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