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