treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 156
[sfrench/cifs-2.6.git] / drivers / platform / x86 / asus-wmi.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Asus PC WMI hotkey driver
4  *
5  * Copyright(C) 2010 Intel Corporation.
6  * Copyright(C) 2010-2011 Corentin Chary <corentin.chary@gmail.com>
7  *
8  * Portions based on wistron_btns.c:
9  * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
10  * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
11  * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
12  */
13
14 #ifndef _ASUS_WMI_H_
15 #define _ASUS_WMI_H_
16
17 #include <linux/platform_device.h>
18 #include <linux/i8042.h>
19
20 #define ASUS_WMI_KEY_IGNORE (-1)
21 #define ASUS_WMI_BRN_DOWN       0x20
22 #define ASUS_WMI_BRN_UP         0x2f
23
24 struct module;
25 struct key_entry;
26 struct asus_wmi;
27
28 struct quirk_entry {
29         bool hotplug_wireless;
30         bool scalar_panel_brightness;
31         bool store_backlight_power;
32         bool wmi_backlight_power;
33         bool wmi_backlight_native;
34         bool wmi_force_als_set;
35         int wapf;
36         /*
37          * For machines with AMD graphic chips, it will send out WMI event
38          * and ACPI interrupt at the same time while hitting the hotkey.
39          * To simplify the problem, we just have to ignore the WMI event,
40          * and let the ACPI interrupt to send out the key event.
41          */
42         int no_display_toggle;
43         u32 xusb2pr;
44
45         bool (*i8042_filter)(unsigned char data, unsigned char str,
46                              struct serio *serio);
47 };
48
49 struct asus_wmi_driver {
50         int                     brightness;
51         int                     panel_power;
52         int                     wlan_ctrl_by_user;
53
54         const char              *name;
55         struct module           *owner;
56
57         const char              *event_guid;
58
59         const struct key_entry  *keymap;
60         const char              *input_name;
61         const char              *input_phys;
62         struct quirk_entry      *quirks;
63         /* Returns new code, value, and autorelease values in arguments.
64          * Return ASUS_WMI_KEY_IGNORE in code if event should be ignored. */
65         void (*key_filter) (struct asus_wmi_driver *driver, int *code,
66                             unsigned int *value, bool *autorelease);
67
68         int (*probe) (struct platform_device *device);
69         void (*detect_quirks) (struct asus_wmi_driver *driver);
70
71         struct platform_driver  platform_driver;
72         struct platform_device *platform_device;
73 };
74
75 int asus_wmi_register_driver(struct asus_wmi_driver *driver);
76 void asus_wmi_unregister_driver(struct asus_wmi_driver *driver);
77
78 #endif /* !_ASUS_WMI_H_ */