1 /* $OpenBSD: acpiec.c,v 1.53 2016/05/07 18:03:36 kettenis Exp $ */ 2 /* 3 * Copyright (c) 2006 Can Erkin Acar <canacar@openbsd.org> 4 * 5 * Permission to use, copy, modify, and distribute this software for any 6 * purpose with or without fee is hereby granted, provided that the above 7 * copyright notice and this permission notice appear in all copies. 8 * 9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16 */ 17 18 #include <sys/param.h> 19 #include <sys/signalvar.h> 20 #include <sys/systm.h> 21 #include <sys/device.h> 22 23 #include <machine/bus.h> 24 25 #include <dev/acpi/acpireg.h> 26 #include <dev/acpi/acpivar.h> 27 #include <dev/acpi/acpidev.h> 28 #include <dev/acpi/amltypes.h> 29 #include <dev/acpi/dsdt.h> 30 31 #include <sys/sensors.h> 32 33 int acpiec_match(struct device *, void *, void *); 34 void acpiec_attach(struct device *, struct device *, void *); 35 36 u_int8_t acpiec_status(struct acpiec_softc *); 37 u_int8_t acpiec_read_data(struct acpiec_softc *); 38 void acpiec_write_cmd(struct acpiec_softc *, u_int8_t); 39 void acpiec_write_data(struct acpiec_softc *, u_int8_t); 40 void acpiec_burst_enable(struct acpiec_softc *sc); 41 void acpiec_burst_disable(struct acpiec_softc *sc); 42 43 u_int8_t acpiec_read_1(struct acpiec_softc *, u_int8_t); 44 void acpiec_write_1(struct acpiec_softc *, u_int8_t, u_int8_t); 45 46 void acpiec_read(struct acpiec_softc *, u_int8_t, int, u_int8_t *); 47 void acpiec_write(struct acpiec_softc *, u_int8_t, int, u_int8_t *); 48 49 int acpiec_getcrs(struct acpiec_softc *, 50 struct acpi_attach_args *); 51 int acpiec_getregister(const u_int8_t *, int, int *, bus_size_t *); 52 53 void acpiec_wait(struct acpiec_softc *, u_int8_t, u_int8_t); 54 void acpiec_sci_event(struct acpiec_softc *); 55 56 void acpiec_get_events(struct acpiec_softc *); 57 58 int acpiec_gpehandler(struct acpi_softc *, int, void *); 59 60 void acpiec_lock(struct acpiec_softc *); 61 void acpiec_unlock(struct acpiec_softc *); 62 63 /* EC Status bits */ 64 #define EC_STAT_SMI_EVT 0x40 /* SMI event pending */ 65 #define EC_STAT_SCI_EVT 0x20 /* SCI event pending */ 66 #define EC_STAT_BURST 0x10 /* Controller in burst mode */ 67 #define EC_STAT_CMD 0x08 /* data is command */ 68 #define EC_STAT_IBF 0x02 /* input buffer full */ 69 #define EC_STAT_OBF 0x01 /* output buffer full */ 70 71 /* EC Commands */ 72 #define EC_CMD_RD 0x80 /* Read */ 73 #define EC_CMD_WR 0x81 /* Write */ 74 #define EC_CMD_BE 0x82 /* Burst Enable */ 75 #define EC_CMD_BD 0x83 /* Burst Disable */ 76 #define EC_CMD_QR 0x84 /* Query */ 77 78 int acpiec_reg(struct acpiec_softc *); 79 80 struct cfattach acpiec_ca = { 81 sizeof(struct acpiec_softc), acpiec_match, acpiec_attach 82 }; 83 84 struct cfdriver acpiec_cd = { 85 NULL, "acpiec", DV_DULL 86 }; 87 88 const char *acpiec_hids[] = { ACPI_DEV_ECD, 0 }; 89 90 void 91 acpiec_wait(struct acpiec_softc *sc, u_int8_t mask, u_int8_t val) 92 { 93 static int acpiecnowait; 94 u_int8_t stat; 95 96 dnprintf(40, "%s: EC wait_ns for: %b == %02x\n", 97 DEVNAME(sc), (int)mask, 98 "\20\x8IGN\x7SMI\x6SCI\05BURST\04CMD\03IGN\02IBF\01OBF", (int)val); 99 100 while (((stat = acpiec_status(sc)) & mask) != val) { 101 if (stat & EC_STAT_SCI_EVT) 102 sc->sc_gotsci = 1; 103 if (cold || (stat & EC_STAT_BURST)) 104 delay(1); 105 else 106 tsleep(&acpiecnowait, PWAIT, "acpiec", 1); 107 } 108 109 dnprintf(40, "%s: EC wait_ns, stat: %b\n", DEVNAME(sc), (int)stat, 110 "\20\x8IGN\x7SMI\x6SCI\05BURST\04CMD\03IGN\02IBF\01OBF"); 111 } 112 113 u_int8_t 114 acpiec_status(struct acpiec_softc *sc) 115 { 116 return (bus_space_read_1(sc->sc_cmd_bt, sc->sc_cmd_bh, 0)); 117 } 118 119 void 120 acpiec_write_data(struct acpiec_softc *sc, u_int8_t val) 121 { 122 acpiec_wait(sc, EC_STAT_IBF, 0); 123 dnprintf(40, "acpiec: write_data -- %d\n", (int)val); 124 bus_space_write_1(sc->sc_data_bt, sc->sc_data_bh, 0, val); 125 } 126 127 void 128 acpiec_write_cmd(struct acpiec_softc *sc, u_int8_t val) 129 { 130 acpiec_wait(sc, EC_STAT_IBF, 0); 131 dnprintf(40, "acpiec: write_cmd -- %d\n", (int)val); 132 bus_space_write_1(sc->sc_cmd_bt, sc->sc_cmd_bh, 0, val); 133 } 134 135 u_int8_t 136 acpiec_read_data(struct acpiec_softc *sc) 137 { 138 u_int8_t val; 139 140 acpiec_wait(sc, EC_STAT_OBF, EC_STAT_OBF); 141 val = bus_space_read_1(sc->sc_data_bt, sc->sc_data_bh, 0); 142 143 dnprintf(40, "acpiec: read_data %d\n", (int)val); 144 145 return (val); 146 } 147 148 void 149 acpiec_sci_event(struct acpiec_softc *sc) 150 { 151 u_int8_t evt; 152 153 sc->sc_gotsci = 0; 154 155 acpiec_wait(sc, EC_STAT_IBF, 0); 156 bus_space_write_1(sc->sc_cmd_bt, sc->sc_cmd_bh, 0, EC_CMD_QR); 157 158 acpiec_wait(sc, EC_STAT_OBF, EC_STAT_OBF); 159 evt = bus_space_read_1(sc->sc_data_bt, sc->sc_data_bh, 0); 160 161 if (evt) { 162 dnprintf(10, "%s: sci_event: 0x%02x\n", DEVNAME(sc), (int)evt); 163 aml_evalnode(sc->sc_acpi, sc->sc_events[evt].event, 0, NULL, 164 NULL); 165 } 166 } 167 168 u_int8_t 169 acpiec_read_1(struct acpiec_softc *sc, u_int8_t addr) 170 { 171 u_int8_t val; 172 173 if ((acpiec_status(sc) & EC_STAT_SCI_EVT) == EC_STAT_SCI_EVT) 174 sc->sc_gotsci = 1; 175 176 acpiec_write_cmd(sc, EC_CMD_RD); 177 acpiec_write_data(sc, addr); 178 179 val = acpiec_read_data(sc); 180 181 return (val); 182 } 183 184 void 185 acpiec_write_1(struct acpiec_softc *sc, u_int8_t addr, u_int8_t data) 186 { 187 if ((acpiec_status(sc) & EC_STAT_SCI_EVT) == EC_STAT_SCI_EVT) 188 sc->sc_gotsci = 1; 189 190 acpiec_write_cmd(sc, EC_CMD_WR); 191 acpiec_write_data(sc, addr); 192 acpiec_write_data(sc, data); 193 } 194 195 void 196 acpiec_burst_enable(struct acpiec_softc *sc) 197 { 198 acpiec_write_cmd(sc, EC_CMD_BE); 199 acpiec_read_data(sc); 200 } 201 202 void 203 acpiec_burst_disable(struct acpiec_softc *sc) 204 { 205 if ((acpiec_status(sc) & EC_STAT_BURST) == EC_STAT_BURST) 206 acpiec_write_cmd(sc, EC_CMD_BD); 207 } 208 209 void 210 acpiec_read(struct acpiec_softc *sc, u_int8_t addr, int len, u_int8_t *buffer) 211 { 212 int reg; 213 214 /* 215 * this works because everything runs in the acpi thread context. 216 * at some point add a lock to deal with concurrency so that a 217 * transaction does not get interrupted. 218 */ 219 dnprintf(20, "%s: read %d, %d\n", DEVNAME(sc), (int)addr, len); 220 sc->sc_ecbusy = 1; 221 acpiec_burst_enable(sc); 222 for (reg = 0; reg < len; reg++) 223 buffer[reg] = acpiec_read_1(sc, addr + reg); 224 acpiec_burst_disable(sc); 225 sc->sc_ecbusy = 0; 226 } 227 228 void 229 acpiec_write(struct acpiec_softc *sc, u_int8_t addr, int len, u_int8_t *buffer) 230 { 231 int reg; 232 233 /* 234 * this works because everything runs in the acpi thread context. 235 * at some point add a lock to deal with concurrency so that a 236 * transaction does not get interrupted. 237 */ 238 dnprintf(20, "%s: write %d, %d\n", DEVNAME(sc), (int)addr, len); 239 sc->sc_ecbusy = 1; 240 acpiec_burst_enable(sc); 241 for (reg = 0; reg < len; reg++) 242 acpiec_write_1(sc, addr + reg, buffer[reg]); 243 acpiec_burst_disable(sc); 244 sc->sc_ecbusy = 0; 245 } 246 247 int 248 acpiec_match(struct device *parent, void *match, void *aux) 249 { 250 struct acpi_attach_args *aa = aux; 251 struct cfdata *cf = match; 252 struct acpi_ecdt *ecdt = aa->aaa_table; 253 struct acpi_softc *acpisc = (struct acpi_softc *)parent; 254 255 /* Check for early ECDT table attach */ 256 if (ecdt && 257 !memcmp(ecdt->hdr.signature, ECDT_SIG, sizeof(ECDT_SIG) - 1)) 258 return (1); 259 if (acpisc->sc_ec) 260 return (0); 261 262 /* sanity */ 263 return (acpi_matchhids(aa, acpiec_hids, cf->cf_driver->cd_name)); 264 } 265 266 void 267 acpiec_attach(struct device *parent, struct device *self, void *aux) 268 { 269 struct acpiec_softc *sc = (struct acpiec_softc *)self; 270 struct acpi_attach_args *aa = aux; 271 struct aml_value res; 272 int64_t st; 273 274 sc->sc_acpi = (struct acpi_softc *)parent; 275 sc->sc_devnode = aa->aaa_node; 276 277 if (aml_evalinteger(sc->sc_acpi, sc->sc_devnode, "_STA", 0, NULL, &st)) 278 st = STA_PRESENT | STA_ENABLED | STA_DEV_OK; 279 if ((st & STA_PRESENT) == 0) { 280 printf(": not present\n"); 281 return; 282 } 283 284 if (acpiec_getcrs(sc, aa)) { 285 printf(": Failed to read resource settings\n"); 286 return; 287 } 288 289 sc->sc_acpi->sc_ec = sc; 290 291 if (acpiec_reg(sc)) { 292 printf(": Failed to register address space\n"); 293 return; 294 } 295 296 acpiec_get_events(sc); 297 298 dnprintf(10, "%s: GPE: %d\n", DEVNAME(sc), sc->sc_gpe); 299 300 #ifndef SMALL_KERNEL 301 acpi_set_gpehandler(sc->sc_acpi, sc->sc_gpe, acpiec_gpehandler, 302 sc, 1); 303 #endif 304 305 if (aml_evalname(sc->sc_acpi, sc->sc_devnode, "_GLK", 0, NULL, &res)) 306 sc->sc_glk = 0; 307 else if (res.type != AML_OBJTYPE_INTEGER) 308 sc->sc_glk = 0; 309 else 310 sc->sc_glk = res.v_integer ? 1 : 0; 311 312 printf("\n"); 313 } 314 315 void 316 acpiec_get_events(struct acpiec_softc *sc) 317 { 318 int idx; 319 char name[16]; 320 321 memset(sc->sc_events, 0, sizeof(sc->sc_events)); 322 for (idx = 0; idx < ACPIEC_MAX_EVENTS; idx++) { 323 snprintf(name, sizeof(name), "_Q%02X", idx); 324 sc->sc_events[idx].event = aml_searchname(sc->sc_devnode, name); 325 if (sc->sc_events[idx].event != NULL) 326 dnprintf(10, "%s: Found event %s\n", DEVNAME(sc), name); 327 } 328 } 329 330 int 331 acpiec_gpehandler(struct acpi_softc *acpi_sc, int gpe, void *arg) 332 { 333 struct acpiec_softc *sc = arg; 334 u_int8_t mask, stat, en; 335 int s; 336 337 KASSERT(sc->sc_ecbusy == 0); 338 dnprintf(10, "ACPIEC: got gpe\n"); 339 340 do { 341 if (sc->sc_gotsci) 342 acpiec_sci_event(sc); 343 344 stat = acpiec_status(sc); 345 dnprintf(40, "%s: EC interrupt, stat: %b\n", 346 DEVNAME(sc), (int)stat, 347 "\20\x8IGN\x7SMI\x6SCI\05BURST\04CMD\03IGN\02IBF\01OBF"); 348 349 if (stat & EC_STAT_SCI_EVT) 350 sc->sc_gotsci = 1; 351 else 352 sc->sc_gotsci = 0; 353 } while (sc->sc_gotsci); 354 355 /* Unmask the GPE which was blocked at interrupt time */ 356 s = spltty(); 357 mask = (1L << (gpe & 7)); 358 en = acpi_read_pmreg(acpi_sc, ACPIREG_GPE_EN, gpe>>3); 359 acpi_write_pmreg(acpi_sc, ACPIREG_GPE_EN, gpe>>3, en | mask); 360 splx(s); 361 362 return (0); 363 } 364 365 /* parse the resource buffer to get a 'register' value */ 366 int 367 acpiec_getregister(const u_int8_t *buf, int size, int *type, bus_size_t *addr) 368 { 369 int len, hlen; 370 371 #define RES_TYPE_MASK 0x80 372 #define RES_LENGTH_MASK 0x07 373 #define RES_TYPE_IOPORT 0x47 374 #define RES_TYPE_ENDTAG 0x79 375 376 if (size <= 0) 377 return (0); 378 379 if (*buf & RES_TYPE_MASK) { 380 /* large resource */ 381 if (size < 3) 382 return (1); 383 len = (int)buf[1] + 256 * (int)buf[2]; 384 hlen = 3; 385 } else { 386 /* small resource */ 387 len = buf[0] & RES_LENGTH_MASK; 388 hlen = 1; 389 } 390 391 /* XXX todo: decode other types */ 392 if (*buf != RES_TYPE_IOPORT) 393 return (0); 394 395 if (size < hlen + len) 396 return (0); 397 398 /* XXX validate? */ 399 *type = GAS_SYSTEM_IOSPACE; 400 *addr = (int)buf[2] + 256 * (int)buf[3]; 401 402 return (hlen + len); 403 } 404 405 int 406 acpiec_getcrs(struct acpiec_softc *sc, struct acpi_attach_args *aa) 407 { 408 struct aml_value res; 409 bus_size_t ec_sc, ec_data; 410 int dtype, ctype; 411 char *buf; 412 int size, ret; 413 int64_t gpe; 414 struct acpi_ecdt *ecdt = aa->aaa_table; 415 extern struct aml_node aml_root; 416 417 /* Check if this is ECDT initialization */ 418 if (ecdt) { 419 /* Get GPE, Data and Control segments */ 420 sc->sc_gpe = ecdt->gpe_bit; 421 422 ctype = ecdt->ec_control.address_space_id; 423 ec_sc = ecdt->ec_control.address; 424 425 dtype = ecdt->ec_data.address_space_id; 426 ec_data = ecdt->ec_data.address; 427 428 /* Get devnode from header */ 429 sc->sc_devnode = aml_searchname(&aml_root, ecdt->ec_id); 430 431 goto ecdtdone; 432 } 433 434 if (aml_evalinteger(sc->sc_acpi, sc->sc_devnode, "_GPE", 0, NULL, &gpe)) { 435 dnprintf(10, "%s: no _GPE\n", DEVNAME(sc)); 436 return (1); 437 } 438 439 sc->sc_gpe = gpe; 440 441 if (aml_evalname(sc->sc_acpi, sc->sc_devnode, "_CRS", 0, NULL, &res)) { 442 dnprintf(10, "%s: no _CRS\n", DEVNAME(sc)); 443 return (1); 444 } 445 446 /* Parse CRS to get control and data registers */ 447 448 if (res.type != AML_OBJTYPE_BUFFER) { 449 dnprintf(10, "%s: unknown _CRS type %d\n", 450 DEVNAME(sc), res.type); 451 aml_freevalue(&res); 452 return (1); 453 } 454 455 size = res.length; 456 buf = res.v_buffer; 457 458 ret = acpiec_getregister(buf, size, &dtype, &ec_data); 459 if (ret <= 0) { 460 dnprintf(10, "%s: failed to read DATA from _CRS\n", 461 DEVNAME(sc)); 462 aml_freevalue(&res); 463 return (1); 464 } 465 466 buf += ret; 467 size -= ret; 468 469 ret = acpiec_getregister(buf, size, &ctype, &ec_sc); 470 if (ret <= 0) { 471 dnprintf(10, "%s: failed to read S/C from _CRS\n", 472 DEVNAME(sc)); 473 aml_freevalue(&res); 474 return (1); 475 } 476 477 buf += ret; 478 size -= ret; 479 480 if (size != 2 || *buf != RES_TYPE_ENDTAG) { 481 dnprintf(10, "%s: no _CRS end tag\n", DEVNAME(sc)); 482 aml_freevalue(&res); 483 return (1); 484 } 485 aml_freevalue(&res); 486 487 /* XXX: todo - validate _CRS checksum? */ 488 ecdtdone: 489 490 dnprintf(10, "%s: Data: 0x%lx, S/C: 0x%lx\n", 491 DEVNAME(sc), ec_data, ec_sc); 492 493 if (ctype == GAS_SYSTEM_IOSPACE) 494 sc->sc_cmd_bt = aa->aaa_iot; 495 else 496 sc->sc_cmd_bt = aa->aaa_memt; 497 498 if (bus_space_map(sc->sc_cmd_bt, ec_sc, 1, 0, &sc->sc_cmd_bh)) { 499 dnprintf(10, "%s: failed to map S/C reg.\n", DEVNAME(sc)); 500 return (1); 501 } 502 503 if (dtype == GAS_SYSTEM_IOSPACE) 504 sc->sc_data_bt = aa->aaa_iot; 505 else 506 sc->sc_data_bt = aa->aaa_memt; 507 508 if (bus_space_map(sc->sc_data_bt, ec_data, 1, 0, &sc->sc_data_bh)) { 509 dnprintf(10, "%s: failed to map DATA reg.\n", DEVNAME(sc)); 510 bus_space_unmap(sc->sc_cmd_bt, sc->sc_cmd_bh, 1); 511 return (1); 512 } 513 514 return (0); 515 } 516 517 int 518 acpiec_reg(struct acpiec_softc *sc) 519 { 520 struct aml_value arg[2]; 521 struct aml_node *node; 522 523 memset(&arg, 0, sizeof(arg)); 524 arg[0].type = AML_OBJTYPE_INTEGER; 525 arg[0].v_integer = ACPI_OPREG_EC; 526 arg[1].type = AML_OBJTYPE_INTEGER; 527 arg[1].v_integer = 1; 528 529 node = aml_searchname(sc->sc_devnode, "_REG"); 530 if (node && aml_evalnode(sc->sc_acpi, node, 2, arg, NULL)) { 531 dnprintf(10, "%s: eval method _REG failed\n", DEVNAME(sc)); 532 printf("acpiec _REG failed, broken BIOS\n"); 533 } 534 535 return (0); 536 } 537 538 void 539 acpiec_lock(struct acpiec_softc *sc) 540 { 541 KASSERT(sc->sc_ecbusy == 0); 542 543 sc->sc_ecbusy = 1; 544 545 if (sc->sc_glk) { 546 acpi_glk_enter(); 547 } 548 } 549 550 void 551 acpiec_unlock(struct acpiec_softc *sc) 552 { 553 KASSERT(sc->sc_ecbusy == 1); 554 555 if (sc->sc_glk) { 556 acpi_glk_leave(); 557 } 558 559 sc->sc_ecbusy = 0; 560 } 561