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