err.no Git - linux-2.6/blob - drivers/acpi/ec.c

   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 /* Uncomment next line to get verbose print outs*/
  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 <asm/io.h>
  42 #include <acpi/acpi_bus.h>
  43 #include <acpi/acpi_drivers.h>
  44 #include <acpi/actypes.h>
  45
  46 #define ACPI_EC_CLASS                   "embedded_controller"
  47 #define ACPI_EC_DEVICE_NAME             "Embedded Controller"
  48 #define ACPI_EC_FILE_INFO               "info"
  49
  50 #undef PREFIX
  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 /* 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 #define ACPI_EC_UDELAY          100     /* Wait 100us before polling EC again */
  77
  78 enum {
  79         EC_FLAGS_WAIT_GPE = 0,          /* Don't check status until GPE arrives */
  80         EC_FLAGS_QUERY_PENDING,         /* Query is pending */
  81         EC_FLAGS_GPE_MODE,              /* Expect GPE to be sent for status change */
  82         EC_FLAGS_NO_GPE,                /* Don't use GPE mode */
  83         EC_FLAGS_RESCHEDULE_POLL        /* Re-schedule poll */
  84 };
  85
  86 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
  87 /* External interfaces use first EC only, so remember */
  88 typedef int (*acpi_ec_query_func) (void *data);
  89
  90 struct acpi_ec_query_handler {
  91         struct list_head node;
  92         acpi_ec_query_func func;
  93         acpi_handle handle;
  94         void *data;
  95         u8 query_bit;
  96 };
  97
  98 static struct acpi_ec {
  99         acpi_handle handle;
 100         unsigned long gpe;
 101         unsigned long command_addr;
 102         unsigned long data_addr;
 103         unsigned long global_lock;
 104         unsigned long flags;
 105         struct mutex lock;
 106         wait_queue_head_t wait;
 107         struct list_head list;
 108         struct delayed_work work;
 109         atomic_t irq_count;
 110         u8 handlers_installed;
 111 } *boot_ec, *first_ec;
 112
 113 /*
 114  * Some Asus system have exchanged ECDT data/command IO addresses.
 115  */
 116 static int print_ecdt_error(const struct dmi_system_id *id)
 117 {
 118         printk(KERN_NOTICE PREFIX "%s detected - "
 119                 "ECDT has exchanged control/data I/O address\n",
 120                 id->ident);
 121         return 0;
 122 }
 123
 124 static struct dmi_system_id __cpuinitdata ec_dmi_table[] = {
 125         {
 126         print_ecdt_error, "Asus L4R", {
 127         DMI_MATCH(DMI_BIOS_VERSION, "1008.006"),
 128         DMI_MATCH(DMI_PRODUCT_NAME, "L4R"),
 129         DMI_MATCH(DMI_BOARD_NAME, "L4R") }, NULL},
 130         {
 131         print_ecdt_error, "Asus M6R", {
 132         DMI_MATCH(DMI_BIOS_VERSION, "0207"),
 133         DMI_MATCH(DMI_PRODUCT_NAME, "M6R"),
 134         DMI_MATCH(DMI_BOARD_NAME, "M6R") }, NULL},
 135         {},
 136 };
 137
 138 /* --------------------------------------------------------------------------
 139                              Transaction Management
 140    -------------------------------------------------------------------------- */
 141
 142 static inline u8 acpi_ec_read_status(struct acpi_ec *ec)
 143 {
 144         u8 x = inb(ec->command_addr);
 145         pr_debug(PREFIX "---> status = 0x%2.2x\n", x);
 146         return x;
 147 }
 148
 149 static inline u8 acpi_ec_read_data(struct acpi_ec *ec)
 150 {
 151         u8 x = inb(ec->data_addr);
 152         pr_debug(PREFIX "---> data = 0x%2.2x\n", x);
 153         return inb(ec->data_addr);
 154 }
 155
 156 static inline void acpi_ec_write_cmd(struct acpi_ec *ec, u8 command)
 157 {
 158         pr_debug(PREFIX "<--- command = 0x%2.2x\n", command);
 159         outb(command, ec->command_addr);
 160 }
 161
 162 static inline void acpi_ec_write_data(struct acpi_ec *ec, u8 data)
 163 {
 164         pr_debug(PREFIX "<--- data = 0x%2.2x\n", data);
 165         outb(data, ec->data_addr);
 166 }
 167
 168 static inline int acpi_ec_check_status(struct acpi_ec *ec, enum ec_event event)
 169 {
 170         if (test_bit(EC_FLAGS_WAIT_GPE, &ec->flags))
 171                 return 0;
 172         if (event == ACPI_EC_EVENT_OBF_1) {
 173                 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
 174                         return 1;
 175         } else if (event == ACPI_EC_EVENT_IBF_0) {
 176                 if (!(acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF))
 177                         return 1;
 178         }
 179
 180         return 0;
 181 }
 182
 183 static void ec_schedule_ec_poll(struct acpi_ec *ec)
 184 {
 185         if (test_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags))
 186                 schedule_delayed_work(&ec->work,
 187                                       msecs_to_jiffies(ACPI_EC_DELAY));
 188 }
 189
 190 static void ec_switch_to_poll_mode(struct acpi_ec *ec)
 191 {
 192         set_bit(EC_FLAGS_NO_GPE, &ec->flags);
 193         clear_bit(EC_FLAGS_GPE_MODE, &ec->flags);
 194         acpi_disable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
 195         set_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags);
 196 }
 197
 198 static int acpi_ec_wait(struct acpi_ec *ec, enum ec_event event, int force_poll)
 199 {
 200         atomic_set(&ec->irq_count, 0);
 201         if (likely(test_bit(EC_FLAGS_GPE_MODE, &ec->flags)) &&
 202             likely(!force_poll)) {
 203                 if (wait_event_timeout(ec->wait, acpi_ec_check_status(ec, event),
 204                                        msecs_to_jiffies(ACPI_EC_DELAY)))
 205                         return 0;
 206                 clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
 207                 if (acpi_ec_check_status(ec, event)) {
 208                         /* missing GPEs, switch back to poll mode */
 209                         if (printk_ratelimit())
 210                                 pr_info(PREFIX "missing confirmations, "
 211                                                 "switch off interrupt mode.\n");
 212                         ec_switch_to_poll_mode(ec);
 213                         ec_schedule_ec_poll(ec);
 214                         return 0;
 215                 }
 216         } else {
 217                 unsigned long delay = jiffies + msecs_to_jiffies(ACPI_EC_DELAY);
 218                 clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
 219                 while (time_before(jiffies, delay)) {
 220                         if (acpi_ec_check_status(ec, event))
 221                                 return 0;
 222                         msleep(1);
 223                 }
 224         }
 225         pr_err(PREFIX "acpi_ec_wait timeout, status = 0x%2.2x, event = %s\n",
 226                 acpi_ec_read_status(ec),
 227                 (event == ACPI_EC_EVENT_OBF_1) ? "\"b0=1\"" : "\"b1=0\"");
 228         return -ETIME;
 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         pr_debug(PREFIX "transaction start\n");
 239         acpi_ec_write_cmd(ec, command);
 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                 set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
 248                 acpi_ec_write_data(ec, *(wdata++));
 249         }
 250
 251         if (!rdata_len) {
 252                 result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, force_poll);
 253                 if (result) {
 254                         pr_err(PREFIX
 255                                "finish-write timeout, command = %d\n", command);
 256                         goto end;
 257                 }
 258         } else if (command == ACPI_EC_COMMAND_QUERY)
 259                 clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
 260
 261         for (; rdata_len > 0; --rdata_len) {
 262                 result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF_1, force_poll);
 263                 if (result) {
 264                         pr_err(PREFIX "read timeout, command = %d\n", command);
 265                         goto end;
 266                 }
 267                 /* Don't expect GPE after last read */
 268                 if (rdata_len > 1)
 269                         set_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
 270                 *(rdata++) = acpi_ec_read_data(ec);
 271         }
 272       end:
 273         pr_debug(PREFIX "transaction end\n");
 274         return result;
 275 }
 276
 277 static int acpi_ec_transaction(struct acpi_ec *ec, u8 command,
 278                                const u8 * wdata, unsigned wdata_len,
 279                                u8 * rdata, unsigned rdata_len,
 280                                int force_poll)
 281 {
 282         int status;
 283         u32 glk;
 284
 285         if (!ec || (wdata_len && !wdata) || (rdata_len && !rdata))
 286                 return -EINVAL;
 287
 288         if (rdata)
 289                 memset(rdata, 0, rdata_len);
 290
 291         mutex_lock(&ec->lock);
 292         if (ec->global_lock) {
 293                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 294                 if (ACPI_FAILURE(status)) {
 295                         mutex_unlock(&ec->lock);
 296                         return -ENODEV;
 297                 }
 298         }
 299
 300         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBF_0, 0);
 301         if (status) {
 302                 pr_err(PREFIX "input buffer is not empty, "
 303                                 "aborting transaction\n");
 304                 goto end;
 305         }
 306
 307         status = acpi_ec_transaction_unlocked(ec, command,
 308                                               wdata, wdata_len,
 309                                               rdata, rdata_len,
 310                                               force_poll);
 311
 312       end:
 313
 314         if (ec->global_lock)
 315                 acpi_release_global_lock(glk);
 316         mutex_unlock(&ec->lock);
 317
 318         return status;
 319 }
 320
 321 /*
 322  * Note: samsung nv5000 doesn't work with ec burst mode.
 323  * http://bugzilla.kernel.org/show_bug.cgi?id=4980
 324  */
 325 int acpi_ec_burst_enable(struct acpi_ec *ec)
 326 {
 327         u8 d;
 328         return acpi_ec_transaction(ec, ACPI_EC_BURST_ENABLE, NULL, 0, &d, 1, 0);
 329 }
 330
 331 int acpi_ec_burst_disable(struct acpi_ec *ec)
 332 {
 333         return acpi_ec_transaction(ec, ACPI_EC_BURST_DISABLE, NULL, 0, NULL, 0, 0);
 334 }
 335
 336 static int acpi_ec_read(struct acpi_ec *ec, u8 address, u8 * data)
 337 {
 338         int result;
 339         u8 d;
 340
 341         result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_READ,
 342                                      &address, 1, &d, 1, 0);
 343         *data = d;
 344         return result;
 345 }
 346
 347 static int acpi_ec_write(struct acpi_ec *ec, u8 address, u8 data)
 348 {
 349         u8 wdata[2] = { address, data };
 350         return acpi_ec_transaction(ec, ACPI_EC_COMMAND_WRITE,
 351                                    wdata, 2, NULL, 0, 0);
 352 }
 353
 354 /*
 355  * Externally callable EC access functions. For now, assume 1 EC only
 356  */
 357 int ec_burst_enable(void)
 358 {
 359         if (!first_ec)
 360                 return -ENODEV;
 361         return acpi_ec_burst_enable(first_ec);
 362 }
 363
 364 EXPORT_SYMBOL(ec_burst_enable);
 365
 366 int ec_burst_disable(void)
 367 {
 368         if (!first_ec)
 369                 return -ENODEV;
 370         return acpi_ec_burst_disable(first_ec);
 371 }
 372
 373 EXPORT_SYMBOL(ec_burst_disable);
 374
 375 int ec_read(u8 addr, u8 * val)
 376 {
 377         int err;
 378         u8 temp_data;
 379
 380         if (!first_ec)
 381                 return -ENODEV;
 382
 383         err = acpi_ec_read(first_ec, addr, &temp_data);
 384
 385         if (!err) {
 386                 *val = temp_data;
 387                 return 0;
 388         } else
 389                 return err;
 390 }
 391
 392 EXPORT_SYMBOL(ec_read);
 393
 394 int ec_write(u8 addr, u8 val)
 395 {
 396         int err;
 397
 398         if (!first_ec)
 399                 return -ENODEV;
 400
 401         err = acpi_ec_write(first_ec, addr, val);
 402
 403         return err;
 404 }
 405
 406 EXPORT_SYMBOL(ec_write);
 407
 408 int ec_transaction(u8 command,
 409                    const u8 * wdata, unsigned wdata_len,
 410                    u8 * rdata, unsigned rdata_len,
 411                    int force_poll)
 412 {
 413         if (!first_ec)
 414                 return -ENODEV;
 415
 416         return acpi_ec_transaction(first_ec, command, wdata,
 417                                    wdata_len, rdata, rdata_len,
 418                                    force_poll);
 419 }
 420
 421 EXPORT_SYMBOL(ec_transaction);
 422
 423 static int acpi_ec_query(struct acpi_ec *ec, u8 * data)
 424 {
 425         int result;
 426         u8 d;
 427
 428         if (!ec || !data)
 429                 return -EINVAL;
 430
 431         /*
 432          * Query the EC to find out which _Qxx method we need to evaluate.
 433          * Note that successful completion of the query causes the ACPI_EC_SCI
 434          * bit to be cleared (and thus clearing the interrupt source).
 435          */
 436
 437         result = acpi_ec_transaction(ec, ACPI_EC_COMMAND_QUERY, NULL, 0, &d, 1, 0);
 438         if (result)
 439                 return result;
 440
 441         if (!d)
 442                 return -ENODATA;
 443
 444         *data = d;
 445         return 0;
 446 }
 447
 448 /* --------------------------------------------------------------------------
 449                                 Event Management
 450    -------------------------------------------------------------------------- */
 451 int acpi_ec_add_query_handler(struct acpi_ec *ec, u8 query_bit,
 452                               acpi_handle handle, acpi_ec_query_func func,
 453                               void *data)
 454 {
 455         struct acpi_ec_query_handler *handler =
 456             kzalloc(sizeof(struct acpi_ec_query_handler), GFP_KERNEL);
 457         if (!handler)
 458                 return -ENOMEM;
 459
 460         handler->query_bit = query_bit;
 461         handler->handle = handle;
 462         handler->func = func;
 463         handler->data = data;
 464         mutex_lock(&ec->lock);
 465         list_add(&handler->node, &ec->list);
 466         mutex_unlock(&ec->lock);
 467         return 0;
 468 }
 469
 470 EXPORT_SYMBOL_GPL(acpi_ec_add_query_handler);
 471
 472 void acpi_ec_remove_query_handler(struct acpi_ec *ec, u8 query_bit)
 473 {
 474         struct acpi_ec_query_handler *handler, *tmp;
 475         mutex_lock(&ec->lock);
 476         list_for_each_entry_safe(handler, tmp, &ec->list, node) {
 477                 if (query_bit == handler->query_bit) {
 478                         list_del(&handler->node);
 479                         kfree(handler);
 480                 }
 481         }
 482         mutex_unlock(&ec->lock);
 483 }
 484
 485 EXPORT_SYMBOL_GPL(acpi_ec_remove_query_handler);
 486
 487 static void acpi_ec_gpe_query(void *ec_cxt)
 488 {
 489         struct acpi_ec *ec = ec_cxt;
 490         u8 value = 0;
 491         struct acpi_ec_query_handler *handler, copy;
 492
 493         if (!ec || acpi_ec_query(ec, &value))
 494                 return;
 495         mutex_lock(&ec->lock);
 496         list_for_each_entry(handler, &ec->list, node) {
 497                 if (value == handler->query_bit) {
 498                         /* have custom handler for this bit */
 499                         memcpy(&copy, handler, sizeof(copy));
 500                         mutex_unlock(&ec->lock);
 501                         if (copy.func) {
 502                                 copy.func(copy.data);
 503                         } else if (copy.handle) {
 504                                 acpi_evaluate_object(copy.handle, NULL, NULL, NULL);
 505                         }
 506                         return;
 507                 }
 508         }
 509         mutex_unlock(&ec->lock);
 510 }
 511
 512 static u32 acpi_ec_gpe_handler(void *data)
 513 {
 514         acpi_status status = AE_OK;
 515         struct acpi_ec *ec = data;
 516         u8 state = acpi_ec_read_status(ec);
 517
 518         pr_debug(PREFIX "~~~> interrupt\n");
 519         atomic_inc(&ec->irq_count);
 520         if (atomic_read(&ec->irq_count) > 5) {
 521                 pr_err(PREFIX "GPE storm detected, disabling EC GPE\n");
 522                 ec_switch_to_poll_mode(ec);
 523                 goto end;
 524         }
 525         clear_bit(EC_FLAGS_WAIT_GPE, &ec->flags);
 526         if (test_bit(EC_FLAGS_GPE_MODE, &ec->flags))
 527                 wake_up(&ec->wait);
 528
 529         if (state & ACPI_EC_FLAG_SCI) {
 530                 if (!test_and_set_bit(EC_FLAGS_QUERY_PENDING, &ec->flags))
 531                         status = acpi_os_execute(OSL_EC_BURST_HANDLER,
 532                                 acpi_ec_gpe_query, ec);
 533         } else if (!test_bit(EC_FLAGS_GPE_MODE, &ec->flags) &&
 534                    !test_bit(EC_FLAGS_NO_GPE, &ec->flags) &&
 535                    in_interrupt()) {
 536                 /* this is non-query, must be confirmation */
 537                 if (printk_ratelimit())
 538                         pr_info(PREFIX "non-query interrupt received,"
 539                                 " switching to interrupt mode\n");
 540                 set_bit(EC_FLAGS_GPE_MODE, &ec->flags);
 541                 clear_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags);
 542         }
 543 end:
 544         ec_schedule_ec_poll(ec);
 545         return ACPI_SUCCESS(status) ?
 546             ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
 547 }
 548
 549 static void do_ec_poll(struct work_struct *work)
 550 {
 551         struct acpi_ec *ec = container_of(work, struct acpi_ec, work.work);
 552         atomic_set(&ec->irq_count, 0);
 553         (void)acpi_ec_gpe_handler(ec);
 554 }
 555
 556 /* --------------------------------------------------------------------------
 557                              Address Space Management
 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 = proc_create_data(ACPI_EC_FILE_INFO, S_IRUGO,
 663                                  acpi_device_dir(device),
 664                                  &acpi_ec_info_ops, acpi_driver_data(device));
 665         if (!entry)
 666                 return -ENODEV;
 667         return 0;
 668 }
 669
 670 static int acpi_ec_remove_fs(struct acpi_device *device)
 671 {
 672
 673         if (acpi_device_dir(device)) {
 674                 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
 675                 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
 676                 acpi_device_dir(device) = NULL;
 677         }
 678
 679         return 0;
 680 }
 681
 682 /* --------------------------------------------------------------------------
 683                                Driver Interface
 684    -------------------------------------------------------------------------- */
 685 static acpi_status
 686 ec_parse_io_ports(struct acpi_resource *resource, void *context);
 687
 688 static struct acpi_ec *make_acpi_ec(void)
 689 {
 690         struct acpi_ec *ec = kzalloc(sizeof(struct acpi_ec), GFP_KERNEL);
 691         if (!ec)
 692                 return NULL;
 693         ec->flags = 1 << EC_FLAGS_QUERY_PENDING;
 694         mutex_init(&ec->lock);
 695         init_waitqueue_head(&ec->wait);
 696         INIT_LIST_HEAD(&ec->list);
 697         INIT_DELAYED_WORK_DEFERRABLE(&ec->work, do_ec_poll);
 698         atomic_set(&ec->irq_count, 0);
 699         return ec;
 700 }
 701
 702 static acpi_status
 703 acpi_ec_register_query_methods(acpi_handle handle, u32 level,
 704                                void *context, void **return_value)
 705 {
 706         struct acpi_namespace_node *node = handle;
 707         struct acpi_ec *ec = context;
 708         int value = 0;
 709         if (sscanf(node->name.ascii, "_Q%x", &value) == 1) {
 710                 acpi_ec_add_query_handler(ec, value, handle, NULL, NULL);
 711         }
 712         return AE_OK;
 713 }
 714
 715 static acpi_status
 716 ec_parse_device(acpi_handle handle, u32 Level, void *context, void **retval)
 717 {
 718         acpi_status status;
 719
 720         struct acpi_ec *ec = context;
 721         status = acpi_walk_resources(handle, METHOD_NAME__CRS,
 722                                      ec_parse_io_ports, ec);
 723         if (ACPI_FAILURE(status))
 724                 return status;
 725
 726         /* Get GPE bit assignment (EC events). */
 727         /* TODO: Add support for _GPE returning a package */
 728         status = acpi_evaluate_integer(handle, "_GPE", NULL, &ec->gpe);
 729         if (ACPI_FAILURE(status))
 730                 return status;
 731         /* Use the global lock for all EC transactions? */
 732         acpi_evaluate_integer(handle, "_GLK", NULL, &ec->global_lock);
 733         ec->handle = handle;
 734         return AE_CTRL_TERMINATE;
 735 }
 736
 737 static void ec_poll_stop(struct acpi_ec *ec)
 738 {
 739         clear_bit(EC_FLAGS_RESCHEDULE_POLL, &ec->flags);
 740         cancel_delayed_work(&ec->work);
 741 }
 742
 743 static void ec_remove_handlers(struct acpi_ec *ec)
 744 {
 745         ec_poll_stop(ec);
 746         if (ACPI_FAILURE(acpi_remove_address_space_handler(ec->handle,
 747                                 ACPI_ADR_SPACE_EC, &acpi_ec_space_handler)))
 748                 pr_err(PREFIX "failed to remove space handler\n");
 749         if (ACPI_FAILURE(acpi_remove_gpe_handler(NULL, ec->gpe,
 750                                 &acpi_ec_gpe_handler)))
 751                 pr_err(PREFIX "failed to remove gpe handler\n");
 752         ec->handlers_installed = 0;
 753 }
 754
 755 static int acpi_ec_add(struct acpi_device *device)
 756 {
 757         struct acpi_ec *ec = NULL;
 758
 759         if (!device)
 760                 return -EINVAL;
 761         strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
 762         strcpy(acpi_device_class(device), ACPI_EC_CLASS);
 763
 764         /* Check for boot EC */
 765         if (boot_ec &&
 766             (boot_ec->handle == device->handle ||
 767              boot_ec->handle == ACPI_ROOT_OBJECT)) {
 768                 ec = boot_ec;
 769                 boot_ec = NULL;
 770         } else {
 771                 ec = make_acpi_ec();
 772                 if (!ec)
 773                         return -ENOMEM;
 774                 if (ec_parse_device(device->handle, 0, ec, NULL) !=
 775                     AE_CTRL_TERMINATE) {
 776                         kfree(ec);
 777                         return -EINVAL;
 778                 }
 779         }
 780
 781         ec->handle = device->handle;
 782
 783         /* Find and register all query methods */
 784         acpi_walk_namespace(ACPI_TYPE_METHOD, ec->handle, 1,
 785                             acpi_ec_register_query_methods, ec, NULL);
 786
 787         if (!first_ec)
 788                 first_ec = ec;
 789         acpi_driver_data(device) = ec;
 790         acpi_ec_add_fs(device);
 791         pr_info(PREFIX "GPE = 0x%lx, I/O: command/status = 0x%lx, data = 0x%lx\n",
 792                           ec->gpe, ec->command_addr, ec->data_addr);
 793         pr_info(PREFIX "driver started in %s mode\n",
 794                 (test_bit(EC_FLAGS_GPE_MODE, &ec->flags))?"interrupt":"poll");
 795         return 0;
 796 }
 797
 798 static int acpi_ec_remove(struct acpi_device *device, int type)
 799 {
 800         struct acpi_ec *ec;
 801         struct acpi_ec_query_handler *handler, *tmp;
 802
 803         if (!device)
 804                 return -EINVAL;
 805
 806         ec = acpi_driver_data(device);
 807         mutex_lock(&ec->lock);
 808         list_for_each_entry_safe(handler, tmp, &ec->list, node) {
 809                 list_del(&handler->node);
 810                 kfree(handler);
 811         }
 812         mutex_unlock(&ec->lock);
 813         acpi_ec_remove_fs(device);
 814         acpi_driver_data(device) = NULL;
 815         if (ec == first_ec)
 816                 first_ec = NULL;
 817         kfree(ec);
 818         return 0;
 819 }
 820
 821 static acpi_status
 822 ec_parse_io_ports(struct acpi_resource *resource, void *context)
 823 {
 824         struct acpi_ec *ec = context;
 825
 826         if (resource->type != ACPI_RESOURCE_TYPE_IO)
 827                 return AE_OK;
 828
 829         /*
 830          * The first address region returned is the data port, and
 831          * the second address region returned is the status/command
 832          * port.
 833          */
 834         if (ec->data_addr == 0)
 835                 ec->data_addr = resource->data.io.minimum;
 836         else if (ec->command_addr == 0)
 837                 ec->command_addr = resource->data.io.minimum;
 838         else
 839                 return AE_CTRL_TERMINATE;
 840
 841         return AE_OK;
 842 }
 843
 844 static int ec_install_handlers(struct acpi_ec *ec)
 845 {
 846         acpi_status status;
 847         if (ec->handlers_installed)
 848                 return 0;
 849         status = acpi_install_gpe_handler(NULL, ec->gpe,
 850                                           ACPI_GPE_EDGE_TRIGGERED,
 851                                           &acpi_ec_gpe_handler, ec);
 852         if (ACPI_FAILURE(status))
 853                 return -ENODEV;
 854
 855         acpi_set_gpe_type(NULL, ec->gpe, ACPI_GPE_TYPE_RUNTIME);
 856         acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
 857
 858         status = acpi_install_address_space_handler(ec->handle,
 859                                                     ACPI_ADR_SPACE_EC,
 860                                                     &acpi_ec_space_handler,
 861                                                     NULL, ec);
 862         if (ACPI_FAILURE(status)) {
 863                 acpi_remove_gpe_handler(NULL, ec->gpe, &acpi_ec_gpe_handler);
 864                 return -ENODEV;
 865         }
 866
 867         ec->handlers_installed = 1;
 868         return 0;
 869 }
 870
 871 static int acpi_ec_start(struct acpi_device *device)
 872 {
 873         struct acpi_ec *ec;
 874         int ret = 0;
 875
 876         if (!device)
 877                 return -EINVAL;
 878
 879         ec = acpi_driver_data(device);
 880
 881         if (!ec)
 882                 return -EINVAL;
 883
 884         ret = ec_install_handlers(ec);
 885
 886         /* EC is fully operational, allow queries */
 887         clear_bit(EC_FLAGS_QUERY_PENDING, &ec->flags);
 888         ec_schedule_ec_poll(ec);
 889         return ret;
 890 }
 891
 892 static int acpi_ec_stop(struct acpi_device *device, int type)
 893 {
 894         struct acpi_ec *ec;
 895         if (!device)
 896                 return -EINVAL;
 897         ec = acpi_driver_data(device);
 898         if (!ec)
 899                 return -EINVAL;
 900         ec_remove_handlers(ec);
 901
 902         return 0;
 903 }
 904
 905 int __init acpi_boot_ec_enable(void)
 906 {
 907         if (!boot_ec || boot_ec->handlers_installed)
 908                 return 0;
 909         if (!ec_install_handlers(boot_ec)) {
 910                 first_ec = boot_ec;
 911                 return 0;
 912         }
 913         return -EFAULT;
 914 }
 915
 916 static const struct acpi_device_id ec_device_ids[] = {
 917         {"PNP0C09", 0},
 918         {"", 0},
 919 };
 920
 921 int __init acpi_ec_ecdt_probe(void)
 922 {
 923         int ret;
 924         acpi_status status;
 925         struct acpi_table_ecdt *ecdt_ptr;
 926
 927         boot_ec = make_acpi_ec();
 928         if (!boot_ec)
 929                 return -ENOMEM;
 930         /*
 931          * Generate a boot ec context
 932          */
 933         status = acpi_get_table(ACPI_SIG_ECDT, 1,
 934                                 (struct acpi_table_header **)&ecdt_ptr);
 935         if (ACPI_SUCCESS(status)) {
 936                 pr_info(PREFIX "EC description table is found, configuring boot EC\n");
 937                 boot_ec->command_addr = ecdt_ptr->control.address;
 938                 boot_ec->data_addr = ecdt_ptr->data.address;
 939                 if (dmi_check_system(ec_dmi_table)) {
 940                         /*
 941                          * If the board falls into ec_dmi_table, it means
 942                          * that ECDT table gives the incorrect command/status
 943                          * & data I/O address. Just fix it.
 944                          */
 945                         boot_ec->data_addr = ecdt_ptr->control.address;
 946                         boot_ec->command_addr = ecdt_ptr->data.address;
 947                 }
 948                 boot_ec->gpe = ecdt_ptr->gpe;
 949                 boot_ec->handle = ACPI_ROOT_OBJECT;
 950                 acpi_get_handle(ACPI_ROOT_OBJECT, ecdt_ptr->id, &boot_ec->handle);
 951         } else {
 952                 /* This workaround is needed only on some broken machines,
 953                  * which require early EC, but fail to provide ECDT */
 954                 acpi_handle x;
 955                 printk(KERN_DEBUG PREFIX "Look up EC in DSDT\n");
 956                 status = acpi_get_devices(ec_device_ids[0].id, ec_parse_device,
 957                                                 boot_ec, NULL);
 958                 /* Check that acpi_get_devices actually find something */
 959                 if (ACPI_FAILURE(status) || !boot_ec->handle)
 960                         goto error;
 961                 /* We really need to limit this workaround, the only ASUS,
 962                  * which needs it, has fake EC._INI method, so use it as flag.
 963                  * Keep boot_ec struct as it will be needed soon.
 964                  */
 965                 if (ACPI_FAILURE(acpi_get_handle(boot_ec->handle, "_INI", &x)))
 966                         return -ENODEV;
 967         }
 968
 969         ret = ec_install_handlers(boot_ec);
 970         if (!ret) {
 971                 first_ec = boot_ec;
 972                 return 0;
 973         }
 974       error:
 975         kfree(boot_ec);
 976         boot_ec = NULL;
 977         return -ENODEV;
 978 }
 979
 980 static int acpi_ec_suspend(struct acpi_device *device, pm_message_t state)
 981 {
 982         struct acpi_ec *ec = acpi_driver_data(device);
 983         /* Stop using GPE */
 984         set_bit(EC_FLAGS_NO_GPE, &ec->flags);
 985         clear_bit(EC_FLAGS_GPE_MODE, &ec->flags);
 986         acpi_disable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
 987         return 0;
 988 }
 989
 990 static int acpi_ec_resume(struct acpi_device *device)
 991 {
 992         struct acpi_ec *ec = acpi_driver_data(device);
 993         /* Enable use of GPE back */
 994         clear_bit(EC_FLAGS_NO_GPE, &ec->flags);
 995         acpi_enable_gpe(NULL, ec->gpe, ACPI_NOT_ISR);
 996         return 0;
 997 }
 998
 999 static struct acpi_driver acpi_ec_driver = {
1000         .name = "ec",
1001         .class = ACPI_EC_CLASS,
1002         .ids = ec_device_ids,
1003         .ops = {
1004                 .add = acpi_ec_add,
1005                 .remove = acpi_ec_remove,
1006                 .start = acpi_ec_start,
1007                 .stop = acpi_ec_stop,
1008                 .suspend = acpi_ec_suspend,
1009                 .resume = acpi_ec_resume,
1010                 },
1011 };
1012
1013 static int __init acpi_ec_init(void)
1014 {
1015         int result = 0;
1016
1017         if (acpi_disabled)
1018                 return 0;
1019
1020         acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1021         if (!acpi_ec_dir)
1022                 return -ENODEV;
1023
1024         /* Now register the driver for the EC */
1025         result = acpi_bus_register_driver(&acpi_ec_driver);
1026         if (result < 0) {
1027                 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1028                 return -ENODEV;
1029         }
1030
1031         return result;
1032 }
1033
1034 subsys_initcall(acpi_ec_init);
1035
1036 /* EC driver currently not unloadable */
1037 #if 0
1038 static void __exit acpi_ec_exit(void)
1039 {
1040
1041         acpi_bus_unregister_driver(&acpi_ec_driver);
1042
1043         remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1044
1045         return;
1046 }
1047 #endif  /* 0 */