drivers/acpi/ec.c

   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/proc_fs.h>
  38 #include <linux/seq_file.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/list.h>
  41 #include <linux/spinlock.h>
  42 #include <asm/io.h>
  43 #include <acpi/acpi_bus.h>
  44 #include <acpi/acpi_drivers.h>
  45 #include <linux/dmi.h>
  46
  47 #define ACPI_EC_CLASS                   "embedded_controller"
  48 #define ACPI_EC_DEVICE_NAME             "Embedded Controller"
  49 #define ACPI_EC_FILE_INFO               "info"
  50
  51 #define PREFIX                          "ACPI: EC: "
  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 #define ACPI_EC_DELAY           500     /* Wait 500ms max. during EC ops */
  69 #define ACPI_EC_UDELAY_GLK      1000    /* Wait 1ms max. to get global lock */
  70 #define ACPI_EC_CDELAY          10      /* Wait 10us before polling EC */
  71 #define ACPI_EC_MSI_UDELAY      550     /* Wait 550us for MSI EC */
  72
  73 #define ACPI_EC_STORM_THRESHOLD 8       /* number of false interrupts
  74                                            per one transaction */
  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 };
  82
  83 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
  84 /* External interfaces use first EC only, so remember */
  85 typedef int (*acpi_ec_query_func) (void *data);
  86
  87 struct acpi_ec_query_handler {
  88         struct list_head node;
  89         acpi_ec_query_func func;
  90         acpi_handle handle;
  91         void *data;
  92         u8 query_bit;
  93 };
  94
  95 struct transaction {
  96         const u8 *wdata;
  97         u8 *rdata;
  98         unsigned short irq_count;
  99         u8 command;
 100         u8 wi;
 101         u8 ri;
 102         u8 wlen;
 103         u8 rlen;
 104         bool done;
 105 };
 106
 107 static struct acpi_ec {
 108         acpi_handle handle;
 109         unsigned long gpe;
 110         unsigned long command_addr;
 111         unsigned long data_addr;
 112         unsigned long global_lock;
 113         unsigned long flags;
 114         struct mutex lock;
 115         wait_queue_head_t wait;
 116         struct list_head list;
 117         struct transaction *curr;
 118         spinlock_t curr_lock;
 119 } *boot_ec, *first_ec;
 120
 121 static int EC_FLAGS_MSI; /* Out-of-spec MSI controller */
 122 static int EC_FLAGS_VALIDATE_ECDT; /* ASUStec ECDTs need to be validated */
 123 static int EC_FLAGS_SKIP_DSDT_SCAN; /* Not all BIOS survive early DSDT scan */
 124
 125 /* --------------------------------------------------------------------------
 126                              Transaction Management
 127    -------------------------------------------------------------------------- */
 128
 129 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
 130 {
 131         u8 x = inb(ec->command_addr);
 132         pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
 133         return x;
 134 }
 135
 136 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
 137 {
 138         u8 x = inb(ec->data_addr);
 139         pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
 140         return x;
 141 }
 142
 143 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
 144 {
 145         pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
 146         outb(command, ec->command_addr);
 147 }
 148
 149 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
 150 {
 151         pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
 152         outb(data, ec->data_addr);
 153 }
 154
 155 static int ec_transaction_done(struct acpi_ec *ec)
 156 {
 157         unsigned long flags;
 158         int ret = 0;
 159         spin_lock_irqsave(&ec->curr_lock, flags);
 160         if (!ec->curr || ec->curr->done)
 161                 ret = 1;
 162         spin_unlock_irqrestore(&ec->curr_lock, flags);
 163         return ret;
 164 }
 165
 166 static void start_transaction(struct acpi_ec *ec)
 167 {
 168         ec->curr->irq_count = ec->curr->wi = ec->curr->ri = 0;
 169         ec->curr->done = false;
 170         acpi_ec_write_cmd(ec, ec->curr->command);
 171 }
 172
 173 static void advance_transaction(struct acpi_ec *ec, u8 status)
 174 {
 175         unsigned long flags;
 176         spin_lock_irqsave(&ec->curr_lock, flags);
 177         if (!ec->curr)
 178                 goto unlock;
 179         if (ec->curr->wlen > ec->curr->wi) {
 180                 if ((status & ACPI_EC_FLAG_IBF) == 0)
 181                         acpi_ec_write_data(ec,
 182                                 ec->curr->wdata[ec->curr->wi++]);
 183                 else
 184                         goto err;
 185         } else if (ec->curr->rlen > ec->curr->ri) {
 186                 if ((status & ACPI_EC_FLAG_OBF) == 1) {
 187                         ec->curr->rdata[ec->curr->ri++] = acpi_ec_read_data(ec);
 188                         if (ec->curr->rlen == ec->curr->ri)
 189                                 ec->curr->done = true;
 190                 } else
 191                         goto err;
 192         } else if (ec->curr->wlen == ec->curr->wi &&
 193                    (status & ACPI_EC_FLAG_IBF) == 0)
 194                 ec->curr->done = true;
 195         goto unlock;
 196 err:
 197         /* false interrupt, state didn't change */
 198         if (in_interrupt())
 199                 ++ec->curr->irq_count;
 200 unlock:
 201         spin_unlock_irqrestore(&ec->curr_lock, flags);
 202 }
 203
 204 static int acpi_ec_sync_query(struct acpi_ec *ec);
 205
 206 static int ec_check_sci_sync(struct acpi_ec *ec, u8 state)
 207 {
 208         if (state & ACPI_EC_FLAG_SCI) {
 209                 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
 210                         return acpi_ec_sync_query(ec);
 211         }
 212         return 0;
 213 }
 214
 215 static int ec_poll(struct acpi_ec *ec)
 216 {
 217         unsigned long flags;
 218         int repeat = 2; /* number of command restarts */
 219         while (repeat--) {
 220                 unsigned long delay = jiffies +
 221                         msecs_to_jiffies(ACPI_EC_DELAY);
 222                 do {
 223                         /* don't sleep with disabled interrupts */
 224                         if (EC_FLAGS_MSI || irqs_disabled()) {
 225                                 udelay(ACPI_EC_MSI_UDELAY);
 226                                 if (ec_transaction_done(ec))
 227                                         return 0;
 228                         } else {
 229                                 if (wait_event_timeout(ec->wait,
 230                                                 ec_transaction_done(ec),
 231                                                 msecs_to_jiffies(1)))
 232                                         return 0;
 233                         }
 234                         advance_transaction(ec, acpi_ec_read_status(ec));
 235                 } while (time_before(jiffies, delay));
 236                 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
 237                         break;
 238                 pr_debug(PREFIX "controller reset, restart transaction\n");
 239                 spin_lock_irqsave(&ec->curr_lock, flags);
 240                 start_transaction(ec);
 241                 spin_unlock_irqrestore(&ec->curr_lock, flags);
 242         }
 243         return -ETIME;
 244 }
 245
 246 static int acpi_ec_transaction_unlocked(struct acpi_ec *ec,
 247                                         struct transaction *t)
 248 {
 249         unsigned long tmp;
 250         int ret = 0;
 251         if (EC_FLAGS_MSI)
 252                 udelay(ACPI_EC_MSI_UDELAY);
 253         /* start transaction */
 254         spin_lock_irqsave(&ec->curr_lock, tmp);
 255         /* following two actions should be kept atomic */
 256         ec->curr = t;
 257         start_transaction(ec);
 258         if (ec->curr->command == ACPI_EC_COMMAND_QUERY)
 259                 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
 260         spin_unlock_irqrestore(&ec->curr_lock, tmp);
 261         ret = ec_poll(ec);
 262         spin_lock_irqsave(&ec->curr_lock, tmp);
 263         ec->curr = NULL;
 264         spin_unlock_irqrestore(&ec->curr_lock, tmp);
 265         return ret;
 266 }
 267
 268 static int ec_check_ibf0(struct acpi_ec *ec)
 269 {
 270         u8 status = acpi_ec_read_status(ec);
 271         return (status & ACPI_EC_FLAG_IBF) == 0;
 272 }
 273
 274 static int ec_wait_ibf0(struct acpi_ec *ec)
 275 {
 276         unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
 277         /* interrupt wait manually if GPE mode is not active */
 278         while (time_before(jiffies, delay))
 279                 if (wait_event_timeout(ec->wait, ec_check_ibf0(ec),
 280                                         msecs_to_jiffies(1)))
 281                         return 0;
 282         return -ETIME;
 283 }
 284
 285 static int acpi_ec_transaction(struct acpi_ec *ec, struct transaction *t)
 286 {
 287         int status;
 288         u32 glk;
 289         if (!ec || (!t) || (t->wlen && !t->wdata) || (t->rlen && !t->rdata))
 290                 return -EINVAL;
 291         if (t->rdata)
 292                 memset(t->rdata, 0, t->rlen);
 293         mutex_lock(&ec->lock);
 294         if (ec->global_lock) {
 295                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 296                 if (ACPI_FAILURE(status)) {
 297                         status = -ENODEV;
 298                         goto unlock;
 299                 }
 300         }
 301         if (ec_wait_ibf0(ec)) {
 302                 pr_err(PREFIX "input buffer is not empty, "
 303                                 "aborting transaction\n");
 304                 status = -ETIME;
 305                 goto end;
 306         }
 307         pr_debug(PREFIX "transaction start\n");
 308         /* disable GPE during transaction if storm is detected */
 309         if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
 310                 acpi_disable_gpe(NULL, ec->gpe);
 311         }
 312
 313         status = acpi_ec_transaction_unlocked(ec, t);
 314
 315         /* check if we received SCI during transaction */
 316         ec_check_sci_sync(ec, acpi_ec_read_status(ec));
 317         if (test_bit(EC_FLAGS_GPE_STORM, &ec->flags)) {
 318                 msleep(1);
 319                 /* it is safe to enable GPE outside of transaction */
 320                 acpi_enable_gpe(NULL, ec->gpe);
 321         } else if (t->irq_count > ACPI_EC_STORM_THRESHOLD) {
 322                 pr_info(PREFIX "GPE storm detected, "
 323                         "transactions will use polling mode\n");
 324                 set_bit(EC_FLAGS_GPE_STORM, &ec->flags);
 325         }
 326         pr_debug(PREFIX "transaction end\n");
 327 end:
 328         if (ec->global_lock)
 329                 acpi_release_global_lock(glk);
 330 unlock:
 331         mutex_unlock(&ec->lock);
 332         return status;
 333 }
 334
 335 static int acpi_ec_burst_enable(struct acpi_ec *ec)
 336 {
 337         u8 d;
 338         struct transaction t = {.command = ACPI_EC_BURST_ENABLE,
 339                                 .wdata = NULL, .rdata = &d,
 340                                 .wlen = 0, .rlen = 1};
 341
 342         return acpi_ec_transaction(ec, &t);
 343 }
 344
 345 static int acpi_ec_burst_disable(struct acpi_ec *ec)
 346 {
 347         struct transaction t = {.command = ACPI_EC_BURST_DISABLE,
 348                                 .wdata = NULL, .rdata = NULL,
 349                                 .wlen = 0, .rlen = 0};
 350
 351         return (acpi_ec_read_status(ec) & ACPI_EC_FLAG_BURST) ?
 352                                 acpi_ec_transaction(ec, &t) : 0;
 353 }
 354
 355 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
 356 {
 357         int result;
 358         u8 d;
 359         struct transaction t = {.command = ACPI_EC_COMMAND_READ,
 360                                 .wdata = &address, .rdata = &d,
 361                                 .wlen = 1, .rlen = 1};
 362
 363         result = acpi_ec_transaction(ec, &t);
 364         *data = d;
 365         return result;
 366 }
 367
 368 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
 369 {
 370         u8 wdata[2] = { address, data };
 371         struct transaction t = {.command = ACPI_EC_COMMAND_WRITE,
 372                                 .wdata = wdata, .rdata = NULL,
 373                                 .wlen = 2, .rlen = 0};
 374
 375         return acpi_ec_transaction(ec, &t);
 376 }
 377
 378 /*
 379  * Externally callable EC access functions. For now, assume 1 EC only
 380  */
 381 int ec_burst_enable(void)
 382 {
 383         if (!first_ec)
 384                 return -ENODEV;
 385         return acpi_ec_burst_enable(first_ec);
 386 }
 387
 388 EXPORT_SYMBOL(ec_burst_enable);
 389
 390 int ec_burst_disable(void)
 391 {
 392         if (!first_ec)
 393                 return -ENODEV;
 394         return acpi_ec_burst_disable(first_ec);
 395 }
 396
 397 EXPORT_SYMBOL(ec_burst_disable);
 398
 399 int ec_read(u8 addr, u8 * val)
 400 {
 401         int err;
 402         u8 temp_data;
 403
 404         if (!first_ec)
 405                 return -ENODEV;
 406
 407         err = acpi_ec_read(first_ec, addr, &temp_data);
 408
 409         if (!err) {
 410                 *val = temp_data;
 411                 return 0;
 412         } else
 413                 return err;
 414 }
 415
 416 EXPORT_SYMBOL(ec_read);
 417
 418 int ec_write(u8 addr, u8 val)
 419 {
 420         int err;
 421
 422         if (!first_ec)
 423                 return -ENODEV;
 424
 425         err = acpi_ec_write(first_ec, addr, val);
 426
 427         return err;
 428 }
 429
 430 EXPORT_SYMBOL(ec_write);
 431
 432 int ec_transaction(u8 command,
 433                    const u8 * wdata, unsigned wdata_len,
 434                    u8 * rdata, unsigned rdata_len,
 435                    int force_poll)
 436 {
 437         struct transaction t = {.command = command,
 438                                 .wdata = wdata, .rdata = rdata,
 439                                 .wlen = wdata_len, .rlen = rdata_len};
 440         if (!first_ec)
 441                 return -ENODEV;
 442
 443         return acpi_ec_transaction(first_ec, &t);
 444 }
 445
 446 EXPORT_SYMBOL(ec_transaction);
 447
 448 static int acpi_ec_query_unlocked(struct acpi_ec *ec, u8 * data)
 449 {
 450         int result;
 451         u8 d;
 452         struct transaction t = {.command = ACPI_EC_COMMAND_QUERY,
 453                                 .wdata = NULL, .rdata = &d,
 454                                 .wlen = 0, .rlen = 1};
 455         if (!ec || !data)
 456                 return -EINVAL;
 457         /*
 458          * Query the EC to find out which _Qxx method we need to evaluate.
 459          * Note that successful completion of the query causes the ACPI_EC_SCI
 460          * bit to be cleared (and thus clearing the interrupt source).
 461          */
 462         result = acpi_ec_transaction_unlocked(ec, &t);
 463         if (result)
 464                 return result;
 465         if (!d)
 466                 return -ENODATA;
 467         *data = d;
 468         return 0;
 469 }
 470
 471 /* --------------------------------------------------------------------------
 472                                 Event Management
 473    -------------------------------------------------------------------------- */
 474 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
 475                               acpi_handle handle, acpi_ec_query_func func,
 476                               void *data)
 477 {
 478         struct acpi_ec_query_handler *handler =
 479             kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
 480         if (!handler)
 481                 return -ENOMEM;
 482
 483         handler->query_bit = query_bit;
 484         handler->handle = handle;
 485         handler->func = func;
 486         handler->data = data;
 487         mutex_lock(&ec->lock);
 488         list_add(&handler->node, &ec->list);
 489         mutex_unlock(&ec->lock);
 490         return 0;
 491 }
 492
 493 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
 494
 495 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
 496 {
 497         struct acpi_ec_query_handler *handler, *tmp;
 498         mutex_lock(&ec->lock);
 499         list_for_each_entry_safe(handler, tmp, &ec->list, node) {
 500                 if (query_bit == handler->query_bit) {
 501                         list_del(&handler->node);
 502                         kfree(handler);
 503                 }
 504         }
 505         mutex_unlock(&ec->lock);
 506 }
 507
 508 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
 509
 510 static void acpi_ec_run(void *cxt)
 511 {
 512         struct acpi_ec_query_handler *handler = cxt;
 513         if (!handler)
 514                 return;
 515         pr_debug(PREFIX "start query execution\n");
 516         if (handler->func)
 517                 handler->func(handler->data);
 518         else if (handler->handle)
 519                 acpi_evaluate_object(handler->handle, NULL, NULL, NULL);
 520         pr_debug(PREFIX "stop query execution\n");
 521         kfree(handler);
 522 }
 523
 524 static int acpi_ec_sync_query(struct acpi_ec *ec)
 525 {
 526         u8 value = 0;
 527         int status;
 528         struct acpi_ec_query_handler *handler, *copy;
 529         if ((status = acpi_ec_query_unlocked(ec, &value)))
 530                 return status;
 531         list_for_each_entry(handler, &ec->list, node) {
 532                 if (value == handler->query_bit) {
 533                         /* have custom handler for this bit */
 534                         copy = kmalloc(sizeof(*handler), GFP_KERNEL);
 535                         if (!copy)
 536                                 return -ENOMEM;
 537                         memcpy(copy, handler, sizeof(*copy));
 538                         pr_debug(PREFIX "push query execution (0x%2x) on queue\n", value);
 539                         return acpi_os_execute(OSL_GPE_HANDLER,
 540                                 acpi_ec_run, copy);
 541                 }
 542         }
 543         return 0;
 544 }
 545
 546 static void acpi_ec_gpe_query(void *ec_cxt)
 547 {
 548         struct acpi_ec *ec = ec_cxt;
 549         if (!ec)
 550                 return;
 551         mutex_lock(&ec->lock);
 552         acpi_ec_sync_query(ec);
 553         mutex_unlock(&ec->lock);
 554 }
 555
 556 static void acpi_ec_gpe_query(void *ec_cxt);
 557
 558 static int ec_check_sci(struct acpi_ec *ec, u8 state)
 559 {
 560         if (state & ACPI_EC_FLAG_SCI) {
 561                 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags)) {
 562                         pr_debug(PREFIX "push gpe query to the queue\n");
 563                         return acpi_os_execute(OSL_NOTIFY_HANDLER,
 564                                 acpi_ec_gpe_query, ec);
 565                 }
 566         }
 567         return 0;
 568 }
 569
 570 static u32 acpi_ec_gpe_handler(void *data)
 571 {
 572         struct acpi_ec *ec = data;
 573
 574         pr_debug(PREFIX "~~~> interrupt\n");
 575
 576         advance_transaction(ec, acpi_ec_read_status(ec));
 577         if (ec_transaction_done(ec) &&
 578             (acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF) == 0) {
 579                 wake_up(&ec->wait);
 580                 ec_check_sci(ec, acpi_ec_read_status(ec));
 581         }
 582         return ACPI_INTERRUPT_HANDLED;
 583 }
 584
 585 /* --------------------------------------------------------------------------
 586                              Address Space Management
 587    -------------------------------------------------------------------------- */
 588
 589 static acpi_status
 590 acpi_ec_space_handler(u32 function, acpi_physical_address address,
 591                       u32 bits, acpi_integer *value64,
 592                       void *handler_context, void *region_context)
 593 {
 594         struct acpi_ec *ec = handler_context;
 595         int result = 0, i, bytes = bits / 8;
 596         u8 *value = (u8 *)value64;
 597
 598         if ((address > 0xFF) || !value || !handler_context)
 599                 return AE_BAD_PARAMETER;
 600
 601         if (function != ACPI_READ && function != ACPI_WRITE)
 602                 return AE_BAD_PARAMETER;
 603
 604         if (EC_FLAGS_MSI || bits > 8)
 605                 acpi_ec_burst_enable(ec);
 606
 607         for (i = 0; i < bytes; ++i, ++address, ++value)
 608                 result = (function == ACPI_READ) ?
 609                         acpi_ec_read(ec, address, value) :
 610                         acpi_ec_write(ec, address, *value);
 611
 612         if (EC_FLAGS_MSI || bits > 8)
 613                 acpi_ec_burst_disable(ec);
 614
 615         switch (result) {
 616         case -EINVAL:
 617                 return AE_BAD_PARAMETER;
 618                 break;
 619         case -ENODEV:
 620                 return AE_NOT_FOUND;
 621                 break;
 622         case -ETIME:
 623                 return AE_TIME;
 624                 break;
 625         default:
 626                 return AE_OK;
 627         }
 628 }
 629
 630 /* --------------------------------------------------------------------------
 631                               FS Interface (/proc)
 632    -------------------------------------------------------------------------- */
 633
 634 static struct proc_dir_entry *acpi_ec_dir;
 635
 636 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
 637 {
 638         struct acpi_ec *ec = seq->private;
 639
 640         if (!ec)
 641                 goto end;
 642
 643         seq_printf(seq, "gpe:\t\t\t0x%02x\n", (u32) ec->gpe);
 644         seq_printf(seq, "ports:\t\t\t0x%02x, 0x%02x\n",
 645                    (unsigned)ec->command_addr, (unsigned)ec->data_addr);
 646         seq_printf(seq, "use global lock:\t%s\n",
 647                    ec->global_lock ? "yes" : "no");
 648       end:
 649         return 0;
 650 }
 651
 652 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
 653 {
 654         return single_open(file, acpi_ec_read_info, PDE(inode)->data);
 655 }
 656
 657 static const struct file_operations acpi_ec_info_ops = {
 658         .open = acpi_ec_info_open_fs,
 659         .read = seq_read,
 660         .llseek = seq_lseek,
 661         .release = single_release,
 662         .owner = THIS_MODULE,
 663 };
 664
 665 static int acpi_ec_add_fs(struct acpi_device *device)
 666 {
 667         struct proc_dir_entry *entry = NULL;
 668
 669         if (!acpi_device_dir(device)) {
 670                 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
 671                                                      acpi_ec_dir);
 672                 if (!acpi_device_dir(device))
 673                         return -ENODEV;
 674         }
 675
 676         entry = proc_create_data(ACPI_EC_FILE_INFO, S_IRUGO,
 677                                  acpi_device_dir(device),
 678                                  &acpi_ec_info_ops, acpi_driver_data(device));
 679         if (!entry)
 680                 return -ENODEV;
 681         return 0;
 682 }
 683
 684 static int acpi_ec_remove_fs(struct acpi_device *device)
 685 {
 686
 687         if (acpi_device_dir(device)) {
 688                 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
 689                 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
 690                 acpi_device_dir(device) = NULL;
 691         }
 692
 693         return 0;
 694 }
 695
 696 /* --------------------------------------------------------------------------
 697                                Driver Interface
 698    -------------------------------------------------------------------------- */
 699 static acpi_status
 700 ec_parse_io_ports(struct acpi_resource *resource, void *context);
 701
 702 static struct acpi_ec *make_acpi_ec(void)
 703 {
 704         struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
 705         if (!ec)
 706                 return NULL;
 707         ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
 708         mutex_init(&ec->lock);
 709         init_waitqueue_head(&ec->wait);
 710         INIT_LIST_HEAD(&ec->list);
 711         spin_lock_init(&ec->curr_lock);
 712         return ec;
 713 }
 714
 715 static acpi_status
 716 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
 717                                void *context, void **return_value)
 718 {
 719         char node_name[5];
 720         struct acpi_buffer buffer = { sizeof(node_name), node_name };
 721         struct acpi_ec *ec = context;
 722         int value = 0;
 723         acpi_status status;
 724
 725         status = acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
 726
 727         if (ACPI_SUCCESS(status) && sscanf(node_name, "_Q%x", &value) == 1) {
 728                 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
 729         }
 730         return AE_OK;
 731 }
 732
 733 static acpi_status
 734 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
 735 {
 736         acpi_status status;
 737         unsigned long long tmp = 0;
 738
 739         struct acpi_ec *ec = context;
 740
 741         /* clear addr values, ec_parse_io_ports depend on it */
 742         ec->command_addr = ec->data_addr = 0;
 743
 744         status = acpi_walk_resources(handle, METHOD_NAME__CRS,
 745                                      ec_parse_io_ports, ec);
 746         if (ACPI_FAILURE(status))
 747                 return status;
 748
 749         /* Get GPE bit assignment (EC events). */
 750         /* TODO: Add support for _GPE returning a package */
 751         status = acpi_evaluate_integer(handle, "_GPE", NULL, &tmp);
 752         if (ACPI_FAILURE(status))
 753                 return status;
 754         ec->gpe = tmp;
 755         /* Use the global lock for all EC transactions? */
 756         tmp = 0;
 757         acpi_evaluate_integer(handle, "_GLK", NULL, &tmp);
 758         ec->global_lock = tmp;
 759         ec->handle = handle;
 760         return AE_CTRL_TERMINATE;
 761 }
 762
 763 static int ec_install_handlers(struct acpi_ec *ec)
 764 {
 765         acpi_status status;
 766         if (test_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags))
 767                 return 0;
 768         status = acpi_install_gpe_handler(NULL, ec->gpe,
 769                                   ACPI_GPE_EDGE_TRIGGERED,
 770                                   &acpi_ec_gpe_handler, ec);
 771         if (ACPI_FAILURE(status))
 772                 return -ENODEV;
 773         acpi_set_gpe_type(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
 774         acpi_enable_gpe(NULL, ec->gpe);
 775         status = acpi_install_address_space_handler(ec->handle,
 776                                                     ACPI_ADR_SPACE_EC,
 777                                                     &acpi_ec_space_handler,
 778                                                     NULL, ec);
 779         if (ACPI_FAILURE(status)) {
 780                 if (status == AE_NOT_FOUND) {
 781                         /*
 782                          * Maybe OS fails in evaluating the _REG object.
 783                          * The AE_NOT_FOUND error will be ignored and OS
 784                          * continue to initialize EC.
 785                          */
 786                         printk(KERN_ERR "Fail in evaluating the _REG object"
 787                                 " of EC device. Broken bios is suspected.\n");
 788                 } else {
 789                         acpi_remove_gpe_handler(NULL, ec->gpe,
 790                                 &acpi_ec_gpe_handler);
 791                         return -ENODEV;
 792                 }
 793         }
 794
 795         set_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
 796         return 0;
 797 }
 798
 799 static void ec_remove_handlers(struct acpi_ec *ec)
 800 {
 801         if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
 802                                 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
 803                 pr_err(PREFIX "failed to remove space handler\n");
 804         if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
 805                                 &acpi_ec_gpe_handler)))
 806                 pr_err(PREFIX "failed to remove gpe handler\n");
 807         clear_bit(EC_FLAGS_HANDLERS_INSTALLED, &ec->flags);
 808 }
 809
 810 static int acpi_ec_add(struct acpi_device *device)
 811 {
 812         struct acpi_ec *ec = NULL;
 813         int ret;
 814
 815         strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
 816         strcpy(acpi_device_class(device), ACPI_EC_CLASS);
 817
 818         /* Check for boot EC */
 819         if (boot_ec &&
 820             (boot_ec->handle == device->handle ||
 821              boot_ec->handle == ACPI_ROOT_OBJECT)) {
 822                 ec = boot_ec;
 823                 boot_ec = NULL;
 824         } else {
 825                 ec = make_acpi_ec();
 826                 if (!ec)
 827                         return -ENOMEM;
 828         }
 829         if (ec_parse_device(device->handle, 0, ec, NULL) !=
 830                 AE_CTRL_TERMINATE) {
 831                         kfree(ec);
 832                         return -EINVAL;
 833         }
 834
 835         ec->handle = device->handle;
 836
 837         /* Find and register all query methods */
 838         acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
 839                             acpi_ec_register_query_methods, ec, NULL);
 840
 841         if (!first_ec)
 842                 first_ec = ec;
 843         device->driver_data = ec;
 844         acpi_ec_add_fs(device);
 845         pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
 846                           ec->gpe, ec->command_addr, ec->data_addr);
 847
 848         ret = ec_install_handlers(ec);
 849
 850         /* EC is fully operational, allow queries */
 851         clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
 852         return ret;
 853 }
 854
 855 static int acpi_ec_remove(struct acpi_device *device, int type)
 856 {
 857         struct acpi_ec *ec;
 858         struct acpi_ec_query_handler *handler, *tmp;
 859
 860         if (!device)
 861                 return -EINVAL;
 862
 863         ec = acpi_driver_data(device);
 864         ec_remove_handlers(ec);
 865         mutex_lock(&ec->lock);
 866         list_for_each_entry_safe(handler, tmp, &ec->list, node) {
 867                 list_del(&handler->node);
 868                 kfree(handler);
 869         }
 870         mutex_unlock(&ec->lock);
 871         acpi_ec_remove_fs(device);
 872         device->driver_data = NULL;
 873         if (ec == first_ec)
 874                 first_ec = NULL;
 875         kfree(ec);
 876         return 0;
 877 }
 878
 879 static acpi_status
 880 ec_parse_io_ports(struct acpi_resource *resource, void *context)
 881 {
 882         struct acpi_ec *ec = context;
 883
 884         if (resource->type != ACPI_RESOURCE_TYPE_IO)
 885                 return AE_OK;
 886
 887         /*
 888          * The first address region returned is the data port, and
 889          * the second address region returned is the status/command
 890          * port.
 891          */
 892         if (ec->data_addr == 0)
 893                 ec->data_addr = resource->data.io.minimum;
 894         else if (ec->command_addr == 0)
 895                 ec->command_addr = resource->data.io.minimum;
 896         else
 897                 return AE_CTRL_TERMINATE;
 898
 899         return AE_OK;
 900 }
 901
 902 int __init acpi_boot_ec_enable(void)
 903 {
 904         if (!boot_ec || test_bit(EC_FLAGS_HANDLERS_INSTALLED, &boot_ec->flags))
 905                 return 0;
 906         if (!ec_install_handlers(boot_ec)) {
 907                 first_ec = boot_ec;
 908                 return 0;
 909         }
 910         return -EFAULT;
 911 }
 912
 913 static const struct acpi_device_id ec_device_ids[] = {
 914         {"PNP0C09", 0},
 915         {"", 0},
 916 };
 917
 918 /* Some BIOS do not survive early DSDT scan, skip it */
 919 static int ec_skip_dsdt_scan(const struct dmi_system_id *id)
 920 {
 921         EC_FLAGS_SKIP_DSDT_SCAN = 1;
 922         return 0;
 923 }
 924
 925 /* ASUStek often supplies us with broken ECDT, validate it */
 926 static int ec_validate_ecdt(const struct dmi_system_id *id)
 927 {
 928         EC_FLAGS_VALIDATE_ECDT = 1;
 929         return 0;
 930 }
 931
 932 /* MSI EC needs special treatment, enable it */
 933 static int ec_flag_msi(const struct dmi_system_id *id)
 934 {
 935         printk(KERN_DEBUG PREFIX "Detected MSI hardware, enabling workarounds.\n");
 936         EC_FLAGS_MSI = 1;
 937         EC_FLAGS_VALIDATE_ECDT = 1;
 938         return 0;
 939 }
 940
 941 static struct dmi_system_id __initdata ec_dmi_table[] = {
 942         {
 943         ec_skip_dsdt_scan, "Compal JFL92", {
 944         DMI_MATCH(DMI_BIOS_VENDOR, "COMPAL"),
 945         DMI_MATCH(DMI_BOARD_NAME, "JFL92") }, NULL},
 946         {
 947         ec_flag_msi, "MSI hardware", {
 948         DMI_MATCH(DMI_BIOS_VENDOR, "Micro-Star")}, NULL},
 949         {
 950         ec_flag_msi, "MSI hardware", {
 951         DMI_MATCH(DMI_SYS_VENDOR, "Micro-Star")}, NULL},
 952         {
 953         ec_flag_msi, "MSI hardware", {
 954         DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-Star")}, NULL},
 955         {
 956         ec_flag_msi, "MSI hardware", {
 957         DMI_MATCH(DMI_CHASSIS_VENDOR, "MICRO-STAR")}, NULL},
 958         {
 959         ec_validate_ecdt, "ASUS hardware", {
 960         DMI_MATCH(DMI_BIOS_VENDOR, "ASUS") }, NULL},
 961         {},
 962 };
 963
 964
 965 int __init acpi_ec_ecdt_probe(void)
 966 {
 967         acpi_status status;
 968         struct acpi_ec *saved_ec = NULL;
 969         struct acpi_table_ecdt *ecdt_ptr;
 970
 971         boot_ec = make_acpi_ec();
 972         if (!boot_ec)
 973                 return -ENOMEM;
 974         /*
 975          * Generate a boot ec context
 976          */
 977         dmi_check_system(ec_dmi_table);
 978         status = acpi_get_table(ACPI_SIG_ECDT, 1,
 979                                 (struct acpi_table_header **)&ecdt_ptr);
 980         if (ACPI_SUCCESS(status)) {
 981                 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
 982                 boot_ec->command_addr = ecdt_ptr->control.address;
 983                 boot_ec->data_addr = ecdt_ptr->data.address;
 984                 boot_ec->gpe = ecdt_ptr->gpe;
 985                 boot_ec->handle = ACPI_ROOT_OBJECT;
 986                 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
 987                 /* Don't trust ECDT, which comes from ASUSTek */
 988                 if (!EC_FLAGS_VALIDATE_ECDT)
 989                         goto install;
 990                 saved_ec = kmalloc(sizeof(struct acpi_ec), GFP_KERNEL);
 991                 if (!saved_ec)
 992                         return -ENOMEM;
 993                 memcpy(saved_ec, boot_ec, sizeof(struct acpi_ec));
 994         /* fall through */
 995         }
 996
 997         if (EC_FLAGS_SKIP_DSDT_SCAN)
 998                 return -ENODEV;
 999
1000         /* This workaround is needed only on some broken machines,
1001          * which require early EC, but fail to provide ECDT */
1002         printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
1003         status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
1004                                         boot_ec, NULL);
1005         /* Check that acpi_get_devices actually find something */
1006         if (ACPI_FAILURE(status) || !boot_ec->handle)
1007                 goto error;
1008         if (saved_ec) {
1009                 /* try to find good ECDT from ASUSTek */
1010                 if (saved_ec->command_addr != boot_ec->command_addr ||
1011                     saved_ec->data_addr != boot_ec->data_addr ||
1012                     saved_ec->gpe != boot_ec->gpe ||
1013                     saved_ec->handle != boot_ec->handle)
1014                         pr_info(PREFIX "ASUSTek keeps feeding us with broken "
1015                         "ECDT tables, which are very hard to workaround. "
1016                         "Trying to use DSDT EC info instead. Please send "
1017                         "output of acpidump to linux-acpi@vger.kernel.org\n");
1018                 kfree(saved_ec);
1019                 saved_ec = NULL;
1020         } else {
1021                 /* We really need to limit this workaround, the only ASUS,
1022                 * which needs it, has fake EC._INI method, so use it as flag.
1023                 * Keep boot_ec struct as it will be needed soon.
1024                 */
1025                 acpi_handle dummy;
1026                 if (!dmi_name_in_vendors("ASUS") ||
1027                     ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI",
1028                                                         &dummy)))
1029                         return -ENODEV;
1030         }
1031 install:
1032         if (!ec_install_handlers(boot_ec)) {
1033                 first_ec = boot_ec;
1034                 return 0;
1035         }
1036 error:
1037         kfree(boot_ec);
1038         boot_ec = NULL;
1039         return -ENODEV;
1040 }
1041
1042 static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
1043 {
1044         struct acpi_ec *ec = acpi_driver_data(device);
1045         /* Stop using GPE */
1046         acpi_disable_gpe(NULL, ec->gpe);
1047         return 0;
1048 }
1049
1050 static int acpi_ec_resume(struct acpi_device *device)
1051 {
1052         struct acpi_ec *ec = acpi_driver_data(device);
1053         /* Enable use of GPE back */
1054         acpi_enable_gpe(NULL, ec->gpe);
1055         return 0;
1056 }
1057
1058 static struct acpi_driver acpi_ec_driver = {
1059         .name = "ec",
1060         .class = ACPI_EC_CLASS,
1061         .ids = ec_device_ids,
1062         .ops = {
1063                 .add = acpi_ec_add,
1064                 .remove = acpi_ec_remove,
1065                 .suspend = acpi_ec_suspend,
1066                 .resume = acpi_ec_resume,
1067                 },
1068 };
1069
1070 int __init acpi_ec_init(void)
1071 {
1072         int result = 0;
1073
1074         acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1075         if (!acpi_ec_dir)
1076                 return -ENODEV;
1077
1078         /* Now register the driver for the EC */
1079         result = acpi_bus_register_driver(&acpi_ec_driver);
1080         if (result < 0) {
1081                 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1082                 return -ENODEV;
1083         }
1084
1085         return result;
1086 }
1087
1088 /* EC driver currently not unloadable */
1089 #if 0
1090 static void __exit acpi_ec_exit(void)
1091 {
1092
1093         acpi_bus_unregister_driver(&acpi_ec_driver);
1094
1095         remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1096
1097         return;
1098 }
1099 #endif  /* 0 */