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 <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
, int type
);
180 static int acpi_pcc_hotkey_resume(struct acpi_device
*device
);
181 static void acpi_pcc_hotkey_notify(struct acpi_device
*device
, u32 event
);
183 static const struct acpi_device_id pcc_device_ids
[] = {
190 MODULE_DEVICE_TABLE(acpi
, pcc_device_ids
);
192 static struct acpi_driver acpi_pcc_driver
= {
193 .name
= ACPI_PCC_DRIVER_NAME
,
194 .class = ACPI_PCC_CLASS
,
195 .ids
= pcc_device_ids
,
197 .add
= acpi_pcc_hotkey_add
,
198 .remove
= acpi_pcc_hotkey_remove
,
199 .resume
= acpi_pcc_hotkey_resume
,
200 .notify
= acpi_pcc_hotkey_notify
,
204 static 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
} }, /* Change CPU boost */
214 { KE_KEY
, 9, { KEY_BATTERY
} },
215 { KE_KEY
, 10, { KEY_SUSPEND
} },
221 unsigned long num_sifr
;
224 struct acpi_device
*device
;
225 struct input_dev
*input_dev
;
226 struct backlight_device
*backlight
;
229 struct pcc_keyinput
{
230 struct acpi_hotkey
*hotkey
;
233 /* method access functions */
234 static int acpi_pcc_write_sset(struct pcc_acpi
*pcc
, int func
, int val
)
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
, },
242 struct acpi_object_list params
= {
243 .count
= ARRAY_SIZE(in_objs
),
246 acpi_status status
= AE_OK
;
248 status
= acpi_evaluate_object(pcc
->handle
, METHOD_HKEY_SSET
,
251 return (status
== AE_OK
) ? 0 : -EIO
;
254 static inline int acpi_pcc_get_sqty(struct acpi_device
*device
)
256 unsigned long long s
;
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
)
273 struct acpi_buffer buffer
= {ACPI_ALLOCATE_BUFFER
, NULL
};
274 union acpi_object
*hkey
= NULL
;
277 status
= acpi_evaluate_object(pcc
->handle
, METHOD_HKEY_SINF
, NULL
,
279 if (ACPI_FAILURE(status
)) {
280 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
281 "evaluation error HKEY.SINF\n"));
285 hkey
= buffer
.pointer
;
286 if (!hkey
|| (hkey
->type
!= ACPI_TYPE_PACKAGE
)) {
287 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Invalid HKEY.SINF\n"));
292 if (pcc
->num_sifr
< hkey
->package
.count
) {
293 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
294 "SQTY reports bad SINF length\n"));
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
;
304 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
305 "Invalid HKEY.SINF data\n"));
307 pcc
->sinf
[hkey
->package
.count
] = -1;
310 kfree(buffer
.pointer
);
311 return status
== AE_OK
;
314 /* backlight API interface functions */
316 /* This driver currently treats AC and DC brightness identical,
317 * since we don't need to invent an interface to the core ACPI
318 * logic to receive events in case a power supply is plugged in
321 static int bl_get(struct backlight_device
*bd
)
323 struct pcc_acpi
*pcc
= bl_get_data(bd
);
325 if (!acpi_pcc_retrieve_biosdata(pcc
))
328 return pcc
->sinf
[SINF_AC_CUR_BRIGHT
];
331 static int bl_set_status(struct backlight_device
*bd
)
333 struct pcc_acpi
*pcc
= bl_get_data(bd
);
334 int bright
= bd
->props
.brightness
;
337 if (!acpi_pcc_retrieve_biosdata(pcc
))
340 if (bright
< pcc
->sinf
[SINF_AC_MIN_BRIGHT
])
341 bright
= pcc
->sinf
[SINF_AC_MIN_BRIGHT
];
343 if (bright
< pcc
->sinf
[SINF_DC_MIN_BRIGHT
])
344 bright
= pcc
->sinf
[SINF_DC_MIN_BRIGHT
];
346 if (bright
< pcc
->sinf
[SINF_AC_MIN_BRIGHT
] ||
347 bright
> pcc
->sinf
[SINF_AC_MAX_BRIGHT
])
350 rc
= acpi_pcc_write_sset(pcc
, SINF_AC_CUR_BRIGHT
, bright
);
354 return acpi_pcc_write_sset(pcc
, SINF_DC_CUR_BRIGHT
, bright
);
357 static const struct backlight_ops pcc_backlight_ops
= {
358 .get_brightness
= bl_get
,
359 .update_status
= bl_set_status
,
363 /* sysfs user interface functions */
365 static ssize_t
show_numbatt(struct device
*dev
, struct device_attribute
*attr
,
368 struct acpi_device
*acpi
= to_acpi_device(dev
);
369 struct pcc_acpi
*pcc
= acpi_driver_data(acpi
);
371 if (!acpi_pcc_retrieve_biosdata(pcc
))
374 return snprintf(buf
, PAGE_SIZE
, "%u\n", pcc
->sinf
[SINF_NUM_BATTERIES
]);
377 static ssize_t
show_lcdtype(struct device
*dev
, struct device_attribute
*attr
,
380 struct acpi_device
*acpi
= to_acpi_device(dev
);
381 struct pcc_acpi
*pcc
= acpi_driver_data(acpi
);
383 if (!acpi_pcc_retrieve_biosdata(pcc
))
386 return snprintf(buf
, PAGE_SIZE
, "%u\n", pcc
->sinf
[SINF_LCD_TYPE
]);
389 static ssize_t
show_mute(struct device
*dev
, struct device_attribute
*attr
,
392 struct acpi_device
*acpi
= to_acpi_device(dev
);
393 struct pcc_acpi
*pcc
= acpi_driver_data(acpi
);
395 if (!acpi_pcc_retrieve_biosdata(pcc
))
398 return snprintf(buf
, PAGE_SIZE
, "%u\n", pcc
->sinf
[SINF_MUTE
]);
401 static ssize_t
show_sticky(struct device
*dev
, struct device_attribute
*attr
,
404 struct acpi_device
*acpi
= to_acpi_device(dev
);
405 struct pcc_acpi
*pcc
= acpi_driver_data(acpi
);
407 if (!acpi_pcc_retrieve_biosdata(pcc
))
410 return snprintf(buf
, PAGE_SIZE
, "%u\n", pcc
->sinf
[SINF_STICKY_KEY
]);
413 static ssize_t
set_sticky(struct device
*dev
, struct device_attribute
*attr
,
414 const char *buf
, size_t count
)
416 struct acpi_device
*acpi
= to_acpi_device(dev
);
417 struct pcc_acpi
*pcc
= acpi_driver_data(acpi
);
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
;
429 static DEVICE_ATTR(numbatt
, S_IRUGO
, show_numbatt
, NULL
);
430 static DEVICE_ATTR(lcdtype
, S_IRUGO
, show_lcdtype
, NULL
);
431 static DEVICE_ATTR(mute
, S_IRUGO
, show_mute
, NULL
);
432 static DEVICE_ATTR(sticky_key
, S_IRUGO
| S_IWUSR
, show_sticky
, set_sticky
);
434 static struct attribute
*pcc_sysfs_entries
[] = {
435 &dev_attr_numbatt
.attr
,
436 &dev_attr_lcdtype
.attr
,
438 &dev_attr_sticky_key
.attr
,
442 static struct attribute_group pcc_attr_group
= {
443 .name
= NULL
, /* put in device directory */
444 .attrs
= pcc_sysfs_entries
,
448 /* hotkey input device driver */
450 static void acpi_pcc_generate_keyinput(struct pcc_acpi
*pcc
)
452 struct input_dev
*hotk_input_dev
= pcc
->input_dev
;
454 unsigned long long result
;
456 rc
= acpi_evaluate_integer(pcc
->handle
, METHOD_HKEY_QUERY
,
458 if (!ACPI_SUCCESS(rc
)) {
459 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
460 "error getting hotkey status\n"));
464 acpi_bus_generate_proc_event(pcc
->device
, HKEY_NOTIFY
, result
);
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
));
472 static void acpi_pcc_hotkey_notify(struct acpi_device
*device
, u32 event
)
474 struct pcc_acpi
*pcc
= acpi_driver_data(device
);
478 acpi_pcc_generate_keyinput(pcc
);
486 static int acpi_pcc_init_input(struct pcc_acpi
*pcc
)
488 struct input_dev
*input_dev
;
491 input_dev
= input_allocate_device();
493 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
494 "Couldn't allocate input device for hotkey"));
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;
505 error
= sparse_keymap_setup(input_dev
, panasonic_keymap
, NULL
);
507 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
508 "Unable to setup input device keymap\n"));
512 error
= input_register_device(input_dev
);
514 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
515 "Unable to register input device\n"));
516 goto err_free_keymap
;
519 pcc
->input_dev
= input_dev
;
523 sparse_keymap_free(input_dev
);
525 input_free_device(input_dev
);
529 static void acpi_pcc_destroy_input(struct pcc_acpi
*pcc
)
531 sparse_keymap_free(pcc
->input_dev
);
532 input_unregister_device(pcc
->input_dev
);
534 * No need to input_free_device() since core input API refcounts
535 * and free()s the device.
539 /* kernel module interface */
541 static int acpi_pcc_hotkey_resume(struct acpi_device
*device
)
543 struct pcc_acpi
*pcc
= acpi_driver_data(device
);
545 if (device
== NULL
|| pcc
== NULL
)
548 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Sticky mode restore: %d\n",
551 return acpi_pcc_write_sset(pcc
, SINF_STICKY_KEY
, pcc
->sticky_mode
);
554 static int acpi_pcc_hotkey_add(struct acpi_device
*device
)
556 struct backlight_properties props
;
557 struct pcc_acpi
*pcc
;
558 int num_sifr
, result
;
563 num_sifr
= acpi_pcc_get_sqty(device
);
565 if (num_sifr
< 0 || num_sifr
> 255) {
566 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "num_sifr out of range"));
570 pcc
= kzalloc(sizeof(struct pcc_acpi
), GFP_KERNEL
);
572 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
573 "Couldn't allocate mem for pcc"));
577 pcc
->sinf
= kzalloc(sizeof(u32
) * (num_sifr
+ 1), GFP_KERNEL
);
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
);
590 result
= acpi_pcc_init_input(pcc
);
592 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
593 "Error installing keyinput handler\n"));
597 if (!acpi_pcc_retrieve_biosdata(pcc
)) {
598 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
599 "Couldn't retrieve BIOS data\n"));
603 /* initialize backlight */
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
);
614 /* read the initial brightness setting from the hardware */
615 pcc
->backlight
->props
.brightness
= pcc
->sinf
[SINF_AC_CUR_BRIGHT
];
617 /* read the initial sticky key mode from the hardware */
618 pcc
->sticky_mode
= pcc
->sinf
[SINF_STICKY_KEY
];
620 /* add sysfs attributes */
621 result
= sysfs_create_group(&device
->dev
.kobj
, &pcc_attr_group
);
628 backlight_device_unregister(pcc
->backlight
);
630 acpi_pcc_destroy_input(pcc
);
639 static int __init
acpi_pcc_init(void)
646 result
= acpi_bus_register_driver(&acpi_pcc_driver
);
648 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
649 "Error registering hotkey driver\n"));
656 static int acpi_pcc_hotkey_remove(struct acpi_device
*device
, int type
)
658 struct pcc_acpi
*pcc
= acpi_driver_data(device
);
663 sysfs_remove_group(&device
->dev
.kobj
, &pcc_attr_group
);
665 backlight_device_unregister(pcc
->backlight
);
667 acpi_pcc_destroy_input(pcc
);
675 static void __exit
acpi_pcc_exit(void)
677 acpi_bus_unregister_driver(&acpi_pcc_driver
);
680 module_init(acpi_pcc_init
);
681 module_exit(acpi_pcc_exit
);