3 * Provides ACPI support for PATA/SATA.
5 * Copyright (C) 2006 Intel Corp.
6 * Copyright (C) 2006 Randy Dunlap
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>
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>
27 #define NO_PORT_MULT 0xffff
28 #define SATA_ADR(root,pmp) (((root) << 16) | (pmp))
30 #define REGS_PER_GTF 7
32 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
36 * Helper - belongs in the PCI layer somewhere eventually
38 static int is_pci_dev(struct device *dev)
40 return (dev->bus == &pci_bus_type);
43 static void ata_acpi_associate_sata_port(struct ata_port *ap)
45 acpi_integer adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
47 ap->link.device->acpi_handle =
48 acpi_get_child(ap->host->acpi_handle, adr);
51 static void ata_acpi_associate_ide_port(struct ata_port *ap)
55 ap->acpi_handle = acpi_get_child(ap->host->acpi_handle, ap->port_no);
60 if (ap->flags & ATA_FLAG_SLAVE_POSS)
63 for (i = 0; i < max_devices; i++) {
64 struct ata_device *dev = &ap->link.device[i];
66 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
71 * ata_acpi_associate - associate ATA host with ACPI objects
72 * @host: target ATA host
74 * Look up ACPI objects associated with @host and initialize
75 * acpi_handle fields of @host, its ports and devices accordingly.
81 * 0 on success, -errno on failure.
83 void ata_acpi_associate(struct ata_host *host)
87 if (!is_pci_dev(host->dev) || libata_noacpi)
90 host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
91 if (!host->acpi_handle)
94 for (i = 0; i < host->n_ports; i++) {
95 struct ata_port *ap = host->ports[i];
97 if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
98 ata_acpi_associate_sata_port(ap);
100 ata_acpi_associate_ide_port(ap);
105 * ata_acpi_gtm - execute _GTM
106 * @ap: target ATA port
107 * @gtm: out parameter for _GTM result
109 * Evaluate _GTM and store the result in @gtm.
115 * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
117 static int ata_acpi_gtm(const struct ata_port *ap, struct ata_acpi_gtm *gtm)
119 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
120 union acpi_object *out_obj;
124 status = acpi_evaluate_object(ap->acpi_handle, "_GTM", NULL, &output);
127 if (status == AE_NOT_FOUND)
131 if (ACPI_FAILURE(status)) {
132 ata_port_printk(ap, KERN_ERR,
133 "ACPI get timing mode failed (AE 0x%x)\n",
138 out_obj = output.pointer;
139 if (out_obj->type != ACPI_TYPE_BUFFER) {
140 ata_port_printk(ap, KERN_WARNING,
141 "_GTM returned unexpected object type 0x%x\n",
147 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
148 ata_port_printk(ap, KERN_ERR,
149 "_GTM returned invalid length %d\n",
150 out_obj->buffer.length);
154 memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
157 kfree(output.pointer);
162 * ata_acpi_stm - execute _STM
163 * @ap: target ATA port
164 * @stm: timing parameter to _STM
166 * Evaluate _STM with timing parameter @stm.
172 * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
174 static int ata_acpi_stm(const struct ata_port *ap, struct ata_acpi_gtm *stm)
177 struct acpi_object_list input;
178 union acpi_object in_params[3];
180 in_params[0].type = ACPI_TYPE_BUFFER;
181 in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
182 in_params[0].buffer.pointer = (u8 *)stm;
183 /* Buffers for id may need byteswapping ? */
184 in_params[1].type = ACPI_TYPE_BUFFER;
185 in_params[1].buffer.length = 512;
186 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
187 in_params[2].type = ACPI_TYPE_BUFFER;
188 in_params[2].buffer.length = 512;
189 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
192 input.pointer = in_params;
194 status = acpi_evaluate_object(ap->acpi_handle, "_STM", &input, NULL);
196 if (status == AE_NOT_FOUND)
198 if (ACPI_FAILURE(status)) {
199 ata_port_printk(ap, KERN_ERR,
200 "ACPI set timing mode failed (status=0x%x)\n", status);
207 * ata_dev_get_GTF - get the drive bootup default taskfile settings
208 * @dev: target ATA device
209 * @gtf: output parameter for buffer containing _GTF taskfile arrays
210 * @ptr_to_free: pointer which should be freed
212 * This applies to both PATA and SATA drives.
214 * The _GTF method has no input parameters.
215 * It returns a variable number of register set values (registers
216 * hex 1F1..1F7, taskfiles).
217 * The <variable number> is not known in advance, so have ACPI-CA
218 * allocate the buffer as needed and return it, then free it later.
224 * Number of taskfiles on success, 0 if _GTF doesn't exist or doesn't
225 * contain valid data. -errno on other errors.
227 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf,
230 struct ata_port *ap = dev->link->ap;
232 struct acpi_buffer output;
233 union acpi_object *out_obj;
236 /* set up output buffer */
237 output.length = ACPI_ALLOCATE_BUFFER;
238 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
240 if (ata_msg_probe(ap))
241 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
242 __FUNCTION__, ap->port_no);
244 /* _GTF has no input parameters */
245 status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
247 if (ACPI_FAILURE(status)) {
248 if (status != AE_NOT_FOUND) {
249 ata_dev_printk(dev, KERN_WARNING,
250 "_GTF evaluation failed (AE 0x%x)\n",
257 if (!output.length || !output.pointer) {
258 if (ata_msg_probe(ap))
259 ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
260 "length or ptr is NULL (0x%llx, 0x%p)\n",
262 (unsigned long long)output.length,
267 out_obj = output.pointer;
268 if (out_obj->type != ACPI_TYPE_BUFFER) {
269 ata_dev_printk(dev, KERN_WARNING,
270 "_GTF unexpected object type 0x%x\n",
276 if (out_obj->buffer.length % REGS_PER_GTF) {
277 ata_dev_printk(dev, KERN_WARNING,
278 "unexpected _GTF length (%d)\n",
279 out_obj->buffer.length);
284 *ptr_to_free = out_obj;
285 *gtf = (void *)out_obj->buffer.pointer;
286 rc = out_obj->buffer.length / REGS_PER_GTF;
288 if (ata_msg_probe(ap))
289 ata_dev_printk(dev, KERN_DEBUG, "%s: returning "
290 "gtf=%p, gtf_count=%d, ptr_to_free=%p\n",
291 __FUNCTION__, *gtf, rc, *ptr_to_free);
295 kfree(output.pointer);
300 * ata_acpi_cbl_80wire - Check for 80 wire cable
303 * Return 1 if the ACPI mode data for this port indicates the BIOS selected
307 int ata_acpi_cbl_80wire(struct ata_port *ap)
309 struct ata_acpi_gtm gtm;
312 /* No _GTM data, no information */
313 if (ata_acpi_gtm(ap, >m) < 0)
316 /* Split timing, DMA enabled */
317 if ((gtm.flags & 0x11) == 0x11 && gtm.drive[0].dma < 55)
319 if ((gtm.flags & 0x14) == 0x14 && gtm.drive[1].dma < 55)
321 /* Shared timing, DMA enabled */
322 if ((gtm.flags & 0x11) == 0x01 && gtm.drive[0].dma < 55)
324 if ((gtm.flags & 0x14) == 0x04 && gtm.drive[0].dma < 55)
328 if ((valid & 1) && ata_dev_enabled(&ap->link.device[0]))
330 if ((valid & 2) && ata_dev_enabled(&ap->link.device[1]))
335 EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
338 * taskfile_load_raw - send taskfile registers to host controller
339 * @dev: target ATA device
340 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
342 * Outputs ATA taskfile to standard ATA host controller using MMIO
343 * or PIO as indicated by the ATA_FLAG_MMIO flag.
344 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
345 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
346 * hob_lbal, hob_lbam, and hob_lbah.
348 * This function waits for idle (!BUSY and !DRQ) after writing
349 * registers. If the control register has a new value, this
350 * function also waits for idle after writing control and before
351 * writing the remaining registers.
357 * 0 on success, -errno on failure.
359 static int taskfile_load_raw(struct ata_device *dev,
360 const struct ata_acpi_gtf *gtf)
362 struct ata_port *ap = dev->link->ap;
363 struct ata_taskfile tf, rtf;
364 unsigned int err_mask;
366 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
367 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
368 && (gtf->tf[6] == 0))
371 ata_tf_init(dev, &tf);
373 /* convert gtf to tf */
374 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE; /* TBD */
375 tf.protocol = ATA_PROT_NODATA;
376 tf.feature = gtf->tf[0]; /* 0x1f1 */
377 tf.nsect = gtf->tf[1]; /* 0x1f2 */
378 tf.lbal = gtf->tf[2]; /* 0x1f3 */
379 tf.lbam = gtf->tf[3]; /* 0x1f4 */
380 tf.lbah = gtf->tf[4]; /* 0x1f5 */
381 tf.device = gtf->tf[5]; /* 0x1f6 */
382 tf.command = gtf->tf[6]; /* 0x1f7 */
384 if (ata_msg_probe(ap))
385 ata_dev_printk(dev, KERN_DEBUG, "executing ACPI cmd "
386 "%02x/%02x:%02x:%02x:%02x:%02x:%02x\n",
387 tf.command, tf.feature, tf.nsect,
388 tf.lbal, tf.lbam, tf.lbah, tf.device);
391 err_mask = ata_exec_internal(dev, &rtf, NULL, DMA_NONE, NULL, 0);
393 ata_dev_printk(dev, KERN_ERR,
394 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x failed "
395 "(Emask=0x%x Stat=0x%02x Err=0x%02x)\n",
396 tf.command, tf.feature, tf.nsect, tf.lbal, tf.lbam,
397 tf.lbah, tf.device, err_mask, rtf.command, rtf.feature);
405 * ata_acpi_exec_tfs - get then write drive taskfile settings
406 * @dev: target ATA device
408 * Evaluate _GTF and excute returned taskfiles.
414 * Number of executed taskfiles on success, 0 if _GTF doesn't exist or
415 * doesn't contain valid data. -errno on other errors.
417 static int ata_acpi_exec_tfs(struct ata_device *dev)
419 struct ata_acpi_gtf *gtf = NULL;
420 void *ptr_to_free = NULL;
421 int gtf_count, i, rc;
424 rc = ata_dev_get_GTF(dev, >f, &ptr_to_free);
430 for (i = 0, rc = 0; i < gtf_count; i++) {
433 /* ACPI errors are eventually ignored. Run till the
434 * end even after errors.
436 tmp = taskfile_load_raw(dev, gtf++);
449 * ata_acpi_push_id - send Identify data to drive
450 * @dev: target ATA device
452 * _SDD ACPI object: for SATA mode only
453 * Must be after Identify (Packet) Device -- uses its data
454 * ATM this function never returns a failure. It is an optional
455 * method and if it fails for whatever reason, we should still
462 * 0 on success, -errno on failure.
464 static int ata_acpi_push_id(struct ata_device *dev)
466 struct ata_port *ap = dev->link->ap;
469 struct acpi_object_list input;
470 union acpi_object in_params[1];
472 if (ata_msg_probe(ap))
473 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
474 __FUNCTION__, dev->devno, ap->port_no);
476 /* Give the drive Identify data to the drive via the _SDD method */
477 /* _SDD: set up input parameters */
479 input.pointer = in_params;
480 in_params[0].type = ACPI_TYPE_BUFFER;
481 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
482 in_params[0].buffer.pointer = (u8 *)dev->id;
483 /* Output buffer: _SDD has no output */
485 /* It's OK for _SDD to be missing too. */
486 swap_buf_le16(dev->id, ATA_ID_WORDS);
487 status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
488 swap_buf_le16(dev->id, ATA_ID_WORDS);
490 err = ACPI_FAILURE(status) ? -EIO : 0;
492 ata_dev_printk(dev, KERN_WARNING,
493 "ACPI _SDD failed (AE 0x%x)\n", status);
499 * ata_acpi_on_suspend - ATA ACPI hook called on suspend
500 * @ap: target ATA port
502 * This function is called when @ap is about to be suspended. All
503 * devices are already put to sleep but the port_suspend() callback
504 * hasn't been executed yet. Error return from this function aborts
511 * 0 on success, -errno on failure.
513 int ata_acpi_on_suspend(struct ata_port *ap)
518 /* proceed iff per-port acpi_handle is valid */
519 if (!ap->acpi_handle)
521 BUG_ON(ap->flags & ATA_FLAG_ACPI_SATA);
523 /* store timing parameters */
524 rc = ata_acpi_gtm(ap, &ap->acpi_gtm);
526 spin_lock_irqsave(ap->lock, flags);
528 ap->pflags |= ATA_PFLAG_GTM_VALID;
530 ap->pflags &= ~ATA_PFLAG_GTM_VALID;
531 spin_unlock_irqrestore(ap->lock, flags);
539 * ata_acpi_on_resume - ATA ACPI hook called on resume
540 * @ap: target ATA port
542 * This function is called when @ap is resumed - right after port
543 * itself is resumed but before any EH action is taken.
548 void ata_acpi_on_resume(struct ata_port *ap)
550 struct ata_device *dev;
552 if (ap->acpi_handle && (ap->pflags & ATA_PFLAG_GTM_VALID)) {
553 BUG_ON(ap->flags & ATA_FLAG_ACPI_SATA);
555 /* restore timing parameters */
556 ata_acpi_stm(ap, &ap->acpi_gtm);
560 ata_link_for_each_dev(dev, &ap->link)
561 dev->flags |= ATA_DFLAG_ACPI_PENDING;
565 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
566 * @dev: target ATA device
568 * This function is called when @dev is about to be configured.
569 * IDENTIFY data might have been modified after this hook is run.
575 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
578 int ata_acpi_on_devcfg(struct ata_device *dev)
580 struct ata_port *ap = dev->link->ap;
581 struct ata_eh_context *ehc = &ap->link.eh_context;
582 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
585 if (!dev->acpi_handle)
588 /* do we need to do _GTF? */
589 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
590 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
593 /* do _SDD if SATA */
595 rc = ata_acpi_push_id(dev);
601 rc = ata_acpi_exec_tfs(dev);
605 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
607 /* refresh IDENTIFY page if any _GTF command has been executed */
609 rc = ata_dev_reread_id(dev, 0);
611 ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
612 "after ACPI commands\n");
620 /* let EH retry on the first failure, disable ACPI on the second */
621 if (dev->flags & ATA_DFLAG_ACPI_FAILED) {
622 ata_dev_printk(dev, KERN_WARNING, "ACPI on devcfg failed the "
623 "second time, disabling (errno=%d)\n", rc);
625 dev->acpi_handle = NULL;
627 /* if port is working, request IDENTIFY reload and continue */
628 if (!(ap->pflags & ATA_PFLAG_FROZEN))
631 dev->flags |= ATA_DFLAG_ACPI_FAILED;