Loading...
1/*
2 * ec.c - ACPI Embedded Controller Driver (v2.1)
3 *
4 * Copyright (C) 2006-2008 Alexey Starikovskiy <astarikovskiy@suse.de>
5 * Copyright (C) 2006 Denis Sadykov <denis.m.sadykov@intel.com>
6 * Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
7 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
8 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
9 *
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or (at
15 * your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
25 *
26 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 */
28
29/* Uncomment next line to get verbose printout */
30/* #define DEBUG */
31
32#include <linux/kernel.h>
33#include <linux/module.h>
34#include <linux/init.h>
35#include <linux/types.h>
36#include <linux/delay.h>
37#include <linux/interrupt.h>
38#include <linux/list.h>
39#include <linux/spinlock.h>
40#include <linux/slab.h>
41#include <asm/io.h>
42#include <acpi/acpi_bus.h>
43#include <acpi/acpi_drivers.h>
44#include <linux/dmi.h>
45
46#include "internal.h"
47
48#define ACPI_EC_CLASS "embedded_controller"
49#define ACPI_EC_DEVICE_NAME "Embedded Controller"
50#define ACPI_EC_FILE_INFO "info"
51
52#undef PREFIX
53#define PREFIX "ACPI: EC: "
54
55/* EC status register */
56#define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
57#define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
58#define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
59#define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
60
61/* EC commands */
62enum ec_command {
63 ACPI_EC_COMMAND_READ = 0x80,
64 ACPI_EC_COMMAND_WRITE = 0x81,
65 ACPI_EC_BURST_ENABLE = 0x82,
66 ACPI_EC_BURST_DISABLE = 0x83,
67 ACPI_EC_COMMAND_QUERY = 0x84,
68};
69
70#define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
71#define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
72#define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
73
74#define ACPI_EC_STORM_THRESHOLD 8 /* number of false interrupts
75 per one transaction */
76
77enum {
78 EC_FLAGS_QUERY_PENDING, /* Query is pending */
79 EC_FLAGS_GPE_STORM, /* GPE storm detected */
80 EC_FLAGS_HANDLERS_INSTALLED, /* Handlers for GPE and
81 * OpReg are installed */
82 EC_FLAGS_BLOCKED, /* Transactions are blocked */
83};
84
85/* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
86static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
87module_param(ec_delay, uint, 0644);
88MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
89
90/* If we find an EC via the ECDT, we need to keep a ptr to its context */
91/* External interfaces use first EC only, so remember */
92typedef int (*acpi_ec_query_func) (void *data);
93
94struct acpi_ec_query_handler {
95 struct list_head node;
96 acpi_ec_query_func func;
97 acpi_handle handle;
98 void *data;
99 u8 query_bit;
100};
101
102struct transaction {
103 const u8 *wdata;
104 u8 *rdata;
105 unsigned short irq_count;
106 u8 command;
107 u8 wi;
108 u8 ri;
109 u8 wlen;
110 u8 rlen;
111 bool done;
112};
113
114struct acpi_ec *boot_ec, *first_ec;
115EXPORT_SYMBOL(first_ec);
116
117static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
118static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
119static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
120
121/* --------------------------------------------------------------------------
122 Transaction Management
123 -------------------------------------------------------------------------- */
124
125static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
126{
127 u8 x = inb(ec->command_addr);
128 pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
129 return x;
130}
131
132static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
133{
134 u8 x = inb(ec->data_addr);
135 pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
136 return x;
137}
138
139static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
140{
141 pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
142 outb(command, ec->command_addr);
143}
144
145static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
146{
147 pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
148 outb(data, ec->data_addr);
149}
150
151static int ec_transaction_done(struct acpi_ec *ec)
152{
153 unsigned long flags;
154 int ret = 0;
155 spin_lock_irqsave(&ec->curr_lock, flags);
156 if (!ec->curr || ec->curr->done)
157 ret = 1;
158 spin_unlock_irqrestore(&ec->curr_lock, flags);
159 return ret;
160}
161
162static void start_transaction(struct acpi_ec *ec)
163{
164 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
165 ec->curr->done = false;
166 acpi_ec_write_cmd(ec, ec->curr->command);
167}
168
169static void advance_transaction(struct acpi_ec *ec, u8 status)
170{
171 unsigned long flags;
172 spin_lock_irqsave(&ec->curr_lock, flags);
173 if (!ec->curr)
174 goto unlock;
175 if (ec->curr->wlen > ec->curr->wi) {
176 if ((status & ACPI_EC_FLAG_IBF) == 0)
177 acpi_ec_write_data(ec,
178 ec->curr->wdata[ec->curr->wi++]);
179 else
180 goto err;
181 } else if (ec->curr->rlen > ec->curr->ri) {
182 if ((status & ACPI_EC_FLAG_OBF) == 1) {
183 ec->curr->rdata[ec->curr->ri++] = acpi_ec_read_data(ec);
184 if (ec->curr->rlen == ec->curr->ri)
185 ec->curr->done = true;
186 } else
187 goto err;
188 } else if (ec->curr->wlen == ec->curr->wi &&
189 (status & ACPI_EC_FLAG_IBF) == 0)
190 ec->curr->done = true;
191 goto unlock;
192err:
193 /* false interrupt, state didn't change */
194 if (in_interrupt())
195 ++ec->curr->irq_count;
196unlock:
197 spin_unlock_irqrestore(&ec->curr_lock, flags);
198}
199
200static int acpi_ec_sync_query(struct acpi_ec *ec);
201
202static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
203{
204 if (state & ACPI_EC_FLAG_SCI) {
205 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
206 return acpi_ec_sync_query(ec);
207 }
208 return 0;
209}
210
211static int ec_poll(struct acpi_ec *ec)
212{
213 unsigned long flags;
214 int repeat = 2; /* number of command restarts */
215 while (repeat--) {
216 unsigned long delay = jiffies +
217 msecs_to_jiffies(ec_delay);
218 do {
219 /* don't sleep with disabled interrupts */
220 if (EC_FLAGS_MSI || irqs_disabled()) {
221 udelay(ACPI_EC_MSI_UDELAY);
222 if (ec_transaction_done(ec))
223 return 0;
224 } else {
225 if (wait_event_timeout(ec->wait,
226 ec_transaction_done(ec),
227 msecs_to_jiffies(1)))
228 return 0;
229 }
230 advance_transaction(ec, acpi_ec_read_status(ec));
231 } while (time_before(jiffies, delay));
232 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
233 break;
234 pr_debug(PREFIX "controller reset, restart transaction\n");
235 spin_lock_irqsave(&ec->curr_lock, flags);
236 start_transaction(ec);
237 spin_unlock_irqrestore(&ec->curr_lock, flags);
238 }
239 return -ETIME;
240}
241
242static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
243 struct transaction *t)
244{
245 unsigned long tmp;
246 int ret = 0;
247 if (EC_FLAGS_MSI)
248 udelay(ACPI_EC_MSI_UDELAY);
249 /* start transaction */
250 spin_lock_irqsave(&ec->curr_lock, tmp);
251 /* following two actions should be kept atomic */
252 ec->curr = t;
253 start_transaction(ec);
254 if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
255 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
256 spin_unlock_irqrestore(&ec->curr_lock, tmp);
257 ret = ec_poll(ec);
258 spin_lock_irqsave(&ec->curr_lock, tmp);
259 ec->curr = NULL;
260 spin_unlock_irqrestore(&ec->curr_lock, tmp);
261 return ret;
262}
263
264static int ec_check_ibf0(struct acpi_ec *ec)
265{
266 u8 status = acpi_ec_read_status(ec);
267 return (status & ACPI_EC_FLAG_IBF) == 0;
268}
269
270static int ec_wait_ibf0(struct acpi_ec *ec)
271{
272 unsigned long delay = jiffies + msecs_to_jiffies(ec_delay);
273 /* interrupt wait manually if GPE mode is not active */
274 while (time_before(jiffies, delay))
275 if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
276 msecs_to_jiffies(1)))
277 return 0;
278 return -ETIME;
279}
280
281static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
282{
283 int status;
284 u32 glk;
285 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
286 return -EINVAL;
287 if (t->rdata)
288 memset(t->rdata, 0, t->rlen);
289 mutex_lock(&ec->lock);
290 if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) {
291 status = -EINVAL;
292 goto unlock;
293 }
294 if (ec->global_lock) {
295 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
296 if (ACPI_FAILURE(status)) {
297 status = -ENODEV;
298 goto unlock;
299 }
300 }
301 if (ec_wait_ibf0(ec)) {
302 pr_err(PREFIX "input buffer is not empty, "
303 "aborting transaction\n");
304 status = -ETIME;
305 goto end;
306 }
307 pr_debug(PREFIX "transaction start\n");
308 /* disable GPE during transaction if storm is detected */
309 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
310 /* It has to be disabled, so that it doesn't trigger. */
311 acpi_disable_gpe(NULL, ec->gpe);
312 }
313
314 status = acpi_ec_transaction_unlocked(ec, t);
315
316 /* check if we received SCI during transaction */
317 ec_check_sci_sync(ec, acpi_ec_read_status(ec));
318 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
319 msleep(1);
320 /* It is safe to enable the GPE outside of the transaction. */
321 acpi_enable_gpe(NULL, ec->gpe);
322 } else if (t->irq_count > ACPI_EC_STORM_THRESHOLD) {
323 pr_info(PREFIX "GPE storm detected, "
324 "transactions will use polling mode\n");
325 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
326 }
327 pr_debug(PREFIX "transaction end\n");
328end:
329 if (ec->global_lock)
330 acpi_release_global_lock(glk);
331unlock:
332 mutex_unlock(&ec->lock);
333 return status;
334}
335
336static int acpi_ec_burst_enable(struct acpi_ec *ec)
337{
338 u8 d;
339 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
340 .wdata = NULL, .rdata = &d,
341 .wlen = 0, .rlen = 1};
342
343 return acpi_ec_transaction(ec, &t);
344}
345
346static int acpi_ec_burst_disable(struct acpi_ec *ec)
347{
348 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
349 .wdata = NULL, .rdata = NULL,
350 .wlen = 0, .rlen = 0};
351
352 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
353 acpi_ec_transaction(ec, &t) : 0;
354}
355
356static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
357{
358 int result;
359 u8 d;
360 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
361 .wdata = &address, .rdata = &d,
362 .wlen = 1, .rlen = 1};
363
364 result = acpi_ec_transaction(ec, &t);
365 *data = d;
366 return result;
367}
368
369static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
370{
371 u8 wdata[2] = { address, data };
372 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
373 .wdata = wdata, .rdata = NULL,
374 .wlen = 2, .rlen = 0};
375
376 return acpi_ec_transaction(ec, &t);
377}
378
379/*
380 * Externally callable EC access functions. For now, assume 1 EC only
381 */
382int ec_burst_enable(void)
383{
384 if (!first_ec)
385 return -ENODEV;
386 return acpi_ec_burst_enable(first_ec);
387}
388
389EXPORT_SYMBOL(ec_burst_enable);
390
391int ec_burst_disable(void)
392{
393 if (!first_ec)
394 return -ENODEV;
395 return acpi_ec_burst_disable(first_ec);
396}
397
398EXPORT_SYMBOL(ec_burst_disable);
399
400int ec_read(u8 addr, u8 * val)
401{
402 int err;
403 u8 temp_data;
404
405 if (!first_ec)
406 return -ENODEV;
407
408 err = acpi_ec_read(first_ec, addr, &temp_data);
409
410 if (!err) {
411 *val = temp_data;
412 return 0;
413 } else
414 return err;
415}
416
417EXPORT_SYMBOL(ec_read);
418
419int ec_write(u8 addr, u8 val)
420{
421 int err;
422
423 if (!first_ec)
424 return -ENODEV;
425
426 err = acpi_ec_write(first_ec, addr, val);
427
428 return err;
429}
430
431EXPORT_SYMBOL(ec_write);
432
433int ec_transaction(u8 command,
434 const u8 * wdata, unsigned wdata_len,
435 u8 * rdata, unsigned rdata_len)
436{
437 struct transaction t = {.command = command,
438 .wdata = wdata, .rdata = rdata,
439 .wlen = wdata_len, .rlen = rdata_len};
440 if (!first_ec)
441 return -ENODEV;
442
443 return acpi_ec_transaction(first_ec, &t);
444}
445
446EXPORT_SYMBOL(ec_transaction);
447
448void acpi_ec_block_transactions(void)
449{
450 struct acpi_ec *ec = first_ec;
451
452 if (!ec)
453 return;
454
455 mutex_lock(&ec->lock);
456 /* Prevent transactions from being carried out */
457 set_bit(EC_FLAGS_BLOCKED, &ec->flags);
458 mutex_unlock(&ec->lock);
459}
460
461void acpi_ec_unblock_transactions(void)
462{
463 struct acpi_ec *ec = first_ec;
464
465 if (!ec)
466 return;
467
468 mutex_lock(&ec->lock);
469 /* Allow transactions to be carried out again */
470 clear_bit(EC_FLAGS_BLOCKED, &ec->flags);
471 mutex_unlock(&ec->lock);
472}
473
474void acpi_ec_unblock_transactions_early(void)
475{
476 /*
477 * Allow transactions to happen again (this function is called from
478 * atomic context during wakeup, so we don't need to acquire the mutex).
479 */
480 if (first_ec)
481 clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags);
482}
483
484static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
485{
486 int result;
487 u8 d;
488 struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
489 .wdata = NULL, .rdata = &d,
490 .wlen = 0, .rlen = 1};
491 if (!ec || !data)
492 return -EINVAL;
493 /*
494 * Query the EC to find out which _Qxx method we need to evaluate.
495 * Note that successful completion of the query causes the ACPI_EC_SCI
496 * bit to be cleared (and thus clearing the interrupt source).
497 */
498 result = acpi_ec_transaction_unlocked(ec, &t);
499 if (result)
500 return result;
501 if (!d)
502 return -ENODATA;
503 *data = d;
504 return 0;
505}
506
507/* --------------------------------------------------------------------------
508 Event Management
509 -------------------------------------------------------------------------- */
510int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
511 acpi_handle handle, acpi_ec_query_func func,
512 void *data)
513{
514 struct acpi_ec_query_handler *handler =
515 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
516 if (!handler)
517 return -ENOMEM;
518
519 handler->query_bit = query_bit;
520 handler->handle = handle;
521 handler->func = func;
522 handler->data = data;
523 mutex_lock(&ec->lock);
524 list_add(&handler->node, &ec->list);
525 mutex_unlock(&ec->lock);
526 return 0;
527}
528
529EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
530
531void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
532{
533 struct acpi_ec_query_handler *handler, *tmp;
534 mutex_lock(&ec->lock);
535 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
536 if (query_bit == handler->query_bit) {
537 list_del(&handler->node);
538 kfree(handler);
539 }
540 }
541 mutex_unlock(&ec->lock);
542}
543
544EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
545
546static void acpi_ec_run(void *cxt)
547{
548 struct acpi_ec_query_handler *handler = cxt;
549 if (!handler)
550 return;
551 pr_debug(PREFIX "start query execution\n");
552 if (handler->func)
553 handler->func(handler->data);
554 else if (handler->handle)
555 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
556 pr_debug(PREFIX "stop query execution\n");
557 kfree(handler);
558}
559
560static int acpi_ec_sync_query(struct acpi_ec *ec)
561{
562 u8 value = 0;
563 int status;
564 struct acpi_ec_query_handler *handler, *copy;
565 if ((status = acpi_ec_query_unlocked(ec, &value)))
566 return status;
567 list_for_each_entry(handler, &ec->list, node) {
568 if (value == handler->query_bit) {
569 /* have custom handler for this bit */
570 copy = kmalloc(sizeof(*handler), GFP_KERNEL);
571 if (!copy)
572 return -ENOMEM;
573 memcpy(copy, handler, sizeof(*copy));
574 pr_debug(PREFIX "push query execution (0x%2x) on queue\n", value);
575 return acpi_os_execute((copy->func) ?
576 OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
577 acpi_ec_run, copy);
578 }
579 }
580 return 0;
581}
582
583static void acpi_ec_gpe_query(void *ec_cxt)
584{
585 struct acpi_ec *ec = ec_cxt;
586 if (!ec)
587 return;
588 mutex_lock(&ec->lock);
589 acpi_ec_sync_query(ec);
590 mutex_unlock(&ec->lock);
591}
592
593static int ec_check_sci(struct acpi_ec *ec, u8 state)
594{
595 if (state & ACPI_EC_FLAG_SCI) {
596 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
597 pr_debug(PREFIX "push gpe query to the queue\n");
598 return acpi_os_execute(OSL_NOTIFY_HANDLER,
599 acpi_ec_gpe_query, ec);
600 }
601 }
602 return 0;
603}
604
605static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
606 u32 gpe_number, void *data)
607{
608 struct acpi_ec *ec = data;
609
610 pr_debug(PREFIX "~~~> interrupt\n");
611
612 advance_transaction(ec, acpi_ec_read_status(ec));
613 if (ec_transaction_done(ec) &&
614 (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) {
615 wake_up(&ec->wait);
616 ec_check_sci(ec, acpi_ec_read_status(ec));
617 }
618 return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE;
619}
620
621/* --------------------------------------------------------------------------
622 Address Space Management
623 -------------------------------------------------------------------------- */
624
625static acpi_status
626acpi_ec_space_handler(u32 function, acpi_physical_address address,
627 u32 bits, u64 *value64,
628 void *handler_context, void *region_context)
629{
630 struct acpi_ec *ec = handler_context;
631 int result = 0, i, bytes = bits / 8;
632 u8 *value = (u8 *)value64;
633
634 if ((address > 0xFF) || !value || !handler_context)
635 return AE_BAD_PARAMETER;
636
637 if (function != ACPI_READ && function != ACPI_WRITE)
638 return AE_BAD_PARAMETER;
639
640 if (EC_FLAGS_MSI || bits > 8)
641 acpi_ec_burst_enable(ec);
642
643 for (i = 0; i < bytes; ++i, ++address, ++value)
644 result = (function == ACPI_READ) ?
645 acpi_ec_read(ec, address, value) :
646 acpi_ec_write(ec, address, *value);
647
648 if (EC_FLAGS_MSI || bits > 8)
649 acpi_ec_burst_disable(ec);
650
651 switch (result) {
652 case -EINVAL:
653 return AE_BAD_PARAMETER;
654 break;
655 case -ENODEV:
656 return AE_NOT_FOUND;
657 break;
658 case -ETIME:
659 return AE_TIME;
660 break;
661 default:
662 return AE_OK;
663 }
664}
665
666/* --------------------------------------------------------------------------
667 Driver Interface
668 -------------------------------------------------------------------------- */
669static acpi_status
670ec_parse_io_ports(struct acpi_resource *resource, void *context);
671
672static struct acpi_ec *make_acpi_ec(void)
673{
674 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
675 if (!ec)
676 return NULL;
677 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
678 mutex_init(&ec->lock);
679 init_waitqueue_head(&ec->wait);
680 INIT_LIST_HEAD(&ec->list);
681 spin_lock_init(&ec->curr_lock);
682 return ec;
683}
684
685static acpi_status
686acpi_ec_register_query_methods(acpi_handle handle, u32 level,
687 void *context, void **return_value)
688{
689 char node_name[5];
690 struct acpi_buffer buffer = { sizeof(node_name), node_name };
691 struct acpi_ec *ec = context;
692 int value = 0;
693 acpi_status status;
694
695 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
696
697 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
698 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
699 }
700 return AE_OK;
701}
702
703static acpi_status
704ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
705{
706 acpi_status status;
707 unsigned long long tmp = 0;
708
709 struct acpi_ec *ec = context;
710
711 /* clear addr values, ec_parse_io_ports depend on it */
712 ec->command_addr = ec->data_addr = 0;
713
714 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
715 ec_parse_io_ports, ec);
716 if (ACPI_FAILURE(status))
717 return status;
718
719 /* Get GPE bit assignment (EC events). */
720 /* TODO: Add support for _GPE returning a package */
721 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
722 if (ACPI_FAILURE(status))
723 return status;
724 ec->gpe = tmp;
725 /* Use the global lock for all EC transactions? */
726 tmp = 0;
727 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
728 ec->global_lock = tmp;
729 ec->handle = handle;
730 return AE_CTRL_TERMINATE;
731}
732
733static int ec_install_handlers(struct acpi_ec *ec)
734{
735 acpi_status status;
736 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
737 return 0;
738 status = acpi_install_gpe_handler(NULL, ec->gpe,
739 ACPI_GPE_EDGE_TRIGGERED,
740 &acpi_ec_gpe_handler, ec);
741 if (ACPI_FAILURE(status))
742 return -ENODEV;
743
744 acpi_enable_gpe(NULL, ec->gpe);
745 status = acpi_install_address_space_handler(ec->handle,
746 ACPI_ADR_SPACE_EC,
747 &acpi_ec_space_handler,
748 NULL, ec);
749 if (ACPI_FAILURE(status)) {
750 if (status == AE_NOT_FOUND) {
751 /*
752 * Maybe OS fails in evaluating the _REG object.
753 * The AE_NOT_FOUND error will be ignored and OS
754 * continue to initialize EC.
755 */
756 printk(KERN_ERR "Fail in evaluating the _REG object"
757 " of EC device. Broken bios is suspected.\n");
758 } else {
759 acpi_remove_gpe_handler(NULL, ec->gpe,
760 &acpi_ec_gpe_handler);
761 acpi_disable_gpe(NULL, ec->gpe);
762 return -ENODEV;
763 }
764 }
765
766 set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
767 return 0;
768}
769
770static void ec_remove_handlers(struct acpi_ec *ec)
771{
772 acpi_disable_gpe(NULL, ec->gpe);
773 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
774 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
775 pr_err(PREFIX "failed to remove space handler\n");
776 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
777 &acpi_ec_gpe_handler)))
778 pr_err(PREFIX "failed to remove gpe handler\n");
779 clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
780}
781
782static int acpi_ec_add(struct acpi_device *device)
783{
784 struct acpi_ec *ec = NULL;
785 int ret;
786
787 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
788 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
789
790 /* Check for boot EC */
791 if (boot_ec &&
792 (boot_ec->handle == device->handle ||
793 boot_ec->handle == ACPI_ROOT_OBJECT)) {
794 ec = boot_ec;
795 boot_ec = NULL;
796 } else {
797 ec = make_acpi_ec();
798 if (!ec)
799 return -ENOMEM;
800 }
801 if (ec_parse_device(device->handle, 0, ec, NULL) !=
802 AE_CTRL_TERMINATE) {
803 kfree(ec);
804 return -EINVAL;
805 }
806
807 /* Find and register all query methods */
808 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
809 acpi_ec_register_query_methods, NULL, ec, NULL);
810
811 if (!first_ec)
812 first_ec = ec;
813 device->driver_data = ec;
814
815 WARN(!request_region(ec->data_addr, 1, "EC data"),
816 "Could not request EC data io port 0x%lx", ec->data_addr);
817 WARN(!request_region(ec->command_addr, 1, "EC cmd"),
818 "Could not request EC cmd io port 0x%lx", ec->command_addr);
819
820 pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
821 ec->gpe, ec->command_addr, ec->data_addr);
822
823 ret = ec_install_handlers(ec);
824
825 /* EC is fully operational, allow queries */
826 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
827 return ret;
828}
829
830static int acpi_ec_remove(struct acpi_device *device, int type)
831{
832 struct acpi_ec *ec;
833 struct acpi_ec_query_handler *handler, *tmp;
834
835 if (!device)
836 return -EINVAL;
837
838 ec = acpi_driver_data(device);
839 ec_remove_handlers(ec);
840 mutex_lock(&ec->lock);
841 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
842 list_del(&handler->node);
843 kfree(handler);
844 }
845 mutex_unlock(&ec->lock);
846 release_region(ec->data_addr, 1);
847 release_region(ec->command_addr, 1);
848 device->driver_data = NULL;
849 if (ec == first_ec)
850 first_ec = NULL;
851 kfree(ec);
852 return 0;
853}
854
855static acpi_status
856ec_parse_io_ports(struct acpi_resource *resource, void *context)
857{
858 struct acpi_ec *ec = context;
859
860 if (resource->type != ACPI_RESOURCE_TYPE_IO)
861 return AE_OK;
862
863 /*
864 * The first address region returned is the data port, and
865 * the second address region returned is the status/command
866 * port.
867 */
868 if (ec->data_addr == 0)
869 ec->data_addr = resource->data.io.minimum;
870 else if (ec->command_addr == 0)
871 ec->command_addr = resource->data.io.minimum;
872 else
873 return AE_CTRL_TERMINATE;
874
875 return AE_OK;
876}
877
878int __init acpi_boot_ec_enable(void)
879{
880 if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
881 return 0;
882 if (!ec_install_handlers(boot_ec)) {
883 first_ec = boot_ec;
884 return 0;
885 }
886 return -EFAULT;
887}
888
889static const struct acpi_device_id ec_device_ids[] = {
890 {"PNP0C09", 0},
891 {"", 0},
892};
893
894/* Some BIOS do not survive early DSDT scan, skip it */
895static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
896{
897 EC_FLAGS_SKIP_DSDT_SCAN = 1;
898 return 0;
899}
900
901/* ASUStek often supplies us with broken ECDT, validate it */
902static int ec_validate_ecdt(const struct dmi_system_id *id)
903{
904 EC_FLAGS_VALIDATE_ECDT = 1;
905 return 0;
906}
907
908/* MSI EC needs special treatment, enable it */
909static int ec_flag_msi(const struct dmi_system_id *id)
910{
911 printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
912 EC_FLAGS_MSI = 1;
913 EC_FLAGS_VALIDATE_ECDT = 1;
914 return 0;
915}
916
917static struct dmi_system_id __initdata ec_dmi_table[] = {
918 {
919 ec_skip_dsdt_scan, "Compal JFL92", {
920 DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
921 DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
922 {
923 ec_flag_msi, "MSI hardware", {
924 DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
925 {
926 ec_flag_msi, "MSI hardware", {
927 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
928 {
929 ec_flag_msi, "MSI hardware", {
930 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
931 {
932 ec_flag_msi, "MSI hardware", {
933 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL},
934 {
935 ec_flag_msi, "Quanta hardware", {
936 DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
937 DMI_MATCH(DMI_PRODUCT_NAME, "TW8/SW8/DW8"),}, NULL},
938 {
939 ec_flag_msi, "Quanta hardware", {
940 DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
941 DMI_MATCH(DMI_PRODUCT_NAME, "TW9/SW9"),}, NULL},
942 {
943 ec_validate_ecdt, "ASUS hardware", {
944 DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
945 {
946 ec_validate_ecdt, "ASUS hardware", {
947 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL},
948 {},
949};
950
951
952int __init acpi_ec_ecdt_probe(void)
953{
954 acpi_status status;
955 struct acpi_ec *saved_ec = NULL;
956 struct acpi_table_ecdt *ecdt_ptr;
957
958 boot_ec = make_acpi_ec();
959 if (!boot_ec)
960 return -ENOMEM;
961 /*
962 * Generate a boot ec context
963 */
964 dmi_check_system(ec_dmi_table);
965 status = acpi_get_table(ACPI_SIG_ECDT, 1,
966 (struct acpi_table_header **)&ecdt_ptr);
967 if (ACPI_SUCCESS(status)) {
968 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
969 boot_ec->command_addr = ecdt_ptr->control.address;
970 boot_ec->data_addr = ecdt_ptr->data.address;
971 boot_ec->gpe = ecdt_ptr->gpe;
972 boot_ec->handle = ACPI_ROOT_OBJECT;
973 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
974 /* Don't trust ECDT, which comes from ASUSTek */
975 if (!EC_FLAGS_VALIDATE_ECDT)
976 goto install;
977 saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
978 if (!saved_ec)
979 return -ENOMEM;
980 /* fall through */
981 }
982
983 if (EC_FLAGS_SKIP_DSDT_SCAN)
984 return -ENODEV;
985
986 /* This workaround is needed only on some broken machines,
987 * which require early EC, but fail to provide ECDT */
988 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
989 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
990 boot_ec, NULL);
991 /* Check that acpi_get_devices actually find something */
992 if (ACPI_FAILURE(status) || !boot_ec->handle)
993 goto error;
994 if (saved_ec) {
995 /* try to find good ECDT from ASUSTek */
996 if (saved_ec->command_addr != boot_ec->command_addr ||
997 saved_ec->data_addr != boot_ec->data_addr ||
998 saved_ec->gpe != boot_ec->gpe ||
999 saved_ec->handle != boot_ec->handle)
1000 pr_info(PREFIX "ASUSTek keeps feeding us with broken "
1001 "ECDT tables, which are very hard to workaround. "
1002 "Trying to use DSDT EC info instead. Please send "
1003 "output of acpidump to linux-acpi@vger.kernel.org\n");
1004 kfree(saved_ec);
1005 saved_ec = NULL;
1006 } else {
1007 /* We really need to limit this workaround, the only ASUS,
1008 * which needs it, has fake EC._INI method, so use it as flag.
1009 * Keep boot_ec struct as it will be needed soon.
1010 */
1011 acpi_handle dummy;
1012 if (!dmi_name_in_vendors("ASUS") ||
1013 ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI",
1014 &dummy)))
1015 return -ENODEV;
1016 }
1017install:
1018 if (!ec_install_handlers(boot_ec)) {
1019 first_ec = boot_ec;
1020 return 0;
1021 }
1022error:
1023 kfree(boot_ec);
1024 boot_ec = NULL;
1025 return -ENODEV;
1026}
1027
1028static struct acpi_driver acpi_ec_driver = {
1029 .name = "ec",
1030 .class = ACPI_EC_CLASS,
1031 .ids = ec_device_ids,
1032 .ops = {
1033 .add = acpi_ec_add,
1034 .remove = acpi_ec_remove,
1035 },
1036};
1037
1038int __init acpi_ec_init(void)
1039{
1040 int result = 0;
1041
1042 /* Now register the driver for the EC */
1043 result = acpi_bus_register_driver(&acpi_ec_driver);
1044 if (result < 0)
1045 return -ENODEV;
1046
1047 return result;
1048}
1049
1050/* EC driver currently not unloadable */
1051#if 0
1052static void __exit acpi_ec_exit(void)
1053{
1054
1055 acpi_bus_unregister_driver(&acpi_ec_driver);
1056 return;
1057}
1058#endif /* 0 */
1/*
2 * ec.c - ACPI Embedded Controller Driver (v3)
3 *
4 * Copyright (C) 2001-2015 Intel Corporation
5 * Author: 2014, 2015 Lv Zheng <lv.zheng@intel.com>
6 * 2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
7 * 2006 Denis Sadykov <denis.m.sadykov@intel.com>
8 * 2004 Luming Yu <luming.yu@intel.com>
9 * 2001, 2002 Andy Grover <andrew.grover@intel.com>
10 * 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
11 * Copyright (C) 2008 Alexey Starikovskiy <astarikovskiy@suse.de>
12 *
13 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 *
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or (at
18 * your option) any later version.
19 *
20 * This program is distributed in the hope that it will be useful, but
21 * WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * General Public License for more details.
24 *
25 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 */
27
28/* Uncomment next line to get verbose printout */
29/* #define DEBUG */
30#define pr_fmt(fmt) "ACPI: EC: " fmt
31
32#include <linux/kernel.h>
33#include <linux/module.h>
34#include <linux/init.h>
35#include <linux/types.h>
36#include <linux/delay.h>
37#include <linux/interrupt.h>
38#include <linux/list.h>
39#include <linux/spinlock.h>
40#include <linux/slab.h>
41#include <linux/acpi.h>
42#include <linux/dmi.h>
43#include <asm/io.h>
44
45#include "internal.h"
46
47#define ACPI_EC_CLASS "embedded_controller"
48#define ACPI_EC_DEVICE_NAME "Embedded Controller"
49#define ACPI_EC_FILE_INFO "info"
50
51/* EC status register */
52#define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
53#define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
54#define ACPI_EC_FLAG_CMD 0x08 /* Input buffer contains a command */
55#define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
56#define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
57
58/*
59 * The SCI_EVT clearing timing is not defined by the ACPI specification.
60 * This leads to lots of practical timing issues for the host EC driver.
61 * The following variations are defined (from the target EC firmware's
62 * perspective):
63 * STATUS: After indicating SCI_EVT edge triggered IRQ to the host, the
64 * target can clear SCI_EVT at any time so long as the host can see
65 * the indication by reading the status register (EC_SC). So the
66 * host should re-check SCI_EVT after the first time the SCI_EVT
67 * indication is seen, which is the same time the query request
68 * (QR_EC) is written to the command register (EC_CMD). SCI_EVT set
69 * at any later time could indicate another event. Normally such
70 * kind of EC firmware has implemented an event queue and will
71 * return 0x00 to indicate "no outstanding event".
72 * QUERY: After seeing the query request (QR_EC) written to the command
73 * register (EC_CMD) by the host and having prepared the responding
74 * event value in the data register (EC_DATA), the target can safely
75 * clear SCI_EVT because the target can confirm that the current
76 * event is being handled by the host. The host then should check
77 * SCI_EVT right after reading the event response from the data
78 * register (EC_DATA).
79 * EVENT: After seeing the event response read from the data register
80 * (EC_DATA) by the host, the target can clear SCI_EVT. As the
81 * target requires time to notice the change in the data register
82 * (EC_DATA), the host may be required to wait additional guarding
83 * time before checking the SCI_EVT again. Such guarding may not be
84 * necessary if the host is notified via another IRQ.
85 */
86#define ACPI_EC_EVT_TIMING_STATUS 0x00
87#define ACPI_EC_EVT_TIMING_QUERY 0x01
88#define ACPI_EC_EVT_TIMING_EVENT 0x02
89
90/* EC commands */
91enum ec_command {
92 ACPI_EC_COMMAND_READ = 0x80,
93 ACPI_EC_COMMAND_WRITE = 0x81,
94 ACPI_EC_BURST_ENABLE = 0x82,
95 ACPI_EC_BURST_DISABLE = 0x83,
96 ACPI_EC_COMMAND_QUERY = 0x84,
97};
98
99#define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
100#define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
101#define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */
102#define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
103 * when trying to clear the EC */
104#define ACPI_EC_MAX_QUERIES 16 /* Maximum number of parallel queries */
105
106enum {
107 EC_FLAGS_QUERY_ENABLED, /* Query is enabled */
108 EC_FLAGS_QUERY_PENDING, /* Query is pending */
109 EC_FLAGS_QUERY_GUARDING, /* Guard for SCI_EVT check */
110 EC_FLAGS_GPE_HANDLER_INSTALLED, /* GPE handler installed */
111 EC_FLAGS_EC_HANDLER_INSTALLED, /* OpReg handler installed */
112 EC_FLAGS_EVT_HANDLER_INSTALLED, /* _Qxx handlers installed */
113 EC_FLAGS_STARTED, /* Driver is started */
114 EC_FLAGS_STOPPED, /* Driver is stopped */
115 EC_FLAGS_GPE_MASKED, /* GPE masked */
116};
117
118#define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
119#define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
120
121/* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
122static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
123module_param(ec_delay, uint, 0644);
124MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
125
126static unsigned int ec_max_queries __read_mostly = ACPI_EC_MAX_QUERIES;
127module_param(ec_max_queries, uint, 0644);
128MODULE_PARM_DESC(ec_max_queries, "Maximum parallel _Qxx evaluations");
129
130static bool ec_busy_polling __read_mostly;
131module_param(ec_busy_polling, bool, 0644);
132MODULE_PARM_DESC(ec_busy_polling, "Use busy polling to advance EC transaction");
133
134static unsigned int ec_polling_guard __read_mostly = ACPI_EC_UDELAY_POLL;
135module_param(ec_polling_guard, uint, 0644);
136MODULE_PARM_DESC(ec_polling_guard, "Guard time(us) between EC accesses in polling modes");
137
138static unsigned int ec_event_clearing __read_mostly = ACPI_EC_EVT_TIMING_QUERY;
139
140/*
141 * If the number of false interrupts per one transaction exceeds
142 * this threshold, will think there is a GPE storm happened and
143 * will disable the GPE for normal transaction.
144 */
145static unsigned int ec_storm_threshold __read_mostly = 8;
146module_param(ec_storm_threshold, uint, 0644);
147MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm");
148
149static bool ec_freeze_events __read_mostly = false;
150module_param(ec_freeze_events, bool, 0644);
151MODULE_PARM_DESC(ec_freeze_events, "Disabling event handling during suspend/resume");
152
153static bool ec_no_wakeup __read_mostly;
154module_param(ec_no_wakeup, bool, 0644);
155MODULE_PARM_DESC(ec_no_wakeup, "Do not wake up from suspend-to-idle");
156
157struct acpi_ec_query_handler {
158 struct list_head node;
159 acpi_ec_query_func func;
160 acpi_handle handle;
161 void *data;
162 u8 query_bit;
163 struct kref kref;
164};
165
166struct transaction {
167 const u8 *wdata;
168 u8 *rdata;
169 unsigned short irq_count;
170 u8 command;
171 u8 wi;
172 u8 ri;
173 u8 wlen;
174 u8 rlen;
175 u8 flags;
176};
177
178struct acpi_ec_query {
179 struct transaction transaction;
180 struct work_struct work;
181 struct acpi_ec_query_handler *handler;
182};
183
184static int acpi_ec_query(struct acpi_ec *ec, u8 *data);
185static void advance_transaction(struct acpi_ec *ec);
186static void acpi_ec_event_handler(struct work_struct *work);
187static void acpi_ec_event_processor(struct work_struct *work);
188
189struct acpi_ec *boot_ec, *first_ec;
190EXPORT_SYMBOL(first_ec);
191static bool boot_ec_is_ecdt = false;
192static struct workqueue_struct *ec_query_wq;
193
194static int EC_FLAGS_QUERY_HANDSHAKE; /* Needs QR_EC issued when SCI_EVT set */
195static int EC_FLAGS_CORRECT_ECDT; /* Needs ECDT port address correction */
196static int EC_FLAGS_IGNORE_DSDT_GPE; /* Needs ECDT GPE as correction setting */
197
198/* --------------------------------------------------------------------------
199 * Logging/Debugging
200 * -------------------------------------------------------------------------- */
201
202/*
203 * Splitters used by the developers to track the boundary of the EC
204 * handling processes.
205 */
206#ifdef DEBUG
207#define EC_DBG_SEP " "
208#define EC_DBG_DRV "+++++"
209#define EC_DBG_STM "====="
210#define EC_DBG_REQ "*****"
211#define EC_DBG_EVT "#####"
212#else
213#define EC_DBG_SEP ""
214#define EC_DBG_DRV
215#define EC_DBG_STM
216#define EC_DBG_REQ
217#define EC_DBG_EVT
218#endif
219
220#define ec_log_raw(fmt, ...) \
221 pr_info(fmt "\n", ##__VA_ARGS__)
222#define ec_dbg_raw(fmt, ...) \
223 pr_debug(fmt "\n", ##__VA_ARGS__)
224#define ec_log(filter, fmt, ...) \
225 ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
226#define ec_dbg(filter, fmt, ...) \
227 ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
228
229#define ec_log_drv(fmt, ...) \
230 ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__)
231#define ec_dbg_drv(fmt, ...) \
232 ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__)
233#define ec_dbg_stm(fmt, ...) \
234 ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__)
235#define ec_dbg_req(fmt, ...) \
236 ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__)
237#define ec_dbg_evt(fmt, ...) \
238 ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__)
239#define ec_dbg_ref(ec, fmt, ...) \
240 ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
241
242/* --------------------------------------------------------------------------
243 * Device Flags
244 * -------------------------------------------------------------------------- */
245
246static bool acpi_ec_started(struct acpi_ec *ec)
247{
248 return test_bit(EC_FLAGS_STARTED, &ec->flags) &&
249 !test_bit(EC_FLAGS_STOPPED, &ec->flags);
250}
251
252static bool acpi_ec_event_enabled(struct acpi_ec *ec)
253{
254 /*
255 * There is an OSPM early stage logic. During the early stages
256 * (boot/resume), OSPMs shouldn't enable the event handling, only
257 * the EC transactions are allowed to be performed.
258 */
259 if (!test_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
260 return false;
261 /*
262 * However, disabling the event handling is experimental for late
263 * stage (suspend), and is controlled by the boot parameter of
264 * "ec_freeze_events":
265 * 1. true: The EC event handling is disabled before entering
266 * the noirq stage.
267 * 2. false: The EC event handling is automatically disabled as
268 * soon as the EC driver is stopped.
269 */
270 if (ec_freeze_events)
271 return acpi_ec_started(ec);
272 else
273 return test_bit(EC_FLAGS_STARTED, &ec->flags);
274}
275
276static bool acpi_ec_flushed(struct acpi_ec *ec)
277{
278 return ec->reference_count == 1;
279}
280
281/* --------------------------------------------------------------------------
282 * EC Registers
283 * -------------------------------------------------------------------------- */
284
285static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
286{
287 u8 x = inb(ec->command_addr);
288
289 ec_dbg_raw("EC_SC(R) = 0x%2.2x "
290 "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d",
291 x,
292 !!(x & ACPI_EC_FLAG_SCI),
293 !!(x & ACPI_EC_FLAG_BURST),
294 !!(x & ACPI_EC_FLAG_CMD),
295 !!(x & ACPI_EC_FLAG_IBF),
296 !!(x & ACPI_EC_FLAG_OBF));
297 return x;
298}
299
300static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
301{
302 u8 x = inb(ec->data_addr);
303
304 ec->timestamp = jiffies;
305 ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x);
306 return x;
307}
308
309static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
310{
311 ec_dbg_raw("EC_SC(W) = 0x%2.2x", command);
312 outb(command, ec->command_addr);
313 ec->timestamp = jiffies;
314}
315
316static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
317{
318 ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data);
319 outb(data, ec->data_addr);
320 ec->timestamp = jiffies;
321}
322
323#if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
324static const char *acpi_ec_cmd_string(u8 cmd)
325{
326 switch (cmd) {
327 case 0x80:
328 return "RD_EC";
329 case 0x81:
330 return "WR_EC";
331 case 0x82:
332 return "BE_EC";
333 case 0x83:
334 return "BD_EC";
335 case 0x84:
336 return "QR_EC";
337 }
338 return "UNKNOWN";
339}
340#else
341#define acpi_ec_cmd_string(cmd) "UNDEF"
342#endif
343
344/* --------------------------------------------------------------------------
345 * GPE Registers
346 * -------------------------------------------------------------------------- */
347
348static inline bool acpi_ec_is_gpe_raised(struct acpi_ec *ec)
349{
350 acpi_event_status gpe_status = 0;
351
352 (void)acpi_get_gpe_status(NULL, ec->gpe, &gpe_status);
353 return (gpe_status & ACPI_EVENT_FLAG_STATUS_SET) ? true : false;
354}
355
356static inline void acpi_ec_enable_gpe(struct acpi_ec *ec, bool open)
357{
358 if (open)
359 acpi_enable_gpe(NULL, ec->gpe);
360 else {
361 BUG_ON(ec->reference_count < 1);
362 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
363 }
364 if (acpi_ec_is_gpe_raised(ec)) {
365 /*
366 * On some platforms, EN=1 writes cannot trigger GPE. So
367 * software need to manually trigger a pseudo GPE event on
368 * EN=1 writes.
369 */
370 ec_dbg_raw("Polling quirk");
371 advance_transaction(ec);
372 }
373}
374
375static inline void acpi_ec_disable_gpe(struct acpi_ec *ec, bool close)
376{
377 if (close)
378 acpi_disable_gpe(NULL, ec->gpe);
379 else {
380 BUG_ON(ec->reference_count < 1);
381 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
382 }
383}
384
385static inline void acpi_ec_clear_gpe(struct acpi_ec *ec)
386{
387 /*
388 * GPE STS is a W1C register, which means:
389 * 1. Software can clear it without worrying about clearing other
390 * GPEs' STS bits when the hardware sets them in parallel.
391 * 2. As long as software can ensure only clearing it when it is
392 * set, hardware won't set it in parallel.
393 * So software can clear GPE in any contexts.
394 * Warning: do not move the check into advance_transaction() as the
395 * EC commands will be sent without GPE raised.
396 */
397 if (!acpi_ec_is_gpe_raised(ec))
398 return;
399 acpi_clear_gpe(NULL, ec->gpe);
400}
401
402/* --------------------------------------------------------------------------
403 * Transaction Management
404 * -------------------------------------------------------------------------- */
405
406static void acpi_ec_submit_request(struct acpi_ec *ec)
407{
408 ec->reference_count++;
409 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags) &&
410 ec->reference_count == 1)
411 acpi_ec_enable_gpe(ec, true);
412}
413
414static void acpi_ec_complete_request(struct acpi_ec *ec)
415{
416 bool flushed = false;
417
418 ec->reference_count--;
419 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags) &&
420 ec->reference_count == 0)
421 acpi_ec_disable_gpe(ec, true);
422 flushed = acpi_ec_flushed(ec);
423 if (flushed)
424 wake_up(&ec->wait);
425}
426
427static void acpi_ec_mask_gpe(struct acpi_ec *ec)
428{
429 if (!test_bit(EC_FLAGS_GPE_MASKED, &ec->flags)) {
430 acpi_ec_disable_gpe(ec, false);
431 ec_dbg_drv("Polling enabled");
432 set_bit(EC_FLAGS_GPE_MASKED, &ec->flags);
433 }
434}
435
436static void acpi_ec_unmask_gpe(struct acpi_ec *ec)
437{
438 if (test_bit(EC_FLAGS_GPE_MASKED, &ec->flags)) {
439 clear_bit(EC_FLAGS_GPE_MASKED, &ec->flags);
440 acpi_ec_enable_gpe(ec, false);
441 ec_dbg_drv("Polling disabled");
442 }
443}
444
445/*
446 * acpi_ec_submit_flushable_request() - Increase the reference count unless
447 * the flush operation is not in
448 * progress
449 * @ec: the EC device
450 *
451 * This function must be used before taking a new action that should hold
452 * the reference count. If this function returns false, then the action
453 * must be discarded or it will prevent the flush operation from being
454 * completed.
455 */
456static bool acpi_ec_submit_flushable_request(struct acpi_ec *ec)
457{
458 if (!acpi_ec_started(ec))
459 return false;
460 acpi_ec_submit_request(ec);
461 return true;
462}
463
464static void acpi_ec_submit_query(struct acpi_ec *ec)
465{
466 acpi_ec_mask_gpe(ec);
467 if (!acpi_ec_event_enabled(ec))
468 return;
469 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
470 ec_dbg_evt("Command(%s) submitted/blocked",
471 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
472 ec->nr_pending_queries++;
473 schedule_work(&ec->work);
474 }
475}
476
477static void acpi_ec_complete_query(struct acpi_ec *ec)
478{
479 if (test_and_clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
480 ec_dbg_evt("Command(%s) unblocked",
481 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
482 acpi_ec_unmask_gpe(ec);
483}
484
485static inline void __acpi_ec_enable_event(struct acpi_ec *ec)
486{
487 if (!test_and_set_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
488 ec_log_drv("event unblocked");
489 /*
490 * Unconditionally invoke this once after enabling the event
491 * handling mechanism to detect the pending events.
492 */
493 advance_transaction(ec);
494}
495
496static inline void __acpi_ec_disable_event(struct acpi_ec *ec)
497{
498 if (test_and_clear_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
499 ec_log_drv("event blocked");
500}
501
502static void acpi_ec_enable_event(struct acpi_ec *ec)
503{
504 unsigned long flags;
505
506 spin_lock_irqsave(&ec->lock, flags);
507 if (acpi_ec_started(ec))
508 __acpi_ec_enable_event(ec);
509 spin_unlock_irqrestore(&ec->lock, flags);
510}
511
512#ifdef CONFIG_PM_SLEEP
513static bool acpi_ec_query_flushed(struct acpi_ec *ec)
514{
515 bool flushed;
516 unsigned long flags;
517
518 spin_lock_irqsave(&ec->lock, flags);
519 flushed = !ec->nr_pending_queries;
520 spin_unlock_irqrestore(&ec->lock, flags);
521 return flushed;
522}
523
524static void __acpi_ec_flush_event(struct acpi_ec *ec)
525{
526 /*
527 * When ec_freeze_events is true, we need to flush events in
528 * the proper position before entering the noirq stage.
529 */
530 wait_event(ec->wait, acpi_ec_query_flushed(ec));
531 if (ec_query_wq)
532 flush_workqueue(ec_query_wq);
533}
534
535static void acpi_ec_disable_event(struct acpi_ec *ec)
536{
537 unsigned long flags;
538
539 spin_lock_irqsave(&ec->lock, flags);
540 __acpi_ec_disable_event(ec);
541 spin_unlock_irqrestore(&ec->lock, flags);
542 __acpi_ec_flush_event(ec);
543}
544
545void acpi_ec_flush_work(void)
546{
547 if (first_ec)
548 __acpi_ec_flush_event(first_ec);
549
550 flush_scheduled_work();
551}
552#endif /* CONFIG_PM_SLEEP */
553
554static bool acpi_ec_guard_event(struct acpi_ec *ec)
555{
556 bool guarded = true;
557 unsigned long flags;
558
559 spin_lock_irqsave(&ec->lock, flags);
560 /*
561 * If firmware SCI_EVT clearing timing is "event", we actually
562 * don't know when the SCI_EVT will be cleared by firmware after
563 * evaluating _Qxx, so we need to re-check SCI_EVT after waiting an
564 * acceptable period.
565 *
566 * The guarding period begins when EC_FLAGS_QUERY_PENDING is
567 * flagged, which means SCI_EVT check has just been performed.
568 * But if the current transaction is ACPI_EC_COMMAND_QUERY, the
569 * guarding should have already been performed (via
570 * EC_FLAGS_QUERY_GUARDING) and should not be applied so that the
571 * ACPI_EC_COMMAND_QUERY transaction can be transitioned into
572 * ACPI_EC_COMMAND_POLL state immediately.
573 */
574 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS ||
575 ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY ||
576 !test_bit(EC_FLAGS_QUERY_PENDING, &ec->flags) ||
577 (ec->curr && ec->curr->command == ACPI_EC_COMMAND_QUERY))
578 guarded = false;
579 spin_unlock_irqrestore(&ec->lock, flags);
580 return guarded;
581}
582
583static int ec_transaction_polled(struct acpi_ec *ec)
584{
585 unsigned long flags;
586 int ret = 0;
587
588 spin_lock_irqsave(&ec->lock, flags);
589 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_POLL))
590 ret = 1;
591 spin_unlock_irqrestore(&ec->lock, flags);
592 return ret;
593}
594
595static int ec_transaction_completed(struct acpi_ec *ec)
596{
597 unsigned long flags;
598 int ret = 0;
599
600 spin_lock_irqsave(&ec->lock, flags);
601 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE))
602 ret = 1;
603 spin_unlock_irqrestore(&ec->lock, flags);
604 return ret;
605}
606
607static inline void ec_transaction_transition(struct acpi_ec *ec, unsigned long flag)
608{
609 ec->curr->flags |= flag;
610 if (ec->curr->command == ACPI_EC_COMMAND_QUERY) {
611 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS &&
612 flag == ACPI_EC_COMMAND_POLL)
613 acpi_ec_complete_query(ec);
614 if (ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY &&
615 flag == ACPI_EC_COMMAND_COMPLETE)
616 acpi_ec_complete_query(ec);
617 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT &&
618 flag == ACPI_EC_COMMAND_COMPLETE)
619 set_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags);
620 }
621}
622
623static void advance_transaction(struct acpi_ec *ec)
624{
625 struct transaction *t;
626 u8 status;
627 bool wakeup = false;
628
629 ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK",
630 smp_processor_id());
631 /*
632 * By always clearing STS before handling all indications, we can
633 * ensure a hardware STS 0->1 change after this clearing can always
634 * trigger a GPE interrupt.
635 */
636 acpi_ec_clear_gpe(ec);
637 status = acpi_ec_read_status(ec);
638 t = ec->curr;
639 /*
640 * Another IRQ or a guarded polling mode advancement is detected,
641 * the next QR_EC submission is then allowed.
642 */
643 if (!t || !(t->flags & ACPI_EC_COMMAND_POLL)) {
644 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT &&
645 (!ec->nr_pending_queries ||
646 test_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags))) {
647 clear_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags);
648 acpi_ec_complete_query(ec);
649 }
650 }
651 if (!t)
652 goto err;
653 if (t->flags & ACPI_EC_COMMAND_POLL) {
654 if (t->wlen > t->wi) {
655 if ((status & ACPI_EC_FLAG_IBF) == 0)
656 acpi_ec_write_data(ec, t->wdata[t->wi++]);
657 else
658 goto err;
659 } else if (t->rlen > t->ri) {
660 if ((status & ACPI_EC_FLAG_OBF) == 1) {
661 t->rdata[t->ri++] = acpi_ec_read_data(ec);
662 if (t->rlen == t->ri) {
663 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
664 if (t->command == ACPI_EC_COMMAND_QUERY)
665 ec_dbg_evt("Command(%s) completed by hardware",
666 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
667 wakeup = true;
668 }
669 } else
670 goto err;
671 } else if (t->wlen == t->wi &&
672 (status & ACPI_EC_FLAG_IBF) == 0) {
673 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
674 wakeup = true;
675 }
676 goto out;
677 } else {
678 if (EC_FLAGS_QUERY_HANDSHAKE &&
679 !(status & ACPI_EC_FLAG_SCI) &&
680 (t->command == ACPI_EC_COMMAND_QUERY)) {
681 ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL);
682 t->rdata[t->ri++] = 0x00;
683 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
684 ec_dbg_evt("Command(%s) completed by software",
685 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
686 wakeup = true;
687 } else if ((status & ACPI_EC_FLAG_IBF) == 0) {
688 acpi_ec_write_cmd(ec, t->command);
689 ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL);
690 } else
691 goto err;
692 goto out;
693 }
694err:
695 /*
696 * If SCI bit is set, then don't think it's a false IRQ
697 * otherwise will take a not handled IRQ as a false one.
698 */
699 if (!(status & ACPI_EC_FLAG_SCI)) {
700 if (in_interrupt() && t) {
701 if (t->irq_count < ec_storm_threshold)
702 ++t->irq_count;
703 /* Allow triggering on 0 threshold */
704 if (t->irq_count == ec_storm_threshold)
705 acpi_ec_mask_gpe(ec);
706 }
707 }
708out:
709 if (status & ACPI_EC_FLAG_SCI)
710 acpi_ec_submit_query(ec);
711 if (wakeup && in_interrupt())
712 wake_up(&ec->wait);
713}
714
715static void start_transaction(struct acpi_ec *ec)
716{
717 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
718 ec->curr->flags = 0;
719}
720
721static int ec_guard(struct acpi_ec *ec)
722{
723 unsigned long guard = usecs_to_jiffies(ec->polling_guard);
724 unsigned long timeout = ec->timestamp + guard;
725
726 /* Ensure guarding period before polling EC status */
727 do {
728 if (ec->busy_polling) {
729 /* Perform busy polling */
730 if (ec_transaction_completed(ec))
731 return 0;
732 udelay(jiffies_to_usecs(guard));
733 } else {
734 /*
735 * Perform wait polling
736 * 1. Wait the transaction to be completed by the
737 * GPE handler after the transaction enters
738 * ACPI_EC_COMMAND_POLL state.
739 * 2. A special guarding logic is also required
740 * for event clearing mode "event" before the
741 * transaction enters ACPI_EC_COMMAND_POLL
742 * state.
743 */
744 if (!ec_transaction_polled(ec) &&
745 !acpi_ec_guard_event(ec))
746 break;
747 if (wait_event_timeout(ec->wait,
748 ec_transaction_completed(ec),
749 guard))
750 return 0;
751 }
752 } while (time_before(jiffies, timeout));
753 return -ETIME;
754}
755
756static int ec_poll(struct acpi_ec *ec)
757{
758 unsigned long flags;
759 int repeat = 5; /* number of command restarts */
760
761 while (repeat--) {
762 unsigned long delay = jiffies +
763 msecs_to_jiffies(ec_delay);
764 do {
765 if (!ec_guard(ec))
766 return 0;
767 spin_lock_irqsave(&ec->lock, flags);
768 advance_transaction(ec);
769 spin_unlock_irqrestore(&ec->lock, flags);
770 } while (time_before(jiffies, delay));
771 pr_debug("controller reset, restart transaction\n");
772 spin_lock_irqsave(&ec->lock, flags);
773 start_transaction(ec);
774 spin_unlock_irqrestore(&ec->lock, flags);
775 }
776 return -ETIME;
777}
778
779static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
780 struct transaction *t)
781{
782 unsigned long tmp;
783 int ret = 0;
784
785 /* start transaction */
786 spin_lock_irqsave(&ec->lock, tmp);
787 /* Enable GPE for command processing (IBF=0/OBF=1) */
788 if (!acpi_ec_submit_flushable_request(ec)) {
789 ret = -EINVAL;
790 goto unlock;
791 }
792 ec_dbg_ref(ec, "Increase command");
793 /* following two actions should be kept atomic */
794 ec->curr = t;
795 ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t->command));
796 start_transaction(ec);
797 spin_unlock_irqrestore(&ec->lock, tmp);
798
799 ret = ec_poll(ec);
800
801 spin_lock_irqsave(&ec->lock, tmp);
802 if (t->irq_count == ec_storm_threshold)
803 acpi_ec_unmask_gpe(ec);
804 ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t->command));
805 ec->curr = NULL;
806 /* Disable GPE for command processing (IBF=0/OBF=1) */
807 acpi_ec_complete_request(ec);
808 ec_dbg_ref(ec, "Decrease command");
809unlock:
810 spin_unlock_irqrestore(&ec->lock, tmp);
811 return ret;
812}
813
814static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
815{
816 int status;
817 u32 glk;
818
819 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
820 return -EINVAL;
821 if (t->rdata)
822 memset(t->rdata, 0, t->rlen);
823
824 mutex_lock(&ec->mutex);
825 if (ec->global_lock) {
826 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
827 if (ACPI_FAILURE(status)) {
828 status = -ENODEV;
829 goto unlock;
830 }
831 }
832
833 status = acpi_ec_transaction_unlocked(ec, t);
834
835 if (ec->global_lock)
836 acpi_release_global_lock(glk);
837unlock:
838 mutex_unlock(&ec->mutex);
839 return status;
840}
841
842static int acpi_ec_burst_enable(struct acpi_ec *ec)
843{
844 u8 d;
845 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
846 .wdata = NULL, .rdata = &d,
847 .wlen = 0, .rlen = 1};
848
849 return acpi_ec_transaction(ec, &t);
850}
851
852static int acpi_ec_burst_disable(struct acpi_ec *ec)
853{
854 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
855 .wdata = NULL, .rdata = NULL,
856 .wlen = 0, .rlen = 0};
857
858 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
859 acpi_ec_transaction(ec, &t) : 0;
860}
861
862static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data)
863{
864 int result;
865 u8 d;
866 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
867 .wdata = &address, .rdata = &d,
868 .wlen = 1, .rlen = 1};
869
870 result = acpi_ec_transaction(ec, &t);
871 *data = d;
872 return result;
873}
874
875static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
876{
877 u8 wdata[2] = { address, data };
878 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
879 .wdata = wdata, .rdata = NULL,
880 .wlen = 2, .rlen = 0};
881
882 return acpi_ec_transaction(ec, &t);
883}
884
885int ec_read(u8 addr, u8 *val)
886{
887 int err;
888 u8 temp_data;
889
890 if (!first_ec)
891 return -ENODEV;
892
893 err = acpi_ec_read(first_ec, addr, &temp_data);
894
895 if (!err) {
896 *val = temp_data;
897 return 0;
898 }
899 return err;
900}
901EXPORT_SYMBOL(ec_read);
902
903int ec_write(u8 addr, u8 val)
904{
905 int err;
906
907 if (!first_ec)
908 return -ENODEV;
909
910 err = acpi_ec_write(first_ec, addr, val);
911
912 return err;
913}
914EXPORT_SYMBOL(ec_write);
915
916int ec_transaction(u8 command,
917 const u8 *wdata, unsigned wdata_len,
918 u8 *rdata, unsigned rdata_len)
919{
920 struct transaction t = {.command = command,
921 .wdata = wdata, .rdata = rdata,
922 .wlen = wdata_len, .rlen = rdata_len};
923
924 if (!first_ec)
925 return -ENODEV;
926
927 return acpi_ec_transaction(first_ec, &t);
928}
929EXPORT_SYMBOL(ec_transaction);
930
931/* Get the handle to the EC device */
932acpi_handle ec_get_handle(void)
933{
934 if (!first_ec)
935 return NULL;
936 return first_ec->handle;
937}
938EXPORT_SYMBOL(ec_get_handle);
939
940static void acpi_ec_start(struct acpi_ec *ec, bool resuming)
941{
942 unsigned long flags;
943
944 spin_lock_irqsave(&ec->lock, flags);
945 if (!test_and_set_bit(EC_FLAGS_STARTED, &ec->flags)) {
946 ec_dbg_drv("Starting EC");
947 /* Enable GPE for event processing (SCI_EVT=1) */
948 if (!resuming) {
949 acpi_ec_submit_request(ec);
950 ec_dbg_ref(ec, "Increase driver");
951 }
952 ec_log_drv("EC started");
953 }
954 spin_unlock_irqrestore(&ec->lock, flags);
955}
956
957static bool acpi_ec_stopped(struct acpi_ec *ec)
958{
959 unsigned long flags;
960 bool flushed;
961
962 spin_lock_irqsave(&ec->lock, flags);
963 flushed = acpi_ec_flushed(ec);
964 spin_unlock_irqrestore(&ec->lock, flags);
965 return flushed;
966}
967
968static void acpi_ec_stop(struct acpi_ec *ec, bool suspending)
969{
970 unsigned long flags;
971
972 spin_lock_irqsave(&ec->lock, flags);
973 if (acpi_ec_started(ec)) {
974 ec_dbg_drv("Stopping EC");
975 set_bit(EC_FLAGS_STOPPED, &ec->flags);
976 spin_unlock_irqrestore(&ec->lock, flags);
977 wait_event(ec->wait, acpi_ec_stopped(ec));
978 spin_lock_irqsave(&ec->lock, flags);
979 /* Disable GPE for event processing (SCI_EVT=1) */
980 if (!suspending) {
981 acpi_ec_complete_request(ec);
982 ec_dbg_ref(ec, "Decrease driver");
983 } else if (!ec_freeze_events)
984 __acpi_ec_disable_event(ec);
985 clear_bit(EC_FLAGS_STARTED, &ec->flags);
986 clear_bit(EC_FLAGS_STOPPED, &ec->flags);
987 ec_log_drv("EC stopped");
988 }
989 spin_unlock_irqrestore(&ec->lock, flags);
990}
991
992static void acpi_ec_enter_noirq(struct acpi_ec *ec)
993{
994 unsigned long flags;
995
996 spin_lock_irqsave(&ec->lock, flags);
997 ec->busy_polling = true;
998 ec->polling_guard = 0;
999 ec_log_drv("interrupt blocked");
1000 spin_unlock_irqrestore(&ec->lock, flags);
1001}
1002
1003static void acpi_ec_leave_noirq(struct acpi_ec *ec)
1004{
1005 unsigned long flags;
1006
1007 spin_lock_irqsave(&ec->lock, flags);
1008 ec->busy_polling = ec_busy_polling;
1009 ec->polling_guard = ec_polling_guard;
1010 ec_log_drv("interrupt unblocked");
1011 spin_unlock_irqrestore(&ec->lock, flags);
1012}
1013
1014void acpi_ec_block_transactions(void)
1015{
1016 struct acpi_ec *ec = first_ec;
1017
1018 if (!ec)
1019 return;
1020
1021 mutex_lock(&ec->mutex);
1022 /* Prevent transactions from being carried out */
1023 acpi_ec_stop(ec, true);
1024 mutex_unlock(&ec->mutex);
1025}
1026
1027void acpi_ec_unblock_transactions(void)
1028{
1029 /*
1030 * Allow transactions to happen again (this function is called from
1031 * atomic context during wakeup, so we don't need to acquire the mutex).
1032 */
1033 if (first_ec)
1034 acpi_ec_start(first_ec, true);
1035}
1036
1037/* --------------------------------------------------------------------------
1038 Event Management
1039 -------------------------------------------------------------------------- */
1040static struct acpi_ec_query_handler *
1041acpi_ec_get_query_handler(struct acpi_ec_query_handler *handler)
1042{
1043 if (handler)
1044 kref_get(&handler->kref);
1045 return handler;
1046}
1047
1048static struct acpi_ec_query_handler *
1049acpi_ec_get_query_handler_by_value(struct acpi_ec *ec, u8 value)
1050{
1051 struct acpi_ec_query_handler *handler;
1052 bool found = false;
1053
1054 mutex_lock(&ec->mutex);
1055 list_for_each_entry(handler, &ec->list, node) {
1056 if (value == handler->query_bit) {
1057 found = true;
1058 break;
1059 }
1060 }
1061 mutex_unlock(&ec->mutex);
1062 return found ? acpi_ec_get_query_handler(handler) : NULL;
1063}
1064
1065static void acpi_ec_query_handler_release(struct kref *kref)
1066{
1067 struct acpi_ec_query_handler *handler =
1068 container_of(kref, struct acpi_ec_query_handler, kref);
1069
1070 kfree(handler);
1071}
1072
1073static void acpi_ec_put_query_handler(struct acpi_ec_query_handler *handler)
1074{
1075 kref_put(&handler->kref, acpi_ec_query_handler_release);
1076}
1077
1078int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
1079 acpi_handle handle, acpi_ec_query_func func,
1080 void *data)
1081{
1082 struct acpi_ec_query_handler *handler =
1083 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
1084
1085 if (!handler)
1086 return -ENOMEM;
1087
1088 handler->query_bit = query_bit;
1089 handler->handle = handle;
1090 handler->func = func;
1091 handler->data = data;
1092 mutex_lock(&ec->mutex);
1093 kref_init(&handler->kref);
1094 list_add(&handler->node, &ec->list);
1095 mutex_unlock(&ec->mutex);
1096 return 0;
1097}
1098EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
1099
1100static void acpi_ec_remove_query_handlers(struct acpi_ec *ec,
1101 bool remove_all, u8 query_bit)
1102{
1103 struct acpi_ec_query_handler *handler, *tmp;
1104 LIST_HEAD(free_list);
1105
1106 mutex_lock(&ec->mutex);
1107 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
1108 if (remove_all || query_bit == handler->query_bit) {
1109 list_del_init(&handler->node);
1110 list_add(&handler->node, &free_list);
1111 }
1112 }
1113 mutex_unlock(&ec->mutex);
1114 list_for_each_entry_safe(handler, tmp, &free_list, node)
1115 acpi_ec_put_query_handler(handler);
1116}
1117
1118void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
1119{
1120 acpi_ec_remove_query_handlers(ec, false, query_bit);
1121}
1122EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
1123
1124static struct acpi_ec_query *acpi_ec_create_query(u8 *pval)
1125{
1126 struct acpi_ec_query *q;
1127 struct transaction *t;
1128
1129 q = kzalloc(sizeof (struct acpi_ec_query), GFP_KERNEL);
1130 if (!q)
1131 return NULL;
1132 INIT_WORK(&q->work, acpi_ec_event_processor);
1133 t = &q->transaction;
1134 t->command = ACPI_EC_COMMAND_QUERY;
1135 t->rdata = pval;
1136 t->rlen = 1;
1137 return q;
1138}
1139
1140static void acpi_ec_delete_query(struct acpi_ec_query *q)
1141{
1142 if (q) {
1143 if (q->handler)
1144 acpi_ec_put_query_handler(q->handler);
1145 kfree(q);
1146 }
1147}
1148
1149static void acpi_ec_event_processor(struct work_struct *work)
1150{
1151 struct acpi_ec_query *q = container_of(work, struct acpi_ec_query, work);
1152 struct acpi_ec_query_handler *handler = q->handler;
1153
1154 ec_dbg_evt("Query(0x%02x) started", handler->query_bit);
1155 if (handler->func)
1156 handler->func(handler->data);
1157 else if (handler->handle)
1158 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
1159 ec_dbg_evt("Query(0x%02x) stopped", handler->query_bit);
1160 acpi_ec_delete_query(q);
1161}
1162
1163static int acpi_ec_query(struct acpi_ec *ec, u8 *data)
1164{
1165 u8 value = 0;
1166 int result;
1167 struct acpi_ec_query *q;
1168
1169 q = acpi_ec_create_query(&value);
1170 if (!q)
1171 return -ENOMEM;
1172
1173 /*
1174 * Query the EC to find out which _Qxx method we need to evaluate.
1175 * Note that successful completion of the query causes the ACPI_EC_SCI
1176 * bit to be cleared (and thus clearing the interrupt source).
1177 */
1178 result = acpi_ec_transaction(ec, &q->transaction);
1179 if (!value)
1180 result = -ENODATA;
1181 if (result)
1182 goto err_exit;
1183
1184 q->handler = acpi_ec_get_query_handler_by_value(ec, value);
1185 if (!q->handler) {
1186 result = -ENODATA;
1187 goto err_exit;
1188 }
1189
1190 /*
1191 * It is reported that _Qxx are evaluated in a parallel way on
1192 * Windows:
1193 * https://bugzilla.kernel.org/show_bug.cgi?id=94411
1194 *
1195 * Put this log entry before schedule_work() in order to make
1196 * it appearing before any other log entries occurred during the
1197 * work queue execution.
1198 */
1199 ec_dbg_evt("Query(0x%02x) scheduled", value);
1200 if (!queue_work(ec_query_wq, &q->work)) {
1201 ec_dbg_evt("Query(0x%02x) overlapped", value);
1202 result = -EBUSY;
1203 }
1204
1205err_exit:
1206 if (result)
1207 acpi_ec_delete_query(q);
1208 if (data)
1209 *data = value;
1210 return result;
1211}
1212
1213static void acpi_ec_check_event(struct acpi_ec *ec)
1214{
1215 unsigned long flags;
1216
1217 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT) {
1218 if (ec_guard(ec)) {
1219 spin_lock_irqsave(&ec->lock, flags);
1220 /*
1221 * Take care of the SCI_EVT unless no one else is
1222 * taking care of it.
1223 */
1224 if (!ec->curr)
1225 advance_transaction(ec);
1226 spin_unlock_irqrestore(&ec->lock, flags);
1227 }
1228 }
1229}
1230
1231static void acpi_ec_event_handler(struct work_struct *work)
1232{
1233 unsigned long flags;
1234 struct acpi_ec *ec = container_of(work, struct acpi_ec, work);
1235
1236 ec_dbg_evt("Event started");
1237
1238 spin_lock_irqsave(&ec->lock, flags);
1239 while (ec->nr_pending_queries) {
1240 spin_unlock_irqrestore(&ec->lock, flags);
1241 (void)acpi_ec_query(ec, NULL);
1242 spin_lock_irqsave(&ec->lock, flags);
1243 ec->nr_pending_queries--;
1244 /*
1245 * Before exit, make sure that this work item can be
1246 * scheduled again. There might be QR_EC failures, leaving
1247 * EC_FLAGS_QUERY_PENDING uncleared and preventing this work
1248 * item from being scheduled again.
1249 */
1250 if (!ec->nr_pending_queries) {
1251 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS ||
1252 ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY)
1253 acpi_ec_complete_query(ec);
1254 }
1255 }
1256 spin_unlock_irqrestore(&ec->lock, flags);
1257
1258 ec_dbg_evt("Event stopped");
1259
1260 acpi_ec_check_event(ec);
1261}
1262
1263static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
1264 u32 gpe_number, void *data)
1265{
1266 unsigned long flags;
1267 struct acpi_ec *ec = data;
1268
1269 spin_lock_irqsave(&ec->lock, flags);
1270 advance_transaction(ec);
1271 spin_unlock_irqrestore(&ec->lock, flags);
1272 return ACPI_INTERRUPT_HANDLED;
1273}
1274
1275/* --------------------------------------------------------------------------
1276 * Address Space Management
1277 * -------------------------------------------------------------------------- */
1278
1279static acpi_status
1280acpi_ec_space_handler(u32 function, acpi_physical_address address,
1281 u32 bits, u64 *value64,
1282 void *handler_context, void *region_context)
1283{
1284 struct acpi_ec *ec = handler_context;
1285 int result = 0, i, bytes = bits / 8;
1286 u8 *value = (u8 *)value64;
1287
1288 if ((address > 0xFF) || !value || !handler_context)
1289 return AE_BAD_PARAMETER;
1290
1291 if (function != ACPI_READ && function != ACPI_WRITE)
1292 return AE_BAD_PARAMETER;
1293
1294 if (ec->busy_polling || bits > 8)
1295 acpi_ec_burst_enable(ec);
1296
1297 for (i = 0; i < bytes; ++i, ++address, ++value)
1298 result = (function == ACPI_READ) ?
1299 acpi_ec_read(ec, address, value) :
1300 acpi_ec_write(ec, address, *value);
1301
1302 if (ec->busy_polling || bits > 8)
1303 acpi_ec_burst_disable(ec);
1304
1305 switch (result) {
1306 case -EINVAL:
1307 return AE_BAD_PARAMETER;
1308 case -ENODEV:
1309 return AE_NOT_FOUND;
1310 case -ETIME:
1311 return AE_TIME;
1312 default:
1313 return AE_OK;
1314 }
1315}
1316
1317/* --------------------------------------------------------------------------
1318 * Driver Interface
1319 * -------------------------------------------------------------------------- */
1320
1321static acpi_status
1322ec_parse_io_ports(struct acpi_resource *resource, void *context);
1323
1324static void acpi_ec_free(struct acpi_ec *ec)
1325{
1326 if (first_ec == ec)
1327 first_ec = NULL;
1328 if (boot_ec == ec)
1329 boot_ec = NULL;
1330 kfree(ec);
1331}
1332
1333static struct acpi_ec *acpi_ec_alloc(void)
1334{
1335 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
1336
1337 if (!ec)
1338 return NULL;
1339 mutex_init(&ec->mutex);
1340 init_waitqueue_head(&ec->wait);
1341 INIT_LIST_HEAD(&ec->list);
1342 spin_lock_init(&ec->lock);
1343 INIT_WORK(&ec->work, acpi_ec_event_handler);
1344 ec->timestamp = jiffies;
1345 ec->busy_polling = true;
1346 ec->polling_guard = 0;
1347 return ec;
1348}
1349
1350static acpi_status
1351acpi_ec_register_query_methods(acpi_handle handle, u32 level,
1352 void *context, void **return_value)
1353{
1354 char node_name[5];
1355 struct acpi_buffer buffer = { sizeof(node_name), node_name };
1356 struct acpi_ec *ec = context;
1357 int value = 0;
1358 acpi_status status;
1359
1360 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
1361
1362 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1)
1363 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
1364 return AE_OK;
1365}
1366
1367static acpi_status
1368ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
1369{
1370 acpi_status status;
1371 unsigned long long tmp = 0;
1372 struct acpi_ec *ec = context;
1373
1374 /* clear addr values, ec_parse_io_ports depend on it */
1375 ec->command_addr = ec->data_addr = 0;
1376
1377 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1378 ec_parse_io_ports, ec);
1379 if (ACPI_FAILURE(status))
1380 return status;
1381 if (ec->data_addr == 0 || ec->command_addr == 0)
1382 return AE_OK;
1383
1384 if (boot_ec && boot_ec_is_ecdt && EC_FLAGS_IGNORE_DSDT_GPE) {
1385 /*
1386 * Always inherit the GPE number setting from the ECDT
1387 * EC.
1388 */
1389 ec->gpe = boot_ec->gpe;
1390 } else {
1391 /* Get GPE bit assignment (EC events). */
1392 /* TODO: Add support for _GPE returning a package */
1393 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
1394 if (ACPI_FAILURE(status))
1395 return status;
1396 ec->gpe = tmp;
1397 }
1398 /* Use the global lock for all EC transactions? */
1399 tmp = 0;
1400 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
1401 ec->global_lock = tmp;
1402 ec->handle = handle;
1403 return AE_CTRL_TERMINATE;
1404}
1405
1406/*
1407 * Note: This function returns an error code only when the address space
1408 * handler is not installed, which means "not able to handle
1409 * transactions".
1410 */
1411static int ec_install_handlers(struct acpi_ec *ec, bool handle_events)
1412{
1413 acpi_status status;
1414
1415 acpi_ec_start(ec, false);
1416
1417 if (!test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) {
1418 acpi_ec_enter_noirq(ec);
1419 status = acpi_install_address_space_handler(ec->handle,
1420 ACPI_ADR_SPACE_EC,
1421 &acpi_ec_space_handler,
1422 NULL, ec);
1423 if (ACPI_FAILURE(status)) {
1424 if (status == AE_NOT_FOUND) {
1425 /*
1426 * Maybe OS fails in evaluating the _REG
1427 * object. The AE_NOT_FOUND error will be
1428 * ignored and OS * continue to initialize
1429 * EC.
1430 */
1431 pr_err("Fail in evaluating the _REG object"
1432 " of EC device. Broken bios is suspected.\n");
1433 } else {
1434 acpi_ec_stop(ec, false);
1435 return -ENODEV;
1436 }
1437 }
1438 set_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags);
1439 }
1440
1441 if (!handle_events)
1442 return 0;
1443
1444 if (!test_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags)) {
1445 /* Find and register all query methods */
1446 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
1447 acpi_ec_register_query_methods,
1448 NULL, ec, NULL);
1449 set_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags);
1450 }
1451 if (!test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags)) {
1452 status = acpi_install_gpe_raw_handler(NULL, ec->gpe,
1453 ACPI_GPE_EDGE_TRIGGERED,
1454 &acpi_ec_gpe_handler, ec);
1455 /* This is not fatal as we can poll EC events */
1456 if (ACPI_SUCCESS(status)) {
1457 set_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags);
1458 acpi_ec_leave_noirq(ec);
1459 if (test_bit(EC_FLAGS_STARTED, &ec->flags) &&
1460 ec->reference_count >= 1)
1461 acpi_ec_enable_gpe(ec, true);
1462 }
1463 }
1464 /* EC is fully operational, allow queries */
1465 acpi_ec_enable_event(ec);
1466
1467 return 0;
1468}
1469
1470static void ec_remove_handlers(struct acpi_ec *ec)
1471{
1472 if (test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) {
1473 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
1474 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
1475 pr_err("failed to remove space handler\n");
1476 clear_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags);
1477 }
1478
1479 /*
1480 * Stops handling the EC transactions after removing the operation
1481 * region handler. This is required because _REG(DISCONNECT)
1482 * invoked during the removal can result in new EC transactions.
1483 *
1484 * Flushes the EC requests and thus disables the GPE before
1485 * removing the GPE handler. This is required by the current ACPICA
1486 * GPE core. ACPICA GPE core will automatically disable a GPE when
1487 * it is indicated but there is no way to handle it. So the drivers
1488 * must disable the GPEs prior to removing the GPE handlers.
1489 */
1490 acpi_ec_stop(ec, false);
1491
1492 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags)) {
1493 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
1494 &acpi_ec_gpe_handler)))
1495 pr_err("failed to remove gpe handler\n");
1496 clear_bit(EC_FLAGS_GPE_HANDLER_INSTALLED, &ec->flags);
1497 }
1498 if (test_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags)) {
1499 acpi_ec_remove_query_handlers(ec, true, 0);
1500 clear_bit(EC_FLAGS_EVT_HANDLER_INSTALLED, &ec->flags);
1501 }
1502}
1503
1504static int acpi_ec_setup(struct acpi_ec *ec, bool handle_events)
1505{
1506 int ret;
1507
1508 ret = ec_install_handlers(ec, handle_events);
1509 if (ret)
1510 return ret;
1511
1512 /* First EC capable of handling transactions */
1513 if (!first_ec) {
1514 first_ec = ec;
1515 acpi_handle_info(first_ec->handle, "Used as first EC\n");
1516 }
1517
1518 acpi_handle_info(ec->handle,
1519 "GPE=0x%x, EC_CMD/EC_SC=0x%lx, EC_DATA=0x%lx\n",
1520 ec->gpe, ec->command_addr, ec->data_addr);
1521 return ret;
1522}
1523
1524static int acpi_config_boot_ec(struct acpi_ec *ec, acpi_handle handle,
1525 bool handle_events, bool is_ecdt)
1526{
1527 int ret;
1528
1529 /*
1530 * Changing the ACPI handle results in a re-configuration of the
1531 * boot EC. And if it happens after the namespace initialization,
1532 * it causes _REG evaluations.
1533 */
1534 if (boot_ec && boot_ec->handle != handle)
1535 ec_remove_handlers(boot_ec);
1536
1537 /* Unset old boot EC */
1538 if (boot_ec != ec)
1539 acpi_ec_free(boot_ec);
1540
1541 /*
1542 * ECDT device creation is split into acpi_ec_ecdt_probe() and
1543 * acpi_ec_ecdt_start(). This function takes care of completing the
1544 * ECDT parsing logic as the handle update should be performed
1545 * between the installation/uninstallation of the handlers.
1546 */
1547 if (ec->handle != handle)
1548 ec->handle = handle;
1549
1550 ret = acpi_ec_setup(ec, handle_events);
1551 if (ret)
1552 return ret;
1553
1554 /* Set new boot EC */
1555 if (!boot_ec) {
1556 boot_ec = ec;
1557 boot_ec_is_ecdt = is_ecdt;
1558 }
1559
1560 acpi_handle_info(boot_ec->handle,
1561 "Used as boot %s EC to handle transactions%s\n",
1562 is_ecdt ? "ECDT" : "DSDT",
1563 handle_events ? " and events" : "");
1564 return ret;
1565}
1566
1567static bool acpi_ec_ecdt_get_handle(acpi_handle *phandle)
1568{
1569 struct acpi_table_ecdt *ecdt_ptr;
1570 acpi_status status;
1571 acpi_handle handle;
1572
1573 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1574 (struct acpi_table_header **)&ecdt_ptr);
1575 if (ACPI_FAILURE(status))
1576 return false;
1577
1578 status = acpi_get_handle(NULL, ecdt_ptr->id, &handle);
1579 if (ACPI_FAILURE(status))
1580 return false;
1581
1582 *phandle = handle;
1583 return true;
1584}
1585
1586static bool acpi_is_boot_ec(struct acpi_ec *ec)
1587{
1588 if (!boot_ec)
1589 return false;
1590 if (ec->command_addr == boot_ec->command_addr &&
1591 ec->data_addr == boot_ec->data_addr)
1592 return true;
1593 return false;
1594}
1595
1596static int acpi_ec_add(struct acpi_device *device)
1597{
1598 struct acpi_ec *ec = NULL;
1599 int ret;
1600 bool is_ecdt = false;
1601 acpi_status status;
1602
1603 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1604 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1605
1606 if (!strcmp(acpi_device_hid(device), ACPI_ECDT_HID)) {
1607 is_ecdt = true;
1608 ec = boot_ec;
1609 } else {
1610 ec = acpi_ec_alloc();
1611 if (!ec)
1612 return -ENOMEM;
1613 status = ec_parse_device(device->handle, 0, ec, NULL);
1614 if (status != AE_CTRL_TERMINATE) {
1615 ret = -EINVAL;
1616 goto err_alloc;
1617 }
1618 }
1619
1620 if (acpi_is_boot_ec(ec)) {
1621 boot_ec_is_ecdt = is_ecdt;
1622 if (!is_ecdt) {
1623 /*
1624 * Trust PNP0C09 namespace location rather than
1625 * ECDT ID. But trust ECDT GPE rather than _GPE
1626 * because of ASUS quirks, so do not change
1627 * boot_ec->gpe to ec->gpe.
1628 */
1629 boot_ec->handle = ec->handle;
1630 acpi_handle_debug(ec->handle, "duplicated.\n");
1631 acpi_ec_free(ec);
1632 ec = boot_ec;
1633 }
1634 ret = acpi_config_boot_ec(ec, ec->handle, true, is_ecdt);
1635 } else
1636 ret = acpi_ec_setup(ec, true);
1637 if (ret)
1638 goto err_query;
1639
1640 device->driver_data = ec;
1641
1642 ret = !!request_region(ec->data_addr, 1, "EC data");
1643 WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr);
1644 ret = !!request_region(ec->command_addr, 1, "EC cmd");
1645 WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr);
1646
1647 if (!is_ecdt) {
1648 /* Reprobe devices depending on the EC */
1649 acpi_walk_dep_device_list(ec->handle);
1650 }
1651 acpi_handle_debug(ec->handle, "enumerated.\n");
1652 return 0;
1653
1654err_query:
1655 if (ec != boot_ec)
1656 acpi_ec_remove_query_handlers(ec, true, 0);
1657err_alloc:
1658 if (ec != boot_ec)
1659 acpi_ec_free(ec);
1660 return ret;
1661}
1662
1663static int acpi_ec_remove(struct acpi_device *device)
1664{
1665 struct acpi_ec *ec;
1666
1667 if (!device)
1668 return -EINVAL;
1669
1670 ec = acpi_driver_data(device);
1671 release_region(ec->data_addr, 1);
1672 release_region(ec->command_addr, 1);
1673 device->driver_data = NULL;
1674 if (ec != boot_ec) {
1675 ec_remove_handlers(ec);
1676 acpi_ec_free(ec);
1677 }
1678 return 0;
1679}
1680
1681static acpi_status
1682ec_parse_io_ports(struct acpi_resource *resource, void *context)
1683{
1684 struct acpi_ec *ec = context;
1685
1686 if (resource->type != ACPI_RESOURCE_TYPE_IO)
1687 return AE_OK;
1688
1689 /*
1690 * The first address region returned is the data port, and
1691 * the second address region returned is the status/command
1692 * port.
1693 */
1694 if (ec->data_addr == 0)
1695 ec->data_addr = resource->data.io.minimum;
1696 else if (ec->command_addr == 0)
1697 ec->command_addr = resource->data.io.minimum;
1698 else
1699 return AE_CTRL_TERMINATE;
1700
1701 return AE_OK;
1702}
1703
1704static const struct acpi_device_id ec_device_ids[] = {
1705 {"PNP0C09", 0},
1706 {ACPI_ECDT_HID, 0},
1707 {"", 0},
1708};
1709
1710/*
1711 * This function is not Windows-compatible as Windows never enumerates the
1712 * namespace EC before the main ACPI device enumeration process. It is
1713 * retained for historical reason and will be deprecated in the future.
1714 */
1715int __init acpi_ec_dsdt_probe(void)
1716{
1717 acpi_status status;
1718 struct acpi_ec *ec;
1719 int ret;
1720
1721 /*
1722 * If a platform has ECDT, there is no need to proceed as the
1723 * following probe is not a part of the ACPI device enumeration,
1724 * executing _STA is not safe, and thus this probe may risk of
1725 * picking up an invalid EC device.
1726 */
1727 if (boot_ec)
1728 return -ENODEV;
1729
1730 ec = acpi_ec_alloc();
1731 if (!ec)
1732 return -ENOMEM;
1733 /*
1734 * At this point, the namespace is initialized, so start to find
1735 * the namespace objects.
1736 */
1737 status = acpi_get_devices(ec_device_ids[0].id,
1738 ec_parse_device, ec, NULL);
1739 if (ACPI_FAILURE(status) || !ec->handle) {
1740 ret = -ENODEV;
1741 goto error;
1742 }
1743 /*
1744 * When the DSDT EC is available, always re-configure boot EC to
1745 * have _REG evaluated. _REG can only be evaluated after the
1746 * namespace initialization.
1747 * At this point, the GPE is not fully initialized, so do not to
1748 * handle the events.
1749 */
1750 ret = acpi_config_boot_ec(ec, ec->handle, false, false);
1751error:
1752 if (ret)
1753 acpi_ec_free(ec);
1754 return ret;
1755}
1756
1757/*
1758 * If the DSDT EC is not functioning, we still need to prepare a fully
1759 * functioning ECDT EC first in order to handle the events.
1760 * https://bugzilla.kernel.org/show_bug.cgi?id=115021
1761 */
1762static int __init acpi_ec_ecdt_start(void)
1763{
1764 acpi_handle handle;
1765
1766 if (!boot_ec)
1767 return -ENODEV;
1768 /* In case acpi_ec_ecdt_start() is called after acpi_ec_add() */
1769 if (!boot_ec_is_ecdt)
1770 return -ENODEV;
1771
1772 /*
1773 * At this point, the namespace and the GPE is initialized, so
1774 * start to find the namespace objects and handle the events.
1775 *
1776 * Note: ec->handle can be valid if this function is called after
1777 * acpi_ec_add(), hence the fast path.
1778 */
1779 if (boot_ec->handle == ACPI_ROOT_OBJECT) {
1780 if (!acpi_ec_ecdt_get_handle(&handle))
1781 return -ENODEV;
1782 boot_ec->handle = handle;
1783 }
1784
1785 /* Register to ACPI bus with PM ops attached */
1786 return acpi_bus_register_early_device(ACPI_BUS_TYPE_ECDT_EC);
1787}
1788
1789#if 0
1790/*
1791 * Some EC firmware variations refuses to respond QR_EC when SCI_EVT is not
1792 * set, for which case, we complete the QR_EC without issuing it to the
1793 * firmware.
1794 * https://bugzilla.kernel.org/show_bug.cgi?id=82611
1795 * https://bugzilla.kernel.org/show_bug.cgi?id=97381
1796 */
1797static int ec_flag_query_handshake(const struct dmi_system_id *id)
1798{
1799 pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n");
1800 EC_FLAGS_QUERY_HANDSHAKE = 1;
1801 return 0;
1802}
1803#endif
1804
1805/*
1806 * Some ECDTs contain wrong register addresses.
1807 * MSI MS-171F
1808 * https://bugzilla.kernel.org/show_bug.cgi?id=12461
1809 */
1810static int ec_correct_ecdt(const struct dmi_system_id *id)
1811{
1812 pr_debug("Detected system needing ECDT address correction.\n");
1813 EC_FLAGS_CORRECT_ECDT = 1;
1814 return 0;
1815}
1816
1817/*
1818 * Some DSDTs contain wrong GPE setting.
1819 * Asus FX502VD/VE, GL702VMK, X550VXK, X580VD
1820 * https://bugzilla.kernel.org/show_bug.cgi?id=195651
1821 */
1822static int ec_honor_ecdt_gpe(const struct dmi_system_id *id)
1823{
1824 pr_debug("Detected system needing ignore DSDT GPE setting.\n");
1825 EC_FLAGS_IGNORE_DSDT_GPE = 1;
1826 return 0;
1827}
1828
1829static const struct dmi_system_id ec_dmi_table[] __initconst = {
1830 {
1831 ec_correct_ecdt, "MSI MS-171F", {
1832 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star"),
1833 DMI_MATCH(DMI_PRODUCT_NAME, "MS-171F"),}, NULL},
1834 {
1835 ec_honor_ecdt_gpe, "ASUS FX502VD", {
1836 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1837 DMI_MATCH(DMI_PRODUCT_NAME, "FX502VD"),}, NULL},
1838 {
1839 ec_honor_ecdt_gpe, "ASUS FX502VE", {
1840 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1841 DMI_MATCH(DMI_PRODUCT_NAME, "FX502VE"),}, NULL},
1842 {
1843 ec_honor_ecdt_gpe, "ASUS GL702VMK", {
1844 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1845 DMI_MATCH(DMI_PRODUCT_NAME, "GL702VMK"),}, NULL},
1846 {
1847 ec_honor_ecdt_gpe, "ASUS X550VXK", {
1848 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1849 DMI_MATCH(DMI_PRODUCT_NAME, "X550VXK"),}, NULL},
1850 {
1851 ec_honor_ecdt_gpe, "ASUS X580VD", {
1852 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1853 DMI_MATCH(DMI_PRODUCT_NAME, "X580VD"),}, NULL},
1854 {},
1855};
1856
1857int __init acpi_ec_ecdt_probe(void)
1858{
1859 int ret;
1860 acpi_status status;
1861 struct acpi_table_ecdt *ecdt_ptr;
1862 struct acpi_ec *ec;
1863
1864 ec = acpi_ec_alloc();
1865 if (!ec)
1866 return -ENOMEM;
1867 /*
1868 * Generate a boot ec context
1869 */
1870 dmi_check_system(ec_dmi_table);
1871 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1872 (struct acpi_table_header **)&ecdt_ptr);
1873 if (ACPI_FAILURE(status)) {
1874 ret = -ENODEV;
1875 goto error;
1876 }
1877
1878 if (!ecdt_ptr->control.address || !ecdt_ptr->data.address) {
1879 /*
1880 * Asus X50GL:
1881 * https://bugzilla.kernel.org/show_bug.cgi?id=11880
1882 */
1883 ret = -ENODEV;
1884 goto error;
1885 }
1886
1887 if (EC_FLAGS_CORRECT_ECDT) {
1888 ec->command_addr = ecdt_ptr->data.address;
1889 ec->data_addr = ecdt_ptr->control.address;
1890 } else {
1891 ec->command_addr = ecdt_ptr->control.address;
1892 ec->data_addr = ecdt_ptr->data.address;
1893 }
1894 ec->gpe = ecdt_ptr->gpe;
1895
1896 /*
1897 * At this point, the namespace is not initialized, so do not find
1898 * the namespace objects, or handle the events.
1899 */
1900 ret = acpi_config_boot_ec(ec, ACPI_ROOT_OBJECT, false, true);
1901error:
1902 if (ret)
1903 acpi_ec_free(ec);
1904 return ret;
1905}
1906
1907#ifdef CONFIG_PM_SLEEP
1908static int acpi_ec_suspend(struct device *dev)
1909{
1910 struct acpi_ec *ec =
1911 acpi_driver_data(to_acpi_device(dev));
1912
1913 if (acpi_sleep_no_ec_events() && ec_freeze_events)
1914 acpi_ec_disable_event(ec);
1915 return 0;
1916}
1917
1918static int acpi_ec_suspend_noirq(struct device *dev)
1919{
1920 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev));
1921
1922 /*
1923 * The SCI handler doesn't run at this point, so the GPE can be
1924 * masked at the low level without side effects.
1925 */
1926 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) &&
1927 ec->reference_count >= 1)
1928 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
1929
1930 if (acpi_sleep_no_ec_events())
1931 acpi_ec_enter_noirq(ec);
1932
1933 return 0;
1934}
1935
1936static int acpi_ec_resume_noirq(struct device *dev)
1937{
1938 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev));
1939
1940 if (acpi_sleep_no_ec_events())
1941 acpi_ec_leave_noirq(ec);
1942
1943 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) &&
1944 ec->reference_count >= 1)
1945 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
1946
1947 return 0;
1948}
1949
1950static int acpi_ec_resume(struct device *dev)
1951{
1952 struct acpi_ec *ec =
1953 acpi_driver_data(to_acpi_device(dev));
1954
1955 acpi_ec_enable_event(ec);
1956 return 0;
1957}
1958#endif
1959
1960static const struct dev_pm_ops acpi_ec_pm = {
1961 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend_noirq, acpi_ec_resume_noirq)
1962 SET_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend, acpi_ec_resume)
1963};
1964
1965static int param_set_event_clearing(const char *val,
1966 const struct kernel_param *kp)
1967{
1968 int result = 0;
1969
1970 if (!strncmp(val, "status", sizeof("status") - 1)) {
1971 ec_event_clearing = ACPI_EC_EVT_TIMING_STATUS;
1972 pr_info("Assuming SCI_EVT clearing on EC_SC accesses\n");
1973 } else if (!strncmp(val, "query", sizeof("query") - 1)) {
1974 ec_event_clearing = ACPI_EC_EVT_TIMING_QUERY;
1975 pr_info("Assuming SCI_EVT clearing on QR_EC writes\n");
1976 } else if (!strncmp(val, "event", sizeof("event") - 1)) {
1977 ec_event_clearing = ACPI_EC_EVT_TIMING_EVENT;
1978 pr_info("Assuming SCI_EVT clearing on event reads\n");
1979 } else
1980 result = -EINVAL;
1981 return result;
1982}
1983
1984static int param_get_event_clearing(char *buffer,
1985 const struct kernel_param *kp)
1986{
1987 switch (ec_event_clearing) {
1988 case ACPI_EC_EVT_TIMING_STATUS:
1989 return sprintf(buffer, "status");
1990 case ACPI_EC_EVT_TIMING_QUERY:
1991 return sprintf(buffer, "query");
1992 case ACPI_EC_EVT_TIMING_EVENT:
1993 return sprintf(buffer, "event");
1994 default:
1995 return sprintf(buffer, "invalid");
1996 }
1997 return 0;
1998}
1999
2000module_param_call(ec_event_clearing, param_set_event_clearing, param_get_event_clearing,
2001 NULL, 0644);
2002MODULE_PARM_DESC(ec_event_clearing, "Assumed SCI_EVT clearing timing");
2003
2004static struct acpi_driver acpi_ec_driver = {
2005 .name = "ec",
2006 .class = ACPI_EC_CLASS,
2007 .ids = ec_device_ids,
2008 .ops = {
2009 .add = acpi_ec_add,
2010 .remove = acpi_ec_remove,
2011 },
2012 .drv.pm = &acpi_ec_pm,
2013};
2014
2015static inline int acpi_ec_query_init(void)
2016{
2017 if (!ec_query_wq) {
2018 ec_query_wq = alloc_workqueue("kec_query", 0,
2019 ec_max_queries);
2020 if (!ec_query_wq)
2021 return -ENODEV;
2022 }
2023 return 0;
2024}
2025
2026static inline void acpi_ec_query_exit(void)
2027{
2028 if (ec_query_wq) {
2029 destroy_workqueue(ec_query_wq);
2030 ec_query_wq = NULL;
2031 }
2032}
2033
2034int __init acpi_ec_init(void)
2035{
2036 int result;
2037 int ecdt_fail, dsdt_fail;
2038
2039 /* register workqueue for _Qxx evaluations */
2040 result = acpi_ec_query_init();
2041 if (result)
2042 return result;
2043
2044 /* Drivers must be started after acpi_ec_query_init() */
2045 dsdt_fail = acpi_bus_register_driver(&acpi_ec_driver);
2046 /*
2047 * Register ECDT to ACPI bus only when PNP0C09 probe fails. This is
2048 * useful for platforms (confirmed on ASUS X550ZE) with valid ECDT
2049 * settings but invalid DSDT settings.
2050 * https://bugzilla.kernel.org/show_bug.cgi?id=196847
2051 */
2052 ecdt_fail = acpi_ec_ecdt_start();
2053 return ecdt_fail && dsdt_fail ? -ENODEV : 0;
2054}
2055
2056/* EC driver currently not unloadable */
2057#if 0
2058static void __exit acpi_ec_exit(void)
2059{
2060
2061 acpi_bus_unregister_driver(&acpi_ec_driver);
2062 acpi_ec_query_exit();
2063}
2064#endif /* 0 */