1 /*-
2 * Copyright (c) 2003-2007 Nate Lawson
3 * Copyright (c) 2000 Michael Smith
4 * Copyright (c) 2000 BSDi
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD: releng/11.0/sys/dev/acpica/acpi_ec.c 295940 2016-02-23 23:09:45Z jkim $");
31
32 #include "opt_acpi.h"
33 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/bus.h>
36 #include <sys/lock.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
39 #include <sys/sx.h>
40
41 #include <machine/bus.h>
42 #include <machine/resource.h>
43 #include <sys/rman.h>
44
45 #include <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
47
48 #include <dev/acpica/acpivar.h>
49
50 /* Hooks for the ACPI CA debugging infrastructure */
51 #define _COMPONENT ACPI_EC
52 ACPI_MODULE_NAME("EC")
53
54 /*
55 * EC_COMMAND:
56 * -----------
57 */
58 typedef UINT8 EC_COMMAND;
59
60 #define EC_COMMAND_UNKNOWN ((EC_COMMAND) 0x00)
61 #define EC_COMMAND_READ ((EC_COMMAND) 0x80)
62 #define EC_COMMAND_WRITE ((EC_COMMAND) 0x81)
63 #define EC_COMMAND_BURST_ENABLE ((EC_COMMAND) 0x82)
64 #define EC_COMMAND_BURST_DISABLE ((EC_COMMAND) 0x83)
65 #define EC_COMMAND_QUERY ((EC_COMMAND) 0x84)
66
67 /*
68 * EC_STATUS:
69 * ----------
70 * The encoding of the EC status register is illustrated below.
71 * Note that a set bit (1) indicates the property is TRUE
72 * (e.g. if bit 0 is set then the output buffer is full).
73 * +-+-+-+-+-+-+-+-+
74 * |7|6|5|4|3|2|1|0|
75 * +-+-+-+-+-+-+-+-+
76 * | | | | | | | |
77 * | | | | | | | +- Output Buffer Full?
78 * | | | | | | +--- Input Buffer Full?
79 * | | | | | +----- <reserved>
80 * | | | | +------- Data Register is Command Byte?
81 * | | | +--------- Burst Mode Enabled?
82 * | | +----------- SCI Event?
83 * | +------------- SMI Event?
84 * +--------------- <reserved>
85 *
86 */
87 typedef UINT8 EC_STATUS;
88
89 #define EC_FLAG_OUTPUT_BUFFER ((EC_STATUS) 0x01)
90 #define EC_FLAG_INPUT_BUFFER ((EC_STATUS) 0x02)
91 #define EC_FLAG_DATA_IS_CMD ((EC_STATUS) 0x08)
92 #define EC_FLAG_BURST_MODE ((EC_STATUS) 0x10)
93
94 /*
95 * EC_EVENT:
96 * ---------
97 */
98 typedef UINT8 EC_EVENT;
99
100 #define EC_EVENT_UNKNOWN ((EC_EVENT) 0x00)
101 #define EC_EVENT_OUTPUT_BUFFER_FULL ((EC_EVENT) 0x01)
102 #define EC_EVENT_INPUT_BUFFER_EMPTY ((EC_EVENT) 0x02)
103 #define EC_EVENT_SCI ((EC_EVENT) 0x20)
104 #define EC_EVENT_SMI ((EC_EVENT) 0x40)
105
106 /* Data byte returned after burst enable indicating it was successful. */
107 #define EC_BURST_ACK 0x90
108
109 /*
110 * Register access primitives
111 */
112 #define EC_GET_DATA(sc) \
113 bus_space_read_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0)
114
115 #define EC_SET_DATA(sc, v) \
116 bus_space_write_1((sc)->ec_data_tag, (sc)->ec_data_handle, 0, (v))
117
118 #define EC_GET_CSR(sc) \
119 bus_space_read_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0)
120
121 #define EC_SET_CSR(sc, v) \
122 bus_space_write_1((sc)->ec_csr_tag, (sc)->ec_csr_handle, 0, (v))
123
124 /* Additional params to pass from the probe routine */
125 struct acpi_ec_params {
126 int glk;
127 int gpe_bit;
128 ACPI_HANDLE gpe_handle;
129 int uid;
130 };
131
132 /*
133 * Driver softc.
134 */
135 struct acpi_ec_softc {
136 device_t ec_dev;
137 ACPI_HANDLE ec_handle;
138 int ec_uid;
139 ACPI_HANDLE ec_gpehandle;
140 UINT8 ec_gpebit;
141
142 int ec_data_rid;
143 struct resource *ec_data_res;
144 bus_space_tag_t ec_data_tag;
145 bus_space_handle_t ec_data_handle;
146
147 int ec_csr_rid;
148 struct resource *ec_csr_res;
149 bus_space_tag_t ec_csr_tag;
150 bus_space_handle_t ec_csr_handle;
151
152 int ec_glk;
153 int ec_glkhandle;
154 int ec_burstactive;
155 int ec_sci_pend;
156 volatile u_int ec_gencount;
157 int ec_suspending;
158 };
159
160 /*
161 * XXX njl
162 * I couldn't find it in the spec but other implementations also use a
163 * value of 1 ms for the time to acquire global lock.
164 */
165 #define EC_LOCK_TIMEOUT 1000
166
167 /* Default delay in microseconds between each run of the status polling loop. */
168 #define EC_POLL_DELAY 50
169
170 /* Total time in ms spent waiting for a response from EC. */
171 #define EC_TIMEOUT 750
172
173 #define EVENT_READY(event, status) \
174 (((event) == EC_EVENT_OUTPUT_BUFFER_FULL && \
175 ((status) & EC_FLAG_OUTPUT_BUFFER) != 0) || \
176 ((event) == EC_EVENT_INPUT_BUFFER_EMPTY && \
177 ((status) & EC_FLAG_INPUT_BUFFER) == 0))
178
179 ACPI_SERIAL_DECL(ec, "ACPI embedded controller");
180
181 static SYSCTL_NODE(_debug_acpi, OID_AUTO, ec, CTLFLAG_RD, NULL, "EC debugging");
182
183 static int ec_burst_mode;
184 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, burst, CTLFLAG_RWTUN, &ec_burst_mode, 0,
185 "Enable use of burst mode (faster for nearly all systems)");
186 static int ec_polled_mode;
187 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, polled, CTLFLAG_RWTUN, &ec_polled_mode, 0,
188 "Force use of polled mode (only if interrupt mode doesn't work)");
189 static int ec_timeout = EC_TIMEOUT;
190 SYSCTL_INT(_debug_acpi_ec, OID_AUTO, timeout, CTLFLAG_RWTUN, &ec_timeout,
191 EC_TIMEOUT, "Total time spent waiting for a response (poll+sleep)");
192
193 static ACPI_STATUS
194 EcLock(struct acpi_ec_softc *sc)
195 {
196 ACPI_STATUS status;
197
198 /* If _GLK is non-zero, acquire the global lock. */
199 status = AE_OK;
200 if (sc->ec_glk) {
201 status = AcpiAcquireGlobalLock(EC_LOCK_TIMEOUT, &sc->ec_glkhandle);
202 if (ACPI_FAILURE(status))
203 return (status);
204 }
205 ACPI_SERIAL_BEGIN(ec);
206 return (status);
207 }
208
209 static void
210 EcUnlock(struct acpi_ec_softc *sc)
211 {
212 ACPI_SERIAL_END(ec);
213 if (sc->ec_glk)
214 AcpiReleaseGlobalLock(sc->ec_glkhandle);
215 }
216
217 static UINT32 EcGpeHandler(ACPI_HANDLE, UINT32, void *);
218 static ACPI_STATUS EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function,
219 void *Context, void **return_Context);
220 static ACPI_STATUS EcSpaceHandler(UINT32 Function,
221 ACPI_PHYSICAL_ADDRESS Address,
222 UINT32 Width, UINT64 *Value,
223 void *Context, void *RegionContext);
224 static ACPI_STATUS EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event,
225 u_int gen_count);
226 static ACPI_STATUS EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd);
227 static ACPI_STATUS EcRead(struct acpi_ec_softc *sc, UINT8 Address,
228 UINT8 *Data);
229 static ACPI_STATUS EcWrite(struct acpi_ec_softc *sc, UINT8 Address,
230 UINT8 Data);
231 static int acpi_ec_probe(device_t dev);
232 static int acpi_ec_attach(device_t dev);
233 static int acpi_ec_suspend(device_t dev);
234 static int acpi_ec_resume(device_t dev);
235 static int acpi_ec_shutdown(device_t dev);
236 static int acpi_ec_read_method(device_t dev, u_int addr,
237 UINT64 *val, int width);
238 static int acpi_ec_write_method(device_t dev, u_int addr,
239 UINT64 val, int width);
240
241 static device_method_t acpi_ec_methods[] = {
242 /* Device interface */
243 DEVMETHOD(device_probe, acpi_ec_probe),
244 DEVMETHOD(device_attach, acpi_ec_attach),
245 DEVMETHOD(device_suspend, acpi_ec_suspend),
246 DEVMETHOD(device_resume, acpi_ec_resume),
247 DEVMETHOD(device_shutdown, acpi_ec_shutdown),
248
249 /* Embedded controller interface */
250 DEVMETHOD(acpi_ec_read, acpi_ec_read_method),
251 DEVMETHOD(acpi_ec_write, acpi_ec_write_method),
252
253 DEVMETHOD_END
254 };
255
256 static driver_t acpi_ec_driver = {
257 "acpi_ec",
258 acpi_ec_methods,
259 sizeof(struct acpi_ec_softc),
260 };
261
262 static devclass_t acpi_ec_devclass;
263 DRIVER_MODULE(acpi_ec, acpi, acpi_ec_driver, acpi_ec_devclass, 0, 0);
264 MODULE_DEPEND(acpi_ec, acpi, 1, 1, 1);
265
266 /*
267 * Look for an ECDT and if we find one, set up default GPE and
268 * space handlers to catch attempts to access EC space before
269 * we have a real driver instance in place.
270 *
271 * TODO: Some old Gateway laptops need us to fake up an ECDT or
272 * otherwise attach early so that _REG methods can run.
273 */
274 void
275 acpi_ec_ecdt_probe(device_t parent)
276 {
277 ACPI_TABLE_ECDT *ecdt;
278 ACPI_STATUS status;
279 device_t child;
280 ACPI_HANDLE h;
281 struct acpi_ec_params *params;
282
283 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
284
285 /* Find and validate the ECDT. */
286 status = AcpiGetTable(ACPI_SIG_ECDT, 1, (ACPI_TABLE_HEADER **)&ecdt);
287 if (ACPI_FAILURE(status) ||
288 ecdt->Control.BitWidth != 8 ||
289 ecdt->Data.BitWidth != 8) {
290 return;
291 }
292
293 /* Create the child device with the given unit number. */
294 child = BUS_ADD_CHILD(parent, 3, "acpi_ec", ecdt->Uid);
295 if (child == NULL) {
296 printf("%s: can't add child\n", __func__);
297 return;
298 }
299
300 /* Find and save the ACPI handle for this device. */
301 status = AcpiGetHandle(NULL, ecdt->Id, &h);
302 if (ACPI_FAILURE(status)) {
303 device_delete_child(parent, child);
304 printf("%s: can't get handle\n", __func__);
305 return;
306 }
307 acpi_set_handle(child, h);
308
309 /* Set the data and CSR register addresses. */
310 bus_set_resource(child, SYS_RES_IOPORT, 0, ecdt->Data.Address,
311 /*count*/1);
312 bus_set_resource(child, SYS_RES_IOPORT, 1, ecdt->Control.Address,
313 /*count*/1);
314
315 /*
316 * Store values for the probe/attach routines to use. Store the
317 * ECDT GPE bit and set the global lock flag according to _GLK.
318 * Note that it is not perfectly correct to be evaluating a method
319 * before initializing devices, but in practice this function
320 * should be safe to call at this point.
321 */
322 params = malloc(sizeof(struct acpi_ec_params), M_TEMP, M_WAITOK | M_ZERO);
323 params->gpe_handle = NULL;
324 params->gpe_bit = ecdt->Gpe;
325 params->uid = ecdt->Uid;
326 acpi_GetInteger(h, "_GLK", ¶ms->glk);
327 acpi_set_private(child, params);
328
329 /* Finish the attach process. */
330 if (device_probe_and_attach(child) != 0)
331 device_delete_child(parent, child);
332 }
333
334 static int
335 acpi_ec_probe(device_t dev)
336 {
337 ACPI_BUFFER buf;
338 ACPI_HANDLE h;
339 ACPI_OBJECT *obj;
340 ACPI_STATUS status;
341 device_t peer;
342 char desc[64];
343 int ecdt;
344 int ret;
345 struct acpi_ec_params *params;
346 static char *ec_ids[] = { "PNP0C09", NULL };
347
348 /* Check that this is a device and that EC is not disabled. */
349 if (acpi_get_type(dev) != ACPI_TYPE_DEVICE || acpi_disabled("ec"))
350 return (ENXIO);
351
352 /*
353 * If probed via ECDT, set description and continue. Otherwise,
354 * we can access the namespace and make sure this is not a
355 * duplicate probe.
356 */
357 ret = ENXIO;
358 ecdt = 0;
359 buf.Pointer = NULL;
360 buf.Length = ACPI_ALLOCATE_BUFFER;
361 params = acpi_get_private(dev);
362 if (params != NULL) {
363 ecdt = 1;
364 ret = 0;
365 } else if (ACPI_ID_PROBE(device_get_parent(dev), dev, ec_ids)) {
366 params = malloc(sizeof(struct acpi_ec_params), M_TEMP,
367 M_WAITOK | M_ZERO);
368 h = acpi_get_handle(dev);
369
370 /*
371 * Read the unit ID to check for duplicate attach and the
372 * global lock value to see if we should acquire it when
373 * accessing the EC.
374 */
375 status = acpi_GetInteger(h, "_UID", ¶ms->uid);
376 if (ACPI_FAILURE(status))
377 params->uid = 0;
378 status = acpi_GetInteger(h, "_GLK", ¶ms->glk);
379 if (ACPI_FAILURE(status))
380 params->glk = 0;
381
382 /*
383 * Evaluate the _GPE method to find the GPE bit used by the EC to
384 * signal status (SCI). If it's a package, it contains a reference
385 * and GPE bit, similar to _PRW.
386 */
387 status = AcpiEvaluateObject(h, "_GPE", NULL, &buf);
388 if (ACPI_FAILURE(status)) {
389 device_printf(dev, "can't evaluate _GPE - %s\n",
390 AcpiFormatException(status));
391 goto out;
392 }
393 obj = (ACPI_OBJECT *)buf.Pointer;
394 if (obj == NULL)
395 goto out;
396
397 switch (obj->Type) {
398 case ACPI_TYPE_INTEGER:
399 params->gpe_handle = NULL;
400 params->gpe_bit = obj->Integer.Value;
401 break;
402 case ACPI_TYPE_PACKAGE:
403 if (!ACPI_PKG_VALID(obj, 2))
404 goto out;
405 params->gpe_handle =
406 acpi_GetReference(NULL, &obj->Package.Elements[0]);
407 if (params->gpe_handle == NULL ||
408 acpi_PkgInt32(obj, 1, ¶ms->gpe_bit) != 0)
409 goto out;
410 break;
411 default:
412 device_printf(dev, "_GPE has invalid type %d\n", obj->Type);
413 goto out;
414 }
415
416 /* Store the values we got from the namespace for attach. */
417 acpi_set_private(dev, params);
418
419 /*
420 * Check for a duplicate probe. This can happen when a probe
421 * via ECDT succeeded already. If this is a duplicate, disable
422 * this device.
423 */
424 peer = devclass_get_device(acpi_ec_devclass, params->uid);
425 if (peer == NULL || !device_is_alive(peer))
426 ret = 0;
427 else
428 device_disable(dev);
429 }
430
431 out:
432 if (ret == 0) {
433 snprintf(desc, sizeof(desc), "Embedded Controller: GPE %#x%s%s",
434 params->gpe_bit, (params->glk) ? ", GLK" : "",
435 ecdt ? ", ECDT" : "");
436 device_set_desc_copy(dev, desc);
437 } else
438 free(params, M_TEMP);
439 if (buf.Pointer)
440 AcpiOsFree(buf.Pointer);
441 return (ret);
442 }
443
444 static int
445 acpi_ec_attach(device_t dev)
446 {
447 struct acpi_ec_softc *sc;
448 struct acpi_ec_params *params;
449 ACPI_STATUS Status;
450
451 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
452
453 /* Fetch/initialize softc (assumes softc is pre-zeroed). */
454 sc = device_get_softc(dev);
455 params = acpi_get_private(dev);
456 sc->ec_dev = dev;
457 sc->ec_handle = acpi_get_handle(dev);
458
459 /* Retrieve previously probed values via device ivars. */
460 sc->ec_glk = params->glk;
461 sc->ec_gpebit = params->gpe_bit;
462 sc->ec_gpehandle = params->gpe_handle;
463 sc->ec_uid = params->uid;
464 sc->ec_suspending = FALSE;
465 acpi_set_private(dev, NULL);
466 free(params, M_TEMP);
467
468 /* Attach bus resources for data and command/status ports. */
469 sc->ec_data_rid = 0;
470 sc->ec_data_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
471 &sc->ec_data_rid, RF_ACTIVE);
472 if (sc->ec_data_res == NULL) {
473 device_printf(dev, "can't allocate data port\n");
474 goto error;
475 }
476 sc->ec_data_tag = rman_get_bustag(sc->ec_data_res);
477 sc->ec_data_handle = rman_get_bushandle(sc->ec_data_res);
478
479 sc->ec_csr_rid = 1;
480 sc->ec_csr_res = bus_alloc_resource_any(sc->ec_dev, SYS_RES_IOPORT,
481 &sc->ec_csr_rid, RF_ACTIVE);
482 if (sc->ec_csr_res == NULL) {
483 device_printf(dev, "can't allocate command/status port\n");
484 goto error;
485 }
486 sc->ec_csr_tag = rman_get_bustag(sc->ec_csr_res);
487 sc->ec_csr_handle = rman_get_bushandle(sc->ec_csr_res);
488
489 /*
490 * Install a handler for this EC's GPE bit. We want edge-triggered
491 * behavior.
492 */
493 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching GPE handler\n"));
494 Status = AcpiInstallGpeHandler(sc->ec_gpehandle, sc->ec_gpebit,
495 ACPI_GPE_EDGE_TRIGGERED, EcGpeHandler, sc);
496 if (ACPI_FAILURE(Status)) {
497 device_printf(dev, "can't install GPE handler for %s - %s\n",
498 acpi_name(sc->ec_handle), AcpiFormatException(Status));
499 goto error;
500 }
501
502 /*
503 * Install address space handler
504 */
505 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "attaching address space handler\n"));
506 Status = AcpiInstallAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
507 &EcSpaceHandler, &EcSpaceSetup, sc);
508 if (ACPI_FAILURE(Status)) {
509 device_printf(dev, "can't install address space handler for %s - %s\n",
510 acpi_name(sc->ec_handle), AcpiFormatException(Status));
511 goto error;
512 }
513
514 /* Enable runtime GPEs for the handler. */
515 Status = AcpiEnableGpe(sc->ec_gpehandle, sc->ec_gpebit);
516 if (ACPI_FAILURE(Status)) {
517 device_printf(dev, "AcpiEnableGpe failed: %s\n",
518 AcpiFormatException(Status));
519 goto error;
520 }
521
522 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES, "acpi_ec_attach complete\n"));
523 return (0);
524
525 error:
526 AcpiRemoveGpeHandler(sc->ec_gpehandle, sc->ec_gpebit, EcGpeHandler);
527 AcpiRemoveAddressSpaceHandler(sc->ec_handle, ACPI_ADR_SPACE_EC,
528 EcSpaceHandler);
529 if (sc->ec_csr_res)
530 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_csr_rid,
531 sc->ec_csr_res);
532 if (sc->ec_data_res)
533 bus_release_resource(sc->ec_dev, SYS_RES_IOPORT, sc->ec_data_rid,
534 sc->ec_data_res);
535 return (ENXIO);
536 }
537
538 static int
539 acpi_ec_suspend(device_t dev)
540 {
541 struct acpi_ec_softc *sc;
542
543 sc = device_get_softc(dev);
544 sc->ec_suspending = TRUE;
545 return (0);
546 }
547
548 static int
549 acpi_ec_resume(device_t dev)
550 {
551 struct acpi_ec_softc *sc;
552
553 sc = device_get_softc(dev);
554 sc->ec_suspending = FALSE;
555 return (0);
556 }
557
558 static int
559 acpi_ec_shutdown(device_t dev)
560 {
561 struct acpi_ec_softc *sc;
562
563 /* Disable the GPE so we don't get EC events during shutdown. */
564 sc = device_get_softc(dev);
565 AcpiDisableGpe(sc->ec_gpehandle, sc->ec_gpebit);
566 return (0);
567 }
568
569 /* Methods to allow other devices (e.g., smbat) to read/write EC space. */
570 static int
571 acpi_ec_read_method(device_t dev, u_int addr, UINT64 *val, int width)
572 {
573 struct acpi_ec_softc *sc;
574 ACPI_STATUS status;
575
576 sc = device_get_softc(dev);
577 status = EcSpaceHandler(ACPI_READ, addr, width * 8, val, sc, NULL);
578 if (ACPI_FAILURE(status))
579 return (ENXIO);
580 return (0);
581 }
582
583 static int
584 acpi_ec_write_method(device_t dev, u_int addr, UINT64 val, int width)
585 {
586 struct acpi_ec_softc *sc;
587 ACPI_STATUS status;
588
589 sc = device_get_softc(dev);
590 status = EcSpaceHandler(ACPI_WRITE, addr, width * 8, &val, sc, NULL);
591 if (ACPI_FAILURE(status))
592 return (ENXIO);
593 return (0);
594 }
595
596 static ACPI_STATUS
597 EcCheckStatus(struct acpi_ec_softc *sc, const char *msg, EC_EVENT event)
598 {
599 ACPI_STATUS status;
600 EC_STATUS ec_status;
601
602 status = AE_NO_HARDWARE_RESPONSE;
603 ec_status = EC_GET_CSR(sc);
604 if (sc->ec_burstactive && !(ec_status & EC_FLAG_BURST_MODE)) {
605 CTR1(KTR_ACPI, "ec burst disabled in waitevent (%s)", msg);
606 sc->ec_burstactive = FALSE;
607 }
608 if (EVENT_READY(event, ec_status)) {
609 CTR2(KTR_ACPI, "ec %s wait ready, status %#x", msg, ec_status);
610 status = AE_OK;
611 }
612 return (status);
613 }
614
615 static void
616 EcGpeQueryHandler(void *Context)
617 {
618 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
619 UINT8 Data;
620 ACPI_STATUS Status;
621 int retry;
622 char qxx[5];
623
624 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
625 KASSERT(Context != NULL, ("EcGpeQueryHandler called with NULL"));
626
627 /* Serialize user access with EcSpaceHandler(). */
628 Status = EcLock(sc);
629 if (ACPI_FAILURE(Status)) {
630 device_printf(sc->ec_dev, "GpeQuery lock error: %s\n",
631 AcpiFormatException(Status));
632 return;
633 }
634
635 /*
636 * Send a query command to the EC to find out which _Qxx call it
637 * wants to make. This command clears the SCI bit and also the
638 * interrupt source since we are edge-triggered. To prevent the GPE
639 * that may arise from running the query from causing another query
640 * to be queued, we clear the pending flag only after running it.
641 */
642 for (retry = 0; retry < 2; retry++) {
643 Status = EcCommand(sc, EC_COMMAND_QUERY);
644 if (ACPI_SUCCESS(Status))
645 break;
646 if (ACPI_FAILURE(EcCheckStatus(sc, "retr_check",
647 EC_EVENT_INPUT_BUFFER_EMPTY)))
648 break;
649 }
650 sc->ec_sci_pend = FALSE;
651 if (ACPI_FAILURE(Status)) {
652 EcUnlock(sc);
653 device_printf(sc->ec_dev, "GPE query failed: %s\n",
654 AcpiFormatException(Status));
655 return;
656 }
657 Data = EC_GET_DATA(sc);
658
659 /*
660 * We have to unlock before running the _Qxx method below since that
661 * method may attempt to read/write from EC address space, causing
662 * recursive acquisition of the lock.
663 */
664 EcUnlock(sc);
665
666 /* Ignore the value for "no outstanding event". (13.3.5) */
667 CTR2(KTR_ACPI, "ec query ok,%s running _Q%02X", Data ? "" : " not", Data);
668 if (Data == 0)
669 return;
670
671 /* Evaluate _Qxx to respond to the controller. */
672 snprintf(qxx, sizeof(qxx), "_Q%02X", Data);
673 AcpiUtStrupr(qxx);
674 Status = AcpiEvaluateObject(sc->ec_handle, qxx, NULL, NULL);
675 if (ACPI_FAILURE(Status) && Status != AE_NOT_FOUND) {
676 device_printf(sc->ec_dev, "evaluation of query method %s failed: %s\n",
677 qxx, AcpiFormatException(Status));
678 }
679 }
680
681 /*
682 * The GPE handler is called when IBE/OBF or SCI events occur. We are
683 * called from an unknown lock context.
684 */
685 static UINT32
686 EcGpeHandler(ACPI_HANDLE GpeDevice, UINT32 GpeNumber, void *Context)
687 {
688 struct acpi_ec_softc *sc = Context;
689 ACPI_STATUS Status;
690 EC_STATUS EcStatus;
691
692 KASSERT(Context != NULL, ("EcGpeHandler called with NULL"));
693 CTR0(KTR_ACPI, "ec gpe handler start");
694
695 /*
696 * Notify EcWaitEvent() that the status register is now fresh. If we
697 * didn't do this, it wouldn't be possible to distinguish an old IBE
698 * from a new one, for example when doing a write transaction (writing
699 * address and then data values.)
700 */
701 atomic_add_int(&sc->ec_gencount, 1);
702 wakeup(sc);
703
704 /*
705 * If the EC_SCI bit of the status register is set, queue a query handler.
706 * It will run the query and _Qxx method later, under the lock.
707 */
708 EcStatus = EC_GET_CSR(sc);
709 if ((EcStatus & EC_EVENT_SCI) && !sc->ec_sci_pend) {
710 CTR0(KTR_ACPI, "ec gpe queueing query handler");
711 Status = AcpiOsExecute(OSL_GPE_HANDLER, EcGpeQueryHandler, Context);
712 if (ACPI_SUCCESS(Status))
713 sc->ec_sci_pend = TRUE;
714 else
715 printf("EcGpeHandler: queuing GPE query handler failed\n");
716 }
717 return (ACPI_REENABLE_GPE);
718 }
719
720 static ACPI_STATUS
721 EcSpaceSetup(ACPI_HANDLE Region, UINT32 Function, void *Context,
722 void **RegionContext)
723 {
724
725 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
726
727 /*
728 * If deactivating a region, always set the output to NULL. Otherwise,
729 * just pass the context through.
730 */
731 if (Function == ACPI_REGION_DEACTIVATE)
732 *RegionContext = NULL;
733 else
734 *RegionContext = Context;
735
736 return_ACPI_STATUS (AE_OK);
737 }
738
739 static ACPI_STATUS
740 EcSpaceHandler(UINT32 Function, ACPI_PHYSICAL_ADDRESS Address, UINT32 Width,
741 UINT64 *Value, void *Context, void *RegionContext)
742 {
743 struct acpi_ec_softc *sc = (struct acpi_ec_softc *)Context;
744 ACPI_PHYSICAL_ADDRESS EcAddr;
745 UINT8 *EcData;
746 ACPI_STATUS Status;
747
748 ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, (UINT32)Address);
749
750 if (Function != ACPI_READ && Function != ACPI_WRITE)
751 return_ACPI_STATUS (AE_BAD_PARAMETER);
752 if (Width % 8 != 0 || Value == NULL || Context == NULL)
753 return_ACPI_STATUS (AE_BAD_PARAMETER);
754 if (Address + Width / 8 > 256)
755 return_ACPI_STATUS (AE_BAD_ADDRESS);
756
757 /*
758 * If booting, check if we need to run the query handler. If so, we
759 * we call it directly here since our thread taskq is not active yet.
760 */
761 if (cold || rebooting || sc->ec_suspending) {
762 if ((EC_GET_CSR(sc) & EC_EVENT_SCI)) {
763 CTR0(KTR_ACPI, "ec running gpe handler directly");
764 EcGpeQueryHandler(sc);
765 }
766 }
767
768 /* Serialize with EcGpeQueryHandler() at transaction granularity. */
769 Status = EcLock(sc);
770 if (ACPI_FAILURE(Status))
771 return_ACPI_STATUS (Status);
772
773 /* If we can't start burst mode, continue anyway. */
774 Status = EcCommand(sc, EC_COMMAND_BURST_ENABLE);
775 if (ACPI_SUCCESS(Status)) {
776 if (EC_GET_DATA(sc) == EC_BURST_ACK) {
777 CTR0(KTR_ACPI, "ec burst enabled");
778 sc->ec_burstactive = TRUE;
779 }
780 }
781
782 /* Perform the transaction(s), based on Width. */
783 EcAddr = Address;
784 EcData = (UINT8 *)Value;
785 if (Function == ACPI_READ)
786 *Value = 0;
787 do {
788 switch (Function) {
789 case ACPI_READ:
790 Status = EcRead(sc, EcAddr, EcData);
791 break;
792 case ACPI_WRITE:
793 Status = EcWrite(sc, EcAddr, *EcData);
794 break;
795 }
796 if (ACPI_FAILURE(Status))
797 break;
798 EcAddr++;
799 EcData++;
800 } while (EcAddr < Address + Width / 8);
801
802 if (sc->ec_burstactive) {
803 sc->ec_burstactive = FALSE;
804 if (ACPI_SUCCESS(EcCommand(sc, EC_COMMAND_BURST_DISABLE)))
805 CTR0(KTR_ACPI, "ec disabled burst ok");
806 }
807
808 EcUnlock(sc);
809 return_ACPI_STATUS (Status);
810 }
811
812 static ACPI_STATUS
813 EcWaitEvent(struct acpi_ec_softc *sc, EC_EVENT Event, u_int gen_count)
814 {
815 static int no_intr = 0;
816 ACPI_STATUS Status;
817 int count, i, need_poll, slp_ival;
818
819 ACPI_SERIAL_ASSERT(ec);
820 Status = AE_NO_HARDWARE_RESPONSE;
821 need_poll = cold || rebooting || ec_polled_mode || sc->ec_suspending;
822
823 /* Wait for event by polling or GPE (interrupt). */
824 if (need_poll) {
825 count = (ec_timeout * 1000) / EC_POLL_DELAY;
826 if (count == 0)
827 count = 1;
828 DELAY(10);
829 for (i = 0; i < count; i++) {
830 Status = EcCheckStatus(sc, "poll", Event);
831 if (ACPI_SUCCESS(Status))
832 break;
833 DELAY(EC_POLL_DELAY);
834 }
835 } else {
836 slp_ival = hz / 1000;
837 if (slp_ival != 0) {
838 count = ec_timeout;
839 } else {
840 /* hz has less than 1 ms resolution so scale timeout. */
841 slp_ival = 1;
842 count = ec_timeout / (1000 / hz);
843 }
844
845 /*
846 * Wait for the GPE to signal the status changed, checking the
847 * status register each time we get one. It's possible to get a
848 * GPE for an event we're not interested in here (i.e., SCI for
849 * EC query).
850 */
851 for (i = 0; i < count; i++) {
852 if (gen_count == sc->ec_gencount)
853 tsleep(sc, 0, "ecgpe", slp_ival);
854 /*
855 * Record new generation count. It's possible the GPE was
856 * just to notify us that a query is needed and we need to
857 * wait for a second GPE to signal the completion of the
858 * event we are actually waiting for.
859 */
860 Status = EcCheckStatus(sc, "sleep", Event);
861 if (ACPI_SUCCESS(Status)) {
862 if (gen_count == sc->ec_gencount)
863 no_intr++;
864 else
865 no_intr = 0;
866 break;
867 }
868 gen_count = sc->ec_gencount;
869 }
870
871 /*
872 * We finished waiting for the GPE and it never arrived. Try to
873 * read the register once and trust whatever value we got. This is
874 * the best we can do at this point.
875 */
876 if (ACPI_FAILURE(Status))
877 Status = EcCheckStatus(sc, "sleep_end", Event);
878 }
879 if (!need_poll && no_intr > 10) {
880 device_printf(sc->ec_dev,
881 "not getting interrupts, switched to polled mode\n");
882 ec_polled_mode = 1;
883 }
884 if (ACPI_FAILURE(Status))
885 CTR0(KTR_ACPI, "error: ec wait timed out");
886 return (Status);
887 }
888
889 static ACPI_STATUS
890 EcCommand(struct acpi_ec_softc *sc, EC_COMMAND cmd)
891 {
892 ACPI_STATUS status;
893 EC_EVENT event;
894 EC_STATUS ec_status;
895 u_int gen_count;
896
897 ACPI_SERIAL_ASSERT(ec);
898
899 /* Don't use burst mode if user disabled it. */
900 if (!ec_burst_mode && cmd == EC_COMMAND_BURST_ENABLE)
901 return (AE_ERROR);
902
903 /* Decide what to wait for based on command type. */
904 switch (cmd) {
905 case EC_COMMAND_READ:
906 case EC_COMMAND_WRITE:
907 case EC_COMMAND_BURST_DISABLE:
908 event = EC_EVENT_INPUT_BUFFER_EMPTY;
909 break;
910 case EC_COMMAND_QUERY:
911 case EC_COMMAND_BURST_ENABLE:
912 event = EC_EVENT_OUTPUT_BUFFER_FULL;
913 break;
914 default:
915 device_printf(sc->ec_dev, "EcCommand: invalid command %#x\n", cmd);
916 return (AE_BAD_PARAMETER);
917 }
918
919 /*
920 * Ensure empty input buffer before issuing command.
921 * Use generation count of zero to force a quick check.
922 */
923 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, 0);
924 if (ACPI_FAILURE(status))
925 return (status);
926
927 /* Run the command and wait for the chosen event. */
928 CTR1(KTR_ACPI, "ec running command %#x", cmd);
929 gen_count = sc->ec_gencount;
930 EC_SET_CSR(sc, cmd);
931 status = EcWaitEvent(sc, event, gen_count);
932 if (ACPI_SUCCESS(status)) {
933 /* If we succeeded, burst flag should now be present. */
934 if (cmd == EC_COMMAND_BURST_ENABLE) {
935 ec_status = EC_GET_CSR(sc);
936 if ((ec_status & EC_FLAG_BURST_MODE) == 0)
937 status = AE_ERROR;
938 }
939 } else
940 device_printf(sc->ec_dev, "EcCommand: no response to %#x\n", cmd);
941 return (status);
942 }
943
944 static ACPI_STATUS
945 EcRead(struct acpi_ec_softc *sc, UINT8 Address, UINT8 *Data)
946 {
947 ACPI_STATUS status;
948 u_int gen_count;
949 int retry;
950
951 ACPI_SERIAL_ASSERT(ec);
952 CTR1(KTR_ACPI, "ec read from %#x", Address);
953
954 for (retry = 0; retry < 2; retry++) {
955 status = EcCommand(sc, EC_COMMAND_READ);
956 if (ACPI_FAILURE(status))
957 return (status);
958
959 gen_count = sc->ec_gencount;
960 EC_SET_DATA(sc, Address);
961 status = EcWaitEvent(sc, EC_EVENT_OUTPUT_BUFFER_FULL, gen_count);
962 if (ACPI_SUCCESS(status)) {
963 *Data = EC_GET_DATA(sc);
964 return (AE_OK);
965 }
966 if (ACPI_FAILURE(EcCheckStatus(sc, "retr_check",
967 EC_EVENT_INPUT_BUFFER_EMPTY)))
968 break;
969 }
970 device_printf(sc->ec_dev, "EcRead: failed waiting to get data\n");
971 return (status);
972 }
973
974 static ACPI_STATUS
975 EcWrite(struct acpi_ec_softc *sc, UINT8 Address, UINT8 Data)
976 {
977 ACPI_STATUS status;
978 u_int gen_count;
979
980 ACPI_SERIAL_ASSERT(ec);
981 CTR2(KTR_ACPI, "ec write to %#x, data %#x", Address, Data);
982
983 status = EcCommand(sc, EC_COMMAND_WRITE);
984 if (ACPI_FAILURE(status))
985 return (status);
986
987 gen_count = sc->ec_gencount;
988 EC_SET_DATA(sc, Address);
989 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
990 if (ACPI_FAILURE(status)) {
991 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent address\n");
992 return (status);
993 }
994
995 gen_count = sc->ec_gencount;
996 EC_SET_DATA(sc, Data);
997 status = EcWaitEvent(sc, EC_EVENT_INPUT_BUFFER_EMPTY, gen_count);
998 if (ACPI_FAILURE(status)) {
999 device_printf(sc->ec_dev, "EcWrite: failed waiting for sent data\n");
1000 return (status);
1001 }
1002
1003 return (AE_OK);
1004 }
Cache object: a49e2f0e2df3e26159a7d24a2aa78518
|