?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
x86/xen: resume timer irqs early
[linux/fpc-iii.git] / drivers / acpi / ec.c
blob7171d52e12ca32e8b341c29668f5815fdffad9d0
1 /*
2 * ec.c - ACPI Embedded Controller Driver (v2.1)
3 *
4 * Copyright (C) 2006-2008 Alexey Starikovskiy <astarikovskiy@suse.de>
5 * Copyright (C) 2006 Denis Sadykov <denis.m.sadykov@intel.com>
6 * Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
7 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
8 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
9 *
10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or (at
15 * your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
25 *
26 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 */
28
29 /* Uncomment next line to get verbose printout */
30 /* #define DEBUG */
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 <asm/io.h>
42 #include <acpi/acpi_bus.h>
43 #include <acpi/acpi_drivers.h>
44 #include <linux/dmi.h>
45
46 #include "internal.h"
47
48 #define ACPI_EC_CLASS "embedded_controller"
49 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
50 #define ACPI_EC_FILE_INFO "info"
51
52 #undef PREFIX
53 #define PREFIX "ACPI: EC: "
54
55 /* EC status register */
56 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
57 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
58 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
59 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
60
61 /* EC commands */
62 enum ec_command {
63 ACPI_EC_COMMAND_READ = 0x80,
64 ACPI_EC_COMMAND_WRITE = 0x81,
65 ACPI_EC_BURST_ENABLE = 0x82,
66 ACPI_EC_BURST_DISABLE = 0x83,
67 ACPI_EC_COMMAND_QUERY = 0x84,
68 };
69
70 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
71 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
72 #define ACPI_EC_MSI_UDELAY 550 /* Wait 550us for MSI EC */
73 #define ACPI_EC_CLEAR_MAX 100 /* Maximum number of events to query
74 * when trying to clear the EC */
75
76 enum {
77 EC_FLAGS_QUERY_PENDING, /* Query is pending */
78 EC_FLAGS_GPE_STORM, /* GPE storm detected */
79 EC_FLAGS_HANDLERS_INSTALLED, /* Handlers for GPE and
80 * OpReg are installed */
81 EC_FLAGS_BLOCKED, /* Transactions are blocked */
82 };
83
84 #define ACPI_EC_COMMAND_POLL 0x01 /* Available for command byte */
85 #define ACPI_EC_COMMAND_COMPLETE 0x02 /* Completed last byte */
86
87 /* ec.c is compiled in acpi namespace so this shows up as acpi.ec_delay param */
88 static unsigned int ec_delay __read_mostly = ACPI_EC_DELAY;
89 module_param(ec_delay, uint, 0644);
90 MODULE_PARM_DESC(ec_delay, "Timeout(ms) waited until an EC command completes");
91
92 /*
93 * If the number of false interrupts per one transaction exceeds
94 * this threshold, will think there is a GPE storm happened and
95 * will disable the GPE for normal transaction.
96 */
97 static unsigned int ec_storm_threshold __read_mostly = 8;
98 module_param(ec_storm_threshold, uint, 0644);
99 MODULE_PARM_DESC(ec_storm_threshold, "Maxim false GPE numbers not considered as GPE storm");
100
101 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
102 /* External interfaces use first EC only, so remember */
103 typedef int (*acpi_ec_query_func) (void *data);
104
105 struct acpi_ec_query_handler {
106 struct list_head node;
107 acpi_ec_query_func func;
108 acpi_handle handle;
109 void *data;
110 u8 query_bit;
111 };
112
113 struct transaction {
114 const u8 *wdata;
115 u8 *rdata;
116 unsigned short irq_count;
117 u8 command;
118 u8 wi;
119 u8 ri;
120 u8 wlen;
121 u8 rlen;
122 u8 flags;
123 };
124
125 struct acpi_ec *boot_ec, *first_ec;
126 EXPORT_SYMBOL(first_ec);
127
128 static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
129 static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
130 static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
131 static int EC_FLAGS_CLEAR_ON_RESUME; /* Needs acpi_ec_clear() on boot/resume */
132
133 /* --------------------------------------------------------------------------
134 Transaction Management
135 -------------------------------------------------------------------------- */
136
137 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
138 {
139 u8 x = inb(ec->command_addr);
140 pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
141 return x;
142 }
143
144 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
145 {
146 u8 x = inb(ec->data_addr);
147 pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
148 return x;
149 }
150
151 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
152 {
153 pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
154 outb(command, ec->command_addr);
155 }
156
157 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
158 {
159 pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
160 outb(data, ec->data_addr);
161 }
162
163 static int ec_transaction_completed(struct acpi_ec *ec)
164 {
165 unsigned long flags;
166 int ret = 0;
167 spin_lock_irqsave(&ec->lock, flags);
168 if (ec->curr && (ec->curr->flags & ACPI_EC_COMMAND_COMPLETE))
169 ret = 1;
170 spin_unlock_irqrestore(&ec->lock, flags);
171 return ret;
172 }
173
174 static bool advance_transaction(struct acpi_ec *ec)
175 {
176 struct transaction *t;
177 u8 status;
178 bool wakeup = false;
179
180 pr_debug("===== %s =====\n", in_interrupt() ? "IRQ" : "TASK");
181 status = acpi_ec_read_status(ec);
182 t = ec->curr;
183 if (!t)
184 goto err;
185 if (t->flags & ACPI_EC_COMMAND_POLL) {
186 if (t->wlen > t->wi) {
187 if ((status & ACPI_EC_FLAG_IBF) == 0)
188 acpi_ec_write_data(ec, t->wdata[t->wi++]);
189 else
190 goto err;
191 } else if (t->rlen > t->ri) {
192 if ((status & ACPI_EC_FLAG_OBF) == 1) {
193 t->rdata[t->ri++] = acpi_ec_read_data(ec);
194 if (t->rlen == t->ri) {
195 t->flags |= ACPI_EC_COMMAND_COMPLETE;
196 wakeup = true;
197 }
198 } else
199 goto err;
200 } else if (t->wlen == t->wi &&
201 (status & ACPI_EC_FLAG_IBF) == 0) {
202 t->flags |= ACPI_EC_COMMAND_COMPLETE;
203 wakeup = true;
204 }
205 return wakeup;
206 } else {
207 if ((status & ACPI_EC_FLAG_IBF) == 0) {
208 acpi_ec_write_cmd(ec, t->command);
209 t->flags |= ACPI_EC_COMMAND_POLL;
210 } else
211 goto err;
212 return wakeup;
213 }
214 err:
215 /*
216 * If SCI bit is set, then don't think it's a false IRQ
217 * otherwise will take a not handled IRQ as a false one.
218 */
219 if (!(status & ACPI_EC_FLAG_SCI)) {
220 if (in_interrupt() && t)
221 ++t->irq_count;
222 }
223 return wakeup;
224 }
225
226 static void start_transaction(struct acpi_ec *ec)
227 {
228 ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
229 ec->curr->flags = 0;
230 (void)advance_transaction(ec);
231 }
232
233 static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data);
234
235 static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
236 {
237 if (state & ACPI_EC_FLAG_SCI) {
238 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
239 return acpi_ec_sync_query(ec, NULL);
240 }
241 return 0;
242 }
243
244 static int ec_poll(struct acpi_ec *ec)
245 {
246 unsigned long flags;
247 int repeat = 5; /* number of command restarts */
248 while (repeat--) {
249 unsigned long delay = jiffies +
250 msecs_to_jiffies(ec_delay);
251 do {
252 /* don't sleep with disabled interrupts */
253 if (EC_FLAGS_MSI || irqs_disabled()) {
254 udelay(ACPI_EC_MSI_UDELAY);
255 if (ec_transaction_completed(ec))
256 return 0;
257 } else {
258 if (wait_event_timeout(ec->wait,
259 ec_transaction_completed(ec),
260 msecs_to_jiffies(1)))
261 return 0;
262 }
263 spin_lock_irqsave(&ec->lock, flags);
264 (void)advance_transaction(ec);
265 spin_unlock_irqrestore(&ec->lock, flags);
266 } while (time_before(jiffies, delay));
267 pr_debug(PREFIX "controller reset, restart transaction\n");
268 spin_lock_irqsave(&ec->lock, flags);
269 start_transaction(ec);
270 spin_unlock_irqrestore(&ec->lock, flags);
271 }
272 return -ETIME;
273 }
274
275 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
276 struct transaction *t)
277 {
278 unsigned long tmp;
279 int ret = 0;
280 if (EC_FLAGS_MSI)
281 udelay(ACPI_EC_MSI_UDELAY);
282 /* start transaction */
283 spin_lock_irqsave(&ec->lock, tmp);
284 /* following two actions should be kept atomic */
285 ec->curr = t;
286 start_transaction(ec);
287 if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
288 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
289 spin_unlock_irqrestore(&ec->lock, tmp);
290 ret = ec_poll(ec);
291 spin_lock_irqsave(&ec->lock, tmp);
292 ec->curr = NULL;
293 spin_unlock_irqrestore(&ec->lock, tmp);
294 return ret;
295 }
296
297 static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
298 {
299 int status;
300 u32 glk;
301 if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
302 return -EINVAL;
303 if (t->rdata)
304 memset(t->rdata, 0, t->rlen);
305 mutex_lock(&ec->mutex);
306 if (test_bit(EC_FLAGS_BLOCKED, &ec->flags)) {
307 status = -EINVAL;
308 goto unlock;
309 }
310 if (ec->global_lock) {
311 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
312 if (ACPI_FAILURE(status)) {
313 status = -ENODEV;
314 goto unlock;
315 }
316 }
317 pr_debug(PREFIX "transaction start (cmd=0x%02x, addr=0x%02x)\n",
318 t->command, t->wdata ? t->wdata[0] : 0);
319 /* disable GPE during transaction if storm is detected */
320 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
321 /* It has to be disabled, so that it doesn't trigger. */
322 acpi_disable_gpe(NULL, ec->gpe);
323 }
324
325 status = acpi_ec_transaction_unlocked(ec, t);
326
327 /* check if we received SCI during transaction */
328 ec_check_sci_sync(ec, acpi_ec_read_status(ec));
329 if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
330 msleep(1);
331 /* It is safe to enable the GPE outside of the transaction. */
332 acpi_enable_gpe(NULL, ec->gpe);
333 } else if (t->irq_count > ec_storm_threshold) {
334 pr_info(PREFIX "GPE storm detected(%d GPEs), "
335 "transactions will use polling mode\n",
336 t->irq_count);
337 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
338 }
339 pr_debug(PREFIX "transaction end\n");
340 if (ec->global_lock)
341 acpi_release_global_lock(glk);
342 unlock:
343 mutex_unlock(&ec->mutex);
344 return status;
345 }
346
347 static int acpi_ec_burst_enable(struct acpi_ec *ec)
348 {
349 u8 d;
350 struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
351 .wdata = NULL, .rdata = &d,
352 .wlen = 0, .rlen = 1};
353
354 return acpi_ec_transaction(ec, &t);
355 }
356
357 static int acpi_ec_burst_disable(struct acpi_ec *ec)
358 {
359 struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
360 .wdata = NULL, .rdata = NULL,
361 .wlen = 0, .rlen = 0};
362
363 return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
364 acpi_ec_transaction(ec, &t) : 0;
365 }
366
367 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
368 {
369 int result;
370 u8 d;
371 struct transaction t = {.command = ACPI_EC_COMMAND_READ,
372 .wdata = &address, .rdata = &d,
373 .wlen = 1, .rlen = 1};
374
375 result = acpi_ec_transaction(ec, &t);
376 *data = d;
377 return result;
378 }
379
380 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
381 {
382 u8 wdata[2] = { address, data };
383 struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
384 .wdata = wdata, .rdata = NULL,
385 .wlen = 2, .rlen = 0};
386
387 return acpi_ec_transaction(ec, &t);
388 }
389
390 /*
391 * Externally callable EC access functions. For now, assume 1 EC only
392 */
393 int ec_burst_enable(void)
394 {
395 if (!first_ec)
396 return -ENODEV;
397 return acpi_ec_burst_enable(first_ec);
398 }
399
400 EXPORT_SYMBOL(ec_burst_enable);
401
402 int ec_burst_disable(void)
403 {
404 if (!first_ec)
405 return -ENODEV;
406 return acpi_ec_burst_disable(first_ec);
407 }
408
409 EXPORT_SYMBOL(ec_burst_disable);
410
411 int ec_read(u8 addr, u8 *val)
412 {
413 int err;
414 u8 temp_data;
415
416 if (!first_ec)
417 return -ENODEV;
418
419 err = acpi_ec_read(first_ec, addr, &temp_data);
420
421 if (!err) {
422 *val = temp_data;
423 return 0;
424 } else
425 return err;
426 }
427
428 EXPORT_SYMBOL(ec_read);
429
430 int ec_write(u8 addr, u8 val)
431 {
432 int err;
433
434 if (!first_ec)
435 return -ENODEV;
436
437 err = acpi_ec_write(first_ec, addr, val);
438
439 return err;
440 }
441
442 EXPORT_SYMBOL(ec_write);
443
444 int ec_transaction(u8 command,
445 const u8 * wdata, unsigned wdata_len,
446 u8 * rdata, unsigned rdata_len)
447 {
448 struct transaction t = {.command = command,
449 .wdata = wdata, .rdata = rdata,
450 .wlen = wdata_len, .rlen = rdata_len};
451 if (!first_ec)
452 return -ENODEV;
453
454 return acpi_ec_transaction(first_ec, &t);
455 }
456
457 EXPORT_SYMBOL(ec_transaction);
458
459 /* Get the handle to the EC device */
460 acpi_handle ec_get_handle(void)
461 {
462 if (!first_ec)
463 return NULL;
464 return first_ec->handle;
465 }
466
467 EXPORT_SYMBOL(ec_get_handle);
468
469 /*
470 * Process _Q events that might have accumulated in the EC.
471 * Run with locked ec mutex.
472 */
473 static void acpi_ec_clear(struct acpi_ec *ec)
474 {
475 int i, status;
476 u8 value = 0;
477
478 for (i = 0; i < ACPI_EC_CLEAR_MAX; i++) {
479 status = acpi_ec_sync_query(ec, &value);
480 if (status || !value)
481 break;
482 }
483
484 if (unlikely(i == ACPI_EC_CLEAR_MAX))
485 pr_warn("Warning: Maximum of %d stale EC events cleared\n", i);
486 else
487 pr_info("%d stale EC events cleared\n", i);
488 }
489
490 void acpi_ec_block_transactions(void)
491 {
492 struct acpi_ec *ec = first_ec;
493
494 if (!ec)
495 return;
496
497 mutex_lock(&ec->mutex);
498 /* Prevent transactions from being carried out */
499 set_bit(EC_FLAGS_BLOCKED, &ec->flags);
500 mutex_unlock(&ec->mutex);
501 }
502
503 void acpi_ec_unblock_transactions(void)
504 {
505 struct acpi_ec *ec = first_ec;
506
507 if (!ec)
508 return;
509
510 mutex_lock(&ec->mutex);
511 /* Allow transactions to be carried out again */
512 clear_bit(EC_FLAGS_BLOCKED, &ec->flags);
513
514 if (EC_FLAGS_CLEAR_ON_RESUME)
515 acpi_ec_clear(ec);
516
517 mutex_unlock(&ec->mutex);
518 }
519
520 void acpi_ec_unblock_transactions_early(void)
521 {
522 /*
523 * Allow transactions to happen again (this function is called from
524 * atomic context during wakeup, so we don't need to acquire the mutex).
525 */
526 if (first_ec)
527 clear_bit(EC_FLAGS_BLOCKED, &first_ec->flags);
528 }
529
530 static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
531 {
532 int result;
533 u8 d;
534 struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
535 .wdata = NULL, .rdata = &d,
536 .wlen = 0, .rlen = 1};
537 if (!ec || !data)
538 return -EINVAL;
539 /*
540 * Query the EC to find out which _Qxx method we need to evaluate.
541 * Note that successful completion of the query causes the ACPI_EC_SCI
542 * bit to be cleared (and thus clearing the interrupt source).
543 */
544 result = acpi_ec_transaction_unlocked(ec, &t);
545 if (result)
546 return result;
547 if (!d)
548 return -ENODATA;
549 *data = d;
550 return 0;
551 }
552
553 /* --------------------------------------------------------------------------
554 Event Management
555 -------------------------------------------------------------------------- */
556 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
557 acpi_handle handle, acpi_ec_query_func func,
558 void *data)
559 {
560 struct acpi_ec_query_handler *handler =
561 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
562 if (!handler)
563 return -ENOMEM;
564
565 handler->query_bit = query_bit;
566 handler->handle = handle;
567 handler->func = func;
568 handler->data = data;
569 mutex_lock(&ec->mutex);
570 list_add(&handler->node, &ec->list);
571 mutex_unlock(&ec->mutex);
572 return 0;
573 }
574
575 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
576
577 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
578 {
579 struct acpi_ec_query_handler *handler, *tmp;
580 mutex_lock(&ec->mutex);
581 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
582 if (query_bit == handler->query_bit) {
583 list_del(&handler->node);
584 kfree(handler);
585 }
586 }
587 mutex_unlock(&ec->mutex);
588 }
589
590 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
591
592 static void acpi_ec_run(void *cxt)
593 {
594 struct acpi_ec_query_handler *handler = cxt;
595 if (!handler)
596 return;
597 pr_debug(PREFIX "start query execution\n");
598 if (handler->func)
599 handler->func(handler->data);
600 else if (handler->handle)
601 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
602 pr_debug(PREFIX "stop query execution\n");
603 kfree(handler);
604 }
605
606 static int acpi_ec_sync_query(struct acpi_ec *ec, u8 *data)
607 {
608 u8 value = 0;
609 int status;
610 struct acpi_ec_query_handler *handler, *copy;
611
612 status = acpi_ec_query_unlocked(ec, &value);
613 if (data)
614 *data = value;
615 if (status)
616 return status;
617
618 list_for_each_entry(handler, &ec->list, node) {
619 if (value == handler->query_bit) {
620 /* have custom handler for this bit */
621 copy = kmalloc(sizeof(*handler), GFP_KERNEL);
622 if (!copy)
623 return -ENOMEM;
624 memcpy(copy, handler, sizeof(*copy));
625 pr_debug(PREFIX "push query execution (0x%2x) on queue\n", value);
626 return acpi_os_execute((copy->func) ?
627 OSL_NOTIFY_HANDLER : OSL_GPE_HANDLER,
628 acpi_ec_run, copy);
629 }
630 }
631 return 0;
632 }
633
634 static void acpi_ec_gpe_query(void *ec_cxt)
635 {
636 struct acpi_ec *ec = ec_cxt;
637 if (!ec)
638 return;
639 mutex_lock(&ec->mutex);
640 acpi_ec_sync_query(ec, NULL);
641 mutex_unlock(&ec->mutex);
642 }
643
644 static int ec_check_sci(struct acpi_ec *ec, u8 state)
645 {
646 if (state & ACPI_EC_FLAG_SCI) {
647 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
648 pr_debug(PREFIX "push gpe query to the queue\n");
649 return acpi_os_execute(OSL_NOTIFY_HANDLER,
650 acpi_ec_gpe_query, ec);
651 }
652 }
653 return 0;
654 }
655
656 static u32 acpi_ec_gpe_handler(acpi_handle gpe_device,
657 u32 gpe_number, void *data)
658 {
659 unsigned long flags;
660 struct acpi_ec *ec = data;
661
662 spin_lock_irqsave(&ec->lock, flags);
663 if (advance_transaction(ec))
664 wake_up(&ec->wait);
665 spin_unlock_irqrestore(&ec->lock, flags);
666 ec_check_sci(ec, acpi_ec_read_status(ec));
667 return ACPI_INTERRUPT_HANDLED | ACPI_REENABLE_GPE;
668 }
669
670 /* --------------------------------------------------------------------------
671 Address Space Management
672 -------------------------------------------------------------------------- */
673
674 static acpi_status
675 acpi_ec_space_handler(u32 function, acpi_physical_address address,
676 u32 bits, u64 *value64,
677 void *handler_context, void *region_context)
678 {
679 struct acpi_ec *ec = handler_context;
680 int result = 0, i, bytes = bits / 8;
681 u8 *value = (u8 *)value64;
682
683 if ((address > 0xFF) || !value || !handler_context)
684 return AE_BAD_PARAMETER;
685
686 if (function != ACPI_READ && function != ACPI_WRITE)
687 return AE_BAD_PARAMETER;
688
689 if (EC_FLAGS_MSI || bits > 8)
690 acpi_ec_burst_enable(ec);
691
692 for (i = 0; i < bytes; ++i, ++address, ++value)
693 result = (function == ACPI_READ) ?
694 acpi_ec_read(ec, address, value) :
695 acpi_ec_write(ec, address, *value);
696
697 if (EC_FLAGS_MSI || bits > 8)
698 acpi_ec_burst_disable(ec);
699
700 switch (result) {
701 case -EINVAL:
702 return AE_BAD_PARAMETER;
703 break;
704 case -ENODEV:
705 return AE_NOT_FOUND;
706 break;
707 case -ETIME:
708 return AE_TIME;
709 break;
710 default:
711 return AE_OK;
712 }
713 }
714
715 /* --------------------------------------------------------------------------
716 Driver Interface
717 -------------------------------------------------------------------------- */
718 static acpi_status
719 ec_parse_io_ports(struct acpi_resource *resource, void *context);
720
721 static struct acpi_ec *make_acpi_ec(void)
722 {
723 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
724 if (!ec)
725 return NULL;
726 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
727 mutex_init(&ec->mutex);
728 init_waitqueue_head(&ec->wait);
729 INIT_LIST_HEAD(&ec->list);
730 spin_lock_init(&ec->lock);
731 return ec;
732 }
733
734 static acpi_status
735 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
736 void *context, void **return_value)
737 {
738 char node_name[5];
739 struct acpi_buffer buffer = { sizeof(node_name), node_name };
740 struct acpi_ec *ec = context;
741 int value = 0;
742 acpi_status status;
743
744 status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
745
746 if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
747 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
748 }
749 return AE_OK;
750 }
751
752 static acpi_status
753 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
754 {
755 acpi_status status;
756 unsigned long long tmp = 0;
757
758 struct acpi_ec *ec = context;
759
760 /* clear addr values, ec_parse_io_ports depend on it */
761 ec->command_addr = ec->data_addr = 0;
762
763 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
764 ec_parse_io_ports, ec);
765 if (ACPI_FAILURE(status))
766 return status;
767
768 /* Get GPE bit assignment (EC events). */
769 /* TODO: Add support for _GPE returning a package */
770 status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
771 if (ACPI_FAILURE(status))
772 return status;
773 ec->gpe = tmp;
774 /* Use the global lock for all EC transactions? */
775 tmp = 0;
776 acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
777 ec->global_lock = tmp;
778 ec->handle = handle;
779 return AE_CTRL_TERMINATE;
780 }
781
782 static int ec_install_handlers(struct acpi_ec *ec)
783 {
784 acpi_status status;
785 if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
786 return 0;
787 status = acpi_install_gpe_handler(NULL, ec->gpe,
788 ACPI_GPE_EDGE_TRIGGERED,
789 &acpi_ec_gpe_handler, ec);
790 if (ACPI_FAILURE(status))
791 return -ENODEV;
792
793 acpi_enable_gpe(NULL, ec->gpe);
794 status = acpi_install_address_space_handler(ec->handle,
795 ACPI_ADR_SPACE_EC,
796 &acpi_ec_space_handler,
797 NULL, ec);
798 if (ACPI_FAILURE(status)) {
799 if (status == AE_NOT_FOUND) {
800 /*
801 * Maybe OS fails in evaluating the _REG object.
802 * The AE_NOT_FOUND error will be ignored and OS
803 * continue to initialize EC.
804 */
805 printk(KERN_ERR "Fail in evaluating the _REG object"
806 " of EC device. Broken bios is suspected.\n");
807 } else {
808 acpi_remove_gpe_handler(NULL, ec->gpe,
809 &acpi_ec_gpe_handler);
810 acpi_disable_gpe(NULL, ec->gpe);
811 return -ENODEV;
812 }
813 }
814
815 set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
816 return 0;
817 }
818
819 static void ec_remove_handlers(struct acpi_ec *ec)
820 {
821 acpi_disable_gpe(NULL, ec->gpe);
822 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
823 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
824 pr_err(PREFIX "failed to remove space handler\n");
825 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
826 &acpi_ec_gpe_handler)))
827 pr_err(PREFIX "failed to remove gpe handler\n");
828 clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
829 }
830
831 static int acpi_ec_add(struct acpi_device *device)
832 {
833 struct acpi_ec *ec = NULL;
834 int ret;
835
836 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
837 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
838
839 /* Check for boot EC */
840 if (boot_ec &&
841 (boot_ec->handle == device->handle ||
842 boot_ec->handle == ACPI_ROOT_OBJECT)) {
843 ec = boot_ec;
844 boot_ec = NULL;
845 } else {
846 ec = make_acpi_ec();
847 if (!ec)
848 return -ENOMEM;
849 }
850 if (ec_parse_device(device->handle, 0, ec, NULL) !=
851 AE_CTRL_TERMINATE) {
852 kfree(ec);
853 return -EINVAL;
854 }
855
856 /* Find and register all query methods */
857 acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
858 acpi_ec_register_query_methods, NULL, ec, NULL);
859
860 if (!first_ec)
861 first_ec = ec;
862 device->driver_data = ec;
863
864 ret = !!request_region(ec->data_addr, 1, "EC data");
865 WARN(!ret, "Could not request EC data io port 0x%lx", ec->data_addr);
866 ret = !!request_region(ec->command_addr, 1, "EC cmd");
867 WARN(!ret, "Could not request EC cmd io port 0x%lx", ec->command_addr);
868
869 pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
870 ec->gpe, ec->command_addr, ec->data_addr);
871
872 ret = ec_install_handlers(ec);
873
874 /* EC is fully operational, allow queries */
875 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
876
877 /* Clear stale _Q events if hardware might require that */
878 if (EC_FLAGS_CLEAR_ON_RESUME) {
879 mutex_lock(&ec->mutex);
880 acpi_ec_clear(ec);
881 mutex_unlock(&ec->mutex);
882 }
883 return ret;
884 }
885
886 static int acpi_ec_remove(struct acpi_device *device)
887 {
888 struct acpi_ec *ec;
889 struct acpi_ec_query_handler *handler, *tmp;
890
891 if (!device)
892 return -EINVAL;
893
894 ec = acpi_driver_data(device);
895 ec_remove_handlers(ec);
896 mutex_lock(&ec->mutex);
897 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
898 list_del(&handler->node);
899 kfree(handler);
900 }
901 mutex_unlock(&ec->mutex);
902 release_region(ec->data_addr, 1);
903 release_region(ec->command_addr, 1);
904 device->driver_data = NULL;
905 if (ec == first_ec)
906 first_ec = NULL;
907 kfree(ec);
908 return 0;
909 }
910
911 static acpi_status
912 ec_parse_io_ports(struct acpi_resource *resource, void *context)
913 {
914 struct acpi_ec *ec = context;
915
916 if (resource->type != ACPI_RESOURCE_TYPE_IO)
917 return AE_OK;
918
919 /*
920 * The first address region returned is the data port, and
921 * the second address region returned is the status/command
922 * port.
923 */
924 if (ec->data_addr == 0)
925 ec->data_addr = resource->data.io.minimum;
926 else if (ec->command_addr == 0)
927 ec->command_addr = resource->data.io.minimum;
928 else
929 return AE_CTRL_TERMINATE;
930
931 return AE_OK;
932 }
933
934 int __init acpi_boot_ec_enable(void)
935 {
936 if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
937 return 0;
938 if (!ec_install_handlers(boot_ec)) {
939 first_ec = boot_ec;
940 return 0;
941 }
942 return -EFAULT;
943 }
944
945 static const struct acpi_device_id ec_device_ids[] = {
946 {"PNP0C09", 0},
947 {"", 0},
948 };
949
950 /* Some BIOS do not survive early DSDT scan, skip it */
951 static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
952 {
953 EC_FLAGS_SKIP_DSDT_SCAN = 1;
954 return 0;
955 }
956
957 /* ASUStek often supplies us with broken ECDT, validate it */
958 static int ec_validate_ecdt(const struct dmi_system_id *id)
959 {
960 EC_FLAGS_VALIDATE_ECDT = 1;
961 return 0;
962 }
963
964 /* MSI EC needs special treatment, enable it */
965 static int ec_flag_msi(const struct dmi_system_id *id)
966 {
967 printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
968 EC_FLAGS_MSI = 1;
969 EC_FLAGS_VALIDATE_ECDT = 1;
970 return 0;
971 }
972
973 /*
974 * Clevo M720 notebook actually works ok with IRQ mode, if we lifted
975 * the GPE storm threshold back to 20
976 */
977 static int ec_enlarge_storm_threshold(const struct dmi_system_id *id)
978 {
979 pr_debug("Setting the EC GPE storm threshold to 20\n");
980 ec_storm_threshold = 20;
981 return 0;
982 }
983
984 /*
985 * On some hardware it is necessary to clear events accumulated by the EC during
986 * sleep. These ECs stop reporting GPEs until they are manually polled, if too
987 * many events are accumulated. (e.g. Samsung Series 5/9 notebooks)
988 *
989 * https://bugzilla.kernel.org/show_bug.cgi?id=44161
990 *
991 * Ideally, the EC should also be instructed NOT to accumulate events during
992 * sleep (which Windows seems to do somehow), but the interface to control this
993 * behaviour is not known at this time.
994 *
995 * Models known to be affected are Samsung 530Uxx/535Uxx/540Uxx/550Pxx/900Xxx,
996 * however it is very likely that other Samsung models are affected.
997 *
998 * On systems which don't accumulate _Q events during sleep, this extra check
999 * should be harmless.
1000 */
1001 static int ec_clear_on_resume(const struct dmi_system_id *id)
1002 {
1003 pr_debug("Detected system needing EC poll on resume.\n");
1004 EC_FLAGS_CLEAR_ON_RESUME = 1;
1005 return 0;
1006 }
1007
1008 static struct dmi_system_id ec_dmi_table[] __initdata = {
1009 {
1010 ec_skip_dsdt_scan, "Compal JFL92", {
1011 DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
1012 DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
1013 {
1014 ec_flag_msi, "MSI hardware", {
1015 DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
1016 {
1017 ec_flag_msi, "MSI hardware", {
1018 DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
1019 {
1020 ec_flag_msi, "MSI hardware", {
1021 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
1022 {
1023 ec_flag_msi, "MSI hardware", {
1024 DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL},
1025 {
1026 ec_flag_msi, "Quanta hardware", {
1027 DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
1028 DMI_MATCH(DMI_PRODUCT_NAME, "TW8/SW8/DW8"),}, NULL},
1029 {
1030 ec_flag_msi, "Quanta hardware", {
1031 DMI_MATCH(DMI_SYS_VENDOR, "Quanta"),
1032 DMI_MATCH(DMI_PRODUCT_NAME, "TW9/SW9"),}, NULL},
1033 {
1034 ec_validate_ecdt, "ASUS hardware", {
1035 DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
1036 {
1037 ec_validate_ecdt, "ASUS hardware", {
1038 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer Inc.") }, NULL},
1039 {
1040 ec_enlarge_storm_threshold, "CLEVO hardware", {
1041 DMI_MATCH(DMI_SYS_VENDOR, "CLEVO Co."),
1042 DMI_MATCH(DMI_PRODUCT_NAME, "M720T/M730T"),}, NULL},
1043 {
1044 ec_skip_dsdt_scan, "HP Folio 13", {
1045 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1046 DMI_MATCH(DMI_PRODUCT_NAME, "HP Folio 13"),}, NULL},
1047 {
1048 ec_validate_ecdt, "ASUS hardware", {
1049 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTek Computer Inc."),
1050 DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),}, NULL},
1051 {
1052 ec_clear_on_resume, "Samsung hardware", {
1053 DMI_MATCH(DMI_SYS_VENDOR, "SAMSUNG ELECTRONICS CO., LTD.")}, NULL},
1054 {},
1055 };
1056
1057 int __init acpi_ec_ecdt_probe(void)
1058 {
1059 acpi_status status;
1060 struct acpi_ec *saved_ec = NULL;
1061 struct acpi_table_ecdt *ecdt_ptr;
1062
1063 boot_ec = make_acpi_ec();
1064 if (!boot_ec)
1065 return -ENOMEM;
1066 /*
1067 * Generate a boot ec context
1068 */
1069 dmi_check_system(ec_dmi_table);
1070 status = acpi_get_table(ACPI_SIG_ECDT, 1,
1071 (struct acpi_table_header **)&ecdt_ptr);
1072 if (ACPI_SUCCESS(status)) {
1073 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
1074 boot_ec->command_addr = ecdt_ptr->control.address;
1075 boot_ec->data_addr = ecdt_ptr->data.address;
1076 boot_ec->gpe = ecdt_ptr->gpe;
1077 boot_ec->handle = ACPI_ROOT_OBJECT;
1078 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
1079 /* Don't trust ECDT, which comes from ASUSTek */
1080 if (!EC_FLAGS_VALIDATE_ECDT)
1081 goto install;
1082 saved_ec = kmemdup(boot_ec, sizeof(struct acpi_ec), GFP_KERNEL);
1083 if (!saved_ec)
1084 return -ENOMEM;
1085 /* fall through */
1086 }
1087
1088 if (EC_FLAGS_SKIP_DSDT_SCAN)
1089 return -ENODEV;
1090
1091 /* This workaround is needed only on some broken machines,
1092 * which require early EC, but fail to provide ECDT */
1093 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
1094 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
1095 boot_ec, NULL);
1096 /* Check that acpi_get_devices actually find something */
1097 if (ACPI_FAILURE(status) || !boot_ec->handle)
1098 goto error;
1099 if (saved_ec) {
1100 /* try to find good ECDT from ASUSTek */
1101 if (saved_ec->command_addr != boot_ec->command_addr ||
1102 saved_ec->data_addr != boot_ec->data_addr ||
1103 saved_ec->gpe != boot_ec->gpe ||
1104 saved_ec->handle != boot_ec->handle)
1105 pr_info(PREFIX "ASUSTek keeps feeding us with broken "
1106 "ECDT tables, which are very hard to workaround. "
1107 "Trying to use DSDT EC info instead. Please send "
1108 "output of acpidump to linux-acpi@vger.kernel.org\n");
1109 kfree(saved_ec);
1110 saved_ec = NULL;
1111 } else {
1112 /* We really need to limit this workaround, the only ASUS,
1113 * which needs it, has fake EC._INI method, so use it as flag.
1114 * Keep boot_ec struct as it will be needed soon.
1115 */
1116 if (!dmi_name_in_vendors("ASUS") ||
1117 !acpi_has_method(boot_ec->handle, "_INI"))
1118 return -ENODEV;
1119 }
1120 install:
1121 if (!ec_install_handlers(boot_ec)) {
1122 first_ec = boot_ec;
1123 return 0;
1124 }
1125 error:
1126 kfree(boot_ec);
1127 boot_ec = NULL;
1128 return -ENODEV;
1129 }
1130
1131 static struct acpi_driver acpi_ec_driver = {
1132 .name = "ec",
1133 .class = ACPI_EC_CLASS,
1134 .ids = ec_device_ids,
1135 .ops = {
1136 .add = acpi_ec_add,
1137 .remove = acpi_ec_remove,
1138 },
1139 };
1140
1141 int __init acpi_ec_init(void)
1142 {
1143 int result = 0;
1144
1145 /* Now register the driver for the EC */
1146 result = acpi_bus_register_driver(&acpi_ec_driver);
1147 if (result < 0)
1148 return -ENODEV;
1149
1150 return result;
1151 }
1152
1153 /* EC driver currently not unloadable */
1154 #if 0
1155 static void __exit acpi_ec_exit(void)
1156 {
1157
1158 acpi_bus_unregister_driver(&acpi_ec_driver);
1159 return;
1160 }
1161 #endif /* 0 */
Linux with added FPC-III support