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>
34 #include <linux/kthread.h>
35 #include <linux/freezer.h>
36 #include <linux/delay.h>
38 #include <linux/nvram.h>
39 #include <linux/proc_fs.h>
40 #include <linux/sysfs.h>
41 #include <linux/backlight.h>
43 #include <linux/platform_device.h>
44 #include <linux/hwmon.h>
45 #include <linux/hwmon-sysfs.h>
46 #include <linux/input.h>
47 #include <asm/uaccess.h>
49 #include <linux/dmi.h>
50 #include <linux/jiffies.h>
51 #include <linux/workqueue.h>
53 #include <acpi/acpi_drivers.h>
54 #include <acpi/acnamesp.h>
56 #include <linux/pci_ids.h>
58 /****************************************************************************
62 #define IBM_NAME "thinkpad"
63 #define IBM_DESC "ThinkPad ACPI Extras"
64 #define IBM_FILE IBM_NAME "_acpi"
65 #define IBM_URL "http://ibm-acpi.sf.net/"
66 #define IBM_MAIL "ibm-acpi-devel@lists.sourceforge.net"
68 #define IBM_PROC_DIR "ibm"
69 #define IBM_ACPI_EVENT_PREFIX "ibm"
70 #define IBM_DRVR_NAME IBM_FILE
71 #define IBM_HWMON_DRVR_NAME IBM_NAME "_hwmon"
73 #define IBM_LOG IBM_FILE ": "
74 #define IBM_ERR KERN_ERR IBM_LOG
75 #define IBM_NOTICE KERN_NOTICE IBM_LOG
76 #define IBM_INFO KERN_INFO IBM_LOG
77 #define IBM_DEBUG KERN_DEBUG IBM_LOG
79 #define IBM_MAX_ACPI_ARGS 3
81 /* ThinkPad CMOS commands */
82 #define TP_CMOS_VOLUME_DOWN 0
83 #define TP_CMOS_VOLUME_UP 1
84 #define TP_CMOS_VOLUME_MUTE 2
85 #define TP_CMOS_BRIGHTNESS_UP 4
86 #define TP_CMOS_BRIGHTNESS_DOWN 5
90 TP_NVRAM_ADDR_HK2
= 0x57,
91 TP_NVRAM_ADDR_THINKLIGHT
= 0x58,
92 TP_NVRAM_ADDR_VIDEO
= 0x59,
93 TP_NVRAM_ADDR_BRIGHTNESS
= 0x5e,
94 TP_NVRAM_ADDR_MIXER
= 0x60,
99 TP_NVRAM_MASK_HKT_THINKPAD
= 0x08,
100 TP_NVRAM_MASK_HKT_ZOOM
= 0x20,
101 TP_NVRAM_MASK_HKT_DISPLAY
= 0x40,
102 TP_NVRAM_MASK_HKT_HIBERNATE
= 0x80,
103 TP_NVRAM_MASK_THINKLIGHT
= 0x10,
104 TP_NVRAM_MASK_HKT_DISPEXPND
= 0x30,
105 TP_NVRAM_MASK_HKT_BRIGHTNESS
= 0x20,
106 TP_NVRAM_MASK_LEVEL_BRIGHTNESS
= 0x0f,
107 TP_NVRAM_POS_LEVEL_BRIGHTNESS
= 0,
108 TP_NVRAM_MASK_MUTE
= 0x40,
109 TP_NVRAM_MASK_HKT_VOLUME
= 0x80,
110 TP_NVRAM_MASK_LEVEL_VOLUME
= 0x0f,
111 TP_NVRAM_POS_LEVEL_VOLUME
= 0,
114 #define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
115 #define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
116 #define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
119 #define TPACPI_DBG_ALL 0xffff
120 #define TPACPI_DBG_ALL 0xffff
121 #define TPACPI_DBG_INIT 0x0001
122 #define TPACPI_DBG_EXIT 0x0002
123 #define dbg_printk(a_dbg_level, format, arg...) \
124 do { if (dbg_level & a_dbg_level) \
125 printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
126 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
127 #define vdbg_printk(a_dbg_level, format, arg...) \
128 dbg_printk(a_dbg_level, format, ## arg)
129 static const char *str_supported(int is_supported
);
131 #define vdbg_printk(a_dbg_level, format, arg...)
135 #define TPACPI_HKEY_INPUT_VENDOR PCI_VENDOR_ID_IBM
136 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
137 #define TPACPI_HKEY_INPUT_VERSION 0x4101
140 #define IBM_HKEY_HID "IBM0068"
143 static int __must_check
acpi_evalf(acpi_handle handle
,
144 void *res
, char *method
, char *fmt
, ...);
145 static int __must_check
acpi_ec_read(int i
, u8
* p
);
146 static int __must_check
acpi_ec_write(int i
, u8 v
);
147 static int __must_check
_sta(acpi_handle handle
);
150 static acpi_handle root_handle
; /* root namespace */
151 static acpi_handle ec_handle
; /* EC */
152 static acpi_handle ecrd_handle
, ecwr_handle
; /* 570 EC access */
153 static acpi_handle cmos_handle
, hkey_handle
; /* basic thinkpad handles */
155 static void drv_acpi_handle_init(char *name
,
156 acpi_handle
*handle
, acpi_handle parent
,
157 char **paths
, int num_paths
, char **path
);
158 #define IBM_ACPIHANDLE_INIT(object) \
159 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
160 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
162 /* ThinkPad ACPI helpers */
163 static int issue_thinkpad_cmos_command(int cmos_cmd
);
166 static struct proc_dir_entry
*proc_dir
;
169 static int dispatch_procfs_read(char *page
, char **start
, off_t off
,
170 int count
, int *eof
, void *data
);
171 static int dispatch_procfs_write(struct file
*file
,
172 const char __user
* userbuf
,
173 unsigned long count
, void *data
);
174 static char *next_cmd(char **cmds
);
177 struct attribute_set
{
178 unsigned int members
, max_members
;
179 struct attribute_group group
;
182 static struct attribute_set
*create_attr_set(unsigned int max_members
,
184 #define destroy_attr_set(_set) \
186 static int add_to_attr_set(struct attribute_set
* s
, struct attribute
*attr
);
187 static int add_many_to_attr_set(struct attribute_set
* s
,
188 struct attribute
**attr
,
190 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
191 sysfs_create_group(_kobj, &_attr_set->group)
192 static void delete_attr_set(struct attribute_set
* s
, struct kobject
*kobj
);
194 static int parse_strtoul(const char *buf
, unsigned long max
,
195 unsigned long *value
);
198 static struct platform_device
*tpacpi_pdev
;
199 static struct platform_device
*tpacpi_sensors_pdev
;
200 static struct class_device
*tpacpi_hwmon
;
201 static struct platform_driver tpacpi_pdriver
;
202 static struct input_dev
*tpacpi_inputdev
;
203 static int tpacpi_create_driver_attributes(struct device_driver
*drv
);
204 static void tpacpi_remove_driver_attributes(struct device_driver
*drv
);
207 static int experimental
;
208 static u32 dbg_level
;
209 static int force_load
;
210 static unsigned int hotkey_report_mode
;
212 static int thinkpad_acpi_module_init(void);
213 static void thinkpad_acpi_module_exit(void);
216 /****************************************************************************
222 struct tp_acpi_drv_struct
{
223 const struct acpi_device_id
*hid
;
224 struct acpi_driver
*driver
;
226 void (*notify
) (struct ibm_struct
*, u32
);
229 struct acpi_device
*device
;
235 int (*read
) (char *);
236 int (*write
) (char *);
238 void (*resume
) (void);
240 struct list_head all_drivers
;
242 struct tp_acpi_drv_struct
*acpi
;
245 u8 acpi_driver_registered
:1;
246 u8 acpi_notify_installed
:1;
253 struct ibm_init_struct
{
256 int (*init
) (struct ibm_init_struct
*);
257 struct ibm_struct
*data
;
261 #ifdef CONFIG_THINKPAD_ACPI_BAY
273 u32 bright_16levels
:1;
275 u32 fan_ctrl_status_undef
:1;
276 u32 input_device_registered
:1;
277 u32 platform_drv_registered
:1;
278 u32 platform_drv_attrs_registered
:1;
279 u32 sensors_pdrv_registered
:1;
280 u32 sensors_pdrv_attrs_registered
:1;
281 u32 sensors_pdev_attrs_registered
:1;
282 u32 hotkey_poll_active
:1;
285 struct thinkpad_id_data
{
286 unsigned int vendor
; /* ThinkPad vendor:
287 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
289 char *bios_version_str
; /* Something like 1ZET51WW (1.03z) */
290 char *ec_version_str
; /* Something like 1ZHT51WW-1.04a */
292 u16 bios_model
; /* Big Endian, TP-1Y = 0x5931, 0 = unknown */
298 static struct thinkpad_id_data thinkpad_id
;
300 static struct list_head tpacpi_all_drivers
;
302 static struct ibm_init_struct ibms_init
[];
303 static int set_ibm_param(const char *val
, struct kernel_param
*kp
);
304 static int ibm_init(struct ibm_init_struct
*iibm
);
305 static void ibm_exit(struct ibm_struct
*ibm
);
309 * procfs master subdriver
311 static int thinkpad_acpi_driver_init(struct ibm_init_struct
*iibm
);
312 static int thinkpad_acpi_driver_read(char *p
);
319 #ifdef CONFIG_THINKPAD_ACPI_BAY
320 static acpi_handle bay_handle
, bay_ej_handle
;
321 static acpi_handle bay2_handle
, bay2_ej_handle
;
323 static int bay_init(struct ibm_init_struct
*iibm
);
324 static void bay_notify(struct ibm_struct
*ibm
, u32 event
);
325 static int bay_read(char *p
);
326 static int bay_write(char *buf
);
327 #endif /* CONFIG_THINKPAD_ACPI_BAY */
334 static acpi_handle beep_handle
;
336 static int beep_read(char *p
);
337 static int beep_write(char *buf
);
341 * Bluetooth subdriver
345 /* ACPI GBDC/SBDC bits */
346 TP_ACPI_BLUETOOTH_HWPRESENT
= 0x01, /* Bluetooth hw available */
347 TP_ACPI_BLUETOOTH_RADIOSSW
= 0x02, /* Bluetooth radio enabled */
348 TP_ACPI_BLUETOOTH_UNK
= 0x04, /* unknown function */
351 static int bluetooth_init(struct ibm_init_struct
*iibm
);
352 static int bluetooth_get_radiosw(void);
353 static int bluetooth_set_radiosw(int radio_on
);
354 static int bluetooth_read(char *p
);
355 static int bluetooth_write(char *buf
);
359 * Brightness (backlight) subdriver
362 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
364 static struct backlight_device
*ibm_backlight_device
;
365 static int brightness_offset
= 0x31;
366 static int brightness_mode
;
367 static unsigned int brightness_enable
; /* 0 = no, 1 = yes, 2 = auto */
369 static int brightness_init(struct ibm_init_struct
*iibm
);
370 static void brightness_exit(void);
371 static int brightness_get(struct backlight_device
*bd
);
372 static int brightness_set(int value
);
373 static int brightness_update_status(struct backlight_device
*bd
);
374 static int brightness_read(char *p
);
375 static int brightness_write(char *buf
);
382 static int cmos_read(char *p
);
383 static int cmos_write(char *buf
);
390 #ifdef CONFIG_THINKPAD_ACPI_DOCK
391 static acpi_handle pci_handle
;
392 static acpi_handle dock_handle
;
394 static void dock_notify(struct ibm_struct
*ibm
, u32 event
);
395 static int dock_read(char *p
);
396 static int dock_write(char *buf
);
397 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
404 static int ecdump_read(char *p
) ;
405 static int ecdump_write(char *buf
);
412 enum { /* Fan control constants */
413 fan_status_offset
= 0x2f, /* EC register 0x2f */
414 fan_rpm_offset
= 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
415 * 0x84 must be read before 0x85 */
417 TP_EC_FAN_FULLSPEED
= 0x40, /* EC fan mode: full speed */
418 TP_EC_FAN_AUTO
= 0x80, /* EC fan mode: auto fan control */
420 TPACPI_FAN_LAST_LEVEL
= 0x100, /* Use cached last-seen fan level */
423 enum fan_status_access_mode
{
424 TPACPI_FAN_NONE
= 0, /* No fan status or control */
425 TPACPI_FAN_RD_ACPI_GFAN
, /* Use ACPI GFAN */
426 TPACPI_FAN_RD_TPEC
, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
429 enum fan_control_access_mode
{
430 TPACPI_FAN_WR_NONE
= 0, /* No fan control */
431 TPACPI_FAN_WR_ACPI_SFAN
, /* Use ACPI SFAN */
432 TPACPI_FAN_WR_TPEC
, /* Use ACPI EC reg 0x2f */
433 TPACPI_FAN_WR_ACPI_FANS
, /* Use ACPI FANS and EC reg 0x2f */
436 enum fan_control_commands
{
437 TPACPI_FAN_CMD_SPEED
= 0x0001, /* speed command */
438 TPACPI_FAN_CMD_LEVEL
= 0x0002, /* level command */
439 TPACPI_FAN_CMD_ENABLE
= 0x0004, /* enable/disable cmd,
440 * and also watchdog cmd */
443 static int fan_control_allowed
;
445 static enum fan_status_access_mode fan_status_access_mode
;
446 static enum fan_control_access_mode fan_control_access_mode
;
447 static enum fan_control_commands fan_control_commands
;
448 static u8 fan_control_initial_status
;
449 static u8 fan_control_desired_level
;
450 static int fan_watchdog_maxinterval
;
452 static struct mutex fan_mutex
;
454 static acpi_handle fans_handle
, gfan_handle
, sfan_handle
;
456 static int fan_init(struct ibm_init_struct
*iibm
);
457 static void fan_exit(void);
458 static int fan_get_status(u8
*status
);
459 static int fan_get_status_safe(u8
*status
);
460 static int fan_get_speed(unsigned int *speed
);
461 static void fan_update_desired_level(u8 status
);
462 static void fan_watchdog_fire(struct work_struct
*ignored
);
463 static void fan_watchdog_reset(void);
464 static int fan_set_level(int level
);
465 static int fan_set_level_safe(int level
);
466 static int fan_set_enable(void);
467 static int fan_set_disable(void);
468 static int fan_set_speed(int speed
);
469 static int fan_read(char *p
);
470 static int fan_write(char *buf
);
471 static int fan_write_cmd_level(const char *cmd
, int *rc
);
472 static int fan_write_cmd_enable(const char *cmd
, int *rc
);
473 static int fan_write_cmd_disable(const char *cmd
, int *rc
);
474 static int fan_write_cmd_speed(const char *cmd
, int *rc
);
475 static int fan_write_cmd_watchdog(const char *cmd
, int *rc
);
482 enum { /* hot key scan codes (derived from ACPI DSDT) */
483 TP_ACPI_HOTKEYSCAN_FNF1
= 0,
484 TP_ACPI_HOTKEYSCAN_FNF2
,
485 TP_ACPI_HOTKEYSCAN_FNF3
,
486 TP_ACPI_HOTKEYSCAN_FNF4
,
487 TP_ACPI_HOTKEYSCAN_FNF5
,
488 TP_ACPI_HOTKEYSCAN_FNF6
,
489 TP_ACPI_HOTKEYSCAN_FNF7
,
490 TP_ACPI_HOTKEYSCAN_FNF8
,
491 TP_ACPI_HOTKEYSCAN_FNF9
,
492 TP_ACPI_HOTKEYSCAN_FNF10
,
493 TP_ACPI_HOTKEYSCAN_FNF11
,
494 TP_ACPI_HOTKEYSCAN_FNF12
,
495 TP_ACPI_HOTKEYSCAN_FNBACKSPACE
,
496 TP_ACPI_HOTKEYSCAN_FNINSERT
,
497 TP_ACPI_HOTKEYSCAN_FNDELETE
,
498 TP_ACPI_HOTKEYSCAN_FNHOME
,
499 TP_ACPI_HOTKEYSCAN_FNEND
,
500 TP_ACPI_HOTKEYSCAN_FNPAGEUP
,
501 TP_ACPI_HOTKEYSCAN_FNPAGEDOWN
,
502 TP_ACPI_HOTKEYSCAN_FNSPACE
,
503 TP_ACPI_HOTKEYSCAN_VOLUMEUP
,
504 TP_ACPI_HOTKEYSCAN_VOLUMEDOWN
,
505 TP_ACPI_HOTKEYSCAN_MUTE
,
506 TP_ACPI_HOTKEYSCAN_THINKPAD
,
509 static int hotkey_orig_status
;
510 static u32 hotkey_orig_mask
;
512 static struct mutex hotkey_mutex
;
514 static int hotkey_init(struct ibm_init_struct
*iibm
);
515 static void hotkey_exit(void);
516 static void hotkey_notify(struct ibm_struct
*ibm
, u32 event
);
517 static int hotkey_read(char *p
);
518 static int hotkey_write(char *buf
);
525 enum led_access_mode
{
527 TPACPI_LED_570
, /* 570 */
528 TPACPI_LED_OLD
, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
529 TPACPI_LED_NEW
, /* all others */
532 enum { /* For TPACPI_LED_OLD */
533 TPACPI_LED_EC_HLCL
= 0x0c, /* EC reg to get led to power on */
534 TPACPI_LED_EC_HLBL
= 0x0d, /* EC reg to blink a lit led */
535 TPACPI_LED_EC_HLMS
= 0x0e, /* EC reg to select led to command */
538 static enum led_access_mode led_supported
;
539 static acpi_handle led_handle
;
541 static int led_init(struct ibm_init_struct
*iibm
);
542 static int led_read(char *p
);
543 static int led_write(char *buf
);
546 * Light (thinklight) subdriver
549 static acpi_handle lght_handle
, ledb_handle
;
551 static int light_init(struct ibm_init_struct
*iibm
);
552 static int light_read(char *p
);
553 static int light_write(char *buf
);
560 enum thermal_access_mode
{
561 TPACPI_THERMAL_NONE
= 0, /* No thermal support */
562 TPACPI_THERMAL_ACPI_TMP07
, /* Use ACPI TMP0-7 */
563 TPACPI_THERMAL_ACPI_UPDT
, /* Use ACPI TMP0-7 with UPDT */
564 TPACPI_THERMAL_TPEC_8
, /* Use ACPI EC regs, 8 sensors */
565 TPACPI_THERMAL_TPEC_16
, /* Use ACPI EC regs, 16 sensors */
568 enum { /* TPACPI_THERMAL_TPEC_* */
569 TP_EC_THERMAL_TMP0
= 0x78, /* ACPI EC regs TMP 0..7 */
570 TP_EC_THERMAL_TMP8
= 0xC0, /* ACPI EC regs TMP 8..15 */
571 TP_EC_THERMAL_TMP_NA
= -128, /* ACPI EC sensor not available */
574 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
575 struct ibm_thermal_sensors_struct
{
576 s32 temp
[TPACPI_MAX_THERMAL_SENSORS
];
579 static enum thermal_access_mode thermal_read_mode
;
581 static int thermal_init(struct ibm_init_struct
*iibm
);
582 static int thermal_get_sensor(int idx
, s32
*value
);
583 static int thermal_get_sensors(struct ibm_thermal_sensors_struct
*s
);
584 static int thermal_read(char *p
);
591 enum video_access_mode
{
592 TPACPI_VIDEO_NONE
= 0,
593 TPACPI_VIDEO_570
, /* 570 */
594 TPACPI_VIDEO_770
, /* 600e/x, 770e, 770x */
595 TPACPI_VIDEO_NEW
, /* all others */
598 enum { /* video status flags, based on VIDEO_570 */
599 TP_ACPI_VIDEO_S_LCD
= 0x01, /* LCD output enabled */
600 TP_ACPI_VIDEO_S_CRT
= 0x02, /* CRT output enabled */
601 TP_ACPI_VIDEO_S_DVI
= 0x08, /* DVI output enabled */
604 enum { /* TPACPI_VIDEO_570 constants */
605 TP_ACPI_VIDEO_570_PHSCMD
= 0x87, /* unknown magic constant :( */
606 TP_ACPI_VIDEO_570_PHSMASK
= 0x03, /* PHS bits that map to
607 * video_status_flags */
608 TP_ACPI_VIDEO_570_PHS2CMD
= 0x8b, /* unknown magic constant :( */
609 TP_ACPI_VIDEO_570_PHS2SET
= 0x80, /* unknown magic constant :( */
612 static enum video_access_mode video_supported
;
613 static int video_orig_autosw
;
614 static acpi_handle vid_handle
, vid2_handle
;
616 static int video_init(struct ibm_init_struct
*iibm
);
617 static void video_exit(void);
618 static int video_outputsw_get(void);
619 static int video_outputsw_set(int status
);
620 static int video_autosw_get(void);
621 static int video_autosw_set(int enable
);
622 static int video_outputsw_cycle(void);
623 static int video_expand_toggle(void);
624 static int video_read(char *p
);
625 static int video_write(char *buf
);
632 static int volume_offset
= 0x30;
634 static int volume_read(char *p
);
635 static int volume_write(char *buf
);
643 /* ACPI GWAN/SWAN bits */
644 TP_ACPI_WANCARD_HWPRESENT
= 0x01, /* Wan hw available */
645 TP_ACPI_WANCARD_RADIOSSW
= 0x02, /* Wan radio enabled */
646 TP_ACPI_WANCARD_UNK
= 0x04, /* unknown function */
649 static int wan_init(struct ibm_init_struct
*iibm
);
650 static int wan_get_radiosw(void);
651 static int wan_set_radiosw(int radio_on
);
652 static int wan_read(char *p
);
653 static int wan_write(char *buf
);
656 #endif /* __THINKPAD_ACPI_H */