1 /* $NetBSD: acpi_ec.c,v 1.4 2002/06/15 18:03:41 thorpej Exp $ */ 2 3 /* 4 * Copyright 2001 Wasabi Systems, Inc. 5 * All rights reserved. 6 * 7 * Written by Jason R. Thorpe for Wasabi Systems, Inc. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed for the NetBSD Project by 20 * Wasabi Systems, Inc. 21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse 22 * or promote products derived from this software without specific prior 23 * written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC 29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35 * POSSIBILITY OF SUCH DAMAGE. 36 */ 37 38 /*- 39 * Copyright (c) 2000 Michael Smith 40 * Copyright (c) 2000 BSDi 41 * All rights reserved. 42 * 43 * Redistribution and use in source and binary forms, with or without 44 * modification, are permitted provided that the following conditions 45 * are met: 46 * 1. Redistributions of source code must retain the above copyright 47 * notice, this list of conditions and the following disclaimer. 48 * 2. Redistributions in binary form must reproduce the above copyright 49 * notice, this list of conditions and the following disclaimer in the 50 * documentation and/or other materials provided with the distribution. 51 * 52 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 53 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 54 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 55 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 56 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 57 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 58 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 59 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 60 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 61 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 62 * SUCH DAMAGE. 63 */ 64 65 /****************************************************************************** 66 * 67 * 1. Copyright Notice 68 * 69 * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 70 * reserved. 71 * 72 * 2. License 73 * 74 * 2.1. This is your license from Intel Corp. under its intellectual property 75 * rights. You may have additional license terms from the party that provided 76 * you this software, covering your right to use that party's intellectual 77 * property rights. 78 * 79 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 80 * copy of the source code appearing in this file ("Covered Code") an 81 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 82 * base code distributed originally by Intel ("Original Intel Code") to copy, 83 * make derivatives, distribute, use and display any portion of the Covered 84 * Code in any form, with the right to sublicense such rights; and 85 * 86 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 87 * license (with the right to sublicense), under only those claims of Intel 88 * patents that are infringed by the Original Intel Code, to make, use, sell, 89 * offer to sell, and import the Covered Code and derivative works thereof 90 * solely to the minimum extent necessary to exercise the above copyright 91 * license, and in no event shall the patent license extend to any additions 92 * to or modifications of the Original Intel Code. No other license or right 93 * is granted directly or by implication, estoppel or otherwise; 94 * 95 * The above copyright and patent license is granted only if the following 96 * conditions are met: 97 * 98 * 3. Conditions 99 * 100 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 101 * Redistribution of source code of any substantial portion of the Covered 102 * Code or modification with rights to further distribute source must include 103 * the above Copyright Notice, the above License, this list of Conditions, 104 * and the following Disclaimer and Export Compliance provision. In addition, 105 * Licensee must cause all Covered Code to which Licensee contributes to 106 * contain a file documenting the changes Licensee made to create that Covered 107 * Code and the date of any change. Licensee must include in that file the 108 * documentation of any changes made by any predecessor Licensee. Licensee 109 * must include a prominent statement that the modification is derived, 110 * directly or indirectly, from Original Intel Code. 111 * 112 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 113 * Redistribution of source code of any substantial portion of the Covered 114 * Code or modification without rights to further distribute source must 115 * include the following Disclaimer and Export Compliance provision in the 116 * documentation and/or other materials provided with distribution. In 117 * addition, Licensee may not authorize further sublicense of source of any 118 * portion of the Covered Code, and must include terms to the effect that the 119 * license from Licensee to its licensee is limited to the intellectual 120 * property embodied in the software Licensee provides to its licensee, and 121 * not to intellectual property embodied in modifications its licensee may 122 * make. 123 * 124 * 3.3. Redistribution of Executable. Redistribution in executable form of any 125 * substantial portion of the Covered Code or modification must reproduce the 126 * above Copyright Notice, and the following Disclaimer and Export Compliance 127 * provision in the documentation and/or other materials provided with the 128 * distribution. 129 * 130 * 3.4. Intel retains all right, title, and interest in and to the Original 131 * Intel Code. 132 * 133 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 134 * Intel shall be used in advertising or otherwise to promote the sale, use or 135 * other dealings in products derived from or relating to the Covered Code 136 * without prior written authorization from Intel. 137 * 138 * 4. Disclaimer and Export Compliance 139 * 140 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 141 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 142 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 143 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 144 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 145 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 146 * PARTICULAR PURPOSE. 147 * 148 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 149 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 150 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 151 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 152 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 153 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 154 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 155 * LIMITED REMEDY. 156 * 157 * 4.3. Licensee shall not export, either directly or indirectly, any of this 158 * software or system incorporating such software without first obtaining any 159 * required license or other approval from the U. S. Department of Commerce or 160 * any other agency or department of the United States Government. In the 161 * event Licensee exports any such software from the United States or 162 * re-exports any such software from a foreign destination, Licensee shall 163 * ensure that the distribution and export/re-export of the software is in 164 * compliance with all laws, regulations, orders, or other restrictions of the 165 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 166 * any of its subsidiaries will export/re-export any technical data, process, 167 * software, or service, directly or indirectly, to any country for which the 168 * United States government or any agency thereof requires an export license, 169 * other governmental approval, or letter of assurance, without first obtaining 170 * such license, approval or letter. 171 * 172 *****************************************************************************/ 173 174 #include <sys/cdefs.h> 175 __KERNEL_RCSID(0, "$NetBSD: acpi_ec.c,v 1.4 2002/06/15 18:03:41 thorpej Exp $"); 176 177 #include <sys/param.h> 178 #include <sys/systm.h> 179 #include <sys/device.h> 180 #include <sys/proc.h> 181 #include <sys/kernel.h> 182 183 #include <machine/bus.h> 184 185 #include <dev/acpi/acpica.h> 186 #include <dev/acpi/acpireg.h> 187 #include <dev/acpi/acpivar.h> 188 #include <dev/acpi/acpi_ecreg.h> 189 190 #define _COMPONENT ACPI_EC_COMPONENT 191 ACPI_MODULE_NAME("EC") 192 193 struct acpi_ec_softc { 194 struct device sc_dev; /* base device glue */ 195 struct acpi_devnode *sc_node; /* our ACPI devnode */ 196 197 struct acpi_resources sc_res; /* our bus resources */ 198 199 UINT32 sc_gpebit; /* our GPE interrupt bit */ 200 201 bus_space_tag_t sc_data_st; /* space tag for data register */ 202 bus_space_handle_t sc_data_sh; /* space handle for data register */ 203 204 bus_space_tag_t sc_csr_st; /* space tag for control register */ 205 bus_space_handle_t sc_csr_sh; /* space handle for control register */ 206 207 int sc_flags; /* see below */ 208 209 uint32_t sc_csrvalue; /* saved control register */ 210 }; 211 212 #define EC_F_LOCKED 0x01 /* EC is locked */ 213 #define EC_F_PENDQUERY 0x02 /* query is pending */ 214 215 #define EC_LOCK_TIMEOUT 1000 /* 1ms */ 216 217 #define EC_DATA_READ(sc) \ 218 bus_space_read_1((sc)->sc_data_st, (sc)->sc_data_sh, 0) 219 #define EC_DATA_WRITE(sc, v) \ 220 bus_space_write_1((sc)->sc_data_st, (sc)->sc_data_sh, 0, (v)) 221 222 #define EC_CSR_READ(sc) \ 223 bus_space_read_1((sc)->sc_csr_st, (sc)->sc_csr_sh, 0) 224 #define EC_CSR_WRITE(sc, v) \ 225 bus_space_write_1((sc)->sc_csr_st, (sc)->sc_csr_sh, 0, (v)) 226 227 static UINT32 glk; /* XXX XXX XXX */ 228 229 static __inline ACPI_STATUS 230 EcLock(struct acpi_ec_softc *sc) 231 { 232 ACPI_STATUS status; 233 234 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &glk); 235 if (status == AE_OK) 236 (sc)->sc_flags |= EC_F_LOCKED; 237 return (status); 238 } 239 240 static __inline void 241 EcUnlock(struct acpi_ec_softc *sc) 242 { 243 244 (sc)->sc_flags &= ~EC_F_LOCKED; 245 AcpiReleaseGlobalLock(glk); 246 } 247 248 static __inline int 249 EcIsLocked(struct acpi_ec_softc *sc) 250 { 251 252 return (((sc)->sc_flags & EC_F_LOCKED) != 0); 253 } 254 255 typedef struct { 256 EC_COMMAND Command; 257 UINT8 Address; 258 UINT8 Data; 259 } EC_REQUEST; 260 261 static void EcGpeHandler(void *Context); 262 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, 263 void *Context, void **return_Context); 264 static ACPI_STATUS EcSpaceHandler(UINT32 Function, 265 ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 266 ACPI_INTEGER *Value, void *Context, 267 void *RegionContext); 268 269 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event); 270 static ACPI_STATUS EcQuery(struct acpi_ec_softc *sc, UINT8 *Data); 271 static ACPI_STATUS EcTransaction(struct acpi_ec_softc *sc, 272 EC_REQUEST *EcRequest); 273 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address, 274 UINT8 *Data); 275 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address, 276 UINT8 *Data); 277 278 int acpiec_match(struct device *, struct cfdata *, void *); 279 void acpiec_attach(struct device *, struct device *, void *); 280 281 struct cfattach acpiec_ca = { 282 sizeof(struct acpi_ec_softc), acpiec_match, acpiec_attach, 283 }; 284 285 /* 286 * acpiec_match: 287 * 288 * Autoconfiguration `match' routine. 289 */ 290 int 291 acpiec_match(struct device *parent, struct cfdata *match, void *aux) 292 { 293 struct acpi_attach_args *aa = aux; 294 295 if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE) 296 return (0); 297 298 if (strcmp(aa->aa_node->ad_devinfo.HardwareId, "PNP0C09") == 0) 299 return (1); 300 301 return (0); 302 } 303 304 /* 305 * acpiec_attach: 306 * 307 * Autoconfiguration `attach' routine. 308 */ 309 void 310 acpiec_attach(struct device *parent, struct device *self, void *aux) 311 { 312 struct acpi_ec_softc *sc = (void *) self; 313 struct acpi_attach_args *aa = aux; 314 struct acpi_io *io0, *io1; 315 ACPI_STATUS rv; 316 317 ACPI_FUNCTION_TRACE(__FUNCTION__); 318 319 printf(": ACPI Embedded Controller\n"); 320 321 sc->sc_node = aa->aa_node; 322 323 /* Parse our resources. */ 324 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "parsing EC resources\n")); 325 rv = acpi_resource_parse(&sc->sc_dev, sc->sc_node, &sc->sc_res, 326 &acpi_resource_parse_ops_default); 327 if (rv != AE_OK) { 328 printf("%s: unable to parse resources: %d\n", 329 sc->sc_dev.dv_xname, rv); 330 return; 331 } 332 333 sc->sc_data_st = aa->aa_iot; 334 io0 = acpi_res_io(&sc->sc_res, 0); 335 if (io0 == NULL) { 336 printf("%s: unable to find data register resource\n", 337 sc->sc_dev.dv_xname); 338 return; 339 } 340 if (bus_space_map(sc->sc_data_st, io0->ar_base, io0->ar_length, 341 0, &sc->sc_data_sh) != 0) { 342 printf("%s: unable to map data register\n", 343 sc->sc_dev.dv_xname); 344 return; 345 } 346 347 sc->sc_csr_st = aa->aa_iot; 348 io1 = acpi_res_io(&sc->sc_res, 1); 349 if (io1 == NULL) { 350 printf("%s: unable to find csr register resource\n", 351 sc->sc_dev.dv_xname); 352 return; 353 } 354 if (bus_space_map(sc->sc_csr_st, io1->ar_base, io1->ar_length, 355 0, &sc->sc_csr_sh) != 0) { 356 printf("%s: unable to map csr register\n", 357 sc->sc_dev.dv_xname); 358 return; 359 } 360 361 /* 362 * Install GPE handler. 363 * 364 * We evaluate the _GPE method to find the GPE bit used by the 365 * Embedded Controller to signal status (SCI). 366 */ 367 if ((rv = acpi_eval_integer(sc->sc_node->ad_handle, "_GPE", 368 &sc->sc_gpebit)) != AE_OK) { 369 printf("%s: unable to evaluate _GPE: %d\n", 370 sc->sc_dev.dv_xname, rv); 371 return; 372 } 373 374 /* 375 * Install a handler for this EC's GPE bit. Note that EC SCIs are 376 * treated as both edge- and level-triggered interrupts; in other words 377 * we clear the status bit immediately after getting an EC-SCI, then 378 * again after we're done processing the event. This guarantees that 379 * events we cause while performing a transaction (e.g. IBE/OBF) get 380 * cleared before re-enabling the GPE. 381 */ 382 if ((rv = AcpiInstallGpeHandler(sc->sc_gpebit, 383 ACPI_EVENT_LEVEL_TRIGGERED | ACPI_EVENT_EDGE_TRIGGERED, 384 EcGpeHandler, sc)) != AE_OK) { 385 printf("%s: unable to install GPE handler: %d\n", 386 sc->sc_dev.dv_xname, rv); 387 return; 388 } 389 390 /* Install address space handler. */ 391 if ((rv = AcpiInstallAddressSpaceHandler(sc->sc_node->ad_handle, 392 ACPI_ADR_SPACE_EC, EcSpaceHandler, EcSpaceSetup, sc)) != AE_OK) { 393 printf("%s: unable to install address space handler: %d\n", 394 sc->sc_dev.dv_xname, rv); 395 return; 396 } 397 398 return_VOID; 399 } 400 401 static void 402 EcGpeQueryHandler(void *Context) 403 { 404 struct acpi_ec_softc *sc = Context; 405 UINT8 Data; 406 ACPI_STATUS Status; 407 char qxx[5]; 408 409 ACPI_FUNCTION_TRACE(__FUNCTION__); 410 411 for (;;) { 412 /* 413 * Check EC_SCI. 414 * 415 * Bail out if the EC_SCI bit of the status register is not 416 * set. Note that this function should only be called when 417 * this bit is set (polling is used to detect IBE/OBF events). 418 * 419 * It is safe to do this without locking the controller, as 420 * it's OK to call EcQuery when there's no data ready; in the 421 * worst case we should just find nothing waiting for us and 422 * bail. 423 */ 424 if ((EC_CSR_READ(sc) & EC_EVENT_SCI) == 0) 425 break; 426 427 /* 428 * Find out why the EC is signalling us 429 */ 430 Status = EcQuery(sc, &Data); 431 432 /* 433 * If we failed to get anything from the EC, give up. 434 */ 435 if (Status != AE_OK) { 436 printf("%s: GPE query failed: %d\n", 437 sc->sc_dev.dv_xname, Status); 438 break; 439 } 440 441 /* 442 * Evaluate _Qxx to respond to the controller. 443 */ 444 sprintf(qxx, "_Q%02x", Data); 445 strupr(qxx); 446 Status = AcpiEvaluateObject(sc->sc_node->ad_handle, qxx, 447 NULL, NULL); 448 449 /* 450 * Ignore spurious query requests. 451 */ 452 if (Status != AE_OK && 453 (Data != 0 || Status != AE_NOT_FOUND)) { 454 printf("%s: evaluation of GPE query method %s " 455 "failed: %d\n", sc->sc_dev.dv_xname, qxx, Status); 456 } 457 } 458 459 /* I know I request Level trigger cleanup */ 460 if (AcpiClearEvent(sc->sc_gpebit, ACPI_EVENT_GPE) != AE_OK) 461 printf("%s: AcpiClearEvent failed\n", sc->sc_dev.dv_xname); 462 if (AcpiEnableEvent(sc->sc_gpebit, ACPI_EVENT_GPE, 0) != AE_OK) 463 printf("%s: AcpiEnableEvent failed\n", sc->sc_dev.dv_xname); 464 465 return_VOID; 466 } 467 468 static void 469 EcGpeHandler(void *Context) 470 { 471 struct acpi_ec_softc *sc = Context; 472 uint32_t csrvalue; 473 474 /* 475 * If EC is locked, the intr must process EcRead/Write wait only. 476 * Query request must be pending. 477 */ 478 if (EcIsLocked(sc)) { 479 csrvalue = EC_CSR_READ(sc); 480 if (csrvalue & EC_EVENT_SCI) 481 sc->sc_flags |= EC_F_PENDQUERY; 482 483 if ((csrvalue & EC_FLAG_OUTPUT_BUFFER) != 0 || 484 (csrvalue & EC_FLAG_INPUT_BUFFER) == 0) { 485 sc->sc_csrvalue = csrvalue; 486 wakeup(&sc->sc_csrvalue); 487 } 488 } else { 489 /* Enqueue GpeQuery handler. */ 490 if (AcpiOsQueueForExecution(OSD_PRIORITY_HIGH, 491 EcGpeQueryHandler, Context) != AE_OK) { 492 printf("%s: failed to enqueue query handler\n", 493 sc->sc_dev.dv_xname); 494 } 495 } 496 } 497 498 static ACPI_STATUS 499 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context, 500 void **RegionContext) 501 { 502 503 ACPI_FUNCTION_TRACE(__FUNCTION__); 504 505 /* 506 * Just pass the context through, there's nothing to do here. 507 */ 508 *RegionContext = Context; 509 510 return_ACPI_STATUS(AE_OK); 511 } 512 513 static ACPI_STATUS 514 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 515 ACPI_INTEGER *Value, void *Context, void *RegionContext) 516 { 517 struct acpi_ec_softc *sc = Context; 518 ACPI_STATUS Status = AE_OK; 519 EC_REQUEST EcRequest; 520 int i; 521 522 ACPI_FUNCTION_TRACE_U32(__FUNCTION__, (UINT32)Address); 523 524 if ((Address > 0xFF) || (width % 8 != 0) || (Value == NULL) || 525 (Context == NULL)) 526 return_ACPI_STATUS(AE_BAD_PARAMETER); 527 528 switch (Function) { 529 case ACPI_READ: 530 EcRequest.Command = EC_COMMAND_READ; 531 EcRequest.Address = Address; 532 (*Value) = 0; 533 break; 534 535 case ACPI_WRITE: 536 EcRequest.Command = EC_COMMAND_WRITE; 537 EcRequest.Address = Address; 538 break; 539 540 default: 541 printf("%s: invalid Address Space function: %d\n", 542 sc->sc_dev.dv_xname, Function); 543 return_ACPI_STATUS(AE_BAD_PARAMETER); 544 } 545 546 /* 547 * Perform the transaction. 548 */ 549 (*Value) = 0; 550 for (i = 0; i < width; i += 8) { 551 if (Function == ACPI_READ) 552 EcRequest.Data = 0; 553 else 554 EcRequest.Data = (UINT8)((*Value) >> i); 555 556 if ((Status = EcTransaction(sc, &EcRequest)) != AE_OK) 557 break; 558 559 (*Value) |= (UINT32)EcRequest.Data << i; 560 if (++EcRequest.Address == 0) 561 return_ACPI_STATUS(AE_BAD_PARAMETER); 562 } 563 564 return_ACPI_STATUS(Status); 565 } 566 567 static ACPI_STATUS 568 EcWaitEventIntr(struct acpi_ec_softc *sc, EC_EVENT Event) 569 { 570 EC_STATUS EcStatus; 571 int i; 572 573 ACPI_FUNCTION_TRACE_U32(__FUNCTION__, (UINT32)Event); 574 575 /* XXX Need better test for "yes, you have interrupts". */ 576 if (cold) 577 return_ACPI_STATUS(EcWaitEvent(sc, Event)); 578 579 if (EcIsLocked(sc) == 0) 580 printf("%s: EcWaitEventIntr called without EC lock!\n", 581 sc->sc_dev.dv_xname); 582 583 EcStatus = EC_CSR_READ(sc); 584 585 /* Too long? */ 586 for (i = 0; i < 10; i++) { 587 /* Check EC status against the desired event. */ 588 if ((Event == EC_EVENT_OUTPUT_BUFFER_FULL) && 589 (EcStatus & EC_FLAG_OUTPUT_BUFFER) != 0) 590 return_ACPI_STATUS(AE_OK); 591 592 if ((Event == EC_EVENT_INPUT_BUFFER_EMPTY) && 593 (EcStatus & EC_FLAG_INPUT_BUFFER) == 0) 594 return_ACPI_STATUS(AE_OK); 595 596 sc->sc_csrvalue = 0; 597 /* XXXJRT Sleeping with a lock held? */ 598 if (tsleep(&sc->sc_csrvalue, 0, "EcWait", 1) != EWOULDBLOCK) 599 EcStatus = sc->sc_csrvalue; 600 else 601 EcStatus = EC_CSR_READ(sc); 602 } 603 return_ACPI_STATUS(AE_ERROR); 604 } 605 606 static ACPI_STATUS 607 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event) 608 { 609 EC_STATUS EcStatus; 610 UINT32 i = 0; 611 612 if (EcIsLocked(sc) == 0) 613 printf("%s: EcWaitEvent called without EC lock!\n", 614 sc->sc_dev.dv_xname); 615 616 /* 617 * Stall 1us: 618 * ---------- 619 * Stall for 1 microsecond before reading the status register 620 * for the first time. This allows the EC to set the IBF/OBF 621 * bit to its proper state. 622 * 623 * XXX it is not clear why we read the CSR twice. 624 */ 625 AcpiOsStall(1); 626 EcStatus = EC_CSR_READ(sc); 627 628 /* 629 * Wait For Event: 630 * --------------- 631 * Poll the EC status register to detect completion of the last 632 * command. Wait up to 10ms (in 100us chunks) for this to occur. 633 */ 634 for (i = 0; i < 100; i++) { 635 EcStatus = EC_CSR_READ(sc); 636 637 if ((Event == EC_EVENT_OUTPUT_BUFFER_FULL) && 638 (EcStatus & EC_FLAG_OUTPUT_BUFFER) != 0) 639 return (AE_OK); 640 641 if ((Event == EC_EVENT_INPUT_BUFFER_EMPTY) && 642 (EcStatus & EC_FLAG_INPUT_BUFFER) == 0) 643 return (AE_OK); 644 645 AcpiOsStall(10); 646 } 647 648 return (AE_ERROR); 649 } 650 651 static ACPI_STATUS 652 EcQuery(struct acpi_ec_softc *sc, UINT8 *Data) 653 { 654 ACPI_STATUS Status; 655 656 if ((Status = EcLock(sc)) != AE_OK) 657 return (Status); 658 659 EC_CSR_WRITE(sc, EC_COMMAND_QUERY); 660 Status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL); 661 if (Status == AE_OK) 662 *Data = EC_DATA_READ(sc); 663 664 EcUnlock(sc); 665 666 if (Status != AE_OK) 667 printf("%s: timed out waiting for EC to respond to " 668 "EC_COMMAND_QUERY\n", sc->sc_dev.dv_xname); 669 670 return (Status); 671 } 672 673 static ACPI_STATUS 674 EcTransaction(struct acpi_ec_softc *sc, EC_REQUEST *EcRequest) 675 { 676 ACPI_STATUS Status; 677 678 if ((Status = EcLock(sc)) != AE_OK) 679 return (Status); 680 681 /* 682 * Perform the transaction. 683 */ 684 switch (EcRequest->Command) { 685 case EC_COMMAND_READ: 686 Status = EcRead(sc, EcRequest->Address, &(EcRequest->Data)); 687 break; 688 689 case EC_COMMAND_WRITE: 690 Status = EcWrite(sc, EcRequest->Address, &(EcRequest->Data)); 691 break; 692 693 default: 694 Status = AE_SUPPORT; 695 break; 696 } 697 698 /* 699 * Clear & Re-Enable the EC GPE: 700 * ----------------------------- 701 * 'Consume' any EC GPE events that we generated while performing 702 * the transaction (e.g. IBF/OBF). Clearing the GPE here shouldn't 703 * have an adverse affect on outstanding EC-SCI's, as the source 704 * (EC-SCI) will still be high and thus should trigger the GPE 705 * immediately after we re-enabling it. 706 */ 707 if (sc->sc_flags & EC_F_PENDQUERY) { 708 if (AcpiOsQueueForExecution(OSD_PRIORITY_HIGH, 709 EcGpeQueryHandler, sc) != AE_OK) 710 printf("%s: unable to queue pending query\n", 711 sc->sc_dev.dv_xname); 712 sc->sc_flags &= ~EC_F_PENDQUERY; 713 } 714 715 if (AcpiClearEvent(sc->sc_gpebit, ACPI_EVENT_GPE) != AE_OK) 716 printf("%s: EcRequest: unable to clear EC GPE\n", 717 sc->sc_dev.dv_xname); 718 if (AcpiEnableEvent(sc->sc_gpebit, ACPI_EVENT_GPE, 0) != AE_OK) 719 printf("%s: EcRequest: unable to reenable EC GPE\n", 720 sc->sc_dev.dv_xname); 721 722 EcUnlock(sc); 723 724 return(Status); 725 } 726 727 static ACPI_STATUS 728 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 729 { 730 ACPI_STATUS Status; 731 732 if (EcIsLocked(sc) == 0) 733 printf("%s: EcRead called without EC lock!\n", 734 sc->sc_dev.dv_xname); 735 736 /* EcBurstEnable(EmbeddedController); */ 737 738 EC_CSR_WRITE(sc, EC_COMMAND_READ); 739 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 740 AE_OK) { 741 printf("%s: EcRead: timeout waiting for EC to process " 742 "read command\n", sc->sc_dev.dv_xname); 743 return (Status); 744 } 745 746 EC_DATA_WRITE(sc, Address); 747 if ((Status = EcWaitEventIntr(sc, EC_EVENT_OUTPUT_BUFFER_FULL)) != 748 AE_OK) { 749 printf("%s: EcRead: timeout waiting for EC to send data\n", 750 sc->sc_dev.dv_xname); 751 return (Status); 752 } 753 754 (*Data) = EC_DATA_READ(sc); 755 756 /* EcBurstDisable(EmbeddedController); */ 757 758 return (AE_OK); 759 } 760 761 static ACPI_STATUS 762 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 763 { 764 ACPI_STATUS Status; 765 766 if (EcIsLocked(sc) == 0) 767 printf("%s: EcWrite called without EC lock!\n", 768 sc->sc_dev.dv_xname); 769 770 /* EcBurstEnable(EmbeddedController); */ 771 772 EC_CSR_WRITE(sc, EC_COMMAND_WRITE); 773 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 774 AE_OK) { 775 printf("%s: EcWrite: timeout waiting for EC to process " 776 "write command\n", sc->sc_dev.dv_xname); 777 return (Status); 778 } 779 780 EC_DATA_WRITE(sc, Address); 781 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 782 AE_OK) { 783 printf("%s: EcWrite: timeout waiting for EC to process " 784 "address\n", sc->sc_dev.dv_xname); 785 return (Status); 786 } 787 788 EC_DATA_WRITE(sc, *Data); 789 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 790 AE_OK) { 791 printf("%s: EcWrite: timeout waiting for EC to process " 792 "data\n", sc->sc_dev.dv_xname); 793 return (Status); 794 } 795 796 /* EcBurstDisable(EmbeddedController); */ 797 798 return (AE_OK); 799 } 800