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 <acpi/actypes.h>
47 #define ACPI_EC_CLASS "embedded_controller"
48 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
49 #define ACPI_EC_FILE_INFO "info"
52 #define PREFIX "ACPI: EC: "
54 /* EC status register */
55 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
56 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
57 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
58 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
62 ACPI_EC_COMMAND_READ
= 0x80,
63 ACPI_EC_COMMAND_WRITE
= 0x81,
64 ACPI_EC_BURST_ENABLE
= 0x82,
65 ACPI_EC_BURST_DISABLE
= 0x83,
66 ACPI_EC_COMMAND_QUERY
= 0x84,
69 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
70 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
71 #define ACPI_EC_UDELAY 100 /* Wait 100us before polling EC again */
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_MODE
, /* Expect GPE to be sent
79 * for status change */
80 EC_FLAGS_NO_GPE
, /* Don't use GPE mode */
81 EC_FLAGS_GPE_STORM
, /* GPE storm detected */
82 EC_FLAGS_HANDLERS_INSTALLED
/* Handlers for GPE and
83 * OpReg are installed */
86 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
87 /* External interfaces use first EC only, so remember */
88 typedef int (*acpi_ec_query_func
) (void *data
);
90 struct acpi_ec_query_handler
{
91 struct list_head node
;
92 acpi_ec_query_func func
;
101 unsigned short irq_count
;
110 static struct acpi_ec
{
113 unsigned long command_addr
;
114 unsigned long data_addr
;
115 unsigned long global_lock
;
118 wait_queue_head_t wait
;
119 struct list_head list
;
120 struct transaction
*curr
;
121 spinlock_t curr_lock
;
122 } *boot_ec
, *first_ec
;
125 * Some Asus system have exchanged ECDT data/command IO addresses.
127 static int print_ecdt_error(const struct dmi_system_id
*id
)
129 printk(KERN_NOTICE PREFIX
"%s detected - "
130 "ECDT has exchanged control/data I/O address\n",
135 static struct dmi_system_id __cpuinitdata ec_dmi_table
[] = {
137 print_ecdt_error
, "Asus L4R", {
138 DMI_MATCH(DMI_BIOS_VERSION
, "1008.006"),
139 DMI_MATCH(DMI_PRODUCT_NAME
, "L4R"),
140 DMI_MATCH(DMI_BOARD_NAME
, "L4R") }, NULL
},
142 print_ecdt_error
, "Asus M6R", {
143 DMI_MATCH(DMI_BIOS_VERSION
, "0207"),
144 DMI_MATCH(DMI_PRODUCT_NAME
, "M6R"),
145 DMI_MATCH(DMI_BOARD_NAME
, "M6R") }, NULL
},
149 /* --------------------------------------------------------------------------
150 Transaction Management
151 -------------------------------------------------------------------------- */
153 static inline u8
acpi_ec_read_status(struct acpi_ec
*ec
)
155 u8 x
= inb(ec
->command_addr
);
156 pr_debug(PREFIX
"---> status = 0x%2.2x\n", x
);
160 static inline u8
acpi_ec_read_data(struct acpi_ec
*ec
)
162 u8 x
= inb(ec
->data_addr
);
163 pr_debug(PREFIX
"---> data = 0x%2.2x\n", x
);
167 static inline void acpi_ec_write_cmd(struct acpi_ec
*ec
, u8 command
)
169 pr_debug(PREFIX
"<--- command = 0x%2.2x\n", command
);
170 outb(command
, ec
->command_addr
);
173 static inline void acpi_ec_write_data(struct acpi_ec
*ec
, u8 data
)
175 pr_debug(PREFIX
"<--- data = 0x%2.2x\n", data
);
176 outb(data
, ec
->data_addr
);
179 static int ec_transaction_done(struct acpi_ec
*ec
)
183 spin_lock_irqsave(&ec
->curr_lock
, flags
);
184 if (!ec
->curr
|| ec
->curr
->done
)
186 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
190 static void start_transaction(struct acpi_ec
*ec
)
192 ec
->curr
->irq_count
= ec
->curr
->wi
= ec
->curr
->ri
= 0;
193 ec
->curr
->done
= false;
194 acpi_ec_write_cmd(ec
, ec
->curr
->command
);
197 static void gpe_transaction(struct acpi_ec
*ec
, u8 status
)
200 spin_lock_irqsave(&ec
->curr_lock
, flags
);
203 if (ec
->curr
->wlen
> ec
->curr
->wi
) {
204 if ((status
& ACPI_EC_FLAG_IBF
) == 0)
205 acpi_ec_write_data(ec
,
206 ec
->curr
->wdata
[ec
->curr
->wi
++]);
209 } else if (ec
->curr
->rlen
> ec
->curr
->ri
) {
210 if ((status
& ACPI_EC_FLAG_OBF
) == 1) {
211 ec
->curr
->rdata
[ec
->curr
->ri
++] = acpi_ec_read_data(ec
);
212 if (ec
->curr
->rlen
== ec
->curr
->ri
)
213 ec
->curr
->done
= true;
216 } else if (ec
->curr
->wlen
== ec
->curr
->wi
&&
217 (status
& ACPI_EC_FLAG_IBF
) == 0)
218 ec
->curr
->done
= true;
221 /* false interrupt, state didn't change */
223 ++ec
->curr
->irq_count
;
225 spin_unlock_irqrestore(&ec
->curr_lock
, flags
);
228 static int acpi_ec_wait(struct acpi_ec
*ec
)
230 if (wait_event_timeout(ec
->wait
, ec_transaction_done(ec
),
231 msecs_to_jiffies(ACPI_EC_DELAY
)))
233 /* try restart command if we get any false interrupts */
234 if (ec
->curr
->irq_count
&&
235 (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_IBF
) == 0) {
236 pr_debug(PREFIX
"controller reset, restart transaction\n");
237 start_transaction(ec
);
238 if (wait_event_timeout(ec
->wait
, ec_transaction_done(ec
),
239 msecs_to_jiffies(ACPI_EC_DELAY
)))
242 /* missing GPEs, switch back to poll mode */
243 if (printk_ratelimit())
244 pr_info(PREFIX
"missing confirmations, "
245 "switch off interrupt mode.\n");
246 set_bit(EC_FLAGS_NO_GPE
, &ec
->flags
);
247 clear_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
251 static void acpi_ec_gpe_query(void *ec_cxt
);
253 static int ec_check_sci(struct acpi_ec
*ec
, u8 state
)
255 if (state
& ACPI_EC_FLAG_SCI
) {
256 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
))
257 return acpi_os_execute(OSL_EC_BURST_HANDLER
,
258 acpi_ec_gpe_query
, ec
);
263 static int ec_poll(struct acpi_ec
*ec
)
265 unsigned long delay
= jiffies
+ msecs_to_jiffies(ACPI_EC_DELAY
);
266 udelay(ACPI_EC_UDELAY
);
267 while (time_before(jiffies
, delay
)) {
268 gpe_transaction(ec
, acpi_ec_read_status(ec
));
269 udelay(ACPI_EC_UDELAY
);
270 if (ec_transaction_done(ec
))
276 static int acpi_ec_transaction_unlocked(struct acpi_ec
*ec
,
277 struct transaction
*t
,
282 pr_debug(PREFIX
"transaction start\n");
283 /* disable GPE during transaction if storm is detected */
284 if (test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
285 clear_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
286 acpi_disable_gpe(NULL
, ec
->gpe
, ACPI_NOT_ISR
);
288 /* start transaction */
289 spin_lock_irqsave(&ec
->curr_lock
, tmp
);
290 /* following two actions should be kept atomic */
292 start_transaction(ec
);
293 if (ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
)
294 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
295 spin_unlock_irqrestore(&ec
->curr_lock
, tmp
);
296 /* if we selected poll mode or failed in GPE-mode do a poll loop */
298 !test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) ||
301 pr_debug(PREFIX
"transaction end\n");
302 spin_lock_irqsave(&ec
->curr_lock
, tmp
);
304 spin_unlock_irqrestore(&ec
->curr_lock
, tmp
);
305 if (test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
306 /* check if we received SCI during transaction */
307 ec_check_sci(ec
, acpi_ec_read_status(ec
));
308 /* it is safe to enable GPE outside of transaction */
309 acpi_enable_gpe(NULL
, ec
->gpe
, ACPI_NOT_ISR
);
310 } else if (test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) &&
311 t
->irq_count
> ACPI_EC_STORM_THRESHOLD
) {
312 pr_info(PREFIX
"GPE storm detected, "
313 "transactions will use polling mode\n");
314 set_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
);
319 static int ec_check_ibf0(struct acpi_ec
*ec
)
321 u8 status
= acpi_ec_read_status(ec
);
322 return (status
& ACPI_EC_FLAG_IBF
) == 0;
325 static int ec_wait_ibf0(struct acpi_ec
*ec
)
327 unsigned long delay
= jiffies
+ msecs_to_jiffies(ACPI_EC_DELAY
);
328 /* interrupt wait manually if GPE mode is not active */
329 unsigned long timeout
= test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) ?
330 msecs_to_jiffies(ACPI_EC_DELAY
) : msecs_to_jiffies(1);
331 while (time_before(jiffies
, delay
))
332 if (wait_event_timeout(ec
->wait
, ec_check_ibf0(ec
), timeout
))
337 static int acpi_ec_transaction(struct acpi_ec
*ec
, struct transaction
*t
,
342 if (!ec
|| (!t
) || (t
->wlen
&& !t
->wdata
) || (t
->rlen
&& !t
->rdata
))
345 memset(t
->rdata
, 0, t
->rlen
);
346 mutex_lock(&ec
->lock
);
347 if (ec
->global_lock
) {
348 status
= acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK
, &glk
);
349 if (ACPI_FAILURE(status
)) {
354 if (ec_wait_ibf0(ec
)) {
355 pr_err(PREFIX
"input buffer is not empty, "
356 "aborting transaction\n");
360 status
= acpi_ec_transaction_unlocked(ec
, t
, force_poll
);
363 acpi_release_global_lock(glk
);
365 mutex_unlock(&ec
->lock
);
370 * Note: samsung nv5000 doesn't work with ec burst mode.
371 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
373 int acpi_ec_burst_enable(struct acpi_ec
*ec
)
376 struct transaction t
= {.command
= ACPI_EC_BURST_ENABLE
,
377 .wdata
= NULL
, .rdata
= &d
,
378 .wlen
= 0, .rlen
= 1};
380 return acpi_ec_transaction(ec
, &t
, 0);
383 int acpi_ec_burst_disable(struct acpi_ec
*ec
)
385 struct transaction t
= {.command
= ACPI_EC_BURST_DISABLE
,
386 .wdata
= NULL
, .rdata
= NULL
,
387 .wlen
= 0, .rlen
= 0};
389 return (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_BURST
) ?
390 acpi_ec_transaction(ec
, &t
, 0) : 0;
393 static int acpi_ec_read(struct acpi_ec
*ec
, u8 address
, u8
* data
)
397 struct transaction t
= {.command
= ACPI_EC_COMMAND_READ
,
398 .wdata
= &address
, .rdata
= &d
,
399 .wlen
= 1, .rlen
= 1};
401 result
= acpi_ec_transaction(ec
, &t
, 0);
406 static int acpi_ec_write(struct acpi_ec
*ec
, u8 address
, u8 data
)
408 u8 wdata
[2] = { address
, data
};
409 struct transaction t
= {.command
= ACPI_EC_COMMAND_WRITE
,
410 .wdata
= wdata
, .rdata
= NULL
,
411 .wlen
= 2, .rlen
= 0};
413 return acpi_ec_transaction(ec
, &t
, 0);
417 * Externally callable EC access functions. For now, assume 1 EC only
419 int ec_burst_enable(void)
423 return acpi_ec_burst_enable(first_ec
);
426 EXPORT_SYMBOL(ec_burst_enable
);
428 int ec_burst_disable(void)
432 return acpi_ec_burst_disable(first_ec
);
435 EXPORT_SYMBOL(ec_burst_disable
);
437 int ec_read(u8 addr
, u8
* val
)
445 err
= acpi_ec_read(first_ec
, addr
, &temp_data
);
454 EXPORT_SYMBOL(ec_read
);
456 int ec_write(u8 addr
, u8 val
)
463 err
= acpi_ec_write(first_ec
, addr
, val
);
468 EXPORT_SYMBOL(ec_write
);
470 int ec_transaction(u8 command
,
471 const u8
* wdata
, unsigned wdata_len
,
472 u8
* rdata
, unsigned rdata_len
,
475 struct transaction t
= {.command
= command
,
476 .wdata
= wdata
, .rdata
= rdata
,
477 .wlen
= wdata_len
, .rlen
= rdata_len
};
481 return acpi_ec_transaction(first_ec
, &t
, force_poll
);
484 EXPORT_SYMBOL(ec_transaction
);
486 static int acpi_ec_query(struct acpi_ec
*ec
, u8
* data
)
490 struct transaction t
= {.command
= ACPI_EC_COMMAND_QUERY
,
491 .wdata
= NULL
, .rdata
= &d
,
492 .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).
502 result
= acpi_ec_transaction(ec
, &t
, 0);
513 /* --------------------------------------------------------------------------
515 -------------------------------------------------------------------------- */
516 int acpi_ec_add_query_handler(struct acpi_ec
*ec
, u8 query_bit
,
517 acpi_handle handle
, acpi_ec_query_func func
,
520 struct acpi_ec_query_handler
*handler
=
521 kzalloc(sizeof(struct acpi_ec_query_handler
), GFP_KERNEL
);
525 handler
->query_bit
= query_bit
;
526 handler
->handle
= handle
;
527 handler
->func
= func
;
528 handler
->data
= data
;
529 mutex_lock(&ec
->lock
);
530 list_add(&handler
->node
, &ec
->list
);
531 mutex_unlock(&ec
->lock
);
535 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler
);
537 void acpi_ec_remove_query_handler(struct acpi_ec
*ec
, u8 query_bit
)
539 struct acpi_ec_query_handler
*handler
, *tmp
;
540 mutex_lock(&ec
->lock
);
541 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
542 if (query_bit
== handler
->query_bit
) {
543 list_del(&handler
->node
);
547 mutex_unlock(&ec
->lock
);
550 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler
);
552 static void acpi_ec_gpe_query(void *ec_cxt
)
554 struct acpi_ec
*ec
= ec_cxt
;
556 struct acpi_ec_query_handler
*handler
, copy
;
558 if (!ec
|| acpi_ec_query(ec
, &value
))
560 mutex_lock(&ec
->lock
);
561 list_for_each_entry(handler
, &ec
->list
, node
) {
562 if (value
== handler
->query_bit
) {
563 /* have custom handler for this bit */
564 memcpy(©
, handler
, sizeof(copy
));
565 mutex_unlock(&ec
->lock
);
567 copy
.func(copy
.data
);
568 } else if (copy
.handle
) {
569 acpi_evaluate_object(copy
.handle
, NULL
, NULL
, NULL
);
574 mutex_unlock(&ec
->lock
);
577 static u32
acpi_ec_gpe_handler(void *data
)
579 struct acpi_ec
*ec
= data
;
582 pr_debug(PREFIX
"~~~> interrupt\n");
583 status
= acpi_ec_read_status(ec
);
585 if (test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
)) {
586 gpe_transaction(ec
, status
);
587 if (ec_transaction_done(ec
) &&
588 (status
& ACPI_EC_FLAG_IBF
) == 0)
592 ec_check_sci(ec
, status
);
593 if (!test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
) &&
594 !test_bit(EC_FLAGS_NO_GPE
, &ec
->flags
)) {
595 /* this is non-query, must be confirmation */
596 if (!test_bit(EC_FLAGS_GPE_STORM
, &ec
->flags
)) {
597 if (printk_ratelimit())
598 pr_info(PREFIX
"non-query interrupt received,"
599 " switching to interrupt mode\n");
601 /* hush, STORM switches the mode every transaction */
602 pr_debug(PREFIX
"non-query interrupt received,"
603 " switching to interrupt mode\n");
605 set_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
607 return ACPI_INTERRUPT_HANDLED
;
610 /* --------------------------------------------------------------------------
611 Address Space Management
612 -------------------------------------------------------------------------- */
615 acpi_ec_space_handler(u32 function
, acpi_physical_address address
,
616 u32 bits
, acpi_integer
*value
,
617 void *handler_context
, void *region_context
)
619 struct acpi_ec
*ec
= handler_context
;
623 if ((address
> 0xFF) || !value
|| !handler_context
)
624 return AE_BAD_PARAMETER
;
626 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
627 return AE_BAD_PARAMETER
;
629 if (bits
!= 8 && acpi_strict
)
630 return AE_BAD_PARAMETER
;
632 acpi_ec_burst_enable(ec
);
634 if (function
== ACPI_READ
) {
635 result
= acpi_ec_read(ec
, address
, &temp
);
638 temp
= 0xff & (*value
);
639 result
= acpi_ec_write(ec
, address
, temp
);
642 for (i
= 8; unlikely(bits
- i
> 0); i
+= 8) {
644 if (function
== ACPI_READ
) {
645 result
= acpi_ec_read(ec
, address
, &temp
);
646 (*value
) |= ((acpi_integer
)temp
) << i
;
648 temp
= 0xff & ((*value
) >> i
);
649 result
= acpi_ec_write(ec
, address
, temp
);
653 acpi_ec_burst_disable(ec
);
657 return AE_BAD_PARAMETER
;
670 /* --------------------------------------------------------------------------
672 -------------------------------------------------------------------------- */
674 static struct proc_dir_entry
*acpi_ec_dir
;
676 static int acpi_ec_read_info(struct seq_file
*seq
, void *offset
)
678 struct acpi_ec
*ec
= seq
->private;
683 seq_printf(seq
, "gpe:\t\t\t0x%02x\n", (u32
) ec
->gpe
);
684 seq_printf(seq
, "ports:\t\t\t0x%02x, 0x%02x\n",
685 (unsigned)ec
->command_addr
, (unsigned)ec
->data_addr
);
686 seq_printf(seq
, "use global lock:\t%s\n",
687 ec
->global_lock
? "yes" : "no");
692 static int acpi_ec_info_open_fs(struct inode
*inode
, struct file
*file
)
694 return single_open(file
, acpi_ec_read_info
, PDE(inode
)->data
);
697 static struct file_operations acpi_ec_info_ops
= {
698 .open
= acpi_ec_info_open_fs
,
701 .release
= single_release
,
702 .owner
= THIS_MODULE
,
705 static int acpi_ec_add_fs(struct acpi_device
*device
)
707 struct proc_dir_entry
*entry
= NULL
;
709 if (!acpi_device_dir(device
)) {
710 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
712 if (!acpi_device_dir(device
))
716 entry
= proc_create_data(ACPI_EC_FILE_INFO
, S_IRUGO
,
717 acpi_device_dir(device
),
718 &acpi_ec_info_ops
, acpi_driver_data(device
));
724 static int acpi_ec_remove_fs(struct acpi_device
*device
)
727 if (acpi_device_dir(device
)) {
728 remove_proc_entry(ACPI_EC_FILE_INFO
, acpi_device_dir(device
));
729 remove_proc_entry(acpi_device_bid(device
), acpi_ec_dir
);
730 acpi_device_dir(device
) = NULL
;
736 /* --------------------------------------------------------------------------
738 -------------------------------------------------------------------------- */
740 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
);
742 static struct acpi_ec
*make_acpi_ec(void)
744 struct acpi_ec
*ec
= kzalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
747 ec
->flags
= 1 << EC_FLAGS_QUERY_PENDING
;
748 mutex_init(&ec
->lock
);
749 init_waitqueue_head(&ec
->wait
);
750 INIT_LIST_HEAD(&ec
->list
);
751 spin_lock_init(&ec
->curr_lock
);
756 acpi_ec_register_query_methods(acpi_handle handle
, u32 level
,
757 void *context
, void **return_value
)
759 struct acpi_namespace_node
*node
= handle
;
760 struct acpi_ec
*ec
= context
;
763 if (sscanf(node
->name
.ascii
, "_Q%2x", &value
) == 1)
764 acpi_ec_add_query_handler(ec
, value
, handle
, NULL
, NULL
);
770 ec_parse_device(acpi_handle handle
, u32 Level
, void *context
, void **retval
)
773 unsigned long long tmp
= 0;
775 struct acpi_ec
*ec
= context
;
776 status
= acpi_walk_resources(handle
, METHOD_NAME__CRS
,
777 ec_parse_io_ports
, ec
);
778 if (ACPI_FAILURE(status
))
781 /* Get GPE bit assignment (EC events). */
782 /* TODO: Add support for _GPE returning a package */
783 status
= acpi_evaluate_integer(handle
, "_GPE", NULL
, &tmp
);
784 if (ACPI_FAILURE(status
))
787 /* Use the global lock for all EC transactions? */
789 acpi_evaluate_integer(handle
, "_GLK", NULL
, &tmp
);
790 ec
->global_lock
= tmp
;
792 return AE_CTRL_TERMINATE
;
795 static void ec_remove_handlers(struct acpi_ec
*ec
)
797 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec
->handle
,
798 ACPI_ADR_SPACE_EC
, &acpi_ec_space_handler
)))
799 pr_err(PREFIX
"failed to remove space handler\n");
800 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL
, ec
->gpe
,
801 &acpi_ec_gpe_handler
)))
802 pr_err(PREFIX
"failed to remove gpe handler\n");
803 clear_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
806 static int acpi_ec_add(struct acpi_device
*device
)
808 struct acpi_ec
*ec
= NULL
;
812 strcpy(acpi_device_name(device
), ACPI_EC_DEVICE_NAME
);
813 strcpy(acpi_device_class(device
), ACPI_EC_CLASS
);
815 /* Check for boot EC */
817 (boot_ec
->handle
== device
->handle
||
818 boot_ec
->handle
== ACPI_ROOT_OBJECT
)) {
825 if (ec_parse_device(device
->handle
, 0, ec
, NULL
) !=
832 ec
->handle
= device
->handle
;
834 /* Find and register all query methods */
835 acpi_walk_namespace(ACPI_TYPE_METHOD
, ec
->handle
, 1,
836 acpi_ec_register_query_methods
, ec
, NULL
);
840 acpi_driver_data(device
) = ec
;
841 acpi_ec_add_fs(device
);
842 pr_info(PREFIX
"GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
843 ec
->gpe
, ec
->command_addr
, ec
->data_addr
);
844 pr_info(PREFIX
"driver started in %s mode\n",
845 (test_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
))?"interrupt":"poll");
849 static int acpi_ec_remove(struct acpi_device
*device
, int type
)
852 struct acpi_ec_query_handler
*handler
, *tmp
;
857 ec
= acpi_driver_data(device
);
858 mutex_lock(&ec
->lock
);
859 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
860 list_del(&handler
->node
);
863 mutex_unlock(&ec
->lock
);
864 acpi_ec_remove_fs(device
);
865 acpi_driver_data(device
) = NULL
;
873 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
)
875 struct acpi_ec
*ec
= context
;
877 if (resource
->type
!= ACPI_RESOURCE_TYPE_IO
)
881 * The first address region returned is the data port, and
882 * the second address region returned is the status/command
885 if (ec
->data_addr
== 0)
886 ec
->data_addr
= resource
->data
.io
.minimum
;
887 else if (ec
->command_addr
== 0)
888 ec
->command_addr
= resource
->data
.io
.minimum
;
890 return AE_CTRL_TERMINATE
;
895 static int ec_install_handlers(struct acpi_ec
*ec
)
898 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
))
900 status
= acpi_install_gpe_handler(NULL
, ec
->gpe
,
901 ACPI_GPE_EDGE_TRIGGERED
,
902 &acpi_ec_gpe_handler
, ec
);
903 if (ACPI_FAILURE(status
))
905 acpi_set_gpe_type(NULL
, ec
->gpe
, ACPI_GPE_TYPE_RUNTIME
);
906 acpi_enable_gpe(NULL
, ec
->gpe
, ACPI_NOT_ISR
);
907 status
= acpi_install_address_space_handler(ec
->handle
,
909 &acpi_ec_space_handler
,
911 if (ACPI_FAILURE(status
)) {
912 acpi_remove_gpe_handler(NULL
, ec
->gpe
, &acpi_ec_gpe_handler
);
916 set_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
920 static int acpi_ec_start(struct acpi_device
*device
)
928 ec
= acpi_driver_data(device
);
933 ret
= ec_install_handlers(ec
);
935 /* EC is fully operational, allow queries */
936 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
940 static int acpi_ec_stop(struct acpi_device
*device
, int type
)
945 ec
= acpi_driver_data(device
);
948 ec_remove_handlers(ec
);
953 int __init
acpi_boot_ec_enable(void)
955 if (!boot_ec
|| test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &boot_ec
->flags
))
957 if (!ec_install_handlers(boot_ec
)) {
964 static const struct acpi_device_id ec_device_ids
[] = {
969 int __init
acpi_ec_ecdt_probe(void)
972 struct acpi_table_ecdt
*ecdt_ptr
;
975 boot_ec
= make_acpi_ec();
979 * Generate a boot ec context
981 status
= acpi_get_table(ACPI_SIG_ECDT
, 1,
982 (struct acpi_table_header
**)&ecdt_ptr
);
983 if (ACPI_SUCCESS(status
)) {
984 pr_info(PREFIX
"EC description table is found, configuring boot EC\n");
985 boot_ec
->command_addr
= ecdt_ptr
->control
.address
;
986 boot_ec
->data_addr
= ecdt_ptr
->data
.address
;
987 if (dmi_check_system(ec_dmi_table
)) {
989 * If the board falls into ec_dmi_table, it means
990 * that ECDT table gives the incorrect command/status
991 * & data I/O address. Just fix it.
993 boot_ec
->data_addr
= ecdt_ptr
->control
.address
;
994 boot_ec
->command_addr
= ecdt_ptr
->data
.address
;
996 boot_ec
->gpe
= ecdt_ptr
->gpe
;
997 boot_ec
->handle
= ACPI_ROOT_OBJECT
;
998 acpi_get_handle(ACPI_ROOT_OBJECT
, ecdt_ptr
->id
, &boot_ec
->handle
);
999 /* Add some basic check against completely broken table */
1000 if (boot_ec
->data_addr
!= boot_ec
->command_addr
)
1004 /* This workaround is needed only on some broken machines,
1005 * which require early EC, but fail to provide ECDT */
1006 printk(KERN_DEBUG PREFIX
"Look up EC in DSDT\n");
1007 status
= acpi_get_devices(ec_device_ids
[0].id
, ec_parse_device
,
1009 /* Check that acpi_get_devices actually find something */
1010 if (ACPI_FAILURE(status
) || !boot_ec
->handle
)
1012 /* We really need to limit this workaround, the only ASUS,
1013 * which needs it, has fake EC._INI method, so use it as flag.
1014 * Keep boot_ec struct as it will be needed soon.
1016 if (!dmi_name_in_vendors("ASUS") ||
1017 ACPI_FAILURE(acpi_get_handle(boot_ec
->handle
, "_INI", &dummy
)))
1020 if (!ec_install_handlers(boot_ec
)) {
1030 static int acpi_ec_suspend(struct acpi_device
*device
, pm_message_t state
)
1032 struct acpi_ec
*ec
= acpi_driver_data(device
);
1033 /* Stop using GPE */
1034 set_bit(EC_FLAGS_NO_GPE
, &ec
->flags
);
1035 clear_bit(EC_FLAGS_GPE_MODE
, &ec
->flags
);
1036 acpi_disable_gpe(NULL
, ec
->gpe
, ACPI_NOT_ISR
);
1040 static int acpi_ec_resume(struct acpi_device
*device
)
1042 struct acpi_ec
*ec
= acpi_driver_data(device
);
1043 /* Enable use of GPE back */
1044 clear_bit(EC_FLAGS_NO_GPE
, &ec
->flags
);
1045 acpi_enable_gpe(NULL
, ec
->gpe
, ACPI_NOT_ISR
);
1049 static struct acpi_driver acpi_ec_driver
= {
1051 .class = ACPI_EC_CLASS
,
1052 .ids
= ec_device_ids
,
1055 .remove
= acpi_ec_remove
,
1056 .start
= acpi_ec_start
,
1057 .stop
= acpi_ec_stop
,
1058 .suspend
= acpi_ec_suspend
,
1059 .resume
= acpi_ec_resume
,
1063 static int __init
acpi_ec_init(void)
1070 acpi_ec_dir
= proc_mkdir(ACPI_EC_CLASS
, acpi_root_dir
);
1074 /* Now register the driver for the EC */
1075 result
= acpi_bus_register_driver(&acpi_ec_driver
);
1077 remove_proc_entry(ACPI_EC_CLASS
, acpi_root_dir
);
1084 subsys_initcall(acpi_ec_init
);
1086 /* EC driver currently not unloadable */
1088 static void __exit
acpi_ec_exit(void)
1091 acpi_bus_unregister_driver(&acpi_ec_driver
);
1093 remove_proc_entry(ACPI_EC_CLASS
, acpi_root_dir
);