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