Loading...
1/*
2 * thinkpad_acpi.c - ThinkPad ACPI Extras
3 *
4 *
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301, USA.
22 */
23
24#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25
26#define TPACPI_VERSION "0.24"
27#define TPACPI_SYSFS_VERSION 0x020700
28
29/*
30 * Changelog:
31 * 2007-10-20 changelog trimmed down
32 *
33 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
34 * drivers/misc.
35 *
36 * 2006-11-22 0.13 new maintainer
37 * changelog now lives in git commit history, and will
38 * not be updated further in-file.
39 *
40 * 2005-03-17 0.11 support for 600e, 770x
41 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
42 *
43 * 2005-01-16 0.9 use MODULE_VERSION
44 * thanks to Henrik Brix Andersen <brix@gentoo.org>
45 * fix parameter passing on module loading
46 * thanks to Rusty Russell <rusty@rustcorp.com.au>
47 * thanks to Jim Radford <radford@blackbean.org>
48 * 2004-11-08 0.8 fix init error case, don't return from a macro
49 * thanks to Chris Wright <chrisw@osdl.org>
50 */
51
52#include <linux/kernel.h>
53#include <linux/module.h>
54#include <linux/init.h>
55#include <linux/types.h>
56#include <linux/string.h>
57#include <linux/list.h>
58#include <linux/mutex.h>
59#include <linux/sched.h>
60#include <linux/kthread.h>
61#include <linux/freezer.h>
62#include <linux/delay.h>
63#include <linux/slab.h>
64
65#include <linux/nvram.h>
66#include <linux/proc_fs.h>
67#include <linux/seq_file.h>
68#include <linux/sysfs.h>
69#include <linux/backlight.h>
70#include <linux/fb.h>
71#include <linux/platform_device.h>
72#include <linux/hwmon.h>
73#include <linux/hwmon-sysfs.h>
74#include <linux/input.h>
75#include <linux/leds.h>
76#include <linux/rfkill.h>
77#include <asm/uaccess.h>
78
79#include <linux/dmi.h>
80#include <linux/jiffies.h>
81#include <linux/workqueue.h>
82
83#include <sound/core.h>
84#include <sound/control.h>
85#include <sound/initval.h>
86
87#include <acpi/acpi_drivers.h>
88
89#include <linux/pci_ids.h>
90
91
92/* ThinkPad CMOS commands */
93#define TP_CMOS_VOLUME_DOWN 0
94#define TP_CMOS_VOLUME_UP 1
95#define TP_CMOS_VOLUME_MUTE 2
96#define TP_CMOS_BRIGHTNESS_UP 4
97#define TP_CMOS_BRIGHTNESS_DOWN 5
98#define TP_CMOS_THINKLIGHT_ON 12
99#define TP_CMOS_THINKLIGHT_OFF 13
100
101/* NVRAM Addresses */
102enum tp_nvram_addr {
103 TP_NVRAM_ADDR_HK2 = 0x57,
104 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
105 TP_NVRAM_ADDR_VIDEO = 0x59,
106 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
107 TP_NVRAM_ADDR_MIXER = 0x60,
108};
109
110/* NVRAM bit masks */
111enum {
112 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
113 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
114 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
115 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
116 TP_NVRAM_MASK_THINKLIGHT = 0x10,
117 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
118 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
119 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
120 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
121 TP_NVRAM_MASK_MUTE = 0x40,
122 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
123 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
124 TP_NVRAM_POS_LEVEL_VOLUME = 0,
125};
126
127/* Misc NVRAM-related */
128enum {
129 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
130};
131
132/* ACPI HIDs */
133#define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
134#define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
135#define TPACPI_ACPI_EC_HID "PNP0C09"
136
137/* Input IDs */
138#define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
139#define TPACPI_HKEY_INPUT_VERSION 0x4101
140
141/* ACPI \WGSV commands */
142enum {
143 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
144 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
145 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
146 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
147};
148
149/* TP_ACPI_WGSV_GET_STATE bits */
150enum {
151 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
152 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
153 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
154 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
155 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
156 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
157 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
158 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
159 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
160 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
161};
162
163/* HKEY events */
164enum tpacpi_hkey_event_t {
165 /* Hotkey-related */
166 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
167 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
168 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
169 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
170 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
171 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
172
173 /* Reasons for waking up from S3/S4 */
174 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
175 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
176 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
177 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
178 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
179 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
180
181 /* Auto-sleep after eject request */
182 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
183 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
184
185 /* Misc bay events */
186 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
187 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
188 or port replicator */
189 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
190 dock or port replicator */
191
192 /* User-interface events */
193 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
194 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
195 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
196 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
197 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
198 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
199 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
200
201 /* Key-related user-interface events */
202 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
203 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
204
205 /* Thermal events */
206 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
207 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
208 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
209 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
210 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
211
212 TP_HKEY_EV_UNK_6040 = 0x6040, /* Related to AC change?
213 some sort of APM hint,
214 W520 */
215
216 /* Misc */
217 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
218};
219
220/****************************************************************************
221 * Main driver
222 */
223
224#define TPACPI_NAME "thinkpad"
225#define TPACPI_DESC "ThinkPad ACPI Extras"
226#define TPACPI_FILE TPACPI_NAME "_acpi"
227#define TPACPI_URL "http://ibm-acpi.sf.net/"
228#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
229
230#define TPACPI_PROC_DIR "ibm"
231#define TPACPI_ACPI_EVENT_PREFIX "ibm"
232#define TPACPI_DRVR_NAME TPACPI_FILE
233#define TPACPI_DRVR_SHORTNAME "tpacpi"
234#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
235
236#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
237#define TPACPI_WORKQUEUE_NAME "ktpacpid"
238
239#define TPACPI_MAX_ACPI_ARGS 3
240
241/* Debugging printk groups */
242#define TPACPI_DBG_ALL 0xffff
243#define TPACPI_DBG_DISCLOSETASK 0x8000
244#define TPACPI_DBG_INIT 0x0001
245#define TPACPI_DBG_EXIT 0x0002
246#define TPACPI_DBG_RFKILL 0x0004
247#define TPACPI_DBG_HKEY 0x0008
248#define TPACPI_DBG_FAN 0x0010
249#define TPACPI_DBG_BRGHT 0x0020
250#define TPACPI_DBG_MIXER 0x0040
251
252#define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
253#define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
254#define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
255
256
257/****************************************************************************
258 * Driver-wide structs and misc. variables
259 */
260
261struct ibm_struct;
262
263struct tp_acpi_drv_struct {
264 const struct acpi_device_id *hid;
265 struct acpi_driver *driver;
266
267 void (*notify) (struct ibm_struct *, u32);
268 acpi_handle *handle;
269 u32 type;
270 struct acpi_device *device;
271};
272
273struct ibm_struct {
274 char *name;
275
276 int (*read) (struct seq_file *);
277 int (*write) (char *);
278 void (*exit) (void);
279 void (*resume) (void);
280 void (*suspend) (pm_message_t state);
281 void (*shutdown) (void);
282
283 struct list_head all_drivers;
284
285 struct tp_acpi_drv_struct *acpi;
286
287 struct {
288 u8 acpi_driver_registered:1;
289 u8 acpi_notify_installed:1;
290 u8 proc_created:1;
291 u8 init_called:1;
292 u8 experimental:1;
293 } flags;
294};
295
296struct ibm_init_struct {
297 char param[32];
298
299 int (*init) (struct ibm_init_struct *);
300 mode_t base_procfs_mode;
301 struct ibm_struct *data;
302};
303
304static struct {
305 u32 bluetooth:1;
306 u32 hotkey:1;
307 u32 hotkey_mask:1;
308 u32 hotkey_wlsw:1;
309 u32 hotkey_tablet:1;
310 u32 light:1;
311 u32 light_status:1;
312 u32 bright_acpimode:1;
313 u32 bright_unkfw:1;
314 u32 wan:1;
315 u32 uwb:1;
316 u32 fan_ctrl_status_undef:1;
317 u32 second_fan:1;
318 u32 beep_needs_two_args:1;
319 u32 mixer_no_level_control:1;
320 u32 input_device_registered:1;
321 u32 platform_drv_registered:1;
322 u32 platform_drv_attrs_registered:1;
323 u32 sensors_pdrv_registered:1;
324 u32 sensors_pdrv_attrs_registered:1;
325 u32 sensors_pdev_attrs_registered:1;
326 u32 hotkey_poll_active:1;
327} tp_features;
328
329static struct {
330 u16 hotkey_mask_ff:1;
331 u16 volume_ctrl_forbidden:1;
332} tp_warned;
333
334struct thinkpad_id_data {
335 unsigned int vendor; /* ThinkPad vendor:
336 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
337
338 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
339 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
340
341 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
342 u16 ec_model;
343 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
344 u16 ec_release;
345
346 char *model_str; /* ThinkPad T43 */
347 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
348};
349static struct thinkpad_id_data thinkpad_id;
350
351static enum {
352 TPACPI_LIFE_INIT = 0,
353 TPACPI_LIFE_RUNNING,
354 TPACPI_LIFE_EXITING,
355} tpacpi_lifecycle;
356
357static int experimental;
358static u32 dbg_level;
359
360static struct workqueue_struct *tpacpi_wq;
361
362enum led_status_t {
363 TPACPI_LED_OFF = 0,
364 TPACPI_LED_ON,
365 TPACPI_LED_BLINK,
366};
367
368/* Special LED class that can defer work */
369struct tpacpi_led_classdev {
370 struct led_classdev led_classdev;
371 struct work_struct work;
372 enum led_status_t new_state;
373 unsigned int led;
374};
375
376/* brightness level capabilities */
377static unsigned int bright_maxlvl; /* 0 = unknown */
378
379#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
380static int dbg_wlswemul;
381static int tpacpi_wlsw_emulstate;
382static int dbg_bluetoothemul;
383static int tpacpi_bluetooth_emulstate;
384static int dbg_wwanemul;
385static int tpacpi_wwan_emulstate;
386static int dbg_uwbemul;
387static int tpacpi_uwb_emulstate;
388#endif
389
390
391/*************************************************************************
392 * Debugging helpers
393 */
394
395#define dbg_printk(a_dbg_level, format, arg...) \
396do { \
397 if (dbg_level & (a_dbg_level)) \
398 printk(KERN_DEBUG pr_fmt("%s: " format), \
399 __func__, ##arg); \
400} while (0)
401
402#ifdef CONFIG_THINKPAD_ACPI_DEBUG
403#define vdbg_printk dbg_printk
404static const char *str_supported(int is_supported);
405#else
406static inline const char *str_supported(int is_supported) { return ""; }
407#define vdbg_printk(a_dbg_level, format, arg...) \
408 no_printk(format, ##arg)
409#endif
410
411static void tpacpi_log_usertask(const char * const what)
412{
413 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
414 what, task_tgid_vnr(current));
415}
416
417#define tpacpi_disclose_usertask(what, format, arg...) \
418do { \
419 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
420 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
421 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
422 what, task_tgid_vnr(current), ## arg); \
423 } \
424} while (0)
425
426/*
427 * Quirk handling helpers
428 *
429 * ThinkPad IDs and versions seen in the field so far
430 * are two-characters from the set [0-9A-Z], i.e. base 36.
431 *
432 * We use values well outside that range as specials.
433 */
434
435#define TPACPI_MATCH_ANY 0xffffU
436#define TPACPI_MATCH_UNKNOWN 0U
437
438/* TPID('1', 'Y') == 0x5931 */
439#define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
440
441#define TPACPI_Q_IBM(__id1, __id2, __quirk) \
442 { .vendor = PCI_VENDOR_ID_IBM, \
443 .bios = TPID(__id1, __id2), \
444 .ec = TPACPI_MATCH_ANY, \
445 .quirks = (__quirk) }
446
447#define TPACPI_Q_LNV(__id1, __id2, __quirk) \
448 { .vendor = PCI_VENDOR_ID_LENOVO, \
449 .bios = TPID(__id1, __id2), \
450 .ec = TPACPI_MATCH_ANY, \
451 .quirks = (__quirk) }
452
453#define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
454 { .vendor = PCI_VENDOR_ID_LENOVO, \
455 .bios = TPACPI_MATCH_ANY, \
456 .ec = TPID(__id1, __id2), \
457 .quirks = (__quirk) }
458
459struct tpacpi_quirk {
460 unsigned int vendor;
461 u16 bios;
462 u16 ec;
463 unsigned long quirks;
464};
465
466/**
467 * tpacpi_check_quirks() - search BIOS/EC version on a list
468 * @qlist: array of &struct tpacpi_quirk
469 * @qlist_size: number of elements in @qlist
470 *
471 * Iterates over a quirks list until one is found that matches the
472 * ThinkPad's vendor, BIOS and EC model.
473 *
474 * Returns 0 if nothing matches, otherwise returns the quirks field of
475 * the matching &struct tpacpi_quirk entry.
476 *
477 * The match criteria is: vendor, ec and bios much match.
478 */
479static unsigned long __init tpacpi_check_quirks(
480 const struct tpacpi_quirk *qlist,
481 unsigned int qlist_size)
482{
483 while (qlist_size) {
484 if ((qlist->vendor == thinkpad_id.vendor ||
485 qlist->vendor == TPACPI_MATCH_ANY) &&
486 (qlist->bios == thinkpad_id.bios_model ||
487 qlist->bios == TPACPI_MATCH_ANY) &&
488 (qlist->ec == thinkpad_id.ec_model ||
489 qlist->ec == TPACPI_MATCH_ANY))
490 return qlist->quirks;
491
492 qlist_size--;
493 qlist++;
494 }
495 return 0;
496}
497
498static inline bool __pure __init tpacpi_is_lenovo(void)
499{
500 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
501}
502
503static inline bool __pure __init tpacpi_is_ibm(void)
504{
505 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
506}
507
508/****************************************************************************
509 ****************************************************************************
510 *
511 * ACPI Helpers and device model
512 *
513 ****************************************************************************
514 ****************************************************************************/
515
516/*************************************************************************
517 * ACPI basic handles
518 */
519
520static acpi_handle root_handle;
521static acpi_handle ec_handle;
522
523#define TPACPI_HANDLE(object, parent, paths...) \
524 static acpi_handle object##_handle; \
525 static const acpi_handle *object##_parent __initdata = \
526 &parent##_handle; \
527 static char *object##_paths[] __initdata = { paths }
528
529TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
530TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
531
532TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
533 /* T4x, X31, X40 */
534 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
535 "\\CMS", /* R40, R40e */
536 ); /* all others */
537
538TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
539 "^HKEY", /* R30, R31 */
540 "HKEY", /* all others */
541 ); /* 570 */
542
543/*************************************************************************
544 * ACPI helpers
545 */
546
547static int acpi_evalf(acpi_handle handle,
548 void *res, char *method, char *fmt, ...)
549{
550 char *fmt0 = fmt;
551 struct acpi_object_list params;
552 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
553 struct acpi_buffer result, *resultp;
554 union acpi_object out_obj;
555 acpi_status status;
556 va_list ap;
557 char res_type;
558 int success;
559 int quiet;
560
561 if (!*fmt) {
562 pr_err("acpi_evalf() called with empty format\n");
563 return 0;
564 }
565
566 if (*fmt == 'q') {
567 quiet = 1;
568 fmt++;
569 } else
570 quiet = 0;
571
572 res_type = *(fmt++);
573
574 params.count = 0;
575 params.pointer = &in_objs[0];
576
577 va_start(ap, fmt);
578 while (*fmt) {
579 char c = *(fmt++);
580 switch (c) {
581 case 'd': /* int */
582 in_objs[params.count].integer.value = va_arg(ap, int);
583 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
584 break;
585 /* add more types as needed */
586 default:
587 pr_err("acpi_evalf() called "
588 "with invalid format character '%c'\n", c);
589 va_end(ap);
590 return 0;
591 }
592 }
593 va_end(ap);
594
595 if (res_type != 'v') {
596 result.length = sizeof(out_obj);
597 result.pointer = &out_obj;
598 resultp = &result;
599 } else
600 resultp = NULL;
601
602 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
603
604 switch (res_type) {
605 case 'd': /* int */
606 success = (status == AE_OK &&
607 out_obj.type == ACPI_TYPE_INTEGER);
608 if (success && res)
609 *(int *)res = out_obj.integer.value;
610 break;
611 case 'v': /* void */
612 success = status == AE_OK;
613 break;
614 /* add more types as needed */
615 default:
616 pr_err("acpi_evalf() called "
617 "with invalid format character '%c'\n", res_type);
618 return 0;
619 }
620
621 if (!success && !quiet)
622 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
623 method, fmt0, acpi_format_exception(status));
624
625 return success;
626}
627
628static int acpi_ec_read(int i, u8 *p)
629{
630 int v;
631
632 if (ecrd_handle) {
633 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
634 return 0;
635 *p = v;
636 } else {
637 if (ec_read(i, p) < 0)
638 return 0;
639 }
640
641 return 1;
642}
643
644static int acpi_ec_write(int i, u8 v)
645{
646 if (ecwr_handle) {
647 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
648 return 0;
649 } else {
650 if (ec_write(i, v) < 0)
651 return 0;
652 }
653
654 return 1;
655}
656
657static int issue_thinkpad_cmos_command(int cmos_cmd)
658{
659 if (!cmos_handle)
660 return -ENXIO;
661
662 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
663 return -EIO;
664
665 return 0;
666}
667
668/*************************************************************************
669 * ACPI device model
670 */
671
672#define TPACPI_ACPIHANDLE_INIT(object) \
673 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
674 object##_paths, ARRAY_SIZE(object##_paths))
675
676static void __init drv_acpi_handle_init(const char *name,
677 acpi_handle *handle, const acpi_handle parent,
678 char **paths, const int num_paths)
679{
680 int i;
681 acpi_status status;
682
683 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
684 name);
685
686 for (i = 0; i < num_paths; i++) {
687 status = acpi_get_handle(parent, paths[i], handle);
688 if (ACPI_SUCCESS(status)) {
689 dbg_printk(TPACPI_DBG_INIT,
690 "Found ACPI handle %s for %s\n",
691 paths[i], name);
692 return;
693 }
694 }
695
696 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
697 name);
698 *handle = NULL;
699}
700
701static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
702 u32 level, void *context, void **return_value)
703{
704 *(acpi_handle *)return_value = handle;
705
706 return AE_CTRL_TERMINATE;
707}
708
709static void __init tpacpi_acpi_handle_locate(const char *name,
710 const char *hid,
711 acpi_handle *handle)
712{
713 acpi_status status;
714 acpi_handle device_found;
715
716 BUG_ON(!name || !hid || !handle);
717 vdbg_printk(TPACPI_DBG_INIT,
718 "trying to locate ACPI handle for %s, using HID %s\n",
719 name, hid);
720
721 memset(&device_found, 0, sizeof(device_found));
722 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
723 (void *)name, &device_found);
724
725 *handle = NULL;
726
727 if (ACPI_SUCCESS(status)) {
728 *handle = device_found;
729 dbg_printk(TPACPI_DBG_INIT,
730 "Found ACPI handle for %s\n", name);
731 } else {
732 vdbg_printk(TPACPI_DBG_INIT,
733 "Could not locate an ACPI handle for %s: %s\n",
734 name, acpi_format_exception(status));
735 }
736}
737
738static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
739{
740 struct ibm_struct *ibm = data;
741
742 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
743 return;
744
745 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
746 return;
747
748 ibm->acpi->notify(ibm, event);
749}
750
751static int __init setup_acpi_notify(struct ibm_struct *ibm)
752{
753 acpi_status status;
754 int rc;
755
756 BUG_ON(!ibm->acpi);
757
758 if (!*ibm->acpi->handle)
759 return 0;
760
761 vdbg_printk(TPACPI_DBG_INIT,
762 "setting up ACPI notify for %s\n", ibm->name);
763
764 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
765 if (rc < 0) {
766 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
767 return -ENODEV;
768 }
769
770 ibm->acpi->device->driver_data = ibm;
771 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
772 TPACPI_ACPI_EVENT_PREFIX,
773 ibm->name);
774
775 status = acpi_install_notify_handler(*ibm->acpi->handle,
776 ibm->acpi->type, dispatch_acpi_notify, ibm);
777 if (ACPI_FAILURE(status)) {
778 if (status == AE_ALREADY_EXISTS) {
779 pr_notice("another device driver is already "
780 "handling %s events\n", ibm->name);
781 } else {
782 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
783 ibm->name, acpi_format_exception(status));
784 }
785 return -ENODEV;
786 }
787 ibm->flags.acpi_notify_installed = 1;
788 return 0;
789}
790
791static int __init tpacpi_device_add(struct acpi_device *device)
792{
793 return 0;
794}
795
796static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
797{
798 int rc;
799
800 dbg_printk(TPACPI_DBG_INIT,
801 "registering %s as an ACPI driver\n", ibm->name);
802
803 BUG_ON(!ibm->acpi);
804
805 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
806 if (!ibm->acpi->driver) {
807 pr_err("failed to allocate memory for ibm->acpi->driver\n");
808 return -ENOMEM;
809 }
810
811 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
812 ibm->acpi->driver->ids = ibm->acpi->hid;
813
814 ibm->acpi->driver->ops.add = &tpacpi_device_add;
815
816 rc = acpi_bus_register_driver(ibm->acpi->driver);
817 if (rc < 0) {
818 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
819 ibm->name, rc);
820 kfree(ibm->acpi->driver);
821 ibm->acpi->driver = NULL;
822 } else if (!rc)
823 ibm->flags.acpi_driver_registered = 1;
824
825 return rc;
826}
827
828
829/****************************************************************************
830 ****************************************************************************
831 *
832 * Procfs Helpers
833 *
834 ****************************************************************************
835 ****************************************************************************/
836
837static int dispatch_proc_show(struct seq_file *m, void *v)
838{
839 struct ibm_struct *ibm = m->private;
840
841 if (!ibm || !ibm->read)
842 return -EINVAL;
843 return ibm->read(m);
844}
845
846static int dispatch_proc_open(struct inode *inode, struct file *file)
847{
848 return single_open(file, dispatch_proc_show, PDE(inode)->data);
849}
850
851static ssize_t dispatch_proc_write(struct file *file,
852 const char __user *userbuf,
853 size_t count, loff_t *pos)
854{
855 struct ibm_struct *ibm = PDE(file->f_path.dentry->d_inode)->data;
856 char *kernbuf;
857 int ret;
858
859 if (!ibm || !ibm->write)
860 return -EINVAL;
861 if (count > PAGE_SIZE - 2)
862 return -EINVAL;
863
864 kernbuf = kmalloc(count + 2, GFP_KERNEL);
865 if (!kernbuf)
866 return -ENOMEM;
867
868 if (copy_from_user(kernbuf, userbuf, count)) {
869 kfree(kernbuf);
870 return -EFAULT;
871 }
872
873 kernbuf[count] = 0;
874 strcat(kernbuf, ",");
875 ret = ibm->write(kernbuf);
876 if (ret == 0)
877 ret = count;
878
879 kfree(kernbuf);
880
881 return ret;
882}
883
884static const struct file_operations dispatch_proc_fops = {
885 .owner = THIS_MODULE,
886 .open = dispatch_proc_open,
887 .read = seq_read,
888 .llseek = seq_lseek,
889 .release = single_release,
890 .write = dispatch_proc_write,
891};
892
893static char *next_cmd(char **cmds)
894{
895 char *start = *cmds;
896 char *end;
897
898 while ((end = strchr(start, ',')) && end == start)
899 start = end + 1;
900
901 if (!end)
902 return NULL;
903
904 *end = 0;
905 *cmds = end + 1;
906 return start;
907}
908
909
910/****************************************************************************
911 ****************************************************************************
912 *
913 * Device model: input, hwmon and platform
914 *
915 ****************************************************************************
916 ****************************************************************************/
917
918static struct platform_device *tpacpi_pdev;
919static struct platform_device *tpacpi_sensors_pdev;
920static struct device *tpacpi_hwmon;
921static struct input_dev *tpacpi_inputdev;
922static struct mutex tpacpi_inputdev_send_mutex;
923static LIST_HEAD(tpacpi_all_drivers);
924
925static int tpacpi_suspend_handler(struct platform_device *pdev,
926 pm_message_t state)
927{
928 struct ibm_struct *ibm, *itmp;
929
930 list_for_each_entry_safe(ibm, itmp,
931 &tpacpi_all_drivers,
932 all_drivers) {
933 if (ibm->suspend)
934 (ibm->suspend)(state);
935 }
936
937 return 0;
938}
939
940static int tpacpi_resume_handler(struct platform_device *pdev)
941{
942 struct ibm_struct *ibm, *itmp;
943
944 list_for_each_entry_safe(ibm, itmp,
945 &tpacpi_all_drivers,
946 all_drivers) {
947 if (ibm->resume)
948 (ibm->resume)();
949 }
950
951 return 0;
952}
953
954static void tpacpi_shutdown_handler(struct platform_device *pdev)
955{
956 struct ibm_struct *ibm, *itmp;
957
958 list_for_each_entry_safe(ibm, itmp,
959 &tpacpi_all_drivers,
960 all_drivers) {
961 if (ibm->shutdown)
962 (ibm->shutdown)();
963 }
964}
965
966static struct platform_driver tpacpi_pdriver = {
967 .driver = {
968 .name = TPACPI_DRVR_NAME,
969 .owner = THIS_MODULE,
970 },
971 .suspend = tpacpi_suspend_handler,
972 .resume = tpacpi_resume_handler,
973 .shutdown = tpacpi_shutdown_handler,
974};
975
976static struct platform_driver tpacpi_hwmon_pdriver = {
977 .driver = {
978 .name = TPACPI_HWMON_DRVR_NAME,
979 .owner = THIS_MODULE,
980 },
981};
982
983/*************************************************************************
984 * sysfs support helpers
985 */
986
987struct attribute_set {
988 unsigned int members, max_members;
989 struct attribute_group group;
990};
991
992struct attribute_set_obj {
993 struct attribute_set s;
994 struct attribute *a;
995} __attribute__((packed));
996
997static struct attribute_set *create_attr_set(unsigned int max_members,
998 const char *name)
999{
1000 struct attribute_set_obj *sobj;
1001
1002 if (max_members == 0)
1003 return NULL;
1004
1005 /* Allocates space for implicit NULL at the end too */
1006 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1007 max_members * sizeof(struct attribute *),
1008 GFP_KERNEL);
1009 if (!sobj)
1010 return NULL;
1011 sobj->s.max_members = max_members;
1012 sobj->s.group.attrs = &sobj->a;
1013 sobj->s.group.name = name;
1014
1015 return &sobj->s;
1016}
1017
1018#define destroy_attr_set(_set) \
1019 kfree(_set);
1020
1021/* not multi-threaded safe, use it in a single thread per set */
1022static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1023{
1024 if (!s || !attr)
1025 return -EINVAL;
1026
1027 if (s->members >= s->max_members)
1028 return -ENOMEM;
1029
1030 s->group.attrs[s->members] = attr;
1031 s->members++;
1032
1033 return 0;
1034}
1035
1036static int add_many_to_attr_set(struct attribute_set *s,
1037 struct attribute **attr,
1038 unsigned int count)
1039{
1040 int i, res;
1041
1042 for (i = 0; i < count; i++) {
1043 res = add_to_attr_set(s, attr[i]);
1044 if (res)
1045 return res;
1046 }
1047
1048 return 0;
1049}
1050
1051static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1052{
1053 sysfs_remove_group(kobj, &s->group);
1054 destroy_attr_set(s);
1055}
1056
1057#define register_attr_set_with_sysfs(_attr_set, _kobj) \
1058 sysfs_create_group(_kobj, &_attr_set->group)
1059
1060static int parse_strtoul(const char *buf,
1061 unsigned long max, unsigned long *value)
1062{
1063 char *endp;
1064
1065 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1066 endp = skip_spaces(endp);
1067 if (*endp || *value > max)
1068 return -EINVAL;
1069
1070 return 0;
1071}
1072
1073static void tpacpi_disable_brightness_delay(void)
1074{
1075 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1076 pr_notice("ACPI backlight control delay disabled\n");
1077}
1078
1079static void printk_deprecated_attribute(const char * const what,
1080 const char * const details)
1081{
1082 tpacpi_log_usertask("deprecated sysfs attribute");
1083 pr_warn("WARNING: sysfs attribute %s is deprecated and "
1084 "will be removed. %s\n",
1085 what, details);
1086}
1087
1088/*************************************************************************
1089 * rfkill and radio control support helpers
1090 */
1091
1092/*
1093 * ThinkPad-ACPI firmware handling model:
1094 *
1095 * WLSW (master wireless switch) is event-driven, and is common to all
1096 * firmware-controlled radios. It cannot be controlled, just monitored,
1097 * as expected. It overrides all radio state in firmware
1098 *
1099 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1100 * (TODO: verify how WLSW interacts with the returned radio state).
1101 *
1102 * The only time there are shadow radio state changes, is when
1103 * masked-off hotkeys are used.
1104 */
1105
1106/*
1107 * Internal driver API for radio state:
1108 *
1109 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1110 * bool: true means radio blocked (off)
1111 */
1112enum tpacpi_rfkill_state {
1113 TPACPI_RFK_RADIO_OFF = 0,
1114 TPACPI_RFK_RADIO_ON
1115};
1116
1117/* rfkill switches */
1118enum tpacpi_rfk_id {
1119 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1120 TPACPI_RFK_WWAN_SW_ID,
1121 TPACPI_RFK_UWB_SW_ID,
1122 TPACPI_RFK_SW_MAX
1123};
1124
1125static const char *tpacpi_rfkill_names[] = {
1126 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1127 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1128 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1129 [TPACPI_RFK_SW_MAX] = NULL
1130};
1131
1132/* ThinkPad-ACPI rfkill subdriver */
1133struct tpacpi_rfk {
1134 struct rfkill *rfkill;
1135 enum tpacpi_rfk_id id;
1136 const struct tpacpi_rfk_ops *ops;
1137};
1138
1139struct tpacpi_rfk_ops {
1140 /* firmware interface */
1141 int (*get_status)(void);
1142 int (*set_status)(const enum tpacpi_rfkill_state);
1143};
1144
1145static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1146
1147/* Query FW and update rfkill sw state for a given rfkill switch */
1148static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1149{
1150 int status;
1151
1152 if (!tp_rfk)
1153 return -ENODEV;
1154
1155 status = (tp_rfk->ops->get_status)();
1156 if (status < 0)
1157 return status;
1158
1159 rfkill_set_sw_state(tp_rfk->rfkill,
1160 (status == TPACPI_RFK_RADIO_OFF));
1161
1162 return status;
1163}
1164
1165/* Query FW and update rfkill sw state for all rfkill switches */
1166static void tpacpi_rfk_update_swstate_all(void)
1167{
1168 unsigned int i;
1169
1170 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1171 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1172}
1173
1174/*
1175 * Sync the HW-blocking state of all rfkill switches,
1176 * do notice it causes the rfkill core to schedule uevents
1177 */
1178static void tpacpi_rfk_update_hwblock_state(bool blocked)
1179{
1180 unsigned int i;
1181 struct tpacpi_rfk *tp_rfk;
1182
1183 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1184 tp_rfk = tpacpi_rfkill_switches[i];
1185 if (tp_rfk) {
1186 if (rfkill_set_hw_state(tp_rfk->rfkill,
1187 blocked)) {
1188 /* ignore -- we track sw block */
1189 }
1190 }
1191 }
1192}
1193
1194/* Call to get the WLSW state from the firmware */
1195static int hotkey_get_wlsw(void);
1196
1197/* Call to query WLSW state and update all rfkill switches */
1198static bool tpacpi_rfk_check_hwblock_state(void)
1199{
1200 int res = hotkey_get_wlsw();
1201 int hw_blocked;
1202
1203 /* When unknown or unsupported, we have to assume it is unblocked */
1204 if (res < 0)
1205 return false;
1206
1207 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1208 tpacpi_rfk_update_hwblock_state(hw_blocked);
1209
1210 return hw_blocked;
1211}
1212
1213static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1214{
1215 struct tpacpi_rfk *tp_rfk = data;
1216 int res;
1217
1218 dbg_printk(TPACPI_DBG_RFKILL,
1219 "request to change radio state to %s\n",
1220 blocked ? "blocked" : "unblocked");
1221
1222 /* try to set radio state */
1223 res = (tp_rfk->ops->set_status)(blocked ?
1224 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1225
1226 /* and update the rfkill core with whatever the FW really did */
1227 tpacpi_rfk_update_swstate(tp_rfk);
1228
1229 return (res < 0) ? res : 0;
1230}
1231
1232static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1233 .set_block = tpacpi_rfk_hook_set_block,
1234};
1235
1236static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1237 const struct tpacpi_rfk_ops *tp_rfkops,
1238 const enum rfkill_type rfktype,
1239 const char *name,
1240 const bool set_default)
1241{
1242 struct tpacpi_rfk *atp_rfk;
1243 int res;
1244 bool sw_state = false;
1245 bool hw_state;
1246 int sw_status;
1247
1248 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1249
1250 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1251 if (atp_rfk)
1252 atp_rfk->rfkill = rfkill_alloc(name,
1253 &tpacpi_pdev->dev,
1254 rfktype,
1255 &tpacpi_rfk_rfkill_ops,
1256 atp_rfk);
1257 if (!atp_rfk || !atp_rfk->rfkill) {
1258 pr_err("failed to allocate memory for rfkill class\n");
1259 kfree(atp_rfk);
1260 return -ENOMEM;
1261 }
1262
1263 atp_rfk->id = id;
1264 atp_rfk->ops = tp_rfkops;
1265
1266 sw_status = (tp_rfkops->get_status)();
1267 if (sw_status < 0) {
1268 pr_err("failed to read initial state for %s, error %d\n",
1269 name, sw_status);
1270 } else {
1271 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1272 if (set_default) {
1273 /* try to keep the initial state, since we ask the
1274 * firmware to preserve it across S5 in NVRAM */
1275 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1276 }
1277 }
1278 hw_state = tpacpi_rfk_check_hwblock_state();
1279 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1280
1281 res = rfkill_register(atp_rfk->rfkill);
1282 if (res < 0) {
1283 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1284 rfkill_destroy(atp_rfk->rfkill);
1285 kfree(atp_rfk);
1286 return res;
1287 }
1288
1289 tpacpi_rfkill_switches[id] = atp_rfk;
1290
1291 pr_info("rfkill switch %s: radio is %sblocked\n",
1292 name, (sw_state || hw_state) ? "" : "un");
1293 return 0;
1294}
1295
1296static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1297{
1298 struct tpacpi_rfk *tp_rfk;
1299
1300 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1301
1302 tp_rfk = tpacpi_rfkill_switches[id];
1303 if (tp_rfk) {
1304 rfkill_unregister(tp_rfk->rfkill);
1305 rfkill_destroy(tp_rfk->rfkill);
1306 tpacpi_rfkill_switches[id] = NULL;
1307 kfree(tp_rfk);
1308 }
1309}
1310
1311static void printk_deprecated_rfkill_attribute(const char * const what)
1312{
1313 printk_deprecated_attribute(what,
1314 "Please switch to generic rfkill before year 2010");
1315}
1316
1317/* sysfs <radio> enable ------------------------------------------------ */
1318static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1319 struct device_attribute *attr,
1320 char *buf)
1321{
1322 int status;
1323
1324 printk_deprecated_rfkill_attribute(attr->attr.name);
1325
1326 /* This is in the ABI... */
1327 if (tpacpi_rfk_check_hwblock_state()) {
1328 status = TPACPI_RFK_RADIO_OFF;
1329 } else {
1330 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1331 if (status < 0)
1332 return status;
1333 }
1334
1335 return snprintf(buf, PAGE_SIZE, "%d\n",
1336 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1337}
1338
1339static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1340 struct device_attribute *attr,
1341 const char *buf, size_t count)
1342{
1343 unsigned long t;
1344 int res;
1345
1346 printk_deprecated_rfkill_attribute(attr->attr.name);
1347
1348 if (parse_strtoul(buf, 1, &t))
1349 return -EINVAL;
1350
1351 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1352
1353 /* This is in the ABI... */
1354 if (tpacpi_rfk_check_hwblock_state() && !!t)
1355 return -EPERM;
1356
1357 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1358 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1359 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1360
1361 return (res < 0) ? res : count;
1362}
1363
1364/* procfs -------------------------------------------------------------- */
1365static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1366{
1367 if (id >= TPACPI_RFK_SW_MAX)
1368 seq_printf(m, "status:\t\tnot supported\n");
1369 else {
1370 int status;
1371
1372 /* This is in the ABI... */
1373 if (tpacpi_rfk_check_hwblock_state()) {
1374 status = TPACPI_RFK_RADIO_OFF;
1375 } else {
1376 status = tpacpi_rfk_update_swstate(
1377 tpacpi_rfkill_switches[id]);
1378 if (status < 0)
1379 return status;
1380 }
1381
1382 seq_printf(m, "status:\t\t%s\n",
1383 (status == TPACPI_RFK_RADIO_ON) ?
1384 "enabled" : "disabled");
1385 seq_printf(m, "commands:\tenable, disable\n");
1386 }
1387
1388 return 0;
1389}
1390
1391static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1392{
1393 char *cmd;
1394 int status = -1;
1395 int res = 0;
1396
1397 if (id >= TPACPI_RFK_SW_MAX)
1398 return -ENODEV;
1399
1400 while ((cmd = next_cmd(&buf))) {
1401 if (strlencmp(cmd, "enable") == 0)
1402 status = TPACPI_RFK_RADIO_ON;
1403 else if (strlencmp(cmd, "disable") == 0)
1404 status = TPACPI_RFK_RADIO_OFF;
1405 else
1406 return -EINVAL;
1407 }
1408
1409 if (status != -1) {
1410 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1411 (status == TPACPI_RFK_RADIO_ON) ?
1412 "enable" : "disable",
1413 tpacpi_rfkill_names[id]);
1414 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1415 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1416 }
1417
1418 return res;
1419}
1420
1421/*************************************************************************
1422 * thinkpad-acpi driver attributes
1423 */
1424
1425/* interface_version --------------------------------------------------- */
1426static ssize_t tpacpi_driver_interface_version_show(
1427 struct device_driver *drv,
1428 char *buf)
1429{
1430 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1431}
1432
1433static DRIVER_ATTR(interface_version, S_IRUGO,
1434 tpacpi_driver_interface_version_show, NULL);
1435
1436/* debug_level --------------------------------------------------------- */
1437static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1438 char *buf)
1439{
1440 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1441}
1442
1443static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1444 const char *buf, size_t count)
1445{
1446 unsigned long t;
1447
1448 if (parse_strtoul(buf, 0xffff, &t))
1449 return -EINVAL;
1450
1451 dbg_level = t;
1452
1453 return count;
1454}
1455
1456static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1457 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1458
1459/* version ------------------------------------------------------------- */
1460static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1461 char *buf)
1462{
1463 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1464 TPACPI_DESC, TPACPI_VERSION);
1465}
1466
1467static DRIVER_ATTR(version, S_IRUGO,
1468 tpacpi_driver_version_show, NULL);
1469
1470/* --------------------------------------------------------------------- */
1471
1472#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1473
1474/* wlsw_emulstate ------------------------------------------------------ */
1475static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1476 char *buf)
1477{
1478 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1479}
1480
1481static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1482 const char *buf, size_t count)
1483{
1484 unsigned long t;
1485
1486 if (parse_strtoul(buf, 1, &t))
1487 return -EINVAL;
1488
1489 if (tpacpi_wlsw_emulstate != !!t) {
1490 tpacpi_wlsw_emulstate = !!t;
1491 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1492 }
1493
1494 return count;
1495}
1496
1497static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1498 tpacpi_driver_wlsw_emulstate_show,
1499 tpacpi_driver_wlsw_emulstate_store);
1500
1501/* bluetooth_emulstate ------------------------------------------------- */
1502static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1503 struct device_driver *drv,
1504 char *buf)
1505{
1506 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1507}
1508
1509static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1510 struct device_driver *drv,
1511 const char *buf, size_t count)
1512{
1513 unsigned long t;
1514
1515 if (parse_strtoul(buf, 1, &t))
1516 return -EINVAL;
1517
1518 tpacpi_bluetooth_emulstate = !!t;
1519
1520 return count;
1521}
1522
1523static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1524 tpacpi_driver_bluetooth_emulstate_show,
1525 tpacpi_driver_bluetooth_emulstate_store);
1526
1527/* wwan_emulstate ------------------------------------------------- */
1528static ssize_t tpacpi_driver_wwan_emulstate_show(
1529 struct device_driver *drv,
1530 char *buf)
1531{
1532 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1533}
1534
1535static ssize_t tpacpi_driver_wwan_emulstate_store(
1536 struct device_driver *drv,
1537 const char *buf, size_t count)
1538{
1539 unsigned long t;
1540
1541 if (parse_strtoul(buf, 1, &t))
1542 return -EINVAL;
1543
1544 tpacpi_wwan_emulstate = !!t;
1545
1546 return count;
1547}
1548
1549static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1550 tpacpi_driver_wwan_emulstate_show,
1551 tpacpi_driver_wwan_emulstate_store);
1552
1553/* uwb_emulstate ------------------------------------------------- */
1554static ssize_t tpacpi_driver_uwb_emulstate_show(
1555 struct device_driver *drv,
1556 char *buf)
1557{
1558 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1559}
1560
1561static ssize_t tpacpi_driver_uwb_emulstate_store(
1562 struct device_driver *drv,
1563 const char *buf, size_t count)
1564{
1565 unsigned long t;
1566
1567 if (parse_strtoul(buf, 1, &t))
1568 return -EINVAL;
1569
1570 tpacpi_uwb_emulstate = !!t;
1571
1572 return count;
1573}
1574
1575static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1576 tpacpi_driver_uwb_emulstate_show,
1577 tpacpi_driver_uwb_emulstate_store);
1578#endif
1579
1580/* --------------------------------------------------------------------- */
1581
1582static struct driver_attribute *tpacpi_driver_attributes[] = {
1583 &driver_attr_debug_level, &driver_attr_version,
1584 &driver_attr_interface_version,
1585};
1586
1587static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1588{
1589 int i, res;
1590
1591 i = 0;
1592 res = 0;
1593 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1594 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1595 i++;
1596 }
1597
1598#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1599 if (!res && dbg_wlswemul)
1600 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1601 if (!res && dbg_bluetoothemul)
1602 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1603 if (!res && dbg_wwanemul)
1604 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1605 if (!res && dbg_uwbemul)
1606 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1607#endif
1608
1609 return res;
1610}
1611
1612static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1613{
1614 int i;
1615
1616 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1617 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1618
1619#ifdef THINKPAD_ACPI_DEBUGFACILITIES
1620 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1621 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1622 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1623 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1624#endif
1625}
1626
1627/*************************************************************************
1628 * Firmware Data
1629 */
1630
1631/*
1632 * Table of recommended minimum BIOS versions
1633 *
1634 * Reasons for listing:
1635 * 1. Stable BIOS, listed because the unknown amount of
1636 * bugs and bad ACPI behaviour on older versions
1637 *
1638 * 2. BIOS or EC fw with known bugs that trigger on Linux
1639 *
1640 * 3. BIOS with known reduced functionality in older versions
1641 *
1642 * We recommend the latest BIOS and EC version.
1643 * We only support the latest BIOS and EC fw version as a rule.
1644 *
1645 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1646 * Information from users in ThinkWiki
1647 *
1648 * WARNING: we use this table also to detect that the machine is
1649 * a ThinkPad in some cases, so don't remove entries lightly.
1650 */
1651
1652#define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1653 { .vendor = (__v), \
1654 .bios = TPID(__id1, __id2), \
1655 .ec = TPACPI_MATCH_ANY, \
1656 .quirks = TPACPI_MATCH_ANY << 16 \
1657 | (__bv1) << 8 | (__bv2) }
1658
1659#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1660 __eid, __ev1, __ev2) \
1661 { .vendor = (__v), \
1662 .bios = TPID(__bid1, __bid2), \
1663 .ec = __eid, \
1664 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1665 | (__bv1) << 8 | (__bv2) }
1666
1667#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1668 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1669
1670/* Outdated IBM BIOSes often lack the EC id string */
1671#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1672 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1673 __bv1, __bv2, TPID(__id1, __id2), \
1674 __ev1, __ev2), \
1675 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1676 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1677 __ev1, __ev2)
1678
1679/* Outdated IBM BIOSes often lack the EC id string */
1680#define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1681 __eid1, __eid2, __ev1, __ev2) \
1682 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1683 __bv1, __bv2, TPID(__eid1, __eid2), \
1684 __ev1, __ev2), \
1685 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1686 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1687 __ev1, __ev2)
1688
1689#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1690 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1691
1692#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1693 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1694 __bv1, __bv2, TPID(__id1, __id2), \
1695 __ev1, __ev2)
1696
1697#define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1698 __eid1, __eid2, __ev1, __ev2) \
1699 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1700 __bv1, __bv2, TPID(__eid1, __eid2), \
1701 __ev1, __ev2)
1702
1703static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1704 /* Numeric models ------------------ */
1705 /* FW MODEL BIOS VERS */
1706 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1707 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1708 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1709 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1710 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1711 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1712 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1713 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1714 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1715
1716 /* A-series ------------------------- */
1717 /* FW MODEL BIOS VERS EC VERS */
1718 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1719 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1720 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1721 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1722 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1723 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1724 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1725 TPV_QI0('1', '3', '2', '0'), /* A22m */
1726 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1727 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1728 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1729
1730 /* G-series ------------------------- */
1731 /* FW MODEL BIOS VERS */
1732 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1733 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1734
1735 /* R-series, T-series --------------- */
1736 /* FW MODEL BIOS VERS EC VERS */
1737 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1738 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1739 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1740 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1741 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1742 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1743 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1744 T40/p, T41/p, T42/p (1) */
1745 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1746 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1747 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1748 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1749
1750 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1751 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1752 TPV_QI0('1', '6', '3', '2'), /* T22 */
1753 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1754 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1755 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1756
1757 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1758 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1759 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1760
1761 /* BIOS FW BIOS VERS EC FW EC VERS */
1762 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1763 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1764
1765 /* X-series ------------------------- */
1766 /* FW MODEL BIOS VERS EC VERS */
1767 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1768 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1769 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1770 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1771 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1772 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1773 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1774
1775 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1776 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1777
1778 /* (0) - older versions lack DMI EC fw string and functionality */
1779 /* (1) - older versions known to lack functionality */
1780};
1781
1782#undef TPV_QL1
1783#undef TPV_QL0
1784#undef TPV_QI2
1785#undef TPV_QI1
1786#undef TPV_QI0
1787#undef TPV_Q_X
1788#undef TPV_Q
1789
1790static void __init tpacpi_check_outdated_fw(void)
1791{
1792 unsigned long fwvers;
1793 u16 ec_version, bios_version;
1794
1795 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1796 ARRAY_SIZE(tpacpi_bios_version_qtable));
1797
1798 if (!fwvers)
1799 return;
1800
1801 bios_version = fwvers & 0xffffU;
1802 ec_version = (fwvers >> 16) & 0xffffU;
1803
1804 /* note that unknown versions are set to 0x0000 and we use that */
1805 if ((bios_version > thinkpad_id.bios_release) ||
1806 (ec_version > thinkpad_id.ec_release &&
1807 ec_version != TPACPI_MATCH_ANY)) {
1808 /*
1809 * The changelogs would let us track down the exact
1810 * reason, but it is just too much of a pain to track
1811 * it. We only list BIOSes that are either really
1812 * broken, or really stable to begin with, so it is
1813 * best if the user upgrades the firmware anyway.
1814 */
1815 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1816 pr_warn("WARNING: This firmware may be missing critical bug "
1817 "fixes and/or important features\n");
1818 }
1819}
1820
1821static bool __init tpacpi_is_fw_known(void)
1822{
1823 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1824 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1825}
1826
1827/****************************************************************************
1828 ****************************************************************************
1829 *
1830 * Subdrivers
1831 *
1832 ****************************************************************************
1833 ****************************************************************************/
1834
1835/*************************************************************************
1836 * thinkpad-acpi metadata subdriver
1837 */
1838
1839static int thinkpad_acpi_driver_read(struct seq_file *m)
1840{
1841 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1842 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1843 return 0;
1844}
1845
1846static struct ibm_struct thinkpad_acpi_driver_data = {
1847 .name = "driver",
1848 .read = thinkpad_acpi_driver_read,
1849};
1850
1851/*************************************************************************
1852 * Hotkey subdriver
1853 */
1854
1855/*
1856 * ThinkPad firmware event model
1857 *
1858 * The ThinkPad firmware has two main event interfaces: normal ACPI
1859 * notifications (which follow the ACPI standard), and a private event
1860 * interface.
1861 *
1862 * The private event interface also issues events for the hotkeys. As
1863 * the driver gained features, the event handling code ended up being
1864 * built around the hotkey subdriver. This will need to be refactored
1865 * to a more formal event API eventually.
1866 *
1867 * Some "hotkeys" are actually supposed to be used as event reports,
1868 * such as "brightness has changed", "volume has changed", depending on
1869 * the ThinkPad model and how the firmware is operating.
1870 *
1871 * Unlike other classes, hotkey-class events have mask/unmask control on
1872 * non-ancient firmware. However, how it behaves changes a lot with the
1873 * firmware model and version.
1874 */
1875
1876enum { /* hot key scan codes (derived from ACPI DSDT) */
1877 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1878 TP_ACPI_HOTKEYSCAN_FNF2,
1879 TP_ACPI_HOTKEYSCAN_FNF3,
1880 TP_ACPI_HOTKEYSCAN_FNF4,
1881 TP_ACPI_HOTKEYSCAN_FNF5,
1882 TP_ACPI_HOTKEYSCAN_FNF6,
1883 TP_ACPI_HOTKEYSCAN_FNF7,
1884 TP_ACPI_HOTKEYSCAN_FNF8,
1885 TP_ACPI_HOTKEYSCAN_FNF9,
1886 TP_ACPI_HOTKEYSCAN_FNF10,
1887 TP_ACPI_HOTKEYSCAN_FNF11,
1888 TP_ACPI_HOTKEYSCAN_FNF12,
1889 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1890 TP_ACPI_HOTKEYSCAN_FNINSERT,
1891 TP_ACPI_HOTKEYSCAN_FNDELETE,
1892 TP_ACPI_HOTKEYSCAN_FNHOME,
1893 TP_ACPI_HOTKEYSCAN_FNEND,
1894 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1895 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1896 TP_ACPI_HOTKEYSCAN_FNSPACE,
1897 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1898 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1899 TP_ACPI_HOTKEYSCAN_MUTE,
1900 TP_ACPI_HOTKEYSCAN_THINKPAD,
1901 TP_ACPI_HOTKEYSCAN_UNK1,
1902 TP_ACPI_HOTKEYSCAN_UNK2,
1903 TP_ACPI_HOTKEYSCAN_UNK3,
1904 TP_ACPI_HOTKEYSCAN_UNK4,
1905 TP_ACPI_HOTKEYSCAN_UNK5,
1906 TP_ACPI_HOTKEYSCAN_UNK6,
1907 TP_ACPI_HOTKEYSCAN_UNK7,
1908 TP_ACPI_HOTKEYSCAN_UNK8,
1909
1910 /* Hotkey keymap size */
1911 TPACPI_HOTKEY_MAP_LEN
1912};
1913
1914enum { /* Keys/events available through NVRAM polling */
1915 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1916 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1917};
1918
1919enum { /* Positions of some of the keys in hotkey masks */
1920 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1921 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1922 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1923 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1924 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1925 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1926 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1927 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1928 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1929 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1930 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1931};
1932
1933enum { /* NVRAM to ACPI HKEY group map */
1934 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1935 TP_ACPI_HKEY_ZOOM_MASK |
1936 TP_ACPI_HKEY_DISPSWTCH_MASK |
1937 TP_ACPI_HKEY_HIBERNATE_MASK,
1938 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1939 TP_ACPI_HKEY_BRGHTDWN_MASK,
1940 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1941 TP_ACPI_HKEY_VOLDWN_MASK |
1942 TP_ACPI_HKEY_MUTE_MASK,
1943};
1944
1945#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1946struct tp_nvram_state {
1947 u16 thinkpad_toggle:1;
1948 u16 zoom_toggle:1;
1949 u16 display_toggle:1;
1950 u16 thinklight_toggle:1;
1951 u16 hibernate_toggle:1;
1952 u16 displayexp_toggle:1;
1953 u16 display_state:1;
1954 u16 brightness_toggle:1;
1955 u16 volume_toggle:1;
1956 u16 mute:1;
1957
1958 u8 brightness_level;
1959 u8 volume_level;
1960};
1961
1962/* kthread for the hotkey poller */
1963static struct task_struct *tpacpi_hotkey_task;
1964
1965/* Acquired while the poller kthread is running, use to sync start/stop */
1966static struct mutex hotkey_thread_mutex;
1967
1968/*
1969 * Acquire mutex to write poller control variables as an
1970 * atomic block.
1971 *
1972 * Increment hotkey_config_change when changing them if you
1973 * want the kthread to forget old state.
1974 *
1975 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1976 */
1977static struct mutex hotkey_thread_data_mutex;
1978static unsigned int hotkey_config_change;
1979
1980/*
1981 * hotkey poller control variables
1982 *
1983 * Must be atomic or readers will also need to acquire mutex
1984 *
1985 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1986 * should be used only when the changes need to be taken as
1987 * a block, OR when one needs to force the kthread to forget
1988 * old state.
1989 */
1990static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
1991static unsigned int hotkey_poll_freq = 10; /* Hz */
1992
1993#define HOTKEY_CONFIG_CRITICAL_START \
1994 do { \
1995 mutex_lock(&hotkey_thread_data_mutex); \
1996 hotkey_config_change++; \
1997 } while (0);
1998#define HOTKEY_CONFIG_CRITICAL_END \
1999 mutex_unlock(&hotkey_thread_data_mutex);
2000
2001#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2002
2003#define hotkey_source_mask 0U
2004#define HOTKEY_CONFIG_CRITICAL_START
2005#define HOTKEY_CONFIG_CRITICAL_END
2006
2007#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2008
2009static struct mutex hotkey_mutex;
2010
2011static enum { /* Reasons for waking up */
2012 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2013 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2014 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2015} hotkey_wakeup_reason;
2016
2017static int hotkey_autosleep_ack;
2018
2019static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2020static u32 hotkey_all_mask; /* all events supported in fw */
2021static u32 hotkey_reserved_mask; /* events better left disabled */
2022static u32 hotkey_driver_mask; /* events needed by the driver */
2023static u32 hotkey_user_mask; /* events visible to userspace */
2024static u32 hotkey_acpi_mask; /* events enabled in firmware */
2025
2026static unsigned int hotkey_report_mode;
2027
2028static u16 *hotkey_keycode_map;
2029
2030static struct attribute_set *hotkey_dev_attributes;
2031
2032static void tpacpi_driver_event(const unsigned int hkey_event);
2033static void hotkey_driver_event(const unsigned int scancode);
2034static void hotkey_poll_setup(const bool may_warn);
2035
2036/* HKEY.MHKG() return bits */
2037#define TP_HOTKEY_TABLET_MASK (1 << 3)
2038
2039static int hotkey_get_wlsw(void)
2040{
2041 int status;
2042
2043 if (!tp_features.hotkey_wlsw)
2044 return -ENODEV;
2045
2046#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2047 if (dbg_wlswemul)
2048 return (tpacpi_wlsw_emulstate) ?
2049 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2050#endif
2051
2052 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2053 return -EIO;
2054
2055 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2056}
2057
2058static int hotkey_get_tablet_mode(int *status)
2059{
2060 int s;
2061
2062 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2063 return -EIO;
2064
2065 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2066 return 0;
2067}
2068
2069/*
2070 * Reads current event mask from firmware, and updates
2071 * hotkey_acpi_mask accordingly. Also resets any bits
2072 * from hotkey_user_mask that are unavailable to be
2073 * delivered (shadow requirement of the userspace ABI).
2074 *
2075 * Call with hotkey_mutex held
2076 */
2077static int hotkey_mask_get(void)
2078{
2079 if (tp_features.hotkey_mask) {
2080 u32 m = 0;
2081
2082 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2083 return -EIO;
2084
2085 hotkey_acpi_mask = m;
2086 } else {
2087 /* no mask support doesn't mean no event support... */
2088 hotkey_acpi_mask = hotkey_all_mask;
2089 }
2090
2091 /* sync userspace-visible mask */
2092 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2093
2094 return 0;
2095}
2096
2097void static hotkey_mask_warn_incomplete_mask(void)
2098{
2099 /* log only what the user can fix... */
2100 const u32 wantedmask = hotkey_driver_mask &
2101 ~(hotkey_acpi_mask | hotkey_source_mask) &
2102 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2103
2104 if (wantedmask)
2105 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2106}
2107
2108/*
2109 * Set the firmware mask when supported
2110 *
2111 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2112 *
2113 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2114 *
2115 * Call with hotkey_mutex held
2116 */
2117static int hotkey_mask_set(u32 mask)
2118{
2119 int i;
2120 int rc = 0;
2121
2122 const u32 fwmask = mask & ~hotkey_source_mask;
2123
2124 if (tp_features.hotkey_mask) {
2125 for (i = 0; i < 32; i++) {
2126 if (!acpi_evalf(hkey_handle,
2127 NULL, "MHKM", "vdd", i + 1,
2128 !!(mask & (1 << i)))) {
2129 rc = -EIO;
2130 break;
2131 }
2132 }
2133 }
2134
2135 /*
2136 * We *must* make an inconditional call to hotkey_mask_get to
2137 * refresh hotkey_acpi_mask and update hotkey_user_mask
2138 *
2139 * Take the opportunity to also log when we cannot _enable_
2140 * a given event.
2141 */
2142 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2143 pr_notice("asked for hotkey mask 0x%08x, but "
2144 "firmware forced it to 0x%08x\n",
2145 fwmask, hotkey_acpi_mask);
2146 }
2147
2148 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2149 hotkey_mask_warn_incomplete_mask();
2150
2151 return rc;
2152}
2153
2154/*
2155 * Sets hotkey_user_mask and tries to set the firmware mask
2156 *
2157 * Call with hotkey_mutex held
2158 */
2159static int hotkey_user_mask_set(const u32 mask)
2160{
2161 int rc;
2162
2163 /* Give people a chance to notice they are doing something that
2164 * is bound to go boom on their users sooner or later */
2165 if (!tp_warned.hotkey_mask_ff &&
2166 (mask == 0xffff || mask == 0xffffff ||
2167 mask == 0xffffffff)) {
2168 tp_warned.hotkey_mask_ff = 1;
2169 pr_notice("setting the hotkey mask to 0x%08x is likely "
2170 "not the best way to go about it\n", mask);
2171 pr_notice("please consider using the driver defaults, "
2172 "and refer to up-to-date thinkpad-acpi "
2173 "documentation\n");
2174 }
2175
2176 /* Try to enable what the user asked for, plus whatever we need.
2177 * this syncs everything but won't enable bits in hotkey_user_mask */
2178 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2179
2180 /* Enable the available bits in hotkey_user_mask */
2181 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2182
2183 return rc;
2184}
2185
2186/*
2187 * Sets the driver hotkey mask.
2188 *
2189 * Can be called even if the hotkey subdriver is inactive
2190 */
2191static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2192{
2193 int rc;
2194
2195 /* Do the right thing if hotkey_init has not been called yet */
2196 if (!tp_features.hotkey) {
2197 hotkey_driver_mask = mask;
2198 return 0;
2199 }
2200
2201 mutex_lock(&hotkey_mutex);
2202
2203 HOTKEY_CONFIG_CRITICAL_START
2204 hotkey_driver_mask = mask;
2205#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2206 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2207#endif
2208 HOTKEY_CONFIG_CRITICAL_END
2209
2210 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2211 ~hotkey_source_mask);
2212 hotkey_poll_setup(true);
2213
2214 mutex_unlock(&hotkey_mutex);
2215
2216 return rc;
2217}
2218
2219static int hotkey_status_get(int *status)
2220{
2221 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2222 return -EIO;
2223
2224 return 0;
2225}
2226
2227static int hotkey_status_set(bool enable)
2228{
2229 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2230 return -EIO;
2231
2232 return 0;
2233}
2234
2235static void tpacpi_input_send_tabletsw(void)
2236{
2237 int state;
2238
2239 if (tp_features.hotkey_tablet &&
2240 !hotkey_get_tablet_mode(&state)) {
2241 mutex_lock(&tpacpi_inputdev_send_mutex);
2242
2243 input_report_switch(tpacpi_inputdev,
2244 SW_TABLET_MODE, !!state);
2245 input_sync(tpacpi_inputdev);
2246
2247 mutex_unlock(&tpacpi_inputdev_send_mutex);
2248 }
2249}
2250
2251/* Do NOT call without validating scancode first */
2252static void tpacpi_input_send_key(const unsigned int scancode)
2253{
2254 const unsigned int keycode = hotkey_keycode_map[scancode];
2255
2256 if (keycode != KEY_RESERVED) {
2257 mutex_lock(&tpacpi_inputdev_send_mutex);
2258
2259 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2260 input_report_key(tpacpi_inputdev, keycode, 1);
2261 input_sync(tpacpi_inputdev);
2262
2263 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2264 input_report_key(tpacpi_inputdev, keycode, 0);
2265 input_sync(tpacpi_inputdev);
2266
2267 mutex_unlock(&tpacpi_inputdev_send_mutex);
2268 }
2269}
2270
2271/* Do NOT call without validating scancode first */
2272static void tpacpi_input_send_key_masked(const unsigned int scancode)
2273{
2274 hotkey_driver_event(scancode);
2275 if (hotkey_user_mask & (1 << scancode))
2276 tpacpi_input_send_key(scancode);
2277}
2278
2279#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2280static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2281
2282/* Do NOT call without validating scancode first */
2283static void tpacpi_hotkey_send_key(unsigned int scancode)
2284{
2285 tpacpi_input_send_key_masked(scancode);
2286 if (hotkey_report_mode < 2) {
2287 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2288 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2289 }
2290}
2291
2292static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2293{
2294 u8 d;
2295
2296 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2297 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2298 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2299 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2300 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2301 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2302 }
2303 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2304 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2305 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2306 }
2307 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2308 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2309 n->displayexp_toggle =
2310 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2311 }
2312 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2313 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2314 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2315 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2316 n->brightness_toggle =
2317 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2318 }
2319 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2320 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2321 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2322 >> TP_NVRAM_POS_LEVEL_VOLUME;
2323 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2324 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2325 }
2326}
2327
2328static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2329 struct tp_nvram_state *newn,
2330 const u32 event_mask)
2331{
2332
2333#define TPACPI_COMPARE_KEY(__scancode, __member) \
2334 do { \
2335 if ((event_mask & (1 << __scancode)) && \
2336 oldn->__member != newn->__member) \
2337 tpacpi_hotkey_send_key(__scancode); \
2338 } while (0)
2339
2340#define TPACPI_MAY_SEND_KEY(__scancode) \
2341 do { \
2342 if (event_mask & (1 << __scancode)) \
2343 tpacpi_hotkey_send_key(__scancode); \
2344 } while (0)
2345
2346 void issue_volchange(const unsigned int oldvol,
2347 const unsigned int newvol)
2348 {
2349 unsigned int i = oldvol;
2350
2351 while (i > newvol) {
2352 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2353 i--;
2354 }
2355 while (i < newvol) {
2356 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2357 i++;
2358 }
2359 }
2360
2361 void issue_brightnesschange(const unsigned int oldbrt,
2362 const unsigned int newbrt)
2363 {
2364 unsigned int i = oldbrt;
2365
2366 while (i > newbrt) {
2367 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2368 i--;
2369 }
2370 while (i < newbrt) {
2371 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2372 i++;
2373 }
2374 }
2375
2376 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2377 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2378 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2379 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2380
2381 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2382
2383 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2384
2385 /*
2386 * Handle volume
2387 *
2388 * This code is supposed to duplicate the IBM firmware behaviour:
2389 * - Pressing MUTE issues mute hotkey message, even when already mute
2390 * - Pressing Volume up/down issues volume up/down hotkey messages,
2391 * even when already at maximum or minimum volume
2392 * - The act of unmuting issues volume up/down notification,
2393 * depending which key was used to unmute
2394 *
2395 * We are constrained to what the NVRAM can tell us, which is not much
2396 * and certainly not enough if more than one volume hotkey was pressed
2397 * since the last poll cycle.
2398 *
2399 * Just to make our life interesting, some newer Lenovo ThinkPads have
2400 * bugs in the BIOS and may fail to update volume_toggle properly.
2401 */
2402 if (newn->mute) {
2403 /* muted */
2404 if (!oldn->mute ||
2405 oldn->volume_toggle != newn->volume_toggle ||
2406 oldn->volume_level != newn->volume_level) {
2407 /* recently muted, or repeated mute keypress, or
2408 * multiple presses ending in mute */
2409 issue_volchange(oldn->volume_level, newn->volume_level);
2410 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2411 }
2412 } else {
2413 /* unmute */
2414 if (oldn->mute) {
2415 /* recently unmuted, issue 'unmute' keypress */
2416 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2417 }
2418 if (oldn->volume_level != newn->volume_level) {
2419 issue_volchange(oldn->volume_level, newn->volume_level);
2420 } else if (oldn->volume_toggle != newn->volume_toggle) {
2421 /* repeated vol up/down keypress at end of scale ? */
2422 if (newn->volume_level == 0)
2423 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2424 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2425 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2426 }
2427 }
2428
2429 /* handle brightness */
2430 if (oldn->brightness_level != newn->brightness_level) {
2431 issue_brightnesschange(oldn->brightness_level,
2432 newn->brightness_level);
2433 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2434 /* repeated key presses that didn't change state */
2435 if (newn->brightness_level == 0)
2436 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2437 else if (newn->brightness_level >= bright_maxlvl
2438 && !tp_features.bright_unkfw)
2439 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2440 }
2441
2442#undef TPACPI_COMPARE_KEY
2443#undef TPACPI_MAY_SEND_KEY
2444}
2445
2446/*
2447 * Polling driver
2448 *
2449 * We track all events in hotkey_source_mask all the time, since
2450 * most of them are edge-based. We only issue those requested by
2451 * hotkey_user_mask or hotkey_driver_mask, though.
2452 */
2453static int hotkey_kthread(void *data)
2454{
2455 struct tp_nvram_state s[2];
2456 u32 poll_mask, event_mask;
2457 unsigned int si, so;
2458 unsigned long t;
2459 unsigned int change_detector, must_reset;
2460 unsigned int poll_freq;
2461
2462 mutex_lock(&hotkey_thread_mutex);
2463
2464 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2465 goto exit;
2466
2467 set_freezable();
2468
2469 so = 0;
2470 si = 1;
2471 t = 0;
2472
2473 /* Initial state for compares */
2474 mutex_lock(&hotkey_thread_data_mutex);
2475 change_detector = hotkey_config_change;
2476 poll_mask = hotkey_source_mask;
2477 event_mask = hotkey_source_mask &
2478 (hotkey_driver_mask | hotkey_user_mask);
2479 poll_freq = hotkey_poll_freq;
2480 mutex_unlock(&hotkey_thread_data_mutex);
2481 hotkey_read_nvram(&s[so], poll_mask);
2482
2483 while (!kthread_should_stop()) {
2484 if (t == 0) {
2485 if (likely(poll_freq))
2486 t = 1000/poll_freq;
2487 else
2488 t = 100; /* should never happen... */
2489 }
2490 t = msleep_interruptible(t);
2491 if (unlikely(kthread_should_stop()))
2492 break;
2493 must_reset = try_to_freeze();
2494 if (t > 0 && !must_reset)
2495 continue;
2496
2497 mutex_lock(&hotkey_thread_data_mutex);
2498 if (must_reset || hotkey_config_change != change_detector) {
2499 /* forget old state on thaw or config change */
2500 si = so;
2501 t = 0;
2502 change_detector = hotkey_config_change;
2503 }
2504 poll_mask = hotkey_source_mask;
2505 event_mask = hotkey_source_mask &
2506 (hotkey_driver_mask | hotkey_user_mask);
2507 poll_freq = hotkey_poll_freq;
2508 mutex_unlock(&hotkey_thread_data_mutex);
2509
2510 if (likely(poll_mask)) {
2511 hotkey_read_nvram(&s[si], poll_mask);
2512 if (likely(si != so)) {
2513 hotkey_compare_and_issue_event(&s[so], &s[si],
2514 event_mask);
2515 }
2516 }
2517
2518 so = si;
2519 si ^= 1;
2520 }
2521
2522exit:
2523 mutex_unlock(&hotkey_thread_mutex);
2524 return 0;
2525}
2526
2527/* call with hotkey_mutex held */
2528static void hotkey_poll_stop_sync(void)
2529{
2530 if (tpacpi_hotkey_task) {
2531 if (frozen(tpacpi_hotkey_task) ||
2532 freezing(tpacpi_hotkey_task))
2533 thaw_process(tpacpi_hotkey_task);
2534
2535 kthread_stop(tpacpi_hotkey_task);
2536 tpacpi_hotkey_task = NULL;
2537 mutex_lock(&hotkey_thread_mutex);
2538 /* at this point, the thread did exit */
2539 mutex_unlock(&hotkey_thread_mutex);
2540 }
2541}
2542
2543/* call with hotkey_mutex held */
2544static void hotkey_poll_setup(const bool may_warn)
2545{
2546 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2547 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2548
2549 if (hotkey_poll_freq > 0 &&
2550 (poll_driver_mask ||
2551 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2552 if (!tpacpi_hotkey_task) {
2553 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2554 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2555 if (IS_ERR(tpacpi_hotkey_task)) {
2556 tpacpi_hotkey_task = NULL;
2557 pr_err("could not create kernel thread "
2558 "for hotkey polling\n");
2559 }
2560 }
2561 } else {
2562 hotkey_poll_stop_sync();
2563 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2564 hotkey_poll_freq == 0) {
2565 pr_notice("hot keys 0x%08x and/or events 0x%08x "
2566 "require polling, which is currently "
2567 "disabled\n",
2568 poll_user_mask, poll_driver_mask);
2569 }
2570 }
2571}
2572
2573static void hotkey_poll_setup_safe(const bool may_warn)
2574{
2575 mutex_lock(&hotkey_mutex);
2576 hotkey_poll_setup(may_warn);
2577 mutex_unlock(&hotkey_mutex);
2578}
2579
2580/* call with hotkey_mutex held */
2581static void hotkey_poll_set_freq(unsigned int freq)
2582{
2583 if (!freq)
2584 hotkey_poll_stop_sync();
2585
2586 hotkey_poll_freq = freq;
2587}
2588
2589#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2590
2591static void hotkey_poll_setup(const bool __unused)
2592{
2593}
2594
2595static void hotkey_poll_setup_safe(const bool __unused)
2596{
2597}
2598
2599#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2600
2601static int hotkey_inputdev_open(struct input_dev *dev)
2602{
2603 switch (tpacpi_lifecycle) {
2604 case TPACPI_LIFE_INIT:
2605 case TPACPI_LIFE_RUNNING:
2606 hotkey_poll_setup_safe(false);
2607 return 0;
2608 case TPACPI_LIFE_EXITING:
2609 return -EBUSY;
2610 }
2611
2612 /* Should only happen if tpacpi_lifecycle is corrupt */
2613 BUG();
2614 return -EBUSY;
2615}
2616
2617static void hotkey_inputdev_close(struct input_dev *dev)
2618{
2619 /* disable hotkey polling when possible */
2620 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2621 !(hotkey_source_mask & hotkey_driver_mask))
2622 hotkey_poll_setup_safe(false);
2623}
2624
2625/* sysfs hotkey enable ------------------------------------------------- */
2626static ssize_t hotkey_enable_show(struct device *dev,
2627 struct device_attribute *attr,
2628 char *buf)
2629{
2630 int res, status;
2631
2632 printk_deprecated_attribute("hotkey_enable",
2633 "Hotkey reporting is always enabled");
2634
2635 res = hotkey_status_get(&status);
2636 if (res)
2637 return res;
2638
2639 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2640}
2641
2642static ssize_t hotkey_enable_store(struct device *dev,
2643 struct device_attribute *attr,
2644 const char *buf, size_t count)
2645{
2646 unsigned long t;
2647
2648 printk_deprecated_attribute("hotkey_enable",
2649 "Hotkeys can be disabled through hotkey_mask");
2650
2651 if (parse_strtoul(buf, 1, &t))
2652 return -EINVAL;
2653
2654 if (t == 0)
2655 return -EPERM;
2656
2657 return count;
2658}
2659
2660static struct device_attribute dev_attr_hotkey_enable =
2661 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2662 hotkey_enable_show, hotkey_enable_store);
2663
2664/* sysfs hotkey mask --------------------------------------------------- */
2665static ssize_t hotkey_mask_show(struct device *dev,
2666 struct device_attribute *attr,
2667 char *buf)
2668{
2669 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2670}
2671
2672static ssize_t hotkey_mask_store(struct device *dev,
2673 struct device_attribute *attr,
2674 const char *buf, size_t count)
2675{
2676 unsigned long t;
2677 int res;
2678
2679 if (parse_strtoul(buf, 0xffffffffUL, &t))
2680 return -EINVAL;
2681
2682 if (mutex_lock_killable(&hotkey_mutex))
2683 return -ERESTARTSYS;
2684
2685 res = hotkey_user_mask_set(t);
2686
2687#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2688 hotkey_poll_setup(true);
2689#endif
2690
2691 mutex_unlock(&hotkey_mutex);
2692
2693 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2694
2695 return (res) ? res : count;
2696}
2697
2698static struct device_attribute dev_attr_hotkey_mask =
2699 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2700 hotkey_mask_show, hotkey_mask_store);
2701
2702/* sysfs hotkey bios_enabled ------------------------------------------- */
2703static ssize_t hotkey_bios_enabled_show(struct device *dev,
2704 struct device_attribute *attr,
2705 char *buf)
2706{
2707 return sprintf(buf, "0\n");
2708}
2709
2710static struct device_attribute dev_attr_hotkey_bios_enabled =
2711 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2712
2713/* sysfs hotkey bios_mask ---------------------------------------------- */
2714static ssize_t hotkey_bios_mask_show(struct device *dev,
2715 struct device_attribute *attr,
2716 char *buf)
2717{
2718 printk_deprecated_attribute("hotkey_bios_mask",
2719 "This attribute is useless.");
2720 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2721}
2722
2723static struct device_attribute dev_attr_hotkey_bios_mask =
2724 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2725
2726/* sysfs hotkey all_mask ----------------------------------------------- */
2727static ssize_t hotkey_all_mask_show(struct device *dev,
2728 struct device_attribute *attr,
2729 char *buf)
2730{
2731 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2732 hotkey_all_mask | hotkey_source_mask);
2733}
2734
2735static struct device_attribute dev_attr_hotkey_all_mask =
2736 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2737
2738/* sysfs hotkey recommended_mask --------------------------------------- */
2739static ssize_t hotkey_recommended_mask_show(struct device *dev,
2740 struct device_attribute *attr,
2741 char *buf)
2742{
2743 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2744 (hotkey_all_mask | hotkey_source_mask)
2745 & ~hotkey_reserved_mask);
2746}
2747
2748static struct device_attribute dev_attr_hotkey_recommended_mask =
2749 __ATTR(hotkey_recommended_mask, S_IRUGO,
2750 hotkey_recommended_mask_show, NULL);
2751
2752#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2753
2754/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2755static ssize_t hotkey_source_mask_show(struct device *dev,
2756 struct device_attribute *attr,
2757 char *buf)
2758{
2759 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2760}
2761
2762static ssize_t hotkey_source_mask_store(struct device *dev,
2763 struct device_attribute *attr,
2764 const char *buf, size_t count)
2765{
2766 unsigned long t;
2767 u32 r_ev;
2768 int rc;
2769
2770 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2771 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2772 return -EINVAL;
2773
2774 if (mutex_lock_killable(&hotkey_mutex))
2775 return -ERESTARTSYS;
2776
2777 HOTKEY_CONFIG_CRITICAL_START
2778 hotkey_source_mask = t;
2779 HOTKEY_CONFIG_CRITICAL_END
2780
2781 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2782 ~hotkey_source_mask);
2783 hotkey_poll_setup(true);
2784
2785 /* check if events needed by the driver got disabled */
2786 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2787 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2788
2789 mutex_unlock(&hotkey_mutex);
2790
2791 if (rc < 0)
2792 pr_err("hotkey_source_mask: "
2793 "failed to update the firmware event mask!\n");
2794
2795 if (r_ev)
2796 pr_notice("hotkey_source_mask: "
2797 "some important events were disabled: 0x%04x\n",
2798 r_ev);
2799
2800 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2801
2802 return (rc < 0) ? rc : count;
2803}
2804
2805static struct device_attribute dev_attr_hotkey_source_mask =
2806 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2807 hotkey_source_mask_show, hotkey_source_mask_store);
2808
2809/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2810static ssize_t hotkey_poll_freq_show(struct device *dev,
2811 struct device_attribute *attr,
2812 char *buf)
2813{
2814 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2815}
2816
2817static ssize_t hotkey_poll_freq_store(struct device *dev,
2818 struct device_attribute *attr,
2819 const char *buf, size_t count)
2820{
2821 unsigned long t;
2822
2823 if (parse_strtoul(buf, 25, &t))
2824 return -EINVAL;
2825
2826 if (mutex_lock_killable(&hotkey_mutex))
2827 return -ERESTARTSYS;
2828
2829 hotkey_poll_set_freq(t);
2830 hotkey_poll_setup(true);
2831
2832 mutex_unlock(&hotkey_mutex);
2833
2834 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2835
2836 return count;
2837}
2838
2839static struct device_attribute dev_attr_hotkey_poll_freq =
2840 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2841 hotkey_poll_freq_show, hotkey_poll_freq_store);
2842
2843#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2844
2845/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2846static ssize_t hotkey_radio_sw_show(struct device *dev,
2847 struct device_attribute *attr,
2848 char *buf)
2849{
2850 int res;
2851 res = hotkey_get_wlsw();
2852 if (res < 0)
2853 return res;
2854
2855 /* Opportunistic update */
2856 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2857
2858 return snprintf(buf, PAGE_SIZE, "%d\n",
2859 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2860}
2861
2862static struct device_attribute dev_attr_hotkey_radio_sw =
2863 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2864
2865static void hotkey_radio_sw_notify_change(void)
2866{
2867 if (tp_features.hotkey_wlsw)
2868 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2869 "hotkey_radio_sw");
2870}
2871
2872/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2873static ssize_t hotkey_tablet_mode_show(struct device *dev,
2874 struct device_attribute *attr,
2875 char *buf)
2876{
2877 int res, s;
2878 res = hotkey_get_tablet_mode(&s);
2879 if (res < 0)
2880 return res;
2881
2882 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2883}
2884
2885static struct device_attribute dev_attr_hotkey_tablet_mode =
2886 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2887
2888static void hotkey_tablet_mode_notify_change(void)
2889{
2890 if (tp_features.hotkey_tablet)
2891 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2892 "hotkey_tablet_mode");
2893}
2894
2895/* sysfs hotkey report_mode -------------------------------------------- */
2896static ssize_t hotkey_report_mode_show(struct device *dev,
2897 struct device_attribute *attr,
2898 char *buf)
2899{
2900 return snprintf(buf, PAGE_SIZE, "%d\n",
2901 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2902}
2903
2904static struct device_attribute dev_attr_hotkey_report_mode =
2905 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2906
2907/* sysfs wakeup reason (pollable) -------------------------------------- */
2908static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2909 struct device_attribute *attr,
2910 char *buf)
2911{
2912 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2913}
2914
2915static struct device_attribute dev_attr_hotkey_wakeup_reason =
2916 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2917
2918static void hotkey_wakeup_reason_notify_change(void)
2919{
2920 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2921 "wakeup_reason");
2922}
2923
2924/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2925static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2926 struct device_attribute *attr,
2927 char *buf)
2928{
2929 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2930}
2931
2932static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2933 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2934 hotkey_wakeup_hotunplug_complete_show, NULL);
2935
2936static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2937{
2938 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2939 "wakeup_hotunplug_complete");
2940}
2941
2942/* --------------------------------------------------------------------- */
2943
2944static struct attribute *hotkey_attributes[] __initdata = {
2945 &dev_attr_hotkey_enable.attr,
2946 &dev_attr_hotkey_bios_enabled.attr,
2947 &dev_attr_hotkey_bios_mask.attr,
2948 &dev_attr_hotkey_report_mode.attr,
2949 &dev_attr_hotkey_wakeup_reason.attr,
2950 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2951 &dev_attr_hotkey_mask.attr,
2952 &dev_attr_hotkey_all_mask.attr,
2953 &dev_attr_hotkey_recommended_mask.attr,
2954#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2955 &dev_attr_hotkey_source_mask.attr,
2956 &dev_attr_hotkey_poll_freq.attr,
2957#endif
2958};
2959
2960/*
2961 * Sync both the hw and sw blocking state of all switches
2962 */
2963static void tpacpi_send_radiosw_update(void)
2964{
2965 int wlsw;
2966
2967 /*
2968 * We must sync all rfkill controllers *before* issuing any
2969 * rfkill input events, or we will race the rfkill core input
2970 * handler.
2971 *
2972 * tpacpi_inputdev_send_mutex works as a synchronization point
2973 * for the above.
2974 *
2975 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2976 */
2977
2978 wlsw = hotkey_get_wlsw();
2979
2980 /* Sync hw blocking state first if it is hw-blocked */
2981 if (wlsw == TPACPI_RFK_RADIO_OFF)
2982 tpacpi_rfk_update_hwblock_state(true);
2983
2984 /* Sync sw blocking state */
2985 tpacpi_rfk_update_swstate_all();
2986
2987 /* Sync hw blocking state last if it is hw-unblocked */
2988 if (wlsw == TPACPI_RFK_RADIO_ON)
2989 tpacpi_rfk_update_hwblock_state(false);
2990
2991 /* Issue rfkill input event for WLSW switch */
2992 if (!(wlsw < 0)) {
2993 mutex_lock(&tpacpi_inputdev_send_mutex);
2994
2995 input_report_switch(tpacpi_inputdev,
2996 SW_RFKILL_ALL, (wlsw > 0));
2997 input_sync(tpacpi_inputdev);
2998
2999 mutex_unlock(&tpacpi_inputdev_send_mutex);
3000 }
3001
3002 /*
3003 * this can be unconditional, as we will poll state again
3004 * if userspace uses the notify to read data
3005 */
3006 hotkey_radio_sw_notify_change();
3007}
3008
3009static void hotkey_exit(void)
3010{
3011#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3012 mutex_lock(&hotkey_mutex);
3013 hotkey_poll_stop_sync();
3014 mutex_unlock(&hotkey_mutex);
3015#endif
3016
3017 if (hotkey_dev_attributes)
3018 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3019
3020 kfree(hotkey_keycode_map);
3021
3022 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3023 "restoring original HKEY status and mask\n");
3024 /* yes, there is a bitwise or below, we want the
3025 * functions to be called even if one of them fail */
3026 if (((tp_features.hotkey_mask &&
3027 hotkey_mask_set(hotkey_orig_mask)) |
3028 hotkey_status_set(false)) != 0)
3029 pr_err("failed to restore hot key mask "
3030 "to BIOS defaults\n");
3031}
3032
3033static void __init hotkey_unmap(const unsigned int scancode)
3034{
3035 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3036 clear_bit(hotkey_keycode_map[scancode],
3037 tpacpi_inputdev->keybit);
3038 hotkey_keycode_map[scancode] = KEY_RESERVED;
3039 }
3040}
3041
3042/*
3043 * HKEY quirks:
3044 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3045 */
3046
3047#define TPACPI_HK_Q_INIMASK 0x0001
3048
3049static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3050 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3051 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3052 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3053 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3054 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3055 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3056 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3057 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3058 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3059 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3060 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3061 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3062 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3063 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3064 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3065 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3066 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3067 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3068 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3069};
3070
3071typedef u16 tpacpi_keymap_entry_t;
3072typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3073
3074static int __init hotkey_init(struct ibm_init_struct *iibm)
3075{
3076 /* Requirements for changing the default keymaps:
3077 *
3078 * 1. Many of the keys are mapped to KEY_RESERVED for very
3079 * good reasons. Do not change them unless you have deep
3080 * knowledge on the IBM and Lenovo ThinkPad firmware for
3081 * the various ThinkPad models. The driver behaves
3082 * differently for KEY_RESERVED: such keys have their
3083 * hot key mask *unset* in mask_recommended, and also
3084 * in the initial hot key mask programmed into the
3085 * firmware at driver load time, which means the firm-
3086 * ware may react very differently if you change them to
3087 * something else;
3088 *
3089 * 2. You must be subscribed to the linux-thinkpad and
3090 * ibm-acpi-devel mailing lists, and you should read the
3091 * list archives since 2007 if you want to change the
3092 * keymaps. This requirement exists so that you will
3093 * know the past history of problems with the thinkpad-
3094 * acpi driver keymaps, and also that you will be
3095 * listening to any bug reports;
3096 *
3097 * 3. Do not send thinkpad-acpi specific patches directly to
3098 * for merging, *ever*. Send them to the linux-acpi
3099 * mailinglist for comments. Merging is to be done only
3100 * through acpi-test and the ACPI maintainer.
3101 *
3102 * If the above is too much to ask, don't change the keymap.
3103 * Ask the thinkpad-acpi maintainer to do it, instead.
3104 */
3105
3106 enum keymap_index {
3107 TPACPI_KEYMAP_IBM_GENERIC = 0,
3108 TPACPI_KEYMAP_LENOVO_GENERIC,
3109 };
3110
3111 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3112 /* Generic keymap for IBM ThinkPads */
3113 [TPACPI_KEYMAP_IBM_GENERIC] = {
3114 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3115 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3116 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3117 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3118
3119 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3120 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3121 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3122 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3123
3124 /* brightness: firmware always reacts to them */
3125 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3126 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3127
3128 /* Thinklight: firmware always react to it */
3129 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3130
3131 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3132 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3133
3134 /* Volume: firmware always react to it and reprograms
3135 * the built-in *extra* mixer. Never map it to control
3136 * another mixer by default. */
3137 KEY_RESERVED, /* 0x14: VOLUME UP */
3138 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3139 KEY_RESERVED, /* 0x16: MUTE */
3140
3141 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3142
3143 /* (assignments unknown, please report if found) */
3144 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3145 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3146 },
3147
3148 /* Generic keymap for Lenovo ThinkPads */
3149 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3150 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3151 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3152 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3153 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3154
3155 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3156 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3157 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3158 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3159
3160 /* These should be enabled --only-- when ACPI video
3161 * is disabled (i.e. in "vendor" mode), and are handled
3162 * in a special way by the init code */
3163 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3164 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3165
3166 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3167
3168 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3169 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3170
3171 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3172 * react to it and reprograms the built-in *extra* mixer.
3173 * Never map it to control another mixer by default.
3174 *
3175 * T60?, T61, R60?, R61: firmware and EC tries to send
3176 * these over the regular keyboard, so these are no-ops,
3177 * but there are still weird bugs re. MUTE, so do not
3178 * change unless you get test reports from all Lenovo
3179 * models. May cause the BIOS to interfere with the
3180 * HDA mixer.
3181 */
3182 KEY_RESERVED, /* 0x14: VOLUME UP */
3183 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3184 KEY_RESERVED, /* 0x16: MUTE */
3185
3186 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3187
3188 /* (assignments unknown, please report if found) */
3189 KEY_UNKNOWN, KEY_UNKNOWN,
3190
3191 /*
3192 * The mic mute button only sends 0x1a. It does not
3193 * automatically mute the mic or change the mute light.
3194 */
3195 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3196
3197 /* (assignments unknown, please report if found) */
3198 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3199 KEY_UNKNOWN,
3200 },
3201 };
3202
3203 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3204 /* Generic maps (fallback) */
3205 {
3206 .vendor = PCI_VENDOR_ID_IBM,
3207 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3208 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3209 },
3210 {
3211 .vendor = PCI_VENDOR_ID_LENOVO,
3212 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3213 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3214 },
3215 };
3216
3217#define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3218#define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3219
3220 int res, i;
3221 int status;
3222 int hkeyv;
3223 bool radiosw_state = false;
3224 bool tabletsw_state = false;
3225
3226 unsigned long quirks;
3227 unsigned long keymap_id;
3228
3229 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3230 "initializing hotkey subdriver\n");
3231
3232 BUG_ON(!tpacpi_inputdev);
3233 BUG_ON(tpacpi_inputdev->open != NULL ||
3234 tpacpi_inputdev->close != NULL);
3235
3236 TPACPI_ACPIHANDLE_INIT(hkey);
3237 mutex_init(&hotkey_mutex);
3238
3239#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3240 mutex_init(&hotkey_thread_mutex);
3241 mutex_init(&hotkey_thread_data_mutex);
3242#endif
3243
3244 /* hotkey not supported on 570 */
3245 tp_features.hotkey = hkey_handle != NULL;
3246
3247 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3248 "hotkeys are %s\n",
3249 str_supported(tp_features.hotkey));
3250
3251 if (!tp_features.hotkey)
3252 return 1;
3253
3254 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3255 ARRAY_SIZE(tpacpi_hotkey_qtable));
3256
3257 tpacpi_disable_brightness_delay();
3258
3259 /* MUST have enough space for all attributes to be added to
3260 * hotkey_dev_attributes */
3261 hotkey_dev_attributes = create_attr_set(
3262 ARRAY_SIZE(hotkey_attributes) + 2,
3263 NULL);
3264 if (!hotkey_dev_attributes)
3265 return -ENOMEM;
3266 res = add_many_to_attr_set(hotkey_dev_attributes,
3267 hotkey_attributes,
3268 ARRAY_SIZE(hotkey_attributes));
3269 if (res)
3270 goto err_exit;
3271
3272 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3273 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3274 for HKEY interface version 0x100 */
3275 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3276 if ((hkeyv >> 8) != 1) {
3277 pr_err("unknown version of the HKEY interface: 0x%x\n",
3278 hkeyv);
3279 pr_err("please report this to %s\n", TPACPI_MAIL);
3280 } else {
3281 /*
3282 * MHKV 0x100 in A31, R40, R40e,
3283 * T4x, X31, and later
3284 */
3285 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3286 "firmware HKEY interface version: 0x%x\n",
3287 hkeyv);
3288
3289 /* Paranoia check AND init hotkey_all_mask */
3290 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3291 "MHKA", "qd")) {
3292 pr_err("missing MHKA handler, "
3293 "please report this to %s\n",
3294 TPACPI_MAIL);
3295 /* Fallback: pre-init for FN+F3,F4,F12 */
3296 hotkey_all_mask = 0x080cU;
3297 } else {
3298 tp_features.hotkey_mask = 1;
3299 }
3300 }
3301 }
3302
3303 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3304 "hotkey masks are %s\n",
3305 str_supported(tp_features.hotkey_mask));
3306
3307 /* Init hotkey_all_mask if not initialized yet */
3308 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3309 (quirks & TPACPI_HK_Q_INIMASK))
3310 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3311
3312 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3313 if (tp_features.hotkey_mask) {
3314 /* hotkey_source_mask *must* be zero for
3315 * the first hotkey_mask_get to return hotkey_orig_mask */
3316 res = hotkey_mask_get();
3317 if (res)
3318 goto err_exit;
3319
3320 hotkey_orig_mask = hotkey_acpi_mask;
3321 } else {
3322 hotkey_orig_mask = hotkey_all_mask;
3323 hotkey_acpi_mask = hotkey_all_mask;
3324 }
3325
3326#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3327 if (dbg_wlswemul) {
3328 tp_features.hotkey_wlsw = 1;
3329 radiosw_state = !!tpacpi_wlsw_emulstate;
3330 pr_info("radio switch emulation enabled\n");
3331 } else
3332#endif
3333 /* Not all thinkpads have a hardware radio switch */
3334 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3335 tp_features.hotkey_wlsw = 1;
3336 radiosw_state = !!status;
3337 pr_info("radio switch found; radios are %s\n",
3338 enabled(status, 0));
3339 }
3340 if (tp_features.hotkey_wlsw)
3341 res = add_to_attr_set(hotkey_dev_attributes,
3342 &dev_attr_hotkey_radio_sw.attr);
3343
3344 /* For X41t, X60t, X61t Tablets... */
3345 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3346 tp_features.hotkey_tablet = 1;
3347 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3348 pr_info("possible tablet mode switch found; "
3349 "ThinkPad in %s mode\n",
3350 (tabletsw_state) ? "tablet" : "laptop");
3351 res = add_to_attr_set(hotkey_dev_attributes,
3352 &dev_attr_hotkey_tablet_mode.attr);
3353 }
3354
3355 if (!res)
3356 res = register_attr_set_with_sysfs(
3357 hotkey_dev_attributes,
3358 &tpacpi_pdev->dev.kobj);
3359 if (res)
3360 goto err_exit;
3361
3362 /* Set up key map */
3363 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3364 GFP_KERNEL);
3365 if (!hotkey_keycode_map) {
3366 pr_err("failed to allocate memory for key map\n");
3367 res = -ENOMEM;
3368 goto err_exit;
3369 }
3370
3371 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3372 ARRAY_SIZE(tpacpi_keymap_qtable));
3373 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3374 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3375 "using keymap number %lu\n", keymap_id);
3376
3377 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3378 TPACPI_HOTKEY_MAP_SIZE);
3379
3380 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3381 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3382 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3383 tpacpi_inputdev->keycode = hotkey_keycode_map;
3384 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3385 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3386 input_set_capability(tpacpi_inputdev, EV_KEY,
3387 hotkey_keycode_map[i]);
3388 } else {
3389 if (i < sizeof(hotkey_reserved_mask)*8)
3390 hotkey_reserved_mask |= 1 << i;
3391 }
3392 }
3393
3394 if (tp_features.hotkey_wlsw) {
3395 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3396 input_report_switch(tpacpi_inputdev,
3397 SW_RFKILL_ALL, radiosw_state);
3398 }
3399 if (tp_features.hotkey_tablet) {
3400 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3401 input_report_switch(tpacpi_inputdev,
3402 SW_TABLET_MODE, tabletsw_state);
3403 }
3404
3405 /* Do not issue duplicate brightness change events to
3406 * userspace. tpacpi_detect_brightness_capabilities() must have
3407 * been called before this point */
3408 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3409 pr_info("This ThinkPad has standard ACPI backlight "
3410 "brightness control, supported by the ACPI "
3411 "video driver\n");
3412 pr_notice("Disabling thinkpad-acpi brightness events "
3413 "by default...\n");
3414
3415 /* Disable brightness up/down on Lenovo thinkpads when
3416 * ACPI is handling them, otherwise it is plain impossible
3417 * for userspace to do something even remotely sane */
3418 hotkey_reserved_mask |=
3419 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3420 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3421 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3422 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3423 }
3424
3425#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3426 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3427 & ~hotkey_all_mask
3428 & ~hotkey_reserved_mask;
3429
3430 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3431 "hotkey source mask 0x%08x, polling freq %u\n",
3432 hotkey_source_mask, hotkey_poll_freq);
3433#endif
3434
3435 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3436 "enabling firmware HKEY event interface...\n");
3437 res = hotkey_status_set(true);
3438 if (res) {
3439 hotkey_exit();
3440 return res;
3441 }
3442 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3443 | hotkey_driver_mask)
3444 & ~hotkey_source_mask);
3445 if (res < 0 && res != -ENXIO) {
3446 hotkey_exit();
3447 return res;
3448 }
3449 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3450 & ~hotkey_reserved_mask;
3451 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3452 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3453 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3454
3455 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3456 "legacy ibm/hotkey event reporting over procfs %s\n",
3457 (hotkey_report_mode < 2) ?
3458 "enabled" : "disabled");
3459
3460 tpacpi_inputdev->open = &hotkey_inputdev_open;
3461 tpacpi_inputdev->close = &hotkey_inputdev_close;
3462
3463 hotkey_poll_setup_safe(true);
3464
3465 return 0;
3466
3467err_exit:
3468 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3469 hotkey_dev_attributes = NULL;
3470
3471 return (res < 0)? res : 1;
3472}
3473
3474static bool hotkey_notify_hotkey(const u32 hkey,
3475 bool *send_acpi_ev,
3476 bool *ignore_acpi_ev)
3477{
3478 /* 0x1000-0x1FFF: key presses */
3479 unsigned int scancode = hkey & 0xfff;
3480 *send_acpi_ev = true;
3481 *ignore_acpi_ev = false;
3482
3483 /* HKEY event 0x1001 is scancode 0x00 */
3484 if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3485 scancode--;
3486 if (!(hotkey_source_mask & (1 << scancode))) {
3487 tpacpi_input_send_key_masked(scancode);
3488 *send_acpi_ev = false;
3489 } else {
3490 *ignore_acpi_ev = true;
3491 }
3492 return true;
3493 }
3494 return false;
3495}
3496
3497static bool hotkey_notify_wakeup(const u32 hkey,
3498 bool *send_acpi_ev,
3499 bool *ignore_acpi_ev)
3500{
3501 /* 0x2000-0x2FFF: Wakeup reason */
3502 *send_acpi_ev = true;
3503 *ignore_acpi_ev = false;
3504
3505 switch (hkey) {
3506 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3507 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3508 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3509 *ignore_acpi_ev = true;
3510 break;
3511
3512 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3513 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3514 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3515 *ignore_acpi_ev = true;
3516 break;
3517
3518 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3519 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3520 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3521 /* how to auto-heal: */
3522 /* 2313: woke up from S3, go to S4/S5 */
3523 /* 2413: woke up from S4, go to S5 */
3524 break;
3525
3526 default:
3527 return false;
3528 }
3529
3530 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3531 pr_info("woke up due to a hot-unplug request...\n");
3532 hotkey_wakeup_reason_notify_change();
3533 }
3534 return true;
3535}
3536
3537static bool hotkey_notify_dockevent(const u32 hkey,
3538 bool *send_acpi_ev,
3539 bool *ignore_acpi_ev)
3540{
3541 /* 0x4000-0x4FFF: dock-related events */
3542 *send_acpi_ev = true;
3543 *ignore_acpi_ev = false;
3544
3545 switch (hkey) {
3546 case TP_HKEY_EV_UNDOCK_ACK:
3547 /* ACPI undock operation completed after wakeup */
3548 hotkey_autosleep_ack = 1;
3549 pr_info("undocked\n");
3550 hotkey_wakeup_hotunplug_complete_notify_change();
3551 return true;
3552
3553 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3554 pr_info("docked into hotplug port replicator\n");
3555 return true;
3556 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3557 pr_info("undocked from hotplug port replicator\n");
3558 return true;
3559
3560 default:
3561 return false;
3562 }
3563}
3564
3565static bool hotkey_notify_usrevent(const u32 hkey,
3566 bool *send_acpi_ev,
3567 bool *ignore_acpi_ev)
3568{
3569 /* 0x5000-0x5FFF: human interface helpers */
3570 *send_acpi_ev = true;
3571 *ignore_acpi_ev = false;
3572
3573 switch (hkey) {
3574 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3575 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3576 return true;
3577
3578 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3579 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3580 tpacpi_input_send_tabletsw();
3581 hotkey_tablet_mode_notify_change();
3582 *send_acpi_ev = false;
3583 return true;
3584
3585 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3586 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3587 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3588 /* do not propagate these events */
3589 *ignore_acpi_ev = true;
3590 return true;
3591
3592 default:
3593 return false;
3594 }
3595}
3596
3597static void thermal_dump_all_sensors(void);
3598
3599static bool hotkey_notify_6xxx(const u32 hkey,
3600 bool *send_acpi_ev,
3601 bool *ignore_acpi_ev)
3602{
3603 bool known = true;
3604
3605 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3606 *send_acpi_ev = true;
3607 *ignore_acpi_ev = false;
3608
3609 switch (hkey) {
3610 case TP_HKEY_EV_THM_TABLE_CHANGED:
3611 pr_info("EC reports that Thermal Table has changed\n");
3612 /* recommended action: do nothing, we don't have
3613 * Lenovo ATM information */
3614 return true;
3615 case TP_HKEY_EV_ALARM_BAT_HOT:
3616 pr_crit("THERMAL ALARM: battery is too hot!\n");
3617 /* recommended action: warn user through gui */
3618 break;
3619 case TP_HKEY_EV_ALARM_BAT_XHOT:
3620 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3621 /* recommended action: immediate sleep/hibernate */
3622 break;
3623 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3624 pr_crit("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 pr_alert("THERMAL EMERGENCY: "
3631 "a sensor reports something is extremely hot!\n");
3632 /* recommended action: immediate sleep/hibernate */
3633 break;
3634
3635 case TP_HKEY_EV_KEY_NUMLOCK:
3636 case TP_HKEY_EV_KEY_FN:
3637 /* key press events, we just ignore them as long as the EC
3638 * is still reporting them in the normal keyboard stream */
3639 *send_acpi_ev = false;
3640 *ignore_acpi_ev = true;
3641 return true;
3642
3643 default:
3644 pr_warn("unknown possible thermal alarm or keyboard event received\n");
3645 known = false;
3646 }
3647
3648 thermal_dump_all_sensors();
3649
3650 return known;
3651}
3652
3653static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3654{
3655 u32 hkey;
3656 bool send_acpi_ev;
3657 bool ignore_acpi_ev;
3658 bool known_ev;
3659
3660 if (event != 0x80) {
3661 pr_err("unknown HKEY notification event %d\n", event);
3662 /* forward it to userspace, maybe it knows how to handle it */
3663 acpi_bus_generate_netlink_event(
3664 ibm->acpi->device->pnp.device_class,
3665 dev_name(&ibm->acpi->device->dev),
3666 event, 0);
3667 return;
3668 }
3669
3670 while (1) {
3671 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3672 pr_err("failed to retrieve HKEY event\n");
3673 return;
3674 }
3675
3676 if (hkey == 0) {
3677 /* queue empty */
3678 return;
3679 }
3680
3681 send_acpi_ev = true;
3682 ignore_acpi_ev = false;
3683
3684 switch (hkey >> 12) {
3685 case 1:
3686 /* 0x1000-0x1FFF: key presses */
3687 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3688 &ignore_acpi_ev);
3689 break;
3690 case 2:
3691 /* 0x2000-0x2FFF: Wakeup reason */
3692 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3693 &ignore_acpi_ev);
3694 break;
3695 case 3:
3696 /* 0x3000-0x3FFF: bay-related wakeups */
3697 switch (hkey) {
3698 case TP_HKEY_EV_BAYEJ_ACK:
3699 hotkey_autosleep_ack = 1;
3700 pr_info("bay ejected\n");
3701 hotkey_wakeup_hotunplug_complete_notify_change();
3702 known_ev = true;
3703 break;
3704 case TP_HKEY_EV_OPTDRV_EJ:
3705 /* FIXME: kick libata if SATA link offline */
3706 known_ev = true;
3707 break;
3708 default:
3709 known_ev = false;
3710 }
3711 break;
3712 case 4:
3713 /* 0x4000-0x4FFF: dock-related events */
3714 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
3715 &ignore_acpi_ev);
3716 break;
3717 case 5:
3718 /* 0x5000-0x5FFF: human interface helpers */
3719 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3720 &ignore_acpi_ev);
3721 break;
3722 case 6:
3723 /* 0x6000-0x6FFF: thermal alarms/notices and
3724 * keyboard events */
3725 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
3726 &ignore_acpi_ev);
3727 break;
3728 case 7:
3729 /* 0x7000-0x7FFF: misc */
3730 if (tp_features.hotkey_wlsw &&
3731 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3732 tpacpi_send_radiosw_update();
3733 send_acpi_ev = 0;
3734 known_ev = true;
3735 break;
3736 }
3737 /* fallthrough to default */
3738 default:
3739 known_ev = false;
3740 }
3741 if (!known_ev) {
3742 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
3743 pr_notice("please report the conditions when this "
3744 "event happened to %s\n", TPACPI_MAIL);
3745 }
3746
3747 /* Legacy events */
3748 if (!ignore_acpi_ev &&
3749 (send_acpi_ev || hotkey_report_mode < 2)) {
3750 acpi_bus_generate_proc_event(ibm->acpi->device,
3751 event, hkey);
3752 }
3753
3754 /* netlink events */
3755 if (!ignore_acpi_ev && send_acpi_ev) {
3756 acpi_bus_generate_netlink_event(
3757 ibm->acpi->device->pnp.device_class,
3758 dev_name(&ibm->acpi->device->dev),
3759 event, hkey);
3760 }
3761 }
3762}
3763
3764static void hotkey_suspend(pm_message_t state)
3765{
3766 /* Do these on suspend, we get the events on early resume! */
3767 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3768 hotkey_autosleep_ack = 0;
3769}
3770
3771static void hotkey_resume(void)
3772{
3773 tpacpi_disable_brightness_delay();
3774
3775 if (hotkey_status_set(true) < 0 ||
3776 hotkey_mask_set(hotkey_acpi_mask) < 0)
3777 pr_err("error while attempting to reset the event "
3778 "firmware interface\n");
3779
3780 tpacpi_send_radiosw_update();
3781 hotkey_tablet_mode_notify_change();
3782 hotkey_wakeup_reason_notify_change();
3783 hotkey_wakeup_hotunplug_complete_notify_change();
3784 hotkey_poll_setup_safe(false);
3785}
3786
3787/* procfs -------------------------------------------------------------- */
3788static int hotkey_read(struct seq_file *m)
3789{
3790 int res, status;
3791
3792 if (!tp_features.hotkey) {
3793 seq_printf(m, "status:\t\tnot supported\n");
3794 return 0;
3795 }
3796
3797 if (mutex_lock_killable(&hotkey_mutex))
3798 return -ERESTARTSYS;
3799 res = hotkey_status_get(&status);
3800 if (!res)
3801 res = hotkey_mask_get();
3802 mutex_unlock(&hotkey_mutex);
3803 if (res)
3804 return res;
3805
3806 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
3807 if (hotkey_all_mask) {
3808 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
3809 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
3810 } else {
3811 seq_printf(m, "mask:\t\tnot supported\n");
3812 seq_printf(m, "commands:\tenable, disable, reset\n");
3813 }
3814
3815 return 0;
3816}
3817
3818static void hotkey_enabledisable_warn(bool enable)
3819{
3820 tpacpi_log_usertask("procfs hotkey enable/disable");
3821 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3822 pr_fmt("hotkey enable/disable functionality has been "
3823 "removed from the driver. "
3824 "Hotkeys are always enabled.\n")))
3825 pr_err("Please remove the hotkey=enable module "
3826 "parameter, it is deprecated. "
3827 "Hotkeys are always enabled.\n");
3828}
3829
3830static int hotkey_write(char *buf)
3831{
3832 int res;
3833 u32 mask;
3834 char *cmd;
3835
3836 if (!tp_features.hotkey)
3837 return -ENODEV;
3838
3839 if (mutex_lock_killable(&hotkey_mutex))
3840 return -ERESTARTSYS;
3841
3842 mask = hotkey_user_mask;
3843
3844 res = 0;
3845 while ((cmd = next_cmd(&buf))) {
3846 if (strlencmp(cmd, "enable") == 0) {
3847 hotkey_enabledisable_warn(1);
3848 } else if (strlencmp(cmd, "disable") == 0) {
3849 hotkey_enabledisable_warn(0);
3850 res = -EPERM;
3851 } else if (strlencmp(cmd, "reset") == 0) {
3852 mask = (hotkey_all_mask | hotkey_source_mask)
3853 & ~hotkey_reserved_mask;
3854 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3855 /* mask set */
3856 } else if (sscanf(cmd, "%x", &mask) == 1) {
3857 /* mask set */
3858 } else {
3859 res = -EINVAL;
3860 goto errexit;
3861 }
3862 }
3863
3864 if (!res) {
3865 tpacpi_disclose_usertask("procfs hotkey",
3866 "set mask to 0x%08x\n", mask);
3867 res = hotkey_user_mask_set(mask);
3868 }
3869
3870errexit:
3871 mutex_unlock(&hotkey_mutex);
3872 return res;
3873}
3874
3875static const struct acpi_device_id ibm_htk_device_ids[] = {
3876 {TPACPI_ACPI_IBM_HKEY_HID, 0},
3877 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
3878 {"", 0},
3879};
3880
3881static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3882 .hid = ibm_htk_device_ids,
3883 .notify = hotkey_notify,
3884 .handle = &hkey_handle,
3885 .type = ACPI_DEVICE_NOTIFY,
3886};
3887
3888static struct ibm_struct hotkey_driver_data = {
3889 .name = "hotkey",
3890 .read = hotkey_read,
3891 .write = hotkey_write,
3892 .exit = hotkey_exit,
3893 .resume = hotkey_resume,
3894 .suspend = hotkey_suspend,
3895 .acpi = &ibm_hotkey_acpidriver,
3896};
3897
3898/*************************************************************************
3899 * Bluetooth subdriver
3900 */
3901
3902enum {
3903 /* ACPI GBDC/SBDC bits */
3904 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3905 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3906 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3907 0 = disable, 1 = enable */
3908};
3909
3910enum {
3911 /* ACPI \BLTH commands */
3912 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3913 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3914 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3915 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3916 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3917};
3918
3919#define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3920
3921static int bluetooth_get_status(void)
3922{
3923 int status;
3924
3925#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3926 if (dbg_bluetoothemul)
3927 return (tpacpi_bluetooth_emulstate) ?
3928 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3929#endif
3930
3931 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3932 return -EIO;
3933
3934 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3935 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3936}
3937
3938static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3939{
3940 int status;
3941
3942 vdbg_printk(TPACPI_DBG_RFKILL,
3943 "will attempt to %s bluetooth\n",
3944 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3945
3946#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3947 if (dbg_bluetoothemul) {
3948 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3949 return 0;
3950 }
3951#endif
3952
3953 if (state == TPACPI_RFK_RADIO_ON)
3954 status = TP_ACPI_BLUETOOTH_RADIOSSW
3955 | TP_ACPI_BLUETOOTH_RESUMECTRL;
3956 else
3957 status = 0;
3958
3959 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3960 return -EIO;
3961
3962 return 0;
3963}
3964
3965/* sysfs bluetooth enable ---------------------------------------------- */
3966static ssize_t bluetooth_enable_show(struct device *dev,
3967 struct device_attribute *attr,
3968 char *buf)
3969{
3970 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3971 attr, buf);
3972}
3973
3974static ssize_t bluetooth_enable_store(struct device *dev,
3975 struct device_attribute *attr,
3976 const char *buf, size_t count)
3977{
3978 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3979 attr, buf, count);
3980}
3981
3982static struct device_attribute dev_attr_bluetooth_enable =
3983 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3984 bluetooth_enable_show, bluetooth_enable_store);
3985
3986/* --------------------------------------------------------------------- */
3987
3988static struct attribute *bluetooth_attributes[] = {
3989 &dev_attr_bluetooth_enable.attr,
3990 NULL
3991};
3992
3993static const struct attribute_group bluetooth_attr_group = {
3994 .attrs = bluetooth_attributes,
3995};
3996
3997static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3998 .get_status = bluetooth_get_status,
3999 .set_status = bluetooth_set_status,
4000};
4001
4002static void bluetooth_shutdown(void)
4003{
4004 /* Order firmware to save current state to NVRAM */
4005 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4006 TP_ACPI_BLTH_SAVE_STATE))
4007 pr_notice("failed to save bluetooth state to NVRAM\n");
4008 else
4009 vdbg_printk(TPACPI_DBG_RFKILL,
4010 "bluestooth state saved to NVRAM\n");
4011}
4012
4013static void bluetooth_exit(void)
4014{
4015 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4016 &bluetooth_attr_group);
4017
4018 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4019
4020 bluetooth_shutdown();
4021}
4022
4023static int __init bluetooth_init(struct ibm_init_struct *iibm)
4024{
4025 int res;
4026 int status = 0;
4027
4028 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4029 "initializing bluetooth subdriver\n");
4030
4031 TPACPI_ACPIHANDLE_INIT(hkey);
4032
4033 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4034 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4035 tp_features.bluetooth = hkey_handle &&
4036 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4037
4038 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4039 "bluetooth is %s, status 0x%02x\n",
4040 str_supported(tp_features.bluetooth),
4041 status);
4042
4043#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4044 if (dbg_bluetoothemul) {
4045 tp_features.bluetooth = 1;
4046 pr_info("bluetooth switch emulation enabled\n");
4047 } else
4048#endif
4049 if (tp_features.bluetooth &&
4050 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4051 /* no bluetooth hardware present in system */
4052 tp_features.bluetooth = 0;
4053 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4054 "bluetooth hardware not installed\n");
4055 }
4056
4057 if (!tp_features.bluetooth)
4058 return 1;
4059
4060 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4061 &bluetooth_tprfk_ops,
4062 RFKILL_TYPE_BLUETOOTH,
4063 TPACPI_RFK_BLUETOOTH_SW_NAME,
4064 true);
4065 if (res)
4066 return res;
4067
4068 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4069 &bluetooth_attr_group);
4070 if (res) {
4071 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4072 return res;
4073 }
4074
4075 return 0;
4076}
4077
4078/* procfs -------------------------------------------------------------- */
4079static int bluetooth_read(struct seq_file *m)
4080{
4081 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4082}
4083
4084static int bluetooth_write(char *buf)
4085{
4086 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4087}
4088
4089static struct ibm_struct bluetooth_driver_data = {
4090 .name = "bluetooth",
4091 .read = bluetooth_read,
4092 .write = bluetooth_write,
4093 .exit = bluetooth_exit,
4094 .shutdown = bluetooth_shutdown,
4095};
4096
4097/*************************************************************************
4098 * Wan subdriver
4099 */
4100
4101enum {
4102 /* ACPI GWAN/SWAN bits */
4103 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4104 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4105 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4106 0 = disable, 1 = enable */
4107};
4108
4109#define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4110
4111static int wan_get_status(void)
4112{
4113 int status;
4114
4115#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4116 if (dbg_wwanemul)
4117 return (tpacpi_wwan_emulstate) ?
4118 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4119#endif
4120
4121 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4122 return -EIO;
4123
4124 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4125 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4126}
4127
4128static int wan_set_status(enum tpacpi_rfkill_state state)
4129{
4130 int status;
4131
4132 vdbg_printk(TPACPI_DBG_RFKILL,
4133 "will attempt to %s wwan\n",
4134 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4135
4136#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4137 if (dbg_wwanemul) {
4138 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4139 return 0;
4140 }
4141#endif
4142
4143 if (state == TPACPI_RFK_RADIO_ON)
4144 status = TP_ACPI_WANCARD_RADIOSSW
4145 | TP_ACPI_WANCARD_RESUMECTRL;
4146 else
4147 status = 0;
4148
4149 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4150 return -EIO;
4151
4152 return 0;
4153}
4154
4155/* sysfs wan enable ---------------------------------------------------- */
4156static ssize_t wan_enable_show(struct device *dev,
4157 struct device_attribute *attr,
4158 char *buf)
4159{
4160 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4161 attr, buf);
4162}
4163
4164static ssize_t wan_enable_store(struct device *dev,
4165 struct device_attribute *attr,
4166 const char *buf, size_t count)
4167{
4168 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4169 attr, buf, count);
4170}
4171
4172static struct device_attribute dev_attr_wan_enable =
4173 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4174 wan_enable_show, wan_enable_store);
4175
4176/* --------------------------------------------------------------------- */
4177
4178static struct attribute *wan_attributes[] = {
4179 &dev_attr_wan_enable.attr,
4180 NULL
4181};
4182
4183static const struct attribute_group wan_attr_group = {
4184 .attrs = wan_attributes,
4185};
4186
4187static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4188 .get_status = wan_get_status,
4189 .set_status = wan_set_status,
4190};
4191
4192static void wan_shutdown(void)
4193{
4194 /* Order firmware to save current state to NVRAM */
4195 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4196 TP_ACPI_WGSV_SAVE_STATE))
4197 pr_notice("failed to save WWAN state to NVRAM\n");
4198 else
4199 vdbg_printk(TPACPI_DBG_RFKILL,
4200 "WWAN state saved to NVRAM\n");
4201}
4202
4203static void wan_exit(void)
4204{
4205 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4206 &wan_attr_group);
4207
4208 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4209
4210 wan_shutdown();
4211}
4212
4213static int __init wan_init(struct ibm_init_struct *iibm)
4214{
4215 int res;
4216 int status = 0;
4217
4218 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4219 "initializing wan subdriver\n");
4220
4221 TPACPI_ACPIHANDLE_INIT(hkey);
4222
4223 tp_features.wan = hkey_handle &&
4224 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4225
4226 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4227 "wan is %s, status 0x%02x\n",
4228 str_supported(tp_features.wan),
4229 status);
4230
4231#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4232 if (dbg_wwanemul) {
4233 tp_features.wan = 1;
4234 pr_info("wwan switch emulation enabled\n");
4235 } else
4236#endif
4237 if (tp_features.wan &&
4238 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4239 /* no wan hardware present in system */
4240 tp_features.wan = 0;
4241 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4242 "wan hardware not installed\n");
4243 }
4244
4245 if (!tp_features.wan)
4246 return 1;
4247
4248 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4249 &wan_tprfk_ops,
4250 RFKILL_TYPE_WWAN,
4251 TPACPI_RFK_WWAN_SW_NAME,
4252 true);
4253 if (res)
4254 return res;
4255
4256 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4257 &wan_attr_group);
4258
4259 if (res) {
4260 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4261 return res;
4262 }
4263
4264 return 0;
4265}
4266
4267/* procfs -------------------------------------------------------------- */
4268static int wan_read(struct seq_file *m)
4269{
4270 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4271}
4272
4273static int wan_write(char *buf)
4274{
4275 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4276}
4277
4278static struct ibm_struct wan_driver_data = {
4279 .name = "wan",
4280 .read = wan_read,
4281 .write = wan_write,
4282 .exit = wan_exit,
4283 .shutdown = wan_shutdown,
4284};
4285
4286/*************************************************************************
4287 * UWB subdriver
4288 */
4289
4290enum {
4291 /* ACPI GUWB/SUWB bits */
4292 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4293 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4294};
4295
4296#define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4297
4298static int uwb_get_status(void)
4299{
4300 int status;
4301
4302#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4303 if (dbg_uwbemul)
4304 return (tpacpi_uwb_emulstate) ?
4305 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4306#endif
4307
4308 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4309 return -EIO;
4310
4311 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4312 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4313}
4314
4315static int uwb_set_status(enum tpacpi_rfkill_state state)
4316{
4317 int status;
4318
4319 vdbg_printk(TPACPI_DBG_RFKILL,
4320 "will attempt to %s UWB\n",
4321 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4322
4323#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4324 if (dbg_uwbemul) {
4325 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4326 return 0;
4327 }
4328#endif
4329
4330 if (state == TPACPI_RFK_RADIO_ON)
4331 status = TP_ACPI_UWB_RADIOSSW;
4332 else
4333 status = 0;
4334
4335 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4336 return -EIO;
4337
4338 return 0;
4339}
4340
4341/* --------------------------------------------------------------------- */
4342
4343static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4344 .get_status = uwb_get_status,
4345 .set_status = uwb_set_status,
4346};
4347
4348static void uwb_exit(void)
4349{
4350 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4351}
4352
4353static int __init uwb_init(struct ibm_init_struct *iibm)
4354{
4355 int res;
4356 int status = 0;
4357
4358 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4359 "initializing uwb subdriver\n");
4360
4361 TPACPI_ACPIHANDLE_INIT(hkey);
4362
4363 tp_features.uwb = hkey_handle &&
4364 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4365
4366 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4367 "uwb is %s, status 0x%02x\n",
4368 str_supported(tp_features.uwb),
4369 status);
4370
4371#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4372 if (dbg_uwbemul) {
4373 tp_features.uwb = 1;
4374 pr_info("uwb switch emulation enabled\n");
4375 } else
4376#endif
4377 if (tp_features.uwb &&
4378 !(status & TP_ACPI_UWB_HWPRESENT)) {
4379 /* no uwb hardware present in system */
4380 tp_features.uwb = 0;
4381 dbg_printk(TPACPI_DBG_INIT,
4382 "uwb hardware not installed\n");
4383 }
4384
4385 if (!tp_features.uwb)
4386 return 1;
4387
4388 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4389 &uwb_tprfk_ops,
4390 RFKILL_TYPE_UWB,
4391 TPACPI_RFK_UWB_SW_NAME,
4392 false);
4393 return res;
4394}
4395
4396static struct ibm_struct uwb_driver_data = {
4397 .name = "uwb",
4398 .exit = uwb_exit,
4399 .flags.experimental = 1,
4400};
4401
4402/*************************************************************************
4403 * Video subdriver
4404 */
4405
4406#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4407
4408enum video_access_mode {
4409 TPACPI_VIDEO_NONE = 0,
4410 TPACPI_VIDEO_570, /* 570 */
4411 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4412 TPACPI_VIDEO_NEW, /* all others */
4413};
4414
4415enum { /* video status flags, based on VIDEO_570 */
4416 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4417 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4418 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4419};
4420
4421enum { /* TPACPI_VIDEO_570 constants */
4422 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4423 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4424 * video_status_flags */
4425 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4426 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4427};
4428
4429static enum video_access_mode video_supported;
4430static int video_orig_autosw;
4431
4432static int video_autosw_get(void);
4433static int video_autosw_set(int enable);
4434
4435TPACPI_HANDLE(vid, root,
4436 "\\_SB.PCI.AGP.VGA", /* 570 */
4437 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4438 "\\_SB.PCI0.VID0", /* 770e */
4439 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4440 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4441 "\\_SB.PCI0.AGP.VID", /* all others */
4442 ); /* R30, R31 */
4443
4444TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4445
4446static int __init video_init(struct ibm_init_struct *iibm)
4447{
4448 int ivga;
4449
4450 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4451
4452 TPACPI_ACPIHANDLE_INIT(vid);
4453 if (tpacpi_is_ibm())
4454 TPACPI_ACPIHANDLE_INIT(vid2);
4455
4456 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4457 /* G41, assume IVGA doesn't change */
4458 vid_handle = vid2_handle;
4459
4460 if (!vid_handle)
4461 /* video switching not supported on R30, R31 */
4462 video_supported = TPACPI_VIDEO_NONE;
4463 else if (tpacpi_is_ibm() &&
4464 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4465 /* 570 */
4466 video_supported = TPACPI_VIDEO_570;
4467 else if (tpacpi_is_ibm() &&
4468 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4469 /* 600e/x, 770e, 770x */
4470 video_supported = TPACPI_VIDEO_770;
4471 else
4472 /* all others */
4473 video_supported = TPACPI_VIDEO_NEW;
4474
4475 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4476 str_supported(video_supported != TPACPI_VIDEO_NONE),
4477 video_supported);
4478
4479 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4480}
4481
4482static void video_exit(void)
4483{
4484 dbg_printk(TPACPI_DBG_EXIT,
4485 "restoring original video autoswitch mode\n");
4486 if (video_autosw_set(video_orig_autosw))
4487 pr_err("error while trying to restore original "
4488 "video autoswitch mode\n");
4489}
4490
4491static int video_outputsw_get(void)
4492{
4493 int status = 0;
4494 int i;
4495
4496 switch (video_supported) {
4497 case TPACPI_VIDEO_570:
4498 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4499 TP_ACPI_VIDEO_570_PHSCMD))
4500 return -EIO;
4501 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4502 break;
4503 case TPACPI_VIDEO_770:
4504 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4505 return -EIO;
4506 if (i)
4507 status |= TP_ACPI_VIDEO_S_LCD;
4508 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4509 return -EIO;
4510 if (i)
4511 status |= TP_ACPI_VIDEO_S_CRT;
4512 break;
4513 case TPACPI_VIDEO_NEW:
4514 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4515 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4516 return -EIO;
4517 if (i)
4518 status |= TP_ACPI_VIDEO_S_CRT;
4519
4520 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4521 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4522 return -EIO;
4523 if (i)
4524 status |= TP_ACPI_VIDEO_S_LCD;
4525 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4526 return -EIO;
4527 if (i)
4528 status |= TP_ACPI_VIDEO_S_DVI;
4529 break;
4530 default:
4531 return -ENOSYS;
4532 }
4533
4534 return status;
4535}
4536
4537static int video_outputsw_set(int status)
4538{
4539 int autosw;
4540 int res = 0;
4541
4542 switch (video_supported) {
4543 case TPACPI_VIDEO_570:
4544 res = acpi_evalf(NULL, NULL,
4545 "\\_SB.PHS2", "vdd",
4546 TP_ACPI_VIDEO_570_PHS2CMD,
4547 status | TP_ACPI_VIDEO_570_PHS2SET);
4548 break;
4549 case TPACPI_VIDEO_770:
4550 autosw = video_autosw_get();
4551 if (autosw < 0)
4552 return autosw;
4553
4554 res = video_autosw_set(1);
4555 if (res)
4556 return res;
4557 res = acpi_evalf(vid_handle, NULL,
4558 "ASWT", "vdd", status * 0x100, 0);
4559 if (!autosw && video_autosw_set(autosw)) {
4560 pr_err("video auto-switch left enabled due to error\n");
4561 return -EIO;
4562 }
4563 break;
4564 case TPACPI_VIDEO_NEW:
4565 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4566 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4567 break;
4568 default:
4569 return -ENOSYS;
4570 }
4571
4572 return (res)? 0 : -EIO;
4573}
4574
4575static int video_autosw_get(void)
4576{
4577 int autosw = 0;
4578
4579 switch (video_supported) {
4580 case TPACPI_VIDEO_570:
4581 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4582 return -EIO;
4583 break;
4584 case TPACPI_VIDEO_770:
4585 case TPACPI_VIDEO_NEW:
4586 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4587 return -EIO;
4588 break;
4589 default:
4590 return -ENOSYS;
4591 }
4592
4593 return autosw & 1;
4594}
4595
4596static int video_autosw_set(int enable)
4597{
4598 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4599 return -EIO;
4600 return 0;
4601}
4602
4603static int video_outputsw_cycle(void)
4604{
4605 int autosw = video_autosw_get();
4606 int res;
4607
4608 if (autosw < 0)
4609 return autosw;
4610
4611 switch (video_supported) {
4612 case TPACPI_VIDEO_570:
4613 res = video_autosw_set(1);
4614 if (res)
4615 return res;
4616 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4617 break;
4618 case TPACPI_VIDEO_770:
4619 case TPACPI_VIDEO_NEW:
4620 res = video_autosw_set(1);
4621 if (res)
4622 return res;
4623 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4624 break;
4625 default:
4626 return -ENOSYS;
4627 }
4628 if (!autosw && video_autosw_set(autosw)) {
4629 pr_err("video auto-switch left enabled due to error\n");
4630 return -EIO;
4631 }
4632
4633 return (res)? 0 : -EIO;
4634}
4635
4636static int video_expand_toggle(void)
4637{
4638 switch (video_supported) {
4639 case TPACPI_VIDEO_570:
4640 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4641 0 : -EIO;
4642 case TPACPI_VIDEO_770:
4643 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4644 0 : -EIO;
4645 case TPACPI_VIDEO_NEW:
4646 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4647 0 : -EIO;
4648 default:
4649 return -ENOSYS;
4650 }
4651 /* not reached */
4652}
4653
4654static int video_read(struct seq_file *m)
4655{
4656 int status, autosw;
4657
4658 if (video_supported == TPACPI_VIDEO_NONE) {
4659 seq_printf(m, "status:\t\tnot supported\n");
4660 return 0;
4661 }
4662
4663 /* Even reads can crash X.org, so... */
4664 if (!capable(CAP_SYS_ADMIN))
4665 return -EPERM;
4666
4667 status = video_outputsw_get();
4668 if (status < 0)
4669 return status;
4670
4671 autosw = video_autosw_get();
4672 if (autosw < 0)
4673 return autosw;
4674
4675 seq_printf(m, "status:\t\tsupported\n");
4676 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4677 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4678 if (video_supported == TPACPI_VIDEO_NEW)
4679 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4680 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4681 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4682 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4683 if (video_supported == TPACPI_VIDEO_NEW)
4684 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4685 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4686 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4687
4688 return 0;
4689}
4690
4691static int video_write(char *buf)
4692{
4693 char *cmd;
4694 int enable, disable, status;
4695 int res;
4696
4697 if (video_supported == TPACPI_VIDEO_NONE)
4698 return -ENODEV;
4699
4700 /* Even reads can crash X.org, let alone writes... */
4701 if (!capable(CAP_SYS_ADMIN))
4702 return -EPERM;
4703
4704 enable = 0;
4705 disable = 0;
4706
4707 while ((cmd = next_cmd(&buf))) {
4708 if (strlencmp(cmd, "lcd_enable") == 0) {
4709 enable |= TP_ACPI_VIDEO_S_LCD;
4710 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4711 disable |= TP_ACPI_VIDEO_S_LCD;
4712 } else if (strlencmp(cmd, "crt_enable") == 0) {
4713 enable |= TP_ACPI_VIDEO_S_CRT;
4714 } else if (strlencmp(cmd, "crt_disable") == 0) {
4715 disable |= TP_ACPI_VIDEO_S_CRT;
4716 } else if (video_supported == TPACPI_VIDEO_NEW &&
4717 strlencmp(cmd, "dvi_enable") == 0) {
4718 enable |= TP_ACPI_VIDEO_S_DVI;
4719 } else if (video_supported == TPACPI_VIDEO_NEW &&
4720 strlencmp(cmd, "dvi_disable") == 0) {
4721 disable |= TP_ACPI_VIDEO_S_DVI;
4722 } else if (strlencmp(cmd, "auto_enable") == 0) {
4723 res = video_autosw_set(1);
4724 if (res)
4725 return res;
4726 } else if (strlencmp(cmd, "auto_disable") == 0) {
4727 res = video_autosw_set(0);
4728 if (res)
4729 return res;
4730 } else if (strlencmp(cmd, "video_switch") == 0) {
4731 res = video_outputsw_cycle();
4732 if (res)
4733 return res;
4734 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4735 res = video_expand_toggle();
4736 if (res)
4737 return res;
4738 } else
4739 return -EINVAL;
4740 }
4741
4742 if (enable || disable) {
4743 status = video_outputsw_get();
4744 if (status < 0)
4745 return status;
4746 res = video_outputsw_set((status & ~disable) | enable);
4747 if (res)
4748 return res;
4749 }
4750
4751 return 0;
4752}
4753
4754static struct ibm_struct video_driver_data = {
4755 .name = "video",
4756 .read = video_read,
4757 .write = video_write,
4758 .exit = video_exit,
4759};
4760
4761#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4762
4763/*************************************************************************
4764 * Light (thinklight) subdriver
4765 */
4766
4767TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4768TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4769
4770static int light_get_status(void)
4771{
4772 int status = 0;
4773
4774 if (tp_features.light_status) {
4775 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4776 return -EIO;
4777 return (!!status);
4778 }
4779
4780 return -ENXIO;
4781}
4782
4783static int light_set_status(int status)
4784{
4785 int rc;
4786
4787 if (tp_features.light) {
4788 if (cmos_handle) {
4789 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4790 (status)?
4791 TP_CMOS_THINKLIGHT_ON :
4792 TP_CMOS_THINKLIGHT_OFF);
4793 } else {
4794 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4795 (status)? 1 : 0);
4796 }
4797 return (rc)? 0 : -EIO;
4798 }
4799
4800 return -ENXIO;
4801}
4802
4803static void light_set_status_worker(struct work_struct *work)
4804{
4805 struct tpacpi_led_classdev *data =
4806 container_of(work, struct tpacpi_led_classdev, work);
4807
4808 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4809 light_set_status((data->new_state != TPACPI_LED_OFF));
4810}
4811
4812static void light_sysfs_set(struct led_classdev *led_cdev,
4813 enum led_brightness brightness)
4814{
4815 struct tpacpi_led_classdev *data =
4816 container_of(led_cdev,
4817 struct tpacpi_led_classdev,
4818 led_classdev);
4819 data->new_state = (brightness != LED_OFF) ?
4820 TPACPI_LED_ON : TPACPI_LED_OFF;
4821 queue_work(tpacpi_wq, &data->work);
4822}
4823
4824static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4825{
4826 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4827}
4828
4829static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4830 .led_classdev = {
4831 .name = "tpacpi::thinklight",
4832 .brightness_set = &light_sysfs_set,
4833 .brightness_get = &light_sysfs_get,
4834 }
4835};
4836
4837static int __init light_init(struct ibm_init_struct *iibm)
4838{
4839 int rc;
4840
4841 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4842
4843 if (tpacpi_is_ibm()) {
4844 TPACPI_ACPIHANDLE_INIT(ledb);
4845 TPACPI_ACPIHANDLE_INIT(lght);
4846 }
4847 TPACPI_ACPIHANDLE_INIT(cmos);
4848 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4849
4850 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4851 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4852
4853 if (tp_features.light)
4854 /* light status not supported on
4855 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4856 tp_features.light_status =
4857 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4858
4859 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4860 str_supported(tp_features.light),
4861 str_supported(tp_features.light_status));
4862
4863 if (!tp_features.light)
4864 return 1;
4865
4866 rc = led_classdev_register(&tpacpi_pdev->dev,
4867 &tpacpi_led_thinklight.led_classdev);
4868
4869 if (rc < 0) {
4870 tp_features.light = 0;
4871 tp_features.light_status = 0;
4872 } else {
4873 rc = 0;
4874 }
4875
4876 return rc;
4877}
4878
4879static void light_exit(void)
4880{
4881 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4882 if (work_pending(&tpacpi_led_thinklight.work))
4883 flush_workqueue(tpacpi_wq);
4884}
4885
4886static int light_read(struct seq_file *m)
4887{
4888 int status;
4889
4890 if (!tp_features.light) {
4891 seq_printf(m, "status:\t\tnot supported\n");
4892 } else if (!tp_features.light_status) {
4893 seq_printf(m, "status:\t\tunknown\n");
4894 seq_printf(m, "commands:\ton, off\n");
4895 } else {
4896 status = light_get_status();
4897 if (status < 0)
4898 return status;
4899 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
4900 seq_printf(m, "commands:\ton, off\n");
4901 }
4902
4903 return 0;
4904}
4905
4906static int light_write(char *buf)
4907{
4908 char *cmd;
4909 int newstatus = 0;
4910
4911 if (!tp_features.light)
4912 return -ENODEV;
4913
4914 while ((cmd = next_cmd(&buf))) {
4915 if (strlencmp(cmd, "on") == 0) {
4916 newstatus = 1;
4917 } else if (strlencmp(cmd, "off") == 0) {
4918 newstatus = 0;
4919 } else
4920 return -EINVAL;
4921 }
4922
4923 return light_set_status(newstatus);
4924}
4925
4926static struct ibm_struct light_driver_data = {
4927 .name = "light",
4928 .read = light_read,
4929 .write = light_write,
4930 .exit = light_exit,
4931};
4932
4933/*************************************************************************
4934 * CMOS subdriver
4935 */
4936
4937/* sysfs cmos_command -------------------------------------------------- */
4938static ssize_t cmos_command_store(struct device *dev,
4939 struct device_attribute *attr,
4940 const char *buf, size_t count)
4941{
4942 unsigned long cmos_cmd;
4943 int res;
4944
4945 if (parse_strtoul(buf, 21, &cmos_cmd))
4946 return -EINVAL;
4947
4948 res = issue_thinkpad_cmos_command(cmos_cmd);
4949 return (res)? res : count;
4950}
4951
4952static struct device_attribute dev_attr_cmos_command =
4953 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4954
4955/* --------------------------------------------------------------------- */
4956
4957static int __init cmos_init(struct ibm_init_struct *iibm)
4958{
4959 int res;
4960
4961 vdbg_printk(TPACPI_DBG_INIT,
4962 "initializing cmos commands subdriver\n");
4963
4964 TPACPI_ACPIHANDLE_INIT(cmos);
4965
4966 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4967 str_supported(cmos_handle != NULL));
4968
4969 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4970 if (res)
4971 return res;
4972
4973 return (cmos_handle)? 0 : 1;
4974}
4975
4976static void cmos_exit(void)
4977{
4978 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4979}
4980
4981static int cmos_read(struct seq_file *m)
4982{
4983 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4984 R30, R31, T20-22, X20-21 */
4985 if (!cmos_handle)
4986 seq_printf(m, "status:\t\tnot supported\n");
4987 else {
4988 seq_printf(m, "status:\t\tsupported\n");
4989 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
4990 }
4991
4992 return 0;
4993}
4994
4995static int cmos_write(char *buf)
4996{
4997 char *cmd;
4998 int cmos_cmd, res;
4999
5000 while ((cmd = next_cmd(&buf))) {
5001 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5002 cmos_cmd >= 0 && cmos_cmd <= 21) {
5003 /* cmos_cmd set */
5004 } else
5005 return -EINVAL;
5006
5007 res = issue_thinkpad_cmos_command(cmos_cmd);
5008 if (res)
5009 return res;
5010 }
5011
5012 return 0;
5013}
5014
5015static struct ibm_struct cmos_driver_data = {
5016 .name = "cmos",
5017 .read = cmos_read,
5018 .write = cmos_write,
5019 .exit = cmos_exit,
5020};
5021
5022/*************************************************************************
5023 * LED subdriver
5024 */
5025
5026enum led_access_mode {
5027 TPACPI_LED_NONE = 0,
5028 TPACPI_LED_570, /* 570 */
5029 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5030 TPACPI_LED_NEW, /* all others */
5031};
5032
5033enum { /* For TPACPI_LED_OLD */
5034 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5035 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5036 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5037};
5038
5039static enum led_access_mode led_supported;
5040
5041static acpi_handle led_handle;
5042
5043#define TPACPI_LED_NUMLEDS 16
5044static struct tpacpi_led_classdev *tpacpi_leds;
5045static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5046static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5047 /* there's a limit of 19 chars + NULL before 2.6.26 */
5048 "tpacpi::power",
5049 "tpacpi:orange:batt",
5050 "tpacpi:green:batt",
5051 "tpacpi::dock_active",
5052 "tpacpi::bay_active",
5053 "tpacpi::dock_batt",
5054 "tpacpi::unknown_led",
5055 "tpacpi::standby",
5056 "tpacpi::dock_status1",
5057 "tpacpi::dock_status2",
5058 "tpacpi::unknown_led2",
5059 "tpacpi::unknown_led3",
5060 "tpacpi::thinkvantage",
5061};
5062#define TPACPI_SAFE_LEDS 0x1081U
5063
5064static inline bool tpacpi_is_led_restricted(const unsigned int led)
5065{
5066#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5067 return false;
5068#else
5069 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5070#endif
5071}
5072
5073static int led_get_status(const unsigned int led)
5074{
5075 int status;
5076 enum led_status_t led_s;
5077
5078 switch (led_supported) {
5079 case TPACPI_LED_570:
5080 if (!acpi_evalf(ec_handle,
5081 &status, "GLED", "dd", 1 << led))
5082 return -EIO;
5083 led_s = (status == 0)?
5084 TPACPI_LED_OFF :
5085 ((status == 1)?
5086 TPACPI_LED_ON :
5087 TPACPI_LED_BLINK);
5088 tpacpi_led_state_cache[led] = led_s;
5089 return led_s;
5090 default:
5091 return -ENXIO;
5092 }
5093
5094 /* not reached */
5095}
5096
5097static int led_set_status(const unsigned int led,
5098 const enum led_status_t ledstatus)
5099{
5100 /* off, on, blink. Index is led_status_t */
5101 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5102 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5103
5104 int rc = 0;
5105
5106 switch (led_supported) {
5107 case TPACPI_LED_570:
5108 /* 570 */
5109 if (unlikely(led > 7))
5110 return -EINVAL;
5111 if (unlikely(tpacpi_is_led_restricted(led)))
5112 return -EPERM;
5113 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5114 (1 << led), led_sled_arg1[ledstatus]))
5115 rc = -EIO;
5116 break;
5117 case TPACPI_LED_OLD:
5118 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5119 if (unlikely(led > 7))
5120 return -EINVAL;
5121 if (unlikely(tpacpi_is_led_restricted(led)))
5122 return -EPERM;
5123 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5124 if (rc >= 0)
5125 rc = ec_write(TPACPI_LED_EC_HLBL,
5126 (ledstatus == TPACPI_LED_BLINK) << led);
5127 if (rc >= 0)
5128 rc = ec_write(TPACPI_LED_EC_HLCL,
5129 (ledstatus != TPACPI_LED_OFF) << led);
5130 break;
5131 case TPACPI_LED_NEW:
5132 /* all others */
5133 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5134 return -EINVAL;
5135 if (unlikely(tpacpi_is_led_restricted(led)))
5136 return -EPERM;
5137 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5138 led, led_led_arg1[ledstatus]))
5139 rc = -EIO;
5140 break;
5141 default:
5142 rc = -ENXIO;
5143 }
5144
5145 if (!rc)
5146 tpacpi_led_state_cache[led] = ledstatus;
5147
5148 return rc;
5149}
5150
5151static void led_set_status_worker(struct work_struct *work)
5152{
5153 struct tpacpi_led_classdev *data =
5154 container_of(work, struct tpacpi_led_classdev, work);
5155
5156 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5157 led_set_status(data->led, data->new_state);
5158}
5159
5160static void led_sysfs_set(struct led_classdev *led_cdev,
5161 enum led_brightness brightness)
5162{
5163 struct tpacpi_led_classdev *data = container_of(led_cdev,
5164 struct tpacpi_led_classdev, led_classdev);
5165
5166 if (brightness == LED_OFF)
5167 data->new_state = TPACPI_LED_OFF;
5168 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5169 data->new_state = TPACPI_LED_ON;
5170 else
5171 data->new_state = TPACPI_LED_BLINK;
5172
5173 queue_work(tpacpi_wq, &data->work);
5174}
5175
5176static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5177 unsigned long *delay_on, unsigned long *delay_off)
5178{
5179 struct tpacpi_led_classdev *data = container_of(led_cdev,
5180 struct tpacpi_led_classdev, led_classdev);
5181
5182 /* Can we choose the flash rate? */
5183 if (*delay_on == 0 && *delay_off == 0) {
5184 /* yes. set them to the hardware blink rate (1 Hz) */
5185 *delay_on = 500; /* ms */
5186 *delay_off = 500; /* ms */
5187 } else if ((*delay_on != 500) || (*delay_off != 500))
5188 return -EINVAL;
5189
5190 data->new_state = TPACPI_LED_BLINK;
5191 queue_work(tpacpi_wq, &data->work);
5192
5193 return 0;
5194}
5195
5196static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5197{
5198 int rc;
5199
5200 struct tpacpi_led_classdev *data = container_of(led_cdev,
5201 struct tpacpi_led_classdev, led_classdev);
5202
5203 rc = led_get_status(data->led);
5204
5205 if (rc == TPACPI_LED_OFF || rc < 0)
5206 rc = LED_OFF; /* no error handling in led class :( */
5207 else
5208 rc = LED_FULL;
5209
5210 return rc;
5211}
5212
5213static void led_exit(void)
5214{
5215 unsigned int i;
5216
5217 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5218 if (tpacpi_leds[i].led_classdev.name)
5219 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5220 }
5221
5222 kfree(tpacpi_leds);
5223}
5224
5225static int __init tpacpi_init_led(unsigned int led)
5226{
5227 int rc;
5228
5229 tpacpi_leds[led].led = led;
5230
5231 /* LEDs with no name don't get registered */
5232 if (!tpacpi_led_names[led])
5233 return 0;
5234
5235 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5236 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5237 if (led_supported == TPACPI_LED_570)
5238 tpacpi_leds[led].led_classdev.brightness_get =
5239 &led_sysfs_get;
5240
5241 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5242
5243 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5244
5245 rc = led_classdev_register(&tpacpi_pdev->dev,
5246 &tpacpi_leds[led].led_classdev);
5247 if (rc < 0)
5248 tpacpi_leds[led].led_classdev.name = NULL;
5249
5250 return rc;
5251}
5252
5253static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5254 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5255 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5256 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5257
5258 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5259 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5260 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5261 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5262 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5263 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5264 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5265 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5266
5267 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5268 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5269 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5270 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5271 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5272
5273 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5274 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5275 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5276 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5277
5278 /* (1) - may have excess leds enabled on MSB */
5279
5280 /* Defaults (order matters, keep last, don't reorder!) */
5281 { /* Lenovo */
5282 .vendor = PCI_VENDOR_ID_LENOVO,
5283 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5284 .quirks = 0x1fffU,
5285 },
5286 { /* IBM ThinkPads with no EC version string */
5287 .vendor = PCI_VENDOR_ID_IBM,
5288 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5289 .quirks = 0x00ffU,
5290 },
5291 { /* IBM ThinkPads with EC version string */
5292 .vendor = PCI_VENDOR_ID_IBM,
5293 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5294 .quirks = 0x00bfU,
5295 },
5296};
5297
5298#undef TPACPI_LEDQ_IBM
5299#undef TPACPI_LEDQ_LNV
5300
5301static enum led_access_mode __init led_init_detect_mode(void)
5302{
5303 acpi_status status;
5304
5305 if (tpacpi_is_ibm()) {
5306 /* 570 */
5307 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5308 if (ACPI_SUCCESS(status))
5309 return TPACPI_LED_570;
5310
5311 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5312 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5313 if (ACPI_SUCCESS(status))
5314 return TPACPI_LED_OLD;
5315 }
5316
5317 /* most others */
5318 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5319 if (ACPI_SUCCESS(status))
5320 return TPACPI_LED_NEW;
5321
5322 /* R30, R31, and unknown firmwares */
5323 led_handle = NULL;
5324 return TPACPI_LED_NONE;
5325}
5326
5327static int __init led_init(struct ibm_init_struct *iibm)
5328{
5329 unsigned int i;
5330 int rc;
5331 unsigned long useful_leds;
5332
5333 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5334
5335 led_supported = led_init_detect_mode();
5336
5337 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5338 str_supported(led_supported), led_supported);
5339
5340 if (led_supported == TPACPI_LED_NONE)
5341 return 1;
5342
5343 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5344 GFP_KERNEL);
5345 if (!tpacpi_leds) {
5346 pr_err("Out of memory for LED data\n");
5347 return -ENOMEM;
5348 }
5349
5350 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5351 ARRAY_SIZE(led_useful_qtable));
5352
5353 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5354 if (!tpacpi_is_led_restricted(i) &&
5355 test_bit(i, &useful_leds)) {
5356 rc = tpacpi_init_led(i);
5357 if (rc < 0) {
5358 led_exit();
5359 return rc;
5360 }
5361 }
5362 }
5363
5364#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5365 pr_notice("warning: userspace override of important "
5366 "firmware LEDs is enabled\n");
5367#endif
5368 return 0;
5369}
5370
5371#define str_led_status(s) \
5372 ((s) == TPACPI_LED_OFF ? "off" : \
5373 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5374
5375static int led_read(struct seq_file *m)
5376{
5377 if (!led_supported) {
5378 seq_printf(m, "status:\t\tnot supported\n");
5379 return 0;
5380 }
5381 seq_printf(m, "status:\t\tsupported\n");
5382
5383 if (led_supported == TPACPI_LED_570) {
5384 /* 570 */
5385 int i, status;
5386 for (i = 0; i < 8; i++) {
5387 status = led_get_status(i);
5388 if (status < 0)
5389 return -EIO;
5390 seq_printf(m, "%d:\t\t%s\n",
5391 i, str_led_status(status));
5392 }
5393 }
5394
5395 seq_printf(m, "commands:\t"
5396 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5397
5398 return 0;
5399}
5400
5401static int led_write(char *buf)
5402{
5403 char *cmd;
5404 int led, rc;
5405 enum led_status_t s;
5406
5407 if (!led_supported)
5408 return -ENODEV;
5409
5410 while ((cmd = next_cmd(&buf))) {
5411 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5412 return -EINVAL;
5413
5414 if (strstr(cmd, "off")) {
5415 s = TPACPI_LED_OFF;
5416 } else if (strstr(cmd, "on")) {
5417 s = TPACPI_LED_ON;
5418 } else if (strstr(cmd, "blink")) {
5419 s = TPACPI_LED_BLINK;
5420 } else {
5421 return -EINVAL;
5422 }
5423
5424 rc = led_set_status(led, s);
5425 if (rc < 0)
5426 return rc;
5427 }
5428
5429 return 0;
5430}
5431
5432static struct ibm_struct led_driver_data = {
5433 .name = "led",
5434 .read = led_read,
5435 .write = led_write,
5436 .exit = led_exit,
5437};
5438
5439/*************************************************************************
5440 * Beep subdriver
5441 */
5442
5443TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5444
5445#define TPACPI_BEEP_Q1 0x0001
5446
5447static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5448 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5449 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5450};
5451
5452static int __init beep_init(struct ibm_init_struct *iibm)
5453{
5454 unsigned long quirks;
5455
5456 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5457
5458 TPACPI_ACPIHANDLE_INIT(beep);
5459
5460 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5461 str_supported(beep_handle != NULL));
5462
5463 quirks = tpacpi_check_quirks(beep_quirk_table,
5464 ARRAY_SIZE(beep_quirk_table));
5465
5466 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5467
5468 return (beep_handle)? 0 : 1;
5469}
5470
5471static int beep_read(struct seq_file *m)
5472{
5473 if (!beep_handle)
5474 seq_printf(m, "status:\t\tnot supported\n");
5475 else {
5476 seq_printf(m, "status:\t\tsupported\n");
5477 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5478 }
5479
5480 return 0;
5481}
5482
5483static int beep_write(char *buf)
5484{
5485 char *cmd;
5486 int beep_cmd;
5487
5488 if (!beep_handle)
5489 return -ENODEV;
5490
5491 while ((cmd = next_cmd(&buf))) {
5492 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5493 beep_cmd >= 0 && beep_cmd <= 17) {
5494 /* beep_cmd set */
5495 } else
5496 return -EINVAL;
5497 if (tp_features.beep_needs_two_args) {
5498 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5499 beep_cmd, 0))
5500 return -EIO;
5501 } else {
5502 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5503 beep_cmd))
5504 return -EIO;
5505 }
5506 }
5507
5508 return 0;
5509}
5510
5511static struct ibm_struct beep_driver_data = {
5512 .name = "beep",
5513 .read = beep_read,
5514 .write = beep_write,
5515};
5516
5517/*************************************************************************
5518 * Thermal subdriver
5519 */
5520
5521enum thermal_access_mode {
5522 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5523 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5524 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5525 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5526 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5527};
5528
5529enum { /* TPACPI_THERMAL_TPEC_* */
5530 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5531 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5532 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5533
5534 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5535};
5536
5537
5538#define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5539struct ibm_thermal_sensors_struct {
5540 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5541};
5542
5543static enum thermal_access_mode thermal_read_mode;
5544
5545/* idx is zero-based */
5546static int thermal_get_sensor(int idx, s32 *value)
5547{
5548 int t;
5549 s8 tmp;
5550 char tmpi[5];
5551
5552 t = TP_EC_THERMAL_TMP0;
5553
5554 switch (thermal_read_mode) {
5555#if TPACPI_MAX_THERMAL_SENSORS >= 16
5556 case TPACPI_THERMAL_TPEC_16:
5557 if (idx >= 8 && idx <= 15) {
5558 t = TP_EC_THERMAL_TMP8;
5559 idx -= 8;
5560 }
5561 /* fallthrough */
5562#endif
5563 case TPACPI_THERMAL_TPEC_8:
5564 if (idx <= 7) {
5565 if (!acpi_ec_read(t + idx, &tmp))
5566 return -EIO;
5567 *value = tmp * 1000;
5568 return 0;
5569 }
5570 break;
5571
5572 case TPACPI_THERMAL_ACPI_UPDT:
5573 if (idx <= 7) {
5574 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5575 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5576 return -EIO;
5577 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5578 return -EIO;
5579 *value = (t - 2732) * 100;
5580 return 0;
5581 }
5582 break;
5583
5584 case TPACPI_THERMAL_ACPI_TMP07:
5585 if (idx <= 7) {
5586 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5587 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5588 return -EIO;
5589 if (t > 127 || t < -127)
5590 t = TP_EC_THERMAL_TMP_NA;
5591 *value = t * 1000;
5592 return 0;
5593 }
5594 break;
5595
5596 case TPACPI_THERMAL_NONE:
5597 default:
5598 return -ENOSYS;
5599 }
5600
5601 return -EINVAL;
5602}
5603
5604static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5605{
5606 int res, i;
5607 int n;
5608
5609 n = 8;
5610 i = 0;
5611
5612 if (!s)
5613 return -EINVAL;
5614
5615 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5616 n = 16;
5617
5618 for (i = 0 ; i < n; i++) {
5619 res = thermal_get_sensor(i, &s->temp[i]);
5620 if (res)
5621 return res;
5622 }
5623
5624 return n;
5625}
5626
5627static void thermal_dump_all_sensors(void)
5628{
5629 int n, i;
5630 struct ibm_thermal_sensors_struct t;
5631
5632 n = thermal_get_sensors(&t);
5633 if (n <= 0)
5634 return;
5635
5636 pr_notice("temperatures (Celsius):");
5637
5638 for (i = 0; i < n; i++) {
5639 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
5640 pr_cont(" %d", (int)(t.temp[i] / 1000));
5641 else
5642 pr_cont(" N/A");
5643 }
5644
5645 pr_cont("\n");
5646}
5647
5648/* sysfs temp##_input -------------------------------------------------- */
5649
5650static ssize_t thermal_temp_input_show(struct device *dev,
5651 struct device_attribute *attr,
5652 char *buf)
5653{
5654 struct sensor_device_attribute *sensor_attr =
5655 to_sensor_dev_attr(attr);
5656 int idx = sensor_attr->index;
5657 s32 value;
5658 int res;
5659
5660 res = thermal_get_sensor(idx, &value);
5661 if (res)
5662 return res;
5663 if (value == TPACPI_THERMAL_SENSOR_NA)
5664 return -ENXIO;
5665
5666 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5667}
5668
5669#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5670 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5671 thermal_temp_input_show, NULL, _idxB)
5672
5673static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5674 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5675 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5676 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5677 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5678 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5679 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5680 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5681 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5682 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5683 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5684 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5685 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5686 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5687 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5688 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5689 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5690};
5691
5692#define THERMAL_ATTRS(X) \
5693 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5694
5695static struct attribute *thermal_temp_input_attr[] = {
5696 THERMAL_ATTRS(8),
5697 THERMAL_ATTRS(9),
5698 THERMAL_ATTRS(10),
5699 THERMAL_ATTRS(11),
5700 THERMAL_ATTRS(12),
5701 THERMAL_ATTRS(13),
5702 THERMAL_ATTRS(14),
5703 THERMAL_ATTRS(15),
5704 THERMAL_ATTRS(0),
5705 THERMAL_ATTRS(1),
5706 THERMAL_ATTRS(2),
5707 THERMAL_ATTRS(3),
5708 THERMAL_ATTRS(4),
5709 THERMAL_ATTRS(5),
5710 THERMAL_ATTRS(6),
5711 THERMAL_ATTRS(7),
5712 NULL
5713};
5714
5715static const struct attribute_group thermal_temp_input16_group = {
5716 .attrs = thermal_temp_input_attr
5717};
5718
5719static const struct attribute_group thermal_temp_input8_group = {
5720 .attrs = &thermal_temp_input_attr[8]
5721};
5722
5723#undef THERMAL_SENSOR_ATTR_TEMP
5724#undef THERMAL_ATTRS
5725
5726/* --------------------------------------------------------------------- */
5727
5728static int __init thermal_init(struct ibm_init_struct *iibm)
5729{
5730 u8 t, ta1, ta2;
5731 int i;
5732 int acpi_tmp7;
5733 int res;
5734
5735 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5736
5737 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5738
5739 if (thinkpad_id.ec_model) {
5740 /*
5741 * Direct EC access mode: sensors at registers
5742 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5743 * non-implemented, thermal sensors return 0x80 when
5744 * not available
5745 */
5746
5747 ta1 = ta2 = 0;
5748 for (i = 0; i < 8; i++) {
5749 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5750 ta1 |= t;
5751 } else {
5752 ta1 = 0;
5753 break;
5754 }
5755 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5756 ta2 |= t;
5757 } else {
5758 ta1 = 0;
5759 break;
5760 }
5761 }
5762 if (ta1 == 0) {
5763 /* This is sheer paranoia, but we handle it anyway */
5764 if (acpi_tmp7) {
5765 pr_err("ThinkPad ACPI EC access misbehaving, "
5766 "falling back to ACPI TMPx access "
5767 "mode\n");
5768 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5769 } else {
5770 pr_err("ThinkPad ACPI EC access misbehaving, "
5771 "disabling thermal sensors access\n");
5772 thermal_read_mode = TPACPI_THERMAL_NONE;
5773 }
5774 } else {
5775 thermal_read_mode =
5776 (ta2 != 0) ?
5777 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5778 }
5779 } else if (acpi_tmp7) {
5780 if (tpacpi_is_ibm() &&
5781 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5782 /* 600e/x, 770e, 770x */
5783 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5784 } else {
5785 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
5786 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5787 }
5788 } else {
5789 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5790 thermal_read_mode = TPACPI_THERMAL_NONE;
5791 }
5792
5793 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5794 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5795 thermal_read_mode);
5796
5797 switch (thermal_read_mode) {
5798 case TPACPI_THERMAL_TPEC_16:
5799 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5800 &thermal_temp_input16_group);
5801 if (res)
5802 return res;
5803 break;
5804 case TPACPI_THERMAL_TPEC_8:
5805 case TPACPI_THERMAL_ACPI_TMP07:
5806 case TPACPI_THERMAL_ACPI_UPDT:
5807 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5808 &thermal_temp_input8_group);
5809 if (res)
5810 return res;
5811 break;
5812 case TPACPI_THERMAL_NONE:
5813 default:
5814 return 1;
5815 }
5816
5817 return 0;
5818}
5819
5820static void thermal_exit(void)
5821{
5822 switch (thermal_read_mode) {
5823 case TPACPI_THERMAL_TPEC_16:
5824 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5825 &thermal_temp_input16_group);
5826 break;
5827 case TPACPI_THERMAL_TPEC_8:
5828 case TPACPI_THERMAL_ACPI_TMP07:
5829 case TPACPI_THERMAL_ACPI_UPDT:
5830 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5831 &thermal_temp_input8_group);
5832 break;
5833 case TPACPI_THERMAL_NONE:
5834 default:
5835 break;
5836 }
5837}
5838
5839static int thermal_read(struct seq_file *m)
5840{
5841 int n, i;
5842 struct ibm_thermal_sensors_struct t;
5843
5844 n = thermal_get_sensors(&t);
5845 if (unlikely(n < 0))
5846 return n;
5847
5848 seq_printf(m, "temperatures:\t");
5849
5850 if (n > 0) {
5851 for (i = 0; i < (n - 1); i++)
5852 seq_printf(m, "%d ", t.temp[i] / 1000);
5853 seq_printf(m, "%d\n", t.temp[i] / 1000);
5854 } else
5855 seq_printf(m, "not supported\n");
5856
5857 return 0;
5858}
5859
5860static struct ibm_struct thermal_driver_data = {
5861 .name = "thermal",
5862 .read = thermal_read,
5863 .exit = thermal_exit,
5864};
5865
5866/*************************************************************************
5867 * Backlight/brightness subdriver
5868 */
5869
5870#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5871
5872/*
5873 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5874 * CMOS NVRAM byte 0x5E, bits 0-3.
5875 *
5876 * EC HBRV (0x31) has the following layout
5877 * Bit 7: unknown function
5878 * Bit 6: unknown function
5879 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5880 * Bit 4: must be set to zero to avoid problems
5881 * Bit 3-0: backlight brightness level
5882 *
5883 * brightness_get_raw returns status data in the HBRV layout
5884 *
5885 * WARNING: The X61 has been verified to use HBRV for something else, so
5886 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5887 * testing on the very early *60 Lenovo models...
5888 */
5889
5890enum {
5891 TP_EC_BACKLIGHT = 0x31,
5892
5893 /* TP_EC_BACKLIGHT bitmasks */
5894 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5895 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5896 TP_EC_BACKLIGHT_MAPSW = 0x20,
5897};
5898
5899enum tpacpi_brightness_access_mode {
5900 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5901 TPACPI_BRGHT_MODE_EC, /* EC control */
5902 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5903 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5904 TPACPI_BRGHT_MODE_MAX
5905};
5906
5907static struct backlight_device *ibm_backlight_device;
5908
5909static enum tpacpi_brightness_access_mode brightness_mode =
5910 TPACPI_BRGHT_MODE_MAX;
5911
5912static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5913
5914static struct mutex brightness_mutex;
5915
5916/* NVRAM brightness access,
5917 * call with brightness_mutex held! */
5918static unsigned int tpacpi_brightness_nvram_get(void)
5919{
5920 u8 lnvram;
5921
5922 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5923 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5924 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5925 lnvram &= bright_maxlvl;
5926
5927 return lnvram;
5928}
5929
5930static void tpacpi_brightness_checkpoint_nvram(void)
5931{
5932 u8 lec = 0;
5933 u8 b_nvram;
5934
5935 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5936 return;
5937
5938 vdbg_printk(TPACPI_DBG_BRGHT,
5939 "trying to checkpoint backlight level to NVRAM...\n");
5940
5941 if (mutex_lock_killable(&brightness_mutex) < 0)
5942 return;
5943
5944 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5945 goto unlock;
5946 lec &= TP_EC_BACKLIGHT_LVLMSK;
5947 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5948
5949 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5950 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5951 /* NVRAM needs update */
5952 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5953 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5954 b_nvram |= lec;
5955 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5956 dbg_printk(TPACPI_DBG_BRGHT,
5957 "updated NVRAM backlight level to %u (0x%02x)\n",
5958 (unsigned int) lec, (unsigned int) b_nvram);
5959 } else
5960 vdbg_printk(TPACPI_DBG_BRGHT,
5961 "NVRAM backlight level already is %u (0x%02x)\n",
5962 (unsigned int) lec, (unsigned int) b_nvram);
5963
5964unlock:
5965 mutex_unlock(&brightness_mutex);
5966}
5967
5968
5969/* call with brightness_mutex held! */
5970static int tpacpi_brightness_get_raw(int *status)
5971{
5972 u8 lec = 0;
5973
5974 switch (brightness_mode) {
5975 case TPACPI_BRGHT_MODE_UCMS_STEP:
5976 *status = tpacpi_brightness_nvram_get();
5977 return 0;
5978 case TPACPI_BRGHT_MODE_EC:
5979 case TPACPI_BRGHT_MODE_ECNVRAM:
5980 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5981 return -EIO;
5982 *status = lec;
5983 return 0;
5984 default:
5985 return -ENXIO;
5986 }
5987}
5988
5989/* call with brightness_mutex held! */
5990/* do NOT call with illegal backlight level value */
5991static int tpacpi_brightness_set_ec(unsigned int value)
5992{
5993 u8 lec = 0;
5994
5995 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5996 return -EIO;
5997
5998 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
5999 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6000 (value & TP_EC_BACKLIGHT_LVLMSK))))
6001 return -EIO;
6002
6003 return 0;
6004}
6005
6006/* call with brightness_mutex held! */
6007static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6008{
6009 int cmos_cmd, inc;
6010 unsigned int current_value, i;
6011
6012 current_value = tpacpi_brightness_nvram_get();
6013
6014 if (value == current_value)
6015 return 0;
6016
6017 cmos_cmd = (value > current_value) ?
6018 TP_CMOS_BRIGHTNESS_UP :
6019 TP_CMOS_BRIGHTNESS_DOWN;
6020 inc = (value > current_value) ? 1 : -1;
6021
6022 for (i = current_value; i != value; i += inc)
6023 if (issue_thinkpad_cmos_command(cmos_cmd))
6024 return -EIO;
6025
6026 return 0;
6027}
6028
6029/* May return EINTR which can always be mapped to ERESTARTSYS */
6030static int brightness_set(unsigned int value)
6031{
6032 int res;
6033
6034 if (value > bright_maxlvl || value < 0)
6035 return -EINVAL;
6036
6037 vdbg_printk(TPACPI_DBG_BRGHT,
6038 "set backlight level to %d\n", value);
6039
6040 res = mutex_lock_killable(&brightness_mutex);
6041 if (res < 0)
6042 return res;
6043
6044 switch (brightness_mode) {
6045 case TPACPI_BRGHT_MODE_EC:
6046 case TPACPI_BRGHT_MODE_ECNVRAM:
6047 res = tpacpi_brightness_set_ec(value);
6048 break;
6049 case TPACPI_BRGHT_MODE_UCMS_STEP:
6050 res = tpacpi_brightness_set_ucmsstep(value);
6051 break;
6052 default:
6053 res = -ENXIO;
6054 }
6055
6056 mutex_unlock(&brightness_mutex);
6057 return res;
6058}
6059
6060/* sysfs backlight class ----------------------------------------------- */
6061
6062static int brightness_update_status(struct backlight_device *bd)
6063{
6064 unsigned int level =
6065 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6066 bd->props.power == FB_BLANK_UNBLANK) ?
6067 bd->props.brightness : 0;
6068
6069 dbg_printk(TPACPI_DBG_BRGHT,
6070 "backlight: attempt to set level to %d\n",
6071 level);
6072
6073 /* it is the backlight class's job (caller) to handle
6074 * EINTR and other errors properly */
6075 return brightness_set(level);
6076}
6077
6078static int brightness_get(struct backlight_device *bd)
6079{
6080 int status, res;
6081
6082 res = mutex_lock_killable(&brightness_mutex);
6083 if (res < 0)
6084 return 0;
6085
6086 res = tpacpi_brightness_get_raw(&status);
6087
6088 mutex_unlock(&brightness_mutex);
6089
6090 if (res < 0)
6091 return 0;
6092
6093 return status & TP_EC_BACKLIGHT_LVLMSK;
6094}
6095
6096static void tpacpi_brightness_notify_change(void)
6097{
6098 backlight_force_update(ibm_backlight_device,
6099 BACKLIGHT_UPDATE_HOTKEY);
6100}
6101
6102static const struct backlight_ops ibm_backlight_data = {
6103 .get_brightness = brightness_get,
6104 .update_status = brightness_update_status,
6105};
6106
6107/* --------------------------------------------------------------------- */
6108
6109/*
6110 * Call _BCL method of video device. On some ThinkPads this will
6111 * switch the firmware to the ACPI brightness control mode.
6112 */
6113
6114static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6115{
6116 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6117 union acpi_object *obj;
6118 int rc;
6119
6120 if (ACPI_SUCCESS(acpi_evaluate_object(handle, "_BCL", NULL, &buffer))) {
6121 obj = (union acpi_object *)buffer.pointer;
6122 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6123 pr_err("Unknown _BCL data, please report this to %s\n",
6124 TPACPI_MAIL);
6125 rc = 0;
6126 } else {
6127 rc = obj->package.count;
6128 }
6129 } else {
6130 return 0;
6131 }
6132
6133 kfree(buffer.pointer);
6134 return rc;
6135}
6136
6137
6138/*
6139 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6140 */
6141static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6142{
6143 acpi_handle video_device;
6144 int bcl_levels = 0;
6145
6146 tpacpi_acpi_handle_locate("video", ACPI_VIDEO_HID, &video_device);
6147 if (video_device)
6148 bcl_levels = tpacpi_query_bcl_levels(video_device);
6149
6150 tp_features.bright_acpimode = (bcl_levels > 0);
6151
6152 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6153}
6154
6155/*
6156 * These are only useful for models that have only one possibility
6157 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6158 * these quirks.
6159 */
6160#define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6161#define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6162#define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6163
6164static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6165 /* Models with ATI GPUs known to require ECNVRAM mode */
6166 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6167
6168 /* Models with ATI GPUs that can use ECNVRAM */
6169 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6170 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6171 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6172 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6173
6174 /* Models with Intel Extreme Graphics 2 */
6175 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6176 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6177 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6178
6179 /* Models with Intel GMA900 */
6180 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6181 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6182 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6183};
6184
6185/*
6186 * Returns < 0 for error, otherwise sets tp_features.bright_*
6187 * and bright_maxlvl.
6188 */
6189static void __init tpacpi_detect_brightness_capabilities(void)
6190{
6191 unsigned int b;
6192
6193 vdbg_printk(TPACPI_DBG_INIT,
6194 "detecting firmware brightness interface capabilities\n");
6195
6196 /* we could run a quirks check here (same table used by
6197 * brightness_init) if needed */
6198
6199 /*
6200 * We always attempt to detect acpi support, so as to switch
6201 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6202 * going to publish a backlight interface
6203 */
6204 b = tpacpi_check_std_acpi_brightness_support();
6205 switch (b) {
6206 case 16:
6207 bright_maxlvl = 15;
6208 pr_info("detected a 16-level brightness capable ThinkPad\n");
6209 break;
6210 case 8:
6211 case 0:
6212 bright_maxlvl = 7;
6213 pr_info("detected a 8-level brightness capable ThinkPad\n");
6214 break;
6215 default:
6216 pr_err("Unsupported brightness interface, "
6217 "please contact %s\n", TPACPI_MAIL);
6218 tp_features.bright_unkfw = 1;
6219 bright_maxlvl = b - 1;
6220 }
6221}
6222
6223static int __init brightness_init(struct ibm_init_struct *iibm)
6224{
6225 struct backlight_properties props;
6226 int b;
6227 unsigned long quirks;
6228
6229 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6230
6231 mutex_init(&brightness_mutex);
6232
6233 quirks = tpacpi_check_quirks(brightness_quirk_table,
6234 ARRAY_SIZE(brightness_quirk_table));
6235
6236 /* tpacpi_detect_brightness_capabilities() must have run already */
6237
6238 /* if it is unknown, we don't handle it: it wouldn't be safe */
6239 if (tp_features.bright_unkfw)
6240 return 1;
6241
6242 if (!brightness_enable) {
6243 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6244 "brightness support disabled by "
6245 "module parameter\n");
6246 return 1;
6247 }
6248
6249 if (acpi_video_backlight_support()) {
6250 if (brightness_enable > 1) {
6251 pr_info("Standard ACPI backlight interface "
6252 "available, not loading native one\n");
6253 return 1;
6254 } else if (brightness_enable == 1) {
6255 pr_warn("Cannot enable backlight brightness support, "
6256 "ACPI is already handling it. Refer to the "
6257 "acpi_backlight kernel parameter.\n");
6258 return 1;
6259 }
6260 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6261 pr_notice("Standard ACPI backlight interface not "
6262 "available, thinkpad_acpi native "
6263 "brightness control enabled\n");
6264 }
6265
6266 /*
6267 * Check for module parameter bogosity, note that we
6268 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6269 * able to detect "unspecified"
6270 */
6271 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6272 return -EINVAL;
6273
6274 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6275 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6276 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6277 if (quirks & TPACPI_BRGHT_Q_EC)
6278 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6279 else
6280 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6281
6282 dbg_printk(TPACPI_DBG_BRGHT,
6283 "driver auto-selected brightness_mode=%d\n",
6284 brightness_mode);
6285 }
6286
6287 /* Safety */
6288 if (!tpacpi_is_ibm() &&
6289 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6290 brightness_mode == TPACPI_BRGHT_MODE_EC))
6291 return -EINVAL;
6292
6293 if (tpacpi_brightness_get_raw(&b) < 0)
6294 return 1;
6295
6296 memset(&props, 0, sizeof(struct backlight_properties));
6297 props.type = BACKLIGHT_PLATFORM;
6298 props.max_brightness = bright_maxlvl;
6299 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6300 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6301 NULL, NULL,
6302 &ibm_backlight_data,
6303 &props);
6304 if (IS_ERR(ibm_backlight_device)) {
6305 int rc = PTR_ERR(ibm_backlight_device);
6306 ibm_backlight_device = NULL;
6307 pr_err("Could not register backlight device\n");
6308 return rc;
6309 }
6310 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6311 "brightness is supported\n");
6312
6313 if (quirks & TPACPI_BRGHT_Q_ASK) {
6314 pr_notice("brightness: will use unverified default: "
6315 "brightness_mode=%d\n", brightness_mode);
6316 pr_notice("brightness: please report to %s whether it works well "
6317 "or not on your ThinkPad\n", TPACPI_MAIL);
6318 }
6319
6320 /* Added by mistake in early 2007. Probably useless, but it could
6321 * be working around some unknown firmware problem where the value
6322 * read at startup doesn't match the real hardware state... so leave
6323 * it in place just in case */
6324 backlight_update_status(ibm_backlight_device);
6325
6326 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6327 "brightness: registering brightness hotkeys "
6328 "as change notification\n");
6329 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6330 | TP_ACPI_HKEY_BRGHTUP_MASK
6331 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6332 return 0;
6333}
6334
6335static void brightness_suspend(pm_message_t state)
6336{
6337 tpacpi_brightness_checkpoint_nvram();
6338}
6339
6340static void brightness_shutdown(void)
6341{
6342 tpacpi_brightness_checkpoint_nvram();
6343}
6344
6345static void brightness_exit(void)
6346{
6347 if (ibm_backlight_device) {
6348 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6349 "calling backlight_device_unregister()\n");
6350 backlight_device_unregister(ibm_backlight_device);
6351 }
6352
6353 tpacpi_brightness_checkpoint_nvram();
6354}
6355
6356static int brightness_read(struct seq_file *m)
6357{
6358 int level;
6359
6360 level = brightness_get(NULL);
6361 if (level < 0) {
6362 seq_printf(m, "level:\t\tunreadable\n");
6363 } else {
6364 seq_printf(m, "level:\t\t%d\n", level);
6365 seq_printf(m, "commands:\tup, down\n");
6366 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6367 bright_maxlvl);
6368 }
6369
6370 return 0;
6371}
6372
6373static int brightness_write(char *buf)
6374{
6375 int level;
6376 int rc;
6377 char *cmd;
6378
6379 level = brightness_get(NULL);
6380 if (level < 0)
6381 return level;
6382
6383 while ((cmd = next_cmd(&buf))) {
6384 if (strlencmp(cmd, "up") == 0) {
6385 if (level < bright_maxlvl)
6386 level++;
6387 } else if (strlencmp(cmd, "down") == 0) {
6388 if (level > 0)
6389 level--;
6390 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6391 level >= 0 && level <= bright_maxlvl) {
6392 /* new level set */
6393 } else
6394 return -EINVAL;
6395 }
6396
6397 tpacpi_disclose_usertask("procfs brightness",
6398 "set level to %d\n", level);
6399
6400 /*
6401 * Now we know what the final level should be, so we try to set it.
6402 * Doing it this way makes the syscall restartable in case of EINTR
6403 */
6404 rc = brightness_set(level);
6405 if (!rc && ibm_backlight_device)
6406 backlight_force_update(ibm_backlight_device,
6407 BACKLIGHT_UPDATE_SYSFS);
6408 return (rc == -EINTR)? -ERESTARTSYS : rc;
6409}
6410
6411static struct ibm_struct brightness_driver_data = {
6412 .name = "brightness",
6413 .read = brightness_read,
6414 .write = brightness_write,
6415 .exit = brightness_exit,
6416 .suspend = brightness_suspend,
6417 .shutdown = brightness_shutdown,
6418};
6419
6420/*************************************************************************
6421 * Volume subdriver
6422 */
6423
6424/*
6425 * IBM ThinkPads have a simple volume controller with MUTE gating.
6426 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6427 *
6428 * Since the *61 series (and probably also the later *60 series), Lenovo
6429 * ThinkPads only implement the MUTE gate.
6430 *
6431 * EC register 0x30
6432 * Bit 6: MUTE (1 mutes sound)
6433 * Bit 3-0: Volume
6434 * Other bits should be zero as far as we know.
6435 *
6436 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6437 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6438 * such as bit 7 which is used to detect repeated presses of MUTE,
6439 * and we leave them unchanged.
6440 */
6441
6442#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6443
6444#define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6445#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6446#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6447
6448static int alsa_index = ~((1 << (SNDRV_CARDS - 3)) - 1); /* last three slots */
6449static char *alsa_id = "ThinkPadEC";
6450static int alsa_enable = SNDRV_DEFAULT_ENABLE1;
6451
6452struct tpacpi_alsa_data {
6453 struct snd_card *card;
6454 struct snd_ctl_elem_id *ctl_mute_id;
6455 struct snd_ctl_elem_id *ctl_vol_id;
6456};
6457
6458static struct snd_card *alsa_card;
6459
6460enum {
6461 TP_EC_AUDIO = 0x30,
6462
6463 /* TP_EC_AUDIO bits */
6464 TP_EC_AUDIO_MUTESW = 6,
6465
6466 /* TP_EC_AUDIO bitmasks */
6467 TP_EC_AUDIO_LVL_MSK = 0x0F,
6468 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6469
6470 /* Maximum volume */
6471 TP_EC_VOLUME_MAX = 14,
6472};
6473
6474enum tpacpi_volume_access_mode {
6475 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6476 TPACPI_VOL_MODE_EC, /* Pure EC control */
6477 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6478 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6479 TPACPI_VOL_MODE_MAX
6480};
6481
6482enum tpacpi_volume_capabilities {
6483 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6484 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6485 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6486 TPACPI_VOL_CAP_MAX
6487};
6488
6489static enum tpacpi_volume_access_mode volume_mode =
6490 TPACPI_VOL_MODE_MAX;
6491
6492static enum tpacpi_volume_capabilities volume_capabilities;
6493static int volume_control_allowed;
6494
6495/*
6496 * Used to syncronize writers to TP_EC_AUDIO and
6497 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6498 */
6499static struct mutex volume_mutex;
6500
6501static void tpacpi_volume_checkpoint_nvram(void)
6502{
6503 u8 lec = 0;
6504 u8 b_nvram;
6505 u8 ec_mask;
6506
6507 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6508 return;
6509 if (!volume_control_allowed)
6510 return;
6511
6512 vdbg_printk(TPACPI_DBG_MIXER,
6513 "trying to checkpoint mixer state to NVRAM...\n");
6514
6515 if (tp_features.mixer_no_level_control)
6516 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6517 else
6518 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6519
6520 if (mutex_lock_killable(&volume_mutex) < 0)
6521 return;
6522
6523 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6524 goto unlock;
6525 lec &= ec_mask;
6526 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
6527
6528 if (lec != (b_nvram & ec_mask)) {
6529 /* NVRAM needs update */
6530 b_nvram &= ~ec_mask;
6531 b_nvram |= lec;
6532 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
6533 dbg_printk(TPACPI_DBG_MIXER,
6534 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
6535 (unsigned int) lec, (unsigned int) b_nvram);
6536 } else {
6537 vdbg_printk(TPACPI_DBG_MIXER,
6538 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
6539 (unsigned int) lec, (unsigned int) b_nvram);
6540 }
6541
6542unlock:
6543 mutex_unlock(&volume_mutex);
6544}
6545
6546static int volume_get_status_ec(u8 *status)
6547{
6548 u8 s;
6549
6550 if (!acpi_ec_read(TP_EC_AUDIO, &s))
6551 return -EIO;
6552
6553 *status = s;
6554
6555 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
6556
6557 return 0;
6558}
6559
6560static int volume_get_status(u8 *status)
6561{
6562 return volume_get_status_ec(status);
6563}
6564
6565static int volume_set_status_ec(const u8 status)
6566{
6567 if (!acpi_ec_write(TP_EC_AUDIO, status))
6568 return -EIO;
6569
6570 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
6571
6572 return 0;
6573}
6574
6575static int volume_set_status(const u8 status)
6576{
6577 return volume_set_status_ec(status);
6578}
6579
6580/* returns < 0 on error, 0 on no change, 1 on change */
6581static int __volume_set_mute_ec(const bool mute)
6582{
6583 int rc;
6584 u8 s, n;
6585
6586 if (mutex_lock_killable(&volume_mutex) < 0)
6587 return -EINTR;
6588
6589 rc = volume_get_status_ec(&s);
6590 if (rc)
6591 goto unlock;
6592
6593 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
6594 s & ~TP_EC_AUDIO_MUTESW_MSK;
6595
6596 if (n != s) {
6597 rc = volume_set_status_ec(n);
6598 if (!rc)
6599 rc = 1;
6600 }
6601
6602unlock:
6603 mutex_unlock(&volume_mutex);
6604 return rc;
6605}
6606
6607static int volume_alsa_set_mute(const bool mute)
6608{
6609 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
6610 (mute) ? "" : "un");
6611 return __volume_set_mute_ec(mute);
6612}
6613
6614static int volume_set_mute(const bool mute)
6615{
6616 int rc;
6617
6618 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
6619 (mute) ? "" : "un");
6620
6621 rc = __volume_set_mute_ec(mute);
6622 return (rc < 0) ? rc : 0;
6623}
6624
6625/* returns < 0 on error, 0 on no change, 1 on change */
6626static int __volume_set_volume_ec(const u8 vol)
6627{
6628 int rc;
6629 u8 s, n;
6630
6631 if (vol > TP_EC_VOLUME_MAX)
6632 return -EINVAL;
6633
6634 if (mutex_lock_killable(&volume_mutex) < 0)
6635 return -EINTR;
6636
6637 rc = volume_get_status_ec(&s);
6638 if (rc)
6639 goto unlock;
6640
6641 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
6642
6643 if (n != s) {
6644 rc = volume_set_status_ec(n);
6645 if (!rc)
6646 rc = 1;
6647 }
6648
6649unlock:
6650 mutex_unlock(&volume_mutex);
6651 return rc;
6652}
6653
6654static int volume_alsa_set_volume(const u8 vol)
6655{
6656 dbg_printk(TPACPI_DBG_MIXER,
6657 "ALSA: trying to set volume level to %hu\n", vol);
6658 return __volume_set_volume_ec(vol);
6659}
6660
6661static void volume_alsa_notify_change(void)
6662{
6663 struct tpacpi_alsa_data *d;
6664
6665 if (alsa_card && alsa_card->private_data) {
6666 d = alsa_card->private_data;
6667 if (d->ctl_mute_id)
6668 snd_ctl_notify(alsa_card,
6669 SNDRV_CTL_EVENT_MASK_VALUE,
6670 d->ctl_mute_id);
6671 if (d->ctl_vol_id)
6672 snd_ctl_notify(alsa_card,
6673 SNDRV_CTL_EVENT_MASK_VALUE,
6674 d->ctl_vol_id);
6675 }
6676}
6677
6678static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
6679 struct snd_ctl_elem_info *uinfo)
6680{
6681 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
6682 uinfo->count = 1;
6683 uinfo->value.integer.min = 0;
6684 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
6685 return 0;
6686}
6687
6688static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
6689 struct snd_ctl_elem_value *ucontrol)
6690{
6691 u8 s;
6692 int rc;
6693
6694 rc = volume_get_status(&s);
6695 if (rc < 0)
6696 return rc;
6697
6698 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
6699 return 0;
6700}
6701
6702static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
6703 struct snd_ctl_elem_value *ucontrol)
6704{
6705 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
6706 ucontrol->value.integer.value[0]);
6707 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
6708}
6709
6710#define volume_alsa_mute_info snd_ctl_boolean_mono_info
6711
6712static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
6713 struct snd_ctl_elem_value *ucontrol)
6714{
6715 u8 s;
6716 int rc;
6717
6718 rc = volume_get_status(&s);
6719 if (rc < 0)
6720 return rc;
6721
6722 ucontrol->value.integer.value[0] =
6723 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
6724 return 0;
6725}
6726
6727static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
6728 struct snd_ctl_elem_value *ucontrol)
6729{
6730 tpacpi_disclose_usertask("ALSA", "%smute\n",
6731 ucontrol->value.integer.value[0] ?
6732 "un" : "");
6733 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
6734}
6735
6736static struct snd_kcontrol_new volume_alsa_control_vol __devinitdata = {
6737 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6738 .name = "Console Playback Volume",
6739 .index = 0,
6740 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6741 .info = volume_alsa_vol_info,
6742 .get = volume_alsa_vol_get,
6743};
6744
6745static struct snd_kcontrol_new volume_alsa_control_mute __devinitdata = {
6746 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
6747 .name = "Console Playback Switch",
6748 .index = 0,
6749 .access = SNDRV_CTL_ELEM_ACCESS_READ,
6750 .info = volume_alsa_mute_info,
6751 .get = volume_alsa_mute_get,
6752};
6753
6754static void volume_suspend(pm_message_t state)
6755{
6756 tpacpi_volume_checkpoint_nvram();
6757}
6758
6759static void volume_resume(void)
6760{
6761 volume_alsa_notify_change();
6762}
6763
6764static void volume_shutdown(void)
6765{
6766 tpacpi_volume_checkpoint_nvram();
6767}
6768
6769static void volume_exit(void)
6770{
6771 if (alsa_card) {
6772 snd_card_free(alsa_card);
6773 alsa_card = NULL;
6774 }
6775
6776 tpacpi_volume_checkpoint_nvram();
6777}
6778
6779static int __init volume_create_alsa_mixer(void)
6780{
6781 struct snd_card *card;
6782 struct tpacpi_alsa_data *data;
6783 struct snd_kcontrol *ctl_vol;
6784 struct snd_kcontrol *ctl_mute;
6785 int rc;
6786
6787 rc = snd_card_create(alsa_index, alsa_id, THIS_MODULE,
6788 sizeof(struct tpacpi_alsa_data), &card);
6789 if (rc < 0 || !card) {
6790 pr_err("Failed to create ALSA card structures: %d\n", rc);
6791 return 1;
6792 }
6793
6794 BUG_ON(!card->private_data);
6795 data = card->private_data;
6796 data->card = card;
6797
6798 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
6799 sizeof(card->driver));
6800 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
6801 sizeof(card->shortname));
6802 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
6803 (thinkpad_id.ec_version_str) ?
6804 thinkpad_id.ec_version_str : "(unknown)");
6805 snprintf(card->longname, sizeof(card->longname),
6806 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
6807 (thinkpad_id.ec_version_str) ?
6808 thinkpad_id.ec_version_str : "unknown");
6809
6810 if (volume_control_allowed) {
6811 volume_alsa_control_vol.put = volume_alsa_vol_put;
6812 volume_alsa_control_vol.access =
6813 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6814
6815 volume_alsa_control_mute.put = volume_alsa_mute_put;
6816 volume_alsa_control_mute.access =
6817 SNDRV_CTL_ELEM_ACCESS_READWRITE;
6818 }
6819
6820 if (!tp_features.mixer_no_level_control) {
6821 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
6822 rc = snd_ctl_add(card, ctl_vol);
6823 if (rc < 0) {
6824 pr_err("Failed to create ALSA volume control: %d\n",
6825 rc);
6826 goto err_exit;
6827 }
6828 data->ctl_vol_id = &ctl_vol->id;
6829 }
6830
6831 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
6832 rc = snd_ctl_add(card, ctl_mute);
6833 if (rc < 0) {
6834 pr_err("Failed to create ALSA mute control: %d\n", rc);
6835 goto err_exit;
6836 }
6837 data->ctl_mute_id = &ctl_mute->id;
6838
6839 snd_card_set_dev(card, &tpacpi_pdev->dev);
6840 rc = snd_card_register(card);
6841 if (rc < 0) {
6842 pr_err("Failed to register ALSA card: %d\n", rc);
6843 goto err_exit;
6844 }
6845
6846 alsa_card = card;
6847 return 0;
6848
6849err_exit:
6850 snd_card_free(card);
6851 return 1;
6852}
6853
6854#define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
6855#define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
6856
6857static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
6858 /* Whitelist volume level on all IBM by default */
6859 { .vendor = PCI_VENDOR_ID_IBM,
6860 .bios = TPACPI_MATCH_ANY,
6861 .ec = TPACPI_MATCH_ANY,
6862 .quirks = TPACPI_VOL_Q_LEVEL },
6863
6864 /* Lenovo models with volume control (needs confirmation) */
6865 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
6866 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
6867 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
6868 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
6869 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
6870 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
6871 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
6872
6873 /* Whitelist mute-only on all Lenovo by default */
6874 { .vendor = PCI_VENDOR_ID_LENOVO,
6875 .bios = TPACPI_MATCH_ANY,
6876 .ec = TPACPI_MATCH_ANY,
6877 .quirks = TPACPI_VOL_Q_MUTEONLY }
6878};
6879
6880static int __init volume_init(struct ibm_init_struct *iibm)
6881{
6882 unsigned long quirks;
6883 int rc;
6884
6885 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
6886
6887 mutex_init(&volume_mutex);
6888
6889 /*
6890 * Check for module parameter bogosity, note that we
6891 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
6892 * able to detect "unspecified"
6893 */
6894 if (volume_mode > TPACPI_VOL_MODE_MAX)
6895 return -EINVAL;
6896
6897 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
6898 pr_err("UCMS step volume mode not implemented, "
6899 "please contact %s\n", TPACPI_MAIL);
6900 return 1;
6901 }
6902
6903 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
6904 return -EINVAL;
6905
6906 /*
6907 * The ALSA mixer is our primary interface.
6908 * When disabled, don't install the subdriver at all
6909 */
6910 if (!alsa_enable) {
6911 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6912 "ALSA mixer disabled by parameter, "
6913 "not loading volume subdriver...\n");
6914 return 1;
6915 }
6916
6917 quirks = tpacpi_check_quirks(volume_quirk_table,
6918 ARRAY_SIZE(volume_quirk_table));
6919
6920 switch (volume_capabilities) {
6921 case TPACPI_VOL_CAP_AUTO:
6922 if (quirks & TPACPI_VOL_Q_MUTEONLY)
6923 tp_features.mixer_no_level_control = 1;
6924 else if (quirks & TPACPI_VOL_Q_LEVEL)
6925 tp_features.mixer_no_level_control = 0;
6926 else
6927 return 1; /* no mixer */
6928 break;
6929 case TPACPI_VOL_CAP_VOLMUTE:
6930 tp_features.mixer_no_level_control = 0;
6931 break;
6932 case TPACPI_VOL_CAP_MUTEONLY:
6933 tp_features.mixer_no_level_control = 1;
6934 break;
6935 default:
6936 return 1;
6937 }
6938
6939 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
6940 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6941 "using user-supplied volume_capabilities=%d\n",
6942 volume_capabilities);
6943
6944 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
6945 volume_mode == TPACPI_VOL_MODE_MAX) {
6946 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
6947
6948 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6949 "driver auto-selected volume_mode=%d\n",
6950 volume_mode);
6951 } else {
6952 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6953 "using user-supplied volume_mode=%d\n",
6954 volume_mode);
6955 }
6956
6957 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6958 "mute is supported, volume control is %s\n",
6959 str_supported(!tp_features.mixer_no_level_control));
6960
6961 rc = volume_create_alsa_mixer();
6962 if (rc) {
6963 pr_err("Could not create the ALSA mixer interface\n");
6964 return rc;
6965 }
6966
6967 pr_info("Console audio control enabled, mode: %s\n",
6968 (volume_control_allowed) ?
6969 "override (read/write)" :
6970 "monitor (read only)");
6971
6972 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
6973 "registering volume hotkeys as change notification\n");
6974 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6975 | TP_ACPI_HKEY_VOLUP_MASK
6976 | TP_ACPI_HKEY_VOLDWN_MASK
6977 | TP_ACPI_HKEY_MUTE_MASK);
6978
6979 return 0;
6980}
6981
6982static int volume_read(struct seq_file *m)
6983{
6984 u8 status;
6985
6986 if (volume_get_status(&status) < 0) {
6987 seq_printf(m, "level:\t\tunreadable\n");
6988 } else {
6989 if (tp_features.mixer_no_level_control)
6990 seq_printf(m, "level:\t\tunsupported\n");
6991 else
6992 seq_printf(m, "level:\t\t%d\n",
6993 status & TP_EC_AUDIO_LVL_MSK);
6994
6995 seq_printf(m, "mute:\t\t%s\n",
6996 onoff(status, TP_EC_AUDIO_MUTESW));
6997
6998 if (volume_control_allowed) {
6999 seq_printf(m, "commands:\tunmute, mute\n");
7000 if (!tp_features.mixer_no_level_control) {
7001 seq_printf(m,
7002 "commands:\tup, down\n");
7003 seq_printf(m,
7004 "commands:\tlevel <level>"
7005 " (<level> is 0-%d)\n",
7006 TP_EC_VOLUME_MAX);
7007 }
7008 }
7009 }
7010
7011 return 0;
7012}
7013
7014static int volume_write(char *buf)
7015{
7016 u8 s;
7017 u8 new_level, new_mute;
7018 int l;
7019 char *cmd;
7020 int rc;
7021
7022 /*
7023 * We do allow volume control at driver startup, so that the
7024 * user can set initial state through the volume=... parameter hack.
7025 */
7026 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7027 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7028 tp_warned.volume_ctrl_forbidden = 1;
7029 pr_notice("Console audio control in monitor mode, "
7030 "changes are not allowed\n");
7031 pr_notice("Use the volume_control=1 module parameter "
7032 "to enable volume control\n");
7033 }
7034 return -EPERM;
7035 }
7036
7037 rc = volume_get_status(&s);
7038 if (rc < 0)
7039 return rc;
7040
7041 new_level = s & TP_EC_AUDIO_LVL_MSK;
7042 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7043
7044 while ((cmd = next_cmd(&buf))) {
7045 if (!tp_features.mixer_no_level_control) {
7046 if (strlencmp(cmd, "up") == 0) {
7047 if (new_mute)
7048 new_mute = 0;
7049 else if (new_level < TP_EC_VOLUME_MAX)
7050 new_level++;
7051 continue;
7052 } else if (strlencmp(cmd, "down") == 0) {
7053 if (new_mute)
7054 new_mute = 0;
7055 else if (new_level > 0)
7056 new_level--;
7057 continue;
7058 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7059 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7060 new_level = l;
7061 continue;
7062 }
7063 }
7064 if (strlencmp(cmd, "mute") == 0)
7065 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7066 else if (strlencmp(cmd, "unmute") == 0)
7067 new_mute = 0;
7068 else
7069 return -EINVAL;
7070 }
7071
7072 if (tp_features.mixer_no_level_control) {
7073 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7074 new_mute ? "" : "un");
7075 rc = volume_set_mute(!!new_mute);
7076 } else {
7077 tpacpi_disclose_usertask("procfs volume",
7078 "%smute and set level to %d\n",
7079 new_mute ? "" : "un", new_level);
7080 rc = volume_set_status(new_mute | new_level);
7081 }
7082 volume_alsa_notify_change();
7083
7084 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7085}
7086
7087static struct ibm_struct volume_driver_data = {
7088 .name = "volume",
7089 .read = volume_read,
7090 .write = volume_write,
7091 .exit = volume_exit,
7092 .suspend = volume_suspend,
7093 .resume = volume_resume,
7094 .shutdown = volume_shutdown,
7095};
7096
7097#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7098
7099#define alsa_card NULL
7100
7101static void inline volume_alsa_notify_change(void)
7102{
7103}
7104
7105static int __init volume_init(struct ibm_init_struct *iibm)
7106{
7107 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7108
7109 return 1;
7110}
7111
7112static struct ibm_struct volume_driver_data = {
7113 .name = "volume",
7114};
7115
7116#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7117
7118/*************************************************************************
7119 * Fan subdriver
7120 */
7121
7122/*
7123 * FAN ACCESS MODES
7124 *
7125 * TPACPI_FAN_RD_ACPI_GFAN:
7126 * ACPI GFAN method: returns fan level
7127 *
7128 * see TPACPI_FAN_WR_ACPI_SFAN
7129 * EC 0x2f (HFSP) not available if GFAN exists
7130 *
7131 * TPACPI_FAN_WR_ACPI_SFAN:
7132 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7133 *
7134 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7135 * it for writing.
7136 *
7137 * TPACPI_FAN_WR_TPEC:
7138 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7139 * Supported on almost all ThinkPads
7140 *
7141 * Fan speed changes of any sort (including those caused by the
7142 * disengaged mode) are usually done slowly by the firmware as the
7143 * maximum amount of fan duty cycle change per second seems to be
7144 * limited.
7145 *
7146 * Reading is not available if GFAN exists.
7147 * Writing is not available if SFAN exists.
7148 *
7149 * Bits
7150 * 7 automatic mode engaged;
7151 * (default operation mode of the ThinkPad)
7152 * fan level is ignored in this mode.
7153 * 6 full speed mode (takes precedence over bit 7);
7154 * not available on all thinkpads. May disable
7155 * the tachometer while the fan controller ramps up
7156 * the speed (which can take up to a few *minutes*).
7157 * Speeds up fan to 100% duty-cycle, which is far above
7158 * the standard RPM levels. It is not impossible that
7159 * it could cause hardware damage.
7160 * 5-3 unused in some models. Extra bits for fan level
7161 * in others, but still useless as all values above
7162 * 7 map to the same speed as level 7 in these models.
7163 * 2-0 fan level (0..7 usually)
7164 * 0x00 = stop
7165 * 0x07 = max (set when temperatures critical)
7166 * Some ThinkPads may have other levels, see
7167 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7168 *
7169 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7170 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7171 * does so, its initial value is meaningless (0x07).
7172 *
7173 * For firmware bugs, refer to:
7174 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7175 *
7176 * ----
7177 *
7178 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7179 * Main fan tachometer reading (in RPM)
7180 *
7181 * This register is present on all ThinkPads with a new-style EC, and
7182 * it is known not to be present on the A21m/e, and T22, as there is
7183 * something else in offset 0x84 according to the ACPI DSDT. Other
7184 * ThinkPads from this same time period (and earlier) probably lack the
7185 * tachometer as well.
7186 *
7187 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7188 * was never fixed by IBM to report the EC firmware version string
7189 * probably support the tachometer (like the early X models), so
7190 * detecting it is quite hard. We need more data to know for sure.
7191 *
7192 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7193 * might result.
7194 *
7195 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7196 * mode.
7197 *
7198 * For firmware bugs, refer to:
7199 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7200 *
7201 * ----
7202 *
7203 * ThinkPad EC register 0x31 bit 0 (only on select models)
7204 *
7205 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7206 * show the speed of the main fan. When bit 0 of EC register 0x31
7207 * is one, the tachometer registers show the speed of the auxiliary
7208 * fan.
7209 *
7210 * Fan control seems to affect both fans, regardless of the state
7211 * of this bit.
7212 *
7213 * So far, only the firmware for the X60/X61 non-tablet versions
7214 * seem to support this (firmware TP-7M).
7215 *
7216 * TPACPI_FAN_WR_ACPI_FANS:
7217 * ThinkPad X31, X40, X41. Not available in the X60.
7218 *
7219 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7220 * high speed. ACPI DSDT seems to map these three speeds to levels
7221 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7222 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7223 *
7224 * The speeds are stored on handles
7225 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7226 *
7227 * There are three default speed sets, accessible as handles:
7228 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7229 *
7230 * ACPI DSDT switches which set is in use depending on various
7231 * factors.
7232 *
7233 * TPACPI_FAN_WR_TPEC is also available and should be used to
7234 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7235 * but the ACPI tables just mention level 7.
7236 */
7237
7238enum { /* Fan control constants */
7239 fan_status_offset = 0x2f, /* EC register 0x2f */
7240 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7241 * 0x84 must be read before 0x85 */
7242 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7243 bit 0 selects which fan is active */
7244
7245 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7246 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7247
7248 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7249};
7250
7251enum fan_status_access_mode {
7252 TPACPI_FAN_NONE = 0, /* No fan status or control */
7253 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7254 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7255};
7256
7257enum fan_control_access_mode {
7258 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7259 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7260 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7261 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7262};
7263
7264enum fan_control_commands {
7265 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7266 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7267 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7268 * and also watchdog cmd */
7269};
7270
7271static int fan_control_allowed;
7272
7273static enum fan_status_access_mode fan_status_access_mode;
7274static enum fan_control_access_mode fan_control_access_mode;
7275static enum fan_control_commands fan_control_commands;
7276
7277static u8 fan_control_initial_status;
7278static u8 fan_control_desired_level;
7279static u8 fan_control_resume_level;
7280static int fan_watchdog_maxinterval;
7281
7282static struct mutex fan_mutex;
7283
7284static void fan_watchdog_fire(struct work_struct *ignored);
7285static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7286
7287TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7288TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7289 "\\FSPD", /* 600e/x, 770e, 770x */
7290 ); /* all others */
7291TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7292 "JFNS", /* 770x-JL */
7293 ); /* all others */
7294
7295/*
7296 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7297 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7298 * be in auto mode (0x80).
7299 *
7300 * This is corrected by any write to HFSP either by the driver, or
7301 * by the firmware.
7302 *
7303 * We assume 0x07 really means auto mode while this quirk is active,
7304 * as this is far more likely than the ThinkPad being in level 7,
7305 * which is only used by the firmware during thermal emergencies.
7306 *
7307 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7308 * TP-70 (T43, R52), which are known to be buggy.
7309 */
7310
7311static void fan_quirk1_setup(void)
7312{
7313 if (fan_control_initial_status == 0x07) {
7314 pr_notice("fan_init: initial fan status is unknown, "
7315 "assuming it is in auto mode\n");
7316 tp_features.fan_ctrl_status_undef = 1;
7317 }
7318}
7319
7320static void fan_quirk1_handle(u8 *fan_status)
7321{
7322 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7323 if (*fan_status != fan_control_initial_status) {
7324 /* something changed the HFSP regisnter since
7325 * driver init time, so it is not undefined
7326 * anymore */
7327 tp_features.fan_ctrl_status_undef = 0;
7328 } else {
7329 /* Return most likely status. In fact, it
7330 * might be the only possible status */
7331 *fan_status = TP_EC_FAN_AUTO;
7332 }
7333 }
7334}
7335
7336/* Select main fan on X60/X61, NOOP on others */
7337static bool fan_select_fan1(void)
7338{
7339 if (tp_features.second_fan) {
7340 u8 val;
7341
7342 if (ec_read(fan_select_offset, &val) < 0)
7343 return false;
7344 val &= 0xFEU;
7345 if (ec_write(fan_select_offset, val) < 0)
7346 return false;
7347 }
7348 return true;
7349}
7350
7351/* Select secondary fan on X60/X61 */
7352static bool fan_select_fan2(void)
7353{
7354 u8 val;
7355
7356 if (!tp_features.second_fan)
7357 return false;
7358
7359 if (ec_read(fan_select_offset, &val) < 0)
7360 return false;
7361 val |= 0x01U;
7362 if (ec_write(fan_select_offset, val) < 0)
7363 return false;
7364
7365 return true;
7366}
7367
7368/*
7369 * Call with fan_mutex held
7370 */
7371static void fan_update_desired_level(u8 status)
7372{
7373 if ((status &
7374 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7375 if (status > 7)
7376 fan_control_desired_level = 7;
7377 else
7378 fan_control_desired_level = status;
7379 }
7380}
7381
7382static int fan_get_status(u8 *status)
7383{
7384 u8 s;
7385
7386 /* TODO:
7387 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7388
7389 switch (fan_status_access_mode) {
7390 case TPACPI_FAN_RD_ACPI_GFAN:
7391 /* 570, 600e/x, 770e, 770x */
7392
7393 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
7394 return -EIO;
7395
7396 if (likely(status))
7397 *status = s & 0x07;
7398
7399 break;
7400
7401 case TPACPI_FAN_RD_TPEC:
7402 /* all except 570, 600e/x, 770e, 770x */
7403 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7404 return -EIO;
7405
7406 if (likely(status)) {
7407 *status = s;
7408 fan_quirk1_handle(status);
7409 }
7410
7411 break;
7412
7413 default:
7414 return -ENXIO;
7415 }
7416
7417 return 0;
7418}
7419
7420static int fan_get_status_safe(u8 *status)
7421{
7422 int rc;
7423 u8 s;
7424
7425 if (mutex_lock_killable(&fan_mutex))
7426 return -ERESTARTSYS;
7427 rc = fan_get_status(&s);
7428 if (!rc)
7429 fan_update_desired_level(s);
7430 mutex_unlock(&fan_mutex);
7431
7432 if (status)
7433 *status = s;
7434
7435 return rc;
7436}
7437
7438static int fan_get_speed(unsigned int *speed)
7439{
7440 u8 hi, lo;
7441
7442 switch (fan_status_access_mode) {
7443 case TPACPI_FAN_RD_TPEC:
7444 /* all except 570, 600e/x, 770e, 770x */
7445 if (unlikely(!fan_select_fan1()))
7446 return -EIO;
7447 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7448 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7449 return -EIO;
7450
7451 if (likely(speed))
7452 *speed = (hi << 8) | lo;
7453
7454 break;
7455
7456 default:
7457 return -ENXIO;
7458 }
7459
7460 return 0;
7461}
7462
7463static int fan2_get_speed(unsigned int *speed)
7464{
7465 u8 hi, lo;
7466 bool rc;
7467
7468 switch (fan_status_access_mode) {
7469 case TPACPI_FAN_RD_TPEC:
7470 /* all except 570, 600e/x, 770e, 770x */
7471 if (unlikely(!fan_select_fan2()))
7472 return -EIO;
7473 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
7474 !acpi_ec_read(fan_rpm_offset + 1, &hi);
7475 fan_select_fan1(); /* play it safe */
7476 if (rc)
7477 return -EIO;
7478
7479 if (likely(speed))
7480 *speed = (hi << 8) | lo;
7481
7482 break;
7483
7484 default:
7485 return -ENXIO;
7486 }
7487
7488 return 0;
7489}
7490
7491static int fan_set_level(int level)
7492{
7493 if (!fan_control_allowed)
7494 return -EPERM;
7495
7496 switch (fan_control_access_mode) {
7497 case TPACPI_FAN_WR_ACPI_SFAN:
7498 if (level >= 0 && level <= 7) {
7499 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
7500 return -EIO;
7501 } else
7502 return -EINVAL;
7503 break;
7504
7505 case TPACPI_FAN_WR_ACPI_FANS:
7506 case TPACPI_FAN_WR_TPEC:
7507 if (!(level & TP_EC_FAN_AUTO) &&
7508 !(level & TP_EC_FAN_FULLSPEED) &&
7509 ((level < 0) || (level > 7)))
7510 return -EINVAL;
7511
7512 /* safety net should the EC not support AUTO
7513 * or FULLSPEED mode bits and just ignore them */
7514 if (level & TP_EC_FAN_FULLSPEED)
7515 level |= 7; /* safety min speed 7 */
7516 else if (level & TP_EC_FAN_AUTO)
7517 level |= 4; /* safety min speed 4 */
7518
7519 if (!acpi_ec_write(fan_status_offset, level))
7520 return -EIO;
7521 else
7522 tp_features.fan_ctrl_status_undef = 0;
7523 break;
7524
7525 default:
7526 return -ENXIO;
7527 }
7528
7529 vdbg_printk(TPACPI_DBG_FAN,
7530 "fan control: set fan control register to 0x%02x\n", level);
7531 return 0;
7532}
7533
7534static int fan_set_level_safe(int level)
7535{
7536 int rc;
7537
7538 if (!fan_control_allowed)
7539 return -EPERM;
7540
7541 if (mutex_lock_killable(&fan_mutex))
7542 return -ERESTARTSYS;
7543
7544 if (level == TPACPI_FAN_LAST_LEVEL)
7545 level = fan_control_desired_level;
7546
7547 rc = fan_set_level(level);
7548 if (!rc)
7549 fan_update_desired_level(level);
7550
7551 mutex_unlock(&fan_mutex);
7552 return rc;
7553}
7554
7555static int fan_set_enable(void)
7556{
7557 u8 s;
7558 int rc;
7559
7560 if (!fan_control_allowed)
7561 return -EPERM;
7562
7563 if (mutex_lock_killable(&fan_mutex))
7564 return -ERESTARTSYS;
7565
7566 switch (fan_control_access_mode) {
7567 case TPACPI_FAN_WR_ACPI_FANS:
7568 case TPACPI_FAN_WR_TPEC:
7569 rc = fan_get_status(&s);
7570 if (rc < 0)
7571 break;
7572
7573 /* Don't go out of emergency fan mode */
7574 if (s != 7) {
7575 s &= 0x07;
7576 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
7577 }
7578
7579 if (!acpi_ec_write(fan_status_offset, s))
7580 rc = -EIO;
7581 else {
7582 tp_features.fan_ctrl_status_undef = 0;
7583 rc = 0;
7584 }
7585 break;
7586
7587 case TPACPI_FAN_WR_ACPI_SFAN:
7588 rc = fan_get_status(&s);
7589 if (rc < 0)
7590 break;
7591
7592 s &= 0x07;
7593
7594 /* Set fan to at least level 4 */
7595 s |= 4;
7596
7597 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
7598 rc = -EIO;
7599 else
7600 rc = 0;
7601 break;
7602
7603 default:
7604 rc = -ENXIO;
7605 }
7606
7607 mutex_unlock(&fan_mutex);
7608
7609 if (!rc)
7610 vdbg_printk(TPACPI_DBG_FAN,
7611 "fan control: set fan control register to 0x%02x\n",
7612 s);
7613 return rc;
7614}
7615
7616static int fan_set_disable(void)
7617{
7618 int rc;
7619
7620 if (!fan_control_allowed)
7621 return -EPERM;
7622
7623 if (mutex_lock_killable(&fan_mutex))
7624 return -ERESTARTSYS;
7625
7626 rc = 0;
7627 switch (fan_control_access_mode) {
7628 case TPACPI_FAN_WR_ACPI_FANS:
7629 case TPACPI_FAN_WR_TPEC:
7630 if (!acpi_ec_write(fan_status_offset, 0x00))
7631 rc = -EIO;
7632 else {
7633 fan_control_desired_level = 0;
7634 tp_features.fan_ctrl_status_undef = 0;
7635 }
7636 break;
7637
7638 case TPACPI_FAN_WR_ACPI_SFAN:
7639 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
7640 rc = -EIO;
7641 else
7642 fan_control_desired_level = 0;
7643 break;
7644
7645 default:
7646 rc = -ENXIO;
7647 }
7648
7649 if (!rc)
7650 vdbg_printk(TPACPI_DBG_FAN,
7651 "fan control: set fan control register to 0\n");
7652
7653 mutex_unlock(&fan_mutex);
7654 return rc;
7655}
7656
7657static int fan_set_speed(int speed)
7658{
7659 int rc;
7660
7661 if (!fan_control_allowed)
7662 return -EPERM;
7663
7664 if (mutex_lock_killable(&fan_mutex))
7665 return -ERESTARTSYS;
7666
7667 rc = 0;
7668 switch (fan_control_access_mode) {
7669 case TPACPI_FAN_WR_ACPI_FANS:
7670 if (speed >= 0 && speed <= 65535) {
7671 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
7672 speed, speed, speed))
7673 rc = -EIO;
7674 } else
7675 rc = -EINVAL;
7676 break;
7677
7678 default:
7679 rc = -ENXIO;
7680 }
7681
7682 mutex_unlock(&fan_mutex);
7683 return rc;
7684}
7685
7686static void fan_watchdog_reset(void)
7687{
7688 static int fan_watchdog_active;
7689
7690 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7691 return;
7692
7693 if (fan_watchdog_active)
7694 cancel_delayed_work(&fan_watchdog_task);
7695
7696 if (fan_watchdog_maxinterval > 0 &&
7697 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7698 fan_watchdog_active = 1;
7699 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7700 msecs_to_jiffies(fan_watchdog_maxinterval
7701 * 1000))) {
7702 pr_err("failed to queue the fan watchdog, "
7703 "watchdog will not trigger\n");
7704 }
7705 } else
7706 fan_watchdog_active = 0;
7707}
7708
7709static void fan_watchdog_fire(struct work_struct *ignored)
7710{
7711 int rc;
7712
7713 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7714 return;
7715
7716 pr_notice("fan watchdog: enabling fan\n");
7717 rc = fan_set_enable();
7718 if (rc < 0) {
7719 pr_err("fan watchdog: error %d while enabling fan, "
7720 "will try again later...\n", -rc);
7721 /* reschedule for later */
7722 fan_watchdog_reset();
7723 }
7724}
7725
7726/*
7727 * SYSFS fan layout: hwmon compatible (device)
7728 *
7729 * pwm*_enable:
7730 * 0: "disengaged" mode
7731 * 1: manual mode
7732 * 2: native EC "auto" mode (recommended, hardware default)
7733 *
7734 * pwm*: set speed in manual mode, ignored otherwise.
7735 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7736 * interpolation.
7737 *
7738 * fan*_input: tachometer reading, RPM
7739 *
7740 *
7741 * SYSFS fan layout: extensions
7742 *
7743 * fan_watchdog (driver):
7744 * fan watchdog interval in seconds, 0 disables (default), max 120
7745 */
7746
7747/* sysfs fan pwm1_enable ----------------------------------------------- */
7748static ssize_t fan_pwm1_enable_show(struct device *dev,
7749 struct device_attribute *attr,
7750 char *buf)
7751{
7752 int res, mode;
7753 u8 status;
7754
7755 res = fan_get_status_safe(&status);
7756 if (res)
7757 return res;
7758
7759 if (status & TP_EC_FAN_FULLSPEED) {
7760 mode = 0;
7761 } else if (status & TP_EC_FAN_AUTO) {
7762 mode = 2;
7763 } else
7764 mode = 1;
7765
7766 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7767}
7768
7769static ssize_t fan_pwm1_enable_store(struct device *dev,
7770 struct device_attribute *attr,
7771 const char *buf, size_t count)
7772{
7773 unsigned long t;
7774 int res, level;
7775
7776 if (parse_strtoul(buf, 2, &t))
7777 return -EINVAL;
7778
7779 tpacpi_disclose_usertask("hwmon pwm1_enable",
7780 "set fan mode to %lu\n", t);
7781
7782 switch (t) {
7783 case 0:
7784 level = TP_EC_FAN_FULLSPEED;
7785 break;
7786 case 1:
7787 level = TPACPI_FAN_LAST_LEVEL;
7788 break;
7789 case 2:
7790 level = TP_EC_FAN_AUTO;
7791 break;
7792 case 3:
7793 /* reserved for software-controlled auto mode */
7794 return -ENOSYS;
7795 default:
7796 return -EINVAL;
7797 }
7798
7799 res = fan_set_level_safe(level);
7800 if (res == -ENXIO)
7801 return -EINVAL;
7802 else if (res < 0)
7803 return res;
7804
7805 fan_watchdog_reset();
7806
7807 return count;
7808}
7809
7810static struct device_attribute dev_attr_fan_pwm1_enable =
7811 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7812 fan_pwm1_enable_show, fan_pwm1_enable_store);
7813
7814/* sysfs fan pwm1 ------------------------------------------------------ */
7815static ssize_t fan_pwm1_show(struct device *dev,
7816 struct device_attribute *attr,
7817 char *buf)
7818{
7819 int res;
7820 u8 status;
7821
7822 res = fan_get_status_safe(&status);
7823 if (res)
7824 return res;
7825
7826 if ((status &
7827 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7828 status = fan_control_desired_level;
7829
7830 if (status > 7)
7831 status = 7;
7832
7833 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7834}
7835
7836static ssize_t fan_pwm1_store(struct device *dev,
7837 struct device_attribute *attr,
7838 const char *buf, size_t count)
7839{
7840 unsigned long s;
7841 int rc;
7842 u8 status, newlevel;
7843
7844 if (parse_strtoul(buf, 255, &s))
7845 return -EINVAL;
7846
7847 tpacpi_disclose_usertask("hwmon pwm1",
7848 "set fan speed to %lu\n", s);
7849
7850 /* scale down from 0-255 to 0-7 */
7851 newlevel = (s >> 5) & 0x07;
7852
7853 if (mutex_lock_killable(&fan_mutex))
7854 return -ERESTARTSYS;
7855
7856 rc = fan_get_status(&status);
7857 if (!rc && (status &
7858 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7859 rc = fan_set_level(newlevel);
7860 if (rc == -ENXIO)
7861 rc = -EINVAL;
7862 else if (!rc) {
7863 fan_update_desired_level(newlevel);
7864 fan_watchdog_reset();
7865 }
7866 }
7867
7868 mutex_unlock(&fan_mutex);
7869 return (rc)? rc : count;
7870}
7871
7872static struct device_attribute dev_attr_fan_pwm1 =
7873 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7874 fan_pwm1_show, fan_pwm1_store);
7875
7876/* sysfs fan fan1_input ------------------------------------------------ */
7877static ssize_t fan_fan1_input_show(struct device *dev,
7878 struct device_attribute *attr,
7879 char *buf)
7880{
7881 int res;
7882 unsigned int speed;
7883
7884 res = fan_get_speed(&speed);
7885 if (res < 0)
7886 return res;
7887
7888 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7889}
7890
7891static struct device_attribute dev_attr_fan_fan1_input =
7892 __ATTR(fan1_input, S_IRUGO,
7893 fan_fan1_input_show, NULL);
7894
7895/* sysfs fan fan2_input ------------------------------------------------ */
7896static ssize_t fan_fan2_input_show(struct device *dev,
7897 struct device_attribute *attr,
7898 char *buf)
7899{
7900 int res;
7901 unsigned int speed;
7902
7903 res = fan2_get_speed(&speed);
7904 if (res < 0)
7905 return res;
7906
7907 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7908}
7909
7910static struct device_attribute dev_attr_fan_fan2_input =
7911 __ATTR(fan2_input, S_IRUGO,
7912 fan_fan2_input_show, NULL);
7913
7914/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7915static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7916 char *buf)
7917{
7918 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7919}
7920
7921static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7922 const char *buf, size_t count)
7923{
7924 unsigned long t;
7925
7926 if (parse_strtoul(buf, 120, &t))
7927 return -EINVAL;
7928
7929 if (!fan_control_allowed)
7930 return -EPERM;
7931
7932 fan_watchdog_maxinterval = t;
7933 fan_watchdog_reset();
7934
7935 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7936
7937 return count;
7938}
7939
7940static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7941 fan_fan_watchdog_show, fan_fan_watchdog_store);
7942
7943/* --------------------------------------------------------------------- */
7944static struct attribute *fan_attributes[] = {
7945 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7946 &dev_attr_fan_fan1_input.attr,
7947 NULL, /* for fan2_input */
7948 NULL
7949};
7950
7951static const struct attribute_group fan_attr_group = {
7952 .attrs = fan_attributes,
7953};
7954
7955#define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7956#define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7957
7958#define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7959 { .vendor = PCI_VENDOR_ID_IBM, \
7960 .bios = TPACPI_MATCH_ANY, \
7961 .ec = TPID(__id1, __id2), \
7962 .quirks = __quirks }
7963
7964#define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7965 { .vendor = PCI_VENDOR_ID_LENOVO, \
7966 .bios = TPACPI_MATCH_ANY, \
7967 .ec = TPID(__id1, __id2), \
7968 .quirks = __quirks }
7969
7970static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7971 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7972 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7973 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7974 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7975 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7976};
7977
7978#undef TPACPI_FAN_QL
7979#undef TPACPI_FAN_QI
7980
7981static int __init fan_init(struct ibm_init_struct *iibm)
7982{
7983 int rc;
7984 unsigned long quirks;
7985
7986 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7987 "initializing fan subdriver\n");
7988
7989 mutex_init(&fan_mutex);
7990 fan_status_access_mode = TPACPI_FAN_NONE;
7991 fan_control_access_mode = TPACPI_FAN_WR_NONE;
7992 fan_control_commands = 0;
7993 fan_watchdog_maxinterval = 0;
7994 tp_features.fan_ctrl_status_undef = 0;
7995 tp_features.second_fan = 0;
7996 fan_control_desired_level = 7;
7997
7998 if (tpacpi_is_ibm()) {
7999 TPACPI_ACPIHANDLE_INIT(fans);
8000 TPACPI_ACPIHANDLE_INIT(gfan);
8001 TPACPI_ACPIHANDLE_INIT(sfan);
8002 }
8003
8004 quirks = tpacpi_check_quirks(fan_quirk_table,
8005 ARRAY_SIZE(fan_quirk_table));
8006
8007 if (gfan_handle) {
8008 /* 570, 600e/x, 770e, 770x */
8009 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8010 } else {
8011 /* all other ThinkPads: note that even old-style
8012 * ThinkPad ECs supports the fan control register */
8013 if (likely(acpi_ec_read(fan_status_offset,
8014 &fan_control_initial_status))) {
8015 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8016 if (quirks & TPACPI_FAN_Q1)
8017 fan_quirk1_setup();
8018 if (quirks & TPACPI_FAN_2FAN) {
8019 tp_features.second_fan = 1;
8020 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8021 "secondary fan support enabled\n");
8022 }
8023 } else {
8024 pr_err("ThinkPad ACPI EC access misbehaving, "
8025 "fan status and control unavailable\n");
8026 return 1;
8027 }
8028 }
8029
8030 if (sfan_handle) {
8031 /* 570, 770x-JL */
8032 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8033 fan_control_commands |=
8034 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8035 } else {
8036 if (!gfan_handle) {
8037 /* gfan without sfan means no fan control */
8038 /* all other models implement TP EC 0x2f control */
8039
8040 if (fans_handle) {
8041 /* X31, X40, X41 */
8042 fan_control_access_mode =
8043 TPACPI_FAN_WR_ACPI_FANS;
8044 fan_control_commands |=
8045 TPACPI_FAN_CMD_SPEED |
8046 TPACPI_FAN_CMD_LEVEL |
8047 TPACPI_FAN_CMD_ENABLE;
8048 } else {
8049 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8050 fan_control_commands |=
8051 TPACPI_FAN_CMD_LEVEL |
8052 TPACPI_FAN_CMD_ENABLE;
8053 }
8054 }
8055 }
8056
8057 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8058 "fan is %s, modes %d, %d\n",
8059 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8060 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8061 fan_status_access_mode, fan_control_access_mode);
8062
8063 /* fan control master switch */
8064 if (!fan_control_allowed) {
8065 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8066 fan_control_commands = 0;
8067 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8068 "fan control features disabled by parameter\n");
8069 }
8070
8071 /* update fan_control_desired_level */
8072 if (fan_status_access_mode != TPACPI_FAN_NONE)
8073 fan_get_status_safe(NULL);
8074
8075 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8076 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8077 if (tp_features.second_fan) {
8078 /* attach second fan tachometer */
8079 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8080 &dev_attr_fan_fan2_input.attr;
8081 }
8082 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8083 &fan_attr_group);
8084 if (rc < 0)
8085 return rc;
8086
8087 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8088 &driver_attr_fan_watchdog);
8089 if (rc < 0) {
8090 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8091 &fan_attr_group);
8092 return rc;
8093 }
8094 return 0;
8095 } else
8096 return 1;
8097}
8098
8099static void fan_exit(void)
8100{
8101 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8102 "cancelling any pending fan watchdog tasks\n");
8103
8104 /* FIXME: can we really do this unconditionally? */
8105 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8106 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8107 &driver_attr_fan_watchdog);
8108
8109 cancel_delayed_work(&fan_watchdog_task);
8110 flush_workqueue(tpacpi_wq);
8111}
8112
8113static void fan_suspend(pm_message_t state)
8114{
8115 int rc;
8116
8117 if (!fan_control_allowed)
8118 return;
8119
8120 /* Store fan status in cache */
8121 fan_control_resume_level = 0;
8122 rc = fan_get_status_safe(&fan_control_resume_level);
8123 if (rc < 0)
8124 pr_notice("failed to read fan level for later "
8125 "restore during resume: %d\n", rc);
8126
8127 /* if it is undefined, don't attempt to restore it.
8128 * KEEP THIS LAST */
8129 if (tp_features.fan_ctrl_status_undef)
8130 fan_control_resume_level = 0;
8131}
8132
8133static void fan_resume(void)
8134{
8135 u8 current_level = 7;
8136 bool do_set = false;
8137 int rc;
8138
8139 /* DSDT *always* updates status on resume */
8140 tp_features.fan_ctrl_status_undef = 0;
8141
8142 if (!fan_control_allowed ||
8143 !fan_control_resume_level ||
8144 (fan_get_status_safe(¤t_level) < 0))
8145 return;
8146
8147 switch (fan_control_access_mode) {
8148 case TPACPI_FAN_WR_ACPI_SFAN:
8149 /* never decrease fan level */
8150 do_set = (fan_control_resume_level > current_level);
8151 break;
8152 case TPACPI_FAN_WR_ACPI_FANS:
8153 case TPACPI_FAN_WR_TPEC:
8154 /* never decrease fan level, scale is:
8155 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8156 *
8157 * We expect the firmware to set either 7 or AUTO, but we
8158 * handle FULLSPEED out of paranoia.
8159 *
8160 * So, we can safely only restore FULLSPEED or 7, anything
8161 * else could slow the fan. Restoring AUTO is useless, at
8162 * best that's exactly what the DSDT already set (it is the
8163 * slower it uses).
8164 *
8165 * Always keep in mind that the DSDT *will* have set the
8166 * fans to what the vendor supposes is the best level. We
8167 * muck with it only to speed the fan up.
8168 */
8169 if (fan_control_resume_level != 7 &&
8170 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8171 return;
8172 else
8173 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8174 (current_level != fan_control_resume_level);
8175 break;
8176 default:
8177 return;
8178 }
8179 if (do_set) {
8180 pr_notice("restoring fan level to 0x%02x\n",
8181 fan_control_resume_level);
8182 rc = fan_set_level_safe(fan_control_resume_level);
8183 if (rc < 0)
8184 pr_notice("failed to restore fan level: %d\n", rc);
8185 }
8186}
8187
8188static int fan_read(struct seq_file *m)
8189{
8190 int rc;
8191 u8 status;
8192 unsigned int speed = 0;
8193
8194 switch (fan_status_access_mode) {
8195 case TPACPI_FAN_RD_ACPI_GFAN:
8196 /* 570, 600e/x, 770e, 770x */
8197 rc = fan_get_status_safe(&status);
8198 if (rc < 0)
8199 return rc;
8200
8201 seq_printf(m, "status:\t\t%s\n"
8202 "level:\t\t%d\n",
8203 (status != 0) ? "enabled" : "disabled", status);
8204 break;
8205
8206 case TPACPI_FAN_RD_TPEC:
8207 /* all except 570, 600e/x, 770e, 770x */
8208 rc = fan_get_status_safe(&status);
8209 if (rc < 0)
8210 return rc;
8211
8212 seq_printf(m, "status:\t\t%s\n",
8213 (status != 0) ? "enabled" : "disabled");
8214
8215 rc = fan_get_speed(&speed);
8216 if (rc < 0)
8217 return rc;
8218
8219 seq_printf(m, "speed:\t\t%d\n", speed);
8220
8221 if (status & TP_EC_FAN_FULLSPEED)
8222 /* Disengaged mode takes precedence */
8223 seq_printf(m, "level:\t\tdisengaged\n");
8224 else if (status & TP_EC_FAN_AUTO)
8225 seq_printf(m, "level:\t\tauto\n");
8226 else
8227 seq_printf(m, "level:\t\t%d\n", status);
8228 break;
8229
8230 case TPACPI_FAN_NONE:
8231 default:
8232 seq_printf(m, "status:\t\tnot supported\n");
8233 }
8234
8235 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8236 seq_printf(m, "commands:\tlevel <level>");
8237
8238 switch (fan_control_access_mode) {
8239 case TPACPI_FAN_WR_ACPI_SFAN:
8240 seq_printf(m, " (<level> is 0-7)\n");
8241 break;
8242
8243 default:
8244 seq_printf(m, " (<level> is 0-7, "
8245 "auto, disengaged, full-speed)\n");
8246 break;
8247 }
8248 }
8249
8250 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8251 seq_printf(m, "commands:\tenable, disable\n"
8252 "commands:\twatchdog <timeout> (<timeout> "
8253 "is 0 (off), 1-120 (seconds))\n");
8254
8255 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8256 seq_printf(m, "commands:\tspeed <speed>"
8257 " (<speed> is 0-65535)\n");
8258
8259 return 0;
8260}
8261
8262static int fan_write_cmd_level(const char *cmd, int *rc)
8263{
8264 int level;
8265
8266 if (strlencmp(cmd, "level auto") == 0)
8267 level = TP_EC_FAN_AUTO;
8268 else if ((strlencmp(cmd, "level disengaged") == 0) |
8269 (strlencmp(cmd, "level full-speed") == 0))
8270 level = TP_EC_FAN_FULLSPEED;
8271 else if (sscanf(cmd, "level %d", &level) != 1)
8272 return 0;
8273
8274 *rc = fan_set_level_safe(level);
8275 if (*rc == -ENXIO)
8276 pr_err("level command accepted for unsupported access mode %d\n",
8277 fan_control_access_mode);
8278 else if (!*rc)
8279 tpacpi_disclose_usertask("procfs fan",
8280 "set level to %d\n", level);
8281
8282 return 1;
8283}
8284
8285static int fan_write_cmd_enable(const char *cmd, int *rc)
8286{
8287 if (strlencmp(cmd, "enable") != 0)
8288 return 0;
8289
8290 *rc = fan_set_enable();
8291 if (*rc == -ENXIO)
8292 pr_err("enable command accepted for unsupported access mode %d\n",
8293 fan_control_access_mode);
8294 else if (!*rc)
8295 tpacpi_disclose_usertask("procfs fan", "enable\n");
8296
8297 return 1;
8298}
8299
8300static int fan_write_cmd_disable(const char *cmd, int *rc)
8301{
8302 if (strlencmp(cmd, "disable") != 0)
8303 return 0;
8304
8305 *rc = fan_set_disable();
8306 if (*rc == -ENXIO)
8307 pr_err("disable command accepted for unsupported access mode %d\n",
8308 fan_control_access_mode);
8309 else if (!*rc)
8310 tpacpi_disclose_usertask("procfs fan", "disable\n");
8311
8312 return 1;
8313}
8314
8315static int fan_write_cmd_speed(const char *cmd, int *rc)
8316{
8317 int speed;
8318
8319 /* TODO:
8320 * Support speed <low> <medium> <high> ? */
8321
8322 if (sscanf(cmd, "speed %d", &speed) != 1)
8323 return 0;
8324
8325 *rc = fan_set_speed(speed);
8326 if (*rc == -ENXIO)
8327 pr_err("speed command accepted for unsupported access mode %d\n",
8328 fan_control_access_mode);
8329 else if (!*rc)
8330 tpacpi_disclose_usertask("procfs fan",
8331 "set speed to %d\n", speed);
8332
8333 return 1;
8334}
8335
8336static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8337{
8338 int interval;
8339
8340 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8341 return 0;
8342
8343 if (interval < 0 || interval > 120)
8344 *rc = -EINVAL;
8345 else {
8346 fan_watchdog_maxinterval = interval;
8347 tpacpi_disclose_usertask("procfs fan",
8348 "set watchdog timer to %d\n",
8349 interval);
8350 }
8351
8352 return 1;
8353}
8354
8355static int fan_write(char *buf)
8356{
8357 char *cmd;
8358 int rc = 0;
8359
8360 while (!rc && (cmd = next_cmd(&buf))) {
8361 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8362 fan_write_cmd_level(cmd, &rc)) &&
8363 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8364 (fan_write_cmd_enable(cmd, &rc) ||
8365 fan_write_cmd_disable(cmd, &rc) ||
8366 fan_write_cmd_watchdog(cmd, &rc))) &&
8367 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8368 fan_write_cmd_speed(cmd, &rc))
8369 )
8370 rc = -EINVAL;
8371 else if (!rc)
8372 fan_watchdog_reset();
8373 }
8374
8375 return rc;
8376}
8377
8378static struct ibm_struct fan_driver_data = {
8379 .name = "fan",
8380 .read = fan_read,
8381 .write = fan_write,
8382 .exit = fan_exit,
8383 .suspend = fan_suspend,
8384 .resume = fan_resume,
8385};
8386
8387/****************************************************************************
8388 ****************************************************************************
8389 *
8390 * Infrastructure
8391 *
8392 ****************************************************************************
8393 ****************************************************************************/
8394
8395/*
8396 * HKEY event callout for other subdrivers go here
8397 * (yes, it is ugly, but it is quick, safe, and gets the job done
8398 */
8399static void tpacpi_driver_event(const unsigned int hkey_event)
8400{
8401 if (ibm_backlight_device) {
8402 switch (hkey_event) {
8403 case TP_HKEY_EV_BRGHT_UP:
8404 case TP_HKEY_EV_BRGHT_DOWN:
8405 tpacpi_brightness_notify_change();
8406 }
8407 }
8408 if (alsa_card) {
8409 switch (hkey_event) {
8410 case TP_HKEY_EV_VOL_UP:
8411 case TP_HKEY_EV_VOL_DOWN:
8412 case TP_HKEY_EV_VOL_MUTE:
8413 volume_alsa_notify_change();
8414 }
8415 }
8416}
8417
8418static void hotkey_driver_event(const unsigned int scancode)
8419{
8420 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
8421}
8422
8423/* sysfs name ---------------------------------------------------------- */
8424static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
8425 struct device_attribute *attr,
8426 char *buf)
8427{
8428 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
8429}
8430
8431static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
8432 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
8433
8434/* --------------------------------------------------------------------- */
8435
8436/* /proc support */
8437static struct proc_dir_entry *proc_dir;
8438
8439/*
8440 * Module and infrastructure proble, init and exit handling
8441 */
8442
8443static int force_load;
8444
8445#ifdef CONFIG_THINKPAD_ACPI_DEBUG
8446static const char * __init str_supported(int is_supported)
8447{
8448 static char text_unsupported[] __initdata = "not supported";
8449
8450 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
8451}
8452#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
8453
8454static void ibm_exit(struct ibm_struct *ibm)
8455{
8456 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
8457
8458 list_del_init(&ibm->all_drivers);
8459
8460 if (ibm->flags.acpi_notify_installed) {
8461 dbg_printk(TPACPI_DBG_EXIT,
8462 "%s: acpi_remove_notify_handler\n", ibm->name);
8463 BUG_ON(!ibm->acpi);
8464 acpi_remove_notify_handler(*ibm->acpi->handle,
8465 ibm->acpi->type,
8466 dispatch_acpi_notify);
8467 ibm->flags.acpi_notify_installed = 0;
8468 }
8469
8470 if (ibm->flags.proc_created) {
8471 dbg_printk(TPACPI_DBG_EXIT,
8472 "%s: remove_proc_entry\n", ibm->name);
8473 remove_proc_entry(ibm->name, proc_dir);
8474 ibm->flags.proc_created = 0;
8475 }
8476
8477 if (ibm->flags.acpi_driver_registered) {
8478 dbg_printk(TPACPI_DBG_EXIT,
8479 "%s: acpi_bus_unregister_driver\n", ibm->name);
8480 BUG_ON(!ibm->acpi);
8481 acpi_bus_unregister_driver(ibm->acpi->driver);
8482 kfree(ibm->acpi->driver);
8483 ibm->acpi->driver = NULL;
8484 ibm->flags.acpi_driver_registered = 0;
8485 }
8486
8487 if (ibm->flags.init_called && ibm->exit) {
8488 ibm->exit();
8489 ibm->flags.init_called = 0;
8490 }
8491
8492 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
8493}
8494
8495static int __init ibm_init(struct ibm_init_struct *iibm)
8496{
8497 int ret;
8498 struct ibm_struct *ibm = iibm->data;
8499 struct proc_dir_entry *entry;
8500
8501 BUG_ON(ibm == NULL);
8502
8503 INIT_LIST_HEAD(&ibm->all_drivers);
8504
8505 if (ibm->flags.experimental && !experimental)
8506 return 0;
8507
8508 dbg_printk(TPACPI_DBG_INIT,
8509 "probing for %s\n", ibm->name);
8510
8511 if (iibm->init) {
8512 ret = iibm->init(iibm);
8513 if (ret > 0)
8514 return 0; /* probe failed */
8515 if (ret)
8516 return ret;
8517
8518 ibm->flags.init_called = 1;
8519 }
8520
8521 if (ibm->acpi) {
8522 if (ibm->acpi->hid) {
8523 ret = register_tpacpi_subdriver(ibm);
8524 if (ret)
8525 goto err_out;
8526 }
8527
8528 if (ibm->acpi->notify) {
8529 ret = setup_acpi_notify(ibm);
8530 if (ret == -ENODEV) {
8531 pr_notice("disabling subdriver %s\n",
8532 ibm->name);
8533 ret = 0;
8534 goto err_out;
8535 }
8536 if (ret < 0)
8537 goto err_out;
8538 }
8539 }
8540
8541 dbg_printk(TPACPI_DBG_INIT,
8542 "%s installed\n", ibm->name);
8543
8544 if (ibm->read) {
8545 mode_t mode = iibm->base_procfs_mode;
8546
8547 if (!mode)
8548 mode = S_IRUGO;
8549 if (ibm->write)
8550 mode |= S_IWUSR;
8551 entry = proc_create_data(ibm->name, mode, proc_dir,
8552 &dispatch_proc_fops, ibm);
8553 if (!entry) {
8554 pr_err("unable to create proc entry %s\n", ibm->name);
8555 ret = -ENODEV;
8556 goto err_out;
8557 }
8558 ibm->flags.proc_created = 1;
8559 }
8560
8561 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
8562
8563 return 0;
8564
8565err_out:
8566 dbg_printk(TPACPI_DBG_INIT,
8567 "%s: at error exit path with result %d\n",
8568 ibm->name, ret);
8569
8570 ibm_exit(ibm);
8571 return (ret < 0)? ret : 0;
8572}
8573
8574/* Probing */
8575
8576static bool __pure __init tpacpi_is_fw_digit(const char c)
8577{
8578 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
8579}
8580
8581/* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
8582static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
8583 const char t)
8584{
8585 return s && strlen(s) >= 8 &&
8586 tpacpi_is_fw_digit(s[0]) &&
8587 tpacpi_is_fw_digit(s[1]) &&
8588 s[2] == t && s[3] == 'T' &&
8589 tpacpi_is_fw_digit(s[4]) &&
8590 tpacpi_is_fw_digit(s[5]);
8591}
8592
8593/* returns 0 - probe ok, or < 0 - probe error.
8594 * Probe ok doesn't mean thinkpad found.
8595 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
8596static int __must_check __init get_thinkpad_model_data(
8597 struct thinkpad_id_data *tp)
8598{
8599 const struct dmi_device *dev = NULL;
8600 char ec_fw_string[18];
8601 char const *s;
8602
8603 if (!tp)
8604 return -EINVAL;
8605
8606 memset(tp, 0, sizeof(*tp));
8607
8608 if (dmi_name_in_vendors("IBM"))
8609 tp->vendor = PCI_VENDOR_ID_IBM;
8610 else if (dmi_name_in_vendors("LENOVO"))
8611 tp->vendor = PCI_VENDOR_ID_LENOVO;
8612 else
8613 return 0;
8614
8615 s = dmi_get_system_info(DMI_BIOS_VERSION);
8616 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
8617 if (s && !tp->bios_version_str)
8618 return -ENOMEM;
8619
8620 /* Really ancient ThinkPad 240X will fail this, which is fine */
8621 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
8622 return 0;
8623
8624 tp->bios_model = tp->bios_version_str[0]
8625 | (tp->bios_version_str[1] << 8);
8626 tp->bios_release = (tp->bios_version_str[4] << 8)
8627 | tp->bios_version_str[5];
8628
8629 /*
8630 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
8631 * X32 or newer, all Z series; Some models must have an
8632 * up-to-date BIOS or they will not be detected.
8633 *
8634 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8635 */
8636 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
8637 if (sscanf(dev->name,
8638 "IBM ThinkPad Embedded Controller -[%17c",
8639 ec_fw_string) == 1) {
8640 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
8641 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
8642
8643 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
8644 if (!tp->ec_version_str)
8645 return -ENOMEM;
8646
8647 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
8648 tp->ec_model = ec_fw_string[0]
8649 | (ec_fw_string[1] << 8);
8650 tp->ec_release = (ec_fw_string[4] << 8)
8651 | ec_fw_string[5];
8652 } else {
8653 pr_notice("ThinkPad firmware release %s "
8654 "doesn't match the known patterns\n",
8655 ec_fw_string);
8656 pr_notice("please report this to %s\n",
8657 TPACPI_MAIL);
8658 }
8659 break;
8660 }
8661 }
8662
8663 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
8664 if (s && !strnicmp(s, "ThinkPad", 8)) {
8665 tp->model_str = kstrdup(s, GFP_KERNEL);
8666 if (!tp->model_str)
8667 return -ENOMEM;
8668 }
8669
8670 s = dmi_get_system_info(DMI_PRODUCT_NAME);
8671 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
8672 if (s && !tp->nummodel_str)
8673 return -ENOMEM;
8674
8675 return 0;
8676}
8677
8678static int __init probe_for_thinkpad(void)
8679{
8680 int is_thinkpad;
8681
8682 if (acpi_disabled)
8683 return -ENODEV;
8684
8685 /* It would be dangerous to run the driver in this case */
8686 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
8687 return -ENODEV;
8688
8689 /*
8690 * Non-ancient models have better DMI tagging, but very old models
8691 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
8692 */
8693 is_thinkpad = (thinkpad_id.model_str != NULL) ||
8694 (thinkpad_id.ec_model != 0) ||
8695 tpacpi_is_fw_known();
8696
8697 /* The EC handler is required */
8698 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
8699 if (!ec_handle) {
8700 if (is_thinkpad)
8701 pr_err("Not yet supported ThinkPad detected!\n");
8702 return -ENODEV;
8703 }
8704
8705 if (!is_thinkpad && !force_load)
8706 return -ENODEV;
8707
8708 return 0;
8709}
8710
8711static void __init thinkpad_acpi_init_banner(void)
8712{
8713 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
8714 pr_info("%s\n", TPACPI_URL);
8715
8716 pr_info("ThinkPad BIOS %s, EC %s\n",
8717 (thinkpad_id.bios_version_str) ?
8718 thinkpad_id.bios_version_str : "unknown",
8719 (thinkpad_id.ec_version_str) ?
8720 thinkpad_id.ec_version_str : "unknown");
8721
8722 BUG_ON(!thinkpad_id.vendor);
8723
8724 if (thinkpad_id.model_str)
8725 pr_info("%s %s, model %s\n",
8726 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
8727 "IBM" : ((thinkpad_id.vendor ==
8728 PCI_VENDOR_ID_LENOVO) ?
8729 "Lenovo" : "Unknown vendor"),
8730 thinkpad_id.model_str,
8731 (thinkpad_id.nummodel_str) ?
8732 thinkpad_id.nummodel_str : "unknown");
8733}
8734
8735/* Module init, exit, parameters */
8736
8737static struct ibm_init_struct ibms_init[] __initdata = {
8738 {
8739 .data = &thinkpad_acpi_driver_data,
8740 },
8741 {
8742 .init = hotkey_init,
8743 .data = &hotkey_driver_data,
8744 },
8745 {
8746 .init = bluetooth_init,
8747 .data = &bluetooth_driver_data,
8748 },
8749 {
8750 .init = wan_init,
8751 .data = &wan_driver_data,
8752 },
8753 {
8754 .init = uwb_init,
8755 .data = &uwb_driver_data,
8756 },
8757#ifdef CONFIG_THINKPAD_ACPI_VIDEO
8758 {
8759 .init = video_init,
8760 .base_procfs_mode = S_IRUSR,
8761 .data = &video_driver_data,
8762 },
8763#endif
8764 {
8765 .init = light_init,
8766 .data = &light_driver_data,
8767 },
8768 {
8769 .init = cmos_init,
8770 .data = &cmos_driver_data,
8771 },
8772 {
8773 .init = led_init,
8774 .data = &led_driver_data,
8775 },
8776 {
8777 .init = beep_init,
8778 .data = &beep_driver_data,
8779 },
8780 {
8781 .init = thermal_init,
8782 .data = &thermal_driver_data,
8783 },
8784 {
8785 .init = brightness_init,
8786 .data = &brightness_driver_data,
8787 },
8788 {
8789 .init = volume_init,
8790 .data = &volume_driver_data,
8791 },
8792 {
8793 .init = fan_init,
8794 .data = &fan_driver_data,
8795 },
8796};
8797
8798static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8799{
8800 unsigned int i;
8801 struct ibm_struct *ibm;
8802
8803 if (!kp || !kp->name || !val)
8804 return -EINVAL;
8805
8806 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8807 ibm = ibms_init[i].data;
8808 WARN_ON(ibm == NULL);
8809
8810 if (!ibm || !ibm->name)
8811 continue;
8812
8813 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8814 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8815 return -ENOSPC;
8816 strcpy(ibms_init[i].param, val);
8817 strcat(ibms_init[i].param, ",");
8818 return 0;
8819 }
8820 }
8821
8822 return -EINVAL;
8823}
8824
8825module_param(experimental, int, 0444);
8826MODULE_PARM_DESC(experimental,
8827 "Enables experimental features when non-zero");
8828
8829module_param_named(debug, dbg_level, uint, 0);
8830MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8831
8832module_param(force_load, bool, 0444);
8833MODULE_PARM_DESC(force_load,
8834 "Attempts to load the driver even on a "
8835 "mis-identified ThinkPad when true");
8836
8837module_param_named(fan_control, fan_control_allowed, bool, 0444);
8838MODULE_PARM_DESC(fan_control,
8839 "Enables setting fan parameters features when true");
8840
8841module_param_named(brightness_mode, brightness_mode, uint, 0444);
8842MODULE_PARM_DESC(brightness_mode,
8843 "Selects brightness control strategy: "
8844 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8845
8846module_param(brightness_enable, uint, 0444);
8847MODULE_PARM_DESC(brightness_enable,
8848 "Enables backlight control when 1, disables when 0");
8849
8850module_param(hotkey_report_mode, uint, 0444);
8851MODULE_PARM_DESC(hotkey_report_mode,
8852 "used for backwards compatibility with userspace, "
8853 "see documentation");
8854
8855#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
8856module_param_named(volume_mode, volume_mode, uint, 0444);
8857MODULE_PARM_DESC(volume_mode,
8858 "Selects volume control strategy: "
8859 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
8860
8861module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
8862MODULE_PARM_DESC(volume_capabilities,
8863 "Selects the mixer capabilites: "
8864 "0=auto, 1=volume and mute, 2=mute only");
8865
8866module_param_named(volume_control, volume_control_allowed, bool, 0444);
8867MODULE_PARM_DESC(volume_control,
8868 "Enables software override for the console audio "
8869 "control when true");
8870
8871/* ALSA module API parameters */
8872module_param_named(index, alsa_index, int, 0444);
8873MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
8874module_param_named(id, alsa_id, charp, 0444);
8875MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
8876module_param_named(enable, alsa_enable, bool, 0444);
8877MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
8878#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
8879
8880#define TPACPI_PARAM(feature) \
8881 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8882 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8883 "at module load, see documentation")
8884
8885TPACPI_PARAM(hotkey);
8886TPACPI_PARAM(bluetooth);
8887TPACPI_PARAM(video);
8888TPACPI_PARAM(light);
8889TPACPI_PARAM(cmos);
8890TPACPI_PARAM(led);
8891TPACPI_PARAM(beep);
8892TPACPI_PARAM(brightness);
8893TPACPI_PARAM(volume);
8894TPACPI_PARAM(fan);
8895
8896#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8897module_param(dbg_wlswemul, uint, 0444);
8898MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8899module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8900MODULE_PARM_DESC(wlsw_state,
8901 "Initial state of the emulated WLSW switch");
8902
8903module_param(dbg_bluetoothemul, uint, 0444);
8904MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8905module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8906MODULE_PARM_DESC(bluetooth_state,
8907 "Initial state of the emulated bluetooth switch");
8908
8909module_param(dbg_wwanemul, uint, 0444);
8910MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8911module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8912MODULE_PARM_DESC(wwan_state,
8913 "Initial state of the emulated WWAN switch");
8914
8915module_param(dbg_uwbemul, uint, 0444);
8916MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8917module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8918MODULE_PARM_DESC(uwb_state,
8919 "Initial state of the emulated UWB switch");
8920#endif
8921
8922static void thinkpad_acpi_module_exit(void)
8923{
8924 struct ibm_struct *ibm, *itmp;
8925
8926 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8927
8928 list_for_each_entry_safe_reverse(ibm, itmp,
8929 &tpacpi_all_drivers,
8930 all_drivers) {
8931 ibm_exit(ibm);
8932 }
8933
8934 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8935
8936 if (tpacpi_inputdev) {
8937 if (tp_features.input_device_registered)
8938 input_unregister_device(tpacpi_inputdev);
8939 else
8940 input_free_device(tpacpi_inputdev);
8941 }
8942
8943 if (tpacpi_hwmon)
8944 hwmon_device_unregister(tpacpi_hwmon);
8945
8946 if (tp_features.sensors_pdev_attrs_registered)
8947 device_remove_file(&tpacpi_sensors_pdev->dev,
8948 &dev_attr_thinkpad_acpi_pdev_name);
8949 if (tpacpi_sensors_pdev)
8950 platform_device_unregister(tpacpi_sensors_pdev);
8951 if (tpacpi_pdev)
8952 platform_device_unregister(tpacpi_pdev);
8953
8954 if (tp_features.sensors_pdrv_attrs_registered)
8955 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8956 if (tp_features.platform_drv_attrs_registered)
8957 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8958
8959 if (tp_features.sensors_pdrv_registered)
8960 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8961
8962 if (tp_features.platform_drv_registered)
8963 platform_driver_unregister(&tpacpi_pdriver);
8964
8965 if (proc_dir)
8966 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8967
8968 if (tpacpi_wq)
8969 destroy_workqueue(tpacpi_wq);
8970
8971 kfree(thinkpad_id.bios_version_str);
8972 kfree(thinkpad_id.ec_version_str);
8973 kfree(thinkpad_id.model_str);
8974}
8975
8976
8977static int __init thinkpad_acpi_module_init(void)
8978{
8979 int ret, i;
8980
8981 tpacpi_lifecycle = TPACPI_LIFE_INIT;
8982
8983 /* Parameter checking */
8984 if (hotkey_report_mode > 2)
8985 return -EINVAL;
8986
8987 /* Driver-level probe */
8988
8989 ret = get_thinkpad_model_data(&thinkpad_id);
8990 if (ret) {
8991 pr_err("unable to get DMI data: %d\n", ret);
8992 thinkpad_acpi_module_exit();
8993 return ret;
8994 }
8995 ret = probe_for_thinkpad();
8996 if (ret) {
8997 thinkpad_acpi_module_exit();
8998 return ret;
8999 }
9000
9001 /* Driver initialization */
9002
9003 thinkpad_acpi_init_banner();
9004 tpacpi_check_outdated_fw();
9005
9006 TPACPI_ACPIHANDLE_INIT(ecrd);
9007 TPACPI_ACPIHANDLE_INIT(ecwr);
9008
9009 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9010 if (!tpacpi_wq) {
9011 thinkpad_acpi_module_exit();
9012 return -ENOMEM;
9013 }
9014
9015 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9016 if (!proc_dir) {
9017 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
9018 thinkpad_acpi_module_exit();
9019 return -ENODEV;
9020 }
9021
9022 ret = platform_driver_register(&tpacpi_pdriver);
9023 if (ret) {
9024 pr_err("unable to register main platform driver\n");
9025 thinkpad_acpi_module_exit();
9026 return ret;
9027 }
9028 tp_features.platform_drv_registered = 1;
9029
9030 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9031 if (ret) {
9032 pr_err("unable to register hwmon platform driver\n");
9033 thinkpad_acpi_module_exit();
9034 return ret;
9035 }
9036 tp_features.sensors_pdrv_registered = 1;
9037
9038 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9039 if (!ret) {
9040 tp_features.platform_drv_attrs_registered = 1;
9041 ret = tpacpi_create_driver_attributes(
9042 &tpacpi_hwmon_pdriver.driver);
9043 }
9044 if (ret) {
9045 pr_err("unable to create sysfs driver attributes\n");
9046 thinkpad_acpi_module_exit();
9047 return ret;
9048 }
9049 tp_features.sensors_pdrv_attrs_registered = 1;
9050
9051
9052 /* Device initialization */
9053 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9054 NULL, 0);
9055 if (IS_ERR(tpacpi_pdev)) {
9056 ret = PTR_ERR(tpacpi_pdev);
9057 tpacpi_pdev = NULL;
9058 pr_err("unable to register platform device\n");
9059 thinkpad_acpi_module_exit();
9060 return ret;
9061 }
9062 tpacpi_sensors_pdev = platform_device_register_simple(
9063 TPACPI_HWMON_DRVR_NAME,
9064 -1, NULL, 0);
9065 if (IS_ERR(tpacpi_sensors_pdev)) {
9066 ret = PTR_ERR(tpacpi_sensors_pdev);
9067 tpacpi_sensors_pdev = NULL;
9068 pr_err("unable to register hwmon platform device\n");
9069 thinkpad_acpi_module_exit();
9070 return ret;
9071 }
9072 ret = device_create_file(&tpacpi_sensors_pdev->dev,
9073 &dev_attr_thinkpad_acpi_pdev_name);
9074 if (ret) {
9075 pr_err("unable to create sysfs hwmon device attributes\n");
9076 thinkpad_acpi_module_exit();
9077 return ret;
9078 }
9079 tp_features.sensors_pdev_attrs_registered = 1;
9080 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9081 if (IS_ERR(tpacpi_hwmon)) {
9082 ret = PTR_ERR(tpacpi_hwmon);
9083 tpacpi_hwmon = NULL;
9084 pr_err("unable to register hwmon device\n");
9085 thinkpad_acpi_module_exit();
9086 return ret;
9087 }
9088 mutex_init(&tpacpi_inputdev_send_mutex);
9089 tpacpi_inputdev = input_allocate_device();
9090 if (!tpacpi_inputdev) {
9091 pr_err("unable to allocate input device\n");
9092 thinkpad_acpi_module_exit();
9093 return -ENOMEM;
9094 } else {
9095 /* Prepare input device, but don't register */
9096 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9097 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9098 tpacpi_inputdev->id.bustype = BUS_HOST;
9099 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9100 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9101 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9102 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9103 }
9104
9105 /* Init subdriver dependencies */
9106 tpacpi_detect_brightness_capabilities();
9107
9108 /* Init subdrivers */
9109 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9110 ret = ibm_init(&ibms_init[i]);
9111 if (ret >= 0 && *ibms_init[i].param)
9112 ret = ibms_init[i].data->write(ibms_init[i].param);
9113 if (ret < 0) {
9114 thinkpad_acpi_module_exit();
9115 return ret;
9116 }
9117 }
9118
9119 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9120
9121 ret = input_register_device(tpacpi_inputdev);
9122 if (ret < 0) {
9123 pr_err("unable to register input device\n");
9124 thinkpad_acpi_module_exit();
9125 return ret;
9126 } else {
9127 tp_features.input_device_registered = 1;
9128 }
9129
9130 return 0;
9131}
9132
9133MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9134
9135/*
9136 * This will autoload the driver in almost every ThinkPad
9137 * in widespread use.
9138 *
9139 * Only _VERY_ old models, like the 240, 240x and 570 lack
9140 * the HKEY event interface.
9141 */
9142MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9143
9144/*
9145 * DMI matching for module autoloading
9146 *
9147 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9148 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9149 *
9150 * Only models listed in thinkwiki will be supported, so add yours
9151 * if it is not there yet.
9152 */
9153#define IBM_BIOS_MODULE_ALIAS(__type) \
9154 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9155
9156/* Ancient thinkpad BIOSes have to be identified by
9157 * BIOS type or model number, and there are far less
9158 * BIOS types than model numbers... */
9159IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9160
9161MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9162MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9163MODULE_DESCRIPTION(TPACPI_DESC);
9164MODULE_VERSION(TPACPI_VERSION);
9165MODULE_LICENSE("GPL");
9166
9167module_init(thinkpad_acpi_module_init);
9168module_exit(thinkpad_acpi_module_exit);
1/*
2 * thinkpad_acpi.c - ThinkPad ACPI Extras
3 *
4 *
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301, USA.
22 */
23
24#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25
26#define TPACPI_VERSION "0.26"
27#define TPACPI_SYSFS_VERSION 0x030000
28
29/*
30 * Changelog:
31 * 2007-10-20 changelog trimmed down
32 *
33 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
34 * drivers/misc.
35 *
36 * 2006-11-22 0.13 new maintainer
37 * changelog now lives in git commit history, and will
38 * not be updated further in-file.
39 *
40 * 2005-03-17 0.11 support for 600e, 770x
41 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
42 *
43 * 2005-01-16 0.9 use MODULE_VERSION
44 * thanks to Henrik Brix Andersen <brix@gentoo.org>
45 * fix parameter passing on module loading
46 * thanks to Rusty Russell <rusty@rustcorp.com.au>
47 * thanks to Jim Radford <radford@blackbean.org>
48 * 2004-11-08 0.8 fix init error case, don't return from a macro
49 * thanks to Chris Wright <chrisw@osdl.org>
50 */
51
52#include <linux/kernel.h>
53#include <linux/module.h>
54#include <linux/init.h>
55#include <linux/types.h>
56#include <linux/string.h>
57#include <linux/list.h>
58#include <linux/mutex.h>
59#include <linux/sched.h>
60#include <linux/kthread.h>
61#include <linux/freezer.h>
62#include <linux/delay.h>
63#include <linux/slab.h>
64#include <linux/nvram.h>
65#include <linux/proc_fs.h>
66#include <linux/seq_file.h>
67#include <linux/sysfs.h>
68#include <linux/backlight.h>
69#include <linux/bitops.h>
70#include <linux/fb.h>
71#include <linux/platform_device.h>
72#include <linux/hwmon.h>
73#include <linux/hwmon-sysfs.h>
74#include <linux/input.h>
75#include <linux/leds.h>
76#include <linux/rfkill.h>
77#include <linux/dmi.h>
78#include <linux/jiffies.h>
79#include <linux/workqueue.h>
80#include <linux/acpi.h>
81#include <linux/pci_ids.h>
82#include <linux/power_supply.h>
83#include <linux/thinkpad_acpi.h>
84#include <sound/core.h>
85#include <sound/control.h>
86#include <sound/initval.h>
87#include <linux/uaccess.h>
88#include <acpi/battery.h>
89#include <acpi/video.h>
90
91/* ThinkPad CMOS commands */
92#define TP_CMOS_VOLUME_DOWN 0
93#define TP_CMOS_VOLUME_UP 1
94#define TP_CMOS_VOLUME_MUTE 2
95#define TP_CMOS_BRIGHTNESS_UP 4
96#define TP_CMOS_BRIGHTNESS_DOWN 5
97#define TP_CMOS_THINKLIGHT_ON 12
98#define TP_CMOS_THINKLIGHT_OFF 13
99
100/* NVRAM Addresses */
101enum tp_nvram_addr {
102 TP_NVRAM_ADDR_HK2 = 0x57,
103 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
104 TP_NVRAM_ADDR_VIDEO = 0x59,
105 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
106 TP_NVRAM_ADDR_MIXER = 0x60,
107};
108
109/* NVRAM bit masks */
110enum {
111 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
112 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
113 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
114 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
115 TP_NVRAM_MASK_THINKLIGHT = 0x10,
116 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
117 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
118 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
119 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
120 TP_NVRAM_MASK_MUTE = 0x40,
121 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
122 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
123 TP_NVRAM_POS_LEVEL_VOLUME = 0,
124};
125
126/* Misc NVRAM-related */
127enum {
128 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
129};
130
131/* ACPI HIDs */
132#define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
133#define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
134#define TPACPI_ACPI_LENOVO_HKEY_V2_HID "LEN0268"
135#define TPACPI_ACPI_EC_HID "PNP0C09"
136
137/* Input IDs */
138#define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
139#define TPACPI_HKEY_INPUT_VERSION 0x4101
140
141/* ACPI \WGSV commands */
142enum {
143 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
144 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
145 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
146 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
147};
148
149/* TP_ACPI_WGSV_GET_STATE bits */
150enum {
151 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
152 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
153 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
154 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
155 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
156 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
157 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
158 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
159 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
160 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
161};
162
163/* HKEY events */
164enum tpacpi_hkey_event_t {
165 /* Hotkey-related */
166 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
167 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
168 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
169 TP_HKEY_EV_KBD_LIGHT = 0x1012, /* Thinklight/kbd backlight */
170 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
171 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
172 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
173
174 /* Reasons for waking up from S3/S4 */
175 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
176 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
177 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
178 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
179 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
180 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
181
182 /* Auto-sleep after eject request */
183 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
184 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
185
186 /* Misc bay events */
187 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
188 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
189 or port replicator */
190 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
191 dock or port replicator */
192
193 /* User-interface events */
194 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
195 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
196 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
197 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
198 TP_HKEY_EV_TABLET_CHANGED = 0x60c0, /* X1 Yoga (2016):
199 * enter/leave tablet mode
200 */
201 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
202 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
203 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
204
205 /* Key-related user-interface events */
206 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
207 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
208 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
209
210 /* Thermal events */
211 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
212 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
213 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
214 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
215 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
216
217 /* AC-related events */
218 TP_HKEY_EV_AC_CHANGED = 0x6040, /* AC status changed */
219
220 /* Further user-interface events */
221 TP_HKEY_EV_PALM_DETECTED = 0x60b0, /* palm hoveres keyboard */
222 TP_HKEY_EV_PALM_UNDETECTED = 0x60b1, /* palm removed */
223
224 /* Misc */
225 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
226};
227
228/****************************************************************************
229 * Main driver
230 */
231
232#define TPACPI_NAME "thinkpad"
233#define TPACPI_DESC "ThinkPad ACPI Extras"
234#define TPACPI_FILE TPACPI_NAME "_acpi"
235#define TPACPI_URL "http://ibm-acpi.sf.net/"
236#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
237
238#define TPACPI_PROC_DIR "ibm"
239#define TPACPI_ACPI_EVENT_PREFIX "ibm"
240#define TPACPI_DRVR_NAME TPACPI_FILE
241#define TPACPI_DRVR_SHORTNAME "tpacpi"
242#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
243
244#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
245#define TPACPI_WORKQUEUE_NAME "ktpacpid"
246
247#define TPACPI_MAX_ACPI_ARGS 3
248
249/* Debugging printk groups */
250#define TPACPI_DBG_ALL 0xffff
251#define TPACPI_DBG_DISCLOSETASK 0x8000
252#define TPACPI_DBG_INIT 0x0001
253#define TPACPI_DBG_EXIT 0x0002
254#define TPACPI_DBG_RFKILL 0x0004
255#define TPACPI_DBG_HKEY 0x0008
256#define TPACPI_DBG_FAN 0x0010
257#define TPACPI_DBG_BRGHT 0x0020
258#define TPACPI_DBG_MIXER 0x0040
259
260#define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
261#define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
262#define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
263
264
265/****************************************************************************
266 * Driver-wide structs and misc. variables
267 */
268
269struct ibm_struct;
270
271struct tp_acpi_drv_struct {
272 const struct acpi_device_id *hid;
273 struct acpi_driver *driver;
274
275 void (*notify) (struct ibm_struct *, u32);
276 acpi_handle *handle;
277 u32 type;
278 struct acpi_device *device;
279};
280
281struct ibm_struct {
282 char *name;
283
284 int (*read) (struct seq_file *);
285 int (*write) (char *);
286 void (*exit) (void);
287 void (*resume) (void);
288 void (*suspend) (void);
289 void (*shutdown) (void);
290
291 struct list_head all_drivers;
292
293 struct tp_acpi_drv_struct *acpi;
294
295 struct {
296 u8 acpi_driver_registered:1;
297 u8 acpi_notify_installed:1;
298 u8 proc_created:1;
299 u8 init_called:1;
300 u8 experimental:1;
301 } flags;
302};
303
304struct ibm_init_struct {
305 char param[32];
306
307 int (*init) (struct ibm_init_struct *);
308 umode_t base_procfs_mode;
309 struct ibm_struct *data;
310};
311
312static struct {
313 u32 bluetooth:1;
314 u32 hotkey:1;
315 u32 hotkey_mask:1;
316 u32 hotkey_wlsw:1;
317 enum {
318 TP_HOTKEY_TABLET_NONE = 0,
319 TP_HOTKEY_TABLET_USES_MHKG,
320 TP_HOTKEY_TABLET_USES_GMMS,
321 } hotkey_tablet;
322 u32 kbdlight:1;
323 u32 light:1;
324 u32 light_status:1;
325 u32 bright_acpimode:1;
326 u32 bright_unkfw:1;
327 u32 wan:1;
328 u32 uwb:1;
329 u32 fan_ctrl_status_undef:1;
330 u32 second_fan:1;
331 u32 beep_needs_two_args:1;
332 u32 mixer_no_level_control:1;
333 u32 input_device_registered:1;
334 u32 platform_drv_registered:1;
335 u32 platform_drv_attrs_registered:1;
336 u32 sensors_pdrv_registered:1;
337 u32 sensors_pdrv_attrs_registered:1;
338 u32 sensors_pdev_attrs_registered:1;
339 u32 hotkey_poll_active:1;
340 u32 has_adaptive_kbd:1;
341 u32 battery:1;
342} tp_features;
343
344static struct {
345 u16 hotkey_mask_ff:1;
346 u16 volume_ctrl_forbidden:1;
347} tp_warned;
348
349struct thinkpad_id_data {
350 unsigned int vendor; /* ThinkPad vendor:
351 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
352
353 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
354 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
355
356 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
357 u16 ec_model;
358 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
359 u16 ec_release;
360
361 char *model_str; /* ThinkPad T43 */
362 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
363};
364static struct thinkpad_id_data thinkpad_id;
365
366static enum {
367 TPACPI_LIFE_INIT = 0,
368 TPACPI_LIFE_RUNNING,
369 TPACPI_LIFE_EXITING,
370} tpacpi_lifecycle;
371
372static int experimental;
373static u32 dbg_level;
374
375static struct workqueue_struct *tpacpi_wq;
376
377enum led_status_t {
378 TPACPI_LED_OFF = 0,
379 TPACPI_LED_ON,
380 TPACPI_LED_BLINK,
381};
382
383/* tpacpi LED class */
384struct tpacpi_led_classdev {
385 struct led_classdev led_classdev;
386 int led;
387};
388
389/* brightness level capabilities */
390static unsigned int bright_maxlvl; /* 0 = unknown */
391
392#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
393static int dbg_wlswemul;
394static bool tpacpi_wlsw_emulstate;
395static int dbg_bluetoothemul;
396static bool tpacpi_bluetooth_emulstate;
397static int dbg_wwanemul;
398static bool tpacpi_wwan_emulstate;
399static int dbg_uwbemul;
400static bool tpacpi_uwb_emulstate;
401#endif
402
403
404/*************************************************************************
405 * Debugging helpers
406 */
407
408#define dbg_printk(a_dbg_level, format, arg...) \
409do { \
410 if (dbg_level & (a_dbg_level)) \
411 printk(KERN_DEBUG pr_fmt("%s: " format), \
412 __func__, ##arg); \
413} while (0)
414
415#ifdef CONFIG_THINKPAD_ACPI_DEBUG
416#define vdbg_printk dbg_printk
417static const char *str_supported(int is_supported);
418#else
419static inline const char *str_supported(int is_supported) { return ""; }
420#define vdbg_printk(a_dbg_level, format, arg...) \
421 do { if (0) no_printk(format, ##arg); } while (0)
422#endif
423
424static void tpacpi_log_usertask(const char * const what)
425{
426 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
427 what, task_tgid_vnr(current));
428}
429
430#define tpacpi_disclose_usertask(what, format, arg...) \
431do { \
432 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
433 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
434 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
435 what, task_tgid_vnr(current), ## arg); \
436 } \
437} while (0)
438
439/*
440 * Quirk handling helpers
441 *
442 * ThinkPad IDs and versions seen in the field so far
443 * are two-characters from the set [0-9A-Z], i.e. base 36.
444 *
445 * We use values well outside that range as specials.
446 */
447
448#define TPACPI_MATCH_ANY 0xffffU
449#define TPACPI_MATCH_UNKNOWN 0U
450
451/* TPID('1', 'Y') == 0x5931 */
452#define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
453
454#define TPACPI_Q_IBM(__id1, __id2, __quirk) \
455 { .vendor = PCI_VENDOR_ID_IBM, \
456 .bios = TPID(__id1, __id2), \
457 .ec = TPACPI_MATCH_ANY, \
458 .quirks = (__quirk) }
459
460#define TPACPI_Q_LNV(__id1, __id2, __quirk) \
461 { .vendor = PCI_VENDOR_ID_LENOVO, \
462 .bios = TPID(__id1, __id2), \
463 .ec = TPACPI_MATCH_ANY, \
464 .quirks = (__quirk) }
465
466#define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
467 { .vendor = PCI_VENDOR_ID_LENOVO, \
468 .bios = TPACPI_MATCH_ANY, \
469 .ec = TPID(__id1, __id2), \
470 .quirks = (__quirk) }
471
472struct tpacpi_quirk {
473 unsigned int vendor;
474 u16 bios;
475 u16 ec;
476 unsigned long quirks;
477};
478
479/**
480 * tpacpi_check_quirks() - search BIOS/EC version on a list
481 * @qlist: array of &struct tpacpi_quirk
482 * @qlist_size: number of elements in @qlist
483 *
484 * Iterates over a quirks list until one is found that matches the
485 * ThinkPad's vendor, BIOS and EC model.
486 *
487 * Returns 0 if nothing matches, otherwise returns the quirks field of
488 * the matching &struct tpacpi_quirk entry.
489 *
490 * The match criteria is: vendor, ec and bios much match.
491 */
492static unsigned long __init tpacpi_check_quirks(
493 const struct tpacpi_quirk *qlist,
494 unsigned int qlist_size)
495{
496 while (qlist_size) {
497 if ((qlist->vendor == thinkpad_id.vendor ||
498 qlist->vendor == TPACPI_MATCH_ANY) &&
499 (qlist->bios == thinkpad_id.bios_model ||
500 qlist->bios == TPACPI_MATCH_ANY) &&
501 (qlist->ec == thinkpad_id.ec_model ||
502 qlist->ec == TPACPI_MATCH_ANY))
503 return qlist->quirks;
504
505 qlist_size--;
506 qlist++;
507 }
508 return 0;
509}
510
511static inline bool __pure __init tpacpi_is_lenovo(void)
512{
513 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
514}
515
516static inline bool __pure __init tpacpi_is_ibm(void)
517{
518 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
519}
520
521/****************************************************************************
522 ****************************************************************************
523 *
524 * ACPI Helpers and device model
525 *
526 ****************************************************************************
527 ****************************************************************************/
528
529/*************************************************************************
530 * ACPI basic handles
531 */
532
533static acpi_handle root_handle;
534static acpi_handle ec_handle;
535
536#define TPACPI_HANDLE(object, parent, paths...) \
537 static acpi_handle object##_handle; \
538 static const acpi_handle * const object##_parent __initconst = \
539 &parent##_handle; \
540 static char *object##_paths[] __initdata = { paths }
541
542TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
543TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
544
545TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
546 /* T4x, X31, X40 */
547 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
548 "\\CMS", /* R40, R40e */
549 ); /* all others */
550
551TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
552 "^HKEY", /* R30, R31 */
553 "HKEY", /* all others */
554 ); /* 570 */
555
556/*************************************************************************
557 * ACPI helpers
558 */
559
560static int acpi_evalf(acpi_handle handle,
561 int *res, char *method, char *fmt, ...)
562{
563 char *fmt0 = fmt;
564 struct acpi_object_list params;
565 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
566 struct acpi_buffer result, *resultp;
567 union acpi_object out_obj;
568 acpi_status status;
569 va_list ap;
570 char res_type;
571 int success;
572 int quiet;
573
574 if (!*fmt) {
575 pr_err("acpi_evalf() called with empty format\n");
576 return 0;
577 }
578
579 if (*fmt == 'q') {
580 quiet = 1;
581 fmt++;
582 } else
583 quiet = 0;
584
585 res_type = *(fmt++);
586
587 params.count = 0;
588 params.pointer = &in_objs[0];
589
590 va_start(ap, fmt);
591 while (*fmt) {
592 char c = *(fmt++);
593 switch (c) {
594 case 'd': /* int */
595 in_objs[params.count].integer.value = va_arg(ap, int);
596 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
597 break;
598 /* add more types as needed */
599 default:
600 pr_err("acpi_evalf() called with invalid format character '%c'\n",
601 c);
602 va_end(ap);
603 return 0;
604 }
605 }
606 va_end(ap);
607
608 if (res_type != 'v') {
609 result.length = sizeof(out_obj);
610 result.pointer = &out_obj;
611 resultp = &result;
612 } else
613 resultp = NULL;
614
615 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
616
617 switch (res_type) {
618 case 'd': /* int */
619 success = (status == AE_OK &&
620 out_obj.type == ACPI_TYPE_INTEGER);
621 if (success && res)
622 *res = out_obj.integer.value;
623 break;
624 case 'v': /* void */
625 success = status == AE_OK;
626 break;
627 /* add more types as needed */
628 default:
629 pr_err("acpi_evalf() called with invalid format character '%c'\n",
630 res_type);
631 return 0;
632 }
633
634 if (!success && !quiet)
635 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
636 method, fmt0, acpi_format_exception(status));
637
638 return success;
639}
640
641static int acpi_ec_read(int i, u8 *p)
642{
643 int v;
644
645 if (ecrd_handle) {
646 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
647 return 0;
648 *p = v;
649 } else {
650 if (ec_read(i, p) < 0)
651 return 0;
652 }
653
654 return 1;
655}
656
657static int acpi_ec_write(int i, u8 v)
658{
659 if (ecwr_handle) {
660 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
661 return 0;
662 } else {
663 if (ec_write(i, v) < 0)
664 return 0;
665 }
666
667 return 1;
668}
669
670static int issue_thinkpad_cmos_command(int cmos_cmd)
671{
672 if (!cmos_handle)
673 return -ENXIO;
674
675 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
676 return -EIO;
677
678 return 0;
679}
680
681/*************************************************************************
682 * ACPI device model
683 */
684
685#define TPACPI_ACPIHANDLE_INIT(object) \
686 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
687 object##_paths, ARRAY_SIZE(object##_paths))
688
689static void __init drv_acpi_handle_init(const char *name,
690 acpi_handle *handle, const acpi_handle parent,
691 char **paths, const int num_paths)
692{
693 int i;
694 acpi_status status;
695
696 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
697 name);
698
699 for (i = 0; i < num_paths; i++) {
700 status = acpi_get_handle(parent, paths[i], handle);
701 if (ACPI_SUCCESS(status)) {
702 dbg_printk(TPACPI_DBG_INIT,
703 "Found ACPI handle %s for %s\n",
704 paths[i], name);
705 return;
706 }
707 }
708
709 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
710 name);
711 *handle = NULL;
712}
713
714static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
715 u32 level, void *context, void **return_value)
716{
717 struct acpi_device *dev;
718 if (!strcmp(context, "video")) {
719 if (acpi_bus_get_device(handle, &dev))
720 return AE_OK;
721 if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
722 return AE_OK;
723 }
724
725 *(acpi_handle *)return_value = handle;
726
727 return AE_CTRL_TERMINATE;
728}
729
730static void __init tpacpi_acpi_handle_locate(const char *name,
731 const char *hid,
732 acpi_handle *handle)
733{
734 acpi_status status;
735 acpi_handle device_found;
736
737 BUG_ON(!name || !handle);
738 vdbg_printk(TPACPI_DBG_INIT,
739 "trying to locate ACPI handle for %s, using HID %s\n",
740 name, hid ? hid : "NULL");
741
742 memset(&device_found, 0, sizeof(device_found));
743 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
744 (void *)name, &device_found);
745
746 *handle = NULL;
747
748 if (ACPI_SUCCESS(status)) {
749 *handle = device_found;
750 dbg_printk(TPACPI_DBG_INIT,
751 "Found ACPI handle for %s\n", name);
752 } else {
753 vdbg_printk(TPACPI_DBG_INIT,
754 "Could not locate an ACPI handle for %s: %s\n",
755 name, acpi_format_exception(status));
756 }
757}
758
759static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
760{
761 struct ibm_struct *ibm = data;
762
763 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
764 return;
765
766 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
767 return;
768
769 ibm->acpi->notify(ibm, event);
770}
771
772static int __init setup_acpi_notify(struct ibm_struct *ibm)
773{
774 acpi_status status;
775 int rc;
776
777 BUG_ON(!ibm->acpi);
778
779 if (!*ibm->acpi->handle)
780 return 0;
781
782 vdbg_printk(TPACPI_DBG_INIT,
783 "setting up ACPI notify for %s\n", ibm->name);
784
785 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
786 if (rc < 0) {
787 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
788 return -ENODEV;
789 }
790
791 ibm->acpi->device->driver_data = ibm;
792 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
793 TPACPI_ACPI_EVENT_PREFIX,
794 ibm->name);
795
796 status = acpi_install_notify_handler(*ibm->acpi->handle,
797 ibm->acpi->type, dispatch_acpi_notify, ibm);
798 if (ACPI_FAILURE(status)) {
799 if (status == AE_ALREADY_EXISTS) {
800 pr_notice("another device driver is already handling %s events\n",
801 ibm->name);
802 } else {
803 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
804 ibm->name, acpi_format_exception(status));
805 }
806 return -ENODEV;
807 }
808 ibm->flags.acpi_notify_installed = 1;
809 return 0;
810}
811
812static int __init tpacpi_device_add(struct acpi_device *device)
813{
814 return 0;
815}
816
817static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
818{
819 int rc;
820
821 dbg_printk(TPACPI_DBG_INIT,
822 "registering %s as an ACPI driver\n", ibm->name);
823
824 BUG_ON(!ibm->acpi);
825
826 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
827 if (!ibm->acpi->driver) {
828 pr_err("failed to allocate memory for ibm->acpi->driver\n");
829 return -ENOMEM;
830 }
831
832 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
833 ibm->acpi->driver->ids = ibm->acpi->hid;
834
835 ibm->acpi->driver->ops.add = &tpacpi_device_add;
836
837 rc = acpi_bus_register_driver(ibm->acpi->driver);
838 if (rc < 0) {
839 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
840 ibm->name, rc);
841 kfree(ibm->acpi->driver);
842 ibm->acpi->driver = NULL;
843 } else if (!rc)
844 ibm->flags.acpi_driver_registered = 1;
845
846 return rc;
847}
848
849
850/****************************************************************************
851 ****************************************************************************
852 *
853 * Procfs Helpers
854 *
855 ****************************************************************************
856 ****************************************************************************/
857
858static int dispatch_proc_show(struct seq_file *m, void *v)
859{
860 struct ibm_struct *ibm = m->private;
861
862 if (!ibm || !ibm->read)
863 return -EINVAL;
864 return ibm->read(m);
865}
866
867static int dispatch_proc_open(struct inode *inode, struct file *file)
868{
869 return single_open(file, dispatch_proc_show, PDE_DATA(inode));
870}
871
872static ssize_t dispatch_proc_write(struct file *file,
873 const char __user *userbuf,
874 size_t count, loff_t *pos)
875{
876 struct ibm_struct *ibm = PDE_DATA(file_inode(file));
877 char *kernbuf;
878 int ret;
879
880 if (!ibm || !ibm->write)
881 return -EINVAL;
882 if (count > PAGE_SIZE - 2)
883 return -EINVAL;
884
885 kernbuf = kmalloc(count + 2, GFP_KERNEL);
886 if (!kernbuf)
887 return -ENOMEM;
888
889 if (copy_from_user(kernbuf, userbuf, count)) {
890 kfree(kernbuf);
891 return -EFAULT;
892 }
893
894 kernbuf[count] = 0;
895 strcat(kernbuf, ",");
896 ret = ibm->write(kernbuf);
897 if (ret == 0)
898 ret = count;
899
900 kfree(kernbuf);
901
902 return ret;
903}
904
905static const struct file_operations dispatch_proc_fops = {
906 .owner = THIS_MODULE,
907 .open = dispatch_proc_open,
908 .read = seq_read,
909 .llseek = seq_lseek,
910 .release = single_release,
911 .write = dispatch_proc_write,
912};
913
914static char *next_cmd(char **cmds)
915{
916 char *start = *cmds;
917 char *end;
918
919 while ((end = strchr(start, ',')) && end == start)
920 start = end + 1;
921
922 if (!end)
923 return NULL;
924
925 *end = 0;
926 *cmds = end + 1;
927 return start;
928}
929
930
931/****************************************************************************
932 ****************************************************************************
933 *
934 * Device model: input, hwmon and platform
935 *
936 ****************************************************************************
937 ****************************************************************************/
938
939static struct platform_device *tpacpi_pdev;
940static struct platform_device *tpacpi_sensors_pdev;
941static struct device *tpacpi_hwmon;
942static struct input_dev *tpacpi_inputdev;
943static struct mutex tpacpi_inputdev_send_mutex;
944static LIST_HEAD(tpacpi_all_drivers);
945
946#ifdef CONFIG_PM_SLEEP
947static int tpacpi_suspend_handler(struct device *dev)
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->suspend)
955 (ibm->suspend)();
956 }
957
958 return 0;
959}
960
961static int tpacpi_resume_handler(struct device *dev)
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->resume)
969 (ibm->resume)();
970 }
971
972 return 0;
973}
974#endif
975
976static SIMPLE_DEV_PM_OPS(tpacpi_pm,
977 tpacpi_suspend_handler, tpacpi_resume_handler);
978
979static void tpacpi_shutdown_handler(struct platform_device *pdev)
980{
981 struct ibm_struct *ibm, *itmp;
982
983 list_for_each_entry_safe(ibm, itmp,
984 &tpacpi_all_drivers,
985 all_drivers) {
986 if (ibm->shutdown)
987 (ibm->shutdown)();
988 }
989}
990
991static struct platform_driver tpacpi_pdriver = {
992 .driver = {
993 .name = TPACPI_DRVR_NAME,
994 .pm = &tpacpi_pm,
995 },
996 .shutdown = tpacpi_shutdown_handler,
997};
998
999static struct platform_driver tpacpi_hwmon_pdriver = {
1000 .driver = {
1001 .name = TPACPI_HWMON_DRVR_NAME,
1002 },
1003};
1004
1005/*************************************************************************
1006 * sysfs support helpers
1007 */
1008
1009struct attribute_set {
1010 unsigned int members, max_members;
1011 struct attribute_group group;
1012};
1013
1014struct attribute_set_obj {
1015 struct attribute_set s;
1016 struct attribute *a;
1017} __attribute__((packed));
1018
1019static struct attribute_set *create_attr_set(unsigned int max_members,
1020 const char *name)
1021{
1022 struct attribute_set_obj *sobj;
1023
1024 if (max_members == 0)
1025 return NULL;
1026
1027 /* Allocates space for implicit NULL at the end too */
1028 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1029 max_members * sizeof(struct attribute *),
1030 GFP_KERNEL);
1031 if (!sobj)
1032 return NULL;
1033 sobj->s.max_members = max_members;
1034 sobj->s.group.attrs = &sobj->a;
1035 sobj->s.group.name = name;
1036
1037 return &sobj->s;
1038}
1039
1040#define destroy_attr_set(_set) \
1041 kfree(_set);
1042
1043/* not multi-threaded safe, use it in a single thread per set */
1044static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1045{
1046 if (!s || !attr)
1047 return -EINVAL;
1048
1049 if (s->members >= s->max_members)
1050 return -ENOMEM;
1051
1052 s->group.attrs[s->members] = attr;
1053 s->members++;
1054
1055 return 0;
1056}
1057
1058static int add_many_to_attr_set(struct attribute_set *s,
1059 struct attribute **attr,
1060 unsigned int count)
1061{
1062 int i, res;
1063
1064 for (i = 0; i < count; i++) {
1065 res = add_to_attr_set(s, attr[i]);
1066 if (res)
1067 return res;
1068 }
1069
1070 return 0;
1071}
1072
1073static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1074{
1075 sysfs_remove_group(kobj, &s->group);
1076 destroy_attr_set(s);
1077}
1078
1079#define register_attr_set_with_sysfs(_attr_set, _kobj) \
1080 sysfs_create_group(_kobj, &_attr_set->group)
1081
1082static int parse_strtoul(const char *buf,
1083 unsigned long max, unsigned long *value)
1084{
1085 char *endp;
1086
1087 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1088 endp = skip_spaces(endp);
1089 if (*endp || *value > max)
1090 return -EINVAL;
1091
1092 return 0;
1093}
1094
1095static void tpacpi_disable_brightness_delay(void)
1096{
1097 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1098 pr_notice("ACPI backlight control delay disabled\n");
1099}
1100
1101static void printk_deprecated_attribute(const char * const what,
1102 const char * const details)
1103{
1104 tpacpi_log_usertask("deprecated sysfs attribute");
1105 pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1106 what, details);
1107}
1108
1109/*************************************************************************
1110 * rfkill and radio control support helpers
1111 */
1112
1113/*
1114 * ThinkPad-ACPI firmware handling model:
1115 *
1116 * WLSW (master wireless switch) is event-driven, and is common to all
1117 * firmware-controlled radios. It cannot be controlled, just monitored,
1118 * as expected. It overrides all radio state in firmware
1119 *
1120 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1121 * (TODO: verify how WLSW interacts with the returned radio state).
1122 *
1123 * The only time there are shadow radio state changes, is when
1124 * masked-off hotkeys are used.
1125 */
1126
1127/*
1128 * Internal driver API for radio state:
1129 *
1130 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1131 * bool: true means radio blocked (off)
1132 */
1133enum tpacpi_rfkill_state {
1134 TPACPI_RFK_RADIO_OFF = 0,
1135 TPACPI_RFK_RADIO_ON
1136};
1137
1138/* rfkill switches */
1139enum tpacpi_rfk_id {
1140 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1141 TPACPI_RFK_WWAN_SW_ID,
1142 TPACPI_RFK_UWB_SW_ID,
1143 TPACPI_RFK_SW_MAX
1144};
1145
1146static const char *tpacpi_rfkill_names[] = {
1147 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1148 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1149 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1150 [TPACPI_RFK_SW_MAX] = NULL
1151};
1152
1153/* ThinkPad-ACPI rfkill subdriver */
1154struct tpacpi_rfk {
1155 struct rfkill *rfkill;
1156 enum tpacpi_rfk_id id;
1157 const struct tpacpi_rfk_ops *ops;
1158};
1159
1160struct tpacpi_rfk_ops {
1161 /* firmware interface */
1162 int (*get_status)(void);
1163 int (*set_status)(const enum tpacpi_rfkill_state);
1164};
1165
1166static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1167
1168/* Query FW and update rfkill sw state for a given rfkill switch */
1169static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1170{
1171 int status;
1172
1173 if (!tp_rfk)
1174 return -ENODEV;
1175
1176 status = (tp_rfk->ops->get_status)();
1177 if (status < 0)
1178 return status;
1179
1180 rfkill_set_sw_state(tp_rfk->rfkill,
1181 (status == TPACPI_RFK_RADIO_OFF));
1182
1183 return status;
1184}
1185
1186/* Query FW and update rfkill sw state for all rfkill switches */
1187static void tpacpi_rfk_update_swstate_all(void)
1188{
1189 unsigned int i;
1190
1191 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1192 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1193}
1194
1195/*
1196 * Sync the HW-blocking state of all rfkill switches,
1197 * do notice it causes the rfkill core to schedule uevents
1198 */
1199static void tpacpi_rfk_update_hwblock_state(bool blocked)
1200{
1201 unsigned int i;
1202 struct tpacpi_rfk *tp_rfk;
1203
1204 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1205 tp_rfk = tpacpi_rfkill_switches[i];
1206 if (tp_rfk) {
1207 if (rfkill_set_hw_state(tp_rfk->rfkill,
1208 blocked)) {
1209 /* ignore -- we track sw block */
1210 }
1211 }
1212 }
1213}
1214
1215/* Call to get the WLSW state from the firmware */
1216static int hotkey_get_wlsw(void);
1217
1218/* Call to query WLSW state and update all rfkill switches */
1219static bool tpacpi_rfk_check_hwblock_state(void)
1220{
1221 int res = hotkey_get_wlsw();
1222 int hw_blocked;
1223
1224 /* When unknown or unsupported, we have to assume it is unblocked */
1225 if (res < 0)
1226 return false;
1227
1228 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1229 tpacpi_rfk_update_hwblock_state(hw_blocked);
1230
1231 return hw_blocked;
1232}
1233
1234static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1235{
1236 struct tpacpi_rfk *tp_rfk = data;
1237 int res;
1238
1239 dbg_printk(TPACPI_DBG_RFKILL,
1240 "request to change radio state to %s\n",
1241 blocked ? "blocked" : "unblocked");
1242
1243 /* try to set radio state */
1244 res = (tp_rfk->ops->set_status)(blocked ?
1245 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1246
1247 /* and update the rfkill core with whatever the FW really did */
1248 tpacpi_rfk_update_swstate(tp_rfk);
1249
1250 return (res < 0) ? res : 0;
1251}
1252
1253static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1254 .set_block = tpacpi_rfk_hook_set_block,
1255};
1256
1257static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1258 const struct tpacpi_rfk_ops *tp_rfkops,
1259 const enum rfkill_type rfktype,
1260 const char *name,
1261 const bool set_default)
1262{
1263 struct tpacpi_rfk *atp_rfk;
1264 int res;
1265 bool sw_state = false;
1266 bool hw_state;
1267 int sw_status;
1268
1269 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1270
1271 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1272 if (atp_rfk)
1273 atp_rfk->rfkill = rfkill_alloc(name,
1274 &tpacpi_pdev->dev,
1275 rfktype,
1276 &tpacpi_rfk_rfkill_ops,
1277 atp_rfk);
1278 if (!atp_rfk || !atp_rfk->rfkill) {
1279 pr_err("failed to allocate memory for rfkill class\n");
1280 kfree(atp_rfk);
1281 return -ENOMEM;
1282 }
1283
1284 atp_rfk->id = id;
1285 atp_rfk->ops = tp_rfkops;
1286
1287 sw_status = (tp_rfkops->get_status)();
1288 if (sw_status < 0) {
1289 pr_err("failed to read initial state for %s, error %d\n",
1290 name, sw_status);
1291 } else {
1292 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1293 if (set_default) {
1294 /* try to keep the initial state, since we ask the
1295 * firmware to preserve it across S5 in NVRAM */
1296 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1297 }
1298 }
1299 hw_state = tpacpi_rfk_check_hwblock_state();
1300 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1301
1302 res = rfkill_register(atp_rfk->rfkill);
1303 if (res < 0) {
1304 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1305 rfkill_destroy(atp_rfk->rfkill);
1306 kfree(atp_rfk);
1307 return res;
1308 }
1309
1310 tpacpi_rfkill_switches[id] = atp_rfk;
1311
1312 pr_info("rfkill switch %s: radio is %sblocked\n",
1313 name, (sw_state || hw_state) ? "" : "un");
1314 return 0;
1315}
1316
1317static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1318{
1319 struct tpacpi_rfk *tp_rfk;
1320
1321 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1322
1323 tp_rfk = tpacpi_rfkill_switches[id];
1324 if (tp_rfk) {
1325 rfkill_unregister(tp_rfk->rfkill);
1326 rfkill_destroy(tp_rfk->rfkill);
1327 tpacpi_rfkill_switches[id] = NULL;
1328 kfree(tp_rfk);
1329 }
1330}
1331
1332static void printk_deprecated_rfkill_attribute(const char * const what)
1333{
1334 printk_deprecated_attribute(what,
1335 "Please switch to generic rfkill before year 2010");
1336}
1337
1338/* sysfs <radio> enable ------------------------------------------------ */
1339static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1340 struct device_attribute *attr,
1341 char *buf)
1342{
1343 int status;
1344
1345 printk_deprecated_rfkill_attribute(attr->attr.name);
1346
1347 /* This is in the ABI... */
1348 if (tpacpi_rfk_check_hwblock_state()) {
1349 status = TPACPI_RFK_RADIO_OFF;
1350 } else {
1351 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1352 if (status < 0)
1353 return status;
1354 }
1355
1356 return snprintf(buf, PAGE_SIZE, "%d\n",
1357 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1358}
1359
1360static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1361 struct device_attribute *attr,
1362 const char *buf, size_t count)
1363{
1364 unsigned long t;
1365 int res;
1366
1367 printk_deprecated_rfkill_attribute(attr->attr.name);
1368
1369 if (parse_strtoul(buf, 1, &t))
1370 return -EINVAL;
1371
1372 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1373
1374 /* This is in the ABI... */
1375 if (tpacpi_rfk_check_hwblock_state() && !!t)
1376 return -EPERM;
1377
1378 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1379 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1380 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1381
1382 return (res < 0) ? res : count;
1383}
1384
1385/* procfs -------------------------------------------------------------- */
1386static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1387{
1388 if (id >= TPACPI_RFK_SW_MAX)
1389 seq_printf(m, "status:\t\tnot supported\n");
1390 else {
1391 int status;
1392
1393 /* This is in the ABI... */
1394 if (tpacpi_rfk_check_hwblock_state()) {
1395 status = TPACPI_RFK_RADIO_OFF;
1396 } else {
1397 status = tpacpi_rfk_update_swstate(
1398 tpacpi_rfkill_switches[id]);
1399 if (status < 0)
1400 return status;
1401 }
1402
1403 seq_printf(m, "status:\t\t%s\n",
1404 (status == TPACPI_RFK_RADIO_ON) ?
1405 "enabled" : "disabled");
1406 seq_printf(m, "commands:\tenable, disable\n");
1407 }
1408
1409 return 0;
1410}
1411
1412static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1413{
1414 char *cmd;
1415 int status = -1;
1416 int res = 0;
1417
1418 if (id >= TPACPI_RFK_SW_MAX)
1419 return -ENODEV;
1420
1421 while ((cmd = next_cmd(&buf))) {
1422 if (strlencmp(cmd, "enable") == 0)
1423 status = TPACPI_RFK_RADIO_ON;
1424 else if (strlencmp(cmd, "disable") == 0)
1425 status = TPACPI_RFK_RADIO_OFF;
1426 else
1427 return -EINVAL;
1428 }
1429
1430 if (status != -1) {
1431 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1432 (status == TPACPI_RFK_RADIO_ON) ?
1433 "enable" : "disable",
1434 tpacpi_rfkill_names[id]);
1435 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1436 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1437 }
1438
1439 return res;
1440}
1441
1442/*************************************************************************
1443 * thinkpad-acpi driver attributes
1444 */
1445
1446/* interface_version --------------------------------------------------- */
1447static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1448{
1449 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1450}
1451static DRIVER_ATTR_RO(interface_version);
1452
1453/* debug_level --------------------------------------------------------- */
1454static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1455{
1456 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1457}
1458
1459static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1460 size_t count)
1461{
1462 unsigned long t;
1463
1464 if (parse_strtoul(buf, 0xffff, &t))
1465 return -EINVAL;
1466
1467 dbg_level = t;
1468
1469 return count;
1470}
1471static DRIVER_ATTR_RW(debug_level);
1472
1473/* version ------------------------------------------------------------- */
1474static ssize_t version_show(struct device_driver *drv, char *buf)
1475{
1476 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1477 TPACPI_DESC, TPACPI_VERSION);
1478}
1479static DRIVER_ATTR_RO(version);
1480
1481/* --------------------------------------------------------------------- */
1482
1483#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1484
1485/* wlsw_emulstate ------------------------------------------------------ */
1486static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1487{
1488 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1489}
1490
1491static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1492 size_t count)
1493{
1494 unsigned long t;
1495
1496 if (parse_strtoul(buf, 1, &t))
1497 return -EINVAL;
1498
1499 if (tpacpi_wlsw_emulstate != !!t) {
1500 tpacpi_wlsw_emulstate = !!t;
1501 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1502 }
1503
1504 return count;
1505}
1506static DRIVER_ATTR_RW(wlsw_emulstate);
1507
1508/* bluetooth_emulstate ------------------------------------------------- */
1509static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1510{
1511 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1512}
1513
1514static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1515 const char *buf, size_t count)
1516{
1517 unsigned long t;
1518
1519 if (parse_strtoul(buf, 1, &t))
1520 return -EINVAL;
1521
1522 tpacpi_bluetooth_emulstate = !!t;
1523
1524 return count;
1525}
1526static DRIVER_ATTR_RW(bluetooth_emulstate);
1527
1528/* wwan_emulstate ------------------------------------------------- */
1529static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1530{
1531 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1532}
1533
1534static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1535 size_t count)
1536{
1537 unsigned long t;
1538
1539 if (parse_strtoul(buf, 1, &t))
1540 return -EINVAL;
1541
1542 tpacpi_wwan_emulstate = !!t;
1543
1544 return count;
1545}
1546static DRIVER_ATTR_RW(wwan_emulstate);
1547
1548/* uwb_emulstate ------------------------------------------------- */
1549static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1550{
1551 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1552}
1553
1554static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1555 size_t count)
1556{
1557 unsigned long t;
1558
1559 if (parse_strtoul(buf, 1, &t))
1560 return -EINVAL;
1561
1562 tpacpi_uwb_emulstate = !!t;
1563
1564 return count;
1565}
1566static DRIVER_ATTR_RW(uwb_emulstate);
1567#endif
1568
1569/* --------------------------------------------------------------------- */
1570
1571static struct driver_attribute *tpacpi_driver_attributes[] = {
1572 &driver_attr_debug_level, &driver_attr_version,
1573 &driver_attr_interface_version,
1574};
1575
1576static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1577{
1578 int i, res;
1579
1580 i = 0;
1581 res = 0;
1582 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1583 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1584 i++;
1585 }
1586
1587#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1588 if (!res && dbg_wlswemul)
1589 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1590 if (!res && dbg_bluetoothemul)
1591 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1592 if (!res && dbg_wwanemul)
1593 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1594 if (!res && dbg_uwbemul)
1595 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1596#endif
1597
1598 return res;
1599}
1600
1601static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1602{
1603 int i;
1604
1605 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1606 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1607
1608#ifdef THINKPAD_ACPI_DEBUGFACILITIES
1609 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1610 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1611 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1612 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1613#endif
1614}
1615
1616/*************************************************************************
1617 * Firmware Data
1618 */
1619
1620/*
1621 * Table of recommended minimum BIOS versions
1622 *
1623 * Reasons for listing:
1624 * 1. Stable BIOS, listed because the unknown amount of
1625 * bugs and bad ACPI behaviour on older versions
1626 *
1627 * 2. BIOS or EC fw with known bugs that trigger on Linux
1628 *
1629 * 3. BIOS with known reduced functionality in older versions
1630 *
1631 * We recommend the latest BIOS and EC version.
1632 * We only support the latest BIOS and EC fw version as a rule.
1633 *
1634 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1635 * Information from users in ThinkWiki
1636 *
1637 * WARNING: we use this table also to detect that the machine is
1638 * a ThinkPad in some cases, so don't remove entries lightly.
1639 */
1640
1641#define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1642 { .vendor = (__v), \
1643 .bios = TPID(__id1, __id2), \
1644 .ec = TPACPI_MATCH_ANY, \
1645 .quirks = TPACPI_MATCH_ANY << 16 \
1646 | (__bv1) << 8 | (__bv2) }
1647
1648#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1649 __eid, __ev1, __ev2) \
1650 { .vendor = (__v), \
1651 .bios = TPID(__bid1, __bid2), \
1652 .ec = __eid, \
1653 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1654 | (__bv1) << 8 | (__bv2) }
1655
1656#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1657 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1658
1659/* Outdated IBM BIOSes often lack the EC id string */
1660#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1661 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1662 __bv1, __bv2, TPID(__id1, __id2), \
1663 __ev1, __ev2), \
1664 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1665 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1666 __ev1, __ev2)
1667
1668/* Outdated IBM BIOSes often lack the EC id string */
1669#define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1670 __eid1, __eid2, __ev1, __ev2) \
1671 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1672 __bv1, __bv2, TPID(__eid1, __eid2), \
1673 __ev1, __ev2), \
1674 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1675 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1676 __ev1, __ev2)
1677
1678#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1679 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1680
1681#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1682 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1683 __bv1, __bv2, TPID(__id1, __id2), \
1684 __ev1, __ev2)
1685
1686#define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1687 __eid1, __eid2, __ev1, __ev2) \
1688 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1689 __bv1, __bv2, TPID(__eid1, __eid2), \
1690 __ev1, __ev2)
1691
1692static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1693 /* Numeric models ------------------ */
1694 /* FW MODEL BIOS VERS */
1695 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1696 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1697 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1698 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1699 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1700 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1701 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1702 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1703 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1704
1705 /* A-series ------------------------- */
1706 /* FW MODEL BIOS VERS EC VERS */
1707 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1708 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1709 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1710 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1711 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1712 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1713 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1714 TPV_QI0('1', '3', '2', '0'), /* A22m */
1715 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1716 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1717 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1718
1719 /* G-series ------------------------- */
1720 /* FW MODEL BIOS VERS */
1721 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1722 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1723
1724 /* R-series, T-series --------------- */
1725 /* FW MODEL BIOS VERS EC VERS */
1726 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1727 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1728 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1729 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1730 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1731 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1732 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1733 T40/p, T41/p, T42/p (1) */
1734 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1735 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1736 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1737 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1738
1739 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1740 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1741 TPV_QI0('1', '6', '3', '2'), /* T22 */
1742 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1743 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1744 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1745
1746 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1747 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1748 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1749
1750 /* BIOS FW BIOS VERS EC FW EC VERS */
1751 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1752 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1753
1754 /* X-series ------------------------- */
1755 /* FW MODEL BIOS VERS EC VERS */
1756 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1757 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1758 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1759 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1760 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1761 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1762 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1763
1764 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1765 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1766
1767 /* (0) - older versions lack DMI EC fw string and functionality */
1768 /* (1) - older versions known to lack functionality */
1769};
1770
1771#undef TPV_QL1
1772#undef TPV_QL0
1773#undef TPV_QI2
1774#undef TPV_QI1
1775#undef TPV_QI0
1776#undef TPV_Q_X
1777#undef TPV_Q
1778
1779static void __init tpacpi_check_outdated_fw(void)
1780{
1781 unsigned long fwvers;
1782 u16 ec_version, bios_version;
1783
1784 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1785 ARRAY_SIZE(tpacpi_bios_version_qtable));
1786
1787 if (!fwvers)
1788 return;
1789
1790 bios_version = fwvers & 0xffffU;
1791 ec_version = (fwvers >> 16) & 0xffffU;
1792
1793 /* note that unknown versions are set to 0x0000 and we use that */
1794 if ((bios_version > thinkpad_id.bios_release) ||
1795 (ec_version > thinkpad_id.ec_release &&
1796 ec_version != TPACPI_MATCH_ANY)) {
1797 /*
1798 * The changelogs would let us track down the exact
1799 * reason, but it is just too much of a pain to track
1800 * it. We only list BIOSes that are either really
1801 * broken, or really stable to begin with, so it is
1802 * best if the user upgrades the firmware anyway.
1803 */
1804 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1805 pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1806 }
1807}
1808
1809static bool __init tpacpi_is_fw_known(void)
1810{
1811 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1812 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1813}
1814
1815/****************************************************************************
1816 ****************************************************************************
1817 *
1818 * Subdrivers
1819 *
1820 ****************************************************************************
1821 ****************************************************************************/
1822
1823/*************************************************************************
1824 * thinkpad-acpi metadata subdriver
1825 */
1826
1827static int thinkpad_acpi_driver_read(struct seq_file *m)
1828{
1829 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1830 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1831 return 0;
1832}
1833
1834static struct ibm_struct thinkpad_acpi_driver_data = {
1835 .name = "driver",
1836 .read = thinkpad_acpi_driver_read,
1837};
1838
1839/*************************************************************************
1840 * Hotkey subdriver
1841 */
1842
1843/*
1844 * ThinkPad firmware event model
1845 *
1846 * The ThinkPad firmware has two main event interfaces: normal ACPI
1847 * notifications (which follow the ACPI standard), and a private event
1848 * interface.
1849 *
1850 * The private event interface also issues events for the hotkeys. As
1851 * the driver gained features, the event handling code ended up being
1852 * built around the hotkey subdriver. This will need to be refactored
1853 * to a more formal event API eventually.
1854 *
1855 * Some "hotkeys" are actually supposed to be used as event reports,
1856 * such as "brightness has changed", "volume has changed", depending on
1857 * the ThinkPad model and how the firmware is operating.
1858 *
1859 * Unlike other classes, hotkey-class events have mask/unmask control on
1860 * non-ancient firmware. However, how it behaves changes a lot with the
1861 * firmware model and version.
1862 */
1863
1864enum { /* hot key scan codes (derived from ACPI DSDT) */
1865 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1866 TP_ACPI_HOTKEYSCAN_FNF2,
1867 TP_ACPI_HOTKEYSCAN_FNF3,
1868 TP_ACPI_HOTKEYSCAN_FNF4,
1869 TP_ACPI_HOTKEYSCAN_FNF5,
1870 TP_ACPI_HOTKEYSCAN_FNF6,
1871 TP_ACPI_HOTKEYSCAN_FNF7,
1872 TP_ACPI_HOTKEYSCAN_FNF8,
1873 TP_ACPI_HOTKEYSCAN_FNF9,
1874 TP_ACPI_HOTKEYSCAN_FNF10,
1875 TP_ACPI_HOTKEYSCAN_FNF11,
1876 TP_ACPI_HOTKEYSCAN_FNF12,
1877 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1878 TP_ACPI_HOTKEYSCAN_FNINSERT,
1879 TP_ACPI_HOTKEYSCAN_FNDELETE,
1880 TP_ACPI_HOTKEYSCAN_FNHOME,
1881 TP_ACPI_HOTKEYSCAN_FNEND,
1882 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1883 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1884 TP_ACPI_HOTKEYSCAN_FNSPACE,
1885 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1886 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1887 TP_ACPI_HOTKEYSCAN_MUTE,
1888 TP_ACPI_HOTKEYSCAN_THINKPAD,
1889 TP_ACPI_HOTKEYSCAN_UNK1,
1890 TP_ACPI_HOTKEYSCAN_UNK2,
1891 TP_ACPI_HOTKEYSCAN_UNK3,
1892 TP_ACPI_HOTKEYSCAN_UNK4,
1893 TP_ACPI_HOTKEYSCAN_UNK5,
1894 TP_ACPI_HOTKEYSCAN_UNK6,
1895 TP_ACPI_HOTKEYSCAN_UNK7,
1896 TP_ACPI_HOTKEYSCAN_UNK8,
1897
1898 /* Adaptive keyboard keycodes */
1899 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1900 TP_ACPI_HOTKEYSCAN_MUTE2 = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1901 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1902 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1903 TP_ACPI_HOTKEYSCAN_CLOUD,
1904 TP_ACPI_HOTKEYSCAN_UNK9,
1905 TP_ACPI_HOTKEYSCAN_VOICE,
1906 TP_ACPI_HOTKEYSCAN_UNK10,
1907 TP_ACPI_HOTKEYSCAN_GESTURES,
1908 TP_ACPI_HOTKEYSCAN_UNK11,
1909 TP_ACPI_HOTKEYSCAN_UNK12,
1910 TP_ACPI_HOTKEYSCAN_UNK13,
1911 TP_ACPI_HOTKEYSCAN_CONFIG,
1912 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1913 TP_ACPI_HOTKEYSCAN_RELOAD,
1914 TP_ACPI_HOTKEYSCAN_BACK,
1915 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1916 TP_ACPI_HOTKEYSCAN_MIC_UP,
1917 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1918 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1919 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1920
1921 /* Lenovo extended keymap, starting at 0x1300 */
1922 TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1923 /* first new observed key (star, favorites) is 0x1311 */
1924 TP_ACPI_HOTKEYSCAN_STAR = 69,
1925 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1926 TP_ACPI_HOTKEYSCAN_UNK25,
1927 TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1928 TP_ACPI_HOTKEYSCAN_KEYBOARD,
1929
1930 /* Hotkey keymap size */
1931 TPACPI_HOTKEY_MAP_LEN
1932};
1933
1934enum { /* Keys/events available through NVRAM polling */
1935 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1936 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1937};
1938
1939enum { /* Positions of some of the keys in hotkey masks */
1940 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1941 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1942 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1943 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1944 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1945 TP_ACPI_HKEY_KBD_LIGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1946 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1947 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1948 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1949 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1950 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1951};
1952
1953enum { /* NVRAM to ACPI HKEY group map */
1954 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1955 TP_ACPI_HKEY_ZOOM_MASK |
1956 TP_ACPI_HKEY_DISPSWTCH_MASK |
1957 TP_ACPI_HKEY_HIBERNATE_MASK,
1958 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1959 TP_ACPI_HKEY_BRGHTDWN_MASK,
1960 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1961 TP_ACPI_HKEY_VOLDWN_MASK |
1962 TP_ACPI_HKEY_MUTE_MASK,
1963};
1964
1965#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1966struct tp_nvram_state {
1967 u16 thinkpad_toggle:1;
1968 u16 zoom_toggle:1;
1969 u16 display_toggle:1;
1970 u16 thinklight_toggle:1;
1971 u16 hibernate_toggle:1;
1972 u16 displayexp_toggle:1;
1973 u16 display_state:1;
1974 u16 brightness_toggle:1;
1975 u16 volume_toggle:1;
1976 u16 mute:1;
1977
1978 u8 brightness_level;
1979 u8 volume_level;
1980};
1981
1982/* kthread for the hotkey poller */
1983static struct task_struct *tpacpi_hotkey_task;
1984
1985/*
1986 * Acquire mutex to write poller control variables as an
1987 * atomic block.
1988 *
1989 * Increment hotkey_config_change when changing them if you
1990 * want the kthread to forget old state.
1991 *
1992 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1993 */
1994static struct mutex hotkey_thread_data_mutex;
1995static unsigned int hotkey_config_change;
1996
1997/*
1998 * hotkey poller control variables
1999 *
2000 * Must be atomic or readers will also need to acquire mutex
2001 *
2002 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2003 * should be used only when the changes need to be taken as
2004 * a block, OR when one needs to force the kthread to forget
2005 * old state.
2006 */
2007static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2008static unsigned int hotkey_poll_freq = 10; /* Hz */
2009
2010#define HOTKEY_CONFIG_CRITICAL_START \
2011 do { \
2012 mutex_lock(&hotkey_thread_data_mutex); \
2013 hotkey_config_change++; \
2014 } while (0);
2015#define HOTKEY_CONFIG_CRITICAL_END \
2016 mutex_unlock(&hotkey_thread_data_mutex);
2017
2018#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2019
2020#define hotkey_source_mask 0U
2021#define HOTKEY_CONFIG_CRITICAL_START
2022#define HOTKEY_CONFIG_CRITICAL_END
2023
2024#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2025
2026static struct mutex hotkey_mutex;
2027
2028static enum { /* Reasons for waking up */
2029 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2030 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2031 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2032} hotkey_wakeup_reason;
2033
2034static int hotkey_autosleep_ack;
2035
2036static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2037static u32 hotkey_all_mask; /* all events supported in fw */
2038static u32 hotkey_adaptive_all_mask; /* all adaptive events supported in fw */
2039static u32 hotkey_reserved_mask; /* events better left disabled */
2040static u32 hotkey_driver_mask; /* events needed by the driver */
2041static u32 hotkey_user_mask; /* events visible to userspace */
2042static u32 hotkey_acpi_mask; /* events enabled in firmware */
2043
2044static u16 *hotkey_keycode_map;
2045
2046static struct attribute_set *hotkey_dev_attributes;
2047
2048static void tpacpi_driver_event(const unsigned int hkey_event);
2049static void hotkey_driver_event(const unsigned int scancode);
2050static void hotkey_poll_setup(const bool may_warn);
2051
2052/* HKEY.MHKG() return bits */
2053#define TP_HOTKEY_TABLET_MASK (1 << 3)
2054enum {
2055 TP_ACPI_MULTI_MODE_INVALID = 0,
2056 TP_ACPI_MULTI_MODE_UNKNOWN = 1 << 0,
2057 TP_ACPI_MULTI_MODE_LAPTOP = 1 << 1,
2058 TP_ACPI_MULTI_MODE_TABLET = 1 << 2,
2059 TP_ACPI_MULTI_MODE_FLAT = 1 << 3,
2060 TP_ACPI_MULTI_MODE_STAND = 1 << 4,
2061 TP_ACPI_MULTI_MODE_TENT = 1 << 5,
2062 TP_ACPI_MULTI_MODE_STAND_TENT = 1 << 6,
2063};
2064
2065enum {
2066 /* The following modes are considered tablet mode for the purpose of
2067 * reporting the status to userspace. i.e. in all these modes it makes
2068 * sense to disable the laptop input devices such as touchpad and
2069 * keyboard.
2070 */
2071 TP_ACPI_MULTI_MODE_TABLET_LIKE = TP_ACPI_MULTI_MODE_TABLET |
2072 TP_ACPI_MULTI_MODE_STAND |
2073 TP_ACPI_MULTI_MODE_TENT |
2074 TP_ACPI_MULTI_MODE_STAND_TENT,
2075};
2076
2077static int hotkey_get_wlsw(void)
2078{
2079 int status;
2080
2081 if (!tp_features.hotkey_wlsw)
2082 return -ENODEV;
2083
2084#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2085 if (dbg_wlswemul)
2086 return (tpacpi_wlsw_emulstate) ?
2087 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2088#endif
2089
2090 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2091 return -EIO;
2092
2093 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2094}
2095
2096static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
2097{
2098 int type = (s >> 16) & 0xffff;
2099 int value = s & 0xffff;
2100 int mode = TP_ACPI_MULTI_MODE_INVALID;
2101 int valid_modes = 0;
2102
2103 if (has_tablet_mode)
2104 *has_tablet_mode = 0;
2105
2106 switch (type) {
2107 case 1:
2108 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2109 TP_ACPI_MULTI_MODE_TABLET |
2110 TP_ACPI_MULTI_MODE_STAND_TENT;
2111 break;
2112 case 2:
2113 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2114 TP_ACPI_MULTI_MODE_FLAT |
2115 TP_ACPI_MULTI_MODE_TABLET |
2116 TP_ACPI_MULTI_MODE_STAND |
2117 TP_ACPI_MULTI_MODE_TENT;
2118 break;
2119 case 3:
2120 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2121 TP_ACPI_MULTI_MODE_FLAT;
2122 break;
2123 case 4:
2124 case 5:
2125 /* In mode 4, FLAT is not specified as a valid mode. However,
2126 * it can be seen at least on the X1 Yoga 2nd Generation.
2127 */
2128 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2129 TP_ACPI_MULTI_MODE_FLAT |
2130 TP_ACPI_MULTI_MODE_TABLET |
2131 TP_ACPI_MULTI_MODE_STAND |
2132 TP_ACPI_MULTI_MODE_TENT;
2133 break;
2134 default:
2135 pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
2136 type, value, TPACPI_MAIL);
2137 return 0;
2138 }
2139
2140 if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
2141 *has_tablet_mode = 1;
2142
2143 switch (value) {
2144 case 1:
2145 mode = TP_ACPI_MULTI_MODE_LAPTOP;
2146 break;
2147 case 2:
2148 mode = TP_ACPI_MULTI_MODE_FLAT;
2149 break;
2150 case 3:
2151 mode = TP_ACPI_MULTI_MODE_TABLET;
2152 break;
2153 case 4:
2154 if (type == 1)
2155 mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2156 else
2157 mode = TP_ACPI_MULTI_MODE_STAND;
2158 break;
2159 case 5:
2160 mode = TP_ACPI_MULTI_MODE_TENT;
2161 break;
2162 default:
2163 if (type == 5 && value == 0xffff) {
2164 pr_warn("Multi mode status is undetected, assuming laptop\n");
2165 return 0;
2166 }
2167 }
2168
2169 if (!(mode & valid_modes)) {
2170 pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2171 value, type, TPACPI_MAIL);
2172 return 0;
2173 }
2174
2175 return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2176}
2177
2178static int hotkey_get_tablet_mode(int *status)
2179{
2180 int s;
2181
2182 switch (tp_features.hotkey_tablet) {
2183 case TP_HOTKEY_TABLET_USES_MHKG:
2184 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2185 return -EIO;
2186
2187 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2188 break;
2189 case TP_HOTKEY_TABLET_USES_GMMS:
2190 if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2191 return -EIO;
2192
2193 *status = hotkey_gmms_get_tablet_mode(s, NULL);
2194 break;
2195 default:
2196 break;
2197 }
2198
2199 return 0;
2200}
2201
2202/*
2203 * Reads current event mask from firmware, and updates
2204 * hotkey_acpi_mask accordingly. Also resets any bits
2205 * from hotkey_user_mask that are unavailable to be
2206 * delivered (shadow requirement of the userspace ABI).
2207 *
2208 * Call with hotkey_mutex held
2209 */
2210static int hotkey_mask_get(void)
2211{
2212 if (tp_features.hotkey_mask) {
2213 u32 m = 0;
2214
2215 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2216 return -EIO;
2217
2218 hotkey_acpi_mask = m;
2219 } else {
2220 /* no mask support doesn't mean no event support... */
2221 hotkey_acpi_mask = hotkey_all_mask;
2222 }
2223
2224 /* sync userspace-visible mask */
2225 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2226
2227 return 0;
2228}
2229
2230static void hotkey_mask_warn_incomplete_mask(void)
2231{
2232 /* log only what the user can fix... */
2233 const u32 wantedmask = hotkey_driver_mask &
2234 ~(hotkey_acpi_mask | hotkey_source_mask) &
2235 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2236
2237 if (wantedmask)
2238 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2239}
2240
2241/*
2242 * Set the firmware mask when supported
2243 *
2244 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2245 *
2246 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2247 *
2248 * Call with hotkey_mutex held
2249 */
2250static int hotkey_mask_set(u32 mask)
2251{
2252 int i;
2253 int rc = 0;
2254
2255 const u32 fwmask = mask & ~hotkey_source_mask;
2256
2257 if (tp_features.hotkey_mask) {
2258 for (i = 0; i < 32; i++) {
2259 if (!acpi_evalf(hkey_handle,
2260 NULL, "MHKM", "vdd", i + 1,
2261 !!(mask & (1 << i)))) {
2262 rc = -EIO;
2263 break;
2264 }
2265 }
2266 }
2267
2268 /*
2269 * We *must* make an inconditional call to hotkey_mask_get to
2270 * refresh hotkey_acpi_mask and update hotkey_user_mask
2271 *
2272 * Take the opportunity to also log when we cannot _enable_
2273 * a given event.
2274 */
2275 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2276 pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2277 fwmask, hotkey_acpi_mask);
2278 }
2279
2280 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2281 hotkey_mask_warn_incomplete_mask();
2282
2283 return rc;
2284}
2285
2286/*
2287 * Sets hotkey_user_mask and tries to set the firmware mask
2288 *
2289 * Call with hotkey_mutex held
2290 */
2291static int hotkey_user_mask_set(const u32 mask)
2292{
2293 int rc;
2294
2295 /* Give people a chance to notice they are doing something that
2296 * is bound to go boom on their users sooner or later */
2297 if (!tp_warned.hotkey_mask_ff &&
2298 (mask == 0xffff || mask == 0xffffff ||
2299 mask == 0xffffffff)) {
2300 tp_warned.hotkey_mask_ff = 1;
2301 pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2302 mask);
2303 pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2304 }
2305
2306 /* Try to enable what the user asked for, plus whatever we need.
2307 * this syncs everything but won't enable bits in hotkey_user_mask */
2308 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2309
2310 /* Enable the available bits in hotkey_user_mask */
2311 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2312
2313 return rc;
2314}
2315
2316/*
2317 * Sets the driver hotkey mask.
2318 *
2319 * Can be called even if the hotkey subdriver is inactive
2320 */
2321static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2322{
2323 int rc;
2324
2325 /* Do the right thing if hotkey_init has not been called yet */
2326 if (!tp_features.hotkey) {
2327 hotkey_driver_mask = mask;
2328 return 0;
2329 }
2330
2331 mutex_lock(&hotkey_mutex);
2332
2333 HOTKEY_CONFIG_CRITICAL_START
2334 hotkey_driver_mask = mask;
2335#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2336 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2337#endif
2338 HOTKEY_CONFIG_CRITICAL_END
2339
2340 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2341 ~hotkey_source_mask);
2342 hotkey_poll_setup(true);
2343
2344 mutex_unlock(&hotkey_mutex);
2345
2346 return rc;
2347}
2348
2349static int hotkey_status_get(int *status)
2350{
2351 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2352 return -EIO;
2353
2354 return 0;
2355}
2356
2357static int hotkey_status_set(bool enable)
2358{
2359 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2360 return -EIO;
2361
2362 return 0;
2363}
2364
2365static void tpacpi_input_send_tabletsw(void)
2366{
2367 int state;
2368
2369 if (tp_features.hotkey_tablet &&
2370 !hotkey_get_tablet_mode(&state)) {
2371 mutex_lock(&tpacpi_inputdev_send_mutex);
2372
2373 input_report_switch(tpacpi_inputdev,
2374 SW_TABLET_MODE, !!state);
2375 input_sync(tpacpi_inputdev);
2376
2377 mutex_unlock(&tpacpi_inputdev_send_mutex);
2378 }
2379}
2380
2381/* Do NOT call without validating scancode first */
2382static void tpacpi_input_send_key(const unsigned int scancode)
2383{
2384 const unsigned int keycode = hotkey_keycode_map[scancode];
2385
2386 if (keycode != KEY_RESERVED) {
2387 mutex_lock(&tpacpi_inputdev_send_mutex);
2388
2389 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2390 input_report_key(tpacpi_inputdev, keycode, 1);
2391 input_sync(tpacpi_inputdev);
2392
2393 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2394 input_report_key(tpacpi_inputdev, keycode, 0);
2395 input_sync(tpacpi_inputdev);
2396
2397 mutex_unlock(&tpacpi_inputdev_send_mutex);
2398 }
2399}
2400
2401/* Do NOT call without validating scancode first */
2402static void tpacpi_input_send_key_masked(const unsigned int scancode)
2403{
2404 hotkey_driver_event(scancode);
2405 if (hotkey_user_mask & (1 << scancode))
2406 tpacpi_input_send_key(scancode);
2407}
2408
2409#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2410static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2411
2412/* Do NOT call without validating scancode first */
2413static void tpacpi_hotkey_send_key(unsigned int scancode)
2414{
2415 tpacpi_input_send_key_masked(scancode);
2416}
2417
2418static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2419{
2420 u8 d;
2421
2422 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2423 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2424 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2425 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2426 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2427 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2428 }
2429 if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2430 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2431 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2432 }
2433 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2434 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2435 n->displayexp_toggle =
2436 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2437 }
2438 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2439 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2440 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2441 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2442 n->brightness_toggle =
2443 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2444 }
2445 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2446 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2447 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2448 >> TP_NVRAM_POS_LEVEL_VOLUME;
2449 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2450 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2451 }
2452}
2453
2454#define TPACPI_COMPARE_KEY(__scancode, __member) \
2455do { \
2456 if ((event_mask & (1 << __scancode)) && \
2457 oldn->__member != newn->__member) \
2458 tpacpi_hotkey_send_key(__scancode); \
2459} while (0)
2460
2461#define TPACPI_MAY_SEND_KEY(__scancode) \
2462do { \
2463 if (event_mask & (1 << __scancode)) \
2464 tpacpi_hotkey_send_key(__scancode); \
2465} while (0)
2466
2467static void issue_volchange(const unsigned int oldvol,
2468 const unsigned int newvol,
2469 const u32 event_mask)
2470{
2471 unsigned int i = oldvol;
2472
2473 while (i > newvol) {
2474 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2475 i--;
2476 }
2477 while (i < newvol) {
2478 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2479 i++;
2480 }
2481}
2482
2483static void issue_brightnesschange(const unsigned int oldbrt,
2484 const unsigned int newbrt,
2485 const u32 event_mask)
2486{
2487 unsigned int i = oldbrt;
2488
2489 while (i > newbrt) {
2490 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2491 i--;
2492 }
2493 while (i < newbrt) {
2494 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2495 i++;
2496 }
2497}
2498
2499static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2500 struct tp_nvram_state *newn,
2501 const u32 event_mask)
2502{
2503
2504 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2505 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2506 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2507 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2508
2509 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2510
2511 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2512
2513 /*
2514 * Handle volume
2515 *
2516 * This code is supposed to duplicate the IBM firmware behaviour:
2517 * - Pressing MUTE issues mute hotkey message, even when already mute
2518 * - Pressing Volume up/down issues volume up/down hotkey messages,
2519 * even when already at maximum or minimum volume
2520 * - The act of unmuting issues volume up/down notification,
2521 * depending which key was used to unmute
2522 *
2523 * We are constrained to what the NVRAM can tell us, which is not much
2524 * and certainly not enough if more than one volume hotkey was pressed
2525 * since the last poll cycle.
2526 *
2527 * Just to make our life interesting, some newer Lenovo ThinkPads have
2528 * bugs in the BIOS and may fail to update volume_toggle properly.
2529 */
2530 if (newn->mute) {
2531 /* muted */
2532 if (!oldn->mute ||
2533 oldn->volume_toggle != newn->volume_toggle ||
2534 oldn->volume_level != newn->volume_level) {
2535 /* recently muted, or repeated mute keypress, or
2536 * multiple presses ending in mute */
2537 issue_volchange(oldn->volume_level, newn->volume_level,
2538 event_mask);
2539 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2540 }
2541 } else {
2542 /* unmute */
2543 if (oldn->mute) {
2544 /* recently unmuted, issue 'unmute' keypress */
2545 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2546 }
2547 if (oldn->volume_level != newn->volume_level) {
2548 issue_volchange(oldn->volume_level, newn->volume_level,
2549 event_mask);
2550 } else if (oldn->volume_toggle != newn->volume_toggle) {
2551 /* repeated vol up/down keypress at end of scale ? */
2552 if (newn->volume_level == 0)
2553 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2554 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2555 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2556 }
2557 }
2558
2559 /* handle brightness */
2560 if (oldn->brightness_level != newn->brightness_level) {
2561 issue_brightnesschange(oldn->brightness_level,
2562 newn->brightness_level, event_mask);
2563 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2564 /* repeated key presses that didn't change state */
2565 if (newn->brightness_level == 0)
2566 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2567 else if (newn->brightness_level >= bright_maxlvl
2568 && !tp_features.bright_unkfw)
2569 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2570 }
2571
2572#undef TPACPI_COMPARE_KEY
2573#undef TPACPI_MAY_SEND_KEY
2574}
2575
2576/*
2577 * Polling driver
2578 *
2579 * We track all events in hotkey_source_mask all the time, since
2580 * most of them are edge-based. We only issue those requested by
2581 * hotkey_user_mask or hotkey_driver_mask, though.
2582 */
2583static int hotkey_kthread(void *data)
2584{
2585 struct tp_nvram_state s[2];
2586 u32 poll_mask, event_mask;
2587 unsigned int si, so;
2588 unsigned long t;
2589 unsigned int change_detector;
2590 unsigned int poll_freq;
2591 bool was_frozen;
2592
2593 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2594 goto exit;
2595
2596 set_freezable();
2597
2598 so = 0;
2599 si = 1;
2600 t = 0;
2601
2602 /* Initial state for compares */
2603 mutex_lock(&hotkey_thread_data_mutex);
2604 change_detector = hotkey_config_change;
2605 poll_mask = hotkey_source_mask;
2606 event_mask = hotkey_source_mask &
2607 (hotkey_driver_mask | hotkey_user_mask);
2608 poll_freq = hotkey_poll_freq;
2609 mutex_unlock(&hotkey_thread_data_mutex);
2610 hotkey_read_nvram(&s[so], poll_mask);
2611
2612 while (!kthread_should_stop()) {
2613 if (t == 0) {
2614 if (likely(poll_freq))
2615 t = 1000/poll_freq;
2616 else
2617 t = 100; /* should never happen... */
2618 }
2619 t = msleep_interruptible(t);
2620 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2621 break;
2622
2623 if (t > 0 && !was_frozen)
2624 continue;
2625
2626 mutex_lock(&hotkey_thread_data_mutex);
2627 if (was_frozen || hotkey_config_change != change_detector) {
2628 /* forget old state on thaw or config change */
2629 si = so;
2630 t = 0;
2631 change_detector = hotkey_config_change;
2632 }
2633 poll_mask = hotkey_source_mask;
2634 event_mask = hotkey_source_mask &
2635 (hotkey_driver_mask | hotkey_user_mask);
2636 poll_freq = hotkey_poll_freq;
2637 mutex_unlock(&hotkey_thread_data_mutex);
2638
2639 if (likely(poll_mask)) {
2640 hotkey_read_nvram(&s[si], poll_mask);
2641 if (likely(si != so)) {
2642 hotkey_compare_and_issue_event(&s[so], &s[si],
2643 event_mask);
2644 }
2645 }
2646
2647 so = si;
2648 si ^= 1;
2649 }
2650
2651exit:
2652 return 0;
2653}
2654
2655/* call with hotkey_mutex held */
2656static void hotkey_poll_stop_sync(void)
2657{
2658 if (tpacpi_hotkey_task) {
2659 kthread_stop(tpacpi_hotkey_task);
2660 tpacpi_hotkey_task = NULL;
2661 }
2662}
2663
2664/* call with hotkey_mutex held */
2665static void hotkey_poll_setup(const bool may_warn)
2666{
2667 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2668 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2669
2670 if (hotkey_poll_freq > 0 &&
2671 (poll_driver_mask ||
2672 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2673 if (!tpacpi_hotkey_task) {
2674 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2675 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2676 if (IS_ERR(tpacpi_hotkey_task)) {
2677 tpacpi_hotkey_task = NULL;
2678 pr_err("could not create kernel thread for hotkey polling\n");
2679 }
2680 }
2681 } else {
2682 hotkey_poll_stop_sync();
2683 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2684 hotkey_poll_freq == 0) {
2685 pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2686 poll_user_mask, poll_driver_mask);
2687 }
2688 }
2689}
2690
2691static void hotkey_poll_setup_safe(const bool may_warn)
2692{
2693 mutex_lock(&hotkey_mutex);
2694 hotkey_poll_setup(may_warn);
2695 mutex_unlock(&hotkey_mutex);
2696}
2697
2698/* call with hotkey_mutex held */
2699static void hotkey_poll_set_freq(unsigned int freq)
2700{
2701 if (!freq)
2702 hotkey_poll_stop_sync();
2703
2704 hotkey_poll_freq = freq;
2705}
2706
2707#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2708
2709static void hotkey_poll_setup(const bool __unused)
2710{
2711}
2712
2713static void hotkey_poll_setup_safe(const bool __unused)
2714{
2715}
2716
2717#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2718
2719static int hotkey_inputdev_open(struct input_dev *dev)
2720{
2721 switch (tpacpi_lifecycle) {
2722 case TPACPI_LIFE_INIT:
2723 case TPACPI_LIFE_RUNNING:
2724 hotkey_poll_setup_safe(false);
2725 return 0;
2726 case TPACPI_LIFE_EXITING:
2727 return -EBUSY;
2728 }
2729
2730 /* Should only happen if tpacpi_lifecycle is corrupt */
2731 BUG();
2732 return -EBUSY;
2733}
2734
2735static void hotkey_inputdev_close(struct input_dev *dev)
2736{
2737 /* disable hotkey polling when possible */
2738 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2739 !(hotkey_source_mask & hotkey_driver_mask))
2740 hotkey_poll_setup_safe(false);
2741}
2742
2743/* sysfs hotkey enable ------------------------------------------------- */
2744static ssize_t hotkey_enable_show(struct device *dev,
2745 struct device_attribute *attr,
2746 char *buf)
2747{
2748 int res, status;
2749
2750 printk_deprecated_attribute("hotkey_enable",
2751 "Hotkey reporting is always enabled");
2752
2753 res = hotkey_status_get(&status);
2754 if (res)
2755 return res;
2756
2757 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2758}
2759
2760static ssize_t hotkey_enable_store(struct device *dev,
2761 struct device_attribute *attr,
2762 const char *buf, size_t count)
2763{
2764 unsigned long t;
2765
2766 printk_deprecated_attribute("hotkey_enable",
2767 "Hotkeys can be disabled through hotkey_mask");
2768
2769 if (parse_strtoul(buf, 1, &t))
2770 return -EINVAL;
2771
2772 if (t == 0)
2773 return -EPERM;
2774
2775 return count;
2776}
2777
2778static DEVICE_ATTR_RW(hotkey_enable);
2779
2780/* sysfs hotkey mask --------------------------------------------------- */
2781static ssize_t hotkey_mask_show(struct device *dev,
2782 struct device_attribute *attr,
2783 char *buf)
2784{
2785 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2786}
2787
2788static ssize_t hotkey_mask_store(struct device *dev,
2789 struct device_attribute *attr,
2790 const char *buf, size_t count)
2791{
2792 unsigned long t;
2793 int res;
2794
2795 if (parse_strtoul(buf, 0xffffffffUL, &t))
2796 return -EINVAL;
2797
2798 if (mutex_lock_killable(&hotkey_mutex))
2799 return -ERESTARTSYS;
2800
2801 res = hotkey_user_mask_set(t);
2802
2803#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2804 hotkey_poll_setup(true);
2805#endif
2806
2807 mutex_unlock(&hotkey_mutex);
2808
2809 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2810
2811 return (res) ? res : count;
2812}
2813
2814static DEVICE_ATTR_RW(hotkey_mask);
2815
2816/* sysfs hotkey bios_enabled ------------------------------------------- */
2817static ssize_t hotkey_bios_enabled_show(struct device *dev,
2818 struct device_attribute *attr,
2819 char *buf)
2820{
2821 return sprintf(buf, "0\n");
2822}
2823
2824static DEVICE_ATTR_RO(hotkey_bios_enabled);
2825
2826/* sysfs hotkey bios_mask ---------------------------------------------- */
2827static ssize_t hotkey_bios_mask_show(struct device *dev,
2828 struct device_attribute *attr,
2829 char *buf)
2830{
2831 printk_deprecated_attribute("hotkey_bios_mask",
2832 "This attribute is useless.");
2833 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2834}
2835
2836static DEVICE_ATTR_RO(hotkey_bios_mask);
2837
2838/* sysfs hotkey all_mask ----------------------------------------------- */
2839static ssize_t hotkey_all_mask_show(struct device *dev,
2840 struct device_attribute *attr,
2841 char *buf)
2842{
2843 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2844 hotkey_all_mask | hotkey_source_mask);
2845}
2846
2847static DEVICE_ATTR_RO(hotkey_all_mask);
2848
2849/* sysfs hotkey all_mask ----------------------------------------------- */
2850static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2851 struct device_attribute *attr,
2852 char *buf)
2853{
2854 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2855 hotkey_adaptive_all_mask | hotkey_source_mask);
2856}
2857
2858static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2859
2860/* sysfs hotkey recommended_mask --------------------------------------- */
2861static ssize_t hotkey_recommended_mask_show(struct device *dev,
2862 struct device_attribute *attr,
2863 char *buf)
2864{
2865 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2866 (hotkey_all_mask | hotkey_source_mask)
2867 & ~hotkey_reserved_mask);
2868}
2869
2870static DEVICE_ATTR_RO(hotkey_recommended_mask);
2871
2872#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2873
2874/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2875static ssize_t hotkey_source_mask_show(struct device *dev,
2876 struct device_attribute *attr,
2877 char *buf)
2878{
2879 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2880}
2881
2882static ssize_t hotkey_source_mask_store(struct device *dev,
2883 struct device_attribute *attr,
2884 const char *buf, size_t count)
2885{
2886 unsigned long t;
2887 u32 r_ev;
2888 int rc;
2889
2890 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2891 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2892 return -EINVAL;
2893
2894 if (mutex_lock_killable(&hotkey_mutex))
2895 return -ERESTARTSYS;
2896
2897 HOTKEY_CONFIG_CRITICAL_START
2898 hotkey_source_mask = t;
2899 HOTKEY_CONFIG_CRITICAL_END
2900
2901 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2902 ~hotkey_source_mask);
2903 hotkey_poll_setup(true);
2904
2905 /* check if events needed by the driver got disabled */
2906 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2907 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2908
2909 mutex_unlock(&hotkey_mutex);
2910
2911 if (rc < 0)
2912 pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2913
2914 if (r_ev)
2915 pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2916 r_ev);
2917
2918 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2919
2920 return (rc < 0) ? rc : count;
2921}
2922
2923static DEVICE_ATTR_RW(hotkey_source_mask);
2924
2925/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2926static ssize_t hotkey_poll_freq_show(struct device *dev,
2927 struct device_attribute *attr,
2928 char *buf)
2929{
2930 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2931}
2932
2933static ssize_t hotkey_poll_freq_store(struct device *dev,
2934 struct device_attribute *attr,
2935 const char *buf, size_t count)
2936{
2937 unsigned long t;
2938
2939 if (parse_strtoul(buf, 25, &t))
2940 return -EINVAL;
2941
2942 if (mutex_lock_killable(&hotkey_mutex))
2943 return -ERESTARTSYS;
2944
2945 hotkey_poll_set_freq(t);
2946 hotkey_poll_setup(true);
2947
2948 mutex_unlock(&hotkey_mutex);
2949
2950 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2951
2952 return count;
2953}
2954
2955static DEVICE_ATTR_RW(hotkey_poll_freq);
2956
2957#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2958
2959/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2960static ssize_t hotkey_radio_sw_show(struct device *dev,
2961 struct device_attribute *attr,
2962 char *buf)
2963{
2964 int res;
2965 res = hotkey_get_wlsw();
2966 if (res < 0)
2967 return res;
2968
2969 /* Opportunistic update */
2970 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2971
2972 return snprintf(buf, PAGE_SIZE, "%d\n",
2973 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2974}
2975
2976static DEVICE_ATTR_RO(hotkey_radio_sw);
2977
2978static void hotkey_radio_sw_notify_change(void)
2979{
2980 if (tp_features.hotkey_wlsw)
2981 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2982 "hotkey_radio_sw");
2983}
2984
2985/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2986static ssize_t hotkey_tablet_mode_show(struct device *dev,
2987 struct device_attribute *attr,
2988 char *buf)
2989{
2990 int res, s;
2991 res = hotkey_get_tablet_mode(&s);
2992 if (res < 0)
2993 return res;
2994
2995 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2996}
2997
2998static DEVICE_ATTR_RO(hotkey_tablet_mode);
2999
3000static void hotkey_tablet_mode_notify_change(void)
3001{
3002 if (tp_features.hotkey_tablet)
3003 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3004 "hotkey_tablet_mode");
3005}
3006
3007/* sysfs wakeup reason (pollable) -------------------------------------- */
3008static ssize_t hotkey_wakeup_reason_show(struct device *dev,
3009 struct device_attribute *attr,
3010 char *buf)
3011{
3012 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
3013}
3014
3015static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
3016
3017static void hotkey_wakeup_reason_notify_change(void)
3018{
3019 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3020 "wakeup_reason");
3021}
3022
3023/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
3024static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
3025 struct device_attribute *attr,
3026 char *buf)
3027{
3028 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
3029}
3030
3031static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
3032 hotkey_wakeup_hotunplug_complete_show, NULL);
3033
3034static void hotkey_wakeup_hotunplug_complete_notify_change(void)
3035{
3036 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3037 "wakeup_hotunplug_complete");
3038}
3039
3040/* sysfs adaptive kbd mode --------------------------------------------- */
3041
3042static int adaptive_keyboard_get_mode(void);
3043static int adaptive_keyboard_set_mode(int new_mode);
3044
3045enum ADAPTIVE_KEY_MODE {
3046 HOME_MODE,
3047 WEB_BROWSER_MODE,
3048 WEB_CONFERENCE_MODE,
3049 FUNCTION_MODE,
3050 LAYFLAT_MODE
3051};
3052
3053static ssize_t adaptive_kbd_mode_show(struct device *dev,
3054 struct device_attribute *attr,
3055 char *buf)
3056{
3057 int current_mode;
3058
3059 current_mode = adaptive_keyboard_get_mode();
3060 if (current_mode < 0)
3061 return current_mode;
3062
3063 return snprintf(buf, PAGE_SIZE, "%d\n", current_mode);
3064}
3065
3066static ssize_t adaptive_kbd_mode_store(struct device *dev,
3067 struct device_attribute *attr,
3068 const char *buf, size_t count)
3069{
3070 unsigned long t;
3071 int res;
3072
3073 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
3074 return -EINVAL;
3075
3076 res = adaptive_keyboard_set_mode(t);
3077 return (res < 0) ? res : count;
3078}
3079
3080static DEVICE_ATTR_RW(adaptive_kbd_mode);
3081
3082static struct attribute *adaptive_kbd_attributes[] = {
3083 &dev_attr_adaptive_kbd_mode.attr,
3084 NULL
3085};
3086
3087static const struct attribute_group adaptive_kbd_attr_group = {
3088 .attrs = adaptive_kbd_attributes,
3089};
3090
3091/* --------------------------------------------------------------------- */
3092
3093static struct attribute *hotkey_attributes[] __initdata = {
3094 &dev_attr_hotkey_enable.attr,
3095 &dev_attr_hotkey_bios_enabled.attr,
3096 &dev_attr_hotkey_bios_mask.attr,
3097 &dev_attr_wakeup_reason.attr,
3098 &dev_attr_wakeup_hotunplug_complete.attr,
3099 &dev_attr_hotkey_mask.attr,
3100 &dev_attr_hotkey_all_mask.attr,
3101 &dev_attr_hotkey_adaptive_all_mask.attr,
3102 &dev_attr_hotkey_recommended_mask.attr,
3103#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3104 &dev_attr_hotkey_source_mask.attr,
3105 &dev_attr_hotkey_poll_freq.attr,
3106#endif
3107};
3108
3109/*
3110 * Sync both the hw and sw blocking state of all switches
3111 */
3112static void tpacpi_send_radiosw_update(void)
3113{
3114 int wlsw;
3115
3116 /*
3117 * We must sync all rfkill controllers *before* issuing any
3118 * rfkill input events, or we will race the rfkill core input
3119 * handler.
3120 *
3121 * tpacpi_inputdev_send_mutex works as a synchronization point
3122 * for the above.
3123 *
3124 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3125 */
3126
3127 wlsw = hotkey_get_wlsw();
3128
3129 /* Sync hw blocking state first if it is hw-blocked */
3130 if (wlsw == TPACPI_RFK_RADIO_OFF)
3131 tpacpi_rfk_update_hwblock_state(true);
3132
3133 /* Sync sw blocking state */
3134 tpacpi_rfk_update_swstate_all();
3135
3136 /* Sync hw blocking state last if it is hw-unblocked */
3137 if (wlsw == TPACPI_RFK_RADIO_ON)
3138 tpacpi_rfk_update_hwblock_state(false);
3139
3140 /* Issue rfkill input event for WLSW switch */
3141 if (!(wlsw < 0)) {
3142 mutex_lock(&tpacpi_inputdev_send_mutex);
3143
3144 input_report_switch(tpacpi_inputdev,
3145 SW_RFKILL_ALL, (wlsw > 0));
3146 input_sync(tpacpi_inputdev);
3147
3148 mutex_unlock(&tpacpi_inputdev_send_mutex);
3149 }
3150
3151 /*
3152 * this can be unconditional, as we will poll state again
3153 * if userspace uses the notify to read data
3154 */
3155 hotkey_radio_sw_notify_change();
3156}
3157
3158static void hotkey_exit(void)
3159{
3160#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3161 mutex_lock(&hotkey_mutex);
3162 hotkey_poll_stop_sync();
3163 mutex_unlock(&hotkey_mutex);
3164#endif
3165
3166 if (hotkey_dev_attributes)
3167 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3168
3169 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3170 "restoring original HKEY status and mask\n");
3171 /* yes, there is a bitwise or below, we want the
3172 * functions to be called even if one of them fail */
3173 if (((tp_features.hotkey_mask &&
3174 hotkey_mask_set(hotkey_orig_mask)) |
3175 hotkey_status_set(false)) != 0)
3176 pr_err("failed to restore hot key mask to BIOS defaults\n");
3177}
3178
3179static void __init hotkey_unmap(const unsigned int scancode)
3180{
3181 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3182 clear_bit(hotkey_keycode_map[scancode],
3183 tpacpi_inputdev->keybit);
3184 hotkey_keycode_map[scancode] = KEY_RESERVED;
3185 }
3186}
3187
3188/*
3189 * HKEY quirks:
3190 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3191 */
3192
3193#define TPACPI_HK_Q_INIMASK 0x0001
3194
3195static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3196 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3197 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3198 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3199 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3200 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3201 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3202 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3203 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3204 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3205 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3206 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3207 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3208 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3209 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3210 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3211 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3212 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3213 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3214 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3215};
3216
3217typedef u16 tpacpi_keymap_entry_t;
3218typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3219
3220static int hotkey_init_tablet_mode(void)
3221{
3222 int in_tablet_mode = 0, res;
3223 char *type = NULL;
3224
3225 if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3226 int has_tablet_mode;
3227
3228 in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3229 &has_tablet_mode);
3230 if (has_tablet_mode)
3231 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3232 type = "GMMS";
3233 } else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3234 /* For X41t, X60t, X61t Tablets... */
3235 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3236 in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3237 type = "MHKG";
3238 }
3239
3240 if (!tp_features.hotkey_tablet)
3241 return 0;
3242
3243 pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3244 type, in_tablet_mode ? "tablet" : "laptop");
3245
3246 res = add_to_attr_set(hotkey_dev_attributes,
3247 &dev_attr_hotkey_tablet_mode.attr);
3248 if (res)
3249 return -1;
3250
3251 return in_tablet_mode;
3252}
3253
3254static int __init hotkey_init(struct ibm_init_struct *iibm)
3255{
3256 /* Requirements for changing the default keymaps:
3257 *
3258 * 1. Many of the keys are mapped to KEY_RESERVED for very
3259 * good reasons. Do not change them unless you have deep
3260 * knowledge on the IBM and Lenovo ThinkPad firmware for
3261 * the various ThinkPad models. The driver behaves
3262 * differently for KEY_RESERVED: such keys have their
3263 * hot key mask *unset* in mask_recommended, and also
3264 * in the initial hot key mask programmed into the
3265 * firmware at driver load time, which means the firm-
3266 * ware may react very differently if you change them to
3267 * something else;
3268 *
3269 * 2. You must be subscribed to the linux-thinkpad and
3270 * ibm-acpi-devel mailing lists, and you should read the
3271 * list archives since 2007 if you want to change the
3272 * keymaps. This requirement exists so that you will
3273 * know the past history of problems with the thinkpad-
3274 * acpi driver keymaps, and also that you will be
3275 * listening to any bug reports;
3276 *
3277 * 3. Do not send thinkpad-acpi specific patches directly to
3278 * for merging, *ever*. Send them to the linux-acpi
3279 * mailinglist for comments. Merging is to be done only
3280 * through acpi-test and the ACPI maintainer.
3281 *
3282 * If the above is too much to ask, don't change the keymap.
3283 * Ask the thinkpad-acpi maintainer to do it, instead.
3284 */
3285
3286 enum keymap_index {
3287 TPACPI_KEYMAP_IBM_GENERIC = 0,
3288 TPACPI_KEYMAP_LENOVO_GENERIC,
3289 };
3290
3291 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3292 /* Generic keymap for IBM ThinkPads */
3293 [TPACPI_KEYMAP_IBM_GENERIC] = {
3294 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3295 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3296 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3297 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3298
3299 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3300 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3301 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3302 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3303
3304 /* brightness: firmware always reacts to them */
3305 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3306 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3307
3308 /* Thinklight: firmware always react to it */
3309 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3310
3311 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3312 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3313
3314 /* Volume: firmware always react to it and reprograms
3315 * the built-in *extra* mixer. Never map it to control
3316 * another mixer by default. */
3317 KEY_RESERVED, /* 0x14: VOLUME UP */
3318 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3319 KEY_RESERVED, /* 0x16: MUTE */
3320
3321 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3322
3323 /* (assignments unknown, please report if found) */
3324 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3325 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3326
3327 /* No assignments, only used for Adaptive keyboards. */
3328 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3329 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3330 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3331 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3332 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3333
3334 /* No assignment, used for newer Lenovo models */
3335 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3336 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3337 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3338 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3339 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3340 KEY_UNKNOWN, KEY_UNKNOWN
3341
3342 },
3343
3344 /* Generic keymap for Lenovo ThinkPads */
3345 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3346 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3347 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3348 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3349 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3350
3351 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3352 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3353 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3354 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3355
3356 /* These should be enabled --only-- when ACPI video
3357 * is disabled (i.e. in "vendor" mode), and are handled
3358 * in a special way by the init code */
3359 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3360 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3361
3362 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3363
3364 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3365 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3366
3367 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3368 * react to it and reprograms the built-in *extra* mixer.
3369 * Never map it to control another mixer by default.
3370 *
3371 * T60?, T61, R60?, R61: firmware and EC tries to send
3372 * these over the regular keyboard, so these are no-ops,
3373 * but there are still weird bugs re. MUTE, so do not
3374 * change unless you get test reports from all Lenovo
3375 * models. May cause the BIOS to interfere with the
3376 * HDA mixer.
3377 */
3378 KEY_RESERVED, /* 0x14: VOLUME UP */
3379 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3380 KEY_RESERVED, /* 0x16: MUTE */
3381
3382 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3383
3384 /* (assignments unknown, please report if found) */
3385 KEY_UNKNOWN, KEY_UNKNOWN,
3386
3387 /*
3388 * The mic mute button only sends 0x1a. It does not
3389 * automatically mute the mic or change the mute light.
3390 */
3391 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3392
3393 /* (assignments unknown, please report if found) */
3394 KEY_UNKNOWN,
3395
3396 /* Extra keys in use since the X240 / T440 / T540 */
3397 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3398
3399 /*
3400 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3401 * The first item in this list is the Mute button which is
3402 * emitted with 0x103 through
3403 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3404 * symbol is held.
3405 * We'll need to offset those by 0x20.
3406 */
3407 KEY_RESERVED, /* Mute held, 0x103 */
3408 KEY_BRIGHTNESS_MIN, /* Backlight off */
3409 KEY_RESERVED, /* Clipping tool */
3410 KEY_RESERVED, /* Cloud */
3411 KEY_RESERVED,
3412 KEY_VOICECOMMAND, /* Voice */
3413 KEY_RESERVED,
3414 KEY_RESERVED, /* Gestures */
3415 KEY_RESERVED,
3416 KEY_RESERVED,
3417 KEY_RESERVED,
3418 KEY_CONFIG, /* Settings */
3419 KEY_RESERVED, /* New tab */
3420 KEY_REFRESH, /* Reload */
3421 KEY_BACK, /* Back */
3422 KEY_RESERVED, /* Microphone down */
3423 KEY_RESERVED, /* Microphone up */
3424 KEY_RESERVED, /* Microphone cancellation */
3425 KEY_RESERVED, /* Camera mode */
3426 KEY_RESERVED, /* Rotate display, 0x116 */
3427
3428 /*
3429 * These are found in 2017 models (e.g. T470s, X270).
3430 * The lowest known value is 0x311, which according to
3431 * the manual should launch a user defined favorite
3432 * application.
3433 *
3434 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3435 * corresponding to 0x34.
3436 */
3437
3438 /* (assignments unknown, please report if found) */
3439 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3440 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3441 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3442 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3443 KEY_UNKNOWN,
3444
3445 KEY_FAVORITES, /* Favorite app, 0x311 */
3446 KEY_RESERVED, /* Clipping tool */
3447 KEY_RESERVED,
3448 KEY_BLUETOOTH, /* Bluetooth */
3449 KEY_KEYBOARD /* Keyboard, 0x315 */
3450 },
3451 };
3452
3453 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3454 /* Generic maps (fallback) */
3455 {
3456 .vendor = PCI_VENDOR_ID_IBM,
3457 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3458 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3459 },
3460 {
3461 .vendor = PCI_VENDOR_ID_LENOVO,
3462 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3463 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3464 },
3465 };
3466
3467#define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3468#define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3469
3470 int res, i;
3471 int status;
3472 int hkeyv;
3473 bool radiosw_state = false;
3474 bool tabletsw_state = false;
3475
3476 unsigned long quirks;
3477 unsigned long keymap_id;
3478
3479 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3480 "initializing hotkey subdriver\n");
3481
3482 BUG_ON(!tpacpi_inputdev);
3483 BUG_ON(tpacpi_inputdev->open != NULL ||
3484 tpacpi_inputdev->close != NULL);
3485
3486 TPACPI_ACPIHANDLE_INIT(hkey);
3487 mutex_init(&hotkey_mutex);
3488
3489#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3490 mutex_init(&hotkey_thread_data_mutex);
3491#endif
3492
3493 /* hotkey not supported on 570 */
3494 tp_features.hotkey = hkey_handle != NULL;
3495
3496 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3497 "hotkeys are %s\n",
3498 str_supported(tp_features.hotkey));
3499
3500 if (!tp_features.hotkey)
3501 return 1;
3502
3503 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3504 ARRAY_SIZE(tpacpi_hotkey_qtable));
3505
3506 tpacpi_disable_brightness_delay();
3507
3508 /* MUST have enough space for all attributes to be added to
3509 * hotkey_dev_attributes */
3510 hotkey_dev_attributes = create_attr_set(
3511 ARRAY_SIZE(hotkey_attributes) + 2,
3512 NULL);
3513 if (!hotkey_dev_attributes)
3514 return -ENOMEM;
3515 res = add_many_to_attr_set(hotkey_dev_attributes,
3516 hotkey_attributes,
3517 ARRAY_SIZE(hotkey_attributes));
3518 if (res)
3519 goto err_exit;
3520
3521 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3522 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3523 for HKEY interface version 0x100 */
3524 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3525 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3526 "firmware HKEY interface version: 0x%x\n",
3527 hkeyv);
3528
3529 switch (hkeyv >> 8) {
3530 case 1:
3531 /*
3532 * MHKV 0x100 in A31, R40, R40e,
3533 * T4x, X31, and later
3534 */
3535
3536 /* Paranoia check AND init hotkey_all_mask */
3537 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3538 "MHKA", "qd")) {
3539 pr_err("missing MHKA handler, please report this to %s\n",
3540 TPACPI_MAIL);
3541 /* Fallback: pre-init for FN+F3,F4,F12 */
3542 hotkey_all_mask = 0x080cU;
3543 } else {
3544 tp_features.hotkey_mask = 1;
3545 }
3546 break;
3547
3548 case 2:
3549 /*
3550 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3551 */
3552
3553 /* Paranoia check AND init hotkey_all_mask */
3554 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3555 "MHKA", "dd", 1)) {
3556 pr_err("missing MHKA handler, please report this to %s\n",
3557 TPACPI_MAIL);
3558 /* Fallback: pre-init for FN+F3,F4,F12 */
3559 hotkey_all_mask = 0x080cU;
3560 } else {
3561 tp_features.hotkey_mask = 1;
3562 }
3563
3564 /*
3565 * Check if we have an adaptive keyboard, like on the
3566 * Lenovo Carbon X1 2014 (2nd Gen).
3567 */
3568 if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3569 "MHKA", "dd", 2)) {
3570 if (hotkey_adaptive_all_mask != 0) {
3571 tp_features.has_adaptive_kbd = true;
3572 res = sysfs_create_group(
3573 &tpacpi_pdev->dev.kobj,
3574 &adaptive_kbd_attr_group);
3575 if (res)
3576 goto err_exit;
3577 }
3578 } else {
3579 tp_features.has_adaptive_kbd = false;
3580 hotkey_adaptive_all_mask = 0x0U;
3581 }
3582 break;
3583
3584 default:
3585 pr_err("unknown version of the HKEY interface: 0x%x\n",
3586 hkeyv);
3587 pr_err("please report this to %s\n", TPACPI_MAIL);
3588 break;
3589 }
3590 }
3591
3592 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3593 "hotkey masks are %s\n",
3594 str_supported(tp_features.hotkey_mask));
3595
3596 /* Init hotkey_all_mask if not initialized yet */
3597 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3598 (quirks & TPACPI_HK_Q_INIMASK))
3599 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3600
3601 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3602 if (tp_features.hotkey_mask) {
3603 /* hotkey_source_mask *must* be zero for
3604 * the first hotkey_mask_get to return hotkey_orig_mask */
3605 res = hotkey_mask_get();
3606 if (res)
3607 goto err_exit;
3608
3609 hotkey_orig_mask = hotkey_acpi_mask;
3610 } else {
3611 hotkey_orig_mask = hotkey_all_mask;
3612 hotkey_acpi_mask = hotkey_all_mask;
3613 }
3614
3615#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3616 if (dbg_wlswemul) {
3617 tp_features.hotkey_wlsw = 1;
3618 radiosw_state = !!tpacpi_wlsw_emulstate;
3619 pr_info("radio switch emulation enabled\n");
3620 } else
3621#endif
3622 /* Not all thinkpads have a hardware radio switch */
3623 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3624 tp_features.hotkey_wlsw = 1;
3625 radiosw_state = !!status;
3626 pr_info("radio switch found; radios are %s\n",
3627 enabled(status, 0));
3628 }
3629 if (tp_features.hotkey_wlsw)
3630 res = add_to_attr_set(hotkey_dev_attributes,
3631 &dev_attr_hotkey_radio_sw.attr);
3632
3633 res = hotkey_init_tablet_mode();
3634 if (res < 0)
3635 goto err_exit;
3636
3637 tabletsw_state = res;
3638
3639 res = register_attr_set_with_sysfs(hotkey_dev_attributes,
3640 &tpacpi_pdev->dev.kobj);
3641 if (res)
3642 goto err_exit;
3643
3644 /* Set up key map */
3645 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3646 GFP_KERNEL);
3647 if (!hotkey_keycode_map) {
3648 pr_err("failed to allocate memory for key map\n");
3649 res = -ENOMEM;
3650 goto err_exit;
3651 }
3652
3653 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3654 ARRAY_SIZE(tpacpi_keymap_qtable));
3655 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3656 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3657 "using keymap number %lu\n", keymap_id);
3658
3659 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3660 TPACPI_HOTKEY_MAP_SIZE);
3661
3662 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3663 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3664 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3665 tpacpi_inputdev->keycode = hotkey_keycode_map;
3666 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3667 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3668 input_set_capability(tpacpi_inputdev, EV_KEY,
3669 hotkey_keycode_map[i]);
3670 } else {
3671 if (i < sizeof(hotkey_reserved_mask)*8)
3672 hotkey_reserved_mask |= 1 << i;
3673 }
3674 }
3675
3676 if (tp_features.hotkey_wlsw) {
3677 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3678 input_report_switch(tpacpi_inputdev,
3679 SW_RFKILL_ALL, radiosw_state);
3680 }
3681 if (tp_features.hotkey_tablet) {
3682 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3683 input_report_switch(tpacpi_inputdev,
3684 SW_TABLET_MODE, tabletsw_state);
3685 }
3686
3687 /* Do not issue duplicate brightness change events to
3688 * userspace. tpacpi_detect_brightness_capabilities() must have
3689 * been called before this point */
3690 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3691 pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3692 pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3693
3694 /* Disable brightness up/down on Lenovo thinkpads when
3695 * ACPI is handling them, otherwise it is plain impossible
3696 * for userspace to do something even remotely sane */
3697 hotkey_reserved_mask |=
3698 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3699 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3700 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3701 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3702 }
3703
3704#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3705 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3706 & ~hotkey_all_mask
3707 & ~hotkey_reserved_mask;
3708
3709 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3710 "hotkey source mask 0x%08x, polling freq %u\n",
3711 hotkey_source_mask, hotkey_poll_freq);
3712#endif
3713
3714 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3715 "enabling firmware HKEY event interface...\n");
3716 res = hotkey_status_set(true);
3717 if (res) {
3718 hotkey_exit();
3719 return res;
3720 }
3721 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3722 | hotkey_driver_mask)
3723 & ~hotkey_source_mask);
3724 if (res < 0 && res != -ENXIO) {
3725 hotkey_exit();
3726 return res;
3727 }
3728 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3729 & ~hotkey_reserved_mask;
3730 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3731 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3732 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3733
3734 tpacpi_inputdev->open = &hotkey_inputdev_open;
3735 tpacpi_inputdev->close = &hotkey_inputdev_close;
3736
3737 hotkey_poll_setup_safe(true);
3738
3739 return 0;
3740
3741err_exit:
3742 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3743 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3744 &adaptive_kbd_attr_group);
3745
3746 hotkey_dev_attributes = NULL;
3747
3748 return (res < 0) ? res : 1;
3749}
3750
3751/* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3752 * mode, Web conference mode, Function mode and Lay-flat mode.
3753 * We support Home mode and Function mode currently.
3754 *
3755 * Will consider support rest of modes in future.
3756 *
3757 */
3758static const int adaptive_keyboard_modes[] = {
3759 HOME_MODE,
3760/* WEB_BROWSER_MODE = 2,
3761 WEB_CONFERENCE_MODE = 3, */
3762 FUNCTION_MODE
3763};
3764
3765#define DFR_CHANGE_ROW 0x101
3766#define DFR_SHOW_QUICKVIEW_ROW 0x102
3767#define FIRST_ADAPTIVE_KEY 0x103
3768
3769/* press Fn key a while second, it will switch to Function Mode. Then
3770 * release Fn key, previous mode be restored.
3771 */
3772static bool adaptive_keyboard_mode_is_saved;
3773static int adaptive_keyboard_prev_mode;
3774
3775static int adaptive_keyboard_get_mode(void)
3776{
3777 int mode = 0;
3778
3779 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3780 pr_err("Cannot read adaptive keyboard mode\n");
3781 return -EIO;
3782 }
3783
3784 return mode;
3785}
3786
3787static int adaptive_keyboard_set_mode(int new_mode)
3788{
3789 if (new_mode < 0 ||
3790 new_mode > LAYFLAT_MODE)
3791 return -EINVAL;
3792
3793 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3794 pr_err("Cannot set adaptive keyboard mode\n");
3795 return -EIO;
3796 }
3797
3798 return 0;
3799}
3800
3801static int adaptive_keyboard_get_next_mode(int mode)
3802{
3803 size_t i;
3804 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3805
3806 for (i = 0; i <= max_mode; i++) {
3807 if (adaptive_keyboard_modes[i] == mode)
3808 break;
3809 }
3810
3811 if (i >= max_mode)
3812 i = 0;
3813 else
3814 i++;
3815
3816 return adaptive_keyboard_modes[i];
3817}
3818
3819static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3820{
3821 int current_mode = 0;
3822 int new_mode = 0;
3823 int keycode;
3824
3825 switch (scancode) {
3826 case DFR_CHANGE_ROW:
3827 if (adaptive_keyboard_mode_is_saved) {
3828 new_mode = adaptive_keyboard_prev_mode;
3829 adaptive_keyboard_mode_is_saved = false;
3830 } else {
3831 current_mode = adaptive_keyboard_get_mode();
3832 if (current_mode < 0)
3833 return false;
3834 new_mode = adaptive_keyboard_get_next_mode(
3835 current_mode);
3836 }
3837
3838 if (adaptive_keyboard_set_mode(new_mode) < 0)
3839 return false;
3840
3841 return true;
3842
3843 case DFR_SHOW_QUICKVIEW_ROW:
3844 current_mode = adaptive_keyboard_get_mode();
3845 if (current_mode < 0)
3846 return false;
3847
3848 adaptive_keyboard_prev_mode = current_mode;
3849 adaptive_keyboard_mode_is_saved = true;
3850
3851 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3852 return false;
3853 return true;
3854
3855 default:
3856 if (scancode < FIRST_ADAPTIVE_KEY ||
3857 scancode >= FIRST_ADAPTIVE_KEY +
3858 TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3859 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3860 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3861 scancode);
3862 return false;
3863 }
3864 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3865 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3866 if (keycode != KEY_RESERVED) {
3867 mutex_lock(&tpacpi_inputdev_send_mutex);
3868
3869 input_report_key(tpacpi_inputdev, keycode, 1);
3870 input_sync(tpacpi_inputdev);
3871
3872 input_report_key(tpacpi_inputdev, keycode, 0);
3873 input_sync(tpacpi_inputdev);
3874
3875 mutex_unlock(&tpacpi_inputdev_send_mutex);
3876 }
3877 return true;
3878 }
3879}
3880
3881static bool hotkey_notify_hotkey(const u32 hkey,
3882 bool *send_acpi_ev,
3883 bool *ignore_acpi_ev)
3884{
3885 /* 0x1000-0x1FFF: key presses */
3886 unsigned int scancode = hkey & 0xfff;
3887 *send_acpi_ev = true;
3888 *ignore_acpi_ev = false;
3889
3890 /*
3891 * Original events are in the 0x10XX range, the adaptive keyboard
3892 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3893 * models, additional keys are emitted through 0x13XX.
3894 */
3895 switch ((hkey >> 8) & 0xf) {
3896 case 0:
3897 if (scancode > 0 &&
3898 scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3899 /* HKEY event 0x1001 is scancode 0x00 */
3900 scancode--;
3901 if (!(hotkey_source_mask & (1 << scancode))) {
3902 tpacpi_input_send_key_masked(scancode);
3903 *send_acpi_ev = false;
3904 } else {
3905 *ignore_acpi_ev = true;
3906 }
3907 return true;
3908 }
3909 break;
3910
3911 case 1:
3912 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3913
3914 case 3:
3915 /* Extended keycodes start at 0x300 and our offset into the map
3916 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3917 * will be positive, but might not be in the correct range.
3918 */
3919 scancode -= (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3920 if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3921 scancode < TPACPI_HOTKEY_MAP_LEN) {
3922 tpacpi_input_send_key(scancode);
3923 return true;
3924 }
3925 break;
3926 }
3927
3928 return false;
3929}
3930
3931static bool hotkey_notify_wakeup(const u32 hkey,
3932 bool *send_acpi_ev,
3933 bool *ignore_acpi_ev)
3934{
3935 /* 0x2000-0x2FFF: Wakeup reason */
3936 *send_acpi_ev = true;
3937 *ignore_acpi_ev = false;
3938
3939 switch (hkey) {
3940 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3941 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3942 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3943 *ignore_acpi_ev = true;
3944 break;
3945
3946 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3947 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3948 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3949 *ignore_acpi_ev = true;
3950 break;
3951
3952 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3953 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3954 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3955 /* how to auto-heal: */
3956 /* 2313: woke up from S3, go to S4/S5 */
3957 /* 2413: woke up from S4, go to S5 */
3958 break;
3959
3960 default:
3961 return false;
3962 }
3963
3964 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3965 pr_info("woke up due to a hot-unplug request...\n");
3966 hotkey_wakeup_reason_notify_change();
3967 }
3968 return true;
3969}
3970
3971static bool hotkey_notify_dockevent(const u32 hkey,
3972 bool *send_acpi_ev,
3973 bool *ignore_acpi_ev)
3974{
3975 /* 0x4000-0x4FFF: dock-related events */
3976 *send_acpi_ev = true;
3977 *ignore_acpi_ev = false;
3978
3979 switch (hkey) {
3980 case TP_HKEY_EV_UNDOCK_ACK:
3981 /* ACPI undock operation completed after wakeup */
3982 hotkey_autosleep_ack = 1;
3983 pr_info("undocked\n");
3984 hotkey_wakeup_hotunplug_complete_notify_change();
3985 return true;
3986
3987 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3988 pr_info("docked into hotplug port replicator\n");
3989 return true;
3990 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3991 pr_info("undocked from hotplug port replicator\n");
3992 return true;
3993
3994 default:
3995 return false;
3996 }
3997}
3998
3999static bool hotkey_notify_usrevent(const u32 hkey,
4000 bool *send_acpi_ev,
4001 bool *ignore_acpi_ev)
4002{
4003 /* 0x5000-0x5FFF: human interface helpers */
4004 *send_acpi_ev = true;
4005 *ignore_acpi_ev = false;
4006
4007 switch (hkey) {
4008 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
4009 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
4010 return true;
4011
4012 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
4013 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
4014 tpacpi_input_send_tabletsw();
4015 hotkey_tablet_mode_notify_change();
4016 *send_acpi_ev = false;
4017 return true;
4018
4019 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
4020 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
4021 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
4022 /* do not propagate these events */
4023 *ignore_acpi_ev = true;
4024 return true;
4025
4026 default:
4027 return false;
4028 }
4029}
4030
4031static void thermal_dump_all_sensors(void);
4032
4033static bool hotkey_notify_6xxx(const u32 hkey,
4034 bool *send_acpi_ev,
4035 bool *ignore_acpi_ev)
4036{
4037 bool known = true;
4038
4039 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
4040 *send_acpi_ev = true;
4041 *ignore_acpi_ev = false;
4042
4043 switch (hkey) {
4044 case TP_HKEY_EV_THM_TABLE_CHANGED:
4045 pr_info("EC reports that Thermal Table has changed\n");
4046 /* recommended action: do nothing, we don't have
4047 * Lenovo ATM information */
4048 return true;
4049 case TP_HKEY_EV_ALARM_BAT_HOT:
4050 pr_crit("THERMAL ALARM: battery is too hot!\n");
4051 /* recommended action: warn user through gui */
4052 break;
4053 case TP_HKEY_EV_ALARM_BAT_XHOT:
4054 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
4055 /* recommended action: immediate sleep/hibernate */
4056 break;
4057 case TP_HKEY_EV_ALARM_SENSOR_HOT:
4058 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
4059 /* recommended action: warn user through gui, that */
4060 /* some internal component is too hot */
4061 break;
4062 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
4063 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
4064 /* recommended action: immediate sleep/hibernate */
4065 break;
4066 case TP_HKEY_EV_AC_CHANGED:
4067 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
4068 * AC status changed; can be triggered by plugging or
4069 * unplugging AC adapter, docking or undocking. */
4070
4071 /* fallthrough */
4072
4073 case TP_HKEY_EV_KEY_NUMLOCK:
4074 case TP_HKEY_EV_KEY_FN:
4075 case TP_HKEY_EV_KEY_FN_ESC:
4076 /* key press events, we just ignore them as long as the EC
4077 * is still reporting them in the normal keyboard stream */
4078 *send_acpi_ev = false;
4079 *ignore_acpi_ev = true;
4080 return true;
4081
4082 case TP_HKEY_EV_TABLET_CHANGED:
4083 tpacpi_input_send_tabletsw();
4084 hotkey_tablet_mode_notify_change();
4085 *send_acpi_ev = false;
4086 break;
4087
4088 case TP_HKEY_EV_PALM_DETECTED:
4089 case TP_HKEY_EV_PALM_UNDETECTED:
4090 /* palm detected hovering the keyboard, forward to user-space
4091 * via netlink for consumption */
4092 return true;
4093
4094 default:
4095 pr_warn("unknown possible thermal alarm or keyboard event received\n");
4096 known = false;
4097 }
4098
4099 thermal_dump_all_sensors();
4100
4101 return known;
4102}
4103
4104static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4105{
4106 u32 hkey;
4107 bool send_acpi_ev;
4108 bool ignore_acpi_ev;
4109 bool known_ev;
4110
4111 if (event != 0x80) {
4112 pr_err("unknown HKEY notification event %d\n", event);
4113 /* forward it to userspace, maybe it knows how to handle it */
4114 acpi_bus_generate_netlink_event(
4115 ibm->acpi->device->pnp.device_class,
4116 dev_name(&ibm->acpi->device->dev),
4117 event, 0);
4118 return;
4119 }
4120
4121 while (1) {
4122 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4123 pr_err("failed to retrieve HKEY event\n");
4124 return;
4125 }
4126
4127 if (hkey == 0) {
4128 /* queue empty */
4129 return;
4130 }
4131
4132 send_acpi_ev = true;
4133 ignore_acpi_ev = false;
4134
4135 switch (hkey >> 12) {
4136 case 1:
4137 /* 0x1000-0x1FFF: key presses */
4138 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4139 &ignore_acpi_ev);
4140 break;
4141 case 2:
4142 /* 0x2000-0x2FFF: Wakeup reason */
4143 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4144 &ignore_acpi_ev);
4145 break;
4146 case 3:
4147 /* 0x3000-0x3FFF: bay-related wakeups */
4148 switch (hkey) {
4149 case TP_HKEY_EV_BAYEJ_ACK:
4150 hotkey_autosleep_ack = 1;
4151 pr_info("bay ejected\n");
4152 hotkey_wakeup_hotunplug_complete_notify_change();
4153 known_ev = true;
4154 break;
4155 case TP_HKEY_EV_OPTDRV_EJ:
4156 /* FIXME: kick libata if SATA link offline */
4157 known_ev = true;
4158 break;
4159 default:
4160 known_ev = false;
4161 }
4162 break;
4163 case 4:
4164 /* 0x4000-0x4FFF: dock-related events */
4165 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4166 &ignore_acpi_ev);
4167 break;
4168 case 5:
4169 /* 0x5000-0x5FFF: human interface helpers */
4170 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4171 &ignore_acpi_ev);
4172 break;
4173 case 6:
4174 /* 0x6000-0x6FFF: thermal alarms/notices and
4175 * keyboard events */
4176 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4177 &ignore_acpi_ev);
4178 break;
4179 case 7:
4180 /* 0x7000-0x7FFF: misc */
4181 if (tp_features.hotkey_wlsw &&
4182 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4183 tpacpi_send_radiosw_update();
4184 send_acpi_ev = 0;
4185 known_ev = true;
4186 break;
4187 }
4188 /* fallthrough to default */
4189 default:
4190 known_ev = false;
4191 }
4192 if (!known_ev) {
4193 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4194 pr_notice("please report the conditions when this event happened to %s\n",
4195 TPACPI_MAIL);
4196 }
4197
4198 /* netlink events */
4199 if (!ignore_acpi_ev && send_acpi_ev) {
4200 acpi_bus_generate_netlink_event(
4201 ibm->acpi->device->pnp.device_class,
4202 dev_name(&ibm->acpi->device->dev),
4203 event, hkey);
4204 }
4205 }
4206}
4207
4208static void hotkey_suspend(void)
4209{
4210 /* Do these on suspend, we get the events on early resume! */
4211 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4212 hotkey_autosleep_ack = 0;
4213
4214 /* save previous mode of adaptive keyboard of X1 Carbon */
4215 if (tp_features.has_adaptive_kbd) {
4216 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4217 "GTRW", "dd", 0)) {
4218 pr_err("Cannot read adaptive keyboard mode.\n");
4219 }
4220 }
4221}
4222
4223static void hotkey_resume(void)
4224{
4225 tpacpi_disable_brightness_delay();
4226
4227 if (hotkey_status_set(true) < 0 ||
4228 hotkey_mask_set(hotkey_acpi_mask) < 0)
4229 pr_err("error while attempting to reset the event firmware interface\n");
4230
4231 tpacpi_send_radiosw_update();
4232 hotkey_tablet_mode_notify_change();
4233 hotkey_wakeup_reason_notify_change();
4234 hotkey_wakeup_hotunplug_complete_notify_change();
4235 hotkey_poll_setup_safe(false);
4236
4237 /* restore previous mode of adapive keyboard of X1 Carbon */
4238 if (tp_features.has_adaptive_kbd) {
4239 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4240 adaptive_keyboard_prev_mode)) {
4241 pr_err("Cannot set adaptive keyboard mode.\n");
4242 }
4243 }
4244}
4245
4246/* procfs -------------------------------------------------------------- */
4247static int hotkey_read(struct seq_file *m)
4248{
4249 int res, status;
4250
4251 if (!tp_features.hotkey) {
4252 seq_printf(m, "status:\t\tnot supported\n");
4253 return 0;
4254 }
4255
4256 if (mutex_lock_killable(&hotkey_mutex))
4257 return -ERESTARTSYS;
4258 res = hotkey_status_get(&status);
4259 if (!res)
4260 res = hotkey_mask_get();
4261 mutex_unlock(&hotkey_mutex);
4262 if (res)
4263 return res;
4264
4265 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4266 if (hotkey_all_mask) {
4267 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4268 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4269 } else {
4270 seq_printf(m, "mask:\t\tnot supported\n");
4271 seq_printf(m, "commands:\tenable, disable, reset\n");
4272 }
4273
4274 return 0;
4275}
4276
4277static void hotkey_enabledisable_warn(bool enable)
4278{
4279 tpacpi_log_usertask("procfs hotkey enable/disable");
4280 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4281 pr_fmt("hotkey enable/disable functionality has been removed from the driver. Hotkeys are always enabled.\n")))
4282 pr_err("Please remove the hotkey=enable module parameter, it is deprecated. Hotkeys are always enabled.\n");
4283}
4284
4285static int hotkey_write(char *buf)
4286{
4287 int res;
4288 u32 mask;
4289 char *cmd;
4290
4291 if (!tp_features.hotkey)
4292 return -ENODEV;
4293
4294 if (mutex_lock_killable(&hotkey_mutex))
4295 return -ERESTARTSYS;
4296
4297 mask = hotkey_user_mask;
4298
4299 res = 0;
4300 while ((cmd = next_cmd(&buf))) {
4301 if (strlencmp(cmd, "enable") == 0) {
4302 hotkey_enabledisable_warn(1);
4303 } else if (strlencmp(cmd, "disable") == 0) {
4304 hotkey_enabledisable_warn(0);
4305 res = -EPERM;
4306 } else if (strlencmp(cmd, "reset") == 0) {
4307 mask = (hotkey_all_mask | hotkey_source_mask)
4308 & ~hotkey_reserved_mask;
4309 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4310 /* mask set */
4311 } else if (sscanf(cmd, "%x", &mask) == 1) {
4312 /* mask set */
4313 } else {
4314 res = -EINVAL;
4315 goto errexit;
4316 }
4317 }
4318
4319 if (!res) {
4320 tpacpi_disclose_usertask("procfs hotkey",
4321 "set mask to 0x%08x\n", mask);
4322 res = hotkey_user_mask_set(mask);
4323 }
4324
4325errexit:
4326 mutex_unlock(&hotkey_mutex);
4327 return res;
4328}
4329
4330static const struct acpi_device_id ibm_htk_device_ids[] = {
4331 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4332 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4333 {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4334 {"", 0},
4335};
4336
4337static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4338 .hid = ibm_htk_device_ids,
4339 .notify = hotkey_notify,
4340 .handle = &hkey_handle,
4341 .type = ACPI_DEVICE_NOTIFY,
4342};
4343
4344static struct ibm_struct hotkey_driver_data = {
4345 .name = "hotkey",
4346 .read = hotkey_read,
4347 .write = hotkey_write,
4348 .exit = hotkey_exit,
4349 .resume = hotkey_resume,
4350 .suspend = hotkey_suspend,
4351 .acpi = &ibm_hotkey_acpidriver,
4352};
4353
4354/*************************************************************************
4355 * Bluetooth subdriver
4356 */
4357
4358enum {
4359 /* ACPI GBDC/SBDC bits */
4360 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4361 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4362 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4363 0 = disable, 1 = enable */
4364};
4365
4366enum {
4367 /* ACPI \BLTH commands */
4368 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4369 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4370 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4371 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4372 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4373};
4374
4375#define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4376
4377static int bluetooth_get_status(void)
4378{
4379 int status;
4380
4381#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4382 if (dbg_bluetoothemul)
4383 return (tpacpi_bluetooth_emulstate) ?
4384 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4385#endif
4386
4387 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4388 return -EIO;
4389
4390 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4391 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4392}
4393
4394static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4395{
4396 int status;
4397
4398 vdbg_printk(TPACPI_DBG_RFKILL,
4399 "will attempt to %s bluetooth\n",
4400 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4401
4402#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4403 if (dbg_bluetoothemul) {
4404 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4405 return 0;
4406 }
4407#endif
4408
4409 if (state == TPACPI_RFK_RADIO_ON)
4410 status = TP_ACPI_BLUETOOTH_RADIOSSW
4411 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4412 else
4413 status = 0;
4414
4415 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4416 return -EIO;
4417
4418 return 0;
4419}
4420
4421/* sysfs bluetooth enable ---------------------------------------------- */
4422static ssize_t bluetooth_enable_show(struct device *dev,
4423 struct device_attribute *attr,
4424 char *buf)
4425{
4426 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4427 attr, buf);
4428}
4429
4430static ssize_t bluetooth_enable_store(struct device *dev,
4431 struct device_attribute *attr,
4432 const char *buf, size_t count)
4433{
4434 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4435 attr, buf, count);
4436}
4437
4438static DEVICE_ATTR_RW(bluetooth_enable);
4439
4440/* --------------------------------------------------------------------- */
4441
4442static struct attribute *bluetooth_attributes[] = {
4443 &dev_attr_bluetooth_enable.attr,
4444 NULL
4445};
4446
4447static const struct attribute_group bluetooth_attr_group = {
4448 .attrs = bluetooth_attributes,
4449};
4450
4451static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4452 .get_status = bluetooth_get_status,
4453 .set_status = bluetooth_set_status,
4454};
4455
4456static void bluetooth_shutdown(void)
4457{
4458 /* Order firmware to save current state to NVRAM */
4459 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4460 TP_ACPI_BLTH_SAVE_STATE))
4461 pr_notice("failed to save bluetooth state to NVRAM\n");
4462 else
4463 vdbg_printk(TPACPI_DBG_RFKILL,
4464 "bluetooth state saved to NVRAM\n");
4465}
4466
4467static void bluetooth_exit(void)
4468{
4469 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4470 &bluetooth_attr_group);
4471
4472 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4473
4474 bluetooth_shutdown();
4475}
4476
4477static int __init bluetooth_init(struct ibm_init_struct *iibm)
4478{
4479 int res;
4480 int status = 0;
4481
4482 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4483 "initializing bluetooth subdriver\n");
4484
4485 TPACPI_ACPIHANDLE_INIT(hkey);
4486
4487 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4488 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4489 tp_features.bluetooth = hkey_handle &&
4490 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4491
4492 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4493 "bluetooth is %s, status 0x%02x\n",
4494 str_supported(tp_features.bluetooth),
4495 status);
4496
4497#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4498 if (dbg_bluetoothemul) {
4499 tp_features.bluetooth = 1;
4500 pr_info("bluetooth switch emulation enabled\n");
4501 } else
4502#endif
4503 if (tp_features.bluetooth &&
4504 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4505 /* no bluetooth hardware present in system */
4506 tp_features.bluetooth = 0;
4507 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4508 "bluetooth hardware not installed\n");
4509 }
4510
4511 if (!tp_features.bluetooth)
4512 return 1;
4513
4514 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4515 &bluetooth_tprfk_ops,
4516 RFKILL_TYPE_BLUETOOTH,
4517 TPACPI_RFK_BLUETOOTH_SW_NAME,
4518 true);
4519 if (res)
4520 return res;
4521
4522 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4523 &bluetooth_attr_group);
4524 if (res) {
4525 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4526 return res;
4527 }
4528
4529 return 0;
4530}
4531
4532/* procfs -------------------------------------------------------------- */
4533static int bluetooth_read(struct seq_file *m)
4534{
4535 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4536}
4537
4538static int bluetooth_write(char *buf)
4539{
4540 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4541}
4542
4543static struct ibm_struct bluetooth_driver_data = {
4544 .name = "bluetooth",
4545 .read = bluetooth_read,
4546 .write = bluetooth_write,
4547 .exit = bluetooth_exit,
4548 .shutdown = bluetooth_shutdown,
4549};
4550
4551/*************************************************************************
4552 * Wan subdriver
4553 */
4554
4555enum {
4556 /* ACPI GWAN/SWAN bits */
4557 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4558 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4559 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4560 0 = disable, 1 = enable */
4561};
4562
4563#define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4564
4565static int wan_get_status(void)
4566{
4567 int status;
4568
4569#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4570 if (dbg_wwanemul)
4571 return (tpacpi_wwan_emulstate) ?
4572 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4573#endif
4574
4575 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4576 return -EIO;
4577
4578 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4579 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4580}
4581
4582static int wan_set_status(enum tpacpi_rfkill_state state)
4583{
4584 int status;
4585
4586 vdbg_printk(TPACPI_DBG_RFKILL,
4587 "will attempt to %s wwan\n",
4588 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4589
4590#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4591 if (dbg_wwanemul) {
4592 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4593 return 0;
4594 }
4595#endif
4596
4597 if (state == TPACPI_RFK_RADIO_ON)
4598 status = TP_ACPI_WANCARD_RADIOSSW
4599 | TP_ACPI_WANCARD_RESUMECTRL;
4600 else
4601 status = 0;
4602
4603 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4604 return -EIO;
4605
4606 return 0;
4607}
4608
4609/* sysfs wan enable ---------------------------------------------------- */
4610static ssize_t wan_enable_show(struct device *dev,
4611 struct device_attribute *attr,
4612 char *buf)
4613{
4614 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4615 attr, buf);
4616}
4617
4618static ssize_t wan_enable_store(struct device *dev,
4619 struct device_attribute *attr,
4620 const char *buf, size_t count)
4621{
4622 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4623 attr, buf, count);
4624}
4625
4626static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4627 wan_enable_show, wan_enable_store);
4628
4629/* --------------------------------------------------------------------- */
4630
4631static struct attribute *wan_attributes[] = {
4632 &dev_attr_wwan_enable.attr,
4633 NULL
4634};
4635
4636static const struct attribute_group wan_attr_group = {
4637 .attrs = wan_attributes,
4638};
4639
4640static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4641 .get_status = wan_get_status,
4642 .set_status = wan_set_status,
4643};
4644
4645static void wan_shutdown(void)
4646{
4647 /* Order firmware to save current state to NVRAM */
4648 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4649 TP_ACPI_WGSV_SAVE_STATE))
4650 pr_notice("failed to save WWAN state to NVRAM\n");
4651 else
4652 vdbg_printk(TPACPI_DBG_RFKILL,
4653 "WWAN state saved to NVRAM\n");
4654}
4655
4656static void wan_exit(void)
4657{
4658 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4659 &wan_attr_group);
4660
4661 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4662
4663 wan_shutdown();
4664}
4665
4666static int __init wan_init(struct ibm_init_struct *iibm)
4667{
4668 int res;
4669 int status = 0;
4670
4671 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4672 "initializing wan subdriver\n");
4673
4674 TPACPI_ACPIHANDLE_INIT(hkey);
4675
4676 tp_features.wan = hkey_handle &&
4677 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4678
4679 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4680 "wan is %s, status 0x%02x\n",
4681 str_supported(tp_features.wan),
4682 status);
4683
4684#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4685 if (dbg_wwanemul) {
4686 tp_features.wan = 1;
4687 pr_info("wwan switch emulation enabled\n");
4688 } else
4689#endif
4690 if (tp_features.wan &&
4691 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4692 /* no wan hardware present in system */
4693 tp_features.wan = 0;
4694 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4695 "wan hardware not installed\n");
4696 }
4697
4698 if (!tp_features.wan)
4699 return 1;
4700
4701 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4702 &wan_tprfk_ops,
4703 RFKILL_TYPE_WWAN,
4704 TPACPI_RFK_WWAN_SW_NAME,
4705 true);
4706 if (res)
4707 return res;
4708
4709 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4710 &wan_attr_group);
4711
4712 if (res) {
4713 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4714 return res;
4715 }
4716
4717 return 0;
4718}
4719
4720/* procfs -------------------------------------------------------------- */
4721static int wan_read(struct seq_file *m)
4722{
4723 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4724}
4725
4726static int wan_write(char *buf)
4727{
4728 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4729}
4730
4731static struct ibm_struct wan_driver_data = {
4732 .name = "wan",
4733 .read = wan_read,
4734 .write = wan_write,
4735 .exit = wan_exit,
4736 .shutdown = wan_shutdown,
4737};
4738
4739/*************************************************************************
4740 * UWB subdriver
4741 */
4742
4743enum {
4744 /* ACPI GUWB/SUWB bits */
4745 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4746 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4747};
4748
4749#define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4750
4751static int uwb_get_status(void)
4752{
4753 int status;
4754
4755#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4756 if (dbg_uwbemul)
4757 return (tpacpi_uwb_emulstate) ?
4758 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4759#endif
4760
4761 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4762 return -EIO;
4763
4764 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4765 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4766}
4767
4768static int uwb_set_status(enum tpacpi_rfkill_state state)
4769{
4770 int status;
4771
4772 vdbg_printk(TPACPI_DBG_RFKILL,
4773 "will attempt to %s UWB\n",
4774 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4775
4776#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4777 if (dbg_uwbemul) {
4778 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4779 return 0;
4780 }
4781#endif
4782
4783 if (state == TPACPI_RFK_RADIO_ON)
4784 status = TP_ACPI_UWB_RADIOSSW;
4785 else
4786 status = 0;
4787
4788 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4789 return -EIO;
4790
4791 return 0;
4792}
4793
4794/* --------------------------------------------------------------------- */
4795
4796static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4797 .get_status = uwb_get_status,
4798 .set_status = uwb_set_status,
4799};
4800
4801static void uwb_exit(void)
4802{
4803 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4804}
4805
4806static int __init uwb_init(struct ibm_init_struct *iibm)
4807{
4808 int res;
4809 int status = 0;
4810
4811 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4812 "initializing uwb subdriver\n");
4813
4814 TPACPI_ACPIHANDLE_INIT(hkey);
4815
4816 tp_features.uwb = hkey_handle &&
4817 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4818
4819 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4820 "uwb is %s, status 0x%02x\n",
4821 str_supported(tp_features.uwb),
4822 status);
4823
4824#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4825 if (dbg_uwbemul) {
4826 tp_features.uwb = 1;
4827 pr_info("uwb switch emulation enabled\n");
4828 } else
4829#endif
4830 if (tp_features.uwb &&
4831 !(status & TP_ACPI_UWB_HWPRESENT)) {
4832 /* no uwb hardware present in system */
4833 tp_features.uwb = 0;
4834 dbg_printk(TPACPI_DBG_INIT,
4835 "uwb hardware not installed\n");
4836 }
4837
4838 if (!tp_features.uwb)
4839 return 1;
4840
4841 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4842 &uwb_tprfk_ops,
4843 RFKILL_TYPE_UWB,
4844 TPACPI_RFK_UWB_SW_NAME,
4845 false);
4846 return res;
4847}
4848
4849static struct ibm_struct uwb_driver_data = {
4850 .name = "uwb",
4851 .exit = uwb_exit,
4852 .flags.experimental = 1,
4853};
4854
4855/*************************************************************************
4856 * Video subdriver
4857 */
4858
4859#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4860
4861enum video_access_mode {
4862 TPACPI_VIDEO_NONE = 0,
4863 TPACPI_VIDEO_570, /* 570 */
4864 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4865 TPACPI_VIDEO_NEW, /* all others */
4866};
4867
4868enum { /* video status flags, based on VIDEO_570 */
4869 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4870 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4871 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4872};
4873
4874enum { /* TPACPI_VIDEO_570 constants */
4875 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4876 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4877 * video_status_flags */
4878 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4879 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4880};
4881
4882static enum video_access_mode video_supported;
4883static int video_orig_autosw;
4884
4885static int video_autosw_get(void);
4886static int video_autosw_set(int enable);
4887
4888TPACPI_HANDLE(vid, root,
4889 "\\_SB.PCI.AGP.VGA", /* 570 */
4890 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4891 "\\_SB.PCI0.VID0", /* 770e */
4892 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4893 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4894 "\\_SB.PCI0.AGP.VID", /* all others */
4895 ); /* R30, R31 */
4896
4897TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4898
4899static int __init video_init(struct ibm_init_struct *iibm)
4900{
4901 int ivga;
4902
4903 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4904
4905 TPACPI_ACPIHANDLE_INIT(vid);
4906 if (tpacpi_is_ibm())
4907 TPACPI_ACPIHANDLE_INIT(vid2);
4908
4909 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4910 /* G41, assume IVGA doesn't change */
4911 vid_handle = vid2_handle;
4912
4913 if (!vid_handle)
4914 /* video switching not supported on R30, R31 */
4915 video_supported = TPACPI_VIDEO_NONE;
4916 else if (tpacpi_is_ibm() &&
4917 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4918 /* 570 */
4919 video_supported = TPACPI_VIDEO_570;
4920 else if (tpacpi_is_ibm() &&
4921 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4922 /* 600e/x, 770e, 770x */
4923 video_supported = TPACPI_VIDEO_770;
4924 else
4925 /* all others */
4926 video_supported = TPACPI_VIDEO_NEW;
4927
4928 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4929 str_supported(video_supported != TPACPI_VIDEO_NONE),
4930 video_supported);
4931
4932 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
4933}
4934
4935static void video_exit(void)
4936{
4937 dbg_printk(TPACPI_DBG_EXIT,
4938 "restoring original video autoswitch mode\n");
4939 if (video_autosw_set(video_orig_autosw))
4940 pr_err("error while trying to restore original video autoswitch mode\n");
4941}
4942
4943static int video_outputsw_get(void)
4944{
4945 int status = 0;
4946 int i;
4947
4948 switch (video_supported) {
4949 case TPACPI_VIDEO_570:
4950 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4951 TP_ACPI_VIDEO_570_PHSCMD))
4952 return -EIO;
4953 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4954 break;
4955 case TPACPI_VIDEO_770:
4956 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4957 return -EIO;
4958 if (i)
4959 status |= TP_ACPI_VIDEO_S_LCD;
4960 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4961 return -EIO;
4962 if (i)
4963 status |= TP_ACPI_VIDEO_S_CRT;
4964 break;
4965 case TPACPI_VIDEO_NEW:
4966 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4967 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4968 return -EIO;
4969 if (i)
4970 status |= TP_ACPI_VIDEO_S_CRT;
4971
4972 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4973 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4974 return -EIO;
4975 if (i)
4976 status |= TP_ACPI_VIDEO_S_LCD;
4977 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4978 return -EIO;
4979 if (i)
4980 status |= TP_ACPI_VIDEO_S_DVI;
4981 break;
4982 default:
4983 return -ENOSYS;
4984 }
4985
4986 return status;
4987}
4988
4989static int video_outputsw_set(int status)
4990{
4991 int autosw;
4992 int res = 0;
4993
4994 switch (video_supported) {
4995 case TPACPI_VIDEO_570:
4996 res = acpi_evalf(NULL, NULL,
4997 "\\_SB.PHS2", "vdd",
4998 TP_ACPI_VIDEO_570_PHS2CMD,
4999 status | TP_ACPI_VIDEO_570_PHS2SET);
5000 break;
5001 case TPACPI_VIDEO_770:
5002 autosw = video_autosw_get();
5003 if (autosw < 0)
5004 return autosw;
5005
5006 res = video_autosw_set(1);
5007 if (res)
5008 return res;
5009 res = acpi_evalf(vid_handle, NULL,
5010 "ASWT", "vdd", status * 0x100, 0);
5011 if (!autosw && video_autosw_set(autosw)) {
5012 pr_err("video auto-switch left enabled due to error\n");
5013 return -EIO;
5014 }
5015 break;
5016 case TPACPI_VIDEO_NEW:
5017 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5018 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5019 break;
5020 default:
5021 return -ENOSYS;
5022 }
5023
5024 return (res) ? 0 : -EIO;
5025}
5026
5027static int video_autosw_get(void)
5028{
5029 int autosw = 0;
5030
5031 switch (video_supported) {
5032 case TPACPI_VIDEO_570:
5033 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5034 return -EIO;
5035 break;
5036 case TPACPI_VIDEO_770:
5037 case TPACPI_VIDEO_NEW:
5038 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5039 return -EIO;
5040 break;
5041 default:
5042 return -ENOSYS;
5043 }
5044
5045 return autosw & 1;
5046}
5047
5048static int video_autosw_set(int enable)
5049{
5050 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5051 return -EIO;
5052 return 0;
5053}
5054
5055static int video_outputsw_cycle(void)
5056{
5057 int autosw = video_autosw_get();
5058 int res;
5059
5060 if (autosw < 0)
5061 return autosw;
5062
5063 switch (video_supported) {
5064 case TPACPI_VIDEO_570:
5065 res = video_autosw_set(1);
5066 if (res)
5067 return res;
5068 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5069 break;
5070 case TPACPI_VIDEO_770:
5071 case TPACPI_VIDEO_NEW:
5072 res = video_autosw_set(1);
5073 if (res)
5074 return res;
5075 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5076 break;
5077 default:
5078 return -ENOSYS;
5079 }
5080 if (!autosw && video_autosw_set(autosw)) {
5081 pr_err("video auto-switch left enabled due to error\n");
5082 return -EIO;
5083 }
5084
5085 return (res) ? 0 : -EIO;
5086}
5087
5088static int video_expand_toggle(void)
5089{
5090 switch (video_supported) {
5091 case TPACPI_VIDEO_570:
5092 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5093 0 : -EIO;
5094 case TPACPI_VIDEO_770:
5095 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5096 0 : -EIO;
5097 case TPACPI_VIDEO_NEW:
5098 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5099 0 : -EIO;
5100 default:
5101 return -ENOSYS;
5102 }
5103 /* not reached */
5104}
5105
5106static int video_read(struct seq_file *m)
5107{
5108 int status, autosw;
5109
5110 if (video_supported == TPACPI_VIDEO_NONE) {
5111 seq_printf(m, "status:\t\tnot supported\n");
5112 return 0;
5113 }
5114
5115 /* Even reads can crash X.org, so... */
5116 if (!capable(CAP_SYS_ADMIN))
5117 return -EPERM;
5118
5119 status = video_outputsw_get();
5120 if (status < 0)
5121 return status;
5122
5123 autosw = video_autosw_get();
5124 if (autosw < 0)
5125 return autosw;
5126
5127 seq_printf(m, "status:\t\tsupported\n");
5128 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
5129 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
5130 if (video_supported == TPACPI_VIDEO_NEW)
5131 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
5132 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
5133 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5134 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5135 if (video_supported == TPACPI_VIDEO_NEW)
5136 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5137 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5138 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5139
5140 return 0;
5141}
5142
5143static int video_write(char *buf)
5144{
5145 char *cmd;
5146 int enable, disable, status;
5147 int res;
5148
5149 if (video_supported == TPACPI_VIDEO_NONE)
5150 return -ENODEV;
5151
5152 /* Even reads can crash X.org, let alone writes... */
5153 if (!capable(CAP_SYS_ADMIN))
5154 return -EPERM;
5155
5156 enable = 0;
5157 disable = 0;
5158
5159 while ((cmd = next_cmd(&buf))) {
5160 if (strlencmp(cmd, "lcd_enable") == 0) {
5161 enable |= TP_ACPI_VIDEO_S_LCD;
5162 } else if (strlencmp(cmd, "lcd_disable") == 0) {
5163 disable |= TP_ACPI_VIDEO_S_LCD;
5164 } else if (strlencmp(cmd, "crt_enable") == 0) {
5165 enable |= TP_ACPI_VIDEO_S_CRT;
5166 } else if (strlencmp(cmd, "crt_disable") == 0) {
5167 disable |= TP_ACPI_VIDEO_S_CRT;
5168 } else if (video_supported == TPACPI_VIDEO_NEW &&
5169 strlencmp(cmd, "dvi_enable") == 0) {
5170 enable |= TP_ACPI_VIDEO_S_DVI;
5171 } else if (video_supported == TPACPI_VIDEO_NEW &&
5172 strlencmp(cmd, "dvi_disable") == 0) {
5173 disable |= TP_ACPI_VIDEO_S_DVI;
5174 } else if (strlencmp(cmd, "auto_enable") == 0) {
5175 res = video_autosw_set(1);
5176 if (res)
5177 return res;
5178 } else if (strlencmp(cmd, "auto_disable") == 0) {
5179 res = video_autosw_set(0);
5180 if (res)
5181 return res;
5182 } else if (strlencmp(cmd, "video_switch") == 0) {
5183 res = video_outputsw_cycle();
5184 if (res)
5185 return res;
5186 } else if (strlencmp(cmd, "expand_toggle") == 0) {
5187 res = video_expand_toggle();
5188 if (res)
5189 return res;
5190 } else
5191 return -EINVAL;
5192 }
5193
5194 if (enable || disable) {
5195 status = video_outputsw_get();
5196 if (status < 0)
5197 return status;
5198 res = video_outputsw_set((status & ~disable) | enable);
5199 if (res)
5200 return res;
5201 }
5202
5203 return 0;
5204}
5205
5206static struct ibm_struct video_driver_data = {
5207 .name = "video",
5208 .read = video_read,
5209 .write = video_write,
5210 .exit = video_exit,
5211};
5212
5213#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5214
5215/*************************************************************************
5216 * Keyboard backlight subdriver
5217 */
5218
5219static enum led_brightness kbdlight_brightness;
5220static DEFINE_MUTEX(kbdlight_mutex);
5221
5222static int kbdlight_set_level(int level)
5223{
5224 int ret = 0;
5225
5226 if (!hkey_handle)
5227 return -ENXIO;
5228
5229 mutex_lock(&kbdlight_mutex);
5230
5231 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5232 ret = -EIO;
5233 else
5234 kbdlight_brightness = level;
5235
5236 mutex_unlock(&kbdlight_mutex);
5237
5238 return ret;
5239}
5240
5241static int kbdlight_get_level(void)
5242{
5243 int status = 0;
5244
5245 if (!hkey_handle)
5246 return -ENXIO;
5247
5248 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5249 return -EIO;
5250
5251 if (status < 0)
5252 return status;
5253
5254 return status & 0x3;
5255}
5256
5257static bool kbdlight_is_supported(void)
5258{
5259 int status = 0;
5260
5261 if (!hkey_handle)
5262 return false;
5263
5264 if (!acpi_has_method(hkey_handle, "MLCG")) {
5265 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5266 return false;
5267 }
5268
5269 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5270 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5271 return false;
5272 }
5273
5274 if (status < 0) {
5275 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5276 return false;
5277 }
5278
5279 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5280 /*
5281 * Guessed test for keyboard backlight:
5282 *
5283 * Machines with backlight keyboard return:
5284 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5285 * b110100010010000000XX - ThinkPad x230
5286 * b010100000010000000XX - ThinkPad x240
5287 * b010100000010000000XX - ThinkPad W541
5288 * (XX is current backlight level)
5289 *
5290 * Machines without backlight keyboard return:
5291 * b10100001000000000000 - ThinkPad x230
5292 * b10110001000000000000 - ThinkPad E430
5293 * b00000000000000000000 - ThinkPad E450
5294 *
5295 * Candidate BITs for detection test (XOR):
5296 * b01000000001000000000
5297 * ^
5298 */
5299 return status & BIT(9);
5300}
5301
5302static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5303 enum led_brightness brightness)
5304{
5305 return kbdlight_set_level(brightness);
5306}
5307
5308static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5309{
5310 int level;
5311
5312 level = kbdlight_get_level();
5313 if (level < 0)
5314 return 0;
5315
5316 return level;
5317}
5318
5319static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5320 .led_classdev = {
5321 .name = "tpacpi::kbd_backlight",
5322 .max_brightness = 2,
5323 .flags = LED_BRIGHT_HW_CHANGED,
5324 .brightness_set_blocking = &kbdlight_sysfs_set,
5325 .brightness_get = &kbdlight_sysfs_get,
5326 }
5327};
5328
5329static int __init kbdlight_init(struct ibm_init_struct *iibm)
5330{
5331 int rc;
5332
5333 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5334
5335 TPACPI_ACPIHANDLE_INIT(hkey);
5336
5337 if (!kbdlight_is_supported()) {
5338 tp_features.kbdlight = 0;
5339 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5340 return 1;
5341 }
5342
5343 kbdlight_brightness = kbdlight_sysfs_get(NULL);
5344 tp_features.kbdlight = 1;
5345
5346 rc = led_classdev_register(&tpacpi_pdev->dev,
5347 &tpacpi_led_kbdlight.led_classdev);
5348 if (rc < 0) {
5349 tp_features.kbdlight = 0;
5350 return rc;
5351 }
5352
5353 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5354 TP_ACPI_HKEY_KBD_LIGHT_MASK);
5355 return 0;
5356}
5357
5358static void kbdlight_exit(void)
5359{
5360 if (tp_features.kbdlight)
5361 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5362}
5363
5364static int kbdlight_set_level_and_update(int level)
5365{
5366 int ret;
5367 struct led_classdev *led_cdev;
5368
5369 ret = kbdlight_set_level(level);
5370 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5371
5372 if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5373 led_cdev->brightness = level;
5374
5375 return ret;
5376}
5377
5378static int kbdlight_read(struct seq_file *m)
5379{
5380 int level;
5381
5382 if (!tp_features.kbdlight) {
5383 seq_printf(m, "status:\t\tnot supported\n");
5384 } else {
5385 level = kbdlight_get_level();
5386 if (level < 0)
5387 seq_printf(m, "status:\t\terror %d\n", level);
5388 else
5389 seq_printf(m, "status:\t\t%d\n", level);
5390 seq_printf(m, "commands:\t0, 1, 2\n");
5391 }
5392
5393 return 0;
5394}
5395
5396static int kbdlight_write(char *buf)
5397{
5398 char *cmd;
5399 int level = -1;
5400
5401 if (!tp_features.kbdlight)
5402 return -ENODEV;
5403
5404 while ((cmd = next_cmd(&buf))) {
5405 if (strlencmp(cmd, "0") == 0)
5406 level = 0;
5407 else if (strlencmp(cmd, "1") == 0)
5408 level = 1;
5409 else if (strlencmp(cmd, "2") == 0)
5410 level = 2;
5411 else
5412 return -EINVAL;
5413 }
5414
5415 if (level == -1)
5416 return -EINVAL;
5417
5418 return kbdlight_set_level_and_update(level);
5419}
5420
5421static void kbdlight_suspend(void)
5422{
5423 struct led_classdev *led_cdev;
5424
5425 if (!tp_features.kbdlight)
5426 return;
5427
5428 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5429 led_update_brightness(led_cdev);
5430 led_classdev_suspend(led_cdev);
5431}
5432
5433static void kbdlight_resume(void)
5434{
5435 if (!tp_features.kbdlight)
5436 return;
5437
5438 led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5439}
5440
5441static struct ibm_struct kbdlight_driver_data = {
5442 .name = "kbdlight",
5443 .read = kbdlight_read,
5444 .write = kbdlight_write,
5445 .suspend = kbdlight_suspend,
5446 .resume = kbdlight_resume,
5447 .exit = kbdlight_exit,
5448};
5449
5450/*************************************************************************
5451 * Light (thinklight) subdriver
5452 */
5453
5454TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5455TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5456
5457static int light_get_status(void)
5458{
5459 int status = 0;
5460
5461 if (tp_features.light_status) {
5462 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5463 return -EIO;
5464 return (!!status);
5465 }
5466
5467 return -ENXIO;
5468}
5469
5470static int light_set_status(int status)
5471{
5472 int rc;
5473
5474 if (tp_features.light) {
5475 if (cmos_handle) {
5476 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5477 (status) ?
5478 TP_CMOS_THINKLIGHT_ON :
5479 TP_CMOS_THINKLIGHT_OFF);
5480 } else {
5481 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5482 (status) ? 1 : 0);
5483 }
5484 return (rc) ? 0 : -EIO;
5485 }
5486
5487 return -ENXIO;
5488}
5489
5490static int light_sysfs_set(struct led_classdev *led_cdev,
5491 enum led_brightness brightness)
5492{
5493 return light_set_status((brightness != LED_OFF) ?
5494 TPACPI_LED_ON : TPACPI_LED_OFF);
5495}
5496
5497static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5498{
5499 return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5500}
5501
5502static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5503 .led_classdev = {
5504 .name = "tpacpi::thinklight",
5505 .brightness_set_blocking = &light_sysfs_set,
5506 .brightness_get = &light_sysfs_get,
5507 }
5508};
5509
5510static int __init light_init(struct ibm_init_struct *iibm)
5511{
5512 int rc;
5513
5514 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5515
5516 if (tpacpi_is_ibm()) {
5517 TPACPI_ACPIHANDLE_INIT(ledb);
5518 TPACPI_ACPIHANDLE_INIT(lght);
5519 }
5520 TPACPI_ACPIHANDLE_INIT(cmos);
5521
5522 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5523 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5524
5525 if (tp_features.light)
5526 /* light status not supported on
5527 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5528 tp_features.light_status =
5529 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5530
5531 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5532 str_supported(tp_features.light),
5533 str_supported(tp_features.light_status));
5534
5535 if (!tp_features.light)
5536 return 1;
5537
5538 rc = led_classdev_register(&tpacpi_pdev->dev,
5539 &tpacpi_led_thinklight.led_classdev);
5540
5541 if (rc < 0) {
5542 tp_features.light = 0;
5543 tp_features.light_status = 0;
5544 } else {
5545 rc = 0;
5546 }
5547
5548 return rc;
5549}
5550
5551static void light_exit(void)
5552{
5553 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5554}
5555
5556static int light_read(struct seq_file *m)
5557{
5558 int status;
5559
5560 if (!tp_features.light) {
5561 seq_printf(m, "status:\t\tnot supported\n");
5562 } else if (!tp_features.light_status) {
5563 seq_printf(m, "status:\t\tunknown\n");
5564 seq_printf(m, "commands:\ton, off\n");
5565 } else {
5566 status = light_get_status();
5567 if (status < 0)
5568 return status;
5569 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5570 seq_printf(m, "commands:\ton, off\n");
5571 }
5572
5573 return 0;
5574}
5575
5576static int light_write(char *buf)
5577{
5578 char *cmd;
5579 int newstatus = 0;
5580
5581 if (!tp_features.light)
5582 return -ENODEV;
5583
5584 while ((cmd = next_cmd(&buf))) {
5585 if (strlencmp(cmd, "on") == 0) {
5586 newstatus = 1;
5587 } else if (strlencmp(cmd, "off") == 0) {
5588 newstatus = 0;
5589 } else
5590 return -EINVAL;
5591 }
5592
5593 return light_set_status(newstatus);
5594}
5595
5596static struct ibm_struct light_driver_data = {
5597 .name = "light",
5598 .read = light_read,
5599 .write = light_write,
5600 .exit = light_exit,
5601};
5602
5603/*************************************************************************
5604 * CMOS subdriver
5605 */
5606
5607/* sysfs cmos_command -------------------------------------------------- */
5608static ssize_t cmos_command_store(struct device *dev,
5609 struct device_attribute *attr,
5610 const char *buf, size_t count)
5611{
5612 unsigned long cmos_cmd;
5613 int res;
5614
5615 if (parse_strtoul(buf, 21, &cmos_cmd))
5616 return -EINVAL;
5617
5618 res = issue_thinkpad_cmos_command(cmos_cmd);
5619 return (res) ? res : count;
5620}
5621
5622static DEVICE_ATTR_WO(cmos_command);
5623
5624/* --------------------------------------------------------------------- */
5625
5626static int __init cmos_init(struct ibm_init_struct *iibm)
5627{
5628 int res;
5629
5630 vdbg_printk(TPACPI_DBG_INIT,
5631 "initializing cmos commands subdriver\n");
5632
5633 TPACPI_ACPIHANDLE_INIT(cmos);
5634
5635 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5636 str_supported(cmos_handle != NULL));
5637
5638 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5639 if (res)
5640 return res;
5641
5642 return (cmos_handle) ? 0 : 1;
5643}
5644
5645static void cmos_exit(void)
5646{
5647 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5648}
5649
5650static int cmos_read(struct seq_file *m)
5651{
5652 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5653 R30, R31, T20-22, X20-21 */
5654 if (!cmos_handle)
5655 seq_printf(m, "status:\t\tnot supported\n");
5656 else {
5657 seq_printf(m, "status:\t\tsupported\n");
5658 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5659 }
5660
5661 return 0;
5662}
5663
5664static int cmos_write(char *buf)
5665{
5666 char *cmd;
5667 int cmos_cmd, res;
5668
5669 while ((cmd = next_cmd(&buf))) {
5670 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5671 cmos_cmd >= 0 && cmos_cmd <= 21) {
5672 /* cmos_cmd set */
5673 } else
5674 return -EINVAL;
5675
5676 res = issue_thinkpad_cmos_command(cmos_cmd);
5677 if (res)
5678 return res;
5679 }
5680
5681 return 0;
5682}
5683
5684static struct ibm_struct cmos_driver_data = {
5685 .name = "cmos",
5686 .read = cmos_read,
5687 .write = cmos_write,
5688 .exit = cmos_exit,
5689};
5690
5691/*************************************************************************
5692 * LED subdriver
5693 */
5694
5695enum led_access_mode {
5696 TPACPI_LED_NONE = 0,
5697 TPACPI_LED_570, /* 570 */
5698 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5699 TPACPI_LED_NEW, /* all others */
5700};
5701
5702enum { /* For TPACPI_LED_OLD */
5703 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5704 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5705 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5706};
5707
5708static enum led_access_mode led_supported;
5709
5710static acpi_handle led_handle;
5711
5712#define TPACPI_LED_NUMLEDS 16
5713static struct tpacpi_led_classdev *tpacpi_leds;
5714static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5715static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5716 /* there's a limit of 19 chars + NULL before 2.6.26 */
5717 "tpacpi::power",
5718 "tpacpi:orange:batt",
5719 "tpacpi:green:batt",
5720 "tpacpi::dock_active",
5721 "tpacpi::bay_active",
5722 "tpacpi::dock_batt",
5723 "tpacpi::unknown_led",
5724 "tpacpi::standby",
5725 "tpacpi::dock_status1",
5726 "tpacpi::dock_status2",
5727 "tpacpi::unknown_led2",
5728 "tpacpi::unknown_led3",
5729 "tpacpi::thinkvantage",
5730};
5731#define TPACPI_SAFE_LEDS 0x1081U
5732
5733static inline bool tpacpi_is_led_restricted(const unsigned int led)
5734{
5735#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5736 return false;
5737#else
5738 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5739#endif
5740}
5741
5742static int led_get_status(const unsigned int led)
5743{
5744 int status;
5745 enum led_status_t led_s;
5746
5747 switch (led_supported) {
5748 case TPACPI_LED_570:
5749 if (!acpi_evalf(ec_handle,
5750 &status, "GLED", "dd", 1 << led))
5751 return -EIO;
5752 led_s = (status == 0) ?
5753 TPACPI_LED_OFF :
5754 ((status == 1) ?
5755 TPACPI_LED_ON :
5756 TPACPI_LED_BLINK);
5757 tpacpi_led_state_cache[led] = led_s;
5758 return led_s;
5759 default:
5760 return -ENXIO;
5761 }
5762
5763 /* not reached */
5764}
5765
5766static int led_set_status(const unsigned int led,
5767 const enum led_status_t ledstatus)
5768{
5769 /* off, on, blink. Index is led_status_t */
5770 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5771 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5772
5773 int rc = 0;
5774
5775 switch (led_supported) {
5776 case TPACPI_LED_570:
5777 /* 570 */
5778 if (unlikely(led > 7))
5779 return -EINVAL;
5780 if (unlikely(tpacpi_is_led_restricted(led)))
5781 return -EPERM;
5782 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5783 (1 << led), led_sled_arg1[ledstatus]))
5784 rc = -EIO;
5785 break;
5786 case TPACPI_LED_OLD:
5787 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5788 if (unlikely(led > 7))
5789 return -EINVAL;
5790 if (unlikely(tpacpi_is_led_restricted(led)))
5791 return -EPERM;
5792 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5793 if (rc >= 0)
5794 rc = ec_write(TPACPI_LED_EC_HLBL,
5795 (ledstatus == TPACPI_LED_BLINK) << led);
5796 if (rc >= 0)
5797 rc = ec_write(TPACPI_LED_EC_HLCL,
5798 (ledstatus != TPACPI_LED_OFF) << led);
5799 break;
5800 case TPACPI_LED_NEW:
5801 /* all others */
5802 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5803 return -EINVAL;
5804 if (unlikely(tpacpi_is_led_restricted(led)))
5805 return -EPERM;
5806 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5807 led, led_led_arg1[ledstatus]))
5808 rc = -EIO;
5809 break;
5810 default:
5811 rc = -ENXIO;
5812 }
5813
5814 if (!rc)
5815 tpacpi_led_state_cache[led] = ledstatus;
5816
5817 return rc;
5818}
5819
5820static int led_sysfs_set(struct led_classdev *led_cdev,
5821 enum led_brightness brightness)
5822{
5823 struct tpacpi_led_classdev *data = container_of(led_cdev,
5824 struct tpacpi_led_classdev, led_classdev);
5825 enum led_status_t new_state;
5826
5827 if (brightness == LED_OFF)
5828 new_state = TPACPI_LED_OFF;
5829 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5830 new_state = TPACPI_LED_ON;
5831 else
5832 new_state = TPACPI_LED_BLINK;
5833
5834 return led_set_status(data->led, new_state);
5835}
5836
5837static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5838 unsigned long *delay_on, unsigned long *delay_off)
5839{
5840 struct tpacpi_led_classdev *data = container_of(led_cdev,
5841 struct tpacpi_led_classdev, led_classdev);
5842
5843 /* Can we choose the flash rate? */
5844 if (*delay_on == 0 && *delay_off == 0) {
5845 /* yes. set them to the hardware blink rate (1 Hz) */
5846 *delay_on = 500; /* ms */
5847 *delay_off = 500; /* ms */
5848 } else if ((*delay_on != 500) || (*delay_off != 500))
5849 return -EINVAL;
5850
5851 return led_set_status(data->led, TPACPI_LED_BLINK);
5852}
5853
5854static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5855{
5856 int rc;
5857
5858 struct tpacpi_led_classdev *data = container_of(led_cdev,
5859 struct tpacpi_led_classdev, led_classdev);
5860
5861 rc = led_get_status(data->led);
5862
5863 if (rc == TPACPI_LED_OFF || rc < 0)
5864 rc = LED_OFF; /* no error handling in led class :( */
5865 else
5866 rc = LED_FULL;
5867
5868 return rc;
5869}
5870
5871static void led_exit(void)
5872{
5873 unsigned int i;
5874
5875 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5876 if (tpacpi_leds[i].led_classdev.name)
5877 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5878 }
5879
5880 kfree(tpacpi_leds);
5881}
5882
5883static int __init tpacpi_init_led(unsigned int led)
5884{
5885 int rc;
5886
5887 tpacpi_leds[led].led = led;
5888
5889 /* LEDs with no name don't get registered */
5890 if (!tpacpi_led_names[led])
5891 return 0;
5892
5893 tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5894 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5895 if (led_supported == TPACPI_LED_570)
5896 tpacpi_leds[led].led_classdev.brightness_get =
5897 &led_sysfs_get;
5898
5899 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5900
5901 rc = led_classdev_register(&tpacpi_pdev->dev,
5902 &tpacpi_leds[led].led_classdev);
5903 if (rc < 0)
5904 tpacpi_leds[led].led_classdev.name = NULL;
5905
5906 return rc;
5907}
5908
5909static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5910 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5911 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5912 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5913
5914 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5915 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5916 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5917 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5918 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5919 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5920 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5921 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5922
5923 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5924 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5925 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5926 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5927 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5928
5929 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5930 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5931 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5932 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5933
5934 /* (1) - may have excess leds enabled on MSB */
5935
5936 /* Defaults (order matters, keep last, don't reorder!) */
5937 { /* Lenovo */
5938 .vendor = PCI_VENDOR_ID_LENOVO,
5939 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5940 .quirks = 0x1fffU,
5941 },
5942 { /* IBM ThinkPads with no EC version string */
5943 .vendor = PCI_VENDOR_ID_IBM,
5944 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5945 .quirks = 0x00ffU,
5946 },
5947 { /* IBM ThinkPads with EC version string */
5948 .vendor = PCI_VENDOR_ID_IBM,
5949 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5950 .quirks = 0x00bfU,
5951 },
5952};
5953
5954#undef TPACPI_LEDQ_IBM
5955#undef TPACPI_LEDQ_LNV
5956
5957static enum led_access_mode __init led_init_detect_mode(void)
5958{
5959 acpi_status status;
5960
5961 if (tpacpi_is_ibm()) {
5962 /* 570 */
5963 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5964 if (ACPI_SUCCESS(status))
5965 return TPACPI_LED_570;
5966
5967 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5968 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5969 if (ACPI_SUCCESS(status))
5970 return TPACPI_LED_OLD;
5971 }
5972
5973 /* most others */
5974 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5975 if (ACPI_SUCCESS(status))
5976 return TPACPI_LED_NEW;
5977
5978 /* R30, R31, and unknown firmwares */
5979 led_handle = NULL;
5980 return TPACPI_LED_NONE;
5981}
5982
5983static int __init led_init(struct ibm_init_struct *iibm)
5984{
5985 unsigned int i;
5986 int rc;
5987 unsigned long useful_leds;
5988
5989 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5990
5991 led_supported = led_init_detect_mode();
5992
5993 if (led_supported != TPACPI_LED_NONE) {
5994 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5995 ARRAY_SIZE(led_useful_qtable));
5996
5997 if (!useful_leds) {
5998 led_handle = NULL;
5999 led_supported = TPACPI_LED_NONE;
6000 }
6001 }
6002
6003 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6004 str_supported(led_supported), led_supported);
6005
6006 if (led_supported == TPACPI_LED_NONE)
6007 return 1;
6008
6009 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
6010 GFP_KERNEL);
6011 if (!tpacpi_leds) {
6012 pr_err("Out of memory for LED data\n");
6013 return -ENOMEM;
6014 }
6015
6016 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6017 tpacpi_leds[i].led = -1;
6018
6019 if (!tpacpi_is_led_restricted(i) &&
6020 test_bit(i, &useful_leds)) {
6021 rc = tpacpi_init_led(i);
6022 if (rc < 0) {
6023 led_exit();
6024 return rc;
6025 }
6026 }
6027 }
6028
6029#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6030 pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6031#endif
6032 return 0;
6033}
6034
6035#define str_led_status(s) \
6036 ((s) == TPACPI_LED_OFF ? "off" : \
6037 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
6038
6039static int led_read(struct seq_file *m)
6040{
6041 if (!led_supported) {
6042 seq_printf(m, "status:\t\tnot supported\n");
6043 return 0;
6044 }
6045 seq_printf(m, "status:\t\tsupported\n");
6046
6047 if (led_supported == TPACPI_LED_570) {
6048 /* 570 */
6049 int i, status;
6050 for (i = 0; i < 8; i++) {
6051 status = led_get_status(i);
6052 if (status < 0)
6053 return -EIO;
6054 seq_printf(m, "%d:\t\t%s\n",
6055 i, str_led_status(status));
6056 }
6057 }
6058
6059 seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6060
6061 return 0;
6062}
6063
6064static int led_write(char *buf)
6065{
6066 char *cmd;
6067 int led, rc;
6068 enum led_status_t s;
6069
6070 if (!led_supported)
6071 return -ENODEV;
6072
6073 while ((cmd = next_cmd(&buf))) {
6074 if (sscanf(cmd, "%d", &led) != 1)
6075 return -EINVAL;
6076
6077 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1) ||
6078 tpacpi_leds[led].led < 0)
6079 return -ENODEV;
6080
6081 if (strstr(cmd, "off")) {
6082 s = TPACPI_LED_OFF;
6083 } else if (strstr(cmd, "on")) {
6084 s = TPACPI_LED_ON;
6085 } else if (strstr(cmd, "blink")) {
6086 s = TPACPI_LED_BLINK;
6087 } else {
6088 return -EINVAL;
6089 }
6090
6091 rc = led_set_status(led, s);
6092 if (rc < 0)
6093 return rc;
6094 }
6095
6096 return 0;
6097}
6098
6099static struct ibm_struct led_driver_data = {
6100 .name = "led",
6101 .read = led_read,
6102 .write = led_write,
6103 .exit = led_exit,
6104};
6105
6106/*************************************************************************
6107 * Beep subdriver
6108 */
6109
6110TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
6111
6112#define TPACPI_BEEP_Q1 0x0001
6113
6114static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6115 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6116 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6117};
6118
6119static int __init beep_init(struct ibm_init_struct *iibm)
6120{
6121 unsigned long quirks;
6122
6123 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6124
6125 TPACPI_ACPIHANDLE_INIT(beep);
6126
6127 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6128 str_supported(beep_handle != NULL));
6129
6130 quirks = tpacpi_check_quirks(beep_quirk_table,
6131 ARRAY_SIZE(beep_quirk_table));
6132
6133 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6134
6135 return (beep_handle) ? 0 : 1;
6136}
6137
6138static int beep_read(struct seq_file *m)
6139{
6140 if (!beep_handle)
6141 seq_printf(m, "status:\t\tnot supported\n");
6142 else {
6143 seq_printf(m, "status:\t\tsupported\n");
6144 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6145 }
6146
6147 return 0;
6148}
6149
6150static int beep_write(char *buf)
6151{
6152 char *cmd;
6153 int beep_cmd;
6154
6155 if (!beep_handle)
6156 return -ENODEV;
6157
6158 while ((cmd = next_cmd(&buf))) {
6159 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6160 beep_cmd >= 0 && beep_cmd <= 17) {
6161 /* beep_cmd set */
6162 } else
6163 return -EINVAL;
6164 if (tp_features.beep_needs_two_args) {
6165 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6166 beep_cmd, 0))
6167 return -EIO;
6168 } else {
6169 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6170 beep_cmd))
6171 return -EIO;
6172 }
6173 }
6174
6175 return 0;
6176}
6177
6178static struct ibm_struct beep_driver_data = {
6179 .name = "beep",
6180 .read = beep_read,
6181 .write = beep_write,
6182};
6183
6184/*************************************************************************
6185 * Thermal subdriver
6186 */
6187
6188enum thermal_access_mode {
6189 TPACPI_THERMAL_NONE = 0, /* No thermal support */
6190 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
6191 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
6192 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
6193 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
6194};
6195
6196enum { /* TPACPI_THERMAL_TPEC_* */
6197 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
6198 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
6199 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
6200
6201 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6202};
6203
6204
6205#define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
6206struct ibm_thermal_sensors_struct {
6207 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6208};
6209
6210static enum thermal_access_mode thermal_read_mode;
6211
6212/* idx is zero-based */
6213static int thermal_get_sensor(int idx, s32 *value)
6214{
6215 int t;
6216 s8 tmp;
6217 char tmpi[5];
6218
6219 t = TP_EC_THERMAL_TMP0;
6220
6221 switch (thermal_read_mode) {
6222#if TPACPI_MAX_THERMAL_SENSORS >= 16
6223 case TPACPI_THERMAL_TPEC_16:
6224 if (idx >= 8 && idx <= 15) {
6225 t = TP_EC_THERMAL_TMP8;
6226 idx -= 8;
6227 }
6228 /* fallthrough */
6229#endif
6230 case TPACPI_THERMAL_TPEC_8:
6231 if (idx <= 7) {
6232 if (!acpi_ec_read(t + idx, &tmp))
6233 return -EIO;
6234 *value = tmp * 1000;
6235 return 0;
6236 }
6237 break;
6238
6239 case TPACPI_THERMAL_ACPI_UPDT:
6240 if (idx <= 7) {
6241 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6242 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6243 return -EIO;
6244 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6245 return -EIO;
6246 *value = (t - 2732) * 100;
6247 return 0;
6248 }
6249 break;
6250
6251 case TPACPI_THERMAL_ACPI_TMP07:
6252 if (idx <= 7) {
6253 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6254 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6255 return -EIO;
6256 if (t > 127 || t < -127)
6257 t = TP_EC_THERMAL_TMP_NA;
6258 *value = t * 1000;
6259 return 0;
6260 }
6261 break;
6262
6263 case TPACPI_THERMAL_NONE:
6264 default:
6265 return -ENOSYS;
6266 }
6267
6268 return -EINVAL;
6269}
6270
6271static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6272{
6273 int res, i;
6274 int n;
6275
6276 n = 8;
6277 i = 0;
6278
6279 if (!s)
6280 return -EINVAL;
6281
6282 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6283 n = 16;
6284
6285 for (i = 0 ; i < n; i++) {
6286 res = thermal_get_sensor(i, &s->temp[i]);
6287 if (res)
6288 return res;
6289 }
6290
6291 return n;
6292}
6293
6294static void thermal_dump_all_sensors(void)
6295{
6296 int n, i;
6297 struct ibm_thermal_sensors_struct t;
6298
6299 n = thermal_get_sensors(&t);
6300 if (n <= 0)
6301 return;
6302
6303 pr_notice("temperatures (Celsius):");
6304
6305 for (i = 0; i < n; i++) {
6306 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6307 pr_cont(" %d", (int)(t.temp[i] / 1000));
6308 else
6309 pr_cont(" N/A");
6310 }
6311
6312 pr_cont("\n");
6313}
6314
6315/* sysfs temp##_input -------------------------------------------------- */
6316
6317static ssize_t thermal_temp_input_show(struct device *dev,
6318 struct device_attribute *attr,
6319 char *buf)
6320{
6321 struct sensor_device_attribute *sensor_attr =
6322 to_sensor_dev_attr(attr);
6323 int idx = sensor_attr->index;
6324 s32 value;
6325 int res;
6326
6327 res = thermal_get_sensor(idx, &value);
6328 if (res)
6329 return res;
6330 if (value == TPACPI_THERMAL_SENSOR_NA)
6331 return -ENXIO;
6332
6333 return snprintf(buf, PAGE_SIZE, "%d\n", value);
6334}
6335
6336#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6337 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6338 thermal_temp_input_show, NULL, _idxB)
6339
6340static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6341 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6342 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6343 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6344 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6345 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6346 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6347 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6348 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6349 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6350 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6351 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6352 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6353 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6354 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6355 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6356 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6357};
6358
6359#define THERMAL_ATTRS(X) \
6360 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6361
6362static struct attribute *thermal_temp_input_attr[] = {
6363 THERMAL_ATTRS(8),
6364 THERMAL_ATTRS(9),
6365 THERMAL_ATTRS(10),
6366 THERMAL_ATTRS(11),
6367 THERMAL_ATTRS(12),
6368 THERMAL_ATTRS(13),
6369 THERMAL_ATTRS(14),
6370 THERMAL_ATTRS(15),
6371 THERMAL_ATTRS(0),
6372 THERMAL_ATTRS(1),
6373 THERMAL_ATTRS(2),
6374 THERMAL_ATTRS(3),
6375 THERMAL_ATTRS(4),
6376 THERMAL_ATTRS(5),
6377 THERMAL_ATTRS(6),
6378 THERMAL_ATTRS(7),
6379 NULL
6380};
6381
6382static const struct attribute_group thermal_temp_input16_group = {
6383 .attrs = thermal_temp_input_attr
6384};
6385
6386static const struct attribute_group thermal_temp_input8_group = {
6387 .attrs = &thermal_temp_input_attr[8]
6388};
6389
6390#undef THERMAL_SENSOR_ATTR_TEMP
6391#undef THERMAL_ATTRS
6392
6393/* --------------------------------------------------------------------- */
6394
6395static int __init thermal_init(struct ibm_init_struct *iibm)
6396{
6397 u8 t, ta1, ta2;
6398 int i;
6399 int acpi_tmp7;
6400 int res;
6401
6402 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6403
6404 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6405
6406 if (thinkpad_id.ec_model) {
6407 /*
6408 * Direct EC access mode: sensors at registers
6409 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6410 * non-implemented, thermal sensors return 0x80 when
6411 * not available
6412 */
6413
6414 ta1 = ta2 = 0;
6415 for (i = 0; i < 8; i++) {
6416 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6417 ta1 |= t;
6418 } else {
6419 ta1 = 0;
6420 break;
6421 }
6422 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6423 ta2 |= t;
6424 } else {
6425 ta1 = 0;
6426 break;
6427 }
6428 }
6429 if (ta1 == 0) {
6430 /* This is sheer paranoia, but we handle it anyway */
6431 if (acpi_tmp7) {
6432 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6433 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6434 } else {
6435 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6436 thermal_read_mode = TPACPI_THERMAL_NONE;
6437 }
6438 } else {
6439 thermal_read_mode =
6440 (ta2 != 0) ?
6441 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6442 }
6443 } else if (acpi_tmp7) {
6444 if (tpacpi_is_ibm() &&
6445 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6446 /* 600e/x, 770e, 770x */
6447 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6448 } else {
6449 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6450 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6451 }
6452 } else {
6453 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6454 thermal_read_mode = TPACPI_THERMAL_NONE;
6455 }
6456
6457 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6458 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6459 thermal_read_mode);
6460
6461 switch (thermal_read_mode) {
6462 case TPACPI_THERMAL_TPEC_16:
6463 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6464 &thermal_temp_input16_group);
6465 if (res)
6466 return res;
6467 break;
6468 case TPACPI_THERMAL_TPEC_8:
6469 case TPACPI_THERMAL_ACPI_TMP07:
6470 case TPACPI_THERMAL_ACPI_UPDT:
6471 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6472 &thermal_temp_input8_group);
6473 if (res)
6474 return res;
6475 break;
6476 case TPACPI_THERMAL_NONE:
6477 default:
6478 return 1;
6479 }
6480
6481 return 0;
6482}
6483
6484static void thermal_exit(void)
6485{
6486 switch (thermal_read_mode) {
6487 case TPACPI_THERMAL_TPEC_16:
6488 sysfs_remove_group(&tpacpi_hwmon->kobj,
6489 &thermal_temp_input16_group);
6490 break;
6491 case TPACPI_THERMAL_TPEC_8:
6492 case TPACPI_THERMAL_ACPI_TMP07:
6493 case TPACPI_THERMAL_ACPI_UPDT:
6494 sysfs_remove_group(&tpacpi_hwmon->kobj,
6495 &thermal_temp_input8_group);
6496 break;
6497 case TPACPI_THERMAL_NONE:
6498 default:
6499 break;
6500 }
6501}
6502
6503static int thermal_read(struct seq_file *m)
6504{
6505 int n, i;
6506 struct ibm_thermal_sensors_struct t;
6507
6508 n = thermal_get_sensors(&t);
6509 if (unlikely(n < 0))
6510 return n;
6511
6512 seq_printf(m, "temperatures:\t");
6513
6514 if (n > 0) {
6515 for (i = 0; i < (n - 1); i++)
6516 seq_printf(m, "%d ", t.temp[i] / 1000);
6517 seq_printf(m, "%d\n", t.temp[i] / 1000);
6518 } else
6519 seq_printf(m, "not supported\n");
6520
6521 return 0;
6522}
6523
6524static struct ibm_struct thermal_driver_data = {
6525 .name = "thermal",
6526 .read = thermal_read,
6527 .exit = thermal_exit,
6528};
6529
6530/*************************************************************************
6531 * Backlight/brightness subdriver
6532 */
6533
6534#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6535
6536/*
6537 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6538 * CMOS NVRAM byte 0x5E, bits 0-3.
6539 *
6540 * EC HBRV (0x31) has the following layout
6541 * Bit 7: unknown function
6542 * Bit 6: unknown function
6543 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6544 * Bit 4: must be set to zero to avoid problems
6545 * Bit 3-0: backlight brightness level
6546 *
6547 * brightness_get_raw returns status data in the HBRV layout
6548 *
6549 * WARNING: The X61 has been verified to use HBRV for something else, so
6550 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6551 * testing on the very early *60 Lenovo models...
6552 */
6553
6554enum {
6555 TP_EC_BACKLIGHT = 0x31,
6556
6557 /* TP_EC_BACKLIGHT bitmasks */
6558 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6559 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6560 TP_EC_BACKLIGHT_MAPSW = 0x20,
6561};
6562
6563enum tpacpi_brightness_access_mode {
6564 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6565 TPACPI_BRGHT_MODE_EC, /* EC control */
6566 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6567 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6568 TPACPI_BRGHT_MODE_MAX
6569};
6570
6571static struct backlight_device *ibm_backlight_device;
6572
6573static enum tpacpi_brightness_access_mode brightness_mode =
6574 TPACPI_BRGHT_MODE_MAX;
6575
6576static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6577
6578static struct mutex brightness_mutex;
6579
6580/* NVRAM brightness access,
6581 * call with brightness_mutex held! */
6582static unsigned int tpacpi_brightness_nvram_get(void)
6583{
6584 u8 lnvram;
6585
6586 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6587 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6588 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6589 lnvram &= bright_maxlvl;
6590
6591 return lnvram;
6592}
6593
6594static void tpacpi_brightness_checkpoint_nvram(void)
6595{
6596 u8 lec = 0;
6597 u8 b_nvram;
6598
6599 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6600 return;
6601
6602 vdbg_printk(TPACPI_DBG_BRGHT,
6603 "trying to checkpoint backlight level to NVRAM...\n");
6604
6605 if (mutex_lock_killable(&brightness_mutex) < 0)
6606 return;
6607
6608 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6609 goto unlock;
6610 lec &= TP_EC_BACKLIGHT_LVLMSK;
6611 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6612
6613 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6614 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6615 /* NVRAM needs update */
6616 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6617 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6618 b_nvram |= lec;
6619 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6620 dbg_printk(TPACPI_DBG_BRGHT,
6621 "updated NVRAM backlight level to %u (0x%02x)\n",
6622 (unsigned int) lec, (unsigned int) b_nvram);
6623 } else
6624 vdbg_printk(TPACPI_DBG_BRGHT,
6625 "NVRAM backlight level already is %u (0x%02x)\n",
6626 (unsigned int) lec, (unsigned int) b_nvram);
6627
6628unlock:
6629 mutex_unlock(&brightness_mutex);
6630}
6631
6632
6633/* call with brightness_mutex held! */
6634static int tpacpi_brightness_get_raw(int *status)
6635{
6636 u8 lec = 0;
6637
6638 switch (brightness_mode) {
6639 case TPACPI_BRGHT_MODE_UCMS_STEP:
6640 *status = tpacpi_brightness_nvram_get();
6641 return 0;
6642 case TPACPI_BRGHT_MODE_EC:
6643 case TPACPI_BRGHT_MODE_ECNVRAM:
6644 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6645 return -EIO;
6646 *status = lec;
6647 return 0;
6648 default:
6649 return -ENXIO;
6650 }
6651}
6652
6653/* call with brightness_mutex held! */
6654/* do NOT call with illegal backlight level value */
6655static int tpacpi_brightness_set_ec(unsigned int value)
6656{
6657 u8 lec = 0;
6658
6659 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6660 return -EIO;
6661
6662 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6663 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6664 (value & TP_EC_BACKLIGHT_LVLMSK))))
6665 return -EIO;
6666
6667 return 0;
6668}
6669
6670/* call with brightness_mutex held! */
6671static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6672{
6673 int cmos_cmd, inc;
6674 unsigned int current_value, i;
6675
6676 current_value = tpacpi_brightness_nvram_get();
6677
6678 if (value == current_value)
6679 return 0;
6680
6681 cmos_cmd = (value > current_value) ?
6682 TP_CMOS_BRIGHTNESS_UP :
6683 TP_CMOS_BRIGHTNESS_DOWN;
6684 inc = (value > current_value) ? 1 : -1;
6685
6686 for (i = current_value; i != value; i += inc)
6687 if (issue_thinkpad_cmos_command(cmos_cmd))
6688 return -EIO;
6689
6690 return 0;
6691}
6692
6693/* May return EINTR which can always be mapped to ERESTARTSYS */
6694static int brightness_set(unsigned int value)
6695{
6696 int res;
6697
6698 if (value > bright_maxlvl)
6699 return -EINVAL;
6700
6701 vdbg_printk(TPACPI_DBG_BRGHT,
6702 "set backlight level to %d\n", value);
6703
6704 res = mutex_lock_killable(&brightness_mutex);
6705 if (res < 0)
6706 return res;
6707
6708 switch (brightness_mode) {
6709 case TPACPI_BRGHT_MODE_EC:
6710 case TPACPI_BRGHT_MODE_ECNVRAM:
6711 res = tpacpi_brightness_set_ec(value);
6712 break;
6713 case TPACPI_BRGHT_MODE_UCMS_STEP:
6714 res = tpacpi_brightness_set_ucmsstep(value);
6715 break;
6716 default:
6717 res = -ENXIO;
6718 }
6719
6720 mutex_unlock(&brightness_mutex);
6721 return res;
6722}
6723
6724/* sysfs backlight class ----------------------------------------------- */
6725
6726static int brightness_update_status(struct backlight_device *bd)
6727{
6728 unsigned int level =
6729 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6730 bd->props.power == FB_BLANK_UNBLANK) ?
6731 bd->props.brightness : 0;
6732
6733 dbg_printk(TPACPI_DBG_BRGHT,
6734 "backlight: attempt to set level to %d\n",
6735 level);
6736
6737 /* it is the backlight class's job (caller) to handle
6738 * EINTR and other errors properly */
6739 return brightness_set(level);
6740}
6741
6742static int brightness_get(struct backlight_device *bd)
6743{
6744 int status, res;
6745
6746 res = mutex_lock_killable(&brightness_mutex);
6747 if (res < 0)
6748 return 0;
6749
6750 res = tpacpi_brightness_get_raw(&status);
6751
6752 mutex_unlock(&brightness_mutex);
6753
6754 if (res < 0)
6755 return 0;
6756
6757 return status & TP_EC_BACKLIGHT_LVLMSK;
6758}
6759
6760static void tpacpi_brightness_notify_change(void)
6761{
6762 backlight_force_update(ibm_backlight_device,
6763 BACKLIGHT_UPDATE_HOTKEY);
6764}
6765
6766static const struct backlight_ops ibm_backlight_data = {
6767 .get_brightness = brightness_get,
6768 .update_status = brightness_update_status,
6769};
6770
6771/* --------------------------------------------------------------------- */
6772
6773/*
6774 * Call _BCL method of video device. On some ThinkPads this will
6775 * switch the firmware to the ACPI brightness control mode.
6776 */
6777
6778static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6779{
6780 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6781 union acpi_object *obj;
6782 struct acpi_device *device, *child;
6783 int rc;
6784
6785 if (acpi_bus_get_device(handle, &device))
6786 return 0;
6787
6788 rc = 0;
6789 list_for_each_entry(child, &device->children, node) {
6790 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6791 NULL, &buffer);
6792 if (ACPI_FAILURE(status))
6793 continue;
6794
6795 obj = (union acpi_object *)buffer.pointer;
6796 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6797 pr_err("Unknown _BCL data, please report this to %s\n",
6798 TPACPI_MAIL);
6799 rc = 0;
6800 } else {
6801 rc = obj->package.count;
6802 }
6803 break;
6804 }
6805
6806 kfree(buffer.pointer);
6807 return rc;
6808}
6809
6810
6811/*
6812 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6813 */
6814static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6815{
6816 acpi_handle video_device;
6817 int bcl_levels = 0;
6818
6819 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6820 if (video_device)
6821 bcl_levels = tpacpi_query_bcl_levels(video_device);
6822
6823 tp_features.bright_acpimode = (bcl_levels > 0);
6824
6825 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6826}
6827
6828/*
6829 * These are only useful for models that have only one possibility
6830 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6831 * these quirks.
6832 */
6833#define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6834#define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6835#define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6836
6837static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6838 /* Models with ATI GPUs known to require ECNVRAM mode */
6839 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6840
6841 /* Models with ATI GPUs that can use ECNVRAM */
6842 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6843 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6844 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6845 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6846
6847 /* Models with Intel Extreme Graphics 2 */
6848 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6849 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6850 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6851
6852 /* Models with Intel GMA900 */
6853 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6854 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6855 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6856};
6857
6858/*
6859 * Returns < 0 for error, otherwise sets tp_features.bright_*
6860 * and bright_maxlvl.
6861 */
6862static void __init tpacpi_detect_brightness_capabilities(void)
6863{
6864 unsigned int b;
6865
6866 vdbg_printk(TPACPI_DBG_INIT,
6867 "detecting firmware brightness interface capabilities\n");
6868
6869 /* we could run a quirks check here (same table used by
6870 * brightness_init) if needed */
6871
6872 /*
6873 * We always attempt to detect acpi support, so as to switch
6874 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6875 * going to publish a backlight interface
6876 */
6877 b = tpacpi_check_std_acpi_brightness_support();
6878 switch (b) {
6879 case 16:
6880 bright_maxlvl = 15;
6881 break;
6882 case 8:
6883 case 0:
6884 bright_maxlvl = 7;
6885 break;
6886 default:
6887 tp_features.bright_unkfw = 1;
6888 bright_maxlvl = b - 1;
6889 }
6890 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6891}
6892
6893static int __init brightness_init(struct ibm_init_struct *iibm)
6894{
6895 struct backlight_properties props;
6896 int b;
6897 unsigned long quirks;
6898
6899 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6900
6901 mutex_init(&brightness_mutex);
6902
6903 quirks = tpacpi_check_quirks(brightness_quirk_table,
6904 ARRAY_SIZE(brightness_quirk_table));
6905
6906 /* tpacpi_detect_brightness_capabilities() must have run already */
6907
6908 /* if it is unknown, we don't handle it: it wouldn't be safe */
6909 if (tp_features.bright_unkfw)
6910 return 1;
6911
6912 if (!brightness_enable) {
6913 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6914 "brightness support disabled by module parameter\n");
6915 return 1;
6916 }
6917
6918 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6919 if (brightness_enable > 1) {
6920 pr_info("Standard ACPI backlight interface available, not loading native one\n");
6921 return 1;
6922 } else if (brightness_enable == 1) {
6923 pr_warn("Cannot enable backlight brightness support, ACPI is already handling it. Refer to the acpi_backlight kernel parameter.\n");
6924 return 1;
6925 }
6926 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6927 pr_notice("Standard ACPI backlight interface not available, thinkpad_acpi native brightness control enabled\n");
6928 }
6929
6930 /*
6931 * Check for module parameter bogosity, note that we
6932 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6933 * able to detect "unspecified"
6934 */
6935 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6936 return -EINVAL;
6937
6938 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6939 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6940 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6941 if (quirks & TPACPI_BRGHT_Q_EC)
6942 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6943 else
6944 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6945
6946 dbg_printk(TPACPI_DBG_BRGHT,
6947 "driver auto-selected brightness_mode=%d\n",
6948 brightness_mode);
6949 }
6950
6951 /* Safety */
6952 if (!tpacpi_is_ibm() &&
6953 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6954 brightness_mode == TPACPI_BRGHT_MODE_EC))
6955 return -EINVAL;
6956
6957 if (tpacpi_brightness_get_raw(&b) < 0)
6958 return 1;
6959
6960 memset(&props, 0, sizeof(struct backlight_properties));
6961 props.type = BACKLIGHT_PLATFORM;
6962 props.max_brightness = bright_maxlvl;
6963 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6964 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6965 NULL, NULL,
6966 &ibm_backlight_data,
6967 &props);
6968 if (IS_ERR(ibm_backlight_device)) {
6969 int rc = PTR_ERR(ibm_backlight_device);
6970 ibm_backlight_device = NULL;
6971 pr_err("Could not register backlight device\n");
6972 return rc;
6973 }
6974 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6975 "brightness is supported\n");
6976
6977 if (quirks & TPACPI_BRGHT_Q_ASK) {
6978 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
6979 brightness_mode);
6980 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
6981 TPACPI_MAIL);
6982 }
6983
6984 /* Added by mistake in early 2007. Probably useless, but it could
6985 * be working around some unknown firmware problem where the value
6986 * read at startup doesn't match the real hardware state... so leave
6987 * it in place just in case */
6988 backlight_update_status(ibm_backlight_device);
6989
6990 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6991 "brightness: registering brightness hotkeys as change notification\n");
6992 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6993 | TP_ACPI_HKEY_BRGHTUP_MASK
6994 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6995 return 0;
6996}
6997
6998static void brightness_suspend(void)
6999{
7000 tpacpi_brightness_checkpoint_nvram();
7001}
7002
7003static void brightness_shutdown(void)
7004{
7005 tpacpi_brightness_checkpoint_nvram();
7006}
7007
7008static void brightness_exit(void)
7009{
7010 if (ibm_backlight_device) {
7011 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7012 "calling backlight_device_unregister()\n");
7013 backlight_device_unregister(ibm_backlight_device);
7014 }
7015
7016 tpacpi_brightness_checkpoint_nvram();
7017}
7018
7019static int brightness_read(struct seq_file *m)
7020{
7021 int level;
7022
7023 level = brightness_get(NULL);
7024 if (level < 0) {
7025 seq_printf(m, "level:\t\tunreadable\n");
7026 } else {
7027 seq_printf(m, "level:\t\t%d\n", level);
7028 seq_printf(m, "commands:\tup, down\n");
7029 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7030 bright_maxlvl);
7031 }
7032
7033 return 0;
7034}
7035
7036static int brightness_write(char *buf)
7037{
7038 int level;
7039 int rc;
7040 char *cmd;
7041
7042 level = brightness_get(NULL);
7043 if (level < 0)
7044 return level;
7045
7046 while ((cmd = next_cmd(&buf))) {
7047 if (strlencmp(cmd, "up") == 0) {
7048 if (level < bright_maxlvl)
7049 level++;
7050 } else if (strlencmp(cmd, "down") == 0) {
7051 if (level > 0)
7052 level--;
7053 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7054 level >= 0 && level <= bright_maxlvl) {
7055 /* new level set */
7056 } else
7057 return -EINVAL;
7058 }
7059
7060 tpacpi_disclose_usertask("procfs brightness",
7061 "set level to %d\n", level);
7062
7063 /*
7064 * Now we know what the final level should be, so we try to set it.
7065 * Doing it this way makes the syscall restartable in case of EINTR
7066 */
7067 rc = brightness_set(level);
7068 if (!rc && ibm_backlight_device)
7069 backlight_force_update(ibm_backlight_device,
7070 BACKLIGHT_UPDATE_SYSFS);
7071 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7072}
7073
7074static struct ibm_struct brightness_driver_data = {
7075 .name = "brightness",
7076 .read = brightness_read,
7077 .write = brightness_write,
7078 .exit = brightness_exit,
7079 .suspend = brightness_suspend,
7080 .shutdown = brightness_shutdown,
7081};
7082
7083/*************************************************************************
7084 * Volume subdriver
7085 */
7086
7087/*
7088 * IBM ThinkPads have a simple volume controller with MUTE gating.
7089 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7090 *
7091 * Since the *61 series (and probably also the later *60 series), Lenovo
7092 * ThinkPads only implement the MUTE gate.
7093 *
7094 * EC register 0x30
7095 * Bit 6: MUTE (1 mutes sound)
7096 * Bit 3-0: Volume
7097 * Other bits should be zero as far as we know.
7098 *
7099 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7100 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
7101 * such as bit 7 which is used to detect repeated presses of MUTE,
7102 * and we leave them unchanged.
7103 *
7104 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7105 * in response to user input. Unfortunately, this rarely works well.
7106 * The laptop changes the state of its internal MUTE gate and, on some
7107 * models, sends KEY_MUTE, causing any user code that responds to the
7108 * mute button to get confused. The hardware MUTE gate is also
7109 * unnecessary, since user code can handle the mute button without
7110 * kernel or EC help.
7111 *
7112 * To avoid confusing userspace, we simply disable all EC-based mute
7113 * and volume controls when possible.
7114 */
7115
7116#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7117
7118#define TPACPI_ALSA_DRVNAME "ThinkPad EC"
7119#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7120#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7121
7122#if SNDRV_CARDS <= 32
7123#define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
7124#else
7125#define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
7126#endif
7127static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7128static char *alsa_id = "ThinkPadEC";
7129static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7130
7131struct tpacpi_alsa_data {
7132 struct snd_card *card;
7133 struct snd_ctl_elem_id *ctl_mute_id;
7134 struct snd_ctl_elem_id *ctl_vol_id;
7135};
7136
7137static struct snd_card *alsa_card;
7138
7139enum {
7140 TP_EC_AUDIO = 0x30,
7141
7142 /* TP_EC_AUDIO bits */
7143 TP_EC_AUDIO_MUTESW = 6,
7144
7145 /* TP_EC_AUDIO bitmasks */
7146 TP_EC_AUDIO_LVL_MSK = 0x0F,
7147 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7148
7149 /* Maximum volume */
7150 TP_EC_VOLUME_MAX = 14,
7151};
7152
7153enum tpacpi_volume_access_mode {
7154 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
7155 TPACPI_VOL_MODE_EC, /* Pure EC control */
7156 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
7157 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
7158 TPACPI_VOL_MODE_MAX
7159};
7160
7161enum tpacpi_volume_capabilities {
7162 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
7163 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
7164 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
7165 TPACPI_VOL_CAP_MAX
7166};
7167
7168enum tpacpi_mute_btn_mode {
7169 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
7170 /* We don't know what mode 1 is. */
7171 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
7172 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
7173};
7174
7175static enum tpacpi_volume_access_mode volume_mode =
7176 TPACPI_VOL_MODE_MAX;
7177
7178static enum tpacpi_volume_capabilities volume_capabilities;
7179static bool volume_control_allowed;
7180static bool software_mute_requested = true;
7181static bool software_mute_active;
7182static int software_mute_orig_mode;
7183
7184/*
7185 * Used to syncronize writers to TP_EC_AUDIO and
7186 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7187 */
7188static struct mutex volume_mutex;
7189
7190static void tpacpi_volume_checkpoint_nvram(void)
7191{
7192 u8 lec = 0;
7193 u8 b_nvram;
7194 u8 ec_mask;
7195
7196 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7197 return;
7198 if (!volume_control_allowed)
7199 return;
7200 if (software_mute_active)
7201 return;
7202
7203 vdbg_printk(TPACPI_DBG_MIXER,
7204 "trying to checkpoint mixer state to NVRAM...\n");
7205
7206 if (tp_features.mixer_no_level_control)
7207 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7208 else
7209 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7210
7211 if (mutex_lock_killable(&volume_mutex) < 0)
7212 return;
7213
7214 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7215 goto unlock;
7216 lec &= ec_mask;
7217 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7218
7219 if (lec != (b_nvram & ec_mask)) {
7220 /* NVRAM needs update */
7221 b_nvram &= ~ec_mask;
7222 b_nvram |= lec;
7223 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7224 dbg_printk(TPACPI_DBG_MIXER,
7225 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7226 (unsigned int) lec, (unsigned int) b_nvram);
7227 } else {
7228 vdbg_printk(TPACPI_DBG_MIXER,
7229 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7230 (unsigned int) lec, (unsigned int) b_nvram);
7231 }
7232
7233unlock:
7234 mutex_unlock(&volume_mutex);
7235}
7236
7237static int volume_get_status_ec(u8 *status)
7238{
7239 u8 s;
7240
7241 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7242 return -EIO;
7243
7244 *status = s;
7245
7246 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7247
7248 return 0;
7249}
7250
7251static int volume_get_status(u8 *status)
7252{
7253 return volume_get_status_ec(status);
7254}
7255
7256static int volume_set_status_ec(const u8 status)
7257{
7258 if (!acpi_ec_write(TP_EC_AUDIO, status))
7259 return -EIO;
7260
7261 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7262
7263 /*
7264 * On X200s, and possibly on others, it can take a while for
7265 * reads to become correct.
7266 */
7267 msleep(1);
7268
7269 return 0;
7270}
7271
7272static int volume_set_status(const u8 status)
7273{
7274 return volume_set_status_ec(status);
7275}
7276
7277/* returns < 0 on error, 0 on no change, 1 on change */
7278static int __volume_set_mute_ec(const bool mute)
7279{
7280 int rc;
7281 u8 s, n;
7282
7283 if (mutex_lock_killable(&volume_mutex) < 0)
7284 return -EINTR;
7285
7286 rc = volume_get_status_ec(&s);
7287 if (rc)
7288 goto unlock;
7289
7290 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7291 s & ~TP_EC_AUDIO_MUTESW_MSK;
7292
7293 if (n != s) {
7294 rc = volume_set_status_ec(n);
7295 if (!rc)
7296 rc = 1;
7297 }
7298
7299unlock:
7300 mutex_unlock(&volume_mutex);
7301 return rc;
7302}
7303
7304static int volume_alsa_set_mute(const bool mute)
7305{
7306 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7307 (mute) ? "" : "un");
7308 return __volume_set_mute_ec(mute);
7309}
7310
7311static int volume_set_mute(const bool mute)
7312{
7313 int rc;
7314
7315 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7316 (mute) ? "" : "un");
7317
7318 rc = __volume_set_mute_ec(mute);
7319 return (rc < 0) ? rc : 0;
7320}
7321
7322/* returns < 0 on error, 0 on no change, 1 on change */
7323static int __volume_set_volume_ec(const u8 vol)
7324{
7325 int rc;
7326 u8 s, n;
7327
7328 if (vol > TP_EC_VOLUME_MAX)
7329 return -EINVAL;
7330
7331 if (mutex_lock_killable(&volume_mutex) < 0)
7332 return -EINTR;
7333
7334 rc = volume_get_status_ec(&s);
7335 if (rc)
7336 goto unlock;
7337
7338 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7339
7340 if (n != s) {
7341 rc = volume_set_status_ec(n);
7342 if (!rc)
7343 rc = 1;
7344 }
7345
7346unlock:
7347 mutex_unlock(&volume_mutex);
7348 return rc;
7349}
7350
7351static int volume_set_software_mute(bool startup)
7352{
7353 int result;
7354
7355 if (!tpacpi_is_lenovo())
7356 return -ENODEV;
7357
7358 if (startup) {
7359 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7360 "HAUM", "qd"))
7361 return -EIO;
7362
7363 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7364 "Initial HAUM setting was %d\n",
7365 software_mute_orig_mode);
7366 }
7367
7368 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7369 (int)TP_EC_MUTE_BTN_NONE))
7370 return -EIO;
7371
7372 if (result != TP_EC_MUTE_BTN_NONE)
7373 pr_warn("Unexpected SAUM result %d\n",
7374 result);
7375
7376 /*
7377 * In software mute mode, the standard codec controls take
7378 * precendence, so we unmute the ThinkPad HW switch at
7379 * startup. Just on case there are SAUM-capable ThinkPads
7380 * with level controls, set max HW volume as well.
7381 */
7382 if (tp_features.mixer_no_level_control)
7383 result = volume_set_mute(false);
7384 else
7385 result = volume_set_status(TP_EC_VOLUME_MAX);
7386
7387 if (result != 0)
7388 pr_warn("Failed to unmute the HW mute switch\n");
7389
7390 return 0;
7391}
7392
7393static void volume_exit_software_mute(void)
7394{
7395 int r;
7396
7397 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7398 || r != software_mute_orig_mode)
7399 pr_warn("Failed to restore mute mode\n");
7400}
7401
7402static int volume_alsa_set_volume(const u8 vol)
7403{
7404 dbg_printk(TPACPI_DBG_MIXER,
7405 "ALSA: trying to set volume level to %hu\n", vol);
7406 return __volume_set_volume_ec(vol);
7407}
7408
7409static void volume_alsa_notify_change(void)
7410{
7411 struct tpacpi_alsa_data *d;
7412
7413 if (alsa_card && alsa_card->private_data) {
7414 d = alsa_card->private_data;
7415 if (d->ctl_mute_id)
7416 snd_ctl_notify(alsa_card,
7417 SNDRV_CTL_EVENT_MASK_VALUE,
7418 d->ctl_mute_id);
7419 if (d->ctl_vol_id)
7420 snd_ctl_notify(alsa_card,
7421 SNDRV_CTL_EVENT_MASK_VALUE,
7422 d->ctl_vol_id);
7423 }
7424}
7425
7426static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7427 struct snd_ctl_elem_info *uinfo)
7428{
7429 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7430 uinfo->count = 1;
7431 uinfo->value.integer.min = 0;
7432 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7433 return 0;
7434}
7435
7436static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7437 struct snd_ctl_elem_value *ucontrol)
7438{
7439 u8 s;
7440 int rc;
7441
7442 rc = volume_get_status(&s);
7443 if (rc < 0)
7444 return rc;
7445
7446 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7447 return 0;
7448}
7449
7450static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7451 struct snd_ctl_elem_value *ucontrol)
7452{
7453 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7454 ucontrol->value.integer.value[0]);
7455 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7456}
7457
7458#define volume_alsa_mute_info snd_ctl_boolean_mono_info
7459
7460static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7461 struct snd_ctl_elem_value *ucontrol)
7462{
7463 u8 s;
7464 int rc;
7465
7466 rc = volume_get_status(&s);
7467 if (rc < 0)
7468 return rc;
7469
7470 ucontrol->value.integer.value[0] =
7471 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7472 return 0;
7473}
7474
7475static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7476 struct snd_ctl_elem_value *ucontrol)
7477{
7478 tpacpi_disclose_usertask("ALSA", "%smute\n",
7479 ucontrol->value.integer.value[0] ?
7480 "un" : "");
7481 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7482}
7483
7484static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7485 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7486 .name = "Console Playback Volume",
7487 .index = 0,
7488 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7489 .info = volume_alsa_vol_info,
7490 .get = volume_alsa_vol_get,
7491};
7492
7493static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7494 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7495 .name = "Console Playback Switch",
7496 .index = 0,
7497 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7498 .info = volume_alsa_mute_info,
7499 .get = volume_alsa_mute_get,
7500};
7501
7502static void volume_suspend(void)
7503{
7504 tpacpi_volume_checkpoint_nvram();
7505}
7506
7507static void volume_resume(void)
7508{
7509 if (software_mute_active) {
7510 if (volume_set_software_mute(false) < 0)
7511 pr_warn("Failed to restore software mute\n");
7512 } else {
7513 volume_alsa_notify_change();
7514 }
7515}
7516
7517static void volume_shutdown(void)
7518{
7519 tpacpi_volume_checkpoint_nvram();
7520}
7521
7522static void volume_exit(void)
7523{
7524 if (alsa_card) {
7525 snd_card_free(alsa_card);
7526 alsa_card = NULL;
7527 }
7528
7529 tpacpi_volume_checkpoint_nvram();
7530
7531 if (software_mute_active)
7532 volume_exit_software_mute();
7533}
7534
7535static int __init volume_create_alsa_mixer(void)
7536{
7537 struct snd_card *card;
7538 struct tpacpi_alsa_data *data;
7539 struct snd_kcontrol *ctl_vol;
7540 struct snd_kcontrol *ctl_mute;
7541 int rc;
7542
7543 rc = snd_card_new(&tpacpi_pdev->dev,
7544 alsa_index, alsa_id, THIS_MODULE,
7545 sizeof(struct tpacpi_alsa_data), &card);
7546 if (rc < 0 || !card) {
7547 pr_err("Failed to create ALSA card structures: %d\n", rc);
7548 return 1;
7549 }
7550
7551 BUG_ON(!card->private_data);
7552 data = card->private_data;
7553 data->card = card;
7554
7555 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7556 sizeof(card->driver));
7557 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7558 sizeof(card->shortname));
7559 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7560 (thinkpad_id.ec_version_str) ?
7561 thinkpad_id.ec_version_str : "(unknown)");
7562 snprintf(card->longname, sizeof(card->longname),
7563 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7564 (thinkpad_id.ec_version_str) ?
7565 thinkpad_id.ec_version_str : "unknown");
7566
7567 if (volume_control_allowed) {
7568 volume_alsa_control_vol.put = volume_alsa_vol_put;
7569 volume_alsa_control_vol.access =
7570 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7571
7572 volume_alsa_control_mute.put = volume_alsa_mute_put;
7573 volume_alsa_control_mute.access =
7574 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7575 }
7576
7577 if (!tp_features.mixer_no_level_control) {
7578 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7579 rc = snd_ctl_add(card, ctl_vol);
7580 if (rc < 0) {
7581 pr_err("Failed to create ALSA volume control: %d\n",
7582 rc);
7583 goto err_exit;
7584 }
7585 data->ctl_vol_id = &ctl_vol->id;
7586 }
7587
7588 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7589 rc = snd_ctl_add(card, ctl_mute);
7590 if (rc < 0) {
7591 pr_err("Failed to create ALSA mute control: %d\n", rc);
7592 goto err_exit;
7593 }
7594 data->ctl_mute_id = &ctl_mute->id;
7595
7596 rc = snd_card_register(card);
7597 if (rc < 0) {
7598 pr_err("Failed to register ALSA card: %d\n", rc);
7599 goto err_exit;
7600 }
7601
7602 alsa_card = card;
7603 return 0;
7604
7605err_exit:
7606 snd_card_free(card);
7607 return 1;
7608}
7609
7610#define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7611#define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7612
7613static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7614 /* Whitelist volume level on all IBM by default */
7615 { .vendor = PCI_VENDOR_ID_IBM,
7616 .bios = TPACPI_MATCH_ANY,
7617 .ec = TPACPI_MATCH_ANY,
7618 .quirks = TPACPI_VOL_Q_LEVEL },
7619
7620 /* Lenovo models with volume control (needs confirmation) */
7621 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7622 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7623 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7624 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7625 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7626 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7627 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7628
7629 /* Whitelist mute-only on all Lenovo by default */
7630 { .vendor = PCI_VENDOR_ID_LENOVO,
7631 .bios = TPACPI_MATCH_ANY,
7632 .ec = TPACPI_MATCH_ANY,
7633 .quirks = TPACPI_VOL_Q_MUTEONLY }
7634};
7635
7636static int __init volume_init(struct ibm_init_struct *iibm)
7637{
7638 unsigned long quirks;
7639 int rc;
7640
7641 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7642
7643 mutex_init(&volume_mutex);
7644
7645 /*
7646 * Check for module parameter bogosity, note that we
7647 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7648 * able to detect "unspecified"
7649 */
7650 if (volume_mode > TPACPI_VOL_MODE_MAX)
7651 return -EINVAL;
7652
7653 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7654 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7655 TPACPI_MAIL);
7656 return 1;
7657 }
7658
7659 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7660 return -EINVAL;
7661
7662 /*
7663 * The ALSA mixer is our primary interface.
7664 * When disabled, don't install the subdriver at all
7665 */
7666 if (!alsa_enable) {
7667 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7668 "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7669 return 1;
7670 }
7671
7672 quirks = tpacpi_check_quirks(volume_quirk_table,
7673 ARRAY_SIZE(volume_quirk_table));
7674
7675 switch (volume_capabilities) {
7676 case TPACPI_VOL_CAP_AUTO:
7677 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7678 tp_features.mixer_no_level_control = 1;
7679 else if (quirks & TPACPI_VOL_Q_LEVEL)
7680 tp_features.mixer_no_level_control = 0;
7681 else
7682 return 1; /* no mixer */
7683 break;
7684 case TPACPI_VOL_CAP_VOLMUTE:
7685 tp_features.mixer_no_level_control = 0;
7686 break;
7687 case TPACPI_VOL_CAP_MUTEONLY:
7688 tp_features.mixer_no_level_control = 1;
7689 break;
7690 default:
7691 return 1;
7692 }
7693
7694 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7695 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7696 "using user-supplied volume_capabilities=%d\n",
7697 volume_capabilities);
7698
7699 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7700 volume_mode == TPACPI_VOL_MODE_MAX) {
7701 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7702
7703 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7704 "driver auto-selected volume_mode=%d\n",
7705 volume_mode);
7706 } else {
7707 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7708 "using user-supplied volume_mode=%d\n",
7709 volume_mode);
7710 }
7711
7712 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7713 "mute is supported, volume control is %s\n",
7714 str_supported(!tp_features.mixer_no_level_control));
7715
7716 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7717 software_mute_active = true;
7718 } else {
7719 rc = volume_create_alsa_mixer();
7720 if (rc) {
7721 pr_err("Could not create the ALSA mixer interface\n");
7722 return rc;
7723 }
7724
7725 pr_info("Console audio control enabled, mode: %s\n",
7726 (volume_control_allowed) ?
7727 "override (read/write)" :
7728 "monitor (read only)");
7729 }
7730
7731 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7732 "registering volume hotkeys as change notification\n");
7733 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7734 | TP_ACPI_HKEY_VOLUP_MASK
7735 | TP_ACPI_HKEY_VOLDWN_MASK
7736 | TP_ACPI_HKEY_MUTE_MASK);
7737
7738 return 0;
7739}
7740
7741static int volume_read(struct seq_file *m)
7742{
7743 u8 status;
7744
7745 if (volume_get_status(&status) < 0) {
7746 seq_printf(m, "level:\t\tunreadable\n");
7747 } else {
7748 if (tp_features.mixer_no_level_control)
7749 seq_printf(m, "level:\t\tunsupported\n");
7750 else
7751 seq_printf(m, "level:\t\t%d\n",
7752 status & TP_EC_AUDIO_LVL_MSK);
7753
7754 seq_printf(m, "mute:\t\t%s\n",
7755 onoff(status, TP_EC_AUDIO_MUTESW));
7756
7757 if (volume_control_allowed) {
7758 seq_printf(m, "commands:\tunmute, mute\n");
7759 if (!tp_features.mixer_no_level_control) {
7760 seq_printf(m, "commands:\tup, down\n");
7761 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7762 TP_EC_VOLUME_MAX);
7763 }
7764 }
7765 }
7766
7767 return 0;
7768}
7769
7770static int volume_write(char *buf)
7771{
7772 u8 s;
7773 u8 new_level, new_mute;
7774 int l;
7775 char *cmd;
7776 int rc;
7777
7778 /*
7779 * We do allow volume control at driver startup, so that the
7780 * user can set initial state through the volume=... parameter hack.
7781 */
7782 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7783 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7784 tp_warned.volume_ctrl_forbidden = 1;
7785 pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7786 pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7787 }
7788 return -EPERM;
7789 }
7790
7791 rc = volume_get_status(&s);
7792 if (rc < 0)
7793 return rc;
7794
7795 new_level = s & TP_EC_AUDIO_LVL_MSK;
7796 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7797
7798 while ((cmd = next_cmd(&buf))) {
7799 if (!tp_features.mixer_no_level_control) {
7800 if (strlencmp(cmd, "up") == 0) {
7801 if (new_mute)
7802 new_mute = 0;
7803 else if (new_level < TP_EC_VOLUME_MAX)
7804 new_level++;
7805 continue;
7806 } else if (strlencmp(cmd, "down") == 0) {
7807 if (new_mute)
7808 new_mute = 0;
7809 else if (new_level > 0)
7810 new_level--;
7811 continue;
7812 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7813 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7814 new_level = l;
7815 continue;
7816 }
7817 }
7818 if (strlencmp(cmd, "mute") == 0)
7819 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7820 else if (strlencmp(cmd, "unmute") == 0)
7821 new_mute = 0;
7822 else
7823 return -EINVAL;
7824 }
7825
7826 if (tp_features.mixer_no_level_control) {
7827 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7828 new_mute ? "" : "un");
7829 rc = volume_set_mute(!!new_mute);
7830 } else {
7831 tpacpi_disclose_usertask("procfs volume",
7832 "%smute and set level to %d\n",
7833 new_mute ? "" : "un", new_level);
7834 rc = volume_set_status(new_mute | new_level);
7835 }
7836 volume_alsa_notify_change();
7837
7838 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7839}
7840
7841static struct ibm_struct volume_driver_data = {
7842 .name = "volume",
7843 .read = volume_read,
7844 .write = volume_write,
7845 .exit = volume_exit,
7846 .suspend = volume_suspend,
7847 .resume = volume_resume,
7848 .shutdown = volume_shutdown,
7849};
7850
7851#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7852
7853#define alsa_card NULL
7854
7855static inline void volume_alsa_notify_change(void)
7856{
7857}
7858
7859static int __init volume_init(struct ibm_init_struct *iibm)
7860{
7861 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7862
7863 return 1;
7864}
7865
7866static struct ibm_struct volume_driver_data = {
7867 .name = "volume",
7868};
7869
7870#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7871
7872/*************************************************************************
7873 * Fan subdriver
7874 */
7875
7876/*
7877 * FAN ACCESS MODES
7878 *
7879 * TPACPI_FAN_RD_ACPI_GFAN:
7880 * ACPI GFAN method: returns fan level
7881 *
7882 * see TPACPI_FAN_WR_ACPI_SFAN
7883 * EC 0x2f (HFSP) not available if GFAN exists
7884 *
7885 * TPACPI_FAN_WR_ACPI_SFAN:
7886 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7887 *
7888 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7889 * it for writing.
7890 *
7891 * TPACPI_FAN_WR_TPEC:
7892 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7893 * Supported on almost all ThinkPads
7894 *
7895 * Fan speed changes of any sort (including those caused by the
7896 * disengaged mode) are usually done slowly by the firmware as the
7897 * maximum amount of fan duty cycle change per second seems to be
7898 * limited.
7899 *
7900 * Reading is not available if GFAN exists.
7901 * Writing is not available if SFAN exists.
7902 *
7903 * Bits
7904 * 7 automatic mode engaged;
7905 * (default operation mode of the ThinkPad)
7906 * fan level is ignored in this mode.
7907 * 6 full speed mode (takes precedence over bit 7);
7908 * not available on all thinkpads. May disable
7909 * the tachometer while the fan controller ramps up
7910 * the speed (which can take up to a few *minutes*).
7911 * Speeds up fan to 100% duty-cycle, which is far above
7912 * the standard RPM levels. It is not impossible that
7913 * it could cause hardware damage.
7914 * 5-3 unused in some models. Extra bits for fan level
7915 * in others, but still useless as all values above
7916 * 7 map to the same speed as level 7 in these models.
7917 * 2-0 fan level (0..7 usually)
7918 * 0x00 = stop
7919 * 0x07 = max (set when temperatures critical)
7920 * Some ThinkPads may have other levels, see
7921 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7922 *
7923 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7924 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7925 * does so, its initial value is meaningless (0x07).
7926 *
7927 * For firmware bugs, refer to:
7928 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7929 *
7930 * ----
7931 *
7932 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7933 * Main fan tachometer reading (in RPM)
7934 *
7935 * This register is present on all ThinkPads with a new-style EC, and
7936 * it is known not to be present on the A21m/e, and T22, as there is
7937 * something else in offset 0x84 according to the ACPI DSDT. Other
7938 * ThinkPads from this same time period (and earlier) probably lack the
7939 * tachometer as well.
7940 *
7941 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7942 * was never fixed by IBM to report the EC firmware version string
7943 * probably support the tachometer (like the early X models), so
7944 * detecting it is quite hard. We need more data to know for sure.
7945 *
7946 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7947 * might result.
7948 *
7949 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7950 * mode.
7951 *
7952 * For firmware bugs, refer to:
7953 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7954 *
7955 * ----
7956 *
7957 * ThinkPad EC register 0x31 bit 0 (only on select models)
7958 *
7959 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7960 * show the speed of the main fan. When bit 0 of EC register 0x31
7961 * is one, the tachometer registers show the speed of the auxiliary
7962 * fan.
7963 *
7964 * Fan control seems to affect both fans, regardless of the state
7965 * of this bit.
7966 *
7967 * So far, only the firmware for the X60/X61 non-tablet versions
7968 * seem to support this (firmware TP-7M).
7969 *
7970 * TPACPI_FAN_WR_ACPI_FANS:
7971 * ThinkPad X31, X40, X41. Not available in the X60.
7972 *
7973 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7974 * high speed. ACPI DSDT seems to map these three speeds to levels
7975 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7976 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7977 *
7978 * The speeds are stored on handles
7979 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7980 *
7981 * There are three default speed sets, accessible as handles:
7982 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7983 *
7984 * ACPI DSDT switches which set is in use depending on various
7985 * factors.
7986 *
7987 * TPACPI_FAN_WR_TPEC is also available and should be used to
7988 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7989 * but the ACPI tables just mention level 7.
7990 */
7991
7992enum { /* Fan control constants */
7993 fan_status_offset = 0x2f, /* EC register 0x2f */
7994 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7995 * 0x84 must be read before 0x85 */
7996 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7997 bit 0 selects which fan is active */
7998
7999 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
8000 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
8001
8002 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
8003};
8004
8005enum fan_status_access_mode {
8006 TPACPI_FAN_NONE = 0, /* No fan status or control */
8007 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
8008 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8009};
8010
8011enum fan_control_access_mode {
8012 TPACPI_FAN_WR_NONE = 0, /* No fan control */
8013 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
8014 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
8015 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
8016};
8017
8018enum fan_control_commands {
8019 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
8020 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
8021 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
8022 * and also watchdog cmd */
8023};
8024
8025static bool fan_control_allowed;
8026
8027static enum fan_status_access_mode fan_status_access_mode;
8028static enum fan_control_access_mode fan_control_access_mode;
8029static enum fan_control_commands fan_control_commands;
8030
8031static u8 fan_control_initial_status;
8032static u8 fan_control_desired_level;
8033static u8 fan_control_resume_level;
8034static int fan_watchdog_maxinterval;
8035
8036static struct mutex fan_mutex;
8037
8038static void fan_watchdog_fire(struct work_struct *ignored);
8039static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8040
8041TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
8042TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8043 "\\FSPD", /* 600e/x, 770e, 770x */
8044 ); /* all others */
8045TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8046 "JFNS", /* 770x-JL */
8047 ); /* all others */
8048
8049/*
8050 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8051 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8052 * be in auto mode (0x80).
8053 *
8054 * This is corrected by any write to HFSP either by the driver, or
8055 * by the firmware.
8056 *
8057 * We assume 0x07 really means auto mode while this quirk is active,
8058 * as this is far more likely than the ThinkPad being in level 7,
8059 * which is only used by the firmware during thermal emergencies.
8060 *
8061 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8062 * TP-70 (T43, R52), which are known to be buggy.
8063 */
8064
8065static void fan_quirk1_setup(void)
8066{
8067 if (fan_control_initial_status == 0x07) {
8068 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8069 tp_features.fan_ctrl_status_undef = 1;
8070 }
8071}
8072
8073static void fan_quirk1_handle(u8 *fan_status)
8074{
8075 if (unlikely(tp_features.fan_ctrl_status_undef)) {
8076 if (*fan_status != fan_control_initial_status) {
8077 /* something changed the HFSP regisnter since
8078 * driver init time, so it is not undefined
8079 * anymore */
8080 tp_features.fan_ctrl_status_undef = 0;
8081 } else {
8082 /* Return most likely status. In fact, it
8083 * might be the only possible status */
8084 *fan_status = TP_EC_FAN_AUTO;
8085 }
8086 }
8087}
8088
8089/* Select main fan on X60/X61, NOOP on others */
8090static bool fan_select_fan1(void)
8091{
8092 if (tp_features.second_fan) {
8093 u8 val;
8094
8095 if (ec_read(fan_select_offset, &val) < 0)
8096 return false;
8097 val &= 0xFEU;
8098 if (ec_write(fan_select_offset, val) < 0)
8099 return false;
8100 }
8101 return true;
8102}
8103
8104/* Select secondary fan on X60/X61 */
8105static bool fan_select_fan2(void)
8106{
8107 u8 val;
8108
8109 if (!tp_features.second_fan)
8110 return false;
8111
8112 if (ec_read(fan_select_offset, &val) < 0)
8113 return false;
8114 val |= 0x01U;
8115 if (ec_write(fan_select_offset, val) < 0)
8116 return false;
8117
8118 return true;
8119}
8120
8121/*
8122 * Call with fan_mutex held
8123 */
8124static void fan_update_desired_level(u8 status)
8125{
8126 if ((status &
8127 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8128 if (status > 7)
8129 fan_control_desired_level = 7;
8130 else
8131 fan_control_desired_level = status;
8132 }
8133}
8134
8135static int fan_get_status(u8 *status)
8136{
8137 u8 s;
8138
8139 /* TODO:
8140 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8141
8142 switch (fan_status_access_mode) {
8143 case TPACPI_FAN_RD_ACPI_GFAN: {
8144 /* 570, 600e/x, 770e, 770x */
8145 int res;
8146
8147 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8148 return -EIO;
8149
8150 if (likely(status))
8151 *status = res & 0x07;
8152
8153 break;
8154 }
8155 case TPACPI_FAN_RD_TPEC:
8156 /* all except 570, 600e/x, 770e, 770x */
8157 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8158 return -EIO;
8159
8160 if (likely(status)) {
8161 *status = s;
8162 fan_quirk1_handle(status);
8163 }
8164
8165 break;
8166
8167 default:
8168 return -ENXIO;
8169 }
8170
8171 return 0;
8172}
8173
8174static int fan_get_status_safe(u8 *status)
8175{
8176 int rc;
8177 u8 s;
8178
8179 if (mutex_lock_killable(&fan_mutex))
8180 return -ERESTARTSYS;
8181 rc = fan_get_status(&s);
8182 if (!rc)
8183 fan_update_desired_level(s);
8184 mutex_unlock(&fan_mutex);
8185
8186 if (rc)
8187 return rc;
8188 if (status)
8189 *status = s;
8190
8191 return 0;
8192}
8193
8194static int fan_get_speed(unsigned int *speed)
8195{
8196 u8 hi, lo;
8197
8198 switch (fan_status_access_mode) {
8199 case TPACPI_FAN_RD_TPEC:
8200 /* all except 570, 600e/x, 770e, 770x */
8201 if (unlikely(!fan_select_fan1()))
8202 return -EIO;
8203 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8204 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8205 return -EIO;
8206
8207 if (likely(speed))
8208 *speed = (hi << 8) | lo;
8209
8210 break;
8211
8212 default:
8213 return -ENXIO;
8214 }
8215
8216 return 0;
8217}
8218
8219static int fan2_get_speed(unsigned int *speed)
8220{
8221 u8 hi, lo;
8222 bool rc;
8223
8224 switch (fan_status_access_mode) {
8225 case TPACPI_FAN_RD_TPEC:
8226 /* all except 570, 600e/x, 770e, 770x */
8227 if (unlikely(!fan_select_fan2()))
8228 return -EIO;
8229 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8230 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8231 fan_select_fan1(); /* play it safe */
8232 if (rc)
8233 return -EIO;
8234
8235 if (likely(speed))
8236 *speed = (hi << 8) | lo;
8237
8238 break;
8239
8240 default:
8241 return -ENXIO;
8242 }
8243
8244 return 0;
8245}
8246
8247static int fan_set_level(int level)
8248{
8249 if (!fan_control_allowed)
8250 return -EPERM;
8251
8252 switch (fan_control_access_mode) {
8253 case TPACPI_FAN_WR_ACPI_SFAN:
8254 if (level >= 0 && level <= 7) {
8255 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8256 return -EIO;
8257 } else
8258 return -EINVAL;
8259 break;
8260
8261 case TPACPI_FAN_WR_ACPI_FANS:
8262 case TPACPI_FAN_WR_TPEC:
8263 if (!(level & TP_EC_FAN_AUTO) &&
8264 !(level & TP_EC_FAN_FULLSPEED) &&
8265 ((level < 0) || (level > 7)))
8266 return -EINVAL;
8267
8268 /* safety net should the EC not support AUTO
8269 * or FULLSPEED mode bits and just ignore them */
8270 if (level & TP_EC_FAN_FULLSPEED)
8271 level |= 7; /* safety min speed 7 */
8272 else if (level & TP_EC_FAN_AUTO)
8273 level |= 4; /* safety min speed 4 */
8274
8275 if (!acpi_ec_write(fan_status_offset, level))
8276 return -EIO;
8277 else
8278 tp_features.fan_ctrl_status_undef = 0;
8279 break;
8280
8281 default:
8282 return -ENXIO;
8283 }
8284
8285 vdbg_printk(TPACPI_DBG_FAN,
8286 "fan control: set fan control register to 0x%02x\n", level);
8287 return 0;
8288}
8289
8290static int fan_set_level_safe(int level)
8291{
8292 int rc;
8293
8294 if (!fan_control_allowed)
8295 return -EPERM;
8296
8297 if (mutex_lock_killable(&fan_mutex))
8298 return -ERESTARTSYS;
8299
8300 if (level == TPACPI_FAN_LAST_LEVEL)
8301 level = fan_control_desired_level;
8302
8303 rc = fan_set_level(level);
8304 if (!rc)
8305 fan_update_desired_level(level);
8306
8307 mutex_unlock(&fan_mutex);
8308 return rc;
8309}
8310
8311static int fan_set_enable(void)
8312{
8313 u8 s;
8314 int rc;
8315
8316 if (!fan_control_allowed)
8317 return -EPERM;
8318
8319 if (mutex_lock_killable(&fan_mutex))
8320 return -ERESTARTSYS;
8321
8322 switch (fan_control_access_mode) {
8323 case TPACPI_FAN_WR_ACPI_FANS:
8324 case TPACPI_FAN_WR_TPEC:
8325 rc = fan_get_status(&s);
8326 if (rc < 0)
8327 break;
8328
8329 /* Don't go out of emergency fan mode */
8330 if (s != 7) {
8331 s &= 0x07;
8332 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8333 }
8334
8335 if (!acpi_ec_write(fan_status_offset, s))
8336 rc = -EIO;
8337 else {
8338 tp_features.fan_ctrl_status_undef = 0;
8339 rc = 0;
8340 }
8341 break;
8342
8343 case TPACPI_FAN_WR_ACPI_SFAN:
8344 rc = fan_get_status(&s);
8345 if (rc < 0)
8346 break;
8347
8348 s &= 0x07;
8349
8350 /* Set fan to at least level 4 */
8351 s |= 4;
8352
8353 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8354 rc = -EIO;
8355 else
8356 rc = 0;
8357 break;
8358
8359 default:
8360 rc = -ENXIO;
8361 }
8362
8363 mutex_unlock(&fan_mutex);
8364
8365 if (!rc)
8366 vdbg_printk(TPACPI_DBG_FAN,
8367 "fan control: set fan control register to 0x%02x\n",
8368 s);
8369 return rc;
8370}
8371
8372static int fan_set_disable(void)
8373{
8374 int rc;
8375
8376 if (!fan_control_allowed)
8377 return -EPERM;
8378
8379 if (mutex_lock_killable(&fan_mutex))
8380 return -ERESTARTSYS;
8381
8382 rc = 0;
8383 switch (fan_control_access_mode) {
8384 case TPACPI_FAN_WR_ACPI_FANS:
8385 case TPACPI_FAN_WR_TPEC:
8386 if (!acpi_ec_write(fan_status_offset, 0x00))
8387 rc = -EIO;
8388 else {
8389 fan_control_desired_level = 0;
8390 tp_features.fan_ctrl_status_undef = 0;
8391 }
8392 break;
8393
8394 case TPACPI_FAN_WR_ACPI_SFAN:
8395 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8396 rc = -EIO;
8397 else
8398 fan_control_desired_level = 0;
8399 break;
8400
8401 default:
8402 rc = -ENXIO;
8403 }
8404
8405 if (!rc)
8406 vdbg_printk(TPACPI_DBG_FAN,
8407 "fan control: set fan control register to 0\n");
8408
8409 mutex_unlock(&fan_mutex);
8410 return rc;
8411}
8412
8413static int fan_set_speed(int speed)
8414{
8415 int rc;
8416
8417 if (!fan_control_allowed)
8418 return -EPERM;
8419
8420 if (mutex_lock_killable(&fan_mutex))
8421 return -ERESTARTSYS;
8422
8423 rc = 0;
8424 switch (fan_control_access_mode) {
8425 case TPACPI_FAN_WR_ACPI_FANS:
8426 if (speed >= 0 && speed <= 65535) {
8427 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8428 speed, speed, speed))
8429 rc = -EIO;
8430 } else
8431 rc = -EINVAL;
8432 break;
8433
8434 default:
8435 rc = -ENXIO;
8436 }
8437
8438 mutex_unlock(&fan_mutex);
8439 return rc;
8440}
8441
8442static void fan_watchdog_reset(void)
8443{
8444 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8445 return;
8446
8447 if (fan_watchdog_maxinterval > 0 &&
8448 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8449 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8450 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8451 else
8452 cancel_delayed_work(&fan_watchdog_task);
8453}
8454
8455static void fan_watchdog_fire(struct work_struct *ignored)
8456{
8457 int rc;
8458
8459 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8460 return;
8461
8462 pr_notice("fan watchdog: enabling fan\n");
8463 rc = fan_set_enable();
8464 if (rc < 0) {
8465 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8466 rc);
8467 /* reschedule for later */
8468 fan_watchdog_reset();
8469 }
8470}
8471
8472/*
8473 * SYSFS fan layout: hwmon compatible (device)
8474 *
8475 * pwm*_enable:
8476 * 0: "disengaged" mode
8477 * 1: manual mode
8478 * 2: native EC "auto" mode (recommended, hardware default)
8479 *
8480 * pwm*: set speed in manual mode, ignored otherwise.
8481 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8482 * interpolation.
8483 *
8484 * fan*_input: tachometer reading, RPM
8485 *
8486 *
8487 * SYSFS fan layout: extensions
8488 *
8489 * fan_watchdog (driver):
8490 * fan watchdog interval in seconds, 0 disables (default), max 120
8491 */
8492
8493/* sysfs fan pwm1_enable ----------------------------------------------- */
8494static ssize_t fan_pwm1_enable_show(struct device *dev,
8495 struct device_attribute *attr,
8496 char *buf)
8497{
8498 int res, mode;
8499 u8 status;
8500
8501 res = fan_get_status_safe(&status);
8502 if (res)
8503 return res;
8504
8505 if (status & TP_EC_FAN_FULLSPEED) {
8506 mode = 0;
8507 } else if (status & TP_EC_FAN_AUTO) {
8508 mode = 2;
8509 } else
8510 mode = 1;
8511
8512 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
8513}
8514
8515static ssize_t fan_pwm1_enable_store(struct device *dev,
8516 struct device_attribute *attr,
8517 const char *buf, size_t count)
8518{
8519 unsigned long t;
8520 int res, level;
8521
8522 if (parse_strtoul(buf, 2, &t))
8523 return -EINVAL;
8524
8525 tpacpi_disclose_usertask("hwmon pwm1_enable",
8526 "set fan mode to %lu\n", t);
8527
8528 switch (t) {
8529 case 0:
8530 level = TP_EC_FAN_FULLSPEED;
8531 break;
8532 case 1:
8533 level = TPACPI_FAN_LAST_LEVEL;
8534 break;
8535 case 2:
8536 level = TP_EC_FAN_AUTO;
8537 break;
8538 case 3:
8539 /* reserved for software-controlled auto mode */
8540 return -ENOSYS;
8541 default:
8542 return -EINVAL;
8543 }
8544
8545 res = fan_set_level_safe(level);
8546 if (res == -ENXIO)
8547 return -EINVAL;
8548 else if (res < 0)
8549 return res;
8550
8551 fan_watchdog_reset();
8552
8553 return count;
8554}
8555
8556static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8557 fan_pwm1_enable_show, fan_pwm1_enable_store);
8558
8559/* sysfs fan pwm1 ------------------------------------------------------ */
8560static ssize_t fan_pwm1_show(struct device *dev,
8561 struct device_attribute *attr,
8562 char *buf)
8563{
8564 int res;
8565 u8 status;
8566
8567 res = fan_get_status_safe(&status);
8568 if (res)
8569 return res;
8570
8571 if ((status &
8572 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8573 status = fan_control_desired_level;
8574
8575 if (status > 7)
8576 status = 7;
8577
8578 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
8579}
8580
8581static ssize_t fan_pwm1_store(struct device *dev,
8582 struct device_attribute *attr,
8583 const char *buf, size_t count)
8584{
8585 unsigned long s;
8586 int rc;
8587 u8 status, newlevel;
8588
8589 if (parse_strtoul(buf, 255, &s))
8590 return -EINVAL;
8591
8592 tpacpi_disclose_usertask("hwmon pwm1",
8593 "set fan speed to %lu\n", s);
8594
8595 /* scale down from 0-255 to 0-7 */
8596 newlevel = (s >> 5) & 0x07;
8597
8598 if (mutex_lock_killable(&fan_mutex))
8599 return -ERESTARTSYS;
8600
8601 rc = fan_get_status(&status);
8602 if (!rc && (status &
8603 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8604 rc = fan_set_level(newlevel);
8605 if (rc == -ENXIO)
8606 rc = -EINVAL;
8607 else if (!rc) {
8608 fan_update_desired_level(newlevel);
8609 fan_watchdog_reset();
8610 }
8611 }
8612
8613 mutex_unlock(&fan_mutex);
8614 return (rc) ? rc : count;
8615}
8616
8617static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8618
8619/* sysfs fan fan1_input ------------------------------------------------ */
8620static ssize_t fan_fan1_input_show(struct device *dev,
8621 struct device_attribute *attr,
8622 char *buf)
8623{
8624 int res;
8625 unsigned int speed;
8626
8627 res = fan_get_speed(&speed);
8628 if (res < 0)
8629 return res;
8630
8631 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8632}
8633
8634static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8635
8636/* sysfs fan fan2_input ------------------------------------------------ */
8637static ssize_t fan_fan2_input_show(struct device *dev,
8638 struct device_attribute *attr,
8639 char *buf)
8640{
8641 int res;
8642 unsigned int speed;
8643
8644 res = fan2_get_speed(&speed);
8645 if (res < 0)
8646 return res;
8647
8648 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8649}
8650
8651static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8652
8653/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8654static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8655{
8656 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8657}
8658
8659static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8660 size_t count)
8661{
8662 unsigned long t;
8663
8664 if (parse_strtoul(buf, 120, &t))
8665 return -EINVAL;
8666
8667 if (!fan_control_allowed)
8668 return -EPERM;
8669
8670 fan_watchdog_maxinterval = t;
8671 fan_watchdog_reset();
8672
8673 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8674
8675 return count;
8676}
8677static DRIVER_ATTR_RW(fan_watchdog);
8678
8679/* --------------------------------------------------------------------- */
8680static struct attribute *fan_attributes[] = {
8681 &dev_attr_pwm1_enable.attr, &dev_attr_pwm1.attr,
8682 &dev_attr_fan1_input.attr,
8683 NULL, /* for fan2_input */
8684 NULL
8685};
8686
8687static const struct attribute_group fan_attr_group = {
8688 .attrs = fan_attributes,
8689};
8690
8691#define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
8692#define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8693
8694#define TPACPI_FAN_QI(__id1, __id2, __quirks) \
8695 { .vendor = PCI_VENDOR_ID_IBM, \
8696 .bios = TPACPI_MATCH_ANY, \
8697 .ec = TPID(__id1, __id2), \
8698 .quirks = __quirks }
8699
8700#define TPACPI_FAN_QL(__id1, __id2, __quirks) \
8701 { .vendor = PCI_VENDOR_ID_LENOVO, \
8702 .bios = TPACPI_MATCH_ANY, \
8703 .ec = TPID(__id1, __id2), \
8704 .quirks = __quirks }
8705
8706#define TPACPI_FAN_QB(__id1, __id2, __quirks) \
8707 { .vendor = PCI_VENDOR_ID_LENOVO, \
8708 .bios = TPID(__id1, __id2), \
8709 .ec = TPACPI_MATCH_ANY, \
8710 .quirks = __quirks }
8711
8712static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8713 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8714 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8715 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8716 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8717 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8718 TPACPI_FAN_QB('N', '1', TPACPI_FAN_2FAN),
8719};
8720
8721#undef TPACPI_FAN_QL
8722#undef TPACPI_FAN_QI
8723#undef TPACPI_FAN_QB
8724
8725static int __init fan_init(struct ibm_init_struct *iibm)
8726{
8727 int rc;
8728 unsigned long quirks;
8729
8730 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8731 "initializing fan subdriver\n");
8732
8733 mutex_init(&fan_mutex);
8734 fan_status_access_mode = TPACPI_FAN_NONE;
8735 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8736 fan_control_commands = 0;
8737 fan_watchdog_maxinterval = 0;
8738 tp_features.fan_ctrl_status_undef = 0;
8739 tp_features.second_fan = 0;
8740 fan_control_desired_level = 7;
8741
8742 if (tpacpi_is_ibm()) {
8743 TPACPI_ACPIHANDLE_INIT(fans);
8744 TPACPI_ACPIHANDLE_INIT(gfan);
8745 TPACPI_ACPIHANDLE_INIT(sfan);
8746 }
8747
8748 quirks = tpacpi_check_quirks(fan_quirk_table,
8749 ARRAY_SIZE(fan_quirk_table));
8750
8751 if (gfan_handle) {
8752 /* 570, 600e/x, 770e, 770x */
8753 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8754 } else {
8755 /* all other ThinkPads: note that even old-style
8756 * ThinkPad ECs supports the fan control register */
8757 if (likely(acpi_ec_read(fan_status_offset,
8758 &fan_control_initial_status))) {
8759 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8760 if (quirks & TPACPI_FAN_Q1)
8761 fan_quirk1_setup();
8762 if (quirks & TPACPI_FAN_2FAN) {
8763 tp_features.second_fan = 1;
8764 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8765 "secondary fan support enabled\n");
8766 }
8767 } else {
8768 pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8769 return 1;
8770 }
8771 }
8772
8773 if (sfan_handle) {
8774 /* 570, 770x-JL */
8775 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8776 fan_control_commands |=
8777 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8778 } else {
8779 if (!gfan_handle) {
8780 /* gfan without sfan means no fan control */
8781 /* all other models implement TP EC 0x2f control */
8782
8783 if (fans_handle) {
8784 /* X31, X40, X41 */
8785 fan_control_access_mode =
8786 TPACPI_FAN_WR_ACPI_FANS;
8787 fan_control_commands |=
8788 TPACPI_FAN_CMD_SPEED |
8789 TPACPI_FAN_CMD_LEVEL |
8790 TPACPI_FAN_CMD_ENABLE;
8791 } else {
8792 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8793 fan_control_commands |=
8794 TPACPI_FAN_CMD_LEVEL |
8795 TPACPI_FAN_CMD_ENABLE;
8796 }
8797 }
8798 }
8799
8800 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8801 "fan is %s, modes %d, %d\n",
8802 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8803 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8804 fan_status_access_mode, fan_control_access_mode);
8805
8806 /* fan control master switch */
8807 if (!fan_control_allowed) {
8808 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8809 fan_control_commands = 0;
8810 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8811 "fan control features disabled by parameter\n");
8812 }
8813
8814 /* update fan_control_desired_level */
8815 if (fan_status_access_mode != TPACPI_FAN_NONE)
8816 fan_get_status_safe(NULL);
8817
8818 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8819 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8820 if (tp_features.second_fan) {
8821 /* attach second fan tachometer */
8822 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8823 &dev_attr_fan2_input.attr;
8824 }
8825 rc = sysfs_create_group(&tpacpi_hwmon->kobj,
8826 &fan_attr_group);
8827 if (rc < 0)
8828 return rc;
8829
8830 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8831 &driver_attr_fan_watchdog);
8832 if (rc < 0) {
8833 sysfs_remove_group(&tpacpi_hwmon->kobj,
8834 &fan_attr_group);
8835 return rc;
8836 }
8837 return 0;
8838 } else
8839 return 1;
8840}
8841
8842static void fan_exit(void)
8843{
8844 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8845 "cancelling any pending fan watchdog tasks\n");
8846
8847 /* FIXME: can we really do this unconditionally? */
8848 sysfs_remove_group(&tpacpi_hwmon->kobj, &fan_attr_group);
8849 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8850 &driver_attr_fan_watchdog);
8851
8852 cancel_delayed_work(&fan_watchdog_task);
8853 flush_workqueue(tpacpi_wq);
8854}
8855
8856static void fan_suspend(void)
8857{
8858 int rc;
8859
8860 if (!fan_control_allowed)
8861 return;
8862
8863 /* Store fan status in cache */
8864 fan_control_resume_level = 0;
8865 rc = fan_get_status_safe(&fan_control_resume_level);
8866 if (rc < 0)
8867 pr_notice("failed to read fan level for later restore during resume: %d\n",
8868 rc);
8869
8870 /* if it is undefined, don't attempt to restore it.
8871 * KEEP THIS LAST */
8872 if (tp_features.fan_ctrl_status_undef)
8873 fan_control_resume_level = 0;
8874}
8875
8876static void fan_resume(void)
8877{
8878 u8 current_level = 7;
8879 bool do_set = false;
8880 int rc;
8881
8882 /* DSDT *always* updates status on resume */
8883 tp_features.fan_ctrl_status_undef = 0;
8884
8885 if (!fan_control_allowed ||
8886 !fan_control_resume_level ||
8887 (fan_get_status_safe(¤t_level) < 0))
8888 return;
8889
8890 switch (fan_control_access_mode) {
8891 case TPACPI_FAN_WR_ACPI_SFAN:
8892 /* never decrease fan level */
8893 do_set = (fan_control_resume_level > current_level);
8894 break;
8895 case TPACPI_FAN_WR_ACPI_FANS:
8896 case TPACPI_FAN_WR_TPEC:
8897 /* never decrease fan level, scale is:
8898 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8899 *
8900 * We expect the firmware to set either 7 or AUTO, but we
8901 * handle FULLSPEED out of paranoia.
8902 *
8903 * So, we can safely only restore FULLSPEED or 7, anything
8904 * else could slow the fan. Restoring AUTO is useless, at
8905 * best that's exactly what the DSDT already set (it is the
8906 * slower it uses).
8907 *
8908 * Always keep in mind that the DSDT *will* have set the
8909 * fans to what the vendor supposes is the best level. We
8910 * muck with it only to speed the fan up.
8911 */
8912 if (fan_control_resume_level != 7 &&
8913 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8914 return;
8915 else
8916 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8917 (current_level != fan_control_resume_level);
8918 break;
8919 default:
8920 return;
8921 }
8922 if (do_set) {
8923 pr_notice("restoring fan level to 0x%02x\n",
8924 fan_control_resume_level);
8925 rc = fan_set_level_safe(fan_control_resume_level);
8926 if (rc < 0)
8927 pr_notice("failed to restore fan level: %d\n", rc);
8928 }
8929}
8930
8931static int fan_read(struct seq_file *m)
8932{
8933 int rc;
8934 u8 status;
8935 unsigned int speed = 0;
8936
8937 switch (fan_status_access_mode) {
8938 case TPACPI_FAN_RD_ACPI_GFAN:
8939 /* 570, 600e/x, 770e, 770x */
8940 rc = fan_get_status_safe(&status);
8941 if (rc < 0)
8942 return rc;
8943
8944 seq_printf(m, "status:\t\t%s\n"
8945 "level:\t\t%d\n",
8946 (status != 0) ? "enabled" : "disabled", status);
8947 break;
8948
8949 case TPACPI_FAN_RD_TPEC:
8950 /* all except 570, 600e/x, 770e, 770x */
8951 rc = fan_get_status_safe(&status);
8952 if (rc < 0)
8953 return rc;
8954
8955 seq_printf(m, "status:\t\t%s\n",
8956 (status != 0) ? "enabled" : "disabled");
8957
8958 rc = fan_get_speed(&speed);
8959 if (rc < 0)
8960 return rc;
8961
8962 seq_printf(m, "speed:\t\t%d\n", speed);
8963
8964 if (status & TP_EC_FAN_FULLSPEED)
8965 /* Disengaged mode takes precedence */
8966 seq_printf(m, "level:\t\tdisengaged\n");
8967 else if (status & TP_EC_FAN_AUTO)
8968 seq_printf(m, "level:\t\tauto\n");
8969 else
8970 seq_printf(m, "level:\t\t%d\n", status);
8971 break;
8972
8973 case TPACPI_FAN_NONE:
8974 default:
8975 seq_printf(m, "status:\t\tnot supported\n");
8976 }
8977
8978 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8979 seq_printf(m, "commands:\tlevel <level>");
8980
8981 switch (fan_control_access_mode) {
8982 case TPACPI_FAN_WR_ACPI_SFAN:
8983 seq_printf(m, " (<level> is 0-7)\n");
8984 break;
8985
8986 default:
8987 seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
8988 break;
8989 }
8990 }
8991
8992 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8993 seq_printf(m, "commands:\tenable, disable\n"
8994 "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
8995
8996 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8997 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
8998
8999 return 0;
9000}
9001
9002static int fan_write_cmd_level(const char *cmd, int *rc)
9003{
9004 int level;
9005
9006 if (strlencmp(cmd, "level auto") == 0)
9007 level = TP_EC_FAN_AUTO;
9008 else if ((strlencmp(cmd, "level disengaged") == 0) |
9009 (strlencmp(cmd, "level full-speed") == 0))
9010 level = TP_EC_FAN_FULLSPEED;
9011 else if (sscanf(cmd, "level %d", &level) != 1)
9012 return 0;
9013
9014 *rc = fan_set_level_safe(level);
9015 if (*rc == -ENXIO)
9016 pr_err("level command accepted for unsupported access mode %d\n",
9017 fan_control_access_mode);
9018 else if (!*rc)
9019 tpacpi_disclose_usertask("procfs fan",
9020 "set level to %d\n", level);
9021
9022 return 1;
9023}
9024
9025static int fan_write_cmd_enable(const char *cmd, int *rc)
9026{
9027 if (strlencmp(cmd, "enable") != 0)
9028 return 0;
9029
9030 *rc = fan_set_enable();
9031 if (*rc == -ENXIO)
9032 pr_err("enable command accepted for unsupported access mode %d\n",
9033 fan_control_access_mode);
9034 else if (!*rc)
9035 tpacpi_disclose_usertask("procfs fan", "enable\n");
9036
9037 return 1;
9038}
9039
9040static int fan_write_cmd_disable(const char *cmd, int *rc)
9041{
9042 if (strlencmp(cmd, "disable") != 0)
9043 return 0;
9044
9045 *rc = fan_set_disable();
9046 if (*rc == -ENXIO)
9047 pr_err("disable command accepted for unsupported access mode %d\n",
9048 fan_control_access_mode);
9049 else if (!*rc)
9050 tpacpi_disclose_usertask("procfs fan", "disable\n");
9051
9052 return 1;
9053}
9054
9055static int fan_write_cmd_speed(const char *cmd, int *rc)
9056{
9057 int speed;
9058
9059 /* TODO:
9060 * Support speed <low> <medium> <high> ? */
9061
9062 if (sscanf(cmd, "speed %d", &speed) != 1)
9063 return 0;
9064
9065 *rc = fan_set_speed(speed);
9066 if (*rc == -ENXIO)
9067 pr_err("speed command accepted for unsupported access mode %d\n",
9068 fan_control_access_mode);
9069 else if (!*rc)
9070 tpacpi_disclose_usertask("procfs fan",
9071 "set speed to %d\n", speed);
9072
9073 return 1;
9074}
9075
9076static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9077{
9078 int interval;
9079
9080 if (sscanf(cmd, "watchdog %d", &interval) != 1)
9081 return 0;
9082
9083 if (interval < 0 || interval > 120)
9084 *rc = -EINVAL;
9085 else {
9086 fan_watchdog_maxinterval = interval;
9087 tpacpi_disclose_usertask("procfs fan",
9088 "set watchdog timer to %d\n",
9089 interval);
9090 }
9091
9092 return 1;
9093}
9094
9095static int fan_write(char *buf)
9096{
9097 char *cmd;
9098 int rc = 0;
9099
9100 while (!rc && (cmd = next_cmd(&buf))) {
9101 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9102 fan_write_cmd_level(cmd, &rc)) &&
9103 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9104 (fan_write_cmd_enable(cmd, &rc) ||
9105 fan_write_cmd_disable(cmd, &rc) ||
9106 fan_write_cmd_watchdog(cmd, &rc))) &&
9107 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9108 fan_write_cmd_speed(cmd, &rc))
9109 )
9110 rc = -EINVAL;
9111 else if (!rc)
9112 fan_watchdog_reset();
9113 }
9114
9115 return rc;
9116}
9117
9118static struct ibm_struct fan_driver_data = {
9119 .name = "fan",
9120 .read = fan_read,
9121 .write = fan_write,
9122 .exit = fan_exit,
9123 .suspend = fan_suspend,
9124 .resume = fan_resume,
9125};
9126
9127/*************************************************************************
9128 * Mute LED subdriver
9129 */
9130
9131
9132struct tp_led_table {
9133 acpi_string name;
9134 int on_value;
9135 int off_value;
9136 int state;
9137};
9138
9139static struct tp_led_table led_tables[] = {
9140 [TPACPI_LED_MUTE] = {
9141 .name = "SSMS",
9142 .on_value = 1,
9143 .off_value = 0,
9144 },
9145 [TPACPI_LED_MICMUTE] = {
9146 .name = "MMTS",
9147 .on_value = 2,
9148 .off_value = 0,
9149 },
9150};
9151
9152static int mute_led_on_off(struct tp_led_table *t, bool state)
9153{
9154 acpi_handle temp;
9155 int output;
9156
9157 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9158 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9159 return -EIO;
9160 }
9161
9162 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9163 state ? t->on_value : t->off_value))
9164 return -EIO;
9165
9166 t->state = state;
9167 return state;
9168}
9169
9170int tpacpi_led_set(int whichled, bool on)
9171{
9172 struct tp_led_table *t;
9173
9174 if (whichled < 0 || whichled >= TPACPI_LED_MAX)
9175 return -EINVAL;
9176
9177 t = &led_tables[whichled];
9178 if (t->state < 0 || t->state == on)
9179 return t->state;
9180 return mute_led_on_off(t, on);
9181}
9182EXPORT_SYMBOL_GPL(tpacpi_led_set);
9183
9184static int mute_led_init(struct ibm_init_struct *iibm)
9185{
9186 acpi_handle temp;
9187 int i;
9188
9189 for (i = 0; i < TPACPI_LED_MAX; i++) {
9190 struct tp_led_table *t = &led_tables[i];
9191 if (ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp)))
9192 mute_led_on_off(t, false);
9193 else
9194 t->state = -ENODEV;
9195 }
9196 return 0;
9197}
9198
9199static void mute_led_exit(void)
9200{
9201 int i;
9202
9203 for (i = 0; i < TPACPI_LED_MAX; i++)
9204 tpacpi_led_set(i, false);
9205}
9206
9207static void mute_led_resume(void)
9208{
9209 int i;
9210
9211 for (i = 0; i < TPACPI_LED_MAX; i++) {
9212 struct tp_led_table *t = &led_tables[i];
9213 if (t->state >= 0)
9214 mute_led_on_off(t, t->state);
9215 }
9216}
9217
9218static struct ibm_struct mute_led_driver_data = {
9219 .name = "mute_led",
9220 .exit = mute_led_exit,
9221 .resume = mute_led_resume,
9222};
9223
9224/*
9225 * Battery Wear Control Driver
9226 * Contact: Ognjen Galic <smclt30p@gmail.com>
9227 */
9228
9229/* Metadata */
9230
9231#define GET_START "BCTG"
9232#define SET_START "BCCS"
9233#define GET_STOP "BCSG"
9234#define SET_STOP "BCSS"
9235
9236#define START_ATTR "charge_start_threshold"
9237#define STOP_ATTR "charge_stop_threshold"
9238
9239enum {
9240 BAT_ANY = 0,
9241 BAT_PRIMARY = 1,
9242 BAT_SECONDARY = 2
9243};
9244
9245enum {
9246 /* Error condition bit */
9247 METHOD_ERR = BIT(31),
9248};
9249
9250enum {
9251 /* This is used in the get/set helpers */
9252 THRESHOLD_START,
9253 THRESHOLD_STOP,
9254};
9255
9256struct tpacpi_battery_data {
9257 int charge_start;
9258 int start_support;
9259 int charge_stop;
9260 int stop_support;
9261};
9262
9263struct tpacpi_battery_driver_data {
9264 struct tpacpi_battery_data batteries[3];
9265 int individual_addressing;
9266};
9267
9268static struct tpacpi_battery_driver_data battery_info;
9269
9270/* ACPI helpers/functions/probes */
9271
9272/**
9273 * This evaluates a ACPI method call specific to the battery
9274 * ACPI extension. The specifics are that an error is marked
9275 * in the 32rd bit of the response, so we just check that here.
9276 */
9277static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9278{
9279 int response;
9280
9281 if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9282 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9283 return AE_ERROR;
9284 }
9285 if (response & METHOD_ERR) {
9286 acpi_handle_err(hkey_handle,
9287 "%s evaluated but flagged as error", method);
9288 return AE_ERROR;
9289 }
9290 *ret = response;
9291 return AE_OK;
9292}
9293
9294static int tpacpi_battery_get(int what, int battery, int *ret)
9295{
9296 switch (what) {
9297 case THRESHOLD_START:
9298 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9299 return -ENODEV;
9300
9301 /* The value is in the low 8 bits of the response */
9302 *ret = *ret & 0xFF;
9303 return 0;
9304 case THRESHOLD_STOP:
9305 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9306 return -ENODEV;
9307 /* Value is in lower 8 bits */
9308 *ret = *ret & 0xFF;
9309 /*
9310 * On the stop value, if we return 0 that
9311 * does not make any sense. 0 means Default, which
9312 * means that charging stops at 100%, so we return
9313 * that.
9314 */
9315 if (*ret == 0)
9316 *ret = 100;
9317 return 0;
9318 default:
9319 pr_crit("wrong parameter: %d", what);
9320 return -EINVAL;
9321 }
9322}
9323
9324static int tpacpi_battery_set(int what, int battery, int value)
9325{
9326 int param, ret;
9327 /* The first 8 bits are the value of the threshold */
9328 param = value;
9329 /* The battery ID is in bits 8-9, 2 bits */
9330 param |= battery << 8;
9331
9332 switch (what) {
9333 case THRESHOLD_START:
9334 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9335 pr_err("failed to set charge threshold on battery %d",
9336 battery);
9337 return -ENODEV;
9338 }
9339 return 0;
9340 case THRESHOLD_STOP:
9341 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9342 pr_err("failed to set stop threshold: %d", battery);
9343 return -ENODEV;
9344 }
9345 return 0;
9346 default:
9347 pr_crit("wrong parameter: %d", what);
9348 return -EINVAL;
9349 }
9350}
9351
9352static int tpacpi_battery_probe(int battery)
9353{
9354 int ret = 0;
9355
9356 memset(&battery_info, 0, sizeof(struct tpacpi_battery_driver_data));
9357 /*
9358 * 1) Get the current start threshold
9359 * 2) Check for support
9360 * 3) Get the current stop threshold
9361 * 4) Check for support
9362 */
9363 if (acpi_has_method(hkey_handle, GET_START)) {
9364 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9365 pr_err("Error probing battery %d\n", battery);
9366 return -ENODEV;
9367 }
9368 /* Individual addressing is in bit 9 */
9369 if (ret & BIT(9))
9370 battery_info.individual_addressing = true;
9371 /* Support is marked in bit 8 */
9372 if (ret & BIT(8))
9373 battery_info.batteries[battery].start_support = 1;
9374 else
9375 return -ENODEV;
9376 if (tpacpi_battery_get(THRESHOLD_START, battery,
9377 &battery_info.batteries[battery].charge_start)) {
9378 pr_err("Error probing battery %d\n", battery);
9379 return -ENODEV;
9380 }
9381 }
9382 if (acpi_has_method(hkey_handle, GET_STOP)) {
9383 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9384 pr_err("Error probing battery stop; %d\n", battery);
9385 return -ENODEV;
9386 }
9387 /* Support is marked in bit 8 */
9388 if (ret & BIT(8))
9389 battery_info.batteries[battery].stop_support = 1;
9390 else
9391 return -ENODEV;
9392 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9393 &battery_info.batteries[battery].charge_stop)) {
9394 pr_err("Error probing battery stop: %d\n", battery);
9395 return -ENODEV;
9396 }
9397 }
9398 pr_info("battery %d registered (start %d, stop %d)",
9399 battery,
9400 battery_info.batteries[battery].charge_start,
9401 battery_info.batteries[battery].charge_stop);
9402
9403 return 0;
9404}
9405
9406/* General helper functions */
9407
9408static int tpacpi_battery_get_id(const char *battery_name)
9409{
9410
9411 if (strcmp(battery_name, "BAT0") == 0)
9412 return BAT_PRIMARY;
9413 if (strcmp(battery_name, "BAT1") == 0)
9414 return BAT_SECONDARY;
9415 /*
9416 * If for some reason the battery is not BAT0 nor is it
9417 * BAT1, we will assume it's the default, first battery,
9418 * AKA primary.
9419 */
9420 pr_warn("unknown battery %s, assuming primary", battery_name);
9421 return BAT_PRIMARY;
9422}
9423
9424/* sysfs interface */
9425
9426static ssize_t tpacpi_battery_store(int what,
9427 struct device *dev,
9428 const char *buf, size_t count)
9429{
9430 struct power_supply *supply = to_power_supply(dev);
9431 unsigned long value;
9432 int battery, rval;
9433 /*
9434 * Some systems have support for more than
9435 * one battery. If that is the case,
9436 * tpacpi_battery_probe marked that addressing
9437 * them individually is supported, so we do that
9438 * based on the device struct.
9439 *
9440 * On systems that are not supported, we assume
9441 * the primary as most of the ACPI calls fail
9442 * with "Any Battery" as the parameter.
9443 */
9444 if (battery_info.individual_addressing)
9445 /* BAT_PRIMARY or BAT_SECONDARY */
9446 battery = tpacpi_battery_get_id(supply->desc->name);
9447 else
9448 battery = BAT_PRIMARY;
9449
9450 rval = kstrtoul(buf, 10, &value);
9451 if (rval)
9452 return rval;
9453
9454 switch (what) {
9455 case THRESHOLD_START:
9456 if (!battery_info.batteries[battery].start_support)
9457 return -ENODEV;
9458 /* valid values are [0, 99] */
9459 if (value < 0 || value > 99)
9460 return -EINVAL;
9461 if (value > battery_info.batteries[battery].charge_stop)
9462 return -EINVAL;
9463 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9464 return -ENODEV;
9465 battery_info.batteries[battery].charge_start = value;
9466 return count;
9467
9468 case THRESHOLD_STOP:
9469 if (!battery_info.batteries[battery].stop_support)
9470 return -ENODEV;
9471 /* valid values are [1, 100] */
9472 if (value < 1 || value > 100)
9473 return -EINVAL;
9474 if (value < battery_info.batteries[battery].charge_start)
9475 return -EINVAL;
9476 battery_info.batteries[battery].charge_stop = value;
9477 /*
9478 * When 100 is passed to stop, we need to flip
9479 * it to 0 as that the EC understands that as
9480 * "Default", which will charge to 100%
9481 */
9482 if (value == 100)
9483 value = 0;
9484 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9485 return -EINVAL;
9486 return count;
9487 default:
9488 pr_crit("Wrong parameter: %d", what);
9489 return -EINVAL;
9490 }
9491 return count;
9492}
9493
9494static ssize_t tpacpi_battery_show(int what,
9495 struct device *dev,
9496 char *buf)
9497{
9498 struct power_supply *supply = to_power_supply(dev);
9499 int ret, battery;
9500 /*
9501 * Some systems have support for more than
9502 * one battery. If that is the case,
9503 * tpacpi_battery_probe marked that addressing
9504 * them individually is supported, so we;
9505 * based on the device struct.
9506 *
9507 * On systems that are not supported, we assume
9508 * the primary as most of the ACPI calls fail
9509 * with "Any Battery" as the parameter.
9510 */
9511 if (battery_info.individual_addressing)
9512 /* BAT_PRIMARY or BAT_SECONDARY */
9513 battery = tpacpi_battery_get_id(supply->desc->name);
9514 else
9515 battery = BAT_PRIMARY;
9516 if (tpacpi_battery_get(what, battery, &ret))
9517 return -ENODEV;
9518 return sprintf(buf, "%d\n", ret);
9519}
9520
9521static ssize_t charge_start_threshold_show(struct device *device,
9522 struct device_attribute *attr,
9523 char *buf)
9524{
9525 return tpacpi_battery_show(THRESHOLD_START, device, buf);
9526}
9527
9528static ssize_t charge_stop_threshold_show(struct device *device,
9529 struct device_attribute *attr,
9530 char *buf)
9531{
9532 return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9533}
9534
9535static ssize_t charge_start_threshold_store(struct device *dev,
9536 struct device_attribute *attr,
9537 const char *buf, size_t count)
9538{
9539 return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9540}
9541
9542static ssize_t charge_stop_threshold_store(struct device *dev,
9543 struct device_attribute *attr,
9544 const char *buf, size_t count)
9545{
9546 return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9547}
9548
9549static DEVICE_ATTR_RW(charge_start_threshold);
9550static DEVICE_ATTR_RW(charge_stop_threshold);
9551
9552static struct attribute *tpacpi_battery_attrs[] = {
9553 &dev_attr_charge_start_threshold.attr,
9554 &dev_attr_charge_stop_threshold.attr,
9555 NULL,
9556};
9557
9558ATTRIBUTE_GROUPS(tpacpi_battery);
9559
9560/* ACPI battery hooking */
9561
9562static int tpacpi_battery_add(struct power_supply *battery)
9563{
9564 int batteryid = tpacpi_battery_get_id(battery->desc->name);
9565
9566 if (tpacpi_battery_probe(batteryid))
9567 return -ENODEV;
9568 if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9569 return -ENODEV;
9570 return 0;
9571}
9572
9573static int tpacpi_battery_remove(struct power_supply *battery)
9574{
9575 device_remove_groups(&battery->dev, tpacpi_battery_groups);
9576 return 0;
9577}
9578
9579static struct acpi_battery_hook battery_hook = {
9580 .add_battery = tpacpi_battery_add,
9581 .remove_battery = tpacpi_battery_remove,
9582 .name = "ThinkPad Battery Extension",
9583};
9584
9585/* Subdriver init/exit */
9586
9587static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9588{
9589 battery_hook_register(&battery_hook);
9590 return 0;
9591}
9592
9593static void tpacpi_battery_exit(void)
9594{
9595 battery_hook_unregister(&battery_hook);
9596}
9597
9598static struct ibm_struct battery_driver_data = {
9599 .name = "battery",
9600 .exit = tpacpi_battery_exit,
9601};
9602
9603/****************************************************************************
9604 ****************************************************************************
9605 *
9606 * Infrastructure
9607 *
9608 ****************************************************************************
9609 ****************************************************************************/
9610
9611/*
9612 * HKEY event callout for other subdrivers go here
9613 * (yes, it is ugly, but it is quick, safe, and gets the job done
9614 */
9615static void tpacpi_driver_event(const unsigned int hkey_event)
9616{
9617 if (ibm_backlight_device) {
9618 switch (hkey_event) {
9619 case TP_HKEY_EV_BRGHT_UP:
9620 case TP_HKEY_EV_BRGHT_DOWN:
9621 tpacpi_brightness_notify_change();
9622 }
9623 }
9624 if (alsa_card) {
9625 switch (hkey_event) {
9626 case TP_HKEY_EV_VOL_UP:
9627 case TP_HKEY_EV_VOL_DOWN:
9628 case TP_HKEY_EV_VOL_MUTE:
9629 volume_alsa_notify_change();
9630 }
9631 }
9632 if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
9633 enum led_brightness brightness;
9634
9635 mutex_lock(&kbdlight_mutex);
9636
9637 /*
9638 * Check the brightness actually changed, setting the brightness
9639 * through kbdlight_set_level() also triggers this event.
9640 */
9641 brightness = kbdlight_sysfs_get(NULL);
9642 if (kbdlight_brightness != brightness) {
9643 kbdlight_brightness = brightness;
9644 led_classdev_notify_brightness_hw_changed(
9645 &tpacpi_led_kbdlight.led_classdev, brightness);
9646 }
9647
9648 mutex_unlock(&kbdlight_mutex);
9649 }
9650}
9651
9652static void hotkey_driver_event(const unsigned int scancode)
9653{
9654 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
9655}
9656
9657/* --------------------------------------------------------------------- */
9658
9659/* /proc support */
9660static struct proc_dir_entry *proc_dir;
9661
9662/*
9663 * Module and infrastructure proble, init and exit handling
9664 */
9665
9666static bool force_load;
9667
9668#ifdef CONFIG_THINKPAD_ACPI_DEBUG
9669static const char * __init str_supported(int is_supported)
9670{
9671 static char text_unsupported[] __initdata = "not supported";
9672
9673 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
9674}
9675#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
9676
9677static void ibm_exit(struct ibm_struct *ibm)
9678{
9679 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
9680
9681 list_del_init(&ibm->all_drivers);
9682
9683 if (ibm->flags.acpi_notify_installed) {
9684 dbg_printk(TPACPI_DBG_EXIT,
9685 "%s: acpi_remove_notify_handler\n", ibm->name);
9686 BUG_ON(!ibm->acpi);
9687 acpi_remove_notify_handler(*ibm->acpi->handle,
9688 ibm->acpi->type,
9689 dispatch_acpi_notify);
9690 ibm->flags.acpi_notify_installed = 0;
9691 }
9692
9693 if (ibm->flags.proc_created) {
9694 dbg_printk(TPACPI_DBG_EXIT,
9695 "%s: remove_proc_entry\n", ibm->name);
9696 remove_proc_entry(ibm->name, proc_dir);
9697 ibm->flags.proc_created = 0;
9698 }
9699
9700 if (ibm->flags.acpi_driver_registered) {
9701 dbg_printk(TPACPI_DBG_EXIT,
9702 "%s: acpi_bus_unregister_driver\n", ibm->name);
9703 BUG_ON(!ibm->acpi);
9704 acpi_bus_unregister_driver(ibm->acpi->driver);
9705 kfree(ibm->acpi->driver);
9706 ibm->acpi->driver = NULL;
9707 ibm->flags.acpi_driver_registered = 0;
9708 }
9709
9710 if (ibm->flags.init_called && ibm->exit) {
9711 ibm->exit();
9712 ibm->flags.init_called = 0;
9713 }
9714
9715 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
9716}
9717
9718static int __init ibm_init(struct ibm_init_struct *iibm)
9719{
9720 int ret;
9721 struct ibm_struct *ibm = iibm->data;
9722 struct proc_dir_entry *entry;
9723
9724 BUG_ON(ibm == NULL);
9725
9726 INIT_LIST_HEAD(&ibm->all_drivers);
9727
9728 if (ibm->flags.experimental && !experimental)
9729 return 0;
9730
9731 dbg_printk(TPACPI_DBG_INIT,
9732 "probing for %s\n", ibm->name);
9733
9734 if (iibm->init) {
9735 ret = iibm->init(iibm);
9736 if (ret > 0)
9737 return 0; /* probe failed */
9738 if (ret)
9739 return ret;
9740
9741 ibm->flags.init_called = 1;
9742 }
9743
9744 if (ibm->acpi) {
9745 if (ibm->acpi->hid) {
9746 ret = register_tpacpi_subdriver(ibm);
9747 if (ret)
9748 goto err_out;
9749 }
9750
9751 if (ibm->acpi->notify) {
9752 ret = setup_acpi_notify(ibm);
9753 if (ret == -ENODEV) {
9754 pr_notice("disabling subdriver %s\n",
9755 ibm->name);
9756 ret = 0;
9757 goto err_out;
9758 }
9759 if (ret < 0)
9760 goto err_out;
9761 }
9762 }
9763
9764 dbg_printk(TPACPI_DBG_INIT,
9765 "%s installed\n", ibm->name);
9766
9767 if (ibm->read) {
9768 umode_t mode = iibm->base_procfs_mode;
9769
9770 if (!mode)
9771 mode = S_IRUGO;
9772 if (ibm->write)
9773 mode |= S_IWUSR;
9774 entry = proc_create_data(ibm->name, mode, proc_dir,
9775 &dispatch_proc_fops, ibm);
9776 if (!entry) {
9777 pr_err("unable to create proc entry %s\n", ibm->name);
9778 ret = -ENODEV;
9779 goto err_out;
9780 }
9781 ibm->flags.proc_created = 1;
9782 }
9783
9784 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
9785
9786 return 0;
9787
9788err_out:
9789 dbg_printk(TPACPI_DBG_INIT,
9790 "%s: at error exit path with result %d\n",
9791 ibm->name, ret);
9792
9793 ibm_exit(ibm);
9794 return (ret < 0) ? ret : 0;
9795}
9796
9797/* Probing */
9798
9799static bool __pure __init tpacpi_is_fw_digit(const char c)
9800{
9801 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
9802}
9803
9804static bool __pure __init tpacpi_is_valid_fw_id(const char * const s,
9805 const char t)
9806{
9807 /*
9808 * Most models: xxyTkkWW (#.##c)
9809 * Ancient 570/600 and -SL lacks (#.##c)
9810 */
9811 if (s && strlen(s) >= 8 &&
9812 tpacpi_is_fw_digit(s[0]) &&
9813 tpacpi_is_fw_digit(s[1]) &&
9814 s[2] == t &&
9815 (s[3] == 'T' || s[3] == 'N') &&
9816 tpacpi_is_fw_digit(s[4]) &&
9817 tpacpi_is_fw_digit(s[5]))
9818 return true;
9819
9820 /* New models: xxxyTkkW (#.##c); T550 and some others */
9821 return s && strlen(s) >= 8 &&
9822 tpacpi_is_fw_digit(s[0]) &&
9823 tpacpi_is_fw_digit(s[1]) &&
9824 tpacpi_is_fw_digit(s[2]) &&
9825 s[3] == t &&
9826 (s[4] == 'T' || s[4] == 'N') &&
9827 tpacpi_is_fw_digit(s[5]) &&
9828 tpacpi_is_fw_digit(s[6]);
9829}
9830
9831/* returns 0 - probe ok, or < 0 - probe error.
9832 * Probe ok doesn't mean thinkpad found.
9833 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
9834static int __must_check __init get_thinkpad_model_data(
9835 struct thinkpad_id_data *tp)
9836{
9837 const struct dmi_device *dev = NULL;
9838 char ec_fw_string[18];
9839 char const *s;
9840
9841 if (!tp)
9842 return -EINVAL;
9843
9844 memset(tp, 0, sizeof(*tp));
9845
9846 if (dmi_name_in_vendors("IBM"))
9847 tp->vendor = PCI_VENDOR_ID_IBM;
9848 else if (dmi_name_in_vendors("LENOVO"))
9849 tp->vendor = PCI_VENDOR_ID_LENOVO;
9850 else
9851 return 0;
9852
9853 s = dmi_get_system_info(DMI_BIOS_VERSION);
9854 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
9855 if (s && !tp->bios_version_str)
9856 return -ENOMEM;
9857
9858 /* Really ancient ThinkPad 240X will fail this, which is fine */
9859 if (!(tpacpi_is_valid_fw_id(tp->bios_version_str, 'E') ||
9860 tpacpi_is_valid_fw_id(tp->bios_version_str, 'C')))
9861 return 0;
9862
9863 tp->bios_model = tp->bios_version_str[0]
9864 | (tp->bios_version_str[1] << 8);
9865 tp->bios_release = (tp->bios_version_str[4] << 8)
9866 | tp->bios_version_str[5];
9867
9868 /*
9869 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
9870 * X32 or newer, all Z series; Some models must have an
9871 * up-to-date BIOS or they will not be detected.
9872 *
9873 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9874 */
9875 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
9876 if (sscanf(dev->name,
9877 "IBM ThinkPad Embedded Controller -[%17c",
9878 ec_fw_string) == 1) {
9879 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
9880 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
9881
9882 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
9883 if (!tp->ec_version_str)
9884 return -ENOMEM;
9885
9886 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
9887 tp->ec_model = ec_fw_string[0]
9888 | (ec_fw_string[1] << 8);
9889 tp->ec_release = (ec_fw_string[4] << 8)
9890 | ec_fw_string[5];
9891 } else {
9892 pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
9893 ec_fw_string);
9894 pr_notice("please report this to %s\n",
9895 TPACPI_MAIL);
9896 }
9897 break;
9898 }
9899 }
9900
9901 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
9902 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
9903 tp->model_str = kstrdup(s, GFP_KERNEL);
9904 if (!tp->model_str)
9905 return -ENOMEM;
9906 } else {
9907 s = dmi_get_system_info(DMI_BIOS_VENDOR);
9908 if (s && !(strncasecmp(s, "Lenovo", 6))) {
9909 tp->model_str = kstrdup(s, GFP_KERNEL);
9910 if (!tp->model_str)
9911 return -ENOMEM;
9912 }
9913 }
9914
9915 s = dmi_get_system_info(DMI_PRODUCT_NAME);
9916 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
9917 if (s && !tp->nummodel_str)
9918 return -ENOMEM;
9919
9920 return 0;
9921}
9922
9923static int __init probe_for_thinkpad(void)
9924{
9925 int is_thinkpad;
9926
9927 if (acpi_disabled)
9928 return -ENODEV;
9929
9930 /* It would be dangerous to run the driver in this case */
9931 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
9932 return -ENODEV;
9933
9934 /*
9935 * Non-ancient models have better DMI tagging, but very old models
9936 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
9937 */
9938 is_thinkpad = (thinkpad_id.model_str != NULL) ||
9939 (thinkpad_id.ec_model != 0) ||
9940 tpacpi_is_fw_known();
9941
9942 /* The EC handler is required */
9943 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
9944 if (!ec_handle) {
9945 if (is_thinkpad)
9946 pr_err("Not yet supported ThinkPad detected!\n");
9947 return -ENODEV;
9948 }
9949
9950 if (!is_thinkpad && !force_load)
9951 return -ENODEV;
9952
9953 return 0;
9954}
9955
9956static void __init thinkpad_acpi_init_banner(void)
9957{
9958 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
9959 pr_info("%s\n", TPACPI_URL);
9960
9961 pr_info("ThinkPad BIOS %s, EC %s\n",
9962 (thinkpad_id.bios_version_str) ?
9963 thinkpad_id.bios_version_str : "unknown",
9964 (thinkpad_id.ec_version_str) ?
9965 thinkpad_id.ec_version_str : "unknown");
9966
9967 BUG_ON(!thinkpad_id.vendor);
9968
9969 if (thinkpad_id.model_str)
9970 pr_info("%s %s, model %s\n",
9971 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
9972 "IBM" : ((thinkpad_id.vendor ==
9973 PCI_VENDOR_ID_LENOVO) ?
9974 "Lenovo" : "Unknown vendor"),
9975 thinkpad_id.model_str,
9976 (thinkpad_id.nummodel_str) ?
9977 thinkpad_id.nummodel_str : "unknown");
9978}
9979
9980/* Module init, exit, parameters */
9981
9982static struct ibm_init_struct ibms_init[] __initdata = {
9983 {
9984 .data = &thinkpad_acpi_driver_data,
9985 },
9986 {
9987 .init = hotkey_init,
9988 .data = &hotkey_driver_data,
9989 },
9990 {
9991 .init = bluetooth_init,
9992 .data = &bluetooth_driver_data,
9993 },
9994 {
9995 .init = wan_init,
9996 .data = &wan_driver_data,
9997 },
9998 {
9999 .init = uwb_init,
10000 .data = &uwb_driver_data,
10001 },
10002#ifdef CONFIG_THINKPAD_ACPI_VIDEO
10003 {
10004 .init = video_init,
10005 .base_procfs_mode = S_IRUSR,
10006 .data = &video_driver_data,
10007 },
10008#endif
10009 {
10010 .init = kbdlight_init,
10011 .data = &kbdlight_driver_data,
10012 },
10013 {
10014 .init = light_init,
10015 .data = &light_driver_data,
10016 },
10017 {
10018 .init = cmos_init,
10019 .data = &cmos_driver_data,
10020 },
10021 {
10022 .init = led_init,
10023 .data = &led_driver_data,
10024 },
10025 {
10026 .init = beep_init,
10027 .data = &beep_driver_data,
10028 },
10029 {
10030 .init = thermal_init,
10031 .data = &thermal_driver_data,
10032 },
10033 {
10034 .init = brightness_init,
10035 .data = &brightness_driver_data,
10036 },
10037 {
10038 .init = volume_init,
10039 .data = &volume_driver_data,
10040 },
10041 {
10042 .init = fan_init,
10043 .data = &fan_driver_data,
10044 },
10045 {
10046 .init = mute_led_init,
10047 .data = &mute_led_driver_data,
10048 },
10049 {
10050 .init = tpacpi_battery_init,
10051 .data = &battery_driver_data,
10052 },
10053};
10054
10055static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
10056{
10057 unsigned int i;
10058 struct ibm_struct *ibm;
10059
10060 if (!kp || !kp->name || !val)
10061 return -EINVAL;
10062
10063 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10064 ibm = ibms_init[i].data;
10065 WARN_ON(ibm == NULL);
10066
10067 if (!ibm || !ibm->name)
10068 continue;
10069
10070 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
10071 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
10072 return -ENOSPC;
10073 strcpy(ibms_init[i].param, val);
10074 strcat(ibms_init[i].param, ",");
10075 return 0;
10076 }
10077 }
10078
10079 return -EINVAL;
10080}
10081
10082module_param(experimental, int, 0444);
10083MODULE_PARM_DESC(experimental,
10084 "Enables experimental features when non-zero");
10085
10086module_param_named(debug, dbg_level, uint, 0);
10087MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
10088
10089module_param(force_load, bool, 0444);
10090MODULE_PARM_DESC(force_load,
10091 "Attempts to load the driver even on a mis-identified ThinkPad when true");
10092
10093module_param_named(fan_control, fan_control_allowed, bool, 0444);
10094MODULE_PARM_DESC(fan_control,
10095 "Enables setting fan parameters features when true");
10096
10097module_param_named(brightness_mode, brightness_mode, uint, 0444);
10098MODULE_PARM_DESC(brightness_mode,
10099 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
10100
10101module_param(brightness_enable, uint, 0444);
10102MODULE_PARM_DESC(brightness_enable,
10103 "Enables backlight control when 1, disables when 0");
10104
10105#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
10106module_param_named(volume_mode, volume_mode, uint, 0444);
10107MODULE_PARM_DESC(volume_mode,
10108 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
10109
10110module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
10111MODULE_PARM_DESC(volume_capabilities,
10112 "Selects the mixer capabilites: 0=auto, 1=volume and mute, 2=mute only");
10113
10114module_param_named(volume_control, volume_control_allowed, bool, 0444);
10115MODULE_PARM_DESC(volume_control,
10116 "Enables software override for the console audio control when true");
10117
10118module_param_named(software_mute, software_mute_requested, bool, 0444);
10119MODULE_PARM_DESC(software_mute,
10120 "Request full software mute control");
10121
10122/* ALSA module API parameters */
10123module_param_named(index, alsa_index, int, 0444);
10124MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
10125module_param_named(id, alsa_id, charp, 0444);
10126MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
10127module_param_named(enable, alsa_enable, bool, 0444);
10128MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
10129#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
10130
10131/* The module parameter can't be read back, that's why 0 is used here */
10132#define TPACPI_PARAM(feature) \
10133 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
10134 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
10135
10136TPACPI_PARAM(hotkey);
10137TPACPI_PARAM(bluetooth);
10138TPACPI_PARAM(video);
10139TPACPI_PARAM(light);
10140TPACPI_PARAM(cmos);
10141TPACPI_PARAM(led);
10142TPACPI_PARAM(beep);
10143TPACPI_PARAM(brightness);
10144TPACPI_PARAM(volume);
10145TPACPI_PARAM(fan);
10146
10147#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10148module_param(dbg_wlswemul, uint, 0444);
10149MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
10150module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
10151MODULE_PARM_DESC(wlsw_state,
10152 "Initial state of the emulated WLSW switch");
10153
10154module_param(dbg_bluetoothemul, uint, 0444);
10155MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
10156module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
10157MODULE_PARM_DESC(bluetooth_state,
10158 "Initial state of the emulated bluetooth switch");
10159
10160module_param(dbg_wwanemul, uint, 0444);
10161MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
10162module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
10163MODULE_PARM_DESC(wwan_state,
10164 "Initial state of the emulated WWAN switch");
10165
10166module_param(dbg_uwbemul, uint, 0444);
10167MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
10168module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
10169MODULE_PARM_DESC(uwb_state,
10170 "Initial state of the emulated UWB switch");
10171#endif
10172
10173static void thinkpad_acpi_module_exit(void)
10174{
10175 struct ibm_struct *ibm, *itmp;
10176
10177 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
10178
10179 list_for_each_entry_safe_reverse(ibm, itmp,
10180 &tpacpi_all_drivers,
10181 all_drivers) {
10182 ibm_exit(ibm);
10183 }
10184
10185 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
10186
10187 if (tpacpi_inputdev) {
10188 if (tp_features.input_device_registered)
10189 input_unregister_device(tpacpi_inputdev);
10190 else
10191 input_free_device(tpacpi_inputdev);
10192 kfree(hotkey_keycode_map);
10193 }
10194
10195 if (tpacpi_hwmon)
10196 hwmon_device_unregister(tpacpi_hwmon);
10197
10198 if (tpacpi_sensors_pdev)
10199 platform_device_unregister(tpacpi_sensors_pdev);
10200 if (tpacpi_pdev)
10201 platform_device_unregister(tpacpi_pdev);
10202
10203 if (tp_features.sensors_pdrv_attrs_registered)
10204 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
10205 if (tp_features.platform_drv_attrs_registered)
10206 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
10207
10208 if (tp_features.sensors_pdrv_registered)
10209 platform_driver_unregister(&tpacpi_hwmon_pdriver);
10210
10211 if (tp_features.platform_drv_registered)
10212 platform_driver_unregister(&tpacpi_pdriver);
10213
10214 if (proc_dir)
10215 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
10216
10217 if (tpacpi_wq)
10218 destroy_workqueue(tpacpi_wq);
10219
10220 kfree(thinkpad_id.bios_version_str);
10221 kfree(thinkpad_id.ec_version_str);
10222 kfree(thinkpad_id.model_str);
10223 kfree(thinkpad_id.nummodel_str);
10224}
10225
10226
10227static int __init thinkpad_acpi_module_init(void)
10228{
10229 int ret, i;
10230
10231 tpacpi_lifecycle = TPACPI_LIFE_INIT;
10232
10233 /* Driver-level probe */
10234
10235 ret = get_thinkpad_model_data(&thinkpad_id);
10236 if (ret) {
10237 pr_err("unable to get DMI data: %d\n", ret);
10238 thinkpad_acpi_module_exit();
10239 return ret;
10240 }
10241 ret = probe_for_thinkpad();
10242 if (ret) {
10243 thinkpad_acpi_module_exit();
10244 return ret;
10245 }
10246
10247 /* Driver initialization */
10248
10249 thinkpad_acpi_init_banner();
10250 tpacpi_check_outdated_fw();
10251
10252 TPACPI_ACPIHANDLE_INIT(ecrd);
10253 TPACPI_ACPIHANDLE_INIT(ecwr);
10254
10255 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
10256 if (!tpacpi_wq) {
10257 thinkpad_acpi_module_exit();
10258 return -ENOMEM;
10259 }
10260
10261 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
10262 if (!proc_dir) {
10263 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
10264 thinkpad_acpi_module_exit();
10265 return -ENODEV;
10266 }
10267
10268 ret = platform_driver_register(&tpacpi_pdriver);
10269 if (ret) {
10270 pr_err("unable to register main platform driver\n");
10271 thinkpad_acpi_module_exit();
10272 return ret;
10273 }
10274 tp_features.platform_drv_registered = 1;
10275
10276 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
10277 if (ret) {
10278 pr_err("unable to register hwmon platform driver\n");
10279 thinkpad_acpi_module_exit();
10280 return ret;
10281 }
10282 tp_features.sensors_pdrv_registered = 1;
10283
10284 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
10285 if (!ret) {
10286 tp_features.platform_drv_attrs_registered = 1;
10287 ret = tpacpi_create_driver_attributes(
10288 &tpacpi_hwmon_pdriver.driver);
10289 }
10290 if (ret) {
10291 pr_err("unable to create sysfs driver attributes\n");
10292 thinkpad_acpi_module_exit();
10293 return ret;
10294 }
10295 tp_features.sensors_pdrv_attrs_registered = 1;
10296
10297
10298 /* Device initialization */
10299 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
10300 NULL, 0);
10301 if (IS_ERR(tpacpi_pdev)) {
10302 ret = PTR_ERR(tpacpi_pdev);
10303 tpacpi_pdev = NULL;
10304 pr_err("unable to register platform device\n");
10305 thinkpad_acpi_module_exit();
10306 return ret;
10307 }
10308 tpacpi_sensors_pdev = platform_device_register_simple(
10309 TPACPI_HWMON_DRVR_NAME,
10310 -1, NULL, 0);
10311 if (IS_ERR(tpacpi_sensors_pdev)) {
10312 ret = PTR_ERR(tpacpi_sensors_pdev);
10313 tpacpi_sensors_pdev = NULL;
10314 pr_err("unable to register hwmon platform device\n");
10315 thinkpad_acpi_module_exit();
10316 return ret;
10317 }
10318 tp_features.sensors_pdev_attrs_registered = 1;
10319 tpacpi_hwmon = hwmon_device_register_with_groups(
10320 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, NULL);
10321
10322 if (IS_ERR(tpacpi_hwmon)) {
10323 ret = PTR_ERR(tpacpi_hwmon);
10324 tpacpi_hwmon = NULL;
10325 pr_err("unable to register hwmon device\n");
10326 thinkpad_acpi_module_exit();
10327 return ret;
10328 }
10329 mutex_init(&tpacpi_inputdev_send_mutex);
10330 tpacpi_inputdev = input_allocate_device();
10331 if (!tpacpi_inputdev) {
10332 thinkpad_acpi_module_exit();
10333 return -ENOMEM;
10334 } else {
10335 /* Prepare input device, but don't register */
10336 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
10337 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
10338 tpacpi_inputdev->id.bustype = BUS_HOST;
10339 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
10340 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
10341 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
10342 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
10343 }
10344
10345 /* Init subdriver dependencies */
10346 tpacpi_detect_brightness_capabilities();
10347
10348 /* Init subdrivers */
10349 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10350 ret = ibm_init(&ibms_init[i]);
10351 if (ret >= 0 && *ibms_init[i].param)
10352 ret = ibms_init[i].data->write(ibms_init[i].param);
10353 if (ret < 0) {
10354 thinkpad_acpi_module_exit();
10355 return ret;
10356 }
10357 }
10358
10359 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
10360
10361 ret = input_register_device(tpacpi_inputdev);
10362 if (ret < 0) {
10363 pr_err("unable to register input device\n");
10364 thinkpad_acpi_module_exit();
10365 return ret;
10366 } else {
10367 tp_features.input_device_registered = 1;
10368 }
10369
10370 return 0;
10371}
10372
10373MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
10374
10375/*
10376 * This will autoload the driver in almost every ThinkPad
10377 * in widespread use.
10378 *
10379 * Only _VERY_ old models, like the 240, 240x and 570 lack
10380 * the HKEY event interface.
10381 */
10382MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
10383
10384/*
10385 * DMI matching for module autoloading
10386 *
10387 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
10388 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
10389 *
10390 * Only models listed in thinkwiki will be supported, so add yours
10391 * if it is not there yet.
10392 */
10393#define IBM_BIOS_MODULE_ALIAS(__type) \
10394 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
10395
10396/* Ancient thinkpad BIOSes have to be identified by
10397 * BIOS type or model number, and there are far less
10398 * BIOS types than model numbers... */
10399IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
10400
10401MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
10402MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
10403MODULE_DESCRIPTION(TPACPI_DESC);
10404MODULE_VERSION(TPACPI_VERSION);
10405MODULE_LICENSE("GPL");
10406
10407module_init(thinkpad_acpi_module_init);
10408module_exit(thinkpad_acpi_module_exit);