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 NULL, NULL);
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, NULL, NULL);
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
acpi_toshiba_probe(device_t dev)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
acpi_toshiba_attach(device_t dev)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 ACPI_SERIAL_INIT(toshiba);
243
244 acpi_sc = acpi_device_get_parent_softc(dev);
245 sysctl_ctx_init(&sc->sysctl_ctx);
246 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx,
247 SYSCTL_CHILDREN(acpi_sc->acpi_sysctl_tree), OID_AUTO,
248 "toshiba", CTLFLAG_RD, 0, "");
249
250 for (i = 0; sysctl_table[i].name != NULL; i++) {
251 SYSCTL_ADD_PROC(&sc->sysctl_ctx,
252 SYSCTL_CHILDREN(sc->sysctl_tree), OID_AUTO,
253 sysctl_table[i].name,
254 CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_ANYBODY,
255 sc, i, acpi_toshiba_sysctl, "I", "");
256 }
257
258 if (enable_fn_keys != 0) {
259 status = AcpiEvaluateObject(sc->handle, METHOD_HCI_ENABLE,
260 NULL, NULL);
261 if (ACPI_FAILURE(status)) {
262 device_printf(dev, "enable FN keys failed\n");
263 sysctl_ctx_free(&sc->sysctl_ctx);
264 return (ENXIO);
265 }
266 AcpiInstallNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
267 acpi_toshiba_notify, sc);
268 }
269
270 return (0);
271 }
272
273 static int
acpi_toshiba_detach(device_t dev)274 acpi_toshiba_detach(device_t dev)
275 {
276 struct acpi_toshiba_softc *sc;
277
278 sc = device_get_softc(dev);
279 if (enable_fn_keys != 0) {
280 AcpiRemoveNotifyHandler(sc->handle, ACPI_DEVICE_NOTIFY,
281 acpi_toshiba_notify);
282 }
283 sysctl_ctx_free(&sc->sysctl_ctx);
284
285 return (0);
286 }
287
288 static int
acpi_toshiba_sysctl(SYSCTL_HANDLER_ARGS)289 acpi_toshiba_sysctl(SYSCTL_HANDLER_ARGS)
290 {
291 struct acpi_toshiba_softc *sc;
292 UINT32 arg;
293 int function, error = 0;
294 hci_fn_t *handler;
295
296 sc = (struct acpi_toshiba_softc *)oidp->oid_arg1;
297 function = oidp->oid_arg2;
298 handler = sysctl_table[function].handler;
299
300 /* Get the current value from the appropriate function. */
301 ACPI_SERIAL_BEGIN(toshiba);
302 error = handler(sc->handle, HCI_GET, &arg);
303 if (error != 0)
304 goto out;
305
306 /* Send the current value to the user and return if no new value. */
307 error = sysctl_handle_int(oidp, &arg, 0, req);
308 if (error != 0 || req->newptr == NULL)
309 goto out;
310
311 /* Set the new value via the appropriate function. */
312 error = handler(sc->handle, HCI_SET, &arg);
313
314 out:
315 ACPI_SERIAL_END(toshiba);
316 return (error);
317 }
318
319 static int
hci_force_fan(ACPI_HANDLE h,int op,UINT32 * state)320 hci_force_fan(ACPI_HANDLE h, int op, UINT32 *state)
321 {
322 int ret;
323
324 ACPI_SERIAL_ASSERT(toshiba);
325 if (op == HCI_SET) {
326 if (*state > 1)
327 return (EINVAL);
328 *state <<= HCI_FAN_SHIFT;
329 }
330 ret = hci_call(h, op, HCI_REG_FAN, state);
331 if (ret == 0 && op == HCI_GET)
332 *state >>= HCI_FAN_SHIFT;
333 return (ret);
334 }
335
336 static int
hci_video_output(ACPI_HANDLE h,int op,UINT32 * video_output)337 hci_video_output(ACPI_HANDLE h, int op, UINT32 *video_output)
338 {
339 int ret;
340 ACPI_STATUS status;
341
342 ACPI_SERIAL_ASSERT(toshiba);
343 if (op == HCI_SET) {
344 if (*video_output < 1 || *video_output > 7)
345 return (EINVAL);
346 if (h == NULL)
347 return (ENXIO);
348 *video_output |= HCI_VIDEO_OUTPUT_FLAG;
349 status = acpi_SetInteger(h, METHOD_VIDEO, *video_output);
350 if (ACPI_SUCCESS(status))
351 ret = 0;
352 else
353 ret = ENXIO;
354 } else {
355 ret = hci_call(h, op, HCI_REG_VIDEO_OUTPUT, video_output);
356 if (ret == 0)
357 *video_output &= 0xff;
358 }
359
360 return (ret);
361 }
362
363 static int
hci_lcd_brightness(ACPI_HANDLE h,int op,UINT32 * brightness)364 hci_lcd_brightness(ACPI_HANDLE h, int op, UINT32 *brightness)
365 {
366 int ret;
367
368 ACPI_SERIAL_ASSERT(toshiba);
369 if (op == HCI_SET) {
370 if (*brightness > HCI_LCD_BRIGHTNESS_MAX)
371 return (EINVAL);
372 *brightness <<= HCI_LCD_BRIGHTNESS_SHIFT;
373 }
374 ret = hci_call(h, op, HCI_REG_LCD_BRIGHTNESS, brightness);
375 if (ret == 0 && op == HCI_GET)
376 *brightness >>= HCI_LCD_BRIGHTNESS_SHIFT;
377 return (ret);
378 }
379
380 static int
hci_lcd_backlight(ACPI_HANDLE h,int op,UINT32 * backlight)381 hci_lcd_backlight(ACPI_HANDLE h, int op, UINT32 *backlight)
382 {
383
384 ACPI_SERIAL_ASSERT(toshiba);
385 if (op == HCI_SET) {
386 if (*backlight > 1)
387 return (EINVAL);
388 }
389 return (hci_call(h, op, HCI_REG_LCD_BACKLIGHT, backlight));
390 }
391
392 static int
hci_cpu_speed(ACPI_HANDLE h,int op,UINT32 * speed)393 hci_cpu_speed(ACPI_HANDLE h, int op, UINT32 *speed)
394 {
395 int ret;
396
397 ACPI_SERIAL_ASSERT(toshiba);
398 if (op == HCI_SET) {
399 if (*speed > HCI_CPU_SPEED_MAX)
400 return (EINVAL);
401 *speed <<= HCI_CPU_SPEED_SHIFT;
402 }
403 ret = hci_call(h, op, HCI_REG_CPU_SPEED, speed);
404 if (ret == 0 && op == HCI_GET)
405 *speed >>= HCI_CPU_SPEED_SHIFT;
406 return (ret);
407 }
408
409 static int
hci_call(ACPI_HANDLE h,int op,int function,UINT32 * arg)410 hci_call(ACPI_HANDLE h, int op, int function, UINT32 *arg)
411 {
412 ACPI_OBJECT_LIST args;
413 ACPI_BUFFER results;
414 ACPI_OBJECT obj[HCI_WORDS];
415 ACPI_OBJECT *res;
416 int status, i, ret;
417
418 ACPI_SERIAL_ASSERT(toshiba);
419 status = ENXIO;
420
421 for (i = 0; i < HCI_WORDS; i++) {
422 obj[i].Type = ACPI_TYPE_INTEGER;
423 obj[i].Integer.Value = 0;
424 }
425 obj[HCI_REG_AX].Integer.Value = op;
426 obj[HCI_REG_BX].Integer.Value = function;
427 if (op == HCI_SET)
428 obj[HCI_REG_CX].Integer.Value = *arg;
429
430 args.Count = HCI_WORDS;
431 args.Pointer = obj;
432 results.Pointer = NULL;
433 results.Length = ACPI_ALLOCATE_BUFFER;
434 if (ACPI_FAILURE(AcpiEvaluateObject(h, METHOD_HCI, &args, &results)))
435 goto end;
436 res = (ACPI_OBJECT *)results.Pointer;
437 if (!ACPI_PKG_VALID(res, HCI_WORDS)) {
438 kprintf("toshiba: invalid package!\n");
439 return (ENXIO);
440 }
441
442 acpi_PkgInt32(res, HCI_REG_AX, &ret);
443 if (ret == HCI_SUCCESS) {
444 if (op == HCI_GET)
445 acpi_PkgInt32(res, HCI_REG_CX, arg);
446 status = 0;
447 } else if (function == HCI_REG_SYSTEM_EVENT && op == HCI_GET &&
448 ret == HCI_NOT_SUPPORTED) {
449 /*
450 * Sometimes system events are disabled without us requesting
451 * it. This workaround attempts to re-enable them.
452 *
453 * XXX This call probably shouldn't be recursive. Queueing
454 * a task via AcpiOsQueueForExecution() might be better.
455 */
456 i = 1;
457 hci_call(h, HCI_SET, HCI_REG_SYSTEM_EVENT, &i);
458 }
459
460 end:
461 if (results.Pointer != NULL)
462 AcpiOsFree(results.Pointer);
463
464 return (status);
465 }
466
467 /*
468 * Perform a few actions based on the keypress. Users can extend this
469 * functionality by reading the keystrokes we send to devd(8).
470 */
471 static void
hci_key_action(struct acpi_toshiba_softc * sc,ACPI_HANDLE h,UINT32 key)472 hci_key_action(struct acpi_toshiba_softc *sc, ACPI_HANDLE h, UINT32 key)
473 {
474 UINT32 arg;
475
476 ACPI_SERIAL_ASSERT(toshiba);
477 switch (key) {
478 case FN_F6_RELEASE:
479 /* Decrease LCD brightness. */
480 hci_lcd_brightness(h, HCI_GET, &arg);
481 if (arg-- == 0)
482 arg = 0;
483 else
484 hci_lcd_brightness(h, HCI_SET, &arg);
485 break;
486 case FN_F7_RELEASE:
487 /* Increase LCD brightness. */
488 hci_lcd_brightness(h, HCI_GET, &arg);
489 if (arg++ == 7)
490 arg = 7;
491 else
492 hci_lcd_brightness(h, HCI_SET, &arg);
493 break;
494 case FN_F5_RELEASE:
495 /* Cycle through video outputs. */
496 hci_video_output(h, HCI_GET, &arg);
497 arg = (arg + 1) % 7;
498 hci_video_output(sc->video_handle, HCI_SET, &arg);
499 break;
500 case FN_F8_RELEASE:
501 /* Toggle LCD backlight. */
502 hci_lcd_backlight(h, HCI_GET, &arg);
503 arg = (arg != 0) ? 0 : 1;
504 hci_lcd_backlight(h, HCI_SET, &arg);
505 break;
506 case FN_ESC_RELEASE:
507 /* Toggle forcing fan on. */
508 hci_force_fan(h, HCI_GET, &arg);
509 arg = (arg != 0) ? 0 : 1;
510 hci_force_fan(h, HCI_SET, &arg);
511 break;
512 }
513 }
514
515 static void
acpi_toshiba_notify(ACPI_HANDLE h,UINT32 notify,void * context)516 acpi_toshiba_notify(ACPI_HANDLE h, UINT32 notify, void *context)
517 {
518 struct acpi_toshiba_softc *sc;
519 UINT32 key;
520
521 sc = (struct acpi_toshiba_softc *)context;
522
523 if (notify == 0x80) {
524 ACPI_SERIAL_BEGIN(toshiba);
525 while (hci_call(h, HCI_GET, HCI_REG_SYSTEM_EVENT, &key) == 0) {
526 hci_key_action(sc, h, key);
527 acpi_UserNotify("TOSHIBA", h, (uint8_t)key);
528 }
529 ACPI_SERIAL_END(toshiba);
530 } else {
531 device_printf(sc->dev, "unknown notify: %#x\n", notify);
532 }
533 }
534
535 /*
536 * Toshiba video pseudo-device to provide the DSSX method.
537 *
538 * HID Model
539 * -------------------------------------
540 * TOS6201 Libretto L Series
541 */
542 static int
acpi_toshiba_video_probe(device_t dev)543 acpi_toshiba_video_probe(device_t dev)
544 {
545 static char *vid_ids[] = { "TOS6201", NULL };
546
547 if (acpi_disabled("toshiba") ||
548 ACPI_ID_PROBE(device_get_parent(dev), dev, vid_ids) == NULL ||
549 device_get_unit(dev) != 0)
550 return (ENXIO);
551
552 device_quiet(dev);
553 device_set_desc(dev, "Toshiba Video");
554 return (0);
555 }
556
557 static int
acpi_toshiba_video_attach(device_t dev)558 acpi_toshiba_video_attach(device_t dev)
559 {
560 struct acpi_toshiba_softc *sc;
561
562 sc = devclass_get_softc(acpi_toshiba_devclass, 0);
563 if (sc == NULL)
564 return (ENXIO);
565 sc->video_handle = acpi_get_handle(dev);
566 return (0);
567 }
568