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