drivers/acpi/asus_acpi.c

   1 /*
   2  *  asus_acpi.c - Asus Laptop ACPI Extras
   3  *
   4  *
   5  *  Copyright (C) 2002, 2003, 2004 Julien Lerouge, Karol Kozimor
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  *
  22  *  The development page for this driver is located at
  23  *  http://sourceforge.net/projects/acpi4asus/
  24  *
  25  *  Credits:
  26  *  Pontus Fuchs   - Helper functions, cleanup
  27  *  Johann Wiesner - Small compile fixes
  28  *  John Belmonte  - ACPI code for Toshiba laptop was a good starting point.
  29  *
  30  *  TODO:
  31  *  add Fn key status
  32  *  Add mode selection on module loading (parameter) -> still necessary?
  33  *  Complete display switching -- may require dirty hacks or calling _DOS?
  34  */
  35
  36 #include <linux/kernel.h>
  37 #include <linux/module.h>
  38 #include <linux/init.h>
  39 #include <linux/types.h>
  40 #include <linux/proc_fs.h>
  41 #include <acpi/acpi_drivers.h>
  42 #include <acpi/acpi_bus.h>
  43 #include <asm/uaccess.h>
  44
  45 #define ASUS_ACPI_VERSION "0.29"
  46
  47 #define PROC_ASUS       "asus"  //the directory
  48 #define PROC_MLED       "mled"
  49 #define PROC_WLED       "wled"
  50 #define PROC_TLED       "tled"
  51 #define PROC_INFO       "info"
  52 #define PROC_LCD        "lcd"
  53 #define PROC_BRN        "brn"
  54 #define PROC_DISP       "disp"
  55
  56 #define ACPI_HOTK_NAME          "Asus Laptop ACPI Extras Driver"
  57 #define ACPI_HOTK_CLASS         "hotkey"
  58 #define ACPI_HOTK_DEVICE_NAME   "Hotkey"
  59 #define ACPI_HOTK_HID           "ATK0100"
  60
  61 /*
  62  * Some events we use, same for all Asus
  63  */
  64 #define BR_UP       0x10
  65 #define BR_DOWN     0x20
  66
  67 /*
  68  * Flags for hotk status
  69  */
  70 #define MLED_ON     0x01        //is MLED ON ?
  71 #define WLED_ON     0x02
  72 #define TLED_ON     0x04
  73
  74 MODULE_AUTHOR("Julien Lerouge, Karol Kozimor");
  75 MODULE_DESCRIPTION(ACPI_HOTK_NAME);
  76 MODULE_LICENSE("GPL");
  77
  78 static uid_t asus_uid;
  79 static gid_t asus_gid;
  80 module_param(asus_uid, uint, 0);
  81 MODULE_PARM_DESC(asus_uid, "UID for entries in /proc/acpi/asus.\n");
  82 module_param(asus_gid, uint, 0);
  83 MODULE_PARM_DESC(asus_gid, "GID for entries in /proc/acpi/asus.\n");
  84
  85 /* For each model, all features implemented,
  86  * those marked with R are relative to HOTK, A for absolute */
  87 struct model_data {
  88         char *name;             //name of the laptop________________A
  89         char *mt_mled;          //method to handle mled_____________R
  90         char *mled_status;      //node to handle mled reading_______A
  91         char *mt_wled;          //method to handle wled_____________R
  92         char *wled_status;      //node to handle wled reading_______A
  93         char *mt_tled;          //method to handle tled_____________R
  94         char *tled_status;      //node to handle tled reading_______A
  95         char *mt_lcd_switch;    //method to turn LCD ON/OFF_________A
  96         char *lcd_status;       //node to read LCD panel state______A
  97         char *brightness_up;    //method to set brightness up_______A
  98         char *brightness_down;  //guess what ?______________________A
  99         char *brightness_set;   //method to set absolute brightness_R
 100         char *brightness_get;   //method to get absolute brightness_R
 101         char *brightness_status;        //node to get brightness____________A
 102         char *display_set;      //method to set video output________R
 103         char *display_get;      //method to get video output________R
 104 };
 105
 106 /*
 107  * This is the main structure, we can use it to store anything interesting
 108  * about the hotk device
 109  */
 110 struct asus_hotk {
 111         struct acpi_device *device;     //the device we are in
 112         acpi_handle handle;     //the handle of the hotk device
 113         char status;            //status of the hotk, for LEDs, ...
 114         struct model_data *methods;     //methods available on the laptop
 115         u8 brightness;          //brightness level
 116         enum {
 117                 A1x = 0,        //A1340D, A1300F
 118                 A2x,            //A2500H
 119                 D1x,            //D1
 120                 L2D,            //L2000D
 121                 L3C,            //L3800C
 122                 L3D,            //L3400D
 123                 L3H,            //L3H, but also L2000E
 124                 L4R,            //L4500R
 125                 L5x,            //L5800C
 126                 L8L,            //L8400L
 127                 M1A,            //M1300A
 128                 M2E,            //M2400E, L4400L
 129                 M6N,            //M6800N
 130                 M6R,            //M6700R
 131                 P30,            //Samsung P30
 132                 S1x,            //S1300A, but also L1400B and M2400A (L84F)
 133                 S2x,            //S200 (J1 reported), Victor MP-XP7210
 134                 xxN,            //M2400N, M3700N, M5200N, S1300N, S5200N, W1OOON
 135                 //(Centrino)
 136                 END_MODEL
 137         } model;                //Models currently supported
 138         u16 event_count[128];   //count for each event TODO make this better
 139 };
 140
 141 /* Here we go */
 142 #define A1x_PREFIX "\\_SB.PCI0.ISA.EC0."
 143 #define L3C_PREFIX "\\_SB.PCI0.PX40.ECD0."
 144 #define M1A_PREFIX "\\_SB.PCI0.PX40.EC0."
 145 #define P30_PREFIX "\\_SB.PCI0.LPCB.EC0."
 146 #define S1x_PREFIX "\\_SB.PCI0.PX40."
 147 #define S2x_PREFIX A1x_PREFIX
 148 #define xxN_PREFIX "\\_SB.PCI0.SBRG.EC0."
 149
 150 static struct model_data model_conf[END_MODEL] = {
 151         /*
 152          * Those pathnames are relative to the HOTK / ATKD device :
 153          *       - mt_mled
 154          *       - mt_wled
 155          *       - brightness_set
 156          *       - brightness_get
 157          *       - display_set
 158          *       - display_get
 159          *
 160          * TODO I have seen a SWBX and AIBX method on some models, like L1400B,
 161          * it seems to be a kind of switch, but what for ?
 162          *
 163          */
 164
 165         {
 166          .name = "A1x",
 167          .mt_mled = "MLED",
 168          .mled_status = "\\MAIL",
 169          .mt_lcd_switch = A1x_PREFIX "_Q10",
 170          .lcd_status = "\\BKLI",
 171          .brightness_up = A1x_PREFIX "_Q0E",
 172          .brightness_down = A1x_PREFIX "_Q0F"},
 173
 174         {
 175          .name = "A2x",
 176          .mt_mled = "MLED",
 177          .mt_wled = "WLED",
 178          .wled_status = "\\SG66",
 179          .mt_lcd_switch = "\\Q10",
 180          .lcd_status = "\\BAOF",
 181          .brightness_set = "SPLV",
 182          .brightness_get = "GPLV",
 183          .display_set = "SDSP",
 184          .display_get = "\\INFB"},
 185
 186         {
 187          .name = "D1x",
 188          .mt_mled = "MLED",
 189          .mt_lcd_switch = "\\Q0D",
 190          .lcd_status = "\\GP11",
 191          .brightness_up = "\\Q0C",
 192          .brightness_down = "\\Q0B",
 193          .brightness_status = "\\BLVL",
 194          .display_set = "SDSP",
 195          .display_get = "\\INFB"},
 196
 197         {
 198          .name = "L2D",
 199          .mt_mled = "MLED",
 200          .mled_status = "\\SGP6",
 201          .mt_wled = "WLED",
 202          .wled_status = "\\RCP3",
 203          .mt_lcd_switch = "\\Q10",
 204          .lcd_status = "\\SGP0",
 205          .brightness_up = "\\Q0E",
 206          .brightness_down = "\\Q0F",
 207          .display_set = "SDSP",
 208          .display_get = "\\INFB"},
 209
 210         {
 211          .name = "L3C",
 212          .mt_mled = "MLED",
 213          .mt_wled = "WLED",
 214          .mt_lcd_switch = L3C_PREFIX "_Q10",
 215          .lcd_status = "\\GL32",
 216          .brightness_set = "SPLV",
 217          .brightness_get = "GPLV",
 218          .display_set = "SDSP",
 219          .display_get = "\\_SB.PCI0.PCI1.VGAC.NMAP"},
 220
 221         {
 222          .name = "L3D",
 223          .mt_mled = "MLED",
 224          .mled_status = "\\MALD",
 225          .mt_wled = "WLED",
 226          .mt_lcd_switch = "\\Q10",
 227          .lcd_status = "\\BKLG",
 228          .brightness_set = "SPLV",
 229          .brightness_get = "GPLV",
 230          .display_set = "SDSP",
 231          .display_get = "\\INFB"},
 232
 233         {
 234          .name = "L3H",
 235          .mt_mled = "MLED",
 236          .mt_wled = "WLED",
 237          .mt_lcd_switch = "EHK",
 238          .lcd_status = "\\_SB.PCI0.PM.PBC",
 239          .brightness_set = "SPLV",
 240          .brightness_get = "GPLV",
 241          .display_set = "SDSP",
 242          .display_get = "\\INFB"},
 243
 244         {
 245          .name = "L4R",
 246          .mt_mled = "MLED",
 247          .mt_wled = "WLED",
 248          .wled_status = "\\_SB.PCI0.SBRG.SG13",
 249          .mt_lcd_switch = xxN_PREFIX "_Q10",
 250          .lcd_status = "\\_SB.PCI0.SBSM.SEO4",
 251          .brightness_set = "SPLV",
 252          .brightness_get = "GPLV",
 253          .display_set = "SDSP",
 254          .display_get = "\\_SB.PCI0.P0P1.VGA.GETD"},
 255
 256         {
 257          .name = "L5x",
 258          .mt_mled = "MLED",
 259 /* WLED present, but not controlled by ACPI */
 260          .mt_tled = "TLED",
 261          .mt_lcd_switch = "\\Q0D",
 262          .lcd_status = "\\BAOF",
 263          .brightness_set = "SPLV",
 264          .brightness_get = "GPLV",
 265          .display_set = "SDSP",
 266          .display_get = "\\INFB"},
 267
 268         {
 269          .name = "L8L"
 270 /* No features, but at least support the hotkeys */
 271          },
 272
 273         {
 274          .name = "M1A",
 275          .mt_mled = "MLED",
 276          .mt_lcd_switch = M1A_PREFIX "Q10",
 277          .lcd_status = "\\PNOF",
 278          .brightness_up = M1A_PREFIX "Q0E",
 279          .brightness_down = M1A_PREFIX "Q0F",
 280          .brightness_status = "\\BRIT",
 281          .display_set = "SDSP",
 282          .display_get = "\\INFB"},
 283
 284         {
 285          .name = "M2E",
 286          .mt_mled = "MLED",
 287          .mt_wled = "WLED",
 288          .mt_lcd_switch = "\\Q10",
 289          .lcd_status = "\\GP06",
 290          .brightness_set = "SPLV",
 291          .brightness_get = "GPLV",
 292          .display_set = "SDSP",
 293          .display_get = "\\INFB"},
 294
 295         {
 296          .name = "M6N",
 297          .mt_mled = "MLED",
 298          .mt_wled = "WLED",
 299          .wled_status = "\\_SB.PCI0.SBRG.SG13",
 300          .mt_lcd_switch = xxN_PREFIX "_Q10",
 301          .lcd_status = "\\_SB.BKLT",
 302          .brightness_set = "SPLV",
 303          .brightness_get = "GPLV",
 304          .display_set = "SDSP",
 305          .display_get = "\\_SB.PCI0.P0P1.VGA.GETD"},
 306         {
 307          .name = "M6R",
 308          .mt_mled = "MLED",
 309          .mt_wled = "WLED",
 310          .mt_lcd_switch = xxN_PREFIX "_Q10",
 311          .lcd_status = "\\_SB.PCI0.SBSM.SEO4",
 312          .brightness_set = "SPLV",
 313          .brightness_get = "GPLV",
 314          .display_set = "SDSP",
 315          .display_get = "\\SSTE"},
 316
 317         {
 318          .name = "P30",
 319          .mt_wled = "WLED",
 320          .mt_lcd_switch = P30_PREFIX "_Q0E",
 321          .lcd_status = "\\BKLT",
 322          .brightness_up = P30_PREFIX "_Q68",
 323          .brightness_down = P30_PREFIX "_Q69",
 324          .brightness_get = "GPLV",
 325          .display_set = "SDSP",
 326          .display_get = "\\DNXT"},
 327
 328         {
 329          .name = "S1x",
 330          .mt_mled = "MLED",
 331          .mled_status = "\\EMLE",
 332          .mt_wled = "WLED",
 333          .mt_lcd_switch = S1x_PREFIX "Q10",
 334          .lcd_status = "\\PNOF",
 335          .brightness_set = "SPLV",
 336          .brightness_get = "GPLV"},
 337
 338         {
 339          .name = "S2x",
 340          .mt_mled = "MLED",
 341          .mled_status = "\\MAIL",
 342          .mt_lcd_switch = S2x_PREFIX "_Q10",
 343          .lcd_status = "\\BKLI",
 344          .brightness_up = S2x_PREFIX "_Q0B",
 345          .brightness_down = S2x_PREFIX "_Q0A"},
 346
 347         {
 348          .name = "xxN",
 349          .mt_mled = "MLED",
 350 /* WLED present, but not controlled by ACPI */
 351          .mt_lcd_switch = xxN_PREFIX "_Q10",
 352          .lcd_status = "\\BKLT",
 353          .brightness_set = "SPLV",
 354          .brightness_get = "GPLV",
 355          .display_set = "SDSP",
 356          .display_get = "\\ADVG"}
 357 };
 358
 359 /* procdir we use */
 360 static struct proc_dir_entry *asus_proc_dir;
 361
 362 /*
 363  * This header is made available to allow proper configuration given model,
 364  * revision number , ... this info cannot go in struct asus_hotk because it is
 365  * available before the hotk
 366  */
 367 static struct acpi_table_header *asus_info;
 368
 369 /* The actual device the driver binds to */
 370 static struct asus_hotk *hotk;
 371
 372 /*
 373  * The hotkey driver declaration
 374  */
 375 static int asus_hotk_add(struct acpi_device *device);
 376 static int asus_hotk_remove(struct acpi_device *device, int type);
 377 static struct acpi_driver asus_hotk_driver = {
 378         .name = ACPI_HOTK_NAME,
 379         .class = ACPI_HOTK_CLASS,
 380         .ids = ACPI_HOTK_HID,
 381         .ops = {
 382                 .add = asus_hotk_add,
 383                 .remove = asus_hotk_remove,
 384                 },
 385 };
 386
 387 /*
 388  * This function evaluates an ACPI method, given an int as parameter, the
 389  * method is searched within the scope of the handle, can be NULL. The output
 390  * of the method is written is output, which can also be NULL
 391  *
 392  * returns 1 if write is successful, 0 else.
 393  */
 394 static int write_acpi_int(acpi_handle handle, const char *method, int val,
 395                           struct acpi_buffer *output)
 396 {
 397         struct acpi_object_list params; //list of input parameters (an int here)
 398         union acpi_object in_obj;       //the only param we use
 399         acpi_status status;
 400
 401         params.count = 1;
 402         params.pointer = &in_obj;
 403         in_obj.type = ACPI_TYPE_INTEGER;
 404         in_obj.integer.value = val;
 405
 406         status = acpi_evaluate_object(handle, (char *)method, &params, output);
 407         return (status == AE_OK);
 408 }
 409
 410 static int read_acpi_int(acpi_handle handle, const char *method, int *val)
 411 {
 412         struct acpi_buffer output;
 413         union acpi_object out_obj;
 414         acpi_status status;
 415
 416         output.length = sizeof(out_obj);
 417         output.pointer = &out_obj;
 418
 419         status = acpi_evaluate_object(handle, (char *)method, NULL, &output);
 420         *val = out_obj.integer.value;
 421         return (status == AE_OK) && (out_obj.type == ACPI_TYPE_INTEGER);
 422 }
 423
 424 /*
 425  * We write our info in page, we begin at offset off and cannot write more
 426  * than count bytes. We set eof to 1 if we handle those 2 values. We return the
 427  * number of bytes written in page
 428  */
 429 static int
 430 proc_read_info(char *page, char **start, off_t off, int count, int *eof,
 431                void *data)
 432 {
 433         int len = 0;
 434         int temp;
 435         char buf[16];           //enough for all info
 436         /*
 437          * We use the easy way, we don't care of off and count, so we don't set eof
 438          * to 1
 439          */
 440
 441         len += sprintf(page, ACPI_HOTK_NAME " " ASUS_ACPI_VERSION "\n");
 442         len += sprintf(page + len, "Model reference    : %s\n",
 443                        hotk->methods->name);
 444         /*
 445          * The SFUN method probably allows the original driver to get the list
 446          * of features supported by a given model. For now, 0x0100 or 0x0800
 447          * bit signifies that the laptop is equipped with a Wi-Fi MiniPCI card.
 448          * The significance of others is yet to be found.
 449          */
 450         if (read_acpi_int(hotk->handle, "SFUN", &temp))
 451                 len +=
 452                     sprintf(page + len, "SFUN value         : 0x%04x\n", temp);
 453         /*
 454          * Another value for userspace: the ASYM method returns 0x02 for
 455          * battery low and 0x04 for battery critical, its readings tend to be
 456          * more accurate than those provided by _BST.
 457          * Note: since not all the laptops provide this method, errors are
 458          * silently ignored.
 459          */
 460         if (read_acpi_int(hotk->handle, "ASYM", &temp))
 461                 len +=
 462                     sprintf(page + len, "ASYM value         : 0x%04x\n", temp);
 463         if (asus_info) {
 464                 snprintf(buf, 16, "%d", asus_info->length);
 465                 len += sprintf(page + len, "DSDT length        : %s\n", buf);
 466                 snprintf(buf, 16, "%d", asus_info->checksum);
 467                 len += sprintf(page + len, "DSDT checksum      : %s\n", buf);
 468                 snprintf(buf, 16, "%d", asus_info->revision);
 469                 len += sprintf(page + len, "DSDT revision      : %s\n", buf);
 470                 snprintf(buf, 7, "%s", asus_info->oem_id);
 471                 len += sprintf(page + len, "OEM id             : %s\n", buf);
 472                 snprintf(buf, 9, "%s", asus_info->oem_table_id);
 473                 len += sprintf(page + len, "OEM table id       : %s\n", buf);
 474                 snprintf(buf, 16, "%x", asus_info->oem_revision);
 475                 len += sprintf(page + len, "OEM revision       : 0x%s\n", buf);
 476                 snprintf(buf, 5, "%s", asus_info->asl_compiler_id);
 477                 len += sprintf(page + len, "ASL comp vendor id : %s\n", buf);
 478                 snprintf(buf, 16, "%x", asus_info->asl_compiler_revision);
 479                 len += sprintf(page + len, "ASL comp revision  : 0x%s\n", buf);
 480         }
 481
 482         return len;
 483 }
 484
 485 /*
 486  * /proc handlers
 487  * We write our info in page, we begin at offset off and cannot write more
 488  * than count bytes. We set eof to 1 if we handle those 2 values. We return the
 489  * number of bytes written in page
 490  */
 491
 492 /* Generic LED functions */
 493 static int read_led(const char *ledname, int ledmask)
 494 {
 495         if (ledname) {
 496                 int led_status;
 497
 498                 if (read_acpi_int(NULL, ledname, &led_status))
 499                         return led_status;
 500                 else
 501                         printk(KERN_WARNING "Asus ACPI: Error reading LED "
 502                                "status\n");
 503         }
 504         return (hotk->status & ledmask) ? 1 : 0;
 505 }
 506
 507 static int parse_arg(const char __user * buf, unsigned long count, int *val)
 508 {
 509         char s[32];
 510         if (!count)
 511                 return 0;
 512         if (count > 31)
 513                 return -EINVAL;
 514         if (copy_from_user(s, buf, count))
 515                 return -EFAULT;
 516         s[count] = 0;
 517         if (sscanf(s, "%i", val) != 1)
 518                 return -EINVAL;
 519         return count;
 520 }
 521
 522 /* FIXME: kill extraneous args so it can be called independently */
 523 static int
 524 write_led(const char __user * buffer, unsigned long count,
 525           char *ledname, int ledmask, int invert)
 526 {
 527         int value;
 528         int led_out = 0;
 529
 530         count = parse_arg(buffer, count, &value);
 531         if (count > 0)
 532                 led_out = value ? 1 : 0;
 533
 534         hotk->status =
 535             (led_out) ? (hotk->status | ledmask) : (hotk->status & ~ledmask);
 536
 537         if (invert)             /* invert target value */
 538                 led_out = !led_out & 0x1;
 539
 540         if (!write_acpi_int(hotk->handle, ledname, led_out, NULL))
 541                 printk(KERN_WARNING "Asus ACPI: LED (%s) write failed\n",
 542                        ledname);
 543
 544         return count;
 545 }
 546
 547 /*
 548  * Proc handlers for MLED
 549  */
 550 static int
 551 proc_read_mled(char *page, char **start, off_t off, int count, int *eof,
 552                void *data)
 553 {
 554         return sprintf(page, "%d\n",
 555                        read_led(hotk->methods->mled_status, MLED_ON));
 556 }
 557
 558 static int
 559 proc_write_mled(struct file *file, const char __user * buffer,
 560                 unsigned long count, void *data)
 561 {
 562         return write_led(buffer, count, hotk->methods->mt_mled, MLED_ON, 1);
 563 }
 564
 565 /*
 566  * Proc handlers for WLED
 567  */
 568 static int
 569 proc_read_wled(char *page, char **start, off_t off, int count, int *eof,
 570                void *data)
 571 {
 572         return sprintf(page, "%d\n",
 573                        read_led(hotk->methods->wled_status, WLED_ON));
 574 }
 575
 576 static int
 577 proc_write_wled(struct file *file, const char __user * buffer,
 578                 unsigned long count, void *data)
 579 {
 580         return write_led(buffer, count, hotk->methods->mt_wled, WLED_ON, 0);
 581 }
 582
 583 /*
 584  * Proc handlers for TLED
 585  */
 586 static int
 587 proc_read_tled(char *page, char **start, off_t off, int count, int *eof,
 588                void *data)
 589 {
 590         return sprintf(page, "%d\n",
 591                        read_led(hotk->methods->tled_status, TLED_ON));
 592 }
 593
 594 static int
 595 proc_write_tled(struct file *file, const char __user * buffer,
 596                 unsigned long count, void *data)
 597 {
 598         return write_led(buffer, count, hotk->methods->mt_tled, TLED_ON, 0);
 599 }
 600
 601 static int get_lcd_state(void)
 602 {
 603         int lcd = 0;
 604
 605         if (hotk->model != L3H) {
 606                 /* We don't have to check anything if we are here */
 607                 if (!read_acpi_int(NULL, hotk->methods->lcd_status, &lcd))
 608                         printk(KERN_WARNING
 609                                "Asus ACPI: Error reading LCD status\n");
 610
 611                 if (hotk->model == L2D)
 612                         lcd = ~lcd;
 613         } else {                /* L3H and the like have to be handled differently */
 614                 acpi_status status = 0;
 615                 struct acpi_object_list input;
 616                 union acpi_object mt_params[2];
 617                 struct acpi_buffer output;
 618                 union acpi_object out_obj;
 619
 620                 input.count = 2;
 621                 input.pointer = mt_params;
 622                 /* Note: the following values are partly guessed up, but
 623                    otherwise they seem to work */
 624                 mt_params[0].type = ACPI_TYPE_INTEGER;
 625                 mt_params[0].integer.value = 0x02;
 626                 mt_params[1].type = ACPI_TYPE_INTEGER;
 627                 mt_params[1].integer.value = 0x02;
 628
 629                 output.length = sizeof(out_obj);
 630                 output.pointer = &out_obj;
 631
 632                 status =
 633                     acpi_evaluate_object(NULL, hotk->methods->lcd_status,
 634                                          &input, &output);
 635                 if (status != AE_OK)
 636                         return -1;
 637                 if (out_obj.type == ACPI_TYPE_INTEGER)
 638                         /* That's what the AML code does */
 639                         lcd = out_obj.integer.value >> 8;
 640         }
 641
 642         return (lcd & 1);
 643 }
 644
 645 static int set_lcd_state(int value)
 646 {
 647         int lcd = 0;
 648         acpi_status status = 0;
 649
 650         lcd = value ? 1 : 0;
 651         if (lcd != get_lcd_state()) {
 652                 /* switch */
 653                 if (hotk->model != L3H) {
 654                         status =
 655                             acpi_evaluate_object(NULL,
 656                                                  hotk->methods->mt_lcd_switch,
 657                                                  NULL, NULL);
 658                 } else {        /* L3H and the like have to be handled differently */
 659                         if (!write_acpi_int
 660                             (hotk->handle, hotk->methods->mt_lcd_switch, 0x07,
 661                              NULL))
 662                                 status = AE_ERROR;
 663                         /* L3H's AML executes EHK (0x07) upon Fn+F7 keypress,
 664                            the exact behaviour is simulated here */
 665                 }
 666                 if (ACPI_FAILURE(status))
 667                         printk(KERN_WARNING "Asus ACPI: Error switching LCD\n");
 668         }
 669         return 0;
 670
 671 }
 672
 673 static int
 674 proc_read_lcd(char *page, char **start, off_t off, int count, int *eof,
 675               void *data)
 676 {
 677         return sprintf(page, "%d\n", get_lcd_state());
 678 }
 679
 680 static int
 681 proc_write_lcd(struct file *file, const char __user * buffer,
 682                unsigned long count, void *data)
 683 {
 684         int value;
 685
 686         count = parse_arg(buffer, count, &value);
 687         if (count > 0)
 688                 set_lcd_state(value);
 689         return count;
 690 }
 691
 692 static int read_brightness(void)
 693 {
 694         int value;
 695
 696         if (hotk->methods->brightness_get) {    /* SPLV/GPLV laptop */
 697                 if (!read_acpi_int(hotk->handle, hotk->methods->brightness_get,
 698                                    &value))
 699                         printk(KERN_WARNING
 700                                "Asus ACPI: Error reading brightness\n");
 701         } else if (hotk->methods->brightness_status) {  /* For D1 for example */
 702                 if (!read_acpi_int(NULL, hotk->methods->brightness_status,
 703                                    &value))
 704                         printk(KERN_WARNING
 705                                "Asus ACPI: Error reading brightness\n");
 706         } else                  /* No GPLV method */
 707                 value = hotk->brightness;
 708         return value;
 709 }
 710
 711 /*
 712  * Change the brightness level
 713  */
 714 static void set_brightness(int value)
 715 {
 716         acpi_status status = 0;
 717
 718         /* SPLV laptop */
 719         if (hotk->methods->brightness_set) {
 720                 if (!write_acpi_int(hotk->handle, hotk->methods->brightness_set,
 721                                     value, NULL))
 722                         printk(KERN_WARNING
 723                                "Asus ACPI: Error changing brightness\n");
 724                 return;
 725         }
 726
 727         /* No SPLV method if we are here, act as appropriate */
 728         value -= read_brightness();
 729         while (value != 0) {
 730                 status = acpi_evaluate_object(NULL, (value > 0) ?
 731                                               hotk->methods->brightness_up :
 732                                               hotk->methods->brightness_down,
 733                                               NULL, NULL);
 734                 (value > 0) ? value-- : value++;
 735                 if (ACPI_FAILURE(status))
 736                         printk(KERN_WARNING
 737                                "Asus ACPI: Error changing brightness\n");
 738         }
 739         return;
 740 }
 741
 742 static int
 743 proc_read_brn(char *page, char **start, off_t off, int count, int *eof,
 744               void *data)
 745 {
 746         return sprintf(page, "%d\n", read_brightness());
 747 }
 748
 749 static int
 750 proc_write_brn(struct file *file, const char __user * buffer,
 751                unsigned long count, void *data)
 752 {
 753         int value;
 754
 755         count = parse_arg(buffer, count, &value);
 756         if (count > 0) {
 757                 value = (0 < value) ? ((15 < value) ? 15 : value) : 0;
 758                 /* 0 <= value <= 15 */
 759                 set_brightness(value);
 760         } else if (count < 0) {
 761                 printk(KERN_WARNING "Asus ACPI: Error reading user input\n");
 762         }
 763
 764         return count;
 765 }
 766
 767 static void set_display(int value)
 768 {
 769         /* no sanity check needed for now */
 770         if (!write_acpi_int(hotk->handle, hotk->methods->display_set,
 771                             value, NULL))
 772                 printk(KERN_WARNING "Asus ACPI: Error setting display\n");
 773         return;
 774 }
 775
 776 /*
 777  * Now, *this* one could be more user-friendly, but so far, no-one has
 778  * complained. The significance of bits is the same as in proc_write_disp()
 779  */
 780 static int
 781 proc_read_disp(char *page, char **start, off_t off, int count, int *eof,
 782                void *data)
 783 {
 784         int value = 0;
 785
 786         if (!read_acpi_int(hotk->handle, hotk->methods->display_get, &value))
 787                 printk(KERN_WARNING
 788                        "Asus ACPI: Error reading display status\n");
 789         value &= 0x07;          /* needed for some models, shouldn't hurt others */
 790         return sprintf(page, "%d\n", value);
 791 }
 792
 793 /*
 794  * Experimental support for display switching. As of now: 1 should activate
 795  * the LCD output, 2 should do for CRT, and 4 for TV-Out. Any combination
 796  * (bitwise) of these will suffice. I never actually tested 3 displays hooked up
 797  * simultaneously, so be warned. See the acpi4asus README for more info.
 798  */
 799 static int
 800 proc_write_disp(struct file *file, const char __user * buffer,
 801                 unsigned long count, void *data)
 802 {
 803         int value;
 804
 805         count = parse_arg(buffer, count, &value);
 806         if (count > 0)
 807                 set_display(value);
 808         else if (count < 0)
 809                 printk(KERN_WARNING "Asus ACPI: Error reading user input\n");
 810
 811         return count;
 812 }
 813
 814 typedef int (proc_readfunc) (char *page, char **start, off_t off, int count,
 815                              int *eof, void *data);
 816 typedef int (proc_writefunc) (struct file * file, const char __user * buffer,
 817                               unsigned long count, void *data);
 818
 819 static int
 820 __init asus_proc_add(char *name, proc_writefunc * writefunc,
 821                      proc_readfunc * readfunc, mode_t mode,
 822                      struct acpi_device *device)
 823 {
 824         struct proc_dir_entry *proc =
 825             create_proc_entry(name, mode, acpi_device_dir(device));
 826         if (!proc) {
 827                 printk(KERN_WARNING "  Unable to create %s fs entry\n", name);
 828                 return -1;
 829         }
 830         proc->write_proc = writefunc;
 831         proc->read_proc = readfunc;
 832         proc->data = acpi_driver_data(device);
 833         proc->owner = THIS_MODULE;
 834         proc->uid = asus_uid;
 835         proc->gid = asus_gid;
 836         return 0;
 837 }
 838
 839 static int __init asus_hotk_add_fs(struct acpi_device *device)
 840 {
 841         struct proc_dir_entry *proc;
 842         mode_t mode;
 843
 844         /*
 845          * If parameter uid or gid is not changed, keep the default setting for
 846          * our proc entries (-rw-rw-rw-) else, it means we care about security,
 847          * and then set to -rw-rw----
 848          */
 849
 850         if ((asus_uid == 0) && (asus_gid == 0)) {
 851                 mode = S_IFREG | S_IRUGO | S_IWUGO;
 852         } else {
 853                 mode = S_IFREG | S_IRUSR | S_IRGRP | S_IWUSR | S_IWGRP;
 854                 printk(KERN_WARNING "  asus_uid and asus_gid parameters are "
 855                        "deprecated, use chown and chmod instead!\n");
 856         }
 857
 858         acpi_device_dir(device) = asus_proc_dir;
 859         if (!acpi_device_dir(device))
 860                 return -ENODEV;
 861
 862         proc = create_proc_entry(PROC_INFO, mode, acpi_device_dir(device));
 863         if (proc) {
 864                 proc->read_proc = proc_read_info;
 865                 proc->data = acpi_driver_data(device);
 866                 proc->owner = THIS_MODULE;
 867                 proc->uid = asus_uid;
 868                 proc->gid = asus_gid;
 869         } else {
 870                 printk(KERN_WARNING "  Unable to create " PROC_INFO
 871                        " fs entry\n");
 872         }
 873
 874         if (hotk->methods->mt_wled) {
 875                 asus_proc_add(PROC_WLED, &proc_write_wled, &proc_read_wled,
 876                               mode, device);
 877         }
 878
 879         if (hotk->methods->mt_mled) {
 880                 asus_proc_add(PROC_MLED, &proc_write_mled, &proc_read_mled,
 881                               mode, device);
 882         }
 883
 884         if (hotk->methods->mt_tled) {
 885                 asus_proc_add(PROC_TLED, &proc_write_tled, &proc_read_tled,
 886                               mode, device);
 887         }
 888
 889         /*
 890          * We need both read node and write method as LCD switch is also accessible
 891          * from keyboard
 892          */
 893         if (hotk->methods->mt_lcd_switch && hotk->methods->lcd_status) {
 894                 asus_proc_add(PROC_LCD, &proc_write_lcd, &proc_read_lcd, mode,
 895                               device);
 896         }
 897
 898         if ((hotk->methods->brightness_up && hotk->methods->brightness_down) ||
 899             (hotk->methods->brightness_get && hotk->methods->brightness_set)) {
 900                 asus_proc_add(PROC_BRN, &proc_write_brn, &proc_read_brn, mode,
 901                               device);
 902         }
 903
 904         if (hotk->methods->display_set) {
 905                 asus_proc_add(PROC_DISP, &proc_write_disp, &proc_read_disp,
 906                               mode, device);
 907         }
 908
 909         return 0;
 910 }
 911
 912 static int asus_hotk_remove_fs(struct acpi_device *device)
 913 {
 914         if (acpi_device_dir(device)) {
 915                 remove_proc_entry(PROC_INFO, acpi_device_dir(device));
 916                 if (hotk->methods->mt_wled)
 917                         remove_proc_entry(PROC_WLED, acpi_device_dir(device));
 918                 if (hotk->methods->mt_mled)
 919                         remove_proc_entry(PROC_MLED, acpi_device_dir(device));
 920                 if (hotk->methods->mt_tled)
 921                         remove_proc_entry(PROC_TLED, acpi_device_dir(device));
 922                 if (hotk->methods->mt_lcd_switch && hotk->methods->lcd_status)
 923                         remove_proc_entry(PROC_LCD, acpi_device_dir(device));
 924                 if ((hotk->methods->brightness_up
 925                      && hotk->methods->brightness_down)
 926                     || (hotk->methods->brightness_get
 927                         && hotk->methods->brightness_set))
 928                         remove_proc_entry(PROC_BRN, acpi_device_dir(device));
 929                 if (hotk->methods->display_set)
 930                         remove_proc_entry(PROC_DISP, acpi_device_dir(device));
 931         }
 932         return 0;
 933 }
 934
 935 static void asus_hotk_notify(acpi_handle handle, u32 event, void *data)
 936 {
 937         /* TODO Find a better way to handle events count. */
 938         if (!hotk)
 939                 return;
 940
 941         if ((event & ~((u32) BR_UP)) < 16) {
 942                 hotk->brightness = (event & ~((u32) BR_UP));
 943         } else if ((event & ~((u32) BR_DOWN)) < 16) {
 944                 hotk->brightness = (event & ~((u32) BR_DOWN));
 945         }
 946
 947         acpi_bus_generate_event(hotk->device, event,
 948                                 hotk->event_count[event % 128]++);
 949
 950         return;
 951 }
 952
 953 /*
 954  * This function is used to initialize the hotk with right values. In this
 955  * method, we can make all the detection we want, and modify the hotk struct
 956  */
 957 static int __init asus_hotk_get_info(void)
 958 {
 959         struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
 960         struct acpi_buffer dsdt = { ACPI_ALLOCATE_BUFFER, NULL };
 961         union acpi_object *model = NULL;
 962         int bsts_result;
 963         acpi_status status;
 964
 965         /*
 966          * Get DSDT headers early enough to allow for differentiating between
 967          * models, but late enough to allow acpi_bus_register_driver() to fail
 968          * before doing anything ACPI-specific. Should we encounter a machine,
 969          * which needs special handling (i.e. its hotkey device has a different
 970          * HID), this bit will be moved. A global variable asus_info contains
 971          * the DSDT header.
 972          */
 973         status = acpi_get_table(ACPI_TABLE_DSDT, 1, &dsdt);
 974         if (ACPI_FAILURE(status))
 975                 printk(KERN_WARNING "  Couldn't get the DSDT table header\n");
 976         else
 977                 asus_info = (struct acpi_table_header *)dsdt.pointer;
 978
 979         /* We have to write 0 on init this far for all ASUS models */
 980         if (!write_acpi_int(hotk->handle, "INIT", 0, &buffer)) {
 981                 printk(KERN_ERR "  Hotkey initialization failed\n");
 982                 return -ENODEV;
 983         }
 984
 985         /* This needs to be called for some laptops to init properly */
 986         if (!read_acpi_int(hotk->handle, "BSTS", &bsts_result))
 987                 printk(KERN_WARNING "  Error calling BSTS\n");
 988         else if (bsts_result)
 989                 printk(KERN_NOTICE "  BSTS called, 0x%02x returned\n",
 990                        bsts_result);
 991
 992         /* This is unlikely with implicit return */
 993         if (buffer.pointer == NULL)
 994                 return -EINVAL;
 995
 996         model = (union acpi_object *) buffer.pointer;
 997         /*
 998          * Samsung P30 has a device with a valid _HID whose INIT does not
 999          * return anything. It used to be possible to catch this exception,
1000          * but the implicit return code will now happily confuse the
1001          * driver. We assume that every ACPI_TYPE_STRING is a valid model
1002          * identifier but it's still possible to get completely bogus data.
1003          */
1004         if (model->type == ACPI_TYPE_STRING) {
1005                 printk(KERN_NOTICE "  %s model detected, ", model->string.pointer);
1006         } else {
1007                 if (asus_info &&        /* Samsung P30 */
1008                     strncmp(asus_info->oem_table_id, "ODEM", 4) == 0) {
1009                         hotk->model = P30;
1010                         printk(KERN_NOTICE
1011                                "  Samsung P30 detected, supported\n");
1012                 } else {
1013                         hotk->model = M2E;
1014                         printk(KERN_WARNING "  no string returned by INIT\n");
1015                         printk(KERN_WARNING "  trying default values, supply "
1016                                "the developers with your DSDT\n");
1017                 }
1018                 hotk->methods = &model_conf[hotk->model];
1019
1020                 acpi_os_free(model);
1021
1022                 return AE_OK;
1023         }
1024
1025         hotk->model = END_MODEL;
1026         if (strncmp(model->string.pointer, "L3D", 3) == 0)
1027                 hotk->model = L3D;
1028         else if (strncmp(model->string.pointer, "L3H", 3) == 0 ||
1029                  strncmp(model->string.pointer, "L2E", 3) == 0)
1030                 hotk->model = L3H;
1031         else if (strncmp(model->string.pointer, "L3", 2) == 0 ||
1032                  strncmp(model->string.pointer, "L2B", 3) == 0)
1033                 hotk->model = L3C;
1034         else if (strncmp(model->string.pointer, "L8L", 3) == 0)
1035                 hotk->model = L8L;
1036         else if (strncmp(model->string.pointer, "L4R", 3) == 0)
1037                 hotk->model = L4R;
1038         else if (strncmp(model->string.pointer, "M6N", 3) == 0)
1039                 hotk->model = M6N;
1040         else if (strncmp(model->string.pointer, "M6R", 3) == 0)
1041                 hotk->model = M6R;
1042         else if (strncmp(model->string.pointer, "M2N", 3) == 0 ||
1043                  strncmp(model->string.pointer, "M3N", 3) == 0 ||
1044                  strncmp(model->string.pointer, "M5N", 3) == 0 ||
1045                  strncmp(model->string.pointer, "M6N", 3) == 0 ||
1046                  strncmp(model->string.pointer, "S1N", 3) == 0 ||
1047                  strncmp(model->string.pointer, "S5N", 3) == 0 ||
1048                  strncmp(model->string.pointer, "W1N", 3) == 0)
1049                 hotk->model = xxN;
1050         else if (strncmp(model->string.pointer, "M1", 2) == 0)
1051                 hotk->model = M1A;
1052         else if (strncmp(model->string.pointer, "M2", 2) == 0 ||
1053                  strncmp(model->string.pointer, "L4E", 3) == 0)
1054                 hotk->model = M2E;
1055         else if (strncmp(model->string.pointer, "L2", 2) == 0)
1056                 hotk->model = L2D;
1057         else if (strncmp(model->string.pointer, "L8", 2) == 0)
1058                 hotk->model = S1x;
1059         else if (strncmp(model->string.pointer, "D1", 2) == 0)
1060                 hotk->model = D1x;
1061         else if (strncmp(model->string.pointer, "A1", 2) == 0)
1062                 hotk->model = A1x;
1063         else if (strncmp(model->string.pointer, "A2", 2) == 0)
1064                 hotk->model = A2x;
1065         else if (strncmp(model->string.pointer, "J1", 2) == 0)
1066                 hotk->model = S2x;
1067         else if (strncmp(model->string.pointer, "L5", 2) == 0)
1068                 hotk->model = L5x;
1069
1070         if (hotk->model == END_MODEL) {
1071                 printk("unsupported, trying default values, supply the "
1072                        "developers with your DSDT\n");
1073                 hotk->model = M2E;
1074         } else {
1075                 printk("supported\n");
1076         }
1077
1078         hotk->methods = &model_conf[hotk->model];
1079
1080         /* Sort of per-model blacklist */
1081         if (strncmp(model->string.pointer, "L2B", 3) == 0)
1082                 hotk->methods->lcd_status = NULL;
1083         /* L2B is similar enough to L3C to use its settings, with this only
1084            exception */
1085         else if (strncmp(model->string.pointer, "S5N", 3) == 0 ||
1086                  strncmp(model->string.pointer, "M5N", 3) == 0)
1087                 hotk->methods->mt_mled = NULL;
1088         /* S5N and M5N have no MLED */
1089         else if (strncmp(model->string.pointer, "M2N", 3) == 0 ||
1090                  strncmp(model->string.pointer, "W1N", 3) == 0)
1091                 hotk->methods->mt_wled = "WLED";
1092         /* M2N and W1N have a usable WLED */
1093         else if (asus_info) {
1094                 if (strncmp(asus_info->oem_table_id, "L1", 2) == 0)
1095                         hotk->methods->mled_status = NULL;
1096                 /* S1300A reports L84F, but L1400B too, account for that */
1097         }
1098
1099         acpi_os_free(model);
1100
1101         return AE_OK;
1102 }
1103
1104 static int __init asus_hotk_check(void)
1105 {
1106         int result = 0;
1107
1108         result = acpi_bus_get_status(hotk->device);
1109         if (result)
1110                 return result;
1111
1112         if (hotk->device->status.present) {
1113                 result = asus_hotk_get_info();
1114         } else {
1115                 printk(KERN_ERR "  Hotkey device not present, aborting\n");
1116                 return -EINVAL;
1117         }
1118
1119         return result;
1120 }
1121
1122 static int __init asus_hotk_add(struct acpi_device *device)
1123 {
1124         acpi_status status = AE_OK;
1125         int result;
1126
1127         if (!device)
1128                 return -EINVAL;
1129
1130         printk(KERN_NOTICE "Asus Laptop ACPI Extras version %s\n",
1131                ASUS_ACPI_VERSION);
1132
1133         hotk =
1134             (struct asus_hotk *)kmalloc(sizeof(struct asus_hotk), GFP_KERNEL);
1135         if (!hotk)
1136                 return -ENOMEM;
1137         memset(hotk, 0, sizeof(struct asus_hotk));
1138
1139         hotk->handle = device->handle;
1140         strcpy(acpi_device_name(device), ACPI_HOTK_DEVICE_NAME);
1141         strcpy(acpi_device_class(device), ACPI_HOTK_CLASS);
1142         acpi_driver_data(device) = hotk;
1143         hotk->device = device;
1144
1145         result = asus_hotk_check();
1146         if (result)
1147                 goto end;
1148
1149         result = asus_hotk_add_fs(device);
1150         if (result)
1151                 goto end;
1152
1153         /*
1154          * We install the handler, it will receive the hotk in parameter, so, we
1155          * could add other data to the hotk struct
1156          */
1157         status = acpi_install_notify_handler(hotk->handle, ACPI_SYSTEM_NOTIFY,
1158                                              asus_hotk_notify, hotk);
1159         if (ACPI_FAILURE(status))
1160                 printk(KERN_ERR "  Error installing notify handler\n");
1161
1162         /* For laptops without GPLV: init the hotk->brightness value */
1163         if ((!hotk->methods->brightness_get)
1164             && (!hotk->methods->brightness_status)
1165             && (hotk->methods->brightness_up
1166                 && hotk->methods->brightness_down)) {
1167                 status =
1168                     acpi_evaluate_object(NULL, hotk->methods->brightness_down,
1169                                          NULL, NULL);
1170                 if (ACPI_FAILURE(status))
1171                         printk(KERN_WARNING "  Error changing brightness\n");
1172                 else {
1173                         status =
1174                             acpi_evaluate_object(NULL,
1175                                                  hotk->methods->brightness_up,
1176                                                  NULL, NULL);
1177                         if (ACPI_FAILURE(status))
1178                                 printk(KERN_WARNING "  Strange, error changing"
1179                                        " brightness\n");
1180                 }
1181         }
1182
1183       end:
1184         if (result) {
1185                 kfree(hotk);
1186         }
1187
1188         return result;
1189 }
1190
1191 static int asus_hotk_remove(struct acpi_device *device, int type)
1192 {
1193         acpi_status status = 0;
1194
1195         if (!device || !acpi_driver_data(device))
1196                 return -EINVAL;
1197
1198         status = acpi_remove_notify_handler(hotk->handle, ACPI_SYSTEM_NOTIFY,
1199                                             asus_hotk_notify);
1200         if (ACPI_FAILURE(status))
1201                 printk(KERN_ERR "Asus ACPI: Error removing notify handler\n");
1202
1203         asus_hotk_remove_fs(device);
1204
1205         kfree(hotk);
1206
1207         return 0;
1208 }
1209
1210 static int __init asus_acpi_init(void)
1211 {
1212         int result;
1213
1214         if (acpi_disabled)
1215                 return -ENODEV;
1216
1217         if (!acpi_specific_hotkey_enabled) {
1218                 printk(KERN_ERR "Using generic hotkey driver\n");
1219                 return -ENODEV;
1220         }
1221         asus_proc_dir = proc_mkdir(PROC_ASUS, acpi_root_dir);
1222         if (!asus_proc_dir) {
1223                 printk(KERN_ERR "Asus ACPI: Unable to create /proc entry\n");
1224                 return -ENODEV;
1225         }
1226         asus_proc_dir->owner = THIS_MODULE;
1227
1228         result = acpi_bus_register_driver(&asus_hotk_driver);
1229         if (result < 1) {
1230                 acpi_bus_unregister_driver(&asus_hotk_driver);
1231                 remove_proc_entry(PROC_ASUS, acpi_root_dir);
1232                 return -ENODEV;
1233         }
1234
1235         return 0;
1236 }
1237
1238 static void __exit asus_acpi_exit(void)
1239 {
1240         acpi_bus_unregister_driver(&asus_hotk_driver);
1241         remove_proc_entry(PROC_ASUS, acpi_root_dir);
1242
1243         acpi_os_free(asus_info);
1244
1245         return;
1246 }
1247
1248 module_init(asus_acpi_init);
1249 module_exit(asus_acpi_exit);