2 * Copyright (c) 2002 Sean Bullington <seanATstalker.org>
3 * 2003-2008 Anish Mistry <amistry@am-productions.biz>
4 * 2004 Mark Santcroos <marks@ripe.net>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * $FreeBSD: head/sys/dev/acpi_support/acpi_fujitsu.c 246128 2013-01-30 18:01:20Z sbz $
32 #include <sys/param.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/sysctl.h>
41 #include <dev/acpica/acpivar.h>
43 /* Hooks for the ACPI CA debugging infrastructure */
44 #define _COMPONENT ACPI_OEM
45 ACPI_MODULE_NAME("Fujitsu")
47 /* Change and update bits for the hotkeys */
48 #define VOLUME_MUTE_BIT 0x40000000
50 /* Values of settings */
51 #define GENERAL_SETTING_BITS 0x0fffffff
52 #define MOUSE_SETTING_BITS GENERAL_SETTING_BITS
53 #define VOLUME_SETTING_BITS GENERAL_SETTING_BITS
54 #define BRIGHTNESS_SETTING_BITS GENERAL_SETTING_BITS
56 /* Possible state changes */
58 * These are NOT arbitrary values. They are the
59 * GHKS return value from the device that says which
60 * hotkey is active. They should match up with a bit
61 * from the GSIF bitmask.
63 #define BRIGHT_CHANGED 0x01
64 #define VOLUME_CHANGED 0x04
65 #define MOUSE_CHANGED 0x08
67 * It is unknown which hotkey this bit is supposed to indicate, but
68 * according to values from GSIF this is a valid flag.
70 #define UNKNOWN_CHANGED 0x10
74 #define FN_POINTER_ENABLE 1
75 #define FN_LCD_BRIGHTNESS 2
90 #define ACPI_NOTIFY_STATUS_CHANGED 0x80
93 * Holds a control method name and its associated integer value.
94 * Only used for no-argument control methods which return a value.
103 * Driver extension for the FUJITSU ACPI driver.
105 struct acpi_fujitsu_softc {
109 /* Control methods */
110 struct int_nameval _sta, /* unused */
111 gbll, /* brightness */
112 gbls, /* get brightness state */
113 ghks, /* hotkey selector */
114 gbuf, /* unused (buffer?) */
116 gsif, /* function key bitmask */
118 rbll, /* number of brightness levels (radix) */
119 rvol; /* number of volume levels (radix) */
121 /* State variables */
122 uint8_t bIsMuted; /* Is volume muted */
123 uint8_t bIntPtrEnabled; /* Is internal ptr enabled */
124 uint32_t lastValChanged; /* The last value updated */
127 struct sysctl_ctx_list sysctl_ctx;
128 struct sysctl_oid *sysctl_tree;
131 /* Driver entry point forward declarations. */
132 static int acpi_fujitsu_probe(device_t dev);
133 static int acpi_fujitsu_attach(device_t dev);
134 static int acpi_fujitsu_detach(device_t dev);
135 static int acpi_fujitsu_suspend(device_t dev);
136 static int acpi_fujitsu_resume(device_t dev);
138 static void acpi_fujitsu_notify_status_changed(void *arg);
139 static void acpi_fujitsu_notify_handler(ACPI_HANDLE h, uint32_t notify, void *context);
140 static int acpi_fujitsu_sysctl(SYSCTL_HANDLER_ARGS);
142 /* Utility function declarations */
143 static uint8_t acpi_fujitsu_update(struct acpi_fujitsu_softc *sc);
144 static uint8_t acpi_fujitsu_init(struct acpi_fujitsu_softc *sc);
145 static uint8_t acpi_fujitsu_check_hardware(struct acpi_fujitsu_softc *sc);
147 /* Driver/Module specific structure definitions. */
148 static device_method_t acpi_fujitsu_methods[] = {
149 /* Device interface */
150 DEVMETHOD(device_probe, acpi_fujitsu_probe),
151 DEVMETHOD(device_attach, acpi_fujitsu_attach),
152 DEVMETHOD(device_detach, acpi_fujitsu_detach),
153 DEVMETHOD(device_suspend, acpi_fujitsu_suspend),
154 DEVMETHOD(device_resume, acpi_fujitsu_resume),
158 static driver_t acpi_fujitsu_driver = {
160 acpi_fujitsu_methods,
161 sizeof(struct acpi_fujitsu_softc),
164 /* Prototype for function hotkeys for getting/setting a value. */
165 static int acpi_fujitsu_method_get(struct acpi_fujitsu_softc *sc, int method);
166 static int acpi_fujitsu_method_set(struct acpi_fujitsu_softc *sc, int method, int value);
168 static char *fujitsu_ids[] = { "FUJ02B1", NULL };
170 ACPI_SERIAL_DECL(fujitsu, "Fujitsu Function Hotkeys");
172 /* sysctl names and function calls */
180 .method = METHOD_MUTE,
181 .description = "Speakers/headphones mute status"
184 .name = "pointer_enable",
185 .method = METHOD_GMOU,
186 .description = "Enable and disable the internal pointer"
189 .name = "lcd_brightness",
190 .method = METHOD_GBLL,
191 .description = "Brightness level of the LCD panel"
194 .name = "lcd_brightness",
195 .method = METHOD_GBLS,
196 .description = "Brightness level of the LCD panel"
200 .method = METHOD_GVOL,
201 .description = "Speakers/headphones volume level"
204 .name = "volume_radix",
205 .method = METHOD_RVOL,
206 .description = "Number of volume level steps"
209 .name = "lcd_brightness_radix",
210 .method = METHOD_RBLL,
211 .description = "Number of brightness level steps"
217 static devclass_t acpi_fujitsu_devclass;
218 DRIVER_MODULE(acpi_fujitsu, acpi, acpi_fujitsu_driver,
219 acpi_fujitsu_devclass, 0, 0);
220 MODULE_DEPEND(acpi_fujitsu, acpi, 1, 1, 1);
221 MODULE_VERSION(acpi_fujitsu, 1);
224 acpi_fujitsu_probe(device_t dev)
229 name = ACPI_ID_PROBE(device_get_parent(dev), dev, fujitsu_ids);
230 if (acpi_disabled("fujitsu") || name == NULL ||
231 device_get_unit(dev) > 1)
234 ksprintf(buffer, "Fujitsu Function Hotkeys %s", name);
235 device_set_desc_copy(dev, buffer);
241 acpi_fujitsu_attach(device_t dev)
243 struct acpi_fujitsu_softc *sc;
245 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
247 sc = device_get_softc(dev);
249 sc->handle = acpi_get_handle(dev);
251 /* Install notification handler */
252 AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
253 acpi_fujitsu_notify_handler, sc);
255 /* Snag our default values for the hotkeys / hotkey states. */
256 ACPI_SERIAL_BEGIN(fujitsu);
257 if (!acpi_fujitsu_init(sc))
258 device_printf(dev, "Couldn't initialize hotkey states!\n");
259 ACPI_SERIAL_END(fujitsu);
265 * Called when the system is being suspended, simply
266 * set an event to be signalled when we wake up.
269 acpi_fujitsu_suspend(device_t dev)
276 acpi_fujitsu_resume(device_t dev)
278 struct acpi_fujitsu_softc *sc;
281 sc = device_get_softc(dev);
284 * The pointer needs to be re-enabled for
285 * some revisions of the P series (2120).
287 ACPI_SERIAL_BEGIN(fujitsu);
289 if(sc->gmou.exists) {
290 status = acpi_SetInteger(sc->handle, "SMOU", 1);
291 if (ACPI_FAILURE(status))
292 device_printf(sc->dev, "Couldn't enable pointer\n");
294 ACPI_SERIAL_END(fujitsu);
300 acpi_fujitsu_notify_status_changed(void *arg)
302 struct acpi_fujitsu_softc *sc;
304 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
306 sc = (struct acpi_fujitsu_softc *)arg;
309 * Since our notify function is called, we know something has
310 * happened. So the only reason for acpi_fujitsu_update to fail
311 * is if we can't find what has changed or an error occurs.
313 ACPI_SERIAL_BEGIN(fujitsu);
314 acpi_fujitsu_update(sc);
315 ACPI_SERIAL_END(fujitsu);
320 acpi_fujitsu_notify_handler(ACPI_HANDLE h, uint32_t notify, void *context)
322 struct acpi_fujitsu_softc *sc;
324 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
326 sc = (struct acpi_fujitsu_softc *)context;
329 case ACPI_NOTIFY_STATUS_CHANGED:
330 AcpiOsExecute(OSL_NOTIFY_HANDLER,
331 acpi_fujitsu_notify_status_changed, sc);
334 /* unknown notification value */
340 acpi_fujitsu_detach(device_t dev)
342 struct acpi_fujitsu_softc *sc;
344 sc = device_get_softc(dev);
345 AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
346 acpi_fujitsu_notify_handler);
348 sysctl_ctx_free(&sc->sysctl_ctx);
354 * Initializes the names of the ACPI control methods and grabs
355 * the current state of all of the ACPI hotkeys into the softc.
358 acpi_fujitsu_init(struct acpi_fujitsu_softc *sc)
360 struct acpi_softc *acpi_sc;
363 ACPI_SERIAL_ASSERT(fujitsu);
365 /* Setup all of the names for each control method */
366 sc->_sta.name = "_STA";
367 sc->gbll.name = "GBLL";
368 sc->gbls.name = "GBLS";
369 sc->ghks.name = "GHKS";
370 sc->gmou.name = "GMOU";
371 sc->gsif.name = "GSIF";
372 sc->gvol.name = "GVOL";
373 sc->ghks.name = "GHKS";
374 sc->gsif.name = "GSIF";
375 sc->rbll.name = "RBLL";
376 sc->rvol.name = "RVOL";
378 /* Determine what hardware functionality is available */
379 acpi_fujitsu_check_hardware(sc);
381 /* Build the sysctl tree */
382 acpi_sc = acpi_device_get_parent_softc(sc->dev);
383 sysctl_ctx_init(&sc->sysctl_ctx);
384 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
385 SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
386 OID_AUTO, "fujitsu", CTLFLAG_RD, 0, "");
388 for (i = 0; sysctl_table[i].name != NULL; i++) {
389 switch(sysctl_table[i].method) {
391 exists = sc->gmou.exists;
394 exists = sc->gbll.exists;
397 exists = sc->gbls.exists;
401 exists = sc->gvol.exists;
404 exists = sc->rvol.exists;
407 exists = sc->rbll.exists;
410 /* Allow by default */
416 SYSCTL_ADD_PROC(&sc->sysctl_ctx,
417 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
418 sysctl_table[i].name,
419 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY,
420 sc, i, acpi_fujitsu_sysctl, "I",
421 sysctl_table[i].description);
425 /* Set the hotkeys to their initial states */
426 if (!acpi_fujitsu_update(sc)) {
427 device_printf(sc->dev, "Couldn't init hotkey states\n");
435 acpi_fujitsu_sysctl(SYSCTL_HANDLER_ARGS)
437 struct acpi_fujitsu_softc *sc;
440 int function_num, error = 0;
442 sc = (struct acpi_fujitsu_softc *)oidp->oid_arg1;
443 function_num = oidp->oid_arg2;
444 method = sysctl_table[function_num].method;
446 ACPI_SERIAL_BEGIN(fujitsu);
448 /* Get the current value */
449 arg = acpi_fujitsu_method_get(sc, method);
450 error = sysctl_handle_int(oidp, &arg, 0, req);
452 if (error != 0 || req->newptr == NULL)
455 /* Update the value */
456 error = acpi_fujitsu_method_set(sc, method, arg);
459 ACPI_SERIAL_END(fujitsu);
464 acpi_fujitsu_method_get(struct acpi_fujitsu_softc *sc, int method)
466 struct int_nameval nv;
469 ACPI_SERIAL_ASSERT(fujitsu);
504 status = acpi_GetInteger(sc->handle, nv.name, &nv.value);
505 if (ACPI_FAILURE(status)) {
506 device_printf(sc->dev, "Couldn't query method (%s)\n", nv.name);
510 if (method == METHOD_MUTE) {
511 sc->bIsMuted = (uint8_t)((nv.value & VOLUME_MUTE_BIT) != 0);
512 return (sc->bIsMuted);
515 nv.value &= GENERAL_SETTING_BITS;
520 acpi_fujitsu_method_set(struct acpi_fujitsu_softc *sc, int method, int value)
522 struct int_nameval nv;
527 ACPI_SERIAL_ASSERT(fujitsu);
531 changed = BRIGHT_CHANGED;
536 changed = BRIGHT_CHANGED;
541 changed = MOUSE_CHANGED;
547 changed = VOLUME_CHANGED;
558 if (method == METHOD_MUTE) {
560 value = nv.value | VOLUME_MUTE_BIT;
562 value = nv.value & ~VOLUME_MUTE_BIT;
567 status = acpi_SetInteger(sc->handle, control, value);
568 if (ACPI_FAILURE(status)) {
569 device_printf(sc->dev, "Couldn't update %s\n", control);
573 sc->lastValChanged = changed;
578 * Query the get methods to determine what functionality is available
579 * from the hardware function hotkeys.
582 acpi_fujitsu_check_hardware(struct acpi_fujitsu_softc *sc)
586 ACPI_SERIAL_ASSERT(fujitsu);
587 /* save the hotkey bitmask */
588 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
589 sc->gsif.name, &(sc->gsif.value)))) {
591 device_printf(sc->dev, "Couldn't query bitmask value\n");
596 /* System Volume Level */
597 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
598 sc->gvol.name, &val))) {
604 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
605 sc->gbls.name, &val))) {
611 /* don't add if we can use the new method */
612 if (sc->gbls.exists || ACPI_FAILURE(acpi_GetInteger(sc->handle,
613 sc->gbll.name, &val))) {
619 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
620 sc->ghks.name, &val))) {
626 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
627 sc->gmou.name, &val))) {
633 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
634 sc->rbll.name, &val))) {
640 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
641 sc->rvol.name, &val))) {
651 * Query each of the ACPI control methods that contain information we're
652 * interested in. We check the return values from the control methods and
653 * adjust any state variables if they should be adjusted.
656 acpi_fujitsu_update(struct acpi_fujitsu_softc *sc)
659 struct acpi_softc *acpi_sc;
661 acpi_sc = acpi_device_get_parent_softc(sc->dev);
663 ACPI_SERIAL_ASSERT(fujitsu);
665 changed = sc->gsif.value & acpi_fujitsu_method_get(sc,METHOD_GHKS);
669 /* System Volume Level */
670 if(sc->gvol.exists) {
671 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
672 sc->gvol.name, &(sc->gvol.value)))) {
673 device_printf(sc->dev, "Couldn't query volume level\n");
677 if (changed & VOLUME_CHANGED) {
679 (uint8_t)((sc->gvol.value & VOLUME_MUTE_BIT) != 0);
681 /* Clear the modification bit */
682 sc->gvol.value &= VOLUME_SETTING_BITS;
685 acpi_UserNotify("FUJITSU", sc->handle, FN_MUTE);
686 ACPI_VPRINT(sc->dev, acpi_sc, "Volume is now mute\n");
688 ACPI_VPRINT(sc->dev, acpi_sc, "Volume is now %d\n",
691 acpi_UserNotify("FUJITSU", sc->handle, FN_VOLUME);
695 /* Internal mouse pointer (eraserhead) */
696 if(sc->gmou.exists) {
697 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
698 sc->gmou.name, &(sc->gmou.value)))) {
699 device_printf(sc->dev, "Couldn't query pointer state\n");
703 if (changed & MOUSE_CHANGED) {
704 sc->bIntPtrEnabled = (uint8_t)(sc->gmou.value & 0x1);
706 /* Clear the modification bit */
707 sc->gmou.value &= MOUSE_SETTING_BITS;
709 /* Set the value in case it is not hardware controlled */
710 acpi_fujitsu_method_set(sc, METHOD_GMOU, sc->gmou.value);
712 acpi_UserNotify("FUJITSU", sc->handle, FN_POINTER_ENABLE);
714 ACPI_VPRINT(sc->dev, acpi_sc, "Internal pointer is now %s\n",
715 (sc->bIntPtrEnabled) ? "enabled" : "disabled");
719 /* Screen Brightness Level P8XXX */
720 if(sc->gbls.exists) {
721 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
722 sc->gbls.name, &(sc->gbls.value)))) {
723 device_printf(sc->dev, "Couldn't query P8XXX brightness level\n");
726 if (changed & BRIGHT_CHANGED) {
727 /* No state to record here. */
729 /* Clear the modification bit */
730 sc->gbls.value &= BRIGHTNESS_SETTING_BITS;
732 /* Set the value in case it is not hardware controlled */
733 acpi_fujitsu_method_set(sc, METHOD_GBLS, sc->gbls.value);
735 acpi_UserNotify("FUJITSU", sc->handle, FN_LCD_BRIGHTNESS);
737 ACPI_VPRINT(sc->dev, acpi_sc, "P8XXX Brightness level is now %d\n",
742 /* Screen Brightness Level */
743 if(sc->gbll.exists) {
744 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
745 sc->gbll.name, &(sc->gbll.value)))) {
746 device_printf(sc->dev, "Couldn't query brightness level\n");
750 if (changed & BRIGHT_CHANGED) {
751 /* No state to record here. */
753 /* Clear the modification bit */
754 sc->gbll.value &= BRIGHTNESS_SETTING_BITS;
756 acpi_UserNotify("FUJITSU", sc->handle, FN_LCD_BRIGHTNESS);
758 ACPI_VPRINT(sc->dev, acpi_sc, "Brightness level is now %d\n",
763 sc->lastValChanged = changed;