drivers/ata/libata-acpi.c

   1 /*
   2  * libata-acpi.c
   3  * Provides ACPI support for PATA/SATA.
   4  *
   5  * Copyright (C) 2006 Intel Corp.
   6  * Copyright (C) 2006 Randy Dunlap
   7  */
   8
   9 #include <linux/module.h>
  10 #include <linux/ata.h>
  11 #include <linux/delay.h>
  12 #include <linux/device.h>
  13 #include <linux/errno.h>
  14 #include <linux/kernel.h>
  15 #include <linux/acpi.h>
  16 #include <linux/libata.h>
  17 #include <linux/pci.h>
  18 #include <scsi/scsi_device.h>
  19 #include "libata.h"
  20
  21 #include <acpi/acpi_bus.h>
  22 #include <acpi/acnames.h>
  23 #include <acpi/acnamesp.h>
  24 #include <acpi/acparser.h>
  25 #include <acpi/acexcep.h>
  26 #include <acpi/acmacros.h>
  27 #include <acpi/actypes.h>
  28
  29 enum {
  30         ATA_ACPI_FILTER_SETXFER = 1 << 0,
  31         ATA_ACPI_FILTER_LOCK    = 1 << 1,
  32         ATA_ACPI_FILTER_DIPM    = 1 << 2,
  33
  34         ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
  35                                   ATA_ACPI_FILTER_LOCK |
  36                                   ATA_ACPI_FILTER_DIPM,
  37 };
  38
  39 static unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
  40 module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
  41 MODULE_PARM_DESC(acpi_gtf_filter, "filter mask for ACPI _GTF commands, set to filter out (0x1=set xfermode, 0x2=lock/freeze lock, 0x4=DIPM)");
  42
  43 #define NO_PORT_MULT            0xffff
  44 #define SATA_ADR(root, pmp)     (((root) << 16) | (pmp))
  45
  46 #define REGS_PER_GTF            7
  47 struct ata_acpi_gtf {
  48         u8      tf[REGS_PER_GTF];       /* regs. 0x1f1 - 0x1f7 */
  49 } __packed;
  50
  51 /*
  52  *      Helper - belongs in the PCI layer somewhere eventually
  53  */
  54 static int is_pci_dev(struct device *dev)
  55 {
  56         return (dev->bus == &pci_bus_type);
  57 }
  58
  59 static void ata_acpi_clear_gtf(struct ata_device *dev)
  60 {
  61         kfree(dev->gtf_cache);
  62         dev->gtf_cache = NULL;
  63 }
  64
  65 /**
  66  * ata_acpi_associate_sata_port - associate SATA port with ACPI objects
  67  * @ap: target SATA port
  68  *
  69  * Look up ACPI objects associated with @ap and initialize acpi_handle
  70  * fields of @ap, the port and devices accordingly.
  71  *
  72  * LOCKING:
  73  * EH context.
  74  *
  75  * RETURNS:
  76  * 0 on success, -errno on failure.
  77  */
  78 void ata_acpi_associate_sata_port(struct ata_port *ap)
  79 {
  80         WARN_ON(!(ap->flags & ATA_FLAG_ACPI_SATA));
  81
  82         if (!sata_pmp_attached(ap)) {
  83                 acpi_integer adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
  84
  85                 ap->link.device->acpi_handle =
  86                         acpi_get_child(ap->host->acpi_handle, adr);
  87         } else {
  88                 struct ata_link *link;
  89
  90                 ap->link.device->acpi_handle = NULL;
  91
  92                 ata_port_for_each_link(link, ap) {
  93                         acpi_integer adr = SATA_ADR(ap->port_no, link->pmp);
  94
  95                         link->device->acpi_handle =
  96                                 acpi_get_child(ap->host->acpi_handle, adr);
  97                 }
  98         }
  99 }
 100
 101 static void ata_acpi_associate_ide_port(struct ata_port *ap)
 102 {
 103         int max_devices, i;
 104
 105         ap->acpi_handle = acpi_get_child(ap->host->acpi_handle, ap->port_no);
 106         if (!ap->acpi_handle)
 107                 return;
 108
 109         max_devices = 1;
 110         if (ap->flags & ATA_FLAG_SLAVE_POSS)
 111                 max_devices++;
 112
 113         for (i = 0; i < max_devices; i++) {
 114                 struct ata_device *dev = &ap->link.device[i];
 115
 116                 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
 117         }
 118
 119         if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
 120                 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
 121 }
 122
 123 /* @ap and @dev are the same as ata_acpi_handle_hotplug() */
 124 static void ata_acpi_detach_device(struct ata_port *ap, struct ata_device *dev)
 125 {
 126         if (dev)
 127                 dev->flags |= ATA_DFLAG_DETACH;
 128         else {
 129                 struct ata_link *tlink;
 130                 struct ata_device *tdev;
 131
 132                 ata_port_for_each_link(tlink, ap)
 133                         ata_link_for_each_dev(tdev, tlink)
 134                                 tdev->flags |= ATA_DFLAG_DETACH;
 135         }
 136
 137         ata_port_schedule_eh(ap);
 138 }
 139
 140 /**
 141  * ata_acpi_handle_hotplug - ACPI event handler backend
 142  * @ap: ATA port ACPI event occurred
 143  * @dev: ATA device ACPI event occurred (can be NULL)
 144  * @event: ACPI event which occurred
 145  *
 146  * All ACPI bay / device realted events end up in this function.  If
 147  * the event is port-wide @dev is NULL.  If the event is specific to a
 148  * device, @dev points to it.
 149  *
 150  * Hotplug (as opposed to unplug) notification is always handled as
 151  * port-wide while unplug only kills the target device on device-wide
 152  * event.
 153  *
 154  * LOCKING:
 155  * ACPI notify handler context.  May sleep.
 156  */
 157 static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
 158                                     u32 event)
 159 {
 160         struct ata_eh_info *ehi = &ap->link.eh_info;
 161         int wait = 0;
 162         unsigned long flags;
 163         acpi_handle handle;
 164
 165         if (dev)
 166                 handle = dev->acpi_handle;
 167         else
 168                 handle = ap->acpi_handle;
 169
 170         spin_lock_irqsave(ap->lock, flags);
 171         /*
 172          * When dock driver calls into the routine, it will always use
 173          * ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
 174          * ACPI_NOTIFY_EJECT_REQUEST for remove
 175          */
 176         switch (event) {
 177         case ACPI_NOTIFY_BUS_CHECK:
 178         case ACPI_NOTIFY_DEVICE_CHECK:
 179                 ata_ehi_push_desc(ehi, "ACPI event");
 180
 181                 ata_ehi_hotplugged(ehi);
 182                 ata_port_freeze(ap);
 183                 break;
 184         case ACPI_NOTIFY_EJECT_REQUEST:
 185                 ata_ehi_push_desc(ehi, "ACPI event");
 186
 187                 ata_acpi_detach_device(ap, dev);
 188                 wait = 1;
 189                 break;
 190         }
 191
 192         spin_unlock_irqrestore(ap->lock, flags);
 193
 194         if (wait)
 195                 ata_port_wait_eh(ap);
 196 }
 197
 198 static void ata_acpi_dev_notify_dock(acpi_handle handle, u32 event, void *data)
 199 {
 200         struct ata_device *dev = data;
 201
 202         ata_acpi_handle_hotplug(dev->link->ap, dev, event);
 203 }
 204
 205 static void ata_acpi_ap_notify_dock(acpi_handle handle, u32 event, void *data)
 206 {
 207         struct ata_port *ap = data;
 208
 209         ata_acpi_handle_hotplug(ap, NULL, event);
 210 }
 211
 212 /**
 213  * ata_acpi_associate - associate ATA host with ACPI objects
 214  * @host: target ATA host
 215  *
 216  * Look up ACPI objects associated with @host and initialize
 217  * acpi_handle fields of @host, its ports and devices accordingly.
 218  *
 219  * LOCKING:
 220  * EH context.
 221  *
 222  * RETURNS:
 223  * 0 on success, -errno on failure.
 224  */
 225 void ata_acpi_associate(struct ata_host *host)
 226 {
 227         int i, j;
 228
 229         if (!is_pci_dev(host->dev) || libata_noacpi)
 230                 return;
 231
 232         host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
 233         if (!host->acpi_handle)
 234                 return;
 235
 236         for (i = 0; i < host->n_ports; i++) {
 237                 struct ata_port *ap = host->ports[i];
 238
 239                 if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
 240                         ata_acpi_associate_sata_port(ap);
 241                 else
 242                         ata_acpi_associate_ide_port(ap);
 243
 244                 if (ap->acpi_handle) {
 245                         /* we might be on a docking station */
 246                         register_hotplug_dock_device(ap->acpi_handle,
 247                                              ata_acpi_ap_notify_dock, ap);
 248                 }
 249
 250                 for (j = 0; j < ata_link_max_devices(&ap->link); j++) {
 251                         struct ata_device *dev = &ap->link.device[j];
 252
 253                         if (dev->acpi_handle) {
 254                                 /* we might be on a docking station */
 255                                 register_hotplug_dock_device(dev->acpi_handle,
 256                                              ata_acpi_dev_notify_dock, dev);
 257                         }
 258                 }
 259         }
 260 }
 261
 262 /**
 263  * ata_acpi_dissociate - dissociate ATA host from ACPI objects
 264  * @host: target ATA host
 265  *
 266  * This function is called during driver detach after the whole host
 267  * is shut down.
 268  *
 269  * LOCKING:
 270  * EH context.
 271  */
 272 void ata_acpi_dissociate(struct ata_host *host)
 273 {
 274         int i;
 275
 276         /* Restore initial _GTM values so that driver which attaches
 277          * afterward can use them too.
 278          */
 279         for (i = 0; i < host->n_ports; i++) {
 280                 struct ata_port *ap = host->ports[i];
 281                 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
 282
 283                 if (ap->acpi_handle && gtm)
 284                         ata_acpi_stm(ap, gtm);
 285         }
 286 }
 287
 288 /**
 289  * ata_acpi_gtm - execute _GTM
 290  * @ap: target ATA port
 291  * @gtm: out parameter for _GTM result
 292  *
 293  * Evaluate _GTM and store the result in @gtm.
 294  *
 295  * LOCKING:
 296  * EH context.
 297  *
 298  * RETURNS:
 299  * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
 300  */
 301 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
 302 {
 303         struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
 304         union acpi_object *out_obj;
 305         acpi_status status;
 306         int rc = 0;
 307
 308         status = acpi_evaluate_object(ap->acpi_handle, "_GTM", NULL, &output);
 309
 310         rc = -ENOENT;
 311         if (status == AE_NOT_FOUND)
 312                 goto out_free;
 313
 314         rc = -EINVAL;
 315         if (ACPI_FAILURE(status)) {
 316                 ata_port_printk(ap, KERN_ERR,
 317                                 "ACPI get timing mode failed (AE 0x%x)\n",
 318                                 status);
 319                 goto out_free;
 320         }
 321
 322         out_obj = output.pointer;
 323         if (out_obj->type != ACPI_TYPE_BUFFER) {
 324                 ata_port_printk(ap, KERN_WARNING,
 325                                 "_GTM returned unexpected object type 0x%x\n",
 326                                 out_obj->type);
 327
 328                 goto out_free;
 329         }
 330
 331         if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
 332                 ata_port_printk(ap, KERN_ERR,
 333                                 "_GTM returned invalid length %d\n",
 334                                 out_obj->buffer.length);
 335                 goto out_free;
 336         }
 337
 338         memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
 339         rc = 0;
 340  out_free:
 341         kfree(output.pointer);
 342         return rc;
 343 }
 344
 345 EXPORT_SYMBOL_GPL(ata_acpi_gtm);
 346
 347 /**
 348  * ata_acpi_stm - execute _STM
 349  * @ap: target ATA port
 350  * @stm: timing parameter to _STM
 351  *
 352  * Evaluate _STM with timing parameter @stm.
 353  *
 354  * LOCKING:
 355  * EH context.
 356  *
 357  * RETURNS:
 358  * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
 359  */
 360 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
 361 {
 362         acpi_status status;
 363         struct ata_acpi_gtm             stm_buf = *stm;
 364         struct acpi_object_list         input;
 365         union acpi_object               in_params[3];
 366
 367         in_params[0].type = ACPI_TYPE_BUFFER;
 368         in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
 369         in_params[0].buffer.pointer = (u8 *)&stm_buf;
 370         /* Buffers for id may need byteswapping ? */
 371         in_params[1].type = ACPI_TYPE_BUFFER;
 372         in_params[1].buffer.length = 512;
 373         in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
 374         in_params[2].type = ACPI_TYPE_BUFFER;
 375         in_params[2].buffer.length = 512;
 376         in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
 377
 378         input.count = 3;
 379         input.pointer = in_params;
 380
 381         status = acpi_evaluate_object(ap->acpi_handle, "_STM", &input, NULL);
 382
 383         if (status == AE_NOT_FOUND)
 384                 return -ENOENT;
 385         if (ACPI_FAILURE(status)) {
 386                 ata_port_printk(ap, KERN_ERR,
 387                         "ACPI set timing mode failed (status=0x%x)\n", status);
 388                 return -EINVAL;
 389         }
 390         return 0;
 391 }
 392
 393 EXPORT_SYMBOL_GPL(ata_acpi_stm);
 394
 395 /**
 396  * ata_dev_get_GTF - get the drive bootup default taskfile settings
 397  * @dev: target ATA device
 398  * @gtf: output parameter for buffer containing _GTF taskfile arrays
 399  *
 400  * This applies to both PATA and SATA drives.
 401  *
 402  * The _GTF method has no input parameters.
 403  * It returns a variable number of register set values (registers
 404  * hex 1F1..1F7, taskfiles).
 405  * The <variable number> is not known in advance, so have ACPI-CA
 406  * allocate the buffer as needed and return it, then free it later.
 407  *
 408  * LOCKING:
 409  * EH context.
 410  *
 411  * RETURNS:
 412  * Number of taskfiles on success, 0 if _GTF doesn't exist.  -EINVAL
 413  * if _GTF is invalid.
 414  */
 415 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
 416 {
 417         struct ata_port *ap = dev->link->ap;
 418         acpi_status status;
 419         struct acpi_buffer output;
 420         union acpi_object *out_obj;
 421         int rc = 0;
 422
 423         /* if _GTF is cached, use the cached value */
 424         if (dev->gtf_cache) {
 425                 out_obj = dev->gtf_cache;
 426                 goto done;
 427         }
 428
 429         /* set up output buffer */
 430         output.length = ACPI_ALLOCATE_BUFFER;
 431         output.pointer = NULL;  /* ACPI-CA sets this; save/free it later */
 432
 433         if (ata_msg_probe(ap))
 434                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
 435                                __func__, ap->port_no);
 436
 437         /* _GTF has no input parameters */
 438         status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
 439         out_obj = dev->gtf_cache = output.pointer;
 440
 441         if (ACPI_FAILURE(status)) {
 442                 if (status != AE_NOT_FOUND) {
 443                         ata_dev_printk(dev, KERN_WARNING,
 444                                        "_GTF evaluation failed (AE 0x%x)\n",
 445                                        status);
 446                         rc = -EINVAL;
 447                 }
 448                 goto out_free;
 449         }
 450
 451         if (!output.length || !output.pointer) {
 452                 if (ata_msg_probe(ap))
 453                         ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
 454                                 "length or ptr is NULL (0x%llx, 0x%p)\n",
 455                                 __func__,
 456                                 (unsigned long long)output.length,
 457                                 output.pointer);
 458                 rc = -EINVAL;
 459                 goto out_free;
 460         }
 461
 462         if (out_obj->type != ACPI_TYPE_BUFFER) {
 463                 ata_dev_printk(dev, KERN_WARNING,
 464                                "_GTF unexpected object type 0x%x\n",
 465                                out_obj->type);
 466                 rc = -EINVAL;
 467                 goto out_free;
 468         }
 469
 470         if (out_obj->buffer.length % REGS_PER_GTF) {
 471                 ata_dev_printk(dev, KERN_WARNING,
 472                                "unexpected _GTF length (%d)\n",
 473                                out_obj->buffer.length);
 474                 rc = -EINVAL;
 475                 goto out_free;
 476         }
 477
 478  done:
 479         rc = out_obj->buffer.length / REGS_PER_GTF;
 480         if (gtf) {
 481                 *gtf = (void *)out_obj->buffer.pointer;
 482                 if (ata_msg_probe(ap))
 483                         ata_dev_printk(dev, KERN_DEBUG,
 484                                        "%s: returning gtf=%p, gtf_count=%d\n",
 485                                        __func__, *gtf, rc);
 486         }
 487         return rc;
 488
 489  out_free:
 490         ata_acpi_clear_gtf(dev);
 491         return rc;
 492 }
 493
 494 /**
 495  * ata_acpi_gtm_xfermode - determine xfermode from GTM parameter
 496  * @dev: target device
 497  * @gtm: GTM parameter to use
 498  *
 499  * Determine xfermask for @dev from @gtm.
 500  *
 501  * LOCKING:
 502  * None.
 503  *
 504  * RETURNS:
 505  * Determined xfermask.
 506  */
 507 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
 508                                     const struct ata_acpi_gtm *gtm)
 509 {
 510         unsigned long xfer_mask = 0;
 511         unsigned int type;
 512         int unit;
 513         u8 mode;
 514
 515         /* we always use the 0 slot for crap hardware */
 516         unit = dev->devno;
 517         if (!(gtm->flags & 0x10))
 518                 unit = 0;
 519
 520         /* PIO */
 521         mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
 522         xfer_mask |= ata_xfer_mode2mask(mode);
 523
 524         /* See if we have MWDMA or UDMA data. We don't bother with
 525          * MWDMA if UDMA is available as this means the BIOS set UDMA
 526          * and our error changedown if it works is UDMA to PIO anyway.
 527          */
 528         if (!(gtm->flags & (1 << (2 * unit))))
 529                 type = ATA_SHIFT_MWDMA;
 530         else
 531                 type = ATA_SHIFT_UDMA;
 532
 533         mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
 534         xfer_mask |= ata_xfer_mode2mask(mode);
 535
 536         return xfer_mask;
 537 }
 538 EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
 539
 540 /**
 541  * ata_acpi_cbl_80wire          -       Check for 80 wire cable
 542  * @ap: Port to check
 543  * @gtm: GTM data to use
 544  *
 545  * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
 546  */
 547 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
 548 {
 549         struct ata_device *dev;
 550
 551         ata_link_for_each_dev(dev, &ap->link) {
 552                 unsigned long xfer_mask, udma_mask;
 553
 554                 if (!ata_dev_enabled(dev))
 555                         continue;
 556
 557                 xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
 558                 ata_unpack_xfermask(xfer_mask, NULL, NULL, &udma_mask);
 559
 560                 if (udma_mask & ~ATA_UDMA_MASK_40C)
 561                         return 1;
 562         }
 563
 564         return 0;
 565 }
 566 EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
 567
 568 static void ata_acpi_gtf_to_tf(struct ata_device *dev,
 569                                const struct ata_acpi_gtf *gtf,
 570                                struct ata_taskfile *tf)
 571 {
 572         ata_tf_init(dev, tf);
 573
 574         tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
 575         tf->protocol = ATA_PROT_NODATA;
 576         tf->feature = gtf->tf[0];       /* 0x1f1 */
 577         tf->nsect   = gtf->tf[1];       /* 0x1f2 */
 578         tf->lbal    = gtf->tf[2];       /* 0x1f3 */
 579         tf->lbam    = gtf->tf[3];       /* 0x1f4 */
 580         tf->lbah    = gtf->tf[4];       /* 0x1f5 */
 581         tf->device  = gtf->tf[5];       /* 0x1f6 */
 582         tf->command = gtf->tf[6];       /* 0x1f7 */
 583 }
 584
 585 static int ata_acpi_filter_tf(const struct ata_taskfile *tf,
 586                               const struct ata_taskfile *ptf)
 587 {
 588         if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_SETXFER) {
 589                 /* libata doesn't use ACPI to configure transfer mode.
 590                  * It will only confuse device configuration.  Skip.
 591                  */
 592                 if (tf->command == ATA_CMD_SET_FEATURES &&
 593                     tf->feature == SETFEATURES_XFER)
 594                         return 1;
 595         }
 596
 597         if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_LOCK) {
 598                 /* BIOS writers, sorry but we don't wanna lock
 599                  * features unless the user explicitly said so.
 600                  */
 601
 602                 /* DEVICE CONFIGURATION FREEZE LOCK */
 603                 if (tf->command == ATA_CMD_CONF_OVERLAY &&
 604                     tf->feature == ATA_DCO_FREEZE_LOCK)
 605                         return 1;
 606
 607                 /* SECURITY FREEZE LOCK */
 608                 if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
 609                         return 1;
 610
 611                 /* SET MAX LOCK and SET MAX FREEZE LOCK */
 612                 if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
 613                     tf->command == ATA_CMD_SET_MAX &&
 614                     (tf->feature == ATA_SET_MAX_LOCK ||
 615                      tf->feature == ATA_SET_MAX_FREEZE_LOCK))
 616                         return 1;
 617         }
 618
 619         if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_DIPM) {
 620                 /* inhibit enabling DIPM */
 621                 if (tf->command == ATA_CMD_SET_FEATURES &&
 622                     tf->feature == SETFEATURES_SATA_ENABLE &&
 623                     tf->nsect == SATA_DIPM)
 624                         return 1;
 625         }
 626
 627         return 0;
 628 }
 629
 630 /**
 631  * ata_acpi_run_tf - send taskfile registers to host controller
 632  * @dev: target ATA device
 633  * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
 634  *
 635  * Outputs ATA taskfile to standard ATA host controller using MMIO
 636  * or PIO as indicated by the ATA_FLAG_MMIO flag.
 637  * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
 638  * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
 639  * hob_lbal, hob_lbam, and hob_lbah.
 640  *
 641  * This function waits for idle (!BUSY and !DRQ) after writing
 642  * registers.  If the control register has a new value, this
 643  * function also waits for idle after writing control and before
 644  * writing the remaining registers.
 645  *
 646  * LOCKING:
 647  * EH context.
 648  *
 649  * RETURNS:
 650  * 1 if command is executed successfully.  0 if ignored, rejected or
 651  * filtered out, -errno on other errors.
 652  */
 653 static int ata_acpi_run_tf(struct ata_device *dev,
 654                            const struct ata_acpi_gtf *gtf,
 655                            const struct ata_acpi_gtf *prev_gtf)
 656 {
 657         struct ata_taskfile *pptf = NULL;
 658         struct ata_taskfile tf, ptf, rtf;
 659         unsigned int err_mask;
 660         const char *level;
 661         char msg[60];
 662         int rc;
 663
 664         if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
 665             && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
 666             && (gtf->tf[6] == 0))
 667                 return 0;
 668
 669         ata_acpi_gtf_to_tf(dev, gtf, &tf);
 670         if (prev_gtf) {
 671                 ata_acpi_gtf_to_tf(dev, prev_gtf, &ptf);
 672                 pptf = &ptf;
 673         }
 674
 675         if (!ata_acpi_filter_tf(&tf, pptf)) {
 676                 rtf = tf;
 677                 err_mask = ata_exec_internal(dev, &rtf, NULL,
 678                                              DMA_NONE, NULL, 0, 0);
 679
 680                 switch (err_mask) {
 681                 case 0:
 682                         level = KERN_DEBUG;
 683                         snprintf(msg, sizeof(msg), "succeeded");
 684                         rc = 1;
 685                         break;
 686
 687                 case AC_ERR_DEV:
 688                         level = KERN_INFO;
 689                         snprintf(msg, sizeof(msg),
 690                                  "rejected by device (Stat=0x%02x Err=0x%02x)",
 691                                  rtf.command, rtf.feature);
 692                         rc = 0;
 693                         break;
 694
 695                 default:
 696                         level = KERN_ERR;
 697                         snprintf(msg, sizeof(msg),
 698                                  "failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
 699                                  err_mask, rtf.command, rtf.feature);
 700                         rc = -EIO;
 701                         break;
 702                 }
 703         } else {
 704                 level = KERN_INFO;
 705                 snprintf(msg, sizeof(msg), "filtered out");
 706                 rc = 0;
 707         }
 708
 709         ata_dev_printk(dev, level,
 710                        "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x %s\n",
 711                        tf.command, tf.feature, tf.nsect, tf.lbal,
 712                        tf.lbam, tf.lbah, tf.device, msg);
 713
 714         return rc;
 715 }
 716
 717 /**
 718  * ata_acpi_exec_tfs - get then write drive taskfile settings
 719  * @dev: target ATA device
 720  * @nr_executed: out paramter for the number of executed commands
 721  *
 722  * Evaluate _GTF and excute returned taskfiles.
 723  *
 724  * LOCKING:
 725  * EH context.
 726  *
 727  * RETURNS:
 728  * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
 729  * -errno on other errors.
 730  */
 731 static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
 732 {
 733         struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
 734         int gtf_count, i, rc;
 735
 736         /* get taskfiles */
 737         rc = ata_dev_get_GTF(dev, &gtf);
 738         if (rc < 0)
 739                 return rc;
 740         gtf_count = rc;
 741
 742         /* execute them */
 743         for (i = 0; i < gtf_count; i++, gtf++) {
 744                 rc = ata_acpi_run_tf(dev, gtf, pgtf);
 745                 if (rc < 0)
 746                         break;
 747                 if (rc) {
 748                         (*nr_executed)++;
 749                         pgtf = gtf;
 750                 }
 751         }
 752
 753         ata_acpi_clear_gtf(dev);
 754
 755         if (rc < 0)
 756                 return rc;
 757         return 0;
 758 }
 759
 760 /**
 761  * ata_acpi_push_id - send Identify data to drive
 762  * @dev: target ATA device
 763  *
 764  * _SDD ACPI object: for SATA mode only
 765  * Must be after Identify (Packet) Device -- uses its data
 766  * ATM this function never returns a failure.  It is an optional
 767  * method and if it fails for whatever reason, we should still
 768  * just keep going.
 769  *
 770  * LOCKING:
 771  * EH context.
 772  *
 773  * RETURNS:
 774  * 0 on success, -errno on failure.
 775  */
 776 static int ata_acpi_push_id(struct ata_device *dev)
 777 {
 778         struct ata_port *ap = dev->link->ap;
 779         int err;
 780         acpi_status status;
 781         struct acpi_object_list input;
 782         union acpi_object in_params[1];
 783
 784         if (ata_msg_probe(ap))
 785                 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
 786                                __func__, dev->devno, ap->port_no);
 787
 788         /* Give the drive Identify data to the drive via the _SDD method */
 789         /* _SDD: set up input parameters */
 790         input.count = 1;
 791         input.pointer = in_params;
 792         in_params[0].type = ACPI_TYPE_BUFFER;
 793         in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
 794         in_params[0].buffer.pointer = (u8 *)dev->id;
 795         /* Output buffer: _SDD has no output */
 796
 797         /* It's OK for _SDD to be missing too. */
 798         swap_buf_le16(dev->id, ATA_ID_WORDS);
 799         status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
 800         swap_buf_le16(dev->id, ATA_ID_WORDS);
 801
 802         err = ACPI_FAILURE(status) ? -EIO : 0;
 803         if (err < 0)
 804                 ata_dev_printk(dev, KERN_WARNING,
 805                                "ACPI _SDD failed (AE 0x%x)\n", status);
 806
 807         return err;
 808 }
 809
 810 /**
 811  * ata_acpi_on_suspend - ATA ACPI hook called on suspend
 812  * @ap: target ATA port
 813  *
 814  * This function is called when @ap is about to be suspended.  All
 815  * devices are already put to sleep but the port_suspend() callback
 816  * hasn't been executed yet.  Error return from this function aborts
 817  * suspend.
 818  *
 819  * LOCKING:
 820  * EH context.
 821  *
 822  * RETURNS:
 823  * 0 on success, -errno on failure.
 824  */
 825 int ata_acpi_on_suspend(struct ata_port *ap)
 826 {
 827         /* nada */
 828         return 0;
 829 }
 830
 831 /**
 832  * ata_acpi_on_resume - ATA ACPI hook called on resume
 833  * @ap: target ATA port
 834  *
 835  * This function is called when @ap is resumed - right after port
 836  * itself is resumed but before any EH action is taken.
 837  *
 838  * LOCKING:
 839  * EH context.
 840  */
 841 void ata_acpi_on_resume(struct ata_port *ap)
 842 {
 843         const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
 844         struct ata_device *dev;
 845
 846         if (ap->acpi_handle && gtm) {
 847                 /* _GTM valid */
 848
 849                 /* restore timing parameters */
 850                 ata_acpi_stm(ap, gtm);
 851
 852                 /* _GTF should immediately follow _STM so that it can
 853                  * use values set by _STM.  Cache _GTF result and
 854                  * schedule _GTF.
 855                  */
 856                 ata_link_for_each_dev(dev, &ap->link) {
 857                         ata_acpi_clear_gtf(dev);
 858                         if (ata_dev_enabled(dev) &&
 859                             ata_dev_get_GTF(dev, NULL) >= 0)
 860                                 dev->flags |= ATA_DFLAG_ACPI_PENDING;
 861                 }
 862         } else {
 863                 /* SATA _GTF needs to be evaulated after _SDD and
 864                  * there's no reason to evaluate IDE _GTF early
 865                  * without _STM.  Clear cache and schedule _GTF.
 866                  */
 867                 ata_link_for_each_dev(dev, &ap->link) {
 868                         ata_acpi_clear_gtf(dev);
 869                         if (ata_dev_enabled(dev))
 870                                 dev->flags |= ATA_DFLAG_ACPI_PENDING;
 871                 }
 872         }
 873 }
 874
 875 /**
 876  * ata_acpi_set_state - set the port power state
 877  * @ap: target ATA port
 878  * @state: state, on/off
 879  *
 880  * This function executes the _PS0/_PS3 ACPI method to set the power state.
 881  * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
 882  */
 883 void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
 884 {
 885         struct ata_device *dev;
 886
 887         if (!ap->acpi_handle || (ap->flags & ATA_FLAG_ACPI_SATA))
 888                 return;
 889
 890         /* channel first and then drives for power on and vica versa
 891            for power off */
 892         if (state.event == PM_EVENT_ON)
 893                 acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D0);
 894
 895         ata_link_for_each_dev(dev, &ap->link) {
 896                 if (dev->acpi_handle && ata_dev_enabled(dev))
 897                         acpi_bus_set_power(dev->acpi_handle,
 898                                 state.event == PM_EVENT_ON ?
 899                                         ACPI_STATE_D0 : ACPI_STATE_D3);
 900         }
 901         if (state.event != PM_EVENT_ON)
 902                 acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D3);
 903 }
 904
 905 /**
 906  * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
 907  * @dev: target ATA device
 908  *
 909  * This function is called when @dev is about to be configured.
 910  * IDENTIFY data might have been modified after this hook is run.
 911  *
 912  * LOCKING:
 913  * EH context.
 914  *
 915  * RETURNS:
 916  * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
 917  * -errno on failure.
 918  */
 919 int ata_acpi_on_devcfg(struct ata_device *dev)
 920 {
 921         struct ata_port *ap = dev->link->ap;
 922         struct ata_eh_context *ehc = &ap->link.eh_context;
 923         int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
 924         int nr_executed = 0;
 925         int rc;
 926
 927         if (!dev->acpi_handle)
 928                 return 0;
 929
 930         /* do we need to do _GTF? */
 931         if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
 932             !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
 933                 return 0;
 934
 935         /* do _SDD if SATA */
 936         if (acpi_sata) {
 937                 rc = ata_acpi_push_id(dev);
 938                 if (rc)
 939                         goto acpi_err;
 940         }
 941
 942         /* do _GTF */
 943         rc = ata_acpi_exec_tfs(dev, &nr_executed);
 944         if (rc)
 945                 goto acpi_err;
 946
 947         dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
 948
 949         /* refresh IDENTIFY page if any _GTF command has been executed */
 950         if (nr_executed) {
 951                 rc = ata_dev_reread_id(dev, 0);
 952                 if (rc < 0) {
 953                         ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
 954                                        "after ACPI commands\n");
 955                         return rc;
 956                 }
 957         }
 958
 959         return 0;
 960
 961  acpi_err:
 962         /* ignore evaluation failure if we can continue safely */
 963         if (rc == -EINVAL && !nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
 964                 return 0;
 965
 966         /* fail and let EH retry once more for unknown IO errors */
 967         if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
 968                 dev->flags |= ATA_DFLAG_ACPI_FAILED;
 969                 return rc;
 970         }
 971
 972         ata_dev_printk(dev, KERN_WARNING,
 973                        "ACPI: failed the second time, disabled\n");
 974         dev->acpi_handle = NULL;
 975
 976         /* We can safely continue if no _GTF command has been executed
 977          * and port is not frozen.
 978          */
 979         if (!nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
 980                 return 0;
 981
 982         return rc;
 983 }
 984
 985 /**
 986  * ata_acpi_on_disable - ATA ACPI hook called when a device is disabled
 987  * @dev: target ATA device
 988  *
 989  * This function is called when @dev is about to be disabled.
 990  *
 991  * LOCKING:
 992  * EH context.
 993  */
 994 void ata_acpi_on_disable(struct ata_device *dev)
 995 {
 996         ata_acpi_clear_gtf(dev);
 997 }