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
63 #define EC_POLLING 0xFF
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_burst_add(struct acpi_device *device);
69 static int acpi_ec_polling_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_polling_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;
123 static int acpi_ec_polling_wait(union acpi_ec *ec, u8 event);
124 static int acpi_ec_burst_wait(union acpi_ec *ec, unsigned int event);
125 static int acpi_ec_polling_read(union acpi_ec *ec, u8 address, u32 * data);
126 static int acpi_ec_burst_read(union acpi_ec *ec, u8 address, u32 * data);
127 static int acpi_ec_polling_write(union acpi_ec *ec, u8 address, u8 data);
128 static int acpi_ec_burst_write(union acpi_ec *ec, u8 address, u8 data);
129 static int acpi_ec_polling_query(union acpi_ec *ec, u32 * data);
130 static int acpi_ec_burst_query(union acpi_ec *ec, u32 * data);
131 static void acpi_ec_gpe_polling_query(void *ec_cxt);
132 static void acpi_ec_gpe_burst_query(void *ec_cxt);
133 static u32 acpi_ec_gpe_polling_handler(void *data);
134 static u32 acpi_ec_gpe_burst_handler(void *data);
135 static acpi_status __init
136 acpi_fake_ecdt_polling_callback(acpi_handle handle,
137 u32 Level, void *context, void **retval);
139 static acpi_status __init
140 acpi_fake_ecdt_burst_callback(acpi_handle handle,
141 u32 Level, void *context, void **retval);
143 static int __init acpi_ec_polling_get_real_ecdt(void);
144 static int __init acpi_ec_burst_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_polling_mode = EC_POLLING;
152 /* --------------------------------------------------------------------------
153 Transaction Management
154 -------------------------------------------------------------------------- */
156 static inline 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_polling_mode)
167 return acpi_ec_polling_wait(ec, event);
169 return acpi_ec_burst_wait(ec, event);
172 static int acpi_ec_polling_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_burst_wait(union acpi_ec *ec, unsigned int event)
210 ACPI_FUNCTION_TRACE("acpi_ec_wait");
212 ec->burst.expect_event = event;
216 case ACPI_EC_EVENT_IBE:
217 if (~acpi_ec_read_status(ec) & event) {
218 ec->burst.expect_event = 0;
226 result = wait_event_timeout(ec->burst.wait,
227 !ec->burst.expect_event,
228 msecs_to_jiffies(ACPI_EC_DELAY));
230 ec->burst.expect_event = 0;
234 * Verify that the event in question has actually happened by
235 * querying EC status. Do the check even if operation timed-out
236 * to make sure that we did not miss interrupt.
239 case ACPI_EC_EVENT_OBF:
240 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
244 case ACPI_EC_EVENT_IBE:
245 if (~acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
250 return_VALUE(-ETIME);
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)
262 ACPI_FUNCTION_TRACE("acpi_ec_enter_burst_mode");
264 status = acpi_ec_read_status(ec);
265 if (status != -EINVAL && !(status & ACPI_EC_FLAG_BURST)) {
266 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
269 acpi_hw_low_level_write(8, ACPI_EC_BURST_ENABLE,
270 &ec->common.command_addr);
271 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
272 acpi_hw_low_level_read(8, &tmp, &ec->common.data_addr);
273 if (tmp != 0x90) { /* Burst ACK byte */
274 return_VALUE(-EINVAL);
278 atomic_set(&ec->burst.leaving_burst, 0);
281 printk("Error in acpi_ec_wait\n");
285 int acpi_ec_leave_burst_mode(union acpi_ec *ec)
289 ACPI_FUNCTION_TRACE("acpi_ec_leave_burst_mode");
291 status = acpi_ec_read_status(ec);
292 if (status != -EINVAL && (status & ACPI_EC_FLAG_BURST)){
293 status = acpi_ec_wait(ec, ACPI_EC_FLAG_IBF);
296 acpi_hw_low_level_write(8, ACPI_EC_BURST_DISABLE, &ec->common.command_addr);
297 acpi_ec_wait(ec, ACPI_EC_FLAG_IBF);
299 atomic_set(&ec->burst.leaving_burst, 1);
302 printk("leave burst_mode:error \n");
306 static int acpi_ec_read(union acpi_ec *ec, u8 address, u32 * data)
308 if (acpi_ec_polling_mode)
309 return acpi_ec_polling_read(ec, address, data);
311 return acpi_ec_burst_read(ec, address, data);
313 static int acpi_ec_write(union acpi_ec *ec, u8 address, u8 data)
315 if (acpi_ec_polling_mode)
316 return acpi_ec_polling_write(ec, address, data);
318 return acpi_ec_burst_write(ec, address, data);
320 static int acpi_ec_polling_read(union acpi_ec *ec, u8 address, u32 * data)
322 acpi_status status = AE_OK;
324 unsigned long flags = 0;
327 ACPI_FUNCTION_TRACE("acpi_ec_read");
330 return_VALUE(-EINVAL);
334 if (ec->common.global_lock) {
335 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
336 if (ACPI_FAILURE(status))
337 return_VALUE(-ENODEV);
340 spin_lock_irqsave(&ec->polling.lock, flags);
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",
359 spin_unlock_irqrestore(&ec->polling.lock, flags);
361 if (ec->common.global_lock)
362 acpi_release_global_lock(glk);
364 return_VALUE(result);
367 static int acpi_ec_polling_write(union acpi_ec *ec, u8 address, u8 data)
370 acpi_status status = AE_OK;
371 unsigned long flags = 0;
374 ACPI_FUNCTION_TRACE("acpi_ec_write");
377 return_VALUE(-EINVAL);
379 if (ec->common.global_lock) {
380 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
381 if (ACPI_FAILURE(status))
382 return_VALUE(-ENODEV);
385 spin_lock_irqsave(&ec->polling.lock, flags);
387 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_WRITE,
388 &ec->common.command_addr);
389 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
393 acpi_hw_low_level_write(8, address, &ec->common.data_addr);
394 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
398 acpi_hw_low_level_write(8, data, &ec->common.data_addr);
399 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
403 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Wrote [%02x] to address [%02x]\n",
407 spin_unlock_irqrestore(&ec->polling.lock, flags);
409 if (ec->common.global_lock)
410 acpi_release_global_lock(glk);
412 return_VALUE(result);
415 static int acpi_ec_burst_read(union acpi_ec *ec, u8 address, u32 * data)
420 ACPI_FUNCTION_TRACE("acpi_ec_read");
423 return_VALUE(-EINVAL);
427 if (ec->common.global_lock) {
428 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
429 if (ACPI_FAILURE(status))
430 return_VALUE(-ENODEV);
433 WARN_ON(in_interrupt());
434 down(&ec->burst.sem);
436 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
438 printk("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("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("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);
464 return_VALUE(status);
467 static int acpi_ec_burst_write(union acpi_ec *ec, u8 address, u8 data)
472 ACPI_FUNCTION_TRACE("acpi_ec_write");
475 return_VALUE(-EINVAL);
477 if (ec->common.global_lock) {
478 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
479 if (ACPI_FAILURE(status))
480 return_VALUE(-ENODEV);
483 WARN_ON(in_interrupt());
484 down(&ec->burst.sem);
486 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
488 printk("write EC, IB not empty\n");
490 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_WRITE,
491 &ec->common.command_addr);
492 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
494 printk("write EC, IB not empty\n");
497 acpi_hw_low_level_write(8, address, &ec->common.data_addr);
498 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
500 printk("write EC, IB not empty\n");
503 acpi_hw_low_level_write(8, data, &ec->common.data_addr);
505 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Wrote [%02x] to address [%02x]\n",
510 if (ec->common.global_lock)
511 acpi_release_global_lock(glk);
513 return_VALUE(status);
517 * Externally callable EC access functions. For now, assume 1 EC only
519 int ec_read(u8 addr, u8 * val)
528 ec = acpi_driver_data(first_ec);
530 err = acpi_ec_read(ec, addr, &temp_data);
539 EXPORT_SYMBOL(ec_read);
541 int ec_write(u8 addr, u8 val)
549 ec = acpi_driver_data(first_ec);
551 err = acpi_ec_write(ec, addr, val);
556 EXPORT_SYMBOL(ec_write);
558 static int acpi_ec_query(union acpi_ec *ec, u32 * data)
560 if (acpi_ec_polling_mode)
561 return acpi_ec_polling_query(ec, data);
563 return acpi_ec_burst_query(ec, data);
565 static int acpi_ec_polling_query(union acpi_ec *ec, u32 * data)
568 acpi_status status = AE_OK;
569 unsigned long flags = 0;
572 ACPI_FUNCTION_TRACE("acpi_ec_query");
575 return_VALUE(-EINVAL);
579 if (ec->common.global_lock) {
580 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
581 if (ACPI_FAILURE(status))
582 return_VALUE(-ENODEV);
586 * Query the EC to find out which _Qxx method we need to evaluate.
587 * Note that successful completion of the query causes the ACPI_EC_SCI
588 * bit to be cleared (and thus clearing the interrupt source).
590 spin_lock_irqsave(&ec->polling.lock, flags);
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);
603 spin_unlock_irqrestore(&ec->polling.lock, flags);
605 if (ec->common.global_lock)
606 acpi_release_global_lock(glk);
608 return_VALUE(result);
610 static int acpi_ec_burst_query(union acpi_ec *ec, u32 * data)
615 ACPI_FUNCTION_TRACE("acpi_ec_query");
618 return_VALUE(-EINVAL);
621 if (ec->common.global_lock) {
622 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
623 if (ACPI_FAILURE(status))
624 return_VALUE(-ENODEV);
627 down(&ec->burst.sem);
629 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
631 printk("query EC, IB not empty\n");
635 * Query the EC to find out which _Qxx method we need to evaluate.
636 * Note that successful completion of the query causes the ACPI_EC_SCI
637 * bit to be cleared (and thus clearing the interrupt source).
639 acpi_hw_low_level_write(8, ACPI_EC_COMMAND_QUERY,
640 &ec->common.command_addr);
641 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
643 printk("query EC, OB not full\n");
647 acpi_hw_low_level_read(8, data, &ec->common.data_addr);
654 if (ec->common.global_lock)
655 acpi_release_global_lock(glk);
657 return_VALUE(status);
660 /* --------------------------------------------------------------------------
662 -------------------------------------------------------------------------- */
664 union acpi_ec_query_data {
669 static void acpi_ec_gpe_query(void *ec_cxt)
671 if (acpi_ec_polling_mode)
672 acpi_ec_gpe_polling_query(ec_cxt);
674 acpi_ec_gpe_burst_query(ec_cxt);
677 static void acpi_ec_gpe_polling_query(void *ec_cxt)
679 union acpi_ec *ec = (union acpi_ec *)ec_cxt;
681 unsigned long flags = 0;
682 static char object_name[5] = { '_', 'Q', '0', '0', '\0' };
683 const char hex[] = { '0', '1', '2', '3', '4', '5', '6', '7',
684 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
687 ACPI_FUNCTION_TRACE("acpi_ec_gpe_query");
692 spin_lock_irqsave(&ec->polling.lock, flags);
693 acpi_hw_low_level_read(8, &value, &ec->common.command_addr);
694 spin_unlock_irqrestore(&ec->polling.lock, flags);
696 /* TBD: Implement asynch events!
697 * NOTE: All we care about are EC-SCI's. Other EC events are
698 * handled via polling (yuck!). This is because some systems
699 * treat EC-SCIs as level (versus EDGE!) triggered, preventing
700 * a purely interrupt-driven approach (grumble, grumble).
702 if (!(value & ACPI_EC_FLAG_SCI))
705 if (acpi_ec_query(ec, &value))
708 object_name[2] = hex[((value >> 4) & 0x0F)];
709 object_name[3] = hex[(value & 0x0F)];
711 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s\n", object_name));
713 acpi_evaluate_object(ec->common.handle, object_name, NULL, NULL);
716 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
718 static void acpi_ec_gpe_burst_query(void *ec_cxt)
720 union acpi_ec *ec = (union acpi_ec *)ec_cxt;
722 int result = -ENODATA;
723 static char object_name[5] = { '_', 'Q', '0', '0', '\0' };
724 const char hex[] = { '0', '1', '2', '3', '4', '5', '6', '7',
725 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
728 ACPI_FUNCTION_TRACE("acpi_ec_gpe_query");
730 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_SCI)
731 result = acpi_ec_query(ec, &value);
736 object_name[2] = hex[((value >> 4) & 0x0F)];
737 object_name[3] = hex[(value & 0x0F)];
739 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s\n", object_name));
741 acpi_evaluate_object(ec->common.handle, object_name, NULL, NULL);
743 atomic_dec(&ec->burst.pending_gpe);
747 static u32 acpi_ec_gpe_handler(void *data)
749 if (acpi_ec_polling_mode)
750 return acpi_ec_gpe_polling_handler(data);
752 return acpi_ec_gpe_burst_handler(data);
754 static u32 acpi_ec_gpe_polling_handler(void *data)
756 acpi_status status = AE_OK;
757 union acpi_ec *ec = (union acpi_ec *)data;
760 return ACPI_INTERRUPT_NOT_HANDLED;
762 acpi_disable_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
764 status = acpi_os_queue_for_execution(OSD_PRIORITY_GPE,
765 acpi_ec_gpe_query, ec);
768 return ACPI_INTERRUPT_HANDLED;
770 return ACPI_INTERRUPT_NOT_HANDLED;
772 static u32 acpi_ec_gpe_burst_handler(void *data)
774 acpi_status status = AE_OK;
776 union acpi_ec *ec = (union acpi_ec *)data;
779 return ACPI_INTERRUPT_NOT_HANDLED;
781 acpi_clear_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
782 value = acpi_ec_read_status(ec);
784 switch (ec->burst.expect_event) {
785 case ACPI_EC_EVENT_OBF:
786 if (!(value & ACPI_EC_FLAG_OBF))
788 case ACPI_EC_EVENT_IBE:
789 if ((value & ACPI_EC_FLAG_IBF))
791 ec->burst.expect_event = 0;
792 wake_up(&ec->burst.wait);
793 return ACPI_INTERRUPT_HANDLED;
798 if (value & ACPI_EC_FLAG_SCI) {
799 atomic_add(1, &ec->burst.pending_gpe);
800 status = acpi_os_queue_for_execution(OSD_PRIORITY_GPE,
801 acpi_ec_gpe_query, ec);
802 return status == AE_OK ?
803 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
805 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
806 return status == AE_OK ?
807 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
810 /* --------------------------------------------------------------------------
811 Address Space Management
812 -------------------------------------------------------------------------- */
815 acpi_ec_space_setup(acpi_handle region_handle,
816 u32 function, void *handler_context, void **return_context)
819 * The EC object is in the handler context and is needed
820 * when calling the acpi_ec_space_handler.
822 *return_context = (function != ACPI_REGION_DEACTIVATE) ?
823 handler_context : NULL;
829 acpi_ec_space_handler(u32 function,
830 acpi_physical_address address,
832 acpi_integer * value,
833 void *handler_context, void *region_context)
836 union acpi_ec *ec = NULL;
838 acpi_integer f_v = 0;
841 ACPI_FUNCTION_TRACE("acpi_ec_space_handler");
843 if ((address > 0xFF) || !value || !handler_context)
844 return_VALUE(AE_BAD_PARAMETER);
846 if (bit_width != 8 && acpi_strict) {
847 printk(KERN_WARNING PREFIX
848 "acpi_ec_space_handler: bit_width should be 8\n");
849 return_VALUE(AE_BAD_PARAMETER);
852 ec = (union acpi_ec *)handler_context;
858 result = acpi_ec_read(ec, (u8) address, (u32 *) & temp);
861 result = acpi_ec_write(ec, (u8) address, (u8) temp);
871 if (function == ACPI_READ)
872 f_v |= temp << 8 * i;
873 if (function == ACPI_WRITE)
880 if (function == ACPI_READ) {
881 f_v |= temp << 8 * i;
888 return_VALUE(AE_BAD_PARAMETER);
891 return_VALUE(AE_NOT_FOUND);
894 return_VALUE(AE_TIME);
901 /* --------------------------------------------------------------------------
903 -------------------------------------------------------------------------- */
905 static struct proc_dir_entry *acpi_ec_dir;
907 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
909 union acpi_ec *ec = (union acpi_ec *)seq->private;
911 ACPI_FUNCTION_TRACE("acpi_ec_read_info");
916 seq_printf(seq, "gpe bit: 0x%02x\n",
917 (u32) ec->common.gpe_bit);
918 seq_printf(seq, "ports: 0x%02x, 0x%02x\n",
919 (u32) ec->common.status_addr.address,
920 (u32) ec->common.data_addr.address);
921 seq_printf(seq, "use global lock: %s\n",
922 ec->common.global_lock ? "yes" : "no");
923 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
929 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
931 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
934 static struct file_operations acpi_ec_info_ops = {
935 .open = acpi_ec_info_open_fs,
938 .release = single_release,
939 .owner = THIS_MODULE,
942 static int acpi_ec_add_fs(struct acpi_device *device)
944 struct proc_dir_entry *entry = NULL;
946 ACPI_FUNCTION_TRACE("acpi_ec_add_fs");
948 if (!acpi_device_dir(device)) {
949 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
951 if (!acpi_device_dir(device))
952 return_VALUE(-ENODEV);
955 entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
956 acpi_device_dir(device));
958 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
959 "Unable to create '%s' fs entry\n",
962 entry->proc_fops = &acpi_ec_info_ops;
963 entry->data = acpi_driver_data(device);
964 entry->owner = THIS_MODULE;
970 static int acpi_ec_remove_fs(struct acpi_device *device)
972 ACPI_FUNCTION_TRACE("acpi_ec_remove_fs");
974 if (acpi_device_dir(device)) {
975 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
976 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
977 acpi_device_dir(device) = NULL;
983 /* --------------------------------------------------------------------------
985 -------------------------------------------------------------------------- */
987 static int acpi_ec_polling_add(struct acpi_device *device)
990 acpi_status status = AE_OK;
991 union acpi_ec *ec = NULL;
994 ACPI_FUNCTION_TRACE("acpi_ec_add");
997 return_VALUE(-EINVAL);
999 ec = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1001 return_VALUE(-ENOMEM);
1002 memset(ec, 0, sizeof(union acpi_ec));
1004 ec->common.handle = device->handle;
1005 ec->common.uid = -1;
1006 spin_lock_init(&ec->polling.lock);
1007 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1008 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1009 acpi_driver_data(device) = ec;
1011 /* Use the global lock for all EC transactions? */
1012 acpi_evaluate_integer(ec->common.handle, "_GLK", NULL,
1013 &ec->common.global_lock);
1015 /* If our UID matches the UID for the ECDT-enumerated EC,
1016 we now have the *real* EC info, so kill the makeshift one. */
1017 acpi_evaluate_integer(ec->common.handle, "_UID", NULL, &uid);
1018 if (ec_ecdt && ec_ecdt->common.uid == uid) {
1019 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
1021 &acpi_ec_space_handler);
1023 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1024 &acpi_ec_gpe_handler);
1029 /* Get GPE bit assignment (EC events). */
1030 /* TODO: Add support for _GPE returning a package */
1032 acpi_evaluate_integer(ec->common.handle, "_GPE", NULL,
1033 &ec->common.gpe_bit);
1034 if (ACPI_FAILURE(status)) {
1035 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
1036 "Error obtaining GPE bit assignment\n"));
1041 result = acpi_ec_add_fs(device);
1045 printk(KERN_INFO PREFIX "%s [%s] (gpe %d)\n",
1046 acpi_device_name(device), acpi_device_bid(device),
1047 (u32) ec->common.gpe_bit);
1056 return_VALUE(result);
1058 static int acpi_ec_burst_add(struct acpi_device *device)
1061 acpi_status status = AE_OK;
1062 union acpi_ec *ec = NULL;
1065 ACPI_FUNCTION_TRACE("acpi_ec_add");
1068 return_VALUE(-EINVAL);
1070 ec = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1072 return_VALUE(-ENOMEM);
1073 memset(ec, 0, sizeof(union acpi_ec));
1075 ec->common.handle = device->handle;
1076 ec->common.uid = -1;
1077 atomic_set(&ec->burst.pending_gpe, 0);
1078 atomic_set(&ec->burst.leaving_burst, 1);
1079 init_MUTEX(&ec->burst.sem);
1080 init_waitqueue_head(&ec->burst.wait);
1081 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1082 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1083 acpi_driver_data(device) = ec;
1085 /* Use the global lock for all EC transactions? */
1086 acpi_evaluate_integer(ec->common.handle, "_GLK", NULL,
1087 &ec->common.global_lock);
1089 /* If our UID matches the UID for the ECDT-enumerated EC,
1090 we now have the *real* EC info, so kill the makeshift one. */
1091 acpi_evaluate_integer(ec->common.handle, "_UID", NULL, &uid);
1092 if (ec_ecdt && ec_ecdt->common.uid == uid) {
1093 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
1095 &acpi_ec_space_handler);
1097 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1098 &acpi_ec_gpe_handler);
1103 /* Get GPE bit assignment (EC events). */
1104 /* TODO: Add support for _GPE returning a package */
1106 acpi_evaluate_integer(ec->common.handle, "_GPE", NULL,
1107 &ec->common.gpe_bit);
1108 if (ACPI_FAILURE(status)) {
1109 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
1110 "Error obtaining GPE bit assignment\n"));
1115 result = acpi_ec_add_fs(device);
1119 printk("burst-mode-ec-10-Aug\n");
1120 printk(KERN_INFO PREFIX "%s [%s] (gpe %d)\n",
1121 acpi_device_name(device), acpi_device_bid(device),
1122 (u32) ec->common.gpe_bit);
1131 return_VALUE(result);
1134 static int acpi_ec_remove(struct acpi_device *device, int type)
1136 union acpi_ec *ec = NULL;
1138 ACPI_FUNCTION_TRACE("acpi_ec_remove");
1141 return_VALUE(-EINVAL);
1143 ec = acpi_driver_data(device);
1145 acpi_ec_remove_fs(device);
1153 acpi_ec_io_ports(struct acpi_resource *resource, void *context)
1155 union acpi_ec *ec = (union acpi_ec *)context;
1156 struct acpi_generic_address *addr;
1158 if (resource->id != ACPI_RSTYPE_IO) {
1163 * The first address region returned is the data port, and
1164 * the second address region returned is the status/command
1167 if (ec->common.data_addr.register_bit_width == 0) {
1168 addr = &ec->common.data_addr;
1169 } else if (ec->common.command_addr.register_bit_width == 0) {
1170 addr = &ec->common.command_addr;
1172 return AE_CTRL_TERMINATE;
1175 addr->address_space_id = ACPI_ADR_SPACE_SYSTEM_IO;
1176 addr->register_bit_width = 8;
1177 addr->register_bit_offset = 0;
1178 addr->address = resource->data.io.min_base_address;
1183 static int acpi_ec_start(struct acpi_device *device)
1185 acpi_status status = AE_OK;
1186 union acpi_ec *ec = NULL;
1188 ACPI_FUNCTION_TRACE("acpi_ec_start");
1191 return_VALUE(-EINVAL);
1193 ec = acpi_driver_data(device);
1196 return_VALUE(-EINVAL);
1199 * Get I/O port addresses. Convert to GAS format.
1201 status = acpi_walk_resources(ec->common.handle, METHOD_NAME__CRS,
1202 acpi_ec_io_ports, ec);
1203 if (ACPI_FAILURE(status)
1204 || ec->common.command_addr.register_bit_width == 0) {
1205 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
1206 "Error getting I/O port addresses"));
1207 return_VALUE(-ENODEV);
1210 ec->common.status_addr = ec->common.command_addr;
1212 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "gpe=0x%02x, ports=0x%2x,0x%2x\n",
1213 (u32) ec->common.gpe_bit,
1214 (u32) ec->common.command_addr.address,
1215 (u32) ec->common.data_addr.address));
1218 * Install GPE handler
1220 status = acpi_install_gpe_handler(NULL, ec->common.gpe_bit,
1221 ACPI_GPE_EDGE_TRIGGERED,
1222 &acpi_ec_gpe_handler, ec);
1223 if (ACPI_FAILURE(status)) {
1224 return_VALUE(-ENODEV);
1226 acpi_set_gpe_type(NULL, ec->common.gpe_bit, ACPI_GPE_TYPE_RUNTIME);
1227 acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
1229 status = acpi_install_address_space_handler(ec->common.handle,
1231 &acpi_ec_space_handler,
1232 &acpi_ec_space_setup, ec);
1233 if (ACPI_FAILURE(status)) {
1234 acpi_remove_gpe_handler(NULL, ec->common.gpe_bit,
1235 &acpi_ec_gpe_handler);
1236 return_VALUE(-ENODEV);
1239 return_VALUE(AE_OK);
1242 static int acpi_ec_stop(struct acpi_device *device, int type)
1244 acpi_status status = AE_OK;
1245 union acpi_ec *ec = NULL;
1247 ACPI_FUNCTION_TRACE("acpi_ec_stop");
1250 return_VALUE(-EINVAL);
1252 ec = acpi_driver_data(device);
1254 status = acpi_remove_address_space_handler(ec->common.handle,
1256 &acpi_ec_space_handler);
1257 if (ACPI_FAILURE(status))
1258 return_VALUE(-ENODEV);
1261 acpi_remove_gpe_handler(NULL, ec->common.gpe_bit,
1262 &acpi_ec_gpe_handler);
1263 if (ACPI_FAILURE(status))
1264 return_VALUE(-ENODEV);
1269 static acpi_status __init
1270 acpi_fake_ecdt_callback(acpi_handle handle,
1271 u32 Level, void *context, void **retval)
1274 if (acpi_ec_polling_mode)
1275 return acpi_fake_ecdt_polling_callback(handle,
1276 Level, context, retval);
1278 return acpi_fake_ecdt_burst_callback(handle,
1279 Level, context, retval);
1282 static acpi_status __init
1283 acpi_fake_ecdt_polling_callback(acpi_handle handle,
1284 u32 Level, void *context, void **retval)
1288 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1289 acpi_ec_io_ports, ec_ecdt);
1290 if (ACPI_FAILURE(status))
1292 ec_ecdt->common.status_addr = ec_ecdt->common.command_addr;
1294 ec_ecdt->common.uid = -1;
1295 acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->common.uid);
1298 acpi_evaluate_integer(handle, "_GPE", NULL,
1299 &ec_ecdt->common.gpe_bit);
1300 if (ACPI_FAILURE(status))
1302 spin_lock_init(&ec_ecdt->polling.lock);
1303 ec_ecdt->common.global_lock = TRUE;
1304 ec_ecdt->common.handle = handle;
1306 printk(KERN_INFO PREFIX "GPE=0x%02x, ports=0x%2x, 0x%2x\n",
1307 (u32) ec_ecdt->common.gpe_bit,
1308 (u32) ec_ecdt->common.command_addr.address,
1309 (u32) ec_ecdt->common.data_addr.address);
1311 return AE_CTRL_TERMINATE;
1314 static acpi_status __init
1315 acpi_fake_ecdt_burst_callback(acpi_handle handle,
1316 u32 Level, void *context, void **retval)
1320 init_MUTEX(&ec_ecdt->burst.sem);
1321 init_waitqueue_head(&ec_ecdt->burst.wait);
1322 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1323 acpi_ec_io_ports, ec_ecdt);
1324 if (ACPI_FAILURE(status))
1326 ec_ecdt->common.status_addr = ec_ecdt->common.command_addr;
1328 ec_ecdt->common.uid = -1;
1329 acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->common.uid);
1332 acpi_evaluate_integer(handle, "_GPE", NULL,
1333 &ec_ecdt->common.gpe_bit);
1334 if (ACPI_FAILURE(status))
1336 ec_ecdt->common.global_lock = TRUE;
1337 ec_ecdt->common.handle = handle;
1339 printk(KERN_INFO PREFIX "GPE=0x%02x, ports=0x%2x, 0x%2x\n",
1340 (u32) ec_ecdt->common.gpe_bit,
1341 (u32) ec_ecdt->common.command_addr.address,
1342 (u32) ec_ecdt->common.data_addr.address);
1344 return AE_CTRL_TERMINATE;
1348 * Some BIOS (such as some from Gateway laptops) access EC region very early
1349 * such as in BAT0._INI or EC._INI before an EC device is found and
1350 * do not provide an ECDT. According to ACPI spec, ECDT isn't mandatorily
1351 * required, but if EC regison is accessed early, it is required.
1352 * The routine tries to workaround the BIOS bug by pre-scan EC device
1353 * It assumes that _CRS, _HID, _GPE, _UID methods of EC don't touch any
1354 * op region (since _REG isn't invoked yet). The assumption is true for
1355 * all systems found.
1357 static int __init acpi_ec_fake_ecdt(void)
1362 printk(KERN_INFO PREFIX "Try to make an fake ECDT\n");
1364 ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1369 memset(ec_ecdt, 0, sizeof(union acpi_ec));
1371 status = acpi_get_devices(ACPI_EC_HID,
1372 acpi_fake_ecdt_callback, NULL, NULL);
1373 if (ACPI_FAILURE(status)) {
1381 printk(KERN_ERR PREFIX "Can't make an fake ECDT\n");
1385 static int __init acpi_ec_get_real_ecdt(void)
1387 if (acpi_ec_polling_mode)
1388 return acpi_ec_polling_get_real_ecdt();
1390 return acpi_ec_burst_get_real_ecdt();
1393 static int __init acpi_ec_polling_get_real_ecdt(void)
1396 struct acpi_table_ecdt *ecdt_ptr;
1398 status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
1399 (struct acpi_table_header **)
1401 if (ACPI_FAILURE(status))
1404 printk(KERN_INFO PREFIX "Found ECDT\n");
1407 * Generate a temporary ec context to use until the namespace is scanned
1409 ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1412 memset(ec_ecdt, 0, sizeof(union acpi_ec));
1414 ec_ecdt->common.command_addr = ecdt_ptr->ec_control;
1415 ec_ecdt->common.status_addr = ecdt_ptr->ec_control;
1416 ec_ecdt->common.data_addr = ecdt_ptr->ec_data;
1417 ec_ecdt->common.gpe_bit = ecdt_ptr->gpe_bit;
1418 spin_lock_init(&ec_ecdt->polling.lock);
1419 /* use the GL just to be safe */
1420 ec_ecdt->common.global_lock = TRUE;
1421 ec_ecdt->common.uid = ecdt_ptr->uid;
1424 acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->common.handle);
1425 if (ACPI_FAILURE(status)) {
1431 printk(KERN_ERR PREFIX "Could not use ECDT\n");
1438 static int __init acpi_ec_burst_get_real_ecdt(void)
1441 struct acpi_table_ecdt *ecdt_ptr;
1443 status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
1444 (struct acpi_table_header **)
1446 if (ACPI_FAILURE(status))
1449 printk(KERN_INFO PREFIX "Found ECDT\n");
1452 * Generate a temporary ec context to use until the namespace is scanned
1454 ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1457 memset(ec_ecdt, 0, sizeof(union acpi_ec));
1459 init_MUTEX(&ec_ecdt->burst.sem);
1460 init_waitqueue_head(&ec_ecdt->burst.wait);
1461 ec_ecdt->common.command_addr = ecdt_ptr->ec_control;
1462 ec_ecdt->common.status_addr = ecdt_ptr->ec_control;
1463 ec_ecdt->common.data_addr = ecdt_ptr->ec_data;
1464 ec_ecdt->common.gpe_bit = ecdt_ptr->gpe_bit;
1465 /* use the GL just to be safe */
1466 ec_ecdt->common.global_lock = TRUE;
1467 ec_ecdt->common.uid = ecdt_ptr->uid;
1470 acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->common.handle);
1471 if (ACPI_FAILURE(status)) {
1477 printk(KERN_ERR PREFIX "Could not use ECDT\n");
1484 static int __initdata acpi_fake_ecdt_enabled;
1485 int __init acpi_ec_ecdt_probe(void)
1490 ret = acpi_ec_get_real_ecdt();
1491 /* Try to make a fake ECDT */
1492 if (ret && acpi_fake_ecdt_enabled) {
1493 ret = acpi_ec_fake_ecdt();
1500 * Install GPE handler
1502 status = acpi_install_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1503 ACPI_GPE_EDGE_TRIGGERED,
1504 &acpi_ec_gpe_handler, ec_ecdt);
1505 if (ACPI_FAILURE(status)) {
1508 acpi_set_gpe_type(NULL, ec_ecdt->common.gpe_bit, ACPI_GPE_TYPE_RUNTIME);
1509 acpi_enable_gpe(NULL, ec_ecdt->common.gpe_bit, ACPI_NOT_ISR);
1511 status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT,
1513 &acpi_ec_space_handler,
1514 &acpi_ec_space_setup,
1516 if (ACPI_FAILURE(status)) {
1517 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1518 &acpi_ec_gpe_handler);
1525 printk(KERN_ERR PREFIX "Could not use ECDT\n");
1532 static int __init acpi_ec_init(void)
1536 ACPI_FUNCTION_TRACE("acpi_ec_init");
1541 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1543 return_VALUE(-ENODEV);
1545 /* Now register the driver for the EC */
1546 result = acpi_bus_register_driver(&acpi_ec_driver);
1548 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1549 return_VALUE(-ENODEV);
1552 return_VALUE(result);
1555 subsys_initcall(acpi_ec_init);
1557 /* EC driver currently not unloadable */
1559 static void __exit acpi_ec_exit(void)
1561 ACPI_FUNCTION_TRACE("acpi_ec_exit");
1563 acpi_bus_unregister_driver(&acpi_ec_driver);
1565 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1571 static int __init acpi_fake_ecdt_setup(char *str)
1573 acpi_fake_ecdt_enabled = 1;
1577 __setup("acpi_fake_ecdt", acpi_fake_ecdt_setup);
1578 static int __init acpi_ec_set_polling_mode(char *str)
1582 if (!get_option(&str, &burst))
1586 acpi_ec_polling_mode = EC_BURST;
1587 acpi_ec_driver.ops.add = acpi_ec_burst_add;
1589 acpi_ec_polling_mode = EC_POLLING;
1590 acpi_ec_driver.ops.add = acpi_ec_polling_add;
1592 printk(KERN_INFO PREFIX "EC %s mode.\n", burst ? "burst" : "polling");
1596 __setup("ec_burst=", acpi_ec_set_polling_mode);