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