ACPI: APEI: Put the HEST table for error path
[linux-block.git] / drivers / acpi / ec.c
CommitLineData
c942fddf 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 2/*
a8d4fc22 3 * ec.c - ACPI Embedded Controller Driver (v3)
1da177e4 4 *
a8d4fc22
LZ
5 * Copyright (C) 2001-2015 Intel Corporation
6 * Author: 2014, 2015 Lv Zheng <lv.zheng@intel.com>
4a3f6b5b
LZ
7 * 2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
8 * 2006 Denis Sadykov <denis.m.sadykov@intel.com>
9 * 2004 Luming Yu <luming.yu@intel.com>
10 * 2001, 2002 Andy Grover <andrew.grover@intel.com>
11 * 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
12 * Copyright (C) 2008 Alexey Starikovskiy <astarikovskiy@suse.de>
1da177e4
LT
13 */
14
7c6db4e0 15/* Uncomment next line to get verbose printout */
d772b3b3 16/* #define DEBUG */
b6aeab44 17#define pr_fmt(fmt) "ACPI: EC: " fmt
d772b3b3 18
1da177e4
LT
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/init.h>
22#include <linux/types.h>
23#include <linux/delay.h>
451566f4 24#include <linux/interrupt.h>
837012ed 25#include <linux/list.h>
7c6db4e0 26#include <linux/spinlock.h>
5a0e3ad6 27#include <linux/slab.h>
10a08fd6 28#include <linux/suspend.h>
8b48463f 29#include <linux/acpi.h>
eb27cae8 30#include <linux/dmi.h>
8b48463f 31#include <asm/io.h>
1da177e4 32
1195a098
TR
33#include "internal.h"
34
1da177e4 35#define ACPI_EC_CLASS "embedded_controller"
1da177e4
LT
36#define ACPI_EC_DEVICE_NAME "Embedded Controller"
37#define ACPI_EC_FILE_INFO "info"
837012ed 38
703959d4 39/* EC status register */
1da177e4
LT
40#define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
41#define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
dd43de20 42#define ACPI_EC_FLAG_CMD 0x08 /* Input buffer contains a command */
451566f4 43#define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
1da177e4 44#define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
4350933a 45
1d68d261
LZ
46/*
47 * The SCI_EVT clearing timing is not defined by the ACPI specification.
48 * This leads to lots of practical timing issues for the host EC driver.
49 * The following variations are defined (from the target EC firmware's
50 * perspective):
51 * STATUS: After indicating SCI_EVT edge triggered IRQ to the host, the
52 * target can clear SCI_EVT at any time so long as the host can see
53 * the indication by reading the status register (EC_SC). So the
54 * host should re-check SCI_EVT after the first time the SCI_EVT
55 * indication is seen, which is the same time the query request
56 * (QR_EC) is written to the command register (EC_CMD). SCI_EVT set
57 * at any later time could indicate another event. Normally such
58 * kind of EC firmware has implemented an event queue and will
59 * return 0x00 to indicate "no outstanding event".
60 * QUERY: After seeing the query request (QR_EC) written to the command
61 * register (EC_CMD) by the host and having prepared the responding
62 * event value in the data register (EC_DATA), the target can safely
63 * clear SCI_EVT because the target can confirm that the current
64 * event is being handled by the host. The host then should check
65 * SCI_EVT right after reading the event response from the data
66 * register (EC_DATA).
67 * EVENT: After seeing the event response read from the data register
68 * (EC_DATA) by the host, the target can clear SCI_EVT. As the
69 * target requires time to notice the change in the data register
70 * (EC_DATA), the host may be required to wait additional guarding
71 * time before checking the SCI_EVT again. Such guarding may not be
72 * necessary if the host is notified via another IRQ.
73 */
74#define ACPI_EC_EVT_TIMING_STATUS 0x00
75#define ACPI_EC_EVT_TIMING_QUERY 0x01
76#define ACPI_EC_EVT_TIMING_EVENT 0x02
77
703959d4 78/* EC commands */
3261ff4d 79enum ec_command {
6ccedb10
AS
80 ACPI_EC_COMMAND_READ = 0x80,
81 ACPI_EC_COMMAND_WRITE = 0x81,
82 ACPI_EC_BURST_ENABLE = 0x82,
83 ACPI_EC_BURST_DISABLE = 0x83,
84 ACPI_EC_COMMAND_QUERY = 0x84,
3261ff4d 85};
837012ed 86
5c406412 87#define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
703959d4 88#define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
d8d031a6 89#define ACPI_EC_UDELAY_POLL 550 /* Wait 1ms for EC transaction polling */
ad332c8a
KC
90#define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
91 * when trying to clear the EC */
e1191bd4 92#define ACPI_EC_MAX_QUERIES 16 /* Maximum number of parallel queries */
703959d4 93
080e412c 94enum {
750f628b 95 EC_FLAGS_QUERY_ENABLED, /* Query is enabled */
37d11391 96 EC_FLAGS_QUERY_PENDING, /* Query is pending */
1d68d261 97 EC_FLAGS_QUERY_GUARDING, /* Guard for SCI_EVT check */
4446abc9 98 EC_FLAGS_EVENT_HANDLER_INSTALLED, /* Event handler installed */
0e1affe4 99 EC_FLAGS_EC_HANDLER_INSTALLED, /* OpReg handler installed */
4446abc9 100 EC_FLAGS_QUERY_METHODS_INSTALLED, /* _Qxx handlers installed */
ad479e7f
LZ
101 EC_FLAGS_STARTED, /* Driver is started */
102 EC_FLAGS_STOPPED, /* Driver is stopped */
4446abc9 103 EC_FLAGS_EVENTS_MASKED, /* Events masked */
1da177e4 104};
6ffb221a 105
f92fca00
LZ
106#define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
107#define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
108
7a18e96d
TR
109/* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
110static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
111module_param(ec_delay, uint, 0644);
112MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
113
e1191bd4
LZ
114static unsigned int ec_max_queries __read_mostly = ACPI_EC_MAX_QUERIES;
115module_param(ec_max_queries, uint, 0644);
116MODULE_PARM_DESC(ec_max_queries, "Maximum parallel _Qxx evaluations");
117
15de603b
LZ
118static bool ec_busy_polling __read_mostly;
119module_param(ec_busy_polling, bool, 0644);
120MODULE_PARM_DESC(ec_busy_polling, "Use busy polling to advance EC transaction");
121
122static unsigned int ec_polling_guard __read_mostly = ACPI_EC_UDELAY_POLL;
123module_param(ec_polling_guard, uint, 0644);
124MODULE_PARM_DESC(ec_polling_guard, "Guard time(us) between EC accesses in polling modes");
125
3cb02aeb 126static unsigned int ec_event_clearing __read_mostly = ACPI_EC_EVT_TIMING_QUERY;
1d68d261 127
a520d52e
FT
128/*
129 * If the number of false interrupts per one transaction exceeds
130 * this threshold, will think there is a GPE storm happened and
131 * will disable the GPE for normal transaction.
132 */
133static unsigned int ec_storm_threshold __read_mostly = 8;
134module_param(ec_storm_threshold, uint, 0644);
135MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm");
136
9c40f956 137static bool ec_freeze_events __read_mostly = false;
39a2a2aa
LZ
138module_param(ec_freeze_events, bool, 0644);
139MODULE_PARM_DESC(ec_freeze_events, "Disabling event handling during suspend/resume");
140
76380636
RW
141static bool ec_no_wakeup __read_mostly;
142module_param(ec_no_wakeup, bool, 0644);
143MODULE_PARM_DESC(ec_no_wakeup, "Do not wake up from suspend-to-idle");
144
837012ed
AS
145struct acpi_ec_query_handler {
146 struct list_head node;
147 acpi_ec_query_func func;
148 acpi_handle handle;
149 void *data;
150 u8 query_bit;
01305d41 151 struct kref kref;
837012ed
AS
152};
153
8463200a 154struct transaction {
7c6db4e0
AS
155 const u8 *wdata;
156 u8 *rdata;
157 unsigned short irq_count;
8463200a 158 u8 command;
a2f93aea
AS
159 u8 wi;
160 u8 ri;
7c6db4e0
AS
161 u8 wlen;
162 u8 rlen;
f92fca00 163 u8 flags;
7c6db4e0
AS
164};
165
02b771b6
LZ
166struct acpi_ec_query {
167 struct transaction transaction;
168 struct work_struct work;
169 struct acpi_ec_query_handler *handler;
170};
171
550b3aac 172static int acpi_ec_query(struct acpi_ec *ec, u8 *data);
ca37bfdf 173static void advance_transaction(struct acpi_ec *ec);
02b771b6
LZ
174static void acpi_ec_event_handler(struct work_struct *work);
175static void acpi_ec_event_processor(struct work_struct *work);
74443bbe 176
a9c30768 177struct acpi_ec *first_ec;
1195a098 178EXPORT_SYMBOL(first_ec);
a9c30768
RW
179
180static struct acpi_ec *boot_ec;
72c77b7e 181static bool boot_ec_is_ecdt = false;
f0ac20c3 182static struct workqueue_struct *ec_wq;
e1191bd4 183static struct workqueue_struct *ec_query_wq;
703959d4 184
59f0aa94 185static int EC_FLAGS_CORRECT_ECDT; /* Needs ECDT port address correction */
440f53da 186static int EC_FLAGS_IGNORE_DSDT_GPE; /* Needs ECDT GPE as correction setting */
b6a3e147 187static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */
5423a0cb 188
3535a3c1
LZ
189/* --------------------------------------------------------------------------
190 * Logging/Debugging
191 * -------------------------------------------------------------------------- */
192
193/*
194 * Splitters used by the developers to track the boundary of the EC
195 * handling processes.
196 */
197#ifdef DEBUG
198#define EC_DBG_SEP " "
199#define EC_DBG_DRV "+++++"
200#define EC_DBG_STM "====="
201#define EC_DBG_REQ "*****"
202#define EC_DBG_EVT "#####"
203#else
204#define EC_DBG_SEP ""
205#define EC_DBG_DRV
206#define EC_DBG_STM
207#define EC_DBG_REQ
208#define EC_DBG_EVT
209#endif
210
211#define ec_log_raw(fmt, ...) \
212 pr_info(fmt "\n", ##__VA_ARGS__)
213#define ec_dbg_raw(fmt, ...) \
214 pr_debug(fmt "\n", ##__VA_ARGS__)
215#define ec_log(filter, fmt, ...) \
216 ec_log_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
217#define ec_dbg(filter, fmt, ...) \
218 ec_dbg_raw(filter EC_DBG_SEP fmt EC_DBG_SEP filter, ##__VA_ARGS__)
219
220#define ec_log_drv(fmt, ...) \
221 ec_log(EC_DBG_DRV, fmt, ##__VA_ARGS__)
222#define ec_dbg_drv(fmt, ...) \
223 ec_dbg(EC_DBG_DRV, fmt, ##__VA_ARGS__)
224#define ec_dbg_stm(fmt, ...) \
225 ec_dbg(EC_DBG_STM, fmt, ##__VA_ARGS__)
226#define ec_dbg_req(fmt, ...) \
227 ec_dbg(EC_DBG_REQ, fmt, ##__VA_ARGS__)
228#define ec_dbg_evt(fmt, ...) \
229 ec_dbg(EC_DBG_EVT, fmt, ##__VA_ARGS__)
770970f0
LZ
230#define ec_dbg_ref(ec, fmt, ...) \
231 ec_dbg_raw("%lu: " fmt, ec->reference_count, ## __VA_ARGS__)
3535a3c1 232
ad479e7f
LZ
233/* --------------------------------------------------------------------------
234 * Device Flags
235 * -------------------------------------------------------------------------- */
236
237static bool acpi_ec_started(struct acpi_ec *ec)
238{
239 return test_bit(EC_FLAGS_STARTED, &ec->flags) &&
240 !test_bit(EC_FLAGS_STOPPED, &ec->flags);
241}
242
750f628b
LZ
243static bool acpi_ec_event_enabled(struct acpi_ec *ec)
244{
245 /*
246 * There is an OSPM early stage logic. During the early stages
247 * (boot/resume), OSPMs shouldn't enable the event handling, only
248 * the EC transactions are allowed to be performed.
249 */
250 if (!test_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
251 return false;
252 /*
39a2a2aa
LZ
253 * However, disabling the event handling is experimental for late
254 * stage (suspend), and is controlled by the boot parameter of
255 * "ec_freeze_events":
256 * 1. true: The EC event handling is disabled before entering
257 * the noirq stage.
258 * 2. false: The EC event handling is automatically disabled as
259 * soon as the EC driver is stopped.
750f628b 260 */
39a2a2aa
LZ
261 if (ec_freeze_events)
262 return acpi_ec_started(ec);
263 else
264 return test_bit(EC_FLAGS_STARTED, &ec->flags);
750f628b
LZ
265}
266
9887d22a
LZ
267static bool acpi_ec_flushed(struct acpi_ec *ec)
268{
269 return ec->reference_count == 1;
270}
271
1da177e4 272/* --------------------------------------------------------------------------
ca37bfdf 273 * EC Registers
7a73e60e 274 * -------------------------------------------------------------------------- */
1da177e4 275
6ffb221a 276static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
1da177e4 277{
3ebe08a7 278 u8 x = inb(ec->command_addr);
7a73e60e 279
3535a3c1
LZ
280 ec_dbg_raw("EC_SC(R) = 0x%2.2x "
281 "SCI_EVT=%d BURST=%d CMD=%d IBF=%d OBF=%d",
282 x,
283 !!(x & ACPI_EC_FLAG_SCI),
284 !!(x & ACPI_EC_FLAG_BURST),
285 !!(x & ACPI_EC_FLAG_CMD),
286 !!(x & ACPI_EC_FLAG_IBF),
287 !!(x & ACPI_EC_FLAG_OBF));
3ebe08a7 288 return x;
451566f4
DT
289}
290
6ffb221a 291static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
703959d4 292{
3ebe08a7 293 u8 x = inb(ec->data_addr);
7a73e60e 294
d8d031a6 295 ec->timestamp = jiffies;
3535a3c1 296 ec_dbg_raw("EC_DATA(R) = 0x%2.2x", x);
7c6db4e0 297 return x;
7c6db5e5
DS
298}
299
6ffb221a 300static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
45bea155 301{
3535a3c1 302 ec_dbg_raw("EC_SC(W) = 0x%2.2x", command);
6ffb221a 303 outb(command, ec->command_addr);
d8d031a6 304 ec->timestamp = jiffies;
45bea155
LY
305}
306
6ffb221a 307static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
45bea155 308{
3535a3c1 309 ec_dbg_raw("EC_DATA(W) = 0x%2.2x", data);
6ffb221a 310 outb(data, ec->data_addr);
d8d031a6 311 ec->timestamp = jiffies;
703959d4 312}
45bea155 313
4625d752 314#if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
e34c0e2b
LZ
315static const char *acpi_ec_cmd_string(u8 cmd)
316{
317 switch (cmd) {
318 case 0x80:
319 return "RD_EC";
320 case 0x81:
321 return "WR_EC";
322 case 0x82:
323 return "BE_EC";
324 case 0x83:
325 return "BD_EC";
326 case 0x84:
327 return "QR_EC";
328 }
329 return "UNKNOWN";
330}
331#else
332#define acpi_ec_cmd_string(cmd) "UNDEF"
333#endif
334
ca37bfdf
LZ
335/* --------------------------------------------------------------------------
336 * GPE Registers
337 * -------------------------------------------------------------------------- */
338
339static inline bool acpi_ec_is_gpe_raised(struct acpi_ec *ec)
340{
341 acpi_event_status gpe_status = 0;
342
343 (void)acpi_get_gpe_status(NULL, ec->gpe, &gpe_status);
7c0b2595 344 return (gpe_status & ACPI_EVENT_FLAG_STATUS_SET) ? true : false;
ca37bfdf
LZ
345}
346
347static inline void acpi_ec_enable_gpe(struct acpi_ec *ec, bool open)
348{
349 if (open)
350 acpi_enable_gpe(NULL, ec->gpe);
e1d4d90f
LZ
351 else {
352 BUG_ON(ec->reference_count < 1);
ca37bfdf 353 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
e1d4d90f 354 }
ca37bfdf
LZ
355 if (acpi_ec_is_gpe_raised(ec)) {
356 /*
357 * On some platforms, EN=1 writes cannot trigger GPE. So
358 * software need to manually trigger a pseudo GPE event on
359 * EN=1 writes.
360 */
3535a3c1 361 ec_dbg_raw("Polling quirk");
ca37bfdf
LZ
362 advance_transaction(ec);
363 }
364}
365
366static inline void acpi_ec_disable_gpe(struct acpi_ec *ec, bool close)
367{
368 if (close)
369 acpi_disable_gpe(NULL, ec->gpe);
e1d4d90f
LZ
370 else {
371 BUG_ON(ec->reference_count < 1);
ca37bfdf 372 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
e1d4d90f 373 }
ca37bfdf
LZ
374}
375
376static inline void acpi_ec_clear_gpe(struct acpi_ec *ec)
377{
378 /*
379 * GPE STS is a W1C register, which means:
380 * 1. Software can clear it without worrying about clearing other
381 * GPEs' STS bits when the hardware sets them in parallel.
382 * 2. As long as software can ensure only clearing it when it is
383 * set, hardware won't set it in parallel.
384 * So software can clear GPE in any contexts.
385 * Warning: do not move the check into advance_transaction() as the
386 * EC commands will be sent without GPE raised.
387 */
388 if (!acpi_ec_is_gpe_raised(ec))
389 return;
390 acpi_clear_gpe(NULL, ec->gpe);
391}
392
393/* --------------------------------------------------------------------------
394 * Transaction Management
395 * -------------------------------------------------------------------------- */
396
9887d22a
LZ
397static void acpi_ec_submit_request(struct acpi_ec *ec)
398{
399 ec->reference_count++;
4446abc9 400 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags) &&
406857f7 401 ec->gpe >= 0 && ec->reference_count == 1)
9887d22a
LZ
402 acpi_ec_enable_gpe(ec, true);
403}
404
405static void acpi_ec_complete_request(struct acpi_ec *ec)
406{
407 bool flushed = false;
408
409 ec->reference_count--;
4446abc9 410 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags) &&
406857f7 411 ec->gpe >= 0 && ec->reference_count == 0)
9887d22a
LZ
412 acpi_ec_disable_gpe(ec, true);
413 flushed = acpi_ec_flushed(ec);
414 if (flushed)
415 wake_up(&ec->wait);
416}
417
4446abc9 418static void acpi_ec_mask_events(struct acpi_ec *ec)
e1d4d90f 419{
4446abc9 420 if (!test_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags)) {
406857f7
DD
421 if (ec->gpe >= 0)
422 acpi_ec_disable_gpe(ec, false);
423 else
424 disable_irq_nosync(ec->irq);
425
3535a3c1 426 ec_dbg_drv("Polling enabled");
4446abc9 427 set_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags);
e1d4d90f
LZ
428 }
429}
430
4446abc9 431static void acpi_ec_unmask_events(struct acpi_ec *ec)
e1d4d90f 432{
4446abc9
DD
433 if (test_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags)) {
434 clear_bit(EC_FLAGS_EVENTS_MASKED, &ec->flags);
406857f7
DD
435 if (ec->gpe >= 0)
436 acpi_ec_enable_gpe(ec, false);
437 else
438 enable_irq(ec->irq);
439
3535a3c1 440 ec_dbg_drv("Polling disabled");
e1d4d90f
LZ
441 }
442}
443
9887d22a
LZ
444/*
445 * acpi_ec_submit_flushable_request() - Increase the reference count unless
446 * the flush operation is not in
447 * progress
448 * @ec: the EC device
449 *
450 * This function must be used before taking a new action that should hold
451 * the reference count. If this function returns false, then the action
452 * must be discarded or it will prevent the flush operation from being
453 * completed.
454 */
37d11391 455static bool acpi_ec_submit_flushable_request(struct acpi_ec *ec)
9887d22a 456{
37d11391
RW
457 if (!acpi_ec_started(ec))
458 return false;
9887d22a
LZ
459 acpi_ec_submit_request(ec);
460 return true;
461}
462
37d11391 463static void acpi_ec_submit_query(struct acpi_ec *ec)
74443bbe 464{
4446abc9 465 acpi_ec_mask_events(ec);
1ab69f27
LZ
466 if (!acpi_ec_event_enabled(ec))
467 return;
468 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
9d8993be
LZ
469 ec_dbg_evt("Command(%s) submitted/blocked",
470 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
471 ec->nr_pending_queries++;
f0ac20c3 472 queue_work(ec_wq, &ec->work);
74443bbe
LZ
473 }
474}
475
37d11391 476static void acpi_ec_complete_query(struct acpi_ec *ec)
74443bbe 477{
1ab69f27 478 if (test_and_clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
9d8993be
LZ
479 ec_dbg_evt("Command(%s) unblocked",
480 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
4446abc9 481 acpi_ec_unmask_events(ec);
74443bbe
LZ
482}
483
750f628b
LZ
484static inline void __acpi_ec_enable_event(struct acpi_ec *ec)
485{
486 if (!test_and_set_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
487 ec_log_drv("event unblocked");
53c5eaab
LZ
488 /*
489 * Unconditionally invoke this once after enabling the event
490 * handling mechanism to detect the pending events.
491 */
492 advance_transaction(ec);
750f628b
LZ
493}
494
495static inline void __acpi_ec_disable_event(struct acpi_ec *ec)
496{
497 if (test_and_clear_bit(EC_FLAGS_QUERY_ENABLED, &ec->flags))
498 ec_log_drv("event blocked");
499}
500
b6a3e147
ZR
501/*
502 * Process _Q events that might have accumulated in the EC.
503 * Run with locked ec mutex.
504 */
505static void acpi_ec_clear(struct acpi_ec *ec)
506{
507 int i, status;
508 u8 value = 0;
509
510 for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) {
511 status = acpi_ec_query(ec, &value);
512 if (status || !value)
513 break;
514 }
515 if (unlikely(i == ACPI_EC_CLEAR_MAX))
516 pr_warn("Warning: Maximum of %d stale EC events cleared\n", i);
517 else
518 pr_info("%d stale EC events cleared\n", i);
519}
520
750f628b
LZ
521static void acpi_ec_enable_event(struct acpi_ec *ec)
522{
523 unsigned long flags;
524
525 spin_lock_irqsave(&ec->lock, flags);
526 if (acpi_ec_started(ec))
527 __acpi_ec_enable_event(ec);
528 spin_unlock_irqrestore(&ec->lock, flags);
b6a3e147
ZR
529
530 /* Drain additional events if hardware requires that */
531 if (EC_FLAGS_CLEAR_ON_RESUME)
532 acpi_ec_clear(ec);
750f628b
LZ
533}
534
eab05ec3 535#ifdef CONFIG_PM_SLEEP
016b87ca 536static void __acpi_ec_flush_work(void)
39a2a2aa 537{
f0ac20c3 538 drain_workqueue(ec_wq); /* flush ec->work */
016b87ca 539 flush_workqueue(ec_query_wq); /* flush queries */
39a2a2aa
LZ
540}
541
542static void acpi_ec_disable_event(struct acpi_ec *ec)
543{
544 unsigned long flags;
545
546 spin_lock_irqsave(&ec->lock, flags);
547 __acpi_ec_disable_event(ec);
548 spin_unlock_irqrestore(&ec->lock, flags);
016b87ca
RW
549
550 /*
551 * When ec_freeze_events is true, we need to flush events in
552 * the proper position before entering the noirq stage.
553 */
554 __acpi_ec_flush_work();
39a2a2aa 555}
880a6627
RW
556
557void acpi_ec_flush_work(void)
558{
f0ac20c3
RW
559 /* Without ec_wq there is nothing to flush. */
560 if (!ec_wq)
016b87ca 561 return;
880a6627 562
016b87ca 563 __acpi_ec_flush_work();
880a6627 564}
eab05ec3 565#endif /* CONFIG_PM_SLEEP */
39a2a2aa 566
1d68d261
LZ
567static bool acpi_ec_guard_event(struct acpi_ec *ec)
568{
61197547
LZ
569 bool guarded = true;
570 unsigned long flags;
571
572 spin_lock_irqsave(&ec->lock, flags);
573 /*
574 * If firmware SCI_EVT clearing timing is "event", we actually
575 * don't know when the SCI_EVT will be cleared by firmware after
576 * evaluating _Qxx, so we need to re-check SCI_EVT after waiting an
577 * acceptable period.
578 *
579 * The guarding period begins when EC_FLAGS_QUERY_PENDING is
580 * flagged, which means SCI_EVT check has just been performed.
581 * But if the current transaction is ACPI_EC_COMMAND_QUERY, the
582 * guarding should have already been performed (via
583 * EC_FLAGS_QUERY_GUARDING) and should not be applied so that the
584 * ACPI_EC_COMMAND_QUERY transaction can be transitioned into
585 * ACPI_EC_COMMAND_POLL state immediately.
586 */
1d68d261
LZ
587 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS ||
588 ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY ||
589 !test_bit(EC_FLAGS_QUERY_PENDING, &ec->flags) ||
590 (ec->curr && ec->curr->command == ACPI_EC_COMMAND_QUERY))
61197547
LZ
591 guarded = false;
592 spin_unlock_irqrestore(&ec->lock, flags);
593 return guarded;
1d68d261
LZ
594}
595
d8d031a6
LZ
596static int ec_transaction_polled(struct acpi_ec *ec)
597{
598 unsigned long flags;
599 int ret = 0;
600
601 spin_lock_irqsave(&ec->lock, flags);
602 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_POLL))
603 ret = 1;
604 spin_unlock_irqrestore(&ec->lock, flags);
605 return ret;
606}
607
f92fca00 608static int ec_transaction_completed(struct acpi_ec *ec)
6ffb221a 609{
7c6db4e0
AS
610 unsigned long flags;
611 int ret = 0;
7a73e60e 612
f351d027 613 spin_lock_irqsave(&ec->lock, flags);
c0d65341 614 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE))
7c6db4e0 615 ret = 1;
f351d027 616 spin_unlock_irqrestore(&ec->lock, flags);
7c6db4e0 617 return ret;
45bea155 618}
451566f4 619
f8b8eb71
LZ
620static inline void ec_transaction_transition(struct acpi_ec *ec, unsigned long flag)
621{
622 ec->curr->flags |= flag;
623 if (ec->curr->command == ACPI_EC_COMMAND_QUERY) {
1d68d261
LZ
624 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS &&
625 flag == ACPI_EC_COMMAND_POLL)
626 acpi_ec_complete_query(ec);
627 if (ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY &&
628 flag == ACPI_EC_COMMAND_COMPLETE)
f8b8eb71 629 acpi_ec_complete_query(ec);
1d68d261
LZ
630 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT &&
631 flag == ACPI_EC_COMMAND_COMPLETE)
632 set_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags);
f8b8eb71
LZ
633 }
634}
635
0c78808f 636static void advance_transaction(struct acpi_ec *ec)
7c6db5e5 637{
36b15875 638 struct transaction *t;
66b42b78 639 u8 status;
c0d65341 640 bool wakeup = false;
b76b51ba 641
3535a3c1
LZ
642 ec_dbg_stm("%s (%d)", in_interrupt() ? "IRQ" : "TASK",
643 smp_processor_id());
ca37bfdf
LZ
644 /*
645 * By always clearing STS before handling all indications, we can
646 * ensure a hardware STS 0->1 change after this clearing can always
647 * trigger a GPE interrupt.
648 */
406857f7
DD
649 if (ec->gpe >= 0)
650 acpi_ec_clear_gpe(ec);
651
66b42b78 652 status = acpi_ec_read_status(ec);
36b15875 653 t = ec->curr;
1d68d261
LZ
654 /*
655 * Another IRQ or a guarded polling mode advancement is detected,
656 * the next QR_EC submission is then allowed.
657 */
658 if (!t || !(t->flags & ACPI_EC_COMMAND_POLL)) {
659 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT &&
66db3834
LZ
660 (!ec->nr_pending_queries ||
661 test_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags))) {
1d68d261
LZ
662 clear_bit(EC_FLAGS_QUERY_GUARDING, &ec->flags);
663 acpi_ec_complete_query(ec);
664 }
665 }
b76b51ba 666 if (!t)
f92fca00
LZ
667 goto err;
668 if (t->flags & ACPI_EC_COMMAND_POLL) {
669 if (t->wlen > t->wi) {
670 if ((status & ACPI_EC_FLAG_IBF) == 0)
671 acpi_ec_write_data(ec, t->wdata[t->wi++]);
672 else
673 goto err;
674 } else if (t->rlen > t->ri) {
675 if ((status & ACPI_EC_FLAG_OBF) == 1) {
676 t->rdata[t->ri++] = acpi_ec_read_data(ec);
c0d65341 677 if (t->rlen == t->ri) {
f8b8eb71 678 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
3afcf2ec 679 if (t->command == ACPI_EC_COMMAND_QUERY)
9d8993be
LZ
680 ec_dbg_evt("Command(%s) completed by hardware",
681 acpi_ec_cmd_string(ACPI_EC_COMMAND_QUERY));
c0d65341
LZ
682 wakeup = true;
683 }
f92fca00
LZ
684 } else
685 goto err;
686 } else if (t->wlen == t->wi &&
c0d65341 687 (status & ACPI_EC_FLAG_IBF) == 0) {
f8b8eb71 688 ec_transaction_transition(ec, ACPI_EC_COMMAND_COMPLETE);
c0d65341
LZ
689 wakeup = true;
690 }
0c78808f 691 goto out;
b1e14999
RW
692 } else if (!(status & ACPI_EC_FLAG_IBF)) {
693 acpi_ec_write_cmd(ec, t->command);
694 ec_transaction_transition(ec, ACPI_EC_COMMAND_POLL);
0c78808f 695 goto out;
f92fca00 696 }
dd15f8c4 697err:
a3cd8d27
FT
698 /*
699 * If SCI bit is set, then don't think it's a false IRQ
700 * otherwise will take a not handled IRQ as a false one.
701 */
f92fca00 702 if (!(status & ACPI_EC_FLAG_SCI)) {
e1d4d90f
LZ
703 if (in_interrupt() && t) {
704 if (t->irq_count < ec_storm_threshold)
705 ++t->irq_count;
706 /* Allow triggering on 0 threshold */
707 if (t->irq_count == ec_storm_threshold)
4446abc9 708 acpi_ec_mask_events(ec);
e1d4d90f 709 }
f92fca00 710 }
0c78808f 711out:
74443bbe 712 if (status & ACPI_EC_FLAG_SCI)
37d11391 713 acpi_ec_submit_query(ec);
0c78808f
LZ
714 if (wakeup && in_interrupt())
715 wake_up(&ec->wait);
f92fca00 716}
a3cd8d27 717
f92fca00
LZ
718static void start_transaction(struct acpi_ec *ec)
719{
720 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
721 ec->curr->flags = 0;
d8d031a6
LZ
722}
723
724static int ec_guard(struct acpi_ec *ec)
725{
c3a696b6 726 unsigned long guard = usecs_to_jiffies(ec->polling_guard);
d8d031a6
LZ
727 unsigned long timeout = ec->timestamp + guard;
728
61197547 729 /* Ensure guarding period before polling EC status */
d8d031a6 730 do {
c3a696b6 731 if (ec->busy_polling) {
d8d031a6
LZ
732 /* Perform busy polling */
733 if (ec_transaction_completed(ec))
734 return 0;
735 udelay(jiffies_to_usecs(guard));
736 } else {
737 /*
738 * Perform wait polling
61197547
LZ
739 * 1. Wait the transaction to be completed by the
740 * GPE handler after the transaction enters
741 * ACPI_EC_COMMAND_POLL state.
742 * 2. A special guarding logic is also required
743 * for event clearing mode "event" before the
744 * transaction enters ACPI_EC_COMMAND_POLL
745 * state.
d8d031a6 746 */
1d68d261
LZ
747 if (!ec_transaction_polled(ec) &&
748 !acpi_ec_guard_event(ec))
d8d031a6
LZ
749 break;
750 if (wait_event_timeout(ec->wait,
751 ec_transaction_completed(ec),
752 guard))
753 return 0;
754 }
d8d031a6
LZ
755 } while (time_before(jiffies, timeout));
756 return -ETIME;
845625cd 757}
03d1d99c 758
7c6db4e0
AS
759static int ec_poll(struct acpi_ec *ec)
760{
2a84cb98 761 unsigned long flags;
28fe5c82 762 int repeat = 5; /* number of command restarts */
7a73e60e 763
2a84cb98
AS
764 while (repeat--) {
765 unsigned long delay = jiffies +
7a18e96d 766 msecs_to_jiffies(ec_delay);
2a84cb98 767 do {
d8d031a6
LZ
768 if (!ec_guard(ec))
769 return 0;
f92fca00 770 spin_lock_irqsave(&ec->lock, flags);
d8d031a6 771 advance_transaction(ec);
f92fca00 772 spin_unlock_irqrestore(&ec->lock, flags);
2a84cb98 773 } while (time_before(jiffies, delay));
16a26e85 774 pr_debug("controller reset, restart transaction\n");
f351d027 775 spin_lock_irqsave(&ec->lock, flags);
2a84cb98 776 start_transaction(ec);
f351d027 777 spin_unlock_irqrestore(&ec->lock, flags);
af3fd140 778 }
b77d81b2 779 return -ETIME;
1da177e4
LT
780}
781
8463200a 782static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
2a84cb98 783 struct transaction *t)
45bea155 784{
7c6db4e0 785 unsigned long tmp;
7c6db4e0 786 int ret = 0;
7a73e60e 787
7c6db4e0 788 /* start transaction */
f351d027 789 spin_lock_irqsave(&ec->lock, tmp);
9887d22a 790 /* Enable GPE for command processing (IBF=0/OBF=1) */
37d11391 791 if (!acpi_ec_submit_flushable_request(ec)) {
ad479e7f
LZ
792 ret = -EINVAL;
793 goto unlock;
794 }
770970f0 795 ec_dbg_ref(ec, "Increase command");
7c6db4e0 796 /* following two actions should be kept atomic */
8463200a 797 ec->curr = t;
3535a3c1 798 ec_dbg_req("Command(%s) started", acpi_ec_cmd_string(t->command));
a2f93aea 799 start_transaction(ec);
df9ff918 800 spin_unlock_irqrestore(&ec->lock, tmp);
d8d031a6 801
df9ff918 802 ret = ec_poll(ec);
d8d031a6 803
df9ff918 804 spin_lock_irqsave(&ec->lock, tmp);
e1d4d90f 805 if (t->irq_count == ec_storm_threshold)
4446abc9 806 acpi_ec_unmask_events(ec);
3535a3c1 807 ec_dbg_req("Command(%s) stopped", acpi_ec_cmd_string(t->command));
8463200a 808 ec->curr = NULL;
9887d22a
LZ
809 /* Disable GPE for command processing (IBF=0/OBF=1) */
810 acpi_ec_complete_request(ec);
770970f0 811 ec_dbg_ref(ec, "Decrease command");
ad479e7f 812unlock:
f351d027 813 spin_unlock_irqrestore(&ec->lock, tmp);
7c6db4e0
AS
814 return ret;
815}
816
2a84cb98 817static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
1da177e4 818{
d7a76e4c 819 int status;
50526df6 820 u32 glk;
7a73e60e 821
8463200a 822 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
d550d98d 823 return -EINVAL;
8463200a
AS
824 if (t->rdata)
825 memset(t->rdata, 0, t->rlen);
d8d031a6 826
f351d027 827 mutex_lock(&ec->mutex);
703959d4 828 if (ec->global_lock) {
1da177e4 829 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
c24e912b 830 if (ACPI_FAILURE(status)) {
7c6db4e0
AS
831 status = -ENODEV;
832 goto unlock;
c24e912b 833 }
1da177e4 834 }
a62e8f19 835
2a84cb98 836 status = acpi_ec_transaction_unlocked(ec, t);
a62e8f19 837
703959d4 838 if (ec->global_lock)
1da177e4 839 acpi_release_global_lock(glk);
7c6db4e0 840unlock:
f351d027 841 mutex_unlock(&ec->mutex);
d550d98d 842 return status;
1da177e4
LT
843}
844
8a383ef0 845static int acpi_ec_burst_enable(struct acpi_ec *ec)
c45aac43
AS
846{
847 u8 d;
8463200a
AS
848 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
849 .wdata = NULL, .rdata = &d,
850 .wlen = 0, .rlen = 1};
851
2a84cb98 852 return acpi_ec_transaction(ec, &t);
c45aac43
AS
853}
854
8a383ef0 855static int acpi_ec_burst_disable(struct acpi_ec *ec)
c45aac43 856{
8463200a
AS
857 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
858 .wdata = NULL, .rdata = NULL,
859 .wlen = 0, .rlen = 0};
860
7c6db4e0 861 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
2a84cb98 862 acpi_ec_transaction(ec, &t) : 0;
c45aac43
AS
863}
864
7a73e60e 865static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data)
3576cf61
DS
866{
867 int result;
868 u8 d;
8463200a
AS
869 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
870 .wdata = &address, .rdata = &d,
871 .wlen = 1, .rlen = 1};
3576cf61 872
2a84cb98 873 result = acpi_ec_transaction(ec, &t);
3576cf61
DS
874 *data = d;
875 return result;
876}
6ffb221a 877
3576cf61
DS
878static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
879{
6ccedb10 880 u8 wdata[2] = { address, data };
8463200a
AS
881 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
882 .wdata = wdata, .rdata = NULL,
883 .wlen = 2, .rlen = 0};
884
2a84cb98 885 return acpi_ec_transaction(ec, &t);
3576cf61
DS
886}
887
b76b51ba 888int ec_read(u8 addr, u8 *val)
1da177e4 889{
1da177e4 890 int err;
6ffb221a 891 u8 temp_data;
1da177e4
LT
892
893 if (!first_ec)
894 return -ENODEV;
895
d033879c 896 err = acpi_ec_read(first_ec, addr, &temp_data);
1da177e4
LT
897
898 if (!err) {
899 *val = temp_data;
900 return 0;
7a73e60e
LZ
901 }
902 return err;
1da177e4
LT
903}
904EXPORT_SYMBOL(ec_read);
905
50526df6 906int ec_write(u8 addr, u8 val)
1da177e4 907{
1da177e4
LT
908 int err;
909
910 if (!first_ec)
911 return -ENODEV;
912
d033879c 913 err = acpi_ec_write(first_ec, addr, val);
1da177e4
LT
914
915 return err;
916}
917EXPORT_SYMBOL(ec_write);
918
616362de 919int ec_transaction(u8 command,
7a73e60e
LZ
920 const u8 *wdata, unsigned wdata_len,
921 u8 *rdata, unsigned rdata_len)
45bea155 922{
8463200a
AS
923 struct transaction t = {.command = command,
924 .wdata = wdata, .rdata = rdata,
925 .wlen = wdata_len, .rlen = rdata_len};
7a73e60e 926
d7a76e4c
LP
927 if (!first_ec)
928 return -ENODEV;
45bea155 929
2a84cb98 930 return acpi_ec_transaction(first_ec, &t);
45bea155 931}
ab9e43c6
LP
932EXPORT_SYMBOL(ec_transaction);
933
3e2abc5a
SF
934/* Get the handle to the EC device */
935acpi_handle ec_get_handle(void)
936{
937 if (!first_ec)
938 return NULL;
939 return first_ec->handle;
940}
3e2abc5a
SF
941EXPORT_SYMBOL(ec_get_handle);
942
ad479e7f
LZ
943static void acpi_ec_start(struct acpi_ec *ec, bool resuming)
944{
945 unsigned long flags;
946
947 spin_lock_irqsave(&ec->lock, flags);
948 if (!test_and_set_bit(EC_FLAGS_STARTED, &ec->flags)) {
3535a3c1 949 ec_dbg_drv("Starting EC");
9887d22a 950 /* Enable GPE for event processing (SCI_EVT=1) */
770970f0 951 if (!resuming) {
9887d22a 952 acpi_ec_submit_request(ec);
770970f0 953 ec_dbg_ref(ec, "Increase driver");
c2b46d67 954 }
3535a3c1 955 ec_log_drv("EC started");
ad479e7f
LZ
956 }
957 spin_unlock_irqrestore(&ec->lock, flags);
958}
959
9887d22a
LZ
960static bool acpi_ec_stopped(struct acpi_ec *ec)
961{
962 unsigned long flags;
963 bool flushed;
964
965 spin_lock_irqsave(&ec->lock, flags);
966 flushed = acpi_ec_flushed(ec);
967 spin_unlock_irqrestore(&ec->lock, flags);
968 return flushed;
969}
970
ad479e7f
LZ
971static void acpi_ec_stop(struct acpi_ec *ec, bool suspending)
972{
973 unsigned long flags;
974
975 spin_lock_irqsave(&ec->lock, flags);
976 if (acpi_ec_started(ec)) {
3535a3c1 977 ec_dbg_drv("Stopping EC");
ad479e7f 978 set_bit(EC_FLAGS_STOPPED, &ec->flags);
9887d22a
LZ
979 spin_unlock_irqrestore(&ec->lock, flags);
980 wait_event(ec->wait, acpi_ec_stopped(ec));
981 spin_lock_irqsave(&ec->lock, flags);
982 /* Disable GPE for event processing (SCI_EVT=1) */
770970f0 983 if (!suspending) {
9887d22a 984 acpi_ec_complete_request(ec);
770970f0 985 ec_dbg_ref(ec, "Decrease driver");
39a2a2aa 986 } else if (!ec_freeze_events)
750f628b 987 __acpi_ec_disable_event(ec);
ad479e7f
LZ
988 clear_bit(EC_FLAGS_STARTED, &ec->flags);
989 clear_bit(EC_FLAGS_STOPPED, &ec->flags);
3535a3c1 990 ec_log_drv("EC stopped");
ad479e7f
LZ
991 }
992 spin_unlock_irqrestore(&ec->lock, flags);
993}
994
c3a696b6
LZ
995static void acpi_ec_enter_noirq(struct acpi_ec *ec)
996{
997 unsigned long flags;
998
999 spin_lock_irqsave(&ec->lock, flags);
1000 ec->busy_polling = true;
1001 ec->polling_guard = 0;
1002 ec_log_drv("interrupt blocked");
1003 spin_unlock_irqrestore(&ec->lock, flags);
1004}
1005
1006static void acpi_ec_leave_noirq(struct acpi_ec *ec)
1007{
1008 unsigned long flags;
1009
1010 spin_lock_irqsave(&ec->lock, flags);
1011 ec->busy_polling = ec_busy_polling;
1012 ec->polling_guard = ec_polling_guard;
1013 ec_log_drv("interrupt unblocked");
1014 spin_unlock_irqrestore(&ec->lock, flags);
1015}
1016
fe955682 1017void acpi_ec_block_transactions(void)
f6bb13aa
RW
1018{
1019 struct acpi_ec *ec = first_ec;
1020
1021 if (!ec)
1022 return;
1023
f351d027 1024 mutex_lock(&ec->mutex);
f6bb13aa 1025 /* Prevent transactions from being carried out */
ad479e7f 1026 acpi_ec_stop(ec, true);
f351d027 1027 mutex_unlock(&ec->mutex);
f6bb13aa
RW
1028}
1029
fe955682 1030void acpi_ec_unblock_transactions(void)
d5a64513
RW
1031{
1032 /*
1033 * Allow transactions to happen again (this function is called from
1034 * atomic context during wakeup, so we don't need to acquire the mutex).
1035 */
1036 if (first_ec)
ad479e7f 1037 acpi_ec_start(first_ec, true);
d5a64513
RW
1038}
1039
1da177e4
LT
1040/* --------------------------------------------------------------------------
1041 Event Management
1042 -------------------------------------------------------------------------- */
0700c047
LZ
1043static struct acpi_ec_query_handler *
1044acpi_ec_get_query_handler_by_value(struct acpi_ec *ec, u8 value)
1045{
1046 struct acpi_ec_query_handler *handler;
0700c047
LZ
1047
1048 mutex_lock(&ec->mutex);
1049 list_for_each_entry(handler, &ec->list, node) {
1050 if (value == handler->query_bit) {
3df663a1
RW
1051 kref_get(&handler->kref);
1052 mutex_unlock(&ec->mutex);
1053 return handler;
0700c047
LZ
1054 }
1055 }
1056 mutex_unlock(&ec->mutex);
3df663a1 1057 return NULL;
0700c047
LZ
1058}
1059
01305d41
LZ
1060static void acpi_ec_query_handler_release(struct kref *kref)
1061{
1062 struct acpi_ec_query_handler *handler =
1063 container_of(kref, struct acpi_ec_query_handler, kref);
1064
1065 kfree(handler);
1066}
1067
1068static void acpi_ec_put_query_handler(struct acpi_ec_query_handler *handler)
1069{
1070 kref_put(&handler->kref, acpi_ec_query_handler_release);
1071}
1072
837012ed
AS
1073int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
1074 acpi_handle handle, acpi_ec_query_func func,
1075 void *data)
1076{
1077 struct acpi_ec_query_handler *handler =
1078 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
7a73e60e 1079
837012ed
AS
1080 if (!handler)
1081 return -ENOMEM;
1082
1083 handler->query_bit = query_bit;
1084 handler->handle = handle;
1085 handler->func = func;
1086 handler->data = data;
f351d027 1087 mutex_lock(&ec->mutex);
01305d41 1088 kref_init(&handler->kref);
30c08574 1089 list_add(&handler->node, &ec->list);
f351d027 1090 mutex_unlock(&ec->mutex);
837012ed
AS
1091 return 0;
1092}
837012ed
AS
1093EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
1094
0700c047
LZ
1095static void acpi_ec_remove_query_handlers(struct acpi_ec *ec,
1096 bool remove_all, u8 query_bit)
837012ed 1097{
1544fdbc 1098 struct acpi_ec_query_handler *handler, *tmp;
01305d41 1099 LIST_HEAD(free_list);
7a73e60e 1100
f351d027 1101 mutex_lock(&ec->mutex);
1544fdbc 1102 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
0700c047 1103 if (remove_all || query_bit == handler->query_bit) {
01305d41
LZ
1104 list_del_init(&handler->node);
1105 list_add(&handler->node, &free_list);
837012ed
AS
1106 }
1107 }
f351d027 1108 mutex_unlock(&ec->mutex);
6b5eab54 1109 list_for_each_entry_safe(handler, tmp, &free_list, node)
01305d41 1110 acpi_ec_put_query_handler(handler);
837012ed 1111}
0700c047
LZ
1112
1113void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
1114{
1115 acpi_ec_remove_query_handlers(ec, false, query_bit);
1116}
837012ed 1117EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
1da177e4 1118
02b771b6 1119static struct acpi_ec_query *acpi_ec_create_query(u8 *pval)
45bea155 1120{
02b771b6
LZ
1121 struct acpi_ec_query *q;
1122 struct transaction *t;
1123
1124 q = kzalloc(sizeof (struct acpi_ec_query), GFP_KERNEL);
1125 if (!q)
1126 return NULL;
1127 INIT_WORK(&q->work, acpi_ec_event_processor);
1128 t = &q->transaction;
1129 t->command = ACPI_EC_COMMAND_QUERY;
1130 t->rdata = pval;
1131 t->rlen = 1;
1132 return q;
1133}
1134
1135static void acpi_ec_delete_query(struct acpi_ec_query *q)
1136{
1137 if (q) {
1138 if (q->handler)
1139 acpi_ec_put_query_handler(q->handler);
1140 kfree(q);
1141 }
1142}
1143
1144static void acpi_ec_event_processor(struct work_struct *work)
1145{
1146 struct acpi_ec_query *q = container_of(work, struct acpi_ec_query, work);
1147 struct acpi_ec_query_handler *handler = q->handler;
7a73e60e 1148
3535a3c1 1149 ec_dbg_evt("Query(0x%02x) started", handler->query_bit);
a62e8f19
AS
1150 if (handler->func)
1151 handler->func(handler->data);
1152 else if (handler->handle)
1153 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
3535a3c1 1154 ec_dbg_evt("Query(0x%02x) stopped", handler->query_bit);
02b771b6 1155 acpi_ec_delete_query(q);
a62e8f19
AS
1156}
1157
550b3aac 1158static int acpi_ec_query(struct acpi_ec *ec, u8 *data)
a62e8f19
AS
1159{
1160 u8 value = 0;
c2cf5769 1161 int result;
02b771b6
LZ
1162 struct acpi_ec_query *q;
1163
1164 q = acpi_ec_create_query(&value);
1165 if (!q)
1166 return -ENOMEM;
3eba563e 1167
550b3aac
LZ
1168 /*
1169 * Query the EC to find out which _Qxx method we need to evaluate.
1170 * Note that successful completion of the query causes the ACPI_EC_SCI
1171 * bit to be cleared (and thus clearing the interrupt source).
1172 */
02b771b6 1173 result = acpi_ec_transaction(ec, &q->transaction);
550b3aac 1174 if (!value)
02b771b6
LZ
1175 result = -ENODATA;
1176 if (result)
1177 goto err_exit;
3eba563e 1178
0700c047
LZ
1179 q->handler = acpi_ec_get_query_handler_by_value(ec, value);
1180 if (!q->handler) {
1181 result = -ENODATA;
1182 goto err_exit;
1183 }
1184
1185 /*
1186 * It is reported that _Qxx are evaluated in a parallel way on
1187 * Windows:
1188 * https://bugzilla.kernel.org/show_bug.cgi?id=94411
1189 *
1190 * Put this log entry before schedule_work() in order to make
1191 * it appearing before any other log entries occurred during the
1192 * work queue execution.
1193 */
1194 ec_dbg_evt("Query(0x%02x) scheduled", value);
e1191bd4 1195 if (!queue_work(ec_query_wq, &q->work)) {
0700c047
LZ
1196 ec_dbg_evt("Query(0x%02x) overlapped", value);
1197 result = -EBUSY;
837012ed 1198 }
02b771b6
LZ
1199
1200err_exit:
4981c2b7 1201 if (result)
02b771b6
LZ
1202 acpi_ec_delete_query(q);
1203 if (data)
1204 *data = value;
c2cf5769 1205 return result;
a62e8f19
AS
1206}
1207
1d68d261
LZ
1208static void acpi_ec_check_event(struct acpi_ec *ec)
1209{
1210 unsigned long flags;
1211
1212 if (ec_event_clearing == ACPI_EC_EVT_TIMING_EVENT) {
1213 if (ec_guard(ec)) {
1214 spin_lock_irqsave(&ec->lock, flags);
1215 /*
1216 * Take care of the SCI_EVT unless no one else is
1217 * taking care of it.
1218 */
1219 if (!ec->curr)
1220 advance_transaction(ec);
1221 spin_unlock_irqrestore(&ec->lock, flags);
1222 }
1223 }
1224}
1225
9d8993be 1226static void acpi_ec_event_handler(struct work_struct *work)
a62e8f19 1227{
9d8993be 1228 unsigned long flags;
74443bbe 1229 struct acpi_ec *ec = container_of(work, struct acpi_ec, work);
7a73e60e 1230
9d8993be
LZ
1231 ec_dbg_evt("Event started");
1232
1233 spin_lock_irqsave(&ec->lock, flags);
1234 while (ec->nr_pending_queries) {
1235 spin_unlock_irqrestore(&ec->lock, flags);
1236 (void)acpi_ec_query(ec, NULL);
1237 spin_lock_irqsave(&ec->lock, flags);
1238 ec->nr_pending_queries--;
66db3834
LZ
1239 /*
1240 * Before exit, make sure that this work item can be
1241 * scheduled again. There might be QR_EC failures, leaving
1242 * EC_FLAGS_QUERY_PENDING uncleared and preventing this work
1243 * item from being scheduled again.
1244 */
1245 if (!ec->nr_pending_queries) {
1246 if (ec_event_clearing == ACPI_EC_EVT_TIMING_STATUS ||
1247 ec_event_clearing == ACPI_EC_EVT_TIMING_QUERY)
1248 acpi_ec_complete_query(ec);
1249 }
9d8993be
LZ
1250 }
1251 spin_unlock_irqrestore(&ec->lock, flags);
1252
1253 ec_dbg_evt("Event stopped");
1d68d261
LZ
1254
1255 acpi_ec_check_event(ec);
45bea155 1256}
1da177e4 1257
406857f7 1258static void acpi_ec_handle_interrupt(struct acpi_ec *ec)
1da177e4 1259{
f92fca00 1260 unsigned long flags;
7c6db4e0 1261
f92fca00 1262 spin_lock_irqsave(&ec->lock, flags);
0c78808f 1263 advance_transaction(ec);
c0d65341 1264 spin_unlock_irqrestore(&ec->lock, flags);
406857f7
DD
1265}
1266
1267static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
1268 u32 gpe_number, void *data)
1269{
1270 acpi_ec_handle_interrupt(data);
ca37bfdf 1271 return ACPI_INTERRUPT_HANDLED;
845625cd
AS
1272}
1273
406857f7
DD
1274static irqreturn_t acpi_ec_irq_handler(int irq, void *data)
1275{
1276 acpi_ec_handle_interrupt(data);
1277 return IRQ_HANDLED;
1278}
1279
1da177e4 1280/* --------------------------------------------------------------------------
7a73e60e
LZ
1281 * Address Space Management
1282 * -------------------------------------------------------------------------- */
1da177e4 1283
1da177e4 1284static acpi_status
5b7734b4 1285acpi_ec_space_handler(u32 function, acpi_physical_address address,
dadf28a1 1286 u32 bits, u64 *value64,
50526df6 1287 void *handler_context, void *region_context)
1da177e4 1288{
3d02b90b 1289 struct acpi_ec *ec = handler_context;
dadf28a1
AS
1290 int result = 0, i, bytes = bits / 8;
1291 u8 *value = (u8 *)value64;
1da177e4 1292
1da177e4 1293 if ((address > 0xFF) || !value || !handler_context)
d550d98d 1294 return AE_BAD_PARAMETER;
1da177e4 1295
5b7734b4 1296 if (function != ACPI_READ && function != ACPI_WRITE)
d550d98d 1297 return AE_BAD_PARAMETER;
1da177e4 1298
c3a696b6 1299 if (ec->busy_polling || bits > 8)
6a63b06f 1300 acpi_ec_burst_enable(ec);
b3b233c7 1301
dadf28a1
AS
1302 for (i = 0; i < bytes; ++i, ++address, ++value)
1303 result = (function == ACPI_READ) ?
1304 acpi_ec_read(ec, address, value) :
1305 acpi_ec_write(ec, address, *value);
1da177e4 1306
c3a696b6 1307 if (ec->busy_polling || bits > 8)
6a63b06f 1308 acpi_ec_burst_disable(ec);
b3b233c7 1309
1da177e4
LT
1310 switch (result) {
1311 case -EINVAL:
d550d98d 1312 return AE_BAD_PARAMETER;
1da177e4 1313 case -ENODEV:
d550d98d 1314 return AE_NOT_FOUND;
1da177e4 1315 case -ETIME:
d550d98d 1316 return AE_TIME;
1da177e4 1317 default:
d550d98d 1318 return AE_OK;
1da177e4 1319 }
1da177e4
LT
1320}
1321
1da177e4 1322/* --------------------------------------------------------------------------
7a73e60e
LZ
1323 * Driver Interface
1324 * -------------------------------------------------------------------------- */
1325
c0900c35
AS
1326static acpi_status
1327ec_parse_io_ports(struct acpi_resource *resource, void *context);
1328
72c77b7e
LZ
1329static void acpi_ec_free(struct acpi_ec *ec)
1330{
1331 if (first_ec == ec)
1332 first_ec = NULL;
1333 if (boot_ec == ec)
1334 boot_ec = NULL;
1335 kfree(ec);
1336}
1337
1338static struct acpi_ec *acpi_ec_alloc(void)
c0900c35
AS
1339{
1340 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
7a73e60e 1341
c0900c35
AS
1342 if (!ec)
1343 return NULL;
f351d027 1344 mutex_init(&ec->mutex);
c0900c35 1345 init_waitqueue_head(&ec->wait);
837012ed 1346 INIT_LIST_HEAD(&ec->list);
f351d027 1347 spin_lock_init(&ec->lock);
9d8993be 1348 INIT_WORK(&ec->work, acpi_ec_event_handler);
d8d031a6 1349 ec->timestamp = jiffies;
c3a696b6
LZ
1350 ec->busy_polling = true;
1351 ec->polling_guard = 0;
406857f7
DD
1352 ec->gpe = -1;
1353 ec->irq = -1;
c0900c35
AS
1354 return ec;
1355}
837012ed 1356
c019b193
AS
1357static acpi_status
1358acpi_ec_register_query_methods(acpi_handle handle, u32 level,
1359 void *context, void **return_value)
1360{
0175d562
LM
1361 char node_name[5];
1362 struct acpi_buffer buffer = { sizeof(node_name), node_name };
c019b193
AS
1363 struct acpi_ec *ec = context;
1364 int value = 0;
0175d562
LM
1365 acpi_status status;
1366
1367 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
1368
7a73e60e 1369 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1)
c019b193 1370 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
c019b193
AS
1371 return AE_OK;
1372}
1373
cd8c93a4
AS
1374static acpi_status
1375ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
837012ed 1376{
cd8c93a4 1377 acpi_status status;
d21cf3c1 1378 unsigned long long tmp = 0;
cd8c93a4 1379 struct acpi_ec *ec = context;
a5032bfd
AS
1380
1381 /* clear addr values, ec_parse_io_ports depend on it */
1382 ec->command_addr = ec->data_addr = 0;
1383
cd8c93a4
AS
1384 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1385 ec_parse_io_ports, ec);
1386 if (ACPI_FAILURE(status))
1387 return status;
ae56c9fd
LZ
1388 if (ec->data_addr == 0 || ec->command_addr == 0)
1389 return AE_OK;
837012ed 1390
440f53da
CC
1391 if (boot_ec && boot_ec_is_ecdt && EC_FLAGS_IGNORE_DSDT_GPE) {
1392 /*
1393 * Always inherit the GPE number setting from the ECDT
1394 * EC.
1395 */
1396 ec->gpe = boot_ec->gpe;
1397 } else {
1398 /* Get GPE bit assignment (EC events). */
1399 /* TODO: Add support for _GPE returning a package */
1400 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
406857f7
DD
1401 if (ACPI_SUCCESS(status))
1402 ec->gpe = tmp;
1403
1404 /*
1405 * Errors are non-fatal, allowing for ACPI Reduced Hardware
1406 * platforms which use GpioInt instead of GPE.
1407 */
440f53da 1408 }
837012ed 1409 /* Use the global lock for all EC transactions? */
d21cf3c1 1410 tmp = 0;
27663c58
MW
1411 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
1412 ec->global_lock = tmp;
837012ed 1413 ec->handle = handle;
cd8c93a4 1414 return AE_CTRL_TERMINATE;
837012ed
AS
1415}
1416
03e9a0e0 1417static bool install_gpe_event_handler(struct acpi_ec *ec)
406857f7 1418{
03e9a0e0 1419 acpi_status status;
406857f7 1420
03e9a0e0
RW
1421 status = acpi_install_gpe_raw_handler(NULL, ec->gpe,
1422 ACPI_GPE_EDGE_TRIGGERED,
1423 &acpi_ec_gpe_handler, ec);
1424 if (ACPI_FAILURE(status))
1425 return false;
406857f7 1426
03e9a0e0
RW
1427 if (test_bit(EC_FLAGS_STARTED, &ec->flags) && ec->reference_count >= 1)
1428 acpi_ec_enable_gpe(ec, true);
406857f7 1429
03e9a0e0
RW
1430 return true;
1431}
406857f7 1432
03e9a0e0
RW
1433static bool install_gpio_irq_event_handler(struct acpi_ec *ec)
1434{
1435 return request_irq(ec->irq, acpi_ec_irq_handler, IRQF_SHARED,
1436 "ACPI EC", ec) >= 0;
406857f7
DD
1437}
1438
03e9a0e0
RW
1439/**
1440 * ec_install_handlers - Install service callbacks and register query methods.
1441 * @ec: Target EC.
1442 * @device: ACPI device object corresponding to @ec.
1443 *
1444 * Install a handler for the EC address space type unless it has been installed
1445 * already. If @device is not NULL, also look for EC query methods in the
1446 * namespace and register them, and install an event (either GPE or GPIO IRQ)
1447 * handler for the EC, if possible.
1448 *
1449 * Return:
1450 * -ENODEV if the address space handler cannot be installed, which means
1451 * "unable to handle transactions",
1452 * -EPROBE_DEFER if GPIO IRQ acquisition needs to be deferred,
1453 * or 0 (success) otherwise.
72c77b7e 1454 */
a2b69177 1455static int ec_install_handlers(struct acpi_ec *ec, struct acpi_device *device)
5efc5476
BH
1456{
1457 acpi_status status;
7a73e60e 1458
ad479e7f 1459 acpi_ec_start(ec, false);
0e1affe4
LZ
1460
1461 if (!test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) {
c3a696b6 1462 acpi_ec_enter_noirq(ec);
0e1affe4
LZ
1463 status = acpi_install_address_space_handler(ec->handle,
1464 ACPI_ADR_SPACE_EC,
1465 &acpi_ec_space_handler,
1466 NULL, ec);
1467 if (ACPI_FAILURE(status)) {
7247f0c2
RW
1468 acpi_ec_stop(ec, false);
1469 return -ENODEV;
0e1affe4
LZ
1470 }
1471 set_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags);
1472 }
1473
a2b69177 1474 if (!device)
2a570840
LZ
1475 return 0;
1476
03e9a0e0
RW
1477 if (ec->gpe < 0) {
1478 /* ACPI reduced hardware platforms use a GpioInt from _CRS. */
1479 int irq = acpi_dev_gpio_irq_get(device, 0);
1480 /*
1481 * Bail out right away for deferred probing or complete the
1482 * initialization regardless of any other errors.
1483 */
1484 if (irq == -EPROBE_DEFER)
1485 return -EPROBE_DEFER;
1486 else if (irq >= 0)
1487 ec->irq = irq;
1488 }
1489
4446abc9 1490 if (!test_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags)) {
2a570840
LZ
1491 /* Find and register all query methods */
1492 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
1493 acpi_ec_register_query_methods,
1494 NULL, ec, NULL);
4446abc9 1495 set_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags);
2a570840 1496 }
4446abc9 1497 if (!test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags)) {
03e9a0e0
RW
1498 bool ready = false;
1499
1500 if (ec->gpe >= 0)
1501 ready = install_gpe_event_handler(ec);
1502 else if (ec->irq >= 0)
1503 ready = install_gpio_irq_event_handler(ec);
1504
1505 if (ready) {
1506 set_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags);
1507 acpi_ec_leave_noirq(ec);
5efc5476 1508 }
03e9a0e0
RW
1509 /*
1510 * Failures to install an event handler are not fatal, because
1511 * the EC can be polled for events.
1512 */
5efc5476 1513 }
53c5eaab
LZ
1514 /* EC is fully operational, allow queries */
1515 acpi_ec_enable_event(ec);
5efc5476 1516
5efc5476
BH
1517 return 0;
1518}
1519
4c611060
AS
1520static void ec_remove_handlers(struct acpi_ec *ec)
1521{
0e1affe4
LZ
1522 if (test_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags)) {
1523 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
1524 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
1525 pr_err("failed to remove space handler\n");
1526 clear_bit(EC_FLAGS_EC_HANDLER_INSTALLED, &ec->flags);
1527 }
1528
fa5b4a50
LZ
1529 /*
1530 * Stops handling the EC transactions after removing the operation
1531 * region handler. This is required because _REG(DISCONNECT)
1532 * invoked during the removal can result in new EC transactions.
1533 *
1534 * Flushes the EC requests and thus disables the GPE before
1535 * removing the GPE handler. This is required by the current ACPICA
1536 * GPE core. ACPICA GPE core will automatically disable a GPE when
1537 * it is indicated but there is no way to handle it. So the drivers
1538 * must disable the GPEs prior to removing the GPE handlers.
1539 */
1540 acpi_ec_stop(ec, false);
1541
4446abc9 1542 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags)) {
406857f7
DD
1543 if (ec->gpe >= 0 &&
1544 ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
1545 &acpi_ec_gpe_handler)))
0e1affe4 1546 pr_err("failed to remove gpe handler\n");
406857f7
DD
1547
1548 if (ec->irq >= 0)
1549 free_irq(ec->irq, ec);
1550
4446abc9 1551 clear_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags);
0e1affe4 1552 }
4446abc9 1553 if (test_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags)) {
2a570840 1554 acpi_ec_remove_query_handlers(ec, true, 0);
4446abc9 1555 clear_bit(EC_FLAGS_QUERY_METHODS_INSTALLED, &ec->flags);
2a570840 1556 }
4c611060
AS
1557}
1558
a2b69177 1559static int acpi_ec_setup(struct acpi_ec *ec, struct acpi_device *device)
1da177e4 1560{
72c77b7e 1561 int ret;
c0900c35 1562
a2b69177 1563 ret = ec_install_handlers(ec, device);
72c77b7e
LZ
1564 if (ret)
1565 return ret;
1566
1567 /* First EC capable of handling transactions */
c823c17a 1568 if (!first_ec)
72c77b7e 1569 first_ec = ec;
72c77b7e 1570
c823c17a
RW
1571 pr_info("EC_CMD/EC_SC=0x%lx, EC_DATA=0x%lx\n", ec->command_addr,
1572 ec->data_addr);
97cb159f 1573
c823c17a
RW
1574 if (test_bit(EC_FLAGS_EVENT_HANDLER_INSTALLED, &ec->flags)) {
1575 if (ec->gpe >= 0)
1576 pr_info("GPE=0x%x\n", ec->gpe);
1577 else
1578 pr_info("IRQ=%d\n", ec->irq);
a5032bfd 1579 }
97cb159f 1580
72c77b7e 1581 return ret;
97cb159f
LZ
1582}
1583
fd6231e7
LZ
1584static int acpi_ec_add(struct acpi_device *device)
1585{
e3cfabcd 1586 struct acpi_ec *ec;
116f2b34 1587 int ret;
fd6231e7
LZ
1588
1589 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1590 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1591
d7e0481c
RW
1592 if (boot_ec && (boot_ec->handle == device->handle ||
1593 !strcmp(acpi_device_hid(device), ACPI_ECDT_HID))) {
e3cfabcd 1594 /* Fast path: this device corresponds to the boot EC. */
a64a62ce
LZ
1595 ec = boot_ec;
1596 } else {
e3cfabcd
RW
1597 acpi_status status;
1598
a64a62ce
LZ
1599 ec = acpi_ec_alloc();
1600 if (!ec)
1601 return -ENOMEM;
116f2b34 1602
a64a62ce
LZ
1603 status = ec_parse_device(device->handle, 0, ec, NULL);
1604 if (status != AE_CTRL_TERMINATE) {
46922d2a 1605 ret = -EINVAL;
03e9a0e0 1606 goto err;
a64a62ce 1607 }
4c611060 1608
116f2b34
RW
1609 if (boot_ec && ec->command_addr == boot_ec->command_addr &&
1610 ec->data_addr == boot_ec->data_addr) {
a64a62ce
LZ
1611 /*
1612 * Trust PNP0C09 namespace location rather than
1613 * ECDT ID. But trust ECDT GPE rather than _GPE
1614 * because of ASUS quirks, so do not change
1615 * boot_ec->gpe to ec->gpe.
1616 */
1617 boot_ec->handle = ec->handle;
1618 acpi_handle_debug(ec->handle, "duplicated.\n");
1619 acpi_ec_free(ec);
1620 ec = boot_ec;
1621 }
d2c62aef
RW
1622 }
1623
a2b69177 1624 ret = acpi_ec_setup(ec, device);
46922d2a 1625 if (ret)
03e9a0e0 1626 goto err;
46922d2a 1627
d2c62aef
RW
1628 if (ec == boot_ec)
1629 acpi_handle_info(boot_ec->handle,
65a691f5 1630 "Boot %s EC initialization complete\n",
116f2b34 1631 boot_ec_is_ecdt ? "ECDT" : "DSDT");
d2c62aef 1632
65a691f5
RW
1633 acpi_handle_info(ec->handle,
1634 "EC: Used to handle transactions and events\n");
1635
db89b4f0 1636 device->driver_data = ec;
de4f1046 1637
d6795fe3
AK
1638 ret = !!request_region(ec->data_addr, 1, "EC data");
1639 WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr);
1640 ret = !!request_region(ec->command_addr, 1, "EC cmd");
1641 WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr);
de4f1046 1642
e3cfabcd
RW
1643 /* Reprobe devices depending on the EC */
1644 acpi_walk_dep_device_list(ec->handle);
1645
97cb159f 1646 acpi_handle_debug(ec->handle, "enumerated.\n");
46922d2a
LZ
1647 return 0;
1648
03e9a0e0 1649err:
97cb159f
LZ
1650 if (ec != boot_ec)
1651 acpi_ec_free(ec);
03e9a0e0 1652
5efc5476 1653 return ret;
1da177e4
LT
1654}
1655
51fac838 1656static int acpi_ec_remove(struct acpi_device *device)
1da177e4 1657{
01f22462 1658 struct acpi_ec *ec;
1da177e4 1659
1da177e4 1660 if (!device)
d550d98d 1661 return -EINVAL;
1da177e4
LT
1662
1663 ec = acpi_driver_data(device);
de4f1046
TR
1664 release_region(ec->data_addr, 1);
1665 release_region(ec->command_addr, 1);
db89b4f0 1666 device->driver_data = NULL;
97cb159f
LZ
1667 if (ec != boot_ec) {
1668 ec_remove_handlers(ec);
1669 acpi_ec_free(ec);
1670 }
d550d98d 1671 return 0;
1da177e4
LT
1672}
1673
1da177e4 1674static acpi_status
c0900c35 1675ec_parse_io_ports(struct acpi_resource *resource, void *context)
1da177e4 1676{
3d02b90b 1677 struct acpi_ec *ec = context;
1da177e4 1678
01f22462 1679 if (resource->type != ACPI_RESOURCE_TYPE_IO)
1da177e4 1680 return AE_OK;
1da177e4
LT
1681
1682 /*
1683 * The first address region returned is the data port, and
1684 * the second address region returned is the status/command
1685 * port.
1686 */
de4f1046 1687 if (ec->data_addr == 0)
6ffb221a 1688 ec->data_addr = resource->data.io.minimum;
de4f1046 1689 else if (ec->command_addr == 0)
6ffb221a 1690 ec->command_addr = resource->data.io.minimum;
01f22462 1691 else
1da177e4 1692 return AE_CTRL_TERMINATE;
1da177e4 1693
1da177e4
LT
1694 return AE_OK;
1695}
1696
dcf15cbd
LZ
1697static const struct acpi_device_id ec_device_ids[] = {
1698 {"PNP0C09", 0},
a64a62ce 1699 {ACPI_ECDT_HID, 0},
dcf15cbd
LZ
1700 {"", 0},
1701};
1702
c712bb58
LZ
1703/*
1704 * This function is not Windows-compatible as Windows never enumerates the
1705 * namespace EC before the main ACPI device enumeration process. It is
1706 * retained for historical reason and will be deprecated in the future.
1707 */
fdb3c177 1708void __init acpi_ec_dsdt_probe(void)
c04209a7 1709{
fd6231e7 1710 struct acpi_ec *ec;
fdb3c177 1711 acpi_status status;
fd6231e7 1712 int ret;
dcf15cbd 1713
c712bb58
LZ
1714 /*
1715 * If a platform has ECDT, there is no need to proceed as the
1716 * following probe is not a part of the ACPI device enumeration,
1717 * executing _STA is not safe, and thus this probe may risk of
1718 * picking up an invalid EC device.
1719 */
1720 if (boot_ec)
fdb3c177 1721 return;
c712bb58 1722
fd6231e7
LZ
1723 ec = acpi_ec_alloc();
1724 if (!ec)
fdb3c177
RW
1725 return;
1726
dcf15cbd 1727 /*
2a570840
LZ
1728 * At this point, the namespace is initialized, so start to find
1729 * the namespace objects.
dcf15cbd 1730 */
fdb3c177 1731 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device, ec, NULL);
fd6231e7 1732 if (ACPI_FAILURE(status) || !ec->handle) {
fdb3c177
RW
1733 acpi_ec_free(ec);
1734 return;
c04209a7 1735 }
fdb3c177 1736
2a570840
LZ
1737 /*
1738 * When the DSDT EC is available, always re-configure boot EC to
1739 * have _REG evaluated. _REG can only be evaluated after the
1740 * namespace initialization.
1741 * At this point, the GPE is not fully initialized, so do not to
1742 * handle the events.
1743 */
a2b69177 1744 ret = acpi_ec_setup(ec, NULL);
c746b6b6 1745 if (ret) {
72c77b7e 1746 acpi_ec_free(ec);
c746b6b6
RW
1747 return;
1748 }
1749
1750 boot_ec = ec;
1751
1752 acpi_handle_info(ec->handle,
1753 "Boot DSDT EC used to handle transactions\n");
c04209a7
AS
1754}
1755
2a570840 1756/*
98ada3c5
RW
1757 * acpi_ec_ecdt_start - Finalize the boot ECDT EC initialization.
1758 *
1759 * First, look for an ACPI handle for the boot ECDT EC if acpi_ec_add() has not
1760 * found a matching object in the namespace.
1761 *
1762 * Next, in case the DSDT EC is not functioning, it is still necessary to
1763 * provide a functional ECDT EC to handle events, so add an extra device object
1764 * to represent it (see https://bugzilla.kernel.org/show_bug.cgi?id=115021).
1765 *
1766 * This is useful on platforms with valid ECDT and invalid DSDT EC settings,
1767 * like ASUS X550ZE (see https://bugzilla.kernel.org/show_bug.cgi?id=196847).
2a570840 1768 */
98ada3c5 1769static void __init acpi_ec_ecdt_start(void)
2a570840 1770{
98ada3c5 1771 struct acpi_table_ecdt *ecdt_ptr;
2a570840 1772 acpi_handle handle;
98ada3c5 1773 acpi_status status;
2a570840 1774
98ada3c5
RW
1775 /* Bail out if a matching EC has been found in the namespace. */
1776 if (!boot_ec || boot_ec->handle != ACPI_ROOT_OBJECT)
1777 return;
2a570840 1778
98ada3c5
RW
1779 /* Look up the object pointed to from the ECDT in the namespace. */
1780 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1781 (struct acpi_table_header **)&ecdt_ptr);
1782 if (ACPI_FAILURE(status))
1783 return;
a64a62ce 1784
98ada3c5
RW
1785 status = acpi_get_handle(NULL, ecdt_ptr->id, &handle);
1786 if (ACPI_FAILURE(status))
1787 return;
2a570840 1788
98ada3c5
RW
1789 boot_ec->handle = handle;
1790
1791 /* Add a special ACPI device object to represent the boot EC. */
1792 acpi_bus_register_early_device(ACPI_BUS_TYPE_ECDT_EC);
79149001
LZ
1793}
1794
b6a3e147
ZR
1795/*
1796 * On some hardware it is necessary to clear events accumulated by the EC during
1797 * sleep. These ECs stop reporting GPEs until they are manually polled, if too
1798 * many events are accumulated. (e.g. Samsung Series 5/9 notebooks)
1799 *
1800 * https://bugzilla.kernel.org/show_bug.cgi?id=44161
1801 *
1802 * Ideally, the EC should also be instructed NOT to accumulate events during
1803 * sleep (which Windows seems to do somehow), but the interface to control this
1804 * behaviour is not known at this time.
1805 *
1806 * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx,
1807 * however it is very likely that other Samsung models are affected.
1808 *
1809 * On systems which don't accumulate _Q events during sleep, this extra check
1810 * should be harmless.
1811 */
1812static int ec_clear_on_resume(const struct dmi_system_id *id)
1813{
1814 pr_debug("Detected system needing EC poll on resume.\n");
1815 EC_FLAGS_CLEAR_ON_RESUME = 1;
1816 ec_event_clearing = ACPI_EC_EVT_TIMING_STATUS;
1817 return 0;
1818}
1819
bc539567
LZ
1820/*
1821 * Some ECDTs contain wrong register addresses.
1822 * MSI MS-171F
1823 * https://bugzilla.kernel.org/show_bug.cgi?id=12461
1824 */
59f0aa94
LZ
1825static int ec_correct_ecdt(const struct dmi_system_id *id)
1826{
1827 pr_debug("Detected system needing ECDT address correction.\n");
1828 EC_FLAGS_CORRECT_ECDT = 1;
1829 return 0;
1830}
1831
440f53da
CC
1832/*
1833 * Some DSDTs contain wrong GPE setting.
ef75040a 1834 * Asus FX502VD/VE, GL702VMK, X550VXK, X580VD
440f53da
CC
1835 * https://bugzilla.kernel.org/show_bug.cgi?id=195651
1836 */
1837static int ec_honor_ecdt_gpe(const struct dmi_system_id *id)
1838{
1839 pr_debug("Detected system needing ignore DSDT GPE setting.\n");
1840 EC_FLAGS_IGNORE_DSDT_GPE = 1;
1841 return 0;
1842}
1843
6faadbbb 1844static const struct dmi_system_id ec_dmi_table[] __initconst = {
0adf3c74 1845 {
59f0aa94 1846 ec_correct_ecdt, "MSI MS-171F", {
3174abcf
LZ
1847 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star"),
1848 DMI_MATCH(DMI_PRODUCT_NAME, "MS-171F"),}, NULL},
440f53da
CC
1849 {
1850 ec_honor_ecdt_gpe, "ASUS FX502VD", {
1851 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1852 DMI_MATCH(DMI_PRODUCT_NAME, "FX502VD"),}, NULL},
1853 {
1854 ec_honor_ecdt_gpe, "ASUS FX502VE", {
1855 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1856 DMI_MATCH(DMI_PRODUCT_NAME, "FX502VE"),}, NULL},
1857 {
ef75040a
CC
1858 ec_honor_ecdt_gpe, "ASUS GL702VMK", {
1859 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1860 DMI_MATCH(DMI_PRODUCT_NAME, "GL702VMK"),}, NULL},
1861 {
440f53da
CC
1862 ec_honor_ecdt_gpe, "ASUS X550VXK", {
1863 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1864 DMI_MATCH(DMI_PRODUCT_NAME, "X550VXK"),}, NULL},
1865 {
1866 ec_honor_ecdt_gpe, "ASUS X580VD", {
1867 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1868 DMI_MATCH(DMI_PRODUCT_NAME, "X580VD"),}, NULL},
b6a3e147
ZR
1869 {
1870 ec_clear_on_resume, "Samsung hardware", {
1871 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL},
0adf3c74
AS
1872 {},
1873};
1874
fdb3c177 1875void __init acpi_ec_ecdt_probe(void)
c0900c35 1876{
50526df6 1877 struct acpi_table_ecdt *ecdt_ptr;
fd6231e7 1878 struct acpi_ec *ec;
fdb3c177
RW
1879 acpi_status status;
1880 int ret;
45bea155 1881
fdb3c177 1882 /* Generate a boot ec context. */
0adf3c74 1883 dmi_check_system(ec_dmi_table);
15a58ed1
AS
1884 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1885 (struct acpi_table_header **)&ecdt_ptr);
fdb3c177
RW
1886 if (ACPI_FAILURE(status))
1887 return;
0adf3c74 1888
59f0aa94
LZ
1889 if (!ecdt_ptr->control.address || !ecdt_ptr->data.address) {
1890 /*
1891 * Asus X50GL:
1892 * https://bugzilla.kernel.org/show_bug.cgi?id=11880
1893 */
fdb3c177 1894 return;
ed4b197d 1895 }
478fa03b 1896
fdb3c177
RW
1897 ec = acpi_ec_alloc();
1898 if (!ec)
1899 return;
1900
59f0aa94 1901 if (EC_FLAGS_CORRECT_ECDT) {
fd6231e7
LZ
1902 ec->command_addr = ecdt_ptr->data.address;
1903 ec->data_addr = ecdt_ptr->control.address;
c6cb0e87 1904 } else {
fd6231e7
LZ
1905 ec->command_addr = ecdt_ptr->control.address;
1906 ec->data_addr = ecdt_ptr->data.address;
c6cb0e87 1907 }
406857f7
DD
1908
1909 /*
1910 * Ignore the GPE value on Reduced Hardware platforms.
1911 * Some products have this set to an erroneous value.
1912 */
1913 if (!acpi_gbl_reduced_hardware)
1914 ec->gpe = ecdt_ptr->gpe;
1915
1568426c 1916 ec->handle = ACPI_ROOT_OBJECT;
2a570840
LZ
1917
1918 /*
1919 * At this point, the namespace is not initialized, so do not find
1920 * the namespace objects, or handle the events.
1921 */
a2b69177 1922 ret = acpi_ec_setup(ec, NULL);
1568426c 1923 if (ret) {
72c77b7e 1924 acpi_ec_free(ec);
1568426c
RW
1925 return;
1926 }
1927
1928 boot_ec = ec;
1929 boot_ec_is_ecdt = true;
1930
1931 pr_info("Boot ECDT EC used to handle transactions\n");
1da177e4
LT
1932}
1933
df45db61 1934#ifdef CONFIG_PM_SLEEP
39a2a2aa
LZ
1935static int acpi_ec_suspend(struct device *dev)
1936{
1937 struct acpi_ec *ec =
1938 acpi_driver_data(to_acpi_device(dev));
1939
6e86633a 1940 if (!pm_suspend_no_platform() && ec_freeze_events)
39a2a2aa
LZ
1941 acpi_ec_disable_event(ec);
1942 return 0;
1943}
1944
76380636
RW
1945static int acpi_ec_suspend_noirq(struct device *dev)
1946{
1947 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev));
1948
1949 /*
1950 * The SCI handler doesn't run at this point, so the GPE can be
1951 * masked at the low level without side effects.
1952 */
1953 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) &&
406857f7 1954 ec->gpe >= 0 && ec->reference_count >= 1)
76380636
RW
1955 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_DISABLE);
1956
fcd0a042 1957 acpi_ec_enter_noirq(ec);
3cd091a7 1958
76380636
RW
1959 return 0;
1960}
1961
1962static int acpi_ec_resume_noirq(struct device *dev)
1963{
1964 struct acpi_ec *ec = acpi_driver_data(to_acpi_device(dev));
1965
fcd0a042 1966 acpi_ec_leave_noirq(ec);
3cd091a7 1967
76380636 1968 if (ec_no_wakeup && test_bit(EC_FLAGS_STARTED, &ec->flags) &&
406857f7 1969 ec->gpe >= 0 && ec->reference_count >= 1)
76380636
RW
1970 acpi_set_gpe(NULL, ec->gpe, ACPI_GPE_ENABLE);
1971
1972 return 0;
1973}
1974
c2b46d67
LZ
1975static int acpi_ec_resume(struct device *dev)
1976{
1977 struct acpi_ec *ec =
1978 acpi_driver_data(to_acpi_device(dev));
1979
1980 acpi_ec_enable_event(ec);
1981 return 0;
1982}
d7589404
RW
1983
1984void acpi_ec_mark_gpe_for_wake(void)
1985{
1986 if (first_ec && !ec_no_wakeup)
1987 acpi_mark_gpe_for_wake(NULL, first_ec->gpe);
1988}
1989EXPORT_SYMBOL_GPL(acpi_ec_mark_gpe_for_wake);
1990
1991void acpi_ec_set_gpe_wake_mask(u8 action)
1992{
1993 if (pm_suspend_no_platform() && first_ec && !ec_no_wakeup)
1994 acpi_set_gpe_wake_mask(NULL, first_ec->gpe, action);
1995}
d7589404 1996
d5406284
RW
1997bool acpi_ec_other_gpes_active(void)
1998{
1999 return acpi_any_gpe_status_set(first_ec ? first_ec->gpe : U32_MAX);
2000}
2001
d7589404
RW
2002bool acpi_ec_dispatch_gpe(void)
2003{
2004 u32 ret;
2005
2006 if (!first_ec)
2007 return false;
2008
2009 ret = acpi_dispatch_gpe(NULL, first_ec->gpe);
29113f2f
RW
2010 if (ret == ACPI_INTERRUPT_HANDLED) {
2011 pm_pr_dbg("EC GPE dispatched\n");
2012 return true;
2013 }
2014 return false;
d7589404
RW
2015}
2016#endif /* CONFIG_PM_SLEEP */
df45db61
LZ
2017
2018static const struct dev_pm_ops acpi_ec_pm = {
76380636 2019 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend_noirq, acpi_ec_resume_noirq)
39a2a2aa 2020 SET_SYSTEM_SLEEP_PM_OPS(acpi_ec_suspend, acpi_ec_resume)
df45db61
LZ
2021};
2022
e4dca7b7
KC
2023static int param_set_event_clearing(const char *val,
2024 const struct kernel_param *kp)
1d68d261
LZ
2025{
2026 int result = 0;
2027
2028 if (!strncmp(val, "status", sizeof("status") - 1)) {
2029 ec_event_clearing = ACPI_EC_EVT_TIMING_STATUS;
2030 pr_info("Assuming SCI_EVT clearing on EC_SC accesses\n");
2031 } else if (!strncmp(val, "query", sizeof("query") - 1)) {
2032 ec_event_clearing = ACPI_EC_EVT_TIMING_QUERY;
2033 pr_info("Assuming SCI_EVT clearing on QR_EC writes\n");
2034 } else if (!strncmp(val, "event", sizeof("event") - 1)) {
2035 ec_event_clearing = ACPI_EC_EVT_TIMING_EVENT;
2036 pr_info("Assuming SCI_EVT clearing on event reads\n");
2037 } else
2038 result = -EINVAL;
2039 return result;
2040}
2041
e4dca7b7
KC
2042static int param_get_event_clearing(char *buffer,
2043 const struct kernel_param *kp)
1d68d261
LZ
2044{
2045 switch (ec_event_clearing) {
2046 case ACPI_EC_EVT_TIMING_STATUS:
2047 return sprintf(buffer, "status");
2048 case ACPI_EC_EVT_TIMING_QUERY:
2049 return sprintf(buffer, "query");
2050 case ACPI_EC_EVT_TIMING_EVENT:
2051 return sprintf(buffer, "event");
2052 default:
2053 return sprintf(buffer, "invalid");
2054 }
2055 return 0;
2056}
2057
2058module_param_call(ec_event_clearing, param_set_event_clearing, param_get_event_clearing,
2059 NULL, 0644);
2060MODULE_PARM_DESC(ec_event_clearing, "Assumed SCI_EVT clearing timing");
2061
223883b7
AS
2062static struct acpi_driver acpi_ec_driver = {
2063 .name = "ec",
2064 .class = ACPI_EC_CLASS,
2065 .ids = ec_device_ids,
2066 .ops = {
2067 .add = acpi_ec_add,
2068 .remove = acpi_ec_remove,
223883b7 2069 },
df45db61 2070 .drv.pm = &acpi_ec_pm,
223883b7
AS
2071};
2072
f0ac20c3 2073static void acpi_ec_destroy_workqueues(void)
e1191bd4 2074{
f0ac20c3
RW
2075 if (ec_wq) {
2076 destroy_workqueue(ec_wq);
2077 ec_wq = NULL;
e1191bd4 2078 }
e1191bd4
LZ
2079 if (ec_query_wq) {
2080 destroy_workqueue(ec_query_wq);
2081 ec_query_wq = NULL;
2082 }
2083}
2084
f0ac20c3
RW
2085static int acpi_ec_init_workqueues(void)
2086{
2087 if (!ec_wq)
2088 ec_wq = alloc_ordered_workqueue("kec", 0);
2089
2090 if (!ec_query_wq)
2091 ec_query_wq = alloc_workqueue("kec_query", 0, ec_max_queries);
2092
2093 if (!ec_wq || !ec_query_wq) {
2094 acpi_ec_destroy_workqueues();
2095 return -ENODEV;
2096 }
2097 return 0;
2098}
2099
8195a655
MW
2100static const struct dmi_system_id acpi_ec_no_wakeup[] = {
2101 {
2102 .ident = "Thinkpad X1 Carbon 6th",
2103 .matches = {
2104 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
2c4d6baf 2105 DMI_MATCH(DMI_PRODUCT_FAMILY, "Thinkpad X1 Carbon 6th"),
8195a655
MW
2106 },
2107 },
4c3be61e
MW
2108 {
2109 .ident = "ThinkPad X1 Carbon 6th",
2110 .matches = {
2111 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
2112 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Carbon 6th"),
2113 },
2114 },
b047c62e
AM
2115 {
2116 .ident = "ThinkPad X1 Yoga 3rd",
2117 .matches = {
2118 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
2119 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Yoga 3rd"),
2120 },
2121 },
8195a655
MW
2122 { },
2123};
2124
98ada3c5 2125void __init acpi_ec_init(void)
1da177e4 2126{
e1191bd4 2127 int result;
1da177e4 2128
f0ac20c3 2129 result = acpi_ec_init_workqueues();
e1191bd4 2130 if (result)
98ada3c5 2131 return;
1da177e4 2132
8195a655
MW
2133 /*
2134 * Disable EC wakeup on following systems to prevent periodic
2135 * wakeup from EC GPE.
2136 */
2137 if (dmi_check_system(acpi_ec_no_wakeup)) {
2138 ec_no_wakeup = true;
2139 pr_debug("Disabling EC wakeup on suspend-to-idle\n");
2140 }
2141
98ada3c5
RW
2142 /* Driver must be registered after acpi_ec_init_workqueues(). */
2143 acpi_bus_register_driver(&acpi_ec_driver);
2144
2145 acpi_ec_ecdt_start();
1da177e4
LT
2146}
2147
1da177e4
LT
2148/* EC driver currently not unloadable */
2149#if 0
50526df6 2150static void __exit acpi_ec_exit(void)
1da177e4 2151{
1da177e4
LT
2152
2153 acpi_bus_unregister_driver(&acpi_ec_driver);
f0ac20c3 2154 acpi_ec_destroy_workqueues();
1da177e4 2155}
7843932a 2156#endif /* 0 */