2 * ec.c - ACPI Embedded Controller Driver (v2.1)
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>
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
26 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 /* Uncomment next line to get verbose printout */
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/proc_fs.h>
38 #include <linux/seq_file.h>
39 #include <linux/interrupt.h>
40 #include <linux/list.h>
41 #include <linux/spinlock.h>
43 #include <acpi/acpi_bus.h>
44 #include <acpi/acpi_drivers.h>
45 #include <linux/dmi.h>
47 #define ACPI_EC_CLASS "embedded_controller"
48 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
49 #define ACPI_EC_FILE_INFO "info"
51 #define PREFIX "ACPI: EC: "
53 /* EC status register */
54 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
55 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
56 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
57 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
61 ACPI_EC_COMMAND_READ = 0x80,
62 ACPI_EC_COMMAND_WRITE = 0x81,
63 ACPI_EC_BURST_ENABLE = 0x82,
64 ACPI_EC_BURST_DISABLE = 0x83,
65 ACPI_EC_COMMAND_QUERY = 0x84,
68 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
69 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
70 #define ACPI_EC_CDELAY 10 /* Wait 10us before polling EC */
71 #define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
73 #define ACPI_EC_STORM_THRESHOLD 8 /* number of false interrupts
74 per one transaction */
77 EC_FLAGS_QUERY_PENDING, /* Query is pending */
78 EC_FLAGS_GPE_STORM, /* GPE storm detected */
79 EC_FLAGS_HANDLERS_INSTALLED /* Handlers for GPE and
80 * OpReg are installed */
83 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
84 /* External interfaces use first EC only, so remember */
85 typedef int (*acpi_ec_query_func) (void *data);
87 struct acpi_ec_query_handler {
88 struct list_head node;
89 acpi_ec_query_func func;
98 unsigned short irq_count;
107 static struct acpi_ec {
110 unsigned long command_addr;
111 unsigned long data_addr;
112 unsigned long global_lock;
115 wait_queue_head_t wait;
116 struct list_head list;
117 struct transaction *curr;
118 spinlock_t curr_lock;
119 } *boot_ec, *first_ec;
121 static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
122 static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
123 static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
125 /* --------------------------------------------------------------------------
126 Transaction Management
127 -------------------------------------------------------------------------- */
129 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
131 u8 x = inb(ec->command_addr);
132 pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
136 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
138 u8 x = inb(ec->data_addr);
139 pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
143 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
145 pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
146 outb(command, ec->command_addr);
149 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
151 pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
152 outb(data, ec->data_addr);
155 static int ec_transaction_done(struct acpi_ec *ec)
159 spin_lock_irqsave(&ec->curr_lock, flags);
160 if (!ec->curr || ec->curr->done)
162 spin_unlock_irqrestore(&ec->curr_lock, flags);
166 static void start_transaction(struct acpi_ec *ec)
168 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
169 ec->curr->done = false;
170 acpi_ec_write_cmd(ec, ec->curr->command);
173 static void advance_transaction(struct acpi_ec *ec, u8 status)
176 spin_lock_irqsave(&ec->curr_lock, flags);
179 if (ec->curr->wlen > ec->curr->wi) {
180 if ((status & ACPI_EC_FLAG_IBF) == 0)
181 acpi_ec_write_data(ec,
182 ec->curr->wdata[ec->curr->wi++]);
185 } else if (ec->curr->rlen > ec->curr->ri) {
186 if ((status & ACPI_EC_FLAG_OBF) == 1) {
187 ec->curr->rdata[ec->curr->ri++] = acpi_ec_read_data(ec);
188 if (ec->curr->rlen == ec->curr->ri)
189 ec->curr->done = true;
192 } else if (ec->curr->wlen == ec->curr->wi &&
193 (status & ACPI_EC_FLAG_IBF) == 0)
194 ec->curr->done = true;
197 /* false interrupt, state didn't change */
199 ++ec->curr->irq_count;
201 spin_unlock_irqrestore(&ec->curr_lock, flags);
204 static int acpi_ec_sync_query(struct acpi_ec *ec);
206 static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
208 if (state & ACPI_EC_FLAG_SCI) {
209 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
210 return acpi_ec_sync_query(ec);
215 static int ec_poll(struct acpi_ec *ec)
218 int repeat = 2; /* number of command restarts */
220 unsigned long delay = jiffies +
221 msecs_to_jiffies(ACPI_EC_DELAY);
223 /* don't sleep with disabled interrupts */
224 if (EC_FLAGS_MSI || irqs_disabled()) {
225 udelay(ACPI_EC_MSI_UDELAY);
226 if (ec_transaction_done(ec))
229 if (wait_event_timeout(ec->wait,
230 ec_transaction_done(ec),
231 msecs_to_jiffies(1)))
234 advance_transaction(ec, acpi_ec_read_status(ec));
235 } while (time_before(jiffies, delay));
236 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
238 pr_debug(PREFIX "controller reset, restart transaction\n");
239 spin_lock_irqsave(&ec->curr_lock, flags);
240 start_transaction(ec);
241 spin_unlock_irqrestore(&ec->curr_lock, flags);
246 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
247 struct transaction *t)
252 udelay(ACPI_EC_MSI_UDELAY);
253 /* start transaction */
254 spin_lock_irqsave(&ec->curr_lock, tmp);
255 /* following two actions should be kept atomic */
257 start_transaction(ec);
258 if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
259 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
260 spin_unlock_irqrestore(&ec->curr_lock, tmp);
262 spin_lock_irqsave(&ec->curr_lock, tmp);
264 spin_unlock_irqrestore(&ec->curr_lock, tmp);
268 static int ec_check_ibf0(struct acpi_ec *ec)
270 u8 status = acpi_ec_read_status(ec);
271 return (status & ACPI_EC_FLAG_IBF) == 0;
274 static int ec_wait_ibf0(struct acpi_ec *ec)
276 unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
277 /* interrupt wait manually if GPE mode is not active */
278 while (time_before(jiffies, delay))
279 if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
280 msecs_to_jiffies(1)))
285 static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
289 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
292 memset(t->rdata, 0, t->rlen);
293 mutex_lock(&ec->lock);
294 if (ec->global_lock) {
295 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
296 if (ACPI_FAILURE(status)) {
301 if (ec_wait_ibf0(ec)) {
302 pr_err(PREFIX "input buffer is not empty, "
303 "aborting transaction\n");
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)) {
311 * It has to be disabled at the hardware level regardless of the
312 * GPE reference counting, so that it doesn't trigger.
314 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
317 status = acpi_ec_transaction_unlocked(ec, t);
319 /* check if we received SCI during transaction */
320 ec_check_sci_sync(ec, acpi_ec_read_status(ec));
321 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
324 * It is safe to enable the GPE outside of the transaction. Use
325 * acpi_set_gpe() for that, since we used it to disable the GPE
328 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
329 } else if (t->irq_count > ACPI_EC_STORM_THRESHOLD) {
330 pr_info(PREFIX "GPE storm detected, "
331 "transactions will use polling mode\n");
332 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
334 pr_debug(PREFIX "transaction end\n");
337 acpi_release_global_lock(glk);
339 mutex_unlock(&ec->lock);
343 static int acpi_ec_burst_enable(struct acpi_ec *ec)
346 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
347 .wdata = NULL, .rdata = &d,
348 .wlen = 0, .rlen = 1};
350 return acpi_ec_transaction(ec, &t);
353 static int acpi_ec_burst_disable(struct acpi_ec *ec)
355 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
356 .wdata = NULL, .rdata = NULL,
357 .wlen = 0, .rlen = 0};
359 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
360 acpi_ec_transaction(ec, &t) : 0;
363 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
367 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
368 .wdata = &address, .rdata = &d,
369 .wlen = 1, .rlen = 1};
371 result = acpi_ec_transaction(ec, &t);
376 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
378 u8 wdata[2] = { address, data };
379 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
380 .wdata = wdata, .rdata = NULL,
381 .wlen = 2, .rlen = 0};
383 return acpi_ec_transaction(ec, &t);
387 * Externally callable EC access functions. For now, assume 1 EC only
389 int ec_burst_enable(void)
393 return acpi_ec_burst_enable(first_ec);
396 EXPORT_SYMBOL(ec_burst_enable);
398 int ec_burst_disable(void)
402 return acpi_ec_burst_disable(first_ec);
405 EXPORT_SYMBOL(ec_burst_disable);
407 int ec_read(u8 addr, u8 * val)
415 err = acpi_ec_read(first_ec, addr, &temp_data);
424 EXPORT_SYMBOL(ec_read);
426 int ec_write(u8 addr, u8 val)
433 err = acpi_ec_write(first_ec, addr, val);
438 EXPORT_SYMBOL(ec_write);
440 int ec_transaction(u8 command,
441 const u8 * wdata, unsigned wdata_len,
442 u8 * rdata, unsigned rdata_len,
445 struct transaction t = {.command = command,
446 .wdata = wdata, .rdata = rdata,
447 .wlen = wdata_len, .rlen = rdata_len};
451 return acpi_ec_transaction(first_ec, &t);
454 EXPORT_SYMBOL(ec_transaction);
456 static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
460 struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
461 .wdata = NULL, .rdata = &d,
462 .wlen = 0, .rlen = 1};
466 * Query the EC to find out which _Qxx method we need to evaluate.
467 * Note that successful completion of the query causes the ACPI_EC_SCI
468 * bit to be cleared (and thus clearing the interrupt source).
470 result = acpi_ec_transaction_unlocked(ec, &t);
479 /* --------------------------------------------------------------------------
481 -------------------------------------------------------------------------- */
482 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
483 acpi_handle handle, acpi_ec_query_func func,
486 struct acpi_ec_query_handler *handler =
487 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
491 handler->query_bit = query_bit;
492 handler->handle = handle;
493 handler->func = func;
494 handler->data = data;
495 mutex_lock(&ec->lock);
496 list_add(&handler->node, &ec->list);
497 mutex_unlock(&ec->lock);
501 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
503 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
505 struct acpi_ec_query_handler *handler, *tmp;
506 mutex_lock(&ec->lock);
507 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
508 if (query_bit == handler->query_bit) {
509 list_del(&handler->node);
513 mutex_unlock(&ec->lock);
516 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
518 static void acpi_ec_run(void *cxt)
520 struct acpi_ec_query_handler *handler = cxt;
523 pr_debug(PREFIX "start query execution\n");
525 handler->func(handler->data);
526 else if (handler->handle)
527 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
528 pr_debug(PREFIX "stop query execution\n");
532 static int acpi_ec_sync_query(struct acpi_ec *ec)
536 struct acpi_ec_query_handler *handler, *copy;
537 if ((status = acpi_ec_query_unlocked(ec, &value)))
539 list_for_each_entry(handler, &ec->list, node) {
540 if (value == handler->query_bit) {
541 /* have custom handler for this bit */
542 copy = kmalloc(sizeof(*handler), GFP_KERNEL);
545 memcpy(copy, handler, sizeof(*copy));
546 pr_debug(PREFIX "push query execution (0x%2x) on queue\n", value);
547 return acpi_os_execute((copy->func) ?
548 OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
555 static void acpi_ec_gpe_query(void *ec_cxt)
557 struct acpi_ec *ec = ec_cxt;
560 mutex_lock(&ec->lock);
561 acpi_ec_sync_query(ec);
562 mutex_unlock(&ec->lock);
565 static void acpi_ec_gpe_query(void *ec_cxt);
567 static int ec_check_sci(struct acpi_ec *ec, u8 state)
569 if (state & ACPI_EC_FLAG_SCI) {
570 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
571 pr_debug(PREFIX "push gpe query to the queue\n");
572 return acpi_os_execute(OSL_NOTIFY_HANDLER,
573 acpi_ec_gpe_query, ec);
579 static u32 acpi_ec_gpe_handler(void *data)
581 struct acpi_ec *ec = data;
583 pr_debug(PREFIX "~~~> interrupt\n");
585 advance_transaction(ec, acpi_ec_read_status(ec));
586 if (ec_transaction_done(ec) &&
587 (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) {
589 ec_check_sci(ec, acpi_ec_read_status(ec));
591 return ACPI_INTERRUPT_HANDLED;
594 /* --------------------------------------------------------------------------
595 Address Space Management
596 -------------------------------------------------------------------------- */
599 acpi_ec_space_handler(u32 function, acpi_physical_address address,
600 u32 bits, u64 *value,
601 void *handler_context, void *region_context)
603 struct acpi_ec *ec = handler_context;
607 if ((address > 0xFF) || !value || !handler_context)
608 return AE_BAD_PARAMETER;
610 if (function != ACPI_READ && function != ACPI_WRITE)
611 return AE_BAD_PARAMETER;
613 if (bits != 8 && acpi_strict)
614 return AE_BAD_PARAMETER;
617 acpi_ec_burst_enable(ec);
619 if (function == ACPI_READ) {
620 result = acpi_ec_read(ec, address, &temp);
623 temp = 0xff & (*value);
624 result = acpi_ec_write(ec, address, temp);
627 for (i = 8; unlikely(bits - i > 0); i += 8) {
629 if (function == ACPI_READ) {
630 result = acpi_ec_read(ec, address, &temp);
631 (*value) |= ((u64)temp) << i;
633 temp = 0xff & ((*value) >> i);
634 result = acpi_ec_write(ec, address, temp);
639 acpi_ec_burst_disable(ec);
643 return AE_BAD_PARAMETER;
656 /* --------------------------------------------------------------------------
658 -------------------------------------------------------------------------- */
660 static struct proc_dir_entry *acpi_ec_dir;
662 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
664 struct acpi_ec *ec = seq->private;
669 seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
670 seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
671 (unsigned)ec->command_addr, (unsigned)ec->data_addr);
672 seq_printf(seq, "use global lock:\t%s\n",
673 ec->global_lock ? "yes" : "no");
678 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
680 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
683 static const struct file_operations acpi_ec_info_ops = {
684 .open = acpi_ec_info_open_fs,
687 .release = single_release,
688 .owner = THIS_MODULE,
691 static int acpi_ec_add_fs(struct acpi_device *device)
693 struct proc_dir_entry *entry = NULL;
695 if (!acpi_device_dir(device)) {
696 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
698 if (!acpi_device_dir(device))
702 entry = proc_create_data(ACPI_EC_FILE_INFO, S_IRUGO,
703 acpi_device_dir(device),
704 &acpi_ec_info_ops, acpi_driver_data(device));
710 static int acpi_ec_remove_fs(struct acpi_device *device)
713 if (acpi_device_dir(device)) {
714 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
715 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
716 acpi_device_dir(device) = NULL;
722 /* --------------------------------------------------------------------------
724 -------------------------------------------------------------------------- */
726 ec_parse_io_ports(struct acpi_resource *resource, void *context);
728 static struct acpi_ec *make_acpi_ec(void)
730 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
733 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
734 mutex_init(&ec->lock);
735 init_waitqueue_head(&ec->wait);
736 INIT_LIST_HEAD(&ec->list);
737 spin_lock_init(&ec->curr_lock);
742 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
743 void *context, void **return_value)
746 struct acpi_buffer buffer = { sizeof(node_name), node_name };
747 struct acpi_ec *ec = context;
751 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
753 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
754 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
760 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
763 unsigned long long tmp = 0;
765 struct acpi_ec *ec = context;
767 /* clear addr values, ec_parse_io_ports depend on it */
768 ec->command_addr = ec->data_addr = 0;
770 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
771 ec_parse_io_ports, ec);
772 if (ACPI_FAILURE(status))
775 /* Get GPE bit assignment (EC events). */
776 /* TODO: Add support for _GPE returning a package */
777 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
778 if (ACPI_FAILURE(status))
781 /* Use the global lock for all EC transactions? */
783 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
784 ec->global_lock = tmp;
786 return AE_CTRL_TERMINATE;
789 static int ec_install_handlers(struct acpi_ec *ec)
792 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
794 status = acpi_install_gpe_handler(NULL, ec->gpe,
795 ACPI_GPE_EDGE_TRIGGERED,
796 &acpi_ec_gpe_handler, ec);
797 if (ACPI_FAILURE(status))
800 acpi_enable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
801 status = acpi_install_address_space_handler(ec->handle,
803 &acpi_ec_space_handler,
805 if (ACPI_FAILURE(status)) {
806 if (status == AE_NOT_FOUND) {
808 * Maybe OS fails in evaluating the _REG object.
809 * The AE_NOT_FOUND error will be ignored and OS
810 * continue to initialize EC.
812 printk(KERN_ERR "Fail in evaluating the _REG object"
813 " of EC device. Broken bios is suspected.\n");
815 acpi_remove_gpe_handler(NULL, ec->gpe,
816 &acpi_ec_gpe_handler);
817 acpi_disable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
822 set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
826 static void ec_remove_handlers(struct acpi_ec *ec)
828 acpi_disable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
829 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
830 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
831 pr_err(PREFIX "failed to remove space handler\n");
832 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
833 &acpi_ec_gpe_handler)))
834 pr_err(PREFIX "failed to remove gpe handler\n");
835 clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
838 static int acpi_ec_add(struct acpi_device *device)
840 struct acpi_ec *ec = NULL;
843 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
844 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
846 /* Check for boot EC */
848 (boot_ec->handle == device->handle ||
849 boot_ec->handle == ACPI_ROOT_OBJECT)) {
857 if (ec_parse_device(device->handle, 0, ec, NULL) !=
863 ec->handle = device->handle;
865 /* Find and register all query methods */
866 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
867 acpi_ec_register_query_methods, NULL, ec, NULL);
871 device->driver_data = ec;
872 acpi_ec_add_fs(device);
873 pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
874 ec->gpe, ec->command_addr, ec->data_addr);
876 ret = ec_install_handlers(ec);
878 /* EC is fully operational, allow queries */
879 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
883 static int acpi_ec_remove(struct acpi_device *device, int type)
886 struct acpi_ec_query_handler *handler, *tmp;
891 ec = acpi_driver_data(device);
892 ec_remove_handlers(ec);
893 mutex_lock(&ec->lock);
894 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
895 list_del(&handler->node);
898 mutex_unlock(&ec->lock);
899 acpi_ec_remove_fs(device);
900 device->driver_data = NULL;
908 ec_parse_io_ports(struct acpi_resource *resource, void *context)
910 struct acpi_ec *ec = context;
912 if (resource->type != ACPI_RESOURCE_TYPE_IO)
916 * The first address region returned is the data port, and
917 * the second address region returned is the status/command
920 if (ec->data_addr == 0)
921 ec->data_addr = resource->data.io.minimum;
922 else if (ec->command_addr == 0)
923 ec->command_addr = resource->data.io.minimum;
925 return AE_CTRL_TERMINATE;
930 int __init acpi_boot_ec_enable(void)
932 if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
934 if (!ec_install_handlers(boot_ec)) {
941 static const struct acpi_device_id ec_device_ids[] = {
946 /* Some BIOS do not survive early DSDT scan, skip it */
947 static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
949 EC_FLAGS_SKIP_DSDT_SCAN = 1;
953 /* ASUStek often supplies us with broken ECDT, validate it */
954 static int ec_validate_ecdt(const struct dmi_system_id *id)
956 EC_FLAGS_VALIDATE_ECDT = 1;
960 /* MSI EC needs special treatment, enable it */
961 static int ec_flag_msi(const struct dmi_system_id *id)
963 printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
965 EC_FLAGS_VALIDATE_ECDT = 1;
969 static struct dmi_system_id __initdata ec_dmi_table[] = {
971 ec_skip_dsdt_scan, "Compal JFL92", {
972 DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
973 DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
975 ec_flag_msi, "MSI hardware", {
976 DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
978 ec_flag_msi, "MSI hardware", {
979 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
981 ec_flag_msi, "MSI hardware", {
982 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
984 ec_validate_ecdt, "ASUS hardware", {
985 DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
990 int __init acpi_ec_ecdt_probe(void)
993 struct acpi_ec *saved_ec = NULL;
994 struct acpi_table_ecdt *ecdt_ptr;
996 boot_ec = make_acpi_ec();
1000 * Generate a boot ec context
1002 dmi_check_system(ec_dmi_table);
1003 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1004 (struct acpi_table_header **)&ecdt_ptr);
1005 if (ACPI_SUCCESS(status)) {
1006 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
1007 boot_ec->command_addr = ecdt_ptr->control.address;
1008 boot_ec->data_addr = ecdt_ptr->data.address;
1009 boot_ec->gpe = ecdt_ptr->gpe;
1010 boot_ec->handle = ACPI_ROOT_OBJECT;
1011 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
1012 /* Don't trust ECDT, which comes from ASUSTek */
1013 if (!EC_FLAGS_VALIDATE_ECDT)
1015 saved_ec = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
1018 memcpy(saved_ec, boot_ec, sizeof(struct acpi_ec));
1022 if (EC_FLAGS_SKIP_DSDT_SCAN)
1025 /* This workaround is needed only on some broken machines,
1026 * which require early EC, but fail to provide ECDT */
1027 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
1028 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
1030 /* Check that acpi_get_devices actually find something */
1031 if (ACPI_FAILURE(status) || !boot_ec->handle)
1034 /* try to find good ECDT from ASUSTek */
1035 if (saved_ec->command_addr != boot_ec->command_addr ||
1036 saved_ec->data_addr != boot_ec->data_addr ||
1037 saved_ec->gpe != boot_ec->gpe ||
1038 saved_ec->handle != boot_ec->handle)
1039 pr_info(PREFIX "ASUSTek keeps feeding us with broken "
1040 "ECDT tables, which are very hard to workaround. "
1041 "Trying to use DSDT EC info instead. Please send "
1042 "output of acpidump to linux-acpi@vger.kernel.org\n");
1046 /* We really need to limit this workaround, the only ASUS,
1047 * which needs it, has fake EC._INI method, so use it as flag.
1048 * Keep boot_ec struct as it will be needed soon.
1051 if (!dmi_name_in_vendors("ASUS") ||
1052 ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI",
1057 if (!ec_install_handlers(boot_ec)) {
1067 static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
1069 struct acpi_ec *ec = acpi_driver_data(device);
1070 /* Stop using the GPE, but keep it reference counted. */
1071 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
1075 static int acpi_ec_resume(struct acpi_device *device)
1077 struct acpi_ec *ec = acpi_driver_data(device);
1078 /* Enable the GPE again, but don't reference count it once more. */
1079 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
1083 static struct acpi_driver acpi_ec_driver = {
1085 .class = ACPI_EC_CLASS,
1086 .ids = ec_device_ids,
1089 .remove = acpi_ec_remove,
1090 .suspend = acpi_ec_suspend,
1091 .resume = acpi_ec_resume,
1095 int __init acpi_ec_init(void)
1099 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1103 /* Now register the driver for the EC */
1104 result = acpi_bus_register_driver(&acpi_ec_driver);
1106 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1113 /* EC driver currently not unloadable */
1115 static void __exit acpi_ec_exit(void)
1118 acpi_bus_unregister_driver(&acpi_ec_driver);
1120 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);