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/ata.h>
  10 #include <linux/delay.h>
  11 #include <linux/device.h>
  12 #include <linux/errno.h>
  13 #include <linux/kernel.h>
  14 #include <linux/acpi.h>
  15 #include <linux/libata.h>
  16 #include <linux/pci.h>
  17 #include "libata.h"
  18
  19 #include <acpi/acpi_bus.h>
  20 #include <acpi/acnames.h>
  21 #include <acpi/acnamesp.h>
  22 #include <acpi/acparser.h>
  23 #include <acpi/acexcep.h>
  24 #include <acpi/acmacros.h>
  25 #include <acpi/actypes.h>
  26
  27 #define NO_PORT_MULT            0xffff
  28 #define SATA_ADR(root,pmp)      (((root) << 16) | (pmp))
  29
  30 #define REGS_PER_GTF            7
  31 struct ata_acpi_gtf {
  32         u8      tf[REGS_PER_GTF];       /* regs. 0x1f1 - 0x1f7 */
  33 } __packed;
  34
  35 /*
  36  *      Helper - belongs in the PCI layer somewhere eventually
  37  */
  38 static int is_pci_dev(struct device *dev)
  39 {
  40         return (dev->bus == &pci_bus_type);
  41 }
  42
  43 static void ata_acpi_associate_sata_port(struct ata_port *ap)
  44 {
  45         acpi_integer adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
  46
  47         ap->device->acpi_handle = acpi_get_child(ap->host->acpi_handle, adr);
  48 }
  49
  50 static void ata_acpi_associate_ide_port(struct ata_port *ap)
  51 {
  52         int max_devices, i;
  53
  54         ap->acpi_handle = acpi_get_child(ap->host->acpi_handle, ap->port_no);
  55         if (!ap->acpi_handle)
  56                 return;
  57
  58         max_devices = 1;
  59         if (ap->flags & ATA_FLAG_SLAVE_POSS)
  60                 max_devices++;
  61
  62         for (i = 0; i < max_devices; i++) {
  63                 struct ata_device *dev = &ap->device[i];
  64
  65                 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
  66         }
  67 }
  68
  69 /**
  70  * ata_acpi_associate - associate ATA host with ACPI objects
  71  * @host: target ATA host
  72  *
  73  * Look up ACPI objects associated with @host and initialize
  74  * acpi_handle fields of @host, its ports and devices accordingly.
  75  *
  76  * LOCKING:
  77  * EH context.
  78  *
  79  * RETURNS:
  80  * 0 on success, -errno on failure.
  81  */
  82 void ata_acpi_associate(struct ata_host *host)
  83 {
  84         int i;
  85
  86         if (!is_pci_dev(host->dev) || libata_noacpi)
  87                 return;
  88
  89         host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
  90         if (!host->acpi_handle)
  91                 return;
  92
  93         for (i = 0; i < host->n_ports; i++) {
  94                 struct ata_port *ap = host->ports[i];
  95
  96                 if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
  97                         ata_acpi_associate_sata_port(ap);
  98                 else
  99                         ata_acpi_associate_ide_port(ap);
 100         }
 101 }
 102
 103 /**
 104  * ata_dev_get_GTF - get the drive bootup default taskfile settings
 105  * @dev: target ATA device
 106  * @gtf: output parameter for buffer containing _GTF taskfile arrays
 107  * @ptr_to_free: pointer which should be freed
 108  *
 109  * This applies to both PATA and SATA drives.
 110  *
 111  * The _GTF method has no input parameters.
 112  * It returns a variable number of register set values (registers
 113  * hex 1F1..1F7, taskfiles).
 114  * The <variable number> is not known in advance, so have ACPI-CA
 115  * allocate the buffer as needed and return it, then free it later.
 116  *
 117  * LOCKING:
 118  * EH context.
 119  *
 120  * RETURNS:
 121  * Number of taskfiles on success, 0 if _GTF doesn't exist or doesn't
 122  * contain valid data.  -errno on other errors.
 123  */
 124 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf,
 125                            void **ptr_to_free)
 126 {
 127         struct ata_port *ap = dev->ap;
 128         acpi_status status;
 129         struct acpi_buffer output;
 130         union acpi_object *out_obj;
 131         int rc = 0;
 132
 133         /* set up output buffer */
 134         output.length = ACPI_ALLOCATE_BUFFER;
 135         output.pointer = NULL;  /* ACPI-CA sets this; save/free it later */
 136
 137         if (!dev->acpi_handle)
 138                 goto out_free;
 139
 140         if (ata_msg_probe(ap))
 141                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
 142                                __FUNCTION__, ap->port_no);
 143
 144         if (!ata_dev_enabled(dev) || (ap->flags & ATA_FLAG_DISABLED)) {
 145                 if (ata_msg_probe(ap))
 146                         ata_dev_printk(dev, KERN_DEBUG, "%s: ERR: "
 147                                 "ata_dev_present: %d, PORT_DISABLED: %lu\n",
 148                                 __FUNCTION__, ata_dev_enabled(dev),
 149                                 ap->flags & ATA_FLAG_DISABLED);
 150                 goto out_free;
 151         }
 152
 153         /* _GTF has no input parameters */
 154         status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
 155
 156         if (ACPI_FAILURE(status)) {
 157                 if (status != AE_NOT_FOUND) {
 158                         ata_dev_printk(dev, KERN_WARNING,
 159                                        "_GTF evaluation failed (AE 0x%x)\n",
 160                                        status);
 161                         rc = -EIO;
 162                 }
 163                 goto out_free;
 164         }
 165
 166         if (!output.length || !output.pointer) {
 167                 if (ata_msg_probe(ap))
 168                         ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
 169                                 "length or ptr is NULL (0x%llx, 0x%p)\n",
 170                                 __FUNCTION__,
 171                                 (unsigned long long)output.length,
 172                                 output.pointer);
 173                 goto out_free;
 174         }
 175
 176         out_obj = output.pointer;
 177         if (out_obj->type != ACPI_TYPE_BUFFER) {
 178                 ata_dev_printk(dev, KERN_WARNING,
 179                                "_GTF unexpected object type 0x%x\n",
 180                                out_obj->type);
 181                 rc = -EINVAL;
 182                 goto out_free;
 183         }
 184
 185         if (out_obj->buffer.length % REGS_PER_GTF) {
 186                 ata_dev_printk(dev, KERN_WARNING,
 187                                "unexpected _GTF length (%d)\n",
 188                                out_obj->buffer.length);
 189                 rc = -EINVAL;
 190                 goto out_free;
 191         }
 192
 193         *ptr_to_free = out_obj;
 194         *gtf = (void *)out_obj->buffer.pointer;
 195         rc = out_obj->buffer.length / REGS_PER_GTF;
 196
 197         if (ata_msg_probe(ap))
 198                 ata_dev_printk(dev, KERN_DEBUG, "%s: returning "
 199                         "gtf=%p, gtf_count=%d, ptr_to_free=%p\n",
 200                         __FUNCTION__, *gtf, rc, *ptr_to_free);
 201         return rc;
 202
 203  out_free:
 204         kfree(output.pointer);
 205         return rc;
 206 }
 207
 208 /**
 209  * taskfile_load_raw - send taskfile registers to host controller
 210  * @dev: target ATA device
 211  * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
 212  *
 213  * Outputs ATA taskfile to standard ATA host controller using MMIO
 214  * or PIO as indicated by the ATA_FLAG_MMIO flag.
 215  * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
 216  * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
 217  * hob_lbal, hob_lbam, and hob_lbah.
 218  *
 219  * This function waits for idle (!BUSY and !DRQ) after writing
 220  * registers.  If the control register has a new value, this
 221  * function also waits for idle after writing control and before
 222  * writing the remaining registers.
 223  *
 224  * LOCKING:
 225  * EH context.
 226  *
 227  * RETURNS:
 228  * 0 on success, -errno on failure.
 229  */
 230 static int taskfile_load_raw(struct ata_device *dev,
 231                               const struct ata_acpi_gtf *gtf)
 232 {
 233         struct ata_port *ap = dev->ap;
 234         struct ata_taskfile tf, rtf;
 235         unsigned int err_mask;
 236
 237         if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
 238             && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
 239             && (gtf->tf[6] == 0))
 240                 return 0;
 241
 242         ata_tf_init(dev, &tf);
 243
 244         /* convert gtf to tf */
 245         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE; /* TBD */
 246         tf.protocol = ATA_PROT_NODATA;
 247         tf.feature = gtf->tf[0];        /* 0x1f1 */
 248         tf.nsect   = gtf->tf[1];        /* 0x1f2 */
 249         tf.lbal    = gtf->tf[2];        /* 0x1f3 */
 250         tf.lbam    = gtf->tf[3];        /* 0x1f4 */
 251         tf.lbah    = gtf->tf[4];        /* 0x1f5 */
 252         tf.device  = gtf->tf[5];        /* 0x1f6 */
 253         tf.command = gtf->tf[6];        /* 0x1f7 */
 254
 255         if (ata_msg_probe(ap))
 256                 ata_dev_printk(dev, KERN_DEBUG, "executing ACPI cmd "
 257                                "%02x/%02x:%02x:%02x:%02x:%02x:%02x\n",
 258                                tf.command, tf.feature, tf.nsect,
 259                                tf.lbal, tf.lbam, tf.lbah, tf.device);
 260
 261         rtf = tf;
 262         err_mask = ata_exec_internal(dev, &rtf, NULL, DMA_NONE, NULL, 0);
 263         if (err_mask) {
 264                 ata_dev_printk(dev, KERN_ERR,
 265                         "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x failed "
 266                         "(Emask=0x%x Stat=0x%02x Err=0x%02x)\n",
 267                         tf.command, tf.feature, tf.nsect, tf.lbal, tf.lbam,
 268                         tf.lbah, tf.device, err_mask, rtf.command, rtf.feature);
 269                 return -EIO;
 270         }
 271
 272         return 0;
 273 }
 274
 275 /**
 276  * ata_acpi_exec_tfs - get then write drive taskfile settings
 277  * @dev: target ATA device
 278  *
 279  * Evaluate _GTF and excute returned taskfiles.
 280  *
 281  * LOCKING:
 282  * EH context.
 283  *
 284  * RETURNS:
 285  * Number of executed taskfiles on success, 0 if _GTF doesn't exist or
 286  * doesn't contain valid data.  -errno on other errors.
 287  */
 288 static int ata_acpi_exec_tfs(struct ata_device *dev)
 289 {
 290         struct ata_acpi_gtf *gtf = NULL;
 291         void *ptr_to_free = NULL;
 292         int gtf_count, i, rc;
 293
 294         /* get taskfiles */
 295         rc = ata_dev_get_GTF(dev, &gtf, &ptr_to_free);
 296         if (rc < 0)
 297                 return rc;
 298         gtf_count = rc;
 299
 300         /* execute them */
 301         for (i = 0, rc = 0; i < gtf_count; i++) {
 302                 int tmp;
 303
 304                 /* ACPI errors are eventually ignored.  Run till the
 305                  * end even after errors.
 306                  */
 307                 tmp = taskfile_load_raw(dev, gtf++);
 308                 if (!rc)
 309                         rc = tmp;
 310         }
 311
 312         kfree(ptr_to_free);
 313
 314         if (rc == 0)
 315                 return gtf_count;
 316         return rc;
 317 }
 318
 319 /**
 320  * ata_acpi_push_id - send Identify data to drive
 321  * @dev: target ATA device
 322  *
 323  * _SDD ACPI object: for SATA mode only
 324  * Must be after Identify (Packet) Device -- uses its data
 325  * ATM this function never returns a failure.  It is an optional
 326  * method and if it fails for whatever reason, we should still
 327  * just keep going.
 328  *
 329  * LOCKING:
 330  * EH context.
 331  *
 332  * RETURNS:
 333  * 0 on success, -errno on failure.
 334  */
 335 static int ata_acpi_push_id(struct ata_device *dev)
 336 {
 337         struct ata_port *ap = dev->ap;
 338         int err;
 339         acpi_status status;
 340         struct acpi_object_list input;
 341         union acpi_object in_params[1];
 342
 343         if (!dev->acpi_handle)
 344                 return 0;
 345
 346         if (ata_msg_probe(ap))
 347                 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
 348                                __FUNCTION__, dev->devno, ap->port_no);
 349
 350         /* Don't continue if not a SATA device. */
 351         if (!(ap->flags & ATA_FLAG_ACPI_SATA)) {
 352                 if (ata_msg_probe(ap))
 353                         ata_dev_printk(dev, KERN_DEBUG,
 354                                 "%s: Not a SATA device\n", __FUNCTION__);
 355                 return 0;
 356         }
 357
 358         /* Give the drive Identify data to the drive via the _SDD method */
 359         /* _SDD: set up input parameters */
 360         input.count = 1;
 361         input.pointer = in_params;
 362         in_params[0].type = ACPI_TYPE_BUFFER;
 363         in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
 364         in_params[0].buffer.pointer = (u8 *)dev->id;
 365         /* Output buffer: _SDD has no output */
 366
 367         /* It's OK for _SDD to be missing too. */
 368         swap_buf_le16(dev->id, ATA_ID_WORDS);
 369         status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
 370         swap_buf_le16(dev->id, ATA_ID_WORDS);
 371
 372         err = ACPI_FAILURE(status) ? -EIO : 0;
 373         if (err < 0)
 374                 ata_dev_printk(dev, KERN_WARNING,
 375                                "ACPI _SDD failed (AE 0x%x)\n", status);
 376
 377         return err;
 378 }
 379
 380 /**
 381  * ata_acpi_on_resume - ATA ACPI hook called on resume
 382  * @ap: target ATA port
 383  *
 384  * This function is called when @ap is resumed - right after port
 385  * itself is resumed but before any EH action is taken.
 386  *
 387  * LOCKING:
 388  * EH context.
 389  */
 390 void ata_acpi_on_resume(struct ata_port *ap)
 391 {
 392         int i;
 393
 394         /* schedule _GTF */
 395         for (i = 0; i < ATA_MAX_DEVICES; i++)
 396                 ap->device[i].flags |= ATA_DFLAG_ACPI_PENDING;
 397 }
 398
 399 /**
 400  * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
 401  * @dev: target ATA device
 402  *
 403  * This function is called when @dev is about to be configured.
 404  * IDENTIFY data might have been modified after this hook is run.
 405  *
 406  * LOCKING:
 407  * EH context.
 408  *
 409  * RETURNS:
 410  * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
 411  * -errno on failure.
 412  */
 413 int ata_acpi_on_devcfg(struct ata_device *dev)
 414 {
 415         struct ata_port *ap = dev->ap;
 416         struct ata_eh_context *ehc = &ap->eh_context;
 417         int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
 418         int rc;
 419
 420         /* XXX: _STM isn't implemented yet, skip if IDE for now */
 421         if (!acpi_sata)
 422                 return 0;
 423
 424         if (!dev->acpi_handle)
 425                 return 0;
 426
 427         /* do we need to do _GTF? */
 428         if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
 429             !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
 430                 return 0;
 431
 432         /* do _SDD if SATA */
 433         if (acpi_sata) {
 434                 rc = ata_acpi_push_id(dev);
 435                 if (rc)
 436                         goto acpi_err;
 437         }
 438
 439         /* do _GTF */
 440         rc = ata_acpi_exec_tfs(dev);
 441         if (rc < 0)
 442                 goto acpi_err;
 443
 444         dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
 445
 446         /* refresh IDENTIFY page if any _GTF command has been executed */
 447         if (rc > 0) {
 448                 rc = ata_dev_reread_id(dev, 0);
 449                 if (rc < 0) {
 450                         ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
 451                                        "after ACPI commands\n");
 452                         return rc;
 453                 }
 454         }
 455
 456         return 0;
 457
 458  acpi_err:
 459         /* let EH retry on the first failure, disable ACPI on the second */
 460         if (dev->flags & ATA_DFLAG_ACPI_FAILED) {
 461                 ata_dev_printk(dev, KERN_WARNING, "ACPI on devcfg failed the "
 462                                "second time, disabling (errno=%d)\n", rc);
 463
 464                 dev->acpi_handle = NULL;
 465
 466                 /* if port is working, request IDENTIFY reload and continue */
 467                 if (!(ap->pflags & ATA_PFLAG_FROZEN))
 468                         rc = 1;
 469         }
 470         dev->flags |= ATA_DFLAG_ACPI_FAILED;
 471         return rc;
 472 }