acpi_ec.c revision 1.71.2.1
1 /* $NetBSD: acpi_ec.c,v 1.71.2.1 2014/05/22 11:40:19 yamt Exp $ */ 2 3 /*- 4 * Copyright (c) 2007 Joerg Sonnenberger <joerg (at) NetBSD.org>. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 22 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 23 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 26 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 28 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 /* 33 * The ACPI Embedded Controller (EC) driver serves two different purposes: 34 * - read and write access from ASL, e.g. to read battery state 35 * - notification of ASL of System Control Interrupts. 36 * 37 * Access to the EC is serialised by sc_access_mtx and optionally the 38 * ACPI global mutex. Both locks are held until the request is fulfilled. 39 * All access to the softc has to hold sc_mtx to serialise against the GPE 40 * handler and the callout. sc_mtx is also used for wakeup conditions. 41 * 42 * SCIs are processed in a kernel thread. Handling gets a bit complicated 43 * by the lock order (sc_mtx must be acquired after sc_access_mtx and the 44 * ACPI global mutex). 45 * 46 * Read and write requests spin around for a short time as many requests 47 * can be handled instantly by the EC. During normal processing interrupt 48 * mode is used exclusively. At boot and resume time interrupts are not 49 * working and the handlers just busy loop. 50 * 51 * A callout is scheduled to compensate for missing interrupts on some 52 * hardware. If the EC doesn't process a request for 5s, it is most likely 53 * in a wedged state. No method to reset the EC is currently known. 54 * 55 * Special care has to be taken to not poll the EC in a busy loop without 56 * delay. This can prevent processing of Power Button events. At least some 57 * Lenovo Thinkpads seem to be implement the Power Button Override in the EC 58 * and the only option to recover on those models is to cut off all power. 59 */ 60 61 #include <sys/cdefs.h> 62 __KERNEL_RCSID(0, "$NetBSD: acpi_ec.c,v 1.71.2.1 2014/05/22 11:40:19 yamt Exp $"); 63 64 #include <sys/param.h> 65 #include <sys/callout.h> 66 #include <sys/condvar.h> 67 #include <sys/device.h> 68 #include <sys/kernel.h> 69 #include <sys/kthread.h> 70 #include <sys/mutex.h> 71 #include <sys/systm.h> 72 73 #include <dev/acpi/acpireg.h> 74 #include <dev/acpi/acpivar.h> 75 #include <dev/acpi/acpi_ecvar.h> 76 77 #define _COMPONENT ACPI_EC_COMPONENT 78 ACPI_MODULE_NAME ("acpi_ec") 79 80 /* Maximum time to wait for global ACPI lock in ms */ 81 #define EC_LOCK_TIMEOUT 5 82 83 /* Maximum time to poll for completion of a command in ms */ 84 #define EC_POLL_TIMEOUT 5 85 86 /* Maximum time to give a single EC command in s */ 87 #define EC_CMD_TIMEOUT 10 88 89 /* From ACPI 3.0b, chapter 12.3 */ 90 #define EC_COMMAND_READ 0x80 91 #define EC_COMMAND_WRITE 0x81 92 #define EC_COMMAND_BURST_EN 0x82 93 #define EC_COMMAND_BURST_DIS 0x83 94 #define EC_COMMAND_QUERY 0x84 95 96 /* From ACPI 3.0b, chapter 12.2.1 */ 97 #define EC_STATUS_OBF 0x01 98 #define EC_STATUS_IBF 0x02 99 #define EC_STATUS_CMD 0x08 100 #define EC_STATUS_BURST 0x10 101 #define EC_STATUS_SCI 0x20 102 #define EC_STATUS_SMI 0x40 103 104 static const char *ec_hid[] = { 105 "PNP0C09", 106 NULL, 107 }; 108 109 enum ec_state_t { 110 EC_STATE_QUERY, 111 EC_STATE_QUERY_VAL, 112 EC_STATE_READ, 113 EC_STATE_READ_ADDR, 114 EC_STATE_READ_VAL, 115 EC_STATE_WRITE, 116 EC_STATE_WRITE_ADDR, 117 EC_STATE_WRITE_VAL, 118 EC_STATE_FREE 119 }; 120 121 struct acpiec_softc { 122 ACPI_HANDLE sc_ech; 123 124 ACPI_HANDLE sc_gpeh; 125 uint8_t sc_gpebit; 126 127 bus_space_tag_t sc_data_st; 128 bus_space_handle_t sc_data_sh; 129 130 bus_space_tag_t sc_csr_st; 131 bus_space_handle_t sc_csr_sh; 132 133 bool sc_need_global_lock; 134 uint32_t sc_global_lock; 135 136 kmutex_t sc_mtx, sc_access_mtx; 137 kcondvar_t sc_cv, sc_cv_sci; 138 enum ec_state_t sc_state; 139 bool sc_got_sci; 140 callout_t sc_pseudo_intr; 141 142 uint8_t sc_cur_addr, sc_cur_val; 143 }; 144 145 static int acpiecdt_match(device_t, cfdata_t, void *); 146 static void acpiecdt_attach(device_t, device_t, void *); 147 148 static int acpiec_match(device_t, cfdata_t, void *); 149 static void acpiec_attach(device_t, device_t, void *); 150 151 static void acpiec_common_attach(device_t, device_t, ACPI_HANDLE, 152 bus_space_tag_t, bus_addr_t, bus_space_tag_t, bus_addr_t, 153 ACPI_HANDLE, uint8_t); 154 155 static bool acpiec_suspend(device_t, const pmf_qual_t *); 156 static bool acpiec_resume(device_t, const pmf_qual_t *); 157 static bool acpiec_shutdown(device_t, int); 158 159 static bool acpiec_parse_gpe_package(device_t, ACPI_HANDLE, 160 ACPI_HANDLE *, uint8_t *); 161 162 static void acpiec_callout(void *); 163 static void acpiec_gpe_query(void *); 164 static uint32_t acpiec_gpe_handler(ACPI_HANDLE, uint32_t, void *); 165 static ACPI_STATUS acpiec_space_setup(ACPI_HANDLE, uint32_t, void *, void **); 166 static ACPI_STATUS acpiec_space_handler(uint32_t, ACPI_PHYSICAL_ADDRESS, 167 uint32_t, ACPI_INTEGER *, void *, void *); 168 169 static void acpiec_gpe_state_machine(device_t); 170 171 CFATTACH_DECL_NEW(acpiec, sizeof(struct acpiec_softc), 172 acpiec_match, acpiec_attach, NULL, NULL); 173 174 CFATTACH_DECL_NEW(acpiecdt, sizeof(struct acpiec_softc), 175 acpiecdt_match, acpiecdt_attach, NULL, NULL); 176 177 static device_t ec_singleton = NULL; 178 static bool acpiec_cold = false; 179 180 static bool 181 acpiecdt_find(device_t parent, ACPI_HANDLE *ec_handle, 182 bus_addr_t *cmd_reg, bus_addr_t *data_reg, uint8_t *gpebit) 183 { 184 ACPI_TABLE_ECDT *ecdt; 185 ACPI_STATUS rv; 186 187 rv = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt); 188 if (ACPI_FAILURE(rv)) 189 return false; 190 191 if (ecdt->Control.BitWidth != 8 || ecdt->Data.BitWidth != 8) { 192 aprint_error_dev(parent, 193 "ECDT register width invalid (%u/%u)\n", 194 ecdt->Control.BitWidth, ecdt->Data.BitWidth); 195 return false; 196 } 197 198 rv = AcpiGetHandle(ACPI_ROOT_OBJECT, ecdt->Id, ec_handle); 199 if (ACPI_FAILURE(rv)) { 200 aprint_error_dev(parent, 201 "failed to look up EC object %s: %s\n", 202 ecdt->Id, AcpiFormatException(rv)); 203 return false; 204 } 205 206 *cmd_reg = ecdt->Control.Address; 207 *data_reg = ecdt->Data.Address; 208 *gpebit = ecdt->Gpe; 209 210 return true; 211 } 212 213 static int 214 acpiecdt_match(device_t parent, cfdata_t match, void *aux) 215 { 216 ACPI_HANDLE ec_handle; 217 bus_addr_t cmd_reg, data_reg; 218 uint8_t gpebit; 219 220 if (acpiecdt_find(parent, &ec_handle, &cmd_reg, &data_reg, &gpebit)) 221 return 1; 222 else 223 return 0; 224 } 225 226 static void 227 acpiecdt_attach(device_t parent, device_t self, void *aux) 228 { 229 struct acpibus_attach_args *aa = aux; 230 ACPI_HANDLE ec_handle; 231 bus_addr_t cmd_reg, data_reg; 232 uint8_t gpebit; 233 234 if (!acpiecdt_find(parent, &ec_handle, &cmd_reg, &data_reg, &gpebit)) 235 panic("ECDT disappeared"); 236 237 aprint_naive("\n"); 238 aprint_normal(": ACPI Embedded Controller via ECDT\n"); 239 240 acpiec_common_attach(parent, self, ec_handle, aa->aa_iot, cmd_reg, 241 aa->aa_iot, data_reg, NULL, gpebit); 242 } 243 244 static int 245 acpiec_match(device_t parent, cfdata_t match, void *aux) 246 { 247 struct acpi_attach_args *aa = aux; 248 249 if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE) 250 return 0; 251 252 return acpi_match_hid(aa->aa_node->ad_devinfo, ec_hid); 253 } 254 255 static void 256 acpiec_attach(device_t parent, device_t self, void *aux) 257 { 258 struct acpi_attach_args *aa = aux; 259 struct acpi_resources ec_res; 260 struct acpi_io *io0, *io1; 261 ACPI_HANDLE gpe_handle; 262 uint8_t gpebit; 263 ACPI_STATUS rv; 264 265 if (ec_singleton != NULL) { 266 aprint_naive(": using %s\n", device_xname(ec_singleton)); 267 aprint_normal(": using %s\n", device_xname(ec_singleton)); 268 if (!pmf_device_register(self, NULL, NULL)) 269 aprint_error_dev(self, "couldn't establish power handler\n"); 270 return; 271 } 272 273 if (!acpiec_parse_gpe_package(self, aa->aa_node->ad_handle, 274 &gpe_handle, &gpebit)) 275 return; 276 277 rv = acpi_resource_parse(self, aa->aa_node->ad_handle, "_CRS", 278 &ec_res, &acpi_resource_parse_ops_default); 279 if (rv != AE_OK) { 280 aprint_error_dev(self, "resource parsing failed: %s\n", 281 AcpiFormatException(rv)); 282 return; 283 } 284 285 if ((io0 = acpi_res_io(&ec_res, 0)) == NULL) { 286 aprint_error_dev(self, "no data register resource\n"); 287 goto free_res; 288 } 289 if ((io1 = acpi_res_io(&ec_res, 1)) == NULL) { 290 aprint_error_dev(self, "no CSR register resource\n"); 291 goto free_res; 292 } 293 294 acpiec_common_attach(parent, self, aa->aa_node->ad_handle, 295 aa->aa_iot, io1->ar_base, aa->aa_iot, io0->ar_base, 296 gpe_handle, gpebit); 297 298 free_res: 299 acpi_resource_cleanup(&ec_res); 300 } 301 302 static void 303 acpiec_common_attach(device_t parent, device_t self, 304 ACPI_HANDLE ec_handle, bus_space_tag_t cmdt, bus_addr_t cmd_reg, 305 bus_space_tag_t datat, bus_addr_t data_reg, 306 ACPI_HANDLE gpe_handle, uint8_t gpebit) 307 { 308 struct acpiec_softc *sc = device_private(self); 309 ACPI_STATUS rv; 310 ACPI_INTEGER val; 311 312 sc->sc_csr_st = cmdt; 313 sc->sc_data_st = datat; 314 315 sc->sc_ech = ec_handle; 316 sc->sc_gpeh = gpe_handle; 317 sc->sc_gpebit = gpebit; 318 319 sc->sc_state = EC_STATE_FREE; 320 mutex_init(&sc->sc_mtx, MUTEX_DRIVER, IPL_TTY); 321 mutex_init(&sc->sc_access_mtx, MUTEX_DEFAULT, IPL_NONE); 322 cv_init(&sc->sc_cv, "eccv"); 323 cv_init(&sc->sc_cv_sci, "ecsci"); 324 325 if (bus_space_map(sc->sc_data_st, data_reg, 1, 0, 326 &sc->sc_data_sh) != 0) { 327 aprint_error_dev(self, "unable to map data register\n"); 328 return; 329 } 330 331 if (bus_space_map(sc->sc_csr_st, cmd_reg, 1, 0, &sc->sc_csr_sh) != 0) { 332 aprint_error_dev(self, "unable to map CSR register\n"); 333 goto post_data_map; 334 } 335 336 rv = acpi_eval_integer(sc->sc_ech, "_GLK", &val); 337 if (rv == AE_OK) { 338 sc->sc_need_global_lock = val != 0; 339 } else if (rv != AE_NOT_FOUND) { 340 aprint_error_dev(self, "unable to evaluate _GLK: %s\n", 341 AcpiFormatException(rv)); 342 goto post_csr_map; 343 } else { 344 sc->sc_need_global_lock = false; 345 } 346 if (sc->sc_need_global_lock) 347 aprint_normal_dev(self, "using global ACPI lock\n"); 348 349 callout_init(&sc->sc_pseudo_intr, CALLOUT_MPSAFE); 350 callout_setfunc(&sc->sc_pseudo_intr, acpiec_callout, self); 351 352 rv = AcpiInstallAddressSpaceHandler(sc->sc_ech, ACPI_ADR_SPACE_EC, 353 acpiec_space_handler, acpiec_space_setup, self); 354 if (rv != AE_OK) { 355 aprint_error_dev(self, 356 "unable to install address space handler: %s\n", 357 AcpiFormatException(rv)); 358 goto post_csr_map; 359 } 360 361 rv = AcpiInstallGpeHandler(sc->sc_gpeh, sc->sc_gpebit, 362 ACPI_GPE_EDGE_TRIGGERED, acpiec_gpe_handler, self); 363 if (rv != AE_OK) { 364 aprint_error_dev(self, "unable to install GPE handler: %s\n", 365 AcpiFormatException(rv)); 366 goto post_csr_map; 367 } 368 369 rv = AcpiEnableGpe(sc->sc_gpeh, sc->sc_gpebit); 370 if (rv != AE_OK) { 371 aprint_error_dev(self, "unable to enable GPE: %s\n", 372 AcpiFormatException(rv)); 373 goto post_csr_map; 374 } 375 376 if (kthread_create(PRI_NONE, KTHREAD_MPSAFE, NULL, acpiec_gpe_query, 377 self, NULL, "acpiec sci thread")) { 378 aprint_error_dev(self, "unable to create query kthread\n"); 379 goto post_csr_map; 380 } 381 382 ec_singleton = self; 383 384 if (!pmf_device_register1(self, acpiec_suspend, acpiec_resume, 385 acpiec_shutdown)) 386 aprint_error_dev(self, "couldn't establish power handler\n"); 387 388 return; 389 390 post_csr_map: 391 (void)AcpiRemoveGpeHandler(sc->sc_gpeh, sc->sc_gpebit, 392 acpiec_gpe_handler); 393 (void)AcpiRemoveAddressSpaceHandler(sc->sc_ech, 394 ACPI_ADR_SPACE_EC, acpiec_space_handler); 395 bus_space_unmap(sc->sc_csr_st, sc->sc_csr_sh, 1); 396 post_data_map: 397 bus_space_unmap(sc->sc_data_st, sc->sc_data_sh, 1); 398 } 399 400 static bool 401 acpiec_suspend(device_t dv, const pmf_qual_t *qual) 402 { 403 acpiec_cold = true; 404 405 return true; 406 } 407 408 static bool 409 acpiec_resume(device_t dv, const pmf_qual_t *qual) 410 { 411 acpiec_cold = false; 412 413 return true; 414 } 415 416 static bool 417 acpiec_shutdown(device_t dv, int how) 418 { 419 420 acpiec_cold = true; 421 return true; 422 } 423 424 static bool 425 acpiec_parse_gpe_package(device_t self, ACPI_HANDLE ec_handle, 426 ACPI_HANDLE *gpe_handle, uint8_t *gpebit) 427 { 428 ACPI_BUFFER buf; 429 ACPI_OBJECT *p, *c; 430 ACPI_STATUS rv; 431 432 rv = acpi_eval_struct(ec_handle, "_GPE", &buf); 433 if (rv != AE_OK) { 434 aprint_error_dev(self, "unable to evaluate _GPE: %s\n", 435 AcpiFormatException(rv)); 436 return false; 437 } 438 439 p = buf.Pointer; 440 441 if (p->Type == ACPI_TYPE_INTEGER) { 442 *gpe_handle = NULL; 443 *gpebit = p->Integer.Value; 444 ACPI_FREE(p); 445 return true; 446 } 447 448 if (p->Type != ACPI_TYPE_PACKAGE) { 449 aprint_error_dev(self, "_GPE is neither integer nor package\n"); 450 ACPI_FREE(p); 451 return false; 452 } 453 454 if (p->Package.Count != 2) { 455 aprint_error_dev(self, "_GPE package does not contain 2 elements\n"); 456 ACPI_FREE(p); 457 return false; 458 } 459 460 c = &p->Package.Elements[0]; 461 rv = acpi_eval_reference_handle(c, gpe_handle); 462 463 if (ACPI_FAILURE(rv)) { 464 aprint_error_dev(self, "failed to evaluate _GPE handle\n"); 465 ACPI_FREE(p); 466 return false; 467 } 468 469 c = &p->Package.Elements[1]; 470 471 if (c->Type != ACPI_TYPE_INTEGER) { 472 aprint_error_dev(self, 473 "_GPE package needs integer as 2nd field\n"); 474 ACPI_FREE(p); 475 return false; 476 } 477 *gpebit = c->Integer.Value; 478 ACPI_FREE(p); 479 return true; 480 } 481 482 static uint8_t 483 acpiec_read_data(struct acpiec_softc *sc) 484 { 485 return bus_space_read_1(sc->sc_data_st, sc->sc_data_sh, 0); 486 } 487 488 static void 489 acpiec_write_data(struct acpiec_softc *sc, uint8_t val) 490 { 491 bus_space_write_1(sc->sc_data_st, sc->sc_data_sh, 0, val); 492 } 493 494 static uint8_t 495 acpiec_read_status(struct acpiec_softc *sc) 496 { 497 return bus_space_read_1(sc->sc_csr_st, sc->sc_csr_sh, 0); 498 } 499 500 static void 501 acpiec_write_command(struct acpiec_softc *sc, uint8_t cmd) 502 { 503 bus_space_write_1(sc->sc_csr_st, sc->sc_csr_sh, 0, cmd); 504 } 505 506 static ACPI_STATUS 507 acpiec_space_setup(ACPI_HANDLE region, uint32_t func, void *arg, 508 void **region_arg) 509 { 510 if (func == ACPI_REGION_DEACTIVATE) 511 *region_arg = NULL; 512 else 513 *region_arg = arg; 514 515 return AE_OK; 516 } 517 518 static void 519 acpiec_lock(device_t dv) 520 { 521 struct acpiec_softc *sc = device_private(dv); 522 ACPI_STATUS rv; 523 524 mutex_enter(&sc->sc_access_mtx); 525 526 if (sc->sc_need_global_lock) { 527 rv = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->sc_global_lock); 528 if (rv != AE_OK) { 529 aprint_error_dev(dv, "failed to acquire global lock: %s\n", 530 AcpiFormatException(rv)); 531 return; 532 } 533 } 534 } 535 536 static void 537 acpiec_unlock(device_t dv) 538 { 539 struct acpiec_softc *sc = device_private(dv); 540 ACPI_STATUS rv; 541 542 if (sc->sc_need_global_lock) { 543 rv = AcpiReleaseGlobalLock(sc->sc_global_lock); 544 if (rv != AE_OK) { 545 aprint_error_dev(dv, "failed to release global lock: %s\n", 546 AcpiFormatException(rv)); 547 } 548 } 549 mutex_exit(&sc->sc_access_mtx); 550 } 551 552 static ACPI_STATUS 553 acpiec_read(device_t dv, uint8_t addr, uint8_t *val) 554 { 555 struct acpiec_softc *sc = device_private(dv); 556 int i, timeo = 1000 * EC_CMD_TIMEOUT; 557 558 acpiec_lock(dv); 559 mutex_enter(&sc->sc_mtx); 560 561 sc->sc_cur_addr = addr; 562 sc->sc_state = EC_STATE_READ; 563 564 for (i = 0; i < EC_POLL_TIMEOUT; ++i) { 565 acpiec_gpe_state_machine(dv); 566 if (sc->sc_state == EC_STATE_FREE) 567 goto done; 568 delay(1); 569 } 570 571 if (cold || acpiec_cold) { 572 while (sc->sc_state != EC_STATE_FREE && timeo-- > 0) { 573 delay(1000); 574 acpiec_gpe_state_machine(dv); 575 } 576 if (sc->sc_state != EC_STATE_FREE) { 577 mutex_exit(&sc->sc_mtx); 578 acpiec_unlock(dv); 579 aprint_error_dev(dv, "command timed out, state %d\n", 580 sc->sc_state); 581 return AE_ERROR; 582 } 583 } else if (cv_timedwait(&sc->sc_cv, &sc->sc_mtx, EC_CMD_TIMEOUT * hz)) { 584 mutex_exit(&sc->sc_mtx); 585 acpiec_unlock(dv); 586 aprint_error_dev(dv, "command takes over %d sec...\n", EC_CMD_TIMEOUT); 587 return AE_ERROR; 588 } 589 590 done: 591 *val = sc->sc_cur_val; 592 593 mutex_exit(&sc->sc_mtx); 594 acpiec_unlock(dv); 595 return AE_OK; 596 } 597 598 static ACPI_STATUS 599 acpiec_write(device_t dv, uint8_t addr, uint8_t val) 600 { 601 struct acpiec_softc *sc = device_private(dv); 602 int i, timeo = 1000 * EC_CMD_TIMEOUT; 603 604 acpiec_lock(dv); 605 mutex_enter(&sc->sc_mtx); 606 607 sc->sc_cur_addr = addr; 608 sc->sc_cur_val = val; 609 sc->sc_state = EC_STATE_WRITE; 610 611 for (i = 0; i < EC_POLL_TIMEOUT; ++i) { 612 acpiec_gpe_state_machine(dv); 613 if (sc->sc_state == EC_STATE_FREE) 614 goto done; 615 delay(1); 616 } 617 618 if (cold || acpiec_cold) { 619 while (sc->sc_state != EC_STATE_FREE && timeo-- > 0) { 620 delay(1000); 621 acpiec_gpe_state_machine(dv); 622 } 623 if (sc->sc_state != EC_STATE_FREE) { 624 mutex_exit(&sc->sc_mtx); 625 acpiec_unlock(dv); 626 aprint_error_dev(dv, "command timed out, state %d\n", 627 sc->sc_state); 628 return AE_ERROR; 629 } 630 } else if (cv_timedwait(&sc->sc_cv, &sc->sc_mtx, EC_CMD_TIMEOUT * hz)) { 631 mutex_exit(&sc->sc_mtx); 632 acpiec_unlock(dv); 633 aprint_error_dev(dv, "command takes over %d sec...\n", EC_CMD_TIMEOUT); 634 return AE_ERROR; 635 } 636 637 done: 638 mutex_exit(&sc->sc_mtx); 639 acpiec_unlock(dv); 640 return AE_OK; 641 } 642 643 static ACPI_STATUS 644 acpiec_space_handler(uint32_t func, ACPI_PHYSICAL_ADDRESS paddr, 645 uint32_t width, ACPI_INTEGER *value, void *arg, void *region_arg) 646 { 647 device_t dv; 648 ACPI_STATUS rv; 649 uint8_t addr, reg; 650 unsigned int i; 651 652 if (paddr > 0xff || width % 8 != 0 || value == NULL || arg == NULL || 653 paddr + width / 8 > 0x100) 654 return AE_BAD_PARAMETER; 655 656 addr = paddr; 657 dv = arg; 658 659 rv = AE_OK; 660 661 switch (func) { 662 case ACPI_READ: 663 *value = 0; 664 for (i = 0; i < width; i += 8, ++addr) { 665 rv = acpiec_read(dv, addr, ®); 666 if (rv != AE_OK) 667 break; 668 *value |= (ACPI_INTEGER)reg << i; 669 } 670 break; 671 case ACPI_WRITE: 672 for (i = 0; i < width; i += 8, ++addr) { 673 reg = (*value >>i) & 0xff; 674 rv = acpiec_write(dv, addr, reg); 675 if (rv != AE_OK) 676 break; 677 } 678 break; 679 default: 680 aprint_error("%s: invalid Address Space function called: %x\n", 681 device_xname(dv), (unsigned int)func); 682 return AE_BAD_PARAMETER; 683 } 684 685 return rv; 686 } 687 688 static void 689 acpiec_gpe_query(void *arg) 690 { 691 device_t dv = arg; 692 struct acpiec_softc *sc = device_private(dv); 693 uint8_t reg; 694 char qxx[5]; 695 ACPI_STATUS rv; 696 int i; 697 698 loop: 699 mutex_enter(&sc->sc_mtx); 700 701 if (sc->sc_got_sci == false) 702 cv_wait(&sc->sc_cv_sci, &sc->sc_mtx); 703 mutex_exit(&sc->sc_mtx); 704 705 acpiec_lock(dv); 706 mutex_enter(&sc->sc_mtx); 707 708 /* The Query command can always be issued, so be defensive here. */ 709 sc->sc_got_sci = false; 710 sc->sc_state = EC_STATE_QUERY; 711 712 for (i = 0; i < EC_POLL_TIMEOUT; ++i) { 713 acpiec_gpe_state_machine(dv); 714 if (sc->sc_state == EC_STATE_FREE) 715 goto done; 716 delay(1); 717 } 718 719 cv_wait(&sc->sc_cv, &sc->sc_mtx); 720 721 done: 722 reg = sc->sc_cur_val; 723 724 mutex_exit(&sc->sc_mtx); 725 acpiec_unlock(dv); 726 727 if (reg == 0) 728 goto loop; /* Spurious query result */ 729 730 /* 731 * Evaluate _Qxx to respond to the controller. 732 */ 733 snprintf(qxx, sizeof(qxx), "_Q%02X", (unsigned int)reg); 734 rv = AcpiEvaluateObject(sc->sc_ech, qxx, NULL, NULL); 735 if (rv != AE_OK && rv != AE_NOT_FOUND) { 736 aprint_error_dev(dv, "GPE query method %s failed: %s", 737 qxx, AcpiFormatException(rv)); 738 } 739 740 goto loop; 741 } 742 743 static void 744 acpiec_gpe_state_machine(device_t dv) 745 { 746 struct acpiec_softc *sc = device_private(dv); 747 uint8_t reg; 748 749 reg = acpiec_read_status(sc); 750 751 if (reg & EC_STATUS_SCI) 752 sc->sc_got_sci = true; 753 754 switch (sc->sc_state) { 755 case EC_STATE_QUERY: 756 if ((reg & EC_STATUS_IBF) != 0) 757 break; /* Nothing of interest here. */ 758 acpiec_write_command(sc, EC_COMMAND_QUERY); 759 sc->sc_state = EC_STATE_QUERY_VAL; 760 break; 761 762 case EC_STATE_QUERY_VAL: 763 if ((reg & EC_STATUS_OBF) == 0) 764 break; /* Nothing of interest here. */ 765 766 sc->sc_cur_val = acpiec_read_data(sc); 767 sc->sc_state = EC_STATE_FREE; 768 769 cv_signal(&sc->sc_cv); 770 break; 771 772 case EC_STATE_READ: 773 if ((reg & EC_STATUS_IBF) != 0) 774 break; /* Nothing of interest here. */ 775 776 acpiec_write_command(sc, EC_COMMAND_READ); 777 sc->sc_state = EC_STATE_READ_ADDR; 778 break; 779 780 case EC_STATE_READ_ADDR: 781 if ((reg & EC_STATUS_IBF) != 0) 782 break; /* Nothing of interest here. */ 783 784 acpiec_write_data(sc, sc->sc_cur_addr); 785 sc->sc_state = EC_STATE_READ_VAL; 786 break; 787 788 case EC_STATE_READ_VAL: 789 if ((reg & EC_STATUS_OBF) == 0) 790 break; /* Nothing of interest here. */ 791 sc->sc_cur_val = acpiec_read_data(sc); 792 sc->sc_state = EC_STATE_FREE; 793 794 cv_signal(&sc->sc_cv); 795 break; 796 797 case EC_STATE_WRITE: 798 if ((reg & EC_STATUS_IBF) != 0) 799 break; /* Nothing of interest here. */ 800 801 acpiec_write_command(sc, EC_COMMAND_WRITE); 802 sc->sc_state = EC_STATE_WRITE_ADDR; 803 break; 804 805 case EC_STATE_WRITE_ADDR: 806 if ((reg & EC_STATUS_IBF) != 0) 807 break; /* Nothing of interest here. */ 808 acpiec_write_data(sc, sc->sc_cur_addr); 809 sc->sc_state = EC_STATE_WRITE_VAL; 810 break; 811 812 case EC_STATE_WRITE_VAL: 813 if ((reg & EC_STATUS_IBF) != 0) 814 break; /* Nothing of interest here. */ 815 sc->sc_state = EC_STATE_FREE; 816 cv_signal(&sc->sc_cv); 817 818 acpiec_write_data(sc, sc->sc_cur_val); 819 break; 820 821 case EC_STATE_FREE: 822 if (sc->sc_got_sci) 823 cv_signal(&sc->sc_cv_sci); 824 break; 825 default: 826 panic("invalid state"); 827 } 828 829 if (sc->sc_state != EC_STATE_FREE) 830 callout_schedule(&sc->sc_pseudo_intr, 1); 831 } 832 833 static void 834 acpiec_callout(void *arg) 835 { 836 device_t dv = arg; 837 struct acpiec_softc *sc = device_private(dv); 838 839 mutex_enter(&sc->sc_mtx); 840 acpiec_gpe_state_machine(dv); 841 mutex_exit(&sc->sc_mtx); 842 } 843 844 static uint32_t 845 acpiec_gpe_handler(ACPI_HANDLE hdl, uint32_t gpebit, void *arg) 846 { 847 device_t dv = arg; 848 struct acpiec_softc *sc = device_private(dv); 849 850 mutex_enter(&sc->sc_mtx); 851 acpiec_gpe_state_machine(dv); 852 mutex_exit(&sc->sc_mtx); 853 854 return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE; 855 } 856 857 ACPI_STATUS 858 acpiec_bus_read(device_t dv, u_int addr, ACPI_INTEGER *val, int width) 859 { 860 return acpiec_space_handler(ACPI_READ, addr, width * 8, val, dv, NULL); 861 } 862 863 ACPI_STATUS 864 acpiec_bus_write(device_t dv, u_int addr, ACPI_INTEGER val, int width) 865 { 866 return acpiec_space_handler(ACPI_WRITE, addr, width * 8, &val, dv, NULL); 867 } 868 869 ACPI_HANDLE 870 acpiec_get_handle(device_t dv) 871 { 872 struct acpiec_softc *sc = device_private(dv); 873 874 return sc->sc_ech; 875 } 876
Indexes created Thu Oct 02 07:10:07 GMT 2025