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         struct {
 161                 u8 driver_registered:1;
 162                 u8 proc_created:1;
 163                 u8 init_called:1;
 164                 u8 notify_installed:1;
 165                 u8 experimental:1;
 166         } flags;
 167 };
 168
 169 struct ibm_init_struct {
 170         char param[32];
 171
 172         int (*init) (struct ibm_init_struct *);
 173         struct ibm_struct *data;
 174 };
 175
 176 static struct {
 177 #ifdef CONFIG_THINKPAD_ACPI_BAY
 178         u16 bay_status:1;
 179         u16 bay_eject:1;
 180         u16 bay_status2:1;
 181         u16 bay_eject2:1;
 182 #endif
 183         u16 bluetooth:1;
 184         u16 hotkey:1;
 185         u16 hotkey_mask:1;
 186         u16 light:1;
 187         u16 light_status:1;
 188         u16 wan:1;
 189         u16 fan_ctrl_status_undef:1;
 190 } tp_features;
 191
 192 static struct list_head tpacpi_all_drivers;
 193
 194 static struct ibm_init_struct ibms_init[];
 195 static int set_ibm_param(const char *val, struct kernel_param *kp);
 196 static int ibm_init(struct ibm_init_struct *iibm);
 197 static void ibm_exit(struct ibm_struct *ibm);
 198
 199
 200 /*
 201  * procfs master subdriver
 202  */
 203 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
 204 static int thinkpad_acpi_driver_read(char *p);
 205
 206
 207 /*
 208  * Bay subdriver
 209  */
 210
 211 #ifdef CONFIG_THINKPAD_ACPI_BAY
 212 static acpi_handle bay_handle, bay_ej_handle;
 213 static acpi_handle bay2_handle, bay2_ej_handle;
 214
 215 static int bay_init(struct ibm_init_struct *iibm);
 216 static void bay_notify(struct ibm_struct *ibm, u32 event);
 217 static int bay_read(char *p);
 218 static int bay_write(char *buf);
 219 #endif /* CONFIG_THINKPAD_ACPI_BAY */
 220
 221
 222 /*
 223  * Beep subdriver
 224  */
 225
 226 static acpi_handle beep_handle;
 227
 228 static int beep_read(char *p);
 229 static int beep_write(char *buf);
 230
 231
 232 /*
 233  * Bluetooth subdriver
 234  */
 235
 236 static int bluetooth_init(struct ibm_init_struct *iibm);
 237 static int bluetooth_status(void);
 238 static int bluetooth_read(char *p);
 239 static int bluetooth_write(char *buf);
 240
 241
 242 /*
 243  * Brightness (backlight) subdriver
 244  */
 245
 246 static struct backlight_device *ibm_backlight_device;
 247 static int brightness_offset = 0x31;
 248
 249 static int brightness_init(struct ibm_init_struct *iibm);
 250 static void brightness_exit(void);
 251 static int brightness_get(struct backlight_device *bd);
 252 static int brightness_set(int value);
 253 static int brightness_update_status(struct backlight_device *bd);
 254 static int brightness_read(char *p);
 255 static int brightness_write(char *buf);
 256
 257
 258 /*
 259  * CMOS subdriver
 260  */
 261
 262 static int cmos_eval(int cmos_cmd);
 263 static int cmos_read(char *p);
 264 static int cmos_write(char *buf);
 265
 266
 267 /*
 268  * Dock subdriver
 269  */
 270
 271 #ifdef CONFIG_THINKPAD_ACPI_DOCK
 272 static acpi_handle pci_handle;
 273 static acpi_handle dock_handle;
 274
 275 static void dock_notify(struct ibm_struct *ibm, u32 event);
 276 static int dock_read(char *p);
 277 static int dock_write(char *buf);
 278 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
 279
 280
 281 /*
 282  * EC dump subdriver
 283  */
 284
 285 static int ecdump_read(char *p) ;
 286 static int ecdump_write(char *buf);
 287
 288
 289 /*
 290  * Fan subdriver
 291  */
 292
 293 enum {                                  /* Fan control constants */
 294         fan_status_offset = 0x2f,       /* EC register 0x2f */
 295         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
 296                                          * 0x84 must be read before 0x85 */
 297
 298         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
 299         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
 300 };
 301
 302 enum fan_status_access_mode {
 303         TPACPI_FAN_NONE = 0,            /* No fan status or control */
 304         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
 305         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
 306 };
 307
 308 enum fan_control_access_mode {
 309         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
 310         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
 311         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
 312         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
 313 };
 314
 315 enum fan_control_commands {
 316         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
 317         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
 318         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
 319                                                  * and also watchdog cmd */
 320 };
 321
 322 static enum fan_status_access_mode fan_status_access_mode;
 323 static enum fan_control_access_mode fan_control_access_mode;
 324 static enum fan_control_commands fan_control_commands;
 325 static u8 fan_control_initial_status;
 326 static int fan_watchdog_maxinterval;
 327
 328 static acpi_handle fans_handle, gfan_handle, sfan_handle;
 329
 330 static int fan_init(struct ibm_init_struct *iibm);
 331 static void fan_exit(void);
 332 static int fan_get_status(u8 *status);
 333 static int fan_get_speed(unsigned int *speed);
 334 static void fan_watchdog_fire(struct work_struct *ignored);
 335 static void fan_watchdog_reset(void);
 336 static int fan_set_level(int level);
 337 static int fan_set_enable(void);
 338 static int fan_set_disable(void);
 339 static int fan_set_speed(int speed);
 340 static int fan_read(char *p);
 341 static int fan_write(char *buf);
 342 static int fan_write_cmd_level(const char *cmd, int *rc);
 343 static int fan_write_cmd_enable(const char *cmd, int *rc);
 344 static int fan_write_cmd_disable(const char *cmd, int *rc);
 345 static int fan_write_cmd_speed(const char *cmd, int *rc);
 346 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
 347
 348
 349 /*
 350  * Hotkey subdriver
 351  */
 352
 353 static int hotkey_orig_status;
 354 static int hotkey_orig_mask;
 355
 356 static int hotkey_init(struct ibm_init_struct *iibm);
 357 static void hotkey_exit(void);
 358 static int hotkey_get(int *status, int *mask);
 359 static int hotkey_set(int status, int mask);
 360 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
 361 static int hotkey_read(char *p);
 362 static int hotkey_write(char *buf);
 363
 364
 365 /*
 366  * LED subdriver
 367  */
 368
 369 enum led_access_mode {
 370         TPACPI_LED_NONE = 0,
 371         TPACPI_LED_570, /* 570 */
 372         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
 373         TPACPI_LED_NEW, /* all others */
 374 };
 375
 376 enum {  /* For TPACPI_LED_OLD */
 377         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
 378         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
 379         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
 380 };
 381
 382 static enum led_access_mode led_supported;
 383 static acpi_handle led_handle;
 384
 385 static int led_init(struct ibm_init_struct *iibm);
 386 static int led_read(char *p);
 387 static int led_write(char *buf);
 388
 389 /*
 390  * Light (thinklight) subdriver
 391  */
 392
 393 static acpi_handle lght_handle, ledb_handle;
 394
 395 static int light_init(struct ibm_init_struct *iibm);
 396 static int light_read(char *p);
 397 static int light_write(char *buf);
 398
 399
 400 /*
 401  * Thermal subdriver
 402  */
 403
 404 enum thermal_access_mode {
 405         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
 406         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
 407         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
 408         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
 409         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
 410 };
 411
 412 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
 413 struct ibm_thermal_sensors_struct {
 414         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
 415 };
 416
 417 static int thermal_init(struct ibm_init_struct *iibm);
 418 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
 419 static int thermal_read(char *p);
 420
 421
 422 /*
 423  * Video subdriver
 424  */
 425
 426 enum video_access_mode {
 427         TPACPI_VIDEO_NONE = 0,
 428         TPACPI_VIDEO_570,       /* 570 */
 429         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
 430         TPACPI_VIDEO_NEW,       /* all others */
 431 };
 432
 433 static enum video_access_mode video_supported;
 434 static int video_orig_autosw;
 435 static acpi_handle vid_handle, vid2_handle;
 436
 437 static int video_init(struct ibm_init_struct *iibm);
 438 static void video_exit(void);
 439 static int video_status(void);
 440 static int video_autosw(void);
 441 static int video_switch(void);
 442 static int video_switch2(int status);
 443 static int video_expand(void);
 444 static int video_read(char *p);
 445 static int video_write(char *buf);
 446
 447
 448 /*
 449  * Volume subdriver
 450  */
 451
 452 static int volume_offset = 0x30;
 453
 454 static int volume_read(char *p);
 455 static int volume_write(char *buf);
 456
 457
 458 /*
 459  * Wan subdriver
 460  */
 461
 462 static int wan_init(struct ibm_init_struct *iibm);
 463 static int wan_status(void);
 464 static int wan_read(char *p);
 465 static int wan_write(char *buf);
 466
 467
 468 #endif /* __THINKPAD_ACPI_H */