SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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                 if (ata_msg_probe(ap))
 179                         ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
 180                                 "error: expected object type of "
 181                                 " ACPI_TYPE_BUFFER, got 0x%x\n",
 182                                 __FUNCTION__, out_obj->type);
 183                 rc = -EINVAL;
 184                 goto out_free;
 185         }
 186
 187         if (out_obj->buffer.length % REGS_PER_GTF) {
 188                 if (ata_msg_drv(ap))
 189                         ata_dev_printk(dev, KERN_ERR,
 190                                 "%s: unexpected GTF length (%d) or addr (0x%p)\n",
 191                                 __FUNCTION__, out_obj->buffer.length,
 192                                 out_obj->buffer.pointer);
 193                 rc = -EINVAL;
 194                 goto out_free;
 195         }
 196
 197         *ptr_to_free = out_obj;
 198         *gtf = (void *)out_obj->buffer.pointer;
 199         rc = out_obj->buffer.length / REGS_PER_GTF;
 200
 201         if (ata_msg_probe(ap))
 202                 ata_dev_printk(dev, KERN_DEBUG, "%s: returning "
 203                         "gtf=%p, gtf_count=%d, ptr_to_free=%p\n",
 204                         __FUNCTION__, *gtf, rc, *ptr_to_free);
 205         return rc;
 206
 207  out_free:
 208         kfree(output.pointer);
 209         return rc;
 210 }
 211
 212 /**
 213  * taskfile_load_raw - send taskfile registers to host controller
 214  * @dev: target ATA device
 215  * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
 216  *
 217  * Outputs ATA taskfile to standard ATA host controller using MMIO
 218  * or PIO as indicated by the ATA_FLAG_MMIO flag.
 219  * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
 220  * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
 221  * hob_lbal, hob_lbam, and hob_lbah.
 222  *
 223  * This function waits for idle (!BUSY and !DRQ) after writing
 224  * registers.  If the control register has a new value, this
 225  * function also waits for idle after writing control and before
 226  * writing the remaining registers.
 227  *
 228  * LOCKING:
 229  * EH context.
 230  *
 231  * RETURNS:
 232  * 0 on success, -errno on failure.
 233  */
 234 static int taskfile_load_raw(struct ata_device *dev,
 235                               const struct ata_acpi_gtf *gtf)
 236 {
 237         struct ata_port *ap = dev->ap;
 238         struct ata_taskfile tf, rtf;
 239         unsigned int err_mask;
 240
 241         if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
 242             && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
 243             && (gtf->tf[6] == 0))
 244                 return 0;
 245
 246         ata_tf_init(dev, &tf);
 247
 248         /* convert gtf to tf */
 249         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE; /* TBD */
 250         tf.protocol = ATA_PROT_NODATA;
 251         tf.feature = gtf->tf[0];        /* 0x1f1 */
 252         tf.nsect   = gtf->tf[1];        /* 0x1f2 */
 253         tf.lbal    = gtf->tf[2];        /* 0x1f3 */
 254         tf.lbam    = gtf->tf[3];        /* 0x1f4 */
 255         tf.lbah    = gtf->tf[4];        /* 0x1f5 */
 256         tf.device  = gtf->tf[5];        /* 0x1f6 */
 257         tf.command = gtf->tf[6];        /* 0x1f7 */
 258
 259         if (ata_msg_probe(ap))
 260                 ata_dev_printk(dev, KERN_DEBUG, "executing ACPI cmd "
 261                                "%02x/%02x:%02x:%02x:%02x:%02x:%02x\n",
 262                                tf.command, tf.feature, tf.nsect,
 263                                tf.lbal, tf.lbam, tf.lbah, tf.device);
 264
 265         rtf = tf;
 266         err_mask = ata_exec_internal(dev, &rtf, NULL, DMA_NONE, NULL, 0);
 267         if (err_mask) {
 268                 ata_dev_printk(dev, KERN_ERR,
 269                         "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x failed "
 270                         "(Emask=0x%x Stat=0x%02x Err=0x%02x)\n",
 271                         tf.command, tf.feature, tf.nsect, tf.lbal, tf.lbam,
 272                         tf.lbah, tf.device, err_mask, rtf.command, rtf.feature);
 273                 return -EIO;
 274         }
 275
 276         return 0;
 277 }
 278
 279 /**
 280  * ata_dev_set_taskfiles - write the drive taskfile settings from _GTF
 281  * @dev: target ATA device
 282  * @gtf: pointer to array of _GTF taskfiles to execute
 283  * @gtf_count: number of taskfiles
 284  *
 285  * This applies to both PATA and SATA drives.
 286  *
 287  * Execute taskfiles in @gtf.
 288  *
 289  * LOCKING:
 290  * EH context.
 291  *
 292  * RETURNS:
 293  * 0 on success, -errno on failure.
 294  */
 295 static int ata_dev_set_taskfiles(struct ata_device *dev,
 296                                  struct ata_acpi_gtf *gtf, int gtf_count)
 297 {
 298         struct ata_port *ap = dev->ap;
 299         int ix;
 300
 301         if (ata_msg_probe(ap))
 302                 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
 303                                __FUNCTION__, ap->port_no);
 304
 305         if (!(ap->flags & ATA_FLAG_ACPI_SATA))
 306                 return 0;
 307
 308         if (!ata_dev_enabled(dev) || (ap->flags & ATA_FLAG_DISABLED))
 309                 return -ENODEV;
 310
 311         /* send all TaskFile registers (0x1f1-0x1f7) *in*that*order* */
 312         for (ix = 0; ix < gtf_count; ix++)
 313                  taskfile_load_raw(dev, gtf++);
 314
 315         return 0;
 316 }
 317
 318 /**
 319  * ata_acpi_exec_tfs - get then write drive taskfile settings
 320  * @ap: the ata_port for the drive
 321  *
 322  * This applies to both PATA and SATA drives.
 323  */
 324 int ata_acpi_exec_tfs(struct ata_port *ap)
 325 {
 326         int ix, ret = 0;
 327
 328         /*
 329          * TBD - implement PATA support.  For now,
 330          * we should not run GTF on PATA devices since some
 331          * PATA require execution of GTM/STM before GTF.
 332          */
 333         if (!(ap->flags & ATA_FLAG_ACPI_SATA))
 334                 return 0;
 335
 336         for (ix = 0; ix < ATA_MAX_DEVICES; ix++) {
 337                 struct ata_device *dev = &ap->device[ix];
 338                 struct ata_acpi_gtf *gtf = NULL;
 339                 int gtf_count;
 340                 void *ptr_to_free = NULL;
 341
 342                 if (!ata_dev_enabled(dev))
 343                         continue;
 344
 345                 ret = ata_dev_get_GTF(dev, &gtf, &ptr_to_free);
 346                 if (ret == 0)
 347                         continue;
 348                 if (ret < 0) {
 349                         if (ata_msg_probe(ap))
 350                                 ata_port_printk(ap, KERN_DEBUG,
 351                                         "%s: get_GTF error (%d)\n",
 352                                         __FUNCTION__, ret);
 353                         break;
 354                 }
 355                 gtf_count = ret;
 356
 357                 ret = ata_dev_set_taskfiles(dev, gtf, gtf_count);
 358                 kfree(ptr_to_free);
 359                 if (ret < 0) {
 360                         if (ata_msg_probe(ap))
 361                                 ata_port_printk(ap, KERN_DEBUG,
 362                                         "%s: set_taskfiles error (%d)\n",
 363                                         __FUNCTION__, ret);
 364                         break;
 365                 }
 366         }
 367
 368         return ret;
 369 }
 370
 371 /**
 372  * ata_acpi_push_id - send Identify data to drive
 373  * @dev: target ATA device
 374  *
 375  * _SDD ACPI object: for SATA mode only
 376  * Must be after Identify (Packet) Device -- uses its data
 377  * ATM this function never returns a failure.  It is an optional
 378  * method and if it fails for whatever reason, we should still
 379  * just keep going.
 380  */
 381 int ata_acpi_push_id(struct ata_device *dev)
 382 {
 383         struct ata_port *ap = dev->ap;
 384         int err;
 385         acpi_status status;
 386         struct acpi_object_list input;
 387         union acpi_object in_params[1];
 388
 389         if (!dev->acpi_handle)
 390                 return 0;
 391
 392         if (ata_msg_probe(ap))
 393                 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
 394                                __FUNCTION__, dev->devno, ap->port_no);
 395
 396         /* Don't continue if not a SATA device. */
 397         if (!(ap->flags & ATA_FLAG_ACPI_SATA)) {
 398                 if (ata_msg_probe(ap))
 399                         ata_dev_printk(dev, KERN_DEBUG,
 400                                 "%s: Not a SATA device\n", __FUNCTION__);
 401                 goto out;
 402         }
 403
 404         /* Give the drive Identify data to the drive via the _SDD method */
 405         /* _SDD: set up input parameters */
 406         input.count = 1;
 407         input.pointer = in_params;
 408         in_params[0].type = ACPI_TYPE_BUFFER;
 409         in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
 410         in_params[0].buffer.pointer = (u8 *)dev->id;
 411         /* Output buffer: _SDD has no output */
 412
 413         /* It's OK for _SDD to be missing too. */
 414         swap_buf_le16(dev->id, ATA_ID_WORDS);
 415         status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
 416         swap_buf_le16(dev->id, ATA_ID_WORDS);
 417
 418         err = ACPI_FAILURE(status) ? -EIO : 0;
 419         if (err < 0) {
 420                 if (ata_msg_probe(ap))
 421                         ata_dev_printk(dev, KERN_DEBUG,
 422                                        "%s _SDD error: status = 0x%x\n",
 423                                        __FUNCTION__, status);
 424         }
 425
 426         /* always return success */
 427 out:
 428         return 0;
 429 }
 430
 431