1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119#include <linux/kernel.h>
120#include <linux/module.h>
121#include <linux/init.h>
122#include <linux/types.h>
123#include <linux/backlight.h>
124#include <linux/ctype.h>
125#include <linux/seq_file.h>
126#include <linux/uaccess.h>
127#include <acpi/acpi_bus.h>
128#include <acpi/acpi_drivers.h>
129#include <linux/input.h>
130
131
132#ifndef ACPI_HOTKEY_COMPONENT
133#define ACPI_HOTKEY_COMPONENT 0x10000000
134#endif
135
136#define _COMPONENT ACPI_HOTKEY_COMPONENT
137
138MODULE_AUTHOR("Hiroshi Miura, David Bronaugh and Harald Welte");
139MODULE_DESCRIPTION("ACPI HotKey driver for Panasonic Let's Note laptops");
140MODULE_LICENSE("GPL");
141
142#define LOGPREFIX "pcc_acpi: "
143
144
145
146#define METHOD_HKEY_QUERY "HINF"
147#define METHOD_HKEY_SQTY "SQTY"
148#define METHOD_HKEY_SINF "SINF"
149#define METHOD_HKEY_SSET "SSET"
150#define HKEY_NOTIFY 0x80
151
152#define ACPI_PCC_DRIVER_NAME "Panasonic Laptop Support"
153#define ACPI_PCC_DEVICE_NAME "Hotkey"
154#define ACPI_PCC_CLASS "pcc"
155
156#define ACPI_PCC_INPUT_PHYS "panasonic/hkey0"
157
158
159
160
161enum SINF_BITS { SINF_NUM_BATTERIES = 0,
162 SINF_LCD_TYPE,
163 SINF_AC_MAX_BRIGHT,
164 SINF_AC_MIN_BRIGHT,
165 SINF_AC_CUR_BRIGHT,
166 SINF_DC_MAX_BRIGHT,
167 SINF_DC_MIN_BRIGHT,
168 SINF_DC_CUR_BRIGHT,
169 SINF_MUTE,
170 SINF_RESERVED,
171 SINF_ENV_STATE,
172 SINF_STICKY_KEY = 0x80,
173 };
174
175
176static int acpi_pcc_hotkey_add(struct acpi_device *device);
177static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type);
178static int acpi_pcc_hotkey_resume(struct acpi_device *device);
179static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event);
180
181static const struct acpi_device_id pcc_device_ids[] = {
182 { "MAT0012", 0},
183 { "MAT0013", 0},
184 { "MAT0018", 0},
185 { "MAT0019", 0},
186 { "", 0},
187};
188MODULE_DEVICE_TABLE(acpi, pcc_device_ids);
189
190static struct acpi_driver acpi_pcc_driver = {
191 .name = ACPI_PCC_DRIVER_NAME,
192 .class = ACPI_PCC_CLASS,
193 .ids = pcc_device_ids,
194 .ops = {
195 .add = acpi_pcc_hotkey_add,
196 .remove = acpi_pcc_hotkey_remove,
197 .resume = acpi_pcc_hotkey_resume,
198 .notify = acpi_pcc_hotkey_notify,
199 },
200};
201
202#define KEYMAP_SIZE 11
203static const int initial_keymap[KEYMAP_SIZE] = {
204 KEY_RESERVED,
205 KEY_BRIGHTNESSDOWN,
206 KEY_BRIGHTNESSUP,
207 KEY_DISPLAYTOGGLE,
208 KEY_MUTE,
209 KEY_VOLUMEDOWN,
210 KEY_VOLUMEUP,
211 KEY_SLEEP,
212 KEY_PROG1,
213 KEY_BATTERY,
214 KEY_SUSPEND,
215};
216
217struct pcc_acpi {
218 acpi_handle handle;
219 unsigned long num_sifr;
220 int sticky_mode;
221 u32 *sinf;
222 struct acpi_device *device;
223 struct input_dev *input_dev;
224 struct backlight_device *backlight;
225 int keymap[KEYMAP_SIZE];
226};
227
228struct pcc_keyinput {
229 struct acpi_hotkey *hotkey;
230};
231
232
233static int acpi_pcc_write_sset(struct pcc_acpi *pcc, int func, int val)
234{
235 union acpi_object in_objs[] = {
236 { .integer.type = ACPI_TYPE_INTEGER,
237 .integer.value = func, },
238 { .integer.type = ACPI_TYPE_INTEGER,
239 .integer.value = val, },
240 };
241 struct acpi_object_list params = {
242 .count = ARRAY_SIZE(in_objs),
243 .pointer = in_objs,
244 };
245 acpi_status status = AE_OK;
246
247 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SSET,
248 ¶ms, NULL);
249
250 return status == AE_OK;
251}
252
253static inline int acpi_pcc_get_sqty(struct acpi_device *device)
254{
255 unsigned long long s;
256 acpi_status status;
257
258 status = acpi_evaluate_integer(device->handle, METHOD_HKEY_SQTY,
259 NULL, &s);
260 if (ACPI_SUCCESS(status))
261 return s;
262 else {
263 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
264 "evaluation error HKEY.SQTY\n"));
265 return -EINVAL;
266 }
267}
268
269static int acpi_pcc_retrieve_biosdata(struct pcc_acpi *pcc, u32 *sinf)
270{
271 acpi_status status;
272 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
273 union acpi_object *hkey = NULL;
274 int i;
275
276 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SINF, NULL,
277 &buffer);
278 if (ACPI_FAILURE(status)) {
279 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
280 "evaluation error HKEY.SINF\n"));
281 return 0;
282 }
283
284 hkey = buffer.pointer;
285 if (!hkey || (hkey->type != ACPI_TYPE_PACKAGE)) {
286 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid HKEY.SINF\n"));
287 goto end;
288 }
289
290 if (pcc->num_sifr < hkey->package.count) {
291 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
292 "SQTY reports bad SINF length\n"));
293 status = AE_ERROR;
294 goto end;
295 }
296
297 for (i = 0; i < hkey->package.count; i++) {
298 union acpi_object *element = &(hkey->package.elements[i]);
299 if (likely(element->type == ACPI_TYPE_INTEGER)) {
300 sinf[i] = element->integer.value;
301 } else
302 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
303 "Invalid HKEY.SINF data\n"));
304 }
305 sinf[hkey->package.count] = -1;
306
307end:
308 kfree(buffer.pointer);
309 return status == AE_OK;
310}
311
312
313
314
315
316
317
318
319static int bl_get(struct backlight_device *bd)
320{
321 struct pcc_acpi *pcc = bl_get_data(bd);
322
323 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
324 return -EIO;
325
326 return pcc->sinf[SINF_AC_CUR_BRIGHT];
327}
328
329static int bl_set_status(struct backlight_device *bd)
330{
331 struct pcc_acpi *pcc = bl_get_data(bd);
332 int bright = bd->props.brightness;
333 int rc;
334
335 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
336 return -EIO;
337
338 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT])
339 bright = pcc->sinf[SINF_AC_MIN_BRIGHT];
340
341 if (bright < pcc->sinf[SINF_DC_MIN_BRIGHT])
342 bright = pcc->sinf[SINF_DC_MIN_BRIGHT];
343
344 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT] ||
345 bright > pcc->sinf[SINF_AC_MAX_BRIGHT])
346 return -EINVAL;
347
348 rc = acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, bright);
349 if (rc < 0)
350 return rc;
351
352 return acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, bright);
353}
354
355static struct backlight_ops pcc_backlight_ops = {
356 .get_brightness = bl_get,
357 .update_status = bl_set_status,
358};
359
360
361
362
363static ssize_t show_numbatt(struct device *dev, struct device_attribute *attr,
364 char *buf)
365{
366 struct acpi_device *acpi = to_acpi_device(dev);
367 struct pcc_acpi *pcc = acpi_driver_data(acpi);
368
369 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
370 return -EIO;
371
372 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_NUM_BATTERIES]);
373}
374
375static ssize_t show_lcdtype(struct device *dev, struct device_attribute *attr,
376 char *buf)
377{
378 struct acpi_device *acpi = to_acpi_device(dev);
379 struct pcc_acpi *pcc = acpi_driver_data(acpi);
380
381 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
382 return -EIO;
383
384 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_LCD_TYPE]);
385}
386
387static ssize_t show_mute(struct device *dev, struct device_attribute *attr,
388 char *buf)
389{
390 struct acpi_device *acpi = to_acpi_device(dev);
391 struct pcc_acpi *pcc = acpi_driver_data(acpi);
392
393 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
394 return -EIO;
395
396 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_MUTE]);
397}
398
399static ssize_t show_sticky(struct device *dev, struct device_attribute *attr,
400 char *buf)
401{
402 struct acpi_device *acpi = to_acpi_device(dev);
403 struct pcc_acpi *pcc = acpi_driver_data(acpi);
404
405 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
406 return -EIO;
407
408 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_STICKY_KEY]);
409}
410
411static ssize_t set_sticky(struct device *dev, struct device_attribute *attr,
412 const char *buf, size_t count)
413{
414 struct acpi_device *acpi = to_acpi_device(dev);
415 struct pcc_acpi *pcc = acpi_driver_data(acpi);
416 int val;
417
418 if (count && sscanf(buf, "%i", &val) == 1 &&
419 (val == 0 || val == 1)) {
420 acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, val);
421 pcc->sticky_mode = val;
422 }
423
424 return count;
425}
426
427static DEVICE_ATTR(numbatt, S_IRUGO, show_numbatt, NULL);
428static DEVICE_ATTR(lcdtype, S_IRUGO, show_lcdtype, NULL);
429static DEVICE_ATTR(mute, S_IRUGO, show_mute, NULL);
430static DEVICE_ATTR(sticky_key, S_IRUGO | S_IWUSR, show_sticky, set_sticky);
431
432static struct attribute *pcc_sysfs_entries[] = {
433 &dev_attr_numbatt.attr,
434 &dev_attr_lcdtype.attr,
435 &dev_attr_mute.attr,
436 &dev_attr_sticky_key.attr,
437 NULL,
438};
439
440static struct attribute_group pcc_attr_group = {
441 .name = NULL,
442 .attrs = pcc_sysfs_entries,
443};
444
445
446
447
448static int pcc_getkeycode(struct input_dev *dev, int scancode, int *keycode)
449{
450 struct pcc_acpi *pcc = input_get_drvdata(dev);
451
452 if (scancode >= ARRAY_SIZE(pcc->keymap))
453 return -EINVAL;
454
455 *keycode = pcc->keymap[scancode];
456
457 return 0;
458}
459
460static int keymap_get_by_keycode(struct pcc_acpi *pcc, int keycode)
461{
462 int i;
463
464 for (i = 0; i < ARRAY_SIZE(pcc->keymap); i++) {
465 if (pcc->keymap[i] == keycode)
466 return i+1;
467 }
468
469 return 0;
470}
471
472static int pcc_setkeycode(struct input_dev *dev, int scancode, int keycode)
473{
474 struct pcc_acpi *pcc = input_get_drvdata(dev);
475 int oldkeycode;
476
477 if (scancode >= ARRAY_SIZE(pcc->keymap))
478 return -EINVAL;
479
480 if (keycode < 0 || keycode > KEY_MAX)
481 return -EINVAL;
482
483 oldkeycode = pcc->keymap[scancode];
484 pcc->keymap[scancode] = keycode;
485
486 set_bit(keycode, dev->keybit);
487
488 if (!keymap_get_by_keycode(pcc, oldkeycode))
489 clear_bit(oldkeycode, dev->keybit);
490
491 return 0;
492}
493
494static void acpi_pcc_generate_keyinput(struct pcc_acpi *pcc)
495{
496 struct input_dev *hotk_input_dev = pcc->input_dev;
497 int rc;
498 int key_code, hkey_num;
499 unsigned long long result;
500
501 rc = acpi_evaluate_integer(pcc->handle, METHOD_HKEY_QUERY,
502 NULL, &result);
503 if (!ACPI_SUCCESS(rc)) {
504 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
505 "error getting hotkey status\n"));
506 return;
507 }
508
509 acpi_bus_generate_proc_event(pcc->device, HKEY_NOTIFY, result);
510
511 hkey_num = result & 0xf;
512
513 if (hkey_num < 0 || hkey_num >= ARRAY_SIZE(pcc->keymap)) {
514 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
515 "hotkey number out of range: %d\n",
516 hkey_num));
517 return;
518 }
519
520 key_code = pcc->keymap[hkey_num];
521
522 if (key_code != KEY_RESERVED) {
523 int pushed = (result & 0x80) ? TRUE : FALSE;
524
525 input_report_key(hotk_input_dev, key_code, pushed);
526 input_sync(hotk_input_dev);
527 }
528
529 return;
530}
531
532static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event)
533{
534 struct pcc_acpi *pcc = acpi_driver_data(device);
535
536 switch (event) {
537 case HKEY_NOTIFY:
538 acpi_pcc_generate_keyinput(pcc);
539 break;
540 default:
541
542 break;
543 }
544}
545
546static int acpi_pcc_init_input(struct pcc_acpi *pcc)
547{
548 int i, rc;
549
550 pcc->input_dev = input_allocate_device();
551 if (!pcc->input_dev) {
552 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
553 "Couldn't allocate input device for hotkey"));
554 return -ENOMEM;
555 }
556
557 pcc->input_dev->evbit[0] = BIT(EV_KEY);
558
559 pcc->input_dev->name = ACPI_PCC_DRIVER_NAME;
560 pcc->input_dev->phys = ACPI_PCC_INPUT_PHYS;
561 pcc->input_dev->id.bustype = BUS_HOST;
562 pcc->input_dev->id.vendor = 0x0001;
563 pcc->input_dev->id.product = 0x0001;
564 pcc->input_dev->id.version = 0x0100;
565 pcc->input_dev->getkeycode = pcc_getkeycode;
566 pcc->input_dev->setkeycode = pcc_setkeycode;
567
568
569 memcpy(pcc->keymap, initial_keymap, sizeof(pcc->keymap));
570
571 for (i = 0; i < ARRAY_SIZE(pcc->keymap); i++)
572 __set_bit(pcc->keymap[i], pcc->input_dev->keybit);
573 __clear_bit(KEY_RESERVED, pcc->input_dev->keybit);
574
575 input_set_drvdata(pcc->input_dev, pcc);
576
577 rc = input_register_device(pcc->input_dev);
578 if (rc < 0)
579 input_free_device(pcc->input_dev);
580
581 return rc;
582}
583
584
585
586static int acpi_pcc_hotkey_resume(struct acpi_device *device)
587{
588 struct pcc_acpi *pcc = acpi_driver_data(device);
589 acpi_status status = AE_OK;
590
591 if (device == NULL || pcc == NULL)
592 return -EINVAL;
593
594 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Sticky mode restore: %d\n",
595 pcc->sticky_mode));
596
597 status = acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, pcc->sticky_mode);
598
599 return status == AE_OK ? 0 : -EINVAL;
600}
601
602static int acpi_pcc_hotkey_add(struct acpi_device *device)
603{
604 struct pcc_acpi *pcc;
605 int num_sifr, result;
606
607 if (!device)
608 return -EINVAL;
609
610 num_sifr = acpi_pcc_get_sqty(device);
611
612 if (num_sifr > 255) {
613 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "num_sifr too large"));
614 return -ENODEV;
615 }
616
617 pcc = kzalloc(sizeof(struct pcc_acpi), GFP_KERNEL);
618 if (!pcc) {
619 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
620 "Couldn't allocate mem for pcc"));
621 return -ENOMEM;
622 }
623
624 pcc->sinf = kzalloc(sizeof(u32) * (num_sifr + 1), GFP_KERNEL);
625 if (!pcc->sinf) {
626 result = -ENOMEM;
627 goto out_hotkey;
628 }
629
630 pcc->device = device;
631 pcc->handle = device->handle;
632 pcc->num_sifr = num_sifr;
633 device->driver_data = pcc;
634 strcpy(acpi_device_name(device), ACPI_PCC_DEVICE_NAME);
635 strcpy(acpi_device_class(device), ACPI_PCC_CLASS);
636
637 result = acpi_pcc_init_input(pcc);
638 if (result) {
639 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
640 "Error installing keyinput handler\n"));
641 goto out_sinf;
642 }
643
644
645 pcc->backlight = backlight_device_register("panasonic", NULL, pcc,
646 &pcc_backlight_ops);
647 if (IS_ERR(pcc->backlight))
648 goto out_input;
649
650 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf)) {
651 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
652 "Couldn't retrieve BIOS data\n"));
653 goto out_backlight;
654 }
655
656
657 pcc->backlight->props.max_brightness =
658 pcc->sinf[SINF_AC_MAX_BRIGHT];
659 pcc->backlight->props.brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
660
661
662 pcc->sticky_mode = pcc->sinf[SINF_STICKY_KEY];
663
664
665 result = sysfs_create_group(&device->dev.kobj, &pcc_attr_group);
666 if (result)
667 goto out_backlight;
668
669 return 0;
670
671out_backlight:
672 backlight_device_unregister(pcc->backlight);
673out_input:
674 input_unregister_device(pcc->input_dev);
675
676
677out_sinf:
678 kfree(pcc->sinf);
679out_hotkey:
680 kfree(pcc);
681
682 return result;
683}
684
685static int __init acpi_pcc_init(void)
686{
687 int result = 0;
688
689 if (acpi_disabled)
690 return -ENODEV;
691
692 result = acpi_bus_register_driver(&acpi_pcc_driver);
693 if (result < 0) {
694 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
695 "Error registering hotkey driver\n"));
696 return -ENODEV;
697 }
698
699 return 0;
700}
701
702static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type)
703{
704 struct pcc_acpi *pcc = acpi_driver_data(device);
705
706 if (!device || !pcc)
707 return -EINVAL;
708
709 sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);
710
711 backlight_device_unregister(pcc->backlight);
712
713 input_unregister_device(pcc->input_dev);
714
715
716
717 kfree(pcc->sinf);
718 kfree(pcc);
719
720 return 0;
721}
722
723static void __exit acpi_pcc_exit(void)
724{
725 acpi_bus_unregister_driver(&acpi_pcc_driver);
726}
727
728module_init(acpi_pcc_init);
729module_exit(acpi_pcc_exit);
730