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