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