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 #define IBM_MAIL "ibm-acpi-devel@lists.sourceforge.net"
  56
  57 #define IBM_PROC_DIR "ibm"
  58 #define IBM_ACPI_EVENT_PREFIX "ibm"
  59
  60 #define IBM_LOG IBM_FILE ": "
  61 #define IBM_ERR    KERN_ERR    IBM_LOG
  62 #define IBM_NOTICE KERN_NOTICE IBM_LOG
  63 #define IBM_INFO   KERN_INFO   IBM_LOG
  64 #define IBM_DEBUG  KERN_DEBUG  IBM_LOG
  65
  66 #define IBM_MAX_ACPI_ARGS 3
  67
  68 /* ThinkPad CMOS commands */
  69 #define TP_CMOS_VOLUME_DOWN     0
  70 #define TP_CMOS_VOLUME_UP       1
  71 #define TP_CMOS_VOLUME_MUTE     2
  72 #define TP_CMOS_BRIGHTNESS_UP   4
  73 #define TP_CMOS_BRIGHTNESS_DOWN 5
  74
  75 #define onoff(status,bit) ((status) & (1 << (bit)) ? "on" : "off")
  76 #define enabled(status,bit) ((status) & (1 << (bit)) ? "enabled" : "disabled")
  77 #define strlencmp(a,b) (strncmp((a), (b), strlen(b)))
  78
  79 /* Debugging */
  80 #define TPACPI_DBG_ALL          0xffff
  81 #define TPACPI_DBG_ALL          0xffff
  82 #define TPACPI_DBG_INIT         0x0001
  83 #define TPACPI_DBG_EXIT         0x0002
  84 #define dbg_printk(a_dbg_level, format, arg...) \
  85         do { if (dbg_level & a_dbg_level) \
  86                 printk(IBM_DEBUG "%s: " format, __func__ , ## arg); } while (0)
  87 #ifdef CONFIG_THINKPAD_ACPI_DEBUG
  88 #define vdbg_printk(a_dbg_level, format, arg...) \
  89         dbg_printk(a_dbg_level, format, ## arg)
  90 static const char *str_supported(int is_supported);
  91 #else
  92 #define vdbg_printk(a_dbg_level, format, arg...)
  93 #endif
  94
  95 /* ACPI HIDs */
  96 #define IBM_HKEY_HID    "IBM0068"
  97 #define IBM_PCI_HID     "PNP0A03"
  98
  99 /* ACPI helpers */
 100 static int __must_check acpi_evalf(acpi_handle handle,
 101                       void *res, char *method, char *fmt, ...);
 102 static int __must_check acpi_ec_read(int i, u8 * p);
 103 static int __must_check acpi_ec_write(int i, u8 v);
 104 static int __must_check _sta(acpi_handle handle);
 105
 106 /* ACPI handles */
 107 static acpi_handle root_handle;                 /* root namespace */
 108 static acpi_handle ec_handle;                   /* EC */
 109 static acpi_handle ecrd_handle, ecwr_handle;    /* 570 EC access */
 110 static acpi_handle cmos_handle, hkey_handle;    /* basic thinkpad handles */
 111
 112 static void drv_acpi_handle_init(char *name,
 113                    acpi_handle *handle, acpi_handle parent,
 114                    char **paths, int num_paths, char **path);
 115 #define IBM_ACPIHANDLE_INIT(object)                                             \
 116         drv_acpi_handle_init(#object, &object##_handle, *object##_parent,       \
 117                 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
 118
 119 /* ThinkPad ACPI helpers */
 120 static int issue_thinkpad_cmos_command(int cmos_cmd);
 121
 122 /* procfs support */
 123 static struct proc_dir_entry *proc_dir;
 124
 125 /* procfs helpers */
 126 static int dispatch_procfs_read(char *page, char **start, off_t off,
 127                 int count, int *eof, void *data);
 128 static int dispatch_procfs_write(struct file *file,
 129                 const char __user * userbuf,
 130                 unsigned long count, void *data);
 131 static char *next_cmd(char **cmds);
 132
 133 /* Module */
 134 static int experimental;
 135 static u32 dbg_level;
 136 static int force_load;
 137 static char *ibm_thinkpad_ec_found;
 138
 139 static char* check_dmi_for_ec(void);
 140 static int thinkpad_acpi_module_init(void);
 141 static void thinkpad_acpi_module_exit(void);
 142
 143
 144 /****************************************************************************
 145  * Subdrivers
 146  */
 147
 148 struct ibm_struct;
 149
 150 struct tp_acpi_drv_struct {
 151         char *hid;
 152         struct acpi_driver *driver;
 153
 154         void (*notify) (struct ibm_struct *, u32);
 155         acpi_handle *handle;
 156         u32 type;
 157         struct acpi_device *device;
 158 };
 159
 160 struct ibm_struct {
 161         char *name;
 162
 163         int (*read) (char *);
 164         int (*write) (char *);
 165         void (*exit) (void);
 166
 167         struct list_head all_drivers;
 168
 169         struct tp_acpi_drv_struct *acpi;
 170
 171         struct {
 172                 u8 acpi_driver_registered:1;
 173                 u8 acpi_notify_installed:1;
 174                 u8 proc_created:1;
 175                 u8 init_called:1;
 176                 u8 experimental:1;
 177         } flags;
 178 };
 179
 180 struct ibm_init_struct {
 181         char param[32];
 182
 183         int (*init) (struct ibm_init_struct *);
 184         struct ibm_struct *data;
 185 };
 186
 187 static struct {
 188 #ifdef CONFIG_THINKPAD_ACPI_BAY
 189         u16 bay_status:1;
 190         u16 bay_eject:1;
 191         u16 bay_status2:1;
 192         u16 bay_eject2:1;
 193 #endif
 194         u16 bluetooth:1;
 195         u16 hotkey:1;
 196         u16 hotkey_mask:1;
 197         u16 light:1;
 198         u16 light_status:1;
 199         u16 wan:1;
 200         u16 fan_ctrl_status_undef:1;
 201 } tp_features;
 202
 203 static struct list_head tpacpi_all_drivers;
 204
 205 static struct ibm_init_struct ibms_init[];
 206 static int set_ibm_param(const char *val, struct kernel_param *kp);
 207 static int ibm_init(struct ibm_init_struct *iibm);
 208 static void ibm_exit(struct ibm_struct *ibm);
 209
 210
 211 /*
 212  * procfs master subdriver
 213  */
 214 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
 215 static int thinkpad_acpi_driver_read(char *p);
 216
 217
 218 /*
 219  * Bay subdriver
 220  */
 221
 222 #ifdef CONFIG_THINKPAD_ACPI_BAY
 223 static acpi_handle bay_handle, bay_ej_handle;
 224 static acpi_handle bay2_handle, bay2_ej_handle;
 225
 226 static int bay_init(struct ibm_init_struct *iibm);
 227 static void bay_notify(struct ibm_struct *ibm, u32 event);
 228 static int bay_read(char *p);
 229 static int bay_write(char *buf);
 230 #endif /* CONFIG_THINKPAD_ACPI_BAY */
 231
 232
 233 /*
 234  * Beep subdriver
 235  */
 236
 237 static acpi_handle beep_handle;
 238
 239 static int beep_read(char *p);
 240 static int beep_write(char *buf);
 241
 242
 243 /*
 244  * Bluetooth subdriver
 245  */
 246
 247 enum {
 248         /* ACPI GBDC/SBDC bits */
 249         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
 250         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
 251         TP_ACPI_BLUETOOTH_UNK           = 0x04, /* unknown function */
 252 };
 253
 254 static int bluetooth_init(struct ibm_init_struct *iibm);
 255 static int bluetooth_get_radiosw(void);
 256 static int bluetooth_set_radiosw(int radio_on);
 257 static int bluetooth_read(char *p);
 258 static int bluetooth_write(char *buf);
 259
 260
 261 /*
 262  * Brightness (backlight) subdriver
 263  */
 264
 265 static struct backlight_device *ibm_backlight_device;
 266 static int brightness_offset = 0x31;
 267
 268 static int brightness_init(struct ibm_init_struct *iibm);
 269 static void brightness_exit(void);
 270 static int brightness_get(struct backlight_device *bd);
 271 static int brightness_set(int value);
 272 static int brightness_update_status(struct backlight_device *bd);
 273 static int brightness_read(char *p);
 274 static int brightness_write(char *buf);
 275
 276
 277 /*
 278  * CMOS subdriver
 279  */
 280
 281 static int cmos_read(char *p);
 282 static int cmos_write(char *buf);
 283
 284
 285 /*
 286  * Dock subdriver
 287  */
 288
 289 #ifdef CONFIG_THINKPAD_ACPI_DOCK
 290 static acpi_handle pci_handle;
 291 static acpi_handle dock_handle;
 292
 293 static void dock_notify(struct ibm_struct *ibm, u32 event);
 294 static int dock_read(char *p);
 295 static int dock_write(char *buf);
 296 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
 297
 298
 299 /*
 300  * EC dump subdriver
 301  */
 302
 303 static int ecdump_read(char *p) ;
 304 static int ecdump_write(char *buf);
 305
 306
 307 /*
 308  * Fan subdriver
 309  */
 310
 311 enum {                                  /* Fan control constants */
 312         fan_status_offset = 0x2f,       /* EC register 0x2f */
 313         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
 314                                          * 0x84 must be read before 0x85 */
 315
 316         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
 317         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
 318 };
 319
 320 enum fan_status_access_mode {
 321         TPACPI_FAN_NONE = 0,            /* No fan status or control */
 322         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
 323         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
 324 };
 325
 326 enum fan_control_access_mode {
 327         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
 328         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
 329         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
 330         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
 331 };
 332
 333 enum fan_control_commands {
 334         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
 335         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
 336         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
 337                                                  * and also watchdog cmd */
 338 };
 339
 340 static enum fan_status_access_mode fan_status_access_mode;
 341 static enum fan_control_access_mode fan_control_access_mode;
 342 static enum fan_control_commands fan_control_commands;
 343 static u8 fan_control_initial_status;
 344 static int fan_watchdog_maxinterval;
 345
 346 static acpi_handle fans_handle, gfan_handle, sfan_handle;
 347
 348 static int fan_init(struct ibm_init_struct *iibm);
 349 static void fan_exit(void);
 350 static int fan_get_status(u8 *status);
 351 static int fan_get_speed(unsigned int *speed);
 352 static void fan_watchdog_fire(struct work_struct *ignored);
 353 static void fan_watchdog_reset(void);
 354 static int fan_set_level(int level);
 355 static int fan_set_enable(void);
 356 static int fan_set_disable(void);
 357 static int fan_set_speed(int speed);
 358 static int fan_read(char *p);
 359 static int fan_write(char *buf);
 360 static int fan_write_cmd_level(const char *cmd, int *rc);
 361 static int fan_write_cmd_enable(const char *cmd, int *rc);
 362 static int fan_write_cmd_disable(const char *cmd, int *rc);
 363 static int fan_write_cmd_speed(const char *cmd, int *rc);
 364 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
 365
 366
 367 /*
 368  * Hotkey subdriver
 369  */
 370
 371 static int hotkey_orig_status;
 372 static int hotkey_orig_mask;
 373
 374 static int hotkey_init(struct ibm_init_struct *iibm);
 375 static void hotkey_exit(void);
 376 static int hotkey_get(int *status, int *mask);
 377 static int hotkey_set(int status, int mask);
 378 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
 379 static int hotkey_read(char *p);
 380 static int hotkey_write(char *buf);
 381
 382
 383 /*
 384  * LED subdriver
 385  */
 386
 387 enum led_access_mode {
 388         TPACPI_LED_NONE = 0,
 389         TPACPI_LED_570, /* 570 */
 390         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
 391         TPACPI_LED_NEW, /* all others */
 392 };
 393
 394 enum {  /* For TPACPI_LED_OLD */
 395         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
 396         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
 397         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
 398 };
 399
 400 static enum led_access_mode led_supported;
 401 static acpi_handle led_handle;
 402
 403 static int led_init(struct ibm_init_struct *iibm);
 404 static int led_read(char *p);
 405 static int led_write(char *buf);
 406
 407 /*
 408  * Light (thinklight) subdriver
 409  */
 410
 411 static acpi_handle lght_handle, ledb_handle;
 412
 413 static int light_init(struct ibm_init_struct *iibm);
 414 static int light_read(char *p);
 415 static int light_write(char *buf);
 416
 417
 418 /*
 419  * Thermal subdriver
 420  */
 421
 422 enum thermal_access_mode {
 423         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
 424         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
 425         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
 426         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
 427         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
 428 };
 429
 430 enum { /* TPACPI_THERMAL_TPEC_* */
 431         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
 432         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
 433 };
 434
 435 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
 436 struct ibm_thermal_sensors_struct {
 437         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
 438 };
 439
 440 static enum thermal_access_mode thermal_read_mode;
 441
 442 static int thermal_init(struct ibm_init_struct *iibm);
 443 static int thermal_get_sensor(int idx, s32 *value);
 444 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
 445 static int thermal_read(char *p);
 446
 447
 448 /*
 449  * Video subdriver
 450  */
 451
 452 enum video_access_mode {
 453         TPACPI_VIDEO_NONE = 0,
 454         TPACPI_VIDEO_570,       /* 570 */
 455         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
 456         TPACPI_VIDEO_NEW,       /* all others */
 457 };
 458
 459 enum {  /* video status flags, based on VIDEO_570 */
 460         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
 461         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
 462         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
 463 };
 464
 465 enum {  /* TPACPI_VIDEO_570 constants */
 466         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
 467         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
 468                                                  * video_status_flags */
 469         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
 470         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
 471 };
 472
 473 static enum video_access_mode video_supported;
 474 static int video_orig_autosw;
 475 static acpi_handle vid_handle, vid2_handle;
 476
 477 static int video_init(struct ibm_init_struct *iibm);
 478 static void video_exit(void);
 479 static int video_outputsw_get(void);
 480 static int video_outputsw_set(int status);
 481 static int video_autosw_get(void);
 482 static int video_autosw_set(int enable);
 483 static int video_outputsw_cycle(void);
 484 static int video_expand_toggle(void);
 485 static int video_read(char *p);
 486 static int video_write(char *buf);
 487
 488
 489 /*
 490  * Volume subdriver
 491  */
 492
 493 static int volume_offset = 0x30;
 494
 495 static int volume_read(char *p);
 496 static int volume_write(char *buf);
 497
 498
 499 /*
 500  * Wan subdriver
 501  */
 502
 503 enum {
 504         /* ACPI GWAN/SWAN bits */
 505         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
 506         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
 507         TP_ACPI_WANCARD_UNK             = 0x04, /* unknown function */
 508 };
 509
 510 static int wan_init(struct ibm_init_struct *iibm);
 511 static int wan_get_radiosw(void);
 512 static int wan_set_radiosw(int radio_on);
 513 static int wan_read(char *p);
 514 static int wan_write(char *buf);
 515
 516
 517 #endif /* __THINKPAD_ACPI_H */