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>
42 #include <linux/slab.h>
44 #include <acpi/acpi_bus.h>
45 #include <acpi/acpi_drivers.h>
46 #include <linux/dmi.h>
48 #define ACPI_EC_CLASS "embedded_controller"
49 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
50 #define ACPI_EC_FILE_INFO "info"
52 #define PREFIX "ACPI: EC: "
54 /* EC status register */
55 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
56 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
57 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
58 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
62 ACPI_EC_COMMAND_READ = 0x80,
63 ACPI_EC_COMMAND_WRITE = 0x81,
64 ACPI_EC_BURST_ENABLE = 0x82,
65 ACPI_EC_BURST_DISABLE = 0x83,
66 ACPI_EC_COMMAND_QUERY = 0x84,
69 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
70 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
71 #define ACPI_EC_CDELAY 10 /* Wait 10us before polling EC */
72 #define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
74 #define ACPI_EC_STORM_THRESHOLD 8 /* number of false interrupts
75 per one transaction */
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 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
86 /* External interfaces use first EC only, so remember */
87 typedef int (*acpi_ec_query_func) (void *data);
89 struct acpi_ec_query_handler {
90 struct list_head node;
91 acpi_ec_query_func func;
100 unsigned short irq_count;
109 static struct acpi_ec {
112 unsigned long command_addr;
113 unsigned long data_addr;
114 unsigned long global_lock;
117 wait_queue_head_t wait;
118 struct list_head list;
119 struct transaction *curr;
120 spinlock_t curr_lock;
121 } *boot_ec, *first_ec;
123 static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
124 static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
125 static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
127 /* --------------------------------------------------------------------------
128 Transaction Management
129 -------------------------------------------------------------------------- */
131 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
133 u8 x = inb(ec->command_addr);
134 pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
138 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
140 u8 x = inb(ec->data_addr);
141 pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
145 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
147 pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
148 outb(command, ec->command_addr);
151 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
153 pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
154 outb(data, ec->data_addr);
157 static int ec_transaction_done(struct acpi_ec *ec)
161 spin_lock_irqsave(&ec->curr_lock, flags);
162 if (!ec->curr || ec->curr->done)
164 spin_unlock_irqrestore(&ec->curr_lock, flags);
168 static void start_transaction(struct acpi_ec *ec)
170 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
171 ec->curr->done = false;
172 acpi_ec_write_cmd(ec, ec->curr->command);
175 static void advance_transaction(struct acpi_ec *ec, u8 status)
178 spin_lock_irqsave(&ec->curr_lock, flags);
181 if (ec->curr->wlen > ec->curr->wi) {
182 if ((status & ACPI_EC_FLAG_IBF) == 0)
183 acpi_ec_write_data(ec,
184 ec->curr->wdata[ec->curr->wi++]);
187 } else if (ec->curr->rlen > ec->curr->ri) {
188 if ((status & ACPI_EC_FLAG_OBF) == 1) {
189 ec->curr->rdata[ec->curr->ri++] = acpi_ec_read_data(ec);
190 if (ec->curr->rlen == ec->curr->ri)
191 ec->curr->done = true;
194 } else if (ec->curr->wlen == ec->curr->wi &&
195 (status & ACPI_EC_FLAG_IBF) == 0)
196 ec->curr->done = true;
199 /* false interrupt, state didn't change */
201 ++ec->curr->irq_count;
203 spin_unlock_irqrestore(&ec->curr_lock, flags);
206 static int acpi_ec_sync_query(struct acpi_ec *ec);
208 static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
210 if (state & ACPI_EC_FLAG_SCI) {
211 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
212 return acpi_ec_sync_query(ec);
217 static int ec_poll(struct acpi_ec *ec)
220 int repeat = 2; /* number of command restarts */
222 unsigned long delay = jiffies +
223 msecs_to_jiffies(ACPI_EC_DELAY);
225 /* don't sleep with disabled interrupts */
226 if (EC_FLAGS_MSI || irqs_disabled()) {
227 udelay(ACPI_EC_MSI_UDELAY);
228 if (ec_transaction_done(ec))
231 if (wait_event_timeout(ec->wait,
232 ec_transaction_done(ec),
233 msecs_to_jiffies(1)))
236 advance_transaction(ec, acpi_ec_read_status(ec));
237 } while (time_before(jiffies, delay));
238 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
240 pr_debug(PREFIX "controller reset, restart transaction\n");
241 spin_lock_irqsave(&ec->curr_lock, flags);
242 start_transaction(ec);
243 spin_unlock_irqrestore(&ec->curr_lock, flags);
248 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
249 struct transaction *t)
254 udelay(ACPI_EC_MSI_UDELAY);
255 /* start transaction */
256 spin_lock_irqsave(&ec->curr_lock, tmp);
257 /* following two actions should be kept atomic */
259 start_transaction(ec);
260 if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
261 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
262 spin_unlock_irqrestore(&ec->curr_lock, tmp);
264 spin_lock_irqsave(&ec->curr_lock, tmp);
266 spin_unlock_irqrestore(&ec->curr_lock, tmp);
270 static int ec_check_ibf0(struct acpi_ec *ec)
272 u8 status = acpi_ec_read_status(ec);
273 return (status & ACPI_EC_FLAG_IBF) == 0;
276 static int ec_wait_ibf0(struct acpi_ec *ec)
278 unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
279 /* interrupt wait manually if GPE mode is not active */
280 while (time_before(jiffies, delay))
281 if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
282 msecs_to_jiffies(1)))
287 static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
291 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
294 memset(t->rdata, 0, t->rlen);
295 mutex_lock(&ec->lock);
296 if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) {
300 if (ec->global_lock) {
301 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
302 if (ACPI_FAILURE(status)) {
307 if (ec_wait_ibf0(ec)) {
308 pr_err(PREFIX "input buffer is not empty, "
309 "aborting transaction\n");
313 pr_debug(PREFIX "transaction start\n");
314 /* disable GPE during transaction if storm is detected */
315 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
317 * It has to be disabled at the hardware level regardless of the
318 * GPE reference counting, so that it doesn't trigger.
320 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
323 status = acpi_ec_transaction_unlocked(ec, t);
325 /* check if we received SCI during transaction */
326 ec_check_sci_sync(ec, acpi_ec_read_status(ec));
327 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
330 * It is safe to enable the GPE outside of the transaction. Use
331 * acpi_set_gpe() for that, since we used it to disable the GPE
334 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
335 } else if (t->irq_count > ACPI_EC_STORM_THRESHOLD) {
336 pr_info(PREFIX "GPE storm detected, "
337 "transactions will use polling mode\n");
338 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
340 pr_debug(PREFIX "transaction end\n");
343 acpi_release_global_lock(glk);
345 mutex_unlock(&ec->lock);
349 static int acpi_ec_burst_enable(struct acpi_ec *ec)
352 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
353 .wdata = NULL, .rdata = &d,
354 .wlen = 0, .rlen = 1};
356 return acpi_ec_transaction(ec, &t);
359 static int acpi_ec_burst_disable(struct acpi_ec *ec)
361 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
362 .wdata = NULL, .rdata = NULL,
363 .wlen = 0, .rlen = 0};
365 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
366 acpi_ec_transaction(ec, &t) : 0;
369 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
373 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
374 .wdata = &address, .rdata = &d,
375 .wlen = 1, .rlen = 1};
377 result = acpi_ec_transaction(ec, &t);
382 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
384 u8 wdata[2] = { address, data };
385 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
386 .wdata = wdata, .rdata = NULL,
387 .wlen = 2, .rlen = 0};
389 return acpi_ec_transaction(ec, &t);
393 * Externally callable EC access functions. For now, assume 1 EC only
395 int ec_burst_enable(void)
399 return acpi_ec_burst_enable(first_ec);
402 EXPORT_SYMBOL(ec_burst_enable);
404 int ec_burst_disable(void)
408 return acpi_ec_burst_disable(first_ec);
411 EXPORT_SYMBOL(ec_burst_disable);
413 int ec_read(u8 addr, u8 * val)
421 err = acpi_ec_read(first_ec, addr, &temp_data);
430 EXPORT_SYMBOL(ec_read);
432 int ec_write(u8 addr, u8 val)
439 err = acpi_ec_write(first_ec, addr, val);
444 EXPORT_SYMBOL(ec_write);
446 int ec_transaction(u8 command,
447 const u8 * wdata, unsigned wdata_len,
448 u8 * rdata, unsigned rdata_len,
451 struct transaction t = {.command = command,
452 .wdata = wdata, .rdata = rdata,
453 .wlen = wdata_len, .rlen = rdata_len};
457 return acpi_ec_transaction(first_ec, &t);
460 EXPORT_SYMBOL(ec_transaction);
462 void acpi_ec_block_transactions(void)
464 struct acpi_ec *ec = first_ec;
469 mutex_lock(&ec->lock);
470 /* Prevent transactions from being carried out */
471 set_bit(EC_FLAGS_BLOCKED, &ec->flags);
472 mutex_unlock(&ec->lock);
475 void acpi_ec_unblock_transactions(void)
477 struct acpi_ec *ec = first_ec;
482 mutex_lock(&ec->lock);
483 /* Allow transactions to be carried out again */
484 clear_bit(EC_FLAGS_BLOCKED, &ec->flags);
485 mutex_unlock(&ec->lock);
488 void acpi_ec_unblock_transactions_early(void)
491 * Allow transactions to happen again (this function is called from
492 * atomic context during wakeup, so we don't need to acquire the mutex).
495 clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags);
498 static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
502 struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
503 .wdata = NULL, .rdata = &d,
504 .wlen = 0, .rlen = 1};
508 * Query the EC to find out which _Qxx method we need to evaluate.
509 * Note that successful completion of the query causes the ACPI_EC_SCI
510 * bit to be cleared (and thus clearing the interrupt source).
512 result = acpi_ec_transaction_unlocked(ec, &t);
521 /* --------------------------------------------------------------------------
523 -------------------------------------------------------------------------- */
524 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
525 acpi_handle handle, acpi_ec_query_func func,
528 struct acpi_ec_query_handler *handler =
529 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
533 handler->query_bit = query_bit;
534 handler->handle = handle;
535 handler->func = func;
536 handler->data = data;
537 mutex_lock(&ec->lock);
538 list_add(&handler->node, &ec->list);
539 mutex_unlock(&ec->lock);
543 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
545 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
547 struct acpi_ec_query_handler *handler, *tmp;
548 mutex_lock(&ec->lock);
549 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
550 if (query_bit == handler->query_bit) {
551 list_del(&handler->node);
555 mutex_unlock(&ec->lock);
558 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
560 static void acpi_ec_run(void *cxt)
562 struct acpi_ec_query_handler *handler = cxt;
565 pr_debug(PREFIX "start query execution\n");
567 handler->func(handler->data);
568 else if (handler->handle)
569 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
570 pr_debug(PREFIX "stop query execution\n");
574 static int acpi_ec_sync_query(struct acpi_ec *ec)
578 struct acpi_ec_query_handler *handler, *copy;
579 if ((status = acpi_ec_query_unlocked(ec, &value)))
581 list_for_each_entry(handler, &ec->list, node) {
582 if (value == handler->query_bit) {
583 /* have custom handler for this bit */
584 copy = kmalloc(sizeof(*handler), GFP_KERNEL);
587 memcpy(copy, handler, sizeof(*copy));
588 pr_debug(PREFIX "push query execution (0x%2x) on queue\n", value);
589 return acpi_os_execute((copy->func) ?
590 OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
597 static void acpi_ec_gpe_query(void *ec_cxt)
599 struct acpi_ec *ec = ec_cxt;
602 mutex_lock(&ec->lock);
603 acpi_ec_sync_query(ec);
604 mutex_unlock(&ec->lock);
607 static void acpi_ec_gpe_query(void *ec_cxt);
609 static int ec_check_sci(struct acpi_ec *ec, u8 state)
611 if (state & ACPI_EC_FLAG_SCI) {
612 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
613 pr_debug(PREFIX "push gpe query to the queue\n");
614 return acpi_os_execute(OSL_NOTIFY_HANDLER,
615 acpi_ec_gpe_query, ec);
621 static u32 acpi_ec_gpe_handler(void *data)
623 struct acpi_ec *ec = data;
625 pr_debug(PREFIX "~~~> interrupt\n");
627 advance_transaction(ec, acpi_ec_read_status(ec));
628 if (ec_transaction_done(ec) &&
629 (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) {
631 ec_check_sci(ec, acpi_ec_read_status(ec));
633 return ACPI_INTERRUPT_HANDLED;
636 /* --------------------------------------------------------------------------
637 Address Space Management
638 -------------------------------------------------------------------------- */
641 acpi_ec_space_handler(u32 function, acpi_physical_address address,
642 u32 bits, u64 *value64,
643 void *handler_context, void *region_context)
645 struct acpi_ec *ec = handler_context;
646 int result = 0, i, bytes = bits / 8;
647 u8 *value = (u8 *)value64;
649 if ((address > 0xFF) || !value || !handler_context)
650 return AE_BAD_PARAMETER;
652 if (function != ACPI_READ && function != ACPI_WRITE)
653 return AE_BAD_PARAMETER;
655 if (EC_FLAGS_MSI || bits > 8)
656 acpi_ec_burst_enable(ec);
658 for (i = 0; i < bytes; ++i, ++address, ++value)
659 result = (function == ACPI_READ) ?
660 acpi_ec_read(ec, address, value) :
661 acpi_ec_write(ec, address, *value);
663 if (EC_FLAGS_MSI || bits > 8)
664 acpi_ec_burst_disable(ec);
668 return AE_BAD_PARAMETER;
681 /* --------------------------------------------------------------------------
683 -------------------------------------------------------------------------- */
685 static struct proc_dir_entry *acpi_ec_dir;
687 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
689 struct acpi_ec *ec = seq->private;
694 seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
695 seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
696 (unsigned)ec->command_addr, (unsigned)ec->data_addr);
697 seq_printf(seq, "use global lock:\t%s\n",
698 ec->global_lock ? "yes" : "no");
703 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
705 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
708 static const struct file_operations acpi_ec_info_ops = {
709 .open = acpi_ec_info_open_fs,
712 .release = single_release,
713 .owner = THIS_MODULE,
716 static int acpi_ec_add_fs(struct acpi_device *device)
718 struct proc_dir_entry *entry = NULL;
720 if (!acpi_device_dir(device)) {
721 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
723 if (!acpi_device_dir(device))
727 entry = proc_create_data(ACPI_EC_FILE_INFO, S_IRUGO,
728 acpi_device_dir(device),
729 &acpi_ec_info_ops, acpi_driver_data(device));
735 static int acpi_ec_remove_fs(struct acpi_device *device)
738 if (acpi_device_dir(device)) {
739 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
740 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
741 acpi_device_dir(device) = NULL;
747 /* --------------------------------------------------------------------------
749 -------------------------------------------------------------------------- */
751 ec_parse_io_ports(struct acpi_resource *resource, void *context);
753 static struct acpi_ec *make_acpi_ec(void)
755 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
758 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
759 mutex_init(&ec->lock);
760 init_waitqueue_head(&ec->wait);
761 INIT_LIST_HEAD(&ec->list);
762 spin_lock_init(&ec->curr_lock);
767 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
768 void *context, void **return_value)
771 struct acpi_buffer buffer = { sizeof(node_name), node_name };
772 struct acpi_ec *ec = context;
776 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
778 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
779 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
785 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
788 unsigned long long tmp = 0;
790 struct acpi_ec *ec = context;
792 /* clear addr values, ec_parse_io_ports depend on it */
793 ec->command_addr = ec->data_addr = 0;
795 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
796 ec_parse_io_ports, ec);
797 if (ACPI_FAILURE(status))
800 /* Get GPE bit assignment (EC events). */
801 /* TODO: Add support for _GPE returning a package */
802 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
803 if (ACPI_FAILURE(status))
806 /* Use the global lock for all EC transactions? */
808 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
809 ec->global_lock = tmp;
811 return AE_CTRL_TERMINATE;
814 static int ec_install_handlers(struct acpi_ec *ec)
817 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
819 status = acpi_install_gpe_handler(NULL, ec->gpe,
820 ACPI_GPE_EDGE_TRIGGERED,
821 &acpi_ec_gpe_handler, ec);
822 if (ACPI_FAILURE(status))
825 acpi_enable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
826 status = acpi_install_address_space_handler(ec->handle,
828 &acpi_ec_space_handler,
830 if (ACPI_FAILURE(status)) {
831 if (status == AE_NOT_FOUND) {
833 * Maybe OS fails in evaluating the _REG object.
834 * The AE_NOT_FOUND error will be ignored and OS
835 * continue to initialize EC.
837 printk(KERN_ERR "Fail in evaluating the _REG object"
838 " of EC device. Broken bios is suspected.\n");
840 acpi_remove_gpe_handler(NULL, ec->gpe,
841 &acpi_ec_gpe_handler);
842 acpi_disable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
847 set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
851 static void ec_remove_handlers(struct acpi_ec *ec)
853 acpi_disable_gpe(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
854 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
855 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
856 pr_err(PREFIX "failed to remove space handler\n");
857 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
858 &acpi_ec_gpe_handler)))
859 pr_err(PREFIX "failed to remove gpe handler\n");
860 clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
863 static int acpi_ec_add(struct acpi_device *device)
865 struct acpi_ec *ec = NULL;
868 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
869 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
871 /* Check for boot EC */
873 (boot_ec->handle == device->handle ||
874 boot_ec->handle == ACPI_ROOT_OBJECT)) {
882 if (ec_parse_device(device->handle, 0, ec, NULL) !=
888 ec->handle = device->handle;
890 /* Find and register all query methods */
891 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
892 acpi_ec_register_query_methods, NULL, ec, NULL);
896 device->driver_data = ec;
897 acpi_ec_add_fs(device);
898 pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
899 ec->gpe, ec->command_addr, ec->data_addr);
901 ret = ec_install_handlers(ec);
903 /* EC is fully operational, allow queries */
904 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
908 static int acpi_ec_remove(struct acpi_device *device, int type)
911 struct acpi_ec_query_handler *handler, *tmp;
916 ec = acpi_driver_data(device);
917 ec_remove_handlers(ec);
918 mutex_lock(&ec->lock);
919 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
920 list_del(&handler->node);
923 mutex_unlock(&ec->lock);
924 acpi_ec_remove_fs(device);
925 device->driver_data = NULL;
933 ec_parse_io_ports(struct acpi_resource *resource, void *context)
935 struct acpi_ec *ec = context;
937 if (resource->type != ACPI_RESOURCE_TYPE_IO)
941 * The first address region returned is the data port, and
942 * the second address region returned is the status/command
945 if (ec->data_addr == 0)
946 ec->data_addr = resource->data.io.minimum;
947 else if (ec->command_addr == 0)
948 ec->command_addr = resource->data.io.minimum;
950 return AE_CTRL_TERMINATE;
955 int __init acpi_boot_ec_enable(void)
957 if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
959 if (!ec_install_handlers(boot_ec)) {
966 static const struct acpi_device_id ec_device_ids[] = {
971 /* Some BIOS do not survive early DSDT scan, skip it */
972 static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
974 EC_FLAGS_SKIP_DSDT_SCAN = 1;
978 /* ASUStek often supplies us with broken ECDT, validate it */
979 static int ec_validate_ecdt(const struct dmi_system_id *id)
981 EC_FLAGS_VALIDATE_ECDT = 1;
985 /* MSI EC needs special treatment, enable it */
986 static int ec_flag_msi(const struct dmi_system_id *id)
988 printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
990 EC_FLAGS_VALIDATE_ECDT = 1;
994 static struct dmi_system_id __initdata ec_dmi_table[] = {
996 ec_skip_dsdt_scan, "Compal JFL92", {
997 DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
998 DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
1000 ec_flag_msi, "MSI hardware", {
1001 DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
1003 ec_flag_msi, "MSI hardware", {
1004 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
1006 ec_flag_msi, "MSI hardware", {
1007 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
1009 ec_validate_ecdt, "ASUS hardware", {
1010 DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
1015 int __init acpi_ec_ecdt_probe(void)
1018 struct acpi_ec *saved_ec = NULL;
1019 struct acpi_table_ecdt *ecdt_ptr;
1021 boot_ec = make_acpi_ec();
1025 * Generate a boot ec context
1027 dmi_check_system(ec_dmi_table);
1028 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1029 (struct acpi_table_header **)&ecdt_ptr);
1030 if (ACPI_SUCCESS(status)) {
1031 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
1032 boot_ec->command_addr = ecdt_ptr->control.address;
1033 boot_ec->data_addr = ecdt_ptr->data.address;
1034 boot_ec->gpe = ecdt_ptr->gpe;
1035 boot_ec->handle = ACPI_ROOT_OBJECT;
1036 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
1037 /* Don't trust ECDT, which comes from ASUSTek */
1038 if (!EC_FLAGS_VALIDATE_ECDT)
1040 saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
1046 if (EC_FLAGS_SKIP_DSDT_SCAN)
1049 /* This workaround is needed only on some broken machines,
1050 * which require early EC, but fail to provide ECDT */
1051 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
1052 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
1054 /* Check that acpi_get_devices actually find something */
1055 if (ACPI_FAILURE(status) || !boot_ec->handle)
1058 /* try to find good ECDT from ASUSTek */
1059 if (saved_ec->command_addr != boot_ec->command_addr ||
1060 saved_ec->data_addr != boot_ec->data_addr ||
1061 saved_ec->gpe != boot_ec->gpe ||
1062 saved_ec->handle != boot_ec->handle)
1063 pr_info(PREFIX "ASUSTek keeps feeding us with broken "
1064 "ECDT tables, which are very hard to workaround. "
1065 "Trying to use DSDT EC info instead. Please send "
1066 "output of acpidump to linux-acpi@vger.kernel.org\n");
1070 /* We really need to limit this workaround, the only ASUS,
1071 * which needs it, has fake EC._INI method, so use it as flag.
1072 * Keep boot_ec struct as it will be needed soon.
1075 if (!dmi_name_in_vendors("ASUS") ||
1076 ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI",
1081 if (!ec_install_handlers(boot_ec)) {
1091 static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
1093 struct acpi_ec *ec = acpi_driver_data(device);
1094 /* Stop using the GPE, but keep it reference counted. */
1095 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
1099 static int acpi_ec_resume(struct acpi_device *device)
1101 struct acpi_ec *ec = acpi_driver_data(device);
1102 /* Enable the GPE again, but don't reference count it once more. */
1103 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
1107 static struct acpi_driver acpi_ec_driver = {
1109 .class = ACPI_EC_CLASS,
1110 .ids = ec_device_ids,
1113 .remove = acpi_ec_remove,
1114 .suspend = acpi_ec_suspend,
1115 .resume = acpi_ec_resume,
1119 int __init acpi_ec_init(void)
1123 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1127 /* Now register the driver for the EC */
1128 result = acpi_bus_register_driver(&acpi_ec_driver);
1130 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1137 /* EC driver currently not unloadable */
1139 static void __exit acpi_ec_exit(void)
1142 acpi_bus_unregister_driver(&acpi_ec_driver);
1144 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);