2 * ec.c - ACPI Embedded Controller Driver (v2.1)
4 * Copyright (C) 2006-2008 Alexey Starikovskiy <astarikovskiy@suse.de>
5 * Copyright (C) 2006 Denis Sadykov <denis.m.sadykov@intel.com>
6 * Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
7 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
8 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or (at
15 * your option) any later version.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
26 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29 /* Uncomment next line to get verbose printout */
32 #include <linux/kernel.h>
33 #include <linux/module.h>
34 #include <linux/init.h>
35 #include <linux/types.h>
36 #include <linux/delay.h>
37 #include <linux/proc_fs.h>
38 #include <linux/seq_file.h>
39 #include <linux/interrupt.h>
40 #include <linux/list.h>
41 #include <linux/spinlock.h>
43 #include <acpi/acpi_bus.h>
44 #include <acpi/acpi_drivers.h>
45 #include <linux/dmi.h>
47 #define ACPI_EC_CLASS "embedded_controller"
48 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
49 #define ACPI_EC_FILE_INFO "info"
51 #define PREFIX "ACPI: EC: "
53 /* EC status register */
54 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
55 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
56 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
57 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
61 ACPI_EC_COMMAND_READ
= 0x80,
62 ACPI_EC_COMMAND_WRITE
= 0x81,
63 ACPI_EC_BURST_ENABLE
= 0x82,
64 ACPI_EC_BURST_DISABLE
= 0x83,
65 ACPI_EC_COMMAND_QUERY
= 0x84,
68 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
69 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
70 #define ACPI_EC_CDELAY 10 /* Wait 10us before polling EC */
71 #define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
73 #define ACPI_EC_STORM_THRESHOLD 8 /* number of false interrupts
74 per one transaction */
77 EC_FLAGS_QUERY_PENDING
, /* Query is pending */
78 EC_FLAGS_GPE_STORM
, /* GPE storm detected */
79 EC_FLAGS_HANDLERS_INSTALLED
, /* Handlers for GPE and
80 * OpReg are installed */
81 EC_FLAGS_FROZEN
, /* Transactions are suspended */
84 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
85 /* External interfaces use first EC only, so remember */
86 typedef int (*acpi_ec_query_func
) (void *data
);
88 struct acpi_ec_query_handler
{
89 struct list_head node
;
90 acpi_ec_query_func func
;
99 unsigned short irq_count
;
108 static struct acpi_ec
{
111 unsigned long command_addr
;
112 unsigned long data_addr
;
113 unsigned long global_lock
;
116 wait_queue_head_t wait
;
117 struct list_head list
;
118 struct transaction
*curr
;
119 spinlock_t curr_lock
;
120 } *boot_ec
, *first_ec
;
122 static int EC_FLAGS_MSI
; /* Out-of-spec MSI controller */
123 static int EC_FLAGS_VALIDATE_ECDT
; /* ASUStec ECDTs need to be validated */
124 static int EC_FLAGS_SKIP_DSDT_SCAN
; /* Not all BIOS survive early DSDT scan */
126 /* --------------------------------------------------------------------------
127 Transaction Management
128 -------------------------------------------------------------------------- */
130 static inline u8
acpi_ec_read_status(struct acpi_ec
*ec
)
132 u8 x
= inb(ec
->command_addr
);
133 pr_debug(PREFIX
"---> status = 0x%2.2x\n", x
);
137 static inline u8
acpi_ec_read_data(struct acpi_ec
*ec
)
139 u8 x
= inb(ec
->data_addr
);
140 pr_debug(PREFIX
"---> data = 0x%2.2x\n", x
);
144 static inline void acpi_ec_write_cmd(struct acpi_ec
*ec
, u8 command
)
146 pr_debug(PREFIX
"<--- command = 0x%2.2x\n", command
);
147 outb(command
, ec
->command_addr
);
150 static inline void acpi_ec_write_data(struct acpi_ec
*ec
, u8 data
)
152 pr_debug(PREFIX
"<--- data = 0x%2.2x\n", data
);
153 outb(data
, ec
->data_addr
);
156 static int ec_transaction_done(struct acpi_ec
*ec
)
160 spin_lock_irqsave(&ec
->curr_lock
, flags
);
161 if (!ec
->curr
|| ec
->curr
->done
)
163 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
167 static void start_transaction(struct acpi_ec
*ec
)
169 ec
->curr
->irq_count
= ec
->curr
->wi
= ec
->curr
->ri
= 0;
170 ec
->curr
->done
= false;
171 acpi_ec_write_cmd(ec
, ec
->curr
->command
);
174 static void advance_transaction(struct acpi_ec
*ec
, u8 status
)
177 spin_lock_irqsave(&ec
->curr_lock
, flags
);
180 if (ec
->curr
->wlen
> ec
->curr
->wi
) {
181 if ((status
& ACPI_EC_FLAG_IBF
) == 0)
182 acpi_ec_write_data(ec
,
183 ec
->curr
->wdata
[ec
->curr
->wi
++]);
186 } else if (ec
->curr
->rlen
> ec
->curr
->ri
) {
187 if ((status
& ACPI_EC_FLAG_OBF
) == 1) {
188 ec
->curr
->rdata
[ec
->curr
->ri
++] = acpi_ec_read_data(ec
);
189 if (ec
->curr
->rlen
== ec
->curr
->ri
)
190 ec
->curr
->done
= true;
193 } else if (ec
->curr
->wlen
== ec
->curr
->wi
&&
194 (status
& ACPI_EC_FLAG_IBF
) == 0)
195 ec
->curr
->done
= true;
198 /* false interrupt, state didn't change */
200 ++ec
->curr
->irq_count
;
202 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
205 static int acpi_ec_sync_query(struct acpi_ec
*ec
);
207 static int ec_check_sci_sync(struct acpi_ec
*ec
, u8 state
)
209 if (state
& ACPI_EC_FLAG_SCI
) {
210 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
))
211 return acpi_ec_sync_query(ec
);
216 static int ec_poll(struct acpi_ec
*ec
)
219 int repeat
= 2; /* number of command restarts */
221 unsigned long delay
= jiffies
+
222 msecs_to_jiffies(ACPI_EC_DELAY
);
224 /* don't sleep with disabled interrupts */
225 if (EC_FLAGS_MSI
|| irqs_disabled()) {
226 udelay(ACPI_EC_MSI_UDELAY
);
227 if (ec_transaction_done(ec
))
230 if (wait_event_timeout(ec
->wait
,
231 ec_transaction_done(ec
),
232 msecs_to_jiffies(1)))
235 advance_transaction(ec
, acpi_ec_read_status(ec
));
236 } while (time_before(jiffies
, delay
));
237 if (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_IBF
)
239 pr_debug(PREFIX
"controller reset, restart transaction\n");
240 spin_lock_irqsave(&ec
->curr_lock
, flags
);
241 start_transaction(ec
);
242 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
247 static int acpi_ec_transaction_unlocked(struct acpi_ec
*ec
,
248 struct transaction
*t
)
253 udelay(ACPI_EC_MSI_UDELAY
);
254 /* start transaction */
255 spin_lock_irqsave(&ec
->curr_lock
, tmp
);
256 /* following two actions should be kept atomic */
258 start_transaction(ec
);
259 if (ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
)
260 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
261 spin_unlock_irqrestore(&ec
->curr_lock
, tmp
);
263 spin_lock_irqsave(&ec
->curr_lock
, tmp
);
265 spin_unlock_irqrestore(&ec
->curr_lock
, tmp
);
269 static int ec_check_ibf0(struct acpi_ec
*ec
)
271 u8 status
= acpi_ec_read_status(ec
);
272 return (status
& ACPI_EC_FLAG_IBF
) == 0;
275 static int ec_wait_ibf0(struct acpi_ec
*ec
)
277 unsigned long delay
= jiffies
+ msecs_to_jiffies(ACPI_EC_DELAY
);
278 /* interrupt wait manually if GPE mode is not active */
279 while (time_before(jiffies
, delay
))
280 if (wait_event_timeout(ec
->wait
, ec_check_ibf0(ec
),
281 msecs_to_jiffies(1)))
286 static int acpi_ec_transaction(struct acpi_ec
*ec
, struct transaction
*t
)
290 if (!ec
|| (!t
) || (t
->wlen
&& !t
->wdata
) || (t
->rlen
&& !t
->rdata
))
293 memset(t
->rdata
, 0, t
->rlen
);
294 mutex_lock(&ec
->lock
);
295 if (test_bit(EC_FLAGS_FROZEN
, &ec
->flags
)) {
299 if (ec
->global_lock
) {
300 status
= acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK
, &glk
);
301 if (ACPI_FAILURE(status
)) {
306 if (ec_wait_ibf0(ec
)) {
307 pr_err(PREFIX
"input buffer is not empty, "
308 "aborting transaction\n");
312 pr_debug(PREFIX
"transaction start\n");
313 /* disable GPE during transaction if storm is detected */
314 if (test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
316 * It has to be disabled at the hardware level regardless of the
317 * GPE reference counting, so that it doesn't trigger.
319 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_DISABLE
);
322 status
= acpi_ec_transaction_unlocked(ec
, t
);
324 /* check if we received SCI during transaction */
325 ec_check_sci_sync(ec
, acpi_ec_read_status(ec
));
326 if (test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
329 * It is safe to enable the GPE outside of the transaction. Use
330 * acpi_set_gpe() for that, since we used it to disable the GPE
333 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_ENABLE
);
334 } else if (t
->irq_count
> ACPI_EC_STORM_THRESHOLD
) {
335 pr_info(PREFIX
"GPE storm detected, "
336 "transactions will use polling mode\n");
337 set_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
);
339 pr_debug(PREFIX
"transaction end\n");
342 acpi_release_global_lock(glk
);
344 mutex_unlock(&ec
->lock
);
348 static int acpi_ec_burst_enable(struct acpi_ec
*ec
)
351 struct transaction t
= {.command
= ACPI_EC_BURST_ENABLE
,
352 .wdata
= NULL
, .rdata
= &d
,
353 .wlen
= 0, .rlen
= 1};
355 return acpi_ec_transaction(ec
, &t
);
358 static int acpi_ec_burst_disable(struct acpi_ec
*ec
)
360 struct transaction t
= {.command
= ACPI_EC_BURST_DISABLE
,
361 .wdata
= NULL
, .rdata
= NULL
,
362 .wlen
= 0, .rlen
= 0};
364 return (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_BURST
) ?
365 acpi_ec_transaction(ec
, &t
) : 0;
368 static int acpi_ec_read(struct acpi_ec
*ec
, u8 address
, u8
* data
)
372 struct transaction t
= {.command
= ACPI_EC_COMMAND_READ
,
373 .wdata
= &address
, .rdata
= &d
,
374 .wlen
= 1, .rlen
= 1};
376 result
= acpi_ec_transaction(ec
, &t
);
381 static int acpi_ec_write(struct acpi_ec
*ec
, u8 address
, u8 data
)
383 u8 wdata
[2] = { address
, data
};
384 struct transaction t
= {.command
= ACPI_EC_COMMAND_WRITE
,
385 .wdata
= wdata
, .rdata
= NULL
,
386 .wlen
= 2, .rlen
= 0};
388 return acpi_ec_transaction(ec
, &t
);
392 * Externally callable EC access functions. For now, assume 1 EC only
394 int ec_burst_enable(void)
398 return acpi_ec_burst_enable(first_ec
);
401 EXPORT_SYMBOL(ec_burst_enable
);
403 int ec_burst_disable(void)
407 return acpi_ec_burst_disable(first_ec
);
410 EXPORT_SYMBOL(ec_burst_disable
);
412 int ec_read(u8 addr
, u8
* val
)
420 err
= acpi_ec_read(first_ec
, addr
, &temp_data
);
429 EXPORT_SYMBOL(ec_read
);
431 int ec_write(u8 addr
, u8 val
)
438 err
= acpi_ec_write(first_ec
, addr
, val
);
443 EXPORT_SYMBOL(ec_write
);
445 int ec_transaction(u8 command
,
446 const u8
* wdata
, unsigned wdata_len
,
447 u8
* rdata
, unsigned rdata_len
,
450 struct transaction t
= {.command
= command
,
451 .wdata
= wdata
, .rdata
= rdata
,
452 .wlen
= wdata_len
, .rlen
= rdata_len
};
456 return acpi_ec_transaction(first_ec
, &t
);
459 EXPORT_SYMBOL(ec_transaction
);
461 void acpi_ec_suspend_transactions(void)
463 struct acpi_ec
*ec
= first_ec
;
468 mutex_lock(&ec
->lock
);
469 /* Prevent transactions from being carried out */
470 set_bit(EC_FLAGS_FROZEN
, &ec
->flags
);
471 mutex_unlock(&ec
->lock
);
474 void acpi_ec_resume_transactions(void)
476 struct acpi_ec
*ec
= first_ec
;
481 mutex_lock(&ec
->lock
);
482 /* Allow transactions to be carried out again */
483 clear_bit(EC_FLAGS_FROZEN
, &ec
->flags
);
484 mutex_unlock(&ec
->lock
);
487 static int acpi_ec_query_unlocked(struct acpi_ec
*ec
, u8
* data
)
491 struct transaction t
= {.command
= ACPI_EC_COMMAND_QUERY
,
492 .wdata
= NULL
, .rdata
= &d
,
493 .wlen
= 0, .rlen
= 1};
497 * Query the EC to find out which _Qxx method we need to evaluate.
498 * Note that successful completion of the query causes the ACPI_EC_SCI
499 * bit to be cleared (and thus clearing the interrupt source).
501 result
= acpi_ec_transaction_unlocked(ec
, &t
);
510 /* --------------------------------------------------------------------------
512 -------------------------------------------------------------------------- */
513 int acpi_ec_add_query_handler(struct acpi_ec
*ec
, u8 query_bit
,
514 acpi_handle handle
, acpi_ec_query_func func
,
517 struct acpi_ec_query_handler
*handler
=
518 kzalloc(sizeof(struct acpi_ec_query_handler
), GFP_KERNEL
);
522 handler
->query_bit
= query_bit
;
523 handler
->handle
= handle
;
524 handler
->func
= func
;
525 handler
->data
= data
;
526 mutex_lock(&ec
->lock
);
527 list_add(&handler
->node
, &ec
->list
);
528 mutex_unlock(&ec
->lock
);
532 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler
);
534 void acpi_ec_remove_query_handler(struct acpi_ec
*ec
, u8 query_bit
)
536 struct acpi_ec_query_handler
*handler
, *tmp
;
537 mutex_lock(&ec
->lock
);
538 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
539 if (query_bit
== handler
->query_bit
) {
540 list_del(&handler
->node
);
544 mutex_unlock(&ec
->lock
);
547 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler
);
549 static void acpi_ec_run(void *cxt
)
551 struct acpi_ec_query_handler
*handler
= cxt
;
554 pr_debug(PREFIX
"start query execution\n");
556 handler
->func(handler
->data
);
557 else if (handler
->handle
)
558 acpi_evaluate_object(handler
->handle
, NULL
, NULL
, NULL
);
559 pr_debug(PREFIX
"stop query execution\n");
563 static int acpi_ec_sync_query(struct acpi_ec
*ec
)
567 struct acpi_ec_query_handler
*handler
, *copy
;
568 if ((status
= acpi_ec_query_unlocked(ec
, &value
)))
570 list_for_each_entry(handler
, &ec
->list
, node
) {
571 if (value
== handler
->query_bit
) {
572 /* have custom handler for this bit */
573 copy
= kmalloc(sizeof(*handler
), GFP_KERNEL
);
576 memcpy(copy
, handler
, sizeof(*copy
));
577 pr_debug(PREFIX
"push query execution (0x%2x) on queue\n", value
);
578 return acpi_os_execute((copy
->func
) ?
579 OSL_NOTIFY_HANDLER
: OSL_GPE_HANDLER
,
586 static void acpi_ec_gpe_query(void *ec_cxt
)
588 struct acpi_ec
*ec
= ec_cxt
;
591 mutex_lock(&ec
->lock
);
592 acpi_ec_sync_query(ec
);
593 mutex_unlock(&ec
->lock
);
596 static void acpi_ec_gpe_query(void *ec_cxt
);
598 static int ec_check_sci(struct acpi_ec
*ec
, u8 state
)
600 if (state
& ACPI_EC_FLAG_SCI
) {
601 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
)) {
602 pr_debug(PREFIX
"push gpe query to the queue\n");
603 return acpi_os_execute(OSL_NOTIFY_HANDLER
,
604 acpi_ec_gpe_query
, ec
);
610 static u32
acpi_ec_gpe_handler(void *data
)
612 struct acpi_ec
*ec
= data
;
614 pr_debug(PREFIX
"~~~> interrupt\n");
616 advance_transaction(ec
, acpi_ec_read_status(ec
));
617 if (ec_transaction_done(ec
) &&
618 (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_IBF
) == 0) {
620 ec_check_sci(ec
, acpi_ec_read_status(ec
));
622 return ACPI_INTERRUPT_HANDLED
;
625 /* --------------------------------------------------------------------------
626 Address Space Management
627 -------------------------------------------------------------------------- */
630 acpi_ec_space_handler(u32 function
, acpi_physical_address address
,
631 u32 bits
, u64
*value
,
632 void *handler_context
, void *region_context
)
634 struct acpi_ec
*ec
= handler_context
;
638 if ((address
> 0xFF) || !value
|| !handler_context
)
639 return AE_BAD_PARAMETER
;
641 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
642 return AE_BAD_PARAMETER
;
644 if (bits
!= 8 && acpi_strict
)
645 return AE_BAD_PARAMETER
;
648 acpi_ec_burst_enable(ec
);
650 if (function
== ACPI_READ
) {
651 result
= acpi_ec_read(ec
, address
, &temp
);
654 temp
= 0xff & (*value
);
655 result
= acpi_ec_write(ec
, address
, temp
);
658 for (i
= 8; unlikely(bits
- i
> 0); i
+= 8) {
660 if (function
== ACPI_READ
) {
661 result
= acpi_ec_read(ec
, address
, &temp
);
662 (*value
) |= ((u64
)temp
) << i
;
664 temp
= 0xff & ((*value
) >> i
);
665 result
= acpi_ec_write(ec
, address
, temp
);
670 acpi_ec_burst_disable(ec
);
674 return AE_BAD_PARAMETER
;
687 /* --------------------------------------------------------------------------
689 -------------------------------------------------------------------------- */
691 static struct proc_dir_entry
*acpi_ec_dir
;
693 static int acpi_ec_read_info(struct seq_file
*seq
, void *offset
)
695 struct acpi_ec
*ec
= seq
->private;
700 seq_printf(seq
, "gpe:\t\t\t0x%02x\n", (u32
) ec
->gpe
);
701 seq_printf(seq
, "ports:\t\t\t0x%02x, 0x%02x\n",
702 (unsigned)ec
->command_addr
, (unsigned)ec
->data_addr
);
703 seq_printf(seq
, "use global lock:\t%s\n",
704 ec
->global_lock
? "yes" : "no");
709 static int acpi_ec_info_open_fs(struct inode
*inode
, struct file
*file
)
711 return single_open(file
, acpi_ec_read_info
, PDE(inode
)->data
);
714 static const struct file_operations acpi_ec_info_ops
= {
715 .open
= acpi_ec_info_open_fs
,
718 .release
= single_release
,
719 .owner
= THIS_MODULE
,
722 static int acpi_ec_add_fs(struct acpi_device
*device
)
724 struct proc_dir_entry
*entry
= NULL
;
726 if (!acpi_device_dir(device
)) {
727 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
729 if (!acpi_device_dir(device
))
733 entry
= proc_create_data(ACPI_EC_FILE_INFO
, S_IRUGO
,
734 acpi_device_dir(device
),
735 &acpi_ec_info_ops
, acpi_driver_data(device
));
741 static int acpi_ec_remove_fs(struct acpi_device
*device
)
744 if (acpi_device_dir(device
)) {
745 remove_proc_entry(ACPI_EC_FILE_INFO
, acpi_device_dir(device
));
746 remove_proc_entry(acpi_device_bid(device
), acpi_ec_dir
);
747 acpi_device_dir(device
) = NULL
;
753 /* --------------------------------------------------------------------------
755 -------------------------------------------------------------------------- */
757 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
);
759 static struct acpi_ec
*make_acpi_ec(void)
761 struct acpi_ec
*ec
= kzalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
764 ec
->flags
= 1 << EC_FLAGS_QUERY_PENDING
;
765 mutex_init(&ec
->lock
);
766 init_waitqueue_head(&ec
->wait
);
767 INIT_LIST_HEAD(&ec
->list
);
768 spin_lock_init(&ec
->curr_lock
);
773 acpi_ec_register_query_methods(acpi_handle handle
, u32 level
,
774 void *context
, void **return_value
)
777 struct acpi_buffer buffer
= { sizeof(node_name
), node_name
};
778 struct acpi_ec
*ec
= context
;
782 status
= acpi_get_name(handle
, ACPI_SINGLE_NAME
, &buffer
);
784 if (ACPI_SUCCESS(status
) && sscanf(node_name
, "_Q%x", &value
) == 1) {
785 acpi_ec_add_query_handler(ec
, value
, handle
, NULL
, NULL
);
791 ec_parse_device(acpi_handle handle
, u32 Level
, void *context
, void **retval
)
794 unsigned long long tmp
= 0;
796 struct acpi_ec
*ec
= context
;
798 /* clear addr values, ec_parse_io_ports depend on it */
799 ec
->command_addr
= ec
->data_addr
= 0;
801 status
= acpi_walk_resources(handle
, METHOD_NAME__CRS
,
802 ec_parse_io_ports
, ec
);
803 if (ACPI_FAILURE(status
))
806 /* Get GPE bit assignment (EC events). */
807 /* TODO: Add support for _GPE returning a package */
808 status
= acpi_evaluate_integer(handle
, "_GPE", NULL
, &tmp
);
809 if (ACPI_FAILURE(status
))
812 /* Use the global lock for all EC transactions? */
814 acpi_evaluate_integer(handle
, "_GLK", NULL
, &tmp
);
815 ec
->global_lock
= tmp
;
817 return AE_CTRL_TERMINATE
;
820 static int ec_install_handlers(struct acpi_ec
*ec
)
823 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
))
825 status
= acpi_install_gpe_handler(NULL
, ec
->gpe
,
826 ACPI_GPE_EDGE_TRIGGERED
,
827 &acpi_ec_gpe_handler
, ec
);
828 if (ACPI_FAILURE(status
))
831 acpi_enable_gpe(NULL
, ec
->gpe
, ACPI_GPE_TYPE_RUNTIME
);
832 status
= acpi_install_address_space_handler(ec
->handle
,
834 &acpi_ec_space_handler
,
836 if (ACPI_FAILURE(status
)) {
837 if (status
== AE_NOT_FOUND
) {
839 * Maybe OS fails in evaluating the _REG object.
840 * The AE_NOT_FOUND error will be ignored and OS
841 * continue to initialize EC.
843 printk(KERN_ERR
"Fail in evaluating the _REG object"
844 " of EC device. Broken bios is suspected.\n");
846 acpi_remove_gpe_handler(NULL
, ec
->gpe
,
847 &acpi_ec_gpe_handler
);
848 acpi_disable_gpe(NULL
, ec
->gpe
, ACPI_GPE_TYPE_RUNTIME
);
853 set_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
857 static void ec_remove_handlers(struct acpi_ec
*ec
)
859 acpi_disable_gpe(NULL
, ec
->gpe
, ACPI_GPE_TYPE_RUNTIME
);
860 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec
->handle
,
861 ACPI_ADR_SPACE_EC
, &acpi_ec_space_handler
)))
862 pr_err(PREFIX
"failed to remove space handler\n");
863 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL
, ec
->gpe
,
864 &acpi_ec_gpe_handler
)))
865 pr_err(PREFIX
"failed to remove gpe handler\n");
866 clear_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
869 static int acpi_ec_add(struct acpi_device
*device
)
871 struct acpi_ec
*ec
= NULL
;
874 strcpy(acpi_device_name(device
), ACPI_EC_DEVICE_NAME
);
875 strcpy(acpi_device_class(device
), ACPI_EC_CLASS
);
877 /* Check for boot EC */
879 (boot_ec
->handle
== device
->handle
||
880 boot_ec
->handle
== ACPI_ROOT_OBJECT
)) {
888 if (ec_parse_device(device
->handle
, 0, ec
, NULL
) !=
894 ec
->handle
= device
->handle
;
896 /* Find and register all query methods */
897 acpi_walk_namespace(ACPI_TYPE_METHOD
, ec
->handle
, 1,
898 acpi_ec_register_query_methods
, NULL
, ec
, NULL
);
902 device
->driver_data
= ec
;
903 acpi_ec_add_fs(device
);
904 pr_info(PREFIX
"GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
905 ec
->gpe
, ec
->command_addr
, ec
->data_addr
);
907 ret
= ec_install_handlers(ec
);
909 /* EC is fully operational, allow queries */
910 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
914 static int acpi_ec_remove(struct acpi_device
*device
, int type
)
917 struct acpi_ec_query_handler
*handler
, *tmp
;
922 ec
= acpi_driver_data(device
);
923 ec_remove_handlers(ec
);
924 mutex_lock(&ec
->lock
);
925 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
926 list_del(&handler
->node
);
929 mutex_unlock(&ec
->lock
);
930 acpi_ec_remove_fs(device
);
931 device
->driver_data
= NULL
;
939 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
)
941 struct acpi_ec
*ec
= context
;
943 if (resource
->type
!= ACPI_RESOURCE_TYPE_IO
)
947 * The first address region returned is the data port, and
948 * the second address region returned is the status/command
951 if (ec
->data_addr
== 0)
952 ec
->data_addr
= resource
->data
.io
.minimum
;
953 else if (ec
->command_addr
== 0)
954 ec
->command_addr
= resource
->data
.io
.minimum
;
956 return AE_CTRL_TERMINATE
;
961 int __init
acpi_boot_ec_enable(void)
963 if (!boot_ec
|| test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &boot_ec
->flags
))
965 if (!ec_install_handlers(boot_ec
)) {
972 static const struct acpi_device_id ec_device_ids
[] = {
977 /* Some BIOS do not survive early DSDT scan, skip it */
978 static int ec_skip_dsdt_scan(const struct dmi_system_id
*id
)
980 EC_FLAGS_SKIP_DSDT_SCAN
= 1;
984 /* ASUStek often supplies us with broken ECDT, validate it */
985 static int ec_validate_ecdt(const struct dmi_system_id
*id
)
987 EC_FLAGS_VALIDATE_ECDT
= 1;
991 /* MSI EC needs special treatment, enable it */
992 static int ec_flag_msi(const struct dmi_system_id
*id
)
994 printk(KERN_DEBUG PREFIX
"Detected MSI hardware, enabling workarounds.\n");
996 EC_FLAGS_VALIDATE_ECDT
= 1;
1000 static struct dmi_system_id __initdata ec_dmi_table
[] = {
1002 ec_skip_dsdt_scan
, "Compal JFL92", {
1003 DMI_MATCH(DMI_BIOS_VENDOR
, "COMPAL"),
1004 DMI_MATCH(DMI_BOARD_NAME
, "JFL92") }, NULL
},
1006 ec_flag_msi
, "MSI hardware", {
1007 DMI_MATCH(DMI_BIOS_VENDOR
, "Micro-Star")}, NULL
},
1009 ec_flag_msi
, "MSI hardware", {
1010 DMI_MATCH(DMI_SYS_VENDOR
, "Micro-Star")}, NULL
},
1012 ec_flag_msi
, "MSI hardware", {
1013 DMI_MATCH(DMI_CHASSIS_VENDOR
, "MICRO-Star")}, NULL
},
1015 ec_validate_ecdt
, "ASUS hardware", {
1016 DMI_MATCH(DMI_BIOS_VENDOR
, "ASUS") }, NULL
},
1021 int __init
acpi_ec_ecdt_probe(void)
1024 struct acpi_ec
*saved_ec
= NULL
;
1025 struct acpi_table_ecdt
*ecdt_ptr
;
1027 boot_ec
= make_acpi_ec();
1031 * Generate a boot ec context
1033 dmi_check_system(ec_dmi_table
);
1034 status
= acpi_get_table(ACPI_SIG_ECDT
, 1,
1035 (struct acpi_table_header
**)&ecdt_ptr
);
1036 if (ACPI_SUCCESS(status
)) {
1037 pr_info(PREFIX
"EC description table is found, configuring boot EC\n");
1038 boot_ec
->command_addr
= ecdt_ptr
->control
.address
;
1039 boot_ec
->data_addr
= ecdt_ptr
->data
.address
;
1040 boot_ec
->gpe
= ecdt_ptr
->gpe
;
1041 boot_ec
->handle
= ACPI_ROOT_OBJECT
;
1042 acpi_get_handle(ACPI_ROOT_OBJECT
, ecdt_ptr
->id
, &boot_ec
->handle
);
1043 /* Don't trust ECDT, which comes from ASUSTek */
1044 if (!EC_FLAGS_VALIDATE_ECDT
)
1046 saved_ec
= kmalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
1049 memcpy(saved_ec
, boot_ec
, sizeof(struct acpi_ec
));
1053 if (EC_FLAGS_SKIP_DSDT_SCAN
)
1056 /* This workaround is needed only on some broken machines,
1057 * which require early EC, but fail to provide ECDT */
1058 printk(KERN_DEBUG PREFIX
"Look up EC in DSDT\n");
1059 status
= acpi_get_devices(ec_device_ids
[0].id
, ec_parse_device
,
1061 /* Check that acpi_get_devices actually find something */
1062 if (ACPI_FAILURE(status
) || !boot_ec
->handle
)
1065 /* try to find good ECDT from ASUSTek */
1066 if (saved_ec
->command_addr
!= boot_ec
->command_addr
||
1067 saved_ec
->data_addr
!= boot_ec
->data_addr
||
1068 saved_ec
->gpe
!= boot_ec
->gpe
||
1069 saved_ec
->handle
!= boot_ec
->handle
)
1070 pr_info(PREFIX
"ASUSTek keeps feeding us with broken "
1071 "ECDT tables, which are very hard to workaround. "
1072 "Trying to use DSDT EC info instead. Please send "
1073 "output of acpidump to linux-acpi@vger.kernel.org\n");
1077 /* We really need to limit this workaround, the only ASUS,
1078 * which needs it, has fake EC._INI method, so use it as flag.
1079 * Keep boot_ec struct as it will be needed soon.
1082 if (!dmi_name_in_vendors("ASUS") ||
1083 ACPI_FAILURE(acpi_get_handle(boot_ec
->handle
, "_INI",
1088 if (!ec_install_handlers(boot_ec
)) {
1098 static int acpi_ec_suspend(struct acpi_device
*device
, pm_message_t state
)
1100 struct acpi_ec
*ec
= acpi_driver_data(device
);
1101 /* Stop using the GPE, but keep it reference counted. */
1102 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_DISABLE
);
1106 static int acpi_ec_resume(struct acpi_device
*device
)
1108 struct acpi_ec
*ec
= acpi_driver_data(device
);
1109 /* Enable the GPE again, but don't reference count it once more. */
1110 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_ENABLE
);
1114 static struct acpi_driver acpi_ec_driver
= {
1116 .class = ACPI_EC_CLASS
,
1117 .ids
= ec_device_ids
,
1120 .remove
= acpi_ec_remove
,
1121 .suspend
= acpi_ec_suspend
,
1122 .resume
= acpi_ec_resume
,
1126 int __init
acpi_ec_init(void)
1130 acpi_ec_dir
= proc_mkdir(ACPI_EC_CLASS
, acpi_root_dir
);
1134 /* Now register the driver for the EC */
1135 result
= acpi_bus_register_driver(&acpi_ec_driver
);
1137 remove_proc_entry(ACPI_EC_CLASS
, acpi_root_dir
);
1144 /* EC driver currently not unloadable */
1146 static void __exit
acpi_ec_exit(void)
1149 acpi_bus_unregister_driver(&acpi_ec_driver
);
1151 remove_proc_entry(ACPI_EC_CLASS
, acpi_root_dir
);