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