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 <linux/acpi.h>
129 #include <linux/input.h>
130 #include <linux/input/sparse-keymap.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
);
178 static void acpi_pcc_hotkey_notify(struct acpi_device
*device
, u32 event
);
180 static const struct acpi_device_id pcc_device_ids
[] = {
187 MODULE_DEVICE_TABLE(acpi
, pcc_device_ids
);
189 #ifdef CONFIG_PM_SLEEP
190 static int acpi_pcc_hotkey_resume(struct device
*dev
);
192 static SIMPLE_DEV_PM_OPS(acpi_pcc_hotkey_pm
, NULL
, acpi_pcc_hotkey_resume
);
194 static struct acpi_driver acpi_pcc_driver
= {
195 .name
= ACPI_PCC_DRIVER_NAME
,
196 .class = ACPI_PCC_CLASS
,
197 .ids
= pcc_device_ids
,
199 .add
= acpi_pcc_hotkey_add
,
200 .remove
= acpi_pcc_hotkey_remove
,
201 .notify
= acpi_pcc_hotkey_notify
,
203 .drv
.pm
= &acpi_pcc_hotkey_pm
,
206 static const struct key_entry panasonic_keymap
[] = {
207 { KE_KEY
, 0, { KEY_RESERVED
} },
208 { KE_KEY
, 1, { KEY_BRIGHTNESSDOWN
} },
209 { KE_KEY
, 2, { KEY_BRIGHTNESSUP
} },
210 { KE_KEY
, 3, { KEY_DISPLAYTOGGLE
} },
211 { KE_KEY
, 4, { KEY_MUTE
} },
212 { KE_KEY
, 5, { KEY_VOLUMEDOWN
} },
213 { KE_KEY
, 6, { KEY_VOLUMEUP
} },
214 { KE_KEY
, 7, { KEY_SLEEP
} },
215 { KE_KEY
, 8, { KEY_PROG1
} }, /* Change CPU boost */
216 { KE_KEY
, 9, { KEY_BATTERY
} },
217 { KE_KEY
, 10, { KEY_SUSPEND
} },
223 unsigned long num_sifr
;
226 struct acpi_device
*device
;
227 struct input_dev
*input_dev
;
228 struct backlight_device
*backlight
;
231 /* method access functions */
232 static int acpi_pcc_write_sset(struct pcc_acpi
*pcc
, int func
, int val
)
234 union acpi_object in_objs
[] = {
235 { .integer
.type
= ACPI_TYPE_INTEGER
,
236 .integer
.value
= func
, },
237 { .integer
.type
= ACPI_TYPE_INTEGER
,
238 .integer
.value
= val
, },
240 struct acpi_object_list params
= {
241 .count
= ARRAY_SIZE(in_objs
),
244 acpi_status status
= AE_OK
;
246 status
= acpi_evaluate_object(pcc
->handle
, METHOD_HKEY_SSET
,
249 return (status
== AE_OK
) ? 0 : -EIO
;
252 static inline int acpi_pcc_get_sqty(struct acpi_device
*device
)
254 unsigned long long s
;
257 status
= acpi_evaluate_integer(device
->handle
, METHOD_HKEY_SQTY
,
259 if (ACPI_SUCCESS(status
))
262 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
263 "evaluation error HKEY.SQTY\n"));
268 static int acpi_pcc_retrieve_biosdata(struct pcc_acpi
*pcc
)
271 struct acpi_buffer buffer
= {ACPI_ALLOCATE_BUFFER
, NULL
};
272 union acpi_object
*hkey
= NULL
;
275 status
= acpi_evaluate_object(pcc
->handle
, METHOD_HKEY_SINF
, NULL
,
277 if (ACPI_FAILURE(status
)) {
278 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
279 "evaluation error HKEY.SINF\n"));
283 hkey
= buffer
.pointer
;
284 if (!hkey
|| (hkey
->type
!= ACPI_TYPE_PACKAGE
)) {
285 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 pcc
->sinf
[i
] = element
->integer
.value
;
302 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
303 "Invalid HKEY.SINF data\n"));
305 pcc
->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
))
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
))
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 const 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
))
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
))
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
))
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
))
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 const 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 sleep_keydown_seen
;
449 static void acpi_pcc_generate_keyinput(struct pcc_acpi
*pcc
)
451 struct input_dev
*hotk_input_dev
= pcc
->input_dev
;
453 unsigned long long result
;
455 rc
= acpi_evaluate_integer(pcc
->handle
, METHOD_HKEY_QUERY
,
457 if (ACPI_FAILURE(rc
)) {
458 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
459 "error getting hotkey status\n"));
463 /* hack: some firmware sends no key down for sleep / hibernate */
464 if ((result
& 0xf) == 0x7 || (result
& 0xf) == 0xa) {
466 sleep_keydown_seen
= 1;
467 if (!sleep_keydown_seen
)
468 sparse_keymap_report_event(hotk_input_dev
,
469 result
& 0xf, 0x80, false);
472 if (!sparse_keymap_report_event(hotk_input_dev
,
473 result
& 0xf, result
& 0x80, false))
474 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
475 "Unknown hotkey event: %d\n", result
));
478 static void acpi_pcc_hotkey_notify(struct acpi_device
*device
, u32 event
)
480 struct pcc_acpi
*pcc
= acpi_driver_data(device
);
484 acpi_pcc_generate_keyinput(pcc
);
492 static int acpi_pcc_init_input(struct pcc_acpi
*pcc
)
494 struct input_dev
*input_dev
;
497 input_dev
= input_allocate_device();
501 input_dev
->name
= ACPI_PCC_DRIVER_NAME
;
502 input_dev
->phys
= ACPI_PCC_INPUT_PHYS
;
503 input_dev
->id
.bustype
= BUS_HOST
;
504 input_dev
->id
.vendor
= 0x0001;
505 input_dev
->id
.product
= 0x0001;
506 input_dev
->id
.version
= 0x0100;
508 error
= sparse_keymap_setup(input_dev
, panasonic_keymap
, NULL
);
510 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
511 "Unable to setup input device keymap\n"));
515 error
= input_register_device(input_dev
);
517 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
518 "Unable to register input device\n"));
522 pcc
->input_dev
= input_dev
;
526 input_free_device(input_dev
);
530 /* kernel module interface */
532 #ifdef CONFIG_PM_SLEEP
533 static int acpi_pcc_hotkey_resume(struct device
*dev
)
535 struct pcc_acpi
*pcc
;
540 pcc
= acpi_driver_data(to_acpi_device(dev
));
544 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Sticky mode restore: %d\n",
547 return acpi_pcc_write_sset(pcc
, SINF_STICKY_KEY
, pcc
->sticky_mode
);
551 static int acpi_pcc_hotkey_add(struct acpi_device
*device
)
553 struct backlight_properties props
;
554 struct pcc_acpi
*pcc
;
555 int num_sifr
, result
;
560 num_sifr
= acpi_pcc_get_sqty(device
);
562 if (num_sifr
< 0 || num_sifr
> 255) {
563 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "num_sifr out of range"));
567 pcc
= kzalloc(sizeof(struct pcc_acpi
), GFP_KERNEL
);
569 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
570 "Couldn't allocate mem for pcc"));
574 pcc
->sinf
= kzalloc(sizeof(u32
) * (num_sifr
+ 1), GFP_KERNEL
);
580 pcc
->device
= device
;
581 pcc
->handle
= device
->handle
;
582 pcc
->num_sifr
= num_sifr
;
583 device
->driver_data
= pcc
;
584 strcpy(acpi_device_name(device
), ACPI_PCC_DEVICE_NAME
);
585 strcpy(acpi_device_class(device
), ACPI_PCC_CLASS
);
587 result
= acpi_pcc_init_input(pcc
);
589 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
590 "Error installing keyinput handler\n"));
594 if (!acpi_pcc_retrieve_biosdata(pcc
)) {
595 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
596 "Couldn't retrieve BIOS data\n"));
600 /* initialize backlight */
601 memset(&props
, 0, sizeof(struct backlight_properties
));
602 props
.type
= BACKLIGHT_PLATFORM
;
603 props
.max_brightness
= pcc
->sinf
[SINF_AC_MAX_BRIGHT
];
604 pcc
->backlight
= backlight_device_register("panasonic", NULL
, pcc
,
605 &pcc_backlight_ops
, &props
);
606 if (IS_ERR(pcc
->backlight
)) {
607 result
= PTR_ERR(pcc
->backlight
);
611 /* read the initial brightness setting from the hardware */
612 pcc
->backlight
->props
.brightness
= pcc
->sinf
[SINF_AC_CUR_BRIGHT
];
614 /* read the initial sticky key mode from the hardware */
615 pcc
->sticky_mode
= pcc
->sinf
[SINF_STICKY_KEY
];
617 /* add sysfs attributes */
618 result
= sysfs_create_group(&device
->dev
.kobj
, &pcc_attr_group
);
625 backlight_device_unregister(pcc
->backlight
);
627 input_unregister_device(pcc
->input_dev
);
636 static int acpi_pcc_hotkey_remove(struct acpi_device
*device
)
638 struct pcc_acpi
*pcc
= acpi_driver_data(device
);
643 sysfs_remove_group(&device
->dev
.kobj
, &pcc_attr_group
);
645 backlight_device_unregister(pcc
->backlight
);
647 input_unregister_device(pcc
->input_dev
);
655 module_acpi_driver(acpi_pcc_driver
);