1 /*
2  * Asus Notebooks WMI hotkey driver
3  *
4  * Copyright(C) 2010 Corentin Chary <corentin.chary@gmail.com>
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20 
21 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22 
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/input.h>
27 #include <linux/input/sparse-keymap.h>
28 #include <linux/fb.h>
29 #include <linux/dmi.h>
30 
31 #include "asus-wmi.h"
32 
33 #define	ASUS_NB_WMI_FILE	"asus-nb-wmi"
34 
35 MODULE_AUTHOR("Corentin Chary <corentin.chary@gmail.com>");
36 MODULE_DESCRIPTION("Asus Notebooks WMI Hotkey Driver");
37 MODULE_LICENSE("GPL");
38 
39 #define ASUS_NB_WMI_EVENT_GUID	"0B3CBB35-E3C2-45ED-91C2-4C5A6D195D1C"
40 
41 MODULE_ALIAS("wmi:"ASUS_NB_WMI_EVENT_GUID);
42 
43 /*
44  * WAPF defines the behavior of the Fn+Fx wlan key
45  * The significance of values is yet to be found, but
46  * most of the time:
47  * Bit | Bluetooth | WLAN
48  *  0  | Hardware  | Hardware
49  *  1  | Hardware  | Software
50  *  4  | Software  | Software
51  */
52 static int wapf = -1;
53 module_param(wapf, uint, 0444);
54 MODULE_PARM_DESC(wapf, "WAPF value");
55 
56 static struct quirk_entry *quirks;
57 
58 static struct quirk_entry quirk_asus_unknown = {
59 	.wapf = 0,
60 };
61 
62 /*
63  * For those machines that need software to control bt/wifi status
64  * and can't adjust brightness through ACPI interface
65  * and have duplicate events(ACPI and WMI) for display toggle
66  */
67 static struct quirk_entry quirk_asus_x55u = {
68 	.wapf = 4,
69 	.wmi_backlight_power = true,
70 	.no_display_toggle = true,
71 };
72 
73 static struct quirk_entry quirk_asus_wapf4 = {
74 	.wapf = 4,
75 };
76 
77 static struct quirk_entry quirk_asus_x200ca = {
78 	.wapf = 2,
79 };
80 
81 static struct quirk_entry quirk_no_rfkill = {
82 	.no_rfkill = true,
83 };
84 
85 static struct quirk_entry quirk_no_rfkill_wapf4 = {
86 	.wapf = 4,
87 	.no_rfkill = true,
88 };
89 
90 static int dmi_matched(const struct dmi_system_id *dmi)
91 {
92 	quirks = dmi->driver_data;
93 	return 1;
94 }
95 
96 static const struct dmi_system_id asus_quirks[] = {
97 	{
98 		.callback = dmi_matched,
99 		.ident = "ASUSTeK COMPUTER INC. U32U",
100 		.matches = {
101 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
102 			DMI_MATCH(DMI_PRODUCT_NAME, "U32U"),
103 		},
104 		/*
105 		 * Note this machine has a Brazos APU, and most Brazos Asus
106 		 * machines need quirk_asus_x55u / wmi_backlight_power but
107 		 * here acpi-video seems to work fine for backlight control.
108 		 */
109 		.driver_data = &quirk_asus_wapf4,
110 	},
111 	{
112 		.callback = dmi_matched,
113 		.ident = "ASUSTeK COMPUTER INC. X401U",
114 		.matches = {
115 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
116 			DMI_MATCH(DMI_PRODUCT_NAME, "X401U"),
117 		},
118 		.driver_data = &quirk_asus_x55u,
119 	},
120 	{
121 		.callback = dmi_matched,
122 		.ident = "ASUSTeK COMPUTER INC. X401A",
123 		.matches = {
124 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
125 			DMI_MATCH(DMI_PRODUCT_NAME, "X401A"),
126 		},
127 		.driver_data = &quirk_asus_wapf4,
128 	},
129 	{
130 		.callback = dmi_matched,
131 		.ident = "ASUSTeK COMPUTER INC. X401A1",
132 		.matches = {
133 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
134 			DMI_MATCH(DMI_PRODUCT_NAME, "X401A1"),
135 		},
136 		.driver_data = &quirk_asus_wapf4,
137 	},
138 	{
139 		.callback = dmi_matched,
140 		.ident = "ASUSTeK COMPUTER INC. X456UA",
141 		.matches = {
142 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
143 			DMI_MATCH(DMI_PRODUCT_NAME, "X456UA"),
144 		},
145 		.driver_data = &quirk_no_rfkill_wapf4,
146 	},
147 	{
148 		.callback = dmi_matched,
149 		.ident = "ASUSTeK COMPUTER INC. X456UF",
150 		.matches = {
151 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
152 			DMI_MATCH(DMI_PRODUCT_NAME, "X456UF"),
153 		},
154 		.driver_data = &quirk_no_rfkill_wapf4,
155 	},
156 	{
157 		.callback = dmi_matched,
158 		.ident = "ASUSTeK COMPUTER INC. X501U",
159 		.matches = {
160 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
161 			DMI_MATCH(DMI_PRODUCT_NAME, "X501U"),
162 		},
163 		.driver_data = &quirk_asus_x55u,
164 	},
165 	{
166 		.callback = dmi_matched,
167 		.ident = "ASUSTeK COMPUTER INC. X501A",
168 		.matches = {
169 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
170 			DMI_MATCH(DMI_PRODUCT_NAME, "X501A"),
171 		},
172 		.driver_data = &quirk_asus_wapf4,
173 	},
174 	{
175 		.callback = dmi_matched,
176 		.ident = "ASUSTeK COMPUTER INC. X501A1",
177 		.matches = {
178 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
179 			DMI_MATCH(DMI_PRODUCT_NAME, "X501A1"),
180 		},
181 		.driver_data = &quirk_asus_wapf4,
182 	},
183 	{
184 		.callback = dmi_matched,
185 		.ident = "ASUSTeK COMPUTER INC. X550CA",
186 		.matches = {
187 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
188 			DMI_MATCH(DMI_PRODUCT_NAME, "X550CA"),
189 		},
190 		.driver_data = &quirk_asus_wapf4,
191 	},
192 	{
193 		.callback = dmi_matched,
194 		.ident = "ASUSTeK COMPUTER INC. X550CC",
195 		.matches = {
196 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
197 			DMI_MATCH(DMI_PRODUCT_NAME, "X550CC"),
198 		},
199 		.driver_data = &quirk_asus_wapf4,
200 	},
201 	{
202 		.callback = dmi_matched,
203 		.ident = "ASUSTeK COMPUTER INC. X550CL",
204 		.matches = {
205 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
206 			DMI_MATCH(DMI_PRODUCT_NAME, "X550CL"),
207 		},
208 		.driver_data = &quirk_asus_wapf4,
209 	},
210 	{
211 		.callback = dmi_matched,
212 		.ident = "ASUSTeK COMPUTER INC. X550VB",
213 		.matches = {
214 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
215 			DMI_MATCH(DMI_PRODUCT_NAME, "X550VB"),
216 		},
217 		.driver_data = &quirk_asus_wapf4,
218 	},
219 	{
220 		.callback = dmi_matched,
221 		.ident = "ASUSTeK COMPUTER INC. X551CA",
222 		.matches = {
223 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
224 			DMI_MATCH(DMI_PRODUCT_NAME, "X551CA"),
225 		},
226 		.driver_data = &quirk_asus_wapf4,
227 	},
228 	{
229 		.callback = dmi_matched,
230 		.ident = "ASUSTeK COMPUTER INC. X55A",
231 		.matches = {
232 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
233 			DMI_MATCH(DMI_PRODUCT_NAME, "X55A"),
234 		},
235 		.driver_data = &quirk_asus_wapf4,
236 	},
237 	{
238 		.callback = dmi_matched,
239 		.ident = "ASUSTeK COMPUTER INC. X55C",
240 		.matches = {
241 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
242 			DMI_MATCH(DMI_PRODUCT_NAME, "X55C"),
243 		},
244 		.driver_data = &quirk_asus_wapf4,
245 	},
246 	{
247 		.callback = dmi_matched,
248 		.ident = "ASUSTeK COMPUTER INC. X55U",
249 		.matches = {
250 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
251 			DMI_MATCH(DMI_PRODUCT_NAME, "X55U"),
252 		},
253 		.driver_data = &quirk_asus_x55u,
254 	},
255 	{
256 		.callback = dmi_matched,
257 		.ident = "ASUSTeK COMPUTER INC. X55VD",
258 		.matches = {
259 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
260 			DMI_MATCH(DMI_PRODUCT_NAME, "X55VD"),
261 		},
262 		.driver_data = &quirk_asus_wapf4,
263 	},
264 	{
265 		.callback = dmi_matched,
266 		.ident = "ASUSTeK COMPUTER INC. X75A",
267 		.matches = {
268 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
269 			DMI_MATCH(DMI_PRODUCT_NAME, "X75A"),
270 		},
271 		.driver_data = &quirk_asus_wapf4,
272 	},
273 	{
274 		.callback = dmi_matched,
275 		.ident = "ASUSTeK COMPUTER INC. X75VBP",
276 		.matches = {
277 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
278 			DMI_MATCH(DMI_PRODUCT_NAME, "X75VBP"),
279 		},
280 		.driver_data = &quirk_asus_wapf4,
281 	},
282 	{
283 		.callback = dmi_matched,
284 		.ident = "ASUSTeK COMPUTER INC. X75VD",
285 		.matches = {
286 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
287 			DMI_MATCH(DMI_PRODUCT_NAME, "X75VD"),
288 		},
289 		.driver_data = &quirk_asus_wapf4,
290 	},
291 	{
292 		.callback = dmi_matched,
293 		.ident = "ASUSTeK COMPUTER INC. 1015E",
294 		.matches = {
295 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
296 			DMI_MATCH(DMI_PRODUCT_NAME, "1015E"),
297 		},
298 		.driver_data = &quirk_asus_wapf4,
299 	},
300 	{
301 		.callback = dmi_matched,
302 		.ident = "ASUSTeK COMPUTER INC. 1015U",
303 		.matches = {
304 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
305 			DMI_MATCH(DMI_PRODUCT_NAME, "1015U"),
306 		},
307 		.driver_data = &quirk_asus_wapf4,
308 	},
309 	{
310 		.callback = dmi_matched,
311 		.ident = "ASUSTeK COMPUTER INC. X200CA",
312 		.matches = {
313 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
314 			DMI_MATCH(DMI_PRODUCT_NAME, "X200CA"),
315 		},
316 		.driver_data = &quirk_asus_x200ca,
317 	},
318 	{
319 		.callback = dmi_matched,
320 		.ident = "ASUSTeK COMPUTER INC. X555UB",
321 		.matches = {
322 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
323 			DMI_MATCH(DMI_PRODUCT_NAME, "X555UB"),
324 		},
325 		.driver_data = &quirk_no_rfkill,
326 	},
327 	{
328 		.callback = dmi_matched,
329 		.ident = "ASUSTeK COMPUTER INC. N552VW",
330 		.matches = {
331 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
332 			DMI_MATCH(DMI_PRODUCT_NAME, "N552VW"),
333 		},
334 		.driver_data = &quirk_no_rfkill,
335 	},
336 	{
337 		.callback = dmi_matched,
338 		.ident = "ASUSTeK COMPUTER INC. U303LB",
339 		.matches = {
340 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
341 			DMI_MATCH(DMI_PRODUCT_NAME, "U303LB"),
342 		},
343 		.driver_data = &quirk_no_rfkill,
344 	},
345 	{
346 		.callback = dmi_matched,
347 		.ident = "ASUSTeK COMPUTER INC. Z550MA",
348 		.matches = {
349 			DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
350 			DMI_MATCH(DMI_PRODUCT_NAME, "Z550MA"),
351 		},
352 		.driver_data = &quirk_no_rfkill,
353 	},
354 	{},
355 };
356 
357 static void asus_nb_wmi_quirks(struct asus_wmi_driver *driver)
358 {
359 	quirks = &quirk_asus_unknown;
360 	dmi_check_system(asus_quirks);
361 
362 	driver->quirks = quirks;
363 	driver->panel_power = FB_BLANK_UNBLANK;
364 
365 	/* overwrite the wapf setting if the wapf paramater is specified */
366 	if (wapf != -1)
367 		quirks->wapf = wapf;
368 	else
369 		wapf = quirks->wapf;
370 }
371 
372 static const struct key_entry asus_nb_wmi_keymap[] = {
373 	{ KE_KEY, ASUS_WMI_BRN_DOWN, { KEY_BRIGHTNESSDOWN } },
374 	{ KE_KEY, ASUS_WMI_BRN_UP, { KEY_BRIGHTNESSUP } },
375 	{ KE_KEY, 0x30, { KEY_VOLUMEUP } },
376 	{ KE_KEY, 0x31, { KEY_VOLUMEDOWN } },
377 	{ KE_KEY, 0x32, { KEY_MUTE } },
378 	{ KE_KEY, 0x33, { KEY_DISPLAYTOGGLE } }, /* LCD on */
379 	{ KE_KEY, 0x34, { KEY_DISPLAY_OFF } }, /* LCD off */
380 	{ KE_KEY, 0x40, { KEY_PREVIOUSSONG } },
381 	{ KE_KEY, 0x41, { KEY_NEXTSONG } },
382 	{ KE_KEY, 0x43, { KEY_STOPCD } }, /* Stop/Eject */
383 	{ KE_KEY, 0x45, { KEY_PLAYPAUSE } },
384 	{ KE_KEY, 0x4c, { KEY_MEDIA } }, /* WMP Key */
385 	{ KE_KEY, 0x50, { KEY_EMAIL } },
386 	{ KE_KEY, 0x51, { KEY_WWW } },
387 	{ KE_KEY, 0x55, { KEY_CALC } },
388 	{ KE_IGNORE, 0x57, },  /* Battery mode */
389 	{ KE_IGNORE, 0x58, },  /* AC mode */
390 	{ KE_KEY, 0x5C, { KEY_F15 } },  /* Power Gear key */
391 	{ KE_KEY, 0x5D, { KEY_WLAN } }, /* Wireless console Toggle */
392 	{ KE_KEY, 0x5E, { KEY_WLAN } }, /* Wireless console Enable */
393 	{ KE_KEY, 0x5F, { KEY_WLAN } }, /* Wireless console Disable */
394 	{ KE_KEY, 0x60, { KEY_TOUCHPAD_ON } },
395 	{ KE_KEY, 0x61, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD only */
396 	{ KE_KEY, 0x62, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT only */
397 	{ KE_KEY, 0x63, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT */
398 	{ KE_KEY, 0x64, { KEY_SWITCHVIDEOMODE } }, /* SDSP TV */
399 	{ KE_KEY, 0x65, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + TV */
400 	{ KE_KEY, 0x66, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + TV */
401 	{ KE_KEY, 0x67, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + TV */
402 	{ KE_KEY, 0x6B, { KEY_TOUCHPAD_TOGGLE } },
403 	{ KE_IGNORE, 0x6E, },  /* Low Battery notification */
404 	{ KE_KEY, 0x7a, { KEY_ALS_TOGGLE } }, /* Ambient Light Sensor Toggle */
405 	{ KE_KEY, 0x7D, { KEY_BLUETOOTH } }, /* Bluetooth Enable */
406 	{ KE_KEY, 0x7E, { KEY_BLUETOOTH } }, /* Bluetooth Disable */
407 	{ KE_KEY, 0x82, { KEY_CAMERA } },
408 	{ KE_KEY, 0x88, { KEY_RFKILL  } }, /* Radio Toggle Key */
409 	{ KE_KEY, 0x8A, { KEY_PROG1 } }, /* Color enhancement mode */
410 	{ KE_KEY, 0x8C, { KEY_SWITCHVIDEOMODE } }, /* SDSP DVI only */
411 	{ KE_KEY, 0x8D, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + DVI */
412 	{ KE_KEY, 0x8E, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + DVI */
413 	{ KE_KEY, 0x8F, { KEY_SWITCHVIDEOMODE } }, /* SDSP TV + DVI */
414 	{ KE_KEY, 0x90, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + DVI */
415 	{ KE_KEY, 0x91, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + TV + DVI */
416 	{ KE_KEY, 0x92, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + TV + DVI */
417 	{ KE_KEY, 0x93, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + TV + DVI */
418 	{ KE_KEY, 0x95, { KEY_MEDIA } },
419 	{ KE_KEY, 0x99, { KEY_PHONE } },
420 	{ KE_KEY, 0xA0, { KEY_SWITCHVIDEOMODE } }, /* SDSP HDMI only */
421 	{ KE_KEY, 0xA1, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + HDMI */
422 	{ KE_KEY, 0xA2, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + HDMI */
423 	{ KE_KEY, 0xA3, { KEY_SWITCHVIDEOMODE } }, /* SDSP TV + HDMI */
424 	{ KE_KEY, 0xA4, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + HDMI */
425 	{ KE_KEY, 0xA5, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + TV + HDMI */
426 	{ KE_KEY, 0xA6, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + TV + HDMI */
427 	{ KE_KEY, 0xA7, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + TV + HDMI */
428 	{ KE_KEY, 0xB5, { KEY_CALC } },
429 	{ KE_KEY, 0xC4, { KEY_KBDILLUMUP } },
430 	{ KE_KEY, 0xC5, { KEY_KBDILLUMDOWN } },
431 	{ KE_IGNORE, 0xC6, },  /* Ambient Light Sensor notification */
432 	{ KE_END, 0},
433 };
434 
435 static struct asus_wmi_driver asus_nb_wmi_driver = {
436 	.name = ASUS_NB_WMI_FILE,
437 	.owner = THIS_MODULE,
438 	.event_guid = ASUS_NB_WMI_EVENT_GUID,
439 	.keymap = asus_nb_wmi_keymap,
440 	.input_name = "Asus WMI hotkeys",
441 	.input_phys = ASUS_NB_WMI_FILE "/input0",
442 	.detect_quirks = asus_nb_wmi_quirks,
443 };
444 
445 
446 static int __init asus_nb_wmi_init(void)
447 {
448 	return asus_wmi_register_driver(&asus_nb_wmi_driver);
449 }
450 
451 static void __exit asus_nb_wmi_exit(void)
452 {
453 	asus_wmi_unregister_driver(&asus_nb_wmi_driver);
454 }
455 
456 module_init(asus_nb_wmi_init);
457 module_exit(asus_nb_wmi_exit);
458