]> nv-tegra.nvidia Code Review - linux-2.6.git/blob - drivers/misc/thinkpad_acpi.h
88af089d64945b41a5150e545a5064ce1b6f0a5a
[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/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>
45
46 #include <linux/dmi.h>
47 #include <linux/jiffies.h>
48 #include <linux/workqueue.h>
49
50 #include <acpi/acpi_drivers.h>
51 #include <acpi/acnamesp.h>
52
53 #include <linux/pci_ids.h>
54
55 /****************************************************************************
56  * Main driver
57  */
58
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"
64
65 #define IBM_PROC_DIR "ibm"
66 #define IBM_ACPI_EVENT_PREFIX "ibm"
67 #define IBM_DRVR_NAME IBM_FILE
68
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
74
75 #define IBM_MAX_ACPI_ARGS 3
76
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
83
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
88
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)))
92
93 /* Debugging */
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);
105 #else
106 #define vdbg_printk(a_dbg_level, format, arg...)
107 #endif
108
109 /* Input IDs */
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
113
114 /* ACPI HIDs */
115 #define IBM_HKEY_HID    "IBM0068"
116
117 /* ACPI helpers */
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);
123
124 /* ACPI handles */
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 */
129
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)
136
137 /* ThinkPad ACPI helpers */
138 static int issue_thinkpad_cmos_command(int cmos_cmd);
139
140 /* procfs support */
141 static struct proc_dir_entry *proc_dir;
142
143 /* procfs helpers */
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);
150
151 /* sysfs support */
152 struct attribute_set {
153         unsigned int members, max_members;
154         struct attribute_group group;
155 };
156
157 static struct attribute_set *create_attr_set(unsigned int max_members,
158                                                 const char* name);
159 #define destroy_attr_set(_set) \
160         kfree(_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,
164                         unsigned int count);
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);
168
169 static int parse_strtoul(const char *buf, unsigned long max,
170                         unsigned long *value);
171
172 /* Device model */
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);
179
180 /* Module */
181 static int experimental;
182 static u32 dbg_level;
183 static int force_load;
184
185 static int thinkpad_acpi_module_init(void);
186 static void thinkpad_acpi_module_exit(void);
187
188
189 /****************************************************************************
190  * Subdrivers
191  */
192
193 struct ibm_struct;
194
195 struct tp_acpi_drv_struct {
196         const struct acpi_device_id *hid;
197         struct acpi_driver *driver;
198
199         void (*notify) (struct ibm_struct *, u32);
200         acpi_handle *handle;
201         u32 type;
202         struct acpi_device *device;
203 };
204
205 struct ibm_struct {
206         char *name;
207
208         int (*read) (char *);
209         int (*write) (char *);
210         void (*exit) (void);
211         void (*resume) (void);
212
213         struct list_head all_drivers;
214
215         struct tp_acpi_drv_struct *acpi;
216
217         struct {
218                 u8 acpi_driver_registered:1;
219                 u8 acpi_notify_installed:1;
220                 u8 proc_created:1;
221                 u8 init_called:1;
222                 u8 experimental:1;
223         } flags;
224 };
225
226 struct ibm_init_struct {
227         char param[32];
228
229         int (*init) (struct ibm_init_struct *);
230         struct ibm_struct *data;
231 };
232
233 static struct {
234 #ifdef CONFIG_THINKPAD_ACPI_BAY
235         u16 bay_status:1;
236         u16 bay_eject:1;
237         u16 bay_status2:1;
238         u16 bay_eject2:1;
239 #endif
240         u16 bluetooth:1;
241         u16 hotkey:1;
242         u16 hotkey_mask:1;
243         u16 hotkey_wlsw:1;
244         u16 light:1;
245         u16 light_status:1;
246         u16 wan:1;
247         u16 fan_ctrl_status_undef:1;
248         u16 input_device_registered:1;
249 } tp_features;
250
251 struct thinkpad_id_data {
252         unsigned int vendor;    /* ThinkPad vendor:
253                                  * PCI_VENDOR_ID_IBM/PCI_VENDOR_ID_LENOVO */
254
255         char *bios_version_str; /* Something like 1ZET51WW (1.03z) */
256         char *ec_version_str;   /* Something like 1ZHT51WW-1.04a */
257
258         u16 bios_model;         /* Big Endian, TP-1Y = 0x5931, 0 = unknown */
259         u16 ec_model;
260
261         char *model_str;
262 };
263
264 static struct thinkpad_id_data thinkpad_id;
265
266 static struct list_head tpacpi_all_drivers;
267
268 static struct ibm_init_struct ibms_init[];
269 static int set_ibm_param(const char *val, struct kernel_param *kp);
270 static int ibm_init(struct ibm_init_struct *iibm);
271 static void ibm_exit(struct ibm_struct *ibm);
272
273
274 /*
275  * procfs master subdriver
276  */
277 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
278 static int thinkpad_acpi_driver_read(char *p);
279
280
281 /*
282  * Bay subdriver
283  */
284
285 #ifdef CONFIG_THINKPAD_ACPI_BAY
286 static acpi_handle bay_handle, bay_ej_handle;
287 static acpi_handle bay2_handle, bay2_ej_handle;
288
289 static int bay_init(struct ibm_init_struct *iibm);
290 static void bay_notify(struct ibm_struct *ibm, u32 event);
291 static int bay_read(char *p);
292 static int bay_write(char *buf);
293 #endif /* CONFIG_THINKPAD_ACPI_BAY */
294
295
296 /*
297  * Beep subdriver
298  */
299
300 static acpi_handle beep_handle;
301
302 static int beep_read(char *p);
303 static int beep_write(char *buf);
304
305
306 /*
307  * Bluetooth subdriver
308  */
309
310 enum {
311         /* ACPI GBDC/SBDC bits */
312         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
313         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
314         TP_ACPI_BLUETOOTH_UNK           = 0x04, /* unknown function */
315 };
316
317 static int bluetooth_init(struct ibm_init_struct *iibm);
318 static int bluetooth_get_radiosw(void);
319 static int bluetooth_set_radiosw(int radio_on);
320 static int bluetooth_read(char *p);
321 static int bluetooth_write(char *buf);
322
323
324 /*
325  * Brightness (backlight) subdriver
326  */
327
328 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
329
330 static struct backlight_device *ibm_backlight_device;
331 static int brightness_offset = 0x31;
332 static int brightness_mode;
333
334 static int brightness_init(struct ibm_init_struct *iibm);
335 static void brightness_exit(void);
336 static int brightness_get(struct backlight_device *bd);
337 static int brightness_set(int value);
338 static int brightness_update_status(struct backlight_device *bd);
339 static int brightness_read(char *p);
340 static int brightness_write(char *buf);
341
342
343 /*
344  * CMOS subdriver
345  */
346
347 static int cmos_read(char *p);
348 static int cmos_write(char *buf);
349
350
351 /*
352  * Dock subdriver
353  */
354
355 #ifdef CONFIG_THINKPAD_ACPI_DOCK
356 static acpi_handle pci_handle;
357 static acpi_handle dock_handle;
358
359 static void dock_notify(struct ibm_struct *ibm, u32 event);
360 static int dock_read(char *p);
361 static int dock_write(char *buf);
362 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
363
364
365 /*
366  * EC dump subdriver
367  */
368
369 static int ecdump_read(char *p) ;
370 static int ecdump_write(char *buf);
371
372
373 /*
374  * Fan subdriver
375  */
376
377 enum {                                  /* Fan control constants */
378         fan_status_offset = 0x2f,       /* EC register 0x2f */
379         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
380                                          * 0x84 must be read before 0x85 */
381
382         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
383         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
384
385         TPACPI_FAN_LAST_LEVEL = 0x100,  /* Use cached last-seen fan level */
386 };
387
388 enum fan_status_access_mode {
389         TPACPI_FAN_NONE = 0,            /* No fan status or control */
390         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
391         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
392 };
393
394 enum fan_control_access_mode {
395         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
396         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
397         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
398         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
399 };
400
401 enum fan_control_commands {
402         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
403         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
404         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
405                                                  * and also watchdog cmd */
406 };
407
408 static int fan_control_allowed;
409
410 static enum fan_status_access_mode fan_status_access_mode;
411 static enum fan_control_access_mode fan_control_access_mode;
412 static enum fan_control_commands fan_control_commands;
413 static u8 fan_control_initial_status;
414 static u8 fan_control_desired_level;
415 static int fan_watchdog_maxinterval;
416
417 static struct mutex fan_mutex;
418
419 static acpi_handle fans_handle, gfan_handle, sfan_handle;
420
421 static int fan_init(struct ibm_init_struct *iibm);
422 static void fan_exit(void);
423 static int fan_get_status(u8 *status);
424 static int fan_get_status_safe(u8 *status);
425 static int fan_get_speed(unsigned int *speed);
426 static void fan_update_desired_level(u8 status);
427 static void fan_watchdog_fire(struct work_struct *ignored);
428 static void fan_watchdog_reset(void);
429 static int fan_set_level(int level);
430 static int fan_set_level_safe(int level);
431 static int fan_set_enable(void);
432 static int fan_set_disable(void);
433 static int fan_set_speed(int speed);
434 static int fan_read(char *p);
435 static int fan_write(char *buf);
436 static int fan_write_cmd_level(const char *cmd, int *rc);
437 static int fan_write_cmd_enable(const char *cmd, int *rc);
438 static int fan_write_cmd_disable(const char *cmd, int *rc);
439 static int fan_write_cmd_speed(const char *cmd, int *rc);
440 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
441
442
443 /*
444  * Hotkey subdriver
445  */
446
447 static int hotkey_orig_status;
448 static u32 hotkey_orig_mask;
449
450 static struct mutex hotkey_mutex;
451
452 static int hotkey_init(struct ibm_init_struct *iibm);
453 static void hotkey_exit(void);
454 static int hotkey_get(int *status, u32 *mask);
455 static int hotkey_set(int status, u32 mask);
456 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
457 static int hotkey_read(char *p);
458 static int hotkey_write(char *buf);
459
460
461 /*
462  * LED subdriver
463  */
464
465 enum led_access_mode {
466         TPACPI_LED_NONE = 0,
467         TPACPI_LED_570, /* 570 */
468         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
469         TPACPI_LED_NEW, /* all others */
470 };
471
472 enum {  /* For TPACPI_LED_OLD */
473         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
474         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
475         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
476 };
477
478 static enum led_access_mode led_supported;
479 static acpi_handle led_handle;
480
481 static int led_init(struct ibm_init_struct *iibm);
482 static int led_read(char *p);
483 static int led_write(char *buf);
484
485 /*
486  * Light (thinklight) subdriver
487  */
488
489 static acpi_handle lght_handle, ledb_handle;
490
491 static int light_init(struct ibm_init_struct *iibm);
492 static int light_read(char *p);
493 static int light_write(char *buf);
494
495
496 /*
497  * Thermal subdriver
498  */
499
500 enum thermal_access_mode {
501         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
502         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
503         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
504         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
505         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
506 };
507
508 enum { /* TPACPI_THERMAL_TPEC_* */
509         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
510         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
511         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
512 };
513
514 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
515 struct ibm_thermal_sensors_struct {
516         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
517 };
518
519 static enum thermal_access_mode thermal_read_mode;
520
521 static int thermal_init(struct ibm_init_struct *iibm);
522 static int thermal_get_sensor(int idx, s32 *value);
523 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
524 static int thermal_read(char *p);
525
526
527 /*
528  * Video subdriver
529  */
530
531 enum video_access_mode {
532         TPACPI_VIDEO_NONE = 0,
533         TPACPI_VIDEO_570,       /* 570 */
534         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
535         TPACPI_VIDEO_NEW,       /* all others */
536 };
537
538 enum {  /* video status flags, based on VIDEO_570 */
539         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
540         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
541         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
542 };
543
544 enum {  /* TPACPI_VIDEO_570 constants */
545         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
546         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
547                                                  * video_status_flags */
548         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
549         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
550 };
551
552 static enum video_access_mode video_supported;
553 static int video_orig_autosw;
554 static acpi_handle vid_handle, vid2_handle;
555
556 static int video_init(struct ibm_init_struct *iibm);
557 static void video_exit(void);
558 static int video_outputsw_get(void);
559 static int video_outputsw_set(int status);
560 static int video_autosw_get(void);
561 static int video_autosw_set(int enable);
562 static int video_outputsw_cycle(void);
563 static int video_expand_toggle(void);
564 static int video_read(char *p);
565 static int video_write(char *buf);
566
567
568 /*
569  * Volume subdriver
570  */
571
572 static int volume_offset = 0x30;
573
574 static int volume_read(char *p);
575 static int volume_write(char *buf);
576
577
578 /*
579  * Wan subdriver
580  */
581
582 enum {
583         /* ACPI GWAN/SWAN bits */
584         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
585         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
586         TP_ACPI_WANCARD_UNK             = 0x04, /* unknown function */
587 };
588
589 static int wan_init(struct ibm_init_struct *iibm);
590 static int wan_get_radiosw(void);
591 static int wan_set_radiosw(int radio_on);
592 static int wan_read(char *p);
593 static int wan_write(char *buf);
594
595
596 #endif /* __THINKPAD_ACPI_H */