2 * quickstart.c - ACPI Direct App Launch driver
5 * Copyright (C) 2007-2010 Angelo Arrifano <miknix@gmail.com>
7 * Information gathered from disassebled 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.03"
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/init.h>
31 #include <linux/types.h>
32 #include <acpi/acpi_drivers.h>
33 #include <linux/platform_device.h>
34 #include <linux/input.h>
36 MODULE_AUTHOR("Angelo Arrifano");
37 MODULE_DESCRIPTION("ACPI Direct App Launch driver");
38 MODULE_LICENSE("GPL");
40 #define QUICKSTART_ACPI_DEVICE_NAME "quickstart"
41 #define QUICKSTART_ACPI_CLASS "quickstart"
42 #define QUICKSTART_ACPI_HID "PNP0C32"
44 #define QUICKSTART_PF_DRIVER_NAME "quickstart"
45 #define QUICKSTART_PF_DEVICE_NAME "quickstart"
46 #define QUICKSTART_PF_DEVATTR_NAME "pressed_button"
48 #define QUICKSTART_MAX_BTN_NAME_LEN 16
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. */
53 #define QUICKSTART_EVENT_WAKE 0x02
54 #define QUICKSTART_EVENT_RUNTIME 0x80
56 struct quickstart_btn {
59 struct quickstart_btn *next;
62 static struct quickstart_driver_data {
63 struct quickstart_btn *btn_lst;
64 struct quickstart_btn *pressed;
67 /* ACPI driver Structs */
68 struct quickstart_acpi {
69 struct acpi_device *device;
70 struct quickstart_btn *btn;
72 static int quickstart_acpi_add(struct acpi_device *device);
73 static int quickstart_acpi_remove(struct acpi_device *device, int type);
74 static const struct acpi_device_id quickstart_device_ids[] = {
75 {QUICKSTART_ACPI_HID, 0},
79 static struct acpi_driver quickstart_acpi_driver = {
81 .class = QUICKSTART_ACPI_CLASS,
82 .ids = quickstart_device_ids,
84 .add = quickstart_acpi_add,
85 .remove = quickstart_acpi_remove,
89 /* Input device structs */
90 struct input_dev *quickstart_input;
92 /* Platform driver structs */
93 static ssize_t buttons_show(struct device *dev,
94 struct device_attribute *attr,
96 static ssize_t pressed_button_show(struct device *dev,
97 struct device_attribute *attr,
99 static ssize_t pressed_button_store(struct device *dev,
100 struct device_attribute *attr,
103 static DEVICE_ATTR(pressed_button, 0666, pressed_button_show,
104 pressed_button_store);
105 static DEVICE_ATTR(buttons, 0444, buttons_show, NULL);
106 static struct platform_device *pf_device;
107 static struct platform_driver pf_driver = {
109 .name = QUICKSTART_PF_DRIVER_NAME,
110 .owner = THIS_MODULE,
115 * Platform driver functions
117 static ssize_t buttons_show(struct device *dev,
118 struct device_attribute *attr,
122 struct quickstart_btn *ptr = quickstart_data.btn_lst;
125 return snprintf(buf, PAGE_SIZE, "none");
127 while (ptr && (count < PAGE_SIZE)) {
129 count += snprintf(buf + count,
131 "%d\t%s\n", ptr->id, ptr->name);
139 static ssize_t pressed_button_show(struct device *dev,
140 struct device_attribute *attr,
143 return snprintf(buf, PAGE_SIZE, "%s\n",
144 (quickstart_data.pressed?quickstart_data.pressed->name:"none"));
148 static ssize_t pressed_button_store(struct device *dev,
149 struct device_attribute *attr,
150 const char *buf, size_t count)
155 if (strncasecmp(buf, "none", 4) != 0)
158 quickstart_data.pressed = NULL;
162 /* Hotstart Helper functions */
163 static int quickstart_btnlst_add(struct quickstart_btn **data)
165 struct quickstart_btn **ptr = &quickstart_data.btn_lst;
168 ptr = &((*ptr)->next);
170 *ptr = kzalloc(sizeof(struct quickstart_btn), GFP_KERNEL);
180 static void quickstart_btnlst_del(struct quickstart_btn *data)
182 struct quickstart_btn **ptr = &quickstart_data.btn_lst;
193 ptr = &((*ptr)->next);
199 static void quickstart_btnlst_free(void)
201 struct quickstart_btn *ptr = quickstart_data.btn_lst;
202 struct quickstart_btn *lptr = NULL;
214 /* ACPI Driver functions */
215 static void quickstart_acpi_notify(acpi_handle handle, u32 event, void *data)
217 struct quickstart_acpi *quickstart = data;
222 if (event == QUICKSTART_EVENT_WAKE)
223 quickstart_data.pressed = quickstart->btn;
224 else if (event == QUICKSTART_EVENT_RUNTIME) {
225 input_report_key(quickstart_input, quickstart->btn->id, 1);
226 input_sync(quickstart_input);
227 input_report_key(quickstart_input, quickstart->btn->id, 0);
228 input_sync(quickstart_input);
233 static void quickstart_acpi_ghid(struct quickstart_acpi *quickstart)
236 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
237 uint32_t usageid = 0;
242 /* This returns a buffer telling the button usage ID,
243 * and triggers pending notify events (The ones before booting). */
244 status = acpi_evaluate_object(quickstart->device->handle,
245 "GHID", NULL, &buffer);
246 if (ACPI_FAILURE(status) || !buffer.pointer) {
247 printk(KERN_ERR "quickstart: %s GHID method failed.\n",
248 quickstart->btn->name);
252 if (buffer.length < 8)
255 /* <<The GHID method can return a BYTE, WORD, or DWORD.
256 * The value must be encoded in little-endian byte
257 * order (least significant byte first).>> */
258 usageid = *((uint32_t *)(buffer.pointer + (buffer.length - 8)));
259 quickstart->btn->id = usageid;
261 kfree(buffer.pointer);
264 static int quickstart_acpi_config(struct quickstart_acpi *quickstart, char *bid)
266 int len = strlen(bid);
269 /* Add button to list */
270 ret = quickstart_btnlst_add(&quickstart->btn);
274 quickstart->btn->name = kzalloc(len + 1, GFP_KERNEL);
275 if (!quickstart->btn->name) {
276 quickstart_btnlst_free();
279 strcpy(quickstart->btn->name, bid);
284 static int quickstart_acpi_add(struct acpi_device *device)
287 acpi_status status = AE_OK;
288 struct quickstart_acpi *quickstart = NULL;
293 quickstart = kzalloc(sizeof(struct quickstart_acpi), GFP_KERNEL);
297 quickstart->device = device;
298 strcpy(acpi_device_name(device), QUICKSTART_ACPI_DEVICE_NAME);
299 strcpy(acpi_device_class(device), QUICKSTART_ACPI_CLASS);
300 device->driver_data = quickstart;
302 /* Add button to list and initialize some stuff */
303 ret = quickstart_acpi_config(quickstart, acpi_device_bid(device));
307 status = acpi_install_notify_handler(device->handle,
309 quickstart_acpi_notify,
311 if (ACPI_FAILURE(status)) {
312 printk(KERN_ERR "quickstart: Notify handler install error\n");
314 goto fail_installnotify;
317 quickstart_acpi_ghid(quickstart);
322 quickstart_btnlst_del(quickstart->btn);
331 static int quickstart_acpi_remove(struct acpi_device *device, int type)
333 acpi_status status = 0;
334 struct quickstart_acpi *quickstart = NULL;
336 if (!device || !acpi_driver_data(device))
339 quickstart = acpi_driver_data(device);
341 status = acpi_remove_notify_handler(device->handle,
343 quickstart_acpi_notify);
344 if (ACPI_FAILURE(status))
345 printk(KERN_ERR "quickstart: Error removing notify handler\n");
353 /* Module functions */
355 static void quickstart_exit(void)
357 input_unregister_device(quickstart_input);
359 device_remove_file(&pf_device->dev, &dev_attr_pressed_button);
360 device_remove_file(&pf_device->dev, &dev_attr_buttons);
362 platform_device_unregister(pf_device);
364 platform_driver_unregister(&pf_driver);
366 acpi_bus_unregister_driver(&quickstart_acpi_driver);
368 quickstart_btnlst_free();
373 static int __init quickstart_init_input(void)
375 struct quickstart_btn **ptr = &quickstart_data.btn_lst;
379 quickstart_input = input_allocate_device();
381 if (!quickstart_input)
384 quickstart_input->name = "Quickstart ACPI Buttons";
385 quickstart_input->id.bustype = BUS_HOST;
389 set_bit(EV_KEY, quickstart_input->evbit);
390 set_bit((*ptr)->id, quickstart_input->keybit);
391 ptr = &((*ptr)->next);
394 ret = input_register_device(quickstart_input);
396 input_free_device(quickstart_input);
403 static int __init quickstart_init(void)
411 /* ACPI driver register */
412 ret = acpi_bus_register_driver(&quickstart_acpi_driver);
416 /* If existing bus with no devices */
417 if (!quickstart_data.btn_lst) {
422 /* Platform driver register */
423 ret = platform_driver_register(&pf_driver);
427 /* Platform device register */
428 pf_device = platform_device_alloc(QUICKSTART_PF_DEVICE_NAME, -1);
431 goto fail_pfdev_alloc;
433 ret = platform_device_add(pf_device);
437 /* Create device sysfs file */
438 ret = device_create_file(&pf_device->dev, &dev_attr_pressed_button);
442 ret = device_create_file(&pf_device->dev, &dev_attr_buttons);
448 ret = quickstart_init_input();
452 printk(KERN_INFO "quickstart: ACPI Direct App Launch ver %s\n",
457 device_remove_file(&pf_device->dev, &dev_attr_buttons);
460 device_remove_file(&pf_device->dev, &dev_attr_pressed_button);
463 platform_device_del(pf_device);
466 platform_device_put(pf_device);
469 platform_driver_unregister(&pf_driver);
472 acpi_bus_unregister_driver(&quickstart_acpi_driver);
477 module_init(quickstart_init);
478 module_exit(quickstart_exit);