]> nv-tegra.nvidia Code Review - linux-2.6.git/blob - drivers/misc/thinkpad_acpi.h
fee04214a10b8f5a69592cf2b5b606c93bb5fff2
[linux-2.6.git] / drivers / misc / thinkpad_acpi.h
1 /*
2  *  thinkpad_acpi.h - ThinkPad ACPI Extras
3  *
4  *
5  *  Copyright (C) 2004-2005 Borislav Deianov <borislav@users.sf.net>
6  *  Copyright (C) 2006-2007 Henrique de Moraes Holschuh <hmh@hmh.eng.br>
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21  *  02110-1301, USA.
22  */
23
24 #ifndef __THINKPAD_ACPI_H__
25 #define __THINKPAD_ACPI_H__
26
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
35 #include <linux/proc_fs.h>
36 #include <linux/sysfs.h>
37 #include <linux/backlight.h>
38 #include <linux/fb.h>
39 #include <linux/platform_device.h>
40 #include <linux/hwmon.h>
41 #include <linux/hwmon-sysfs.h>
42 #include <linux/input.h>
43 #include <asm/uaccess.h>
44
45 #include <linux/dmi.h>
46 #include <linux/jiffies.h>
47 #include <linux/workqueue.h>
48
49 #include <acpi/acpi_drivers.h>
50 #include <acpi/acnamesp.h>
51
52 #include <linux/pci_ids.h>
53
54 /****************************************************************************
55  * Main driver
56  */
57
58 #define IBM_NAME "thinkpad"
59 #define IBM_DESC "ThinkPad ACPI Extras"
60 #define IBM_FILE "thinkpad_acpi"
61 #define IBM_URL "http://ibm-acpi.sf.net/"
62 #define IBM_MAIL "ibm-acpi-devel@lists.sourceforge.net"
63
64 #define IBM_PROC_DIR "ibm"
65 #define IBM_ACPI_EVENT_PREFIX "ibm"
66 #define IBM_DRVR_NAME IBM_FILE
67
68 #define IBM_LOG IBM_FILE ": "
69 #define IBM_ERR    KERN_ERR    IBM_LOG
70 #define IBM_NOTICE KERN_NOTICE IBM_LOG
71 #define IBM_INFO   KERN_INFO   IBM_LOG
72 #define IBM_DEBUG  KERN_DEBUG  IBM_LOG
73
74 #define IBM_MAX_ACPI_ARGS 3
75
76 /* ThinkPad CMOS commands */
77 #define TP_CMOS_VOLUME_DOWN     0
78 #define TP_CMOS_VOLUME_UP       1
79 #define TP_CMOS_VOLUME_MUTE     2
80 #define TP_CMOS_BRIGHTNESS_UP   4
81 #define TP_CMOS_BRIGHTNESS_DOWN 5
82
83 #define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
84 #define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
85 #define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
86
87 /* Debugging */
88 #define TPACPI_DBG_ALL          0xffff
89 #define TPACPI_DBG_ALL          0xffff
90 #define TPACPI_DBG_INIT         0x0001
91 #define TPACPI_DBG_EXIT         0x0002
92 #define dbg_printk(a_dbg_level, format, arg...) \
93         do { if (dbg_level & a_dbg_level) \
94                 printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
95 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
96 #define vdbg_printk(a_dbg_level, format, arg...) \
97         dbg_printk(a_dbg_level, format, ## arg)
98 static const char *str_supported(int is_supported);
99 #else
100 #define vdbg_printk(a_dbg_level, format, arg...)
101 #endif
102
103 /* Input IDs */
104 #define TPACPI_HKEY_INPUT_VENDOR        PCI_VENDOR_ID_IBM
105 #define TPACPI_HKEY_INPUT_PRODUCT       0x5054 /* "TP" */
106 #define TPACPI_HKEY_INPUT_VERSION       0x4101
107
108 /* ACPI HIDs */
109 #define IBM_HKEY_HID    "IBM0068"
110
111 /* ACPI helpers */
112 static int __must_check acpi_evalf(acpi_handle handle,
113                       void *res, char *method, char *fmt, ...);
114 static int __must_check acpi_ec_read(int i, u8 * p);
115 static int __must_check acpi_ec_write(int i, u8 v);
116 static int __must_check _sta(acpi_handle handle);
117
118 /* ACPI handles */
119 static acpi_handle root_handle;                 /* root namespace */
120 static acpi_handle ec_handle;                   /* EC */
121 static acpi_handle ecrd_handle, ecwr_handle;    /* 570 EC access */
122 static acpi_handle cmos_handle, hkey_handle;    /* basic thinkpad handles */
123
124 static void drv_acpi_handle_init(char *name,
125                    acpi_handle *handle, acpi_handle parent,
126                    char **paths, int num_paths, char **path);
127 #define IBM_ACPIHANDLE_INIT(object)                                             \
128         drv_acpi_handle_init(#object, &object##_handle, *object##_parent,       \
129                 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
130
131 /* ThinkPad ACPI helpers */
132 static int issue_thinkpad_cmos_command(int cmos_cmd);
133
134 /* procfs support */
135 static struct proc_dir_entry *proc_dir;
136
137 /* procfs helpers */
138 static int dispatch_procfs_read(char *page, char **start, off_t off,
139                 int count, int *eof, void *data);
140 static int dispatch_procfs_write(struct file *file,
141                 const char __user * userbuf,
142                 unsigned long count, void *data);
143 static char *next_cmd(char **cmds);
144
145 /* sysfs support */
146 struct attribute_set {
147         unsigned int members, max_members;
148         struct attribute_group group;
149 };
150
151 static struct attribute_set *create_attr_set(unsigned int max_members,
152                                                 const char* name);
153 #define destroy_attr_set(_set) \
154         kfree(_set);
155 static int add_to_attr_set(struct attribute_set* s, struct attribute *attr);
156 static int add_many_to_attr_set(struct attribute_set* s,
157                         struct attribute **attr,
158                         unsigned int count);
159 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
160         sysfs_create_group(_kobj, &_attr_set->group)
161 static void delete_attr_set(struct attribute_set* s, struct kobject *kobj);
162
163 static int parse_strtoul(const char *buf, unsigned long max,
164                         unsigned long *value);
165
166 /* Device model */
167 static struct platform_device *tpacpi_pdev;
168 static struct class_device *tpacpi_hwmon;
169 static struct platform_driver tpacpi_pdriver;
170 static struct input_dev *tpacpi_inputdev;
171 static int tpacpi_create_driver_attributes(struct device_driver *drv);
172 static void tpacpi_remove_driver_attributes(struct device_driver *drv);
173
174 /* Module */
175 static int experimental;
176 static u32 dbg_level;
177 static int force_load;
178 static char *ibm_thinkpad_ec_found;
179
180 static char* check_dmi_for_ec(void);
181 static int thinkpad_acpi_module_init(void);
182 static void thinkpad_acpi_module_exit(void);
183
184
185 /****************************************************************************
186  * Subdrivers
187  */
188
189 struct ibm_struct;
190
191 struct tp_acpi_drv_struct {
192         char *hid;
193         struct acpi_driver *driver;
194
195         void (*notify) (struct ibm_struct *, u32);
196         acpi_handle *handle;
197         u32 type;
198         struct acpi_device *device;
199 };
200
201 struct ibm_struct {
202         char *name;
203
204         int (*read) (char *);
205         int (*write) (char *);
206         void (*exit) (void);
207         void (*resume) (void);
208
209         struct list_head all_drivers;
210
211         struct tp_acpi_drv_struct *acpi;
212
213         struct {
214                 u8 acpi_driver_registered:1;
215                 u8 acpi_notify_installed:1;
216                 u8 proc_created:1;
217                 u8 init_called:1;
218                 u8 experimental:1;
219         } flags;
220 };
221
222 struct ibm_init_struct {
223         char param[32];
224
225         int (*init) (struct ibm_init_struct *);
226         struct ibm_struct *data;
227 };
228
229 static struct {
230 #ifdef CONFIG_THINKPAD_ACPI_BAY
231         u16 bay_status:1;
232         u16 bay_eject:1;
233         u16 bay_status2:1;
234         u16 bay_eject2:1;
235 #endif
236         u16 bluetooth:1;
237         u16 hotkey:1;
238         u16 hotkey_mask:1;
239         u16 hotkey_wlsw:1;
240         u16 light:1;
241         u16 light_status:1;
242         u16 wan:1;
243         u16 fan_ctrl_status_undef:1;
244         u16 input_device_registered:1;
245 } tp_features;
246
247 static struct list_head tpacpi_all_drivers;
248
249 static struct ibm_init_struct ibms_init[];
250 static int set_ibm_param(const char *val, struct kernel_param *kp);
251 static int ibm_init(struct ibm_init_struct *iibm);
252 static void ibm_exit(struct ibm_struct *ibm);
253
254
255 /*
256  * procfs master subdriver
257  */
258 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
259 static int thinkpad_acpi_driver_read(char *p);
260
261
262 /*
263  * Bay subdriver
264  */
265
266 #ifdef CONFIG_THINKPAD_ACPI_BAY
267 static acpi_handle bay_handle, bay_ej_handle;
268 static acpi_handle bay2_handle, bay2_ej_handle;
269
270 static int bay_init(struct ibm_init_struct *iibm);
271 static void bay_notify(struct ibm_struct *ibm, u32 event);
272 static int bay_read(char *p);
273 static int bay_write(char *buf);
274 #endif /* CONFIG_THINKPAD_ACPI_BAY */
275
276
277 /*
278  * Beep subdriver
279  */
280
281 static acpi_handle beep_handle;
282
283 static int beep_read(char *p);
284 static int beep_write(char *buf);
285
286
287 /*
288  * Bluetooth subdriver
289  */
290
291 enum {
292         /* ACPI GBDC/SBDC bits */
293         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
294         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
295         TP_ACPI_BLUETOOTH_UNK           = 0x04, /* unknown function */
296 };
297
298 static int bluetooth_init(struct ibm_init_struct *iibm);
299 static int bluetooth_get_radiosw(void);
300 static int bluetooth_set_radiosw(int radio_on);
301 static int bluetooth_read(char *p);
302 static int bluetooth_write(char *buf);
303
304
305 /*
306  * Brightness (backlight) subdriver
307  */
308
309 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
310
311 static struct backlight_device *ibm_backlight_device;
312 static int brightness_offset = 0x31;
313
314 static int brightness_init(struct ibm_init_struct *iibm);
315 static void brightness_exit(void);
316 static int brightness_get(struct backlight_device *bd);
317 static int brightness_set(int value);
318 static int brightness_update_status(struct backlight_device *bd);
319 static int brightness_read(char *p);
320 static int brightness_write(char *buf);
321
322
323 /*
324  * CMOS subdriver
325  */
326
327 static int cmos_read(char *p);
328 static int cmos_write(char *buf);
329
330
331 /*
332  * Dock subdriver
333  */
334
335 #ifdef CONFIG_THINKPAD_ACPI_DOCK
336 static acpi_handle pci_handle;
337 static acpi_handle dock_handle;
338
339 static void dock_notify(struct ibm_struct *ibm, u32 event);
340 static int dock_read(char *p);
341 static int dock_write(char *buf);
342 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
343
344
345 /*
346  * EC dump subdriver
347  */
348
349 static int ecdump_read(char *p) ;
350 static int ecdump_write(char *buf);
351
352
353 /*
354  * Fan subdriver
355  */
356
357 enum {                                  /* Fan control constants */
358         fan_status_offset = 0x2f,       /* EC register 0x2f */
359         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
360                                          * 0x84 must be read before 0x85 */
361
362         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
363         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
364
365         TPACPI_FAN_LAST_LEVEL = 0x100,  /* Use cached last-seen fan level */
366 };
367
368 enum fan_status_access_mode {
369         TPACPI_FAN_NONE = 0,            /* No fan status or control */
370         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
371         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
372 };
373
374 enum fan_control_access_mode {
375         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
376         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
377         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
378         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
379 };
380
381 enum fan_control_commands {
382         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
383         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
384         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
385                                                  * and also watchdog cmd */
386 };
387
388 static int fan_control_allowed;
389
390 static enum fan_status_access_mode fan_status_access_mode;
391 static enum fan_control_access_mode fan_control_access_mode;
392 static enum fan_control_commands fan_control_commands;
393 static u8 fan_control_initial_status;
394 static u8 fan_control_desired_level;
395 static int fan_watchdog_maxinterval;
396
397 static struct mutex fan_mutex;
398
399 static acpi_handle fans_handle, gfan_handle, sfan_handle;
400
401 static int fan_init(struct ibm_init_struct *iibm);
402 static void fan_exit(void);
403 static int fan_get_status(u8 *status);
404 static int fan_get_status_safe(u8 *status);
405 static int fan_get_speed(unsigned int *speed);
406 static void fan_update_desired_level(u8 status);
407 static void fan_watchdog_fire(struct work_struct *ignored);
408 static void fan_watchdog_reset(void);
409 static int fan_set_level(int level);
410 static int fan_set_level_safe(int level);
411 static int fan_set_enable(void);
412 static int fan_set_disable(void);
413 static int fan_set_speed(int speed);
414 static int fan_read(char *p);
415 static int fan_write(char *buf);
416 static int fan_write_cmd_level(const char *cmd, int *rc);
417 static int fan_write_cmd_enable(const char *cmd, int *rc);
418 static int fan_write_cmd_disable(const char *cmd, int *rc);
419 static int fan_write_cmd_speed(const char *cmd, int *rc);
420 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
421
422
423 /*
424  * Hotkey subdriver
425  */
426
427 static int hotkey_orig_status;
428 static u32 hotkey_orig_mask;
429
430 static struct mutex hotkey_mutex;
431
432 static int hotkey_init(struct ibm_init_struct *iibm);
433 static void hotkey_exit(void);
434 static int hotkey_get(int *status, u32 *mask);
435 static int hotkey_set(int status, u32 mask);
436 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
437 static int hotkey_read(char *p);
438 static int hotkey_write(char *buf);
439
440
441 /*
442  * LED subdriver
443  */
444
445 enum led_access_mode {
446         TPACPI_LED_NONE = 0,
447         TPACPI_LED_570, /* 570 */
448         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
449         TPACPI_LED_NEW, /* all others */
450 };
451
452 enum {  /* For TPACPI_LED_OLD */
453         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
454         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
455         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
456 };
457
458 static enum led_access_mode led_supported;
459 static acpi_handle led_handle;
460
461 static int led_init(struct ibm_init_struct *iibm);
462 static int led_read(char *p);
463 static int led_write(char *buf);
464
465 /*
466  * Light (thinklight) subdriver
467  */
468
469 static acpi_handle lght_handle, ledb_handle;
470
471 static int light_init(struct ibm_init_struct *iibm);
472 static int light_read(char *p);
473 static int light_write(char *buf);
474
475
476 /*
477  * Thermal subdriver
478  */
479
480 enum thermal_access_mode {
481         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
482         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
483         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
484         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
485         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
486 };
487
488 enum { /* TPACPI_THERMAL_TPEC_* */
489         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
490         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
491         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
492 };
493
494 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
495 struct ibm_thermal_sensors_struct {
496         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
497 };
498
499 static enum thermal_access_mode thermal_read_mode;
500
501 static int thermal_init(struct ibm_init_struct *iibm);
502 static int thermal_get_sensor(int idx, s32 *value);
503 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
504 static int thermal_read(char *p);
505
506
507 /*
508  * Video subdriver
509  */
510
511 enum video_access_mode {
512         TPACPI_VIDEO_NONE = 0,
513         TPACPI_VIDEO_570,       /* 570 */
514         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
515         TPACPI_VIDEO_NEW,       /* all others */
516 };
517
518 enum {  /* video status flags, based on VIDEO_570 */
519         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
520         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
521         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
522 };
523
524 enum {  /* TPACPI_VIDEO_570 constants */
525         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
526         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
527                                                  * video_status_flags */
528         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
529         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
530 };
531
532 static enum video_access_mode video_supported;
533 static int video_orig_autosw;
534 static acpi_handle vid_handle, vid2_handle;
535
536 static int video_init(struct ibm_init_struct *iibm);
537 static void video_exit(void);
538 static int video_outputsw_get(void);
539 static int video_outputsw_set(int status);
540 static int video_autosw_get(void);
541 static int video_autosw_set(int enable);
542 static int video_outputsw_cycle(void);
543 static int video_expand_toggle(void);
544 static int video_read(char *p);
545 static int video_write(char *buf);
546
547
548 /*
549  * Volume subdriver
550  */
551
552 static int volume_offset = 0x30;
553
554 static int volume_read(char *p);
555 static int volume_write(char *buf);
556
557
558 /*
559  * Wan subdriver
560  */
561
562 enum {
563         /* ACPI GWAN/SWAN bits */
564         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
565         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
566         TP_ACPI_WANCARD_UNK             = 0x04, /* unknown function */
567 };
568
569 static int wan_init(struct ibm_init_struct *iibm);
570 static int wan_get_radiosw(void);
571 static int wan_set_radiosw(int radio_on);
572 static int wan_read(char *p);
573 static int wan_write(char *buf);
574
575
576 #endif /* __THINKPAD_ACPI_H */