2 * thinkpad_acpi.c - ThinkPad ACPI Extras
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2009 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
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.
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.
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
24 #define TPACPI_VERSION "0.23"
25 #define TPACPI_SYSFS_VERSION 0x020500
29 * 2007-10-20 changelog trimmed down
31 * 2007-03-27 0.14 renamed to thinkpad_acpi and moved to
34 * 2006-11-22 0.13 new maintainer
35 * changelog now lives in git commit history, and will
36 * not be updated further in-file.
38 * 2005-03-17 0.11 support for 600e, 770x
39 * thanks to Jamie Lentin <lentinj@dial.pipex.com>
41 * 2005-01-16 0.9 use MODULE_VERSION
42 * thanks to Henrik Brix Andersen <brix@gentoo.org>
43 * fix parameter passing on module loading
44 * thanks to Rusty Russell <rusty@rustcorp.com.au>
45 * thanks to Jim Radford <radford@blackbean.org>
46 * 2004-11-08 0.8 fix init error case, don't return from a macro
47 * thanks to Chris Wright <chrisw@osdl.org>
50 #include <linux/kernel.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/types.h>
54 #include <linux/string.h>
55 #include <linux/list.h>
56 #include <linux/mutex.h>
57 #include <linux/sched.h>
58 #include <linux/kthread.h>
59 #include <linux/freezer.h>
60 #include <linux/delay.h>
62 #include <linux/nvram.h>
63 #include <linux/proc_fs.h>
64 #include <linux/sysfs.h>
65 #include <linux/backlight.h>
67 #include <linux/platform_device.h>
68 #include <linux/hwmon.h>
69 #include <linux/hwmon-sysfs.h>
70 #include <linux/input.h>
71 #include <linux/leds.h>
72 #include <linux/rfkill.h>
73 #include <asm/uaccess.h>
75 #include <linux/dmi.h>
76 #include <linux/jiffies.h>
77 #include <linux/workqueue.h>
79 #include <acpi/acpi_drivers.h>
81 #include <linux/pci_ids.h>
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
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,
102 /* NVRAM bit masks */
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,
120 #define TPACPI_ACPI_HKEY_HID "IBM0068"
123 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
124 #define TPACPI_HKEY_INPUT_VERSION 0x4101
126 /* ACPI \WGSV commands */
128 TP_ACPI_WGSV_GET_STATE = 0x01, /* Get state information */
129 TP_ACPI_WGSV_PWR_ON_ON_RESUME = 0x02, /* Resume WWAN powered on */
130 TP_ACPI_WGSV_PWR_OFF_ON_RESUME = 0x03, /* Resume WWAN powered off */
131 TP_ACPI_WGSV_SAVE_STATE = 0x04, /* Save state for S4/S5 */
134 /* TP_ACPI_WGSV_GET_STATE bits */
136 TP_ACPI_WGSV_STATE_WWANEXIST = 0x0001, /* WWAN hw available */
137 TP_ACPI_WGSV_STATE_WWANPWR = 0x0002, /* WWAN radio enabled */
138 TP_ACPI_WGSV_STATE_WWANPWRRES = 0x0004, /* WWAN state at resume */
139 TP_ACPI_WGSV_STATE_WWANBIOSOFF = 0x0008, /* WWAN disabled in BIOS */
140 TP_ACPI_WGSV_STATE_BLTHEXIST = 0x0001, /* BLTH hw available */
141 TP_ACPI_WGSV_STATE_BLTHPWR = 0x0002, /* BLTH radio enabled */
142 TP_ACPI_WGSV_STATE_BLTHPWRRES = 0x0004, /* BLTH state at resume */
143 TP_ACPI_WGSV_STATE_BLTHBIOSOFF = 0x0008, /* BLTH disabled in BIOS */
144 TP_ACPI_WGSV_STATE_UWBEXIST = 0x0010, /* UWB hw available */
145 TP_ACPI_WGSV_STATE_UWBPWR = 0x0020, /* UWB radio enabled */
149 enum tpacpi_hkey_event_t {
151 TP_HKEY_EV_HOTKEY_BASE = 0x1001, /* first hotkey (FN+F1) */
152 TP_HKEY_EV_BRGHT_UP = 0x1010, /* Brightness up */
153 TP_HKEY_EV_BRGHT_DOWN = 0x1011, /* Brightness down */
154 TP_HKEY_EV_VOL_UP = 0x1015, /* Volume up or unmute */
155 TP_HKEY_EV_VOL_DOWN = 0x1016, /* Volume down or unmute */
156 TP_HKEY_EV_VOL_MUTE = 0x1017, /* Mixer output mute */
158 /* Reasons for waking up from S3/S4 */
159 TP_HKEY_EV_WKUP_S3_UNDOCK = 0x2304, /* undock requested, S3 */
160 TP_HKEY_EV_WKUP_S4_UNDOCK = 0x2404, /* undock requested, S4 */
161 TP_HKEY_EV_WKUP_S3_BAYEJ = 0x2305, /* bay ejection req, S3 */
162 TP_HKEY_EV_WKUP_S4_BAYEJ = 0x2405, /* bay ejection req, S4 */
163 TP_HKEY_EV_WKUP_S3_BATLOW = 0x2313, /* battery empty, S3 */
164 TP_HKEY_EV_WKUP_S4_BATLOW = 0x2413, /* battery empty, S4 */
166 /* Auto-sleep after eject request */
167 TP_HKEY_EV_BAYEJ_ACK = 0x3003, /* bay ejection complete */
168 TP_HKEY_EV_UNDOCK_ACK = 0x4003, /* undock complete */
170 /* Misc bay events */
171 TP_HKEY_EV_OPTDRV_EJ = 0x3006, /* opt. drive tray ejected */
173 /* User-interface events */
174 TP_HKEY_EV_LID_CLOSE = 0x5001, /* laptop lid closed */
175 TP_HKEY_EV_LID_OPEN = 0x5002, /* laptop lid opened */
176 TP_HKEY_EV_TABLET_TABLET = 0x5009, /* tablet swivel up */
177 TP_HKEY_EV_TABLET_NOTEBOOK = 0x500a, /* tablet swivel down */
178 TP_HKEY_EV_PEN_INSERTED = 0x500b, /* tablet pen inserted */
179 TP_HKEY_EV_PEN_REMOVED = 0x500c, /* tablet pen removed */
180 TP_HKEY_EV_BRGHT_CHANGED = 0x5010, /* backlight control event */
183 TP_HKEY_EV_ALARM_BAT_HOT = 0x6011, /* battery too hot */
184 TP_HKEY_EV_ALARM_BAT_XHOT = 0x6012, /* battery critically hot */
185 TP_HKEY_EV_ALARM_SENSOR_HOT = 0x6021, /* sensor too hot */
186 TP_HKEY_EV_ALARM_SENSOR_XHOT = 0x6022, /* sensor critically hot */
187 TP_HKEY_EV_THM_TABLE_CHANGED = 0x6030, /* thermal table changed */
190 TP_HKEY_EV_RFKILL_CHANGED = 0x7000, /* rfkill switch changed */
193 /****************************************************************************
197 #define TPACPI_NAME "thinkpad"
198 #define TPACPI_DESC "ThinkPad ACPI Extras"
199 #define TPACPI_FILE TPACPI_NAME "_acpi"
200 #define TPACPI_URL "http://ibm-acpi.sf.net/"
201 #define TPACPI_MAIL "ibm-acpi-devel@lists.sourceforge.net"
203 #define TPACPI_PROC_DIR "ibm"
204 #define TPACPI_ACPI_EVENT_PREFIX "ibm"
205 #define TPACPI_DRVR_NAME TPACPI_FILE
206 #define TPACPI_DRVR_SHORTNAME "tpacpi"
207 #define TPACPI_HWMON_DRVR_NAME TPACPI_NAME "_hwmon"
209 #define TPACPI_NVRAM_KTHREAD_NAME "ktpacpi_nvramd"
210 #define TPACPI_WORKQUEUE_NAME "ktpacpid"
212 #define TPACPI_MAX_ACPI_ARGS 3
215 #define TPACPI_LOG TPACPI_FILE ": "
216 #define TPACPI_EMERG KERN_EMERG TPACPI_LOG
217 #define TPACPI_ALERT KERN_ALERT TPACPI_LOG
218 #define TPACPI_CRIT KERN_CRIT TPACPI_LOG
219 #define TPACPI_ERR KERN_ERR TPACPI_LOG
220 #define TPACPI_WARN KERN_WARNING TPACPI_LOG
221 #define TPACPI_NOTICE KERN_NOTICE TPACPI_LOG
222 #define TPACPI_INFO KERN_INFO TPACPI_LOG
223 #define TPACPI_DEBUG KERN_DEBUG TPACPI_LOG
225 /* Debugging printk groups */
226 #define TPACPI_DBG_ALL 0xffff
227 #define TPACPI_DBG_DISCLOSETASK 0x8000
228 #define TPACPI_DBG_INIT 0x0001
229 #define TPACPI_DBG_EXIT 0x0002
230 #define TPACPI_DBG_RFKILL 0x0004
231 #define TPACPI_DBG_HKEY 0x0008
232 #define TPACPI_DBG_FAN 0x0010
233 #define TPACPI_DBG_BRGHT 0x0020
235 #define onoff(status, bit) ((status) & (1 << (bit)) ? "on" : "off")
236 #define enabled(status, bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
237 #define strlencmp(a, b) (strncmp((a), (b), strlen(b)))
240 /****************************************************************************
241 * Driver-wide structs and misc. variables
246 struct tp_acpi_drv_struct {
247 const struct acpi_device_id *hid;
248 struct acpi_driver *driver;
250 void (*notify) (struct ibm_struct *, u32);
253 struct acpi_device *device;
259 int (*read) (char *);
260 int (*write) (char *);
262 void (*resume) (void);
263 void (*suspend) (pm_message_t state);
264 void (*shutdown) (void);
266 struct list_head all_drivers;
268 struct tp_acpi_drv_struct *acpi;
271 u8 acpi_driver_registered:1;
272 u8 acpi_notify_installed:1;
279 struct ibm_init_struct {
282 int (*init) (struct ibm_init_struct *);
283 struct ibm_struct *data;
294 u32 bright_16levels:1;
295 u32 bright_acpimode:1;
298 u32 fan_ctrl_status_undef:1;
300 u32 beep_needs_two_args:1;
301 u32 input_device_registered:1;
302 u32 platform_drv_registered:1;
303 u32 platform_drv_attrs_registered:1;
304 u32 sensors_pdrv_registered:1;
305 u32 sensors_pdrv_attrs_registered:1;
306 u32 sensors_pdev_attrs_registered:1;
307 u32 hotkey_poll_active:1;
311 u16 hotkey_mask_ff:1;
314 struct thinkpad_id_data {
315 unsigned int vendor; /* ThinkPad vendor:
316 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
318 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
319 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
321 u16 bios_model; /* 1Y = 0x5931, 0 = unknown */
323 u16 bios_release; /* 1ZETK1WW = 0x314b, 0 = unknown */
326 char *model_str; /* ThinkPad T43 */
327 char *nummodel_str; /* 9384A9C for a 9384-A9C model */
329 static struct thinkpad_id_data thinkpad_id;
332 TPACPI_LIFE_INIT = 0,
337 static int experimental;
338 static u32 dbg_level;
340 static struct workqueue_struct *tpacpi_wq;
348 /* Special LED class that can defer work */
349 struct tpacpi_led_classdev {
350 struct led_classdev led_classdev;
351 struct work_struct work;
352 enum led_status_t new_state;
356 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
357 static int dbg_wlswemul;
358 static int tpacpi_wlsw_emulstate;
359 static int dbg_bluetoothemul;
360 static int tpacpi_bluetooth_emulstate;
361 static int dbg_wwanemul;
362 static int tpacpi_wwan_emulstate;
363 static int dbg_uwbemul;
364 static int tpacpi_uwb_emulstate;
368 /*************************************************************************
372 #define dbg_printk(a_dbg_level, format, arg...) \
373 do { if (dbg_level & (a_dbg_level)) \
374 printk(TPACPI_DEBUG "%s: " format, __func__ , ## arg); \
377 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
378 #define vdbg_printk dbg_printk
379 static const char *str_supported(int is_supported);
381 #define vdbg_printk(a_dbg_level, format, arg...) \
385 static void tpacpi_log_usertask(const char * const what)
387 printk(TPACPI_DEBUG "%s: access by process with PID %d\n",
388 what, task_tgid_vnr(current));
391 #define tpacpi_disclose_usertask(what, format, arg...) \
394 (dbg_level & TPACPI_DBG_DISCLOSETASK) && \
395 (tpacpi_lifecycle == TPACPI_LIFE_RUNNING))) { \
396 printk(TPACPI_DEBUG "%s: PID %d: " format, \
397 what, task_tgid_vnr(current), ## arg); \
402 * Quirk handling helpers
404 * ThinkPad IDs and versions seen in the field so far
405 * are two-characters from the set [0-9A-Z], i.e. base 36.
407 * We use values well outside that range as specials.
410 #define TPACPI_MATCH_ANY 0xffffU
411 #define TPACPI_MATCH_UNKNOWN 0U
413 /* TPID('1', 'Y') == 0x5931 */
414 #define TPID(__c1, __c2) (((__c2) << 8) | (__c1))
416 #define TPACPI_Q_IBM(__id1, __id2, __quirk) \
417 { .vendor = PCI_VENDOR_ID_IBM, \
418 .bios = TPID(__id1, __id2), \
419 .ec = TPACPI_MATCH_ANY, \
420 .quirks = (__quirk) }
422 #define TPACPI_Q_LNV(__id1, __id2, __quirk) \
423 { .vendor = PCI_VENDOR_ID_LENOVO, \
424 .bios = TPID(__id1, __id2), \
425 .ec = TPACPI_MATCH_ANY, \
426 .quirks = (__quirk) }
428 struct tpacpi_quirk {
432 unsigned long quirks;
436 * tpacpi_check_quirks() - search BIOS/EC version on a list
437 * @qlist: array of &struct tpacpi_quirk
438 * @qlist_size: number of elements in @qlist
440 * Iterates over a quirks list until one is found that matches the
441 * ThinkPad's vendor, BIOS and EC model.
443 * Returns 0 if nothing matches, otherwise returns the quirks field of
444 * the matching &struct tpacpi_quirk entry.
446 * The match criteria is: vendor, ec and bios much match.
448 static unsigned long __init tpacpi_check_quirks(
449 const struct tpacpi_quirk *qlist,
450 unsigned int qlist_size)
453 if ((qlist->vendor == thinkpad_id.vendor ||
454 qlist->vendor == TPACPI_MATCH_ANY) &&
455 (qlist->bios == thinkpad_id.bios_model ||
456 qlist->bios == TPACPI_MATCH_ANY) &&
457 (qlist->ec == thinkpad_id.ec_model ||
458 qlist->ec == TPACPI_MATCH_ANY))
459 return qlist->quirks;
468 /****************************************************************************
469 ****************************************************************************
471 * ACPI Helpers and device model
473 ****************************************************************************
474 ****************************************************************************/
476 /*************************************************************************
480 static acpi_handle root_handle;
482 #define TPACPI_HANDLE(object, parent, paths...) \
483 static acpi_handle object##_handle; \
484 static acpi_handle *object##_parent = &parent##_handle; \
485 static char *object##_path; \
486 static char *object##_paths[] = { paths }
488 TPACPI_HANDLE(ec, root, "\\_SB.PCI0.ISA.EC0", /* 240, 240x */
489 "\\_SB.PCI.ISA.EC", /* 570 */
490 "\\_SB.PCI0.ISA0.EC0", /* 600e/x, 770e, 770x */
491 "\\_SB.PCI0.ISA.EC", /* A21e, A2xm/p, T20-22, X20-21 */
492 "\\_SB.PCI0.AD4S.EC0", /* i1400, R30 */
493 "\\_SB.PCI0.ICH3.EC0", /* R31 */
494 "\\_SB.PCI0.LPC.EC", /* all others */
497 TPACPI_HANDLE(ecrd, ec, "ECRD"); /* 570 */
498 TPACPI_HANDLE(ecwr, ec, "ECWR"); /* 570 */
500 TPACPI_HANDLE(cmos, root, "\\UCMS", /* R50, R50e, R50p, R51, */
502 "\\CMOS", /* A3x, G4x, R32, T23, T30, X22-24, X30 */
503 "\\CMS", /* R40, R40e */
506 TPACPI_HANDLE(hkey, ec, "\\_SB.HKEY", /* 600e/x, 770e, 770x */
507 "^HKEY", /* R30, R31 */
508 "HKEY", /* all others */
511 TPACPI_HANDLE(vid, root, "\\_SB.PCI.AGP.VGA", /* 570 */
512 "\\_SB.PCI0.AGP0.VID0", /* 600e/x, 770x */
513 "\\_SB.PCI0.VID0", /* 770e */
514 "\\_SB.PCI0.VID", /* A21e, G4x, R50e, X30, X40 */
515 "\\_SB.PCI0.AGP.VID", /* all others */
519 /*************************************************************************
523 static int acpi_evalf(acpi_handle handle,
524 void *res, char *method, char *fmt, ...)
527 struct acpi_object_list params;
528 union acpi_object in_objs[TPACPI_MAX_ACPI_ARGS];
529 struct acpi_buffer result, *resultp;
530 union acpi_object out_obj;
538 printk(TPACPI_ERR "acpi_evalf() called with empty format\n");
551 params.pointer = &in_objs[0];
558 in_objs[params.count].integer.value = va_arg(ap, int);
559 in_objs[params.count++].type = ACPI_TYPE_INTEGER;
561 /* add more types as needed */
563 printk(TPACPI_ERR "acpi_evalf() called "
564 "with invalid format character '%c'\n", c);
570 if (res_type != 'v') {
571 result.length = sizeof(out_obj);
572 result.pointer = &out_obj;
577 status = acpi_evaluate_object(handle, method, ¶ms, resultp);
582 *(int *)res = out_obj.integer.value;
583 success = status == AE_OK && out_obj.type == ACPI_TYPE_INTEGER;
586 success = status == AE_OK;
588 /* add more types as needed */
590 printk(TPACPI_ERR "acpi_evalf() called "
591 "with invalid format character '%c'\n", res_type);
595 if (!success && !quiet)
596 printk(TPACPI_ERR "acpi_evalf(%s, %s, ...) failed: %d\n",
597 method, fmt0, status);
602 static int acpi_ec_read(int i, u8 *p)
607 if (!acpi_evalf(ecrd_handle, &v, NULL, "dd", i))
611 if (ec_read(i, p) < 0)
618 static int acpi_ec_write(int i, u8 v)
621 if (!acpi_evalf(ecwr_handle, NULL, NULL, "vdd", i, v))
624 if (ec_write(i, v) < 0)
631 static int issue_thinkpad_cmos_command(int cmos_cmd)
636 if (!acpi_evalf(cmos_handle, NULL, NULL, "vd", cmos_cmd))
642 /*************************************************************************
646 #define TPACPI_ACPIHANDLE_INIT(object) \
647 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
648 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
650 static void drv_acpi_handle_init(char *name,
651 acpi_handle *handle, acpi_handle parent,
652 char **paths, int num_paths, char **path)
657 vdbg_printk(TPACPI_DBG_INIT, "trying to locate ACPI handle for %s\n",
660 for (i = 0; i < num_paths; i++) {
661 status = acpi_get_handle(parent, paths[i], handle);
662 if (ACPI_SUCCESS(status)) {
664 dbg_printk(TPACPI_DBG_INIT,
665 "Found ACPI handle %s for %s\n",
671 vdbg_printk(TPACPI_DBG_INIT, "ACPI handle for %s not found\n",
676 static void dispatch_acpi_notify(acpi_handle handle, u32 event, void *data)
678 struct ibm_struct *ibm = data;
680 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
683 if (!ibm || !ibm->acpi || !ibm->acpi->notify)
686 ibm->acpi->notify(ibm, event);
689 static int __init setup_acpi_notify(struct ibm_struct *ibm)
696 if (!*ibm->acpi->handle)
699 vdbg_printk(TPACPI_DBG_INIT,
700 "setting up ACPI notify for %s\n", ibm->name);
702 rc = acpi_bus_get_device(*ibm->acpi->handle, &ibm->acpi->device);
704 printk(TPACPI_ERR "acpi_bus_get_device(%s) failed: %d\n",
709 ibm->acpi->device->driver_data = ibm;
710 sprintf(acpi_device_class(ibm->acpi->device), "%s/%s",
711 TPACPI_ACPI_EVENT_PREFIX,
714 status = acpi_install_notify_handler(*ibm->acpi->handle,
715 ibm->acpi->type, dispatch_acpi_notify, ibm);
716 if (ACPI_FAILURE(status)) {
717 if (status == AE_ALREADY_EXISTS) {
719 "another device driver is already "
720 "handling %s events\n", ibm->name);
723 "acpi_install_notify_handler(%s) failed: %d\n",
728 ibm->flags.acpi_notify_installed = 1;
732 static int __init tpacpi_device_add(struct acpi_device *device)
737 static int __init register_tpacpi_subdriver(struct ibm_struct *ibm)
741 dbg_printk(TPACPI_DBG_INIT,
742 "registering %s as an ACPI driver\n", ibm->name);
746 ibm->acpi->driver = kzalloc(sizeof(struct acpi_driver), GFP_KERNEL);
747 if (!ibm->acpi->driver) {
749 "failed to allocate memory for ibm->acpi->driver\n");
753 sprintf(ibm->acpi->driver->name, "%s_%s", TPACPI_NAME, ibm->name);
754 ibm->acpi->driver->ids = ibm->acpi->hid;
756 ibm->acpi->driver->ops.add = &tpacpi_device_add;
758 rc = acpi_bus_register_driver(ibm->acpi->driver);
760 printk(TPACPI_ERR "acpi_bus_register_driver(%s) failed: %d\n",
762 kfree(ibm->acpi->driver);
763 ibm->acpi->driver = NULL;
765 ibm->flags.acpi_driver_registered = 1;
771 /****************************************************************************
772 ****************************************************************************
776 ****************************************************************************
777 ****************************************************************************/
779 static int dispatch_procfs_read(char *page, char **start, off_t off,
780 int count, int *eof, void *data)
782 struct ibm_struct *ibm = data;
785 if (!ibm || !ibm->read)
788 len = ibm->read(page);
792 if (len <= off + count)
804 static int dispatch_procfs_write(struct file *file,
805 const char __user *userbuf,
806 unsigned long count, void *data)
808 struct ibm_struct *ibm = data;
812 if (!ibm || !ibm->write)
814 if (count > PAGE_SIZE - 2)
817 kernbuf = kmalloc(count + 2, GFP_KERNEL);
821 if (copy_from_user(kernbuf, userbuf, count)) {
827 strcat(kernbuf, ",");
828 ret = ibm->write(kernbuf);
837 static char *next_cmd(char **cmds)
842 while ((end = strchr(start, ',')) && end == start)
854 /****************************************************************************
855 ****************************************************************************
857 * Device model: input, hwmon and platform
859 ****************************************************************************
860 ****************************************************************************/
862 static struct platform_device *tpacpi_pdev;
863 static struct platform_device *tpacpi_sensors_pdev;
864 static struct device *tpacpi_hwmon;
865 static struct input_dev *tpacpi_inputdev;
866 static struct mutex tpacpi_inputdev_send_mutex;
867 static LIST_HEAD(tpacpi_all_drivers);
869 static int tpacpi_suspend_handler(struct platform_device *pdev,
872 struct ibm_struct *ibm, *itmp;
874 list_for_each_entry_safe(ibm, itmp,
878 (ibm->suspend)(state);
884 static int tpacpi_resume_handler(struct platform_device *pdev)
886 struct ibm_struct *ibm, *itmp;
888 list_for_each_entry_safe(ibm, itmp,
898 static void tpacpi_shutdown_handler(struct platform_device *pdev)
900 struct ibm_struct *ibm, *itmp;
902 list_for_each_entry_safe(ibm, itmp,
910 static struct platform_driver tpacpi_pdriver = {
912 .name = TPACPI_DRVR_NAME,
913 .owner = THIS_MODULE,
915 .suspend = tpacpi_suspend_handler,
916 .resume = tpacpi_resume_handler,
917 .shutdown = tpacpi_shutdown_handler,
920 static struct platform_driver tpacpi_hwmon_pdriver = {
922 .name = TPACPI_HWMON_DRVR_NAME,
923 .owner = THIS_MODULE,
927 /*************************************************************************
928 * sysfs support helpers
931 struct attribute_set {
932 unsigned int members, max_members;
933 struct attribute_group group;
936 struct attribute_set_obj {
937 struct attribute_set s;
939 } __attribute__((packed));
941 static struct attribute_set *create_attr_set(unsigned int max_members,
944 struct attribute_set_obj *sobj;
946 if (max_members == 0)
949 /* Allocates space for implicit NULL at the end too */
950 sobj = kzalloc(sizeof(struct attribute_set_obj) +
951 max_members * sizeof(struct attribute *),
955 sobj->s.max_members = max_members;
956 sobj->s.group.attrs = &sobj->a;
957 sobj->s.group.name = name;
962 #define destroy_attr_set(_set) \
965 /* not multi-threaded safe, use it in a single thread per set */
966 static int add_to_attr_set(struct attribute_set *s, struct attribute *attr)
971 if (s->members >= s->max_members)
974 s->group.attrs[s->members] = attr;
980 static int add_many_to_attr_set(struct attribute_set *s,
981 struct attribute **attr,
986 for (i = 0; i < count; i++) {
987 res = add_to_attr_set(s, attr[i]);
995 static void delete_attr_set(struct attribute_set *s, struct kobject *kobj)
997 sysfs_remove_group(kobj, &s->group);
1001 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
1002 sysfs_create_group(_kobj, &_attr_set->group)
1004 static int parse_strtoul(const char *buf,
1005 unsigned long max, unsigned long *value)
1009 while (*buf && isspace(*buf))
1011 *value = simple_strtoul(buf, &endp, 0);
1012 while (*endp && isspace(*endp))
1014 if (*endp || *value > max)
1020 static void tpacpi_disable_brightness_delay(void)
1022 if (acpi_evalf(hkey_handle, NULL, "PWMS", "qvd", 0))
1023 printk(TPACPI_NOTICE
1024 "ACPI backlight control delay disabled\n");
1027 static int __init tpacpi_query_bcl_levels(acpi_handle handle)
1029 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1030 union acpi_object *obj;
1033 if (ACPI_SUCCESS(acpi_evaluate_object(handle, NULL, NULL, &buffer))) {
1034 obj = (union acpi_object *)buffer.pointer;
1035 if (!obj || (obj->type != ACPI_TYPE_PACKAGE)) {
1036 printk(TPACPI_ERR "Unknown _BCL data, "
1037 "please report this to %s\n", TPACPI_MAIL);
1040 rc = obj->package.count;
1046 kfree(buffer.pointer);
1050 static acpi_status __init tpacpi_acpi_walk_find_bcl(acpi_handle handle,
1051 u32 lvl, void *context, void **rv)
1053 char name[ACPI_PATH_SEGMENT_LENGTH];
1054 struct acpi_buffer buffer = { sizeof(name), &name };
1056 if (ACPI_SUCCESS(acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer)) &&
1057 !strncmp("_BCL", name, sizeof(name) - 1)) {
1058 BUG_ON(!rv || !*rv);
1059 **(int **)rv = tpacpi_query_bcl_levels(handle);
1060 return AE_CTRL_TERMINATE;
1067 * Returns 0 (no ACPI _BCL or _BCL invalid), or size of brightness map
1069 static int __init tpacpi_check_std_acpi_brightness_support(void)
1073 void *bcl_ptr = &bcl_levels;
1076 TPACPI_ACPIHANDLE_INIT(vid);
1082 * Search for a _BCL method, and execute it. This is safe on all
1083 * ThinkPads, and as a side-effect, _BCL will place a Lenovo Vista
1084 * BIOS in ACPI backlight control mode. We do NOT have to care
1085 * about calling the _BCL method in an enabled video device, any
1086 * will do for our purposes.
1089 status = acpi_walk_namespace(ACPI_TYPE_METHOD, vid_handle, 3,
1090 tpacpi_acpi_walk_find_bcl, NULL,
1093 if (ACPI_SUCCESS(status) && bcl_levels > 2) {
1094 tp_features.bright_acpimode = 1;
1095 return (bcl_levels - 2);
1101 static void printk_deprecated_attribute(const char * const what,
1102 const char * const details)
1104 tpacpi_log_usertask("deprecated sysfs attribute");
1105 printk(TPACPI_WARN "WARNING: sysfs attribute %s is deprecated and "
1106 "will be removed. %s\n",
1110 /*************************************************************************
1111 * rfkill and radio control support helpers
1115 * ThinkPad-ACPI firmware handling model:
1117 * WLSW (master wireless switch) is event-driven, and is common to all
1118 * firmware-controlled radios. It cannot be controlled, just monitored,
1119 * as expected. It overrides all radio state in firmware
1121 * The kernel, a masked-off hotkey, and WLSW can change the radio state
1122 * (TODO: verify how WLSW interacts with the returned radio state).
1124 * The only time there are shadow radio state changes, is when
1125 * masked-off hotkeys are used.
1129 * Internal driver API for radio state:
1131 * int: < 0 = error, otherwise enum tpacpi_rfkill_state
1132 * bool: true means radio blocked (off)
1134 enum tpacpi_rfkill_state {
1135 TPACPI_RFK_RADIO_OFF = 0,
1139 /* rfkill switches */
1140 enum tpacpi_rfk_id {
1141 TPACPI_RFK_BLUETOOTH_SW_ID = 0,
1142 TPACPI_RFK_WWAN_SW_ID,
1143 TPACPI_RFK_UWB_SW_ID,
1147 static const char *tpacpi_rfkill_names[] = {
1148 [TPACPI_RFK_BLUETOOTH_SW_ID] = "bluetooth",
1149 [TPACPI_RFK_WWAN_SW_ID] = "wwan",
1150 [TPACPI_RFK_UWB_SW_ID] = "uwb",
1151 [TPACPI_RFK_SW_MAX] = NULL
1154 /* ThinkPad-ACPI rfkill subdriver */
1156 struct rfkill *rfkill;
1157 enum tpacpi_rfk_id id;
1158 const struct tpacpi_rfk_ops *ops;
1161 struct tpacpi_rfk_ops {
1162 /* firmware interface */
1163 int (*get_status)(void);
1164 int (*set_status)(const enum tpacpi_rfkill_state);
1167 static struct tpacpi_rfk *tpacpi_rfkill_switches[TPACPI_RFK_SW_MAX];
1169 /* Query FW and update rfkill sw state for a given rfkill switch */
1170 static int tpacpi_rfk_update_swstate(const struct tpacpi_rfk *tp_rfk)
1177 status = (tp_rfk->ops->get_status)();
1181 rfkill_set_sw_state(tp_rfk->rfkill,
1182 (status == TPACPI_RFK_RADIO_OFF));
1187 /* Query FW and update rfkill sw state for all rfkill switches */
1188 static void tpacpi_rfk_update_swstate_all(void)
1192 for (i = 0; i < TPACPI_RFK_SW_MAX; i++)
1193 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[i]);
1197 * Sync the HW-blocking state of all rfkill switches,
1198 * do notice it causes the rfkill core to schedule uevents
1200 static void tpacpi_rfk_update_hwblock_state(bool blocked)
1203 struct tpacpi_rfk *tp_rfk;
1205 for (i = 0; i < TPACPI_RFK_SW_MAX; i++) {
1206 tp_rfk = tpacpi_rfkill_switches[i];
1208 if (rfkill_set_hw_state(tp_rfk->rfkill,
1210 /* ignore -- we track sw block */
1216 /* Call to get the WLSW state from the firmware */
1217 static int hotkey_get_wlsw(void);
1219 /* Call to query WLSW state and update all rfkill switches */
1220 static bool tpacpi_rfk_check_hwblock_state(void)
1222 int res = hotkey_get_wlsw();
1225 /* When unknown or unsupported, we have to assume it is unblocked */
1229 hw_blocked = (res == TPACPI_RFK_RADIO_OFF);
1230 tpacpi_rfk_update_hwblock_state(hw_blocked);
1235 static int tpacpi_rfk_hook_set_block(void *data, bool blocked)
1237 struct tpacpi_rfk *tp_rfk = data;
1240 dbg_printk(TPACPI_DBG_RFKILL,
1241 "request to change radio state to %s\n",
1242 blocked ? "blocked" : "unblocked");
1244 /* try to set radio state */
1245 res = (tp_rfk->ops->set_status)(blocked ?
1246 TPACPI_RFK_RADIO_OFF : TPACPI_RFK_RADIO_ON);
1248 /* and update the rfkill core with whatever the FW really did */
1249 tpacpi_rfk_update_swstate(tp_rfk);
1251 return (res < 0) ? res : 0;
1254 static const struct rfkill_ops tpacpi_rfk_rfkill_ops = {
1255 .set_block = tpacpi_rfk_hook_set_block,
1258 static int __init tpacpi_new_rfkill(const enum tpacpi_rfk_id id,
1259 const struct tpacpi_rfk_ops *tp_rfkops,
1260 const enum rfkill_type rfktype,
1262 const bool set_default)
1264 struct tpacpi_rfk *atp_rfk;
1266 bool sw_state = false;
1269 BUG_ON(id >= TPACPI_RFK_SW_MAX || tpacpi_rfkill_switches[id]);
1271 atp_rfk = kzalloc(sizeof(struct tpacpi_rfk), GFP_KERNEL);
1273 atp_rfk->rfkill = rfkill_alloc(name,
1276 &tpacpi_rfk_rfkill_ops,
1278 if (!atp_rfk || !atp_rfk->rfkill) {
1280 "failed to allocate memory for rfkill class\n");
1286 atp_rfk->ops = tp_rfkops;
1288 sw_status = (tp_rfkops->get_status)();
1289 if (sw_status < 0) {
1291 "failed to read initial state for %s, error %d\n",
1294 sw_state = (sw_status == TPACPI_RFK_RADIO_OFF);
1296 /* try to keep the initial state, since we ask the
1297 * firmware to preserve it across S5 in NVRAM */
1298 rfkill_init_sw_state(atp_rfk->rfkill, sw_state);
1301 rfkill_set_hw_state(atp_rfk->rfkill, tpacpi_rfk_check_hwblock_state());
1303 res = rfkill_register(atp_rfk->rfkill);
1306 "failed to register %s rfkill switch: %d\n",
1308 rfkill_destroy(atp_rfk->rfkill);
1313 tpacpi_rfkill_switches[id] = atp_rfk;
1317 static void tpacpi_destroy_rfkill(const enum tpacpi_rfk_id id)
1319 struct tpacpi_rfk *tp_rfk;
1321 BUG_ON(id >= TPACPI_RFK_SW_MAX);
1323 tp_rfk = tpacpi_rfkill_switches[id];
1325 rfkill_unregister(tp_rfk->rfkill);
1326 rfkill_destroy(tp_rfk->rfkill);
1327 tpacpi_rfkill_switches[id] = NULL;
1332 static void printk_deprecated_rfkill_attribute(const char * const what)
1334 printk_deprecated_attribute(what,
1335 "Please switch to generic rfkill before year 2010");
1338 /* sysfs <radio> enable ------------------------------------------------ */
1339 static ssize_t tpacpi_rfk_sysfs_enable_show(const enum tpacpi_rfk_id id,
1340 struct device_attribute *attr,
1345 printk_deprecated_rfkill_attribute(attr->attr.name);
1347 /* This is in the ABI... */
1348 if (tpacpi_rfk_check_hwblock_state()) {
1349 status = TPACPI_RFK_RADIO_OFF;
1351 status = tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1356 return snprintf(buf, PAGE_SIZE, "%d\n",
1357 (status == TPACPI_RFK_RADIO_ON) ? 1 : 0);
1360 static ssize_t tpacpi_rfk_sysfs_enable_store(const enum tpacpi_rfk_id id,
1361 struct device_attribute *attr,
1362 const char *buf, size_t count)
1367 printk_deprecated_rfkill_attribute(attr->attr.name);
1369 if (parse_strtoul(buf, 1, &t))
1372 tpacpi_disclose_usertask(attr->attr.name, "set to %ld\n", t);
1374 /* This is in the ABI... */
1375 if (tpacpi_rfk_check_hwblock_state() && !!t)
1378 res = tpacpi_rfkill_switches[id]->ops->set_status((!!t) ?
1379 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF);
1380 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1382 return (res < 0) ? res : count;
1385 /* procfs -------------------------------------------------------------- */
1386 static int tpacpi_rfk_procfs_read(const enum tpacpi_rfk_id id, char *p)
1390 if (id >= TPACPI_RFK_SW_MAX)
1391 len += sprintf(p + len, "status:\t\tnot supported\n");
1395 /* This is in the ABI... */
1396 if (tpacpi_rfk_check_hwblock_state()) {
1397 status = TPACPI_RFK_RADIO_OFF;
1399 status = tpacpi_rfk_update_swstate(
1400 tpacpi_rfkill_switches[id]);
1405 len += sprintf(p + len, "status:\t\t%s\n",
1406 (status == TPACPI_RFK_RADIO_ON) ?
1407 "enabled" : "disabled");
1408 len += sprintf(p + len, "commands:\tenable, disable\n");
1414 static int tpacpi_rfk_procfs_write(const enum tpacpi_rfk_id id, char *buf)
1420 if (id >= TPACPI_RFK_SW_MAX)
1423 while ((cmd = next_cmd(&buf))) {
1424 if (strlencmp(cmd, "enable") == 0)
1425 status = TPACPI_RFK_RADIO_ON;
1426 else if (strlencmp(cmd, "disable") == 0)
1427 status = TPACPI_RFK_RADIO_OFF;
1433 tpacpi_disclose_usertask("procfs", "attempt to %s %s\n",
1434 (status == TPACPI_RFK_RADIO_ON) ?
1435 "enable" : "disable",
1436 tpacpi_rfkill_names[id]);
1437 res = (tpacpi_rfkill_switches[id]->ops->set_status)(status);
1438 tpacpi_rfk_update_swstate(tpacpi_rfkill_switches[id]);
1444 /*************************************************************************
1445 * thinkpad-acpi driver attributes
1448 /* interface_version --------------------------------------------------- */
1449 static ssize_t tpacpi_driver_interface_version_show(
1450 struct device_driver *drv,
1453 return snprintf(buf, PAGE_SIZE, "0x%08x\n", TPACPI_SYSFS_VERSION);
1456 static DRIVER_ATTR(interface_version, S_IRUGO,
1457 tpacpi_driver_interface_version_show, NULL);
1459 /* debug_level --------------------------------------------------------- */
1460 static ssize_t tpacpi_driver_debug_show(struct device_driver *drv,
1463 return snprintf(buf, PAGE_SIZE, "0x%04x\n", dbg_level);
1466 static ssize_t tpacpi_driver_debug_store(struct device_driver *drv,
1467 const char *buf, size_t count)
1471 if (parse_strtoul(buf, 0xffff, &t))
1479 static DRIVER_ATTR(debug_level, S_IWUSR | S_IRUGO,
1480 tpacpi_driver_debug_show, tpacpi_driver_debug_store);
1482 /* version ------------------------------------------------------------- */
1483 static ssize_t tpacpi_driver_version_show(struct device_driver *drv,
1486 return snprintf(buf, PAGE_SIZE, "%s v%s\n",
1487 TPACPI_DESC, TPACPI_VERSION);
1490 static DRIVER_ATTR(version, S_IRUGO,
1491 tpacpi_driver_version_show, NULL);
1493 /* --------------------------------------------------------------------- */
1495 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1497 /* wlsw_emulstate ------------------------------------------------------ */
1498 static ssize_t tpacpi_driver_wlsw_emulstate_show(struct device_driver *drv,
1501 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wlsw_emulstate);
1504 static ssize_t tpacpi_driver_wlsw_emulstate_store(struct device_driver *drv,
1505 const char *buf, size_t count)
1509 if (parse_strtoul(buf, 1, &t))
1512 if (tpacpi_wlsw_emulstate != !!t) {
1513 tpacpi_wlsw_emulstate = !!t;
1514 tpacpi_rfk_update_hwblock_state(!t); /* negative logic */
1520 static DRIVER_ATTR(wlsw_emulstate, S_IWUSR | S_IRUGO,
1521 tpacpi_driver_wlsw_emulstate_show,
1522 tpacpi_driver_wlsw_emulstate_store);
1524 /* bluetooth_emulstate ------------------------------------------------- */
1525 static ssize_t tpacpi_driver_bluetooth_emulstate_show(
1526 struct device_driver *drv,
1529 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_bluetooth_emulstate);
1532 static ssize_t tpacpi_driver_bluetooth_emulstate_store(
1533 struct device_driver *drv,
1534 const char *buf, size_t count)
1538 if (parse_strtoul(buf, 1, &t))
1541 tpacpi_bluetooth_emulstate = !!t;
1546 static DRIVER_ATTR(bluetooth_emulstate, S_IWUSR | S_IRUGO,
1547 tpacpi_driver_bluetooth_emulstate_show,
1548 tpacpi_driver_bluetooth_emulstate_store);
1550 /* wwan_emulstate ------------------------------------------------- */
1551 static ssize_t tpacpi_driver_wwan_emulstate_show(
1552 struct device_driver *drv,
1555 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_wwan_emulstate);
1558 static ssize_t tpacpi_driver_wwan_emulstate_store(
1559 struct device_driver *drv,
1560 const char *buf, size_t count)
1564 if (parse_strtoul(buf, 1, &t))
1567 tpacpi_wwan_emulstate = !!t;
1572 static DRIVER_ATTR(wwan_emulstate, S_IWUSR | S_IRUGO,
1573 tpacpi_driver_wwan_emulstate_show,
1574 tpacpi_driver_wwan_emulstate_store);
1576 /* uwb_emulstate ------------------------------------------------- */
1577 static ssize_t tpacpi_driver_uwb_emulstate_show(
1578 struct device_driver *drv,
1581 return snprintf(buf, PAGE_SIZE, "%d\n", !!tpacpi_uwb_emulstate);
1584 static ssize_t tpacpi_driver_uwb_emulstate_store(
1585 struct device_driver *drv,
1586 const char *buf, size_t count)
1590 if (parse_strtoul(buf, 1, &t))
1593 tpacpi_uwb_emulstate = !!t;
1598 static DRIVER_ATTR(uwb_emulstate, S_IWUSR | S_IRUGO,
1599 tpacpi_driver_uwb_emulstate_show,
1600 tpacpi_driver_uwb_emulstate_store);
1603 /* --------------------------------------------------------------------- */
1605 static struct driver_attribute *tpacpi_driver_attributes[] = {
1606 &driver_attr_debug_level, &driver_attr_version,
1607 &driver_attr_interface_version,
1610 static int __init tpacpi_create_driver_attributes(struct device_driver *drv)
1616 while (!res && i < ARRAY_SIZE(tpacpi_driver_attributes)) {
1617 res = driver_create_file(drv, tpacpi_driver_attributes[i]);
1621 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
1622 if (!res && dbg_wlswemul)
1623 res = driver_create_file(drv, &driver_attr_wlsw_emulstate);
1624 if (!res && dbg_bluetoothemul)
1625 res = driver_create_file(drv, &driver_attr_bluetooth_emulstate);
1626 if (!res && dbg_wwanemul)
1627 res = driver_create_file(drv, &driver_attr_wwan_emulstate);
1628 if (!res && dbg_uwbemul)
1629 res = driver_create_file(drv, &driver_attr_uwb_emulstate);
1635 static void tpacpi_remove_driver_attributes(struct device_driver *drv)
1639 for (i = 0; i < ARRAY_SIZE(tpacpi_driver_attributes); i++)
1640 driver_remove_file(drv, tpacpi_driver_attributes[i]);
1642 #ifdef THINKPAD_ACPI_DEBUGFACILITIES
1643 driver_remove_file(drv, &driver_attr_wlsw_emulstate);
1644 driver_remove_file(drv, &driver_attr_bluetooth_emulstate);
1645 driver_remove_file(drv, &driver_attr_wwan_emulstate);
1646 driver_remove_file(drv, &driver_attr_uwb_emulstate);
1650 /*************************************************************************
1655 * Table of recommended minimum BIOS versions
1657 * Reasons for listing:
1658 * 1. Stable BIOS, listed because the unknown ammount of
1659 * bugs and bad ACPI behaviour on older versions
1661 * 2. BIOS or EC fw with known bugs that trigger on Linux
1663 * 3. BIOS with known reduced functionality in older versions
1665 * We recommend the latest BIOS and EC version.
1666 * We only support the latest BIOS and EC fw version as a rule.
1668 * Sources: IBM ThinkPad Public Web Documents (update changelogs),
1669 * Information from users in ThinkWiki
1671 * WARNING: we use this table also to detect that the machine is
1672 * a ThinkPad in some cases, so don't remove entries lightly.
1675 #define TPV_Q(__v, __id1, __id2, __bv1, __bv2) \
1676 { .vendor = (__v), \
1677 .bios = TPID(__id1, __id2), \
1678 .ec = TPACPI_MATCH_ANY, \
1679 .quirks = TPACPI_MATCH_ANY << 16 \
1680 | (__bv1) << 8 | (__bv2) }
1682 #define TPV_Q_X(__v, __bid1, __bid2, __bv1, __bv2, \
1683 __eid1, __eid2, __ev1, __ev2) \
1684 { .vendor = (__v), \
1685 .bios = TPID(__bid1, __bid2), \
1686 .ec = TPID(__eid1, __eid2), \
1687 .quirks = (__ev1) << 24 | (__ev2) << 16 \
1688 | (__bv1) << 8 | (__bv2) }
1690 #define TPV_QI0(__id1, __id2, __bv1, __bv2) \
1691 TPV_Q(PCI_VENDOR_ID_IBM, __id1, __id2, __bv1, __bv2)
1693 #define TPV_QI1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1694 TPV_Q_X(PCI_VENDOR_ID_IBM, __id1, __id2, \
1695 __bv1, __bv2, __id1, __id2, __ev1, __ev2)
1697 #define TPV_QI2(__bid1, __bid2, __bv1, __bv2, \
1698 __eid1, __eid2, __ev1, __ev2) \
1699 TPV_Q_X(PCI_VENDOR_ID_IBM, __bid1, __bid2, \
1700 __bv1, __bv2, __eid1, __eid2, __ev1, __ev2)
1702 #define TPV_QL0(__id1, __id2, __bv1, __bv2) \
1703 TPV_Q(PCI_VENDOR_ID_LENOVO, __id1, __id2, __bv1, __bv2)
1705 #define TPV_QL1(__id1, __id2, __bv1, __bv2, __ev1, __ev2) \
1706 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __id1, __id2, \
1707 __bv1, __bv2, __id1, __id2, __ev1, __ev2)
1709 #define TPV_QL2(__bid1, __bid2, __bv1, __bv2, \
1710 __eid1, __eid2, __ev1, __ev2) \
1711 TPV_Q_X(PCI_VENDOR_ID_LENOVO, __bid1, __bid2, \
1712 __bv1, __bv2, __eid1, __eid2, __ev1, __ev2)
1714 static const struct tpacpi_quirk tpacpi_bios_version_qtable[] __initconst = {
1715 /* Numeric models ------------------ */
1716 /* FW MODEL BIOS VERS */
1717 TPV_QI0('I', 'M', '6', '5'), /* 570 */
1718 TPV_QI0('I', 'U', '2', '6'), /* 570E */
1719 TPV_QI0('I', 'B', '5', '4'), /* 600 */
1720 TPV_QI0('I', 'H', '4', '7'), /* 600E */
1721 TPV_QI0('I', 'N', '3', '6'), /* 600E */
1722 TPV_QI0('I', 'T', '5', '5'), /* 600X */
1723 TPV_QI0('I', 'D', '4', '8'), /* 770, 770E, 770ED */
1724 TPV_QI0('I', 'I', '4', '2'), /* 770X */
1725 TPV_QI0('I', 'O', '2', '3'), /* 770Z */
1727 /* A-series ------------------------- */
1728 /* FW MODEL BIOS VERS EC VERS */
1729 TPV_QI0('I', 'W', '5', '9'), /* A20m */
1730 TPV_QI0('I', 'V', '6', '9'), /* A20p */
1731 TPV_QI0('1', '0', '2', '6'), /* A21e, A22e */
1732 TPV_QI0('K', 'U', '3', '6'), /* A21e */
1733 TPV_QI0('K', 'X', '3', '6'), /* A21m, A22m */
1734 TPV_QI0('K', 'Y', '3', '8'), /* A21p, A22p */
1735 TPV_QI0('1', 'B', '1', '7'), /* A22e */
1736 TPV_QI0('1', '3', '2', '0'), /* A22m */
1737 TPV_QI0('1', 'E', '7', '3'), /* A30/p (0) */
1738 TPV_QI1('1', 'G', '4', '1', '1', '7'), /* A31/p (0) */
1739 TPV_QI1('1', 'N', '1', '6', '0', '7'), /* A31/p (0) */
1741 /* G-series ------------------------- */
1742 /* FW MODEL BIOS VERS */
1743 TPV_QI0('1', 'T', 'A', '6'), /* G40 */
1744 TPV_QI0('1', 'X', '5', '7'), /* G41 */
1746 /* R-series, T-series --------------- */
1747 /* FW MODEL BIOS VERS EC VERS */
1748 TPV_QI0('1', 'C', 'F', '0'), /* R30 */
1749 TPV_QI0('1', 'F', 'F', '1'), /* R31 */
1750 TPV_QI0('1', 'M', '9', '7'), /* R32 */
1751 TPV_QI0('1', 'O', '6', '1'), /* R40 */
1752 TPV_QI0('1', 'P', '6', '5'), /* R40 */
1753 TPV_QI0('1', 'S', '7', '0'), /* R40e */
1754 TPV_QI1('1', 'R', 'D', 'R', '7', '1'), /* R50/p, R51,
1755 T40/p, T41/p, T42/p (1) */
1756 TPV_QI1('1', 'V', '7', '1', '2', '8'), /* R50e, R51 (1) */
1757 TPV_QI1('7', '8', '7', '1', '0', '6'), /* R51e (1) */
1758 TPV_QI1('7', '6', '6', '9', '1', '6'), /* R52 (1) */
1759 TPV_QI1('7', '0', '6', '9', '2', '8'), /* R52, T43 (1) */
1761 TPV_QI0('I', 'Y', '6', '1'), /* T20 */
1762 TPV_QI0('K', 'Z', '3', '4'), /* T21 */
1763 TPV_QI0('1', '6', '3', '2'), /* T22 */
1764 TPV_QI1('1', 'A', '6', '4', '2', '3'), /* T23 (0) */
1765 TPV_QI1('1', 'I', '7', '1', '2', '0'), /* T30 (0) */
1766 TPV_QI1('1', 'Y', '6', '5', '2', '9'), /* T43/p (1) */
1768 TPV_QL1('7', '9', 'E', '3', '5', '0'), /* T60/p */
1769 TPV_QL1('7', 'C', 'D', '2', '2', '2'), /* R60, R60i */
1770 TPV_QL0('7', 'E', 'D', '0'), /* R60e, R60i */
1772 /* BIOS FW BIOS VERS EC FW EC VERS */
1773 TPV_QI2('1', 'W', '9', '0', '1', 'V', '2', '8'), /* R50e (1) */
1774 TPV_QL2('7', 'I', '3', '4', '7', '9', '5', '0'), /* T60/p wide */
1776 /* X-series ------------------------- */
1777 /* FW MODEL BIOS VERS EC VERS */
1778 TPV_QI0('I', 'Z', '9', 'D'), /* X20, X21 */
1779 TPV_QI0('1', 'D', '7', '0'), /* X22, X23, X24 */
1780 TPV_QI1('1', 'K', '4', '8', '1', '8'), /* X30 (0) */
1781 TPV_QI1('1', 'Q', '9', '7', '2', '3'), /* X31, X32 (0) */
1782 TPV_QI1('1', 'U', 'D', '3', 'B', '2'), /* X40 (0) */
1783 TPV_QI1('7', '4', '6', '4', '2', '7'), /* X41 (0) */
1784 TPV_QI1('7', '5', '6', '0', '2', '0'), /* X41t (0) */
1786 TPV_QL0('7', 'B', 'D', '7'), /* X60/s */
1787 TPV_QL0('7', 'J', '3', '0'), /* X60t */
1789 /* (0) - older versions lack DMI EC fw string and functionality */
1790 /* (1) - older versions known to lack functionality */
1801 static void __init tpacpi_check_outdated_fw(void)
1803 unsigned long fwvers;
1804 u16 ec_version, bios_version;
1806 fwvers = tpacpi_check_quirks(tpacpi_bios_version_qtable,
1807 ARRAY_SIZE(tpacpi_bios_version_qtable));
1812 bios_version = fwvers & 0xffffU;
1813 ec_version = (fwvers >> 16) & 0xffffU;
1815 /* note that unknown versions are set to 0x0000 and we use that */
1816 if ((bios_version > thinkpad_id.bios_release) ||
1817 (ec_version > thinkpad_id.ec_release &&
1818 ec_version != TPACPI_MATCH_ANY)) {
1820 * The changelogs would let us track down the exact
1821 * reason, but it is just too much of a pain to track
1822 * it. We only list BIOSes that are either really
1823 * broken, or really stable to begin with, so it is
1824 * best if the user upgrades the firmware anyway.
1827 "WARNING: Outdated ThinkPad BIOS/EC firmware\n");
1829 "WARNING: This firmware may be missing critical bug "
1830 "fixes and/or important features\n");
1834 static bool __init tpacpi_is_fw_known(void)
1836 return tpacpi_check_quirks(tpacpi_bios_version_qtable,
1837 ARRAY_SIZE(tpacpi_bios_version_qtable)) != 0;
1840 /****************************************************************************
1841 ****************************************************************************
1845 ****************************************************************************
1846 ****************************************************************************/
1848 /*************************************************************************
1849 * thinkpad-acpi init subdriver
1852 static int __init thinkpad_acpi_driver_init(struct ibm_init_struct *iibm)
1854 printk(TPACPI_INFO "%s v%s\n", TPACPI_DESC, TPACPI_VERSION);
1855 printk(TPACPI_INFO "%s\n", TPACPI_URL);
1857 printk(TPACPI_INFO "ThinkPad BIOS %s, EC %s\n",
1858 (thinkpad_id.bios_version_str) ?
1859 thinkpad_id.bios_version_str : "unknown",
1860 (thinkpad_id.ec_version_str) ?
1861 thinkpad_id.ec_version_str : "unknown");
1863 if (thinkpad_id.vendor && thinkpad_id.model_str)
1864 printk(TPACPI_INFO "%s %s, model %s\n",
1865 (thinkpad_id.vendor == PCI_VENDOR_ID_IBM) ?
1866 "IBM" : ((thinkpad_id.vendor ==
1867 PCI_VENDOR_ID_LENOVO) ?
1868 "Lenovo" : "Unknown vendor"),
1869 thinkpad_id.model_str,
1870 (thinkpad_id.nummodel_str) ?
1871 thinkpad_id.nummodel_str : "unknown");
1873 tpacpi_check_outdated_fw();
1877 static int thinkpad_acpi_driver_read(char *p)
1881 len += sprintf(p + len, "driver:\t\t%s\n", TPACPI_DESC);
1882 len += sprintf(p + len, "version:\t%s\n", TPACPI_VERSION);
1887 static struct ibm_struct thinkpad_acpi_driver_data = {
1889 .read = thinkpad_acpi_driver_read,
1892 /*************************************************************************
1897 * ThinkPad firmware event model
1899 * The ThinkPad firmware has two main event interfaces: normal ACPI
1900 * notifications (which follow the ACPI standard), and a private event
1903 * The private event interface also issues events for the hotkeys. As
1904 * the driver gained features, the event handling code ended up being
1905 * built around the hotkey subdriver. This will need to be refactored
1906 * to a more formal event API eventually.
1908 * Some "hotkeys" are actually supposed to be used as event reports,
1909 * such as "brightness has changed", "volume has changed", depending on
1910 * the ThinkPad model and how the firmware is operating.
1912 * Unlike other classes, hotkey-class events have mask/unmask control on
1913 * non-ancient firmware. However, how it behaves changes a lot with the
1914 * firmware model and version.
1917 enum { /* hot key scan codes (derived from ACPI DSDT) */
1918 TP_ACPI_HOTKEYSCAN_FNF1 = 0,
1919 TP_ACPI_HOTKEYSCAN_FNF2,
1920 TP_ACPI_HOTKEYSCAN_FNF3,
1921 TP_ACPI_HOTKEYSCAN_FNF4,
1922 TP_ACPI_HOTKEYSCAN_FNF5,
1923 TP_ACPI_HOTKEYSCAN_FNF6,
1924 TP_ACPI_HOTKEYSCAN_FNF7,
1925 TP_ACPI_HOTKEYSCAN_FNF8,
1926 TP_ACPI_HOTKEYSCAN_FNF9,
1927 TP_ACPI_HOTKEYSCAN_FNF10,
1928 TP_ACPI_HOTKEYSCAN_FNF11,
1929 TP_ACPI_HOTKEYSCAN_FNF12,
1930 TP_ACPI_HOTKEYSCAN_FNBACKSPACE,
1931 TP_ACPI_HOTKEYSCAN_FNINSERT,
1932 TP_ACPI_HOTKEYSCAN_FNDELETE,
1933 TP_ACPI_HOTKEYSCAN_FNHOME,
1934 TP_ACPI_HOTKEYSCAN_FNEND,
1935 TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1936 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN,
1937 TP_ACPI_HOTKEYSCAN_FNSPACE,
1938 TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1939 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1940 TP_ACPI_HOTKEYSCAN_MUTE,
1941 TP_ACPI_HOTKEYSCAN_THINKPAD,
1944 enum { /* Keys/events available through NVRAM polling */
1945 TPACPI_HKEY_NVRAM_KNOWN_MASK = 0x00fb88c0U,
1946 TPACPI_HKEY_NVRAM_GOOD_MASK = 0x00fb8000U,
1949 enum { /* Positions of some of the keys in hotkey masks */
1950 TP_ACPI_HKEY_DISPSWTCH_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF7,
1951 TP_ACPI_HKEY_DISPXPAND_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF8,
1952 TP_ACPI_HKEY_HIBERNATE_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNF12,
1953 TP_ACPI_HKEY_BRGHTUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNHOME,
1954 TP_ACPI_HKEY_BRGHTDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNEND,
1955 TP_ACPI_HKEY_THNKLGHT_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNPAGEUP,
1956 TP_ACPI_HKEY_ZOOM_MASK = 1 << TP_ACPI_HOTKEYSCAN_FNSPACE,
1957 TP_ACPI_HKEY_VOLUP_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEUP,
1958 TP_ACPI_HKEY_VOLDWN_MASK = 1 << TP_ACPI_HOTKEYSCAN_VOLUMEDOWN,
1959 TP_ACPI_HKEY_MUTE_MASK = 1 << TP_ACPI_HOTKEYSCAN_MUTE,
1960 TP_ACPI_HKEY_THINKPAD_MASK = 1 << TP_ACPI_HOTKEYSCAN_THINKPAD,
1963 enum { /* NVRAM to ACPI HKEY group map */
1964 TP_NVRAM_HKEY_GROUP_HK2 = TP_ACPI_HKEY_THINKPAD_MASK |
1965 TP_ACPI_HKEY_ZOOM_MASK |
1966 TP_ACPI_HKEY_DISPSWTCH_MASK |
1967 TP_ACPI_HKEY_HIBERNATE_MASK,
1968 TP_NVRAM_HKEY_GROUP_BRIGHTNESS = TP_ACPI_HKEY_BRGHTUP_MASK |
1969 TP_ACPI_HKEY_BRGHTDWN_MASK,
1970 TP_NVRAM_HKEY_GROUP_VOLUME = TP_ACPI_HKEY_VOLUP_MASK |
1971 TP_ACPI_HKEY_VOLDWN_MASK |
1972 TP_ACPI_HKEY_MUTE_MASK,
1975 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
1976 struct tp_nvram_state {
1977 u16 thinkpad_toggle:1;
1979 u16 display_toggle:1;
1980 u16 thinklight_toggle:1;
1981 u16 hibernate_toggle:1;
1982 u16 displayexp_toggle:1;
1983 u16 display_state:1;
1984 u16 brightness_toggle:1;
1985 u16 volume_toggle:1;
1988 u8 brightness_level;
1992 /* kthread for the hotkey poller */
1993 static struct task_struct *tpacpi_hotkey_task;
1995 /* Acquired while the poller kthread is running, use to sync start/stop */
1996 static struct mutex hotkey_thread_mutex;
1999 * Acquire mutex to write poller control variables as an
2002 * Increment hotkey_config_change when changing them if you
2003 * want the kthread to forget old state.
2005 * See HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2007 static struct mutex hotkey_thread_data_mutex;
2008 static unsigned int hotkey_config_change;
2011 * hotkey poller control variables
2013 * Must be atomic or readers will also need to acquire mutex
2015 * HOTKEY_CONFIG_CRITICAL_START/HOTKEY_CONFIG_CRITICAL_END
2016 * should be used only when the changes need to be taken as
2017 * a block, OR when one needs to force the kthread to forget
2020 static u32 hotkey_source_mask; /* bit mask 0=ACPI,1=NVRAM */
2021 static unsigned int hotkey_poll_freq = 10; /* Hz */
2023 #define HOTKEY_CONFIG_CRITICAL_START \
2025 mutex_lock(&hotkey_thread_data_mutex); \
2026 hotkey_config_change++; \
2028 #define HOTKEY_CONFIG_CRITICAL_END \
2029 mutex_unlock(&hotkey_thread_data_mutex);
2031 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2033 #define hotkey_source_mask 0U
2034 #define HOTKEY_CONFIG_CRITICAL_START
2035 #define HOTKEY_CONFIG_CRITICAL_END
2037 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2039 static struct mutex hotkey_mutex;
2041 static enum { /* Reasons for waking up */
2042 TP_ACPI_WAKEUP_NONE = 0, /* None or unknown */
2043 TP_ACPI_WAKEUP_BAYEJ, /* Bay ejection request */
2044 TP_ACPI_WAKEUP_UNDOCK, /* Undock request */
2045 } hotkey_wakeup_reason;
2047 static int hotkey_autosleep_ack;
2049 static u32 hotkey_orig_mask; /* events the BIOS had enabled */
2050 static u32 hotkey_all_mask; /* all events supported in fw */
2051 static u32 hotkey_reserved_mask; /* events better left disabled */
2052 static u32 hotkey_driver_mask; /* events needed by the driver */
2053 static u32 hotkey_user_mask; /* events visible to userspace */
2054 static u32 hotkey_acpi_mask; /* events enabled in firmware */
2056 static unsigned int hotkey_report_mode;
2058 static u16 *hotkey_keycode_map;
2060 static struct attribute_set *hotkey_dev_attributes;
2062 static void tpacpi_driver_event(const unsigned int hkey_event);
2063 static void hotkey_driver_event(const unsigned int scancode);
2065 /* HKEY.MHKG() return bits */
2066 #define TP_HOTKEY_TABLET_MASK (1 << 3)
2068 static int hotkey_get_wlsw(void)
2072 if (!tp_features.hotkey_wlsw)
2075 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
2077 return (tpacpi_wlsw_emulstate) ?
2078 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2081 if (!acpi_evalf(hkey_handle, &status, "WLSW", "d"))
2084 return (status) ? TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
2087 static int hotkey_get_tablet_mode(int *status)
2091 if (!acpi_evalf(hkey_handle, &s, "MHKG", "d"))
2094 *status = ((s & TP_HOTKEY_TABLET_MASK) != 0);
2099 * Reads current event mask from firmware, and updates
2100 * hotkey_acpi_mask accordingly. Also resets any bits
2101 * from hotkey_user_mask that are unavailable to be
2102 * delivered (shadow requirement of the userspace ABI).
2104 * Call with hotkey_mutex held
2106 static int hotkey_mask_get(void)
2108 if (tp_features.hotkey_mask) {
2111 if (!acpi_evalf(hkey_handle, &m, "DHKN", "d"))
2114 hotkey_acpi_mask = m;
2116 /* no mask support doesn't mean no event support... */
2117 hotkey_acpi_mask = hotkey_all_mask;
2120 /* sync userspace-visible mask */
2121 hotkey_user_mask &= (hotkey_acpi_mask | hotkey_source_mask);
2126 void static hotkey_mask_warn_incomplete_mask(void)
2128 /* log only what the user can fix... */
2129 const u32 wantedmask = hotkey_driver_mask &
2130 ~(hotkey_acpi_mask | hotkey_source_mask) &
2131 (hotkey_all_mask | TPACPI_HKEY_NVRAM_KNOWN_MASK);
2134 printk(TPACPI_NOTICE
2135 "required events 0x%08x not enabled!\n",
2140 * Set the firmware mask when supported
2142 * Also calls hotkey_mask_get to update hotkey_acpi_mask.
2144 * NOTE: does not set bits in hotkey_user_mask, but may reset them.
2146 * Call with hotkey_mutex held
2148 static int hotkey_mask_set(u32 mask)
2153 const u32 fwmask = mask & ~hotkey_source_mask;
2155 if (tp_features.hotkey_mask) {
2156 for (i = 0; i < 32; i++) {
2157 if (!acpi_evalf(hkey_handle,
2158 NULL, "MHKM", "vdd", i + 1,
2159 !!(mask & (1 << i)))) {
2167 * We *must* make an inconditional call to hotkey_mask_get to
2168 * refresh hotkey_acpi_mask and update hotkey_user_mask
2170 * Take the opportunity to also log when we cannot _enable_
2173 if (!hotkey_mask_get() && !rc && (fwmask & ~hotkey_acpi_mask)) {
2174 printk(TPACPI_NOTICE
2175 "asked for hotkey mask 0x%08x, but "
2176 "firmware forced it to 0x%08x\n",
2177 fwmask, hotkey_acpi_mask);
2180 hotkey_mask_warn_incomplete_mask();
2186 * Sets hotkey_user_mask and tries to set the firmware mask
2188 * Call with hotkey_mutex held
2190 static int hotkey_user_mask_set(const u32 mask)
2194 /* Give people a chance to notice they are doing something that
2195 * is bound to go boom on their users sooner or later */
2196 if (!tp_warned.hotkey_mask_ff &&
2197 (mask == 0xffff || mask == 0xffffff ||
2198 mask == 0xffffffff)) {
2199 tp_warned.hotkey_mask_ff = 1;
2200 printk(TPACPI_NOTICE
2201 "setting the hotkey mask to 0x%08x is likely "
2202 "not the best way to go about it\n", mask);
2203 printk(TPACPI_NOTICE
2204 "please consider using the driver defaults, "
2205 "and refer to up-to-date thinkpad-acpi "
2209 /* Try to enable what the user asked for, plus whatever we need.
2210 * this syncs everything but won't enable bits in hotkey_user_mask */
2211 rc = hotkey_mask_set((mask | hotkey_driver_mask) & ~hotkey_source_mask);
2213 /* Enable the available bits in hotkey_user_mask */
2214 hotkey_user_mask = mask & (hotkey_acpi_mask | hotkey_source_mask);
2220 * Sets the driver hotkey mask.
2222 * Can be called even if the hotkey subdriver is inactive
2224 static int tpacpi_hotkey_driver_mask_set(const u32 mask)
2228 /* Do the right thing if hotkey_init has not been called yet */
2229 if (!tp_features.hotkey) {
2230 hotkey_driver_mask = mask;
2234 mutex_lock(&hotkey_mutex);
2236 HOTKEY_CONFIG_CRITICAL_START
2237 hotkey_driver_mask = mask;
2238 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2239 hotkey_source_mask |= (mask & ~hotkey_all_mask);
2241 HOTKEY_CONFIG_CRITICAL_END
2243 rc = hotkey_mask_set((hotkey_acpi_mask | hotkey_driver_mask) &
2244 ~hotkey_source_mask);
2245 mutex_unlock(&hotkey_mutex);
2250 static int hotkey_status_get(int *status)
2252 if (!acpi_evalf(hkey_handle, status, "DHKC", "d"))
2258 static int hotkey_status_set(bool enable)
2260 if (!acpi_evalf(hkey_handle, NULL, "MHKC", "vd", enable ? 1 : 0))
2266 static void tpacpi_input_send_tabletsw(void)
2270 if (tp_features.hotkey_tablet &&
2271 !hotkey_get_tablet_mode(&state)) {
2272 mutex_lock(&tpacpi_inputdev_send_mutex);
2274 input_report_switch(tpacpi_inputdev,
2275 SW_TABLET_MODE, !!state);
2276 input_sync(tpacpi_inputdev);
2278 mutex_unlock(&tpacpi_inputdev_send_mutex);
2282 /* Do NOT call without validating scancode first */
2283 static void tpacpi_input_send_key(const unsigned int scancode)
2285 const unsigned int keycode = hotkey_keycode_map[scancode];
2287 if (keycode != KEY_RESERVED) {
2288 mutex_lock(&tpacpi_inputdev_send_mutex);
2290 input_report_key(tpacpi_inputdev, keycode, 1);
2291 if (keycode == KEY_UNKNOWN)
2292 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2294 input_sync(tpacpi_inputdev);
2296 input_report_key(tpacpi_inputdev, keycode, 0);
2297 if (keycode == KEY_UNKNOWN)
2298 input_event(tpacpi_inputdev, EV_MSC, MSC_SCAN,
2300 input_sync(tpacpi_inputdev);
2302 mutex_unlock(&tpacpi_inputdev_send_mutex);
2306 /* Do NOT call without validating scancode first */
2307 static void tpacpi_input_send_key_masked(const unsigned int scancode)
2309 hotkey_driver_event(scancode);
2310 if (hotkey_user_mask & (1 << scancode))
2311 tpacpi_input_send_key(scancode);
2314 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2315 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver;
2317 /* Do NOT call without validating scancode first */
2318 static void tpacpi_hotkey_send_key(unsigned int scancode)
2320 tpacpi_input_send_key_masked(scancode);
2321 if (hotkey_report_mode < 2) {
2322 acpi_bus_generate_proc_event(ibm_hotkey_acpidriver.device,
2323 0x80, TP_HKEY_EV_HOTKEY_BASE + scancode);
2327 static void hotkey_read_nvram(struct tp_nvram_state *n, const u32 m)
2331 if (m & TP_NVRAM_HKEY_GROUP_HK2) {
2332 d = nvram_read_byte(TP_NVRAM_ADDR_HK2);
2333 n->thinkpad_toggle = !!(d & TP_NVRAM_MASK_HKT_THINKPAD);
2334 n->zoom_toggle = !!(d & TP_NVRAM_MASK_HKT_ZOOM);
2335 n->display_toggle = !!(d & TP_NVRAM_MASK_HKT_DISPLAY);
2336 n->hibernate_toggle = !!(d & TP_NVRAM_MASK_HKT_HIBERNATE);
2338 if (m & TP_ACPI_HKEY_THNKLGHT_MASK) {
2339 d = nvram_read_byte(TP_NVRAM_ADDR_THINKLIGHT);
2340 n->thinklight_toggle = !!(d & TP_NVRAM_MASK_THINKLIGHT);
2342 if (m & TP_ACPI_HKEY_DISPXPAND_MASK) {
2343 d = nvram_read_byte(TP_NVRAM_ADDR_VIDEO);
2344 n->displayexp_toggle =
2345 !!(d & TP_NVRAM_MASK_HKT_DISPEXPND);
2347 if (m & TP_NVRAM_HKEY_GROUP_BRIGHTNESS) {
2348 d = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
2349 n->brightness_level = (d & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
2350 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
2351 n->brightness_toggle =
2352 !!(d & TP_NVRAM_MASK_HKT_BRIGHTNESS);
2354 if (m & TP_NVRAM_HKEY_GROUP_VOLUME) {
2355 d = nvram_read_byte(TP_NVRAM_ADDR_MIXER);
2356 n->volume_level = (d & TP_NVRAM_MASK_LEVEL_VOLUME)
2357 >> TP_NVRAM_POS_LEVEL_VOLUME;
2358 n->mute = !!(d & TP_NVRAM_MASK_MUTE);
2359 n->volume_toggle = !!(d & TP_NVRAM_MASK_HKT_VOLUME);
2363 static void hotkey_compare_and_issue_event(struct tp_nvram_state *oldn,
2364 struct tp_nvram_state *newn,
2365 const u32 event_mask)
2368 #define TPACPI_COMPARE_KEY(__scancode, __member) \
2370 if ((event_mask & (1 << __scancode)) && \
2371 oldn->__member != newn->__member) \
2372 tpacpi_hotkey_send_key(__scancode); \
2375 #define TPACPI_MAY_SEND_KEY(__scancode) \
2377 if (event_mask & (1 << __scancode)) \
2378 tpacpi_hotkey_send_key(__scancode); \
2381 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_THINKPAD, thinkpad_toggle);
2382 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNSPACE, zoom_toggle);
2383 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF7, display_toggle);
2384 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF12, hibernate_toggle);
2386 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNPAGEUP, thinklight_toggle);
2388 TPACPI_COMPARE_KEY(TP_ACPI_HOTKEYSCAN_FNF8, displayexp_toggle);
2391 if (oldn->volume_toggle != newn->volume_toggle) {
2392 if (oldn->mute != newn->mute) {
2393 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2395 if (oldn->volume_level > newn->volume_level) {
2396 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2397 } else if (oldn->volume_level < newn->volume_level) {
2398 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2399 } else if (oldn->mute == newn->mute) {
2400 /* repeated key presses that didn't change state */
2402 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_MUTE);
2403 } else if (newn->volume_level != 0) {
2404 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEUP);
2406 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_VOLUMEDOWN);
2411 /* handle brightness */
2412 if (oldn->brightness_toggle != newn->brightness_toggle) {
2413 if (oldn->brightness_level < newn->brightness_level) {
2414 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2415 } else if (oldn->brightness_level > newn->brightness_level) {
2416 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2418 /* repeated key presses that didn't change state */
2419 if (newn->brightness_level != 0) {
2420 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNHOME);
2422 TPACPI_MAY_SEND_KEY(TP_ACPI_HOTKEYSCAN_FNEND);
2427 #undef TPACPI_COMPARE_KEY
2428 #undef TPACPI_MAY_SEND_KEY
2434 * We track all events in hotkey_source_mask all the time, since
2435 * most of them are edge-based. We only issue those requested by
2436 * hotkey_user_mask or hotkey_driver_mask, though.
2438 static int hotkey_kthread(void *data)
2440 struct tp_nvram_state s[2];
2441 u32 poll_mask, event_mask;
2442 unsigned int si, so;
2444 unsigned int change_detector, must_reset;
2445 unsigned int poll_freq;
2447 mutex_lock(&hotkey_thread_mutex);
2449 if (tpacpi_lifecycle == TPACPI_LIFE_EXITING)
2458 /* Initial state for compares */
2459 mutex_lock(&hotkey_thread_data_mutex);
2460 change_detector = hotkey_config_change;
2461 poll_mask = hotkey_source_mask;
2462 event_mask = hotkey_source_mask &
2463 (hotkey_driver_mask | hotkey_user_mask);
2464 poll_freq = hotkey_poll_freq;
2465 mutex_unlock(&hotkey_thread_data_mutex);
2466 hotkey_read_nvram(&s[so], poll_mask);
2468 while (!kthread_should_stop()) {
2470 if (likely(poll_freq))
2473 t = 100; /* should never happen... */
2475 t = msleep_interruptible(t);
2476 if (unlikely(kthread_should_stop()))
2478 must_reset = try_to_freeze();
2479 if (t > 0 && !must_reset)
2482 mutex_lock(&hotkey_thread_data_mutex);
2483 if (must_reset || hotkey_config_change != change_detector) {
2484 /* forget old state on thaw or config change */
2487 change_detector = hotkey_config_change;
2489 poll_mask = hotkey_source_mask;
2490 event_mask = hotkey_source_mask &
2491 (hotkey_driver_mask | hotkey_user_mask);
2492 poll_freq = hotkey_poll_freq;
2493 mutex_unlock(&hotkey_thread_data_mutex);
2495 if (likely(poll_mask)) {
2496 hotkey_read_nvram(&s[si], poll_mask);
2497 if (likely(si != so)) {
2498 hotkey_compare_and_issue_event(&s[so], &s[si],
2508 mutex_unlock(&hotkey_thread_mutex);
2512 /* call with hotkey_mutex held */
2513 static void hotkey_poll_stop_sync(void)
2515 if (tpacpi_hotkey_task) {
2516 if (frozen(tpacpi_hotkey_task) ||
2517 freezing(tpacpi_hotkey_task))
2518 thaw_process(tpacpi_hotkey_task);
2520 kthread_stop(tpacpi_hotkey_task);
2521 tpacpi_hotkey_task = NULL;
2522 mutex_lock(&hotkey_thread_mutex);
2523 /* at this point, the thread did exit */
2524 mutex_unlock(&hotkey_thread_mutex);
2528 /* call with hotkey_mutex held */
2529 static void hotkey_poll_setup(bool may_warn)
2531 const u32 poll_driver_mask = hotkey_driver_mask & hotkey_source_mask;
2532 const u32 poll_user_mask = hotkey_user_mask & hotkey_source_mask;
2534 if (hotkey_poll_freq > 0 &&
2535 (poll_driver_mask ||
2536 (poll_user_mask && tpacpi_inputdev->users > 0))) {
2537 if (!tpacpi_hotkey_task) {
2538 tpacpi_hotkey_task = kthread_run(hotkey_kthread,
2539 NULL, TPACPI_NVRAM_KTHREAD_NAME);
2540 if (IS_ERR(tpacpi_hotkey_task)) {
2541 tpacpi_hotkey_task = NULL;
2543 "could not create kernel thread "
2544 "for hotkey polling\n");
2548 hotkey_poll_stop_sync();
2549 if (may_warn && (poll_driver_mask || poll_user_mask) &&
2550 hotkey_poll_freq == 0) {
2551 printk(TPACPI_NOTICE
2552 "hot keys 0x%08x and/or events 0x%08x "
2553 "require polling, which is currently "
2555 poll_user_mask, poll_driver_mask);
2560 static void hotkey_poll_setup_safe(bool may_warn)
2562 mutex_lock(&hotkey_mutex);
2563 hotkey_poll_setup(may_warn);
2564 mutex_unlock(&hotkey_mutex);
2567 /* call with hotkey_mutex held */
2568 static void hotkey_poll_set_freq(unsigned int freq)
2571 hotkey_poll_stop_sync();
2573 hotkey_poll_freq = freq;
2576 #else /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2578 static void hotkey_poll_setup_safe(bool __unused)
2582 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2584 static int hotkey_inputdev_open(struct input_dev *dev)
2586 switch (tpacpi_lifecycle) {
2587 case TPACPI_LIFE_INIT:
2589 * hotkey_init will call hotkey_poll_setup_safe
2590 * at the appropriate moment
2593 case TPACPI_LIFE_EXITING:
2595 case TPACPI_LIFE_RUNNING:
2596 hotkey_poll_setup_safe(false);
2600 /* Should only happen if tpacpi_lifecycle is corrupt */
2605 static void hotkey_inputdev_close(struct input_dev *dev)
2607 /* disable hotkey polling when possible */
2608 if (tpacpi_lifecycle == TPACPI_LIFE_RUNNING &&
2609 !(hotkey_source_mask & hotkey_driver_mask))
2610 hotkey_poll_setup_safe(false);
2613 /* sysfs hotkey enable ------------------------------------------------- */
2614 static ssize_t hotkey_enable_show(struct device *dev,
2615 struct device_attribute *attr,
2620 printk_deprecated_attribute("hotkey_enable",
2621 "Hotkey reporting is always enabled");
2623 res = hotkey_status_get(&status);
2627 return snprintf(buf, PAGE_SIZE, "%d\n", status);
2630 static ssize_t hotkey_enable_store(struct device *dev,
2631 struct device_attribute *attr,
2632 const char *buf, size_t count)
2636 printk_deprecated_attribute("hotkey_enable",
2637 "Hotkeys can be disabled through hotkey_mask");
2639 if (parse_strtoul(buf, 1, &t))
2648 static struct device_attribute dev_attr_hotkey_enable =
2649 __ATTR(hotkey_enable, S_IWUSR | S_IRUGO,
2650 hotkey_enable_show, hotkey_enable_store);
2652 /* sysfs hotkey mask --------------------------------------------------- */
2653 static ssize_t hotkey_mask_show(struct device *dev,
2654 struct device_attribute *attr,
2657 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_user_mask);
2660 static ssize_t hotkey_mask_store(struct device *dev,
2661 struct device_attribute *attr,
2662 const char *buf, size_t count)
2667 if (parse_strtoul(buf, 0xffffffffUL, &t))
2670 if (mutex_lock_killable(&hotkey_mutex))
2671 return -ERESTARTSYS;
2673 res = hotkey_user_mask_set(t);
2675 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2676 hotkey_poll_setup(true);
2679 mutex_unlock(&hotkey_mutex);
2681 tpacpi_disclose_usertask("hotkey_mask", "set to 0x%08lx\n", t);
2683 return (res) ? res : count;
2686 static struct device_attribute dev_attr_hotkey_mask =
2687 __ATTR(hotkey_mask, S_IWUSR | S_IRUGO,
2688 hotkey_mask_show, hotkey_mask_store);
2690 /* sysfs hotkey bios_enabled ------------------------------------------- */
2691 static ssize_t hotkey_bios_enabled_show(struct device *dev,
2692 struct device_attribute *attr,
2695 return sprintf(buf, "0\n");
2698 static struct device_attribute dev_attr_hotkey_bios_enabled =
2699 __ATTR(hotkey_bios_enabled, S_IRUGO, hotkey_bios_enabled_show, NULL);
2701 /* sysfs hotkey bios_mask ---------------------------------------------- */
2702 static ssize_t hotkey_bios_mask_show(struct device *dev,
2703 struct device_attribute *attr,
2706 printk_deprecated_attribute("hotkey_bios_mask",
2707 "This attribute is useless.");
2708 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_orig_mask);
2711 static struct device_attribute dev_attr_hotkey_bios_mask =
2712 __ATTR(hotkey_bios_mask, S_IRUGO, hotkey_bios_mask_show, NULL);
2714 /* sysfs hotkey all_mask ----------------------------------------------- */
2715 static ssize_t hotkey_all_mask_show(struct device *dev,
2716 struct device_attribute *attr,
2719 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2720 hotkey_all_mask | hotkey_source_mask);
2723 static struct device_attribute dev_attr_hotkey_all_mask =
2724 __ATTR(hotkey_all_mask, S_IRUGO, hotkey_all_mask_show, NULL);
2726 /* sysfs hotkey recommended_mask --------------------------------------- */
2727 static ssize_t hotkey_recommended_mask_show(struct device *dev,
2728 struct device_attribute *attr,
2731 return snprintf(buf, PAGE_SIZE, "0x%08x\n",
2732 (hotkey_all_mask | hotkey_source_mask)
2733 & ~hotkey_reserved_mask);
2736 static struct device_attribute dev_attr_hotkey_recommended_mask =
2737 __ATTR(hotkey_recommended_mask, S_IRUGO,
2738 hotkey_recommended_mask_show, NULL);
2740 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2742 /* sysfs hotkey hotkey_source_mask ------------------------------------- */
2743 static ssize_t hotkey_source_mask_show(struct device *dev,
2744 struct device_attribute *attr,
2747 return snprintf(buf, PAGE_SIZE, "0x%08x\n", hotkey_source_mask);
2750 static ssize_t hotkey_source_mask_store(struct device *dev,
2751 struct device_attribute *attr,
2752 const char *buf, size_t count)
2758 if (parse_strtoul(buf, 0xffffffffUL, &t) ||
2759 ((t & ~TPACPI_HKEY_NVRAM_KNOWN_MASK) != 0))
2762 if (mutex_lock_killable(&hotkey_mutex))
2763 return -ERESTARTSYS;
2765 HOTKEY_CONFIG_CRITICAL_START
2766 hotkey_source_mask = t;
2767 HOTKEY_CONFIG_CRITICAL_END
2769 rc = hotkey_mask_set((hotkey_user_mask | hotkey_driver_mask) &
2770 ~hotkey_source_mask);
2771 hotkey_poll_setup(true);
2773 /* check if events needed by the driver got disabled */
2774 r_ev = hotkey_driver_mask & ~(hotkey_acpi_mask & hotkey_all_mask)
2775 & ~hotkey_source_mask & TPACPI_HKEY_NVRAM_KNOWN_MASK;
2777 mutex_unlock(&hotkey_mutex);
2780 printk(TPACPI_ERR "hotkey_source_mask: failed to update the"
2781 "firmware event mask!\n");
2784 printk(TPACPI_NOTICE "hotkey_source_mask: "
2785 "some important events were disabled: "
2788 tpacpi_disclose_usertask("hotkey_source_mask", "set to 0x%08lx\n", t);
2790 return (rc < 0) ? rc : count;
2793 static struct device_attribute dev_attr_hotkey_source_mask =
2794 __ATTR(hotkey_source_mask, S_IWUSR | S_IRUGO,
2795 hotkey_source_mask_show, hotkey_source_mask_store);
2797 /* sysfs hotkey hotkey_poll_freq --------------------------------------- */
2798 static ssize_t hotkey_poll_freq_show(struct device *dev,
2799 struct device_attribute *attr,
2802 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_poll_freq);
2805 static ssize_t hotkey_poll_freq_store(struct device *dev,
2806 struct device_attribute *attr,
2807 const char *buf, size_t count)
2811 if (parse_strtoul(buf, 25, &t))
2814 if (mutex_lock_killable(&hotkey_mutex))
2815 return -ERESTARTSYS;
2817 hotkey_poll_set_freq(t);
2818 hotkey_poll_setup(true);
2820 mutex_unlock(&hotkey_mutex);
2822 tpacpi_disclose_usertask("hotkey_poll_freq", "set to %lu\n", t);
2827 static struct device_attribute dev_attr_hotkey_poll_freq =
2828 __ATTR(hotkey_poll_freq, S_IWUSR | S_IRUGO,
2829 hotkey_poll_freq_show, hotkey_poll_freq_store);
2831 #endif /* CONFIG_THINKPAD_ACPI_HOTKEY_POLL */
2833 /* sysfs hotkey radio_sw (pollable) ------------------------------------ */
2834 static ssize_t hotkey_radio_sw_show(struct device *dev,
2835 struct device_attribute *attr,
2839 res = hotkey_get_wlsw();
2843 /* Opportunistic update */
2844 tpacpi_rfk_update_hwblock_state((res == TPACPI_RFK_RADIO_OFF));
2846 return snprintf(buf, PAGE_SIZE, "%d\n",
2847 (res == TPACPI_RFK_RADIO_OFF) ? 0 : 1);
2850 static struct device_attribute dev_attr_hotkey_radio_sw =
2851 __ATTR(hotkey_radio_sw, S_IRUGO, hotkey_radio_sw_show, NULL);
2853 static void hotkey_radio_sw_notify_change(void)
2855 if (tp_features.hotkey_wlsw)
2856 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2860 /* sysfs hotkey tablet mode (pollable) --------------------------------- */
2861 static ssize_t hotkey_tablet_mode_show(struct device *dev,
2862 struct device_attribute *attr,
2866 res = hotkey_get_tablet_mode(&s);
2870 return snprintf(buf, PAGE_SIZE, "%d\n", !!s);
2873 static struct device_attribute dev_attr_hotkey_tablet_mode =
2874 __ATTR(hotkey_tablet_mode, S_IRUGO, hotkey_tablet_mode_show, NULL);
2876 static void hotkey_tablet_mode_notify_change(void)
2878 if (tp_features.hotkey_tablet)
2879 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2880 "hotkey_tablet_mode");
2883 /* sysfs hotkey report_mode -------------------------------------------- */
2884 static ssize_t hotkey_report_mode_show(struct device *dev,
2885 struct device_attribute *attr,
2888 return snprintf(buf, PAGE_SIZE, "%d\n",
2889 (hotkey_report_mode != 0) ? hotkey_report_mode : 1);
2892 static struct device_attribute dev_attr_hotkey_report_mode =
2893 __ATTR(hotkey_report_mode, S_IRUGO, hotkey_report_mode_show, NULL);
2895 /* sysfs wakeup reason (pollable) -------------------------------------- */
2896 static ssize_t hotkey_wakeup_reason_show(struct device *dev,
2897 struct device_attribute *attr,
2900 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_wakeup_reason);
2903 static struct device_attribute dev_attr_hotkey_wakeup_reason =
2904 __ATTR(wakeup_reason, S_IRUGO, hotkey_wakeup_reason_show, NULL);
2906 static void hotkey_wakeup_reason_notify_change(void)
2908 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2912 /* sysfs wakeup hotunplug_complete (pollable) -------------------------- */
2913 static ssize_t hotkey_wakeup_hotunplug_complete_show(struct device *dev,
2914 struct device_attribute *attr,
2917 return snprintf(buf, PAGE_SIZE, "%d\n", hotkey_autosleep_ack);
2920 static struct device_attribute dev_attr_hotkey_wakeup_hotunplug_complete =
2921 __ATTR(wakeup_hotunplug_complete, S_IRUGO,
2922 hotkey_wakeup_hotunplug_complete_show, NULL);
2924 static void hotkey_wakeup_hotunplug_complete_notify_change(void)
2926 sysfs_notify(&tpacpi_pdev->dev.kobj, NULL,
2927 "wakeup_hotunplug_complete");
2930 /* --------------------------------------------------------------------- */
2932 static struct attribute *hotkey_attributes[] __initdata = {
2933 &dev_attr_hotkey_enable.attr,
2934 &dev_attr_hotkey_bios_enabled.attr,
2935 &dev_attr_hotkey_bios_mask.attr,
2936 &dev_attr_hotkey_report_mode.attr,
2937 &dev_attr_hotkey_wakeup_reason.attr,
2938 &dev_attr_hotkey_wakeup_hotunplug_complete.attr,
2939 &dev_attr_hotkey_mask.attr,
2940 &dev_attr_hotkey_all_mask.attr,
2941 &dev_attr_hotkey_recommended_mask.attr,
2942 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
2943 &dev_attr_hotkey_source_mask.attr,
2944 &dev_attr_hotkey_poll_freq.attr,
2949 * Sync both the hw and sw blocking state of all switches
2951 static void tpacpi_send_radiosw_update(void)
2956 * We must sync all rfkill controllers *before* issuing any
2957 * rfkill input events, or we will race the rfkill core input
2960 * tpacpi_inputdev_send_mutex works as a syncronization point
2963 * We optimize to avoid numerous calls to hotkey_get_wlsw.
2966 wlsw = hotkey_get_wlsw();
2968 /* Sync hw blocking state first if it is hw-blocked */
2969 if (wlsw == TPACPI_RFK_RADIO_OFF)
2970 tpacpi_rfk_update_hwblock_state(true);
2972 /* Sync sw blocking state */
2973 tpacpi_rfk_update_swstate_all();
2975 /* Sync hw blocking state last if it is hw-unblocked */
2976 if (wlsw == TPACPI_RFK_RADIO_ON)
2977 tpacpi_rfk_update_hwblock_state(false);
2979 /* Issue rfkill input event for WLSW switch */
2981 mutex_lock(&tpacpi_inputdev_send_mutex);
2983 input_report_switch(tpacpi_inputdev,
2984 SW_RFKILL_ALL, (wlsw > 0));
2985 input_sync(tpacpi_inputdev);
2987 mutex_unlock(&tpacpi_inputdev_send_mutex);
2991 * this can be unconditional, as we will poll state again
2992 * if userspace uses the notify to read data
2994 hotkey_radio_sw_notify_change();
2997 static void hotkey_exit(void)
2999 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3000 mutex_lock(&hotkey_mutex);
3001 hotkey_poll_stop_sync();
3002 mutex_unlock(&hotkey_mutex);
3005 if (hotkey_dev_attributes)
3006 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3008 kfree(hotkey_keycode_map);
3010 dbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_HKEY,
3011 "restoring original HKEY status and mask\n");
3012 /* yes, there is a bitwise or below, we want the
3013 * functions to be called even if one of them fail */
3014 if (((tp_features.hotkey_mask &&
3015 hotkey_mask_set(hotkey_orig_mask)) |
3016 hotkey_status_set(false)) != 0)
3018 "failed to restore hot key mask "
3019 "to BIOS defaults\n");
3022 static void __init hotkey_unmap(const unsigned int scancode)
3024 if (hotkey_keycode_map[scancode] != KEY_RESERVED) {
3025 clear_bit(hotkey_keycode_map[scancode],
3026 tpacpi_inputdev->keybit);
3027 hotkey_keycode_map[scancode] = KEY_RESERVED;
3033 * TPACPI_HK_Q_INIMASK: Supports FN+F3,FN+F4,FN+F12
3036 #define TPACPI_HK_Q_INIMASK 0x0001
3038 static const struct tpacpi_quirk tpacpi_hotkey_qtable[] __initconst = {
3039 TPACPI_Q_IBM('I', 'H', TPACPI_HK_Q_INIMASK), /* 600E */
3040 TPACPI_Q_IBM('I', 'N', TPACPI_HK_Q_INIMASK), /* 600E */
3041 TPACPI_Q_IBM('I', 'D', TPACPI_HK_Q_INIMASK), /* 770, 770E, 770ED */
3042 TPACPI_Q_IBM('I', 'W', TPACPI_HK_Q_INIMASK), /* A20m */
3043 TPACPI_Q_IBM('I', 'V', TPACPI_HK_Q_INIMASK), /* A20p */
3044 TPACPI_Q_IBM('1', '0', TPACPI_HK_Q_INIMASK), /* A21e, A22e */
3045 TPACPI_Q_IBM('K', 'U', TPACPI_HK_Q_INIMASK), /* A21e */
3046 TPACPI_Q_IBM('K', 'X', TPACPI_HK_Q_INIMASK), /* A21m, A22m */
3047 TPACPI_Q_IBM('K', 'Y', TPACPI_HK_Q_INIMASK), /* A21p, A22p */
3048 TPACPI_Q_IBM('1', 'B', TPACPI_HK_Q_INIMASK), /* A22e */
3049 TPACPI_Q_IBM('1', '3', TPACPI_HK_Q_INIMASK), /* A22m */
3050 TPACPI_Q_IBM('1', 'E', TPACPI_HK_Q_INIMASK), /* A30/p (0) */
3051 TPACPI_Q_IBM('1', 'C', TPACPI_HK_Q_INIMASK), /* R30 */
3052 TPACPI_Q_IBM('1', 'F', TPACPI_HK_Q_INIMASK), /* R31 */
3053 TPACPI_Q_IBM('I', 'Y', TPACPI_HK_Q_INIMASK), /* T20 */
3054 TPACPI_Q_IBM('K', 'Z', TPACPI_HK_Q_INIMASK), /* T21 */
3055 TPACPI_Q_IBM('1', '6', TPACPI_HK_Q_INIMASK), /* T22 */
3056 TPACPI_Q_IBM('I', 'Z', TPACPI_HK_Q_INIMASK), /* X20, X21 */
3057 TPACPI_Q_IBM('1', 'D', TPACPI_HK_Q_INIMASK), /* X22, X23, X24 */
3060 static int __init hotkey_init(struct ibm_init_struct *iibm)
3062 /* Requirements for changing the default keymaps:
3064 * 1. Many of the keys are mapped to KEY_RESERVED for very
3065 * good reasons. Do not change them unless you have deep
3066 * knowledge on the IBM and Lenovo ThinkPad firmware for
3067 * the various ThinkPad models. The driver behaves
3068 * differently for KEY_RESERVED: such keys have their
3069 * hot key mask *unset* in mask_recommended, and also
3070 * in the initial hot key mask programmed into the
3071 * firmware at driver load time, which means the firm-
3072 * ware may react very differently if you change them to
3075 * 2. You must be subscribed to the linux-thinkpad and
3076 * ibm-acpi-devel mailing lists, and you should read the
3077 * list archives since 2007 if you want to change the
3078 * keymaps. This requirement exists so that you will
3079 * know the past history of problems with the thinkpad-
3080 * acpi driver keymaps, and also that you will be
3081 * listening to any bug reports;
3083 * 3. Do not send thinkpad-acpi specific patches directly to
3084 * for merging, *ever*. Send them to the linux-acpi
3085 * mailinglist for comments. Merging is to be done only
3086 * through acpi-test and the ACPI maintainer.
3088 * If the above is too much to ask, don't change the keymap.
3089 * Ask the thinkpad-acpi maintainer to do it, instead.
3091 static u16 ibm_keycode_map[] __initdata = {
3092 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3093 KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP,
3094 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3095 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3097 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3098 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3099 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3100 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3102 /* brightness: firmware always reacts to them */
3103 KEY_RESERVED, /* 0x0F: FN+HOME (brightness up) */
3104 KEY_RESERVED, /* 0x10: FN+END (brightness down) */
3106 /* Thinklight: firmware always react to it */
3107 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3109 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3110 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3112 /* Volume: firmware always react to it and reprograms
3113 * the built-in *extra* mixer. Never map it to control
3114 * another mixer by default. */
3115 KEY_RESERVED, /* 0x14: VOLUME UP */
3116 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3117 KEY_RESERVED, /* 0x16: MUTE */
3119 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3121 /* (assignments unknown, please report if found) */
3122 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3123 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3125 static u16 lenovo_keycode_map[] __initdata = {
3126 /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */
3127 KEY_FN_F1, KEY_COFFEE, KEY_BATTERY, KEY_SLEEP,
3128 KEY_WLAN, KEY_FN_F6, KEY_SWITCHVIDEOMODE, KEY_FN_F8,
3129 KEY_FN_F9, KEY_FN_F10, KEY_FN_F11, KEY_SUSPEND,
3131 /* Scan codes 0x0C to 0x1F: Other ACPI HKEY hot keys */
3132 KEY_UNKNOWN, /* 0x0C: FN+BACKSPACE */
3133 KEY_UNKNOWN, /* 0x0D: FN+INSERT */
3134 KEY_UNKNOWN, /* 0x0E: FN+DELETE */
3136 /* These should be enabled --only-- when ACPI video
3137 * is disabled (i.e. in "vendor" mode), and are handled
3138 * in a special way by the init code */
3139 KEY_BRIGHTNESSUP, /* 0x0F: FN+HOME (brightness up) */
3140 KEY_BRIGHTNESSDOWN, /* 0x10: FN+END (brightness down) */
3142 KEY_RESERVED, /* 0x11: FN+PGUP (thinklight toggle) */
3144 KEY_UNKNOWN, /* 0x12: FN+PGDOWN */
3145 KEY_ZOOM, /* 0x13: FN+SPACE (zoom) */
3147 /* Volume: z60/z61, T60 (BIOS version?): firmware always
3148 * react to it and reprograms the built-in *extra* mixer.
3149 * Never map it to control another mixer by default.
3151 * T60?, T61, R60?, R61: firmware and EC tries to send
3152 * these over the regular keyboard, so these are no-ops,
3153 * but there are still weird bugs re. MUTE, so do not
3154 * change unless you get test reports from all Lenovo
3155 * models. May cause the BIOS to interfere with the
3158 KEY_RESERVED, /* 0x14: VOLUME UP */
3159 KEY_RESERVED, /* 0x15: VOLUME DOWN */
3160 KEY_RESERVED, /* 0x16: MUTE */
3162 KEY_VENDOR, /* 0x17: Thinkpad/AccessIBM/Lenovo */
3164 /* (assignments unknown, please report if found) */
3165 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3166 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
3169 #define TPACPI_HOTKEY_MAP_LEN ARRAY_SIZE(ibm_keycode_map)
3170 #define TPACPI_HOTKEY_MAP_SIZE sizeof(ibm_keycode_map)
3171 #define TPACPI_HOTKEY_MAP_TYPESIZE sizeof(ibm_keycode_map[0])
3177 unsigned long quirks;
3179 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3180 "initializing hotkey subdriver\n");
3182 BUG_ON(!tpacpi_inputdev);
3183 BUG_ON(tpacpi_inputdev->open != NULL ||
3184 tpacpi_inputdev->close != NULL);
3186 TPACPI_ACPIHANDLE_INIT(hkey);
3187 mutex_init(&hotkey_mutex);
3189 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3190 mutex_init(&hotkey_thread_mutex);
3191 mutex_init(&hotkey_thread_data_mutex);
3194 /* hotkey not supported on 570 */
3195 tp_features.hotkey = hkey_handle != NULL;
3197 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3199 str_supported(tp_features.hotkey));
3201 if (!tp_features.hotkey)
3204 quirks = tpacpi_check_quirks(tpacpi_hotkey_qtable,
3205 ARRAY_SIZE(tpacpi_hotkey_qtable));
3207 tpacpi_disable_brightness_delay();
3209 /* MUST have enough space for all attributes to be added to
3210 * hotkey_dev_attributes */
3211 hotkey_dev_attributes = create_attr_set(
3212 ARRAY_SIZE(hotkey_attributes) + 2,
3214 if (!hotkey_dev_attributes)
3216 res = add_many_to_attr_set(hotkey_dev_attributes,
3218 ARRAY_SIZE(hotkey_attributes));
3222 /* mask not supported on 600e/x, 770e, 770x, A21e, A2xm/p,
3223 A30, R30, R31, T20-22, X20-21, X22-24. Detected by checking
3224 for HKEY interface version 0x100 */
3225 if (acpi_evalf(hkey_handle, &hkeyv, "MHKV", "qd")) {
3226 if ((hkeyv >> 8) != 1) {
3227 printk(TPACPI_ERR "unknown version of the "
3228 "HKEY interface: 0x%x\n", hkeyv);
3229 printk(TPACPI_ERR "please report this to %s\n",
3233 * MHKV 0x100 in A31, R40, R40e,
3234 * T4x, X31, and later
3236 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3237 "firmware HKEY interface version: 0x%x\n",
3240 /* Paranoia check AND init hotkey_all_mask */
3241 if (!acpi_evalf(hkey_handle, &hotkey_all_mask,
3244 "missing MHKA handler, "
3245 "please report this to %s\n",
3247 /* Fallback: pre-init for FN+F3,F4,F12 */
3248 hotkey_all_mask = 0x080cU;
3250 tp_features.hotkey_mask = 1;
3255 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3256 "hotkey masks are %s\n",
3257 str_supported(tp_features.hotkey_mask));
3259 /* Init hotkey_all_mask if not initialized yet */
3260 if (!tp_features.hotkey_mask && !hotkey_all_mask &&
3261 (quirks & TPACPI_HK_Q_INIMASK))
3262 hotkey_all_mask = 0x080cU; /* FN+F12, FN+F4, FN+F3 */
3264 /* Init hotkey_acpi_mask and hotkey_orig_mask */
3265 if (tp_features.hotkey_mask) {
3266 /* hotkey_source_mask *must* be zero for
3267 * the first hotkey_mask_get to return hotkey_orig_mask */
3268 res = hotkey_mask_get();
3272 hotkey_orig_mask = hotkey_acpi_mask;
3274 hotkey_orig_mask = hotkey_all_mask;
3275 hotkey_acpi_mask = hotkey_all_mask;
3278 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3280 tp_features.hotkey_wlsw = 1;
3282 "radio switch emulation enabled\n");
3285 /* Not all thinkpads have a hardware radio switch */
3286 if (acpi_evalf(hkey_handle, &status, "WLSW", "qd")) {
3287 tp_features.hotkey_wlsw = 1;
3289 "radio switch found; radios are %s\n",
3290 enabled(status, 0));
3292 if (tp_features.hotkey_wlsw)
3293 res = add_to_attr_set(hotkey_dev_attributes,
3294 &dev_attr_hotkey_radio_sw.attr);
3296 /* For X41t, X60t, X61t Tablets... */
3297 if (!res && acpi_evalf(hkey_handle, &status, "MHKG", "qd")) {
3298 tp_features.hotkey_tablet = 1;
3300 "possible tablet mode switch found; "
3301 "ThinkPad in %s mode\n",
3302 (status & TP_HOTKEY_TABLET_MASK)?
3303 "tablet" : "laptop");
3304 res = add_to_attr_set(hotkey_dev_attributes,
3305 &dev_attr_hotkey_tablet_mode.attr);
3309 res = register_attr_set_with_sysfs(
3310 hotkey_dev_attributes,
3311 &tpacpi_pdev->dev.kobj);
3315 /* Set up key map */
3317 hotkey_keycode_map = kmalloc(TPACPI_HOTKEY_MAP_SIZE,
3319 if (!hotkey_keycode_map) {
3321 "failed to allocate memory for key map\n");
3326 if (thinkpad_id.vendor == PCI_VENDOR_ID_LENOVO) {
3327 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3328 "using Lenovo default hot key map\n");
3329 memcpy(hotkey_keycode_map, &lenovo_keycode_map,
3330 TPACPI_HOTKEY_MAP_SIZE);
3332 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3333 "using IBM default hot key map\n");
3334 memcpy(hotkey_keycode_map, &ibm_keycode_map,
3335 TPACPI_HOTKEY_MAP_SIZE);
3338 set_bit(EV_KEY, tpacpi_inputdev->evbit);
3339 set_bit(EV_MSC, tpacpi_inputdev->evbit);
3340 set_bit(MSC_SCAN, tpacpi_inputdev->mscbit);
3341 tpacpi_inputdev->keycodesize = TPACPI_HOTKEY_MAP_TYPESIZE;
3342 tpacpi_inputdev->keycodemax = TPACPI_HOTKEY_MAP_LEN;
3343 tpacpi_inputdev->keycode = hotkey_keycode_map;
3344 for (i = 0; i < TPACPI_HOTKEY_MAP_LEN; i++) {
3345 if (hotkey_keycode_map[i] != KEY_RESERVED) {
3346 set_bit(hotkey_keycode_map[i],
3347 tpacpi_inputdev->keybit);
3349 if (i < sizeof(hotkey_reserved_mask)*8)
3350 hotkey_reserved_mask |= 1 << i;
3354 if (tp_features.hotkey_wlsw) {
3355 set_bit(EV_SW, tpacpi_inputdev->evbit);
3356 set_bit(SW_RFKILL_ALL, tpacpi_inputdev->swbit);
3358 if (tp_features.hotkey_tablet) {
3359 set_bit(EV_SW, tpacpi_inputdev->evbit);
3360 set_bit(SW_TABLET_MODE, tpacpi_inputdev->swbit);
3363 /* Do not issue duplicate brightness change events to
3365 if (!tp_features.bright_acpimode)
3366 /* update bright_acpimode... */
3367 tpacpi_check_std_acpi_brightness_support();
3369 if (tp_features.bright_acpimode && acpi_video_backlight_support()) {
3371 "This ThinkPad has standard ACPI backlight "
3372 "brightness control, supported by the ACPI "
3374 printk(TPACPI_NOTICE
3375 "Disabling thinkpad-acpi brightness events "
3378 /* Disable brightness up/down on Lenovo thinkpads when
3379 * ACPI is handling them, otherwise it is plain impossible
3380 * for userspace to do something even remotely sane */
3381 hotkey_reserved_mask |=
3382 (1 << TP_ACPI_HOTKEYSCAN_FNHOME)
3383 | (1 << TP_ACPI_HOTKEYSCAN_FNEND);
3384 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNHOME);
3385 hotkey_unmap(TP_ACPI_HOTKEYSCAN_FNEND);
3388 #ifdef CONFIG_THINKPAD_ACPI_HOTKEY_POLL
3389 hotkey_source_mask = TPACPI_HKEY_NVRAM_GOOD_MASK
3391 & ~hotkey_reserved_mask;
3393 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3394 "hotkey source mask 0x%08x, polling freq %u\n",
3395 hotkey_source_mask, hotkey_poll_freq);
3398 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3399 "enabling firmware HKEY event interface...\n");
3400 res = hotkey_status_set(true);
3405 res = hotkey_mask_set(((hotkey_all_mask & ~hotkey_reserved_mask)
3406 | hotkey_driver_mask)
3407 & ~hotkey_source_mask);
3408 if (res < 0 && res != -ENXIO) {
3412 hotkey_user_mask = (hotkey_acpi_mask | hotkey_source_mask)
3413 & ~hotkey_reserved_mask;
3414 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3415 "initial masks: user=0x%08x, fw=0x%08x, poll=0x%08x\n",
3416 hotkey_user_mask, hotkey_acpi_mask, hotkey_source_mask);
3418 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_HKEY,
3419 "legacy ibm/hotkey event reporting over procfs %s\n",
3420 (hotkey_report_mode < 2) ?
3421 "enabled" : "disabled");
3423 tpacpi_inputdev->open = &hotkey_inputdev_open;
3424 tpacpi_inputdev->close = &hotkey_inputdev_close;
3426 hotkey_poll_setup_safe(true);
3427 tpacpi_send_radiosw_update();
3428 tpacpi_input_send_tabletsw();
3433 delete_attr_set(hotkey_dev_attributes, &tpacpi_pdev->dev.kobj);
3434 hotkey_dev_attributes = NULL;
3436 return (res < 0)? res : 1;
3439 static bool hotkey_notify_hotkey(const u32 hkey,
3441 bool *ignore_acpi_ev)
3443 /* 0x1000-0x1FFF: key presses */
3444 unsigned int scancode = hkey & 0xfff;
3445 *send_acpi_ev = true;
3446 *ignore_acpi_ev = false;
3448 if (scancode > 0 && scancode < 0x21) {
3450 if (!(hotkey_source_mask & (1 << scancode))) {
3451 tpacpi_input_send_key_masked(scancode);
3452 *send_acpi_ev = false;
3454 *ignore_acpi_ev = true;
3461 static bool hotkey_notify_wakeup(const u32 hkey,
3463 bool *ignore_acpi_ev)
3465 /* 0x2000-0x2FFF: Wakeup reason */
3466 *send_acpi_ev = true;
3467 *ignore_acpi_ev = false;
3470 case TP_HKEY_EV_WKUP_S3_UNDOCK: /* suspend, undock */
3471 case TP_HKEY_EV_WKUP_S4_UNDOCK: /* hibernation, undock */
3472 hotkey_wakeup_reason = TP_ACPI_WAKEUP_UNDOCK;
3473 *ignore_acpi_ev = true;
3476 case TP_HKEY_EV_WKUP_S3_BAYEJ: /* suspend, bay eject */
3477 case TP_HKEY_EV_WKUP_S4_BAYEJ: /* hibernation, bay eject */
3478 hotkey_wakeup_reason = TP_ACPI_WAKEUP_BAYEJ;
3479 *ignore_acpi_ev = true;
3482 case TP_HKEY_EV_WKUP_S3_BATLOW: /* Battery on critical low level/S3 */
3483 case TP_HKEY_EV_WKUP_S4_BATLOW: /* Battery on critical low level/S4 */
3485 "EMERGENCY WAKEUP: battery almost empty\n");
3486 /* how to auto-heal: */
3487 /* 2313: woke up from S3, go to S4/S5 */
3488 /* 2413: woke up from S4, go to S5 */
3495 if (hotkey_wakeup_reason != TP_ACPI_WAKEUP_NONE) {
3497 "woke up due to a hot-unplug "
3499 hotkey_wakeup_reason_notify_change();
3504 static bool hotkey_notify_usrevent(const u32 hkey,
3506 bool *ignore_acpi_ev)
3508 /* 0x5000-0x5FFF: human interface helpers */
3509 *send_acpi_ev = true;
3510 *ignore_acpi_ev = false;
3513 case TP_HKEY_EV_PEN_INSERTED: /* X61t: tablet pen inserted into bay */
3514 case TP_HKEY_EV_PEN_REMOVED: /* X61t: tablet pen removed from bay */
3517 case TP_HKEY_EV_TABLET_TABLET: /* X41t-X61t: tablet mode */
3518 case TP_HKEY_EV_TABLET_NOTEBOOK: /* X41t-X61t: normal mode */
3519 tpacpi_input_send_tabletsw();
3520 hotkey_tablet_mode_notify_change();
3521 *send_acpi_ev = false;
3524 case TP_HKEY_EV_LID_CLOSE: /* Lid closed */
3525 case TP_HKEY_EV_LID_OPEN: /* Lid opened */
3526 case TP_HKEY_EV_BRGHT_CHANGED: /* brightness changed */
3527 /* do not propagate these events */
3528 *ignore_acpi_ev = true;
3536 static bool hotkey_notify_thermal(const u32 hkey,
3538 bool *ignore_acpi_ev)
3540 /* 0x6000-0x6FFF: thermal alarms */
3541 *send_acpi_ev = true;
3542 *ignore_acpi_ev = false;
3545 case TP_HKEY_EV_ALARM_BAT_HOT:
3547 "THERMAL ALARM: battery is too hot!\n");
3548 /* recommended action: warn user through gui */
3550 case TP_HKEY_EV_ALARM_BAT_XHOT:
3552 "THERMAL EMERGENCY: battery is extremely hot!\n");
3553 /* recommended action: immediate sleep/hibernate */
3555 case TP_HKEY_EV_ALARM_SENSOR_HOT:
3558 "a sensor reports something is too hot!\n");
3559 /* recommended action: warn user through gui, that */
3560 /* some internal component is too hot */
3562 case TP_HKEY_EV_ALARM_SENSOR_XHOT:
3564 "THERMAL EMERGENCY: "
3565 "a sensor reports something is extremely hot!\n");
3566 /* recommended action: immediate sleep/hibernate */
3568 case TP_HKEY_EV_THM_TABLE_CHANGED:
3570 "EC reports that Thermal Table has changed\n");
3571 /* recommended action: do nothing, we don't have
3572 * Lenovo ATM information */
3576 "THERMAL ALERT: unknown thermal alarm received\n");
3581 static void hotkey_notify(struct ibm_struct *ibm, u32 event)
3585 bool ignore_acpi_ev;
3588 if (event != 0x80) {
3590 "unknown HKEY notification event %d\n", event);
3591 /* forward it to userspace, maybe it knows how to handle it */
3592 acpi_bus_generate_netlink_event(
3593 ibm->acpi->device->pnp.device_class,
3594 dev_name(&ibm->acpi->device->dev),
3600 if (!acpi_evalf(hkey_handle, &hkey, "MHKP", "d")) {
3601 printk(TPACPI_ERR "failed to retrieve HKEY event\n");
3610 send_acpi_ev = true;
3611 ignore_acpi_ev = false;
3613 switch (hkey >> 12) {
3615 /* 0x1000-0x1FFF: key presses */
3616 known_ev = hotkey_notify_hotkey(hkey, &send_acpi_ev,
3620 /* 0x2000-0x2FFF: Wakeup reason */
3621 known_ev = hotkey_notify_wakeup(hkey, &send_acpi_ev,
3625 /* 0x3000-0x3FFF: bay-related wakeups */
3626 if (hkey == TP_HKEY_EV_BAYEJ_ACK) {
3627 hotkey_autosleep_ack = 1;
3630 hotkey_wakeup_hotunplug_complete_notify_change();
3637 /* 0x4000-0x4FFF: dock-related wakeups */
3638 if (hkey == TP_HKEY_EV_UNDOCK_ACK) {
3639 hotkey_autosleep_ack = 1;
3642 hotkey_wakeup_hotunplug_complete_notify_change();
3649 /* 0x5000-0x5FFF: human interface helpers */
3650 known_ev = hotkey_notify_usrevent(hkey, &send_acpi_ev,
3654 /* 0x6000-0x6FFF: thermal alarms */
3655 known_ev = hotkey_notify_thermal(hkey, &send_acpi_ev,
3659 /* 0x7000-0x7FFF: misc */
3660 if (tp_features.hotkey_wlsw &&
3661 hkey == TP_HKEY_EV_RFKILL_CHANGED) {
3662 tpacpi_send_radiosw_update();
3667 /* fallthrough to default */
3672 printk(TPACPI_NOTICE
3673 "unhandled HKEY event 0x%04x\n", hkey);
3674 printk(TPACPI_NOTICE
3675 "please report the conditions when this "
3676 "event happened to %s\n", TPACPI_MAIL);
3680 if (!ignore_acpi_ev &&
3681 (send_acpi_ev || hotkey_report_mode < 2)) {
3682 acpi_bus_generate_proc_event(ibm->acpi->device,
3686 /* netlink events */
3687 if (!ignore_acpi_ev && send_acpi_ev) {
3688 acpi_bus_generate_netlink_event(
3689 ibm->acpi->device->pnp.device_class,
3690 dev_name(&ibm->acpi->device->dev),
3696 static void hotkey_suspend(pm_message_t state)
3698 /* Do these on suspend, we get the events on early resume! */
3699 hotkey_wakeup_reason = TP_ACPI_WAKEUP_NONE;
3700 hotkey_autosleep_ack = 0;
3703 static void hotkey_resume(void)
3705 tpacpi_disable_brightness_delay();
3707 if (hotkey_status_set(true) < 0 ||
3708 hotkey_mask_set(hotkey_acpi_mask) < 0)
3710 "error while attempting to reset the event "
3711 "firmware interface\n");
3713 tpacpi_send_radiosw_update();
3714 hotkey_tablet_mode_notify_change();
3715 hotkey_wakeup_reason_notify_change();
3716 hotkey_wakeup_hotunplug_complete_notify_change();
3717 hotkey_poll_setup_safe(false);
3720 /* procfs -------------------------------------------------------------- */
3721 static int hotkey_read(char *p)
3726 if (!tp_features.hotkey) {
3727 len += sprintf(p + len, "status:\t\tnot supported\n");
3731 if (mutex_lock_killable(&hotkey_mutex))
3732 return -ERESTARTSYS;
3733 res = hotkey_status_get(&status);
3735 res = hotkey_mask_get();
3736 mutex_unlock(&hotkey_mutex);
3740 len += sprintf(p + len, "status:\t\t%s\n", enabled(status, 0));
3741 if (hotkey_all_mask) {
3742 len += sprintf(p + len, "mask:\t\t0x%08x\n", hotkey_user_mask);
3743 len += sprintf(p + len,
3744 "commands:\tenable, disable, reset, <mask>\n");
3746 len += sprintf(p + len, "mask:\t\tnot supported\n");
3747 len += sprintf(p + len, "commands:\tenable, disable, reset\n");
3753 static void hotkey_enabledisable_warn(bool enable)
3755 tpacpi_log_usertask("procfs hotkey enable/disable");
3756 if (!WARN((tpacpi_lifecycle == TPACPI_LIFE_RUNNING || !enable),
3758 "hotkey enable/disable functionality has been "
3759 "removed from the driver. Hotkeys are always "
3762 "Please remove the hotkey=enable module "
3763 "parameter, it is deprecated. Hotkeys are always "
3767 static int hotkey_write(char *buf)
3773 if (!tp_features.hotkey)
3776 if (mutex_lock_killable(&hotkey_mutex))
3777 return -ERESTARTSYS;
3779 mask = hotkey_user_mask;
3782 while ((cmd = next_cmd(&buf))) {
3783 if (strlencmp(cmd, "enable") == 0) {
3784 hotkey_enabledisable_warn(1);
3785 } else if (strlencmp(cmd, "disable") == 0) {
3786 hotkey_enabledisable_warn(0);
3788 } else if (strlencmp(cmd, "reset") == 0) {
3789 mask = (hotkey_all_mask | hotkey_source_mask)
3790 & ~hotkey_reserved_mask;
3791 } else if (sscanf(cmd, "0x%x", &mask) == 1) {
3793 } else if (sscanf(cmd, "%x", &mask) == 1) {
3802 tpacpi_disclose_usertask("procfs hotkey",
3803 "set mask to 0x%08x\n", mask);
3804 res = hotkey_user_mask_set(mask);
3808 mutex_unlock(&hotkey_mutex);
3812 static const struct acpi_device_id ibm_htk_device_ids[] = {
3813 {TPACPI_ACPI_HKEY_HID, 0},
3817 static struct tp_acpi_drv_struct ibm_hotkey_acpidriver = {
3818 .hid = ibm_htk_device_ids,
3819 .notify = hotkey_notify,
3820 .handle = &hkey_handle,
3821 .type = ACPI_DEVICE_NOTIFY,
3824 static struct ibm_struct hotkey_driver_data = {
3826 .read = hotkey_read,
3827 .write = hotkey_write,
3828 .exit = hotkey_exit,
3829 .resume = hotkey_resume,
3830 .suspend = hotkey_suspend,
3831 .acpi = &ibm_hotkey_acpidriver,
3834 /*************************************************************************
3835 * Bluetooth subdriver
3839 /* ACPI GBDC/SBDC bits */
3840 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
3841 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
3842 TP_ACPI_BLUETOOTH_RESUMECTRL = 0x04, /* Bluetooth state at resume:
3847 /* ACPI \BLTH commands */
3848 TP_ACPI_BLTH_GET_ULTRAPORT_ID = 0x00, /* Get Ultraport BT ID */
3849 TP_ACPI_BLTH_GET_PWR_ON_RESUME = 0x01, /* Get power-on-resume state */
3850 TP_ACPI_BLTH_PWR_ON_ON_RESUME = 0x02, /* Resume powered on */
3851 TP_ACPI_BLTH_PWR_OFF_ON_RESUME = 0x03, /* Resume powered off */
3852 TP_ACPI_BLTH_SAVE_STATE = 0x05, /* Save state for S4/S5 */
3855 #define TPACPI_RFK_BLUETOOTH_SW_NAME "tpacpi_bluetooth_sw"
3857 static void bluetooth_suspend(pm_message_t state)
3859 /* Try to make sure radio will resume powered off */
3860 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
3861 TP_ACPI_BLTH_PWR_OFF_ON_RESUME))
3862 vdbg_printk(TPACPI_DBG_RFKILL,
3863 "bluetooth power down on resume request failed\n");
3866 static int bluetooth_get_status(void)
3870 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3871 if (dbg_bluetoothemul)
3872 return (tpacpi_bluetooth_emulstate) ?
3873 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3876 if (!acpi_evalf(hkey_handle, &status, "GBDC", "d"))
3879 return ((status & TP_ACPI_BLUETOOTH_RADIOSSW) != 0) ?
3880 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
3883 static int bluetooth_set_status(enum tpacpi_rfkill_state state)
3887 vdbg_printk(TPACPI_DBG_RFKILL,
3888 "will attempt to %s bluetooth\n",
3889 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
3891 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3892 if (dbg_bluetoothemul) {
3893 tpacpi_bluetooth_emulstate = (state == TPACPI_RFK_RADIO_ON);
3898 /* We make sure to keep TP_ACPI_BLUETOOTH_RESUMECTRL off */
3899 if (state == TPACPI_RFK_RADIO_ON)
3900 status = TP_ACPI_BLUETOOTH_RADIOSSW;
3904 if (!acpi_evalf(hkey_handle, NULL, "SBDC", "vd", status))
3910 /* sysfs bluetooth enable ---------------------------------------------- */
3911 static ssize_t bluetooth_enable_show(struct device *dev,
3912 struct device_attribute *attr,
3915 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_BLUETOOTH_SW_ID,
3919 static ssize_t bluetooth_enable_store(struct device *dev,
3920 struct device_attribute *attr,
3921 const char *buf, size_t count)
3923 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_BLUETOOTH_SW_ID,
3927 static struct device_attribute dev_attr_bluetooth_enable =
3928 __ATTR(bluetooth_enable, S_IWUSR | S_IRUGO,
3929 bluetooth_enable_show, bluetooth_enable_store);
3931 /* --------------------------------------------------------------------- */
3933 static struct attribute *bluetooth_attributes[] = {
3934 &dev_attr_bluetooth_enable.attr,
3938 static const struct attribute_group bluetooth_attr_group = {
3939 .attrs = bluetooth_attributes,
3942 static const struct tpacpi_rfk_ops bluetooth_tprfk_ops = {
3943 .get_status = bluetooth_get_status,
3944 .set_status = bluetooth_set_status,
3947 static void bluetooth_shutdown(void)
3949 /* Order firmware to save current state to NVRAM */
3950 if (!acpi_evalf(NULL, NULL, "\\BLTH", "vd",
3951 TP_ACPI_BLTH_SAVE_STATE))
3952 printk(TPACPI_NOTICE
3953 "failed to save bluetooth state to NVRAM\n");
3955 vdbg_printk(TPACPI_DBG_RFKILL,
3956 "bluestooth state saved to NVRAM\n");
3959 static void bluetooth_exit(void)
3961 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
3962 &bluetooth_attr_group);
3964 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
3966 bluetooth_shutdown();
3969 static int __init bluetooth_init(struct ibm_init_struct *iibm)
3974 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
3975 "initializing bluetooth subdriver\n");
3977 TPACPI_ACPIHANDLE_INIT(hkey);
3979 /* bluetooth not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
3980 G4x, R30, R31, R40e, R50e, T20-22, X20-21 */
3981 tp_features.bluetooth = hkey_handle &&
3982 acpi_evalf(hkey_handle, &status, "GBDC", "qd");
3984 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
3985 "bluetooth is %s, status 0x%02x\n",
3986 str_supported(tp_features.bluetooth),
3989 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
3990 if (dbg_bluetoothemul) {
3991 tp_features.bluetooth = 1;
3993 "bluetooth switch emulation enabled\n");
3996 if (tp_features.bluetooth &&
3997 !(status & TP_ACPI_BLUETOOTH_HWPRESENT)) {
3998 /* no bluetooth hardware present in system */
3999 tp_features.bluetooth = 0;
4000 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4001 "bluetooth hardware not installed\n");
4004 if (!tp_features.bluetooth)
4007 res = tpacpi_new_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID,
4008 &bluetooth_tprfk_ops,
4009 RFKILL_TYPE_BLUETOOTH,
4010 TPACPI_RFK_BLUETOOTH_SW_NAME,
4015 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4016 &bluetooth_attr_group);
4018 tpacpi_destroy_rfkill(TPACPI_RFK_BLUETOOTH_SW_ID);
4025 /* procfs -------------------------------------------------------------- */
4026 static int bluetooth_read(char *p)
4028 return tpacpi_rfk_procfs_read(TPACPI_RFK_BLUETOOTH_SW_ID, p);
4031 static int bluetooth_write(char *buf)
4033 return tpacpi_rfk_procfs_write(TPACPI_RFK_BLUETOOTH_SW_ID, buf);
4036 static struct ibm_struct bluetooth_driver_data = {
4037 .name = "bluetooth",
4038 .read = bluetooth_read,
4039 .write = bluetooth_write,
4040 .exit = bluetooth_exit,
4041 .suspend = bluetooth_suspend,
4042 .shutdown = bluetooth_shutdown,
4045 /*************************************************************************
4050 /* ACPI GWAN/SWAN bits */
4051 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
4052 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
4053 TP_ACPI_WANCARD_RESUMECTRL = 0x04, /* Wan state at resume:
4057 #define TPACPI_RFK_WWAN_SW_NAME "tpacpi_wwan_sw"
4059 static void wan_suspend(pm_message_t state)
4061 /* Try to make sure radio will resume powered off */
4062 if (!acpi_evalf(NULL, NULL, "\\WGSV", "qvd",
4063 TP_ACPI_WGSV_PWR_OFF_ON_RESUME))
4064 vdbg_printk(TPACPI_DBG_RFKILL,
4065 "WWAN power down on resume request failed\n");
4068 static int wan_get_status(void)
4072 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4074 return (tpacpi_wwan_emulstate) ?
4075 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4078 if (!acpi_evalf(hkey_handle, &status, "GWAN", "d"))
4081 return ((status & TP_ACPI_WANCARD_RADIOSSW) != 0) ?
4082 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4085 static int wan_set_status(enum tpacpi_rfkill_state state)
4089 vdbg_printk(TPACPI_DBG_RFKILL,
4090 "will attempt to %s wwan\n",
4091 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4093 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4095 tpacpi_wwan_emulstate = (state == TPACPI_RFK_RADIO_ON);
4100 /* We make sure to keep TP_ACPI_WANCARD_RESUMECTRL off */
4101 if (state == TPACPI_RFK_RADIO_ON)
4102 status = TP_ACPI_WANCARD_RADIOSSW;
4106 if (!acpi_evalf(hkey_handle, NULL, "SWAN", "vd", status))
4112 /* sysfs wan enable ---------------------------------------------------- */
4113 static ssize_t wan_enable_show(struct device *dev,
4114 struct device_attribute *attr,
4117 return tpacpi_rfk_sysfs_enable_show(TPACPI_RFK_WWAN_SW_ID,
4121 static ssize_t wan_enable_store(struct device *dev,
4122 struct device_attribute *attr,
4123 const char *buf, size_t count)
4125 return tpacpi_rfk_sysfs_enable_store(TPACPI_RFK_WWAN_SW_ID,
4129 static struct device_attribute dev_attr_wan_enable =
4130 __ATTR(wwan_enable, S_IWUSR | S_IRUGO,
4131 wan_enable_show, wan_enable_store);
4133 /* --------------------------------------------------------------------- */
4135 static struct attribute *wan_attributes[] = {
4136 &dev_attr_wan_enable.attr,
4140 static const struct attribute_group wan_attr_group = {
4141 .attrs = wan_attributes,
4144 static const struct tpacpi_rfk_ops wan_tprfk_ops = {
4145 .get_status = wan_get_status,
4146 .set_status = wan_set_status,
4149 static void wan_shutdown(void)
4151 /* Order firmware to save current state to NVRAM */
4152 if (!acpi_evalf(NULL, NULL, "\\WGSV", "vd",
4153 TP_ACPI_WGSV_SAVE_STATE))
4154 printk(TPACPI_NOTICE
4155 "failed to save WWAN state to NVRAM\n");
4157 vdbg_printk(TPACPI_DBG_RFKILL,
4158 "WWAN state saved to NVRAM\n");
4161 static void wan_exit(void)
4163 sysfs_remove_group(&tpacpi_pdev->dev.kobj,
4166 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4171 static int __init wan_init(struct ibm_init_struct *iibm)
4176 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4177 "initializing wan subdriver\n");
4179 TPACPI_ACPIHANDLE_INIT(hkey);
4181 tp_features.wan = hkey_handle &&
4182 acpi_evalf(hkey_handle, &status, "GWAN", "qd");
4184 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4185 "wan is %s, status 0x%02x\n",
4186 str_supported(tp_features.wan),
4189 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4191 tp_features.wan = 1;
4193 "wwan switch emulation enabled\n");
4196 if (tp_features.wan &&
4197 !(status & TP_ACPI_WANCARD_HWPRESENT)) {
4198 /* no wan hardware present in system */
4199 tp_features.wan = 0;
4200 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4201 "wan hardware not installed\n");
4204 if (!tp_features.wan)
4207 res = tpacpi_new_rfkill(TPACPI_RFK_WWAN_SW_ID,
4210 TPACPI_RFK_WWAN_SW_NAME,
4215 res = sysfs_create_group(&tpacpi_pdev->dev.kobj,
4219 tpacpi_destroy_rfkill(TPACPI_RFK_WWAN_SW_ID);
4226 /* procfs -------------------------------------------------------------- */
4227 static int wan_read(char *p)
4229 return tpacpi_rfk_procfs_read(TPACPI_RFK_WWAN_SW_ID, p);
4232 static int wan_write(char *buf)
4234 return tpacpi_rfk_procfs_write(TPACPI_RFK_WWAN_SW_ID, buf);
4237 static struct ibm_struct wan_driver_data = {
4242 .suspend = wan_suspend,
4243 .shutdown = wan_shutdown,
4246 /*************************************************************************
4251 /* ACPI GUWB/SUWB bits */
4252 TP_ACPI_UWB_HWPRESENT = 0x01, /* UWB hw available */
4253 TP_ACPI_UWB_RADIOSSW = 0x02, /* UWB radio enabled */
4256 #define TPACPI_RFK_UWB_SW_NAME "tpacpi_uwb_sw"
4258 static int uwb_get_status(void)
4262 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4264 return (tpacpi_uwb_emulstate) ?
4265 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4268 if (!acpi_evalf(hkey_handle, &status, "GUWB", "d"))
4271 return ((status & TP_ACPI_UWB_RADIOSSW) != 0) ?
4272 TPACPI_RFK_RADIO_ON : TPACPI_RFK_RADIO_OFF;
4275 static int uwb_set_status(enum tpacpi_rfkill_state state)
4279 vdbg_printk(TPACPI_DBG_RFKILL,
4280 "will attempt to %s UWB\n",
4281 (state == TPACPI_RFK_RADIO_ON) ? "enable" : "disable");
4283 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4285 tpacpi_uwb_emulstate = (state == TPACPI_RFK_RADIO_ON);
4290 if (state == TPACPI_RFK_RADIO_ON)
4291 status = TP_ACPI_UWB_RADIOSSW;
4295 if (!acpi_evalf(hkey_handle, NULL, "SUWB", "vd", status))
4301 /* --------------------------------------------------------------------- */
4303 static const struct tpacpi_rfk_ops uwb_tprfk_ops = {
4304 .get_status = uwb_get_status,
4305 .set_status = uwb_set_status,
4308 static void uwb_exit(void)
4310 tpacpi_destroy_rfkill(TPACPI_RFK_UWB_SW_ID);
4313 static int __init uwb_init(struct ibm_init_struct *iibm)
4318 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4319 "initializing uwb subdriver\n");
4321 TPACPI_ACPIHANDLE_INIT(hkey);
4323 tp_features.uwb = hkey_handle &&
4324 acpi_evalf(hkey_handle, &status, "GUWB", "qd");
4326 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_RFKILL,
4327 "uwb is %s, status 0x%02x\n",
4328 str_supported(tp_features.uwb),
4331 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
4333 tp_features.uwb = 1;
4335 "uwb switch emulation enabled\n");
4338 if (tp_features.uwb &&
4339 !(status & TP_ACPI_UWB_HWPRESENT)) {
4340 /* no uwb hardware present in system */
4341 tp_features.uwb = 0;
4342 dbg_printk(TPACPI_DBG_INIT,
4343 "uwb hardware not installed\n");
4346 if (!tp_features.uwb)
4349 res = tpacpi_new_rfkill(TPACPI_RFK_UWB_SW_ID,
4352 TPACPI_RFK_UWB_SW_NAME,
4357 static struct ibm_struct uwb_driver_data = {
4360 .flags.experimental = 1,
4363 /*************************************************************************
4367 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
4369 enum video_access_mode {
4370 TPACPI_VIDEO_NONE = 0,
4371 TPACPI_VIDEO_570, /* 570 */
4372 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
4373 TPACPI_VIDEO_NEW, /* all others */
4376 enum { /* video status flags, based on VIDEO_570 */
4377 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
4378 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
4379 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
4382 enum { /* TPACPI_VIDEO_570 constants */
4383 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
4384 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
4385 * video_status_flags */
4386 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
4387 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
4390 static enum video_access_mode video_supported;
4391 static int video_orig_autosw;
4393 static int video_autosw_get(void);
4394 static int video_autosw_set(int enable);
4396 TPACPI_HANDLE(vid2, root, "\\_SB.PCI0.AGPB.VID"); /* G41 */
4398 static int __init video_init(struct ibm_init_struct *iibm)
4402 vdbg_printk(TPACPI_DBG_INIT, "initializing video subdriver\n");
4404 TPACPI_ACPIHANDLE_INIT(vid);
4405 TPACPI_ACPIHANDLE_INIT(vid2);
4407 if (vid2_handle && acpi_evalf(NULL, &ivga, "\\IVGA", "d") && ivga)
4408 /* G41, assume IVGA doesn't change */
4409 vid_handle = vid2_handle;
4412 /* video switching not supported on R30, R31 */
4413 video_supported = TPACPI_VIDEO_NONE;
4414 else if (acpi_evalf(vid_handle, &video_orig_autosw, "SWIT", "qd"))
4416 video_supported = TPACPI_VIDEO_570;
4417 else if (acpi_evalf(vid_handle, &video_orig_autosw, "^VADL", "qd"))
4418 /* 600e/x, 770e, 770x */
4419 video_supported = TPACPI_VIDEO_770;
4422 video_supported = TPACPI_VIDEO_NEW;
4424 vdbg_printk(TPACPI_DBG_INIT, "video is %s, mode %d\n",
4425 str_supported(video_supported != TPACPI_VIDEO_NONE),
4428 return (video_supported != TPACPI_VIDEO_NONE)? 0 : 1;
4431 static void video_exit(void)
4433 dbg_printk(TPACPI_DBG_EXIT,
4434 "restoring original video autoswitch mode\n");
4435 if (video_autosw_set(video_orig_autosw))
4436 printk(TPACPI_ERR "error while trying to restore original "
4437 "video autoswitch mode\n");
4440 static int video_outputsw_get(void)
4445 switch (video_supported) {
4446 case TPACPI_VIDEO_570:
4447 if (!acpi_evalf(NULL, &i, "\\_SB.PHS", "dd",
4448 TP_ACPI_VIDEO_570_PHSCMD))
4450 status = i & TP_ACPI_VIDEO_570_PHSMASK;
4452 case TPACPI_VIDEO_770:
4453 if (!acpi_evalf(NULL, &i, "\\VCDL", "d"))
4456 status |= TP_ACPI_VIDEO_S_LCD;
4457 if (!acpi_evalf(NULL, &i, "\\VCDC", "d"))
4460 status |= TP_ACPI_VIDEO_S_CRT;
4462 case TPACPI_VIDEO_NEW:
4463 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 1) ||
4464 !acpi_evalf(NULL, &i, "\\VCDC", "d"))
4467 status |= TP_ACPI_VIDEO_S_CRT;
4469 if (!acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0) ||
4470 !acpi_evalf(NULL, &i, "\\VCDL", "d"))
4473 status |= TP_ACPI_VIDEO_S_LCD;
4474 if (!acpi_evalf(NULL, &i, "\\VCDD", "d"))
4477 status |= TP_ACPI_VIDEO_S_DVI;
4486 static int video_outputsw_set(int status)
4491 switch (video_supported) {
4492 case TPACPI_VIDEO_570:
4493 res = acpi_evalf(NULL, NULL,
4494 "\\_SB.PHS2", "vdd",
4495 TP_ACPI_VIDEO_570_PHS2CMD,
4496 status | TP_ACPI_VIDEO_570_PHS2SET);
4498 case TPACPI_VIDEO_770:
4499 autosw = video_autosw_get();
4503 res = video_autosw_set(1);
4506 res = acpi_evalf(vid_handle, NULL,
4507 "ASWT", "vdd", status * 0x100, 0);
4508 if (!autosw && video_autosw_set(autosw)) {
4510 "video auto-switch left enabled due to error\n");
4514 case TPACPI_VIDEO_NEW:
4515 res = acpi_evalf(NULL, NULL, "\\VUPS", "vd", 0x80) &&
4516 acpi_evalf(NULL, NULL, "\\VSDS", "vdd", status, 1);
4522 return (res)? 0 : -EIO;
4525 static int video_autosw_get(void)
4529 switch (video_supported) {
4530 case TPACPI_VIDEO_570:
4531 if (!acpi_evalf(vid_handle, &autosw, "SWIT", "d"))
4534 case TPACPI_VIDEO_770:
4535 case TPACPI_VIDEO_NEW:
4536 if (!acpi_evalf(vid_handle, &autosw, "^VDEE", "d"))
4546 static int video_autosw_set(int enable)
4548 if (!acpi_evalf(vid_handle, NULL, "_DOS", "vd", (enable)? 1 : 0))
4553 static int video_outputsw_cycle(void)
4555 int autosw = video_autosw_get();
4561 switch (video_supported) {
4562 case TPACPI_VIDEO_570:
4563 res = video_autosw_set(1);
4566 res = acpi_evalf(ec_handle, NULL, "_Q16", "v");
4568 case TPACPI_VIDEO_770:
4569 case TPACPI_VIDEO_NEW:
4570 res = video_autosw_set(1);
4573 res = acpi_evalf(vid_handle, NULL, "VSWT", "v");
4578 if (!autosw && video_autosw_set(autosw)) {
4580 "video auto-switch left enabled due to error\n");
4584 return (res)? 0 : -EIO;
4587 static int video_expand_toggle(void)
4589 switch (video_supported) {
4590 case TPACPI_VIDEO_570:
4591 return acpi_evalf(ec_handle, NULL, "_Q17", "v")?
4593 case TPACPI_VIDEO_770:
4594 return acpi_evalf(vid_handle, NULL, "VEXP", "v")?
4596 case TPACPI_VIDEO_NEW:
4597 return acpi_evalf(NULL, NULL, "\\VEXP", "v")?
4605 static int video_read(char *p)
4610 if (video_supported == TPACPI_VIDEO_NONE) {
4611 len += sprintf(p + len, "status:\t\tnot supported\n");
4615 status = video_outputsw_get();
4619 autosw = video_autosw_get();
4623 len += sprintf(p + len, "status:\t\tsupported\n");
4624 len += sprintf(p + len, "lcd:\t\t%s\n", enabled(status, 0));
4625 len += sprintf(p + len, "crt:\t\t%s\n", enabled(status, 1));
4626 if (video_supported == TPACPI_VIDEO_NEW)
4627 len += sprintf(p + len, "dvi:\t\t%s\n", enabled(status, 3));
4628 len += sprintf(p + len, "auto:\t\t%s\n", enabled(autosw, 0));
4629 len += sprintf(p + len, "commands:\tlcd_enable, lcd_disable\n");
4630 len += sprintf(p + len, "commands:\tcrt_enable, crt_disable\n");
4631 if (video_supported == TPACPI_VIDEO_NEW)
4632 len += sprintf(p + len, "commands:\tdvi_enable, dvi_disable\n");
4633 len += sprintf(p + len, "commands:\tauto_enable, auto_disable\n");
4634 len += sprintf(p + len, "commands:\tvideo_switch, expand_toggle\n");
4639 static int video_write(char *buf)
4642 int enable, disable, status;
4645 if (video_supported == TPACPI_VIDEO_NONE)
4651 while ((cmd = next_cmd(&buf))) {
4652 if (strlencmp(cmd, "lcd_enable") == 0) {
4653 enable |= TP_ACPI_VIDEO_S_LCD;
4654 } else if (strlencmp(cmd, "lcd_disable") == 0) {
4655 disable |= TP_ACPI_VIDEO_S_LCD;
4656 } else if (strlencmp(cmd, "crt_enable") == 0) {
4657 enable |= TP_ACPI_VIDEO_S_CRT;
4658 } else if (strlencmp(cmd, "crt_disable") == 0) {
4659 disable |= TP_ACPI_VIDEO_S_CRT;
4660 } else if (video_supported == TPACPI_VIDEO_NEW &&
4661 strlencmp(cmd, "dvi_enable") == 0) {
4662 enable |= TP_ACPI_VIDEO_S_DVI;
4663 } else if (video_supported == TPACPI_VIDEO_NEW &&
4664 strlencmp(cmd, "dvi_disable") == 0) {
4665 disable |= TP_ACPI_VIDEO_S_DVI;
4666 } else if (strlencmp(cmd, "auto_enable") == 0) {
4667 res = video_autosw_set(1);
4670 } else if (strlencmp(cmd, "auto_disable") == 0) {
4671 res = video_autosw_set(0);
4674 } else if (strlencmp(cmd, "video_switch") == 0) {
4675 res = video_outputsw_cycle();
4678 } else if (strlencmp(cmd, "expand_toggle") == 0) {
4679 res = video_expand_toggle();
4686 if (enable || disable) {
4687 status = video_outputsw_get();
4690 res = video_outputsw_set((status & ~disable) | enable);
4698 static struct ibm_struct video_driver_data = {
4701 .write = video_write,
4705 #endif /* CONFIG_THINKPAD_ACPI_VIDEO */
4707 /*************************************************************************
4708 * Light (thinklight) subdriver
4711 TPACPI_HANDLE(lght, root, "\\LGHT"); /* A21e, A2xm/p, T20-22, X20-21 */
4712 TPACPI_HANDLE(ledb, ec, "LEDB"); /* G4x */
4714 static int light_get_status(void)
4718 if (tp_features.light_status) {
4719 if (!acpi_evalf(ec_handle, &status, "KBLT", "d"))
4727 static int light_set_status(int status)
4731 if (tp_features.light) {
4733 rc = acpi_evalf(cmos_handle, NULL, NULL, "vd",
4735 TP_CMOS_THINKLIGHT_ON :
4736 TP_CMOS_THINKLIGHT_OFF);
4738 rc = acpi_evalf(lght_handle, NULL, NULL, "vd",
4741 return (rc)? 0 : -EIO;
4747 static void light_set_status_worker(struct work_struct *work)
4749 struct tpacpi_led_classdev *data =
4750 container_of(work, struct tpacpi_led_classdev, work);
4752 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
4753 light_set_status((data->new_state != TPACPI_LED_OFF));
4756 static void light_sysfs_set(struct led_classdev *led_cdev,
4757 enum led_brightness brightness)
4759 struct tpacpi_led_classdev *data =
4760 container_of(led_cdev,
4761 struct tpacpi_led_classdev,
4763 data->new_state = (brightness != LED_OFF) ?
4764 TPACPI_LED_ON : TPACPI_LED_OFF;
4765 queue_work(tpacpi_wq, &data->work);
4768 static enum led_brightness light_sysfs_get(struct led_classdev *led_cdev)
4770 return (light_get_status() == 1)? LED_FULL : LED_OFF;
4773 static struct tpacpi_led_classdev tpacpi_led_thinklight = {
4775 .name = "tpacpi::thinklight",
4776 .brightness_set = &light_sysfs_set,
4777 .brightness_get = &light_sysfs_get,
4781 static int __init light_init(struct ibm_init_struct *iibm)
4785 vdbg_printk(TPACPI_DBG_INIT, "initializing light subdriver\n");
4787 TPACPI_ACPIHANDLE_INIT(ledb);
4788 TPACPI_ACPIHANDLE_INIT(lght);
4789 TPACPI_ACPIHANDLE_INIT(cmos);
4790 INIT_WORK(&tpacpi_led_thinklight.work, light_set_status_worker);
4792 /* light not supported on 570, 600e/x, 770e, 770x, G4x, R30, R31 */
4793 tp_features.light = (cmos_handle || lght_handle) && !ledb_handle;
4795 if (tp_features.light)
4796 /* light status not supported on
4797 570, 600e/x, 770e, 770x, G4x, R30, R31, R32, X20 */
4798 tp_features.light_status =
4799 acpi_evalf(ec_handle, NULL, "KBLT", "qv");
4801 vdbg_printk(TPACPI_DBG_INIT, "light is %s, light status is %s\n",
4802 str_supported(tp_features.light),
4803 str_supported(tp_features.light_status));
4805 if (!tp_features.light)
4808 rc = led_classdev_register(&tpacpi_pdev->dev,
4809 &tpacpi_led_thinklight.led_classdev);
4812 tp_features.light = 0;
4813 tp_features.light_status = 0;
4821 static void light_exit(void)
4823 led_classdev_unregister(&tpacpi_led_thinklight.led_classdev);
4824 if (work_pending(&tpacpi_led_thinklight.work))
4825 flush_workqueue(tpacpi_wq);
4828 static int light_read(char *p)
4833 if (!tp_features.light) {
4834 len += sprintf(p + len, "status:\t\tnot supported\n");
4835 } else if (!tp_features.light_status) {
4836 len += sprintf(p + len, "status:\t\tunknown\n");
4837 len += sprintf(p + len, "commands:\ton, off\n");
4839 status = light_get_status();
4842 len += sprintf(p + len, "status:\t\t%s\n", onoff(status, 0));
4843 len += sprintf(p + len, "commands:\ton, off\n");
4849 static int light_write(char *buf)
4854 if (!tp_features.light)
4857 while ((cmd = next_cmd(&buf))) {
4858 if (strlencmp(cmd, "on") == 0) {
4860 } else if (strlencmp(cmd, "off") == 0) {
4866 return light_set_status(newstatus);
4869 static struct ibm_struct light_driver_data = {
4872 .write = light_write,
4876 /*************************************************************************
4880 /* sysfs cmos_command -------------------------------------------------- */
4881 static ssize_t cmos_command_store(struct device *dev,
4882 struct device_attribute *attr,
4883 const char *buf, size_t count)
4885 unsigned long cmos_cmd;
4888 if (parse_strtoul(buf, 21, &cmos_cmd))
4891 res = issue_thinkpad_cmos_command(cmos_cmd);
4892 return (res)? res : count;
4895 static struct device_attribute dev_attr_cmos_command =
4896 __ATTR(cmos_command, S_IWUSR, NULL, cmos_command_store);
4898 /* --------------------------------------------------------------------- */
4900 static int __init cmos_init(struct ibm_init_struct *iibm)
4904 vdbg_printk(TPACPI_DBG_INIT,
4905 "initializing cmos commands subdriver\n");
4907 TPACPI_ACPIHANDLE_INIT(cmos);
4909 vdbg_printk(TPACPI_DBG_INIT, "cmos commands are %s\n",
4910 str_supported(cmos_handle != NULL));
4912 res = device_create_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4916 return (cmos_handle)? 0 : 1;
4919 static void cmos_exit(void)
4921 device_remove_file(&tpacpi_pdev->dev, &dev_attr_cmos_command);
4924 static int cmos_read(char *p)
4928 /* cmos not supported on 570, 600e/x, 770e, 770x, A21e, A2xm/p,
4929 R30, R31, T20-22, X20-21 */
4931 len += sprintf(p + len, "status:\t\tnot supported\n");
4933 len += sprintf(p + len, "status:\t\tsupported\n");
4934 len += sprintf(p + len, "commands:\t<cmd> (<cmd> is 0-21)\n");
4940 static int cmos_write(char *buf)
4945 while ((cmd = next_cmd(&buf))) {
4946 if (sscanf(cmd, "%u", &cmos_cmd) == 1 &&
4947 cmos_cmd >= 0 && cmos_cmd <= 21) {
4952 res = issue_thinkpad_cmos_command(cmos_cmd);
4960 static struct ibm_struct cmos_driver_data = {
4963 .write = cmos_write,
4967 /*************************************************************************
4971 enum led_access_mode {
4972 TPACPI_LED_NONE = 0,
4973 TPACPI_LED_570, /* 570 */
4974 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
4975 TPACPI_LED_NEW, /* all others */
4978 enum { /* For TPACPI_LED_OLD */
4979 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
4980 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
4981 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
4984 static enum led_access_mode led_supported;
4986 TPACPI_HANDLE(led, ec, "SLED", /* 570 */
4987 "SYSL", /* 600e/x, 770e, 770x, A21e, A2xm/p, */
4988 /* T20-22, X20-21 */
4989 "LED", /* all others */
4992 #define TPACPI_LED_NUMLEDS 16
4993 static struct tpacpi_led_classdev *tpacpi_leds;
4994 static enum led_status_t tpacpi_led_state_cache[TPACPI_LED_NUMLEDS];
4995 static const char * const tpacpi_led_names[TPACPI_LED_NUMLEDS] = {
4996 /* there's a limit of 19 chars + NULL before 2.6.26 */
4998 "tpacpi:orange:batt",
4999 "tpacpi:green:batt",
5000 "tpacpi::dock_active",
5001 "tpacpi::bay_active",
5002 "tpacpi::dock_batt",
5003 "tpacpi::unknown_led",
5005 "tpacpi::dock_status1",
5006 "tpacpi::dock_status2",
5007 "tpacpi::unknown_led2",
5008 "tpacpi::unknown_led3",
5009 "tpacpi::thinkvantage",
5011 #define TPACPI_SAFE_LEDS 0x1081U
5013 static inline bool tpacpi_is_led_restricted(const unsigned int led)
5015 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5018 return (1U & (TPACPI_SAFE_LEDS >> led)) == 0;
5022 static int led_get_status(const unsigned int led)
5025 enum led_status_t led_s;
5027 switch (led_supported) {
5028 case TPACPI_LED_570:
5029 if (!acpi_evalf(ec_handle,
5030 &status, "GLED", "dd", 1 << led))
5032 led_s = (status == 0)?
5037 tpacpi_led_state_cache[led] = led_s;
5046 static int led_set_status(const unsigned int led,
5047 const enum led_status_t ledstatus)
5049 /* off, on, blink. Index is led_status_t */
5050 static const unsigned int led_sled_arg1[] = { 0, 1, 3 };
5051 static const unsigned int led_led_arg1[] = { 0, 0x80, 0xc0 };
5055 switch (led_supported) {
5056 case TPACPI_LED_570:
5058 if (unlikely(led > 7))
5060 if (unlikely(tpacpi_is_led_restricted(led)))
5062 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5063 (1 << led), led_sled_arg1[ledstatus]))
5066 case TPACPI_LED_OLD:
5067 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20 */
5068 if (unlikely(led > 7))
5070 if (unlikely(tpacpi_is_led_restricted(led)))
5072 rc = ec_write(TPACPI_LED_EC_HLMS, (1 << led));
5074 rc = ec_write(TPACPI_LED_EC_HLBL,
5075 (ledstatus == TPACPI_LED_BLINK) << led);
5077 rc = ec_write(TPACPI_LED_EC_HLCL,
5078 (ledstatus != TPACPI_LED_OFF) << led);
5080 case TPACPI_LED_NEW:
5082 if (unlikely(led >= TPACPI_LED_NUMLEDS))
5084 if (unlikely(tpacpi_is_led_restricted(led)))
5086 if (!acpi_evalf(led_handle, NULL, NULL, "vdd",
5087 led, led_led_arg1[ledstatus]))
5095 tpacpi_led_state_cache[led] = ledstatus;
5100 static void led_set_status_worker(struct work_struct *work)
5102 struct tpacpi_led_classdev *data =
5103 container_of(work, struct tpacpi_led_classdev, work);
5105 if (likely(tpacpi_lifecycle == TPACPI_LIFE_RUNNING))
5106 led_set_status(data->led, data->new_state);
5109 static void led_sysfs_set(struct led_classdev *led_cdev,
5110 enum led_brightness brightness)
5112 struct tpacpi_led_classdev *data = container_of(led_cdev,
5113 struct tpacpi_led_classdev, led_classdev);
5115 if (brightness == LED_OFF)
5116 data->new_state = TPACPI_LED_OFF;
5117 else if (tpacpi_led_state_cache[data->led] != TPACPI_LED_BLINK)
5118 data->new_state = TPACPI_LED_ON;
5120 data->new_state = TPACPI_LED_BLINK;
5122 queue_work(tpacpi_wq, &data->work);
5125 static int led_sysfs_blink_set(struct led_classdev *led_cdev,
5126 unsigned long *delay_on, unsigned long *delay_off)
5128 struct tpacpi_led_classdev *data = container_of(led_cdev,
5129 struct tpacpi_led_classdev, led_classdev);
5131 /* Can we choose the flash rate? */
5132 if (*delay_on == 0 && *delay_off == 0) {
5133 /* yes. set them to the hardware blink rate (1 Hz) */
5134 *delay_on = 500; /* ms */
5135 *delay_off = 500; /* ms */
5136 } else if ((*delay_on != 500) || (*delay_off != 500))
5139 data->new_state = TPACPI_LED_BLINK;
5140 queue_work(tpacpi_wq, &data->work);
5145 static enum led_brightness led_sysfs_get(struct led_classdev *led_cdev)
5149 struct tpacpi_led_classdev *data = container_of(led_cdev,
5150 struct tpacpi_led_classdev, led_classdev);
5152 rc = led_get_status(data->led);
5154 if (rc == TPACPI_LED_OFF || rc < 0)
5155 rc = LED_OFF; /* no error handling in led class :( */
5162 static void led_exit(void)
5166 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5167 if (tpacpi_leds[i].led_classdev.name)
5168 led_classdev_unregister(&tpacpi_leds[i].led_classdev);
5174 static int __init tpacpi_init_led(unsigned int led)
5178 tpacpi_leds[led].led = led;
5180 /* LEDs with no name don't get registered */
5181 if (!tpacpi_led_names[led])
5184 tpacpi_leds[led].led_classdev.brightness_set = &led_sysfs_set;
5185 tpacpi_leds[led].led_classdev.blink_set = &led_sysfs_blink_set;
5186 if (led_supported == TPACPI_LED_570)
5187 tpacpi_leds[led].led_classdev.brightness_get =
5190 tpacpi_leds[led].led_classdev.name = tpacpi_led_names[led];
5192 INIT_WORK(&tpacpi_leds[led].work, led_set_status_worker);
5194 rc = led_classdev_register(&tpacpi_pdev->dev,
5195 &tpacpi_leds[led].led_classdev);
5197 tpacpi_leds[led].led_classdev.name = NULL;
5202 static const struct tpacpi_quirk led_useful_qtable[] __initconst = {
5203 TPACPI_Q_IBM('1', 'E', 0x009f), /* A30 */
5204 TPACPI_Q_IBM('1', 'N', 0x009f), /* A31 */
5205 TPACPI_Q_IBM('1', 'G', 0x009f), /* A31 */
5207 TPACPI_Q_IBM('1', 'I', 0x0097), /* T30 */
5208 TPACPI_Q_IBM('1', 'R', 0x0097), /* T40, T41, T42, R50, R51 */
5209 TPACPI_Q_IBM('7', '0', 0x0097), /* T43, R52 */
5210 TPACPI_Q_IBM('1', 'Y', 0x0097), /* T43 */
5211 TPACPI_Q_IBM('1', 'W', 0x0097), /* R50e */
5212 TPACPI_Q_IBM('1', 'V', 0x0097), /* R51 */
5213 TPACPI_Q_IBM('7', '8', 0x0097), /* R51e */
5214 TPACPI_Q_IBM('7', '6', 0x0097), /* R52 */
5216 TPACPI_Q_IBM('1', 'K', 0x00bf), /* X30 */
5217 TPACPI_Q_IBM('1', 'Q', 0x00bf), /* X31, X32 */
5218 TPACPI_Q_IBM('1', 'U', 0x00bf), /* X40 */
5219 TPACPI_Q_IBM('7', '4', 0x00bf), /* X41 */
5220 TPACPI_Q_IBM('7', '5', 0x00bf), /* X41t */
5222 TPACPI_Q_IBM('7', '9', 0x1f97), /* T60 (1) */
5223 TPACPI_Q_IBM('7', '7', 0x1f97), /* Z60* (1) */
5224 TPACPI_Q_IBM('7', 'F', 0x1f97), /* Z61* (1) */
5225 TPACPI_Q_IBM('7', 'B', 0x1fb7), /* X60 (1) */
5227 /* (1) - may have excess leds enabled on MSB */
5229 /* Defaults (order matters, keep last, don't reorder!) */
5231 .vendor = PCI_VENDOR_ID_LENOVO,
5232 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5235 { /* IBM ThinkPads with no EC version string */
5236 .vendor = PCI_VENDOR_ID_IBM,
5237 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_UNKNOWN,
5240 { /* IBM ThinkPads with EC version string */
5241 .vendor = PCI_VENDOR_ID_IBM,
5242 .bios = TPACPI_MATCH_ANY, .ec = TPACPI_MATCH_ANY,
5247 #undef TPACPI_LEDQ_IBM
5248 #undef TPACPI_LEDQ_LNV
5250 static int __init led_init(struct ibm_init_struct *iibm)
5254 unsigned long useful_leds;
5256 vdbg_printk(TPACPI_DBG_INIT, "initializing LED subdriver\n");
5258 TPACPI_ACPIHANDLE_INIT(led);
5261 /* led not supported on R30, R31 */
5262 led_supported = TPACPI_LED_NONE;
5263 else if (strlencmp(led_path, "SLED") == 0)
5265 led_supported = TPACPI_LED_570;
5266 else if (strlencmp(led_path, "SYSL") == 0)
5267 /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
5268 led_supported = TPACPI_LED_OLD;
5271 led_supported = TPACPI_LED_NEW;
5273 vdbg_printk(TPACPI_DBG_INIT, "LED commands are %s, mode %d\n",
5274 str_supported(led_supported), led_supported);
5276 if (led_supported == TPACPI_LED_NONE)
5279 tpacpi_leds = kzalloc(sizeof(*tpacpi_leds) * TPACPI_LED_NUMLEDS,
5282 printk(TPACPI_ERR "Out of memory for LED data\n");
5286 useful_leds = tpacpi_check_quirks(led_useful_qtable,
5287 ARRAY_SIZE(led_useful_qtable));
5289 for (i = 0; i < TPACPI_LED_NUMLEDS; i++) {
5290 if (!tpacpi_is_led_restricted(i) &&
5291 test_bit(i, &useful_leds)) {
5292 rc = tpacpi_init_led(i);
5300 #ifdef CONFIG_THINKPAD_ACPI_UNSAFE_LEDS
5301 printk(TPACPI_NOTICE
5302 "warning: userspace override of important "
5303 "firmware LEDs is enabled\n");
5308 #define str_led_status(s) \
5309 ((s) == TPACPI_LED_OFF ? "off" : \
5310 ((s) == TPACPI_LED_ON ? "on" : "blinking"))
5312 static int led_read(char *p)
5316 if (!led_supported) {
5317 len += sprintf(p + len, "status:\t\tnot supported\n");
5320 len += sprintf(p + len, "status:\t\tsupported\n");
5322 if (led_supported == TPACPI_LED_570) {
5325 for (i = 0; i < 8; i++) {
5326 status = led_get_status(i);
5329 len += sprintf(p + len, "%d:\t\t%s\n",
5330 i, str_led_status(status));
5334 len += sprintf(p + len, "commands:\t"
5335 "<led> on, <led> off, <led> blink (<led> is 0-15)\n");
5340 static int led_write(char *buf)
5344 enum led_status_t s;
5349 while ((cmd = next_cmd(&buf))) {
5350 if (sscanf(cmd, "%d", &led) != 1 || led < 0 || led > 15)
5353 if (strstr(cmd, "off")) {
5355 } else if (strstr(cmd, "on")) {
5357 } else if (strstr(cmd, "blink")) {
5358 s = TPACPI_LED_BLINK;
5363 rc = led_set_status(led, s);
5371 static struct ibm_struct led_driver_data = {
5378 /*************************************************************************
5382 TPACPI_HANDLE(beep, ec, "BEEP"); /* all except R30, R31 */
5384 #define TPACPI_BEEP_Q1 0x0001
5386 static const struct tpacpi_quirk beep_quirk_table[] __initconst = {
5387 TPACPI_Q_IBM('I', 'M', TPACPI_BEEP_Q1), /* 570 */
5388 TPACPI_Q_IBM('I', 'U', TPACPI_BEEP_Q1), /* 570E - unverified */
5391 static int __init beep_init(struct ibm_init_struct *iibm)
5393 unsigned long quirks;
5395 vdbg_printk(TPACPI_DBG_INIT, "initializing beep subdriver\n");
5397 TPACPI_ACPIHANDLE_INIT(beep);
5399 vdbg_printk(TPACPI_DBG_INIT, "beep is %s\n",
5400 str_supported(beep_handle != NULL));
5402 quirks = tpacpi_check_quirks(beep_quirk_table,
5403 ARRAY_SIZE(beep_quirk_table));
5405 tp_features.beep_needs_two_args = !!(quirks & TPACPI_BEEP_Q1);
5407 return (beep_handle)? 0 : 1;
5410 static int beep_read(char *p)
5415 len += sprintf(p + len, "status:\t\tnot supported\n");
5417 len += sprintf(p + len, "status:\t\tsupported\n");
5418 len += sprintf(p + len, "commands:\t<cmd> (<cmd> is 0-17)\n");
5424 static int beep_write(char *buf)
5432 while ((cmd = next_cmd(&buf))) {
5433 if (sscanf(cmd, "%u", &beep_cmd) == 1 &&
5434 beep_cmd >= 0 && beep_cmd <= 17) {
5438 if (tp_features.beep_needs_two_args) {
5439 if (!acpi_evalf(beep_handle, NULL, NULL, "vdd",
5443 if (!acpi_evalf(beep_handle, NULL, NULL, "vd",
5452 static struct ibm_struct beep_driver_data = {
5455 .write = beep_write,
5458 /*************************************************************************
5462 enum thermal_access_mode {
5463 TPACPI_THERMAL_NONE = 0, /* No thermal support */
5464 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
5465 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
5466 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
5467 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
5470 enum { /* TPACPI_THERMAL_TPEC_* */
5471 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
5472 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
5473 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
5476 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
5477 struct ibm_thermal_sensors_struct {
5478 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
5481 static enum thermal_access_mode thermal_read_mode;
5483 /* idx is zero-based */
5484 static int thermal_get_sensor(int idx, s32 *value)
5490 t = TP_EC_THERMAL_TMP0;
5492 switch (thermal_read_mode) {
5493 #if TPACPI_MAX_THERMAL_SENSORS >= 16
5494 case TPACPI_THERMAL_TPEC_16:
5495 if (idx >= 8 && idx <= 15) {
5496 t = TP_EC_THERMAL_TMP8;
5501 case TPACPI_THERMAL_TPEC_8:
5503 if (!acpi_ec_read(t + idx, &tmp))
5505 *value = tmp * 1000;
5510 case TPACPI_THERMAL_ACPI_UPDT:
5512 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5513 if (!acpi_evalf(ec_handle, NULL, "UPDT", "v"))
5515 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5517 *value = (t - 2732) * 100;
5522 case TPACPI_THERMAL_ACPI_TMP07:
5524 snprintf(tmpi, sizeof(tmpi), "TMP%c", '0' + idx);
5525 if (!acpi_evalf(ec_handle, &t, tmpi, "d"))
5527 if (t > 127 || t < -127)
5528 t = TP_EC_THERMAL_TMP_NA;
5534 case TPACPI_THERMAL_NONE:
5542 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s)
5553 if (thermal_read_mode == TPACPI_THERMAL_TPEC_16)
5556 for (i = 0 ; i < n; i++) {
5557 res = thermal_get_sensor(i, &s->temp[i]);
5565 /* sysfs temp##_input -------------------------------------------------- */
5567 static ssize_t thermal_temp_input_show(struct device *dev,
5568 struct device_attribute *attr,
5571 struct sensor_device_attribute *sensor_attr =
5572 to_sensor_dev_attr(attr);
5573 int idx = sensor_attr->index;
5577 res = thermal_get_sensor(idx, &value);
5580 if (value == TP_EC_THERMAL_TMP_NA * 1000)
5583 return snprintf(buf, PAGE_SIZE, "%d\n", value);
5586 #define THERMAL_SENSOR_ATTR_TEMP(_idxA, _idxB) \
5587 SENSOR_ATTR(temp##_idxA##_input, S_IRUGO, \
5588 thermal_temp_input_show, NULL, _idxB)
5590 static struct sensor_device_attribute sensor_dev_attr_thermal_temp_input[] = {
5591 THERMAL_SENSOR_ATTR_TEMP(1, 0),
5592 THERMAL_SENSOR_ATTR_TEMP(2, 1),
5593 THERMAL_SENSOR_ATTR_TEMP(3, 2),
5594 THERMAL_SENSOR_ATTR_TEMP(4, 3),
5595 THERMAL_SENSOR_ATTR_TEMP(5, 4),
5596 THERMAL_SENSOR_ATTR_TEMP(6, 5),
5597 THERMAL_SENSOR_ATTR_TEMP(7, 6),
5598 THERMAL_SENSOR_ATTR_TEMP(8, 7),
5599 THERMAL_SENSOR_ATTR_TEMP(9, 8),
5600 THERMAL_SENSOR_ATTR_TEMP(10, 9),
5601 THERMAL_SENSOR_ATTR_TEMP(11, 10),
5602 THERMAL_SENSOR_ATTR_TEMP(12, 11),
5603 THERMAL_SENSOR_ATTR_TEMP(13, 12),
5604 THERMAL_SENSOR_ATTR_TEMP(14, 13),
5605 THERMAL_SENSOR_ATTR_TEMP(15, 14),
5606 THERMAL_SENSOR_ATTR_TEMP(16, 15),
5609 #define THERMAL_ATTRS(X) \
5610 &sensor_dev_attr_thermal_temp_input[X].dev_attr.attr
5612 static struct attribute *thermal_temp_input_attr[] = {
5632 static const struct attribute_group thermal_temp_input16_group = {
5633 .attrs = thermal_temp_input_attr
5636 static const struct attribute_group thermal_temp_input8_group = {
5637 .attrs = &thermal_temp_input_attr[8]
5640 #undef THERMAL_SENSOR_ATTR_TEMP
5641 #undef THERMAL_ATTRS
5643 /* --------------------------------------------------------------------- */
5645 static int __init thermal_init(struct ibm_init_struct *iibm)
5652 vdbg_printk(TPACPI_DBG_INIT, "initializing thermal subdriver\n");
5654 acpi_tmp7 = acpi_evalf(ec_handle, NULL, "TMP7", "qv");
5656 if (thinkpad_id.ec_model) {
5658 * Direct EC access mode: sensors at registers
5659 * 0x78-0x7F, 0xC0-0xC7. Registers return 0x00 for
5660 * non-implemented, thermal sensors return 0x80 when
5665 for (i = 0; i < 8; i++) {
5666 if (acpi_ec_read(TP_EC_THERMAL_TMP0 + i, &t)) {
5672 if (acpi_ec_read(TP_EC_THERMAL_TMP8 + i, &t)) {
5680 /* This is sheer paranoia, but we handle it anyway */
5683 "ThinkPad ACPI EC access misbehaving, "
5684 "falling back to ACPI TMPx access "
5686 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5689 "ThinkPad ACPI EC access misbehaving, "
5690 "disabling thermal sensors access\n");
5691 thermal_read_mode = TPACPI_THERMAL_NONE;
5696 TPACPI_THERMAL_TPEC_16 : TPACPI_THERMAL_TPEC_8;
5698 } else if (acpi_tmp7) {
5699 if (acpi_evalf(ec_handle, NULL, "UPDT", "qv")) {
5700 /* 600e/x, 770e, 770x */
5701 thermal_read_mode = TPACPI_THERMAL_ACPI_UPDT;
5703 /* Standard ACPI TMPx access, max 8 sensors */
5704 thermal_read_mode = TPACPI_THERMAL_ACPI_TMP07;
5707 /* temperatures not supported on 570, G4x, R30, R31, R32 */
5708 thermal_read_mode = TPACPI_THERMAL_NONE;
5711 vdbg_printk(TPACPI_DBG_INIT, "thermal is %s, mode %d\n",
5712 str_supported(thermal_read_mode != TPACPI_THERMAL_NONE),
5715 switch (thermal_read_mode) {
5716 case TPACPI_THERMAL_TPEC_16:
5717 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5718 &thermal_temp_input16_group);
5722 case TPACPI_THERMAL_TPEC_8:
5723 case TPACPI_THERMAL_ACPI_TMP07:
5724 case TPACPI_THERMAL_ACPI_UPDT:
5725 res = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
5726 &thermal_temp_input8_group);
5730 case TPACPI_THERMAL_NONE:
5738 static void thermal_exit(void)
5740 switch (thermal_read_mode) {
5741 case TPACPI_THERMAL_TPEC_16:
5742 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5743 &thermal_temp_input16_group);
5745 case TPACPI_THERMAL_TPEC_8:
5746 case TPACPI_THERMAL_ACPI_TMP07:
5747 case TPACPI_THERMAL_ACPI_UPDT:
5748 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
5749 &thermal_temp_input16_group);
5751 case TPACPI_THERMAL_NONE:
5757 static int thermal_read(char *p)
5761 struct ibm_thermal_sensors_struct t;
5763 n = thermal_get_sensors(&t);
5764 if (unlikely(n < 0))
5767 len += sprintf(p + len, "temperatures:\t");
5770 for (i = 0; i < (n - 1); i++)
5771 len += sprintf(p + len, "%d ", t.temp[i] / 1000);
5772 len += sprintf(p + len, "%d\n", t.temp[i] / 1000);
5774 len += sprintf(p + len, "not supported\n");
5779 static struct ibm_struct thermal_driver_data = {
5781 .read = thermal_read,
5782 .exit = thermal_exit,
5785 /*************************************************************************
5789 static u8 ecdump_regs[256];
5791 static int ecdump_read(char *p)
5797 len += sprintf(p + len, "EC "
5798 " +00 +01 +02 +03 +04 +05 +06 +07"
5799 " +08 +09 +0a +0b +0c +0d +0e +0f\n");
5800 for (i = 0; i < 256; i += 16) {
5801 len += sprintf(p + len, "EC 0x%02x:", i);
5802 for (j = 0; j < 16; j++) {
5803 if (!acpi_ec_read(i + j, &v))
5805 if (v != ecdump_regs[i + j])
5806 len += sprintf(p + len, " *%02x", v);
5808 len += sprintf(p + len, " %02x", v);
5809 ecdump_regs[i + j] = v;
5811 len += sprintf(p + len, "\n");
5816 /* These are way too dangerous to advertise openly... */
5818 len += sprintf(p + len, "commands:\t0x<offset> 0x<value>"
5819 " (<offset> is 00-ff, <value> is 00-ff)\n");
5820 len += sprintf(p + len, "commands:\t0x<offset> <value> "
5821 " (<offset> is 00-ff, <value> is 0-255)\n");
5826 static int ecdump_write(char *buf)
5831 while ((cmd = next_cmd(&buf))) {
5832 if (sscanf(cmd, "0x%x 0x%x", &i, &v) == 2) {
5834 } else if (sscanf(cmd, "0x%x %u", &i, &v) == 2) {
5838 if (i >= 0 && i < 256 && v >= 0 && v < 256) {
5839 if (!acpi_ec_write(i, v))
5848 static struct ibm_struct ecdump_driver_data = {
5850 .read = ecdump_read,
5851 .write = ecdump_write,
5852 .flags.experimental = 1,
5855 /*************************************************************************
5856 * Backlight/brightness subdriver
5859 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
5862 * ThinkPads can read brightness from two places: EC HBRV (0x31), or
5863 * CMOS NVRAM byte 0x5E, bits 0-3.
5865 * EC HBRV (0x31) has the following layout
5866 * Bit 7: unknown function
5867 * Bit 6: unknown function
5868 * Bit 5: Z: honour scale changes, NZ: ignore scale changes
5869 * Bit 4: must be set to zero to avoid problems
5870 * Bit 3-0: backlight brightness level
5872 * brightness_get_raw returns status data in the HBRV layout
5874 * WARNING: The X61 has been verified to use HBRV for something else, so
5875 * this should be used _only_ on IBM ThinkPads, and maybe with some careful
5876 * testing on the very early *60 Lenovo models...
5880 TP_EC_BACKLIGHT = 0x31,
5882 /* TP_EC_BACKLIGHT bitmasks */
5883 TP_EC_BACKLIGHT_LVLMSK = 0x1F,
5884 TP_EC_BACKLIGHT_CMDMSK = 0xE0,
5885 TP_EC_BACKLIGHT_MAPSW = 0x20,
5888 enum tpacpi_brightness_access_mode {
5889 TPACPI_BRGHT_MODE_AUTO = 0, /* Not implemented yet */
5890 TPACPI_BRGHT_MODE_EC, /* EC control */
5891 TPACPI_BRGHT_MODE_UCMS_STEP, /* UCMS step-based control */
5892 TPACPI_BRGHT_MODE_ECNVRAM, /* EC control w/ NVRAM store */
5893 TPACPI_BRGHT_MODE_MAX
5896 static struct backlight_device *ibm_backlight_device;
5898 static enum tpacpi_brightness_access_mode brightness_mode =
5899 TPACPI_BRGHT_MODE_MAX;
5901 static unsigned int brightness_enable = 2; /* 2 = auto, 0 = no, 1 = yes */
5903 static struct mutex brightness_mutex;
5905 /* NVRAM brightness access,
5906 * call with brightness_mutex held! */
5907 static unsigned int tpacpi_brightness_nvram_get(void)
5911 lnvram = (nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS)
5912 & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5913 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS;
5914 lnvram &= (tp_features.bright_16levels) ? 0x0f : 0x07;
5919 static void tpacpi_brightness_checkpoint_nvram(void)
5924 if (brightness_mode != TPACPI_BRGHT_MODE_ECNVRAM)
5927 vdbg_printk(TPACPI_DBG_BRGHT,
5928 "trying to checkpoint backlight level to NVRAM...\n");
5930 if (mutex_lock_killable(&brightness_mutex) < 0)
5933 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5935 lec &= TP_EC_BACKLIGHT_LVLMSK;
5936 b_nvram = nvram_read_byte(TP_NVRAM_ADDR_BRIGHTNESS);
5938 if (lec != ((b_nvram & TP_NVRAM_MASK_LEVEL_BRIGHTNESS)
5939 >> TP_NVRAM_POS_LEVEL_BRIGHTNESS)) {
5940 /* NVRAM needs update */
5941 b_nvram &= ~(TP_NVRAM_MASK_LEVEL_BRIGHTNESS <<
5942 TP_NVRAM_POS_LEVEL_BRIGHTNESS);
5944 nvram_write_byte(b_nvram, TP_NVRAM_ADDR_BRIGHTNESS);
5945 dbg_printk(TPACPI_DBG_BRGHT,
5946 "updated NVRAM backlight level to %u (0x%02x)\n",
5947 (unsigned int) lec, (unsigned int) b_nvram);
5949 vdbg_printk(TPACPI_DBG_BRGHT,
5950 "NVRAM backlight level already is %u (0x%02x)\n",
5951 (unsigned int) lec, (unsigned int) b_nvram);
5954 mutex_unlock(&brightness_mutex);
5958 /* call with brightness_mutex held! */
5959 static int tpacpi_brightness_get_raw(int *status)
5963 switch (brightness_mode) {
5964 case TPACPI_BRGHT_MODE_UCMS_STEP:
5965 *status = tpacpi_brightness_nvram_get();
5967 case TPACPI_BRGHT_MODE_EC:
5968 case TPACPI_BRGHT_MODE_ECNVRAM:
5969 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5978 /* call with brightness_mutex held! */
5979 /* do NOT call with illegal backlight level value */
5980 static int tpacpi_brightness_set_ec(unsigned int value)
5984 if (unlikely(!acpi_ec_read(TP_EC_BACKLIGHT, &lec)))
5987 if (unlikely(!acpi_ec_write(TP_EC_BACKLIGHT,
5988 (lec & TP_EC_BACKLIGHT_CMDMSK) |
5989 (value & TP_EC_BACKLIGHT_LVLMSK))))
5995 /* call with brightness_mutex held! */
5996 static int tpacpi_brightness_set_ucmsstep(unsigned int value)
5999 unsigned int current_value, i;
6001 current_value = tpacpi_brightness_nvram_get();
6003 if (value == current_value)
6006 cmos_cmd = (value > current_value) ?
6007 TP_CMOS_BRIGHTNESS_UP :
6008 TP_CMOS_BRIGHTNESS_DOWN;
6009 inc = (value > current_value) ? 1 : -1;
6011 for (i = current_value; i != value; i += inc)
6012 if (issue_thinkpad_cmos_command(cmos_cmd))
6018 /* May return EINTR which can always be mapped to ERESTARTSYS */
6019 static int brightness_set(unsigned int value)
6023 if (value > ((tp_features.bright_16levels)? 15 : 7) ||
6027 vdbg_printk(TPACPI_DBG_BRGHT,
6028 "set backlight level to %d\n", value);
6030 res = mutex_lock_killable(&brightness_mutex);
6034 switch (brightness_mode) {
6035 case TPACPI_BRGHT_MODE_EC:
6036 case TPACPI_BRGHT_MODE_ECNVRAM:
6037 res = tpacpi_brightness_set_ec(value);
6039 case TPACPI_BRGHT_MODE_UCMS_STEP:
6040 res = tpacpi_brightness_set_ucmsstep(value);
6046 mutex_unlock(&brightness_mutex);
6050 /* sysfs backlight class ----------------------------------------------- */
6052 static int brightness_update_status(struct backlight_device *bd)
6054 unsigned int level =
6055 (bd->props.fb_blank == FB_BLANK_UNBLANK &&
6056 bd->props.power == FB_BLANK_UNBLANK) ?
6057 bd->props.brightness : 0;
6059 dbg_printk(TPACPI_DBG_BRGHT,
6060 "backlight: attempt to set level to %d\n",
6063 /* it is the backlight class's job (caller) to handle
6064 * EINTR and other errors properly */
6065 return brightness_set(level);
6068 static int brightness_get(struct backlight_device *bd)
6072 res = mutex_lock_killable(&brightness_mutex);
6076 res = tpacpi_brightness_get_raw(&status);
6078 mutex_unlock(&brightness_mutex);
6083 return status & TP_EC_BACKLIGHT_LVLMSK;
6086 static struct backlight_ops ibm_backlight_data = {
6087 .get_brightness = brightness_get,
6088 .update_status = brightness_update_status,
6091 /* --------------------------------------------------------------------- */
6094 * These are only useful for models that have only one possibility
6095 * of GPU. If the BIOS model handles both ATI and Intel, don't use
6098 #define TPACPI_BRGHT_Q_NOEC 0x0001 /* Must NOT use EC HBRV */
6099 #define TPACPI_BRGHT_Q_EC 0x0002 /* Should or must use EC HBRV */
6100 #define TPACPI_BRGHT_Q_ASK 0x8000 /* Ask for user report */
6102 static const struct tpacpi_quirk brightness_quirk_table[] __initconst = {
6103 /* Models with ATI GPUs known to require ECNVRAM mode */
6104 TPACPI_Q_IBM('1', 'Y', TPACPI_BRGHT_Q_EC), /* T43/p ATI */
6106 /* Models with ATI GPUs that can use ECNVRAM */
6107 TPACPI_Q_IBM('1', 'R', TPACPI_BRGHT_Q_EC),
6108 TPACPI_Q_IBM('1', 'Q', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6109 TPACPI_Q_IBM('7', '6', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6110 TPACPI_Q_IBM('7', '8', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_EC),
6112 /* Models with Intel Extreme Graphics 2 */
6113 TPACPI_Q_IBM('1', 'U', TPACPI_BRGHT_Q_NOEC),
6114 TPACPI_Q_IBM('1', 'V', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_NOEC),
6115 TPACPI_Q_IBM('1', 'W', TPACPI_BRGHT_Q_ASK|TPACPI_BRGHT_Q_NOEC),
6117 /* Models with Intel GMA900 */
6118 TPACPI_Q_IBM('7', '0', TPACPI_BRGHT_Q_NOEC), /* T43, R52 */
6119 TPACPI_Q_IBM('7', '4', TPACPI_BRGHT_Q_NOEC), /* X41 */
6120 TPACPI_Q_IBM('7', '5', TPACPI_BRGHT_Q_NOEC), /* X41 Tablet */
6123 static int __init brightness_init(struct ibm_init_struct *iibm)
6126 unsigned long quirks;
6128 vdbg_printk(TPACPI_DBG_INIT, "initializing brightness subdriver\n");
6130 mutex_init(&brightness_mutex);
6132 quirks = tpacpi_check_quirks(brightness_quirk_table,
6133 ARRAY_SIZE(brightness_quirk_table));
6136 * We always attempt to detect acpi support, so as to switch
6137 * Lenovo Vista BIOS to ACPI brightness mode even if we are not
6138 * going to publish a backlight interface
6140 b = tpacpi_check_std_acpi_brightness_support();
6143 if (acpi_video_backlight_support()) {
6144 if (brightness_enable > 1) {
6145 printk(TPACPI_NOTICE
6146 "Standard ACPI backlight interface "
6147 "available, not loading native one.\n");
6149 } else if (brightness_enable == 1) {
6150 printk(TPACPI_NOTICE
6151 "Backlight control force enabled, even if standard "
6152 "ACPI backlight interface is available\n");
6155 if (brightness_enable > 1) {
6156 printk(TPACPI_NOTICE
6157 "Standard ACPI backlight interface not "
6158 "available, thinkpad_acpi native "
6159 "brightness control enabled\n");
6164 if (!brightness_enable) {
6165 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6166 "brightness support disabled by "
6167 "module parameter\n");
6173 "Unsupported brightness interface, "
6174 "please contact %s\n", TPACPI_MAIL);
6178 tp_features.bright_16levels = 1;
6181 * Check for module parameter bogosity, note that we
6182 * init brightness_mode to TPACPI_BRGHT_MODE_MAX in order to be
6183 * able to detect "unspecified"
6185 if (brightness_mode > TPACPI_BRGHT_MODE_MAX)
6188 /* TPACPI_BRGHT_MODE_AUTO not implemented yet, just use default */
6189 if (brightness_mode == TPACPI_BRGHT_MODE_AUTO ||
6190 brightness_mode == TPACPI_BRGHT_MODE_MAX) {
6191 if (quirks & TPACPI_BRGHT_Q_EC)
6192 brightness_mode = TPACPI_BRGHT_MODE_ECNVRAM;
6194 brightness_mode = TPACPI_BRGHT_MODE_UCMS_STEP;
6196 dbg_printk(TPACPI_DBG_BRGHT,
6197 "driver auto-selected brightness_mode=%d\n",
6202 if (thinkpad_id.vendor != PCI_VENDOR_ID_IBM &&
6203 (brightness_mode == TPACPI_BRGHT_MODE_ECNVRAM ||
6204 brightness_mode == TPACPI_BRGHT_MODE_EC))
6207 if (tpacpi_brightness_get_raw(&b) < 0)
6210 if (tp_features.bright_16levels)
6212 "detected a 16-level brightness capable ThinkPad\n");
6214 ibm_backlight_device = backlight_device_register(
6215 TPACPI_BACKLIGHT_DEV_NAME, NULL, NULL,
6216 &ibm_backlight_data);
6217 if (IS_ERR(ibm_backlight_device)) {
6218 int rc = PTR_ERR(ibm_backlight_device);
6219 ibm_backlight_device = NULL;
6220 printk(TPACPI_ERR "Could not register backlight device\n");
6223 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_BRGHT,
6224 "brightness is supported\n");
6226 if (quirks & TPACPI_BRGHT_Q_ASK) {
6227 printk(TPACPI_NOTICE
6228 "brightness: will use unverified default: "
6229 "brightness_mode=%d\n", brightness_mode);
6230 printk(TPACPI_NOTICE
6231 "brightness: please report to %s whether it works well "
6232 "or not on your ThinkPad\n", TPACPI_MAIL);
6235 ibm_backlight_device->props.max_brightness =
6236 (tp_features.bright_16levels)? 15 : 7;
6237 ibm_backlight_device->props.brightness = b & TP_EC_BACKLIGHT_LVLMSK;
6238 backlight_update_status(ibm_backlight_device);
6243 static void brightness_suspend(pm_message_t state)
6245 tpacpi_brightness_checkpoint_nvram();
6248 static void brightness_shutdown(void)
6250 tpacpi_brightness_checkpoint_nvram();
6253 static void brightness_exit(void)
6255 if (ibm_backlight_device) {
6256 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_BRGHT,
6257 "calling backlight_device_unregister()\n");
6258 backlight_device_unregister(ibm_backlight_device);
6261 tpacpi_brightness_checkpoint_nvram();
6264 static int brightness_read(char *p)
6269 level = brightness_get(NULL);
6271 len += sprintf(p + len, "level:\t\tunreadable\n");
6273 len += sprintf(p + len, "level:\t\t%d\n", level);
6274 len += sprintf(p + len, "commands:\tup, down\n");
6275 len += sprintf(p + len, "commands:\tlevel <level>"
6276 " (<level> is 0-%d)\n",
6277 (tp_features.bright_16levels) ? 15 : 7);
6283 static int brightness_write(char *buf)
6288 int max_level = (tp_features.bright_16levels) ? 15 : 7;
6290 level = brightness_get(NULL);
6294 while ((cmd = next_cmd(&buf))) {
6295 if (strlencmp(cmd, "up") == 0) {
6296 if (level < max_level)
6298 } else if (strlencmp(cmd, "down") == 0) {
6301 } else if (sscanf(cmd, "level %d", &level) == 1 &&
6302 level >= 0 && level <= max_level) {
6308 tpacpi_disclose_usertask("procfs brightness",
6309 "set level to %d\n", level);
6312 * Now we know what the final level should be, so we try to set it.
6313 * Doing it this way makes the syscall restartable in case of EINTR
6315 rc = brightness_set(level);
6316 return (rc == -EINTR)? ERESTARTSYS : rc;
6319 static struct ibm_struct brightness_driver_data = {
6320 .name = "brightness",
6321 .read = brightness_read,
6322 .write = brightness_write,
6323 .exit = brightness_exit,
6324 .suspend = brightness_suspend,
6325 .shutdown = brightness_shutdown,
6328 /*************************************************************************
6332 static int volume_offset = 0x30;
6334 static int volume_read(char *p)
6339 if (!acpi_ec_read(volume_offset, &level)) {
6340 len += sprintf(p + len, "level:\t\tunreadable\n");
6342 len += sprintf(p + len, "level:\t\t%d\n", level & 0xf);
6343 len += sprintf(p + len, "mute:\t\t%s\n", onoff(level, 6));
6344 len += sprintf(p + len, "commands:\tup, down, mute\n");
6345 len += sprintf(p + len, "commands:\tlevel <level>"
6346 " (<level> is 0-15)\n");
6352 static int volume_write(char *buf)
6354 int cmos_cmd, inc, i;
6356 int new_level, new_mute;
6359 while ((cmd = next_cmd(&buf))) {
6360 if (!acpi_ec_read(volume_offset, &level))
6362 new_mute = mute = level & 0x40;
6363 new_level = level = level & 0xf;
6365 if (strlencmp(cmd, "up") == 0) {
6369 new_level = level == 15 ? 15 : level + 1;
6370 } else if (strlencmp(cmd, "down") == 0) {
6374 new_level = level == 0 ? 0 : level - 1;
6375 } else if (sscanf(cmd, "level %d", &new_level) == 1 &&
6376 new_level >= 0 && new_level <= 15) {
6378 } else if (strlencmp(cmd, "mute") == 0) {
6383 if (new_level != level) {
6384 /* mute doesn't change */
6386 cmos_cmd = (new_level > level) ?
6387 TP_CMOS_VOLUME_UP : TP_CMOS_VOLUME_DOWN;
6388 inc = new_level > level ? 1 : -1;
6390 if (mute && (issue_thinkpad_cmos_command(cmos_cmd) ||
6391 !acpi_ec_write(volume_offset, level)))
6394 for (i = level; i != new_level; i += inc)
6395 if (issue_thinkpad_cmos_command(cmos_cmd) ||
6396 !acpi_ec_write(volume_offset, i + inc))
6400 (issue_thinkpad_cmos_command(TP_CMOS_VOLUME_MUTE) ||
6401 !acpi_ec_write(volume_offset, new_level + mute))) {
6406 if (new_mute != mute) {
6407 /* level doesn't change */
6409 cmos_cmd = (new_mute) ?
6410 TP_CMOS_VOLUME_MUTE : TP_CMOS_VOLUME_UP;
6412 if (issue_thinkpad_cmos_command(cmos_cmd) ||
6413 !acpi_ec_write(volume_offset, level + new_mute))
6421 static struct ibm_struct volume_driver_data = {
6423 .read = volume_read,
6424 .write = volume_write,
6427 /*************************************************************************
6434 * TPACPI_FAN_RD_ACPI_GFAN:
6435 * ACPI GFAN method: returns fan level
6437 * see TPACPI_FAN_WR_ACPI_SFAN
6438 * EC 0x2f (HFSP) not available if GFAN exists
6440 * TPACPI_FAN_WR_ACPI_SFAN:
6441 * ACPI SFAN method: sets fan level, 0 (stop) to 7 (max)
6443 * EC 0x2f (HFSP) might be available *for reading*, but do not use
6446 * TPACPI_FAN_WR_TPEC:
6447 * ThinkPad EC register 0x2f (HFSP): fan control loop mode
6448 * Supported on almost all ThinkPads
6450 * Fan speed changes of any sort (including those caused by the
6451 * disengaged mode) are usually done slowly by the firmware as the
6452 * maximum ammount of fan duty cycle change per second seems to be
6455 * Reading is not available if GFAN exists.
6456 * Writing is not available if SFAN exists.
6459 * 7 automatic mode engaged;
6460 * (default operation mode of the ThinkPad)
6461 * fan level is ignored in this mode.
6462 * 6 full speed mode (takes precedence over bit 7);
6463 * not available on all thinkpads. May disable
6464 * the tachometer while the fan controller ramps up
6465 * the speed (which can take up to a few *minutes*).
6466 * Speeds up fan to 100% duty-cycle, which is far above
6467 * the standard RPM levels. It is not impossible that
6468 * it could cause hardware damage.
6469 * 5-3 unused in some models. Extra bits for fan level
6470 * in others, but still useless as all values above
6471 * 7 map to the same speed as level 7 in these models.
6472 * 2-0 fan level (0..7 usually)
6474 * 0x07 = max (set when temperatures critical)
6475 * Some ThinkPads may have other levels, see
6476 * TPACPI_FAN_WR_ACPI_FANS (X31/X40/X41)
6478 * FIRMWARE BUG: on some models, EC 0x2f might not be initialized at
6479 * boot. Apparently the EC does not intialize it, so unless ACPI DSDT
6480 * does so, its initial value is meaningless (0x07).
6482 * For firmware bugs, refer to:
6483 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
6487 * ThinkPad EC register 0x84 (LSB), 0x85 (MSB):
6488 * Main fan tachometer reading (in RPM)
6490 * This register is present on all ThinkPads with a new-style EC, and
6491 * it is known not to be present on the A21m/e, and T22, as there is
6492 * something else in offset 0x84 according to the ACPI DSDT. Other
6493 * ThinkPads from this same time period (and earlier) probably lack the
6494 * tachometer as well.
6496 * Unfortunately a lot of ThinkPads with new-style ECs but whose firmware
6497 * was never fixed by IBM to report the EC firmware version string
6498 * probably support the tachometer (like the early X models), so
6499 * detecting it is quite hard. We need more data to know for sure.
6501 * FIRMWARE BUG: always read 0x84 first, otherwise incorrect readings
6504 * FIRMWARE BUG: may go stale while the EC is switching to full speed
6507 * For firmware bugs, refer to:
6508 * http://thinkwiki.org/wiki/Embedded_Controller_Firmware#Firmware_Issues
6512 * ThinkPad EC register 0x31 bit 0 (only on select models)
6514 * When bit 0 of EC register 0x31 is zero, the tachometer registers
6515 * show the speed of the main fan. When bit 0 of EC register 0x31
6516 * is one, the tachometer registers show the speed of the auxiliary
6519 * Fan control seems to affect both fans, regardless of the state
6522 * So far, only the firmware for the X60/X61 non-tablet versions
6523 * seem to support this (firmware TP-7M).
6525 * TPACPI_FAN_WR_ACPI_FANS:
6526 * ThinkPad X31, X40, X41. Not available in the X60.
6528 * FANS ACPI handle: takes three arguments: low speed, medium speed,
6529 * high speed. ACPI DSDT seems to map these three speeds to levels
6530 * as follows: STOP LOW LOW MED MED HIGH HIGH HIGH HIGH
6531 * (this map is stored on FAN0..FAN8 as "0,1,1,2,2,3,3,3,3")
6533 * The speeds are stored on handles
6534 * (FANA:FAN9), (FANC:FANB), (FANE:FAND).
6536 * There are three default speed sets, accessible as handles:
6537 * FS1L,FS1M,FS1H; FS2L,FS2M,FS2H; FS3L,FS3M,FS3H
6539 * ACPI DSDT switches which set is in use depending on various
6542 * TPACPI_FAN_WR_TPEC is also available and should be used to
6543 * command the fan. The X31/X40/X41 seems to have 8 fan levels,
6544 * but the ACPI tables just mention level 7.
6547 enum { /* Fan control constants */
6548 fan_status_offset = 0x2f, /* EC register 0x2f */
6549 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
6550 * 0x84 must be read before 0x85 */
6551 fan_select_offset = 0x31, /* EC register 0x31 (Firmware 7M)
6552 bit 0 selects which fan is active */
6554 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
6555 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
6557 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
6560 enum fan_status_access_mode {
6561 TPACPI_FAN_NONE = 0, /* No fan status or control */
6562 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
6563 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
6566 enum fan_control_access_mode {
6567 TPACPI_FAN_WR_NONE = 0, /* No fan control */
6568 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
6569 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
6570 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
6573 enum fan_control_commands {
6574 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
6575 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
6576 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
6577 * and also watchdog cmd */
6580 static int fan_control_allowed;
6582 static enum fan_status_access_mode fan_status_access_mode;
6583 static enum fan_control_access_mode fan_control_access_mode;
6584 static enum fan_control_commands fan_control_commands;
6586 static u8 fan_control_initial_status;
6587 static u8 fan_control_desired_level;
6588 static u8 fan_control_resume_level;
6589 static int fan_watchdog_maxinterval;
6591 static struct mutex fan_mutex;
6593 static void fan_watchdog_fire(struct work_struct *ignored);
6594 static DECLARE_DELAYED_WORK(fan_watchdog_task, fan_watchdog_fire);
6596 TPACPI_HANDLE(fans, ec, "FANS"); /* X31, X40, X41 */
6597 TPACPI_HANDLE(gfan, ec, "GFAN", /* 570 */
6598 "\\FSPD", /* 600e/x, 770e, 770x */
6600 TPACPI_HANDLE(sfan, ec, "SFAN", /* 570 */
6601 "JFNS", /* 770x-JL */
6605 * Unitialized HFSP quirk: ACPI DSDT and EC fail to initialize the
6606 * HFSP register at boot, so it contains 0x07 but the Thinkpad could
6607 * be in auto mode (0x80).
6609 * This is corrected by any write to HFSP either by the driver, or
6612 * We assume 0x07 really means auto mode while this quirk is active,
6613 * as this is far more likely than the ThinkPad being in level 7,
6614 * which is only used by the firmware during thermal emergencies.
6616 * Enable for TP-1Y (T43), TP-78 (R51e), TP-76 (R52),
6617 * TP-70 (T43, R52), which are known to be buggy.
6620 static void fan_quirk1_setup(void)
6622 if (fan_control_initial_status == 0x07) {
6623 printk(TPACPI_NOTICE
6624 "fan_init: initial fan status is unknown, "
6625 "assuming it is in auto mode\n");
6626 tp_features.fan_ctrl_status_undef = 1;
6630 static void fan_quirk1_handle(u8 *fan_status)
6632 if (unlikely(tp_features.fan_ctrl_status_undef)) {
6633 if (*fan_status != fan_control_initial_status) {
6634 /* something changed the HFSP regisnter since
6635 * driver init time, so it is not undefined
6637 tp_features.fan_ctrl_status_undef = 0;
6639 /* Return most likely status. In fact, it
6640 * might be the only possible status */
6641 *fan_status = TP_EC_FAN_AUTO;
6646 /* Select main fan on X60/X61, NOOP on others */
6647 static bool fan_select_fan1(void)
6649 if (tp_features.second_fan) {
6652 if (ec_read(fan_select_offset, &val) < 0)
6655 if (ec_write(fan_select_offset, val) < 0)
6661 /* Select secondary fan on X60/X61 */
6662 static bool fan_select_fan2(void)
6666 if (!tp_features.second_fan)
6669 if (ec_read(fan_select_offset, &val) < 0)
6672 if (ec_write(fan_select_offset, val) < 0)
6679 * Call with fan_mutex held
6681 static void fan_update_desired_level(u8 status)
6684 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
6686 fan_control_desired_level = 7;
6688 fan_control_desired_level = status;
6692 static int fan_get_status(u8 *status)
6697 * Add TPACPI_FAN_RD_ACPI_FANS ? */
6699 switch (fan_status_access_mode) {
6700 case TPACPI_FAN_RD_ACPI_GFAN:
6701 /* 570, 600e/x, 770e, 770x */
6703 if (unlikely(!acpi_evalf(gfan_handle, &s, NULL, "d")))
6711 case TPACPI_FAN_RD_TPEC:
6712 /* all except 570, 600e/x, 770e, 770x */
6713 if (unlikely(!acpi_ec_read(fan_status_offset, &s)))
6716 if (likely(status)) {
6718 fan_quirk1_handle(status);
6730 static int fan_get_status_safe(u8 *status)
6735 if (mutex_lock_killable(&fan_mutex))
6736 return -ERESTARTSYS;
6737 rc = fan_get_status(&s);
6739 fan_update_desired_level(s);
6740 mutex_unlock(&fan_mutex);
6748 static int fan_get_speed(unsigned int *speed)
6752 switch (fan_status_access_mode) {
6753 case TPACPI_FAN_RD_TPEC:
6754 /* all except 570, 600e/x, 770e, 770x */
6755 if (unlikely(!fan_select_fan1()))
6757 if (unlikely(!acpi_ec_read(fan_rpm_offset, &lo) ||
6758 !acpi_ec_read(fan_rpm_offset + 1, &hi)))
6762 *speed = (hi << 8) | lo;
6773 static int fan2_get_speed(unsigned int *speed)
6778 switch (fan_status_access_mode) {
6779 case TPACPI_FAN_RD_TPEC:
6780 /* all except 570, 600e/x, 770e, 770x */
6781 if (unlikely(!fan_select_fan2()))
6783 rc = !acpi_ec_read(fan_rpm_offset, &lo) ||
6784 !acpi_ec_read(fan_rpm_offset + 1, &hi);
6785 fan_select_fan1(); /* play it safe */
6790 *speed = (hi << 8) | lo;
6801 static int fan_set_level(int level)
6803 if (!fan_control_allowed)
6806 switch (fan_control_access_mode) {
6807 case TPACPI_FAN_WR_ACPI_SFAN:
6808 if (level >= 0 && level <= 7) {
6809 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", level))
6815 case TPACPI_FAN_WR_ACPI_FANS:
6816 case TPACPI_FAN_WR_TPEC:
6817 if (!(level & TP_EC_FAN_AUTO) &&
6818 !(level & TP_EC_FAN_FULLSPEED) &&
6819 ((level < 0) || (level > 7)))
6822 /* safety net should the EC not support AUTO
6823 * or FULLSPEED mode bits and just ignore them */
6824 if (level & TP_EC_FAN_FULLSPEED)
6825 level |= 7; /* safety min speed 7 */
6826 else if (level & TP_EC_FAN_AUTO)
6827 level |= 4; /* safety min speed 4 */
6829 if (!acpi_ec_write(fan_status_offset, level))
6832 tp_features.fan_ctrl_status_undef = 0;
6839 vdbg_printk(TPACPI_DBG_FAN,
6840 "fan control: set fan control register to 0x%02x\n", level);
6844 static int fan_set_level_safe(int level)
6848 if (!fan_control_allowed)
6851 if (mutex_lock_killable(&fan_mutex))
6852 return -ERESTARTSYS;
6854 if (level == TPACPI_FAN_LAST_LEVEL)
6855 level = fan_control_desired_level;
6857 rc = fan_set_level(level);
6859 fan_update_desired_level(level);
6861 mutex_unlock(&fan_mutex);
6865 static int fan_set_enable(void)
6870 if (!fan_control_allowed)
6873 if (mutex_lock_killable(&fan_mutex))
6874 return -ERESTARTSYS;
6876 switch (fan_control_access_mode) {
6877 case TPACPI_FAN_WR_ACPI_FANS:
6878 case TPACPI_FAN_WR_TPEC:
6879 rc = fan_get_status(&s);
6883 /* Don't go out of emergency fan mode */
6886 s |= TP_EC_FAN_AUTO | 4; /* min fan speed 4 */
6889 if (!acpi_ec_write(fan_status_offset, s))
6892 tp_features.fan_ctrl_status_undef = 0;
6897 case TPACPI_FAN_WR_ACPI_SFAN:
6898 rc = fan_get_status(&s);
6904 /* Set fan to at least level 4 */
6907 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", s))
6917 mutex_unlock(&fan_mutex);
6920 vdbg_printk(TPACPI_DBG_FAN,
6921 "fan control: set fan control register to 0x%02x\n",
6926 static int fan_set_disable(void)
6930 if (!fan_control_allowed)
6933 if (mutex_lock_killable(&fan_mutex))
6934 return -ERESTARTSYS;
6937 switch (fan_control_access_mode) {
6938 case TPACPI_FAN_WR_ACPI_FANS:
6939 case TPACPI_FAN_WR_TPEC:
6940 if (!acpi_ec_write(fan_status_offset, 0x00))
6943 fan_control_desired_level = 0;
6944 tp_features.fan_ctrl_status_undef = 0;
6948 case TPACPI_FAN_WR_ACPI_SFAN:
6949 if (!acpi_evalf(sfan_handle, NULL, NULL, "vd", 0x00))
6952 fan_control_desired_level = 0;
6960 vdbg_printk(TPACPI_DBG_FAN,
6961 "fan control: set fan control register to 0\n");
6963 mutex_unlock(&fan_mutex);
6967 static int fan_set_speed(int speed)
6971 if (!fan_control_allowed)
6974 if (mutex_lock_killable(&fan_mutex))
6975 return -ERESTARTSYS;
6978 switch (fan_control_access_mode) {
6979 case TPACPI_FAN_WR_ACPI_FANS:
6980 if (speed >= 0 && speed <= 65535) {
6981 if (!acpi_evalf(fans_handle, NULL, NULL, "vddd",
6982 speed, speed, speed))
6992 mutex_unlock(&fan_mutex);
6996 static void fan_watchdog_reset(void)
6998 static int fan_watchdog_active;
7000 if (fan_control_access_mode == TPACPI_FAN_WR_NONE)
7003 if (fan_watchdog_active)
7004 cancel_delayed_work(&fan_watchdog_task);
7006 if (fan_watchdog_maxinterval > 0 &&
7007 tpacpi_lifecycle != TPACPI_LIFE_EXITING) {
7008 fan_watchdog_active = 1;
7009 if (!queue_delayed_work(tpacpi_wq, &fan_watchdog_task,
7010 msecs_to_jiffies(fan_watchdog_maxinterval
7013 "failed to queue the fan watchdog, "
7014 "watchdog will not trigger\n");
7017 fan_watchdog_active = 0;
7020 static void fan_watchdog_fire(struct work_struct *ignored)
7024 if (tpacpi_lifecycle != TPACPI_LIFE_RUNNING)
7027 printk(TPACPI_NOTICE "fan watchdog: enabling fan\n");
7028 rc = fan_set_enable();
7030 printk(TPACPI_ERR "fan watchdog: error %d while enabling fan, "
7031 "will try again later...\n", -rc);
7032 /* reschedule for later */
7033 fan_watchdog_reset();
7038 * SYSFS fan layout: hwmon compatible (device)
7041 * 0: "disengaged" mode
7043 * 2: native EC "auto" mode (recommended, hardware default)
7045 * pwm*: set speed in manual mode, ignored otherwise.
7046 * 0 is level 0; 255 is level 7. Intermediate points done with linear
7049 * fan*_input: tachometer reading, RPM
7052 * SYSFS fan layout: extensions
7054 * fan_watchdog (driver):
7055 * fan watchdog interval in seconds, 0 disables (default), max 120
7058 /* sysfs fan pwm1_enable ----------------------------------------------- */
7059 static ssize_t fan_pwm1_enable_show(struct device *dev,
7060 struct device_attribute *attr,
7066 res = fan_get_status_safe(&status);
7070 if (status & TP_EC_FAN_FULLSPEED) {
7072 } else if (status & TP_EC_FAN_AUTO) {
7077 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
7080 static ssize_t fan_pwm1_enable_store(struct device *dev,
7081 struct device_attribute *attr,
7082 const char *buf, size_t count)
7087 if (parse_strtoul(buf, 2, &t))
7090 tpacpi_disclose_usertask("hwmon pwm1_enable",
7091 "set fan mode to %lu\n", t);
7095 level = TP_EC_FAN_FULLSPEED;
7098 level = TPACPI_FAN_LAST_LEVEL;
7101 level = TP_EC_FAN_AUTO;
7104 /* reserved for software-controlled auto mode */
7110 res = fan_set_level_safe(level);
7116 fan_watchdog_reset();
7121 static struct device_attribute dev_attr_fan_pwm1_enable =
7122 __ATTR(pwm1_enable, S_IWUSR | S_IRUGO,
7123 fan_pwm1_enable_show, fan_pwm1_enable_store);
7125 /* sysfs fan pwm1 ------------------------------------------------------ */
7126 static ssize_t fan_pwm1_show(struct device *dev,
7127 struct device_attribute *attr,
7133 res = fan_get_status_safe(&status);
7138 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) != 0)
7139 status = fan_control_desired_level;
7144 return snprintf(buf, PAGE_SIZE, "%u\n", (status * 255) / 7);
7147 static ssize_t fan_pwm1_store(struct device *dev,
7148 struct device_attribute *attr,
7149 const char *buf, size_t count)
7153 u8 status, newlevel;
7155 if (parse_strtoul(buf, 255, &s))
7158 tpacpi_disclose_usertask("hwmon pwm1",
7159 "set fan speed to %lu\n", s);
7161 /* scale down from 0-255 to 0-7 */
7162 newlevel = (s >> 5) & 0x07;
7164 if (mutex_lock_killable(&fan_mutex))
7165 return -ERESTARTSYS;
7167 rc = fan_get_status(&status);
7168 if (!rc && (status &
7169 (TP_EC_FAN_AUTO | TP_EC_FAN_FULLSPEED)) == 0) {
7170 rc = fan_set_level(newlevel);
7174 fan_update_desired_level(newlevel);
7175 fan_watchdog_reset();
7179 mutex_unlock(&fan_mutex);
7180 return (rc)? rc : count;
7183 static struct device_attribute dev_attr_fan_pwm1 =
7184 __ATTR(pwm1, S_IWUSR | S_IRUGO,
7185 fan_pwm1_show, fan_pwm1_store);
7187 /* sysfs fan fan1_input ------------------------------------------------ */
7188 static ssize_t fan_fan1_input_show(struct device *dev,
7189 struct device_attribute *attr,
7195 res = fan_get_speed(&speed);
7199 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7202 static struct device_attribute dev_attr_fan_fan1_input =
7203 __ATTR(fan1_input, S_IRUGO,
7204 fan_fan1_input_show, NULL);
7206 /* sysfs fan fan2_input ------------------------------------------------ */
7207 static ssize_t fan_fan2_input_show(struct device *dev,
7208 struct device_attribute *attr,
7214 res = fan2_get_speed(&speed);
7218 return snprintf(buf, PAGE_SIZE, "%u\n", speed);
7221 static struct device_attribute dev_attr_fan_fan2_input =
7222 __ATTR(fan2_input, S_IRUGO,
7223 fan_fan2_input_show, NULL);
7225 /* sysfs fan fan_watchdog (hwmon driver) ------------------------------- */
7226 static ssize_t fan_fan_watchdog_show(struct device_driver *drv,
7229 return snprintf(buf, PAGE_SIZE, "%u\n", fan_watchdog_maxinterval);
7232 static ssize_t fan_fan_watchdog_store(struct device_driver *drv,
7233 const char *buf, size_t count)
7237 if (parse_strtoul(buf, 120, &t))
7240 if (!fan_control_allowed)
7243 fan_watchdog_maxinterval = t;
7244 fan_watchdog_reset();
7246 tpacpi_disclose_usertask("fan_watchdog", "set to %lu\n", t);
7251 static DRIVER_ATTR(fan_watchdog, S_IWUSR | S_IRUGO,
7252 fan_fan_watchdog_show, fan_fan_watchdog_store);
7254 /* --------------------------------------------------------------------- */
7255 static struct attribute *fan_attributes[] = {
7256 &dev_attr_fan_pwm1_enable.attr, &dev_attr_fan_pwm1.attr,
7257 &dev_attr_fan_fan1_input.attr,
7258 NULL, /* for fan2_input */
7262 static const struct attribute_group fan_attr_group = {
7263 .attrs = fan_attributes,
7266 #define TPACPI_FAN_Q1 0x0001 /* Unitialized HFSP */
7267 #define TPACPI_FAN_2FAN 0x0002 /* EC 0x31 bit 0 selects fan2 */
7269 #define TPACPI_FAN_QI(__id1, __id2, __quirks) \
7270 { .vendor = PCI_VENDOR_ID_IBM, \
7271 .bios = TPACPI_MATCH_ANY, \
7272 .ec = TPID(__id1, __id2), \
7273 .quirks = __quirks }
7275 #define TPACPI_FAN_QL(__id1, __id2, __quirks) \
7276 { .vendor = PCI_VENDOR_ID_LENOVO, \
7277 .bios = TPACPI_MATCH_ANY, \
7278 .ec = TPID(__id1, __id2), \
7279 .quirks = __quirks }
7281 static const struct tpacpi_quirk fan_quirk_table[] __initconst = {
7282 TPACPI_FAN_QI('1', 'Y', TPACPI_FAN_Q1),
7283 TPACPI_FAN_QI('7', '8', TPACPI_FAN_Q1),
7284 TPACPI_FAN_QI('7', '6', TPACPI_FAN_Q1),
7285 TPACPI_FAN_QI('7', '0', TPACPI_FAN_Q1),
7286 TPACPI_FAN_QL('7', 'M', TPACPI_FAN_2FAN),
7289 #undef TPACPI_FAN_QL
7290 #undef TPACPI_FAN_QI
7292 static int __init fan_init(struct ibm_init_struct *iibm)
7295 unsigned long quirks;
7297 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7298 "initializing fan subdriver\n");
7300 mutex_init(&fan_mutex);
7301 fan_status_access_mode = TPACPI_FAN_NONE;
7302 fan_control_access_mode = TPACPI_FAN_WR_NONE;
7303 fan_control_commands = 0;
7304 fan_watchdog_maxinterval = 0;
7305 tp_features.fan_ctrl_status_undef = 0;
7306 tp_features.second_fan = 0;
7307 fan_control_desired_level = 7;
7309 TPACPI_ACPIHANDLE_INIT(fans);
7310 TPACPI_ACPIHANDLE_INIT(gfan);
7311 TPACPI_ACPIHANDLE_INIT(sfan);
7313 quirks = tpacpi_check_quirks(fan_quirk_table,
7314 ARRAY_SIZE(fan_quirk_table));
7317 /* 570, 600e/x, 770e, 770x */
7318 fan_status_access_mode = TPACPI_FAN_RD_ACPI_GFAN;
7320 /* all other ThinkPads: note that even old-style
7321 * ThinkPad ECs supports the fan control register */
7322 if (likely(acpi_ec_read(fan_status_offset,
7323 &fan_control_initial_status))) {
7324 fan_status_access_mode = TPACPI_FAN_RD_TPEC;
7325 if (quirks & TPACPI_FAN_Q1)
7327 if (quirks & TPACPI_FAN_2FAN) {
7328 tp_features.second_fan = 1;
7329 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7330 "secondary fan support enabled\n");
7334 "ThinkPad ACPI EC access misbehaving, "
7335 "fan status and control unavailable\n");
7342 fan_control_access_mode = TPACPI_FAN_WR_ACPI_SFAN;
7343 fan_control_commands |=
7344 TPACPI_FAN_CMD_LEVEL | TPACPI_FAN_CMD_ENABLE;
7347 /* gfan without sfan means no fan control */
7348 /* all other models implement TP EC 0x2f control */
7352 fan_control_access_mode =
7353 TPACPI_FAN_WR_ACPI_FANS;
7354 fan_control_commands |=
7355 TPACPI_FAN_CMD_SPEED |
7356 TPACPI_FAN_CMD_LEVEL |
7357 TPACPI_FAN_CMD_ENABLE;
7359 fan_control_access_mode = TPACPI_FAN_WR_TPEC;
7360 fan_control_commands |=
7361 TPACPI_FAN_CMD_LEVEL |
7362 TPACPI_FAN_CMD_ENABLE;
7367 vdbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7368 "fan is %s, modes %d, %d\n",
7369 str_supported(fan_status_access_mode != TPACPI_FAN_NONE ||
7370 fan_control_access_mode != TPACPI_FAN_WR_NONE),
7371 fan_status_access_mode, fan_control_access_mode);
7373 /* fan control master switch */
7374 if (!fan_control_allowed) {
7375 fan_control_access_mode = TPACPI_FAN_WR_NONE;
7376 fan_control_commands = 0;
7377 dbg_printk(TPACPI_DBG_INIT | TPACPI_DBG_FAN,
7378 "fan control features disabled by parameter\n");
7381 /* update fan_control_desired_level */
7382 if (fan_status_access_mode != TPACPI_FAN_NONE)
7383 fan_get_status_safe(NULL);
7385 if (fan_status_access_mode != TPACPI_FAN_NONE ||
7386 fan_control_access_mode != TPACPI_FAN_WR_NONE) {
7387 if (tp_features.second_fan) {
7388 /* attach second fan tachometer */
7389 fan_attributes[ARRAY_SIZE(fan_attributes)-2] =
7390 &dev_attr_fan_fan2_input.attr;
7392 rc = sysfs_create_group(&tpacpi_sensors_pdev->dev.kobj,
7397 rc = driver_create_file(&tpacpi_hwmon_pdriver.driver,
7398 &driver_attr_fan_watchdog);
7400 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj,
7409 static void fan_exit(void)
7411 vdbg_printk(TPACPI_DBG_EXIT | TPACPI_DBG_FAN,
7412 "cancelling any pending fan watchdog tasks\n");
7414 /* FIXME: can we really do this unconditionally? */
7415 sysfs_remove_group(&tpacpi_sensors_pdev->dev.kobj, &fan_attr_group);
7416 driver_remove_file(&tpacpi_hwmon_pdriver.driver,
7417 &driver_attr_fan_watchdog);
7419 cancel_delayed_work(&fan_watchdog_task);
7420 flush_workqueue(tpacpi_wq);
7423 static void fan_suspend(pm_message_t state)
7427 if (!fan_control_allowed)
7430 /* Store fan status in cache */
7431 fan_control_resume_level = 0;
7432 rc = fan_get_status_safe(&fan_control_resume_level);
7434 printk(TPACPI_NOTICE
7435 "failed to read fan level for later "
7436 "restore during resume: %d\n", rc);
7438 /* if it is undefined, don't attempt to restore it.
7440 if (tp_features.fan_ctrl_status_undef)
7441 fan_control_resume_level = 0;
7444 static void fan_resume(void)
7446 u8 current_level = 7;
7447 bool do_set = false;
7450 /* DSDT *always* updates status on resume */
7451 tp_features.fan_ctrl_status_undef = 0;
7453 if (!fan_control_allowed ||
7454 !fan_control_resume_level ||
7455 (fan_get_status_safe(¤t_level) < 0))
7458 switch (fan_control_access_mode) {
7459 case TPACPI_FAN_WR_ACPI_SFAN:
7460 /* never decrease fan level */
7461 do_set = (fan_control_resume_level > current_level);
7463 case TPACPI_FAN_WR_ACPI_FANS:
7464 case TPACPI_FAN_WR_TPEC:
7465 /* never decrease fan level, scale is:
7466 * TP_EC_FAN_FULLSPEED > 7 >= TP_EC_FAN_AUTO
7468 * We expect the firmware to set either 7 or AUTO, but we
7469 * handle FULLSPEED out of paranoia.
7471 * So, we can safely only restore FULLSPEED or 7, anything
7472 * else could slow the fan. Restoring AUTO is useless, at
7473 * best that's exactly what the DSDT already set (it is the
7476 * Always keep in mind that the DSDT *will* have set the
7477 * fans to what the vendor supposes is the best level. We
7478 * muck with it only to speed the fan up.
7480 if (fan_control_resume_level != 7 &&
7481 !(fan_control_resume_level & TP_EC_FAN_FULLSPEED))
7484 do_set = !(current_level & TP_EC_FAN_FULLSPEED) &&
7485 (current_level != fan_control_resume_level);
7491 printk(TPACPI_NOTICE
7492 "restoring fan level to 0x%02x\n",
7493 fan_control_resume_level);
7494 rc = fan_set_level_safe(fan_control_resume_level);
7496 printk(TPACPI_NOTICE
7497 "failed to restore fan level: %d\n", rc);
7501 static int fan_read(char *p)
7506 unsigned int speed = 0;
7508 switch (fan_status_access_mode) {
7509 case TPACPI_FAN_RD_ACPI_GFAN:
7510 /* 570, 600e/x, 770e, 770x */
7511 rc = fan_get_status_safe(&status);
7515 len += sprintf(p + len, "status:\t\t%s\n"
7517 (status != 0) ? "enabled" : "disabled", status);
7520 case TPACPI_FAN_RD_TPEC:
7521 /* all except 570, 600e/x, 770e, 770x */
7522 rc = fan_get_status_safe(&status);
7526 len += sprintf(p + len, "status:\t\t%s\n",
7527 (status != 0) ? "enabled" : "disabled");
7529 rc = fan_get_speed(&speed);
7533 len += sprintf(p + len, "speed:\t\t%d\n", speed);
7535 if (status & TP_EC_FAN_FULLSPEED)
7536 /* Disengaged mode takes precedence */
7537 len += sprintf(p + len, "level:\t\tdisengaged\n");
7538 else if (status & TP_EC_FAN_AUTO)
7539 len += sprintf(p + len, "level:\t\tauto\n");
7541 len += sprintf(p + len, "level:\t\t%d\n", status);
7544 case TPACPI_FAN_NONE:
7546 len += sprintf(p + len, "status:\t\tnot supported\n");
7549 if (fan_control_commands & TPACPI_FAN_CMD_LEVEL) {
7550 len += sprintf(p + len, "commands:\tlevel <level>");
7552 switch (fan_control_access_mode) {
7553 case TPACPI_FAN_WR_ACPI_SFAN:
7554 len += sprintf(p + len, " (<level> is 0-7)\n");
7558 len += sprintf(p + len, " (<level> is 0-7, "
7559 "auto, disengaged, full-speed)\n");
7564 if (fan_control_commands & TPACPI_FAN_CMD_ENABLE)
7565 len += sprintf(p + len, "commands:\tenable, disable\n"
7566 "commands:\twatchdog <timeout> (<timeout> "
7567 "is 0 (off), 1-120 (seconds))\n");
7569 if (fan_control_commands & TPACPI_FAN_CMD_SPEED)
7570 len += sprintf(p + len, "commands:\tspeed <speed>"
7571 " (<speed> is 0-65535)\n");
7576 static int fan_write_cmd_level(const char *cmd, int *rc)
7580 if (strlencmp(cmd, "level auto") == 0)
7581 level = TP_EC_FAN_AUTO;
7582 else if ((strlencmp(cmd, "level disengaged") == 0) |
7583 (strlencmp(cmd, "level full-speed") == 0))
7584 level = TP_EC_FAN_FULLSPEED;
7585 else if (sscanf(cmd, "level %d", &level) != 1)
7588 *rc = fan_set_level_safe(level);
7590 printk(TPACPI_ERR "level command accepted for unsupported "
7591 "access mode %d", fan_control_access_mode);
7593 tpacpi_disclose_usertask("procfs fan",
7594 "set level to %d\n", level);
7599 static int fan_write_cmd_enable(const char *cmd, int *rc)
7601 if (strlencmp(cmd, "enable") != 0)
7604 *rc = fan_set_enable();
7606 printk(TPACPI_ERR "enable command accepted for unsupported "
7607 "access mode %d", fan_control_access_mode);
7609 tpacpi_disclose_usertask("procfs fan", "enable\n");
7614 static int fan_write_cmd_disable(const char *cmd, int *rc)
7616 if (strlencmp(cmd, "disable") != 0)
7619 *rc = fan_set_disable();
7621 printk(TPACPI_ERR "disable command accepted for unsupported "
7622 "access mode %d", fan_control_access_mode);
7624 tpacpi_disclose_usertask("procfs fan", "disable\n");
7629 static int fan_write_cmd_speed(const char *cmd, int *rc)
7634 * Support speed <low> <medium> <high> ? */
7636 if (sscanf(cmd, "speed %d", &speed) != 1)
7639 *rc = fan_set_speed(speed);
7641 printk(TPACPI_ERR "speed command accepted for unsupported "
7642 "access mode %d", fan_control_access_mode);
7644 tpacpi_disclose_usertask("procfs fan",
7645 "set speed to %d\n", speed);
7650 static int fan_write_cmd_watchdog(const char *cmd, int *rc)
7654 if (sscanf(cmd, "watchdog %d", &interval) != 1)
7657 if (interval < 0 || interval > 120)
7660 fan_watchdog_maxinterval = interval;
7661 tpacpi_disclose_usertask("procfs fan",
7662 "set watchdog timer to %d\n",
7669 static int fan_write(char *buf)
7674 while (!rc && (cmd = next_cmd(&buf))) {
7675 if (!((fan_control_commands & TPACPI_FAN_CMD_LEVEL) &&
7676 fan_write_cmd_level(cmd, &rc)) &&
7677 !((fan_control_commands & TPACPI_FAN_CMD_ENABLE) &&
7678 (fan_write_cmd_enable(cmd, &rc) ||
7679 fan_write_cmd_disable(cmd, &rc) ||
7680 fan_write_cmd_watchdog(cmd, &rc))) &&
7681 !((fan_control_commands & TPACPI_FAN_CMD_SPEED) &&
7682 fan_write_cmd_speed(cmd, &rc))
7686 fan_watchdog_reset();
7692 static struct ibm_struct fan_driver_data = {
7697 .suspend = fan_suspend,
7698 .resume = fan_resume,
7701 /****************************************************************************
7702 ****************************************************************************
7706 ****************************************************************************
7707 ****************************************************************************/
7710 * HKEY event callout for other subdrivers go here
7711 * (yes, it is ugly, but it is quick, safe, and gets the job done
7713 static void tpacpi_driver_event(const unsigned int hkey_event)
7719 static void hotkey_driver_event(const unsigned int scancode)
7721 tpacpi_driver_event(TP_HKEY_EV_HOTKEY_BASE + scancode);
7724 /* sysfs name ---------------------------------------------------------- */
7725 static ssize_t thinkpad_acpi_pdev_name_show(struct device *dev,
7726 struct device_attribute *attr,
7729 return snprintf(buf, PAGE_SIZE, "%s\n", TPACPI_NAME);
7732 static struct device_attribute dev_attr_thinkpad_acpi_pdev_name =
7733 __ATTR(name, S_IRUGO, thinkpad_acpi_pdev_name_show, NULL);
7735 /* --------------------------------------------------------------------- */
7738 static struct proc_dir_entry *proc_dir;
7741 * Module and infrastructure proble, init and exit handling
7744 static int force_load;
7746 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
7747 static const char * __init str_supported(int is_supported)
7749 static char text_unsupported[] __initdata = "not supported";
7751 return (is_supported)? &text_unsupported[4] : &text_unsupported[0];
7753 #endif /* CONFIG_THINKPAD_ACPI_DEBUG */
7755 static void ibm_exit(struct ibm_struct *ibm)
7757 dbg_printk(TPACPI_DBG_EXIT, "removing %s\n", ibm->name);
7759 list_del_init(&ibm->all_drivers);
7761 if (ibm->flags.acpi_notify_installed) {
7762 dbg_printk(TPACPI_DBG_EXIT,
7763 "%s: acpi_remove_notify_handler\n", ibm->name);
7765 acpi_remove_notify_handler(*ibm->acpi->handle,
7767 dispatch_acpi_notify);
7768 ibm->flags.acpi_notify_installed = 0;
7769 ibm->flags.acpi_notify_installed = 0;
7772 if (ibm->flags.proc_created) {
7773 dbg_printk(TPACPI_DBG_EXIT,
7774 "%s: remove_proc_entry\n", ibm->name);
7775 remove_proc_entry(ibm->name, proc_dir);
7776 ibm->flags.proc_created = 0;
7779 if (ibm->flags.acpi_driver_registered) {
7780 dbg_printk(TPACPI_DBG_EXIT,
7781 "%s: acpi_bus_unregister_driver\n", ibm->name);
7783 acpi_bus_unregister_driver(ibm->acpi->driver);
7784 kfree(ibm->acpi->driver);
7785 ibm->acpi->driver = NULL;
7786 ibm->flags.acpi_driver_registered = 0;
7789 if (ibm->flags.init_called && ibm->exit) {
7791 ibm->flags.init_called = 0;
7794 dbg_printk(TPACPI_DBG_INIT, "finished removing %s\n", ibm->name);
7797 static int __init ibm_init(struct ibm_init_struct *iibm)
7800 struct ibm_struct *ibm = iibm->data;
7801 struct proc_dir_entry *entry;
7803 BUG_ON(ibm == NULL);
7805 INIT_LIST_HEAD(&ibm->all_drivers);
7807 if (ibm->flags.experimental && !experimental)
7810 dbg_printk(TPACPI_DBG_INIT,
7811 "probing for %s\n", ibm->name);
7814 ret = iibm->init(iibm);
7816 return 0; /* probe failed */
7820 ibm->flags.init_called = 1;
7824 if (ibm->acpi->hid) {
7825 ret = register_tpacpi_subdriver(ibm);
7830 if (ibm->acpi->notify) {
7831 ret = setup_acpi_notify(ibm);
7832 if (ret == -ENODEV) {
7833 printk(TPACPI_NOTICE "disabling subdriver %s\n",
7843 dbg_printk(TPACPI_DBG_INIT,
7844 "%s installed\n", ibm->name);
7847 entry = create_proc_entry(ibm->name,
7848 S_IFREG | S_IRUGO | S_IWUSR,
7851 printk(TPACPI_ERR "unable to create proc entry %s\n",
7857 entry->read_proc = &dispatch_procfs_read;
7859 entry->write_proc = &dispatch_procfs_write;
7860 ibm->flags.proc_created = 1;
7863 list_add_tail(&ibm->all_drivers, &tpacpi_all_drivers);
7868 dbg_printk(TPACPI_DBG_INIT,
7869 "%s: at error exit path with result %d\n",
7873 return (ret < 0)? ret : 0;
7878 static bool __pure __init tpacpi_is_fw_digit(const char c)
7880 return (c >= '0' && c <= '9') || (c >= 'A' && c <= 'Z');
7883 /* Most models: xxyTkkWW (#.##c); Ancient 570/600 and -SL lacks (#.##c) */
7884 static bool __pure __init tpacpi_is_valid_fw_id(const char* const s,
7887 return s && strlen(s) >= 8 &&
7888 tpacpi_is_fw_digit(s[0]) &&
7889 tpacpi_is_fw_digit(s[1]) &&
7890 s[2] == t && s[3] == 'T' &&
7891 tpacpi_is_fw_digit(s[4]) &&
7892 tpacpi_is_fw_digit(s[5]) &&
7893 s[6] == 'W' && s[7] == 'W';
7896 /* returns 0 - probe ok, or < 0 - probe error.
7897 * Probe ok doesn't mean thinkpad found.
7898 * On error, kfree() cleanup on tp->* is not performed, caller must do it */
7899 static int __must_check __init get_thinkpad_model_data(
7900 struct thinkpad_id_data *tp)
7902 const struct dmi_device *dev = NULL;
7903 char ec_fw_string[18];
7909 memset(tp, 0, sizeof(*tp));
7911 if (dmi_name_in_vendors("IBM"))
7912 tp->vendor = PCI_VENDOR_ID_IBM;
7913 else if (dmi_name_in_vendors("LENOVO"))
7914 tp->vendor = PCI_VENDOR_ID_LENOVO;
7918 s = dmi_get_system_info(DMI_BIOS_VERSION);
7919 tp->bios_version_str = kstrdup(s, GFP_KERNEL);
7920 if (s && !tp->bios_version_str)
7923 /* Really ancient ThinkPad 240X will fail this, which is fine */
7924 if (!tpacpi_is_valid_fw_id(tp->bios_version_str, 'E'))
7927 tp->bios_model = tp->bios_version_str[0]
7928 | (tp->bios_version_str[1] << 8);
7929 tp->bios_release = (tp->bios_version_str[4] << 8)
7930 | tp->bios_version_str[5];
7933 * ThinkPad T23 or newer, A31 or newer, R50e or newer,
7934 * X32 or newer, all Z series; Some models must have an
7935 * up-to-date BIOS or they will not be detected.
7937 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
7939 while ((dev = dmi_find_device(DMI_DEV_TYPE_OEM_STRING, NULL, dev))) {
7940 if (sscanf(dev->name,
7941 "IBM ThinkPad Embedded Controller -[%17c",
7942 ec_fw_string) == 1) {
7943 ec_fw_string[sizeof(ec_fw_string) - 1] = 0;
7944 ec_fw_string[strcspn(ec_fw_string, " ]")] = 0;
7946 tp->ec_version_str = kstrdup(ec_fw_string, GFP_KERNEL);
7947 if (!tp->ec_version_str)
7950 if (tpacpi_is_valid_fw_id(ec_fw_string, 'H')) {
7951 tp->ec_model = ec_fw_string[0]
7952 | (ec_fw_string[1] << 8);
7953 tp->ec_release = (ec_fw_string[4] << 8)
7956 printk(TPACPI_NOTICE
7957 "ThinkPad firmware release %s "
7958 "doesn't match the known patterns\n",
7960 printk(TPACPI_NOTICE
7961 "please report this to %s\n",
7968 s = dmi_get_system_info(DMI_PRODUCT_VERSION);
7969 if (s && !strnicmp(s, "ThinkPad", 8)) {
7970 tp->model_str = kstrdup(s, GFP_KERNEL);
7975 s = dmi_get_system_info(DMI_PRODUCT_NAME);
7976 tp->nummodel_str = kstrdup(s, GFP_KERNEL);
7977 if (s && !tp->nummodel_str)
7983 static int __init probe_for_thinkpad(void)
7991 * Non-ancient models have better DMI tagging, but very old models
7992 * don't. tpacpi_is_fw_known() is a cheat to help in that case.
7994 is_thinkpad = (thinkpad_id.model_str != NULL) ||
7995 (thinkpad_id.ec_model != 0) ||
7996 tpacpi_is_fw_known();
7998 /* ec is required because many other handles are relative to it */
7999 TPACPI_ACPIHANDLE_INIT(ec);
8003 "Not yet supported ThinkPad detected!\n");
8007 if (!is_thinkpad && !force_load)
8014 /* Module init, exit, parameters */
8016 static struct ibm_init_struct ibms_init[] __initdata = {
8018 .init = thinkpad_acpi_driver_init,
8019 .data = &thinkpad_acpi_driver_data,
8022 .init = hotkey_init,
8023 .data = &hotkey_driver_data,
8026 .init = bluetooth_init,
8027 .data = &bluetooth_driver_data,
8031 .data = &wan_driver_data,
8035 .data = &uwb_driver_data,
8037 #ifdef CONFIG_THINKPAD_ACPI_VIDEO
8040 .data = &video_driver_data,
8045 .data = &light_driver_data,
8049 .data = &cmos_driver_data,
8053 .data = &led_driver_data,
8057 .data = &beep_driver_data,
8060 .init = thermal_init,
8061 .data = &thermal_driver_data,
8064 .data = &ecdump_driver_data,
8067 .init = brightness_init,
8068 .data = &brightness_driver_data,
8071 .data = &volume_driver_data,
8075 .data = &fan_driver_data,
8079 static int __init set_ibm_param(const char *val, struct kernel_param *kp)
8082 struct ibm_struct *ibm;
8084 if (!kp || !kp->name || !val)
8087 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8088 ibm = ibms_init[i].data;
8089 WARN_ON(ibm == NULL);
8091 if (!ibm || !ibm->name)
8094 if (strcmp(ibm->name, kp->name) == 0 && ibm->write) {
8095 if (strlen(val) > sizeof(ibms_init[i].param) - 2)
8097 strcpy(ibms_init[i].param, val);
8098 strcat(ibms_init[i].param, ",");
8106 module_param(experimental, int, 0);
8107 MODULE_PARM_DESC(experimental,
8108 "Enables experimental features when non-zero");
8110 module_param_named(debug, dbg_level, uint, 0);
8111 MODULE_PARM_DESC(debug, "Sets debug level bit-mask");
8113 module_param(force_load, bool, 0);
8114 MODULE_PARM_DESC(force_load,
8115 "Attempts to load the driver even on a "
8116 "mis-identified ThinkPad when true");
8118 module_param_named(fan_control, fan_control_allowed, bool, 0);
8119 MODULE_PARM_DESC(fan_control,
8120 "Enables setting fan parameters features when true");
8122 module_param_named(brightness_mode, brightness_mode, uint, 0);
8123 MODULE_PARM_DESC(brightness_mode,
8124 "Selects brightness control strategy: "
8125 "0=auto, 1=EC, 2=UCMS, 3=EC+NVRAM");
8127 module_param(brightness_enable, uint, 0);
8128 MODULE_PARM_DESC(brightness_enable,
8129 "Enables backlight control when 1, disables when 0");
8131 module_param(hotkey_report_mode, uint, 0);
8132 MODULE_PARM_DESC(hotkey_report_mode,
8133 "used for backwards compatibility with userspace, "
8134 "see documentation");
8136 #define TPACPI_PARAM(feature) \
8137 module_param_call(feature, set_ibm_param, NULL, NULL, 0); \
8138 MODULE_PARM_DESC(feature, "Simulates thinkpad-acpi procfs command " \
8139 "at module load, see documentation")
8141 TPACPI_PARAM(hotkey);
8142 TPACPI_PARAM(bluetooth);
8143 TPACPI_PARAM(video);
8144 TPACPI_PARAM(light);
8148 TPACPI_PARAM(ecdump);
8149 TPACPI_PARAM(brightness);
8150 TPACPI_PARAM(volume);
8153 #ifdef CONFIG_THINKPAD_ACPI_DEBUGFACILITIES
8154 module_param(dbg_wlswemul, uint, 0);
8155 MODULE_PARM_DESC(dbg_wlswemul, "Enables WLSW emulation");
8156 module_param_named(wlsw_state, tpacpi_wlsw_emulstate, bool, 0);
8157 MODULE_PARM_DESC(wlsw_state,
8158 "Initial state of the emulated WLSW switch");
8160 module_param(dbg_bluetoothemul, uint, 0);
8161 MODULE_PARM_DESC(dbg_bluetoothemul, "Enables bluetooth switch emulation");
8162 module_param_named(bluetooth_state, tpacpi_bluetooth_emulstate, bool, 0);
8163 MODULE_PARM_DESC(bluetooth_state,
8164 "Initial state of the emulated bluetooth switch");
8166 module_param(dbg_wwanemul, uint, 0);
8167 MODULE_PARM_DESC(dbg_wwanemul, "Enables WWAN switch emulation");
8168 module_param_named(wwan_state, tpacpi_wwan_emulstate, bool, 0);
8169 MODULE_PARM_DESC(wwan_state,
8170 "Initial state of the emulated WWAN switch");
8172 module_param(dbg_uwbemul, uint, 0);
8173 MODULE_PARM_DESC(dbg_uwbemul, "Enables UWB switch emulation");
8174 module_param_named(uwb_state, tpacpi_uwb_emulstate, bool, 0);
8175 MODULE_PARM_DESC(uwb_state,
8176 "Initial state of the emulated UWB switch");
8179 static void thinkpad_acpi_module_exit(void)
8181 struct ibm_struct *ibm, *itmp;
8183 tpacpi_lifecycle = TPACPI_LIFE_EXITING;
8185 list_for_each_entry_safe_reverse(ibm, itmp,
8186 &tpacpi_all_drivers,
8191 dbg_printk(TPACPI_DBG_INIT, "finished subdriver exit path...\n");
8193 if (tpacpi_inputdev) {
8194 if (tp_features.input_device_registered)
8195 input_unregister_device(tpacpi_inputdev);
8197 input_free_device(tpacpi_inputdev);
8201 hwmon_device_unregister(tpacpi_hwmon);
8203 if (tp_features.sensors_pdev_attrs_registered)
8204 device_remove_file(&tpacpi_sensors_pdev->dev,
8205 &dev_attr_thinkpad_acpi_pdev_name);
8206 if (tpacpi_sensors_pdev)
8207 platform_device_unregister(tpacpi_sensors_pdev);
8209 platform_device_unregister(tpacpi_pdev);
8211 if (tp_features.sensors_pdrv_attrs_registered)
8212 tpacpi_remove_driver_attributes(&tpacpi_hwmon_pdriver.driver);
8213 if (tp_features.platform_drv_attrs_registered)
8214 tpacpi_remove_driver_attributes(&tpacpi_pdriver.driver);
8216 if (tp_features.sensors_pdrv_registered)
8217 platform_driver_unregister(&tpacpi_hwmon_pdriver);
8219 if (tp_features.platform_drv_registered)
8220 platform_driver_unregister(&tpacpi_pdriver);
8223 remove_proc_entry(TPACPI_PROC_DIR, acpi_root_dir);
8226 destroy_workqueue(tpacpi_wq);
8228 kfree(thinkpad_id.bios_version_str);
8229 kfree(thinkpad_id.ec_version_str);
8230 kfree(thinkpad_id.model_str);
8234 static int __init thinkpad_acpi_module_init(void)
8238 tpacpi_lifecycle = TPACPI_LIFE_INIT;
8240 /* Parameter checking */
8241 if (hotkey_report_mode > 2)
8244 /* Driver-level probe */
8246 ret = get_thinkpad_model_data(&thinkpad_id);
8249 "unable to get DMI data: %d\n", ret);
8250 thinkpad_acpi_module_exit();
8253 ret = probe_for_thinkpad();
8255 thinkpad_acpi_module_exit();
8259 /* Driver initialization */
8261 TPACPI_ACPIHANDLE_INIT(ecrd);
8262 TPACPI_ACPIHANDLE_INIT(ecwr);
8264 tpacpi_wq = create_singlethread_workqueue(TPACPI_WORKQUEUE_NAME);
8266 thinkpad_acpi_module_exit();
8270 proc_dir = proc_mkdir(TPACPI_PROC_DIR, acpi_root_dir);
8273 "unable to create proc dir " TPACPI_PROC_DIR);
8274 thinkpad_acpi_module_exit();
8278 ret = platform_driver_register(&tpacpi_pdriver);
8281 "unable to register main platform driver\n");
8282 thinkpad_acpi_module_exit();
8285 tp_features.platform_drv_registered = 1;
8287 ret = platform_driver_register(&tpacpi_hwmon_pdriver);
8290 "unable to register hwmon platform driver\n");
8291 thinkpad_acpi_module_exit();
8294 tp_features.sensors_pdrv_registered = 1;
8296 ret = tpacpi_create_driver_attributes(&tpacpi_pdriver.driver);
8298 tp_features.platform_drv_attrs_registered = 1;
8299 ret = tpacpi_create_driver_attributes(
8300 &tpacpi_hwmon_pdriver.driver);
8304 "unable to create sysfs driver attributes\n");
8305 thinkpad_acpi_module_exit();
8308 tp_features.sensors_pdrv_attrs_registered = 1;
8311 /* Device initialization */
8312 tpacpi_pdev = platform_device_register_simple(TPACPI_DRVR_NAME, -1,
8314 if (IS_ERR(tpacpi_pdev)) {
8315 ret = PTR_ERR(tpacpi_pdev);
8317 printk(TPACPI_ERR "unable to register platform device\n");
8318 thinkpad_acpi_module_exit();
8321 tpacpi_sensors_pdev = platform_device_register_simple(
8322 TPACPI_HWMON_DRVR_NAME,
8324 if (IS_ERR(tpacpi_sensors_pdev)) {
8325 ret = PTR_ERR(tpacpi_sensors_pdev);
8326 tpacpi_sensors_pdev = NULL;
8328 "unable to register hwmon platform device\n");
8329 thinkpad_acpi_module_exit();
8332 ret = device_create_file(&tpacpi_sensors_pdev->dev,
8333 &dev_attr_thinkpad_acpi_pdev_name);
8336 "unable to create sysfs hwmon device attributes\n");
8337 thinkpad_acpi_module_exit();
8340 tp_features.sensors_pdev_attrs_registered = 1;
8341 tpacpi_hwmon = hwmon_device_register(&tpacpi_sensors_pdev->dev);
8342 if (IS_ERR(tpacpi_hwmon)) {
8343 ret = PTR_ERR(tpacpi_hwmon);
8344 tpacpi_hwmon = NULL;
8345 printk(TPACPI_ERR "unable to register hwmon device\n");
8346 thinkpad_acpi_module_exit();
8349 mutex_init(&tpacpi_inputdev_send_mutex);
8350 tpacpi_inputdev = input_allocate_device();
8351 if (!tpacpi_inputdev) {
8352 printk(TPACPI_ERR "unable to allocate input device\n");
8353 thinkpad_acpi_module_exit();
8356 /* Prepare input device, but don't register */
8357 tpacpi_inputdev->name = "ThinkPad Extra Buttons";
8358 tpacpi_inputdev->phys = TPACPI_DRVR_NAME "/input0";
8359 tpacpi_inputdev->id.bustype = BUS_HOST;
8360 tpacpi_inputdev->id.vendor = (thinkpad_id.vendor) ?
8361 thinkpad_id.vendor :
8363 tpacpi_inputdev->id.product = TPACPI_HKEY_INPUT_PRODUCT;
8364 tpacpi_inputdev->id.version = TPACPI_HKEY_INPUT_VERSION;
8366 for (i = 0; i < ARRAY_SIZE(ibms_init); i++) {
8367 ret = ibm_init(&ibms_init[i]);
8368 if (ret >= 0 && *ibms_init[i].param)
8369 ret = ibms_init[i].data->write(ibms_init[i].param);
8371 thinkpad_acpi_module_exit();
8375 ret = input_register_device(tpacpi_inputdev);
8377 printk(TPACPI_ERR "unable to register input device\n");
8378 thinkpad_acpi_module_exit();
8381 tp_features.input_device_registered = 1;
8384 tpacpi_lifecycle = TPACPI_LIFE_RUNNING;
8388 MODULE_ALIAS(TPACPI_DRVR_SHORTNAME);
8391 * This will autoload the driver in almost every ThinkPad
8392 * in widespread use.
8394 * Only _VERY_ old models, like the 240, 240x and 570 lack
8395 * the HKEY event interface.
8397 MODULE_DEVICE_TABLE(acpi, ibm_htk_device_ids);
8400 * DMI matching for module autoloading
8402 * See http://thinkwiki.org/wiki/List_of_DMI_IDs
8403 * See http://thinkwiki.org/wiki/BIOS_Upgrade_Downloads
8405 * Only models listed in thinkwiki will be supported, so add yours
8406 * if it is not there yet.
8408 #define IBM_BIOS_MODULE_ALIAS(__type) \
8409 MODULE_ALIAS("dmi:bvnIBM:bvr" __type "ET??WW*")
8411 /* Ancient thinkpad BIOSes have to be identified by
8412 * BIOS type or model number, and there are far less
8413 * BIOS types than model numbers... */
8414 IBM_BIOS_MODULE_ALIAS("I[MU]"); /* 570, 570e */
8416 MODULE_AUTHOR("Borislav Deianov <borislav@users.sf.net>");
8417 MODULE_AUTHOR("Henrique de Moraes Holschuh <hmh@hmh.eng.br>");
8418 MODULE_DESCRIPTION(TPACPI_DESC);
8419 MODULE_VERSION(TPACPI_VERSION);
8420 MODULE_LICENSE("GPL");
8422 module_init(thinkpad_acpi_module_init);
8423 module_exit(thinkpad_acpi_module_exit);