ACPI: thinkpad-acpi: improve thinkpad detection
[safe/jmp/linux-2.6] / 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
34 #include <linux/proc_fs.h>
35 #include <linux/backlight.h>
36 #include <linux/fb.h>
37 #include <asm/uaccess.h>
38
39 #include <linux/dmi.h>
40 #include <linux/jiffies.h>
41 #include <linux/workqueue.h>
42
43 #include <acpi/acpi_drivers.h>
44 #include <acpi/acnamesp.h>
45
46
47 /****************************************************************************
48  * Main driver
49  */
50
51 #define IBM_NAME "thinkpad"
52 #define IBM_DESC "ThinkPad ACPI Extras"
53 #define IBM_FILE "thinkpad_acpi"
54 #define IBM_URL "http://ibm-acpi.sf.net/"
55
56 #define IBM_DIR "ibm"
57 #define IBM_ACPI_EVENT_PREFIX "ibm"
58
59 #define IBM_LOG IBM_FILE ": "
60 #define IBM_ERR    KERN_ERR    IBM_LOG
61 #define IBM_NOTICE KERN_NOTICE IBM_LOG
62 #define IBM_INFO   KERN_INFO   IBM_LOG
63 #define IBM_DEBUG  KERN_DEBUG  IBM_LOG
64
65 #define IBM_MAX_ACPI_ARGS 3
66
67 /* ThinkPad CMOS commands */
68 #define TP_CMOS_VOLUME_DOWN     0
69 #define TP_CMOS_VOLUME_UP       1
70 #define TP_CMOS_VOLUME_MUTE     2
71 #define TP_CMOS_BRIGHTNESS_UP   4
72 #define TP_CMOS_BRIGHTNESS_DOWN 5
73
74 #define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
75 #define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
76 #define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
77
78 /* Debugging */
79 #define TPACPI_DBG_ALL          0xffff
80 #define TPACPI_DBG_ALL          0xffff
81 #define TPACPI_DBG_INIT         0x0001
82 #define TPACPI_DBG_EXIT         0x0002
83 #define dbg_printk(a_dbg_level, format, arg...) \
84         do { if (dbg_level & a_dbg_level) \
85                 printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
86 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
87 #define vdbg_printk(a_dbg_level, format, arg...) \
88         dbg_printk(a_dbg_level, format, ## arg)
89 static const char *str_supported(int is_supported);
90 #else
91 #define vdbg_printk(a_dbg_level, format, arg...)
92 #endif
93
94 /* ACPI HIDs */
95 #define IBM_HKEY_HID    "IBM0068"
96 #define IBM_PCI_HID     "PNP0A03"
97
98 /* ACPI helpers */
99 static int acpi_evalf(acpi_handle handle,
100                       void *res, char *method, char *fmt, ...);
101 static int acpi_ec_read(int i, u8 * p);
102 static int acpi_ec_write(int i, u8 v);
103 static int _sta(acpi_handle handle);
104
105 /* ACPI handles */
106 static acpi_handle root_handle;                 /* root namespace */
107 static acpi_handle ec_handle;                   /* EC */
108 static acpi_handle ecrd_handle, ecwr_handle;    /* 570 EC access */
109 static acpi_handle cmos_handle, hkey_handle;    /* basic thinkpad handles */
110
111 static void ibm_handle_init(char *name,
112                    acpi_handle *handle, acpi_handle parent,
113                    char **paths, int num_paths, char **path);
114 #define IBM_HANDLE_INIT(object)                                         \
115         ibm_handle_init(#object, &object##_handle, *object##_parent,    \
116                 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
117
118 /* procfs support */
119 static struct proc_dir_entry *proc_dir;
120
121 /* procfs helpers */
122 static int dispatch_read(char *page, char **start, off_t off, int count,
123                 int *eof, void *data);
124 static int dispatch_write(struct file *file, const char __user * userbuf,
125                 unsigned long count, void *data);
126 static char *next_cmd(char **cmds);
127
128 /* Module */
129 static int experimental;
130 static u32 dbg_level;
131 static int force_load;
132 static char *ibm_thinkpad_ec_found;
133
134 static char* check_dmi_for_ec(void);
135 static int thinkpad_acpi_module_init(void);
136 static void thinkpad_acpi_module_exit(void);
137
138
139 /****************************************************************************
140  * Subdrivers
141  */
142
143 struct ibm_struct {
144         char *name;
145
146         char *hid;
147         struct acpi_driver *driver;
148
149         int (*read) (char *);
150         int (*write) (char *);
151         void (*exit) (void);
152
153         void (*notify) (struct ibm_struct *, u32);
154         acpi_handle *handle;
155         int type;
156         struct acpi_device *device;
157
158         struct list_head all_drivers;
159
160         int driver_registered;
161         int proc_created;
162         int init_called;
163         int notify_installed;
164
165         int experimental;
166 };
167
168 struct ibm_init_struct {
169         char param[32];
170
171         int (*init) (struct ibm_init_struct *);
172         struct ibm_struct *data;
173 };
174
175 static struct list_head tpacpi_all_drivers;
176
177 static struct ibm_init_struct ibms_init[];
178 static int set_ibm_param(const char *val, struct kernel_param *kp);
179 static int ibm_init(struct ibm_init_struct *iibm);
180 static void ibm_exit(struct ibm_struct *ibm);
181
182
183 /*
184  * procfs master subdriver
185  */
186 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
187 static int thinkpad_acpi_driver_read(char *p);
188
189
190 /*
191  * Bay subdriver
192  */
193
194 #ifdef CONFIG_THINKPAD_ACPI_BAY
195 static int bay_status_supported, bay_eject_supported;
196 static int bay_status2_supported, bay_eject2_supported;
197
198 static acpi_handle bay_handle, bay_ej_handle;
199 static acpi_handle bay2_handle, bay2_ej_handle;
200
201 static int bay_init(struct ibm_init_struct *iibm);
202 static void bay_notify(struct ibm_struct *ibm, u32 event);
203 static int bay_read(char *p);
204 static int bay_write(char *buf);
205 #endif /* CONFIG_THINKPAD_ACPI_BAY */
206
207
208 /*
209  * Beep subdriver
210  */
211
212 static acpi_handle beep_handle;
213
214 static int beep_read(char *p);
215 static int beep_write(char *buf);
216
217
218 /*
219  * Bluetooth subdriver
220  */
221
222 static int bluetooth_supported;
223
224 static int bluetooth_init(struct ibm_init_struct *iibm);
225 static int bluetooth_status(void);
226 static int bluetooth_read(char *p);
227 static int bluetooth_write(char *buf);
228
229
230 /*
231  * Brightness (backlight) subdriver
232  */
233
234 static struct backlight_device *ibm_backlight_device;
235 static int brightness_offset = 0x31;
236
237 static int brightness_init(struct ibm_init_struct *iibm);
238 static void brightness_exit(void);
239 static int brightness_get(struct backlight_device *bd);
240 static int brightness_set(int value);
241 static int brightness_update_status(struct backlight_device *bd);
242 static int brightness_read(char *p);
243 static int brightness_write(char *buf);
244
245
246 /*
247  * CMOS subdriver
248  */
249
250 static int cmos_eval(int cmos_cmd);
251 static int cmos_read(char *p);
252 static int cmos_write(char *buf);
253
254
255 /*
256  * Dock subdriver
257  */
258
259 #ifdef CONFIG_THINKPAD_ACPI_DOCK
260 static acpi_handle pci_handle;
261 static acpi_handle dock_handle;
262
263 static void dock_notify(struct ibm_struct *ibm, u32 event);
264 static int dock_read(char *p);
265 static int dock_write(char *buf);
266 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
267
268
269 /*
270  * EC dump subdriver
271  */
272
273 static int ecdump_read(char *p) ;
274 static int ecdump_write(char *buf);
275
276
277 /*
278  * Fan subdriver
279  */
280
281 enum {                                  /* Fan control constants */
282         fan_status_offset = 0x2f,       /* EC register 0x2f */
283         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
284                                          * 0x84 must be read before 0x85 */
285
286         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
287         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
288 };
289
290 enum fan_status_access_mode {
291         TPACPI_FAN_NONE = 0,            /* No fan status or control */
292         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
293         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
294 };
295
296 enum fan_control_access_mode {
297         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
298         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
299         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
300         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
301 };
302
303 enum fan_control_commands {
304         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
305         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
306         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
307                                                  * and also watchdog cmd */
308 };
309
310 static enum fan_status_access_mode fan_status_access_mode;
311 static enum fan_control_access_mode fan_control_access_mode;
312 static enum fan_control_commands fan_control_commands;
313 static int fan_control_status_known;
314 static u8 fan_control_initial_status;
315 static int fan_watchdog_maxinterval;
316
317 static acpi_handle fans_handle, gfan_handle, sfan_handle;
318
319 static int fan_init(struct ibm_init_struct *iibm);
320 static void fan_exit(void);
321 static int fan_get_status(u8 *status);
322 static int fan_get_speed(unsigned int *speed);
323 static void fan_watchdog_fire(struct work_struct *ignored);
324 static void fan_watchdog_reset(void);
325 static int fan_set_level(int level);
326 static int fan_set_enable(void);
327 static int fan_set_disable(void);
328 static int fan_set_speed(int speed);
329 static int fan_read(char *p);
330 static int fan_write(char *buf);
331 static int fan_write_cmd_level(const char *cmd, int *rc);
332 static int fan_write_cmd_enable(const char *cmd, int *rc);
333 static int fan_write_cmd_disable(const char *cmd, int *rc);
334 static int fan_write_cmd_speed(const char *cmd, int *rc);
335 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
336
337
338 /*
339  * Hotkey subdriver
340  */
341
342 static int hotkey_supported;
343 static int hotkey_mask_supported;
344 static int hotkey_orig_status;
345 static int hotkey_orig_mask;
346
347 static int hotkey_init(struct ibm_init_struct *iibm);
348 static void hotkey_exit(void);
349 static int hotkey_get(int *status, int *mask);
350 static int hotkey_set(int status, int mask);
351 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
352 static int hotkey_read(char *p);
353 static int hotkey_write(char *buf);
354
355
356 /*
357  * LED subdriver
358  */
359
360 enum led_access_mode {
361         TPACPI_LED_NONE = 0,
362         TPACPI_LED_570, /* 570 */
363         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
364         TPACPI_LED_NEW, /* all others */
365 };
366
367 enum {  /* For TPACPI_LED_OLD */
368         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
369         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
370         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
371 };
372
373 static enum led_access_mode led_supported;
374 static acpi_handle led_handle;
375
376 static int led_init(struct ibm_init_struct *iibm);
377 static int led_read(char *p);
378 static int led_write(char *buf);
379
380 /*
381  * Light (thinklight) subdriver
382  */
383
384 static int light_supported;
385 static int light_status_supported;
386 static acpi_handle lght_handle, ledb_handle;
387
388 static int light_init(struct ibm_init_struct *iibm);
389 static int light_read(char *p);
390 static int light_write(char *buf);
391
392
393 /*
394  * Thermal subdriver
395  */
396
397 enum thermal_access_mode {
398         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
399         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
400         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
401         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
402         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
403 };
404
405 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
406 struct ibm_thermal_sensors_struct {
407         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
408 };
409
410 static int thermal_init(struct ibm_init_struct *iibm);
411 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
412 static int thermal_read(char *p);
413
414
415 /*
416  * Video subdriver
417  */
418
419 enum video_access_mode {
420         TPACPI_VIDEO_NONE = 0,
421         TPACPI_VIDEO_570,       /* 570 */
422         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
423         TPACPI_VIDEO_NEW,       /* all others */
424 };
425
426 static enum video_access_mode video_supported;
427 static int video_orig_autosw;
428 static acpi_handle vid_handle, vid2_handle;
429
430 static int video_init(struct ibm_init_struct *iibm);
431 static void video_exit(void);
432 static int video_status(void);
433 static int video_autosw(void);
434 static int video_switch(void);
435 static int video_switch2(int status);
436 static int video_expand(void);
437 static int video_read(char *p);
438 static int video_write(char *buf);
439
440
441 /*
442  * Volume subdriver
443  */
444
445 static int volume_offset = 0x30;
446
447 static int volume_read(char *p);
448 static int volume_write(char *buf);
449
450
451 /*
452  * Wan subdriver
453  */
454
455 static int wan_supported;
456
457 static int wan_init(struct ibm_init_struct *iibm);
458 static int wan_status(void);
459 static int wan_read(char *p);
460 static int wan_write(char *buf);
461
462
463 #endif /* __THINKPAD_ACPI_H */