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 size_t __init locate_wistron_bios(void __iomem *base)
96 {
97 	static const unsigned char __initdata signature[] =
98 		{ 0x42, 0x21, 0x55, 0x30 };
99 	size_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 	size_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(&regs, 0, sizeof (regs));
169 	regs.eax = 0x9610;
170 	regs.ebx = 0x061C;
171 	regs.ecx = 0x0000;
172 	call_bios(&regs);
173 
174 	return regs.eax;
175 }
176 
177 static void __devinit bios_attach(void)
178 {
179 	struct regs regs;
180 
181 	memset(&regs, 0, sizeof (regs));
182 	regs.eax = 0x9610;
183 	regs.ebx = 0x012E;
184 	call_bios(&regs);
185 }
186 
187 static void bios_detach(void)
188 {
189 	struct regs regs;
190 
191 	memset(&regs, 0, sizeof (regs));
192 	regs.eax = 0x9610;
193 	regs.ebx = 0x002E;
194 	call_bios(&regs);
195 }
196 
197 static u8 __devinit bios_get_cmos_address(void)
198 {
199 	struct regs regs;
200 
201 	memset(&regs, 0, sizeof (regs));
202 	regs.eax = 0x9610;
203 	regs.ebx = 0x051C;
204 	call_bios(&regs);
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(&regs, 0, sizeof (regs));
214 	regs.eax = 0x9610;
215 	regs.ebx = 0x0200 | subsys;
216 	call_bios(&regs);
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(&regs, 0, sizeof (regs));
226 	regs.eax = 0x9610;
227 	regs.ebx = (enable ? 0x0100 : 0x0000) | subsys;
228 	call_bios(&regs);
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[] = {
263 	{ KE_END, 0 }
264 };
265 
266 static struct key_entry keymap_fs_amilo_pro_v2000[] = {
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_wistron_ms2141[] = {
277 	{ KE_KEY,  0x11, KEY_PROG1 },
278 	{ KE_KEY,  0x12, KEY_PROG2 },
279 	{ KE_WIFI, 0x30, 0 },
280 	{ KE_KEY,  0x22, KEY_REWIND },
281 	{ KE_KEY,  0x23, KEY_FORWARD },
282 	{ KE_KEY,  0x24, KEY_PLAYPAUSE },
283 	{ KE_KEY,  0x25, KEY_STOPCD },
284 	{ KE_KEY,  0x31, KEY_MAIL },
285 	{ KE_KEY,  0x36, KEY_WWW },
286 	{ KE_END,  0 }
287 };
288 
289 static struct key_entry keymap_acer_aspire_1500[] = {
290 	{ KE_KEY, 0x11, KEY_PROG1 },
291 	{ KE_KEY, 0x12, KEY_PROG2 },
292 	{ KE_WIFI, 0x30, 0 },
293 	{ KE_KEY, 0x31, KEY_MAIL },
294 	{ KE_KEY, 0x36, KEY_WWW },
295 	{ KE_BLUETOOTH, 0x44, 0 },
296 	{ KE_END, 0 }
297 };
298 
299 static struct key_entry keymap_acer_travelmate_240[] = {
300 	{ KE_KEY, 0x31, KEY_MAIL },
301 	{ KE_KEY, 0x36, KEY_WWW },
302 	{ KE_KEY, 0x11, KEY_PROG1 },
303 	{ KE_KEY, 0x12, KEY_PROG2 },
304 	{ KE_BLUETOOTH, 0x44, 0 },
305 	{ KE_WIFI, 0x30, 0 },
306 	{ KE_END, 0 }
307 };
308 
309 /*
310  * If your machine is not here (which is currently rather likely), please send
311  * a list of buttons and their key codes (reported when loading this module
312  * with force=1) and the output of dmidecode to $MODULE_AUTHOR.
313  */
314 static struct dmi_system_id dmi_ids[] = {
315 	{
316 		.callback = dmi_matched,
317 		.ident = "Fujitsu-Siemens Amilo Pro V2000",
318 		.matches = {
319 			DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
320 			DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Pro V2000"),
321 		},
322 		.driver_data = keymap_fs_amilo_pro_v2000
323 	},
324 	{
325 		.callback = dmi_matched,
326 		.ident = "Acer Aspire 1500",
327 		.matches = {
328 			DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
329 			DMI_MATCH(DMI_PRODUCT_NAME, "Aspire 1500"),
330 		},
331 		.driver_data = keymap_acer_aspire_1500
332 	},
333 	{
334 		.callback = dmi_matched,
335 		.ident = "Acer TravelMate 240",
336 		.matches = {
337 			DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
338 			DMI_MATCH(DMI_PRODUCT_NAME, "TravelMate 240"),
339 		},
340 		.driver_data = keymap_acer_travelmate_240
341 	},
342 	{ NULL, }
343 };
344 
345 static int __init select_keymap(void)
346 {
347 	if (keymap_name != NULL) {
348 		if (strcmp (keymap_name, "1557/MS2141") == 0)
349 			keymap = keymap_wistron_ms2141;
350 		else {
351 			printk(KERN_ERR "wistron_btns: Keymap unknown\n");
352 			return -EINVAL;
353 		}
354 	}
355 	dmi_check_system(dmi_ids);
356 	if (keymap == NULL) {
357 		if (!force) {
358 			printk(KERN_ERR "wistron_btns: System unknown\n");
359 			return -ENODEV;
360 		}
361 		keymap = keymap_empty;
362 	}
363 	return 0;
364 }
365 
366  /* Input layer interface */
367 
368 static struct input_dev *input_dev;
369 
370 static int __devinit setup_input_dev(void)
371 {
372 	const struct key_entry *key;
373 	int error;
374 
375 	input_dev = input_allocate_device();
376 	if (!input_dev)
377 		return -ENOMEM;
378 
379 	input_dev->name = "Wistron laptop buttons";
380 	input_dev->phys = "wistron/input0";
381 	input_dev->id.bustype = BUS_HOST;
382 	input_dev->cdev.dev = &wistron_device->dev;
383 
384 	for (key = keymap; key->type != KE_END; key++) {
385 		if (key->type == KE_KEY) {
386 			input_dev->evbit[LONG(EV_KEY)] = BIT(EV_KEY);
387 			set_bit(key->keycode, input_dev->keybit);
388 		}
389 	}
390 
391 	error = input_register_device(input_dev);
392 	if (error) {
393 		input_free_device(input_dev);
394 		return error;
395 	}
396 
397 	return 0;
398 }
399 
400 static void report_key(unsigned keycode)
401 {
402 	input_report_key(input_dev, keycode, 1);
403 	input_sync(input_dev);
404 	input_report_key(input_dev, keycode, 0);
405 	input_sync(input_dev);
406 }
407 
408  /* Driver core */
409 
410 static int wifi_enabled;
411 static int bluetooth_enabled;
412 
413 static void poll_bios(unsigned long);
414 
415 static struct timer_list poll_timer = TIMER_INITIALIZER(poll_bios, 0, 0);
416 
417 static void handle_key(u8 code)
418 {
419 	const struct key_entry *key;
420 
421 	for (key = keymap; key->type != KE_END; key++) {
422 		if (code == key->code) {
423 			switch (key->type) {
424 			case KE_KEY:
425 				report_key(key->keycode);
426 				break;
427 
428 			case KE_WIFI:
429 				if (have_wifi) {
430 					wifi_enabled = !wifi_enabled;
431 					bios_set_state(WIFI, wifi_enabled);
432 				}
433 				break;
434 
435 			case KE_BLUETOOTH:
436 				if (have_bluetooth) {
437 					bluetooth_enabled = !bluetooth_enabled;
438 					bios_set_state(BLUETOOTH, bluetooth_enabled);
439 				}
440 				break;
441 
442 			case KE_END:
443 			default:
444 				BUG();
445 			}
446 			return;
447 		}
448 	}
449 	printk(KERN_NOTICE "wistron_btns: Unknown key code %02X\n", code);
450 }
451 
452 static void poll_bios(unsigned long discard)
453 {
454 	u8 qlen;
455 	u16 val;
456 
457 	for (;;) {
458 		qlen = CMOS_READ(cmos_address);
459 		if (qlen == 0)
460 			break;
461 		val = bios_pop_queue();
462 		if (val != 0 && !discard)
463 			handle_key((u8)val);
464 	}
465 
466 	mod_timer(&poll_timer, jiffies + HZ / POLL_FREQUENCY);
467 }
468 
469 static int __devinit wistron_probe(struct platform_device *dev)
470 {
471 	int err = setup_input_dev();
472 	if (err)
473 		return err;
474 
475 	bios_attach();
476 	cmos_address = bios_get_cmos_address();
477 
478 	if (have_wifi) {
479 		u16 wifi = bios_get_default_setting(WIFI);
480 		if (wifi & 1)
481 			wifi_enabled = (wifi & 2) ? 1 : 0;
482 		else
483 			have_wifi = 0;
484 
485 		if (have_wifi)
486 			bios_set_state(WIFI, wifi_enabled);
487 	}
488 
489 	if (have_bluetooth) {
490 		u16 bt = bios_get_default_setting(BLUETOOTH);
491 		if (bt & 1)
492 			bluetooth_enabled = (bt & 2) ? 1 : 0;
493 		else
494 			have_bluetooth = 0;
495 
496 		if (have_bluetooth)
497 			bios_set_state(BLUETOOTH, bluetooth_enabled);
498 	}
499 
500 	poll_bios(1); /* Flush stale event queue and arm timer */
501 
502 	return 0;
503 }
504 
505 static int __devexit wistron_remove(struct platform_device *dev)
506 {
507 	del_timer_sync(&poll_timer);
508 	input_unregister_device(input_dev);
509 	bios_detach();
510 
511 	return 0;
512 }
513 
514 #ifdef CONFIG_PM
515 static int wistron_suspend(struct platform_device *dev, pm_message_t state)
516 {
517 	del_timer_sync(&poll_timer);
518 
519 	if (have_wifi)
520 		bios_set_state(WIFI, 0);
521 
522 	if (have_bluetooth)
523 		bios_set_state(BLUETOOTH, 0);
524 
525 	return 0;
526 }
527 
528 static int wistron_resume(struct platform_device *dev)
529 {
530 	if (have_wifi)
531 		bios_set_state(WIFI, wifi_enabled);
532 
533 	if (have_bluetooth)
534 		bios_set_state(BLUETOOTH, bluetooth_enabled);
535 
536 	poll_bios(1);
537 
538 	return 0;
539 }
540 #else
541 #define wistron_suspend		NULL
542 #define wistron_resume		NULL
543 #endif
544 
545 static struct platform_driver wistron_driver = {
546 	.driver		= {
547 		.name	= "wistron-bios",
548 		.owner	= THIS_MODULE,
549 	},
550 	.probe		= wistron_probe,
551 	.remove		= __devexit_p(wistron_remove),
552 	.suspend	= wistron_suspend,
553 	.resume		= wistron_resume,
554 };
555 
556 static int __init wb_module_init(void)
557 {
558 	int err;
559 
560 	err = select_keymap();
561 	if (err)
562 		return err;
563 
564 	err = map_bios();
565 	if (err)
566 		return err;
567 
568 	err = platform_driver_register(&wistron_driver);
569 	if (err)
570 		goto err_unmap_bios;
571 
572 	wistron_device = platform_device_alloc("wistron-bios", -1);
573 	if (!wistron_device) {
574 		err = -ENOMEM;
575 		goto err_unregister_driver;
576 	}
577 
578 	err = platform_device_add(wistron_device);
579 	if (err)
580 		goto err_free_device;
581 
582 	return 0;
583 
584  err_free_device:
585 	platform_device_put(wistron_device);
586  err_unregister_driver:
587 	platform_driver_unregister(&wistron_driver);
588  err_unmap_bios:
589 	unmap_bios();
590 
591 	return err;
592 }
593 
594 static void __exit wb_module_exit(void)
595 {
596 	platform_device_unregister(wistron_device);
597 	platform_driver_unregister(&wistron_driver);
598 	unmap_bios();
599 }
600 
601 module_init(wb_module_init);
602 module_exit(wb_module_exit);
603