ACPI: EC: Simplify acpi_hw_low_level*() with inb()/outb().
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / acpi / ec.c
CommitLineData
1da177e4
LT
1/*
2 * acpi_ec.c - ACPI Embedded Controller Driver ($Revision: 38 $)
3 *
4 * Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
5 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 *
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or (at
13 * your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 *
24 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 */
26
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/init.h>
30#include <linux/types.h>
31#include <linux/delay.h>
32#include <linux/proc_fs.h>
33#include <linux/seq_file.h>
451566f4 34#include <linux/interrupt.h>
1da177e4
LT
35#include <asm/io.h>
36#include <acpi/acpi_bus.h>
37#include <acpi/acpi_drivers.h>
38#include <acpi/actypes.h>
39
40#define _COMPONENT ACPI_EC_COMPONENT
50526df6 41ACPI_MODULE_NAME("acpi_ec")
1da177e4
LT
42#define ACPI_EC_COMPONENT 0x00100000
43#define ACPI_EC_CLASS "embedded_controller"
44#define ACPI_EC_HID "PNP0C09"
45#define ACPI_EC_DRIVER_NAME "ACPI Embedded Controller Driver"
46#define ACPI_EC_DEVICE_NAME "Embedded Controller"
47#define ACPI_EC_FILE_INFO "info"
703959d4
DS
48
49/* EC status register */
1da177e4
LT
50#define ACPI_EC_FLAG_OBF 0x01 /* Output buffer full */
51#define ACPI_EC_FLAG_IBF 0x02 /* Input buffer full */
451566f4 52#define ACPI_EC_FLAG_BURST 0x10 /* burst mode */
1da177e4 53#define ACPI_EC_FLAG_SCI 0x20 /* EC-SCI occurred */
703959d4
DS
54
55/* EC commands */
1da177e4
LT
56#define ACPI_EC_COMMAND_READ 0x80
57#define ACPI_EC_COMMAND_WRITE 0x81
451566f4
DT
58#define ACPI_EC_BURST_ENABLE 0x82
59#define ACPI_EC_BURST_DISABLE 0x83
1da177e4 60#define ACPI_EC_COMMAND_QUERY 0x84
703959d4
DS
61
62/* EC events */
63enum {
64 ACPI_EC_EVENT_OBF_1 = 1, /* Output buffer full */
65 ACPI_EC_EVENT_IBF_0, /* Input buffer empty */
66};
67
68#define ACPI_EC_DELAY 50 /* Wait 50ms max. during EC ops */
69#define ACPI_EC_UDELAY_GLK 1000 /* Wait 1ms max. to get global lock */
70#define ACPI_EC_UDELAY 100 /* Poll @ 100us increments */
71#define ACPI_EC_UDELAY_COUNT 1000 /* Wait 10ms max. during EC ops */
72
73enum {
74 EC_INTR = 1, /* Output buffer full */
6ffb221a 75 EC_POLL, /* Input buffer empty */
703959d4
DS
76};
77
50526df6
LB
78static int acpi_ec_remove(struct acpi_device *device, int type);
79static int acpi_ec_start(struct acpi_device *device);
80static int acpi_ec_stop(struct acpi_device *device, int type);
703959d4 81static int acpi_ec_add(struct acpi_device *device);
1da177e4
LT
82
83static struct acpi_driver acpi_ec_driver = {
50526df6
LB
84 .name = ACPI_EC_DRIVER_NAME,
85 .class = ACPI_EC_CLASS,
86 .ids = ACPI_EC_HID,
87 .ops = {
703959d4 88 .add = acpi_ec_add,
50526df6
LB
89 .remove = acpi_ec_remove,
90 .start = acpi_ec_start,
91 .stop = acpi_ec_stop,
92 },
1da177e4 93};
6ffb221a
DS
94
95/* If we find an EC via the ECDT, we need to keep a ptr to its context */
703959d4
DS
96struct acpi_ec {
97 acpi_handle handle;
98 unsigned long uid;
99 unsigned long gpe_bit;
6ffb221a
DS
100 unsigned long command_addr;
101 unsigned long data_addr;
703959d4
DS
102 unsigned long global_lock;
103 struct semaphore sem;
104 unsigned int expect_event;
105 atomic_t leaving_burst; /* 0 : No, 1 : Yes, 2: abort */
106 wait_queue_head_t wait;
6ffb221a 107} *ec_ecdt;
703959d4
DS
108
109/* External interfaces use first EC only, so remember */
110static struct acpi_device *first_ec;
111static int acpi_ec_mode = EC_INTR;
112
1da177e4
LT
113/* --------------------------------------------------------------------------
114 Transaction Management
115 -------------------------------------------------------------------------- */
116
6ffb221a 117static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
1da177e4 118{
6ffb221a 119 return inb(ec->command_addr);
451566f4
DT
120}
121
6ffb221a 122static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
703959d4 123{
6ffb221a 124 return inb(ec->data_addr);
7c6db5e5
DS
125}
126
6ffb221a 127static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
45bea155 128{
6ffb221a 129 outb(command, ec->command_addr);
45bea155
LY
130}
131
6ffb221a 132static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
45bea155 133{
6ffb221a 134 outb(data, ec->data_addr);
703959d4 135}
45bea155 136
6ffb221a
DS
137static int acpi_ec_check_status(u8 status, u8 event)
138{
45bea155 139 switch (event) {
703959d4
DS
140 case ACPI_EC_EVENT_OBF_1:
141 if (status & ACPI_EC_FLAG_OBF)
142 return 1;
45bea155 143 break;
703959d4
DS
144 case ACPI_EC_EVENT_IBF_0:
145 if (!(status & ACPI_EC_FLAG_IBF))
146 return 1;
45bea155
LY
147 break;
148 default:
703959d4 149 break;
45bea155
LY
150 }
151
703959d4 152 return 0;
45bea155 153}
451566f4 154
703959d4 155static int acpi_ec_wait(struct acpi_ec *ec, u8 event)
7c6db5e5 156{
703959d4
DS
157 int i = (acpi_ec_mode == EC_POLL) ? ACPI_EC_UDELAY_COUNT : 0;
158 long time_left;
451566f4 159
703959d4 160 ec->expect_event = event;
7c6db5e5 161 if (acpi_ec_check_status(acpi_ec_read_status(ec), event)) {
703959d4
DS
162 ec->expect_event = 0;
163 return 0;
716e084e
LY
164 }
165
703959d4
DS
166 do {
167 if (acpi_ec_mode == EC_POLL) {
168 udelay(ACPI_EC_UDELAY);
169 } else {
170 time_left = wait_event_timeout(ec->wait,
171 !ec->expect_event,
172 msecs_to_jiffies(ACPI_EC_DELAY));
173 if (time_left > 0) {
174 ec->expect_event = 0;
7c6db5e5 175 return 0;
703959d4 176 }
7c6db5e5 177 }
703959d4
DS
178 if (acpi_ec_check_status(acpi_ec_read_status(ec), event)) {
179 ec->expect_event = 0;
180 return 0;
181 }
182 } while (--i > 0);
183
184 ec->expect_event = 0;
1da177e4 185
d550d98d 186 return -ETIME;
1da177e4
LT
187}
188
02b28a33 189#ifdef ACPI_FUTURE_USAGE
06a2a385
LY
190/*
191 * Note: samsung nv5000 doesn't work with ec burst mode.
192 * http://bugzilla.kernel.org/show_bug.cgi?id=4980
193 */
703959d4 194int acpi_ec_enter_burst_mode(struct acpi_ec *ec)
451566f4 195{
6ffb221a
DS
196 u8 tmp = 0;
197 u8 status = 0;
451566f4 198
451566f4
DT
199
200 status = acpi_ec_read_status(ec);
50526df6 201 if (status != -EINVAL && !(status & ACPI_EC_FLAG_BURST)) {
703959d4 202 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
50526df6 203 if (status)
716e084e 204 goto end;
703959d4
DS
205 acpi_ec_write_cmd(ec, ACPI_EC_BURST_ENABLE);
206 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1);
207 tmp = acpi_ec_read_data(ec);
50526df6 208 if (tmp != 0x90) { /* Burst ACK byte */
d550d98d 209 return -EINVAL;
451566f4 210 }
668d74c0
LY
211 }
212
703959d4 213 atomic_set(&ec->leaving_burst, 0);
d550d98d 214 return 0;
703959d4
DS
215 end:
216 ACPI_EXCEPTION((AE_INFO, status, "EC wait, burst mode"));
d550d98d 217 return -1;
451566f4
DT
218}
219
703959d4 220int acpi_ec_leave_burst_mode(struct acpi_ec *ec)
451566f4 221{
6ffb221a 222 u8 status = 0;
451566f4 223
451566f4 224
06a2a385
LY
225 status = acpi_ec_read_status(ec);
226 if (status != -EINVAL && (status & ACPI_EC_FLAG_BURST)){
703959d4 227 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
06a2a385
LY
228 if(status)
229 goto end;
703959d4
DS
230 acpi_ec_write_cmd(ec, ACPI_EC_BURST_DISABLE);
231 acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
7c6db5e5 232 }
703959d4 233 atomic_set(&ec->leaving_burst, 1);
d550d98d 234 return 0;
703959d4
DS
235 end:
236 ACPI_EXCEPTION((AE_INFO, status, "EC leave burst mode"));
d550d98d 237 return -1;
451566f4 238}
02b28a33 239#endif /* ACPI_FUTURE_USAGE */
451566f4 240
703959d4 241static int acpi_ec_transaction_unlocked(struct acpi_ec *ec, u8 command,
3576cf61
DS
242 const u8 *wdata, unsigned wdata_len,
243 u8 *rdata, unsigned rdata_len)
45bea155 244{
d7a76e4c 245 int result;
45bea155 246
703959d4 247 acpi_ec_write_cmd(ec, command);
45bea155 248
7c6db5e5 249 for (; wdata_len > 0; wdata_len --) {
703959d4 250 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
7c6db5e5
DS
251 if (result)
252 return result;
703959d4 253 acpi_ec_write_data(ec, *(wdata++));
3576cf61 254 }
45bea155 255
7c6db5e5 256 if (command == ACPI_EC_COMMAND_WRITE) {
703959d4 257 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
7c6db5e5
DS
258 if (result)
259 return result;
260 }
45bea155 261
7c6db5e5 262 for (; rdata_len > 0; rdata_len --) {
703959d4 263 result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1);
7c6db5e5
DS
264 if (result)
265 return result;
50526df6 266
6ffb221a 267 *(rdata++) = acpi_ec_read_data(ec);
7c6db5e5 268 }
45bea155 269
7c6db5e5 270 return 0;
45bea155
LY
271}
272
3576cf61
DS
273static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
274 const u8 *wdata, unsigned wdata_len,
275 u8 *rdata, unsigned rdata_len)
1da177e4 276{
d7a76e4c 277 int status;
50526df6 278 u32 glk;
1da177e4 279
d7a76e4c 280 if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
d550d98d 281 return -EINVAL;
1da177e4 282
d7a76e4c
LP
283 if (rdata)
284 memset(rdata, 0, rdata_len);
1da177e4 285
703959d4 286 if (ec->global_lock) {
1da177e4
LT
287 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
288 if (ACPI_FAILURE(status))
d550d98d 289 return -ENODEV;
1da177e4 290 }
703959d4 291 down(&ec->sem);
451566f4 292
703959d4 293 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0);
716e084e 294 if (status) {
3576cf61 295 printk(KERN_DEBUG PREFIX "read EC, IB not empty\n");
451566f4 296 goto end;
716e084e 297 }
1da177e4 298
d7a76e4c
LP
299 status = acpi_ec_transaction_unlocked(ec, command,
300 wdata, wdata_len,
301 rdata, rdata_len);
1da177e4 302
d7a76e4c 303end:
703959d4 304 up(&ec->sem);
1da177e4 305
703959d4 306 if (ec->global_lock)
1da177e4
LT
307 acpi_release_global_lock(glk);
308
d550d98d 309 return status;
1da177e4
LT
310}
311
6ffb221a 312static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 *data)
3576cf61
DS
313{
314 int result;
315 u8 d;
316
317 result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
318 &address, 1, &d, 1);
319 *data = d;
320 return result;
321}
6ffb221a 322
3576cf61
DS
323static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
324{
325 u8 wdata[2] = { address, data };
326 return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
327 wdata, 2, NULL, 0);
328}
329
1da177e4
LT
330/*
331 * Externally callable EC access functions. For now, assume 1 EC only
332 */
6ffb221a 333int ec_read(u8 addr, u8 *val)
1da177e4 334{
703959d4 335 struct acpi_ec *ec;
1da177e4 336 int err;
6ffb221a 337 u8 temp_data;
1da177e4
LT
338
339 if (!first_ec)
340 return -ENODEV;
341
342 ec = acpi_driver_data(first_ec);
343
344 err = acpi_ec_read(ec, addr, &temp_data);
345
346 if (!err) {
347 *val = temp_data;
348 return 0;
50526df6 349 } else
1da177e4
LT
350 return err;
351}
50526df6 352
1da177e4
LT
353EXPORT_SYMBOL(ec_read);
354
50526df6 355int ec_write(u8 addr, u8 val)
1da177e4 356{
703959d4 357 struct acpi_ec *ec;
1da177e4
LT
358 int err;
359
360 if (!first_ec)
361 return -ENODEV;
362
363 ec = acpi_driver_data(first_ec);
364
365 err = acpi_ec_write(ec, addr, val);
366
367 return err;
368}
50526df6 369
1da177e4
LT
370EXPORT_SYMBOL(ec_write);
371
d7a76e4c
LP
372extern int ec_transaction(u8 command,
373 const u8 *wdata, unsigned wdata_len,
374 u8 *rdata, unsigned rdata_len)
45bea155 375{
703959d4 376 struct acpi_ec *ec;
45bea155 377
d7a76e4c
LP
378 if (!first_ec)
379 return -ENODEV;
45bea155 380
d7a76e4c 381 ec = acpi_driver_data(first_ec);
45bea155 382
3576cf61
DS
383 return acpi_ec_transaction(ec, command, wdata,
384 wdata_len, rdata, rdata_len);
45bea155 385}
1da177e4 386
6ffb221a 387static int acpi_ec_query(struct acpi_ec *ec, u8 *data)
3576cf61
DS
388{
389 int result;
d7a76e4c 390 u8 d;
1da177e4 391
d7a76e4c
LP
392 if (!ec || !data)
393 return -EINVAL;
1da177e4 394
d7a76e4c
LP
395 /*
396 * Query the EC to find out which _Qxx method we need to evaluate.
397 * Note that successful completion of the query causes the ACPI_EC_SCI
398 * bit to be cleared (and thus clearing the interrupt source).
399 */
716e084e 400
d7a76e4c
LP
401 result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1);
402 if (result)
403 return result;
1da177e4 404
d7a76e4c
LP
405 if (!d)
406 return -ENODATA;
1da177e4 407
d7a76e4c
LP
408 *data = d;
409 return 0;
1da177e4
LT
410}
411
1da177e4
LT
412/* --------------------------------------------------------------------------
413 Event Management
414 -------------------------------------------------------------------------- */
415
8e0341ba 416struct acpi_ec_query_data {
50526df6
LB
417 acpi_handle handle;
418 u8 data;
1da177e4
LT
419};
420
50526df6 421static void acpi_ec_gpe_query(void *ec_cxt)
45bea155 422{
703959d4 423 struct acpi_ec *ec = (struct acpi_ec *)ec_cxt;
6ffb221a
DS
424 u8 value = 0;
425 static char object_name[8];
45bea155 426
6ffb221a 427 if (!ec)
45bea155
LY
428 goto end;
429
703959d4 430 value = acpi_ec_read_status(ec);
45bea155 431
45bea155
LY
432 if (!(value & ACPI_EC_FLAG_SCI))
433 goto end;
434
435 if (acpi_ec_query(ec, &value))
436 goto end;
437
6ffb221a 438 snprintf(object_name, 8, "_Q%2.2X", value);
45bea155 439
8e0341ba 440 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s", object_name));
45bea155 441
703959d4 442 acpi_evaluate_object(ec->handle, object_name, NULL, NULL);
45bea155 443
50526df6 444 end:
703959d4 445 acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
45bea155 446}
1da177e4 447
50526df6 448static u32 acpi_ec_gpe_handler(void *data)
1da177e4 449{
50526df6 450 acpi_status status = AE_OK;
6ffb221a 451 u8 value;
703959d4 452 struct acpi_ec *ec = (struct acpi_ec *)data;
1da177e4 453
703959d4 454 acpi_clear_gpe(NULL, ec->gpe_bit, ACPI_ISR);
451566f4 455 value = acpi_ec_read_status(ec);
1da177e4 456
8e0341ba
DS
457 if (acpi_ec_mode == EC_INTR) {
458 if (acpi_ec_check_status(value, ec->expect_event)) {
459 ec->expect_event = 0;
460 wake_up(&ec->wait);
461 }
451566f4
DT
462 }
463
50526df6 464 if (value & ACPI_EC_FLAG_SCI) {
6ffb221a 465 status = acpi_os_execute(OSL_EC_BURST_HANDLER, acpi_ec_gpe_query, ec);
17e9c78a 466 return status == AE_OK ?
50526df6
LB
467 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
468 }
703959d4 469 acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_ISR);
451566f4 470 return status == AE_OK ?
50526df6 471 ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
1da177e4
LT
472}
473
474/* --------------------------------------------------------------------------
475 Address Space Management
476 -------------------------------------------------------------------------- */
477
478static acpi_status
50526df6
LB
479acpi_ec_space_setup(acpi_handle region_handle,
480 u32 function, void *handler_context, void **return_context)
1da177e4
LT
481{
482 /*
483 * The EC object is in the handler context and is needed
484 * when calling the acpi_ec_space_handler.
485 */
50526df6
LB
486 *return_context = (function != ACPI_REGION_DEACTIVATE) ?
487 handler_context : NULL;
1da177e4
LT
488
489 return AE_OK;
490}
491
1da177e4 492static acpi_status
50526df6
LB
493acpi_ec_space_handler(u32 function,
494 acpi_physical_address address,
495 u32 bit_width,
496 acpi_integer * value,
497 void *handler_context, void *region_context)
1da177e4 498{
50526df6 499 int result = 0;
703959d4 500 struct acpi_ec *ec = NULL;
50526df6
LB
501 u64 temp = *value;
502 acpi_integer f_v = 0;
503 int i = 0;
1da177e4 504
1da177e4
LT
505
506 if ((address > 0xFF) || !value || !handler_context)
d550d98d 507 return AE_BAD_PARAMETER;
1da177e4 508
fa9cd547 509 if (bit_width != 8 && acpi_strict) {
d550d98d 510 return AE_BAD_PARAMETER;
1da177e4
LT
511 }
512
703959d4 513 ec = (struct acpi_ec *)handler_context;
1da177e4 514
50526df6 515 next_byte:
1da177e4
LT
516 switch (function) {
517 case ACPI_READ:
fa9cd547 518 temp = 0;
6ffb221a 519 result = acpi_ec_read(ec, (u8) address, (u8 *) &temp);
1da177e4
LT
520 break;
521 case ACPI_WRITE:
fa9cd547 522 result = acpi_ec_write(ec, (u8) address, (u8) temp);
1da177e4
LT
523 break;
524 default:
525 result = -EINVAL;
526 goto out;
527 break;
528 }
529
530 bit_width -= 8;
fa9cd547
LY
531 if (bit_width) {
532 if (function == ACPI_READ)
533 f_v |= temp << 8 * i;
534 if (function == ACPI_WRITE)
535 temp >>= 8;
1da177e4 536 i++;
83ea7445 537 address++;
1da177e4
LT
538 goto next_byte;
539 }
540
fa9cd547
LY
541 if (function == ACPI_READ) {
542 f_v |= temp << 8 * i;
1da177e4
LT
543 *value = f_v;
544 }
545
50526df6 546 out:
1da177e4
LT
547 switch (result) {
548 case -EINVAL:
d550d98d 549 return AE_BAD_PARAMETER;
1da177e4
LT
550 break;
551 case -ENODEV:
d550d98d 552 return AE_NOT_FOUND;
1da177e4
LT
553 break;
554 case -ETIME:
d550d98d 555 return AE_TIME;
1da177e4
LT
556 break;
557 default:
d550d98d 558 return AE_OK;
1da177e4 559 }
1da177e4
LT
560}
561
1da177e4
LT
562/* --------------------------------------------------------------------------
563 FS Interface (/proc)
564 -------------------------------------------------------------------------- */
565
50526df6 566static struct proc_dir_entry *acpi_ec_dir;
1da177e4 567
50526df6 568static int acpi_ec_read_info(struct seq_file *seq, void *offset)
1da177e4 569{
703959d4 570 struct acpi_ec *ec = (struct acpi_ec *)seq->private;
1da177e4 571
1da177e4
LT
572
573 if (!ec)
574 goto end;
575
576 seq_printf(seq, "gpe bit: 0x%02x\n",
703959d4 577 (u32) ec->gpe_bit);
1da177e4 578 seq_printf(seq, "ports: 0x%02x, 0x%02x\n",
6ffb221a
DS
579 (u32) ec->command_addr,
580 (u32) ec->data_addr);
1da177e4 581 seq_printf(seq, "use global lock: %s\n",
703959d4
DS
582 ec->global_lock ? "yes" : "no");
583 acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
1da177e4 584
50526df6 585 end:
d550d98d 586 return 0;
1da177e4
LT
587}
588
589static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
590{
591 return single_open(file, acpi_ec_read_info, PDE(inode)->data);
592}
593
703959d4 594static struct file_operations acpi_ec_info_ops = {
50526df6
LB
595 .open = acpi_ec_info_open_fs,
596 .read = seq_read,
597 .llseek = seq_lseek,
598 .release = single_release,
1da177e4
LT
599 .owner = THIS_MODULE,
600};
601
50526df6 602static int acpi_ec_add_fs(struct acpi_device *device)
1da177e4 603{
50526df6 604 struct proc_dir_entry *entry = NULL;
1da177e4 605
1da177e4
LT
606
607 if (!acpi_device_dir(device)) {
608 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
50526df6 609 acpi_ec_dir);
1da177e4 610 if (!acpi_device_dir(device))
d550d98d 611 return -ENODEV;
1da177e4
LT
612 }
613
614 entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
50526df6 615 acpi_device_dir(device));
1da177e4 616 if (!entry)
d550d98d 617 return -ENODEV;
1da177e4
LT
618 else {
619 entry->proc_fops = &acpi_ec_info_ops;
620 entry->data = acpi_driver_data(device);
621 entry->owner = THIS_MODULE;
622 }
623
d550d98d 624 return 0;
1da177e4
LT
625}
626
50526df6 627static int acpi_ec_remove_fs(struct acpi_device *device)
1da177e4 628{
1da177e4
LT
629
630 if (acpi_device_dir(device)) {
631 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
632 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
633 acpi_device_dir(device) = NULL;
634 }
635
d550d98d 636 return 0;
1da177e4
LT
637}
638
1da177e4
LT
639/* --------------------------------------------------------------------------
640 Driver Interface
641 -------------------------------------------------------------------------- */
642
703959d4 643static int acpi_ec_add(struct acpi_device *device)
1da177e4 644{
50526df6
LB
645 int result = 0;
646 acpi_status status = AE_OK;
703959d4 647 struct acpi_ec *ec = NULL;
45bea155 648
45bea155
LY
649
650 if (!device)
d550d98d 651 return -EINVAL;
45bea155 652
703959d4 653 ec = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
45bea155 654 if (!ec)
d550d98d 655 return -ENOMEM;
703959d4
DS
656 memset(ec, 0, sizeof(struct acpi_ec));
657
658 ec->handle = device->handle;
659 ec->uid = -1;
660 init_MUTEX(&ec->sem);
661 if (acpi_ec_mode == EC_INTR) {
662 atomic_set(&ec->leaving_burst, 1);
663 init_waitqueue_head(&ec->wait);
45bea155 664 }
1da177e4
LT
665 strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
666 strcpy(acpi_device_class(device), ACPI_EC_CLASS);
667 acpi_driver_data(device) = ec;
668
669 /* Use the global lock for all EC transactions? */
703959d4
DS
670 acpi_evaluate_integer(ec->handle, "_GLK", NULL,
671 &ec->global_lock);
1da177e4 672
ff2fc3e9
JS
673 /* XXX we don't test uids, because on some boxes ecdt uid = 0, see:
674 http://bugzilla.kernel.org/show_bug.cgi?id=6111 */
675 if (ec_ecdt) {
1da177e4 676 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
50526df6
LB
677 ACPI_ADR_SPACE_EC,
678 &acpi_ec_space_handler);
451566f4 679
703959d4 680 acpi_remove_gpe_handler(NULL, ec_ecdt->gpe_bit,
50526df6 681 &acpi_ec_gpe_handler);
1da177e4
LT
682
683 kfree(ec_ecdt);
684 }
685
686 /* Get GPE bit assignment (EC events). */
687 /* TODO: Add support for _GPE returning a package */
50526df6 688 status =
703959d4
DS
689 acpi_evaluate_integer(ec->handle, "_GPE", NULL,
690 &ec->gpe_bit);
1da177e4 691 if (ACPI_FAILURE(status)) {
703959d4 692 ACPI_EXCEPTION((AE_INFO, status, "Obtaining GPE bit assignment"));
1da177e4
LT
693 result = -ENODEV;
694 goto end;
695 }
696
697 result = acpi_ec_add_fs(device);
698 if (result)
699 goto end;
700
703959d4 701 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s [%s] (gpe %d) interrupt mode.",
50526df6 702 acpi_device_name(device), acpi_device_bid(device),
703959d4 703 (u32) ec->gpe_bit));
1da177e4
LT
704
705 if (!first_ec)
706 first_ec = device;
707
703959d4 708 end:
1da177e4
LT
709 if (result)
710 kfree(ec);
711
d550d98d 712 return result;
1da177e4
LT
713}
714
50526df6 715static int acpi_ec_remove(struct acpi_device *device, int type)
1da177e4 716{
703959d4 717 struct acpi_ec *ec = NULL;
1da177e4 718
1da177e4
LT
719
720 if (!device)
d550d98d 721 return -EINVAL;
1da177e4
LT
722
723 ec = acpi_driver_data(device);
724
725 acpi_ec_remove_fs(device);
726
727 kfree(ec);
728
d550d98d 729 return 0;
1da177e4
LT
730}
731
1da177e4 732static acpi_status
50526df6 733acpi_ec_io_ports(struct acpi_resource *resource, void *context)
1da177e4 734{
703959d4 735 struct acpi_ec *ec = (struct acpi_ec *)context;
1da177e4 736
50eca3eb 737 if (resource->type != ACPI_RESOURCE_TYPE_IO) {
1da177e4
LT
738 return AE_OK;
739 }
740
741 /*
742 * The first address region returned is the data port, and
743 * the second address region returned is the status/command
744 * port.
745 */
6ffb221a
DS
746 if (ec->data_addr == 0) {
747 ec->data_addr = resource->data.io.minimum;
748 } else if (ec->command_addr == 0) {
749 ec->command_addr = resource->data.io.minimum;
1da177e4
LT
750 } else {
751 return AE_CTRL_TERMINATE;
752 }
753
1da177e4
LT
754 return AE_OK;
755}
756
50526df6 757static int acpi_ec_start(struct acpi_device *device)
1da177e4 758{
50526df6 759 acpi_status status = AE_OK;
703959d4 760 struct acpi_ec *ec = NULL;
1da177e4 761
1da177e4
LT
762
763 if (!device)
d550d98d 764 return -EINVAL;
1da177e4
LT
765
766 ec = acpi_driver_data(device);
767
768 if (!ec)
d550d98d 769 return -EINVAL;
1da177e4
LT
770
771 /*
772 * Get I/O port addresses. Convert to GAS format.
773 */
703959d4 774 status = acpi_walk_resources(ec->handle, METHOD_NAME__CRS,
50526df6 775 acpi_ec_io_ports, ec);
6ffb221a 776 if (ACPI_FAILURE(status) || ec->command_addr == 0) {
703959d4
DS
777 ACPI_EXCEPTION((AE_INFO, status,
778 "Error getting I/O port addresses"));
d550d98d 779 return -ENODEV;
1da177e4
LT
780 }
781
6ffb221a
DS
782 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "gpe=0x%02lx, ports=0x%2lx,0x%2lx",
783 ec->gpe_bit, ec->command_addr, ec->data_addr));
1da177e4
LT
784
785 /*
786 * Install GPE handler
787 */
703959d4 788 status = acpi_install_gpe_handler(NULL, ec->gpe_bit,
50526df6
LB
789 ACPI_GPE_EDGE_TRIGGERED,
790 &acpi_ec_gpe_handler, ec);
1da177e4 791 if (ACPI_FAILURE(status)) {
d550d98d 792 return -ENODEV;
1da177e4 793 }
703959d4
DS
794 acpi_set_gpe_type(NULL, ec->gpe_bit, ACPI_GPE_TYPE_RUNTIME);
795 acpi_enable_gpe(NULL, ec->gpe_bit, ACPI_NOT_ISR);
1da177e4 796
703959d4 797 status = acpi_install_address_space_handler(ec->handle,
50526df6
LB
798 ACPI_ADR_SPACE_EC,
799 &acpi_ec_space_handler,
800 &acpi_ec_space_setup, ec);
1da177e4 801 if (ACPI_FAILURE(status)) {
703959d4 802 acpi_remove_gpe_handler(NULL, ec->gpe_bit,
50526df6 803 &acpi_ec_gpe_handler);
d550d98d 804 return -ENODEV;
1da177e4
LT
805 }
806
d550d98d 807 return AE_OK;
1da177e4
LT
808}
809
50526df6 810static int acpi_ec_stop(struct acpi_device *device, int type)
1da177e4 811{
50526df6 812 acpi_status status = AE_OK;
703959d4 813 struct acpi_ec *ec = NULL;
1da177e4 814
1da177e4
LT
815
816 if (!device)
d550d98d 817 return -EINVAL;
1da177e4
LT
818
819 ec = acpi_driver_data(device);
820
703959d4 821 status = acpi_remove_address_space_handler(ec->handle,
50526df6
LB
822 ACPI_ADR_SPACE_EC,
823 &acpi_ec_space_handler);
1da177e4 824 if (ACPI_FAILURE(status))
d550d98d 825 return -ENODEV;
1da177e4 826
50526df6 827 status =
703959d4 828 acpi_remove_gpe_handler(NULL, ec->gpe_bit,
50526df6 829 &acpi_ec_gpe_handler);
1da177e4 830 if (ACPI_FAILURE(status))
d550d98d 831 return -ENODEV;
1da177e4 832
d550d98d 833 return 0;
1da177e4
LT
834}
835
836static acpi_status __init
50526df6
LB
837acpi_fake_ecdt_callback(acpi_handle handle,
838 u32 Level, void *context, void **retval)
1da177e4 839{
50526df6 840 acpi_status status;
1da177e4 841
703959d4
DS
842 init_MUTEX(&ec_ecdt->sem);
843 if (acpi_ec_mode == EC_INTR) {
844 init_waitqueue_head(&ec_ecdt->wait);
845 }
1da177e4 846 status = acpi_walk_resources(handle, METHOD_NAME__CRS,
50526df6 847 acpi_ec_io_ports, ec_ecdt);
1da177e4
LT
848 if (ACPI_FAILURE(status))
849 return status;
1da177e4 850
703959d4
DS
851 ec_ecdt->uid = -1;
852 acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->uid);
1da177e4 853
50526df6
LB
854 status =
855 acpi_evaluate_integer(handle, "_GPE", NULL,
703959d4 856 &ec_ecdt->gpe_bit);
1da177e4
LT
857 if (ACPI_FAILURE(status))
858 return status;
703959d4
DS
859 ec_ecdt->global_lock = TRUE;
860 ec_ecdt->handle = handle;
1da177e4 861
6ffb221a
DS
862 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "GPE=0x%02lx, ports=0x%2lx, 0x%2lx",
863 ec_ecdt->gpe_bit, ec_ecdt->command_addr, ec_ecdt->data_addr));
1da177e4
LT
864
865 return AE_CTRL_TERMINATE;
866}
867
868/*
869 * Some BIOS (such as some from Gateway laptops) access EC region very early
870 * such as in BAT0._INI or EC._INI before an EC device is found and
871 * do not provide an ECDT. According to ACPI spec, ECDT isn't mandatorily
872 * required, but if EC regison is accessed early, it is required.
873 * The routine tries to workaround the BIOS bug by pre-scan EC device
874 * It assumes that _CRS, _HID, _GPE, _UID methods of EC don't touch any
875 * op region (since _REG isn't invoked yet). The assumption is true for
876 * all systems found.
877 */
50526df6 878static int __init acpi_ec_fake_ecdt(void)
1da177e4 879{
50526df6
LB
880 acpi_status status;
881 int ret = 0;
1da177e4 882
703959d4 883 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Try to make an fake ECDT"));
1da177e4 884
703959d4 885 ec_ecdt = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
1da177e4
LT
886 if (!ec_ecdt) {
887 ret = -ENOMEM;
888 goto error;
889 }
703959d4 890 memset(ec_ecdt, 0, sizeof(struct acpi_ec));
1da177e4 891
50526df6
LB
892 status = acpi_get_devices(ACPI_EC_HID,
893 acpi_fake_ecdt_callback, NULL, NULL);
1da177e4
LT
894 if (ACPI_FAILURE(status)) {
895 kfree(ec_ecdt);
896 ec_ecdt = NULL;
897 ret = -ENODEV;
703959d4 898 ACPI_EXCEPTION((AE_INFO, status, "Can't make an fake ECDT"));
1da177e4
LT
899 goto error;
900 }
901 return 0;
703959d4 902 error:
1da177e4
LT
903 return ret;
904}
905
50526df6 906static int __init acpi_ec_get_real_ecdt(void)
45bea155 907{
50526df6
LB
908 acpi_status status;
909 struct acpi_table_ecdt *ecdt_ptr;
45bea155 910
50526df6
LB
911 status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
912 (struct acpi_table_header **)
913 &ecdt_ptr);
45bea155
LY
914 if (ACPI_FAILURE(status))
915 return -ENODEV;
916
703959d4 917 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Found ECDT"));
45bea155
LY
918
919 /*
920 * Generate a temporary ec context to use until the namespace is scanned
921 */
703959d4 922 ec_ecdt = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
45bea155
LY
923 if (!ec_ecdt)
924 return -ENOMEM;
703959d4 925 memset(ec_ecdt, 0, sizeof(struct acpi_ec));
45bea155 926
703959d4
DS
927 init_MUTEX(&ec_ecdt->sem);
928 if (acpi_ec_mode == EC_INTR) {
929 init_waitqueue_head(&ec_ecdt->wait);
45bea155 930 }
6ffb221a
DS
931 ec_ecdt->command_addr = ecdt_ptr->ec_control.address;
932 ec_ecdt->data_addr = ecdt_ptr->ec_data.address;
703959d4 933 ec_ecdt->gpe_bit = ecdt_ptr->gpe_bit;
1da177e4 934 /* use the GL just to be safe */
703959d4
DS
935 ec_ecdt->global_lock = TRUE;
936 ec_ecdt->uid = ecdt_ptr->uid;
1da177e4 937
50526df6 938 status =
703959d4 939 acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->handle);
1da177e4
LT
940 if (ACPI_FAILURE(status)) {
941 goto error;
942 }
943
944 return 0;
703959d4
DS
945 error:
946 ACPI_EXCEPTION((AE_INFO, status, "Could not use ECDT"));
1da177e4
LT
947 kfree(ec_ecdt);
948 ec_ecdt = NULL;
949
950 return -ENODEV;
951}
952
953static int __initdata acpi_fake_ecdt_enabled;
50526df6 954int __init acpi_ec_ecdt_probe(void)
1da177e4 955{
50526df6
LB
956 acpi_status status;
957 int ret;
1da177e4
LT
958
959 ret = acpi_ec_get_real_ecdt();
960 /* Try to make a fake ECDT */
961 if (ret && acpi_fake_ecdt_enabled) {
962 ret = acpi_ec_fake_ecdt();
963 }
964
965 if (ret)
966 return 0;
967
968 /*
969 * Install GPE handler
970 */
703959d4 971 status = acpi_install_gpe_handler(NULL, ec_ecdt->gpe_bit,
50526df6
LB
972 ACPI_GPE_EDGE_TRIGGERED,
973 &acpi_ec_gpe_handler, ec_ecdt);
1da177e4
LT
974 if (ACPI_FAILURE(status)) {
975 goto error;
976 }
703959d4
DS
977 acpi_set_gpe_type(NULL, ec_ecdt->gpe_bit, ACPI_GPE_TYPE_RUNTIME);
978 acpi_enable_gpe(NULL, ec_ecdt->gpe_bit, ACPI_NOT_ISR);
50526df6
LB
979
980 status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT,
981 ACPI_ADR_SPACE_EC,
982 &acpi_ec_space_handler,
983 &acpi_ec_space_setup,
984 ec_ecdt);
1da177e4 985 if (ACPI_FAILURE(status)) {
703959d4 986 acpi_remove_gpe_handler(NULL, ec_ecdt->gpe_bit,
50526df6 987 &acpi_ec_gpe_handler);
1da177e4
LT
988 goto error;
989 }
990
991 return 0;
992
50526df6 993 error:
703959d4 994 ACPI_EXCEPTION((AE_INFO, status, "Could not use ECDT"));
1da177e4
LT
995 kfree(ec_ecdt);
996 ec_ecdt = NULL;
997
998 return -ENODEV;
999}
1000
50526df6 1001static int __init acpi_ec_init(void)
1da177e4 1002{
50526df6 1003 int result = 0;
1da177e4 1004
1da177e4
LT
1005
1006 if (acpi_disabled)
d550d98d 1007 return 0;
1da177e4
LT
1008
1009 acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1010 if (!acpi_ec_dir)
d550d98d 1011 return -ENODEV;
1da177e4
LT
1012
1013 /* Now register the driver for the EC */
1014 result = acpi_bus_register_driver(&acpi_ec_driver);
1015 if (result < 0) {
1016 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
d550d98d 1017 return -ENODEV;
1da177e4
LT
1018 }
1019
d550d98d 1020 return result;
1da177e4
LT
1021}
1022
1023subsys_initcall(acpi_ec_init);
1024
1025/* EC driver currently not unloadable */
1026#if 0
50526df6 1027static void __exit acpi_ec_exit(void)
1da177e4 1028{
1da177e4
LT
1029
1030 acpi_bus_unregister_driver(&acpi_ec_driver);
1031
1032 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1033
d550d98d 1034 return;
1da177e4 1035}
50526df6 1036#endif /* 0 */
1da177e4
LT
1037
1038static int __init acpi_fake_ecdt_setup(char *str)
1039{
1040 acpi_fake_ecdt_enabled = 1;
9b41046c 1041 return 1;
1da177e4 1042}
7b15f5e7 1043
1da177e4 1044__setup("acpi_fake_ecdt", acpi_fake_ecdt_setup);
02b28a33 1045static int __init acpi_ec_set_intr_mode(char *str)
45bea155 1046{
02b28a33 1047 int intr;
7b15f5e7 1048
02b28a33 1049 if (!get_option(&str, &intr))
7b15f5e7
LY
1050 return 0;
1051
02b28a33 1052 if (intr) {
703959d4 1053 acpi_ec_mode = EC_INTR;
7b15f5e7 1054 } else {
703959d4 1055 acpi_ec_mode = EC_POLL;
7b15f5e7 1056 }
703959d4
DS
1057 acpi_ec_driver.ops.add = acpi_ec_add;
1058 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "EC %s mode.\n", intr ? "interrupt" : "polling"));
1059
9b41046c 1060 return 1;
45bea155 1061}
50526df6 1062
53f11d4f 1063__setup("ec_intr=", acpi_ec_set_intr_mode);