libata: make gtf_filter per-dev
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / ata / libata-acpi.c
blobb0882cddfd4cae52856cabeb487ecc51c8cc81a3
1 /*
2 * libata-acpi.c
3 * Provides ACPI support for PATA/SATA.
5 * Copyright (C) 2006 Intel Corp.
6 * Copyright (C) 2006 Randy Dunlap
7 */
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"
21 #include <acpi/acpi_bus.h>
23 unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
24 module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
25 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, 0x8=FPDMA non-zero offset, 0x10=FPDMA DMA Setup FIS auto-activate)");
27 #define NO_PORT_MULT 0xffff
28 #define SATA_ADR(root, pmp) (((root) << 16) | (pmp))
30 #define REGS_PER_GTF 7
31 struct ata_acpi_gtf {
32 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
33 } __packed;
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_clear_gtf(struct ata_device *dev)
45 kfree(dev->gtf_cache);
46 dev->gtf_cache = NULL;
49 /**
50 * ata_acpi_associate_sata_port - associate SATA port with ACPI objects
51 * @ap: target SATA port
53 * Look up ACPI objects associated with @ap and initialize acpi_handle
54 * fields of @ap, the port and devices accordingly.
56 * LOCKING:
57 * EH context.
59 * RETURNS:
60 * 0 on success, -errno on failure.
62 void ata_acpi_associate_sata_port(struct ata_port *ap)
64 WARN_ON(!(ap->flags & ATA_FLAG_ACPI_SATA));
66 if (!sata_pmp_attached(ap)) {
67 acpi_integer adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
69 ap->link.device->acpi_handle =
70 acpi_get_child(ap->host->acpi_handle, adr);
71 } else {
72 struct ata_link *link;
74 ap->link.device->acpi_handle = NULL;
76 ata_for_each_link(link, ap, EDGE) {
77 acpi_integer adr = SATA_ADR(ap->port_no, link->pmp);
79 link->device->acpi_handle =
80 acpi_get_child(ap->host->acpi_handle, adr);
85 static void ata_acpi_associate_ide_port(struct ata_port *ap)
87 int max_devices, i;
89 ap->acpi_handle = acpi_get_child(ap->host->acpi_handle, ap->port_no);
90 if (!ap->acpi_handle)
91 return;
93 max_devices = 1;
94 if (ap->flags & ATA_FLAG_SLAVE_POSS)
95 max_devices++;
97 for (i = 0; i < max_devices; i++) {
98 struct ata_device *dev = &ap->link.device[i];
100 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
103 if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
104 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
107 /* @ap and @dev are the same as ata_acpi_handle_hotplug() */
108 static void ata_acpi_detach_device(struct ata_port *ap, struct ata_device *dev)
110 if (dev)
111 dev->flags |= ATA_DFLAG_DETACH;
112 else {
113 struct ata_link *tlink;
114 struct ata_device *tdev;
116 ata_for_each_link(tlink, ap, EDGE)
117 ata_for_each_dev(tdev, tlink, ALL)
118 tdev->flags |= ATA_DFLAG_DETACH;
121 ata_port_schedule_eh(ap);
125 * ata_acpi_handle_hotplug - ACPI event handler backend
126 * @ap: ATA port ACPI event occurred
127 * @dev: ATA device ACPI event occurred (can be NULL)
128 * @event: ACPI event which occurred
130 * All ACPI bay / device realted events end up in this function. If
131 * the event is port-wide @dev is NULL. If the event is specific to a
132 * device, @dev points to it.
134 * Hotplug (as opposed to unplug) notification is always handled as
135 * port-wide while unplug only kills the target device on device-wide
136 * event.
138 * LOCKING:
139 * ACPI notify handler context. May sleep.
141 static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
142 u32 event)
144 struct ata_eh_info *ehi = &ap->link.eh_info;
145 int wait = 0;
146 unsigned long flags;
147 acpi_handle handle;
149 if (dev)
150 handle = dev->acpi_handle;
151 else
152 handle = ap->acpi_handle;
154 spin_lock_irqsave(ap->lock, flags);
156 * When dock driver calls into the routine, it will always use
157 * ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
158 * ACPI_NOTIFY_EJECT_REQUEST for remove
160 switch (event) {
161 case ACPI_NOTIFY_BUS_CHECK:
162 case ACPI_NOTIFY_DEVICE_CHECK:
163 ata_ehi_push_desc(ehi, "ACPI event");
165 ata_ehi_hotplugged(ehi);
166 ata_port_freeze(ap);
167 break;
168 case ACPI_NOTIFY_EJECT_REQUEST:
169 ata_ehi_push_desc(ehi, "ACPI event");
171 ata_acpi_detach_device(ap, dev);
172 wait = 1;
173 break;
176 spin_unlock_irqrestore(ap->lock, flags);
178 if (wait)
179 ata_port_wait_eh(ap);
182 static void ata_acpi_dev_notify_dock(acpi_handle handle, u32 event, void *data)
184 struct ata_device *dev = data;
186 ata_acpi_handle_hotplug(dev->link->ap, dev, event);
189 static void ata_acpi_ap_notify_dock(acpi_handle handle, u32 event, void *data)
191 struct ata_port *ap = data;
193 ata_acpi_handle_hotplug(ap, NULL, event);
196 static void ata_acpi_uevent(struct ata_port *ap, struct ata_device *dev,
197 u32 event)
199 struct kobject *kobj = NULL;
200 char event_string[20];
201 char *envp[] = { event_string, NULL };
203 if (dev) {
204 if (dev->sdev)
205 kobj = &dev->sdev->sdev_gendev.kobj;
206 } else
207 kobj = &ap->dev->kobj;
209 if (kobj) {
210 snprintf(event_string, 20, "BAY_EVENT=%d", event);
211 kobject_uevent_env(kobj, KOBJ_CHANGE, envp);
215 static void ata_acpi_ap_uevent(acpi_handle handle, u32 event, void *data)
217 ata_acpi_uevent(data, NULL, event);
220 static void ata_acpi_dev_uevent(acpi_handle handle, u32 event, void *data)
222 struct ata_device *dev = data;
223 ata_acpi_uevent(dev->link->ap, dev, event);
226 static struct acpi_dock_ops ata_acpi_dev_dock_ops = {
227 .handler = ata_acpi_dev_notify_dock,
228 .uevent = ata_acpi_dev_uevent,
231 static struct acpi_dock_ops ata_acpi_ap_dock_ops = {
232 .handler = ata_acpi_ap_notify_dock,
233 .uevent = ata_acpi_ap_uevent,
237 * ata_acpi_associate - associate ATA host with ACPI objects
238 * @host: target ATA host
240 * Look up ACPI objects associated with @host and initialize
241 * acpi_handle fields of @host, its ports and devices accordingly.
243 * LOCKING:
244 * EH context.
246 * RETURNS:
247 * 0 on success, -errno on failure.
249 void ata_acpi_associate(struct ata_host *host)
251 int i, j;
253 if (!is_pci_dev(host->dev) || libata_noacpi)
254 return;
256 host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
257 if (!host->acpi_handle)
258 return;
260 for (i = 0; i < host->n_ports; i++) {
261 struct ata_port *ap = host->ports[i];
263 if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
264 ata_acpi_associate_sata_port(ap);
265 else
266 ata_acpi_associate_ide_port(ap);
268 if (ap->acpi_handle) {
269 /* we might be on a docking station */
270 register_hotplug_dock_device(ap->acpi_handle,
271 &ata_acpi_ap_dock_ops, ap);
274 for (j = 0; j < ata_link_max_devices(&ap->link); j++) {
275 struct ata_device *dev = &ap->link.device[j];
277 if (dev->acpi_handle) {
278 /* we might be on a docking station */
279 register_hotplug_dock_device(dev->acpi_handle,
280 &ata_acpi_dev_dock_ops, dev);
287 * ata_acpi_dissociate - dissociate ATA host from ACPI objects
288 * @host: target ATA host
290 * This function is called during driver detach after the whole host
291 * is shut down.
293 * LOCKING:
294 * EH context.
296 void ata_acpi_dissociate(struct ata_host *host)
298 int i;
300 /* Restore initial _GTM values so that driver which attaches
301 * afterward can use them too.
303 for (i = 0; i < host->n_ports; i++) {
304 struct ata_port *ap = host->ports[i];
305 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
307 if (ap->acpi_handle && gtm)
308 ata_acpi_stm(ap, gtm);
313 * ata_acpi_gtm - execute _GTM
314 * @ap: target ATA port
315 * @gtm: out parameter for _GTM result
317 * Evaluate _GTM and store the result in @gtm.
319 * LOCKING:
320 * EH context.
322 * RETURNS:
323 * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
325 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
327 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
328 union acpi_object *out_obj;
329 acpi_status status;
330 int rc = 0;
332 status = acpi_evaluate_object(ap->acpi_handle, "_GTM", NULL, &output);
334 rc = -ENOENT;
335 if (status == AE_NOT_FOUND)
336 goto out_free;
338 rc = -EINVAL;
339 if (ACPI_FAILURE(status)) {
340 ata_port_printk(ap, KERN_ERR,
341 "ACPI get timing mode failed (AE 0x%x)\n",
342 status);
343 goto out_free;
346 out_obj = output.pointer;
347 if (out_obj->type != ACPI_TYPE_BUFFER) {
348 ata_port_printk(ap, KERN_WARNING,
349 "_GTM returned unexpected object type 0x%x\n",
350 out_obj->type);
352 goto out_free;
355 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
356 ata_port_printk(ap, KERN_ERR,
357 "_GTM returned invalid length %d\n",
358 out_obj->buffer.length);
359 goto out_free;
362 memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
363 rc = 0;
364 out_free:
365 kfree(output.pointer);
366 return rc;
369 EXPORT_SYMBOL_GPL(ata_acpi_gtm);
372 * ata_acpi_stm - execute _STM
373 * @ap: target ATA port
374 * @stm: timing parameter to _STM
376 * Evaluate _STM with timing parameter @stm.
378 * LOCKING:
379 * EH context.
381 * RETURNS:
382 * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
384 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
386 acpi_status status;
387 struct ata_acpi_gtm stm_buf = *stm;
388 struct acpi_object_list input;
389 union acpi_object in_params[3];
391 in_params[0].type = ACPI_TYPE_BUFFER;
392 in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
393 in_params[0].buffer.pointer = (u8 *)&stm_buf;
394 /* Buffers for id may need byteswapping ? */
395 in_params[1].type = ACPI_TYPE_BUFFER;
396 in_params[1].buffer.length = 512;
397 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
398 in_params[2].type = ACPI_TYPE_BUFFER;
399 in_params[2].buffer.length = 512;
400 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
402 input.count = 3;
403 input.pointer = in_params;
405 status = acpi_evaluate_object(ap->acpi_handle, "_STM", &input, NULL);
407 if (status == AE_NOT_FOUND)
408 return -ENOENT;
409 if (ACPI_FAILURE(status)) {
410 ata_port_printk(ap, KERN_ERR,
411 "ACPI set timing mode failed (status=0x%x)\n", status);
412 return -EINVAL;
414 return 0;
417 EXPORT_SYMBOL_GPL(ata_acpi_stm);
420 * ata_dev_get_GTF - get the drive bootup default taskfile settings
421 * @dev: target ATA device
422 * @gtf: output parameter for buffer containing _GTF taskfile arrays
424 * This applies to both PATA and SATA drives.
426 * The _GTF method has no input parameters.
427 * It returns a variable number of register set values (registers
428 * hex 1F1..1F7, taskfiles).
429 * The <variable number> is not known in advance, so have ACPI-CA
430 * allocate the buffer as needed and return it, then free it later.
432 * LOCKING:
433 * EH context.
435 * RETURNS:
436 * Number of taskfiles on success, 0 if _GTF doesn't exist. -EINVAL
437 * if _GTF is invalid.
439 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
441 struct ata_port *ap = dev->link->ap;
442 acpi_status status;
443 struct acpi_buffer output;
444 union acpi_object *out_obj;
445 int rc = 0;
447 /* if _GTF is cached, use the cached value */
448 if (dev->gtf_cache) {
449 out_obj = dev->gtf_cache;
450 goto done;
453 /* set up output buffer */
454 output.length = ACPI_ALLOCATE_BUFFER;
455 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
457 if (ata_msg_probe(ap))
458 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
459 __func__, ap->port_no);
461 /* _GTF has no input parameters */
462 status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
463 out_obj = dev->gtf_cache = output.pointer;
465 if (ACPI_FAILURE(status)) {
466 if (status != AE_NOT_FOUND) {
467 ata_dev_printk(dev, KERN_WARNING,
468 "_GTF evaluation failed (AE 0x%x)\n",
469 status);
470 rc = -EINVAL;
472 goto out_free;
475 if (!output.length || !output.pointer) {
476 if (ata_msg_probe(ap))
477 ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
478 "length or ptr is NULL (0x%llx, 0x%p)\n",
479 __func__,
480 (unsigned long long)output.length,
481 output.pointer);
482 rc = -EINVAL;
483 goto out_free;
486 if (out_obj->type != ACPI_TYPE_BUFFER) {
487 ata_dev_printk(dev, KERN_WARNING,
488 "_GTF unexpected object type 0x%x\n",
489 out_obj->type);
490 rc = -EINVAL;
491 goto out_free;
494 if (out_obj->buffer.length % REGS_PER_GTF) {
495 ata_dev_printk(dev, KERN_WARNING,
496 "unexpected _GTF length (%d)\n",
497 out_obj->buffer.length);
498 rc = -EINVAL;
499 goto out_free;
502 done:
503 rc = out_obj->buffer.length / REGS_PER_GTF;
504 if (gtf) {
505 *gtf = (void *)out_obj->buffer.pointer;
506 if (ata_msg_probe(ap))
507 ata_dev_printk(dev, KERN_DEBUG,
508 "%s: returning gtf=%p, gtf_count=%d\n",
509 __func__, *gtf, rc);
511 return rc;
513 out_free:
514 ata_acpi_clear_gtf(dev);
515 return rc;
519 * ata_acpi_gtm_xfermode - determine xfermode from GTM parameter
520 * @dev: target device
521 * @gtm: GTM parameter to use
523 * Determine xfermask for @dev from @gtm.
525 * LOCKING:
526 * None.
528 * RETURNS:
529 * Determined xfermask.
531 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
532 const struct ata_acpi_gtm *gtm)
534 unsigned long xfer_mask = 0;
535 unsigned int type;
536 int unit;
537 u8 mode;
539 /* we always use the 0 slot for crap hardware */
540 unit = dev->devno;
541 if (!(gtm->flags & 0x10))
542 unit = 0;
544 /* PIO */
545 mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
546 xfer_mask |= ata_xfer_mode2mask(mode);
548 /* See if we have MWDMA or UDMA data. We don't bother with
549 * MWDMA if UDMA is available as this means the BIOS set UDMA
550 * and our error changedown if it works is UDMA to PIO anyway.
552 if (!(gtm->flags & (1 << (2 * unit))))
553 type = ATA_SHIFT_MWDMA;
554 else
555 type = ATA_SHIFT_UDMA;
557 mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
558 xfer_mask |= ata_xfer_mode2mask(mode);
560 return xfer_mask;
562 EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
565 * ata_acpi_cbl_80wire - Check for 80 wire cable
566 * @ap: Port to check
567 * @gtm: GTM data to use
569 * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
571 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
573 struct ata_device *dev;
575 ata_for_each_dev(dev, &ap->link, ENABLED) {
576 unsigned long xfer_mask, udma_mask;
578 xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
579 ata_unpack_xfermask(xfer_mask, NULL, NULL, &udma_mask);
581 if (udma_mask & ~ATA_UDMA_MASK_40C)
582 return 1;
585 return 0;
587 EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
589 static void ata_acpi_gtf_to_tf(struct ata_device *dev,
590 const struct ata_acpi_gtf *gtf,
591 struct ata_taskfile *tf)
593 ata_tf_init(dev, tf);
595 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
596 tf->protocol = ATA_PROT_NODATA;
597 tf->feature = gtf->tf[0]; /* 0x1f1 */
598 tf->nsect = gtf->tf[1]; /* 0x1f2 */
599 tf->lbal = gtf->tf[2]; /* 0x1f3 */
600 tf->lbam = gtf->tf[3]; /* 0x1f4 */
601 tf->lbah = gtf->tf[4]; /* 0x1f5 */
602 tf->device = gtf->tf[5]; /* 0x1f6 */
603 tf->command = gtf->tf[6]; /* 0x1f7 */
606 static int ata_acpi_filter_tf(struct ata_device *dev,
607 const struct ata_taskfile *tf,
608 const struct ata_taskfile *ptf)
610 if (dev->gtf_filter & ATA_ACPI_FILTER_SETXFER) {
611 /* libata doesn't use ACPI to configure transfer mode.
612 * It will only confuse device configuration. Skip.
614 if (tf->command == ATA_CMD_SET_FEATURES &&
615 tf->feature == SETFEATURES_XFER)
616 return 1;
619 if (dev->gtf_filter & ATA_ACPI_FILTER_LOCK) {
620 /* BIOS writers, sorry but we don't wanna lock
621 * features unless the user explicitly said so.
624 /* DEVICE CONFIGURATION FREEZE LOCK */
625 if (tf->command == ATA_CMD_CONF_OVERLAY &&
626 tf->feature == ATA_DCO_FREEZE_LOCK)
627 return 1;
629 /* SECURITY FREEZE LOCK */
630 if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
631 return 1;
633 /* SET MAX LOCK and SET MAX FREEZE LOCK */
634 if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
635 tf->command == ATA_CMD_SET_MAX &&
636 (tf->feature == ATA_SET_MAX_LOCK ||
637 tf->feature == ATA_SET_MAX_FREEZE_LOCK))
638 return 1;
641 if (tf->command == ATA_CMD_SET_FEATURES &&
642 tf->feature == SETFEATURES_SATA_ENABLE) {
643 /* inhibit enabling DIPM */
644 if (dev->gtf_filter & ATA_ACPI_FILTER_DIPM &&
645 tf->nsect == SATA_DIPM)
646 return 1;
648 /* inhibit FPDMA non-zero offset */
649 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_OFFSET &&
650 (tf->nsect == SATA_FPDMA_OFFSET ||
651 tf->nsect == SATA_FPDMA_IN_ORDER))
652 return 1;
654 /* inhibit FPDMA auto activation */
655 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_AA &&
656 tf->nsect == SATA_FPDMA_AA)
657 return 1;
660 return 0;
664 * ata_acpi_run_tf - send taskfile registers to host controller
665 * @dev: target ATA device
666 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
668 * Outputs ATA taskfile to standard ATA host controller using MMIO
669 * or PIO as indicated by the ATA_FLAG_MMIO flag.
670 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
671 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
672 * hob_lbal, hob_lbam, and hob_lbah.
674 * This function waits for idle (!BUSY and !DRQ) after writing
675 * registers. If the control register has a new value, this
676 * function also waits for idle after writing control and before
677 * writing the remaining registers.
679 * LOCKING:
680 * EH context.
682 * RETURNS:
683 * 1 if command is executed successfully. 0 if ignored, rejected or
684 * filtered out, -errno on other errors.
686 static int ata_acpi_run_tf(struct ata_device *dev,
687 const struct ata_acpi_gtf *gtf,
688 const struct ata_acpi_gtf *prev_gtf)
690 struct ata_taskfile *pptf = NULL;
691 struct ata_taskfile tf, ptf, rtf;
692 unsigned int err_mask;
693 const char *level;
694 const char *descr;
695 char msg[60];
696 int rc;
698 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
699 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
700 && (gtf->tf[6] == 0))
701 return 0;
703 ata_acpi_gtf_to_tf(dev, gtf, &tf);
704 if (prev_gtf) {
705 ata_acpi_gtf_to_tf(dev, prev_gtf, &ptf);
706 pptf = &ptf;
709 if (!ata_acpi_filter_tf(dev, &tf, pptf)) {
710 rtf = tf;
711 err_mask = ata_exec_internal(dev, &rtf, NULL,
712 DMA_NONE, NULL, 0, 0);
714 switch (err_mask) {
715 case 0:
716 level = KERN_DEBUG;
717 snprintf(msg, sizeof(msg), "succeeded");
718 rc = 1;
719 break;
721 case AC_ERR_DEV:
722 level = KERN_INFO;
723 snprintf(msg, sizeof(msg),
724 "rejected by device (Stat=0x%02x Err=0x%02x)",
725 rtf.command, rtf.feature);
726 rc = 0;
727 break;
729 default:
730 level = KERN_ERR;
731 snprintf(msg, sizeof(msg),
732 "failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
733 err_mask, rtf.command, rtf.feature);
734 rc = -EIO;
735 break;
737 } else {
738 level = KERN_INFO;
739 snprintf(msg, sizeof(msg), "filtered out");
740 rc = 0;
742 descr = ata_get_cmd_descript(tf.command);
744 ata_dev_printk(dev, level,
745 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x (%s) %s\n",
746 tf.command, tf.feature, tf.nsect, tf.lbal,
747 tf.lbam, tf.lbah, tf.device,
748 (descr ? descr : "unknown"), msg);
750 return rc;
754 * ata_acpi_exec_tfs - get then write drive taskfile settings
755 * @dev: target ATA device
756 * @nr_executed: out parameter for the number of executed commands
758 * Evaluate _GTF and execute returned taskfiles.
760 * LOCKING:
761 * EH context.
763 * RETURNS:
764 * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
765 * -errno on other errors.
767 static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
769 struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
770 int gtf_count, i, rc;
772 /* get taskfiles */
773 rc = ata_dev_get_GTF(dev, &gtf);
774 if (rc < 0)
775 return rc;
776 gtf_count = rc;
778 /* execute them */
779 for (i = 0; i < gtf_count; i++, gtf++) {
780 rc = ata_acpi_run_tf(dev, gtf, pgtf);
781 if (rc < 0)
782 break;
783 if (rc) {
784 (*nr_executed)++;
785 pgtf = gtf;
789 ata_acpi_clear_gtf(dev);
791 if (rc < 0)
792 return rc;
793 return 0;
797 * ata_acpi_push_id - send Identify data to drive
798 * @dev: target ATA device
800 * _SDD ACPI object: for SATA mode only
801 * Must be after Identify (Packet) Device -- uses its data
802 * ATM this function never returns a failure. It is an optional
803 * method and if it fails for whatever reason, we should still
804 * just keep going.
806 * LOCKING:
807 * EH context.
809 * RETURNS:
810 * 0 on success, -errno on failure.
812 static int ata_acpi_push_id(struct ata_device *dev)
814 struct ata_port *ap = dev->link->ap;
815 int err;
816 acpi_status status;
817 struct acpi_object_list input;
818 union acpi_object in_params[1];
820 if (ata_msg_probe(ap))
821 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
822 __func__, dev->devno, ap->port_no);
824 /* Give the drive Identify data to the drive via the _SDD method */
825 /* _SDD: set up input parameters */
826 input.count = 1;
827 input.pointer = in_params;
828 in_params[0].type = ACPI_TYPE_BUFFER;
829 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
830 in_params[0].buffer.pointer = (u8 *)dev->id;
831 /* Output buffer: _SDD has no output */
833 /* It's OK for _SDD to be missing too. */
834 swap_buf_le16(dev->id, ATA_ID_WORDS);
835 status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
836 swap_buf_le16(dev->id, ATA_ID_WORDS);
838 err = ACPI_FAILURE(status) ? -EIO : 0;
839 if (err < 0)
840 ata_dev_printk(dev, KERN_WARNING,
841 "ACPI _SDD failed (AE 0x%x)\n", status);
843 return err;
847 * ata_acpi_on_suspend - ATA ACPI hook called on suspend
848 * @ap: target ATA port
850 * This function is called when @ap is about to be suspended. All
851 * devices are already put to sleep but the port_suspend() callback
852 * hasn't been executed yet. Error return from this function aborts
853 * suspend.
855 * LOCKING:
856 * EH context.
858 * RETURNS:
859 * 0 on success, -errno on failure.
861 int ata_acpi_on_suspend(struct ata_port *ap)
863 /* nada */
864 return 0;
868 * ata_acpi_on_resume - ATA ACPI hook called on resume
869 * @ap: target ATA port
871 * This function is called when @ap is resumed - right after port
872 * itself is resumed but before any EH action is taken.
874 * LOCKING:
875 * EH context.
877 void ata_acpi_on_resume(struct ata_port *ap)
879 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
880 struct ata_device *dev;
882 if (ap->acpi_handle && gtm) {
883 /* _GTM valid */
885 /* restore timing parameters */
886 ata_acpi_stm(ap, gtm);
888 /* _GTF should immediately follow _STM so that it can
889 * use values set by _STM. Cache _GTF result and
890 * schedule _GTF.
892 ata_for_each_dev(dev, &ap->link, ALL) {
893 ata_acpi_clear_gtf(dev);
894 if (ata_dev_enabled(dev) &&
895 ata_dev_get_GTF(dev, NULL) >= 0)
896 dev->flags |= ATA_DFLAG_ACPI_PENDING;
898 } else {
899 /* SATA _GTF needs to be evaulated after _SDD and
900 * there's no reason to evaluate IDE _GTF early
901 * without _STM. Clear cache and schedule _GTF.
903 ata_for_each_dev(dev, &ap->link, ALL) {
904 ata_acpi_clear_gtf(dev);
905 if (ata_dev_enabled(dev))
906 dev->flags |= ATA_DFLAG_ACPI_PENDING;
912 * ata_acpi_set_state - set the port power state
913 * @ap: target ATA port
914 * @state: state, on/off
916 * This function executes the _PS0/_PS3 ACPI method to set the power state.
917 * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
919 void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
921 struct ata_device *dev;
923 if (!ap->acpi_handle || (ap->flags & ATA_FLAG_ACPI_SATA))
924 return;
926 /* channel first and then drives for power on and vica versa
927 for power off */
928 if (state.event == PM_EVENT_ON)
929 acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D0);
931 ata_for_each_dev(dev, &ap->link, ENABLED) {
932 if (dev->acpi_handle)
933 acpi_bus_set_power(dev->acpi_handle,
934 state.event == PM_EVENT_ON ?
935 ACPI_STATE_D0 : ACPI_STATE_D3);
937 if (state.event != PM_EVENT_ON)
938 acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D3);
942 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
943 * @dev: target ATA device
945 * This function is called when @dev is about to be configured.
946 * IDENTIFY data might have been modified after this hook is run.
948 * LOCKING:
949 * EH context.
951 * RETURNS:
952 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
953 * -errno on failure.
955 int ata_acpi_on_devcfg(struct ata_device *dev)
957 struct ata_port *ap = dev->link->ap;
958 struct ata_eh_context *ehc = &ap->link.eh_context;
959 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
960 int nr_executed = 0;
961 int rc;
963 if (!dev->acpi_handle)
964 return 0;
966 /* do we need to do _GTF? */
967 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
968 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
969 return 0;
971 /* do _SDD if SATA */
972 if (acpi_sata) {
973 rc = ata_acpi_push_id(dev);
974 if (rc)
975 goto acpi_err;
978 /* do _GTF */
979 rc = ata_acpi_exec_tfs(dev, &nr_executed);
980 if (rc)
981 goto acpi_err;
983 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
985 /* refresh IDENTIFY page if any _GTF command has been executed */
986 if (nr_executed) {
987 rc = ata_dev_reread_id(dev, 0);
988 if (rc < 0) {
989 ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
990 "after ACPI commands\n");
991 return rc;
995 return 0;
997 acpi_err:
998 /* ignore evaluation failure if we can continue safely */
999 if (rc == -EINVAL && !nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
1000 return 0;
1002 /* fail and let EH retry once more for unknown IO errors */
1003 if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
1004 dev->flags |= ATA_DFLAG_ACPI_FAILED;
1005 return rc;
1008 ata_dev_printk(dev, KERN_WARNING,
1009 "ACPI: failed the second time, disabled\n");
1010 dev->acpi_handle = NULL;
1012 /* We can safely continue if no _GTF command has been executed
1013 * and port is not frozen.
1015 if (!nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
1016 return 0;
1018 return rc;
1022 * ata_acpi_on_disable - ATA ACPI hook called when a device is disabled
1023 * @dev: target ATA device
1025 * This function is called when @dev is about to be disabled.
1027 * LOCKING:
1028 * EH context.
1030 void ata_acpi_on_disable(struct ata_device *dev)
1032 ata_acpi_clear_gtf(dev);