3 * Provides ACPI support for PATA/SATA.
5 * Copyright (C) 2006 Intel Corp.
6 * Copyright (C) 2006 Randy Dunlap
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 <linux/slab.h>
19 #include <linux/pm_runtime.h>
20 #include <scsi/scsi_device.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
32 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
35 static void ata_acpi_clear_gtf(struct ata_device *dev)
37 kfree(dev->gtf_cache);
38 dev->gtf_cache = NULL;
41 struct ata_acpi_hotplug_context {
42 struct acpi_hotplug_context hp;
45 struct ata_device *dev;
49 #define ata_hotplug_data(context) (container_of((context), struct ata_acpi_hotplug_context, hp)->data)
52 * ata_dev_acpi_handle - provide the acpi_handle for an ata_device
53 * @dev: the acpi_handle returned will correspond to this device
55 * Returns the acpi_handle for the ACPI namespace object corresponding to
56 * the ata_device passed into the function, or NULL if no such object exists
57 * or ACPI is disabled for this device due to consecutive errors.
59 acpi_handle ata_dev_acpi_handle(struct ata_device *dev)
61 return dev->flags & ATA_DFLAG_ACPI_DISABLED ?
62 NULL : ACPI_HANDLE(&dev->tdev);
65 /* @ap and @dev are the same as ata_acpi_handle_hotplug() */
66 static void ata_acpi_detach_device(struct ata_port *ap, struct ata_device *dev)
69 dev->flags |= ATA_DFLAG_DETACH;
71 struct ata_link *tlink;
72 struct ata_device *tdev;
74 ata_for_each_link(tlink, ap, EDGE)
75 ata_for_each_dev(tdev, tlink, ALL)
76 tdev->flags |= ATA_DFLAG_DETACH;
79 ata_port_schedule_eh(ap);
83 * ata_acpi_handle_hotplug - ACPI event handler backend
84 * @ap: ATA port ACPI event occurred
85 * @dev: ATA device ACPI event occurred (can be NULL)
86 * @event: ACPI event which occurred
88 * All ACPI bay / device realted events end up in this function. If
89 * the event is port-wide @dev is NULL. If the event is specific to a
90 * device, @dev points to it.
92 * Hotplug (as opposed to unplug) notification is always handled as
93 * port-wide while unplug only kills the target device on device-wide
97 * ACPI notify handler context. May sleep.
99 static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
102 struct ata_eh_info *ehi = &ap->link.eh_info;
106 spin_lock_irqsave(ap->lock, flags);
108 * When dock driver calls into the routine, it will always use
109 * ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
110 * ACPI_NOTIFY_EJECT_REQUEST for remove
113 case ACPI_NOTIFY_BUS_CHECK:
114 case ACPI_NOTIFY_DEVICE_CHECK:
115 ata_ehi_push_desc(ehi, "ACPI event");
117 ata_ehi_hotplugged(ehi);
120 case ACPI_NOTIFY_EJECT_REQUEST:
121 ata_ehi_push_desc(ehi, "ACPI event");
123 ata_acpi_detach_device(ap, dev);
128 spin_unlock_irqrestore(ap->lock, flags);
131 ata_port_wait_eh(ap);
134 static int ata_acpi_dev_notify_dock(struct acpi_device *adev, u32 event)
136 struct ata_device *dev = ata_hotplug_data(adev->hp).dev;
137 ata_acpi_handle_hotplug(dev->link->ap, dev, event);
141 static int ata_acpi_ap_notify_dock(struct acpi_device *adev, u32 event)
143 ata_acpi_handle_hotplug(ata_hotplug_data(adev->hp).ap, NULL, event);
147 static void ata_acpi_uevent(struct ata_port *ap, struct ata_device *dev,
150 struct kobject *kobj = NULL;
151 char event_string[20];
152 char *envp[] = { event_string, NULL };
156 kobj = &dev->sdev->sdev_gendev.kobj;
158 kobj = &ap->dev->kobj;
161 snprintf(event_string, 20, "BAY_EVENT=%d", event);
162 kobject_uevent_env(kobj, KOBJ_CHANGE, envp);
166 static void ata_acpi_ap_uevent(struct acpi_device *adev, u32 event)
168 ata_acpi_uevent(ata_hotplug_data(adev->hp).ap, NULL, event);
171 static void ata_acpi_dev_uevent(struct acpi_device *adev, u32 event)
173 struct ata_device *dev = ata_hotplug_data(adev->hp).dev;
174 ata_acpi_uevent(dev->link->ap, dev, event);
177 /* bind acpi handle to pata port */
178 void ata_acpi_bind_port(struct ata_port *ap)
180 struct acpi_device *host_companion = ACPI_COMPANION(ap->host->dev);
181 struct acpi_device *adev;
182 struct ata_acpi_hotplug_context *context;
184 if (libata_noacpi || ap->flags & ATA_FLAG_ACPI_SATA || !host_companion)
187 acpi_preset_companion(&ap->tdev, host_companion, ap->port_no);
189 if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
190 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
192 adev = ACPI_COMPANION(&ap->tdev);
193 if (!adev || adev->hp)
196 context = kzalloc(sizeof(*context), GFP_KERNEL);
200 context->data.ap = ap;
201 acpi_initialize_hp_context(adev, &context->hp, ata_acpi_ap_notify_dock,
205 void ata_acpi_bind_dev(struct ata_device *dev)
207 struct ata_port *ap = dev->link->ap;
208 struct acpi_device *port_companion = ACPI_COMPANION(&ap->tdev);
209 struct acpi_device *host_companion = ACPI_COMPANION(ap->host->dev);
210 struct acpi_device *parent, *adev;
211 struct ata_acpi_hotplug_context *context;
215 * For both sata/pata devices, host companion device is required.
216 * For pata device, port companion device is also required.
218 if (libata_noacpi || !host_companion ||
219 (!(ap->flags & ATA_FLAG_ACPI_SATA) && !port_companion))
222 if (ap->flags & ATA_FLAG_ACPI_SATA) {
223 if (!sata_pmp_attached(ap))
224 adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
226 adr = SATA_ADR(ap->port_no, dev->link->pmp);
227 parent = host_companion;
230 parent = port_companion;
233 acpi_preset_companion(&dev->tdev, parent, adr);
234 adev = ACPI_COMPANION(&dev->tdev);
235 if (!adev || adev->hp)
238 context = kzalloc(sizeof(*context), GFP_KERNEL);
242 context->data.dev = dev;
243 acpi_initialize_hp_context(adev, &context->hp, ata_acpi_dev_notify_dock,
244 ata_acpi_dev_uevent);
248 * ata_acpi_dissociate - dissociate ATA host from ACPI objects
249 * @host: target ATA host
251 * This function is called during driver detach after the whole host
257 void ata_acpi_dissociate(struct ata_host *host)
261 /* Restore initial _GTM values so that driver which attaches
262 * afterward can use them too.
264 for (i = 0; i < host->n_ports; i++) {
265 struct ata_port *ap = host->ports[i];
266 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
268 if (ACPI_HANDLE(&ap->tdev) && gtm)
269 ata_acpi_stm(ap, gtm);
274 * ata_acpi_gtm - execute _GTM
275 * @ap: target ATA port
276 * @gtm: out parameter for _GTM result
278 * Evaluate _GTM and store the result in @gtm.
284 * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
286 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
288 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
289 union acpi_object *out_obj;
292 acpi_handle handle = ACPI_HANDLE(&ap->tdev);
297 status = acpi_evaluate_object(handle, "_GTM", NULL, &output);
300 if (status == AE_NOT_FOUND)
304 if (ACPI_FAILURE(status)) {
305 ata_port_err(ap, "ACPI get timing mode failed (AE 0x%x)\n",
310 out_obj = output.pointer;
311 if (out_obj->type != ACPI_TYPE_BUFFER) {
312 ata_port_warn(ap, "_GTM returned unexpected object type 0x%x\n",
318 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
319 ata_port_err(ap, "_GTM returned invalid length %d\n",
320 out_obj->buffer.length);
324 memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
327 kfree(output.pointer);
331 EXPORT_SYMBOL_GPL(ata_acpi_gtm);
334 * ata_acpi_stm - execute _STM
335 * @ap: target ATA port
336 * @stm: timing parameter to _STM
338 * Evaluate _STM with timing parameter @stm.
344 * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
346 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
349 struct ata_acpi_gtm stm_buf = *stm;
350 struct acpi_object_list input;
351 union acpi_object in_params[3];
353 in_params[0].type = ACPI_TYPE_BUFFER;
354 in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
355 in_params[0].buffer.pointer = (u8 *)&stm_buf;
356 /* Buffers for id may need byteswapping ? */
357 in_params[1].type = ACPI_TYPE_BUFFER;
358 in_params[1].buffer.length = 512;
359 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
360 in_params[2].type = ACPI_TYPE_BUFFER;
361 in_params[2].buffer.length = 512;
362 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
365 input.pointer = in_params;
367 status = acpi_evaluate_object(ACPI_HANDLE(&ap->tdev), "_STM",
370 if (status == AE_NOT_FOUND)
372 if (ACPI_FAILURE(status)) {
373 ata_port_err(ap, "ACPI set timing mode failed (status=0x%x)\n",
380 EXPORT_SYMBOL_GPL(ata_acpi_stm);
383 * ata_dev_get_GTF - get the drive bootup default taskfile settings
384 * @dev: target ATA device
385 * @gtf: output parameter for buffer containing _GTF taskfile arrays
387 * This applies to both PATA and SATA drives.
389 * The _GTF method has no input parameters.
390 * It returns a variable number of register set values (registers
391 * hex 1F1..1F7, taskfiles).
392 * The <variable number> is not known in advance, so have ACPI-CA
393 * allocate the buffer as needed and return it, then free it later.
399 * Number of taskfiles on success, 0 if _GTF doesn't exist. -EINVAL
400 * if _GTF is invalid.
402 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
404 struct ata_port *ap = dev->link->ap;
406 struct acpi_buffer output;
407 union acpi_object *out_obj;
410 /* if _GTF is cached, use the cached value */
411 if (dev->gtf_cache) {
412 out_obj = dev->gtf_cache;
416 /* set up output buffer */
417 output.length = ACPI_ALLOCATE_BUFFER;
418 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
420 if (ata_msg_probe(ap))
421 ata_dev_dbg(dev, "%s: ENTER: port#: %d\n",
422 __func__, ap->port_no);
424 /* _GTF has no input parameters */
425 status = acpi_evaluate_object(ata_dev_acpi_handle(dev), "_GTF", NULL,
427 out_obj = dev->gtf_cache = output.pointer;
429 if (ACPI_FAILURE(status)) {
430 if (status != AE_NOT_FOUND) {
431 ata_dev_warn(dev, "_GTF evaluation failed (AE 0x%x)\n",
438 if (!output.length || !output.pointer) {
439 if (ata_msg_probe(ap))
440 ata_dev_dbg(dev, "%s: Run _GTF: length or ptr is NULL (0x%llx, 0x%p)\n",
442 (unsigned long long)output.length,
448 if (out_obj->type != ACPI_TYPE_BUFFER) {
449 ata_dev_warn(dev, "_GTF unexpected object type 0x%x\n",
455 if (out_obj->buffer.length % REGS_PER_GTF) {
456 ata_dev_warn(dev, "unexpected _GTF length (%d)\n",
457 out_obj->buffer.length);
463 rc = out_obj->buffer.length / REGS_PER_GTF;
465 *gtf = (void *)out_obj->buffer.pointer;
466 if (ata_msg_probe(ap))
467 ata_dev_dbg(dev, "%s: returning gtf=%p, gtf_count=%d\n",
473 ata_acpi_clear_gtf(dev);
478 * ata_acpi_gtm_xfermode - determine xfermode from GTM parameter
479 * @dev: target device
480 * @gtm: GTM parameter to use
482 * Determine xfermask for @dev from @gtm.
488 * Determined xfermask.
490 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
491 const struct ata_acpi_gtm *gtm)
493 unsigned long xfer_mask = 0;
498 /* we always use the 0 slot for crap hardware */
500 if (!(gtm->flags & 0x10))
504 mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
505 xfer_mask |= ata_xfer_mode2mask(mode);
507 /* See if we have MWDMA or UDMA data. We don't bother with
508 * MWDMA if UDMA is available as this means the BIOS set UDMA
509 * and our error changedown if it works is UDMA to PIO anyway.
511 if (!(gtm->flags & (1 << (2 * unit))))
512 type = ATA_SHIFT_MWDMA;
514 type = ATA_SHIFT_UDMA;
516 mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
517 xfer_mask |= ata_xfer_mode2mask(mode);
521 EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
524 * ata_acpi_cbl_80wire - Check for 80 wire cable
526 * @gtm: GTM data to use
528 * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
530 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
532 struct ata_device *dev;
534 ata_for_each_dev(dev, &ap->link, ENABLED) {
535 unsigned long xfer_mask, udma_mask;
537 xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
538 ata_unpack_xfermask(xfer_mask, NULL, NULL, &udma_mask);
540 if (udma_mask & ~ATA_UDMA_MASK_40C)
546 EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
548 static void ata_acpi_gtf_to_tf(struct ata_device *dev,
549 const struct ata_acpi_gtf *gtf,
550 struct ata_taskfile *tf)
552 ata_tf_init(dev, tf);
554 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
555 tf->protocol = ATA_PROT_NODATA;
556 tf->feature = gtf->tf[0]; /* 0x1f1 */
557 tf->nsect = gtf->tf[1]; /* 0x1f2 */
558 tf->lbal = gtf->tf[2]; /* 0x1f3 */
559 tf->lbam = gtf->tf[3]; /* 0x1f4 */
560 tf->lbah = gtf->tf[4]; /* 0x1f5 */
561 tf->device = gtf->tf[5]; /* 0x1f6 */
562 tf->command = gtf->tf[6]; /* 0x1f7 */
565 static int ata_acpi_filter_tf(struct ata_device *dev,
566 const struct ata_taskfile *tf,
567 const struct ata_taskfile *ptf)
569 if (dev->gtf_filter & ATA_ACPI_FILTER_SETXFER) {
570 /* libata doesn't use ACPI to configure transfer mode.
571 * It will only confuse device configuration. Skip.
573 if (tf->command == ATA_CMD_SET_FEATURES &&
574 tf->feature == SETFEATURES_XFER)
578 if (dev->gtf_filter & ATA_ACPI_FILTER_LOCK) {
579 /* BIOS writers, sorry but we don't wanna lock
580 * features unless the user explicitly said so.
583 /* DEVICE CONFIGURATION FREEZE LOCK */
584 if (tf->command == ATA_CMD_CONF_OVERLAY &&
585 tf->feature == ATA_DCO_FREEZE_LOCK)
588 /* SECURITY FREEZE LOCK */
589 if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
592 /* SET MAX LOCK and SET MAX FREEZE LOCK */
593 if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
594 tf->command == ATA_CMD_SET_MAX &&
595 (tf->feature == ATA_SET_MAX_LOCK ||
596 tf->feature == ATA_SET_MAX_FREEZE_LOCK))
600 if (tf->command == ATA_CMD_SET_FEATURES &&
601 tf->feature == SETFEATURES_SATA_ENABLE) {
602 /* inhibit enabling DIPM */
603 if (dev->gtf_filter & ATA_ACPI_FILTER_DIPM &&
604 tf->nsect == SATA_DIPM)
607 /* inhibit FPDMA non-zero offset */
608 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_OFFSET &&
609 (tf->nsect == SATA_FPDMA_OFFSET ||
610 tf->nsect == SATA_FPDMA_IN_ORDER))
613 /* inhibit FPDMA auto activation */
614 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_AA &&
615 tf->nsect == SATA_FPDMA_AA)
623 * ata_acpi_run_tf - send taskfile registers to host controller
624 * @dev: target ATA device
625 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
627 * Outputs ATA taskfile to standard ATA host controller.
628 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
629 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
630 * hob_lbal, hob_lbam, and hob_lbah.
632 * This function waits for idle (!BUSY and !DRQ) after writing
633 * registers. If the control register has a new value, this
634 * function also waits for idle after writing control and before
635 * writing the remaining registers.
641 * 1 if command is executed successfully. 0 if ignored, rejected or
642 * filtered out, -errno on other errors.
644 static int ata_acpi_run_tf(struct ata_device *dev,
645 const struct ata_acpi_gtf *gtf,
646 const struct ata_acpi_gtf *prev_gtf)
648 struct ata_taskfile *pptf = NULL;
649 struct ata_taskfile tf, ptf, rtf;
650 unsigned int err_mask;
656 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
657 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
658 && (gtf->tf[6] == 0))
661 ata_acpi_gtf_to_tf(dev, gtf, &tf);
663 ata_acpi_gtf_to_tf(dev, prev_gtf, &ptf);
667 if (!ata_acpi_filter_tf(dev, &tf, pptf)) {
669 err_mask = ata_exec_internal(dev, &rtf, NULL,
670 DMA_NONE, NULL, 0, 0);
675 snprintf(msg, sizeof(msg), "succeeded");
681 snprintf(msg, sizeof(msg),
682 "rejected by device (Stat=0x%02x Err=0x%02x)",
683 rtf.command, rtf.feature);
689 snprintf(msg, sizeof(msg),
690 "failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
691 err_mask, rtf.command, rtf.feature);
697 snprintf(msg, sizeof(msg), "filtered out");
700 descr = ata_get_cmd_descript(tf.command);
702 ata_dev_printk(dev, level,
703 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x (%s) %s\n",
704 tf.command, tf.feature, tf.nsect, tf.lbal,
705 tf.lbam, tf.lbah, tf.device,
706 (descr ? descr : "unknown"), msg);
712 * ata_acpi_exec_tfs - get then write drive taskfile settings
713 * @dev: target ATA device
714 * @nr_executed: out parameter for the number of executed commands
716 * Evaluate _GTF and execute returned taskfiles.
722 * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
723 * -errno on other errors.
725 static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
727 struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
728 int gtf_count, i, rc;
731 rc = ata_dev_get_GTF(dev, >f);
737 for (i = 0; i < gtf_count; i++, gtf++) {
738 rc = ata_acpi_run_tf(dev, gtf, pgtf);
747 ata_acpi_clear_gtf(dev);
755 * ata_acpi_push_id - send Identify data to drive
756 * @dev: target ATA device
758 * _SDD ACPI object: for SATA mode only
759 * Must be after Identify (Packet) Device -- uses its data
760 * ATM this function never returns a failure. It is an optional
761 * method and if it fails for whatever reason, we should still
768 * 0 on success, -ENOENT if _SDD doesn't exist, -errno on failure.
770 static int ata_acpi_push_id(struct ata_device *dev)
772 struct ata_port *ap = dev->link->ap;
774 struct acpi_object_list input;
775 union acpi_object in_params[1];
777 if (ata_msg_probe(ap))
778 ata_dev_dbg(dev, "%s: ix = %d, port#: %d\n",
779 __func__, dev->devno, ap->port_no);
781 /* Give the drive Identify data to the drive via the _SDD method */
782 /* _SDD: set up input parameters */
784 input.pointer = in_params;
785 in_params[0].type = ACPI_TYPE_BUFFER;
786 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
787 in_params[0].buffer.pointer = (u8 *)dev->id;
788 /* Output buffer: _SDD has no output */
790 /* It's OK for _SDD to be missing too. */
791 swap_buf_le16(dev->id, ATA_ID_WORDS);
792 status = acpi_evaluate_object(ata_dev_acpi_handle(dev), "_SDD", &input,
794 swap_buf_le16(dev->id, ATA_ID_WORDS);
796 if (status == AE_NOT_FOUND)
799 if (ACPI_FAILURE(status)) {
800 ata_dev_warn(dev, "ACPI _SDD failed (AE 0x%x)\n", status);
808 * ata_acpi_on_suspend - ATA ACPI hook called on suspend
809 * @ap: target ATA port
811 * This function is called when @ap is about to be suspended. All
812 * devices are already put to sleep but the port_suspend() callback
813 * hasn't been executed yet. Error return from this function aborts
820 * 0 on success, -errno on failure.
822 int ata_acpi_on_suspend(struct ata_port *ap)
829 * ata_acpi_on_resume - ATA ACPI hook called on resume
830 * @ap: target ATA port
832 * This function is called when @ap is resumed - right after port
833 * itself is resumed but before any EH action is taken.
838 void ata_acpi_on_resume(struct ata_port *ap)
840 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
841 struct ata_device *dev;
843 if (ACPI_HANDLE(&ap->tdev) && gtm) {
846 /* restore timing parameters */
847 ata_acpi_stm(ap, gtm);
849 /* _GTF should immediately follow _STM so that it can
850 * use values set by _STM. Cache _GTF result and
853 ata_for_each_dev(dev, &ap->link, ALL) {
854 ata_acpi_clear_gtf(dev);
855 if (ata_dev_enabled(dev) &&
856 ata_dev_acpi_handle(dev) &&
857 ata_dev_get_GTF(dev, NULL) >= 0)
858 dev->flags |= ATA_DFLAG_ACPI_PENDING;
861 /* SATA _GTF needs to be evaulated after _SDD and
862 * there's no reason to evaluate IDE _GTF early
863 * without _STM. Clear cache and schedule _GTF.
865 ata_for_each_dev(dev, &ap->link, ALL) {
866 ata_acpi_clear_gtf(dev);
867 if (ata_dev_enabled(dev))
868 dev->flags |= ATA_DFLAG_ACPI_PENDING;
873 static int ata_acpi_choose_suspend_state(struct ata_device *dev, bool runtime)
875 int d_max_in = ACPI_STATE_D3_COLD;
880 * For ATAPI, runtime D3 cold is only allowed
881 * for ZPODD in zero power ready state
883 if (dev->class == ATA_DEV_ATAPI &&
884 !(zpodd_dev_enabled(dev) && zpodd_zpready(dev)))
885 d_max_in = ACPI_STATE_D3_HOT;
888 return acpi_pm_device_sleep_state(&dev->tdev, NULL, d_max_in);
891 static void sata_acpi_set_state(struct ata_port *ap, pm_message_t state)
893 bool runtime = PMSG_IS_AUTO(state);
894 struct ata_device *dev;
898 ata_for_each_dev(dev, &ap->link, ENABLED) {
899 handle = ata_dev_acpi_handle(dev);
903 if (!(state.event & PM_EVENT_RESUME)) {
904 acpi_state = ata_acpi_choose_suspend_state(dev, runtime);
905 if (acpi_state == ACPI_STATE_D0)
907 if (runtime && zpodd_dev_enabled(dev) &&
908 acpi_state == ACPI_STATE_D3_COLD)
909 zpodd_enable_run_wake(dev);
910 acpi_bus_set_power(handle, acpi_state);
912 if (runtime && zpodd_dev_enabled(dev))
913 zpodd_disable_run_wake(dev);
914 acpi_bus_set_power(handle, ACPI_STATE_D0);
919 /* ACPI spec requires _PS0 when IDE power on and _PS3 when power off */
920 static void pata_acpi_set_state(struct ata_port *ap, pm_message_t state)
922 struct ata_device *dev;
923 acpi_handle port_handle;
925 port_handle = ACPI_HANDLE(&ap->tdev);
929 /* channel first and then drives for power on and vica versa
931 if (state.event & PM_EVENT_RESUME)
932 acpi_bus_set_power(port_handle, ACPI_STATE_D0);
934 ata_for_each_dev(dev, &ap->link, ENABLED) {
935 acpi_handle dev_handle = ata_dev_acpi_handle(dev);
939 acpi_bus_set_power(dev_handle, state.event & PM_EVENT_RESUME ?
940 ACPI_STATE_D0 : ACPI_STATE_D3_COLD);
943 if (!(state.event & PM_EVENT_RESUME))
944 acpi_bus_set_power(port_handle, ACPI_STATE_D3_COLD);
948 * ata_acpi_set_state - set the port power state
949 * @ap: target ATA port
950 * @state: state, on/off
952 * This function sets a proper ACPI D state for the device on
953 * system and runtime PM operations.
955 void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
957 if (ap->flags & ATA_FLAG_ACPI_SATA)
958 sata_acpi_set_state(ap, state);
960 pata_acpi_set_state(ap, state);
964 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
965 * @dev: target ATA device
967 * This function is called when @dev is about to be configured.
968 * IDENTIFY data might have been modified after this hook is run.
974 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
977 int ata_acpi_on_devcfg(struct ata_device *dev)
979 struct ata_port *ap = dev->link->ap;
980 struct ata_eh_context *ehc = &ap->link.eh_context;
981 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
985 if (!ata_dev_acpi_handle(dev))
988 /* do we need to do _GTF? */
989 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
990 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
993 /* do _SDD if SATA */
995 rc = ata_acpi_push_id(dev);
996 if (rc && rc != -ENOENT)
1001 rc = ata_acpi_exec_tfs(dev, &nr_executed);
1005 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
1007 /* refresh IDENTIFY page if any _GTF command has been executed */
1009 rc = ata_dev_reread_id(dev, 0);
1012 "failed to IDENTIFY after ACPI commands\n");
1020 /* ignore evaluation failure if we can continue safely */
1021 if (rc == -EINVAL && !nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
1024 /* fail and let EH retry once more for unknown IO errors */
1025 if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
1026 dev->flags |= ATA_DFLAG_ACPI_FAILED;
1030 dev->flags |= ATA_DFLAG_ACPI_DISABLED;
1031 ata_dev_warn(dev, "ACPI: failed the second time, disabled\n");
1033 /* We can safely continue if no _GTF command has been executed
1034 * and port is not frozen.
1036 if (!nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
1043 * ata_acpi_on_disable - ATA ACPI hook called when a device is disabled
1044 * @dev: target ATA device
1046 * This function is called when @dev is about to be disabled.
1051 void ata_acpi_on_disable(struct ata_device *dev)
1053 ata_acpi_clear_gtf(dev);