2 * Panasonic HotKey and LCD brightness control driver
3 * (C) 2004 Hiroshi Miura <miura@da-cha.org>
4 * (C) 2004 NTT DATA Intellilink Co. http://www.intellilink.co.jp/
5 * (C) YOKOTA Hiroshi <yokota (at) netlab. is. tsukuba. ac. jp>
6 * (C) 2004 David Bronaugh <dbronaugh>
7 * (C) 2006-2008 Harald Welte <laforge@gnumonks.org>
9 * derived from toshiba_acpi.c, Copyright (C) 2002-2004 John Belmonte
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * publicshed by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 *---------------------------------------------------------------------------
27 * Sep.23, 2008 Harald Welte <laforge@gnumonks.org>
28 * -v0.95 rename driver from drivers/acpi/pcc_acpi.c to
29 * drivers/misc/panasonic-laptop.c
31 * Jul.04, 2008 Harald Welte <laforge@gnumonks.org>
32 * -v0.94 replace /proc interface with device attributes
33 * support {set,get}keycode on th input device
35 * Jun.27, 2008 Harald Welte <laforge@gnumonks.org>
36 * -v0.92 merge with 2.6.26-rc6 input API changes
37 * remove broken <= 2.6.15 kernel support
38 * resolve all compiler warnings
39 * various coding style fixes (checkpatch.pl)
40 * add support for backlight api
41 * major code restructuring
43 * Dac.28, 2007 Harald Welte <laforge@gnumonks.org>
44 * -v0.91 merge with 2.6.24-rc6 ACPI changes
46 * Nov.04, 2006 Hiroshi Miura <miura@da-cha.org>
47 * -v0.9 remove warning about section reference.
49 * add /proc/acpi/pcc/brightness interface for HAL access
50 * merge dbronaugh's enhancement
51 * Aug.17, 2004 David Bronaugh (dbronaugh)
52 * - Added screen brightness setting interface
53 * Thanks to FreeBSD crew (acpi_panasonic.c)
54 * for the ideas I needed to accomplish it
56 * May.29, 2006 Hiroshi Miura <miura@da-cha.org>
57 * -v0.8.4 follow to change keyinput structure
58 * thanks Fabian Yamaguchi <fabs@cs.tu-berlin.de>,
59 * Jacob Bower <jacob.bower@ic.ac.uk> and
60 * Hiroshi Yokota for providing solutions.
62 * Oct.02, 2004 Hiroshi Miura <miura@da-cha.org>
63 * -v0.8.2 merge code of YOKOTA Hiroshi
64 * <yokota@netlab.is.tsukuba.ac.jp>.
65 * Add sticky key mode interface.
66 * Refactoring acpi_pcc_generate_keyinput().
68 * Sep.15, 2004 Hiroshi Miura <miura@da-cha.org>
69 * -v0.8 Generate key input event on input subsystem.
70 * This is based on yet another driver written by
73 * Sep.10, 2004 Hiroshi Miura <miura@da-cha.org>
74 * -v0.7 Change proc interface functions using seq_file
75 * facility as same as other ACPI drivers.
77 * Aug.28, 2004 Hiroshi Miura <miura@da-cha.org>
78 * -v0.6.4 Fix a silly error with status checking
80 * Aug.25, 2004 Hiroshi Miura <miura@da-cha.org>
81 * -v0.6.3 replace read_acpi_int by standard function
82 * acpi_evaluate_integer
83 * some clean up and make smart copyright notice.
84 * fix return value of pcc_acpi_get_key()
85 * fix checking return value of acpi_bus_register_driver()
87 * Aug.22, 2004 David Bronaugh <dbronaugh@linuxboxen.org>
88 * -v0.6.2 Add check on ACPI data (num_sifr)
89 * Coding style cleanups, better error messages/handling
90 * Fixed an off-by-one error in memory allocation
92 * Aug.21, 2004 David Bronaugh <dbronaugh@linuxboxen.org>
93 * -v0.6.1 Fix a silly error with status checking
95 * Aug.20, 2004 David Bronaugh <dbronaugh@linuxboxen.org>
96 * - v0.6 Correct brightness controls to reflect reality
97 * based on information gleaned by Hiroshi Miura
98 * and discussions with Hiroshi Miura
100 * Aug.10, 2004 Hiroshi Miura <miura@da-cha.org>
101 * - v0.5 support LCD brightness control
102 * based on the disclosed information by MEI.
104 * Jul.25, 2004 Hiroshi Miura <miura@da-cha.org>
105 * - v0.4 first post version
106 * add function to retrive SIFR
108 * Jul.24, 2004 Hiroshi Miura <miura@da-cha.org>
109 * - v0.3 get proper status of hotkey
111 * Jul.22, 2004 Hiroshi Miura <miura@da-cha.org>
112 * - v0.2 add HotKey handler
114 * Jul.17, 2004 Hiroshi Miura <miura@da-cha.org>
115 * - v0.1 start from toshiba_acpi driver written by John Belmonte
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>
132 #ifndef ACPI_HOTKEY_COMPONENT
133 #define ACPI_HOTKEY_COMPONENT 0x10000000
136 #define _COMPONENT ACPI_HOTKEY_COMPONENT
138 MODULE_AUTHOR("Hiroshi Miura, David Bronaugh and Harald Welte");
139 MODULE_DESCRIPTION("ACPI HotKey driver for Panasonic Let's Note laptops");
140 MODULE_LICENSE("GPL");
142 #define LOGPREFIX "pcc_acpi: "
144 /* Define ACPI PATHs */
145 /* Lets note hotkeys */
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
152 #define ACPI_PCC_DRIVER_NAME "Panasonic Laptop Support"
153 #define ACPI_PCC_DEVICE_NAME "Hotkey"
154 #define ACPI_PCC_CLASS "pcc"
156 #define ACPI_PCC_INPUT_PHYS "panasonic/hkey0"
158 /* LCD_TYPEs: 0 = Normal, 1 = Semi-transparent
159 ENV_STATEs: Normal temp=0x01, High temp=0x81, N/A=0x00
161 enum SINF_BITS { SINF_NUM_BATTERIES = 0,
172 SINF_STICKY_KEY = 0x80,
174 /* R1 handles SINF_AC_CUR_BRIGHT as SINF_CUR_BRIGHT, doesn't know AC state */
176 static int acpi_pcc_hotkey_add(struct acpi_device *device);
177 static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type);
178 static int acpi_pcc_hotkey_resume(struct acpi_device *device);
180 static const struct acpi_device_id pcc_device_ids[] = {
188 static struct acpi_driver acpi_pcc_driver = {
189 .name = ACPI_PCC_DRIVER_NAME,
190 .class = ACPI_PCC_CLASS,
191 .ids = pcc_device_ids,
193 .add = acpi_pcc_hotkey_add,
194 .remove = acpi_pcc_hotkey_remove,
195 .resume = acpi_pcc_hotkey_resume,
199 #define KEYMAP_SIZE 11
200 static const int initial_keymap[KEYMAP_SIZE] = {
201 /* 0 */ KEY_RESERVED,
202 /* 1 */ KEY_BRIGHTNESSDOWN,
203 /* 2 */ KEY_BRIGHTNESSUP,
204 /* 3 */ KEY_DISPLAYTOGGLE,
206 /* 5 */ KEY_VOLUMEDOWN,
207 /* 6 */ KEY_VOLUMEUP,
209 /* 8 */ KEY_PROG1, /* Change CPU boost */
211 /* 10 */ KEY_SUSPEND,
216 unsigned long num_sifr;
219 struct acpi_device *device;
220 struct input_dev *input_dev;
221 struct backlight_device *backlight;
222 int keymap[KEYMAP_SIZE];
225 struct pcc_keyinput {
226 struct acpi_hotkey *hotkey;
229 /* method access functions */
230 static int acpi_pcc_write_sset(struct pcc_acpi *pcc, int func, int val)
232 union acpi_object in_objs[] = {
233 { .integer.type = ACPI_TYPE_INTEGER,
234 .integer.value = func, },
235 { .integer.type = ACPI_TYPE_INTEGER,
236 .integer.value = val, },
238 struct acpi_object_list params = {
239 .count = ARRAY_SIZE(in_objs),
242 acpi_status status = AE_OK;
244 ACPI_FUNCTION_TRACE("acpi_pcc_write_sset");
246 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SSET,
249 return status == AE_OK;
252 static inline int acpi_pcc_get_sqty(struct acpi_device *device)
254 unsigned long long s;
257 ACPI_FUNCTION_TRACE("acpi_pcc_get_sqty");
259 status = acpi_evaluate_integer(device->handle, METHOD_HKEY_SQTY,
261 if (ACPI_SUCCESS(status))
264 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
265 "evaluation error HKEY.SQTY\n"));
270 static int acpi_pcc_retrieve_biosdata(struct pcc_acpi *pcc, u32 *sinf)
273 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
274 union acpi_object *hkey = NULL;
277 ACPI_FUNCTION_TRACE("acpi_pcc_retrieve_biosdata");
279 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SINF, 0,
281 if (ACPI_FAILURE(status)) {
282 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
283 "evaluation error HKEY.SINF\n"));
287 hkey = buffer.pointer;
288 if (!hkey || (hkey->type != ACPI_TYPE_PACKAGE)) {
289 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid HKEY.SINF\n"));
293 if (pcc->num_sifr < hkey->package.count) {
294 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
295 "SQTY reports bad SINF length\n"));
300 for (i = 0; i < hkey->package.count; i++) {
301 union acpi_object *element = &(hkey->package.elements[i]);
302 if (likely(element->type == ACPI_TYPE_INTEGER)) {
303 sinf[i] = element->integer.value;
305 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
306 "Invalid HKEY.SINF data\n"));
308 sinf[hkey->package.count] = -1;
311 kfree(buffer.pointer);
312 return status == AE_OK;
315 /* backlight API interface functions */
317 /* This driver currently treats AC and DC brightness identical,
318 * since we don't need to invent an interface to the core ACPI
319 * logic to receive events in case a power supply is plugged in
322 static int bl_get(struct backlight_device *bd)
324 struct pcc_acpi *pcc = bl_get_data(bd);
326 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
329 return pcc->sinf[SINF_AC_CUR_BRIGHT];
332 static int bl_set_status(struct backlight_device *bd)
334 struct pcc_acpi *pcc = bl_get_data(bd);
335 int bright = bd->props.brightness;
338 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
341 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT])
342 bright = pcc->sinf[SINF_AC_MIN_BRIGHT];
344 if (bright < pcc->sinf[SINF_DC_MIN_BRIGHT])
345 bright = pcc->sinf[SINF_DC_MIN_BRIGHT];
347 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT] ||
348 bright > pcc->sinf[SINF_AC_MAX_BRIGHT])
351 rc = acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, bright);
355 return acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, bright);
358 static struct backlight_ops pcc_backlight_ops = {
359 .get_brightness = bl_get,
360 .update_status = bl_set_status,
364 /* sysfs user interface functions */
366 static ssize_t show_numbatt(struct device *dev, struct device_attribute *attr,
369 struct acpi_device *acpi = to_acpi_device(dev);
370 struct pcc_acpi *pcc = acpi_driver_data(acpi);
372 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
375 return sprintf(buf, "%u\n", pcc->sinf[SINF_NUM_BATTERIES]);
378 static ssize_t show_lcdtype(struct device *dev, struct device_attribute *attr,
381 struct acpi_device *acpi = to_acpi_device(dev);
382 struct pcc_acpi *pcc = acpi_driver_data(acpi);
384 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
387 return sprintf(buf, "%u\n", pcc->sinf[SINF_LCD_TYPE]);
390 static ssize_t show_mute(struct device *dev, struct device_attribute *attr,
393 struct acpi_device *acpi = to_acpi_device(dev);
394 struct pcc_acpi *pcc = acpi_driver_data(acpi);
396 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
399 return sprintf(buf, "%u\n", pcc->sinf[SINF_MUTE]);
402 static ssize_t show_sticky(struct device *dev, struct device_attribute *attr,
405 struct acpi_device *acpi = to_acpi_device(dev);
406 struct pcc_acpi *pcc = acpi_driver_data(acpi);
408 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
411 return sprintf(buf, "%u\n", pcc->sinf[SINF_STICKY_KEY]);
414 static ssize_t set_sticky(struct device *dev, struct device_attribute *attr,
415 const char *buf, size_t count)
417 struct acpi_device *acpi = to_acpi_device(dev);
418 struct pcc_acpi *pcc = acpi_driver_data(acpi);
421 if (count && sscanf(buf, "%i", &val) == 1 &&
422 (val == 0 || val == 1)) {
423 acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, val);
424 pcc->sticky_mode = val;
430 static DEVICE_ATTR(numbatt, S_IRUGO, show_numbatt, NULL);
431 static DEVICE_ATTR(lcdtype, S_IRUGO, show_lcdtype, NULL);
432 static DEVICE_ATTR(mute, S_IRUGO, show_mute, NULL);
433 static DEVICE_ATTR(sticky_key, S_IRUGO | S_IWUSR, show_sticky, set_sticky);
435 static struct attribute *pcc_sysfs_entries[] = {
436 &dev_attr_numbatt.attr,
437 &dev_attr_lcdtype.attr,
439 &dev_attr_sticky_key.attr,
443 static struct attribute_group pcc_attr_group = {
444 .name = NULL, /* put in device directory */
445 .attrs = pcc_sysfs_entries,
449 /* hotkey input device driver */
451 static int pcc_getkeycode(struct input_dev *dev, int scancode, int *keycode)
453 struct pcc_acpi *pcc = input_get_drvdata(dev);
455 if (scancode >= ARRAY_SIZE(pcc->keymap))
458 *keycode = pcc->keymap[scancode];
463 static int keymap_get_by_keycode(struct pcc_acpi *pcc, int keycode)
467 for (i = 0; i < ARRAY_SIZE(pcc->keymap); i++) {
468 if (pcc->keymap[i] == keycode)
475 static int pcc_setkeycode(struct input_dev *dev, int scancode, int keycode)
477 struct pcc_acpi *pcc = input_get_drvdata(dev);
480 if (scancode >= ARRAY_SIZE(pcc->keymap))
483 if (keycode < 0 || keycode > KEY_MAX)
486 oldkeycode = pcc->keymap[scancode];
487 pcc->keymap[scancode] = keycode;
489 set_bit(keycode, dev->keybit);
491 if (!keymap_get_by_keycode(pcc, oldkeycode))
492 clear_bit(oldkeycode, dev->keybit);
497 static void acpi_pcc_generate_keyinput(struct pcc_acpi *pcc)
499 struct input_dev *hotk_input_dev = pcc->input_dev;
501 int key_code, hkey_num;
502 unsigned long long result;
504 ACPI_FUNCTION_TRACE("acpi_pcc_generate_keyinput");
506 rc = acpi_evaluate_integer(pcc->handle, METHOD_HKEY_QUERY,
508 if (!ACPI_SUCCESS(rc)) {
509 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
510 "error getting hotkey status\n"));
514 acpi_bus_generate_proc_event(pcc->device, HKEY_NOTIFY, result);
516 hkey_num = result & 0xf;
518 if (hkey_num < 0 || hkey_num > ARRAY_SIZE(pcc->keymap)) {
519 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
520 "hotkey number out of range: %d\n",
525 key_code = pcc->keymap[hkey_num];
527 if (key_code != KEY_RESERVED) {
528 int pushed = (result & 0x80) ? TRUE : FALSE;
530 input_report_key(hotk_input_dev, key_code, pushed);
531 input_sync(hotk_input_dev);
537 static void acpi_pcc_hotkey_notify(acpi_handle handle, u32 event, void *data)
539 struct pcc_acpi *pcc = (struct pcc_acpi *) data;
541 ACPI_FUNCTION_TRACE("acpi_pcc_hotkey_notify");
545 acpi_pcc_generate_keyinput(pcc);
553 static int acpi_pcc_init_input(struct pcc_acpi *pcc)
557 ACPI_FUNCTION_TRACE("acpi_pcc_init_input");
559 pcc->input_dev = input_allocate_device();
560 if (!pcc->input_dev) {
561 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
562 "Couldn't allocate input device for hotkey"));
566 pcc->input_dev->evbit[0] = BIT(EV_KEY);
568 pcc->input_dev->name = ACPI_PCC_DRIVER_NAME;
569 pcc->input_dev->phys = ACPI_PCC_INPUT_PHYS;
570 pcc->input_dev->id.bustype = BUS_HOST;
571 pcc->input_dev->id.vendor = 0x0001;
572 pcc->input_dev->id.product = 0x0001;
573 pcc->input_dev->id.version = 0x0100;
574 pcc->input_dev->getkeycode = pcc_getkeycode;
575 pcc->input_dev->setkeycode = pcc_setkeycode;
577 /* load initial keymap */
578 memcpy(pcc->keymap, initial_keymap, sizeof(pcc->keymap));
580 for (i = 0; i < ARRAY_SIZE(pcc->keymap); i++)
581 __set_bit(pcc->keymap[i], pcc->input_dev->keybit);
582 __clear_bit(KEY_RESERVED, pcc->input_dev->keybit);
584 input_set_drvdata(pcc->input_dev, pcc);
586 rc = input_register_device(pcc->input_dev);
588 input_free_device(pcc->input_dev);
593 /* kernel module interface */
595 static int acpi_pcc_hotkey_resume(struct acpi_device *device)
597 struct pcc_acpi *pcc = acpi_driver_data(device);
598 acpi_status status = AE_OK;
600 ACPI_FUNCTION_TRACE("acpi_pcc_hotkey_resume");
602 if (device == NULL || pcc == NULL)
605 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Sticky mode restore: %d\n",
608 status = acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, pcc->sticky_mode);
610 return status == AE_OK ? 0 : -EINVAL;
613 static int acpi_pcc_hotkey_add(struct acpi_device *device)
616 struct pcc_acpi *pcc;
617 int num_sifr, result;
619 ACPI_FUNCTION_TRACE("acpi_pcc_hotkey_add");
624 num_sifr = acpi_pcc_get_sqty(device);
626 if (num_sifr > 255) {
627 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "num_sifr too large"));
631 pcc = kzalloc(sizeof(struct pcc_acpi), GFP_KERNEL);
633 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
634 "Couldn't allocate mem for pcc"));
638 pcc->sinf = kzalloc(sizeof(u32) * (num_sifr + 1), GFP_KERNEL);
644 pcc->device = device;
645 pcc->handle = device->handle;
646 pcc->num_sifr = num_sifr;
647 device->driver_data = pcc;
648 strcpy(acpi_device_name(device), ACPI_PCC_DEVICE_NAME);
649 strcpy(acpi_device_class(device), ACPI_PCC_CLASS);
651 result = acpi_pcc_init_input(pcc);
653 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
654 "Error installing keyinput handler\n"));
658 /* initialize hotkey input device */
659 status = acpi_install_notify_handler(pcc->handle, ACPI_DEVICE_NOTIFY,
660 acpi_pcc_hotkey_notify, pcc);
662 if (ACPI_FAILURE(status)) {
663 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
664 "Error installing notify handler\n"));
669 /* initialize backlight */
670 pcc->backlight = backlight_device_register("panasonic", NULL, pcc,
672 if (IS_ERR(pcc->backlight))
675 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf)) {
676 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
677 "Couldn't retrieve BIOS data\n"));
681 /* read the initial brightness setting from the hardware */
682 pcc->backlight->props.max_brightness =
683 pcc->sinf[SINF_AC_MAX_BRIGHT];
684 pcc->backlight->props.brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
686 /* read the initial sticky key mode from the hardware */
687 pcc->sticky_mode = pcc->sinf[SINF_STICKY_KEY];
689 /* add sysfs attributes */
690 result = sysfs_create_group(&device->dev.kobj, &pcc_attr_group);
697 backlight_device_unregister(pcc->backlight);
699 acpi_remove_notify_handler(pcc->handle, ACPI_DEVICE_NOTIFY,
700 acpi_pcc_hotkey_notify);
702 input_unregister_device(pcc->input_dev);
703 /* no need to input_free_device() since core input API refcount and
704 * free()s the device */
713 static int __init acpi_pcc_init(void)
717 ACPI_FUNCTION_TRACE("acpi_pcc_init");
722 result = acpi_bus_register_driver(&acpi_pcc_driver);
724 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
725 "Error registering hotkey driver\n"));
732 static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type)
734 struct pcc_acpi *pcc = acpi_driver_data(device);
736 ACPI_FUNCTION_TRACE("acpi_pcc_hotkey_remove");
741 sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);
743 backlight_device_unregister(pcc->backlight);
745 acpi_remove_notify_handler(pcc->handle, ACPI_DEVICE_NOTIFY,
746 acpi_pcc_hotkey_notify);
748 input_unregister_device(pcc->input_dev);
749 /* no need to input_free_device() since core input API refcount and
750 * free()s the device */
758 static void __exit acpi_pcc_exit(void)
760 ACPI_FUNCTION_TRACE("acpi_pcc_exit");
762 acpi_bus_unregister_driver(&acpi_pcc_driver);
765 module_init(acpi_pcc_init);
766 module_exit(acpi_pcc_exit);