Loading...
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/acpi.h>
38#include <linux/backlight.h>
39#include <linux/bitops.h>
40#include <linux/delay.h>
41#include <linux/dmi.h>
42#include <linux/fb.h>
43#include <linux/freezer.h>
44#include <linux/hwmon.h>
45#include <linux/hwmon-sysfs.h>
46#include <linux/init.h>
47#include <linux/input.h>
48#include <linux/jiffies.h>
49#include <linux/kernel.h>
50#include <linux/kthread.h>
51#include <linux/leds.h>
52#include <linux/list.h>
53#include <linux/module.h>
54#include <linux/mutex.h>
55#include <linux/nvram.h>
56#include <linux/pci.h>
57#include <linux/platform_device.h>
58#include <linux/platform_profile.h>
59#include <linux/power_supply.h>
60#include <linux/proc_fs.h>
61#include <linux/rfkill.h>
62#include <linux/sched.h>
63#include <linux/sched/signal.h>
64#include <linux/seq_file.h>
65#include <linux/slab.h>
66#include <linux/string.h>
67#include <linux/string_helpers.h>
68#include <linux/sysfs.h>
69#include <linux/types.h>
70#include <linux/uaccess.h>
71#include <linux/workqueue.h>
72
73#include <acpi/battery.h>
74#include <acpi/video.h>
75
76#include <drm/drm_privacy_screen_driver.h>
77
78#include <sound/control.h>
79#include <sound/core.h>
80#include <sound/initval.h>
81
82#include "dual_accel_detect.h"
83
84/* ThinkPad CMOS commands */
85#define TP_CMOS_VOLUME_DOWN 0
86#define TP_CMOS_VOLUME_UP 1
87#define TP_CMOS_VOLUME_MUTE 2
88#define TP_CMOS_BRIGHTNESS_UP 4
89#define TP_CMOS_BRIGHTNESS_DOWN 5
90#define TP_CMOS_THINKLIGHT_ON 12
91#define TP_CMOS_THINKLIGHT_OFF 13
92
93/* NVRAM Addresses */
94enum tp_nvram_addr {
95 TP_NVRAM_ADDR_HK2 = 0x57,
96 TP_NVRAM_ADDR_THINKLIGHT = 0x58,
97 TP_NVRAM_ADDR_VIDEO = 0x59,
98 TP_NVRAM_ADDR_BRIGHTNESS = 0x5e,
99 TP_NVRAM_ADDR_MIXER = 0x60,
100};
101
102/* NVRAM bit masks */
103enum {
104 TP_NVRAM_MASK_HKT_THINKPAD = 0x08,
105 TP_NVRAM_MASK_HKT_ZOOM = 0x20,
106 TP_NVRAM_MASK_HKT_DISPLAY = 0x40,
107 TP_NVRAM_MASK_HKT_HIBERNATE = 0x80,
108 TP_NVRAM_MASK_THINKLIGHT = 0x10,
109 TP_NVRAM_MASK_HKT_DISPEXPND = 0x30,
110 TP_NVRAM_MASK_HKT_BRIGHTNESS = 0x20,
111 TP_NVRAM_MASK_LEVEL_BRIGHTNESS = 0x0f,
112 TP_NVRAM_POS_LEVEL_BRIGHTNESS = 0,
113 TP_NVRAM_MASK_MUTE = 0x40,
114 TP_NVRAM_MASK_HKT_VOLUME = 0x80,
115 TP_NVRAM_MASK_LEVEL_VOLUME = 0x0f,
116 TP_NVRAM_POS_LEVEL_VOLUME = 0,
117};
118
119/* Misc NVRAM-related */
120enum {
121 TP_NVRAM_LEVEL_VOLUME_MAX = 14,
122};
123
124/* ACPI HIDs */
125#define TPACPI_ACPI_IBM_HKEY_HID "IBM0068"
126#define TPACPI_ACPI_LENOVO_HKEY_HID "LEN0068"
127#define TPACPI_ACPI_LENOVO_HKEY_V2_HID "LEN0268"
128#define TPACPI_ACPI_EC_HID "PNP0C09"
129
130/* Input IDs */
131#define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
132#define TPACPI_HKEY_INPUT_VERSION 0x4101
133
134/* ACPI \WGSV commands */
135enum {
136 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
137 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
138 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
139 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
140};
141
142/* TP_ACPI_WGSV_GET_STATE bits */
143enum {
144 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
145 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
146 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
147 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
148 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
149 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
150 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
151 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
152 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
153 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
154};
155
156/* HKEY events */
157enum tpacpi_hkey_event_t {
158 /* Hotkey-related */
159 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
160 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
161 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
162 TP_HKEY_EV_KBD_LIGHT = 0x1012, /* Thinklight/kbd backlight */
163 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
164 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
165 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
166 TP_HKEY_EV_PRIVACYGUARD_TOGGLE = 0x130f, /* Toggle priv.guard on/off */
167 TP_HKEY_EV_AMT_TOGGLE = 0x131a, /* Toggle AMT on/off */
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 * Thinkpad X1 Tablet series devices emit 0x4012 and 0x4013
189 * when keyboard cover is attached, detached or folded onto the back
190 */
191 TP_HKEY_EV_KBD_COVER_ATTACH = 0x4012, /* keyboard cover attached */
192 TP_HKEY_EV_KBD_COVER_DETACH = 0x4013, /* keyboard cover detached or folded back */
193
194 /* User-interface events */
195 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
196 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
197 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
198 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
199 TP_HKEY_EV_TABLET_CHANGED = 0x60c0, /* X1 Yoga (2016):
200 * enter/leave tablet mode
201 */
202 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
203 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
204 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
205
206 /* Key-related user-interface events */
207 TP_HKEY_EV_KEY_NUMLOCK = 0x6000, /* NumLock key pressed */
208 TP_HKEY_EV_KEY_FN = 0x6005, /* Fn key pressed? E420 */
209 TP_HKEY_EV_KEY_FN_ESC = 0x6060, /* Fn+Esc key pressed X240 */
210
211 /* Thermal events */
212 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
213 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
214 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
215 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
216 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* windows; thermal table changed */
217 TP_HKEY_EV_THM_CSM_COMPLETED = 0x6032, /* windows; thermal control set
218 * command completed. Related to
219 * AML DYTC */
220 TP_HKEY_EV_THM_TRANSFM_CHANGED = 0x60F0, /* windows; thermal transformation
221 * changed. Related to AML GMTS */
222
223 /* AC-related events */
224 TP_HKEY_EV_AC_CHANGED = 0x6040, /* AC status changed */
225
226 /* Further user-interface events */
227 TP_HKEY_EV_PALM_DETECTED = 0x60b0, /* palm hoveres keyboard */
228 TP_HKEY_EV_PALM_UNDETECTED = 0x60b1, /* palm removed */
229
230 /* Misc */
231 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
232};
233
234/****************************************************************************
235 * Main driver
236 */
237
238#define TPACPI_NAME "thinkpad"
239#define TPACPI_DESC "ThinkPad ACPI Extras"
240#define TPACPI_FILE TPACPI_NAME "_acpi"
241#define TPACPI_URL "http://ibm-acpi.sf.net/"
242#define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
243
244#define TPACPI_PROC_DIR "ibm"
245#define TPACPI_ACPI_EVENT_PREFIX "ibm"
246#define TPACPI_DRVR_NAME TPACPI_FILE
247#define TPACPI_DRVR_SHORTNAME "tpacpi"
248#define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
249
250#define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
251#define TPACPI_WORKQUEUE_NAME "ktpacpid"
252
253#define TPACPI_MAX_ACPI_ARGS 3
254
255/* Debugging printk groups */
256#define TPACPI_DBG_ALL 0xffff
257#define TPACPI_DBG_DISCLOSETASK 0x8000
258#define TPACPI_DBG_INIT 0x0001
259#define TPACPI_DBG_EXIT 0x0002
260#define TPACPI_DBG_RFKILL 0x0004
261#define TPACPI_DBG_HKEY 0x0008
262#define TPACPI_DBG_FAN 0x0010
263#define TPACPI_DBG_BRGHT 0x0020
264#define TPACPI_DBG_MIXER 0x0040
265
266#define FAN_NOT_PRESENT 65535
267
268/****************************************************************************
269 * Driver-wide structs and misc. variables
270 */
271
272struct ibm_struct;
273
274struct tp_acpi_drv_struct {
275 const struct acpi_device_id *hid;
276 struct acpi_driver *driver;
277
278 void (*notify) (struct ibm_struct *, u32);
279 acpi_handle *handle;
280 u32 type;
281 struct acpi_device *device;
282};
283
284struct ibm_struct {
285 char *name;
286
287 int (*read) (struct seq_file *);
288 int (*write) (char *);
289 void (*exit) (void);
290 void (*resume) (void);
291 void (*suspend) (void);
292 void (*shutdown) (void);
293
294 struct list_head all_drivers;
295
296 struct tp_acpi_drv_struct *acpi;
297
298 struct {
299 u8 acpi_driver_registered:1;
300 u8 acpi_notify_installed:1;
301 u8 proc_created:1;
302 u8 init_called:1;
303 u8 experimental:1;
304 } flags;
305};
306
307struct ibm_init_struct {
308 char param[32];
309
310 int (*init) (struct ibm_init_struct *);
311 umode_t base_procfs_mode;
312 struct ibm_struct *data;
313};
314
315/* DMI Quirks */
316struct quirk_entry {
317 bool btusb_bug;
318 u32 s2idle_bug_mmio;
319};
320
321static struct quirk_entry quirk_btusb_bug = {
322 .btusb_bug = true,
323};
324
325static struct quirk_entry quirk_s2idle_bug = {
326 .s2idle_bug_mmio = 0xfed80380,
327};
328
329static struct {
330 u32 bluetooth:1;
331 u32 hotkey:1;
332 u32 hotkey_mask:1;
333 u32 hotkey_wlsw:1;
334 enum {
335 TP_HOTKEY_TABLET_NONE = 0,
336 TP_HOTKEY_TABLET_USES_MHKG,
337 TP_HOTKEY_TABLET_USES_GMMS,
338 } hotkey_tablet;
339 u32 kbdlight:1;
340 u32 light:1;
341 u32 light_status:1;
342 u32 bright_acpimode:1;
343 u32 bright_unkfw:1;
344 u32 wan:1;
345 u32 uwb:1;
346 u32 fan_ctrl_status_undef:1;
347 u32 second_fan:1;
348 u32 second_fan_ctl:1;
349 u32 beep_needs_two_args:1;
350 u32 mixer_no_level_control:1;
351 u32 battery_force_primary:1;
352 u32 input_device_registered:1;
353 u32 platform_drv_registered:1;
354 u32 sensors_pdrv_registered:1;
355 u32 hotkey_poll_active:1;
356 u32 has_adaptive_kbd:1;
357 u32 kbd_lang:1;
358 struct quirk_entry *quirks;
359} tp_features;
360
361static struct {
362 u16 hotkey_mask_ff:1;
363 u16 volume_ctrl_forbidden:1;
364} tp_warned;
365
366struct thinkpad_id_data {
367 unsigned int vendor; /* ThinkPad vendor:
368 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
369
370 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
371 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
372
373 u32 bios_model; /* 1Y = 0x3159, 0 = unknown */
374 u32 ec_model;
375 u16 bios_release; /* 1ZETK1WW = 0x4b31, 0 = unknown */
376 u16 ec_release;
377
378 char *model_str; /* ThinkPad T43 */
379 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
380};
381static struct thinkpad_id_data thinkpad_id;
382
383static enum {
384 TPACPI_LIFE_INIT = 0,
385 TPACPI_LIFE_RUNNING,
386 TPACPI_LIFE_EXITING,
387} tpacpi_lifecycle;
388
389static int experimental;
390static u32 dbg_level;
391
392static struct workqueue_struct *tpacpi_wq;
393
394enum led_status_t {
395 TPACPI_LED_OFF = 0,
396 TPACPI_LED_ON,
397 TPACPI_LED_BLINK,
398};
399
400/* tpacpi LED class */
401struct tpacpi_led_classdev {
402 struct led_classdev led_classdev;
403 int led;
404};
405
406/* brightness level capabilities */
407static unsigned int bright_maxlvl; /* 0 = unknown */
408
409#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
410static int dbg_wlswemul;
411static bool tpacpi_wlsw_emulstate;
412static int dbg_bluetoothemul;
413static bool tpacpi_bluetooth_emulstate;
414static int dbg_wwanemul;
415static bool tpacpi_wwan_emulstate;
416static int dbg_uwbemul;
417static bool tpacpi_uwb_emulstate;
418#endif
419
420
421/*************************************************************************
422 * Debugging helpers
423 */
424
425#define dbg_printk(a_dbg_level, format, arg...) \
426do { \
427 if (dbg_level & (a_dbg_level)) \
428 printk(KERN_DEBUG pr_fmt("%s: " format), \
429 __func__, ##arg); \
430} while (0)
431
432#ifdef CONFIG_THINKPAD_ACPI_DEBUG
433#define vdbg_printk dbg_printk
434static const char *str_supported(int is_supported);
435#else
436static inline const char *str_supported(int is_supported) { return ""; }
437#define vdbg_printk(a_dbg_level, format, arg...) \
438 do { if (0) no_printk(format, ##arg); } while (0)
439#endif
440
441static void tpacpi_log_usertask(const char * const what)
442{
443 printk(KERN_DEBUG pr_fmt("%s: access by process with PID %d\n"),
444 what, task_tgid_vnr(current));
445}
446
447#define tpacpi_disclose_usertask(what, format, arg...) \
448do { \
449 if (unlikely((dbg_level & TPACPI_DBG_DISCLOSETASK) && \
450 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
451 printk(KERN_DEBUG pr_fmt("%s: PID %d: " format), \
452 what, task_tgid_vnr(current), ## arg); \
453 } \
454} while (0)
455
456/*
457 * Quirk handling helpers
458 *
459 * ThinkPad IDs and versions seen in the field so far are
460 * two or three characters from the set [0-9A-Z], i.e. base 36.
461 *
462 * We use values well outside that range as specials.
463 */
464
465#define TPACPI_MATCH_ANY 0xffffffffU
466#define TPACPI_MATCH_ANY_VERSION 0xffffU
467#define TPACPI_MATCH_UNKNOWN 0U
468
469/* TPID('1', 'Y') == 0x3159 */
470#define TPID(__c1, __c2) (((__c1) << 8) | (__c2))
471#define TPID3(__c1, __c2, __c3) (((__c1) << 16) | ((__c2) << 8) | (__c3))
472#define TPVER TPID
473
474#define TPACPI_Q_IBM(__id1, __id2, __quirk) \
475 { .vendor = PCI_VENDOR_ID_IBM, \
476 .bios = TPID(__id1, __id2), \
477 .ec = TPACPI_MATCH_ANY, \
478 .quirks = (__quirk) }
479
480#define TPACPI_Q_LNV(__id1, __id2, __quirk) \
481 { .vendor = PCI_VENDOR_ID_LENOVO, \
482 .bios = TPID(__id1, __id2), \
483 .ec = TPACPI_MATCH_ANY, \
484 .quirks = (__quirk) }
485
486#define TPACPI_Q_LNV3(__id1, __id2, __id3, __quirk) \
487 { .vendor = PCI_VENDOR_ID_LENOVO, \
488 .bios = TPID3(__id1, __id2, __id3), \
489 .ec = TPACPI_MATCH_ANY, \
490 .quirks = (__quirk) }
491
492#define TPACPI_QEC_IBM(__id1, __id2, __quirk) \
493 { .vendor = PCI_VENDOR_ID_IBM, \
494 .bios = TPACPI_MATCH_ANY, \
495 .ec = TPID(__id1, __id2), \
496 .quirks = (__quirk) }
497
498#define TPACPI_QEC_LNV(__id1, __id2, __quirk) \
499 { .vendor = PCI_VENDOR_ID_LENOVO, \
500 .bios = TPACPI_MATCH_ANY, \
501 .ec = TPID(__id1, __id2), \
502 .quirks = (__quirk) }
503
504struct tpacpi_quirk {
505 unsigned int vendor;
506 u32 bios;
507 u32 ec;
508 unsigned long quirks;
509};
510
511/**
512 * tpacpi_check_quirks() - search BIOS/EC version on a list
513 * @qlist: array of &struct tpacpi_quirk
514 * @qlist_size: number of elements in @qlist
515 *
516 * Iterates over a quirks list until one is found that matches the
517 * ThinkPad's vendor, BIOS and EC model.
518 *
519 * Returns 0 if nothing matches, otherwise returns the quirks field of
520 * the matching &struct tpacpi_quirk entry.
521 *
522 * The match criteria is: vendor, ec and bios much match.
523 */
524static unsigned long __init tpacpi_check_quirks(
525 const struct tpacpi_quirk *qlist,
526 unsigned int qlist_size)
527{
528 while (qlist_size) {
529 if ((qlist->vendor == thinkpad_id.vendor ||
530 qlist->vendor == TPACPI_MATCH_ANY) &&
531 (qlist->bios == thinkpad_id.bios_model ||
532 qlist->bios == TPACPI_MATCH_ANY) &&
533 (qlist->ec == thinkpad_id.ec_model ||
534 qlist->ec == TPACPI_MATCH_ANY))
535 return qlist->quirks;
536
537 qlist_size--;
538 qlist++;
539 }
540 return 0;
541}
542
543static inline bool __pure __init tpacpi_is_lenovo(void)
544{
545 return thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO;
546}
547
548static inline bool __pure __init tpacpi_is_ibm(void)
549{
550 return thinkpad_id.vendor == PCI_VENDOR_ID_IBM;
551}
552
553/****************************************************************************
554 ****************************************************************************
555 *
556 * ACPI Helpers and device model
557 *
558 ****************************************************************************
559 ****************************************************************************/
560
561/*************************************************************************
562 * ACPI basic handles
563 */
564
565static acpi_handle root_handle;
566static acpi_handle ec_handle;
567
568#define TPACPI_HANDLE(object, parent, paths...) \
569 static acpi_handle object##_handle; \
570 static const acpi_handle * const object##_parent __initconst = \
571 &parent##_handle; \
572 static char *object##_paths[] __initdata = { paths }
573
574TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
575TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
576
577TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
578 /* T4x, X31, X40 */
579 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
580 "\\CMS", /* R40, R40e */
581 ); /* all others */
582
583TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
584 "^HKEY", /* R30, R31 */
585 "HKEY", /* all others */
586 ); /* 570 */
587
588/*************************************************************************
589 * ACPI helpers
590 */
591
592static int acpi_evalf(acpi_handle handle,
593 int *res, char *method, char *fmt, ...)
594{
595 char *fmt0 = fmt;
596 struct acpi_object_list params;
597 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
598 struct acpi_buffer result, *resultp;
599 union acpi_object out_obj;
600 acpi_status status;
601 va_list ap;
602 char res_type;
603 int success;
604 int quiet;
605
606 if (!*fmt) {
607 pr_err("acpi_evalf() called with empty format\n");
608 return 0;
609 }
610
611 if (*fmt == 'q') {
612 quiet = 1;
613 fmt++;
614 } else
615 quiet = 0;
616
617 res_type = *(fmt++);
618
619 params.count = 0;
620 params.pointer = &in_objs[0];
621
622 va_start(ap, fmt);
623 while (*fmt) {
624 char c = *(fmt++);
625 switch (c) {
626 case 'd': /* int */
627 in_objs[params.count].integer.value = va_arg(ap, int);
628 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
629 break;
630 /* add more types as needed */
631 default:
632 pr_err("acpi_evalf() called with invalid format character '%c'\n",
633 c);
634 va_end(ap);
635 return 0;
636 }
637 }
638 va_end(ap);
639
640 if (res_type != 'v') {
641 result.length = sizeof(out_obj);
642 result.pointer = &out_obj;
643 resultp = &result;
644 } else
645 resultp = NULL;
646
647 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
648
649 switch (res_type) {
650 case 'd': /* int */
651 success = (status == AE_OK &&
652 out_obj.type == ACPI_TYPE_INTEGER);
653 if (success && res)
654 *res = out_obj.integer.value;
655 break;
656 case 'v': /* void */
657 success = status == AE_OK;
658 break;
659 /* add more types as needed */
660 default:
661 pr_err("acpi_evalf() called with invalid format character '%c'\n",
662 res_type);
663 return 0;
664 }
665
666 if (!success && !quiet)
667 pr_err("acpi_evalf(%s, %s, ...) failed: %s\n",
668 method, fmt0, acpi_format_exception(status));
669
670 return success;
671}
672
673static int acpi_ec_read(int i, u8 *p)
674{
675 int v;
676
677 if (ecrd_handle) {
678 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
679 return 0;
680 *p = v;
681 } else {
682 if (ec_read(i, p) < 0)
683 return 0;
684 }
685
686 return 1;
687}
688
689static int acpi_ec_write(int i, u8 v)
690{
691 if (ecwr_handle) {
692 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
693 return 0;
694 } else {
695 if (ec_write(i, v) < 0)
696 return 0;
697 }
698
699 return 1;
700}
701
702static int issue_thinkpad_cmos_command(int cmos_cmd)
703{
704 if (!cmos_handle)
705 return -ENXIO;
706
707 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
708 return -EIO;
709
710 return 0;
711}
712
713/*************************************************************************
714 * ACPI device model
715 */
716
717#define TPACPI_ACPIHANDLE_INIT(object) \
718 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
719 object##_paths, ARRAY_SIZE(object##_paths))
720
721static void __init drv_acpi_handle_init(const char *name,
722 acpi_handle *handle, const acpi_handle parent,
723 char **paths, const int num_paths)
724{
725 int i;
726 acpi_status status;
727
728 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
729 name);
730
731 for (i = 0; i < num_paths; i++) {
732 status = acpi_get_handle(parent, paths[i], handle);
733 if (ACPI_SUCCESS(status)) {
734 dbg_printk(TPACPI_DBG_INIT,
735 "Found ACPI handle %s for %s\n",
736 paths[i], name);
737 return;
738 }
739 }
740
741 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
742 name);
743 *handle = NULL;
744}
745
746static acpi_status __init tpacpi_acpi_handle_locate_callback(acpi_handle handle,
747 u32 level, void *context, void **return_value)
748{
749 if (!strcmp(context, "video")) {
750 struct acpi_device *dev = acpi_fetch_acpi_dev(handle);
751
752 if (!dev || strcmp(ACPI_VIDEO_HID, acpi_device_hid(dev)))
753 return AE_OK;
754 }
755
756 *(acpi_handle *)return_value = handle;
757
758 return AE_CTRL_TERMINATE;
759}
760
761static void __init tpacpi_acpi_handle_locate(const char *name,
762 const char *hid,
763 acpi_handle *handle)
764{
765 acpi_status status;
766 acpi_handle device_found;
767
768 BUG_ON(!name || !handle);
769 vdbg_printk(TPACPI_DBG_INIT,
770 "trying to locate ACPI handle for %s, using HID %s\n",
771 name, hid ? hid : "NULL");
772
773 memset(&device_found, 0, sizeof(device_found));
774 status = acpi_get_devices(hid, tpacpi_acpi_handle_locate_callback,
775 (void *)name, &device_found);
776
777 *handle = NULL;
778
779 if (ACPI_SUCCESS(status)) {
780 *handle = device_found;
781 dbg_printk(TPACPI_DBG_INIT,
782 "Found ACPI handle for %s\n", name);
783 } else {
784 vdbg_printk(TPACPI_DBG_INIT,
785 "Could not locate an ACPI handle for %s: %s\n",
786 name, acpi_format_exception(status));
787 }
788}
789
790static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
791{
792 struct ibm_struct *ibm = data;
793
794 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
795 return;
796
797 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
798 return;
799
800 ibm->acpi->notify(ibm, event);
801}
802
803static int __init setup_acpi_notify(struct ibm_struct *ibm)
804{
805 acpi_status status;
806
807 BUG_ON(!ibm->acpi);
808
809 if (!*ibm->acpi->handle)
810 return 0;
811
812 vdbg_printk(TPACPI_DBG_INIT,
813 "setting up ACPI notify for %s\n", ibm->name);
814
815 ibm->acpi->device = acpi_fetch_acpi_dev(*ibm->acpi->handle);
816 if (!ibm->acpi->device) {
817 pr_err("acpi_fetch_acpi_dev(%s) failed\n", ibm->name);
818 return -ENODEV;
819 }
820
821 ibm->acpi->device->driver_data = ibm;
822 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
823 TPACPI_ACPI_EVENT_PREFIX,
824 ibm->name);
825
826 status = acpi_install_notify_handler(*ibm->acpi->handle,
827 ibm->acpi->type, dispatch_acpi_notify, ibm);
828 if (ACPI_FAILURE(status)) {
829 if (status == AE_ALREADY_EXISTS) {
830 pr_notice("another device driver is already handling %s events\n",
831 ibm->name);
832 } else {
833 pr_err("acpi_install_notify_handler(%s) failed: %s\n",
834 ibm->name, acpi_format_exception(status));
835 }
836 return -ENODEV;
837 }
838 ibm->flags.acpi_notify_installed = 1;
839 return 0;
840}
841
842static int __init tpacpi_device_add(struct acpi_device *device)
843{
844 return 0;
845}
846
847static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
848{
849 int rc;
850
851 dbg_printk(TPACPI_DBG_INIT,
852 "registering %s as an ACPI driver\n", ibm->name);
853
854 BUG_ON(!ibm->acpi);
855
856 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
857 if (!ibm->acpi->driver) {
858 pr_err("failed to allocate memory for ibm->acpi->driver\n");
859 return -ENOMEM;
860 }
861
862 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
863 ibm->acpi->driver->ids = ibm->acpi->hid;
864
865 ibm->acpi->driver->ops.add = &tpacpi_device_add;
866
867 rc = acpi_bus_register_driver(ibm->acpi->driver);
868 if (rc < 0) {
869 pr_err("acpi_bus_register_driver(%s) failed: %d\n",
870 ibm->name, rc);
871 kfree(ibm->acpi->driver);
872 ibm->acpi->driver = NULL;
873 } else if (!rc)
874 ibm->flags.acpi_driver_registered = 1;
875
876 return rc;
877}
878
879
880/****************************************************************************
881 ****************************************************************************
882 *
883 * Procfs Helpers
884 *
885 ****************************************************************************
886 ****************************************************************************/
887
888static int dispatch_proc_show(struct seq_file *m, void *v)
889{
890 struct ibm_struct *ibm = m->private;
891
892 if (!ibm || !ibm->read)
893 return -EINVAL;
894 return ibm->read(m);
895}
896
897static int dispatch_proc_open(struct inode *inode, struct file *file)
898{
899 return single_open(file, dispatch_proc_show, pde_data(inode));
900}
901
902static ssize_t dispatch_proc_write(struct file *file,
903 const char __user *userbuf,
904 size_t count, loff_t *pos)
905{
906 struct ibm_struct *ibm = pde_data(file_inode(file));
907 char *kernbuf;
908 int ret;
909
910 if (!ibm || !ibm->write)
911 return -EINVAL;
912 if (count > PAGE_SIZE - 1)
913 return -EINVAL;
914
915 kernbuf = kmalloc(count + 1, GFP_KERNEL);
916 if (!kernbuf)
917 return -ENOMEM;
918
919 if (copy_from_user(kernbuf, userbuf, count)) {
920 kfree(kernbuf);
921 return -EFAULT;
922 }
923
924 kernbuf[count] = 0;
925 ret = ibm->write(kernbuf);
926 if (ret == 0)
927 ret = count;
928
929 kfree(kernbuf);
930
931 return ret;
932}
933
934static const struct proc_ops dispatch_proc_ops = {
935 .proc_open = dispatch_proc_open,
936 .proc_read = seq_read,
937 .proc_lseek = seq_lseek,
938 .proc_release = single_release,
939 .proc_write = dispatch_proc_write,
940};
941
942/****************************************************************************
943 ****************************************************************************
944 *
945 * Device model: input, hwmon and platform
946 *
947 ****************************************************************************
948 ****************************************************************************/
949
950static struct platform_device *tpacpi_pdev;
951static struct platform_device *tpacpi_sensors_pdev;
952static struct device *tpacpi_hwmon;
953static struct input_dev *tpacpi_inputdev;
954static struct mutex tpacpi_inputdev_send_mutex;
955static LIST_HEAD(tpacpi_all_drivers);
956
957#ifdef CONFIG_PM_SLEEP
958static int tpacpi_suspend_handler(struct device *dev)
959{
960 struct ibm_struct *ibm, *itmp;
961
962 list_for_each_entry_safe(ibm, itmp,
963 &tpacpi_all_drivers,
964 all_drivers) {
965 if (ibm->suspend)
966 (ibm->suspend)();
967 }
968
969 return 0;
970}
971
972static int tpacpi_resume_handler(struct device *dev)
973{
974 struct ibm_struct *ibm, *itmp;
975
976 list_for_each_entry_safe(ibm, itmp,
977 &tpacpi_all_drivers,
978 all_drivers) {
979 if (ibm->resume)
980 (ibm->resume)();
981 }
982
983 return 0;
984}
985#endif
986
987static SIMPLE_DEV_PM_OPS(tpacpi_pm,
988 tpacpi_suspend_handler, tpacpi_resume_handler);
989
990static void tpacpi_shutdown_handler(struct platform_device *pdev)
991{
992 struct ibm_struct *ibm, *itmp;
993
994 list_for_each_entry_safe(ibm, itmp,
995 &tpacpi_all_drivers,
996 all_drivers) {
997 if (ibm->shutdown)
998 (ibm->shutdown)();
999 }
1000}
1001
1002/*************************************************************************
1003 * sysfs support helpers
1004 */
1005
1006static int parse_strtoul(const char *buf,
1007 unsigned long max, unsigned long *value)
1008{
1009 char *endp;
1010
1011 *value = simple_strtoul(skip_spaces(buf), &endp, 0);
1012 endp = skip_spaces(endp);
1013 if (*endp || *value > max)
1014 return -EINVAL;
1015
1016 return 0;
1017}
1018
1019static void tpacpi_disable_brightness_delay(void)
1020{
1021 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1022 pr_notice("ACPI backlight control delay disabled\n");
1023}
1024
1025static void printk_deprecated_attribute(const char * const what,
1026 const char * const details)
1027{
1028 tpacpi_log_usertask("deprecated sysfs attribute");
1029 pr_warn("WARNING: sysfs attribute %s is deprecated and will be removed. %s\n",
1030 what, details);
1031}
1032
1033/*************************************************************************
1034 * rfkill and radio control support helpers
1035 */
1036
1037/*
1038 * ThinkPad-ACPI firmware handling model:
1039 *
1040 * WLSW (master wireless switch) is event-driven, and is common to all
1041 * firmware-controlled radios. It cannot be controlled, just monitored,
1042 * as expected. It overrides all radio state in firmware
1043 *
1044 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1045 * (TODO: verify how WLSW interacts with the returned radio state).
1046 *
1047 * The only time there are shadow radio state changes, is when
1048 * masked-off hotkeys are used.
1049 */
1050
1051/*
1052 * Internal driver API for radio state:
1053 *
1054 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1055 * bool: true means radio blocked (off)
1056 */
1057enum tpacpi_rfkill_state {
1058 TPACPI_RFK_RADIO_OFF = 0,
1059 TPACPI_RFK_RADIO_ON
1060};
1061
1062/* rfkill switches */
1063enum tpacpi_rfk_id {
1064 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1065 TPACPI_RFK_WWAN_SW_ID,
1066 TPACPI_RFK_UWB_SW_ID,
1067 TPACPI_RFK_SW_MAX
1068};
1069
1070static const char *tpacpi_rfkill_names[] = {
1071 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1072 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1073 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1074 [TPACPI_RFK_SW_MAX] = NULL
1075};
1076
1077/* ThinkPad-ACPI rfkill subdriver */
1078struct tpacpi_rfk {
1079 struct rfkill *rfkill;
1080 enum tpacpi_rfk_id id;
1081 const struct tpacpi_rfk_ops *ops;
1082};
1083
1084struct tpacpi_rfk_ops {
1085 /* firmware interface */
1086 int (*get_status)(void);
1087 int (*set_status)(const enum tpacpi_rfkill_state);
1088};
1089
1090static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1091
1092/* Query FW and update rfkill sw state for a given rfkill switch */
1093static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1094{
1095 int status;
1096
1097 if (!tp_rfk)
1098 return -ENODEV;
1099
1100 status = (tp_rfk->ops->get_status)();
1101 if (status < 0)
1102 return status;
1103
1104 rfkill_set_sw_state(tp_rfk->rfkill,
1105 (status == TPACPI_RFK_RADIO_OFF));
1106
1107 return status;
1108}
1109
1110/*
1111 * Sync the HW-blocking state of all rfkill switches,
1112 * do notice it causes the rfkill core to schedule uevents
1113 */
1114static void tpacpi_rfk_update_hwblock_state(bool blocked)
1115{
1116 unsigned int i;
1117 struct tpacpi_rfk *tp_rfk;
1118
1119 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1120 tp_rfk = tpacpi_rfkill_switches[i];
1121 if (tp_rfk) {
1122 if (rfkill_set_hw_state(tp_rfk->rfkill,
1123 blocked)) {
1124 /* ignore -- we track sw block */
1125 }
1126 }
1127 }
1128}
1129
1130/* Call to get the WLSW state from the firmware */
1131static int hotkey_get_wlsw(void);
1132
1133/* Call to query WLSW state and update all rfkill switches */
1134static bool tpacpi_rfk_check_hwblock_state(void)
1135{
1136 int res = hotkey_get_wlsw();
1137 int hw_blocked;
1138
1139 /* When unknown or unsupported, we have to assume it is unblocked */
1140 if (res < 0)
1141 return false;
1142
1143 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1144 tpacpi_rfk_update_hwblock_state(hw_blocked);
1145
1146 return hw_blocked;
1147}
1148
1149static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1150{
1151 struct tpacpi_rfk *tp_rfk = data;
1152 int res;
1153
1154 dbg_printk(TPACPI_DBG_RFKILL,
1155 "request to change radio state to %s\n",
1156 blocked ? "blocked" : "unblocked");
1157
1158 /* try to set radio state */
1159 res = (tp_rfk->ops->set_status)(blocked ?
1160 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1161
1162 /* and update the rfkill core with whatever the FW really did */
1163 tpacpi_rfk_update_swstate(tp_rfk);
1164
1165 return (res < 0) ? res : 0;
1166}
1167
1168static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1169 .set_block = tpacpi_rfk_hook_set_block,
1170};
1171
1172static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1173 const struct tpacpi_rfk_ops *tp_rfkops,
1174 const enum rfkill_type rfktype,
1175 const char *name,
1176 const bool set_default)
1177{
1178 struct tpacpi_rfk *atp_rfk;
1179 int res;
1180 bool sw_state = false;
1181 bool hw_state;
1182 int sw_status;
1183
1184 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1185
1186 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1187 if (atp_rfk)
1188 atp_rfk->rfkill = rfkill_alloc(name,
1189 &tpacpi_pdev->dev,
1190 rfktype,
1191 &tpacpi_rfk_rfkill_ops,
1192 atp_rfk);
1193 if (!atp_rfk || !atp_rfk->rfkill) {
1194 pr_err("failed to allocate memory for rfkill class\n");
1195 kfree(atp_rfk);
1196 return -ENOMEM;
1197 }
1198
1199 atp_rfk->id = id;
1200 atp_rfk->ops = tp_rfkops;
1201
1202 sw_status = (tp_rfkops->get_status)();
1203 if (sw_status < 0) {
1204 pr_err("failed to read initial state for %s, error %d\n",
1205 name, sw_status);
1206 } else {
1207 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1208 if (set_default) {
1209 /* try to keep the initial state, since we ask the
1210 * firmware to preserve it across S5 in NVRAM */
1211 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1212 }
1213 }
1214 hw_state = tpacpi_rfk_check_hwblock_state();
1215 rfkill_set_hw_state(atp_rfk->rfkill, hw_state);
1216
1217 res = rfkill_register(atp_rfk->rfkill);
1218 if (res < 0) {
1219 pr_err("failed to register %s rfkill switch: %d\n", name, res);
1220 rfkill_destroy(atp_rfk->rfkill);
1221 kfree(atp_rfk);
1222 return res;
1223 }
1224
1225 tpacpi_rfkill_switches[id] = atp_rfk;
1226
1227 pr_info("rfkill switch %s: radio is %sblocked\n",
1228 name, (sw_state || hw_state) ? "" : "un");
1229 return 0;
1230}
1231
1232static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1233{
1234 struct tpacpi_rfk *tp_rfk;
1235
1236 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1237
1238 tp_rfk = tpacpi_rfkill_switches[id];
1239 if (tp_rfk) {
1240 rfkill_unregister(tp_rfk->rfkill);
1241 rfkill_destroy(tp_rfk->rfkill);
1242 tpacpi_rfkill_switches[id] = NULL;
1243 kfree(tp_rfk);
1244 }
1245}
1246
1247static void printk_deprecated_rfkill_attribute(const char * const what)
1248{
1249 printk_deprecated_attribute(what,
1250 "Please switch to generic rfkill before year 2010");
1251}
1252
1253/* sysfs <radio> enable ------------------------------------------------ */
1254static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1255 struct device_attribute *attr,
1256 char *buf)
1257{
1258 int status;
1259
1260 printk_deprecated_rfkill_attribute(attr->attr.name);
1261
1262 /* This is in the ABI... */
1263 if (tpacpi_rfk_check_hwblock_state()) {
1264 status = TPACPI_RFK_RADIO_OFF;
1265 } else {
1266 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1267 if (status < 0)
1268 return status;
1269 }
1270
1271 return sysfs_emit(buf, "%d\n",
1272 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1273}
1274
1275static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1276 struct device_attribute *attr,
1277 const char *buf, size_t count)
1278{
1279 unsigned long t;
1280 int res;
1281
1282 printk_deprecated_rfkill_attribute(attr->attr.name);
1283
1284 if (parse_strtoul(buf, 1, &t))
1285 return -EINVAL;
1286
1287 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1288
1289 /* This is in the ABI... */
1290 if (tpacpi_rfk_check_hwblock_state() && !!t)
1291 return -EPERM;
1292
1293 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1294 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1295 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1296
1297 return (res < 0) ? res : count;
1298}
1299
1300/* procfs -------------------------------------------------------------- */
1301static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, struct seq_file *m)
1302{
1303 if (id >= TPACPI_RFK_SW_MAX)
1304 seq_printf(m, "status:\t\tnot supported\n");
1305 else {
1306 int status;
1307
1308 /* This is in the ABI... */
1309 if (tpacpi_rfk_check_hwblock_state()) {
1310 status = TPACPI_RFK_RADIO_OFF;
1311 } else {
1312 status = tpacpi_rfk_update_swstate(
1313 tpacpi_rfkill_switches[id]);
1314 if (status < 0)
1315 return status;
1316 }
1317
1318 seq_printf(m, "status:\t\t%s\n", str_enabled_disabled(status == TPACPI_RFK_RADIO_ON));
1319 seq_printf(m, "commands:\tenable, disable\n");
1320 }
1321
1322 return 0;
1323}
1324
1325static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1326{
1327 char *cmd;
1328 int status = -1;
1329 int res = 0;
1330
1331 if (id >= TPACPI_RFK_SW_MAX)
1332 return -ENODEV;
1333
1334 while ((cmd = strsep(&buf, ","))) {
1335 if (strstarts(cmd, "enable"))
1336 status = TPACPI_RFK_RADIO_ON;
1337 else if (strstarts(cmd, "disable"))
1338 status = TPACPI_RFK_RADIO_OFF;
1339 else
1340 return -EINVAL;
1341 }
1342
1343 if (status != -1) {
1344 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1345 str_enable_disable(status == TPACPI_RFK_RADIO_ON),
1346 tpacpi_rfkill_names[id]);
1347 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1348 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1349 }
1350
1351 return res;
1352}
1353
1354/*************************************************************************
1355 * thinkpad-acpi driver attributes
1356 */
1357
1358/* interface_version --------------------------------------------------- */
1359static ssize_t interface_version_show(struct device_driver *drv, char *buf)
1360{
1361 return sysfs_emit(buf, "0x%08x\n", TPACPI_SYSFS_VERSION);
1362}
1363static DRIVER_ATTR_RO(interface_version);
1364
1365/* debug_level --------------------------------------------------------- */
1366static ssize_t debug_level_show(struct device_driver *drv, char *buf)
1367{
1368 return sysfs_emit(buf, "0x%04x\n", dbg_level);
1369}
1370
1371static ssize_t debug_level_store(struct device_driver *drv, const char *buf,
1372 size_t count)
1373{
1374 unsigned long t;
1375
1376 if (parse_strtoul(buf, 0xffff, &t))
1377 return -EINVAL;
1378
1379 dbg_level = t;
1380
1381 return count;
1382}
1383static DRIVER_ATTR_RW(debug_level);
1384
1385/* version ------------------------------------------------------------- */
1386static ssize_t version_show(struct device_driver *drv, char *buf)
1387{
1388 return sysfs_emit(buf, "%s v%s\n",
1389 TPACPI_DESC, TPACPI_VERSION);
1390}
1391static DRIVER_ATTR_RO(version);
1392
1393/* --------------------------------------------------------------------- */
1394
1395#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1396
1397/* wlsw_emulstate ------------------------------------------------------ */
1398static ssize_t wlsw_emulstate_show(struct device_driver *drv, char *buf)
1399{
1400 return sysfs_emit(buf, "%d\n", !!tpacpi_wlsw_emulstate);
1401}
1402
1403static ssize_t wlsw_emulstate_store(struct device_driver *drv, const char *buf,
1404 size_t count)
1405{
1406 unsigned long t;
1407
1408 if (parse_strtoul(buf, 1, &t))
1409 return -EINVAL;
1410
1411 if (tpacpi_wlsw_emulstate != !!t) {
1412 tpacpi_wlsw_emulstate = !!t;
1413 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1414 }
1415
1416 return count;
1417}
1418static DRIVER_ATTR_RW(wlsw_emulstate);
1419
1420/* bluetooth_emulstate ------------------------------------------------- */
1421static ssize_t bluetooth_emulstate_show(struct device_driver *drv, char *buf)
1422{
1423 return sysfs_emit(buf, "%d\n", !!tpacpi_bluetooth_emulstate);
1424}
1425
1426static ssize_t bluetooth_emulstate_store(struct device_driver *drv,
1427 const char *buf, size_t count)
1428{
1429 unsigned long t;
1430
1431 if (parse_strtoul(buf, 1, &t))
1432 return -EINVAL;
1433
1434 tpacpi_bluetooth_emulstate = !!t;
1435
1436 return count;
1437}
1438static DRIVER_ATTR_RW(bluetooth_emulstate);
1439
1440/* wwan_emulstate ------------------------------------------------- */
1441static ssize_t wwan_emulstate_show(struct device_driver *drv, char *buf)
1442{
1443 return sysfs_emit(buf, "%d\n", !!tpacpi_wwan_emulstate);
1444}
1445
1446static ssize_t wwan_emulstate_store(struct device_driver *drv, const char *buf,
1447 size_t count)
1448{
1449 unsigned long t;
1450
1451 if (parse_strtoul(buf, 1, &t))
1452 return -EINVAL;
1453
1454 tpacpi_wwan_emulstate = !!t;
1455
1456 return count;
1457}
1458static DRIVER_ATTR_RW(wwan_emulstate);
1459
1460/* uwb_emulstate ------------------------------------------------- */
1461static ssize_t uwb_emulstate_show(struct device_driver *drv, char *buf)
1462{
1463 return sysfs_emit(buf, "%d\n", !!tpacpi_uwb_emulstate);
1464}
1465
1466static ssize_t uwb_emulstate_store(struct device_driver *drv, const char *buf,
1467 size_t count)
1468{
1469 unsigned long t;
1470
1471 if (parse_strtoul(buf, 1, &t))
1472 return -EINVAL;
1473
1474 tpacpi_uwb_emulstate = !!t;
1475
1476 return count;
1477}
1478static DRIVER_ATTR_RW(uwb_emulstate);
1479#endif
1480
1481/*************************************************************************
1482 * Firmware Data
1483 */
1484
1485/*
1486 * Table of recommended minimum BIOS versions
1487 *
1488 * Reasons for listing:
1489 * 1. Stable BIOS, listed because the unknown amount of
1490 * bugs and bad ACPI behaviour on older versions
1491 *
1492 * 2. BIOS or EC fw with known bugs that trigger on Linux
1493 *
1494 * 3. BIOS with known reduced functionality in older versions
1495 *
1496 * We recommend the latest BIOS and EC version.
1497 * We only support the latest BIOS and EC fw version as a rule.
1498 *
1499 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1500 * Information from users in ThinkWiki
1501 *
1502 * WARNING: we use this table also to detect that the machine is
1503 * a ThinkPad in some cases, so don't remove entries lightly.
1504 */
1505
1506#define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1507 { .vendor = (__v), \
1508 .bios = TPID(__id1, __id2), \
1509 .ec = TPACPI_MATCH_ANY, \
1510 .quirks = TPACPI_MATCH_ANY_VERSION << 16 \
1511 | TPVER(__bv1, __bv2) }
1512
1513#define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1514 __eid, __ev1, __ev2) \
1515 { .vendor = (__v), \
1516 .bios = TPID(__bid1, __bid2), \
1517 .ec = __eid, \
1518 .quirks = TPVER(__ev1, __ev2) << 16 \
1519 | TPVER(__bv1, __bv2) }
1520
1521#define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1522 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1523
1524/* Outdated IBM BIOSes often lack the EC id string */
1525#define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1526 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1527 __bv1, __bv2, TPID(__id1, __id2), \
1528 __ev1, __ev2), \
1529 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1530 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1531 __ev1, __ev2)
1532
1533/* Outdated IBM BIOSes often lack the EC id string */
1534#define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1535 __eid1, __eid2, __ev1, __ev2) \
1536 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1537 __bv1, __bv2, TPID(__eid1, __eid2), \
1538 __ev1, __ev2), \
1539 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1540 __bv1, __bv2, TPACPI_MATCH_UNKNOWN, \
1541 __ev1, __ev2)
1542
1543#define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1544 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1545
1546#define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1547 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1548 __bv1, __bv2, TPID(__id1, __id2), \
1549 __ev1, __ev2)
1550
1551#define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1552 __eid1, __eid2, __ev1, __ev2) \
1553 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1554 __bv1, __bv2, TPID(__eid1, __eid2), \
1555 __ev1, __ev2)
1556
1557static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1558 /* Numeric models ------------------ */
1559 /* FW MODEL BIOS VERS */
1560 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1561 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1562 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1563 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1564 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1565 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1566 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1567 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1568 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1569
1570 /* A-series ------------------------- */
1571 /* FW MODEL BIOS VERS EC VERS */
1572 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1573 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1574 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1575 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1576 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1577 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1578 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1579 TPV_QI0('1', '3', '2', '0'), /* A22m */
1580 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1581 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1582 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1583
1584 /* G-series ------------------------- */
1585 /* FW MODEL BIOS VERS */
1586 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1587 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1588
1589 /* R-series, T-series --------------- */
1590 /* FW MODEL BIOS VERS EC VERS */
1591 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1592 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1593 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1594 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1595 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1596 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1597 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1598 T40/p, T41/p, T42/p (1) */
1599 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1600 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1601 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1602 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1603
1604 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1605 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1606 TPV_QI0('1', '6', '3', '2'), /* T22 */
1607 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1608 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1609 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1610
1611 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1612 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1613 TPV_QL1('7', 'E', 'D', '0', '1', '5'), /* R60e, R60i */
1614
1615 /* BIOS FW BIOS VERS EC FW EC VERS */
1616 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1617 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1618
1619 /* X-series ------------------------- */
1620 /* FW MODEL BIOS VERS EC VERS */
1621 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1622 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1623 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1624 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1625 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1626 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1627 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1628
1629 TPV_QL1('7', 'B', 'D', '7', '4', '0'), /* X60/s */
1630 TPV_QL1('7', 'J', '3', '0', '1', '3'), /* X60t */
1631
1632 /* (0) - older versions lack DMI EC fw string and functionality */
1633 /* (1) - older versions known to lack functionality */
1634};
1635
1636#undef TPV_QL1
1637#undef TPV_QL0
1638#undef TPV_QI2
1639#undef TPV_QI1
1640#undef TPV_QI0
1641#undef TPV_Q_X
1642#undef TPV_Q
1643
1644static void __init tpacpi_check_outdated_fw(void)
1645{
1646 unsigned long fwvers;
1647 u16 ec_version, bios_version;
1648
1649 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1650 ARRAY_SIZE(tpacpi_bios_version_qtable));
1651
1652 if (!fwvers)
1653 return;
1654
1655 bios_version = fwvers & 0xffffU;
1656 ec_version = (fwvers >> 16) & 0xffffU;
1657
1658 /* note that unknown versions are set to 0x0000 and we use that */
1659 if ((bios_version > thinkpad_id.bios_release) ||
1660 (ec_version > thinkpad_id.ec_release &&
1661 ec_version != TPACPI_MATCH_ANY_VERSION)) {
1662 /*
1663 * The changelogs would let us track down the exact
1664 * reason, but it is just too much of a pain to track
1665 * it. We only list BIOSes that are either really
1666 * broken, or really stable to begin with, so it is
1667 * best if the user upgrades the firmware anyway.
1668 */
1669 pr_warn("WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1670 pr_warn("WARNING: This firmware may be missing critical bug fixes and/or important features\n");
1671 }
1672}
1673
1674static bool __init tpacpi_is_fw_known(void)
1675{
1676 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1677 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1678}
1679
1680/****************************************************************************
1681 ****************************************************************************
1682 *
1683 * Subdrivers
1684 *
1685 ****************************************************************************
1686 ****************************************************************************/
1687
1688/*************************************************************************
1689 * thinkpad-acpi metadata subdriver
1690 */
1691
1692static int thinkpad_acpi_driver_read(struct seq_file *m)
1693{
1694 seq_printf(m, "driver:\t\t%s\n", TPACPI_DESC);
1695 seq_printf(m, "version:\t%s\n", TPACPI_VERSION);
1696 return 0;
1697}
1698
1699static struct ibm_struct thinkpad_acpi_driver_data = {
1700 .name = "driver",
1701 .read = thinkpad_acpi_driver_read,
1702};
1703
1704/*************************************************************************
1705 * Hotkey subdriver
1706 */
1707
1708/*
1709 * ThinkPad firmware event model
1710 *
1711 * The ThinkPad firmware has two main event interfaces: normal ACPI
1712 * notifications (which follow the ACPI standard), and a private event
1713 * interface.
1714 *
1715 * The private event interface also issues events for the hotkeys. As
1716 * the driver gained features, the event handling code ended up being
1717 * built around the hotkey subdriver. This will need to be refactored
1718 * to a more formal event API eventually.
1719 *
1720 * Some "hotkeys" are actually supposed to be used as event reports,
1721 * such as "brightness has changed", "volume has changed", depending on
1722 * the ThinkPad model and how the firmware is operating.
1723 *
1724 * Unlike other classes, hotkey-class events have mask/unmask control on
1725 * non-ancient firmware. However, how it behaves changes a lot with the
1726 * firmware model and version.
1727 */
1728
1729enum { /* hot key scan codes (derived from ACPI DSDT) */
1730 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1731 TP_ACPI_HOTKEYSCAN_FNF2,
1732 TP_ACPI_HOTKEYSCAN_FNF3,
1733 TP_ACPI_HOTKEYSCAN_FNF4,
1734 TP_ACPI_HOTKEYSCAN_FNF5,
1735 TP_ACPI_HOTKEYSCAN_FNF6,
1736 TP_ACPI_HOTKEYSCAN_FNF7,
1737 TP_ACPI_HOTKEYSCAN_FNF8,
1738 TP_ACPI_HOTKEYSCAN_FNF9,
1739 TP_ACPI_HOTKEYSCAN_FNF10,
1740 TP_ACPI_HOTKEYSCAN_FNF11,
1741 TP_ACPI_HOTKEYSCAN_FNF12,
1742 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1743 TP_ACPI_HOTKEYSCAN_FNINSERT,
1744 TP_ACPI_HOTKEYSCAN_FNDELETE,
1745 TP_ACPI_HOTKEYSCAN_FNHOME,
1746 TP_ACPI_HOTKEYSCAN_FNEND,
1747 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1748 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1749 TP_ACPI_HOTKEYSCAN_FNSPACE,
1750 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1751 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1752 TP_ACPI_HOTKEYSCAN_MUTE,
1753 TP_ACPI_HOTKEYSCAN_THINKPAD,
1754 TP_ACPI_HOTKEYSCAN_UNK1,
1755 TP_ACPI_HOTKEYSCAN_UNK2,
1756 TP_ACPI_HOTKEYSCAN_UNK3,
1757 TP_ACPI_HOTKEYSCAN_UNK4,
1758 TP_ACPI_HOTKEYSCAN_UNK5,
1759 TP_ACPI_HOTKEYSCAN_UNK6,
1760 TP_ACPI_HOTKEYSCAN_UNK7,
1761 TP_ACPI_HOTKEYSCAN_UNK8,
1762
1763 /* Adaptive keyboard keycodes */
1764 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1765 TP_ACPI_HOTKEYSCAN_MUTE2 = TP_ACPI_HOTKEYSCAN_ADAPTIVE_START,
1766 TP_ACPI_HOTKEYSCAN_BRIGHTNESS_ZERO,
1767 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL,
1768 TP_ACPI_HOTKEYSCAN_CLOUD,
1769 TP_ACPI_HOTKEYSCAN_UNK9,
1770 TP_ACPI_HOTKEYSCAN_VOICE,
1771 TP_ACPI_HOTKEYSCAN_UNK10,
1772 TP_ACPI_HOTKEYSCAN_GESTURES,
1773 TP_ACPI_HOTKEYSCAN_UNK11,
1774 TP_ACPI_HOTKEYSCAN_UNK12,
1775 TP_ACPI_HOTKEYSCAN_UNK13,
1776 TP_ACPI_HOTKEYSCAN_CONFIG,
1777 TP_ACPI_HOTKEYSCAN_NEW_TAB,
1778 TP_ACPI_HOTKEYSCAN_RELOAD,
1779 TP_ACPI_HOTKEYSCAN_BACK,
1780 TP_ACPI_HOTKEYSCAN_MIC_DOWN,
1781 TP_ACPI_HOTKEYSCAN_MIC_UP,
1782 TP_ACPI_HOTKEYSCAN_MIC_CANCELLATION,
1783 TP_ACPI_HOTKEYSCAN_CAMERA_MODE,
1784 TP_ACPI_HOTKEYSCAN_ROTATE_DISPLAY,
1785
1786 /* Lenovo extended keymap, starting at 0x1300 */
1787 TP_ACPI_HOTKEYSCAN_EXTENDED_START,
1788 /* first new observed key (star, favorites) is 0x1311 */
1789 TP_ACPI_HOTKEYSCAN_STAR = 69,
1790 TP_ACPI_HOTKEYSCAN_CLIPPING_TOOL2,
1791 TP_ACPI_HOTKEYSCAN_CALCULATOR,
1792 TP_ACPI_HOTKEYSCAN_BLUETOOTH,
1793 TP_ACPI_HOTKEYSCAN_KEYBOARD,
1794 TP_ACPI_HOTKEYSCAN_FN_RIGHT_SHIFT, /* Used by "Lenovo Quick Clean" */
1795 TP_ACPI_HOTKEYSCAN_NOTIFICATION_CENTER,
1796 TP_ACPI_HOTKEYSCAN_PICKUP_PHONE,
1797 TP_ACPI_HOTKEYSCAN_HANGUP_PHONE,
1798
1799 /* Hotkey keymap size */
1800 TPACPI_HOTKEY_MAP_LEN
1801};
1802
1803enum { /* Keys/events available through NVRAM polling */
1804 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1805 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1806};
1807
1808enum { /* Positions of some of the keys in hotkey masks */
1809 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1810 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1811 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1812 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1813 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1814 TP_ACPI_HKEY_KBD_LIGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1815 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1816 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1817 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1818 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1819 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1820};
1821
1822enum { /* NVRAM to ACPI HKEY group map */
1823 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1824 TP_ACPI_HKEY_ZOOM_MASK |
1825 TP_ACPI_HKEY_DISPSWTCH_MASK |
1826 TP_ACPI_HKEY_HIBERNATE_MASK,
1827 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1828 TP_ACPI_HKEY_BRGHTDWN_MASK,
1829 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1830 TP_ACPI_HKEY_VOLDWN_MASK |
1831 TP_ACPI_HKEY_MUTE_MASK,
1832};
1833
1834#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1835struct tp_nvram_state {
1836 u16 thinkpad_toggle:1;
1837 u16 zoom_toggle:1;
1838 u16 display_toggle:1;
1839 u16 thinklight_toggle:1;
1840 u16 hibernate_toggle:1;
1841 u16 displayexp_toggle:1;
1842 u16 display_state:1;
1843 u16 brightness_toggle:1;
1844 u16 volume_toggle:1;
1845 u16 mute:1;
1846
1847 u8 brightness_level;
1848 u8 volume_level;
1849};
1850
1851/* kthread for the hotkey poller */
1852static struct task_struct *tpacpi_hotkey_task;
1853
1854/*
1855 * Acquire mutex to write poller control variables as an
1856 * atomic block.
1857 *
1858 * Increment hotkey_config_change when changing them if you
1859 * want the kthread to forget old state.
1860 *
1861 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1862 */
1863static struct mutex hotkey_thread_data_mutex;
1864static unsigned int hotkey_config_change;
1865
1866/*
1867 * hotkey poller control variables
1868 *
1869 * Must be atomic or readers will also need to acquire mutex
1870 *
1871 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
1872 * should be used only when the changes need to be taken as
1873 * a block, OR when one needs to force the kthread to forget
1874 * old state.
1875 */
1876static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
1877static unsigned int hotkey_poll_freq = 10; /* Hz */
1878
1879#define HOTKEY_CONFIG_CRITICAL_START \
1880 do { \
1881 mutex_lock(&hotkey_thread_data_mutex); \
1882 hotkey_config_change++; \
1883 } while (0);
1884#define HOTKEY_CONFIG_CRITICAL_END \
1885 mutex_unlock(&hotkey_thread_data_mutex);
1886
1887#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
1888
1889#define hotkey_source_mask 0U
1890#define HOTKEY_CONFIG_CRITICAL_START
1891#define HOTKEY_CONFIG_CRITICAL_END
1892
1893#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
1894
1895static struct mutex hotkey_mutex;
1896
1897static enum { /* Reasons for waking up */
1898 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
1899 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
1900 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
1901} hotkey_wakeup_reason;
1902
1903static int hotkey_autosleep_ack;
1904
1905static u32 hotkey_orig_mask; /* events the BIOS had enabled */
1906static u32 hotkey_all_mask; /* all events supported in fw */
1907static u32 hotkey_adaptive_all_mask; /* all adaptive events supported in fw */
1908static u32 hotkey_reserved_mask; /* events better left disabled */
1909static u32 hotkey_driver_mask; /* events needed by the driver */
1910static u32 hotkey_user_mask; /* events visible to userspace */
1911static u32 hotkey_acpi_mask; /* events enabled in firmware */
1912
1913static u16 *hotkey_keycode_map;
1914
1915static void tpacpi_driver_event(const unsigned int hkey_event);
1916static void hotkey_driver_event(const unsigned int scancode);
1917static void hotkey_poll_setup(const bool may_warn);
1918
1919/* HKEY.MHKG() return bits */
1920#define TP_HOTKEY_TABLET_MASK (1 << 3)
1921enum {
1922 TP_ACPI_MULTI_MODE_INVALID = 0,
1923 TP_ACPI_MULTI_MODE_UNKNOWN = 1 << 0,
1924 TP_ACPI_MULTI_MODE_LAPTOP = 1 << 1,
1925 TP_ACPI_MULTI_MODE_TABLET = 1 << 2,
1926 TP_ACPI_MULTI_MODE_FLAT = 1 << 3,
1927 TP_ACPI_MULTI_MODE_STAND = 1 << 4,
1928 TP_ACPI_MULTI_MODE_TENT = 1 << 5,
1929 TP_ACPI_MULTI_MODE_STAND_TENT = 1 << 6,
1930};
1931
1932enum {
1933 /* The following modes are considered tablet mode for the purpose of
1934 * reporting the status to userspace. i.e. in all these modes it makes
1935 * sense to disable the laptop input devices such as touchpad and
1936 * keyboard.
1937 */
1938 TP_ACPI_MULTI_MODE_TABLET_LIKE = TP_ACPI_MULTI_MODE_TABLET |
1939 TP_ACPI_MULTI_MODE_STAND |
1940 TP_ACPI_MULTI_MODE_TENT |
1941 TP_ACPI_MULTI_MODE_STAND_TENT,
1942};
1943
1944static int hotkey_get_wlsw(void)
1945{
1946 int status;
1947
1948 if (!tp_features.hotkey_wlsw)
1949 return -ENODEV;
1950
1951#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1952 if (dbg_wlswemul)
1953 return (tpacpi_wlsw_emulstate) ?
1954 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
1955#endif
1956
1957 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
1958 return -EIO;
1959
1960 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
1961}
1962
1963static int hotkey_gmms_get_tablet_mode(int s, int *has_tablet_mode)
1964{
1965 int type = (s >> 16) & 0xffff;
1966 int value = s & 0xffff;
1967 int mode = TP_ACPI_MULTI_MODE_INVALID;
1968 int valid_modes = 0;
1969
1970 if (has_tablet_mode)
1971 *has_tablet_mode = 0;
1972
1973 switch (type) {
1974 case 1:
1975 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1976 TP_ACPI_MULTI_MODE_TABLET |
1977 TP_ACPI_MULTI_MODE_STAND_TENT;
1978 break;
1979 case 2:
1980 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1981 TP_ACPI_MULTI_MODE_FLAT |
1982 TP_ACPI_MULTI_MODE_TABLET |
1983 TP_ACPI_MULTI_MODE_STAND |
1984 TP_ACPI_MULTI_MODE_TENT;
1985 break;
1986 case 3:
1987 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1988 TP_ACPI_MULTI_MODE_FLAT;
1989 break;
1990 case 4:
1991 case 5:
1992 /* In mode 4, FLAT is not specified as a valid mode. However,
1993 * it can be seen at least on the X1 Yoga 2nd Generation.
1994 */
1995 valid_modes = TP_ACPI_MULTI_MODE_LAPTOP |
1996 TP_ACPI_MULTI_MODE_FLAT |
1997 TP_ACPI_MULTI_MODE_TABLET |
1998 TP_ACPI_MULTI_MODE_STAND |
1999 TP_ACPI_MULTI_MODE_TENT;
2000 break;
2001 default:
2002 pr_err("Unknown multi mode status type %d with value 0x%04X, please report this to %s\n",
2003 type, value, TPACPI_MAIL);
2004 return 0;
2005 }
2006
2007 if (has_tablet_mode && (valid_modes & TP_ACPI_MULTI_MODE_TABLET_LIKE))
2008 *has_tablet_mode = 1;
2009
2010 switch (value) {
2011 case 1:
2012 mode = TP_ACPI_MULTI_MODE_LAPTOP;
2013 break;
2014 case 2:
2015 mode = TP_ACPI_MULTI_MODE_FLAT;
2016 break;
2017 case 3:
2018 mode = TP_ACPI_MULTI_MODE_TABLET;
2019 break;
2020 case 4:
2021 if (type == 1)
2022 mode = TP_ACPI_MULTI_MODE_STAND_TENT;
2023 else
2024 mode = TP_ACPI_MULTI_MODE_STAND;
2025 break;
2026 case 5:
2027 mode = TP_ACPI_MULTI_MODE_TENT;
2028 break;
2029 default:
2030 if (type == 5 && value == 0xffff) {
2031 pr_warn("Multi mode status is undetected, assuming laptop\n");
2032 return 0;
2033 }
2034 }
2035
2036 if (!(mode & valid_modes)) {
2037 pr_err("Unknown/reserved multi mode value 0x%04X for type %d, please report this to %s\n",
2038 value, type, TPACPI_MAIL);
2039 return 0;
2040 }
2041
2042 return !!(mode & TP_ACPI_MULTI_MODE_TABLET_LIKE);
2043}
2044
2045static int hotkey_get_tablet_mode(int *status)
2046{
2047 int s;
2048
2049 switch (tp_features.hotkey_tablet) {
2050 case TP_HOTKEY_TABLET_USES_MHKG:
2051 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2052 return -EIO;
2053
2054 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2055 break;
2056 case TP_HOTKEY_TABLET_USES_GMMS:
2057 if (!acpi_evalf(hkey_handle, &s, "GMMS", "dd", 0))
2058 return -EIO;
2059
2060 *status = hotkey_gmms_get_tablet_mode(s, NULL);
2061 break;
2062 default:
2063 break;
2064 }
2065
2066 return 0;
2067}
2068
2069/*
2070 * Reads current event mask from firmware, and updates
2071 * hotkey_acpi_mask accordingly. Also resets any bits
2072 * from hotkey_user_mask that are unavailable to be
2073 * delivered (shadow requirement of the userspace ABI).
2074 *
2075 * Call with hotkey_mutex held
2076 */
2077static int hotkey_mask_get(void)
2078{
2079 if (tp_features.hotkey_mask) {
2080 u32 m = 0;
2081
2082 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2083 return -EIO;
2084
2085 hotkey_acpi_mask = m;
2086 } else {
2087 /* no mask support doesn't mean no event support... */
2088 hotkey_acpi_mask = hotkey_all_mask;
2089 }
2090
2091 /* sync userspace-visible mask */
2092 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2093
2094 return 0;
2095}
2096
2097static void hotkey_mask_warn_incomplete_mask(void)
2098{
2099 /* log only what the user can fix... */
2100 const u32 wantedmask = hotkey_driver_mask &
2101 ~(hotkey_acpi_mask | hotkey_source_mask) &
2102 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2103
2104 if (wantedmask)
2105 pr_notice("required events 0x%08x not enabled!\n", wantedmask);
2106}
2107
2108/*
2109 * Set the firmware mask when supported
2110 *
2111 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2112 *
2113 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2114 *
2115 * Call with hotkey_mutex held
2116 */
2117static int hotkey_mask_set(u32 mask)
2118{
2119 int i;
2120 int rc = 0;
2121
2122 const u32 fwmask = mask & ~hotkey_source_mask;
2123
2124 if (tp_features.hotkey_mask) {
2125 for (i = 0; i < 32; i++) {
2126 if (!acpi_evalf(hkey_handle,
2127 NULL, "MHKM", "vdd", i + 1,
2128 !!(mask & (1 << i)))) {
2129 rc = -EIO;
2130 break;
2131 }
2132 }
2133 }
2134
2135 /*
2136 * We *must* make an inconditional call to hotkey_mask_get to
2137 * refresh hotkey_acpi_mask and update hotkey_user_mask
2138 *
2139 * Take the opportunity to also log when we cannot _enable_
2140 * a given event.
2141 */
2142 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2143 pr_notice("asked for hotkey mask 0x%08x, but firmware forced it to 0x%08x\n",
2144 fwmask, hotkey_acpi_mask);
2145 }
2146
2147 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING)
2148 hotkey_mask_warn_incomplete_mask();
2149
2150 return rc;
2151}
2152
2153/*
2154 * Sets hotkey_user_mask and tries to set the firmware mask
2155 *
2156 * Call with hotkey_mutex held
2157 */
2158static int hotkey_user_mask_set(const u32 mask)
2159{
2160 int rc;
2161
2162 /* Give people a chance to notice they are doing something that
2163 * is bound to go boom on their users sooner or later */
2164 if (!tp_warned.hotkey_mask_ff &&
2165 (mask == 0xffff || mask == 0xffffff ||
2166 mask == 0xffffffff)) {
2167 tp_warned.hotkey_mask_ff = 1;
2168 pr_notice("setting the hotkey mask to 0x%08x is likely not the best way to go about it\n",
2169 mask);
2170 pr_notice("please consider using the driver defaults, and refer to up-to-date thinkpad-acpi documentation\n");
2171 }
2172
2173 /* Try to enable what the user asked for, plus whatever we need.
2174 * this syncs everything but won't enable bits in hotkey_user_mask */
2175 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2176
2177 /* Enable the available bits in hotkey_user_mask */
2178 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2179
2180 return rc;
2181}
2182
2183/*
2184 * Sets the driver hotkey mask.
2185 *
2186 * Can be called even if the hotkey subdriver is inactive
2187 */
2188static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2189{
2190 int rc;
2191
2192 /* Do the right thing if hotkey_init has not been called yet */
2193 if (!tp_features.hotkey) {
2194 hotkey_driver_mask = mask;
2195 return 0;
2196 }
2197
2198 mutex_lock(&hotkey_mutex);
2199
2200 HOTKEY_CONFIG_CRITICAL_START
2201 hotkey_driver_mask = mask;
2202#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2203 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2204#endif
2205 HOTKEY_CONFIG_CRITICAL_END
2206
2207 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2208 ~hotkey_source_mask);
2209 hotkey_poll_setup(true);
2210
2211 mutex_unlock(&hotkey_mutex);
2212
2213 return rc;
2214}
2215
2216static int hotkey_status_get(int *status)
2217{
2218 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2219 return -EIO;
2220
2221 return 0;
2222}
2223
2224static int hotkey_status_set(bool enable)
2225{
2226 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2227 return -EIO;
2228
2229 return 0;
2230}
2231
2232static void tpacpi_input_send_tabletsw(void)
2233{
2234 int state;
2235
2236 if (tp_features.hotkey_tablet &&
2237 !hotkey_get_tablet_mode(&state)) {
2238 mutex_lock(&tpacpi_inputdev_send_mutex);
2239
2240 input_report_switch(tpacpi_inputdev,
2241 SW_TABLET_MODE, !!state);
2242 input_sync(tpacpi_inputdev);
2243
2244 mutex_unlock(&tpacpi_inputdev_send_mutex);
2245 }
2246}
2247
2248/* Do NOT call without validating scancode first */
2249static void tpacpi_input_send_key(const unsigned int scancode)
2250{
2251 const unsigned int keycode = hotkey_keycode_map[scancode];
2252
2253 if (keycode != KEY_RESERVED) {
2254 mutex_lock(&tpacpi_inputdev_send_mutex);
2255
2256 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2257 input_report_key(tpacpi_inputdev, keycode, 1);
2258 input_sync(tpacpi_inputdev);
2259
2260 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN, scancode);
2261 input_report_key(tpacpi_inputdev, keycode, 0);
2262 input_sync(tpacpi_inputdev);
2263
2264 mutex_unlock(&tpacpi_inputdev_send_mutex);
2265 }
2266}
2267
2268/* Do NOT call without validating scancode first */
2269static void tpacpi_input_send_key_masked(const unsigned int scancode)
2270{
2271 hotkey_driver_event(scancode);
2272 if (hotkey_user_mask & (1 << scancode))
2273 tpacpi_input_send_key(scancode);
2274}
2275
2276#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2277static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2278
2279/* Do NOT call without validating scancode first */
2280static void tpacpi_hotkey_send_key(unsigned int scancode)
2281{
2282 tpacpi_input_send_key_masked(scancode);
2283}
2284
2285static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2286{
2287 u8 d;
2288
2289 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2290 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2291 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2292 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2293 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2294 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2295 }
2296 if (m & TP_ACPI_HKEY_KBD_LIGHT_MASK) {
2297 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2298 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2299 }
2300 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2301 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2302 n->displayexp_toggle =
2303 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2304 }
2305 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2306 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2307 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2308 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2309 n->brightness_toggle =
2310 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2311 }
2312 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2313 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2314 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2315 >> TP_NVRAM_POS_LEVEL_VOLUME;
2316 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2317 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2318 }
2319}
2320
2321#define TPACPI_COMPARE_KEY(__scancode, __member) \
2322do { \
2323 if ((event_mask & (1 << __scancode)) && \
2324 oldn->__member != newn->__member) \
2325 tpacpi_hotkey_send_key(__scancode); \
2326} while (0)
2327
2328#define TPACPI_MAY_SEND_KEY(__scancode) \
2329do { \
2330 if (event_mask & (1 << __scancode)) \
2331 tpacpi_hotkey_send_key(__scancode); \
2332} while (0)
2333
2334static void issue_volchange(const unsigned int oldvol,
2335 const unsigned int newvol,
2336 const u32 event_mask)
2337{
2338 unsigned int i = oldvol;
2339
2340 while (i > newvol) {
2341 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2342 i--;
2343 }
2344 while (i < newvol) {
2345 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2346 i++;
2347 }
2348}
2349
2350static void issue_brightnesschange(const unsigned int oldbrt,
2351 const unsigned int newbrt,
2352 const u32 event_mask)
2353{
2354 unsigned int i = oldbrt;
2355
2356 while (i > newbrt) {
2357 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2358 i--;
2359 }
2360 while (i < newbrt) {
2361 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2362 i++;
2363 }
2364}
2365
2366static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2367 struct tp_nvram_state *newn,
2368 const u32 event_mask)
2369{
2370
2371 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2372 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2373 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2374 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2375
2376 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2377
2378 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2379
2380 /*
2381 * Handle volume
2382 *
2383 * This code is supposed to duplicate the IBM firmware behaviour:
2384 * - Pressing MUTE issues mute hotkey message, even when already mute
2385 * - Pressing Volume up/down issues volume up/down hotkey messages,
2386 * even when already at maximum or minimum volume
2387 * - The act of unmuting issues volume up/down notification,
2388 * depending which key was used to unmute
2389 *
2390 * We are constrained to what the NVRAM can tell us, which is not much
2391 * and certainly not enough if more than one volume hotkey was pressed
2392 * since the last poll cycle.
2393 *
2394 * Just to make our life interesting, some newer Lenovo ThinkPads have
2395 * bugs in the BIOS and may fail to update volume_toggle properly.
2396 */
2397 if (newn->mute) {
2398 /* muted */
2399 if (!oldn->mute ||
2400 oldn->volume_toggle != newn->volume_toggle ||
2401 oldn->volume_level != newn->volume_level) {
2402 /* recently muted, or repeated mute keypress, or
2403 * multiple presses ending in mute */
2404 issue_volchange(oldn->volume_level, newn->volume_level,
2405 event_mask);
2406 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2407 }
2408 } else {
2409 /* unmute */
2410 if (oldn->mute) {
2411 /* recently unmuted, issue 'unmute' keypress */
2412 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2413 }
2414 if (oldn->volume_level != newn->volume_level) {
2415 issue_volchange(oldn->volume_level, newn->volume_level,
2416 event_mask);
2417 } else if (oldn->volume_toggle != newn->volume_toggle) {
2418 /* repeated vol up/down keypress at end of scale ? */
2419 if (newn->volume_level == 0)
2420 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2421 else if (newn->volume_level >= TP_NVRAM_LEVEL_VOLUME_MAX)
2422 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2423 }
2424 }
2425
2426 /* handle brightness */
2427 if (oldn->brightness_level != newn->brightness_level) {
2428 issue_brightnesschange(oldn->brightness_level,
2429 newn->brightness_level, event_mask);
2430 } else if (oldn->brightness_toggle != newn->brightness_toggle) {
2431 /* repeated key presses that didn't change state */
2432 if (newn->brightness_level == 0)
2433 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2434 else if (newn->brightness_level >= bright_maxlvl
2435 && !tp_features.bright_unkfw)
2436 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2437 }
2438
2439#undef TPACPI_COMPARE_KEY
2440#undef TPACPI_MAY_SEND_KEY
2441}
2442
2443/*
2444 * Polling driver
2445 *
2446 * We track all events in hotkey_source_mask all the time, since
2447 * most of them are edge-based. We only issue those requested by
2448 * hotkey_user_mask or hotkey_driver_mask, though.
2449 */
2450static int hotkey_kthread(void *data)
2451{
2452 struct tp_nvram_state s[2] = { 0 };
2453 u32 poll_mask, event_mask;
2454 unsigned int si, so;
2455 unsigned long t;
2456 unsigned int change_detector;
2457 unsigned int poll_freq;
2458 bool was_frozen;
2459
2460 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2461 goto exit;
2462
2463 set_freezable();
2464
2465 so = 0;
2466 si = 1;
2467 t = 0;
2468
2469 /* Initial state for compares */
2470 mutex_lock(&hotkey_thread_data_mutex);
2471 change_detector = hotkey_config_change;
2472 poll_mask = hotkey_source_mask;
2473 event_mask = hotkey_source_mask &
2474 (hotkey_driver_mask | hotkey_user_mask);
2475 poll_freq = hotkey_poll_freq;
2476 mutex_unlock(&hotkey_thread_data_mutex);
2477 hotkey_read_nvram(&s[so], poll_mask);
2478
2479 while (!kthread_should_stop()) {
2480 if (t == 0) {
2481 if (likely(poll_freq))
2482 t = 1000/poll_freq;
2483 else
2484 t = 100; /* should never happen... */
2485 }
2486 t = msleep_interruptible(t);
2487 if (unlikely(kthread_freezable_should_stop(&was_frozen)))
2488 break;
2489
2490 if (t > 0 && !was_frozen)
2491 continue;
2492
2493 mutex_lock(&hotkey_thread_data_mutex);
2494 if (was_frozen || hotkey_config_change != change_detector) {
2495 /* forget old state on thaw or config change */
2496 si = so;
2497 t = 0;
2498 change_detector = hotkey_config_change;
2499 }
2500 poll_mask = hotkey_source_mask;
2501 event_mask = hotkey_source_mask &
2502 (hotkey_driver_mask | hotkey_user_mask);
2503 poll_freq = hotkey_poll_freq;
2504 mutex_unlock(&hotkey_thread_data_mutex);
2505
2506 if (likely(poll_mask)) {
2507 hotkey_read_nvram(&s[si], poll_mask);
2508 if (likely(si != so)) {
2509 hotkey_compare_and_issue_event(&s[so], &s[si],
2510 event_mask);
2511 }
2512 }
2513
2514 so = si;
2515 si ^= 1;
2516 }
2517
2518exit:
2519 return 0;
2520}
2521
2522/* call with hotkey_mutex held */
2523static void hotkey_poll_stop_sync(void)
2524{
2525 if (tpacpi_hotkey_task) {
2526 kthread_stop(tpacpi_hotkey_task);
2527 tpacpi_hotkey_task = NULL;
2528 }
2529}
2530
2531/* call with hotkey_mutex held */
2532static void hotkey_poll_setup(const bool may_warn)
2533{
2534 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2535 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2536
2537 if (hotkey_poll_freq > 0 &&
2538 (poll_driver_mask ||
2539 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2540 if (!tpacpi_hotkey_task) {
2541 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2542 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2543 if (IS_ERR(tpacpi_hotkey_task)) {
2544 tpacpi_hotkey_task = NULL;
2545 pr_err("could not create kernel thread for hotkey polling\n");
2546 }
2547 }
2548 } else {
2549 hotkey_poll_stop_sync();
2550 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2551 hotkey_poll_freq == 0) {
2552 pr_notice("hot keys 0x%08x and/or events 0x%08x require polling, which is currently disabled\n",
2553 poll_user_mask, poll_driver_mask);
2554 }
2555 }
2556}
2557
2558static void hotkey_poll_setup_safe(const bool may_warn)
2559{
2560 mutex_lock(&hotkey_mutex);
2561 hotkey_poll_setup(may_warn);
2562 mutex_unlock(&hotkey_mutex);
2563}
2564
2565/* call with hotkey_mutex held */
2566static void hotkey_poll_set_freq(unsigned int freq)
2567{
2568 if (!freq)
2569 hotkey_poll_stop_sync();
2570
2571 hotkey_poll_freq = freq;
2572}
2573
2574#else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2575
2576static void hotkey_poll_setup(const bool __unused)
2577{
2578}
2579
2580static void hotkey_poll_setup_safe(const bool __unused)
2581{
2582}
2583
2584#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2585
2586static int hotkey_inputdev_open(struct input_dev *dev)
2587{
2588 switch (tpacpi_lifecycle) {
2589 case TPACPI_LIFE_INIT:
2590 case TPACPI_LIFE_RUNNING:
2591 hotkey_poll_setup_safe(false);
2592 return 0;
2593 case TPACPI_LIFE_EXITING:
2594 return -EBUSY;
2595 }
2596
2597 /* Should only happen if tpacpi_lifecycle is corrupt */
2598 BUG();
2599 return -EBUSY;
2600}
2601
2602static void hotkey_inputdev_close(struct input_dev *dev)
2603{
2604 /* disable hotkey polling when possible */
2605 if (tpacpi_lifecycle != TPACPI_LIFE_EXITING &&
2606 !(hotkey_source_mask & hotkey_driver_mask))
2607 hotkey_poll_setup_safe(false);
2608}
2609
2610/* sysfs hotkey enable ------------------------------------------------- */
2611static ssize_t hotkey_enable_show(struct device *dev,
2612 struct device_attribute *attr,
2613 char *buf)
2614{
2615 int res, status;
2616
2617 printk_deprecated_attribute("hotkey_enable",
2618 "Hotkey reporting is always enabled");
2619
2620 res = hotkey_status_get(&status);
2621 if (res)
2622 return res;
2623
2624 return sysfs_emit(buf, "%d\n", status);
2625}
2626
2627static ssize_t hotkey_enable_store(struct device *dev,
2628 struct device_attribute *attr,
2629 const char *buf, size_t count)
2630{
2631 unsigned long t;
2632
2633 printk_deprecated_attribute("hotkey_enable",
2634 "Hotkeys can be disabled through hotkey_mask");
2635
2636 if (parse_strtoul(buf, 1, &t))
2637 return -EINVAL;
2638
2639 if (t == 0)
2640 return -EPERM;
2641
2642 return count;
2643}
2644
2645static DEVICE_ATTR_RW(hotkey_enable);
2646
2647/* sysfs hotkey mask --------------------------------------------------- */
2648static ssize_t hotkey_mask_show(struct device *dev,
2649 struct device_attribute *attr,
2650 char *buf)
2651{
2652 return sysfs_emit(buf, "0x%08x\n", hotkey_user_mask);
2653}
2654
2655static ssize_t hotkey_mask_store(struct device *dev,
2656 struct device_attribute *attr,
2657 const char *buf, size_t count)
2658{
2659 unsigned long t;
2660 int res;
2661
2662 if (parse_strtoul(buf, 0xffffffffUL, &t))
2663 return -EINVAL;
2664
2665 if (mutex_lock_killable(&hotkey_mutex))
2666 return -ERESTARTSYS;
2667
2668 res = hotkey_user_mask_set(t);
2669
2670#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2671 hotkey_poll_setup(true);
2672#endif
2673
2674 mutex_unlock(&hotkey_mutex);
2675
2676 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2677
2678 return (res) ? res : count;
2679}
2680
2681static DEVICE_ATTR_RW(hotkey_mask);
2682
2683/* sysfs hotkey bios_enabled ------------------------------------------- */
2684static ssize_t hotkey_bios_enabled_show(struct device *dev,
2685 struct device_attribute *attr,
2686 char *buf)
2687{
2688 return sprintf(buf, "0\n");
2689}
2690
2691static DEVICE_ATTR_RO(hotkey_bios_enabled);
2692
2693/* sysfs hotkey bios_mask ---------------------------------------------- */
2694static ssize_t hotkey_bios_mask_show(struct device *dev,
2695 struct device_attribute *attr,
2696 char *buf)
2697{
2698 printk_deprecated_attribute("hotkey_bios_mask",
2699 "This attribute is useless.");
2700 return sysfs_emit(buf, "0x%08x\n", hotkey_orig_mask);
2701}
2702
2703static DEVICE_ATTR_RO(hotkey_bios_mask);
2704
2705/* sysfs hotkey all_mask ----------------------------------------------- */
2706static ssize_t hotkey_all_mask_show(struct device *dev,
2707 struct device_attribute *attr,
2708 char *buf)
2709{
2710 return sysfs_emit(buf, "0x%08x\n",
2711 hotkey_all_mask | hotkey_source_mask);
2712}
2713
2714static DEVICE_ATTR_RO(hotkey_all_mask);
2715
2716/* sysfs hotkey all_mask ----------------------------------------------- */
2717static ssize_t hotkey_adaptive_all_mask_show(struct device *dev,
2718 struct device_attribute *attr,
2719 char *buf)
2720{
2721 return sysfs_emit(buf, "0x%08x\n",
2722 hotkey_adaptive_all_mask | hotkey_source_mask);
2723}
2724
2725static DEVICE_ATTR_RO(hotkey_adaptive_all_mask);
2726
2727/* sysfs hotkey recommended_mask --------------------------------------- */
2728static ssize_t hotkey_recommended_mask_show(struct device *dev,
2729 struct device_attribute *attr,
2730 char *buf)
2731{
2732 return sysfs_emit(buf, "0x%08x\n",
2733 (hotkey_all_mask | hotkey_source_mask)
2734 & ~hotkey_reserved_mask);
2735}
2736
2737static DEVICE_ATTR_RO(hotkey_recommended_mask);
2738
2739#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2740
2741/* sysfs hotkey hotkey_source_mask ------------------------------------- */
2742static ssize_t hotkey_source_mask_show(struct device *dev,
2743 struct device_attribute *attr,
2744 char *buf)
2745{
2746 return sysfs_emit(buf, "0x%08x\n", hotkey_source_mask);
2747}
2748
2749static ssize_t hotkey_source_mask_store(struct device *dev,
2750 struct device_attribute *attr,
2751 const char *buf, size_t count)
2752{
2753 unsigned long t;
2754 u32 r_ev;
2755 int rc;
2756
2757 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2758 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2759 return -EINVAL;
2760
2761 if (mutex_lock_killable(&hotkey_mutex))
2762 return -ERESTARTSYS;
2763
2764 HOTKEY_CONFIG_CRITICAL_START
2765 hotkey_source_mask = t;
2766 HOTKEY_CONFIG_CRITICAL_END
2767
2768 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2769 ~hotkey_source_mask);
2770 hotkey_poll_setup(true);
2771
2772 /* check if events needed by the driver got disabled */
2773 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2774 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2775
2776 mutex_unlock(&hotkey_mutex);
2777
2778 if (rc < 0)
2779 pr_err("hotkey_source_mask: failed to update the firmware event mask!\n");
2780
2781 if (r_ev)
2782 pr_notice("hotkey_source_mask: some important events were disabled: 0x%04x\n",
2783 r_ev);
2784
2785 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2786
2787 return (rc < 0) ? rc : count;
2788}
2789
2790static DEVICE_ATTR_RW(hotkey_source_mask);
2791
2792/* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2793static ssize_t hotkey_poll_freq_show(struct device *dev,
2794 struct device_attribute *attr,
2795 char *buf)
2796{
2797 return sysfs_emit(buf, "%d\n", hotkey_poll_freq);
2798}
2799
2800static ssize_t hotkey_poll_freq_store(struct device *dev,
2801 struct device_attribute *attr,
2802 const char *buf, size_t count)
2803{
2804 unsigned long t;
2805
2806 if (parse_strtoul(buf, 25, &t))
2807 return -EINVAL;
2808
2809 if (mutex_lock_killable(&hotkey_mutex))
2810 return -ERESTARTSYS;
2811
2812 hotkey_poll_set_freq(t);
2813 hotkey_poll_setup(true);
2814
2815 mutex_unlock(&hotkey_mutex);
2816
2817 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2818
2819 return count;
2820}
2821
2822static DEVICE_ATTR_RW(hotkey_poll_freq);
2823
2824#endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2825
2826/* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2827static ssize_t hotkey_radio_sw_show(struct device *dev,
2828 struct device_attribute *attr,
2829 char *buf)
2830{
2831 int res;
2832 res = hotkey_get_wlsw();
2833 if (res < 0)
2834 return res;
2835
2836 /* Opportunistic update */
2837 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2838
2839 return sysfs_emit(buf, "%d\n",
2840 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2841}
2842
2843static DEVICE_ATTR_RO(hotkey_radio_sw);
2844
2845static void hotkey_radio_sw_notify_change(void)
2846{
2847 if (tp_features.hotkey_wlsw)
2848 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2849 "hotkey_radio_sw");
2850}
2851
2852/* sysfs hotkey tablet mode (pollable) --------------------------------- */
2853static ssize_t hotkey_tablet_mode_show(struct device *dev,
2854 struct device_attribute *attr,
2855 char *buf)
2856{
2857 int res, s;
2858 res = hotkey_get_tablet_mode(&s);
2859 if (res < 0)
2860 return res;
2861
2862 return sysfs_emit(buf, "%d\n", !!s);
2863}
2864
2865static DEVICE_ATTR_RO(hotkey_tablet_mode);
2866
2867static void hotkey_tablet_mode_notify_change(void)
2868{
2869 if (tp_features.hotkey_tablet)
2870 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2871 "hotkey_tablet_mode");
2872}
2873
2874/* sysfs wakeup reason (pollable) -------------------------------------- */
2875static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2876 struct device_attribute *attr,
2877 char *buf)
2878{
2879 return sysfs_emit(buf, "%d\n", hotkey_wakeup_reason);
2880}
2881
2882static DEVICE_ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2883
2884static void hotkey_wakeup_reason_notify_change(void)
2885{
2886 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2887 "wakeup_reason");
2888}
2889
2890/* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2891static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2892 struct device_attribute *attr,
2893 char *buf)
2894{
2895 return sysfs_emit(buf, "%d\n", hotkey_autosleep_ack);
2896}
2897
2898static DEVICE_ATTR(wakeup_hotunplug_complete, S_IRUGO,
2899 hotkey_wakeup_hotunplug_complete_show, NULL);
2900
2901static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2902{
2903 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2904 "wakeup_hotunplug_complete");
2905}
2906
2907/* sysfs adaptive kbd mode --------------------------------------------- */
2908
2909static int adaptive_keyboard_get_mode(void);
2910static int adaptive_keyboard_set_mode(int new_mode);
2911
2912enum ADAPTIVE_KEY_MODE {
2913 HOME_MODE,
2914 WEB_BROWSER_MODE,
2915 WEB_CONFERENCE_MODE,
2916 FUNCTION_MODE,
2917 LAYFLAT_MODE
2918};
2919
2920static ssize_t adaptive_kbd_mode_show(struct device *dev,
2921 struct device_attribute *attr,
2922 char *buf)
2923{
2924 int current_mode;
2925
2926 current_mode = adaptive_keyboard_get_mode();
2927 if (current_mode < 0)
2928 return current_mode;
2929
2930 return sysfs_emit(buf, "%d\n", current_mode);
2931}
2932
2933static ssize_t adaptive_kbd_mode_store(struct device *dev,
2934 struct device_attribute *attr,
2935 const char *buf, size_t count)
2936{
2937 unsigned long t;
2938 int res;
2939
2940 if (parse_strtoul(buf, LAYFLAT_MODE, &t))
2941 return -EINVAL;
2942
2943 res = adaptive_keyboard_set_mode(t);
2944 return (res < 0) ? res : count;
2945}
2946
2947static DEVICE_ATTR_RW(adaptive_kbd_mode);
2948
2949static struct attribute *adaptive_kbd_attributes[] = {
2950 &dev_attr_adaptive_kbd_mode.attr,
2951 NULL
2952};
2953
2954static umode_t hadaptive_kbd_attr_is_visible(struct kobject *kobj,
2955 struct attribute *attr, int n)
2956{
2957 return tp_features.has_adaptive_kbd ? attr->mode : 0;
2958}
2959
2960static const struct attribute_group adaptive_kbd_attr_group = {
2961 .is_visible = hadaptive_kbd_attr_is_visible,
2962 .attrs = adaptive_kbd_attributes,
2963};
2964
2965/* --------------------------------------------------------------------- */
2966
2967static struct attribute *hotkey_attributes[] = {
2968 &dev_attr_hotkey_enable.attr,
2969 &dev_attr_hotkey_bios_enabled.attr,
2970 &dev_attr_hotkey_bios_mask.attr,
2971 &dev_attr_wakeup_reason.attr,
2972 &dev_attr_wakeup_hotunplug_complete.attr,
2973 &dev_attr_hotkey_mask.attr,
2974 &dev_attr_hotkey_all_mask.attr,
2975 &dev_attr_hotkey_adaptive_all_mask.attr,
2976 &dev_attr_hotkey_recommended_mask.attr,
2977 &dev_attr_hotkey_tablet_mode.attr,
2978 &dev_attr_hotkey_radio_sw.attr,
2979#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2980 &dev_attr_hotkey_source_mask.attr,
2981 &dev_attr_hotkey_poll_freq.attr,
2982#endif
2983 NULL
2984};
2985
2986static umode_t hotkey_attr_is_visible(struct kobject *kobj,
2987 struct attribute *attr, int n)
2988{
2989 if (attr == &dev_attr_hotkey_tablet_mode.attr) {
2990 if (!tp_features.hotkey_tablet)
2991 return 0;
2992 } else if (attr == &dev_attr_hotkey_radio_sw.attr) {
2993 if (!tp_features.hotkey_wlsw)
2994 return 0;
2995 }
2996
2997 return attr->mode;
2998}
2999
3000static const struct attribute_group hotkey_attr_group = {
3001 .is_visible = hotkey_attr_is_visible,
3002 .attrs = hotkey_attributes,
3003};
3004
3005/*
3006 * Sync both the hw and sw blocking state of all switches
3007 */
3008static void tpacpi_send_radiosw_update(void)
3009{
3010 int wlsw;
3011
3012 /*
3013 * We must sync all rfkill controllers *before* issuing any
3014 * rfkill input events, or we will race the rfkill core input
3015 * handler.
3016 *
3017 * tpacpi_inputdev_send_mutex works as a synchronization point
3018 * for the above.
3019 *
3020 * We optimize to avoid numerous calls to hotkey_get_wlsw.
3021 */
3022
3023 wlsw = hotkey_get_wlsw();
3024
3025 /* Sync hw blocking state first if it is hw-blocked */
3026 if (wlsw == TPACPI_RFK_RADIO_OFF)
3027 tpacpi_rfk_update_hwblock_state(true);
3028
3029 /* Sync hw blocking state last if it is hw-unblocked */
3030 if (wlsw == TPACPI_RFK_RADIO_ON)
3031 tpacpi_rfk_update_hwblock_state(false);
3032
3033 /* Issue rfkill input event for WLSW switch */
3034 if (!(wlsw < 0)) {
3035 mutex_lock(&tpacpi_inputdev_send_mutex);
3036
3037 input_report_switch(tpacpi_inputdev,
3038 SW_RFKILL_ALL, (wlsw > 0));
3039 input_sync(tpacpi_inputdev);
3040
3041 mutex_unlock(&tpacpi_inputdev_send_mutex);
3042 }
3043
3044 /*
3045 * this can be unconditional, as we will poll state again
3046 * if userspace uses the notify to read data
3047 */
3048 hotkey_radio_sw_notify_change();
3049}
3050
3051static void hotkey_exit(void)
3052{
3053#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3054 mutex_lock(&hotkey_mutex);
3055 hotkey_poll_stop_sync();
3056 mutex_unlock(&hotkey_mutex);
3057#endif
3058 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3059 "restoring original HKEY status and mask\n");
3060 /* yes, there is a bitwise or below, we want the
3061 * functions to be called even if one of them fail */
3062 if (((tp_features.hotkey_mask &&
3063 hotkey_mask_set(hotkey_orig_mask)) |
3064 hotkey_status_set(false)) != 0)
3065 pr_err("failed to restore hot key mask to BIOS defaults\n");
3066}
3067
3068static void __init hotkey_unmap(const unsigned int scancode)
3069{
3070 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3071 clear_bit(hotkey_keycode_map[scancode],
3072 tpacpi_inputdev->keybit);
3073 hotkey_keycode_map[scancode] = KEY_RESERVED;
3074 }
3075}
3076
3077/*
3078 * HKEY quirks:
3079 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3080 */
3081
3082#define TPACPI_HK_Q_INIMASK 0x0001
3083
3084static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3085 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3086 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3087 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3088 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3089 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3090 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3091 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3092 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3093 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3094 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3095 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3096 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3097 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3098 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3099 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3100 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3101 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3102 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3103 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3104};
3105
3106typedef u16 tpacpi_keymap_entry_t;
3107typedef tpacpi_keymap_entry_t tpacpi_keymap_t[TPACPI_HOTKEY_MAP_LEN];
3108
3109static int hotkey_init_tablet_mode(void)
3110{
3111 int in_tablet_mode = 0, res;
3112 char *type = NULL;
3113
3114 if (acpi_evalf(hkey_handle, &res, "GMMS", "qdd", 0)) {
3115 int has_tablet_mode;
3116
3117 in_tablet_mode = hotkey_gmms_get_tablet_mode(res,
3118 &has_tablet_mode);
3119 /*
3120 * The Yoga 11e series has 2 accelerometers described by a
3121 * BOSC0200 ACPI node. This setup relies on a Windows service
3122 * which calls special ACPI methods on this node to report
3123 * the laptop/tent/tablet mode to the EC. The bmc150 iio driver
3124 * does not support this, so skip the hotkey on these models.
3125 */
3126 if (has_tablet_mode && !dual_accel_detect())
3127 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_GMMS;
3128 type = "GMMS";
3129 } else if (acpi_evalf(hkey_handle, &res, "MHKG", "qd")) {
3130 /* For X41t, X60t, X61t Tablets... */
3131 tp_features.hotkey_tablet = TP_HOTKEY_TABLET_USES_MHKG;
3132 in_tablet_mode = !!(res & TP_HOTKEY_TABLET_MASK);
3133 type = "MHKG";
3134 }
3135
3136 if (!tp_features.hotkey_tablet)
3137 return 0;
3138
3139 pr_info("Tablet mode switch found (type: %s), currently in %s mode\n",
3140 type, in_tablet_mode ? "tablet" : "laptop");
3141
3142 return in_tablet_mode;
3143}
3144
3145static int __init hotkey_init(struct ibm_init_struct *iibm)
3146{
3147 /* Requirements for changing the default keymaps:
3148 *
3149 * 1. Many of the keys are mapped to KEY_RESERVED for very
3150 * good reasons. Do not change them unless you have deep
3151 * knowledge on the IBM and Lenovo ThinkPad firmware for
3152 * the various ThinkPad models. The driver behaves
3153 * differently for KEY_RESERVED: such keys have their
3154 * hot key mask *unset* in mask_recommended, and also
3155 * in the initial hot key mask programmed into the
3156 * firmware at driver load time, which means the firm-
3157 * ware may react very differently if you change them to
3158 * something else;
3159 *
3160 * 2. You must be subscribed to the linux-thinkpad and
3161 * ibm-acpi-devel mailing lists, and you should read the
3162 * list archives since 2007 if you want to change the
3163 * keymaps. This requirement exists so that you will
3164 * know the past history of problems with the thinkpad-
3165 * acpi driver keymaps, and also that you will be
3166 * listening to any bug reports;
3167 *
3168 * 3. Do not send thinkpad-acpi specific patches directly to
3169 * for merging, *ever*. Send them to the linux-acpi
3170 * mailinglist for comments. Merging is to be done only
3171 * through acpi-test and the ACPI maintainer.
3172 *
3173 * If the above is too much to ask, don't change the keymap.
3174 * Ask the thinkpad-acpi maintainer to do it, instead.
3175 */
3176
3177 enum keymap_index {
3178 TPACPI_KEYMAP_IBM_GENERIC = 0,
3179 TPACPI_KEYMAP_LENOVO_GENERIC,
3180 };
3181
3182 static const tpacpi_keymap_t tpacpi_keymaps[] __initconst = {
3183 /* Generic keymap for IBM ThinkPads */
3184 [TPACPI_KEYMAP_IBM_GENERIC] = {
3185 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3186 KEY_FN_F1, KEY_BATTERY, KEY_COFFEE, KEY_SLEEP,
3187 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3188 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3189
3190 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3191 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3192 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3193 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3194
3195 /* brightness: firmware always reacts to them */
3196 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3197 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3198
3199 /* Thinklight: firmware always react to it */
3200 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3201
3202 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3203 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3204
3205 /* Volume: firmware always react to it and reprograms
3206 * the built-in *extra* mixer. Never map it to control
3207 * another mixer by default. */
3208 KEY_RESERVED, /* 0x14: VOLUME UP */
3209 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3210 KEY_RESERVED, /* 0x16: MUTE */
3211
3212 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3213
3214 /* (assignments unknown, please report if found) */
3215 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3216 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3217
3218 /* No assignments, only used for Adaptive keyboards. */
3219 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3220 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3221 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3222 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3223 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3224
3225 /* No assignment, used for newer Lenovo models */
3226 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3227 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3228 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3229 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3230 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3231 KEY_UNKNOWN, KEY_UNKNOWN
3232
3233 },
3234
3235 /* Generic keymap for Lenovo ThinkPads */
3236 [TPACPI_KEYMAP_LENOVO_GENERIC] = {
3237 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3238 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3239 KEY_WLAN, KEY_CAMERA, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3240 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3241
3242 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3243 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3244 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3245 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3246
3247 /* These should be enabled --only-- when ACPI video
3248 * is disabled (i.e. in "vendor" mode), and are handled
3249 * in a special way by the init code */
3250 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3251 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3252
3253 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3254
3255 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3256 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3257
3258 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3259 * react to it and reprograms the built-in *extra* mixer.
3260 * Never map it to control another mixer by default.
3261 *
3262 * T60?, T61, R60?, R61: firmware and EC tries to send
3263 * these over the regular keyboard, so these are no-ops,
3264 * but there are still weird bugs re. MUTE, so do not
3265 * change unless you get test reports from all Lenovo
3266 * models. May cause the BIOS to interfere with the
3267 * HDA mixer.
3268 */
3269 KEY_RESERVED, /* 0x14: VOLUME UP */
3270 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3271 KEY_RESERVED, /* 0x16: MUTE */
3272
3273 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3274
3275 /* (assignments unknown, please report if found) */
3276 KEY_UNKNOWN, KEY_UNKNOWN,
3277
3278 /*
3279 * The mic mute button only sends 0x1a. It does not
3280 * automatically mute the mic or change the mute light.
3281 */
3282 KEY_MICMUTE, /* 0x1a: Mic mute (since ?400 or so) */
3283
3284 /* (assignments unknown, please report if found) */
3285 KEY_UNKNOWN,
3286
3287 /* Extra keys in use since the X240 / T440 / T540 */
3288 KEY_CONFIG, KEY_SEARCH, KEY_SCALE, KEY_FILE,
3289
3290 /*
3291 * These are the adaptive keyboard keycodes for Carbon X1 2014.
3292 * The first item in this list is the Mute button which is
3293 * emitted with 0x103 through
3294 * adaptive_keyboard_hotkey_notify_hotkey() when the sound
3295 * symbol is held.
3296 * We'll need to offset those by 0x20.
3297 */
3298 KEY_RESERVED, /* Mute held, 0x103 */
3299 KEY_BRIGHTNESS_MIN, /* Backlight off */
3300 KEY_RESERVED, /* Clipping tool */
3301 KEY_RESERVED, /* Cloud */
3302 KEY_RESERVED,
3303 KEY_VOICECOMMAND, /* Voice */
3304 KEY_RESERVED,
3305 KEY_RESERVED, /* Gestures */
3306 KEY_RESERVED,
3307 KEY_RESERVED,
3308 KEY_RESERVED,
3309 KEY_CONFIG, /* Settings */
3310 KEY_RESERVED, /* New tab */
3311 KEY_REFRESH, /* Reload */
3312 KEY_BACK, /* Back */
3313 KEY_RESERVED, /* Microphone down */
3314 KEY_RESERVED, /* Microphone up */
3315 KEY_RESERVED, /* Microphone cancellation */
3316 KEY_RESERVED, /* Camera mode */
3317 KEY_RESERVED, /* Rotate display, 0x116 */
3318
3319 /*
3320 * These are found in 2017 models (e.g. T470s, X270).
3321 * The lowest known value is 0x311, which according to
3322 * the manual should launch a user defined favorite
3323 * application.
3324 *
3325 * The offset for these is TP_ACPI_HOTKEYSCAN_EXTENDED_START,
3326 * corresponding to 0x34.
3327 */
3328
3329 /* (assignments unknown, please report if found) */
3330 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3331 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3332 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3333 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3334 KEY_UNKNOWN,
3335
3336 KEY_BOOKMARKS, /* Favorite app, 0x311 */
3337 KEY_SELECTIVE_SCREENSHOT, /* Clipping tool */
3338 KEY_CALC, /* Calculator (above numpad, P52) */
3339 KEY_BLUETOOTH, /* Bluetooth */
3340 KEY_KEYBOARD, /* Keyboard, 0x315 */
3341 KEY_FN_RIGHT_SHIFT, /* Fn + right Shift */
3342 KEY_NOTIFICATION_CENTER, /* Notification Center */
3343 KEY_PICKUP_PHONE, /* Answer incoming call */
3344 KEY_HANGUP_PHONE, /* Decline incoming call */
3345 },
3346 };
3347
3348 static const struct tpacpi_quirk tpacpi_keymap_qtable[] __initconst = {
3349 /* Generic maps (fallback) */
3350 {
3351 .vendor = PCI_VENDOR_ID_IBM,
3352 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3353 .quirks = TPACPI_KEYMAP_IBM_GENERIC,
3354 },
3355 {
3356 .vendor = PCI_VENDOR_ID_LENOVO,
3357 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
3358 .quirks = TPACPI_KEYMAP_LENOVO_GENERIC,
3359 },
3360 };
3361
3362#define TPACPI_HOTKEY_MAP_SIZE sizeof(tpacpi_keymap_t)
3363#define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(tpacpi_keymap_entry_t)
3364
3365 int res, i;
3366 int status;
3367 int hkeyv;
3368 bool radiosw_state = false;
3369 bool tabletsw_state = false;
3370
3371 unsigned long quirks;
3372 unsigned long keymap_id;
3373
3374 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3375 "initializing hotkey subdriver\n");
3376
3377 BUG_ON(!tpacpi_inputdev);
3378 BUG_ON(tpacpi_inputdev->open != NULL ||
3379 tpacpi_inputdev->close != NULL);
3380
3381 TPACPI_ACPIHANDLE_INIT(hkey);
3382 mutex_init(&hotkey_mutex);
3383
3384#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3385 mutex_init(&hotkey_thread_data_mutex);
3386#endif
3387
3388 /* hotkey not supported on 570 */
3389 tp_features.hotkey = hkey_handle != NULL;
3390
3391 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3392 "hotkeys are %s\n",
3393 str_supported(tp_features.hotkey));
3394
3395 if (!tp_features.hotkey)
3396 return -ENODEV;
3397
3398 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3399 ARRAY_SIZE(tpacpi_hotkey_qtable));
3400
3401 tpacpi_disable_brightness_delay();
3402
3403 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3404 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3405 for HKEY interface version 0x100 */
3406 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3407 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3408 "firmware HKEY interface version: 0x%x\n",
3409 hkeyv);
3410
3411 switch (hkeyv >> 8) {
3412 case 1:
3413 /*
3414 * MHKV 0x100 in A31, R40, R40e,
3415 * T4x, X31, and later
3416 */
3417
3418 /* Paranoia check AND init hotkey_all_mask */
3419 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3420 "MHKA", "qd")) {
3421 pr_err("missing MHKA handler, please report this to %s\n",
3422 TPACPI_MAIL);
3423 /* Fallback: pre-init for FN+F3,F4,F12 */
3424 hotkey_all_mask = 0x080cU;
3425 } else {
3426 tp_features.hotkey_mask = 1;
3427 }
3428 break;
3429
3430 case 2:
3431 /*
3432 * MHKV 0x200 in X1, T460s, X260, T560, X1 Tablet (2016)
3433 */
3434
3435 /* Paranoia check AND init hotkey_all_mask */
3436 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3437 "MHKA", "dd", 1)) {
3438 pr_err("missing MHKA handler, please report this to %s\n",
3439 TPACPI_MAIL);
3440 /* Fallback: pre-init for FN+F3,F4,F12 */
3441 hotkey_all_mask = 0x080cU;
3442 } else {
3443 tp_features.hotkey_mask = 1;
3444 }
3445
3446 /*
3447 * Check if we have an adaptive keyboard, like on the
3448 * Lenovo Carbon X1 2014 (2nd Gen).
3449 */
3450 if (acpi_evalf(hkey_handle, &hotkey_adaptive_all_mask,
3451 "MHKA", "dd", 2)) {
3452 if (hotkey_adaptive_all_mask != 0)
3453 tp_features.has_adaptive_kbd = true;
3454 } else {
3455 tp_features.has_adaptive_kbd = false;
3456 hotkey_adaptive_all_mask = 0x0U;
3457 }
3458 break;
3459
3460 default:
3461 pr_err("unknown version of the HKEY interface: 0x%x\n",
3462 hkeyv);
3463 pr_err("please report this to %s\n", TPACPI_MAIL);
3464 break;
3465 }
3466 }
3467
3468 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3469 "hotkey masks are %s\n",
3470 str_supported(tp_features.hotkey_mask));
3471
3472 /* Init hotkey_all_mask if not initialized yet */
3473 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3474 (quirks & TPACPI_HK_Q_INIMASK))
3475 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3476
3477 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3478 if (tp_features.hotkey_mask) {
3479 /* hotkey_source_mask *must* be zero for
3480 * the first hotkey_mask_get to return hotkey_orig_mask */
3481 res = hotkey_mask_get();
3482 if (res)
3483 return res;
3484
3485 hotkey_orig_mask = hotkey_acpi_mask;
3486 } else {
3487 hotkey_orig_mask = hotkey_all_mask;
3488 hotkey_acpi_mask = hotkey_all_mask;
3489 }
3490
3491#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3492 if (dbg_wlswemul) {
3493 tp_features.hotkey_wlsw = 1;
3494 radiosw_state = !!tpacpi_wlsw_emulstate;
3495 pr_info("radio switch emulation enabled\n");
3496 } else
3497#endif
3498 /* Not all thinkpads have a hardware radio switch */
3499 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3500 tp_features.hotkey_wlsw = 1;
3501 radiosw_state = !!status;
3502 pr_info("radio switch found; radios are %s\n", str_enabled_disabled(status & BIT(0)));
3503 }
3504
3505 tabletsw_state = hotkey_init_tablet_mode();
3506
3507 /* Set up key map */
3508 keymap_id = tpacpi_check_quirks(tpacpi_keymap_qtable,
3509 ARRAY_SIZE(tpacpi_keymap_qtable));
3510 BUG_ON(keymap_id >= ARRAY_SIZE(tpacpi_keymaps));
3511 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3512 "using keymap number %lu\n", keymap_id);
3513
3514 hotkey_keycode_map = kmemdup(&tpacpi_keymaps[keymap_id],
3515 TPACPI_HOTKEY_MAP_SIZE, GFP_KERNEL);
3516 if (!hotkey_keycode_map) {
3517 pr_err("failed to allocate memory for key map\n");
3518 return -ENOMEM;
3519 }
3520
3521 input_set_capability(tpacpi_inputdev, EV_MSC, MSC_SCAN);
3522 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3523 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3524 tpacpi_inputdev->keycode = hotkey_keycode_map;
3525 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3526 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3527 input_set_capability(tpacpi_inputdev, EV_KEY,
3528 hotkey_keycode_map[i]);
3529 } else {
3530 if (i < sizeof(hotkey_reserved_mask)*8)
3531 hotkey_reserved_mask |= 1 << i;
3532 }
3533 }
3534
3535 if (tp_features.hotkey_wlsw) {
3536 input_set_capability(tpacpi_inputdev, EV_SW, SW_RFKILL_ALL);
3537 input_report_switch(tpacpi_inputdev,
3538 SW_RFKILL_ALL, radiosw_state);
3539 }
3540 if (tp_features.hotkey_tablet) {
3541 input_set_capability(tpacpi_inputdev, EV_SW, SW_TABLET_MODE);
3542 input_report_switch(tpacpi_inputdev,
3543 SW_TABLET_MODE, tabletsw_state);
3544 }
3545
3546 /* Do not issue duplicate brightness change events to
3547 * userspace. tpacpi_detect_brightness_capabilities() must have
3548 * been called before this point */
3549 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
3550 pr_info("This ThinkPad has standard ACPI backlight brightness control, supported by the ACPI video driver\n");
3551 pr_notice("Disabling thinkpad-acpi brightness events by default...\n");
3552
3553 /* Disable brightness up/down on Lenovo thinkpads when
3554 * ACPI is handling them, otherwise it is plain impossible
3555 * for userspace to do something even remotely sane */
3556 hotkey_reserved_mask |=
3557 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3558 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3559 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3560 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3561 }
3562
3563#ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3564 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3565 & ~hotkey_all_mask
3566 & ~hotkey_reserved_mask;
3567
3568 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3569 "hotkey source mask 0x%08x, polling freq %u\n",
3570 hotkey_source_mask, hotkey_poll_freq);
3571#endif
3572
3573 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3574 "enabling firmware HKEY event interface...\n");
3575 res = hotkey_status_set(true);
3576 if (res) {
3577 hotkey_exit();
3578 return res;
3579 }
3580 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3581 | hotkey_driver_mask)
3582 & ~hotkey_source_mask);
3583 if (res < 0 && res != -ENXIO) {
3584 hotkey_exit();
3585 return res;
3586 }
3587 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3588 & ~hotkey_reserved_mask;
3589 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3590 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3591 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3592
3593 tpacpi_inputdev->open = &hotkey_inputdev_open;
3594 tpacpi_inputdev->close = &hotkey_inputdev_close;
3595
3596 hotkey_poll_setup_safe(true);
3597
3598 return 0;
3599}
3600
3601/* Thinkpad X1 Carbon support 5 modes including Home mode, Web browser
3602 * mode, Web conference mode, Function mode and Lay-flat mode.
3603 * We support Home mode and Function mode currently.
3604 *
3605 * Will consider support rest of modes in future.
3606 *
3607 */
3608static const int adaptive_keyboard_modes[] = {
3609 HOME_MODE,
3610/* WEB_BROWSER_MODE = 2,
3611 WEB_CONFERENCE_MODE = 3, */
3612 FUNCTION_MODE
3613};
3614
3615#define DFR_CHANGE_ROW 0x101
3616#define DFR_SHOW_QUICKVIEW_ROW 0x102
3617#define FIRST_ADAPTIVE_KEY 0x103
3618
3619/* press Fn key a while second, it will switch to Function Mode. Then
3620 * release Fn key, previous mode be restored.
3621 */
3622static bool adaptive_keyboard_mode_is_saved;
3623static int adaptive_keyboard_prev_mode;
3624
3625static int adaptive_keyboard_get_mode(void)
3626{
3627 int mode = 0;
3628
3629 if (!acpi_evalf(hkey_handle, &mode, "GTRW", "dd", 0)) {
3630 pr_err("Cannot read adaptive keyboard mode\n");
3631 return -EIO;
3632 }
3633
3634 return mode;
3635}
3636
3637static int adaptive_keyboard_set_mode(int new_mode)
3638{
3639 if (new_mode < 0 ||
3640 new_mode > LAYFLAT_MODE)
3641 return -EINVAL;
3642
3643 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd", new_mode)) {
3644 pr_err("Cannot set adaptive keyboard mode\n");
3645 return -EIO;
3646 }
3647
3648 return 0;
3649}
3650
3651static int adaptive_keyboard_get_next_mode(int mode)
3652{
3653 size_t i;
3654 size_t max_mode = ARRAY_SIZE(adaptive_keyboard_modes) - 1;
3655
3656 for (i = 0; i <= max_mode; i++) {
3657 if (adaptive_keyboard_modes[i] == mode)
3658 break;
3659 }
3660
3661 if (i >= max_mode)
3662 i = 0;
3663 else
3664 i++;
3665
3666 return adaptive_keyboard_modes[i];
3667}
3668
3669static bool adaptive_keyboard_hotkey_notify_hotkey(unsigned int scancode)
3670{
3671 int current_mode = 0;
3672 int new_mode = 0;
3673 int keycode;
3674
3675 switch (scancode) {
3676 case DFR_CHANGE_ROW:
3677 if (adaptive_keyboard_mode_is_saved) {
3678 new_mode = adaptive_keyboard_prev_mode;
3679 adaptive_keyboard_mode_is_saved = false;
3680 } else {
3681 current_mode = adaptive_keyboard_get_mode();
3682 if (current_mode < 0)
3683 return false;
3684 new_mode = adaptive_keyboard_get_next_mode(
3685 current_mode);
3686 }
3687
3688 if (adaptive_keyboard_set_mode(new_mode) < 0)
3689 return false;
3690
3691 return true;
3692
3693 case DFR_SHOW_QUICKVIEW_ROW:
3694 current_mode = adaptive_keyboard_get_mode();
3695 if (current_mode < 0)
3696 return false;
3697
3698 adaptive_keyboard_prev_mode = current_mode;
3699 adaptive_keyboard_mode_is_saved = true;
3700
3701 if (adaptive_keyboard_set_mode (FUNCTION_MODE) < 0)
3702 return false;
3703 return true;
3704
3705 default:
3706 if (scancode < FIRST_ADAPTIVE_KEY ||
3707 scancode >= FIRST_ADAPTIVE_KEY +
3708 TP_ACPI_HOTKEYSCAN_EXTENDED_START -
3709 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3710 pr_info("Unhandled adaptive keyboard key: 0x%x\n",
3711 scancode);
3712 return false;
3713 }
3714 keycode = hotkey_keycode_map[scancode - FIRST_ADAPTIVE_KEY +
3715 TP_ACPI_HOTKEYSCAN_ADAPTIVE_START];
3716 if (keycode != KEY_RESERVED) {
3717 mutex_lock(&tpacpi_inputdev_send_mutex);
3718
3719 input_report_key(tpacpi_inputdev, keycode, 1);
3720 input_sync(tpacpi_inputdev);
3721
3722 input_report_key(tpacpi_inputdev, keycode, 0);
3723 input_sync(tpacpi_inputdev);
3724
3725 mutex_unlock(&tpacpi_inputdev_send_mutex);
3726 }
3727 return true;
3728 }
3729}
3730
3731static bool hotkey_notify_extended_hotkey(const u32 hkey)
3732{
3733 unsigned int scancode;
3734
3735 switch (hkey) {
3736 case TP_HKEY_EV_PRIVACYGUARD_TOGGLE:
3737 case TP_HKEY_EV_AMT_TOGGLE:
3738 tpacpi_driver_event(hkey);
3739 return true;
3740 }
3741
3742 /* Extended keycodes start at 0x300 and our offset into the map
3743 * TP_ACPI_HOTKEYSCAN_EXTENDED_START. The calculated scancode
3744 * will be positive, but might not be in the correct range.
3745 */
3746 scancode = (hkey & 0xfff) - (0x300 - TP_ACPI_HOTKEYSCAN_EXTENDED_START);
3747 if (scancode >= TP_ACPI_HOTKEYSCAN_EXTENDED_START &&
3748 scancode < TPACPI_HOTKEY_MAP_LEN) {
3749 tpacpi_input_send_key(scancode);
3750 return true;
3751 }
3752
3753 return false;
3754}
3755
3756static bool hotkey_notify_hotkey(const u32 hkey,
3757 bool *send_acpi_ev,
3758 bool *ignore_acpi_ev)
3759{
3760 /* 0x1000-0x1FFF: key presses */
3761 unsigned int scancode = hkey & 0xfff;
3762 *send_acpi_ev = true;
3763 *ignore_acpi_ev = false;
3764
3765 /*
3766 * Original events are in the 0x10XX range, the adaptive keyboard
3767 * found in 2014 X1 Carbon emits events are of 0x11XX. In 2017
3768 * models, additional keys are emitted through 0x13XX.
3769 */
3770 switch ((hkey >> 8) & 0xf) {
3771 case 0:
3772 if (scancode > 0 &&
3773 scancode <= TP_ACPI_HOTKEYSCAN_ADAPTIVE_START) {
3774 /* HKEY event 0x1001 is scancode 0x00 */
3775 scancode--;
3776 if (!(hotkey_source_mask & (1 << scancode))) {
3777 tpacpi_input_send_key_masked(scancode);
3778 *send_acpi_ev = false;
3779 } else {
3780 *ignore_acpi_ev = true;
3781 }
3782 return true;
3783 }
3784 break;
3785
3786 case 1:
3787 return adaptive_keyboard_hotkey_notify_hotkey(scancode);
3788
3789 case 3:
3790 return hotkey_notify_extended_hotkey(hkey);
3791 }
3792
3793 return false;
3794}
3795
3796static bool hotkey_notify_wakeup(const u32 hkey,
3797 bool *send_acpi_ev,
3798 bool *ignore_acpi_ev)
3799{
3800 /* 0x2000-0x2FFF: Wakeup reason */
3801 *send_acpi_ev = true;
3802 *ignore_acpi_ev = false;
3803
3804 switch (hkey) {
3805 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3806 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3807 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3808 *ignore_acpi_ev = true;
3809 break;
3810
3811 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3812 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3813 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3814 *ignore_acpi_ev = true;
3815 break;
3816
3817 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3818 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3819 pr_alert("EMERGENCY WAKEUP: battery almost empty\n");
3820 /* how to auto-heal: */
3821 /* 2313: woke up from S3, go to S4/S5 */
3822 /* 2413: woke up from S4, go to S5 */
3823 break;
3824
3825 default:
3826 return false;
3827 }
3828
3829 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3830 pr_info("woke up due to a hot-unplug request...\n");
3831 hotkey_wakeup_reason_notify_change();
3832 }
3833 return true;
3834}
3835
3836static bool hotkey_notify_dockevent(const u32 hkey,
3837 bool *send_acpi_ev,
3838 bool *ignore_acpi_ev)
3839{
3840 /* 0x4000-0x4FFF: dock-related events */
3841 *send_acpi_ev = true;
3842 *ignore_acpi_ev = false;
3843
3844 switch (hkey) {
3845 case TP_HKEY_EV_UNDOCK_ACK:
3846 /* ACPI undock operation completed after wakeup */
3847 hotkey_autosleep_ack = 1;
3848 pr_info("undocked\n");
3849 hotkey_wakeup_hotunplug_complete_notify_change();
3850 return true;
3851
3852 case TP_HKEY_EV_HOTPLUG_DOCK: /* docked to port replicator */
3853 pr_info("docked into hotplug port replicator\n");
3854 return true;
3855 case TP_HKEY_EV_HOTPLUG_UNDOCK: /* undocked from port replicator */
3856 pr_info("undocked from hotplug port replicator\n");
3857 return true;
3858
3859 /*
3860 * Deliberately ignore attaching and detaching the keybord cover to avoid
3861 * duplicates from intel-vbtn, which already emits SW_TABLET_MODE events
3862 * to userspace.
3863 *
3864 * Please refer to the following thread for more information and a preliminary
3865 * implementation using the GTOP ("Get Tablet OPtions") interface that could be
3866 * extended to other attachment options of the ThinkPad X1 Tablet series, such as
3867 * the Pico cartridge dock module:
3868 * https://lore.kernel.org/platform-driver-x86/38cb8265-1e30-d547-9e12-b4ae290be737@a-kobel.de/
3869 */
3870 case TP_HKEY_EV_KBD_COVER_ATTACH:
3871 case TP_HKEY_EV_KBD_COVER_DETACH:
3872 *send_acpi_ev = false;
3873 *ignore_acpi_ev = true;
3874 return true;
3875
3876 default:
3877 return false;
3878 }
3879}
3880
3881static bool hotkey_notify_usrevent(const u32 hkey,
3882 bool *send_acpi_ev,
3883 bool *ignore_acpi_ev)
3884{
3885 /* 0x5000-0x5FFF: human interface helpers */
3886 *send_acpi_ev = true;
3887 *ignore_acpi_ev = false;
3888
3889 switch (hkey) {
3890 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3891 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3892 return true;
3893
3894 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3895 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3896 tpacpi_input_send_tabletsw();
3897 hotkey_tablet_mode_notify_change();
3898 *send_acpi_ev = false;
3899 return true;
3900
3901 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3902 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3903 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3904 /* do not propagate these events */
3905 *ignore_acpi_ev = true;
3906 return true;
3907
3908 default:
3909 return false;
3910 }
3911}
3912
3913static void thermal_dump_all_sensors(void);
3914static void palmsensor_refresh(void);
3915
3916static bool hotkey_notify_6xxx(const u32 hkey,
3917 bool *send_acpi_ev,
3918 bool *ignore_acpi_ev)
3919{
3920 /* 0x6000-0x6FFF: thermal alarms/notices and keyboard events */
3921 *send_acpi_ev = true;
3922 *ignore_acpi_ev = false;
3923
3924 switch (hkey) {
3925 case TP_HKEY_EV_THM_TABLE_CHANGED:
3926 pr_debug("EC reports: Thermal Table has changed\n");
3927 /* recommended action: do nothing, we don't have
3928 * Lenovo ATM information */
3929 return true;
3930 case TP_HKEY_EV_THM_CSM_COMPLETED:
3931 pr_debug("EC reports: Thermal Control Command set completed (DYTC)\n");
3932 /* Thermal event - pass on to event handler */
3933 tpacpi_driver_event(hkey);
3934 return true;
3935 case TP_HKEY_EV_THM_TRANSFM_CHANGED:
3936 pr_debug("EC reports: Thermal Transformation changed (GMTS)\n");
3937 /* recommended action: do nothing, we don't have
3938 * Lenovo ATM information */
3939 return true;
3940 case TP_HKEY_EV_ALARM_BAT_HOT:
3941 pr_crit("THERMAL ALARM: battery is too hot!\n");
3942 /* recommended action: warn user through gui */
3943 break;
3944 case TP_HKEY_EV_ALARM_BAT_XHOT:
3945 pr_alert("THERMAL EMERGENCY: battery is extremely hot!\n");
3946 /* recommended action: immediate sleep/hibernate */
3947 break;
3948 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3949 pr_crit("THERMAL ALARM: a sensor reports something is too hot!\n");
3950 /* recommended action: warn user through gui, that */
3951 /* some internal component is too hot */
3952 break;
3953 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3954 pr_alert("THERMAL EMERGENCY: a sensor reports something is extremely hot!\n");
3955 /* recommended action: immediate sleep/hibernate */
3956 break;
3957 case TP_HKEY_EV_AC_CHANGED:
3958 /* X120e, X121e, X220, X220i, X220t, X230, T420, T420s, W520:
3959 * AC status changed; can be triggered by plugging or
3960 * unplugging AC adapter, docking or undocking. */
3961
3962 fallthrough;
3963
3964 case TP_HKEY_EV_KEY_NUMLOCK:
3965 case TP_HKEY_EV_KEY_FN:
3966 /* key press events, we just ignore them as long as the EC
3967 * is still reporting them in the normal keyboard stream */
3968 *send_acpi_ev = false;
3969 *ignore_acpi_ev = true;
3970 return true;
3971
3972 case TP_HKEY_EV_KEY_FN_ESC:
3973 /* Get the media key status to force the status LED to update */
3974 acpi_evalf(hkey_handle, NULL, "GMKS", "v");
3975 *send_acpi_ev = false;
3976 *ignore_acpi_ev = true;
3977 return true;
3978
3979 case TP_HKEY_EV_TABLET_CHANGED:
3980 tpacpi_input_send_tabletsw();
3981 hotkey_tablet_mode_notify_change();
3982 *send_acpi_ev = false;
3983 return true;
3984
3985 case TP_HKEY_EV_PALM_DETECTED:
3986 case TP_HKEY_EV_PALM_UNDETECTED:
3987 /* palm detected - pass on to event handler */
3988 palmsensor_refresh();
3989 return true;
3990
3991 default:
3992 /* report simply as unknown, no sensor dump */
3993 return false;
3994 }
3995
3996 thermal_dump_all_sensors();
3997 return true;
3998}
3999
4000static void hotkey_notify(struct ibm_struct *ibm, u32 event)
4001{
4002 u32 hkey;
4003 bool send_acpi_ev;
4004 bool ignore_acpi_ev;
4005 bool known_ev;
4006
4007 if (event != 0x80) {
4008 pr_err("unknown HKEY notification event %d\n", event);
4009 /* forward it to userspace, maybe it knows how to handle it */
4010 acpi_bus_generate_netlink_event(
4011 ibm->acpi->device->pnp.device_class,
4012 dev_name(&ibm->acpi->device->dev),
4013 event, 0);
4014 return;
4015 }
4016
4017 while (1) {
4018 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
4019 pr_err("failed to retrieve HKEY event\n");
4020 return;
4021 }
4022
4023 if (hkey == 0) {
4024 /* queue empty */
4025 return;
4026 }
4027
4028 send_acpi_ev = true;
4029 ignore_acpi_ev = false;
4030
4031 switch (hkey >> 12) {
4032 case 1:
4033 /* 0x1000-0x1FFF: key presses */
4034 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
4035 &ignore_acpi_ev);
4036 break;
4037 case 2:
4038 /* 0x2000-0x2FFF: Wakeup reason */
4039 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
4040 &ignore_acpi_ev);
4041 break;
4042 case 3:
4043 /* 0x3000-0x3FFF: bay-related wakeups */
4044 switch (hkey) {
4045 case TP_HKEY_EV_BAYEJ_ACK:
4046 hotkey_autosleep_ack = 1;
4047 pr_info("bay ejected\n");
4048 hotkey_wakeup_hotunplug_complete_notify_change();
4049 known_ev = true;
4050 break;
4051 case TP_HKEY_EV_OPTDRV_EJ:
4052 /* FIXME: kick libata if SATA link offline */
4053 known_ev = true;
4054 break;
4055 default:
4056 known_ev = false;
4057 }
4058 break;
4059 case 4:
4060 /* 0x4000-0x4FFF: dock-related events */
4061 known_ev = hotkey_notify_dockevent(hkey, &send_acpi_ev,
4062 &ignore_acpi_ev);
4063 break;
4064 case 5:
4065 /* 0x5000-0x5FFF: human interface helpers */
4066 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
4067 &ignore_acpi_ev);
4068 break;
4069 case 6:
4070 /* 0x6000-0x6FFF: thermal alarms/notices and
4071 * keyboard events */
4072 known_ev = hotkey_notify_6xxx(hkey, &send_acpi_ev,
4073 &ignore_acpi_ev);
4074 break;
4075 case 7:
4076 /* 0x7000-0x7FFF: misc */
4077 if (tp_features.hotkey_wlsw &&
4078 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
4079 tpacpi_send_radiosw_update();
4080 send_acpi_ev = 0;
4081 known_ev = true;
4082 break;
4083 }
4084 fallthrough; /* to default */
4085 default:
4086 known_ev = false;
4087 }
4088 if (!known_ev) {
4089 pr_notice("unhandled HKEY event 0x%04x\n", hkey);
4090 pr_notice("please report the conditions when this event happened to %s\n",
4091 TPACPI_MAIL);
4092 }
4093
4094 /* netlink events */
4095 if (!ignore_acpi_ev && send_acpi_ev) {
4096 acpi_bus_generate_netlink_event(
4097 ibm->acpi->device->pnp.device_class,
4098 dev_name(&ibm->acpi->device->dev),
4099 event, hkey);
4100 }
4101 }
4102}
4103
4104static void hotkey_suspend(void)
4105{
4106 /* Do these on suspend, we get the events on early resume! */
4107 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
4108 hotkey_autosleep_ack = 0;
4109
4110 /* save previous mode of adaptive keyboard of X1 Carbon */
4111 if (tp_features.has_adaptive_kbd) {
4112 if (!acpi_evalf(hkey_handle, &adaptive_keyboard_prev_mode,
4113 "GTRW", "dd", 0)) {
4114 pr_err("Cannot read adaptive keyboard mode.\n");
4115 }
4116 }
4117}
4118
4119static void hotkey_resume(void)
4120{
4121 tpacpi_disable_brightness_delay();
4122
4123 if (hotkey_status_set(true) < 0 ||
4124 hotkey_mask_set(hotkey_acpi_mask) < 0)
4125 pr_err("error while attempting to reset the event firmware interface\n");
4126
4127 tpacpi_send_radiosw_update();
4128 tpacpi_input_send_tabletsw();
4129 hotkey_tablet_mode_notify_change();
4130 hotkey_wakeup_reason_notify_change();
4131 hotkey_wakeup_hotunplug_complete_notify_change();
4132 hotkey_poll_setup_safe(false);
4133
4134 /* restore previous mode of adapive keyboard of X1 Carbon */
4135 if (tp_features.has_adaptive_kbd) {
4136 if (!acpi_evalf(hkey_handle, NULL, "STRW", "vd",
4137 adaptive_keyboard_prev_mode)) {
4138 pr_err("Cannot set adaptive keyboard mode.\n");
4139 }
4140 }
4141}
4142
4143/* procfs -------------------------------------------------------------- */
4144static int hotkey_read(struct seq_file *m)
4145{
4146 int res, status;
4147
4148 if (!tp_features.hotkey) {
4149 seq_printf(m, "status:\t\tnot supported\n");
4150 return 0;
4151 }
4152
4153 if (mutex_lock_killable(&hotkey_mutex))
4154 return -ERESTARTSYS;
4155 res = hotkey_status_get(&status);
4156 if (!res)
4157 res = hotkey_mask_get();
4158 mutex_unlock(&hotkey_mutex);
4159 if (res)
4160 return res;
4161
4162 seq_printf(m, "status:\t\t%s\n", str_enabled_disabled(status & BIT(0)));
4163 if (hotkey_all_mask) {
4164 seq_printf(m, "mask:\t\t0x%08x\n", hotkey_user_mask);
4165 seq_printf(m, "commands:\tenable, disable, reset, <mask>\n");
4166 } else {
4167 seq_printf(m, "mask:\t\tnot supported\n");
4168 seq_printf(m, "commands:\tenable, disable, reset\n");
4169 }
4170
4171 return 0;
4172}
4173
4174static void hotkey_enabledisable_warn(bool enable)
4175{
4176 tpacpi_log_usertask("procfs hotkey enable/disable");
4177 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
4178 pr_fmt("hotkey enable/disable functionality has been removed from the driver. Hotkeys are always enabled.\n")))
4179 pr_err("Please remove the hotkey=enable module parameter, it is deprecated. Hotkeys are always enabled.\n");
4180}
4181
4182static int hotkey_write(char *buf)
4183{
4184 int res;
4185 u32 mask;
4186 char *cmd;
4187
4188 if (!tp_features.hotkey)
4189 return -ENODEV;
4190
4191 if (mutex_lock_killable(&hotkey_mutex))
4192 return -ERESTARTSYS;
4193
4194 mask = hotkey_user_mask;
4195
4196 res = 0;
4197 while ((cmd = strsep(&buf, ","))) {
4198 if (strstarts(cmd, "enable")) {
4199 hotkey_enabledisable_warn(1);
4200 } else if (strstarts(cmd, "disable")) {
4201 hotkey_enabledisable_warn(0);
4202 res = -EPERM;
4203 } else if (strstarts(cmd, "reset")) {
4204 mask = (hotkey_all_mask | hotkey_source_mask)
4205 & ~hotkey_reserved_mask;
4206 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
4207 /* mask set */
4208 } else if (sscanf(cmd, "%x", &mask) == 1) {
4209 /* mask set */
4210 } else {
4211 res = -EINVAL;
4212 goto errexit;
4213 }
4214 }
4215
4216 if (!res) {
4217 tpacpi_disclose_usertask("procfs hotkey",
4218 "set mask to 0x%08x\n", mask);
4219 res = hotkey_user_mask_set(mask);
4220 }
4221
4222errexit:
4223 mutex_unlock(&hotkey_mutex);
4224 return res;
4225}
4226
4227static const struct acpi_device_id ibm_htk_device_ids[] = {
4228 {TPACPI_ACPI_IBM_HKEY_HID, 0},
4229 {TPACPI_ACPI_LENOVO_HKEY_HID, 0},
4230 {TPACPI_ACPI_LENOVO_HKEY_V2_HID, 0},
4231 {"", 0},
4232};
4233
4234static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
4235 .hid = ibm_htk_device_ids,
4236 .notify = hotkey_notify,
4237 .handle = &hkey_handle,
4238 .type = ACPI_DEVICE_NOTIFY,
4239};
4240
4241static struct ibm_struct hotkey_driver_data = {
4242 .name = "hotkey",
4243 .read = hotkey_read,
4244 .write = hotkey_write,
4245 .exit = hotkey_exit,
4246 .resume = hotkey_resume,
4247 .suspend = hotkey_suspend,
4248 .acpi = &ibm_hotkey_acpidriver,
4249};
4250
4251/*************************************************************************
4252 * Bluetooth subdriver
4253 */
4254
4255enum {
4256 /* ACPI GBDC/SBDC bits */
4257 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
4258 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
4259 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
4260 0 = disable, 1 = enable */
4261};
4262
4263enum {
4264 /* ACPI \BLTH commands */
4265 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
4266 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
4267 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
4268 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
4269 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
4270};
4271
4272#define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
4273
4274static int bluetooth_get_status(void)
4275{
4276 int status;
4277
4278#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4279 if (dbg_bluetoothemul)
4280 return (tpacpi_bluetooth_emulstate) ?
4281 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4282#endif
4283
4284 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
4285 return -EIO;
4286
4287 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
4288 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4289}
4290
4291static int bluetooth_set_status(enum tpacpi_rfkill_state state)
4292{
4293 int status;
4294
4295 vdbg_printk(TPACPI_DBG_RFKILL, "will attempt to %s bluetooth\n",
4296 str_enable_disable(state == TPACPI_RFK_RADIO_ON));
4297
4298#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4299 if (dbg_bluetoothemul) {
4300 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
4301 return 0;
4302 }
4303#endif
4304
4305 if (state == TPACPI_RFK_RADIO_ON)
4306 status = TP_ACPI_BLUETOOTH_RADIOSSW
4307 | TP_ACPI_BLUETOOTH_RESUMECTRL;
4308 else
4309 status = 0;
4310
4311 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
4312 return -EIO;
4313
4314 return 0;
4315}
4316
4317/* sysfs bluetooth enable ---------------------------------------------- */
4318static ssize_t bluetooth_enable_show(struct device *dev,
4319 struct device_attribute *attr,
4320 char *buf)
4321{
4322 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
4323 attr, buf);
4324}
4325
4326static ssize_t bluetooth_enable_store(struct device *dev,
4327 struct device_attribute *attr,
4328 const char *buf, size_t count)
4329{
4330 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
4331 attr, buf, count);
4332}
4333
4334static DEVICE_ATTR_RW(bluetooth_enable);
4335
4336/* --------------------------------------------------------------------- */
4337
4338static struct attribute *bluetooth_attributes[] = {
4339 &dev_attr_bluetooth_enable.attr,
4340 NULL
4341};
4342
4343static umode_t bluetooth_attr_is_visible(struct kobject *kobj,
4344 struct attribute *attr, int n)
4345{
4346 return tp_features.bluetooth ? attr->mode : 0;
4347}
4348
4349static const struct attribute_group bluetooth_attr_group = {
4350 .is_visible = bluetooth_attr_is_visible,
4351 .attrs = bluetooth_attributes,
4352};
4353
4354static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
4355 .get_status = bluetooth_get_status,
4356 .set_status = bluetooth_set_status,
4357};
4358
4359static void bluetooth_shutdown(void)
4360{
4361 /* Order firmware to save current state to NVRAM */
4362 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
4363 TP_ACPI_BLTH_SAVE_STATE))
4364 pr_notice("failed to save bluetooth state to NVRAM\n");
4365 else
4366 vdbg_printk(TPACPI_DBG_RFKILL,
4367 "bluetooth state saved to NVRAM\n");
4368}
4369
4370static void bluetooth_exit(void)
4371{
4372 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4373 bluetooth_shutdown();
4374}
4375
4376static const struct dmi_system_id fwbug_list[] __initconst = {
4377 {
4378 .ident = "ThinkPad E485",
4379 .driver_data = &quirk_btusb_bug,
4380 .matches = {
4381 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4382 DMI_MATCH(DMI_BOARD_NAME, "20KU"),
4383 },
4384 },
4385 {
4386 .ident = "ThinkPad E585",
4387 .driver_data = &quirk_btusb_bug,
4388 .matches = {
4389 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4390 DMI_MATCH(DMI_BOARD_NAME, "20KV"),
4391 },
4392 },
4393 {
4394 .ident = "ThinkPad A285 - 20MW",
4395 .driver_data = &quirk_btusb_bug,
4396 .matches = {
4397 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4398 DMI_MATCH(DMI_BOARD_NAME, "20MW"),
4399 },
4400 },
4401 {
4402 .ident = "ThinkPad A285 - 20MX",
4403 .driver_data = &quirk_btusb_bug,
4404 .matches = {
4405 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4406 DMI_MATCH(DMI_BOARD_NAME, "20MX"),
4407 },
4408 },
4409 {
4410 .ident = "ThinkPad A485 - 20MU",
4411 .driver_data = &quirk_btusb_bug,
4412 .matches = {
4413 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4414 DMI_MATCH(DMI_BOARD_NAME, "20MU"),
4415 },
4416 },
4417 {
4418 .ident = "ThinkPad A485 - 20MV",
4419 .driver_data = &quirk_btusb_bug,
4420 .matches = {
4421 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
4422 DMI_MATCH(DMI_BOARD_NAME, "20MV"),
4423 },
4424 },
4425 {
4426 .ident = "L14 Gen2 AMD",
4427 .driver_data = &quirk_s2idle_bug,
4428 .matches = {
4429 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4430 DMI_MATCH(DMI_PRODUCT_NAME, "20X5"),
4431 }
4432 },
4433 {
4434 .ident = "T14s Gen2 AMD",
4435 .driver_data = &quirk_s2idle_bug,
4436 .matches = {
4437 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4438 DMI_MATCH(DMI_PRODUCT_NAME, "20XF"),
4439 }
4440 },
4441 {
4442 .ident = "X13 Gen2 AMD",
4443 .driver_data = &quirk_s2idle_bug,
4444 .matches = {
4445 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4446 DMI_MATCH(DMI_PRODUCT_NAME, "20XH"),
4447 }
4448 },
4449 {
4450 .ident = "T14 Gen2 AMD",
4451 .driver_data = &quirk_s2idle_bug,
4452 .matches = {
4453 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4454 DMI_MATCH(DMI_PRODUCT_NAME, "20XK"),
4455 }
4456 },
4457 {
4458 .ident = "T14 Gen1 AMD",
4459 .driver_data = &quirk_s2idle_bug,
4460 .matches = {
4461 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4462 DMI_MATCH(DMI_PRODUCT_NAME, "20UD"),
4463 }
4464 },
4465 {
4466 .ident = "T14 Gen1 AMD",
4467 .driver_data = &quirk_s2idle_bug,
4468 .matches = {
4469 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4470 DMI_MATCH(DMI_PRODUCT_NAME, "20UE"),
4471 }
4472 },
4473 {
4474 .ident = "T14s Gen1 AMD",
4475 .driver_data = &quirk_s2idle_bug,
4476 .matches = {
4477 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4478 DMI_MATCH(DMI_PRODUCT_NAME, "20UH"),
4479 }
4480 },
4481 {
4482 .ident = "P14s Gen1 AMD",
4483 .driver_data = &quirk_s2idle_bug,
4484 .matches = {
4485 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4486 DMI_MATCH(DMI_PRODUCT_NAME, "20Y1"),
4487 }
4488 },
4489 {
4490 .ident = "P14s Gen2 AMD",
4491 .driver_data = &quirk_s2idle_bug,
4492 .matches = {
4493 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4494 DMI_MATCH(DMI_PRODUCT_NAME, "21A0"),
4495 }
4496 },
4497 {
4498 .ident = "P14s Gen2 AMD",
4499 .driver_data = &quirk_s2idle_bug,
4500 .matches = {
4501 DMI_MATCH(DMI_BOARD_VENDOR, "LENOVO"),
4502 DMI_MATCH(DMI_PRODUCT_NAME, "21A1"),
4503 }
4504 },
4505 {}
4506};
4507
4508#ifdef CONFIG_SUSPEND
4509/*
4510 * Lenovo laptops from a variety of generations run a SMI handler during the D3->D0
4511 * transition that occurs specifically when exiting suspend to idle which can cause
4512 * large delays during resume when the IOMMU translation layer is enabled (the default
4513 * behavior) for NVME devices:
4514 *
4515 * To avoid this firmware problem, skip the SMI handler on these machines before the
4516 * D0 transition occurs.
4517 */
4518static void thinkpad_acpi_amd_s2idle_restore(void)
4519{
4520 struct resource *res;
4521 void __iomem *addr;
4522 u8 val;
4523
4524 res = request_mem_region_muxed(tp_features.quirks->s2idle_bug_mmio, 1,
4525 "thinkpad_acpi_pm80");
4526 if (!res)
4527 return;
4528
4529 addr = ioremap(tp_features.quirks->s2idle_bug_mmio, 1);
4530 if (!addr)
4531 goto cleanup_resource;
4532
4533 val = ioread8(addr);
4534 iowrite8(val & ~BIT(0), addr);
4535
4536 iounmap(addr);
4537cleanup_resource:
4538 release_resource(res);
4539 kfree(res);
4540}
4541
4542static struct acpi_s2idle_dev_ops thinkpad_acpi_s2idle_dev_ops = {
4543 .restore = thinkpad_acpi_amd_s2idle_restore,
4544};
4545#endif
4546
4547static const struct pci_device_id fwbug_cards_ids[] __initconst = {
4548 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24F3) },
4549 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x24FD) },
4550 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x2526) },
4551 {}
4552};
4553
4554
4555static int __init have_bt_fwbug(void)
4556{
4557 /*
4558 * Some AMD based ThinkPads have a firmware bug that calling
4559 * "GBDC" will cause bluetooth on Intel wireless cards blocked
4560 */
4561 if (tp_features.quirks && tp_features.quirks->btusb_bug &&
4562 pci_dev_present(fwbug_cards_ids)) {
4563 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4564 FW_BUG "disable bluetooth subdriver for Intel cards\n");
4565 return 1;
4566 } else
4567 return 0;
4568}
4569
4570static int __init bluetooth_init(struct ibm_init_struct *iibm)
4571{
4572 int res;
4573 int status = 0;
4574
4575 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4576 "initializing bluetooth subdriver\n");
4577
4578 TPACPI_ACPIHANDLE_INIT(hkey);
4579
4580 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4581 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
4582 tp_features.bluetooth = !have_bt_fwbug() && hkey_handle &&
4583 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
4584
4585 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4586 "bluetooth is %s, status 0x%02x\n",
4587 str_supported(tp_features.bluetooth),
4588 status);
4589
4590#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4591 if (dbg_bluetoothemul) {
4592 tp_features.bluetooth = 1;
4593 pr_info("bluetooth switch emulation enabled\n");
4594 } else
4595#endif
4596 if (tp_features.bluetooth &&
4597 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
4598 /* no bluetooth hardware present in system */
4599 tp_features.bluetooth = 0;
4600 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4601 "bluetooth hardware not installed\n");
4602 }
4603
4604 if (!tp_features.bluetooth)
4605 return -ENODEV;
4606
4607 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4608 &bluetooth_tprfk_ops,
4609 RFKILL_TYPE_BLUETOOTH,
4610 TPACPI_RFK_BLUETOOTH_SW_NAME,
4611 true);
4612 return res;
4613}
4614
4615/* procfs -------------------------------------------------------------- */
4616static int bluetooth_read(struct seq_file *m)
4617{
4618 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, m);
4619}
4620
4621static int bluetooth_write(char *buf)
4622{
4623 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4624}
4625
4626static struct ibm_struct bluetooth_driver_data = {
4627 .name = "bluetooth",
4628 .read = bluetooth_read,
4629 .write = bluetooth_write,
4630 .exit = bluetooth_exit,
4631 .shutdown = bluetooth_shutdown,
4632};
4633
4634/*************************************************************************
4635 * Wan subdriver
4636 */
4637
4638enum {
4639 /* ACPI GWAN/SWAN bits */
4640 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4641 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4642 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4643 0 = disable, 1 = enable */
4644};
4645
4646#define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4647
4648static int wan_get_status(void)
4649{
4650 int status;
4651
4652#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4653 if (dbg_wwanemul)
4654 return (tpacpi_wwan_emulstate) ?
4655 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4656#endif
4657
4658 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4659 return -EIO;
4660
4661 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4662 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4663}
4664
4665static int wan_set_status(enum tpacpi_rfkill_state state)
4666{
4667 int status;
4668
4669 vdbg_printk(TPACPI_DBG_RFKILL, "will attempt to %s wwan\n",
4670 str_enable_disable(state == TPACPI_RFK_RADIO_ON));
4671
4672#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4673 if (dbg_wwanemul) {
4674 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4675 return 0;
4676 }
4677#endif
4678
4679 if (state == TPACPI_RFK_RADIO_ON)
4680 status = TP_ACPI_WANCARD_RADIOSSW
4681 | TP_ACPI_WANCARD_RESUMECTRL;
4682 else
4683 status = 0;
4684
4685 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4686 return -EIO;
4687
4688 return 0;
4689}
4690
4691/* sysfs wan enable ---------------------------------------------------- */
4692static ssize_t wan_enable_show(struct device *dev,
4693 struct device_attribute *attr,
4694 char *buf)
4695{
4696 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4697 attr, buf);
4698}
4699
4700static ssize_t wan_enable_store(struct device *dev,
4701 struct device_attribute *attr,
4702 const char *buf, size_t count)
4703{
4704 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4705 attr, buf, count);
4706}
4707
4708static DEVICE_ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4709 wan_enable_show, wan_enable_store);
4710
4711/* --------------------------------------------------------------------- */
4712
4713static struct attribute *wan_attributes[] = {
4714 &dev_attr_wwan_enable.attr,
4715 NULL
4716};
4717
4718static umode_t wan_attr_is_visible(struct kobject *kobj, struct attribute *attr,
4719 int n)
4720{
4721 return tp_features.wan ? attr->mode : 0;
4722}
4723
4724static const struct attribute_group wan_attr_group = {
4725 .is_visible = wan_attr_is_visible,
4726 .attrs = wan_attributes,
4727};
4728
4729static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4730 .get_status = wan_get_status,
4731 .set_status = wan_set_status,
4732};
4733
4734static void wan_shutdown(void)
4735{
4736 /* Order firmware to save current state to NVRAM */
4737 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4738 TP_ACPI_WGSV_SAVE_STATE))
4739 pr_notice("failed to save WWAN state to NVRAM\n");
4740 else
4741 vdbg_printk(TPACPI_DBG_RFKILL,
4742 "WWAN state saved to NVRAM\n");
4743}
4744
4745static void wan_exit(void)
4746{
4747 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4748 wan_shutdown();
4749}
4750
4751static int __init wan_init(struct ibm_init_struct *iibm)
4752{
4753 int res;
4754 int status = 0;
4755
4756 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4757 "initializing wan subdriver\n");
4758
4759 TPACPI_ACPIHANDLE_INIT(hkey);
4760
4761 tp_features.wan = hkey_handle &&
4762 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4763
4764 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4765 "wan is %s, status 0x%02x\n",
4766 str_supported(tp_features.wan),
4767 status);
4768
4769#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4770 if (dbg_wwanemul) {
4771 tp_features.wan = 1;
4772 pr_info("wwan switch emulation enabled\n");
4773 } else
4774#endif
4775 if (tp_features.wan &&
4776 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4777 /* no wan hardware present in system */
4778 tp_features.wan = 0;
4779 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4780 "wan hardware not installed\n");
4781 }
4782
4783 if (!tp_features.wan)
4784 return -ENODEV;
4785
4786 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4787 &wan_tprfk_ops,
4788 RFKILL_TYPE_WWAN,
4789 TPACPI_RFK_WWAN_SW_NAME,
4790 true);
4791 return res;
4792}
4793
4794/* procfs -------------------------------------------------------------- */
4795static int wan_read(struct seq_file *m)
4796{
4797 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, m);
4798}
4799
4800static int wan_write(char *buf)
4801{
4802 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4803}
4804
4805static struct ibm_struct wan_driver_data = {
4806 .name = "wan",
4807 .read = wan_read,
4808 .write = wan_write,
4809 .exit = wan_exit,
4810 .shutdown = wan_shutdown,
4811};
4812
4813/*************************************************************************
4814 * UWB subdriver
4815 */
4816
4817enum {
4818 /* ACPI GUWB/SUWB bits */
4819 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4820 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4821};
4822
4823#define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4824
4825static int uwb_get_status(void)
4826{
4827 int status;
4828
4829#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4830 if (dbg_uwbemul)
4831 return (tpacpi_uwb_emulstate) ?
4832 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4833#endif
4834
4835 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4836 return -EIO;
4837
4838 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4839 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4840}
4841
4842static int uwb_set_status(enum tpacpi_rfkill_state state)
4843{
4844 int status;
4845
4846 vdbg_printk(TPACPI_DBG_RFKILL, "will attempt to %s UWB\n",
4847 str_enable_disable(state == TPACPI_RFK_RADIO_ON));
4848
4849#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4850 if (dbg_uwbemul) {
4851 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4852 return 0;
4853 }
4854#endif
4855
4856 if (state == TPACPI_RFK_RADIO_ON)
4857 status = TP_ACPI_UWB_RADIOSSW;
4858 else
4859 status = 0;
4860
4861 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4862 return -EIO;
4863
4864 return 0;
4865}
4866
4867/* --------------------------------------------------------------------- */
4868
4869static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4870 .get_status = uwb_get_status,
4871 .set_status = uwb_set_status,
4872};
4873
4874static void uwb_exit(void)
4875{
4876 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4877}
4878
4879static int __init uwb_init(struct ibm_init_struct *iibm)
4880{
4881 int res;
4882 int status = 0;
4883
4884 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4885 "initializing uwb subdriver\n");
4886
4887 TPACPI_ACPIHANDLE_INIT(hkey);
4888
4889 tp_features.uwb = hkey_handle &&
4890 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4891
4892 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4893 "uwb is %s, status 0x%02x\n",
4894 str_supported(tp_features.uwb),
4895 status);
4896
4897#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4898 if (dbg_uwbemul) {
4899 tp_features.uwb = 1;
4900 pr_info("uwb switch emulation enabled\n");
4901 } else
4902#endif
4903 if (tp_features.uwb &&
4904 !(status & TP_ACPI_UWB_HWPRESENT)) {
4905 /* no uwb hardware present in system */
4906 tp_features.uwb = 0;
4907 dbg_printk(TPACPI_DBG_INIT,
4908 "uwb hardware not installed\n");
4909 }
4910
4911 if (!tp_features.uwb)
4912 return -ENODEV;
4913
4914 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4915 &uwb_tprfk_ops,
4916 RFKILL_TYPE_UWB,
4917 TPACPI_RFK_UWB_SW_NAME,
4918 false);
4919 return res;
4920}
4921
4922static struct ibm_struct uwb_driver_data = {
4923 .name = "uwb",
4924 .exit = uwb_exit,
4925 .flags.experimental = 1,
4926};
4927
4928/*************************************************************************
4929 * Video subdriver
4930 */
4931
4932#ifdef CONFIG_THINKPAD_ACPI_VIDEO
4933
4934enum video_access_mode {
4935 TPACPI_VIDEO_NONE = 0,
4936 TPACPI_VIDEO_570, /* 570 */
4937 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4938 TPACPI_VIDEO_NEW, /* all others */
4939};
4940
4941enum { /* video status flags, based on VIDEO_570 */
4942 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4943 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4944 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4945};
4946
4947enum { /* TPACPI_VIDEO_570 constants */
4948 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4949 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4950 * video_status_flags */
4951 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4952 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4953};
4954
4955static enum video_access_mode video_supported;
4956static int video_orig_autosw;
4957
4958static int video_autosw_get(void);
4959static int video_autosw_set(int enable);
4960
4961TPACPI_HANDLE(vid, root,
4962 "\\_SB.PCI.AGP.VGA", /* 570 */
4963 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
4964 "\\_SB.PCI0.VID0", /* 770e */
4965 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
4966 "\\_SB.PCI0.AGP.VGA", /* X100e and a few others */
4967 "\\_SB.PCI0.AGP.VID", /* all others */
4968 ); /* R30, R31 */
4969
4970TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4971
4972static int __init video_init(struct ibm_init_struct *iibm)
4973{
4974 int ivga;
4975
4976 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4977
4978 TPACPI_ACPIHANDLE_INIT(vid);
4979 if (tpacpi_is_ibm())
4980 TPACPI_ACPIHANDLE_INIT(vid2);
4981
4982 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4983 /* G41, assume IVGA doesn't change */
4984 vid_handle = vid2_handle;
4985
4986 if (!vid_handle)
4987 /* video switching not supported on R30, R31 */
4988 video_supported = TPACPI_VIDEO_NONE;
4989 else if (tpacpi_is_ibm() &&
4990 acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4991 /* 570 */
4992 video_supported = TPACPI_VIDEO_570;
4993 else if (tpacpi_is_ibm() &&
4994 acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4995 /* 600e/x, 770e, 770x */
4996 video_supported = TPACPI_VIDEO_770;
4997 else
4998 /* all others */
4999 video_supported = TPACPI_VIDEO_NEW;
5000
5001 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
5002 str_supported(video_supported != TPACPI_VIDEO_NONE),
5003 video_supported);
5004
5005 return (video_supported != TPACPI_VIDEO_NONE) ? 0 : -ENODEV;
5006}
5007
5008static void video_exit(void)
5009{
5010 dbg_printk(TPACPI_DBG_EXIT,
5011 "restoring original video autoswitch mode\n");
5012 if (video_autosw_set(video_orig_autosw))
5013 pr_err("error while trying to restore original video autoswitch mode\n");
5014}
5015
5016static int video_outputsw_get(void)
5017{
5018 int status = 0;
5019 int i;
5020
5021 switch (video_supported) {
5022 case TPACPI_VIDEO_570:
5023 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
5024 TP_ACPI_VIDEO_570_PHSCMD))
5025 return -EIO;
5026 status = i & TP_ACPI_VIDEO_570_PHSMASK;
5027 break;
5028 case TPACPI_VIDEO_770:
5029 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
5030 return -EIO;
5031 if (i)
5032 status |= TP_ACPI_VIDEO_S_LCD;
5033 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
5034 return -EIO;
5035 if (i)
5036 status |= TP_ACPI_VIDEO_S_CRT;
5037 break;
5038 case TPACPI_VIDEO_NEW:
5039 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
5040 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
5041 return -EIO;
5042 if (i)
5043 status |= TP_ACPI_VIDEO_S_CRT;
5044
5045 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
5046 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
5047 return -EIO;
5048 if (i)
5049 status |= TP_ACPI_VIDEO_S_LCD;
5050 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
5051 return -EIO;
5052 if (i)
5053 status |= TP_ACPI_VIDEO_S_DVI;
5054 break;
5055 default:
5056 return -ENOSYS;
5057 }
5058
5059 return status;
5060}
5061
5062static int video_outputsw_set(int status)
5063{
5064 int autosw;
5065 int res = 0;
5066
5067 switch (video_supported) {
5068 case TPACPI_VIDEO_570:
5069 res = acpi_evalf(NULL, NULL,
5070 "\\_SB.PHS2", "vdd",
5071 TP_ACPI_VIDEO_570_PHS2CMD,
5072 status | TP_ACPI_VIDEO_570_PHS2SET);
5073 break;
5074 case TPACPI_VIDEO_770:
5075 autosw = video_autosw_get();
5076 if (autosw < 0)
5077 return autosw;
5078
5079 res = video_autosw_set(1);
5080 if (res)
5081 return res;
5082 res = acpi_evalf(vid_handle, NULL,
5083 "ASWT", "vdd", status * 0x100, 0);
5084 if (!autosw && video_autosw_set(autosw)) {
5085 pr_err("video auto-switch left enabled due to error\n");
5086 return -EIO;
5087 }
5088 break;
5089 case TPACPI_VIDEO_NEW:
5090 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
5091 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
5092 break;
5093 default:
5094 return -ENOSYS;
5095 }
5096
5097 return (res) ? 0 : -EIO;
5098}
5099
5100static int video_autosw_get(void)
5101{
5102 int autosw = 0;
5103
5104 switch (video_supported) {
5105 case TPACPI_VIDEO_570:
5106 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
5107 return -EIO;
5108 break;
5109 case TPACPI_VIDEO_770:
5110 case TPACPI_VIDEO_NEW:
5111 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
5112 return -EIO;
5113 break;
5114 default:
5115 return -ENOSYS;
5116 }
5117
5118 return autosw & 1;
5119}
5120
5121static int video_autosw_set(int enable)
5122{
5123 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable) ? 1 : 0))
5124 return -EIO;
5125 return 0;
5126}
5127
5128static int video_outputsw_cycle(void)
5129{
5130 int autosw = video_autosw_get();
5131 int res;
5132
5133 if (autosw < 0)
5134 return autosw;
5135
5136 switch (video_supported) {
5137 case TPACPI_VIDEO_570:
5138 res = video_autosw_set(1);
5139 if (res)
5140 return res;
5141 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
5142 break;
5143 case TPACPI_VIDEO_770:
5144 case TPACPI_VIDEO_NEW:
5145 res = video_autosw_set(1);
5146 if (res)
5147 return res;
5148 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
5149 break;
5150 default:
5151 return -ENOSYS;
5152 }
5153 if (!autosw && video_autosw_set(autosw)) {
5154 pr_err("video auto-switch left enabled due to error\n");
5155 return -EIO;
5156 }
5157
5158 return (res) ? 0 : -EIO;
5159}
5160
5161static int video_expand_toggle(void)
5162{
5163 switch (video_supported) {
5164 case TPACPI_VIDEO_570:
5165 return acpi_evalf(ec_handle, NULL, "_Q17", "v") ?
5166 0 : -EIO;
5167 case TPACPI_VIDEO_770:
5168 return acpi_evalf(vid_handle, NULL, "VEXP", "v") ?
5169 0 : -EIO;
5170 case TPACPI_VIDEO_NEW:
5171 return acpi_evalf(NULL, NULL, "\\VEXP", "v") ?
5172 0 : -EIO;
5173 default:
5174 return -ENOSYS;
5175 }
5176 /* not reached */
5177}
5178
5179static int video_read(struct seq_file *m)
5180{
5181 int status, autosw;
5182
5183 if (video_supported == TPACPI_VIDEO_NONE) {
5184 seq_printf(m, "status:\t\tnot supported\n");
5185 return 0;
5186 }
5187
5188 /* Even reads can crash X.org, so... */
5189 if (!capable(CAP_SYS_ADMIN))
5190 return -EPERM;
5191
5192 status = video_outputsw_get();
5193 if (status < 0)
5194 return status;
5195
5196 autosw = video_autosw_get();
5197 if (autosw < 0)
5198 return autosw;
5199
5200 seq_printf(m, "status:\t\tsupported\n");
5201 seq_printf(m, "lcd:\t\t%s\n", str_enabled_disabled(status & BIT(0)));
5202 seq_printf(m, "crt:\t\t%s\n", str_enabled_disabled(status & BIT(1)));
5203 if (video_supported == TPACPI_VIDEO_NEW)
5204 seq_printf(m, "dvi:\t\t%s\n", str_enabled_disabled(status & BIT(3)));
5205 seq_printf(m, "auto:\t\t%s\n", str_enabled_disabled(autosw & BIT(0)));
5206 seq_printf(m, "commands:\tlcd_enable, lcd_disable\n");
5207 seq_printf(m, "commands:\tcrt_enable, crt_disable\n");
5208 if (video_supported == TPACPI_VIDEO_NEW)
5209 seq_printf(m, "commands:\tdvi_enable, dvi_disable\n");
5210 seq_printf(m, "commands:\tauto_enable, auto_disable\n");
5211 seq_printf(m, "commands:\tvideo_switch, expand_toggle\n");
5212
5213 return 0;
5214}
5215
5216static int video_write(char *buf)
5217{
5218 char *cmd;
5219 int enable, disable, status;
5220 int res;
5221
5222 if (video_supported == TPACPI_VIDEO_NONE)
5223 return -ENODEV;
5224
5225 /* Even reads can crash X.org, let alone writes... */
5226 if (!capable(CAP_SYS_ADMIN))
5227 return -EPERM;
5228
5229 enable = 0;
5230 disable = 0;
5231
5232 while ((cmd = strsep(&buf, ","))) {
5233 if (strstarts(cmd, "lcd_enable")) {
5234 enable |= TP_ACPI_VIDEO_S_LCD;
5235 } else if (strstarts(cmd, "lcd_disable")) {
5236 disable |= TP_ACPI_VIDEO_S_LCD;
5237 } else if (strstarts(cmd, "crt_enable")) {
5238 enable |= TP_ACPI_VIDEO_S_CRT;
5239 } else if (strstarts(cmd, "crt_disable")) {
5240 disable |= TP_ACPI_VIDEO_S_CRT;
5241 } else if (video_supported == TPACPI_VIDEO_NEW &&
5242 strstarts(cmd, "dvi_enable")) {
5243 enable |= TP_ACPI_VIDEO_S_DVI;
5244 } else if (video_supported == TPACPI_VIDEO_NEW &&
5245 strstarts(cmd, "dvi_disable")) {
5246 disable |= TP_ACPI_VIDEO_S_DVI;
5247 } else if (strstarts(cmd, "auto_enable")) {
5248 res = video_autosw_set(1);
5249 if (res)
5250 return res;
5251 } else if (strstarts(cmd, "auto_disable")) {
5252 res = video_autosw_set(0);
5253 if (res)
5254 return res;
5255 } else if (strstarts(cmd, "video_switch")) {
5256 res = video_outputsw_cycle();
5257 if (res)
5258 return res;
5259 } else if (strstarts(cmd, "expand_toggle")) {
5260 res = video_expand_toggle();
5261 if (res)
5262 return res;
5263 } else
5264 return -EINVAL;
5265 }
5266
5267 if (enable || disable) {
5268 status = video_outputsw_get();
5269 if (status < 0)
5270 return status;
5271 res = video_outputsw_set((status & ~disable) | enable);
5272 if (res)
5273 return res;
5274 }
5275
5276 return 0;
5277}
5278
5279static struct ibm_struct video_driver_data = {
5280 .name = "video",
5281 .read = video_read,
5282 .write = video_write,
5283 .exit = video_exit,
5284};
5285
5286#endif /* CONFIG_THINKPAD_ACPI_VIDEO */
5287
5288/*************************************************************************
5289 * Keyboard backlight subdriver
5290 */
5291
5292static enum led_brightness kbdlight_brightness;
5293static DEFINE_MUTEX(kbdlight_mutex);
5294
5295static int kbdlight_set_level(int level)
5296{
5297 int ret = 0;
5298
5299 if (!hkey_handle)
5300 return -ENXIO;
5301
5302 mutex_lock(&kbdlight_mutex);
5303
5304 if (!acpi_evalf(hkey_handle, NULL, "MLCS", "dd", level))
5305 ret = -EIO;
5306 else
5307 kbdlight_brightness = level;
5308
5309 mutex_unlock(&kbdlight_mutex);
5310
5311 return ret;
5312}
5313
5314static int kbdlight_get_level(void)
5315{
5316 int status = 0;
5317
5318 if (!hkey_handle)
5319 return -ENXIO;
5320
5321 if (!acpi_evalf(hkey_handle, &status, "MLCG", "dd", 0))
5322 return -EIO;
5323
5324 if (status < 0)
5325 return status;
5326
5327 return status & 0x3;
5328}
5329
5330static bool kbdlight_is_supported(void)
5331{
5332 int status = 0;
5333
5334 if (!hkey_handle)
5335 return false;
5336
5337 if (!acpi_has_method(hkey_handle, "MLCG")) {
5338 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG is unavailable\n");
5339 return false;
5340 }
5341
5342 if (!acpi_evalf(hkey_handle, &status, "MLCG", "qdd", 0)) {
5343 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG failed\n");
5344 return false;
5345 }
5346
5347 if (status < 0) {
5348 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG err: %d\n", status);
5349 return false;
5350 }
5351
5352 vdbg_printk(TPACPI_DBG_INIT, "kbdlight MLCG returned 0x%x\n", status);
5353 /*
5354 * Guessed test for keyboard backlight:
5355 *
5356 * Machines with backlight keyboard return:
5357 * b010100000010000000XX - ThinkPad X1 Carbon 3rd
5358 * b110100010010000000XX - ThinkPad x230
5359 * b010100000010000000XX - ThinkPad x240
5360 * b010100000010000000XX - ThinkPad W541
5361 * (XX is current backlight level)
5362 *
5363 * Machines without backlight keyboard return:
5364 * b10100001000000000000 - ThinkPad x230
5365 * b10110001000000000000 - ThinkPad E430
5366 * b00000000000000000000 - ThinkPad E450
5367 *
5368 * Candidate BITs for detection test (XOR):
5369 * b01000000001000000000
5370 * ^
5371 */
5372 return status & BIT(9);
5373}
5374
5375static int kbdlight_sysfs_set(struct led_classdev *led_cdev,
5376 enum led_brightness brightness)
5377{
5378 return kbdlight_set_level(brightness);
5379}
5380
5381static enum led_brightness kbdlight_sysfs_get(struct led_classdev *led_cdev)
5382{
5383 int level;
5384
5385 level = kbdlight_get_level();
5386 if (level < 0)
5387 return 0;
5388
5389 return level;
5390}
5391
5392static struct tpacpi_led_classdev tpacpi_led_kbdlight = {
5393 .led_classdev = {
5394 .name = "tpacpi::kbd_backlight",
5395 .max_brightness = 2,
5396 .flags = LED_BRIGHT_HW_CHANGED,
5397 .brightness_set_blocking = &kbdlight_sysfs_set,
5398 .brightness_get = &kbdlight_sysfs_get,
5399 }
5400};
5401
5402static int __init kbdlight_init(struct ibm_init_struct *iibm)
5403{
5404 int rc;
5405
5406 vdbg_printk(TPACPI_DBG_INIT, "initializing kbdlight subdriver\n");
5407
5408 TPACPI_ACPIHANDLE_INIT(hkey);
5409
5410 if (!kbdlight_is_supported()) {
5411 tp_features.kbdlight = 0;
5412 vdbg_printk(TPACPI_DBG_INIT, "kbdlight is unsupported\n");
5413 return -ENODEV;
5414 }
5415
5416 kbdlight_brightness = kbdlight_sysfs_get(NULL);
5417 tp_features.kbdlight = 1;
5418
5419 rc = led_classdev_register(&tpacpi_pdev->dev,
5420 &tpacpi_led_kbdlight.led_classdev);
5421 if (rc < 0) {
5422 tp_features.kbdlight = 0;
5423 return rc;
5424 }
5425
5426 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask |
5427 TP_ACPI_HKEY_KBD_LIGHT_MASK);
5428 return 0;
5429}
5430
5431static void kbdlight_exit(void)
5432{
5433 led_classdev_unregister(&tpacpi_led_kbdlight.led_classdev);
5434}
5435
5436static int kbdlight_set_level_and_update(int level)
5437{
5438 int ret;
5439 struct led_classdev *led_cdev;
5440
5441 ret = kbdlight_set_level(level);
5442 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5443
5444 if (ret == 0 && !(led_cdev->flags & LED_SUSPENDED))
5445 led_cdev->brightness = level;
5446
5447 return ret;
5448}
5449
5450static int kbdlight_read(struct seq_file *m)
5451{
5452 int level;
5453
5454 if (!tp_features.kbdlight) {
5455 seq_printf(m, "status:\t\tnot supported\n");
5456 } else {
5457 level = kbdlight_get_level();
5458 if (level < 0)
5459 seq_printf(m, "status:\t\terror %d\n", level);
5460 else
5461 seq_printf(m, "status:\t\t%d\n", level);
5462 seq_printf(m, "commands:\t0, 1, 2\n");
5463 }
5464
5465 return 0;
5466}
5467
5468static int kbdlight_write(char *buf)
5469{
5470 char *cmd;
5471 int res, level = -EINVAL;
5472
5473 if (!tp_features.kbdlight)
5474 return -ENODEV;
5475
5476 while ((cmd = strsep(&buf, ","))) {
5477 res = kstrtoint(cmd, 10, &level);
5478 if (res < 0)
5479 return res;
5480 }
5481
5482 if (level >= 3 || level < 0)
5483 return -EINVAL;
5484
5485 return kbdlight_set_level_and_update(level);
5486}
5487
5488static void kbdlight_suspend(void)
5489{
5490 struct led_classdev *led_cdev;
5491
5492 if (!tp_features.kbdlight)
5493 return;
5494
5495 led_cdev = &tpacpi_led_kbdlight.led_classdev;
5496 led_update_brightness(led_cdev);
5497 led_classdev_suspend(led_cdev);
5498}
5499
5500static void kbdlight_resume(void)
5501{
5502 if (!tp_features.kbdlight)
5503 return;
5504
5505 led_classdev_resume(&tpacpi_led_kbdlight.led_classdev);
5506}
5507
5508static struct ibm_struct kbdlight_driver_data = {
5509 .name = "kbdlight",
5510 .read = kbdlight_read,
5511 .write = kbdlight_write,
5512 .suspend = kbdlight_suspend,
5513 .resume = kbdlight_resume,
5514 .exit = kbdlight_exit,
5515};
5516
5517/*************************************************************************
5518 * Light (thinklight) subdriver
5519 */
5520
5521TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
5522TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
5523
5524static int light_get_status(void)
5525{
5526 int status = 0;
5527
5528 if (tp_features.light_status) {
5529 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
5530 return -EIO;
5531 return (!!status);
5532 }
5533
5534 return -ENXIO;
5535}
5536
5537static int light_set_status(int status)
5538{
5539 int rc;
5540
5541 if (tp_features.light) {
5542 if (cmos_handle) {
5543 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
5544 (status) ?
5545 TP_CMOS_THINKLIGHT_ON :
5546 TP_CMOS_THINKLIGHT_OFF);
5547 } else {
5548 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
5549 (status) ? 1 : 0);
5550 }
5551 return (rc) ? 0 : -EIO;
5552 }
5553
5554 return -ENXIO;
5555}
5556
5557static int light_sysfs_set(struct led_classdev *led_cdev,
5558 enum led_brightness brightness)
5559{
5560 return light_set_status((brightness != LED_OFF) ?
5561 TPACPI_LED_ON : TPACPI_LED_OFF);
5562}
5563
5564static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
5565{
5566 return (light_get_status() == 1) ? LED_ON : LED_OFF;
5567}
5568
5569static struct tpacpi_led_classdev tpacpi_led_thinklight = {
5570 .led_classdev = {
5571 .name = "tpacpi::thinklight",
5572 .max_brightness = 1,
5573 .brightness_set_blocking = &light_sysfs_set,
5574 .brightness_get = &light_sysfs_get,
5575 }
5576};
5577
5578static int __init light_init(struct ibm_init_struct *iibm)
5579{
5580 int rc;
5581
5582 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
5583
5584 if (tpacpi_is_ibm()) {
5585 TPACPI_ACPIHANDLE_INIT(ledb);
5586 TPACPI_ACPIHANDLE_INIT(lght);
5587 }
5588 TPACPI_ACPIHANDLE_INIT(cmos);
5589
5590 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
5591 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
5592
5593 if (tp_features.light)
5594 /* light status not supported on
5595 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
5596 tp_features.light_status =
5597 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
5598
5599 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
5600 str_supported(tp_features.light),
5601 str_supported(tp_features.light_status));
5602
5603 if (!tp_features.light)
5604 return -ENODEV;
5605
5606 rc = led_classdev_register(&tpacpi_pdev->dev,
5607 &tpacpi_led_thinklight.led_classdev);
5608
5609 if (rc < 0) {
5610 tp_features.light = 0;
5611 tp_features.light_status = 0;
5612 } else {
5613 rc = 0;
5614 }
5615
5616 return rc;
5617}
5618
5619static void light_exit(void)
5620{
5621 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
5622}
5623
5624static int light_read(struct seq_file *m)
5625{
5626 int status;
5627
5628 if (!tp_features.light) {
5629 seq_printf(m, "status:\t\tnot supported\n");
5630 } else if (!tp_features.light_status) {
5631 seq_printf(m, "status:\t\tunknown\n");
5632 seq_printf(m, "commands:\ton, off\n");
5633 } else {
5634 status = light_get_status();
5635 if (status < 0)
5636 return status;
5637 seq_printf(m, "status:\t\t%s\n", str_on_off(status & BIT(0)));
5638 seq_printf(m, "commands:\ton, off\n");
5639 }
5640
5641 return 0;
5642}
5643
5644static int light_write(char *buf)
5645{
5646 char *cmd;
5647 int newstatus = 0;
5648
5649 if (!tp_features.light)
5650 return -ENODEV;
5651
5652 while ((cmd = strsep(&buf, ","))) {
5653 if (strstarts(cmd, "on")) {
5654 newstatus = 1;
5655 } else if (strstarts(cmd, "off")) {
5656 newstatus = 0;
5657 } else
5658 return -EINVAL;
5659 }
5660
5661 return light_set_status(newstatus);
5662}
5663
5664static struct ibm_struct light_driver_data = {
5665 .name = "light",
5666 .read = light_read,
5667 .write = light_write,
5668 .exit = light_exit,
5669};
5670
5671/*************************************************************************
5672 * CMOS subdriver
5673 */
5674
5675/* sysfs cmos_command -------------------------------------------------- */
5676static ssize_t cmos_command_store(struct device *dev,
5677 struct device_attribute *attr,
5678 const char *buf, size_t count)
5679{
5680 unsigned long cmos_cmd;
5681 int res;
5682
5683 if (parse_strtoul(buf, 21, &cmos_cmd))
5684 return -EINVAL;
5685
5686 res = issue_thinkpad_cmos_command(cmos_cmd);
5687 return (res) ? res : count;
5688}
5689
5690static DEVICE_ATTR_WO(cmos_command);
5691
5692static struct attribute *cmos_attributes[] = {
5693 &dev_attr_cmos_command.attr,
5694 NULL
5695};
5696
5697static umode_t cmos_attr_is_visible(struct kobject *kobj,
5698 struct attribute *attr, int n)
5699{
5700 return cmos_handle ? attr->mode : 0;
5701}
5702
5703static const struct attribute_group cmos_attr_group = {
5704 .is_visible = cmos_attr_is_visible,
5705 .attrs = cmos_attributes,
5706};
5707
5708/* --------------------------------------------------------------------- */
5709
5710static int __init cmos_init(struct ibm_init_struct *iibm)
5711{
5712 vdbg_printk(TPACPI_DBG_INIT,
5713 "initializing cmos commands subdriver\n");
5714
5715 TPACPI_ACPIHANDLE_INIT(cmos);
5716
5717 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
5718 str_supported(cmos_handle != NULL));
5719
5720 return cmos_handle ? 0 : -ENODEV;
5721}
5722
5723static int cmos_read(struct seq_file *m)
5724{
5725 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
5726 R30, R31, T20-22, X20-21 */
5727 if (!cmos_handle)
5728 seq_printf(m, "status:\t\tnot supported\n");
5729 else {
5730 seq_printf(m, "status:\t\tsupported\n");
5731 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-21)\n");
5732 }
5733
5734 return 0;
5735}
5736
5737static int cmos_write(char *buf)
5738{
5739 char *cmd;
5740 int cmos_cmd, res;
5741
5742 while ((cmd = strsep(&buf, ","))) {
5743 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
5744 cmos_cmd >= 0 && cmos_cmd <= 21) {
5745 /* cmos_cmd set */
5746 } else
5747 return -EINVAL;
5748
5749 res = issue_thinkpad_cmos_command(cmos_cmd);
5750 if (res)
5751 return res;
5752 }
5753
5754 return 0;
5755}
5756
5757static struct ibm_struct cmos_driver_data = {
5758 .name = "cmos",
5759 .read = cmos_read,
5760 .write = cmos_write,
5761};
5762
5763/*************************************************************************
5764 * LED subdriver
5765 */
5766
5767enum led_access_mode {
5768 TPACPI_LED_NONE = 0,
5769 TPACPI_LED_570, /* 570 */
5770 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5771 TPACPI_LED_NEW, /* all others */
5772};
5773
5774enum { /* For TPACPI_LED_OLD */
5775 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
5776 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
5777 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
5778};
5779
5780static enum led_access_mode led_supported;
5781
5782static acpi_handle led_handle;
5783
5784#define TPACPI_LED_NUMLEDS 16
5785static struct tpacpi_led_classdev *tpacpi_leds;
5786static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
5787static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
5788 /* there's a limit of 19 chars + NULL before 2.6.26 */
5789 "tpacpi::power",
5790 "tpacpi:orange:batt",
5791 "tpacpi:green:batt",
5792 "tpacpi::dock_active",
5793 "tpacpi::bay_active",
5794 "tpacpi::dock_batt",
5795 "tpacpi::unknown_led",
5796 "tpacpi::standby",
5797 "tpacpi::dock_status1",
5798 "tpacpi::dock_status2",
5799 "tpacpi::lid_logo_dot",
5800 "tpacpi::unknown_led3",
5801 "tpacpi::thinkvantage",
5802};
5803#define TPACPI_SAFE_LEDS 0x1481U
5804
5805static inline bool tpacpi_is_led_restricted(const unsigned int led)
5806{
5807#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5808 return false;
5809#else
5810 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5811#endif
5812}
5813
5814static int led_get_status(const unsigned int led)
5815{
5816 int status;
5817 enum led_status_t led_s;
5818
5819 switch (led_supported) {
5820 case TPACPI_LED_570:
5821 if (!acpi_evalf(ec_handle,
5822 &status, "GLED", "dd", 1 << led))
5823 return -EIO;
5824 led_s = (status == 0) ?
5825 TPACPI_LED_OFF :
5826 ((status == 1) ?
5827 TPACPI_LED_ON :
5828 TPACPI_LED_BLINK);
5829 tpacpi_led_state_cache[led] = led_s;
5830 return led_s;
5831 default:
5832 return -ENXIO;
5833 }
5834
5835 /* not reached */
5836}
5837
5838static int led_set_status(const unsigned int led,
5839 const enum led_status_t ledstatus)
5840{
5841 /* off, on, blink. Index is led_status_t */
5842 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5843 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5844
5845 int rc = 0;
5846
5847 switch (led_supported) {
5848 case TPACPI_LED_570:
5849 /* 570 */
5850 if (unlikely(led > 7))
5851 return -EINVAL;
5852 if (unlikely(tpacpi_is_led_restricted(led)))
5853 return -EPERM;
5854 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5855 (1 << led), led_sled_arg1[ledstatus]))
5856 return -EIO;
5857 break;
5858 case TPACPI_LED_OLD:
5859 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5860 if (unlikely(led > 7))
5861 return -EINVAL;
5862 if (unlikely(tpacpi_is_led_restricted(led)))
5863 return -EPERM;
5864 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5865 if (rc >= 0)
5866 rc = ec_write(TPACPI_LED_EC_HLBL,
5867 (ledstatus == TPACPI_LED_BLINK) << led);
5868 if (rc >= 0)
5869 rc = ec_write(TPACPI_LED_EC_HLCL,
5870 (ledstatus != TPACPI_LED_OFF) << led);
5871 break;
5872 case TPACPI_LED_NEW:
5873 /* all others */
5874 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5875 return -EINVAL;
5876 if (unlikely(tpacpi_is_led_restricted(led)))
5877 return -EPERM;
5878 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5879 led, led_led_arg1[ledstatus]))
5880 return -EIO;
5881 break;
5882 default:
5883 return -ENXIO;
5884 }
5885
5886 if (!rc)
5887 tpacpi_led_state_cache[led] = ledstatus;
5888
5889 return rc;
5890}
5891
5892static int led_sysfs_set(struct led_classdev *led_cdev,
5893 enum led_brightness brightness)
5894{
5895 struct tpacpi_led_classdev *data = container_of(led_cdev,
5896 struct tpacpi_led_classdev, led_classdev);
5897 enum led_status_t new_state;
5898
5899 if (brightness == LED_OFF)
5900 new_state = TPACPI_LED_OFF;
5901 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5902 new_state = TPACPI_LED_ON;
5903 else
5904 new_state = TPACPI_LED_BLINK;
5905
5906 return led_set_status(data->led, new_state);
5907}
5908
5909static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5910 unsigned long *delay_on, unsigned long *delay_off)
5911{
5912 struct tpacpi_led_classdev *data = container_of(led_cdev,
5913 struct tpacpi_led_classdev, led_classdev);
5914
5915 /* Can we choose the flash rate? */
5916 if (*delay_on == 0 && *delay_off == 0) {
5917 /* yes. set them to the hardware blink rate (1 Hz) */
5918 *delay_on = 500; /* ms */
5919 *delay_off = 500; /* ms */
5920 } else if ((*delay_on != 500) || (*delay_off != 500))
5921 return -EINVAL;
5922
5923 return led_set_status(data->led, TPACPI_LED_BLINK);
5924}
5925
5926static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5927{
5928 int rc;
5929
5930 struct tpacpi_led_classdev *data = container_of(led_cdev,
5931 struct tpacpi_led_classdev, led_classdev);
5932
5933 rc = led_get_status(data->led);
5934
5935 if (rc == TPACPI_LED_OFF || rc < 0)
5936 rc = LED_OFF; /* no error handling in led class :( */
5937 else
5938 rc = LED_FULL;
5939
5940 return rc;
5941}
5942
5943static void led_exit(void)
5944{
5945 unsigned int i;
5946
5947 for (i = 0; i < TPACPI_LED_NUMLEDS; i++)
5948 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5949
5950 kfree(tpacpi_leds);
5951}
5952
5953static int __init tpacpi_init_led(unsigned int led)
5954{
5955 /* LEDs with no name don't get registered */
5956 if (!tpacpi_led_names[led])
5957 return 0;
5958
5959 tpacpi_leds[led].led_classdev.brightness_set_blocking = &led_sysfs_set;
5960 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5961 if (led_supported == TPACPI_LED_570)
5962 tpacpi_leds[led].led_classdev.brightness_get = &led_sysfs_get;
5963
5964 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5965 tpacpi_leds[led].led_classdev.flags = LED_RETAIN_AT_SHUTDOWN;
5966 tpacpi_leds[led].led = led;
5967
5968 return led_classdev_register(&tpacpi_pdev->dev, &tpacpi_leds[led].led_classdev);
5969}
5970
5971static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5972 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5973 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5974 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5975
5976 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5977 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5978 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5979 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5980 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5981 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5982 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5983 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5984
5985 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5986 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5987 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5988 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5989 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5990
5991 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5992 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5993 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5994 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5995
5996 /* (1) - may have excess leds enabled on MSB */
5997
5998 /* Defaults (order matters, keep last, don't reorder!) */
5999 { /* Lenovo */
6000 .vendor = PCI_VENDOR_ID_LENOVO,
6001 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
6002 .quirks = 0x1fffU,
6003 },
6004 { /* IBM ThinkPads with no EC version string */
6005 .vendor = PCI_VENDOR_ID_IBM,
6006 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
6007 .quirks = 0x00ffU,
6008 },
6009 { /* IBM ThinkPads with EC version string */
6010 .vendor = PCI_VENDOR_ID_IBM,
6011 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
6012 .quirks = 0x00bfU,
6013 },
6014};
6015
6016static enum led_access_mode __init led_init_detect_mode(void)
6017{
6018 acpi_status status;
6019
6020 if (tpacpi_is_ibm()) {
6021 /* 570 */
6022 status = acpi_get_handle(ec_handle, "SLED", &led_handle);
6023 if (ACPI_SUCCESS(status))
6024 return TPACPI_LED_570;
6025
6026 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
6027 status = acpi_get_handle(ec_handle, "SYSL", &led_handle);
6028 if (ACPI_SUCCESS(status))
6029 return TPACPI_LED_OLD;
6030 }
6031
6032 /* most others */
6033 status = acpi_get_handle(ec_handle, "LED", &led_handle);
6034 if (ACPI_SUCCESS(status))
6035 return TPACPI_LED_NEW;
6036
6037 /* R30, R31, and unknown firmwares */
6038 led_handle = NULL;
6039 return TPACPI_LED_NONE;
6040}
6041
6042static int __init led_init(struct ibm_init_struct *iibm)
6043{
6044 unsigned int i;
6045 int rc;
6046 unsigned long useful_leds;
6047
6048 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
6049
6050 led_supported = led_init_detect_mode();
6051
6052 if (led_supported != TPACPI_LED_NONE) {
6053 useful_leds = tpacpi_check_quirks(led_useful_qtable,
6054 ARRAY_SIZE(led_useful_qtable));
6055
6056 if (!useful_leds) {
6057 led_handle = NULL;
6058 led_supported = TPACPI_LED_NONE;
6059 }
6060 }
6061
6062 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
6063 str_supported(led_supported), led_supported);
6064
6065 if (led_supported == TPACPI_LED_NONE)
6066 return -ENODEV;
6067
6068 tpacpi_leds = kcalloc(TPACPI_LED_NUMLEDS, sizeof(*tpacpi_leds),
6069 GFP_KERNEL);
6070 if (!tpacpi_leds) {
6071 pr_err("Out of memory for LED data\n");
6072 return -ENOMEM;
6073 }
6074
6075 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
6076 tpacpi_leds[i].led = -1;
6077
6078 if (!tpacpi_is_led_restricted(i) && test_bit(i, &useful_leds)) {
6079 rc = tpacpi_init_led(i);
6080 if (rc < 0) {
6081 led_exit();
6082 return rc;
6083 }
6084 }
6085 }
6086
6087#ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
6088 pr_notice("warning: userspace override of important firmware LEDs is enabled\n");
6089#endif
6090 return 0;
6091}
6092
6093#define str_led_status(s) ((s) >= TPACPI_LED_BLINK ? "blinking" : str_on_off(s))
6094
6095static int led_read(struct seq_file *m)
6096{
6097 if (!led_supported) {
6098 seq_printf(m, "status:\t\tnot supported\n");
6099 return 0;
6100 }
6101 seq_printf(m, "status:\t\tsupported\n");
6102
6103 if (led_supported == TPACPI_LED_570) {
6104 /* 570 */
6105 int i, status;
6106 for (i = 0; i < 8; i++) {
6107 status = led_get_status(i);
6108 if (status < 0)
6109 return -EIO;
6110 seq_printf(m, "%d:\t\t%s\n", i, str_led_status(status));
6111 }
6112 }
6113
6114 seq_printf(m, "commands:\t<led> on, <led> off, <led> blink (<led> is 0-15)\n");
6115
6116 return 0;
6117}
6118
6119static int led_write(char *buf)
6120{
6121 char *cmd;
6122 int led, rc;
6123 enum led_status_t s;
6124
6125 if (!led_supported)
6126 return -ENODEV;
6127
6128 while ((cmd = strsep(&buf, ","))) {
6129 if (sscanf(cmd, "%d", &led) != 1)
6130 return -EINVAL;
6131
6132 if (led < 0 || led > (TPACPI_LED_NUMLEDS - 1))
6133 return -ENODEV;
6134
6135 if (tpacpi_leds[led].led < 0)
6136 return -ENODEV;
6137
6138 if (strstr(cmd, "off")) {
6139 s = TPACPI_LED_OFF;
6140 } else if (strstr(cmd, "on")) {
6141 s = TPACPI_LED_ON;
6142 } else if (strstr(cmd, "blink")) {
6143 s = TPACPI_LED_BLINK;
6144 } else {
6145 return -EINVAL;
6146 }
6147
6148 rc = led_set_status(led, s);
6149 if (rc < 0)
6150 return rc;
6151 }
6152
6153 return 0;
6154}
6155
6156static struct ibm_struct led_driver_data = {
6157 .name = "led",
6158 .read = led_read,
6159 .write = led_write,
6160 .exit = led_exit,
6161};
6162
6163/*************************************************************************
6164 * Beep subdriver
6165 */
6166
6167TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
6168
6169#define TPACPI_BEEP_Q1 0x0001
6170
6171static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
6172 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
6173 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
6174};
6175
6176static int __init beep_init(struct ibm_init_struct *iibm)
6177{
6178 unsigned long quirks;
6179
6180 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
6181
6182 TPACPI_ACPIHANDLE_INIT(beep);
6183
6184 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
6185 str_supported(beep_handle != NULL));
6186
6187 quirks = tpacpi_check_quirks(beep_quirk_table,
6188 ARRAY_SIZE(beep_quirk_table));
6189
6190 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
6191
6192 return (beep_handle) ? 0 : -ENODEV;
6193}
6194
6195static int beep_read(struct seq_file *m)
6196{
6197 if (!beep_handle)
6198 seq_printf(m, "status:\t\tnot supported\n");
6199 else {
6200 seq_printf(m, "status:\t\tsupported\n");
6201 seq_printf(m, "commands:\t<cmd> (<cmd> is 0-17)\n");
6202 }
6203
6204 return 0;
6205}
6206
6207static int beep_write(char *buf)
6208{
6209 char *cmd;
6210 int beep_cmd;
6211
6212 if (!beep_handle)
6213 return -ENODEV;
6214
6215 while ((cmd = strsep(&buf, ","))) {
6216 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
6217 beep_cmd >= 0 && beep_cmd <= 17) {
6218 /* beep_cmd set */
6219 } else
6220 return -EINVAL;
6221 if (tp_features.beep_needs_two_args) {
6222 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
6223 beep_cmd, 0))
6224 return -EIO;
6225 } else {
6226 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
6227 beep_cmd))
6228 return -EIO;
6229 }
6230 }
6231
6232 return 0;
6233}
6234
6235static struct ibm_struct beep_driver_data = {
6236 .name = "beep",
6237 .read = beep_read,
6238 .write = beep_write,
6239};
6240
6241/*************************************************************************
6242 * Thermal subdriver
6243 */
6244
6245enum thermal_access_mode {
6246 TPACPI_THERMAL_NONE = 0, /* No thermal support */
6247 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
6248 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
6249 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
6250 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
6251};
6252
6253enum { /* TPACPI_THERMAL_TPEC_* */
6254 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
6255 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
6256 TP_EC_FUNCREV = 0xEF, /* ACPI EC Functional revision */
6257 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
6258
6259 TPACPI_THERMAL_SENSOR_NA = -128000, /* Sensor not available */
6260};
6261
6262
6263#define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
6264struct ibm_thermal_sensors_struct {
6265 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
6266};
6267
6268static enum thermal_access_mode thermal_read_mode;
6269static bool thermal_use_labels;
6270
6271/* idx is zero-based */
6272static int thermal_get_sensor(int idx, s32 *value)
6273{
6274 int t;
6275 s8 tmp;
6276 char tmpi[5];
6277
6278 t = TP_EC_THERMAL_TMP0;
6279
6280 switch (thermal_read_mode) {
6281#if TPACPI_MAX_THERMAL_SENSORS >= 16
6282 case TPACPI_THERMAL_TPEC_16:
6283 if (idx >= 8 && idx <= 15) {
6284 t = TP_EC_THERMAL_TMP8;
6285 idx -= 8;
6286 }
6287#endif
6288 fallthrough;
6289 case TPACPI_THERMAL_TPEC_8:
6290 if (idx <= 7) {
6291 if (!acpi_ec_read(t + idx, &tmp))
6292 return -EIO;
6293 *value = tmp * 1000;
6294 return 0;
6295 }
6296 break;
6297
6298 case TPACPI_THERMAL_ACPI_UPDT:
6299 if (idx <= 7) {
6300 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6301 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
6302 return -EIO;
6303 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6304 return -EIO;
6305 *value = (t - 2732) * 100;
6306 return 0;
6307 }
6308 break;
6309
6310 case TPACPI_THERMAL_ACPI_TMP07:
6311 if (idx <= 7) {
6312 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
6313 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
6314 return -EIO;
6315 if (t > 127 || t < -127)
6316 t = TP_EC_THERMAL_TMP_NA;
6317 *value = t * 1000;
6318 return 0;
6319 }
6320 break;
6321
6322 case TPACPI_THERMAL_NONE:
6323 default:
6324 return -ENOSYS;
6325 }
6326
6327 return -EINVAL;
6328}
6329
6330static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
6331{
6332 int res, i;
6333 int n;
6334
6335 n = 8;
6336 i = 0;
6337
6338 if (!s)
6339 return -EINVAL;
6340
6341 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
6342 n = 16;
6343
6344 for (i = 0 ; i < n; i++) {
6345 res = thermal_get_sensor(i, &s->temp[i]);
6346 if (res)
6347 return res;
6348 }
6349
6350 return n;
6351}
6352
6353static void thermal_dump_all_sensors(void)
6354{
6355 int n, i;
6356 struct ibm_thermal_sensors_struct t;
6357
6358 n = thermal_get_sensors(&t);
6359 if (n <= 0)
6360 return;
6361
6362 pr_notice("temperatures (Celsius):");
6363
6364 for (i = 0; i < n; i++) {
6365 if (t.temp[i] != TPACPI_THERMAL_SENSOR_NA)
6366 pr_cont(" %d", (int)(t.temp[i] / 1000));
6367 else
6368 pr_cont(" N/A");
6369 }
6370
6371 pr_cont("\n");
6372}
6373
6374/* sysfs temp##_input -------------------------------------------------- */
6375
6376static ssize_t thermal_temp_input_show(struct device *dev,
6377 struct device_attribute *attr,
6378 char *buf)
6379{
6380 struct sensor_device_attribute *sensor_attr =
6381 to_sensor_dev_attr(attr);
6382 int idx = sensor_attr->index;
6383 s32 value;
6384 int res;
6385
6386 res = thermal_get_sensor(idx, &value);
6387 if (res)
6388 return res;
6389 if (value == TPACPI_THERMAL_SENSOR_NA)
6390 return -ENXIO;
6391
6392 return sysfs_emit(buf, "%d\n", value);
6393}
6394
6395#define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
6396 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
6397 thermal_temp_input_show, NULL, _idxB)
6398
6399static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
6400 THERMAL_SENSOR_ATTR_TEMP(1, 0),
6401 THERMAL_SENSOR_ATTR_TEMP(2, 1),
6402 THERMAL_SENSOR_ATTR_TEMP(3, 2),
6403 THERMAL_SENSOR_ATTR_TEMP(4, 3),
6404 THERMAL_SENSOR_ATTR_TEMP(5, 4),
6405 THERMAL_SENSOR_ATTR_TEMP(6, 5),
6406 THERMAL_SENSOR_ATTR_TEMP(7, 6),
6407 THERMAL_SENSOR_ATTR_TEMP(8, 7),
6408 THERMAL_SENSOR_ATTR_TEMP(9, 8),
6409 THERMAL_SENSOR_ATTR_TEMP(10, 9),
6410 THERMAL_SENSOR_ATTR_TEMP(11, 10),
6411 THERMAL_SENSOR_ATTR_TEMP(12, 11),
6412 THERMAL_SENSOR_ATTR_TEMP(13, 12),
6413 THERMAL_SENSOR_ATTR_TEMP(14, 13),
6414 THERMAL_SENSOR_ATTR_TEMP(15, 14),
6415 THERMAL_SENSOR_ATTR_TEMP(16, 15),
6416};
6417
6418#define THERMAL_ATTRS(X) \
6419 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
6420
6421static struct attribute *thermal_temp_input_attr[] = {
6422 THERMAL_ATTRS(0),
6423 THERMAL_ATTRS(1),
6424 THERMAL_ATTRS(2),
6425 THERMAL_ATTRS(3),
6426 THERMAL_ATTRS(4),
6427 THERMAL_ATTRS(5),
6428 THERMAL_ATTRS(6),
6429 THERMAL_ATTRS(7),
6430 THERMAL_ATTRS(8),
6431 THERMAL_ATTRS(9),
6432 THERMAL_ATTRS(10),
6433 THERMAL_ATTRS(11),
6434 THERMAL_ATTRS(12),
6435 THERMAL_ATTRS(13),
6436 THERMAL_ATTRS(14),
6437 THERMAL_ATTRS(15),
6438 NULL
6439};
6440
6441static umode_t thermal_attr_is_visible(struct kobject *kobj,
6442 struct attribute *attr, int n)
6443{
6444 if (thermal_read_mode == TPACPI_THERMAL_NONE)
6445 return 0;
6446
6447 if (attr == THERMAL_ATTRS(8) || attr == THERMAL_ATTRS(9) ||
6448 attr == THERMAL_ATTRS(10) || attr == THERMAL_ATTRS(11) ||
6449 attr == THERMAL_ATTRS(12) || attr == THERMAL_ATTRS(13) ||
6450 attr == THERMAL_ATTRS(14) || attr == THERMAL_ATTRS(15)) {
6451 if (thermal_read_mode != TPACPI_THERMAL_TPEC_16)
6452 return 0;
6453 }
6454
6455 return attr->mode;
6456}
6457
6458static const struct attribute_group thermal_attr_group = {
6459 .is_visible = thermal_attr_is_visible,
6460 .attrs = thermal_temp_input_attr,
6461};
6462
6463#undef THERMAL_SENSOR_ATTR_TEMP
6464#undef THERMAL_ATTRS
6465
6466static ssize_t temp1_label_show(struct device *dev, struct device_attribute *attr, char *buf)
6467{
6468 return sysfs_emit(buf, "CPU\n");
6469}
6470static DEVICE_ATTR_RO(temp1_label);
6471
6472static ssize_t temp2_label_show(struct device *dev, struct device_attribute *attr, char *buf)
6473{
6474 return sysfs_emit(buf, "GPU\n");
6475}
6476static DEVICE_ATTR_RO(temp2_label);
6477
6478static struct attribute *temp_label_attributes[] = {
6479 &dev_attr_temp1_label.attr,
6480 &dev_attr_temp2_label.attr,
6481 NULL
6482};
6483
6484static umode_t temp_label_attr_is_visible(struct kobject *kobj,
6485 struct attribute *attr, int n)
6486{
6487 return thermal_use_labels ? attr->mode : 0;
6488}
6489
6490static const struct attribute_group temp_label_attr_group = {
6491 .is_visible = temp_label_attr_is_visible,
6492 .attrs = temp_label_attributes,
6493};
6494
6495/* --------------------------------------------------------------------- */
6496
6497static int __init thermal_init(struct ibm_init_struct *iibm)
6498{
6499 u8 t, ta1, ta2, ver = 0;
6500 int i;
6501 int acpi_tmp7;
6502
6503 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
6504
6505 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
6506
6507 if (thinkpad_id.ec_model) {
6508 /*
6509 * Direct EC access mode: sensors at registers
6510 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
6511 * non-implemented, thermal sensors return 0x80 when
6512 * not available
6513 * The above rule is unfortunately flawed. This has been seen with
6514 * 0xC2 (power supply ID) causing thermal control problems.
6515 * The EC version can be determined by offset 0xEF and at least for
6516 * version 3 the Lenovo firmware team confirmed that registers 0xC0-0xC7
6517 * are not thermal registers.
6518 */
6519 if (!acpi_ec_read(TP_EC_FUNCREV, &ver))
6520 pr_warn("Thinkpad ACPI EC unable to access EC version\n");
6521
6522 ta1 = ta2 = 0;
6523 for (i = 0; i < 8; i++) {
6524 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
6525 ta1 |= t;
6526 } else {
6527 ta1 = 0;
6528 break;
6529 }
6530 if (ver < 3) {
6531 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
6532 ta2 |= t;
6533 } else {
6534 ta1 = 0;
6535 break;
6536 }
6537 }
6538 }
6539 if (ta1 == 0) {
6540 /* This is sheer paranoia, but we handle it anyway */
6541 if (acpi_tmp7) {
6542 pr_err("ThinkPad ACPI EC access misbehaving, falling back to ACPI TMPx access mode\n");
6543 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6544 } else {
6545 pr_err("ThinkPad ACPI EC access misbehaving, disabling thermal sensors access\n");
6546 thermal_read_mode = TPACPI_THERMAL_NONE;
6547 }
6548 } else {
6549 if (ver >= 3) {
6550 thermal_read_mode = TPACPI_THERMAL_TPEC_8;
6551 thermal_use_labels = true;
6552 } else {
6553 thermal_read_mode =
6554 (ta2 != 0) ?
6555 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
6556 }
6557 }
6558 } else if (acpi_tmp7) {
6559 if (tpacpi_is_ibm() &&
6560 acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
6561 /* 600e/x, 770e, 770x */
6562 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
6563 } else {
6564 /* IBM/LENOVO DSDT EC.TMPx access, max 8 sensors */
6565 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
6566 }
6567 } else {
6568 /* temperatures not supported on 570, G4x, R30, R31, R32 */
6569 thermal_read_mode = TPACPI_THERMAL_NONE;
6570 }
6571
6572 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
6573 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
6574 thermal_read_mode);
6575
6576 return thermal_read_mode != TPACPI_THERMAL_NONE ? 0 : -ENODEV;
6577}
6578
6579static int thermal_read(struct seq_file *m)
6580{
6581 int n, i;
6582 struct ibm_thermal_sensors_struct t;
6583
6584 n = thermal_get_sensors(&t);
6585 if (unlikely(n < 0))
6586 return n;
6587
6588 seq_printf(m, "temperatures:\t");
6589
6590 if (n > 0) {
6591 for (i = 0; i < (n - 1); i++)
6592 seq_printf(m, "%d ", t.temp[i] / 1000);
6593 seq_printf(m, "%d\n", t.temp[i] / 1000);
6594 } else
6595 seq_printf(m, "not supported\n");
6596
6597 return 0;
6598}
6599
6600static struct ibm_struct thermal_driver_data = {
6601 .name = "thermal",
6602 .read = thermal_read,
6603};
6604
6605/*************************************************************************
6606 * Backlight/brightness subdriver
6607 */
6608
6609#define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
6610
6611/*
6612 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
6613 * CMOS NVRAM byte 0x5E, bits 0-3.
6614 *
6615 * EC HBRV (0x31) has the following layout
6616 * Bit 7: unknown function
6617 * Bit 6: unknown function
6618 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
6619 * Bit 4: must be set to zero to avoid problems
6620 * Bit 3-0: backlight brightness level
6621 *
6622 * brightness_get_raw returns status data in the HBRV layout
6623 *
6624 * WARNING: The X61 has been verified to use HBRV for something else, so
6625 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
6626 * testing on the very early *60 Lenovo models...
6627 */
6628
6629enum {
6630 TP_EC_BACKLIGHT = 0x31,
6631
6632 /* TP_EC_BACKLIGHT bitmasks */
6633 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
6634 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
6635 TP_EC_BACKLIGHT_MAPSW = 0x20,
6636};
6637
6638enum tpacpi_brightness_access_mode {
6639 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
6640 TPACPI_BRGHT_MODE_EC, /* EC control */
6641 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
6642 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
6643 TPACPI_BRGHT_MODE_MAX
6644};
6645
6646static struct backlight_device *ibm_backlight_device;
6647
6648static enum tpacpi_brightness_access_mode brightness_mode =
6649 TPACPI_BRGHT_MODE_MAX;
6650
6651static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
6652
6653static struct mutex brightness_mutex;
6654
6655/* NVRAM brightness access,
6656 * call with brightness_mutex held! */
6657static unsigned int tpacpi_brightness_nvram_get(void)
6658{
6659 u8 lnvram;
6660
6661 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
6662 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6663 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
6664 lnvram &= bright_maxlvl;
6665
6666 return lnvram;
6667}
6668
6669static void tpacpi_brightness_checkpoint_nvram(void)
6670{
6671 u8 lec = 0;
6672 u8 b_nvram;
6673
6674 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
6675 return;
6676
6677 vdbg_printk(TPACPI_DBG_BRGHT,
6678 "trying to checkpoint backlight level to NVRAM...\n");
6679
6680 if (mutex_lock_killable(&brightness_mutex) < 0)
6681 return;
6682
6683 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6684 goto unlock;
6685 lec &= TP_EC_BACKLIGHT_LVLMSK;
6686 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
6687
6688 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
6689 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
6690 /* NVRAM needs update */
6691 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
6692 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
6693 b_nvram |= lec;
6694 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
6695 dbg_printk(TPACPI_DBG_BRGHT,
6696 "updated NVRAM backlight level to %u (0x%02x)\n",
6697 (unsigned int) lec, (unsigned int) b_nvram);
6698 } else
6699 vdbg_printk(TPACPI_DBG_BRGHT,
6700 "NVRAM backlight level already is %u (0x%02x)\n",
6701 (unsigned int) lec, (unsigned int) b_nvram);
6702
6703unlock:
6704 mutex_unlock(&brightness_mutex);
6705}
6706
6707
6708/* call with brightness_mutex held! */
6709static int tpacpi_brightness_get_raw(int *status)
6710{
6711 u8 lec = 0;
6712
6713 switch (brightness_mode) {
6714 case TPACPI_BRGHT_MODE_UCMS_STEP:
6715 *status = tpacpi_brightness_nvram_get();
6716 return 0;
6717 case TPACPI_BRGHT_MODE_EC:
6718 case TPACPI_BRGHT_MODE_ECNVRAM:
6719 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6720 return -EIO;
6721 *status = lec;
6722 return 0;
6723 default:
6724 return -ENXIO;
6725 }
6726}
6727
6728/* call with brightness_mutex held! */
6729/* do NOT call with illegal backlight level value */
6730static int tpacpi_brightness_set_ec(unsigned int value)
6731{
6732 u8 lec = 0;
6733
6734 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
6735 return -EIO;
6736
6737 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
6738 (lec & TP_EC_BACKLIGHT_CMDMSK) |
6739 (value & TP_EC_BACKLIGHT_LVLMSK))))
6740 return -EIO;
6741
6742 return 0;
6743}
6744
6745/* call with brightness_mutex held! */
6746static int tpacpi_brightness_set_ucmsstep(unsigned int value)
6747{
6748 int cmos_cmd, inc;
6749 unsigned int current_value, i;
6750
6751 current_value = tpacpi_brightness_nvram_get();
6752
6753 if (value == current_value)
6754 return 0;
6755
6756 cmos_cmd = (value > current_value) ?
6757 TP_CMOS_BRIGHTNESS_UP :
6758 TP_CMOS_BRIGHTNESS_DOWN;
6759 inc = (value > current_value) ? 1 : -1;
6760
6761 for (i = current_value; i != value; i += inc)
6762 if (issue_thinkpad_cmos_command(cmos_cmd))
6763 return -EIO;
6764
6765 return 0;
6766}
6767
6768/* May return EINTR which can always be mapped to ERESTARTSYS */
6769static int brightness_set(unsigned int value)
6770{
6771 int res;
6772
6773 if (value > bright_maxlvl)
6774 return -EINVAL;
6775
6776 vdbg_printk(TPACPI_DBG_BRGHT,
6777 "set backlight level to %d\n", value);
6778
6779 res = mutex_lock_killable(&brightness_mutex);
6780 if (res < 0)
6781 return res;
6782
6783 switch (brightness_mode) {
6784 case TPACPI_BRGHT_MODE_EC:
6785 case TPACPI_BRGHT_MODE_ECNVRAM:
6786 res = tpacpi_brightness_set_ec(value);
6787 break;
6788 case TPACPI_BRGHT_MODE_UCMS_STEP:
6789 res = tpacpi_brightness_set_ucmsstep(value);
6790 break;
6791 default:
6792 res = -ENXIO;
6793 }
6794
6795 mutex_unlock(&brightness_mutex);
6796 return res;
6797}
6798
6799/* sysfs backlight class ----------------------------------------------- */
6800
6801static int brightness_update_status(struct backlight_device *bd)
6802{
6803 int level = backlight_get_brightness(bd);
6804
6805 dbg_printk(TPACPI_DBG_BRGHT,
6806 "backlight: attempt to set level to %d\n",
6807 level);
6808
6809 /* it is the backlight class's job (caller) to handle
6810 * EINTR and other errors properly */
6811 return brightness_set(level);
6812}
6813
6814static int brightness_get(struct backlight_device *bd)
6815{
6816 int status, res;
6817
6818 res = mutex_lock_killable(&brightness_mutex);
6819 if (res < 0)
6820 return 0;
6821
6822 res = tpacpi_brightness_get_raw(&status);
6823
6824 mutex_unlock(&brightness_mutex);
6825
6826 if (res < 0)
6827 return 0;
6828
6829 return status & TP_EC_BACKLIGHT_LVLMSK;
6830}
6831
6832static void tpacpi_brightness_notify_change(void)
6833{
6834 backlight_force_update(ibm_backlight_device,
6835 BACKLIGHT_UPDATE_HOTKEY);
6836}
6837
6838static const struct backlight_ops ibm_backlight_data = {
6839 .get_brightness = brightness_get,
6840 .update_status = brightness_update_status,
6841};
6842
6843/* --------------------------------------------------------------------- */
6844
6845static int __init tpacpi_evaluate_bcl(struct acpi_device *adev, void *not_used)
6846{
6847 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
6848 union acpi_object *obj;
6849 acpi_status status;
6850 int rc;
6851
6852 status = acpi_evaluate_object(adev->handle, "_BCL", NULL, &buffer);
6853 if (ACPI_FAILURE(status))
6854 return 0;
6855
6856 obj = buffer.pointer;
6857 if (!obj || obj->type != ACPI_TYPE_PACKAGE) {
6858 acpi_handle_info(adev->handle,
6859 "Unknown _BCL data, please report this to %s\n",
6860 TPACPI_MAIL);
6861 rc = 0;
6862 } else {
6863 rc = obj->package.count;
6864 }
6865 kfree(obj);
6866
6867 return rc;
6868}
6869
6870/*
6871 * Call _BCL method of video device. On some ThinkPads this will
6872 * switch the firmware to the ACPI brightness control mode.
6873 */
6874
6875static int __init tpacpi_query_bcl_levels(acpi_handle handle)
6876{
6877 struct acpi_device *device;
6878
6879 device = acpi_fetch_acpi_dev(handle);
6880 if (!device)
6881 return 0;
6882
6883 return acpi_dev_for_each_child(device, tpacpi_evaluate_bcl, NULL);
6884}
6885
6886
6887/*
6888 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
6889 */
6890static unsigned int __init tpacpi_check_std_acpi_brightness_support(void)
6891{
6892 acpi_handle video_device;
6893 int bcl_levels = 0;
6894
6895 tpacpi_acpi_handle_locate("video", NULL, &video_device);
6896 if (video_device)
6897 bcl_levels = tpacpi_query_bcl_levels(video_device);
6898
6899 tp_features.bright_acpimode = (bcl_levels > 0);
6900
6901 return (bcl_levels > 2) ? (bcl_levels - 2) : 0;
6902}
6903
6904/*
6905 * These are only useful for models that have only one possibility
6906 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6907 * these quirks.
6908 */
6909#define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6910#define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6911#define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6912
6913static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6914 /* Models with ATI GPUs known to require ECNVRAM mode */
6915 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6916
6917 /* Models with ATI GPUs that can use ECNVRAM */
6918 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC), /* R50,51 T40-42 */
6919 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6920 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_EC), /* R52 */
6921 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6922
6923 /* Models with Intel Extreme Graphics 2 */
6924 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC), /* X40 */
6925 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6926 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6927
6928 /* Models with Intel GMA900 */
6929 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6930 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6931 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6932};
6933
6934/*
6935 * Returns < 0 for error, otherwise sets tp_features.bright_*
6936 * and bright_maxlvl.
6937 */
6938static void __init tpacpi_detect_brightness_capabilities(void)
6939{
6940 unsigned int b;
6941
6942 vdbg_printk(TPACPI_DBG_INIT,
6943 "detecting firmware brightness interface capabilities\n");
6944
6945 /* we could run a quirks check here (same table used by
6946 * brightness_init) if needed */
6947
6948 /*
6949 * We always attempt to detect acpi support, so as to switch
6950 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6951 * going to publish a backlight interface
6952 */
6953 b = tpacpi_check_std_acpi_brightness_support();
6954 switch (b) {
6955 case 16:
6956 bright_maxlvl = 15;
6957 break;
6958 case 8:
6959 case 0:
6960 bright_maxlvl = 7;
6961 break;
6962 default:
6963 tp_features.bright_unkfw = 1;
6964 bright_maxlvl = b - 1;
6965 }
6966 pr_debug("detected %u brightness levels\n", bright_maxlvl + 1);
6967}
6968
6969static int __init brightness_init(struct ibm_init_struct *iibm)
6970{
6971 struct backlight_properties props;
6972 int b;
6973 unsigned long quirks;
6974
6975 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6976
6977 mutex_init(&brightness_mutex);
6978
6979 quirks = tpacpi_check_quirks(brightness_quirk_table,
6980 ARRAY_SIZE(brightness_quirk_table));
6981
6982 /* tpacpi_detect_brightness_capabilities() must have run already */
6983
6984 /* if it is unknown, we don't handle it: it wouldn't be safe */
6985 if (tp_features.bright_unkfw)
6986 return -ENODEV;
6987
6988 if (!brightness_enable) {
6989 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6990 "brightness support disabled by module parameter\n");
6991 return -ENODEV;
6992 }
6993
6994 if (acpi_video_get_backlight_type() != acpi_backlight_vendor) {
6995 if (brightness_enable > 1) {
6996 pr_info("Standard ACPI backlight interface available, not loading native one\n");
6997 return -ENODEV;
6998 } else if (brightness_enable == 1) {
6999 pr_warn("Cannot enable backlight brightness support, ACPI is already handling it. Refer to the acpi_backlight kernel parameter.\n");
7000 return -ENODEV;
7001 }
7002 } else if (!tp_features.bright_acpimode) {
7003 pr_notice("ACPI backlight interface not available\n");
7004 return -ENODEV;
7005 }
7006
7007 pr_notice("ACPI native brightness control enabled\n");
7008
7009 /*
7010 * Check for module parameter bogosity, note that we
7011 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
7012 * able to detect "unspecified"
7013 */
7014 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
7015 return -EINVAL;
7016
7017 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
7018 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
7019 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
7020 if (quirks & TPACPI_BRGHT_Q_EC)
7021 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
7022 else
7023 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
7024
7025 dbg_printk(TPACPI_DBG_BRGHT,
7026 "driver auto-selected brightness_mode=%d\n",
7027 brightness_mode);
7028 }
7029
7030 /* Safety */
7031 if (!tpacpi_is_ibm() &&
7032 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
7033 brightness_mode == TPACPI_BRGHT_MODE_EC))
7034 return -EINVAL;
7035
7036 if (tpacpi_brightness_get_raw(&b) < 0)
7037 return -ENODEV;
7038
7039 memset(&props, 0, sizeof(struct backlight_properties));
7040 props.type = BACKLIGHT_PLATFORM;
7041 props.max_brightness = bright_maxlvl;
7042 props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
7043 ibm_backlight_device = backlight_device_register(TPACPI_BACKLIGHT_DEV_NAME,
7044 NULL, NULL,
7045 &ibm_backlight_data,
7046 &props);
7047 if (IS_ERR(ibm_backlight_device)) {
7048 int rc = PTR_ERR(ibm_backlight_device);
7049 ibm_backlight_device = NULL;
7050 pr_err("Could not register backlight device\n");
7051 return rc;
7052 }
7053 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7054 "brightness is supported\n");
7055
7056 if (quirks & TPACPI_BRGHT_Q_ASK) {
7057 pr_notice("brightness: will use unverified default: brightness_mode=%d\n",
7058 brightness_mode);
7059 pr_notice("brightness: please report to %s whether it works well or not on your ThinkPad\n",
7060 TPACPI_MAIL);
7061 }
7062
7063 /* Added by mistake in early 2007. Probably useless, but it could
7064 * be working around some unknown firmware problem where the value
7065 * read at startup doesn't match the real hardware state... so leave
7066 * it in place just in case */
7067 backlight_update_status(ibm_backlight_device);
7068
7069 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
7070 "brightness: registering brightness hotkeys as change notification\n");
7071 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7072 | TP_ACPI_HKEY_BRGHTUP_MASK
7073 | TP_ACPI_HKEY_BRGHTDWN_MASK);
7074 return 0;
7075}
7076
7077static void brightness_suspend(void)
7078{
7079 tpacpi_brightness_checkpoint_nvram();
7080}
7081
7082static void brightness_shutdown(void)
7083{
7084 tpacpi_brightness_checkpoint_nvram();
7085}
7086
7087static void brightness_exit(void)
7088{
7089 if (ibm_backlight_device) {
7090 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
7091 "calling backlight_device_unregister()\n");
7092 backlight_device_unregister(ibm_backlight_device);
7093 }
7094
7095 tpacpi_brightness_checkpoint_nvram();
7096}
7097
7098static int brightness_read(struct seq_file *m)
7099{
7100 int level;
7101
7102 level = brightness_get(NULL);
7103 if (level < 0) {
7104 seq_printf(m, "level:\t\tunreadable\n");
7105 } else {
7106 seq_printf(m, "level:\t\t%d\n", level);
7107 seq_printf(m, "commands:\tup, down\n");
7108 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7109 bright_maxlvl);
7110 }
7111
7112 return 0;
7113}
7114
7115static int brightness_write(char *buf)
7116{
7117 int level;
7118 int rc;
7119 char *cmd;
7120
7121 level = brightness_get(NULL);
7122 if (level < 0)
7123 return level;
7124
7125 while ((cmd = strsep(&buf, ","))) {
7126 if (strstarts(cmd, "up")) {
7127 if (level < bright_maxlvl)
7128 level++;
7129 } else if (strstarts(cmd, "down")) {
7130 if (level > 0)
7131 level--;
7132 } else if (sscanf(cmd, "level %d", &level) == 1 &&
7133 level >= 0 && level <= bright_maxlvl) {
7134 /* new level set */
7135 } else
7136 return -EINVAL;
7137 }
7138
7139 tpacpi_disclose_usertask("procfs brightness",
7140 "set level to %d\n", level);
7141
7142 /*
7143 * Now we know what the final level should be, so we try to set it.
7144 * Doing it this way makes the syscall restartable in case of EINTR
7145 */
7146 rc = brightness_set(level);
7147 if (!rc && ibm_backlight_device)
7148 backlight_force_update(ibm_backlight_device,
7149 BACKLIGHT_UPDATE_SYSFS);
7150 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7151}
7152
7153static struct ibm_struct brightness_driver_data = {
7154 .name = "brightness",
7155 .read = brightness_read,
7156 .write = brightness_write,
7157 .exit = brightness_exit,
7158 .suspend = brightness_suspend,
7159 .shutdown = brightness_shutdown,
7160};
7161
7162/*************************************************************************
7163 * Volume subdriver
7164 */
7165
7166/*
7167 * IBM ThinkPads have a simple volume controller with MUTE gating.
7168 * Very early Lenovo ThinkPads follow the IBM ThinkPad spec.
7169 *
7170 * Since the *61 series (and probably also the later *60 series), Lenovo
7171 * ThinkPads only implement the MUTE gate.
7172 *
7173 * EC register 0x30
7174 * Bit 6: MUTE (1 mutes sound)
7175 * Bit 3-0: Volume
7176 * Other bits should be zero as far as we know.
7177 *
7178 * This is also stored in CMOS NVRAM, byte 0x60, bit 6 (MUTE), and
7179 * bits 3-0 (volume). Other bits in NVRAM may have other functions,
7180 * such as bit 7 which is used to detect repeated presses of MUTE,
7181 * and we leave them unchanged.
7182 *
7183 * On newer Lenovo ThinkPads, the EC can automatically change the volume
7184 * in response to user input. Unfortunately, this rarely works well.
7185 * The laptop changes the state of its internal MUTE gate and, on some
7186 * models, sends KEY_MUTE, causing any user code that responds to the
7187 * mute button to get confused. The hardware MUTE gate is also
7188 * unnecessary, since user code can handle the mute button without
7189 * kernel or EC help.
7190 *
7191 * To avoid confusing userspace, we simply disable all EC-based mute
7192 * and volume controls when possible.
7193 */
7194
7195#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
7196
7197#define TPACPI_ALSA_DRVNAME "ThinkPad EC"
7198#define TPACPI_ALSA_SHRTNAME "ThinkPad Console Audio Control"
7199#define TPACPI_ALSA_MIXERNAME TPACPI_ALSA_SHRTNAME
7200
7201#if SNDRV_CARDS <= 32
7202#define DEFAULT_ALSA_IDX ~((1 << (SNDRV_CARDS - 3)) - 1)
7203#else
7204#define DEFAULT_ALSA_IDX ~((1 << (32 - 3)) - 1)
7205#endif
7206static int alsa_index = DEFAULT_ALSA_IDX; /* last three slots */
7207static char *alsa_id = "ThinkPadEC";
7208static bool alsa_enable = SNDRV_DEFAULT_ENABLE1;
7209
7210struct tpacpi_alsa_data {
7211 struct snd_card *card;
7212 struct snd_ctl_elem_id *ctl_mute_id;
7213 struct snd_ctl_elem_id *ctl_vol_id;
7214};
7215
7216static struct snd_card *alsa_card;
7217
7218enum {
7219 TP_EC_AUDIO = 0x30,
7220
7221 /* TP_EC_AUDIO bits */
7222 TP_EC_AUDIO_MUTESW = 6,
7223
7224 /* TP_EC_AUDIO bitmasks */
7225 TP_EC_AUDIO_LVL_MSK = 0x0F,
7226 TP_EC_AUDIO_MUTESW_MSK = (1 << TP_EC_AUDIO_MUTESW),
7227
7228 /* Maximum volume */
7229 TP_EC_VOLUME_MAX = 14,
7230};
7231
7232enum tpacpi_volume_access_mode {
7233 TPACPI_VOL_MODE_AUTO = 0, /* Not implemented yet */
7234 TPACPI_VOL_MODE_EC, /* Pure EC control */
7235 TPACPI_VOL_MODE_UCMS_STEP, /* UCMS step-based control: N/A */
7236 TPACPI_VOL_MODE_ECNVRAM, /* EC control w/ NVRAM store */
7237 TPACPI_VOL_MODE_MAX
7238};
7239
7240enum tpacpi_volume_capabilities {
7241 TPACPI_VOL_CAP_AUTO = 0, /* Use white/blacklist */
7242 TPACPI_VOL_CAP_VOLMUTE, /* Output vol and mute */
7243 TPACPI_VOL_CAP_MUTEONLY, /* Output mute only */
7244 TPACPI_VOL_CAP_MAX
7245};
7246
7247enum tpacpi_mute_btn_mode {
7248 TP_EC_MUTE_BTN_LATCH = 0, /* Mute mutes; up/down unmutes */
7249 /* We don't know what mode 1 is. */
7250 TP_EC_MUTE_BTN_NONE = 2, /* Mute and up/down are just keys */
7251 TP_EC_MUTE_BTN_TOGGLE = 3, /* Mute toggles; up/down unmutes */
7252};
7253
7254static enum tpacpi_volume_access_mode volume_mode =
7255 TPACPI_VOL_MODE_MAX;
7256
7257static enum tpacpi_volume_capabilities volume_capabilities;
7258static bool volume_control_allowed;
7259static bool software_mute_requested = true;
7260static bool software_mute_active;
7261static int software_mute_orig_mode;
7262
7263/*
7264 * Used to syncronize writers to TP_EC_AUDIO and
7265 * TP_NVRAM_ADDR_MIXER, as we need to do read-modify-write
7266 */
7267static struct mutex volume_mutex;
7268
7269static void tpacpi_volume_checkpoint_nvram(void)
7270{
7271 u8 lec = 0;
7272 u8 b_nvram;
7273 u8 ec_mask;
7274
7275 if (volume_mode != TPACPI_VOL_MODE_ECNVRAM)
7276 return;
7277 if (!volume_control_allowed)
7278 return;
7279 if (software_mute_active)
7280 return;
7281
7282 vdbg_printk(TPACPI_DBG_MIXER,
7283 "trying to checkpoint mixer state to NVRAM...\n");
7284
7285 if (tp_features.mixer_no_level_control)
7286 ec_mask = TP_EC_AUDIO_MUTESW_MSK;
7287 else
7288 ec_mask = TP_EC_AUDIO_MUTESW_MSK | TP_EC_AUDIO_LVL_MSK;
7289
7290 if (mutex_lock_killable(&volume_mutex) < 0)
7291 return;
7292
7293 if (unlikely(!acpi_ec_read(TP_EC_AUDIO, &lec)))
7294 goto unlock;
7295 lec &= ec_mask;
7296 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
7297
7298 if (lec != (b_nvram & ec_mask)) {
7299 /* NVRAM needs update */
7300 b_nvram &= ~ec_mask;
7301 b_nvram |= lec;
7302 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_MIXER);
7303 dbg_printk(TPACPI_DBG_MIXER,
7304 "updated NVRAM mixer status to 0x%02x (0x%02x)\n",
7305 (unsigned int) lec, (unsigned int) b_nvram);
7306 } else {
7307 vdbg_printk(TPACPI_DBG_MIXER,
7308 "NVRAM mixer status already is 0x%02x (0x%02x)\n",
7309 (unsigned int) lec, (unsigned int) b_nvram);
7310 }
7311
7312unlock:
7313 mutex_unlock(&volume_mutex);
7314}
7315
7316static int volume_get_status_ec(u8 *status)
7317{
7318 u8 s;
7319
7320 if (!acpi_ec_read(TP_EC_AUDIO, &s))
7321 return -EIO;
7322
7323 *status = s;
7324
7325 dbg_printk(TPACPI_DBG_MIXER, "status 0x%02x\n", s);
7326
7327 return 0;
7328}
7329
7330static int volume_get_status(u8 *status)
7331{
7332 return volume_get_status_ec(status);
7333}
7334
7335static int volume_set_status_ec(const u8 status)
7336{
7337 if (!acpi_ec_write(TP_EC_AUDIO, status))
7338 return -EIO;
7339
7340 dbg_printk(TPACPI_DBG_MIXER, "set EC mixer to 0x%02x\n", status);
7341
7342 /*
7343 * On X200s, and possibly on others, it can take a while for
7344 * reads to become correct.
7345 */
7346 msleep(1);
7347
7348 return 0;
7349}
7350
7351static int volume_set_status(const u8 status)
7352{
7353 return volume_set_status_ec(status);
7354}
7355
7356/* returns < 0 on error, 0 on no change, 1 on change */
7357static int __volume_set_mute_ec(const bool mute)
7358{
7359 int rc;
7360 u8 s, n;
7361
7362 if (mutex_lock_killable(&volume_mutex) < 0)
7363 return -EINTR;
7364
7365 rc = volume_get_status_ec(&s);
7366 if (rc)
7367 goto unlock;
7368
7369 n = (mute) ? s | TP_EC_AUDIO_MUTESW_MSK :
7370 s & ~TP_EC_AUDIO_MUTESW_MSK;
7371
7372 if (n != s) {
7373 rc = volume_set_status_ec(n);
7374 if (!rc)
7375 rc = 1;
7376 }
7377
7378unlock:
7379 mutex_unlock(&volume_mutex);
7380 return rc;
7381}
7382
7383static int volume_alsa_set_mute(const bool mute)
7384{
7385 dbg_printk(TPACPI_DBG_MIXER, "ALSA: trying to %smute\n",
7386 (mute) ? "" : "un");
7387 return __volume_set_mute_ec(mute);
7388}
7389
7390static int volume_set_mute(const bool mute)
7391{
7392 int rc;
7393
7394 dbg_printk(TPACPI_DBG_MIXER, "trying to %smute\n",
7395 (mute) ? "" : "un");
7396
7397 rc = __volume_set_mute_ec(mute);
7398 return (rc < 0) ? rc : 0;
7399}
7400
7401/* returns < 0 on error, 0 on no change, 1 on change */
7402static int __volume_set_volume_ec(const u8 vol)
7403{
7404 int rc;
7405 u8 s, n;
7406
7407 if (vol > TP_EC_VOLUME_MAX)
7408 return -EINVAL;
7409
7410 if (mutex_lock_killable(&volume_mutex) < 0)
7411 return -EINTR;
7412
7413 rc = volume_get_status_ec(&s);
7414 if (rc)
7415 goto unlock;
7416
7417 n = (s & ~TP_EC_AUDIO_LVL_MSK) | vol;
7418
7419 if (n != s) {
7420 rc = volume_set_status_ec(n);
7421 if (!rc)
7422 rc = 1;
7423 }
7424
7425unlock:
7426 mutex_unlock(&volume_mutex);
7427 return rc;
7428}
7429
7430static int volume_set_software_mute(bool startup)
7431{
7432 int result;
7433
7434 if (!tpacpi_is_lenovo())
7435 return -ENODEV;
7436
7437 if (startup) {
7438 if (!acpi_evalf(ec_handle, &software_mute_orig_mode,
7439 "HAUM", "qd"))
7440 return -EIO;
7441
7442 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7443 "Initial HAUM setting was %d\n",
7444 software_mute_orig_mode);
7445 }
7446
7447 if (!acpi_evalf(ec_handle, &result, "SAUM", "qdd",
7448 (int)TP_EC_MUTE_BTN_NONE))
7449 return -EIO;
7450
7451 if (result != TP_EC_MUTE_BTN_NONE)
7452 pr_warn("Unexpected SAUM result %d\n",
7453 result);
7454
7455 /*
7456 * In software mute mode, the standard codec controls take
7457 * precendence, so we unmute the ThinkPad HW switch at
7458 * startup. Just on case there are SAUM-capable ThinkPads
7459 * with level controls, set max HW volume as well.
7460 */
7461 if (tp_features.mixer_no_level_control)
7462 result = volume_set_mute(false);
7463 else
7464 result = volume_set_status(TP_EC_VOLUME_MAX);
7465
7466 if (result != 0)
7467 pr_warn("Failed to unmute the HW mute switch\n");
7468
7469 return 0;
7470}
7471
7472static void volume_exit_software_mute(void)
7473{
7474 int r;
7475
7476 if (!acpi_evalf(ec_handle, &r, "SAUM", "qdd", software_mute_orig_mode)
7477 || r != software_mute_orig_mode)
7478 pr_warn("Failed to restore mute mode\n");
7479}
7480
7481static int volume_alsa_set_volume(const u8 vol)
7482{
7483 dbg_printk(TPACPI_DBG_MIXER,
7484 "ALSA: trying to set volume level to %hu\n", vol);
7485 return __volume_set_volume_ec(vol);
7486}
7487
7488static void volume_alsa_notify_change(void)
7489{
7490 struct tpacpi_alsa_data *d;
7491
7492 if (alsa_card && alsa_card->private_data) {
7493 d = alsa_card->private_data;
7494 if (d->ctl_mute_id)
7495 snd_ctl_notify(alsa_card,
7496 SNDRV_CTL_EVENT_MASK_VALUE,
7497 d->ctl_mute_id);
7498 if (d->ctl_vol_id)
7499 snd_ctl_notify(alsa_card,
7500 SNDRV_CTL_EVENT_MASK_VALUE,
7501 d->ctl_vol_id);
7502 }
7503}
7504
7505static int volume_alsa_vol_info(struct snd_kcontrol *kcontrol,
7506 struct snd_ctl_elem_info *uinfo)
7507{
7508 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
7509 uinfo->count = 1;
7510 uinfo->value.integer.min = 0;
7511 uinfo->value.integer.max = TP_EC_VOLUME_MAX;
7512 return 0;
7513}
7514
7515static int volume_alsa_vol_get(struct snd_kcontrol *kcontrol,
7516 struct snd_ctl_elem_value *ucontrol)
7517{
7518 u8 s;
7519 int rc;
7520
7521 rc = volume_get_status(&s);
7522 if (rc < 0)
7523 return rc;
7524
7525 ucontrol->value.integer.value[0] = s & TP_EC_AUDIO_LVL_MSK;
7526 return 0;
7527}
7528
7529static int volume_alsa_vol_put(struct snd_kcontrol *kcontrol,
7530 struct snd_ctl_elem_value *ucontrol)
7531{
7532 tpacpi_disclose_usertask("ALSA", "set volume to %ld\n",
7533 ucontrol->value.integer.value[0]);
7534 return volume_alsa_set_volume(ucontrol->value.integer.value[0]);
7535}
7536
7537#define volume_alsa_mute_info snd_ctl_boolean_mono_info
7538
7539static int volume_alsa_mute_get(struct snd_kcontrol *kcontrol,
7540 struct snd_ctl_elem_value *ucontrol)
7541{
7542 u8 s;
7543 int rc;
7544
7545 rc = volume_get_status(&s);
7546 if (rc < 0)
7547 return rc;
7548
7549 ucontrol->value.integer.value[0] =
7550 (s & TP_EC_AUDIO_MUTESW_MSK) ? 0 : 1;
7551 return 0;
7552}
7553
7554static int volume_alsa_mute_put(struct snd_kcontrol *kcontrol,
7555 struct snd_ctl_elem_value *ucontrol)
7556{
7557 tpacpi_disclose_usertask("ALSA", "%smute\n",
7558 ucontrol->value.integer.value[0] ?
7559 "un" : "");
7560 return volume_alsa_set_mute(!ucontrol->value.integer.value[0]);
7561}
7562
7563static struct snd_kcontrol_new volume_alsa_control_vol __initdata = {
7564 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7565 .name = "Console Playback Volume",
7566 .index = 0,
7567 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7568 .info = volume_alsa_vol_info,
7569 .get = volume_alsa_vol_get,
7570};
7571
7572static struct snd_kcontrol_new volume_alsa_control_mute __initdata = {
7573 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
7574 .name = "Console Playback Switch",
7575 .index = 0,
7576 .access = SNDRV_CTL_ELEM_ACCESS_READ,
7577 .info = volume_alsa_mute_info,
7578 .get = volume_alsa_mute_get,
7579};
7580
7581static void volume_suspend(void)
7582{
7583 tpacpi_volume_checkpoint_nvram();
7584}
7585
7586static void volume_resume(void)
7587{
7588 if (software_mute_active) {
7589 if (volume_set_software_mute(false) < 0)
7590 pr_warn("Failed to restore software mute\n");
7591 } else {
7592 volume_alsa_notify_change();
7593 }
7594}
7595
7596static void volume_shutdown(void)
7597{
7598 tpacpi_volume_checkpoint_nvram();
7599}
7600
7601static void volume_exit(void)
7602{
7603 if (alsa_card) {
7604 snd_card_free(alsa_card);
7605 alsa_card = NULL;
7606 }
7607
7608 tpacpi_volume_checkpoint_nvram();
7609
7610 if (software_mute_active)
7611 volume_exit_software_mute();
7612}
7613
7614static int __init volume_create_alsa_mixer(void)
7615{
7616 struct snd_card *card;
7617 struct tpacpi_alsa_data *data;
7618 struct snd_kcontrol *ctl_vol;
7619 struct snd_kcontrol *ctl_mute;
7620 int rc;
7621
7622 rc = snd_card_new(&tpacpi_pdev->dev,
7623 alsa_index, alsa_id, THIS_MODULE,
7624 sizeof(struct tpacpi_alsa_data), &card);
7625 if (rc < 0 || !card) {
7626 pr_err("Failed to create ALSA card structures: %d\n", rc);
7627 return -ENODEV;
7628 }
7629
7630 BUG_ON(!card->private_data);
7631 data = card->private_data;
7632 data->card = card;
7633
7634 strscpy(card->driver, TPACPI_ALSA_DRVNAME,
7635 sizeof(card->driver));
7636 strscpy(card->shortname, TPACPI_ALSA_SHRTNAME,
7637 sizeof(card->shortname));
7638 snprintf(card->mixername, sizeof(card->mixername), "ThinkPad EC %s",
7639 (thinkpad_id.ec_version_str) ?
7640 thinkpad_id.ec_version_str : "(unknown)");
7641 snprintf(card->longname, sizeof(card->longname),
7642 "%s at EC reg 0x%02x, fw %s", card->shortname, TP_EC_AUDIO,
7643 (thinkpad_id.ec_version_str) ?
7644 thinkpad_id.ec_version_str : "unknown");
7645
7646 if (volume_control_allowed) {
7647 volume_alsa_control_vol.put = volume_alsa_vol_put;
7648 volume_alsa_control_vol.access =
7649 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7650
7651 volume_alsa_control_mute.put = volume_alsa_mute_put;
7652 volume_alsa_control_mute.access =
7653 SNDRV_CTL_ELEM_ACCESS_READWRITE;
7654 }
7655
7656 if (!tp_features.mixer_no_level_control) {
7657 ctl_vol = snd_ctl_new1(&volume_alsa_control_vol, NULL);
7658 rc = snd_ctl_add(card, ctl_vol);
7659 if (rc < 0) {
7660 pr_err("Failed to create ALSA volume control: %d\n",
7661 rc);
7662 goto err_exit;
7663 }
7664 data->ctl_vol_id = &ctl_vol->id;
7665 }
7666
7667 ctl_mute = snd_ctl_new1(&volume_alsa_control_mute, NULL);
7668 rc = snd_ctl_add(card, ctl_mute);
7669 if (rc < 0) {
7670 pr_err("Failed to create ALSA mute control: %d\n", rc);
7671 goto err_exit;
7672 }
7673 data->ctl_mute_id = &ctl_mute->id;
7674
7675 rc = snd_card_register(card);
7676 if (rc < 0) {
7677 pr_err("Failed to register ALSA card: %d\n", rc);
7678 goto err_exit;
7679 }
7680
7681 alsa_card = card;
7682 return 0;
7683
7684err_exit:
7685 snd_card_free(card);
7686 return -ENODEV;
7687}
7688
7689#define TPACPI_VOL_Q_MUTEONLY 0x0001 /* Mute-only control available */
7690#define TPACPI_VOL_Q_LEVEL 0x0002 /* Volume control available */
7691
7692static const struct tpacpi_quirk volume_quirk_table[] __initconst = {
7693 /* Whitelist volume level on all IBM by default */
7694 { .vendor = PCI_VENDOR_ID_IBM,
7695 .bios = TPACPI_MATCH_ANY,
7696 .ec = TPACPI_MATCH_ANY,
7697 .quirks = TPACPI_VOL_Q_LEVEL },
7698
7699 /* Lenovo models with volume control (needs confirmation) */
7700 TPACPI_QEC_LNV('7', 'C', TPACPI_VOL_Q_LEVEL), /* R60/i */
7701 TPACPI_QEC_LNV('7', 'E', TPACPI_VOL_Q_LEVEL), /* R60e/i */
7702 TPACPI_QEC_LNV('7', '9', TPACPI_VOL_Q_LEVEL), /* T60/p */
7703 TPACPI_QEC_LNV('7', 'B', TPACPI_VOL_Q_LEVEL), /* X60/s */
7704 TPACPI_QEC_LNV('7', 'J', TPACPI_VOL_Q_LEVEL), /* X60t */
7705 TPACPI_QEC_LNV('7', '7', TPACPI_VOL_Q_LEVEL), /* Z60 */
7706 TPACPI_QEC_LNV('7', 'F', TPACPI_VOL_Q_LEVEL), /* Z61 */
7707
7708 /* Whitelist mute-only on all Lenovo by default */
7709 { .vendor = PCI_VENDOR_ID_LENOVO,
7710 .bios = TPACPI_MATCH_ANY,
7711 .ec = TPACPI_MATCH_ANY,
7712 .quirks = TPACPI_VOL_Q_MUTEONLY }
7713};
7714
7715static int __init volume_init(struct ibm_init_struct *iibm)
7716{
7717 unsigned long quirks;
7718 int rc;
7719
7720 vdbg_printk(TPACPI_DBG_INIT, "initializing volume subdriver\n");
7721
7722 mutex_init(&volume_mutex);
7723
7724 /*
7725 * Check for module parameter bogosity, note that we
7726 * init volume_mode to TPACPI_VOL_MODE_MAX in order to be
7727 * able to detect "unspecified"
7728 */
7729 if (volume_mode > TPACPI_VOL_MODE_MAX)
7730 return -EINVAL;
7731
7732 if (volume_mode == TPACPI_VOL_MODE_UCMS_STEP) {
7733 pr_err("UCMS step volume mode not implemented, please contact %s\n",
7734 TPACPI_MAIL);
7735 return -ENODEV;
7736 }
7737
7738 if (volume_capabilities >= TPACPI_VOL_CAP_MAX)
7739 return -EINVAL;
7740
7741 /*
7742 * The ALSA mixer is our primary interface.
7743 * When disabled, don't install the subdriver at all
7744 */
7745 if (!alsa_enable) {
7746 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7747 "ALSA mixer disabled by parameter, not loading volume subdriver...\n");
7748 return -ENODEV;
7749 }
7750
7751 quirks = tpacpi_check_quirks(volume_quirk_table,
7752 ARRAY_SIZE(volume_quirk_table));
7753
7754 switch (volume_capabilities) {
7755 case TPACPI_VOL_CAP_AUTO:
7756 if (quirks & TPACPI_VOL_Q_MUTEONLY)
7757 tp_features.mixer_no_level_control = 1;
7758 else if (quirks & TPACPI_VOL_Q_LEVEL)
7759 tp_features.mixer_no_level_control = 0;
7760 else
7761 return -ENODEV; /* no mixer */
7762 break;
7763 case TPACPI_VOL_CAP_VOLMUTE:
7764 tp_features.mixer_no_level_control = 0;
7765 break;
7766 case TPACPI_VOL_CAP_MUTEONLY:
7767 tp_features.mixer_no_level_control = 1;
7768 break;
7769 default:
7770 return -ENODEV;
7771 }
7772
7773 if (volume_capabilities != TPACPI_VOL_CAP_AUTO)
7774 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7775 "using user-supplied volume_capabilities=%d\n",
7776 volume_capabilities);
7777
7778 if (volume_mode == TPACPI_VOL_MODE_AUTO ||
7779 volume_mode == TPACPI_VOL_MODE_MAX) {
7780 volume_mode = TPACPI_VOL_MODE_ECNVRAM;
7781
7782 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7783 "driver auto-selected volume_mode=%d\n",
7784 volume_mode);
7785 } else {
7786 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7787 "using user-supplied volume_mode=%d\n",
7788 volume_mode);
7789 }
7790
7791 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7792 "mute is supported, volume control is %s\n",
7793 str_supported(!tp_features.mixer_no_level_control));
7794
7795 if (software_mute_requested && volume_set_software_mute(true) == 0) {
7796 software_mute_active = true;
7797 } else {
7798 rc = volume_create_alsa_mixer();
7799 if (rc) {
7800 pr_err("Could not create the ALSA mixer interface\n");
7801 return rc;
7802 }
7803
7804 pr_info("Console audio control enabled, mode: %s\n",
7805 (volume_control_allowed) ?
7806 "override (read/write)" :
7807 "monitor (read only)");
7808 }
7809
7810 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_MIXER,
7811 "registering volume hotkeys as change notification\n");
7812 tpacpi_hotkey_driver_mask_set(hotkey_driver_mask
7813 | TP_ACPI_HKEY_VOLUP_MASK
7814 | TP_ACPI_HKEY_VOLDWN_MASK
7815 | TP_ACPI_HKEY_MUTE_MASK);
7816
7817 return 0;
7818}
7819
7820static int volume_read(struct seq_file *m)
7821{
7822 u8 status;
7823
7824 if (volume_get_status(&status) < 0) {
7825 seq_printf(m, "level:\t\tunreadable\n");
7826 } else {
7827 if (tp_features.mixer_no_level_control)
7828 seq_printf(m, "level:\t\tunsupported\n");
7829 else
7830 seq_printf(m, "level:\t\t%d\n",
7831 status & TP_EC_AUDIO_LVL_MSK);
7832
7833 seq_printf(m, "mute:\t\t%s\n", str_on_off(status & BIT(TP_EC_AUDIO_MUTESW)));
7834
7835 if (volume_control_allowed) {
7836 seq_printf(m, "commands:\tunmute, mute\n");
7837 if (!tp_features.mixer_no_level_control) {
7838 seq_printf(m, "commands:\tup, down\n");
7839 seq_printf(m, "commands:\tlevel <level> (<level> is 0-%d)\n",
7840 TP_EC_VOLUME_MAX);
7841 }
7842 }
7843 }
7844
7845 return 0;
7846}
7847
7848static int volume_write(char *buf)
7849{
7850 u8 s;
7851 u8 new_level, new_mute;
7852 int l;
7853 char *cmd;
7854 int rc;
7855
7856 /*
7857 * We do allow volume control at driver startup, so that the
7858 * user can set initial state through the volume=... parameter hack.
7859 */
7860 if (!volume_control_allowed && tpacpi_lifecycle != TPACPI_LIFE_INIT) {
7861 if (unlikely(!tp_warned.volume_ctrl_forbidden)) {
7862 tp_warned.volume_ctrl_forbidden = 1;
7863 pr_notice("Console audio control in monitor mode, changes are not allowed\n");
7864 pr_notice("Use the volume_control=1 module parameter to enable volume control\n");
7865 }
7866 return -EPERM;
7867 }
7868
7869 rc = volume_get_status(&s);
7870 if (rc < 0)
7871 return rc;
7872
7873 new_level = s & TP_EC_AUDIO_LVL_MSK;
7874 new_mute = s & TP_EC_AUDIO_MUTESW_MSK;
7875
7876 while ((cmd = strsep(&buf, ","))) {
7877 if (!tp_features.mixer_no_level_control) {
7878 if (strstarts(cmd, "up")) {
7879 if (new_mute)
7880 new_mute = 0;
7881 else if (new_level < TP_EC_VOLUME_MAX)
7882 new_level++;
7883 continue;
7884 } else if (strstarts(cmd, "down")) {
7885 if (new_mute)
7886 new_mute = 0;
7887 else if (new_level > 0)
7888 new_level--;
7889 continue;
7890 } else if (sscanf(cmd, "level %u", &l) == 1 &&
7891 l >= 0 && l <= TP_EC_VOLUME_MAX) {
7892 new_level = l;
7893 continue;
7894 }
7895 }
7896 if (strstarts(cmd, "mute"))
7897 new_mute = TP_EC_AUDIO_MUTESW_MSK;
7898 else if (strstarts(cmd, "unmute"))
7899 new_mute = 0;
7900 else
7901 return -EINVAL;
7902 }
7903
7904 if (tp_features.mixer_no_level_control) {
7905 tpacpi_disclose_usertask("procfs volume", "%smute\n",
7906 new_mute ? "" : "un");
7907 rc = volume_set_mute(!!new_mute);
7908 } else {
7909 tpacpi_disclose_usertask("procfs volume",
7910 "%smute and set level to %d\n",
7911 new_mute ? "" : "un", new_level);
7912 rc = volume_set_status(new_mute | new_level);
7913 }
7914 volume_alsa_notify_change();
7915
7916 return (rc == -EINTR) ? -ERESTARTSYS : rc;
7917}
7918
7919static struct ibm_struct volume_driver_data = {
7920 .name = "volume",
7921 .read = volume_read,
7922 .write = volume_write,
7923 .exit = volume_exit,
7924 .suspend = volume_suspend,
7925 .resume = volume_resume,
7926 .shutdown = volume_shutdown,
7927};
7928
7929#else /* !CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7930
7931#define alsa_card NULL
7932
7933static inline void volume_alsa_notify_change(void)
7934{
7935}
7936
7937static int __init volume_init(struct ibm_init_struct *iibm)
7938{
7939 pr_info("volume: disabled as there is no ALSA support in this kernel\n");
7940
7941 return -ENODEV;
7942}
7943
7944static struct ibm_struct volume_driver_data = {
7945 .name = "volume",
7946};
7947
7948#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
7949
7950/*************************************************************************
7951 * Fan subdriver
7952 */
7953
7954/*
7955 * FAN ACCESS MODES
7956 *
7957 * TPACPI_FAN_RD_ACPI_GFAN:
7958 * ACPI GFAN method: returns fan level
7959 *
7960 * see TPACPI_FAN_WR_ACPI_SFAN
7961 * EC 0x2f (HFSP) not available if GFAN exists
7962 *
7963 * TPACPI_FAN_WR_ACPI_SFAN:
7964 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
7965 *
7966 * EC 0x2f (HFSP) might be available *for reading*, but do not use
7967 * it for writing.
7968 *
7969 * TPACPI_FAN_WR_TPEC:
7970 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
7971 * Supported on almost all ThinkPads
7972 *
7973 * Fan speed changes of any sort (including those caused by the
7974 * disengaged mode) are usually done slowly by the firmware as the
7975 * maximum amount of fan duty cycle change per second seems to be
7976 * limited.
7977 *
7978 * Reading is not available if GFAN exists.
7979 * Writing is not available if SFAN exists.
7980 *
7981 * Bits
7982 * 7 automatic mode engaged;
7983 * (default operation mode of the ThinkPad)
7984 * fan level is ignored in this mode.
7985 * 6 full speed mode (takes precedence over bit 7);
7986 * not available on all thinkpads. May disable
7987 * the tachometer while the fan controller ramps up
7988 * the speed (which can take up to a few *minutes*).
7989 * Speeds up fan to 100% duty-cycle, which is far above
7990 * the standard RPM levels. It is not impossible that
7991 * it could cause hardware damage.
7992 * 5-3 unused in some models. Extra bits for fan level
7993 * in others, but still useless as all values above
7994 * 7 map to the same speed as level 7 in these models.
7995 * 2-0 fan level (0..7 usually)
7996 * 0x00 = stop
7997 * 0x07 = max (set when temperatures critical)
7998 * Some ThinkPads may have other levels, see
7999 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
8000 *
8001 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
8002 * boot. Apparently the EC does not initialize it, so unless ACPI DSDT
8003 * does so, its initial value is meaningless (0x07).
8004 *
8005 * For firmware bugs, refer to:
8006 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8007 *
8008 * ----
8009 *
8010 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
8011 * Main fan tachometer reading (in RPM)
8012 *
8013 * This register is present on all ThinkPads with a new-style EC, and
8014 * it is known not to be present on the A21m/e, and T22, as there is
8015 * something else in offset 0x84 according to the ACPI DSDT. Other
8016 * ThinkPads from this same time period (and earlier) probably lack the
8017 * tachometer as well.
8018 *
8019 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
8020 * was never fixed by IBM to report the EC firmware version string
8021 * probably support the tachometer (like the early X models), so
8022 * detecting it is quite hard. We need more data to know for sure.
8023 *
8024 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
8025 * might result.
8026 *
8027 * FIRMWARE BUG: may go stale while the EC is switching to full speed
8028 * mode.
8029 *
8030 * For firmware bugs, refer to:
8031 * https://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
8032 *
8033 * ----
8034 *
8035 * ThinkPad EC register 0x31 bit 0 (only on select models)
8036 *
8037 * When bit 0 of EC register 0x31 is zero, the tachometer registers
8038 * show the speed of the main fan. When bit 0 of EC register 0x31
8039 * is one, the tachometer registers show the speed of the auxiliary
8040 * fan.
8041 *
8042 * Fan control seems to affect both fans, regardless of the state
8043 * of this bit.
8044 *
8045 * So far, only the firmware for the X60/X61 non-tablet versions
8046 * seem to support this (firmware TP-7M).
8047 *
8048 * TPACPI_FAN_WR_ACPI_FANS:
8049 * ThinkPad X31, X40, X41. Not available in the X60.
8050 *
8051 * FANS ACPI handle: takes three arguments: low speed, medium speed,
8052 * high speed. ACPI DSDT seems to map these three speeds to levels
8053 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
8054 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
8055 *
8056 * The speeds are stored on handles
8057 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
8058 *
8059 * There are three default speed sets, accessible as handles:
8060 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
8061 *
8062 * ACPI DSDT switches which set is in use depending on various
8063 * factors.
8064 *
8065 * TPACPI_FAN_WR_TPEC is also available and should be used to
8066 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
8067 * but the ACPI tables just mention level 7.
8068 */
8069
8070enum { /* Fan control constants */
8071 fan_status_offset = 0x2f, /* EC register 0x2f */
8072 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
8073 * 0x84 must be read before 0x85 */
8074 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
8075 bit 0 selects which fan is active */
8076
8077 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
8078 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
8079
8080 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
8081};
8082
8083enum fan_status_access_mode {
8084 TPACPI_FAN_NONE = 0, /* No fan status or control */
8085 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
8086 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
8087};
8088
8089enum fan_control_access_mode {
8090 TPACPI_FAN_WR_NONE = 0, /* No fan control */
8091 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
8092 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
8093 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
8094};
8095
8096enum fan_control_commands {
8097 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
8098 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
8099 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
8100 * and also watchdog cmd */
8101};
8102
8103static bool fan_control_allowed;
8104
8105static enum fan_status_access_mode fan_status_access_mode;
8106static enum fan_control_access_mode fan_control_access_mode;
8107static enum fan_control_commands fan_control_commands;
8108
8109static u8 fan_control_initial_status;
8110static u8 fan_control_desired_level;
8111static u8 fan_control_resume_level;
8112static int fan_watchdog_maxinterval;
8113
8114static struct mutex fan_mutex;
8115
8116static void fan_watchdog_fire(struct work_struct *ignored);
8117static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
8118
8119TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
8120TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
8121 "\\FSPD", /* 600e/x, 770e, 770x */
8122 ); /* all others */
8123TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
8124 "JFNS", /* 770x-JL */
8125 ); /* all others */
8126
8127/*
8128 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
8129 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
8130 * be in auto mode (0x80).
8131 *
8132 * This is corrected by any write to HFSP either by the driver, or
8133 * by the firmware.
8134 *
8135 * We assume 0x07 really means auto mode while this quirk is active,
8136 * as this is far more likely than the ThinkPad being in level 7,
8137 * which is only used by the firmware during thermal emergencies.
8138 *
8139 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
8140 * TP-70 (T43, R52), which are known to be buggy.
8141 */
8142
8143static void fan_quirk1_setup(void)
8144{
8145 if (fan_control_initial_status == 0x07) {
8146 pr_notice("fan_init: initial fan status is unknown, assuming it is in auto mode\n");
8147 tp_features.fan_ctrl_status_undef = 1;
8148 }
8149}
8150
8151static void fan_quirk1_handle(u8 *fan_status)
8152{
8153 if (unlikely(tp_features.fan_ctrl_status_undef)) {
8154 if (*fan_status != fan_control_initial_status) {
8155 /* something changed the HFSP regisnter since
8156 * driver init time, so it is not undefined
8157 * anymore */
8158 tp_features.fan_ctrl_status_undef = 0;
8159 } else {
8160 /* Return most likely status. In fact, it
8161 * might be the only possible status */
8162 *fan_status = TP_EC_FAN_AUTO;
8163 }
8164 }
8165}
8166
8167/* Select main fan on X60/X61, NOOP on others */
8168static bool fan_select_fan1(void)
8169{
8170 if (tp_features.second_fan) {
8171 u8 val;
8172
8173 if (ec_read(fan_select_offset, &val) < 0)
8174 return false;
8175 val &= 0xFEU;
8176 if (ec_write(fan_select_offset, val) < 0)
8177 return false;
8178 }
8179 return true;
8180}
8181
8182/* Select secondary fan on X60/X61 */
8183static bool fan_select_fan2(void)
8184{
8185 u8 val;
8186
8187 if (!tp_features.second_fan)
8188 return false;
8189
8190 if (ec_read(fan_select_offset, &val) < 0)
8191 return false;
8192 val |= 0x01U;
8193 if (ec_write(fan_select_offset, val) < 0)
8194 return false;
8195
8196 return true;
8197}
8198
8199/*
8200 * Call with fan_mutex held
8201 */
8202static void fan_update_desired_level(u8 status)
8203{
8204 if ((status &
8205 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8206 if (status > 7)
8207 fan_control_desired_level = 7;
8208 else
8209 fan_control_desired_level = status;
8210 }
8211}
8212
8213static int fan_get_status(u8 *status)
8214{
8215 u8 s;
8216
8217 /* TODO:
8218 * Add TPACPI_FAN_RD_ACPI_FANS ? */
8219
8220 switch (fan_status_access_mode) {
8221 case TPACPI_FAN_RD_ACPI_GFAN: {
8222 /* 570, 600e/x, 770e, 770x */
8223 int res;
8224
8225 if (unlikely(!acpi_evalf(gfan_handle, &res, NULL, "d")))
8226 return -EIO;
8227
8228 if (likely(status))
8229 *status = res & 0x07;
8230
8231 break;
8232 }
8233 case TPACPI_FAN_RD_TPEC:
8234 /* all except 570, 600e/x, 770e, 770x */
8235 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
8236 return -EIO;
8237
8238 if (likely(status)) {
8239 *status = s;
8240 fan_quirk1_handle(status);
8241 }
8242
8243 break;
8244
8245 default:
8246 return -ENXIO;
8247 }
8248
8249 return 0;
8250}
8251
8252static int fan_get_status_safe(u8 *status)
8253{
8254 int rc;
8255 u8 s;
8256
8257 if (mutex_lock_killable(&fan_mutex))
8258 return -ERESTARTSYS;
8259 rc = fan_get_status(&s);
8260 if (!rc)
8261 fan_update_desired_level(s);
8262 mutex_unlock(&fan_mutex);
8263
8264 if (rc)
8265 return rc;
8266 if (status)
8267 *status = s;
8268
8269 return 0;
8270}
8271
8272static int fan_get_speed(unsigned int *speed)
8273{
8274 u8 hi, lo;
8275
8276 switch (fan_status_access_mode) {
8277 case TPACPI_FAN_RD_TPEC:
8278 /* all except 570, 600e/x, 770e, 770x */
8279 if (unlikely(!fan_select_fan1()))
8280 return -EIO;
8281 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
8282 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
8283 return -EIO;
8284
8285 if (likely(speed))
8286 *speed = (hi << 8) | lo;
8287
8288 break;
8289
8290 default:
8291 return -ENXIO;
8292 }
8293
8294 return 0;
8295}
8296
8297static int fan2_get_speed(unsigned int *speed)
8298{
8299 u8 hi, lo;
8300 bool rc;
8301
8302 switch (fan_status_access_mode) {
8303 case TPACPI_FAN_RD_TPEC:
8304 /* all except 570, 600e/x, 770e, 770x */
8305 if (unlikely(!fan_select_fan2()))
8306 return -EIO;
8307 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
8308 !acpi_ec_read(fan_rpm_offset + 1, &hi);
8309 fan_select_fan1(); /* play it safe */
8310 if (rc)
8311 return -EIO;
8312
8313 if (likely(speed))
8314 *speed = (hi << 8) | lo;
8315
8316 break;
8317
8318 default:
8319 return -ENXIO;
8320 }
8321
8322 return 0;
8323}
8324
8325static int fan_set_level(int level)
8326{
8327 if (!fan_control_allowed)
8328 return -EPERM;
8329
8330 switch (fan_control_access_mode) {
8331 case TPACPI_FAN_WR_ACPI_SFAN:
8332 if ((level < 0) || (level > 7))
8333 return -EINVAL;
8334
8335 if (tp_features.second_fan_ctl) {
8336 if (!fan_select_fan2() ||
8337 !acpi_evalf(sfan_handle, NULL, NULL, "vd", level)) {
8338 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8339 tp_features.second_fan_ctl = 0;
8340 }
8341 fan_select_fan1();
8342 }
8343 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
8344 return -EIO;
8345 break;
8346
8347 case TPACPI_FAN_WR_ACPI_FANS:
8348 case TPACPI_FAN_WR_TPEC:
8349 if (!(level & TP_EC_FAN_AUTO) &&
8350 !(level & TP_EC_FAN_FULLSPEED) &&
8351 ((level < 0) || (level > 7)))
8352 return -EINVAL;
8353
8354 /* safety net should the EC not support AUTO
8355 * or FULLSPEED mode bits and just ignore them */
8356 if (level & TP_EC_FAN_FULLSPEED)
8357 level |= 7; /* safety min speed 7 */
8358 else if (level & TP_EC_FAN_AUTO)
8359 level |= 4; /* safety min speed 4 */
8360
8361 if (tp_features.second_fan_ctl) {
8362 if (!fan_select_fan2() ||
8363 !acpi_ec_write(fan_status_offset, level)) {
8364 pr_warn("Couldn't set 2nd fan level, disabling support\n");
8365 tp_features.second_fan_ctl = 0;
8366 }
8367 fan_select_fan1();
8368
8369 }
8370 if (!acpi_ec_write(fan_status_offset, level))
8371 return -EIO;
8372 else
8373 tp_features.fan_ctrl_status_undef = 0;
8374 break;
8375
8376 default:
8377 return -ENXIO;
8378 }
8379
8380 vdbg_printk(TPACPI_DBG_FAN,
8381 "fan control: set fan control register to 0x%02x\n", level);
8382 return 0;
8383}
8384
8385static int fan_set_level_safe(int level)
8386{
8387 int rc;
8388
8389 if (!fan_control_allowed)
8390 return -EPERM;
8391
8392 if (mutex_lock_killable(&fan_mutex))
8393 return -ERESTARTSYS;
8394
8395 if (level == TPACPI_FAN_LAST_LEVEL)
8396 level = fan_control_desired_level;
8397
8398 rc = fan_set_level(level);
8399 if (!rc)
8400 fan_update_desired_level(level);
8401
8402 mutex_unlock(&fan_mutex);
8403 return rc;
8404}
8405
8406static int fan_set_enable(void)
8407{
8408 u8 s;
8409 int rc;
8410
8411 if (!fan_control_allowed)
8412 return -EPERM;
8413
8414 if (mutex_lock_killable(&fan_mutex))
8415 return -ERESTARTSYS;
8416
8417 switch (fan_control_access_mode) {
8418 case TPACPI_FAN_WR_ACPI_FANS:
8419 case TPACPI_FAN_WR_TPEC:
8420 rc = fan_get_status(&s);
8421 if (rc)
8422 break;
8423
8424 /* Don't go out of emergency fan mode */
8425 if (s != 7) {
8426 s &= 0x07;
8427 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
8428 }
8429
8430 if (!acpi_ec_write(fan_status_offset, s))
8431 rc = -EIO;
8432 else {
8433 tp_features.fan_ctrl_status_undef = 0;
8434 rc = 0;
8435 }
8436 break;
8437
8438 case TPACPI_FAN_WR_ACPI_SFAN:
8439 rc = fan_get_status(&s);
8440 if (rc)
8441 break;
8442
8443 s &= 0x07;
8444
8445 /* Set fan to at least level 4 */
8446 s |= 4;
8447
8448 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
8449 rc = -EIO;
8450 else
8451 rc = 0;
8452 break;
8453
8454 default:
8455 rc = -ENXIO;
8456 }
8457
8458 mutex_unlock(&fan_mutex);
8459
8460 if (!rc)
8461 vdbg_printk(TPACPI_DBG_FAN,
8462 "fan control: set fan control register to 0x%02x\n",
8463 s);
8464 return rc;
8465}
8466
8467static int fan_set_disable(void)
8468{
8469 int rc;
8470
8471 if (!fan_control_allowed)
8472 return -EPERM;
8473
8474 if (mutex_lock_killable(&fan_mutex))
8475 return -ERESTARTSYS;
8476
8477 rc = 0;
8478 switch (fan_control_access_mode) {
8479 case TPACPI_FAN_WR_ACPI_FANS:
8480 case TPACPI_FAN_WR_TPEC:
8481 if (!acpi_ec_write(fan_status_offset, 0x00))
8482 rc = -EIO;
8483 else {
8484 fan_control_desired_level = 0;
8485 tp_features.fan_ctrl_status_undef = 0;
8486 }
8487 break;
8488
8489 case TPACPI_FAN_WR_ACPI_SFAN:
8490 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
8491 rc = -EIO;
8492 else
8493 fan_control_desired_level = 0;
8494 break;
8495
8496 default:
8497 rc = -ENXIO;
8498 }
8499
8500 if (!rc)
8501 vdbg_printk(TPACPI_DBG_FAN,
8502 "fan control: set fan control register to 0\n");
8503
8504 mutex_unlock(&fan_mutex);
8505 return rc;
8506}
8507
8508static int fan_set_speed(int speed)
8509{
8510 int rc;
8511
8512 if (!fan_control_allowed)
8513 return -EPERM;
8514
8515 if (mutex_lock_killable(&fan_mutex))
8516 return -ERESTARTSYS;
8517
8518 rc = 0;
8519 switch (fan_control_access_mode) {
8520 case TPACPI_FAN_WR_ACPI_FANS:
8521 if (speed >= 0 && speed <= 65535) {
8522 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
8523 speed, speed, speed))
8524 rc = -EIO;
8525 } else
8526 rc = -EINVAL;
8527 break;
8528
8529 default:
8530 rc = -ENXIO;
8531 }
8532
8533 mutex_unlock(&fan_mutex);
8534 return rc;
8535}
8536
8537static void fan_watchdog_reset(void)
8538{
8539 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
8540 return;
8541
8542 if (fan_watchdog_maxinterval > 0 &&
8543 tpacpi_lifecycle != TPACPI_LIFE_EXITING)
8544 mod_delayed_work(tpacpi_wq, &fan_watchdog_task,
8545 msecs_to_jiffies(fan_watchdog_maxinterval * 1000));
8546 else
8547 cancel_delayed_work(&fan_watchdog_task);
8548}
8549
8550static void fan_watchdog_fire(struct work_struct *ignored)
8551{
8552 int rc;
8553
8554 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
8555 return;
8556
8557 pr_notice("fan watchdog: enabling fan\n");
8558 rc = fan_set_enable();
8559 if (rc < 0) {
8560 pr_err("fan watchdog: error %d while enabling fan, will try again later...\n",
8561 rc);
8562 /* reschedule for later */
8563 fan_watchdog_reset();
8564 }
8565}
8566
8567/*
8568 * SYSFS fan layout: hwmon compatible (device)
8569 *
8570 * pwm*_enable:
8571 * 0: "disengaged" mode
8572 * 1: manual mode
8573 * 2: native EC "auto" mode (recommended, hardware default)
8574 *
8575 * pwm*: set speed in manual mode, ignored otherwise.
8576 * 0 is level 0; 255 is level 7. Intermediate points done with linear
8577 * interpolation.
8578 *
8579 * fan*_input: tachometer reading, RPM
8580 *
8581 *
8582 * SYSFS fan layout: extensions
8583 *
8584 * fan_watchdog (driver):
8585 * fan watchdog interval in seconds, 0 disables (default), max 120
8586 */
8587
8588/* sysfs fan pwm1_enable ----------------------------------------------- */
8589static ssize_t fan_pwm1_enable_show(struct device *dev,
8590 struct device_attribute *attr,
8591 char *buf)
8592{
8593 int res, mode;
8594 u8 status;
8595
8596 res = fan_get_status_safe(&status);
8597 if (res)
8598 return res;
8599
8600 if (status & TP_EC_FAN_FULLSPEED) {
8601 mode = 0;
8602 } else if (status & TP_EC_FAN_AUTO) {
8603 mode = 2;
8604 } else
8605 mode = 1;
8606
8607 return sysfs_emit(buf, "%d\n", mode);
8608}
8609
8610static ssize_t fan_pwm1_enable_store(struct device *dev,
8611 struct device_attribute *attr,
8612 const char *buf, size_t count)
8613{
8614 unsigned long t;
8615 int res, level;
8616
8617 if (parse_strtoul(buf, 2, &t))
8618 return -EINVAL;
8619
8620 tpacpi_disclose_usertask("hwmon pwm1_enable",
8621 "set fan mode to %lu\n", t);
8622
8623 switch (t) {
8624 case 0:
8625 level = TP_EC_FAN_FULLSPEED;
8626 break;
8627 case 1:
8628 level = TPACPI_FAN_LAST_LEVEL;
8629 break;
8630 case 2:
8631 level = TP_EC_FAN_AUTO;
8632 break;
8633 case 3:
8634 /* reserved for software-controlled auto mode */
8635 return -ENOSYS;
8636 default:
8637 return -EINVAL;
8638 }
8639
8640 res = fan_set_level_safe(level);
8641 if (res == -ENXIO)
8642 return -EINVAL;
8643 else if (res < 0)
8644 return res;
8645
8646 fan_watchdog_reset();
8647
8648 return count;
8649}
8650
8651static DEVICE_ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
8652 fan_pwm1_enable_show, fan_pwm1_enable_store);
8653
8654/* sysfs fan pwm1 ------------------------------------------------------ */
8655static ssize_t fan_pwm1_show(struct device *dev,
8656 struct device_attribute *attr,
8657 char *buf)
8658{
8659 int res;
8660 u8 status;
8661
8662 res = fan_get_status_safe(&status);
8663 if (res)
8664 return res;
8665
8666 if ((status &
8667 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
8668 status = fan_control_desired_level;
8669
8670 if (status > 7)
8671 status = 7;
8672
8673 return sysfs_emit(buf, "%u\n", (status * 255) / 7);
8674}
8675
8676static ssize_t fan_pwm1_store(struct device *dev,
8677 struct device_attribute *attr,
8678 const char *buf, size_t count)
8679{
8680 unsigned long s;
8681 int rc;
8682 u8 status, newlevel;
8683
8684 if (parse_strtoul(buf, 255, &s))
8685 return -EINVAL;
8686
8687 tpacpi_disclose_usertask("hwmon pwm1",
8688 "set fan speed to %lu\n", s);
8689
8690 /* scale down from 0-255 to 0-7 */
8691 newlevel = (s >> 5) & 0x07;
8692
8693 if (mutex_lock_killable(&fan_mutex))
8694 return -ERESTARTSYS;
8695
8696 rc = fan_get_status(&status);
8697 if (!rc && (status &
8698 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
8699 rc = fan_set_level(newlevel);
8700 if (rc == -ENXIO)
8701 rc = -EINVAL;
8702 else if (!rc) {
8703 fan_update_desired_level(newlevel);
8704 fan_watchdog_reset();
8705 }
8706 }
8707
8708 mutex_unlock(&fan_mutex);
8709 return (rc) ? rc : count;
8710}
8711
8712static DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, fan_pwm1_show, fan_pwm1_store);
8713
8714/* sysfs fan fan1_input ------------------------------------------------ */
8715static ssize_t fan_fan1_input_show(struct device *dev,
8716 struct device_attribute *attr,
8717 char *buf)
8718{
8719 int res;
8720 unsigned int speed;
8721
8722 res = fan_get_speed(&speed);
8723 if (res < 0)
8724 return res;
8725
8726 return sysfs_emit(buf, "%u\n", speed);
8727}
8728
8729static DEVICE_ATTR(fan1_input, S_IRUGO, fan_fan1_input_show, NULL);
8730
8731/* sysfs fan fan2_input ------------------------------------------------ */
8732static ssize_t fan_fan2_input_show(struct device *dev,
8733 struct device_attribute *attr,
8734 char *buf)
8735{
8736 int res;
8737 unsigned int speed;
8738
8739 res = fan2_get_speed(&speed);
8740 if (res < 0)
8741 return res;
8742
8743 return sysfs_emit(buf, "%u\n", speed);
8744}
8745
8746static DEVICE_ATTR(fan2_input, S_IRUGO, fan_fan2_input_show, NULL);
8747
8748/* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
8749static ssize_t fan_watchdog_show(struct device_driver *drv, char *buf)
8750{
8751 return sysfs_emit(buf, "%u\n", fan_watchdog_maxinterval);
8752}
8753
8754static ssize_t fan_watchdog_store(struct device_driver *drv, const char *buf,
8755 size_t count)
8756{
8757 unsigned long t;
8758
8759 if (parse_strtoul(buf, 120, &t))
8760 return -EINVAL;
8761
8762 if (!fan_control_allowed)
8763 return -EPERM;
8764
8765 fan_watchdog_maxinterval = t;
8766 fan_watchdog_reset();
8767
8768 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
8769
8770 return count;
8771}
8772static DRIVER_ATTR_RW(fan_watchdog);
8773
8774/* --------------------------------------------------------------------- */
8775
8776static struct attribute *fan_attributes[] = {
8777 &dev_attr_pwm1_enable.attr,
8778 &dev_attr_pwm1.attr,
8779 &dev_attr_fan1_input.attr,
8780 &dev_attr_fan2_input.attr,
8781 NULL
8782};
8783
8784static umode_t fan_attr_is_visible(struct kobject *kobj, struct attribute *attr,
8785 int n)
8786{
8787 if (fan_status_access_mode == TPACPI_FAN_NONE &&
8788 fan_control_access_mode == TPACPI_FAN_WR_NONE)
8789 return 0;
8790
8791 if (attr == &dev_attr_fan2_input.attr) {
8792 if (!tp_features.second_fan)
8793 return 0;
8794 }
8795
8796 return attr->mode;
8797}
8798
8799static const struct attribute_group fan_attr_group = {
8800 .is_visible = fan_attr_is_visible,
8801 .attrs = fan_attributes,
8802};
8803
8804static struct attribute *fan_driver_attributes[] = {
8805 &driver_attr_fan_watchdog.attr,
8806 NULL
8807};
8808
8809static const struct attribute_group fan_driver_attr_group = {
8810 .is_visible = fan_attr_is_visible,
8811 .attrs = fan_driver_attributes,
8812};
8813
8814#define TPACPI_FAN_Q1 0x0001 /* Uninitialized HFSP */
8815#define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
8816#define TPACPI_FAN_2CTL 0x0004 /* selects fan2 control */
8817#define TPACPI_FAN_NOFAN 0x0008 /* no fan available */
8818
8819static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
8820 TPACPI_QEC_IBM('1', 'Y', TPACPI_FAN_Q1),
8821 TPACPI_QEC_IBM('7', '8', TPACPI_FAN_Q1),
8822 TPACPI_QEC_IBM('7', '6', TPACPI_FAN_Q1),
8823 TPACPI_QEC_IBM('7', '0', TPACPI_FAN_Q1),
8824 TPACPI_QEC_LNV('7', 'M', TPACPI_FAN_2FAN),
8825 TPACPI_Q_LNV('N', '1', TPACPI_FAN_2FAN),
8826 TPACPI_Q_LNV3('N', '1', 'D', TPACPI_FAN_2CTL), /* P70 */
8827 TPACPI_Q_LNV3('N', '1', 'E', TPACPI_FAN_2CTL), /* P50 */
8828 TPACPI_Q_LNV3('N', '1', 'T', TPACPI_FAN_2CTL), /* P71 */
8829 TPACPI_Q_LNV3('N', '1', 'U', TPACPI_FAN_2CTL), /* P51 */
8830 TPACPI_Q_LNV3('N', '2', 'C', TPACPI_FAN_2CTL), /* P52 / P72 */
8831 TPACPI_Q_LNV3('N', '2', 'N', TPACPI_FAN_2CTL), /* P53 / P73 */
8832 TPACPI_Q_LNV3('N', '2', 'E', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (1st gen) */
8833 TPACPI_Q_LNV3('N', '2', 'O', TPACPI_FAN_2CTL), /* P1 / X1 Extreme (2nd gen) */
8834 TPACPI_Q_LNV3('N', '3', '0', TPACPI_FAN_2CTL), /* P15 (1st gen) / P15v (1st gen) */
8835 TPACPI_Q_LNV3('N', '3', '7', TPACPI_FAN_2CTL), /* T15g (2nd gen) */
8836 TPACPI_Q_LNV3('N', '1', 'O', TPACPI_FAN_NOFAN), /* X1 Tablet (2nd gen) */
8837};
8838
8839static int __init fan_init(struct ibm_init_struct *iibm)
8840{
8841 unsigned long quirks;
8842
8843 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8844 "initializing fan subdriver\n");
8845
8846 mutex_init(&fan_mutex);
8847 fan_status_access_mode = TPACPI_FAN_NONE;
8848 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8849 fan_control_commands = 0;
8850 fan_watchdog_maxinterval = 0;
8851 tp_features.fan_ctrl_status_undef = 0;
8852 tp_features.second_fan = 0;
8853 tp_features.second_fan_ctl = 0;
8854 fan_control_desired_level = 7;
8855
8856 if (tpacpi_is_ibm()) {
8857 TPACPI_ACPIHANDLE_INIT(fans);
8858 TPACPI_ACPIHANDLE_INIT(gfan);
8859 TPACPI_ACPIHANDLE_INIT(sfan);
8860 }
8861
8862 quirks = tpacpi_check_quirks(fan_quirk_table,
8863 ARRAY_SIZE(fan_quirk_table));
8864
8865 if (quirks & TPACPI_FAN_NOFAN) {
8866 pr_info("No integrated ThinkPad fan available\n");
8867 return -ENODEV;
8868 }
8869
8870 if (gfan_handle) {
8871 /* 570, 600e/x, 770e, 770x */
8872 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
8873 } else {
8874 /* all other ThinkPads: note that even old-style
8875 * ThinkPad ECs supports the fan control register */
8876 if (likely(acpi_ec_read(fan_status_offset,
8877 &fan_control_initial_status))) {
8878 int res;
8879 unsigned int speed;
8880
8881 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
8882 if (quirks & TPACPI_FAN_Q1)
8883 fan_quirk1_setup();
8884 /* Try and probe the 2nd fan */
8885 tp_features.second_fan = 1; /* needed for get_speed to work */
8886 res = fan2_get_speed(&speed);
8887 if (res >= 0 && speed != FAN_NOT_PRESENT) {
8888 /* It responded - so let's assume it's there */
8889 tp_features.second_fan = 1;
8890 tp_features.second_fan_ctl = 1;
8891 pr_info("secondary fan control detected & enabled\n");
8892 } else {
8893 /* Fan not auto-detected */
8894 tp_features.second_fan = 0;
8895 if (quirks & TPACPI_FAN_2FAN) {
8896 tp_features.second_fan = 1;
8897 pr_info("secondary fan support enabled\n");
8898 }
8899 if (quirks & TPACPI_FAN_2CTL) {
8900 tp_features.second_fan = 1;
8901 tp_features.second_fan_ctl = 1;
8902 pr_info("secondary fan control enabled\n");
8903 }
8904 }
8905 } else {
8906 pr_err("ThinkPad ACPI EC access misbehaving, fan status and control unavailable\n");
8907 return -ENODEV;
8908 }
8909 }
8910
8911 if (sfan_handle) {
8912 /* 570, 770x-JL */
8913 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
8914 fan_control_commands |=
8915 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
8916 } else {
8917 if (!gfan_handle) {
8918 /* gfan without sfan means no fan control */
8919 /* all other models implement TP EC 0x2f control */
8920
8921 if (fans_handle) {
8922 /* X31, X40, X41 */
8923 fan_control_access_mode =
8924 TPACPI_FAN_WR_ACPI_FANS;
8925 fan_control_commands |=
8926 TPACPI_FAN_CMD_SPEED |
8927 TPACPI_FAN_CMD_LEVEL |
8928 TPACPI_FAN_CMD_ENABLE;
8929 } else {
8930 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
8931 fan_control_commands |=
8932 TPACPI_FAN_CMD_LEVEL |
8933 TPACPI_FAN_CMD_ENABLE;
8934 }
8935 }
8936 }
8937
8938 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8939 "fan is %s, modes %d, %d\n",
8940 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
8941 fan_control_access_mode != TPACPI_FAN_WR_NONE),
8942 fan_status_access_mode, fan_control_access_mode);
8943
8944 /* fan control master switch */
8945 if (!fan_control_allowed) {
8946 fan_control_access_mode = TPACPI_FAN_WR_NONE;
8947 fan_control_commands = 0;
8948 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
8949 "fan control features disabled by parameter\n");
8950 }
8951
8952 /* update fan_control_desired_level */
8953 if (fan_status_access_mode != TPACPI_FAN_NONE)
8954 fan_get_status_safe(NULL);
8955
8956 if (fan_status_access_mode == TPACPI_FAN_NONE &&
8957 fan_control_access_mode == TPACPI_FAN_WR_NONE)
8958 return -ENODEV;
8959
8960 return 0;
8961}
8962
8963static void fan_exit(void)
8964{
8965 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
8966 "cancelling any pending fan watchdog tasks\n");
8967
8968 cancel_delayed_work(&fan_watchdog_task);
8969 flush_workqueue(tpacpi_wq);
8970}
8971
8972static void fan_suspend(void)
8973{
8974 int rc;
8975
8976 if (!fan_control_allowed)
8977 return;
8978
8979 /* Store fan status in cache */
8980 fan_control_resume_level = 0;
8981 rc = fan_get_status_safe(&fan_control_resume_level);
8982 if (rc)
8983 pr_notice("failed to read fan level for later restore during resume: %d\n",
8984 rc);
8985
8986 /* if it is undefined, don't attempt to restore it.
8987 * KEEP THIS LAST */
8988 if (tp_features.fan_ctrl_status_undef)
8989 fan_control_resume_level = 0;
8990}
8991
8992static void fan_resume(void)
8993{
8994 u8 current_level = 7;
8995 bool do_set = false;
8996 int rc;
8997
8998 /* DSDT *always* updates status on resume */
8999 tp_features.fan_ctrl_status_undef = 0;
9000
9001 if (!fan_control_allowed ||
9002 !fan_control_resume_level ||
9003 fan_get_status_safe(¤t_level))
9004 return;
9005
9006 switch (fan_control_access_mode) {
9007 case TPACPI_FAN_WR_ACPI_SFAN:
9008 /* never decrease fan level */
9009 do_set = (fan_control_resume_level > current_level);
9010 break;
9011 case TPACPI_FAN_WR_ACPI_FANS:
9012 case TPACPI_FAN_WR_TPEC:
9013 /* never decrease fan level, scale is:
9014 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
9015 *
9016 * We expect the firmware to set either 7 or AUTO, but we
9017 * handle FULLSPEED out of paranoia.
9018 *
9019 * So, we can safely only restore FULLSPEED or 7, anything
9020 * else could slow the fan. Restoring AUTO is useless, at
9021 * best that's exactly what the DSDT already set (it is the
9022 * slower it uses).
9023 *
9024 * Always keep in mind that the DSDT *will* have set the
9025 * fans to what the vendor supposes is the best level. We
9026 * muck with it only to speed the fan up.
9027 */
9028 if (fan_control_resume_level != 7 &&
9029 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
9030 return;
9031 else
9032 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
9033 (current_level != fan_control_resume_level);
9034 break;
9035 default:
9036 return;
9037 }
9038 if (do_set) {
9039 pr_notice("restoring fan level to 0x%02x\n",
9040 fan_control_resume_level);
9041 rc = fan_set_level_safe(fan_control_resume_level);
9042 if (rc < 0)
9043 pr_notice("failed to restore fan level: %d\n", rc);
9044 }
9045}
9046
9047static int fan_read(struct seq_file *m)
9048{
9049 int rc;
9050 u8 status;
9051 unsigned int speed = 0;
9052
9053 switch (fan_status_access_mode) {
9054 case TPACPI_FAN_RD_ACPI_GFAN:
9055 /* 570, 600e/x, 770e, 770x */
9056 rc = fan_get_status_safe(&status);
9057 if (rc)
9058 return rc;
9059
9060 seq_printf(m, "status:\t\t%s\n"
9061 "level:\t\t%d\n",
9062 str_enabled_disabled(status), status);
9063 break;
9064
9065 case TPACPI_FAN_RD_TPEC:
9066 /* all except 570, 600e/x, 770e, 770x */
9067 rc = fan_get_status_safe(&status);
9068 if (rc)
9069 return rc;
9070
9071 seq_printf(m, "status:\t\t%s\n", str_enabled_disabled(status));
9072
9073 rc = fan_get_speed(&speed);
9074 if (rc < 0)
9075 return rc;
9076
9077 seq_printf(m, "speed:\t\t%d\n", speed);
9078
9079 if (status & TP_EC_FAN_FULLSPEED)
9080 /* Disengaged mode takes precedence */
9081 seq_printf(m, "level:\t\tdisengaged\n");
9082 else if (status & TP_EC_FAN_AUTO)
9083 seq_printf(m, "level:\t\tauto\n");
9084 else
9085 seq_printf(m, "level:\t\t%d\n", status);
9086 break;
9087
9088 case TPACPI_FAN_NONE:
9089 default:
9090 seq_printf(m, "status:\t\tnot supported\n");
9091 }
9092
9093 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
9094 seq_printf(m, "commands:\tlevel <level>");
9095
9096 switch (fan_control_access_mode) {
9097 case TPACPI_FAN_WR_ACPI_SFAN:
9098 seq_printf(m, " (<level> is 0-7)\n");
9099 break;
9100
9101 default:
9102 seq_printf(m, " (<level> is 0-7, auto, disengaged, full-speed)\n");
9103 break;
9104 }
9105 }
9106
9107 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
9108 seq_printf(m, "commands:\tenable, disable\n"
9109 "commands:\twatchdog <timeout> (<timeout> is 0 (off), 1-120 (seconds))\n");
9110
9111 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
9112 seq_printf(m, "commands:\tspeed <speed> (<speed> is 0-65535)\n");
9113
9114 return 0;
9115}
9116
9117static int fan_write_cmd_level(const char *cmd, int *rc)
9118{
9119 int level;
9120
9121 if (strstarts(cmd, "level auto"))
9122 level = TP_EC_FAN_AUTO;
9123 else if (strstarts(cmd, "level disengaged") || strstarts(cmd, "level full-speed"))
9124 level = TP_EC_FAN_FULLSPEED;
9125 else if (sscanf(cmd, "level %d", &level) != 1)
9126 return 0;
9127
9128 *rc = fan_set_level_safe(level);
9129 if (*rc == -ENXIO)
9130 pr_err("level command accepted for unsupported access mode %d\n",
9131 fan_control_access_mode);
9132 else if (!*rc)
9133 tpacpi_disclose_usertask("procfs fan",
9134 "set level to %d\n", level);
9135
9136 return 1;
9137}
9138
9139static int fan_write_cmd_enable(const char *cmd, int *rc)
9140{
9141 if (!strstarts(cmd, "enable"))
9142 return 0;
9143
9144 *rc = fan_set_enable();
9145 if (*rc == -ENXIO)
9146 pr_err("enable command accepted for unsupported access mode %d\n",
9147 fan_control_access_mode);
9148 else if (!*rc)
9149 tpacpi_disclose_usertask("procfs fan", "enable\n");
9150
9151 return 1;
9152}
9153
9154static int fan_write_cmd_disable(const char *cmd, int *rc)
9155{
9156 if (!strstarts(cmd, "disable"))
9157 return 0;
9158
9159 *rc = fan_set_disable();
9160 if (*rc == -ENXIO)
9161 pr_err("disable command accepted for unsupported access mode %d\n",
9162 fan_control_access_mode);
9163 else if (!*rc)
9164 tpacpi_disclose_usertask("procfs fan", "disable\n");
9165
9166 return 1;
9167}
9168
9169static int fan_write_cmd_speed(const char *cmd, int *rc)
9170{
9171 int speed;
9172
9173 /* TODO:
9174 * Support speed <low> <medium> <high> ? */
9175
9176 if (sscanf(cmd, "speed %d", &speed) != 1)
9177 return 0;
9178
9179 *rc = fan_set_speed(speed);
9180 if (*rc == -ENXIO)
9181 pr_err("speed command accepted for unsupported access mode %d\n",
9182 fan_control_access_mode);
9183 else if (!*rc)
9184 tpacpi_disclose_usertask("procfs fan",
9185 "set speed to %d\n", speed);
9186
9187 return 1;
9188}
9189
9190static int fan_write_cmd_watchdog(const char *cmd, int *rc)
9191{
9192 int interval;
9193
9194 if (sscanf(cmd, "watchdog %d", &interval) != 1)
9195 return 0;
9196
9197 if (interval < 0 || interval > 120)
9198 *rc = -EINVAL;
9199 else {
9200 fan_watchdog_maxinterval = interval;
9201 tpacpi_disclose_usertask("procfs fan",
9202 "set watchdog timer to %d\n",
9203 interval);
9204 }
9205
9206 return 1;
9207}
9208
9209static int fan_write(char *buf)
9210{
9211 char *cmd;
9212 int rc = 0;
9213
9214 while (!rc && (cmd = strsep(&buf, ","))) {
9215 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
9216 fan_write_cmd_level(cmd, &rc)) &&
9217 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
9218 (fan_write_cmd_enable(cmd, &rc) ||
9219 fan_write_cmd_disable(cmd, &rc) ||
9220 fan_write_cmd_watchdog(cmd, &rc))) &&
9221 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
9222 fan_write_cmd_speed(cmd, &rc))
9223 )
9224 rc = -EINVAL;
9225 else if (!rc)
9226 fan_watchdog_reset();
9227 }
9228
9229 return rc;
9230}
9231
9232static struct ibm_struct fan_driver_data = {
9233 .name = "fan",
9234 .read = fan_read,
9235 .write = fan_write,
9236 .exit = fan_exit,
9237 .suspend = fan_suspend,
9238 .resume = fan_resume,
9239};
9240
9241/*************************************************************************
9242 * Mute LED subdriver
9243 */
9244
9245#define TPACPI_LED_MAX 2
9246
9247struct tp_led_table {
9248 acpi_string name;
9249 int on_value;
9250 int off_value;
9251 int state;
9252};
9253
9254static struct tp_led_table led_tables[TPACPI_LED_MAX] = {
9255 [LED_AUDIO_MUTE] = {
9256 .name = "SSMS",
9257 .on_value = 1,
9258 .off_value = 0,
9259 },
9260 [LED_AUDIO_MICMUTE] = {
9261 .name = "MMTS",
9262 .on_value = 2,
9263 .off_value = 0,
9264 },
9265};
9266
9267static int mute_led_on_off(struct tp_led_table *t, bool state)
9268{
9269 acpi_handle temp;
9270 int output;
9271
9272 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9273 pr_warn("Thinkpad ACPI has no %s interface.\n", t->name);
9274 return -EIO;
9275 }
9276
9277 if (!acpi_evalf(hkey_handle, &output, t->name, "dd",
9278 state ? t->on_value : t->off_value))
9279 return -EIO;
9280
9281 t->state = state;
9282 return state;
9283}
9284
9285static int tpacpi_led_set(int whichled, bool on)
9286{
9287 struct tp_led_table *t;
9288
9289 t = &led_tables[whichled];
9290 if (t->state < 0 || t->state == on)
9291 return t->state;
9292 return mute_led_on_off(t, on);
9293}
9294
9295static int tpacpi_led_mute_set(struct led_classdev *led_cdev,
9296 enum led_brightness brightness)
9297{
9298 return tpacpi_led_set(LED_AUDIO_MUTE, brightness != LED_OFF);
9299}
9300
9301static int tpacpi_led_micmute_set(struct led_classdev *led_cdev,
9302 enum led_brightness brightness)
9303{
9304 return tpacpi_led_set(LED_AUDIO_MICMUTE, brightness != LED_OFF);
9305}
9306
9307static struct led_classdev mute_led_cdev[TPACPI_LED_MAX] = {
9308 [LED_AUDIO_MUTE] = {
9309 .name = "platform::mute",
9310 .max_brightness = 1,
9311 .brightness_set_blocking = tpacpi_led_mute_set,
9312 .default_trigger = "audio-mute",
9313 },
9314 [LED_AUDIO_MICMUTE] = {
9315 .name = "platform::micmute",
9316 .max_brightness = 1,
9317 .brightness_set_blocking = tpacpi_led_micmute_set,
9318 .default_trigger = "audio-micmute",
9319 },
9320};
9321
9322static int mute_led_init(struct ibm_init_struct *iibm)
9323{
9324 acpi_handle temp;
9325 int i, err;
9326
9327 for (i = 0; i < TPACPI_LED_MAX; i++) {
9328 struct tp_led_table *t = &led_tables[i];
9329 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, t->name, &temp))) {
9330 t->state = -ENODEV;
9331 continue;
9332 }
9333
9334 mute_led_cdev[i].brightness = ledtrig_audio_get(i);
9335 err = led_classdev_register(&tpacpi_pdev->dev, &mute_led_cdev[i]);
9336 if (err < 0) {
9337 while (i--)
9338 led_classdev_unregister(&mute_led_cdev[i]);
9339 return err;
9340 }
9341 }
9342 return 0;
9343}
9344
9345static void mute_led_exit(void)
9346{
9347 int i;
9348
9349 for (i = 0; i < TPACPI_LED_MAX; i++) {
9350 led_classdev_unregister(&mute_led_cdev[i]);
9351 tpacpi_led_set(i, false);
9352 }
9353}
9354
9355static void mute_led_resume(void)
9356{
9357 int i;
9358
9359 for (i = 0; i < TPACPI_LED_MAX; i++) {
9360 struct tp_led_table *t = &led_tables[i];
9361 if (t->state >= 0)
9362 mute_led_on_off(t, t->state);
9363 }
9364}
9365
9366static struct ibm_struct mute_led_driver_data = {
9367 .name = "mute_led",
9368 .exit = mute_led_exit,
9369 .resume = mute_led_resume,
9370};
9371
9372/*
9373 * Battery Wear Control Driver
9374 * Contact: Ognjen Galic <smclt30p@gmail.com>
9375 */
9376
9377/* Metadata */
9378
9379#define GET_START "BCTG"
9380#define SET_START "BCCS"
9381#define GET_STOP "BCSG"
9382#define SET_STOP "BCSS"
9383#define GET_DISCHARGE "BDSG"
9384#define SET_DISCHARGE "BDSS"
9385#define GET_INHIBIT "BICG"
9386#define SET_INHIBIT "BICS"
9387
9388enum {
9389 BAT_ANY = 0,
9390 BAT_PRIMARY = 1,
9391 BAT_SECONDARY = 2
9392};
9393
9394enum {
9395 /* Error condition bit */
9396 METHOD_ERR = BIT(31),
9397};
9398
9399enum {
9400 /* This is used in the get/set helpers */
9401 THRESHOLD_START,
9402 THRESHOLD_STOP,
9403 FORCE_DISCHARGE,
9404 INHIBIT_CHARGE,
9405};
9406
9407struct tpacpi_battery_data {
9408 int charge_start;
9409 int start_support;
9410 int charge_stop;
9411 int stop_support;
9412 unsigned int charge_behaviours;
9413};
9414
9415struct tpacpi_battery_driver_data {
9416 struct tpacpi_battery_data batteries[3];
9417 int individual_addressing;
9418};
9419
9420static struct tpacpi_battery_driver_data battery_info;
9421
9422/* ACPI helpers/functions/probes */
9423
9424/**
9425 * This evaluates a ACPI method call specific to the battery
9426 * ACPI extension. The specifics are that an error is marked
9427 * in the 32rd bit of the response, so we just check that here.
9428 */
9429static acpi_status tpacpi_battery_acpi_eval(char *method, int *ret, int param)
9430{
9431 int response;
9432
9433 if (!acpi_evalf(hkey_handle, &response, method, "dd", param)) {
9434 acpi_handle_err(hkey_handle, "%s: evaluate failed", method);
9435 return AE_ERROR;
9436 }
9437 if (response & METHOD_ERR) {
9438 acpi_handle_err(hkey_handle,
9439 "%s evaluated but flagged as error", method);
9440 return AE_ERROR;
9441 }
9442 *ret = response;
9443 return AE_OK;
9444}
9445
9446static int tpacpi_battery_get(int what, int battery, int *ret)
9447{
9448 switch (what) {
9449 case THRESHOLD_START:
9450 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, ret, battery))
9451 return -ENODEV;
9452
9453 /* The value is in the low 8 bits of the response */
9454 *ret = *ret & 0xFF;
9455 return 0;
9456 case THRESHOLD_STOP:
9457 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, ret, battery))
9458 return -ENODEV;
9459 /* Value is in lower 8 bits */
9460 *ret = *ret & 0xFF;
9461 /*
9462 * On the stop value, if we return 0 that
9463 * does not make any sense. 0 means Default, which
9464 * means that charging stops at 100%, so we return
9465 * that.
9466 */
9467 if (*ret == 0)
9468 *ret = 100;
9469 return 0;
9470 case FORCE_DISCHARGE:
9471 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_DISCHARGE, ret, battery))
9472 return -ENODEV;
9473 /* The force discharge status is in bit 0 */
9474 *ret = *ret & 0x01;
9475 return 0;
9476 case INHIBIT_CHARGE:
9477 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_INHIBIT, ret, battery))
9478 return -ENODEV;
9479 /* The inhibit charge status is in bit 0 */
9480 *ret = *ret & 0x01;
9481 return 0;
9482 default:
9483 pr_crit("wrong parameter: %d", what);
9484 return -EINVAL;
9485 }
9486}
9487
9488static int tpacpi_battery_set(int what, int battery, int value)
9489{
9490 int param, ret;
9491 /* The first 8 bits are the value of the threshold */
9492 param = value;
9493 /* The battery ID is in bits 8-9, 2 bits */
9494 param |= battery << 8;
9495
9496 switch (what) {
9497 case THRESHOLD_START:
9498 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_START, &ret, param)) {
9499 pr_err("failed to set charge threshold on battery %d",
9500 battery);
9501 return -ENODEV;
9502 }
9503 return 0;
9504 case THRESHOLD_STOP:
9505 if ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_STOP, &ret, param)) {
9506 pr_err("failed to set stop threshold: %d", battery);
9507 return -ENODEV;
9508 }
9509 return 0;
9510 case FORCE_DISCHARGE:
9511 /* Force discharge is in bit 0,
9512 * break on AC attach is in bit 1 (won't work on some ThinkPads),
9513 * battery ID is in bits 8-9, 2 bits.
9514 */
9515 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_DISCHARGE, &ret, param))) {
9516 pr_err("failed to set force discharge on %d", battery);
9517 return -ENODEV;
9518 }
9519 return 0;
9520 case INHIBIT_CHARGE:
9521 /* When setting inhibit charge, we set a default value of
9522 * always breaking on AC detach and the effective time is set to
9523 * be permanent.
9524 * The battery ID is in bits 4-5, 2 bits,
9525 * the effective time is in bits 8-23, 2 bytes.
9526 * A time of FFFF indicates forever.
9527 */
9528 param = value;
9529 param |= battery << 4;
9530 param |= 0xFFFF << 8;
9531 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(SET_INHIBIT, &ret, param))) {
9532 pr_err("failed to set inhibit charge on %d", battery);
9533 return -ENODEV;
9534 }
9535 return 0;
9536 default:
9537 pr_crit("wrong parameter: %d", what);
9538 return -EINVAL;
9539 }
9540}
9541
9542static int tpacpi_battery_set_validate(int what, int battery, int value)
9543{
9544 int ret, v;
9545
9546 ret = tpacpi_battery_set(what, battery, value);
9547 if (ret < 0)
9548 return ret;
9549
9550 ret = tpacpi_battery_get(what, battery, &v);
9551 if (ret < 0)
9552 return ret;
9553
9554 if (v == value)
9555 return 0;
9556
9557 msleep(500);
9558
9559 ret = tpacpi_battery_get(what, battery, &v);
9560 if (ret < 0)
9561 return ret;
9562
9563 if (v == value)
9564 return 0;
9565
9566 return -EIO;
9567}
9568
9569static int tpacpi_battery_probe(int battery)
9570{
9571 int ret = 0;
9572
9573 memset(&battery_info.batteries[battery], 0,
9574 sizeof(battery_info.batteries[battery]));
9575
9576 /*
9577 * 1) Get the current start threshold
9578 * 2) Check for support
9579 * 3) Get the current stop threshold
9580 * 4) Check for support
9581 * 5) Get the current force discharge status
9582 * 6) Check for support
9583 * 7) Get the current inhibit charge status
9584 * 8) Check for support
9585 */
9586 if (acpi_has_method(hkey_handle, GET_START)) {
9587 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_START, &ret, battery)) {
9588 pr_err("Error probing battery %d\n", battery);
9589 return -ENODEV;
9590 }
9591 /* Individual addressing is in bit 9 */
9592 if (ret & BIT(9))
9593 battery_info.individual_addressing = true;
9594 /* Support is marked in bit 8 */
9595 if (ret & BIT(8))
9596 battery_info.batteries[battery].start_support = 1;
9597 else
9598 return -ENODEV;
9599 if (tpacpi_battery_get(THRESHOLD_START, battery,
9600 &battery_info.batteries[battery].charge_start)) {
9601 pr_err("Error probing battery %d\n", battery);
9602 return -ENODEV;
9603 }
9604 }
9605 if (acpi_has_method(hkey_handle, GET_STOP)) {
9606 if ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_STOP, &ret, battery)) {
9607 pr_err("Error probing battery stop; %d\n", battery);
9608 return -ENODEV;
9609 }
9610 /* Support is marked in bit 8 */
9611 if (ret & BIT(8))
9612 battery_info.batteries[battery].stop_support = 1;
9613 else
9614 return -ENODEV;
9615 if (tpacpi_battery_get(THRESHOLD_STOP, battery,
9616 &battery_info.batteries[battery].charge_stop)) {
9617 pr_err("Error probing battery stop: %d\n", battery);
9618 return -ENODEV;
9619 }
9620 }
9621 if (acpi_has_method(hkey_handle, GET_DISCHARGE)) {
9622 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_DISCHARGE, &ret, battery))) {
9623 pr_err("Error probing battery discharge; %d\n", battery);
9624 return -ENODEV;
9625 }
9626 /* Support is marked in bit 8 */
9627 if (ret & BIT(8))
9628 battery_info.batteries[battery].charge_behaviours |=
9629 BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE);
9630 }
9631 if (acpi_has_method(hkey_handle, GET_INHIBIT)) {
9632 if (ACPI_FAILURE(tpacpi_battery_acpi_eval(GET_INHIBIT, &ret, battery))) {
9633 pr_err("Error probing battery inhibit charge; %d\n", battery);
9634 return -ENODEV;
9635 }
9636 /* Support is marked in bit 5 */
9637 if (ret & BIT(5))
9638 battery_info.batteries[battery].charge_behaviours |=
9639 BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE);
9640 }
9641
9642 battery_info.batteries[battery].charge_behaviours |=
9643 BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO);
9644
9645 pr_info("battery %d registered (start %d, stop %d, behaviours: 0x%x)\n",
9646 battery,
9647 battery_info.batteries[battery].charge_start,
9648 battery_info.batteries[battery].charge_stop,
9649 battery_info.batteries[battery].charge_behaviours);
9650
9651 return 0;
9652}
9653
9654/* General helper functions */
9655
9656static int tpacpi_battery_get_id(const char *battery_name)
9657{
9658
9659 if (strcmp(battery_name, "BAT0") == 0 ||
9660 tp_features.battery_force_primary)
9661 return BAT_PRIMARY;
9662 if (strcmp(battery_name, "BAT1") == 0)
9663 return BAT_SECONDARY;
9664 /*
9665 * If for some reason the battery is not BAT0 nor is it
9666 * BAT1, we will assume it's the default, first battery,
9667 * AKA primary.
9668 */
9669 pr_warn("unknown battery %s, assuming primary", battery_name);
9670 return BAT_PRIMARY;
9671}
9672
9673/* sysfs interface */
9674
9675static ssize_t tpacpi_battery_store(int what,
9676 struct device *dev,
9677 const char *buf, size_t count)
9678{
9679 struct power_supply *supply = to_power_supply(dev);
9680 unsigned long value;
9681 int battery, rval;
9682 /*
9683 * Some systems have support for more than
9684 * one battery. If that is the case,
9685 * tpacpi_battery_probe marked that addressing
9686 * them individually is supported, so we do that
9687 * based on the device struct.
9688 *
9689 * On systems that are not supported, we assume
9690 * the primary as most of the ACPI calls fail
9691 * with "Any Battery" as the parameter.
9692 */
9693 if (battery_info.individual_addressing)
9694 /* BAT_PRIMARY or BAT_SECONDARY */
9695 battery = tpacpi_battery_get_id(supply->desc->name);
9696 else
9697 battery = BAT_PRIMARY;
9698
9699 rval = kstrtoul(buf, 10, &value);
9700 if (rval)
9701 return rval;
9702
9703 switch (what) {
9704 case THRESHOLD_START:
9705 if (!battery_info.batteries[battery].start_support)
9706 return -ENODEV;
9707 /* valid values are [0, 99] */
9708 if (value > 99)
9709 return -EINVAL;
9710 if (value > battery_info.batteries[battery].charge_stop)
9711 return -EINVAL;
9712 if (tpacpi_battery_set(THRESHOLD_START, battery, value))
9713 return -ENODEV;
9714 battery_info.batteries[battery].charge_start = value;
9715 return count;
9716
9717 case THRESHOLD_STOP:
9718 if (!battery_info.batteries[battery].stop_support)
9719 return -ENODEV;
9720 /* valid values are [1, 100] */
9721 if (value < 1 || value > 100)
9722 return -EINVAL;
9723 if (value < battery_info.batteries[battery].charge_start)
9724 return -EINVAL;
9725 battery_info.batteries[battery].charge_stop = value;
9726 /*
9727 * When 100 is passed to stop, we need to flip
9728 * it to 0 as that the EC understands that as
9729 * "Default", which will charge to 100%
9730 */
9731 if (value == 100)
9732 value = 0;
9733 if (tpacpi_battery_set(THRESHOLD_STOP, battery, value))
9734 return -EINVAL;
9735 return count;
9736 default:
9737 pr_crit("Wrong parameter: %d", what);
9738 return -EINVAL;
9739 }
9740 return count;
9741}
9742
9743static ssize_t tpacpi_battery_show(int what,
9744 struct device *dev,
9745 char *buf)
9746{
9747 struct power_supply *supply = to_power_supply(dev);
9748 int ret, battery;
9749 /*
9750 * Some systems have support for more than
9751 * one battery. If that is the case,
9752 * tpacpi_battery_probe marked that addressing
9753 * them individually is supported, so we;
9754 * based on the device struct.
9755 *
9756 * On systems that are not supported, we assume
9757 * the primary as most of the ACPI calls fail
9758 * with "Any Battery" as the parameter.
9759 */
9760 if (battery_info.individual_addressing)
9761 /* BAT_PRIMARY or BAT_SECONDARY */
9762 battery = tpacpi_battery_get_id(supply->desc->name);
9763 else
9764 battery = BAT_PRIMARY;
9765 if (tpacpi_battery_get(what, battery, &ret))
9766 return -ENODEV;
9767 return sprintf(buf, "%d\n", ret);
9768}
9769
9770static ssize_t charge_control_start_threshold_show(struct device *device,
9771 struct device_attribute *attr,
9772 char *buf)
9773{
9774 return tpacpi_battery_show(THRESHOLD_START, device, buf);
9775}
9776
9777static ssize_t charge_control_end_threshold_show(struct device *device,
9778 struct device_attribute *attr,
9779 char *buf)
9780{
9781 return tpacpi_battery_show(THRESHOLD_STOP, device, buf);
9782}
9783
9784static ssize_t charge_behaviour_show(struct device *dev,
9785 struct device_attribute *attr,
9786 char *buf)
9787{
9788 enum power_supply_charge_behaviour active = POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO;
9789 struct power_supply *supply = to_power_supply(dev);
9790 unsigned int available;
9791 int ret, battery;
9792
9793 battery = tpacpi_battery_get_id(supply->desc->name);
9794 available = battery_info.batteries[battery].charge_behaviours;
9795
9796 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE)) {
9797 if (tpacpi_battery_get(FORCE_DISCHARGE, battery, &ret))
9798 return -ENODEV;
9799 if (ret) {
9800 active = POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE;
9801 goto out;
9802 }
9803 }
9804
9805 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE)) {
9806 if (tpacpi_battery_get(INHIBIT_CHARGE, battery, &ret))
9807 return -ENODEV;
9808 if (ret) {
9809 active = POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE;
9810 goto out;
9811 }
9812 }
9813
9814out:
9815 return power_supply_charge_behaviour_show(dev, available, active, buf);
9816}
9817
9818static ssize_t charge_control_start_threshold_store(struct device *dev,
9819 struct device_attribute *attr,
9820 const char *buf, size_t count)
9821{
9822 return tpacpi_battery_store(THRESHOLD_START, dev, buf, count);
9823}
9824
9825static ssize_t charge_control_end_threshold_store(struct device *dev,
9826 struct device_attribute *attr,
9827 const char *buf, size_t count)
9828{
9829 return tpacpi_battery_store(THRESHOLD_STOP, dev, buf, count);
9830}
9831
9832static ssize_t charge_behaviour_store(struct device *dev,
9833 struct device_attribute *attr,
9834 const char *buf, size_t count)
9835{
9836 struct power_supply *supply = to_power_supply(dev);
9837 int selected, battery, ret = 0;
9838 unsigned int available;
9839
9840 battery = tpacpi_battery_get_id(supply->desc->name);
9841 available = battery_info.batteries[battery].charge_behaviours;
9842 selected = power_supply_charge_behaviour_parse(available, buf);
9843
9844 if (selected < 0)
9845 return selected;
9846
9847 switch (selected) {
9848 case POWER_SUPPLY_CHARGE_BEHAVIOUR_AUTO:
9849 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE))
9850 ret = tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 0);
9851 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE))
9852 ret = min(ret, tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 0));
9853 if (ret < 0)
9854 return ret;
9855 break;
9856 case POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE:
9857 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE))
9858 ret = tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 0);
9859 ret = min(ret, tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 1));
9860 if (ret < 0)
9861 return ret;
9862 break;
9863 case POWER_SUPPLY_CHARGE_BEHAVIOUR_INHIBIT_CHARGE:
9864 if (available & BIT(POWER_SUPPLY_CHARGE_BEHAVIOUR_FORCE_DISCHARGE))
9865 ret = tpacpi_battery_set_validate(FORCE_DISCHARGE, battery, 0);
9866 ret = min(ret, tpacpi_battery_set_validate(INHIBIT_CHARGE, battery, 1));
9867 if (ret < 0)
9868 return ret;
9869 break;
9870 default:
9871 dev_err(dev, "Unexpected charge behaviour: %d\n", selected);
9872 return -EINVAL;
9873 }
9874
9875 return count;
9876}
9877
9878static DEVICE_ATTR_RW(charge_control_start_threshold);
9879static DEVICE_ATTR_RW(charge_control_end_threshold);
9880static DEVICE_ATTR_RW(charge_behaviour);
9881static struct device_attribute dev_attr_charge_start_threshold = __ATTR(
9882 charge_start_threshold,
9883 0644,
9884 charge_control_start_threshold_show,
9885 charge_control_start_threshold_store
9886);
9887static struct device_attribute dev_attr_charge_stop_threshold = __ATTR(
9888 charge_stop_threshold,
9889 0644,
9890 charge_control_end_threshold_show,
9891 charge_control_end_threshold_store
9892);
9893
9894static struct attribute *tpacpi_battery_attrs[] = {
9895 &dev_attr_charge_control_start_threshold.attr,
9896 &dev_attr_charge_control_end_threshold.attr,
9897 &dev_attr_charge_start_threshold.attr,
9898 &dev_attr_charge_stop_threshold.attr,
9899 &dev_attr_charge_behaviour.attr,
9900 NULL,
9901};
9902
9903ATTRIBUTE_GROUPS(tpacpi_battery);
9904
9905/* ACPI battery hooking */
9906
9907static int tpacpi_battery_add(struct power_supply *battery, struct acpi_battery_hook *hook)
9908{
9909 int batteryid = tpacpi_battery_get_id(battery->desc->name);
9910
9911 if (tpacpi_battery_probe(batteryid))
9912 return -ENODEV;
9913 if (device_add_groups(&battery->dev, tpacpi_battery_groups))
9914 return -ENODEV;
9915 return 0;
9916}
9917
9918static int tpacpi_battery_remove(struct power_supply *battery, struct acpi_battery_hook *hook)
9919{
9920 device_remove_groups(&battery->dev, tpacpi_battery_groups);
9921 return 0;
9922}
9923
9924static struct acpi_battery_hook battery_hook = {
9925 .add_battery = tpacpi_battery_add,
9926 .remove_battery = tpacpi_battery_remove,
9927 .name = "ThinkPad Battery Extension",
9928};
9929
9930/* Subdriver init/exit */
9931
9932static const struct tpacpi_quirk battery_quirk_table[] __initconst = {
9933 /*
9934 * Individual addressing is broken on models that expose the
9935 * primary battery as BAT1.
9936 */
9937 TPACPI_Q_LNV('J', '7', true), /* B5400 */
9938 TPACPI_Q_LNV('J', 'I', true), /* Thinkpad 11e */
9939 TPACPI_Q_LNV3('R', '0', 'B', true), /* Thinkpad 11e gen 3 */
9940 TPACPI_Q_LNV3('R', '0', 'C', true), /* Thinkpad 13 */
9941 TPACPI_Q_LNV3('R', '0', 'J', true), /* Thinkpad 13 gen 2 */
9942 TPACPI_Q_LNV3('R', '0', 'K', true), /* Thinkpad 11e gen 4 celeron BIOS */
9943};
9944
9945static int __init tpacpi_battery_init(struct ibm_init_struct *ibm)
9946{
9947 memset(&battery_info, 0, sizeof(battery_info));
9948
9949 tp_features.battery_force_primary = tpacpi_check_quirks(
9950 battery_quirk_table,
9951 ARRAY_SIZE(battery_quirk_table));
9952
9953 battery_hook_register(&battery_hook);
9954 return 0;
9955}
9956
9957static void tpacpi_battery_exit(void)
9958{
9959 battery_hook_unregister(&battery_hook);
9960}
9961
9962static struct ibm_struct battery_driver_data = {
9963 .name = "battery",
9964 .exit = tpacpi_battery_exit,
9965};
9966
9967/*************************************************************************
9968 * LCD Shadow subdriver, for the Lenovo PrivacyGuard feature
9969 */
9970
9971static struct drm_privacy_screen *lcdshadow_dev;
9972static acpi_handle lcdshadow_get_handle;
9973static acpi_handle lcdshadow_set_handle;
9974
9975static int lcdshadow_set_sw_state(struct drm_privacy_screen *priv,
9976 enum drm_privacy_screen_status state)
9977{
9978 int output;
9979
9980 if (WARN_ON(!mutex_is_locked(&priv->lock)))
9981 return -EIO;
9982
9983 if (!acpi_evalf(lcdshadow_set_handle, &output, NULL, "dd", (int)state))
9984 return -EIO;
9985
9986 priv->hw_state = priv->sw_state = state;
9987 return 0;
9988}
9989
9990static void lcdshadow_get_hw_state(struct drm_privacy_screen *priv)
9991{
9992 int output;
9993
9994 if (!acpi_evalf(lcdshadow_get_handle, &output, NULL, "dd", 0))
9995 return;
9996
9997 priv->hw_state = priv->sw_state = output & 0x1;
9998}
9999
10000static const struct drm_privacy_screen_ops lcdshadow_ops = {
10001 .set_sw_state = lcdshadow_set_sw_state,
10002 .get_hw_state = lcdshadow_get_hw_state,
10003};
10004
10005static int tpacpi_lcdshadow_init(struct ibm_init_struct *iibm)
10006{
10007 acpi_status status1, status2;
10008 int output;
10009
10010 status1 = acpi_get_handle(hkey_handle, "GSSS", &lcdshadow_get_handle);
10011 status2 = acpi_get_handle(hkey_handle, "SSSS", &lcdshadow_set_handle);
10012 if (ACPI_FAILURE(status1) || ACPI_FAILURE(status2))
10013 return 0;
10014
10015 if (!acpi_evalf(lcdshadow_get_handle, &output, NULL, "dd", 0))
10016 return -EIO;
10017
10018 if (!(output & 0x10000))
10019 return 0;
10020
10021 lcdshadow_dev = drm_privacy_screen_register(&tpacpi_pdev->dev,
10022 &lcdshadow_ops, NULL);
10023 if (IS_ERR(lcdshadow_dev))
10024 return PTR_ERR(lcdshadow_dev);
10025
10026 return 0;
10027}
10028
10029static void lcdshadow_exit(void)
10030{
10031 drm_privacy_screen_unregister(lcdshadow_dev);
10032}
10033
10034static void lcdshadow_resume(void)
10035{
10036 if (!lcdshadow_dev)
10037 return;
10038
10039 mutex_lock(&lcdshadow_dev->lock);
10040 lcdshadow_set_sw_state(lcdshadow_dev, lcdshadow_dev->sw_state);
10041 mutex_unlock(&lcdshadow_dev->lock);
10042}
10043
10044static int lcdshadow_read(struct seq_file *m)
10045{
10046 if (!lcdshadow_dev) {
10047 seq_puts(m, "status:\t\tnot supported\n");
10048 } else {
10049 seq_printf(m, "status:\t\t%d\n", lcdshadow_dev->hw_state);
10050 seq_puts(m, "commands:\t0, 1\n");
10051 }
10052
10053 return 0;
10054}
10055
10056static int lcdshadow_write(char *buf)
10057{
10058 char *cmd;
10059 int res, state = -EINVAL;
10060
10061 if (!lcdshadow_dev)
10062 return -ENODEV;
10063
10064 while ((cmd = strsep(&buf, ","))) {
10065 res = kstrtoint(cmd, 10, &state);
10066 if (res < 0)
10067 return res;
10068 }
10069
10070 if (state >= 2 || state < 0)
10071 return -EINVAL;
10072
10073 mutex_lock(&lcdshadow_dev->lock);
10074 res = lcdshadow_set_sw_state(lcdshadow_dev, state);
10075 mutex_unlock(&lcdshadow_dev->lock);
10076
10077 drm_privacy_screen_call_notifier_chain(lcdshadow_dev);
10078
10079 return res;
10080}
10081
10082static struct ibm_struct lcdshadow_driver_data = {
10083 .name = "lcdshadow",
10084 .exit = lcdshadow_exit,
10085 .resume = lcdshadow_resume,
10086 .read = lcdshadow_read,
10087 .write = lcdshadow_write,
10088};
10089
10090/*************************************************************************
10091 * Thinkpad sensor interfaces
10092 */
10093
10094#define DYTC_CMD_QUERY 0 /* To get DYTC status - enable/revision */
10095#define DYTC_QUERY_ENABLE_BIT 8 /* Bit 8 - 0 = disabled, 1 = enabled */
10096#define DYTC_QUERY_SUBREV_BIT 16 /* Bits 16 - 27 - sub revision */
10097#define DYTC_QUERY_REV_BIT 28 /* Bits 28 - 31 - revision */
10098
10099#define DYTC_CMD_GET 2 /* To get current IC function and mode */
10100#define DYTC_GET_LAPMODE_BIT 17 /* Set when in lapmode */
10101
10102#define PALMSENSOR_PRESENT_BIT 0 /* Determine if psensor present */
10103#define PALMSENSOR_ON_BIT 1 /* psensor status */
10104
10105static bool has_palmsensor;
10106static bool has_lapsensor;
10107static bool palm_state;
10108static bool lap_state;
10109static int dytc_version;
10110
10111static int dytc_command(int command, int *output)
10112{
10113 acpi_handle dytc_handle;
10114
10115 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DYTC", &dytc_handle))) {
10116 /* Platform doesn't support DYTC */
10117 return -ENODEV;
10118 }
10119 if (!acpi_evalf(dytc_handle, output, NULL, "dd", command))
10120 return -EIO;
10121 return 0;
10122}
10123
10124static int lapsensor_get(bool *present, bool *state)
10125{
10126 int output, err;
10127
10128 *present = false;
10129 err = dytc_command(DYTC_CMD_GET, &output);
10130 if (err)
10131 return err;
10132
10133 *present = true; /*If we get his far, we have lapmode support*/
10134 *state = output & BIT(DYTC_GET_LAPMODE_BIT) ? true : false;
10135 return 0;
10136}
10137
10138static int palmsensor_get(bool *present, bool *state)
10139{
10140 acpi_handle psensor_handle;
10141 int output;
10142
10143 *present = false;
10144 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GPSS", &psensor_handle)))
10145 return -ENODEV;
10146 if (!acpi_evalf(psensor_handle, &output, NULL, "d"))
10147 return -EIO;
10148
10149 *present = output & BIT(PALMSENSOR_PRESENT_BIT) ? true : false;
10150 *state = output & BIT(PALMSENSOR_ON_BIT) ? true : false;
10151 return 0;
10152}
10153
10154static void lapsensor_refresh(void)
10155{
10156 bool state;
10157 int err;
10158
10159 if (has_lapsensor) {
10160 err = lapsensor_get(&has_lapsensor, &state);
10161 if (err)
10162 return;
10163 if (lap_state != state) {
10164 lap_state = state;
10165 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "dytc_lapmode");
10166 }
10167 }
10168}
10169
10170static void palmsensor_refresh(void)
10171{
10172 bool state;
10173 int err;
10174
10175 if (has_palmsensor) {
10176 err = palmsensor_get(&has_palmsensor, &state);
10177 if (err)
10178 return;
10179 if (palm_state != state) {
10180 palm_state = state;
10181 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "palmsensor");
10182 }
10183 }
10184}
10185
10186static ssize_t dytc_lapmode_show(struct device *dev,
10187 struct device_attribute *attr,
10188 char *buf)
10189{
10190 if (has_lapsensor)
10191 return sysfs_emit(buf, "%d\n", lap_state);
10192 return sysfs_emit(buf, "\n");
10193}
10194static DEVICE_ATTR_RO(dytc_lapmode);
10195
10196static ssize_t palmsensor_show(struct device *dev,
10197 struct device_attribute *attr,
10198 char *buf)
10199{
10200 if (has_palmsensor)
10201 return sysfs_emit(buf, "%d\n", palm_state);
10202 return sysfs_emit(buf, "\n");
10203}
10204static DEVICE_ATTR_RO(palmsensor);
10205
10206static struct attribute *proxsensor_attributes[] = {
10207 &dev_attr_dytc_lapmode.attr,
10208 &dev_attr_palmsensor.attr,
10209 NULL
10210};
10211
10212static umode_t proxsensor_attr_is_visible(struct kobject *kobj,
10213 struct attribute *attr, int n)
10214{
10215 if (attr == &dev_attr_dytc_lapmode.attr) {
10216 /*
10217 * Platforms before DYTC version 5 claim to have a lap sensor,
10218 * but it doesn't work, so we ignore them.
10219 */
10220 if (!has_lapsensor || dytc_version < 5)
10221 return 0;
10222 } else if (attr == &dev_attr_palmsensor.attr) {
10223 if (!has_palmsensor)
10224 return 0;
10225 }
10226
10227 return attr->mode;
10228}
10229
10230static const struct attribute_group proxsensor_attr_group = {
10231 .is_visible = proxsensor_attr_is_visible,
10232 .attrs = proxsensor_attributes,
10233};
10234
10235static int tpacpi_proxsensor_init(struct ibm_init_struct *iibm)
10236{
10237 int palm_err, lap_err;
10238
10239 palm_err = palmsensor_get(&has_palmsensor, &palm_state);
10240 lap_err = lapsensor_get(&has_lapsensor, &lap_state);
10241 /* If support isn't available for both devices return -ENODEV */
10242 if ((palm_err == -ENODEV) && (lap_err == -ENODEV))
10243 return -ENODEV;
10244 /* Otherwise, if there was an error return it */
10245 if (palm_err && (palm_err != -ENODEV))
10246 return palm_err;
10247 if (lap_err && (lap_err != -ENODEV))
10248 return lap_err;
10249
10250 return 0;
10251}
10252
10253static struct ibm_struct proxsensor_driver_data = {
10254 .name = "proximity-sensor",
10255};
10256
10257/*************************************************************************
10258 * DYTC Platform Profile interface
10259 */
10260
10261#define DYTC_CMD_SET 1 /* To enable/disable IC function mode */
10262#define DYTC_CMD_MMC_GET 8 /* To get current MMC function and mode */
10263#define DYTC_CMD_RESET 0x1ff /* To reset back to default */
10264
10265#define DYTC_CMD_FUNC_CAP 3 /* To get DYTC capabilities */
10266#define DYTC_FC_MMC 27 /* MMC Mode supported */
10267#define DYTC_FC_PSC 29 /* PSC Mode supported */
10268#define DYTC_FC_AMT 31 /* AMT mode supported */
10269
10270#define DYTC_GET_FUNCTION_BIT 8 /* Bits 8-11 - function setting */
10271#define DYTC_GET_MODE_BIT 12 /* Bits 12-15 - mode setting */
10272
10273#define DYTC_SET_FUNCTION_BIT 12 /* Bits 12-15 - function setting */
10274#define DYTC_SET_MODE_BIT 16 /* Bits 16-19 - mode setting */
10275#define DYTC_SET_VALID_BIT 20 /* Bit 20 - 1 = on, 0 = off */
10276
10277#define DYTC_FUNCTION_STD 0 /* Function = 0, standard mode */
10278#define DYTC_FUNCTION_CQL 1 /* Function = 1, lap mode */
10279#define DYTC_FUNCTION_MMC 11 /* Function = 11, MMC mode */
10280#define DYTC_FUNCTION_PSC 13 /* Function = 13, PSC mode */
10281#define DYTC_FUNCTION_AMT 15 /* Function = 15, AMT mode */
10282
10283#define DYTC_MODE_AMT_ENABLE 0x1 /* Enable AMT (in balanced mode) */
10284#define DYTC_MODE_AMT_DISABLE 0xF /* Disable AMT (in other modes) */
10285
10286#define DYTC_MODE_MMC_PERFORM 2 /* High power mode aka performance */
10287#define DYTC_MODE_MMC_LOWPOWER 3 /* Low power mode */
10288#define DYTC_MODE_MMC_BALANCE 0xF /* Default mode aka balanced */
10289#define DYTC_MODE_MMC_DEFAULT 0 /* Default mode from MMC_GET, aka balanced */
10290
10291#define DYTC_MODE_PSC_LOWPOWER 3 /* Low power mode */
10292#define DYTC_MODE_PSC_BALANCE 5 /* Default mode aka balanced */
10293#define DYTC_MODE_PSC_PERFORM 7 /* High power mode aka performance */
10294
10295#define DYTC_ERR_MASK 0xF /* Bits 0-3 in cmd result are the error result */
10296#define DYTC_ERR_SUCCESS 1 /* CMD completed successful */
10297
10298#define DYTC_SET_COMMAND(function, mode, on) \
10299 (DYTC_CMD_SET | (function) << DYTC_SET_FUNCTION_BIT | \
10300 (mode) << DYTC_SET_MODE_BIT | \
10301 (on) << DYTC_SET_VALID_BIT)
10302
10303#define DYTC_DISABLE_CQL DYTC_SET_COMMAND(DYTC_FUNCTION_CQL, DYTC_MODE_MMC_BALANCE, 0)
10304#define DYTC_ENABLE_CQL DYTC_SET_COMMAND(DYTC_FUNCTION_CQL, DYTC_MODE_MMC_BALANCE, 1)
10305static int dytc_control_amt(bool enable);
10306static bool dytc_amt_active;
10307
10308static enum platform_profile_option dytc_current_profile;
10309static atomic_t dytc_ignore_event = ATOMIC_INIT(0);
10310static DEFINE_MUTEX(dytc_mutex);
10311static int dytc_capabilities;
10312static bool dytc_mmc_get_available;
10313
10314static int convert_dytc_to_profile(int funcmode, int dytcmode,
10315 enum platform_profile_option *profile)
10316{
10317 switch (funcmode) {
10318 case DYTC_FUNCTION_MMC:
10319 switch (dytcmode) {
10320 case DYTC_MODE_MMC_LOWPOWER:
10321 *profile = PLATFORM_PROFILE_LOW_POWER;
10322 break;
10323 case DYTC_MODE_MMC_DEFAULT:
10324 case DYTC_MODE_MMC_BALANCE:
10325 *profile = PLATFORM_PROFILE_BALANCED;
10326 break;
10327 case DYTC_MODE_MMC_PERFORM:
10328 *profile = PLATFORM_PROFILE_PERFORMANCE;
10329 break;
10330 default: /* Unknown mode */
10331 return -EINVAL;
10332 }
10333 return 0;
10334 case DYTC_FUNCTION_PSC:
10335 switch (dytcmode) {
10336 case DYTC_MODE_PSC_LOWPOWER:
10337 *profile = PLATFORM_PROFILE_LOW_POWER;
10338 break;
10339 case DYTC_MODE_PSC_BALANCE:
10340 *profile = PLATFORM_PROFILE_BALANCED;
10341 break;
10342 case DYTC_MODE_PSC_PERFORM:
10343 *profile = PLATFORM_PROFILE_PERFORMANCE;
10344 break;
10345 default: /* Unknown mode */
10346 return -EINVAL;
10347 }
10348 return 0;
10349 case DYTC_FUNCTION_AMT:
10350 /* For now return balanced. It's the closest we have to 'auto' */
10351 *profile = PLATFORM_PROFILE_BALANCED;
10352 return 0;
10353 default:
10354 /* Unknown function */
10355 return -EOPNOTSUPP;
10356 }
10357 return 0;
10358}
10359
10360static int convert_profile_to_dytc(enum platform_profile_option profile, int *perfmode)
10361{
10362 switch (profile) {
10363 case PLATFORM_PROFILE_LOW_POWER:
10364 if (dytc_capabilities & BIT(DYTC_FC_MMC))
10365 *perfmode = DYTC_MODE_MMC_LOWPOWER;
10366 else if (dytc_capabilities & BIT(DYTC_FC_PSC))
10367 *perfmode = DYTC_MODE_PSC_LOWPOWER;
10368 break;
10369 case PLATFORM_PROFILE_BALANCED:
10370 if (dytc_capabilities & BIT(DYTC_FC_MMC))
10371 *perfmode = DYTC_MODE_MMC_BALANCE;
10372 else if (dytc_capabilities & BIT(DYTC_FC_PSC))
10373 *perfmode = DYTC_MODE_PSC_BALANCE;
10374 break;
10375 case PLATFORM_PROFILE_PERFORMANCE:
10376 if (dytc_capabilities & BIT(DYTC_FC_MMC))
10377 *perfmode = DYTC_MODE_MMC_PERFORM;
10378 else if (dytc_capabilities & BIT(DYTC_FC_PSC))
10379 *perfmode = DYTC_MODE_PSC_PERFORM;
10380 break;
10381 default: /* Unknown profile */
10382 return -EOPNOTSUPP;
10383 }
10384 return 0;
10385}
10386
10387/*
10388 * dytc_profile_get: Function to register with platform_profile
10389 * handler. Returns current platform profile.
10390 */
10391static int dytc_profile_get(struct platform_profile_handler *pprof,
10392 enum platform_profile_option *profile)
10393{
10394 *profile = dytc_current_profile;
10395 return 0;
10396}
10397
10398static int dytc_control_amt(bool enable)
10399{
10400 int dummy;
10401 int err;
10402 int cmd;
10403
10404 if (!(dytc_capabilities & BIT(DYTC_FC_AMT))) {
10405 pr_warn("Attempting to toggle AMT on a system that doesn't advertise support\n");
10406 return -ENODEV;
10407 }
10408
10409 if (enable)
10410 cmd = DYTC_SET_COMMAND(DYTC_FUNCTION_AMT, DYTC_MODE_AMT_ENABLE, enable);
10411 else
10412 cmd = DYTC_SET_COMMAND(DYTC_FUNCTION_AMT, DYTC_MODE_AMT_DISABLE, enable);
10413
10414 pr_debug("%sabling AMT (cmd 0x%x)", enable ? "en":"dis", cmd);
10415 err = dytc_command(cmd, &dummy);
10416 if (err)
10417 return err;
10418 dytc_amt_active = enable;
10419 return 0;
10420}
10421
10422/*
10423 * Helper function - check if we are in CQL mode and if we are
10424 * - disable CQL,
10425 * - run the command
10426 * - enable CQL
10427 * If not in CQL mode, just run the command
10428 */
10429static int dytc_cql_command(int command, int *output)
10430{
10431 int err, cmd_err, dummy;
10432 int cur_funcmode;
10433
10434 /* Determine if we are in CQL mode. This alters the commands we do */
10435 err = dytc_command(DYTC_CMD_GET, output);
10436 if (err)
10437 return err;
10438
10439 cur_funcmode = (*output >> DYTC_GET_FUNCTION_BIT) & 0xF;
10440 /* Check if we're OK to return immediately */
10441 if ((command == DYTC_CMD_GET) && (cur_funcmode != DYTC_FUNCTION_CQL))
10442 return 0;
10443
10444 if (cur_funcmode == DYTC_FUNCTION_CQL) {
10445 atomic_inc(&dytc_ignore_event);
10446 err = dytc_command(DYTC_DISABLE_CQL, &dummy);
10447 if (err)
10448 return err;
10449 }
10450
10451 cmd_err = dytc_command(command, output);
10452 /* Check return condition after we've restored CQL state */
10453
10454 if (cur_funcmode == DYTC_FUNCTION_CQL) {
10455 err = dytc_command(DYTC_ENABLE_CQL, &dummy);
10456 if (err)
10457 return err;
10458 }
10459 return cmd_err;
10460}
10461
10462/*
10463 * dytc_profile_set: Function to register with platform_profile
10464 * handler. Sets current platform profile.
10465 */
10466static int dytc_profile_set(struct platform_profile_handler *pprof,
10467 enum platform_profile_option profile)
10468{
10469 int perfmode;
10470 int output;
10471 int err;
10472
10473 err = mutex_lock_interruptible(&dytc_mutex);
10474 if (err)
10475 return err;
10476
10477 err = convert_profile_to_dytc(profile, &perfmode);
10478 if (err)
10479 goto unlock;
10480
10481 if (dytc_capabilities & BIT(DYTC_FC_MMC)) {
10482 if (profile == PLATFORM_PROFILE_BALANCED) {
10483 /*
10484 * To get back to balanced mode we need to issue a reset command.
10485 * Note we still need to disable CQL mode before hand and re-enable
10486 * it afterwards, otherwise dytc_lapmode gets reset to 0 and stays
10487 * stuck at 0 for aprox. 30 minutes.
10488 */
10489 err = dytc_cql_command(DYTC_CMD_RESET, &output);
10490 if (err)
10491 goto unlock;
10492 } else {
10493 /* Determine if we are in CQL mode. This alters the commands we do */
10494 err = dytc_cql_command(DYTC_SET_COMMAND(DYTC_FUNCTION_MMC, perfmode, 1),
10495 &output);
10496 if (err)
10497 goto unlock;
10498 }
10499 } else if (dytc_capabilities & BIT(DYTC_FC_PSC)) {
10500 err = dytc_command(DYTC_SET_COMMAND(DYTC_FUNCTION_PSC, perfmode, 1), &output);
10501 if (err)
10502 goto unlock;
10503
10504 /* system supports AMT, activate it when on balanced */
10505 if (dytc_capabilities & BIT(DYTC_FC_AMT))
10506 dytc_control_amt(profile == PLATFORM_PROFILE_BALANCED);
10507 }
10508 /* Success - update current profile */
10509 dytc_current_profile = profile;
10510unlock:
10511 mutex_unlock(&dytc_mutex);
10512 return err;
10513}
10514
10515static void dytc_profile_refresh(void)
10516{
10517 enum platform_profile_option profile;
10518 int output, err = 0;
10519 int perfmode, funcmode;
10520
10521 mutex_lock(&dytc_mutex);
10522 if (dytc_capabilities & BIT(DYTC_FC_MMC)) {
10523 if (dytc_mmc_get_available)
10524 err = dytc_command(DYTC_CMD_MMC_GET, &output);
10525 else
10526 err = dytc_cql_command(DYTC_CMD_GET, &output);
10527 funcmode = DYTC_FUNCTION_MMC;
10528 } else if (dytc_capabilities & BIT(DYTC_FC_PSC)) {
10529 err = dytc_command(DYTC_CMD_GET, &output);
10530 /* Check if we are PSC mode, or have AMT enabled */
10531 funcmode = (output >> DYTC_GET_FUNCTION_BIT) & 0xF;
10532 }
10533 mutex_unlock(&dytc_mutex);
10534 if (err)
10535 return;
10536
10537 perfmode = (output >> DYTC_GET_MODE_BIT) & 0xF;
10538 convert_dytc_to_profile(funcmode, perfmode, &profile);
10539 if (profile != dytc_current_profile) {
10540 dytc_current_profile = profile;
10541 platform_profile_notify();
10542 }
10543}
10544
10545static struct platform_profile_handler dytc_profile = {
10546 .profile_get = dytc_profile_get,
10547 .profile_set = dytc_profile_set,
10548};
10549
10550static int tpacpi_dytc_profile_init(struct ibm_init_struct *iibm)
10551{
10552 int err, output;
10553
10554 /* Setup supported modes */
10555 set_bit(PLATFORM_PROFILE_LOW_POWER, dytc_profile.choices);
10556 set_bit(PLATFORM_PROFILE_BALANCED, dytc_profile.choices);
10557 set_bit(PLATFORM_PROFILE_PERFORMANCE, dytc_profile.choices);
10558
10559 err = dytc_command(DYTC_CMD_QUERY, &output);
10560 if (err)
10561 return err;
10562
10563 if (output & BIT(DYTC_QUERY_ENABLE_BIT))
10564 dytc_version = (output >> DYTC_QUERY_REV_BIT) & 0xF;
10565
10566 /* Check DYTC is enabled and supports mode setting */
10567 if (dytc_version < 5)
10568 return -ENODEV;
10569
10570 /* Check what capabilities are supported */
10571 err = dytc_command(DYTC_CMD_FUNC_CAP, &dytc_capabilities);
10572 if (err)
10573 return err;
10574
10575 if (dytc_capabilities & BIT(DYTC_FC_MMC)) { /* MMC MODE */
10576 pr_debug("MMC is supported\n");
10577 /*
10578 * Check if MMC_GET functionality available
10579 * Version > 6 and return success from MMC_GET command
10580 */
10581 dytc_mmc_get_available = false;
10582 if (dytc_version >= 6) {
10583 err = dytc_command(DYTC_CMD_MMC_GET, &output);
10584 if (!err && ((output & DYTC_ERR_MASK) == DYTC_ERR_SUCCESS))
10585 dytc_mmc_get_available = true;
10586 }
10587 } else if (dytc_capabilities & BIT(DYTC_FC_PSC)) { /* PSC MODE */
10588 /* Support for this only works on AMD platforms */
10589 if (boot_cpu_data.x86_vendor != X86_VENDOR_AMD) {
10590 dbg_printk(TPACPI_DBG_INIT, "PSC not support on Intel platforms\n");
10591 return -ENODEV;
10592 }
10593 pr_debug("PSC is supported\n");
10594 } else {
10595 dbg_printk(TPACPI_DBG_INIT, "No DYTC support available\n");
10596 return -ENODEV;
10597 }
10598
10599 dbg_printk(TPACPI_DBG_INIT,
10600 "DYTC version %d: thermal mode available\n", dytc_version);
10601
10602 /* Create platform_profile structure and register */
10603 err = platform_profile_register(&dytc_profile);
10604 /*
10605 * If for some reason platform_profiles aren't enabled
10606 * don't quit terminally.
10607 */
10608 if (err)
10609 return -ENODEV;
10610
10611 /* Ensure initial values are correct */
10612 dytc_profile_refresh();
10613
10614 /* Workaround for https://bugzilla.kernel.org/show_bug.cgi?id=216347 */
10615 if (dytc_capabilities & BIT(DYTC_FC_PSC))
10616 dytc_profile_set(NULL, PLATFORM_PROFILE_BALANCED);
10617
10618 return 0;
10619}
10620
10621static void dytc_profile_exit(void)
10622{
10623 platform_profile_remove();
10624}
10625
10626static struct ibm_struct dytc_profile_driver_data = {
10627 .name = "dytc-profile",
10628 .exit = dytc_profile_exit,
10629};
10630
10631/*************************************************************************
10632 * Keyboard language interface
10633 */
10634
10635struct keyboard_lang_data {
10636 const char *lang_str;
10637 int lang_code;
10638};
10639
10640static const struct keyboard_lang_data keyboard_lang_data[] = {
10641 {"be", 0x080c},
10642 {"cz", 0x0405},
10643 {"da", 0x0406},
10644 {"de", 0x0c07},
10645 {"en", 0x0000},
10646 {"es", 0x2c0a},
10647 {"et", 0x0425},
10648 {"fr", 0x040c},
10649 {"fr-ch", 0x100c},
10650 {"hu", 0x040e},
10651 {"it", 0x0410},
10652 {"jp", 0x0411},
10653 {"nl", 0x0413},
10654 {"nn", 0x0414},
10655 {"pl", 0x0415},
10656 {"pt", 0x0816},
10657 {"sl", 0x041b},
10658 {"sv", 0x081d},
10659 {"tr", 0x041f},
10660};
10661
10662static int set_keyboard_lang_command(int command)
10663{
10664 acpi_handle sskl_handle;
10665 int output;
10666
10667 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "SSKL", &sskl_handle))) {
10668 /* Platform doesn't support SSKL */
10669 return -ENODEV;
10670 }
10671
10672 if (!acpi_evalf(sskl_handle, &output, NULL, "dd", command))
10673 return -EIO;
10674
10675 return 0;
10676}
10677
10678static int get_keyboard_lang(int *output)
10679{
10680 acpi_handle gskl_handle;
10681 int kbd_lang;
10682
10683 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "GSKL", &gskl_handle))) {
10684 /* Platform doesn't support GSKL */
10685 return -ENODEV;
10686 }
10687
10688 if (!acpi_evalf(gskl_handle, &kbd_lang, NULL, "dd", 0x02000000))
10689 return -EIO;
10690
10691 /*
10692 * METHOD_ERR gets returned on devices where there are no special (e.g. '=',
10693 * '(' and ')') keys which use layout dependent key-press emulation.
10694 */
10695 if (kbd_lang & METHOD_ERR)
10696 return -ENODEV;
10697
10698 *output = kbd_lang;
10699
10700 return 0;
10701}
10702
10703/* sysfs keyboard language entry */
10704static ssize_t keyboard_lang_show(struct device *dev,
10705 struct device_attribute *attr,
10706 char *buf)
10707{
10708 int output, err, i, len = 0;
10709
10710 err = get_keyboard_lang(&output);
10711 if (err)
10712 return err;
10713
10714 for (i = 0; i < ARRAY_SIZE(keyboard_lang_data); i++) {
10715 if (i)
10716 len += sysfs_emit_at(buf, len, "%s", " ");
10717
10718 if (output == keyboard_lang_data[i].lang_code) {
10719 len += sysfs_emit_at(buf, len, "[%s]", keyboard_lang_data[i].lang_str);
10720 } else {
10721 len += sysfs_emit_at(buf, len, "%s", keyboard_lang_data[i].lang_str);
10722 }
10723 }
10724 len += sysfs_emit_at(buf, len, "\n");
10725
10726 return len;
10727}
10728
10729static ssize_t keyboard_lang_store(struct device *dev,
10730 struct device_attribute *attr,
10731 const char *buf, size_t count)
10732{
10733 int err, i;
10734 bool lang_found = false;
10735 int lang_code = 0;
10736
10737 for (i = 0; i < ARRAY_SIZE(keyboard_lang_data); i++) {
10738 if (sysfs_streq(buf, keyboard_lang_data[i].lang_str)) {
10739 lang_code = keyboard_lang_data[i].lang_code;
10740 lang_found = true;
10741 break;
10742 }
10743 }
10744
10745 if (lang_found) {
10746 lang_code = lang_code | 1 << 24;
10747
10748 /* Set language code */
10749 err = set_keyboard_lang_command(lang_code);
10750 if (err)
10751 return err;
10752 } else {
10753 dev_err(&tpacpi_pdev->dev, "Unknown Keyboard language. Ignoring\n");
10754 return -EINVAL;
10755 }
10756
10757 tpacpi_disclose_usertask(attr->attr.name,
10758 "keyboard language is set to %s\n", buf);
10759
10760 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL, "keyboard_lang");
10761
10762 return count;
10763}
10764static DEVICE_ATTR_RW(keyboard_lang);
10765
10766static struct attribute *kbdlang_attributes[] = {
10767 &dev_attr_keyboard_lang.attr,
10768 NULL
10769};
10770
10771static umode_t kbdlang_attr_is_visible(struct kobject *kobj,
10772 struct attribute *attr, int n)
10773{
10774 return tp_features.kbd_lang ? attr->mode : 0;
10775}
10776
10777static const struct attribute_group kbdlang_attr_group = {
10778 .is_visible = kbdlang_attr_is_visible,
10779 .attrs = kbdlang_attributes,
10780};
10781
10782static int tpacpi_kbdlang_init(struct ibm_init_struct *iibm)
10783{
10784 int err, output;
10785
10786 err = get_keyboard_lang(&output);
10787 tp_features.kbd_lang = !err;
10788 return err;
10789}
10790
10791static struct ibm_struct kbdlang_driver_data = {
10792 .name = "kbdlang",
10793};
10794
10795/*************************************************************************
10796 * DPRC(Dynamic Power Reduction Control) subdriver, for the Lenovo WWAN
10797 * and WLAN feature.
10798 */
10799#define DPRC_GET_WWAN_ANTENNA_TYPE 0x40000
10800#define DPRC_WWAN_ANTENNA_TYPE_A_BIT BIT(4)
10801#define DPRC_WWAN_ANTENNA_TYPE_B_BIT BIT(8)
10802static bool has_antennatype;
10803static int wwan_antennatype;
10804
10805static int dprc_command(int command, int *output)
10806{
10807 acpi_handle dprc_handle;
10808
10809 if (ACPI_FAILURE(acpi_get_handle(hkey_handle, "DPRC", &dprc_handle))) {
10810 /* Platform doesn't support DPRC */
10811 return -ENODEV;
10812 }
10813
10814 if (!acpi_evalf(dprc_handle, output, NULL, "dd", command))
10815 return -EIO;
10816
10817 /*
10818 * METHOD_ERR gets returned on devices where few commands are not supported
10819 * for example command to get WWAN Antenna type command is not supported on
10820 * some devices.
10821 */
10822 if (*output & METHOD_ERR)
10823 return -ENODEV;
10824
10825 return 0;
10826}
10827
10828static int get_wwan_antenna(int *wwan_antennatype)
10829{
10830 int output, err;
10831
10832 /* Get current Antenna type */
10833 err = dprc_command(DPRC_GET_WWAN_ANTENNA_TYPE, &output);
10834 if (err)
10835 return err;
10836
10837 if (output & DPRC_WWAN_ANTENNA_TYPE_A_BIT)
10838 *wwan_antennatype = 1;
10839 else if (output & DPRC_WWAN_ANTENNA_TYPE_B_BIT)
10840 *wwan_antennatype = 2;
10841 else
10842 return -ENODEV;
10843
10844 return 0;
10845}
10846
10847/* sysfs wwan antenna type entry */
10848static ssize_t wwan_antenna_type_show(struct device *dev,
10849 struct device_attribute *attr,
10850 char *buf)
10851{
10852 switch (wwan_antennatype) {
10853 case 1:
10854 return sysfs_emit(buf, "type a\n");
10855 case 2:
10856 return sysfs_emit(buf, "type b\n");
10857 default:
10858 return -ENODATA;
10859 }
10860}
10861static DEVICE_ATTR_RO(wwan_antenna_type);
10862
10863static struct attribute *dprc_attributes[] = {
10864 &dev_attr_wwan_antenna_type.attr,
10865 NULL
10866};
10867
10868static umode_t dprc_attr_is_visible(struct kobject *kobj,
10869 struct attribute *attr, int n)
10870{
10871 return has_antennatype ? attr->mode : 0;
10872}
10873
10874static const struct attribute_group dprc_attr_group = {
10875 .is_visible = dprc_attr_is_visible,
10876 .attrs = dprc_attributes,
10877};
10878
10879static int tpacpi_dprc_init(struct ibm_init_struct *iibm)
10880{
10881 int err;
10882
10883 err = get_wwan_antenna(&wwan_antennatype);
10884 if (err)
10885 return err;
10886
10887 has_antennatype = true;
10888 return 0;
10889}
10890
10891static struct ibm_struct dprc_driver_data = {
10892 .name = "dprc",
10893};
10894
10895/* --------------------------------------------------------------------- */
10896
10897static struct attribute *tpacpi_driver_attributes[] = {
10898 &driver_attr_debug_level.attr,
10899 &driver_attr_version.attr,
10900 &driver_attr_interface_version.attr,
10901#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10902 &driver_attr_wlsw_emulstate.attr,
10903 &driver_attr_bluetooth_emulstate.attr,
10904 &driver_attr_wwan_emulstate.attr,
10905 &driver_attr_uwb_emulstate.attr,
10906#endif
10907 NULL
10908};
10909
10910#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10911static umode_t tpacpi_attr_is_visible(struct kobject *kobj,
10912 struct attribute *attr, int n)
10913{
10914 if (attr == &driver_attr_wlsw_emulstate.attr) {
10915 if (!dbg_wlswemul)
10916 return 0;
10917 } else if (attr == &driver_attr_bluetooth_emulstate.attr) {
10918 if (!dbg_bluetoothemul)
10919 return 0;
10920 } else if (attr == &driver_attr_wwan_emulstate.attr) {
10921 if (!dbg_wwanemul)
10922 return 0;
10923 } else if (attr == &driver_attr_uwb_emulstate.attr) {
10924 if (!dbg_uwbemul)
10925 return 0;
10926 }
10927
10928 return attr->mode;
10929}
10930#endif
10931
10932static const struct attribute_group tpacpi_driver_attr_group = {
10933#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
10934 .is_visible = tpacpi_attr_is_visible,
10935#endif
10936 .attrs = tpacpi_driver_attributes,
10937};
10938
10939static const struct attribute_group *tpacpi_driver_groups[] = {
10940 &tpacpi_driver_attr_group,
10941 NULL,
10942};
10943
10944static const struct attribute_group *tpacpi_groups[] = {
10945 &adaptive_kbd_attr_group,
10946 &hotkey_attr_group,
10947 &bluetooth_attr_group,
10948 &wan_attr_group,
10949 &cmos_attr_group,
10950 &proxsensor_attr_group,
10951 &kbdlang_attr_group,
10952 &dprc_attr_group,
10953 NULL,
10954};
10955
10956static const struct attribute_group *tpacpi_hwmon_groups[] = {
10957 &thermal_attr_group,
10958 &temp_label_attr_group,
10959 &fan_attr_group,
10960 NULL,
10961};
10962
10963static const struct attribute_group *tpacpi_hwmon_driver_groups[] = {
10964 &fan_driver_attr_group,
10965 NULL,
10966};
10967
10968/****************************************************************************
10969 ****************************************************************************
10970 *
10971 * Platform drivers
10972 *
10973 ****************************************************************************
10974 ****************************************************************************/
10975
10976static struct platform_driver tpacpi_pdriver = {
10977 .driver = {
10978 .name = TPACPI_DRVR_NAME,
10979 .pm = &tpacpi_pm,
10980 .groups = tpacpi_driver_groups,
10981 .dev_groups = tpacpi_groups,
10982 },
10983 .shutdown = tpacpi_shutdown_handler,
10984};
10985
10986static struct platform_driver tpacpi_hwmon_pdriver = {
10987 .driver = {
10988 .name = TPACPI_HWMON_DRVR_NAME,
10989 .groups = tpacpi_hwmon_driver_groups,
10990 },
10991};
10992
10993/****************************************************************************
10994 ****************************************************************************
10995 *
10996 * Infrastructure
10997 *
10998 ****************************************************************************
10999 ****************************************************************************/
11000
11001/*
11002 * HKEY event callout for other subdrivers go here
11003 * (yes, it is ugly, but it is quick, safe, and gets the job done
11004 */
11005static void tpacpi_driver_event(const unsigned int hkey_event)
11006{
11007 if (ibm_backlight_device) {
11008 switch (hkey_event) {
11009 case TP_HKEY_EV_BRGHT_UP:
11010 case TP_HKEY_EV_BRGHT_DOWN:
11011 tpacpi_brightness_notify_change();
11012 }
11013 }
11014 if (alsa_card) {
11015 switch (hkey_event) {
11016 case TP_HKEY_EV_VOL_UP:
11017 case TP_HKEY_EV_VOL_DOWN:
11018 case TP_HKEY_EV_VOL_MUTE:
11019 volume_alsa_notify_change();
11020 }
11021 }
11022 if (tp_features.kbdlight && hkey_event == TP_HKEY_EV_KBD_LIGHT) {
11023 enum led_brightness brightness;
11024
11025 mutex_lock(&kbdlight_mutex);
11026
11027 /*
11028 * Check the brightness actually changed, setting the brightness
11029 * through kbdlight_set_level() also triggers this event.
11030 */
11031 brightness = kbdlight_sysfs_get(NULL);
11032 if (kbdlight_brightness != brightness) {
11033 kbdlight_brightness = brightness;
11034 led_classdev_notify_brightness_hw_changed(
11035 &tpacpi_led_kbdlight.led_classdev, brightness);
11036 }
11037
11038 mutex_unlock(&kbdlight_mutex);
11039 }
11040
11041 if (hkey_event == TP_HKEY_EV_THM_CSM_COMPLETED) {
11042 lapsensor_refresh();
11043 /* If we are already accessing DYTC then skip dytc update */
11044 if (!atomic_add_unless(&dytc_ignore_event, -1, 0))
11045 dytc_profile_refresh();
11046 }
11047
11048 if (lcdshadow_dev && hkey_event == TP_HKEY_EV_PRIVACYGUARD_TOGGLE) {
11049 enum drm_privacy_screen_status old_hw_state;
11050 bool changed;
11051
11052 mutex_lock(&lcdshadow_dev->lock);
11053 old_hw_state = lcdshadow_dev->hw_state;
11054 lcdshadow_get_hw_state(lcdshadow_dev);
11055 changed = lcdshadow_dev->hw_state != old_hw_state;
11056 mutex_unlock(&lcdshadow_dev->lock);
11057
11058 if (changed)
11059 drm_privacy_screen_call_notifier_chain(lcdshadow_dev);
11060 }
11061 if (hkey_event == TP_HKEY_EV_AMT_TOGGLE) {
11062 /* If we're enabling AMT we need to force balanced mode */
11063 if (!dytc_amt_active)
11064 /* This will also set AMT mode enabled */
11065 dytc_profile_set(NULL, PLATFORM_PROFILE_BALANCED);
11066 else
11067 dytc_control_amt(!dytc_amt_active);
11068 }
11069
11070}
11071
11072static void hotkey_driver_event(const unsigned int scancode)
11073{
11074 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
11075}
11076
11077/* --------------------------------------------------------------------- */
11078
11079/* /proc support */
11080static struct proc_dir_entry *proc_dir;
11081
11082/*
11083 * Module and infrastructure proble, init and exit handling
11084 */
11085
11086static bool force_load;
11087
11088#ifdef CONFIG_THINKPAD_ACPI_DEBUG
11089static const char * __init str_supported(int is_supported)
11090{
11091 static char text_unsupported[] __initdata = "not supported";
11092
11093 return (is_supported) ? &text_unsupported[4] : &text_unsupported[0];
11094}
11095#endif /* CONFIG_THINKPAD_ACPI_DEBUG */
11096
11097static void ibm_exit(struct ibm_struct *ibm)
11098{
11099 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
11100
11101 list_del_init(&ibm->all_drivers);
11102
11103 if (ibm->flags.acpi_notify_installed) {
11104 dbg_printk(TPACPI_DBG_EXIT,
11105 "%s: acpi_remove_notify_handler\n", ibm->name);
11106 BUG_ON(!ibm->acpi);
11107 acpi_remove_notify_handler(*ibm->acpi->handle,
11108 ibm->acpi->type,
11109 dispatch_acpi_notify);
11110 ibm->flags.acpi_notify_installed = 0;
11111 }
11112
11113 if (ibm->flags.proc_created) {
11114 dbg_printk(TPACPI_DBG_EXIT,
11115 "%s: remove_proc_entry\n", ibm->name);
11116 remove_proc_entry(ibm->name, proc_dir);
11117 ibm->flags.proc_created = 0;
11118 }
11119
11120 if (ibm->flags.acpi_driver_registered) {
11121 dbg_printk(TPACPI_DBG_EXIT,
11122 "%s: acpi_bus_unregister_driver\n", ibm->name);
11123 BUG_ON(!ibm->acpi);
11124 acpi_bus_unregister_driver(ibm->acpi->driver);
11125 kfree(ibm->acpi->driver);
11126 ibm->acpi->driver = NULL;
11127 ibm->flags.acpi_driver_registered = 0;
11128 }
11129
11130 if (ibm->flags.init_called && ibm->exit) {
11131 ibm->exit();
11132 ibm->flags.init_called = 0;
11133 }
11134
11135 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
11136}
11137
11138static int __init ibm_init(struct ibm_init_struct *iibm)
11139{
11140 int ret;
11141 struct ibm_struct *ibm = iibm->data;
11142 struct proc_dir_entry *entry;
11143
11144 BUG_ON(ibm == NULL);
11145
11146 INIT_LIST_HEAD(&ibm->all_drivers);
11147
11148 if (ibm->flags.experimental && !experimental)
11149 return 0;
11150
11151 dbg_printk(TPACPI_DBG_INIT,
11152 "probing for %s\n", ibm->name);
11153
11154 if (iibm->init) {
11155 ret = iibm->init(iibm);
11156 if (ret > 0 || ret == -ENODEV)
11157 return 0; /* subdriver functionality not available */
11158 if (ret)
11159 return ret;
11160
11161 ibm->flags.init_called = 1;
11162 }
11163
11164 if (ibm->acpi) {
11165 if (ibm->acpi->hid) {
11166 ret = register_tpacpi_subdriver(ibm);
11167 if (ret)
11168 goto err_out;
11169 }
11170
11171 if (ibm->acpi->notify) {
11172 ret = setup_acpi_notify(ibm);
11173 if (ret == -ENODEV) {
11174 pr_notice("disabling subdriver %s\n",
11175 ibm->name);
11176 ret = 0;
11177 goto err_out;
11178 }
11179 if (ret < 0)
11180 goto err_out;
11181 }
11182 }
11183
11184 dbg_printk(TPACPI_DBG_INIT,
11185 "%s installed\n", ibm->name);
11186
11187 if (ibm->read) {
11188 umode_t mode = iibm->base_procfs_mode;
11189
11190 if (!mode)
11191 mode = S_IRUGO;
11192 if (ibm->write)
11193 mode |= S_IWUSR;
11194 entry = proc_create_data(ibm->name, mode, proc_dir,
11195 &dispatch_proc_ops, ibm);
11196 if (!entry) {
11197 pr_err("unable to create proc entry %s\n", ibm->name);
11198 ret = -ENODEV;
11199 goto err_out;
11200 }
11201 ibm->flags.proc_created = 1;
11202 }
11203
11204 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
11205
11206 return 0;
11207
11208err_out:
11209 dbg_printk(TPACPI_DBG_INIT,
11210 "%s: at error exit path with result %d\n",
11211 ibm->name, ret);
11212
11213 ibm_exit(ibm);
11214 return (ret < 0) ? ret : 0;
11215}
11216
11217/* Probing */
11218
11219static char __init tpacpi_parse_fw_id(const char * const s,
11220 u32 *model, u16 *release)
11221{
11222 int i;
11223
11224 if (!s || strlen(s) < 8)
11225 goto invalid;
11226
11227 for (i = 0; i < 8; i++)
11228 if (!((s[i] >= '0' && s[i] <= '9') ||
11229 (s[i] >= 'A' && s[i] <= 'Z')))
11230 goto invalid;
11231
11232 /*
11233 * Most models: xxyTkkWW (#.##c)
11234 * Ancient 570/600 and -SL lacks (#.##c)
11235 */
11236 if (s[3] == 'T' || s[3] == 'N') {
11237 *model = TPID(s[0], s[1]);
11238 *release = TPVER(s[4], s[5]);
11239 return s[2];
11240
11241 /* New models: xxxyTkkW (#.##c); T550 and some others */
11242 } else if (s[4] == 'T' || s[4] == 'N') {
11243 *model = TPID3(s[0], s[1], s[2]);
11244 *release = TPVER(s[5], s[6]);
11245 return s[3];
11246 }
11247
11248invalid:
11249 return '\0';
11250}
11251
11252static void find_new_ec_fwstr(const struct dmi_header *dm, void *private)
11253{
11254 char *ec_fw_string = (char *) private;
11255 const char *dmi_data = (const char *)dm;
11256 /*
11257 * ThinkPad Embedded Controller Program Table on newer models
11258 *
11259 * Offset | Name | Width | Description
11260 * ----------------------------------------------------
11261 * 0x00 | Type | BYTE | 0x8C
11262 * 0x01 | Length | BYTE |
11263 * 0x02 | Handle | WORD | Varies
11264 * 0x04 | Signature | BYTEx6 | ASCII for "LENOVO"
11265 * 0x0A | OEM struct offset | BYTE | 0x0B
11266 * 0x0B | OEM struct number | BYTE | 0x07, for this structure
11267 * 0x0C | OEM struct revision | BYTE | 0x01, for this format
11268 * 0x0D | ECP version ID | STR ID |
11269 * 0x0E | ECP release date | STR ID |
11270 */
11271
11272 /* Return if data structure not match */
11273 if (dm->type != 140 || dm->length < 0x0F ||
11274 memcmp(dmi_data + 4, "LENOVO", 6) != 0 ||
11275 dmi_data[0x0A] != 0x0B || dmi_data[0x0B] != 0x07 ||
11276 dmi_data[0x0C] != 0x01)
11277 return;
11278
11279 /* fwstr is the first 8byte string */
11280 strncpy(ec_fw_string, dmi_data + 0x0F, 8);
11281}
11282
11283/* returns 0 - probe ok, or < 0 - probe error.
11284 * Probe ok doesn't mean thinkpad found.
11285 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
11286static int __must_check __init get_thinkpad_model_data(
11287 struct thinkpad_id_data *tp)
11288{
11289 const struct dmi_device *dev = NULL;
11290 char ec_fw_string[18] = {0};
11291 char const *s;
11292 char t;
11293
11294 if (!tp)
11295 return -EINVAL;
11296
11297 memset(tp, 0, sizeof(*tp));
11298
11299 if (dmi_name_in_vendors("IBM"))
11300 tp->vendor = PCI_VENDOR_ID_IBM;
11301 else if (dmi_name_in_vendors("LENOVO"))
11302 tp->vendor = PCI_VENDOR_ID_LENOVO;
11303 else
11304 return 0;
11305
11306 s = dmi_get_system_info(DMI_BIOS_VERSION);
11307 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
11308 if (s && !tp->bios_version_str)
11309 return -ENOMEM;
11310
11311 /* Really ancient ThinkPad 240X will fail this, which is fine */
11312 t = tpacpi_parse_fw_id(tp->bios_version_str,
11313 &tp->bios_model, &tp->bios_release);
11314 if (t != 'E' && t != 'C')
11315 return 0;
11316
11317 /*
11318 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
11319 * X32 or newer, all Z series; Some models must have an
11320 * up-to-date BIOS or they will not be detected.
11321 *
11322 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
11323 */
11324 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
11325 if (sscanf(dev->name,
11326 "IBM ThinkPad Embedded Controller -[%17c",
11327 ec_fw_string) == 1) {
11328 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
11329 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
11330 break;
11331 }
11332 }
11333
11334 /* Newer ThinkPads have different EC program info table */
11335 if (!ec_fw_string[0])
11336 dmi_walk(find_new_ec_fwstr, &ec_fw_string);
11337
11338 if (ec_fw_string[0]) {
11339 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
11340 if (!tp->ec_version_str)
11341 return -ENOMEM;
11342
11343 t = tpacpi_parse_fw_id(ec_fw_string,
11344 &tp->ec_model, &tp->ec_release);
11345 if (t != 'H') {
11346 pr_notice("ThinkPad firmware release %s doesn't match the known patterns\n",
11347 ec_fw_string);
11348 pr_notice("please report this to %s\n", TPACPI_MAIL);
11349 }
11350 }
11351
11352 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
11353 if (s && !(strncasecmp(s, "ThinkPad", 8) && strncasecmp(s, "Lenovo", 6))) {
11354 tp->model_str = kstrdup(s, GFP_KERNEL);
11355 if (!tp->model_str)
11356 return -ENOMEM;
11357 } else {
11358 s = dmi_get_system_info(DMI_BIOS_VENDOR);
11359 if (s && !(strncasecmp(s, "Lenovo", 6))) {
11360 tp->model_str = kstrdup(s, GFP_KERNEL);
11361 if (!tp->model_str)
11362 return -ENOMEM;
11363 }
11364 }
11365
11366 s = dmi_get_system_info(DMI_PRODUCT_NAME);
11367 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
11368 if (s && !tp->nummodel_str)
11369 return -ENOMEM;
11370
11371 return 0;
11372}
11373
11374static int __init probe_for_thinkpad(void)
11375{
11376 int is_thinkpad;
11377
11378 if (acpi_disabled)
11379 return -ENODEV;
11380
11381 /* It would be dangerous to run the driver in this case */
11382 if (!tpacpi_is_ibm() && !tpacpi_is_lenovo())
11383 return -ENODEV;
11384
11385 /*
11386 * Non-ancient models have better DMI tagging, but very old models
11387 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
11388 */
11389 is_thinkpad = (thinkpad_id.model_str != NULL) ||
11390 (thinkpad_id.ec_model != 0) ||
11391 tpacpi_is_fw_known();
11392
11393 /* The EC handler is required */
11394 tpacpi_acpi_handle_locate("ec", TPACPI_ACPI_EC_HID, &ec_handle);
11395 if (!ec_handle) {
11396 if (is_thinkpad)
11397 pr_err("Not yet supported ThinkPad detected!\n");
11398 return -ENODEV;
11399 }
11400
11401 if (!is_thinkpad && !force_load)
11402 return -ENODEV;
11403
11404 return 0;
11405}
11406
11407static void __init thinkpad_acpi_init_banner(void)
11408{
11409 pr_info("%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
11410 pr_info("%s\n", TPACPI_URL);
11411
11412 pr_info("ThinkPad BIOS %s, EC %s\n",
11413 (thinkpad_id.bios_version_str) ?
11414 thinkpad_id.bios_version_str : "unknown",
11415 (thinkpad_id.ec_version_str) ?
11416 thinkpad_id.ec_version_str : "unknown");
11417
11418 BUG_ON(!thinkpad_id.vendor);
11419
11420 if (thinkpad_id.model_str)
11421 pr_info("%s %s, model %s\n",
11422 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
11423 "IBM" : ((thinkpad_id.vendor ==
11424 PCI_VENDOR_ID_LENOVO) ?
11425 "Lenovo" : "Unknown vendor"),
11426 thinkpad_id.model_str,
11427 (thinkpad_id.nummodel_str) ?
11428 thinkpad_id.nummodel_str : "unknown");
11429}
11430
11431/* Module init, exit, parameters */
11432
11433static struct ibm_init_struct ibms_init[] __initdata = {
11434 {
11435 .data = &thinkpad_acpi_driver_data,
11436 },
11437 {
11438 .init = hotkey_init,
11439 .data = &hotkey_driver_data,
11440 },
11441 {
11442 .init = bluetooth_init,
11443 .data = &bluetooth_driver_data,
11444 },
11445 {
11446 .init = wan_init,
11447 .data = &wan_driver_data,
11448 },
11449 {
11450 .init = uwb_init,
11451 .data = &uwb_driver_data,
11452 },
11453#ifdef CONFIG_THINKPAD_ACPI_VIDEO
11454 {
11455 .init = video_init,
11456 .base_procfs_mode = S_IRUSR,
11457 .data = &video_driver_data,
11458 },
11459#endif
11460 {
11461 .init = kbdlight_init,
11462 .data = &kbdlight_driver_data,
11463 },
11464 {
11465 .init = light_init,
11466 .data = &light_driver_data,
11467 },
11468 {
11469 .init = cmos_init,
11470 .data = &cmos_driver_data,
11471 },
11472 {
11473 .init = led_init,
11474 .data = &led_driver_data,
11475 },
11476 {
11477 .init = beep_init,
11478 .data = &beep_driver_data,
11479 },
11480 {
11481 .init = thermal_init,
11482 .data = &thermal_driver_data,
11483 },
11484 {
11485 .init = brightness_init,
11486 .data = &brightness_driver_data,
11487 },
11488 {
11489 .init = volume_init,
11490 .data = &volume_driver_data,
11491 },
11492 {
11493 .init = fan_init,
11494 .data = &fan_driver_data,
11495 },
11496 {
11497 .init = mute_led_init,
11498 .data = &mute_led_driver_data,
11499 },
11500 {
11501 .init = tpacpi_battery_init,
11502 .data = &battery_driver_data,
11503 },
11504 {
11505 .init = tpacpi_lcdshadow_init,
11506 .data = &lcdshadow_driver_data,
11507 },
11508 {
11509 .init = tpacpi_proxsensor_init,
11510 .data = &proxsensor_driver_data,
11511 },
11512 {
11513 .init = tpacpi_dytc_profile_init,
11514 .data = &dytc_profile_driver_data,
11515 },
11516 {
11517 .init = tpacpi_kbdlang_init,
11518 .data = &kbdlang_driver_data,
11519 },
11520 {
11521 .init = tpacpi_dprc_init,
11522 .data = &dprc_driver_data,
11523 },
11524};
11525
11526static int __init set_ibm_param(const char *val, const struct kernel_param *kp)
11527{
11528 unsigned int i;
11529 struct ibm_struct *ibm;
11530
11531 if (!kp || !kp->name || !val)
11532 return -EINVAL;
11533
11534 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
11535 ibm = ibms_init[i].data;
11536 if (!ibm || !ibm->name)
11537 continue;
11538
11539 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
11540 if (strlen(val) > sizeof(ibms_init[i].param) - 1)
11541 return -ENOSPC;
11542 strcpy(ibms_init[i].param, val);
11543 return 0;
11544 }
11545 }
11546
11547 return -EINVAL;
11548}
11549
11550module_param(experimental, int, 0444);
11551MODULE_PARM_DESC(experimental,
11552 "Enables experimental features when non-zero");
11553
11554module_param_named(debug, dbg_level, uint, 0);
11555MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
11556
11557module_param(force_load, bool, 0444);
11558MODULE_PARM_DESC(force_load,
11559 "Attempts to load the driver even on a mis-identified ThinkPad when true");
11560
11561module_param_named(fan_control, fan_control_allowed, bool, 0444);
11562MODULE_PARM_DESC(fan_control,
11563 "Enables setting fan parameters features when true");
11564
11565module_param_named(brightness_mode, brightness_mode, uint, 0444);
11566MODULE_PARM_DESC(brightness_mode,
11567 "Selects brightness control strategy: 0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
11568
11569module_param(brightness_enable, uint, 0444);
11570MODULE_PARM_DESC(brightness_enable,
11571 "Enables backlight control when 1, disables when 0");
11572
11573#ifdef CONFIG_THINKPAD_ACPI_ALSA_SUPPORT
11574module_param_named(volume_mode, volume_mode, uint, 0444);
11575MODULE_PARM_DESC(volume_mode,
11576 "Selects volume control strategy: 0=auto, 1=EC, 2=N/A, 3=EC+NVRAM");
11577
11578module_param_named(volume_capabilities, volume_capabilities, uint, 0444);
11579MODULE_PARM_DESC(volume_capabilities,
11580 "Selects the mixer capabilities: 0=auto, 1=volume and mute, 2=mute only");
11581
11582module_param_named(volume_control, volume_control_allowed, bool, 0444);
11583MODULE_PARM_DESC(volume_control,
11584 "Enables software override for the console audio control when true");
11585
11586module_param_named(software_mute, software_mute_requested, bool, 0444);
11587MODULE_PARM_DESC(software_mute,
11588 "Request full software mute control");
11589
11590/* ALSA module API parameters */
11591module_param_named(index, alsa_index, int, 0444);
11592MODULE_PARM_DESC(index, "ALSA index for the ACPI EC Mixer");
11593module_param_named(id, alsa_id, charp, 0444);
11594MODULE_PARM_DESC(id, "ALSA id for the ACPI EC Mixer");
11595module_param_named(enable, alsa_enable, bool, 0444);
11596MODULE_PARM_DESC(enable, "Enable the ALSA interface for the ACPI EC Mixer");
11597#endif /* CONFIG_THINKPAD_ACPI_ALSA_SUPPORT */
11598
11599/* The module parameter can't be read back, that's why 0 is used here */
11600#define TPACPI_PARAM(feature) \
11601 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
11602 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command at module load, see documentation")
11603
11604TPACPI_PARAM(hotkey);
11605TPACPI_PARAM(bluetooth);
11606TPACPI_PARAM(video);
11607TPACPI_PARAM(light);
11608TPACPI_PARAM(cmos);
11609TPACPI_PARAM(led);
11610TPACPI_PARAM(beep);
11611TPACPI_PARAM(brightness);
11612TPACPI_PARAM(volume);
11613TPACPI_PARAM(fan);
11614
11615#ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
11616module_param(dbg_wlswemul, uint, 0444);
11617MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
11618module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
11619MODULE_PARM_DESC(wlsw_state,
11620 "Initial state of the emulated WLSW switch");
11621
11622module_param(dbg_bluetoothemul, uint, 0444);
11623MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
11624module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
11625MODULE_PARM_DESC(bluetooth_state,
11626 "Initial state of the emulated bluetooth switch");
11627
11628module_param(dbg_wwanemul, uint, 0444);
11629MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
11630module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
11631MODULE_PARM_DESC(wwan_state,
11632 "Initial state of the emulated WWAN switch");
11633
11634module_param(dbg_uwbemul, uint, 0444);
11635MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
11636module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
11637MODULE_PARM_DESC(uwb_state,
11638 "Initial state of the emulated UWB switch");
11639#endif
11640
11641static void thinkpad_acpi_module_exit(void)
11642{
11643 struct ibm_struct *ibm, *itmp;
11644
11645 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
11646
11647#ifdef CONFIG_SUSPEND
11648 if (tp_features.quirks && tp_features.quirks->s2idle_bug_mmio)
11649 acpi_unregister_lps0_dev(&thinkpad_acpi_s2idle_dev_ops);
11650#endif
11651 if (tpacpi_hwmon)
11652 hwmon_device_unregister(tpacpi_hwmon);
11653 if (tp_features.sensors_pdrv_registered)
11654 platform_driver_unregister(&tpacpi_hwmon_pdriver);
11655 if (tp_features.platform_drv_registered)
11656 platform_driver_unregister(&tpacpi_pdriver);
11657
11658 list_for_each_entry_safe_reverse(ibm, itmp,
11659 &tpacpi_all_drivers,
11660 all_drivers) {
11661 ibm_exit(ibm);
11662 }
11663
11664 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
11665
11666 if (tpacpi_inputdev) {
11667 if (tp_features.input_device_registered)
11668 input_unregister_device(tpacpi_inputdev);
11669 else
11670 input_free_device(tpacpi_inputdev);
11671 kfree(hotkey_keycode_map);
11672 }
11673
11674 if (tpacpi_sensors_pdev)
11675 platform_device_unregister(tpacpi_sensors_pdev);
11676 if (tpacpi_pdev)
11677 platform_device_unregister(tpacpi_pdev);
11678 if (proc_dir)
11679 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
11680 if (tpacpi_wq)
11681 destroy_workqueue(tpacpi_wq);
11682
11683 kfree(thinkpad_id.bios_version_str);
11684 kfree(thinkpad_id.ec_version_str);
11685 kfree(thinkpad_id.model_str);
11686 kfree(thinkpad_id.nummodel_str);
11687}
11688
11689
11690static int __init thinkpad_acpi_module_init(void)
11691{
11692 const struct dmi_system_id *dmi_id;
11693 int ret, i;
11694
11695 tpacpi_lifecycle = TPACPI_LIFE_INIT;
11696
11697 /* Driver-level probe */
11698
11699 ret = get_thinkpad_model_data(&thinkpad_id);
11700 if (ret) {
11701 pr_err("unable to get DMI data: %d\n", ret);
11702 thinkpad_acpi_module_exit();
11703 return ret;
11704 }
11705 ret = probe_for_thinkpad();
11706 if (ret) {
11707 thinkpad_acpi_module_exit();
11708 return ret;
11709 }
11710
11711 /* Driver initialization */
11712
11713 thinkpad_acpi_init_banner();
11714 tpacpi_check_outdated_fw();
11715
11716 TPACPI_ACPIHANDLE_INIT(ecrd);
11717 TPACPI_ACPIHANDLE_INIT(ecwr);
11718
11719 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
11720 if (!tpacpi_wq) {
11721 thinkpad_acpi_module_exit();
11722 return -ENOMEM;
11723 }
11724
11725 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
11726 if (!proc_dir) {
11727 pr_err("unable to create proc dir " TPACPI_PROC_DIR "\n");
11728 thinkpad_acpi_module_exit();
11729 return -ENODEV;
11730 }
11731
11732 dmi_id = dmi_first_match(fwbug_list);
11733 if (dmi_id)
11734 tp_features.quirks = dmi_id->driver_data;
11735
11736 /* Device initialization */
11737 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, PLATFORM_DEVID_NONE,
11738 NULL, 0);
11739 if (IS_ERR(tpacpi_pdev)) {
11740 ret = PTR_ERR(tpacpi_pdev);
11741 tpacpi_pdev = NULL;
11742 pr_err("unable to register platform device\n");
11743 thinkpad_acpi_module_exit();
11744 return ret;
11745 }
11746 tpacpi_sensors_pdev = platform_device_register_simple(
11747 TPACPI_HWMON_DRVR_NAME,
11748 PLATFORM_DEVID_NONE, NULL, 0);
11749 if (IS_ERR(tpacpi_sensors_pdev)) {
11750 ret = PTR_ERR(tpacpi_sensors_pdev);
11751 tpacpi_sensors_pdev = NULL;
11752 pr_err("unable to register hwmon platform device\n");
11753 thinkpad_acpi_module_exit();
11754 return ret;
11755 }
11756
11757 mutex_init(&tpacpi_inputdev_send_mutex);
11758 tpacpi_inputdev = input_allocate_device();
11759 if (!tpacpi_inputdev) {
11760 thinkpad_acpi_module_exit();
11761 return -ENOMEM;
11762 } else {
11763 /* Prepare input device, but don't register */
11764 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
11765 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
11766 tpacpi_inputdev->id.bustype = BUS_HOST;
11767 tpacpi_inputdev->id.vendor = thinkpad_id.vendor;
11768 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
11769 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
11770 tpacpi_inputdev->dev.parent = &tpacpi_pdev->dev;
11771 }
11772
11773 /* Init subdriver dependencies */
11774 tpacpi_detect_brightness_capabilities();
11775
11776 /* Init subdrivers */
11777 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
11778 ret = ibm_init(&ibms_init[i]);
11779 if (ret >= 0 && *ibms_init[i].param)
11780 ret = ibms_init[i].data->write(ibms_init[i].param);
11781 if (ret < 0) {
11782 thinkpad_acpi_module_exit();
11783 return ret;
11784 }
11785 }
11786
11787 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
11788
11789 ret = platform_driver_register(&tpacpi_pdriver);
11790 if (ret) {
11791 pr_err("unable to register main platform driver\n");
11792 thinkpad_acpi_module_exit();
11793 return ret;
11794 }
11795 tp_features.platform_drv_registered = 1;
11796
11797 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
11798 if (ret) {
11799 pr_err("unable to register hwmon platform driver\n");
11800 thinkpad_acpi_module_exit();
11801 return ret;
11802 }
11803 tp_features.sensors_pdrv_registered = 1;
11804
11805 tpacpi_hwmon = hwmon_device_register_with_groups(
11806 &tpacpi_sensors_pdev->dev, TPACPI_NAME, NULL, tpacpi_hwmon_groups);
11807 if (IS_ERR(tpacpi_hwmon)) {
11808 ret = PTR_ERR(tpacpi_hwmon);
11809 tpacpi_hwmon = NULL;
11810 pr_err("unable to register hwmon device\n");
11811 thinkpad_acpi_module_exit();
11812 return ret;
11813 }
11814
11815 ret = input_register_device(tpacpi_inputdev);
11816 if (ret < 0) {
11817 pr_err("unable to register input device\n");
11818 thinkpad_acpi_module_exit();
11819 return ret;
11820 } else {
11821 tp_features.input_device_registered = 1;
11822 }
11823
11824#ifdef CONFIG_SUSPEND
11825 if (tp_features.quirks && tp_features.quirks->s2idle_bug_mmio) {
11826 if (!acpi_register_lps0_dev(&thinkpad_acpi_s2idle_dev_ops))
11827 pr_info("Using s2idle quirk to avoid %s platform firmware bug\n",
11828 (dmi_id && dmi_id->ident) ? dmi_id->ident : "");
11829 }
11830#endif
11831 return 0;
11832}
11833
11834MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
11835
11836/*
11837 * This will autoload the driver in almost every ThinkPad
11838 * in widespread use.
11839 *
11840 * Only _VERY_ old models, like the 240, 240x and 570 lack
11841 * the HKEY event interface.
11842 */
11843MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
11844
11845/*
11846 * DMI matching for module autoloading
11847 *
11848 * See https://thinkwiki.org/wiki/List_of_DMI_IDs
11849 * See https://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
11850 *
11851 * Only models listed in thinkwiki will be supported, so add yours
11852 * if it is not there yet.
11853 */
11854#define IBM_BIOS_MODULE_ALIAS(__type) \
11855 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
11856
11857/* Ancient thinkpad BIOSes have to be identified by
11858 * BIOS type or model number, and there are far less
11859 * BIOS types than model numbers... */
11860IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
11861
11862MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
11863MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
11864MODULE_DESCRIPTION(TPACPI_DESC);
11865MODULE_VERSION(TPACPI_VERSION);
11866MODULE_LICENSE("GPL");
11867
11868module_init(thinkpad_acpi_module_init);
11869module_exit(thinkpad_acpi_module_exit);
1/*
2 * thinkpad_acpi.c - ThinkPad ACPI Extras
3 *
4 *
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 * 02110-1301, USA.
22 */
23
24#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
25
26#define TPACPI_VERSION "0.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);