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