2 * ec.c - ACPI Embedded Controller Driver (v3)
4 * Copyright (C) 2001-2015 Intel Corporation
5 * Author: 2014, 2015 Lv Zheng <lv.zheng@intel.com>
6 * 2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
7 * 2006 Denis Sadykov <denis.m.sadykov@intel.com>
8 * 2004 Luming Yu <luming.yu@intel.com>
9 * 2001, 2002 Andy Grover <andrew.grover@intel.com>
10 * 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
11 * Copyright (C) 2008 Alexey Starikovskiy <astarikovskiy@suse.de>
13 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or (at
18 * your option) any later version.
20 * This program is distributed in the hope that it will be useful, but
21 * WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * General Public License for more details.
25 * You should have received a copy of the GNU General Public License along
26 * with this program; if not, write to the Free Software Foundation, Inc.,
27 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
29 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 /* Uncomment next line to get verbose printout */
34 #define pr_fmt(fmt) "ACPI : EC: " fmt
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/init.h>
39 #include <linux/types.h>
40 #include <linux/delay.h>
41 #include <linux/interrupt.h>
42 #include <linux/list.h>
43 #include <linux/spinlock.h>
44 #include <linux/slab.h>
45 #include <linux/acpi.h>
46 #include <linux/dmi.h>
51 #define ACPI_EC_CLASS "embedded_controller"
52 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
53 #define ACPI_EC_FILE_INFO "info"
55 /* EC status register */
56 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
57 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
58 #define ACPI_EC_FLAG_CMD 0x08 /* Input buffer contains a command */
59 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
60 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
63 * The SCI_EVT clearing timing is not defined by the ACPI specification.
64 * This leads to lots of practical timing issues for the host EC driver.
65 * The following variations are defined (from the target EC firmware's
67 * STATUS: After indicating SCI_EVT edge triggered IRQ to the host, the
68 * target can clear SCI_EVT at any time so long as the host can see
69 * the indication by reading the status register (EC_SC). So the
70 * host should re-check SCI_EVT after the first time the SCI_EVT
71 * indication is seen, which is the same time the query request
72 * (QR_EC) is written to the command register (EC_CMD). SCI_EVT set
73 * at any later time could indicate another event. Normally such
74 * kind of EC firmware has implemented an event queue and will
75 * return 0x00 to indicate "no outstanding event".
76 * QUERY: After seeing the query request (QR_EC) written to the command
77 * register (EC_CMD) by the host and having prepared the responding
78 * event value in the data register (EC_DATA), the target can safely
79 * clear SCI_EVT because the target can confirm that the current
80 * event is being handled by the host. The host then should check
81 * SCI_EVT right after reading the event response from the data
83 * EVENT: After seeing the event response read from the data register
84 * (EC_DATA) by the host, the target can clear SCI_EVT. As the
85 * target requires time to notice the change in the data register
86 * (EC_DATA), the host may be required to wait additional guarding
87 * time before checking the SCI_EVT again. Such guarding may not be
88 * necessary if the host is notified via another IRQ.
90 #define ACPI_EC_EVT_TIMING_STATUS 0x00
91 #define ACPI_EC_EVT_TIMING_QUERY 0x01
92 #define ACPI_EC_EVT_TIMING_EVENT 0x02
96 ACPI_EC_COMMAND_READ
= 0x80,
97 ACPI_EC_COMMAND_WRITE
= 0x81,
98 ACPI_EC_BURST_ENABLE
= 0x82,
99 ACPI_EC_BURST_DISABLE
= 0x83,
100 ACPI_EC_COMMAND_QUERY
= 0x84,
103 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
104 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
105 #define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */
106 #define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
107 * when trying to clear the EC */
110 EC_FLAGS_QUERY_PENDING
, /* Query is pending */
111 EC_FLAGS_QUERY_GUARDING
, /* Guard for SCI_EVT check */
112 EC_FLAGS_HANDLERS_INSTALLED
, /* Handlers for GPE and
113 * OpReg are installed */
114 EC_FLAGS_STARTED
, /* Driver is started */
115 EC_FLAGS_STOPPED
, /* Driver is stopped */
116 EC_FLAGS_COMMAND_STORM
, /* GPE storms occurred to the
117 * current command processing */
120 #define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
121 #define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
123 /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
124 static unsigned int ec_delay __read_mostly
= ACPI_EC_DELAY
;
125 module_param(ec_delay
, uint
, 0644);
126 MODULE_PARM_DESC(ec_delay
, "Timeout(ms) waited until an EC command completes");
128 static bool ec_busy_polling __read_mostly
;
129 module_param(ec_busy_polling
, bool, 0644);
130 MODULE_PARM_DESC(ec_busy_polling
, "Use busy polling to advance EC transaction");
132 static unsigned int ec_polling_guard __read_mostly
= ACPI_EC_UDELAY_POLL
;
133 module_param(ec_polling_guard
, uint
, 0644);
134 MODULE_PARM_DESC(ec_polling_guard
, "Guard time(us) between EC accesses in polling modes");
136 static unsigned int ec_event_clearing __read_mostly
= ACPI_EC_EVT_TIMING_QUERY
;
139 * If the number of false interrupts per one transaction exceeds
140 * this threshold, will think there is a GPE storm happened and
141 * will disable the GPE for normal transaction.
143 static unsigned int ec_storm_threshold __read_mostly
= 8;
144 module_param(ec_storm_threshold
, uint
, 0644);
145 MODULE_PARM_DESC(ec_storm_threshold
, "Maxim false GPE numbers not considered as GPE storm");
147 struct acpi_ec_query_handler
{
148 struct list_head node
;
149 acpi_ec_query_func func
;
159 unsigned short irq_count
;
168 static int acpi_ec_query(struct acpi_ec
*ec
, u8
*data
);
169 static void advance_transaction(struct acpi_ec
*ec
);
171 struct acpi_ec
*boot_ec
, *first_ec
;
172 EXPORT_SYMBOL(first_ec
);
174 static int EC_FLAGS_VALIDATE_ECDT
; /* ASUStec ECDTs need to be validated */
175 static int EC_FLAGS_SKIP_DSDT_SCAN
; /* Not all BIOS survive early DSDT scan */
176 static int EC_FLAGS_CLEAR_ON_RESUME
; /* Needs acpi_ec_clear() on boot/resume */
177 static int EC_FLAGS_QUERY_HANDSHAKE
; /* Needs QR_EC issued when SCI_EVT set */
179 /* --------------------------------------------------------------------------
181 * -------------------------------------------------------------------------- */
184 * Splitters used by the developers to track the boundary of the EC
185 * handling processes.
188 #define EC_DBG_SEP " "
189 #define EC_DBG_DRV "+++++"
190 #define EC_DBG_STM "====="
191 #define EC_DBG_REQ "*****"
192 #define EC_DBG_EVT "#####"
194 #define EC_DBG_SEP ""
201 #define ec_log_raw(fmt, ...) \
202 pr_info(fmt "\n", ##__VA_ARGS__)
203 #define ec_dbg_raw(fmt, ...) \
204 pr_debug(fmt "\n", ##__VA_ARGS__)
205 #define ec_log(filter, fmt, ...) \
206 ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
207 #define ec_dbg(filter, fmt, ...) \
208 ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
210 #define ec_log_drv(fmt, ...) \
211 ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__)
212 #define ec_dbg_drv(fmt, ...) \
213 ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__)
214 #define ec_dbg_stm(fmt, ...) \
215 ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__)
216 #define ec_dbg_req(fmt, ...) \
217 ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__)
218 #define ec_dbg_evt(fmt, ...) \
219 ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__)
220 #define ec_dbg_ref(ec, fmt, ...) \
221 ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
223 /* --------------------------------------------------------------------------
225 * -------------------------------------------------------------------------- */
227 static bool acpi_ec_started(struct acpi_ec
*ec
)
229 return test_bit(EC_FLAGS_STARTED
, &ec
->flags
) &&
230 !test_bit(EC_FLAGS_STOPPED
, &ec
->flags
);
233 static bool acpi_ec_flushed(struct acpi_ec
*ec
)
235 return ec
->reference_count
== 1;
238 /* --------------------------------------------------------------------------
240 * -------------------------------------------------------------------------- */
242 static inline u8
acpi_ec_read_status(struct acpi_ec
*ec
)
244 u8 x
= inb(ec
->command_addr
);
246 ec_dbg_raw("EC_SC(R) = 0x%2.2x "
247 "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d",
249 !!(x
& ACPI_EC_FLAG_SCI
),
250 !!(x
& ACPI_EC_FLAG_BURST
),
251 !!(x
& ACPI_EC_FLAG_CMD
),
252 !!(x
& ACPI_EC_FLAG_IBF
),
253 !!(x
& ACPI_EC_FLAG_OBF
));
257 static inline u8
acpi_ec_read_data(struct acpi_ec
*ec
)
259 u8 x
= inb(ec
->data_addr
);
261 ec
->timestamp
= jiffies
;
262 ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x
);
266 static inline void acpi_ec_write_cmd(struct acpi_ec
*ec
, u8 command
)
268 ec_dbg_raw("EC_SC(W) = 0x%2.2x", command
);
269 outb(command
, ec
->command_addr
);
270 ec
->timestamp
= jiffies
;
273 static inline void acpi_ec_write_data(struct acpi_ec
*ec
, u8 data
)
275 ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data
);
276 outb(data
, ec
->data_addr
);
277 ec
->timestamp
= jiffies
;
281 static const char *acpi_ec_cmd_string(u8 cmd
)
298 #define acpi_ec_cmd_string(cmd) "UNDEF"
301 /* --------------------------------------------------------------------------
303 * -------------------------------------------------------------------------- */
305 static inline bool acpi_ec_is_gpe_raised(struct acpi_ec
*ec
)
307 acpi_event_status gpe_status
= 0;
309 (void)acpi_get_gpe_status(NULL
, ec
->gpe
, &gpe_status
);
310 return (gpe_status
& ACPI_EVENT_FLAG_STATUS_SET
) ? true : false;
313 static inline void acpi_ec_enable_gpe(struct acpi_ec
*ec
, bool open
)
316 acpi_enable_gpe(NULL
, ec
->gpe
);
318 BUG_ON(ec
->reference_count
< 1);
319 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_ENABLE
);
321 if (acpi_ec_is_gpe_raised(ec
)) {
323 * On some platforms, EN=1 writes cannot trigger GPE. So
324 * software need to manually trigger a pseudo GPE event on
327 ec_dbg_raw("Polling quirk");
328 advance_transaction(ec
);
332 static inline void acpi_ec_disable_gpe(struct acpi_ec
*ec
, bool close
)
335 acpi_disable_gpe(NULL
, ec
->gpe
);
337 BUG_ON(ec
->reference_count
< 1);
338 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_DISABLE
);
342 static inline void acpi_ec_clear_gpe(struct acpi_ec
*ec
)
345 * GPE STS is a W1C register, which means:
346 * 1. Software can clear it without worrying about clearing other
347 * GPEs' STS bits when the hardware sets them in parallel.
348 * 2. As long as software can ensure only clearing it when it is
349 * set, hardware won't set it in parallel.
350 * So software can clear GPE in any contexts.
351 * Warning: do not move the check into advance_transaction() as the
352 * EC commands will be sent without GPE raised.
354 if (!acpi_ec_is_gpe_raised(ec
))
356 acpi_clear_gpe(NULL
, ec
->gpe
);
359 /* --------------------------------------------------------------------------
360 * Transaction Management
361 * -------------------------------------------------------------------------- */
363 static void acpi_ec_submit_request(struct acpi_ec
*ec
)
365 ec
->reference_count
++;
366 if (ec
->reference_count
== 1)
367 acpi_ec_enable_gpe(ec
, true);
370 static void acpi_ec_complete_request(struct acpi_ec
*ec
)
372 bool flushed
= false;
374 ec
->reference_count
--;
375 if (ec
->reference_count
== 0)
376 acpi_ec_disable_gpe(ec
, true);
377 flushed
= acpi_ec_flushed(ec
);
382 static void acpi_ec_set_storm(struct acpi_ec
*ec
, u8 flag
)
384 if (!test_bit(flag
, &ec
->flags
)) {
385 acpi_ec_disable_gpe(ec
, false);
386 ec_dbg_drv("Polling enabled");
387 set_bit(flag
, &ec
->flags
);
391 static void acpi_ec_clear_storm(struct acpi_ec
*ec
, u8 flag
)
393 if (test_bit(flag
, &ec
->flags
)) {
394 clear_bit(flag
, &ec
->flags
);
395 acpi_ec_enable_gpe(ec
, false);
396 ec_dbg_drv("Polling disabled");
401 * acpi_ec_submit_flushable_request() - Increase the reference count unless
402 * the flush operation is not in
406 * This function must be used before taking a new action that should hold
407 * the reference count. If this function returns false, then the action
408 * must be discarded or it will prevent the flush operation from being
411 static bool acpi_ec_submit_flushable_request(struct acpi_ec
*ec
)
413 if (!acpi_ec_started(ec
))
415 acpi_ec_submit_request(ec
);
419 static void acpi_ec_submit_query(struct acpi_ec
*ec
)
421 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
)) {
422 ec_dbg_evt("Command(%s) submitted/blocked",
423 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
424 ec
->nr_pending_queries
++;
425 schedule_work(&ec
->work
);
429 static void acpi_ec_complete_query(struct acpi_ec
*ec
)
431 if (test_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
)) {
432 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
433 ec_dbg_evt("Command(%s) unblocked",
434 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
438 static bool acpi_ec_guard_event(struct acpi_ec
*ec
)
440 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_STATUS
||
441 ec_event_clearing
== ACPI_EC_EVT_TIMING_QUERY
||
442 !test_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
) ||
443 (ec
->curr
&& ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
))
447 * Postpone the query submission to allow the firmware to proceed,
448 * we shouldn't check SCI_EVT before the firmware reflagging it.
453 static int ec_transaction_polled(struct acpi_ec
*ec
)
458 spin_lock_irqsave(&ec
->lock
, flags
);
459 if (ec
->curr
&& (ec
->curr
->flags
& ACPI_EC_COMMAND_POLL
))
461 spin_unlock_irqrestore(&ec
->lock
, flags
);
465 static int ec_transaction_completed(struct acpi_ec
*ec
)
470 spin_lock_irqsave(&ec
->lock
, flags
);
471 if (ec
->curr
&& (ec
->curr
->flags
& ACPI_EC_COMMAND_COMPLETE
))
473 spin_unlock_irqrestore(&ec
->lock
, flags
);
477 static inline void ec_transaction_transition(struct acpi_ec
*ec
, unsigned long flag
)
479 ec
->curr
->flags
|= flag
;
480 if (ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
) {
481 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_STATUS
&&
482 flag
== ACPI_EC_COMMAND_POLL
)
483 acpi_ec_complete_query(ec
);
484 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_QUERY
&&
485 flag
== ACPI_EC_COMMAND_COMPLETE
)
486 acpi_ec_complete_query(ec
);
487 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_EVENT
&&
488 flag
== ACPI_EC_COMMAND_COMPLETE
)
489 set_bit(EC_FLAGS_QUERY_GUARDING
, &ec
->flags
);
493 static void advance_transaction(struct acpi_ec
*ec
)
495 struct transaction
*t
;
499 ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK",
502 * By always clearing STS before handling all indications, we can
503 * ensure a hardware STS 0->1 change after this clearing can always
504 * trigger a GPE interrupt.
506 acpi_ec_clear_gpe(ec
);
507 status
= acpi_ec_read_status(ec
);
510 * Another IRQ or a guarded polling mode advancement is detected,
511 * the next QR_EC submission is then allowed.
513 if (!t
|| !(t
->flags
& ACPI_EC_COMMAND_POLL
)) {
514 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_EVENT
&&
515 (!ec
->nr_pending_queries
||
516 test_bit(EC_FLAGS_QUERY_GUARDING
, &ec
->flags
))) {
517 clear_bit(EC_FLAGS_QUERY_GUARDING
, &ec
->flags
);
518 acpi_ec_complete_query(ec
);
523 if (t
->flags
& ACPI_EC_COMMAND_POLL
) {
524 if (t
->wlen
> t
->wi
) {
525 if ((status
& ACPI_EC_FLAG_IBF
) == 0)
526 acpi_ec_write_data(ec
, t
->wdata
[t
->wi
++]);
529 } else if (t
->rlen
> t
->ri
) {
530 if ((status
& ACPI_EC_FLAG_OBF
) == 1) {
531 t
->rdata
[t
->ri
++] = acpi_ec_read_data(ec
);
532 if (t
->rlen
== t
->ri
) {
533 ec_transaction_transition(ec
, ACPI_EC_COMMAND_COMPLETE
);
534 if (t
->command
== ACPI_EC_COMMAND_QUERY
)
535 ec_dbg_evt("Command(%s) completed by hardware",
536 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
541 } else if (t
->wlen
== t
->wi
&&
542 (status
& ACPI_EC_FLAG_IBF
) == 0) {
543 ec_transaction_transition(ec
, ACPI_EC_COMMAND_COMPLETE
);
548 if (EC_FLAGS_QUERY_HANDSHAKE
&&
549 !(status
& ACPI_EC_FLAG_SCI
) &&
550 (t
->command
== ACPI_EC_COMMAND_QUERY
)) {
551 ec_transaction_transition(ec
, ACPI_EC_COMMAND_POLL
);
552 t
->rdata
[t
->ri
++] = 0x00;
553 ec_transaction_transition(ec
, ACPI_EC_COMMAND_COMPLETE
);
554 ec_dbg_evt("Command(%s) completed by software",
555 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
557 } else if ((status
& ACPI_EC_FLAG_IBF
) == 0) {
558 acpi_ec_write_cmd(ec
, t
->command
);
559 ec_transaction_transition(ec
, ACPI_EC_COMMAND_POLL
);
566 * If SCI bit is set, then don't think it's a false IRQ
567 * otherwise will take a not handled IRQ as a false one.
569 if (!(status
& ACPI_EC_FLAG_SCI
)) {
570 if (in_interrupt() && t
) {
571 if (t
->irq_count
< ec_storm_threshold
)
573 /* Allow triggering on 0 threshold */
574 if (t
->irq_count
== ec_storm_threshold
)
575 acpi_ec_set_storm(ec
, EC_FLAGS_COMMAND_STORM
);
579 if (status
& ACPI_EC_FLAG_SCI
)
580 acpi_ec_submit_query(ec
);
581 if (wakeup
&& in_interrupt())
585 static void start_transaction(struct acpi_ec
*ec
)
587 ec
->curr
->irq_count
= ec
->curr
->wi
= ec
->curr
->ri
= 0;
591 static int ec_guard(struct acpi_ec
*ec
)
593 unsigned long guard
= usecs_to_jiffies(ec_polling_guard
);
594 unsigned long timeout
= ec
->timestamp
+ guard
;
597 if (ec_busy_polling
) {
598 /* Perform busy polling */
599 if (ec_transaction_completed(ec
))
601 udelay(jiffies_to_usecs(guard
));
604 * Perform wait polling
606 * For SCI_EVT clearing timing of "event",
607 * performing guarding before re-checking the
608 * SCI_EVT. Otherwise, such guarding is not needed
609 * due to the old practices.
611 if (!ec_transaction_polled(ec
) &&
612 !acpi_ec_guard_event(ec
))
614 if (wait_event_timeout(ec
->wait
,
615 ec_transaction_completed(ec
),
619 /* Guard the register accesses for the polling modes */
620 } while (time_before(jiffies
, timeout
));
624 static int ec_poll(struct acpi_ec
*ec
)
627 int repeat
= 5; /* number of command restarts */
630 unsigned long delay
= jiffies
+
631 msecs_to_jiffies(ec_delay
);
635 spin_lock_irqsave(&ec
->lock
, flags
);
636 advance_transaction(ec
);
637 spin_unlock_irqrestore(&ec
->lock
, flags
);
638 } while (time_before(jiffies
, delay
));
639 pr_debug("controller reset, restart transaction\n");
640 spin_lock_irqsave(&ec
->lock
, flags
);
641 start_transaction(ec
);
642 spin_unlock_irqrestore(&ec
->lock
, flags
);
647 static int acpi_ec_transaction_unlocked(struct acpi_ec
*ec
,
648 struct transaction
*t
)
653 /* start transaction */
654 spin_lock_irqsave(&ec
->lock
, tmp
);
655 /* Enable GPE for command processing (IBF=0/OBF=1) */
656 if (!acpi_ec_submit_flushable_request(ec
)) {
660 ec_dbg_ref(ec
, "Increase command");
661 /* following two actions should be kept atomic */
663 ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t
->command
));
664 start_transaction(ec
);
665 spin_unlock_irqrestore(&ec
->lock
, tmp
);
669 spin_lock_irqsave(&ec
->lock
, tmp
);
670 if (t
->irq_count
== ec_storm_threshold
)
671 acpi_ec_clear_storm(ec
, EC_FLAGS_COMMAND_STORM
);
672 ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t
->command
));
674 /* Disable GPE for command processing (IBF=0/OBF=1) */
675 acpi_ec_complete_request(ec
);
676 ec_dbg_ref(ec
, "Decrease command");
678 spin_unlock_irqrestore(&ec
->lock
, tmp
);
682 static int acpi_ec_transaction(struct acpi_ec
*ec
, struct transaction
*t
)
687 if (!ec
|| (!t
) || (t
->wlen
&& !t
->wdata
) || (t
->rlen
&& !t
->rdata
))
690 memset(t
->rdata
, 0, t
->rlen
);
692 mutex_lock(&ec
->mutex
);
693 if (ec
->global_lock
) {
694 status
= acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK
, &glk
);
695 if (ACPI_FAILURE(status
)) {
701 status
= acpi_ec_transaction_unlocked(ec
, t
);
704 acpi_release_global_lock(glk
);
706 mutex_unlock(&ec
->mutex
);
710 static int acpi_ec_burst_enable(struct acpi_ec
*ec
)
713 struct transaction t
= {.command
= ACPI_EC_BURST_ENABLE
,
714 .wdata
= NULL
, .rdata
= &d
,
715 .wlen
= 0, .rlen
= 1};
717 return acpi_ec_transaction(ec
, &t
);
720 static int acpi_ec_burst_disable(struct acpi_ec
*ec
)
722 struct transaction t
= {.command
= ACPI_EC_BURST_DISABLE
,
723 .wdata
= NULL
, .rdata
= NULL
,
724 .wlen
= 0, .rlen
= 0};
726 return (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_BURST
) ?
727 acpi_ec_transaction(ec
, &t
) : 0;
730 static int acpi_ec_read(struct acpi_ec
*ec
, u8 address
, u8
*data
)
734 struct transaction t
= {.command
= ACPI_EC_COMMAND_READ
,
735 .wdata
= &address
, .rdata
= &d
,
736 .wlen
= 1, .rlen
= 1};
738 result
= acpi_ec_transaction(ec
, &t
);
743 static int acpi_ec_write(struct acpi_ec
*ec
, u8 address
, u8 data
)
745 u8 wdata
[2] = { address
, data
};
746 struct transaction t
= {.command
= ACPI_EC_COMMAND_WRITE
,
747 .wdata
= wdata
, .rdata
= NULL
,
748 .wlen
= 2, .rlen
= 0};
750 return acpi_ec_transaction(ec
, &t
);
753 int ec_read(u8 addr
, u8
*val
)
761 err
= acpi_ec_read(first_ec
, addr
, &temp_data
);
769 EXPORT_SYMBOL(ec_read
);
771 int ec_write(u8 addr
, u8 val
)
778 err
= acpi_ec_write(first_ec
, addr
, val
);
782 EXPORT_SYMBOL(ec_write
);
784 int ec_transaction(u8 command
,
785 const u8
*wdata
, unsigned wdata_len
,
786 u8
*rdata
, unsigned rdata_len
)
788 struct transaction t
= {.command
= command
,
789 .wdata
= wdata
, .rdata
= rdata
,
790 .wlen
= wdata_len
, .rlen
= rdata_len
};
795 return acpi_ec_transaction(first_ec
, &t
);
797 EXPORT_SYMBOL(ec_transaction
);
799 /* Get the handle to the EC device */
800 acpi_handle
ec_get_handle(void)
804 return first_ec
->handle
;
806 EXPORT_SYMBOL(ec_get_handle
);
809 * Process _Q events that might have accumulated in the EC.
810 * Run with locked ec mutex.
812 static void acpi_ec_clear(struct acpi_ec
*ec
)
817 for (i
= 0; i
< ACPI_EC_CLEAR_MAX
; i
++) {
818 status
= acpi_ec_query(ec
, &value
);
819 if (status
|| !value
)
823 if (unlikely(i
== ACPI_EC_CLEAR_MAX
))
824 pr_warn("Warning: Maximum of %d stale EC events cleared\n", i
);
826 pr_info("%d stale EC events cleared\n", i
);
829 static void acpi_ec_start(struct acpi_ec
*ec
, bool resuming
)
833 spin_lock_irqsave(&ec
->lock
, flags
);
834 if (!test_and_set_bit(EC_FLAGS_STARTED
, &ec
->flags
)) {
835 ec_dbg_drv("Starting EC");
836 /* Enable GPE for event processing (SCI_EVT=1) */
838 acpi_ec_submit_request(ec
);
839 ec_dbg_ref(ec
, "Increase driver");
841 ec_log_drv("EC started");
843 spin_unlock_irqrestore(&ec
->lock
, flags
);
846 static bool acpi_ec_stopped(struct acpi_ec
*ec
)
851 spin_lock_irqsave(&ec
->lock
, flags
);
852 flushed
= acpi_ec_flushed(ec
);
853 spin_unlock_irqrestore(&ec
->lock
, flags
);
857 static void acpi_ec_stop(struct acpi_ec
*ec
, bool suspending
)
861 spin_lock_irqsave(&ec
->lock
, flags
);
862 if (acpi_ec_started(ec
)) {
863 ec_dbg_drv("Stopping EC");
864 set_bit(EC_FLAGS_STOPPED
, &ec
->flags
);
865 spin_unlock_irqrestore(&ec
->lock
, flags
);
866 wait_event(ec
->wait
, acpi_ec_stopped(ec
));
867 spin_lock_irqsave(&ec
->lock
, flags
);
868 /* Disable GPE for event processing (SCI_EVT=1) */
870 acpi_ec_complete_request(ec
);
871 ec_dbg_ref(ec
, "Decrease driver");
873 clear_bit(EC_FLAGS_STARTED
, &ec
->flags
);
874 clear_bit(EC_FLAGS_STOPPED
, &ec
->flags
);
875 ec_log_drv("EC stopped");
877 spin_unlock_irqrestore(&ec
->lock
, flags
);
880 void acpi_ec_block_transactions(void)
882 struct acpi_ec
*ec
= first_ec
;
887 mutex_lock(&ec
->mutex
);
888 /* Prevent transactions from being carried out */
889 acpi_ec_stop(ec
, true);
890 mutex_unlock(&ec
->mutex
);
893 void acpi_ec_unblock_transactions(void)
895 struct acpi_ec
*ec
= first_ec
;
900 /* Allow transactions to be carried out again */
901 acpi_ec_start(ec
, true);
903 if (EC_FLAGS_CLEAR_ON_RESUME
)
907 void acpi_ec_unblock_transactions_early(void)
910 * Allow transactions to happen again (this function is called from
911 * atomic context during wakeup, so we don't need to acquire the mutex).
914 acpi_ec_start(first_ec
, true);
917 /* --------------------------------------------------------------------------
919 -------------------------------------------------------------------------- */
920 static struct acpi_ec_query_handler
*
921 acpi_ec_get_query_handler(struct acpi_ec_query_handler
*handler
)
924 kref_get(&handler
->kref
);
928 static void acpi_ec_query_handler_release(struct kref
*kref
)
930 struct acpi_ec_query_handler
*handler
=
931 container_of(kref
, struct acpi_ec_query_handler
, kref
);
936 static void acpi_ec_put_query_handler(struct acpi_ec_query_handler
*handler
)
938 kref_put(&handler
->kref
, acpi_ec_query_handler_release
);
941 int acpi_ec_add_query_handler(struct acpi_ec
*ec
, u8 query_bit
,
942 acpi_handle handle
, acpi_ec_query_func func
,
945 struct acpi_ec_query_handler
*handler
=
946 kzalloc(sizeof(struct acpi_ec_query_handler
), GFP_KERNEL
);
951 handler
->query_bit
= query_bit
;
952 handler
->handle
= handle
;
953 handler
->func
= func
;
954 handler
->data
= data
;
955 mutex_lock(&ec
->mutex
);
956 kref_init(&handler
->kref
);
957 list_add(&handler
->node
, &ec
->list
);
958 mutex_unlock(&ec
->mutex
);
961 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler
);
963 void acpi_ec_remove_query_handler(struct acpi_ec
*ec
, u8 query_bit
)
965 struct acpi_ec_query_handler
*handler
, *tmp
;
966 LIST_HEAD(free_list
);
968 mutex_lock(&ec
->mutex
);
969 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
970 if (query_bit
== handler
->query_bit
) {
971 list_del_init(&handler
->node
);
972 list_add(&handler
->node
, &free_list
);
975 mutex_unlock(&ec
->mutex
);
976 list_for_each_entry_safe(handler
, tmp
, &free_list
, node
)
977 acpi_ec_put_query_handler(handler
);
979 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler
);
981 static void acpi_ec_run(void *cxt
)
983 struct acpi_ec_query_handler
*handler
= cxt
;
987 ec_dbg_evt("Query(0x%02x) started", handler
->query_bit
);
989 handler
->func(handler
->data
);
990 else if (handler
->handle
)
991 acpi_evaluate_object(handler
->handle
, NULL
, NULL
, NULL
);
992 ec_dbg_evt("Query(0x%02x) stopped", handler
->query_bit
);
993 acpi_ec_put_query_handler(handler
);
996 static int acpi_ec_query(struct acpi_ec
*ec
, u8
*data
)
1001 struct acpi_ec_query_handler
*handler
;
1002 struct transaction t
= {.command
= ACPI_EC_COMMAND_QUERY
,
1003 .wdata
= NULL
, .rdata
= &value
,
1004 .wlen
= 0, .rlen
= 1};
1007 * Query the EC to find out which _Qxx method we need to evaluate.
1008 * Note that successful completion of the query causes the ACPI_EC_SCI
1009 * bit to be cleared (and thus clearing the interrupt source).
1011 result
= acpi_ec_transaction(ec
, &t
);
1019 mutex_lock(&ec
->mutex
);
1020 list_for_each_entry(handler
, &ec
->list
, node
) {
1021 if (value
== handler
->query_bit
) {
1022 /* have custom handler for this bit */
1023 handler
= acpi_ec_get_query_handler(handler
);
1024 ec_dbg_evt("Query(0x%02x) scheduled",
1025 handler
->query_bit
);
1026 status
= acpi_os_execute((handler
->func
) ?
1027 OSL_NOTIFY_HANDLER
: OSL_GPE_HANDLER
,
1028 acpi_ec_run
, handler
);
1029 if (ACPI_FAILURE(status
))
1034 mutex_unlock(&ec
->mutex
);
1038 static void acpi_ec_check_event(struct acpi_ec
*ec
)
1040 unsigned long flags
;
1042 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_EVENT
) {
1044 spin_lock_irqsave(&ec
->lock
, flags
);
1046 * Take care of the SCI_EVT unless no one else is
1047 * taking care of it.
1050 advance_transaction(ec
);
1051 spin_unlock_irqrestore(&ec
->lock
, flags
);
1056 static void acpi_ec_event_handler(struct work_struct
*work
)
1058 unsigned long flags
;
1059 struct acpi_ec
*ec
= container_of(work
, struct acpi_ec
, work
);
1061 ec_dbg_evt("Event started");
1063 spin_lock_irqsave(&ec
->lock
, flags
);
1064 while (ec
->nr_pending_queries
) {
1065 spin_unlock_irqrestore(&ec
->lock
, flags
);
1066 (void)acpi_ec_query(ec
, NULL
);
1067 spin_lock_irqsave(&ec
->lock
, flags
);
1068 ec
->nr_pending_queries
--;
1070 * Before exit, make sure that this work item can be
1071 * scheduled again. There might be QR_EC failures, leaving
1072 * EC_FLAGS_QUERY_PENDING uncleared and preventing this work
1073 * item from being scheduled again.
1075 if (!ec
->nr_pending_queries
) {
1076 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_STATUS
||
1077 ec_event_clearing
== ACPI_EC_EVT_TIMING_QUERY
)
1078 acpi_ec_complete_query(ec
);
1081 spin_unlock_irqrestore(&ec
->lock
, flags
);
1083 ec_dbg_evt("Event stopped");
1085 acpi_ec_check_event(ec
);
1088 static u32
acpi_ec_gpe_handler(acpi_handle gpe_device
,
1089 u32 gpe_number
, void *data
)
1091 unsigned long flags
;
1092 struct acpi_ec
*ec
= data
;
1094 spin_lock_irqsave(&ec
->lock
, flags
);
1095 advance_transaction(ec
);
1096 spin_unlock_irqrestore(&ec
->lock
, flags
);
1097 return ACPI_INTERRUPT_HANDLED
;
1100 /* --------------------------------------------------------------------------
1101 * Address Space Management
1102 * -------------------------------------------------------------------------- */
1105 acpi_ec_space_handler(u32 function
, acpi_physical_address address
,
1106 u32 bits
, u64
*value64
,
1107 void *handler_context
, void *region_context
)
1109 struct acpi_ec
*ec
= handler_context
;
1110 int result
= 0, i
, bytes
= bits
/ 8;
1111 u8
*value
= (u8
*)value64
;
1113 if ((address
> 0xFF) || !value
|| !handler_context
)
1114 return AE_BAD_PARAMETER
;
1116 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
1117 return AE_BAD_PARAMETER
;
1119 if (ec_busy_polling
|| bits
> 8)
1120 acpi_ec_burst_enable(ec
);
1122 for (i
= 0; i
< bytes
; ++i
, ++address
, ++value
)
1123 result
= (function
== ACPI_READ
) ?
1124 acpi_ec_read(ec
, address
, value
) :
1125 acpi_ec_write(ec
, address
, *value
);
1127 if (ec_busy_polling
|| bits
> 8)
1128 acpi_ec_burst_disable(ec
);
1132 return AE_BAD_PARAMETER
;
1134 return AE_NOT_FOUND
;
1142 /* --------------------------------------------------------------------------
1144 * -------------------------------------------------------------------------- */
1147 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
);
1149 static struct acpi_ec
*make_acpi_ec(void)
1151 struct acpi_ec
*ec
= kzalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
1155 ec
->flags
= 1 << EC_FLAGS_QUERY_PENDING
;
1156 mutex_init(&ec
->mutex
);
1157 init_waitqueue_head(&ec
->wait
);
1158 INIT_LIST_HEAD(&ec
->list
);
1159 spin_lock_init(&ec
->lock
);
1160 INIT_WORK(&ec
->work
, acpi_ec_event_handler
);
1161 ec
->timestamp
= jiffies
;
1166 acpi_ec_register_query_methods(acpi_handle handle
, u32 level
,
1167 void *context
, void **return_value
)
1170 struct acpi_buffer buffer
= { sizeof(node_name
), node_name
};
1171 struct acpi_ec
*ec
= context
;
1175 status
= acpi_get_name(handle
, ACPI_SINGLE_NAME
, &buffer
);
1177 if (ACPI_SUCCESS(status
) && sscanf(node_name
, "_Q%x", &value
) == 1)
1178 acpi_ec_add_query_handler(ec
, value
, handle
, NULL
, NULL
);
1183 ec_parse_device(acpi_handle handle
, u32 Level
, void *context
, void **retval
)
1186 unsigned long long tmp
= 0;
1187 struct acpi_ec
*ec
= context
;
1189 /* clear addr values, ec_parse_io_ports depend on it */
1190 ec
->command_addr
= ec
->data_addr
= 0;
1192 status
= acpi_walk_resources(handle
, METHOD_NAME__CRS
,
1193 ec_parse_io_ports
, ec
);
1194 if (ACPI_FAILURE(status
))
1197 /* Get GPE bit assignment (EC events). */
1198 /* TODO: Add support for _GPE returning a package */
1199 status
= acpi_evaluate_integer(handle
, "_GPE", NULL
, &tmp
);
1200 if (ACPI_FAILURE(status
))
1203 /* Use the global lock for all EC transactions? */
1205 acpi_evaluate_integer(handle
, "_GLK", NULL
, &tmp
);
1206 ec
->global_lock
= tmp
;
1207 ec
->handle
= handle
;
1208 return AE_CTRL_TERMINATE
;
1211 static int ec_install_handlers(struct acpi_ec
*ec
)
1215 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
))
1217 status
= acpi_install_gpe_raw_handler(NULL
, ec
->gpe
,
1218 ACPI_GPE_EDGE_TRIGGERED
,
1219 &acpi_ec_gpe_handler
, ec
);
1220 if (ACPI_FAILURE(status
))
1223 acpi_ec_start(ec
, false);
1224 status
= acpi_install_address_space_handler(ec
->handle
,
1226 &acpi_ec_space_handler
,
1228 if (ACPI_FAILURE(status
)) {
1229 if (status
== AE_NOT_FOUND
) {
1231 * Maybe OS fails in evaluating the _REG object.
1232 * The AE_NOT_FOUND error will be ignored and OS
1233 * continue to initialize EC.
1235 pr_err("Fail in evaluating the _REG object"
1236 " of EC device. Broken bios is suspected.\n");
1238 acpi_ec_stop(ec
, false);
1239 acpi_remove_gpe_handler(NULL
, ec
->gpe
,
1240 &acpi_ec_gpe_handler
);
1245 set_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
1249 static void ec_remove_handlers(struct acpi_ec
*ec
)
1251 if (!test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
))
1253 acpi_ec_stop(ec
, false);
1254 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec
->handle
,
1255 ACPI_ADR_SPACE_EC
, &acpi_ec_space_handler
)))
1256 pr_err("failed to remove space handler\n");
1257 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL
, ec
->gpe
,
1258 &acpi_ec_gpe_handler
)))
1259 pr_err("failed to remove gpe handler\n");
1260 clear_bit(EC_FLAGS_HANDLERS_INSTALLED
, &ec
->flags
);
1263 static int acpi_ec_add(struct acpi_device
*device
)
1265 struct acpi_ec
*ec
= NULL
;
1268 strcpy(acpi_device_name(device
), ACPI_EC_DEVICE_NAME
);
1269 strcpy(acpi_device_class(device
), ACPI_EC_CLASS
);
1271 /* Check for boot EC */
1273 (boot_ec
->handle
== device
->handle
||
1274 boot_ec
->handle
== ACPI_ROOT_OBJECT
)) {
1278 ec
= make_acpi_ec();
1282 if (ec_parse_device(device
->handle
, 0, ec
, NULL
) !=
1283 AE_CTRL_TERMINATE
) {
1288 /* Find and register all query methods */
1289 acpi_walk_namespace(ACPI_TYPE_METHOD
, ec
->handle
, 1,
1290 acpi_ec_register_query_methods
, NULL
, ec
, NULL
);
1294 device
->driver_data
= ec
;
1296 ret
= !!request_region(ec
->data_addr
, 1, "EC data");
1297 WARN(!ret
, "Could not request EC data io port 0x%lx", ec
->data_addr
);
1298 ret
= !!request_region(ec
->command_addr
, 1, "EC cmd");
1299 WARN(!ret
, "Could not request EC cmd io port 0x%lx", ec
->command_addr
);
1301 pr_info("GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
1302 ec
->gpe
, ec
->command_addr
, ec
->data_addr
);
1304 ret
= ec_install_handlers(ec
);
1306 /* Reprobe devices depending on the EC */
1307 acpi_walk_dep_device_list(ec
->handle
);
1309 /* EC is fully operational, allow queries */
1310 clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
);
1312 /* Clear stale _Q events if hardware might require that */
1313 if (EC_FLAGS_CLEAR_ON_RESUME
)
1318 static int acpi_ec_remove(struct acpi_device
*device
)
1321 struct acpi_ec_query_handler
*handler
, *tmp
;
1326 ec
= acpi_driver_data(device
);
1327 ec_remove_handlers(ec
);
1328 mutex_lock(&ec
->mutex
);
1329 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
1330 list_del(&handler
->node
);
1333 mutex_unlock(&ec
->mutex
);
1334 release_region(ec
->data_addr
, 1);
1335 release_region(ec
->command_addr
, 1);
1336 device
->driver_data
= NULL
;
1344 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
)
1346 struct acpi_ec
*ec
= context
;
1348 if (resource
->type
!= ACPI_RESOURCE_TYPE_IO
)
1352 * The first address region returned is the data port, and
1353 * the second address region returned is the status/command
1356 if (ec
->data_addr
== 0)
1357 ec
->data_addr
= resource
->data
.io
.minimum
;
1358 else if (ec
->command_addr
== 0)
1359 ec
->command_addr
= resource
->data
.io
.minimum
;
1361 return AE_CTRL_TERMINATE
;
1366 int __init
acpi_boot_ec_enable(void)
1368 if (!boot_ec
|| test_bit(EC_FLAGS_HANDLERS_INSTALLED
, &boot_ec
->flags
))
1370 if (!ec_install_handlers(boot_ec
)) {
1377 static const struct acpi_device_id ec_device_ids
[] = {
1382 /* Some BIOS do not survive early DSDT scan, skip it */
1383 static int ec_skip_dsdt_scan(const struct dmi_system_id
*id
)
1385 EC_FLAGS_SKIP_DSDT_SCAN
= 1;
1389 /* ASUStek often supplies us with broken ECDT, validate it */
1390 static int ec_validate_ecdt(const struct dmi_system_id
*id
)
1392 EC_FLAGS_VALIDATE_ECDT
= 1;
1398 * Some EC firmware variations refuses to respond QR_EC when SCI_EVT is not
1399 * set, for which case, we complete the QR_EC without issuing it to the
1401 * https://bugzilla.kernel.org/show_bug.cgi?id=82611
1402 * https://bugzilla.kernel.org/show_bug.cgi?id=97381
1404 static int ec_flag_query_handshake(const struct dmi_system_id
*id
)
1406 pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n");
1407 EC_FLAGS_QUERY_HANDSHAKE
= 1;
1413 * On some hardware it is necessary to clear events accumulated by the EC during
1414 * sleep. These ECs stop reporting GPEs until they are manually polled, if too
1415 * many events are accumulated. (e.g. Samsung Series 5/9 notebooks)
1417 * https://bugzilla.kernel.org/show_bug.cgi?id=44161
1419 * Ideally, the EC should also be instructed NOT to accumulate events during
1420 * sleep (which Windows seems to do somehow), but the interface to control this
1421 * behaviour is not known at this time.
1423 * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx,
1424 * however it is very likely that other Samsung models are affected.
1426 * On systems which don't accumulate _Q events during sleep, this extra check
1427 * should be harmless.
1429 static int ec_clear_on_resume(const struct dmi_system_id
*id
)
1431 pr_debug("Detected system needing EC poll on resume.\n");
1432 EC_FLAGS_CLEAR_ON_RESUME
= 1;
1433 ec_event_clearing
= ACPI_EC_EVT_TIMING_STATUS
;
1437 static struct dmi_system_id ec_dmi_table
[] __initdata
= {
1439 ec_skip_dsdt_scan
, "Compal JFL92", {
1440 DMI_MATCH(DMI_BIOS_VENDOR
, "COMPAL"),
1441 DMI_MATCH(DMI_BOARD_NAME
, "JFL92") }, NULL
},
1443 ec_validate_ecdt
, "MSI MS-171F", {
1444 DMI_MATCH(DMI_SYS_VENDOR
, "Micro-Star"),
1445 DMI_MATCH(DMI_PRODUCT_NAME
, "MS-171F"),}, NULL
},
1447 ec_validate_ecdt
, "ASUS hardware", {
1448 DMI_MATCH(DMI_BIOS_VENDOR
, "ASUS") }, NULL
},
1450 ec_validate_ecdt
, "ASUS hardware", {
1451 DMI_MATCH(DMI_BOARD_VENDOR
, "ASUSTeK Computer Inc.") }, NULL
},
1453 ec_skip_dsdt_scan
, "HP Folio 13", {
1454 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
1455 DMI_MATCH(DMI_PRODUCT_NAME
, "HP Folio 13"),}, NULL
},
1457 ec_validate_ecdt
, "ASUS hardware", {
1458 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTek Computer Inc."),
1459 DMI_MATCH(DMI_PRODUCT_NAME
, "L4R"),}, NULL
},
1461 ec_clear_on_resume
, "Samsung hardware", {
1462 DMI_MATCH(DMI_SYS_VENDOR
, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL
},
1466 int __init
acpi_ec_ecdt_probe(void)
1469 struct acpi_ec
*saved_ec
= NULL
;
1470 struct acpi_table_ecdt
*ecdt_ptr
;
1472 boot_ec
= make_acpi_ec();
1476 * Generate a boot ec context
1478 dmi_check_system(ec_dmi_table
);
1479 status
= acpi_get_table(ACPI_SIG_ECDT
, 1,
1480 (struct acpi_table_header
**)&ecdt_ptr
);
1481 if (ACPI_SUCCESS(status
)) {
1482 pr_info("EC description table is found, configuring boot EC\n");
1483 boot_ec
->command_addr
= ecdt_ptr
->control
.address
;
1484 boot_ec
->data_addr
= ecdt_ptr
->data
.address
;
1485 boot_ec
->gpe
= ecdt_ptr
->gpe
;
1486 boot_ec
->handle
= ACPI_ROOT_OBJECT
;
1487 acpi_get_handle(ACPI_ROOT_OBJECT
, ecdt_ptr
->id
,
1489 /* Don't trust ECDT, which comes from ASUSTek */
1490 if (!EC_FLAGS_VALIDATE_ECDT
)
1492 saved_ec
= kmemdup(boot_ec
, sizeof(struct acpi_ec
), GFP_KERNEL
);
1498 if (EC_FLAGS_SKIP_DSDT_SCAN
) {
1503 /* This workaround is needed only on some broken machines,
1504 * which require early EC, but fail to provide ECDT */
1505 pr_debug("Look up EC in DSDT\n");
1506 status
= acpi_get_devices(ec_device_ids
[0].id
, ec_parse_device
,
1508 /* Check that acpi_get_devices actually find something */
1509 if (ACPI_FAILURE(status
) || !boot_ec
->handle
)
1512 /* try to find good ECDT from ASUSTek */
1513 if (saved_ec
->command_addr
!= boot_ec
->command_addr
||
1514 saved_ec
->data_addr
!= boot_ec
->data_addr
||
1515 saved_ec
->gpe
!= boot_ec
->gpe
||
1516 saved_ec
->handle
!= boot_ec
->handle
)
1517 pr_info("ASUSTek keeps feeding us with broken "
1518 "ECDT tables, which are very hard to workaround. "
1519 "Trying to use DSDT EC info instead. Please send "
1520 "output of acpidump to linux-acpi@vger.kernel.org\n");
1524 /* We really need to limit this workaround, the only ASUS,
1525 * which needs it, has fake EC._INI method, so use it as flag.
1526 * Keep boot_ec struct as it will be needed soon.
1528 if (!dmi_name_in_vendors("ASUS") ||
1529 !acpi_has_method(boot_ec
->handle
, "_INI"))
1533 if (!ec_install_handlers(boot_ec
)) {
1544 static int param_set_event_clearing(const char *val
, struct kernel_param
*kp
)
1548 if (!strncmp(val
, "status", sizeof("status") - 1)) {
1549 ec_event_clearing
= ACPI_EC_EVT_TIMING_STATUS
;
1550 pr_info("Assuming SCI_EVT clearing on EC_SC accesses\n");
1551 } else if (!strncmp(val
, "query", sizeof("query") - 1)) {
1552 ec_event_clearing
= ACPI_EC_EVT_TIMING_QUERY
;
1553 pr_info("Assuming SCI_EVT clearing on QR_EC writes\n");
1554 } else if (!strncmp(val
, "event", sizeof("event") - 1)) {
1555 ec_event_clearing
= ACPI_EC_EVT_TIMING_EVENT
;
1556 pr_info("Assuming SCI_EVT clearing on event reads\n");
1562 static int param_get_event_clearing(char *buffer
, struct kernel_param
*kp
)
1564 switch (ec_event_clearing
) {
1565 case ACPI_EC_EVT_TIMING_STATUS
:
1566 return sprintf(buffer
, "status");
1567 case ACPI_EC_EVT_TIMING_QUERY
:
1568 return sprintf(buffer
, "query");
1569 case ACPI_EC_EVT_TIMING_EVENT
:
1570 return sprintf(buffer
, "event");
1572 return sprintf(buffer
, "invalid");
1577 module_param_call(ec_event_clearing
, param_set_event_clearing
, param_get_event_clearing
,
1579 MODULE_PARM_DESC(ec_event_clearing
, "Assumed SCI_EVT clearing timing");
1581 static struct acpi_driver acpi_ec_driver
= {
1583 .class = ACPI_EC_CLASS
,
1584 .ids
= ec_device_ids
,
1587 .remove
= acpi_ec_remove
,
1591 int __init
acpi_ec_init(void)
1595 /* Now register the driver for the EC */
1596 result
= acpi_bus_register_driver(&acpi_ec_driver
);
1603 /* EC driver currently not unloadable */
1605 static void __exit
acpi_ec_exit(void)
1608 acpi_bus_unregister_driver(&acpi_ec_driver
);