2 * quickstart.c - ACPI Direct App Launch driver
5 * Copyright (C) 2007-2010 Angelo Arrifano <miknix@gmail.com>
7 * Information gathered from disassembled dsdt and from here:
8 * <http://www.microsoft.com/whdc/system/platform/firmware/DirAppLaunch.mspx>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
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
26 #define QUICKSTART_VERSION "1.04"
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/init.h>
33 #include <linux/types.h>
34 #include <acpi/acpi_drivers.h>
35 #include <linux/platform_device.h>
36 #include <linux/input.h>
38 MODULE_AUTHOR("Angelo Arrifano");
39 MODULE_DESCRIPTION("ACPI Direct App Launch driver");
40 MODULE_LICENSE("GPL");
42 #define QUICKSTART_ACPI_DEVICE_NAME "quickstart"
43 #define QUICKSTART_ACPI_CLASS "quickstart"
44 #define QUICKSTART_ACPI_HID "PNP0C32"
46 #define QUICKSTART_PF_DRIVER_NAME "quickstart"
47 #define QUICKSTART_PF_DEVICE_NAME "quickstart"
50 * There will be two events:
51 * 0x02 - A hot button was pressed while device was off/sleeping.
52 * 0x80 - A hot button was pressed while device was up.
54 #define QUICKSTART_EVENT_WAKE 0x02
55 #define QUICKSTART_EVENT_RUNTIME 0x80
57 struct quickstart_button {
60 struct list_head list;
63 struct quickstart_acpi {
64 struct acpi_device *device;
65 struct quickstart_button *button;
68 static LIST_HEAD(buttons);
69 static struct quickstart_button *pressed;
71 static struct input_dev *quickstart_input;
73 /* Platform driver functions */
74 static ssize_t quickstart_buttons_show(struct device *dev,
75 struct device_attribute *attr,
79 struct quickstart_button *b;
81 if (list_empty(&buttons))
82 return snprintf(buf, PAGE_SIZE, "none");
84 list_for_each_entry(b, &buttons, list) {
85 count += snprintf(buf + count, PAGE_SIZE - count, "%u\t%s\n",
88 if (count >= PAGE_SIZE) {
97 static ssize_t quickstart_pressed_button_show(struct device *dev,
98 struct device_attribute *attr,
101 return scnprintf(buf, PAGE_SIZE, "%s\n",
102 (pressed ? pressed->name : "none"));
106 static ssize_t quickstart_pressed_button_store(struct device *dev,
107 struct device_attribute *attr,
108 const char *buf, size_t count)
113 if (strncasecmp(buf, "none", 4) != 0)
120 /* Helper functions */
121 static struct quickstart_button *quickstart_buttons_add(void)
123 struct quickstart_button *b;
125 b = kzalloc(sizeof(*b), GFP_KERNEL);
129 list_add_tail(&b->list, &buttons);
134 static void quickstart_button_del(struct quickstart_button *data)
139 list_del(&data->list);
144 static void quickstart_buttons_free(void)
146 struct quickstart_button *b, *n;
148 list_for_each_entry_safe(b, n, &buttons, list)
149 quickstart_button_del(b);
152 /* ACPI Driver functions */
153 static void quickstart_acpi_notify(acpi_handle handle, u32 event, void *data)
155 struct quickstart_acpi *quickstart = data;
161 case QUICKSTART_EVENT_WAKE:
162 pressed = quickstart->button;
164 case QUICKSTART_EVENT_RUNTIME:
165 input_report_key(quickstart_input, quickstart->button->id, 1);
166 input_sync(quickstart_input);
167 input_report_key(quickstart_input, quickstart->button->id, 0);
168 input_sync(quickstart_input);
171 pr_err("Unexpected ACPI event notify (%u)\n", event);
176 static int quickstart_acpi_ghid(struct quickstart_acpi *quickstart)
179 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
183 * This returns a buffer telling the button usage ID,
184 * and triggers pending notify events (The ones before booting).
186 status = acpi_evaluate_object(quickstart->device->handle, "GHID", NULL,
188 if (ACPI_FAILURE(status)) {
189 pr_err("%s GHID method failed\n", quickstart->button->name);
194 * <<The GHID method can return a BYTE, WORD, or DWORD.
195 * The value must be encoded in little-endian byte
196 * order (least significant byte first).>>
198 switch (buffer.length) {
200 quickstart->button->id = *(uint8_t *)buffer.pointer;
203 quickstart->button->id = *(uint16_t *)buffer.pointer;
206 quickstart->button->id = *(uint32_t *)buffer.pointer;
209 quickstart->button->id = *(uint64_t *)buffer.pointer;
212 pr_err("%s GHID method returned buffer of unexpected length %lu\n",
213 quickstart->button->name,
214 (unsigned long)buffer.length);
219 kfree(buffer.pointer);
224 static int quickstart_acpi_config(struct quickstart_acpi *quickstart)
226 char *bid = acpi_device_bid(quickstart->device);
229 name = kmalloc(strlen(bid) + 1, GFP_KERNEL);
233 /* Add new button to list */
234 quickstart->button = quickstart_buttons_add();
235 if (!quickstart->button) {
240 quickstart->button->name = name;
241 strcpy(quickstart->button->name, bid);
246 static int quickstart_acpi_add(struct acpi_device *device)
250 struct quickstart_acpi *quickstart;
255 quickstart = kzalloc(sizeof(*quickstart), GFP_KERNEL);
259 quickstart->device = device;
261 strcpy(acpi_device_name(device), QUICKSTART_ACPI_DEVICE_NAME);
262 strcpy(acpi_device_class(device), QUICKSTART_ACPI_CLASS);
263 device->driver_data = quickstart;
265 /* Add button to list and initialize some stuff */
266 ret = quickstart_acpi_config(quickstart);
270 status = acpi_install_notify_handler(device->handle, ACPI_ALL_NOTIFY,
271 quickstart_acpi_notify,
273 if (ACPI_FAILURE(status)) {
274 pr_err("Notify handler install error\n");
276 goto fail_installnotify;
279 ret = quickstart_acpi_ghid(quickstart);
286 acpi_remove_notify_handler(device->handle, ACPI_ALL_NOTIFY,
287 quickstart_acpi_notify);
290 quickstart_button_del(quickstart->button);
299 static int quickstart_acpi_remove(struct acpi_device *device)
302 struct quickstart_acpi *quickstart;
307 quickstart = acpi_driver_data(device);
311 status = acpi_remove_notify_handler(device->handle, ACPI_ALL_NOTIFY,
312 quickstart_acpi_notify);
313 if (ACPI_FAILURE(status))
314 pr_err("Error removing notify handler\n");
321 /* Platform driver structs */
322 static DEVICE_ATTR(pressed_button, 0666, quickstart_pressed_button_show,
323 quickstart_pressed_button_store);
324 static DEVICE_ATTR(buttons, 0444, quickstart_buttons_show, NULL);
325 static struct platform_device *pf_device;
326 static struct platform_driver pf_driver = {
328 .name = QUICKSTART_PF_DRIVER_NAME,
329 .owner = THIS_MODULE,
333 static const struct acpi_device_id quickstart_device_ids[] = {
334 {QUICKSTART_ACPI_HID, 0},
338 static struct acpi_driver quickstart_acpi_driver = {
339 .name = "quickstart",
340 .class = QUICKSTART_ACPI_CLASS,
341 .ids = quickstart_device_ids,
343 .add = quickstart_acpi_add,
344 .remove = quickstart_acpi_remove,
348 /* Module functions */
349 static void quickstart_exit(void)
351 input_unregister_device(quickstart_input);
353 device_remove_file(&pf_device->dev, &dev_attr_pressed_button);
354 device_remove_file(&pf_device->dev, &dev_attr_buttons);
356 platform_device_unregister(pf_device);
358 platform_driver_unregister(&pf_driver);
360 acpi_bus_unregister_driver(&quickstart_acpi_driver);
362 quickstart_buttons_free();
365 static int __init quickstart_init_input(void)
367 struct quickstart_button *b;
370 quickstart_input = input_allocate_device();
372 if (!quickstart_input)
375 quickstart_input->name = "Quickstart ACPI Buttons";
376 quickstart_input->id.bustype = BUS_HOST;
378 list_for_each_entry(b, &buttons, list) {
379 set_bit(EV_KEY, quickstart_input->evbit);
380 set_bit(b->id, quickstart_input->keybit);
383 ret = input_register_device(quickstart_input);
385 input_free_device(quickstart_input);
392 static int __init quickstart_init(void)
400 /* ACPI driver register */
401 ret = acpi_bus_register_driver(&quickstart_acpi_driver);
405 /* If existing bus with no devices */
406 if (list_empty(&buttons)) {
411 /* Platform driver register */
412 ret = platform_driver_register(&pf_driver);
416 /* Platform device register */
417 pf_device = platform_device_alloc(QUICKSTART_PF_DEVICE_NAME, -1);
420 goto fail_pfdev_alloc;
422 ret = platform_device_add(pf_device);
426 /* Create device sysfs file */
427 ret = device_create_file(&pf_device->dev, &dev_attr_pressed_button);
431 ret = device_create_file(&pf_device->dev, &dev_attr_buttons);
436 ret = quickstart_init_input();
440 pr_info("ACPI Direct App Launch ver %s\n", QUICKSTART_VERSION);
444 device_remove_file(&pf_device->dev, &dev_attr_buttons);
447 device_remove_file(&pf_device->dev, &dev_attr_pressed_button);
450 platform_device_del(pf_device);
453 platform_device_put(pf_device);
456 platform_driver_unregister(&pf_driver);
459 acpi_bus_unregister_driver(&quickstart_acpi_driver);
464 module_init(quickstart_init);
465 module_exit(quickstart_exit);