xref: /openbmc/linux/drivers/ata/libata-acpi.c (revision 22246614)
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/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"
20 
21 #include <acpi/acpi_bus.h>
22 #include <acpi/acnames.h>
23 #include <acpi/acnamesp.h>
24 #include <acpi/acparser.h>
25 #include <acpi/acexcep.h>
26 #include <acpi/acmacros.h>
27 #include <acpi/actypes.h>
28 
29 enum {
30 	ATA_ACPI_FILTER_SETXFER	= 1 << 0,
31 	ATA_ACPI_FILTER_LOCK	= 1 << 1,
32 
33 	ATA_ACPI_FILTER_DEFAULT	= ATA_ACPI_FILTER_SETXFER |
34 				  ATA_ACPI_FILTER_LOCK,
35 };
36 
37 static unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
38 module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
39 MODULE_PARM_DESC(acpi_gtf_filter, "filter mask for ACPI _GTF commands, set to filter out (0x1=set xfermode, 0x2=lock/freeze lock)");
40 
41 #define NO_PORT_MULT		0xffff
42 #define SATA_ADR(root, pmp)	(((root) << 16) | (pmp))
43 
44 #define REGS_PER_GTF		7
45 struct ata_acpi_gtf {
46 	u8	tf[REGS_PER_GTF];	/* regs. 0x1f1 - 0x1f7 */
47 } __packed;
48 
49 /*
50  *	Helper - belongs in the PCI layer somewhere eventually
51  */
52 static int is_pci_dev(struct device *dev)
53 {
54 	return (dev->bus == &pci_bus_type);
55 }
56 
57 static void ata_acpi_clear_gtf(struct ata_device *dev)
58 {
59 	kfree(dev->gtf_cache);
60 	dev->gtf_cache = NULL;
61 }
62 
63 /**
64  * ata_acpi_associate_sata_port - associate SATA port with ACPI objects
65  * @ap: target SATA port
66  *
67  * Look up ACPI objects associated with @ap and initialize acpi_handle
68  * fields of @ap, the port and devices accordingly.
69  *
70  * LOCKING:
71  * EH context.
72  *
73  * RETURNS:
74  * 0 on success, -errno on failure.
75  */
76 void ata_acpi_associate_sata_port(struct ata_port *ap)
77 {
78 	WARN_ON(!(ap->flags & ATA_FLAG_ACPI_SATA));
79 
80 	if (!sata_pmp_attached(ap)) {
81 		acpi_integer adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
82 
83 		ap->link.device->acpi_handle =
84 			acpi_get_child(ap->host->acpi_handle, adr);
85 	} else {
86 		struct ata_link *link;
87 
88 		ap->link.device->acpi_handle = NULL;
89 
90 		ata_port_for_each_link(link, ap) {
91 			acpi_integer adr = SATA_ADR(ap->port_no, link->pmp);
92 
93 			link->device->acpi_handle =
94 				acpi_get_child(ap->host->acpi_handle, adr);
95 		}
96 	}
97 }
98 
99 static void ata_acpi_associate_ide_port(struct ata_port *ap)
100 {
101 	int max_devices, i;
102 
103 	ap->acpi_handle = acpi_get_child(ap->host->acpi_handle, ap->port_no);
104 	if (!ap->acpi_handle)
105 		return;
106 
107 	max_devices = 1;
108 	if (ap->flags & ATA_FLAG_SLAVE_POSS)
109 		max_devices++;
110 
111 	for (i = 0; i < max_devices; i++) {
112 		struct ata_device *dev = &ap->link.device[i];
113 
114 		dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
115 	}
116 
117 	if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
118 		ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
119 }
120 
121 static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
122 				    u32 event)
123 {
124 	char event_string[12];
125 	char *envp[] = { event_string, NULL };
126 	struct ata_eh_info *ehi;
127 	struct kobject *kobj = NULL;
128 	int wait = 0;
129 	unsigned long flags;
130 
131 	if (!ap)
132 		ap = dev->link->ap;
133 	ehi = &ap->link.eh_info;
134 
135 	spin_lock_irqsave(ap->lock, flags);
136 
137 	switch (event) {
138 	case ACPI_NOTIFY_BUS_CHECK:
139 	case ACPI_NOTIFY_DEVICE_CHECK:
140 		ata_ehi_push_desc(ehi, "ACPI event");
141 		ata_ehi_hotplugged(ehi);
142 		ata_port_freeze(ap);
143 		break;
144 
145 	case ACPI_NOTIFY_EJECT_REQUEST:
146 		ata_ehi_push_desc(ehi, "ACPI event");
147 		if (dev)
148 			dev->flags |= ATA_DFLAG_DETACH;
149 		else {
150 			struct ata_link *tlink;
151 			struct ata_device *tdev;
152 
153 			ata_port_for_each_link(tlink, ap)
154 				ata_link_for_each_dev(tdev, tlink)
155 					tdev->flags |= ATA_DFLAG_DETACH;
156 		}
157 
158 		ata_port_schedule_eh(ap);
159 		wait = 1;
160 		break;
161 	}
162 
163 	if (dev) {
164 		if (dev->sdev)
165 			kobj = &dev->sdev->sdev_gendev.kobj;
166 	} else
167 		kobj = &ap->dev->kobj;
168 
169 	if (kobj) {
170 		sprintf(event_string, "BAY_EVENT=%d", event);
171 		kobject_uevent_env(kobj, KOBJ_CHANGE, envp);
172 	}
173 
174 	spin_unlock_irqrestore(ap->lock, flags);
175 
176 	if (wait)
177 		ata_port_wait_eh(ap);
178 }
179 
180 static void ata_acpi_dev_notify(acpi_handle handle, u32 event, void *data)
181 {
182 	struct ata_device *dev = data;
183 
184 	ata_acpi_handle_hotplug(NULL, dev, event);
185 }
186 
187 static void ata_acpi_ap_notify(acpi_handle handle, u32 event, void *data)
188 {
189 	struct ata_port *ap = data;
190 
191 	ata_acpi_handle_hotplug(ap, NULL, event);
192 }
193 
194 /**
195  * ata_acpi_associate - associate ATA host with ACPI objects
196  * @host: target ATA host
197  *
198  * Look up ACPI objects associated with @host and initialize
199  * acpi_handle fields of @host, its ports and devices accordingly.
200  *
201  * LOCKING:
202  * EH context.
203  *
204  * RETURNS:
205  * 0 on success, -errno on failure.
206  */
207 void ata_acpi_associate(struct ata_host *host)
208 {
209 	int i, j;
210 
211 	if (!is_pci_dev(host->dev) || libata_noacpi)
212 		return;
213 
214 	host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
215 	if (!host->acpi_handle)
216 		return;
217 
218 	for (i = 0; i < host->n_ports; i++) {
219 		struct ata_port *ap = host->ports[i];
220 
221 		if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
222 			ata_acpi_associate_sata_port(ap);
223 		else
224 			ata_acpi_associate_ide_port(ap);
225 
226 		if (ap->acpi_handle) {
227 			acpi_install_notify_handler(ap->acpi_handle,
228 						    ACPI_SYSTEM_NOTIFY,
229 						    ata_acpi_ap_notify, ap);
230 			/* we might be on a docking station */
231 			register_hotplug_dock_device(ap->acpi_handle,
232 						     ata_acpi_ap_notify, ap);
233 		}
234 
235 		for (j = 0; j < ata_link_max_devices(&ap->link); j++) {
236 			struct ata_device *dev = &ap->link.device[j];
237 
238 			if (dev->acpi_handle) {
239 				acpi_install_notify_handler(dev->acpi_handle,
240 						ACPI_SYSTEM_NOTIFY,
241 						ata_acpi_dev_notify, dev);
242 				/* we might be on a docking station */
243 				register_hotplug_dock_device(dev->acpi_handle,
244 						ata_acpi_dev_notify, dev);
245 			}
246 		}
247 	}
248 }
249 
250 /**
251  * ata_acpi_dissociate - dissociate ATA host from ACPI objects
252  * @host: target ATA host
253  *
254  * This function is called during driver detach after the whole host
255  * is shut down.
256  *
257  * LOCKING:
258  * EH context.
259  */
260 void ata_acpi_dissociate(struct ata_host *host)
261 {
262 	int i;
263 
264 	/* Restore initial _GTM values so that driver which attaches
265 	 * afterward can use them too.
266 	 */
267 	for (i = 0; i < host->n_ports; i++) {
268 		struct ata_port *ap = host->ports[i];
269 		const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
270 
271 		if (ap->acpi_handle && gtm)
272 			ata_acpi_stm(ap, gtm);
273 	}
274 }
275 
276 /**
277  * ata_acpi_gtm - execute _GTM
278  * @ap: target ATA port
279  * @gtm: out parameter for _GTM result
280  *
281  * Evaluate _GTM and store the result in @gtm.
282  *
283  * LOCKING:
284  * EH context.
285  *
286  * RETURNS:
287  * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
288  */
289 int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
290 {
291 	struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
292 	union acpi_object *out_obj;
293 	acpi_status status;
294 	int rc = 0;
295 
296 	status = acpi_evaluate_object(ap->acpi_handle, "_GTM", NULL, &output);
297 
298 	rc = -ENOENT;
299 	if (status == AE_NOT_FOUND)
300 		goto out_free;
301 
302 	rc = -EINVAL;
303 	if (ACPI_FAILURE(status)) {
304 		ata_port_printk(ap, KERN_ERR,
305 				"ACPI get timing mode failed (AE 0x%x)\n",
306 				status);
307 		goto out_free;
308 	}
309 
310 	out_obj = output.pointer;
311 	if (out_obj->type != ACPI_TYPE_BUFFER) {
312 		ata_port_printk(ap, KERN_WARNING,
313 				"_GTM returned unexpected object type 0x%x\n",
314 				out_obj->type);
315 
316 		goto out_free;
317 	}
318 
319 	if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
320 		ata_port_printk(ap, KERN_ERR,
321 				"_GTM returned invalid length %d\n",
322 				out_obj->buffer.length);
323 		goto out_free;
324 	}
325 
326 	memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
327 	rc = 0;
328  out_free:
329 	kfree(output.pointer);
330 	return rc;
331 }
332 
333 EXPORT_SYMBOL_GPL(ata_acpi_gtm);
334 
335 /**
336  * ata_acpi_stm - execute _STM
337  * @ap: target ATA port
338  * @stm: timing parameter to _STM
339  *
340  * Evaluate _STM with timing parameter @stm.
341  *
342  * LOCKING:
343  * EH context.
344  *
345  * RETURNS:
346  * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
347  */
348 int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
349 {
350 	acpi_status status;
351 	struct ata_acpi_gtm		stm_buf = *stm;
352 	struct acpi_object_list         input;
353 	union acpi_object               in_params[3];
354 
355 	in_params[0].type = ACPI_TYPE_BUFFER;
356 	in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
357 	in_params[0].buffer.pointer = (u8 *)&stm_buf;
358 	/* Buffers for id may need byteswapping ? */
359 	in_params[1].type = ACPI_TYPE_BUFFER;
360 	in_params[1].buffer.length = 512;
361 	in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
362 	in_params[2].type = ACPI_TYPE_BUFFER;
363 	in_params[2].buffer.length = 512;
364 	in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
365 
366 	input.count = 3;
367 	input.pointer = in_params;
368 
369 	status = acpi_evaluate_object(ap->acpi_handle, "_STM", &input, NULL);
370 
371 	if (status == AE_NOT_FOUND)
372 		return -ENOENT;
373 	if (ACPI_FAILURE(status)) {
374 		ata_port_printk(ap, KERN_ERR,
375 			"ACPI set timing mode failed (status=0x%x)\n", status);
376 		return -EINVAL;
377 	}
378 	return 0;
379 }
380 
381 EXPORT_SYMBOL_GPL(ata_acpi_stm);
382 
383 /**
384  * ata_dev_get_GTF - get the drive bootup default taskfile settings
385  * @dev: target ATA device
386  * @gtf: output parameter for buffer containing _GTF taskfile arrays
387  *
388  * This applies to both PATA and SATA drives.
389  *
390  * The _GTF method has no input parameters.
391  * It returns a variable number of register set values (registers
392  * hex 1F1..1F7, taskfiles).
393  * The <variable number> is not known in advance, so have ACPI-CA
394  * allocate the buffer as needed and return it, then free it later.
395  *
396  * LOCKING:
397  * EH context.
398  *
399  * RETURNS:
400  * Number of taskfiles on success, 0 if _GTF doesn't exist.  -EINVAL
401  * if _GTF is invalid.
402  */
403 static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
404 {
405 	struct ata_port *ap = dev->link->ap;
406 	acpi_status status;
407 	struct acpi_buffer output;
408 	union acpi_object *out_obj;
409 	int rc = 0;
410 
411 	/* if _GTF is cached, use the cached value */
412 	if (dev->gtf_cache) {
413 		out_obj = dev->gtf_cache;
414 		goto done;
415 	}
416 
417 	/* set up output buffer */
418 	output.length = ACPI_ALLOCATE_BUFFER;
419 	output.pointer = NULL;	/* ACPI-CA sets this; save/free it later */
420 
421 	if (ata_msg_probe(ap))
422 		ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
423 			       __func__, ap->port_no);
424 
425 	/* _GTF has no input parameters */
426 	status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
427 	out_obj = dev->gtf_cache = output.pointer;
428 
429 	if (ACPI_FAILURE(status)) {
430 		if (status != AE_NOT_FOUND) {
431 			ata_dev_printk(dev, KERN_WARNING,
432 				       "_GTF evaluation failed (AE 0x%x)\n",
433 				       status);
434 			rc = -EINVAL;
435 		}
436 		goto out_free;
437 	}
438 
439 	if (!output.length || !output.pointer) {
440 		if (ata_msg_probe(ap))
441 			ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
442 				"length or ptr is NULL (0x%llx, 0x%p)\n",
443 				__func__,
444 				(unsigned long long)output.length,
445 				output.pointer);
446 		rc = -EINVAL;
447 		goto out_free;
448 	}
449 
450 	if (out_obj->type != ACPI_TYPE_BUFFER) {
451 		ata_dev_printk(dev, KERN_WARNING,
452 			       "_GTF unexpected object type 0x%x\n",
453 			       out_obj->type);
454 		rc = -EINVAL;
455 		goto out_free;
456 	}
457 
458 	if (out_obj->buffer.length % REGS_PER_GTF) {
459 		ata_dev_printk(dev, KERN_WARNING,
460 			       "unexpected _GTF length (%d)\n",
461 			       out_obj->buffer.length);
462 		rc = -EINVAL;
463 		goto out_free;
464 	}
465 
466  done:
467 	rc = out_obj->buffer.length / REGS_PER_GTF;
468 	if (gtf) {
469 		*gtf = (void *)out_obj->buffer.pointer;
470 		if (ata_msg_probe(ap))
471 			ata_dev_printk(dev, KERN_DEBUG,
472 				       "%s: returning gtf=%p, gtf_count=%d\n",
473 				       __func__, *gtf, rc);
474 	}
475 	return rc;
476 
477  out_free:
478 	ata_acpi_clear_gtf(dev);
479 	return rc;
480 }
481 
482 /**
483  * ata_acpi_gtm_xfermode - determine xfermode from GTM parameter
484  * @dev: target device
485  * @gtm: GTM parameter to use
486  *
487  * Determine xfermask for @dev from @gtm.
488  *
489  * LOCKING:
490  * None.
491  *
492  * RETURNS:
493  * Determined xfermask.
494  */
495 unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
496 				    const struct ata_acpi_gtm *gtm)
497 {
498 	unsigned long xfer_mask = 0;
499 	unsigned int type;
500 	int unit;
501 	u8 mode;
502 
503 	/* we always use the 0 slot for crap hardware */
504 	unit = dev->devno;
505 	if (!(gtm->flags & 0x10))
506 		unit = 0;
507 
508 	/* PIO */
509 	mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
510 	xfer_mask |= ata_xfer_mode2mask(mode);
511 
512 	/* See if we have MWDMA or UDMA data. We don't bother with
513 	 * MWDMA if UDMA is available as this means the BIOS set UDMA
514 	 * and our error changedown if it works is UDMA to PIO anyway.
515 	 */
516 	if (!(gtm->flags & (1 << (2 * unit))))
517 		type = ATA_SHIFT_MWDMA;
518 	else
519 		type = ATA_SHIFT_UDMA;
520 
521 	mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
522 	xfer_mask |= ata_xfer_mode2mask(mode);
523 
524 	return xfer_mask;
525 }
526 EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
527 
528 /**
529  * ata_acpi_cbl_80wire		-	Check for 80 wire cable
530  * @ap: Port to check
531  * @gtm: GTM data to use
532  *
533  * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
534  */
535 int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
536 {
537 	struct ata_device *dev;
538 
539 	ata_link_for_each_dev(dev, &ap->link) {
540 		unsigned long xfer_mask, udma_mask;
541 
542 		if (!ata_dev_enabled(dev))
543 			continue;
544 
545 		xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
546 		ata_unpack_xfermask(xfer_mask, NULL, NULL, &udma_mask);
547 
548 		if (udma_mask & ~ATA_UDMA_MASK_40C)
549 			return 1;
550 	}
551 
552 	return 0;
553 }
554 EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
555 
556 static void ata_acpi_gtf_to_tf(struct ata_device *dev,
557 			       const struct ata_acpi_gtf *gtf,
558 			       struct ata_taskfile *tf)
559 {
560 	ata_tf_init(dev, tf);
561 
562 	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
563 	tf->protocol = ATA_PROT_NODATA;
564 	tf->feature = gtf->tf[0];	/* 0x1f1 */
565 	tf->nsect   = gtf->tf[1];	/* 0x1f2 */
566 	tf->lbal    = gtf->tf[2];	/* 0x1f3 */
567 	tf->lbam    = gtf->tf[3];	/* 0x1f4 */
568 	tf->lbah    = gtf->tf[4];	/* 0x1f5 */
569 	tf->device  = gtf->tf[5];	/* 0x1f6 */
570 	tf->command = gtf->tf[6];	/* 0x1f7 */
571 }
572 
573 static int ata_acpi_filter_tf(const struct ata_taskfile *tf,
574 			      const struct ata_taskfile *ptf)
575 {
576 	if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_SETXFER) {
577 		/* libata doesn't use ACPI to configure transfer mode.
578 		 * It will only confuse device configuration.  Skip.
579 		 */
580 		if (tf->command == ATA_CMD_SET_FEATURES &&
581 		    tf->feature == SETFEATURES_XFER)
582 			return 1;
583 	}
584 
585 	if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_LOCK) {
586 		/* BIOS writers, sorry but we don't wanna lock
587 		 * features unless the user explicitly said so.
588 		 */
589 
590 		/* DEVICE CONFIGURATION FREEZE LOCK */
591 		if (tf->command == ATA_CMD_CONF_OVERLAY &&
592 		    tf->feature == ATA_DCO_FREEZE_LOCK)
593 			return 1;
594 
595 		/* SECURITY FREEZE LOCK */
596 		if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
597 			return 1;
598 
599 		/* SET MAX LOCK and SET MAX FREEZE LOCK */
600 		if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
601 		    tf->command == ATA_CMD_SET_MAX &&
602 		    (tf->feature == ATA_SET_MAX_LOCK ||
603 		     tf->feature == ATA_SET_MAX_FREEZE_LOCK))
604 			return 1;
605 	}
606 
607 	return 0;
608 }
609 
610 /**
611  * ata_acpi_run_tf - send taskfile registers to host controller
612  * @dev: target ATA device
613  * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
614  *
615  * Outputs ATA taskfile to standard ATA host controller using MMIO
616  * or PIO as indicated by the ATA_FLAG_MMIO flag.
617  * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
618  * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
619  * hob_lbal, hob_lbam, and hob_lbah.
620  *
621  * This function waits for idle (!BUSY and !DRQ) after writing
622  * registers.  If the control register has a new value, this
623  * function also waits for idle after writing control and before
624  * writing the remaining registers.
625  *
626  * LOCKING:
627  * EH context.
628  *
629  * RETURNS:
630  * 1 if command is executed successfully.  0 if ignored, rejected or
631  * filtered out, -errno on other errors.
632  */
633 static int ata_acpi_run_tf(struct ata_device *dev,
634 			   const struct ata_acpi_gtf *gtf,
635 			   const struct ata_acpi_gtf *prev_gtf)
636 {
637 	struct ata_taskfile *pptf = NULL;
638 	struct ata_taskfile tf, ptf, rtf;
639 	unsigned int err_mask;
640 	const char *level;
641 	char msg[60];
642 	int rc;
643 
644 	if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
645 	    && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
646 	    && (gtf->tf[6] == 0))
647 		return 0;
648 
649 	ata_acpi_gtf_to_tf(dev, gtf, &tf);
650 	if (prev_gtf) {
651 		ata_acpi_gtf_to_tf(dev, prev_gtf, &ptf);
652 		pptf = &ptf;
653 	}
654 
655 	if (!ata_acpi_filter_tf(&tf, pptf)) {
656 		rtf = tf;
657 		err_mask = ata_exec_internal(dev, &rtf, NULL,
658 					     DMA_NONE, NULL, 0, 0);
659 
660 		switch (err_mask) {
661 		case 0:
662 			level = KERN_DEBUG;
663 			snprintf(msg, sizeof(msg), "succeeded");
664 			rc = 1;
665 			break;
666 
667 		case AC_ERR_DEV:
668 			level = KERN_INFO;
669 			snprintf(msg, sizeof(msg),
670 				 "rejected by device (Stat=0x%02x Err=0x%02x)",
671 				 rtf.command, rtf.feature);
672 			rc = 0;
673 			break;
674 
675 		default:
676 			level = KERN_ERR;
677 			snprintf(msg, sizeof(msg),
678 				 "failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
679 				 err_mask, rtf.command, rtf.feature);
680 			rc = -EIO;
681 			break;
682 		}
683 	} else {
684 		level = KERN_INFO;
685 		snprintf(msg, sizeof(msg), "filtered out");
686 		rc = 0;
687 	}
688 
689 	ata_dev_printk(dev, level,
690 		       "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x %s\n",
691 		       tf.command, tf.feature, tf.nsect, tf.lbal,
692 		       tf.lbam, tf.lbah, tf.device, msg);
693 
694 	return rc;
695 }
696 
697 /**
698  * ata_acpi_exec_tfs - get then write drive taskfile settings
699  * @dev: target ATA device
700  * @nr_executed: out paramter for the number of executed commands
701  *
702  * Evaluate _GTF and excute returned taskfiles.
703  *
704  * LOCKING:
705  * EH context.
706  *
707  * RETURNS:
708  * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
709  * -errno on other errors.
710  */
711 static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
712 {
713 	struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
714 	int gtf_count, i, rc;
715 
716 	/* get taskfiles */
717 	rc = ata_dev_get_GTF(dev, &gtf);
718 	if (rc < 0)
719 		return rc;
720 	gtf_count = rc;
721 
722 	/* execute them */
723 	for (i = 0; i < gtf_count; i++, gtf++) {
724 		rc = ata_acpi_run_tf(dev, gtf, pgtf);
725 		if (rc < 0)
726 			break;
727 		if (rc) {
728 			(*nr_executed)++;
729 			pgtf = gtf;
730 		}
731 	}
732 
733 	ata_acpi_clear_gtf(dev);
734 
735 	if (rc < 0)
736 		return rc;
737 	return 0;
738 }
739 
740 /**
741  * ata_acpi_push_id - send Identify data to drive
742  * @dev: target ATA device
743  *
744  * _SDD ACPI object: for SATA mode only
745  * Must be after Identify (Packet) Device -- uses its data
746  * ATM this function never returns a failure.  It is an optional
747  * method and if it fails for whatever reason, we should still
748  * just keep going.
749  *
750  * LOCKING:
751  * EH context.
752  *
753  * RETURNS:
754  * 0 on success, -errno on failure.
755  */
756 static int ata_acpi_push_id(struct ata_device *dev)
757 {
758 	struct ata_port *ap = dev->link->ap;
759 	int err;
760 	acpi_status status;
761 	struct acpi_object_list input;
762 	union acpi_object in_params[1];
763 
764 	if (ata_msg_probe(ap))
765 		ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
766 			       __func__, dev->devno, ap->port_no);
767 
768 	/* Give the drive Identify data to the drive via the _SDD method */
769 	/* _SDD: set up input parameters */
770 	input.count = 1;
771 	input.pointer = in_params;
772 	in_params[0].type = ACPI_TYPE_BUFFER;
773 	in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
774 	in_params[0].buffer.pointer = (u8 *)dev->id;
775 	/* Output buffer: _SDD has no output */
776 
777 	/* It's OK for _SDD to be missing too. */
778 	swap_buf_le16(dev->id, ATA_ID_WORDS);
779 	status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
780 	swap_buf_le16(dev->id, ATA_ID_WORDS);
781 
782 	err = ACPI_FAILURE(status) ? -EIO : 0;
783 	if (err < 0)
784 		ata_dev_printk(dev, KERN_WARNING,
785 			       "ACPI _SDD failed (AE 0x%x)\n", status);
786 
787 	return err;
788 }
789 
790 /**
791  * ata_acpi_on_suspend - ATA ACPI hook called on suspend
792  * @ap: target ATA port
793  *
794  * This function is called when @ap is about to be suspended.  All
795  * devices are already put to sleep but the port_suspend() callback
796  * hasn't been executed yet.  Error return from this function aborts
797  * suspend.
798  *
799  * LOCKING:
800  * EH context.
801  *
802  * RETURNS:
803  * 0 on success, -errno on failure.
804  */
805 int ata_acpi_on_suspend(struct ata_port *ap)
806 {
807 	/* nada */
808 	return 0;
809 }
810 
811 /**
812  * ata_acpi_on_resume - ATA ACPI hook called on resume
813  * @ap: target ATA port
814  *
815  * This function is called when @ap is resumed - right after port
816  * itself is resumed but before any EH action is taken.
817  *
818  * LOCKING:
819  * EH context.
820  */
821 void ata_acpi_on_resume(struct ata_port *ap)
822 {
823 	const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
824 	struct ata_device *dev;
825 
826 	if (ap->acpi_handle && gtm) {
827 		/* _GTM valid */
828 
829 		/* restore timing parameters */
830 		ata_acpi_stm(ap, gtm);
831 
832 		/* _GTF should immediately follow _STM so that it can
833 		 * use values set by _STM.  Cache _GTF result and
834 		 * schedule _GTF.
835 		 */
836 		ata_link_for_each_dev(dev, &ap->link) {
837 			ata_acpi_clear_gtf(dev);
838 			if (ata_dev_enabled(dev) &&
839 			    ata_dev_get_GTF(dev, NULL) >= 0)
840 				dev->flags |= ATA_DFLAG_ACPI_PENDING;
841 		}
842 	} else {
843 		/* SATA _GTF needs to be evaulated after _SDD and
844 		 * there's no reason to evaluate IDE _GTF early
845 		 * without _STM.  Clear cache and schedule _GTF.
846 		 */
847 		ata_link_for_each_dev(dev, &ap->link) {
848 			ata_acpi_clear_gtf(dev);
849 			if (ata_dev_enabled(dev))
850 				dev->flags |= ATA_DFLAG_ACPI_PENDING;
851 		}
852 	}
853 }
854 
855 /**
856  * ata_acpi_set_state - set the port power state
857  * @ap: target ATA port
858  * @state: state, on/off
859  *
860  * This function executes the _PS0/_PS3 ACPI method to set the power state.
861  * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
862  */
863 void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
864 {
865 	struct ata_device *dev;
866 
867 	if (!ap->acpi_handle || (ap->flags & ATA_FLAG_ACPI_SATA))
868 		return;
869 
870 	/* channel first and then drives for power on and vica versa
871 	   for power off */
872 	if (state.event == PM_EVENT_ON)
873 		acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D0);
874 
875 	ata_link_for_each_dev(dev, &ap->link) {
876 		if (dev->acpi_handle && ata_dev_enabled(dev))
877 			acpi_bus_set_power(dev->acpi_handle,
878 				state.event == PM_EVENT_ON ?
879 					ACPI_STATE_D0 : ACPI_STATE_D3);
880 	}
881 	if (state.event != PM_EVENT_ON)
882 		acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D3);
883 }
884 
885 /**
886  * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
887  * @dev: target ATA device
888  *
889  * This function is called when @dev is about to be configured.
890  * IDENTIFY data might have been modified after this hook is run.
891  *
892  * LOCKING:
893  * EH context.
894  *
895  * RETURNS:
896  * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
897  * -errno on failure.
898  */
899 int ata_acpi_on_devcfg(struct ata_device *dev)
900 {
901 	struct ata_port *ap = dev->link->ap;
902 	struct ata_eh_context *ehc = &ap->link.eh_context;
903 	int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
904 	int nr_executed = 0;
905 	int rc;
906 
907 	if (!dev->acpi_handle)
908 		return 0;
909 
910 	/* do we need to do _GTF? */
911 	if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
912 	    !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
913 		return 0;
914 
915 	/* do _SDD if SATA */
916 	if (acpi_sata) {
917 		rc = ata_acpi_push_id(dev);
918 		if (rc)
919 			goto acpi_err;
920 	}
921 
922 	/* do _GTF */
923 	rc = ata_acpi_exec_tfs(dev, &nr_executed);
924 	if (rc)
925 		goto acpi_err;
926 
927 	dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
928 
929 	/* refresh IDENTIFY page if any _GTF command has been executed */
930 	if (nr_executed) {
931 		rc = ata_dev_reread_id(dev, 0);
932 		if (rc < 0) {
933 			ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
934 				       "after ACPI commands\n");
935 			return rc;
936 		}
937 	}
938 
939 	return 0;
940 
941  acpi_err:
942 	/* ignore evaluation failure if we can continue safely */
943 	if (rc == -EINVAL && !nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
944 		return 0;
945 
946 	/* fail and let EH retry once more for unknown IO errors */
947 	if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
948 		dev->flags |= ATA_DFLAG_ACPI_FAILED;
949 		return rc;
950 	}
951 
952 	ata_dev_printk(dev, KERN_WARNING,
953 		       "ACPI: failed the second time, disabled\n");
954 	dev->acpi_handle = NULL;
955 
956 	/* We can safely continue if no _GTF command has been executed
957 	 * and port is not frozen.
958 	 */
959 	if (!nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
960 		return 0;
961 
962 	return rc;
963 }
964 
965 /**
966  * ata_acpi_on_disable - ATA ACPI hook called when a device is disabled
967  * @dev: target ATA device
968  *
969  * This function is called when @dev is about to be disabled.
970  *
971  * LOCKING:
972  * EH context.
973  */
974 void ata_acpi_on_disable(struct ata_device *dev)
975 {
976 	ata_acpi_clear_gtf(dev);
977 }
978