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