acpi_ec.c revision 172313
1/*- 2 * Copyright (c) 2003-2007 Nate Lawson 3 * Copyright (c) 2000 Michael Smith 4 * Copyright (c) 2000 BSDi 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 * 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. 15 * 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 26 * SUCH DAMAGE. 27 */ 28 29#include <sys/cdefs.h> 30__FBSDID("$FreeBSD: head/sys/dev/acpica/acpi_ec.c 172313 2007-09-24 16:59:06Z njl $"); 31 32#include "opt_acpi.h" 33#include <sys/param.h> 34#include <sys/kernel.h> 35#include <sys/bus.h> 36#include <sys/lock.h> 37#include <sys/malloc.h> 38#include <sys/module.h> 39#include <sys/sx.h> 40 41#include <machine/bus.h> 42#include <machine/resource.h> 43#include <sys/rman.h> 44 45#include <contrib/dev/acpica/acpi.h> 46#include <dev/acpica/acpivar.h> 47 48/* Hooks for the ACPI CA debugging infrastructure */ 49#define _COMPONENT ACPI_EC 50ACPI_MODULE_NAME("EC") 51 52/* 53 * EC_COMMAND: 54 * ----------- 55 */ 56typedef UINT8 EC_COMMAND; 57 58#define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00) 59#define EC_COMMAND_READ ((EC_COMMAND) 0x80) 60#define EC_COMMAND_WRITE ((EC_COMMAND) 0x81) 61#define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82) 62#define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83) 63#define EC_COMMAND_QUERY ((EC_COMMAND) 0x84) 64 65/* 66 * EC_STATUS: 67 * ---------- 68 * The encoding of the EC status register is illustrated below. 69 * Note that a set bit (1) indicates the property is TRUE 70 * (e.g. if bit 0 is set then the output buffer is full). 71 * +-+-+-+-+-+-+-+-+ 72 * |7|6|5|4|3|2|1|0| 73 * +-+-+-+-+-+-+-+-+ 74 * | | | | | | | | 75 * | | | | | | | +- Output Buffer Full? 76 * | | | | | | +--- Input Buffer Full? 77 * | | | | | +----- <reserved> 78 * | | | | +------- Data Register is Command Byte? 79 * | | | +--------- Burst Mode Enabled? 80 * | | +----------- SCI Event? 81 * | +------------- SMI Event? 82 * +--------------- <reserved> 83 * 84 */ 85typedef UINT8 EC_STATUS; 86 87#define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01) 88#define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02) 89#define EC_FLAG_DATA_IS_CMD ((EC_STATUS) 0x08) 90#define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10) 91 92/* 93 * EC_EVENT: 94 * --------- 95 */ 96typedef UINT8 EC_EVENT; 97 98#define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00) 99#define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01) 100#define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02) 101#define EC_EVENT_SCI ((EC_EVENT) 0x20) 102#define EC_EVENT_SMI ((EC_EVENT) 0x40) 103 104/* Data byte returned after burst enable indicating it was successful. */ 105#define EC_BURST_ACK 0x90 106 107/* 108 * Register access primitives 109 */ 110#define EC_GET_DATA(sc) \ 111 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0) 112 113#define EC_SET_DATA(sc, v) \ 114 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v)) 115 116#define EC_GET_CSR(sc) \ 117 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0) 118 119#define EC_SET_CSR(sc, v) \ 120 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v)) 121 122/* Additional params to pass from the probe routine */ 123struct acpi_ec_params { 124 int glk; 125 int gpe_bit; 126 ACPI_HANDLE gpe_handle; 127 int uid; 128}; 129 130/* Indicate that this device has already been probed via ECDT. */ 131#define DEV_ECDT(x) (acpi_get_magic(x) == (uintptr_t)&acpi_ec_devclass) 132 133/* 134 * Driver softc. 135 */ 136struct acpi_ec_softc { 137 device_t ec_dev; 138 ACPI_HANDLE ec_handle; 139 int ec_uid; 140 ACPI_HANDLE ec_gpehandle; 141 UINT8 ec_gpebit; 142 143 int ec_data_rid; 144 struct resource *ec_data_res; 145 bus_space_tag_t ec_data_tag; 146 bus_space_handle_t ec_data_handle; 147 148 int ec_csr_rid; 149 struct resource *ec_csr_res; 150 bus_space_tag_t ec_csr_tag; 151 bus_space_handle_t ec_csr_handle; 152 153 int ec_glk; 154 int ec_glkhandle; 155 int ec_burstactive; 156 int ec_sci_pend; 157 u_int ec_gencount; 158}; 159 160/* 161 * XXX njl 162 * I couldn't find it in the spec but other implementations also use a 163 * value of 1 ms for the time to acquire global lock. 164 */ 165#define EC_LOCK_TIMEOUT 1000 166 167/* Default delay in microseconds between each run of the status polling loop. */ 168#define EC_POLL_DELAY 5 169 170/* Total time in ms spent waiting for a response from EC. */ 171#define EC_TIMEOUT 750 172 173#define EVENT_READY(event, status) \ 174 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \ 175 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \ 176 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \ 177 ((status) & EC_FLAG_INPUT_BUFFER) == 0)) 178 179ACPI_SERIAL_DECL(ec, "ACPI embedded controller"); 180 181SYSCTL_DECL(_debug_acpi); 182SYSCTL_NODE(_debug_acpi, OID_AUTO, ec, CTLFLAG_RD, NULL, "EC debugging"); 183 184static int ec_burst_mode; 185TUNABLE_INT("debug.acpi.ec.burst", &ec_burst_mode); 186SYSCTL_INT(_debug_acpi_ec, OID_AUTO, burst, CTLFLAG_RW, &ec_burst_mode, 0, 187 "Enable use of burst mode (faster for nearly all systems)"); 188static int ec_polled_mode; 189TUNABLE_INT("debug.acpi.ec.polled", &ec_polled_mode); 190SYSCTL_INT(_debug_acpi_ec, OID_AUTO, polled, CTLFLAG_RW, &ec_polled_mode, 0, 191 "Force use of polled mode (only if interrupt mode doesn't work)"); 192static int ec_timeout = EC_TIMEOUT; 193TUNABLE_INT("debug.acpi.ec.timeout", &ec_timeout); 194SYSCTL_INT(_debug_acpi_ec, OID_AUTO, timeout, CTLFLAG_RW, &ec_timeout, 195 EC_TIMEOUT, "Total time spent waiting for a response (poll+sleep)"); 196 197static ACPI_STATUS 198EcLock(struct acpi_ec_softc *sc) 199{ 200 ACPI_STATUS status; 201 202 /* If _GLK is non-zero, acquire the global lock. */ 203 status = AE_OK; 204 if (sc->ec_glk) { 205 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle); 206 if (ACPI_FAILURE(status)) 207 return (status); 208 } 209 ACPI_SERIAL_BEGIN(ec); 210 return (status); 211} 212 213static void 214EcUnlock(struct acpi_ec_softc *sc) 215{ 216 ACPI_SERIAL_END(ec); 217 if (sc->ec_glk) 218 AcpiReleaseGlobalLock(sc->ec_glkhandle); 219} 220 221static uint32_t EcGpeHandler(void *Context); 222static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, 223 void *Context, void **return_Context); 224static ACPI_STATUS EcSpaceHandler(UINT32 Function, 225 ACPI_PHYSICAL_ADDRESS Address, 226 UINT32 width, ACPI_INTEGER *Value, 227 void *Context, void *RegionContext); 228static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, 229 u_int gen_count); 230static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd); 231static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address, 232 UINT8 *Data); 233static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address, 234 UINT8 *Data); 235static int acpi_ec_probe(device_t dev); 236static int acpi_ec_attach(device_t dev); 237static int acpi_ec_shutdown(device_t dev); 238static int acpi_ec_read_method(device_t dev, u_int addr, 239 ACPI_INTEGER *val, int width); 240static int acpi_ec_write_method(device_t dev, u_int addr, 241 ACPI_INTEGER val, int width); 242 243static device_method_t acpi_ec_methods[] = { 244 /* Device interface */ 245 DEVMETHOD(device_probe, acpi_ec_probe), 246 DEVMETHOD(device_attach, acpi_ec_attach), 247 DEVMETHOD(device_shutdown, acpi_ec_shutdown), 248 249 /* Embedded controller interface */ 250 DEVMETHOD(acpi_ec_read, acpi_ec_read_method), 251 DEVMETHOD(acpi_ec_write, acpi_ec_write_method), 252 253 {0, 0} 254}; 255 256static driver_t acpi_ec_driver = { 257 "acpi_ec", 258 acpi_ec_methods, 259 sizeof(struct acpi_ec_softc), 260}; 261 262static devclass_t acpi_ec_devclass; 263DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0); 264MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1); 265 266/* 267 * Look for an ECDT and if we find one, set up default GPE and 268 * space handlers to catch attempts to access EC space before 269 * we have a real driver instance in place. 270 * 271 * TODO: Some old Gateway laptops need us to fake up an ECDT or 272 * otherwise attach early so that _REG methods can run. 273 */ 274void 275acpi_ec_ecdt_probe(device_t parent) 276{ 277 ACPI_TABLE_ECDT *ecdt; 278 ACPI_STATUS status; 279 device_t child; 280 ACPI_HANDLE h; 281 struct acpi_ec_params *params; 282 283 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 284 285 /* Find and validate the ECDT. */ 286 status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt); 287 if (ACPI_FAILURE(status) || 288 ecdt->Control.BitWidth != 8 || 289 ecdt->Data.BitWidth != 8) { 290 return; 291 } 292 293 /* Create the child device with the given unit number. */ 294 child = BUS_ADD_CHILD(parent, 0, "acpi_ec", ecdt->Uid); 295 if (child == NULL) { 296 printf("%s: can't add child\n", __func__); 297 return; 298 } 299 300 /* Find and save the ACPI handle for this device. */ 301 status = AcpiGetHandle(NULL, ecdt->Id, &h); 302 if (ACPI_FAILURE(status)) { 303 device_delete_child(parent, child); 304 printf("%s: can't get handle\n", __func__); 305 return; 306 } 307 acpi_set_handle(child, h); 308 309 /* Set the data and CSR register addresses. */ 310 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address, 311 /*count*/1); 312 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address, 313 /*count*/1); 314 315 /* 316 * Store values for the probe/attach routines to use. Store the 317 * ECDT GPE bit and set the global lock flag according to _GLK. 318 * Note that it is not perfectly correct to be evaluating a method 319 * before initializing devices, but in practice this function 320 * should be safe to call at this point. 321 */ 322 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO); 323 params->gpe_handle = NULL; 324 params->gpe_bit = ecdt->Gpe; 325 params->uid = ecdt->Uid; 326 acpi_GetInteger(h, "_GLK", ¶ms->glk); 327 acpi_set_private(child, params); 328 acpi_set_magic(child, (uintptr_t)&acpi_ec_devclass); 329 330 /* Finish the attach process. */ 331 if (device_probe_and_attach(child) != 0) 332 device_delete_child(parent, child); 333} 334 335static int 336acpi_ec_probe(device_t dev) 337{ 338 ACPI_BUFFER buf; 339 ACPI_HANDLE h; 340 ACPI_OBJECT *obj; 341 ACPI_STATUS status; 342 device_t peer; 343 char desc[64]; 344 int ret; 345 struct acpi_ec_params *params; 346 static char *ec_ids[] = { "PNP0C09", NULL }; 347 348 /* Check that this is a device and that EC is not disabled. */ 349 if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec")) 350 return (ENXIO); 351 352 /* 353 * If probed via ECDT, set description and continue. Otherwise, 354 * we can access the namespace and make sure this is not a 355 * duplicate probe. 356 */ 357 ret = ENXIO; 358 params = NULL; 359 buf.Pointer = NULL; 360 buf.Length = ACPI_ALLOCATE_BUFFER; 361 if (DEV_ECDT(dev)) { 362 params = acpi_get_private(dev); 363 ret = 0; 364 } else if (!acpi_disabled("ec") && 365 ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids)) { 366 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, 367 M_WAITOK | M_ZERO); 368 h = acpi_get_handle(dev); 369 370 /* 371 * Read the unit ID to check for duplicate attach and the 372 * global lock value to see if we should acquire it when 373 * accessing the EC. 374 */ 375 status = acpi_GetInteger(h, "_UID", ¶ms->uid); 376 if (ACPI_FAILURE(status)) 377 params->uid = 0; 378 status = acpi_GetInteger(h, "_GLK", ¶ms->glk); 379 if (ACPI_FAILURE(status)) 380 params->glk = 0; 381 382 /* 383 * Evaluate the _GPE method to find the GPE bit used by the EC to 384 * signal status (SCI). If it's a package, it contains a reference 385 * and GPE bit, similar to _PRW. 386 */ 387 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf); 388 if (ACPI_FAILURE(status)) { 389 device_printf(dev, "can't evaluate _GPE - %s\n", 390 AcpiFormatException(status)); 391 goto out; 392 } 393 obj = (ACPI_OBJECT *)buf.Pointer; 394 if (obj == NULL) 395 goto out; 396 397 switch (obj->Type) { 398 case ACPI_TYPE_INTEGER: 399 params->gpe_handle = NULL; 400 params->gpe_bit = obj->Integer.Value; 401 break; 402 case ACPI_TYPE_PACKAGE: 403 if (!ACPI_PKG_VALID(obj, 2)) 404 goto out; 405 params->gpe_handle = 406 acpi_GetReference(NULL, &obj->Package.Elements[0]); 407 if (params->gpe_handle == NULL || 408 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0) 409 goto out; 410 break; 411 default: 412 device_printf(dev, "_GPE has invalid type %d\n", obj->Type); 413 goto out; 414 } 415 416 /* Store the values we got from the namespace for attach. */ 417 acpi_set_private(dev, params); 418 419 /* 420 * Check for a duplicate probe. This can happen when a probe 421 * via ECDT succeeded already. If this is a duplicate, disable 422 * this device. 423 */ 424 peer = devclass_get_device(acpi_ec_devclass, params->uid); 425 if (peer == NULL || !device_is_alive(peer)) 426 ret = 0; 427 else 428 device_disable(dev); 429 } 430 431out: 432 if (ret == 0) { 433 snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s", 434 params->gpe_bit, (params->glk) ? ", GLK" : "", 435 DEV_ECDT(dev) ? ", ECDT" : ""); 436 device_set_desc_copy(dev, desc); 437 } 438 439 if (ret > 0 && params) 440 free(params, M_TEMP); 441 if (buf.Pointer) 442 AcpiOsFree(buf.Pointer); 443 return (ret); 444} 445 446static int 447acpi_ec_attach(device_t dev) 448{ 449 struct acpi_ec_softc *sc; 450 struct acpi_ec_params *params; 451 ACPI_STATUS Status; 452 453 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 454 455 /* Fetch/initialize softc (assumes softc is pre-zeroed). */ 456 sc = device_get_softc(dev); 457 params = acpi_get_private(dev); 458 sc->ec_dev = dev; 459 sc->ec_handle = acpi_get_handle(dev); 460 461 /* Retrieve previously probed values via device ivars. */ 462 sc->ec_glk = params->glk; 463 sc->ec_gpebit = params->gpe_bit; 464 sc->ec_gpehandle = params->gpe_handle; 465 sc->ec_uid = params->uid; 466 free(params, M_TEMP); 467 468 /* Attach bus resources for data and command/status ports. */ 469 sc->ec_data_rid = 0; 470 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT, 471 &sc->ec_data_rid, RF_ACTIVE); 472 if (sc->ec_data_res == NULL) { 473 device_printf(dev, "can't allocate data port\n"); 474 goto error; 475 } 476 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res); 477 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res); 478 479 sc->ec_csr_rid = 1; 480 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT, 481 &sc->ec_csr_rid, RF_ACTIVE); 482 if (sc->ec_csr_res == NULL) { 483 device_printf(dev, "can't allocate command/status port\n"); 484 goto error; 485 } 486 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res); 487 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res); 488 489 /* 490 * Install a handler for this EC's GPE bit. We want edge-triggered 491 * behavior. 492 */ 493 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n")); 494 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, 495 ACPI_GPE_EDGE_TRIGGERED, &EcGpeHandler, sc); 496 if (ACPI_FAILURE(Status)) { 497 device_printf(dev, "can't install GPE handler for %s - %s\n", 498 acpi_name(sc->ec_handle), AcpiFormatException(Status)); 499 goto error; 500 } 501 502 /* 503 * Install address space handler 504 */ 505 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n")); 506 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC, 507 &EcSpaceHandler, &EcSpaceSetup, sc); 508 if (ACPI_FAILURE(Status)) { 509 device_printf(dev, "can't install address space handler for %s - %s\n", 510 acpi_name(sc->ec_handle), AcpiFormatException(Status)); 511 goto error; 512 } 513 514 /* Enable runtime GPEs for the handler. */ 515 Status = AcpiSetGpeType(sc->ec_gpehandle, sc->ec_gpebit, 516 ACPI_GPE_TYPE_RUNTIME); 517 if (ACPI_FAILURE(Status)) { 518 device_printf(dev, "AcpiSetGpeType failed: %s\n", 519 AcpiFormatException(Status)); 520 goto error; 521 } 522 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR); 523 if (ACPI_FAILURE(Status)) { 524 device_printf(dev, "AcpiEnableGpe failed: %s\n", 525 AcpiFormatException(Status)); 526 goto error; 527 } 528 529 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n")); 530 return (0); 531 532error: 533 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, &EcGpeHandler); 534 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC, 535 EcSpaceHandler); 536 if (sc->ec_csr_res) 537 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid, 538 sc->ec_csr_res); 539 if (sc->ec_data_res) 540 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid, 541 sc->ec_data_res); 542 return (ENXIO); 543} 544 545static int 546acpi_ec_shutdown(device_t dev) 547{ 548 struct acpi_ec_softc *sc; 549 550 /* Disable the GPE so we don't get EC events during shutdown. */ 551 sc = device_get_softc(dev); 552 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit, ACPI_NOT_ISR); 553 return (0); 554} 555 556/* Methods to allow other devices (e.g., smbat) to read/write EC space. */ 557static int 558acpi_ec_read_method(device_t dev, u_int addr, ACPI_INTEGER *val, int width) 559{ 560 struct acpi_ec_softc *sc; 561 ACPI_STATUS status; 562 563 sc = device_get_softc(dev); 564 status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL); 565 if (ACPI_FAILURE(status)) 566 return (ENXIO); 567 return (0); 568} 569 570static int 571acpi_ec_write_method(device_t dev, u_int addr, ACPI_INTEGER val, int width) 572{ 573 struct acpi_ec_softc *sc; 574 ACPI_STATUS status; 575 576 sc = device_get_softc(dev); 577 status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL); 578 if (ACPI_FAILURE(status)) 579 return (ENXIO); 580 return (0); 581} 582 583static void 584EcGpeQueryHandler(void *Context) 585{ 586 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context; 587 UINT8 Data; 588 ACPI_STATUS Status; 589 char qxx[5]; 590 591 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 592 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL")); 593 594 /* Serialize user access with EcSpaceHandler(). */ 595 Status = EcLock(sc); 596 if (ACPI_FAILURE(Status)) { 597 device_printf(sc->ec_dev, "GpeQuery lock error: %s\n", 598 AcpiFormatException(Status)); 599 return; 600 } 601 602 /* 603 * Send a query command to the EC to find out which _Qxx call it 604 * wants to make. This command clears the SCI bit and also the 605 * interrupt source since we are edge-triggered. To prevent the GPE 606 * that may arise from running the query from causing another query 607 * to be queued, we clear the pending flag only after running it. 608 */ 609 Status = EcCommand(sc, EC_COMMAND_QUERY); 610 sc->ec_sci_pend = FALSE; 611 if (ACPI_FAILURE(Status)) { 612 EcUnlock(sc); 613 device_printf(sc->ec_dev, "GPE query failed: %s\n", 614 AcpiFormatException(Status)); 615 return; 616 } 617 Data = EC_GET_DATA(sc); 618 619 /* 620 * We have to unlock before running the _Qxx method below since that 621 * method may attempt to read/write from EC address space, causing 622 * recursive acquisition of the lock. 623 */ 624 EcUnlock(sc); 625 626 /* Ignore the value for "no outstanding event". (13.3.5) */ 627 CTR2(KTR_ACPI, "ec query ok,%s running _Q%02X", Data ? "" : " not", Data); 628 if (Data == 0) 629 return; 630 631 /* Evaluate _Qxx to respond to the controller. */ 632 snprintf(qxx, sizeof(qxx), "_Q%02X", Data); 633 AcpiUtStrupr(qxx); 634 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL); 635 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) { 636 device_printf(sc->ec_dev, "evaluation of query method %s failed: %s\n", 637 qxx, AcpiFormatException(Status)); 638 } 639} 640 641/* 642 * The GPE handler is called when IBE/OBF or SCI events occur. We are 643 * called from an unknown lock context. 644 */ 645static uint32_t 646EcGpeHandler(void *Context) 647{ 648 struct acpi_ec_softc *sc = Context; 649 ACPI_STATUS Status; 650 EC_STATUS EcStatus; 651 652 KASSERT(Context != NULL, ("EcGpeHandler called with NULL")); 653 CTR0(KTR_ACPI, "ec gpe handler start"); 654 655 /* 656 * Notify EcWaitEvent() that the status register is now fresh. If we 657 * didn't do this, it wouldn't be possible to distinguish an old IBE 658 * from a new one, for example when doing a write transaction (writing 659 * address and then data values.) 660 */ 661 atomic_add_int(&sc->ec_gencount, 1); 662 wakeup(&sc->ec_gencount); 663 664 /* 665 * If the EC_SCI bit of the status register is set, queue a query handler. 666 * It will run the query and _Qxx method later, under the lock. 667 */ 668 EcStatus = EC_GET_CSR(sc); 669 if ((EcStatus & EC_EVENT_SCI) && !sc->ec_sci_pend) { 670 CTR0(KTR_ACPI, "ec gpe queueing query handler"); 671 Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler, Context); 672 if (ACPI_SUCCESS(Status)) 673 sc->ec_sci_pend = TRUE; 674 else 675 printf("EcGpeHandler: queuing GPE query handler failed\n"); 676 } 677 return (0); 678} 679 680static ACPI_STATUS 681EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context, 682 void **RegionContext) 683{ 684 685 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 686 687 /* 688 * If deactivating a region, always set the output to NULL. Otherwise, 689 * just pass the context through. 690 */ 691 if (Function == ACPI_REGION_DEACTIVATE) 692 *RegionContext = NULL; 693 else 694 *RegionContext = Context; 695 696 return_ACPI_STATUS (AE_OK); 697} 698 699static ACPI_STATUS 700EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 701 ACPI_INTEGER *Value, void *Context, void *RegionContext) 702{ 703 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context; 704 ACPI_STATUS Status; 705 UINT8 EcAddr, EcData; 706 int i; 707 708 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address); 709 710 if (width % 8 != 0 || Value == NULL || Context == NULL) 711 return_ACPI_STATUS (AE_BAD_PARAMETER); 712 if (Address + (width / 8) - 1 > 0xFF) 713 return_ACPI_STATUS (AE_BAD_ADDRESS); 714 715 if (Function == ACPI_READ) 716 *Value = 0; 717 EcAddr = Address; 718 Status = AE_ERROR; 719 720 /* 721 * If booting, check if we need to run the query handler. If so, we 722 * we call it directly here since our thread taskq is not active yet. 723 */ 724 if (cold || rebooting) { 725 if ((EC_GET_CSR(sc) & EC_EVENT_SCI)) { 726 CTR0(KTR_ACPI, "ec running gpe handler directly"); 727 EcGpeQueryHandler(sc); 728 } 729 } 730 731 /* Serialize with EcGpeQueryHandler() at transaction granularity. */ 732 Status = EcLock(sc); 733 if (ACPI_FAILURE(Status)) 734 return_ACPI_STATUS (Status); 735 736 /* Perform the transaction(s), based on width. */ 737 for (i = 0; i < width; i += 8, EcAddr++) { 738 switch (Function) { 739 case ACPI_READ: 740 Status = EcRead(sc, EcAddr, &EcData); 741 if (ACPI_SUCCESS(Status)) 742 *Value |= ((ACPI_INTEGER)EcData) << i; 743 break; 744 case ACPI_WRITE: 745 EcData = (UINT8)((*Value) >> i); 746 Status = EcWrite(sc, EcAddr, &EcData); 747 break; 748 default: 749 device_printf(sc->ec_dev, "invalid EcSpaceHandler function %d\n", 750 Function); 751 Status = AE_BAD_PARAMETER; 752 break; 753 } 754 if (ACPI_FAILURE(Status)) 755 break; 756 } 757 758 EcUnlock(sc); 759 return_ACPI_STATUS (Status); 760} 761 762static ACPI_STATUS 763EcCheckStatus(struct acpi_ec_softc *sc, const char *msg, EC_EVENT event) 764{ 765 ACPI_STATUS status; 766 EC_STATUS ec_status; 767 768 status = AE_NO_HARDWARE_RESPONSE; 769 ec_status = EC_GET_CSR(sc); 770 if (sc->ec_burstactive && !(ec_status & EC_FLAG_BURST_MODE)) { 771 CTR1(KTR_ACPI, "ec burst disabled in waitevent (%s)", msg); 772 sc->ec_burstactive = FALSE; 773 } 774 if (EVENT_READY(event, ec_status)) { 775 CTR2(KTR_ACPI, "ec %s wait ready, status %#x", msg, ec_status); 776 status = AE_OK; 777 } 778 return (status); 779} 780 781static ACPI_STATUS 782EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, u_int gen_count) 783{ 784 ACPI_STATUS Status; 785 int count, i, slp_ival; 786 787 ACPI_SERIAL_ASSERT(ec); 788 Status = AE_NO_HARDWARE_RESPONSE; 789 790 /* 791 * The main CPU should be much faster than the EC. So the status should 792 * be "not ready" when we start waiting. But if the main CPU is really 793 * slow, it's possible we see the current "ready" response. Since that 794 * can't be distinguished from the previous response in polled mode, 795 * this is a potential issue. We really should have interrupts enabled 796 * during boot so there is no ambiguity in polled mode. 797 * 798 * If this occurs, we add an additional delay before actually entering 799 * the status checking loop, hopefully to allow the EC to go to work 800 * and produce a non-stale status. 801 */ 802 if (cold || rebooting || ec_polled_mode) { 803 static int once; 804 805 if (EcCheckStatus(sc, "pre-check", Event) == AE_OK) { 806 if (!once) { 807 device_printf(sc->ec_dev, 808 "warning: EC done before starting event wait\n"); 809 once = 1; 810 } 811 AcpiOsStall(10); 812 } 813 } 814 815 /* Wait for event by polling or GPE (interrupt). */ 816 if (cold || rebooting || ec_polled_mode) { 817 count = (ec_timeout * 1000) / EC_POLL_DELAY; 818 if (count == 0) 819 count = 1; 820 for (i = 0; i < count; i++) { 821 Status = EcCheckStatus(sc, "poll", Event); 822 if (Status == AE_OK) 823 break; 824 AcpiOsStall(EC_POLL_DELAY); 825 } 826 } else { 827 slp_ival = hz / 1000; 828 if (slp_ival != 0) { 829 count = ec_timeout; 830 } else { 831 /* hz has less than 1 ms resolution so scale timeout. */ 832 slp_ival = 1; 833 count = ec_timeout / (1000 / hz); 834 } 835 836 /* 837 * Wait for the GPE to signal the status changed, checking the 838 * status register each time we get one. It's possible to get a 839 * GPE for an event we're not interested in here (i.e., SCI for 840 * EC query). 841 */ 842 for (i = 0; i < count; i++) { 843 if (gen_count != sc->ec_gencount) { 844 /* 845 * Record new generation count. It's possible the GPE was 846 * just to notify us that a query is needed and we need to 847 * wait for a second GPE to signal the completion of the 848 * event we are actually waiting for. 849 */ 850 gen_count = sc->ec_gencount; 851 Status = EcCheckStatus(sc, "sleep", Event); 852 if (Status == AE_OK) 853 break; 854 } 855 tsleep(&sc->ec_gencount, PZERO, "ecgpe", slp_ival); 856 } 857 858 /* 859 * We finished waiting for the GPE and it never arrived. Try to 860 * read the register once and trust whatever value we got. This is 861 * the best we can do at this point. Then, force polled mode on 862 * since this system doesn't appear to generate GPEs. 863 */ 864 if (Status != AE_OK) { 865 Status = EcCheckStatus(sc, "sleep_end", Event); 866 device_printf(sc->ec_dev, 867 "wait timed out (%sresponse), forcing polled mode\n", 868 Status == AE_OK ? "" : "no "); 869 ec_polled_mode = TRUE; 870 } 871 } 872 if (Status != AE_OK) 873 CTR0(KTR_ACPI, "error: ec wait timed out"); 874 return (Status); 875} 876 877static ACPI_STATUS 878EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd) 879{ 880 ACPI_STATUS status; 881 EC_EVENT event; 882 EC_STATUS ec_status; 883 u_int gen_count; 884 885 ACPI_SERIAL_ASSERT(ec); 886 887 /* Don't use burst mode if user disabled it. */ 888 if (!ec_burst_mode && cmd == EC_COMMAND_BURST_ENABLE) 889 return (AE_ERROR); 890 891 /* Decide what to wait for based on command type. */ 892 switch (cmd) { 893 case EC_COMMAND_READ: 894 case EC_COMMAND_WRITE: 895 case EC_COMMAND_BURST_DISABLE: 896 event = EC_EVENT_INPUT_BUFFER_EMPTY; 897 break; 898 case EC_COMMAND_QUERY: 899 case EC_COMMAND_BURST_ENABLE: 900 event = EC_EVENT_OUTPUT_BUFFER_FULL; 901 break; 902 default: 903 device_printf(sc->ec_dev, "EcCommand: invalid command %#x\n", cmd); 904 return (AE_BAD_PARAMETER); 905 } 906 907 /* Run the command and wait for the chosen event. */ 908 CTR1(KTR_ACPI, "ec running command %#x", cmd); 909 gen_count = sc->ec_gencount; 910 EC_SET_CSR(sc, cmd); 911 status = EcWaitEvent(sc, event, gen_count); 912 if (ACPI_SUCCESS(status)) { 913 /* If we succeeded, burst flag should now be present. */ 914 if (cmd == EC_COMMAND_BURST_ENABLE) { 915 ec_status = EC_GET_CSR(sc); 916 if ((ec_status & EC_FLAG_BURST_MODE) == 0) 917 status = AE_ERROR; 918 } 919 } else 920 device_printf(sc->ec_dev, "EcCommand: no response to %#x\n", cmd); 921 return (status); 922} 923 924static ACPI_STATUS 925EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 926{ 927 ACPI_STATUS status; 928 UINT8 data; 929 u_int gen_count; 930 931 ACPI_SERIAL_ASSERT(ec); 932 CTR1(KTR_ACPI, "ec read from %#x", Address); 933 934 /* If we can't start burst mode, continue anyway. */ 935 status = EcCommand(sc, EC_COMMAND_BURST_ENABLE); 936 if (status == AE_OK) { 937 data = EC_GET_DATA(sc); 938 if (data == EC_BURST_ACK) { 939 CTR0(KTR_ACPI, "ec burst enabled"); 940 sc->ec_burstactive = TRUE; 941 } 942 } 943 944 status = EcCommand(sc, EC_COMMAND_READ); 945 if (ACPI_FAILURE(status)) 946 return (status); 947 948 gen_count = sc->ec_gencount; 949 EC_SET_DATA(sc, Address); 950 status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL, gen_count); 951 if (ACPI_FAILURE(status)) { 952 device_printf(sc->ec_dev, "EcRead: failed waiting to get data\n"); 953 return (status); 954 } 955 *Data = EC_GET_DATA(sc); 956 957 if (sc->ec_burstactive) { 958 sc->ec_burstactive = FALSE; 959 status = EcCommand(sc, EC_COMMAND_BURST_DISABLE); 960 if (ACPI_FAILURE(status)) 961 return (status); 962 CTR0(KTR_ACPI, "ec disabled burst ok"); 963 } 964 965 return (AE_OK); 966} 967 968static ACPI_STATUS 969EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 970{ 971 ACPI_STATUS status; 972 UINT8 data; 973 u_int gen_count; 974 975 ACPI_SERIAL_ASSERT(ec); 976 CTR2(KTR_ACPI, "ec write to %#x, data %#x", Address, *Data); 977 978 /* If we can't start burst mode, continue anyway. */ 979 status = EcCommand(sc, EC_COMMAND_BURST_ENABLE); 980 if (status == AE_OK) { 981 data = EC_GET_DATA(sc); 982 if (data == EC_BURST_ACK) { 983 CTR0(KTR_ACPI, "ec burst enabled"); 984 sc->ec_burstactive = TRUE; 985 } 986 } 987 988 status = EcCommand(sc, EC_COMMAND_WRITE); 989 if (ACPI_FAILURE(status)) 990 return (status); 991 992 gen_count = sc->ec_gencount; 993 EC_SET_DATA(sc, Address); 994 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count); 995 if (ACPI_FAILURE(status)) { 996 device_printf(sc->ec_dev, "EcRead: failed waiting for sent address\n"); 997 return (status); 998 } 999 1000 gen_count = sc->ec_gencount; 1001 EC_SET_DATA(sc, *Data); 1002 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count); 1003 if (ACPI_FAILURE(status)) { 1004 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent data\n"); 1005 return (status); 1006 } 1007 1008 if (sc->ec_burstactive) { 1009 sc->ec_burstactive = FALSE; 1010 status = EcCommand(sc, EC_COMMAND_BURST_DISABLE); 1011 if (ACPI_FAILURE(status)) 1012 return (status); 1013 CTR0(KTR_ACPI, "ec disabled burst ok"); 1014 } 1015 1016 return (AE_OK); 1017} 1018