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