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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28 /* Uncomment next line to get verbose printout */
30 #define pr_fmt(fmt) "ACPI: EC: " fmt
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/interrupt.h>
38 #include <linux/list.h>
39 #include <linux/spinlock.h>
40 #include <linux/slab.h>
41 #include <linux/acpi.h>
42 #include <linux/dmi.h>
47 #define ACPI_EC_CLASS "embedded_controller"
48 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
49 #define ACPI_EC_FILE_INFO "info"
51 /* EC status register */
52 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
53 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
54 #define ACPI_EC_FLAG_CMD 0x08 /* Input buffer contains a command */
55 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
56 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
59 * The SCI_EVT clearing timing is not defined by the ACPI specification.
60 * This leads to lots of practical timing issues for the host EC driver.
61 * The following variations are defined (from the target EC firmware's
63 * STATUS: After indicating SCI_EVT edge triggered IRQ to the host, the
64 * target can clear SCI_EVT at any time so long as the host can see
65 * the indication by reading the status register (EC_SC). So the
66 * host should re-check SCI_EVT after the first time the SCI_EVT
67 * indication is seen, which is the same time the query request
68 * (QR_EC) is written to the command register (EC_CMD). SCI_EVT set
69 * at any later time could indicate another event. Normally such
70 * kind of EC firmware has implemented an event queue and will
71 * return 0x00 to indicate "no outstanding event".
72 * QUERY: After seeing the query request (QR_EC) written to the command
73 * register (EC_CMD) by the host and having prepared the responding
74 * event value in the data register (EC_DATA), the target can safely
75 * clear SCI_EVT because the target can confirm that the current
76 * event is being handled by the host. The host then should check
77 * SCI_EVT right after reading the event response from the data
79 * EVENT: After seeing the event response read from the data register
80 * (EC_DATA) by the host, the target can clear SCI_EVT. As the
81 * target requires time to notice the change in the data register
82 * (EC_DATA), the host may be required to wait additional guarding
83 * time before checking the SCI_EVT again. Such guarding may not be
84 * necessary if the host is notified via another IRQ.
86 #define ACPI_EC_EVT_TIMING_STATUS 0x00
87 #define ACPI_EC_EVT_TIMING_QUERY 0x01
88 #define ACPI_EC_EVT_TIMING_EVENT 0x02
92 ACPI_EC_COMMAND_READ
= 0x80,
93 ACPI_EC_COMMAND_WRITE
= 0x81,
94 ACPI_EC_BURST_ENABLE
= 0x82,
95 ACPI_EC_BURST_DISABLE
= 0x83,
96 ACPI_EC_COMMAND_QUERY
= 0x84,
99 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
100 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
101 #define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */
102 #define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
103 * when trying to clear the EC */
104 #define ACPI_EC_MAX_QUERIES 16 /* Maximum number of parallel queries */
107 EC_FLAGS_QUERY_ENABLED
, /* Query is enabled */
108 EC_FLAGS_QUERY_PENDING
, /* Query is pending */
109 EC_FLAGS_QUERY_GUARDING
, /* Guard for SCI_EVT check */
110 EC_FLAGS_GPE_HANDLER_INSTALLED
, /* GPE handler installed */
111 EC_FLAGS_EC_HANDLER_INSTALLED
, /* OpReg handler installed */
112 EC_FLAGS_EVT_HANDLER_INSTALLED
, /* _Qxx handlers installed */
113 EC_FLAGS_STARTED
, /* Driver is started */
114 EC_FLAGS_STOPPED
, /* Driver is stopped */
115 EC_FLAGS_COMMAND_STORM
, /* GPE storms occurred to the
116 * current command processing */
119 #define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
120 #define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
122 /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
123 static unsigned int ec_delay __read_mostly
= ACPI_EC_DELAY
;
124 module_param(ec_delay
, uint
, 0644);
125 MODULE_PARM_DESC(ec_delay
, "Timeout(ms) waited until an EC command completes");
127 static unsigned int ec_max_queries __read_mostly
= ACPI_EC_MAX_QUERIES
;
128 module_param(ec_max_queries
, uint
, 0644);
129 MODULE_PARM_DESC(ec_max_queries
, "Maximum parallel _Qxx evaluations");
131 static bool ec_busy_polling __read_mostly
;
132 module_param(ec_busy_polling
, bool, 0644);
133 MODULE_PARM_DESC(ec_busy_polling
, "Use busy polling to advance EC transaction");
135 static unsigned int ec_polling_guard __read_mostly
= ACPI_EC_UDELAY_POLL
;
136 module_param(ec_polling_guard
, uint
, 0644);
137 MODULE_PARM_DESC(ec_polling_guard
, "Guard time(us) between EC accesses in polling modes");
139 static unsigned int ec_event_clearing __read_mostly
= ACPI_EC_EVT_TIMING_QUERY
;
142 * If the number of false interrupts per one transaction exceeds
143 * this threshold, will think there is a GPE storm happened and
144 * will disable the GPE for normal transaction.
146 static unsigned int ec_storm_threshold __read_mostly
= 8;
147 module_param(ec_storm_threshold
, uint
, 0644);
148 MODULE_PARM_DESC(ec_storm_threshold
, "Maxim false GPE numbers not considered as GPE storm");
150 static bool ec_freeze_events __read_mostly
= false;
151 module_param(ec_freeze_events
, bool, 0644);
152 MODULE_PARM_DESC(ec_freeze_events
, "Disabling event handling during suspend/resume");
154 static bool ec_no_wakeup __read_mostly
;
155 module_param(ec_no_wakeup
, bool, 0644);
156 MODULE_PARM_DESC(ec_no_wakeup
, "Do not wake up from suspend-to-idle");
158 struct acpi_ec_query_handler
{
159 struct list_head node
;
160 acpi_ec_query_func func
;
170 unsigned short irq_count
;
179 struct acpi_ec_query
{
180 struct transaction transaction
;
181 struct work_struct work
;
182 struct acpi_ec_query_handler
*handler
;
185 static int acpi_ec_query(struct acpi_ec
*ec
, u8
*data
);
186 static void advance_transaction(struct acpi_ec
*ec
);
187 static void acpi_ec_event_handler(struct work_struct
*work
);
188 static void acpi_ec_event_processor(struct work_struct
*work
);
190 struct acpi_ec
*boot_ec
, *first_ec
;
191 EXPORT_SYMBOL(first_ec
);
192 static bool boot_ec_is_ecdt
= false;
193 static struct workqueue_struct
*ec_query_wq
;
195 static int EC_FLAGS_QUERY_HANDSHAKE
; /* Needs QR_EC issued when SCI_EVT set */
196 static int EC_FLAGS_CORRECT_ECDT
; /* Needs ECDT port address correction */
197 static int EC_FLAGS_IGNORE_DSDT_GPE
; /* Needs ECDT GPE as correction setting */
199 /* --------------------------------------------------------------------------
201 * -------------------------------------------------------------------------- */
204 * Splitters used by the developers to track the boundary of the EC
205 * handling processes.
208 #define EC_DBG_SEP " "
209 #define EC_DBG_DRV "+++++"
210 #define EC_DBG_STM "====="
211 #define EC_DBG_REQ "*****"
212 #define EC_DBG_EVT "#####"
214 #define EC_DBG_SEP ""
221 #define ec_log_raw(fmt, ...) \
222 pr_info(fmt "\n", ##__VA_ARGS__)
223 #define ec_dbg_raw(fmt, ...) \
224 pr_debug(fmt "\n", ##__VA_ARGS__)
225 #define ec_log(filter, fmt, ...) \
226 ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
227 #define ec_dbg(filter, fmt, ...) \
228 ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
230 #define ec_log_drv(fmt, ...) \
231 ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__)
232 #define ec_dbg_drv(fmt, ...) \
233 ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__)
234 #define ec_dbg_stm(fmt, ...) \
235 ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__)
236 #define ec_dbg_req(fmt, ...) \
237 ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__)
238 #define ec_dbg_evt(fmt, ...) \
239 ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__)
240 #define ec_dbg_ref(ec, fmt, ...) \
241 ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
243 /* --------------------------------------------------------------------------
245 * -------------------------------------------------------------------------- */
247 static bool acpi_ec_started(struct acpi_ec
*ec
)
249 return test_bit(EC_FLAGS_STARTED
, &ec
->flags
) &&
250 !test_bit(EC_FLAGS_STOPPED
, &ec
->flags
);
253 static bool acpi_ec_event_enabled(struct acpi_ec
*ec
)
256 * There is an OSPM early stage logic. During the early stages
257 * (boot/resume), OSPMs shouldn't enable the event handling, only
258 * the EC transactions are allowed to be performed.
260 if (!test_bit(EC_FLAGS_QUERY_ENABLED
, &ec
->flags
))
263 * However, disabling the event handling is experimental for late
264 * stage (suspend), and is controlled by the boot parameter of
265 * "ec_freeze_events":
266 * 1. true: The EC event handling is disabled before entering
268 * 2. false: The EC event handling is automatically disabled as
269 * soon as the EC driver is stopped.
271 if (ec_freeze_events
)
272 return acpi_ec_started(ec
);
274 return test_bit(EC_FLAGS_STARTED
, &ec
->flags
);
277 static bool acpi_ec_flushed(struct acpi_ec
*ec
)
279 return ec
->reference_count
== 1;
282 /* --------------------------------------------------------------------------
284 * -------------------------------------------------------------------------- */
286 static inline u8
acpi_ec_read_status(struct acpi_ec
*ec
)
288 u8 x
= inb(ec
->command_addr
);
290 ec_dbg_raw("EC_SC(R) = 0x%2.2x "
291 "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d",
293 !!(x
& ACPI_EC_FLAG_SCI
),
294 !!(x
& ACPI_EC_FLAG_BURST
),
295 !!(x
& ACPI_EC_FLAG_CMD
),
296 !!(x
& ACPI_EC_FLAG_IBF
),
297 !!(x
& ACPI_EC_FLAG_OBF
));
301 static inline u8
acpi_ec_read_data(struct acpi_ec
*ec
)
303 u8 x
= inb(ec
->data_addr
);
305 ec
->timestamp
= jiffies
;
306 ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x
);
310 static inline void acpi_ec_write_cmd(struct acpi_ec
*ec
, u8 command
)
312 ec_dbg_raw("EC_SC(W) = 0x%2.2x", command
);
313 outb(command
, ec
->command_addr
);
314 ec
->timestamp
= jiffies
;
317 static inline void acpi_ec_write_data(struct acpi_ec
*ec
, u8 data
)
319 ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data
);
320 outb(data
, ec
->data_addr
);
321 ec
->timestamp
= jiffies
;
324 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
325 static const char *acpi_ec_cmd_string(u8 cmd
)
342 #define acpi_ec_cmd_string(cmd) "UNDEF"
345 /* --------------------------------------------------------------------------
347 * -------------------------------------------------------------------------- */
349 static inline bool acpi_ec_is_gpe_raised(struct acpi_ec
*ec
)
351 acpi_event_status gpe_status
= 0;
353 (void)acpi_get_gpe_status(NULL
, ec
->gpe
, &gpe_status
);
354 return (gpe_status
& ACPI_EVENT_FLAG_STATUS_SET
) ? true : false;
357 static inline void acpi_ec_enable_gpe(struct acpi_ec
*ec
, bool open
)
360 acpi_enable_gpe(NULL
, ec
->gpe
);
362 BUG_ON(ec
->reference_count
< 1);
363 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_ENABLE
);
365 if (acpi_ec_is_gpe_raised(ec
)) {
367 * On some platforms, EN=1 writes cannot trigger GPE. So
368 * software need to manually trigger a pseudo GPE event on
371 ec_dbg_raw("Polling quirk");
372 advance_transaction(ec
);
376 static inline void acpi_ec_disable_gpe(struct acpi_ec
*ec
, bool close
)
379 acpi_disable_gpe(NULL
, ec
->gpe
);
381 BUG_ON(ec
->reference_count
< 1);
382 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_DISABLE
);
386 static inline void acpi_ec_clear_gpe(struct acpi_ec
*ec
)
389 * GPE STS is a W1C register, which means:
390 * 1. Software can clear it without worrying about clearing other
391 * GPEs' STS bits when the hardware sets them in parallel.
392 * 2. As long as software can ensure only clearing it when it is
393 * set, hardware won't set it in parallel.
394 * So software can clear GPE in any contexts.
395 * Warning: do not move the check into advance_transaction() as the
396 * EC commands will be sent without GPE raised.
398 if (!acpi_ec_is_gpe_raised(ec
))
400 acpi_clear_gpe(NULL
, ec
->gpe
);
403 /* --------------------------------------------------------------------------
404 * Transaction Management
405 * -------------------------------------------------------------------------- */
407 static void acpi_ec_submit_request(struct acpi_ec
*ec
)
409 ec
->reference_count
++;
410 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED
, &ec
->flags
) &&
411 ec
->reference_count
== 1)
412 acpi_ec_enable_gpe(ec
, true);
415 static void acpi_ec_complete_request(struct acpi_ec
*ec
)
417 bool flushed
= false;
419 ec
->reference_count
--;
420 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED
, &ec
->flags
) &&
421 ec
->reference_count
== 0)
422 acpi_ec_disable_gpe(ec
, true);
423 flushed
= acpi_ec_flushed(ec
);
428 static void acpi_ec_set_storm(struct acpi_ec
*ec
, u8 flag
)
430 if (!test_bit(flag
, &ec
->flags
)) {
431 acpi_ec_disable_gpe(ec
, false);
432 ec_dbg_drv("Polling enabled");
433 set_bit(flag
, &ec
->flags
);
437 static void acpi_ec_clear_storm(struct acpi_ec
*ec
, u8 flag
)
439 if (test_bit(flag
, &ec
->flags
)) {
440 clear_bit(flag
, &ec
->flags
);
441 acpi_ec_enable_gpe(ec
, false);
442 ec_dbg_drv("Polling disabled");
447 * acpi_ec_submit_flushable_request() - Increase the reference count unless
448 * the flush operation is not in
452 * This function must be used before taking a new action that should hold
453 * the reference count. If this function returns false, then the action
454 * must be discarded or it will prevent the flush operation from being
457 static bool acpi_ec_submit_flushable_request(struct acpi_ec
*ec
)
459 if (!acpi_ec_started(ec
))
461 acpi_ec_submit_request(ec
);
465 static void acpi_ec_submit_query(struct acpi_ec
*ec
)
467 acpi_ec_set_storm(ec
, EC_FLAGS_COMMAND_STORM
);
468 if (!acpi_ec_event_enabled(ec
))
470 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
)) {
471 ec_dbg_evt("Command(%s) submitted/blocked",
472 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
473 ec
->nr_pending_queries
++;
474 schedule_work(&ec
->work
);
478 static void acpi_ec_complete_query(struct acpi_ec
*ec
)
480 if (test_and_clear_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
))
481 ec_dbg_evt("Command(%s) unblocked",
482 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
483 acpi_ec_clear_storm(ec
, EC_FLAGS_COMMAND_STORM
);
486 static inline void __acpi_ec_enable_event(struct acpi_ec
*ec
)
488 if (!test_and_set_bit(EC_FLAGS_QUERY_ENABLED
, &ec
->flags
))
489 ec_log_drv("event unblocked");
490 if (!test_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
))
491 advance_transaction(ec
);
494 static inline void __acpi_ec_disable_event(struct acpi_ec
*ec
)
496 if (test_and_clear_bit(EC_FLAGS_QUERY_ENABLED
, &ec
->flags
))
497 ec_log_drv("event blocked");
500 static void acpi_ec_enable_event(struct acpi_ec
*ec
)
504 spin_lock_irqsave(&ec
->lock
, flags
);
505 if (acpi_ec_started(ec
))
506 __acpi_ec_enable_event(ec
);
507 spin_unlock_irqrestore(&ec
->lock
, flags
);
510 #ifdef CONFIG_PM_SLEEP
511 static bool acpi_ec_query_flushed(struct acpi_ec
*ec
)
516 spin_lock_irqsave(&ec
->lock
, flags
);
517 flushed
= !ec
->nr_pending_queries
;
518 spin_unlock_irqrestore(&ec
->lock
, flags
);
522 static void __acpi_ec_flush_event(struct acpi_ec
*ec
)
525 * When ec_freeze_events is true, we need to flush events in
526 * the proper position before entering the noirq stage.
528 wait_event(ec
->wait
, acpi_ec_query_flushed(ec
));
530 flush_workqueue(ec_query_wq
);
533 static void acpi_ec_disable_event(struct acpi_ec
*ec
)
537 spin_lock_irqsave(&ec
->lock
, flags
);
538 __acpi_ec_disable_event(ec
);
539 spin_unlock_irqrestore(&ec
->lock
, flags
);
540 __acpi_ec_flush_event(ec
);
543 void acpi_ec_flush_work(void)
546 __acpi_ec_flush_event(first_ec
);
548 flush_scheduled_work();
550 #endif /* CONFIG_PM_SLEEP */
552 static bool acpi_ec_guard_event(struct acpi_ec
*ec
)
557 spin_lock_irqsave(&ec
->lock
, flags
);
559 * If firmware SCI_EVT clearing timing is "event", we actually
560 * don't know when the SCI_EVT will be cleared by firmware after
561 * evaluating _Qxx, so we need to re-check SCI_EVT after waiting an
564 * The guarding period begins when EC_FLAGS_QUERY_PENDING is
565 * flagged, which means SCI_EVT check has just been performed.
566 * But if the current transaction is ACPI_EC_COMMAND_QUERY, the
567 * guarding should have already been performed (via
568 * EC_FLAGS_QUERY_GUARDING) and should not be applied so that the
569 * ACPI_EC_COMMAND_QUERY transaction can be transitioned into
570 * ACPI_EC_COMMAND_POLL state immediately.
572 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_STATUS
||
573 ec_event_clearing
== ACPI_EC_EVT_TIMING_QUERY
||
574 !test_bit(EC_FLAGS_QUERY_PENDING
, &ec
->flags
) ||
575 (ec
->curr
&& ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
))
577 spin_unlock_irqrestore(&ec
->lock
, flags
);
581 static int ec_transaction_polled(struct acpi_ec
*ec
)
586 spin_lock_irqsave(&ec
->lock
, flags
);
587 if (ec
->curr
&& (ec
->curr
->flags
& ACPI_EC_COMMAND_POLL
))
589 spin_unlock_irqrestore(&ec
->lock
, flags
);
593 static int ec_transaction_completed(struct acpi_ec
*ec
)
598 spin_lock_irqsave(&ec
->lock
, flags
);
599 if (ec
->curr
&& (ec
->curr
->flags
& ACPI_EC_COMMAND_COMPLETE
))
601 spin_unlock_irqrestore(&ec
->lock
, flags
);
605 static inline void ec_transaction_transition(struct acpi_ec
*ec
, unsigned long flag
)
607 ec
->curr
->flags
|= flag
;
608 if (ec
->curr
->command
== ACPI_EC_COMMAND_QUERY
) {
609 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_STATUS
&&
610 flag
== ACPI_EC_COMMAND_POLL
)
611 acpi_ec_complete_query(ec
);
612 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_QUERY
&&
613 flag
== ACPI_EC_COMMAND_COMPLETE
)
614 acpi_ec_complete_query(ec
);
615 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_EVENT
&&
616 flag
== ACPI_EC_COMMAND_COMPLETE
)
617 set_bit(EC_FLAGS_QUERY_GUARDING
, &ec
->flags
);
621 static void advance_transaction(struct acpi_ec
*ec
)
623 struct transaction
*t
;
627 ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK",
630 * By always clearing STS before handling all indications, we can
631 * ensure a hardware STS 0->1 change after this clearing can always
632 * trigger a GPE interrupt.
634 acpi_ec_clear_gpe(ec
);
635 status
= acpi_ec_read_status(ec
);
638 * Another IRQ or a guarded polling mode advancement is detected,
639 * the next QR_EC submission is then allowed.
641 if (!t
|| !(t
->flags
& ACPI_EC_COMMAND_POLL
)) {
642 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_EVENT
&&
643 (!ec
->nr_pending_queries
||
644 test_bit(EC_FLAGS_QUERY_GUARDING
, &ec
->flags
))) {
645 clear_bit(EC_FLAGS_QUERY_GUARDING
, &ec
->flags
);
646 acpi_ec_complete_query(ec
);
651 if (t
->flags
& ACPI_EC_COMMAND_POLL
) {
652 if (t
->wlen
> t
->wi
) {
653 if ((status
& ACPI_EC_FLAG_IBF
) == 0)
654 acpi_ec_write_data(ec
, t
->wdata
[t
->wi
++]);
657 } else if (t
->rlen
> t
->ri
) {
658 if ((status
& ACPI_EC_FLAG_OBF
) == 1) {
659 t
->rdata
[t
->ri
++] = acpi_ec_read_data(ec
);
660 if (t
->rlen
== t
->ri
) {
661 ec_transaction_transition(ec
, ACPI_EC_COMMAND_COMPLETE
);
662 if (t
->command
== ACPI_EC_COMMAND_QUERY
)
663 ec_dbg_evt("Command(%s) completed by hardware",
664 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
669 } else if (t
->wlen
== t
->wi
&&
670 (status
& ACPI_EC_FLAG_IBF
) == 0) {
671 ec_transaction_transition(ec
, ACPI_EC_COMMAND_COMPLETE
);
676 if (EC_FLAGS_QUERY_HANDSHAKE
&&
677 !(status
& ACPI_EC_FLAG_SCI
) &&
678 (t
->command
== ACPI_EC_COMMAND_QUERY
)) {
679 ec_transaction_transition(ec
, ACPI_EC_COMMAND_POLL
);
680 t
->rdata
[t
->ri
++] = 0x00;
681 ec_transaction_transition(ec
, ACPI_EC_COMMAND_COMPLETE
);
682 ec_dbg_evt("Command(%s) completed by software",
683 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY
));
685 } else if ((status
& ACPI_EC_FLAG_IBF
) == 0) {
686 acpi_ec_write_cmd(ec
, t
->command
);
687 ec_transaction_transition(ec
, ACPI_EC_COMMAND_POLL
);
694 * If SCI bit is set, then don't think it's a false IRQ
695 * otherwise will take a not handled IRQ as a false one.
697 if (!(status
& ACPI_EC_FLAG_SCI
)) {
698 if (in_interrupt() && t
) {
699 if (t
->irq_count
< ec_storm_threshold
)
701 /* Allow triggering on 0 threshold */
702 if (t
->irq_count
== ec_storm_threshold
)
703 acpi_ec_set_storm(ec
, EC_FLAGS_COMMAND_STORM
);
707 if (status
& ACPI_EC_FLAG_SCI
)
708 acpi_ec_submit_query(ec
);
709 if (wakeup
&& in_interrupt())
713 static void start_transaction(struct acpi_ec
*ec
)
715 ec
->curr
->irq_count
= ec
->curr
->wi
= ec
->curr
->ri
= 0;
719 static int ec_guard(struct acpi_ec
*ec
)
721 unsigned long guard
= usecs_to_jiffies(ec
->polling_guard
);
722 unsigned long timeout
= ec
->timestamp
+ guard
;
724 /* Ensure guarding period before polling EC status */
726 if (ec
->busy_polling
) {
727 /* Perform busy polling */
728 if (ec_transaction_completed(ec
))
730 udelay(jiffies_to_usecs(guard
));
733 * Perform wait polling
734 * 1. Wait the transaction to be completed by the
735 * GPE handler after the transaction enters
736 * ACPI_EC_COMMAND_POLL state.
737 * 2. A special guarding logic is also required
738 * for event clearing mode "event" before the
739 * transaction enters ACPI_EC_COMMAND_POLL
742 if (!ec_transaction_polled(ec
) &&
743 !acpi_ec_guard_event(ec
))
745 if (wait_event_timeout(ec
->wait
,
746 ec_transaction_completed(ec
),
750 } while (time_before(jiffies
, timeout
));
754 static int ec_poll(struct acpi_ec
*ec
)
757 int repeat
= 5; /* number of command restarts */
760 unsigned long delay
= jiffies
+
761 msecs_to_jiffies(ec_delay
);
765 spin_lock_irqsave(&ec
->lock
, flags
);
766 advance_transaction(ec
);
767 spin_unlock_irqrestore(&ec
->lock
, flags
);
768 } while (time_before(jiffies
, delay
));
769 pr_debug("controller reset, restart transaction\n");
770 spin_lock_irqsave(&ec
->lock
, flags
);
771 start_transaction(ec
);
772 spin_unlock_irqrestore(&ec
->lock
, flags
);
777 static int acpi_ec_transaction_unlocked(struct acpi_ec
*ec
,
778 struct transaction
*t
)
783 /* start transaction */
784 spin_lock_irqsave(&ec
->lock
, tmp
);
785 /* Enable GPE for command processing (IBF=0/OBF=1) */
786 if (!acpi_ec_submit_flushable_request(ec
)) {
790 ec_dbg_ref(ec
, "Increase command");
791 /* following two actions should be kept atomic */
793 ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t
->command
));
794 start_transaction(ec
);
795 spin_unlock_irqrestore(&ec
->lock
, tmp
);
799 spin_lock_irqsave(&ec
->lock
, tmp
);
800 if (t
->irq_count
== ec_storm_threshold
)
801 acpi_ec_clear_storm(ec
, EC_FLAGS_COMMAND_STORM
);
802 ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t
->command
));
804 /* Disable GPE for command processing (IBF=0/OBF=1) */
805 acpi_ec_complete_request(ec
);
806 ec_dbg_ref(ec
, "Decrease command");
808 spin_unlock_irqrestore(&ec
->lock
, tmp
);
812 static int acpi_ec_transaction(struct acpi_ec
*ec
, struct transaction
*t
)
817 if (!ec
|| (!t
) || (t
->wlen
&& !t
->wdata
) || (t
->rlen
&& !t
->rdata
))
820 memset(t
->rdata
, 0, t
->rlen
);
822 mutex_lock(&ec
->mutex
);
823 if (ec
->global_lock
) {
824 status
= acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK
, &glk
);
825 if (ACPI_FAILURE(status
)) {
831 status
= acpi_ec_transaction_unlocked(ec
, t
);
834 acpi_release_global_lock(glk
);
836 mutex_unlock(&ec
->mutex
);
840 static int acpi_ec_burst_enable(struct acpi_ec
*ec
)
843 struct transaction t
= {.command
= ACPI_EC_BURST_ENABLE
,
844 .wdata
= NULL
, .rdata
= &d
,
845 .wlen
= 0, .rlen
= 1};
847 return acpi_ec_transaction(ec
, &t
);
850 static int acpi_ec_burst_disable(struct acpi_ec
*ec
)
852 struct transaction t
= {.command
= ACPI_EC_BURST_DISABLE
,
853 .wdata
= NULL
, .rdata
= NULL
,
854 .wlen
= 0, .rlen
= 0};
856 return (acpi_ec_read_status(ec
) & ACPI_EC_FLAG_BURST
) ?
857 acpi_ec_transaction(ec
, &t
) : 0;
860 static int acpi_ec_read(struct acpi_ec
*ec
, u8 address
, u8
*data
)
864 struct transaction t
= {.command
= ACPI_EC_COMMAND_READ
,
865 .wdata
= &address
, .rdata
= &d
,
866 .wlen
= 1, .rlen
= 1};
868 result
= acpi_ec_transaction(ec
, &t
);
873 static int acpi_ec_write(struct acpi_ec
*ec
, u8 address
, u8 data
)
875 u8 wdata
[2] = { address
, data
};
876 struct transaction t
= {.command
= ACPI_EC_COMMAND_WRITE
,
877 .wdata
= wdata
, .rdata
= NULL
,
878 .wlen
= 2, .rlen
= 0};
880 return acpi_ec_transaction(ec
, &t
);
883 int ec_read(u8 addr
, u8
*val
)
891 err
= acpi_ec_read(first_ec
, addr
, &temp_data
);
899 EXPORT_SYMBOL(ec_read
);
901 int ec_write(u8 addr
, u8 val
)
908 err
= acpi_ec_write(first_ec
, addr
, val
);
912 EXPORT_SYMBOL(ec_write
);
914 int ec_transaction(u8 command
,
915 const u8
*wdata
, unsigned wdata_len
,
916 u8
*rdata
, unsigned rdata_len
)
918 struct transaction t
= {.command
= command
,
919 .wdata
= wdata
, .rdata
= rdata
,
920 .wlen
= wdata_len
, .rlen
= rdata_len
};
925 return acpi_ec_transaction(first_ec
, &t
);
927 EXPORT_SYMBOL(ec_transaction
);
929 /* Get the handle to the EC device */
930 acpi_handle
ec_get_handle(void)
934 return first_ec
->handle
;
936 EXPORT_SYMBOL(ec_get_handle
);
938 static void acpi_ec_start(struct acpi_ec
*ec
, bool resuming
)
942 spin_lock_irqsave(&ec
->lock
, flags
);
943 if (!test_and_set_bit(EC_FLAGS_STARTED
, &ec
->flags
)) {
944 ec_dbg_drv("Starting EC");
945 /* Enable GPE for event processing (SCI_EVT=1) */
947 acpi_ec_submit_request(ec
);
948 ec_dbg_ref(ec
, "Increase driver");
950 ec_log_drv("EC started");
952 spin_unlock_irqrestore(&ec
->lock
, flags
);
955 static bool acpi_ec_stopped(struct acpi_ec
*ec
)
960 spin_lock_irqsave(&ec
->lock
, flags
);
961 flushed
= acpi_ec_flushed(ec
);
962 spin_unlock_irqrestore(&ec
->lock
, flags
);
966 static void acpi_ec_stop(struct acpi_ec
*ec
, bool suspending
)
970 spin_lock_irqsave(&ec
->lock
, flags
);
971 if (acpi_ec_started(ec
)) {
972 ec_dbg_drv("Stopping EC");
973 set_bit(EC_FLAGS_STOPPED
, &ec
->flags
);
974 spin_unlock_irqrestore(&ec
->lock
, flags
);
975 wait_event(ec
->wait
, acpi_ec_stopped(ec
));
976 spin_lock_irqsave(&ec
->lock
, flags
);
977 /* Disable GPE for event processing (SCI_EVT=1) */
979 acpi_ec_complete_request(ec
);
980 ec_dbg_ref(ec
, "Decrease driver");
981 } else if (!ec_freeze_events
)
982 __acpi_ec_disable_event(ec
);
983 clear_bit(EC_FLAGS_STARTED
, &ec
->flags
);
984 clear_bit(EC_FLAGS_STOPPED
, &ec
->flags
);
985 ec_log_drv("EC stopped");
987 spin_unlock_irqrestore(&ec
->lock
, flags
);
990 static void acpi_ec_enter_noirq(struct acpi_ec
*ec
)
994 spin_lock_irqsave(&ec
->lock
, flags
);
995 ec
->busy_polling
= true;
996 ec
->polling_guard
= 0;
997 ec_log_drv("interrupt blocked");
998 spin_unlock_irqrestore(&ec
->lock
, flags
);
1001 static void acpi_ec_leave_noirq(struct acpi_ec
*ec
)
1003 unsigned long flags
;
1005 spin_lock_irqsave(&ec
->lock
, flags
);
1006 ec
->busy_polling
= ec_busy_polling
;
1007 ec
->polling_guard
= ec_polling_guard
;
1008 ec_log_drv("interrupt unblocked");
1009 spin_unlock_irqrestore(&ec
->lock
, flags
);
1012 void acpi_ec_block_transactions(void)
1014 struct acpi_ec
*ec
= first_ec
;
1019 mutex_lock(&ec
->mutex
);
1020 /* Prevent transactions from being carried out */
1021 acpi_ec_stop(ec
, true);
1022 mutex_unlock(&ec
->mutex
);
1025 void acpi_ec_unblock_transactions(void)
1028 * Allow transactions to happen again (this function is called from
1029 * atomic context during wakeup, so we don't need to acquire the mutex).
1032 acpi_ec_start(first_ec
, true);
1035 /* --------------------------------------------------------------------------
1037 -------------------------------------------------------------------------- */
1038 static struct acpi_ec_query_handler
*
1039 acpi_ec_get_query_handler(struct acpi_ec_query_handler
*handler
)
1042 kref_get(&handler
->kref
);
1046 static struct acpi_ec_query_handler
*
1047 acpi_ec_get_query_handler_by_value(struct acpi_ec
*ec
, u8 value
)
1049 struct acpi_ec_query_handler
*handler
;
1052 mutex_lock(&ec
->mutex
);
1053 list_for_each_entry(handler
, &ec
->list
, node
) {
1054 if (value
== handler
->query_bit
) {
1059 mutex_unlock(&ec
->mutex
);
1060 return found
? acpi_ec_get_query_handler(handler
) : NULL
;
1063 static void acpi_ec_query_handler_release(struct kref
*kref
)
1065 struct acpi_ec_query_handler
*handler
=
1066 container_of(kref
, struct acpi_ec_query_handler
, kref
);
1071 static void acpi_ec_put_query_handler(struct acpi_ec_query_handler
*handler
)
1073 kref_put(&handler
->kref
, acpi_ec_query_handler_release
);
1076 int acpi_ec_add_query_handler(struct acpi_ec
*ec
, u8 query_bit
,
1077 acpi_handle handle
, acpi_ec_query_func func
,
1080 struct acpi_ec_query_handler
*handler
=
1081 kzalloc(sizeof(struct acpi_ec_query_handler
), GFP_KERNEL
);
1086 handler
->query_bit
= query_bit
;
1087 handler
->handle
= handle
;
1088 handler
->func
= func
;
1089 handler
->data
= data
;
1090 mutex_lock(&ec
->mutex
);
1091 kref_init(&handler
->kref
);
1092 list_add(&handler
->node
, &ec
->list
);
1093 mutex_unlock(&ec
->mutex
);
1096 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler
);
1098 static void acpi_ec_remove_query_handlers(struct acpi_ec
*ec
,
1099 bool remove_all
, u8 query_bit
)
1101 struct acpi_ec_query_handler
*handler
, *tmp
;
1102 LIST_HEAD(free_list
);
1104 mutex_lock(&ec
->mutex
);
1105 list_for_each_entry_safe(handler
, tmp
, &ec
->list
, node
) {
1106 if (remove_all
|| query_bit
== handler
->query_bit
) {
1107 list_del_init(&handler
->node
);
1108 list_add(&handler
->node
, &free_list
);
1111 mutex_unlock(&ec
->mutex
);
1112 list_for_each_entry_safe(handler
, tmp
, &free_list
, node
)
1113 acpi_ec_put_query_handler(handler
);
1116 void acpi_ec_remove_query_handler(struct acpi_ec
*ec
, u8 query_bit
)
1118 acpi_ec_remove_query_handlers(ec
, false, query_bit
);
1120 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler
);
1122 static struct acpi_ec_query
*acpi_ec_create_query(u8
*pval
)
1124 struct acpi_ec_query
*q
;
1125 struct transaction
*t
;
1127 q
= kzalloc(sizeof (struct acpi_ec_query
), GFP_KERNEL
);
1130 INIT_WORK(&q
->work
, acpi_ec_event_processor
);
1131 t
= &q
->transaction
;
1132 t
->command
= ACPI_EC_COMMAND_QUERY
;
1138 static void acpi_ec_delete_query(struct acpi_ec_query
*q
)
1142 acpi_ec_put_query_handler(q
->handler
);
1147 static void acpi_ec_event_processor(struct work_struct
*work
)
1149 struct acpi_ec_query
*q
= container_of(work
, struct acpi_ec_query
, work
);
1150 struct acpi_ec_query_handler
*handler
= q
->handler
;
1152 ec_dbg_evt("Query(0x%02x) started", handler
->query_bit
);
1154 handler
->func(handler
->data
);
1155 else if (handler
->handle
)
1156 acpi_evaluate_object(handler
->handle
, NULL
, NULL
, NULL
);
1157 ec_dbg_evt("Query(0x%02x) stopped", handler
->query_bit
);
1158 acpi_ec_delete_query(q
);
1161 static int acpi_ec_query(struct acpi_ec
*ec
, u8
*data
)
1165 struct acpi_ec_query
*q
;
1167 q
= acpi_ec_create_query(&value
);
1172 * Query the EC to find out which _Qxx method we need to evaluate.
1173 * Note that successful completion of the query causes the ACPI_EC_SCI
1174 * bit to be cleared (and thus clearing the interrupt source).
1176 result
= acpi_ec_transaction(ec
, &q
->transaction
);
1182 q
->handler
= acpi_ec_get_query_handler_by_value(ec
, value
);
1189 * It is reported that _Qxx are evaluated in a parallel way on
1191 * https://bugzilla.kernel.org/show_bug.cgi?id=94411
1193 * Put this log entry before schedule_work() in order to make
1194 * it appearing before any other log entries occurred during the
1195 * work queue execution.
1197 ec_dbg_evt("Query(0x%02x) scheduled", value
);
1198 if (!queue_work(ec_query_wq
, &q
->work
)) {
1199 ec_dbg_evt("Query(0x%02x) overlapped", value
);
1205 acpi_ec_delete_query(q
);
1211 static void acpi_ec_check_event(struct acpi_ec
*ec
)
1213 unsigned long flags
;
1215 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_EVENT
) {
1217 spin_lock_irqsave(&ec
->lock
, flags
);
1219 * Take care of the SCI_EVT unless no one else is
1220 * taking care of it.
1223 advance_transaction(ec
);
1224 spin_unlock_irqrestore(&ec
->lock
, flags
);
1229 static void acpi_ec_event_handler(struct work_struct
*work
)
1231 unsigned long flags
;
1232 struct acpi_ec
*ec
= container_of(work
, struct acpi_ec
, work
);
1234 ec_dbg_evt("Event started");
1236 spin_lock_irqsave(&ec
->lock
, flags
);
1237 while (ec
->nr_pending_queries
) {
1238 spin_unlock_irqrestore(&ec
->lock
, flags
);
1239 (void)acpi_ec_query(ec
, NULL
);
1240 spin_lock_irqsave(&ec
->lock
, flags
);
1241 ec
->nr_pending_queries
--;
1243 * Before exit, make sure that this work item can be
1244 * scheduled again. There might be QR_EC failures, leaving
1245 * EC_FLAGS_QUERY_PENDING uncleared and preventing this work
1246 * item from being scheduled again.
1248 if (!ec
->nr_pending_queries
) {
1249 if (ec_event_clearing
== ACPI_EC_EVT_TIMING_STATUS
||
1250 ec_event_clearing
== ACPI_EC_EVT_TIMING_QUERY
)
1251 acpi_ec_complete_query(ec
);
1254 spin_unlock_irqrestore(&ec
->lock
, flags
);
1256 ec_dbg_evt("Event stopped");
1258 acpi_ec_check_event(ec
);
1261 static u32
acpi_ec_gpe_handler(acpi_handle gpe_device
,
1262 u32 gpe_number
, void *data
)
1264 unsigned long flags
;
1265 struct acpi_ec
*ec
= data
;
1267 spin_lock_irqsave(&ec
->lock
, flags
);
1268 advance_transaction(ec
);
1269 spin_unlock_irqrestore(&ec
->lock
, flags
);
1270 return ACPI_INTERRUPT_HANDLED
;
1273 /* --------------------------------------------------------------------------
1274 * Address Space Management
1275 * -------------------------------------------------------------------------- */
1278 acpi_ec_space_handler(u32 function
, acpi_physical_address address
,
1279 u32 bits
, u64
*value64
,
1280 void *handler_context
, void *region_context
)
1282 struct acpi_ec
*ec
= handler_context
;
1283 int result
= 0, i
, bytes
= bits
/ 8;
1284 u8
*value
= (u8
*)value64
;
1286 if ((address
> 0xFF) || !value
|| !handler_context
)
1287 return AE_BAD_PARAMETER
;
1289 if (function
!= ACPI_READ
&& function
!= ACPI_WRITE
)
1290 return AE_BAD_PARAMETER
;
1292 if (ec
->busy_polling
|| bits
> 8)
1293 acpi_ec_burst_enable(ec
);
1295 for (i
= 0; i
< bytes
; ++i
, ++address
, ++value
)
1296 result
= (function
== ACPI_READ
) ?
1297 acpi_ec_read(ec
, address
, value
) :
1298 acpi_ec_write(ec
, address
, *value
);
1300 if (ec
->busy_polling
|| bits
> 8)
1301 acpi_ec_burst_disable(ec
);
1305 return AE_BAD_PARAMETER
;
1307 return AE_NOT_FOUND
;
1315 /* --------------------------------------------------------------------------
1317 * -------------------------------------------------------------------------- */
1320 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
);
1322 static void acpi_ec_free(struct acpi_ec
*ec
)
1331 static struct acpi_ec
*acpi_ec_alloc(void)
1333 struct acpi_ec
*ec
= kzalloc(sizeof(struct acpi_ec
), GFP_KERNEL
);
1337 mutex_init(&ec
->mutex
);
1338 init_waitqueue_head(&ec
->wait
);
1339 INIT_LIST_HEAD(&ec
->list
);
1340 spin_lock_init(&ec
->lock
);
1341 INIT_WORK(&ec
->work
, acpi_ec_event_handler
);
1342 ec
->timestamp
= jiffies
;
1343 ec
->busy_polling
= true;
1344 ec
->polling_guard
= 0;
1349 acpi_ec_register_query_methods(acpi_handle handle
, u32 level
,
1350 void *context
, void **return_value
)
1353 struct acpi_buffer buffer
= { sizeof(node_name
), node_name
};
1354 struct acpi_ec
*ec
= context
;
1358 status
= acpi_get_name(handle
, ACPI_SINGLE_NAME
, &buffer
);
1360 if (ACPI_SUCCESS(status
) && sscanf(node_name
, "_Q%x", &value
) == 1)
1361 acpi_ec_add_query_handler(ec
, value
, handle
, NULL
, NULL
);
1366 ec_parse_device(acpi_handle handle
, u32 Level
, void *context
, void **retval
)
1369 unsigned long long tmp
= 0;
1370 struct acpi_ec
*ec
= context
;
1372 /* clear addr values, ec_parse_io_ports depend on it */
1373 ec
->command_addr
= ec
->data_addr
= 0;
1375 status
= acpi_walk_resources(handle
, METHOD_NAME__CRS
,
1376 ec_parse_io_ports
, ec
);
1377 if (ACPI_FAILURE(status
))
1379 if (ec
->data_addr
== 0 || ec
->command_addr
== 0)
1382 if (boot_ec
&& boot_ec_is_ecdt
&& EC_FLAGS_IGNORE_DSDT_GPE
) {
1384 * Always inherit the GPE number setting from the ECDT
1387 ec
->gpe
= boot_ec
->gpe
;
1389 /* Get GPE bit assignment (EC events). */
1390 /* TODO: Add support for _GPE returning a package */
1391 status
= acpi_evaluate_integer(handle
, "_GPE", NULL
, &tmp
);
1392 if (ACPI_FAILURE(status
))
1396 /* Use the global lock for all EC transactions? */
1398 acpi_evaluate_integer(handle
, "_GLK", NULL
, &tmp
);
1399 ec
->global_lock
= tmp
;
1400 ec
->handle
= handle
;
1401 return AE_CTRL_TERMINATE
;
1405 * Note: This function returns an error code only when the address space
1406 * handler is not installed, which means "not able to handle
1409 static int ec_install_handlers(struct acpi_ec
*ec
, bool handle_events
)
1413 acpi_ec_start(ec
, false);
1415 if (!test_bit(EC_FLAGS_EC_HANDLER_INSTALLED
, &ec
->flags
)) {
1416 acpi_ec_enter_noirq(ec
);
1417 status
= acpi_install_address_space_handler(ec
->handle
,
1419 &acpi_ec_space_handler
,
1421 if (ACPI_FAILURE(status
)) {
1422 if (status
== AE_NOT_FOUND
) {
1424 * Maybe OS fails in evaluating the _REG
1425 * object. The AE_NOT_FOUND error will be
1426 * ignored and OS * continue to initialize
1429 pr_err("Fail in evaluating the _REG object"
1430 " of EC device. Broken bios is suspected.\n");
1432 acpi_ec_stop(ec
, false);
1436 set_bit(EC_FLAGS_EC_HANDLER_INSTALLED
, &ec
->flags
);
1442 if (!test_bit(EC_FLAGS_EVT_HANDLER_INSTALLED
, &ec
->flags
)) {
1443 /* Find and register all query methods */
1444 acpi_walk_namespace(ACPI_TYPE_METHOD
, ec
->handle
, 1,
1445 acpi_ec_register_query_methods
,
1447 set_bit(EC_FLAGS_EVT_HANDLER_INSTALLED
, &ec
->flags
);
1449 if (!test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED
, &ec
->flags
)) {
1450 status
= acpi_install_gpe_raw_handler(NULL
, ec
->gpe
,
1451 ACPI_GPE_EDGE_TRIGGERED
,
1452 &acpi_ec_gpe_handler
, ec
);
1453 /* This is not fatal as we can poll EC events */
1454 if (ACPI_SUCCESS(status
)) {
1455 set_bit(EC_FLAGS_GPE_HANDLER_INSTALLED
, &ec
->flags
);
1456 acpi_ec_leave_noirq(ec
);
1457 if (test_bit(EC_FLAGS_STARTED
, &ec
->flags
) &&
1458 ec
->reference_count
>= 1)
1459 acpi_ec_enable_gpe(ec
, true);
1461 /* EC is fully operational, allow queries */
1462 acpi_ec_enable_event(ec
);
1469 static void ec_remove_handlers(struct acpi_ec
*ec
)
1471 if (test_bit(EC_FLAGS_EC_HANDLER_INSTALLED
, &ec
->flags
)) {
1472 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec
->handle
,
1473 ACPI_ADR_SPACE_EC
, &acpi_ec_space_handler
)))
1474 pr_err("failed to remove space handler\n");
1475 clear_bit(EC_FLAGS_EC_HANDLER_INSTALLED
, &ec
->flags
);
1479 * Stops handling the EC transactions after removing the operation
1480 * region handler. This is required because _REG(DISCONNECT)
1481 * invoked during the removal can result in new EC transactions.
1483 * Flushes the EC requests and thus disables the GPE before
1484 * removing the GPE handler. This is required by the current ACPICA
1485 * GPE core. ACPICA GPE core will automatically disable a GPE when
1486 * it is indicated but there is no way to handle it. So the drivers
1487 * must disable the GPEs prior to removing the GPE handlers.
1489 acpi_ec_stop(ec
, false);
1491 if (test_bit(EC_FLAGS_GPE_HANDLER_INSTALLED
, &ec
->flags
)) {
1492 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL
, ec
->gpe
,
1493 &acpi_ec_gpe_handler
)))
1494 pr_err("failed to remove gpe handler\n");
1495 clear_bit(EC_FLAGS_GPE_HANDLER_INSTALLED
, &ec
->flags
);
1497 if (test_bit(EC_FLAGS_EVT_HANDLER_INSTALLED
, &ec
->flags
)) {
1498 acpi_ec_remove_query_handlers(ec
, true, 0);
1499 clear_bit(EC_FLAGS_EVT_HANDLER_INSTALLED
, &ec
->flags
);
1503 static int acpi_ec_setup(struct acpi_ec
*ec
, bool handle_events
)
1507 ret
= ec_install_handlers(ec
, handle_events
);
1511 /* First EC capable of handling transactions */
1514 acpi_handle_info(first_ec
->handle
, "Used as first EC\n");
1517 acpi_handle_info(ec
->handle
,
1518 "GPE=0x%lx, EC_CMD/EC_SC=0x%lx, EC_DATA=0x%lx\n",
1519 ec
->gpe
, ec
->command_addr
, ec
->data_addr
);
1523 static int acpi_config_boot_ec(struct acpi_ec
*ec
, acpi_handle handle
,
1524 bool handle_events
, bool is_ecdt
)
1529 * Changing the ACPI handle results in a re-configuration of the
1530 * boot EC. And if it happens after the namespace initialization,
1531 * it causes _REG evaluations.
1533 if (boot_ec
&& boot_ec
->handle
!= handle
)
1534 ec_remove_handlers(boot_ec
);
1536 /* Unset old boot EC */
1538 acpi_ec_free(boot_ec
);
1541 * ECDT device creation is split into acpi_ec_ecdt_probe() and
1542 * acpi_ec_ecdt_start(). This function takes care of completing the
1543 * ECDT parsing logic as the handle update should be performed
1544 * between the installation/uninstallation of the handlers.
1546 if (ec
->handle
!= handle
)
1547 ec
->handle
= handle
;
1549 ret
= acpi_ec_setup(ec
, handle_events
);
1553 /* Set new boot EC */
1556 boot_ec_is_ecdt
= is_ecdt
;
1559 acpi_handle_info(boot_ec
->handle
,
1560 "Used as boot %s EC to handle transactions%s\n",
1561 is_ecdt
? "ECDT" : "DSDT",
1562 handle_events
? " and events" : "");
1566 static bool acpi_ec_ecdt_get_handle(acpi_handle
*phandle
)
1568 struct acpi_table_ecdt
*ecdt_ptr
;
1572 status
= acpi_get_table(ACPI_SIG_ECDT
, 1,
1573 (struct acpi_table_header
**)&ecdt_ptr
);
1574 if (ACPI_FAILURE(status
))
1577 status
= acpi_get_handle(NULL
, ecdt_ptr
->id
, &handle
);
1578 if (ACPI_FAILURE(status
))
1585 static bool acpi_is_boot_ec(struct acpi_ec
*ec
)
1589 if (ec
->handle
== boot_ec
->handle
&&
1590 ec
->gpe
== boot_ec
->gpe
&&
1591 ec
->command_addr
== boot_ec
->command_addr
&&
1592 ec
->data_addr
== boot_ec
->data_addr
)
1597 static int acpi_ec_add(struct acpi_device
*device
)
1599 struct acpi_ec
*ec
= NULL
;
1602 strcpy(acpi_device_name(device
), ACPI_EC_DEVICE_NAME
);
1603 strcpy(acpi_device_class(device
), ACPI_EC_CLASS
);
1605 ec
= acpi_ec_alloc();
1608 if (ec_parse_device(device
->handle
, 0, ec
, NULL
) !=
1609 AE_CTRL_TERMINATE
) {
1614 if (acpi_is_boot_ec(ec
)) {
1615 boot_ec_is_ecdt
= false;
1616 acpi_handle_debug(ec
->handle
, "duplicated.\n");
1619 ret
= acpi_config_boot_ec(ec
, ec
->handle
, true, false);
1621 ret
= acpi_ec_setup(ec
, true);
1625 device
->driver_data
= ec
;
1627 ret
= !!request_region(ec
->data_addr
, 1, "EC data");
1628 WARN(!ret
, "Could not request EC data io port 0x%lx", ec
->data_addr
);
1629 ret
= !!request_region(ec
->command_addr
, 1, "EC cmd");
1630 WARN(!ret
, "Could not request EC cmd io port 0x%lx", ec
->command_addr
);
1632 /* Reprobe devices depending on the EC */
1633 acpi_walk_dep_device_list(ec
->handle
);
1634 acpi_handle_debug(ec
->handle
, "enumerated.\n");
1639 acpi_ec_remove_query_handlers(ec
, true, 0);
1646 static int acpi_ec_remove(struct acpi_device
*device
)
1653 ec
= acpi_driver_data(device
);
1654 release_region(ec
->data_addr
, 1);
1655 release_region(ec
->command_addr
, 1);
1656 device
->driver_data
= NULL
;
1657 if (ec
!= boot_ec
) {
1658 ec_remove_handlers(ec
);
1665 ec_parse_io_ports(struct acpi_resource
*resource
, void *context
)
1667 struct acpi_ec
*ec
= context
;
1669 if (resource
->type
!= ACPI_RESOURCE_TYPE_IO
)
1673 * The first address region returned is the data port, and
1674 * the second address region returned is the status/command
1677 if (ec
->data_addr
== 0)
1678 ec
->data_addr
= resource
->data
.io
.minimum
;
1679 else if (ec
->command_addr
== 0)
1680 ec
->command_addr
= resource
->data
.io
.minimum
;
1682 return AE_CTRL_TERMINATE
;
1687 static const struct acpi_device_id ec_device_ids
[] = {
1693 * This function is not Windows-compatible as Windows never enumerates the
1694 * namespace EC before the main ACPI device enumeration process. It is
1695 * retained for historical reason and will be deprecated in the future.
1697 int __init
acpi_ec_dsdt_probe(void)
1704 * If a platform has ECDT, there is no need to proceed as the
1705 * following probe is not a part of the ACPI device enumeration,
1706 * executing _STA is not safe, and thus this probe may risk of
1707 * picking up an invalid EC device.
1712 ec
= acpi_ec_alloc();
1716 * At this point, the namespace is initialized, so start to find
1717 * the namespace objects.
1719 status
= acpi_get_devices(ec_device_ids
[0].id
,
1720 ec_parse_device
, ec
, NULL
);
1721 if (ACPI_FAILURE(status
) || !ec
->handle
) {
1726 * When the DSDT EC is available, always re-configure boot EC to
1727 * have _REG evaluated. _REG can only be evaluated after the
1728 * namespace initialization.
1729 * At this point, the GPE is not fully initialized, so do not to
1730 * handle the events.
1732 ret
= acpi_config_boot_ec(ec
, ec
->handle
, false, false);
1740 * If the DSDT EC is not functioning, we still need to prepare a fully
1741 * functioning ECDT EC first in order to handle the events.
1742 * https://bugzilla.kernel.org/show_bug.cgi?id=115021
1744 int __init
acpi_ec_ecdt_start(void)
1751 * The DSDT EC should have already been started in
1754 if (!boot_ec_is_ecdt
)
1758 * At this point, the namespace and the GPE is initialized, so
1759 * start to find the namespace objects and handle the events.
1761 if (!acpi_ec_ecdt_get_handle(&handle
))
1763 return acpi_config_boot_ec(boot_ec
, handle
, true, true);
1768 * Some EC firmware variations refuses to respond QR_EC when SCI_EVT is not
1769 * set, for which case, we complete the QR_EC without issuing it to the
1771 * https://bugzilla.kernel.org/show_bug.cgi?id=82611
1772 * https://bugzilla.kernel.org/show_bug.cgi?id=97381
1774 static int ec_flag_query_handshake(const struct dmi_system_id
*id
)
1776 pr_debug("Detected the EC firmware requiring QR_EC issued when SCI_EVT set\n");
1777 EC_FLAGS_QUERY_HANDSHAKE
= 1;
1783 * Some ECDTs contain wrong register addresses.
1785 * https://bugzilla.kernel.org/show_bug.cgi?id=12461
1787 static int ec_correct_ecdt(const struct dmi_system_id
*id
)
1789 pr_debug("Detected system needing ECDT address correction.\n");
1790 EC_FLAGS_CORRECT_ECDT
= 1;
1795 * Some DSDTs contain wrong GPE setting.
1796 * Asus FX502VD/VE, GL702VMK, X550VXK, X580VD
1797 * https://bugzilla.kernel.org/show_bug.cgi?id=195651
1799 static int ec_honor_ecdt_gpe(const struct dmi_system_id
*id
)
1801 pr_debug("Detected system needing ignore DSDT GPE setting.\n");
1802 EC_FLAGS_IGNORE_DSDT_GPE
= 1;
1806 static struct dmi_system_id ec_dmi_table
[] __initdata
= {
1808 ec_correct_ecdt
, "MSI MS-171F", {
1809 DMI_MATCH(DMI_SYS_VENDOR
, "Micro-Star"),
1810 DMI_MATCH(DMI_PRODUCT_NAME
, "MS-171F"),}, NULL
},
1812 ec_honor_ecdt_gpe
, "ASUS FX502VD", {
1813 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK COMPUTER INC."),
1814 DMI_MATCH(DMI_PRODUCT_NAME
, "FX502VD"),}, NULL
},
1816 ec_honor_ecdt_gpe
, "ASUS FX502VE", {
1817 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK COMPUTER INC."),
1818 DMI_MATCH(DMI_PRODUCT_NAME
, "FX502VE"),}, NULL
},
1820 ec_honor_ecdt_gpe
, "ASUS GL702VMK", {
1821 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK COMPUTER INC."),
1822 DMI_MATCH(DMI_PRODUCT_NAME
, "GL702VMK"),}, NULL
},
1824 ec_honor_ecdt_gpe
, "ASUS X550VXK", {
1825 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK COMPUTER INC."),
1826 DMI_MATCH(DMI_PRODUCT_NAME
, "X550VXK"),}, NULL
},
1828 ec_honor_ecdt_gpe
, "ASUS X580VD", {
1829 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK COMPUTER INC."),
1830 DMI_MATCH(DMI_PRODUCT_NAME
, "X580VD"),}, NULL
},
1834 int __init
acpi_ec_ecdt_probe(void)
1838 struct acpi_table_ecdt
*ecdt_ptr
;
1841 ec
= acpi_ec_alloc();
1845 * Generate a boot ec context
1847 dmi_check_system(ec_dmi_table
);
1848 status
= acpi_get_table(ACPI_SIG_ECDT
, 1,
1849 (struct acpi_table_header
**)&ecdt_ptr
);
1850 if (ACPI_FAILURE(status
)) {
1855 if (!ecdt_ptr
->control
.address
|| !ecdt_ptr
->data
.address
) {
1858 * https://bugzilla.kernel.org/show_bug.cgi?id=11880
1864 if (EC_FLAGS_CORRECT_ECDT
) {
1865 ec
->command_addr
= ecdt_ptr
->data
.address
;
1866 ec
->data_addr
= ecdt_ptr
->control
.address
;
1868 ec
->command_addr
= ecdt_ptr
->control
.address
;
1869 ec
->data_addr
= ecdt_ptr
->data
.address
;
1871 ec
->gpe
= ecdt_ptr
->gpe
;
1874 * At this point, the namespace is not initialized, so do not find
1875 * the namespace objects, or handle the events.
1877 ret
= acpi_config_boot_ec(ec
, ACPI_ROOT_OBJECT
, false, true);
1884 #ifdef CONFIG_PM_SLEEP
1885 static int acpi_ec_suspend(struct device
*dev
)
1887 struct acpi_ec
*ec
=
1888 acpi_driver_data(to_acpi_device(dev
));
1890 if (acpi_sleep_no_ec_events() && ec_freeze_events
)
1891 acpi_ec_disable_event(ec
);
1895 static int acpi_ec_suspend_noirq(struct device
*dev
)
1897 struct acpi_ec
*ec
= acpi_driver_data(to_acpi_device(dev
));
1900 * The SCI handler doesn't run at this point, so the GPE can be
1901 * masked at the low level without side effects.
1903 if (ec_no_wakeup
&& test_bit(EC_FLAGS_STARTED
, &ec
->flags
) &&
1904 ec
->reference_count
>= 1)
1905 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_DISABLE
);
1910 static int acpi_ec_resume_noirq(struct device
*dev
)
1912 struct acpi_ec
*ec
= acpi_driver_data(to_acpi_device(dev
));
1914 if (ec_no_wakeup
&& test_bit(EC_FLAGS_STARTED
, &ec
->flags
) &&
1915 ec
->reference_count
>= 1)
1916 acpi_set_gpe(NULL
, ec
->gpe
, ACPI_GPE_ENABLE
);
1921 static int acpi_ec_resume(struct device
*dev
)
1923 struct acpi_ec
*ec
=
1924 acpi_driver_data(to_acpi_device(dev
));
1926 acpi_ec_enable_event(ec
);
1931 static const struct dev_pm_ops acpi_ec_pm
= {
1932 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend_noirq
, acpi_ec_resume_noirq
)
1933 SET_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend
, acpi_ec_resume
)
1936 static int param_set_event_clearing(const char *val
, struct kernel_param
*kp
)
1940 if (!strncmp(val
, "status", sizeof("status") - 1)) {
1941 ec_event_clearing
= ACPI_EC_EVT_TIMING_STATUS
;
1942 pr_info("Assuming SCI_EVT clearing on EC_SC accesses\n");
1943 } else if (!strncmp(val
, "query", sizeof("query") - 1)) {
1944 ec_event_clearing
= ACPI_EC_EVT_TIMING_QUERY
;
1945 pr_info("Assuming SCI_EVT clearing on QR_EC writes\n");
1946 } else if (!strncmp(val
, "event", sizeof("event") - 1)) {
1947 ec_event_clearing
= ACPI_EC_EVT_TIMING_EVENT
;
1948 pr_info("Assuming SCI_EVT clearing on event reads\n");
1954 static int param_get_event_clearing(char *buffer
, struct kernel_param
*kp
)
1956 switch (ec_event_clearing
) {
1957 case ACPI_EC_EVT_TIMING_STATUS
:
1958 return sprintf(buffer
, "status");
1959 case ACPI_EC_EVT_TIMING_QUERY
:
1960 return sprintf(buffer
, "query");
1961 case ACPI_EC_EVT_TIMING_EVENT
:
1962 return sprintf(buffer
, "event");
1964 return sprintf(buffer
, "invalid");
1969 module_param_call(ec_event_clearing
, param_set_event_clearing
, param_get_event_clearing
,
1971 MODULE_PARM_DESC(ec_event_clearing
, "Assumed SCI_EVT clearing timing");
1973 static struct acpi_driver acpi_ec_driver
= {
1975 .class = ACPI_EC_CLASS
,
1976 .ids
= ec_device_ids
,
1979 .remove
= acpi_ec_remove
,
1981 .drv
.pm
= &acpi_ec_pm
,
1984 static inline int acpi_ec_query_init(void)
1987 ec_query_wq
= alloc_workqueue("kec_query", 0,
1995 static inline void acpi_ec_query_exit(void)
1998 destroy_workqueue(ec_query_wq
);
2003 int __init
acpi_ec_init(void)
2007 /* register workqueue for _Qxx evaluations */
2008 result
= acpi_ec_query_init();
2011 /* Now register the driver for the EC */
2012 result
= acpi_bus_register_driver(&acpi_ec_driver
);
2018 acpi_ec_query_exit();
2022 /* EC driver currently not unloadable */
2024 static void __exit
acpi_ec_exit(void)
2027 acpi_bus_unregister_driver(&acpi_ec_driver
);
2028 acpi_ec_query_exit();