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);
179 static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event);
181 static const struct acpi_device_id pcc_device_ids[] = {
188 MODULE_DEVICE_TABLE(acpi, pcc_device_ids);
190 static struct acpi_driver acpi_pcc_driver = {
191 .name = ACPI_PCC_DRIVER_NAME,
192 .class = ACPI_PCC_CLASS,
193 .ids = pcc_device_ids,
195 .add = acpi_pcc_hotkey_add,
196 .remove = acpi_pcc_hotkey_remove,
197 .resume = acpi_pcc_hotkey_resume,
198 .notify = acpi_pcc_hotkey_notify,
202 #define KEYMAP_SIZE 11
203 static const int initial_keymap[KEYMAP_SIZE] = {
204 /* 0 */ KEY_RESERVED,
205 /* 1 */ KEY_BRIGHTNESSDOWN,
206 /* 2 */ KEY_BRIGHTNESSUP,
207 /* 3 */ KEY_DISPLAYTOGGLE,
209 /* 5 */ KEY_VOLUMEDOWN,
210 /* 6 */ KEY_VOLUMEUP,
212 /* 8 */ KEY_PROG1, /* Change CPU boost */
214 /* 10 */ KEY_SUSPEND,
219 unsigned long num_sifr;
222 struct acpi_device *device;
223 struct input_dev *input_dev;
224 struct backlight_device *backlight;
225 int keymap[KEYMAP_SIZE];
228 struct pcc_keyinput {
229 struct acpi_hotkey *hotkey;
232 /* method access functions */
233 static int acpi_pcc_write_sset(struct pcc_acpi *pcc, int func, int val)
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, },
241 struct acpi_object_list params = {
242 .count = ARRAY_SIZE(in_objs),
245 acpi_status status = AE_OK;
247 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SSET,
250 return status == AE_OK;
253 static inline int acpi_pcc_get_sqty(struct acpi_device *device)
255 unsigned long long s;
258 status = acpi_evaluate_integer(device->handle, METHOD_HKEY_SQTY,
260 if (ACPI_SUCCESS(status))
263 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
264 "evaluation error HKEY.SQTY\n"));
269 static int acpi_pcc_retrieve_biosdata(struct pcc_acpi *pcc, u32 *sinf)
272 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
273 union acpi_object *hkey = NULL;
276 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SINF, 0,
278 if (ACPI_FAILURE(status)) {
279 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
280 "evaluation error HKEY.SINF\n"));
284 hkey = buffer.pointer;
285 if (!hkey || (hkey->type != ACPI_TYPE_PACKAGE)) {
286 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid HKEY.SINF\n"));
290 if (pcc->num_sifr < hkey->package.count) {
291 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
292 "SQTY reports bad SINF length\n"));
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;
302 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
303 "Invalid HKEY.SINF data\n"));
305 sinf[hkey->package.count] = -1;
308 kfree(buffer.pointer);
309 return status == AE_OK;
312 /* backlight API interface functions */
314 /* This driver currently treats AC and DC brightness identical,
315 * since we don't need to invent an interface to the core ACPI
316 * logic to receive events in case a power supply is plugged in
319 static int bl_get(struct backlight_device *bd)
321 struct pcc_acpi *pcc = bl_get_data(bd);
323 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
326 return pcc->sinf[SINF_AC_CUR_BRIGHT];
329 static int bl_set_status(struct backlight_device *bd)
331 struct pcc_acpi *pcc = bl_get_data(bd);
332 int bright = bd->props.brightness;
335 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
338 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT])
339 bright = pcc->sinf[SINF_AC_MIN_BRIGHT];
341 if (bright < pcc->sinf[SINF_DC_MIN_BRIGHT])
342 bright = pcc->sinf[SINF_DC_MIN_BRIGHT];
344 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT] ||
345 bright > pcc->sinf[SINF_AC_MAX_BRIGHT])
348 rc = acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, bright);
352 return acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, bright);
355 static struct backlight_ops pcc_backlight_ops = {
356 .get_brightness = bl_get,
357 .update_status = bl_set_status,
361 /* sysfs user interface functions */
363 static ssize_t show_numbatt(struct device *dev, struct device_attribute *attr,
366 struct acpi_device *acpi = to_acpi_device(dev);
367 struct pcc_acpi *pcc = acpi_driver_data(acpi);
369 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
372 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_NUM_BATTERIES]);
375 static ssize_t show_lcdtype(struct device *dev, struct device_attribute *attr,
378 struct acpi_device *acpi = to_acpi_device(dev);
379 struct pcc_acpi *pcc = acpi_driver_data(acpi);
381 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
384 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_LCD_TYPE]);
387 static ssize_t show_mute(struct device *dev, struct device_attribute *attr,
390 struct acpi_device *acpi = to_acpi_device(dev);
391 struct pcc_acpi *pcc = acpi_driver_data(acpi);
393 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
396 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_MUTE]);
399 static ssize_t show_sticky(struct device *dev, struct device_attribute *attr,
402 struct acpi_device *acpi = to_acpi_device(dev);
403 struct pcc_acpi *pcc = acpi_driver_data(acpi);
405 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf))
408 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_STICKY_KEY]);
411 static ssize_t set_sticky(struct device *dev, struct device_attribute *attr,
412 const char *buf, size_t count)
414 struct acpi_device *acpi = to_acpi_device(dev);
415 struct pcc_acpi *pcc = acpi_driver_data(acpi);
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;
427 static DEVICE_ATTR(numbatt, S_IRUGO, show_numbatt, NULL);
428 static DEVICE_ATTR(lcdtype, S_IRUGO, show_lcdtype, NULL);
429 static DEVICE_ATTR(mute, S_IRUGO, show_mute, NULL);
430 static DEVICE_ATTR(sticky_key, S_IRUGO | S_IWUSR, show_sticky, set_sticky);
432 static struct attribute *pcc_sysfs_entries[] = {
433 &dev_attr_numbatt.attr,
434 &dev_attr_lcdtype.attr,
436 &dev_attr_sticky_key.attr,
440 static struct attribute_group pcc_attr_group = {
441 .name = NULL, /* put in device directory */
442 .attrs = pcc_sysfs_entries,
446 /* hotkey input device driver */
448 static int pcc_getkeycode(struct input_dev *dev, int scancode, int *keycode)
450 struct pcc_acpi *pcc = input_get_drvdata(dev);
452 if (scancode >= ARRAY_SIZE(pcc->keymap))
455 *keycode = pcc->keymap[scancode];
460 static int keymap_get_by_keycode(struct pcc_acpi *pcc, int keycode)
464 for (i = 0; i < ARRAY_SIZE(pcc->keymap); i++) {
465 if (pcc->keymap[i] == keycode)
472 static int pcc_setkeycode(struct input_dev *dev, int scancode, int keycode)
474 struct pcc_acpi *pcc = input_get_drvdata(dev);
477 if (scancode >= ARRAY_SIZE(pcc->keymap))
480 if (keycode < 0 || keycode > KEY_MAX)
483 oldkeycode = pcc->keymap[scancode];
484 pcc->keymap[scancode] = keycode;
486 set_bit(keycode, dev->keybit);
488 if (!keymap_get_by_keycode(pcc, oldkeycode))
489 clear_bit(oldkeycode, dev->keybit);
494 static void acpi_pcc_generate_keyinput(struct pcc_acpi *pcc)
496 struct input_dev *hotk_input_dev = pcc->input_dev;
498 int key_code, hkey_num;
499 unsigned long long result;
501 rc = acpi_evaluate_integer(pcc->handle, METHOD_HKEY_QUERY,
503 if (!ACPI_SUCCESS(rc)) {
504 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
505 "error getting hotkey status\n"));
509 acpi_bus_generate_proc_event(pcc->device, HKEY_NOTIFY, result);
511 hkey_num = result & 0xf;
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",
520 key_code = pcc->keymap[hkey_num];
522 if (key_code != KEY_RESERVED) {
523 int pushed = (result & 0x80) ? TRUE : FALSE;
525 input_report_key(hotk_input_dev, key_code, pushed);
526 input_sync(hotk_input_dev);
532 static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event)
534 struct pcc_acpi *pcc = acpi_driver_data(device);
538 acpi_pcc_generate_keyinput(pcc);
546 static int acpi_pcc_init_input(struct pcc_acpi *pcc)
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"));
557 pcc->input_dev->evbit[0] = BIT(EV_KEY);
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;
568 /* load initial keymap */
569 memcpy(pcc->keymap, initial_keymap, sizeof(pcc->keymap));
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);
575 input_set_drvdata(pcc->input_dev, pcc);
577 rc = input_register_device(pcc->input_dev);
579 input_free_device(pcc->input_dev);
584 /* kernel module interface */
586 static int acpi_pcc_hotkey_resume(struct acpi_device *device)
588 struct pcc_acpi *pcc = acpi_driver_data(device);
589 acpi_status status = AE_OK;
591 if (device == NULL || pcc == NULL)
594 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Sticky mode restore: %d\n",
597 status = acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, pcc->sticky_mode);
599 return status == AE_OK ? 0 : -EINVAL;
602 static int acpi_pcc_hotkey_add(struct acpi_device *device)
604 struct pcc_acpi *pcc;
605 int num_sifr, result;
610 num_sifr = acpi_pcc_get_sqty(device);
612 if (num_sifr > 255) {
613 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "num_sifr too large"));
617 pcc = kzalloc(sizeof(struct pcc_acpi), GFP_KERNEL);
619 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
620 "Couldn't allocate mem for pcc"));
624 pcc->sinf = kzalloc(sizeof(u32) * (num_sifr + 1), GFP_KERNEL);
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);
637 result = acpi_pcc_init_input(pcc);
639 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
640 "Error installing keyinput handler\n"));
644 /* initialize backlight */
645 pcc->backlight = backlight_device_register("panasonic", NULL, pcc,
647 if (IS_ERR(pcc->backlight))
650 if (!acpi_pcc_retrieve_biosdata(pcc, pcc->sinf)) {
651 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
652 "Couldn't retrieve BIOS data\n"));
656 /* read the initial brightness setting from the hardware */
657 pcc->backlight->props.max_brightness =
658 pcc->sinf[SINF_AC_MAX_BRIGHT];
659 pcc->backlight->props.brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
661 /* read the initial sticky key mode from the hardware */
662 pcc->sticky_mode = pcc->sinf[SINF_STICKY_KEY];
664 /* add sysfs attributes */
665 result = sysfs_create_group(&device->dev.kobj, &pcc_attr_group);
672 backlight_device_unregister(pcc->backlight);
674 input_unregister_device(pcc->input_dev);
675 /* no need to input_free_device() since core input API refcount and
676 * free()s the device */
685 static int __init acpi_pcc_init(void)
692 result = acpi_bus_register_driver(&acpi_pcc_driver);
694 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
695 "Error registering hotkey driver\n"));
702 static int acpi_pcc_hotkey_remove(struct acpi_device *device, int type)
704 struct pcc_acpi *pcc = acpi_driver_data(device);
709 sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);
711 backlight_device_unregister(pcc->backlight);
713 input_unregister_device(pcc->input_dev);
714 /* no need to input_free_device() since core input API refcount and
715 * free()s the device */
723 static void __exit acpi_pcc_exit(void)
725 acpi_bus_unregister_driver(&acpi_pcc_driver);
728 module_init(acpi_pcc_init);
729 module_exit(acpi_pcc_exit);