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