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