2 * thinkpad_acpi.h - ThinkPad ACPI Extras
5 * Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6 * Copyright (C) 2006-2007 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 #ifndef __THINKPAD_ACPI_H__
25 #define __THINKPAD_ACPI_H__
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/types.h>
31 #include <linux/string.h>
32 #include <linux/list.h>
33 #include <linux/mutex.h>
35 #include <linux/nvram.h>
36 #include <linux/proc_fs.h>
37 #include <linux/sysfs.h>
38 #include <linux/backlight.h>
40 #include <linux/platform_device.h>
41 #include <linux/hwmon.h>
42 #include <linux/hwmon-sysfs.h>
43 #include <linux/input.h>
44 #include <asm/uaccess.h>
46 #include <linux/dmi.h>
47 #include <linux/jiffies.h>
48 #include <linux/workqueue.h>
50 #include <acpi/acpi_drivers.h>
51 #include <acpi/acnamesp.h>
53 #include <linux/pci_ids.h>
55 /****************************************************************************
59 #define IBM_NAME "thinkpad"
60 #define IBM_DESC "ThinkPad ACPI Extras"
61 #define IBM_FILE "thinkpad_acpi"
62 #define IBM_URL "http://ibm-acpi.sf.net/"
63 #define IBM_MAIL "ibm-acpi-devel@lists.sourceforge.net"
65 #define IBM_PROC_DIR "ibm"
66 #define IBM_ACPI_EVENT_PREFIX "ibm"
67 #define IBM_DRVR_NAME IBM_FILE
69 #define IBM_LOG IBM_FILE ": "
70 #define IBM_ERR KERN_ERR IBM_LOG
71 #define IBM_NOTICE KERN_NOTICE IBM_LOG
72 #define IBM_INFO KERN_INFO IBM_LOG
73 #define IBM_DEBUG KERN_DEBUG IBM_LOG
75 #define IBM_MAX_ACPI_ARGS 3
77 /* ThinkPad CMOS commands */
78 #define TP_CMOS_VOLUME_DOWN 0
79 #define TP_CMOS_VOLUME_UP 1
80 #define TP_CMOS_VOLUME_MUTE 2
81 #define TP_CMOS_BRIGHTNESS_UP 4
82 #define TP_CMOS_BRIGHTNESS_DOWN 5
84 /* ThinkPad CMOS NVRAM constants */
85 #define TP_NVRAM_ADDR_BRIGHTNESS 0x5e
86 #define TP_NVRAM_MASK_LEVEL_BRIGHTNESS 0x07
87 #define TP_NVRAM_POS_LEVEL_BRIGHTNESS 0
89 #define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
90 #define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
91 #define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
94 #define TPACPI_DBG_ALL 0xffff
95 #define TPACPI_DBG_ALL 0xffff
96 #define TPACPI_DBG_INIT 0x0001
97 #define TPACPI_DBG_EXIT 0x0002
98 #define dbg_printk(a_dbg_level, format, arg...) \
99 do { if (dbg_level & a_dbg_level) \
100 printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
101 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
102 #define vdbg_printk(a_dbg_level, format, arg...) \
103 dbg_printk(a_dbg_level, format, ## arg)
104 static const char *str_supported(int is_supported
);
106 #define vdbg_printk(a_dbg_level, format, arg...)
110 #define TPACPI_HKEY_INPUT_VENDOR PCI_VENDOR_ID_IBM
111 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
112 #define TPACPI_HKEY_INPUT_VERSION 0x4101
115 #define IBM_HKEY_HID "IBM0068"
118 static int __must_check
acpi_evalf(acpi_handle handle
,
119 void *res
, char *method
, char *fmt
, ...);
120 static int __must_check
acpi_ec_read(int i
, u8
* p
);
121 static int __must_check
acpi_ec_write(int i
, u8 v
);
122 static int __must_check
_sta(acpi_handle handle
);
125 static acpi_handle root_handle
; /* root namespace */
126 static acpi_handle ec_handle
; /* EC */
127 static acpi_handle ecrd_handle
, ecwr_handle
; /* 570 EC access */
128 static acpi_handle cmos_handle
, hkey_handle
; /* basic thinkpad handles */
130 static void drv_acpi_handle_init(char *name
,
131 acpi_handle
*handle
, acpi_handle parent
,
132 char **paths
, int num_paths
, char **path
);
133 #define IBM_ACPIHANDLE_INIT(object) \
134 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
135 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
137 /* ThinkPad ACPI helpers */
138 static int issue_thinkpad_cmos_command(int cmos_cmd
);
141 static struct proc_dir_entry
*proc_dir
;
144 static int dispatch_procfs_read(char *page
, char **start
, off_t off
,
145 int count
, int *eof
, void *data
);
146 static int dispatch_procfs_write(struct file
*file
,
147 const char __user
* userbuf
,
148 unsigned long count
, void *data
);
149 static char *next_cmd(char **cmds
);
152 struct attribute_set
{
153 unsigned int members
, max_members
;
154 struct attribute_group group
;
157 static struct attribute_set
*create_attr_set(unsigned int max_members
,
159 #define destroy_attr_set(_set) \
161 static int add_to_attr_set(struct attribute_set
* s
, struct attribute
*attr
);
162 static int add_many_to_attr_set(struct attribute_set
* s
,
163 struct attribute
**attr
,
165 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
166 sysfs_create_group(_kobj, &_attr_set->group)
167 static void delete_attr_set(struct attribute_set
* s
, struct kobject
*kobj
);
169 static int parse_strtoul(const char *buf
, unsigned long max
,
170 unsigned long *value
);
173 static struct platform_device
*tpacpi_pdev
;
174 static struct class_device
*tpacpi_hwmon
;
175 static struct platform_driver tpacpi_pdriver
;
176 static struct input_dev
*tpacpi_inputdev
;
177 static int tpacpi_create_driver_attributes(struct device_driver
*drv
);
178 static void tpacpi_remove_driver_attributes(struct device_driver
*drv
);
181 static int experimental
;
182 static u32 dbg_level
;
183 static int force_load
;
185 static int thinkpad_acpi_module_init(void);
186 static void thinkpad_acpi_module_exit(void);
189 /****************************************************************************
195 struct tp_acpi_drv_struct
{
196 const struct acpi_device_id
*hid
;
197 struct acpi_driver
*driver
;
199 void (*notify
) (struct ibm_struct
*, u32
);
202 struct acpi_device
*device
;
208 int (*read
) (char *);
209 int (*write
) (char *);
211 void (*resume
) (void);
213 struct list_head all_drivers
;
215 struct tp_acpi_drv_struct
*acpi
;
218 u8 acpi_driver_registered
:1;
219 u8 acpi_notify_installed
:1;
226 struct ibm_init_struct
{
229 int (*init
) (struct ibm_init_struct
*);
230 struct ibm_struct
*data
;
234 #ifdef CONFIG_THINKPAD_ACPI_BAY
247 u16 fan_ctrl_status_undef
:1;
248 u16 input_device_registered
:1;
249 u16 platform_drv_registered
:1;
250 u16 platform_drv_attrs_registered
:1;
253 struct thinkpad_id_data
{
254 unsigned int vendor
; /* ThinkPad vendor:
255 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
257 char *bios_version_str
; /* Something like 1ZET51WW (1.03z) */
258 char *ec_version_str
; /* Something like 1ZHT51WW-1.04a */
260 u16 bios_model
; /* Big Endian, TP-1Y = 0x5931, 0 = unknown */
266 static struct thinkpad_id_data thinkpad_id
;
268 static struct list_head tpacpi_all_drivers
;
270 static struct ibm_init_struct ibms_init
[];
271 static int set_ibm_param(const char *val
, struct kernel_param
*kp
);
272 static int ibm_init(struct ibm_init_struct
*iibm
);
273 static void ibm_exit(struct ibm_struct
*ibm
);
277 * procfs master subdriver
279 static int thinkpad_acpi_driver_init(struct ibm_init_struct
*iibm
);
280 static int thinkpad_acpi_driver_read(char *p
);
287 #ifdef CONFIG_THINKPAD_ACPI_BAY
288 static acpi_handle bay_handle
, bay_ej_handle
;
289 static acpi_handle bay2_handle
, bay2_ej_handle
;
291 static int bay_init(struct ibm_init_struct
*iibm
);
292 static void bay_notify(struct ibm_struct
*ibm
, u32 event
);
293 static int bay_read(char *p
);
294 static int bay_write(char *buf
);
295 #endif /* CONFIG_THINKPAD_ACPI_BAY */
302 static acpi_handle beep_handle
;
304 static int beep_read(char *p
);
305 static int beep_write(char *buf
);
309 * Bluetooth subdriver
313 /* ACPI GBDC/SBDC bits */
314 TP_ACPI_BLUETOOTH_HWPRESENT
= 0x01, /* Bluetooth hw available */
315 TP_ACPI_BLUETOOTH_RADIOSSW
= 0x02, /* Bluetooth radio enabled */
316 TP_ACPI_BLUETOOTH_UNK
= 0x04, /* unknown function */
319 static int bluetooth_init(struct ibm_init_struct
*iibm
);
320 static int bluetooth_get_radiosw(void);
321 static int bluetooth_set_radiosw(int radio_on
);
322 static int bluetooth_read(char *p
);
323 static int bluetooth_write(char *buf
);
327 * Brightness (backlight) subdriver
330 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
332 static struct backlight_device
*ibm_backlight_device
;
333 static int brightness_offset
= 0x31;
334 static int brightness_mode
;
336 static int brightness_init(struct ibm_init_struct
*iibm
);
337 static void brightness_exit(void);
338 static int brightness_get(struct backlight_device
*bd
);
339 static int brightness_set(int value
);
340 static int brightness_update_status(struct backlight_device
*bd
);
341 static int brightness_read(char *p
);
342 static int brightness_write(char *buf
);
349 static int cmos_read(char *p
);
350 static int cmos_write(char *buf
);
357 #ifdef CONFIG_THINKPAD_ACPI_DOCK
358 static acpi_handle pci_handle
;
359 static acpi_handle dock_handle
;
361 static void dock_notify(struct ibm_struct
*ibm
, u32 event
);
362 static int dock_read(char *p
);
363 static int dock_write(char *buf
);
364 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
371 static int ecdump_read(char *p
) ;
372 static int ecdump_write(char *buf
);
379 enum { /* Fan control constants */
380 fan_status_offset
= 0x2f, /* EC register 0x2f */
381 fan_rpm_offset
= 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
382 * 0x84 must be read before 0x85 */
384 TP_EC_FAN_FULLSPEED
= 0x40, /* EC fan mode: full speed */
385 TP_EC_FAN_AUTO
= 0x80, /* EC fan mode: auto fan control */
387 TPACPI_FAN_LAST_LEVEL
= 0x100, /* Use cached last-seen fan level */
390 enum fan_status_access_mode
{
391 TPACPI_FAN_NONE
= 0, /* No fan status or control */
392 TPACPI_FAN_RD_ACPI_GFAN
, /* Use ACPI GFAN */
393 TPACPI_FAN_RD_TPEC
, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
396 enum fan_control_access_mode
{
397 TPACPI_FAN_WR_NONE
= 0, /* No fan control */
398 TPACPI_FAN_WR_ACPI_SFAN
, /* Use ACPI SFAN */
399 TPACPI_FAN_WR_TPEC
, /* Use ACPI EC reg 0x2f */
400 TPACPI_FAN_WR_ACPI_FANS
, /* Use ACPI FANS and EC reg 0x2f */
403 enum fan_control_commands
{
404 TPACPI_FAN_CMD_SPEED
= 0x0001, /* speed command */
405 TPACPI_FAN_CMD_LEVEL
= 0x0002, /* level command */
406 TPACPI_FAN_CMD_ENABLE
= 0x0004, /* enable/disable cmd,
407 * and also watchdog cmd */
410 static int fan_control_allowed
;
412 static enum fan_status_access_mode fan_status_access_mode
;
413 static enum fan_control_access_mode fan_control_access_mode
;
414 static enum fan_control_commands fan_control_commands
;
415 static u8 fan_control_initial_status
;
416 static u8 fan_control_desired_level
;
417 static int fan_watchdog_maxinterval
;
419 static struct mutex fan_mutex
;
421 static acpi_handle fans_handle
, gfan_handle
, sfan_handle
;
423 static int fan_init(struct ibm_init_struct
*iibm
);
424 static void fan_exit(void);
425 static int fan_get_status(u8
*status
);
426 static int fan_get_status_safe(u8
*status
);
427 static int fan_get_speed(unsigned int *speed
);
428 static void fan_update_desired_level(u8 status
);
429 static void fan_watchdog_fire(struct work_struct
*ignored
);
430 static void fan_watchdog_reset(void);
431 static int fan_set_level(int level
);
432 static int fan_set_level_safe(int level
);
433 static int fan_set_enable(void);
434 static int fan_set_disable(void);
435 static int fan_set_speed(int speed
);
436 static int fan_read(char *p
);
437 static int fan_write(char *buf
);
438 static int fan_write_cmd_level(const char *cmd
, int *rc
);
439 static int fan_write_cmd_enable(const char *cmd
, int *rc
);
440 static int fan_write_cmd_disable(const char *cmd
, int *rc
);
441 static int fan_write_cmd_speed(const char *cmd
, int *rc
);
442 static int fan_write_cmd_watchdog(const char *cmd
, int *rc
);
449 static int hotkey_orig_status
;
450 static u32 hotkey_orig_mask
;
452 static struct mutex hotkey_mutex
;
454 static int hotkey_init(struct ibm_init_struct
*iibm
);
455 static void hotkey_exit(void);
456 static int hotkey_get(int *status
, u32
*mask
);
457 static int hotkey_set(int status
, u32 mask
);
458 static void hotkey_notify(struct ibm_struct
*ibm
, u32 event
);
459 static int hotkey_read(char *p
);
460 static int hotkey_write(char *buf
);
467 enum led_access_mode
{
469 TPACPI_LED_570
, /* 570 */
470 TPACPI_LED_OLD
, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
471 TPACPI_LED_NEW
, /* all others */
474 enum { /* For TPACPI_LED_OLD */
475 TPACPI_LED_EC_HLCL
= 0x0c, /* EC reg to get led to power on */
476 TPACPI_LED_EC_HLBL
= 0x0d, /* EC reg to blink a lit led */
477 TPACPI_LED_EC_HLMS
= 0x0e, /* EC reg to select led to command */
480 static enum led_access_mode led_supported
;
481 static acpi_handle led_handle
;
483 static int led_init(struct ibm_init_struct
*iibm
);
484 static int led_read(char *p
);
485 static int led_write(char *buf
);
488 * Light (thinklight) subdriver
491 static acpi_handle lght_handle
, ledb_handle
;
493 static int light_init(struct ibm_init_struct
*iibm
);
494 static int light_read(char *p
);
495 static int light_write(char *buf
);
502 enum thermal_access_mode
{
503 TPACPI_THERMAL_NONE
= 0, /* No thermal support */
504 TPACPI_THERMAL_ACPI_TMP07
, /* Use ACPI TMP0-7 */
505 TPACPI_THERMAL_ACPI_UPDT
, /* Use ACPI TMP0-7 with UPDT */
506 TPACPI_THERMAL_TPEC_8
, /* Use ACPI EC regs, 8 sensors */
507 TPACPI_THERMAL_TPEC_16
, /* Use ACPI EC regs, 16 sensors */
510 enum { /* TPACPI_THERMAL_TPEC_* */
511 TP_EC_THERMAL_TMP0
= 0x78, /* ACPI EC regs TMP 0..7 */
512 TP_EC_THERMAL_TMP8
= 0xC0, /* ACPI EC regs TMP 8..15 */
513 TP_EC_THERMAL_TMP_NA
= -128, /* ACPI EC sensor not available */
516 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
517 struct ibm_thermal_sensors_struct
{
518 s32 temp
[TPACPI_MAX_THERMAL_SENSORS
];
521 static enum thermal_access_mode thermal_read_mode
;
523 static int thermal_init(struct ibm_init_struct
*iibm
);
524 static int thermal_get_sensor(int idx
, s32
*value
);
525 static int thermal_get_sensors(struct ibm_thermal_sensors_struct
*s
);
526 static int thermal_read(char *p
);
533 enum video_access_mode
{
534 TPACPI_VIDEO_NONE
= 0,
535 TPACPI_VIDEO_570
, /* 570 */
536 TPACPI_VIDEO_770
, /* 600e/x, 770e, 770x */
537 TPACPI_VIDEO_NEW
, /* all others */
540 enum { /* video status flags, based on VIDEO_570 */
541 TP_ACPI_VIDEO_S_LCD
= 0x01, /* LCD output enabled */
542 TP_ACPI_VIDEO_S_CRT
= 0x02, /* CRT output enabled */
543 TP_ACPI_VIDEO_S_DVI
= 0x08, /* DVI output enabled */
546 enum { /* TPACPI_VIDEO_570 constants */
547 TP_ACPI_VIDEO_570_PHSCMD
= 0x87, /* unknown magic constant :( */
548 TP_ACPI_VIDEO_570_PHSMASK
= 0x03, /* PHS bits that map to
549 * video_status_flags */
550 TP_ACPI_VIDEO_570_PHS2CMD
= 0x8b, /* unknown magic constant :( */
551 TP_ACPI_VIDEO_570_PHS2SET
= 0x80, /* unknown magic constant :( */
554 static enum video_access_mode video_supported
;
555 static int video_orig_autosw
;
556 static acpi_handle vid_handle
, vid2_handle
;
558 static int video_init(struct ibm_init_struct
*iibm
);
559 static void video_exit(void);
560 static int video_outputsw_get(void);
561 static int video_outputsw_set(int status
);
562 static int video_autosw_get(void);
563 static int video_autosw_set(int enable
);
564 static int video_outputsw_cycle(void);
565 static int video_expand_toggle(void);
566 static int video_read(char *p
);
567 static int video_write(char *buf
);
574 static int volume_offset
= 0x30;
576 static int volume_read(char *p
);
577 static int volume_write(char *buf
);
585 /* ACPI GWAN/SWAN bits */
586 TP_ACPI_WANCARD_HWPRESENT
= 0x01, /* Wan hw available */
587 TP_ACPI_WANCARD_RADIOSSW
= 0x02, /* Wan radio enabled */
588 TP_ACPI_WANCARD_UNK
= 0x04, /* unknown function */
591 static int wan_init(struct ibm_init_struct
*iibm
);
592 static int wan_get_radiosw(void);
593 static int wan_set_radiosw(int radio_on
);
594 static int wan_read(char *p
);
595 static int wan_write(char *buf
);
598 #endif /* __THINKPAD_ACPI_H */