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 ACPICA 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, NULL, NULL);
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_SERIAL_INIT(fujitsu);
246 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
248 sc = device_get_softc(dev);
250 sc->handle = acpi_get_handle(dev);
252 /* Install notification handler */
253 AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
254 acpi_fujitsu_notify_handler, sc);
256 /* Snag our default values for the hotkeys / hotkey states. */
257 ACPI_SERIAL_BEGIN(fujitsu);
258 if (!acpi_fujitsu_init(sc))
259 device_printf(dev, "Couldn't initialize hotkey states!\n");
260 ACPI_SERIAL_END(fujitsu);
266 * Called when the system is being suspended, simply
267 * set an event to be signalled when we wake up.
270 acpi_fujitsu_suspend(device_t dev)
277 acpi_fujitsu_resume(device_t dev)
279 struct acpi_fujitsu_softc *sc;
282 sc = device_get_softc(dev);
285 * The pointer needs to be re-enabled for
286 * some revisions of the P series (2120).
288 ACPI_SERIAL_BEGIN(fujitsu);
290 if(sc->gmou.exists) {
291 status = acpi_SetInteger(sc->handle, "SMOU", 1);
292 if (ACPI_FAILURE(status))
293 device_printf(sc->dev, "Couldn't enable pointer\n");
295 ACPI_SERIAL_END(fujitsu);
301 acpi_fujitsu_notify_status_changed(void *arg)
303 struct acpi_fujitsu_softc *sc;
305 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
307 sc = (struct acpi_fujitsu_softc *)arg;
310 * Since our notify function is called, we know something has
311 * happened. So the only reason for acpi_fujitsu_update to fail
312 * is if we can't find what has changed or an error occurs.
314 ACPI_SERIAL_BEGIN(fujitsu);
315 acpi_fujitsu_update(sc);
316 ACPI_SERIAL_END(fujitsu);
321 acpi_fujitsu_notify_handler(ACPI_HANDLE h, uint32_t notify, void *context)
323 struct acpi_fujitsu_softc *sc;
325 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify);
327 sc = (struct acpi_fujitsu_softc *)context;
330 case ACPI_NOTIFY_STATUS_CHANGED:
331 AcpiOsExecute(OSL_NOTIFY_HANDLER,
332 acpi_fujitsu_notify_status_changed, sc);
335 /* unknown notification value */
341 acpi_fujitsu_detach(device_t dev)
343 struct acpi_fujitsu_softc *sc;
345 sc = device_get_softc(dev);
346 AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
347 acpi_fujitsu_notify_handler);
349 sysctl_ctx_free(&sc->sysctl_ctx);
355 * Initializes the names of the ACPI control methods and grabs
356 * the current state of all of the ACPI hotkeys into the softc.
359 acpi_fujitsu_init(struct acpi_fujitsu_softc *sc)
361 struct acpi_softc *acpi_sc;
364 ACPI_SERIAL_ASSERT(fujitsu);
366 /* Setup all of the names for each control method */
367 sc->_sta.name = "_STA";
368 sc->gbll.name = "GBLL";
369 sc->gbls.name = "GBLS";
370 sc->ghks.name = "GHKS";
371 sc->gmou.name = "GMOU";
372 sc->gsif.name = "GSIF";
373 sc->gvol.name = "GVOL";
374 sc->ghks.name = "GHKS";
375 sc->gsif.name = "GSIF";
376 sc->rbll.name = "RBLL";
377 sc->rvol.name = "RVOL";
379 /* Determine what hardware functionality is available */
380 acpi_fujitsu_check_hardware(sc);
382 /* Build the sysctl tree */
383 acpi_sc = acpi_device_get_parent_softc(sc->dev);
384 sysctl_ctx_init(&sc->sysctl_ctx);
385 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
386 SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree),
387 OID_AUTO, "fujitsu", CTLFLAG_RD, 0, "");
389 for (i = 0; sysctl_table[i].name != NULL; i++) {
390 switch(sysctl_table[i].method) {
392 exists = sc->gmou.exists;
395 exists = sc->gbll.exists;
398 exists = sc->gbls.exists;
402 exists = sc->gvol.exists;
405 exists = sc->rvol.exists;
408 exists = sc->rbll.exists;
411 /* Allow by default */
417 SYSCTL_ADD_PROC(&sc->sysctl_ctx,
418 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
419 sysctl_table[i].name,
420 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY,
421 sc, i, acpi_fujitsu_sysctl, "I",
422 sysctl_table[i].description);
426 /* Set the hotkeys to their initial states */
427 if (!acpi_fujitsu_update(sc)) {
428 device_printf(sc->dev, "Couldn't init hotkey states\n");
436 acpi_fujitsu_sysctl(SYSCTL_HANDLER_ARGS)
438 struct acpi_fujitsu_softc *sc;
441 int function_num, error = 0;
443 sc = (struct acpi_fujitsu_softc *)oidp->oid_arg1;
444 function_num = oidp->oid_arg2;
445 method = sysctl_table[function_num].method;
447 ACPI_SERIAL_BEGIN(fujitsu);
449 /* Get the current value */
450 arg = acpi_fujitsu_method_get(sc, method);
451 error = sysctl_handle_int(oidp, &arg, 0, req);
453 if (error != 0 || req->newptr == NULL)
456 /* Update the value */
457 error = acpi_fujitsu_method_set(sc, method, arg);
460 ACPI_SERIAL_END(fujitsu);
465 acpi_fujitsu_method_get(struct acpi_fujitsu_softc *sc, int method)
467 struct int_nameval nv;
470 ACPI_SERIAL_ASSERT(fujitsu);
505 status = acpi_GetInteger(sc->handle, nv.name, &nv.value);
506 if (ACPI_FAILURE(status)) {
507 device_printf(sc->dev, "Couldn't query method (%s)\n", nv.name);
511 if (method == METHOD_MUTE) {
512 sc->bIsMuted = (uint8_t)((nv.value & VOLUME_MUTE_BIT) != 0);
513 return (sc->bIsMuted);
516 nv.value &= GENERAL_SETTING_BITS;
521 acpi_fujitsu_method_set(struct acpi_fujitsu_softc *sc, int method, int value)
523 struct int_nameval nv;
528 ACPI_SERIAL_ASSERT(fujitsu);
532 changed = BRIGHT_CHANGED;
537 changed = BRIGHT_CHANGED;
542 changed = MOUSE_CHANGED;
548 changed = VOLUME_CHANGED;
559 if (method == METHOD_MUTE) {
561 value = nv.value | VOLUME_MUTE_BIT;
563 value = nv.value & ~VOLUME_MUTE_BIT;
568 status = acpi_SetInteger(sc->handle, control, value);
569 if (ACPI_FAILURE(status)) {
570 device_printf(sc->dev, "Couldn't update %s\n", control);
574 sc->lastValChanged = changed;
579 * Query the get methods to determine what functionality is available
580 * from the hardware function hotkeys.
583 acpi_fujitsu_check_hardware(struct acpi_fujitsu_softc *sc)
587 ACPI_SERIAL_ASSERT(fujitsu);
588 /* save the hotkey bitmask */
589 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
590 sc->gsif.name, &(sc->gsif.value)))) {
592 device_printf(sc->dev, "Couldn't query bitmask value\n");
597 /* System Volume Level */
598 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
599 sc->gvol.name, &val))) {
605 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
606 sc->gbls.name, &val))) {
612 /* don't add if we can use the new method */
613 if (sc->gbls.exists || ACPI_FAILURE(acpi_GetInteger(sc->handle,
614 sc->gbll.name, &val))) {
620 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
621 sc->ghks.name, &val))) {
627 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
628 sc->gmou.name, &val))) {
634 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
635 sc->rbll.name, &val))) {
641 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
642 sc->rvol.name, &val))) {
652 * Query each of the ACPI control methods that contain information we're
653 * interested in. We check the return values from the control methods and
654 * adjust any state variables if they should be adjusted.
657 acpi_fujitsu_update(struct acpi_fujitsu_softc *sc)
660 struct acpi_softc *acpi_sc;
662 acpi_sc = acpi_device_get_parent_softc(sc->dev);
664 ACPI_SERIAL_ASSERT(fujitsu);
666 changed = sc->gsif.value & acpi_fujitsu_method_get(sc,METHOD_GHKS);
670 /* System Volume Level */
671 if(sc->gvol.exists) {
672 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
673 sc->gvol.name, &(sc->gvol.value)))) {
674 device_printf(sc->dev, "Couldn't query volume level\n");
678 if (changed & VOLUME_CHANGED) {
680 (uint8_t)((sc->gvol.value & VOLUME_MUTE_BIT) != 0);
682 /* Clear the modification bit */
683 sc->gvol.value &= VOLUME_SETTING_BITS;
686 acpi_UserNotify("FUJITSU", sc->handle, FN_MUTE);
687 ACPI_VPRINT(sc->dev, acpi_sc, "Volume is now mute\n");
689 ACPI_VPRINT(sc->dev, acpi_sc, "Volume is now %d\n",
692 acpi_UserNotify("FUJITSU", sc->handle, FN_VOLUME);
696 /* Internal mouse pointer (eraserhead) */
697 if(sc->gmou.exists) {
698 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
699 sc->gmou.name, &(sc->gmou.value)))) {
700 device_printf(sc->dev, "Couldn't query pointer state\n");
704 if (changed & MOUSE_CHANGED) {
705 sc->bIntPtrEnabled = (uint8_t)(sc->gmou.value & 0x1);
707 /* Clear the modification bit */
708 sc->gmou.value &= MOUSE_SETTING_BITS;
710 /* Set the value in case it is not hardware controlled */
711 acpi_fujitsu_method_set(sc, METHOD_GMOU, sc->gmou.value);
713 acpi_UserNotify("FUJITSU", sc->handle, FN_POINTER_ENABLE);
715 ACPI_VPRINT(sc->dev, acpi_sc, "Internal pointer is now %s\n",
716 (sc->bIntPtrEnabled) ? "enabled" : "disabled");
720 /* Screen Brightness Level P8XXX */
721 if(sc->gbls.exists) {
722 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
723 sc->gbls.name, &(sc->gbls.value)))) {
724 device_printf(sc->dev, "Couldn't query P8XXX brightness level\n");
727 if (changed & BRIGHT_CHANGED) {
728 /* No state to record here. */
730 /* Clear the modification bit */
731 sc->gbls.value &= BRIGHTNESS_SETTING_BITS;
733 /* Set the value in case it is not hardware controlled */
734 acpi_fujitsu_method_set(sc, METHOD_GBLS, sc->gbls.value);
736 acpi_UserNotify("FUJITSU", sc->handle, FN_LCD_BRIGHTNESS);
738 ACPI_VPRINT(sc->dev, acpi_sc, "P8XXX Brightness level is now %d\n",
743 /* Screen Brightness Level */
744 if(sc->gbll.exists) {
745 if (ACPI_FAILURE(acpi_GetInteger(sc->handle,
746 sc->gbll.name, &(sc->gbll.value)))) {
747 device_printf(sc->dev, "Couldn't query brightness level\n");
751 if (changed & BRIGHT_CHANGED) {
752 /* No state to record here. */
754 /* Clear the modification bit */
755 sc->gbll.value &= BRIGHTNESS_SETTING_BITS;
757 acpi_UserNotify("FUJITSU", sc->handle, FN_LCD_BRIGHTNESS);
759 ACPI_VPRINT(sc->dev, acpi_sc, "Brightness level is now %d\n",
764 sc->lastValChanged = changed;