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.25"
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#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/fb.h>
70#include <linux/platform_device.h>
71#include <linux/hwmon.h>
72#include <linux/hwmon-sysfs.h>
73#include <linux/input.h>
74#include <linux/leds.h>
75#include <linux/rfkill.h>
76#include <linux/dmi.h>
77#include <linux/jiffies.h>
78#include <linux/workqueue.h>
79#include <linux/acpi.h>
80#include <linux/pci_ids.h>
81#include <linux/thinkpad_acpi.h>
82#include <sound/core.h>
83#include <sound/control.h>
84#include <sound/initval.h>
85#include <asm/uaccess.h>
86#include <acpi/video.h>
87
88/* ThinkPad CMOS commands */
89#define TP_CMOS_VOLUME_DOWN 0
90#define TP_CMOS_VOLUME_UP 1
91#define TP_CMOS_VOLUME_MUTE 2
92#define TP_CMOS_BRIGHTNESS_UP 4
93#define TP_CMOS_BRIGHTNESS_DOWN 5
94#define TP_CMOS_THINKLIGHT_ON 12
95#define TP_CMOS_THINKLIGHT_OFF 13
96
97/* NVRAM Addresses */
98enum tp_nvram_addr {
99 TP_NVRAM_ADDR_HK2 = 0x57,
100 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
101 TP_NVRAM_ADDR_VIDEO = 0x59,
102 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
103 TP_NVRAM_ADDR_MIXER = 0x60,
104};
105
106/* NVRAM bit masks */
107enum {
108 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
109 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
110 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
111 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
112 TP_NVRAM_MASK_THINKLIGHT = 0x10,
113 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
114 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
115 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
116 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
117 TP_NVRAM_MASK_MUTE = 0x40,
118 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
119 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
120 TP_NVRAM_POS_LEVEL_VOLUME = 0,
121};
122
123/* Misc NVRAM-related */
124enum {
125 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
126};
127
128/* ACPI HIDs */
129#define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
130#define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
131#define TPACPI_ACPI_EC_HID "PNP0C09"
132
133/* Input IDs */
134#define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
135#define TPACPI_HKEY_INPUT_VERSION 0x4101
136
137/* ACPI \WGSV commands */
138enum {
139 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
140 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
141 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
142 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
143};
144
145/* TP_ACPI_WGSV_GET_STATE bits */
146enum {
147 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
148 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
149 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
150 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
151 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
152 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
153 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
154 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
155 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
156 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
157};
158
159/* HKEY events */
160enum tpacpi_hkey_event_t {
161 /* Hotkey-related */
162 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
163 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
164 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
165 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
166 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
167 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
168
169 /* Reasons for waking up from S3/S4 */
170 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
171 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
172 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
173 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
174 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
175 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
176
177 /* Auto-sleep after eject request */
178 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
179 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
180
181 /* Misc bay events */
182 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
183 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
184 or port replicator */
185 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
186 dock or port replicator */
187
188 /* User-interface events */
189 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
190 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
191 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
192 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
193 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
194 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
195 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
196
197 /* Key-related user-interface events */
198 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
199 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
200 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
201
202 /* Thermal events */
203 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
204 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
205 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
206 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
207 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
208
209 /* AC-related events */
210 TP_HKEY_EV_AC_CHANGED = 0x6040, /* AC status changed */
211
212 /* Misc */
213 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
214};
215
216/****************************************************************************
217 * Main driver
218 */
219
220#define TPACPI_NAME "thinkpad"
221#define TPACPI_DESC "ThinkPad ACPI Extras"
222#define TPACPI_FILE TPACPI_NAME "_acpi"
223#define TPACPI_URL "http://ibm-acpi.sf.net/"
224#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
225
226#define TPACPI_PROC_DIR "ibm"
227#define TPACPI_ACPI_EVENT_PREFIX "ibm"
228#define TPACPI_DRVR_NAME TPACPI_FILE
229#define TPACPI_DRVR_SHORTNAME "tpacpi"
230#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
231
232#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
233#define TPACPI_WORKQUEUE_NAME "ktpacpid"
234
235#define TPACPI_MAX_ACPI_ARGS 3
236
237/* Debugging printk groups */
238#define TPACPI_DBG_ALL 0xffff
239#define TPACPI_DBG_DISCLOSETASK 0x8000
240#define TPACPI_DBG_INIT 0x0001
241#define TPACPI_DBG_EXIT 0x0002
242#define TPACPI_DBG_RFKILL 0x0004
243#define TPACPI_DBG_HKEY 0x0008
244#define TPACPI_DBG_FAN 0x0010
245#define TPACPI_DBG_BRGHT 0x0020
246#define TPACPI_DBG_MIXER 0x0040
247
248#define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
249#define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
250#define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
251
252
253/****************************************************************************
254 * Driver-wide structs and misc. variables
255 */
256
257struct ibm_struct;
258
259struct tp_acpi_drv_struct {
260 const struct acpi_device_id *hid;
261 struct acpi_driver *driver;
262
263 void (*notify) (struct ibm_struct *, u32);
264 acpi_handle *handle;
265 u32 type;
266 struct acpi_device *device;
267};
268
269struct ibm_struct {
270 char *name;
271
272 int (*read) (struct seq_file *);
273 int (*write) (char *);
274 void (*exit) (void);
275 void (*resume) (void);
276 void (*suspend) (void);
277 void (*shutdown) (void);
278
279 struct list_head all_drivers;
280
281 struct tp_acpi_drv_struct *acpi;
282
283 struct {
284 u8 acpi_driver_registered:1;
285 u8 acpi_notify_installed:1;
286 u8 proc_created:1;
287 u8 init_called:1;
288 u8 experimental:1;
289 } flags;
290};
291
292struct ibm_init_struct {
293 char param[32];
294
295 int (*init) (struct ibm_init_struct *);
296 umode_t base_procfs_mode;
297 struct ibm_struct *data;
298};
299
300static struct {
301 u32 bluetooth:1;
302 u32 hotkey:1;
303 u32 hotkey_mask:1;
304 u32 hotkey_wlsw:1;
305 u32 hotkey_tablet:1;
306 u32 kbdlight:1;
307 u32 light:1;
308 u32 light_status:1;
309 u32 bright_acpimode:1;
310 u32 bright_unkfw:1;
311 u32 wan:1;
312 u32 uwb:1;
313 u32 fan_ctrl_status_undef:1;
314 u32 second_fan:1;
315 u32 beep_needs_two_args:1;
316 u32 mixer_no_level_control:1;
317 u32 input_device_registered:1;
318 u32 platform_drv_registered:1;
319 u32 platform_drv_attrs_registered:1;
320 u32 sensors_pdrv_registered:1;
321 u32 sensors_pdrv_attrs_registered:1;
322 u32 sensors_pdev_attrs_registered:1;
323 u32 hotkey_poll_active:1;
324 u32 has_adaptive_kbd:1;
325} tp_features;
326
327static struct {
328 u16 hotkey_mask_ff:1;
329 u16 volume_ctrl_forbidden:1;
330} tp_warned;
331
332struct thinkpad_id_data {
333 unsigned int vendor; /* ThinkPad vendor:
334 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
335
336 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
337 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
338
339 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
340 u16 ec_model;
341 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
342 u16 ec_release;
343
344 char *model_str; /* ThinkPad T43 */
345 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
346};
347static struct thinkpad_id_data thinkpad_id;
348
349static enum {
350 TPACPI_LIFE_INIT = 0,
351 TPACPI_LIFE_RUNNING,
352 TPACPI_LIFE_EXITING,
353} tpacpi_lifecycle;
354
355static int experimental;
356static u32 dbg_level;
357
358static struct workqueue_struct *tpacpi_wq;
359
360enum led_status_t {
361 TPACPI_LED_OFF = 0,
362 TPACPI_LED_ON,
363 TPACPI_LED_BLINK,
364};
365
366/* Special LED class that can defer work */
367struct tpacpi_led_classdev {
368 struct led_classdev led_classdev;
369 struct work_struct work;
370 enum led_status_t new_state;
371 int led;
372};
373
374/* brightness level capabilities */
375static unsigned int bright_maxlvl; /* 0 = unknown */
376
377#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
378static int dbg_wlswemul;
379static bool tpacpi_wlsw_emulstate;
380static int dbg_bluetoothemul;
381static bool tpacpi_bluetooth_emulstate;
382static int dbg_wwanemul;
383static bool tpacpi_wwan_emulstate;
384static int dbg_uwbemul;
385static bool tpacpi_uwb_emulstate;
386#endif
387
388
389/*************************************************************************
390 * Debugging helpers
391 */
392
393#define dbg_printk(a_dbg_level, format, arg...) \
394do { \
395 if (dbg_level & (a_dbg_level)) \
396 printk(KERN_DEBUG pr_fmt("%s: " format), \
397 __func__, ##arg); \
398} while (0)
399
400#ifdef CONFIG_THINKPAD_ACPI_DEBUG
401#define vdbg_printk dbg_printk
402static const char *str_supported(int is_supported);
403#else
404static inline const char *str_supported(int is_supported) { return ""; }
405#define vdbg_printk(a_dbg_level, format, arg...) \
406 do { if (0) no_printk(format, ##arg); } while (0)
407#endif
408
409static void tpacpi_log_usertask(const char * const what)
410{
411 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
412 what, task_tgid_vnr(current));
413}
414
415#define tpacpi_disclose_usertask(what, format, arg...) \
416do { \
417 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
418 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
419 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
420 what, task_tgid_vnr(current), ## arg); \
421 } \
422} while (0)
423
424/*
425 * Quirk handling helpers
426 *
427 * ThinkPad IDs and versions seen in the field so far
428 * are two-characters from the set [0-9A-Z], i.e. base 36.
429 *
430 * We use values well outside that range as specials.
431 */
432
433#define TPACPI_MATCH_ANY 0xffffU
434#define TPACPI_MATCH_UNKNOWN 0U
435
436/* TPID('1', 'Y') == 0x5931 */
437#define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
438
439#define TPACPI_Q_IBM(__id1, __id2, __quirk) \
440 { .vendor = PCI_VENDOR_ID_IBM, \
441 .bios = TPID(__id1, __id2), \
442 .ec = TPACPI_MATCH_ANY, \
443 .quirks = (__quirk) }
444
445#define TPACPI_Q_LNV(__id1, __id2, __quirk) \
446 { .vendor = PCI_VENDOR_ID_LENOVO, \
447 .bios = TPID(__id1, __id2), \
448 .ec = TPACPI_MATCH_ANY, \
449 .quirks = (__quirk) }
450
451#define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
452 { .vendor = PCI_VENDOR_ID_LENOVO, \
453 .bios = TPACPI_MATCH_ANY, \
454 .ec = TPID(__id1, __id2), \
455 .quirks = (__quirk) }
456
457struct tpacpi_quirk {
458 unsigned int vendor;
459 u16 bios;
460 u16 ec;
461 unsigned long quirks;
462};
463
464/**
465 * tpacpi_check_quirks() - search BIOS/EC version on a list
466 * @qlist: array of &struct tpacpi_quirk
467 * @qlist_size: number of elements in @qlist
468 *
469 * Iterates over a quirks list until one is found that matches the
470 * ThinkPad's vendor, BIOS and EC model.
471 *
472 * Returns 0 if nothing matches, otherwise returns the quirks field of
473 * the matching &struct tpacpi_quirk entry.
474 *
475 * The match criteria is: vendor, ec and bios much match.
476 */
477static unsigned long __init tpacpi_check_quirks(
478 const struct tpacpi_quirk *qlist,
479 unsigned int qlist_size)
480{
481 while (qlist_size) {
482 if ((qlist->vendor == thinkpad_id.vendor ||
483 qlist->vendor == TPACPI_MATCH_ANY) &&
484 (qlist->bios == thinkpad_id.bios_model ||
485 qlist->bios == TPACPI_MATCH_ANY) &&
486 (qlist->ec == thinkpad_id.ec_model ||
487 qlist->ec == TPACPI_MATCH_ANY))
488 return qlist->quirks;
489
490 qlist_size--;
491 qlist++;
492 }
493 return 0;
494}
495
496static inline bool __pure __init tpacpi_is_lenovo(void)
497{
498 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
499}
500
501static inline bool __pure __init tpacpi_is_ibm(void)
502{
503 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
504}
505
506/****************************************************************************
507 ****************************************************************************
508 *
509 * ACPI Helpers and device model
510 *
511 ****************************************************************************
512 ****************************************************************************/
513
514/*************************************************************************
515 * ACPI basic handles
516 */
517
518static acpi_handle root_handle;
519static acpi_handle ec_handle;
520
521#define TPACPI_HANDLE(object, parent, paths...) \
522 static acpi_handle object##_handle; \
523 static const acpi_handle * const object##_parent __initconst = \
524 &parent##_handle; \
525 static char *object##_paths[] __initdata = { paths }
526
527TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
528TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
529
530TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
531 /* T4x, X31, X40 */
532 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
533 "\\CMS", /* R40, R40e */
534 ); /* all others */
535
536TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
537 "^HKEY", /* R30, R31 */
538 "HKEY", /* all others */
539 ); /* 570 */
540
541/*************************************************************************
542 * ACPI helpers
543 */
544
545static int acpi_evalf(acpi_handle handle,
546 int *res, char *method, char *fmt, ...)
547{
548 char *fmt0 = fmt;
549 struct acpi_object_list params;
550 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
551 struct acpi_buffer result, *resultp;
552 union acpi_object out_obj;
553 acpi_status status;
554 va_list ap;
555 char res_type;
556 int success;
557 int quiet;
558
559 if (!*fmt) {
560 pr_err("acpi_evalf() called with empty format\n");
561 return 0;
562 }
563
564 if (*fmt == 'q') {
565 quiet = 1;
566 fmt++;
567 } else
568 quiet = 0;
569
570 res_type = *(fmt++);
571
572 params.count = 0;
573 params.pointer = &in_objs[0];
574
575 va_start(ap, fmt);
576 while (*fmt) {
577 char c = *(fmt++);
578 switch (c) {
579 case 'd': /* int */
580 in_objs[params.count].integer.value = va_arg(ap, int);
581 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
582 break;
583 /* add more types as needed */
584 default:
585 pr_err("acpi_evalf() called "
586 "with invalid format character '%c'\n", c);
587 va_end(ap);
588 return 0;
589 }
590 }
591 va_end(ap);
592
593 if (res_type != 'v') {
594 result.length = sizeof(out_obj);
595 result.pointer = &out_obj;
596 resultp = &result;
597 } else
598 resultp = NULL;
599
600 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
601
602 switch (res_type) {
603 case 'd': /* int */
604 success = (status == AE_OK &&
605 out_obj.type == ACPI_TYPE_INTEGER);
606 if (success && res)
607 *res = out_obj.integer.value;
608 break;
609 case 'v': /* void */
610 success = status == AE_OK;
611 break;
612 /* add more types as needed */
613 default:
614 pr_err("acpi_evalf() called "
615 "with invalid format character '%c'\n", res_type);
616 return 0;
617 }
618
619 if (!success && !quiet)
620 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
621 method, fmt0, acpi_format_exception(status));
622
623 return success;
624}
625
626static int acpi_ec_read(int i, u8 *p)
627{
628 int v;
629
630 if (ecrd_handle) {
631 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
632 return 0;
633 *p = v;
634 } else {
635 if (ec_read(i, p) < 0)
636 return 0;
637 }
638
639 return 1;
640}
641
642static int acpi_ec_write(int i, u8 v)
643{
644 if (ecwr_handle) {
645 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
646 return 0;
647 } else {
648 if (ec_write(i, v) < 0)
649 return 0;
650 }
651
652 return 1;
653}
654
655static int issue_thinkpad_cmos_command(int cmos_cmd)
656{
657 if (!cmos_handle)
658 return -ENXIO;
659
660 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
661 return -EIO;
662
663 return 0;
664}
665
666/*************************************************************************
667 * ACPI device model
668 */
669
670#define TPACPI_ACPIHANDLE_INIT(object) \
671 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
672 object##_paths, ARRAY_SIZE(object##_paths))
673
674static void __init drv_acpi_handle_init(const char *name,
675 acpi_handle *handle, const acpi_handle parent,
676 char **paths, const int num_paths)
677{
678 int i;
679 acpi_status status;
680
681 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
682 name);
683
684 for (i = 0; i < num_paths; i++) {
685 status = acpi_get_handle(parent, paths[i], handle);
686 if (ACPI_SUCCESS(status)) {
687 dbg_printk(TPACPI_DBG_INIT,
688 "Found ACPI handle %s for %s\n",
689 paths[i], name);
690 return;
691 }
692 }
693
694 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
695 name);
696 *handle = NULL;
697}
698
699static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
700 u32 level, void *context, void **return_value)
701{
702 struct acpi_device *dev;
703 if (!strcmp(context, "video")) {
704 if (acpi_bus_get_device(handle, &dev))
705 return AE_OK;
706 if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
707 return AE_OK;
708 }
709
710 *(acpi_handle *)return_value = handle;
711
712 return AE_CTRL_TERMINATE;
713}
714
715static void __init tpacpi_acpi_handle_locate(const char *name,
716 const char *hid,
717 acpi_handle *handle)
718{
719 acpi_status status;
720 acpi_handle device_found;
721
722 BUG_ON(!name || !handle);
723 vdbg_printk(TPACPI_DBG_INIT,
724 "trying to locate ACPI handle for %s, using HID %s\n",
725 name, hid ? hid : "NULL");
726
727 memset(&device_found, 0, sizeof(device_found));
728 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
729 (void *)name, &device_found);
730
731 *handle = NULL;
732
733 if (ACPI_SUCCESS(status)) {
734 *handle = device_found;
735 dbg_printk(TPACPI_DBG_INIT,
736 "Found ACPI handle for %s\n", name);
737 } else {
738 vdbg_printk(TPACPI_DBG_INIT,
739 "Could not locate an ACPI handle for %s: %s\n",
740 name, acpi_format_exception(status));
741 }
742}
743
744static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
745{
746 struct ibm_struct *ibm = data;
747
748 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
749 return;
750
751 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
752 return;
753
754 ibm->acpi->notify(ibm, event);
755}
756
757static int __init setup_acpi_notify(struct ibm_struct *ibm)
758{
759 acpi_status status;
760 int rc;
761
762 BUG_ON(!ibm->acpi);
763
764 if (!*ibm->acpi->handle)
765 return 0;
766
767 vdbg_printk(TPACPI_DBG_INIT,
768 "setting up ACPI notify for %s\n", ibm->name);
769
770 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
771 if (rc < 0) {
772 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
773 return -ENODEV;
774 }
775
776 ibm->acpi->device->driver_data = ibm;
777 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
778 TPACPI_ACPI_EVENT_PREFIX,
779 ibm->name);
780
781 status = acpi_install_notify_handler(*ibm->acpi->handle,
782 ibm->acpi->type, dispatch_acpi_notify, ibm);
783 if (ACPI_FAILURE(status)) {
784 if (status == AE_ALREADY_EXISTS) {
785 pr_notice("another device driver is already "
786 "handling %s events\n", ibm->name);
787 } else {
788 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
789 ibm->name, acpi_format_exception(status));
790 }
791 return -ENODEV;
792 }
793 ibm->flags.acpi_notify_installed = 1;
794 return 0;
795}
796
797static int __init tpacpi_device_add(struct acpi_device *device)
798{
799 return 0;
800}
801
802static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
803{
804 int rc;
805
806 dbg_printk(TPACPI_DBG_INIT,
807 "registering %s as an ACPI driver\n", ibm->name);
808
809 BUG_ON(!ibm->acpi);
810
811 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
812 if (!ibm->acpi->driver) {
813 pr_err("failed to allocate memory for ibm->acpi->driver\n");
814 return -ENOMEM;
815 }
816
817 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
818 ibm->acpi->driver->ids = ibm->acpi->hid;
819
820 ibm->acpi->driver->ops.add = &tpacpi_device_add;
821
822 rc = acpi_bus_register_driver(ibm->acpi->driver);
823 if (rc < 0) {
824 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
825 ibm->name, rc);
826 kfree(ibm->acpi->driver);
827 ibm->acpi->driver = NULL;
828 } else if (!rc)
829 ibm->flags.acpi_driver_registered = 1;
830
831 return rc;
832}
833
834
835/****************************************************************************
836 ****************************************************************************
837 *
838 * Procfs Helpers
839 *
840 ****************************************************************************
841 ****************************************************************************/
842
843static int dispatch_proc_show(struct seq_file *m, void *v)
844{
845 struct ibm_struct *ibm = m->private;
846
847 if (!ibm || !ibm->read)
848 return -EINVAL;
849 return ibm->read(m);
850}
851
852static int dispatch_proc_open(struct inode *inode, struct file *file)
853{
854 return single_open(file, dispatch_proc_show, PDE_DATA(inode));
855}
856
857static ssize_t dispatch_proc_write(struct file *file,
858 const char __user *userbuf,
859 size_t count, loff_t *pos)
860{
861 struct ibm_struct *ibm = PDE_DATA(file_inode(file));
862 char *kernbuf;
863 int ret;
864
865 if (!ibm || !ibm->write)
866 return -EINVAL;
867 if (count > PAGE_SIZE - 2)
868 return -EINVAL;
869
870 kernbuf = kmalloc(count + 2, GFP_KERNEL);
871 if (!kernbuf)
872 return -ENOMEM;
873
874 if (copy_from_user(kernbuf, userbuf, count)) {
875 kfree(kernbuf);
876 return -EFAULT;
877 }
878
879 kernbuf[count] = 0;
880 strcat(kernbuf, ",");
881 ret = ibm->write(kernbuf);
882 if (ret == 0)
883 ret = count;
884
885 kfree(kernbuf);
886
887 return ret;
888}
889
890static const struct file_operations dispatch_proc_fops = {
891 .owner = THIS_MODULE,
892 .open = dispatch_proc_open,
893 .read = seq_read,
894 .llseek = seq_lseek,
895 .release = single_release,
896 .write = dispatch_proc_write,
897};
898
899static char *next_cmd(char **cmds)
900{
901 char *start = *cmds;
902 char *end;
903
904 while ((end = strchr(start, ',')) && end == start)
905 start = end + 1;
906
907 if (!end)
908 return NULL;
909
910 *end = 0;
911 *cmds = end + 1;
912 return start;
913}
914
915
916/****************************************************************************
917 ****************************************************************************
918 *
919 * Device model: input, hwmon and platform
920 *
921 ****************************************************************************
922 ****************************************************************************/
923
924static struct platform_device *tpacpi_pdev;
925static struct platform_device *tpacpi_sensors_pdev;
926static struct device *tpacpi_hwmon;
927static struct input_dev *tpacpi_inputdev;
928static struct mutex tpacpi_inputdev_send_mutex;
929static LIST_HEAD(tpacpi_all_drivers);
930
931#ifdef CONFIG_PM_SLEEP
932static int tpacpi_suspend_handler(struct device *dev)
933{
934 struct ibm_struct *ibm, *itmp;
935
936 list_for_each_entry_safe(ibm, itmp,
937 &tpacpi_all_drivers,
938 all_drivers) {
939 if (ibm->suspend)
940 (ibm->suspend)();
941 }
942
943 return 0;
944}
945
946static int tpacpi_resume_handler(struct device *dev)
947{
948 struct ibm_struct *ibm, *itmp;
949
950 list_for_each_entry_safe(ibm, itmp,
951 &tpacpi_all_drivers,
952 all_drivers) {
953 if (ibm->resume)
954 (ibm->resume)();
955 }
956
957 return 0;
958}
959#endif
960
961static SIMPLE_DEV_PM_OPS(tpacpi_pm,
962 tpacpi_suspend_handler, tpacpi_resume_handler);
963
964static void tpacpi_shutdown_handler(struct platform_device *pdev)
965{
966 struct ibm_struct *ibm, *itmp;
967
968 list_for_each_entry_safe(ibm, itmp,
969 &tpacpi_all_drivers,
970 all_drivers) {
971 if (ibm->shutdown)
972 (ibm->shutdown)();
973 }
974}
975
976static struct platform_driver tpacpi_pdriver = {
977 .driver = {
978 .name = TPACPI_DRVR_NAME,
979 .pm = &tpacpi_pm,
980 },
981 .shutdown = tpacpi_shutdown_handler,
982};
983
984static struct platform_driver tpacpi_hwmon_pdriver = {
985 .driver = {
986 .name = TPACPI_HWMON_DRVR_NAME,
987 },
988};
989
990/*************************************************************************
991 * sysfs support helpers
992 */
993
994struct attribute_set {
995 unsigned int members, max_members;
996 struct attribute_group group;
997};
998
999struct attribute_set_obj {
1000 struct attribute_set s;
1001 struct attribute *a;
1002} __attribute__((packed));
1003
1004static struct attribute_set *create_attr_set(unsigned int max_members,
1005 const char *name)
1006{
1007 struct attribute_set_obj *sobj;
1008
1009 if (max_members == 0)
1010 return NULL;
1011
1012 /* Allocates space for implicit NULL at the end too */
1013 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1014 max_members * sizeof(struct attribute *),
1015 GFP_KERNEL);
1016 if (!sobj)
1017 return NULL;
1018 sobj->s.max_members = max_members;
1019 sobj->s.group.attrs = &sobj->a;
1020 sobj->s.group.name = name;
1021
1022 return &sobj->s;
1023}
1024
1025#define destroy_attr_set(_set) \
1026 kfree(_set);
1027
1028/* not multi-threaded safe, use it in a single thread per set */
1029static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1030{
1031 if (!s || !attr)
1032 return -EINVAL;
1033
1034 if (s->members >= s->max_members)
1035 return -ENOMEM;
1036
1037 s->group.attrs[s->members] = attr;
1038 s->members++;
1039
1040 return 0;
1041}
1042
1043static int add_many_to_attr_set(struct attribute_set *s,
1044 struct attribute **attr,
1045 unsigned int count)
1046{
1047 int i, res;
1048
1049 for (i = 0; i < count; i++) {
1050 res = add_to_attr_set(s, attr[i]);
1051 if (res)
1052 return res;
1053 }
1054
1055 return 0;
1056}
1057
1058static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1059{
1060 sysfs_remove_group(kobj, &s->group);
1061 destroy_attr_set(s);
1062}
1063
1064#define register_attr_set_with_sysfs(_attr_set, _kobj) \
1065 sysfs_create_group(_kobj, &_attr_set->group)
1066
1067static int parse_strtoul(const char *buf,
1068 unsigned long max, unsigned long *value)
1069{
1070 char *endp;
1071
1072 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1073 endp = skip_spaces(endp);
1074 if (*endp || *value > max)
1075 return -EINVAL;
1076
1077 return 0;
1078}
1079
1080static void tpacpi_disable_brightness_delay(void)
1081{
1082 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1083 pr_notice("ACPI backlight control delay disabled\n");
1084}
1085
1086static void printk_deprecated_attribute(const char * const what,
1087 const char * const details)
1088{
1089 tpacpi_log_usertask("deprecated sysfs attribute");
1090 pr_warn("WARNING: sysfs attribute %s is deprecated and "
1091 "will be removed. %s\n",
1092 what, details);
1093}
1094
1095/*************************************************************************
1096 * rfkill and radio control support helpers
1097 */
1098
1099/*
1100 * ThinkPad-ACPI firmware handling model:
1101 *
1102 * WLSW (master wireless switch) is event-driven, and is common to all
1103 * firmware-controlled radios. It cannot be controlled, just monitored,
1104 * as expected. It overrides all radio state in firmware
1105 *
1106 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1107 * (TODO: verify how WLSW interacts with the returned radio state).
1108 *
1109 * The only time there are shadow radio state changes, is when
1110 * masked-off hotkeys are used.
1111 */
1112
1113/*
1114 * Internal driver API for radio state:
1115 *
1116 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1117 * bool: true means radio blocked (off)
1118 */
1119enum tpacpi_rfkill_state {
1120 TPACPI_RFK_RADIO_OFF = 0,
1121 TPACPI_RFK_RADIO_ON
1122};
1123
1124/* rfkill switches */
1125enum tpacpi_rfk_id {
1126 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1127 TPACPI_RFK_WWAN_SW_ID,
1128 TPACPI_RFK_UWB_SW_ID,
1129 TPACPI_RFK_SW_MAX
1130};
1131
1132static const char *tpacpi_rfkill_names[] = {
1133 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1134 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1135 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1136 [TPACPI_RFK_SW_MAX] = NULL
1137};
1138
1139/* ThinkPad-ACPI rfkill subdriver */
1140struct tpacpi_rfk {
1141 struct rfkill *rfkill;
1142 enum tpacpi_rfk_id id;
1143 const struct tpacpi_rfk_ops *ops;
1144};
1145
1146struct tpacpi_rfk_ops {
1147 /* firmware interface */
1148 int (*get_status)(void);
1149 int (*set_status)(const enum tpacpi_rfkill_state);
1150};
1151
1152static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1153
1154/* Query FW and update rfkill sw state for a given rfkill switch */
1155static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1156{
1157 int status;
1158
1159 if (!tp_rfk)
1160 return -ENODEV;
1161
1162 status = (tp_rfk->ops->get_status)();
1163 if (status < 0)
1164 return status;
1165
1166 rfkill_set_sw_state(tp_rfk->rfkill,
1167 (status == TPACPI_RFK_RADIO_OFF));
1168
1169 return status;
1170}
1171
1172/* Query FW and update rfkill sw state for all rfkill switches */
1173static void tpacpi_rfk_update_swstate_all(void)
1174{
1175 unsigned int i;
1176
1177 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1178 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1179}
1180
1181/*
1182 * Sync the HW-blocking state of all rfkill switches,
1183 * do notice it causes the rfkill core to schedule uevents
1184 */
1185static void tpacpi_rfk_update_hwblock_state(bool blocked)
1186{
1187 unsigned int i;
1188 struct tpacpi_rfk *tp_rfk;
1189
1190 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1191 tp_rfk = tpacpi_rfkill_switches[i];
1192 if (tp_rfk) {
1193 if (rfkill_set_hw_state(tp_rfk->rfkill,
1194 blocked)) {
1195 /* ignore -- we track sw block */
1196 }
1197 }
1198 }
1199}
1200
1201/* Call to get the WLSW state from the firmware */
1202static int hotkey_get_wlsw(void);
1203
1204/* Call to query WLSW state and update all rfkill switches */
1205static bool tpacpi_rfk_check_hwblock_state(void)
1206{
1207 int res = hotkey_get_wlsw();
1208 int hw_blocked;
1209
1210 /* When unknown or unsupported, we have to assume it is unblocked */
1211 if (res < 0)
1212 return false;
1213
1214 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1215 tpacpi_rfk_update_hwblock_state(hw_blocked);
1216
1217 return hw_blocked;
1218}
1219
1220static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1221{
1222 struct tpacpi_rfk *tp_rfk = data;
1223 int res;
1224
1225 dbg_printk(TPACPI_DBG_RFKILL,
1226 "request to change radio state to %s\n",
1227 blocked ? "blocked" : "unblocked");
1228
1229 /* try to set radio state */
1230 res = (tp_rfk->ops->set_status)(blocked ?
1231 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1232
1233 /* and update the rfkill core with whatever the FW really did */
1234 tpacpi_rfk_update_swstate(tp_rfk);
1235
1236 return (res < 0) ? res : 0;
1237}
1238
1239static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1240 .set_block = tpacpi_rfk_hook_set_block,
1241};
1242
1243static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1244 const struct tpacpi_rfk_ops *tp_rfkops,
1245 const enum rfkill_type rfktype,
1246 const char *name,
1247 const bool set_default)
1248{
1249 struct tpacpi_rfk *atp_rfk;
1250 int res;
1251 bool sw_state = false;
1252 bool hw_state;
1253 int sw_status;
1254
1255 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1256
1257 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1258 if (atp_rfk)
1259 atp_rfk->rfkill = rfkill_alloc(name,
1260 &tpacpi_pdev->dev,
1261 rfktype,
1262 &tpacpi_rfk_rfkill_ops,
1263 atp_rfk);
1264 if (!atp_rfk || !atp_rfk->rfkill) {
1265 pr_err("failed to allocate memory for rfkill class\n");
1266 kfree(atp_rfk);
1267 return -ENOMEM;
1268 }
1269
1270 atp_rfk->id = id;
1271 atp_rfk->ops = tp_rfkops;
1272
1273 sw_status = (tp_rfkops->get_status)();
1274 if (sw_status < 0) {
1275 pr_err("failed to read initial state for %s, error %d\n",
1276 name, sw_status);
1277 } else {
1278 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1279 if (set_default) {
1280 /* try to keep the initial state, since we ask the
1281 * firmware to preserve it across S5 in NVRAM */
1282 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1283 }
1284 }
1285 hw_state = tpacpi_rfk_check_hwblock_state();
1286 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1287
1288 res = rfkill_register(atp_rfk->rfkill);
1289 if (res < 0) {
1290 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1291 rfkill_destroy(atp_rfk->rfkill);
1292 kfree(atp_rfk);
1293 return res;
1294 }
1295
1296 tpacpi_rfkill_switches[id] = atp_rfk;
1297
1298 pr_info("rfkill switch %s: radio is %sblocked\n",
1299 name, (sw_state || hw_state) ? "" : "un");
1300 return 0;
1301}
1302
1303static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1304{
1305 struct tpacpi_rfk *tp_rfk;
1306
1307 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1308
1309 tp_rfk = tpacpi_rfkill_switches[id];
1310 if (tp_rfk) {
1311 rfkill_unregister(tp_rfk->rfkill);
1312 rfkill_destroy(tp_rfk->rfkill);
1313 tpacpi_rfkill_switches[id] = NULL;
1314 kfree(tp_rfk);
1315 }
1316}
1317
1318static void printk_deprecated_rfkill_attribute(const char * const what)
1319{
1320 printk_deprecated_attribute(what,
1321 "Please switch to generic rfkill before year 2010");
1322}
1323
1324/* sysfs <radio> enable ------------------------------------------------ */
1325static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1326 struct device_attribute *attr,
1327 char *buf)
1328{
1329 int status;
1330
1331 printk_deprecated_rfkill_attribute(attr->attr.name);
1332
1333 /* This is in the ABI... */
1334 if (tpacpi_rfk_check_hwblock_state()) {
1335 status = TPACPI_RFK_RADIO_OFF;
1336 } else {
1337 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1338 if (status < 0)
1339 return status;
1340 }
1341
1342 return snprintf(buf, PAGE_SIZE, "%d\n",
1343 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1344}
1345
1346static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1347 struct device_attribute *attr,
1348 const char *buf, size_t count)
1349{
1350 unsigned long t;
1351 int res;
1352
1353 printk_deprecated_rfkill_attribute(attr->attr.name);
1354
1355 if (parse_strtoul(buf, 1, &t))
1356 return -EINVAL;
1357
1358 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1359
1360 /* This is in the ABI... */
1361 if (tpacpi_rfk_check_hwblock_state() && !!t)
1362 return -EPERM;
1363
1364 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1365 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1366 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1367
1368 return (res < 0) ? res : count;
1369}
1370
1371/* procfs -------------------------------------------------------------- */
1372static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1373{
1374 if (id >= TPACPI_RFK_SW_MAX)
1375 seq_printf(m, "status:\t\tnot supported\n");
1376 else {
1377 int status;
1378
1379 /* This is in the ABI... */
1380 if (tpacpi_rfk_check_hwblock_state()) {
1381 status = TPACPI_RFK_RADIO_OFF;
1382 } else {
1383 status = tpacpi_rfk_update_swstate(
1384 tpacpi_rfkill_switches[id]);
1385 if (status < 0)
1386 return status;
1387 }
1388
1389 seq_printf(m, "status:\t\t%s\n",
1390 (status == TPACPI_RFK_RADIO_ON) ?
1391 "enabled" : "disabled");
1392 seq_printf(m, "commands:\tenable, disable\n");
1393 }
1394
1395 return 0;
1396}
1397
1398static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1399{
1400 char *cmd;
1401 int status = -1;
1402 int res = 0;
1403
1404 if (id >= TPACPI_RFK_SW_MAX)
1405 return -ENODEV;
1406
1407 while ((cmd = next_cmd(&buf))) {
1408 if (strlencmp(cmd, "enable") == 0)
1409 status = TPACPI_RFK_RADIO_ON;
1410 else if (strlencmp(cmd, "disable") == 0)
1411 status = TPACPI_RFK_RADIO_OFF;
1412 else
1413 return -EINVAL;
1414 }
1415
1416 if (status != -1) {
1417 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1418 (status == TPACPI_RFK_RADIO_ON) ?
1419 "enable" : "disable",
1420 tpacpi_rfkill_names[id]);
1421 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1422 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1423 }
1424
1425 return res;
1426}
1427
1428/*************************************************************************
1429 * thinkpad-acpi driver attributes
1430 */
1431
1432/* interface_version --------------------------------------------------- */
1433static ssize_t tpacpi_driver_interface_version_show(
1434 struct device_driver *drv,
1435 char *buf)
1436{
1437 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1438}
1439
1440static DRIVER_ATTR(interface_version, S_IRUGO,
1441 tpacpi_driver_interface_version_show, NULL);
1442
1443/* debug_level --------------------------------------------------------- */
1444static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1445 char *buf)
1446{
1447 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1448}
1449
1450static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1451 const char *buf, size_t count)
1452{
1453 unsigned long t;
1454
1455 if (parse_strtoul(buf, 0xffff, &t))
1456 return -EINVAL;
1457
1458 dbg_level = t;
1459
1460 return count;
1461}
1462
1463static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1464 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1465
1466/* version ------------------------------------------------------------- */
1467static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1468 char *buf)
1469{
1470 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1471 TPACPI_DESC, TPACPI_VERSION);
1472}
1473
1474static DRIVER_ATTR(version, S_IRUGO,
1475 tpacpi_driver_version_show, NULL);
1476
1477/* --------------------------------------------------------------------- */
1478
1479#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1480
1481/* wlsw_emulstate ------------------------------------------------------ */
1482static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1483 char *buf)
1484{
1485 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1486}
1487
1488static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1489 const char *buf, size_t count)
1490{
1491 unsigned long t;
1492
1493 if (parse_strtoul(buf, 1, &t))
1494 return -EINVAL;
1495
1496 if (tpacpi_wlsw_emulstate != !!t) {
1497 tpacpi_wlsw_emulstate = !!t;
1498 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1499 }
1500
1501 return count;
1502}
1503
1504static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1505 tpacpi_driver_wlsw_emulstate_show,
1506 tpacpi_driver_wlsw_emulstate_store);
1507
1508/* bluetooth_emulstate ------------------------------------------------- */
1509static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1510 struct device_driver *drv,
1511 char *buf)
1512{
1513 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1514}
1515
1516static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1517 struct device_driver *drv,
1518 const char *buf, size_t count)
1519{
1520 unsigned long t;
1521
1522 if (parse_strtoul(buf, 1, &t))
1523 return -EINVAL;
1524
1525 tpacpi_bluetooth_emulstate = !!t;
1526
1527 return count;
1528}
1529
1530static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1531 tpacpi_driver_bluetooth_emulstate_show,
1532 tpacpi_driver_bluetooth_emulstate_store);
1533
1534/* wwan_emulstate ------------------------------------------------- */
1535static ssize_t tpacpi_driver_wwan_emulstate_show(
1536 struct device_driver *drv,
1537 char *buf)
1538{
1539 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1540}
1541
1542static ssize_t tpacpi_driver_wwan_emulstate_store(
1543 struct device_driver *drv,
1544 const char *buf, size_t count)
1545{
1546 unsigned long t;
1547
1548 if (parse_strtoul(buf, 1, &t))
1549 return -EINVAL;
1550
1551 tpacpi_wwan_emulstate = !!t;
1552
1553 return count;
1554}
1555
1556static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1557 tpacpi_driver_wwan_emulstate_show,
1558 tpacpi_driver_wwan_emulstate_store);
1559
1560/* uwb_emulstate ------------------------------------------------- */
1561static ssize_t tpacpi_driver_uwb_emulstate_show(
1562 struct device_driver *drv,
1563 char *buf)
1564{
1565 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1566}
1567
1568static ssize_t tpacpi_driver_uwb_emulstate_store(
1569 struct device_driver *drv,
1570 const char *buf, size_t count)
1571{
1572 unsigned long t;
1573
1574 if (parse_strtoul(buf, 1, &t))
1575 return -EINVAL;
1576
1577 tpacpi_uwb_emulstate = !!t;
1578
1579 return count;
1580}
1581
1582static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1583 tpacpi_driver_uwb_emulstate_show,
1584 tpacpi_driver_uwb_emulstate_store);
1585#endif
1586
1587/* --------------------------------------------------------------------- */
1588
1589static struct driver_attribute *tpacpi_driver_attributes[] = {
1590 &driver_attr_debug_level, &driver_attr_version,
1591 &driver_attr_interface_version,
1592};
1593
1594static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1595{
1596 int i, res;
1597
1598 i = 0;
1599 res = 0;
1600 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1601 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1602 i++;
1603 }
1604
1605#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1606 if (!res && dbg_wlswemul)
1607 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1608 if (!res && dbg_bluetoothemul)
1609 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1610 if (!res && dbg_wwanemul)
1611 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1612 if (!res && dbg_uwbemul)
1613 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1614#endif
1615
1616 return res;
1617}
1618
1619static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1620{
1621 int i;
1622
1623 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1624 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1625
1626#ifdef THINKPAD_ACPI_DEBUGFACILITIES
1627 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1628 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1629 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1630 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1631#endif
1632}
1633
1634/*************************************************************************
1635 * Firmware Data
1636 */
1637
1638/*
1639 * Table of recommended minimum BIOS versions
1640 *
1641 * Reasons for listing:
1642 * 1. Stable BIOS, listed because the unknown amount of
1643 * bugs and bad ACPI behaviour on older versions
1644 *
1645 * 2. BIOS or EC fw with known bugs that trigger on Linux
1646 *
1647 * 3. BIOS with known reduced functionality in older versions
1648 *
1649 * We recommend the latest BIOS and EC version.
1650 * We only support the latest BIOS and EC fw version as a rule.
1651 *
1652 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1653 * Information from users in ThinkWiki
1654 *
1655 * WARNING: we use this table also to detect that the machine is
1656 * a ThinkPad in some cases, so don't remove entries lightly.
1657 */
1658
1659#define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1660 { .vendor = (__v), \
1661 .bios = TPID(__id1, __id2), \
1662 .ec = TPACPI_MATCH_ANY, \
1663 .quirks = TPACPI_MATCH_ANY << 16 \
1664 | (__bv1) << 8 | (__bv2) }
1665
1666#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1667 __eid, __ev1, __ev2) \
1668 { .vendor = (__v), \
1669 .bios = TPID(__bid1, __bid2), \
1670 .ec = __eid, \
1671 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1672 | (__bv1) << 8 | (__bv2) }
1673
1674#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1675 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1676
1677/* Outdated IBM BIOSes often lack the EC id string */
1678#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1679 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1680 __bv1, __bv2, TPID(__id1, __id2), \
1681 __ev1, __ev2), \
1682 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1683 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1684 __ev1, __ev2)
1685
1686/* Outdated IBM BIOSes often lack the EC id string */
1687#define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1688 __eid1, __eid2, __ev1, __ev2) \
1689 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1690 __bv1, __bv2, TPID(__eid1, __eid2), \
1691 __ev1, __ev2), \
1692 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1693 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1694 __ev1, __ev2)
1695
1696#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1697 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1698
1699#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1700 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1701 __bv1, __bv2, TPID(__id1, __id2), \
1702 __ev1, __ev2)
1703
1704#define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1705 __eid1, __eid2, __ev1, __ev2) \
1706 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1707 __bv1, __bv2, TPID(__eid1, __eid2), \
1708 __ev1, __ev2)
1709
1710static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1711 /* Numeric models ------------------ */
1712 /* FW MODEL BIOS VERS */
1713 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1714 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1715 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1716 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1717 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1718 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1719 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1720 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1721 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1722
1723 /* A-series ------------------------- */
1724 /* FW MODEL BIOS VERS EC VERS */
1725 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1726 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1727 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1728 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1729 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1730 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1731 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1732 TPV_QI0('1', '3', '2', '0'), /* A22m */
1733 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1734 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1735 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1736
1737 /* G-series ------------------------- */
1738 /* FW MODEL BIOS VERS */
1739 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1740 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1741
1742 /* R-series, T-series --------------- */
1743 /* FW MODEL BIOS VERS EC VERS */
1744 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1745 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1746 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1747 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1748 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1749 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1750 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1751 T40/p, T41/p, T42/p (1) */
1752 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1753 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1754 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1755 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1756
1757 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1758 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1759 TPV_QI0('1', '6', '3', '2'), /* T22 */
1760 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1761 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1762 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1763
1764 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1765 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1766 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1767
1768 /* BIOS FW BIOS VERS EC FW EC VERS */
1769 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1770 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1771
1772 /* X-series ------------------------- */
1773 /* FW MODEL BIOS VERS EC VERS */
1774 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1775 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1776 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1777 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1778 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1779 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1780 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1781
1782 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1783 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1784
1785 /* (0) - older versions lack DMI EC fw string and functionality */
1786 /* (1) - older versions known to lack functionality */
1787};
1788
1789#undef TPV_QL1
1790#undef TPV_QL0
1791#undef TPV_QI2
1792#undef TPV_QI1
1793#undef TPV_QI0
1794#undef TPV_Q_X
1795#undef TPV_Q
1796
1797static void __init tpacpi_check_outdated_fw(void)
1798{
1799 unsigned long fwvers;
1800 u16 ec_version, bios_version;
1801
1802 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1803 ARRAY_SIZE(tpacpi_bios_version_qtable));
1804
1805 if (!fwvers)
1806 return;
1807
1808 bios_version = fwvers & 0xffffU;
1809 ec_version = (fwvers >> 16) & 0xffffU;
1810
1811 /* note that unknown versions are set to 0x0000 and we use that */
1812 if ((bios_version > thinkpad_id.bios_release) ||
1813 (ec_version > thinkpad_id.ec_release &&
1814 ec_version != TPACPI_MATCH_ANY)) {
1815 /*
1816 * The changelogs would let us track down the exact
1817 * reason, but it is just too much of a pain to track
1818 * it. We only list BIOSes that are either really
1819 * broken, or really stable to begin with, so it is
1820 * best if the user upgrades the firmware anyway.
1821 */
1822 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1823 pr_warn("WARNING: This firmware may be missing critical bug "
1824 "fixes and/or important features\n");
1825 }
1826}
1827
1828static bool __init tpacpi_is_fw_known(void)
1829{
1830 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1831 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1832}
1833
1834/****************************************************************************
1835 ****************************************************************************
1836 *
1837 * Subdrivers
1838 *
1839 ****************************************************************************
1840 ****************************************************************************/
1841
1842/*************************************************************************
1843 * thinkpad-acpi metadata subdriver
1844 */
1845
1846static int thinkpad_acpi_driver_read(struct seq_file *m)
1847{
1848 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1849 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1850 return 0;
1851}
1852
1853static struct ibm_struct thinkpad_acpi_driver_data = {
1854 .name = "driver",
1855 .read = thinkpad_acpi_driver_read,
1856};
1857
1858/*************************************************************************
1859 * Hotkey subdriver
1860 */
1861
1862/*
1863 * ThinkPad firmware event model
1864 *
1865 * The ThinkPad firmware has two main event interfaces: normal ACPI
1866 * notifications (which follow the ACPI standard), and a private event
1867 * interface.
1868 *
1869 * The private event interface also issues events for the hotkeys. As
1870 * the driver gained features, the event handling code ended up being
1871 * built around the hotkey subdriver. This will need to be refactored
1872 * to a more formal event API eventually.
1873 *
1874 * Some "hotkeys" are actually supposed to be used as event reports,
1875 * such as "brightness has changed", "volume has changed", depending on
1876 * the ThinkPad model and how the firmware is operating.
1877 *
1878 * Unlike other classes, hotkey-class events have mask/unmask control on
1879 * non-ancient firmware. However, how it behaves changes a lot with the
1880 * firmware model and version.
1881 */
1882
1883enum { /* hot key scan codes (derived from ACPI DSDT) */
1884 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1885 TP_ACPI_HOTKEYSCAN_FNF2,
1886 TP_ACPI_HOTKEYSCAN_FNF3,
1887 TP_ACPI_HOTKEYSCAN_FNF4,
1888 TP_ACPI_HOTKEYSCAN_FNF5,
1889 TP_ACPI_HOTKEYSCAN_FNF6,
1890 TP_ACPI_HOTKEYSCAN_FNF7,
1891 TP_ACPI_HOTKEYSCAN_FNF8,
1892 TP_ACPI_HOTKEYSCAN_FNF9,
1893 TP_ACPI_HOTKEYSCAN_FNF10,
1894 TP_ACPI_HOTKEYSCAN_FNF11,
1895 TP_ACPI_HOTKEYSCAN_FNF12,
1896 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1897 TP_ACPI_HOTKEYSCAN_FNINSERT,
1898 TP_ACPI_HOTKEYSCAN_FNDELETE,
1899 TP_ACPI_HOTKEYSCAN_FNHOME,
1900 TP_ACPI_HOTKEYSCAN_FNEND,
1901 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1902 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1903 TP_ACPI_HOTKEYSCAN_FNSPACE,
1904 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1905 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1906 TP_ACPI_HOTKEYSCAN_MUTE,
1907 TP_ACPI_HOTKEYSCAN_THINKPAD,
1908 TP_ACPI_HOTKEYSCAN_UNK1,
1909 TP_ACPI_HOTKEYSCAN_UNK2,
1910 TP_ACPI_HOTKEYSCAN_UNK3,
1911 TP_ACPI_HOTKEYSCAN_UNK4,
1912 TP_ACPI_HOTKEYSCAN_UNK5,
1913 TP_ACPI_HOTKEYSCAN_UNK6,
1914 TP_ACPI_HOTKEYSCAN_UNK7,
1915 TP_ACPI_HOTKEYSCAN_UNK8,
1916
1917 TP_ACPI_HOTKEYSCAN_MUTE2,
1918 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1919 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1920 TP_ACPI_HOTKEYSCAN_CLOUD,
1921 TP_ACPI_HOTKEYSCAN_UNK9,
1922 TP_ACPI_HOTKEYSCAN_VOICE,
1923 TP_ACPI_HOTKEYSCAN_UNK10,
1924 TP_ACPI_HOTKEYSCAN_GESTURES,
1925 TP_ACPI_HOTKEYSCAN_UNK11,
1926 TP_ACPI_HOTKEYSCAN_UNK12,
1927 TP_ACPI_HOTKEYSCAN_UNK13,
1928 TP_ACPI_HOTKEYSCAN_CONFIG,
1929 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1930 TP_ACPI_HOTKEYSCAN_RELOAD,
1931 TP_ACPI_HOTKEYSCAN_BACK,
1932 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1933 TP_ACPI_HOTKEYSCAN_MIC_UP,
1934 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1935 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1936 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1937
1938 /* Hotkey keymap size */
1939 TPACPI_HOTKEY_MAP_LEN
1940};
1941
1942enum { /* Keys/events available through NVRAM polling */
1943 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1944 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1945};
1946
1947enum { /* Positions of some of the keys in hotkey masks */
1948 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1949 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1950 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1951 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1952 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1953 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1954 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1955 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1956 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1957 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1958 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1959};
1960
1961enum { /* NVRAM to ACPI HKEY group map */
1962 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1963 TP_ACPI_HKEY_ZOOM_MASK |
1964 TP_ACPI_HKEY_DISPSWTCH_MASK |
1965 TP_ACPI_HKEY_HIBERNATE_MASK,
1966 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1967 TP_ACPI_HKEY_BRGHTDWN_MASK,
1968 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1969 TP_ACPI_HKEY_VOLDWN_MASK |
1970 TP_ACPI_HKEY_MUTE_MASK,
1971};
1972
1973#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1974struct tp_nvram_state {
1975 u16 thinkpad_toggle:1;
1976 u16 zoom_toggle:1;
1977 u16 display_toggle:1;
1978 u16 thinklight_toggle:1;
1979 u16 hibernate_toggle:1;
1980 u16 displayexp_toggle:1;
1981 u16 display_state:1;
1982 u16 brightness_toggle:1;
1983 u16 volume_toggle:1;
1984 u16 mute:1;
1985
1986 u8 brightness_level;
1987 u8 volume_level;
1988};
1989
1990/* kthread for the hotkey poller */
1991static struct task_struct *tpacpi_hotkey_task;
1992
1993/*
1994 * Acquire mutex to write poller control variables as an
1995 * atomic block.
1996 *
1997 * Increment hotkey_config_change when changing them if you
1998 * want the kthread to forget old state.
1999 *
2000 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2001 */
2002static struct mutex hotkey_thread_data_mutex;
2003static unsigned int hotkey_config_change;
2004
2005/*
2006 * hotkey poller control variables
2007 *
2008 * Must be atomic or readers will also need to acquire mutex
2009 *
2010 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2011 * should be used only when the changes need to be taken as
2012 * a block, OR when one needs to force the kthread to forget
2013 * old state.
2014 */
2015static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2016static unsigned int hotkey_poll_freq = 10; /* Hz */
2017
2018#define HOTKEY_CONFIG_CRITICAL_START \
2019 do { \
2020 mutex_lock(&hotkey_thread_data_mutex); \
2021 hotkey_config_change++; \
2022 } while (0);
2023#define HOTKEY_CONFIG_CRITICAL_END \
2024 mutex_unlock(&hotkey_thread_data_mutex);
2025
2026#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2027
2028#define hotkey_source_mask 0U
2029#define HOTKEY_CONFIG_CRITICAL_START
2030#define HOTKEY_CONFIG_CRITICAL_END
2031
2032#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2033
2034static struct mutex hotkey_mutex;
2035
2036static enum { /* Reasons for waking up */
2037 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2038 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2039 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2040} hotkey_wakeup_reason;
2041
2042static int hotkey_autosleep_ack;
2043
2044static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2045static u32 hotkey_all_mask; /* all events supported in fw */
2046static u32 hotkey_reserved_mask; /* events better left disabled */
2047static u32 hotkey_driver_mask; /* events needed by the driver */
2048static u32 hotkey_user_mask; /* events visible to userspace */
2049static u32 hotkey_acpi_mask; /* events enabled in firmware */
2050
2051static u16 *hotkey_keycode_map;
2052
2053static struct attribute_set *hotkey_dev_attributes;
2054
2055static void tpacpi_driver_event(const unsigned int hkey_event);
2056static void hotkey_driver_event(const unsigned int scancode);
2057static void hotkey_poll_setup(const bool may_warn);
2058
2059/* HKEY.MHKG() return bits */
2060#define TP_HOTKEY_TABLET_MASK (1 << 3)
2061
2062static int hotkey_get_wlsw(void)
2063{
2064 int status;
2065
2066 if (!tp_features.hotkey_wlsw)
2067 return -ENODEV;
2068
2069#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2070 if (dbg_wlswemul)
2071 return (tpacpi_wlsw_emulstate) ?
2072 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2073#endif
2074
2075 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2076 return -EIO;
2077
2078 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2079}
2080
2081static int hotkey_get_tablet_mode(int *status)
2082{
2083 int s;
2084
2085 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2086 return -EIO;
2087
2088 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2089 return 0;
2090}
2091
2092/*
2093 * Reads current event mask from firmware, and updates
2094 * hotkey_acpi_mask accordingly. Also resets any bits
2095 * from hotkey_user_mask that are unavailable to be
2096 * delivered (shadow requirement of the userspace ABI).
2097 *
2098 * Call with hotkey_mutex held
2099 */
2100static int hotkey_mask_get(void)
2101{
2102 if (tp_features.hotkey_mask) {
2103 u32 m = 0;
2104
2105 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2106 return -EIO;
2107
2108 hotkey_acpi_mask = m;
2109 } else {
2110 /* no mask support doesn't mean no event support... */
2111 hotkey_acpi_mask = hotkey_all_mask;
2112 }
2113
2114 /* sync userspace-visible mask */
2115 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2116
2117 return 0;
2118}
2119
2120static void hotkey_mask_warn_incomplete_mask(void)
2121{
2122 /* log only what the user can fix... */
2123 const u32 wantedmask = hotkey_driver_mask &
2124 ~(hotkey_acpi_mask | hotkey_source_mask) &
2125 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2126
2127 if (wantedmask)
2128 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2129}
2130
2131/*
2132 * Set the firmware mask when supported
2133 *
2134 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2135 *
2136 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2137 *
2138 * Call with hotkey_mutex held
2139 */
2140static int hotkey_mask_set(u32 mask)
2141{
2142 int i;
2143 int rc = 0;
2144
2145 const u32 fwmask = mask & ~hotkey_source_mask;
2146
2147 if (tp_features.hotkey_mask) {
2148 for (i = 0; i < 32; i++) {
2149 if (!acpi_evalf(hkey_handle,
2150 NULL, "MHKM", "vdd", i + 1,
2151 !!(mask & (1 << i)))) {
2152 rc = -EIO;
2153 break;
2154 }
2155 }
2156 }
2157
2158 /*
2159 * We *must* make an inconditional call to hotkey_mask_get to
2160 * refresh hotkey_acpi_mask and update hotkey_user_mask
2161 *
2162 * Take the opportunity to also log when we cannot _enable_
2163 * a given event.
2164 */
2165 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2166 pr_notice("asked for hotkey mask 0x%08x, but "
2167 "firmware forced it to 0x%08x\n",
2168 fwmask, hotkey_acpi_mask);
2169 }
2170
2171 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2172 hotkey_mask_warn_incomplete_mask();
2173
2174 return rc;
2175}
2176
2177/*
2178 * Sets hotkey_user_mask and tries to set the firmware mask
2179 *
2180 * Call with hotkey_mutex held
2181 */
2182static int hotkey_user_mask_set(const u32 mask)
2183{
2184 int rc;
2185
2186 /* Give people a chance to notice they are doing something that
2187 * is bound to go boom on their users sooner or later */
2188 if (!tp_warned.hotkey_mask_ff &&
2189 (mask == 0xffff || mask == 0xffffff ||
2190 mask == 0xffffffff)) {
2191 tp_warned.hotkey_mask_ff = 1;
2192 pr_notice("setting the hotkey mask to 0x%08x is likely "
2193 "not the best way to go about it\n", mask);
2194 pr_notice("please consider using the driver defaults, "
2195 "and refer to up-to-date thinkpad-acpi "
2196 "documentation\n");
2197 }
2198
2199 /* Try to enable what the user asked for, plus whatever we need.
2200 * this syncs everything but won't enable bits in hotkey_user_mask */
2201 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2202
2203 /* Enable the available bits in hotkey_user_mask */
2204 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2205
2206 return rc;
2207}
2208
2209/*
2210 * Sets the driver hotkey mask.
2211 *
2212 * Can be called even if the hotkey subdriver is inactive
2213 */
2214static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2215{
2216 int rc;
2217
2218 /* Do the right thing if hotkey_init has not been called yet */
2219 if (!tp_features.hotkey) {
2220 hotkey_driver_mask = mask;
2221 return 0;
2222 }
2223
2224 mutex_lock(&hotkey_mutex);
2225
2226 HOTKEY_CONFIG_CRITICAL_START
2227 hotkey_driver_mask = mask;
2228#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2229 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2230#endif
2231 HOTKEY_CONFIG_CRITICAL_END
2232
2233 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2234 ~hotkey_source_mask);
2235 hotkey_poll_setup(true);
2236
2237 mutex_unlock(&hotkey_mutex);
2238
2239 return rc;
2240}
2241
2242static int hotkey_status_get(int *status)
2243{
2244 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2245 return -EIO;
2246
2247 return 0;
2248}
2249
2250static int hotkey_status_set(bool enable)
2251{
2252 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2253 return -EIO;
2254
2255 return 0;
2256}
2257
2258static void tpacpi_input_send_tabletsw(void)
2259{
2260 int state;
2261
2262 if (tp_features.hotkey_tablet &&
2263 !hotkey_get_tablet_mode(&state)) {
2264 mutex_lock(&tpacpi_inputdev_send_mutex);
2265
2266 input_report_switch(tpacpi_inputdev,
2267 SW_TABLET_MODE, !!state);
2268 input_sync(tpacpi_inputdev);
2269
2270 mutex_unlock(&tpacpi_inputdev_send_mutex);
2271 }
2272}
2273
2274/* Do NOT call without validating scancode first */
2275static void tpacpi_input_send_key(const unsigned int scancode)
2276{
2277 const unsigned int keycode = hotkey_keycode_map[scancode];
2278
2279 if (keycode != KEY_RESERVED) {
2280 mutex_lock(&tpacpi_inputdev_send_mutex);
2281
2282 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2283 input_report_key(tpacpi_inputdev, keycode, 1);
2284 input_sync(tpacpi_inputdev);
2285
2286 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2287 input_report_key(tpacpi_inputdev, keycode, 0);
2288 input_sync(tpacpi_inputdev);
2289
2290 mutex_unlock(&tpacpi_inputdev_send_mutex);
2291 }
2292}
2293
2294/* Do NOT call without validating scancode first */
2295static void tpacpi_input_send_key_masked(const unsigned int scancode)
2296{
2297 hotkey_driver_event(scancode);
2298 if (hotkey_user_mask & (1 << scancode))
2299 tpacpi_input_send_key(scancode);
2300}
2301
2302#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2303static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2304
2305/* Do NOT call without validating scancode first */
2306static void tpacpi_hotkey_send_key(unsigned int scancode)
2307{
2308 tpacpi_input_send_key_masked(scancode);
2309}
2310
2311static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2312{
2313 u8 d;
2314
2315 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2316 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2317 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2318 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2319 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2320 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2321 }
2322 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2323 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2324 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2325 }
2326 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2327 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2328 n->displayexp_toggle =
2329 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2330 }
2331 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2332 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2333 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2334 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2335 n->brightness_toggle =
2336 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2337 }
2338 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2339 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2340 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2341 >> TP_NVRAM_POS_LEVEL_VOLUME;
2342 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2343 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2344 }
2345}
2346
2347#define TPACPI_COMPARE_KEY(__scancode, __member) \
2348do { \
2349 if ((event_mask & (1 << __scancode)) && \
2350 oldn->__member != newn->__member) \
2351 tpacpi_hotkey_send_key(__scancode); \
2352} while (0)
2353
2354#define TPACPI_MAY_SEND_KEY(__scancode) \
2355do { \
2356 if (event_mask & (1 << __scancode)) \
2357 tpacpi_hotkey_send_key(__scancode); \
2358} while (0)
2359
2360static void issue_volchange(const unsigned int oldvol,
2361 const unsigned int newvol,
2362 const u32 event_mask)
2363{
2364 unsigned int i = oldvol;
2365
2366 while (i > newvol) {
2367 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2368 i--;
2369 }
2370 while (i < newvol) {
2371 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2372 i++;
2373 }
2374}
2375
2376static void issue_brightnesschange(const unsigned int oldbrt,
2377 const unsigned int newbrt,
2378 const u32 event_mask)
2379{
2380 unsigned int i = oldbrt;
2381
2382 while (i > newbrt) {
2383 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2384 i--;
2385 }
2386 while (i < newbrt) {
2387 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2388 i++;
2389 }
2390}
2391
2392static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2393 struct tp_nvram_state *newn,
2394 const u32 event_mask)
2395{
2396
2397 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2398 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2399 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2400 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2401
2402 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2403
2404 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2405
2406 /*
2407 * Handle volume
2408 *
2409 * This code is supposed to duplicate the IBM firmware behaviour:
2410 * - Pressing MUTE issues mute hotkey message, even when already mute
2411 * - Pressing Volume up/down issues volume up/down hotkey messages,
2412 * even when already at maximum or minimum volume
2413 * - The act of unmuting issues volume up/down notification,
2414 * depending which key was used to unmute
2415 *
2416 * We are constrained to what the NVRAM can tell us, which is not much
2417 * and certainly not enough if more than one volume hotkey was pressed
2418 * since the last poll cycle.
2419 *
2420 * Just to make our life interesting, some newer Lenovo ThinkPads have
2421 * bugs in the BIOS and may fail to update volume_toggle properly.
2422 */
2423 if (newn->mute) {
2424 /* muted */
2425 if (!oldn->mute ||
2426 oldn->volume_toggle != newn->volume_toggle ||
2427 oldn->volume_level != newn->volume_level) {
2428 /* recently muted, or repeated mute keypress, or
2429 * multiple presses ending in mute */
2430 issue_volchange(oldn->volume_level, newn->volume_level,
2431 event_mask);
2432 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2433 }
2434 } else {
2435 /* unmute */
2436 if (oldn->mute) {
2437 /* recently unmuted, issue 'unmute' keypress */
2438 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2439 }
2440 if (oldn->volume_level != newn->volume_level) {
2441 issue_volchange(oldn->volume_level, newn->volume_level,
2442 event_mask);
2443 } else if (oldn->volume_toggle != newn->volume_toggle) {
2444 /* repeated vol up/down keypress at end of scale ? */
2445 if (newn->volume_level == 0)
2446 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2447 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2448 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2449 }
2450 }
2451
2452 /* handle brightness */
2453 if (oldn->brightness_level != newn->brightness_level) {
2454 issue_brightnesschange(oldn->brightness_level,
2455 newn->brightness_level, event_mask);
2456 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2457 /* repeated key presses that didn't change state */
2458 if (newn->brightness_level == 0)
2459 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2460 else if (newn->brightness_level >= bright_maxlvl
2461 && !tp_features.bright_unkfw)
2462 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2463 }
2464
2465#undef TPACPI_COMPARE_KEY
2466#undef TPACPI_MAY_SEND_KEY
2467}
2468
2469/*
2470 * Polling driver
2471 *
2472 * We track all events in hotkey_source_mask all the time, since
2473 * most of them are edge-based. We only issue those requested by
2474 * hotkey_user_mask or hotkey_driver_mask, though.
2475 */
2476static int hotkey_kthread(void *data)
2477{
2478 struct tp_nvram_state s[2];
2479 u32 poll_mask, event_mask;
2480 unsigned int si, so;
2481 unsigned long t;
2482 unsigned int change_detector;
2483 unsigned int poll_freq;
2484 bool was_frozen;
2485
2486 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2487 goto exit;
2488
2489 set_freezable();
2490
2491 so = 0;
2492 si = 1;
2493 t = 0;
2494
2495 /* Initial state for compares */
2496 mutex_lock(&hotkey_thread_data_mutex);
2497 change_detector = hotkey_config_change;
2498 poll_mask = hotkey_source_mask;
2499 event_mask = hotkey_source_mask &
2500 (hotkey_driver_mask | hotkey_user_mask);
2501 poll_freq = hotkey_poll_freq;
2502 mutex_unlock(&hotkey_thread_data_mutex);
2503 hotkey_read_nvram(&s[so], poll_mask);
2504
2505 while (!kthread_should_stop()) {
2506 if (t == 0) {
2507 if (likely(poll_freq))
2508 t = 1000/poll_freq;
2509 else
2510 t = 100; /* should never happen... */
2511 }
2512 t = msleep_interruptible(t);
2513 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2514 break;
2515
2516 if (t > 0 && !was_frozen)
2517 continue;
2518
2519 mutex_lock(&hotkey_thread_data_mutex);
2520 if (was_frozen || hotkey_config_change != change_detector) {
2521 /* forget old state on thaw or config change */
2522 si = so;
2523 t = 0;
2524 change_detector = hotkey_config_change;
2525 }
2526 poll_mask = hotkey_source_mask;
2527 event_mask = hotkey_source_mask &
2528 (hotkey_driver_mask | hotkey_user_mask);
2529 poll_freq = hotkey_poll_freq;
2530 mutex_unlock(&hotkey_thread_data_mutex);
2531
2532 if (likely(poll_mask)) {
2533 hotkey_read_nvram(&s[si], poll_mask);
2534 if (likely(si != so)) {
2535 hotkey_compare_and_issue_event(&s[so], &s[si],
2536 event_mask);
2537 }
2538 }
2539
2540 so = si;
2541 si ^= 1;
2542 }
2543
2544exit:
2545 return 0;
2546}
2547
2548/* call with hotkey_mutex held */
2549static void hotkey_poll_stop_sync(void)
2550{
2551 if (tpacpi_hotkey_task) {
2552 kthread_stop(tpacpi_hotkey_task);
2553 tpacpi_hotkey_task = NULL;
2554 }
2555}
2556
2557/* call with hotkey_mutex held */
2558static void hotkey_poll_setup(const bool may_warn)
2559{
2560 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2561 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2562
2563 if (hotkey_poll_freq > 0 &&
2564 (poll_driver_mask ||
2565 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2566 if (!tpacpi_hotkey_task) {
2567 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2568 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2569 if (IS_ERR(tpacpi_hotkey_task)) {
2570 tpacpi_hotkey_task = NULL;
2571 pr_err("could not create kernel thread "
2572 "for hotkey polling\n");
2573 }
2574 }
2575 } else {
2576 hotkey_poll_stop_sync();
2577 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2578 hotkey_poll_freq == 0) {
2579 pr_notice("hot keys 0x%08x and/or events 0x%08x "
2580 "require polling, which is currently "
2581 "disabled\n",
2582 poll_user_mask, poll_driver_mask);
2583 }
2584 }
2585}
2586
2587static void hotkey_poll_setup_safe(const bool may_warn)
2588{
2589 mutex_lock(&hotkey_mutex);
2590 hotkey_poll_setup(may_warn);
2591 mutex_unlock(&hotkey_mutex);
2592}
2593
2594/* call with hotkey_mutex held */
2595static void hotkey_poll_set_freq(unsigned int freq)
2596{
2597 if (!freq)
2598 hotkey_poll_stop_sync();
2599
2600 hotkey_poll_freq = freq;
2601}
2602
2603#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2604
2605static void hotkey_poll_setup(const bool __unused)
2606{
2607}
2608
2609static void hotkey_poll_setup_safe(const bool __unused)
2610{
2611}
2612
2613#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2614
2615static int hotkey_inputdev_open(struct input_dev *dev)
2616{
2617 switch (tpacpi_lifecycle) {
2618 case TPACPI_LIFE_INIT:
2619 case TPACPI_LIFE_RUNNING:
2620 hotkey_poll_setup_safe(false);
2621 return 0;
2622 case TPACPI_LIFE_EXITING:
2623 return -EBUSY;
2624 }
2625
2626 /* Should only happen if tpacpi_lifecycle is corrupt */
2627 BUG();
2628 return -EBUSY;
2629}
2630
2631static void hotkey_inputdev_close(struct input_dev *dev)
2632{
2633 /* disable hotkey polling when possible */
2634 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2635 !(hotkey_source_mask & hotkey_driver_mask))
2636 hotkey_poll_setup_safe(false);
2637}
2638
2639/* sysfs hotkey enable ------------------------------------------------- */
2640static ssize_t hotkey_enable_show(struct device *dev,
2641 struct device_attribute *attr,
2642 char *buf)
2643{
2644 int res, status;
2645
2646 printk_deprecated_attribute("hotkey_enable",
2647 "Hotkey reporting is always enabled");
2648
2649 res = hotkey_status_get(&status);
2650 if (res)
2651 return res;
2652
2653 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2654}
2655
2656static ssize_t hotkey_enable_store(struct device *dev,
2657 struct device_attribute *attr,
2658 const char *buf, size_t count)
2659{
2660 unsigned long t;
2661
2662 printk_deprecated_attribute("hotkey_enable",
2663 "Hotkeys can be disabled through hotkey_mask");
2664
2665 if (parse_strtoul(buf, 1, &t))
2666 return -EINVAL;
2667
2668 if (t == 0)
2669 return -EPERM;
2670
2671 return count;
2672}
2673
2674static DEVICE_ATTR_RW(hotkey_enable);
2675
2676/* sysfs hotkey mask --------------------------------------------------- */
2677static ssize_t hotkey_mask_show(struct device *dev,
2678 struct device_attribute *attr,
2679 char *buf)
2680{
2681 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2682}
2683
2684static ssize_t hotkey_mask_store(struct device *dev,
2685 struct device_attribute *attr,
2686 const char *buf, size_t count)
2687{
2688 unsigned long t;
2689 int res;
2690
2691 if (parse_strtoul(buf, 0xffffffffUL, &t))
2692 return -EINVAL;
2693
2694 if (mutex_lock_killable(&hotkey_mutex))
2695 return -ERESTARTSYS;
2696
2697 res = hotkey_user_mask_set(t);
2698
2699#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2700 hotkey_poll_setup(true);
2701#endif
2702
2703 mutex_unlock(&hotkey_mutex);
2704
2705 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2706
2707 return (res) ? res : count;
2708}
2709
2710static DEVICE_ATTR_RW(hotkey_mask);
2711
2712/* sysfs hotkey bios_enabled ------------------------------------------- */
2713static ssize_t hotkey_bios_enabled_show(struct device *dev,
2714 struct device_attribute *attr,
2715 char *buf)
2716{
2717 return sprintf(buf, "0\n");
2718}
2719
2720static DEVICE_ATTR_RO(hotkey_bios_enabled);
2721
2722/* sysfs hotkey bios_mask ---------------------------------------------- */
2723static ssize_t hotkey_bios_mask_show(struct device *dev,
2724 struct device_attribute *attr,
2725 char *buf)
2726{
2727 printk_deprecated_attribute("hotkey_bios_mask",
2728 "This attribute is useless.");
2729 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2730}
2731
2732static DEVICE_ATTR_RO(hotkey_bios_mask);
2733
2734/* sysfs hotkey all_mask ----------------------------------------------- */
2735static ssize_t hotkey_all_mask_show(struct device *dev,
2736 struct device_attribute *attr,
2737 char *buf)
2738{
2739 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2740 hotkey_all_mask | hotkey_source_mask);
2741}
2742
2743static DEVICE_ATTR_RO(hotkey_all_mask);
2744
2745/* sysfs hotkey recommended_mask --------------------------------------- */
2746static ssize_t hotkey_recommended_mask_show(struct device *dev,
2747 struct device_attribute *attr,
2748 char *buf)
2749{
2750 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2751 (hotkey_all_mask | hotkey_source_mask)
2752 & ~hotkey_reserved_mask);
2753}
2754
2755static DEVICE_ATTR_RO(hotkey_recommended_mask);
2756
2757#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2758
2759/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2760static ssize_t hotkey_source_mask_show(struct device *dev,
2761 struct device_attribute *attr,
2762 char *buf)
2763{
2764 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2765}
2766
2767static ssize_t hotkey_source_mask_store(struct device *dev,
2768 struct device_attribute *attr,
2769 const char *buf, size_t count)
2770{
2771 unsigned long t;
2772 u32 r_ev;
2773 int rc;
2774
2775 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2776 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2777 return -EINVAL;
2778
2779 if (mutex_lock_killable(&hotkey_mutex))
2780 return -ERESTARTSYS;
2781
2782 HOTKEY_CONFIG_CRITICAL_START
2783 hotkey_source_mask = t;
2784 HOTKEY_CONFIG_CRITICAL_END
2785
2786 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2787 ~hotkey_source_mask);
2788 hotkey_poll_setup(true);
2789
2790 /* check if events needed by the driver got disabled */
2791 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2792 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2793
2794 mutex_unlock(&hotkey_mutex);
2795
2796 if (rc < 0)
2797 pr_err("hotkey_source_mask: "
2798 "failed to update the firmware event mask!\n");
2799
2800 if (r_ev)
2801 pr_notice("hotkey_source_mask: "
2802 "some important events were disabled: 0x%04x\n",
2803 r_ev);
2804
2805 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2806
2807 return (rc < 0) ? rc : count;
2808}
2809
2810static DEVICE_ATTR_RW(hotkey_source_mask);
2811
2812/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2813static ssize_t hotkey_poll_freq_show(struct device *dev,
2814 struct device_attribute *attr,
2815 char *buf)
2816{
2817 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2818}
2819
2820static ssize_t hotkey_poll_freq_store(struct device *dev,
2821 struct device_attribute *attr,
2822 const char *buf, size_t count)
2823{
2824 unsigned long t;
2825
2826 if (parse_strtoul(buf, 25, &t))
2827 return -EINVAL;
2828
2829 if (mutex_lock_killable(&hotkey_mutex))
2830 return -ERESTARTSYS;
2831
2832 hotkey_poll_set_freq(t);
2833 hotkey_poll_setup(true);
2834
2835 mutex_unlock(&hotkey_mutex);
2836
2837 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2838
2839 return count;
2840}
2841
2842static DEVICE_ATTR_RW(hotkey_poll_freq);
2843
2844#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2845
2846/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2847static ssize_t hotkey_radio_sw_show(struct device *dev,
2848 struct device_attribute *attr,
2849 char *buf)
2850{
2851 int res;
2852 res = hotkey_get_wlsw();
2853 if (res < 0)
2854 return res;
2855
2856 /* Opportunistic update */
2857 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2858
2859 return snprintf(buf, PAGE_SIZE, "%d\n",
2860 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2861}
2862
2863static DEVICE_ATTR_RO(hotkey_radio_sw);
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 DEVICE_ATTR_RO(hotkey_tablet_mode);
2886
2887static void hotkey_tablet_mode_notify_change(void)
2888{
2889 if (tp_features.hotkey_tablet)
2890 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2891 "hotkey_tablet_mode");
2892}
2893
2894/* sysfs wakeup reason (pollable) -------------------------------------- */
2895static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2896 struct device_attribute *attr,
2897 char *buf)
2898{
2899 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2900}
2901
2902static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2903
2904static void hotkey_wakeup_reason_notify_change(void)
2905{
2906 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2907 "wakeup_reason");
2908}
2909
2910/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2911static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2912 struct device_attribute *attr,
2913 char *buf)
2914{
2915 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2916}
2917
2918static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
2919 hotkey_wakeup_hotunplug_complete_show, NULL);
2920
2921static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2922{
2923 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2924 "wakeup_hotunplug_complete");
2925}
2926
2927/* sysfs adaptive kbd mode --------------------------------------------- */
2928
2929static int adaptive_keyboard_get_mode(void);
2930static int adaptive_keyboard_set_mode(int new_mode);
2931
2932enum ADAPTIVE_KEY_MODE {
2933 HOME_MODE,
2934 WEB_BROWSER_MODE,
2935 WEB_CONFERENCE_MODE,
2936 FUNCTION_MODE,
2937 LAYFLAT_MODE
2938};
2939
2940static ssize_t adaptive_kbd_mode_show(struct device *dev,
2941 struct device_attribute *attr,
2942 char *buf)
2943{
2944 int current_mode;
2945
2946 current_mode = adaptive_keyboard_get_mode();
2947 if (current_mode < 0)
2948 return current_mode;
2949
2950 return snprintf(buf, PAGE_SIZE, "%d\n", current_mode);
2951}
2952
2953static ssize_t adaptive_kbd_mode_store(struct device *dev,
2954 struct device_attribute *attr,
2955 const char *buf, size_t count)
2956{
2957 unsigned long t;
2958 int res;
2959
2960 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
2961 return -EINVAL;
2962
2963 res = adaptive_keyboard_set_mode(t);
2964 return (res < 0) ? res : count;
2965}
2966
2967static DEVICE_ATTR_RW(adaptive_kbd_mode);
2968
2969static struct attribute *adaptive_kbd_attributes[] = {
2970 &dev_attr_adaptive_kbd_mode.attr,
2971 NULL
2972};
2973
2974static const struct attribute_group adaptive_kbd_attr_group = {
2975 .attrs = adaptive_kbd_attributes,
2976};
2977
2978/* --------------------------------------------------------------------- */
2979
2980static struct attribute *hotkey_attributes[] __initdata = {
2981 &dev_attr_hotkey_enable.attr,
2982 &dev_attr_hotkey_bios_enabled.attr,
2983 &dev_attr_hotkey_bios_mask.attr,
2984 &dev_attr_wakeup_reason.attr,
2985 &dev_attr_wakeup_hotunplug_complete.attr,
2986 &dev_attr_hotkey_mask.attr,
2987 &dev_attr_hotkey_all_mask.attr,
2988 &dev_attr_hotkey_recommended_mask.attr,
2989#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2990 &dev_attr_hotkey_source_mask.attr,
2991 &dev_attr_hotkey_poll_freq.attr,
2992#endif
2993};
2994
2995/*
2996 * Sync both the hw and sw blocking state of all switches
2997 */
2998static void tpacpi_send_radiosw_update(void)
2999{
3000 int wlsw;
3001
3002 /*
3003 * We must sync all rfkill controllers *before* issuing any
3004 * rfkill input events, or we will race the rfkill core input
3005 * handler.
3006 *
3007 * tpacpi_inputdev_send_mutex works as a synchronization point
3008 * for the above.
3009 *
3010 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3011 */
3012
3013 wlsw = hotkey_get_wlsw();
3014
3015 /* Sync hw blocking state first if it is hw-blocked */
3016 if (wlsw == TPACPI_RFK_RADIO_OFF)
3017 tpacpi_rfk_update_hwblock_state(true);
3018
3019 /* Sync sw blocking state */
3020 tpacpi_rfk_update_swstate_all();
3021
3022 /* Sync hw blocking state last if it is hw-unblocked */
3023 if (wlsw == TPACPI_RFK_RADIO_ON)
3024 tpacpi_rfk_update_hwblock_state(false);
3025
3026 /* Issue rfkill input event for WLSW switch */
3027 if (!(wlsw < 0)) {
3028 mutex_lock(&tpacpi_inputdev_send_mutex);
3029
3030 input_report_switch(tpacpi_inputdev,
3031 SW_RFKILL_ALL, (wlsw > 0));
3032 input_sync(tpacpi_inputdev);
3033
3034 mutex_unlock(&tpacpi_inputdev_send_mutex);
3035 }
3036
3037 /*
3038 * this can be unconditional, as we will poll state again
3039 * if userspace uses the notify to read data
3040 */
3041 hotkey_radio_sw_notify_change();
3042}
3043
3044static void hotkey_exit(void)
3045{
3046#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3047 mutex_lock(&hotkey_mutex);
3048 hotkey_poll_stop_sync();
3049 mutex_unlock(&hotkey_mutex);
3050#endif
3051
3052 if (hotkey_dev_attributes)
3053 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3054
3055 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3056 "restoring original HKEY status and mask\n");
3057 /* yes, there is a bitwise or below, we want the
3058 * functions to be called even if one of them fail */
3059 if (((tp_features.hotkey_mask &&
3060 hotkey_mask_set(hotkey_orig_mask)) |
3061 hotkey_status_set(false)) != 0)
3062 pr_err("failed to restore hot key mask "
3063 "to BIOS defaults\n");
3064}
3065
3066static void __init hotkey_unmap(const unsigned int scancode)
3067{
3068 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3069 clear_bit(hotkey_keycode_map[scancode],
3070 tpacpi_inputdev->keybit);
3071 hotkey_keycode_map[scancode] = KEY_RESERVED;
3072 }
3073}
3074
3075/*
3076 * HKEY quirks:
3077 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3078 */
3079
3080#define TPACPI_HK_Q_INIMASK 0x0001
3081
3082static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3083 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3084 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3085 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3086 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3087 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3088 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3089 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3090 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3091 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3092 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3093 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3094 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3095 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3096 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3097 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3098 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3099 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3100 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3101 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3102};
3103
3104typedef u16 tpacpi_keymap_entry_t;
3105typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3106
3107static int __init hotkey_init(struct ibm_init_struct *iibm)
3108{
3109 /* Requirements for changing the default keymaps:
3110 *
3111 * 1. Many of the keys are mapped to KEY_RESERVED for very
3112 * good reasons. Do not change them unless you have deep
3113 * knowledge on the IBM and Lenovo ThinkPad firmware for
3114 * the various ThinkPad models. The driver behaves
3115 * differently for KEY_RESERVED: such keys have their
3116 * hot key mask *unset* in mask_recommended, and also
3117 * in the initial hot key mask programmed into the
3118 * firmware at driver load time, which means the firm-
3119 * ware may react very differently if you change them to
3120 * something else;
3121 *
3122 * 2. You must be subscribed to the linux-thinkpad and
3123 * ibm-acpi-devel mailing lists, and you should read the
3124 * list archives since 2007 if you want to change the
3125 * keymaps. This requirement exists so that you will
3126 * know the past history of problems with the thinkpad-
3127 * acpi driver keymaps, and also that you will be
3128 * listening to any bug reports;
3129 *
3130 * 3. Do not send thinkpad-acpi specific patches directly to
3131 * for merging, *ever*. Send them to the linux-acpi
3132 * mailinglist for comments. Merging is to be done only
3133 * through acpi-test and the ACPI maintainer.
3134 *
3135 * If the above is too much to ask, don't change the keymap.
3136 * Ask the thinkpad-acpi maintainer to do it, instead.
3137 */
3138
3139 enum keymap_index {
3140 TPACPI_KEYMAP_IBM_GENERIC = 0,
3141 TPACPI_KEYMAP_LENOVO_GENERIC,
3142 };
3143
3144 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3145 /* Generic keymap for IBM ThinkPads */
3146 [TPACPI_KEYMAP_IBM_GENERIC] = {
3147 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3148 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3149 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3150 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3151
3152 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3153 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3154 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3155 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3156
3157 /* brightness: firmware always reacts to them */
3158 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3159 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3160
3161 /* Thinklight: firmware always react to it */
3162 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3163
3164 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3165 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3166
3167 /* Volume: firmware always react to it and reprograms
3168 * the built-in *extra* mixer. Never map it to control
3169 * another mixer by default. */
3170 KEY_RESERVED, /* 0x14: VOLUME UP */
3171 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3172 KEY_RESERVED, /* 0x16: MUTE */
3173
3174 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3175
3176 /* (assignments unknown, please report if found) */
3177 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3178 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3179
3180 /* No assignments, only used for Adaptive keyboards. */
3181 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3182 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3183 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3184 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3185 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3186 },
3187
3188 /* Generic keymap for Lenovo ThinkPads */
3189 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3190 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3191 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3192 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3193 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3194
3195 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3196 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3197 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3198 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3199
3200 /* These should be enabled --only-- when ACPI video
3201 * is disabled (i.e. in "vendor" mode), and are handled
3202 * in a special way by the init code */
3203 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3204 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3205
3206 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3207
3208 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3209 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3210
3211 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3212 * react to it and reprograms the built-in *extra* mixer.
3213 * Never map it to control another mixer by default.
3214 *
3215 * T60?, T61, R60?, R61: firmware and EC tries to send
3216 * these over the regular keyboard, so these are no-ops,
3217 * but there are still weird bugs re. MUTE, so do not
3218 * change unless you get test reports from all Lenovo
3219 * models. May cause the BIOS to interfere with the
3220 * HDA mixer.
3221 */
3222 KEY_RESERVED, /* 0x14: VOLUME UP */
3223 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3224 KEY_RESERVED, /* 0x16: MUTE */
3225
3226 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3227
3228 /* (assignments unknown, please report if found) */
3229 KEY_UNKNOWN, KEY_UNKNOWN,
3230
3231 /*
3232 * The mic mute button only sends 0x1a. It does not
3233 * automatically mute the mic or change the mute light.
3234 */
3235 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3236
3237 /* (assignments unknown, please report if found) */
3238 KEY_UNKNOWN,
3239
3240 /* Extra keys in use since the X240 / T440 / T540 */
3241 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3242
3243 /*
3244 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3245 * The first item in this list is the Mute button which is
3246 * emitted with 0x103 through
3247 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3248 * symbol is held.
3249 * We'll need to offset those by 0x20.
3250 */
3251 KEY_RESERVED, /* Mute held, 0x103 */
3252 KEY_BRIGHTNESS_MIN, /* Backlight off */
3253 KEY_RESERVED, /* Clipping tool */
3254 KEY_RESERVED, /* Cloud */
3255 KEY_RESERVED,
3256 KEY_VOICECOMMAND, /* Voice */
3257 KEY_RESERVED,
3258 KEY_RESERVED, /* Gestures */
3259 KEY_RESERVED,
3260 KEY_RESERVED,
3261 KEY_RESERVED,
3262 KEY_CONFIG, /* Settings */
3263 KEY_RESERVED, /* New tab */
3264 KEY_REFRESH, /* Reload */
3265 KEY_BACK, /* Back */
3266 KEY_RESERVED, /* Microphone down */
3267 KEY_RESERVED, /* Microphone up */
3268 KEY_RESERVED, /* Microphone cancellation */
3269 KEY_RESERVED, /* Camera mode */
3270 KEY_RESERVED, /* Rotate display, 0x116 */
3271 },
3272 };
3273
3274 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3275 /* Generic maps (fallback) */
3276 {
3277 .vendor = PCI_VENDOR_ID_IBM,
3278 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3279 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3280 },
3281 {
3282 .vendor = PCI_VENDOR_ID_LENOVO,
3283 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3284 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3285 },
3286 };
3287
3288#define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3289#define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3290
3291 int res, i;
3292 int status;
3293 int hkeyv;
3294 bool radiosw_state = false;
3295 bool tabletsw_state = false;
3296
3297 unsigned long quirks;
3298 unsigned long keymap_id;
3299
3300 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3301 "initializing hotkey subdriver\n");
3302
3303 BUG_ON(!tpacpi_inputdev);
3304 BUG_ON(tpacpi_inputdev->open != NULL ||
3305 tpacpi_inputdev->close != NULL);
3306
3307 TPACPI_ACPIHANDLE_INIT(hkey);
3308 mutex_init(&hotkey_mutex);
3309
3310#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3311 mutex_init(&hotkey_thread_data_mutex);
3312#endif
3313
3314 /* hotkey not supported on 570 */
3315 tp_features.hotkey = hkey_handle != NULL;
3316
3317 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3318 "hotkeys are %s\n",
3319 str_supported(tp_features.hotkey));
3320
3321 if (!tp_features.hotkey)
3322 return 1;
3323
3324 /*
3325 * Check if we have an adaptive keyboard, like on the
3326 * Lenovo Carbon X1 2014 (2nd Gen).
3327 */
3328 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3329 if ((hkeyv >> 8) == 2) {
3330 tp_features.has_adaptive_kbd = true;
3331 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
3332 &adaptive_kbd_attr_group);
3333 if (res)
3334 goto err_exit;
3335 }
3336 }
3337
3338 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3339 ARRAY_SIZE(tpacpi_hotkey_qtable));
3340
3341 tpacpi_disable_brightness_delay();
3342
3343 /* MUST have enough space for all attributes to be added to
3344 * hotkey_dev_attributes */
3345 hotkey_dev_attributes = create_attr_set(
3346 ARRAY_SIZE(hotkey_attributes) + 2,
3347 NULL);
3348 if (!hotkey_dev_attributes)
3349 return -ENOMEM;
3350 res = add_many_to_attr_set(hotkey_dev_attributes,
3351 hotkey_attributes,
3352 ARRAY_SIZE(hotkey_attributes));
3353 if (res)
3354 goto err_exit;
3355
3356 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3357 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3358 for HKEY interface version 0x100 */
3359 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3360 if ((hkeyv >> 8) != 1) {
3361 pr_err("unknown version of the HKEY interface: 0x%x\n",
3362 hkeyv);
3363 pr_err("please report this to %s\n", TPACPI_MAIL);
3364 } else {
3365 /*
3366 * MHKV 0x100 in A31, R40, R40e,
3367 * T4x, X31, and later
3368 */
3369 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3370 "firmware HKEY interface version: 0x%x\n",
3371 hkeyv);
3372
3373 /* Paranoia check AND init hotkey_all_mask */
3374 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3375 "MHKA", "qd")) {
3376 pr_err("missing MHKA handler, "
3377 "please report this to %s\n",
3378 TPACPI_MAIL);
3379 /* Fallback: pre-init for FN+F3,F4,F12 */
3380 hotkey_all_mask = 0x080cU;
3381 } else {
3382 tp_features.hotkey_mask = 1;
3383 }
3384 }
3385 }
3386
3387 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3388 "hotkey masks are %s\n",
3389 str_supported(tp_features.hotkey_mask));
3390
3391 /* Init hotkey_all_mask if not initialized yet */
3392 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3393 (quirks & TPACPI_HK_Q_INIMASK))
3394 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3395
3396 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3397 if (tp_features.hotkey_mask) {
3398 /* hotkey_source_mask *must* be zero for
3399 * the first hotkey_mask_get to return hotkey_orig_mask */
3400 res = hotkey_mask_get();
3401 if (res)
3402 goto err_exit;
3403
3404 hotkey_orig_mask = hotkey_acpi_mask;
3405 } else {
3406 hotkey_orig_mask = hotkey_all_mask;
3407 hotkey_acpi_mask = hotkey_all_mask;
3408 }
3409
3410#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3411 if (dbg_wlswemul) {
3412 tp_features.hotkey_wlsw = 1;
3413 radiosw_state = !!tpacpi_wlsw_emulstate;
3414 pr_info("radio switch emulation enabled\n");
3415 } else
3416#endif
3417 /* Not all thinkpads have a hardware radio switch */
3418 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3419 tp_features.hotkey_wlsw = 1;
3420 radiosw_state = !!status;
3421 pr_info("radio switch found; radios are %s\n",
3422 enabled(status, 0));
3423 }
3424 if (tp_features.hotkey_wlsw)
3425 res = add_to_attr_set(hotkey_dev_attributes,
3426 &dev_attr_hotkey_radio_sw.attr);
3427
3428 /* For X41t, X60t, X61t Tablets... */
3429 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3430 tp_features.hotkey_tablet = 1;
3431 tabletsw_state = !!(status & TP_HOTKEY_TABLET_MASK);
3432 pr_info("possible tablet mode switch found; "
3433 "ThinkPad in %s mode\n",
3434 (tabletsw_state) ? "tablet" : "laptop");
3435 res = add_to_attr_set(hotkey_dev_attributes,
3436 &dev_attr_hotkey_tablet_mode.attr);
3437 }
3438
3439 if (!res)
3440 res = register_attr_set_with_sysfs(
3441 hotkey_dev_attributes,
3442 &tpacpi_pdev->dev.kobj);
3443 if (res)
3444 goto err_exit;
3445
3446 /* Set up key map */
3447 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3448 GFP_KERNEL);
3449 if (!hotkey_keycode_map) {
3450 pr_err("failed to allocate memory for key map\n");
3451 res = -ENOMEM;
3452 goto err_exit;
3453 }
3454
3455 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3456 ARRAY_SIZE(tpacpi_keymap_qtable));
3457 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3458 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3459 "using keymap number %lu\n", keymap_id);
3460
3461 memcpy(hotkey_keycode_map, &tpacpi_keymaps[keymap_id],
3462 TPACPI_HOTKEY_MAP_SIZE);
3463
3464 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3465 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3466 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3467 tpacpi_inputdev->keycode = hotkey_keycode_map;
3468 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3469 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3470 input_set_capability(tpacpi_inputdev, EV_KEY,
3471 hotkey_keycode_map[i]);
3472 } else {
3473 if (i < sizeof(hotkey_reserved_mask)*8)
3474 hotkey_reserved_mask |= 1 << i;
3475 }
3476 }
3477
3478 if (tp_features.hotkey_wlsw) {
3479 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3480 input_report_switch(tpacpi_inputdev,
3481 SW_RFKILL_ALL, radiosw_state);
3482 }
3483 if (tp_features.hotkey_tablet) {
3484 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3485 input_report_switch(tpacpi_inputdev,
3486 SW_TABLET_MODE, tabletsw_state);
3487 }
3488
3489 /* Do not issue duplicate brightness change events to
3490 * userspace. tpacpi_detect_brightness_capabilities() must have
3491 * been called before this point */
3492 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3493 pr_info("This ThinkPad has standard ACPI backlight "
3494 "brightness control, supported by the ACPI "
3495 "video driver\n");
3496 pr_notice("Disabling thinkpad-acpi brightness events "
3497 "by default...\n");
3498
3499 /* Disable brightness up/down on Lenovo thinkpads when
3500 * ACPI is handling them, otherwise it is plain impossible
3501 * for userspace to do something even remotely sane */
3502 hotkey_reserved_mask |=
3503 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3504 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3505 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3506 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3507 }
3508
3509#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3510 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3511 & ~hotkey_all_mask
3512 & ~hotkey_reserved_mask;
3513
3514 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3515 "hotkey source mask 0x%08x, polling freq %u\n",
3516 hotkey_source_mask, hotkey_poll_freq);
3517#endif
3518
3519 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3520 "enabling firmware HKEY event interface...\n");
3521 res = hotkey_status_set(true);
3522 if (res) {
3523 hotkey_exit();
3524 return res;
3525 }
3526 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3527 | hotkey_driver_mask)
3528 & ~hotkey_source_mask);
3529 if (res < 0 && res != -ENXIO) {
3530 hotkey_exit();
3531 return res;
3532 }
3533 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3534 & ~hotkey_reserved_mask;
3535 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3536 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3537 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3538
3539 tpacpi_inputdev->open = &hotkey_inputdev_open;
3540 tpacpi_inputdev->close = &hotkey_inputdev_close;
3541
3542 hotkey_poll_setup_safe(true);
3543
3544 return 0;
3545
3546err_exit:
3547 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3548 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3549 &adaptive_kbd_attr_group);
3550
3551 hotkey_dev_attributes = NULL;
3552
3553 return (res < 0) ? res : 1;
3554}
3555
3556/* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3557 * mode, Web conference mode, Function mode and Lay-flat mode.
3558 * We support Home mode and Function mode currently.
3559 *
3560 * Will consider support rest of modes in future.
3561 *
3562 */
3563static const int adaptive_keyboard_modes[] = {
3564 HOME_MODE,
3565/* WEB_BROWSER_MODE = 2,
3566 WEB_CONFERENCE_MODE = 3, */
3567 FUNCTION_MODE
3568};
3569
3570#define DFR_CHANGE_ROW 0x101
3571#define DFR_SHOW_QUICKVIEW_ROW 0x102
3572#define FIRST_ADAPTIVE_KEY 0x103
3573#define ADAPTIVE_KEY_OFFSET 0x020
3574
3575/* press Fn key a while second, it will switch to Function Mode. Then
3576 * release Fn key, previous mode be restored.
3577 */
3578static bool adaptive_keyboard_mode_is_saved;
3579static int adaptive_keyboard_prev_mode;
3580
3581static int adaptive_keyboard_get_mode(void)
3582{
3583 int mode = 0;
3584
3585 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3586 pr_err("Cannot read adaptive keyboard mode\n");
3587 return -EIO;
3588 }
3589
3590 return mode;
3591}
3592
3593static int adaptive_keyboard_set_mode(int new_mode)
3594{
3595 if (new_mode < 0 ||
3596 new_mode > LAYFLAT_MODE)
3597 return -EINVAL;
3598
3599 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3600 pr_err("Cannot set adaptive keyboard mode\n");
3601 return -EIO;
3602 }
3603
3604 return 0;
3605}
3606
3607static int adaptive_keyboard_get_next_mode(int mode)
3608{
3609 size_t i;
3610 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3611
3612 for (i = 0; i <= max_mode; i++) {
3613 if (adaptive_keyboard_modes[i] == mode)
3614 break;
3615 }
3616
3617 if (i >= max_mode)
3618 i = 0;
3619 else
3620 i++;
3621
3622 return adaptive_keyboard_modes[i];
3623}
3624
3625static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3626{
3627 int current_mode = 0;
3628 int new_mode = 0;
3629 int keycode;
3630
3631 switch (scancode) {
3632 case DFR_CHANGE_ROW:
3633 if (adaptive_keyboard_mode_is_saved) {
3634 new_mode = adaptive_keyboard_prev_mode;
3635 adaptive_keyboard_mode_is_saved = false;
3636 } else {
3637 current_mode = adaptive_keyboard_get_mode();
3638 if (current_mode < 0)
3639 return false;
3640 new_mode = adaptive_keyboard_get_next_mode(
3641 current_mode);
3642 }
3643
3644 if (adaptive_keyboard_set_mode(new_mode) < 0)
3645 return false;
3646
3647 return true;
3648
3649 case DFR_SHOW_QUICKVIEW_ROW:
3650 current_mode = adaptive_keyboard_get_mode();
3651 if (current_mode < 0)
3652 return false;
3653
3654 adaptive_keyboard_prev_mode = current_mode;
3655 adaptive_keyboard_mode_is_saved = true;
3656
3657 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3658 return false;
3659 return true;
3660
3661 default:
3662 if (scancode < FIRST_ADAPTIVE_KEY ||
3663 scancode >= FIRST_ADAPTIVE_KEY + TPACPI_HOTKEY_MAP_LEN -
3664 ADAPTIVE_KEY_OFFSET) {
3665 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3666 scancode);
3667 return false;
3668 }
3669 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY + ADAPTIVE_KEY_OFFSET];
3670 if (keycode != KEY_RESERVED) {
3671 mutex_lock(&tpacpi_inputdev_send_mutex);
3672
3673 input_report_key(tpacpi_inputdev, keycode, 1);
3674 input_sync(tpacpi_inputdev);
3675
3676 input_report_key(tpacpi_inputdev, keycode, 0);
3677 input_sync(tpacpi_inputdev);
3678
3679 mutex_unlock(&tpacpi_inputdev_send_mutex);
3680 }
3681 return true;
3682 }
3683}
3684
3685static bool hotkey_notify_hotkey(const u32 hkey,
3686 bool *send_acpi_ev,
3687 bool *ignore_acpi_ev)
3688{
3689 /* 0x1000-0x1FFF: key presses */
3690 unsigned int scancode = hkey & 0xfff;
3691 *send_acpi_ev = true;
3692 *ignore_acpi_ev = false;
3693
3694 /* HKEY event 0x1001 is scancode 0x00 */
3695 if (scancode > 0 && scancode <= TPACPI_HOTKEY_MAP_LEN) {
3696 scancode--;
3697 if (!(hotkey_source_mask & (1 << scancode))) {
3698 tpacpi_input_send_key_masked(scancode);
3699 *send_acpi_ev = false;
3700 } else {
3701 *ignore_acpi_ev = true;
3702 }
3703 return true;
3704 } else {
3705 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3706 }
3707 return false;
3708}
3709
3710static bool hotkey_notify_wakeup(const u32 hkey,
3711 bool *send_acpi_ev,
3712 bool *ignore_acpi_ev)
3713{
3714 /* 0x2000-0x2FFF: Wakeup reason */
3715 *send_acpi_ev = true;
3716 *ignore_acpi_ev = false;
3717
3718 switch (hkey) {
3719 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3720 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3721 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3722 *ignore_acpi_ev = true;
3723 break;
3724
3725 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3726 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3727 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3728 *ignore_acpi_ev = true;
3729 break;
3730
3731 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3732 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3733 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3734 /* how to auto-heal: */
3735 /* 2313: woke up from S3, go to S4/S5 */
3736 /* 2413: woke up from S4, go to S5 */
3737 break;
3738
3739 default:
3740 return false;
3741 }
3742
3743 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3744 pr_info("woke up due to a hot-unplug request...\n");
3745 hotkey_wakeup_reason_notify_change();
3746 }
3747 return true;
3748}
3749
3750static bool hotkey_notify_dockevent(const u32 hkey,
3751 bool *send_acpi_ev,
3752 bool *ignore_acpi_ev)
3753{
3754 /* 0x4000-0x4FFF: dock-related events */
3755 *send_acpi_ev = true;
3756 *ignore_acpi_ev = false;
3757
3758 switch (hkey) {
3759 case TP_HKEY_EV_UNDOCK_ACK:
3760 /* ACPI undock operation completed after wakeup */
3761 hotkey_autosleep_ack = 1;
3762 pr_info("undocked\n");
3763 hotkey_wakeup_hotunplug_complete_notify_change();
3764 return true;
3765
3766 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3767 pr_info("docked into hotplug port replicator\n");
3768 return true;
3769 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3770 pr_info("undocked from hotplug port replicator\n");
3771 return true;
3772
3773 default:
3774 return false;
3775 }
3776}
3777
3778static bool hotkey_notify_usrevent(const u32 hkey,
3779 bool *send_acpi_ev,
3780 bool *ignore_acpi_ev)
3781{
3782 /* 0x5000-0x5FFF: human interface helpers */
3783 *send_acpi_ev = true;
3784 *ignore_acpi_ev = false;
3785
3786 switch (hkey) {
3787 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3788 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3789 return true;
3790
3791 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3792 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3793 tpacpi_input_send_tabletsw();
3794 hotkey_tablet_mode_notify_change();
3795 *send_acpi_ev = false;
3796 return true;
3797
3798 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3799 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3800 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3801 /* do not propagate these events */
3802 *ignore_acpi_ev = true;
3803 return true;
3804
3805 default:
3806 return false;
3807 }
3808}
3809
3810static void thermal_dump_all_sensors(void);
3811
3812static bool hotkey_notify_6xxx(const u32 hkey,
3813 bool *send_acpi_ev,
3814 bool *ignore_acpi_ev)
3815{
3816 bool known = true;
3817
3818 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3819 *send_acpi_ev = true;
3820 *ignore_acpi_ev = false;
3821
3822 switch (hkey) {
3823 case TP_HKEY_EV_THM_TABLE_CHANGED:
3824 pr_info("EC reports that Thermal Table has changed\n");
3825 /* recommended action: do nothing, we don't have
3826 * Lenovo ATM information */
3827 return true;
3828 case TP_HKEY_EV_ALARM_BAT_HOT:
3829 pr_crit("THERMAL ALARM: battery is too hot!\n");
3830 /* recommended action: warn user through gui */
3831 break;
3832 case TP_HKEY_EV_ALARM_BAT_XHOT:
3833 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3834 /* recommended action: immediate sleep/hibernate */
3835 break;
3836 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3837 pr_crit("THERMAL ALARM: "
3838 "a sensor reports something is too hot!\n");
3839 /* recommended action: warn user through gui, that */
3840 /* some internal component is too hot */
3841 break;
3842 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3843 pr_alert("THERMAL EMERGENCY: "
3844 "a sensor reports something is extremely hot!\n");
3845 /* recommended action: immediate sleep/hibernate */
3846 break;
3847 case TP_HKEY_EV_AC_CHANGED:
3848 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3849 * AC status changed; can be triggered by plugging or
3850 * unplugging AC adapter, docking or undocking. */
3851
3852 /* fallthrough */
3853
3854 case TP_HKEY_EV_KEY_NUMLOCK:
3855 case TP_HKEY_EV_KEY_FN:
3856 case TP_HKEY_EV_KEY_FN_ESC:
3857 /* key press events, we just ignore them as long as the EC
3858 * is still reporting them in the normal keyboard stream */
3859 *send_acpi_ev = false;
3860 *ignore_acpi_ev = true;
3861 return true;
3862
3863 default:
3864 pr_warn("unknown possible thermal alarm or keyboard event received\n");
3865 known = false;
3866 }
3867
3868 thermal_dump_all_sensors();
3869
3870 return known;
3871}
3872
3873static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3874{
3875 u32 hkey;
3876 bool send_acpi_ev;
3877 bool ignore_acpi_ev;
3878 bool known_ev;
3879
3880 if (event != 0x80) {
3881 pr_err("unknown HKEY notification event %d\n", event);
3882 /* forward it to userspace, maybe it knows how to handle it */
3883 acpi_bus_generate_netlink_event(
3884 ibm->acpi->device->pnp.device_class,
3885 dev_name(&ibm->acpi->device->dev),
3886 event, 0);
3887 return;
3888 }
3889
3890 while (1) {
3891 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3892 pr_err("failed to retrieve HKEY event\n");
3893 return;
3894 }
3895
3896 if (hkey == 0) {
3897 /* queue empty */
3898 return;
3899 }
3900
3901 send_acpi_ev = true;
3902 ignore_acpi_ev = false;
3903
3904 switch (hkey >> 12) {
3905 case 1:
3906 /* 0x1000-0x1FFF: key presses */
3907 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3908 &ignore_acpi_ev);
3909 break;
3910 case 2:
3911 /* 0x2000-0x2FFF: Wakeup reason */
3912 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3913 &ignore_acpi_ev);
3914 break;
3915 case 3:
3916 /* 0x3000-0x3FFF: bay-related wakeups */
3917 switch (hkey) {
3918 case TP_HKEY_EV_BAYEJ_ACK:
3919 hotkey_autosleep_ack = 1;
3920 pr_info("bay ejected\n");
3921 hotkey_wakeup_hotunplug_complete_notify_change();
3922 known_ev = true;
3923 break;
3924 case TP_HKEY_EV_OPTDRV_EJ:
3925 /* FIXME: kick libata if SATA link offline */
3926 known_ev = true;
3927 break;
3928 default:
3929 known_ev = false;
3930 }
3931 break;
3932 case 4:
3933 /* 0x4000-0x4FFF: dock-related events */
3934 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
3935 &ignore_acpi_ev);
3936 break;
3937 case 5:
3938 /* 0x5000-0x5FFF: human interface helpers */
3939 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3940 &ignore_acpi_ev);
3941 break;
3942 case 6:
3943 /* 0x6000-0x6FFF: thermal alarms/notices and
3944 * keyboard events */
3945 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
3946 &ignore_acpi_ev);
3947 break;
3948 case 7:
3949 /* 0x7000-0x7FFF: misc */
3950 if (tp_features.hotkey_wlsw &&
3951 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3952 tpacpi_send_radiosw_update();
3953 send_acpi_ev = 0;
3954 known_ev = true;
3955 break;
3956 }
3957 /* fallthrough to default */
3958 default:
3959 known_ev = false;
3960 }
3961 if (!known_ev) {
3962 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
3963 pr_notice("please report the conditions when this "
3964 "event happened to %s\n", TPACPI_MAIL);
3965 }
3966
3967 /* netlink events */
3968 if (!ignore_acpi_ev && send_acpi_ev) {
3969 acpi_bus_generate_netlink_event(
3970 ibm->acpi->device->pnp.device_class,
3971 dev_name(&ibm->acpi->device->dev),
3972 event, hkey);
3973 }
3974 }
3975}
3976
3977static void hotkey_suspend(void)
3978{
3979 /* Do these on suspend, we get the events on early resume! */
3980 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3981 hotkey_autosleep_ack = 0;
3982
3983 /* save previous mode of adaptive keyboard of X1 Carbon */
3984 if (tp_features.has_adaptive_kbd) {
3985 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
3986 "GTRW", "dd", 0)) {
3987 pr_err("Cannot read adaptive keyboard mode.\n");
3988 }
3989 }
3990}
3991
3992static void hotkey_resume(void)
3993{
3994 tpacpi_disable_brightness_delay();
3995
3996 if (hotkey_status_set(true) < 0 ||
3997 hotkey_mask_set(hotkey_acpi_mask) < 0)
3998 pr_err("error while attempting to reset the event "
3999 "firmware interface\n");
4000
4001 tpacpi_send_radiosw_update();
4002 hotkey_tablet_mode_notify_change();
4003 hotkey_wakeup_reason_notify_change();
4004 hotkey_wakeup_hotunplug_complete_notify_change();
4005 hotkey_poll_setup_safe(false);
4006
4007 /* restore previous mode of adapive keyboard of X1 Carbon */
4008 if (tp_features.has_adaptive_kbd) {
4009 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4010 adaptive_keyboard_prev_mode)) {
4011 pr_err("Cannot set adaptive keyboard mode.\n");
4012 }
4013 }
4014}
4015
4016/* procfs -------------------------------------------------------------- */
4017static int hotkey_read(struct seq_file *m)
4018{
4019 int res, status;
4020
4021 if (!tp_features.hotkey) {
4022 seq_printf(m, "status:\t\tnot supported\n");
4023 return 0;
4024 }
4025
4026 if (mutex_lock_killable(&hotkey_mutex))
4027 return -ERESTARTSYS;
4028 res = hotkey_status_get(&status);
4029 if (!res)
4030 res = hotkey_mask_get();
4031 mutex_unlock(&hotkey_mutex);
4032 if (res)
4033 return res;
4034
4035 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4036 if (hotkey_all_mask) {
4037 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4038 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4039 } else {
4040 seq_printf(m, "mask:\t\tnot supported\n");
4041 seq_printf(m, "commands:\tenable, disable, reset\n");
4042 }
4043
4044 return 0;
4045}
4046
4047static void hotkey_enabledisable_warn(bool enable)
4048{
4049 tpacpi_log_usertask("procfs hotkey enable/disable");
4050 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4051 pr_fmt("hotkey enable/disable functionality has been "
4052 "removed from the driver. "
4053 "Hotkeys are always enabled.\n")))
4054 pr_err("Please remove the hotkey=enable module "
4055 "parameter, it is deprecated. "
4056 "Hotkeys are always enabled.\n");
4057}
4058
4059static int hotkey_write(char *buf)
4060{
4061 int res;
4062 u32 mask;
4063 char *cmd;
4064
4065 if (!tp_features.hotkey)
4066 return -ENODEV;
4067
4068 if (mutex_lock_killable(&hotkey_mutex))
4069 return -ERESTARTSYS;
4070
4071 mask = hotkey_user_mask;
4072
4073 res = 0;
4074 while ((cmd = next_cmd(&buf))) {
4075 if (strlencmp(cmd, "enable") == 0) {
4076 hotkey_enabledisable_warn(1);
4077 } else if (strlencmp(cmd, "disable") == 0) {
4078 hotkey_enabledisable_warn(0);
4079 res = -EPERM;
4080 } else if (strlencmp(cmd, "reset") == 0) {
4081 mask = (hotkey_all_mask | hotkey_source_mask)
4082 & ~hotkey_reserved_mask;
4083 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4084 /* mask set */
4085 } else if (sscanf(cmd, "%x", &mask) == 1) {
4086 /* mask set */
4087 } else {
4088 res = -EINVAL;
4089 goto errexit;
4090 }
4091 }
4092
4093 if (!res) {
4094 tpacpi_disclose_usertask("procfs hotkey",
4095 "set mask to 0x%08x\n", mask);
4096 res = hotkey_user_mask_set(mask);
4097 }
4098
4099errexit:
4100 mutex_unlock(&hotkey_mutex);
4101 return res;
4102}
4103
4104static const struct acpi_device_id ibm_htk_device_ids[] = {
4105 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4106 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4107 {"", 0},
4108};
4109
4110static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4111 .hid = ibm_htk_device_ids,
4112 .notify = hotkey_notify,
4113 .handle = &hkey_handle,
4114 .type = ACPI_DEVICE_NOTIFY,
4115};
4116
4117static struct ibm_struct hotkey_driver_data = {
4118 .name = "hotkey",
4119 .read = hotkey_read,
4120 .write = hotkey_write,
4121 .exit = hotkey_exit,
4122 .resume = hotkey_resume,
4123 .suspend = hotkey_suspend,
4124 .acpi = &ibm_hotkey_acpidriver,
4125};
4126
4127/*************************************************************************
4128 * Bluetooth subdriver
4129 */
4130
4131enum {
4132 /* ACPI GBDC/SBDC bits */
4133 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4134 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4135 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4136 0 = disable, 1 = enable */
4137};
4138
4139enum {
4140 /* ACPI \BLTH commands */
4141 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4142 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4143 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4144 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4145 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4146};
4147
4148#define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4149
4150static int bluetooth_get_status(void)
4151{
4152 int status;
4153
4154#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4155 if (dbg_bluetoothemul)
4156 return (tpacpi_bluetooth_emulstate) ?
4157 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4158#endif
4159
4160 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4161 return -EIO;
4162
4163 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4164 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4165}
4166
4167static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4168{
4169 int status;
4170
4171 vdbg_printk(TPACPI_DBG_RFKILL,
4172 "will attempt to %s bluetooth\n",
4173 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4174
4175#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4176 if (dbg_bluetoothemul) {
4177 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4178 return 0;
4179 }
4180#endif
4181
4182 if (state == TPACPI_RFK_RADIO_ON)
4183 status = TP_ACPI_BLUETOOTH_RADIOSSW
4184 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4185 else
4186 status = 0;
4187
4188 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4189 return -EIO;
4190
4191 return 0;
4192}
4193
4194/* sysfs bluetooth enable ---------------------------------------------- */
4195static ssize_t bluetooth_enable_show(struct device *dev,
4196 struct device_attribute *attr,
4197 char *buf)
4198{
4199 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4200 attr, buf);
4201}
4202
4203static ssize_t bluetooth_enable_store(struct device *dev,
4204 struct device_attribute *attr,
4205 const char *buf, size_t count)
4206{
4207 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4208 attr, buf, count);
4209}
4210
4211static DEVICE_ATTR_RW(bluetooth_enable);
4212
4213/* --------------------------------------------------------------------- */
4214
4215static struct attribute *bluetooth_attributes[] = {
4216 &dev_attr_bluetooth_enable.attr,
4217 NULL
4218};
4219
4220static const struct attribute_group bluetooth_attr_group = {
4221 .attrs = bluetooth_attributes,
4222};
4223
4224static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4225 .get_status = bluetooth_get_status,
4226 .set_status = bluetooth_set_status,
4227};
4228
4229static void bluetooth_shutdown(void)
4230{
4231 /* Order firmware to save current state to NVRAM */
4232 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4233 TP_ACPI_BLTH_SAVE_STATE))
4234 pr_notice("failed to save bluetooth state to NVRAM\n");
4235 else
4236 vdbg_printk(TPACPI_DBG_RFKILL,
4237 "bluetooth state saved to NVRAM\n");
4238}
4239
4240static void bluetooth_exit(void)
4241{
4242 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4243 &bluetooth_attr_group);
4244
4245 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4246
4247 bluetooth_shutdown();
4248}
4249
4250static int __init bluetooth_init(struct ibm_init_struct *iibm)
4251{
4252 int res;
4253 int status = 0;
4254
4255 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4256 "initializing bluetooth subdriver\n");
4257
4258 TPACPI_ACPIHANDLE_INIT(hkey);
4259
4260 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4261 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4262 tp_features.bluetooth = hkey_handle &&
4263 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4264
4265 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4266 "bluetooth is %s, status 0x%02x\n",
4267 str_supported(tp_features.bluetooth),
4268 status);
4269
4270#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4271 if (dbg_bluetoothemul) {
4272 tp_features.bluetooth = 1;
4273 pr_info("bluetooth switch emulation enabled\n");
4274 } else
4275#endif
4276 if (tp_features.bluetooth &&
4277 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4278 /* no bluetooth hardware present in system */
4279 tp_features.bluetooth = 0;
4280 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4281 "bluetooth hardware not installed\n");
4282 }
4283
4284 if (!tp_features.bluetooth)
4285 return 1;
4286
4287 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4288 &bluetooth_tprfk_ops,
4289 RFKILL_TYPE_BLUETOOTH,
4290 TPACPI_RFK_BLUETOOTH_SW_NAME,
4291 true);
4292 if (res)
4293 return res;
4294
4295 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4296 &bluetooth_attr_group);
4297 if (res) {
4298 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4299 return res;
4300 }
4301
4302 return 0;
4303}
4304
4305/* procfs -------------------------------------------------------------- */
4306static int bluetooth_read(struct seq_file *m)
4307{
4308 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4309}
4310
4311static int bluetooth_write(char *buf)
4312{
4313 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4314}
4315
4316static struct ibm_struct bluetooth_driver_data = {
4317 .name = "bluetooth",
4318 .read = bluetooth_read,
4319 .write = bluetooth_write,
4320 .exit = bluetooth_exit,
4321 .shutdown = bluetooth_shutdown,
4322};
4323
4324/*************************************************************************
4325 * Wan subdriver
4326 */
4327
4328enum {
4329 /* ACPI GWAN/SWAN bits */
4330 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4331 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4332 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4333 0 = disable, 1 = enable */
4334};
4335
4336#define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4337
4338static int wan_get_status(void)
4339{
4340 int status;
4341
4342#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4343 if (dbg_wwanemul)
4344 return (tpacpi_wwan_emulstate) ?
4345 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4346#endif
4347
4348 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4349 return -EIO;
4350
4351 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4352 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4353}
4354
4355static int wan_set_status(enum tpacpi_rfkill_state state)
4356{
4357 int status;
4358
4359 vdbg_printk(TPACPI_DBG_RFKILL,
4360 "will attempt to %s wwan\n",
4361 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4362
4363#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4364 if (dbg_wwanemul) {
4365 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4366 return 0;
4367 }
4368#endif
4369
4370 if (state == TPACPI_RFK_RADIO_ON)
4371 status = TP_ACPI_WANCARD_RADIOSSW
4372 | TP_ACPI_WANCARD_RESUMECTRL;
4373 else
4374 status = 0;
4375
4376 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4377 return -EIO;
4378
4379 return 0;
4380}
4381
4382/* sysfs wan enable ---------------------------------------------------- */
4383static ssize_t wan_enable_show(struct device *dev,
4384 struct device_attribute *attr,
4385 char *buf)
4386{
4387 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4388 attr, buf);
4389}
4390
4391static ssize_t wan_enable_store(struct device *dev,
4392 struct device_attribute *attr,
4393 const char *buf, size_t count)
4394{
4395 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4396 attr, buf, count);
4397}
4398
4399static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4400 wan_enable_show, wan_enable_store);
4401
4402/* --------------------------------------------------------------------- */
4403
4404static struct attribute *wan_attributes[] = {
4405 &dev_attr_wwan_enable.attr,
4406 NULL
4407};
4408
4409static const struct attribute_group wan_attr_group = {
4410 .attrs = wan_attributes,
4411};
4412
4413static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4414 .get_status = wan_get_status,
4415 .set_status = wan_set_status,
4416};
4417
4418static void wan_shutdown(void)
4419{
4420 /* Order firmware to save current state to NVRAM */
4421 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4422 TP_ACPI_WGSV_SAVE_STATE))
4423 pr_notice("failed to save WWAN state to NVRAM\n");
4424 else
4425 vdbg_printk(TPACPI_DBG_RFKILL,
4426 "WWAN state saved to NVRAM\n");
4427}
4428
4429static void wan_exit(void)
4430{
4431 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4432 &wan_attr_group);
4433
4434 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4435
4436 wan_shutdown();
4437}
4438
4439static int __init wan_init(struct ibm_init_struct *iibm)
4440{
4441 int res;
4442 int status = 0;
4443
4444 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4445 "initializing wan subdriver\n");
4446
4447 TPACPI_ACPIHANDLE_INIT(hkey);
4448
4449 tp_features.wan = hkey_handle &&
4450 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4451
4452 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4453 "wan is %s, status 0x%02x\n",
4454 str_supported(tp_features.wan),
4455 status);
4456
4457#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4458 if (dbg_wwanemul) {
4459 tp_features.wan = 1;
4460 pr_info("wwan switch emulation enabled\n");
4461 } else
4462#endif
4463 if (tp_features.wan &&
4464 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4465 /* no wan hardware present in system */
4466 tp_features.wan = 0;
4467 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4468 "wan hardware not installed\n");
4469 }
4470
4471 if (!tp_features.wan)
4472 return 1;
4473
4474 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4475 &wan_tprfk_ops,
4476 RFKILL_TYPE_WWAN,
4477 TPACPI_RFK_WWAN_SW_NAME,
4478 true);
4479 if (res)
4480 return res;
4481
4482 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4483 &wan_attr_group);
4484
4485 if (res) {
4486 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4487 return res;
4488 }
4489
4490 return 0;
4491}
4492
4493/* procfs -------------------------------------------------------------- */
4494static int wan_read(struct seq_file *m)
4495{
4496 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4497}
4498
4499static int wan_write(char *buf)
4500{
4501 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4502}
4503
4504static struct ibm_struct wan_driver_data = {
4505 .name = "wan",
4506 .read = wan_read,
4507 .write = wan_write,
4508 .exit = wan_exit,
4509 .shutdown = wan_shutdown,
4510};
4511
4512/*************************************************************************
4513 * UWB subdriver
4514 */
4515
4516enum {
4517 /* ACPI GUWB/SUWB bits */
4518 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4519 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4520};
4521
4522#define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4523
4524static int uwb_get_status(void)
4525{
4526 int status;
4527
4528#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4529 if (dbg_uwbemul)
4530 return (tpacpi_uwb_emulstate) ?
4531 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4532#endif
4533
4534 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4535 return -EIO;
4536
4537 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4538 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4539}
4540
4541static int uwb_set_status(enum tpacpi_rfkill_state state)
4542{
4543 int status;
4544
4545 vdbg_printk(TPACPI_DBG_RFKILL,
4546 "will attempt to %s UWB\n",
4547 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4548
4549#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4550 if (dbg_uwbemul) {
4551 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4552 return 0;
4553 }
4554#endif
4555
4556 if (state == TPACPI_RFK_RADIO_ON)
4557 status = TP_ACPI_UWB_RADIOSSW;
4558 else
4559 status = 0;
4560
4561 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4562 return -EIO;
4563
4564 return 0;
4565}
4566
4567/* --------------------------------------------------------------------- */
4568
4569static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4570 .get_status = uwb_get_status,
4571 .set_status = uwb_set_status,
4572};
4573
4574static void uwb_exit(void)
4575{
4576 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4577}
4578
4579static int __init uwb_init(struct ibm_init_struct *iibm)
4580{
4581 int res;
4582 int status = 0;
4583
4584 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4585 "initializing uwb subdriver\n");
4586
4587 TPACPI_ACPIHANDLE_INIT(hkey);
4588
4589 tp_features.uwb = hkey_handle &&
4590 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4591
4592 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4593 "uwb is %s, status 0x%02x\n",
4594 str_supported(tp_features.uwb),
4595 status);
4596
4597#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4598 if (dbg_uwbemul) {
4599 tp_features.uwb = 1;
4600 pr_info("uwb switch emulation enabled\n");
4601 } else
4602#endif
4603 if (tp_features.uwb &&
4604 !(status & TP_ACPI_UWB_HWPRESENT)) {
4605 /* no uwb hardware present in system */
4606 tp_features.uwb = 0;
4607 dbg_printk(TPACPI_DBG_INIT,
4608 "uwb hardware not installed\n");
4609 }
4610
4611 if (!tp_features.uwb)
4612 return 1;
4613
4614 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4615 &uwb_tprfk_ops,
4616 RFKILL_TYPE_UWB,
4617 TPACPI_RFK_UWB_SW_NAME,
4618 false);
4619 return res;
4620}
4621
4622static struct ibm_struct uwb_driver_data = {
4623 .name = "uwb",
4624 .exit = uwb_exit,
4625 .flags.experimental = 1,
4626};
4627
4628/*************************************************************************
4629 * Video subdriver
4630 */
4631
4632#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4633
4634enum video_access_mode {
4635 TPACPI_VIDEO_NONE = 0,
4636 TPACPI_VIDEO_570, /* 570 */
4637 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4638 TPACPI_VIDEO_NEW, /* all others */
4639};
4640
4641enum { /* video status flags, based on VIDEO_570 */
4642 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4643 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4644 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4645};
4646
4647enum { /* TPACPI_VIDEO_570 constants */
4648 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4649 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4650 * video_status_flags */
4651 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4652 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4653};
4654
4655static enum video_access_mode video_supported;
4656static int video_orig_autosw;
4657
4658static int video_autosw_get(void);
4659static int video_autosw_set(int enable);
4660
4661TPACPI_HANDLE(vid, root,
4662 "\\_SB.PCI.AGP.VGA", /* 570 */
4663 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4664 "\\_SB.PCI0.VID0", /* 770e */
4665 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4666 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4667 "\\_SB.PCI0.AGP.VID", /* all others */
4668 ); /* R30, R31 */
4669
4670TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4671
4672static int __init video_init(struct ibm_init_struct *iibm)
4673{
4674 int ivga;
4675
4676 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4677
4678 TPACPI_ACPIHANDLE_INIT(vid);
4679 if (tpacpi_is_ibm())
4680 TPACPI_ACPIHANDLE_INIT(vid2);
4681
4682 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4683 /* G41, assume IVGA doesn't change */
4684 vid_handle = vid2_handle;
4685
4686 if (!vid_handle)
4687 /* video switching not supported on R30, R31 */
4688 video_supported = TPACPI_VIDEO_NONE;
4689 else if (tpacpi_is_ibm() &&
4690 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4691 /* 570 */
4692 video_supported = TPACPI_VIDEO_570;
4693 else if (tpacpi_is_ibm() &&
4694 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4695 /* 600e/x, 770e, 770x */
4696 video_supported = TPACPI_VIDEO_770;
4697 else
4698 /* all others */
4699 video_supported = TPACPI_VIDEO_NEW;
4700
4701 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4702 str_supported(video_supported != TPACPI_VIDEO_NONE),
4703 video_supported);
4704
4705 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
4706}
4707
4708static void video_exit(void)
4709{
4710 dbg_printk(TPACPI_DBG_EXIT,
4711 "restoring original video autoswitch mode\n");
4712 if (video_autosw_set(video_orig_autosw))
4713 pr_err("error while trying to restore original "
4714 "video autoswitch mode\n");
4715}
4716
4717static int video_outputsw_get(void)
4718{
4719 int status = 0;
4720 int i;
4721
4722 switch (video_supported) {
4723 case TPACPI_VIDEO_570:
4724 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4725 TP_ACPI_VIDEO_570_PHSCMD))
4726 return -EIO;
4727 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4728 break;
4729 case TPACPI_VIDEO_770:
4730 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4731 return -EIO;
4732 if (i)
4733 status |= TP_ACPI_VIDEO_S_LCD;
4734 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4735 return -EIO;
4736 if (i)
4737 status |= TP_ACPI_VIDEO_S_CRT;
4738 break;
4739 case TPACPI_VIDEO_NEW:
4740 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4741 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4742 return -EIO;
4743 if (i)
4744 status |= TP_ACPI_VIDEO_S_CRT;
4745
4746 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4747 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4748 return -EIO;
4749 if (i)
4750 status |= TP_ACPI_VIDEO_S_LCD;
4751 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4752 return -EIO;
4753 if (i)
4754 status |= TP_ACPI_VIDEO_S_DVI;
4755 break;
4756 default:
4757 return -ENOSYS;
4758 }
4759
4760 return status;
4761}
4762
4763static int video_outputsw_set(int status)
4764{
4765 int autosw;
4766 int res = 0;
4767
4768 switch (video_supported) {
4769 case TPACPI_VIDEO_570:
4770 res = acpi_evalf(NULL, NULL,
4771 "\\_SB.PHS2", "vdd",
4772 TP_ACPI_VIDEO_570_PHS2CMD,
4773 status | TP_ACPI_VIDEO_570_PHS2SET);
4774 break;
4775 case TPACPI_VIDEO_770:
4776 autosw = video_autosw_get();
4777 if (autosw < 0)
4778 return autosw;
4779
4780 res = video_autosw_set(1);
4781 if (res)
4782 return res;
4783 res = acpi_evalf(vid_handle, NULL,
4784 "ASWT", "vdd", status * 0x100, 0);
4785 if (!autosw && video_autosw_set(autosw)) {
4786 pr_err("video auto-switch left enabled due to error\n");
4787 return -EIO;
4788 }
4789 break;
4790 case TPACPI_VIDEO_NEW:
4791 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4792 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4793 break;
4794 default:
4795 return -ENOSYS;
4796 }
4797
4798 return (res) ? 0 : -EIO;
4799}
4800
4801static int video_autosw_get(void)
4802{
4803 int autosw = 0;
4804
4805 switch (video_supported) {
4806 case TPACPI_VIDEO_570:
4807 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4808 return -EIO;
4809 break;
4810 case TPACPI_VIDEO_770:
4811 case TPACPI_VIDEO_NEW:
4812 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4813 return -EIO;
4814 break;
4815 default:
4816 return -ENOSYS;
4817 }
4818
4819 return autosw & 1;
4820}
4821
4822static int video_autosw_set(int enable)
4823{
4824 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
4825 return -EIO;
4826 return 0;
4827}
4828
4829static int video_outputsw_cycle(void)
4830{
4831 int autosw = video_autosw_get();
4832 int res;
4833
4834 if (autosw < 0)
4835 return autosw;
4836
4837 switch (video_supported) {
4838 case TPACPI_VIDEO_570:
4839 res = video_autosw_set(1);
4840 if (res)
4841 return res;
4842 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4843 break;
4844 case TPACPI_VIDEO_770:
4845 case TPACPI_VIDEO_NEW:
4846 res = video_autosw_set(1);
4847 if (res)
4848 return res;
4849 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4850 break;
4851 default:
4852 return -ENOSYS;
4853 }
4854 if (!autosw && video_autosw_set(autosw)) {
4855 pr_err("video auto-switch left enabled due to error\n");
4856 return -EIO;
4857 }
4858
4859 return (res) ? 0 : -EIO;
4860}
4861
4862static int video_expand_toggle(void)
4863{
4864 switch (video_supported) {
4865 case TPACPI_VIDEO_570:
4866 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
4867 0 : -EIO;
4868 case TPACPI_VIDEO_770:
4869 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
4870 0 : -EIO;
4871 case TPACPI_VIDEO_NEW:
4872 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
4873 0 : -EIO;
4874 default:
4875 return -ENOSYS;
4876 }
4877 /* not reached */
4878}
4879
4880static int video_read(struct seq_file *m)
4881{
4882 int status, autosw;
4883
4884 if (video_supported == TPACPI_VIDEO_NONE) {
4885 seq_printf(m, "status:\t\tnot supported\n");
4886 return 0;
4887 }
4888
4889 /* Even reads can crash X.org, so... */
4890 if (!capable(CAP_SYS_ADMIN))
4891 return -EPERM;
4892
4893 status = video_outputsw_get();
4894 if (status < 0)
4895 return status;
4896
4897 autosw = video_autosw_get();
4898 if (autosw < 0)
4899 return autosw;
4900
4901 seq_printf(m, "status:\t\tsupported\n");
4902 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
4903 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
4904 if (video_supported == TPACPI_VIDEO_NEW)
4905 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
4906 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
4907 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
4908 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
4909 if (video_supported == TPACPI_VIDEO_NEW)
4910 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
4911 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
4912 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
4913
4914 return 0;
4915}
4916
4917static int video_write(char *buf)
4918{
4919 char *cmd;
4920 int enable, disable, status;
4921 int res;
4922
4923 if (video_supported == TPACPI_VIDEO_NONE)
4924 return -ENODEV;
4925
4926 /* Even reads can crash X.org, let alone writes... */
4927 if (!capable(CAP_SYS_ADMIN))
4928 return -EPERM;
4929
4930 enable = 0;
4931 disable = 0;
4932
4933 while ((cmd = next_cmd(&buf))) {
4934 if (strlencmp(cmd, "lcd_enable") == 0) {
4935 enable |= TP_ACPI_VIDEO_S_LCD;
4936 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4937 disable |= TP_ACPI_VIDEO_S_LCD;
4938 } else if (strlencmp(cmd, "crt_enable") == 0) {
4939 enable |= TP_ACPI_VIDEO_S_CRT;
4940 } else if (strlencmp(cmd, "crt_disable") == 0) {
4941 disable |= TP_ACPI_VIDEO_S_CRT;
4942 } else if (video_supported == TPACPI_VIDEO_NEW &&
4943 strlencmp(cmd, "dvi_enable") == 0) {
4944 enable |= TP_ACPI_VIDEO_S_DVI;
4945 } else if (video_supported == TPACPI_VIDEO_NEW &&
4946 strlencmp(cmd, "dvi_disable") == 0) {
4947 disable |= TP_ACPI_VIDEO_S_DVI;
4948 } else if (strlencmp(cmd, "auto_enable") == 0) {
4949 res = video_autosw_set(1);
4950 if (res)
4951 return res;
4952 } else if (strlencmp(cmd, "auto_disable") == 0) {
4953 res = video_autosw_set(0);
4954 if (res)
4955 return res;
4956 } else if (strlencmp(cmd, "video_switch") == 0) {
4957 res = video_outputsw_cycle();
4958 if (res)
4959 return res;
4960 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4961 res = video_expand_toggle();
4962 if (res)
4963 return res;
4964 } else
4965 return -EINVAL;
4966 }
4967
4968 if (enable || disable) {
4969 status = video_outputsw_get();
4970 if (status < 0)
4971 return status;
4972 res = video_outputsw_set((status & ~disable) | enable);
4973 if (res)
4974 return res;
4975 }
4976
4977 return 0;
4978}
4979
4980static struct ibm_struct video_driver_data = {
4981 .name = "video",
4982 .read = video_read,
4983 .write = video_write,
4984 .exit = video_exit,
4985};
4986
4987#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4988
4989/*************************************************************************
4990 * Keyboard backlight subdriver
4991 */
4992
4993static int kbdlight_set_level(int level)
4994{
4995 if (!hkey_handle)
4996 return -ENXIO;
4997
4998 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
4999 return -EIO;
5000
5001 return 0;
5002}
5003
5004static int kbdlight_get_level(void)
5005{
5006 int status = 0;
5007
5008 if (!hkey_handle)
5009 return -ENXIO;
5010
5011 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5012 return -EIO;
5013
5014 if (status < 0)
5015 return status;
5016
5017 return status & 0x3;
5018}
5019
5020static bool kbdlight_is_supported(void)
5021{
5022 int status = 0;
5023
5024 if (!hkey_handle)
5025 return false;
5026
5027 if (!acpi_has_method(hkey_handle, "MLCG")) {
5028 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5029 return false;
5030 }
5031
5032 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5033 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5034 return false;
5035 }
5036
5037 if (status < 0) {
5038 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5039 return false;
5040 }
5041
5042 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5043 /*
5044 * Guessed test for keyboard backlight:
5045 *
5046 * Machines with backlight keyboard return:
5047 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5048 * b110100010010000000XX - ThinkPad x230
5049 * b010100000010000000XX - ThinkPad x240
5050 * b010100000010000000XX - ThinkPad W541
5051 * (XX is current backlight level)
5052 *
5053 * Machines without backlight keyboard return:
5054 * b10100001000000000000 - ThinkPad x230
5055 * b10110001000000000000 - ThinkPad E430
5056 * b00000000000000000000 - ThinkPad E450
5057 *
5058 * Candidate BITs for detection test (XOR):
5059 * b01000000001000000000
5060 * ^
5061 */
5062 return status & BIT(9);
5063}
5064
5065static void kbdlight_set_worker(struct work_struct *work)
5066{
5067 struct tpacpi_led_classdev *data =
5068 container_of(work, struct tpacpi_led_classdev, work);
5069
5070 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5071 kbdlight_set_level(data->new_state);
5072}
5073
5074static void kbdlight_sysfs_set(struct led_classdev *led_cdev,
5075 enum led_brightness brightness)
5076{
5077 struct tpacpi_led_classdev *data =
5078 container_of(led_cdev,
5079 struct tpacpi_led_classdev,
5080 led_classdev);
5081 data->new_state = brightness;
5082 queue_work(tpacpi_wq, &data->work);
5083}
5084
5085static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5086{
5087 int level;
5088
5089 level = kbdlight_get_level();
5090 if (level < 0)
5091 return 0;
5092
5093 return level;
5094}
5095
5096static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5097 .led_classdev = {
5098 .name = "tpacpi::kbd_backlight",
5099 .max_brightness = 2,
5100 .brightness_set = &kbdlight_sysfs_set,
5101 .brightness_get = &kbdlight_sysfs_get,
5102 .flags = LED_CORE_SUSPENDRESUME,
5103 }
5104};
5105
5106static int __init kbdlight_init(struct ibm_init_struct *iibm)
5107{
5108 int rc;
5109
5110 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5111
5112 TPACPI_ACPIHANDLE_INIT(hkey);
5113 INIT_WORK(&tpacpi_led_kbdlight.work, kbdlight_set_worker);
5114
5115 if (!kbdlight_is_supported()) {
5116 tp_features.kbdlight = 0;
5117 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5118 return 1;
5119 }
5120
5121 tp_features.kbdlight = 1;
5122
5123 rc = led_classdev_register(&tpacpi_pdev->dev,
5124 &tpacpi_led_kbdlight.led_classdev);
5125 if (rc < 0) {
5126 tp_features.kbdlight = 0;
5127 return rc;
5128 }
5129
5130 return 0;
5131}
5132
5133static void kbdlight_exit(void)
5134{
5135 if (tp_features.kbdlight)
5136 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5137 flush_workqueue(tpacpi_wq);
5138}
5139
5140static int kbdlight_read(struct seq_file *m)
5141{
5142 int level;
5143
5144 if (!tp_features.kbdlight) {
5145 seq_printf(m, "status:\t\tnot supported\n");
5146 } else {
5147 level = kbdlight_get_level();
5148 if (level < 0)
5149 seq_printf(m, "status:\t\terror %d\n", level);
5150 else
5151 seq_printf(m, "status:\t\t%d\n", level);
5152 seq_printf(m, "commands:\t0, 1, 2\n");
5153 }
5154
5155 return 0;
5156}
5157
5158static int kbdlight_write(char *buf)
5159{
5160 char *cmd;
5161 int level = -1;
5162
5163 if (!tp_features.kbdlight)
5164 return -ENODEV;
5165
5166 while ((cmd = next_cmd(&buf))) {
5167 if (strlencmp(cmd, "0") == 0)
5168 level = 0;
5169 else if (strlencmp(cmd, "1") == 0)
5170 level = 1;
5171 else if (strlencmp(cmd, "2") == 0)
5172 level = 2;
5173 else
5174 return -EINVAL;
5175 }
5176
5177 if (level == -1)
5178 return -EINVAL;
5179
5180 return kbdlight_set_level(level);
5181}
5182
5183static struct ibm_struct kbdlight_driver_data = {
5184 .name = "kbdlight",
5185 .read = kbdlight_read,
5186 .write = kbdlight_write,
5187 .exit = kbdlight_exit,
5188};
5189
5190/*************************************************************************
5191 * Light (thinklight) subdriver
5192 */
5193
5194TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5195TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5196
5197static int light_get_status(void)
5198{
5199 int status = 0;
5200
5201 if (tp_features.light_status) {
5202 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5203 return -EIO;
5204 return (!!status);
5205 }
5206
5207 return -ENXIO;
5208}
5209
5210static int light_set_status(int status)
5211{
5212 int rc;
5213
5214 if (tp_features.light) {
5215 if (cmos_handle) {
5216 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5217 (status) ?
5218 TP_CMOS_THINKLIGHT_ON :
5219 TP_CMOS_THINKLIGHT_OFF);
5220 } else {
5221 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5222 (status) ? 1 : 0);
5223 }
5224 return (rc) ? 0 : -EIO;
5225 }
5226
5227 return -ENXIO;
5228}
5229
5230static void light_set_status_worker(struct work_struct *work)
5231{
5232 struct tpacpi_led_classdev *data =
5233 container_of(work, struct tpacpi_led_classdev, work);
5234
5235 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5236 light_set_status((data->new_state != TPACPI_LED_OFF));
5237}
5238
5239static void light_sysfs_set(struct led_classdev *led_cdev,
5240 enum led_brightness brightness)
5241{
5242 struct tpacpi_led_classdev *data =
5243 container_of(led_cdev,
5244 struct tpacpi_led_classdev,
5245 led_classdev);
5246 data->new_state = (brightness != LED_OFF) ?
5247 TPACPI_LED_ON : TPACPI_LED_OFF;
5248 queue_work(tpacpi_wq, &data->work);
5249}
5250
5251static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5252{
5253 return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5254}
5255
5256static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5257 .led_classdev = {
5258 .name = "tpacpi::thinklight",
5259 .brightness_set = &light_sysfs_set,
5260 .brightness_get = &light_sysfs_get,
5261 }
5262};
5263
5264static int __init light_init(struct ibm_init_struct *iibm)
5265{
5266 int rc;
5267
5268 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5269
5270 if (tpacpi_is_ibm()) {
5271 TPACPI_ACPIHANDLE_INIT(ledb);
5272 TPACPI_ACPIHANDLE_INIT(lght);
5273 }
5274 TPACPI_ACPIHANDLE_INIT(cmos);
5275 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
5276
5277 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5278 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5279
5280 if (tp_features.light)
5281 /* light status not supported on
5282 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5283 tp_features.light_status =
5284 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5285
5286 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5287 str_supported(tp_features.light),
5288 str_supported(tp_features.light_status));
5289
5290 if (!tp_features.light)
5291 return 1;
5292
5293 rc = led_classdev_register(&tpacpi_pdev->dev,
5294 &tpacpi_led_thinklight.led_classdev);
5295
5296 if (rc < 0) {
5297 tp_features.light = 0;
5298 tp_features.light_status = 0;
5299 } else {
5300 rc = 0;
5301 }
5302
5303 return rc;
5304}
5305
5306static void light_exit(void)
5307{
5308 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5309 flush_workqueue(tpacpi_wq);
5310}
5311
5312static int light_read(struct seq_file *m)
5313{
5314 int status;
5315
5316 if (!tp_features.light) {
5317 seq_printf(m, "status:\t\tnot supported\n");
5318 } else if (!tp_features.light_status) {
5319 seq_printf(m, "status:\t\tunknown\n");
5320 seq_printf(m, "commands:\ton, off\n");
5321 } else {
5322 status = light_get_status();
5323 if (status < 0)
5324 return status;
5325 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5326 seq_printf(m, "commands:\ton, off\n");
5327 }
5328
5329 return 0;
5330}
5331
5332static int light_write(char *buf)
5333{
5334 char *cmd;
5335 int newstatus = 0;
5336
5337 if (!tp_features.light)
5338 return -ENODEV;
5339
5340 while ((cmd = next_cmd(&buf))) {
5341 if (strlencmp(cmd, "on") == 0) {
5342 newstatus = 1;
5343 } else if (strlencmp(cmd, "off") == 0) {
5344 newstatus = 0;
5345 } else
5346 return -EINVAL;
5347 }
5348
5349 return light_set_status(newstatus);
5350}
5351
5352static struct ibm_struct light_driver_data = {
5353 .name = "light",
5354 .read = light_read,
5355 .write = light_write,
5356 .exit = light_exit,
5357};
5358
5359/*************************************************************************
5360 * CMOS subdriver
5361 */
5362
5363/* sysfs cmos_command -------------------------------------------------- */
5364static ssize_t cmos_command_store(struct device *dev,
5365 struct device_attribute *attr,
5366 const char *buf, size_t count)
5367{
5368 unsigned long cmos_cmd;
5369 int res;
5370
5371 if (parse_strtoul(buf, 21, &cmos_cmd))
5372 return -EINVAL;
5373
5374 res = issue_thinkpad_cmos_command(cmos_cmd);
5375 return (res) ? res : count;
5376}
5377
5378static DEVICE_ATTR_WO(cmos_command);
5379
5380/* --------------------------------------------------------------------- */
5381
5382static int __init cmos_init(struct ibm_init_struct *iibm)
5383{
5384 int res;
5385
5386 vdbg_printk(TPACPI_DBG_INIT,
5387 "initializing cmos commands subdriver\n");
5388
5389 TPACPI_ACPIHANDLE_INIT(cmos);
5390
5391 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5392 str_supported(cmos_handle != NULL));
5393
5394 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5395 if (res)
5396 return res;
5397
5398 return (cmos_handle) ? 0 : 1;
5399}
5400
5401static void cmos_exit(void)
5402{
5403 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5404}
5405
5406static int cmos_read(struct seq_file *m)
5407{
5408 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5409 R30, R31, T20-22, X20-21 */
5410 if (!cmos_handle)
5411 seq_printf(m, "status:\t\tnot supported\n");
5412 else {
5413 seq_printf(m, "status:\t\tsupported\n");
5414 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5415 }
5416
5417 return 0;
5418}
5419
5420static int cmos_write(char *buf)
5421{
5422 char *cmd;
5423 int cmos_cmd, res;
5424
5425 while ((cmd = next_cmd(&buf))) {
5426 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5427 cmos_cmd >= 0 && cmos_cmd <= 21) {
5428 /* cmos_cmd set */
5429 } else
5430 return -EINVAL;
5431
5432 res = issue_thinkpad_cmos_command(cmos_cmd);
5433 if (res)
5434 return res;
5435 }
5436
5437 return 0;
5438}
5439
5440static struct ibm_struct cmos_driver_data = {
5441 .name = "cmos",
5442 .read = cmos_read,
5443 .write = cmos_write,
5444 .exit = cmos_exit,
5445};
5446
5447/*************************************************************************
5448 * LED subdriver
5449 */
5450
5451enum led_access_mode {
5452 TPACPI_LED_NONE = 0,
5453 TPACPI_LED_570, /* 570 */
5454 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5455 TPACPI_LED_NEW, /* all others */
5456};
5457
5458enum { /* For TPACPI_LED_OLD */
5459 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5460 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5461 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5462};
5463
5464static enum led_access_mode led_supported;
5465
5466static acpi_handle led_handle;
5467
5468#define TPACPI_LED_NUMLEDS 16
5469static struct tpacpi_led_classdev *tpacpi_leds;
5470static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5471static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5472 /* there's a limit of 19 chars + NULL before 2.6.26 */
5473 "tpacpi::power",
5474 "tpacpi:orange:batt",
5475 "tpacpi:green:batt",
5476 "tpacpi::dock_active",
5477 "tpacpi::bay_active",
5478 "tpacpi::dock_batt",
5479 "tpacpi::unknown_led",
5480 "tpacpi::standby",
5481 "tpacpi::dock_status1",
5482 "tpacpi::dock_status2",
5483 "tpacpi::unknown_led2",
5484 "tpacpi::unknown_led3",
5485 "tpacpi::thinkvantage",
5486};
5487#define TPACPI_SAFE_LEDS 0x1081U
5488
5489static inline bool tpacpi_is_led_restricted(const unsigned int led)
5490{
5491#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5492 return false;
5493#else
5494 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5495#endif
5496}
5497
5498static int led_get_status(const unsigned int led)
5499{
5500 int status;
5501 enum led_status_t led_s;
5502
5503 switch (led_supported) {
5504 case TPACPI_LED_570:
5505 if (!acpi_evalf(ec_handle,
5506 &status, "GLED", "dd", 1 << led))
5507 return -EIO;
5508 led_s = (status == 0) ?
5509 TPACPI_LED_OFF :
5510 ((status == 1) ?
5511 TPACPI_LED_ON :
5512 TPACPI_LED_BLINK);
5513 tpacpi_led_state_cache[led] = led_s;
5514 return led_s;
5515 default:
5516 return -ENXIO;
5517 }
5518
5519 /* not reached */
5520}
5521
5522static int led_set_status(const unsigned int led,
5523 const enum led_status_t ledstatus)
5524{
5525 /* off, on, blink. Index is led_status_t */
5526 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5527 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5528
5529 int rc = 0;
5530
5531 switch (led_supported) {
5532 case TPACPI_LED_570:
5533 /* 570 */
5534 if (unlikely(led > 7))
5535 return -EINVAL;
5536 if (unlikely(tpacpi_is_led_restricted(led)))
5537 return -EPERM;
5538 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5539 (1 << led), led_sled_arg1[ledstatus]))
5540 rc = -EIO;
5541 break;
5542 case TPACPI_LED_OLD:
5543 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5544 if (unlikely(led > 7))
5545 return -EINVAL;
5546 if (unlikely(tpacpi_is_led_restricted(led)))
5547 return -EPERM;
5548 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5549 if (rc >= 0)
5550 rc = ec_write(TPACPI_LED_EC_HLBL,
5551 (ledstatus == TPACPI_LED_BLINK) << led);
5552 if (rc >= 0)
5553 rc = ec_write(TPACPI_LED_EC_HLCL,
5554 (ledstatus != TPACPI_LED_OFF) << led);
5555 break;
5556 case TPACPI_LED_NEW:
5557 /* all others */
5558 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5559 return -EINVAL;
5560 if (unlikely(tpacpi_is_led_restricted(led)))
5561 return -EPERM;
5562 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5563 led, led_led_arg1[ledstatus]))
5564 rc = -EIO;
5565 break;
5566 default:
5567 rc = -ENXIO;
5568 }
5569
5570 if (!rc)
5571 tpacpi_led_state_cache[led] = ledstatus;
5572
5573 return rc;
5574}
5575
5576static void led_set_status_worker(struct work_struct *work)
5577{
5578 struct tpacpi_led_classdev *data =
5579 container_of(work, struct tpacpi_led_classdev, work);
5580
5581 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5582 led_set_status(data->led, data->new_state);
5583}
5584
5585static void led_sysfs_set(struct led_classdev *led_cdev,
5586 enum led_brightness brightness)
5587{
5588 struct tpacpi_led_classdev *data = container_of(led_cdev,
5589 struct tpacpi_led_classdev, led_classdev);
5590
5591 if (brightness == LED_OFF)
5592 data->new_state = TPACPI_LED_OFF;
5593 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5594 data->new_state = TPACPI_LED_ON;
5595 else
5596 data->new_state = TPACPI_LED_BLINK;
5597
5598 queue_work(tpacpi_wq, &data->work);
5599}
5600
5601static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5602 unsigned long *delay_on, unsigned long *delay_off)
5603{
5604 struct tpacpi_led_classdev *data = container_of(led_cdev,
5605 struct tpacpi_led_classdev, led_classdev);
5606
5607 /* Can we choose the flash rate? */
5608 if (*delay_on == 0 && *delay_off == 0) {
5609 /* yes. set them to the hardware blink rate (1 Hz) */
5610 *delay_on = 500; /* ms */
5611 *delay_off = 500; /* ms */
5612 } else if ((*delay_on != 500) || (*delay_off != 500))
5613 return -EINVAL;
5614
5615 data->new_state = TPACPI_LED_BLINK;
5616 queue_work(tpacpi_wq, &data->work);
5617
5618 return 0;
5619}
5620
5621static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5622{
5623 int rc;
5624
5625 struct tpacpi_led_classdev *data = container_of(led_cdev,
5626 struct tpacpi_led_classdev, led_classdev);
5627
5628 rc = led_get_status(data->led);
5629
5630 if (rc == TPACPI_LED_OFF || rc < 0)
5631 rc = LED_OFF; /* no error handling in led class :( */
5632 else
5633 rc = LED_FULL;
5634
5635 return rc;
5636}
5637
5638static void led_exit(void)
5639{
5640 unsigned int i;
5641
5642 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5643 if (tpacpi_leds[i].led_classdev.name)
5644 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5645 }
5646
5647 flush_workqueue(tpacpi_wq);
5648 kfree(tpacpi_leds);
5649}
5650
5651static int __init tpacpi_init_led(unsigned int led)
5652{
5653 int rc;
5654
5655 tpacpi_leds[led].led = led;
5656
5657 /* LEDs with no name don't get registered */
5658 if (!tpacpi_led_names[led])
5659 return 0;
5660
5661 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5662 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5663 if (led_supported == TPACPI_LED_570)
5664 tpacpi_leds[led].led_classdev.brightness_get =
5665 &led_sysfs_get;
5666
5667 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5668
5669 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5670
5671 rc = led_classdev_register(&tpacpi_pdev->dev,
5672 &tpacpi_leds[led].led_classdev);
5673 if (rc < 0)
5674 tpacpi_leds[led].led_classdev.name = NULL;
5675
5676 return rc;
5677}
5678
5679static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5680 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5681 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5682 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5683
5684 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5685 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5686 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5687 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5688 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5689 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5690 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5691 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5692
5693 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5694 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5695 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5696 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5697 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5698
5699 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5700 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5701 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5702 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5703
5704 /* (1) - may have excess leds enabled on MSB */
5705
5706 /* Defaults (order matters, keep last, don't reorder!) */
5707 { /* Lenovo */
5708 .vendor = PCI_VENDOR_ID_LENOVO,
5709 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5710 .quirks = 0x1fffU,
5711 },
5712 { /* IBM ThinkPads with no EC version string */
5713 .vendor = PCI_VENDOR_ID_IBM,
5714 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5715 .quirks = 0x00ffU,
5716 },
5717 { /* IBM ThinkPads with EC version string */
5718 .vendor = PCI_VENDOR_ID_IBM,
5719 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5720 .quirks = 0x00bfU,
5721 },
5722};
5723
5724#undef TPACPI_LEDQ_IBM
5725#undef TPACPI_LEDQ_LNV
5726
5727static enum led_access_mode __init led_init_detect_mode(void)
5728{
5729 acpi_status status;
5730
5731 if (tpacpi_is_ibm()) {
5732 /* 570 */
5733 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
5734 if (ACPI_SUCCESS(status))
5735 return TPACPI_LED_570;
5736
5737 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5738 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
5739 if (ACPI_SUCCESS(status))
5740 return TPACPI_LED_OLD;
5741 }
5742
5743 /* most others */
5744 status = acpi_get_handle(ec_handle, "LED", &led_handle);
5745 if (ACPI_SUCCESS(status))
5746 return TPACPI_LED_NEW;
5747
5748 /* R30, R31, and unknown firmwares */
5749 led_handle = NULL;
5750 return TPACPI_LED_NONE;
5751}
5752
5753static int __init led_init(struct ibm_init_struct *iibm)
5754{
5755 unsigned int i;
5756 int rc;
5757 unsigned long useful_leds;
5758
5759 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5760
5761 led_supported = led_init_detect_mode();
5762
5763 if (led_supported != TPACPI_LED_NONE) {
5764 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5765 ARRAY_SIZE(led_useful_qtable));
5766
5767 if (!useful_leds) {
5768 led_handle = NULL;
5769 led_supported = TPACPI_LED_NONE;
5770 }
5771 }
5772
5773 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5774 str_supported(led_supported), led_supported);
5775
5776 if (led_supported == TPACPI_LED_NONE)
5777 return 1;
5778
5779 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5780 GFP_KERNEL);
5781 if (!tpacpi_leds) {
5782 pr_err("Out of memory for LED data\n");
5783 return -ENOMEM;
5784 }
5785
5786 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5787 tpacpi_leds[i].led = -1;
5788
5789 if (!tpacpi_is_led_restricted(i) &&
5790 test_bit(i, &useful_leds)) {
5791 rc = tpacpi_init_led(i);
5792 if (rc < 0) {
5793 led_exit();
5794 return rc;
5795 }
5796 }
5797 }
5798
5799#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5800 pr_notice("warning: userspace override of important "
5801 "firmware LEDs is enabled\n");
5802#endif
5803 return 0;
5804}
5805
5806#define str_led_status(s) \
5807 ((s) == TPACPI_LED_OFF ? "off" : \
5808 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5809
5810static int led_read(struct seq_file *m)
5811{
5812 if (!led_supported) {
5813 seq_printf(m, "status:\t\tnot supported\n");
5814 return 0;
5815 }
5816 seq_printf(m, "status:\t\tsupported\n");
5817
5818 if (led_supported == TPACPI_LED_570) {
5819 /* 570 */
5820 int i, status;
5821 for (i = 0; i < 8; i++) {
5822 status = led_get_status(i);
5823 if (status < 0)
5824 return -EIO;
5825 seq_printf(m, "%d:\t\t%s\n",
5826 i, str_led_status(status));
5827 }
5828 }
5829
5830 seq_printf(m, "commands:\t"
5831 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5832
5833 return 0;
5834}
5835
5836static int led_write(char *buf)
5837{
5838 char *cmd;
5839 int led, rc;
5840 enum led_status_t s;
5841
5842 if (!led_supported)
5843 return -ENODEV;
5844
5845 while ((cmd = next_cmd(&buf))) {
5846 if (sscanf(cmd, "%d", &led) != 1)
5847 return -EINVAL;
5848
5849 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1) ||
5850 tpacpi_leds[led].led < 0)
5851 return -ENODEV;
5852
5853 if (strstr(cmd, "off")) {
5854 s = TPACPI_LED_OFF;
5855 } else if (strstr(cmd, "on")) {
5856 s = TPACPI_LED_ON;
5857 } else if (strstr(cmd, "blink")) {
5858 s = TPACPI_LED_BLINK;
5859 } else {
5860 return -EINVAL;
5861 }
5862
5863 rc = led_set_status(led, s);
5864 if (rc < 0)
5865 return rc;
5866 }
5867
5868 return 0;
5869}
5870
5871static struct ibm_struct led_driver_data = {
5872 .name = "led",
5873 .read = led_read,
5874 .write = led_write,
5875 .exit = led_exit,
5876};
5877
5878/*************************************************************************
5879 * Beep subdriver
5880 */
5881
5882TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5883
5884#define TPACPI_BEEP_Q1 0x0001
5885
5886static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5887 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5888 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5889};
5890
5891static int __init beep_init(struct ibm_init_struct *iibm)
5892{
5893 unsigned long quirks;
5894
5895 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5896
5897 TPACPI_ACPIHANDLE_INIT(beep);
5898
5899 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5900 str_supported(beep_handle != NULL));
5901
5902 quirks = tpacpi_check_quirks(beep_quirk_table,
5903 ARRAY_SIZE(beep_quirk_table));
5904
5905 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5906
5907 return (beep_handle) ? 0 : 1;
5908}
5909
5910static int beep_read(struct seq_file *m)
5911{
5912 if (!beep_handle)
5913 seq_printf(m, "status:\t\tnot supported\n");
5914 else {
5915 seq_printf(m, "status:\t\tsupported\n");
5916 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
5917 }
5918
5919 return 0;
5920}
5921
5922static int beep_write(char *buf)
5923{
5924 char *cmd;
5925 int beep_cmd;
5926
5927 if (!beep_handle)
5928 return -ENODEV;
5929
5930 while ((cmd = next_cmd(&buf))) {
5931 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5932 beep_cmd >= 0 && beep_cmd <= 17) {
5933 /* beep_cmd set */
5934 } else
5935 return -EINVAL;
5936 if (tp_features.beep_needs_two_args) {
5937 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5938 beep_cmd, 0))
5939 return -EIO;
5940 } else {
5941 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5942 beep_cmd))
5943 return -EIO;
5944 }
5945 }
5946
5947 return 0;
5948}
5949
5950static struct ibm_struct beep_driver_data = {
5951 .name = "beep",
5952 .read = beep_read,
5953 .write = beep_write,
5954};
5955
5956/*************************************************************************
5957 * Thermal subdriver
5958 */
5959
5960enum thermal_access_mode {
5961 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5962 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5963 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5964 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5965 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5966};
5967
5968enum { /* TPACPI_THERMAL_TPEC_* */
5969 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5970 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5971 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5972
5973 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
5974};
5975
5976
5977#define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5978struct ibm_thermal_sensors_struct {
5979 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5980};
5981
5982static enum thermal_access_mode thermal_read_mode;
5983
5984/* idx is zero-based */
5985static int thermal_get_sensor(int idx, s32 *value)
5986{
5987 int t;
5988 s8 tmp;
5989 char tmpi[5];
5990
5991 t = TP_EC_THERMAL_TMP0;
5992
5993 switch (thermal_read_mode) {
5994#if TPACPI_MAX_THERMAL_SENSORS >= 16
5995 case TPACPI_THERMAL_TPEC_16:
5996 if (idx >= 8 && idx <= 15) {
5997 t = TP_EC_THERMAL_TMP8;
5998 idx -= 8;
5999 }
6000 /* fallthrough */
6001#endif
6002 case TPACPI_THERMAL_TPEC_8:
6003 if (idx <= 7) {
6004 if (!acpi_ec_read(t + idx, &tmp))
6005 return -EIO;
6006 *value = tmp * 1000;
6007 return 0;
6008 }
6009 break;
6010
6011 case TPACPI_THERMAL_ACPI_UPDT:
6012 if (idx <= 7) {
6013 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6014 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6015 return -EIO;
6016 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6017 return -EIO;
6018 *value = (t - 2732) * 100;
6019 return 0;
6020 }
6021 break;
6022
6023 case TPACPI_THERMAL_ACPI_TMP07:
6024 if (idx <= 7) {
6025 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6026 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6027 return -EIO;
6028 if (t > 127 || t < -127)
6029 t = TP_EC_THERMAL_TMP_NA;
6030 *value = t * 1000;
6031 return 0;
6032 }
6033 break;
6034
6035 case TPACPI_THERMAL_NONE:
6036 default:
6037 return -ENOSYS;
6038 }
6039
6040 return -EINVAL;
6041}
6042
6043static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6044{
6045 int res, i;
6046 int n;
6047
6048 n = 8;
6049 i = 0;
6050
6051 if (!s)
6052 return -EINVAL;
6053
6054 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6055 n = 16;
6056
6057 for (i = 0 ; i < n; i++) {
6058 res = thermal_get_sensor(i, &s->temp[i]);
6059 if (res)
6060 return res;
6061 }
6062
6063 return n;
6064}
6065
6066static void thermal_dump_all_sensors(void)
6067{
6068 int n, i;
6069 struct ibm_thermal_sensors_struct t;
6070
6071 n = thermal_get_sensors(&t);
6072 if (n <= 0)
6073 return;
6074
6075 pr_notice("temperatures (Celsius):");
6076
6077 for (i = 0; i < n; i++) {
6078 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6079 pr_cont(" %d", (int)(t.temp[i] / 1000));
6080 else
6081 pr_cont(" N/A");
6082 }
6083
6084 pr_cont("\n");
6085}
6086
6087/* sysfs temp##_input -------------------------------------------------- */
6088
6089static ssize_t thermal_temp_input_show(struct device *dev,
6090 struct device_attribute *attr,
6091 char *buf)
6092{
6093 struct sensor_device_attribute *sensor_attr =
6094 to_sensor_dev_attr(attr);
6095 int idx = sensor_attr->index;
6096 s32 value;
6097 int res;
6098
6099 res = thermal_get_sensor(idx, &value);
6100 if (res)
6101 return res;
6102 if (value == TPACPI_THERMAL_SENSOR_NA)
6103 return -ENXIO;
6104
6105 return snprintf(buf, PAGE_SIZE, "%d\n", value);
6106}
6107
6108#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6109 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6110 thermal_temp_input_show, NULL, _idxB)
6111
6112static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6113 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6114 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6115 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6116 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6117 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6118 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6119 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6120 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6121 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6122 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6123 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6124 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6125 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6126 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6127 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6128 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6129};
6130
6131#define THERMAL_ATTRS(X) \
6132 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6133
6134static struct attribute *thermal_temp_input_attr[] = {
6135 THERMAL_ATTRS(8),
6136 THERMAL_ATTRS(9),
6137 THERMAL_ATTRS(10),
6138 THERMAL_ATTRS(11),
6139 THERMAL_ATTRS(12),
6140 THERMAL_ATTRS(13),
6141 THERMAL_ATTRS(14),
6142 THERMAL_ATTRS(15),
6143 THERMAL_ATTRS(0),
6144 THERMAL_ATTRS(1),
6145 THERMAL_ATTRS(2),
6146 THERMAL_ATTRS(3),
6147 THERMAL_ATTRS(4),
6148 THERMAL_ATTRS(5),
6149 THERMAL_ATTRS(6),
6150 THERMAL_ATTRS(7),
6151 NULL
6152};
6153
6154static const struct attribute_group thermal_temp_input16_group = {
6155 .attrs = thermal_temp_input_attr
6156};
6157
6158static const struct attribute_group thermal_temp_input8_group = {
6159 .attrs = &thermal_temp_input_attr[8]
6160};
6161
6162#undef THERMAL_SENSOR_ATTR_TEMP
6163#undef THERMAL_ATTRS
6164
6165/* --------------------------------------------------------------------- */
6166
6167static int __init thermal_init(struct ibm_init_struct *iibm)
6168{
6169 u8 t, ta1, ta2;
6170 int i;
6171 int acpi_tmp7;
6172 int res;
6173
6174 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6175
6176 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6177
6178 if (thinkpad_id.ec_model) {
6179 /*
6180 * Direct EC access mode: sensors at registers
6181 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6182 * non-implemented, thermal sensors return 0x80 when
6183 * not available
6184 */
6185
6186 ta1 = ta2 = 0;
6187 for (i = 0; i < 8; i++) {
6188 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6189 ta1 |= t;
6190 } else {
6191 ta1 = 0;
6192 break;
6193 }
6194 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6195 ta2 |= t;
6196 } else {
6197 ta1 = 0;
6198 break;
6199 }
6200 }
6201 if (ta1 == 0) {
6202 /* This is sheer paranoia, but we handle it anyway */
6203 if (acpi_tmp7) {
6204 pr_err("ThinkPad ACPI EC access misbehaving, "
6205 "falling back to ACPI TMPx access "
6206 "mode\n");
6207 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6208 } else {
6209 pr_err("ThinkPad ACPI EC access misbehaving, "
6210 "disabling thermal sensors access\n");
6211 thermal_read_mode = TPACPI_THERMAL_NONE;
6212 }
6213 } else {
6214 thermal_read_mode =
6215 (ta2 != 0) ?
6216 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6217 }
6218 } else if (acpi_tmp7) {
6219 if (tpacpi_is_ibm() &&
6220 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6221 /* 600e/x, 770e, 770x */
6222 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6223 } else {
6224 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6225 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6226 }
6227 } else {
6228 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6229 thermal_read_mode = TPACPI_THERMAL_NONE;
6230 }
6231
6232 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6233 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6234 thermal_read_mode);
6235
6236 switch (thermal_read_mode) {
6237 case TPACPI_THERMAL_TPEC_16:
6238 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
6239 &thermal_temp_input16_group);
6240 if (res)
6241 return res;
6242 break;
6243 case TPACPI_THERMAL_TPEC_8:
6244 case TPACPI_THERMAL_ACPI_TMP07:
6245 case TPACPI_THERMAL_ACPI_UPDT:
6246 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
6247 &thermal_temp_input8_group);
6248 if (res)
6249 return res;
6250 break;
6251 case TPACPI_THERMAL_NONE:
6252 default:
6253 return 1;
6254 }
6255
6256 return 0;
6257}
6258
6259static void thermal_exit(void)
6260{
6261 switch (thermal_read_mode) {
6262 case TPACPI_THERMAL_TPEC_16:
6263 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
6264 &thermal_temp_input16_group);
6265 break;
6266 case TPACPI_THERMAL_TPEC_8:
6267 case TPACPI_THERMAL_ACPI_TMP07:
6268 case TPACPI_THERMAL_ACPI_UPDT:
6269 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
6270 &thermal_temp_input8_group);
6271 break;
6272 case TPACPI_THERMAL_NONE:
6273 default:
6274 break;
6275 }
6276}
6277
6278static int thermal_read(struct seq_file *m)
6279{
6280 int n, i;
6281 struct ibm_thermal_sensors_struct t;
6282
6283 n = thermal_get_sensors(&t);
6284 if (unlikely(n < 0))
6285 return n;
6286
6287 seq_printf(m, "temperatures:\t");
6288
6289 if (n > 0) {
6290 for (i = 0; i < (n - 1); i++)
6291 seq_printf(m, "%d ", t.temp[i] / 1000);
6292 seq_printf(m, "%d\n", t.temp[i] / 1000);
6293 } else
6294 seq_printf(m, "not supported\n");
6295
6296 return 0;
6297}
6298
6299static struct ibm_struct thermal_driver_data = {
6300 .name = "thermal",
6301 .read = thermal_read,
6302 .exit = thermal_exit,
6303};
6304
6305/*************************************************************************
6306 * Backlight/brightness subdriver
6307 */
6308
6309#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6310
6311/*
6312 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6313 * CMOS NVRAM byte 0x5E, bits 0-3.
6314 *
6315 * EC HBRV (0x31) has the following layout
6316 * Bit 7: unknown function
6317 * Bit 6: unknown function
6318 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6319 * Bit 4: must be set to zero to avoid problems
6320 * Bit 3-0: backlight brightness level
6321 *
6322 * brightness_get_raw returns status data in the HBRV layout
6323 *
6324 * WARNING: The X61 has been verified to use HBRV for something else, so
6325 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6326 * testing on the very early *60 Lenovo models...
6327 */
6328
6329enum {
6330 TP_EC_BACKLIGHT = 0x31,
6331
6332 /* TP_EC_BACKLIGHT bitmasks */
6333 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6334 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6335 TP_EC_BACKLIGHT_MAPSW = 0x20,
6336};
6337
6338enum tpacpi_brightness_access_mode {
6339 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6340 TPACPI_BRGHT_MODE_EC, /* EC control */
6341 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6342 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6343 TPACPI_BRGHT_MODE_MAX
6344};
6345
6346static struct backlight_device *ibm_backlight_device;
6347
6348static enum tpacpi_brightness_access_mode brightness_mode =
6349 TPACPI_BRGHT_MODE_MAX;
6350
6351static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6352
6353static struct mutex brightness_mutex;
6354
6355/* NVRAM brightness access,
6356 * call with brightness_mutex held! */
6357static unsigned int tpacpi_brightness_nvram_get(void)
6358{
6359 u8 lnvram;
6360
6361 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6362 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6363 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6364 lnvram &= bright_maxlvl;
6365
6366 return lnvram;
6367}
6368
6369static void tpacpi_brightness_checkpoint_nvram(void)
6370{
6371 u8 lec = 0;
6372 u8 b_nvram;
6373
6374 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6375 return;
6376
6377 vdbg_printk(TPACPI_DBG_BRGHT,
6378 "trying to checkpoint backlight level to NVRAM...\n");
6379
6380 if (mutex_lock_killable(&brightness_mutex) < 0)
6381 return;
6382
6383 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6384 goto unlock;
6385 lec &= TP_EC_BACKLIGHT_LVLMSK;
6386 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6387
6388 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6389 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6390 /* NVRAM needs update */
6391 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6392 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6393 b_nvram |= lec;
6394 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6395 dbg_printk(TPACPI_DBG_BRGHT,
6396 "updated NVRAM backlight level to %u (0x%02x)\n",
6397 (unsigned int) lec, (unsigned int) b_nvram);
6398 } else
6399 vdbg_printk(TPACPI_DBG_BRGHT,
6400 "NVRAM backlight level already is %u (0x%02x)\n",
6401 (unsigned int) lec, (unsigned int) b_nvram);
6402
6403unlock:
6404 mutex_unlock(&brightness_mutex);
6405}
6406
6407
6408/* call with brightness_mutex held! */
6409static int tpacpi_brightness_get_raw(int *status)
6410{
6411 u8 lec = 0;
6412
6413 switch (brightness_mode) {
6414 case TPACPI_BRGHT_MODE_UCMS_STEP:
6415 *status = tpacpi_brightness_nvram_get();
6416 return 0;
6417 case TPACPI_BRGHT_MODE_EC:
6418 case TPACPI_BRGHT_MODE_ECNVRAM:
6419 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6420 return -EIO;
6421 *status = lec;
6422 return 0;
6423 default:
6424 return -ENXIO;
6425 }
6426}
6427
6428/* call with brightness_mutex held! */
6429/* do NOT call with illegal backlight level value */
6430static int tpacpi_brightness_set_ec(unsigned int value)
6431{
6432 u8 lec = 0;
6433
6434 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6435 return -EIO;
6436
6437 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6438 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6439 (value & TP_EC_BACKLIGHT_LVLMSK))))
6440 return -EIO;
6441
6442 return 0;
6443}
6444
6445/* call with brightness_mutex held! */
6446static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6447{
6448 int cmos_cmd, inc;
6449 unsigned int current_value, i;
6450
6451 current_value = tpacpi_brightness_nvram_get();
6452
6453 if (value == current_value)
6454 return 0;
6455
6456 cmos_cmd = (value > current_value) ?
6457 TP_CMOS_BRIGHTNESS_UP :
6458 TP_CMOS_BRIGHTNESS_DOWN;
6459 inc = (value > current_value) ? 1 : -1;
6460
6461 for (i = current_value; i != value; i += inc)
6462 if (issue_thinkpad_cmos_command(cmos_cmd))
6463 return -EIO;
6464
6465 return 0;
6466}
6467
6468/* May return EINTR which can always be mapped to ERESTARTSYS */
6469static int brightness_set(unsigned int value)
6470{
6471 int res;
6472
6473 if (value > bright_maxlvl)
6474 return -EINVAL;
6475
6476 vdbg_printk(TPACPI_DBG_BRGHT,
6477 "set backlight level to %d\n", value);
6478
6479 res = mutex_lock_killable(&brightness_mutex);
6480 if (res < 0)
6481 return res;
6482
6483 switch (brightness_mode) {
6484 case TPACPI_BRGHT_MODE_EC:
6485 case TPACPI_BRGHT_MODE_ECNVRAM:
6486 res = tpacpi_brightness_set_ec(value);
6487 break;
6488 case TPACPI_BRGHT_MODE_UCMS_STEP:
6489 res = tpacpi_brightness_set_ucmsstep(value);
6490 break;
6491 default:
6492 res = -ENXIO;
6493 }
6494
6495 mutex_unlock(&brightness_mutex);
6496 return res;
6497}
6498
6499/* sysfs backlight class ----------------------------------------------- */
6500
6501static int brightness_update_status(struct backlight_device *bd)
6502{
6503 unsigned int level =
6504 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6505 bd->props.power == FB_BLANK_UNBLANK) ?
6506 bd->props.brightness : 0;
6507
6508 dbg_printk(TPACPI_DBG_BRGHT,
6509 "backlight: attempt to set level to %d\n",
6510 level);
6511
6512 /* it is the backlight class's job (caller) to handle
6513 * EINTR and other errors properly */
6514 return brightness_set(level);
6515}
6516
6517static int brightness_get(struct backlight_device *bd)
6518{
6519 int status, res;
6520
6521 res = mutex_lock_killable(&brightness_mutex);
6522 if (res < 0)
6523 return 0;
6524
6525 res = tpacpi_brightness_get_raw(&status);
6526
6527 mutex_unlock(&brightness_mutex);
6528
6529 if (res < 0)
6530 return 0;
6531
6532 return status & TP_EC_BACKLIGHT_LVLMSK;
6533}
6534
6535static void tpacpi_brightness_notify_change(void)
6536{
6537 backlight_force_update(ibm_backlight_device,
6538 BACKLIGHT_UPDATE_HOTKEY);
6539}
6540
6541static const struct backlight_ops ibm_backlight_data = {
6542 .get_brightness = brightness_get,
6543 .update_status = brightness_update_status,
6544};
6545
6546/* --------------------------------------------------------------------- */
6547
6548/*
6549 * Call _BCL method of video device. On some ThinkPads this will
6550 * switch the firmware to the ACPI brightness control mode.
6551 */
6552
6553static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6554{
6555 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6556 union acpi_object *obj;
6557 struct acpi_device *device, *child;
6558 int rc;
6559
6560 if (acpi_bus_get_device(handle, &device))
6561 return 0;
6562
6563 rc = 0;
6564 list_for_each_entry(child, &device->children, node) {
6565 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6566 NULL, &buffer);
6567 if (ACPI_FAILURE(status))
6568 continue;
6569
6570 obj = (union acpi_object *)buffer.pointer;
6571 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6572 pr_err("Unknown _BCL data, please report this to %s\n",
6573 TPACPI_MAIL);
6574 rc = 0;
6575 } else {
6576 rc = obj->package.count;
6577 }
6578 break;
6579 }
6580
6581 kfree(buffer.pointer);
6582 return rc;
6583}
6584
6585
6586/*
6587 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6588 */
6589static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6590{
6591 acpi_handle video_device;
6592 int bcl_levels = 0;
6593
6594 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6595 if (video_device)
6596 bcl_levels = tpacpi_query_bcl_levels(video_device);
6597
6598 tp_features.bright_acpimode = (bcl_levels > 0);
6599
6600 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6601}
6602
6603/*
6604 * These are only useful for models that have only one possibility
6605 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6606 * these quirks.
6607 */
6608#define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6609#define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6610#define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6611
6612static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6613 /* Models with ATI GPUs known to require ECNVRAM mode */
6614 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6615
6616 /* Models with ATI GPUs that can use ECNVRAM */
6617 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6618 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6619 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6620 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6621
6622 /* Models with Intel Extreme Graphics 2 */
6623 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6624 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6625 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6626
6627 /* Models with Intel GMA900 */
6628 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6629 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6630 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6631};
6632
6633/*
6634 * Returns < 0 for error, otherwise sets tp_features.bright_*
6635 * and bright_maxlvl.
6636 */
6637static void __init tpacpi_detect_brightness_capabilities(void)
6638{
6639 unsigned int b;
6640
6641 vdbg_printk(TPACPI_DBG_INIT,
6642 "detecting firmware brightness interface capabilities\n");
6643
6644 /* we could run a quirks check here (same table used by
6645 * brightness_init) if needed */
6646
6647 /*
6648 * We always attempt to detect acpi support, so as to switch
6649 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6650 * going to publish a backlight interface
6651 */
6652 b = tpacpi_check_std_acpi_brightness_support();
6653 switch (b) {
6654 case 16:
6655 bright_maxlvl = 15;
6656 break;
6657 case 8:
6658 case 0:
6659 bright_maxlvl = 7;
6660 break;
6661 default:
6662 tp_features.bright_unkfw = 1;
6663 bright_maxlvl = b - 1;
6664 }
6665 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6666}
6667
6668static int __init brightness_init(struct ibm_init_struct *iibm)
6669{
6670 struct backlight_properties props;
6671 int b;
6672 unsigned long quirks;
6673
6674 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6675
6676 mutex_init(&brightness_mutex);
6677
6678 quirks = tpacpi_check_quirks(brightness_quirk_table,
6679 ARRAY_SIZE(brightness_quirk_table));
6680
6681 /* tpacpi_detect_brightness_capabilities() must have run already */
6682
6683 /* if it is unknown, we don't handle it: it wouldn't be safe */
6684 if (tp_features.bright_unkfw)
6685 return 1;
6686
6687 if (!brightness_enable) {
6688 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6689 "brightness support disabled by "
6690 "module parameter\n");
6691 return 1;
6692 }
6693
6694 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6695 if (brightness_enable > 1) {
6696 pr_info("Standard ACPI backlight interface "
6697 "available, not loading native one\n");
6698 return 1;
6699 } else if (brightness_enable == 1) {
6700 pr_warn("Cannot enable backlight brightness support, "
6701 "ACPI is already handling it. Refer to the "
6702 "acpi_backlight kernel parameter.\n");
6703 return 1;
6704 }
6705 } else if (tp_features.bright_acpimode && brightness_enable > 1) {
6706 pr_notice("Standard ACPI backlight interface not "
6707 "available, thinkpad_acpi native "
6708 "brightness control enabled\n");
6709 }
6710
6711 /*
6712 * Check for module parameter bogosity, note that we
6713 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6714 * able to detect "unspecified"
6715 */
6716 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6717 return -EINVAL;
6718
6719 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6720 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6721 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6722 if (quirks & TPACPI_BRGHT_Q_EC)
6723 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6724 else
6725 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6726
6727 dbg_printk(TPACPI_DBG_BRGHT,
6728 "driver auto-selected brightness_mode=%d\n",
6729 brightness_mode);
6730 }
6731
6732 /* Safety */
6733 if (!tpacpi_is_ibm() &&
6734 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6735 brightness_mode == TPACPI_BRGHT_MODE_EC))
6736 return -EINVAL;
6737
6738 if (tpacpi_brightness_get_raw(&b) < 0)
6739 return 1;
6740
6741 memset(&props, 0, sizeof(struct backlight_properties));
6742 props.type = BACKLIGHT_PLATFORM;
6743 props.max_brightness = bright_maxlvl;
6744 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6745 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
6746 NULL, NULL,
6747 &ibm_backlight_data,
6748 &props);
6749 if (IS_ERR(ibm_backlight_device)) {
6750 int rc = PTR_ERR(ibm_backlight_device);
6751 ibm_backlight_device = NULL;
6752 pr_err("Could not register backlight device\n");
6753 return rc;
6754 }
6755 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6756 "brightness is supported\n");
6757
6758 if (quirks & TPACPI_BRGHT_Q_ASK) {
6759 pr_notice("brightness: will use unverified default: "
6760 "brightness_mode=%d\n", brightness_mode);
6761 pr_notice("brightness: please report to %s whether it works well "
6762 "or not on your ThinkPad\n", TPACPI_MAIL);
6763 }
6764
6765 /* Added by mistake in early 2007. Probably useless, but it could
6766 * be working around some unknown firmware problem where the value
6767 * read at startup doesn't match the real hardware state... so leave
6768 * it in place just in case */
6769 backlight_update_status(ibm_backlight_device);
6770
6771 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6772 "brightness: registering brightness hotkeys "
6773 "as change notification\n");
6774 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
6775 | TP_ACPI_HKEY_BRGHTUP_MASK
6776 | TP_ACPI_HKEY_BRGHTDWN_MASK);
6777 return 0;
6778}
6779
6780static void brightness_suspend(void)
6781{
6782 tpacpi_brightness_checkpoint_nvram();
6783}
6784
6785static void brightness_shutdown(void)
6786{
6787 tpacpi_brightness_checkpoint_nvram();
6788}
6789
6790static void brightness_exit(void)
6791{
6792 if (ibm_backlight_device) {
6793 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6794 "calling backlight_device_unregister()\n");
6795 backlight_device_unregister(ibm_backlight_device);
6796 }
6797
6798 tpacpi_brightness_checkpoint_nvram();
6799}
6800
6801static int brightness_read(struct seq_file *m)
6802{
6803 int level;
6804
6805 level = brightness_get(NULL);
6806 if (level < 0) {
6807 seq_printf(m, "level:\t\tunreadable\n");
6808 } else {
6809 seq_printf(m, "level:\t\t%d\n", level);
6810 seq_printf(m, "commands:\tup, down\n");
6811 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
6812 bright_maxlvl);
6813 }
6814
6815 return 0;
6816}
6817
6818static int brightness_write(char *buf)
6819{
6820 int level;
6821 int rc;
6822 char *cmd;
6823
6824 level = brightness_get(NULL);
6825 if (level < 0)
6826 return level;
6827
6828 while ((cmd = next_cmd(&buf))) {
6829 if (strlencmp(cmd, "up") == 0) {
6830 if (level < bright_maxlvl)
6831 level++;
6832 } else if (strlencmp(cmd, "down") == 0) {
6833 if (level > 0)
6834 level--;
6835 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6836 level >= 0 && level <= bright_maxlvl) {
6837 /* new level set */
6838 } else
6839 return -EINVAL;
6840 }
6841
6842 tpacpi_disclose_usertask("procfs brightness",
6843 "set level to %d\n", level);
6844
6845 /*
6846 * Now we know what the final level should be, so we try to set it.
6847 * Doing it this way makes the syscall restartable in case of EINTR
6848 */
6849 rc = brightness_set(level);
6850 if (!rc && ibm_backlight_device)
6851 backlight_force_update(ibm_backlight_device,
6852 BACKLIGHT_UPDATE_SYSFS);
6853 return (rc == -EINTR) ? -ERESTARTSYS : rc;
6854}
6855
6856static struct ibm_struct brightness_driver_data = {
6857 .name = "brightness",
6858 .read = brightness_read,
6859 .write = brightness_write,
6860 .exit = brightness_exit,
6861 .suspend = brightness_suspend,
6862 .shutdown = brightness_shutdown,
6863};
6864
6865/*************************************************************************
6866 * Volume subdriver
6867 */
6868
6869/*
6870 * IBM ThinkPads have a simple volume controller with MUTE gating.
6871 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
6872 *
6873 * Since the *61 series (and probably also the later *60 series), Lenovo
6874 * ThinkPads only implement the MUTE gate.
6875 *
6876 * EC register 0x30
6877 * Bit 6: MUTE (1 mutes sound)
6878 * Bit 3-0: Volume
6879 * Other bits should be zero as far as we know.
6880 *
6881 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
6882 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
6883 * such as bit 7 which is used to detect repeated presses of MUTE,
6884 * and we leave them unchanged.
6885 *
6886 * On newer Lenovo ThinkPads, the EC can automatically change the volume
6887 * in response to user input. Unfortunately, this rarely works well.
6888 * The laptop changes the state of its internal MUTE gate and, on some
6889 * models, sends KEY_MUTE, causing any user code that responds to the
6890 * mute button to get confused. The hardware MUTE gate is also
6891 * unnecessary, since user code can handle the mute button without
6892 * kernel or EC help.
6893 *
6894 * To avoid confusing userspace, we simply disable all EC-based mute
6895 * and volume controls when possible.
6896 */
6897
6898#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
6899
6900#define TPACPI_ALSA_DRVNAME "ThinkPad EC"
6901#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
6902#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
6903
6904#if SNDRV_CARDS <= 32
6905#define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
6906#else
6907#define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
6908#endif
6909static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
6910static char *alsa_id = "ThinkPadEC";
6911static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
6912
6913struct tpacpi_alsa_data {
6914 struct snd_card *card;
6915 struct snd_ctl_elem_id *ctl_mute_id;
6916 struct snd_ctl_elem_id *ctl_vol_id;
6917};
6918
6919static struct snd_card *alsa_card;
6920
6921enum {
6922 TP_EC_AUDIO = 0x30,
6923
6924 /* TP_EC_AUDIO bits */
6925 TP_EC_AUDIO_MUTESW = 6,
6926
6927 /* TP_EC_AUDIO bitmasks */
6928 TP_EC_AUDIO_LVL_MSK = 0x0F,
6929 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
6930
6931 /* Maximum volume */
6932 TP_EC_VOLUME_MAX = 14,
6933};
6934
6935enum tpacpi_volume_access_mode {
6936 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
6937 TPACPI_VOL_MODE_EC, /* Pure EC control */
6938 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
6939 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6940 TPACPI_VOL_MODE_MAX
6941};
6942
6943enum tpacpi_volume_capabilities {
6944 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
6945 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
6946 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
6947 TPACPI_VOL_CAP_MAX
6948};
6949
6950enum tpacpi_mute_btn_mode {
6951 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
6952 /* We don't know what mode 1 is. */
6953 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
6954 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
6955};
6956
6957static enum tpacpi_volume_access_mode volume_mode =
6958 TPACPI_VOL_MODE_MAX;
6959
6960static enum tpacpi_volume_capabilities volume_capabilities;
6961static bool volume_control_allowed;
6962static bool software_mute_requested = true;
6963static bool software_mute_active;
6964static int software_mute_orig_mode;
6965
6966/*
6967 * Used to syncronize writers to TP_EC_AUDIO and
6968 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
6969 */
6970static struct mutex volume_mutex;
6971
6972static void tpacpi_volume_checkpoint_nvram(void)
6973{
6974 u8 lec = 0;
6975 u8 b_nvram;
6976 u8 ec_mask;
6977
6978 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
6979 return;
6980 if (!volume_control_allowed)
6981 return;
6982 if (software_mute_active)
6983 return;
6984
6985 vdbg_printk(TPACPI_DBG_MIXER,
6986 "trying to checkpoint mixer state to NVRAM...\n");
6987
6988 if (tp_features.mixer_no_level_control)
6989 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
6990 else
6991 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
6992
6993 if (mutex_lock_killable(&volume_mutex) < 0)
6994 return;
6995
6996 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
6997 goto unlock;
6998 lec &= ec_mask;
6999 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7000
7001 if (lec != (b_nvram & ec_mask)) {
7002 /* NVRAM needs update */
7003 b_nvram &= ~ec_mask;
7004 b_nvram |= lec;
7005 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7006 dbg_printk(TPACPI_DBG_MIXER,
7007 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7008 (unsigned int) lec, (unsigned int) b_nvram);
7009 } else {
7010 vdbg_printk(TPACPI_DBG_MIXER,
7011 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7012 (unsigned int) lec, (unsigned int) b_nvram);
7013 }
7014
7015unlock:
7016 mutex_unlock(&volume_mutex);
7017}
7018
7019static int volume_get_status_ec(u8 *status)
7020{
7021 u8 s;
7022
7023 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7024 return -EIO;
7025
7026 *status = s;
7027
7028 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7029
7030 return 0;
7031}
7032
7033static int volume_get_status(u8 *status)
7034{
7035 return volume_get_status_ec(status);
7036}
7037
7038static int volume_set_status_ec(const u8 status)
7039{
7040 if (!acpi_ec_write(TP_EC_AUDIO, status))
7041 return -EIO;
7042
7043 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7044
7045 /*
7046 * On X200s, and possibly on others, it can take a while for
7047 * reads to become correct.
7048 */
7049 msleep(1);
7050
7051 return 0;
7052}
7053
7054static int volume_set_status(const u8 status)
7055{
7056 return volume_set_status_ec(status);
7057}
7058
7059/* returns < 0 on error, 0 on no change, 1 on change */
7060static int __volume_set_mute_ec(const bool mute)
7061{
7062 int rc;
7063 u8 s, n;
7064
7065 if (mutex_lock_killable(&volume_mutex) < 0)
7066 return -EINTR;
7067
7068 rc = volume_get_status_ec(&s);
7069 if (rc)
7070 goto unlock;
7071
7072 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7073 s & ~TP_EC_AUDIO_MUTESW_MSK;
7074
7075 if (n != s) {
7076 rc = volume_set_status_ec(n);
7077 if (!rc)
7078 rc = 1;
7079 }
7080
7081unlock:
7082 mutex_unlock(&volume_mutex);
7083 return rc;
7084}
7085
7086static int volume_alsa_set_mute(const bool mute)
7087{
7088 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7089 (mute) ? "" : "un");
7090 return __volume_set_mute_ec(mute);
7091}
7092
7093static int volume_set_mute(const bool mute)
7094{
7095 int rc;
7096
7097 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7098 (mute) ? "" : "un");
7099
7100 rc = __volume_set_mute_ec(mute);
7101 return (rc < 0) ? rc : 0;
7102}
7103
7104/* returns < 0 on error, 0 on no change, 1 on change */
7105static int __volume_set_volume_ec(const u8 vol)
7106{
7107 int rc;
7108 u8 s, n;
7109
7110 if (vol > TP_EC_VOLUME_MAX)
7111 return -EINVAL;
7112
7113 if (mutex_lock_killable(&volume_mutex) < 0)
7114 return -EINTR;
7115
7116 rc = volume_get_status_ec(&s);
7117 if (rc)
7118 goto unlock;
7119
7120 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7121
7122 if (n != s) {
7123 rc = volume_set_status_ec(n);
7124 if (!rc)
7125 rc = 1;
7126 }
7127
7128unlock:
7129 mutex_unlock(&volume_mutex);
7130 return rc;
7131}
7132
7133static int volume_set_software_mute(bool startup)
7134{
7135 int result;
7136
7137 if (!tpacpi_is_lenovo())
7138 return -ENODEV;
7139
7140 if (startup) {
7141 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7142 "HAUM", "qd"))
7143 return -EIO;
7144
7145 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7146 "Initial HAUM setting was %d\n",
7147 software_mute_orig_mode);
7148 }
7149
7150 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7151 (int)TP_EC_MUTE_BTN_NONE))
7152 return -EIO;
7153
7154 if (result != TP_EC_MUTE_BTN_NONE)
7155 pr_warn("Unexpected SAUM result %d\n",
7156 result);
7157
7158 /*
7159 * In software mute mode, the standard codec controls take
7160 * precendence, so we unmute the ThinkPad HW switch at
7161 * startup. Just on case there are SAUM-capable ThinkPads
7162 * with level controls, set max HW volume as well.
7163 */
7164 if (tp_features.mixer_no_level_control)
7165 result = volume_set_mute(false);
7166 else
7167 result = volume_set_status(TP_EC_VOLUME_MAX);
7168
7169 if (result != 0)
7170 pr_warn("Failed to unmute the HW mute switch\n");
7171
7172 return 0;
7173}
7174
7175static void volume_exit_software_mute(void)
7176{
7177 int r;
7178
7179 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7180 || r != software_mute_orig_mode)
7181 pr_warn("Failed to restore mute mode\n");
7182}
7183
7184static int volume_alsa_set_volume(const u8 vol)
7185{
7186 dbg_printk(TPACPI_DBG_MIXER,
7187 "ALSA: trying to set volume level to %hu\n", vol);
7188 return __volume_set_volume_ec(vol);
7189}
7190
7191static void volume_alsa_notify_change(void)
7192{
7193 struct tpacpi_alsa_data *d;
7194
7195 if (alsa_card && alsa_card->private_data) {
7196 d = alsa_card->private_data;
7197 if (d->ctl_mute_id)
7198 snd_ctl_notify(alsa_card,
7199 SNDRV_CTL_EVENT_MASK_VALUE,
7200 d->ctl_mute_id);
7201 if (d->ctl_vol_id)
7202 snd_ctl_notify(alsa_card,
7203 SNDRV_CTL_EVENT_MASK_VALUE,
7204 d->ctl_vol_id);
7205 }
7206}
7207
7208static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7209 struct snd_ctl_elem_info *uinfo)
7210{
7211 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7212 uinfo->count = 1;
7213 uinfo->value.integer.min = 0;
7214 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7215 return 0;
7216}
7217
7218static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7219 struct snd_ctl_elem_value *ucontrol)
7220{
7221 u8 s;
7222 int rc;
7223
7224 rc = volume_get_status(&s);
7225 if (rc < 0)
7226 return rc;
7227
7228 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7229 return 0;
7230}
7231
7232static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7233 struct snd_ctl_elem_value *ucontrol)
7234{
7235 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7236 ucontrol->value.integer.value[0]);
7237 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7238}
7239
7240#define volume_alsa_mute_info snd_ctl_boolean_mono_info
7241
7242static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7243 struct snd_ctl_elem_value *ucontrol)
7244{
7245 u8 s;
7246 int rc;
7247
7248 rc = volume_get_status(&s);
7249 if (rc < 0)
7250 return rc;
7251
7252 ucontrol->value.integer.value[0] =
7253 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7254 return 0;
7255}
7256
7257static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7258 struct snd_ctl_elem_value *ucontrol)
7259{
7260 tpacpi_disclose_usertask("ALSA", "%smute\n",
7261 ucontrol->value.integer.value[0] ?
7262 "un" : "");
7263 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7264}
7265
7266static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7267 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7268 .name = "Console Playback Volume",
7269 .index = 0,
7270 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7271 .info = volume_alsa_vol_info,
7272 .get = volume_alsa_vol_get,
7273};
7274
7275static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7276 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7277 .name = "Console Playback Switch",
7278 .index = 0,
7279 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7280 .info = volume_alsa_mute_info,
7281 .get = volume_alsa_mute_get,
7282};
7283
7284static void volume_suspend(void)
7285{
7286 tpacpi_volume_checkpoint_nvram();
7287}
7288
7289static void volume_resume(void)
7290{
7291 if (software_mute_active) {
7292 if (volume_set_software_mute(false) < 0)
7293 pr_warn("Failed to restore software mute\n");
7294 } else {
7295 volume_alsa_notify_change();
7296 }
7297}
7298
7299static void volume_shutdown(void)
7300{
7301 tpacpi_volume_checkpoint_nvram();
7302}
7303
7304static void volume_exit(void)
7305{
7306 if (alsa_card) {
7307 snd_card_free(alsa_card);
7308 alsa_card = NULL;
7309 }
7310
7311 tpacpi_volume_checkpoint_nvram();
7312
7313 if (software_mute_active)
7314 volume_exit_software_mute();
7315}
7316
7317static int __init volume_create_alsa_mixer(void)
7318{
7319 struct snd_card *card;
7320 struct tpacpi_alsa_data *data;
7321 struct snd_kcontrol *ctl_vol;
7322 struct snd_kcontrol *ctl_mute;
7323 int rc;
7324
7325 rc = snd_card_new(&tpacpi_pdev->dev,
7326 alsa_index, alsa_id, THIS_MODULE,
7327 sizeof(struct tpacpi_alsa_data), &card);
7328 if (rc < 0 || !card) {
7329 pr_err("Failed to create ALSA card structures: %d\n", rc);
7330 return 1;
7331 }
7332
7333 BUG_ON(!card->private_data);
7334 data = card->private_data;
7335 data->card = card;
7336
7337 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7338 sizeof(card->driver));
7339 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7340 sizeof(card->shortname));
7341 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7342 (thinkpad_id.ec_version_str) ?
7343 thinkpad_id.ec_version_str : "(unknown)");
7344 snprintf(card->longname, sizeof(card->longname),
7345 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7346 (thinkpad_id.ec_version_str) ?
7347 thinkpad_id.ec_version_str : "unknown");
7348
7349 if (volume_control_allowed) {
7350 volume_alsa_control_vol.put = volume_alsa_vol_put;
7351 volume_alsa_control_vol.access =
7352 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7353
7354 volume_alsa_control_mute.put = volume_alsa_mute_put;
7355 volume_alsa_control_mute.access =
7356 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7357 }
7358
7359 if (!tp_features.mixer_no_level_control) {
7360 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7361 rc = snd_ctl_add(card, ctl_vol);
7362 if (rc < 0) {
7363 pr_err("Failed to create ALSA volume control: %d\n",
7364 rc);
7365 goto err_exit;
7366 }
7367 data->ctl_vol_id = &ctl_vol->id;
7368 }
7369
7370 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7371 rc = snd_ctl_add(card, ctl_mute);
7372 if (rc < 0) {
7373 pr_err("Failed to create ALSA mute control: %d\n", rc);
7374 goto err_exit;
7375 }
7376 data->ctl_mute_id = &ctl_mute->id;
7377
7378 rc = snd_card_register(card);
7379 if (rc < 0) {
7380 pr_err("Failed to register ALSA card: %d\n", rc);
7381 goto err_exit;
7382 }
7383
7384 alsa_card = card;
7385 return 0;
7386
7387err_exit:
7388 snd_card_free(card);
7389 return 1;
7390}
7391
7392#define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7393#define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7394
7395static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7396 /* Whitelist volume level on all IBM by default */
7397 { .vendor = PCI_VENDOR_ID_IBM,
7398 .bios = TPACPI_MATCH_ANY,
7399 .ec = TPACPI_MATCH_ANY,
7400 .quirks = TPACPI_VOL_Q_LEVEL },
7401
7402 /* Lenovo models with volume control (needs confirmation) */
7403 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7404 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7405 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7406 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7407 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7408 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7409 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7410
7411 /* Whitelist mute-only on all Lenovo by default */
7412 { .vendor = PCI_VENDOR_ID_LENOVO,
7413 .bios = TPACPI_MATCH_ANY,
7414 .ec = TPACPI_MATCH_ANY,
7415 .quirks = TPACPI_VOL_Q_MUTEONLY }
7416};
7417
7418static int __init volume_init(struct ibm_init_struct *iibm)
7419{
7420 unsigned long quirks;
7421 int rc;
7422
7423 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7424
7425 mutex_init(&volume_mutex);
7426
7427 /*
7428 * Check for module parameter bogosity, note that we
7429 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7430 * able to detect "unspecified"
7431 */
7432 if (volume_mode > TPACPI_VOL_MODE_MAX)
7433 return -EINVAL;
7434
7435 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7436 pr_err("UCMS step volume mode not implemented, "
7437 "please contact %s\n", TPACPI_MAIL);
7438 return 1;
7439 }
7440
7441 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7442 return -EINVAL;
7443
7444 /*
7445 * The ALSA mixer is our primary interface.
7446 * When disabled, don't install the subdriver at all
7447 */
7448 if (!alsa_enable) {
7449 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7450 "ALSA mixer disabled by parameter, "
7451 "not loading volume subdriver...\n");
7452 return 1;
7453 }
7454
7455 quirks = tpacpi_check_quirks(volume_quirk_table,
7456 ARRAY_SIZE(volume_quirk_table));
7457
7458 switch (volume_capabilities) {
7459 case TPACPI_VOL_CAP_AUTO:
7460 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7461 tp_features.mixer_no_level_control = 1;
7462 else if (quirks & TPACPI_VOL_Q_LEVEL)
7463 tp_features.mixer_no_level_control = 0;
7464 else
7465 return 1; /* no mixer */
7466 break;
7467 case TPACPI_VOL_CAP_VOLMUTE:
7468 tp_features.mixer_no_level_control = 0;
7469 break;
7470 case TPACPI_VOL_CAP_MUTEONLY:
7471 tp_features.mixer_no_level_control = 1;
7472 break;
7473 default:
7474 return 1;
7475 }
7476
7477 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7478 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7479 "using user-supplied volume_capabilities=%d\n",
7480 volume_capabilities);
7481
7482 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7483 volume_mode == TPACPI_VOL_MODE_MAX) {
7484 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7485
7486 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7487 "driver auto-selected volume_mode=%d\n",
7488 volume_mode);
7489 } else {
7490 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7491 "using user-supplied volume_mode=%d\n",
7492 volume_mode);
7493 }
7494
7495 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7496 "mute is supported, volume control is %s\n",
7497 str_supported(!tp_features.mixer_no_level_control));
7498
7499 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7500 software_mute_active = true;
7501 } else {
7502 rc = volume_create_alsa_mixer();
7503 if (rc) {
7504 pr_err("Could not create the ALSA mixer interface\n");
7505 return rc;
7506 }
7507
7508 pr_info("Console audio control enabled, mode: %s\n",
7509 (volume_control_allowed) ?
7510 "override (read/write)" :
7511 "monitor (read only)");
7512 }
7513
7514 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7515 "registering volume hotkeys as change notification\n");
7516 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7517 | TP_ACPI_HKEY_VOLUP_MASK
7518 | TP_ACPI_HKEY_VOLDWN_MASK
7519 | TP_ACPI_HKEY_MUTE_MASK);
7520
7521 return 0;
7522}
7523
7524static int volume_read(struct seq_file *m)
7525{
7526 u8 status;
7527
7528 if (volume_get_status(&status) < 0) {
7529 seq_printf(m, "level:\t\tunreadable\n");
7530 } else {
7531 if (tp_features.mixer_no_level_control)
7532 seq_printf(m, "level:\t\tunsupported\n");
7533 else
7534 seq_printf(m, "level:\t\t%d\n",
7535 status & TP_EC_AUDIO_LVL_MSK);
7536
7537 seq_printf(m, "mute:\t\t%s\n",
7538 onoff(status, TP_EC_AUDIO_MUTESW));
7539
7540 if (volume_control_allowed) {
7541 seq_printf(m, "commands:\tunmute, mute\n");
7542 if (!tp_features.mixer_no_level_control) {
7543 seq_printf(m,
7544 "commands:\tup, down\n");
7545 seq_printf(m,
7546 "commands:\tlevel <level>"
7547 " (<level> is 0-%d)\n",
7548 TP_EC_VOLUME_MAX);
7549 }
7550 }
7551 }
7552
7553 return 0;
7554}
7555
7556static int volume_write(char *buf)
7557{
7558 u8 s;
7559 u8 new_level, new_mute;
7560 int l;
7561 char *cmd;
7562 int rc;
7563
7564 /*
7565 * We do allow volume control at driver startup, so that the
7566 * user can set initial state through the volume=... parameter hack.
7567 */
7568 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7569 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7570 tp_warned.volume_ctrl_forbidden = 1;
7571 pr_notice("Console audio control in monitor mode, "
7572 "changes are not allowed\n");
7573 pr_notice("Use the volume_control=1 module parameter "
7574 "to enable volume control\n");
7575 }
7576 return -EPERM;
7577 }
7578
7579 rc = volume_get_status(&s);
7580 if (rc < 0)
7581 return rc;
7582
7583 new_level = s & TP_EC_AUDIO_LVL_MSK;
7584 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7585
7586 while ((cmd = next_cmd(&buf))) {
7587 if (!tp_features.mixer_no_level_control) {
7588 if (strlencmp(cmd, "up") == 0) {
7589 if (new_mute)
7590 new_mute = 0;
7591 else if (new_level < TP_EC_VOLUME_MAX)
7592 new_level++;
7593 continue;
7594 } else if (strlencmp(cmd, "down") == 0) {
7595 if (new_mute)
7596 new_mute = 0;
7597 else if (new_level > 0)
7598 new_level--;
7599 continue;
7600 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7601 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7602 new_level = l;
7603 continue;
7604 }
7605 }
7606 if (strlencmp(cmd, "mute") == 0)
7607 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7608 else if (strlencmp(cmd, "unmute") == 0)
7609 new_mute = 0;
7610 else
7611 return -EINVAL;
7612 }
7613
7614 if (tp_features.mixer_no_level_control) {
7615 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7616 new_mute ? "" : "un");
7617 rc = volume_set_mute(!!new_mute);
7618 } else {
7619 tpacpi_disclose_usertask("procfs volume",
7620 "%smute and set level to %d\n",
7621 new_mute ? "" : "un", new_level);
7622 rc = volume_set_status(new_mute | new_level);
7623 }
7624 volume_alsa_notify_change();
7625
7626 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7627}
7628
7629static struct ibm_struct volume_driver_data = {
7630 .name = "volume",
7631 .read = volume_read,
7632 .write = volume_write,
7633 .exit = volume_exit,
7634 .suspend = volume_suspend,
7635 .resume = volume_resume,
7636 .shutdown = volume_shutdown,
7637};
7638
7639#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7640
7641#define alsa_card NULL
7642
7643static void inline volume_alsa_notify_change(void)
7644{
7645}
7646
7647static int __init volume_init(struct ibm_init_struct *iibm)
7648{
7649 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7650
7651 return 1;
7652}
7653
7654static struct ibm_struct volume_driver_data = {
7655 .name = "volume",
7656};
7657
7658#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7659
7660/*************************************************************************
7661 * Fan subdriver
7662 */
7663
7664/*
7665 * FAN ACCESS MODES
7666 *
7667 * TPACPI_FAN_RD_ACPI_GFAN:
7668 * ACPI GFAN method: returns fan level
7669 *
7670 * see TPACPI_FAN_WR_ACPI_SFAN
7671 * EC 0x2f (HFSP) not available if GFAN exists
7672 *
7673 * TPACPI_FAN_WR_ACPI_SFAN:
7674 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7675 *
7676 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7677 * it for writing.
7678 *
7679 * TPACPI_FAN_WR_TPEC:
7680 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7681 * Supported on almost all ThinkPads
7682 *
7683 * Fan speed changes of any sort (including those caused by the
7684 * disengaged mode) are usually done slowly by the firmware as the
7685 * maximum amount of fan duty cycle change per second seems to be
7686 * limited.
7687 *
7688 * Reading is not available if GFAN exists.
7689 * Writing is not available if SFAN exists.
7690 *
7691 * Bits
7692 * 7 automatic mode engaged;
7693 * (default operation mode of the ThinkPad)
7694 * fan level is ignored in this mode.
7695 * 6 full speed mode (takes precedence over bit 7);
7696 * not available on all thinkpads. May disable
7697 * the tachometer while the fan controller ramps up
7698 * the speed (which can take up to a few *minutes*).
7699 * Speeds up fan to 100% duty-cycle, which is far above
7700 * the standard RPM levels. It is not impossible that
7701 * it could cause hardware damage.
7702 * 5-3 unused in some models. Extra bits for fan level
7703 * in others, but still useless as all values above
7704 * 7 map to the same speed as level 7 in these models.
7705 * 2-0 fan level (0..7 usually)
7706 * 0x00 = stop
7707 * 0x07 = max (set when temperatures critical)
7708 * Some ThinkPads may have other levels, see
7709 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7710 *
7711 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7712 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7713 * does so, its initial value is meaningless (0x07).
7714 *
7715 * For firmware bugs, refer to:
7716 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7717 *
7718 * ----
7719 *
7720 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7721 * Main fan tachometer reading (in RPM)
7722 *
7723 * This register is present on all ThinkPads with a new-style EC, and
7724 * it is known not to be present on the A21m/e, and T22, as there is
7725 * something else in offset 0x84 according to the ACPI DSDT. Other
7726 * ThinkPads from this same time period (and earlier) probably lack the
7727 * tachometer as well.
7728 *
7729 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7730 * was never fixed by IBM to report the EC firmware version string
7731 * probably support the tachometer (like the early X models), so
7732 * detecting it is quite hard. We need more data to know for sure.
7733 *
7734 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7735 * might result.
7736 *
7737 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7738 * mode.
7739 *
7740 * For firmware bugs, refer to:
7741 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7742 *
7743 * ----
7744 *
7745 * ThinkPad EC register 0x31 bit 0 (only on select models)
7746 *
7747 * When bit 0 of EC register 0x31 is zero, the tachometer registers
7748 * show the speed of the main fan. When bit 0 of EC register 0x31
7749 * is one, the tachometer registers show the speed of the auxiliary
7750 * fan.
7751 *
7752 * Fan control seems to affect both fans, regardless of the state
7753 * of this bit.
7754 *
7755 * So far, only the firmware for the X60/X61 non-tablet versions
7756 * seem to support this (firmware TP-7M).
7757 *
7758 * TPACPI_FAN_WR_ACPI_FANS:
7759 * ThinkPad X31, X40, X41. Not available in the X60.
7760 *
7761 * FANS ACPI handle: takes three arguments: low speed, medium speed,
7762 * high speed. ACPI DSDT seems to map these three speeds to levels
7763 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
7764 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
7765 *
7766 * The speeds are stored on handles
7767 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
7768 *
7769 * There are three default speed sets, accessible as handles:
7770 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
7771 *
7772 * ACPI DSDT switches which set is in use depending on various
7773 * factors.
7774 *
7775 * TPACPI_FAN_WR_TPEC is also available and should be used to
7776 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
7777 * but the ACPI tables just mention level 7.
7778 */
7779
7780enum { /* Fan control constants */
7781 fan_status_offset = 0x2f, /* EC register 0x2f */
7782 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
7783 * 0x84 must be read before 0x85 */
7784 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
7785 bit 0 selects which fan is active */
7786
7787 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
7788 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
7789
7790 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
7791};
7792
7793enum fan_status_access_mode {
7794 TPACPI_FAN_NONE = 0, /* No fan status or control */
7795 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
7796 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
7797};
7798
7799enum fan_control_access_mode {
7800 TPACPI_FAN_WR_NONE = 0, /* No fan control */
7801 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
7802 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
7803 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
7804};
7805
7806enum fan_control_commands {
7807 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
7808 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
7809 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
7810 * and also watchdog cmd */
7811};
7812
7813static bool fan_control_allowed;
7814
7815static enum fan_status_access_mode fan_status_access_mode;
7816static enum fan_control_access_mode fan_control_access_mode;
7817static enum fan_control_commands fan_control_commands;
7818
7819static u8 fan_control_initial_status;
7820static u8 fan_control_desired_level;
7821static u8 fan_control_resume_level;
7822static int fan_watchdog_maxinterval;
7823
7824static struct mutex fan_mutex;
7825
7826static void fan_watchdog_fire(struct work_struct *ignored);
7827static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
7828
7829TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
7830TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
7831 "\\FSPD", /* 600e/x, 770e, 770x */
7832 ); /* all others */
7833TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
7834 "JFNS", /* 770x-JL */
7835 ); /* all others */
7836
7837/*
7838 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
7839 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
7840 * be in auto mode (0x80).
7841 *
7842 * This is corrected by any write to HFSP either by the driver, or
7843 * by the firmware.
7844 *
7845 * We assume 0x07 really means auto mode while this quirk is active,
7846 * as this is far more likely than the ThinkPad being in level 7,
7847 * which is only used by the firmware during thermal emergencies.
7848 *
7849 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
7850 * TP-70 (T43, R52), which are known to be buggy.
7851 */
7852
7853static void fan_quirk1_setup(void)
7854{
7855 if (fan_control_initial_status == 0x07) {
7856 pr_notice("fan_init: initial fan status is unknown, "
7857 "assuming it is in auto mode\n");
7858 tp_features.fan_ctrl_status_undef = 1;
7859 }
7860}
7861
7862static void fan_quirk1_handle(u8 *fan_status)
7863{
7864 if (unlikely(tp_features.fan_ctrl_status_undef)) {
7865 if (*fan_status != fan_control_initial_status) {
7866 /* something changed the HFSP regisnter since
7867 * driver init time, so it is not undefined
7868 * anymore */
7869 tp_features.fan_ctrl_status_undef = 0;
7870 } else {
7871 /* Return most likely status. In fact, it
7872 * might be the only possible status */
7873 *fan_status = TP_EC_FAN_AUTO;
7874 }
7875 }
7876}
7877
7878/* Select main fan on X60/X61, NOOP on others */
7879static bool fan_select_fan1(void)
7880{
7881 if (tp_features.second_fan) {
7882 u8 val;
7883
7884 if (ec_read(fan_select_offset, &val) < 0)
7885 return false;
7886 val &= 0xFEU;
7887 if (ec_write(fan_select_offset, val) < 0)
7888 return false;
7889 }
7890 return true;
7891}
7892
7893/* Select secondary fan on X60/X61 */
7894static bool fan_select_fan2(void)
7895{
7896 u8 val;
7897
7898 if (!tp_features.second_fan)
7899 return false;
7900
7901 if (ec_read(fan_select_offset, &val) < 0)
7902 return false;
7903 val |= 0x01U;
7904 if (ec_write(fan_select_offset, val) < 0)
7905 return false;
7906
7907 return true;
7908}
7909
7910/*
7911 * Call with fan_mutex held
7912 */
7913static void fan_update_desired_level(u8 status)
7914{
7915 if ((status &
7916 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7917 if (status > 7)
7918 fan_control_desired_level = 7;
7919 else
7920 fan_control_desired_level = status;
7921 }
7922}
7923
7924static int fan_get_status(u8 *status)
7925{
7926 u8 s;
7927
7928 /* TODO:
7929 * Add TPACPI_FAN_RD_ACPI_FANS ? */
7930
7931 switch (fan_status_access_mode) {
7932 case TPACPI_FAN_RD_ACPI_GFAN: {
7933 /* 570, 600e/x, 770e, 770x */
7934 int res;
7935
7936 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
7937 return -EIO;
7938
7939 if (likely(status))
7940 *status = res & 0x07;
7941
7942 break;
7943 }
7944 case TPACPI_FAN_RD_TPEC:
7945 /* all except 570, 600e/x, 770e, 770x */
7946 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
7947 return -EIO;
7948
7949 if (likely(status)) {
7950 *status = s;
7951 fan_quirk1_handle(status);
7952 }
7953
7954 break;
7955
7956 default:
7957 return -ENXIO;
7958 }
7959
7960 return 0;
7961}
7962
7963static int fan_get_status_safe(u8 *status)
7964{
7965 int rc;
7966 u8 s;
7967
7968 if (mutex_lock_killable(&fan_mutex))
7969 return -ERESTARTSYS;
7970 rc = fan_get_status(&s);
7971 if (!rc)
7972 fan_update_desired_level(s);
7973 mutex_unlock(&fan_mutex);
7974
7975 if (rc)
7976 return rc;
7977 if (status)
7978 *status = s;
7979
7980 return 0;
7981}
7982
7983static int fan_get_speed(unsigned int *speed)
7984{
7985 u8 hi, lo;
7986
7987 switch (fan_status_access_mode) {
7988 case TPACPI_FAN_RD_TPEC:
7989 /* all except 570, 600e/x, 770e, 770x */
7990 if (unlikely(!fan_select_fan1()))
7991 return -EIO;
7992 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
7993 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
7994 return -EIO;
7995
7996 if (likely(speed))
7997 *speed = (hi << 8) | lo;
7998
7999 break;
8000
8001 default:
8002 return -ENXIO;
8003 }
8004
8005 return 0;
8006}
8007
8008static int fan2_get_speed(unsigned int *speed)
8009{
8010 u8 hi, lo;
8011 bool rc;
8012
8013 switch (fan_status_access_mode) {
8014 case TPACPI_FAN_RD_TPEC:
8015 /* all except 570, 600e/x, 770e, 770x */
8016 if (unlikely(!fan_select_fan2()))
8017 return -EIO;
8018 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8019 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8020 fan_select_fan1(); /* play it safe */
8021 if (rc)
8022 return -EIO;
8023
8024 if (likely(speed))
8025 *speed = (hi << 8) | lo;
8026
8027 break;
8028
8029 default:
8030 return -ENXIO;
8031 }
8032
8033 return 0;
8034}
8035
8036static int fan_set_level(int level)
8037{
8038 if (!fan_control_allowed)
8039 return -EPERM;
8040
8041 switch (fan_control_access_mode) {
8042 case TPACPI_FAN_WR_ACPI_SFAN:
8043 if (level >= 0 && level <= 7) {
8044 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8045 return -EIO;
8046 } else
8047 return -EINVAL;
8048 break;
8049
8050 case TPACPI_FAN_WR_ACPI_FANS:
8051 case TPACPI_FAN_WR_TPEC:
8052 if (!(level & TP_EC_FAN_AUTO) &&
8053 !(level & TP_EC_FAN_FULLSPEED) &&
8054 ((level < 0) || (level > 7)))
8055 return -EINVAL;
8056
8057 /* safety net should the EC not support AUTO
8058 * or FULLSPEED mode bits and just ignore them */
8059 if (level & TP_EC_FAN_FULLSPEED)
8060 level |= 7; /* safety min speed 7 */
8061 else if (level & TP_EC_FAN_AUTO)
8062 level |= 4; /* safety min speed 4 */
8063
8064 if (!acpi_ec_write(fan_status_offset, level))
8065 return -EIO;
8066 else
8067 tp_features.fan_ctrl_status_undef = 0;
8068 break;
8069
8070 default:
8071 return -ENXIO;
8072 }
8073
8074 vdbg_printk(TPACPI_DBG_FAN,
8075 "fan control: set fan control register to 0x%02x\n", level);
8076 return 0;
8077}
8078
8079static int fan_set_level_safe(int level)
8080{
8081 int rc;
8082
8083 if (!fan_control_allowed)
8084 return -EPERM;
8085
8086 if (mutex_lock_killable(&fan_mutex))
8087 return -ERESTARTSYS;
8088
8089 if (level == TPACPI_FAN_LAST_LEVEL)
8090 level = fan_control_desired_level;
8091
8092 rc = fan_set_level(level);
8093 if (!rc)
8094 fan_update_desired_level(level);
8095
8096 mutex_unlock(&fan_mutex);
8097 return rc;
8098}
8099
8100static int fan_set_enable(void)
8101{
8102 u8 s;
8103 int rc;
8104
8105 if (!fan_control_allowed)
8106 return -EPERM;
8107
8108 if (mutex_lock_killable(&fan_mutex))
8109 return -ERESTARTSYS;
8110
8111 switch (fan_control_access_mode) {
8112 case TPACPI_FAN_WR_ACPI_FANS:
8113 case TPACPI_FAN_WR_TPEC:
8114 rc = fan_get_status(&s);
8115 if (rc < 0)
8116 break;
8117
8118 /* Don't go out of emergency fan mode */
8119 if (s != 7) {
8120 s &= 0x07;
8121 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8122 }
8123
8124 if (!acpi_ec_write(fan_status_offset, s))
8125 rc = -EIO;
8126 else {
8127 tp_features.fan_ctrl_status_undef = 0;
8128 rc = 0;
8129 }
8130 break;
8131
8132 case TPACPI_FAN_WR_ACPI_SFAN:
8133 rc = fan_get_status(&s);
8134 if (rc < 0)
8135 break;
8136
8137 s &= 0x07;
8138
8139 /* Set fan to at least level 4 */
8140 s |= 4;
8141
8142 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8143 rc = -EIO;
8144 else
8145 rc = 0;
8146 break;
8147
8148 default:
8149 rc = -ENXIO;
8150 }
8151
8152 mutex_unlock(&fan_mutex);
8153
8154 if (!rc)
8155 vdbg_printk(TPACPI_DBG_FAN,
8156 "fan control: set fan control register to 0x%02x\n",
8157 s);
8158 return rc;
8159}
8160
8161static int fan_set_disable(void)
8162{
8163 int rc;
8164
8165 if (!fan_control_allowed)
8166 return -EPERM;
8167
8168 if (mutex_lock_killable(&fan_mutex))
8169 return -ERESTARTSYS;
8170
8171 rc = 0;
8172 switch (fan_control_access_mode) {
8173 case TPACPI_FAN_WR_ACPI_FANS:
8174 case TPACPI_FAN_WR_TPEC:
8175 if (!acpi_ec_write(fan_status_offset, 0x00))
8176 rc = -EIO;
8177 else {
8178 fan_control_desired_level = 0;
8179 tp_features.fan_ctrl_status_undef = 0;
8180 }
8181 break;
8182
8183 case TPACPI_FAN_WR_ACPI_SFAN:
8184 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8185 rc = -EIO;
8186 else
8187 fan_control_desired_level = 0;
8188 break;
8189
8190 default:
8191 rc = -ENXIO;
8192 }
8193
8194 if (!rc)
8195 vdbg_printk(TPACPI_DBG_FAN,
8196 "fan control: set fan control register to 0\n");
8197
8198 mutex_unlock(&fan_mutex);
8199 return rc;
8200}
8201
8202static int fan_set_speed(int speed)
8203{
8204 int rc;
8205
8206 if (!fan_control_allowed)
8207 return -EPERM;
8208
8209 if (mutex_lock_killable(&fan_mutex))
8210 return -ERESTARTSYS;
8211
8212 rc = 0;
8213 switch (fan_control_access_mode) {
8214 case TPACPI_FAN_WR_ACPI_FANS:
8215 if (speed >= 0 && speed <= 65535) {
8216 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8217 speed, speed, speed))
8218 rc = -EIO;
8219 } else
8220 rc = -EINVAL;
8221 break;
8222
8223 default:
8224 rc = -ENXIO;
8225 }
8226
8227 mutex_unlock(&fan_mutex);
8228 return rc;
8229}
8230
8231static void fan_watchdog_reset(void)
8232{
8233 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8234 return;
8235
8236 if (fan_watchdog_maxinterval > 0 &&
8237 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8238 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8239 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8240 else
8241 cancel_delayed_work(&fan_watchdog_task);
8242}
8243
8244static void fan_watchdog_fire(struct work_struct *ignored)
8245{
8246 int rc;
8247
8248 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8249 return;
8250
8251 pr_notice("fan watchdog: enabling fan\n");
8252 rc = fan_set_enable();
8253 if (rc < 0) {
8254 pr_err("fan watchdog: error %d while enabling fan, "
8255 "will try again later...\n", -rc);
8256 /* reschedule for later */
8257 fan_watchdog_reset();
8258 }
8259}
8260
8261/*
8262 * SYSFS fan layout: hwmon compatible (device)
8263 *
8264 * pwm*_enable:
8265 * 0: "disengaged" mode
8266 * 1: manual mode
8267 * 2: native EC "auto" mode (recommended, hardware default)
8268 *
8269 * pwm*: set speed in manual mode, ignored otherwise.
8270 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8271 * interpolation.
8272 *
8273 * fan*_input: tachometer reading, RPM
8274 *
8275 *
8276 * SYSFS fan layout: extensions
8277 *
8278 * fan_watchdog (driver):
8279 * fan watchdog interval in seconds, 0 disables (default), max 120
8280 */
8281
8282/* sysfs fan pwm1_enable ----------------------------------------------- */
8283static ssize_t fan_pwm1_enable_show(struct device *dev,
8284 struct device_attribute *attr,
8285 char *buf)
8286{
8287 int res, mode;
8288 u8 status;
8289
8290 res = fan_get_status_safe(&status);
8291 if (res)
8292 return res;
8293
8294 if (status & TP_EC_FAN_FULLSPEED) {
8295 mode = 0;
8296 } else if (status & TP_EC_FAN_AUTO) {
8297 mode = 2;
8298 } else
8299 mode = 1;
8300
8301 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
8302}
8303
8304static ssize_t fan_pwm1_enable_store(struct device *dev,
8305 struct device_attribute *attr,
8306 const char *buf, size_t count)
8307{
8308 unsigned long t;
8309 int res, level;
8310
8311 if (parse_strtoul(buf, 2, &t))
8312 return -EINVAL;
8313
8314 tpacpi_disclose_usertask("hwmon pwm1_enable",
8315 "set fan mode to %lu\n", t);
8316
8317 switch (t) {
8318 case 0:
8319 level = TP_EC_FAN_FULLSPEED;
8320 break;
8321 case 1:
8322 level = TPACPI_FAN_LAST_LEVEL;
8323 break;
8324 case 2:
8325 level = TP_EC_FAN_AUTO;
8326 break;
8327 case 3:
8328 /* reserved for software-controlled auto mode */
8329 return -ENOSYS;
8330 default:
8331 return -EINVAL;
8332 }
8333
8334 res = fan_set_level_safe(level);
8335 if (res == -ENXIO)
8336 return -EINVAL;
8337 else if (res < 0)
8338 return res;
8339
8340 fan_watchdog_reset();
8341
8342 return count;
8343}
8344
8345static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8346 fan_pwm1_enable_show, fan_pwm1_enable_store);
8347
8348/* sysfs fan pwm1 ------------------------------------------------------ */
8349static ssize_t fan_pwm1_show(struct device *dev,
8350 struct device_attribute *attr,
8351 char *buf)
8352{
8353 int res;
8354 u8 status;
8355
8356 res = fan_get_status_safe(&status);
8357 if (res)
8358 return res;
8359
8360 if ((status &
8361 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8362 status = fan_control_desired_level;
8363
8364 if (status > 7)
8365 status = 7;
8366
8367 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
8368}
8369
8370static ssize_t fan_pwm1_store(struct device *dev,
8371 struct device_attribute *attr,
8372 const char *buf, size_t count)
8373{
8374 unsigned long s;
8375 int rc;
8376 u8 status, newlevel;
8377
8378 if (parse_strtoul(buf, 255, &s))
8379 return -EINVAL;
8380
8381 tpacpi_disclose_usertask("hwmon pwm1",
8382 "set fan speed to %lu\n", s);
8383
8384 /* scale down from 0-255 to 0-7 */
8385 newlevel = (s >> 5) & 0x07;
8386
8387 if (mutex_lock_killable(&fan_mutex))
8388 return -ERESTARTSYS;
8389
8390 rc = fan_get_status(&status);
8391 if (!rc && (status &
8392 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8393 rc = fan_set_level(newlevel);
8394 if (rc == -ENXIO)
8395 rc = -EINVAL;
8396 else if (!rc) {
8397 fan_update_desired_level(newlevel);
8398 fan_watchdog_reset();
8399 }
8400 }
8401
8402 mutex_unlock(&fan_mutex);
8403 return (rc) ? rc : count;
8404}
8405
8406static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8407
8408/* sysfs fan fan1_input ------------------------------------------------ */
8409static ssize_t fan_fan1_input_show(struct device *dev,
8410 struct device_attribute *attr,
8411 char *buf)
8412{
8413 int res;
8414 unsigned int speed;
8415
8416 res = fan_get_speed(&speed);
8417 if (res < 0)
8418 return res;
8419
8420 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8421}
8422
8423static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8424
8425/* sysfs fan fan2_input ------------------------------------------------ */
8426static ssize_t fan_fan2_input_show(struct device *dev,
8427 struct device_attribute *attr,
8428 char *buf)
8429{
8430 int res;
8431 unsigned int speed;
8432
8433 res = fan2_get_speed(&speed);
8434 if (res < 0)
8435 return res;
8436
8437 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8438}
8439
8440static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8441
8442/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8443static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
8444 char *buf)
8445{
8446 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8447}
8448
8449static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
8450 const char *buf, size_t count)
8451{
8452 unsigned long t;
8453
8454 if (parse_strtoul(buf, 120, &t))
8455 return -EINVAL;
8456
8457 if (!fan_control_allowed)
8458 return -EPERM;
8459
8460 fan_watchdog_maxinterval = t;
8461 fan_watchdog_reset();
8462
8463 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8464
8465 return count;
8466}
8467
8468static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
8469 fan_fan_watchdog_show, fan_fan_watchdog_store);
8470
8471/* --------------------------------------------------------------------- */
8472static struct attribute *fan_attributes[] = {
8473 &dev_attr_pwm1_enable.attr, &dev_attr_pwm1.attr,
8474 &dev_attr_fan1_input.attr,
8475 NULL, /* for fan2_input */
8476 NULL
8477};
8478
8479static const struct attribute_group fan_attr_group = {
8480 .attrs = fan_attributes,
8481};
8482
8483#define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
8484#define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8485
8486#define TPACPI_FAN_QI(__id1, __id2, __quirks) \
8487 { .vendor = PCI_VENDOR_ID_IBM, \
8488 .bios = TPACPI_MATCH_ANY, \
8489 .ec = TPID(__id1, __id2), \
8490 .quirks = __quirks }
8491
8492#define TPACPI_FAN_QL(__id1, __id2, __quirks) \
8493 { .vendor = PCI_VENDOR_ID_LENOVO, \
8494 .bios = TPACPI_MATCH_ANY, \
8495 .ec = TPID(__id1, __id2), \
8496 .quirks = __quirks }
8497
8498static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8499 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
8500 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
8501 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
8502 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
8503 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
8504};
8505
8506#undef TPACPI_FAN_QL
8507#undef TPACPI_FAN_QI
8508
8509static int __init fan_init(struct ibm_init_struct *iibm)
8510{
8511 int rc;
8512 unsigned long quirks;
8513
8514 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8515 "initializing fan subdriver\n");
8516
8517 mutex_init(&fan_mutex);
8518 fan_status_access_mode = TPACPI_FAN_NONE;
8519 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8520 fan_control_commands = 0;
8521 fan_watchdog_maxinterval = 0;
8522 tp_features.fan_ctrl_status_undef = 0;
8523 tp_features.second_fan = 0;
8524 fan_control_desired_level = 7;
8525
8526 if (tpacpi_is_ibm()) {
8527 TPACPI_ACPIHANDLE_INIT(fans);
8528 TPACPI_ACPIHANDLE_INIT(gfan);
8529 TPACPI_ACPIHANDLE_INIT(sfan);
8530 }
8531
8532 quirks = tpacpi_check_quirks(fan_quirk_table,
8533 ARRAY_SIZE(fan_quirk_table));
8534
8535 if (gfan_handle) {
8536 /* 570, 600e/x, 770e, 770x */
8537 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8538 } else {
8539 /* all other ThinkPads: note that even old-style
8540 * ThinkPad ECs supports the fan control register */
8541 if (likely(acpi_ec_read(fan_status_offset,
8542 &fan_control_initial_status))) {
8543 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8544 if (quirks & TPACPI_FAN_Q1)
8545 fan_quirk1_setup();
8546 if (quirks & TPACPI_FAN_2FAN) {
8547 tp_features.second_fan = 1;
8548 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8549 "secondary fan support enabled\n");
8550 }
8551 } else {
8552 pr_err("ThinkPad ACPI EC access misbehaving, "
8553 "fan status and control unavailable\n");
8554 return 1;
8555 }
8556 }
8557
8558 if (sfan_handle) {
8559 /* 570, 770x-JL */
8560 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8561 fan_control_commands |=
8562 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8563 } else {
8564 if (!gfan_handle) {
8565 /* gfan without sfan means no fan control */
8566 /* all other models implement TP EC 0x2f control */
8567
8568 if (fans_handle) {
8569 /* X31, X40, X41 */
8570 fan_control_access_mode =
8571 TPACPI_FAN_WR_ACPI_FANS;
8572 fan_control_commands |=
8573 TPACPI_FAN_CMD_SPEED |
8574 TPACPI_FAN_CMD_LEVEL |
8575 TPACPI_FAN_CMD_ENABLE;
8576 } else {
8577 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8578 fan_control_commands |=
8579 TPACPI_FAN_CMD_LEVEL |
8580 TPACPI_FAN_CMD_ENABLE;
8581 }
8582 }
8583 }
8584
8585 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8586 "fan is %s, modes %d, %d\n",
8587 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8588 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8589 fan_status_access_mode, fan_control_access_mode);
8590
8591 /* fan control master switch */
8592 if (!fan_control_allowed) {
8593 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8594 fan_control_commands = 0;
8595 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8596 "fan control features disabled by parameter\n");
8597 }
8598
8599 /* update fan_control_desired_level */
8600 if (fan_status_access_mode != TPACPI_FAN_NONE)
8601 fan_get_status_safe(NULL);
8602
8603 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8604 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8605 if (tp_features.second_fan) {
8606 /* attach second fan tachometer */
8607 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8608 &dev_attr_fan2_input.attr;
8609 }
8610 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
8611 &fan_attr_group);
8612 if (rc < 0)
8613 return rc;
8614
8615 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8616 &driver_attr_fan_watchdog);
8617 if (rc < 0) {
8618 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
8619 &fan_attr_group);
8620 return rc;
8621 }
8622 return 0;
8623 } else
8624 return 1;
8625}
8626
8627static void fan_exit(void)
8628{
8629 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8630 "cancelling any pending fan watchdog tasks\n");
8631
8632 /* FIXME: can we really do this unconditionally? */
8633 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
8634 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8635 &driver_attr_fan_watchdog);
8636
8637 cancel_delayed_work(&fan_watchdog_task);
8638 flush_workqueue(tpacpi_wq);
8639}
8640
8641static void fan_suspend(void)
8642{
8643 int rc;
8644
8645 if (!fan_control_allowed)
8646 return;
8647
8648 /* Store fan status in cache */
8649 fan_control_resume_level = 0;
8650 rc = fan_get_status_safe(&fan_control_resume_level);
8651 if (rc < 0)
8652 pr_notice("failed to read fan level for later "
8653 "restore during resume: %d\n", rc);
8654
8655 /* if it is undefined, don't attempt to restore it.
8656 * KEEP THIS LAST */
8657 if (tp_features.fan_ctrl_status_undef)
8658 fan_control_resume_level = 0;
8659}
8660
8661static void fan_resume(void)
8662{
8663 u8 current_level = 7;
8664 bool do_set = false;
8665 int rc;
8666
8667 /* DSDT *always* updates status on resume */
8668 tp_features.fan_ctrl_status_undef = 0;
8669
8670 if (!fan_control_allowed ||
8671 !fan_control_resume_level ||
8672 (fan_get_status_safe(¤t_level) < 0))
8673 return;
8674
8675 switch (fan_control_access_mode) {
8676 case TPACPI_FAN_WR_ACPI_SFAN:
8677 /* never decrease fan level */
8678 do_set = (fan_control_resume_level > current_level);
8679 break;
8680 case TPACPI_FAN_WR_ACPI_FANS:
8681 case TPACPI_FAN_WR_TPEC:
8682 /* never decrease fan level, scale is:
8683 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8684 *
8685 * We expect the firmware to set either 7 or AUTO, but we
8686 * handle FULLSPEED out of paranoia.
8687 *
8688 * So, we can safely only restore FULLSPEED or 7, anything
8689 * else could slow the fan. Restoring AUTO is useless, at
8690 * best that's exactly what the DSDT already set (it is the
8691 * slower it uses).
8692 *
8693 * Always keep in mind that the DSDT *will* have set the
8694 * fans to what the vendor supposes is the best level. We
8695 * muck with it only to speed the fan up.
8696 */
8697 if (fan_control_resume_level != 7 &&
8698 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8699 return;
8700 else
8701 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8702 (current_level != fan_control_resume_level);
8703 break;
8704 default:
8705 return;
8706 }
8707 if (do_set) {
8708 pr_notice("restoring fan level to 0x%02x\n",
8709 fan_control_resume_level);
8710 rc = fan_set_level_safe(fan_control_resume_level);
8711 if (rc < 0)
8712 pr_notice("failed to restore fan level: %d\n", rc);
8713 }
8714}
8715
8716static int fan_read(struct seq_file *m)
8717{
8718 int rc;
8719 u8 status;
8720 unsigned int speed = 0;
8721
8722 switch (fan_status_access_mode) {
8723 case TPACPI_FAN_RD_ACPI_GFAN:
8724 /* 570, 600e/x, 770e, 770x */
8725 rc = fan_get_status_safe(&status);
8726 if (rc < 0)
8727 return rc;
8728
8729 seq_printf(m, "status:\t\t%s\n"
8730 "level:\t\t%d\n",
8731 (status != 0) ? "enabled" : "disabled", status);
8732 break;
8733
8734 case TPACPI_FAN_RD_TPEC:
8735 /* all except 570, 600e/x, 770e, 770x */
8736 rc = fan_get_status_safe(&status);
8737 if (rc < 0)
8738 return rc;
8739
8740 seq_printf(m, "status:\t\t%s\n",
8741 (status != 0) ? "enabled" : "disabled");
8742
8743 rc = fan_get_speed(&speed);
8744 if (rc < 0)
8745 return rc;
8746
8747 seq_printf(m, "speed:\t\t%d\n", speed);
8748
8749 if (status & TP_EC_FAN_FULLSPEED)
8750 /* Disengaged mode takes precedence */
8751 seq_printf(m, "level:\t\tdisengaged\n");
8752 else if (status & TP_EC_FAN_AUTO)
8753 seq_printf(m, "level:\t\tauto\n");
8754 else
8755 seq_printf(m, "level:\t\t%d\n", status);
8756 break;
8757
8758 case TPACPI_FAN_NONE:
8759 default:
8760 seq_printf(m, "status:\t\tnot supported\n");
8761 }
8762
8763 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
8764 seq_printf(m, "commands:\tlevel <level>");
8765
8766 switch (fan_control_access_mode) {
8767 case TPACPI_FAN_WR_ACPI_SFAN:
8768 seq_printf(m, " (<level> is 0-7)\n");
8769 break;
8770
8771 default:
8772 seq_printf(m, " (<level> is 0-7, "
8773 "auto, disengaged, full-speed)\n");
8774 break;
8775 }
8776 }
8777
8778 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
8779 seq_printf(m, "commands:\tenable, disable\n"
8780 "commands:\twatchdog <timeout> (<timeout> "
8781 "is 0 (off), 1-120 (seconds))\n");
8782
8783 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
8784 seq_printf(m, "commands:\tspeed <speed>"
8785 " (<speed> is 0-65535)\n");
8786
8787 return 0;
8788}
8789
8790static int fan_write_cmd_level(const char *cmd, int *rc)
8791{
8792 int level;
8793
8794 if (strlencmp(cmd, "level auto") == 0)
8795 level = TP_EC_FAN_AUTO;
8796 else if ((strlencmp(cmd, "level disengaged") == 0) |
8797 (strlencmp(cmd, "level full-speed") == 0))
8798 level = TP_EC_FAN_FULLSPEED;
8799 else if (sscanf(cmd, "level %d", &level) != 1)
8800 return 0;
8801
8802 *rc = fan_set_level_safe(level);
8803 if (*rc == -ENXIO)
8804 pr_err("level command accepted for unsupported access mode %d\n",
8805 fan_control_access_mode);
8806 else if (!*rc)
8807 tpacpi_disclose_usertask("procfs fan",
8808 "set level to %d\n", level);
8809
8810 return 1;
8811}
8812
8813static int fan_write_cmd_enable(const char *cmd, int *rc)
8814{
8815 if (strlencmp(cmd, "enable") != 0)
8816 return 0;
8817
8818 *rc = fan_set_enable();
8819 if (*rc == -ENXIO)
8820 pr_err("enable command accepted for unsupported access mode %d\n",
8821 fan_control_access_mode);
8822 else if (!*rc)
8823 tpacpi_disclose_usertask("procfs fan", "enable\n");
8824
8825 return 1;
8826}
8827
8828static int fan_write_cmd_disable(const char *cmd, int *rc)
8829{
8830 if (strlencmp(cmd, "disable") != 0)
8831 return 0;
8832
8833 *rc = fan_set_disable();
8834 if (*rc == -ENXIO)
8835 pr_err("disable command accepted for unsupported access mode %d\n",
8836 fan_control_access_mode);
8837 else if (!*rc)
8838 tpacpi_disclose_usertask("procfs fan", "disable\n");
8839
8840 return 1;
8841}
8842
8843static int fan_write_cmd_speed(const char *cmd, int *rc)
8844{
8845 int speed;
8846
8847 /* TODO:
8848 * Support speed <low> <medium> <high> ? */
8849
8850 if (sscanf(cmd, "speed %d", &speed) != 1)
8851 return 0;
8852
8853 *rc = fan_set_speed(speed);
8854 if (*rc == -ENXIO)
8855 pr_err("speed command accepted for unsupported access mode %d\n",
8856 fan_control_access_mode);
8857 else if (!*rc)
8858 tpacpi_disclose_usertask("procfs fan",
8859 "set speed to %d\n", speed);
8860
8861 return 1;
8862}
8863
8864static int fan_write_cmd_watchdog(const char *cmd, int *rc)
8865{
8866 int interval;
8867
8868 if (sscanf(cmd, "watchdog %d", &interval) != 1)
8869 return 0;
8870
8871 if (interval < 0 || interval > 120)
8872 *rc = -EINVAL;
8873 else {
8874 fan_watchdog_maxinterval = interval;
8875 tpacpi_disclose_usertask("procfs fan",
8876 "set watchdog timer to %d\n",
8877 interval);
8878 }
8879
8880 return 1;
8881}
8882
8883static int fan_write(char *buf)
8884{
8885 char *cmd;
8886 int rc = 0;
8887
8888 while (!rc && (cmd = next_cmd(&buf))) {
8889 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
8890 fan_write_cmd_level(cmd, &rc)) &&
8891 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
8892 (fan_write_cmd_enable(cmd, &rc) ||
8893 fan_write_cmd_disable(cmd, &rc) ||
8894 fan_write_cmd_watchdog(cmd, &rc))) &&
8895 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
8896 fan_write_cmd_speed(cmd, &rc))
8897 )
8898 rc = -EINVAL;
8899 else if (!rc)
8900 fan_watchdog_reset();
8901 }
8902
8903 return rc;
8904}
8905
8906static struct ibm_struct fan_driver_data = {
8907 .name = "fan",
8908 .read = fan_read,
8909 .write = fan_write,
8910 .exit = fan_exit,
8911 .suspend = fan_suspend,
8912 .resume = fan_resume,
8913};
8914
8915/*************************************************************************
8916 * Mute LED subdriver
8917 */
8918
8919
8920struct tp_led_table {
8921 acpi_string name;
8922 int on_value;
8923 int off_value;
8924 int state;
8925};
8926
8927static struct tp_led_table led_tables[] = {
8928 [TPACPI_LED_MUTE] = {
8929 .name = "SSMS",
8930 .on_value = 1,
8931 .off_value = 0,
8932 },
8933 [TPACPI_LED_MICMUTE] = {
8934 .name = "MMTS",
8935 .on_value = 2,
8936 .off_value = 0,
8937 },
8938};
8939
8940static int mute_led_on_off(struct tp_led_table *t, bool state)
8941{
8942 acpi_handle temp;
8943 int output;
8944
8945 if (!ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp))) {
8946 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
8947 return -EIO;
8948 }
8949
8950 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
8951 state ? t->on_value : t->off_value))
8952 return -EIO;
8953
8954 t->state = state;
8955 return state;
8956}
8957
8958int tpacpi_led_set(int whichled, bool on)
8959{
8960 struct tp_led_table *t;
8961
8962 if (whichled < 0 || whichled >= TPACPI_LED_MAX)
8963 return -EINVAL;
8964
8965 t = &led_tables[whichled];
8966 if (t->state < 0 || t->state == on)
8967 return t->state;
8968 return mute_led_on_off(t, on);
8969}
8970EXPORT_SYMBOL_GPL(tpacpi_led_set);
8971
8972static int mute_led_init(struct ibm_init_struct *iibm)
8973{
8974 acpi_handle temp;
8975 int i;
8976
8977 for (i = 0; i < TPACPI_LED_MAX; i++) {
8978 struct tp_led_table *t = &led_tables[i];
8979 if (ACPI_SUCCESS(acpi_get_handle(hkey_handle, t->name, &temp)))
8980 mute_led_on_off(t, false);
8981 else
8982 t->state = -ENODEV;
8983 }
8984 return 0;
8985}
8986
8987static void mute_led_exit(void)
8988{
8989 int i;
8990
8991 for (i = 0; i < TPACPI_LED_MAX; i++)
8992 tpacpi_led_set(i, false);
8993}
8994
8995static void mute_led_resume(void)
8996{
8997 int i;
8998
8999 for (i = 0; i < TPACPI_LED_MAX; i++) {
9000 struct tp_led_table *t = &led_tables[i];
9001 if (t->state >= 0)
9002 mute_led_on_off(t, t->state);
9003 }
9004}
9005
9006static struct ibm_struct mute_led_driver_data = {
9007 .name = "mute_led",
9008 .exit = mute_led_exit,
9009 .resume = mute_led_resume,
9010};
9011
9012/****************************************************************************
9013 ****************************************************************************
9014 *
9015 * Infrastructure
9016 *
9017 ****************************************************************************
9018 ****************************************************************************/
9019
9020/*
9021 * HKEY event callout for other subdrivers go here
9022 * (yes, it is ugly, but it is quick, safe, and gets the job done
9023 */
9024static void tpacpi_driver_event(const unsigned int hkey_event)
9025{
9026 if (ibm_backlight_device) {
9027 switch (hkey_event) {
9028 case TP_HKEY_EV_BRGHT_UP:
9029 case TP_HKEY_EV_BRGHT_DOWN:
9030 tpacpi_brightness_notify_change();
9031 }
9032 }
9033 if (alsa_card) {
9034 switch (hkey_event) {
9035 case TP_HKEY_EV_VOL_UP:
9036 case TP_HKEY_EV_VOL_DOWN:
9037 case TP_HKEY_EV_VOL_MUTE:
9038 volume_alsa_notify_change();
9039 }
9040 }
9041}
9042
9043static void hotkey_driver_event(const unsigned int scancode)
9044{
9045 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
9046}
9047
9048/* sysfs name ---------------------------------------------------------- */
9049static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
9050 struct device_attribute *attr,
9051 char *buf)
9052{
9053 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
9054}
9055
9056static DEVICE_ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
9057
9058/* --------------------------------------------------------------------- */
9059
9060/* /proc support */
9061static struct proc_dir_entry *proc_dir;
9062
9063/*
9064 * Module and infrastructure proble, init and exit handling
9065 */
9066
9067static bool force_load;
9068
9069#ifdef CONFIG_THINKPAD_ACPI_DEBUG
9070static const char * __init str_supported(int is_supported)
9071{
9072 static char text_unsupported[] __initdata = "not supported";
9073
9074 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
9075}
9076#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
9077
9078static void ibm_exit(struct ibm_struct *ibm)
9079{
9080 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
9081
9082 list_del_init(&ibm->all_drivers);
9083
9084 if (ibm->flags.acpi_notify_installed) {
9085 dbg_printk(TPACPI_DBG_EXIT,
9086 "%s: acpi_remove_notify_handler\n", ibm->name);
9087 BUG_ON(!ibm->acpi);
9088 acpi_remove_notify_handler(*ibm->acpi->handle,
9089 ibm->acpi->type,
9090 dispatch_acpi_notify);
9091 ibm->flags.acpi_notify_installed = 0;
9092 }
9093
9094 if (ibm->flags.proc_created) {
9095 dbg_printk(TPACPI_DBG_EXIT,
9096 "%s: remove_proc_entry\n", ibm->name);
9097 remove_proc_entry(ibm->name, proc_dir);
9098 ibm->flags.proc_created = 0;
9099 }
9100
9101 if (ibm->flags.acpi_driver_registered) {
9102 dbg_printk(TPACPI_DBG_EXIT,
9103 "%s: acpi_bus_unregister_driver\n", ibm->name);
9104 BUG_ON(!ibm->acpi);
9105 acpi_bus_unregister_driver(ibm->acpi->driver);
9106 kfree(ibm->acpi->driver);
9107 ibm->acpi->driver = NULL;
9108 ibm->flags.acpi_driver_registered = 0;
9109 }
9110
9111 if (ibm->flags.init_called && ibm->exit) {
9112 ibm->exit();
9113 ibm->flags.init_called = 0;
9114 }
9115
9116 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
9117}
9118
9119static int __init ibm_init(struct ibm_init_struct *iibm)
9120{
9121 int ret;
9122 struct ibm_struct *ibm = iibm->data;
9123 struct proc_dir_entry *entry;
9124
9125 BUG_ON(ibm == NULL);
9126
9127 INIT_LIST_HEAD(&ibm->all_drivers);
9128
9129 if (ibm->flags.experimental && !experimental)
9130 return 0;
9131
9132 dbg_printk(TPACPI_DBG_INIT,
9133 "probing for %s\n", ibm->name);
9134
9135 if (iibm->init) {
9136 ret = iibm->init(iibm);
9137 if (ret > 0)
9138 return 0; /* probe failed */
9139 if (ret)
9140 return ret;
9141
9142 ibm->flags.init_called = 1;
9143 }
9144
9145 if (ibm->acpi) {
9146 if (ibm->acpi->hid) {
9147 ret = register_tpacpi_subdriver(ibm);
9148 if (ret)
9149 goto err_out;
9150 }
9151
9152 if (ibm->acpi->notify) {
9153 ret = setup_acpi_notify(ibm);
9154 if (ret == -ENODEV) {
9155 pr_notice("disabling subdriver %s\n",
9156 ibm->name);
9157 ret = 0;
9158 goto err_out;
9159 }
9160 if (ret < 0)
9161 goto err_out;
9162 }
9163 }
9164
9165 dbg_printk(TPACPI_DBG_INIT,
9166 "%s installed\n", ibm->name);
9167
9168 if (ibm->read) {
9169 umode_t mode = iibm->base_procfs_mode;
9170
9171 if (!mode)
9172 mode = S_IRUGO;
9173 if (ibm->write)
9174 mode |= S_IWUSR;
9175 entry = proc_create_data(ibm->name, mode, proc_dir,
9176 &dispatch_proc_fops, ibm);
9177 if (!entry) {
9178 pr_err("unable to create proc entry %s\n", ibm->name);
9179 ret = -ENODEV;
9180 goto err_out;
9181 }
9182 ibm->flags.proc_created = 1;
9183 }
9184
9185 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
9186
9187 return 0;
9188
9189err_out:
9190 dbg_printk(TPACPI_DBG_INIT,
9191 "%s: at error exit path with result %d\n",
9192 ibm->name, ret);
9193
9194 ibm_exit(ibm);
9195 return (ret < 0) ? ret : 0;
9196}
9197
9198/* Probing */
9199
9200static bool __pure __init tpacpi_is_fw_digit(const char c)
9201{
9202 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
9203}
9204
9205static bool __pure __init tpacpi_is_valid_fw_id(const char * const s,
9206 const char t)
9207{
9208 /*
9209 * Most models: xxyTkkWW (#.##c)
9210 * Ancient 570/600 and -SL lacks (#.##c)
9211 */
9212 if (s && strlen(s) >= 8 &&
9213 tpacpi_is_fw_digit(s[0]) &&
9214 tpacpi_is_fw_digit(s[1]) &&
9215 s[2] == t &&
9216 (s[3] == 'T' || s[3] == 'N') &&
9217 tpacpi_is_fw_digit(s[4]) &&
9218 tpacpi_is_fw_digit(s[5]))
9219 return true;
9220
9221 /* New models: xxxyTkkW (#.##c); T550 and some others */
9222 return s && strlen(s) >= 8 &&
9223 tpacpi_is_fw_digit(s[0]) &&
9224 tpacpi_is_fw_digit(s[1]) &&
9225 tpacpi_is_fw_digit(s[2]) &&
9226 s[3] == t &&
9227 (s[4] == 'T' || s[4] == 'N') &&
9228 tpacpi_is_fw_digit(s[5]) &&
9229 tpacpi_is_fw_digit(s[6]);
9230}
9231
9232/* returns 0 - probe ok, or < 0 - probe error.
9233 * Probe ok doesn't mean thinkpad found.
9234 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
9235static int __must_check __init get_thinkpad_model_data(
9236 struct thinkpad_id_data *tp)
9237{
9238 const struct dmi_device *dev = NULL;
9239 char ec_fw_string[18];
9240 char const *s;
9241
9242 if (!tp)
9243 return -EINVAL;
9244
9245 memset(tp, 0, sizeof(*tp));
9246
9247 if (dmi_name_in_vendors("IBM"))
9248 tp->vendor = PCI_VENDOR_ID_IBM;
9249 else if (dmi_name_in_vendors("LENOVO"))
9250 tp->vendor = PCI_VENDOR_ID_LENOVO;
9251 else
9252 return 0;
9253
9254 s = dmi_get_system_info(DMI_BIOS_VERSION);
9255 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
9256 if (s && !tp->bios_version_str)
9257 return -ENOMEM;
9258
9259 /* Really ancient ThinkPad 240X will fail this, which is fine */
9260 if (!(tpacpi_is_valid_fw_id(tp->bios_version_str, 'E') ||
9261 tpacpi_is_valid_fw_id(tp->bios_version_str, 'C')))
9262 return 0;
9263
9264 tp->bios_model = tp->bios_version_str[0]
9265 | (tp->bios_version_str[1] << 8);
9266 tp->bios_release = (tp->bios_version_str[4] << 8)
9267 | tp->bios_version_str[5];
9268
9269 /*
9270 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
9271 * X32 or newer, all Z series; Some models must have an
9272 * up-to-date BIOS or they will not be detected.
9273 *
9274 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9275 */
9276 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
9277 if (sscanf(dev->name,
9278 "IBM ThinkPad Embedded Controller -[%17c",
9279 ec_fw_string) == 1) {
9280 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
9281 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
9282
9283 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
9284 if (!tp->ec_version_str)
9285 return -ENOMEM;
9286
9287 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
9288 tp->ec_model = ec_fw_string[0]
9289 | (ec_fw_string[1] << 8);
9290 tp->ec_release = (ec_fw_string[4] << 8)
9291 | ec_fw_string[5];
9292 } else {
9293 pr_notice("ThinkPad firmware release %s "
9294 "doesn't match the known patterns\n",
9295 ec_fw_string);
9296 pr_notice("please report this to %s\n",
9297 TPACPI_MAIL);
9298 }
9299 break;
9300 }
9301 }
9302
9303 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
9304 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
9305 tp->model_str = kstrdup(s, GFP_KERNEL);
9306 if (!tp->model_str)
9307 return -ENOMEM;
9308 } else {
9309 s = dmi_get_system_info(DMI_BIOS_VENDOR);
9310 if (s && !(strncasecmp(s, "Lenovo", 6))) {
9311 tp->model_str = kstrdup(s, GFP_KERNEL);
9312 if (!tp->model_str)
9313 return -ENOMEM;
9314 }
9315 }
9316
9317 s = dmi_get_system_info(DMI_PRODUCT_NAME);
9318 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
9319 if (s && !tp->nummodel_str)
9320 return -ENOMEM;
9321
9322 return 0;
9323}
9324
9325static int __init probe_for_thinkpad(void)
9326{
9327 int is_thinkpad;
9328
9329 if (acpi_disabled)
9330 return -ENODEV;
9331
9332 /* It would be dangerous to run the driver in this case */
9333 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
9334 return -ENODEV;
9335
9336 /*
9337 * Non-ancient models have better DMI tagging, but very old models
9338 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
9339 */
9340 is_thinkpad = (thinkpad_id.model_str != NULL) ||
9341 (thinkpad_id.ec_model != 0) ||
9342 tpacpi_is_fw_known();
9343
9344 /* The EC handler is required */
9345 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
9346 if (!ec_handle) {
9347 if (is_thinkpad)
9348 pr_err("Not yet supported ThinkPad detected!\n");
9349 return -ENODEV;
9350 }
9351
9352 if (!is_thinkpad && !force_load)
9353 return -ENODEV;
9354
9355 return 0;
9356}
9357
9358static void __init thinkpad_acpi_init_banner(void)
9359{
9360 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
9361 pr_info("%s\n", TPACPI_URL);
9362
9363 pr_info("ThinkPad BIOS %s, EC %s\n",
9364 (thinkpad_id.bios_version_str) ?
9365 thinkpad_id.bios_version_str : "unknown",
9366 (thinkpad_id.ec_version_str) ?
9367 thinkpad_id.ec_version_str : "unknown");
9368
9369 BUG_ON(!thinkpad_id.vendor);
9370
9371 if (thinkpad_id.model_str)
9372 pr_info("%s %s, model %s\n",
9373 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
9374 "IBM" : ((thinkpad_id.vendor ==
9375 PCI_VENDOR_ID_LENOVO) ?
9376 "Lenovo" : "Unknown vendor"),
9377 thinkpad_id.model_str,
9378 (thinkpad_id.nummodel_str) ?
9379 thinkpad_id.nummodel_str : "unknown");
9380}
9381
9382/* Module init, exit, parameters */
9383
9384static struct ibm_init_struct ibms_init[] __initdata = {
9385 {
9386 .data = &thinkpad_acpi_driver_data,
9387 },
9388 {
9389 .init = hotkey_init,
9390 .data = &hotkey_driver_data,
9391 },
9392 {
9393 .init = bluetooth_init,
9394 .data = &bluetooth_driver_data,
9395 },
9396 {
9397 .init = wan_init,
9398 .data = &wan_driver_data,
9399 },
9400 {
9401 .init = uwb_init,
9402 .data = &uwb_driver_data,
9403 },
9404#ifdef CONFIG_THINKPAD_ACPI_VIDEO
9405 {
9406 .init = video_init,
9407 .base_procfs_mode = S_IRUSR,
9408 .data = &video_driver_data,
9409 },
9410#endif
9411 {
9412 .init = kbdlight_init,
9413 .data = &kbdlight_driver_data,
9414 },
9415 {
9416 .init = light_init,
9417 .data = &light_driver_data,
9418 },
9419 {
9420 .init = cmos_init,
9421 .data = &cmos_driver_data,
9422 },
9423 {
9424 .init = led_init,
9425 .data = &led_driver_data,
9426 },
9427 {
9428 .init = beep_init,
9429 .data = &beep_driver_data,
9430 },
9431 {
9432 .init = thermal_init,
9433 .data = &thermal_driver_data,
9434 },
9435 {
9436 .init = brightness_init,
9437 .data = &brightness_driver_data,
9438 },
9439 {
9440 .init = volume_init,
9441 .data = &volume_driver_data,
9442 },
9443 {
9444 .init = fan_init,
9445 .data = &fan_driver_data,
9446 },
9447 {
9448 .init = mute_led_init,
9449 .data = &mute_led_driver_data,
9450 },
9451};
9452
9453static int __init set_ibm_param(const char *val, struct kernel_param *kp)
9454{
9455 unsigned int i;
9456 struct ibm_struct *ibm;
9457
9458 if (!kp || !kp->name || !val)
9459 return -EINVAL;
9460
9461 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9462 ibm = ibms_init[i].data;
9463 WARN_ON(ibm == NULL);
9464
9465 if (!ibm || !ibm->name)
9466 continue;
9467
9468 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
9469 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
9470 return -ENOSPC;
9471 strcpy(ibms_init[i].param, val);
9472 strcat(ibms_init[i].param, ",");
9473 return 0;
9474 }
9475 }
9476
9477 return -EINVAL;
9478}
9479
9480module_param(experimental, int, 0444);
9481MODULE_PARM_DESC(experimental,
9482 "Enables experimental features when non-zero");
9483
9484module_param_named(debug, dbg_level, uint, 0);
9485MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
9486
9487module_param(force_load, bool, 0444);
9488MODULE_PARM_DESC(force_load,
9489 "Attempts to load the driver even on a "
9490 "mis-identified ThinkPad when true");
9491
9492module_param_named(fan_control, fan_control_allowed, bool, 0444);
9493MODULE_PARM_DESC(fan_control,
9494 "Enables setting fan parameters features when true");
9495
9496module_param_named(brightness_mode, brightness_mode, uint, 0444);
9497MODULE_PARM_DESC(brightness_mode,
9498 "Selects brightness control strategy: "
9499 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
9500
9501module_param(brightness_enable, uint, 0444);
9502MODULE_PARM_DESC(brightness_enable,
9503 "Enables backlight control when 1, disables when 0");
9504
9505#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
9506module_param_named(volume_mode, volume_mode, uint, 0444);
9507MODULE_PARM_DESC(volume_mode,
9508 "Selects volume control strategy: "
9509 "0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
9510
9511module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
9512MODULE_PARM_DESC(volume_capabilities,
9513 "Selects the mixer capabilites: "
9514 "0=auto, 1=volume and mute, 2=mute only");
9515
9516module_param_named(volume_control, volume_control_allowed, bool, 0444);
9517MODULE_PARM_DESC(volume_control,
9518 "Enables software override for the console audio "
9519 "control when true");
9520
9521module_param_named(software_mute, software_mute_requested, bool, 0444);
9522MODULE_PARM_DESC(software_mute,
9523 "Request full software mute control");
9524
9525/* ALSA module API parameters */
9526module_param_named(index, alsa_index, int, 0444);
9527MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
9528module_param_named(id, alsa_id, charp, 0444);
9529MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
9530module_param_named(enable, alsa_enable, bool, 0444);
9531MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
9532#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
9533
9534#define TPACPI_PARAM(feature) \
9535 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
9536 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
9537 "at module load, see documentation")
9538
9539TPACPI_PARAM(hotkey);
9540TPACPI_PARAM(bluetooth);
9541TPACPI_PARAM(video);
9542TPACPI_PARAM(light);
9543TPACPI_PARAM(cmos);
9544TPACPI_PARAM(led);
9545TPACPI_PARAM(beep);
9546TPACPI_PARAM(brightness);
9547TPACPI_PARAM(volume);
9548TPACPI_PARAM(fan);
9549
9550#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
9551module_param(dbg_wlswemul, uint, 0444);
9552MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
9553module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
9554MODULE_PARM_DESC(wlsw_state,
9555 "Initial state of the emulated WLSW switch");
9556
9557module_param(dbg_bluetoothemul, uint, 0444);
9558MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
9559module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
9560MODULE_PARM_DESC(bluetooth_state,
9561 "Initial state of the emulated bluetooth switch");
9562
9563module_param(dbg_wwanemul, uint, 0444);
9564MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
9565module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
9566MODULE_PARM_DESC(wwan_state,
9567 "Initial state of the emulated WWAN switch");
9568
9569module_param(dbg_uwbemul, uint, 0444);
9570MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
9571module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
9572MODULE_PARM_DESC(uwb_state,
9573 "Initial state of the emulated UWB switch");
9574#endif
9575
9576static void thinkpad_acpi_module_exit(void)
9577{
9578 struct ibm_struct *ibm, *itmp;
9579
9580 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
9581
9582 list_for_each_entry_safe_reverse(ibm, itmp,
9583 &tpacpi_all_drivers,
9584 all_drivers) {
9585 ibm_exit(ibm);
9586 }
9587
9588 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
9589
9590 if (tpacpi_inputdev) {
9591 if (tp_features.input_device_registered)
9592 input_unregister_device(tpacpi_inputdev);
9593 else
9594 input_free_device(tpacpi_inputdev);
9595 kfree(hotkey_keycode_map);
9596 }
9597
9598 if (tpacpi_hwmon)
9599 hwmon_device_unregister(tpacpi_hwmon);
9600
9601 if (tp_features.sensors_pdev_attrs_registered)
9602 device_remove_file(&tpacpi_sensors_pdev->dev, &dev_attr_name);
9603 if (tpacpi_sensors_pdev)
9604 platform_device_unregister(tpacpi_sensors_pdev);
9605 if (tpacpi_pdev)
9606 platform_device_unregister(tpacpi_pdev);
9607
9608 if (tp_features.sensors_pdrv_attrs_registered)
9609 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
9610 if (tp_features.platform_drv_attrs_registered)
9611 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
9612
9613 if (tp_features.sensors_pdrv_registered)
9614 platform_driver_unregister(&tpacpi_hwmon_pdriver);
9615
9616 if (tp_features.platform_drv_registered)
9617 platform_driver_unregister(&tpacpi_pdriver);
9618
9619 if (proc_dir)
9620 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
9621
9622 if (tpacpi_wq)
9623 destroy_workqueue(tpacpi_wq);
9624
9625 kfree(thinkpad_id.bios_version_str);
9626 kfree(thinkpad_id.ec_version_str);
9627 kfree(thinkpad_id.model_str);
9628 kfree(thinkpad_id.nummodel_str);
9629}
9630
9631
9632static int __init thinkpad_acpi_module_init(void)
9633{
9634 int ret, i;
9635
9636 tpacpi_lifecycle = TPACPI_LIFE_INIT;
9637
9638 /* Driver-level probe */
9639
9640 ret = get_thinkpad_model_data(&thinkpad_id);
9641 if (ret) {
9642 pr_err("unable to get DMI data: %d\n", ret);
9643 thinkpad_acpi_module_exit();
9644 return ret;
9645 }
9646 ret = probe_for_thinkpad();
9647 if (ret) {
9648 thinkpad_acpi_module_exit();
9649 return ret;
9650 }
9651
9652 /* Driver initialization */
9653
9654 thinkpad_acpi_init_banner();
9655 tpacpi_check_outdated_fw();
9656
9657 TPACPI_ACPIHANDLE_INIT(ecrd);
9658 TPACPI_ACPIHANDLE_INIT(ecwr);
9659
9660 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
9661 if (!tpacpi_wq) {
9662 thinkpad_acpi_module_exit();
9663 return -ENOMEM;
9664 }
9665
9666 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
9667 if (!proc_dir) {
9668 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
9669 thinkpad_acpi_module_exit();
9670 return -ENODEV;
9671 }
9672
9673 ret = platform_driver_register(&tpacpi_pdriver);
9674 if (ret) {
9675 pr_err("unable to register main platform driver\n");
9676 thinkpad_acpi_module_exit();
9677 return ret;
9678 }
9679 tp_features.platform_drv_registered = 1;
9680
9681 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
9682 if (ret) {
9683 pr_err("unable to register hwmon platform driver\n");
9684 thinkpad_acpi_module_exit();
9685 return ret;
9686 }
9687 tp_features.sensors_pdrv_registered = 1;
9688
9689 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
9690 if (!ret) {
9691 tp_features.platform_drv_attrs_registered = 1;
9692 ret = tpacpi_create_driver_attributes(
9693 &tpacpi_hwmon_pdriver.driver);
9694 }
9695 if (ret) {
9696 pr_err("unable to create sysfs driver attributes\n");
9697 thinkpad_acpi_module_exit();
9698 return ret;
9699 }
9700 tp_features.sensors_pdrv_attrs_registered = 1;
9701
9702
9703 /* Device initialization */
9704 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
9705 NULL, 0);
9706 if (IS_ERR(tpacpi_pdev)) {
9707 ret = PTR_ERR(tpacpi_pdev);
9708 tpacpi_pdev = NULL;
9709 pr_err("unable to register platform device\n");
9710 thinkpad_acpi_module_exit();
9711 return ret;
9712 }
9713 tpacpi_sensors_pdev = platform_device_register_simple(
9714 TPACPI_HWMON_DRVR_NAME,
9715 -1, NULL, 0);
9716 if (IS_ERR(tpacpi_sensors_pdev)) {
9717 ret = PTR_ERR(tpacpi_sensors_pdev);
9718 tpacpi_sensors_pdev = NULL;
9719 pr_err("unable to register hwmon platform device\n");
9720 thinkpad_acpi_module_exit();
9721 return ret;
9722 }
9723 ret = device_create_file(&tpacpi_sensors_pdev->dev, &dev_attr_name);
9724 if (ret) {
9725 pr_err("unable to create sysfs hwmon device attributes\n");
9726 thinkpad_acpi_module_exit();
9727 return ret;
9728 }
9729 tp_features.sensors_pdev_attrs_registered = 1;
9730 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
9731 if (IS_ERR(tpacpi_hwmon)) {
9732 ret = PTR_ERR(tpacpi_hwmon);
9733 tpacpi_hwmon = NULL;
9734 pr_err("unable to register hwmon device\n");
9735 thinkpad_acpi_module_exit();
9736 return ret;
9737 }
9738 mutex_init(&tpacpi_inputdev_send_mutex);
9739 tpacpi_inputdev = input_allocate_device();
9740 if (!tpacpi_inputdev) {
9741 thinkpad_acpi_module_exit();
9742 return -ENOMEM;
9743 } else {
9744 /* Prepare input device, but don't register */
9745 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
9746 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
9747 tpacpi_inputdev->id.bustype = BUS_HOST;
9748 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
9749 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
9750 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
9751 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
9752 }
9753
9754 /* Init subdriver dependencies */
9755 tpacpi_detect_brightness_capabilities();
9756
9757 /* Init subdrivers */
9758 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
9759 ret = ibm_init(&ibms_init[i]);
9760 if (ret >= 0 && *ibms_init[i].param)
9761 ret = ibms_init[i].data->write(ibms_init[i].param);
9762 if (ret < 0) {
9763 thinkpad_acpi_module_exit();
9764 return ret;
9765 }
9766 }
9767
9768 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
9769
9770 ret = input_register_device(tpacpi_inputdev);
9771 if (ret < 0) {
9772 pr_err("unable to register input device\n");
9773 thinkpad_acpi_module_exit();
9774 return ret;
9775 } else {
9776 tp_features.input_device_registered = 1;
9777 }
9778
9779 return 0;
9780}
9781
9782MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
9783
9784/*
9785 * This will autoload the driver in almost every ThinkPad
9786 * in widespread use.
9787 *
9788 * Only _VERY_ old models, like the 240, 240x and 570 lack
9789 * the HKEY event interface.
9790 */
9791MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
9792
9793/*
9794 * DMI matching for module autoloading
9795 *
9796 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
9797 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
9798 *
9799 * Only models listed in thinkwiki will be supported, so add yours
9800 * if it is not there yet.
9801 */
9802#define IBM_BIOS_MODULE_ALIAS(__type) \
9803 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
9804
9805/* Ancient thinkpad BIOSes have to be identified by
9806 * BIOS type or model number, and there are far less
9807 * BIOS types than model numbers... */
9808IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
9809
9810MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
9811MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
9812MODULE_DESCRIPTION(TPACPI_DESC);
9813MODULE_VERSION(TPACPI_VERSION);
9814MODULE_LICENSE("GPL");
9815
9816module_init(thinkpad_acpi_module_init);
9817module_exit(thinkpad_acpi_module_exit);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * thinkpad_acpi.c - ThinkPad ACPI Extras
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
9#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10
11#define TPACPI_VERSION "0.26"
12#define TPACPI_SYSFS_VERSION 0x030000
13
14/*
15 * Changelog:
16 * 2007-10-20 changelog trimmed down
17 *
18 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
19 * drivers/misc.
20 *
21 * 2006-11-22 0.13 new maintainer
22 * changelog now lives in git commit history, and will
23 * not be updated further in-file.
24 *
25 * 2005-03-17 0.11 support for 600e, 770x
26 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
27 *
28 * 2005-01-16 0.9 use MODULE_VERSION
29 * thanks to Henrik Brix Andersen <brix@gentoo.org>
30 * fix parameter passing on module loading
31 * thanks to Rusty Russell <rusty@rustcorp.com.au>
32 * thanks to Jim Radford <radford@blackbean.org>
33 * 2004-11-08 0.8 fix init error case, don't return from a macro
34 * thanks to Chris Wright <chrisw@osdl.org>
35 */
36
37#include <linux/kernel.h>
38#include <linux/module.h>
39#include <linux/init.h>
40#include <linux/types.h>
41#include <linux/string.h>
42#include <linux/list.h>
43#include <linux/mutex.h>
44#include <linux/sched.h>
45#include <linux/sched/signal.h>
46#include <linux/kthread.h>
47#include <linux/freezer.h>
48#include <linux/delay.h>
49#include <linux/slab.h>
50#include <linux/nvram.h>
51#include <linux/proc_fs.h>
52#include <linux/seq_file.h>
53#include <linux/sysfs.h>
54#include <linux/backlight.h>
55#include <linux/bitops.h>
56#include <linux/fb.h>
57#include <linux/platform_device.h>
58#include <linux/hwmon.h>
59#include <linux/hwmon-sysfs.h>
60#include <linux/input.h>
61#include <linux/leds.h>
62#include <linux/rfkill.h>
63#include <linux/dmi.h>
64#include <linux/jiffies.h>
65#include <linux/workqueue.h>
66#include <linux/acpi.h>
67#include <linux/pci.h>
68#include <linux/power_supply.h>
69#include <sound/core.h>
70#include <sound/control.h>
71#include <sound/initval.h>
72#include <linux/uaccess.h>
73#include <acpi/battery.h>
74#include <acpi/video.h>
75
76/* ThinkPad CMOS commands */
77#define TP_CMOS_VOLUME_DOWN 0
78#define TP_CMOS_VOLUME_UP 1
79#define TP_CMOS_VOLUME_MUTE 2
80#define TP_CMOS_BRIGHTNESS_UP 4
81#define TP_CMOS_BRIGHTNESS_DOWN 5
82#define TP_CMOS_THINKLIGHT_ON 12
83#define TP_CMOS_THINKLIGHT_OFF 13
84
85/* NVRAM Addresses */
86enum tp_nvram_addr {
87 TP_NVRAM_ADDR_HK2 = 0x57,
88 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
89 TP_NVRAM_ADDR_VIDEO = 0x59,
90 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
91 TP_NVRAM_ADDR_MIXER = 0x60,
92};
93
94/* NVRAM bit masks */
95enum {
96 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
97 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
98 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
99 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
100 TP_NVRAM_MASK_THINKLIGHT = 0x10,
101 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
102 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
103 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
104 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
105 TP_NVRAM_MASK_MUTE = 0x40,
106 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
107 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
108 TP_NVRAM_POS_LEVEL_VOLUME = 0,
109};
110
111/* Misc NVRAM-related */
112enum {
113 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
114};
115
116/* ACPI HIDs */
117#define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
118#define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
119#define TPACPI_ACPI_LENOVO_HKEY_V2_HID "LEN0268"
120#define TPACPI_ACPI_EC_HID "PNP0C09"
121
122/* Input IDs */
123#define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
124#define TPACPI_HKEY_INPUT_VERSION 0x4101
125
126/* ACPI \WGSV commands */
127enum {
128 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
129 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
130 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
131 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
132};
133
134/* TP_ACPI_WGSV_GET_STATE bits */
135enum {
136 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
137 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
138 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
139 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
140 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
141 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
142 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
143 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
144 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
145 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
146};
147
148/* HKEY events */
149enum tpacpi_hkey_event_t {
150 /* Hotkey-related */
151 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
152 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
153 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
154 TP_HKEY_EV_KBD_LIGHT = 0x1012, /* Thinklight/kbd backlight */
155 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
156 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
157 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
158
159 /* Reasons for waking up from S3/S4 */
160 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
161 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
162 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
163 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
164 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
165 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
166
167 /* Auto-sleep after eject request */
168 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
169 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
170
171 /* Misc bay events */
172 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
173 TP_HKEY_EV_HOTPLUG_DOCK = 0x4010, /* docked into hotplug dock
174 or port replicator */
175 TP_HKEY_EV_HOTPLUG_UNDOCK = 0x4011, /* undocked from hotplug
176 dock or port replicator */
177
178 /* User-interface events */
179 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
180 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
181 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
182 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
183 TP_HKEY_EV_TABLET_CHANGED = 0x60c0, /* X1 Yoga (2016):
184 * enter/leave tablet mode
185 */
186 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
187 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
188 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
189
190 /* Key-related user-interface events */
191 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
192 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
193 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
194
195 /* Thermal events */
196 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
197 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
198 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
199 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
200 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* windows; thermal table changed */
201 TP_HKEY_EV_THM_CSM_COMPLETED = 0x6032, /* windows; thermal control set
202 * command completed. Related to
203 * AML DYTC */
204 TP_HKEY_EV_THM_TRANSFM_CHANGED = 0x60F0, /* windows; thermal transformation
205 * changed. Related to AML GMTS */
206
207 /* AC-related events */
208 TP_HKEY_EV_AC_CHANGED = 0x6040, /* AC status changed */
209
210 /* Further user-interface events */
211 TP_HKEY_EV_PALM_DETECTED = 0x60b0, /* palm hoveres keyboard */
212 TP_HKEY_EV_PALM_UNDETECTED = 0x60b1, /* palm removed */
213
214 /* Misc */
215 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
216};
217
218/****************************************************************************
219 * Main driver
220 */
221
222#define TPACPI_NAME "thinkpad"
223#define TPACPI_DESC "ThinkPad ACPI Extras"
224#define TPACPI_FILE TPACPI_NAME "_acpi"
225#define TPACPI_URL "http://ibm-acpi.sf.net/"
226#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
227
228#define TPACPI_PROC_DIR "ibm"
229#define TPACPI_ACPI_EVENT_PREFIX "ibm"
230#define TPACPI_DRVR_NAME TPACPI_FILE
231#define TPACPI_DRVR_SHORTNAME "tpacpi"
232#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
233
234#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
235#define TPACPI_WORKQUEUE_NAME "ktpacpid"
236
237#define TPACPI_MAX_ACPI_ARGS 3
238
239/* Debugging printk groups */
240#define TPACPI_DBG_ALL 0xffff
241#define TPACPI_DBG_DISCLOSETASK 0x8000
242#define TPACPI_DBG_INIT 0x0001
243#define TPACPI_DBG_EXIT 0x0002
244#define TPACPI_DBG_RFKILL 0x0004
245#define TPACPI_DBG_HKEY 0x0008
246#define TPACPI_DBG_FAN 0x0010
247#define TPACPI_DBG_BRGHT 0x0020
248#define TPACPI_DBG_MIXER 0x0040
249
250#define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
251#define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
252#define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
253
254
255/****************************************************************************
256 * Driver-wide structs and misc. variables
257 */
258
259struct ibm_struct;
260
261struct tp_acpi_drv_struct {
262 const struct acpi_device_id *hid;
263 struct acpi_driver *driver;
264
265 void (*notify) (struct ibm_struct *, u32);
266 acpi_handle *handle;
267 u32 type;
268 struct acpi_device *device;
269};
270
271struct ibm_struct {
272 char *name;
273
274 int (*read) (struct seq_file *);
275 int (*write) (char *);
276 void (*exit) (void);
277 void (*resume) (void);
278 void (*suspend) (void);
279 void (*shutdown) (void);
280
281 struct list_head all_drivers;
282
283 struct tp_acpi_drv_struct *acpi;
284
285 struct {
286 u8 acpi_driver_registered:1;
287 u8 acpi_notify_installed:1;
288 u8 proc_created:1;
289 u8 init_called:1;
290 u8 experimental:1;
291 } flags;
292};
293
294struct ibm_init_struct {
295 char param[32];
296
297 int (*init) (struct ibm_init_struct *);
298 umode_t base_procfs_mode;
299 struct ibm_struct *data;
300};
301
302static struct {
303 u32 bluetooth:1;
304 u32 hotkey:1;
305 u32 hotkey_mask:1;
306 u32 hotkey_wlsw:1;
307 enum {
308 TP_HOTKEY_TABLET_NONE = 0,
309 TP_HOTKEY_TABLET_USES_MHKG,
310 TP_HOTKEY_TABLET_USES_GMMS,
311 } hotkey_tablet;
312 u32 kbdlight:1;
313 u32 light:1;
314 u32 light_status:1;
315 u32 bright_acpimode:1;
316 u32 bright_unkfw:1;
317 u32 wan:1;
318 u32 uwb:1;
319 u32 fan_ctrl_status_undef:1;
320 u32 second_fan:1;
321 u32 second_fan_ctl:1;
322 u32 beep_needs_two_args:1;
323 u32 mixer_no_level_control:1;
324 u32 battery_force_primary:1;
325 u32 input_device_registered:1;
326 u32 platform_drv_registered:1;
327 u32 platform_drv_attrs_registered:1;
328 u32 sensors_pdrv_registered:1;
329 u32 sensors_pdrv_attrs_registered:1;
330 u32 sensors_pdev_attrs_registered:1;
331 u32 hotkey_poll_active:1;
332 u32 has_adaptive_kbd:1;
333} tp_features;
334
335static struct {
336 u16 hotkey_mask_ff:1;
337 u16 volume_ctrl_forbidden:1;
338} tp_warned;
339
340struct thinkpad_id_data {
341 unsigned int vendor; /* ThinkPad vendor:
342 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
343
344 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
345 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
346
347 u32 bios_model; /* 1Y = 0x3159, 0 = unknown */
348 u32 ec_model;
349 u16 bios_release; /* 1ZETK1WW = 0x4b31, 0 = unknown */
350 u16 ec_release;
351
352 char *model_str; /* ThinkPad T43 */
353 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
354};
355static struct thinkpad_id_data thinkpad_id;
356
357static enum {
358 TPACPI_LIFE_INIT = 0,
359 TPACPI_LIFE_RUNNING,
360 TPACPI_LIFE_EXITING,
361} tpacpi_lifecycle;
362
363static int experimental;
364static u32 dbg_level;
365
366static struct workqueue_struct *tpacpi_wq;
367
368enum led_status_t {
369 TPACPI_LED_OFF = 0,
370 TPACPI_LED_ON,
371 TPACPI_LED_BLINK,
372};
373
374/* tpacpi LED class */
375struct tpacpi_led_classdev {
376 struct led_classdev led_classdev;
377 int led;
378};
379
380/* brightness level capabilities */
381static unsigned int bright_maxlvl; /* 0 = unknown */
382
383#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
384static int dbg_wlswemul;
385static bool tpacpi_wlsw_emulstate;
386static int dbg_bluetoothemul;
387static bool tpacpi_bluetooth_emulstate;
388static int dbg_wwanemul;
389static bool tpacpi_wwan_emulstate;
390static int dbg_uwbemul;
391static bool tpacpi_uwb_emulstate;
392#endif
393
394
395/*************************************************************************
396 * Debugging helpers
397 */
398
399#define dbg_printk(a_dbg_level, format, arg...) \
400do { \
401 if (dbg_level & (a_dbg_level)) \
402 printk(KERN_DEBUG pr_fmt("%s: " format), \
403 __func__, ##arg); \
404} while (0)
405
406#ifdef CONFIG_THINKPAD_ACPI_DEBUG
407#define vdbg_printk dbg_printk
408static const char *str_supported(int is_supported);
409#else
410static inline const char *str_supported(int is_supported) { return ""; }
411#define vdbg_printk(a_dbg_level, format, arg...) \
412 do { if (0) no_printk(format, ##arg); } while (0)
413#endif
414
415static void tpacpi_log_usertask(const char * const what)
416{
417 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
418 what, task_tgid_vnr(current));
419}
420
421#define tpacpi_disclose_usertask(what, format, arg...) \
422do { \
423 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
424 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
425 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
426 what, task_tgid_vnr(current), ## arg); \
427 } \
428} while (0)
429
430/*
431 * Quirk handling helpers
432 *
433 * ThinkPad IDs and versions seen in the field so far are
434 * two or three characters from the set [0-9A-Z], i.e. base 36.
435 *
436 * We use values well outside that range as specials.
437 */
438
439#define TPACPI_MATCH_ANY 0xffffffffU
440#define TPACPI_MATCH_ANY_VERSION 0xffffU
441#define TPACPI_MATCH_UNKNOWN 0U
442
443/* TPID('1', 'Y') == 0x3159 */
444#define TPID(__c1, __c2) (((__c1) << 8) | (__c2))
445#define TPID3(__c1, __c2, __c3) (((__c1) << 16) | ((__c2) << 8) | (__c3))
446#define TPVER TPID
447
448#define TPACPI_Q_IBM(__id1, __id2, __quirk) \
449 { .vendor = PCI_VENDOR_ID_IBM, \
450 .bios = TPID(__id1, __id2), \
451 .ec = TPACPI_MATCH_ANY, \
452 .quirks = (__quirk) }
453
454#define TPACPI_Q_LNV(__id1, __id2, __quirk) \
455 { .vendor = PCI_VENDOR_ID_LENOVO, \
456 .bios = TPID(__id1, __id2), \
457 .ec = TPACPI_MATCH_ANY, \
458 .quirks = (__quirk) }
459
460#define TPACPI_Q_LNV3(__id1, __id2, __id3, __quirk) \
461 { .vendor = PCI_VENDOR_ID_LENOVO, \
462 .bios = TPID3(__id1, __id2, __id3), \
463 .ec = TPACPI_MATCH_ANY, \
464 .quirks = (__quirk) }
465
466#define TPACPI_QEC_IBM(__id1, __id2, __quirk) \
467 { .vendor = PCI_VENDOR_ID_IBM, \
468 .bios = TPACPI_MATCH_ANY, \
469 .ec = TPID(__id1, __id2), \
470 .quirks = (__quirk) }
471
472#define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
473 { .vendor = PCI_VENDOR_ID_LENOVO, \
474 .bios = TPACPI_MATCH_ANY, \
475 .ec = TPID(__id1, __id2), \
476 .quirks = (__quirk) }
477
478struct tpacpi_quirk {
479 unsigned int vendor;
480 u32 bios;
481 u32 ec;
482 unsigned long quirks;
483};
484
485/**
486 * tpacpi_check_quirks() - search BIOS/EC version on a list
487 * @qlist: array of &struct tpacpi_quirk
488 * @qlist_size: number of elements in @qlist
489 *
490 * Iterates over a quirks list until one is found that matches the
491 * ThinkPad's vendor, BIOS and EC model.
492 *
493 * Returns 0 if nothing matches, otherwise returns the quirks field of
494 * the matching &struct tpacpi_quirk entry.
495 *
496 * The match criteria is: vendor, ec and bios much match.
497 */
498static unsigned long __init tpacpi_check_quirks(
499 const struct tpacpi_quirk *qlist,
500 unsigned int qlist_size)
501{
502 while (qlist_size) {
503 if ((qlist->vendor == thinkpad_id.vendor ||
504 qlist->vendor == TPACPI_MATCH_ANY) &&
505 (qlist->bios == thinkpad_id.bios_model ||
506 qlist->bios == TPACPI_MATCH_ANY) &&
507 (qlist->ec == thinkpad_id.ec_model ||
508 qlist->ec == TPACPI_MATCH_ANY))
509 return qlist->quirks;
510
511 qlist_size--;
512 qlist++;
513 }
514 return 0;
515}
516
517static inline bool __pure __init tpacpi_is_lenovo(void)
518{
519 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
520}
521
522static inline bool __pure __init tpacpi_is_ibm(void)
523{
524 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
525}
526
527/****************************************************************************
528 ****************************************************************************
529 *
530 * ACPI Helpers and device model
531 *
532 ****************************************************************************
533 ****************************************************************************/
534
535/*************************************************************************
536 * ACPI basic handles
537 */
538
539static acpi_handle root_handle;
540static acpi_handle ec_handle;
541
542#define TPACPI_HANDLE(object, parent, paths...) \
543 static acpi_handle object##_handle; \
544 static const acpi_handle * const object##_parent __initconst = \
545 &parent##_handle; \
546 static char *object##_paths[] __initdata = { paths }
547
548TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
549TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
550
551TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
552 /* T4x, X31, X40 */
553 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
554 "\\CMS", /* R40, R40e */
555 ); /* all others */
556
557TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
558 "^HKEY", /* R30, R31 */
559 "HKEY", /* all others */
560 ); /* 570 */
561
562/*************************************************************************
563 * ACPI helpers
564 */
565
566static int acpi_evalf(acpi_handle handle,
567 int *res, char *method, char *fmt, ...)
568{
569 char *fmt0 = fmt;
570 struct acpi_object_list params;
571 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
572 struct acpi_buffer result, *resultp;
573 union acpi_object out_obj;
574 acpi_status status;
575 va_list ap;
576 char res_type;
577 int success;
578 int quiet;
579
580 if (!*fmt) {
581 pr_err("acpi_evalf() called with empty format\n");
582 return 0;
583 }
584
585 if (*fmt == 'q') {
586 quiet = 1;
587 fmt++;
588 } else
589 quiet = 0;
590
591 res_type = *(fmt++);
592
593 params.count = 0;
594 params.pointer = &in_objs[0];
595
596 va_start(ap, fmt);
597 while (*fmt) {
598 char c = *(fmt++);
599 switch (c) {
600 case 'd': /* int */
601 in_objs[params.count].integer.value = va_arg(ap, int);
602 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
603 break;
604 /* add more types as needed */
605 default:
606 pr_err("acpi_evalf() called with invalid format character '%c'\n",
607 c);
608 va_end(ap);
609 return 0;
610 }
611 }
612 va_end(ap);
613
614 if (res_type != 'v') {
615 result.length = sizeof(out_obj);
616 result.pointer = &out_obj;
617 resultp = &result;
618 } else
619 resultp = NULL;
620
621 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
622
623 switch (res_type) {
624 case 'd': /* int */
625 success = (status == AE_OK &&
626 out_obj.type == ACPI_TYPE_INTEGER);
627 if (success && res)
628 *res = out_obj.integer.value;
629 break;
630 case 'v': /* void */
631 success = status == AE_OK;
632 break;
633 /* add more types as needed */
634 default:
635 pr_err("acpi_evalf() called with invalid format character '%c'\n",
636 res_type);
637 return 0;
638 }
639
640 if (!success && !quiet)
641 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
642 method, fmt0, acpi_format_exception(status));
643
644 return success;
645}
646
647static int acpi_ec_read(int i, u8 *p)
648{
649 int v;
650
651 if (ecrd_handle) {
652 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
653 return 0;
654 *p = v;
655 } else {
656 if (ec_read(i, p) < 0)
657 return 0;
658 }
659
660 return 1;
661}
662
663static int acpi_ec_write(int i, u8 v)
664{
665 if (ecwr_handle) {
666 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
667 return 0;
668 } else {
669 if (ec_write(i, v) < 0)
670 return 0;
671 }
672
673 return 1;
674}
675
676static int issue_thinkpad_cmos_command(int cmos_cmd)
677{
678 if (!cmos_handle)
679 return -ENXIO;
680
681 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
682 return -EIO;
683
684 return 0;
685}
686
687/*************************************************************************
688 * ACPI device model
689 */
690
691#define TPACPI_ACPIHANDLE_INIT(object) \
692 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
693 object##_paths, ARRAY_SIZE(object##_paths))
694
695static void __init drv_acpi_handle_init(const char *name,
696 acpi_handle *handle, const acpi_handle parent,
697 char **paths, const int num_paths)
698{
699 int i;
700 acpi_status status;
701
702 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
703 name);
704
705 for (i = 0; i < num_paths; i++) {
706 status = acpi_get_handle(parent, paths[i], handle);
707 if (ACPI_SUCCESS(status)) {
708 dbg_printk(TPACPI_DBG_INIT,
709 "Found ACPI handle %s for %s\n",
710 paths[i], name);
711 return;
712 }
713 }
714
715 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
716 name);
717 *handle = NULL;
718}
719
720static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
721 u32 level, void *context, void **return_value)
722{
723 struct acpi_device *dev;
724 if (!strcmp(context, "video")) {
725 if (acpi_bus_get_device(handle, &dev))
726 return AE_OK;
727 if (strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
728 return AE_OK;
729 }
730
731 *(acpi_handle *)return_value = handle;
732
733 return AE_CTRL_TERMINATE;
734}
735
736static void __init tpacpi_acpi_handle_locate(const char *name,
737 const char *hid,
738 acpi_handle *handle)
739{
740 acpi_status status;
741 acpi_handle device_found;
742
743 BUG_ON(!name || !handle);
744 vdbg_printk(TPACPI_DBG_INIT,
745 "trying to locate ACPI handle for %s, using HID %s\n",
746 name, hid ? hid : "NULL");
747
748 memset(&device_found, 0, sizeof(device_found));
749 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
750 (void *)name, &device_found);
751
752 *handle = NULL;
753
754 if (ACPI_SUCCESS(status)) {
755 *handle = device_found;
756 dbg_printk(TPACPI_DBG_INIT,
757 "Found ACPI handle for %s\n", name);
758 } else {
759 vdbg_printk(TPACPI_DBG_INIT,
760 "Could not locate an ACPI handle for %s: %s\n",
761 name, acpi_format_exception(status));
762 }
763}
764
765static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
766{
767 struct ibm_struct *ibm = data;
768
769 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
770 return;
771
772 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
773 return;
774
775 ibm->acpi->notify(ibm, event);
776}
777
778static int __init setup_acpi_notify(struct ibm_struct *ibm)
779{
780 acpi_status status;
781 int rc;
782
783 BUG_ON(!ibm->acpi);
784
785 if (!*ibm->acpi->handle)
786 return 0;
787
788 vdbg_printk(TPACPI_DBG_INIT,
789 "setting up ACPI notify for %s\n", ibm->name);
790
791 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
792 if (rc < 0) {
793 pr_err("acpi_bus_get_device(%s) failed: %d\n", ibm->name, rc);
794 return -ENODEV;
795 }
796
797 ibm->acpi->device->driver_data = ibm;
798 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
799 TPACPI_ACPI_EVENT_PREFIX,
800 ibm->name);
801
802 status = acpi_install_notify_handler(*ibm->acpi->handle,
803 ibm->acpi->type, dispatch_acpi_notify, ibm);
804 if (ACPI_FAILURE(status)) {
805 if (status == AE_ALREADY_EXISTS) {
806 pr_notice("another device driver is already handling %s events\n",
807 ibm->name);
808 } else {
809 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
810 ibm->name, acpi_format_exception(status));
811 }
812 return -ENODEV;
813 }
814 ibm->flags.acpi_notify_installed = 1;
815 return 0;
816}
817
818static int __init tpacpi_device_add(struct acpi_device *device)
819{
820 return 0;
821}
822
823static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
824{
825 int rc;
826
827 dbg_printk(TPACPI_DBG_INIT,
828 "registering %s as an ACPI driver\n", ibm->name);
829
830 BUG_ON(!ibm->acpi);
831
832 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
833 if (!ibm->acpi->driver) {
834 pr_err("failed to allocate memory for ibm->acpi->driver\n");
835 return -ENOMEM;
836 }
837
838 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
839 ibm->acpi->driver->ids = ibm->acpi->hid;
840
841 ibm->acpi->driver->ops.add = &tpacpi_device_add;
842
843 rc = acpi_bus_register_driver(ibm->acpi->driver);
844 if (rc < 0) {
845 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
846 ibm->name, rc);
847 kfree(ibm->acpi->driver);
848 ibm->acpi->driver = NULL;
849 } else if (!rc)
850 ibm->flags.acpi_driver_registered = 1;
851
852 return rc;
853}
854
855
856/****************************************************************************
857 ****************************************************************************
858 *
859 * Procfs Helpers
860 *
861 ****************************************************************************
862 ****************************************************************************/
863
864static int dispatch_proc_show(struct seq_file *m, void *v)
865{
866 struct ibm_struct *ibm = m->private;
867
868 if (!ibm || !ibm->read)
869 return -EINVAL;
870 return ibm->read(m);
871}
872
873static int dispatch_proc_open(struct inode *inode, struct file *file)
874{
875 return single_open(file, dispatch_proc_show, PDE_DATA(inode));
876}
877
878static ssize_t dispatch_proc_write(struct file *file,
879 const char __user *userbuf,
880 size_t count, loff_t *pos)
881{
882 struct ibm_struct *ibm = PDE_DATA(file_inode(file));
883 char *kernbuf;
884 int ret;
885
886 if (!ibm || !ibm->write)
887 return -EINVAL;
888 if (count > PAGE_SIZE - 1)
889 return -EINVAL;
890
891 kernbuf = kmalloc(count + 1, GFP_KERNEL);
892 if (!kernbuf)
893 return -ENOMEM;
894
895 if (copy_from_user(kernbuf, userbuf, count)) {
896 kfree(kernbuf);
897 return -EFAULT;
898 }
899
900 kernbuf[count] = 0;
901 ret = ibm->write(kernbuf);
902 if (ret == 0)
903 ret = count;
904
905 kfree(kernbuf);
906
907 return ret;
908}
909
910static const struct proc_ops dispatch_proc_ops = {
911 .proc_open = dispatch_proc_open,
912 .proc_read = seq_read,
913 .proc_lseek = seq_lseek,
914 .proc_release = single_release,
915 .proc_write = dispatch_proc_write,
916};
917
918/****************************************************************************
919 ****************************************************************************
920 *
921 * Device model: input, hwmon and platform
922 *
923 ****************************************************************************
924 ****************************************************************************/
925
926static struct platform_device *tpacpi_pdev;
927static struct platform_device *tpacpi_sensors_pdev;
928static struct device *tpacpi_hwmon;
929static struct input_dev *tpacpi_inputdev;
930static struct mutex tpacpi_inputdev_send_mutex;
931static LIST_HEAD(tpacpi_all_drivers);
932
933#ifdef CONFIG_PM_SLEEP
934static int tpacpi_suspend_handler(struct device *dev)
935{
936 struct ibm_struct *ibm, *itmp;
937
938 list_for_each_entry_safe(ibm, itmp,
939 &tpacpi_all_drivers,
940 all_drivers) {
941 if (ibm->suspend)
942 (ibm->suspend)();
943 }
944
945 return 0;
946}
947
948static int tpacpi_resume_handler(struct device *dev)
949{
950 struct ibm_struct *ibm, *itmp;
951
952 list_for_each_entry_safe(ibm, itmp,
953 &tpacpi_all_drivers,
954 all_drivers) {
955 if (ibm->resume)
956 (ibm->resume)();
957 }
958
959 return 0;
960}
961#endif
962
963static SIMPLE_DEV_PM_OPS(tpacpi_pm,
964 tpacpi_suspend_handler, tpacpi_resume_handler);
965
966static void tpacpi_shutdown_handler(struct platform_device *pdev)
967{
968 struct ibm_struct *ibm, *itmp;
969
970 list_for_each_entry_safe(ibm, itmp,
971 &tpacpi_all_drivers,
972 all_drivers) {
973 if (ibm->shutdown)
974 (ibm->shutdown)();
975 }
976}
977
978static struct platform_driver tpacpi_pdriver = {
979 .driver = {
980 .name = TPACPI_DRVR_NAME,
981 .pm = &tpacpi_pm,
982 },
983 .shutdown = tpacpi_shutdown_handler,
984};
985
986static struct platform_driver tpacpi_hwmon_pdriver = {
987 .driver = {
988 .name = TPACPI_HWMON_DRVR_NAME,
989 },
990};
991
992/*************************************************************************
993 * sysfs support helpers
994 */
995
996struct attribute_set {
997 unsigned int members, max_members;
998 struct attribute_group group;
999};
1000
1001struct attribute_set_obj {
1002 struct attribute_set s;
1003 struct attribute *a;
1004} __attribute__((packed));
1005
1006static struct attribute_set *create_attr_set(unsigned int max_members,
1007 const char *name)
1008{
1009 struct attribute_set_obj *sobj;
1010
1011 if (max_members == 0)
1012 return NULL;
1013
1014 /* Allocates space for implicit NULL at the end too */
1015 sobj = kzalloc(sizeof(struct attribute_set_obj) +
1016 max_members * sizeof(struct attribute *),
1017 GFP_KERNEL);
1018 if (!sobj)
1019 return NULL;
1020 sobj->s.max_members = max_members;
1021 sobj->s.group.attrs = &sobj->a;
1022 sobj->s.group.name = name;
1023
1024 return &sobj->s;
1025}
1026
1027#define destroy_attr_set(_set) \
1028 kfree(_set);
1029
1030/* not multi-threaded safe, use it in a single thread per set */
1031static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
1032{
1033 if (!s || !attr)
1034 return -EINVAL;
1035
1036 if (s->members >= s->max_members)
1037 return -ENOMEM;
1038
1039 s->group.attrs[s->members] = attr;
1040 s->members++;
1041
1042 return 0;
1043}
1044
1045static int add_many_to_attr_set(struct attribute_set *s,
1046 struct attribute **attr,
1047 unsigned int count)
1048{
1049 int i, res;
1050
1051 for (i = 0; i < count; i++) {
1052 res = add_to_attr_set(s, attr[i]);
1053 if (res)
1054 return res;
1055 }
1056
1057 return 0;
1058}
1059
1060static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
1061{
1062 sysfs_remove_group(kobj, &s->group);
1063 destroy_attr_set(s);
1064}
1065
1066#define register_attr_set_with_sysfs(_attr_set, _kobj) \
1067 sysfs_create_group(_kobj, &_attr_set->group)
1068
1069static int parse_strtoul(const char *buf,
1070 unsigned long max, unsigned long *value)
1071{
1072 char *endp;
1073
1074 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1075 endp = skip_spaces(endp);
1076 if (*endp || *value > max)
1077 return -EINVAL;
1078
1079 return 0;
1080}
1081
1082static void tpacpi_disable_brightness_delay(void)
1083{
1084 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1085 pr_notice("ACPI backlight control delay disabled\n");
1086}
1087
1088static void printk_deprecated_attribute(const char * const what,
1089 const char * const details)
1090{
1091 tpacpi_log_usertask("deprecated sysfs attribute");
1092 pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1093 what, details);
1094}
1095
1096/*************************************************************************
1097 * rfkill and radio control support helpers
1098 */
1099
1100/*
1101 * ThinkPad-ACPI firmware handling model:
1102 *
1103 * WLSW (master wireless switch) is event-driven, and is common to all
1104 * firmware-controlled radios. It cannot be controlled, just monitored,
1105 * as expected. It overrides all radio state in firmware
1106 *
1107 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1108 * (TODO: verify how WLSW interacts with the returned radio state).
1109 *
1110 * The only time there are shadow radio state changes, is when
1111 * masked-off hotkeys are used.
1112 */
1113
1114/*
1115 * Internal driver API for radio state:
1116 *
1117 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1118 * bool: true means radio blocked (off)
1119 */
1120enum tpacpi_rfkill_state {
1121 TPACPI_RFK_RADIO_OFF = 0,
1122 TPACPI_RFK_RADIO_ON
1123};
1124
1125/* rfkill switches */
1126enum tpacpi_rfk_id {
1127 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1128 TPACPI_RFK_WWAN_SW_ID,
1129 TPACPI_RFK_UWB_SW_ID,
1130 TPACPI_RFK_SW_MAX
1131};
1132
1133static const char *tpacpi_rfkill_names[] = {
1134 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1135 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1136 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1137 [TPACPI_RFK_SW_MAX] = NULL
1138};
1139
1140/* ThinkPad-ACPI rfkill subdriver */
1141struct tpacpi_rfk {
1142 struct rfkill *rfkill;
1143 enum tpacpi_rfk_id id;
1144 const struct tpacpi_rfk_ops *ops;
1145};
1146
1147struct tpacpi_rfk_ops {
1148 /* firmware interface */
1149 int (*get_status)(void);
1150 int (*set_status)(const enum tpacpi_rfkill_state);
1151};
1152
1153static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1154
1155/* Query FW and update rfkill sw state for a given rfkill switch */
1156static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1157{
1158 int status;
1159
1160 if (!tp_rfk)
1161 return -ENODEV;
1162
1163 status = (tp_rfk->ops->get_status)();
1164 if (status < 0)
1165 return status;
1166
1167 rfkill_set_sw_state(tp_rfk->rfkill,
1168 (status == TPACPI_RFK_RADIO_OFF));
1169
1170 return status;
1171}
1172
1173/* Query FW and update rfkill sw state for all rfkill switches */
1174static void tpacpi_rfk_update_swstate_all(void)
1175{
1176 unsigned int i;
1177
1178 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1179 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1180}
1181
1182/*
1183 * Sync the HW-blocking state of all rfkill switches,
1184 * do notice it causes the rfkill core to schedule uevents
1185 */
1186static void tpacpi_rfk_update_hwblock_state(bool blocked)
1187{
1188 unsigned int i;
1189 struct tpacpi_rfk *tp_rfk;
1190
1191 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1192 tp_rfk = tpacpi_rfkill_switches[i];
1193 if (tp_rfk) {
1194 if (rfkill_set_hw_state(tp_rfk->rfkill,
1195 blocked)) {
1196 /* ignore -- we track sw block */
1197 }
1198 }
1199 }
1200}
1201
1202/* Call to get the WLSW state from the firmware */
1203static int hotkey_get_wlsw(void);
1204
1205/* Call to query WLSW state and update all rfkill switches */
1206static bool tpacpi_rfk_check_hwblock_state(void)
1207{
1208 int res = hotkey_get_wlsw();
1209 int hw_blocked;
1210
1211 /* When unknown or unsupported, we have to assume it is unblocked */
1212 if (res < 0)
1213 return false;
1214
1215 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1216 tpacpi_rfk_update_hwblock_state(hw_blocked);
1217
1218 return hw_blocked;
1219}
1220
1221static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1222{
1223 struct tpacpi_rfk *tp_rfk = data;
1224 int res;
1225
1226 dbg_printk(TPACPI_DBG_RFKILL,
1227 "request to change radio state to %s\n",
1228 blocked ? "blocked" : "unblocked");
1229
1230 /* try to set radio state */
1231 res = (tp_rfk->ops->set_status)(blocked ?
1232 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1233
1234 /* and update the rfkill core with whatever the FW really did */
1235 tpacpi_rfk_update_swstate(tp_rfk);
1236
1237 return (res < 0) ? res : 0;
1238}
1239
1240static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1241 .set_block = tpacpi_rfk_hook_set_block,
1242};
1243
1244static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1245 const struct tpacpi_rfk_ops *tp_rfkops,
1246 const enum rfkill_type rfktype,
1247 const char *name,
1248 const bool set_default)
1249{
1250 struct tpacpi_rfk *atp_rfk;
1251 int res;
1252 bool sw_state = false;
1253 bool hw_state;
1254 int sw_status;
1255
1256 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1257
1258 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1259 if (atp_rfk)
1260 atp_rfk->rfkill = rfkill_alloc(name,
1261 &tpacpi_pdev->dev,
1262 rfktype,
1263 &tpacpi_rfk_rfkill_ops,
1264 atp_rfk);
1265 if (!atp_rfk || !atp_rfk->rfkill) {
1266 pr_err("failed to allocate memory for rfkill class\n");
1267 kfree(atp_rfk);
1268 return -ENOMEM;
1269 }
1270
1271 atp_rfk->id = id;
1272 atp_rfk->ops = tp_rfkops;
1273
1274 sw_status = (tp_rfkops->get_status)();
1275 if (sw_status < 0) {
1276 pr_err("failed to read initial state for %s, error %d\n",
1277 name, sw_status);
1278 } else {
1279 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1280 if (set_default) {
1281 /* try to keep the initial state, since we ask the
1282 * firmware to preserve it across S5 in NVRAM */
1283 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1284 }
1285 }
1286 hw_state = tpacpi_rfk_check_hwblock_state();
1287 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1288
1289 res = rfkill_register(atp_rfk->rfkill);
1290 if (res < 0) {
1291 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1292 rfkill_destroy(atp_rfk->rfkill);
1293 kfree(atp_rfk);
1294 return res;
1295 }
1296
1297 tpacpi_rfkill_switches[id] = atp_rfk;
1298
1299 pr_info("rfkill switch %s: radio is %sblocked\n",
1300 name, (sw_state || hw_state) ? "" : "un");
1301 return 0;
1302}
1303
1304static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1305{
1306 struct tpacpi_rfk *tp_rfk;
1307
1308 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1309
1310 tp_rfk = tpacpi_rfkill_switches[id];
1311 if (tp_rfk) {
1312 rfkill_unregister(tp_rfk->rfkill);
1313 rfkill_destroy(tp_rfk->rfkill);
1314 tpacpi_rfkill_switches[id] = NULL;
1315 kfree(tp_rfk);
1316 }
1317}
1318
1319static void printk_deprecated_rfkill_attribute(const char * const what)
1320{
1321 printk_deprecated_attribute(what,
1322 "Please switch to generic rfkill before year 2010");
1323}
1324
1325/* sysfs <radio> enable ------------------------------------------------ */
1326static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1327 struct device_attribute *attr,
1328 char *buf)
1329{
1330 int status;
1331
1332 printk_deprecated_rfkill_attribute(attr->attr.name);
1333
1334 /* This is in the ABI... */
1335 if (tpacpi_rfk_check_hwblock_state()) {
1336 status = TPACPI_RFK_RADIO_OFF;
1337 } else {
1338 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1339 if (status < 0)
1340 return status;
1341 }
1342
1343 return snprintf(buf, PAGE_SIZE, "%d\n",
1344 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1345}
1346
1347static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1348 struct device_attribute *attr,
1349 const char *buf, size_t count)
1350{
1351 unsigned long t;
1352 int res;
1353
1354 printk_deprecated_rfkill_attribute(attr->attr.name);
1355
1356 if (parse_strtoul(buf, 1, &t))
1357 return -EINVAL;
1358
1359 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1360
1361 /* This is in the ABI... */
1362 if (tpacpi_rfk_check_hwblock_state() && !!t)
1363 return -EPERM;
1364
1365 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1366 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1367 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1368
1369 return (res < 0) ? res : count;
1370}
1371
1372/* procfs -------------------------------------------------------------- */
1373static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1374{
1375 if (id >= TPACPI_RFK_SW_MAX)
1376 seq_printf(m, "status:\t\tnot supported\n");
1377 else {
1378 int status;
1379
1380 /* This is in the ABI... */
1381 if (tpacpi_rfk_check_hwblock_state()) {
1382 status = TPACPI_RFK_RADIO_OFF;
1383 } else {
1384 status = tpacpi_rfk_update_swstate(
1385 tpacpi_rfkill_switches[id]);
1386 if (status < 0)
1387 return status;
1388 }
1389
1390 seq_printf(m, "status:\t\t%s\n",
1391 (status == TPACPI_RFK_RADIO_ON) ?
1392 "enabled" : "disabled");
1393 seq_printf(m, "commands:\tenable, disable\n");
1394 }
1395
1396 return 0;
1397}
1398
1399static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1400{
1401 char *cmd;
1402 int status = -1;
1403 int res = 0;
1404
1405 if (id >= TPACPI_RFK_SW_MAX)
1406 return -ENODEV;
1407
1408 while ((cmd = strsep(&buf, ","))) {
1409 if (strlencmp(cmd, "enable") == 0)
1410 status = TPACPI_RFK_RADIO_ON;
1411 else if (strlencmp(cmd, "disable") == 0)
1412 status = TPACPI_RFK_RADIO_OFF;
1413 else
1414 return -EINVAL;
1415 }
1416
1417 if (status != -1) {
1418 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1419 (status == TPACPI_RFK_RADIO_ON) ?
1420 "enable" : "disable",
1421 tpacpi_rfkill_names[id]);
1422 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1423 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1424 }
1425
1426 return res;
1427}
1428
1429/*************************************************************************
1430 * thinkpad-acpi driver attributes
1431 */
1432
1433/* interface_version --------------------------------------------------- */
1434static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1435{
1436 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1437}
1438static DRIVER_ATTR_RO(interface_version);
1439
1440/* debug_level --------------------------------------------------------- */
1441static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1442{
1443 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1444}
1445
1446static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1447 size_t count)
1448{
1449 unsigned long t;
1450
1451 if (parse_strtoul(buf, 0xffff, &t))
1452 return -EINVAL;
1453
1454 dbg_level = t;
1455
1456 return count;
1457}
1458static DRIVER_ATTR_RW(debug_level);
1459
1460/* version ------------------------------------------------------------- */
1461static ssize_t version_show(struct device_driver *drv, char *buf)
1462{
1463 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1464 TPACPI_DESC, TPACPI_VERSION);
1465}
1466static DRIVER_ATTR_RO(version);
1467
1468/* --------------------------------------------------------------------- */
1469
1470#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1471
1472/* wlsw_emulstate ------------------------------------------------------ */
1473static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1474{
1475 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1476}
1477
1478static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1479 size_t count)
1480{
1481 unsigned long t;
1482
1483 if (parse_strtoul(buf, 1, &t))
1484 return -EINVAL;
1485
1486 if (tpacpi_wlsw_emulstate != !!t) {
1487 tpacpi_wlsw_emulstate = !!t;
1488 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1489 }
1490
1491 return count;
1492}
1493static DRIVER_ATTR_RW(wlsw_emulstate);
1494
1495/* bluetooth_emulstate ------------------------------------------------- */
1496static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1497{
1498 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1499}
1500
1501static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1502 const char *buf, size_t count)
1503{
1504 unsigned long t;
1505
1506 if (parse_strtoul(buf, 1, &t))
1507 return -EINVAL;
1508
1509 tpacpi_bluetooth_emulstate = !!t;
1510
1511 return count;
1512}
1513static DRIVER_ATTR_RW(bluetooth_emulstate);
1514
1515/* wwan_emulstate ------------------------------------------------- */
1516static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1517{
1518 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1519}
1520
1521static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1522 size_t count)
1523{
1524 unsigned long t;
1525
1526 if (parse_strtoul(buf, 1, &t))
1527 return -EINVAL;
1528
1529 tpacpi_wwan_emulstate = !!t;
1530
1531 return count;
1532}
1533static DRIVER_ATTR_RW(wwan_emulstate);
1534
1535/* uwb_emulstate ------------------------------------------------- */
1536static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1537{
1538 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1539}
1540
1541static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1542 size_t count)
1543{
1544 unsigned long t;
1545
1546 if (parse_strtoul(buf, 1, &t))
1547 return -EINVAL;
1548
1549 tpacpi_uwb_emulstate = !!t;
1550
1551 return count;
1552}
1553static DRIVER_ATTR_RW(uwb_emulstate);
1554#endif
1555
1556/* --------------------------------------------------------------------- */
1557
1558static struct driver_attribute *tpacpi_driver_attributes[] = {
1559 &driver_attr_debug_level, &driver_attr_version,
1560 &driver_attr_interface_version,
1561};
1562
1563static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1564{
1565 int i, res;
1566
1567 i = 0;
1568 res = 0;
1569 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1570 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1571 i++;
1572 }
1573
1574#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1575 if (!res && dbg_wlswemul)
1576 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1577 if (!res && dbg_bluetoothemul)
1578 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1579 if (!res && dbg_wwanemul)
1580 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1581 if (!res && dbg_uwbemul)
1582 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1583#endif
1584
1585 return res;
1586}
1587
1588static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1589{
1590 int i;
1591
1592 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1593 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1594
1595#ifdef THINKPAD_ACPI_DEBUGFACILITIES
1596 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1597 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1598 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1599 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1600#endif
1601}
1602
1603/*************************************************************************
1604 * Firmware Data
1605 */
1606
1607/*
1608 * Table of recommended minimum BIOS versions
1609 *
1610 * Reasons for listing:
1611 * 1. Stable BIOS, listed because the unknown amount of
1612 * bugs and bad ACPI behaviour on older versions
1613 *
1614 * 2. BIOS or EC fw with known bugs that trigger on Linux
1615 *
1616 * 3. BIOS with known reduced functionality in older versions
1617 *
1618 * We recommend the latest BIOS and EC version.
1619 * We only support the latest BIOS and EC fw version as a rule.
1620 *
1621 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1622 * Information from users in ThinkWiki
1623 *
1624 * WARNING: we use this table also to detect that the machine is
1625 * a ThinkPad in some cases, so don't remove entries lightly.
1626 */
1627
1628#define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1629 { .vendor = (__v), \
1630 .bios = TPID(__id1, __id2), \
1631 .ec = TPACPI_MATCH_ANY, \
1632 .quirks = TPACPI_MATCH_ANY_VERSION << 16 \
1633 | TPVER(__bv1, __bv2) }
1634
1635#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1636 __eid, __ev1, __ev2) \
1637 { .vendor = (__v), \
1638 .bios = TPID(__bid1, __bid2), \
1639 .ec = __eid, \
1640 .quirks = TPVER(__ev1, __ev2) << 16 \
1641 | TPVER(__bv1, __bv2) }
1642
1643#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1644 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1645
1646/* Outdated IBM BIOSes often lack the EC id string */
1647#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1648 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1649 __bv1, __bv2, TPID(__id1, __id2), \
1650 __ev1, __ev2), \
1651 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1652 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1653 __ev1, __ev2)
1654
1655/* Outdated IBM BIOSes often lack the EC id string */
1656#define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1657 __eid1, __eid2, __ev1, __ev2) \
1658 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1659 __bv1, __bv2, TPID(__eid1, __eid2), \
1660 __ev1, __ev2), \
1661 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1662 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1663 __ev1, __ev2)
1664
1665#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1666 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1667
1668#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1669 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1670 __bv1, __bv2, TPID(__id1, __id2), \
1671 __ev1, __ev2)
1672
1673#define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1674 __eid1, __eid2, __ev1, __ev2) \
1675 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1676 __bv1, __bv2, TPID(__eid1, __eid2), \
1677 __ev1, __ev2)
1678
1679static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1680 /* Numeric models ------------------ */
1681 /* FW MODEL BIOS VERS */
1682 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1683 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1684 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1685 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1686 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1687 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1688 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1689 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1690 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1691
1692 /* A-series ------------------------- */
1693 /* FW MODEL BIOS VERS EC VERS */
1694 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1695 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1696 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1697 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1698 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1699 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1700 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1701 TPV_QI0('1', '3', '2', '0'), /* A22m */
1702 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1703 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1704 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1705
1706 /* G-series ------------------------- */
1707 /* FW MODEL BIOS VERS */
1708 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1709 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1710
1711 /* R-series, T-series --------------- */
1712 /* FW MODEL BIOS VERS EC VERS */
1713 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1714 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1715 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1716 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1717 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1718 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1719 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1720 T40/p, T41/p, T42/p (1) */
1721 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1722 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1723 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1724 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1725
1726 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1727 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1728 TPV_QI0('1', '6', '3', '2'), /* T22 */
1729 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1730 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1731 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1732
1733 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1734 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1735 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1736
1737 /* BIOS FW BIOS VERS EC FW EC VERS */
1738 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1739 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1740
1741 /* X-series ------------------------- */
1742 /* FW MODEL BIOS VERS EC VERS */
1743 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1744 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1745 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1746 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1747 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1748 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1749 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1750
1751 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1752 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1753
1754 /* (0) - older versions lack DMI EC fw string and functionality */
1755 /* (1) - older versions known to lack functionality */
1756};
1757
1758#undef TPV_QL1
1759#undef TPV_QL0
1760#undef TPV_QI2
1761#undef TPV_QI1
1762#undef TPV_QI0
1763#undef TPV_Q_X
1764#undef TPV_Q
1765
1766static void __init tpacpi_check_outdated_fw(void)
1767{
1768 unsigned long fwvers;
1769 u16 ec_version, bios_version;
1770
1771 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1772 ARRAY_SIZE(tpacpi_bios_version_qtable));
1773
1774 if (!fwvers)
1775 return;
1776
1777 bios_version = fwvers & 0xffffU;
1778 ec_version = (fwvers >> 16) & 0xffffU;
1779
1780 /* note that unknown versions are set to 0x0000 and we use that */
1781 if ((bios_version > thinkpad_id.bios_release) ||
1782 (ec_version > thinkpad_id.ec_release &&
1783 ec_version != TPACPI_MATCH_ANY_VERSION)) {
1784 /*
1785 * The changelogs would let us track down the exact
1786 * reason, but it is just too much of a pain to track
1787 * it. We only list BIOSes that are either really
1788 * broken, or really stable to begin with, so it is
1789 * best if the user upgrades the firmware anyway.
1790 */
1791 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1792 pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1793 }
1794}
1795
1796static bool __init tpacpi_is_fw_known(void)
1797{
1798 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1799 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1800}
1801
1802/****************************************************************************
1803 ****************************************************************************
1804 *
1805 * Subdrivers
1806 *
1807 ****************************************************************************
1808 ****************************************************************************/
1809
1810/*************************************************************************
1811 * thinkpad-acpi metadata subdriver
1812 */
1813
1814static int thinkpad_acpi_driver_read(struct seq_file *m)
1815{
1816 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1817 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1818 return 0;
1819}
1820
1821static struct ibm_struct thinkpad_acpi_driver_data = {
1822 .name = "driver",
1823 .read = thinkpad_acpi_driver_read,
1824};
1825
1826/*************************************************************************
1827 * Hotkey subdriver
1828 */
1829
1830/*
1831 * ThinkPad firmware event model
1832 *
1833 * The ThinkPad firmware has two main event interfaces: normal ACPI
1834 * notifications (which follow the ACPI standard), and a private event
1835 * interface.
1836 *
1837 * The private event interface also issues events for the hotkeys. As
1838 * the driver gained features, the event handling code ended up being
1839 * built around the hotkey subdriver. This will need to be refactored
1840 * to a more formal event API eventually.
1841 *
1842 * Some "hotkeys" are actually supposed to be used as event reports,
1843 * such as "brightness has changed", "volume has changed", depending on
1844 * the ThinkPad model and how the firmware is operating.
1845 *
1846 * Unlike other classes, hotkey-class events have mask/unmask control on
1847 * non-ancient firmware. However, how it behaves changes a lot with the
1848 * firmware model and version.
1849 */
1850
1851enum { /* hot key scan codes (derived from ACPI DSDT) */
1852 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1853 TP_ACPI_HOTKEYSCAN_FNF2,
1854 TP_ACPI_HOTKEYSCAN_FNF3,
1855 TP_ACPI_HOTKEYSCAN_FNF4,
1856 TP_ACPI_HOTKEYSCAN_FNF5,
1857 TP_ACPI_HOTKEYSCAN_FNF6,
1858 TP_ACPI_HOTKEYSCAN_FNF7,
1859 TP_ACPI_HOTKEYSCAN_FNF8,
1860 TP_ACPI_HOTKEYSCAN_FNF9,
1861 TP_ACPI_HOTKEYSCAN_FNF10,
1862 TP_ACPI_HOTKEYSCAN_FNF11,
1863 TP_ACPI_HOTKEYSCAN_FNF12,
1864 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1865 TP_ACPI_HOTKEYSCAN_FNINSERT,
1866 TP_ACPI_HOTKEYSCAN_FNDELETE,
1867 TP_ACPI_HOTKEYSCAN_FNHOME,
1868 TP_ACPI_HOTKEYSCAN_FNEND,
1869 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1870 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1871 TP_ACPI_HOTKEYSCAN_FNSPACE,
1872 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1873 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1874 TP_ACPI_HOTKEYSCAN_MUTE,
1875 TP_ACPI_HOTKEYSCAN_THINKPAD,
1876 TP_ACPI_HOTKEYSCAN_UNK1,
1877 TP_ACPI_HOTKEYSCAN_UNK2,
1878 TP_ACPI_HOTKEYSCAN_UNK3,
1879 TP_ACPI_HOTKEYSCAN_UNK4,
1880 TP_ACPI_HOTKEYSCAN_UNK5,
1881 TP_ACPI_HOTKEYSCAN_UNK6,
1882 TP_ACPI_HOTKEYSCAN_UNK7,
1883 TP_ACPI_HOTKEYSCAN_UNK8,
1884
1885 /* Adaptive keyboard keycodes */
1886 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1887 TP_ACPI_HOTKEYSCAN_MUTE2 = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1888 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1889 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1890 TP_ACPI_HOTKEYSCAN_CLOUD,
1891 TP_ACPI_HOTKEYSCAN_UNK9,
1892 TP_ACPI_HOTKEYSCAN_VOICE,
1893 TP_ACPI_HOTKEYSCAN_UNK10,
1894 TP_ACPI_HOTKEYSCAN_GESTURES,
1895 TP_ACPI_HOTKEYSCAN_UNK11,
1896 TP_ACPI_HOTKEYSCAN_UNK12,
1897 TP_ACPI_HOTKEYSCAN_UNK13,
1898 TP_ACPI_HOTKEYSCAN_CONFIG,
1899 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1900 TP_ACPI_HOTKEYSCAN_RELOAD,
1901 TP_ACPI_HOTKEYSCAN_BACK,
1902 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1903 TP_ACPI_HOTKEYSCAN_MIC_UP,
1904 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1905 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1906 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1907
1908 /* Lenovo extended keymap, starting at 0x1300 */
1909 TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1910 /* first new observed key (star, favorites) is 0x1311 */
1911 TP_ACPI_HOTKEYSCAN_STAR = 69,
1912 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1913 TP_ACPI_HOTKEYSCAN_CALCULATOR,
1914 TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1915 TP_ACPI_HOTKEYSCAN_KEYBOARD,
1916
1917 /* Hotkey keymap size */
1918 TPACPI_HOTKEY_MAP_LEN
1919};
1920
1921enum { /* Keys/events available through NVRAM polling */
1922 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1923 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1924};
1925
1926enum { /* Positions of some of the keys in hotkey masks */
1927 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1928 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1929 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1930 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1931 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1932 TP_ACPI_HKEY_KBD_LIGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1933 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1934 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1935 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1936 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1937 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1938};
1939
1940enum { /* NVRAM to ACPI HKEY group map */
1941 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1942 TP_ACPI_HKEY_ZOOM_MASK |
1943 TP_ACPI_HKEY_DISPSWTCH_MASK |
1944 TP_ACPI_HKEY_HIBERNATE_MASK,
1945 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1946 TP_ACPI_HKEY_BRGHTDWN_MASK,
1947 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1948 TP_ACPI_HKEY_VOLDWN_MASK |
1949 TP_ACPI_HKEY_MUTE_MASK,
1950};
1951
1952#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1953struct tp_nvram_state {
1954 u16 thinkpad_toggle:1;
1955 u16 zoom_toggle:1;
1956 u16 display_toggle:1;
1957 u16 thinklight_toggle:1;
1958 u16 hibernate_toggle:1;
1959 u16 displayexp_toggle:1;
1960 u16 display_state:1;
1961 u16 brightness_toggle:1;
1962 u16 volume_toggle:1;
1963 u16 mute:1;
1964
1965 u8 brightness_level;
1966 u8 volume_level;
1967};
1968
1969/* kthread for the hotkey poller */
1970static struct task_struct *tpacpi_hotkey_task;
1971
1972/*
1973 * Acquire mutex to write poller control variables as an
1974 * atomic block.
1975 *
1976 * Increment hotkey_config_change when changing them if you
1977 * want the kthread to forget old state.
1978 *
1979 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1980 */
1981static struct mutex hotkey_thread_data_mutex;
1982static unsigned int hotkey_config_change;
1983
1984/*
1985 * hotkey poller control variables
1986 *
1987 * Must be atomic or readers will also need to acquire mutex
1988 *
1989 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1990 * should be used only when the changes need to be taken as
1991 * a block, OR when one needs to force the kthread to forget
1992 * old state.
1993 */
1994static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
1995static unsigned int hotkey_poll_freq = 10; /* Hz */
1996
1997#define HOTKEY_CONFIG_CRITICAL_START \
1998 do { \
1999 mutex_lock(&hotkey_thread_data_mutex); \
2000 hotkey_config_change++; \
2001 } while (0);
2002#define HOTKEY_CONFIG_CRITICAL_END \
2003 mutex_unlock(&hotkey_thread_data_mutex);
2004
2005#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2006
2007#define hotkey_source_mask 0U
2008#define HOTKEY_CONFIG_CRITICAL_START
2009#define HOTKEY_CONFIG_CRITICAL_END
2010
2011#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2012
2013static struct mutex hotkey_mutex;
2014
2015static enum { /* Reasons for waking up */
2016 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2017 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2018 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2019} hotkey_wakeup_reason;
2020
2021static int hotkey_autosleep_ack;
2022
2023static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2024static u32 hotkey_all_mask; /* all events supported in fw */
2025static u32 hotkey_adaptive_all_mask; /* all adaptive events supported in fw */
2026static u32 hotkey_reserved_mask; /* events better left disabled */
2027static u32 hotkey_driver_mask; /* events needed by the driver */
2028static u32 hotkey_user_mask; /* events visible to userspace */
2029static u32 hotkey_acpi_mask; /* events enabled in firmware */
2030
2031static u16 *hotkey_keycode_map;
2032
2033static struct attribute_set *hotkey_dev_attributes;
2034
2035static void tpacpi_driver_event(const unsigned int hkey_event);
2036static void hotkey_driver_event(const unsigned int scancode);
2037static void hotkey_poll_setup(const bool may_warn);
2038
2039/* HKEY.MHKG() return bits */
2040#define TP_HOTKEY_TABLET_MASK (1 << 3)
2041enum {
2042 TP_ACPI_MULTI_MODE_INVALID = 0,
2043 TP_ACPI_MULTI_MODE_UNKNOWN = 1 << 0,
2044 TP_ACPI_MULTI_MODE_LAPTOP = 1 << 1,
2045 TP_ACPI_MULTI_MODE_TABLET = 1 << 2,
2046 TP_ACPI_MULTI_MODE_FLAT = 1 << 3,
2047 TP_ACPI_MULTI_MODE_STAND = 1 << 4,
2048 TP_ACPI_MULTI_MODE_TENT = 1 << 5,
2049 TP_ACPI_MULTI_MODE_STAND_TENT = 1 << 6,
2050};
2051
2052enum {
2053 /* The following modes are considered tablet mode for the purpose of
2054 * reporting the status to userspace. i.e. in all these modes it makes
2055 * sense to disable the laptop input devices such as touchpad and
2056 * keyboard.
2057 */
2058 TP_ACPI_MULTI_MODE_TABLET_LIKE = TP_ACPI_MULTI_MODE_TABLET |
2059 TP_ACPI_MULTI_MODE_STAND |
2060 TP_ACPI_MULTI_MODE_TENT |
2061 TP_ACPI_MULTI_MODE_STAND_TENT,
2062};
2063
2064static int hotkey_get_wlsw(void)
2065{
2066 int status;
2067
2068 if (!tp_features.hotkey_wlsw)
2069 return -ENODEV;
2070
2071#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2072 if (dbg_wlswemul)
2073 return (tpacpi_wlsw_emulstate) ?
2074 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2075#endif
2076
2077 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2078 return -EIO;
2079
2080 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2081}
2082
2083static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
2084{
2085 int type = (s >> 16) & 0xffff;
2086 int value = s & 0xffff;
2087 int mode = TP_ACPI_MULTI_MODE_INVALID;
2088 int valid_modes = 0;
2089
2090 if (has_tablet_mode)
2091 *has_tablet_mode = 0;
2092
2093 switch (type) {
2094 case 1:
2095 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2096 TP_ACPI_MULTI_MODE_TABLET |
2097 TP_ACPI_MULTI_MODE_STAND_TENT;
2098 break;
2099 case 2:
2100 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2101 TP_ACPI_MULTI_MODE_FLAT |
2102 TP_ACPI_MULTI_MODE_TABLET |
2103 TP_ACPI_MULTI_MODE_STAND |
2104 TP_ACPI_MULTI_MODE_TENT;
2105 break;
2106 case 3:
2107 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2108 TP_ACPI_MULTI_MODE_FLAT;
2109 break;
2110 case 4:
2111 case 5:
2112 /* In mode 4, FLAT is not specified as a valid mode. However,
2113 * it can be seen at least on the X1 Yoga 2nd Generation.
2114 */
2115 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
2116 TP_ACPI_MULTI_MODE_FLAT |
2117 TP_ACPI_MULTI_MODE_TABLET |
2118 TP_ACPI_MULTI_MODE_STAND |
2119 TP_ACPI_MULTI_MODE_TENT;
2120 break;
2121 default:
2122 pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
2123 type, value, TPACPI_MAIL);
2124 return 0;
2125 }
2126
2127 if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
2128 *has_tablet_mode = 1;
2129
2130 switch (value) {
2131 case 1:
2132 mode = TP_ACPI_MULTI_MODE_LAPTOP;
2133 break;
2134 case 2:
2135 mode = TP_ACPI_MULTI_MODE_FLAT;
2136 break;
2137 case 3:
2138 mode = TP_ACPI_MULTI_MODE_TABLET;
2139 break;
2140 case 4:
2141 if (type == 1)
2142 mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2143 else
2144 mode = TP_ACPI_MULTI_MODE_STAND;
2145 break;
2146 case 5:
2147 mode = TP_ACPI_MULTI_MODE_TENT;
2148 break;
2149 default:
2150 if (type == 5 && value == 0xffff) {
2151 pr_warn("Multi mode status is undetected, assuming laptop\n");
2152 return 0;
2153 }
2154 }
2155
2156 if (!(mode & valid_modes)) {
2157 pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2158 value, type, TPACPI_MAIL);
2159 return 0;
2160 }
2161
2162 return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2163}
2164
2165static int hotkey_get_tablet_mode(int *status)
2166{
2167 int s;
2168
2169 switch (tp_features.hotkey_tablet) {
2170 case TP_HOTKEY_TABLET_USES_MHKG:
2171 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2172 return -EIO;
2173
2174 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2175 break;
2176 case TP_HOTKEY_TABLET_USES_GMMS:
2177 if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2178 return -EIO;
2179
2180 *status = hotkey_gmms_get_tablet_mode(s, NULL);
2181 break;
2182 default:
2183 break;
2184 }
2185
2186 return 0;
2187}
2188
2189/*
2190 * Reads current event mask from firmware, and updates
2191 * hotkey_acpi_mask accordingly. Also resets any bits
2192 * from hotkey_user_mask that are unavailable to be
2193 * delivered (shadow requirement of the userspace ABI).
2194 *
2195 * Call with hotkey_mutex held
2196 */
2197static int hotkey_mask_get(void)
2198{
2199 if (tp_features.hotkey_mask) {
2200 u32 m = 0;
2201
2202 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2203 return -EIO;
2204
2205 hotkey_acpi_mask = m;
2206 } else {
2207 /* no mask support doesn't mean no event support... */
2208 hotkey_acpi_mask = hotkey_all_mask;
2209 }
2210
2211 /* sync userspace-visible mask */
2212 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2213
2214 return 0;
2215}
2216
2217static void hotkey_mask_warn_incomplete_mask(void)
2218{
2219 /* log only what the user can fix... */
2220 const u32 wantedmask = hotkey_driver_mask &
2221 ~(hotkey_acpi_mask | hotkey_source_mask) &
2222 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2223
2224 if (wantedmask)
2225 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2226}
2227
2228/*
2229 * Set the firmware mask when supported
2230 *
2231 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2232 *
2233 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2234 *
2235 * Call with hotkey_mutex held
2236 */
2237static int hotkey_mask_set(u32 mask)
2238{
2239 int i;
2240 int rc = 0;
2241
2242 const u32 fwmask = mask & ~hotkey_source_mask;
2243
2244 if (tp_features.hotkey_mask) {
2245 for (i = 0; i < 32; i++) {
2246 if (!acpi_evalf(hkey_handle,
2247 NULL, "MHKM", "vdd", i + 1,
2248 !!(mask & (1 << i)))) {
2249 rc = -EIO;
2250 break;
2251 }
2252 }
2253 }
2254
2255 /*
2256 * We *must* make an inconditional call to hotkey_mask_get to
2257 * refresh hotkey_acpi_mask and update hotkey_user_mask
2258 *
2259 * Take the opportunity to also log when we cannot _enable_
2260 * a given event.
2261 */
2262 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2263 pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2264 fwmask, hotkey_acpi_mask);
2265 }
2266
2267 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2268 hotkey_mask_warn_incomplete_mask();
2269
2270 return rc;
2271}
2272
2273/*
2274 * Sets hotkey_user_mask and tries to set the firmware mask
2275 *
2276 * Call with hotkey_mutex held
2277 */
2278static int hotkey_user_mask_set(const u32 mask)
2279{
2280 int rc;
2281
2282 /* Give people a chance to notice they are doing something that
2283 * is bound to go boom on their users sooner or later */
2284 if (!tp_warned.hotkey_mask_ff &&
2285 (mask == 0xffff || mask == 0xffffff ||
2286 mask == 0xffffffff)) {
2287 tp_warned.hotkey_mask_ff = 1;
2288 pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2289 mask);
2290 pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2291 }
2292
2293 /* Try to enable what the user asked for, plus whatever we need.
2294 * this syncs everything but won't enable bits in hotkey_user_mask */
2295 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2296
2297 /* Enable the available bits in hotkey_user_mask */
2298 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2299
2300 return rc;
2301}
2302
2303/*
2304 * Sets the driver hotkey mask.
2305 *
2306 * Can be called even if the hotkey subdriver is inactive
2307 */
2308static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2309{
2310 int rc;
2311
2312 /* Do the right thing if hotkey_init has not been called yet */
2313 if (!tp_features.hotkey) {
2314 hotkey_driver_mask = mask;
2315 return 0;
2316 }
2317
2318 mutex_lock(&hotkey_mutex);
2319
2320 HOTKEY_CONFIG_CRITICAL_START
2321 hotkey_driver_mask = mask;
2322#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2323 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2324#endif
2325 HOTKEY_CONFIG_CRITICAL_END
2326
2327 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2328 ~hotkey_source_mask);
2329 hotkey_poll_setup(true);
2330
2331 mutex_unlock(&hotkey_mutex);
2332
2333 return rc;
2334}
2335
2336static int hotkey_status_get(int *status)
2337{
2338 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2339 return -EIO;
2340
2341 return 0;
2342}
2343
2344static int hotkey_status_set(bool enable)
2345{
2346 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2347 return -EIO;
2348
2349 return 0;
2350}
2351
2352static void tpacpi_input_send_tabletsw(void)
2353{
2354 int state;
2355
2356 if (tp_features.hotkey_tablet &&
2357 !hotkey_get_tablet_mode(&state)) {
2358 mutex_lock(&tpacpi_inputdev_send_mutex);
2359
2360 input_report_switch(tpacpi_inputdev,
2361 SW_TABLET_MODE, !!state);
2362 input_sync(tpacpi_inputdev);
2363
2364 mutex_unlock(&tpacpi_inputdev_send_mutex);
2365 }
2366}
2367
2368/* Do NOT call without validating scancode first */
2369static void tpacpi_input_send_key(const unsigned int scancode)
2370{
2371 const unsigned int keycode = hotkey_keycode_map[scancode];
2372
2373 if (keycode != KEY_RESERVED) {
2374 mutex_lock(&tpacpi_inputdev_send_mutex);
2375
2376 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2377 input_report_key(tpacpi_inputdev, keycode, 1);
2378 input_sync(tpacpi_inputdev);
2379
2380 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2381 input_report_key(tpacpi_inputdev, keycode, 0);
2382 input_sync(tpacpi_inputdev);
2383
2384 mutex_unlock(&tpacpi_inputdev_send_mutex);
2385 }
2386}
2387
2388/* Do NOT call without validating scancode first */
2389static void tpacpi_input_send_key_masked(const unsigned int scancode)
2390{
2391 hotkey_driver_event(scancode);
2392 if (hotkey_user_mask & (1 << scancode))
2393 tpacpi_input_send_key(scancode);
2394}
2395
2396#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2397static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2398
2399/* Do NOT call without validating scancode first */
2400static void tpacpi_hotkey_send_key(unsigned int scancode)
2401{
2402 tpacpi_input_send_key_masked(scancode);
2403}
2404
2405static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2406{
2407 u8 d;
2408
2409 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2410 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2411 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2412 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2413 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2414 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2415 }
2416 if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2417 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2418 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2419 }
2420 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2421 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2422 n->displayexp_toggle =
2423 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2424 }
2425 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2426 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2427 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2428 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2429 n->brightness_toggle =
2430 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2431 }
2432 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2433 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2434 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2435 >> TP_NVRAM_POS_LEVEL_VOLUME;
2436 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2437 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2438 }
2439}
2440
2441#define TPACPI_COMPARE_KEY(__scancode, __member) \
2442do { \
2443 if ((event_mask & (1 << __scancode)) && \
2444 oldn->__member != newn->__member) \
2445 tpacpi_hotkey_send_key(__scancode); \
2446} while (0)
2447
2448#define TPACPI_MAY_SEND_KEY(__scancode) \
2449do { \
2450 if (event_mask & (1 << __scancode)) \
2451 tpacpi_hotkey_send_key(__scancode); \
2452} while (0)
2453
2454static void issue_volchange(const unsigned int oldvol,
2455 const unsigned int newvol,
2456 const u32 event_mask)
2457{
2458 unsigned int i = oldvol;
2459
2460 while (i > newvol) {
2461 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2462 i--;
2463 }
2464 while (i < newvol) {
2465 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2466 i++;
2467 }
2468}
2469
2470static void issue_brightnesschange(const unsigned int oldbrt,
2471 const unsigned int newbrt,
2472 const u32 event_mask)
2473{
2474 unsigned int i = oldbrt;
2475
2476 while (i > newbrt) {
2477 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2478 i--;
2479 }
2480 while (i < newbrt) {
2481 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2482 i++;
2483 }
2484}
2485
2486static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2487 struct tp_nvram_state *newn,
2488 const u32 event_mask)
2489{
2490
2491 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2492 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2493 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2494 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2495
2496 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2497
2498 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2499
2500 /*
2501 * Handle volume
2502 *
2503 * This code is supposed to duplicate the IBM firmware behaviour:
2504 * - Pressing MUTE issues mute hotkey message, even when already mute
2505 * - Pressing Volume up/down issues volume up/down hotkey messages,
2506 * even when already at maximum or minimum volume
2507 * - The act of unmuting issues volume up/down notification,
2508 * depending which key was used to unmute
2509 *
2510 * We are constrained to what the NVRAM can tell us, which is not much
2511 * and certainly not enough if more than one volume hotkey was pressed
2512 * since the last poll cycle.
2513 *
2514 * Just to make our life interesting, some newer Lenovo ThinkPads have
2515 * bugs in the BIOS and may fail to update volume_toggle properly.
2516 */
2517 if (newn->mute) {
2518 /* muted */
2519 if (!oldn->mute ||
2520 oldn->volume_toggle != newn->volume_toggle ||
2521 oldn->volume_level != newn->volume_level) {
2522 /* recently muted, or repeated mute keypress, or
2523 * multiple presses ending in mute */
2524 issue_volchange(oldn->volume_level, newn->volume_level,
2525 event_mask);
2526 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2527 }
2528 } else {
2529 /* unmute */
2530 if (oldn->mute) {
2531 /* recently unmuted, issue 'unmute' keypress */
2532 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2533 }
2534 if (oldn->volume_level != newn->volume_level) {
2535 issue_volchange(oldn->volume_level, newn->volume_level,
2536 event_mask);
2537 } else if (oldn->volume_toggle != newn->volume_toggle) {
2538 /* repeated vol up/down keypress at end of scale ? */
2539 if (newn->volume_level == 0)
2540 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2541 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2542 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2543 }
2544 }
2545
2546 /* handle brightness */
2547 if (oldn->brightness_level != newn->brightness_level) {
2548 issue_brightnesschange(oldn->brightness_level,
2549 newn->brightness_level, event_mask);
2550 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2551 /* repeated key presses that didn't change state */
2552 if (newn->brightness_level == 0)
2553 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2554 else if (newn->brightness_level >= bright_maxlvl
2555 && !tp_features.bright_unkfw)
2556 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2557 }
2558
2559#undef TPACPI_COMPARE_KEY
2560#undef TPACPI_MAY_SEND_KEY
2561}
2562
2563/*
2564 * Polling driver
2565 *
2566 * We track all events in hotkey_source_mask all the time, since
2567 * most of them are edge-based. We only issue those requested by
2568 * hotkey_user_mask or hotkey_driver_mask, though.
2569 */
2570static int hotkey_kthread(void *data)
2571{
2572 struct tp_nvram_state s[2] = { 0 };
2573 u32 poll_mask, event_mask;
2574 unsigned int si, so;
2575 unsigned long t;
2576 unsigned int change_detector;
2577 unsigned int poll_freq;
2578 bool was_frozen;
2579
2580 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2581 goto exit;
2582
2583 set_freezable();
2584
2585 so = 0;
2586 si = 1;
2587 t = 0;
2588
2589 /* Initial state for compares */
2590 mutex_lock(&hotkey_thread_data_mutex);
2591 change_detector = hotkey_config_change;
2592 poll_mask = hotkey_source_mask;
2593 event_mask = hotkey_source_mask &
2594 (hotkey_driver_mask | hotkey_user_mask);
2595 poll_freq = hotkey_poll_freq;
2596 mutex_unlock(&hotkey_thread_data_mutex);
2597 hotkey_read_nvram(&s[so], poll_mask);
2598
2599 while (!kthread_should_stop()) {
2600 if (t == 0) {
2601 if (likely(poll_freq))
2602 t = 1000/poll_freq;
2603 else
2604 t = 100; /* should never happen... */
2605 }
2606 t = msleep_interruptible(t);
2607 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2608 break;
2609
2610 if (t > 0 && !was_frozen)
2611 continue;
2612
2613 mutex_lock(&hotkey_thread_data_mutex);
2614 if (was_frozen || hotkey_config_change != change_detector) {
2615 /* forget old state on thaw or config change */
2616 si = so;
2617 t = 0;
2618 change_detector = hotkey_config_change;
2619 }
2620 poll_mask = hotkey_source_mask;
2621 event_mask = hotkey_source_mask &
2622 (hotkey_driver_mask | hotkey_user_mask);
2623 poll_freq = hotkey_poll_freq;
2624 mutex_unlock(&hotkey_thread_data_mutex);
2625
2626 if (likely(poll_mask)) {
2627 hotkey_read_nvram(&s[si], poll_mask);
2628 if (likely(si != so)) {
2629 hotkey_compare_and_issue_event(&s[so], &s[si],
2630 event_mask);
2631 }
2632 }
2633
2634 so = si;
2635 si ^= 1;
2636 }
2637
2638exit:
2639 return 0;
2640}
2641
2642/* call with hotkey_mutex held */
2643static void hotkey_poll_stop_sync(void)
2644{
2645 if (tpacpi_hotkey_task) {
2646 kthread_stop(tpacpi_hotkey_task);
2647 tpacpi_hotkey_task = NULL;
2648 }
2649}
2650
2651/* call with hotkey_mutex held */
2652static void hotkey_poll_setup(const bool may_warn)
2653{
2654 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2655 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2656
2657 if (hotkey_poll_freq > 0 &&
2658 (poll_driver_mask ||
2659 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2660 if (!tpacpi_hotkey_task) {
2661 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2662 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2663 if (IS_ERR(tpacpi_hotkey_task)) {
2664 tpacpi_hotkey_task = NULL;
2665 pr_err("could not create kernel thread for hotkey polling\n");
2666 }
2667 }
2668 } else {
2669 hotkey_poll_stop_sync();
2670 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2671 hotkey_poll_freq == 0) {
2672 pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2673 poll_user_mask, poll_driver_mask);
2674 }
2675 }
2676}
2677
2678static void hotkey_poll_setup_safe(const bool may_warn)
2679{
2680 mutex_lock(&hotkey_mutex);
2681 hotkey_poll_setup(may_warn);
2682 mutex_unlock(&hotkey_mutex);
2683}
2684
2685/* call with hotkey_mutex held */
2686static void hotkey_poll_set_freq(unsigned int freq)
2687{
2688 if (!freq)
2689 hotkey_poll_stop_sync();
2690
2691 hotkey_poll_freq = freq;
2692}
2693
2694#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2695
2696static void hotkey_poll_setup(const bool __unused)
2697{
2698}
2699
2700static void hotkey_poll_setup_safe(const bool __unused)
2701{
2702}
2703
2704#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2705
2706static int hotkey_inputdev_open(struct input_dev *dev)
2707{
2708 switch (tpacpi_lifecycle) {
2709 case TPACPI_LIFE_INIT:
2710 case TPACPI_LIFE_RUNNING:
2711 hotkey_poll_setup_safe(false);
2712 return 0;
2713 case TPACPI_LIFE_EXITING:
2714 return -EBUSY;
2715 }
2716
2717 /* Should only happen if tpacpi_lifecycle is corrupt */
2718 BUG();
2719 return -EBUSY;
2720}
2721
2722static void hotkey_inputdev_close(struct input_dev *dev)
2723{
2724 /* disable hotkey polling when possible */
2725 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2726 !(hotkey_source_mask & hotkey_driver_mask))
2727 hotkey_poll_setup_safe(false);
2728}
2729
2730/* sysfs hotkey enable ------------------------------------------------- */
2731static ssize_t hotkey_enable_show(struct device *dev,
2732 struct device_attribute *attr,
2733 char *buf)
2734{
2735 int res, status;
2736
2737 printk_deprecated_attribute("hotkey_enable",
2738 "Hotkey reporting is always enabled");
2739
2740 res = hotkey_status_get(&status);
2741 if (res)
2742 return res;
2743
2744 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2745}
2746
2747static ssize_t hotkey_enable_store(struct device *dev,
2748 struct device_attribute *attr,
2749 const char *buf, size_t count)
2750{
2751 unsigned long t;
2752
2753 printk_deprecated_attribute("hotkey_enable",
2754 "Hotkeys can be disabled through hotkey_mask");
2755
2756 if (parse_strtoul(buf, 1, &t))
2757 return -EINVAL;
2758
2759 if (t == 0)
2760 return -EPERM;
2761
2762 return count;
2763}
2764
2765static DEVICE_ATTR_RW(hotkey_enable);
2766
2767/* sysfs hotkey mask --------------------------------------------------- */
2768static ssize_t hotkey_mask_show(struct device *dev,
2769 struct device_attribute *attr,
2770 char *buf)
2771{
2772 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2773}
2774
2775static ssize_t hotkey_mask_store(struct device *dev,
2776 struct device_attribute *attr,
2777 const char *buf, size_t count)
2778{
2779 unsigned long t;
2780 int res;
2781
2782 if (parse_strtoul(buf, 0xffffffffUL, &t))
2783 return -EINVAL;
2784
2785 if (mutex_lock_killable(&hotkey_mutex))
2786 return -ERESTARTSYS;
2787
2788 res = hotkey_user_mask_set(t);
2789
2790#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2791 hotkey_poll_setup(true);
2792#endif
2793
2794 mutex_unlock(&hotkey_mutex);
2795
2796 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2797
2798 return (res) ? res : count;
2799}
2800
2801static DEVICE_ATTR_RW(hotkey_mask);
2802
2803/* sysfs hotkey bios_enabled ------------------------------------------- */
2804static ssize_t hotkey_bios_enabled_show(struct device *dev,
2805 struct device_attribute *attr,
2806 char *buf)
2807{
2808 return sprintf(buf, "0\n");
2809}
2810
2811static DEVICE_ATTR_RO(hotkey_bios_enabled);
2812
2813/* sysfs hotkey bios_mask ---------------------------------------------- */
2814static ssize_t hotkey_bios_mask_show(struct device *dev,
2815 struct device_attribute *attr,
2816 char *buf)
2817{
2818 printk_deprecated_attribute("hotkey_bios_mask",
2819 "This attribute is useless.");
2820 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2821}
2822
2823static DEVICE_ATTR_RO(hotkey_bios_mask);
2824
2825/* sysfs hotkey all_mask ----------------------------------------------- */
2826static ssize_t hotkey_all_mask_show(struct device *dev,
2827 struct device_attribute *attr,
2828 char *buf)
2829{
2830 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2831 hotkey_all_mask | hotkey_source_mask);
2832}
2833
2834static DEVICE_ATTR_RO(hotkey_all_mask);
2835
2836/* sysfs hotkey all_mask ----------------------------------------------- */
2837static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2838 struct device_attribute *attr,
2839 char *buf)
2840{
2841 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2842 hotkey_adaptive_all_mask | hotkey_source_mask);
2843}
2844
2845static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2846
2847/* sysfs hotkey recommended_mask --------------------------------------- */
2848static ssize_t hotkey_recommended_mask_show(struct device *dev,
2849 struct device_attribute *attr,
2850 char *buf)
2851{
2852 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2853 (hotkey_all_mask | hotkey_source_mask)
2854 & ~hotkey_reserved_mask);
2855}
2856
2857static DEVICE_ATTR_RO(hotkey_recommended_mask);
2858
2859#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2860
2861/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2862static ssize_t hotkey_source_mask_show(struct device *dev,
2863 struct device_attribute *attr,
2864 char *buf)
2865{
2866 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2867}
2868
2869static ssize_t hotkey_source_mask_store(struct device *dev,
2870 struct device_attribute *attr,
2871 const char *buf, size_t count)
2872{
2873 unsigned long t;
2874 u32 r_ev;
2875 int rc;
2876
2877 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2878 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2879 return -EINVAL;
2880
2881 if (mutex_lock_killable(&hotkey_mutex))
2882 return -ERESTARTSYS;
2883
2884 HOTKEY_CONFIG_CRITICAL_START
2885 hotkey_source_mask = t;
2886 HOTKEY_CONFIG_CRITICAL_END
2887
2888 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2889 ~hotkey_source_mask);
2890 hotkey_poll_setup(true);
2891
2892 /* check if events needed by the driver got disabled */
2893 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2894 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2895
2896 mutex_unlock(&hotkey_mutex);
2897
2898 if (rc < 0)
2899 pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2900
2901 if (r_ev)
2902 pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2903 r_ev);
2904
2905 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2906
2907 return (rc < 0) ? rc : count;
2908}
2909
2910static DEVICE_ATTR_RW(hotkey_source_mask);
2911
2912/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2913static ssize_t hotkey_poll_freq_show(struct device *dev,
2914 struct device_attribute *attr,
2915 char *buf)
2916{
2917 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2918}
2919
2920static ssize_t hotkey_poll_freq_store(struct device *dev,
2921 struct device_attribute *attr,
2922 const char *buf, size_t count)
2923{
2924 unsigned long t;
2925
2926 if (parse_strtoul(buf, 25, &t))
2927 return -EINVAL;
2928
2929 if (mutex_lock_killable(&hotkey_mutex))
2930 return -ERESTARTSYS;
2931
2932 hotkey_poll_set_freq(t);
2933 hotkey_poll_setup(true);
2934
2935 mutex_unlock(&hotkey_mutex);
2936
2937 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2938
2939 return count;
2940}
2941
2942static DEVICE_ATTR_RW(hotkey_poll_freq);
2943
2944#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2945
2946/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2947static ssize_t hotkey_radio_sw_show(struct device *dev,
2948 struct device_attribute *attr,
2949 char *buf)
2950{
2951 int res;
2952 res = hotkey_get_wlsw();
2953 if (res < 0)
2954 return res;
2955
2956 /* Opportunistic update */
2957 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2958
2959 return snprintf(buf, PAGE_SIZE, "%d\n",
2960 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2961}
2962
2963static DEVICE_ATTR_RO(hotkey_radio_sw);
2964
2965static void hotkey_radio_sw_notify_change(void)
2966{
2967 if (tp_features.hotkey_wlsw)
2968 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2969 "hotkey_radio_sw");
2970}
2971
2972/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2973static ssize_t hotkey_tablet_mode_show(struct device *dev,
2974 struct device_attribute *attr,
2975 char *buf)
2976{
2977 int res, s;
2978 res = hotkey_get_tablet_mode(&s);
2979 if (res < 0)
2980 return res;
2981
2982 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2983}
2984
2985static DEVICE_ATTR_RO(hotkey_tablet_mode);
2986
2987static void hotkey_tablet_mode_notify_change(void)
2988{
2989 if (tp_features.hotkey_tablet)
2990 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2991 "hotkey_tablet_mode");
2992}
2993
2994/* sysfs wakeup reason (pollable) -------------------------------------- */
2995static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2996 struct device_attribute *attr,
2997 char *buf)
2998{
2999 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
3000}
3001
3002static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
3003
3004static void hotkey_wakeup_reason_notify_change(void)
3005{
3006 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3007 "wakeup_reason");
3008}
3009
3010/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
3011static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
3012 struct device_attribute *attr,
3013 char *buf)
3014{
3015 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
3016}
3017
3018static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
3019 hotkey_wakeup_hotunplug_complete_show, NULL);
3020
3021static void hotkey_wakeup_hotunplug_complete_notify_change(void)
3022{
3023 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
3024 "wakeup_hotunplug_complete");
3025}
3026
3027/* sysfs adaptive kbd mode --------------------------------------------- */
3028
3029static int adaptive_keyboard_get_mode(void);
3030static int adaptive_keyboard_set_mode(int new_mode);
3031
3032enum ADAPTIVE_KEY_MODE {
3033 HOME_MODE,
3034 WEB_BROWSER_MODE,
3035 WEB_CONFERENCE_MODE,
3036 FUNCTION_MODE,
3037 LAYFLAT_MODE
3038};
3039
3040static ssize_t adaptive_kbd_mode_show(struct device *dev,
3041 struct device_attribute *attr,
3042 char *buf)
3043{
3044 int current_mode;
3045
3046 current_mode = adaptive_keyboard_get_mode();
3047 if (current_mode < 0)
3048 return current_mode;
3049
3050 return snprintf(buf, PAGE_SIZE, "%d\n", current_mode);
3051}
3052
3053static ssize_t adaptive_kbd_mode_store(struct device *dev,
3054 struct device_attribute *attr,
3055 const char *buf, size_t count)
3056{
3057 unsigned long t;
3058 int res;
3059
3060 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
3061 return -EINVAL;
3062
3063 res = adaptive_keyboard_set_mode(t);
3064 return (res < 0) ? res : count;
3065}
3066
3067static DEVICE_ATTR_RW(adaptive_kbd_mode);
3068
3069static struct attribute *adaptive_kbd_attributes[] = {
3070 &dev_attr_adaptive_kbd_mode.attr,
3071 NULL
3072};
3073
3074static const struct attribute_group adaptive_kbd_attr_group = {
3075 .attrs = adaptive_kbd_attributes,
3076};
3077
3078/* --------------------------------------------------------------------- */
3079
3080static struct attribute *hotkey_attributes[] __initdata = {
3081 &dev_attr_hotkey_enable.attr,
3082 &dev_attr_hotkey_bios_enabled.attr,
3083 &dev_attr_hotkey_bios_mask.attr,
3084 &dev_attr_wakeup_reason.attr,
3085 &dev_attr_wakeup_hotunplug_complete.attr,
3086 &dev_attr_hotkey_mask.attr,
3087 &dev_attr_hotkey_all_mask.attr,
3088 &dev_attr_hotkey_adaptive_all_mask.attr,
3089 &dev_attr_hotkey_recommended_mask.attr,
3090#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3091 &dev_attr_hotkey_source_mask.attr,
3092 &dev_attr_hotkey_poll_freq.attr,
3093#endif
3094};
3095
3096/*
3097 * Sync both the hw and sw blocking state of all switches
3098 */
3099static void tpacpi_send_radiosw_update(void)
3100{
3101 int wlsw;
3102
3103 /*
3104 * We must sync all rfkill controllers *before* issuing any
3105 * rfkill input events, or we will race the rfkill core input
3106 * handler.
3107 *
3108 * tpacpi_inputdev_send_mutex works as a synchronization point
3109 * for the above.
3110 *
3111 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3112 */
3113
3114 wlsw = hotkey_get_wlsw();
3115
3116 /* Sync hw blocking state first if it is hw-blocked */
3117 if (wlsw == TPACPI_RFK_RADIO_OFF)
3118 tpacpi_rfk_update_hwblock_state(true);
3119
3120 /* Sync sw blocking state */
3121 tpacpi_rfk_update_swstate_all();
3122
3123 /* Sync hw blocking state last if it is hw-unblocked */
3124 if (wlsw == TPACPI_RFK_RADIO_ON)
3125 tpacpi_rfk_update_hwblock_state(false);
3126
3127 /* Issue rfkill input event for WLSW switch */
3128 if (!(wlsw < 0)) {
3129 mutex_lock(&tpacpi_inputdev_send_mutex);
3130
3131 input_report_switch(tpacpi_inputdev,
3132 SW_RFKILL_ALL, (wlsw > 0));
3133 input_sync(tpacpi_inputdev);
3134
3135 mutex_unlock(&tpacpi_inputdev_send_mutex);
3136 }
3137
3138 /*
3139 * this can be unconditional, as we will poll state again
3140 * if userspace uses the notify to read data
3141 */
3142 hotkey_radio_sw_notify_change();
3143}
3144
3145static void hotkey_exit(void)
3146{
3147#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3148 mutex_lock(&hotkey_mutex);
3149 hotkey_poll_stop_sync();
3150 mutex_unlock(&hotkey_mutex);
3151#endif
3152
3153 if (hotkey_dev_attributes)
3154 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3155
3156 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3157 "restoring original HKEY status and mask\n");
3158 /* yes, there is a bitwise or below, we want the
3159 * functions to be called even if one of them fail */
3160 if (((tp_features.hotkey_mask &&
3161 hotkey_mask_set(hotkey_orig_mask)) |
3162 hotkey_status_set(false)) != 0)
3163 pr_err("failed to restore hot key mask to BIOS defaults\n");
3164}
3165
3166static void __init hotkey_unmap(const unsigned int scancode)
3167{
3168 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3169 clear_bit(hotkey_keycode_map[scancode],
3170 tpacpi_inputdev->keybit);
3171 hotkey_keycode_map[scancode] = KEY_RESERVED;
3172 }
3173}
3174
3175/*
3176 * HKEY quirks:
3177 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3178 */
3179
3180#define TPACPI_HK_Q_INIMASK 0x0001
3181
3182static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3183 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3184 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3185 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3186 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3187 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3188 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3189 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3190 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3191 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3192 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3193 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3194 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3195 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3196 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3197 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3198 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3199 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3200 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3201 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3202};
3203
3204typedef u16 tpacpi_keymap_entry_t;
3205typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3206
3207static int hotkey_init_tablet_mode(void)
3208{
3209 int in_tablet_mode = 0, res;
3210 char *type = NULL;
3211
3212 if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3213 int has_tablet_mode;
3214
3215 in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3216 &has_tablet_mode);
3217 if (has_tablet_mode)
3218 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3219 type = "GMMS";
3220 } else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3221 /* For X41t, X60t, X61t Tablets... */
3222 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3223 in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3224 type = "MHKG";
3225 }
3226
3227 if (!tp_features.hotkey_tablet)
3228 return 0;
3229
3230 pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3231 type, in_tablet_mode ? "tablet" : "laptop");
3232
3233 res = add_to_attr_set(hotkey_dev_attributes,
3234 &dev_attr_hotkey_tablet_mode.attr);
3235 if (res)
3236 return -1;
3237
3238 return in_tablet_mode;
3239}
3240
3241static int __init hotkey_init(struct ibm_init_struct *iibm)
3242{
3243 /* Requirements for changing the default keymaps:
3244 *
3245 * 1. Many of the keys are mapped to KEY_RESERVED for very
3246 * good reasons. Do not change them unless you have deep
3247 * knowledge on the IBM and Lenovo ThinkPad firmware for
3248 * the various ThinkPad models. The driver behaves
3249 * differently for KEY_RESERVED: such keys have their
3250 * hot key mask *unset* in mask_recommended, and also
3251 * in the initial hot key mask programmed into the
3252 * firmware at driver load time, which means the firm-
3253 * ware may react very differently if you change them to
3254 * something else;
3255 *
3256 * 2. You must be subscribed to the linux-thinkpad and
3257 * ibm-acpi-devel mailing lists, and you should read the
3258 * list archives since 2007 if you want to change the
3259 * keymaps. This requirement exists so that you will
3260 * know the past history of problems with the thinkpad-
3261 * acpi driver keymaps, and also that you will be
3262 * listening to any bug reports;
3263 *
3264 * 3. Do not send thinkpad-acpi specific patches directly to
3265 * for merging, *ever*. Send them to the linux-acpi
3266 * mailinglist for comments. Merging is to be done only
3267 * through acpi-test and the ACPI maintainer.
3268 *
3269 * If the above is too much to ask, don't change the keymap.
3270 * Ask the thinkpad-acpi maintainer to do it, instead.
3271 */
3272
3273 enum keymap_index {
3274 TPACPI_KEYMAP_IBM_GENERIC = 0,
3275 TPACPI_KEYMAP_LENOVO_GENERIC,
3276 };
3277
3278 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3279 /* Generic keymap for IBM ThinkPads */
3280 [TPACPI_KEYMAP_IBM_GENERIC] = {
3281 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3282 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3283 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3284 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3285
3286 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3287 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3288 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3289 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3290
3291 /* brightness: firmware always reacts to them */
3292 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3293 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3294
3295 /* Thinklight: firmware always react to it */
3296 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3297
3298 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3299 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3300
3301 /* Volume: firmware always react to it and reprograms
3302 * the built-in *extra* mixer. Never map it to control
3303 * another mixer by default. */
3304 KEY_RESERVED, /* 0x14: VOLUME UP */
3305 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3306 KEY_RESERVED, /* 0x16: MUTE */
3307
3308 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3309
3310 /* (assignments unknown, please report if found) */
3311 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3312 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3313
3314 /* No assignments, only used for Adaptive keyboards. */
3315 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3316 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3317 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3318 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3319 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3320
3321 /* No assignment, used for newer Lenovo models */
3322 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3323 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3324 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3325 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3326 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3327 KEY_UNKNOWN, KEY_UNKNOWN
3328
3329 },
3330
3331 /* Generic keymap for Lenovo ThinkPads */
3332 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3333 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3334 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3335 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3336 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3337
3338 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3339 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3340 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3341 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3342
3343 /* These should be enabled --only-- when ACPI video
3344 * is disabled (i.e. in "vendor" mode), and are handled
3345 * in a special way by the init code */
3346 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3347 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3348
3349 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3350
3351 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3352 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3353
3354 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3355 * react to it and reprograms the built-in *extra* mixer.
3356 * Never map it to control another mixer by default.
3357 *
3358 * T60?, T61, R60?, R61: firmware and EC tries to send
3359 * these over the regular keyboard, so these are no-ops,
3360 * but there are still weird bugs re. MUTE, so do not
3361 * change unless you get test reports from all Lenovo
3362 * models. May cause the BIOS to interfere with the
3363 * HDA mixer.
3364 */
3365 KEY_RESERVED, /* 0x14: VOLUME UP */
3366 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3367 KEY_RESERVED, /* 0x16: MUTE */
3368
3369 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3370
3371 /* (assignments unknown, please report if found) */
3372 KEY_UNKNOWN, KEY_UNKNOWN,
3373
3374 /*
3375 * The mic mute button only sends 0x1a. It does not
3376 * automatically mute the mic or change the mute light.
3377 */
3378 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3379
3380 /* (assignments unknown, please report if found) */
3381 KEY_UNKNOWN,
3382
3383 /* Extra keys in use since the X240 / T440 / T540 */
3384 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3385
3386 /*
3387 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3388 * The first item in this list is the Mute button which is
3389 * emitted with 0x103 through
3390 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3391 * symbol is held.
3392 * We'll need to offset those by 0x20.
3393 */
3394 KEY_RESERVED, /* Mute held, 0x103 */
3395 KEY_BRIGHTNESS_MIN, /* Backlight off */
3396 KEY_RESERVED, /* Clipping tool */
3397 KEY_RESERVED, /* Cloud */
3398 KEY_RESERVED,
3399 KEY_VOICECOMMAND, /* Voice */
3400 KEY_RESERVED,
3401 KEY_RESERVED, /* Gestures */
3402 KEY_RESERVED,
3403 KEY_RESERVED,
3404 KEY_RESERVED,
3405 KEY_CONFIG, /* Settings */
3406 KEY_RESERVED, /* New tab */
3407 KEY_REFRESH, /* Reload */
3408 KEY_BACK, /* Back */
3409 KEY_RESERVED, /* Microphone down */
3410 KEY_RESERVED, /* Microphone up */
3411 KEY_RESERVED, /* Microphone cancellation */
3412 KEY_RESERVED, /* Camera mode */
3413 KEY_RESERVED, /* Rotate display, 0x116 */
3414
3415 /*
3416 * These are found in 2017 models (e.g. T470s, X270).
3417 * The lowest known value is 0x311, which according to
3418 * the manual should launch a user defined favorite
3419 * application.
3420 *
3421 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3422 * corresponding to 0x34.
3423 */
3424
3425 /* (assignments unknown, please report if found) */
3426 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3427 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3428 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3429 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3430 KEY_UNKNOWN,
3431
3432 KEY_BOOKMARKS, /* Favorite app, 0x311 */
3433 KEY_RESERVED, /* Clipping tool */
3434 KEY_CALC, /* Calculator (above numpad, P52) */
3435 KEY_BLUETOOTH, /* Bluetooth */
3436 KEY_KEYBOARD /* Keyboard, 0x315 */
3437 },
3438 };
3439
3440 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3441 /* Generic maps (fallback) */
3442 {
3443 .vendor = PCI_VENDOR_ID_IBM,
3444 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3445 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3446 },
3447 {
3448 .vendor = PCI_VENDOR_ID_LENOVO,
3449 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3450 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3451 },
3452 };
3453
3454#define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3455#define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3456
3457 int res, i;
3458 int status;
3459 int hkeyv;
3460 bool radiosw_state = false;
3461 bool tabletsw_state = false;
3462
3463 unsigned long quirks;
3464 unsigned long keymap_id;
3465
3466 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3467 "initializing hotkey subdriver\n");
3468
3469 BUG_ON(!tpacpi_inputdev);
3470 BUG_ON(tpacpi_inputdev->open != NULL ||
3471 tpacpi_inputdev->close != NULL);
3472
3473 TPACPI_ACPIHANDLE_INIT(hkey);
3474 mutex_init(&hotkey_mutex);
3475
3476#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3477 mutex_init(&hotkey_thread_data_mutex);
3478#endif
3479
3480 /* hotkey not supported on 570 */
3481 tp_features.hotkey = hkey_handle != NULL;
3482
3483 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3484 "hotkeys are %s\n",
3485 str_supported(tp_features.hotkey));
3486
3487 if (!tp_features.hotkey)
3488 return 1;
3489
3490 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3491 ARRAY_SIZE(tpacpi_hotkey_qtable));
3492
3493 tpacpi_disable_brightness_delay();
3494
3495 /* MUST have enough space for all attributes to be added to
3496 * hotkey_dev_attributes */
3497 hotkey_dev_attributes = create_attr_set(
3498 ARRAY_SIZE(hotkey_attributes) + 2,
3499 NULL);
3500 if (!hotkey_dev_attributes)
3501 return -ENOMEM;
3502 res = add_many_to_attr_set(hotkey_dev_attributes,
3503 hotkey_attributes,
3504 ARRAY_SIZE(hotkey_attributes));
3505 if (res)
3506 goto err_exit;
3507
3508 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3509 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3510 for HKEY interface version 0x100 */
3511 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3512 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3513 "firmware HKEY interface version: 0x%x\n",
3514 hkeyv);
3515
3516 switch (hkeyv >> 8) {
3517 case 1:
3518 /*
3519 * MHKV 0x100 in A31, R40, R40e,
3520 * T4x, X31, and later
3521 */
3522
3523 /* Paranoia check AND init hotkey_all_mask */
3524 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3525 "MHKA", "qd")) {
3526 pr_err("missing MHKA handler, please report this to %s\n",
3527 TPACPI_MAIL);
3528 /* Fallback: pre-init for FN+F3,F4,F12 */
3529 hotkey_all_mask = 0x080cU;
3530 } else {
3531 tp_features.hotkey_mask = 1;
3532 }
3533 break;
3534
3535 case 2:
3536 /*
3537 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3538 */
3539
3540 /* Paranoia check AND init hotkey_all_mask */
3541 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3542 "MHKA", "dd", 1)) {
3543 pr_err("missing MHKA handler, please report this to %s\n",
3544 TPACPI_MAIL);
3545 /* Fallback: pre-init for FN+F3,F4,F12 */
3546 hotkey_all_mask = 0x080cU;
3547 } else {
3548 tp_features.hotkey_mask = 1;
3549 }
3550
3551 /*
3552 * Check if we have an adaptive keyboard, like on the
3553 * Lenovo Carbon X1 2014 (2nd Gen).
3554 */
3555 if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3556 "MHKA", "dd", 2)) {
3557 if (hotkey_adaptive_all_mask != 0) {
3558 tp_features.has_adaptive_kbd = true;
3559 res = sysfs_create_group(
3560 &tpacpi_pdev->dev.kobj,
3561 &adaptive_kbd_attr_group);
3562 if (res)
3563 goto err_exit;
3564 }
3565 } else {
3566 tp_features.has_adaptive_kbd = false;
3567 hotkey_adaptive_all_mask = 0x0U;
3568 }
3569 break;
3570
3571 default:
3572 pr_err("unknown version of the HKEY interface: 0x%x\n",
3573 hkeyv);
3574 pr_err("please report this to %s\n", TPACPI_MAIL);
3575 break;
3576 }
3577 }
3578
3579 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3580 "hotkey masks are %s\n",
3581 str_supported(tp_features.hotkey_mask));
3582
3583 /* Init hotkey_all_mask if not initialized yet */
3584 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3585 (quirks & TPACPI_HK_Q_INIMASK))
3586 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3587
3588 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3589 if (tp_features.hotkey_mask) {
3590 /* hotkey_source_mask *must* be zero for
3591 * the first hotkey_mask_get to return hotkey_orig_mask */
3592 res = hotkey_mask_get();
3593 if (res)
3594 goto err_exit;
3595
3596 hotkey_orig_mask = hotkey_acpi_mask;
3597 } else {
3598 hotkey_orig_mask = hotkey_all_mask;
3599 hotkey_acpi_mask = hotkey_all_mask;
3600 }
3601
3602#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3603 if (dbg_wlswemul) {
3604 tp_features.hotkey_wlsw = 1;
3605 radiosw_state = !!tpacpi_wlsw_emulstate;
3606 pr_info("radio switch emulation enabled\n");
3607 } else
3608#endif
3609 /* Not all thinkpads have a hardware radio switch */
3610 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3611 tp_features.hotkey_wlsw = 1;
3612 radiosw_state = !!status;
3613 pr_info("radio switch found; radios are %s\n",
3614 enabled(status, 0));
3615 }
3616 if (tp_features.hotkey_wlsw)
3617 res = add_to_attr_set(hotkey_dev_attributes,
3618 &dev_attr_hotkey_radio_sw.attr);
3619
3620 res = hotkey_init_tablet_mode();
3621 if (res < 0)
3622 goto err_exit;
3623
3624 tabletsw_state = res;
3625
3626 res = register_attr_set_with_sysfs(hotkey_dev_attributes,
3627 &tpacpi_pdev->dev.kobj);
3628 if (res)
3629 goto err_exit;
3630
3631 /* Set up key map */
3632 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3633 ARRAY_SIZE(tpacpi_keymap_qtable));
3634 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3635 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3636 "using keymap number %lu\n", keymap_id);
3637
3638 hotkey_keycode_map = kmemdup(&tpacpi_keymaps[keymap_id],
3639 TPACPI_HOTKEY_MAP_SIZE, GFP_KERNEL);
3640 if (!hotkey_keycode_map) {
3641 pr_err("failed to allocate memory for key map\n");
3642 res = -ENOMEM;
3643 goto err_exit;
3644 }
3645
3646 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3647 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3648 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3649 tpacpi_inputdev->keycode = hotkey_keycode_map;
3650 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3651 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3652 input_set_capability(tpacpi_inputdev, EV_KEY,
3653 hotkey_keycode_map[i]);
3654 } else {
3655 if (i < sizeof(hotkey_reserved_mask)*8)
3656 hotkey_reserved_mask |= 1 << i;
3657 }
3658 }
3659
3660 if (tp_features.hotkey_wlsw) {
3661 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3662 input_report_switch(tpacpi_inputdev,
3663 SW_RFKILL_ALL, radiosw_state);
3664 }
3665 if (tp_features.hotkey_tablet) {
3666 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3667 input_report_switch(tpacpi_inputdev,
3668 SW_TABLET_MODE, tabletsw_state);
3669 }
3670
3671 /* Do not issue duplicate brightness change events to
3672 * userspace. tpacpi_detect_brightness_capabilities() must have
3673 * been called before this point */
3674 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3675 pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3676 pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3677
3678 /* Disable brightness up/down on Lenovo thinkpads when
3679 * ACPI is handling them, otherwise it is plain impossible
3680 * for userspace to do something even remotely sane */
3681 hotkey_reserved_mask |=
3682 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3683 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3684 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3685 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3686 }
3687
3688#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3689 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3690 & ~hotkey_all_mask
3691 & ~hotkey_reserved_mask;
3692
3693 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3694 "hotkey source mask 0x%08x, polling freq %u\n",
3695 hotkey_source_mask, hotkey_poll_freq);
3696#endif
3697
3698 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3699 "enabling firmware HKEY event interface...\n");
3700 res = hotkey_status_set(true);
3701 if (res) {
3702 hotkey_exit();
3703 return res;
3704 }
3705 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3706 | hotkey_driver_mask)
3707 & ~hotkey_source_mask);
3708 if (res < 0 && res != -ENXIO) {
3709 hotkey_exit();
3710 return res;
3711 }
3712 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3713 & ~hotkey_reserved_mask;
3714 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3715 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3716 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3717
3718 tpacpi_inputdev->open = &hotkey_inputdev_open;
3719 tpacpi_inputdev->close = &hotkey_inputdev_close;
3720
3721 hotkey_poll_setup_safe(true);
3722
3723 return 0;
3724
3725err_exit:
3726 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3727 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3728 &adaptive_kbd_attr_group);
3729
3730 hotkey_dev_attributes = NULL;
3731
3732 return (res < 0) ? res : 1;
3733}
3734
3735/* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3736 * mode, Web conference mode, Function mode and Lay-flat mode.
3737 * We support Home mode and Function mode currently.
3738 *
3739 * Will consider support rest of modes in future.
3740 *
3741 */
3742static const int adaptive_keyboard_modes[] = {
3743 HOME_MODE,
3744/* WEB_BROWSER_MODE = 2,
3745 WEB_CONFERENCE_MODE = 3, */
3746 FUNCTION_MODE
3747};
3748
3749#define DFR_CHANGE_ROW 0x101
3750#define DFR_SHOW_QUICKVIEW_ROW 0x102
3751#define FIRST_ADAPTIVE_KEY 0x103
3752
3753/* press Fn key a while second, it will switch to Function Mode. Then
3754 * release Fn key, previous mode be restored.
3755 */
3756static bool adaptive_keyboard_mode_is_saved;
3757static int adaptive_keyboard_prev_mode;
3758
3759static int adaptive_keyboard_get_mode(void)
3760{
3761 int mode = 0;
3762
3763 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3764 pr_err("Cannot read adaptive keyboard mode\n");
3765 return -EIO;
3766 }
3767
3768 return mode;
3769}
3770
3771static int adaptive_keyboard_set_mode(int new_mode)
3772{
3773 if (new_mode < 0 ||
3774 new_mode > LAYFLAT_MODE)
3775 return -EINVAL;
3776
3777 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3778 pr_err("Cannot set adaptive keyboard mode\n");
3779 return -EIO;
3780 }
3781
3782 return 0;
3783}
3784
3785static int adaptive_keyboard_get_next_mode(int mode)
3786{
3787 size_t i;
3788 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3789
3790 for (i = 0; i <= max_mode; i++) {
3791 if (adaptive_keyboard_modes[i] == mode)
3792 break;
3793 }
3794
3795 if (i >= max_mode)
3796 i = 0;
3797 else
3798 i++;
3799
3800 return adaptive_keyboard_modes[i];
3801}
3802
3803static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3804{
3805 int current_mode = 0;
3806 int new_mode = 0;
3807 int keycode;
3808
3809 switch (scancode) {
3810 case DFR_CHANGE_ROW:
3811 if (adaptive_keyboard_mode_is_saved) {
3812 new_mode = adaptive_keyboard_prev_mode;
3813 adaptive_keyboard_mode_is_saved = false;
3814 } else {
3815 current_mode = adaptive_keyboard_get_mode();
3816 if (current_mode < 0)
3817 return false;
3818 new_mode = adaptive_keyboard_get_next_mode(
3819 current_mode);
3820 }
3821
3822 if (adaptive_keyboard_set_mode(new_mode) < 0)
3823 return false;
3824
3825 return true;
3826
3827 case DFR_SHOW_QUICKVIEW_ROW:
3828 current_mode = adaptive_keyboard_get_mode();
3829 if (current_mode < 0)
3830 return false;
3831
3832 adaptive_keyboard_prev_mode = current_mode;
3833 adaptive_keyboard_mode_is_saved = true;
3834
3835 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3836 return false;
3837 return true;
3838
3839 default:
3840 if (scancode < FIRST_ADAPTIVE_KEY ||
3841 scancode >= FIRST_ADAPTIVE_KEY +
3842 TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3843 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3844 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3845 scancode);
3846 return false;
3847 }
3848 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3849 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3850 if (keycode != KEY_RESERVED) {
3851 mutex_lock(&tpacpi_inputdev_send_mutex);
3852
3853 input_report_key(tpacpi_inputdev, keycode, 1);
3854 input_sync(tpacpi_inputdev);
3855
3856 input_report_key(tpacpi_inputdev, keycode, 0);
3857 input_sync(tpacpi_inputdev);
3858
3859 mutex_unlock(&tpacpi_inputdev_send_mutex);
3860 }
3861 return true;
3862 }
3863}
3864
3865static bool hotkey_notify_hotkey(const u32 hkey,
3866 bool *send_acpi_ev,
3867 bool *ignore_acpi_ev)
3868{
3869 /* 0x1000-0x1FFF: key presses */
3870 unsigned int scancode = hkey & 0xfff;
3871 *send_acpi_ev = true;
3872 *ignore_acpi_ev = false;
3873
3874 /*
3875 * Original events are in the 0x10XX range, the adaptive keyboard
3876 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3877 * models, additional keys are emitted through 0x13XX.
3878 */
3879 switch ((hkey >> 8) & 0xf) {
3880 case 0:
3881 if (scancode > 0 &&
3882 scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3883 /* HKEY event 0x1001 is scancode 0x00 */
3884 scancode--;
3885 if (!(hotkey_source_mask & (1 << scancode))) {
3886 tpacpi_input_send_key_masked(scancode);
3887 *send_acpi_ev = false;
3888 } else {
3889 *ignore_acpi_ev = true;
3890 }
3891 return true;
3892 }
3893 break;
3894
3895 case 1:
3896 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3897
3898 case 3:
3899 /* Extended keycodes start at 0x300 and our offset into the map
3900 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3901 * will be positive, but might not be in the correct range.
3902 */
3903 scancode -= (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3904 if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3905 scancode < TPACPI_HOTKEY_MAP_LEN) {
3906 tpacpi_input_send_key(scancode);
3907 return true;
3908 }
3909 break;
3910 }
3911
3912 return false;
3913}
3914
3915static bool hotkey_notify_wakeup(const u32 hkey,
3916 bool *send_acpi_ev,
3917 bool *ignore_acpi_ev)
3918{
3919 /* 0x2000-0x2FFF: Wakeup reason */
3920 *send_acpi_ev = true;
3921 *ignore_acpi_ev = false;
3922
3923 switch (hkey) {
3924 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3925 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3926 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3927 *ignore_acpi_ev = true;
3928 break;
3929
3930 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3931 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3932 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3933 *ignore_acpi_ev = true;
3934 break;
3935
3936 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3937 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3938 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3939 /* how to auto-heal: */
3940 /* 2313: woke up from S3, go to S4/S5 */
3941 /* 2413: woke up from S4, go to S5 */
3942 break;
3943
3944 default:
3945 return false;
3946 }
3947
3948 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3949 pr_info("woke up due to a hot-unplug request...\n");
3950 hotkey_wakeup_reason_notify_change();
3951 }
3952 return true;
3953}
3954
3955static bool hotkey_notify_dockevent(const u32 hkey,
3956 bool *send_acpi_ev,
3957 bool *ignore_acpi_ev)
3958{
3959 /* 0x4000-0x4FFF: dock-related events */
3960 *send_acpi_ev = true;
3961 *ignore_acpi_ev = false;
3962
3963 switch (hkey) {
3964 case TP_HKEY_EV_UNDOCK_ACK:
3965 /* ACPI undock operation completed after wakeup */
3966 hotkey_autosleep_ack = 1;
3967 pr_info("undocked\n");
3968 hotkey_wakeup_hotunplug_complete_notify_change();
3969 return true;
3970
3971 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3972 pr_info("docked into hotplug port replicator\n");
3973 return true;
3974 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3975 pr_info("undocked from hotplug port replicator\n");
3976 return true;
3977
3978 default:
3979 return false;
3980 }
3981}
3982
3983static bool hotkey_notify_usrevent(const u32 hkey,
3984 bool *send_acpi_ev,
3985 bool *ignore_acpi_ev)
3986{
3987 /* 0x5000-0x5FFF: human interface helpers */
3988 *send_acpi_ev = true;
3989 *ignore_acpi_ev = false;
3990
3991 switch (hkey) {
3992 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3993 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3994 return true;
3995
3996 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3997 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3998 tpacpi_input_send_tabletsw();
3999 hotkey_tablet_mode_notify_change();
4000 *send_acpi_ev = false;
4001 return true;
4002
4003 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
4004 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
4005 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
4006 /* do not propagate these events */
4007 *ignore_acpi_ev = true;
4008 return true;
4009
4010 default:
4011 return false;
4012 }
4013}
4014
4015static void thermal_dump_all_sensors(void);
4016
4017static bool hotkey_notify_6xxx(const u32 hkey,
4018 bool *send_acpi_ev,
4019 bool *ignore_acpi_ev)
4020{
4021 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
4022 *send_acpi_ev = true;
4023 *ignore_acpi_ev = false;
4024
4025 switch (hkey) {
4026 case TP_HKEY_EV_THM_TABLE_CHANGED:
4027 pr_debug("EC reports: Thermal Table has changed\n");
4028 /* recommended action: do nothing, we don't have
4029 * Lenovo ATM information */
4030 return true;
4031 case TP_HKEY_EV_THM_CSM_COMPLETED:
4032 pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
4033 /* Thermal event - pass on to event handler */
4034 tpacpi_driver_event(hkey);
4035 return true;
4036 case TP_HKEY_EV_THM_TRANSFM_CHANGED:
4037 pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
4038 /* recommended action: do nothing, we don't have
4039 * Lenovo ATM information */
4040 return true;
4041 case TP_HKEY_EV_ALARM_BAT_HOT:
4042 pr_crit("THERMAL ALARM: battery is too hot!\n");
4043 /* recommended action: warn user through gui */
4044 break;
4045 case TP_HKEY_EV_ALARM_BAT_XHOT:
4046 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
4047 /* recommended action: immediate sleep/hibernate */
4048 break;
4049 case TP_HKEY_EV_ALARM_SENSOR_HOT:
4050 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
4051 /* recommended action: warn user through gui, that */
4052 /* some internal component is too hot */
4053 break;
4054 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
4055 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
4056 /* recommended action: immediate sleep/hibernate */
4057 break;
4058 case TP_HKEY_EV_AC_CHANGED:
4059 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
4060 * AC status changed; can be triggered by plugging or
4061 * unplugging AC adapter, docking or undocking. */
4062
4063 fallthrough;
4064
4065 case TP_HKEY_EV_KEY_NUMLOCK:
4066 case TP_HKEY_EV_KEY_FN:
4067 case TP_HKEY_EV_KEY_FN_ESC:
4068 /* key press events, we just ignore them as long as the EC
4069 * is still reporting them in the normal keyboard stream */
4070 *send_acpi_ev = false;
4071 *ignore_acpi_ev = true;
4072 return true;
4073
4074 case TP_HKEY_EV_TABLET_CHANGED:
4075 tpacpi_input_send_tabletsw();
4076 hotkey_tablet_mode_notify_change();
4077 *send_acpi_ev = false;
4078 return true;
4079
4080 case TP_HKEY_EV_PALM_DETECTED:
4081 case TP_HKEY_EV_PALM_UNDETECTED:
4082 /* palm detected hovering the keyboard, forward to user-space
4083 * via netlink for consumption */
4084 return true;
4085
4086 default:
4087 /* report simply as unknown, no sensor dump */
4088 return false;
4089 }
4090
4091 thermal_dump_all_sensors();
4092 return true;
4093}
4094
4095static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4096{
4097 u32 hkey;
4098 bool send_acpi_ev;
4099 bool ignore_acpi_ev;
4100 bool known_ev;
4101
4102 if (event != 0x80) {
4103 pr_err("unknown HKEY notification event %d\n", event);
4104 /* forward it to userspace, maybe it knows how to handle it */
4105 acpi_bus_generate_netlink_event(
4106 ibm->acpi->device->pnp.device_class,
4107 dev_name(&ibm->acpi->device->dev),
4108 event, 0);
4109 return;
4110 }
4111
4112 while (1) {
4113 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4114 pr_err("failed to retrieve HKEY event\n");
4115 return;
4116 }
4117
4118 if (hkey == 0) {
4119 /* queue empty */
4120 return;
4121 }
4122
4123 send_acpi_ev = true;
4124 ignore_acpi_ev = false;
4125
4126 switch (hkey >> 12) {
4127 case 1:
4128 /* 0x1000-0x1FFF: key presses */
4129 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4130 &ignore_acpi_ev);
4131 break;
4132 case 2:
4133 /* 0x2000-0x2FFF: Wakeup reason */
4134 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4135 &ignore_acpi_ev);
4136 break;
4137 case 3:
4138 /* 0x3000-0x3FFF: bay-related wakeups */
4139 switch (hkey) {
4140 case TP_HKEY_EV_BAYEJ_ACK:
4141 hotkey_autosleep_ack = 1;
4142 pr_info("bay ejected\n");
4143 hotkey_wakeup_hotunplug_complete_notify_change();
4144 known_ev = true;
4145 break;
4146 case TP_HKEY_EV_OPTDRV_EJ:
4147 /* FIXME: kick libata if SATA link offline */
4148 known_ev = true;
4149 break;
4150 default:
4151 known_ev = false;
4152 }
4153 break;
4154 case 4:
4155 /* 0x4000-0x4FFF: dock-related events */
4156 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4157 &ignore_acpi_ev);
4158 break;
4159 case 5:
4160 /* 0x5000-0x5FFF: human interface helpers */
4161 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4162 &ignore_acpi_ev);
4163 break;
4164 case 6:
4165 /* 0x6000-0x6FFF: thermal alarms/notices and
4166 * keyboard events */
4167 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4168 &ignore_acpi_ev);
4169 break;
4170 case 7:
4171 /* 0x7000-0x7FFF: misc */
4172 if (tp_features.hotkey_wlsw &&
4173 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4174 tpacpi_send_radiosw_update();
4175 send_acpi_ev = 0;
4176 known_ev = true;
4177 break;
4178 }
4179 fallthrough; /* to default */
4180 default:
4181 known_ev = false;
4182 }
4183 if (!known_ev) {
4184 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4185 pr_notice("please report the conditions when this event happened to %s\n",
4186 TPACPI_MAIL);
4187 }
4188
4189 /* netlink events */
4190 if (!ignore_acpi_ev && send_acpi_ev) {
4191 acpi_bus_generate_netlink_event(
4192 ibm->acpi->device->pnp.device_class,
4193 dev_name(&ibm->acpi->device->dev),
4194 event, hkey);
4195 }
4196 }
4197}
4198
4199static void hotkey_suspend(void)
4200{
4201 /* Do these on suspend, we get the events on early resume! */
4202 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4203 hotkey_autosleep_ack = 0;
4204
4205 /* save previous mode of adaptive keyboard of X1 Carbon */
4206 if (tp_features.has_adaptive_kbd) {
4207 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4208 "GTRW", "dd", 0)) {
4209 pr_err("Cannot read adaptive keyboard mode.\n");
4210 }
4211 }
4212}
4213
4214static void hotkey_resume(void)
4215{
4216 tpacpi_disable_brightness_delay();
4217
4218 if (hotkey_status_set(true) < 0 ||
4219 hotkey_mask_set(hotkey_acpi_mask) < 0)
4220 pr_err("error while attempting to reset the event firmware interface\n");
4221
4222 tpacpi_send_radiosw_update();
4223 hotkey_tablet_mode_notify_change();
4224 hotkey_wakeup_reason_notify_change();
4225 hotkey_wakeup_hotunplug_complete_notify_change();
4226 hotkey_poll_setup_safe(false);
4227
4228 /* restore previous mode of adapive keyboard of X1 Carbon */
4229 if (tp_features.has_adaptive_kbd) {
4230 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4231 adaptive_keyboard_prev_mode)) {
4232 pr_err("Cannot set adaptive keyboard mode.\n");
4233 }
4234 }
4235}
4236
4237/* procfs -------------------------------------------------------------- */
4238static int hotkey_read(struct seq_file *m)
4239{
4240 int res, status;
4241
4242 if (!tp_features.hotkey) {
4243 seq_printf(m, "status:\t\tnot supported\n");
4244 return 0;
4245 }
4246
4247 if (mutex_lock_killable(&hotkey_mutex))
4248 return -ERESTARTSYS;
4249 res = hotkey_status_get(&status);
4250 if (!res)
4251 res = hotkey_mask_get();
4252 mutex_unlock(&hotkey_mutex);
4253 if (res)
4254 return res;
4255
4256 seq_printf(m, "status:\t\t%s\n", enabled(status, 0));
4257 if (hotkey_all_mask) {
4258 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4259 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4260 } else {
4261 seq_printf(m, "mask:\t\tnot supported\n");
4262 seq_printf(m, "commands:\tenable, disable, reset\n");
4263 }
4264
4265 return 0;
4266}
4267
4268static void hotkey_enabledisable_warn(bool enable)
4269{
4270 tpacpi_log_usertask("procfs hotkey enable/disable");
4271 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4272 pr_fmt("hotkey enable/disable functionality has been removed from the driver. Hotkeys are always enabled.\n")))
4273 pr_err("Please remove the hotkey=enable module parameter, it is deprecated. Hotkeys are always enabled.\n");
4274}
4275
4276static int hotkey_write(char *buf)
4277{
4278 int res;
4279 u32 mask;
4280 char *cmd;
4281
4282 if (!tp_features.hotkey)
4283 return -ENODEV;
4284
4285 if (mutex_lock_killable(&hotkey_mutex))
4286 return -ERESTARTSYS;
4287
4288 mask = hotkey_user_mask;
4289
4290 res = 0;
4291 while ((cmd = strsep(&buf, ","))) {
4292 if (strlencmp(cmd, "enable") == 0) {
4293 hotkey_enabledisable_warn(1);
4294 } else if (strlencmp(cmd, "disable") == 0) {
4295 hotkey_enabledisable_warn(0);
4296 res = -EPERM;
4297 } else if (strlencmp(cmd, "reset") == 0) {
4298 mask = (hotkey_all_mask | hotkey_source_mask)
4299 & ~hotkey_reserved_mask;
4300 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4301 /* mask set */
4302 } else if (sscanf(cmd, "%x", &mask) == 1) {
4303 /* mask set */
4304 } else {
4305 res = -EINVAL;
4306 goto errexit;
4307 }
4308 }
4309
4310 if (!res) {
4311 tpacpi_disclose_usertask("procfs hotkey",
4312 "set mask to 0x%08x\n", mask);
4313 res = hotkey_user_mask_set(mask);
4314 }
4315
4316errexit:
4317 mutex_unlock(&hotkey_mutex);
4318 return res;
4319}
4320
4321static const struct acpi_device_id ibm_htk_device_ids[] = {
4322 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4323 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4324 {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4325 {"", 0},
4326};
4327
4328static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4329 .hid = ibm_htk_device_ids,
4330 .notify = hotkey_notify,
4331 .handle = &hkey_handle,
4332 .type = ACPI_DEVICE_NOTIFY,
4333};
4334
4335static struct ibm_struct hotkey_driver_data = {
4336 .name = "hotkey",
4337 .read = hotkey_read,
4338 .write = hotkey_write,
4339 .exit = hotkey_exit,
4340 .resume = hotkey_resume,
4341 .suspend = hotkey_suspend,
4342 .acpi = &ibm_hotkey_acpidriver,
4343};
4344
4345/*************************************************************************
4346 * Bluetooth subdriver
4347 */
4348
4349enum {
4350 /* ACPI GBDC/SBDC bits */
4351 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4352 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4353 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4354 0 = disable, 1 = enable */
4355};
4356
4357enum {
4358 /* ACPI \BLTH commands */
4359 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4360 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4361 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4362 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4363 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4364};
4365
4366#define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4367
4368static int bluetooth_get_status(void)
4369{
4370 int status;
4371
4372#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4373 if (dbg_bluetoothemul)
4374 return (tpacpi_bluetooth_emulstate) ?
4375 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4376#endif
4377
4378 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4379 return -EIO;
4380
4381 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4382 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4383}
4384
4385static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4386{
4387 int status;
4388
4389 vdbg_printk(TPACPI_DBG_RFKILL,
4390 "will attempt to %s bluetooth\n",
4391 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4392
4393#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4394 if (dbg_bluetoothemul) {
4395 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4396 return 0;
4397 }
4398#endif
4399
4400 if (state == TPACPI_RFK_RADIO_ON)
4401 status = TP_ACPI_BLUETOOTH_RADIOSSW
4402 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4403 else
4404 status = 0;
4405
4406 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4407 return -EIO;
4408
4409 return 0;
4410}
4411
4412/* sysfs bluetooth enable ---------------------------------------------- */
4413static ssize_t bluetooth_enable_show(struct device *dev,
4414 struct device_attribute *attr,
4415 char *buf)
4416{
4417 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4418 attr, buf);
4419}
4420
4421static ssize_t bluetooth_enable_store(struct device *dev,
4422 struct device_attribute *attr,
4423 const char *buf, size_t count)
4424{
4425 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4426 attr, buf, count);
4427}
4428
4429static DEVICE_ATTR_RW(bluetooth_enable);
4430
4431/* --------------------------------------------------------------------- */
4432
4433static struct attribute *bluetooth_attributes[] = {
4434 &dev_attr_bluetooth_enable.attr,
4435 NULL
4436};
4437
4438static const struct attribute_group bluetooth_attr_group = {
4439 .attrs = bluetooth_attributes,
4440};
4441
4442static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4443 .get_status = bluetooth_get_status,
4444 .set_status = bluetooth_set_status,
4445};
4446
4447static void bluetooth_shutdown(void)
4448{
4449 /* Order firmware to save current state to NVRAM */
4450 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4451 TP_ACPI_BLTH_SAVE_STATE))
4452 pr_notice("failed to save bluetooth state to NVRAM\n");
4453 else
4454 vdbg_printk(TPACPI_DBG_RFKILL,
4455 "bluetooth state saved to NVRAM\n");
4456}
4457
4458static void bluetooth_exit(void)
4459{
4460 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4461 &bluetooth_attr_group);
4462
4463 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4464
4465 bluetooth_shutdown();
4466}
4467
4468static const struct dmi_system_id bt_fwbug_list[] __initconst = {
4469 {
4470 .ident = "ThinkPad E485",
4471 .matches = {
4472 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4473 DMI_MATCH(DMI_BOARD_NAME, "20KU"),
4474 },
4475 },
4476 {
4477 .ident = "ThinkPad E585",
4478 .matches = {
4479 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4480 DMI_MATCH(DMI_BOARD_NAME, "20KV"),
4481 },
4482 },
4483 {
4484 .ident = "ThinkPad A285 - 20MW",
4485 .matches = {
4486 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4487 DMI_MATCH(DMI_BOARD_NAME, "20MW"),
4488 },
4489 },
4490 {
4491 .ident = "ThinkPad A285 - 20MX",
4492 .matches = {
4493 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4494 DMI_MATCH(DMI_BOARD_NAME, "20MX"),
4495 },
4496 },
4497 {
4498 .ident = "ThinkPad A485 - 20MU",
4499 .matches = {
4500 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4501 DMI_MATCH(DMI_BOARD_NAME, "20MU"),
4502 },
4503 },
4504 {
4505 .ident = "ThinkPad A485 - 20MV",
4506 .matches = {
4507 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4508 DMI_MATCH(DMI_BOARD_NAME, "20MV"),
4509 },
4510 },
4511 {}
4512};
4513
4514static const struct pci_device_id fwbug_cards_ids[] __initconst = {
4515 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24F3) },
4516 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24FD) },
4517 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2526) },
4518 {}
4519};
4520
4521
4522static int __init have_bt_fwbug(void)
4523{
4524 /*
4525 * Some AMD based ThinkPads have a firmware bug that calling
4526 * "GBDC" will cause bluetooth on Intel wireless cards blocked
4527 */
4528 if (dmi_check_system(bt_fwbug_list) && pci_dev_present(fwbug_cards_ids)) {
4529 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4530 FW_BUG "disable bluetooth subdriver for Intel cards\n");
4531 return 1;
4532 } else
4533 return 0;
4534}
4535
4536static int __init bluetooth_init(struct ibm_init_struct *iibm)
4537{
4538 int res;
4539 int status = 0;
4540
4541 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4542 "initializing bluetooth subdriver\n");
4543
4544 TPACPI_ACPIHANDLE_INIT(hkey);
4545
4546 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4547 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4548 tp_features.bluetooth = !have_bt_fwbug() && hkey_handle &&
4549 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4550
4551 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4552 "bluetooth is %s, status 0x%02x\n",
4553 str_supported(tp_features.bluetooth),
4554 status);
4555
4556#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4557 if (dbg_bluetoothemul) {
4558 tp_features.bluetooth = 1;
4559 pr_info("bluetooth switch emulation enabled\n");
4560 } else
4561#endif
4562 if (tp_features.bluetooth &&
4563 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4564 /* no bluetooth hardware present in system */
4565 tp_features.bluetooth = 0;
4566 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4567 "bluetooth hardware not installed\n");
4568 }
4569
4570 if (!tp_features.bluetooth)
4571 return 1;
4572
4573 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4574 &bluetooth_tprfk_ops,
4575 RFKILL_TYPE_BLUETOOTH,
4576 TPACPI_RFK_BLUETOOTH_SW_NAME,
4577 true);
4578 if (res)
4579 return res;
4580
4581 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4582 &bluetooth_attr_group);
4583 if (res) {
4584 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4585 return res;
4586 }
4587
4588 return 0;
4589}
4590
4591/* procfs -------------------------------------------------------------- */
4592static int bluetooth_read(struct seq_file *m)
4593{
4594 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4595}
4596
4597static int bluetooth_write(char *buf)
4598{
4599 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4600}
4601
4602static struct ibm_struct bluetooth_driver_data = {
4603 .name = "bluetooth",
4604 .read = bluetooth_read,
4605 .write = bluetooth_write,
4606 .exit = bluetooth_exit,
4607 .shutdown = bluetooth_shutdown,
4608};
4609
4610/*************************************************************************
4611 * Wan subdriver
4612 */
4613
4614enum {
4615 /* ACPI GWAN/SWAN bits */
4616 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4617 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4618 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4619 0 = disable, 1 = enable */
4620};
4621
4622#define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4623
4624static int wan_get_status(void)
4625{
4626 int status;
4627
4628#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4629 if (dbg_wwanemul)
4630 return (tpacpi_wwan_emulstate) ?
4631 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4632#endif
4633
4634 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4635 return -EIO;
4636
4637 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4638 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4639}
4640
4641static int wan_set_status(enum tpacpi_rfkill_state state)
4642{
4643 int status;
4644
4645 vdbg_printk(TPACPI_DBG_RFKILL,
4646 "will attempt to %s wwan\n",
4647 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4648
4649#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4650 if (dbg_wwanemul) {
4651 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4652 return 0;
4653 }
4654#endif
4655
4656 if (state == TPACPI_RFK_RADIO_ON)
4657 status = TP_ACPI_WANCARD_RADIOSSW
4658 | TP_ACPI_WANCARD_RESUMECTRL;
4659 else
4660 status = 0;
4661
4662 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4663 return -EIO;
4664
4665 return 0;
4666}
4667
4668/* sysfs wan enable ---------------------------------------------------- */
4669static ssize_t wan_enable_show(struct device *dev,
4670 struct device_attribute *attr,
4671 char *buf)
4672{
4673 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4674 attr, buf);
4675}
4676
4677static ssize_t wan_enable_store(struct device *dev,
4678 struct device_attribute *attr,
4679 const char *buf, size_t count)
4680{
4681 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4682 attr, buf, count);
4683}
4684
4685static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4686 wan_enable_show, wan_enable_store);
4687
4688/* --------------------------------------------------------------------- */
4689
4690static struct attribute *wan_attributes[] = {
4691 &dev_attr_wwan_enable.attr,
4692 NULL
4693};
4694
4695static const struct attribute_group wan_attr_group = {
4696 .attrs = wan_attributes,
4697};
4698
4699static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4700 .get_status = wan_get_status,
4701 .set_status = wan_set_status,
4702};
4703
4704static void wan_shutdown(void)
4705{
4706 /* Order firmware to save current state to NVRAM */
4707 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4708 TP_ACPI_WGSV_SAVE_STATE))
4709 pr_notice("failed to save WWAN state to NVRAM\n");
4710 else
4711 vdbg_printk(TPACPI_DBG_RFKILL,
4712 "WWAN state saved to NVRAM\n");
4713}
4714
4715static void wan_exit(void)
4716{
4717 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4718 &wan_attr_group);
4719
4720 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4721
4722 wan_shutdown();
4723}
4724
4725static int __init wan_init(struct ibm_init_struct *iibm)
4726{
4727 int res;
4728 int status = 0;
4729
4730 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4731 "initializing wan subdriver\n");
4732
4733 TPACPI_ACPIHANDLE_INIT(hkey);
4734
4735 tp_features.wan = hkey_handle &&
4736 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4737
4738 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4739 "wan is %s, status 0x%02x\n",
4740 str_supported(tp_features.wan),
4741 status);
4742
4743#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4744 if (dbg_wwanemul) {
4745 tp_features.wan = 1;
4746 pr_info("wwan switch emulation enabled\n");
4747 } else
4748#endif
4749 if (tp_features.wan &&
4750 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4751 /* no wan hardware present in system */
4752 tp_features.wan = 0;
4753 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4754 "wan hardware not installed\n");
4755 }
4756
4757 if (!tp_features.wan)
4758 return 1;
4759
4760 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4761 &wan_tprfk_ops,
4762 RFKILL_TYPE_WWAN,
4763 TPACPI_RFK_WWAN_SW_NAME,
4764 true);
4765 if (res)
4766 return res;
4767
4768 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4769 &wan_attr_group);
4770
4771 if (res) {
4772 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4773 return res;
4774 }
4775
4776 return 0;
4777}
4778
4779/* procfs -------------------------------------------------------------- */
4780static int wan_read(struct seq_file *m)
4781{
4782 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4783}
4784
4785static int wan_write(char *buf)
4786{
4787 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4788}
4789
4790static struct ibm_struct wan_driver_data = {
4791 .name = "wan",
4792 .read = wan_read,
4793 .write = wan_write,
4794 .exit = wan_exit,
4795 .shutdown = wan_shutdown,
4796};
4797
4798/*************************************************************************
4799 * UWB subdriver
4800 */
4801
4802enum {
4803 /* ACPI GUWB/SUWB bits */
4804 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4805 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4806};
4807
4808#define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4809
4810static int uwb_get_status(void)
4811{
4812 int status;
4813
4814#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4815 if (dbg_uwbemul)
4816 return (tpacpi_uwb_emulstate) ?
4817 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4818#endif
4819
4820 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4821 return -EIO;
4822
4823 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4824 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4825}
4826
4827static int uwb_set_status(enum tpacpi_rfkill_state state)
4828{
4829 int status;
4830
4831 vdbg_printk(TPACPI_DBG_RFKILL,
4832 "will attempt to %s UWB\n",
4833 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4834
4835#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4836 if (dbg_uwbemul) {
4837 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4838 return 0;
4839 }
4840#endif
4841
4842 if (state == TPACPI_RFK_RADIO_ON)
4843 status = TP_ACPI_UWB_RADIOSSW;
4844 else
4845 status = 0;
4846
4847 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4848 return -EIO;
4849
4850 return 0;
4851}
4852
4853/* --------------------------------------------------------------------- */
4854
4855static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4856 .get_status = uwb_get_status,
4857 .set_status = uwb_set_status,
4858};
4859
4860static void uwb_exit(void)
4861{
4862 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4863}
4864
4865static int __init uwb_init(struct ibm_init_struct *iibm)
4866{
4867 int res;
4868 int status = 0;
4869
4870 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4871 "initializing uwb subdriver\n");
4872
4873 TPACPI_ACPIHANDLE_INIT(hkey);
4874
4875 tp_features.uwb = hkey_handle &&
4876 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4877
4878 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4879 "uwb is %s, status 0x%02x\n",
4880 str_supported(tp_features.uwb),
4881 status);
4882
4883#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4884 if (dbg_uwbemul) {
4885 tp_features.uwb = 1;
4886 pr_info("uwb switch emulation enabled\n");
4887 } else
4888#endif
4889 if (tp_features.uwb &&
4890 !(status & TP_ACPI_UWB_HWPRESENT)) {
4891 /* no uwb hardware present in system */
4892 tp_features.uwb = 0;
4893 dbg_printk(TPACPI_DBG_INIT,
4894 "uwb hardware not installed\n");
4895 }
4896
4897 if (!tp_features.uwb)
4898 return 1;
4899
4900 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4901 &uwb_tprfk_ops,
4902 RFKILL_TYPE_UWB,
4903 TPACPI_RFK_UWB_SW_NAME,
4904 false);
4905 return res;
4906}
4907
4908static struct ibm_struct uwb_driver_data = {
4909 .name = "uwb",
4910 .exit = uwb_exit,
4911 .flags.experimental = 1,
4912};
4913
4914/*************************************************************************
4915 * Video subdriver
4916 */
4917
4918#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4919
4920enum video_access_mode {
4921 TPACPI_VIDEO_NONE = 0,
4922 TPACPI_VIDEO_570, /* 570 */
4923 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4924 TPACPI_VIDEO_NEW, /* all others */
4925};
4926
4927enum { /* video status flags, based on VIDEO_570 */
4928 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4929 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4930 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4931};
4932
4933enum { /* TPACPI_VIDEO_570 constants */
4934 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4935 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4936 * video_status_flags */
4937 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4938 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4939};
4940
4941static enum video_access_mode video_supported;
4942static int video_orig_autosw;
4943
4944static int video_autosw_get(void);
4945static int video_autosw_set(int enable);
4946
4947TPACPI_HANDLE(vid, root,
4948 "\\_SB.PCI.AGP.VGA", /* 570 */
4949 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4950 "\\_SB.PCI0.VID0", /* 770e */
4951 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4952 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4953 "\\_SB.PCI0.AGP.VID", /* all others */
4954 ); /* R30, R31 */
4955
4956TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4957
4958static int __init video_init(struct ibm_init_struct *iibm)
4959{
4960 int ivga;
4961
4962 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4963
4964 TPACPI_ACPIHANDLE_INIT(vid);
4965 if (tpacpi_is_ibm())
4966 TPACPI_ACPIHANDLE_INIT(vid2);
4967
4968 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4969 /* G41, assume IVGA doesn't change */
4970 vid_handle = vid2_handle;
4971
4972 if (!vid_handle)
4973 /* video switching not supported on R30, R31 */
4974 video_supported = TPACPI_VIDEO_NONE;
4975 else if (tpacpi_is_ibm() &&
4976 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4977 /* 570 */
4978 video_supported = TPACPI_VIDEO_570;
4979 else if (tpacpi_is_ibm() &&
4980 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4981 /* 600e/x, 770e, 770x */
4982 video_supported = TPACPI_VIDEO_770;
4983 else
4984 /* all others */
4985 video_supported = TPACPI_VIDEO_NEW;
4986
4987 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4988 str_supported(video_supported != TPACPI_VIDEO_NONE),
4989 video_supported);
4990
4991 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : 1;
4992}
4993
4994static void video_exit(void)
4995{
4996 dbg_printk(TPACPI_DBG_EXIT,
4997 "restoring original video autoswitch mode\n");
4998 if (video_autosw_set(video_orig_autosw))
4999 pr_err("error while trying to restore original video autoswitch mode\n");
5000}
5001
5002static int video_outputsw_get(void)
5003{
5004 int status = 0;
5005 int i;
5006
5007 switch (video_supported) {
5008 case TPACPI_VIDEO_570:
5009 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
5010 TP_ACPI_VIDEO_570_PHSCMD))
5011 return -EIO;
5012 status = i & TP_ACPI_VIDEO_570_PHSMASK;
5013 break;
5014 case TPACPI_VIDEO_770:
5015 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
5016 return -EIO;
5017 if (i)
5018 status |= TP_ACPI_VIDEO_S_LCD;
5019 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
5020 return -EIO;
5021 if (i)
5022 status |= TP_ACPI_VIDEO_S_CRT;
5023 break;
5024 case TPACPI_VIDEO_NEW:
5025 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
5026 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
5027 return -EIO;
5028 if (i)
5029 status |= TP_ACPI_VIDEO_S_CRT;
5030
5031 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
5032 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
5033 return -EIO;
5034 if (i)
5035 status |= TP_ACPI_VIDEO_S_LCD;
5036 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
5037 return -EIO;
5038 if (i)
5039 status |= TP_ACPI_VIDEO_S_DVI;
5040 break;
5041 default:
5042 return -ENOSYS;
5043 }
5044
5045 return status;
5046}
5047
5048static int video_outputsw_set(int status)
5049{
5050 int autosw;
5051 int res = 0;
5052
5053 switch (video_supported) {
5054 case TPACPI_VIDEO_570:
5055 res = acpi_evalf(NULL, NULL,
5056 "\\_SB.PHS2", "vdd",
5057 TP_ACPI_VIDEO_570_PHS2CMD,
5058 status | TP_ACPI_VIDEO_570_PHS2SET);
5059 break;
5060 case TPACPI_VIDEO_770:
5061 autosw = video_autosw_get();
5062 if (autosw < 0)
5063 return autosw;
5064
5065 res = video_autosw_set(1);
5066 if (res)
5067 return res;
5068 res = acpi_evalf(vid_handle, NULL,
5069 "ASWT", "vdd", status * 0x100, 0);
5070 if (!autosw && video_autosw_set(autosw)) {
5071 pr_err("video auto-switch left enabled due to error\n");
5072 return -EIO;
5073 }
5074 break;
5075 case TPACPI_VIDEO_NEW:
5076 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5077 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5078 break;
5079 default:
5080 return -ENOSYS;
5081 }
5082
5083 return (res) ? 0 : -EIO;
5084}
5085
5086static int video_autosw_get(void)
5087{
5088 int autosw = 0;
5089
5090 switch (video_supported) {
5091 case TPACPI_VIDEO_570:
5092 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5093 return -EIO;
5094 break;
5095 case TPACPI_VIDEO_770:
5096 case TPACPI_VIDEO_NEW:
5097 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5098 return -EIO;
5099 break;
5100 default:
5101 return -ENOSYS;
5102 }
5103
5104 return autosw & 1;
5105}
5106
5107static int video_autosw_set(int enable)
5108{
5109 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5110 return -EIO;
5111 return 0;
5112}
5113
5114static int video_outputsw_cycle(void)
5115{
5116 int autosw = video_autosw_get();
5117 int res;
5118
5119 if (autosw < 0)
5120 return autosw;
5121
5122 switch (video_supported) {
5123 case TPACPI_VIDEO_570:
5124 res = video_autosw_set(1);
5125 if (res)
5126 return res;
5127 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5128 break;
5129 case TPACPI_VIDEO_770:
5130 case TPACPI_VIDEO_NEW:
5131 res = video_autosw_set(1);
5132 if (res)
5133 return res;
5134 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5135 break;
5136 default:
5137 return -ENOSYS;
5138 }
5139 if (!autosw && video_autosw_set(autosw)) {
5140 pr_err("video auto-switch left enabled due to error\n");
5141 return -EIO;
5142 }
5143
5144 return (res) ? 0 : -EIO;
5145}
5146
5147static int video_expand_toggle(void)
5148{
5149 switch (video_supported) {
5150 case TPACPI_VIDEO_570:
5151 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5152 0 : -EIO;
5153 case TPACPI_VIDEO_770:
5154 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5155 0 : -EIO;
5156 case TPACPI_VIDEO_NEW:
5157 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5158 0 : -EIO;
5159 default:
5160 return -ENOSYS;
5161 }
5162 /* not reached */
5163}
5164
5165static int video_read(struct seq_file *m)
5166{
5167 int status, autosw;
5168
5169 if (video_supported == TPACPI_VIDEO_NONE) {
5170 seq_printf(m, "status:\t\tnot supported\n");
5171 return 0;
5172 }
5173
5174 /* Even reads can crash X.org, so... */
5175 if (!capable(CAP_SYS_ADMIN))
5176 return -EPERM;
5177
5178 status = video_outputsw_get();
5179 if (status < 0)
5180 return status;
5181
5182 autosw = video_autosw_get();
5183 if (autosw < 0)
5184 return autosw;
5185
5186 seq_printf(m, "status:\t\tsupported\n");
5187 seq_printf(m, "lcd:\t\t%s\n", enabled(status, 0));
5188 seq_printf(m, "crt:\t\t%s\n", enabled(status, 1));
5189 if (video_supported == TPACPI_VIDEO_NEW)
5190 seq_printf(m, "dvi:\t\t%s\n", enabled(status, 3));
5191 seq_printf(m, "auto:\t\t%s\n", enabled(autosw, 0));
5192 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5193 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5194 if (video_supported == TPACPI_VIDEO_NEW)
5195 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5196 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5197 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5198
5199 return 0;
5200}
5201
5202static int video_write(char *buf)
5203{
5204 char *cmd;
5205 int enable, disable, status;
5206 int res;
5207
5208 if (video_supported == TPACPI_VIDEO_NONE)
5209 return -ENODEV;
5210
5211 /* Even reads can crash X.org, let alone writes... */
5212 if (!capable(CAP_SYS_ADMIN))
5213 return -EPERM;
5214
5215 enable = 0;
5216 disable = 0;
5217
5218 while ((cmd = strsep(&buf, ","))) {
5219 if (strlencmp(cmd, "lcd_enable") == 0) {
5220 enable |= TP_ACPI_VIDEO_S_LCD;
5221 } else if (strlencmp(cmd, "lcd_disable") == 0) {
5222 disable |= TP_ACPI_VIDEO_S_LCD;
5223 } else if (strlencmp(cmd, "crt_enable") == 0) {
5224 enable |= TP_ACPI_VIDEO_S_CRT;
5225 } else if (strlencmp(cmd, "crt_disable") == 0) {
5226 disable |= TP_ACPI_VIDEO_S_CRT;
5227 } else if (video_supported == TPACPI_VIDEO_NEW &&
5228 strlencmp(cmd, "dvi_enable") == 0) {
5229 enable |= TP_ACPI_VIDEO_S_DVI;
5230 } else if (video_supported == TPACPI_VIDEO_NEW &&
5231 strlencmp(cmd, "dvi_disable") == 0) {
5232 disable |= TP_ACPI_VIDEO_S_DVI;
5233 } else if (strlencmp(cmd, "auto_enable") == 0) {
5234 res = video_autosw_set(1);
5235 if (res)
5236 return res;
5237 } else if (strlencmp(cmd, "auto_disable") == 0) {
5238 res = video_autosw_set(0);
5239 if (res)
5240 return res;
5241 } else if (strlencmp(cmd, "video_switch") == 0) {
5242 res = video_outputsw_cycle();
5243 if (res)
5244 return res;
5245 } else if (strlencmp(cmd, "expand_toggle") == 0) {
5246 res = video_expand_toggle();
5247 if (res)
5248 return res;
5249 } else
5250 return -EINVAL;
5251 }
5252
5253 if (enable || disable) {
5254 status = video_outputsw_get();
5255 if (status < 0)
5256 return status;
5257 res = video_outputsw_set((status & ~disable) | enable);
5258 if (res)
5259 return res;
5260 }
5261
5262 return 0;
5263}
5264
5265static struct ibm_struct video_driver_data = {
5266 .name = "video",
5267 .read = video_read,
5268 .write = video_write,
5269 .exit = video_exit,
5270};
5271
5272#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5273
5274/*************************************************************************
5275 * Keyboard backlight subdriver
5276 */
5277
5278static enum led_brightness kbdlight_brightness;
5279static DEFINE_MUTEX(kbdlight_mutex);
5280
5281static int kbdlight_set_level(int level)
5282{
5283 int ret = 0;
5284
5285 if (!hkey_handle)
5286 return -ENXIO;
5287
5288 mutex_lock(&kbdlight_mutex);
5289
5290 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5291 ret = -EIO;
5292 else
5293 kbdlight_brightness = level;
5294
5295 mutex_unlock(&kbdlight_mutex);
5296
5297 return ret;
5298}
5299
5300static int kbdlight_get_level(void)
5301{
5302 int status = 0;
5303
5304 if (!hkey_handle)
5305 return -ENXIO;
5306
5307 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5308 return -EIO;
5309
5310 if (status < 0)
5311 return status;
5312
5313 return status & 0x3;
5314}
5315
5316static bool kbdlight_is_supported(void)
5317{
5318 int status = 0;
5319
5320 if (!hkey_handle)
5321 return false;
5322
5323 if (!acpi_has_method(hkey_handle, "MLCG")) {
5324 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5325 return false;
5326 }
5327
5328 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5329 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5330 return false;
5331 }
5332
5333 if (status < 0) {
5334 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5335 return false;
5336 }
5337
5338 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5339 /*
5340 * Guessed test for keyboard backlight:
5341 *
5342 * Machines with backlight keyboard return:
5343 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5344 * b110100010010000000XX - ThinkPad x230
5345 * b010100000010000000XX - ThinkPad x240
5346 * b010100000010000000XX - ThinkPad W541
5347 * (XX is current backlight level)
5348 *
5349 * Machines without backlight keyboard return:
5350 * b10100001000000000000 - ThinkPad x230
5351 * b10110001000000000000 - ThinkPad E430
5352 * b00000000000000000000 - ThinkPad E450
5353 *
5354 * Candidate BITs for detection test (XOR):
5355 * b01000000001000000000
5356 * ^
5357 */
5358 return status & BIT(9);
5359}
5360
5361static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5362 enum led_brightness brightness)
5363{
5364 return kbdlight_set_level(brightness);
5365}
5366
5367static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5368{
5369 int level;
5370
5371 level = kbdlight_get_level();
5372 if (level < 0)
5373 return 0;
5374
5375 return level;
5376}
5377
5378static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5379 .led_classdev = {
5380 .name = "tpacpi::kbd_backlight",
5381 .max_brightness = 2,
5382 .flags = LED_BRIGHT_HW_CHANGED,
5383 .brightness_set_blocking = &kbdlight_sysfs_set,
5384 .brightness_get = &kbdlight_sysfs_get,
5385 }
5386};
5387
5388static int __init kbdlight_init(struct ibm_init_struct *iibm)
5389{
5390 int rc;
5391
5392 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5393
5394 TPACPI_ACPIHANDLE_INIT(hkey);
5395
5396 if (!kbdlight_is_supported()) {
5397 tp_features.kbdlight = 0;
5398 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5399 return 1;
5400 }
5401
5402 kbdlight_brightness = kbdlight_sysfs_get(NULL);
5403 tp_features.kbdlight = 1;
5404
5405 rc = led_classdev_register(&tpacpi_pdev->dev,
5406 &tpacpi_led_kbdlight.led_classdev);
5407 if (rc < 0) {
5408 tp_features.kbdlight = 0;
5409 return rc;
5410 }
5411
5412 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5413 TP_ACPI_HKEY_KBD_LIGHT_MASK);
5414 return 0;
5415}
5416
5417static void kbdlight_exit(void)
5418{
5419 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5420}
5421
5422static int kbdlight_set_level_and_update(int level)
5423{
5424 int ret;
5425 struct led_classdev *led_cdev;
5426
5427 ret = kbdlight_set_level(level);
5428 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5429
5430 if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5431 led_cdev->brightness = level;
5432
5433 return ret;
5434}
5435
5436static int kbdlight_read(struct seq_file *m)
5437{
5438 int level;
5439
5440 if (!tp_features.kbdlight) {
5441 seq_printf(m, "status:\t\tnot supported\n");
5442 } else {
5443 level = kbdlight_get_level();
5444 if (level < 0)
5445 seq_printf(m, "status:\t\terror %d\n", level);
5446 else
5447 seq_printf(m, "status:\t\t%d\n", level);
5448 seq_printf(m, "commands:\t0, 1, 2\n");
5449 }
5450
5451 return 0;
5452}
5453
5454static int kbdlight_write(char *buf)
5455{
5456 char *cmd;
5457 int res, level = -EINVAL;
5458
5459 if (!tp_features.kbdlight)
5460 return -ENODEV;
5461
5462 while ((cmd = strsep(&buf, ","))) {
5463 res = kstrtoint(cmd, 10, &level);
5464 if (res < 0)
5465 return res;
5466 }
5467
5468 if (level >= 3 || level < 0)
5469 return -EINVAL;
5470
5471 return kbdlight_set_level_and_update(level);
5472}
5473
5474static void kbdlight_suspend(void)
5475{
5476 struct led_classdev *led_cdev;
5477
5478 if (!tp_features.kbdlight)
5479 return;
5480
5481 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5482 led_update_brightness(led_cdev);
5483 led_classdev_suspend(led_cdev);
5484}
5485
5486static void kbdlight_resume(void)
5487{
5488 if (!tp_features.kbdlight)
5489 return;
5490
5491 led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5492}
5493
5494static struct ibm_struct kbdlight_driver_data = {
5495 .name = "kbdlight",
5496 .read = kbdlight_read,
5497 .write = kbdlight_write,
5498 .suspend = kbdlight_suspend,
5499 .resume = kbdlight_resume,
5500 .exit = kbdlight_exit,
5501};
5502
5503/*************************************************************************
5504 * Light (thinklight) subdriver
5505 */
5506
5507TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5508TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5509
5510static int light_get_status(void)
5511{
5512 int status = 0;
5513
5514 if (tp_features.light_status) {
5515 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5516 return -EIO;
5517 return (!!status);
5518 }
5519
5520 return -ENXIO;
5521}
5522
5523static int light_set_status(int status)
5524{
5525 int rc;
5526
5527 if (tp_features.light) {
5528 if (cmos_handle) {
5529 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5530 (status) ?
5531 TP_CMOS_THINKLIGHT_ON :
5532 TP_CMOS_THINKLIGHT_OFF);
5533 } else {
5534 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5535 (status) ? 1 : 0);
5536 }
5537 return (rc) ? 0 : -EIO;
5538 }
5539
5540 return -ENXIO;
5541}
5542
5543static int light_sysfs_set(struct led_classdev *led_cdev,
5544 enum led_brightness brightness)
5545{
5546 return light_set_status((brightness != LED_OFF) ?
5547 TPACPI_LED_ON : TPACPI_LED_OFF);
5548}
5549
5550static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5551{
5552 return (light_get_status() == 1) ? LED_FULL : LED_OFF;
5553}
5554
5555static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5556 .led_classdev = {
5557 .name = "tpacpi::thinklight",
5558 .brightness_set_blocking = &light_sysfs_set,
5559 .brightness_get = &light_sysfs_get,
5560 }
5561};
5562
5563static int __init light_init(struct ibm_init_struct *iibm)
5564{
5565 int rc;
5566
5567 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5568
5569 if (tpacpi_is_ibm()) {
5570 TPACPI_ACPIHANDLE_INIT(ledb);
5571 TPACPI_ACPIHANDLE_INIT(lght);
5572 }
5573 TPACPI_ACPIHANDLE_INIT(cmos);
5574
5575 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5576 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5577
5578 if (tp_features.light)
5579 /* light status not supported on
5580 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5581 tp_features.light_status =
5582 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5583
5584 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5585 str_supported(tp_features.light),
5586 str_supported(tp_features.light_status));
5587
5588 if (!tp_features.light)
5589 return 1;
5590
5591 rc = led_classdev_register(&tpacpi_pdev->dev,
5592 &tpacpi_led_thinklight.led_classdev);
5593
5594 if (rc < 0) {
5595 tp_features.light = 0;
5596 tp_features.light_status = 0;
5597 } else {
5598 rc = 0;
5599 }
5600
5601 return rc;
5602}
5603
5604static void light_exit(void)
5605{
5606 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5607}
5608
5609static int light_read(struct seq_file *m)
5610{
5611 int status;
5612
5613 if (!tp_features.light) {
5614 seq_printf(m, "status:\t\tnot supported\n");
5615 } else if (!tp_features.light_status) {
5616 seq_printf(m, "status:\t\tunknown\n");
5617 seq_printf(m, "commands:\ton, off\n");
5618 } else {
5619 status = light_get_status();
5620 if (status < 0)
5621 return status;
5622 seq_printf(m, "status:\t\t%s\n", onoff(status, 0));
5623 seq_printf(m, "commands:\ton, off\n");
5624 }
5625
5626 return 0;
5627}
5628
5629static int light_write(char *buf)
5630{
5631 char *cmd;
5632 int newstatus = 0;
5633
5634 if (!tp_features.light)
5635 return -ENODEV;
5636
5637 while ((cmd = strsep(&buf, ","))) {
5638 if (strlencmp(cmd, "on") == 0) {
5639 newstatus = 1;
5640 } else if (strlencmp(cmd, "off") == 0) {
5641 newstatus = 0;
5642 } else
5643 return -EINVAL;
5644 }
5645
5646 return light_set_status(newstatus);
5647}
5648
5649static struct ibm_struct light_driver_data = {
5650 .name = "light",
5651 .read = light_read,
5652 .write = light_write,
5653 .exit = light_exit,
5654};
5655
5656/*************************************************************************
5657 * CMOS subdriver
5658 */
5659
5660/* sysfs cmos_command -------------------------------------------------- */
5661static ssize_t cmos_command_store(struct device *dev,
5662 struct device_attribute *attr,
5663 const char *buf, size_t count)
5664{
5665 unsigned long cmos_cmd;
5666 int res;
5667
5668 if (parse_strtoul(buf, 21, &cmos_cmd))
5669 return -EINVAL;
5670
5671 res = issue_thinkpad_cmos_command(cmos_cmd);
5672 return (res) ? res : count;
5673}
5674
5675static DEVICE_ATTR_WO(cmos_command);
5676
5677/* --------------------------------------------------------------------- */
5678
5679static int __init cmos_init(struct ibm_init_struct *iibm)
5680{
5681 int res;
5682
5683 vdbg_printk(TPACPI_DBG_INIT,
5684 "initializing cmos commands subdriver\n");
5685
5686 TPACPI_ACPIHANDLE_INIT(cmos);
5687
5688 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5689 str_supported(cmos_handle != NULL));
5690
5691 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5692 if (res)
5693 return res;
5694
5695 return (cmos_handle) ? 0 : 1;
5696}
5697
5698static void cmos_exit(void)
5699{
5700 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
5701}
5702
5703static int cmos_read(struct seq_file *m)
5704{
5705 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5706 R30, R31, T20-22, X20-21 */
5707 if (!cmos_handle)
5708 seq_printf(m, "status:\t\tnot supported\n");
5709 else {
5710 seq_printf(m, "status:\t\tsupported\n");
5711 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5712 }
5713
5714 return 0;
5715}
5716
5717static int cmos_write(char *buf)
5718{
5719 char *cmd;
5720 int cmos_cmd, res;
5721
5722 while ((cmd = strsep(&buf, ","))) {
5723 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5724 cmos_cmd >= 0 && cmos_cmd <= 21) {
5725 /* cmos_cmd set */
5726 } else
5727 return -EINVAL;
5728
5729 res = issue_thinkpad_cmos_command(cmos_cmd);
5730 if (res)
5731 return res;
5732 }
5733
5734 return 0;
5735}
5736
5737static struct ibm_struct cmos_driver_data = {
5738 .name = "cmos",
5739 .read = cmos_read,
5740 .write = cmos_write,
5741 .exit = cmos_exit,
5742};
5743
5744/*************************************************************************
5745 * LED subdriver
5746 */
5747
5748enum led_access_mode {
5749 TPACPI_LED_NONE = 0,
5750 TPACPI_LED_570, /* 570 */
5751 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5752 TPACPI_LED_NEW, /* all others */
5753};
5754
5755enum { /* For TPACPI_LED_OLD */
5756 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5757 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5758 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5759};
5760
5761static enum led_access_mode led_supported;
5762
5763static acpi_handle led_handle;
5764
5765#define TPACPI_LED_NUMLEDS 16
5766static struct tpacpi_led_classdev *tpacpi_leds;
5767static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5768static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5769 /* there's a limit of 19 chars + NULL before 2.6.26 */
5770 "tpacpi::power",
5771 "tpacpi:orange:batt",
5772 "tpacpi:green:batt",
5773 "tpacpi::dock_active",
5774 "tpacpi::bay_active",
5775 "tpacpi::dock_batt",
5776 "tpacpi::unknown_led",
5777 "tpacpi::standby",
5778 "tpacpi::dock_status1",
5779 "tpacpi::dock_status2",
5780 "tpacpi::unknown_led2",
5781 "tpacpi::unknown_led3",
5782 "tpacpi::thinkvantage",
5783};
5784#define TPACPI_SAFE_LEDS 0x1081U
5785
5786static inline bool tpacpi_is_led_restricted(const unsigned int led)
5787{
5788#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5789 return false;
5790#else
5791 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5792#endif
5793}
5794
5795static int led_get_status(const unsigned int led)
5796{
5797 int status;
5798 enum led_status_t led_s;
5799
5800 switch (led_supported) {
5801 case TPACPI_LED_570:
5802 if (!acpi_evalf(ec_handle,
5803 &status, "GLED", "dd", 1 << led))
5804 return -EIO;
5805 led_s = (status == 0) ?
5806 TPACPI_LED_OFF :
5807 ((status == 1) ?
5808 TPACPI_LED_ON :
5809 TPACPI_LED_BLINK);
5810 tpacpi_led_state_cache[led] = led_s;
5811 return led_s;
5812 default:
5813 return -ENXIO;
5814 }
5815
5816 /* not reached */
5817}
5818
5819static int led_set_status(const unsigned int led,
5820 const enum led_status_t ledstatus)
5821{
5822 /* off, on, blink. Index is led_status_t */
5823 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5824 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5825
5826 int rc = 0;
5827
5828 switch (led_supported) {
5829 case TPACPI_LED_570:
5830 /* 570 */
5831 if (unlikely(led > 7))
5832 return -EINVAL;
5833 if (unlikely(tpacpi_is_led_restricted(led)))
5834 return -EPERM;
5835 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5836 (1 << led), led_sled_arg1[ledstatus]))
5837 return -EIO;
5838 break;
5839 case TPACPI_LED_OLD:
5840 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5841 if (unlikely(led > 7))
5842 return -EINVAL;
5843 if (unlikely(tpacpi_is_led_restricted(led)))
5844 return -EPERM;
5845 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5846 if (rc >= 0)
5847 rc = ec_write(TPACPI_LED_EC_HLBL,
5848 (ledstatus == TPACPI_LED_BLINK) << led);
5849 if (rc >= 0)
5850 rc = ec_write(TPACPI_LED_EC_HLCL,
5851 (ledstatus != TPACPI_LED_OFF) << led);
5852 break;
5853 case TPACPI_LED_NEW:
5854 /* all others */
5855 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5856 return -EINVAL;
5857 if (unlikely(tpacpi_is_led_restricted(led)))
5858 return -EPERM;
5859 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5860 led, led_led_arg1[ledstatus]))
5861 return -EIO;
5862 break;
5863 default:
5864 return -ENXIO;
5865 }
5866
5867 if (!rc)
5868 tpacpi_led_state_cache[led] = ledstatus;
5869
5870 return rc;
5871}
5872
5873static int led_sysfs_set(struct led_classdev *led_cdev,
5874 enum led_brightness brightness)
5875{
5876 struct tpacpi_led_classdev *data = container_of(led_cdev,
5877 struct tpacpi_led_classdev, led_classdev);
5878 enum led_status_t new_state;
5879
5880 if (brightness == LED_OFF)
5881 new_state = TPACPI_LED_OFF;
5882 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5883 new_state = TPACPI_LED_ON;
5884 else
5885 new_state = TPACPI_LED_BLINK;
5886
5887 return led_set_status(data->led, new_state);
5888}
5889
5890static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5891 unsigned long *delay_on, unsigned long *delay_off)
5892{
5893 struct tpacpi_led_classdev *data = container_of(led_cdev,
5894 struct tpacpi_led_classdev, led_classdev);
5895
5896 /* Can we choose the flash rate? */
5897 if (*delay_on == 0 && *delay_off == 0) {
5898 /* yes. set them to the hardware blink rate (1 Hz) */
5899 *delay_on = 500; /* ms */
5900 *delay_off = 500; /* ms */
5901 } else if ((*delay_on != 500) || (*delay_off != 500))
5902 return -EINVAL;
5903
5904 return led_set_status(data->led, TPACPI_LED_BLINK);
5905}
5906
5907static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5908{
5909 int rc;
5910
5911 struct tpacpi_led_classdev *data = container_of(led_cdev,
5912 struct tpacpi_led_classdev, led_classdev);
5913
5914 rc = led_get_status(data->led);
5915
5916 if (rc == TPACPI_LED_OFF || rc < 0)
5917 rc = LED_OFF; /* no error handling in led class :( */
5918 else
5919 rc = LED_FULL;
5920
5921 return rc;
5922}
5923
5924static void led_exit(void)
5925{
5926 unsigned int i;
5927
5928 for (i = 0; i < TPACPI_LED_NUMLEDS; i++)
5929 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5930
5931 kfree(tpacpi_leds);
5932}
5933
5934static int __init tpacpi_init_led(unsigned int led)
5935{
5936 /* LEDs with no name don't get registered */
5937 if (!tpacpi_led_names[led])
5938 return 0;
5939
5940 tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5941 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5942 if (led_supported == TPACPI_LED_570)
5943 tpacpi_leds[led].led_classdev.brightness_get = &led_sysfs_get;
5944
5945 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5946 tpacpi_leds[led].led = led;
5947
5948 return led_classdev_register(&tpacpi_pdev->dev, &tpacpi_leds[led].led_classdev);
5949}
5950
5951static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5952 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5953 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5954 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5955
5956 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5957 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5958 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5959 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5960 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5961 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5962 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5963 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5964
5965 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5966 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5967 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5968 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5969 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5970
5971 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5972 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5973 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5974 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5975
5976 /* (1) - may have excess leds enabled on MSB */
5977
5978 /* Defaults (order matters, keep last, don't reorder!) */
5979 { /* Lenovo */
5980 .vendor = PCI_VENDOR_ID_LENOVO,
5981 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5982 .quirks = 0x1fffU,
5983 },
5984 { /* IBM ThinkPads with no EC version string */
5985 .vendor = PCI_VENDOR_ID_IBM,
5986 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5987 .quirks = 0x00ffU,
5988 },
5989 { /* IBM ThinkPads with EC version string */
5990 .vendor = PCI_VENDOR_ID_IBM,
5991 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5992 .quirks = 0x00bfU,
5993 },
5994};
5995
5996static enum led_access_mode __init led_init_detect_mode(void)
5997{
5998 acpi_status status;
5999
6000 if (tpacpi_is_ibm()) {
6001 /* 570 */
6002 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
6003 if (ACPI_SUCCESS(status))
6004 return TPACPI_LED_570;
6005
6006 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
6007 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
6008 if (ACPI_SUCCESS(status))
6009 return TPACPI_LED_OLD;
6010 }
6011
6012 /* most others */
6013 status = acpi_get_handle(ec_handle, "LED", &led_handle);
6014 if (ACPI_SUCCESS(status))
6015 return TPACPI_LED_NEW;
6016
6017 /* R30, R31, and unknown firmwares */
6018 led_handle = NULL;
6019 return TPACPI_LED_NONE;
6020}
6021
6022static int __init led_init(struct ibm_init_struct *iibm)
6023{
6024 unsigned int i;
6025 int rc;
6026 unsigned long useful_leds;
6027
6028 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
6029
6030 led_supported = led_init_detect_mode();
6031
6032 if (led_supported != TPACPI_LED_NONE) {
6033 useful_leds = tpacpi_check_quirks(led_useful_qtable,
6034 ARRAY_SIZE(led_useful_qtable));
6035
6036 if (!useful_leds) {
6037 led_handle = NULL;
6038 led_supported = TPACPI_LED_NONE;
6039 }
6040 }
6041
6042 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6043 str_supported(led_supported), led_supported);
6044
6045 if (led_supported == TPACPI_LED_NONE)
6046 return 1;
6047
6048 tpacpi_leds = kcalloc(TPACPI_LED_NUMLEDS, sizeof(*tpacpi_leds),
6049 GFP_KERNEL);
6050 if (!tpacpi_leds) {
6051 pr_err("Out of memory for LED data\n");
6052 return -ENOMEM;
6053 }
6054
6055 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6056 tpacpi_leds[i].led = -1;
6057
6058 if (!tpacpi_is_led_restricted(i) && test_bit(i, &useful_leds)) {
6059 rc = tpacpi_init_led(i);
6060 if (rc < 0) {
6061 led_exit();
6062 return rc;
6063 }
6064 }
6065 }
6066
6067#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6068 pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6069#endif
6070 return 0;
6071}
6072
6073#define str_led_status(s) \
6074 ((s) == TPACPI_LED_OFF ? "off" : \
6075 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
6076
6077static int led_read(struct seq_file *m)
6078{
6079 if (!led_supported) {
6080 seq_printf(m, "status:\t\tnot supported\n");
6081 return 0;
6082 }
6083 seq_printf(m, "status:\t\tsupported\n");
6084
6085 if (led_supported == TPACPI_LED_570) {
6086 /* 570 */
6087 int i, status;
6088 for (i = 0; i < 8; i++) {
6089 status = led_get_status(i);
6090 if (status < 0)
6091 return -EIO;
6092 seq_printf(m, "%d:\t\t%s\n",
6093 i, str_led_status(status));
6094 }
6095 }
6096
6097 seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6098
6099 return 0;
6100}
6101
6102static int led_write(char *buf)
6103{
6104 char *cmd;
6105 int led, rc;
6106 enum led_status_t s;
6107
6108 if (!led_supported)
6109 return -ENODEV;
6110
6111 while ((cmd = strsep(&buf, ","))) {
6112 if (sscanf(cmd, "%d", &led) != 1)
6113 return -EINVAL;
6114
6115 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1))
6116 return -ENODEV;
6117
6118 if (tpacpi_leds[led].led < 0)
6119 return -ENODEV;
6120
6121 if (strstr(cmd, "off")) {
6122 s = TPACPI_LED_OFF;
6123 } else if (strstr(cmd, "on")) {
6124 s = TPACPI_LED_ON;
6125 } else if (strstr(cmd, "blink")) {
6126 s = TPACPI_LED_BLINK;
6127 } else {
6128 return -EINVAL;
6129 }
6130
6131 rc = led_set_status(led, s);
6132 if (rc < 0)
6133 return rc;
6134 }
6135
6136 return 0;
6137}
6138
6139static struct ibm_struct led_driver_data = {
6140 .name = "led",
6141 .read = led_read,
6142 .write = led_write,
6143 .exit = led_exit,
6144};
6145
6146/*************************************************************************
6147 * Beep subdriver
6148 */
6149
6150TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
6151
6152#define TPACPI_BEEP_Q1 0x0001
6153
6154static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6155 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6156 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6157};
6158
6159static int __init beep_init(struct ibm_init_struct *iibm)
6160{
6161 unsigned long quirks;
6162
6163 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6164
6165 TPACPI_ACPIHANDLE_INIT(beep);
6166
6167 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6168 str_supported(beep_handle != NULL));
6169
6170 quirks = tpacpi_check_quirks(beep_quirk_table,
6171 ARRAY_SIZE(beep_quirk_table));
6172
6173 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6174
6175 return (beep_handle) ? 0 : 1;
6176}
6177
6178static int beep_read(struct seq_file *m)
6179{
6180 if (!beep_handle)
6181 seq_printf(m, "status:\t\tnot supported\n");
6182 else {
6183 seq_printf(m, "status:\t\tsupported\n");
6184 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6185 }
6186
6187 return 0;
6188}
6189
6190static int beep_write(char *buf)
6191{
6192 char *cmd;
6193 int beep_cmd;
6194
6195 if (!beep_handle)
6196 return -ENODEV;
6197
6198 while ((cmd = strsep(&buf, ","))) {
6199 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6200 beep_cmd >= 0 && beep_cmd <= 17) {
6201 /* beep_cmd set */
6202 } else
6203 return -EINVAL;
6204 if (tp_features.beep_needs_two_args) {
6205 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6206 beep_cmd, 0))
6207 return -EIO;
6208 } else {
6209 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6210 beep_cmd))
6211 return -EIO;
6212 }
6213 }
6214
6215 return 0;
6216}
6217
6218static struct ibm_struct beep_driver_data = {
6219 .name = "beep",
6220 .read = beep_read,
6221 .write = beep_write,
6222};
6223
6224/*************************************************************************
6225 * Thermal subdriver
6226 */
6227
6228enum thermal_access_mode {
6229 TPACPI_THERMAL_NONE = 0, /* No thermal support */
6230 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
6231 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
6232 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
6233 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
6234};
6235
6236enum { /* TPACPI_THERMAL_TPEC_* */
6237 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
6238 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
6239 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
6240
6241 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6242};
6243
6244
6245#define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
6246struct ibm_thermal_sensors_struct {
6247 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6248};
6249
6250static enum thermal_access_mode thermal_read_mode;
6251
6252/* idx is zero-based */
6253static int thermal_get_sensor(int idx, s32 *value)
6254{
6255 int t;
6256 s8 tmp;
6257 char tmpi[5];
6258
6259 t = TP_EC_THERMAL_TMP0;
6260
6261 switch (thermal_read_mode) {
6262#if TPACPI_MAX_THERMAL_SENSORS >= 16
6263 case TPACPI_THERMAL_TPEC_16:
6264 if (idx >= 8 && idx <= 15) {
6265 t = TP_EC_THERMAL_TMP8;
6266 idx -= 8;
6267 }
6268#endif
6269 fallthrough;
6270 case TPACPI_THERMAL_TPEC_8:
6271 if (idx <= 7) {
6272 if (!acpi_ec_read(t + idx, &tmp))
6273 return -EIO;
6274 *value = tmp * 1000;
6275 return 0;
6276 }
6277 break;
6278
6279 case TPACPI_THERMAL_ACPI_UPDT:
6280 if (idx <= 7) {
6281 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6282 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6283 return -EIO;
6284 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6285 return -EIO;
6286 *value = (t - 2732) * 100;
6287 return 0;
6288 }
6289 break;
6290
6291 case TPACPI_THERMAL_ACPI_TMP07:
6292 if (idx <= 7) {
6293 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6294 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6295 return -EIO;
6296 if (t > 127 || t < -127)
6297 t = TP_EC_THERMAL_TMP_NA;
6298 *value = t * 1000;
6299 return 0;
6300 }
6301 break;
6302
6303 case TPACPI_THERMAL_NONE:
6304 default:
6305 return -ENOSYS;
6306 }
6307
6308 return -EINVAL;
6309}
6310
6311static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6312{
6313 int res, i;
6314 int n;
6315
6316 n = 8;
6317 i = 0;
6318
6319 if (!s)
6320 return -EINVAL;
6321
6322 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6323 n = 16;
6324
6325 for (i = 0 ; i < n; i++) {
6326 res = thermal_get_sensor(i, &s->temp[i]);
6327 if (res)
6328 return res;
6329 }
6330
6331 return n;
6332}
6333
6334static void thermal_dump_all_sensors(void)
6335{
6336 int n, i;
6337 struct ibm_thermal_sensors_struct t;
6338
6339 n = thermal_get_sensors(&t);
6340 if (n <= 0)
6341 return;
6342
6343 pr_notice("temperatures (Celsius):");
6344
6345 for (i = 0; i < n; i++) {
6346 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6347 pr_cont(" %d", (int)(t.temp[i] / 1000));
6348 else
6349 pr_cont(" N/A");
6350 }
6351
6352 pr_cont("\n");
6353}
6354
6355/* sysfs temp##_input -------------------------------------------------- */
6356
6357static ssize_t thermal_temp_input_show(struct device *dev,
6358 struct device_attribute *attr,
6359 char *buf)
6360{
6361 struct sensor_device_attribute *sensor_attr =
6362 to_sensor_dev_attr(attr);
6363 int idx = sensor_attr->index;
6364 s32 value;
6365 int res;
6366
6367 res = thermal_get_sensor(idx, &value);
6368 if (res)
6369 return res;
6370 if (value == TPACPI_THERMAL_SENSOR_NA)
6371 return -ENXIO;
6372
6373 return snprintf(buf, PAGE_SIZE, "%d\n", value);
6374}
6375
6376#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6377 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6378 thermal_temp_input_show, NULL, _idxB)
6379
6380static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6381 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6382 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6383 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6384 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6385 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6386 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6387 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6388 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6389 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6390 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6391 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6392 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6393 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6394 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6395 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6396 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6397};
6398
6399#define THERMAL_ATTRS(X) \
6400 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6401
6402static struct attribute *thermal_temp_input_attr[] = {
6403 THERMAL_ATTRS(8),
6404 THERMAL_ATTRS(9),
6405 THERMAL_ATTRS(10),
6406 THERMAL_ATTRS(11),
6407 THERMAL_ATTRS(12),
6408 THERMAL_ATTRS(13),
6409 THERMAL_ATTRS(14),
6410 THERMAL_ATTRS(15),
6411 THERMAL_ATTRS(0),
6412 THERMAL_ATTRS(1),
6413 THERMAL_ATTRS(2),
6414 THERMAL_ATTRS(3),
6415 THERMAL_ATTRS(4),
6416 THERMAL_ATTRS(5),
6417 THERMAL_ATTRS(6),
6418 THERMAL_ATTRS(7),
6419 NULL
6420};
6421
6422static const struct attribute_group thermal_temp_input16_group = {
6423 .attrs = thermal_temp_input_attr
6424};
6425
6426static const struct attribute_group thermal_temp_input8_group = {
6427 .attrs = &thermal_temp_input_attr[8]
6428};
6429
6430#undef THERMAL_SENSOR_ATTR_TEMP
6431#undef THERMAL_ATTRS
6432
6433/* --------------------------------------------------------------------- */
6434
6435static int __init thermal_init(struct ibm_init_struct *iibm)
6436{
6437 u8 t, ta1, ta2;
6438 int i;
6439 int acpi_tmp7;
6440 int res;
6441
6442 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6443
6444 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6445
6446 if (thinkpad_id.ec_model) {
6447 /*
6448 * Direct EC access mode: sensors at registers
6449 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6450 * non-implemented, thermal sensors return 0x80 when
6451 * not available
6452 */
6453
6454 ta1 = ta2 = 0;
6455 for (i = 0; i < 8; i++) {
6456 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6457 ta1 |= t;
6458 } else {
6459 ta1 = 0;
6460 break;
6461 }
6462 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6463 ta2 |= t;
6464 } else {
6465 ta1 = 0;
6466 break;
6467 }
6468 }
6469 if (ta1 == 0) {
6470 /* This is sheer paranoia, but we handle it anyway */
6471 if (acpi_tmp7) {
6472 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6473 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6474 } else {
6475 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6476 thermal_read_mode = TPACPI_THERMAL_NONE;
6477 }
6478 } else {
6479 thermal_read_mode =
6480 (ta2 != 0) ?
6481 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6482 }
6483 } else if (acpi_tmp7) {
6484 if (tpacpi_is_ibm() &&
6485 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6486 /* 600e/x, 770e, 770x */
6487 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6488 } else {
6489 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6490 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6491 }
6492 } else {
6493 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6494 thermal_read_mode = TPACPI_THERMAL_NONE;
6495 }
6496
6497 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6498 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6499 thermal_read_mode);
6500
6501 switch (thermal_read_mode) {
6502 case TPACPI_THERMAL_TPEC_16:
6503 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6504 &thermal_temp_input16_group);
6505 if (res)
6506 return res;
6507 break;
6508 case TPACPI_THERMAL_TPEC_8:
6509 case TPACPI_THERMAL_ACPI_TMP07:
6510 case TPACPI_THERMAL_ACPI_UPDT:
6511 res = sysfs_create_group(&tpacpi_hwmon->kobj,
6512 &thermal_temp_input8_group);
6513 if (res)
6514 return res;
6515 break;
6516 case TPACPI_THERMAL_NONE:
6517 default:
6518 return 1;
6519 }
6520
6521 return 0;
6522}
6523
6524static void thermal_exit(void)
6525{
6526 switch (thermal_read_mode) {
6527 case TPACPI_THERMAL_TPEC_16:
6528 sysfs_remove_group(&tpacpi_hwmon->kobj,
6529 &thermal_temp_input16_group);
6530 break;
6531 case TPACPI_THERMAL_TPEC_8:
6532 case TPACPI_THERMAL_ACPI_TMP07:
6533 case TPACPI_THERMAL_ACPI_UPDT:
6534 sysfs_remove_group(&tpacpi_hwmon->kobj,
6535 &thermal_temp_input8_group);
6536 break;
6537 case TPACPI_THERMAL_NONE:
6538 default:
6539 break;
6540 }
6541}
6542
6543static int thermal_read(struct seq_file *m)
6544{
6545 int n, i;
6546 struct ibm_thermal_sensors_struct t;
6547
6548 n = thermal_get_sensors(&t);
6549 if (unlikely(n < 0))
6550 return n;
6551
6552 seq_printf(m, "temperatures:\t");
6553
6554 if (n > 0) {
6555 for (i = 0; i < (n - 1); i++)
6556 seq_printf(m, "%d ", t.temp[i] / 1000);
6557 seq_printf(m, "%d\n", t.temp[i] / 1000);
6558 } else
6559 seq_printf(m, "not supported\n");
6560
6561 return 0;
6562}
6563
6564static struct ibm_struct thermal_driver_data = {
6565 .name = "thermal",
6566 .read = thermal_read,
6567 .exit = thermal_exit,
6568};
6569
6570/*************************************************************************
6571 * Backlight/brightness subdriver
6572 */
6573
6574#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6575
6576/*
6577 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6578 * CMOS NVRAM byte 0x5E, bits 0-3.
6579 *
6580 * EC HBRV (0x31) has the following layout
6581 * Bit 7: unknown function
6582 * Bit 6: unknown function
6583 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6584 * Bit 4: must be set to zero to avoid problems
6585 * Bit 3-0: backlight brightness level
6586 *
6587 * brightness_get_raw returns status data in the HBRV layout
6588 *
6589 * WARNING: The X61 has been verified to use HBRV for something else, so
6590 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6591 * testing on the very early *60 Lenovo models...
6592 */
6593
6594enum {
6595 TP_EC_BACKLIGHT = 0x31,
6596
6597 /* TP_EC_BACKLIGHT bitmasks */
6598 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6599 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6600 TP_EC_BACKLIGHT_MAPSW = 0x20,
6601};
6602
6603enum tpacpi_brightness_access_mode {
6604 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6605 TPACPI_BRGHT_MODE_EC, /* EC control */
6606 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6607 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6608 TPACPI_BRGHT_MODE_MAX
6609};
6610
6611static struct backlight_device *ibm_backlight_device;
6612
6613static enum tpacpi_brightness_access_mode brightness_mode =
6614 TPACPI_BRGHT_MODE_MAX;
6615
6616static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6617
6618static struct mutex brightness_mutex;
6619
6620/* NVRAM brightness access,
6621 * call with brightness_mutex held! */
6622static unsigned int tpacpi_brightness_nvram_get(void)
6623{
6624 u8 lnvram;
6625
6626 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6627 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6628 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6629 lnvram &= bright_maxlvl;
6630
6631 return lnvram;
6632}
6633
6634static void tpacpi_brightness_checkpoint_nvram(void)
6635{
6636 u8 lec = 0;
6637 u8 b_nvram;
6638
6639 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6640 return;
6641
6642 vdbg_printk(TPACPI_DBG_BRGHT,
6643 "trying to checkpoint backlight level to NVRAM...\n");
6644
6645 if (mutex_lock_killable(&brightness_mutex) < 0)
6646 return;
6647
6648 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6649 goto unlock;
6650 lec &= TP_EC_BACKLIGHT_LVLMSK;
6651 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6652
6653 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6654 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6655 /* NVRAM needs update */
6656 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6657 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6658 b_nvram |= lec;
6659 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6660 dbg_printk(TPACPI_DBG_BRGHT,
6661 "updated NVRAM backlight level to %u (0x%02x)\n",
6662 (unsigned int) lec, (unsigned int) b_nvram);
6663 } else
6664 vdbg_printk(TPACPI_DBG_BRGHT,
6665 "NVRAM backlight level already is %u (0x%02x)\n",
6666 (unsigned int) lec, (unsigned int) b_nvram);
6667
6668unlock:
6669 mutex_unlock(&brightness_mutex);
6670}
6671
6672
6673/* call with brightness_mutex held! */
6674static int tpacpi_brightness_get_raw(int *status)
6675{
6676 u8 lec = 0;
6677
6678 switch (brightness_mode) {
6679 case TPACPI_BRGHT_MODE_UCMS_STEP:
6680 *status = tpacpi_brightness_nvram_get();
6681 return 0;
6682 case TPACPI_BRGHT_MODE_EC:
6683 case TPACPI_BRGHT_MODE_ECNVRAM:
6684 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6685 return -EIO;
6686 *status = lec;
6687 return 0;
6688 default:
6689 return -ENXIO;
6690 }
6691}
6692
6693/* call with brightness_mutex held! */
6694/* do NOT call with illegal backlight level value */
6695static int tpacpi_brightness_set_ec(unsigned int value)
6696{
6697 u8 lec = 0;
6698
6699 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6700 return -EIO;
6701
6702 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6703 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6704 (value & TP_EC_BACKLIGHT_LVLMSK))))
6705 return -EIO;
6706
6707 return 0;
6708}
6709
6710/* call with brightness_mutex held! */
6711static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6712{
6713 int cmos_cmd, inc;
6714 unsigned int current_value, i;
6715
6716 current_value = tpacpi_brightness_nvram_get();
6717
6718 if (value == current_value)
6719 return 0;
6720
6721 cmos_cmd = (value > current_value) ?
6722 TP_CMOS_BRIGHTNESS_UP :
6723 TP_CMOS_BRIGHTNESS_DOWN;
6724 inc = (value > current_value) ? 1 : -1;
6725
6726 for (i = current_value; i != value; i += inc)
6727 if (issue_thinkpad_cmos_command(cmos_cmd))
6728 return -EIO;
6729
6730 return 0;
6731}
6732
6733/* May return EINTR which can always be mapped to ERESTARTSYS */
6734static int brightness_set(unsigned int value)
6735{
6736 int res;
6737
6738 if (value > bright_maxlvl)
6739 return -EINVAL;
6740
6741 vdbg_printk(TPACPI_DBG_BRGHT,
6742 "set backlight level to %d\n", value);
6743
6744 res = mutex_lock_killable(&brightness_mutex);
6745 if (res < 0)
6746 return res;
6747
6748 switch (brightness_mode) {
6749 case TPACPI_BRGHT_MODE_EC:
6750 case TPACPI_BRGHT_MODE_ECNVRAM:
6751 res = tpacpi_brightness_set_ec(value);
6752 break;
6753 case TPACPI_BRGHT_MODE_UCMS_STEP:
6754 res = tpacpi_brightness_set_ucmsstep(value);
6755 break;
6756 default:
6757 res = -ENXIO;
6758 }
6759
6760 mutex_unlock(&brightness_mutex);
6761 return res;
6762}
6763
6764/* sysfs backlight class ----------------------------------------------- */
6765
6766static int brightness_update_status(struct backlight_device *bd)
6767{
6768 unsigned int level =
6769 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6770 bd->props.power == FB_BLANK_UNBLANK) ?
6771 bd->props.brightness : 0;
6772
6773 dbg_printk(TPACPI_DBG_BRGHT,
6774 "backlight: attempt to set level to %d\n",
6775 level);
6776
6777 /* it is the backlight class's job (caller) to handle
6778 * EINTR and other errors properly */
6779 return brightness_set(level);
6780}
6781
6782static int brightness_get(struct backlight_device *bd)
6783{
6784 int status, res;
6785
6786 res = mutex_lock_killable(&brightness_mutex);
6787 if (res < 0)
6788 return 0;
6789
6790 res = tpacpi_brightness_get_raw(&status);
6791
6792 mutex_unlock(&brightness_mutex);
6793
6794 if (res < 0)
6795 return 0;
6796
6797 return status & TP_EC_BACKLIGHT_LVLMSK;
6798}
6799
6800static void tpacpi_brightness_notify_change(void)
6801{
6802 backlight_force_update(ibm_backlight_device,
6803 BACKLIGHT_UPDATE_HOTKEY);
6804}
6805
6806static const struct backlight_ops ibm_backlight_data = {
6807 .get_brightness = brightness_get,
6808 .update_status = brightness_update_status,
6809};
6810
6811/* --------------------------------------------------------------------- */
6812
6813/*
6814 * Call _BCL method of video device. On some ThinkPads this will
6815 * switch the firmware to the ACPI brightness control mode.
6816 */
6817
6818static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6819{
6820 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6821 union acpi_object *obj;
6822 struct acpi_device *device, *child;
6823 int rc;
6824
6825 if (acpi_bus_get_device(handle, &device))
6826 return 0;
6827
6828 rc = 0;
6829 list_for_each_entry(child, &device->children, node) {
6830 acpi_status status = acpi_evaluate_object(child->handle, "_BCL",
6831 NULL, &buffer);
6832 if (ACPI_FAILURE(status)) {
6833 buffer.length = ACPI_ALLOCATE_BUFFER;
6834 continue;
6835 }
6836
6837 obj = (union acpi_object *)buffer.pointer;
6838 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
6839 pr_err("Unknown _BCL data, please report this to %s\n",
6840 TPACPI_MAIL);
6841 rc = 0;
6842 } else {
6843 rc = obj->package.count;
6844 }
6845 break;
6846 }
6847
6848 kfree(buffer.pointer);
6849 return rc;
6850}
6851
6852
6853/*
6854 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6855 */
6856static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6857{
6858 acpi_handle video_device;
6859 int bcl_levels = 0;
6860
6861 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6862 if (video_device)
6863 bcl_levels = tpacpi_query_bcl_levels(video_device);
6864
6865 tp_features.bright_acpimode = (bcl_levels > 0);
6866
6867 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6868}
6869
6870/*
6871 * These are only useful for models that have only one possibility
6872 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6873 * these quirks.
6874 */
6875#define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6876#define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6877#define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6878
6879static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6880 /* Models with ATI GPUs known to require ECNVRAM mode */
6881 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6882
6883 /* Models with ATI GPUs that can use ECNVRAM */
6884 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6885 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6886 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6887 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6888
6889 /* Models with Intel Extreme Graphics 2 */
6890 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6891 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6892 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6893
6894 /* Models with Intel GMA900 */
6895 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6896 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6897 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6898};
6899
6900/*
6901 * Returns < 0 for error, otherwise sets tp_features.bright_*
6902 * and bright_maxlvl.
6903 */
6904static void __init tpacpi_detect_brightness_capabilities(void)
6905{
6906 unsigned int b;
6907
6908 vdbg_printk(TPACPI_DBG_INIT,
6909 "detecting firmware brightness interface capabilities\n");
6910
6911 /* we could run a quirks check here (same table used by
6912 * brightness_init) if needed */
6913
6914 /*
6915 * We always attempt to detect acpi support, so as to switch
6916 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6917 * going to publish a backlight interface
6918 */
6919 b = tpacpi_check_std_acpi_brightness_support();
6920 switch (b) {
6921 case 16:
6922 bright_maxlvl = 15;
6923 break;
6924 case 8:
6925 case 0:
6926 bright_maxlvl = 7;
6927 break;
6928 default:
6929 tp_features.bright_unkfw = 1;
6930 bright_maxlvl = b - 1;
6931 }
6932 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6933}
6934
6935static int __init brightness_init(struct ibm_init_struct *iibm)
6936{
6937 struct backlight_properties props;
6938 int b;
6939 unsigned long quirks;
6940
6941 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6942
6943 mutex_init(&brightness_mutex);
6944
6945 quirks = tpacpi_check_quirks(brightness_quirk_table,
6946 ARRAY_SIZE(brightness_quirk_table));
6947
6948 /* tpacpi_detect_brightness_capabilities() must have run already */
6949
6950 /* if it is unknown, we don't handle it: it wouldn't be safe */
6951 if (tp_features.bright_unkfw)
6952 return 1;
6953
6954 if (!brightness_enable) {
6955 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6956 "brightness support disabled by module parameter\n");
6957 return 1;
6958 }
6959
6960 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6961 if (brightness_enable > 1) {
6962 pr_info("Standard ACPI backlight interface available, not loading native one\n");
6963 return 1;
6964 } else if (brightness_enable == 1) {
6965 pr_warn("Cannot enable backlight brightness support, ACPI is already handling it. Refer to the acpi_backlight kernel parameter.\n");
6966 return 1;
6967 }
6968 } else if (!tp_features.bright_acpimode) {
6969 pr_notice("ACPI backlight interface not available\n");
6970 return 1;
6971 }
6972
6973 pr_notice("ACPI native brightness control enabled\n");
6974
6975 /*
6976 * Check for module parameter bogosity, note that we
6977 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6978 * able to detect "unspecified"
6979 */
6980 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6981 return -EINVAL;
6982
6983 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6984 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6985 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6986 if (quirks & TPACPI_BRGHT_Q_EC)
6987 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6988 else
6989 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6990
6991 dbg_printk(TPACPI_DBG_BRGHT,
6992 "driver auto-selected brightness_mode=%d\n",
6993 brightness_mode);
6994 }
6995
6996 /* Safety */
6997 if (!tpacpi_is_ibm() &&
6998 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6999 brightness_mode == TPACPI_BRGHT_MODE_EC))
7000 return -EINVAL;
7001
7002 if (tpacpi_brightness_get_raw(&b) < 0)
7003 return 1;
7004
7005 memset(&props, 0, sizeof(struct backlight_properties));
7006 props.type = BACKLIGHT_PLATFORM;
7007 props.max_brightness = bright_maxlvl;
7008 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
7009 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
7010 NULL, NULL,
7011 &ibm_backlight_data,
7012 &props);
7013 if (IS_ERR(ibm_backlight_device)) {
7014 int rc = PTR_ERR(ibm_backlight_device);
7015 ibm_backlight_device = NULL;
7016 pr_err("Could not register backlight device\n");
7017 return rc;
7018 }
7019 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7020 "brightness is supported\n");
7021
7022 if (quirks & TPACPI_BRGHT_Q_ASK) {
7023 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
7024 brightness_mode);
7025 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
7026 TPACPI_MAIL);
7027 }
7028
7029 /* Added by mistake in early 2007. Probably useless, but it could
7030 * be working around some unknown firmware problem where the value
7031 * read at startup doesn't match the real hardware state... so leave
7032 * it in place just in case */
7033 backlight_update_status(ibm_backlight_device);
7034
7035 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7036 "brightness: registering brightness hotkeys as change notification\n");
7037 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7038 | TP_ACPI_HKEY_BRGHTUP_MASK
7039 | TP_ACPI_HKEY_BRGHTDWN_MASK);
7040 return 0;
7041}
7042
7043static void brightness_suspend(void)
7044{
7045 tpacpi_brightness_checkpoint_nvram();
7046}
7047
7048static void brightness_shutdown(void)
7049{
7050 tpacpi_brightness_checkpoint_nvram();
7051}
7052
7053static void brightness_exit(void)
7054{
7055 if (ibm_backlight_device) {
7056 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7057 "calling backlight_device_unregister()\n");
7058 backlight_device_unregister(ibm_backlight_device);
7059 }
7060
7061 tpacpi_brightness_checkpoint_nvram();
7062}
7063
7064static int brightness_read(struct seq_file *m)
7065{
7066 int level;
7067
7068 level = brightness_get(NULL);
7069 if (level < 0) {
7070 seq_printf(m, "level:\t\tunreadable\n");
7071 } else {
7072 seq_printf(m, "level:\t\t%d\n", level);
7073 seq_printf(m, "commands:\tup, down\n");
7074 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7075 bright_maxlvl);
7076 }
7077
7078 return 0;
7079}
7080
7081static int brightness_write(char *buf)
7082{
7083 int level;
7084 int rc;
7085 char *cmd;
7086
7087 level = brightness_get(NULL);
7088 if (level < 0)
7089 return level;
7090
7091 while ((cmd = strsep(&buf, ","))) {
7092 if (strlencmp(cmd, "up") == 0) {
7093 if (level < bright_maxlvl)
7094 level++;
7095 } else if (strlencmp(cmd, "down") == 0) {
7096 if (level > 0)
7097 level--;
7098 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7099 level >= 0 && level <= bright_maxlvl) {
7100 /* new level set */
7101 } else
7102 return -EINVAL;
7103 }
7104
7105 tpacpi_disclose_usertask("procfs brightness",
7106 "set level to %d\n", level);
7107
7108 /*
7109 * Now we know what the final level should be, so we try to set it.
7110 * Doing it this way makes the syscall restartable in case of EINTR
7111 */
7112 rc = brightness_set(level);
7113 if (!rc && ibm_backlight_device)
7114 backlight_force_update(ibm_backlight_device,
7115 BACKLIGHT_UPDATE_SYSFS);
7116 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7117}
7118
7119static struct ibm_struct brightness_driver_data = {
7120 .name = "brightness",
7121 .read = brightness_read,
7122 .write = brightness_write,
7123 .exit = brightness_exit,
7124 .suspend = brightness_suspend,
7125 .shutdown = brightness_shutdown,
7126};
7127
7128/*************************************************************************
7129 * Volume subdriver
7130 */
7131
7132/*
7133 * IBM ThinkPads have a simple volume controller with MUTE gating.
7134 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7135 *
7136 * Since the *61 series (and probably also the later *60 series), Lenovo
7137 * ThinkPads only implement the MUTE gate.
7138 *
7139 * EC register 0x30
7140 * Bit 6: MUTE (1 mutes sound)
7141 * Bit 3-0: Volume
7142 * Other bits should be zero as far as we know.
7143 *
7144 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7145 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
7146 * such as bit 7 which is used to detect repeated presses of MUTE,
7147 * and we leave them unchanged.
7148 *
7149 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7150 * in response to user input. Unfortunately, this rarely works well.
7151 * The laptop changes the state of its internal MUTE gate and, on some
7152 * models, sends KEY_MUTE, causing any user code that responds to the
7153 * mute button to get confused. The hardware MUTE gate is also
7154 * unnecessary, since user code can handle the mute button without
7155 * kernel or EC help.
7156 *
7157 * To avoid confusing userspace, we simply disable all EC-based mute
7158 * and volume controls when possible.
7159 */
7160
7161#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7162
7163#define TPACPI_ALSA_DRVNAME "ThinkPad EC"
7164#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7165#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7166
7167#if SNDRV_CARDS <= 32
7168#define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
7169#else
7170#define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
7171#endif
7172static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7173static char *alsa_id = "ThinkPadEC";
7174static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7175
7176struct tpacpi_alsa_data {
7177 struct snd_card *card;
7178 struct snd_ctl_elem_id *ctl_mute_id;
7179 struct snd_ctl_elem_id *ctl_vol_id;
7180};
7181
7182static struct snd_card *alsa_card;
7183
7184enum {
7185 TP_EC_AUDIO = 0x30,
7186
7187 /* TP_EC_AUDIO bits */
7188 TP_EC_AUDIO_MUTESW = 6,
7189
7190 /* TP_EC_AUDIO bitmasks */
7191 TP_EC_AUDIO_LVL_MSK = 0x0F,
7192 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7193
7194 /* Maximum volume */
7195 TP_EC_VOLUME_MAX = 14,
7196};
7197
7198enum tpacpi_volume_access_mode {
7199 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
7200 TPACPI_VOL_MODE_EC, /* Pure EC control */
7201 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
7202 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
7203 TPACPI_VOL_MODE_MAX
7204};
7205
7206enum tpacpi_volume_capabilities {
7207 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
7208 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
7209 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
7210 TPACPI_VOL_CAP_MAX
7211};
7212
7213enum tpacpi_mute_btn_mode {
7214 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
7215 /* We don't know what mode 1 is. */
7216 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
7217 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
7218};
7219
7220static enum tpacpi_volume_access_mode volume_mode =
7221 TPACPI_VOL_MODE_MAX;
7222
7223static enum tpacpi_volume_capabilities volume_capabilities;
7224static bool volume_control_allowed;
7225static bool software_mute_requested = true;
7226static bool software_mute_active;
7227static int software_mute_orig_mode;
7228
7229/*
7230 * Used to syncronize writers to TP_EC_AUDIO and
7231 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7232 */
7233static struct mutex volume_mutex;
7234
7235static void tpacpi_volume_checkpoint_nvram(void)
7236{
7237 u8 lec = 0;
7238 u8 b_nvram;
7239 u8 ec_mask;
7240
7241 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7242 return;
7243 if (!volume_control_allowed)
7244 return;
7245 if (software_mute_active)
7246 return;
7247
7248 vdbg_printk(TPACPI_DBG_MIXER,
7249 "trying to checkpoint mixer state to NVRAM...\n");
7250
7251 if (tp_features.mixer_no_level_control)
7252 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7253 else
7254 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7255
7256 if (mutex_lock_killable(&volume_mutex) < 0)
7257 return;
7258
7259 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7260 goto unlock;
7261 lec &= ec_mask;
7262 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7263
7264 if (lec != (b_nvram & ec_mask)) {
7265 /* NVRAM needs update */
7266 b_nvram &= ~ec_mask;
7267 b_nvram |= lec;
7268 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7269 dbg_printk(TPACPI_DBG_MIXER,
7270 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7271 (unsigned int) lec, (unsigned int) b_nvram);
7272 } else {
7273 vdbg_printk(TPACPI_DBG_MIXER,
7274 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7275 (unsigned int) lec, (unsigned int) b_nvram);
7276 }
7277
7278unlock:
7279 mutex_unlock(&volume_mutex);
7280}
7281
7282static int volume_get_status_ec(u8 *status)
7283{
7284 u8 s;
7285
7286 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7287 return -EIO;
7288
7289 *status = s;
7290
7291 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7292
7293 return 0;
7294}
7295
7296static int volume_get_status(u8 *status)
7297{
7298 return volume_get_status_ec(status);
7299}
7300
7301static int volume_set_status_ec(const u8 status)
7302{
7303 if (!acpi_ec_write(TP_EC_AUDIO, status))
7304 return -EIO;
7305
7306 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7307
7308 /*
7309 * On X200s, and possibly on others, it can take a while for
7310 * reads to become correct.
7311 */
7312 msleep(1);
7313
7314 return 0;
7315}
7316
7317static int volume_set_status(const u8 status)
7318{
7319 return volume_set_status_ec(status);
7320}
7321
7322/* returns < 0 on error, 0 on no change, 1 on change */
7323static int __volume_set_mute_ec(const bool mute)
7324{
7325 int rc;
7326 u8 s, n;
7327
7328 if (mutex_lock_killable(&volume_mutex) < 0)
7329 return -EINTR;
7330
7331 rc = volume_get_status_ec(&s);
7332 if (rc)
7333 goto unlock;
7334
7335 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7336 s & ~TP_EC_AUDIO_MUTESW_MSK;
7337
7338 if (n != s) {
7339 rc = volume_set_status_ec(n);
7340 if (!rc)
7341 rc = 1;
7342 }
7343
7344unlock:
7345 mutex_unlock(&volume_mutex);
7346 return rc;
7347}
7348
7349static int volume_alsa_set_mute(const bool mute)
7350{
7351 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7352 (mute) ? "" : "un");
7353 return __volume_set_mute_ec(mute);
7354}
7355
7356static int volume_set_mute(const bool mute)
7357{
7358 int rc;
7359
7360 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7361 (mute) ? "" : "un");
7362
7363 rc = __volume_set_mute_ec(mute);
7364 return (rc < 0) ? rc : 0;
7365}
7366
7367/* returns < 0 on error, 0 on no change, 1 on change */
7368static int __volume_set_volume_ec(const u8 vol)
7369{
7370 int rc;
7371 u8 s, n;
7372
7373 if (vol > TP_EC_VOLUME_MAX)
7374 return -EINVAL;
7375
7376 if (mutex_lock_killable(&volume_mutex) < 0)
7377 return -EINTR;
7378
7379 rc = volume_get_status_ec(&s);
7380 if (rc)
7381 goto unlock;
7382
7383 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7384
7385 if (n != s) {
7386 rc = volume_set_status_ec(n);
7387 if (!rc)
7388 rc = 1;
7389 }
7390
7391unlock:
7392 mutex_unlock(&volume_mutex);
7393 return rc;
7394}
7395
7396static int volume_set_software_mute(bool startup)
7397{
7398 int result;
7399
7400 if (!tpacpi_is_lenovo())
7401 return -ENODEV;
7402
7403 if (startup) {
7404 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7405 "HAUM", "qd"))
7406 return -EIO;
7407
7408 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7409 "Initial HAUM setting was %d\n",
7410 software_mute_orig_mode);
7411 }
7412
7413 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7414 (int)TP_EC_MUTE_BTN_NONE))
7415 return -EIO;
7416
7417 if (result != TP_EC_MUTE_BTN_NONE)
7418 pr_warn("Unexpected SAUM result %d\n",
7419 result);
7420
7421 /*
7422 * In software mute mode, the standard codec controls take
7423 * precendence, so we unmute the ThinkPad HW switch at
7424 * startup. Just on case there are SAUM-capable ThinkPads
7425 * with level controls, set max HW volume as well.
7426 */
7427 if (tp_features.mixer_no_level_control)
7428 result = volume_set_mute(false);
7429 else
7430 result = volume_set_status(TP_EC_VOLUME_MAX);
7431
7432 if (result != 0)
7433 pr_warn("Failed to unmute the HW mute switch\n");
7434
7435 return 0;
7436}
7437
7438static void volume_exit_software_mute(void)
7439{
7440 int r;
7441
7442 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7443 || r != software_mute_orig_mode)
7444 pr_warn("Failed to restore mute mode\n");
7445}
7446
7447static int volume_alsa_set_volume(const u8 vol)
7448{
7449 dbg_printk(TPACPI_DBG_MIXER,
7450 "ALSA: trying to set volume level to %hu\n", vol);
7451 return __volume_set_volume_ec(vol);
7452}
7453
7454static void volume_alsa_notify_change(void)
7455{
7456 struct tpacpi_alsa_data *d;
7457
7458 if (alsa_card && alsa_card->private_data) {
7459 d = alsa_card->private_data;
7460 if (d->ctl_mute_id)
7461 snd_ctl_notify(alsa_card,
7462 SNDRV_CTL_EVENT_MASK_VALUE,
7463 d->ctl_mute_id);
7464 if (d->ctl_vol_id)
7465 snd_ctl_notify(alsa_card,
7466 SNDRV_CTL_EVENT_MASK_VALUE,
7467 d->ctl_vol_id);
7468 }
7469}
7470
7471static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7472 struct snd_ctl_elem_info *uinfo)
7473{
7474 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7475 uinfo->count = 1;
7476 uinfo->value.integer.min = 0;
7477 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7478 return 0;
7479}
7480
7481static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7482 struct snd_ctl_elem_value *ucontrol)
7483{
7484 u8 s;
7485 int rc;
7486
7487 rc = volume_get_status(&s);
7488 if (rc < 0)
7489 return rc;
7490
7491 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7492 return 0;
7493}
7494
7495static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7496 struct snd_ctl_elem_value *ucontrol)
7497{
7498 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7499 ucontrol->value.integer.value[0]);
7500 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7501}
7502
7503#define volume_alsa_mute_info snd_ctl_boolean_mono_info
7504
7505static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7506 struct snd_ctl_elem_value *ucontrol)
7507{
7508 u8 s;
7509 int rc;
7510
7511 rc = volume_get_status(&s);
7512 if (rc < 0)
7513 return rc;
7514
7515 ucontrol->value.integer.value[0] =
7516 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7517 return 0;
7518}
7519
7520static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7521 struct snd_ctl_elem_value *ucontrol)
7522{
7523 tpacpi_disclose_usertask("ALSA", "%smute\n",
7524 ucontrol->value.integer.value[0] ?
7525 "un" : "");
7526 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7527}
7528
7529static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7530 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7531 .name = "Console Playback Volume",
7532 .index = 0,
7533 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7534 .info = volume_alsa_vol_info,
7535 .get = volume_alsa_vol_get,
7536};
7537
7538static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7539 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7540 .name = "Console Playback Switch",
7541 .index = 0,
7542 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7543 .info = volume_alsa_mute_info,
7544 .get = volume_alsa_mute_get,
7545};
7546
7547static void volume_suspend(void)
7548{
7549 tpacpi_volume_checkpoint_nvram();
7550}
7551
7552static void volume_resume(void)
7553{
7554 if (software_mute_active) {
7555 if (volume_set_software_mute(false) < 0)
7556 pr_warn("Failed to restore software mute\n");
7557 } else {
7558 volume_alsa_notify_change();
7559 }
7560}
7561
7562static void volume_shutdown(void)
7563{
7564 tpacpi_volume_checkpoint_nvram();
7565}
7566
7567static void volume_exit(void)
7568{
7569 if (alsa_card) {
7570 snd_card_free(alsa_card);
7571 alsa_card = NULL;
7572 }
7573
7574 tpacpi_volume_checkpoint_nvram();
7575
7576 if (software_mute_active)
7577 volume_exit_software_mute();
7578}
7579
7580static int __init volume_create_alsa_mixer(void)
7581{
7582 struct snd_card *card;
7583 struct tpacpi_alsa_data *data;
7584 struct snd_kcontrol *ctl_vol;
7585 struct snd_kcontrol *ctl_mute;
7586 int rc;
7587
7588 rc = snd_card_new(&tpacpi_pdev->dev,
7589 alsa_index, alsa_id, THIS_MODULE,
7590 sizeof(struct tpacpi_alsa_data), &card);
7591 if (rc < 0 || !card) {
7592 pr_err("Failed to create ALSA card structures: %d\n", rc);
7593 return 1;
7594 }
7595
7596 BUG_ON(!card->private_data);
7597 data = card->private_data;
7598 data->card = card;
7599
7600 strlcpy(card->driver, TPACPI_ALSA_DRVNAME,
7601 sizeof(card->driver));
7602 strlcpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7603 sizeof(card->shortname));
7604 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7605 (thinkpad_id.ec_version_str) ?
7606 thinkpad_id.ec_version_str : "(unknown)");
7607 snprintf(card->longname, sizeof(card->longname),
7608 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7609 (thinkpad_id.ec_version_str) ?
7610 thinkpad_id.ec_version_str : "unknown");
7611
7612 if (volume_control_allowed) {
7613 volume_alsa_control_vol.put = volume_alsa_vol_put;
7614 volume_alsa_control_vol.access =
7615 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7616
7617 volume_alsa_control_mute.put = volume_alsa_mute_put;
7618 volume_alsa_control_mute.access =
7619 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7620 }
7621
7622 if (!tp_features.mixer_no_level_control) {
7623 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7624 rc = snd_ctl_add(card, ctl_vol);
7625 if (rc < 0) {
7626 pr_err("Failed to create ALSA volume control: %d\n",
7627 rc);
7628 goto err_exit;
7629 }
7630 data->ctl_vol_id = &ctl_vol->id;
7631 }
7632
7633 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7634 rc = snd_ctl_add(card, ctl_mute);
7635 if (rc < 0) {
7636 pr_err("Failed to create ALSA mute control: %d\n", rc);
7637 goto err_exit;
7638 }
7639 data->ctl_mute_id = &ctl_mute->id;
7640
7641 rc = snd_card_register(card);
7642 if (rc < 0) {
7643 pr_err("Failed to register ALSA card: %d\n", rc);
7644 goto err_exit;
7645 }
7646
7647 alsa_card = card;
7648 return 0;
7649
7650err_exit:
7651 snd_card_free(card);
7652 return 1;
7653}
7654
7655#define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7656#define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7657
7658static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7659 /* Whitelist volume level on all IBM by default */
7660 { .vendor = PCI_VENDOR_ID_IBM,
7661 .bios = TPACPI_MATCH_ANY,
7662 .ec = TPACPI_MATCH_ANY,
7663 .quirks = TPACPI_VOL_Q_LEVEL },
7664
7665 /* Lenovo models with volume control (needs confirmation) */
7666 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7667 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7668 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7669 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7670 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7671 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7672 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7673
7674 /* Whitelist mute-only on all Lenovo by default */
7675 { .vendor = PCI_VENDOR_ID_LENOVO,
7676 .bios = TPACPI_MATCH_ANY,
7677 .ec = TPACPI_MATCH_ANY,
7678 .quirks = TPACPI_VOL_Q_MUTEONLY }
7679};
7680
7681static int __init volume_init(struct ibm_init_struct *iibm)
7682{
7683 unsigned long quirks;
7684 int rc;
7685
7686 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7687
7688 mutex_init(&volume_mutex);
7689
7690 /*
7691 * Check for module parameter bogosity, note that we
7692 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7693 * able to detect "unspecified"
7694 */
7695 if (volume_mode > TPACPI_VOL_MODE_MAX)
7696 return -EINVAL;
7697
7698 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7699 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7700 TPACPI_MAIL);
7701 return 1;
7702 }
7703
7704 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7705 return -EINVAL;
7706
7707 /*
7708 * The ALSA mixer is our primary interface.
7709 * When disabled, don't install the subdriver at all
7710 */
7711 if (!alsa_enable) {
7712 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7713 "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7714 return 1;
7715 }
7716
7717 quirks = tpacpi_check_quirks(volume_quirk_table,
7718 ARRAY_SIZE(volume_quirk_table));
7719
7720 switch (volume_capabilities) {
7721 case TPACPI_VOL_CAP_AUTO:
7722 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7723 tp_features.mixer_no_level_control = 1;
7724 else if (quirks & TPACPI_VOL_Q_LEVEL)
7725 tp_features.mixer_no_level_control = 0;
7726 else
7727 return 1; /* no mixer */
7728 break;
7729 case TPACPI_VOL_CAP_VOLMUTE:
7730 tp_features.mixer_no_level_control = 0;
7731 break;
7732 case TPACPI_VOL_CAP_MUTEONLY:
7733 tp_features.mixer_no_level_control = 1;
7734 break;
7735 default:
7736 return 1;
7737 }
7738
7739 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7740 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7741 "using user-supplied volume_capabilities=%d\n",
7742 volume_capabilities);
7743
7744 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7745 volume_mode == TPACPI_VOL_MODE_MAX) {
7746 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7747
7748 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7749 "driver auto-selected volume_mode=%d\n",
7750 volume_mode);
7751 } else {
7752 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7753 "using user-supplied volume_mode=%d\n",
7754 volume_mode);
7755 }
7756
7757 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7758 "mute is supported, volume control is %s\n",
7759 str_supported(!tp_features.mixer_no_level_control));
7760
7761 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7762 software_mute_active = true;
7763 } else {
7764 rc = volume_create_alsa_mixer();
7765 if (rc) {
7766 pr_err("Could not create the ALSA mixer interface\n");
7767 return rc;
7768 }
7769
7770 pr_info("Console audio control enabled, mode: %s\n",
7771 (volume_control_allowed) ?
7772 "override (read/write)" :
7773 "monitor (read only)");
7774 }
7775
7776 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7777 "registering volume hotkeys as change notification\n");
7778 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7779 | TP_ACPI_HKEY_VOLUP_MASK
7780 | TP_ACPI_HKEY_VOLDWN_MASK
7781 | TP_ACPI_HKEY_MUTE_MASK);
7782
7783 return 0;
7784}
7785
7786static int volume_read(struct seq_file *m)
7787{
7788 u8 status;
7789
7790 if (volume_get_status(&status) < 0) {
7791 seq_printf(m, "level:\t\tunreadable\n");
7792 } else {
7793 if (tp_features.mixer_no_level_control)
7794 seq_printf(m, "level:\t\tunsupported\n");
7795 else
7796 seq_printf(m, "level:\t\t%d\n",
7797 status & TP_EC_AUDIO_LVL_MSK);
7798
7799 seq_printf(m, "mute:\t\t%s\n",
7800 onoff(status, TP_EC_AUDIO_MUTESW));
7801
7802 if (volume_control_allowed) {
7803 seq_printf(m, "commands:\tunmute, mute\n");
7804 if (!tp_features.mixer_no_level_control) {
7805 seq_printf(m, "commands:\tup, down\n");
7806 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7807 TP_EC_VOLUME_MAX);
7808 }
7809 }
7810 }
7811
7812 return 0;
7813}
7814
7815static int volume_write(char *buf)
7816{
7817 u8 s;
7818 u8 new_level, new_mute;
7819 int l;
7820 char *cmd;
7821 int rc;
7822
7823 /*
7824 * We do allow volume control at driver startup, so that the
7825 * user can set initial state through the volume=... parameter hack.
7826 */
7827 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7828 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7829 tp_warned.volume_ctrl_forbidden = 1;
7830 pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7831 pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7832 }
7833 return -EPERM;
7834 }
7835
7836 rc = volume_get_status(&s);
7837 if (rc < 0)
7838 return rc;
7839
7840 new_level = s & TP_EC_AUDIO_LVL_MSK;
7841 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7842
7843 while ((cmd = strsep(&buf, ","))) {
7844 if (!tp_features.mixer_no_level_control) {
7845 if (strlencmp(cmd, "up") == 0) {
7846 if (new_mute)
7847 new_mute = 0;
7848 else if (new_level < TP_EC_VOLUME_MAX)
7849 new_level++;
7850 continue;
7851 } else if (strlencmp(cmd, "down") == 0) {
7852 if (new_mute)
7853 new_mute = 0;
7854 else if (new_level > 0)
7855 new_level--;
7856 continue;
7857 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7858 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7859 new_level = l;
7860 continue;
7861 }
7862 }
7863 if (strlencmp(cmd, "mute") == 0)
7864 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7865 else if (strlencmp(cmd, "unmute") == 0)
7866 new_mute = 0;
7867 else
7868 return -EINVAL;
7869 }
7870
7871 if (tp_features.mixer_no_level_control) {
7872 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7873 new_mute ? "" : "un");
7874 rc = volume_set_mute(!!new_mute);
7875 } else {
7876 tpacpi_disclose_usertask("procfs volume",
7877 "%smute and set level to %d\n",
7878 new_mute ? "" : "un", new_level);
7879 rc = volume_set_status(new_mute | new_level);
7880 }
7881 volume_alsa_notify_change();
7882
7883 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7884}
7885
7886static struct ibm_struct volume_driver_data = {
7887 .name = "volume",
7888 .read = volume_read,
7889 .write = volume_write,
7890 .exit = volume_exit,
7891 .suspend = volume_suspend,
7892 .resume = volume_resume,
7893 .shutdown = volume_shutdown,
7894};
7895
7896#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7897
7898#define alsa_card NULL
7899
7900static inline void volume_alsa_notify_change(void)
7901{
7902}
7903
7904static int __init volume_init(struct ibm_init_struct *iibm)
7905{
7906 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7907
7908 return 1;
7909}
7910
7911static struct ibm_struct volume_driver_data = {
7912 .name = "volume",
7913};
7914
7915#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7916
7917/*************************************************************************
7918 * Fan subdriver
7919 */
7920
7921/*
7922 * FAN ACCESS MODES
7923 *
7924 * TPACPI_FAN_RD_ACPI_GFAN:
7925 * ACPI GFAN method: returns fan level
7926 *
7927 * see TPACPI_FAN_WR_ACPI_SFAN
7928 * EC 0x2f (HFSP) not available if GFAN exists
7929 *
7930 * TPACPI_FAN_WR_ACPI_SFAN:
7931 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7932 *
7933 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7934 * it for writing.
7935 *
7936 * TPACPI_FAN_WR_TPEC:
7937 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7938 * Supported on almost all ThinkPads
7939 *
7940 * Fan speed changes of any sort (including those caused by the
7941 * disengaged mode) are usually done slowly by the firmware as the
7942 * maximum amount of fan duty cycle change per second seems to be
7943 * limited.
7944 *
7945 * Reading is not available if GFAN exists.
7946 * Writing is not available if SFAN exists.
7947 *
7948 * Bits
7949 * 7 automatic mode engaged;
7950 * (default operation mode of the ThinkPad)
7951 * fan level is ignored in this mode.
7952 * 6 full speed mode (takes precedence over bit 7);
7953 * not available on all thinkpads. May disable
7954 * the tachometer while the fan controller ramps up
7955 * the speed (which can take up to a few *minutes*).
7956 * Speeds up fan to 100% duty-cycle, which is far above
7957 * the standard RPM levels. It is not impossible that
7958 * it could cause hardware damage.
7959 * 5-3 unused in some models. Extra bits for fan level
7960 * in others, but still useless as all values above
7961 * 7 map to the same speed as level 7 in these models.
7962 * 2-0 fan level (0..7 usually)
7963 * 0x00 = stop
7964 * 0x07 = max (set when temperatures critical)
7965 * Some ThinkPads may have other levels, see
7966 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
7967 *
7968 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
7969 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
7970 * does so, its initial value is meaningless (0x07).
7971 *
7972 * For firmware bugs, refer to:
7973 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7974 *
7975 * ----
7976 *
7977 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
7978 * Main fan tachometer reading (in RPM)
7979 *
7980 * This register is present on all ThinkPads with a new-style EC, and
7981 * it is known not to be present on the A21m/e, and T22, as there is
7982 * something else in offset 0x84 according to the ACPI DSDT. Other
7983 * ThinkPads from this same time period (and earlier) probably lack the
7984 * tachometer as well.
7985 *
7986 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
7987 * was never fixed by IBM to report the EC firmware version string
7988 * probably support the tachometer (like the early X models), so
7989 * detecting it is quite hard. We need more data to know for sure.
7990 *
7991 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
7992 * might result.
7993 *
7994 * FIRMWARE BUG: may go stale while the EC is switching to full speed
7995 * mode.
7996 *
7997 * For firmware bugs, refer to:
7998 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
7999 *
8000 * ----
8001 *
8002 * ThinkPad EC register 0x31 bit 0 (only on select models)
8003 *
8004 * When bit 0 of EC register 0x31 is zero, the tachometer registers
8005 * show the speed of the main fan. When bit 0 of EC register 0x31
8006 * is one, the tachometer registers show the speed of the auxiliary
8007 * fan.
8008 *
8009 * Fan control seems to affect both fans, regardless of the state
8010 * of this bit.
8011 *
8012 * So far, only the firmware for the X60/X61 non-tablet versions
8013 * seem to support this (firmware TP-7M).
8014 *
8015 * TPACPI_FAN_WR_ACPI_FANS:
8016 * ThinkPad X31, X40, X41. Not available in the X60.
8017 *
8018 * FANS ACPI handle: takes three arguments: low speed, medium speed,
8019 * high speed. ACPI DSDT seems to map these three speeds to levels
8020 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
8021 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
8022 *
8023 * The speeds are stored on handles
8024 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
8025 *
8026 * There are three default speed sets, accessible as handles:
8027 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
8028 *
8029 * ACPI DSDT switches which set is in use depending on various
8030 * factors.
8031 *
8032 * TPACPI_FAN_WR_TPEC is also available and should be used to
8033 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
8034 * but the ACPI tables just mention level 7.
8035 */
8036
8037enum { /* Fan control constants */
8038 fan_status_offset = 0x2f, /* EC register 0x2f */
8039 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
8040 * 0x84 must be read before 0x85 */
8041 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
8042 bit 0 selects which fan is active */
8043
8044 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
8045 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
8046
8047 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
8048};
8049
8050enum fan_status_access_mode {
8051 TPACPI_FAN_NONE = 0, /* No fan status or control */
8052 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
8053 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8054};
8055
8056enum fan_control_access_mode {
8057 TPACPI_FAN_WR_NONE = 0, /* No fan control */
8058 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
8059 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
8060 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
8061};
8062
8063enum fan_control_commands {
8064 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
8065 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
8066 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
8067 * and also watchdog cmd */
8068};
8069
8070static bool fan_control_allowed;
8071
8072static enum fan_status_access_mode fan_status_access_mode;
8073static enum fan_control_access_mode fan_control_access_mode;
8074static enum fan_control_commands fan_control_commands;
8075
8076static u8 fan_control_initial_status;
8077static u8 fan_control_desired_level;
8078static u8 fan_control_resume_level;
8079static int fan_watchdog_maxinterval;
8080
8081static struct mutex fan_mutex;
8082
8083static void fan_watchdog_fire(struct work_struct *ignored);
8084static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8085
8086TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
8087TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8088 "\\FSPD", /* 600e/x, 770e, 770x */
8089 ); /* all others */
8090TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8091 "JFNS", /* 770x-JL */
8092 ); /* all others */
8093
8094/*
8095 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8096 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8097 * be in auto mode (0x80).
8098 *
8099 * This is corrected by any write to HFSP either by the driver, or
8100 * by the firmware.
8101 *
8102 * We assume 0x07 really means auto mode while this quirk is active,
8103 * as this is far more likely than the ThinkPad being in level 7,
8104 * which is only used by the firmware during thermal emergencies.
8105 *
8106 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8107 * TP-70 (T43, R52), which are known to be buggy.
8108 */
8109
8110static void fan_quirk1_setup(void)
8111{
8112 if (fan_control_initial_status == 0x07) {
8113 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8114 tp_features.fan_ctrl_status_undef = 1;
8115 }
8116}
8117
8118static void fan_quirk1_handle(u8 *fan_status)
8119{
8120 if (unlikely(tp_features.fan_ctrl_status_undef)) {
8121 if (*fan_status != fan_control_initial_status) {
8122 /* something changed the HFSP regisnter since
8123 * driver init time, so it is not undefined
8124 * anymore */
8125 tp_features.fan_ctrl_status_undef = 0;
8126 } else {
8127 /* Return most likely status. In fact, it
8128 * might be the only possible status */
8129 *fan_status = TP_EC_FAN_AUTO;
8130 }
8131 }
8132}
8133
8134/* Select main fan on X60/X61, NOOP on others */
8135static bool fan_select_fan1(void)
8136{
8137 if (tp_features.second_fan) {
8138 u8 val;
8139
8140 if (ec_read(fan_select_offset, &val) < 0)
8141 return false;
8142 val &= 0xFEU;
8143 if (ec_write(fan_select_offset, val) < 0)
8144 return false;
8145 }
8146 return true;
8147}
8148
8149/* Select secondary fan on X60/X61 */
8150static bool fan_select_fan2(void)
8151{
8152 u8 val;
8153
8154 if (!tp_features.second_fan)
8155 return false;
8156
8157 if (ec_read(fan_select_offset, &val) < 0)
8158 return false;
8159 val |= 0x01U;
8160 if (ec_write(fan_select_offset, val) < 0)
8161 return false;
8162
8163 return true;
8164}
8165
8166/*
8167 * Call with fan_mutex held
8168 */
8169static void fan_update_desired_level(u8 status)
8170{
8171 if ((status &
8172 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8173 if (status > 7)
8174 fan_control_desired_level = 7;
8175 else
8176 fan_control_desired_level = status;
8177 }
8178}
8179
8180static int fan_get_status(u8 *status)
8181{
8182 u8 s;
8183
8184 /* TODO:
8185 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8186
8187 switch (fan_status_access_mode) {
8188 case TPACPI_FAN_RD_ACPI_GFAN: {
8189 /* 570, 600e/x, 770e, 770x */
8190 int res;
8191
8192 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8193 return -EIO;
8194
8195 if (likely(status))
8196 *status = res & 0x07;
8197
8198 break;
8199 }
8200 case TPACPI_FAN_RD_TPEC:
8201 /* all except 570, 600e/x, 770e, 770x */
8202 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8203 return -EIO;
8204
8205 if (likely(status)) {
8206 *status = s;
8207 fan_quirk1_handle(status);
8208 }
8209
8210 break;
8211
8212 default:
8213 return -ENXIO;
8214 }
8215
8216 return 0;
8217}
8218
8219static int fan_get_status_safe(u8 *status)
8220{
8221 int rc;
8222 u8 s;
8223
8224 if (mutex_lock_killable(&fan_mutex))
8225 return -ERESTARTSYS;
8226 rc = fan_get_status(&s);
8227 if (!rc)
8228 fan_update_desired_level(s);
8229 mutex_unlock(&fan_mutex);
8230
8231 if (rc)
8232 return rc;
8233 if (status)
8234 *status = s;
8235
8236 return 0;
8237}
8238
8239static int fan_get_speed(unsigned int *speed)
8240{
8241 u8 hi, lo;
8242
8243 switch (fan_status_access_mode) {
8244 case TPACPI_FAN_RD_TPEC:
8245 /* all except 570, 600e/x, 770e, 770x */
8246 if (unlikely(!fan_select_fan1()))
8247 return -EIO;
8248 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8249 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8250 return -EIO;
8251
8252 if (likely(speed))
8253 *speed = (hi << 8) | lo;
8254
8255 break;
8256
8257 default:
8258 return -ENXIO;
8259 }
8260
8261 return 0;
8262}
8263
8264static int fan2_get_speed(unsigned int *speed)
8265{
8266 u8 hi, lo;
8267 bool rc;
8268
8269 switch (fan_status_access_mode) {
8270 case TPACPI_FAN_RD_TPEC:
8271 /* all except 570, 600e/x, 770e, 770x */
8272 if (unlikely(!fan_select_fan2()))
8273 return -EIO;
8274 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8275 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8276 fan_select_fan1(); /* play it safe */
8277 if (rc)
8278 return -EIO;
8279
8280 if (likely(speed))
8281 *speed = (hi << 8) | lo;
8282
8283 break;
8284
8285 default:
8286 return -ENXIO;
8287 }
8288
8289 return 0;
8290}
8291
8292static int fan_set_level(int level)
8293{
8294 if (!fan_control_allowed)
8295 return -EPERM;
8296
8297 switch (fan_control_access_mode) {
8298 case TPACPI_FAN_WR_ACPI_SFAN:
8299 if ((level < 0) || (level > 7))
8300 return -EINVAL;
8301
8302 if (tp_features.second_fan_ctl) {
8303 if (!fan_select_fan2() ||
8304 !acpi_evalf(sfan_handle, NULL, NULL, "vd", level)) {
8305 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8306 tp_features.second_fan_ctl = 0;
8307 }
8308 fan_select_fan1();
8309 }
8310 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8311 return -EIO;
8312 break;
8313
8314 case TPACPI_FAN_WR_ACPI_FANS:
8315 case TPACPI_FAN_WR_TPEC:
8316 if (!(level & TP_EC_FAN_AUTO) &&
8317 !(level & TP_EC_FAN_FULLSPEED) &&
8318 ((level < 0) || (level > 7)))
8319 return -EINVAL;
8320
8321 /* safety net should the EC not support AUTO
8322 * or FULLSPEED mode bits and just ignore them */
8323 if (level & TP_EC_FAN_FULLSPEED)
8324 level |= 7; /* safety min speed 7 */
8325 else if (level & TP_EC_FAN_AUTO)
8326 level |= 4; /* safety min speed 4 */
8327
8328 if (tp_features.second_fan_ctl) {
8329 if (!fan_select_fan2() ||
8330 !acpi_ec_write(fan_status_offset, level)) {
8331 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8332 tp_features.second_fan_ctl = 0;
8333 }
8334 fan_select_fan1();
8335
8336 }
8337 if (!acpi_ec_write(fan_status_offset, level))
8338 return -EIO;
8339 else
8340 tp_features.fan_ctrl_status_undef = 0;
8341 break;
8342
8343 default:
8344 return -ENXIO;
8345 }
8346
8347 vdbg_printk(TPACPI_DBG_FAN,
8348 "fan control: set fan control register to 0x%02x\n", level);
8349 return 0;
8350}
8351
8352static int fan_set_level_safe(int level)
8353{
8354 int rc;
8355
8356 if (!fan_control_allowed)
8357 return -EPERM;
8358
8359 if (mutex_lock_killable(&fan_mutex))
8360 return -ERESTARTSYS;
8361
8362 if (level == TPACPI_FAN_LAST_LEVEL)
8363 level = fan_control_desired_level;
8364
8365 rc = fan_set_level(level);
8366 if (!rc)
8367 fan_update_desired_level(level);
8368
8369 mutex_unlock(&fan_mutex);
8370 return rc;
8371}
8372
8373static int fan_set_enable(void)
8374{
8375 u8 s;
8376 int rc;
8377
8378 if (!fan_control_allowed)
8379 return -EPERM;
8380
8381 if (mutex_lock_killable(&fan_mutex))
8382 return -ERESTARTSYS;
8383
8384 switch (fan_control_access_mode) {
8385 case TPACPI_FAN_WR_ACPI_FANS:
8386 case TPACPI_FAN_WR_TPEC:
8387 rc = fan_get_status(&s);
8388 if (rc < 0)
8389 break;
8390
8391 /* Don't go out of emergency fan mode */
8392 if (s != 7) {
8393 s &= 0x07;
8394 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8395 }
8396
8397 if (!acpi_ec_write(fan_status_offset, s))
8398 rc = -EIO;
8399 else {
8400 tp_features.fan_ctrl_status_undef = 0;
8401 rc = 0;
8402 }
8403 break;
8404
8405 case TPACPI_FAN_WR_ACPI_SFAN:
8406 rc = fan_get_status(&s);
8407 if (rc < 0)
8408 break;
8409
8410 s &= 0x07;
8411
8412 /* Set fan to at least level 4 */
8413 s |= 4;
8414
8415 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8416 rc = -EIO;
8417 else
8418 rc = 0;
8419 break;
8420
8421 default:
8422 rc = -ENXIO;
8423 }
8424
8425 mutex_unlock(&fan_mutex);
8426
8427 if (!rc)
8428 vdbg_printk(TPACPI_DBG_FAN,
8429 "fan control: set fan control register to 0x%02x\n",
8430 s);
8431 return rc;
8432}
8433
8434static int fan_set_disable(void)
8435{
8436 int rc;
8437
8438 if (!fan_control_allowed)
8439 return -EPERM;
8440
8441 if (mutex_lock_killable(&fan_mutex))
8442 return -ERESTARTSYS;
8443
8444 rc = 0;
8445 switch (fan_control_access_mode) {
8446 case TPACPI_FAN_WR_ACPI_FANS:
8447 case TPACPI_FAN_WR_TPEC:
8448 if (!acpi_ec_write(fan_status_offset, 0x00))
8449 rc = -EIO;
8450 else {
8451 fan_control_desired_level = 0;
8452 tp_features.fan_ctrl_status_undef = 0;
8453 }
8454 break;
8455
8456 case TPACPI_FAN_WR_ACPI_SFAN:
8457 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8458 rc = -EIO;
8459 else
8460 fan_control_desired_level = 0;
8461 break;
8462
8463 default:
8464 rc = -ENXIO;
8465 }
8466
8467 if (!rc)
8468 vdbg_printk(TPACPI_DBG_FAN,
8469 "fan control: set fan control register to 0\n");
8470
8471 mutex_unlock(&fan_mutex);
8472 return rc;
8473}
8474
8475static int fan_set_speed(int speed)
8476{
8477 int rc;
8478
8479 if (!fan_control_allowed)
8480 return -EPERM;
8481
8482 if (mutex_lock_killable(&fan_mutex))
8483 return -ERESTARTSYS;
8484
8485 rc = 0;
8486 switch (fan_control_access_mode) {
8487 case TPACPI_FAN_WR_ACPI_FANS:
8488 if (speed >= 0 && speed <= 65535) {
8489 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8490 speed, speed, speed))
8491 rc = -EIO;
8492 } else
8493 rc = -EINVAL;
8494 break;
8495
8496 default:
8497 rc = -ENXIO;
8498 }
8499
8500 mutex_unlock(&fan_mutex);
8501 return rc;
8502}
8503
8504static void fan_watchdog_reset(void)
8505{
8506 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8507 return;
8508
8509 if (fan_watchdog_maxinterval > 0 &&
8510 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8511 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8512 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8513 else
8514 cancel_delayed_work(&fan_watchdog_task);
8515}
8516
8517static void fan_watchdog_fire(struct work_struct *ignored)
8518{
8519 int rc;
8520
8521 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8522 return;
8523
8524 pr_notice("fan watchdog: enabling fan\n");
8525 rc = fan_set_enable();
8526 if (rc < 0) {
8527 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8528 rc);
8529 /* reschedule for later */
8530 fan_watchdog_reset();
8531 }
8532}
8533
8534/*
8535 * SYSFS fan layout: hwmon compatible (device)
8536 *
8537 * pwm*_enable:
8538 * 0: "disengaged" mode
8539 * 1: manual mode
8540 * 2: native EC "auto" mode (recommended, hardware default)
8541 *
8542 * pwm*: set speed in manual mode, ignored otherwise.
8543 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8544 * interpolation.
8545 *
8546 * fan*_input: tachometer reading, RPM
8547 *
8548 *
8549 * SYSFS fan layout: extensions
8550 *
8551 * fan_watchdog (driver):
8552 * fan watchdog interval in seconds, 0 disables (default), max 120
8553 */
8554
8555/* sysfs fan pwm1_enable ----------------------------------------------- */
8556static ssize_t fan_pwm1_enable_show(struct device *dev,
8557 struct device_attribute *attr,
8558 char *buf)
8559{
8560 int res, mode;
8561 u8 status;
8562
8563 res = fan_get_status_safe(&status);
8564 if (res)
8565 return res;
8566
8567 if (status & TP_EC_FAN_FULLSPEED) {
8568 mode = 0;
8569 } else if (status & TP_EC_FAN_AUTO) {
8570 mode = 2;
8571 } else
8572 mode = 1;
8573
8574 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
8575}
8576
8577static ssize_t fan_pwm1_enable_store(struct device *dev,
8578 struct device_attribute *attr,
8579 const char *buf, size_t count)
8580{
8581 unsigned long t;
8582 int res, level;
8583
8584 if (parse_strtoul(buf, 2, &t))
8585 return -EINVAL;
8586
8587 tpacpi_disclose_usertask("hwmon pwm1_enable",
8588 "set fan mode to %lu\n", t);
8589
8590 switch (t) {
8591 case 0:
8592 level = TP_EC_FAN_FULLSPEED;
8593 break;
8594 case 1:
8595 level = TPACPI_FAN_LAST_LEVEL;
8596 break;
8597 case 2:
8598 level = TP_EC_FAN_AUTO;
8599 break;
8600 case 3:
8601 /* reserved for software-controlled auto mode */
8602 return -ENOSYS;
8603 default:
8604 return -EINVAL;
8605 }
8606
8607 res = fan_set_level_safe(level);
8608 if (res == -ENXIO)
8609 return -EINVAL;
8610 else if (res < 0)
8611 return res;
8612
8613 fan_watchdog_reset();
8614
8615 return count;
8616}
8617
8618static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8619 fan_pwm1_enable_show, fan_pwm1_enable_store);
8620
8621/* sysfs fan pwm1 ------------------------------------------------------ */
8622static ssize_t fan_pwm1_show(struct device *dev,
8623 struct device_attribute *attr,
8624 char *buf)
8625{
8626 int res;
8627 u8 status;
8628
8629 res = fan_get_status_safe(&status);
8630 if (res)
8631 return res;
8632
8633 if ((status &
8634 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8635 status = fan_control_desired_level;
8636
8637 if (status > 7)
8638 status = 7;
8639
8640 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
8641}
8642
8643static ssize_t fan_pwm1_store(struct device *dev,
8644 struct device_attribute *attr,
8645 const char *buf, size_t count)
8646{
8647 unsigned long s;
8648 int rc;
8649 u8 status, newlevel;
8650
8651 if (parse_strtoul(buf, 255, &s))
8652 return -EINVAL;
8653
8654 tpacpi_disclose_usertask("hwmon pwm1",
8655 "set fan speed to %lu\n", s);
8656
8657 /* scale down from 0-255 to 0-7 */
8658 newlevel = (s >> 5) & 0x07;
8659
8660 if (mutex_lock_killable(&fan_mutex))
8661 return -ERESTARTSYS;
8662
8663 rc = fan_get_status(&status);
8664 if (!rc && (status &
8665 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8666 rc = fan_set_level(newlevel);
8667 if (rc == -ENXIO)
8668 rc = -EINVAL;
8669 else if (!rc) {
8670 fan_update_desired_level(newlevel);
8671 fan_watchdog_reset();
8672 }
8673 }
8674
8675 mutex_unlock(&fan_mutex);
8676 return (rc) ? rc : count;
8677}
8678
8679static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8680
8681/* sysfs fan fan1_input ------------------------------------------------ */
8682static ssize_t fan_fan1_input_show(struct device *dev,
8683 struct device_attribute *attr,
8684 char *buf)
8685{
8686 int res;
8687 unsigned int speed;
8688
8689 res = fan_get_speed(&speed);
8690 if (res < 0)
8691 return res;
8692
8693 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8694}
8695
8696static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8697
8698/* sysfs fan fan2_input ------------------------------------------------ */
8699static ssize_t fan_fan2_input_show(struct device *dev,
8700 struct device_attribute *attr,
8701 char *buf)
8702{
8703 int res;
8704 unsigned int speed;
8705
8706 res = fan2_get_speed(&speed);
8707 if (res < 0)
8708 return res;
8709
8710 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
8711}
8712
8713static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8714
8715/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8716static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8717{
8718 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
8719}
8720
8721static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8722 size_t count)
8723{
8724 unsigned long t;
8725
8726 if (parse_strtoul(buf, 120, &t))
8727 return -EINVAL;
8728
8729 if (!fan_control_allowed)
8730 return -EPERM;
8731
8732 fan_watchdog_maxinterval = t;
8733 fan_watchdog_reset();
8734
8735 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8736
8737 return count;
8738}
8739static DRIVER_ATTR_RW(fan_watchdog);
8740
8741/* --------------------------------------------------------------------- */
8742static struct attribute *fan_attributes[] = {
8743 &dev_attr_pwm1_enable.attr, &dev_attr_pwm1.attr,
8744 &dev_attr_fan1_input.attr,
8745 NULL, /* for fan2_input */
8746 NULL
8747};
8748
8749static const struct attribute_group fan_attr_group = {
8750 .attrs = fan_attributes,
8751};
8752
8753#define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
8754#define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8755#define TPACPI_FAN_2CTL 0x0004 /* selects fan2 control */
8756
8757static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8758 TPACPI_QEC_IBM('1', 'Y', TPACPI_FAN_Q1),
8759 TPACPI_QEC_IBM('7', '8', TPACPI_FAN_Q1),
8760 TPACPI_QEC_IBM('7', '6', TPACPI_FAN_Q1),
8761 TPACPI_QEC_IBM('7', '0', TPACPI_FAN_Q1),
8762 TPACPI_QEC_LNV('7', 'M', TPACPI_FAN_2FAN),
8763 TPACPI_Q_LNV('N', '1', TPACPI_FAN_2FAN),
8764 TPACPI_Q_LNV3('N', '1', 'D', TPACPI_FAN_2CTL), /* P70 */
8765 TPACPI_Q_LNV3('N', '1', 'E', TPACPI_FAN_2CTL), /* P50 */
8766 TPACPI_Q_LNV3('N', '1', 'T', TPACPI_FAN_2CTL), /* P71 */
8767 TPACPI_Q_LNV3('N', '1', 'U', TPACPI_FAN_2CTL), /* P51 */
8768 TPACPI_Q_LNV3('N', '2', 'C', TPACPI_FAN_2CTL), /* P52 / P72 */
8769 TPACPI_Q_LNV3('N', '2', 'E', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (1st gen) */
8770 TPACPI_Q_LNV3('N', '2', 'O', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (2nd gen) */
8771};
8772
8773static int __init fan_init(struct ibm_init_struct *iibm)
8774{
8775 int rc;
8776 unsigned long quirks;
8777
8778 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8779 "initializing fan subdriver\n");
8780
8781 mutex_init(&fan_mutex);
8782 fan_status_access_mode = TPACPI_FAN_NONE;
8783 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8784 fan_control_commands = 0;
8785 fan_watchdog_maxinterval = 0;
8786 tp_features.fan_ctrl_status_undef = 0;
8787 tp_features.second_fan = 0;
8788 tp_features.second_fan_ctl = 0;
8789 fan_control_desired_level = 7;
8790
8791 if (tpacpi_is_ibm()) {
8792 TPACPI_ACPIHANDLE_INIT(fans);
8793 TPACPI_ACPIHANDLE_INIT(gfan);
8794 TPACPI_ACPIHANDLE_INIT(sfan);
8795 }
8796
8797 quirks = tpacpi_check_quirks(fan_quirk_table,
8798 ARRAY_SIZE(fan_quirk_table));
8799
8800 if (gfan_handle) {
8801 /* 570, 600e/x, 770e, 770x */
8802 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8803 } else {
8804 /* all other ThinkPads: note that even old-style
8805 * ThinkPad ECs supports the fan control register */
8806 if (likely(acpi_ec_read(fan_status_offset,
8807 &fan_control_initial_status))) {
8808 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8809 if (quirks & TPACPI_FAN_Q1)
8810 fan_quirk1_setup();
8811 if (quirks & TPACPI_FAN_2FAN) {
8812 tp_features.second_fan = 1;
8813 pr_info("secondary fan support enabled\n");
8814 }
8815 if (quirks & TPACPI_FAN_2CTL) {
8816 tp_features.second_fan = 1;
8817 tp_features.second_fan_ctl = 1;
8818 pr_info("secondary fan control enabled\n");
8819 }
8820 } else {
8821 pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8822 return 1;
8823 }
8824 }
8825
8826 if (sfan_handle) {
8827 /* 570, 770x-JL */
8828 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8829 fan_control_commands |=
8830 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8831 } else {
8832 if (!gfan_handle) {
8833 /* gfan without sfan means no fan control */
8834 /* all other models implement TP EC 0x2f control */
8835
8836 if (fans_handle) {
8837 /* X31, X40, X41 */
8838 fan_control_access_mode =
8839 TPACPI_FAN_WR_ACPI_FANS;
8840 fan_control_commands |=
8841 TPACPI_FAN_CMD_SPEED |
8842 TPACPI_FAN_CMD_LEVEL |
8843 TPACPI_FAN_CMD_ENABLE;
8844 } else {
8845 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8846 fan_control_commands |=
8847 TPACPI_FAN_CMD_LEVEL |
8848 TPACPI_FAN_CMD_ENABLE;
8849 }
8850 }
8851 }
8852
8853 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8854 "fan is %s, modes %d, %d\n",
8855 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8856 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8857 fan_status_access_mode, fan_control_access_mode);
8858
8859 /* fan control master switch */
8860 if (!fan_control_allowed) {
8861 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8862 fan_control_commands = 0;
8863 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8864 "fan control features disabled by parameter\n");
8865 }
8866
8867 /* update fan_control_desired_level */
8868 if (fan_status_access_mode != TPACPI_FAN_NONE)
8869 fan_get_status_safe(NULL);
8870
8871 if (fan_status_access_mode != TPACPI_FAN_NONE ||
8872 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
8873 if (tp_features.second_fan) {
8874 /* attach second fan tachometer */
8875 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
8876 &dev_attr_fan2_input.attr;
8877 }
8878 rc = sysfs_create_group(&tpacpi_hwmon->kobj,
8879 &fan_attr_group);
8880 if (rc < 0)
8881 return rc;
8882
8883 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
8884 &driver_attr_fan_watchdog);
8885 if (rc < 0) {
8886 sysfs_remove_group(&tpacpi_hwmon->kobj,
8887 &fan_attr_group);
8888 return rc;
8889 }
8890 return 0;
8891 } else
8892 return 1;
8893}
8894
8895static void fan_exit(void)
8896{
8897 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8898 "cancelling any pending fan watchdog tasks\n");
8899
8900 /* FIXME: can we really do this unconditionally? */
8901 sysfs_remove_group(&tpacpi_hwmon->kobj, &fan_attr_group);
8902 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
8903 &driver_attr_fan_watchdog);
8904
8905 cancel_delayed_work(&fan_watchdog_task);
8906 flush_workqueue(tpacpi_wq);
8907}
8908
8909static void fan_suspend(void)
8910{
8911 int rc;
8912
8913 if (!fan_control_allowed)
8914 return;
8915
8916 /* Store fan status in cache */
8917 fan_control_resume_level = 0;
8918 rc = fan_get_status_safe(&fan_control_resume_level);
8919 if (rc < 0)
8920 pr_notice("failed to read fan level for later restore during resume: %d\n",
8921 rc);
8922
8923 /* if it is undefined, don't attempt to restore it.
8924 * KEEP THIS LAST */
8925 if (tp_features.fan_ctrl_status_undef)
8926 fan_control_resume_level = 0;
8927}
8928
8929static void fan_resume(void)
8930{
8931 u8 current_level = 7;
8932 bool do_set = false;
8933 int rc;
8934
8935 /* DSDT *always* updates status on resume */
8936 tp_features.fan_ctrl_status_undef = 0;
8937
8938 if (!fan_control_allowed ||
8939 !fan_control_resume_level ||
8940 (fan_get_status_safe(¤t_level) < 0))
8941 return;
8942
8943 switch (fan_control_access_mode) {
8944 case TPACPI_FAN_WR_ACPI_SFAN:
8945 /* never decrease fan level */
8946 do_set = (fan_control_resume_level > current_level);
8947 break;
8948 case TPACPI_FAN_WR_ACPI_FANS:
8949 case TPACPI_FAN_WR_TPEC:
8950 /* never decrease fan level, scale is:
8951 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
8952 *
8953 * We expect the firmware to set either 7 or AUTO, but we
8954 * handle FULLSPEED out of paranoia.
8955 *
8956 * So, we can safely only restore FULLSPEED or 7, anything
8957 * else could slow the fan. Restoring AUTO is useless, at
8958 * best that's exactly what the DSDT already set (it is the
8959 * slower it uses).
8960 *
8961 * Always keep in mind that the DSDT *will* have set the
8962 * fans to what the vendor supposes is the best level. We
8963 * muck with it only to speed the fan up.
8964 */
8965 if (fan_control_resume_level != 7 &&
8966 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
8967 return;
8968 else
8969 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
8970 (current_level != fan_control_resume_level);
8971 break;
8972 default:
8973 return;
8974 }
8975 if (do_set) {
8976 pr_notice("restoring fan level to 0x%02x\n",
8977 fan_control_resume_level);
8978 rc = fan_set_level_safe(fan_control_resume_level);
8979 if (rc < 0)
8980 pr_notice("failed to restore fan level: %d\n", rc);
8981 }
8982}
8983
8984static int fan_read(struct seq_file *m)
8985{
8986 int rc;
8987 u8 status;
8988 unsigned int speed = 0;
8989
8990 switch (fan_status_access_mode) {
8991 case TPACPI_FAN_RD_ACPI_GFAN:
8992 /* 570, 600e/x, 770e, 770x */
8993 rc = fan_get_status_safe(&status);
8994 if (rc < 0)
8995 return rc;
8996
8997 seq_printf(m, "status:\t\t%s\n"
8998 "level:\t\t%d\n",
8999 (status != 0) ? "enabled" : "disabled", status);
9000 break;
9001
9002 case TPACPI_FAN_RD_TPEC:
9003 /* all except 570, 600e/x, 770e, 770x */
9004 rc = fan_get_status_safe(&status);
9005 if (rc < 0)
9006 return rc;
9007
9008 seq_printf(m, "status:\t\t%s\n",
9009 (status != 0) ? "enabled" : "disabled");
9010
9011 rc = fan_get_speed(&speed);
9012 if (rc < 0)
9013 return rc;
9014
9015 seq_printf(m, "speed:\t\t%d\n", speed);
9016
9017 if (status & TP_EC_FAN_FULLSPEED)
9018 /* Disengaged mode takes precedence */
9019 seq_printf(m, "level:\t\tdisengaged\n");
9020 else if (status & TP_EC_FAN_AUTO)
9021 seq_printf(m, "level:\t\tauto\n");
9022 else
9023 seq_printf(m, "level:\t\t%d\n", status);
9024 break;
9025
9026 case TPACPI_FAN_NONE:
9027 default:
9028 seq_printf(m, "status:\t\tnot supported\n");
9029 }
9030
9031 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
9032 seq_printf(m, "commands:\tlevel <level>");
9033
9034 switch (fan_control_access_mode) {
9035 case TPACPI_FAN_WR_ACPI_SFAN:
9036 seq_printf(m, " (<level> is 0-7)\n");
9037 break;
9038
9039 default:
9040 seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
9041 break;
9042 }
9043 }
9044
9045 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
9046 seq_printf(m, "commands:\tenable, disable\n"
9047 "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
9048
9049 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
9050 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
9051
9052 return 0;
9053}
9054
9055static int fan_write_cmd_level(const char *cmd, int *rc)
9056{
9057 int level;
9058
9059 if (strlencmp(cmd, "level auto") == 0)
9060 level = TP_EC_FAN_AUTO;
9061 else if ((strlencmp(cmd, "level disengaged") == 0) |
9062 (strlencmp(cmd, "level full-speed") == 0))
9063 level = TP_EC_FAN_FULLSPEED;
9064 else if (sscanf(cmd, "level %d", &level) != 1)
9065 return 0;
9066
9067 *rc = fan_set_level_safe(level);
9068 if (*rc == -ENXIO)
9069 pr_err("level command accepted for unsupported access mode %d\n",
9070 fan_control_access_mode);
9071 else if (!*rc)
9072 tpacpi_disclose_usertask("procfs fan",
9073 "set level to %d\n", level);
9074
9075 return 1;
9076}
9077
9078static int fan_write_cmd_enable(const char *cmd, int *rc)
9079{
9080 if (strlencmp(cmd, "enable") != 0)
9081 return 0;
9082
9083 *rc = fan_set_enable();
9084 if (*rc == -ENXIO)
9085 pr_err("enable command accepted for unsupported access mode %d\n",
9086 fan_control_access_mode);
9087 else if (!*rc)
9088 tpacpi_disclose_usertask("procfs fan", "enable\n");
9089
9090 return 1;
9091}
9092
9093static int fan_write_cmd_disable(const char *cmd, int *rc)
9094{
9095 if (strlencmp(cmd, "disable") != 0)
9096 return 0;
9097
9098 *rc = fan_set_disable();
9099 if (*rc == -ENXIO)
9100 pr_err("disable command accepted for unsupported access mode %d\n",
9101 fan_control_access_mode);
9102 else if (!*rc)
9103 tpacpi_disclose_usertask("procfs fan", "disable\n");
9104
9105 return 1;
9106}
9107
9108static int fan_write_cmd_speed(const char *cmd, int *rc)
9109{
9110 int speed;
9111
9112 /* TODO:
9113 * Support speed <low> <medium> <high> ? */
9114
9115 if (sscanf(cmd, "speed %d", &speed) != 1)
9116 return 0;
9117
9118 *rc = fan_set_speed(speed);
9119 if (*rc == -ENXIO)
9120 pr_err("speed command accepted for unsupported access mode %d\n",
9121 fan_control_access_mode);
9122 else if (!*rc)
9123 tpacpi_disclose_usertask("procfs fan",
9124 "set speed to %d\n", speed);
9125
9126 return 1;
9127}
9128
9129static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9130{
9131 int interval;
9132
9133 if (sscanf(cmd, "watchdog %d", &interval) != 1)
9134 return 0;
9135
9136 if (interval < 0 || interval > 120)
9137 *rc = -EINVAL;
9138 else {
9139 fan_watchdog_maxinterval = interval;
9140 tpacpi_disclose_usertask("procfs fan",
9141 "set watchdog timer to %d\n",
9142 interval);
9143 }
9144
9145 return 1;
9146}
9147
9148static int fan_write(char *buf)
9149{
9150 char *cmd;
9151 int rc = 0;
9152
9153 while (!rc && (cmd = strsep(&buf, ","))) {
9154 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9155 fan_write_cmd_level(cmd, &rc)) &&
9156 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9157 (fan_write_cmd_enable(cmd, &rc) ||
9158 fan_write_cmd_disable(cmd, &rc) ||
9159 fan_write_cmd_watchdog(cmd, &rc))) &&
9160 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9161 fan_write_cmd_speed(cmd, &rc))
9162 )
9163 rc = -EINVAL;
9164 else if (!rc)
9165 fan_watchdog_reset();
9166 }
9167
9168 return rc;
9169}
9170
9171static struct ibm_struct fan_driver_data = {
9172 .name = "fan",
9173 .read = fan_read,
9174 .write = fan_write,
9175 .exit = fan_exit,
9176 .suspend = fan_suspend,
9177 .resume = fan_resume,
9178};
9179
9180/*************************************************************************
9181 * Mute LED subdriver
9182 */
9183
9184#define TPACPI_LED_MAX 2
9185
9186struct tp_led_table {
9187 acpi_string name;
9188 int on_value;
9189 int off_value;
9190 int state;
9191};
9192
9193static struct tp_led_table led_tables[TPACPI_LED_MAX] = {
9194 [LED_AUDIO_MUTE] = {
9195 .name = "SSMS",
9196 .on_value = 1,
9197 .off_value = 0,
9198 },
9199 [LED_AUDIO_MICMUTE] = {
9200 .name = "MMTS",
9201 .on_value = 2,
9202 .off_value = 0,
9203 },
9204};
9205
9206static int mute_led_on_off(struct tp_led_table *t, bool state)
9207{
9208 acpi_handle temp;
9209 int output;
9210
9211 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9212 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9213 return -EIO;
9214 }
9215
9216 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9217 state ? t->on_value : t->off_value))
9218 return -EIO;
9219
9220 t->state = state;
9221 return state;
9222}
9223
9224static int tpacpi_led_set(int whichled, bool on)
9225{
9226 struct tp_led_table *t;
9227
9228 t = &led_tables[whichled];
9229 if (t->state < 0 || t->state == on)
9230 return t->state;
9231 return mute_led_on_off(t, on);
9232}
9233
9234static int tpacpi_led_mute_set(struct led_classdev *led_cdev,
9235 enum led_brightness brightness)
9236{
9237 return tpacpi_led_set(LED_AUDIO_MUTE, brightness != LED_OFF);
9238}
9239
9240static int tpacpi_led_micmute_set(struct led_classdev *led_cdev,
9241 enum led_brightness brightness)
9242{
9243 return tpacpi_led_set(LED_AUDIO_MICMUTE, brightness != LED_OFF);
9244}
9245
9246static struct led_classdev mute_led_cdev[TPACPI_LED_MAX] = {
9247 [LED_AUDIO_MUTE] = {
9248 .name = "platform::mute",
9249 .max_brightness = 1,
9250 .brightness_set_blocking = tpacpi_led_mute_set,
9251 .default_trigger = "audio-mute",
9252 },
9253 [LED_AUDIO_MICMUTE] = {
9254 .name = "platform::micmute",
9255 .max_brightness = 1,
9256 .brightness_set_blocking = tpacpi_led_micmute_set,
9257 .default_trigger = "audio-micmute",
9258 },
9259};
9260
9261static int mute_led_init(struct ibm_init_struct *iibm)
9262{
9263 acpi_handle temp;
9264 int i, err;
9265
9266 for (i = 0; i < TPACPI_LED_MAX; i++) {
9267 struct tp_led_table *t = &led_tables[i];
9268 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9269 t->state = -ENODEV;
9270 continue;
9271 }
9272
9273 mute_led_cdev[i].brightness = ledtrig_audio_get(i);
9274 err = led_classdev_register(&tpacpi_pdev->dev, &mute_led_cdev[i]);
9275 if (err < 0) {
9276 while (i--)
9277 led_classdev_unregister(&mute_led_cdev[i]);
9278 return err;
9279 }
9280 }
9281 return 0;
9282}
9283
9284static void mute_led_exit(void)
9285{
9286 int i;
9287
9288 for (i = 0; i < TPACPI_LED_MAX; i++) {
9289 led_classdev_unregister(&mute_led_cdev[i]);
9290 tpacpi_led_set(i, false);
9291 }
9292}
9293
9294static void mute_led_resume(void)
9295{
9296 int i;
9297
9298 for (i = 0; i < TPACPI_LED_MAX; i++) {
9299 struct tp_led_table *t = &led_tables[i];
9300 if (t->state >= 0)
9301 mute_led_on_off(t, t->state);
9302 }
9303}
9304
9305static struct ibm_struct mute_led_driver_data = {
9306 .name = "mute_led",
9307 .exit = mute_led_exit,
9308 .resume = mute_led_resume,
9309};
9310
9311/*
9312 * Battery Wear Control Driver
9313 * Contact: Ognjen Galic <smclt30p@gmail.com>
9314 */
9315
9316/* Metadata */
9317
9318#define GET_START "BCTG"
9319#define SET_START "BCCS"
9320#define GET_STOP "BCSG"
9321#define SET_STOP "BCSS"
9322
9323enum {
9324 BAT_ANY = 0,
9325 BAT_PRIMARY = 1,
9326 BAT_SECONDARY = 2
9327};
9328
9329enum {
9330 /* Error condition bit */
9331 METHOD_ERR = BIT(31),
9332};
9333
9334enum {
9335 /* This is used in the get/set helpers */
9336 THRESHOLD_START,
9337 THRESHOLD_STOP,
9338};
9339
9340struct tpacpi_battery_data {
9341 int charge_start;
9342 int start_support;
9343 int charge_stop;
9344 int stop_support;
9345};
9346
9347struct tpacpi_battery_driver_data {
9348 struct tpacpi_battery_data batteries[3];
9349 int individual_addressing;
9350};
9351
9352static struct tpacpi_battery_driver_data battery_info;
9353
9354/* ACPI helpers/functions/probes */
9355
9356/**
9357 * This evaluates a ACPI method call specific to the battery
9358 * ACPI extension. The specifics are that an error is marked
9359 * in the 32rd bit of the response, so we just check that here.
9360 */
9361static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9362{
9363 int response;
9364
9365 if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9366 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9367 return AE_ERROR;
9368 }
9369 if (response & METHOD_ERR) {
9370 acpi_handle_err(hkey_handle,
9371 "%s evaluated but flagged as error", method);
9372 return AE_ERROR;
9373 }
9374 *ret = response;
9375 return AE_OK;
9376}
9377
9378static int tpacpi_battery_get(int what, int battery, int *ret)
9379{
9380 switch (what) {
9381 case THRESHOLD_START:
9382 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9383 return -ENODEV;
9384
9385 /* The value is in the low 8 bits of the response */
9386 *ret = *ret & 0xFF;
9387 return 0;
9388 case THRESHOLD_STOP:
9389 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9390 return -ENODEV;
9391 /* Value is in lower 8 bits */
9392 *ret = *ret & 0xFF;
9393 /*
9394 * On the stop value, if we return 0 that
9395 * does not make any sense. 0 means Default, which
9396 * means that charging stops at 100%, so we return
9397 * that.
9398 */
9399 if (*ret == 0)
9400 *ret = 100;
9401 return 0;
9402 default:
9403 pr_crit("wrong parameter: %d", what);
9404 return -EINVAL;
9405 }
9406}
9407
9408static int tpacpi_battery_set(int what, int battery, int value)
9409{
9410 int param, ret;
9411 /* The first 8 bits are the value of the threshold */
9412 param = value;
9413 /* The battery ID is in bits 8-9, 2 bits */
9414 param |= battery << 8;
9415
9416 switch (what) {
9417 case THRESHOLD_START:
9418 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9419 pr_err("failed to set charge threshold on battery %d",
9420 battery);
9421 return -ENODEV;
9422 }
9423 return 0;
9424 case THRESHOLD_STOP:
9425 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9426 pr_err("failed to set stop threshold: %d", battery);
9427 return -ENODEV;
9428 }
9429 return 0;
9430 default:
9431 pr_crit("wrong parameter: %d", what);
9432 return -EINVAL;
9433 }
9434}
9435
9436static int tpacpi_battery_probe(int battery)
9437{
9438 int ret = 0;
9439
9440 memset(&battery_info.batteries[battery], 0,
9441 sizeof(battery_info.batteries[battery]));
9442
9443 /*
9444 * 1) Get the current start threshold
9445 * 2) Check for support
9446 * 3) Get the current stop threshold
9447 * 4) Check for support
9448 */
9449 if (acpi_has_method(hkey_handle, GET_START)) {
9450 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9451 pr_err("Error probing battery %d\n", battery);
9452 return -ENODEV;
9453 }
9454 /* Individual addressing is in bit 9 */
9455 if (ret & BIT(9))
9456 battery_info.individual_addressing = true;
9457 /* Support is marked in bit 8 */
9458 if (ret & BIT(8))
9459 battery_info.batteries[battery].start_support = 1;
9460 else
9461 return -ENODEV;
9462 if (tpacpi_battery_get(THRESHOLD_START, battery,
9463 &battery_info.batteries[battery].charge_start)) {
9464 pr_err("Error probing battery %d\n", battery);
9465 return -ENODEV;
9466 }
9467 }
9468 if (acpi_has_method(hkey_handle, GET_STOP)) {
9469 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9470 pr_err("Error probing battery stop; %d\n", battery);
9471 return -ENODEV;
9472 }
9473 /* Support is marked in bit 8 */
9474 if (ret & BIT(8))
9475 battery_info.batteries[battery].stop_support = 1;
9476 else
9477 return -ENODEV;
9478 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9479 &battery_info.batteries[battery].charge_stop)) {
9480 pr_err("Error probing battery stop: %d\n", battery);
9481 return -ENODEV;
9482 }
9483 }
9484 pr_info("battery %d registered (start %d, stop %d)",
9485 battery,
9486 battery_info.batteries[battery].charge_start,
9487 battery_info.batteries[battery].charge_stop);
9488
9489 return 0;
9490}
9491
9492/* General helper functions */
9493
9494static int tpacpi_battery_get_id(const char *battery_name)
9495{
9496
9497 if (strcmp(battery_name, "BAT0") == 0 ||
9498 tp_features.battery_force_primary)
9499 return BAT_PRIMARY;
9500 if (strcmp(battery_name, "BAT1") == 0)
9501 return BAT_SECONDARY;
9502 /*
9503 * If for some reason the battery is not BAT0 nor is it
9504 * BAT1, we will assume it's the default, first battery,
9505 * AKA primary.
9506 */
9507 pr_warn("unknown battery %s, assuming primary", battery_name);
9508 return BAT_PRIMARY;
9509}
9510
9511/* sysfs interface */
9512
9513static ssize_t tpacpi_battery_store(int what,
9514 struct device *dev,
9515 const char *buf, size_t count)
9516{
9517 struct power_supply *supply = to_power_supply(dev);
9518 unsigned long value;
9519 int battery, rval;
9520 /*
9521 * Some systems have support for more than
9522 * one battery. If that is the case,
9523 * tpacpi_battery_probe marked that addressing
9524 * them individually is supported, so we do that
9525 * based on the device struct.
9526 *
9527 * On systems that are not supported, we assume
9528 * the primary as most of the ACPI calls fail
9529 * with "Any Battery" as the parameter.
9530 */
9531 if (battery_info.individual_addressing)
9532 /* BAT_PRIMARY or BAT_SECONDARY */
9533 battery = tpacpi_battery_get_id(supply->desc->name);
9534 else
9535 battery = BAT_PRIMARY;
9536
9537 rval = kstrtoul(buf, 10, &value);
9538 if (rval)
9539 return rval;
9540
9541 switch (what) {
9542 case THRESHOLD_START:
9543 if (!battery_info.batteries[battery].start_support)
9544 return -ENODEV;
9545 /* valid values are [0, 99] */
9546 if (value > 99)
9547 return -EINVAL;
9548 if (value > battery_info.batteries[battery].charge_stop)
9549 return -EINVAL;
9550 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9551 return -ENODEV;
9552 battery_info.batteries[battery].charge_start = value;
9553 return count;
9554
9555 case THRESHOLD_STOP:
9556 if (!battery_info.batteries[battery].stop_support)
9557 return -ENODEV;
9558 /* valid values are [1, 100] */
9559 if (value < 1 || value > 100)
9560 return -EINVAL;
9561 if (value < battery_info.batteries[battery].charge_start)
9562 return -EINVAL;
9563 battery_info.batteries[battery].charge_stop = value;
9564 /*
9565 * When 100 is passed to stop, we need to flip
9566 * it to 0 as that the EC understands that as
9567 * "Default", which will charge to 100%
9568 */
9569 if (value == 100)
9570 value = 0;
9571 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9572 return -EINVAL;
9573 return count;
9574 default:
9575 pr_crit("Wrong parameter: %d", what);
9576 return -EINVAL;
9577 }
9578 return count;
9579}
9580
9581static ssize_t tpacpi_battery_show(int what,
9582 struct device *dev,
9583 char *buf)
9584{
9585 struct power_supply *supply = to_power_supply(dev);
9586 int ret, battery;
9587 /*
9588 * Some systems have support for more than
9589 * one battery. If that is the case,
9590 * tpacpi_battery_probe marked that addressing
9591 * them individually is supported, so we;
9592 * based on the device struct.
9593 *
9594 * On systems that are not supported, we assume
9595 * the primary as most of the ACPI calls fail
9596 * with "Any Battery" as the parameter.
9597 */
9598 if (battery_info.individual_addressing)
9599 /* BAT_PRIMARY or BAT_SECONDARY */
9600 battery = tpacpi_battery_get_id(supply->desc->name);
9601 else
9602 battery = BAT_PRIMARY;
9603 if (tpacpi_battery_get(what, battery, &ret))
9604 return -ENODEV;
9605 return sprintf(buf, "%d\n", ret);
9606}
9607
9608static ssize_t charge_control_start_threshold_show(struct device *device,
9609 struct device_attribute *attr,
9610 char *buf)
9611{
9612 return tpacpi_battery_show(THRESHOLD_START, device, buf);
9613}
9614
9615static ssize_t charge_control_end_threshold_show(struct device *device,
9616 struct device_attribute *attr,
9617 char *buf)
9618{
9619 return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9620}
9621
9622static ssize_t charge_control_start_threshold_store(struct device *dev,
9623 struct device_attribute *attr,
9624 const char *buf, size_t count)
9625{
9626 return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9627}
9628
9629static ssize_t charge_control_end_threshold_store(struct device *dev,
9630 struct device_attribute *attr,
9631 const char *buf, size_t count)
9632{
9633 return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9634}
9635
9636static DEVICE_ATTR_RW(charge_control_start_threshold);
9637static DEVICE_ATTR_RW(charge_control_end_threshold);
9638static struct device_attribute dev_attr_charge_start_threshold = __ATTR(
9639 charge_start_threshold,
9640 0644,
9641 charge_control_start_threshold_show,
9642 charge_control_start_threshold_store
9643);
9644static struct device_attribute dev_attr_charge_stop_threshold = __ATTR(
9645 charge_stop_threshold,
9646 0644,
9647 charge_control_end_threshold_show,
9648 charge_control_end_threshold_store
9649);
9650
9651static struct attribute *tpacpi_battery_attrs[] = {
9652 &dev_attr_charge_control_start_threshold.attr,
9653 &dev_attr_charge_control_end_threshold.attr,
9654 &dev_attr_charge_start_threshold.attr,
9655 &dev_attr_charge_stop_threshold.attr,
9656 NULL,
9657};
9658
9659ATTRIBUTE_GROUPS(tpacpi_battery);
9660
9661/* ACPI battery hooking */
9662
9663static int tpacpi_battery_add(struct power_supply *battery)
9664{
9665 int batteryid = tpacpi_battery_get_id(battery->desc->name);
9666
9667 if (tpacpi_battery_probe(batteryid))
9668 return -ENODEV;
9669 if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9670 return -ENODEV;
9671 return 0;
9672}
9673
9674static int tpacpi_battery_remove(struct power_supply *battery)
9675{
9676 device_remove_groups(&battery->dev, tpacpi_battery_groups);
9677 return 0;
9678}
9679
9680static struct acpi_battery_hook battery_hook = {
9681 .add_battery = tpacpi_battery_add,
9682 .remove_battery = tpacpi_battery_remove,
9683 .name = "ThinkPad Battery Extension",
9684};
9685
9686/* Subdriver init/exit */
9687
9688static const struct tpacpi_quirk battery_quirk_table[] __initconst = {
9689 /*
9690 * Individual addressing is broken on models that expose the
9691 * primary battery as BAT1.
9692 */
9693 TPACPI_Q_LNV('J', '7', true), /* B5400 */
9694 TPACPI_Q_LNV('J', 'I', true), /* Thinkpad 11e */
9695 TPACPI_Q_LNV3('R', '0', 'B', true), /* Thinkpad 11e gen 3 */
9696 TPACPI_Q_LNV3('R', '0', 'C', true), /* Thinkpad 13 */
9697 TPACPI_Q_LNV3('R', '0', 'J', true), /* Thinkpad 13 gen 2 */
9698};
9699
9700static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9701{
9702 memset(&battery_info, 0, sizeof(battery_info));
9703
9704 tp_features.battery_force_primary = tpacpi_check_quirks(
9705 battery_quirk_table,
9706 ARRAY_SIZE(battery_quirk_table));
9707
9708 battery_hook_register(&battery_hook);
9709 return 0;
9710}
9711
9712static void tpacpi_battery_exit(void)
9713{
9714 battery_hook_unregister(&battery_hook);
9715}
9716
9717static struct ibm_struct battery_driver_data = {
9718 .name = "battery",
9719 .exit = tpacpi_battery_exit,
9720};
9721
9722/*************************************************************************
9723 * LCD Shadow subdriver, for the Lenovo PrivacyGuard feature
9724 */
9725
9726static int lcdshadow_state;
9727
9728static int lcdshadow_on_off(bool state)
9729{
9730 acpi_handle set_shadow_handle;
9731 int output;
9732
9733 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "SSSS", &set_shadow_handle))) {
9734 pr_warn("Thinkpad ACPI has no %s interface.\n", "SSSS");
9735 return -EIO;
9736 }
9737
9738 if (!acpi_evalf(set_shadow_handle, &output, NULL, "dd", (int)state))
9739 return -EIO;
9740
9741 lcdshadow_state = state;
9742 return 0;
9743}
9744
9745static int lcdshadow_set(bool on)
9746{
9747 if (lcdshadow_state < 0)
9748 return lcdshadow_state;
9749 if (lcdshadow_state == on)
9750 return 0;
9751 return lcdshadow_on_off(on);
9752}
9753
9754static int tpacpi_lcdshadow_init(struct ibm_init_struct *iibm)
9755{
9756 acpi_handle get_shadow_handle;
9757 int output;
9758
9759 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GSSS", &get_shadow_handle))) {
9760 lcdshadow_state = -ENODEV;
9761 return 0;
9762 }
9763
9764 if (!acpi_evalf(get_shadow_handle, &output, NULL, "dd", 0)) {
9765 lcdshadow_state = -EIO;
9766 return -EIO;
9767 }
9768 if (!(output & 0x10000)) {
9769 lcdshadow_state = -ENODEV;
9770 return 0;
9771 }
9772 lcdshadow_state = output & 0x1;
9773
9774 return 0;
9775}
9776
9777static void lcdshadow_resume(void)
9778{
9779 if (lcdshadow_state >= 0)
9780 lcdshadow_on_off(lcdshadow_state);
9781}
9782
9783static int lcdshadow_read(struct seq_file *m)
9784{
9785 if (lcdshadow_state < 0) {
9786 seq_puts(m, "status:\t\tnot supported\n");
9787 } else {
9788 seq_printf(m, "status:\t\t%d\n", lcdshadow_state);
9789 seq_puts(m, "commands:\t0, 1\n");
9790 }
9791
9792 return 0;
9793}
9794
9795static int lcdshadow_write(char *buf)
9796{
9797 char *cmd;
9798 int res, state = -EINVAL;
9799
9800 if (lcdshadow_state < 0)
9801 return -ENODEV;
9802
9803 while ((cmd = strsep(&buf, ","))) {
9804 res = kstrtoint(cmd, 10, &state);
9805 if (res < 0)
9806 return res;
9807 }
9808
9809 if (state >= 2 || state < 0)
9810 return -EINVAL;
9811
9812 return lcdshadow_set(state);
9813}
9814
9815static struct ibm_struct lcdshadow_driver_data = {
9816 .name = "lcdshadow",
9817 .resume = lcdshadow_resume,
9818 .read = lcdshadow_read,
9819 .write = lcdshadow_write,
9820};
9821
9822/*************************************************************************
9823 * DYTC subdriver, for the Lenovo lapmode feature
9824 */
9825
9826#define DYTC_CMD_GET 2 /* To get current IC function and mode */
9827#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
9828
9829static bool dytc_lapmode;
9830
9831static void dytc_lapmode_notify_change(void)
9832{
9833 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
9834}
9835
9836static int dytc_command(int command, int *output)
9837{
9838 acpi_handle dytc_handle;
9839
9840 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
9841 /* Platform doesn't support DYTC */
9842 return -ENODEV;
9843 }
9844 if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
9845 return -EIO;
9846 return 0;
9847}
9848
9849static int dytc_lapmode_get(bool *state)
9850{
9851 int output, err;
9852
9853 err = dytc_command(DYTC_CMD_GET, &output);
9854 if (err)
9855 return err;
9856 *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
9857 return 0;
9858}
9859
9860static void dytc_lapmode_refresh(void)
9861{
9862 bool new_state;
9863 int err;
9864
9865 err = dytc_lapmode_get(&new_state);
9866 if (err || (new_state == dytc_lapmode))
9867 return;
9868
9869 dytc_lapmode = new_state;
9870 dytc_lapmode_notify_change();
9871}
9872
9873/* sysfs lapmode entry */
9874static ssize_t dytc_lapmode_show(struct device *dev,
9875 struct device_attribute *attr,
9876 char *buf)
9877{
9878 return snprintf(buf, PAGE_SIZE, "%d\n", dytc_lapmode);
9879}
9880
9881static DEVICE_ATTR_RO(dytc_lapmode);
9882
9883static struct attribute *dytc_attributes[] = {
9884 &dev_attr_dytc_lapmode.attr,
9885 NULL,
9886};
9887
9888static const struct attribute_group dytc_attr_group = {
9889 .attrs = dytc_attributes,
9890};
9891
9892static int tpacpi_dytc_init(struct ibm_init_struct *iibm)
9893{
9894 int err;
9895
9896 err = dytc_lapmode_get(&dytc_lapmode);
9897 /* If support isn't available (ENODEV) then don't return an error
9898 * but just don't create the sysfs group
9899 */
9900 if (err == -ENODEV)
9901 return 0;
9902 /* For all other errors we can flag the failure */
9903 if (err)
9904 return err;
9905
9906 /* Platform supports this feature - create the group */
9907 err = sysfs_create_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
9908 return err;
9909}
9910
9911static void dytc_exit(void)
9912{
9913 sysfs_remove_group(&tpacpi_pdev->dev.kobj, &dytc_attr_group);
9914}
9915
9916static struct ibm_struct dytc_driver_data = {
9917 .name = "dytc",
9918 .exit = dytc_exit,
9919};
9920
9921/****************************************************************************
9922 ****************************************************************************
9923 *
9924 * Infrastructure
9925 *
9926 ****************************************************************************
9927 ****************************************************************************/
9928
9929/*
9930 * HKEY event callout for other subdrivers go here
9931 * (yes, it is ugly, but it is quick, safe, and gets the job done
9932 */
9933static void tpacpi_driver_event(const unsigned int hkey_event)
9934{
9935 if (ibm_backlight_device) {
9936 switch (hkey_event) {
9937 case TP_HKEY_EV_BRGHT_UP:
9938 case TP_HKEY_EV_BRGHT_DOWN:
9939 tpacpi_brightness_notify_change();
9940 }
9941 }
9942 if (alsa_card) {
9943 switch (hkey_event) {
9944 case TP_HKEY_EV_VOL_UP:
9945 case TP_HKEY_EV_VOL_DOWN:
9946 case TP_HKEY_EV_VOL_MUTE:
9947 volume_alsa_notify_change();
9948 }
9949 }
9950 if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
9951 enum led_brightness brightness;
9952
9953 mutex_lock(&kbdlight_mutex);
9954
9955 /*
9956 * Check the brightness actually changed, setting the brightness
9957 * through kbdlight_set_level() also triggers this event.
9958 */
9959 brightness = kbdlight_sysfs_get(NULL);
9960 if (kbdlight_brightness != brightness) {
9961 kbdlight_brightness = brightness;
9962 led_classdev_notify_brightness_hw_changed(
9963 &tpacpi_led_kbdlight.led_classdev, brightness);
9964 }
9965
9966 mutex_unlock(&kbdlight_mutex);
9967 }
9968
9969 if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED)
9970 dytc_lapmode_refresh();
9971
9972}
9973
9974static void hotkey_driver_event(const unsigned int scancode)
9975{
9976 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
9977}
9978
9979/* --------------------------------------------------------------------- */
9980
9981/* /proc support */
9982static struct proc_dir_entry *proc_dir;
9983
9984/*
9985 * Module and infrastructure proble, init and exit handling
9986 */
9987
9988static bool force_load;
9989
9990#ifdef CONFIG_THINKPAD_ACPI_DEBUG
9991static const char * __init str_supported(int is_supported)
9992{
9993 static char text_unsupported[] __initdata = "not supported";
9994
9995 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
9996}
9997#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
9998
9999static void ibm_exit(struct ibm_struct *ibm)
10000{
10001 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
10002
10003 list_del_init(&ibm->all_drivers);
10004
10005 if (ibm->flags.acpi_notify_installed) {
10006 dbg_printk(TPACPI_DBG_EXIT,
10007 "%s: acpi_remove_notify_handler\n", ibm->name);
10008 BUG_ON(!ibm->acpi);
10009 acpi_remove_notify_handler(*ibm->acpi->handle,
10010 ibm->acpi->type,
10011 dispatch_acpi_notify);
10012 ibm->flags.acpi_notify_installed = 0;
10013 }
10014
10015 if (ibm->flags.proc_created) {
10016 dbg_printk(TPACPI_DBG_EXIT,
10017 "%s: remove_proc_entry\n", ibm->name);
10018 remove_proc_entry(ibm->name, proc_dir);
10019 ibm->flags.proc_created = 0;
10020 }
10021
10022 if (ibm->flags.acpi_driver_registered) {
10023 dbg_printk(TPACPI_DBG_EXIT,
10024 "%s: acpi_bus_unregister_driver\n", ibm->name);
10025 BUG_ON(!ibm->acpi);
10026 acpi_bus_unregister_driver(ibm->acpi->driver);
10027 kfree(ibm->acpi->driver);
10028 ibm->acpi->driver = NULL;
10029 ibm->flags.acpi_driver_registered = 0;
10030 }
10031
10032 if (ibm->flags.init_called && ibm->exit) {
10033 ibm->exit();
10034 ibm->flags.init_called = 0;
10035 }
10036
10037 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
10038}
10039
10040static int __init ibm_init(struct ibm_init_struct *iibm)
10041{
10042 int ret;
10043 struct ibm_struct *ibm = iibm->data;
10044 struct proc_dir_entry *entry;
10045
10046 BUG_ON(ibm == NULL);
10047
10048 INIT_LIST_HEAD(&ibm->all_drivers);
10049
10050 if (ibm->flags.experimental && !experimental)
10051 return 0;
10052
10053 dbg_printk(TPACPI_DBG_INIT,
10054 "probing for %s\n", ibm->name);
10055
10056 if (iibm->init) {
10057 ret = iibm->init(iibm);
10058 if (ret > 0)
10059 return 0; /* probe failed */
10060 if (ret)
10061 return ret;
10062
10063 ibm->flags.init_called = 1;
10064 }
10065
10066 if (ibm->acpi) {
10067 if (ibm->acpi->hid) {
10068 ret = register_tpacpi_subdriver(ibm);
10069 if (ret)
10070 goto err_out;
10071 }
10072
10073 if (ibm->acpi->notify) {
10074 ret = setup_acpi_notify(ibm);
10075 if (ret == -ENODEV) {
10076 pr_notice("disabling subdriver %s\n",
10077 ibm->name);
10078 ret = 0;
10079 goto err_out;
10080 }
10081 if (ret < 0)
10082 goto err_out;
10083 }
10084 }
10085
10086 dbg_printk(TPACPI_DBG_INIT,
10087 "%s installed\n", ibm->name);
10088
10089 if (ibm->read) {
10090 umode_t mode = iibm->base_procfs_mode;
10091
10092 if (!mode)
10093 mode = S_IRUGO;
10094 if (ibm->write)
10095 mode |= S_IWUSR;
10096 entry = proc_create_data(ibm->name, mode, proc_dir,
10097 &dispatch_proc_ops, ibm);
10098 if (!entry) {
10099 pr_err("unable to create proc entry %s\n", ibm->name);
10100 ret = -ENODEV;
10101 goto err_out;
10102 }
10103 ibm->flags.proc_created = 1;
10104 }
10105
10106 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
10107
10108 return 0;
10109
10110err_out:
10111 dbg_printk(TPACPI_DBG_INIT,
10112 "%s: at error exit path with result %d\n",
10113 ibm->name, ret);
10114
10115 ibm_exit(ibm);
10116 return (ret < 0) ? ret : 0;
10117}
10118
10119/* Probing */
10120
10121static char __init tpacpi_parse_fw_id(const char * const s,
10122 u32 *model, u16 *release)
10123{
10124 int i;
10125
10126 if (!s || strlen(s) < 8)
10127 goto invalid;
10128
10129 for (i = 0; i < 8; i++)
10130 if (!((s[i] >= '0' && s[i] <= '9') ||
10131 (s[i] >= 'A' && s[i] <= 'Z')))
10132 goto invalid;
10133
10134 /*
10135 * Most models: xxyTkkWW (#.##c)
10136 * Ancient 570/600 and -SL lacks (#.##c)
10137 */
10138 if (s[3] == 'T' || s[3] == 'N') {
10139 *model = TPID(s[0], s[1]);
10140 *release = TPVER(s[4], s[5]);
10141 return s[2];
10142
10143 /* New models: xxxyTkkW (#.##c); T550 and some others */
10144 } else if (s[4] == 'T' || s[4] == 'N') {
10145 *model = TPID3(s[0], s[1], s[2]);
10146 *release = TPVER(s[5], s[6]);
10147 return s[3];
10148 }
10149
10150invalid:
10151 return '\0';
10152}
10153
10154static void find_new_ec_fwstr(const struct dmi_header *dm, void *private)
10155{
10156 char *ec_fw_string = (char *) private;
10157 const char *dmi_data = (const char *)dm;
10158 /*
10159 * ThinkPad Embedded Controller Program Table on newer models
10160 *
10161 * Offset | Name | Width | Description
10162 * ----------------------------------------------------
10163 * 0x00 | Type | BYTE | 0x8C
10164 * 0x01 | Length | BYTE |
10165 * 0x02 | Handle | WORD | Varies
10166 * 0x04 | Signature | BYTEx6 | ASCII for "LENOVO"
10167 * 0x0A | OEM struct offset | BYTE | 0x0B
10168 * 0x0B | OEM struct number | BYTE | 0x07, for this structure
10169 * 0x0C | OEM struct revision | BYTE | 0x01, for this format
10170 * 0x0D | ECP version ID | STR ID |
10171 * 0x0E | ECP release date | STR ID |
10172 */
10173
10174 /* Return if data structure not match */
10175 if (dm->type != 140 || dm->length < 0x0F ||
10176 memcmp(dmi_data + 4, "LENOVO", 6) != 0 ||
10177 dmi_data[0x0A] != 0x0B || dmi_data[0x0B] != 0x07 ||
10178 dmi_data[0x0C] != 0x01)
10179 return;
10180
10181 /* fwstr is the first 8byte string */
10182 strncpy(ec_fw_string, dmi_data + 0x0F, 8);
10183}
10184
10185/* returns 0 - probe ok, or < 0 - probe error.
10186 * Probe ok doesn't mean thinkpad found.
10187 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
10188static int __must_check __init get_thinkpad_model_data(
10189 struct thinkpad_id_data *tp)
10190{
10191 const struct dmi_device *dev = NULL;
10192 char ec_fw_string[18] = {0};
10193 char const *s;
10194 char t;
10195
10196 if (!tp)
10197 return -EINVAL;
10198
10199 memset(tp, 0, sizeof(*tp));
10200
10201 if (dmi_name_in_vendors("IBM"))
10202 tp->vendor = PCI_VENDOR_ID_IBM;
10203 else if (dmi_name_in_vendors("LENOVO"))
10204 tp->vendor = PCI_VENDOR_ID_LENOVO;
10205 else
10206 return 0;
10207
10208 s = dmi_get_system_info(DMI_BIOS_VERSION);
10209 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
10210 if (s && !tp->bios_version_str)
10211 return -ENOMEM;
10212
10213 /* Really ancient ThinkPad 240X will fail this, which is fine */
10214 t = tpacpi_parse_fw_id(tp->bios_version_str,
10215 &tp->bios_model, &tp->bios_release);
10216 if (t != 'E' && t != 'C')
10217 return 0;
10218
10219 /*
10220 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
10221 * X32 or newer, all Z series; Some models must have an
10222 * up-to-date BIOS or they will not be detected.
10223 *
10224 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
10225 */
10226 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
10227 if (sscanf(dev->name,
10228 "IBM ThinkPad Embedded Controller -[%17c",
10229 ec_fw_string) == 1) {
10230 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
10231 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
10232 break;
10233 }
10234 }
10235
10236 /* Newer ThinkPads have different EC program info table */
10237 if (!ec_fw_string[0])
10238 dmi_walk(find_new_ec_fwstr, &ec_fw_string);
10239
10240 if (ec_fw_string[0]) {
10241 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
10242 if (!tp->ec_version_str)
10243 return -ENOMEM;
10244
10245 t = tpacpi_parse_fw_id(ec_fw_string,
10246 &tp->ec_model, &tp->ec_release);
10247 if (t != 'H') {
10248 pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
10249 ec_fw_string);
10250 pr_notice("please report this to %s\n", TPACPI_MAIL);
10251 }
10252 }
10253
10254 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
10255 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
10256 tp->model_str = kstrdup(s, GFP_KERNEL);
10257 if (!tp->model_str)
10258 return -ENOMEM;
10259 } else {
10260 s = dmi_get_system_info(DMI_BIOS_VENDOR);
10261 if (s && !(strncasecmp(s, "Lenovo", 6))) {
10262 tp->model_str = kstrdup(s, GFP_KERNEL);
10263 if (!tp->model_str)
10264 return -ENOMEM;
10265 }
10266 }
10267
10268 s = dmi_get_system_info(DMI_PRODUCT_NAME);
10269 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
10270 if (s && !tp->nummodel_str)
10271 return -ENOMEM;
10272
10273 return 0;
10274}
10275
10276static int __init probe_for_thinkpad(void)
10277{
10278 int is_thinkpad;
10279
10280 if (acpi_disabled)
10281 return -ENODEV;
10282
10283 /* It would be dangerous to run the driver in this case */
10284 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
10285 return -ENODEV;
10286
10287 /*
10288 * Non-ancient models have better DMI tagging, but very old models
10289 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
10290 */
10291 is_thinkpad = (thinkpad_id.model_str != NULL) ||
10292 (thinkpad_id.ec_model != 0) ||
10293 tpacpi_is_fw_known();
10294
10295 /* The EC handler is required */
10296 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
10297 if (!ec_handle) {
10298 if (is_thinkpad)
10299 pr_err("Not yet supported ThinkPad detected!\n");
10300 return -ENODEV;
10301 }
10302
10303 if (!is_thinkpad && !force_load)
10304 return -ENODEV;
10305
10306 return 0;
10307}
10308
10309static void __init thinkpad_acpi_init_banner(void)
10310{
10311 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
10312 pr_info("%s\n", TPACPI_URL);
10313
10314 pr_info("ThinkPad BIOS %s, EC %s\n",
10315 (thinkpad_id.bios_version_str) ?
10316 thinkpad_id.bios_version_str : "unknown",
10317 (thinkpad_id.ec_version_str) ?
10318 thinkpad_id.ec_version_str : "unknown");
10319
10320 BUG_ON(!thinkpad_id.vendor);
10321
10322 if (thinkpad_id.model_str)
10323 pr_info("%s %s, model %s\n",
10324 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
10325 "IBM" : ((thinkpad_id.vendor ==
10326 PCI_VENDOR_ID_LENOVO) ?
10327 "Lenovo" : "Unknown vendor"),
10328 thinkpad_id.model_str,
10329 (thinkpad_id.nummodel_str) ?
10330 thinkpad_id.nummodel_str : "unknown");
10331}
10332
10333/* Module init, exit, parameters */
10334
10335static struct ibm_init_struct ibms_init[] __initdata = {
10336 {
10337 .data = &thinkpad_acpi_driver_data,
10338 },
10339 {
10340 .init = hotkey_init,
10341 .data = &hotkey_driver_data,
10342 },
10343 {
10344 .init = bluetooth_init,
10345 .data = &bluetooth_driver_data,
10346 },
10347 {
10348 .init = wan_init,
10349 .data = &wan_driver_data,
10350 },
10351 {
10352 .init = uwb_init,
10353 .data = &uwb_driver_data,
10354 },
10355#ifdef CONFIG_THINKPAD_ACPI_VIDEO
10356 {
10357 .init = video_init,
10358 .base_procfs_mode = S_IRUSR,
10359 .data = &video_driver_data,
10360 },
10361#endif
10362 {
10363 .init = kbdlight_init,
10364 .data = &kbdlight_driver_data,
10365 },
10366 {
10367 .init = light_init,
10368 .data = &light_driver_data,
10369 },
10370 {
10371 .init = cmos_init,
10372 .data = &cmos_driver_data,
10373 },
10374 {
10375 .init = led_init,
10376 .data = &led_driver_data,
10377 },
10378 {
10379 .init = beep_init,
10380 .data = &beep_driver_data,
10381 },
10382 {
10383 .init = thermal_init,
10384 .data = &thermal_driver_data,
10385 },
10386 {
10387 .init = brightness_init,
10388 .data = &brightness_driver_data,
10389 },
10390 {
10391 .init = volume_init,
10392 .data = &volume_driver_data,
10393 },
10394 {
10395 .init = fan_init,
10396 .data = &fan_driver_data,
10397 },
10398 {
10399 .init = mute_led_init,
10400 .data = &mute_led_driver_data,
10401 },
10402 {
10403 .init = tpacpi_battery_init,
10404 .data = &battery_driver_data,
10405 },
10406 {
10407 .init = tpacpi_lcdshadow_init,
10408 .data = &lcdshadow_driver_data,
10409 },
10410 {
10411 .init = tpacpi_dytc_init,
10412 .data = &dytc_driver_data,
10413 },
10414};
10415
10416static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
10417{
10418 unsigned int i;
10419 struct ibm_struct *ibm;
10420
10421 if (!kp || !kp->name || !val)
10422 return -EINVAL;
10423
10424 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10425 ibm = ibms_init[i].data;
10426 WARN_ON(ibm == NULL);
10427
10428 if (!ibm || !ibm->name)
10429 continue;
10430
10431 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
10432 if (strlen(val) > sizeof(ibms_init[i].param) - 1)
10433 return -ENOSPC;
10434 strcpy(ibms_init[i].param, val);
10435 return 0;
10436 }
10437 }
10438
10439 return -EINVAL;
10440}
10441
10442module_param(experimental, int, 0444);
10443MODULE_PARM_DESC(experimental,
10444 "Enables experimental features when non-zero");
10445
10446module_param_named(debug, dbg_level, uint, 0);
10447MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
10448
10449module_param(force_load, bool, 0444);
10450MODULE_PARM_DESC(force_load,
10451 "Attempts to load the driver even on a mis-identified ThinkPad when true");
10452
10453module_param_named(fan_control, fan_control_allowed, bool, 0444);
10454MODULE_PARM_DESC(fan_control,
10455 "Enables setting fan parameters features when true");
10456
10457module_param_named(brightness_mode, brightness_mode, uint, 0444);
10458MODULE_PARM_DESC(brightness_mode,
10459 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
10460
10461module_param(brightness_enable, uint, 0444);
10462MODULE_PARM_DESC(brightness_enable,
10463 "Enables backlight control when 1, disables when 0");
10464
10465#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
10466module_param_named(volume_mode, volume_mode, uint, 0444);
10467MODULE_PARM_DESC(volume_mode,
10468 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
10469
10470module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
10471MODULE_PARM_DESC(volume_capabilities,
10472 "Selects the mixer capabilities: 0=auto, 1=volume and mute, 2=mute only");
10473
10474module_param_named(volume_control, volume_control_allowed, bool, 0444);
10475MODULE_PARM_DESC(volume_control,
10476 "Enables software override for the console audio control when true");
10477
10478module_param_named(software_mute, software_mute_requested, bool, 0444);
10479MODULE_PARM_DESC(software_mute,
10480 "Request full software mute control");
10481
10482/* ALSA module API parameters */
10483module_param_named(index, alsa_index, int, 0444);
10484MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
10485module_param_named(id, alsa_id, charp, 0444);
10486MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
10487module_param_named(enable, alsa_enable, bool, 0444);
10488MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
10489#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
10490
10491/* The module parameter can't be read back, that's why 0 is used here */
10492#define TPACPI_PARAM(feature) \
10493 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
10494 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
10495
10496TPACPI_PARAM(hotkey);
10497TPACPI_PARAM(bluetooth);
10498TPACPI_PARAM(video);
10499TPACPI_PARAM(light);
10500TPACPI_PARAM(cmos);
10501TPACPI_PARAM(led);
10502TPACPI_PARAM(beep);
10503TPACPI_PARAM(brightness);
10504TPACPI_PARAM(volume);
10505TPACPI_PARAM(fan);
10506
10507#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10508module_param(dbg_wlswemul, uint, 0444);
10509MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
10510module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
10511MODULE_PARM_DESC(wlsw_state,
10512 "Initial state of the emulated WLSW switch");
10513
10514module_param(dbg_bluetoothemul, uint, 0444);
10515MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
10516module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
10517MODULE_PARM_DESC(bluetooth_state,
10518 "Initial state of the emulated bluetooth switch");
10519
10520module_param(dbg_wwanemul, uint, 0444);
10521MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
10522module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
10523MODULE_PARM_DESC(wwan_state,
10524 "Initial state of the emulated WWAN switch");
10525
10526module_param(dbg_uwbemul, uint, 0444);
10527MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
10528module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
10529MODULE_PARM_DESC(uwb_state,
10530 "Initial state of the emulated UWB switch");
10531#endif
10532
10533static void thinkpad_acpi_module_exit(void)
10534{
10535 struct ibm_struct *ibm, *itmp;
10536
10537 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
10538
10539 list_for_each_entry_safe_reverse(ibm, itmp,
10540 &tpacpi_all_drivers,
10541 all_drivers) {
10542 ibm_exit(ibm);
10543 }
10544
10545 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
10546
10547 if (tpacpi_inputdev) {
10548 if (tp_features.input_device_registered)
10549 input_unregister_device(tpacpi_inputdev);
10550 else
10551 input_free_device(tpacpi_inputdev);
10552 kfree(hotkey_keycode_map);
10553 }
10554
10555 if (tpacpi_hwmon)
10556 hwmon_device_unregister(tpacpi_hwmon);
10557
10558 if (tpacpi_sensors_pdev)
10559 platform_device_unregister(tpacpi_sensors_pdev);
10560 if (tpacpi_pdev)
10561 platform_device_unregister(tpacpi_pdev);
10562
10563 if (tp_features.sensors_pdrv_attrs_registered)
10564 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
10565 if (tp_features.platform_drv_attrs_registered)
10566 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
10567
10568 if (tp_features.sensors_pdrv_registered)
10569 platform_driver_unregister(&tpacpi_hwmon_pdriver);
10570
10571 if (tp_features.platform_drv_registered)
10572 platform_driver_unregister(&tpacpi_pdriver);
10573
10574 if (proc_dir)
10575 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
10576
10577 if (tpacpi_wq)
10578 destroy_workqueue(tpacpi_wq);
10579
10580 kfree(thinkpad_id.bios_version_str);
10581 kfree(thinkpad_id.ec_version_str);
10582 kfree(thinkpad_id.model_str);
10583 kfree(thinkpad_id.nummodel_str);
10584}
10585
10586
10587static int __init thinkpad_acpi_module_init(void)
10588{
10589 int ret, i;
10590
10591 tpacpi_lifecycle = TPACPI_LIFE_INIT;
10592
10593 /* Driver-level probe */
10594
10595 ret = get_thinkpad_model_data(&thinkpad_id);
10596 if (ret) {
10597 pr_err("unable to get DMI data: %d\n", ret);
10598 thinkpad_acpi_module_exit();
10599 return ret;
10600 }
10601 ret = probe_for_thinkpad();
10602 if (ret) {
10603 thinkpad_acpi_module_exit();
10604 return ret;
10605 }
10606
10607 /* Driver initialization */
10608
10609 thinkpad_acpi_init_banner();
10610 tpacpi_check_outdated_fw();
10611
10612 TPACPI_ACPIHANDLE_INIT(ecrd);
10613 TPACPI_ACPIHANDLE_INIT(ecwr);
10614
10615 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
10616 if (!tpacpi_wq) {
10617 thinkpad_acpi_module_exit();
10618 return -ENOMEM;
10619 }
10620
10621 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
10622 if (!proc_dir) {
10623 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
10624 thinkpad_acpi_module_exit();
10625 return -ENODEV;
10626 }
10627
10628 ret = platform_driver_register(&tpacpi_pdriver);
10629 if (ret) {
10630 pr_err("unable to register main platform driver\n");
10631 thinkpad_acpi_module_exit();
10632 return ret;
10633 }
10634 tp_features.platform_drv_registered = 1;
10635
10636 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
10637 if (ret) {
10638 pr_err("unable to register hwmon platform driver\n");
10639 thinkpad_acpi_module_exit();
10640 return ret;
10641 }
10642 tp_features.sensors_pdrv_registered = 1;
10643
10644 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
10645 if (!ret) {
10646 tp_features.platform_drv_attrs_registered = 1;
10647 ret = tpacpi_create_driver_attributes(
10648 &tpacpi_hwmon_pdriver.driver);
10649 }
10650 if (ret) {
10651 pr_err("unable to create sysfs driver attributes\n");
10652 thinkpad_acpi_module_exit();
10653 return ret;
10654 }
10655 tp_features.sensors_pdrv_attrs_registered = 1;
10656
10657
10658 /* Device initialization */
10659 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
10660 NULL, 0);
10661 if (IS_ERR(tpacpi_pdev)) {
10662 ret = PTR_ERR(tpacpi_pdev);
10663 tpacpi_pdev = NULL;
10664 pr_err("unable to register platform device\n");
10665 thinkpad_acpi_module_exit();
10666 return ret;
10667 }
10668 tpacpi_sensors_pdev = platform_device_register_simple(
10669 TPACPI_HWMON_DRVR_NAME,
10670 -1, NULL, 0);
10671 if (IS_ERR(tpacpi_sensors_pdev)) {
10672 ret = PTR_ERR(tpacpi_sensors_pdev);
10673 tpacpi_sensors_pdev = NULL;
10674 pr_err("unable to register hwmon platform device\n");
10675 thinkpad_acpi_module_exit();
10676 return ret;
10677 }
10678 tp_features.sensors_pdev_attrs_registered = 1;
10679 tpacpi_hwmon = hwmon_device_register_with_groups(
10680 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, NULL);
10681
10682 if (IS_ERR(tpacpi_hwmon)) {
10683 ret = PTR_ERR(tpacpi_hwmon);
10684 tpacpi_hwmon = NULL;
10685 pr_err("unable to register hwmon device\n");
10686 thinkpad_acpi_module_exit();
10687 return ret;
10688 }
10689 mutex_init(&tpacpi_inputdev_send_mutex);
10690 tpacpi_inputdev = input_allocate_device();
10691 if (!tpacpi_inputdev) {
10692 thinkpad_acpi_module_exit();
10693 return -ENOMEM;
10694 } else {
10695 /* Prepare input device, but don't register */
10696 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
10697 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
10698 tpacpi_inputdev->id.bustype = BUS_HOST;
10699 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
10700 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
10701 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
10702 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
10703 }
10704
10705 /* Init subdriver dependencies */
10706 tpacpi_detect_brightness_capabilities();
10707
10708 /* Init subdrivers */
10709 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
10710 ret = ibm_init(&ibms_init[i]);
10711 if (ret >= 0 && *ibms_init[i].param)
10712 ret = ibms_init[i].data->write(ibms_init[i].param);
10713 if (ret < 0) {
10714 thinkpad_acpi_module_exit();
10715 return ret;
10716 }
10717 }
10718
10719 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
10720
10721 ret = input_register_device(tpacpi_inputdev);
10722 if (ret < 0) {
10723 pr_err("unable to register input device\n");
10724 thinkpad_acpi_module_exit();
10725 return ret;
10726 } else {
10727 tp_features.input_device_registered = 1;
10728 }
10729
10730 return 0;
10731}
10732
10733MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
10734
10735/*
10736 * This will autoload the driver in almost every ThinkPad
10737 * in widespread use.
10738 *
10739 * Only _VERY_ old models, like the 240, 240x and 570 lack
10740 * the HKEY event interface.
10741 */
10742MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
10743
10744/*
10745 * DMI matching for module autoloading
10746 *
10747 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
10748 * See https://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
10749 *
10750 * Only models listed in thinkwiki will be supported, so add yours
10751 * if it is not there yet.
10752 */
10753#define IBM_BIOS_MODULE_ALIAS(__type) \
10754 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
10755
10756/* Ancient thinkpad BIOSes have to be identified by
10757 * BIOS type or model number, and there are far less
10758 * BIOS types than model numbers... */
10759IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
10760
10761MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
10762MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
10763MODULE_DESCRIPTION(TPACPI_DESC);
10764MODULE_VERSION(TPACPI_VERSION);
10765MODULE_LICENSE("GPL");
10766
10767module_init(thinkpad_acpi_module_init);
10768module_exit(thinkpad_acpi_module_exit);