1 /* 2 * Wistron laptop button driver 3 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz> 4 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org> 5 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru> 6 * 7 * You can redistribute and/or modify this program under the terms of the 8 * GNU General Public License version 2 as published by the Free Software 9 * Foundation. 10 * 11 * This program is distributed in the hope that it will be useful, but 12 * WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General 14 * Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License along 17 * with this program; if not, write to the Free Software Foundation, Inc., 18 * 59 Temple Place Suite 330, Boston, MA 02111-1307, USA. 19 */ 20 #include <asm/io.h> 21 #include <linux/dmi.h> 22 #include <linux/init.h> 23 #include <linux/input.h> 24 #include <linux/interrupt.h> 25 #include <linux/kernel.h> 26 #include <linux/mc146818rtc.h> 27 #include <linux/module.h> 28 #include <linux/preempt.h> 29 #include <linux/string.h> 30 #include <linux/timer.h> 31 #include <linux/types.h> 32 #include <linux/platform_device.h> 33 34 /* 35 * Number of attempts to read data from queue per poll; 36 * the queue can hold up to 31 entries 37 */ 38 #define MAX_POLL_ITERATIONS 64 39 40 #define POLL_FREQUENCY 10 /* Number of polls per second */ 41 42 #if POLL_FREQUENCY > HZ 43 #error "POLL_FREQUENCY too high" 44 #endif 45 46 /* BIOS subsystem IDs */ 47 #define WIFI 0x35 48 #define BLUETOOTH 0x34 49 50 MODULE_AUTHOR("Miloslav Trmac <mitr@volny.cz>"); 51 MODULE_DESCRIPTION("Wistron laptop button driver"); 52 MODULE_LICENSE("GPL v2"); 53 MODULE_VERSION("0.1"); 54 55 static int force; /* = 0; */ 56 module_param(force, bool, 0); 57 MODULE_PARM_DESC(force, "Load even if computer is not in database"); 58 59 static char *keymap_name; /* = NULL; */ 60 module_param_named(keymap, keymap_name, charp, 0); 61 MODULE_PARM_DESC(keymap, "Keymap name, if it can't be autodetected"); 62 63 static struct platform_device *wistron_device; 64 65 /* BIOS interface implementation */ 66 67 static void __iomem *bios_entry_point; /* BIOS routine entry point */ 68 static void __iomem *bios_code_map_base; 69 static void __iomem *bios_data_map_base; 70 71 static u8 cmos_address; 72 73 struct regs { 74 u32 eax, ebx, ecx; 75 }; 76 77 static void call_bios(struct regs *regs) 78 { 79 unsigned long flags; 80 81 preempt_disable(); 82 local_irq_save(flags); 83 asm volatile ("pushl %%ebp;" 84 "movl %7, %%ebp;" 85 "call *%6;" 86 "popl %%ebp" 87 : "=a" (regs->eax), "=b" (regs->ebx), "=c" (regs->ecx) 88 : "0" (regs->eax), "1" (regs->ebx), "2" (regs->ecx), 89 "m" (bios_entry_point), "m" (bios_data_map_base) 90 : "edx", "edi", "esi", "memory"); 91 local_irq_restore(flags); 92 preempt_enable(); 93 } 94 95 static ssize_t __init locate_wistron_bios(void __iomem *base) 96 { 97 static unsigned char __initdata signature[] = 98 { 0x42, 0x21, 0x55, 0x30 }; 99 ssize_t offset; 100 101 for (offset = 0; offset < 0x10000; offset += 0x10) { 102 if (check_signature(base + offset, signature, 103 sizeof(signature)) != 0) 104 return offset; 105 } 106 return -1; 107 } 108 109 static int __init map_bios(void) 110 { 111 void __iomem *base; 112 ssize_t offset; 113 u32 entry_point; 114 115 base = ioremap(0xF0000, 0x10000); /* Can't fail */ 116 offset = locate_wistron_bios(base); 117 if (offset < 0) { 118 printk(KERN_ERR "wistron_btns: BIOS entry point not found\n"); 119 iounmap(base); 120 return -ENODEV; 121 } 122 123 entry_point = readl(base + offset + 5); 124 printk(KERN_DEBUG 125 "wistron_btns: BIOS signature found at %p, entry point %08X\n", 126 base + offset, entry_point); 127 128 if (entry_point >= 0xF0000) { 129 bios_code_map_base = base; 130 bios_entry_point = bios_code_map_base + (entry_point & 0xFFFF); 131 } else { 132 iounmap(base); 133 bios_code_map_base = ioremap(entry_point & ~0x3FFF, 0x4000); 134 if (bios_code_map_base == NULL) { 135 printk(KERN_ERR 136 "wistron_btns: Can't map BIOS code at %08X\n", 137 entry_point & ~0x3FFF); 138 goto err; 139 } 140 bios_entry_point = bios_code_map_base + (entry_point & 0x3FFF); 141 } 142 /* The Windows driver maps 0x10000 bytes, we keep only one page... */ 143 bios_data_map_base = ioremap(0x400, 0xc00); 144 if (bios_data_map_base == NULL) { 145 printk(KERN_ERR "wistron_btns: Can't map BIOS data\n"); 146 goto err_code; 147 } 148 return 0; 149 150 err_code: 151 iounmap(bios_code_map_base); 152 err: 153 return -ENOMEM; 154 } 155 156 static inline void unmap_bios(void) 157 { 158 iounmap(bios_code_map_base); 159 iounmap(bios_data_map_base); 160 } 161 162 /* BIOS calls */ 163 164 static u16 bios_pop_queue(void) 165 { 166 struct regs regs; 167 168 memset(®s, 0, sizeof (regs)); 169 regs.eax = 0x9610; 170 regs.ebx = 0x061C; 171 regs.ecx = 0x0000; 172 call_bios(®s); 173 174 return regs.eax; 175 } 176 177 static void __devinit bios_attach(void) 178 { 179 struct regs regs; 180 181 memset(®s, 0, sizeof (regs)); 182 regs.eax = 0x9610; 183 regs.ebx = 0x012E; 184 call_bios(®s); 185 } 186 187 static void bios_detach(void) 188 { 189 struct regs regs; 190 191 memset(®s, 0, sizeof (regs)); 192 regs.eax = 0x9610; 193 regs.ebx = 0x002E; 194 call_bios(®s); 195 } 196 197 static u8 __devinit bios_get_cmos_address(void) 198 { 199 struct regs regs; 200 201 memset(®s, 0, sizeof (regs)); 202 regs.eax = 0x9610; 203 regs.ebx = 0x051C; 204 call_bios(®s); 205 206 return regs.ecx; 207 } 208 209 static u16 __devinit bios_get_default_setting(u8 subsys) 210 { 211 struct regs regs; 212 213 memset(®s, 0, sizeof (regs)); 214 regs.eax = 0x9610; 215 regs.ebx = 0x0200 | subsys; 216 call_bios(®s); 217 218 return regs.eax; 219 } 220 221 static void bios_set_state(u8 subsys, int enable) 222 { 223 struct regs regs; 224 225 memset(®s, 0, sizeof (regs)); 226 regs.eax = 0x9610; 227 regs.ebx = (enable ? 0x0100 : 0x0000) | subsys; 228 call_bios(®s); 229 } 230 231 /* Hardware database */ 232 233 struct key_entry { 234 char type; /* See KE_* below */ 235 u8 code; 236 unsigned keycode; /* For KE_KEY */ 237 }; 238 239 enum { KE_END, KE_KEY, KE_WIFI, KE_BLUETOOTH }; 240 241 static const struct key_entry *keymap; /* = NULL; Current key map */ 242 static int have_wifi; 243 static int have_bluetooth; 244 245 static int __init dmi_matched(struct dmi_system_id *dmi) 246 { 247 const struct key_entry *key; 248 249 keymap = dmi->driver_data; 250 for (key = keymap; key->type != KE_END; key++) { 251 if (key->type == KE_WIFI) { 252 have_wifi = 1; 253 break; 254 } else if (key->type == KE_BLUETOOTH) { 255 have_bluetooth = 1; 256 break; 257 } 258 } 259 return 1; 260 } 261 262 static struct key_entry keymap_empty[] __initdata = { 263 { KE_END, 0 } 264 }; 265 266 static struct key_entry keymap_fs_amilo_pro_v2000[] __initdata = { 267 { KE_KEY, 0x01, KEY_HELP }, 268 { KE_KEY, 0x11, KEY_PROG1 }, 269 { KE_KEY, 0x12, KEY_PROG2 }, 270 { KE_WIFI, 0x30, 0 }, 271 { KE_KEY, 0x31, KEY_MAIL }, 272 { KE_KEY, 0x36, KEY_WWW }, 273 { KE_END, 0 } 274 }; 275 276 static struct key_entry keymap_fujitsu_n3510[] __initdata = { 277 { KE_KEY, 0x11, KEY_PROG1 }, 278 { KE_KEY, 0x12, KEY_PROG2 }, 279 { KE_KEY, 0x36, KEY_WWW }, 280 { KE_KEY, 0x31, KEY_MAIL }, 281 { KE_KEY, 0x71, KEY_STOPCD }, 282 { KE_KEY, 0x72, KEY_PLAYPAUSE }, 283 { KE_KEY, 0x74, KEY_REWIND }, 284 { KE_KEY, 0x78, KEY_FORWARD }, 285 { KE_END, 0 } 286 }; 287 288 static struct key_entry keymap_wistron_ms2111[] __initdata = { 289 { KE_KEY, 0x11, KEY_PROG1 }, 290 { KE_KEY, 0x12, KEY_PROG2 }, 291 { KE_KEY, 0x13, KEY_PROG3 }, 292 { KE_KEY, 0x31, KEY_MAIL }, 293 { KE_KEY, 0x36, KEY_WWW }, 294 { KE_END, 0 } 295 }; 296 297 static struct key_entry keymap_wistron_ms2141[] __initdata = { 298 { KE_KEY, 0x11, KEY_PROG1 }, 299 { KE_KEY, 0x12, KEY_PROG2 }, 300 { KE_WIFI, 0x30, 0 }, 301 { KE_KEY, 0x22, KEY_REWIND }, 302 { KE_KEY, 0x23, KEY_FORWARD }, 303 { KE_KEY, 0x24, KEY_PLAYPAUSE }, 304 { KE_KEY, 0x25, KEY_STOPCD }, 305 { KE_KEY, 0x31, KEY_MAIL }, 306 { KE_KEY, 0x36, KEY_WWW }, 307 { KE_END, 0 } 308 }; 309 310 static struct key_entry keymap_acer_aspire_1500[] __initdata = { 311 { KE_KEY, 0x11, KEY_PROG1 }, 312 { KE_KEY, 0x12, KEY_PROG2 }, 313 { KE_WIFI, 0x30, 0 }, 314 { KE_KEY, 0x31, KEY_MAIL }, 315 { KE_KEY, 0x36, KEY_WWW }, 316 { KE_BLUETOOTH, 0x44, 0 }, 317 { KE_END, 0 } 318 }; 319 320 static struct key_entry keymap_acer_travelmate_240[] __initdata = { 321 { KE_KEY, 0x31, KEY_MAIL }, 322 { KE_KEY, 0x36, KEY_WWW }, 323 { KE_KEY, 0x11, KEY_PROG1 }, 324 { KE_KEY, 0x12, KEY_PROG2 }, 325 { KE_BLUETOOTH, 0x44, 0 }, 326 { KE_WIFI, 0x30, 0 }, 327 { KE_END, 0 } 328 }; 329 330 static struct key_entry keymap_aopen_1559as[] __initdata = { 331 { KE_KEY, 0x01, KEY_HELP }, 332 { KE_KEY, 0x06, KEY_PROG3 }, 333 { KE_KEY, 0x11, KEY_PROG1 }, 334 { KE_KEY, 0x12, KEY_PROG2 }, 335 { KE_WIFI, 0x30, 0 }, 336 { KE_KEY, 0x31, KEY_MAIL }, 337 { KE_KEY, 0x36, KEY_WWW }, 338 { KE_END, 0 }, 339 }; 340 341 /* 342 * If your machine is not here (which is currently rather likely), please send 343 * a list of buttons and their key codes (reported when loading this module 344 * with force=1) and the output of dmidecode to $MODULE_AUTHOR. 345 */ 346 static struct dmi_system_id dmi_ids[] __initdata = { 347 { 348 .callback = dmi_matched, 349 .ident = "Fujitsu-Siemens Amilo Pro V2000", 350 .matches = { 351 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"), 352 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Pro V2000"), 353 }, 354 .driver_data = keymap_fs_amilo_pro_v2000 355 }, 356 { 357 .callback = dmi_matched, 358 .ident = "Fujitsu-Siemens Amilo M7400", 359 .matches = { 360 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"), 361 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO M "), 362 }, 363 .driver_data = keymap_fs_amilo_pro_v2000 364 }, 365 { 366 .callback = dmi_matched, 367 .ident = "Fujitsu N3510", 368 .matches = { 369 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU"), 370 DMI_MATCH(DMI_PRODUCT_NAME, "N3510"), 371 }, 372 .driver_data = keymap_fujitsu_n3510 373 }, 374 { 375 .callback = dmi_matched, 376 .ident = "Acer Aspire 1500", 377 .matches = { 378 DMI_MATCH(DMI_SYS_VENDOR, "Acer"), 379 DMI_MATCH(DMI_PRODUCT_NAME, "Aspire 1500"), 380 }, 381 .driver_data = keymap_acer_aspire_1500 382 }, 383 { 384 .callback = dmi_matched, 385 .ident = "Acer TravelMate 240", 386 .matches = { 387 DMI_MATCH(DMI_SYS_VENDOR, "Acer"), 388 DMI_MATCH(DMI_PRODUCT_NAME, "TravelMate 240"), 389 }, 390 .driver_data = keymap_acer_travelmate_240 391 }, 392 { 393 .callback = dmi_matched, 394 .ident = "AOpen 1559AS", 395 .matches = { 396 DMI_MATCH(DMI_PRODUCT_NAME, "E2U"), 397 DMI_MATCH(DMI_BOARD_NAME, "E2U"), 398 }, 399 .driver_data = keymap_aopen_1559as 400 }, 401 { 402 .callback = dmi_matched, 403 .ident = "Medion MD 9783", 404 .matches = { 405 DMI_MATCH(DMI_SYS_VENDOR, "MEDIONNB"), 406 DMI_MATCH(DMI_PRODUCT_NAME, "MD 9783"), 407 }, 408 .driver_data = keymap_wistron_ms2111 409 }, 410 { NULL, } 411 }; 412 413 static int __init select_keymap(void) 414 { 415 if (keymap_name != NULL) { 416 if (strcmp (keymap_name, "1557/MS2141") == 0) 417 keymap = keymap_wistron_ms2141; 418 else { 419 printk(KERN_ERR "wistron_btns: Keymap unknown\n"); 420 return -EINVAL; 421 } 422 } 423 dmi_check_system(dmi_ids); 424 if (keymap == NULL) { 425 if (!force) { 426 printk(KERN_ERR "wistron_btns: System unknown\n"); 427 return -ENODEV; 428 } 429 keymap = keymap_empty; 430 } 431 return 0; 432 } 433 434 /* Input layer interface */ 435 436 static struct input_dev *input_dev; 437 438 static int __devinit setup_input_dev(void) 439 { 440 const struct key_entry *key; 441 int error; 442 443 input_dev = input_allocate_device(); 444 if (!input_dev) 445 return -ENOMEM; 446 447 input_dev->name = "Wistron laptop buttons"; 448 input_dev->phys = "wistron/input0"; 449 input_dev->id.bustype = BUS_HOST; 450 input_dev->cdev.dev = &wistron_device->dev; 451 452 for (key = keymap; key->type != KE_END; key++) { 453 if (key->type == KE_KEY) { 454 input_dev->evbit[LONG(EV_KEY)] = BIT(EV_KEY); 455 set_bit(key->keycode, input_dev->keybit); 456 } 457 } 458 459 error = input_register_device(input_dev); 460 if (error) { 461 input_free_device(input_dev); 462 return error; 463 } 464 465 return 0; 466 } 467 468 static void report_key(unsigned keycode) 469 { 470 input_report_key(input_dev, keycode, 1); 471 input_sync(input_dev); 472 input_report_key(input_dev, keycode, 0); 473 input_sync(input_dev); 474 } 475 476 /* Driver core */ 477 478 static int wifi_enabled; 479 static int bluetooth_enabled; 480 481 static void poll_bios(unsigned long); 482 483 static struct timer_list poll_timer = TIMER_INITIALIZER(poll_bios, 0, 0); 484 485 static void handle_key(u8 code) 486 { 487 const struct key_entry *key; 488 489 for (key = keymap; key->type != KE_END; key++) { 490 if (code == key->code) { 491 switch (key->type) { 492 case KE_KEY: 493 report_key(key->keycode); 494 break; 495 496 case KE_WIFI: 497 if (have_wifi) { 498 wifi_enabled = !wifi_enabled; 499 bios_set_state(WIFI, wifi_enabled); 500 } 501 break; 502 503 case KE_BLUETOOTH: 504 if (have_bluetooth) { 505 bluetooth_enabled = !bluetooth_enabled; 506 bios_set_state(BLUETOOTH, bluetooth_enabled); 507 } 508 break; 509 510 case KE_END: 511 default: 512 BUG(); 513 } 514 return; 515 } 516 } 517 printk(KERN_NOTICE "wistron_btns: Unknown key code %02X\n", code); 518 } 519 520 static void poll_bios(unsigned long discard) 521 { 522 u8 qlen; 523 u16 val; 524 525 for (;;) { 526 qlen = CMOS_READ(cmos_address); 527 if (qlen == 0) 528 break; 529 val = bios_pop_queue(); 530 if (val != 0 && !discard) 531 handle_key((u8)val); 532 } 533 534 mod_timer(&poll_timer, jiffies + HZ / POLL_FREQUENCY); 535 } 536 537 static int __devinit wistron_probe(struct platform_device *dev) 538 { 539 int err = setup_input_dev(); 540 if (err) 541 return err; 542 543 bios_attach(); 544 cmos_address = bios_get_cmos_address(); 545 546 if (have_wifi) { 547 u16 wifi = bios_get_default_setting(WIFI); 548 if (wifi & 1) 549 wifi_enabled = (wifi & 2) ? 1 : 0; 550 else 551 have_wifi = 0; 552 553 if (have_wifi) 554 bios_set_state(WIFI, wifi_enabled); 555 } 556 557 if (have_bluetooth) { 558 u16 bt = bios_get_default_setting(BLUETOOTH); 559 if (bt & 1) 560 bluetooth_enabled = (bt & 2) ? 1 : 0; 561 else 562 have_bluetooth = 0; 563 564 if (have_bluetooth) 565 bios_set_state(BLUETOOTH, bluetooth_enabled); 566 } 567 568 poll_bios(1); /* Flush stale event queue and arm timer */ 569 570 return 0; 571 } 572 573 static int __devexit wistron_remove(struct platform_device *dev) 574 { 575 del_timer_sync(&poll_timer); 576 input_unregister_device(input_dev); 577 bios_detach(); 578 579 return 0; 580 } 581 582 #ifdef CONFIG_PM 583 static int wistron_suspend(struct platform_device *dev, pm_message_t state) 584 { 585 del_timer_sync(&poll_timer); 586 587 if (have_wifi) 588 bios_set_state(WIFI, 0); 589 590 if (have_bluetooth) 591 bios_set_state(BLUETOOTH, 0); 592 593 return 0; 594 } 595 596 static int wistron_resume(struct platform_device *dev) 597 { 598 if (have_wifi) 599 bios_set_state(WIFI, wifi_enabled); 600 601 if (have_bluetooth) 602 bios_set_state(BLUETOOTH, bluetooth_enabled); 603 604 poll_bios(1); 605 606 return 0; 607 } 608 #else 609 #define wistron_suspend NULL 610 #define wistron_resume NULL 611 #endif 612 613 static struct platform_driver wistron_driver = { 614 .driver = { 615 .name = "wistron-bios", 616 .owner = THIS_MODULE, 617 }, 618 .probe = wistron_probe, 619 .remove = __devexit_p(wistron_remove), 620 .suspend = wistron_suspend, 621 .resume = wistron_resume, 622 }; 623 624 static int __init wb_module_init(void) 625 { 626 int err; 627 628 err = select_keymap(); 629 if (err) 630 return err; 631 632 err = map_bios(); 633 if (err) 634 return err; 635 636 err = platform_driver_register(&wistron_driver); 637 if (err) 638 goto err_unmap_bios; 639 640 wistron_device = platform_device_alloc("wistron-bios", -1); 641 if (!wistron_device) { 642 err = -ENOMEM; 643 goto err_unregister_driver; 644 } 645 646 err = platform_device_add(wistron_device); 647 if (err) 648 goto err_free_device; 649 650 return 0; 651 652 err_free_device: 653 platform_device_put(wistron_device); 654 err_unregister_driver: 655 platform_driver_unregister(&wistron_driver); 656 err_unmap_bios: 657 unmap_bios(); 658 659 return err; 660 } 661 662 static void __exit wb_module_exit(void) 663 { 664 platform_device_unregister(wistron_device); 665 platform_driver_unregister(&wistron_driver); 666 unmap_bios(); 667 } 668 669 module_init(wb_module_init); 670 module_exit(wb_module_exit); 671