kernel: Use DEVMETHOD_END in the drivers.
[dragonfly.git] / sys / dev / acpica / acpi_toshiba / acpi_toshiba.c
1 /*-
2  * Copyright (c) 2003 Hiroyuki Aizu <aizu@navi.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/dev/acpi_support/acpi_toshiba.c,v 1.18 2009/06/05 18:44:36 jkim
27  */
28
29 #include "opt_acpi.h"
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/module.h>
33 #include <sys/bus.h>
34
35 #include "acpi.h"
36
37 #include <dev/acpica/acpivar.h>
38
39 #define _COMPONENT      ACPI_OEM
40 ACPI_MODULE_NAME("Toshiba")
41
42 /*
43  * Toshiba HCI interface definitions
44  *
45  * HCI is Toshiba's "Hardware Control Interface" which is supposed to
46  * be uniform across all their models.  Ideally we would just call
47  * dedicated ACPI methods instead of using this primitive interface.
48  * However, the ACPI methods seem to be incomplete in some areas (for
49  * example they allow setting, but not reading, the LCD brightness
50  * value), so this is still useful.
51  */
52
53 #define METHOD_HCI              "GHCI"
54 #define METHOD_HCI_ENABLE       "ENAB"
55 #define METHOD_VIDEO            "DSSX"
56
57 /* Operations */
58 #define HCI_SET                         0xFF00
59 #define HCI_GET                         0xFE00
60
61 /* Return codes */
62 #define HCI_SUCCESS                     0x0000
63 #define HCI_FAILURE                     0x1000
64 #define HCI_NOT_SUPPORTED               0x8000
65 #define HCI_EMPTY                       0x8C00
66
67 /* Functions */
68 #define HCI_REG_LCD_BACKLIGHT           0x0002
69 #define HCI_REG_FAN                     0x0004
70 #define HCI_REG_SYSTEM_EVENT            0x0016
71 #define HCI_REG_VIDEO_OUTPUT            0x001C
72 #define HCI_REG_HOTKEY_EVENT            0x001E
73 #define HCI_REG_LCD_BRIGHTNESS          0x002A
74 #define HCI_REG_CPU_SPEED               0x0032
75
76 /* Field definitions */
77 #define HCI_FAN_SHIFT                   7
78 #define HCI_LCD_BRIGHTNESS_BITS         3
79 #define HCI_LCD_BRIGHTNESS_SHIFT        (16 - HCI_LCD_BRIGHTNESS_BITS)
80 #define HCI_LCD_BRIGHTNESS_MAX          ((1 << HCI_LCD_BRIGHTNESS_BITS) - 1)
81 #define HCI_VIDEO_OUTPUT_FLAG           0x0100
82 #define HCI_VIDEO_OUTPUT_LCD            0x1
83 #define HCI_VIDEO_OUTPUT_CRT            0x2
84 #define HCI_VIDEO_OUTPUT_TV             0x4
85 #define HCI_CPU_SPEED_BITS              3
86 #define HCI_CPU_SPEED_SHIFT             (16 - HCI_CPU_SPEED_BITS)
87 #define HCI_CPU_SPEED_MAX               ((1 << HCI_CPU_SPEED_BITS) - 1)
88
89 /* Key press/release events. */
90 #define FN_F1_PRESS     0x013B
91 #define FN_F1_RELEASE   0x01BB
92 #define FN_F2_PRESS     0x013C
93 #define FN_F2_RELEASE   0x01BC
94 #define FN_F3_PRESS     0x013D
95 #define FN_F3_RELEASE   0x01BD
96 #define FN_F4_PRESS     0x013E
97 #define FN_F4_RELEASE   0x01BE
98 #define FN_F5_PRESS     0x013F
99 #define FN_F5_RELEASE   0x01BF
100 #define FN_F6_PRESS     0x0140
101 #define FN_F6_RELEASE   0x01C0
102 #define FN_F7_PRESS     0x0141
103 #define FN_F7_RELEASE   0x01C1
104 #define FN_F8_PRESS     0x0142
105 #define FN_F8_RELEASE   0x01C2
106 #define FN_F9_PRESS     0x0143
107 #define FN_F9_RELEASE   0x01C3
108 #define FN_BS_PRESS     0x010E
109 #define FN_BS_RELEASE   0x018E
110 #define FN_ESC_PRESS    0x0101
111 #define FN_ESC_RELEASE  0x0181
112 #define FN_KNJ_PRESS    0x0129
113 #define FN_KNJ_RELEASE  0x01A9
114
115 /* HCI register definitions. */
116 #define HCI_WORDS       6               /* Number of registers */
117 #define HCI_REG_AX      0               /* Operation, then return value */
118 #define HCI_REG_BX      1               /* Function */
119 #define HCI_REG_CX      2               /* Argument (in or out) */
120 #define HCI_REG_DX      3               /* Unused? */
121 #define HCI_REG_SI      4               /* Unused? */
122 #define HCI_REG_DI      5               /* Unused? */
123
124 struct acpi_toshiba_softc {
125         device_t        dev;
126         ACPI_HANDLE     handle;
127         ACPI_HANDLE     video_handle;
128         struct          sysctl_ctx_list sysctl_ctx;
129         struct          sysctl_oid *sysctl_tree;
130 };
131
132 /* Prototype for HCI functions for getting/setting a value. */
133 typedef int     hci_fn_t(ACPI_HANDLE, int, UINT32 *);
134
135 static int      acpi_toshiba_probe(device_t dev);
136 static int      acpi_toshiba_attach(device_t dev);
137 static int      acpi_toshiba_detach(device_t dev);
138 static int      acpi_toshiba_sysctl(SYSCTL_HANDLER_ARGS);
139 static hci_fn_t hci_force_fan;
140 static hci_fn_t hci_video_output;
141 static hci_fn_t hci_lcd_brightness;
142 static hci_fn_t hci_lcd_backlight;
143 static hci_fn_t hci_cpu_speed;
144 static int      hci_call(ACPI_HANDLE h, int op, int function, UINT32 *arg);
145 static void     hci_key_action(struct acpi_toshiba_softc *sc, ACPI_HANDLE h,
146                     UINT32 key);
147 static void     acpi_toshiba_notify(ACPI_HANDLE h, UINT32 notify,
148                     void *context);
149 static int      acpi_toshiba_video_probe(device_t dev);
150 static int      acpi_toshiba_video_attach(device_t dev);
151
152 ACPI_SERIAL_DECL(toshiba, "ACPI Toshiba Extras");
153
154 /* Table of sysctl names and HCI functions to call. */
155 static struct {
156         char            *name;
157         hci_fn_t        *handler;
158 } sysctl_table[] = {
159         /* name,                handler */
160         {"force_fan",           hci_force_fan},
161         {"video_output",        hci_video_output},
162         {"lcd_brightness",      hci_lcd_brightness},
163         {"lcd_backlight",       hci_lcd_backlight},
164         {"cpu_speed",           hci_cpu_speed},
165         {NULL, NULL}
166 };
167
168 static device_method_t acpi_toshiba_methods[] = {
169         DEVMETHOD(device_probe,         acpi_toshiba_probe),
170         DEVMETHOD(device_attach,        acpi_toshiba_attach),
171         DEVMETHOD(device_detach,        acpi_toshiba_detach),
172
173         DEVMETHOD_END
174 };
175
176 static driver_t acpi_toshiba_driver = {
177         "acpi_toshiba",
178         acpi_toshiba_methods,
179         sizeof(struct acpi_toshiba_softc),
180 };
181
182 static devclass_t acpi_toshiba_devclass;
183 DRIVER_MODULE(acpi_toshiba, acpi, acpi_toshiba_driver, acpi_toshiba_devclass,
184     0, 0);
185 MODULE_DEPEND(acpi_toshiba, acpi, 1, 1, 1);
186
187 static device_method_t acpi_toshiba_video_methods[] = {
188         DEVMETHOD(device_probe,         acpi_toshiba_video_probe),
189         DEVMETHOD(device_attach,        acpi_toshiba_video_attach),
190
191         DEVMETHOD_END
192 };
193
194 static driver_t acpi_toshiba_video_driver = {
195         "acpi_toshiba_video",
196         acpi_toshiba_video_methods,
197         0,
198 };
199
200 static devclass_t acpi_toshiba_video_devclass;
201 DRIVER_MODULE(acpi_toshiba_video, acpi, acpi_toshiba_video_driver,
202     acpi_toshiba_video_devclass, 0, 0);
203 MODULE_DEPEND(acpi_toshiba_video, acpi, 1, 1, 1);
204
205 static int      enable_fn_keys = 1;
206 TUNABLE_INT("hw.acpi.toshiba.enable_fn_keys", &enable_fn_keys);
207
208 /*
209  * HID      Model
210  * -------------------------------------
211  * TOS6200  Libretto L Series
212  *          Dynabook Satellite 2455
213  *          Dynabook SS 3500
214  * TOS6207  Dynabook SS2110 Series
215  * TOS6208  SPA40
216  */
217 static int
218 acpi_toshiba_probe(device_t dev)
219 {
220         static char *tosh_ids[] = { "TOS6200", "TOS6207", "TOS6208", NULL };
221
222         if (acpi_disabled("toshiba") ||
223             ACPI_ID_PROBE(device_get_parent(dev), dev, tosh_ids) == NULL ||
224             device_get_unit(dev) != 0)
225                 return (ENXIO);
226
227         device_set_desc(dev, "Toshiba HCI Extras");
228         return (0);
229 }
230
231 static int
232 acpi_toshiba_attach(device_t dev)
233 {
234         struct          acpi_toshiba_softc *sc;
235         struct          acpi_softc *acpi_sc;
236         ACPI_STATUS     status;
237         int             i;
238
239         sc = device_get_softc(dev);
240         sc->dev = dev;
241         sc->handle = acpi_get_handle(dev);
242
243         acpi_sc = acpi_device_get_parent_softc(dev);
244         sysctl_ctx_init(&sc->sysctl_ctx);
245         sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
246             SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO,
247             "toshiba", CTLFLAG_RD, 0, "");
248
249         for (i = 0; sysctl_table[i].name != NULL; i++) {
250                 SYSCTL_ADD_PROC(&sc->sysctl_ctx,
251                     SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
252                     sysctl_table[i].name,
253                     CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY,
254                     sc, i, acpi_toshiba_sysctl, "I", "");
255         }
256
257         if (enable_fn_keys != 0) {
258                 status = AcpiEvaluateObject(sc->handle, METHOD_HCI_ENABLE,
259                                             NULL, NULL);
260                 if (ACPI_FAILURE(status)) {
261                         device_printf(dev, "enable FN keys failed\n");
262                         sysctl_ctx_free(&sc->sysctl_ctx);
263                         return (ENXIO);
264                 }
265                 AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
266                                          acpi_toshiba_notify, sc);
267         }
268
269         return (0);
270 }
271
272 static int
273 acpi_toshiba_detach(device_t dev)
274 {
275         struct          acpi_toshiba_softc *sc;
276
277         sc = device_get_softc(dev);
278         if (enable_fn_keys != 0) {
279                 AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
280                                         acpi_toshiba_notify);
281         }
282         sysctl_ctx_free(&sc->sysctl_ctx);
283
284         return (0);
285 }
286
287 static int
288 acpi_toshiba_sysctl(SYSCTL_HANDLER_ARGS)
289 {
290         struct          acpi_toshiba_softc *sc;
291         UINT32          arg;
292         int             function, error = 0;
293         hci_fn_t        *handler;
294
295         sc = (struct acpi_toshiba_softc *)oidp->oid_arg1;
296         function = oidp->oid_arg2;
297         handler = sysctl_table[function].handler;
298
299         /* Get the current value from the appropriate function. */
300         ACPI_SERIAL_BEGIN(toshiba);
301         error = handler(sc->handle, HCI_GET, &arg);
302         if (error != 0)
303                 goto out;
304
305         /* Send the current value to the user and return if no new value. */
306         error = sysctl_handle_int(oidp, &arg, 0, req);
307         if (error != 0 || req->newptr == NULL)
308                 goto out;
309
310         /* Set the new value via the appropriate function. */
311         error = handler(sc->handle, HCI_SET, &arg);
312
313 out:
314         ACPI_SERIAL_END(toshiba);
315         return (error);
316 }
317
318 static int
319 hci_force_fan(ACPI_HANDLE h, int op, UINT32 *state)
320 {
321         int             ret;
322
323         ACPI_SERIAL_ASSERT(toshiba);
324         if (op == HCI_SET) {
325                 if (*state < 0 || *state > 1)
326                         return (EINVAL);
327                 *state <<= HCI_FAN_SHIFT;
328         }
329         ret = hci_call(h, op, HCI_REG_FAN, state);
330         if (ret == 0 && op == HCI_GET)
331                 *state >>= HCI_FAN_SHIFT;
332         return (ret);
333 }
334
335 static int
336 hci_video_output(ACPI_HANDLE h, int op, UINT32 *video_output)
337 {
338         int             ret;
339         ACPI_STATUS     status;
340
341         ACPI_SERIAL_ASSERT(toshiba);
342         if (op == HCI_SET) {
343                 if (*video_output < 1 || *video_output > 7)
344                         return (EINVAL);
345                 if (h == NULL)
346                         return (ENXIO);
347                 *video_output |= HCI_VIDEO_OUTPUT_FLAG;
348                 status = acpi_SetInteger(h, METHOD_VIDEO, *video_output);
349                 if (ACPI_SUCCESS(status))
350                         ret = 0;
351                 else
352                         ret = ENXIO;
353         } else {
354                 ret = hci_call(h, op, HCI_REG_VIDEO_OUTPUT, video_output);
355                 if (ret == 0)
356                         *video_output &= 0xff;
357         }
358
359         return (ret);
360 }
361
362 static int
363 hci_lcd_brightness(ACPI_HANDLE h, int op, UINT32 *brightness)
364 {
365         int             ret;
366
367         ACPI_SERIAL_ASSERT(toshiba);
368         if (op == HCI_SET) {
369                 if (*brightness < 0 || *brightness > HCI_LCD_BRIGHTNESS_MAX)
370                         return (EINVAL);
371                 *brightness <<= HCI_LCD_BRIGHTNESS_SHIFT;
372         }
373         ret = hci_call(h, op, HCI_REG_LCD_BRIGHTNESS, brightness);
374         if (ret == 0 && op == HCI_GET)
375                 *brightness >>= HCI_LCD_BRIGHTNESS_SHIFT;
376         return (ret);
377 }
378
379 static int
380 hci_lcd_backlight(ACPI_HANDLE h, int op, UINT32 *backlight)
381 {
382
383         ACPI_SERIAL_ASSERT(toshiba);
384         if (op == HCI_SET) {
385                 if (*backlight < 0 || *backlight > 1)
386                         return (EINVAL);
387         }
388         return (hci_call(h, op, HCI_REG_LCD_BACKLIGHT, backlight));
389 }
390
391 static int
392 hci_cpu_speed(ACPI_HANDLE h, int op, UINT32 *speed)
393 {
394         int             ret;
395
396         ACPI_SERIAL_ASSERT(toshiba);
397         if (op == HCI_SET) {
398                 if (*speed < 0 || *speed > HCI_CPU_SPEED_MAX)
399                         return (EINVAL);
400                 *speed <<= HCI_CPU_SPEED_SHIFT;
401         }
402         ret = hci_call(h, op, HCI_REG_CPU_SPEED, speed);
403         if (ret == 0 && op == HCI_GET)
404                 *speed >>= HCI_CPU_SPEED_SHIFT;
405         return (ret);
406 }
407
408 static int
409 hci_call(ACPI_HANDLE h, int op, int function, UINT32 *arg)
410 {
411         ACPI_OBJECT_LIST args;
412         ACPI_BUFFER     results;
413         ACPI_OBJECT     obj[HCI_WORDS];
414         ACPI_OBJECT     *res;
415         int             status, i, ret;
416
417         ACPI_SERIAL_ASSERT(toshiba);
418         status = ENXIO;
419
420         for (i = 0; i < HCI_WORDS; i++) {
421                 obj[i].Type = ACPI_TYPE_INTEGER;
422                 obj[i].Integer.Value = 0;
423         }
424         obj[HCI_REG_AX].Integer.Value = op;
425         obj[HCI_REG_BX].Integer.Value = function;
426         if (op == HCI_SET)
427                 obj[HCI_REG_CX].Integer.Value = *arg;
428
429         args.Count = HCI_WORDS;
430         args.Pointer = obj;
431         results.Pointer = NULL;
432         results.Length = ACPI_ALLOCATE_BUFFER;
433         if (ACPI_FAILURE(AcpiEvaluateObject(h, METHOD_HCI, &args, &results)))
434                 goto end;
435         res = (ACPI_OBJECT *)results.Pointer;
436         if (!ACPI_PKG_VALID(res, HCI_WORDS)) {
437                 kprintf("toshiba: invalid package!\n");
438                 return (ENXIO);
439         }
440
441         acpi_PkgInt32(res, HCI_REG_AX, &ret);
442         if (ret == HCI_SUCCESS) {
443                 if (op == HCI_GET)
444                         acpi_PkgInt32(res, HCI_REG_CX, arg);
445                 status = 0;
446         } else if (function == HCI_REG_SYSTEM_EVENT && op == HCI_GET &&
447             ret == HCI_NOT_SUPPORTED) {
448                 /*
449                  * Sometimes system events are disabled without us requesting
450                  * it.  This workaround attempts to re-enable them.
451                  *
452                  * XXX This call probably shouldn't be recursive.  Queueing
453                  * a task via AcpiOsQueueForExecution() might be better.
454                  */
455                  i = 1;
456                  hci_call(h, HCI_SET, HCI_REG_SYSTEM_EVENT, &i);
457         }
458
459 end:
460         if (results.Pointer != NULL)
461                 AcpiOsFree(results.Pointer);
462
463         return (status);
464 }
465
466 /*
467  * Perform a few actions based on the keypress.  Users can extend this
468  * functionality by reading the keystrokes we send to devd(8).
469  */
470 static void
471 hci_key_action(struct acpi_toshiba_softc *sc, ACPI_HANDLE h, UINT32 key)
472 {
473         UINT32          arg;
474
475         ACPI_SERIAL_ASSERT(toshiba);
476         switch (key) {
477         case FN_F6_RELEASE:
478                 /* Decrease LCD brightness. */
479                 hci_lcd_brightness(h, HCI_GET, &arg);
480                 if (arg-- == 0)
481                         arg = 0;
482                 else
483                         hci_lcd_brightness(h, HCI_SET, &arg);
484                 break;
485         case FN_F7_RELEASE:
486                 /* Increase LCD brightness. */
487                 hci_lcd_brightness(h, HCI_GET, &arg);
488                 if (arg++ == 7)
489                         arg = 7;
490                 else
491                         hci_lcd_brightness(h, HCI_SET, &arg);
492                 break;
493         case FN_F5_RELEASE:
494                 /* Cycle through video outputs. */
495                 hci_video_output(h, HCI_GET, &arg);
496                 arg = (arg + 1) % 7;
497                 hci_video_output(sc->video_handle, HCI_SET, &arg);
498                 break;
499         case FN_F8_RELEASE:
500                 /* Toggle LCD backlight. */
501                 hci_lcd_backlight(h, HCI_GET, &arg);
502                 arg = (arg != 0) ? 0 : 1;
503                 hci_lcd_backlight(h, HCI_SET, &arg);
504                 break;
505         case FN_ESC_RELEASE:
506                 /* Toggle forcing fan on. */
507                 hci_force_fan(h, HCI_GET, &arg);
508                 arg = (arg != 0) ? 0 : 1;
509                 hci_force_fan(h, HCI_SET, &arg);
510                 break;
511         }
512 }
513
514 static void
515 acpi_toshiba_notify(ACPI_HANDLE h, UINT32 notify, void *context)
516 {
517         struct          acpi_toshiba_softc *sc;
518         UINT32          key;
519
520         sc = (struct acpi_toshiba_softc *)context;
521
522         if (notify == 0x80) {
523                 ACPI_SERIAL_BEGIN(toshiba);
524                 while (hci_call(h, HCI_GET, HCI_REG_SYSTEM_EVENT, &key) == 0) {
525                         hci_key_action(sc, h, key);
526                         acpi_UserNotify("TOSHIBA", h, (uint8_t)key);
527                 }
528                 ACPI_SERIAL_END(toshiba);
529         } else
530                 device_printf(sc->dev, "unknown notify: 0x%x\n", notify);
531 }
532
533 /*
534  * Toshiba video pseudo-device to provide the DSSX method.
535  *
536  * HID      Model
537  * -------------------------------------
538  * TOS6201  Libretto L Series
539  */
540 static int
541 acpi_toshiba_video_probe(device_t dev)
542 {
543         static char *vid_ids[] = { "TOS6201", NULL };
544
545         if (acpi_disabled("toshiba") ||
546             ACPI_ID_PROBE(device_get_parent(dev), dev, vid_ids) == NULL ||
547             device_get_unit(dev) != 0)
548                 return (ENXIO);
549
550         device_quiet(dev);
551         device_set_desc(dev, "Toshiba Video");
552         return (0);
553 }
554
555 static int
556 acpi_toshiba_video_attach(device_t dev)
557 {
558         struct          acpi_toshiba_softc *sc;
559
560         sc = devclass_get_softc(acpi_toshiba_devclass, 0);
561         if (sc == NULL)
562                 return (ENXIO);
563         sc->video_handle = acpi_get_handle(dev);
564         return (0);
565 }