?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
ACPI: EC: Some hardware requires burst mode to operate properly
[linux-2.6.git] / drivers / acpi / ec.c
blob445ecbabbe7686c3a2a00a548a96821cd02d46be
1 /*
2 * ec.c - ACPI Embedded Controller Driver (v2.0)
3 *
4 * Copyright (C) 2006, 2007 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
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 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/types.h>
33 #include <linux/delay.h>
34 #include <linux/proc_fs.h>
35 #include <linux/seq_file.h>
36 #include <linux/interrupt.h>
37 #include <linux/list.h>
38 #include <asm/io.h>
39 #include <acpi/acpi_bus.h>
40 #include <acpi/acpi_drivers.h>
41 #include <acpi/actypes.h>
42
43 #define ACPI_EC_CLASS "embedded_controller"
44 #define ACPI_EC_DEVICE_NAME "Embedded Controller"
45 #define ACPI_EC_FILE_INFO "info"
46
47 #undef PREFIX
48 #define PREFIX "ACPI: EC: "
49
50 /* Uncomment next line to get verbose print outs*/
51 /* #define DEBUG */
52
53 /* EC status register */
54 #define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
55 #define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
56 #define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
57 #define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
58
59 /* EC commands */
60 enum ec_command {
61 ACPI_EC_COMMAND_READ = 0x80,
62 ACPI_EC_COMMAND_WRITE = 0x81,
63 ACPI_EC_BURST_ENABLE = 0x82,
64 ACPI_EC_BURST_DISABLE = 0x83,
65 ACPI_EC_COMMAND_QUERY = 0x84,
66 };
67
68 /* EC events */
69 enum ec_event {
70 ACPI_EC_EVENT_OBF_1 = 1, /* Output buffer full */
71 ACPI_EC_EVENT_IBF_0, /* Input buffer empty */
72 };
73
74 #define ACPI_EC_DELAY 500 /* Wait 500ms max. during EC ops */
75 #define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
76
77 enum {
78 EC_FLAGS_WAIT_GPE = 0, /* Don't check status until GPE arrives */
79 EC_FLAGS_QUERY_PENDING, /* Query is pending */
80 EC_FLAGS_GPE_MODE, /* Expect GPE to be sent for status change */
81 EC_FLAGS_NO_ADDRESS_GPE, /* Expect GPE only for non-address event */
82 EC_FLAGS_ADDRESS, /* Address is being written */
83 EC_FLAGS_NO_WDATA_GPE, /* Don't expect WDATA GPE event */
84 EC_FLAGS_WDATA, /* Data is being written */
85 };
86
87 static int acpi_ec_remove(struct acpi_device *device, int type);
88 static int acpi_ec_start(struct acpi_device *device);
89 static int acpi_ec_stop(struct acpi_device *device, int type);
90 static int acpi_ec_add(struct acpi_device *device);
91
92 static const struct acpi_device_id ec_device_ids[] = {
93 {"PNP0C09", 0},
94 {"", 0},
95 };
96
97 static struct acpi_driver acpi_ec_driver = {
98 .name = "ec",
99 .class = ACPI_EC_CLASS,
100 .ids = ec_device_ids,
101 .ops = {
102 .add = acpi_ec_add,
103 .remove = acpi_ec_remove,
104 .start = acpi_ec_start,
105 .stop = acpi_ec_stop,
106 },
107 };
108
109 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
110 /* External interfaces use first EC only, so remember */
111 typedef int (*acpi_ec_query_func) (void *data);
112
113 struct acpi_ec_query_handler {
114 struct list_head node;
115 acpi_ec_query_func func;
116 acpi_handle handle;
117 void *data;
118 u8 query_bit;
119 };
120
121 static struct acpi_ec {
122 acpi_handle handle;
123 unsigned long gpe;
124 unsigned long command_addr;
125 unsigned long data_addr;
126 unsigned long global_lock;
127 unsigned long flags;
128 struct mutex lock;
129 wait_queue_head_t wait;
130 struct list_head list;
131 u8 handlers_installed;
132 } *boot_ec, *first_ec;
133
134 /* --------------------------------------------------------------------------
135 Transaction Management
136 -------------------------------------------------------------------------- */
137
138 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
139 {
140 u8 x = inb(ec->command_addr);
141 pr_debug(PREFIX "---> status = 0x%2x\n", x);
142 return x;
143 }
144
145 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
146 {
147 u8 x = inb(ec->data_addr);
148 pr_debug(PREFIX "---> data = 0x%2x\n", x);
149 return inb(ec->data_addr);
150 }
151
152 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
153 {
154 pr_debug(PREFIX "<--- command = 0x%2x\n", command);
155 outb(command, ec->command_addr);
156 }
157
158 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
159 {
160 pr_debug(PREFIX "<--- data = 0x%2x\n", data);
161 outb(data, ec->data_addr);
162 }
163
164 static inline int acpi_ec_check_status(struct acpi_ec *ec, enum ec_event event)
165 {
166 if (test_bit(EC_FLAGS_WAIT_GPE, &ec->flags))
167 return 0;
168 if (event == ACPI_EC_EVENT_OBF_1) {
169 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
170 return 1;
171 } else if (event == ACPI_EC_EVENT_IBF_0) {
172 if (!(acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF))
173 return 1;
174 }
175
176 return 0;
177 }
178
179 static int acpi_ec_wait(struct acpi_ec *ec, enum ec_event event, int force_poll)
180 {
181 int ret = 0;
182 if (unlikely(test_bit(EC_FLAGS_ADDRESS, &ec->flags) &&
183 test_bit(EC_FLAGS_NO_ADDRESS_GPE, &ec->flags)))
184 force_poll = 1;
185 if (unlikely(test_bit(EC_FLAGS_WDATA, &ec->flags) &&
186 test_bit(EC_FLAGS_NO_WDATA_GPE, &ec->flags)))
187 force_poll = 1;
188 if (likely(test_bit(EC_FLAGS_GPE_MODE, &ec->flags)) &&
189 likely(!force_poll)) {
190 if (wait_event_timeout(ec->wait, acpi_ec_check_status(ec, event),
191 msecs_to_jiffies(ACPI_EC_DELAY)))
192 goto end;
193 clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
194 if (acpi_ec_check_status(ec, event)) {
195 if (test_bit(EC_FLAGS_ADDRESS, &ec->flags)) {
196 /* miss address GPE, don't expect it anymore */
197 pr_info(PREFIX "missing address confirmation, "
198 "don't expect it any longer.\n");
199 set_bit(EC_FLAGS_NO_ADDRESS_GPE, &ec->flags);
200 } else if (test_bit(EC_FLAGS_WDATA, &ec->flags)) {
201 /* miss write data GPE, don't expect it */
202 pr_info(PREFIX "missing write data confirmation, "
203 "don't expect it any longer.\n");
204 set_bit(EC_FLAGS_NO_WDATA_GPE, &ec->flags);
205 } else {
206 /* missing GPEs, switch back to poll mode */
207 if (printk_ratelimit())
208 pr_info(PREFIX "missing confirmations, "
209 "switch off interrupt mode.\n");
210 clear_bit(EC_FLAGS_GPE_MODE, &ec->flags);
211 }
212 goto end;
213 }
214 } else {
215 unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
216 clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
217 while (time_before(jiffies, delay)) {
218 if (acpi_ec_check_status(ec, event))
219 goto end;
220 }
221 }
222 pr_err(PREFIX "acpi_ec_wait timeout,"
223 " status = %d, expect_event = %d\n",
224 acpi_ec_read_status(ec), event);
225 ret = -ETIME;
226 end:
227 clear_bit(EC_FLAGS_ADDRESS, &ec->flags);
228 return ret;
229 }
230
231 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
232 const u8 * wdata, unsigned wdata_len,
233 u8 * rdata, unsigned rdata_len,
234 int force_poll)
235 {
236 int result = 0;
237 set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
238 acpi_ec_write_cmd(ec, command);
239 pr_debug(PREFIX "transaction start\n");
240 for (; wdata_len > 0; --wdata_len) {
241 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
242 if (result) {
243 pr_err(PREFIX
244 "write_cmd timeout, command = %d\n", command);
245 goto end;
246 }
247 /* mark the address byte written to EC */
248 if (rdata_len + wdata_len > 1)
249 set_bit(EC_FLAGS_ADDRESS, &ec->flags);
250 set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
251 acpi_ec_write_data(ec, *(wdata++));
252 }
253
254 if (!rdata_len) {
255 set_bit(EC_FLAGS_WDATA, &ec->flags);
256 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
257 if (result) {
258 pr_err(PREFIX
259 "finish-write timeout, command = %d\n", command);
260 goto end;
261 }
262 } else if (command == ACPI_EC_COMMAND_QUERY)
263 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
264
265 for (; rdata_len > 0; --rdata_len) {
266 result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1, force_poll);
267 if (result) {
268 pr_err(PREFIX "read timeout, command = %d\n", command);
269 goto end;
270 }
271 /* Don't expect GPE after last read */
272 if (rdata_len > 1)
273 set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
274 *(rdata++) = acpi_ec_read_data(ec);
275 }
276 end:
277 pr_debug(PREFIX "transaction end\n");
278 return result;
279 }
280
281 static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
282 const u8 * wdata, unsigned wdata_len,
283 u8 * rdata, unsigned rdata_len,
284 int force_poll)
285 {
286 int status;
287 u32 glk;
288
289 if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
290 return -EINVAL;
291
292 if (rdata)
293 memset(rdata, 0, rdata_len);
294
295 mutex_lock(&ec->lock);
296 if (ec->global_lock) {
297 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
298 if (ACPI_FAILURE(status)) {
299 mutex_unlock(&ec->lock);
300 return -ENODEV;
301 }
302 }
303
304 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, 0);
305 if (status) {
306 pr_err(PREFIX "input buffer is not empty, "
307 "aborting transaction\n");
308 goto end;
309 }
310
311 status = acpi_ec_transaction_unlocked(ec, command,
312 wdata, wdata_len,
313 rdata, rdata_len,
314 force_poll);
315
316 end:
317
318 if (ec->global_lock)
319 acpi_release_global_lock(glk);
320 mutex_unlock(&ec->lock);
321
322 return status;
323 }
324
325 /*
326 * Note: samsung nv5000 doesn't work with ec burst mode.
327 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
328 */
329 int acpi_ec_burst_enable(struct acpi_ec *ec)
330 {
331 u8 d;
332 return acpi_ec_transaction(ec, ACPI_EC_BURST_ENABLE, NULL, 0, &d, 1, 0);
333 }
334
335 int acpi_ec_burst_disable(struct acpi_ec *ec)
336 {
337 return acpi_ec_transaction(ec, ACPI_EC_BURST_DISABLE, NULL, 0, NULL, 0, 0);
338 }
339
340 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
341 {
342 int result;
343 u8 d;
344
345 result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
346 &address, 1, &d, 1, 0);
347 *data = d;
348 return result;
349 }
350
351 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
352 {
353 u8 wdata[2] = { address, data };
354 return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
355 wdata, 2, NULL, 0, 0);
356 }
357
358 /*
359 * Externally callable EC access functions. For now, assume 1 EC only
360 */
361 int ec_burst_enable(void)
362 {
363 if (!first_ec)
364 return -ENODEV;
365 return acpi_ec_burst_enable(first_ec);
366 }
367
368 EXPORT_SYMBOL(ec_burst_enable);
369
370 int ec_burst_disable(void)
371 {
372 if (!first_ec)
373 return -ENODEV;
374 return acpi_ec_burst_disable(first_ec);
375 }
376
377 EXPORT_SYMBOL(ec_burst_disable);
378
379 int ec_read(u8 addr, u8 * val)
380 {
381 int err;
382 u8 temp_data;
383
384 if (!first_ec)
385 return -ENODEV;
386
387 err = acpi_ec_read(first_ec, addr, &temp_data);
388
389 if (!err) {
390 *val = temp_data;
391 return 0;
392 } else
393 return err;
394 }
395
396 EXPORT_SYMBOL(ec_read);
397
398 int ec_write(u8 addr, u8 val)
399 {
400 int err;
401
402 if (!first_ec)
403 return -ENODEV;
404
405 err = acpi_ec_write(first_ec, addr, val);
406
407 return err;
408 }
409
410 EXPORT_SYMBOL(ec_write);
411
412 int ec_transaction(u8 command,
413 const u8 * wdata, unsigned wdata_len,
414 u8 * rdata, unsigned rdata_len,
415 int force_poll)
416 {
417 if (!first_ec)
418 return -ENODEV;
419
420 return acpi_ec_transaction(first_ec, command, wdata,
421 wdata_len, rdata, rdata_len,
422 force_poll);
423 }
424
425 EXPORT_SYMBOL(ec_transaction);
426
427 static int acpi_ec_query(struct acpi_ec *ec, u8 * data)
428 {
429 int result;
430 u8 d;
431
432 if (!ec || !data)
433 return -EINVAL;
434
435 /*
436 * Query the EC to find out which _Qxx method we need to evaluate.
437 * Note that successful completion of the query causes the ACPI_EC_SCI
438 * bit to be cleared (and thus clearing the interrupt source).
439 */
440
441 result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1, 0);
442 if (result)
443 return result;
444
445 if (!d)
446 return -ENODATA;
447
448 *data = d;
449 return 0;
450 }
451
452 /* --------------------------------------------------------------------------
453 Event Management
454 -------------------------------------------------------------------------- */
455 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
456 acpi_handle handle, acpi_ec_query_func func,
457 void *data)
458 {
459 struct acpi_ec_query_handler *handler =
460 kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
461 if (!handler)
462 return -ENOMEM;
463
464 handler->query_bit = query_bit;
465 handler->handle = handle;
466 handler->func = func;
467 handler->data = data;
468 mutex_lock(&ec->lock);
469 list_add(&handler->node, &ec->list);
470 mutex_unlock(&ec->lock);
471 return 0;
472 }
473
474 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
475
476 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
477 {
478 struct acpi_ec_query_handler *handler, *tmp;
479 mutex_lock(&ec->lock);
480 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
481 if (query_bit == handler->query_bit) {
482 list_del(&handler->node);
483 kfree(handler);
484 }
485 }
486 mutex_unlock(&ec->lock);
487 }
488
489 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
490
491 static void acpi_ec_gpe_query(void *ec_cxt)
492 {
493 struct acpi_ec *ec = ec_cxt;
494 u8 value = 0;
495 struct acpi_ec_query_handler *handler, copy;
496
497 if (!ec || acpi_ec_query(ec, &value))
498 return;
499 mutex_lock(&ec->lock);
500 list_for_each_entry(handler, &ec->list, node) {
501 if (value == handler->query_bit) {
502 /* have custom handler for this bit */
503 memcpy(&copy, handler, sizeof(copy));
504 mutex_unlock(&ec->lock);
505 if (copy.func) {
506 copy.func(copy.data);
507 } else if (copy.handle) {
508 acpi_evaluate_object(copy.handle, NULL, NULL, NULL);
509 }
510 return;
511 }
512 }
513 mutex_unlock(&ec->lock);
514 }
515
516 static u32 acpi_ec_gpe_handler(void *data)
517 {
518 acpi_status status = AE_OK;
519 struct acpi_ec *ec = data;
520
521 pr_debug(PREFIX "~~~> interrupt\n");
522 clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
523 if (test_bit(EC_FLAGS_GPE_MODE, &ec->flags))
524 wake_up(&ec->wait);
525
526 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_SCI) {
527 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
528 status = acpi_os_execute(OSL_EC_BURST_HANDLER,
529 acpi_ec_gpe_query, ec);
530 } else if (unlikely(!test_bit(EC_FLAGS_GPE_MODE, &ec->flags))) {
531 /* this is non-query, must be confirmation */
532 if (printk_ratelimit())
533 pr_info(PREFIX "non-query interrupt received,"
534 " switching to interrupt mode\n");
535 set_bit(EC_FLAGS_GPE_MODE, &ec->flags);
536 }
537
538 return ACPI_SUCCESS(status) ?
539 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
540 }
541
542 /* --------------------------------------------------------------------------
543 Address Space Management
544 -------------------------------------------------------------------------- */
545
546 static acpi_status
547 acpi_ec_space_setup(acpi_handle region_handle,
548 u32 function, void *handler_context, void **return_context)
549 {
550 /*
551 * The EC object is in the handler context and is needed
552 * when calling the acpi_ec_space_handler.
553 */
554 *return_context = (function != ACPI_REGION_DEACTIVATE) ?
555 handler_context : NULL;
556
557 return AE_OK;
558 }
559
560 static acpi_status
561 acpi_ec_space_handler(u32 function, acpi_physical_address address,
562 u32 bits, acpi_integer *value,
563 void *handler_context, void *region_context)
564 {
565 struct acpi_ec *ec = handler_context;
566 int result = 0, i;
567 u8 temp = 0;
568
569 if ((address > 0xFF) || !value || !handler_context)
570 return AE_BAD_PARAMETER;
571
572 if (function != ACPI_READ && function != ACPI_WRITE)
573 return AE_BAD_PARAMETER;
574
575 if (bits != 8 && acpi_strict)
576 return AE_BAD_PARAMETER;
577
578 acpi_ec_burst_enable(ec);
579
580 if (function == ACPI_READ) {
581 result = acpi_ec_read(ec, address, &temp);
582 *value = temp;
583 } else {
584 temp = 0xff & (*value);
585 result = acpi_ec_write(ec, address, temp);
586 }
587
588 for (i = 8; unlikely(bits - i > 0); i += 8) {
589 ++address;
590 if (function == ACPI_READ) {
591 result = acpi_ec_read(ec, address, &temp);
592 (*value) |= ((acpi_integer)temp) << i;
593 } else {
594 temp = 0xff & ((*value) >> i);
595 result = acpi_ec_write(ec, address, temp);
596 }
597 }
598
599 acpi_ec_burst_disable(ec);
600
601 switch (result) {
602 case -EINVAL:
603 return AE_BAD_PARAMETER;
604 break;
605 case -ENODEV:
606 return AE_NOT_FOUND;
607 break;
608 case -ETIME:
609 return AE_TIME;
610 break;
611 default:
612 return AE_OK;
613 }
614 }
615
616 /* --------------------------------------------------------------------------
617 FS Interface (/proc)
618 -------------------------------------------------------------------------- */
619
620 static struct proc_dir_entry *acpi_ec_dir;
621
622 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
623 {
624 struct acpi_ec *ec = seq->private;
625
626 if (!ec)
627 goto end;
628
629 seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
630 seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
631 (unsigned)ec->command_addr, (unsigned)ec->data_addr);
632 seq_printf(seq, "use global lock:\t%s\n",
633 ec->global_lock ? "yes" : "no");
634 end:
635 return 0;
636 }
637
638 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
639 {
640 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
641 }
642
643 static struct file_operations acpi_ec_info_ops = {
644 .open = acpi_ec_info_open_fs,
645 .read = seq_read,
646 .llseek = seq_lseek,
647 .release = single_release,
648 .owner = THIS_MODULE,
649 };
650
651 static int acpi_ec_add_fs(struct acpi_device *device)
652 {
653 struct proc_dir_entry *entry = NULL;
654
655 if (!acpi_device_dir(device)) {
656 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
657 acpi_ec_dir);
658 if (!acpi_device_dir(device))
659 return -ENODEV;
660 }
661
662 entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
663 acpi_device_dir(device));
664 if (!entry)
665 return -ENODEV;
666 else {
667 entry->proc_fops = &acpi_ec_info_ops;
668 entry->data = acpi_driver_data(device);
669 entry->owner = THIS_MODULE;
670 }
671
672 return 0;
673 }
674
675 static int acpi_ec_remove_fs(struct acpi_device *device)
676 {
677
678 if (acpi_device_dir(device)) {
679 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
680 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
681 acpi_device_dir(device) = NULL;
682 }
683
684 return 0;
685 }
686
687 /* --------------------------------------------------------------------------
688 Driver Interface
689 -------------------------------------------------------------------------- */
690 static acpi_status
691 ec_parse_io_ports(struct acpi_resource *resource, void *context);
692
693 static struct acpi_ec *make_acpi_ec(void)
694 {
695 struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
696 if (!ec)
697 return NULL;
698 ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
699 mutex_init(&ec->lock);
700 init_waitqueue_head(&ec->wait);
701 INIT_LIST_HEAD(&ec->list);
702 return ec;
703 }
704
705 static acpi_status
706 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
707 void *context, void **return_value)
708 {
709 struct acpi_namespace_node *node = handle;
710 struct acpi_ec *ec = context;
711 int value = 0;
712 if (sscanf(node->name.ascii, "_Q%x", &value) == 1) {
713 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
714 }
715 return AE_OK;
716 }
717
718 static acpi_status
719 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
720 {
721 acpi_status status;
722
723 struct acpi_ec *ec = context;
724 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
725 ec_parse_io_ports, ec);
726 if (ACPI_FAILURE(status))
727 return status;
728
729 /* Get GPE bit assignment (EC events). */
730 /* TODO: Add support for _GPE returning a package */
731 status = acpi_evaluate_integer(handle, "_GPE", NULL, &ec->gpe);
732 if (ACPI_FAILURE(status))
733 return status;
734 /* Find and register all query methods */
735 acpi_walk_namespace(ACPI_TYPE_METHOD, handle, 1,
736 acpi_ec_register_query_methods, ec, NULL);
737 /* Use the global lock for all EC transactions? */
738 acpi_evaluate_integer(handle, "_GLK", NULL, &ec->global_lock);
739 ec->handle = handle;
740 return AE_CTRL_TERMINATE;
741 }
742
743 static void ec_remove_handlers(struct acpi_ec *ec)
744 {
745 if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
746 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
747 pr_err(PREFIX "failed to remove space handler\n");
748 if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
749 &acpi_ec_gpe_handler)))
750 pr_err(PREFIX "failed to remove gpe handler\n");
751 ec->handlers_installed = 0;
752 }
753
754 static int acpi_ec_add(struct acpi_device *device)
755 {
756 struct acpi_ec *ec = NULL;
757
758 if (!device)
759 return -EINVAL;
760 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
761 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
762
763 /* Check for boot EC */
764 if (boot_ec) {
765 if (boot_ec->handle == device->handle) {
766 /* Pre-loaded EC from DSDT, just move pointer */
767 ec = boot_ec;
768 boot_ec = NULL;
769 goto end;
770 } else if (boot_ec->handle == ACPI_ROOT_OBJECT) {
771 /* ECDT-based EC, time to shut it down */
772 ec_remove_handlers(boot_ec);
773 kfree(boot_ec);
774 first_ec = boot_ec = NULL;
775 }
776 }
777
778 ec = make_acpi_ec();
779 if (!ec)
780 return -ENOMEM;
781
782 if (ec_parse_device(device->handle, 0, ec, NULL) !=
783 AE_CTRL_TERMINATE) {
784 kfree(ec);
785 return -EINVAL;
786 }
787 ec->handle = device->handle;
788 end:
789 if (!first_ec)
790 first_ec = ec;
791 acpi_driver_data(device) = ec;
792 acpi_ec_add_fs(device);
793 pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
794 ec->gpe, ec->command_addr, ec->data_addr);
795 pr_info(PREFIX "driver started in %s mode\n",
796 (test_bit(EC_FLAGS_GPE_MODE, &ec->flags))?"interrupt":"poll");
797 return 0;
798 }
799
800 static int acpi_ec_remove(struct acpi_device *device, int type)
801 {
802 struct acpi_ec *ec;
803 struct acpi_ec_query_handler *handler, *tmp;
804
805 if (!device)
806 return -EINVAL;
807
808 ec = acpi_driver_data(device);
809 mutex_lock(&ec->lock);
810 list_for_each_entry_safe(handler, tmp, &ec->list, node) {
811 list_del(&handler->node);
812 kfree(handler);
813 }
814 mutex_unlock(&ec->lock);
815 acpi_ec_remove_fs(device);
816 acpi_driver_data(device) = NULL;
817 if (ec == first_ec)
818 first_ec = NULL;
819 kfree(ec);
820 return 0;
821 }
822
823 static acpi_status
824 ec_parse_io_ports(struct acpi_resource *resource, void *context)
825 {
826 struct acpi_ec *ec = context;
827
828 if (resource->type != ACPI_RESOURCE_TYPE_IO)
829 return AE_OK;
830
831 /*
832 * The first address region returned is the data port, and
833 * the second address region returned is the status/command
834 * port.
835 */
836 if (ec->data_addr == 0)
837 ec->data_addr = resource->data.io.minimum;
838 else if (ec->command_addr == 0)
839 ec->command_addr = resource->data.io.minimum;
840 else
841 return AE_CTRL_TERMINATE;
842
843 return AE_OK;
844 }
845
846 static int ec_install_handlers(struct acpi_ec *ec)
847 {
848 acpi_status status;
849 if (ec->handlers_installed)
850 return 0;
851 status = acpi_install_gpe_handler(NULL, ec->gpe,
852 ACPI_GPE_EDGE_TRIGGERED,
853 &acpi_ec_gpe_handler, ec);
854 if (ACPI_FAILURE(status))
855 return -ENODEV;
856
857 acpi_set_gpe_type(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
858 acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
859
860 status = acpi_install_address_space_handler(ec->handle,
861 ACPI_ADR_SPACE_EC,
862 &acpi_ec_space_handler,
863 &acpi_ec_space_setup, ec);
864 if (ACPI_FAILURE(status)) {
865 acpi_remove_gpe_handler(NULL, ec->gpe, &acpi_ec_gpe_handler);
866 return -ENODEV;
867 }
868
869 ec->handlers_installed = 1;
870 return 0;
871 }
872
873 static int acpi_ec_start(struct acpi_device *device)
874 {
875 struct acpi_ec *ec;
876 int ret = 0;
877
878 if (!device)
879 return -EINVAL;
880
881 ec = acpi_driver_data(device);
882
883 if (!ec)
884 return -EINVAL;
885
886 ret = ec_install_handlers(ec);
887
888 /* EC is fully operational, allow queries */
889 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
890 return ret;
891 }
892
893 static int acpi_ec_stop(struct acpi_device *device, int type)
894 {
895 struct acpi_ec *ec;
896 if (!device)
897 return -EINVAL;
898 ec = acpi_driver_data(device);
899 if (!ec)
900 return -EINVAL;
901 ec_remove_handlers(ec);
902
903 return 0;
904 }
905
906 int __init acpi_ec_ecdt_probe(void)
907 {
908 int ret;
909 acpi_status status;
910 struct acpi_table_ecdt *ecdt_ptr;
911
912 boot_ec = make_acpi_ec();
913 if (!boot_ec)
914 return -ENOMEM;
915 /*
916 * Generate a boot ec context
917 */
918 status = acpi_get_table(ACPI_SIG_ECDT, 1,
919 (struct acpi_table_header **)&ecdt_ptr);
920 if (ACPI_SUCCESS(status)) {
921 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
922 boot_ec->command_addr = ecdt_ptr->control.address;
923 boot_ec->data_addr = ecdt_ptr->data.address;
924 boot_ec->gpe = ecdt_ptr->gpe;
925 boot_ec->handle = ACPI_ROOT_OBJECT;
926 } else {
927 /* This workaround is needed only on some broken machines,
928 * which require early EC, but fail to provide ECDT */
929 acpi_handle x;
930 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
931 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
932 boot_ec, NULL);
933 /* Check that acpi_get_devices actually find something */
934 if (ACPI_FAILURE(status) || !boot_ec->handle)
935 goto error;
936 /* We really need to limit this workaround, the only ASUS,
937 * which needs it, has fake EC._INI method, so use it as flag.
938 */
939 if (ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI", &x)))
940 goto error;
941 }
942
943 ret = ec_install_handlers(boot_ec);
944 if (!ret) {
945 first_ec = boot_ec;
946 return 0;
947 }
948 error:
949 kfree(boot_ec);
950 boot_ec = NULL;
951 return -ENODEV;
952 }
953
954 static int __init acpi_ec_init(void)
955 {
956 int result = 0;
957
958 if (acpi_disabled)
959 return 0;
960
961 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
962 if (!acpi_ec_dir)
963 return -ENODEV;
964
965 /* Now register the driver for the EC */
966 result = acpi_bus_register_driver(&acpi_ec_driver);
967 if (result < 0) {
968 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
969 return -ENODEV;
970 }
971
972 return result;
973 }
974
975 subsys_initcall(acpi_ec_init);
976
977 /* EC driver currently not unloadable */
978 #if 0
979 static void __exit acpi_ec_exit(void)
980 {
981
982 acpi_bus_unregister_driver(&acpi_ec_driver);
983
984 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
985
986 return;
987 }
988 #endif /* 0 */
Linus' kernel tree