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>
17 #include <scsi/scsi_device.h>
20 #include <acpi/acpi_bus.h>
21 #include <acpi/acnames.h>
22 #include <acpi/acnamesp.h>
23 #include <acpi/acparser.h>
24 #include <acpi/acexcep.h>
25 #include <acpi/acmacros.h>
26 #include <acpi/actypes.h>
28 #define NO_PORT_MULT 0xffff
29 #define SATA_ADR(root, pmp) (((root) << 16) | (pmp))
31 #define REGS_PER_GTF 7
33 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
37 * Helper - belongs in the PCI layer somewhere eventually
39 static int is_pci_dev(struct device *dev)
41 return (dev->bus == &pci_bus_type);
45 * ata_acpi_associate_sata_port - associate SATA port with ACPI objects
46 * @ap: target SATA port
48 * Look up ACPI objects associated with @ap and initialize acpi_handle
49 * fields of @ap, the port and devices accordingly.
55 * 0 on success, -errno on failure.
57 void ata_acpi_associate_sata_port(struct ata_port *ap)
59 WARN_ON(!(ap->flags & ATA_FLAG_ACPI_SATA));
61 if (!ap->nr_pmp_links) {
62 acpi_integer adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
64 ap->link.device->acpi_handle =
65 acpi_get_child(ap->host->acpi_handle, adr);
67 struct ata_link *link;
69 ap->link.device->acpi_handle = NULL;
71 ata_port_for_each_link(link, ap) {
72 acpi_integer adr = SATA_ADR(ap->port_no, link->pmp);
74 link->device->acpi_handle =
75 acpi_get_child(ap->host->acpi_handle, adr);
80 static void ata_acpi_associate_ide_port(struct ata_port *ap)
84 ap->acpi_handle = acpi_get_child(ap->host->acpi_handle, ap->port_no);
89 if (ap->flags & ATA_FLAG_SLAVE_POSS)
92 for (i = 0; i < max_devices; i++) {
93 struct ata_device *dev = &ap->link.device[i];
95 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
99 static void ata_acpi_handle_hotplug(struct ata_port *ap, struct kobject *kobj,
102 char event_string[12];
103 char *envp[] = { event_string, NULL };
104 struct ata_eh_info *ehi = &ap->link.eh_info;
106 if (event == 0 || event == 1) {
108 spin_lock_irqsave(ap->lock, flags);
109 ata_ehi_clear_desc(ehi);
110 ata_ehi_push_desc(ehi, "ACPI event");
111 ata_ehi_hotplugged(ehi);
113 spin_unlock_irqrestore(ap->lock, flags);
117 sprintf(event_string, "BAY_EVENT=%d", event);
118 kobject_uevent_env(kobj, KOBJ_CHANGE, envp);
122 static void ata_acpi_dev_notify(acpi_handle handle, u32 event, void *data)
124 struct ata_device *dev = data;
125 struct kobject *kobj = NULL;
128 kobj = &dev->sdev->sdev_gendev.kobj;
130 ata_acpi_handle_hotplug(dev->link->ap, kobj, event);
133 static void ata_acpi_ap_notify(acpi_handle handle, u32 event, void *data)
135 struct ata_port *ap = data;
137 ata_acpi_handle_hotplug(ap, &ap->dev->kobj, event);
141 * ata_acpi_associate - associate ATA host with ACPI objects
142 * @host: target ATA host
144 * Look up ACPI objects associated with @host and initialize
145 * acpi_handle fields of @host, its ports and devices accordingly.
151 * 0 on success, -errno on failure.
153 void ata_acpi_associate(struct ata_host *host)
157 if (!is_pci_dev(host->dev) || libata_noacpi)
160 host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
161 if (!host->acpi_handle)
164 for (i = 0; i < host->n_ports; i++) {
165 struct ata_port *ap = host->ports[i];
167 if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
168 ata_acpi_associate_sata_port(ap);
170 ata_acpi_associate_ide_port(ap);
173 acpi_install_notify_handler (ap->acpi_handle,
178 for (j = 0; j < ata_link_max_devices(&ap->link); j++) {
179 struct ata_device *dev = &ap->link.device[j];
181 if (dev->acpi_handle)
182 acpi_install_notify_handler (dev->acpi_handle,
191 * ata_acpi_gtm - execute _GTM
192 * @ap: target ATA port
193 * @gtm: out parameter for _GTM result
195 * Evaluate _GTM and store the result in @gtm.
201 * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
203 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
205 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
206 union acpi_object *out_obj;
210 status = acpi_evaluate_object(ap->acpi_handle, "_GTM", NULL, &output);
213 if (status == AE_NOT_FOUND)
217 if (ACPI_FAILURE(status)) {
218 ata_port_printk(ap, KERN_ERR,
219 "ACPI get timing mode failed (AE 0x%x)\n",
224 out_obj = output.pointer;
225 if (out_obj->type != ACPI_TYPE_BUFFER) {
226 ata_port_printk(ap, KERN_WARNING,
227 "_GTM returned unexpected object type 0x%x\n",
233 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
234 ata_port_printk(ap, KERN_ERR,
235 "_GTM returned invalid length %d\n",
236 out_obj->buffer.length);
240 memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
243 kfree(output.pointer);
247 EXPORT_SYMBOL_GPL(ata_acpi_gtm);
250 * ata_acpi_stm - execute _STM
251 * @ap: target ATA port
252 * @stm: timing parameter to _STM
254 * Evaluate _STM with timing parameter @stm.
260 * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
262 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
265 struct ata_acpi_gtm stm_buf = *stm;
266 struct acpi_object_list input;
267 union acpi_object in_params[3];
269 in_params[0].type = ACPI_TYPE_BUFFER;
270 in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
271 in_params[0].buffer.pointer = (u8 *)&stm_buf;
272 /* Buffers for id may need byteswapping ? */
273 in_params[1].type = ACPI_TYPE_BUFFER;
274 in_params[1].buffer.length = 512;
275 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
276 in_params[2].type = ACPI_TYPE_BUFFER;
277 in_params[2].buffer.length = 512;
278 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
281 input.pointer = in_params;
283 status = acpi_evaluate_object(ap->acpi_handle, "_STM", &input, NULL);
285 if (status == AE_NOT_FOUND)
287 if (ACPI_FAILURE(status)) {
288 ata_port_printk(ap, KERN_ERR,
289 "ACPI set timing mode failed (status=0x%x)\n", status);
295 EXPORT_SYMBOL_GPL(ata_acpi_stm);
298 * ata_dev_get_GTF - get the drive bootup default taskfile settings
299 * @dev: target ATA device
300 * @gtf: output parameter for buffer containing _GTF taskfile arrays
301 * @ptr_to_free: pointer which should be freed
303 * This applies to both PATA and SATA drives.
305 * The _GTF method has no input parameters.
306 * It returns a variable number of register set values (registers
307 * hex 1F1..1F7, taskfiles).
308 * The <variable number> is not known in advance, so have ACPI-CA
309 * allocate the buffer as needed and return it, then free it later.
315 * Number of taskfiles on success, 0 if _GTF doesn't exist or doesn't
316 * contain valid data.
318 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf,
321 struct ata_port *ap = dev->link->ap;
323 struct acpi_buffer output;
324 union acpi_object *out_obj;
327 /* set up output buffer */
328 output.length = ACPI_ALLOCATE_BUFFER;
329 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
331 if (ata_msg_probe(ap))
332 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
333 __FUNCTION__, ap->port_no);
335 /* _GTF has no input parameters */
336 status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
338 if (ACPI_FAILURE(status)) {
339 if (status != AE_NOT_FOUND) {
340 ata_dev_printk(dev, KERN_WARNING,
341 "_GTF evaluation failed (AE 0x%x)\n",
347 if (!output.length || !output.pointer) {
348 if (ata_msg_probe(ap))
349 ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
350 "length or ptr is NULL (0x%llx, 0x%p)\n",
352 (unsigned long long)output.length,
357 out_obj = output.pointer;
358 if (out_obj->type != ACPI_TYPE_BUFFER) {
359 ata_dev_printk(dev, KERN_WARNING,
360 "_GTF unexpected object type 0x%x\n",
365 if (out_obj->buffer.length % REGS_PER_GTF) {
366 ata_dev_printk(dev, KERN_WARNING,
367 "unexpected _GTF length (%d)\n",
368 out_obj->buffer.length);
372 *ptr_to_free = out_obj;
373 *gtf = (void *)out_obj->buffer.pointer;
374 rc = out_obj->buffer.length / REGS_PER_GTF;
376 if (ata_msg_probe(ap))
377 ata_dev_printk(dev, KERN_DEBUG, "%s: returning "
378 "gtf=%p, gtf_count=%d, ptr_to_free=%p\n",
379 __FUNCTION__, *gtf, rc, *ptr_to_free);
383 kfree(output.pointer);
388 * ata_acpi_cbl_80wire - Check for 80 wire cable
391 * Return 1 if the ACPI mode data for this port indicates the BIOS selected
395 int ata_acpi_cbl_80wire(struct ata_port *ap)
397 struct ata_acpi_gtm gtm;
400 /* No _GTM data, no information */
401 if (ata_acpi_gtm(ap, >m) < 0)
404 /* Split timing, DMA enabled */
405 if ((gtm.flags & 0x11) == 0x11 && gtm.drive[0].dma < 55)
407 if ((gtm.flags & 0x14) == 0x14 && gtm.drive[1].dma < 55)
409 /* Shared timing, DMA enabled */
410 if ((gtm.flags & 0x11) == 0x01 && gtm.drive[0].dma < 55)
412 if ((gtm.flags & 0x14) == 0x04 && gtm.drive[0].dma < 55)
416 if ((valid & 1) && ata_dev_enabled(&ap->link.device[0]))
418 if ((valid & 2) && ata_dev_enabled(&ap->link.device[1]))
423 EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
426 * taskfile_load_raw - send taskfile registers to host controller
427 * @dev: target ATA device
428 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
430 * Outputs ATA taskfile to standard ATA host controller using MMIO
431 * or PIO as indicated by the ATA_FLAG_MMIO flag.
432 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
433 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
434 * hob_lbal, hob_lbam, and hob_lbah.
436 * This function waits for idle (!BUSY and !DRQ) after writing
437 * registers. If the control register has a new value, this
438 * function also waits for idle after writing control and before
439 * writing the remaining registers.
445 * 0 on success, -errno on failure.
447 static int taskfile_load_raw(struct ata_device *dev,
448 const struct ata_acpi_gtf *gtf)
450 struct ata_port *ap = dev->link->ap;
451 struct ata_taskfile tf, rtf;
452 unsigned int err_mask;
454 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
455 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
456 && (gtf->tf[6] == 0))
459 ata_tf_init(dev, &tf);
461 /* convert gtf to tf */
462 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE; /* TBD */
463 tf.protocol = ATA_PROT_NODATA;
464 tf.feature = gtf->tf[0]; /* 0x1f1 */
465 tf.nsect = gtf->tf[1]; /* 0x1f2 */
466 tf.lbal = gtf->tf[2]; /* 0x1f3 */
467 tf.lbam = gtf->tf[3]; /* 0x1f4 */
468 tf.lbah = gtf->tf[4]; /* 0x1f5 */
469 tf.device = gtf->tf[5]; /* 0x1f6 */
470 tf.command = gtf->tf[6]; /* 0x1f7 */
472 if (ata_msg_probe(ap))
473 ata_dev_printk(dev, KERN_DEBUG, "executing ACPI cmd "
474 "%02x/%02x:%02x:%02x:%02x:%02x:%02x\n",
475 tf.command, tf.feature, tf.nsect,
476 tf.lbal, tf.lbam, tf.lbah, tf.device);
479 err_mask = ata_exec_internal(dev, &rtf, NULL, DMA_NONE, NULL, 0, 0);
481 ata_dev_printk(dev, KERN_ERR,
482 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x failed "
483 "(Emask=0x%x Stat=0x%02x Err=0x%02x)\n",
484 tf.command, tf.feature, tf.nsect, tf.lbal, tf.lbam,
485 tf.lbah, tf.device, err_mask, rtf.command, rtf.feature);
493 * ata_acpi_exec_tfs - get then write drive taskfile settings
494 * @dev: target ATA device
496 * Evaluate _GTF and excute returned taskfiles.
502 * Number of executed taskfiles on success, 0 if _GTF doesn't exist or
503 * doesn't contain valid data. -errno on other errors.
505 static int ata_acpi_exec_tfs(struct ata_device *dev)
507 struct ata_acpi_gtf *gtf = NULL;
508 void *ptr_to_free = NULL;
509 int gtf_count, i, rc;
512 gtf_count = ata_dev_get_GTF(dev, >f, &ptr_to_free);
515 for (i = 0, rc = 0; i < gtf_count; i++) {
518 /* ACPI errors are eventually ignored. Run till the
519 * end even after errors.
521 tmp = taskfile_load_raw(dev, gtf++);
534 * ata_acpi_push_id - send Identify data to drive
535 * @dev: target ATA device
537 * _SDD ACPI object: for SATA mode only
538 * Must be after Identify (Packet) Device -- uses its data
539 * ATM this function never returns a failure. It is an optional
540 * method and if it fails for whatever reason, we should still
547 * 0 on success, -errno on failure.
549 static int ata_acpi_push_id(struct ata_device *dev)
551 struct ata_port *ap = dev->link->ap;
554 struct acpi_object_list input;
555 union acpi_object in_params[1];
557 if (ata_msg_probe(ap))
558 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
559 __FUNCTION__, dev->devno, ap->port_no);
561 /* Give the drive Identify data to the drive via the _SDD method */
562 /* _SDD: set up input parameters */
564 input.pointer = in_params;
565 in_params[0].type = ACPI_TYPE_BUFFER;
566 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
567 in_params[0].buffer.pointer = (u8 *)dev->id;
568 /* Output buffer: _SDD has no output */
570 /* It's OK for _SDD to be missing too. */
571 swap_buf_le16(dev->id, ATA_ID_WORDS);
572 status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
573 swap_buf_le16(dev->id, ATA_ID_WORDS);
575 err = ACPI_FAILURE(status) ? -EIO : 0;
577 ata_dev_printk(dev, KERN_WARNING,
578 "ACPI _SDD failed (AE 0x%x)\n", status);
584 * ata_acpi_on_suspend - ATA ACPI hook called on suspend
585 * @ap: target ATA port
587 * This function is called when @ap is about to be suspended. All
588 * devices are already put to sleep but the port_suspend() callback
589 * hasn't been executed yet. Error return from this function aborts
596 * 0 on success, -errno on failure.
598 int ata_acpi_on_suspend(struct ata_port *ap)
603 /* proceed iff per-port acpi_handle is valid */
604 if (!ap->acpi_handle)
606 BUG_ON(ap->flags & ATA_FLAG_ACPI_SATA);
608 /* store timing parameters */
609 rc = ata_acpi_gtm(ap, &ap->acpi_gtm);
611 spin_lock_irqsave(ap->lock, flags);
613 ap->pflags |= ATA_PFLAG_GTM_VALID;
615 ap->pflags &= ~ATA_PFLAG_GTM_VALID;
616 spin_unlock_irqrestore(ap->lock, flags);
624 * ata_acpi_on_resume - ATA ACPI hook called on resume
625 * @ap: target ATA port
627 * This function is called when @ap is resumed - right after port
628 * itself is resumed but before any EH action is taken.
633 void ata_acpi_on_resume(struct ata_port *ap)
635 struct ata_device *dev;
637 if (ap->acpi_handle && (ap->pflags & ATA_PFLAG_GTM_VALID)) {
638 BUG_ON(ap->flags & ATA_FLAG_ACPI_SATA);
640 /* restore timing parameters */
641 ata_acpi_stm(ap, &ap->acpi_gtm);
645 ata_link_for_each_dev(dev, &ap->link)
646 dev->flags |= ATA_DFLAG_ACPI_PENDING;
650 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
651 * @dev: target ATA device
653 * This function is called when @dev is about to be configured.
654 * IDENTIFY data might have been modified after this hook is run.
660 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
663 int ata_acpi_on_devcfg(struct ata_device *dev)
665 struct ata_port *ap = dev->link->ap;
666 struct ata_eh_context *ehc = &ap->link.eh_context;
667 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
670 if (!dev->acpi_handle)
673 /* do we need to do _GTF? */
674 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
675 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
678 /* do _SDD if SATA */
680 rc = ata_acpi_push_id(dev);
686 rc = ata_acpi_exec_tfs(dev);
690 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
692 /* refresh IDENTIFY page if any _GTF command has been executed */
694 rc = ata_dev_reread_id(dev, 0);
696 ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
697 "after ACPI commands\n");
705 /* let EH retry on the first failure, disable ACPI on the second */
706 if (dev->flags & ATA_DFLAG_ACPI_FAILED) {
707 ata_dev_printk(dev, KERN_WARNING, "ACPI on devcfg failed the "
708 "second time, disabling (errno=%d)\n", rc);
710 dev->acpi_handle = NULL;
712 /* if port is working, request IDENTIFY reload and continue */
713 if (!(ap->pflags & ATA_PFLAG_FROZEN))
716 dev->flags |= ATA_DFLAG_ACPI_FAILED;