ACPI: thinkpad-acpi: use a separate platform device for hwmon and name it (v2)
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / misc / thinkpad_acpi.h
blob791b8ca4bca58b80d22066d6d61d1ea0e3fb6629
1 /*
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
21 * 02110-1301, USA.
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>
39 #include <linux/fb.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 /****************************************************************************
56 * Main driver
59 #define IBM_NAME "thinkpad"
60 #define IBM_DESC "ThinkPad ACPI Extras"
61 #define IBM_FILE IBM_NAME "_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
68 #define IBM_HWMON_DRVR_NAME IBM_NAME "_hwmon"
70 #define IBM_LOG IBM_FILE ": "
71 #define IBM_ERR KERN_ERR IBM_LOG
72 #define IBM_NOTICE KERN_NOTICE IBM_LOG
73 #define IBM_INFO KERN_INFO IBM_LOG
74 #define IBM_DEBUG KERN_DEBUG IBM_LOG
76 #define IBM_MAX_ACPI_ARGS 3
78 /* ThinkPad CMOS commands */
79 #define TP_CMOS_VOLUME_DOWN 0
80 #define TP_CMOS_VOLUME_UP 1
81 #define TP_CMOS_VOLUME_MUTE 2
82 #define TP_CMOS_BRIGHTNESS_UP 4
83 #define TP_CMOS_BRIGHTNESS_DOWN 5
85 /* ThinkPad CMOS NVRAM constants */
86 #define TP_NVRAM_ADDR_BRIGHTNESS 0x5e
87 #define TP_NVRAM_MASK_LEVEL_BRIGHTNESS 0x07
88 #define TP_NVRAM_POS_LEVEL_BRIGHTNESS 0
90 #define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
91 #define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
92 #define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
94 /* Debugging */
95 #define TPACPI_DBG_ALL 0xffff
96 #define TPACPI_DBG_ALL 0xffff
97 #define TPACPI_DBG_INIT 0x0001
98 #define TPACPI_DBG_EXIT 0x0002
99 #define dbg_printk(a_dbg_level, format, arg...) \
100 do { if (dbg_level & a_dbg_level) \
101 printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
102 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
103 #define vdbg_printk(a_dbg_level, format, arg...) \
104 dbg_printk(a_dbg_level, format, ## arg)
105 static const char *str_supported(int is_supported);
106 #else
107 #define vdbg_printk(a_dbg_level, format, arg...)
108 #endif
110 /* Input IDs */
111 #define TPACPI_HKEY_INPUT_VENDOR PCI_VENDOR_ID_IBM
112 #define TPACPI_HKEY_INPUT_PRODUCT 0x5054 /* "TP" */
113 #define TPACPI_HKEY_INPUT_VERSION 0x4101
115 /* ACPI HIDs */
116 #define IBM_HKEY_HID "IBM0068"
118 /* ACPI helpers */
119 static int __must_check acpi_evalf(acpi_handle handle,
120 void *res, char *method, char *fmt, ...);
121 static int __must_check acpi_ec_read(int i, u8 * p);
122 static int __must_check acpi_ec_write(int i, u8 v);
123 static int __must_check _sta(acpi_handle handle);
125 /* ACPI handles */
126 static acpi_handle root_handle; /* root namespace */
127 static acpi_handle ec_handle; /* EC */
128 static acpi_handle ecrd_handle, ecwr_handle; /* 570 EC access */
129 static acpi_handle cmos_handle, hkey_handle; /* basic thinkpad handles */
131 static void drv_acpi_handle_init(char *name,
132 acpi_handle *handle, acpi_handle parent,
133 char **paths, int num_paths, char **path);
134 #define IBM_ACPIHANDLE_INIT(object) \
135 drv_acpi_handle_init(#object, &object##_handle, *object##_parent, \
136 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
138 /* ThinkPad ACPI helpers */
139 static int issue_thinkpad_cmos_command(int cmos_cmd);
141 /* procfs support */
142 static struct proc_dir_entry *proc_dir;
144 /* procfs helpers */
145 static int dispatch_procfs_read(char *page, char **start, off_t off,
146 int count, int *eof, void *data);
147 static int dispatch_procfs_write(struct file *file,
148 const char __user * userbuf,
149 unsigned long count, void *data);
150 static char *next_cmd(char **cmds);
152 /* sysfs support */
153 struct attribute_set {
154 unsigned int members, max_members;
155 struct attribute_group group;
158 static struct attribute_set *create_attr_set(unsigned int max_members,
159 const char* name);
160 #define destroy_attr_set(_set) \
161 kfree(_set);
162 static int add_to_attr_set(struct attribute_set* s, struct attribute *attr);
163 static int add_many_to_attr_set(struct attribute_set* s,
164 struct attribute **attr,
165 unsigned int count);
166 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
167 sysfs_create_group(_kobj, &_attr_set->group)
168 static void delete_attr_set(struct attribute_set* s, struct kobject *kobj);
170 static int parse_strtoul(const char *buf, unsigned long max,
171 unsigned long *value);
173 /* Device model */
174 static struct platform_device *tpacpi_pdev;
175 static struct platform_device *tpacpi_sensors_pdev;
176 static struct class_device *tpacpi_hwmon;
177 static struct platform_driver tpacpi_pdriver;
178 static struct input_dev *tpacpi_inputdev;
179 static int tpacpi_create_driver_attributes(struct device_driver *drv);
180 static void tpacpi_remove_driver_attributes(struct device_driver *drv);
182 /* Module */
183 static int experimental;
184 static u32 dbg_level;
185 static int force_load;
186 static unsigned int hotkey_report_mode;
188 static int thinkpad_acpi_module_init(void);
189 static void thinkpad_acpi_module_exit(void);
192 /****************************************************************************
193 * Subdrivers
196 struct ibm_struct;
198 struct tp_acpi_drv_struct {
199 const struct acpi_device_id *hid;
200 struct acpi_driver *driver;
202 void (*notify) (struct ibm_struct *, u32);
203 acpi_handle *handle;
204 u32 type;
205 struct acpi_device *device;
208 struct ibm_struct {
209 char *name;
211 int (*read) (char *);
212 int (*write) (char *);
213 void (*exit) (void);
214 void (*resume) (void);
216 struct list_head all_drivers;
218 struct tp_acpi_drv_struct *acpi;
220 struct {
221 u8 acpi_driver_registered:1;
222 u8 acpi_notify_installed:1;
223 u8 proc_created:1;
224 u8 init_called:1;
225 u8 experimental:1;
226 } flags;
229 struct ibm_init_struct {
230 char param[32];
232 int (*init) (struct ibm_init_struct *);
233 struct ibm_struct *data;
236 static struct {
237 #ifdef CONFIG_THINKPAD_ACPI_BAY
238 u32 bay_status:1;
239 u32 bay_eject:1;
240 u32 bay_status2:1;
241 u32 bay_eject2:1;
242 #endif
243 u32 bluetooth:1;
244 u32 hotkey:1;
245 u32 hotkey_mask:1;
246 u32 hotkey_wlsw:1;
247 u32 light:1;
248 u32 light_status:1;
249 u32 wan:1;
250 u32 fan_ctrl_status_undef:1;
251 u32 input_device_registered:1;
252 u32 platform_drv_registered:1;
253 u32 platform_drv_attrs_registered:1;
254 u32 sensors_pdrv_registered:1;
255 u32 sensors_pdev_attrs_registered:1;
256 } tp_features;
258 struct thinkpad_id_data {
259 unsigned int vendor; /* ThinkPad vendor:
260 * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
262 char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
263 char *ec_version_str; /* Something like 1ZHT51WW-1.04a */
265 u16 bios_model; /* Big Endian, TP-1Y = 0x5931, 0 = unknown */
266 u16 ec_model;
268 char *model_str;
271 static struct thinkpad_id_data thinkpad_id;
273 static struct list_head tpacpi_all_drivers;
275 static struct ibm_init_struct ibms_init[];
276 static int set_ibm_param(const char *val, struct kernel_param *kp);
277 static int ibm_init(struct ibm_init_struct *iibm);
278 static void ibm_exit(struct ibm_struct *ibm);
282 * procfs master subdriver
284 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
285 static int thinkpad_acpi_driver_read(char *p);
289 * Bay subdriver
292 #ifdef CONFIG_THINKPAD_ACPI_BAY
293 static acpi_handle bay_handle, bay_ej_handle;
294 static acpi_handle bay2_handle, bay2_ej_handle;
296 static int bay_init(struct ibm_init_struct *iibm);
297 static void bay_notify(struct ibm_struct *ibm, u32 event);
298 static int bay_read(char *p);
299 static int bay_write(char *buf);
300 #endif /* CONFIG_THINKPAD_ACPI_BAY */
304 * Beep subdriver
307 static acpi_handle beep_handle;
309 static int beep_read(char *p);
310 static int beep_write(char *buf);
314 * Bluetooth subdriver
317 enum {
318 /* ACPI GBDC/SBDC bits */
319 TP_ACPI_BLUETOOTH_HWPRESENT = 0x01, /* Bluetooth hw available */
320 TP_ACPI_BLUETOOTH_RADIOSSW = 0x02, /* Bluetooth radio enabled */
321 TP_ACPI_BLUETOOTH_UNK = 0x04, /* unknown function */
324 static int bluetooth_init(struct ibm_init_struct *iibm);
325 static int bluetooth_get_radiosw(void);
326 static int bluetooth_set_radiosw(int radio_on);
327 static int bluetooth_read(char *p);
328 static int bluetooth_write(char *buf);
332 * Brightness (backlight) subdriver
335 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
337 static struct backlight_device *ibm_backlight_device;
338 static int brightness_offset = 0x31;
339 static int brightness_mode;
341 static int brightness_init(struct ibm_init_struct *iibm);
342 static void brightness_exit(void);
343 static int brightness_get(struct backlight_device *bd);
344 static int brightness_set(int value);
345 static int brightness_update_status(struct backlight_device *bd);
346 static int brightness_read(char *p);
347 static int brightness_write(char *buf);
351 * CMOS subdriver
354 static int cmos_read(char *p);
355 static int cmos_write(char *buf);
359 * Dock subdriver
362 #ifdef CONFIG_THINKPAD_ACPI_DOCK
363 static acpi_handle pci_handle;
364 static acpi_handle dock_handle;
366 static void dock_notify(struct ibm_struct *ibm, u32 event);
367 static int dock_read(char *p);
368 static int dock_write(char *buf);
369 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
373 * EC dump subdriver
376 static int ecdump_read(char *p) ;
377 static int ecdump_write(char *buf);
381 * Fan subdriver
384 enum { /* Fan control constants */
385 fan_status_offset = 0x2f, /* EC register 0x2f */
386 fan_rpm_offset = 0x84, /* EC register 0x84: LSB, 0x85 MSB (RPM)
387 * 0x84 must be read before 0x85 */
389 TP_EC_FAN_FULLSPEED = 0x40, /* EC fan mode: full speed */
390 TP_EC_FAN_AUTO = 0x80, /* EC fan mode: auto fan control */
392 TPACPI_FAN_LAST_LEVEL = 0x100, /* Use cached last-seen fan level */
395 enum fan_status_access_mode {
396 TPACPI_FAN_NONE = 0, /* No fan status or control */
397 TPACPI_FAN_RD_ACPI_GFAN, /* Use ACPI GFAN */
398 TPACPI_FAN_RD_TPEC, /* Use ACPI EC regs 0x2f, 0x84-0x85 */
401 enum fan_control_access_mode {
402 TPACPI_FAN_WR_NONE = 0, /* No fan control */
403 TPACPI_FAN_WR_ACPI_SFAN, /* Use ACPI SFAN */
404 TPACPI_FAN_WR_TPEC, /* Use ACPI EC reg 0x2f */
405 TPACPI_FAN_WR_ACPI_FANS, /* Use ACPI FANS and EC reg 0x2f */
408 enum fan_control_commands {
409 TPACPI_FAN_CMD_SPEED = 0x0001, /* speed command */
410 TPACPI_FAN_CMD_LEVEL = 0x0002, /* level command */
411 TPACPI_FAN_CMD_ENABLE = 0x0004, /* enable/disable cmd,
412 * and also watchdog cmd */
415 static int fan_control_allowed;
417 static enum fan_status_access_mode fan_status_access_mode;
418 static enum fan_control_access_mode fan_control_access_mode;
419 static enum fan_control_commands fan_control_commands;
420 static u8 fan_control_initial_status;
421 static u8 fan_control_desired_level;
422 static int fan_watchdog_maxinterval;
424 static struct mutex fan_mutex;
426 static acpi_handle fans_handle, gfan_handle, sfan_handle;
428 static int fan_init(struct ibm_init_struct *iibm);
429 static void fan_exit(void);
430 static int fan_get_status(u8 *status);
431 static int fan_get_status_safe(u8 *status);
432 static int fan_get_speed(unsigned int *speed);
433 static void fan_update_desired_level(u8 status);
434 static void fan_watchdog_fire(struct work_struct *ignored);
435 static void fan_watchdog_reset(void);
436 static int fan_set_level(int level);
437 static int fan_set_level_safe(int level);
438 static int fan_set_enable(void);
439 static int fan_set_disable(void);
440 static int fan_set_speed(int speed);
441 static int fan_read(char *p);
442 static int fan_write(char *buf);
443 static int fan_write_cmd_level(const char *cmd, int *rc);
444 static int fan_write_cmd_enable(const char *cmd, int *rc);
445 static int fan_write_cmd_disable(const char *cmd, int *rc);
446 static int fan_write_cmd_speed(const char *cmd, int *rc);
447 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
451 * Hotkey subdriver
454 static int hotkey_orig_status;
455 static u32 hotkey_orig_mask;
457 static struct mutex hotkey_mutex;
459 static int hotkey_init(struct ibm_init_struct *iibm);
460 static void hotkey_exit(void);
461 static int hotkey_get(int *status, u32 *mask);
462 static int hotkey_set(int status, u32 mask);
463 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
464 static int hotkey_read(char *p);
465 static int hotkey_write(char *buf);
469 * LED subdriver
472 enum led_access_mode {
473 TPACPI_LED_NONE = 0,
474 TPACPI_LED_570, /* 570 */
475 TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
476 TPACPI_LED_NEW, /* all others */
479 enum { /* For TPACPI_LED_OLD */
480 TPACPI_LED_EC_HLCL = 0x0c, /* EC reg to get led to power on */
481 TPACPI_LED_EC_HLBL = 0x0d, /* EC reg to blink a lit led */
482 TPACPI_LED_EC_HLMS = 0x0e, /* EC reg to select led to command */
485 static enum led_access_mode led_supported;
486 static acpi_handle led_handle;
488 static int led_init(struct ibm_init_struct *iibm);
489 static int led_read(char *p);
490 static int led_write(char *buf);
493 * Light (thinklight) subdriver
496 static acpi_handle lght_handle, ledb_handle;
498 static int light_init(struct ibm_init_struct *iibm);
499 static int light_read(char *p);
500 static int light_write(char *buf);
504 * Thermal subdriver
507 enum thermal_access_mode {
508 TPACPI_THERMAL_NONE = 0, /* No thermal support */
509 TPACPI_THERMAL_ACPI_TMP07, /* Use ACPI TMP0-7 */
510 TPACPI_THERMAL_ACPI_UPDT, /* Use ACPI TMP0-7 with UPDT */
511 TPACPI_THERMAL_TPEC_8, /* Use ACPI EC regs, 8 sensors */
512 TPACPI_THERMAL_TPEC_16, /* Use ACPI EC regs, 16 sensors */
515 enum { /* TPACPI_THERMAL_TPEC_* */
516 TP_EC_THERMAL_TMP0 = 0x78, /* ACPI EC regs TMP 0..7 */
517 TP_EC_THERMAL_TMP8 = 0xC0, /* ACPI EC regs TMP 8..15 */
518 TP_EC_THERMAL_TMP_NA = -128, /* ACPI EC sensor not available */
521 #define TPACPI_MAX_THERMAL_SENSORS 16 /* Max thermal sensors supported */
522 struct ibm_thermal_sensors_struct {
523 s32 temp[TPACPI_MAX_THERMAL_SENSORS];
526 static enum thermal_access_mode thermal_read_mode;
528 static int thermal_init(struct ibm_init_struct *iibm);
529 static int thermal_get_sensor(int idx, s32 *value);
530 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
531 static int thermal_read(char *p);
535 * Video subdriver
538 enum video_access_mode {
539 TPACPI_VIDEO_NONE = 0,
540 TPACPI_VIDEO_570, /* 570 */
541 TPACPI_VIDEO_770, /* 600e/x, 770e, 770x */
542 TPACPI_VIDEO_NEW, /* all others */
545 enum { /* video status flags, based on VIDEO_570 */
546 TP_ACPI_VIDEO_S_LCD = 0x01, /* LCD output enabled */
547 TP_ACPI_VIDEO_S_CRT = 0x02, /* CRT output enabled */
548 TP_ACPI_VIDEO_S_DVI = 0x08, /* DVI output enabled */
551 enum { /* TPACPI_VIDEO_570 constants */
552 TP_ACPI_VIDEO_570_PHSCMD = 0x87, /* unknown magic constant :( */
553 TP_ACPI_VIDEO_570_PHSMASK = 0x03, /* PHS bits that map to
554 * video_status_flags */
555 TP_ACPI_VIDEO_570_PHS2CMD = 0x8b, /* unknown magic constant :( */
556 TP_ACPI_VIDEO_570_PHS2SET = 0x80, /* unknown magic constant :( */
559 static enum video_access_mode video_supported;
560 static int video_orig_autosw;
561 static acpi_handle vid_handle, vid2_handle;
563 static int video_init(struct ibm_init_struct *iibm);
564 static void video_exit(void);
565 static int video_outputsw_get(void);
566 static int video_outputsw_set(int status);
567 static int video_autosw_get(void);
568 static int video_autosw_set(int enable);
569 static int video_outputsw_cycle(void);
570 static int video_expand_toggle(void);
571 static int video_read(char *p);
572 static int video_write(char *buf);
576 * Volume subdriver
579 static int volume_offset = 0x30;
581 static int volume_read(char *p);
582 static int volume_write(char *buf);
586 * Wan subdriver
589 enum {
590 /* ACPI GWAN/SWAN bits */
591 TP_ACPI_WANCARD_HWPRESENT = 0x01, /* Wan hw available */
592 TP_ACPI_WANCARD_RADIOSSW = 0x02, /* Wan radio enabled */
593 TP_ACPI_WANCARD_UNK = 0x04, /* unknown function */
596 static int wan_init(struct ibm_init_struct *iibm);
597 static int wan_get_radiosw(void);
598 static int wan_set_radiosw(int radio_on);
599 static int wan_read(char *p);
600 static int wan_write(char *buf);
603 #endif /* __THINKPAD_ACPI_H */