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>
46 #define ACPI_EC_CLASS "embedded_controller"
47 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
48 #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_UDELAY 100 /* Wait 100us before polling EC again */
72 #define ACPI_EC_STORM_THRESHOLD 8 /* number of false interrupts
73 per one transaction */
76 EC_FLAGS_QUERY_PENDING
, /* Query is pending */
77 EC_FLAGS_GPE_MODE
, /* Expect GPE to be sent
78 * for status change */
79 EC_FLAGS_NO_GPE
, /* Don't use GPE mode */
80 EC_FLAGS_GPE_STORM
, /* GPE storm detected */
81 EC_FLAGS_HANDLERS_INSTALLED
/* Handlers for GPE and
82 * OpReg are installed */
85 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
86 /* External interfaces use first EC only, so remember */
87 typedef int (*acpi_ec_query_func
) (void *data
);
89 struct acpi_ec_query_handler
{
90 struct list_head node
;
91 acpi_ec_query_func func
;
100 unsigned short irq_count
;
109 static struct acpi_ec
{
112 unsigned long command_addr
;
113 unsigned long data_addr
;
114 unsigned long global_lock
;
117 wait_queue_head_t wait
;
118 struct list_head list
;
119 struct transaction
*curr
;
120 spinlock_t curr_lock
;
121 } *boot_ec
, *first_ec
;
123 static int EC_FLAGS_MSI
; /* Out-of-spec MSI controller */
125 /* --------------------------------------------------------------------------
126 Transaction Management
127 -------------------------------------------------------------------------- */
129 static inline u8
acpi_ec_read_status(struct acpi_ec
*ec
)
131 u8 x
= inb(ec
->command_addr
);
132 pr_debug(PREFIX
"---> status = 0x%2.2x\n", x
);
136 static inline u8
acpi_ec_read_data(struct acpi_ec
*ec
)
138 u8 x
= inb(ec
->data_addr
);
139 pr_debug(PREFIX
"---> data = 0x%2.2x\n", x
);
143 static inline void acpi_ec_write_cmd(struct acpi_ec
*ec
, u8 command
)
145 pr_debug(PREFIX
"<--- command = 0x%2.2x\n", command
);
146 outb(command
, ec
->command_addr
);
149 static inline void acpi_ec_write_data(struct acpi_ec
*ec
, u8 data
)
151 pr_debug(PREFIX
"<--- data = 0x%2.2x\n", data
);
152 outb(data
, ec
->data_addr
);
155 static int ec_transaction_done(struct acpi_ec
*ec
)
159 spin_lock_irqsave(&ec
->curr_lock
, flags
);
160 if (!ec
->curr
|| ec
->curr
->done
)
162 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
166 static void start_transaction(struct acpi_ec
*ec
)
168 ec
->curr
->irq_count
= ec
->curr
->wi
= ec
->curr
->ri
= 0;
169 ec
->curr
->done
= false;
170 acpi_ec_write_cmd(ec
, ec
->curr
->command
);
173 static void gpe_transaction(struct acpi_ec
*ec
, u8 status
)
176 spin_lock_irqsave(&ec
->curr_lock
, flags
);
179 if (ec
->curr
->wlen
> ec
->curr
->wi
) {
180 if ((status
& ACPI_EC_FLAG_IBF
) == 0)
181 acpi_ec_write_data(ec
,
182 ec
->curr
->wdata
[ec
->curr
->wi
++]);
185 } else if (ec
->curr
->rlen
> ec
->curr
->ri
) {
186 if ((status
& ACPI_EC_FLAG_OBF
) == 1) {
187 ec
->curr
->rdata
[ec
->curr
->ri
++] = acpi_ec_read_data(ec
);
188 if (ec
->curr
->rlen
== ec
->curr
->ri
)
189 ec
->curr
->done
= true;
192 } else if (ec
->curr
->wlen
== ec
->curr
->wi
&&
193 (status
& ACPI_EC_FLAG_IBF
) == 0)
194 ec
->curr
->done
= true;
197 /* false interrupt, state didn't change */
199 ++ec
->curr
->irq_count
;
201 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
204 static int acpi_ec_wait(struct acpi_ec
*ec
)
206 if (wait_event_timeout(ec
->wait
, ec_transaction_done(ec
),
207 msecs_to_jiffies(ACPI_EC_DELAY
)))
209 /* try restart command if we get any false interrupts */
210 if (ec
->curr
->irq_count
&&
211 (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_IBF
) == 0) {
212 pr_debug(PREFIX
"controller reset, restart transaction\n");
213 start_transaction(ec
);
214 if (wait_event_timeout(ec
->wait
, ec_transaction_done(ec
),
215 msecs_to_jiffies(ACPI_EC_DELAY
)))
218 /* missing GPEs, switch back to poll mode */
219 if (printk_ratelimit())
220 pr_info(PREFIX
"missing confirmations, "
221 "switch off interrupt mode.\n");
222 set_bit(EC_FLAGS_NO_GPE
, &ec
->flags
);
223 clear_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
227 static void acpi_ec_gpe_query(void *ec_cxt
);
229 static int ec_check_sci(struct acpi_ec
*ec
, u8 state
)
231 if (state
& ACPI_EC_FLAG_SCI
) {
232 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
))
233 return acpi_os_execute(OSL_EC_BURST_HANDLER
,
234 acpi_ec_gpe_query
, ec
);
239 static int ec_poll(struct acpi_ec
*ec
)
241 unsigned long delay
= jiffies
+ msecs_to_jiffies(ACPI_EC_DELAY
);
242 udelay(ACPI_EC_UDELAY
);
243 while (time_before(jiffies
, delay
)) {
244 gpe_transaction(ec
, acpi_ec_read_status(ec
));
245 udelay(ACPI_EC_UDELAY
);
246 if (ec_transaction_done(ec
))
252 static int acpi_ec_transaction_unlocked(struct acpi_ec
*ec
,
253 struct transaction
*t
,
258 pr_debug(PREFIX
"transaction start\n");
259 /* disable GPE during transaction if storm is detected */
260 if (test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
261 clear_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
262 acpi_disable_gpe(NULL
, ec
->gpe
);
265 udelay(ACPI_EC_DELAY
);
266 /* start transaction */
267 spin_lock_irqsave(&ec
->curr_lock
, tmp
);
268 /* following two actions should be kept atomic */
270 start_transaction(ec
);
271 if (ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
)
272 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
273 spin_unlock_irqrestore(&ec
->curr_lock
, tmp
);
274 /* if we selected poll mode or failed in GPE-mode do a poll loop */
276 !test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) ||
279 pr_debug(PREFIX
"transaction end\n");
280 spin_lock_irqsave(&ec
->curr_lock
, tmp
);
282 spin_unlock_irqrestore(&ec
->curr_lock
, tmp
);
283 if (test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
284 /* check if we received SCI during transaction */
285 ec_check_sci(ec
, acpi_ec_read_status(ec
));
286 /* it is safe to enable GPE outside of transaction */
287 acpi_enable_gpe(NULL
, ec
->gpe
);
288 } else if (test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) &&
289 t
->irq_count
> ACPI_EC_STORM_THRESHOLD
) {
290 pr_info(PREFIX
"GPE storm detected, "
291 "transactions will use polling mode\n");
292 set_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
);
297 static int ec_check_ibf0(struct acpi_ec
*ec
)
299 u8 status
= acpi_ec_read_status(ec
);
300 return (status
& ACPI_EC_FLAG_IBF
) == 0;
303 static int ec_wait_ibf0(struct acpi_ec
*ec
)
305 unsigned long delay
= jiffies
+ msecs_to_jiffies(ACPI_EC_DELAY
);
306 /* interrupt wait manually if GPE mode is not active */
307 unsigned long timeout
= test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) ?
308 msecs_to_jiffies(ACPI_EC_DELAY
) : msecs_to_jiffies(1);
309 while (time_before(jiffies
, delay
))
310 if (wait_event_timeout(ec
->wait
, ec_check_ibf0(ec
), timeout
))
315 static int acpi_ec_transaction(struct acpi_ec
*ec
, struct transaction
*t
,
320 if (!ec
|| (!t
) || (t
->wlen
&& !t
->wdata
) || (t
->rlen
&& !t
->rdata
))
323 memset(t
->rdata
, 0, t
->rlen
);
324 mutex_lock(&ec
->lock
);
325 if (ec
->global_lock
) {
326 status
= acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK
, &glk
);
327 if (ACPI_FAILURE(status
)) {
332 if (ec_wait_ibf0(ec
)) {
333 pr_err(PREFIX
"input buffer is not empty, "
334 "aborting transaction\n");
338 status
= acpi_ec_transaction_unlocked(ec
, t
, force_poll
);
341 acpi_release_global_lock(glk
);
343 mutex_unlock(&ec
->lock
);
348 * Note: samsung nv5000 doesn't work with ec burst mode.
349 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
351 static int acpi_ec_burst_enable(struct acpi_ec
*ec
)
354 struct transaction t
= {.command
= ACPI_EC_BURST_ENABLE
,
355 .wdata
= NULL
, .rdata
= &d
,
356 .wlen
= 0, .rlen
= 1};
358 return acpi_ec_transaction(ec
, &t
, 0);
361 static int acpi_ec_burst_disable(struct acpi_ec
*ec
)
363 struct transaction t
= {.command
= ACPI_EC_BURST_DISABLE
,
364 .wdata
= NULL
, .rdata
= NULL
,
365 .wlen
= 0, .rlen
= 0};
367 return (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_BURST
) ?
368 acpi_ec_transaction(ec
, &t
, 0) : 0;
371 static int acpi_ec_read(struct acpi_ec
*ec
, u8 address
, u8
* data
)
375 struct transaction t
= {.command
= ACPI_EC_COMMAND_READ
,
376 .wdata
= &address
, .rdata
= &d
,
377 .wlen
= 1, .rlen
= 1};
379 result
= acpi_ec_transaction(ec
, &t
, 0);
384 static int acpi_ec_write(struct acpi_ec
*ec
, u8 address
, u8 data
)
386 u8 wdata
[2] = { address
, data
};
387 struct transaction t
= {.command
= ACPI_EC_COMMAND_WRITE
,
388 .wdata
= wdata
, .rdata
= NULL
,
389 .wlen
= 2, .rlen
= 0};
391 return acpi_ec_transaction(ec
, &t
, 0);
395 * Externally callable EC access functions. For now, assume 1 EC only
397 int ec_burst_enable(void)
401 return acpi_ec_burst_enable(first_ec
);
404 EXPORT_SYMBOL(ec_burst_enable
);
406 int ec_burst_disable(void)
410 return acpi_ec_burst_disable(first_ec
);
413 EXPORT_SYMBOL(ec_burst_disable
);
415 int ec_read(u8 addr
, u8
* val
)
423 err
= acpi_ec_read(first_ec
, addr
, &temp_data
);
432 EXPORT_SYMBOL(ec_read
);
434 int ec_write(u8 addr
, u8 val
)
441 err
= acpi_ec_write(first_ec
, addr
, val
);
446 EXPORT_SYMBOL(ec_write
);
448 int ec_transaction(u8 command
,
449 const u8
* wdata
, unsigned wdata_len
,
450 u8
* rdata
, unsigned rdata_len
,
453 struct transaction t
= {.command
= command
,
454 .wdata
= wdata
, .rdata
= rdata
,
455 .wlen
= wdata_len
, .rlen
= rdata_len
};
459 return acpi_ec_transaction(first_ec
, &t
, force_poll
);
462 EXPORT_SYMBOL(ec_transaction
);
464 static int acpi_ec_query(struct acpi_ec
*ec
, u8
* data
)
468 struct transaction t
= {.command
= ACPI_EC_COMMAND_QUERY
,
469 .wdata
= NULL
, .rdata
= &d
,
470 .wlen
= 0, .rlen
= 1};
475 * Query the EC to find out which _Qxx method we need to evaluate.
476 * Note that successful completion of the query causes the ACPI_EC_SCI
477 * bit to be cleared (and thus clearing the interrupt source).
480 result
= acpi_ec_transaction(ec
, &t
, 0);
491 /* --------------------------------------------------------------------------
493 -------------------------------------------------------------------------- */
494 int acpi_ec_add_query_handler(struct acpi_ec
*ec
, u8 query_bit
,
495 acpi_handle handle
, acpi_ec_query_func func
,
498 struct acpi_ec_query_handler
*handler
=
499 kzalloc(sizeof(struct acpi_ec_query_handler
), GFP_KERNEL
);
503 handler
->query_bit
= query_bit
;
504 handler
->handle
= handle
;
505 handler
->func
= func
;
506 handler
->data
= data
;
507 mutex_lock(&ec
->lock
);
508 list_add(&handler
->node
, &ec
->list
);
509 mutex_unlock(&ec
->lock
);
513 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler
);
515 void acpi_ec_remove_query_handler(struct acpi_ec
*ec
, u8 query_bit
)
517 struct acpi_ec_query_handler
*handler
, *tmp
;
518 mutex_lock(&ec
->lock
);
519 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
520 if (query_bit
== handler
->query_bit
) {
521 list_del(&handler
->node
);
525 mutex_unlock(&ec
->lock
);
528 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler
);
530 static void acpi_ec_gpe_query(void *ec_cxt
)
532 struct acpi_ec
*ec
= ec_cxt
;
534 struct acpi_ec_query_handler
*handler
, copy
;
536 if (!ec
|| acpi_ec_query(ec
, &value
))
538 mutex_lock(&ec
->lock
);
539 list_for_each_entry(handler
, &ec
->list
, node
) {
540 if (value
== handler
->query_bit
) {
541 /* have custom handler for this bit */
542 memcpy(©
, handler
, sizeof(copy
));
543 mutex_unlock(&ec
->lock
);
545 copy
.func(copy
.data
);
546 } else if (copy
.handle
) {
547 acpi_evaluate_object(copy
.handle
, NULL
, NULL
, NULL
);
552 mutex_unlock(&ec
->lock
);
555 static u32
acpi_ec_gpe_handler(void *data
)
557 struct acpi_ec
*ec
= data
;
560 pr_debug(PREFIX
"~~~> interrupt\n");
561 status
= acpi_ec_read_status(ec
);
563 if (test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
)) {
564 gpe_transaction(ec
, status
);
565 if (ec_transaction_done(ec
) &&
566 (status
& ACPI_EC_FLAG_IBF
) == 0)
570 ec_check_sci(ec
, status
);
571 if (!test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) &&
572 !test_bit(EC_FLAGS_NO_GPE
, &ec
->flags
)) {
573 /* this is non-query, must be confirmation */
574 if (!test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
575 if (printk_ratelimit())
576 pr_info(PREFIX
"non-query interrupt received,"
577 " switching to interrupt mode\n");
579 /* hush, STORM switches the mode every transaction */
580 pr_debug(PREFIX
"non-query interrupt received,"
581 " switching to interrupt mode\n");
583 set_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
585 return ACPI_INTERRUPT_HANDLED
;
588 /* --------------------------------------------------------------------------
589 Address Space Management
590 -------------------------------------------------------------------------- */
593 acpi_ec_space_handler(u32 function
, acpi_physical_address address
,
594 u32 bits
, acpi_integer
*value
,
595 void *handler_context
, void *region_context
)
597 struct acpi_ec
*ec
= handler_context
;
601 if ((address
> 0xFF) || !value
|| !handler_context
)
602 return AE_BAD_PARAMETER
;
604 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
605 return AE_BAD_PARAMETER
;
607 if (bits
!= 8 && acpi_strict
)
608 return AE_BAD_PARAMETER
;
610 acpi_ec_burst_enable(ec
);
612 if (function
== ACPI_READ
) {
613 result
= acpi_ec_read(ec
, address
, &temp
);
616 temp
= 0xff & (*value
);
617 result
= acpi_ec_write(ec
, address
, temp
);
620 for (i
= 8; unlikely(bits
- i
> 0); i
+= 8) {
622 if (function
== ACPI_READ
) {
623 result
= acpi_ec_read(ec
, address
, &temp
);
624 (*value
) |= ((acpi_integer
)temp
) << i
;
626 temp
= 0xff & ((*value
) >> i
);
627 result
= acpi_ec_write(ec
, address
, temp
);
631 acpi_ec_burst_disable(ec
);
635 return AE_BAD_PARAMETER
;
648 /* --------------------------------------------------------------------------
650 -------------------------------------------------------------------------- */
652 static struct proc_dir_entry
*acpi_ec_dir
;
654 static int acpi_ec_read_info(struct seq_file
*seq
, void *offset
)
656 struct acpi_ec
*ec
= seq
->private;
661 seq_printf(seq
, "gpe:\t\t\t0x%02x\n", (u32
) ec
->gpe
);
662 seq_printf(seq
, "ports:\t\t\t0x%02x, 0x%02x\n",
663 (unsigned)ec
->command_addr
, (unsigned)ec
->data_addr
);
664 seq_printf(seq
, "use global lock:\t%s\n",
665 ec
->global_lock
? "yes" : "no");
670 static int acpi_ec_info_open_fs(struct inode
*inode
, struct file
*file
)
672 return single_open(file
, acpi_ec_read_info
, PDE(inode
)->data
);
675 static struct file_operations acpi_ec_info_ops
= {
676 .open
= acpi_ec_info_open_fs
,
679 .release
= single_release
,
680 .owner
= THIS_MODULE
,
683 static int acpi_ec_add_fs(struct acpi_device
*device
)
685 struct proc_dir_entry
*entry
= NULL
;
687 if (!acpi_device_dir(device
)) {
688 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
690 if (!acpi_device_dir(device
))
694 entry
= proc_create_data(ACPI_EC_FILE_INFO
, S_IRUGO
,
695 acpi_device_dir(device
),
696 &acpi_ec_info_ops
, acpi_driver_data(device
));
702 static int acpi_ec_remove_fs(struct acpi_device
*device
)
705 if (acpi_device_dir(device
)) {
706 remove_proc_entry(ACPI_EC_FILE_INFO
, acpi_device_dir(device
));
707 remove_proc_entry(acpi_device_bid(device
), acpi_ec_dir
);
708 acpi_device_dir(device
) = NULL
;
714 /* --------------------------------------------------------------------------
716 -------------------------------------------------------------------------- */
718 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
);
720 static struct acpi_ec
*make_acpi_ec(void)
722 struct acpi_ec
*ec
= kzalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
725 ec
->flags
= 1 << EC_FLAGS_QUERY_PENDING
;
726 mutex_init(&ec
->lock
);
727 init_waitqueue_head(&ec
->wait
);
728 INIT_LIST_HEAD(&ec
->list
);
729 spin_lock_init(&ec
->curr_lock
);
734 acpi_ec_register_query_methods(acpi_handle handle
, u32 level
,
735 void *context
, void **return_value
)
738 struct acpi_buffer buffer
= { sizeof(node_name
), node_name
};
739 struct acpi_ec
*ec
= context
;
743 status
= acpi_get_name(handle
, ACPI_SINGLE_NAME
, &buffer
);
745 if (ACPI_SUCCESS(status
) && sscanf(node_name
, "_Q%x", &value
) == 1) {
746 acpi_ec_add_query_handler(ec
, value
, handle
, NULL
, NULL
);
752 ec_parse_device(acpi_handle handle
, u32 Level
, void *context
, void **retval
)
755 unsigned long long tmp
= 0;
757 struct acpi_ec
*ec
= context
;
758 status
= acpi_walk_resources(handle
, METHOD_NAME__CRS
,
759 ec_parse_io_ports
, ec
);
760 if (ACPI_FAILURE(status
))
763 /* Get GPE bit assignment (EC events). */
764 /* TODO: Add support for _GPE returning a package */
765 status
= acpi_evaluate_integer(handle
, "_GPE", NULL
, &tmp
);
766 if (ACPI_FAILURE(status
))
769 /* Use the global lock for all EC transactions? */
771 acpi_evaluate_integer(handle
, "_GLK", NULL
, &tmp
);
772 ec
->global_lock
= tmp
;
774 return AE_CTRL_TERMINATE
;
777 static void ec_remove_handlers(struct acpi_ec
*ec
)
779 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec
->handle
,
780 ACPI_ADR_SPACE_EC
, &acpi_ec_space_handler
)))
781 pr_err(PREFIX
"failed to remove space handler\n");
782 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL
, ec
->gpe
,
783 &acpi_ec_gpe_handler
)))
784 pr_err(PREFIX
"failed to remove gpe handler\n");
785 clear_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
788 static int acpi_ec_add(struct acpi_device
*device
)
790 struct acpi_ec
*ec
= NULL
;
794 strcpy(acpi_device_name(device
), ACPI_EC_DEVICE_NAME
);
795 strcpy(acpi_device_class(device
), ACPI_EC_CLASS
);
797 /* Check for boot EC */
799 (boot_ec
->handle
== device
->handle
||
800 boot_ec
->handle
== ACPI_ROOT_OBJECT
)) {
807 if (ec_parse_device(device
->handle
, 0, ec
, NULL
) !=
814 ec
->handle
= device
->handle
;
816 /* Find and register all query methods */
817 acpi_walk_namespace(ACPI_TYPE_METHOD
, ec
->handle
, 1,
818 acpi_ec_register_query_methods
, ec
, NULL
);
822 device
->driver_data
= ec
;
823 acpi_ec_add_fs(device
);
824 pr_info(PREFIX
"GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
825 ec
->gpe
, ec
->command_addr
, ec
->data_addr
);
826 pr_info(PREFIX
"driver started in %s mode\n",
827 (test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
))?"interrupt":"poll");
831 static int acpi_ec_remove(struct acpi_device
*device
, int type
)
834 struct acpi_ec_query_handler
*handler
, *tmp
;
839 ec
= acpi_driver_data(device
);
840 mutex_lock(&ec
->lock
);
841 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
842 list_del(&handler
->node
);
845 mutex_unlock(&ec
->lock
);
846 acpi_ec_remove_fs(device
);
847 device
->driver_data
= NULL
;
855 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
)
857 struct acpi_ec
*ec
= context
;
859 if (resource
->type
!= ACPI_RESOURCE_TYPE_IO
)
863 * The first address region returned is the data port, and
864 * the second address region returned is the status/command
867 if (ec
->data_addr
== 0)
868 ec
->data_addr
= resource
->data
.io
.minimum
;
869 else if (ec
->command_addr
== 0)
870 ec
->command_addr
= resource
->data
.io
.minimum
;
872 return AE_CTRL_TERMINATE
;
877 static int ec_install_handlers(struct acpi_ec
*ec
)
880 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
))
882 status
= acpi_install_gpe_handler(NULL
, ec
->gpe
,
883 ACPI_GPE_EDGE_TRIGGERED
,
884 &acpi_ec_gpe_handler
, ec
);
885 if (ACPI_FAILURE(status
))
887 acpi_set_gpe_type(NULL
, ec
->gpe
, ACPI_GPE_TYPE_RUNTIME
);
888 acpi_enable_gpe(NULL
, ec
->gpe
);
889 status
= acpi_install_address_space_handler(ec
->handle
,
891 &acpi_ec_space_handler
,
893 if (ACPI_FAILURE(status
)) {
894 if (status
== AE_NOT_FOUND
) {
896 * Maybe OS fails in evaluating the _REG object.
897 * The AE_NOT_FOUND error will be ignored and OS
898 * continue to initialize EC.
900 printk(KERN_ERR
"Fail in evaluating the _REG object"
901 " of EC device. Broken bios is suspected.\n");
903 acpi_remove_gpe_handler(NULL
, ec
->gpe
,
904 &acpi_ec_gpe_handler
);
909 set_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
913 static int acpi_ec_start(struct acpi_device
*device
)
921 ec
= acpi_driver_data(device
);
926 ret
= ec_install_handlers(ec
);
928 /* EC is fully operational, allow queries */
929 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
933 static int acpi_ec_stop(struct acpi_device
*device
, int type
)
938 ec
= acpi_driver_data(device
);
941 ec_remove_handlers(ec
);
946 int __init
acpi_boot_ec_enable(void)
948 if (!boot_ec
|| test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &boot_ec
->flags
))
950 if (!ec_install_handlers(boot_ec
)) {
957 static const struct acpi_device_id ec_device_ids
[] = {
962 int __init
acpi_ec_ecdt_probe(void)
965 struct acpi_ec
*saved_ec
= NULL
;
966 struct acpi_table_ecdt
*ecdt_ptr
;
968 boot_ec
= make_acpi_ec();
972 * Generate a boot ec context
974 if (dmi_name_in_vendors("Micro-Star") ||
975 dmi_name_in_vendors("Notebook")) {
976 pr_info(PREFIX
"Enabling special treatment for EC from MSI.\n");
979 status
= acpi_get_table(ACPI_SIG_ECDT
, 1,
980 (struct acpi_table_header
**)&ecdt_ptr
);
981 if (ACPI_SUCCESS(status
)) {
982 pr_info(PREFIX
"EC description table is found, configuring boot EC\n");
983 boot_ec
->command_addr
= ecdt_ptr
->control
.address
;
984 boot_ec
->data_addr
= ecdt_ptr
->data
.address
;
985 boot_ec
->gpe
= ecdt_ptr
->gpe
;
986 boot_ec
->handle
= ACPI_ROOT_OBJECT
;
987 acpi_get_handle(ACPI_ROOT_OBJECT
, ecdt_ptr
->id
, &boot_ec
->handle
);
988 /* Don't trust ECDT, which comes from ASUSTek */
989 if (!dmi_name_in_vendors("ASUS"))
991 saved_ec
= kmalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
994 memcpy(saved_ec
, boot_ec
, sizeof(*saved_ec
));
997 /* This workaround is needed only on some broken machines,
998 * which require early EC, but fail to provide ECDT */
999 printk(KERN_DEBUG PREFIX
"Look up EC in DSDT\n");
1000 status
= acpi_get_devices(ec_device_ids
[0].id
, ec_parse_device
,
1002 /* Check that acpi_get_devices actually find something */
1003 if (ACPI_FAILURE(status
) || !boot_ec
->handle
)
1006 /* try to find good ECDT from ASUSTek */
1007 if (saved_ec
->command_addr
!= boot_ec
->command_addr
||
1008 saved_ec
->data_addr
!= boot_ec
->data_addr
||
1009 saved_ec
->gpe
!= boot_ec
->gpe
||
1010 saved_ec
->handle
!= boot_ec
->handle
)
1011 pr_info(PREFIX
"ASUSTek keeps feeding us with broken "
1012 "ECDT tables, which are very hard to workaround. "
1013 "Trying to use DSDT EC info instead. Please send "
1014 "output of acpidump to linux-acpi@vger.kernel.org\n");
1018 /* We really need to limit this workaround, the only ASUS,
1019 * which needs it, has fake EC._INI method, so use it as flag.
1020 * Keep boot_ec struct as it will be needed soon.
1023 if (!dmi_name_in_vendors("ASUS") ||
1024 ACPI_FAILURE(acpi_get_handle(boot_ec
->handle
, "_INI",
1029 if (!ec_install_handlers(boot_ec
)) {
1039 static int acpi_ec_suspend(struct acpi_device
*device
, pm_message_t state
)
1041 struct acpi_ec
*ec
= acpi_driver_data(device
);
1042 /* Stop using GPE */
1043 set_bit(EC_FLAGS_NO_GPE
, &ec
->flags
);
1044 clear_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
1045 acpi_disable_gpe(NULL
, ec
->gpe
);
1049 static int acpi_ec_resume(struct acpi_device
*device
)
1051 struct acpi_ec
*ec
= acpi_driver_data(device
);
1052 /* Enable use of GPE back */
1053 clear_bit(EC_FLAGS_NO_GPE
, &ec
->flags
);
1054 acpi_enable_gpe(NULL
, ec
->gpe
);
1058 static struct acpi_driver acpi_ec_driver
= {
1060 .class = ACPI_EC_CLASS
,
1061 .ids
= ec_device_ids
,
1064 .remove
= acpi_ec_remove
,
1065 .start
= acpi_ec_start
,
1066 .stop
= acpi_ec_stop
,
1067 .suspend
= acpi_ec_suspend
,
1068 .resume
= acpi_ec_resume
,
1072 static int __init
acpi_ec_init(void)
1079 acpi_ec_dir
= proc_mkdir(ACPI_EC_CLASS
, acpi_root_dir
);
1083 /* Now register the driver for the EC */
1084 result
= acpi_bus_register_driver(&acpi_ec_driver
);
1086 remove_proc_entry(ACPI_EC_CLASS
, acpi_root_dir
);
1093 subsys_initcall(acpi_ec_init
);
1095 /* EC driver currently not unloadable */
1097 static void __exit
acpi_ec_exit(void)
1100 acpi_bus_unregister_driver(&acpi_ec_driver
);
1102 remove_proc_entry(ACPI_EC_CLASS
, acpi_root_dir
);