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