2 * ec.c - ACPI Embedded Controller Driver (v2.0)
4 * Copyright (C) 2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
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 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/types.h>
33 #include <linux/delay.h>
34 #include <linux/proc_fs.h>
35 #include <linux/seq_file.h>
36 #include <linux/interrupt.h>
37 #include <linux/list.h>
39 #include <acpi/acpi_bus.h>
40 #include <acpi/acpi_drivers.h>
41 #include <acpi/actypes.h>
43 #define ACPI_EC_CLASS "embedded_controller"
44 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
45 #define ACPI_EC_FILE_INFO "info"
48 #define PREFIX "ACPI: EC: "
50 /* EC status register */
51 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
52 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
53 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
54 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
58 ACPI_EC_COMMAND_READ = 0x80,
59 ACPI_EC_COMMAND_WRITE = 0x81,
60 ACPI_EC_BURST_ENABLE = 0x82,
61 ACPI_EC_BURST_DISABLE = 0x83,
62 ACPI_EC_COMMAND_QUERY = 0x84,
67 ACPI_EC_EVENT_OBF_1 = 1, /* Output buffer full */
68 ACPI_EC_EVENT_IBF_0, /* Input buffer empty */
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 */
75 EC_INTR = 1, /* Output buffer full */
76 EC_POLL, /* Input buffer empty */
77 } acpi_ec_mode = EC_INTR;
79 static int acpi_ec_remove(struct acpi_device *device, int type);
80 static int acpi_ec_start(struct acpi_device *device);
81 static int acpi_ec_stop(struct acpi_device *device, int type);
82 static int acpi_ec_add(struct acpi_device *device);
84 static const struct acpi_device_id ec_device_ids[] = {
89 static struct acpi_driver acpi_ec_driver = {
91 .class = ACPI_EC_CLASS,
95 .remove = acpi_ec_remove,
96 .start = acpi_ec_start,
101 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
102 /* External interfaces use first EC only, so remember */
103 typedef int (*acpi_ec_query_func) (void *data);
105 struct acpi_ec_query_handler {
106 struct list_head node;
107 acpi_ec_query_func func;
113 static struct acpi_ec {
116 unsigned long command_addr;
117 unsigned long data_addr;
118 unsigned long global_lock;
120 atomic_t query_pending;
121 atomic_t event_count;
122 wait_queue_head_t wait;
123 struct list_head list;
124 } *boot_ec, *first_ec;
126 /* --------------------------------------------------------------------------
127 Transaction Management
128 -------------------------------------------------------------------------- */
130 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
132 return inb(ec->command_addr);
135 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
137 return inb(ec->data_addr);
140 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
142 outb(command, ec->command_addr);
145 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
147 outb(data, ec->data_addr);
150 static inline int acpi_ec_check_status(struct acpi_ec *ec, enum ec_event event,
153 u8 status = acpi_ec_read_status(ec);
154 if (old_count == atomic_read(&ec->event_count))
156 if (event == ACPI_EC_EVENT_OBF_1) {
157 if (status & ACPI_EC_FLAG_OBF)
159 } else if (event == ACPI_EC_EVENT_IBF_0) {
160 if (!(status & ACPI_EC_FLAG_IBF))
167 static int acpi_ec_wait(struct acpi_ec *ec, enum ec_event event,
168 unsigned count, int force_poll)
170 if (unlikely(force_poll) || acpi_ec_mode == EC_POLL) {
171 unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
172 while (time_before(jiffies, delay)) {
173 if (acpi_ec_check_status(ec, event, 0))
177 if (wait_event_timeout(ec->wait,
178 acpi_ec_check_status(ec, event, count),
179 msecs_to_jiffies(ACPI_EC_DELAY)) ||
180 acpi_ec_check_status(ec, event, 0)) {
183 printk(KERN_ERR PREFIX "acpi_ec_wait timeout,"
184 " status = %d, expect_event = %d\n",
185 acpi_ec_read_status(ec), event);
192 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
193 const u8 * wdata, unsigned wdata_len,
194 u8 * rdata, unsigned rdata_len,
198 unsigned count = atomic_read(&ec->event_count);
199 acpi_ec_write_cmd(ec, command);
201 for (; wdata_len > 0; --wdata_len) {
202 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, count, force_poll);
204 printk(KERN_ERR PREFIX
205 "write_cmd timeout, command = %d\n", command);
208 count = atomic_read(&ec->event_count);
209 acpi_ec_write_data(ec, *(wdata++));
213 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, count, force_poll);
215 printk(KERN_ERR PREFIX
216 "finish-write timeout, command = %d\n", command);
219 } else if (command == ACPI_EC_COMMAND_QUERY) {
220 atomic_set(&ec->query_pending, 0);
223 for (; rdata_len > 0; --rdata_len) {
224 result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1, count, force_poll);
226 printk(KERN_ERR PREFIX "read timeout, command = %d\n",
230 count = atomic_read(&ec->event_count);
231 *(rdata++) = acpi_ec_read_data(ec);
237 static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
238 const u8 * wdata, unsigned wdata_len,
239 u8 * rdata, unsigned rdata_len,
245 if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
249 memset(rdata, 0, rdata_len);
251 mutex_lock(&ec->lock);
252 if (ec->global_lock) {
253 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
254 if (ACPI_FAILURE(status)) {
255 mutex_unlock(&ec->lock);
260 /* Make sure GPE is enabled before doing transaction */
261 acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
263 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, 0, 0);
265 printk(KERN_ERR PREFIX
266 "input buffer is not empty, aborting transaction\n");
270 status = acpi_ec_transaction_unlocked(ec, command,
278 acpi_release_global_lock(glk);
279 mutex_unlock(&ec->lock);
285 * Note: samsung nv5000 doesn't work with ec burst mode.
286 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
288 int acpi_ec_burst_enable(struct acpi_ec *ec)
291 return acpi_ec_transaction(ec, ACPI_EC_BURST_ENABLE, NULL, 0, &d, 1, 0);
294 int acpi_ec_burst_disable(struct acpi_ec *ec)
296 return acpi_ec_transaction(ec, ACPI_EC_BURST_DISABLE, NULL, 0, NULL, 0, 0);
299 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
304 result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
305 &address, 1, &d, 1, 0);
310 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
312 u8 wdata[2] = { address, data };
313 return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
314 wdata, 2, NULL, 0, 0);
318 * Externally callable EC access functions. For now, assume 1 EC only
320 int ec_burst_enable(void)
324 return acpi_ec_burst_enable(first_ec);
327 EXPORT_SYMBOL(ec_burst_enable);
329 int ec_burst_disable(void)
333 return acpi_ec_burst_disable(first_ec);
336 EXPORT_SYMBOL(ec_burst_disable);
338 int ec_read(u8 addr, u8 * val)
346 err = acpi_ec_read(first_ec, addr, &temp_data);
355 EXPORT_SYMBOL(ec_read);
357 int ec_write(u8 addr, u8 val)
364 err = acpi_ec_write(first_ec, addr, val);
369 EXPORT_SYMBOL(ec_write);
371 int ec_transaction(u8 command,
372 const u8 * wdata, unsigned wdata_len,
373 u8 * rdata, unsigned rdata_len,
379 return acpi_ec_transaction(first_ec, command, wdata,
380 wdata_len, rdata, rdata_len,
384 EXPORT_SYMBOL(ec_transaction);
386 static int acpi_ec_query(struct acpi_ec *ec, u8 * data)
395 * Query the EC to find out which _Qxx method we need to evaluate.
396 * Note that successful completion of the query causes the ACPI_EC_SCI
397 * bit to be cleared (and thus clearing the interrupt source).
400 result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1, 0);
411 /* --------------------------------------------------------------------------
413 -------------------------------------------------------------------------- */
414 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
415 acpi_handle handle, acpi_ec_query_func func,
418 struct acpi_ec_query_handler *handler =
419 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
423 handler->query_bit = query_bit;
424 handler->handle = handle;
425 handler->func = func;
426 handler->data = data;
427 mutex_lock(&ec->lock);
428 list_add(&handler->node, &ec->list);
429 mutex_unlock(&ec->lock);
433 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
435 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
437 struct acpi_ec_query_handler *handler;
438 mutex_lock(&ec->lock);
439 list_for_each_entry(handler, &ec->list, node) {
440 if (query_bit == handler->query_bit) {
441 list_del(&handler->node);
445 mutex_unlock(&ec->lock);
448 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
450 static void acpi_ec_gpe_query(void *ec_cxt)
452 struct acpi_ec *ec = ec_cxt;
454 struct acpi_ec_query_handler *handler, copy;
456 if (!ec || acpi_ec_query(ec, &value))
458 mutex_lock(&ec->lock);
459 list_for_each_entry(handler, &ec->list, node) {
460 if (value == handler->query_bit) {
461 /* have custom handler for this bit */
462 memcpy(©, handler, sizeof(copy));
463 mutex_unlock(&ec->lock);
465 copy.func(copy.data);
466 } else if (copy.handle) {
467 acpi_evaluate_object(copy.handle, NULL, NULL, NULL);
472 mutex_unlock(&ec->lock);
475 static u32 acpi_ec_gpe_handler(void *data)
477 acpi_status status = AE_OK;
479 struct acpi_ec *ec = data;
481 atomic_inc(&ec->event_count);
483 if (acpi_ec_mode == EC_INTR) {
487 value = acpi_ec_read_status(ec);
488 if ((value & ACPI_EC_FLAG_SCI) && !atomic_read(&ec->query_pending)) {
489 atomic_set(&ec->query_pending, 1);
491 acpi_os_execute(OSL_EC_BURST_HANDLER, acpi_ec_gpe_query, ec);
494 return status == AE_OK ?
495 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
498 /* --------------------------------------------------------------------------
499 Address Space Management
500 -------------------------------------------------------------------------- */
503 acpi_ec_space_setup(acpi_handle region_handle,
504 u32 function, void *handler_context, void **return_context)
507 * The EC object is in the handler context and is needed
508 * when calling the acpi_ec_space_handler.
510 *return_context = (function != ACPI_REGION_DEACTIVATE) ?
511 handler_context : NULL;
517 acpi_ec_space_handler(u32 function, acpi_physical_address address,
518 u32 bits, acpi_integer *value,
519 void *handler_context, void *region_context)
521 struct acpi_ec *ec = handler_context;
522 int result = 0, i = 0;
525 if ((address > 0xFF) || !value || !handler_context)
526 return AE_BAD_PARAMETER;
528 if (function != ACPI_READ && function != ACPI_WRITE)
529 return AE_BAD_PARAMETER;
531 if (bits != 8 && acpi_strict)
532 return AE_BAD_PARAMETER;
534 while (bits - i > 0) {
535 if (function == ACPI_READ) {
536 result = acpi_ec_read(ec, address, &temp);
537 (*value) |= ((acpi_integer)temp) << i;
539 temp = 0xff & ((*value) >> i);
540 result = acpi_ec_write(ec, address, temp);
548 return AE_BAD_PARAMETER;
561 /* --------------------------------------------------------------------------
563 -------------------------------------------------------------------------- */
565 static struct proc_dir_entry *acpi_ec_dir;
567 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
569 struct acpi_ec *ec = seq->private;
574 seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
575 seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
576 (unsigned)ec->command_addr, (unsigned)ec->data_addr);
577 seq_printf(seq, "use global lock:\t%s\n",
578 ec->global_lock ? "yes" : "no");
583 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
585 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
588 static struct file_operations acpi_ec_info_ops = {
589 .open = acpi_ec_info_open_fs,
592 .release = single_release,
593 .owner = THIS_MODULE,
596 static int acpi_ec_add_fs(struct acpi_device *device)
598 struct proc_dir_entry *entry = NULL;
600 if (!acpi_device_dir(device)) {
601 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
603 if (!acpi_device_dir(device))
607 entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
608 acpi_device_dir(device));
612 entry->proc_fops = &acpi_ec_info_ops;
613 entry->data = acpi_driver_data(device);
614 entry->owner = THIS_MODULE;
620 static int acpi_ec_remove_fs(struct acpi_device *device)
623 if (acpi_device_dir(device)) {
624 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
625 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
626 acpi_device_dir(device) = NULL;
632 /* --------------------------------------------------------------------------
634 -------------------------------------------------------------------------- */
636 ec_parse_io_ports(struct acpi_resource *resource, void *context);
638 static struct acpi_ec *make_acpi_ec(void)
640 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
644 atomic_set(&ec->query_pending, 1);
645 atomic_set(&ec->event_count, 1);
646 mutex_init(&ec->lock);
647 init_waitqueue_head(&ec->wait);
648 INIT_LIST_HEAD(&ec->list);
654 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
655 void *context, void **return_value)
657 struct acpi_namespace_node *node = handle;
658 struct acpi_ec *ec = context;
660 if (sscanf(node->name.ascii, "_Q%x", &value) == 1) {
661 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
667 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
671 struct acpi_ec *ec = context;
672 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
673 ec_parse_io_ports, ec);
674 if (ACPI_FAILURE(status))
677 /* Get GPE bit assignment (EC events). */
678 /* TODO: Add support for _GPE returning a package */
679 status = acpi_evaluate_integer(handle, "_GPE", NULL, &ec->gpe);
680 if (ACPI_FAILURE(status))
683 /* Find and register all query methods */
684 acpi_walk_namespace(ACPI_TYPE_METHOD, handle, 1,
685 acpi_ec_register_query_methods, ec, NULL);
687 /* Use the global lock for all EC transactions? */
688 acpi_evaluate_integer(handle, "_GLK", NULL, &ec->global_lock);
692 printk(KERN_INFO PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
693 ec->gpe, ec->command_addr, ec->data_addr);
695 return AE_CTRL_TERMINATE;
698 static int acpi_ec_add(struct acpi_device *device)
700 struct acpi_ec *ec = NULL;
705 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
706 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
712 if (ec_parse_device(device->handle, 0, ec, NULL) !=
718 /* Check if we found the boot EC */
720 if (boot_ec->gpe == ec->gpe) {
721 /* We might have incorrect info for GL at boot time */
722 mutex_lock(&boot_ec->lock);
723 boot_ec->global_lock = ec->global_lock;
724 /* Copy handlers from new ec into boot ec */
725 list_splice(&ec->list, &boot_ec->list);
726 mutex_unlock(&boot_ec->lock);
732 ec->handle = device->handle;
733 acpi_driver_data(device) = ec;
735 acpi_ec_add_fs(device);
739 static int acpi_ec_remove(struct acpi_device *device, int type)
742 struct acpi_ec_query_handler *handler, *tmp;
747 ec = acpi_driver_data(device);
748 mutex_lock(&ec->lock);
749 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
750 list_del(&handler->node);
753 mutex_unlock(&ec->lock);
754 acpi_ec_remove_fs(device);
755 acpi_driver_data(device) = NULL;
759 /* Don't touch boot EC */
766 ec_parse_io_ports(struct acpi_resource *resource, void *context)
768 struct acpi_ec *ec = context;
770 if (resource->type != ACPI_RESOURCE_TYPE_IO)
774 * The first address region returned is the data port, and
775 * the second address region returned is the status/command
778 if (ec->data_addr == 0)
779 ec->data_addr = resource->data.io.minimum;
780 else if (ec->command_addr == 0)
781 ec->command_addr = resource->data.io.minimum;
783 return AE_CTRL_TERMINATE;
788 static int ec_install_handlers(struct acpi_ec *ec)
791 status = acpi_install_gpe_handler(NULL, ec->gpe,
792 ACPI_GPE_EDGE_TRIGGERED,
793 &acpi_ec_gpe_handler, ec);
794 if (ACPI_FAILURE(status))
797 acpi_set_gpe_type(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
798 acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
800 status = acpi_install_address_space_handler(ec->handle,
802 &acpi_ec_space_handler,
803 &acpi_ec_space_setup, ec);
804 if (ACPI_FAILURE(status)) {
805 acpi_remove_gpe_handler(NULL, ec->gpe, &acpi_ec_gpe_handler);
812 static int acpi_ec_start(struct acpi_device *device)
820 ec = acpi_driver_data(device);
825 /* Boot EC is already working */
827 ret = ec_install_handlers(ec);
829 /* EC is fully operational, allow queries */
830 atomic_set(&ec->query_pending, 0);
835 static int acpi_ec_stop(struct acpi_device *device, int type)
843 ec = acpi_driver_data(device);
847 /* Don't touch boot EC */
851 status = acpi_remove_address_space_handler(ec->handle,
853 &acpi_ec_space_handler);
854 if (ACPI_FAILURE(status))
857 status = acpi_remove_gpe_handler(NULL, ec->gpe, &acpi_ec_gpe_handler);
858 if (ACPI_FAILURE(status))
864 int __init acpi_ec_ecdt_probe(void)
868 struct acpi_table_ecdt *ecdt_ptr;
870 boot_ec = make_acpi_ec();
874 * Generate a boot ec context
876 status = acpi_get_table(ACPI_SIG_ECDT, 1,
877 (struct acpi_table_header **)&ecdt_ptr);
878 if (ACPI_SUCCESS(status)) {
879 printk(KERN_INFO PREFIX "EC description table is found, configuring boot EC\n\n");
880 boot_ec->command_addr = ecdt_ptr->control.address;
881 boot_ec->data_addr = ecdt_ptr->data.address;
882 boot_ec->gpe = ecdt_ptr->gpe;
883 boot_ec->handle = ACPI_ROOT_OBJECT;
885 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
886 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
888 /* Check that acpi_get_devices actually find something */
889 if (ACPI_FAILURE(status) || !boot_ec->handle)
893 ret = ec_install_handlers(boot_ec);
905 static int __init acpi_ec_init(void)
912 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
916 /* Now register the driver for the EC */
917 result = acpi_bus_register_driver(&acpi_ec_driver);
919 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
926 subsys_initcall(acpi_ec_init);
928 /* EC driver currently not unloadable */
930 static void __exit acpi_ec_exit(void)
933 acpi_bus_unregister_driver(&acpi_ec_driver);
935 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
941 static int __init acpi_ec_set_intr_mode(char *str)
945 if (!get_option(&str, &intr))
948 acpi_ec_mode = (intr) ? EC_INTR : EC_POLL;
950 printk(KERN_NOTICE PREFIX "%s mode.\n", intr ? "interrupt" : "polling");
955 __setup("ec_intr=", acpi_ec_set_intr_mode);