blob: ac176da1f94e24d8b4bbe683a44f155cb2f06970 [file] [log] [blame]
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -07001/*
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
Tejun Heo3264a8d2007-12-15 15:05:06 +09009#include <linux/module.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070010#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>
Matthew Garrett237d8442007-10-03 01:24:16 +010018#include <scsi/scsi_device.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070019#include "libata.h"
20
21#include <acpi/acpi_bus.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070022
Tejun Heo3264a8d2007-12-15 15:05:06 +090023enum {
24 ATA_ACPI_FILTER_SETXFER = 1 << 0,
25 ATA_ACPI_FILTER_LOCK = 1 << 1,
Tejun Heob3449912008-07-06 23:15:03 +090026 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heo3264a8d2007-12-15 15:05:06 +090027
28 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
Tejun Heob3449912008-07-06 23:15:03 +090029 ATA_ACPI_FILTER_LOCK |
30 ATA_ACPI_FILTER_DIPM,
Tejun Heo3264a8d2007-12-15 15:05:06 +090031};
32
33static unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
34module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
Tejun Heob3449912008-07-06 23:15:03 +090035MODULE_PARM_DESC(acpi_gtf_filter, "filter mask for ACPI _GTF commands, set to filter out (0x1=set xfermode, 0x2=lock/freeze lock, 0x4=DIPM)");
Tejun Heo3264a8d2007-12-15 15:05:06 +090036
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070037#define NO_PORT_MULT 0xffff
Jeff Garzik2dcb4072007-10-19 06:42:56 -040038#define SATA_ADR(root, pmp) (((root) << 16) | (pmp))
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070039
40#define REGS_PER_GTF 7
Tejun Heo4700c4b2007-05-15 03:28:16 +090041struct ata_acpi_gtf {
42 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
43} __packed;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070044
Alan Coxca426632007-03-08 23:13:50 +000045/*
46 * Helper - belongs in the PCI layer somewhere eventually
47 */
48static int is_pci_dev(struct device *dev)
49{
50 return (dev->bus == &pci_bus_type);
51}
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070052
Tejun Heo398e0782007-12-15 15:05:03 +090053static void ata_acpi_clear_gtf(struct ata_device *dev)
54{
55 kfree(dev->gtf_cache);
56 dev->gtf_cache = NULL;
57}
58
Tejun Heod0df8b5d2007-09-23 13:19:54 +090059/**
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 */
72void ata_acpi_associate_sata_port(struct ata_port *ap)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070073{
Tejun Heod0df8b5d2007-09-23 13:19:54 +090074 WARN_ON(!(ap->flags & ATA_FLAG_ACPI_SATA));
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070075
Tejun Heo071f44b2008-04-07 22:47:22 +090076 if (!sata_pmp_attached(ap)) {
Tejun Heod0df8b5d2007-09-23 13:19:54 +090077 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
Tejun Heo1eca4362008-11-03 20:03:17 +090086 ata_for_each_link(link, ap, EDGE) {
Tejun Heod0df8b5d2007-09-23 13:19:54 +090087 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 }
Tejun Heofafbae82007-05-15 03:28:16 +090093}
Alan Coxca426632007-03-08 23:13:50 +000094
Tejun Heofafbae82007-05-15 03:28:16 +090095static 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++) {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900108 struct ata_device *dev = &ap->link.device[i];
Tejun Heofafbae82007-05-15 03:28:16 +0900109
110 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
111 }
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900112
113 if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
114 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700115}
116
Holger Macht664d0802008-06-03 20:27:59 +0200117/* @ap and @dev are the same as ata_acpi_handle_hotplug() */
118static 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
Tejun Heo1eca4362008-11-03 20:03:17 +0900126 ata_for_each_link(tlink, ap, EDGE)
127 ata_for_each_dev(tdev, tlink, ALL)
Holger Macht664d0802008-06-03 20:27:59 +0200128 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
Holger Macht664d0802008-06-03 20:27:59 +0200139 *
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 */
151static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
Shaohua Lif730ae12008-08-28 10:05:45 +0800152 u32 event)
Matthew Garrett237d8442007-10-03 01:24:16 +0100153{
Holger Macht664d0802008-06-03 20:27:59 +0200154 struct ata_eh_info *ehi = &ap->link.eh_info;
Tejun Heo233f1122008-03-12 14:24:43 +0900155 int wait = 0;
156 unsigned long flags;
Shaohua Lif730ae12008-08-28 10:05:45 +0800157 acpi_handle handle;
Jeff Garzikc85665f2008-05-19 17:56:10 -0400158
Shaohua Lif730ae12008-08-28 10:05:45 +0800159 if (dev)
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100160 handle = dev->acpi_handle;
Shaohua Lif730ae12008-08-28 10:05:45 +0800161 else
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100162 handle = ap->acpi_handle;
Zhang Rui3c1e3892008-07-11 09:42:03 -0400163
Holger Macht664d0802008-06-03 20:27:59 +0200164 spin_lock_irqsave(ap->lock, flags);
Shaohua Lif730ae12008-08-28 10:05:45 +0800165 /*
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 */
Tejun Heo233f1122008-03-12 14:24:43 +0900170 switch (event) {
171 case ACPI_NOTIFY_BUS_CHECK:
172 case ACPI_NOTIFY_DEVICE_CHECK:
173 ata_ehi_push_desc(ehi, "ACPI event");
Jeff Garzikc85665f2008-05-19 17:56:10 -0400174
Shaohua Lif730ae12008-08-28 10:05:45 +0800175 ata_ehi_hotplugged(ehi);
176 ata_port_freeze(ap);
Holger Macht664d0802008-06-03 20:27:59 +0200177 break;
178 case ACPI_NOTIFY_EJECT_REQUEST:
179 ata_ehi_push_desc(ehi, "ACPI event");
180
Holger Macht664d0802008-06-03 20:27:59 +0200181 ata_acpi_detach_device(ap, dev);
182 wait = 1;
183 break;
Matthew Garrett237d8442007-10-03 01:24:16 +0100184 }
185
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100186 spin_unlock_irqrestore(ap->lock, flags);
187
Shaohua Lif730ae12008-08-28 10:05:45 +0800188 if (wait)
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100189 ata_port_wait_eh(ap);
Holger Macht664d0802008-06-03 20:27:59 +0200190}
191
192static void ata_acpi_dev_notify_dock(acpi_handle handle, u32 event, void *data)
193{
194 struct ata_device *dev = data;
195
Shaohua Lif730ae12008-08-28 10:05:45 +0800196 ata_acpi_handle_hotplug(dev->link->ap, dev, event);
Holger Macht664d0802008-06-03 20:27:59 +0200197}
198
199static void ata_acpi_ap_notify_dock(acpi_handle handle, u32 event, void *data)
200{
201 struct ata_port *ap = data;
202
Shaohua Lif730ae12008-08-28 10:05:45 +0800203 ata_acpi_handle_hotplug(ap, NULL, event);
Matthew Garrett237d8442007-10-03 01:24:16 +0100204}
205
Shaohua Li1253f7a2008-08-28 10:06:16 +0800206static 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
225static void ata_acpi_ap_uevent(acpi_handle handle, u32 event, void *data)
226{
227 ata_acpi_uevent(data, NULL, event);
228}
229
230static 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
236static struct acpi_dock_ops ata_acpi_dev_dock_ops = {
237 .handler = ata_acpi_dev_notify_dock,
238 .uevent = ata_acpi_dev_uevent,
239};
240
241static struct acpi_dock_ops ata_acpi_ap_dock_ops = {
242 .handler = ata_acpi_ap_notify_dock,
243 .uevent = ata_acpi_ap_uevent,
244};
245
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700246/**
Tejun Heofafbae82007-05-15 03:28:16 +0900247 * ata_acpi_associate - associate ATA host with ACPI objects
248 * @host: target ATA host
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700249 *
Tejun Heofafbae82007-05-15 03:28:16 +0900250 * Look up ACPI objects associated with @host and initialize
251 * acpi_handle fields of @host, its ports and devices accordingly.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700252 *
Tejun Heofafbae82007-05-15 03:28:16 +0900253 * LOCKING:
254 * EH context.
255 *
256 * RETURNS:
257 * 0 on success, -errno on failure.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700258 */
Tejun Heofafbae82007-05-15 03:28:16 +0900259void ata_acpi_associate(struct ata_host *host)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700260{
Matthew Garrett237d8442007-10-03 01:24:16 +0100261 int i, j;
Alan Coxca426632007-03-08 23:13:50 +0000262
Tejun Heofafbae82007-05-15 03:28:16 +0900263 if (!is_pci_dev(host->dev) || libata_noacpi)
264 return;
Alan Coxca426632007-03-08 23:13:50 +0000265
Tejun Heofafbae82007-05-15 03:28:16 +0900266 host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
267 if (!host->acpi_handle)
268 return;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700269
Tejun Heofafbae82007-05-15 03:28:16 +0900270 for (i = 0; i < host->n_ports; i++) {
271 struct ata_port *ap = host->ports[i];
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700272
Tejun Heofafbae82007-05-15 03:28:16 +0900273 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);
Matthew Garrett237d8442007-10-03 01:24:16 +0100277
Tejun Heo233f1122008-03-12 14:24:43 +0900278 if (ap->acpi_handle) {
Tejun Heo233f1122008-03-12 14:24:43 +0900279 /* we might be on a docking station */
280 register_hotplug_dock_device(ap->acpi_handle,
Shaohua Li1253f7a2008-08-28 10:06:16 +0800281 &ata_acpi_ap_dock_ops, ap);
Tejun Heo233f1122008-03-12 14:24:43 +0900282 }
Matthew Garrett237d8442007-10-03 01:24:16 +0100283
284 for (j = 0; j < ata_link_max_devices(&ap->link); j++) {
285 struct ata_device *dev = &ap->link.device[j];
286
Tejun Heo233f1122008-03-12 14:24:43 +0900287 if (dev->acpi_handle) {
Tejun Heo233f1122008-03-12 14:24:43 +0900288 /* we might be on a docking station */
289 register_hotplug_dock_device(dev->acpi_handle,
Shaohua Li1253f7a2008-08-28 10:06:16 +0800290 &ata_acpi_dev_dock_ops, dev);
Tejun Heo233f1122008-03-12 14:24:43 +0900291 }
Matthew Garrett237d8442007-10-03 01:24:16 +0100292 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700293 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700294}
295
296/**
Tejun Heo562f0c22007-12-15 15:05:01 +0900297 * 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 */
306void ata_acpi_dissociate(struct ata_host *host)
307{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900308 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 }
Tejun Heo562f0c22007-12-15 15:05:01 +0900320}
321
322/**
Tejun Heo64578a32007-05-15 03:28:16 +0900323 * 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 */
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900335int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
Tejun Heo64578a32007-05-15 03:28:16 +0900336{
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
Alan Coxbadff032007-10-04 21:28:18 +0100379EXPORT_SYMBOL_GPL(ata_acpi_gtm);
380
Tejun Heo64578a32007-05-15 03:28:16 +0900381/**
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 */
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900394int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
Tejun Heo64578a32007-05-15 03:28:16 +0900395{
396 acpi_status status;
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900397 struct ata_acpi_gtm stm_buf = *stm;
Tejun Heo64578a32007-05-15 03:28:16 +0900398 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);
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900403 in_params[0].buffer.pointer = (u8 *)&stm_buf;
Tejun Heo64578a32007-05-15 03:28:16 +0900404 /* Buffers for id may need byteswapping ? */
405 in_params[1].type = ACPI_TYPE_BUFFER;
406 in_params[1].buffer.length = 512;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900407 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
Tejun Heo64578a32007-05-15 03:28:16 +0900408 in_params[2].type = ACPI_TYPE_BUFFER;
409 in_params[2].buffer.length = 512;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900410 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
Tejun Heo64578a32007-05-15 03:28:16 +0900411
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
Alan Coxbadff032007-10-04 21:28:18 +0100427EXPORT_SYMBOL_GPL(ata_acpi_stm);
428
Tejun Heo64578a32007-05-15 03:28:16 +0900429/**
Tejun Heo4700c4b2007-05-15 03:28:16 +0900430 * ata_dev_get_GTF - get the drive bootup default taskfile settings
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900431 * @dev: target ATA device
Tejun Heo4700c4b2007-05-15 03:28:16 +0900432 * @gtf: output parameter for buffer containing _GTF taskfile arrays
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700433 *
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 *
Tejun Heo4700c4b2007-05-15 03:28:16 +0900442 * LOCKING:
443 * EH context.
444 *
445 * RETURNS:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900446 * Number of taskfiles on success, 0 if _GTF doesn't exist. -EINVAL
447 * if _GTF is invalid.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700448 */
Tejun Heo398e0782007-12-15 15:05:03 +0900449static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700450{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900451 struct ata_port *ap = dev->link->ap;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900452 acpi_status status;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900453 struct acpi_buffer output;
454 union acpi_object *out_obj;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900455 int rc = 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700456
Tejun Heo398e0782007-12-15 15:05:03 +0900457 /* if _GTF is cached, use the cached value */
458 if (dev->gtf_cache) {
459 out_obj = dev->gtf_cache;
460 goto done;
461 }
462
Tejun Heo4700c4b2007-05-15 03:28:16 +0900463 /* set up output buffer */
464 output.length = ACPI_ALLOCATE_BUFFER;
465 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700466
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700467 if (ata_msg_probe(ap))
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900468 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800469 __func__, ap->port_no);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700470
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700471 /* _GTF has no input parameters */
Tejun Heo4700c4b2007-05-15 03:28:16 +0900472 status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
Tejun Heo398e0782007-12-15 15:05:03 +0900473 out_obj = dev->gtf_cache = output.pointer;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900474
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700475 if (ACPI_FAILURE(status)) {
Tejun Heo4700c4b2007-05-15 03:28:16 +0900476 if (status != AE_NOT_FOUND) {
477 ata_dev_printk(dev, KERN_WARNING,
478 "_GTF evaluation failed (AE 0x%x)\n",
479 status);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900480 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900481 }
482 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700483 }
484
485 if (!output.length || !output.pointer) {
486 if (ata_msg_probe(ap))
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900487 ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700488 "length or ptr is NULL (0x%llx, 0x%p)\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800489 __func__,
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700490 (unsigned long long)output.length,
491 output.pointer);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900492 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900493 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700494 }
495
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700496 if (out_obj->type != ACPI_TYPE_BUFFER) {
Tejun Heo69b16a52007-05-15 03:28:16 +0900497 ata_dev_printk(dev, KERN_WARNING,
498 "_GTF unexpected object type 0x%x\n",
499 out_obj->type);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900500 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900501 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700502 }
503
Tejun Heo4700c4b2007-05-15 03:28:16 +0900504 if (out_obj->buffer.length % REGS_PER_GTF) {
Tejun Heo69b16a52007-05-15 03:28:16 +0900505 ata_dev_printk(dev, KERN_WARNING,
506 "unexpected _GTF length (%d)\n",
507 out_obj->buffer.length);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900508 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900509 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700510 }
511
Tejun Heo398e0782007-12-15 15:05:03 +0900512 done:
Tejun Heo4700c4b2007-05-15 03:28:16 +0900513 rc = out_obj->buffer.length / REGS_PER_GTF;
Tejun Heo398e0782007-12-15 15:05:03 +0900514 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",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800519 __func__, *gtf, rc);
Tejun Heo398e0782007-12-15 15:05:03 +0900520 }
Tejun Heo4700c4b2007-05-15 03:28:16 +0900521 return rc;
522
523 out_free:
Tejun Heo398e0782007-12-15 15:05:03 +0900524 ata_acpi_clear_gtf(dev);
Tejun Heo4700c4b2007-05-15 03:28:16 +0900525 return rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700526}
527
Tejun Heo7c77fa42007-12-18 16:33:03 +0900528/**
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 */
541unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
542 const struct ata_acpi_gtm *gtm)
543{
Tejun Heoa0f79b92007-12-18 16:33:05 +0900544 unsigned long xfer_mask = 0;
545 unsigned int type;
546 int unit;
547 u8 mode;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900548
549 /* we always use the 0 slot for crap hardware */
550 unit = dev->devno;
551 if (!(gtm->flags & 0x10))
552 unit = 0;
553
Tejun Heoa0f79b92007-12-18 16:33:05 +0900554 /* PIO */
555 mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
556 xfer_mask |= ata_xfer_mode2mask(mode);
Tejun Heo7c77fa42007-12-18 16:33:03 +0900557
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 */
Tejun Heoa0f79b92007-12-18 16:33:05 +0900562 if (!(gtm->flags & (1 << (2 * unit))))
563 type = ATA_SHIFT_MWDMA;
564 else
565 type = ATA_SHIFT_UDMA;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900566
Tejun Heoa0f79b92007-12-18 16:33:05 +0900567 mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
568 xfer_mask |= ata_xfer_mode2mask(mode);
569
570 return xfer_mask;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900571}
572EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
573
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700574/**
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400575 * ata_acpi_cbl_80wire - Check for 80 wire cable
576 * @ap: Port to check
Tejun Heo021ee9a2007-12-18 16:33:06 +0900577 * @gtm: GTM data to use
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400578 *
Tejun Heo021ee9a2007-12-18 16:33:06 +0900579 * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400580 */
Tejun Heo021ee9a2007-12-18 16:33:06 +0900581int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400582{
Tejun Heo021ee9a2007-12-18 16:33:06 +0900583 struct ata_device *dev;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400584
Tejun Heo1eca4362008-11-03 20:03:17 +0900585 ata_for_each_dev(dev, &ap->link, ENABLED) {
Tejun Heo021ee9a2007-12-18 16:33:06 +0900586 unsigned long xfer_mask, udma_mask;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400587
Tejun Heo021ee9a2007-12-18 16:33:06 +0900588 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
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400595 return 0;
596}
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400597EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
598
Tejun Heo3264a8d2007-12-15 15:05:06 +0900599static 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
616static 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
Tejun Heob3449912008-07-06 23:15:03 +0900650 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
Tejun Heo3264a8d2007-12-15 15:05:06 +0900658 return 0;
659}
660
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400661/**
Tejun Heo0e8634b2007-12-15 15:05:05 +0900662 * ata_acpi_run_tf - send taskfile registers to host controller
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900663 * @dev: target ATA device
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700664 * @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 *
Tejun Heo4700c4b2007-05-15 03:28:16 +0900677 * LOCKING:
678 * EH context.
679 *
680 * RETURNS:
Tejun Heo3264a8d2007-12-15 15:05:06 +0900681 * 1 if command is executed successfully. 0 if ignored, rejected or
682 * filtered out, -errno on other errors.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700683 */
Tejun Heo0e8634b2007-12-15 15:05:05 +0900684static int ata_acpi_run_tf(struct ata_device *dev,
Tejun Heo3264a8d2007-12-15 15:05:06 +0900685 const struct ata_acpi_gtf *gtf,
686 const struct ata_acpi_gtf *prev_gtf)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700687{
Tejun Heo3264a8d2007-12-15 15:05:06 +0900688 struct ata_taskfile *pptf = NULL;
689 struct ata_taskfile tf, ptf, rtf;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900690 unsigned int err_mask;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900691 const char *level;
692 char msg[60];
693 int rc;
Jeff Garzikfc16c252007-02-24 21:05:01 -0500694
Tejun Heo4700c4b2007-05-15 03:28:16 +0900695 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;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700699
Tejun Heo3264a8d2007-12-15 15:05:06 +0900700 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 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700705
Tejun Heo3264a8d2007-12-15 15:05:06 +0900706 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);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700710
Tejun Heo3264a8d2007-12-15 15:05:06 +0900711 switch (err_mask) {
712 case 0:
713 level = KERN_DEBUG;
714 snprintf(msg, sizeof(msg), "succeeded");
715 rc = 1;
716 break;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900717
Tejun Heo3264a8d2007-12-15 15:05:06 +0900718 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;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900725
Tejun Heo3264a8d2007-12-15 15:05:06 +0900726 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 {
Tejun Heo0e8634b2007-12-15 15:05:05 +0900735 level = KERN_INFO;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900736 snprintf(msg, sizeof(msg), "filtered out");
Tejun Heo0e8634b2007-12-15 15:05:05 +0900737 rc = 0;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900738 }
739
Tejun Heo0e8634b2007-12-15 15:05:05 +0900740 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;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700746}
747
748/**
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700749 * ata_acpi_exec_tfs - get then write drive taskfile settings
Tejun Heo67465442007-05-15 03:28:16 +0900750 * @dev: target ATA device
Martin Olsson98a17082009-04-22 18:21:29 +0200751 * @nr_executed: out parameter for the number of executed commands
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700752 *
Martin Olsson98a17082009-04-22 18:21:29 +0200753 * Evaluate _GTF and execute returned taskfiles.
Tejun Heo69b16a52007-05-15 03:28:16 +0900754 *
755 * LOCKING:
756 * EH context.
757 *
758 * RETURNS:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900759 * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
760 * -errno on other errors.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700761 */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900762static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700763{
Tejun Heo3264a8d2007-12-15 15:05:06 +0900764 struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
Tejun Heo67465442007-05-15 03:28:16 +0900765 int gtf_count, i, rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700766
Tejun Heo67465442007-05-15 03:28:16 +0900767 /* get taskfiles */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900768 rc = ata_dev_get_GTF(dev, &gtf);
769 if (rc < 0)
770 return rc;
771 gtf_count = rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700772
Tejun Heo67465442007-05-15 03:28:16 +0900773 /* execute them */
Tejun Heo3264a8d2007-12-15 15:05:06 +0900774 for (i = 0; i < gtf_count; i++, gtf++) {
775 rc = ata_acpi_run_tf(dev, gtf, pgtf);
Tejun Heo0e8634b2007-12-15 15:05:05 +0900776 if (rc < 0)
777 break;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900778 if (rc) {
Tejun Heo0e8634b2007-12-15 15:05:05 +0900779 (*nr_executed)++;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900780 pgtf = gtf;
781 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700782 }
783
Tejun Heo398e0782007-12-15 15:05:03 +0900784 ata_acpi_clear_gtf(dev);
Tejun Heo67465442007-05-15 03:28:16 +0900785
Tejun Heo0e8634b2007-12-15 15:05:05 +0900786 if (rc < 0)
787 return rc;
788 return 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700789}
790
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700791/**
792 * ata_acpi_push_id - send Identify data to drive
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900793 * @dev: target ATA device
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700794 *
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.
Tejun Heo69b16a52007-05-15 03:28:16 +0900800 *
801 * LOCKING:
802 * EH context.
803 *
804 * RETURNS:
805 * 0 on success, -errno on failure.
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700806 */
Tejun Heo67465442007-05-15 03:28:16 +0900807static int ata_acpi_push_id(struct ata_device *dev)
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700808{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900809 struct ata_port *ap = dev->link->ap;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900810 int err;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900811 acpi_status status;
812 struct acpi_object_list input;
813 union acpi_object in_params[1];
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700814
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700815 if (ata_msg_probe(ap))
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900816 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800817 __func__, dev->devno, ap->port_no);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700818
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700819 /* 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;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900824 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
825 in_params[0].buffer.pointer = (u8 *)dev->id;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700826 /* Output buffer: _SDD has no output */
827
828 /* It's OK for _SDD to be missing too. */
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900829 swap_buf_le16(dev->id, ATA_ID_WORDS);
Tejun Heofafbae82007-05-15 03:28:16 +0900830 status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900831 swap_buf_le16(dev->id, ATA_ID_WORDS);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700832
833 err = ACPI_FAILURE(status) ? -EIO : 0;
Tejun Heo69b16a52007-05-15 03:28:16 +0900834 if (err < 0)
835 ata_dev_printk(dev, KERN_WARNING,
836 "ACPI _SDD failed (AE 0x%x)\n", status);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700837
Tejun Heo67465442007-05-15 03:28:16 +0900838 return err;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700839}
840
Tejun Heo67465442007-05-15 03:28:16 +0900841/**
Tejun Heo64578a32007-05-15 03:28:16 +0900842 * 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 */
856int ata_acpi_on_suspend(struct ata_port *ap)
857{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900858 /* nada */
859 return 0;
Tejun Heo64578a32007-05-15 03:28:16 +0900860}
861
862/**
Tejun Heo67465442007-05-15 03:28:16 +0900863 * 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 */
872void ata_acpi_on_resume(struct ata_port *ap)
873{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900874 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
Tejun Heof58229f2007-08-06 18:36:23 +0900875 struct ata_device *dev;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700876
Tejun Heo398e0782007-12-15 15:05:03 +0900877 if (ap->acpi_handle && gtm) {
878 /* _GTM valid */
879
880 /* restore timing parameters */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900881 ata_acpi_stm(ap, gtm);
Tejun Heo64578a32007-05-15 03:28:16 +0900882
Tejun Heo398e0782007-12-15 15:05:03 +0900883 /* _GTF should immediately follow _STM so that it can
884 * use values set by _STM. Cache _GTF result and
885 * schedule _GTF.
886 */
Tejun Heo1eca4362008-11-03 20:03:17 +0900887 ata_for_each_dev(dev, &ap->link, ALL) {
Tejun Heo398e0782007-12-15 15:05:03 +0900888 ata_acpi_clear_gtf(dev);
Shaohua Li48feb3c2008-03-25 16:50:45 +0800889 if (ata_dev_enabled(dev) &&
890 ata_dev_get_GTF(dev, NULL) >= 0)
Tejun Heo398e0782007-12-15 15:05:03 +0900891 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 */
Tejun Heo1eca4362008-11-03 20:03:17 +0900898 ata_for_each_dev(dev, &ap->link, ALL) {
Tejun Heo398e0782007-12-15 15:05:03 +0900899 ata_acpi_clear_gtf(dev);
Shaohua Li48feb3c2008-03-25 16:50:45 +0800900 if (ata_dev_enabled(dev))
901 dev->flags |= ATA_DFLAG_ACPI_PENDING;
Tejun Heo398e0782007-12-15 15:05:03 +0900902 }
903 }
Tejun Heo67465442007-05-15 03:28:16 +0900904}
905
906/**
Shaohua Libd3adca2007-11-02 09:32:38 +0800907 * 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 */
914void 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
Tejun Heo1eca4362008-11-03 20:03:17 +0900926 ata_for_each_dev(dev, &ap->link, ENABLED) {
927 if (dev->acpi_handle)
Shaohua Libd3adca2007-11-02 09:32:38 +0800928 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/**
Tejun Heo67465442007-05-15 03:28:16 +0900937 * 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 */
950int ata_acpi_on_devcfg(struct ata_device *dev)
951{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900952 struct ata_port *ap = dev->link->ap;
953 struct ata_eh_context *ehc = &ap->link.eh_context;
Tejun Heo67465442007-05-15 03:28:16 +0900954 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
Tejun Heo66fa7f22007-12-15 15:05:04 +0900955 int nr_executed = 0;
Tejun Heo67465442007-05-15 03:28:16 +0900956 int rc;
957
Tejun Heo67465442007-05-15 03:28:16 +0900958 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 */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900974 rc = ata_acpi_exec_tfs(dev, &nr_executed);
975 if (rc)
Tejun Heo67465442007-05-15 03:28:16 +0900976 goto acpi_err;
977
978 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
979
980 /* refresh IDENTIFY page if any _GTF command has been executed */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900981 if (nr_executed) {
Tejun Heo67465442007-05-15 03:28:16 +0900982 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:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900993 /* ignore evaluation failure if we can continue safely */
994 if (rc == -EINVAL && !nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
995 return 0;
Tejun Heo67465442007-05-15 03:28:16 +0900996
Tejun Heo66fa7f22007-12-15 15:05:04 +0900997 /* 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;
Tejun Heo67465442007-05-15 03:28:16 +09001001 }
Tejun Heo66fa7f22007-12-15 15:05:04 +09001002
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
Tejun Heo67465442007-05-15 03:28:16 +09001013 return rc;
1014}
Tejun Heo562f0c22007-12-15 15:05:01 +09001015
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 */
1025void ata_acpi_on_disable(struct ata_device *dev)
1026{
Tejun Heo398e0782007-12-15 15:05:03 +09001027 ata_acpi_clear_gtf(dev);
Tejun Heo562f0c22007-12-15 15:05:01 +09001028}