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 <linux/slab.h>
128#include <acpi/acpi_bus.h>
129#include <acpi/acpi_drivers.h>
130#include <linux/input.h>
131#include <linux/input/sparse-keymap.h>
132
133
134#ifndef ACPI_HOTKEY_COMPONENT
135#define ACPI_HOTKEY_COMPONENT 0x10000000
136#endif
137
138#define _COMPONENT ACPI_HOTKEY_COMPONENT
139
140MODULE_AUTHOR("Hiroshi Miura, David Bronaugh and Harald Welte");
141MODULE_DESCRIPTION("ACPI HotKey driver for Panasonic Let's Note laptops");
142MODULE_LICENSE("GPL");
143
144#define LOGPREFIX "pcc_acpi: "
145
146
147
148#define METHOD_HKEY_QUERY "HINF"
149#define METHOD_HKEY_SQTY "SQTY"
150#define METHOD_HKEY_SINF "SINF"
151#define METHOD_HKEY_SSET "SSET"
152#define HKEY_NOTIFY 0x80
153
154#define ACPI_PCC_DRIVER_NAME "Panasonic Laptop Support"
155#define ACPI_PCC_DEVICE_NAME "Hotkey"
156#define ACPI_PCC_CLASS "pcc"
157
158#define ACPI_PCC_INPUT_PHYS "panasonic/hkey0"
159
160
161
162
163enum SINF_BITS { SINF_NUM_BATTERIES = 0,
164 SINF_LCD_TYPE,
165 SINF_AC_MAX_BRIGHT,
166 SINF_AC_MIN_BRIGHT,
167 SINF_AC_CUR_BRIGHT,
168 SINF_DC_MAX_BRIGHT,
169 SINF_DC_MIN_BRIGHT,
170 SINF_DC_CUR_BRIGHT,
171 SINF_MUTE,
172 SINF_RESERVED,
173 SINF_ENV_STATE,
174 SINF_STICKY_KEY = 0x80,
175 };
176
177
178static int acpi_pcc_hotkey_add(struct acpi_device *device);
179static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type);
180static int acpi_pcc_hotkey_resume(struct acpi_device *device);
181static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event);
182
183static const struct acpi_device_id pcc_device_ids[] = {
184 { "MAT0012", 0},
185 { "MAT0013", 0},
186 { "MAT0018", 0},
187 { "MAT0019", 0},
188 { "", 0},
189};
190MODULE_DEVICE_TABLE(acpi, pcc_device_ids);
191
192static struct acpi_driver acpi_pcc_driver = {
193 .name = ACPI_PCC_DRIVER_NAME,
194 .class = ACPI_PCC_CLASS,
195 .ids = pcc_device_ids,
196 .ops = {
197 .add = acpi_pcc_hotkey_add,
198 .remove = acpi_pcc_hotkey_remove,
199 .resume = acpi_pcc_hotkey_resume,
200 .notify = acpi_pcc_hotkey_notify,
201 },
202};
203
204static const struct key_entry panasonic_keymap[] = {
205 { KE_KEY, 0, { KEY_RESERVED } },
206 { KE_KEY, 1, { KEY_BRIGHTNESSDOWN } },
207 { KE_KEY, 2, { KEY_BRIGHTNESSUP } },
208 { KE_KEY, 3, { KEY_DISPLAYTOGGLE } },
209 { KE_KEY, 4, { KEY_MUTE } },
210 { KE_KEY, 5, { KEY_VOLUMEDOWN } },
211 { KE_KEY, 6, { KEY_VOLUMEUP } },
212 { KE_KEY, 7, { KEY_SLEEP } },
213 { KE_KEY, 8, { KEY_PROG1 } },
214 { KE_KEY, 9, { KEY_BATTERY } },
215 { KE_KEY, 10, { KEY_SUSPEND } },
216 { KE_END, 0 }
217};
218
219struct pcc_acpi {
220 acpi_handle handle;
221 unsigned long num_sifr;
222 int sticky_mode;
223 u32 *sinf;
224 struct acpi_device *device;
225 struct input_dev *input_dev;
226 struct backlight_device *backlight;
227};
228
229struct pcc_keyinput {
230 struct acpi_hotkey *hotkey;
231};
232
233
234static int acpi_pcc_write_sset(struct pcc_acpi *pcc, int func, int val)
235{
236 union acpi_object in_objs[] = {
237 { .integer.type = ACPI_TYPE_INTEGER,
238 .integer.value = func, },
239 { .integer.type = ACPI_TYPE_INTEGER,
240 .integer.value = val, },
241 };
242 struct acpi_object_list params = {
243 .count = ARRAY_SIZE(in_objs),
244 .pointer = in_objs,
245 };
246 acpi_status status = AE_OK;
247
248 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SSET,
249 ¶ms, NULL);
250
251 return (status == AE_OK) ? 0 : -EIO;
252}
253
254static inline int acpi_pcc_get_sqty(struct acpi_device *device)
255{
256 unsigned long long s;
257 acpi_status status;
258
259 status = acpi_evaluate_integer(device->handle, METHOD_HKEY_SQTY,
260 NULL, &s);
261 if (ACPI_SUCCESS(status))
262 return s;
263 else {
264 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
265 "evaluation error HKEY.SQTY\n"));
266 return -EINVAL;
267 }
268}
269
270static int acpi_pcc_retrieve_biosdata(struct pcc_acpi *pcc)
271{
272 acpi_status status;
273 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
274 union acpi_object *hkey = NULL;
275 int i;
276
277 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SINF, NULL,
278 &buffer);
279 if (ACPI_FAILURE(status)) {
280 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
281 "evaluation error HKEY.SINF\n"));
282 return 0;
283 }
284
285 hkey = buffer.pointer;
286 if (!hkey || (hkey->type != ACPI_TYPE_PACKAGE)) {
287 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid HKEY.SINF\n"));
288 status = AE_ERROR;
289 goto end;
290 }
291
292 if (pcc->num_sifr < hkey->package.count) {
293 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
294 "SQTY reports bad SINF length\n"));
295 status = AE_ERROR;
296 goto end;
297 }
298
299 for (i = 0; i < hkey->package.count; i++) {
300 union acpi_object *element = &(hkey->package.elements[i]);
301 if (likely(element->type == ACPI_TYPE_INTEGER)) {
302 pcc->sinf[i] = element->integer.value;
303 } else
304 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
305 "Invalid HKEY.SINF data\n"));
306 }
307 pcc->sinf[hkey->package.count] = -1;
308
309end:
310 kfree(buffer.pointer);
311 return status == AE_OK;
312}
313
314
315
316
317
318
319
320
321static int bl_get(struct backlight_device *bd)
322{
323 struct pcc_acpi *pcc = bl_get_data(bd);
324
325 if (!acpi_pcc_retrieve_biosdata(pcc))
326 return -EIO;
327
328 return pcc->sinf[SINF_AC_CUR_BRIGHT];
329}
330
331static int bl_set_status(struct backlight_device *bd)
332{
333 struct pcc_acpi *pcc = bl_get_data(bd);
334 int bright = bd->props.brightness;
335 int rc;
336
337 if (!acpi_pcc_retrieve_biosdata(pcc))
338 return -EIO;
339
340 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT])
341 bright = pcc->sinf[SINF_AC_MIN_BRIGHT];
342
343 if (bright < pcc->sinf[SINF_DC_MIN_BRIGHT])
344 bright = pcc->sinf[SINF_DC_MIN_BRIGHT];
345
346 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT] ||
347 bright > pcc->sinf[SINF_AC_MAX_BRIGHT])
348 return -EINVAL;
349
350 rc = acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, bright);
351 if (rc < 0)
352 return rc;
353
354 return acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, bright);
355}
356
357static const struct backlight_ops pcc_backlight_ops = {
358 .get_brightness = bl_get,
359 .update_status = bl_set_status,
360};
361
362
363
364
365static ssize_t show_numbatt(struct device *dev, struct device_attribute *attr,
366 char *buf)
367{
368 struct acpi_device *acpi = to_acpi_device(dev);
369 struct pcc_acpi *pcc = acpi_driver_data(acpi);
370
371 if (!acpi_pcc_retrieve_biosdata(pcc))
372 return -EIO;
373
374 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_NUM_BATTERIES]);
375}
376
377static ssize_t show_lcdtype(struct device *dev, struct device_attribute *attr,
378 char *buf)
379{
380 struct acpi_device *acpi = to_acpi_device(dev);
381 struct pcc_acpi *pcc = acpi_driver_data(acpi);
382
383 if (!acpi_pcc_retrieve_biosdata(pcc))
384 return -EIO;
385
386 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_LCD_TYPE]);
387}
388
389static ssize_t show_mute(struct device *dev, struct device_attribute *attr,
390 char *buf)
391{
392 struct acpi_device *acpi = to_acpi_device(dev);
393 struct pcc_acpi *pcc = acpi_driver_data(acpi);
394
395 if (!acpi_pcc_retrieve_biosdata(pcc))
396 return -EIO;
397
398 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_MUTE]);
399}
400
401static ssize_t show_sticky(struct device *dev, struct device_attribute *attr,
402 char *buf)
403{
404 struct acpi_device *acpi = to_acpi_device(dev);
405 struct pcc_acpi *pcc = acpi_driver_data(acpi);
406
407 if (!acpi_pcc_retrieve_biosdata(pcc))
408 return -EIO;
409
410 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_STICKY_KEY]);
411}
412
413static ssize_t set_sticky(struct device *dev, struct device_attribute *attr,
414 const char *buf, size_t count)
415{
416 struct acpi_device *acpi = to_acpi_device(dev);
417 struct pcc_acpi *pcc = acpi_driver_data(acpi);
418 int val;
419
420 if (count && sscanf(buf, "%i", &val) == 1 &&
421 (val == 0 || val == 1)) {
422 acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, val);
423 pcc->sticky_mode = val;
424 }
425
426 return count;
427}
428
429static DEVICE_ATTR(numbatt, S_IRUGO, show_numbatt, NULL);
430static DEVICE_ATTR(lcdtype, S_IRUGO, show_lcdtype, NULL);
431static DEVICE_ATTR(mute, S_IRUGO, show_mute, NULL);
432static DEVICE_ATTR(sticky_key, S_IRUGO | S_IWUSR, show_sticky, set_sticky);
433
434static struct attribute *pcc_sysfs_entries[] = {
435 &dev_attr_numbatt.attr,
436 &dev_attr_lcdtype.attr,
437 &dev_attr_mute.attr,
438 &dev_attr_sticky_key.attr,
439 NULL,
440};
441
442static struct attribute_group pcc_attr_group = {
443 .name = NULL,
444 .attrs = pcc_sysfs_entries,
445};
446
447
448
449
450static void acpi_pcc_generate_keyinput(struct pcc_acpi *pcc)
451{
452 struct input_dev *hotk_input_dev = pcc->input_dev;
453 int rc;
454 unsigned long long result;
455
456 rc = acpi_evaluate_integer(pcc->handle, METHOD_HKEY_QUERY,
457 NULL, &result);
458 if (!ACPI_SUCCESS(rc)) {
459 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
460 "error getting hotkey status\n"));
461 return;
462 }
463
464 acpi_bus_generate_proc_event(pcc->device, HKEY_NOTIFY, result);
465
466 if (!sparse_keymap_report_event(hotk_input_dev,
467 result & 0xf, result & 0x80, false))
468 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
469 "Unknown hotkey event: %d\n", result));
470}
471
472static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event)
473{
474 struct pcc_acpi *pcc = acpi_driver_data(device);
475
476 switch (event) {
477 case HKEY_NOTIFY:
478 acpi_pcc_generate_keyinput(pcc);
479 break;
480 default:
481
482 break;
483 }
484}
485
486static int acpi_pcc_init_input(struct pcc_acpi *pcc)
487{
488 struct input_dev *input_dev;
489 int error;
490
491 input_dev = input_allocate_device();
492 if (!input_dev) {
493 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
494 "Couldn't allocate input device for hotkey"));
495 return -ENOMEM;
496 }
497
498 input_dev->name = ACPI_PCC_DRIVER_NAME;
499 input_dev->phys = ACPI_PCC_INPUT_PHYS;
500 input_dev->id.bustype = BUS_HOST;
501 input_dev->id.vendor = 0x0001;
502 input_dev->id.product = 0x0001;
503 input_dev->id.version = 0x0100;
504
505 error = sparse_keymap_setup(input_dev, panasonic_keymap, NULL);
506 if (error) {
507 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
508 "Unable to setup input device keymap\n"));
509 goto err_free_dev;
510 }
511
512 error = input_register_device(input_dev);
513 if (error) {
514 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
515 "Unable to register input device\n"));
516 goto err_free_keymap;
517 }
518
519 pcc->input_dev = input_dev;
520 return 0;
521
522 err_free_keymap:
523 sparse_keymap_free(input_dev);
524 err_free_dev:
525 input_free_device(input_dev);
526 return error;
527}
528
529static void acpi_pcc_destroy_input(struct pcc_acpi *pcc)
530{
531 sparse_keymap_free(pcc->input_dev);
532 input_unregister_device(pcc->input_dev);
533
534
535
536
537}
538
539
540
541static int acpi_pcc_hotkey_resume(struct acpi_device *device)
542{
543 struct pcc_acpi *pcc = acpi_driver_data(device);
544
545 if (device == NULL || pcc == NULL)
546 return -EINVAL;
547
548 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Sticky mode restore: %d\n",
549 pcc->sticky_mode));
550
551 return acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, pcc->sticky_mode);
552}
553
554static int acpi_pcc_hotkey_add(struct acpi_device *device)
555{
556 struct backlight_properties props;
557 struct pcc_acpi *pcc;
558 int num_sifr, result;
559
560 if (!device)
561 return -EINVAL;
562
563 num_sifr = acpi_pcc_get_sqty(device);
564
565 if (num_sifr < 0 || num_sifr > 255) {
566 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "num_sifr out of range"));
567 return -ENODEV;
568 }
569
570 pcc = kzalloc(sizeof(struct pcc_acpi), GFP_KERNEL);
571 if (!pcc) {
572 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
573 "Couldn't allocate mem for pcc"));
574 return -ENOMEM;
575 }
576
577 pcc->sinf = kzalloc(sizeof(u32) * (num_sifr + 1), GFP_KERNEL);
578 if (!pcc->sinf) {
579 result = -ENOMEM;
580 goto out_hotkey;
581 }
582
583 pcc->device = device;
584 pcc->handle = device->handle;
585 pcc->num_sifr = num_sifr;
586 device->driver_data = pcc;
587 strcpy(acpi_device_name(device), ACPI_PCC_DEVICE_NAME);
588 strcpy(acpi_device_class(device), ACPI_PCC_CLASS);
589
590 result = acpi_pcc_init_input(pcc);
591 if (result) {
592 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
593 "Error installing keyinput handler\n"));
594 goto out_sinf;
595 }
596
597 if (!acpi_pcc_retrieve_biosdata(pcc)) {
598 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
599 "Couldn't retrieve BIOS data\n"));
600 result = -EIO;
601 goto out_input;
602 }
603
604 memset(&props, 0, sizeof(struct backlight_properties));
605 props.type = BACKLIGHT_PLATFORM;
606 props.max_brightness = pcc->sinf[SINF_AC_MAX_BRIGHT];
607 pcc->backlight = backlight_device_register("panasonic", NULL, pcc,
608 &pcc_backlight_ops, &props);
609 if (IS_ERR(pcc->backlight)) {
610 result = PTR_ERR(pcc->backlight);
611 goto out_input;
612 }
613
614
615 pcc->backlight->props.brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
616
617
618 pcc->sticky_mode = pcc->sinf[SINF_STICKY_KEY];
619
620
621 result = sysfs_create_group(&device->dev.kobj, &pcc_attr_group);
622 if (result)
623 goto out_backlight;
624
625 return 0;
626
627out_backlight:
628 backlight_device_unregister(pcc->backlight);
629out_input:
630 acpi_pcc_destroy_input(pcc);
631out_sinf:
632 kfree(pcc->sinf);
633out_hotkey:
634 kfree(pcc);
635
636 return result;
637}
638
639static int __init acpi_pcc_init(void)
640{
641 int result = 0;
642
643 if (acpi_disabled)
644 return -ENODEV;
645
646 result = acpi_bus_register_driver(&acpi_pcc_driver);
647 if (result < 0) {
648 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
649 "Error registering hotkey driver\n"));
650 return -ENODEV;
651 }
652
653 return 0;
654}
655
656static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type)
657{
658 struct pcc_acpi *pcc = acpi_driver_data(device);
659
660 if (!device || !pcc)
661 return -EINVAL;
662
663 sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);
664
665 backlight_device_unregister(pcc->backlight);
666
667 acpi_pcc_destroy_input(pcc);
668
669 kfree(pcc->sinf);
670 kfree(pcc);
671
672 return 0;
673}
674
675static void __exit acpi_pcc_exit(void)
676{
677 acpi_bus_unregister_driver(&acpi_pcc_driver);
678}
679
680module_init(acpi_pcc_init);
681module_exit(acpi_pcc_exit);
682