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