drivers/acpi/ec.c

   1 /*
   2  *  acpi_ec.c - ACPI Embedded Controller Driver ($Revision: 38 $)
   3  *
   4  *  Copyright (C) 2004 Luming Yu <luming.yu@intel.com>
   5  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
   6  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
   7  *
   8  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or (at
  13  *  your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful, but
  16  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  *  General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License along
  21  *  with this program; if not, write to the Free Software Foundation, Inc.,
  22  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  23  *
  24  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  25  */
  26
  27 #include <linux/kernel.h>
  28 #include <linux/module.h>
  29 #include <linux/init.h>
  30 #include <linux/types.h>
  31 #include <linux/delay.h>
  32 #include <linux/proc_fs.h>
  33 #include <linux/seq_file.h>
  34 #include <linux/interrupt.h>
  35 #include <asm/io.h>
  36 #include <acpi/acpi_bus.h>
  37 #include <acpi/acpi_drivers.h>
  38 #include <acpi/actypes.h>
  39
  40 #define _COMPONENT              ACPI_EC_COMPONENT
  41 ACPI_MODULE_NAME("acpi_ec")
  42 #define ACPI_EC_COMPONENT               0x00100000
  43 #define ACPI_EC_CLASS                   "embedded_controller"
  44 #define ACPI_EC_HID                     "PNP0C09"
  45 #define ACPI_EC_DRIVER_NAME             "ACPI Embedded Controller Driver"
  46 #define ACPI_EC_DEVICE_NAME             "Embedded Controller"
  47 #define ACPI_EC_FILE_INFO               "info"
  48 #define ACPI_EC_FLAG_OBF        0x01    /* Output buffer full */
  49 #define ACPI_EC_FLAG_IBF        0x02    /* Input buffer full */
  50 #define ACPI_EC_FLAG_BURST      0x10    /* burst mode */
  51 #define ACPI_EC_FLAG_SCI        0x20    /* EC-SCI occurred */
  52 #define ACPI_EC_EVENT_OBF       0x01    /* Output buffer full */
  53 #define ACPI_EC_EVENT_IBE       0x02    /* Input buffer empty */
  54 #define ACPI_EC_DELAY           50      /* Wait 50ms max. during EC ops */
  55 #define ACPI_EC_UDELAY_GLK      1000    /* Wait 1ms max. to get global lock */
  56 #define ACPI_EC_UDELAY         100      /* Poll @ 100us increments */
  57 #define ACPI_EC_UDELAY_COUNT   1000     /* Wait 10ms max. during EC ops */
  58 #define ACPI_EC_COMMAND_READ    0x80
  59 #define ACPI_EC_COMMAND_WRITE   0x81
  60 #define ACPI_EC_BURST_ENABLE    0x82
  61 #define ACPI_EC_BURST_DISABLE   0x83
  62 #define ACPI_EC_COMMAND_QUERY   0x84
  63 #define EC_POLL                 0xFF
  64 #define EC_INTR                 0x00
  65 static int acpi_ec_remove(struct acpi_device *device, int type);
  66 static int acpi_ec_start(struct acpi_device *device);
  67 static int acpi_ec_stop(struct acpi_device *device, int type);
  68 static int acpi_ec_intr_add(struct acpi_device *device);
  69 static int acpi_ec_poll_add(struct acpi_device *device);
  70
  71 static struct acpi_driver acpi_ec_driver = {
  72         .name = ACPI_EC_DRIVER_NAME,
  73         .class = ACPI_EC_CLASS,
  74         .ids = ACPI_EC_HID,
  75         .ops = {
  76                 .add = acpi_ec_intr_add,
  77                 .remove = acpi_ec_remove,
  78                 .start = acpi_ec_start,
  79                 .stop = acpi_ec_stop,
  80                 },
  81 };
  82 union acpi_ec {
  83         struct {
  84                 u32 mode;
  85                 acpi_handle handle;
  86                 unsigned long uid;
  87                 unsigned long gpe_bit;
  88                 struct acpi_generic_address status_addr;
  89                 struct acpi_generic_address command_addr;
  90                 struct acpi_generic_address data_addr;
  91                 unsigned long global_lock;
  92         } common;
  93
  94         struct {
  95                 u32 mode;
  96                 acpi_handle handle;
  97                 unsigned long uid;
  98                 unsigned long gpe_bit;
  99                 struct acpi_generic_address status_addr;
 100                 struct acpi_generic_address command_addr;
 101                 struct acpi_generic_address data_addr;
 102                 unsigned long global_lock;
 103                 unsigned int expect_event;
 104                 atomic_t leaving_burst; /* 0 : No, 1 : Yes, 2: abort */
 105                 atomic_t pending_gpe;
 106                 struct semaphore sem;
 107                 wait_queue_head_t wait;
 108         } intr;
 109
 110         struct {
 111                 u32 mode;
 112                 acpi_handle handle;
 113                 unsigned long uid;
 114                 unsigned long gpe_bit;
 115                 struct acpi_generic_address status_addr;
 116                 struct acpi_generic_address command_addr;
 117                 struct acpi_generic_address data_addr;
 118                 unsigned long global_lock;
 119                 spinlock_t lock;
 120         } poll;
 121 };
 122
 123 static int acpi_ec_poll_wait(union acpi_ec *ec, u8 event);
 124 static int acpi_ec_intr_wait(union acpi_ec *ec, unsigned int event);
 125 static int acpi_ec_poll_read(union acpi_ec *ec, u8 address, u32 * data);
 126 static int acpi_ec_intr_read(union acpi_ec *ec, u8 address, u32 * data);
 127 static int acpi_ec_poll_write(union acpi_ec *ec, u8 address, u8 data);
 128 static int acpi_ec_intr_write(union acpi_ec *ec, u8 address, u8 data);
 129 static int acpi_ec_poll_query(union acpi_ec *ec, u32 * data);
 130 static int acpi_ec_intr_query(union acpi_ec *ec, u32 * data);
 131 static void acpi_ec_gpe_poll_query(void *ec_cxt);
 132 static void acpi_ec_gpe_intr_query(void *ec_cxt);
 133 static u32 acpi_ec_gpe_poll_handler(void *data);
 134 static u32 acpi_ec_gpe_intr_handler(void *data);
 135 static acpi_status __init
 136 acpi_fake_ecdt_poll_callback(acpi_handle handle,
 137                                 u32 Level, void *context, void **retval);
 138
 139 static acpi_status __init
 140 acpi_fake_ecdt_intr_callback(acpi_handle handle,
 141                               u32 Level, void *context, void **retval);
 142
 143 static int __init acpi_ec_poll_get_real_ecdt(void);
 144 static int __init acpi_ec_intr_get_real_ecdt(void);
 145 /* If we find an EC via the ECDT, we need to keep a ptr to its context */
 146 static union acpi_ec *ec_ecdt;
 147
 148 /* External interfaces use first EC only, so remember */
 149 static struct acpi_device *first_ec;
 150 static int acpi_ec_poll_mode = EC_INTR;
 151
 152 /* --------------------------------------------------------------------------
 153                              Transaction Management
 154    -------------------------------------------------------------------------- */
 155
 156 static u32 acpi_ec_read_status(union acpi_ec *ec)
 157 {
 158         u32 status = 0;
 159
 160         acpi_hw_low_level_read(8, &status, &ec->common.status_addr);
 161         return status;
 162 }
 163
 164 static int acpi_ec_wait(union acpi_ec *ec, u8 event)
 165 {
 166         if (acpi_ec_poll_mode)
 167                 return acpi_ec_poll_wait(ec, event);
 168         else
 169                 return acpi_ec_intr_wait(ec, event);
 170 }
 171
 172 static int acpi_ec_poll_wait(union acpi_ec *ec, u8 event)
 173 {
 174         u32 acpi_ec_status = 0;
 175         u32 i = ACPI_EC_UDELAY_COUNT;
 176
 177         if (!ec)
 178                 return -EINVAL;
 179
 180         /* Poll the EC status register waiting for the event to occur. */
 181         switch (event) {
 182         case ACPI_EC_EVENT_OBF:
 183                 do {
 184                         acpi_hw_low_level_read(8, &acpi_ec_status,
 185                                                &ec->common.status_addr);
 186                         if (acpi_ec_status & ACPI_EC_FLAG_OBF)
 187                                 return 0;
 188                         udelay(ACPI_EC_UDELAY);
 189                 } while (--i > 0);
 190                 break;
 191         case ACPI_EC_EVENT_IBE:
 192                 do {
 193                         acpi_hw_low_level_read(8, &acpi_ec_status,
 194                                                &ec->common.status_addr);
 195                         if (!(acpi_ec_status & ACPI_EC_FLAG_IBF))
 196                                 return 0;
 197                         udelay(ACPI_EC_UDELAY);
 198                 } while (--i > 0);
 199                 break;
 200         default:
 201                 return -EINVAL;
 202         }
 203
 204         return -ETIME;
 205 }
 206 static int acpi_ec_intr_wait(union acpi_ec *ec, unsigned int event)
 207 {
 208         int result = 0;
 209
 210         ACPI_FUNCTION_TRACE("acpi_ec_wait");
 211
 212         ec->intr.expect_event = event;
 213         smp_mb();
 214
 215         switch (event) {
 216         case ACPI_EC_EVENT_IBE:
 217                 if (~acpi_ec_read_status(ec) & event) {
 218                         ec->intr.expect_event = 0;
 219                         return_VALUE(0);
 220                 }
 221                 break;
 222         default:
 223                 break;
 224         }
 225
 226         result = wait_event_timeout(ec->intr.wait,
 227                                     !ec->intr.expect_event,
 228                                     msecs_to_jiffies(ACPI_EC_DELAY));
 229
 230         ec->intr.expect_event = 0;
 231         smp_mb();
 232
 233         /*
 234          * Verify that the event in question has actually happened by
 235          * querying EC status. Do the check even if operation timed-out
 236          * to make sure that we did not miss interrupt.
 237          */
 238         switch (event) {
 239         case ACPI_EC_EVENT_OBF:
 240                 if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_OBF)
 241                         return_VALUE(0);
 242                 break;
 243
 244         case ACPI_EC_EVENT_IBE:
 245                 if (~acpi_ec_read_status(ec) & ACPI_EC_FLAG_IBF)
 246                         return_VALUE(0);
 247                 break;
 248         }
 249
 250         return_VALUE(-ETIME);
 251 }
 252
 253 #ifdef ACPI_FUTURE_USAGE
 254 /*
 255  * Note: samsung nv5000 doesn't work with ec burst mode.
 256  * http://bugzilla.kernel.org/show_bug.cgi?id=4980
 257  */
 258 int acpi_ec_enter_burst_mode(union acpi_ec *ec)
 259 {
 260         u32 tmp = 0;
 261         int status = 0;
 262
 263         ACPI_FUNCTION_TRACE("acpi_ec_enter_burst_mode");
 264
 265         status = acpi_ec_read_status(ec);
 266         if (status != -EINVAL && !(status & ACPI_EC_FLAG_BURST)) {
 267                 status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 268                 if (status)
 269                         goto end;
 270                 acpi_hw_low_level_write(8, ACPI_EC_BURST_ENABLE,
 271                                         &ec->common.command_addr);
 272                 status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
 273                 acpi_hw_low_level_read(8, &tmp, &ec->common.data_addr);
 274                 if (tmp != 0x90) {      /* Burst ACK byte */
 275                         return_VALUE(-EINVAL);
 276                 }
 277         }
 278
 279         atomic_set(&ec->intr.leaving_burst, 0);
 280         return_VALUE(0);
 281       end:
 282         printk(KERN_WARNING PREFIX "Error in acpi_ec_wait\n");
 283         return_VALUE(-1);
 284 }
 285
 286 int acpi_ec_leave_burst_mode(union acpi_ec *ec)
 287 {
 288         int status = 0;
 289
 290         ACPI_FUNCTION_TRACE("acpi_ec_leave_burst_mode");
 291
 292         status = acpi_ec_read_status(ec);
 293         if (status != -EINVAL && (status & ACPI_EC_FLAG_BURST)){
 294                 status = acpi_ec_wait(ec, ACPI_EC_FLAG_IBF);
 295                 if(status)
 296                         goto end;
 297                 acpi_hw_low_level_write(8, ACPI_EC_BURST_DISABLE, &ec->common.command_addr);
 298                 acpi_ec_wait(ec, ACPI_EC_FLAG_IBF);
 299         }
 300         atomic_set(&ec->intr.leaving_burst, 1);
 301         return_VALUE(0);
 302 end:
 303         printk(KERN_WARNING PREFIX "leave burst_mode:error\n");
 304         return_VALUE(-1);
 305 }
 306 #endif /* ACPI_FUTURE_USAGE */
 307
 308 static int acpi_ec_read(union acpi_ec *ec, u8 address, u32 * data)
 309 {
 310         if (acpi_ec_poll_mode)
 311                 return acpi_ec_poll_read(ec, address, data);
 312         else
 313                 return acpi_ec_intr_read(ec, address, data);
 314 }
 315 static int acpi_ec_write(union acpi_ec *ec, u8 address, u8 data)
 316 {
 317         if (acpi_ec_poll_mode)
 318                 return acpi_ec_poll_write(ec, address, data);
 319         else
 320                 return acpi_ec_intr_write(ec, address, data);
 321 }
 322 static int acpi_ec_poll_read(union acpi_ec *ec, u8 address, u32 * data)
 323 {
 324         acpi_status status = AE_OK;
 325         int result = 0;
 326         unsigned long flags = 0;
 327         u32 glk = 0;
 328
 329         ACPI_FUNCTION_TRACE("acpi_ec_read");
 330
 331         if (!ec || !data)
 332                 return_VALUE(-EINVAL);
 333
 334         *data = 0;
 335
 336         if (ec->common.global_lock) {
 337                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 338                 if (ACPI_FAILURE(status))
 339                         return_VALUE(-ENODEV);
 340         }
 341
 342         spin_lock_irqsave(&ec->poll.lock, flags);
 343
 344         acpi_hw_low_level_write(8, ACPI_EC_COMMAND_READ,
 345                                 &ec->common.command_addr);
 346         result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 347         if (result)
 348                 goto end;
 349
 350         acpi_hw_low_level_write(8, address, &ec->common.data_addr);
 351         result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
 352         if (result)
 353                 goto end;
 354
 355         acpi_hw_low_level_read(8, data, &ec->common.data_addr);
 356
 357         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Read [%02x] from address [%02x]\n",
 358                           *data, address));
 359
 360       end:
 361         spin_unlock_irqrestore(&ec->poll.lock, flags);
 362
 363         if (ec->common.global_lock)
 364                 acpi_release_global_lock(glk);
 365
 366         return_VALUE(result);
 367 }
 368
 369 static int acpi_ec_poll_write(union acpi_ec *ec, u8 address, u8 data)
 370 {
 371         int result = 0;
 372         acpi_status status = AE_OK;
 373         unsigned long flags = 0;
 374         u32 glk = 0;
 375
 376         ACPI_FUNCTION_TRACE("acpi_ec_write");
 377
 378         if (!ec)
 379                 return_VALUE(-EINVAL);
 380
 381         if (ec->common.global_lock) {
 382                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 383                 if (ACPI_FAILURE(status))
 384                         return_VALUE(-ENODEV);
 385         }
 386
 387         spin_lock_irqsave(&ec->poll.lock, flags);
 388
 389         acpi_hw_low_level_write(8, ACPI_EC_COMMAND_WRITE,
 390                                 &ec->common.command_addr);
 391         result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 392         if (result)
 393                 goto end;
 394
 395         acpi_hw_low_level_write(8, address, &ec->common.data_addr);
 396         result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 397         if (result)
 398                 goto end;
 399
 400         acpi_hw_low_level_write(8, data, &ec->common.data_addr);
 401         result = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 402         if (result)
 403                 goto end;
 404
 405         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Wrote [%02x] to address [%02x]\n",
 406                           data, address));
 407
 408       end:
 409         spin_unlock_irqrestore(&ec->poll.lock, flags);
 410
 411         if (ec->common.global_lock)
 412                 acpi_release_global_lock(glk);
 413
 414         return_VALUE(result);
 415 }
 416
 417 static int acpi_ec_intr_read(union acpi_ec *ec, u8 address, u32 * data)
 418 {
 419         int status = 0;
 420         u32 glk;
 421
 422         ACPI_FUNCTION_TRACE("acpi_ec_read");
 423
 424         if (!ec || !data)
 425                 return_VALUE(-EINVAL);
 426
 427         *data = 0;
 428
 429         if (ec->common.global_lock) {
 430                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 431                 if (ACPI_FAILURE(status))
 432                         return_VALUE(-ENODEV);
 433         }
 434
 435         WARN_ON(in_interrupt());
 436         down(&ec->intr.sem);
 437
 438         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 439         if (status) {
 440                 printk(KERN_DEBUG PREFIX "read EC, IB not empty\n");
 441                 goto end;
 442         }
 443         acpi_hw_low_level_write(8, ACPI_EC_COMMAND_READ,
 444                                 &ec->common.command_addr);
 445         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 446         if (status) {
 447                 printk(KERN_DEBUG PREFIX "read EC, IB not empty\n");
 448         }
 449
 450         acpi_hw_low_level_write(8, address, &ec->common.data_addr);
 451         status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
 452         if (status) {
 453                 printk(KERN_DEBUG PREFIX "read EC, OB not full\n");
 454                 goto end;
 455         }
 456         acpi_hw_low_level_read(8, data, &ec->common.data_addr);
 457         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Read [%02x] from address [%02x]\n",
 458                           *data, address));
 459
 460       end:
 461         up(&ec->intr.sem);
 462
 463         if (ec->common.global_lock)
 464                 acpi_release_global_lock(glk);
 465
 466         return_VALUE(status);
 467 }
 468
 469 static int acpi_ec_intr_write(union acpi_ec *ec, u8 address, u8 data)
 470 {
 471         int status = 0;
 472         u32 glk;
 473
 474         ACPI_FUNCTION_TRACE("acpi_ec_write");
 475
 476         if (!ec)
 477                 return_VALUE(-EINVAL);
 478
 479         if (ec->common.global_lock) {
 480                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 481                 if (ACPI_FAILURE(status))
 482                         return_VALUE(-ENODEV);
 483         }
 484
 485         WARN_ON(in_interrupt());
 486         down(&ec->intr.sem);
 487
 488         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 489         if (status) {
 490                 printk(KERN_DEBUG PREFIX "write EC, IB not empty\n");
 491         }
 492         acpi_hw_low_level_write(8, ACPI_EC_COMMAND_WRITE,
 493                                 &ec->common.command_addr);
 494         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 495         if (status) {
 496                 printk(KERN_DEBUG PREFIX "write EC, IB not empty\n");
 497         }
 498
 499         acpi_hw_low_level_write(8, address, &ec->common.data_addr);
 500         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 501         if (status) {
 502                 printk(KERN_DEBUG PREFIX "write EC, IB not empty\n");
 503         }
 504
 505         acpi_hw_low_level_write(8, data, &ec->common.data_addr);
 506
 507         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Wrote [%02x] to address [%02x]\n",
 508                           data, address));
 509
 510         up(&ec->intr.sem);
 511
 512         if (ec->common.global_lock)
 513                 acpi_release_global_lock(glk);
 514
 515         return_VALUE(status);
 516 }
 517
 518 /*
 519  * Externally callable EC access functions. For now, assume 1 EC only
 520  */
 521 int ec_read(u8 addr, u8 * val)
 522 {
 523         union acpi_ec *ec;
 524         int err;
 525         u32 temp_data;
 526
 527         if (!first_ec)
 528                 return -ENODEV;
 529
 530         ec = acpi_driver_data(first_ec);
 531
 532         err = acpi_ec_read(ec, addr, &temp_data);
 533
 534         if (!err) {
 535                 *val = temp_data;
 536                 return 0;
 537         } else
 538                 return err;
 539 }
 540
 541 EXPORT_SYMBOL(ec_read);
 542
 543 int ec_write(u8 addr, u8 val)
 544 {
 545         union acpi_ec *ec;
 546         int err;
 547
 548         if (!first_ec)
 549                 return -ENODEV;
 550
 551         ec = acpi_driver_data(first_ec);
 552
 553         err = acpi_ec_write(ec, addr, val);
 554
 555         return err;
 556 }
 557
 558 EXPORT_SYMBOL(ec_write);
 559
 560 static int acpi_ec_query(union acpi_ec *ec, u32 * data)
 561 {
 562         if (acpi_ec_poll_mode)
 563                 return acpi_ec_poll_query(ec, data);
 564         else
 565                 return acpi_ec_intr_query(ec, data);
 566 }
 567 static int acpi_ec_poll_query(union acpi_ec *ec, u32 * data)
 568 {
 569         int result = 0;
 570         acpi_status status = AE_OK;
 571         unsigned long flags = 0;
 572         u32 glk = 0;
 573
 574         ACPI_FUNCTION_TRACE("acpi_ec_query");
 575
 576         if (!ec || !data)
 577                 return_VALUE(-EINVAL);
 578
 579         *data = 0;
 580
 581         if (ec->common.global_lock) {
 582                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 583                 if (ACPI_FAILURE(status))
 584                         return_VALUE(-ENODEV);
 585         }
 586
 587         /*
 588          * Query the EC to find out which _Qxx method we need to evaluate.
 589          * Note that successful completion of the query causes the ACPI_EC_SCI
 590          * bit to be cleared (and thus clearing the interrupt source).
 591          */
 592         spin_lock_irqsave(&ec->poll.lock, flags);
 593
 594         acpi_hw_low_level_write(8, ACPI_EC_COMMAND_QUERY,
 595                                 &ec->common.command_addr);
 596         result = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
 597         if (result)
 598                 goto end;
 599
 600         acpi_hw_low_level_read(8, data, &ec->common.data_addr);
 601         if (!*data)
 602                 result = -ENODATA;
 603
 604       end:
 605         spin_unlock_irqrestore(&ec->poll.lock, flags);
 606
 607         if (ec->common.global_lock)
 608                 acpi_release_global_lock(glk);
 609
 610         return_VALUE(result);
 611 }
 612 static int acpi_ec_intr_query(union acpi_ec *ec, u32 * data)
 613 {
 614         int status = 0;
 615         u32 glk;
 616
 617         ACPI_FUNCTION_TRACE("acpi_ec_query");
 618
 619         if (!ec || !data)
 620                 return_VALUE(-EINVAL);
 621         *data = 0;
 622
 623         if (ec->common.global_lock) {
 624                 status = acpi_acquire_global_lock(ACPI_EC_UDELAY_GLK, &glk);
 625                 if (ACPI_FAILURE(status))
 626                         return_VALUE(-ENODEV);
 627         }
 628
 629         down(&ec->intr.sem);
 630
 631         status = acpi_ec_wait(ec, ACPI_EC_EVENT_IBE);
 632         if (status) {
 633                 printk(KERN_DEBUG PREFIX "query EC, IB not empty\n");
 634                 goto end;
 635         }
 636         /*
 637          * Query the EC to find out which _Qxx method we need to evaluate.
 638          * Note that successful completion of the query causes the ACPI_EC_SCI
 639          * bit to be cleared (and thus clearing the interrupt source).
 640          */
 641         acpi_hw_low_level_write(8, ACPI_EC_COMMAND_QUERY,
 642                                 &ec->common.command_addr);
 643         status = acpi_ec_wait(ec, ACPI_EC_EVENT_OBF);
 644         if (status) {
 645                 printk(KERN_DEBUG PREFIX "query EC, OB not full\n");
 646                 goto end;
 647         }
 648
 649         acpi_hw_low_level_read(8, data, &ec->common.data_addr);
 650         if (!*data)
 651                 status = -ENODATA;
 652
 653       end:
 654         up(&ec->intr.sem);
 655
 656         if (ec->common.global_lock)
 657                 acpi_release_global_lock(glk);
 658
 659         return_VALUE(status);
 660 }
 661
 662 /* --------------------------------------------------------------------------
 663                                 Event Management
 664    -------------------------------------------------------------------------- */
 665
 666 union acpi_ec_query_data {
 667         acpi_handle handle;
 668         u8 data;
 669 };
 670
 671 static void acpi_ec_gpe_query(void *ec_cxt)
 672 {
 673         if (acpi_ec_poll_mode)
 674                 acpi_ec_gpe_poll_query(ec_cxt);
 675         else
 676                 acpi_ec_gpe_intr_query(ec_cxt);
 677 }
 678
 679 static void acpi_ec_gpe_poll_query(void *ec_cxt)
 680 {
 681         union acpi_ec *ec = (union acpi_ec *)ec_cxt;
 682         u32 value = 0;
 683         unsigned long flags = 0;
 684         static char object_name[5] = { '_', 'Q', '0', '0', '\0' };
 685         const char hex[] = { '0', '1', '2', '3', '4', '5', '6', '7',
 686                 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
 687         };
 688
 689         ACPI_FUNCTION_TRACE("acpi_ec_gpe_query");
 690
 691         if (!ec_cxt)
 692                 goto end;
 693
 694         spin_lock_irqsave(&ec->poll.lock, flags);
 695         acpi_hw_low_level_read(8, &value, &ec->common.command_addr);
 696         spin_unlock_irqrestore(&ec->poll.lock, flags);
 697
 698         /* TBD: Implement asynch events!
 699          * NOTE: All we care about are EC-SCI's.  Other EC events are
 700          * handled via polling (yuck!).  This is because some systems
 701          * treat EC-SCIs as level (versus EDGE!) triggered, preventing
 702          *  a purely interrupt-driven approach (grumble, grumble).
 703          */
 704         if (!(value & ACPI_EC_FLAG_SCI))
 705                 goto end;
 706
 707         if (acpi_ec_query(ec, &value))
 708                 goto end;
 709
 710         object_name[2] = hex[((value >> 4) & 0x0F)];
 711         object_name[3] = hex[(value & 0x0F)];
 712
 713         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s\n", object_name));
 714
 715         acpi_evaluate_object(ec->common.handle, object_name, NULL, NULL);
 716
 717       end:
 718         acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
 719 }
 720 static void acpi_ec_gpe_intr_query(void *ec_cxt)
 721 {
 722         union acpi_ec *ec = (union acpi_ec *)ec_cxt;
 723         u32 value;
 724         int result = -ENODATA;
 725         static char object_name[5] = { '_', 'Q', '0', '0', '\0' };
 726         const char hex[] = { '0', '1', '2', '3', '4', '5', '6', '7',
 727                 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
 728         };
 729
 730         ACPI_FUNCTION_TRACE("acpi_ec_gpe_query");
 731
 732         if (acpi_ec_read_status(ec) & ACPI_EC_FLAG_SCI)
 733                 result = acpi_ec_query(ec, &value);
 734
 735         if (result)
 736                 goto end;
 737
 738         object_name[2] = hex[((value >> 4) & 0x0F)];
 739         object_name[3] = hex[(value & 0x0F)];
 740
 741         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Evaluating %s\n", object_name));
 742
 743         acpi_evaluate_object(ec->common.handle, object_name, NULL, NULL);
 744       end:
 745         atomic_dec(&ec->intr.pending_gpe);
 746         return;
 747 }
 748
 749 static u32 acpi_ec_gpe_handler(void *data)
 750 {
 751         if (acpi_ec_poll_mode)
 752                 return acpi_ec_gpe_poll_handler(data);
 753         else
 754                 return acpi_ec_gpe_intr_handler(data);
 755 }
 756 static u32 acpi_ec_gpe_poll_handler(void *data)
 757 {
 758         acpi_status status = AE_OK;
 759         union acpi_ec *ec = (union acpi_ec *)data;
 760
 761         if (!ec)
 762                 return ACPI_INTERRUPT_NOT_HANDLED;
 763
 764         acpi_disable_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
 765
 766         status = acpi_os_execute(OSL_EC_POLL_HANDLER, acpi_ec_gpe_query, ec);
 767
 768         if (status == AE_OK)
 769                 return ACPI_INTERRUPT_HANDLED;
 770         else
 771                 return ACPI_INTERRUPT_NOT_HANDLED;
 772 }
 773 static u32 acpi_ec_gpe_intr_handler(void *data)
 774 {
 775         acpi_status status = AE_OK;
 776         u32 value;
 777         union acpi_ec *ec = (union acpi_ec *)data;
 778
 779         if (!ec)
 780                 return ACPI_INTERRUPT_NOT_HANDLED;
 781
 782         acpi_clear_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
 783         value = acpi_ec_read_status(ec);
 784
 785         switch (ec->intr.expect_event) {
 786         case ACPI_EC_EVENT_OBF:
 787                 if (!(value & ACPI_EC_FLAG_OBF))
 788                         break;
 789         case ACPI_EC_EVENT_IBE:
 790                 if ((value & ACPI_EC_FLAG_IBF))
 791                         break;
 792                 ec->intr.expect_event = 0;
 793                 wake_up(&ec->intr.wait);
 794                 return ACPI_INTERRUPT_HANDLED;
 795         default:
 796                 break;
 797         }
 798
 799         if (value & ACPI_EC_FLAG_SCI) {
 800                 atomic_add(1, &ec->intr.pending_gpe);
 801                 status = acpi_os_execute(OSL_EC_BURST_HANDLER,
 802                                                      acpi_ec_gpe_query, ec);
 803                 return status == AE_OK ?
 804                     ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
 805         }
 806         acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_ISR);
 807         return status == AE_OK ?
 808             ACPI_INTERRUPT_HANDLED : ACPI_INTERRUPT_NOT_HANDLED;
 809 }
 810
 811 /* --------------------------------------------------------------------------
 812                              Address Space Management
 813    -------------------------------------------------------------------------- */
 814
 815 static acpi_status
 816 acpi_ec_space_setup(acpi_handle region_handle,
 817                     u32 function, void *handler_context, void **return_context)
 818 {
 819         /*
 820          * The EC object is in the handler context and is needed
 821          * when calling the acpi_ec_space_handler.
 822          */
 823         *return_context = (function != ACPI_REGION_DEACTIVATE) ?
 824             handler_context : NULL;
 825
 826         return AE_OK;
 827 }
 828
 829 static acpi_status
 830 acpi_ec_space_handler(u32 function,
 831                       acpi_physical_address address,
 832                       u32 bit_width,
 833                       acpi_integer * value,
 834                       void *handler_context, void *region_context)
 835 {
 836         int result = 0;
 837         union acpi_ec *ec = NULL;
 838         u64 temp = *value;
 839         acpi_integer f_v = 0;
 840         int i = 0;
 841
 842         ACPI_FUNCTION_TRACE("acpi_ec_space_handler");
 843
 844         if ((address > 0xFF) || !value || !handler_context)
 845                 return_VALUE(AE_BAD_PARAMETER);
 846
 847         if (bit_width != 8 && acpi_strict) {
 848                 printk(KERN_WARNING PREFIX
 849                        "acpi_ec_space_handler: bit_width should be 8\n");
 850                 return_VALUE(AE_BAD_PARAMETER);
 851         }
 852
 853         ec = (union acpi_ec *)handler_context;
 854
 855       next_byte:
 856         switch (function) {
 857         case ACPI_READ:
 858                 temp = 0;
 859                 result = acpi_ec_read(ec, (u8) address, (u32 *) & temp);
 860                 break;
 861         case ACPI_WRITE:
 862                 result = acpi_ec_write(ec, (u8) address, (u8) temp);
 863                 break;
 864         default:
 865                 result = -EINVAL;
 866                 goto out;
 867                 break;
 868         }
 869
 870         bit_width -= 8;
 871         if (bit_width) {
 872                 if (function == ACPI_READ)
 873                         f_v |= temp << 8 * i;
 874                 if (function == ACPI_WRITE)
 875                         temp >>= 8;
 876                 i++;
 877                 address++;
 878                 goto next_byte;
 879         }
 880
 881         if (function == ACPI_READ) {
 882                 f_v |= temp << 8 * i;
 883                 *value = f_v;
 884         }
 885
 886       out:
 887         switch (result) {
 888         case -EINVAL:
 889                 return_VALUE(AE_BAD_PARAMETER);
 890                 break;
 891         case -ENODEV:
 892                 return_VALUE(AE_NOT_FOUND);
 893                 break;
 894         case -ETIME:
 895                 return_VALUE(AE_TIME);
 896                 break;
 897         default:
 898                 return_VALUE(AE_OK);
 899         }
 900 }
 901
 902 /* --------------------------------------------------------------------------
 903                               FS Interface (/proc)
 904    -------------------------------------------------------------------------- */
 905
 906 static struct proc_dir_entry *acpi_ec_dir;
 907
 908 static int acpi_ec_read_info(struct seq_file *seq, void *offset)
 909 {
 910         union acpi_ec *ec = (union acpi_ec *)seq->private;
 911
 912         ACPI_FUNCTION_TRACE("acpi_ec_read_info");
 913
 914         if (!ec)
 915                 goto end;
 916
 917         seq_printf(seq, "gpe bit:                 0x%02x\n",
 918                    (u32) ec->common.gpe_bit);
 919         seq_printf(seq, "ports:                   0x%02x, 0x%02x\n",
 920                    (u32) ec->common.status_addr.address,
 921                    (u32) ec->common.data_addr.address);
 922         seq_printf(seq, "use global lock:         %s\n",
 923                    ec->common.global_lock ? "yes" : "no");
 924         acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
 925
 926       end:
 927         return_VALUE(0);
 928 }
 929
 930 static int acpi_ec_info_open_fs(struct inode *inode, struct file *file)
 931 {
 932         return single_open(file, acpi_ec_read_info, PDE(inode)->data);
 933 }
 934
 935 static struct file_operations acpi_ec_info_ops = {
 936         .open = acpi_ec_info_open_fs,
 937         .read = seq_read,
 938         .llseek = seq_lseek,
 939         .release = single_release,
 940         .owner = THIS_MODULE,
 941 };
 942
 943 static int acpi_ec_add_fs(struct acpi_device *device)
 944 {
 945         struct proc_dir_entry *entry = NULL;
 946
 947         ACPI_FUNCTION_TRACE("acpi_ec_add_fs");
 948
 949         if (!acpi_device_dir(device)) {
 950                 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
 951                                                      acpi_ec_dir);
 952                 if (!acpi_device_dir(device))
 953                         return_VALUE(-ENODEV);
 954         }
 955
 956         entry = create_proc_entry(ACPI_EC_FILE_INFO, S_IRUGO,
 957                                   acpi_device_dir(device));
 958         if (!entry)
 959                 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
 960                                   "Unable to create '%s' fs entry\n",
 961                                   ACPI_EC_FILE_INFO));
 962         else {
 963                 entry->proc_fops = &acpi_ec_info_ops;
 964                 entry->data = acpi_driver_data(device);
 965                 entry->owner = THIS_MODULE;
 966         }
 967
 968         return_VALUE(0);
 969 }
 970
 971 static int acpi_ec_remove_fs(struct acpi_device *device)
 972 {
 973         ACPI_FUNCTION_TRACE("acpi_ec_remove_fs");
 974
 975         if (acpi_device_dir(device)) {
 976                 remove_proc_entry(ACPI_EC_FILE_INFO, acpi_device_dir(device));
 977                 remove_proc_entry(acpi_device_bid(device), acpi_ec_dir);
 978                 acpi_device_dir(device) = NULL;
 979         }
 980
 981         return_VALUE(0);
 982 }
 983
 984 /* --------------------------------------------------------------------------
 985                                Driver Interface
 986    -------------------------------------------------------------------------- */
 987
 988 static int acpi_ec_poll_add(struct acpi_device *device)
 989 {
 990         int result = 0;
 991         acpi_status status = AE_OK;
 992         union acpi_ec *ec = NULL;
 993
 994         ACPI_FUNCTION_TRACE("acpi_ec_add");
 995
 996         if (!device)
 997                 return_VALUE(-EINVAL);
 998
 999         ec = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1000         if (!ec)
1001                 return_VALUE(-ENOMEM);
1002         memset(ec, 0, sizeof(union acpi_ec));
1003
1004         ec->common.handle = device->handle;
1005         ec->common.uid = -1;
1006         spin_lock_init(&ec->poll.lock);
1007         strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1008         strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1009         acpi_driver_data(device) = ec;
1010
1011         /* Use the global lock for all EC transactions? */
1012         acpi_evaluate_integer(ec->common.handle, "_GLK", NULL,
1013                               &ec->common.global_lock);
1014
1015         /* XXX we don't test uids, because on some boxes ecdt uid = 0, see:
1016            http://bugzilla.kernel.org/show_bug.cgi?id=6111 */
1017         if (ec_ecdt) {
1018                 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
1019                                                   ACPI_ADR_SPACE_EC,
1020                                                   &acpi_ec_space_handler);
1021
1022                 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1023                                         &acpi_ec_gpe_handler);
1024
1025                 kfree(ec_ecdt);
1026         }
1027
1028         /* Get GPE bit assignment (EC events). */
1029         /* TODO: Add support for _GPE returning a package */
1030         status =
1031             acpi_evaluate_integer(ec->common.handle, "_GPE", NULL,
1032                                   &ec->common.gpe_bit);
1033         if (ACPI_FAILURE(status)) {
1034                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
1035                                   "Error obtaining GPE bit assignment\n"));
1036                 result = -ENODEV;
1037                 goto end;
1038         }
1039
1040         result = acpi_ec_add_fs(device);
1041         if (result)
1042                 goto end;
1043
1044         printk(KERN_INFO PREFIX "%s [%s] (gpe %d) polling mode.\n",
1045                acpi_device_name(device), acpi_device_bid(device),
1046                (u32) ec->common.gpe_bit);
1047
1048         if (!first_ec)
1049                 first_ec = device;
1050
1051       end:
1052         if (result)
1053                 kfree(ec);
1054
1055         return_VALUE(result);
1056 }
1057 static int acpi_ec_intr_add(struct acpi_device *device)
1058 {
1059         int result = 0;
1060         acpi_status status = AE_OK;
1061         union acpi_ec *ec = NULL;
1062
1063         ACPI_FUNCTION_TRACE("acpi_ec_add");
1064
1065         if (!device)
1066                 return_VALUE(-EINVAL);
1067
1068         ec = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1069         if (!ec)
1070                 return_VALUE(-ENOMEM);
1071         memset(ec, 0, sizeof(union acpi_ec));
1072
1073         ec->common.handle = device->handle;
1074         ec->common.uid = -1;
1075         atomic_set(&ec->intr.pending_gpe, 0);
1076         atomic_set(&ec->intr.leaving_burst, 1);
1077         init_MUTEX(&ec->intr.sem);
1078         init_waitqueue_head(&ec->intr.wait);
1079         strcpy(acpi_device_name(device), ACPI_EC_DEVICE_NAME);
1080         strcpy(acpi_device_class(device), ACPI_EC_CLASS);
1081         acpi_driver_data(device) = ec;
1082
1083         /* Use the global lock for all EC transactions? */
1084         acpi_evaluate_integer(ec->common.handle, "_GLK", NULL,
1085                               &ec->common.global_lock);
1086
1087         /* XXX we don't test uids, because on some boxes ecdt uid = 0, see:
1088            http://bugzilla.kernel.org/show_bug.cgi?id=6111 */
1089         if (ec_ecdt) {
1090                 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
1091                                                   ACPI_ADR_SPACE_EC,
1092                                                   &acpi_ec_space_handler);
1093
1094                 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1095                                         &acpi_ec_gpe_handler);
1096
1097                 kfree(ec_ecdt);
1098         }
1099
1100         /* Get GPE bit assignment (EC events). */
1101         /* TODO: Add support for _GPE returning a package */
1102         status =
1103             acpi_evaluate_integer(ec->common.handle, "_GPE", NULL,
1104                                   &ec->common.gpe_bit);
1105         if (ACPI_FAILURE(status)) {
1106                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
1107                                   "Error obtaining GPE bit assignment\n"));
1108                 result = -ENODEV;
1109                 goto end;
1110         }
1111
1112         result = acpi_ec_add_fs(device);
1113         if (result)
1114                 goto end;
1115
1116         printk(KERN_INFO PREFIX "%s [%s] (gpe %d) interrupt mode.\n",
1117                acpi_device_name(device), acpi_device_bid(device),
1118                (u32) ec->common.gpe_bit);
1119
1120         if (!first_ec)
1121                 first_ec = device;
1122
1123       end:
1124         if (result)
1125                 kfree(ec);
1126
1127         return_VALUE(result);
1128 }
1129
1130 static int acpi_ec_remove(struct acpi_device *device, int type)
1131 {
1132         union acpi_ec *ec = NULL;
1133
1134         ACPI_FUNCTION_TRACE("acpi_ec_remove");
1135
1136         if (!device)
1137                 return_VALUE(-EINVAL);
1138
1139         ec = acpi_driver_data(device);
1140
1141         acpi_ec_remove_fs(device);
1142
1143         kfree(ec);
1144
1145         return_VALUE(0);
1146 }
1147
1148 static acpi_status
1149 acpi_ec_io_ports(struct acpi_resource *resource, void *context)
1150 {
1151         union acpi_ec *ec = (union acpi_ec *)context;
1152         struct acpi_generic_address *addr;
1153
1154         if (resource->type != ACPI_RESOURCE_TYPE_IO) {
1155                 return AE_OK;
1156         }
1157
1158         /*
1159          * The first address region returned is the data port, and
1160          * the second address region returned is the status/command
1161          * port.
1162          */
1163         if (ec->common.data_addr.register_bit_width == 0) {
1164                 addr = &ec->common.data_addr;
1165         } else if (ec->common.command_addr.register_bit_width == 0) {
1166                 addr = &ec->common.command_addr;
1167         } else {
1168                 return AE_CTRL_TERMINATE;
1169         }
1170
1171         addr->address_space_id = ACPI_ADR_SPACE_SYSTEM_IO;
1172         addr->register_bit_width = 8;
1173         addr->register_bit_offset = 0;
1174         addr->address = resource->data.io.minimum;
1175
1176         return AE_OK;
1177 }
1178
1179 static int acpi_ec_start(struct acpi_device *device)
1180 {
1181         acpi_status status = AE_OK;
1182         union acpi_ec *ec = NULL;
1183
1184         ACPI_FUNCTION_TRACE("acpi_ec_start");
1185
1186         if (!device)
1187                 return_VALUE(-EINVAL);
1188
1189         ec = acpi_driver_data(device);
1190
1191         if (!ec)
1192                 return_VALUE(-EINVAL);
1193
1194         /*
1195          * Get I/O port addresses. Convert to GAS format.
1196          */
1197         status = acpi_walk_resources(ec->common.handle, METHOD_NAME__CRS,
1198                                      acpi_ec_io_ports, ec);
1199         if (ACPI_FAILURE(status)
1200             || ec->common.command_addr.register_bit_width == 0) {
1201                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
1202                                   "Error getting I/O port addresses"));
1203                 return_VALUE(-ENODEV);
1204         }
1205
1206         ec->common.status_addr = ec->common.command_addr;
1207
1208         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "gpe=0x%02x, ports=0x%2x,0x%2x\n",
1209                           (u32) ec->common.gpe_bit,
1210                           (u32) ec->common.command_addr.address,
1211                           (u32) ec->common.data_addr.address));
1212
1213         /*
1214          * Install GPE handler
1215          */
1216         status = acpi_install_gpe_handler(NULL, ec->common.gpe_bit,
1217                                           ACPI_GPE_EDGE_TRIGGERED,
1218                                           &acpi_ec_gpe_handler, ec);
1219         if (ACPI_FAILURE(status)) {
1220                 return_VALUE(-ENODEV);
1221         }
1222         acpi_set_gpe_type(NULL, ec->common.gpe_bit, ACPI_GPE_TYPE_RUNTIME);
1223         acpi_enable_gpe(NULL, ec->common.gpe_bit, ACPI_NOT_ISR);
1224
1225         status = acpi_install_address_space_handler(ec->common.handle,
1226                                                     ACPI_ADR_SPACE_EC,
1227                                                     &acpi_ec_space_handler,
1228                                                     &acpi_ec_space_setup, ec);
1229         if (ACPI_FAILURE(status)) {
1230                 acpi_remove_gpe_handler(NULL, ec->common.gpe_bit,
1231                                         &acpi_ec_gpe_handler);
1232                 return_VALUE(-ENODEV);
1233         }
1234
1235         return_VALUE(AE_OK);
1236 }
1237
1238 static int acpi_ec_stop(struct acpi_device *device, int type)
1239 {
1240         acpi_status status = AE_OK;
1241         union acpi_ec *ec = NULL;
1242
1243         ACPI_FUNCTION_TRACE("acpi_ec_stop");
1244
1245         if (!device)
1246                 return_VALUE(-EINVAL);
1247
1248         ec = acpi_driver_data(device);
1249
1250         status = acpi_remove_address_space_handler(ec->common.handle,
1251                                                    ACPI_ADR_SPACE_EC,
1252                                                    &acpi_ec_space_handler);
1253         if (ACPI_FAILURE(status))
1254                 return_VALUE(-ENODEV);
1255
1256         status =
1257             acpi_remove_gpe_handler(NULL, ec->common.gpe_bit,
1258                                     &acpi_ec_gpe_handler);
1259         if (ACPI_FAILURE(status))
1260                 return_VALUE(-ENODEV);
1261
1262         return_VALUE(0);
1263 }
1264
1265 static acpi_status __init
1266 acpi_fake_ecdt_callback(acpi_handle handle,
1267                         u32 Level, void *context, void **retval)
1268 {
1269
1270         if (acpi_ec_poll_mode)
1271                 return acpi_fake_ecdt_poll_callback(handle,
1272                                                        Level, context, retval);
1273         else
1274                 return acpi_fake_ecdt_intr_callback(handle,
1275                                                      Level, context, retval);
1276 }
1277
1278 static acpi_status __init
1279 acpi_fake_ecdt_poll_callback(acpi_handle handle,
1280                                 u32 Level, void *context, void **retval)
1281 {
1282         acpi_status status;
1283
1284         status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1285                                      acpi_ec_io_ports, ec_ecdt);
1286         if (ACPI_FAILURE(status))
1287                 return status;
1288         ec_ecdt->common.status_addr = ec_ecdt->common.command_addr;
1289
1290         ec_ecdt->common.uid = -1;
1291         acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->common.uid);
1292
1293         status =
1294             acpi_evaluate_integer(handle, "_GPE", NULL,
1295                                   &ec_ecdt->common.gpe_bit);
1296         if (ACPI_FAILURE(status))
1297                 return status;
1298         spin_lock_init(&ec_ecdt->poll.lock);
1299         ec_ecdt->common.global_lock = TRUE;
1300         ec_ecdt->common.handle = handle;
1301
1302         printk(KERN_INFO PREFIX "GPE=0x%02x, ports=0x%2x, 0x%2x\n",
1303                (u32) ec_ecdt->common.gpe_bit,
1304                (u32) ec_ecdt->common.command_addr.address,
1305                (u32) ec_ecdt->common.data_addr.address);
1306
1307         return AE_CTRL_TERMINATE;
1308 }
1309
1310 static acpi_status __init
1311 acpi_fake_ecdt_intr_callback(acpi_handle handle,
1312                               u32 Level, void *context, void **retval)
1313 {
1314         acpi_status status;
1315
1316         init_MUTEX(&ec_ecdt->intr.sem);
1317         init_waitqueue_head(&ec_ecdt->intr.wait);
1318         status = acpi_walk_resources(handle, METHOD_NAME__CRS,
1319                                      acpi_ec_io_ports, ec_ecdt);
1320         if (ACPI_FAILURE(status))
1321                 return status;
1322         ec_ecdt->common.status_addr = ec_ecdt->common.command_addr;
1323
1324         ec_ecdt->common.uid = -1;
1325         acpi_evaluate_integer(handle, "_UID", NULL, &ec_ecdt->common.uid);
1326
1327         status =
1328             acpi_evaluate_integer(handle, "_GPE", NULL,
1329                                   &ec_ecdt->common.gpe_bit);
1330         if (ACPI_FAILURE(status))
1331                 return status;
1332         ec_ecdt->common.global_lock = TRUE;
1333         ec_ecdt->common.handle = handle;
1334
1335         printk(KERN_INFO PREFIX "GPE=0x%02x, ports=0x%2x, 0x%2x\n",
1336                (u32) ec_ecdt->common.gpe_bit,
1337                (u32) ec_ecdt->common.command_addr.address,
1338                (u32) ec_ecdt->common.data_addr.address);
1339
1340         return AE_CTRL_TERMINATE;
1341 }
1342
1343 /*
1344  * Some BIOS (such as some from Gateway laptops) access EC region very early
1345  * such as in BAT0._INI or EC._INI before an EC device is found and
1346  * do not provide an ECDT. According to ACPI spec, ECDT isn't mandatorily
1347  * required, but if EC regison is accessed early, it is required.
1348  * The routine tries to workaround the BIOS bug by pre-scan EC device
1349  * It assumes that _CRS, _HID, _GPE, _UID methods of EC don't touch any
1350  * op region (since _REG isn't invoked yet). The assumption is true for
1351  * all systems found.
1352  */
1353 static int __init acpi_ec_fake_ecdt(void)
1354 {
1355         acpi_status status;
1356         int ret = 0;
1357
1358         printk(KERN_INFO PREFIX "Try to make an fake ECDT\n");
1359
1360         ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1361         if (!ec_ecdt) {
1362                 ret = -ENOMEM;
1363                 goto error;
1364         }
1365         memset(ec_ecdt, 0, sizeof(union acpi_ec));
1366
1367         status = acpi_get_devices(ACPI_EC_HID,
1368                                   acpi_fake_ecdt_callback, NULL, NULL);
1369         if (ACPI_FAILURE(status)) {
1370                 kfree(ec_ecdt);
1371                 ec_ecdt = NULL;
1372                 ret = -ENODEV;
1373                 goto error;
1374         }
1375         return 0;
1376       error:
1377         printk(KERN_ERR PREFIX "Can't make an fake ECDT\n");
1378         return ret;
1379 }
1380
1381 static int __init acpi_ec_get_real_ecdt(void)
1382 {
1383         if (acpi_ec_poll_mode)
1384                 return acpi_ec_poll_get_real_ecdt();
1385         else
1386                 return acpi_ec_intr_get_real_ecdt();
1387 }
1388
1389 static int __init acpi_ec_poll_get_real_ecdt(void)
1390 {
1391         acpi_status status;
1392         struct acpi_table_ecdt *ecdt_ptr;
1393
1394         status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
1395                                          (struct acpi_table_header **)
1396                                          &ecdt_ptr);
1397         if (ACPI_FAILURE(status))
1398                 return -ENODEV;
1399
1400         printk(KERN_INFO PREFIX "Found ECDT\n");
1401
1402         /*
1403          * Generate a temporary ec context to use until the namespace is scanned
1404          */
1405         ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1406         if (!ec_ecdt)
1407                 return -ENOMEM;
1408         memset(ec_ecdt, 0, sizeof(union acpi_ec));
1409
1410         ec_ecdt->common.command_addr = ecdt_ptr->ec_control;
1411         ec_ecdt->common.status_addr = ecdt_ptr->ec_control;
1412         ec_ecdt->common.data_addr = ecdt_ptr->ec_data;
1413         ec_ecdt->common.gpe_bit = ecdt_ptr->gpe_bit;
1414         spin_lock_init(&ec_ecdt->poll.lock);
1415         /* use the GL just to be safe */
1416         ec_ecdt->common.global_lock = TRUE;
1417         ec_ecdt->common.uid = ecdt_ptr->uid;
1418
1419         status =
1420             acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->common.handle);
1421         if (ACPI_FAILURE(status)) {
1422                 goto error;
1423         }
1424
1425         return 0;
1426       error:
1427         printk(KERN_ERR PREFIX "Could not use ECDT\n");
1428         kfree(ec_ecdt);
1429         ec_ecdt = NULL;
1430
1431         return -ENODEV;
1432 }
1433
1434 static int __init acpi_ec_intr_get_real_ecdt(void)
1435 {
1436         acpi_status status;
1437         struct acpi_table_ecdt *ecdt_ptr;
1438
1439         status = acpi_get_firmware_table("ECDT", 1, ACPI_LOGICAL_ADDRESSING,
1440                                          (struct acpi_table_header **)
1441                                          &ecdt_ptr);
1442         if (ACPI_FAILURE(status))
1443                 return -ENODEV;
1444
1445         printk(KERN_INFO PREFIX "Found ECDT\n");
1446
1447         /*
1448          * Generate a temporary ec context to use until the namespace is scanned
1449          */
1450         ec_ecdt = kmalloc(sizeof(union acpi_ec), GFP_KERNEL);
1451         if (!ec_ecdt)
1452                 return -ENOMEM;
1453         memset(ec_ecdt, 0, sizeof(union acpi_ec));
1454
1455         init_MUTEX(&ec_ecdt->intr.sem);
1456         init_waitqueue_head(&ec_ecdt->intr.wait);
1457         ec_ecdt->common.command_addr = ecdt_ptr->ec_control;
1458         ec_ecdt->common.status_addr = ecdt_ptr->ec_control;
1459         ec_ecdt->common.data_addr = ecdt_ptr->ec_data;
1460         ec_ecdt->common.gpe_bit = ecdt_ptr->gpe_bit;
1461         /* use the GL just to be safe */
1462         ec_ecdt->common.global_lock = TRUE;
1463         ec_ecdt->common.uid = ecdt_ptr->uid;
1464
1465         status =
1466             acpi_get_handle(NULL, ecdt_ptr->ec_id, &ec_ecdt->common.handle);
1467         if (ACPI_FAILURE(status)) {
1468                 goto error;
1469         }
1470
1471         return 0;
1472       error:
1473         printk(KERN_ERR PREFIX "Could not use ECDT\n");
1474         kfree(ec_ecdt);
1475         ec_ecdt = NULL;
1476
1477         return -ENODEV;
1478 }
1479
1480 static int __initdata acpi_fake_ecdt_enabled;
1481 int __init acpi_ec_ecdt_probe(void)
1482 {
1483         acpi_status status;
1484         int ret;
1485
1486         ret = acpi_ec_get_real_ecdt();
1487         /* Try to make a fake ECDT */
1488         if (ret && acpi_fake_ecdt_enabled) {
1489                 ret = acpi_ec_fake_ecdt();
1490         }
1491
1492         if (ret)
1493                 return 0;
1494
1495         /*
1496          * Install GPE handler
1497          */
1498         status = acpi_install_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1499                                           ACPI_GPE_EDGE_TRIGGERED,
1500                                           &acpi_ec_gpe_handler, ec_ecdt);
1501         if (ACPI_FAILURE(status)) {
1502                 goto error;
1503         }
1504         acpi_set_gpe_type(NULL, ec_ecdt->common.gpe_bit, ACPI_GPE_TYPE_RUNTIME);
1505         acpi_enable_gpe(NULL, ec_ecdt->common.gpe_bit, ACPI_NOT_ISR);
1506
1507         status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT,
1508                                                     ACPI_ADR_SPACE_EC,
1509                                                     &acpi_ec_space_handler,
1510                                                     &acpi_ec_space_setup,
1511                                                     ec_ecdt);
1512         if (ACPI_FAILURE(status)) {
1513                 acpi_remove_gpe_handler(NULL, ec_ecdt->common.gpe_bit,
1514                                         &acpi_ec_gpe_handler);
1515                 goto error;
1516         }
1517
1518         return 0;
1519
1520       error:
1521         printk(KERN_ERR PREFIX "Could not use ECDT\n");
1522         kfree(ec_ecdt);
1523         ec_ecdt = NULL;
1524
1525         return -ENODEV;
1526 }
1527
1528 static int __init acpi_ec_init(void)
1529 {
1530         int result = 0;
1531
1532         ACPI_FUNCTION_TRACE("acpi_ec_init");
1533
1534         if (acpi_disabled)
1535                 return_VALUE(0);
1536
1537         acpi_ec_dir = proc_mkdir(ACPI_EC_CLASS, acpi_root_dir);
1538         if (!acpi_ec_dir)
1539                 return_VALUE(-ENODEV);
1540
1541         /* Now register the driver for the EC */
1542         result = acpi_bus_register_driver(&acpi_ec_driver);
1543         if (result < 0) {
1544                 remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1545                 return_VALUE(-ENODEV);
1546         }
1547
1548         return_VALUE(result);
1549 }
1550
1551 subsys_initcall(acpi_ec_init);
1552
1553 /* EC driver currently not unloadable */
1554 #if 0
1555 static void __exit acpi_ec_exit(void)
1556 {
1557         ACPI_FUNCTION_TRACE("acpi_ec_exit");
1558
1559         acpi_bus_unregister_driver(&acpi_ec_driver);
1560
1561         remove_proc_entry(ACPI_EC_CLASS, acpi_root_dir);
1562
1563         return_VOID;
1564 }
1565 #endif                          /* 0 */
1566
1567 static int __init acpi_fake_ecdt_setup(char *str)
1568 {
1569         acpi_fake_ecdt_enabled = 1;
1570         return 1;
1571 }
1572
1573 __setup("acpi_fake_ecdt", acpi_fake_ecdt_setup);
1574 static int __init acpi_ec_set_intr_mode(char *str)
1575 {
1576         int intr;
1577
1578         if (!get_option(&str, &intr))
1579                 return 0;
1580
1581         if (intr) {
1582                 acpi_ec_poll_mode = EC_INTR;
1583                 acpi_ec_driver.ops.add = acpi_ec_intr_add;
1584         } else {
1585                 acpi_ec_poll_mode = EC_POLL;
1586                 acpi_ec_driver.ops.add = acpi_ec_poll_add;
1587         }
1588         printk(KERN_INFO PREFIX "EC %s mode.\n", intr ? "interrupt" : "polling");
1589         return 1;
1590 }
1591
1592 __setup("ec_intr=", acpi_ec_set_intr_mode);