1 /* $NetBSD: acpi_ec.c,v 1.35 2005/12/24 20:27:29 perry 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.35 2005/12/24 20:27:29 perry Exp $"); 176 177 #include <sys/param.h> 178 #include <sys/systm.h> 179 #include <sys/device.h> 180 #include <sys/malloc.h> 181 #include <sys/proc.h> 182 #include <sys/kernel.h> 183 184 #include <machine/bus.h> 185 186 #include <dev/acpi/acpica.h> 187 #include <dev/acpi/acpireg.h> 188 #include <dev/acpi/acpivar.h> 189 #include <dev/acpi/acpi_ecreg.h> 190 191 MALLOC_DECLARE(M_ACPI); 192 193 #define _COMPONENT ACPI_EC_COMPONENT 194 ACPI_MODULE_NAME("EC") 195 196 struct acpi_ec_softc { 197 struct device sc_dev; /* base device glue */ 198 ACPI_HANDLE sc_handle; /* ACPI handle */ 199 200 UINT32 sc_gpebit; /* our GPE interrupt bit */ 201 202 bus_space_tag_t sc_data_st; /* space tag for data register */ 203 bus_space_handle_t sc_data_sh; /* space handle for data register */ 204 205 bus_space_tag_t sc_csr_st; /* space tag for control register */ 206 bus_space_handle_t sc_csr_sh; /* space handle for control register */ 207 208 int sc_flags; /* see below */ 209 210 uint32_t sc_csrvalue; /* saved control register */ 211 uint32_t sc_uid; /* _UID in namespace (ECDT only) */ 212 213 struct lock sc_lock; /* serialize operations to this EC */ 214 struct simplelock sc_slock; /* protect against interrupts */ 215 UINT32 sc_glkhandle; /* global lock handle */ 216 UINT32 sc_glk; /* need global lock? */ 217 }; 218 219 static const char * const ec_hid[] = { 220 "PNP0C09", 221 NULL 222 }; 223 224 #define EC_F_TRANSACTION 0x01 /* doing transaction */ 225 #define EC_F_PENDQUERY 0x02 /* query is pending */ 226 227 /* 228 * how long to wait to acquire global lock. 229 * the value is taken from FreeBSD driver. 230 */ 231 #define EC_LOCK_TIMEOUT 1000 232 233 #define EC_DATA_READ(sc) \ 234 bus_space_read_1((sc)->sc_data_st, (sc)->sc_data_sh, 0) 235 #define EC_DATA_WRITE(sc, v) \ 236 bus_space_write_1((sc)->sc_data_st, (sc)->sc_data_sh, 0, (v)) 237 238 #define EC_CSR_READ(sc) \ 239 bus_space_read_1((sc)->sc_csr_st, (sc)->sc_csr_sh, 0) 240 #define EC_CSR_WRITE(sc, v) \ 241 bus_space_write_1((sc)->sc_csr_st, (sc)->sc_csr_sh, 0, (v)) 242 243 typedef struct { 244 EC_COMMAND Command; 245 UINT8 Address; 246 UINT8 Data; 247 } EC_REQUEST; 248 249 static UINT32 EcGpeHandler(void *Context); 250 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, 251 void *Context, void **return_Context); 252 static ACPI_STATUS EcSpaceHandler(UINT32 Function, 253 ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 254 ACPI_INTEGER *Value, void *Context, 255 void *RegionContext); 256 257 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event); 258 static ACPI_STATUS EcQuery(struct acpi_ec_softc *sc, UINT8 *Data); 259 static ACPI_STATUS EcTransaction(struct acpi_ec_softc *sc, 260 EC_REQUEST *EcRequest); 261 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address, 262 UINT8 *Data); 263 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address, 264 UINT8 *Data); 265 static void EcGpeQueryHandler(void *); 266 static inline int EcIsLocked(struct acpi_ec_softc *); 267 static inline void EcLock(struct acpi_ec_softc *); 268 static inline void EcUnlock(struct acpi_ec_softc *); 269 270 271 static int acpiec_match(struct device *, struct cfdata *, void *); 272 static void acpiec_attach(struct device *, struct device *, void *); 273 274 CFATTACH_DECL(acpiec, sizeof(struct acpi_ec_softc), 275 acpiec_match, acpiec_attach, NULL, NULL); 276 277 static struct acpi_ec_softc *ecdt_sc; 278 279 static inline int 280 EcIsLocked(struct acpi_ec_softc *sc) 281 { 282 283 return (lockstatus(&sc->sc_lock) == LK_EXCLUSIVE); 284 } 285 286 static inline void 287 EcLock(struct acpi_ec_softc *sc) 288 { 289 ACPI_STATUS rv; 290 int s; 291 292 lockmgr(&sc->sc_lock, LK_EXCLUSIVE, NULL); 293 if (sc->sc_glk) { 294 rv = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, 295 &sc->sc_glkhandle); 296 if (ACPI_FAILURE(rv)) { 297 printf("%s: failed to acquire global lock\n", 298 sc->sc_dev.dv_xname); 299 lockmgr(&sc->sc_lock, LK_RELEASE, NULL); 300 return; 301 } 302 } 303 304 s = splvm(); /* XXX */ 305 simple_lock(&sc->sc_slock); 306 sc->sc_flags |= EC_F_TRANSACTION; 307 simple_unlock(&sc->sc_slock); 308 splx(s); 309 } 310 311 static inline void 312 EcUnlock(struct acpi_ec_softc *sc) 313 { 314 ACPI_STATUS rv; 315 int s; 316 317 /* 318 * Clear & Re-Enable the EC GPE: 319 * ----------------------------- 320 * 'Consume' any EC GPE events that we generated while performing 321 * the transaction (e.g. IBF/OBF). Clearing the GPE here shouldn't 322 * have an adverse affect on outstanding EC-SCI's, as the source 323 * (EC-SCI) will still be high and thus should trigger the GPE 324 * immediately after we re-enabling it. 325 */ 326 s = splvm(); /* XXX */ 327 simple_lock(&sc->sc_slock); 328 if (sc->sc_flags & EC_F_PENDQUERY) { 329 ACPI_STATUS rv2; 330 331 rv2 = AcpiOsQueueForExecution(OSD_PRIORITY_HIGH, 332 EcGpeQueryHandler, sc); 333 if (ACPI_FAILURE(rv2)) 334 printf("%s: unable to queue pending query: %s\n", 335 sc->sc_dev.dv_xname, AcpiFormatException(rv2)); 336 sc->sc_flags &= ~EC_F_PENDQUERY; 337 } 338 sc->sc_flags &= ~EC_F_TRANSACTION; 339 simple_unlock(&sc->sc_slock); 340 splx(s); 341 342 if (sc->sc_glk) { 343 rv = AcpiReleaseGlobalLock(sc->sc_glkhandle); 344 if (ACPI_FAILURE(rv)) 345 printf("%s: failed to release global lock\n", 346 sc->sc_dev.dv_xname); 347 } 348 lockmgr(&sc->sc_lock, LK_RELEASE, NULL); 349 } 350 351 /* 352 * acpiec_match: 353 * 354 * Autoconfiguration `match' routine. 355 */ 356 static int 357 acpiec_match(struct device *parent, struct cfdata *match, void *aux) 358 { 359 struct acpi_attach_args *aa = aux; 360 361 if (aa->aa_node->ad_type != ACPI_TYPE_DEVICE) 362 return 0; 363 364 return acpi_match_hid(aa->aa_node->ad_devinfo, ec_hid); 365 } 366 367 void 368 acpiec_early_attach(struct device *parent) 369 { 370 struct acpi_softc *sc = (struct acpi_softc *)parent; 371 EC_BOOT_RESOURCES *ep; 372 ACPI_HANDLE handle; 373 ACPI_STATUS rv; 374 ACPI_INTEGER tmp; 375 376 rv = AcpiGetFirmwareTable("ECDT", 1, ACPI_LOGICAL_ADDRESSING, 377 (void *)&ep); 378 if (ACPI_FAILURE(rv)) 379 return; 380 381 if (ep->EcControl.RegisterBitWidth != 8 || 382 ep->EcData.RegisterBitWidth != 8) { 383 printf("%s: ECDT data is invalid, RegisterBitWidth=%d/%d\n", 384 parent->dv_xname, 385 ep->EcControl.RegisterBitWidth, 386 ep->EcData.RegisterBitWidth); 387 return; 388 } 389 390 rv = AcpiGetHandle(ACPI_ROOT_OBJECT, ep->EcId, &handle); 391 if (ACPI_FAILURE(rv)) { 392 printf("%s: failed to look up EC object %s: %s\n", 393 parent->dv_xname, 394 ep->EcId, AcpiFormatException(rv)); 395 return; 396 } 397 398 ecdt_sc = malloc(sizeof(*ecdt_sc), M_ACPI, M_ZERO); 399 400 strcpy(ecdt_sc->sc_dev.dv_xname, "acpiecdt0"); /* XXX */ 401 ecdt_sc->sc_handle = handle; 402 403 ecdt_sc->sc_gpebit = ep->GpeBit; 404 ecdt_sc->sc_uid = ep->Uid; 405 406 ecdt_sc->sc_data_st = sc->sc_iot; 407 if (bus_space_map(ecdt_sc->sc_data_st, 408 (bus_addr_t)(ep->EcData.Address), 1, 0, 409 &ecdt_sc->sc_data_sh) != 0) { 410 printf("%s: bus_space_map failed for EC data.\n", 411 parent->dv_xname); 412 goto out1; 413 } 414 415 ecdt_sc->sc_csr_st = sc->sc_iot; 416 if (bus_space_map(ecdt_sc->sc_csr_st, 417 (bus_addr_t)(ep->EcControl.Address), 1, 0, 418 &ecdt_sc->sc_csr_sh) != 0) { 419 printf("%s: bus_space_map failed for EC control.\n", 420 parent->dv_xname); 421 goto out2; 422 } 423 424 rv = acpi_eval_integer(handle, "_GLK", &tmp); 425 if (ACPI_SUCCESS(rv) && tmp == 1) 426 ecdt_sc->sc_glk = 1; 427 428 rv = AcpiInstallGpeHandler(NULL, ecdt_sc->sc_gpebit, 429 ACPI_GPE_EDGE_TRIGGERED, EcGpeHandler, ecdt_sc); 430 if (ACPI_FAILURE(rv)) { 431 printf("%s: unable to install GPE handler: %s\n", 432 parent->dv_xname, AcpiFormatException(rv)); 433 goto out3; 434 } 435 436 rv = AcpiSetGpeType(NULL, ecdt_sc->sc_gpebit, ACPI_GPE_TYPE_RUNTIME); 437 if (ACPI_FAILURE(rv)) { 438 printf("%s: unable to set GPE type: %s\n", 439 parent->dv_xname, AcpiFormatException(rv)); 440 goto out4; 441 } 442 443 rv = AcpiEnableGpe(NULL, ecdt_sc->sc_gpebit, ACPI_NOT_ISR); 444 if (ACPI_FAILURE(rv)) { 445 printf("%s: unable to enable GPE: %s\n", 446 parent->dv_xname, AcpiFormatException(rv)); 447 goto out4; 448 } 449 450 rv = AcpiInstallAddressSpaceHandler(ACPI_ROOT_OBJECT, 451 ACPI_ADR_SPACE_EC, EcSpaceHandler, EcSpaceSetup, ecdt_sc); 452 if (ACPI_FAILURE(rv)) { 453 printf("%s: unable to install address space handler: %s\n", 454 parent->dv_xname, 455 AcpiFormatException(rv)); 456 goto out4; 457 } 458 459 printf("%s: found ECDT, GPE %d\n", parent->dv_xname, 460 ecdt_sc->sc_gpebit); 461 462 lockinit(&ecdt_sc->sc_lock, PWAIT, "eclock", 0, 0); 463 simple_lock_init(&ecdt_sc->sc_slock); 464 465 AcpiOsUnmapMemory(ep, ep->Length); 466 return; 467 468 out4: 469 AcpiRemoveGpeHandler(NULL, ecdt_sc->sc_gpebit, EcGpeHandler); 470 out3: 471 bus_space_unmap(ecdt_sc->sc_csr_st, ecdt_sc->sc_csr_sh, 1); 472 out2: 473 bus_space_unmap(ecdt_sc->sc_data_st, ecdt_sc->sc_data_sh, 1); 474 out1: 475 free(ecdt_sc, M_ACPI); 476 ecdt_sc = NULL; 477 478 AcpiOsUnmapMemory(ep, ep->Length); 479 480 return; 481 } 482 483 /* 484 * acpiec_attach: 485 * 486 * Autoconfiguration `attach' routine. 487 */ 488 static void 489 acpiec_attach(struct device *parent, struct device *self, void *aux) 490 { 491 struct acpi_ec_softc *sc = (void *) self; 492 struct acpi_attach_args *aa = aux; 493 struct acpi_io *io0, *io1; 494 struct acpi_resources res; 495 ACPI_STATUS rv; 496 ACPI_INTEGER v; 497 498 ACPI_FUNCTION_TRACE(__FUNCTION__); 499 500 printf(": ACPI Embedded Controller\n"); 501 502 lockinit(&sc->sc_lock, PWAIT, "eclock", 0, 0); 503 simple_lock_init(&sc->sc_slock); 504 505 sc->sc_handle = aa->aa_node->ad_handle; 506 507 /* Parse our resources. */ 508 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "parsing EC resources\n")); 509 rv = acpi_resource_parse(&sc->sc_dev, sc->sc_handle, "_CRS", 510 &res, &acpi_resource_parse_ops_default); 511 if (ACPI_FAILURE(rv)) 512 return; 513 514 #define adi aa->aa_node->ad_devinfo 515 516 /* check if we already attached EC via ECDT */ 517 if (ecdt_sc && 518 ((adi->Valid & ACPI_VALID_UID) == ACPI_VALID_UID) && 519 ecdt_sc->sc_uid == strtoul(adi->UniqueId.Value, NULL, 10)) { 520 /* detach all ECDT handles */ 521 rv = AcpiRemoveAddressSpaceHandler(ACPI_ROOT_OBJECT, 522 ACPI_ADR_SPACE_EC, EcSpaceHandler); 523 if (ACPI_FAILURE(rv)) 524 printf("ERROR: RemoveAddressSpaceHandler: %s\n", 525 AcpiFormatException(rv)); 526 rv = AcpiRemoveGpeHandler(NULL, ecdt_sc->sc_gpebit, 527 EcGpeHandler); 528 if (ACPI_FAILURE(rv)) 529 printf("ERROR: RemoveAddressSpaceHandler: %s\n", 530 AcpiFormatException(rv)); 531 532 bus_space_unmap(ecdt_sc->sc_csr_st, 533 ecdt_sc->sc_csr_sh, 1); 534 bus_space_unmap(ecdt_sc->sc_data_st, 535 ecdt_sc->sc_data_sh, 1); 536 537 free(ecdt_sc, M_ACPI); 538 ecdt_sc = NULL; 539 } 540 541 #undef adi 542 543 sc->sc_data_st = aa->aa_iot; 544 io0 = acpi_res_io(&res, 0); 545 if (io0 == NULL) { 546 printf("%s: unable to find data register resource\n", 547 sc->sc_dev.dv_xname); 548 goto out; 549 } 550 if (bus_space_map(sc->sc_data_st, io0->ar_base, io0->ar_length, 551 0, &sc->sc_data_sh) != 0) { 552 printf("%s: unable to map data register\n", 553 sc->sc_dev.dv_xname); 554 goto out; 555 } 556 557 sc->sc_csr_st = aa->aa_iot; 558 io1 = acpi_res_io(&res, 1); 559 if (io1 == NULL) { 560 printf("%s: unable to find csr register resource\n", 561 sc->sc_dev.dv_xname); 562 goto out; 563 } 564 if (bus_space_map(sc->sc_csr_st, io1->ar_base, io1->ar_length, 565 0, &sc->sc_csr_sh) != 0) { 566 printf("%s: unable to map csr register\n", 567 sc->sc_dev.dv_xname); 568 goto out; 569 } 570 571 /* 572 * evaluate _GLK to see if we should acquire global lock 573 * when accessing the EC. 574 */ 575 rv = acpi_eval_integer(sc->sc_handle, "_GLK", &v); 576 if (ACPI_FAILURE(rv)) { 577 if (rv != AE_NOT_FOUND) 578 printf("%s: unable to evaluate _GLK: %s\n", 579 sc->sc_dev.dv_xname, 580 AcpiFormatException(rv)); 581 sc->sc_glk = 0; 582 } else 583 sc->sc_glk = v; 584 585 /* 586 * Install GPE handler. 587 * 588 * We evaluate the _GPE method to find the GPE bit used by the 589 * Embedded Controller to signal status (SCI). 590 */ 591 rv = acpi_eval_integer(sc->sc_handle, "_GPE", &v); 592 if (ACPI_FAILURE(rv)) { 593 printf("%s: unable to evaluate _GPE: %s\n", 594 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 595 goto out; 596 } 597 sc->sc_gpebit = v; 598 599 /* 600 * Install a handler for this EC's GPE bit. Note that EC SCIs are 601 * treated as both edge- and level-triggered interrupts; in other words 602 * we clear the status bit immediately after getting an EC-SCI, then 603 * again after we're done processing the event. This guarantees that 604 * events we cause while performing a transaction (e.g. IBE/OBF) get 605 * cleared before re-enabling the GPE. 606 */ 607 rv = AcpiInstallGpeHandler(NULL, sc->sc_gpebit, 608 ACPI_GPE_EDGE_TRIGGERED, EcGpeHandler, sc); 609 if (ACPI_FAILURE(rv)) { 610 printf("%s: unable to install GPE handler: %s\n", 611 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 612 goto out; 613 } 614 615 rv = AcpiSetGpeType(NULL, sc->sc_gpebit, ACPI_GPE_TYPE_RUNTIME); 616 if (ACPI_FAILURE(rv)) { 617 printf("%s: unable to set GPE type: %s\n", 618 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 619 goto out2; 620 } 621 622 rv = AcpiEnableGpe(NULL, sc->sc_gpebit, ACPI_NOT_ISR); 623 if (ACPI_FAILURE(rv)) { 624 printf("%s: unable to enable GPE: %s\n", 625 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 626 goto out2; 627 } 628 629 /* Install address space handler. */ 630 rv = AcpiInstallAddressSpaceHandler(sc->sc_handle, 631 ACPI_ADR_SPACE_EC, EcSpaceHandler, EcSpaceSetup, sc); 632 if (ACPI_FAILURE(rv)) { 633 printf("%s: unable to install address space handler: %s\n", 634 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 635 goto out2; 636 } 637 638 return_VOID; 639 out2: 640 (void)AcpiRemoveGpeHandler(NULL, sc->sc_gpebit, EcGpeHandler); 641 642 out: 643 acpi_resource_cleanup(&res); 644 return_VOID; 645 } 646 647 static void 648 EcGpeQueryHandler(void *Context) 649 { 650 struct acpi_ec_softc *sc = Context; 651 UINT8 Data; 652 ACPI_STATUS rv; 653 char qxx[5]; 654 655 ACPI_FUNCTION_TRACE(__FUNCTION__); 656 657 for (;;) { 658 /* 659 * Check EC_SCI. 660 * 661 * Bail out if the EC_SCI bit of the status register is not 662 * set. Note that this function should only be called when 663 * this bit is set (polling is used to detect IBE/OBF events). 664 * 665 * It is safe to do this without locking the controller, as 666 * it's OK to call EcQuery when there's no data ready; in the 667 * worst case we should just find nothing waiting for us and 668 * bail. 669 */ 670 if ((EC_CSR_READ(sc) & EC_EVENT_SCI) == 0) 671 break; 672 673 EcLock(sc); 674 675 /* 676 * Find out why the EC is signalling us 677 */ 678 rv = EcQuery(sc, &Data); 679 680 EcUnlock(sc); 681 682 /* 683 * If we failed to get anything from the EC, give up. 684 */ 685 if (ACPI_FAILURE(rv)) { 686 printf("%s: GPE query failed: %s\n", 687 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 688 break; 689 } 690 691 /* 692 * Evaluate _Qxx to respond to the controller. 693 */ 694 snprintf(qxx, sizeof(qxx), "_Q%02X", Data); 695 rv = AcpiEvaluateObject(sc->sc_handle, qxx, 696 NULL, NULL); 697 698 /* 699 * Ignore spurious query requests. 700 */ 701 if (ACPI_FAILURE(rv) && 702 (Data != 0 || rv != AE_NOT_FOUND)) { 703 printf("%s: evaluation of GPE query method %s " 704 "failed: %s\n", sc->sc_dev.dv_xname, qxx, 705 AcpiFormatException(rv)); 706 } 707 } 708 709 /* I know I request Level trigger cleanup */ 710 rv = AcpiClearGpe(NULL, sc->sc_gpebit, ACPI_NOT_ISR); 711 if (ACPI_FAILURE(rv)) 712 printf("%s: AcpiClearGpe failed: %s\n", sc->sc_dev.dv_xname, 713 AcpiFormatException(rv)); 714 715 return_VOID; 716 } 717 718 static UINT32 719 EcGpeHandler(void *Context) 720 { 721 struct acpi_ec_softc *sc = Context; 722 uint32_t csrvalue; 723 ACPI_STATUS rv; 724 725 /* 726 * If EC is locked, the intr must process EcRead/Write wait only. 727 * Query request must be pending. 728 */ 729 simple_lock(&sc->sc_slock); 730 if (sc->sc_flags & EC_F_TRANSACTION) { 731 csrvalue = EC_CSR_READ(sc); 732 sc->sc_flags |= EC_F_PENDQUERY; 733 734 if ((csrvalue & EC_FLAG_OUTPUT_BUFFER) != 0 || 735 (csrvalue & EC_FLAG_INPUT_BUFFER) == 0) { 736 sc->sc_csrvalue = csrvalue; 737 wakeup(&sc->sc_csrvalue); 738 } 739 simple_unlock(&sc->sc_slock); 740 } else { 741 simple_unlock(&sc->sc_slock); 742 /* Enqueue GpeQuery handler. */ 743 rv = AcpiOsQueueForExecution(OSD_PRIORITY_HIGH, 744 EcGpeQueryHandler, Context); 745 if (ACPI_FAILURE(rv)) 746 printf("%s: failed to enqueue query handler: %s\n", 747 sc->sc_dev.dv_xname, AcpiFormatException(rv)); 748 } 749 750 return 0; /* XXX not yet used in ACPI-CA */ 751 } 752 753 static ACPI_STATUS 754 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context, 755 void **RegionContext) 756 { 757 758 ACPI_FUNCTION_TRACE(__FUNCTION__); 759 760 /* 761 * Just pass the context through, there's nothing to do here. 762 */ 763 if (Function == ACPI_REGION_DEACTIVATE) 764 *RegionContext = NULL; 765 else 766 *RegionContext = Context; 767 768 return_ACPI_STATUS(AE_OK); 769 } 770 771 static ACPI_STATUS 772 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 width, 773 ACPI_INTEGER *Value, void *Context, void *RegionContext) 774 { 775 struct acpi_ec_softc *sc = Context; 776 ACPI_STATUS rv = AE_OK; 777 EC_REQUEST EcRequest; 778 int i; 779 780 ACPI_FUNCTION_TRACE_U32(__FUNCTION__, (UINT32)Address); 781 782 if ((Address > 0xFF) || (width % 8 != 0) || (Value == NULL) || 783 (Context == NULL)) 784 return_ACPI_STATUS(AE_BAD_PARAMETER); 785 786 switch (Function) { 787 case ACPI_READ: 788 EcRequest.Command = EC_COMMAND_READ; 789 EcRequest.Address = Address; 790 (*Value) = 0; 791 break; 792 793 case ACPI_WRITE: 794 EcRequest.Command = EC_COMMAND_WRITE; 795 EcRequest.Address = Address; 796 break; 797 798 default: 799 printf("%s: invalid Address Space function: %d\n", 800 sc->sc_dev.dv_xname, Function); 801 return_ACPI_STATUS(AE_BAD_PARAMETER); 802 } 803 804 /* 805 * Perform the transaction. 806 */ 807 for (i = 0; i < width; i += 8) { 808 if (Function == ACPI_READ) 809 EcRequest.Data = 0; 810 else 811 EcRequest.Data = (UINT8)((*Value) >> i); 812 813 rv = EcTransaction(sc, &EcRequest); 814 if (ACPI_FAILURE(rv)) 815 break; 816 817 (*Value) |= (UINT32)EcRequest.Data << i; 818 if (++EcRequest.Address == 0) 819 return_ACPI_STATUS(AE_BAD_PARAMETER); 820 } 821 822 return_ACPI_STATUS(rv); 823 } 824 825 static ACPI_STATUS 826 EcWaitEventIntr(struct acpi_ec_softc *sc, EC_EVENT Event) 827 { 828 EC_STATUS EcStatus; 829 int i; 830 831 ACPI_FUNCTION_TRACE_U32(__FUNCTION__, (UINT32)Event); 832 833 /* XXX Need better test for "yes, you have interrupts". */ 834 if (cold) 835 return_ACPI_STATUS(EcWaitEvent(sc, Event)); 836 837 if (EcIsLocked(sc) == 0) 838 printf("%s: EcWaitEventIntr called without EC lock!\n", 839 sc->sc_dev.dv_xname); 840 841 EcStatus = EC_CSR_READ(sc); 842 843 /* Too long? */ 844 for (i = 0; i < 10; i++) { 845 /* Check EC status against the desired event. */ 846 if ((Event == EC_EVENT_OUTPUT_BUFFER_FULL) && 847 (EcStatus & EC_FLAG_OUTPUT_BUFFER) != 0) 848 return_ACPI_STATUS(AE_OK); 849 850 if ((Event == EC_EVENT_INPUT_BUFFER_EMPTY) && 851 (EcStatus & EC_FLAG_INPUT_BUFFER) == 0) 852 return_ACPI_STATUS(AE_OK); 853 854 sc->sc_csrvalue = 0; 855 /* XXXJRT Sleeping with a lock held? */ 856 if (tsleep(&sc->sc_csrvalue, 0, "EcWait", (hz + 99) / 100) 857 != EWOULDBLOCK) 858 EcStatus = sc->sc_csrvalue; 859 else 860 EcStatus = EC_CSR_READ(sc); 861 } 862 return_ACPI_STATUS(AE_ERROR); 863 } 864 865 static ACPI_STATUS 866 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event) 867 { 868 EC_STATUS EcStatus; 869 UINT32 i = 0; 870 871 if (EcIsLocked(sc) == 0) 872 printf("%s: EcWaitEvent called without EC lock!\n", 873 sc->sc_dev.dv_xname); 874 875 /* 876 * Stall 1us: 877 * ---------- 878 * Stall for 1 microsecond before reading the status register 879 * for the first time. This allows the EC to set the IBF/OBF 880 * bit to its proper state. 881 * 882 * XXX it is not clear why we read the CSR twice. 883 */ 884 AcpiOsStall(1); 885 EcStatus = EC_CSR_READ(sc); 886 887 /* 888 * Wait For Event: 889 * --------------- 890 * Poll the EC status register to detect completion of the last 891 * command. Wait up to 10ms (in 100us chunks) for this to occur. 892 */ 893 for (i = 0; i < 100; i++) { 894 EcStatus = EC_CSR_READ(sc); 895 896 if ((Event == EC_EVENT_OUTPUT_BUFFER_FULL) && 897 (EcStatus & EC_FLAG_OUTPUT_BUFFER) != 0) 898 return AE_OK; 899 900 if ((Event == EC_EVENT_INPUT_BUFFER_EMPTY) && 901 (EcStatus & EC_FLAG_INPUT_BUFFER) == 0) 902 return AE_OK; 903 904 AcpiOsStall(10); 905 } 906 907 return AE_ERROR; 908 } 909 910 static ACPI_STATUS 911 EcQuery(struct acpi_ec_softc *sc, UINT8 *Data) 912 { 913 ACPI_STATUS rv; 914 915 if (EcIsLocked(sc) == 0) 916 printf("%s: EcQuery called without EC lock!\n", 917 sc->sc_dev.dv_xname); 918 919 EC_CSR_WRITE(sc, EC_COMMAND_QUERY); 920 rv = EcWaitEventIntr(sc, EC_EVENT_OUTPUT_BUFFER_FULL); 921 if (ACPI_SUCCESS(rv)) 922 *Data = EC_DATA_READ(sc); 923 924 if (ACPI_FAILURE(rv)) 925 printf("%s: timed out waiting for EC to respond to " 926 "EC_COMMAND_QUERY\n", sc->sc_dev.dv_xname); 927 928 return rv; 929 } 930 931 static ACPI_STATUS 932 EcTransaction(struct acpi_ec_softc *sc, EC_REQUEST *EcRequest) 933 { 934 ACPI_STATUS rv; 935 936 EcLock(sc); 937 938 /* 939 * Perform the transaction. 940 */ 941 switch (EcRequest->Command) { 942 case EC_COMMAND_READ: 943 rv = EcRead(sc, EcRequest->Address, &(EcRequest->Data)); 944 break; 945 946 case EC_COMMAND_WRITE: 947 rv = EcWrite(sc, EcRequest->Address, &(EcRequest->Data)); 948 break; 949 950 default: 951 rv = AE_SUPPORT; 952 break; 953 } 954 955 EcUnlock(sc); 956 957 return rv; 958 } 959 960 static ACPI_STATUS 961 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 962 { 963 ACPI_STATUS rv; 964 965 if (EcIsLocked(sc) == 0) 966 printf("%s: EcRead called without EC lock!\n", 967 sc->sc_dev.dv_xname); 968 969 /* EcBurstEnable(EmbeddedController); */ 970 971 EC_CSR_WRITE(sc, EC_COMMAND_READ); 972 if ((rv = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 973 AE_OK) { 974 printf("%s: EcRead: timeout waiting for EC to process " 975 "read command\n", sc->sc_dev.dv_xname); 976 return rv; 977 } 978 979 EC_DATA_WRITE(sc, Address); 980 if ((rv = EcWaitEventIntr(sc, EC_EVENT_OUTPUT_BUFFER_FULL)) != 981 AE_OK) { 982 printf("%s: EcRead: timeout waiting for EC to send data\n", 983 sc->sc_dev.dv_xname); 984 return rv; 985 } 986 987 (*Data) = EC_DATA_READ(sc); 988 989 /* EcBurstDisable(EmbeddedController); */ 990 991 return AE_OK; 992 } 993 994 static ACPI_STATUS 995 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data) 996 { 997 ACPI_STATUS rv; 998 999 if (EcIsLocked(sc) == 0) 1000 printf("%s: EcWrite called without EC lock!\n", 1001 sc->sc_dev.dv_xname); 1002 1003 /* EcBurstEnable(EmbeddedController); */ 1004 1005 EC_CSR_WRITE(sc, EC_COMMAND_WRITE); 1006 if ((rv = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 1007 AE_OK) { 1008 printf("%s: EcWrite: timeout waiting for EC to process " 1009 "write command\n", sc->sc_dev.dv_xname); 1010 return rv; 1011 } 1012 1013 EC_DATA_WRITE(sc, Address); 1014 if ((rv = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 1015 AE_OK) { 1016 printf("%s: EcWrite: timeout waiting for EC to process " 1017 "address\n", sc->sc_dev.dv_xname); 1018 return rv; 1019 } 1020 1021 EC_DATA_WRITE(sc, *Data); 1022 if ((rv = EcWaitEventIntr(sc, EC_EVENT_INPUT_BUFFER_EMPTY)) != 1023 AE_OK) { 1024 printf("%s: EcWrite: timeout waiting for EC to process " 1025 "data\n", sc->sc_dev.dv_xname); 1026 return rv; 1027 } 1028 1029 /* EcBurstDisable(EmbeddedController); */ 1030 1031 return AE_OK; 1032 } 1033