2 * asus_acpi.c - Asus Laptop ACPI Extras
5 * Copyright (C) 2002-2005 Julien Lerouge, 2003-2006 Karol Kozimor
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.
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.
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
22 * The development page for this driver is located at
23 * http://sourceforge.net/projects/acpi4asus/
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 * Éric Burghard - LED display support for W1N
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/init.h>
36 #include <linux/types.h>
37 #include <linux/proc_fs.h>
38 #include <acpi/acpi_drivers.h>
39 #include <acpi/acpi_bus.h>
40 #include <asm/uaccess.h>
42 #define ASUS_ACPI_VERSION "0.30"
44 #define PROC_ASUS "asus" //the directory
45 #define PROC_MLED "mled"
46 #define PROC_WLED "wled"
47 #define PROC_TLED "tled"
48 #define PROC_BT "bluetooth"
49 #define PROC_LEDD "ledd"
50 #define PROC_INFO "info"
51 #define PROC_LCD "lcd"
52 #define PROC_BRN "brn"
53 #define PROC_DISP "disp"
55 #define ACPI_HOTK_NAME "Asus Laptop ACPI Extras Driver"
56 #define ACPI_HOTK_CLASS "hotkey"
57 #define ACPI_HOTK_DEVICE_NAME "Hotkey"
58 #define ACPI_HOTK_HID "ATK0100"
61 * Some events we use, same for all Asus
67 * Flags for hotk status
69 #define MLED_ON 0x01 //mail LED
70 #define WLED_ON 0x02 //wireless LED
71 #define TLED_ON 0x04 //touchpad LED
72 #define BT_ON 0x08 //internal Bluetooth
74 MODULE_AUTHOR("Julien Lerouge, Karol Kozimor");
75 MODULE_DESCRIPTION(ACPI_HOTK_NAME);
76 MODULE_LICENSE("GPL");
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");
85 /* For each model, all features implemented,
86 * those marked with R are relative to HOTK, A for absolute */
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_ledd; //method to handle LED display______R
96 char *mt_bt_switch; //method to switch Bluetooth on/off_R
97 char *bt_status; //no model currently supports this__?
98 char *mt_lcd_switch; //method to turn LCD on/off_________A
99 char *lcd_status; //node to read LCD panel state______A
100 char *brightness_up; //method to set brightness up_______A
101 char *brightness_down; //guess what ?______________________A
102 char *brightness_set; //method to set absolute brightness_R
103 char *brightness_get; //method to get absolute brightness_R
104 char *brightness_status; //node to get brightness____________A
105 char *display_set; //method to set video output________R
106 char *display_get; //method to get video output________R
110 * This is the main structure, we can use it to store anything interesting
111 * about the hotk device
114 struct acpi_device *device; //the device we are in
115 acpi_handle handle; //the handle of the hotk device
116 char status; //status of the hotk, for LEDs, ...
117 u32 ledd_status; //status of the LED display
118 struct model_data *methods; //methods available on the laptop
119 u8 brightness; //brightness level
121 A1x = 0, //A1340D, A1300F
128 L3H, //L3H, L2000E, L5D
133 M2E, //M2400E, L4400L
134 M6N, //M6800N, W3400N
135 M6R, //M6700R, A3000G
137 S1x, //S1300A, but also L1400B and M2400A (L84F)
138 S2x, //S200 (J1 reported), Victor MP-XP7210
142 xxN, //M2400N, M3700N, M5200N, M6800N, S1300N, S5200N
145 } model; //Models currently supported
146 u16 event_count[128]; //count for each event TODO make this better
150 #define A1x_PREFIX "\\_SB.PCI0.ISA.EC0."
151 #define L3C_PREFIX "\\_SB.PCI0.PX40.ECD0."
152 #define M1A_PREFIX "\\_SB.PCI0.PX40.EC0."
153 #define P30_PREFIX "\\_SB.PCI0.LPCB.EC0."
154 #define S1x_PREFIX "\\_SB.PCI0.PX40."
155 #define S2x_PREFIX A1x_PREFIX
156 #define xxN_PREFIX "\\_SB.PCI0.SBRG.EC0."
158 static struct model_data model_conf[END_MODEL] = {
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 ?
167 .mled_status = "\\MAIL",
168 .mt_lcd_switch = A1x_PREFIX "_Q10",
169 .lcd_status = "\\BKLI",
170 .brightness_up = A1x_PREFIX "_Q0E",
171 .brightness_down = A1x_PREFIX "_Q0F"},
177 .wled_status = "\\SG66",
178 .mt_lcd_switch = "\\Q10",
179 .lcd_status = "\\BAOF",
180 .brightness_set = "SPLV",
181 .brightness_get = "GPLV",
182 .display_set = "SDSP",
183 .display_get = "\\INFB"},
188 /* WLED present, but not controlled by ACPI */
189 .mt_lcd_switch = xxN_PREFIX "_Q10",
190 .brightness_set = "SPLV",
191 .brightness_get = "GPLV",
192 .display_set = "SDSP",
193 .display_get = "\\ADVG"},
198 .mt_lcd_switch = "\\Q0D",
199 .lcd_status = "\\GP11",
200 .brightness_up = "\\Q0C",
201 .brightness_down = "\\Q0B",
202 .brightness_status = "\\BLVL",
203 .display_set = "SDSP",
204 .display_get = "\\INFB"},
209 .mled_status = "\\SGP6",
211 .wled_status = "\\RCP3",
212 .mt_lcd_switch = "\\Q10",
213 .lcd_status = "\\SGP0",
214 .brightness_up = "\\Q0E",
215 .brightness_down = "\\Q0F",
216 .display_set = "SDSP",
217 .display_get = "\\INFB"},
223 .mt_lcd_switch = L3C_PREFIX "_Q10",
224 .lcd_status = "\\GL32",
225 .brightness_set = "SPLV",
226 .brightness_get = "GPLV",
227 .display_set = "SDSP",
228 .display_get = "\\_SB.PCI0.PCI1.VGAC.NMAP"},
233 .mled_status = "\\MALD",
235 .mt_lcd_switch = "\\Q10",
236 .lcd_status = "\\BKLG",
237 .brightness_set = "SPLV",
238 .brightness_get = "GPLV",
239 .display_set = "SDSP",
240 .display_get = "\\INFB"},
246 .mt_lcd_switch = "EHK",
247 .lcd_status = "\\_SB.PCI0.PM.PBC",
248 .brightness_set = "SPLV",
249 .brightness_get = "GPLV",
250 .display_set = "SDSP",
251 .display_get = "\\INFB"},
257 .wled_status = "\\_SB.PCI0.SBRG.SG13",
258 .mt_lcd_switch = xxN_PREFIX "_Q10",
259 .lcd_status = "\\_SB.PCI0.SBSM.SEO4",
260 .brightness_set = "SPLV",
261 .brightness_get = "GPLV",
262 .display_set = "SDSP",
263 .display_get = "\\_SB.PCI0.P0P1.VGA.GETD"},
268 /* WLED present, but not controlled by ACPI */
270 .mt_lcd_switch = "\\Q0D",
271 .lcd_status = "\\BAOF",
272 .brightness_set = "SPLV",
273 .brightness_get = "GPLV",
274 .display_set = "SDSP",
275 .display_get = "\\INFB"},
279 /* No features, but at least support the hotkeys */
285 .mt_lcd_switch = M1A_PREFIX "Q10",
286 .lcd_status = "\\PNOF",
287 .brightness_up = M1A_PREFIX "Q0E",
288 .brightness_down = M1A_PREFIX "Q0F",
289 .brightness_status = "\\BRIT",
290 .display_set = "SDSP",
291 .display_get = "\\INFB"},
297 .mt_lcd_switch = "\\Q10",
298 .lcd_status = "\\GP06",
299 .brightness_set = "SPLV",
300 .brightness_get = "GPLV",
301 .display_set = "SDSP",
302 .display_get = "\\INFB"},
308 .wled_status = "\\_SB.PCI0.SBRG.SG13",
309 .mt_lcd_switch = xxN_PREFIX "_Q10",
310 .lcd_status = "\\_SB.BKLT",
311 .brightness_set = "SPLV",
312 .brightness_get = "GPLV",
313 .display_set = "SDSP",
314 .display_get = "\\SSTE"},
320 .mt_lcd_switch = xxN_PREFIX "_Q10",
321 .lcd_status = "\\_SB.PCI0.SBSM.SEO4",
322 .brightness_set = "SPLV",
323 .brightness_get = "GPLV",
324 .display_set = "SDSP",
325 .display_get = "\\_SB.PCI0.P0P1.VGA.GETD"},
330 .mt_lcd_switch = P30_PREFIX "_Q0E",
331 .lcd_status = "\\BKLT",
332 .brightness_up = P30_PREFIX "_Q68",
333 .brightness_down = P30_PREFIX "_Q69",
334 .brightness_get = "GPLV",
335 .display_set = "SDSP",
336 .display_get = "\\DNXT"},
341 .mled_status = "\\EMLE",
343 .mt_lcd_switch = S1x_PREFIX "Q10",
344 .lcd_status = "\\PNOF",
345 .brightness_set = "SPLV",
346 .brightness_get = "GPLV"},
351 .mled_status = "\\MAIL",
352 .mt_lcd_switch = S2x_PREFIX "_Q10",
353 .lcd_status = "\\BKLI",
354 .brightness_up = S2x_PREFIX "_Q0B",
355 .brightness_down = S2x_PREFIX "_Q0A"},
362 .mt_lcd_switch = xxN_PREFIX "_Q10",
363 .lcd_status = "\\BKLT",
364 .brightness_set = "SPLV",
365 .brightness_get = "GPLV",
366 .display_set = "SDSP",
367 .display_get = "\\ADVG"},
371 .mt_bt_switch = "BLED",
373 .mt_lcd_switch = xxN_PREFIX "_Q10",
374 .brightness_set = "SPLV",
375 .brightness_get = "GPLV",
376 .display_set = "SDSP",
377 .display_get = "\\ADVG"},
383 .mt_lcd_switch = xxN_PREFIX "_Q10",
384 .lcd_status = "\\BKLT",
385 .brightness_set = "SPLV",
386 .brightness_get = "GPLV",
387 .display_set = "SDSP",
388 .display_get = "\\INFB"},
393 /* WLED present, but not controlled by ACPI */
394 .mt_lcd_switch = xxN_PREFIX "_Q10",
395 .lcd_status = "\\BKLT",
396 .brightness_set = "SPLV",
397 .brightness_get = "GPLV",
398 .display_set = "SDSP",
399 .display_get = "\\ADVG"}
403 static struct proc_dir_entry *asus_proc_dir;
406 * This header is made available to allow proper configuration given model,
407 * revision number , ... this info cannot go in struct asus_hotk because it is
408 * available before the hotk
410 static struct acpi_table_header *asus_info;
412 /* The actual device the driver binds to */
413 static struct asus_hotk *hotk;
416 * The hotkey driver declaration
418 static int asus_hotk_add(struct acpi_device *device);
419 static int asus_hotk_remove(struct acpi_device *device, int type);
420 static struct acpi_driver asus_hotk_driver = {
421 .name = ACPI_HOTK_NAME,
422 .class = ACPI_HOTK_CLASS,
423 .ids = ACPI_HOTK_HID,
425 .add = asus_hotk_add,
426 .remove = asus_hotk_remove,
431 * This function evaluates an ACPI method, given an int as parameter, the
432 * method is searched within the scope of the handle, can be NULL. The output
433 * of the method is written is output, which can also be NULL
435 * returns 1 if write is successful, 0 else.
437 static int write_acpi_int(acpi_handle handle, const char *method, int val,
438 struct acpi_buffer *output)
440 struct acpi_object_list params; //list of input parameters (an int here)
441 union acpi_object in_obj; //the only param we use
445 params.pointer = &in_obj;
446 in_obj.type = ACPI_TYPE_INTEGER;
447 in_obj.integer.value = val;
449 status = acpi_evaluate_object(handle, (char *)method, ¶ms, output);
450 return (status == AE_OK);
453 static int read_acpi_int(acpi_handle handle, const char *method, int *val)
455 struct acpi_buffer output;
456 union acpi_object out_obj;
459 output.length = sizeof(out_obj);
460 output.pointer = &out_obj;
462 status = acpi_evaluate_object(handle, (char *)method, NULL, &output);
463 *val = out_obj.integer.value;
464 return (status == AE_OK) && (out_obj.type == ACPI_TYPE_INTEGER);
468 * We write our info in page, we begin at offset off and cannot write more
469 * than count bytes. We set eof to 1 if we handle those 2 values. We return the
470 * number of bytes written in page
473 proc_read_info(char *page, char **start, off_t off, int count, int *eof,
478 char buf[16]; //enough for all info
480 * We use the easy way, we don't care of off and count, so we don't set eof
484 len += sprintf(page, ACPI_HOTK_NAME " " ASUS_ACPI_VERSION "\n");
485 len += sprintf(page + len, "Model reference : %s\n",
486 hotk->methods->name);
488 * The SFUN method probably allows the original driver to get the list
489 * of features supported by a given model. For now, 0x0100 or 0x0800
490 * bit signifies that the laptop is equipped with a Wi-Fi MiniPCI card.
491 * The significance of others is yet to be found.
493 if (read_acpi_int(hotk->handle, "SFUN", &temp))
495 sprintf(page + len, "SFUN value : 0x%04x\n", temp);
497 * Another value for userspace: the ASYM method returns 0x02 for
498 * battery low and 0x04 for battery critical, its readings tend to be
499 * more accurate than those provided by _BST.
500 * Note: since not all the laptops provide this method, errors are
503 if (read_acpi_int(hotk->handle, "ASYM", &temp))
505 sprintf(page + len, "ASYM value : 0x%04x\n", temp);
507 snprintf(buf, 16, "%d", asus_info->length);
508 len += sprintf(page + len, "DSDT length : %s\n", buf);
509 snprintf(buf, 16, "%d", asus_info->checksum);
510 len += sprintf(page + len, "DSDT checksum : %s\n", buf);
511 snprintf(buf, 16, "%d", asus_info->revision);
512 len += sprintf(page + len, "DSDT revision : %s\n", buf);
513 snprintf(buf, 7, "%s", asus_info->oem_id);
514 len += sprintf(page + len, "OEM id : %s\n", buf);
515 snprintf(buf, 9, "%s", asus_info->oem_table_id);
516 len += sprintf(page + len, "OEM table id : %s\n", buf);
517 snprintf(buf, 16, "%x", asus_info->oem_revision);
518 len += sprintf(page + len, "OEM revision : 0x%s\n", buf);
519 snprintf(buf, 5, "%s", asus_info->asl_compiler_id);
520 len += sprintf(page + len, "ASL comp vendor id : %s\n", buf);
521 snprintf(buf, 16, "%x", asus_info->asl_compiler_revision);
522 len += sprintf(page + len, "ASL comp revision : 0x%s\n", buf);
530 * We write our info in page, we begin at offset off and cannot write more
531 * than count bytes. We set eof to 1 if we handle those 2 values. We return the
532 * number of bytes written in page
535 /* Generic LED functions */
536 static int read_led(const char *ledname, int ledmask)
541 if (read_acpi_int(NULL, ledname, &led_status))
544 printk(KERN_WARNING "Asus ACPI: Error reading LED "
547 return (hotk->status & ledmask) ? 1 : 0;
550 static int parse_arg(const char __user * buf, unsigned long count, int *val)
557 if (copy_from_user(s, buf, count))
560 if (sscanf(s, "%i", val) != 1)
565 /* FIXME: kill extraneous args so it can be called independently */
567 write_led(const char __user * buffer, unsigned long count,
568 char *ledname, int ledmask, int invert)
573 rv = parse_arg(buffer, count, &value);
575 led_out = value ? 1 : 0;
578 (led_out) ? (hotk->status | ledmask) : (hotk->status & ~ledmask);
580 if (invert) /* invert target value */
581 led_out = !led_out & 0x1;
583 if (!write_acpi_int(hotk->handle, ledname, led_out, NULL))
584 printk(KERN_WARNING "Asus ACPI: LED (%s) write failed\n",
591 * Proc handlers for MLED
594 proc_read_mled(char *page, char **start, off_t off, int count, int *eof,
597 return sprintf(page, "%d\n",
598 read_led(hotk->methods->mled_status, MLED_ON));
602 proc_write_mled(struct file *file, const char __user * buffer,
603 unsigned long count, void *data)
605 return write_led(buffer, count, hotk->methods->mt_mled, MLED_ON, 1);
609 * Proc handlers for LED display
612 proc_read_ledd(char *page, char **start, off_t off, int count, int *eof,
615 return sprintf(page, "0x%08x\n", hotk->ledd_status);
619 proc_write_ledd(struct file *file, const char __user * buffer,
620 unsigned long count, void *data)
624 rv = parse_arg(buffer, count, &value);
627 (hotk->handle, hotk->methods->mt_ledd, value, NULL))
629 "Asus ACPI: LED display write failed\n");
631 hotk->ledd_status = (u32) value;
637 * Proc handlers for WLED
640 proc_read_wled(char *page, char **start, off_t off, int count, int *eof,
643 return sprintf(page, "%d\n",
644 read_led(hotk->methods->wled_status, WLED_ON));
648 proc_write_wled(struct file *file, const char __user * buffer,
649 unsigned long count, void *data)
651 return write_led(buffer, count, hotk->methods->mt_wled, WLED_ON, 0);
655 * Proc handlers for Bluetooth
658 proc_read_bluetooth(char *page, char **start, off_t off, int count, int *eof,
661 return sprintf(page, "%d\n", read_led(hotk->methods->bt_status, BT_ON));
665 proc_write_bluetooth(struct file *file, const char __user * buffer,
666 unsigned long count, void *data)
668 /* Note: mt_bt_switch controls both internal Bluetooth adapter's
669 presence and its LED */
670 return write_led(buffer, count, hotk->methods->mt_bt_switch, BT_ON, 0);
674 * Proc handlers for TLED
677 proc_read_tled(char *page, char **start, off_t off, int count, int *eof,
680 return sprintf(page, "%d\n",
681 read_led(hotk->methods->tled_status, TLED_ON));
685 proc_write_tled(struct file *file, const char __user * buffer,
686 unsigned long count, void *data)
688 return write_led(buffer, count, hotk->methods->mt_tled, TLED_ON, 0);
691 static int get_lcd_state(void)
695 if (hotk->model != L3H) {
696 /* We don't have to check anything if we are here */
697 if (!read_acpi_int(NULL, hotk->methods->lcd_status, &lcd))
699 "Asus ACPI: Error reading LCD status\n");
701 if (hotk->model == L2D)
703 } else { /* L3H and the like have to be handled differently */
704 acpi_status status = 0;
705 struct acpi_object_list input;
706 union acpi_object mt_params[2];
707 struct acpi_buffer output;
708 union acpi_object out_obj;
711 input.pointer = mt_params;
712 /* Note: the following values are partly guessed up, but
713 otherwise they seem to work */
714 mt_params[0].type = ACPI_TYPE_INTEGER;
715 mt_params[0].integer.value = 0x02;
716 mt_params[1].type = ACPI_TYPE_INTEGER;
717 mt_params[1].integer.value = 0x02;
719 output.length = sizeof(out_obj);
720 output.pointer = &out_obj;
723 acpi_evaluate_object(NULL, hotk->methods->lcd_status,
727 if (out_obj.type == ACPI_TYPE_INTEGER)
728 /* That's what the AML code does */
729 lcd = out_obj.integer.value >> 8;
735 static int set_lcd_state(int value)
738 acpi_status status = 0;
741 if (lcd != get_lcd_state()) {
743 if (hotk->model != L3H) {
745 acpi_evaluate_object(NULL,
746 hotk->methods->mt_lcd_switch,
748 } else { /* L3H and the like have to be handled differently */
750 (hotk->handle, hotk->methods->mt_lcd_switch, 0x07,
753 /* L3H's AML executes EHK (0x07) upon Fn+F7 keypress,
754 the exact behaviour is simulated here */
756 if (ACPI_FAILURE(status))
757 printk(KERN_WARNING "Asus ACPI: Error switching LCD\n");
764 proc_read_lcd(char *page, char **start, off_t off, int count, int *eof,
767 return sprintf(page, "%d\n", get_lcd_state());
771 proc_write_lcd(struct file *file, const char __user * buffer,
772 unsigned long count, void *data)
776 rv = parse_arg(buffer, count, &value);
778 set_lcd_state(value);
782 static int read_brightness(void)
786 if (hotk->methods->brightness_get) { /* SPLV/GPLV laptop */
787 if (!read_acpi_int(hotk->handle, hotk->methods->brightness_get,
790 "Asus ACPI: Error reading brightness\n");
791 } else if (hotk->methods->brightness_status) { /* For D1 for example */
792 if (!read_acpi_int(NULL, hotk->methods->brightness_status,
795 "Asus ACPI: Error reading brightness\n");
796 } else /* No GPLV method */
797 value = hotk->brightness;
802 * Change the brightness level
804 static void set_brightness(int value)
806 acpi_status status = 0;
809 if (hotk->methods->brightness_set) {
810 if (!write_acpi_int(hotk->handle, hotk->methods->brightness_set,
813 "Asus ACPI: Error changing brightness\n");
817 /* No SPLV method if we are here, act as appropriate */
818 value -= read_brightness();
820 status = acpi_evaluate_object(NULL, (value > 0) ?
821 hotk->methods->brightness_up :
822 hotk->methods->brightness_down,
824 (value > 0) ? value-- : value++;
825 if (ACPI_FAILURE(status))
827 "Asus ACPI: Error changing brightness\n");
833 proc_read_brn(char *page, char **start, off_t off, int count, int *eof,
836 return sprintf(page, "%d\n", read_brightness());
840 proc_write_brn(struct file *file, const char __user * buffer,
841 unsigned long count, void *data)
845 rv = parse_arg(buffer, count, &value);
847 value = (0 < value) ? ((15 < value) ? 15 : value) : 0;
848 /* 0 <= value <= 15 */
849 set_brightness(value);
854 static void set_display(int value)
856 /* no sanity check needed for now */
857 if (!write_acpi_int(hotk->handle, hotk->methods->display_set,
859 printk(KERN_WARNING "Asus ACPI: Error setting display\n");
864 * Now, *this* one could be more user-friendly, but so far, no-one has
865 * complained. The significance of bits is the same as in proc_write_disp()
868 proc_read_disp(char *page, char **start, off_t off, int count, int *eof,
873 if (!read_acpi_int(hotk->handle, hotk->methods->display_get, &value))
875 "Asus ACPI: Error reading display status\n");
876 value &= 0x07; /* needed for some models, shouldn't hurt others */
877 return sprintf(page, "%d\n", value);
881 * Experimental support for display switching. As of now: 1 should activate
882 * the LCD output, 2 should do for CRT, and 4 for TV-Out. Any combination
883 * (bitwise) of these will suffice. I never actually tested 3 displays hooked up
884 * simultaneously, so be warned. See the acpi4asus README for more info.
887 proc_write_disp(struct file *file, const char __user * buffer,
888 unsigned long count, void *data)
892 rv = parse_arg(buffer, count, &value);
898 typedef int (proc_readfunc) (char *page, char **start, off_t off, int count,
899 int *eof, void *data);
900 typedef int (proc_writefunc) (struct file * file, const char __user * buffer,
901 unsigned long count, void *data);
904 asus_proc_add(char *name, proc_writefunc * writefunc,
905 proc_readfunc * readfunc, mode_t mode,
906 struct acpi_device *device)
908 struct proc_dir_entry *proc =
909 create_proc_entry(name, mode, acpi_device_dir(device));
911 printk(KERN_WARNING " Unable to create %s fs entry\n", name);
914 proc->write_proc = writefunc;
915 proc->read_proc = readfunc;
916 proc->data = acpi_driver_data(device);
917 proc->owner = THIS_MODULE;
918 proc->uid = asus_uid;
919 proc->gid = asus_gid;
923 static int asus_hotk_add_fs(struct acpi_device *device)
925 struct proc_dir_entry *proc;
929 * If parameter uid or gid is not changed, keep the default setting for
930 * our proc entries (-rw-rw-rw-) else, it means we care about security,
931 * and then set to -rw-rw----
934 if ((asus_uid == 0) && (asus_gid == 0)) {
935 mode = S_IFREG | S_IRUGO | S_IWUGO;
937 mode = S_IFREG | S_IRUSR | S_IRGRP | S_IWUSR | S_IWGRP;
938 printk(KERN_WARNING " asus_uid and asus_gid parameters are "
939 "deprecated, use chown and chmod instead!\n");
942 acpi_device_dir(device) = asus_proc_dir;
943 if (!acpi_device_dir(device))
946 proc = create_proc_entry(PROC_INFO, mode, acpi_device_dir(device));
948 proc->read_proc = proc_read_info;
949 proc->data = acpi_driver_data(device);
950 proc->owner = THIS_MODULE;
951 proc->uid = asus_uid;
952 proc->gid = asus_gid;
954 printk(KERN_WARNING " Unable to create " PROC_INFO
958 if (hotk->methods->mt_wled) {
959 asus_proc_add(PROC_WLED, &proc_write_wled, &proc_read_wled,
963 if (hotk->methods->mt_ledd) {
964 asus_proc_add(PROC_LEDD, &proc_write_ledd, &proc_read_ledd,
968 if (hotk->methods->mt_mled) {
969 asus_proc_add(PROC_MLED, &proc_write_mled, &proc_read_mled,
973 if (hotk->methods->mt_tled) {
974 asus_proc_add(PROC_TLED, &proc_write_tled, &proc_read_tled,
978 if (hotk->methods->mt_bt_switch) {
979 asus_proc_add(PROC_BT, &proc_write_bluetooth,
980 &proc_read_bluetooth, mode, device);
984 * We need both read node and write method as LCD switch is also accessible
987 if (hotk->methods->mt_lcd_switch && hotk->methods->lcd_status) {
988 asus_proc_add(PROC_LCD, &proc_write_lcd, &proc_read_lcd, mode,
992 if ((hotk->methods->brightness_up && hotk->methods->brightness_down) ||
993 (hotk->methods->brightness_get && hotk->methods->brightness_set)) {
994 asus_proc_add(PROC_BRN, &proc_write_brn, &proc_read_brn, mode,
998 if (hotk->methods->display_set) {
999 asus_proc_add(PROC_DISP, &proc_write_disp, &proc_read_disp,
1006 static int asus_hotk_remove_fs(struct acpi_device *device)
1008 if (acpi_device_dir(device)) {
1009 remove_proc_entry(PROC_INFO, acpi_device_dir(device));
1010 if (hotk->methods->mt_wled)
1011 remove_proc_entry(PROC_WLED, acpi_device_dir(device));
1012 if (hotk->methods->mt_mled)
1013 remove_proc_entry(PROC_MLED, acpi_device_dir(device));
1014 if (hotk->methods->mt_tled)
1015 remove_proc_entry(PROC_TLED, acpi_device_dir(device));
1016 if (hotk->methods->mt_ledd)
1017 remove_proc_entry(PROC_LEDD, acpi_device_dir(device));
1018 if (hotk->methods->mt_bt_switch)
1019 remove_proc_entry(PROC_BT, acpi_device_dir(device));
1020 if (hotk->methods->mt_lcd_switch && hotk->methods->lcd_status)
1021 remove_proc_entry(PROC_LCD, acpi_device_dir(device));
1022 if ((hotk->methods->brightness_up
1023 && hotk->methods->brightness_down)
1024 || (hotk->methods->brightness_get
1025 && hotk->methods->brightness_set))
1026 remove_proc_entry(PROC_BRN, acpi_device_dir(device));
1027 if (hotk->methods->display_set)
1028 remove_proc_entry(PROC_DISP, acpi_device_dir(device));
1033 static void asus_hotk_notify(acpi_handle handle, u32 event, void *data)
1035 /* TODO Find a better way to handle events count. */
1039 if ((event & ~((u32) BR_UP)) < 16) {
1040 hotk->brightness = (event & ~((u32) BR_UP));
1041 } else if ((event & ~((u32) BR_DOWN)) < 16) {
1042 hotk->brightness = (event & ~((u32) BR_DOWN));
1045 acpi_bus_generate_event(hotk->device, event,
1046 hotk->event_count[event % 128]++);
1052 * Match the model string to the list of supported models. Return END_MODEL if
1053 * no match or model is NULL.
1055 static int asus_model_match(char *model)
1060 if (strncmp(model, "L3D", 3) == 0)
1062 else if (strncmp(model, "L2E", 3) == 0 ||
1063 strncmp(model, "L3H", 3) == 0 || strncmp(model, "L5D", 3) == 0)
1065 else if (strncmp(model, "L3", 2) == 0 || strncmp(model, "L2B", 3) == 0)
1067 else if (strncmp(model, "L8L", 3) == 0)
1069 else if (strncmp(model, "L4R", 3) == 0)
1071 else if (strncmp(model, "M6N", 3) == 0 || strncmp(model, "W3N", 3) == 0)
1073 else if (strncmp(model, "M6R", 3) == 0 || strncmp(model, "A3G", 3) == 0)
1075 else if (strncmp(model, "M2N", 3) == 0 ||
1076 strncmp(model, "M3N", 3) == 0 ||
1077 strncmp(model, "M5N", 3) == 0 ||
1078 strncmp(model, "M6N", 3) == 0 ||
1079 strncmp(model, "S1N", 3) == 0 ||
1080 strncmp(model, "S5N", 3) == 0 || strncmp(model, "W1N", 3) == 0)
1082 else if (strncmp(model, "M1", 2) == 0)
1084 else if (strncmp(model, "M2", 2) == 0 || strncmp(model, "L4E", 3) == 0)
1086 else if (strncmp(model, "L2", 2) == 0)
1088 else if (strncmp(model, "L8", 2) == 0)
1090 else if (strncmp(model, "D1", 2) == 0)
1092 else if (strncmp(model, "A1", 2) == 0)
1094 else if (strncmp(model, "A2", 2) == 0)
1096 else if (strncmp(model, "J1", 2) == 0)
1098 else if (strncmp(model, "L5", 2) == 0)
1100 else if (strncmp(model, "A4G", 3) == 0)
1102 else if (strncmp(model, "W1N", 3) == 0)
1104 else if (strncmp(model, "W3V", 3) == 0)
1106 else if (strncmp(model, "W5A", 3) == 0)
1113 * This function is used to initialize the hotk with right values. In this
1114 * method, we can make all the detection we want, and modify the hotk struct
1116 static int asus_hotk_get_info(void)
1118 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
1119 struct acpi_buffer dsdt = { ACPI_ALLOCATE_BUFFER, NULL };
1120 union acpi_object *model = NULL;
1122 char *string = NULL;
1126 * Get DSDT headers early enough to allow for differentiating between
1127 * models, but late enough to allow acpi_bus_register_driver() to fail
1128 * before doing anything ACPI-specific. Should we encounter a machine,
1129 * which needs special handling (i.e. its hotkey device has a different
1130 * HID), this bit will be moved. A global variable asus_info contains
1133 status = acpi_get_table(ACPI_TABLE_ID_DSDT, 1, &dsdt);
1134 if (ACPI_FAILURE(status))
1135 printk(KERN_WARNING " Couldn't get the DSDT table header\n");
1137 asus_info = (struct acpi_table_header *)dsdt.pointer;
1139 /* We have to write 0 on init this far for all ASUS models */
1140 if (!write_acpi_int(hotk->handle, "INIT", 0, &buffer)) {
1141 printk(KERN_ERR " Hotkey initialization failed\n");
1145 /* This needs to be called for some laptops to init properly */
1146 if (!read_acpi_int(hotk->handle, "BSTS", &bsts_result))
1147 printk(KERN_WARNING " Error calling BSTS\n");
1148 else if (bsts_result)
1149 printk(KERN_NOTICE " BSTS called, 0x%02x returned\n",
1153 * Try to match the object returned by INIT to the specific model.
1154 * Handle every possible object (or the lack of thereof) the DSDT
1155 * writers might throw at us. When in trouble, we pass NULL to
1156 * asus_model_match() and try something completely different.
1158 if (buffer.pointer) {
1159 model = (union acpi_object *)buffer.pointer;
1160 switch (model->type) {
1161 case ACPI_TYPE_STRING:
1162 string = model->string.pointer;
1164 case ACPI_TYPE_BUFFER:
1165 string = model->buffer.pointer;
1172 hotk->model = asus_model_match(string);
1173 if (hotk->model == END_MODEL) { /* match failed */
1175 strncmp(asus_info->oem_table_id, "ODEM", 4) == 0) {
1178 " Samsung P30 detected, supported\n");
1181 printk(KERN_NOTICE " unsupported model %s, trying "
1182 "default values\n", string);
1184 " send /proc/acpi/dsdt to the developers\n");
1186 hotk->methods = &model_conf[hotk->model];
1189 hotk->methods = &model_conf[hotk->model];
1190 printk(KERN_NOTICE " %s model detected, supported\n", string);
1192 /* Sort of per-model blacklist */
1193 if (strncmp(string, "L2B", 3) == 0)
1194 hotk->methods->lcd_status = NULL;
1195 /* L2B is similar enough to L3C to use its settings, with this only
1197 else if (strncmp(string, "A3G", 3) == 0)
1198 hotk->methods->lcd_status = "\\BLFG";
1199 /* A3G is like M6R */
1200 else if (strncmp(string, "S5N", 3) == 0 ||
1201 strncmp(string, "M5N", 3) == 0 ||
1202 strncmp(string, "W3N", 3) == 0)
1203 hotk->methods->mt_mled = NULL;
1204 /* S5N, M5N and W3N have no MLED */
1205 else if (strncmp(string, "L5D", 3) == 0)
1206 hotk->methods->mt_wled = NULL;
1207 /* L5D's WLED is not controlled by ACPI */
1208 else if (strncmp(string, "M2N", 3) == 0 ||
1209 strncmp(string, "W3V", 3) == 0 ||
1210 strncmp(string, "S1N", 3) == 0)
1211 hotk->methods->mt_wled = "WLED";
1212 /* M2N, S1N and W3V have a usable WLED */
1213 else if (asus_info) {
1214 if (strncmp(asus_info->oem_table_id, "L1", 2) == 0)
1215 hotk->methods->mled_status = NULL;
1216 /* S1300A reports L84F, but L1400B too, account for that */
1224 static int asus_hotk_check(void)
1228 result = acpi_bus_get_status(hotk->device);
1232 if (hotk->device->status.present) {
1233 result = asus_hotk_get_info();
1235 printk(KERN_ERR " Hotkey device not present, aborting\n");
1242 static int asus_hotk_found;
1244 static int asus_hotk_add(struct acpi_device *device)
1246 acpi_status status = AE_OK;
1252 printk(KERN_NOTICE "Asus Laptop ACPI Extras version %s\n",
1256 (struct asus_hotk *)kmalloc(sizeof(struct asus_hotk), GFP_KERNEL);
1259 memset(hotk, 0, sizeof(struct asus_hotk));
1261 hotk->handle = device->handle;
1262 strcpy(acpi_device_name(device), ACPI_HOTK_DEVICE_NAME);
1263 strcpy(acpi_device_class(device), ACPI_HOTK_CLASS);
1264 acpi_driver_data(device) = hotk;
1265 hotk->device = device;
1267 result = asus_hotk_check();
1271 result = asus_hotk_add_fs(device);
1276 * We install the handler, it will receive the hotk in parameter, so, we
1277 * could add other data to the hotk struct
1279 status = acpi_install_notify_handler(hotk->handle, ACPI_SYSTEM_NOTIFY,
1280 asus_hotk_notify, hotk);
1281 if (ACPI_FAILURE(status))
1282 printk(KERN_ERR " Error installing notify handler\n");
1284 /* For laptops without GPLV: init the hotk->brightness value */
1285 if ((!hotk->methods->brightness_get)
1286 && (!hotk->methods->brightness_status)
1287 && (hotk->methods->brightness_up && hotk->methods->brightness_down)) {
1289 acpi_evaluate_object(NULL, hotk->methods->brightness_down,
1291 if (ACPI_FAILURE(status))
1292 printk(KERN_WARNING " Error changing brightness\n");
1295 acpi_evaluate_object(NULL,
1296 hotk->methods->brightness_up,
1298 if (ACPI_FAILURE(status))
1299 printk(KERN_WARNING " Strange, error changing"
1304 asus_hotk_found = 1;
1306 /* LED display is off by default */
1307 hotk->ledd_status = 0xFFF;
1317 static int asus_hotk_remove(struct acpi_device *device, int type)
1319 acpi_status status = 0;
1321 if (!device || !acpi_driver_data(device))
1324 status = acpi_remove_notify_handler(hotk->handle, ACPI_SYSTEM_NOTIFY,
1326 if (ACPI_FAILURE(status))
1327 printk(KERN_ERR "Asus ACPI: Error removing notify handler\n");
1329 asus_hotk_remove_fs(device);
1336 static int __init asus_acpi_init(void)
1343 if (!acpi_specific_hotkey_enabled) {
1344 printk(KERN_ERR "Using generic hotkey driver\n");
1347 asus_proc_dir = proc_mkdir(PROC_ASUS, acpi_root_dir);
1348 if (!asus_proc_dir) {
1349 printk(KERN_ERR "Asus ACPI: Unable to create /proc entry\n");
1352 asus_proc_dir->owner = THIS_MODULE;
1354 result = acpi_bus_register_driver(&asus_hotk_driver);
1356 remove_proc_entry(PROC_ASUS, acpi_root_dir);
1361 * This is a bit of a kludge. We only want this module loaded
1362 * for ASUS systems, but there's currently no way to probe the
1363 * ACPI namespace for ASUS HIDs. So we just return failure if
1364 * we didn't find one, which will cause the module to be
1367 if (!asus_hotk_found) {
1368 acpi_bus_unregister_driver(&asus_hotk_driver);
1369 remove_proc_entry(PROC_ASUS, acpi_root_dir);
1376 static void __exit asus_acpi_exit(void)
1378 acpi_bus_unregister_driver(&asus_hotk_driver);
1379 remove_proc_entry(PROC_ASUS, acpi_root_dir);
1386 module_init(asus_acpi_init);
1387 module_exit(asus_acpi_exit);