2 * Panasonic HotKey and LCD brightness control driver
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>
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 *---------------------------------------------------------------------------
28 * -v0.95 rename driver from drivers/acpi/pcc_acpi.c to
29 * drivers/misc/panasonic-laptop.c
32 * -v0.94 replace /proc interface with device attributes
33 * support {set,get}keycode on th input device
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
44 * -v0.91 merge with 2.6.24-rc6 ACPI changes
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
57 * -v0.8.4 follow to change keyinput structure
60 * Hiroshi Yokota for providing solutions.
63 * -v0.8.2 merge code of YOKOTA Hiroshi
65 * Add sticky key mode interface.
66 * Refactoring acpi_pcc_generate_keyinput().
69 * -v0.8 Generate key input event on input subsystem.
70 * This is based on yet another driver written by
74 * -v0.7 Change proc interface functions using seq_file
75 * facility as same as other ACPI drivers.
78 * -v0.6.4 Fix a silly error with status checking
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()
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
93 * -v0.6.1 Fix a silly error with status checking
96 * - v0.6 Correct brightness controls to reflect reality
97 * based on information gleaned by Hiroshi Miura
98 * and discussions with Hiroshi Miura
101 * - v0.5 support LCD brightness control
102 * based on the disclosed information by MEI.
105 * - v0.4 first post version
106 * add function to retrive SIFR
109 * - v0.3 get proper status of hotkey
112 * - v0.2 add HotKey handler
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 <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>
134 #ifndef ACPI_HOTKEY_COMPONENT
135 #define ACPI_HOTKEY_COMPONENT 0x10000000
138 #define _COMPONENT ACPI_HOTKEY_COMPONENT
140 MODULE_AUTHOR("Hiroshi Miura, David Bronaugh and Harald Welte");
141 MODULE_DESCRIPTION("ACPI HotKey driver for Panasonic Let's Note laptops");
142 MODULE_LICENSE("GPL");
144 #define LOGPREFIX "pcc_acpi: "
146 /* Define ACPI PATHs */
147 /* Lets note hotkeys */
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
154 #define ACPI_PCC_DRIVER_NAME "Panasonic Laptop Support"
155 #define ACPI_PCC_DEVICE_NAME "Hotkey"
156 #define ACPI_PCC_CLASS "pcc"
158 #define ACPI_PCC_INPUT_PHYS "panasonic/hkey0"
160 /* LCD_TYPEs: 0 = Normal, 1 = Semi-transparent
161 ENV_STATEs: Normal temp=0x01, High temp=0x81, N/A=0x00
163 enum SINF_BITS { SINF_NUM_BATTERIES = 0,
174 SINF_STICKY_KEY = 0x80,
176 /* R1 handles SINF_AC_CUR_BRIGHT as SINF_CUR_BRIGHT, doesn't know AC state */
178 static int acpi_pcc_hotkey_add(struct acpi_device *device);
179 static int acpi_pcc_hotkey_remove(struct acpi_device *device);
180 static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event);
182 static const struct acpi_device_id pcc_device_ids[] = {
189 MODULE_DEVICE_TABLE(acpi, pcc_device_ids);
191 #ifdef CONFIG_PM_SLEEP
192 static int acpi_pcc_hotkey_resume(struct device *dev);
194 static SIMPLE_DEV_PM_OPS(acpi_pcc_hotkey_pm, NULL, acpi_pcc_hotkey_resume);
196 static struct acpi_driver acpi_pcc_driver = {
197 .name = ACPI_PCC_DRIVER_NAME,
198 .class = ACPI_PCC_CLASS,
199 .ids = pcc_device_ids,
201 .add = acpi_pcc_hotkey_add,
202 .remove = acpi_pcc_hotkey_remove,
203 .notify = acpi_pcc_hotkey_notify,
205 .drv.pm = &acpi_pcc_hotkey_pm,
208 static const struct key_entry panasonic_keymap[] = {
209 { KE_KEY, 0, { KEY_RESERVED } },
210 { KE_KEY, 1, { KEY_BRIGHTNESSDOWN } },
211 { KE_KEY, 2, { KEY_BRIGHTNESSUP } },
212 { KE_KEY, 3, { KEY_DISPLAYTOGGLE } },
213 { KE_KEY, 4, { KEY_MUTE } },
214 { KE_KEY, 5, { KEY_VOLUMEDOWN } },
215 { KE_KEY, 6, { KEY_VOLUMEUP } },
216 { KE_KEY, 7, { KEY_SLEEP } },
217 { KE_KEY, 8, { KEY_PROG1 } }, /* Change CPU boost */
218 { KE_KEY, 9, { KEY_BATTERY } },
219 { KE_KEY, 10, { KEY_SUSPEND } },
225 unsigned long num_sifr;
228 struct acpi_device *device;
229 struct input_dev *input_dev;
230 struct backlight_device *backlight;
233 struct pcc_keyinput {
234 struct acpi_hotkey *hotkey;
237 /* method access functions */
238 static int acpi_pcc_write_sset(struct pcc_acpi *pcc, int func, int val)
240 union acpi_object in_objs[] = {
241 { .integer.type = ACPI_TYPE_INTEGER,
242 .integer.value = func, },
243 { .integer.type = ACPI_TYPE_INTEGER,
244 .integer.value = val, },
246 struct acpi_object_list params = {
247 .count = ARRAY_SIZE(in_objs),
250 acpi_status status = AE_OK;
252 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SSET,
255 return (status == AE_OK) ? 0 : -EIO;
258 static inline int acpi_pcc_get_sqty(struct acpi_device *device)
260 unsigned long long s;
263 status = acpi_evaluate_integer(device->handle, METHOD_HKEY_SQTY,
265 if (ACPI_SUCCESS(status))
268 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
269 "evaluation error HKEY.SQTY\n"));
274 static int acpi_pcc_retrieve_biosdata(struct pcc_acpi *pcc)
277 struct acpi_buffer buffer = {ACPI_ALLOCATE_BUFFER, NULL};
278 union acpi_object *hkey = NULL;
281 status = acpi_evaluate_object(pcc->handle, METHOD_HKEY_SINF, NULL,
283 if (ACPI_FAILURE(status)) {
284 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
285 "evaluation error HKEY.SINF\n"));
289 hkey = buffer.pointer;
290 if (!hkey || (hkey->type != ACPI_TYPE_PACKAGE)) {
291 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Invalid HKEY.SINF\n"));
296 if (pcc->num_sifr < hkey->package.count) {
297 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
298 "SQTY reports bad SINF length\n"));
303 for (i = 0; i < hkey->package.count; i++) {
304 union acpi_object *element = &(hkey->package.elements[i]);
305 if (likely(element->type == ACPI_TYPE_INTEGER)) {
306 pcc->sinf[i] = element->integer.value;
308 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
309 "Invalid HKEY.SINF data\n"));
311 pcc->sinf[hkey->package.count] = -1;
314 kfree(buffer.pointer);
315 return status == AE_OK;
318 /* backlight API interface functions */
320 /* This driver currently treats AC and DC brightness identical,
321 * since we don't need to invent an interface to the core ACPI
322 * logic to receive events in case a power supply is plugged in
325 static int bl_get(struct backlight_device *bd)
327 struct pcc_acpi *pcc = bl_get_data(bd);
329 if (!acpi_pcc_retrieve_biosdata(pcc))
332 return pcc->sinf[SINF_AC_CUR_BRIGHT];
335 static int bl_set_status(struct backlight_device *bd)
337 struct pcc_acpi *pcc = bl_get_data(bd);
338 int bright = bd->props.brightness;
341 if (!acpi_pcc_retrieve_biosdata(pcc))
344 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT])
345 bright = pcc->sinf[SINF_AC_MIN_BRIGHT];
347 if (bright < pcc->sinf[SINF_DC_MIN_BRIGHT])
348 bright = pcc->sinf[SINF_DC_MIN_BRIGHT];
350 if (bright < pcc->sinf[SINF_AC_MIN_BRIGHT] ||
351 bright > pcc->sinf[SINF_AC_MAX_BRIGHT])
354 rc = acpi_pcc_write_sset(pcc, SINF_AC_CUR_BRIGHT, bright);
358 return acpi_pcc_write_sset(pcc, SINF_DC_CUR_BRIGHT, bright);
361 static const struct backlight_ops pcc_backlight_ops = {
362 .get_brightness = bl_get,
363 .update_status = bl_set_status,
367 /* sysfs user interface functions */
369 static ssize_t show_numbatt(struct device *dev, struct device_attribute *attr,
372 struct acpi_device *acpi = to_acpi_device(dev);
373 struct pcc_acpi *pcc = acpi_driver_data(acpi);
375 if (!acpi_pcc_retrieve_biosdata(pcc))
378 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_NUM_BATTERIES]);
381 static ssize_t show_lcdtype(struct device *dev, struct device_attribute *attr,
384 struct acpi_device *acpi = to_acpi_device(dev);
385 struct pcc_acpi *pcc = acpi_driver_data(acpi);
387 if (!acpi_pcc_retrieve_biosdata(pcc))
390 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_LCD_TYPE]);
393 static ssize_t show_mute(struct device *dev, struct device_attribute *attr,
396 struct acpi_device *acpi = to_acpi_device(dev);
397 struct pcc_acpi *pcc = acpi_driver_data(acpi);
399 if (!acpi_pcc_retrieve_biosdata(pcc))
402 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_MUTE]);
405 static ssize_t show_sticky(struct device *dev, struct device_attribute *attr,
408 struct acpi_device *acpi = to_acpi_device(dev);
409 struct pcc_acpi *pcc = acpi_driver_data(acpi);
411 if (!acpi_pcc_retrieve_biosdata(pcc))
414 return snprintf(buf, PAGE_SIZE, "%u\n", pcc->sinf[SINF_STICKY_KEY]);
417 static ssize_t set_sticky(struct device *dev, struct device_attribute *attr,
418 const char *buf, size_t count)
420 struct acpi_device *acpi = to_acpi_device(dev);
421 struct pcc_acpi *pcc = acpi_driver_data(acpi);
424 if (count && sscanf(buf, "%i", &val) == 1 &&
425 (val == 0 || val == 1)) {
426 acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, val);
427 pcc->sticky_mode = val;
433 static DEVICE_ATTR(numbatt, S_IRUGO, show_numbatt, NULL);
434 static DEVICE_ATTR(lcdtype, S_IRUGO, show_lcdtype, NULL);
435 static DEVICE_ATTR(mute, S_IRUGO, show_mute, NULL);
436 static DEVICE_ATTR(sticky_key, S_IRUGO | S_IWUSR, show_sticky, set_sticky);
438 static struct attribute *pcc_sysfs_entries[] = {
439 &dev_attr_numbatt.attr,
440 &dev_attr_lcdtype.attr,
442 &dev_attr_sticky_key.attr,
446 static struct attribute_group pcc_attr_group = {
447 .name = NULL, /* put in device directory */
448 .attrs = pcc_sysfs_entries,
452 /* hotkey input device driver */
454 static void acpi_pcc_generate_keyinput(struct pcc_acpi *pcc)
456 struct input_dev *hotk_input_dev = pcc->input_dev;
458 unsigned long long result;
460 rc = acpi_evaluate_integer(pcc->handle, METHOD_HKEY_QUERY,
462 if (!ACPI_SUCCESS(rc)) {
463 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
464 "error getting hotkey status\n"));
468 acpi_bus_generate_proc_event(pcc->device, HKEY_NOTIFY, result);
470 if (!sparse_keymap_report_event(hotk_input_dev,
471 result & 0xf, result & 0x80, false))
472 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
473 "Unknown hotkey event: %d\n", result));
476 static void acpi_pcc_hotkey_notify(struct acpi_device *device, u32 event)
478 struct pcc_acpi *pcc = acpi_driver_data(device);
482 acpi_pcc_generate_keyinput(pcc);
490 static int acpi_pcc_init_input(struct pcc_acpi *pcc)
492 struct input_dev *input_dev;
495 input_dev = input_allocate_device();
497 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
498 "Couldn't allocate input device for hotkey"));
502 input_dev->name = ACPI_PCC_DRIVER_NAME;
503 input_dev->phys = ACPI_PCC_INPUT_PHYS;
504 input_dev->id.bustype = BUS_HOST;
505 input_dev->id.vendor = 0x0001;
506 input_dev->id.product = 0x0001;
507 input_dev->id.version = 0x0100;
509 error = sparse_keymap_setup(input_dev, panasonic_keymap, NULL);
511 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
512 "Unable to setup input device keymap\n"));
516 error = input_register_device(input_dev);
518 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
519 "Unable to register input device\n"));
520 goto err_free_keymap;
523 pcc->input_dev = input_dev;
527 sparse_keymap_free(input_dev);
529 input_free_device(input_dev);
533 static void acpi_pcc_destroy_input(struct pcc_acpi *pcc)
535 sparse_keymap_free(pcc->input_dev);
536 input_unregister_device(pcc->input_dev);
538 * No need to input_free_device() since core input API refcounts
539 * and free()s the device.
543 /* kernel module interface */
545 #ifdef CONFIG_PM_SLEEP
546 static int acpi_pcc_hotkey_resume(struct device *dev)
548 struct pcc_acpi *pcc;
553 pcc = acpi_driver_data(to_acpi_device(dev));
557 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "Sticky mode restore: %d\n",
560 return acpi_pcc_write_sset(pcc, SINF_STICKY_KEY, pcc->sticky_mode);
564 static int acpi_pcc_hotkey_add(struct acpi_device *device)
566 struct backlight_properties props;
567 struct pcc_acpi *pcc;
568 int num_sifr, result;
573 num_sifr = acpi_pcc_get_sqty(device);
575 if (num_sifr < 0 || num_sifr > 255) {
576 ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "num_sifr out of range"));
580 pcc = kzalloc(sizeof(struct pcc_acpi), GFP_KERNEL);
582 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
583 "Couldn't allocate mem for pcc"));
587 pcc->sinf = kzalloc(sizeof(u32) * (num_sifr + 1), GFP_KERNEL);
593 pcc->device = device;
594 pcc->handle = device->handle;
595 pcc->num_sifr = num_sifr;
596 device->driver_data = pcc;
597 strcpy(acpi_device_name(device), ACPI_PCC_DEVICE_NAME);
598 strcpy(acpi_device_class(device), ACPI_PCC_CLASS);
600 result = acpi_pcc_init_input(pcc);
602 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
603 "Error installing keyinput handler\n"));
607 if (!acpi_pcc_retrieve_biosdata(pcc)) {
608 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
609 "Couldn't retrieve BIOS data\n"));
613 /* initialize backlight */
614 memset(&props, 0, sizeof(struct backlight_properties));
615 props.type = BACKLIGHT_PLATFORM;
616 props.max_brightness = pcc->sinf[SINF_AC_MAX_BRIGHT];
617 pcc->backlight = backlight_device_register("panasonic", NULL, pcc,
618 &pcc_backlight_ops, &props);
619 if (IS_ERR(pcc->backlight)) {
620 result = PTR_ERR(pcc->backlight);
624 /* read the initial brightness setting from the hardware */
625 pcc->backlight->props.brightness = pcc->sinf[SINF_AC_CUR_BRIGHT];
627 /* read the initial sticky key mode from the hardware */
628 pcc->sticky_mode = pcc->sinf[SINF_STICKY_KEY];
630 /* add sysfs attributes */
631 result = sysfs_create_group(&device->dev.kobj, &pcc_attr_group);
638 backlight_device_unregister(pcc->backlight);
640 acpi_pcc_destroy_input(pcc);
649 static int __init acpi_pcc_init(void)
656 result = acpi_bus_register_driver(&acpi_pcc_driver);
658 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
659 "Error registering hotkey driver\n"));
666 static int acpi_pcc_hotkey_remove(struct acpi_device *device)
668 struct pcc_acpi *pcc = acpi_driver_data(device);
673 sysfs_remove_group(&device->dev.kobj, &pcc_attr_group);
675 backlight_device_unregister(pcc->backlight);
677 acpi_pcc_destroy_input(pcc);
685 static void __exit acpi_pcc_exit(void)
687 acpi_bus_unregister_driver(&acpi_pcc_driver);
690 module_init(acpi_pcc_init);
691 module_exit(acpi_pcc_exit);