]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/input/misc/wistron_btns.c
Input: wistron - add PM support
[mirror_ubuntu-bionic-kernel.git] / drivers / input / misc / wistron_btns.c
CommitLineData
5fc14680
DT
1/*
2 * Wistron laptop button driver
3 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
84b256a6 4 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
a5b0cc80 5 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
5fc14680
DT
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>
a5b0cc80 32#include <linux/platform_device.h>
5fc14680
DT
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
84b256a6
BR
46/* BIOS subsystem IDs */
47#define WIFI 0x35
48#define BLUETOOTH 0x34
49
5fc14680
DT
50MODULE_AUTHOR("Miloslav Trmac <mitr@volny.cz>");
51MODULE_DESCRIPTION("Wistron laptop button driver");
52MODULE_LICENSE("GPL v2");
53MODULE_VERSION("0.1");
54
55static int force; /* = 0; */
56module_param(force, bool, 0);
57MODULE_PARM_DESC(force, "Load even if computer is not in database");
58
59static char *keymap_name; /* = NULL; */
60module_param_named(keymap, keymap_name, charp, 0);
61MODULE_PARM_DESC(keymap, "Keymap name, if it can't be autodetected");
62
a5b0cc80
DT
63static struct platform_device *wistron_device;
64
5fc14680
DT
65 /* BIOS interface implementation */
66
67static void __iomem *bios_entry_point; /* BIOS routine entry point */
68static void __iomem *bios_code_map_base;
69static void __iomem *bios_data_map_base;
70
71static u8 cmos_address;
72
73struct regs {
74 u32 eax, ebx, ecx;
75};
76
77static 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
95static 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
109static 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
150err_code:
151 iounmap(bios_code_map_base);
152err:
153 return -ENOMEM;
154}
155
22a397e2 156static inline void unmap_bios(void)
5fc14680
DT
157{
158 iounmap(bios_code_map_base);
159 iounmap(bios_data_map_base);
160}
161
162 /* BIOS calls */
163
164static 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
177static void __init 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
22a397e2 187static void bios_detach(void)
5fc14680
DT
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
197static u8 __init 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
84b256a6 209static u16 __init bios_get_default_setting(u8 subsys)
5fc14680
DT
210{
211 struct regs regs;
212
213 memset(&regs, 0, sizeof (regs));
214 regs.eax = 0x9610;
84b256a6 215 regs.ebx = 0x0200 | subsys;
5fc14680
DT
216 call_bios(&regs);
217
218 return regs.eax;
219}
220
84b256a6 221static void bios_set_state(u8 subsys, int enable)
5fc14680
DT
222{
223 struct regs regs;
224
225 memset(&regs, 0, sizeof (regs));
226 regs.eax = 0x9610;
84b256a6 227 regs.ebx = (enable ? 0x0100 : 0x0000) | subsys;
5fc14680
DT
228 call_bios(&regs);
229}
230
84b256a6 231/* Hardware database */
5fc14680
DT
232
233struct key_entry {
234 char type; /* See KE_* below */
235 u8 code;
236 unsigned keycode; /* For KE_KEY */
237};
238
84b256a6 239enum { KE_END, KE_KEY, KE_WIFI, KE_BLUETOOTH };
5fc14680
DT
240
241static const struct key_entry *keymap; /* = NULL; Current key map */
242static int have_wifi;
84b256a6 243static int have_bluetooth;
5fc14680
DT
244
245static 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;
84b256a6
BR
254 } else if (key->type == KE_BLUETOOTH) {
255 have_bluetooth = 1;
256 break;
5fc14680
DT
257 }
258 }
259 return 1;
260}
261
262static struct key_entry keymap_empty[] = {
263 { KE_END, 0 }
264};
265
266static 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
276static 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
84b256a6
BR
289static 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
5fc14680
DT
299/*
300 * If your machine is not here (which is currently rather likely), please send
301 * a list of buttons and their key codes (reported when loading this module
302 * with force=1) and the output of dmidecode to $MODULE_AUTHOR.
303 */
304static struct dmi_system_id dmi_ids[] = {
305 {
306 .callback = dmi_matched,
307 .ident = "Fujitsu-Siemens Amilo Pro V2000",
308 .matches = {
309 DMI_MATCH(DMI_SYS_VENDOR, "FUJITSU SIEMENS"),
310 DMI_MATCH(DMI_PRODUCT_NAME, "AMILO Pro V2000"),
311 },
312 .driver_data = keymap_fs_amilo_pro_v2000
313 },
84b256a6
BR
314 {
315 .callback = dmi_matched,
316 .ident = "Acer Aspire 1500",
317 .matches = {
318 DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
319 DMI_MATCH(DMI_PRODUCT_NAME, "Aspire 1500"),
320 },
321 .driver_data = keymap_acer_aspire_1500
322 },
5fc14680
DT
323 { 0, }
324};
325
326static int __init select_keymap(void)
327{
328 if (keymap_name != NULL) {
329 if (strcmp (keymap_name, "1557/MS2141") == 0)
330 keymap = keymap_wistron_ms2141;
331 else {
332 printk(KERN_ERR "wistron_btns: Keymap unknown\n");
333 return -EINVAL;
334 }
335 }
336 dmi_check_system(dmi_ids);
337 if (keymap == NULL) {
338 if (!force) {
339 printk(KERN_ERR "wistron_btns: System unknown\n");
340 return -ENODEV;
341 }
342 keymap = keymap_empty;
343 }
344 return 0;
345}
346
347 /* Input layer interface */
348
22a397e2 349static struct input_dev *input_dev;
5fc14680 350
22a397e2 351static int __init setup_input_dev(void)
5fc14680
DT
352{
353 const struct key_entry *key;
22a397e2
DT
354 int error;
355
356 input_dev = input_allocate_device();
357 if (!input_dev)
358 return -ENOMEM;
359
360 input_dev->name = "Wistron laptop buttons";
361 input_dev->phys = "wistron/input0";
362 input_dev->id.bustype = BUS_HOST;
a5b0cc80 363 input_dev->cdev.dev = &wistron_device->dev;
5fc14680
DT
364
365 for (key = keymap; key->type != KE_END; key++) {
366 if (key->type == KE_KEY) {
22a397e2
DT
367 input_dev->evbit[LONG(EV_KEY)] = BIT(EV_KEY);
368 set_bit(key->keycode, input_dev->keybit);
5fc14680
DT
369 }
370 }
371
22a397e2
DT
372 error = input_register_device(input_dev);
373 if (error) {
374 input_free_device(input_dev);
375 return error;
376 }
377
378 return 0;
5fc14680
DT
379}
380
381static void report_key(unsigned keycode)
382{
22a397e2
DT
383 input_report_key(input_dev, keycode, 1);
384 input_sync(input_dev);
385 input_report_key(input_dev, keycode, 0);
386 input_sync(input_dev);
5fc14680
DT
387}
388
389 /* Driver core */
390
391static int wifi_enabled;
84b256a6 392static int bluetooth_enabled;
5fc14680
DT
393
394static void poll_bios(unsigned long);
395
396static struct timer_list poll_timer = TIMER_INITIALIZER(poll_bios, 0, 0);
397
398static void handle_key(u8 code)
399{
400 const struct key_entry *key;
401
402 for (key = keymap; key->type != KE_END; key++) {
403 if (code == key->code) {
404 switch (key->type) {
405 case KE_KEY:
406 report_key(key->keycode);
407 break;
408
409 case KE_WIFI:
410 if (have_wifi) {
411 wifi_enabled = !wifi_enabled;
84b256a6
BR
412 bios_set_state(WIFI, wifi_enabled);
413 }
414 break;
415
416 case KE_BLUETOOTH:
417 if (have_bluetooth) {
418 bluetooth_enabled = !bluetooth_enabled;
419 bios_set_state(BLUETOOTH, bluetooth_enabled);
5fc14680
DT
420 }
421 break;
422
423 case KE_END:
424 default:
425 BUG();
426 }
427 return;
428 }
429 }
430 printk(KERN_NOTICE "wistron_btns: Unknown key code %02X\n", code);
431}
432
433static void poll_bios(unsigned long discard)
434{
435 u8 qlen;
436 u16 val;
437
438 for (;;) {
439 qlen = CMOS_READ(cmos_address);
440 if (qlen == 0)
441 break;
442 val = bios_pop_queue();
443 if (val != 0 && !discard)
444 handle_key((u8)val);
445 }
446
447 mod_timer(&poll_timer, jiffies + HZ / POLL_FREQUENCY);
448}
449
a5b0cc80
DT
450static int wistron_suspend(struct platform_device *dev, pm_message_t state)
451{
452 del_timer_sync(&poll_timer);
453
454 return 0;
455}
456
457static int wistron_resume(struct platform_device *dev)
458{
459 if (have_wifi)
460 bios_set_state(WIFI, wifi_enabled);
461
462 if (have_bluetooth)
463 bios_set_state(BLUETOOTH, bluetooth_enabled);
464
465 poll_bios(1);
466
467 return 0;
468}
469
470static struct platform_driver wistron_driver = {
471 .suspend = wistron_suspend,
472 .resume = wistron_resume,
473 .driver = {
474 .name = "wistron-bios",
475 },
476};
477
5fc14680
DT
478static int __init wb_module_init(void)
479{
480 int err;
481
482 err = select_keymap();
483 if (err)
484 return err;
22a397e2 485
5fc14680
DT
486 err = map_bios();
487 if (err)
488 return err;
22a397e2 489
5fc14680
DT
490 bios_attach();
491 cmos_address = bios_get_cmos_address();
22a397e2 492
a5b0cc80
DT
493 err = platform_driver_register(&wistron_driver);
494 if (err)
495 goto err_detach_bios;
496
497 wistron_device = platform_device_register_simple("wistron-bios", -1, NULL, 0);
498 if (IS_ERR(wistron_device)) {
499 err = PTR_ERR(wistron_device);
500 goto err_unregister_driver;
501 }
502
5fc14680 503 if (have_wifi) {
84b256a6
BR
504 u16 wifi = bios_get_default_setting(WIFI);
505 if (wifi & 1)
506 wifi_enabled = (wifi & 2) ? 1 : 0;
507 else
5fc14680 508 have_wifi = 0;
84b256a6 509
5fc14680 510 if (have_wifi)
84b256a6
BR
511 bios_set_state(WIFI, wifi_enabled);
512 }
22a397e2 513
84b256a6
BR
514 if (have_bluetooth) {
515 u16 bt = bios_get_default_setting(BLUETOOTH);
516 if (bt & 1)
517 bluetooth_enabled = (bt & 2) ? 1 : 0;
518 else
519 have_bluetooth = 0;
520
521 if (have_bluetooth)
522 bios_set_state(BLUETOOTH, bluetooth_enabled);
5fc14680
DT
523 }
524
22a397e2 525 err = setup_input_dev();
a5b0cc80
DT
526 if (err)
527 goto err_unregister_device;
5fc14680
DT
528
529 poll_bios(1); /* Flush stale event queue and arm timer */
530
531 return 0;
a5b0cc80
DT
532
533 err_unregister_device:
534 platform_device_unregister(wistron_device);
535 err_unregister_driver:
536 platform_driver_unregister(&wistron_driver);
537 err_detach_bios:
538 bios_detach();
539 unmap_bios();
540
541 return err;
5fc14680
DT
542}
543
544static void __exit wb_module_exit(void)
545{
546 del_timer_sync(&poll_timer);
22a397e2 547 input_unregister_device(input_dev);
a5b0cc80
DT
548 platform_device_unregister(wistron_device);
549 platform_driver_unregister(&wistron_driver);
5fc14680
DT
550 bios_detach();
551 unmap_bios();
552}
553
554module_init(wb_module_init);
555module_exit(wb_module_exit);