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