2 * ec.c - ACPI Embedded Controller Driver (v2.2)
4 * Copyright (C) 2001-2014 Intel Corporation
5 * Author: 2014 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>
13 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
25 * You should have received a copy of the GNU General Public License along
26 * with this program; if not, write to the Free Software Foundation, Inc.,
27 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
29 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 /* Uncomment next line to get verbose printout */
34 #define pr_fmt(fmt) "ACPI : EC: " fmt
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/init.h>
39 #include <linux/types.h>
40 #include <linux/delay.h>
41 #include <linux/interrupt.h>
42 #include <linux/list.h>
43 #include <linux/spinlock.h>
44 #include <linux/slab.h>
45 #include <linux/acpi.h>
46 #include <linux/dmi.h>
51 #define ACPI_EC_CLASS "embedded_controller"
52 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
53 #define ACPI_EC_FILE_INFO "info"
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_CMD 0x08 /* Input buffer contains a command */
59 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
60 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
64 ACPI_EC_COMMAND_READ = 0x80,
65 ACPI_EC_COMMAND_WRITE = 0x81,
66 ACPI_EC_BURST_ENABLE = 0x82,
67 ACPI_EC_BURST_DISABLE = 0x83,
68 ACPI_EC_COMMAND_QUERY = 0x84,
71 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
72 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
73 #define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
74 #define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
75 * when trying to clear the EC */
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 */
85 #define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
86 #define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
88 /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
89 static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
90 module_param(ec_delay, uint, 0644);
91 MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
94 * If the number of false interrupts per one transaction exceeds
95 * this threshold, will think there is a GPE storm happened and
96 * will disable the GPE for normal transaction.
98 static unsigned int ec_storm_threshold __read_mostly = 8;
99 module_param(ec_storm_threshold, uint, 0644);
100 MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm");
102 struct acpi_ec_query_handler {
103 struct list_head node;
104 acpi_ec_query_func func;
113 unsigned short irq_count;
122 struct acpi_ec *boot_ec, *first_ec;
123 EXPORT_SYMBOL(first_ec);
125 static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
126 static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
127 static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
128 static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */
130 /* --------------------------------------------------------------------------
131 Transaction Management
132 -------------------------------------------------------------------------- */
134 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
136 u8 x = inb(ec->command_addr);
137 pr_debug("EC_SC(R) = 0x%2.2x "
138 "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d\n",
140 !!(x & ACPI_EC_FLAG_SCI),
141 !!(x & ACPI_EC_FLAG_BURST),
142 !!(x & ACPI_EC_FLAG_CMD),
143 !!(x & ACPI_EC_FLAG_IBF),
144 !!(x & ACPI_EC_FLAG_OBF));
148 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
150 u8 x = inb(ec->data_addr);
151 pr_debug("EC_DATA(R) = 0x%2.2x\n", x);
155 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
157 pr_debug("EC_SC(W) = 0x%2.2x\n", command);
158 outb(command, ec->command_addr);
161 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
163 pr_debug("EC_DATA(W) = 0x%2.2x\n", data);
164 outb(data, ec->data_addr);
168 static const char *acpi_ec_cmd_string(u8 cmd)
185 #define acpi_ec_cmd_string(cmd) "UNDEF"
188 static int ec_transaction_completed(struct acpi_ec *ec)
192 spin_lock_irqsave(&ec->lock, flags);
193 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE))
195 spin_unlock_irqrestore(&ec->lock, flags);
199 static bool advance_transaction(struct acpi_ec *ec)
201 struct transaction *t;
205 pr_debug("===== %s (%d) =====\n",
206 in_interrupt() ? "IRQ" : "TASK", smp_processor_id());
207 status = acpi_ec_read_status(ec);
211 if (t->flags & ACPI_EC_COMMAND_POLL) {
212 if (t->wlen > t->wi) {
213 if ((status & ACPI_EC_FLAG_IBF) == 0)
214 acpi_ec_write_data(ec, t->wdata[t->wi++]);
217 } else if (t->rlen > t->ri) {
218 if ((status & ACPI_EC_FLAG_OBF) == 1) {
219 t->rdata[t->ri++] = acpi_ec_read_data(ec);
220 if (t->rlen == t->ri) {
221 t->flags |= ACPI_EC_COMMAND_COMPLETE;
222 if (t->command == ACPI_EC_COMMAND_QUERY)
223 pr_debug("***** Command(%s) hardware completion *****\n",
224 acpi_ec_cmd_string(t->command));
229 } else if (t->wlen == t->wi &&
230 (status & ACPI_EC_FLAG_IBF) == 0) {
231 t->flags |= ACPI_EC_COMMAND_COMPLETE;
237 * There is firmware refusing to respond QR_EC when SCI_EVT
238 * is not set, for which case, we complete the QR_EC
239 * without issuing it to the firmware.
240 * https://bugzilla.kernel.org/show_bug.cgi?id=86211
242 if (!(status & ACPI_EC_FLAG_SCI) &&
243 (t->command == ACPI_EC_COMMAND_QUERY)) {
244 t->flags |= ACPI_EC_COMMAND_POLL;
245 t->rdata[t->ri++] = 0x00;
246 t->flags |= ACPI_EC_COMMAND_COMPLETE;
247 pr_debug("***** Command(%s) software completion *****\n",
248 acpi_ec_cmd_string(t->command));
250 } else if ((status & ACPI_EC_FLAG_IBF) == 0) {
251 acpi_ec_write_cmd(ec, t->command);
252 t->flags |= ACPI_EC_COMMAND_POLL;
259 * If SCI bit is set, then don't think it's a false IRQ
260 * otherwise will take a not handled IRQ as a false one.
262 if (!(status & ACPI_EC_FLAG_SCI)) {
263 if (in_interrupt() && t)
269 static void start_transaction(struct acpi_ec *ec)
271 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
273 (void)advance_transaction(ec);
276 static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data);
278 static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
280 if (state & ACPI_EC_FLAG_SCI) {
281 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
282 return acpi_ec_sync_query(ec, NULL);
287 static int ec_poll(struct acpi_ec *ec)
290 int repeat = 5; /* number of command restarts */
292 unsigned long delay = jiffies +
293 msecs_to_jiffies(ec_delay);
295 /* don't sleep with disabled interrupts */
296 if (EC_FLAGS_MSI || irqs_disabled()) {
297 udelay(ACPI_EC_MSI_UDELAY);
298 if (ec_transaction_completed(ec))
301 if (wait_event_timeout(ec->wait,
302 ec_transaction_completed(ec),
303 msecs_to_jiffies(1)))
306 spin_lock_irqsave(&ec->lock, flags);
307 (void)advance_transaction(ec);
308 spin_unlock_irqrestore(&ec->lock, flags);
309 } while (time_before(jiffies, delay));
310 pr_debug("controller reset, restart transaction\n");
311 spin_lock_irqsave(&ec->lock, flags);
312 start_transaction(ec);
313 spin_unlock_irqrestore(&ec->lock, flags);
318 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
319 struct transaction *t)
324 udelay(ACPI_EC_MSI_UDELAY);
325 /* start transaction */
326 spin_lock_irqsave(&ec->lock, tmp);
327 /* following two actions should be kept atomic */
329 pr_debug("***** Command(%s) started *****\n",
330 acpi_ec_cmd_string(t->command));
331 start_transaction(ec);
332 spin_unlock_irqrestore(&ec->lock, tmp);
334 spin_lock_irqsave(&ec->lock, tmp);
335 if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
336 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
337 pr_debug("***** Command(%s) stopped *****\n",
338 acpi_ec_cmd_string(t->command));
340 spin_unlock_irqrestore(&ec->lock, tmp);
344 static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
348 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
351 memset(t->rdata, 0, t->rlen);
352 mutex_lock(&ec->mutex);
353 if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) {
357 if (ec->global_lock) {
358 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
359 if (ACPI_FAILURE(status)) {
364 /* disable GPE during transaction if storm is detected */
365 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
366 /* It has to be disabled, so that it doesn't trigger. */
367 acpi_disable_gpe(NULL, ec->gpe);
370 status = acpi_ec_transaction_unlocked(ec, t);
372 /* check if we received SCI during transaction */
373 ec_check_sci_sync(ec, acpi_ec_read_status(ec));
374 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
376 /* It is safe to enable the GPE outside of the transaction. */
377 acpi_enable_gpe(NULL, ec->gpe);
378 } else if (t->irq_count > ec_storm_threshold) {
379 pr_info("GPE storm detected(%d GPEs), "
380 "transactions will use polling mode\n",
382 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
385 acpi_release_global_lock(glk);
387 mutex_unlock(&ec->mutex);
391 static int acpi_ec_burst_enable(struct acpi_ec *ec)
394 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
395 .wdata = NULL, .rdata = &d,
396 .wlen = 0, .rlen = 1};
398 return acpi_ec_transaction(ec, &t);
401 static int acpi_ec_burst_disable(struct acpi_ec *ec)
403 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
404 .wdata = NULL, .rdata = NULL,
405 .wlen = 0, .rlen = 0};
407 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
408 acpi_ec_transaction(ec, &t) : 0;
411 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
415 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
416 .wdata = &address, .rdata = &d,
417 .wlen = 1, .rlen = 1};
419 result = acpi_ec_transaction(ec, &t);
424 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
426 u8 wdata[2] = { address, data };
427 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
428 .wdata = wdata, .rdata = NULL,
429 .wlen = 2, .rlen = 0};
431 return acpi_ec_transaction(ec, &t);
434 int ec_read(u8 addr, u8 *val)
442 err = acpi_ec_read(first_ec, addr, &temp_data);
451 EXPORT_SYMBOL(ec_read);
453 int ec_write(u8 addr, u8 val)
460 err = acpi_ec_write(first_ec, addr, val);
465 EXPORT_SYMBOL(ec_write);
467 int ec_transaction(u8 command,
468 const u8 * wdata, unsigned wdata_len,
469 u8 * rdata, unsigned rdata_len)
471 struct transaction t = {.command = command,
472 .wdata = wdata, .rdata = rdata,
473 .wlen = wdata_len, .rlen = rdata_len};
477 return acpi_ec_transaction(first_ec, &t);
480 EXPORT_SYMBOL(ec_transaction);
482 /* Get the handle to the EC device */
483 acpi_handle ec_get_handle(void)
487 return first_ec->handle;
490 EXPORT_SYMBOL(ec_get_handle);
493 * Process _Q events that might have accumulated in the EC.
494 * Run with locked ec mutex.
496 static void acpi_ec_clear(struct acpi_ec *ec)
501 for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) {
502 status = acpi_ec_sync_query(ec, &value);
503 if (status || !value)
507 if (unlikely(i == ACPI_EC_CLEAR_MAX))
508 pr_warn("Warning: Maximum of %d stale EC events cleared\n", i);
510 pr_info("%d stale EC events cleared\n", i);
513 void acpi_ec_block_transactions(void)
515 struct acpi_ec *ec = first_ec;
520 mutex_lock(&ec->mutex);
521 /* Prevent transactions from being carried out */
522 set_bit(EC_FLAGS_BLOCKED, &ec->flags);
523 mutex_unlock(&ec->mutex);
526 void acpi_ec_unblock_transactions(void)
528 struct acpi_ec *ec = first_ec;
533 mutex_lock(&ec->mutex);
534 /* Allow transactions to be carried out again */
535 clear_bit(EC_FLAGS_BLOCKED, &ec->flags);
537 if (EC_FLAGS_CLEAR_ON_RESUME)
540 mutex_unlock(&ec->mutex);
543 void acpi_ec_unblock_transactions_early(void)
546 * Allow transactions to happen again (this function is called from
547 * atomic context during wakeup, so we don't need to acquire the mutex).
550 clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags);
553 static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
557 struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
558 .wdata = NULL, .rdata = &d,
559 .wlen = 0, .rlen = 1};
563 * Query the EC to find out which _Qxx method we need to evaluate.
564 * Note that successful completion of the query causes the ACPI_EC_SCI
565 * bit to be cleared (and thus clearing the interrupt source).
567 result = acpi_ec_transaction_unlocked(ec, &t);
576 /* --------------------------------------------------------------------------
578 -------------------------------------------------------------------------- */
579 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
580 acpi_handle handle, acpi_ec_query_func func,
583 struct acpi_ec_query_handler *handler =
584 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
588 handler->query_bit = query_bit;
589 handler->handle = handle;
590 handler->func = func;
591 handler->data = data;
592 mutex_lock(&ec->mutex);
593 list_add(&handler->node, &ec->list);
594 mutex_unlock(&ec->mutex);
598 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
600 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
602 struct acpi_ec_query_handler *handler, *tmp;
603 mutex_lock(&ec->mutex);
604 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
605 if (query_bit == handler->query_bit) {
606 list_del(&handler->node);
610 mutex_unlock(&ec->mutex);
613 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
615 static void acpi_ec_run(void *cxt)
617 struct acpi_ec_query_handler *handler = cxt;
620 pr_debug("start query execution\n");
622 handler->func(handler->data);
623 else if (handler->handle)
624 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
625 pr_debug("stop query execution\n");
629 static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data)
633 struct acpi_ec_query_handler *handler, *copy;
635 status = acpi_ec_query_unlocked(ec, &value);
641 list_for_each_entry(handler, &ec->list, node) {
642 if (value == handler->query_bit) {
643 /* have custom handler for this bit */
644 copy = kmalloc(sizeof(*handler), GFP_KERNEL);
647 memcpy(copy, handler, sizeof(*copy));
648 pr_debug("push query execution (0x%2x) on queue\n",
650 return acpi_os_execute((copy->func) ?
651 OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
658 static void acpi_ec_gpe_query(void *ec_cxt)
660 struct acpi_ec *ec = ec_cxt;
663 mutex_lock(&ec->mutex);
664 acpi_ec_sync_query(ec, NULL);
665 mutex_unlock(&ec->mutex);
668 static int ec_check_sci(struct acpi_ec *ec, u8 state)
670 if (state & ACPI_EC_FLAG_SCI) {
671 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
672 pr_debug("push gpe query to the queue\n");
673 return acpi_os_execute(OSL_NOTIFY_HANDLER,
674 acpi_ec_gpe_query, ec);
680 static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
681 u32 gpe_number, void *data)
684 struct acpi_ec *ec = data;
686 spin_lock_irqsave(&ec->lock, flags);
687 if (advance_transaction(ec))
689 spin_unlock_irqrestore(&ec->lock, flags);
690 ec_check_sci(ec, acpi_ec_read_status(ec));
691 return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE;
694 /* --------------------------------------------------------------------------
695 Address Space Management
696 -------------------------------------------------------------------------- */
699 acpi_ec_space_handler(u32 function, acpi_physical_address address,
700 u32 bits, u64 *value64,
701 void *handler_context, void *region_context)
703 struct acpi_ec *ec = handler_context;
704 int result = 0, i, bytes = bits / 8;
705 u8 *value = (u8 *)value64;
707 if ((address > 0xFF) || !value || !handler_context)
708 return AE_BAD_PARAMETER;
710 if (function != ACPI_READ && function != ACPI_WRITE)
711 return AE_BAD_PARAMETER;
713 if (EC_FLAGS_MSI || bits > 8)
714 acpi_ec_burst_enable(ec);
716 for (i = 0; i < bytes; ++i, ++address, ++value)
717 result = (function == ACPI_READ) ?
718 acpi_ec_read(ec, address, value) :
719 acpi_ec_write(ec, address, *value);
721 if (EC_FLAGS_MSI || bits > 8)
722 acpi_ec_burst_disable(ec);
726 return AE_BAD_PARAMETER;
739 /* --------------------------------------------------------------------------
741 -------------------------------------------------------------------------- */
743 ec_parse_io_ports(struct acpi_resource *resource, void *context);
745 static struct acpi_ec *make_acpi_ec(void)
747 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
750 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
751 mutex_init(&ec->mutex);
752 init_waitqueue_head(&ec->wait);
753 INIT_LIST_HEAD(&ec->list);
754 spin_lock_init(&ec->lock);
759 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
760 void *context, void **return_value)
763 struct acpi_buffer buffer = { sizeof(node_name), node_name };
764 struct acpi_ec *ec = context;
768 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
770 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
771 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
777 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
780 unsigned long long tmp = 0;
782 struct acpi_ec *ec = context;
784 /* clear addr values, ec_parse_io_ports depend on it */
785 ec->command_addr = ec->data_addr = 0;
787 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
788 ec_parse_io_ports, ec);
789 if (ACPI_FAILURE(status))
792 /* Get GPE bit assignment (EC events). */
793 /* TODO: Add support for _GPE returning a package */
794 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
795 if (ACPI_FAILURE(status))
798 /* Use the global lock for all EC transactions? */
800 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
801 ec->global_lock = tmp;
803 return AE_CTRL_TERMINATE;
806 static int ec_install_handlers(struct acpi_ec *ec)
809 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
811 status = acpi_install_gpe_handler(NULL, ec->gpe,
812 ACPI_GPE_EDGE_TRIGGERED,
813 &acpi_ec_gpe_handler, ec);
814 if (ACPI_FAILURE(status))
817 acpi_enable_gpe(NULL, ec->gpe);
818 status = acpi_install_address_space_handler(ec->handle,
820 &acpi_ec_space_handler,
822 if (ACPI_FAILURE(status)) {
823 if (status == AE_NOT_FOUND) {
825 * Maybe OS fails in evaluating the _REG object.
826 * The AE_NOT_FOUND error will be ignored and OS
827 * continue to initialize EC.
829 pr_err("Fail in evaluating the _REG object"
830 " of EC device. Broken bios is suspected.\n");
832 acpi_disable_gpe(NULL, ec->gpe);
833 acpi_remove_gpe_handler(NULL, ec->gpe,
834 &acpi_ec_gpe_handler);
839 set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
843 static void ec_remove_handlers(struct acpi_ec *ec)
845 acpi_disable_gpe(NULL, ec->gpe);
846 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
847 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
848 pr_err("failed to remove space handler\n");
849 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
850 &acpi_ec_gpe_handler)))
851 pr_err("failed to remove gpe handler\n");
852 clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
855 static int acpi_ec_add(struct acpi_device *device)
857 struct acpi_ec *ec = NULL;
860 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
861 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
863 /* Check for boot EC */
865 (boot_ec->handle == device->handle ||
866 boot_ec->handle == ACPI_ROOT_OBJECT)) {
874 if (ec_parse_device(device->handle, 0, ec, NULL) !=
880 /* Find and register all query methods */
881 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
882 acpi_ec_register_query_methods, NULL, ec, NULL);
886 device->driver_data = ec;
888 ret = !!request_region(ec->data_addr, 1, "EC data");
889 WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr);
890 ret = !!request_region(ec->command_addr, 1, "EC cmd");
891 WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr);
893 pr_info("GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
894 ec->gpe, ec->command_addr, ec->data_addr);
896 ret = ec_install_handlers(ec);
898 /* EC is fully operational, allow queries */
899 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
901 /* Clear stale _Q events if hardware might require that */
902 if (EC_FLAGS_CLEAR_ON_RESUME) {
903 mutex_lock(&ec->mutex);
905 mutex_unlock(&ec->mutex);
910 static int acpi_ec_remove(struct acpi_device *device)
913 struct acpi_ec_query_handler *handler, *tmp;
918 ec = acpi_driver_data(device);
919 ec_remove_handlers(ec);
920 mutex_lock(&ec->mutex);
921 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
922 list_del(&handler->node);
925 mutex_unlock(&ec->mutex);
926 release_region(ec->data_addr, 1);
927 release_region(ec->command_addr, 1);
928 device->driver_data = NULL;
936 ec_parse_io_ports(struct acpi_resource *resource, void *context)
938 struct acpi_ec *ec = context;
940 if (resource->type != ACPI_RESOURCE_TYPE_IO)
944 * The first address region returned is the data port, and
945 * the second address region returned is the status/command
948 if (ec->data_addr == 0)
949 ec->data_addr = resource->data.io.minimum;
950 else if (ec->command_addr == 0)
951 ec->command_addr = resource->data.io.minimum;
953 return AE_CTRL_TERMINATE;
958 int __init acpi_boot_ec_enable(void)
960 if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
962 if (!ec_install_handlers(boot_ec)) {
969 static const struct acpi_device_id ec_device_ids[] = {
974 /* Some BIOS do not survive early DSDT scan, skip it */
975 static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
977 EC_FLAGS_SKIP_DSDT_SCAN = 1;
981 /* ASUStek often supplies us with broken ECDT, validate it */
982 static int ec_validate_ecdt(const struct dmi_system_id *id)
984 EC_FLAGS_VALIDATE_ECDT = 1;
988 /* MSI EC needs special treatment, enable it */
989 static int ec_flag_msi(const struct dmi_system_id *id)
991 pr_debug("Detected MSI hardware, enabling workarounds.\n");
993 EC_FLAGS_VALIDATE_ECDT = 1;
998 * Clevo M720 notebook actually works ok with IRQ mode, if we lifted
999 * the GPE storm threshold back to 20
1001 static int ec_enlarge_storm_threshold(const struct dmi_system_id *id)
1003 pr_debug("Setting the EC GPE storm threshold to 20\n");
1004 ec_storm_threshold = 20;
1009 * On some hardware it is necessary to clear events accumulated by the EC during
1010 * sleep. These ECs stop reporting GPEs until they are manually polled, if too
1011 * many events are accumulated. (e.g. Samsung Series 5/9 notebooks)
1013 * https://bugzilla.kernel.org/show_bug.cgi?id=44161
1015 * Ideally, the EC should also be instructed NOT to accumulate events during
1016 * sleep (which Windows seems to do somehow), but the interface to control this
1017 * behaviour is not known at this time.
1019 * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx,
1020 * however it is very likely that other Samsung models are affected.
1022 * On systems which don't accumulate _Q events during sleep, this extra check
1023 * should be harmless.
1025 static int ec_clear_on_resume(const struct dmi_system_id *id)
1027 pr_debug("Detected system needing EC poll on resume.\n");
1028 EC_FLAGS_CLEAR_ON_RESUME = 1;
1032 static struct dmi_system_id ec_dmi_table[] __initdata = {
1034 ec_skip_dsdt_scan, "Compal JFL92", {
1035 DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
1036 DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
1038 ec_flag_msi, "MSI hardware", {
1039 DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
1041 ec_flag_msi, "MSI hardware", {
1042 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
1044 ec_flag_msi, "MSI hardware", {
1045 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
1047 ec_flag_msi, "MSI hardware", {
1048 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL},
1050 ec_flag_msi, "Quanta hardware", {
1051 DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
1052 DMI_MATCH(DMI_PRODUCT_NAME, "TW8/SW8/DW8"),}, NULL},
1054 ec_flag_msi, "Quanta hardware", {
1055 DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
1056 DMI_MATCH(DMI_PRODUCT_NAME, "TW9/SW9"),}, NULL},
1058 ec_flag_msi, "Clevo W350etq", {
1059 DMI_MATCH(DMI_SYS_VENDOR, "CLEVO CO."),
1060 DMI_MATCH(DMI_PRODUCT_NAME, "W35_37ET"),}, NULL},
1062 ec_validate_ecdt, "ASUS hardware", {
1063 DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
1065 ec_validate_ecdt, "ASUS hardware", {
1066 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL},
1068 ec_enlarge_storm_threshold, "CLEVO hardware", {
1069 DMI_MATCH(DMI_SYS_VENDOR, "CLEVO Co."),
1070 DMI_MATCH(DMI_PRODUCT_NAME, "M720T/M730T"),}, NULL},
1072 ec_skip_dsdt_scan, "HP Folio 13", {
1073 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1074 DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL},
1076 ec_validate_ecdt, "ASUS hardware", {
1077 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTek Computer Inc."),
1078 DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),}, NULL},
1080 ec_clear_on_resume, "Samsung hardware", {
1081 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL},
1085 int __init acpi_ec_ecdt_probe(void)
1088 struct acpi_ec *saved_ec = NULL;
1089 struct acpi_table_ecdt *ecdt_ptr;
1091 boot_ec = make_acpi_ec();
1095 * Generate a boot ec context
1097 dmi_check_system(ec_dmi_table);
1098 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1099 (struct acpi_table_header **)&ecdt_ptr);
1100 if (ACPI_SUCCESS(status)) {
1101 pr_info("EC description table is found, configuring boot EC\n");
1102 boot_ec->command_addr = ecdt_ptr->control.address;
1103 boot_ec->data_addr = ecdt_ptr->data.address;
1104 boot_ec->gpe = ecdt_ptr->gpe;
1105 boot_ec->handle = ACPI_ROOT_OBJECT;
1106 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
1107 /* Don't trust ECDT, which comes from ASUSTek */
1108 if (!EC_FLAGS_VALIDATE_ECDT)
1110 saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
1116 if (EC_FLAGS_SKIP_DSDT_SCAN) {
1121 /* This workaround is needed only on some broken machines,
1122 * which require early EC, but fail to provide ECDT */
1123 pr_debug("Look up EC in DSDT\n");
1124 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
1126 /* Check that acpi_get_devices actually find something */
1127 if (ACPI_FAILURE(status) || !boot_ec->handle)
1130 /* try to find good ECDT from ASUSTek */
1131 if (saved_ec->command_addr != boot_ec->command_addr ||
1132 saved_ec->data_addr != boot_ec->data_addr ||
1133 saved_ec->gpe != boot_ec->gpe ||
1134 saved_ec->handle != boot_ec->handle)
1135 pr_info("ASUSTek keeps feeding us with broken "
1136 "ECDT tables, which are very hard to workaround. "
1137 "Trying to use DSDT EC info instead. Please send "
1138 "output of acpidump to linux-acpi@vger.kernel.org\n");
1142 /* We really need to limit this workaround, the only ASUS,
1143 * which needs it, has fake EC._INI method, so use it as flag.
1144 * Keep boot_ec struct as it will be needed soon.
1146 if (!dmi_name_in_vendors("ASUS") ||
1147 !acpi_has_method(boot_ec->handle, "_INI"))
1151 if (!ec_install_handlers(boot_ec)) {
1162 static struct acpi_driver acpi_ec_driver = {
1164 .class = ACPI_EC_CLASS,
1165 .ids = ec_device_ids,
1168 .remove = acpi_ec_remove,
1172 int __init acpi_ec_init(void)
1176 /* Now register the driver for the EC */
1177 result = acpi_bus_register_driver(&acpi_ec_driver);
1184 /* EC driver currently not unloadable */
1186 static void __exit acpi_ec_exit(void)
1189 acpi_bus_unregister_driver(&acpi_ec_driver);