2 * acpi_ec.c - ACPI Embedded Controller Driver ($Revision: 38 $)
4 * Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or (at
13 * your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
24 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/types.h>
31 #include <linux/delay.h>
32 #include <linux/proc_fs.h>
33 #include <linux/seq_file.h>
34 #include <linux/interrupt.h>
36 #include <acpi/acpi_bus.h>
37 #include <acpi/acpi_drivers.h>
38 #include <acpi/actypes.h>
40 #define _COMPONENT ACPI_EC_COMPONENT
41 ACPI_MODULE_NAME("acpi_ec")
42 #define ACPI_EC_COMPONENT 0x00100000
43 #define ACPI_EC_CLASS "embedded_controller"
44 #define ACPI_EC_HID "PNP0C09"
45 #define ACPI_EC_DRIVER_NAME "ACPI Embedded Controller Driver"
46 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
47 #define ACPI_EC_FILE_INFO "info"
48 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
49 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
50 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
51 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
52 #define ACPI_EC_EVENT_OBF 0x01 /* Output buffer full */
53 #define ACPI_EC_EVENT_IBE 0x02 /* Input buffer empty */
54 #define ACPI_EC_DELAY 50 /* Wait 50ms max. during EC ops */
55 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
56 #define ACPI_EC_UDELAY 100 /* Poll @ 100us increments */
57 #define ACPI_EC_UDELAY_COUNT 1000 /* Wait 10ms max. during EC ops */
58 #define ACPI_EC_COMMAND_READ 0x80
59 #define ACPI_EC_COMMAND_WRITE 0x81
60 #define ACPI_EC_BURST_ENABLE 0x82
61 #define ACPI_EC_BURST_DISABLE 0x83
62 #define ACPI_EC_COMMAND_QUERY 0x84
65 static int acpi_ec_remove(struct acpi_device *device, int type);
66 static int acpi_ec_start(struct acpi_device *device);
67 static int acpi_ec_stop(struct acpi_device *device, int type);
68 static int acpi_ec_intr_add(struct acpi_device *device);
69 static int acpi_ec_poll_add(struct acpi_device *device);
71 static struct acpi_driver acpi_ec_driver = {
72 .name = ACPI_EC_DRIVER_NAME,
73 .class = ACPI_EC_CLASS,
76 .add = acpi_ec_intr_add,
77 .remove = acpi_ec_remove,
78 .start = acpi_ec_start,
87 unsigned long gpe_bit;
88 struct acpi_generic_address status_addr;
89 struct acpi_generic_address command_addr;
90 struct acpi_generic_address data_addr;
91 unsigned long global_lock;
98 unsigned long gpe_bit;
99 struct acpi_generic_address status_addr;
100 struct acpi_generic_address command_addr;
101 struct acpi_generic_address data_addr;
102 unsigned long global_lock;
103 unsigned int expect_event;
104 atomic_t leaving_burst; /* 0 : No, 1 : Yes, 2: abort */
105 atomic_t pending_gpe;
106 struct semaphore sem;
107 wait_queue_head_t wait;
114 unsigned long gpe_bit;
115 struct acpi_generic_address status_addr;
116 struct acpi_generic_address command_addr;
117 struct acpi_generic_address data_addr;
118 unsigned long global_lock;
119 struct semaphore sem;
123 static int acpi_ec_poll_wait(union acpi_ec *ec, u8 event);
124 static int acpi_ec_intr_wait(union acpi_ec *ec, unsigned int event);
125 static int acpi_ec_poll_read(union acpi_ec *ec, u8 address, u32 * data);
126 static int acpi_ec_intr_read(union acpi_ec *ec, u8 address, u32 * data);
127 static int acpi_ec_poll_write(union acpi_ec *ec, u8 address, u8 data);
128 static int acpi_ec_intr_write(union acpi_ec *ec, u8 address, u8 data);
129 static int acpi_ec_poll_query(union acpi_ec *ec, u32 * data);
130 static int acpi_ec_intr_query(union acpi_ec *ec, u32 * data);
131 static void acpi_ec_gpe_poll_query(void *ec_cxt);
132 static void acpi_ec_gpe_intr_query(void *ec_cxt);
133 static u32 acpi_ec_gpe_poll_handler(void *data);
134 static u32 acpi_ec_gpe_intr_handler(void *data);
135 static acpi_status __init
136 acpi_fake_ecdt_poll_callback(acpi_handle handle,
137 u32 Level, void *context, void **retval);
139 static acpi_status __init
140 acpi_fake_ecdt_intr_callback(acpi_handle handle,
141 u32 Level, void *context, void **retval);
143 static int __init acpi_ec_poll_get_real_ecdt(void);
144 static int __init acpi_ec_intr_get_real_ecdt(void);
145 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
146 static union acpi_ec *ec_ecdt;
148 /* External interfaces use first EC only, so remember */
149 static struct acpi_device *first_ec;
150 static int acpi_ec_poll_mode = EC_INTR;
152 /* --------------------------------------------------------------------------
153 Transaction Management
154 -------------------------------------------------------------------------- */
156 static u32 acpi_ec_read_status(union acpi_ec *ec)
160 acpi_hw_low_level_read(8, &status, &ec->common.status_addr);
164 static int acpi_ec_wait(union acpi_ec *ec, u8 event)
166 if (acpi_ec_poll_mode)
167 return acpi_ec_poll_wait(ec, event);
169 return acpi_ec_intr_wait(ec, event);
172 static int acpi_ec_poll_wait(union acpi_ec *ec, u8 event)
174 u32 acpi_ec_status = 0;
175 u32 i = ACPI_EC_UDELAY_COUNT;
180 /* Poll the EC status register waiting for the event to occur. */
182 case ACPI_EC_EVENT_OBF:
184 acpi_hw_low_level_read(8, &acpi_ec_status,
185 &ec->common.status_addr);
186 if (acpi_ec_status & ACPI_EC_FLAG_OBF)
188 udelay(ACPI_EC_UDELAY);
191 case ACPI_EC_EVENT_IBE:
193 acpi_hw_low_level_read(8, &acpi_ec_status,
194 &ec->common.status_addr);
195 if (!(acpi_ec_status & ACPI_EC_FLAG_IBF))
197 udelay(ACPI_EC_UDELAY);
206 static int acpi_ec_intr_wait(union acpi_ec *ec, unsigned int event)
211 ec->intr.expect_event = event;
215 case ACPI_EC_EVENT_IBE:
216 if (~acpi_ec_read_status(ec) & event) {
217 ec->intr.expect_event = 0;
225 result = wait_event_timeout(ec->intr.wait,
226 !ec->intr.expect_event,
227 msecs_to_jiffies(ACPI_EC_DELAY));
229 ec->intr.expect_event = 0;
233 * Verify that the event in question has actually happened by
234 * querying EC status. Do the check even if operation timed-out
235 * to make sure that we did not miss interrupt.
238 case ACPI_EC_EVENT_OBF:
239 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
243 case ACPI_EC_EVENT_IBE:
244 if (~acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
252 #ifdef ACPI_FUTURE_USAGE
254 * Note: samsung nv5000 doesn't work with ec burst mode.
255 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
257 int acpi_ec_enter_burst_mode(union acpi_ec *ec)
263 status = acpi_ec_read_status(ec);
264 if (status != -EINVAL && !(status & ACPI_EC_FLAG_BURST)) {
265 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
268 acpi_hw_low_level_write(8, ACPI_EC_BURST_ENABLE,
269 &ec->common.command_addr);
270 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
271 acpi_hw_low_level_read(8, &tmp, &ec->common.data_addr);
272 if (tmp != 0x90) { /* Burst ACK byte */
277 atomic_set(&ec->intr.leaving_burst, 0);
280 ACPI_EXCEPTION ((AE_INFO, status, "EC wait, burst mode");
284 int acpi_ec_leave_burst_mode(union acpi_ec *ec)
289 status = acpi_ec_read_status(ec);
290 if (status != -EINVAL && (status & ACPI_EC_FLAG_BURST)){
291 status = acpi_ec_wait(ec, ACPI_EC_FLAG_IBF);
294 acpi_hw_low_level_write(8, ACPI_EC_BURST_DISABLE, &ec->common.command_addr);
295 acpi_ec_wait(ec, ACPI_EC_FLAG_IBF);
297 atomic_set(&ec->intr.leaving_burst, 1);
300 ACPI_EXCEPTION((AE_INFO, status, "EC leave burst mode");
303 #endif /* ACPI_FUTURE_USAGE */
305 static int acpi_ec_read(union acpi_ec *ec, u8 address, u32 * data)
307 if (acpi_ec_poll_mode)
308 return acpi_ec_poll_read(ec, address, data);
310 return acpi_ec_intr_read(ec, address, data);
312 static int acpi_ec_write(union acpi_ec *ec, u8 address, u8 data)
314 if (acpi_ec_poll_mode)
315 return acpi_ec_poll_write(ec, address, data);
317 return acpi_ec_intr_write(ec, address, data);
319 static int acpi_ec_poll_read(union acpi_ec *ec, u8 address, u32 * data)
321 acpi_status status = AE_OK;
331 if (ec->common.global_lock) {
332 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
333 if (ACPI_FAILURE(status))
337 if (down_interruptible(&ec->poll.sem)) {
338 result = -ERESTARTSYS;
342 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_READ,
343 &ec->common.command_addr);
344 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
348 acpi_hw_low_level_write(8, address, &ec->common.data_addr);
349 result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
353 acpi_hw_low_level_read(8, data, &ec->common.data_addr);
355 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Read [%02x] from address [%02x]\n",
361 if (ec->common.global_lock)
362 acpi_release_global_lock(glk);
367 static int acpi_ec_poll_write(union acpi_ec *ec, u8 address, u8 data)
370 acpi_status status = AE_OK;
377 if (ec->common.global_lock) {
378 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
379 if (ACPI_FAILURE(status))
383 if (down_interruptible(&ec->poll.sem)) {
384 result = -ERESTARTSYS;
388 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_WRITE,
389 &ec->common.command_addr);
390 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
394 acpi_hw_low_level_write(8, address, &ec->common.data_addr);
395 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
399 acpi_hw_low_level_write(8, data, &ec->common.data_addr);
400 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
404 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Wrote [%02x] to address [%02x]\n",
410 if (ec->common.global_lock)
411 acpi_release_global_lock(glk);
416 static int acpi_ec_intr_read(union acpi_ec *ec, u8 address, u32 * data)
427 if (ec->common.global_lock) {
428 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
429 if (ACPI_FAILURE(status))
433 WARN_ON(in_interrupt());
436 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
438 printk(KERN_DEBUG PREFIX "read EC, IB not empty\n");
441 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_READ,
442 &ec->common.command_addr);
443 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
445 printk(KERN_DEBUG PREFIX "read EC, IB not empty\n");
448 acpi_hw_low_level_write(8, address, &ec->common.data_addr);
449 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
451 printk(KERN_DEBUG PREFIX "read EC, OB not full\n");
454 acpi_hw_low_level_read(8, data, &ec->common.data_addr);
455 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Read [%02x] from address [%02x]\n",
461 if (ec->common.global_lock)
462 acpi_release_global_lock(glk);
467 static int acpi_ec_intr_write(union acpi_ec *ec, u8 address, u8 data)
476 if (ec->common.global_lock) {
477 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
478 if (ACPI_FAILURE(status))
482 WARN_ON(in_interrupt());
485 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
487 printk(KERN_DEBUG PREFIX "write EC, IB not empty\n");
489 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_WRITE,
490 &ec->common.command_addr);
491 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
493 printk(KERN_DEBUG PREFIX "write EC, IB not empty\n");
496 acpi_hw_low_level_write(8, address, &ec->common.data_addr);
497 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
499 printk(KERN_DEBUG PREFIX "write EC, IB not empty\n");
502 acpi_hw_low_level_write(8, data, &ec->common.data_addr);
504 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Wrote [%02x] to address [%02x]\n",
509 if (ec->common.global_lock)
510 acpi_release_global_lock(glk);
516 * Externally callable EC access functions. For now, assume 1 EC only
518 int ec_read(u8 addr, u8 * val)
527 ec = acpi_driver_data(first_ec);
529 err = acpi_ec_read(ec, addr, &temp_data);
538 EXPORT_SYMBOL(ec_read);
540 int ec_write(u8 addr, u8 val)
548 ec = acpi_driver_data(first_ec);
550 err = acpi_ec_write(ec, addr, val);
555 EXPORT_SYMBOL(ec_write);
557 static int acpi_ec_query(union acpi_ec *ec, u32 * data)
559 if (acpi_ec_poll_mode)
560 return acpi_ec_poll_query(ec, data);
562 return acpi_ec_intr_query(ec, data);
564 static int acpi_ec_poll_query(union acpi_ec *ec, u32 * data)
567 acpi_status status = AE_OK;
576 if (ec->common.global_lock) {
577 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
578 if (ACPI_FAILURE(status))
583 * Query the EC to find out which _Qxx method we need to evaluate.
584 * Note that successful completion of the query causes the ACPI_EC_SCI
585 * bit to be cleared (and thus clearing the interrupt source).
587 if (down_interruptible(&ec->poll.sem)) {
588 result = -ERESTARTSYS;
592 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_QUERY,
593 &ec->common.command_addr);
594 result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
598 acpi_hw_low_level_read(8, data, &ec->common.data_addr);
605 if (ec->common.global_lock)
606 acpi_release_global_lock(glk);
610 static int acpi_ec_intr_query(union acpi_ec *ec, u32 * data)
620 if (ec->common.global_lock) {
621 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
622 if (ACPI_FAILURE(status))
628 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
630 printk(KERN_DEBUG PREFIX "query EC, IB not empty\n");
634 * Query the EC to find out which _Qxx method we need to evaluate.
635 * Note that successful completion of the query causes the ACPI_EC_SCI
636 * bit to be cleared (and thus clearing the interrupt source).
638 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_QUERY,
639 &ec->common.command_addr);
640 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
642 printk(KERN_DEBUG PREFIX "query EC, OB not full\n");
646 acpi_hw_low_level_read(8, data, &ec->common.data_addr);
653 if (ec->common.global_lock)
654 acpi_release_global_lock(glk);
659 /* --------------------------------------------------------------------------
661 -------------------------------------------------------------------------- */
663 union acpi_ec_query_data {
668 static void acpi_ec_gpe_query(void *ec_cxt)
670 if (acpi_ec_poll_mode)
671 acpi_ec_gpe_poll_query(ec_cxt);
673 acpi_ec_gpe_intr_query(ec_cxt);
676 static void acpi_ec_gpe_poll_query(void *ec_cxt)
678 union acpi_ec *ec = (union acpi_ec *)ec_cxt;
680 static char object_name[5] = { '_', 'Q', '0', '0', '\0' };
681 const char hex[] = { '0', '1', '2', '3', '4', '5', '6', '7',
682 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
689 if (down_interruptible (&ec->poll.sem)) {
692 acpi_hw_low_level_read(8, &value, &ec->common.command_addr);
695 /* TBD: Implement asynch events!
696 * NOTE: All we care about are EC-SCI's. Other EC events are
697 * handled via polling (yuck!). This is because some systems
698 * treat EC-SCIs as level (versus EDGE!) triggered, preventing
699 * a purely interrupt-driven approach (grumble, grumble).
701 if (!(value & ACPI_EC_FLAG_SCI))
704 if (acpi_ec_query(ec, &value))
707 object_name[2] = hex[((value >> 4) & 0x0F)];
708 object_name[3] = hex[(value & 0x0F)];
710 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s\n", object_name));
712 acpi_evaluate_object(ec->common.handle, object_name, NULL, NULL);
715 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
717 static void acpi_ec_gpe_intr_query(void *ec_cxt)
719 union acpi_ec *ec = (union acpi_ec *)ec_cxt;
721 int result = -ENODATA;
722 static char object_name[5] = { '_', 'Q', '0', '0', '\0' };
723 const char hex[] = { '0', '1', '2', '3', '4', '5', '6', '7',
724 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
728 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_SCI)
729 result = acpi_ec_query(ec, &value);
734 object_name[2] = hex[((value >> 4) & 0x0F)];
735 object_name[3] = hex[(value & 0x0F)];
737 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s\n", object_name));
739 acpi_evaluate_object(ec->common.handle, object_name, NULL, NULL);
741 atomic_dec(&ec->intr.pending_gpe);
745 static u32 acpi_ec_gpe_handler(void *data)
747 if (acpi_ec_poll_mode)
748 return acpi_ec_gpe_poll_handler(data);
750 return acpi_ec_gpe_intr_handler(data);
752 static u32 acpi_ec_gpe_poll_handler(void *data)
754 acpi_status status = AE_OK;
755 union acpi_ec *ec = (union acpi_ec *)data;
758 return ACPI_INTERRUPT_NOT_HANDLED;
760 acpi_disable_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
762 status = acpi_os_execute(OSL_EC_POLL_HANDLER, acpi_ec_gpe_query, ec);
765 return ACPI_INTERRUPT_HANDLED;
767 return ACPI_INTERRUPT_NOT_HANDLED;
769 static u32 acpi_ec_gpe_intr_handler(void *data)
771 acpi_status status = AE_OK;
773 union acpi_ec *ec = (union acpi_ec *)data;
776 return ACPI_INTERRUPT_NOT_HANDLED;
778 acpi_clear_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
779 value = acpi_ec_read_status(ec);
781 switch (ec->intr.expect_event) {
782 case ACPI_EC_EVENT_OBF:
783 if (!(value & ACPI_EC_FLAG_OBF))
785 case ACPI_EC_EVENT_IBE:
786 if ((value & ACPI_EC_FLAG_IBF))
788 ec->intr.expect_event = 0;
789 wake_up(&ec->intr.wait);
790 return ACPI_INTERRUPT_HANDLED;
795 if (value & ACPI_EC_FLAG_SCI) {
796 atomic_add(1, &ec->intr.pending_gpe);
797 status = acpi_os_execute(OSL_EC_BURST_HANDLER,
798 acpi_ec_gpe_query, ec);
799 return status == AE_OK ?
800 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
802 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
803 return status == AE_OK ?
804 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
807 /* --------------------------------------------------------------------------
808 Address Space Management
809 -------------------------------------------------------------------------- */
812 acpi_ec_space_setup(acpi_handle region_handle,
813 u32 function, void *handler_context, void **return_context)
816 * The EC object is in the handler context and is needed
817 * when calling the acpi_ec_space_handler.
819 *return_context = (function != ACPI_REGION_DEACTIVATE) ?
820 handler_context : NULL;
826 acpi_ec_space_handler(u32 function,
827 acpi_physical_address address,
829 acpi_integer * value,
830 void *handler_context, void *region_context)
833 union acpi_ec *ec = NULL;
835 acpi_integer f_v = 0;
839 if ((address > 0xFF) || !value || !handler_context)
840 return AE_BAD_PARAMETER;
842 if (bit_width != 8 && acpi_strict) {
843 printk(KERN_WARNING PREFIX
844 "acpi_ec_space_handler: bit_width should be 8\n");
845 return AE_BAD_PARAMETER;
848 ec = (union acpi_ec *)handler_context;
854 result = acpi_ec_read(ec, (u8) address, (u32 *) & temp);
857 result = acpi_ec_write(ec, (u8) address, (u8) temp);
867 if (function == ACPI_READ)
868 f_v |= temp << 8 * i;
869 if (function == ACPI_WRITE)
876 if (function == ACPI_READ) {
877 f_v |= temp << 8 * i;
884 return AE_BAD_PARAMETER;
897 /* --------------------------------------------------------------------------
899 -------------------------------------------------------------------------- */
901 static struct proc_dir_entry *acpi_ec_dir;
903 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
905 union acpi_ec *ec = (union acpi_ec *)seq->private;
911 seq_printf(seq, "gpe bit: 0x%02x\n",
912 (u32) ec->common.gpe_bit);
913 seq_printf(seq, "ports: 0x%02x, 0x%02x\n",
914 (u32) ec->common.status_addr.address,
915 (u32) ec->common.data_addr.address);
916 seq_printf(seq, "use global lock: %s\n",
917 ec->common.global_lock ? "yes" : "no");
918 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
924 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
926 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
929 static struct file_operations acpi_ec_info_ops = {
930 .open = acpi_ec_info_open_fs,
933 .release = single_release,
934 .owner = THIS_MODULE,
937 static int acpi_ec_add_fs(struct acpi_device *device)
939 struct proc_dir_entry *entry = NULL;
942 if (!acpi_device_dir(device)) {
943 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
945 if (!acpi_device_dir(device))
949 entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
950 acpi_device_dir(device));
954 entry->proc_fops = &acpi_ec_info_ops;
955 entry->data = acpi_driver_data(device);
956 entry->owner = THIS_MODULE;
962 static int acpi_ec_remove_fs(struct acpi_device *device)
965 if (acpi_device_dir(device)) {
966 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
967 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
968 acpi_device_dir(device) = NULL;
974 /* --------------------------------------------------------------------------
976 -------------------------------------------------------------------------- */
978 static int acpi_ec_poll_add(struct acpi_device *device)
981 acpi_status status = AE_OK;
982 union acpi_ec *ec = NULL;
988 ec = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
991 memset(ec, 0, sizeof(union acpi_ec));
993 ec->common.handle = device->handle;
995 init_MUTEX(&ec->poll.sem);
996 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
997 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
998 acpi_driver_data(device) = ec;
1000 /* Use the global lock for all EC transactions? */
1001 acpi_evaluate_integer(ec->common.handle, "_GLK", NULL,
1002 &ec->common.global_lock);
1004 /* XXX we don't test uids, because on some boxes ecdt uid = 0, see:
1005 http://bugzilla.kernel.org/show_bug.cgi?id=6111 */
1007 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
1009 &acpi_ec_space_handler);
1011 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1012 &acpi_ec_gpe_handler);
1017 /* Get GPE bit assignment (EC events). */
1018 /* TODO: Add support for _GPE returning a package */
1020 acpi_evaluate_integer(ec->common.handle, "_GPE", NULL,
1021 &ec->common.gpe_bit);
1022 if (ACPI_FAILURE(status)) {
1023 ACPI_EXCEPTION((AE_INFO, status, "Obtaining GPE bit"));
1028 result = acpi_ec_add_fs(device);
1032 printk(KERN_INFO PREFIX "%s [%s] (gpe %d) polling mode.\n",
1033 acpi_device_name(device), acpi_device_bid(device),
1034 (u32) ec->common.gpe_bit);
1045 static int acpi_ec_intr_add(struct acpi_device *device)
1048 acpi_status status = AE_OK;
1049 union acpi_ec *ec = NULL;
1055 ec = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1058 memset(ec, 0, sizeof(union acpi_ec));
1060 ec->common.handle = device->handle;
1061 ec->common.uid = -1;
1062 atomic_set(&ec->intr.pending_gpe, 0);
1063 atomic_set(&ec->intr.leaving_burst, 1);
1064 init_MUTEX(&ec->intr.sem);
1065 init_waitqueue_head(&ec->intr.wait);
1066 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1067 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1068 acpi_driver_data(device) = ec;
1070 /* Use the global lock for all EC transactions? */
1071 acpi_evaluate_integer(ec->common.handle, "_GLK", NULL,
1072 &ec->common.global_lock);
1074 /* XXX we don't test uids, because on some boxes ecdt uid = 0, see:
1075 http://bugzilla.kernel.org/show_bug.cgi?id=6111 */
1077 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
1079 &acpi_ec_space_handler);
1081 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1082 &acpi_ec_gpe_handler);
1087 /* Get GPE bit assignment (EC events). */
1088 /* TODO: Add support for _GPE returning a package */
1090 acpi_evaluate_integer(ec->common.handle, "_GPE", NULL,
1091 &ec->common.gpe_bit);
1092 if (ACPI_FAILURE(status)) {
1093 printk(KERN_ERR PREFIX "Obtaining GPE bit assignment\n");
1098 result = acpi_ec_add_fs(device);
1102 printk(KERN_INFO PREFIX "%s [%s] (gpe %d) interrupt mode.\n",
1103 acpi_device_name(device), acpi_device_bid(device),
1104 (u32) ec->common.gpe_bit);
1116 static int acpi_ec_remove(struct acpi_device *device, int type)
1118 union acpi_ec *ec = NULL;
1124 ec = acpi_driver_data(device);
1126 acpi_ec_remove_fs(device);
1134 acpi_ec_io_ports(struct acpi_resource *resource, void *context)
1136 union acpi_ec *ec = (union acpi_ec *)context;
1137 struct acpi_generic_address *addr;
1139 if (resource->type != ACPI_RESOURCE_TYPE_IO) {
1144 * The first address region returned is the data port, and
1145 * the second address region returned is the status/command
1148 if (ec->common.data_addr.register_bit_width == 0) {
1149 addr = &ec->common.data_addr;
1150 } else if (ec->common.command_addr.register_bit_width == 0) {
1151 addr = &ec->common.command_addr;
1153 return AE_CTRL_TERMINATE;
1156 addr->address_space_id = ACPI_ADR_SPACE_SYSTEM_IO;
1157 addr->register_bit_width = 8;
1158 addr->register_bit_offset = 0;
1159 addr->address = resource->data.io.minimum;
1164 static int acpi_ec_start(struct acpi_device *device)
1166 acpi_status status = AE_OK;
1167 union acpi_ec *ec = NULL;
1173 ec = acpi_driver_data(device);
1179 * Get I/O port addresses. Convert to GAS format.
1181 status = acpi_walk_resources(ec->common.handle, METHOD_NAME__CRS,
1182 acpi_ec_io_ports, ec);
1183 if (ACPI_FAILURE(status)
1184 || ec->common.command_addr.register_bit_width == 0) {
1185 printk(KERN_ERR PREFIX "Error getting I/O port addresses\n");
1189 ec->common.status_addr = ec->common.command_addr;
1191 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "gpe=0x%02x, ports=0x%2x,0x%2x\n",
1192 (u32) ec->common.gpe_bit,
1193 (u32) ec->common.command_addr.address,
1194 (u32) ec->common.data_addr.address));
1197 * Install GPE handler
1199 status = acpi_install_gpe_handler(NULL, ec->common.gpe_bit,
1200 ACPI_GPE_EDGE_TRIGGERED,
1201 &acpi_ec_gpe_handler, ec);
1202 if (ACPI_FAILURE(status)) {
1205 acpi_set_gpe_type(NULL, ec->common.gpe_bit, ACPI_GPE_TYPE_RUNTIME);
1206 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
1208 status = acpi_install_address_space_handler(ec->common.handle,
1210 &acpi_ec_space_handler,
1211 &acpi_ec_space_setup, ec);
1212 if (ACPI_FAILURE(status)) {
1213 acpi_remove_gpe_handler(NULL, ec->common.gpe_bit,
1214 &acpi_ec_gpe_handler);
1221 static int acpi_ec_stop(struct acpi_device *device, int type)
1223 acpi_status status = AE_OK;
1224 union acpi_ec *ec = NULL;
1230 ec = acpi_driver_data(device);
1232 status = acpi_remove_address_space_handler(ec->common.handle,
1234 &acpi_ec_space_handler);
1235 if (ACPI_FAILURE(status))
1239 acpi_remove_gpe_handler(NULL, ec->common.gpe_bit,
1240 &acpi_ec_gpe_handler);
1241 if (ACPI_FAILURE(status))
1247 static acpi_status __init
1248 acpi_fake_ecdt_callback(acpi_handle handle,
1249 u32 Level, void *context, void **retval)
1252 if (acpi_ec_poll_mode)
1253 return acpi_fake_ecdt_poll_callback(handle,
1254 Level, context, retval);
1256 return acpi_fake_ecdt_intr_callback(handle,
1257 Level, context, retval);
1260 static acpi_status __init
1261 acpi_fake_ecdt_poll_callback(acpi_handle handle,
1262 u32 Level, void *context, void **retval)
1266 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1267 acpi_ec_io_ports, ec_ecdt);
1268 if (ACPI_FAILURE(status))
1270 ec_ecdt->common.status_addr = ec_ecdt->common.command_addr;
1272 ec_ecdt->common.uid = -1;
1273 acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->common.uid);
1276 acpi_evaluate_integer(handle, "_GPE", NULL,
1277 &ec_ecdt->common.gpe_bit);
1278 if (ACPI_FAILURE(status))
1280 init_MUTEX(&ec_ecdt->poll.sem);
1281 ec_ecdt->common.global_lock = TRUE;
1282 ec_ecdt->common.handle = handle;
1284 printk(KERN_INFO PREFIX "GPE=0x%02x, ports=0x%2x, 0x%2x\n",
1285 (u32) ec_ecdt->common.gpe_bit,
1286 (u32) ec_ecdt->common.command_addr.address,
1287 (u32) ec_ecdt->common.data_addr.address);
1289 return AE_CTRL_TERMINATE;
1292 static acpi_status __init
1293 acpi_fake_ecdt_intr_callback(acpi_handle handle,
1294 u32 Level, void *context, void **retval)
1298 init_MUTEX(&ec_ecdt->intr.sem);
1299 init_waitqueue_head(&ec_ecdt->intr.wait);
1300 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1301 acpi_ec_io_ports, ec_ecdt);
1302 if (ACPI_FAILURE(status))
1304 ec_ecdt->common.status_addr = ec_ecdt->common.command_addr;
1306 ec_ecdt->common.uid = -1;
1307 acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->common.uid);
1310 acpi_evaluate_integer(handle, "_GPE", NULL,
1311 &ec_ecdt->common.gpe_bit);
1312 if (ACPI_FAILURE(status))
1314 ec_ecdt->common.global_lock = TRUE;
1315 ec_ecdt->common.handle = handle;
1317 printk(KERN_INFO PREFIX "GPE=0x%02x, ports=0x%2x, 0x%2x\n",
1318 (u32) ec_ecdt->common.gpe_bit,
1319 (u32) ec_ecdt->common.command_addr.address,
1320 (u32) ec_ecdt->common.data_addr.address);
1322 return AE_CTRL_TERMINATE;
1326 * Some BIOS (such as some from Gateway laptops) access EC region very early
1327 * such as in BAT0._INI or EC._INI before an EC device is found and
1328 * do not provide an ECDT. According to ACPI spec, ECDT isn't mandatorily
1329 * required, but if EC regison is accessed early, it is required.
1330 * The routine tries to workaround the BIOS bug by pre-scan EC device
1331 * It assumes that _CRS, _HID, _GPE, _UID methods of EC don't touch any
1332 * op region (since _REG isn't invoked yet). The assumption is true for
1333 * all systems found.
1335 static int __init acpi_ec_fake_ecdt(void)
1340 printk(KERN_INFO PREFIX "Try to make an fake ECDT\n");
1342 ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1347 memset(ec_ecdt, 0, sizeof(union acpi_ec));
1349 status = acpi_get_devices(ACPI_EC_HID,
1350 acpi_fake_ecdt_callback, NULL, NULL);
1351 if (ACPI_FAILURE(status)) {
1359 printk(KERN_ERR PREFIX "Can't make an fake ECDT\n");
1363 static int __init acpi_ec_get_real_ecdt(void)
1365 if (acpi_ec_poll_mode)
1366 return acpi_ec_poll_get_real_ecdt();
1368 return acpi_ec_intr_get_real_ecdt();
1371 static int __init acpi_ec_poll_get_real_ecdt(void)
1374 struct acpi_table_ecdt *ecdt_ptr;
1376 status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
1377 (struct acpi_table_header **)
1379 if (ACPI_FAILURE(status))
1382 printk(KERN_INFO PREFIX "Found ECDT\n");
1385 * Generate a temporary ec context to use until the namespace is scanned
1387 ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1390 memset(ec_ecdt, 0, sizeof(union acpi_ec));
1392 ec_ecdt->common.command_addr = ecdt_ptr->ec_control;
1393 ec_ecdt->common.status_addr = ecdt_ptr->ec_control;
1394 ec_ecdt->common.data_addr = ecdt_ptr->ec_data;
1395 ec_ecdt->common.gpe_bit = ecdt_ptr->gpe_bit;
1396 init_MUTEX(&ec_ecdt->poll.sem);
1397 /* use the GL just to be safe */
1398 ec_ecdt->common.global_lock = TRUE;
1399 ec_ecdt->common.uid = ecdt_ptr->uid;
1402 acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->common.handle);
1403 if (ACPI_FAILURE(status)) {
1409 printk(KERN_ERR PREFIX "Could not use ECDT\n");
1416 static int __init acpi_ec_intr_get_real_ecdt(void)
1419 struct acpi_table_ecdt *ecdt_ptr;
1421 status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
1422 (struct acpi_table_header **)
1424 if (ACPI_FAILURE(status))
1427 printk(KERN_INFO PREFIX "Found ECDT\n");
1430 * Generate a temporary ec context to use until the namespace is scanned
1432 ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1435 memset(ec_ecdt, 0, sizeof(union acpi_ec));
1437 init_MUTEX(&ec_ecdt->intr.sem);
1438 init_waitqueue_head(&ec_ecdt->intr.wait);
1439 ec_ecdt->common.command_addr = ecdt_ptr->ec_control;
1440 ec_ecdt->common.status_addr = ecdt_ptr->ec_control;
1441 ec_ecdt->common.data_addr = ecdt_ptr->ec_data;
1442 ec_ecdt->common.gpe_bit = ecdt_ptr->gpe_bit;
1443 /* use the GL just to be safe */
1444 ec_ecdt->common.global_lock = TRUE;
1445 ec_ecdt->common.uid = ecdt_ptr->uid;
1448 acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->common.handle);
1449 if (ACPI_FAILURE(status)) {
1455 printk(KERN_ERR PREFIX "Could not use ECDT\n");
1462 static int __initdata acpi_fake_ecdt_enabled;
1463 int __init acpi_ec_ecdt_probe(void)
1468 ret = acpi_ec_get_real_ecdt();
1469 /* Try to make a fake ECDT */
1470 if (ret && acpi_fake_ecdt_enabled) {
1471 ret = acpi_ec_fake_ecdt();
1478 * Install GPE handler
1480 status = acpi_install_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1481 ACPI_GPE_EDGE_TRIGGERED,
1482 &acpi_ec_gpe_handler, ec_ecdt);
1483 if (ACPI_FAILURE(status)) {
1486 acpi_set_gpe_type(NULL, ec_ecdt->common.gpe_bit, ACPI_GPE_TYPE_RUNTIME);
1487 acpi_enable_gpe(NULL, ec_ecdt->common.gpe_bit, ACPI_NOT_ISR);
1489 status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT,
1491 &acpi_ec_space_handler,
1492 &acpi_ec_space_setup,
1494 if (ACPI_FAILURE(status)) {
1495 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1496 &acpi_ec_gpe_handler);
1503 printk(KERN_ERR PREFIX "Could not use ECDT\n");
1510 static int __init acpi_ec_init(void)
1518 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1522 /* Now register the driver for the EC */
1523 result = acpi_bus_register_driver(&acpi_ec_driver);
1525 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1532 subsys_initcall(acpi_ec_init);
1534 /* EC driver currently not unloadable */
1536 static void __exit acpi_ec_exit(void)
1539 acpi_bus_unregister_driver(&acpi_ec_driver);
1541 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1547 static int __init acpi_fake_ecdt_setup(char *str)
1549 acpi_fake_ecdt_enabled = 1;
1553 __setup("acpi_fake_ecdt", acpi_fake_ecdt_setup);
1554 static int __init acpi_ec_set_intr_mode(char *str)
1558 if (!get_option(&str, &intr))
1562 acpi_ec_poll_mode = EC_INTR;
1563 acpi_ec_driver.ops.add = acpi_ec_intr_add;
1565 acpi_ec_poll_mode = EC_POLL;
1566 acpi_ec_driver.ops.add = acpi_ec_poll_add;
1568 printk(KERN_INFO PREFIX "EC %s mode.\n", intr ? "interrupt" : "polling");
1572 __setup("ec_intr=", acpi_ec_set_intr_mode);