1 /* $NetBSD: acpi_ec.c,v 1.9 2003/02/14 11:05:39 tshiozak 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.9 2003/02/14 11:05:39 tshiozak 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 UINT32 sc_lockhandle; 211 }; 212 213 #define EC_F_LOCKED 0x01 /* EC is locked */ 214 #define EC_F_PENDQUERY 0x02 /* query is pending */ 215 216 #define EC_DATA_READ(sc) \ 217 bus_space_read_1((sc)->sc_data_st, (sc)->sc_data_sh, 0) 218 #define EC_DATA_WRITE(sc, v) \ 219 bus_space_write_1((sc)->sc_data_st, (sc)->sc_data_sh, 0, (v)) 220 221 #define EC_CSR_READ(sc) \ 222 bus_space_read_1((sc)->sc_csr_st, (sc)->sc_csr_sh, 0) 223 #define EC_CSR_WRITE(sc, v) \ 224 bus_space_write_1((sc)->sc_csr_st, (sc)->sc_csr_sh, 0, (v)) 225 226 static __inline int 227 EcIsLocked(struct acpi_ec_softc *sc) 228 { 229 230 return (acpi_is_global_locked() && (sc->sc_flags & EC_F_LOCKED)); 231 } 232 233 static __inline ACPI_STATUS 234 EcLock(struct acpi_ec_softc *sc) 235 { 236 ACPI_STATUS status; 237 UINT32 handle; 238 239 status = acpi_acquire_global_lock(&handle); 240 if (ACPI_SUCCESS(status)) { 241 sc->sc_flags |= EC_F_LOCKED; 242 sc->sc_lockhandle = handle; 243 } 244 245 return (status); 246 } 247 248 static __inline void 249 EcUnlock(struct acpi_ec_softc *sc) 250 { 251 UINT32 handle; 252 253 if (!EcIsLocked(sc)) 254 return; 255 handle = sc->sc_lockhandle; 256 sc->sc_flags &= EC_F_LOCKED; 257 acpi_release_global_lock(handle); 258 } 259 260 typedef struct { 261 EC_COMMAND Command; 262 UINT8 Address; 263 UINT8 Data; 264 } EC_REQUEST; 265 266 static void EcGpeHandler(void *Context); 267 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, 268 void *Context, void **return_Context); 269 static ACPI_STATUS EcSpaceHandler(UINT32 Function, 270 ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 271 ACPI_INTEGER *Value, void *Context, 272 void *RegionContext); 273 274 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event); 275 static ACPI_STATUS EcQuery(struct acpi_ec_softc *sc, UINT8 *Data); 276 static ACPI_STATUS EcTransaction(struct acpi_ec_softc *sc, 277 EC_REQUEST *EcRequest); 278 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address, 279 UINT8 *Data); 280 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address, 281 UINT8 *Data); 282 283 int acpiec_match(struct device *, struct cfdata *, void *); 284 void acpiec_attach(struct device *, struct device *, void *); 285 286 CFATTACH_DECL(acpiec, sizeof(struct acpi_ec_softc), 287 acpiec_match, acpiec_attach, NULL, NULL); 288 289 /* 290 * acpiec_match: 291 * 292 * Autoconfiguration `match' routine. 293 */ 294 int 295 acpiec_match(struct device *parent, struct cfdata *match, void *aux) 296 { 297 struct acpi_attach_args *aa = aux; 298 299 if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE) 300 return (0); 301 302 if (strcmp(aa->aa_node->ad_devinfo.HardwareId, "PNP0C09") == 0) 303 return (1); 304 305 return (0); 306 } 307 308 /* 309 * acpiec_attach: 310 * 311 * Autoconfiguration `attach' routine. 312 */ 313 void 314 acpiec_attach(struct device *parent, struct device *self, void *aux) 315 { 316 struct acpi_ec_softc *sc = (void *) self; 317 struct acpi_attach_args *aa = aux; 318 struct acpi_io *io0, *io1; 319 ACPI_STATUS rv; 320 321 ACPI_FUNCTION_TRACE(__FUNCTION__); 322 323 printf(": ACPI Embedded Controller\n"); 324 325 sc->sc_node = aa->aa_node; 326 327 /* Parse our resources. */ 328 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "parsing EC resources\n")); 329 rv = acpi_resource_parse(&sc->sc_dev, sc->sc_node, &sc->sc_res, 330 &acpi_resource_parse_ops_default); 331 if (rv != AE_OK) { 332 printf("%s: unable to parse resources: %d\n", 333 sc->sc_dev.dv_xname, rv); 334 return; 335 } 336 337 sc->sc_data_st = aa->aa_iot; 338 io0 = acpi_res_io(&sc->sc_res, 0); 339 if (io0 == NULL) { 340 printf("%s: unable to find data register resource\n", 341 sc->sc_dev.dv_xname); 342 return; 343 } 344 if (bus_space_map(sc->sc_data_st, io0->ar_base, io0->ar_length, 345 0, &sc->sc_data_sh) != 0) { 346 printf("%s: unable to map data register\n", 347 sc->sc_dev.dv_xname); 348 return; 349 } 350 351 sc->sc_csr_st = aa->aa_iot; 352 io1 = acpi_res_io(&sc->sc_res, 1); 353 if (io1 == NULL) { 354 printf("%s: unable to find csr register resource\n", 355 sc->sc_dev.dv_xname); 356 return; 357 } 358 if (bus_space_map(sc->sc_csr_st, io1->ar_base, io1->ar_length, 359 0, &sc->sc_csr_sh) != 0) { 360 printf("%s: unable to map csr register\n", 361 sc->sc_dev.dv_xname); 362 return; 363 } 364 365 /* 366 * Install GPE handler. 367 * 368 * We evaluate the _GPE method to find the GPE bit used by the 369 * Embedded Controller to signal status (SCI). 370 */ 371 if ((rv = acpi_eval_integer(sc->sc_node->ad_handle, "_GPE", 372 &sc->sc_gpebit)) != AE_OK) { 373 printf("%s: unable to evaluate _GPE: %d\n", 374 sc->sc_dev.dv_xname, rv); 375 return; 376 } 377 378 /* 379 * Install a handler for this EC's GPE bit. Note that EC SCIs are 380 * treated as both edge- and level-triggered interrupts; in other words 381 * we clear the status bit immediately after getting an EC-SCI, then 382 * again after we're done processing the event. This guarantees that 383 * events we cause while performing a transaction (e.g. IBE/OBF) get 384 * cleared before re-enabling the GPE. 385 */ 386 if ((rv = AcpiInstallGpeHandler(sc->sc_gpebit, 387 ACPI_EVENT_LEVEL_TRIGGERED | ACPI_EVENT_EDGE_TRIGGERED, 388 EcGpeHandler, sc)) != AE_OK) { 389 printf("%s: unable to install GPE handler: %d\n", 390 sc->sc_dev.dv_xname, rv); 391 return; 392 } 393 394 /* Install address space handler. */ 395 if ((rv = AcpiInstallAddressSpaceHandler(sc->sc_node->ad_handle, 396 ACPI_ADR_SPACE_EC, EcSpaceHandler, EcSpaceSetup, sc)) != AE_OK) { 397 printf("%s: unable to install address space handler: %d\n", 398 sc->sc_dev.dv_xname, rv); 399 return; 400 } 401 402 return_VOID; 403 } 404 405 static void 406 EcGpeQueryHandler(void *Context) 407 { 408 struct acpi_ec_softc *sc = Context; 409 UINT8 Data; 410 ACPI_STATUS Status; 411 char qxx[5]; 412 413 ACPI_FUNCTION_TRACE(__FUNCTION__); 414 415 for (;;) { 416 /* 417 * Check EC_SCI. 418 * 419 * Bail out if the EC_SCI bit of the status register is not 420 * set. Note that this function should only be called when 421 * this bit is set (polling is used to detect IBE/OBF events). 422 * 423 * It is safe to do this without locking the controller, as 424 * it's OK to call EcQuery when there's no data ready; in the 425 * worst case we should just find nothing waiting for us and 426 * bail. 427 */ 428 if ((EC_CSR_READ(sc) & EC_EVENT_SCI) == 0) 429 break; 430 431 /* 432 * Find out why the EC is signalling us 433 */ 434 Status = EcQuery(sc, &Data); 435 436 /* 437 * If we failed to get anything from the EC, give up. 438 */ 439 if (Status != AE_OK) { 440 printf("%s: GPE query failed: %d\n", 441 sc->sc_dev.dv_xname, Status); 442 break; 443 } 444 445 /* 446 * Evaluate _Qxx to respond to the controller. 447 */ 448 sprintf(qxx, "_Q%02x", Data); 449 strupr(qxx); 450 Status = AcpiEvaluateObject(sc->sc_node->ad_handle, qxx, 451 NULL, NULL); 452 453 /* 454 * Ignore spurious query requests. 455 */ 456 if (Status != AE_OK && 457 (Data != 0 || Status != AE_NOT_FOUND)) { 458 printf("%s: evaluation of GPE query method %s " 459 "failed: %d\n", sc->sc_dev.dv_xname, qxx, Status); 460 } 461 } 462 463 /* I know I request Level trigger cleanup */ 464 if (AcpiClearEvent(sc->sc_gpebit, ACPI_EVENT_GPE) != AE_OK) 465 printf("%s: AcpiClearEvent failed\n", sc->sc_dev.dv_xname); 466 if (AcpiEnableEvent(sc->sc_gpebit, ACPI_EVENT_GPE, 0) != AE_OK) 467 printf("%s: AcpiEnableEvent failed\n", sc->sc_dev.dv_xname); 468 469 return_VOID; 470 } 471 472 static void 473 EcGpeHandler(void *Context) 474 { 475 struct acpi_ec_softc *sc = Context; 476 uint32_t csrvalue; 477 478 /* 479 * If EC is locked, the intr must process EcRead/Write wait only. 480 * Query request must be pending. 481 */ 482 if (EcIsLocked(sc)) { 483 csrvalue = EC_CSR_READ(sc); 484 if (csrvalue & EC_EVENT_SCI) 485 sc->sc_flags |= EC_F_PENDQUERY; 486 487 if ((csrvalue & EC_FLAG_OUTPUT_BUFFER) != 0 || 488 (csrvalue & EC_FLAG_INPUT_BUFFER) == 0) { 489 sc->sc_csrvalue = csrvalue; 490 wakeup(&sc->sc_csrvalue); 491 } 492 } else { 493 /* Enqueue GpeQuery handler. */ 494 if (AcpiOsQueueForExecution(OSD_PRIORITY_HIGH, 495 EcGpeQueryHandler, Context) != AE_OK) { 496 printf("%s: failed to enqueue query handler\n", 497 sc->sc_dev.dv_xname); 498 } 499 } 500 } 501 502 static ACPI_STATUS 503 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context, 504 void **RegionContext) 505 { 506 507 ACPI_FUNCTION_TRACE(__FUNCTION__); 508 509 /* 510 * Just pass the context through, there's nothing to do here. 511 */ 512 *RegionContext = Context; 513 514 return_ACPI_STATUS(AE_OK); 515 } 516 517 static ACPI_STATUS 518 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 519 ACPI_INTEGER *Value, void *Context, void *RegionContext) 520 { 521 struct acpi_ec_softc *sc = Context; 522 ACPI_STATUS Status = AE_OK; 523 EC_REQUEST EcRequest; 524 int i; 525 526 ACPI_FUNCTION_TRACE_U32(__FUNCTION__, (UINT32)Address); 527 528 if ((Address > 0xFF) || (width % 8 != 0) || (Value == NULL) || 529 (Context == NULL)) 530 return_ACPI_STATUS(AE_BAD_PARAMETER); 531 532 switch (Function) { 533 case ACPI_READ: 534 EcRequest.Command = EC_COMMAND_READ; 535 EcRequest.Address = Address; 536 (*Value) = 0; 537 break; 538 539 case ACPI_WRITE: 540 EcRequest.Command = EC_COMMAND_WRITE; 541 EcRequest.Address = Address; 542 break; 543 544 default: 545 printf("%s: invalid Address Space function: %d\n", 546 sc->sc_dev.dv_xname, Function); 547 return_ACPI_STATUS(AE_BAD_PARAMETER); 548 } 549 550 /* 551 * Perform the transaction. 552 */ 553 for (i = 0; i < width; i += 8) { 554 if (Function == ACPI_READ) 555 EcRequest.Data = 0; 556 else 557 EcRequest.Data = (UINT8)((*Value) >> i); 558 559 if ((Status = EcTransaction(sc, &EcRequest)) != AE_OK) 560 break; 561 562 (*Value) |= (UINT32)EcRequest.Data << i; 563 if (++EcRequest.Address == 0) 564 return_ACPI_STATUS(AE_BAD_PARAMETER); 565 } 566 567 return_ACPI_STATUS(Status); 568 } 569 570 static ACPI_STATUS 571 EcWaitEventIntr(struct acpi_ec_softc *sc, EC_EVENT Event) 572 { 573 EC_STATUS EcStatus; 574 int i; 575 576 ACPI_FUNCTION_TRACE_U32(__FUNCTION__, (UINT32)Event); 577 578 /* XXX Need better test for "yes, you have interrupts". */ 579 if (cold) 580 return_ACPI_STATUS(EcWaitEvent(sc, Event)); 581 582 if (EcIsLocked(sc) == 0) 583 printf("%s: EcWaitEventIntr called without EC lock!\n", 584 sc->sc_dev.dv_xname); 585 586 EcStatus = EC_CSR_READ(sc); 587 588 /* Too long? */ 589 for (i = 0; i < 10; i++) { 590 /* Check EC status against the desired event. */ 591 if ((Event == EC_EVENT_OUTPUT_BUFFER_FULL) && 592 (EcStatus & EC_FLAG_OUTPUT_BUFFER) != 0) 593 return_ACPI_STATUS(AE_OK); 594 595 if ((Event == EC_EVENT_INPUT_BUFFER_EMPTY) && 596 (EcStatus & EC_FLAG_INPUT_BUFFER) == 0) 597 return_ACPI_STATUS(AE_OK); 598 599 sc->sc_csrvalue = 0; 600 /* XXXJRT Sleeping with a lock held? */ 601 if (tsleep(&sc->sc_csrvalue, 0, "EcWait", 1) != EWOULDBLOCK) 602 EcStatus = sc->sc_csrvalue; 603 else 604 EcStatus = EC_CSR_READ(sc); 605 } 606 return_ACPI_STATUS(AE_ERROR); 607 } 608 609 static ACPI_STATUS 610 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event) 611 { 612 EC_STATUS EcStatus; 613 UINT32 i = 0; 614 615 if (EcIsLocked(sc) == 0) 616 printf("%s: EcWaitEvent called without EC lock!\n", 617 sc->sc_dev.dv_xname); 618 619 /* 620 * Stall 1us: 621 * ---------- 622 * Stall for 1 microsecond before reading the status register 623 * for the first time. This allows the EC to set the IBF/OBF 624 * bit to its proper state. 625 * 626 * XXX it is not clear why we read the CSR twice. 627 */ 628 AcpiOsStall(1); 629 EcStatus = EC_CSR_READ(sc); 630 631 /* 632 * Wait For Event: 633 * --------------- 634 * Poll the EC status register to detect completion of the last 635 * command. Wait up to 10ms (in 100us chunks) for this to occur. 636 */ 637 for (i = 0; i < 100; i++) { 638 EcStatus = EC_CSR_READ(sc); 639 640 if ((Event == EC_EVENT_OUTPUT_BUFFER_FULL) && 641 (EcStatus & EC_FLAG_OUTPUT_BUFFER) != 0) 642 return (AE_OK); 643 644 if ((Event == EC_EVENT_INPUT_BUFFER_EMPTY) && 645 (EcStatus & EC_FLAG_INPUT_BUFFER) == 0) 646 return (AE_OK); 647 648 AcpiOsStall(10); 649 } 650 651 return (AE_ERROR); 652 } 653 654 static ACPI_STATUS 655 EcQuery(struct acpi_ec_softc *sc, UINT8 *Data) 656 { 657 ACPI_STATUS Status; 658 659 if ((Status = EcLock(sc)) != AE_OK) 660 return (Status); 661 662 EC_CSR_WRITE(sc, EC_COMMAND_QUERY); 663 Status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL); 664 if (Status == AE_OK) 665 *Data = EC_DATA_READ(sc); 666 667 EcUnlock(sc); 668 669 if (Status != AE_OK) 670 printf("%s: timed out waiting for EC to respond to " 671 "EC_COMMAND_QUERY\n", sc->sc_dev.dv_xname); 672 673 return (Status); 674 } 675 676 static ACPI_STATUS 677 EcTransaction(struct acpi_ec_softc *sc, EC_REQUEST *EcRequest) 678 { 679 ACPI_STATUS Status; 680 681 if ((Status = EcLock(sc)) != AE_OK) 682 return (Status); 683 684 /* 685 * Perform the transaction. 686 */ 687 switch (EcRequest->Command) { 688 case EC_COMMAND_READ: 689 Status = EcRead(sc, EcRequest->Address, &(EcRequest->Data)); 690 break; 691 692 case EC_COMMAND_WRITE: 693 Status = EcWrite(sc, EcRequest->Address, &(EcRequest->Data)); 694 break; 695 696 default: 697 Status = AE_SUPPORT; 698 break; 699 } 700 701 /* 702 * Clear & Re-Enable the EC GPE: 703 * ----------------------------- 704 * 'Consume' any EC GPE events that we generated while performing 705 * the transaction (e.g. IBF/OBF). Clearing the GPE here shouldn't 706 * have an adverse affect on outstanding EC-SCI's, as the source 707 * (EC-SCI) will still be high and thus should trigger the GPE 708 * immediately after we re-enabling it. 709 */ 710 if (sc->sc_flags & EC_F_PENDQUERY) { 711 if (AcpiOsQueueForExecution(OSD_PRIORITY_HIGH, 712 EcGpeQueryHandler, sc) != AE_OK) 713 printf("%s: unable to queue pending query\n", 714 sc->sc_dev.dv_xname); 715 sc->sc_flags &= ~EC_F_PENDQUERY; 716 } 717 718 if (AcpiClearEvent(sc->sc_gpebit, ACPI_EVENT_GPE) != AE_OK) 719 printf("%s: EcRequest: unable to clear EC GPE\n", 720 sc->sc_dev.dv_xname); 721 if (AcpiEnableEvent(sc->sc_gpebit, ACPI_EVENT_GPE, 0) != AE_OK) 722 printf("%s: EcRequest: unable to reenable EC GPE\n", 723 sc->sc_dev.dv_xname); 724 725 EcUnlock(sc); 726 727 return(Status); 728 } 729 730 static ACPI_STATUS 731 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 732 { 733 ACPI_STATUS Status; 734 735 if (EcIsLocked(sc) == 0) 736 printf("%s: EcRead called without EC lock!\n", 737 sc->sc_dev.dv_xname); 738 739 /* EcBurstEnable(EmbeddedController); */ 740 741 EC_CSR_WRITE(sc, EC_COMMAND_READ); 742 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 743 AE_OK) { 744 printf("%s: EcRead: timeout waiting for EC to process " 745 "read command\n", sc->sc_dev.dv_xname); 746 return (Status); 747 } 748 749 EC_DATA_WRITE(sc, Address); 750 if ((Status = EcWaitEventIntr(sc, EC_EVENT_OUTPUT_BUFFER_FULL)) != 751 AE_OK) { 752 printf("%s: EcRead: timeout waiting for EC to send data\n", 753 sc->sc_dev.dv_xname); 754 return (Status); 755 } 756 757 (*Data) = EC_DATA_READ(sc); 758 759 /* EcBurstDisable(EmbeddedController); */ 760 761 return (AE_OK); 762 } 763 764 static ACPI_STATUS 765 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 766 { 767 ACPI_STATUS Status; 768 769 if (EcIsLocked(sc) == 0) 770 printf("%s: EcWrite called without EC lock!\n", 771 sc->sc_dev.dv_xname); 772 773 /* EcBurstEnable(EmbeddedController); */ 774 775 EC_CSR_WRITE(sc, EC_COMMAND_WRITE); 776 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 777 AE_OK) { 778 printf("%s: EcWrite: timeout waiting for EC to process " 779 "write command\n", sc->sc_dev.dv_xname); 780 return (Status); 781 } 782 783 EC_DATA_WRITE(sc, Address); 784 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 785 AE_OK) { 786 printf("%s: EcWrite: timeout waiting for EC to process " 787 "address\n", sc->sc_dev.dv_xname); 788 return (Status); 789 } 790 791 EC_DATA_WRITE(sc, *Data); 792 if ((Status = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 793 AE_OK) { 794 printf("%s: EcWrite: timeout waiting for EC to process " 795 "data\n", sc->sc_dev.dv_xname); 796 return (Status); 797 } 798 799 /* EcBurstDisable(EmbeddedController); */ 800 801 return (AE_OK); 802 } 803