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 #define IBM_PCI_HID     "PNP0A03"
 111
 112 /* ACPI helpers */
 113 static int __must_check acpi_evalf(acpi_handle handle,
 114                       void *res, char *method, char *fmt, ...);
 115 static int __must_check acpi_ec_read(int i, u8 * p);
 116 static int __must_check acpi_ec_write(int i, u8 v);
 117 static int __must_check _sta(acpi_handle handle);
 118
 119 /* ACPI handles */
 120 static acpi_handle root_handle;                 /* root namespace */
 121 static acpi_handle ec_handle;                   /* EC */
 122 static acpi_handle ecrd_handle, ecwr_handle;    /* 570 EC access */
 123 static acpi_handle cmos_handle, hkey_handle;    /* basic thinkpad handles */
 124
 125 static void drv_acpi_handle_init(char *name,
 126                    acpi_handle *handle, acpi_handle parent,
 127                    char **paths, int num_paths, char **path);
 128 #define IBM_ACPIHANDLE_INIT(object)                                             \
 129         drv_acpi_handle_init(#object, &object##_handle, *object##_parent,       \
 130                 object##_paths, ARRAY_SIZE(object##_paths), &object##_path)
 131
 132 /* ThinkPad ACPI helpers */
 133 static int issue_thinkpad_cmos_command(int cmos_cmd);
 134
 135 /* procfs support */
 136 static struct proc_dir_entry *proc_dir;
 137
 138 /* procfs helpers */
 139 static int dispatch_procfs_read(char *page, char **start, off_t off,
 140                 int count, int *eof, void *data);
 141 static int dispatch_procfs_write(struct file *file,
 142                 const char __user * userbuf,
 143                 unsigned long count, void *data);
 144 static char *next_cmd(char **cmds);
 145
 146 /* sysfs support */
 147 struct attribute_set {
 148         unsigned int members, max_members;
 149         struct attribute_group group;
 150 };
 151
 152 static struct attribute_set *create_attr_set(unsigned int max_members,
 153                                                 const char* name);
 154 #define destroy_attr_set(_set) \
 155         kfree(_set);
 156 static int add_to_attr_set(struct attribute_set* s, struct attribute *attr);
 157 static int add_many_to_attr_set(struct attribute_set* s,
 158                         struct attribute **attr,
 159                         unsigned int count);
 160 #define register_attr_set_with_sysfs(_attr_set, _kobj) \
 161         sysfs_create_group(_kobj, &_attr_set->group)
 162 static void delete_attr_set(struct attribute_set* s, struct kobject *kobj);
 163
 164 static int parse_strtoul(const char *buf, unsigned long max,
 165                         unsigned long *value);
 166
 167 /* Device model */
 168 static struct platform_device *tpacpi_pdev;
 169 static struct class_device *tpacpi_hwmon;
 170 static struct platform_driver tpacpi_pdriver;
 171 static struct input_dev *tpacpi_inputdev;
 172 static int tpacpi_create_driver_attributes(struct device_driver *drv);
 173 static void tpacpi_remove_driver_attributes(struct device_driver *drv);
 174
 175 /* Module */
 176 static int experimental;
 177 static u32 dbg_level;
 178 static int force_load;
 179 static char *ibm_thinkpad_ec_found;
 180
 181 static char* check_dmi_for_ec(void);
 182 static int thinkpad_acpi_module_init(void);
 183 static void thinkpad_acpi_module_exit(void);
 184
 185
 186 /****************************************************************************
 187  * Subdrivers
 188  */
 189
 190 struct ibm_struct;
 191
 192 struct tp_acpi_drv_struct {
 193         char *hid;
 194         struct acpi_driver *driver;
 195
 196         void (*notify) (struct ibm_struct *, u32);
 197         acpi_handle *handle;
 198         u32 type;
 199         struct acpi_device *device;
 200 };
 201
 202 struct ibm_struct {
 203         char *name;
 204
 205         int (*read) (char *);
 206         int (*write) (char *);
 207         void (*exit) (void);
 208         void (*resume) (void);
 209
 210         struct list_head all_drivers;
 211
 212         struct tp_acpi_drv_struct *acpi;
 213
 214         struct {
 215                 u8 acpi_driver_registered:1;
 216                 u8 acpi_notify_installed:1;
 217                 u8 proc_created:1;
 218                 u8 init_called:1;
 219                 u8 experimental:1;
 220         } flags;
 221 };
 222
 223 struct ibm_init_struct {
 224         char param[32];
 225
 226         int (*init) (struct ibm_init_struct *);
 227         struct ibm_struct *data;
 228 };
 229
 230 static struct {
 231 #ifdef CONFIG_THINKPAD_ACPI_BAY
 232         u16 bay_status:1;
 233         u16 bay_eject:1;
 234         u16 bay_status2:1;
 235         u16 bay_eject2:1;
 236 #endif
 237         u16 bluetooth:1;
 238         u16 hotkey:1;
 239         u16 hotkey_mask:1;
 240         u16 hotkey_wlsw:1;
 241         u16 light:1;
 242         u16 light_status:1;
 243         u16 wan:1;
 244         u16 fan_ctrl_status_undef:1;
 245         u16 input_device_registered:1;
 246 } tp_features;
 247
 248 static struct list_head tpacpi_all_drivers;
 249
 250 static struct ibm_init_struct ibms_init[];
 251 static int set_ibm_param(const char *val, struct kernel_param *kp);
 252 static int ibm_init(struct ibm_init_struct *iibm);
 253 static void ibm_exit(struct ibm_struct *ibm);
 254
 255
 256 /*
 257  * procfs master subdriver
 258  */
 259 static int thinkpad_acpi_driver_init(struct ibm_init_struct *iibm);
 260 static int thinkpad_acpi_driver_read(char *p);
 261
 262
 263 /*
 264  * Bay subdriver
 265  */
 266
 267 #ifdef CONFIG_THINKPAD_ACPI_BAY
 268 static acpi_handle bay_handle, bay_ej_handle;
 269 static acpi_handle bay2_handle, bay2_ej_handle;
 270
 271 static int bay_init(struct ibm_init_struct *iibm);
 272 static void bay_notify(struct ibm_struct *ibm, u32 event);
 273 static int bay_read(char *p);
 274 static int bay_write(char *buf);
 275 #endif /* CONFIG_THINKPAD_ACPI_BAY */
 276
 277
 278 /*
 279  * Beep subdriver
 280  */
 281
 282 static acpi_handle beep_handle;
 283
 284 static int beep_read(char *p);
 285 static int beep_write(char *buf);
 286
 287
 288 /*
 289  * Bluetooth subdriver
 290  */
 291
 292 enum {
 293         /* ACPI GBDC/SBDC bits */
 294         TP_ACPI_BLUETOOTH_HWPRESENT     = 0x01, /* Bluetooth hw available */
 295         TP_ACPI_BLUETOOTH_RADIOSSW      = 0x02, /* Bluetooth radio enabled */
 296         TP_ACPI_BLUETOOTH_UNK           = 0x04, /* unknown function */
 297 };
 298
 299 static int bluetooth_init(struct ibm_init_struct *iibm);
 300 static int bluetooth_get_radiosw(void);
 301 static int bluetooth_set_radiosw(int radio_on);
 302 static int bluetooth_read(char *p);
 303 static int bluetooth_write(char *buf);
 304
 305
 306 /*
 307  * Brightness (backlight) subdriver
 308  */
 309
 310 #define TPACPI_BACKLIGHT_DEV_NAME "thinkpad_screen"
 311
 312 static struct backlight_device *ibm_backlight_device;
 313 static int brightness_offset = 0x31;
 314
 315 static int brightness_init(struct ibm_init_struct *iibm);
 316 static void brightness_exit(void);
 317 static int brightness_get(struct backlight_device *bd);
 318 static int brightness_set(int value);
 319 static int brightness_update_status(struct backlight_device *bd);
 320 static int brightness_read(char *p);
 321 static int brightness_write(char *buf);
 322
 323
 324 /*
 325  * CMOS subdriver
 326  */
 327
 328 static int cmos_read(char *p);
 329 static int cmos_write(char *buf);
 330
 331
 332 /*
 333  * Dock subdriver
 334  */
 335
 336 #ifdef CONFIG_THINKPAD_ACPI_DOCK
 337 static acpi_handle pci_handle;
 338 static acpi_handle dock_handle;
 339
 340 static void dock_notify(struct ibm_struct *ibm, u32 event);
 341 static int dock_read(char *p);
 342 static int dock_write(char *buf);
 343 #endif /* CONFIG_THINKPAD_ACPI_DOCK */
 344
 345
 346 /*
 347  * EC dump subdriver
 348  */
 349
 350 static int ecdump_read(char *p) ;
 351 static int ecdump_write(char *buf);
 352
 353
 354 /*
 355  * Fan subdriver
 356  */
 357
 358 enum {                                  /* Fan control constants */
 359         fan_status_offset = 0x2f,       /* EC register 0x2f */
 360         fan_rpm_offset = 0x84,          /* EC register 0x84: LSB, 0x85 MSB (RPM)
 361                                          * 0x84 must be read before 0x85 */
 362
 363         TP_EC_FAN_FULLSPEED = 0x40,     /* EC fan mode: full speed */
 364         TP_EC_FAN_AUTO      = 0x80,     /* EC fan mode: auto fan control */
 365
 366         TPACPI_FAN_LAST_LEVEL = 0x100,  /* Use cached last-seen fan level */
 367 };
 368
 369 enum fan_status_access_mode {
 370         TPACPI_FAN_NONE = 0,            /* No fan status or control */
 371         TPACPI_FAN_RD_ACPI_GFAN,        /* Use ACPI GFAN */
 372         TPACPI_FAN_RD_TPEC,             /* Use ACPI EC regs 0x2f, 0x84-0x85 */
 373 };
 374
 375 enum fan_control_access_mode {
 376         TPACPI_FAN_WR_NONE = 0,         /* No fan control */
 377         TPACPI_FAN_WR_ACPI_SFAN,        /* Use ACPI SFAN */
 378         TPACPI_FAN_WR_TPEC,             /* Use ACPI EC reg 0x2f */
 379         TPACPI_FAN_WR_ACPI_FANS,        /* Use ACPI FANS and EC reg 0x2f */
 380 };
 381
 382 enum fan_control_commands {
 383         TPACPI_FAN_CMD_SPEED    = 0x0001,       /* speed command */
 384         TPACPI_FAN_CMD_LEVEL    = 0x0002,       /* level command  */
 385         TPACPI_FAN_CMD_ENABLE   = 0x0004,       /* enable/disable cmd,
 386                                                  * and also watchdog cmd */
 387 };
 388
 389 static int fan_control_allowed;
 390
 391 static enum fan_status_access_mode fan_status_access_mode;
 392 static enum fan_control_access_mode fan_control_access_mode;
 393 static enum fan_control_commands fan_control_commands;
 394 static u8 fan_control_initial_status;
 395 static u8 fan_control_desired_level;
 396 static int fan_watchdog_maxinterval;
 397
 398 static struct mutex fan_mutex;
 399
 400 static acpi_handle fans_handle, gfan_handle, sfan_handle;
 401
 402 static int fan_init(struct ibm_init_struct *iibm);
 403 static void fan_exit(void);
 404 static int fan_get_status(u8 *status);
 405 static int fan_get_status_safe(u8 *status);
 406 static int fan_get_speed(unsigned int *speed);
 407 static void fan_update_desired_level(u8 status);
 408 static void fan_watchdog_fire(struct work_struct *ignored);
 409 static void fan_watchdog_reset(void);
 410 static int fan_set_level(int level);
 411 static int fan_set_level_safe(int level);
 412 static int fan_set_enable(void);
 413 static int fan_set_disable(void);
 414 static int fan_set_speed(int speed);
 415 static int fan_read(char *p);
 416 static int fan_write(char *buf);
 417 static int fan_write_cmd_level(const char *cmd, int *rc);
 418 static int fan_write_cmd_enable(const char *cmd, int *rc);
 419 static int fan_write_cmd_disable(const char *cmd, int *rc);
 420 static int fan_write_cmd_speed(const char *cmd, int *rc);
 421 static int fan_write_cmd_watchdog(const char *cmd, int *rc);
 422
 423
 424 /*
 425  * Hotkey subdriver
 426  */
 427
 428 static int hotkey_orig_status;
 429 static u32 hotkey_orig_mask;
 430
 431 static struct mutex hotkey_mutex;
 432
 433 static int hotkey_init(struct ibm_init_struct *iibm);
 434 static void hotkey_exit(void);
 435 static int hotkey_get(int *status, u32 *mask);
 436 static int hotkey_set(int status, u32 mask);
 437 static void hotkey_notify(struct ibm_struct *ibm, u32 event);
 438 static int hotkey_read(char *p);
 439 static int hotkey_write(char *buf);
 440
 441
 442 /*
 443  * LED subdriver
 444  */
 445
 446 enum led_access_mode {
 447         TPACPI_LED_NONE = 0,
 448         TPACPI_LED_570, /* 570 */
 449         TPACPI_LED_OLD, /* 600e/x, 770e, 770x, A21e, A2xm/p, T20-22, X20-21 */
 450         TPACPI_LED_NEW, /* all others */
 451 };
 452
 453 enum {  /* For TPACPI_LED_OLD */
 454         TPACPI_LED_EC_HLCL = 0x0c,      /* EC reg to get led to power on */
 455         TPACPI_LED_EC_HLBL = 0x0d,      /* EC reg to blink a lit led */
 456         TPACPI_LED_EC_HLMS = 0x0e,      /* EC reg to select led to command */
 457 };
 458
 459 static enum led_access_mode led_supported;
 460 static acpi_handle led_handle;
 461
 462 static int led_init(struct ibm_init_struct *iibm);
 463 static int led_read(char *p);
 464 static int led_write(char *buf);
 465
 466 /*
 467  * Light (thinklight) subdriver
 468  */
 469
 470 static acpi_handle lght_handle, ledb_handle;
 471
 472 static int light_init(struct ibm_init_struct *iibm);
 473 static int light_read(char *p);
 474 static int light_write(char *buf);
 475
 476
 477 /*
 478  * Thermal subdriver
 479  */
 480
 481 enum thermal_access_mode {
 482         TPACPI_THERMAL_NONE = 0,        /* No thermal support */
 483         TPACPI_THERMAL_ACPI_TMP07,      /* Use ACPI TMP0-7 */
 484         TPACPI_THERMAL_ACPI_UPDT,       /* Use ACPI TMP0-7 with UPDT */
 485         TPACPI_THERMAL_TPEC_8,          /* Use ACPI EC regs, 8 sensors */
 486         TPACPI_THERMAL_TPEC_16,         /* Use ACPI EC regs, 16 sensors */
 487 };
 488
 489 enum { /* TPACPI_THERMAL_TPEC_* */
 490         TP_EC_THERMAL_TMP0 = 0x78,      /* ACPI EC regs TMP 0..7 */
 491         TP_EC_THERMAL_TMP8 = 0xC0,      /* ACPI EC regs TMP 8..15 */
 492         TP_EC_THERMAL_TMP_NA = -128,    /* ACPI EC sensor not available */
 493 };
 494
 495 #define TPACPI_MAX_THERMAL_SENSORS 16   /* Max thermal sensors supported */
 496 struct ibm_thermal_sensors_struct {
 497         s32 temp[TPACPI_MAX_THERMAL_SENSORS];
 498 };
 499
 500 static enum thermal_access_mode thermal_read_mode;
 501
 502 static int thermal_init(struct ibm_init_struct *iibm);
 503 static int thermal_get_sensor(int idx, s32 *value);
 504 static int thermal_get_sensors(struct ibm_thermal_sensors_struct *s);
 505 static int thermal_read(char *p);
 506
 507
 508 /*
 509  * Video subdriver
 510  */
 511
 512 enum video_access_mode {
 513         TPACPI_VIDEO_NONE = 0,
 514         TPACPI_VIDEO_570,       /* 570 */
 515         TPACPI_VIDEO_770,       /* 600e/x, 770e, 770x */
 516         TPACPI_VIDEO_NEW,       /* all others */
 517 };
 518
 519 enum {  /* video status flags, based on VIDEO_570 */
 520         TP_ACPI_VIDEO_S_LCD = 0x01,     /* LCD output enabled */
 521         TP_ACPI_VIDEO_S_CRT = 0x02,     /* CRT output enabled */
 522         TP_ACPI_VIDEO_S_DVI = 0x08,     /* DVI output enabled */
 523 };
 524
 525 enum {  /* TPACPI_VIDEO_570 constants */
 526         TP_ACPI_VIDEO_570_PHSCMD = 0x87,        /* unknown magic constant :( */
 527         TP_ACPI_VIDEO_570_PHSMASK = 0x03,       /* PHS bits that map to
 528                                                  * video_status_flags */
 529         TP_ACPI_VIDEO_570_PHS2CMD = 0x8b,       /* unknown magic constant :( */
 530         TP_ACPI_VIDEO_570_PHS2SET = 0x80,       /* unknown magic constant :( */
 531 };
 532
 533 static enum video_access_mode video_supported;
 534 static int video_orig_autosw;
 535 static acpi_handle vid_handle, vid2_handle;
 536
 537 static int video_init(struct ibm_init_struct *iibm);
 538 static void video_exit(void);
 539 static int video_outputsw_get(void);
 540 static int video_outputsw_set(int status);
 541 static int video_autosw_get(void);
 542 static int video_autosw_set(int enable);
 543 static int video_outputsw_cycle(void);
 544 static int video_expand_toggle(void);
 545 static int video_read(char *p);
 546 static int video_write(char *buf);
 547
 548
 549 /*
 550  * Volume subdriver
 551  */
 552
 553 static int volume_offset = 0x30;
 554
 555 static int volume_read(char *p);
 556 static int volume_write(char *buf);
 557
 558
 559 /*
 560  * Wan subdriver
 561  */
 562
 563 enum {
 564         /* ACPI GWAN/SWAN bits */
 565         TP_ACPI_WANCARD_HWPRESENT       = 0x01, /* Wan hw available */
 566         TP_ACPI_WANCARD_RADIOSSW        = 0x02, /* Wan radio enabled */
 567         TP_ACPI_WANCARD_UNK             = 0x04, /* unknown function */
 568 };
 569
 570 static int wan_init(struct ibm_init_struct *iibm);
 571 static int wan_get_radiosw(void);
 572 static int wan_set_radiosw(int radio_on);
 573 static int wan_read(char *p);
 574 static int wan_write(char *buf);
 575
 576
 577 #endif /* __THINKPAD_ACPI_H */