blob: 9330b7922f6281e758a795603d18e2550fb70da1 [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>
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
Tejun Heo3264a8d2007-12-15 15:05:06 +090029enum {
30 ATA_ACPI_FILTER_SETXFER = 1 << 0,
31 ATA_ACPI_FILTER_LOCK = 1 << 1,
Tejun Heob3449912008-07-06 23:15:03 +090032 ATA_ACPI_FILTER_DIPM = 1 << 2,
Tejun Heo3264a8d2007-12-15 15:05:06 +090033
34 ATA_ACPI_FILTER_DEFAULT = ATA_ACPI_FILTER_SETXFER |
Tejun Heob3449912008-07-06 23:15:03 +090035 ATA_ACPI_FILTER_LOCK |
36 ATA_ACPI_FILTER_DIPM,
Tejun Heo3264a8d2007-12-15 15:05:06 +090037};
38
39static unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
40module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
Tejun Heob3449912008-07-06 23:15:03 +090041MODULE_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 +090042
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070043#define NO_PORT_MULT 0xffff
Jeff Garzik2dcb4072007-10-19 06:42:56 -040044#define SATA_ADR(root, pmp) (((root) << 16) | (pmp))
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070045
46#define REGS_PER_GTF 7
Tejun Heo4700c4b2007-05-15 03:28:16 +090047struct ata_acpi_gtf {
48 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
49} __packed;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070050
Alan Coxca426632007-03-08 23:13:50 +000051/*
52 * Helper - belongs in the PCI layer somewhere eventually
53 */
54static int is_pci_dev(struct device *dev)
55{
56 return (dev->bus == &pci_bus_type);
57}
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070058
Tejun Heo398e0782007-12-15 15:05:03 +090059static void ata_acpi_clear_gtf(struct ata_device *dev)
60{
61 kfree(dev->gtf_cache);
62 dev->gtf_cache = NULL;
63}
64
Tejun Heod0df8b5d2007-09-23 13:19:54 +090065/**
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 */
78void ata_acpi_associate_sata_port(struct ata_port *ap)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070079{
Tejun Heod0df8b5d2007-09-23 13:19:54 +090080 WARN_ON(!(ap->flags & ATA_FLAG_ACPI_SATA));
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070081
Tejun Heo071f44b2008-04-07 22:47:22 +090082 if (!sata_pmp_attached(ap)) {
Tejun Heod0df8b5d2007-09-23 13:19:54 +090083 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_port_for_each_link(link, ap) {
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 }
Tejun Heofafbae82007-05-15 03:28:16 +090099}
Alan Coxca426632007-03-08 23:13:50 +0000100
Tejun Heofafbae82007-05-15 03:28:16 +0900101static 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++) {
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900114 struct ata_device *dev = &ap->link.device[i];
Tejun Heofafbae82007-05-15 03:28:16 +0900115
116 dev->acpi_handle = acpi_get_child(ap->acpi_handle, i);
117 }
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900118
119 if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
120 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700121}
122
Holger Macht664d0802008-06-03 20:27:59 +0200123static void ata_acpi_eject_device(acpi_handle handle)
124{
125 struct acpi_object_list arg_list;
126 union acpi_object arg;
127
128 arg_list.count = 1;
129 arg_list.pointer = &arg;
130 arg.type = ACPI_TYPE_INTEGER;
131 arg.integer.value = 1;
132
133 if (ACPI_FAILURE(acpi_evaluate_object(handle, "_EJ0",
134 &arg_list, NULL)))
135 printk(KERN_ERR "Failed to evaluate _EJ0!\n");
136}
137
138/* @ap and @dev are the same as ata_acpi_handle_hotplug() */
139static void ata_acpi_detach_device(struct ata_port *ap, struct ata_device *dev)
140{
141 if (dev)
142 dev->flags |= ATA_DFLAG_DETACH;
143 else {
144 struct ata_link *tlink;
145 struct ata_device *tdev;
146
147 ata_port_for_each_link(tlink, ap)
148 ata_link_for_each_dev(tdev, tlink)
149 tdev->flags |= ATA_DFLAG_DETACH;
150 }
151
152 ata_port_schedule_eh(ap);
153}
154
155/**
156 * ata_acpi_handle_hotplug - ACPI event handler backend
157 * @ap: ATA port ACPI event occurred
158 * @dev: ATA device ACPI event occurred (can be NULL)
159 * @event: ACPI event which occurred
160 * @is_dock_event: boolean indicating whether the event was a dock one
161 *
162 * All ACPI bay / device realted events end up in this function. If
163 * the event is port-wide @dev is NULL. If the event is specific to a
164 * device, @dev points to it.
165 *
166 * Hotplug (as opposed to unplug) notification is always handled as
167 * port-wide while unplug only kills the target device on device-wide
168 * event.
169 *
170 * LOCKING:
171 * ACPI notify handler context. May sleep.
172 */
173static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
174 u32 event, int is_dock_event)
Matthew Garrett237d8442007-10-03 01:24:16 +0100175{
176 char event_string[12];
177 char *envp[] = { event_string, NULL };
Holger Macht664d0802008-06-03 20:27:59 +0200178 struct ata_eh_info *ehi = &ap->link.eh_info;
Tejun Heo233f1122008-03-12 14:24:43 +0900179 struct kobject *kobj = NULL;
180 int wait = 0;
181 unsigned long flags;
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100182 acpi_handle handle, tmphandle;
183 unsigned long sta;
184 acpi_status status;
Jeff Garzikc85665f2008-05-19 17:56:10 -0400185
Holger Macht664d0802008-06-03 20:27:59 +0200186 if (dev) {
187 if (dev->sdev)
188 kobj = &dev->sdev->sdev_gendev.kobj;
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100189 handle = dev->acpi_handle;
Holger Macht664d0802008-06-03 20:27:59 +0200190 } else {
191 kobj = &ap->dev->kobj;
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100192 handle = ap->acpi_handle;
Holger Macht664d0802008-06-03 20:27:59 +0200193 }
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100194
195 status = acpi_get_handle(handle, "_EJ0", &tmphandle);
Holger Macht664d0802008-06-03 20:27:59 +0200196 if (ACPI_FAILURE(status))
197 /* This device does not support hotplug */
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100198 return;
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100199
Zhang Rui3c1e3892008-07-11 09:42:03 -0400200 if (event == ACPI_NOTIFY_BUS_CHECK ||
201 event == ACPI_NOTIFY_DEVICE_CHECK)
202 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
203
Holger Macht664d0802008-06-03 20:27:59 +0200204 spin_lock_irqsave(ap->lock, flags);
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100205
Tejun Heo233f1122008-03-12 14:24:43 +0900206 switch (event) {
207 case ACPI_NOTIFY_BUS_CHECK:
208 case ACPI_NOTIFY_DEVICE_CHECK:
209 ata_ehi_push_desc(ehi, "ACPI event");
Jeff Garzikc85665f2008-05-19 17:56:10 -0400210
Holger Macht664d0802008-06-03 20:27:59 +0200211 if (ACPI_FAILURE(status)) {
212 ata_port_printk(ap, KERN_ERR,
213 "acpi: failed to determine bay status (0x%x)\n",
214 status);
215 break;
216 }
217
218 if (sta) {
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100219 ata_ehi_hotplugged(ehi);
220 ata_port_freeze(ap);
Holger Macht664d0802008-06-03 20:27:59 +0200221 } else {
222 /* The device has gone - unplug it */
223 ata_acpi_detach_device(ap, dev);
224 wait = 1;
Tejun Heo233f1122008-03-12 14:24:43 +0900225 }
Holger Macht664d0802008-06-03 20:27:59 +0200226 break;
227 case ACPI_NOTIFY_EJECT_REQUEST:
228 ata_ehi_push_desc(ehi, "ACPI event");
229
230 if (!is_dock_event)
231 break;
232
233 /* undock event - immediate unplug */
234 ata_acpi_detach_device(ap, dev);
235 wait = 1;
236 break;
Matthew Garrett237d8442007-10-03 01:24:16 +0100237 }
238
Holger Macht664d0802008-06-03 20:27:59 +0200239 /* make sure kobj doesn't go away while ap->lock is released */
240 kobject_get(kobj);
241
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100242 spin_unlock_irqrestore(ap->lock, flags);
243
Holger Macht664d0802008-06-03 20:27:59 +0200244 if (wait) {
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100245 ata_port_wait_eh(ap);
Holger Macht664d0802008-06-03 20:27:59 +0200246 ata_acpi_eject_device(handle);
247 }
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100248
Holger Macht664d0802008-06-03 20:27:59 +0200249 if (kobj && !is_dock_event) {
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400250 sprintf(event_string, "BAY_EVENT=%d", event);
Matthew Garrett237d8442007-10-03 01:24:16 +0100251 kobject_uevent_env(kobj, KOBJ_CHANGE, envp);
252 }
Holger Macht664d0802008-06-03 20:27:59 +0200253
254 kobject_put(kobj);
255}
256
257static void ata_acpi_dev_notify_dock(acpi_handle handle, u32 event, void *data)
258{
259 struct ata_device *dev = data;
260
261 ata_acpi_handle_hotplug(dev->link->ap, dev, event, 1);
262}
263
264static void ata_acpi_ap_notify_dock(acpi_handle handle, u32 event, void *data)
265{
266 struct ata_port *ap = data;
267
268 ata_acpi_handle_hotplug(ap, NULL, event, 1);
Matthew Garrett237d8442007-10-03 01:24:16 +0100269}
270
271static void ata_acpi_dev_notify(acpi_handle handle, u32 event, void *data)
272{
273 struct ata_device *dev = data;
Matthew Garrett237d8442007-10-03 01:24:16 +0100274
Holger Macht664d0802008-06-03 20:27:59 +0200275 ata_acpi_handle_hotplug(dev->link->ap, dev, event, 0);
Matthew Garrett237d8442007-10-03 01:24:16 +0100276}
277
278static void ata_acpi_ap_notify(acpi_handle handle, u32 event, void *data)
279{
280 struct ata_port *ap = data;
281
Holger Macht664d0802008-06-03 20:27:59 +0200282 ata_acpi_handle_hotplug(ap, NULL, event, 0);
Matthew Garrett237d8442007-10-03 01:24:16 +0100283}
284
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700285/**
Tejun Heofafbae82007-05-15 03:28:16 +0900286 * ata_acpi_associate - associate ATA host with ACPI objects
287 * @host: target ATA host
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700288 *
Tejun Heofafbae82007-05-15 03:28:16 +0900289 * Look up ACPI objects associated with @host and initialize
290 * acpi_handle fields of @host, its ports and devices accordingly.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700291 *
Tejun Heofafbae82007-05-15 03:28:16 +0900292 * LOCKING:
293 * EH context.
294 *
295 * RETURNS:
296 * 0 on success, -errno on failure.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700297 */
Tejun Heofafbae82007-05-15 03:28:16 +0900298void ata_acpi_associate(struct ata_host *host)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700299{
Matthew Garrett237d8442007-10-03 01:24:16 +0100300 int i, j;
Alan Coxca426632007-03-08 23:13:50 +0000301
Tejun Heofafbae82007-05-15 03:28:16 +0900302 if (!is_pci_dev(host->dev) || libata_noacpi)
303 return;
Alan Coxca426632007-03-08 23:13:50 +0000304
Tejun Heofafbae82007-05-15 03:28:16 +0900305 host->acpi_handle = DEVICE_ACPI_HANDLE(host->dev);
306 if (!host->acpi_handle)
307 return;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700308
Tejun Heofafbae82007-05-15 03:28:16 +0900309 for (i = 0; i < host->n_ports; i++) {
310 struct ata_port *ap = host->ports[i];
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700311
Tejun Heofafbae82007-05-15 03:28:16 +0900312 if (host->ports[0]->flags & ATA_FLAG_ACPI_SATA)
313 ata_acpi_associate_sata_port(ap);
314 else
315 ata_acpi_associate_ide_port(ap);
Matthew Garrett237d8442007-10-03 01:24:16 +0100316
Tejun Heo233f1122008-03-12 14:24:43 +0900317 if (ap->acpi_handle) {
318 acpi_install_notify_handler(ap->acpi_handle,
319 ACPI_SYSTEM_NOTIFY,
320 ata_acpi_ap_notify, ap);
Tejun Heo233f1122008-03-12 14:24:43 +0900321 /* we might be on a docking station */
322 register_hotplug_dock_device(ap->acpi_handle,
Holger Macht664d0802008-06-03 20:27:59 +0200323 ata_acpi_ap_notify_dock, ap);
Tejun Heo233f1122008-03-12 14:24:43 +0900324 }
Matthew Garrett237d8442007-10-03 01:24:16 +0100325
326 for (j = 0; j < ata_link_max_devices(&ap->link); j++) {
327 struct ata_device *dev = &ap->link.device[j];
328
Tejun Heo233f1122008-03-12 14:24:43 +0900329 if (dev->acpi_handle) {
330 acpi_install_notify_handler(dev->acpi_handle,
331 ACPI_SYSTEM_NOTIFY,
332 ata_acpi_dev_notify, dev);
Tejun Heo233f1122008-03-12 14:24:43 +0900333 /* we might be on a docking station */
334 register_hotplug_dock_device(dev->acpi_handle,
Holger Macht664d0802008-06-03 20:27:59 +0200335 ata_acpi_dev_notify_dock, dev);
Tejun Heo233f1122008-03-12 14:24:43 +0900336 }
Matthew Garrett237d8442007-10-03 01:24:16 +0100337 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700338 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700339}
340
341/**
Tejun Heo562f0c22007-12-15 15:05:01 +0900342 * ata_acpi_dissociate - dissociate ATA host from ACPI objects
343 * @host: target ATA host
344 *
345 * This function is called during driver detach after the whole host
346 * is shut down.
347 *
348 * LOCKING:
349 * EH context.
350 */
351void ata_acpi_dissociate(struct ata_host *host)
352{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900353 int i;
354
355 /* Restore initial _GTM values so that driver which attaches
356 * afterward can use them too.
357 */
358 for (i = 0; i < host->n_ports; i++) {
359 struct ata_port *ap = host->ports[i];
360 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
361
362 if (ap->acpi_handle && gtm)
363 ata_acpi_stm(ap, gtm);
364 }
Tejun Heo562f0c22007-12-15 15:05:01 +0900365}
366
367/**
Tejun Heo64578a32007-05-15 03:28:16 +0900368 * ata_acpi_gtm - execute _GTM
369 * @ap: target ATA port
370 * @gtm: out parameter for _GTM result
371 *
372 * Evaluate _GTM and store the result in @gtm.
373 *
374 * LOCKING:
375 * EH context.
376 *
377 * RETURNS:
378 * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
379 */
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900380int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
Tejun Heo64578a32007-05-15 03:28:16 +0900381{
382 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
383 union acpi_object *out_obj;
384 acpi_status status;
385 int rc = 0;
386
387 status = acpi_evaluate_object(ap->acpi_handle, "_GTM", NULL, &output);
388
389 rc = -ENOENT;
390 if (status == AE_NOT_FOUND)
391 goto out_free;
392
393 rc = -EINVAL;
394 if (ACPI_FAILURE(status)) {
395 ata_port_printk(ap, KERN_ERR,
396 "ACPI get timing mode failed (AE 0x%x)\n",
397 status);
398 goto out_free;
399 }
400
401 out_obj = output.pointer;
402 if (out_obj->type != ACPI_TYPE_BUFFER) {
403 ata_port_printk(ap, KERN_WARNING,
404 "_GTM returned unexpected object type 0x%x\n",
405 out_obj->type);
406
407 goto out_free;
408 }
409
410 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
411 ata_port_printk(ap, KERN_ERR,
412 "_GTM returned invalid length %d\n",
413 out_obj->buffer.length);
414 goto out_free;
415 }
416
417 memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
418 rc = 0;
419 out_free:
420 kfree(output.pointer);
421 return rc;
422}
423
Alan Coxbadff032007-10-04 21:28:18 +0100424EXPORT_SYMBOL_GPL(ata_acpi_gtm);
425
Tejun Heo64578a32007-05-15 03:28:16 +0900426/**
427 * ata_acpi_stm - execute _STM
428 * @ap: target ATA port
429 * @stm: timing parameter to _STM
430 *
431 * Evaluate _STM with timing parameter @stm.
432 *
433 * LOCKING:
434 * EH context.
435 *
436 * RETURNS:
437 * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
438 */
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900439int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
Tejun Heo64578a32007-05-15 03:28:16 +0900440{
441 acpi_status status;
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900442 struct ata_acpi_gtm stm_buf = *stm;
Tejun Heo64578a32007-05-15 03:28:16 +0900443 struct acpi_object_list input;
444 union acpi_object in_params[3];
445
446 in_params[0].type = ACPI_TYPE_BUFFER;
447 in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900448 in_params[0].buffer.pointer = (u8 *)&stm_buf;
Tejun Heo64578a32007-05-15 03:28:16 +0900449 /* Buffers for id may need byteswapping ? */
450 in_params[1].type = ACPI_TYPE_BUFFER;
451 in_params[1].buffer.length = 512;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900452 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
Tejun Heo64578a32007-05-15 03:28:16 +0900453 in_params[2].type = ACPI_TYPE_BUFFER;
454 in_params[2].buffer.length = 512;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900455 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
Tejun Heo64578a32007-05-15 03:28:16 +0900456
457 input.count = 3;
458 input.pointer = in_params;
459
460 status = acpi_evaluate_object(ap->acpi_handle, "_STM", &input, NULL);
461
462 if (status == AE_NOT_FOUND)
463 return -ENOENT;
464 if (ACPI_FAILURE(status)) {
465 ata_port_printk(ap, KERN_ERR,
466 "ACPI set timing mode failed (status=0x%x)\n", status);
467 return -EINVAL;
468 }
469 return 0;
470}
471
Alan Coxbadff032007-10-04 21:28:18 +0100472EXPORT_SYMBOL_GPL(ata_acpi_stm);
473
Tejun Heo64578a32007-05-15 03:28:16 +0900474/**
Tejun Heo4700c4b2007-05-15 03:28:16 +0900475 * ata_dev_get_GTF - get the drive bootup default taskfile settings
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900476 * @dev: target ATA device
Tejun Heo4700c4b2007-05-15 03:28:16 +0900477 * @gtf: output parameter for buffer containing _GTF taskfile arrays
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700478 *
479 * This applies to both PATA and SATA drives.
480 *
481 * The _GTF method has no input parameters.
482 * It returns a variable number of register set values (registers
483 * hex 1F1..1F7, taskfiles).
484 * The <variable number> is not known in advance, so have ACPI-CA
485 * allocate the buffer as needed and return it, then free it later.
486 *
Tejun Heo4700c4b2007-05-15 03:28:16 +0900487 * LOCKING:
488 * EH context.
489 *
490 * RETURNS:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900491 * Number of taskfiles on success, 0 if _GTF doesn't exist. -EINVAL
492 * if _GTF is invalid.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700493 */
Tejun Heo398e0782007-12-15 15:05:03 +0900494static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700495{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900496 struct ata_port *ap = dev->link->ap;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900497 acpi_status status;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900498 struct acpi_buffer output;
499 union acpi_object *out_obj;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900500 int rc = 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700501
Tejun Heo398e0782007-12-15 15:05:03 +0900502 /* if _GTF is cached, use the cached value */
503 if (dev->gtf_cache) {
504 out_obj = dev->gtf_cache;
505 goto done;
506 }
507
Tejun Heo4700c4b2007-05-15 03:28:16 +0900508 /* set up output buffer */
509 output.length = ACPI_ALLOCATE_BUFFER;
510 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700511
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700512 if (ata_msg_probe(ap))
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900513 ata_dev_printk(dev, KERN_DEBUG, "%s: ENTER: port#: %d\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800514 __func__, ap->port_no);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700515
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700516 /* _GTF has no input parameters */
Tejun Heo4700c4b2007-05-15 03:28:16 +0900517 status = acpi_evaluate_object(dev->acpi_handle, "_GTF", NULL, &output);
Tejun Heo398e0782007-12-15 15:05:03 +0900518 out_obj = dev->gtf_cache = output.pointer;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900519
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700520 if (ACPI_FAILURE(status)) {
Tejun Heo4700c4b2007-05-15 03:28:16 +0900521 if (status != AE_NOT_FOUND) {
522 ata_dev_printk(dev, KERN_WARNING,
523 "_GTF evaluation failed (AE 0x%x)\n",
524 status);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900525 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900526 }
527 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700528 }
529
530 if (!output.length || !output.pointer) {
531 if (ata_msg_probe(ap))
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900532 ata_dev_printk(dev, KERN_DEBUG, "%s: Run _GTF: "
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700533 "length or ptr is NULL (0x%llx, 0x%p)\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800534 __func__,
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700535 (unsigned long long)output.length,
536 output.pointer);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900537 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900538 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700539 }
540
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700541 if (out_obj->type != ACPI_TYPE_BUFFER) {
Tejun Heo69b16a52007-05-15 03:28:16 +0900542 ata_dev_printk(dev, KERN_WARNING,
543 "_GTF unexpected object type 0x%x\n",
544 out_obj->type);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900545 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900546 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700547 }
548
Tejun Heo4700c4b2007-05-15 03:28:16 +0900549 if (out_obj->buffer.length % REGS_PER_GTF) {
Tejun Heo69b16a52007-05-15 03:28:16 +0900550 ata_dev_printk(dev, KERN_WARNING,
551 "unexpected _GTF length (%d)\n",
552 out_obj->buffer.length);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900553 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900554 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700555 }
556
Tejun Heo398e0782007-12-15 15:05:03 +0900557 done:
Tejun Heo4700c4b2007-05-15 03:28:16 +0900558 rc = out_obj->buffer.length / REGS_PER_GTF;
Tejun Heo398e0782007-12-15 15:05:03 +0900559 if (gtf) {
560 *gtf = (void *)out_obj->buffer.pointer;
561 if (ata_msg_probe(ap))
562 ata_dev_printk(dev, KERN_DEBUG,
563 "%s: returning gtf=%p, gtf_count=%d\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800564 __func__, *gtf, rc);
Tejun Heo398e0782007-12-15 15:05:03 +0900565 }
Tejun Heo4700c4b2007-05-15 03:28:16 +0900566 return rc;
567
568 out_free:
Tejun Heo398e0782007-12-15 15:05:03 +0900569 ata_acpi_clear_gtf(dev);
Tejun Heo4700c4b2007-05-15 03:28:16 +0900570 return rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700571}
572
Tejun Heo7c77fa42007-12-18 16:33:03 +0900573/**
574 * ata_acpi_gtm_xfermode - determine xfermode from GTM parameter
575 * @dev: target device
576 * @gtm: GTM parameter to use
577 *
578 * Determine xfermask for @dev from @gtm.
579 *
580 * LOCKING:
581 * None.
582 *
583 * RETURNS:
584 * Determined xfermask.
585 */
586unsigned long ata_acpi_gtm_xfermask(struct ata_device *dev,
587 const struct ata_acpi_gtm *gtm)
588{
Tejun Heoa0f79b92007-12-18 16:33:05 +0900589 unsigned long xfer_mask = 0;
590 unsigned int type;
591 int unit;
592 u8 mode;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900593
594 /* we always use the 0 slot for crap hardware */
595 unit = dev->devno;
596 if (!(gtm->flags & 0x10))
597 unit = 0;
598
Tejun Heoa0f79b92007-12-18 16:33:05 +0900599 /* PIO */
600 mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
601 xfer_mask |= ata_xfer_mode2mask(mode);
Tejun Heo7c77fa42007-12-18 16:33:03 +0900602
603 /* See if we have MWDMA or UDMA data. We don't bother with
604 * MWDMA if UDMA is available as this means the BIOS set UDMA
605 * and our error changedown if it works is UDMA to PIO anyway.
606 */
Tejun Heoa0f79b92007-12-18 16:33:05 +0900607 if (!(gtm->flags & (1 << (2 * unit))))
608 type = ATA_SHIFT_MWDMA;
609 else
610 type = ATA_SHIFT_UDMA;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900611
Tejun Heoa0f79b92007-12-18 16:33:05 +0900612 mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
613 xfer_mask |= ata_xfer_mode2mask(mode);
614
615 return xfer_mask;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900616}
617EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
618
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700619/**
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400620 * ata_acpi_cbl_80wire - Check for 80 wire cable
621 * @ap: Port to check
Tejun Heo021ee9a2007-12-18 16:33:06 +0900622 * @gtm: GTM data to use
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400623 *
Tejun Heo021ee9a2007-12-18 16:33:06 +0900624 * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400625 */
Tejun Heo021ee9a2007-12-18 16:33:06 +0900626int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400627{
Tejun Heo021ee9a2007-12-18 16:33:06 +0900628 struct ata_device *dev;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400629
Tejun Heo021ee9a2007-12-18 16:33:06 +0900630 ata_link_for_each_dev(dev, &ap->link) {
631 unsigned long xfer_mask, udma_mask;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400632
Tejun Heo021ee9a2007-12-18 16:33:06 +0900633 if (!ata_dev_enabled(dev))
634 continue;
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400635
Tejun Heo021ee9a2007-12-18 16:33:06 +0900636 xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
637 ata_unpack_xfermask(xfer_mask, NULL, NULL, &udma_mask);
638
639 if (udma_mask & ~ATA_UDMA_MASK_40C)
640 return 1;
641 }
642
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400643 return 0;
644}
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400645EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
646
Tejun Heo3264a8d2007-12-15 15:05:06 +0900647static void ata_acpi_gtf_to_tf(struct ata_device *dev,
648 const struct ata_acpi_gtf *gtf,
649 struct ata_taskfile *tf)
650{
651 ata_tf_init(dev, tf);
652
653 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
654 tf->protocol = ATA_PROT_NODATA;
655 tf->feature = gtf->tf[0]; /* 0x1f1 */
656 tf->nsect = gtf->tf[1]; /* 0x1f2 */
657 tf->lbal = gtf->tf[2]; /* 0x1f3 */
658 tf->lbam = gtf->tf[3]; /* 0x1f4 */
659 tf->lbah = gtf->tf[4]; /* 0x1f5 */
660 tf->device = gtf->tf[5]; /* 0x1f6 */
661 tf->command = gtf->tf[6]; /* 0x1f7 */
662}
663
664static int ata_acpi_filter_tf(const struct ata_taskfile *tf,
665 const struct ata_taskfile *ptf)
666{
667 if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_SETXFER) {
668 /* libata doesn't use ACPI to configure transfer mode.
669 * It will only confuse device configuration. Skip.
670 */
671 if (tf->command == ATA_CMD_SET_FEATURES &&
672 tf->feature == SETFEATURES_XFER)
673 return 1;
674 }
675
676 if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_LOCK) {
677 /* BIOS writers, sorry but we don't wanna lock
678 * features unless the user explicitly said so.
679 */
680
681 /* DEVICE CONFIGURATION FREEZE LOCK */
682 if (tf->command == ATA_CMD_CONF_OVERLAY &&
683 tf->feature == ATA_DCO_FREEZE_LOCK)
684 return 1;
685
686 /* SECURITY FREEZE LOCK */
687 if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
688 return 1;
689
690 /* SET MAX LOCK and SET MAX FREEZE LOCK */
691 if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
692 tf->command == ATA_CMD_SET_MAX &&
693 (tf->feature == ATA_SET_MAX_LOCK ||
694 tf->feature == ATA_SET_MAX_FREEZE_LOCK))
695 return 1;
696 }
697
Tejun Heob3449912008-07-06 23:15:03 +0900698 if (ata_acpi_gtf_filter & ATA_ACPI_FILTER_DIPM) {
699 /* inhibit enabling DIPM */
700 if (tf->command == ATA_CMD_SET_FEATURES &&
701 tf->feature == SETFEATURES_SATA_ENABLE &&
702 tf->nsect == SATA_DIPM)
703 return 1;
704 }
705
Tejun Heo3264a8d2007-12-15 15:05:06 +0900706 return 0;
707}
708
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400709/**
Tejun Heo0e8634b2007-12-15 15:05:05 +0900710 * ata_acpi_run_tf - send taskfile registers to host controller
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900711 * @dev: target ATA device
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700712 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
713 *
714 * Outputs ATA taskfile to standard ATA host controller using MMIO
715 * or PIO as indicated by the ATA_FLAG_MMIO flag.
716 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
717 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
718 * hob_lbal, hob_lbam, and hob_lbah.
719 *
720 * This function waits for idle (!BUSY and !DRQ) after writing
721 * registers. If the control register has a new value, this
722 * function also waits for idle after writing control and before
723 * writing the remaining registers.
724 *
Tejun Heo4700c4b2007-05-15 03:28:16 +0900725 * LOCKING:
726 * EH context.
727 *
728 * RETURNS:
Tejun Heo3264a8d2007-12-15 15:05:06 +0900729 * 1 if command is executed successfully. 0 if ignored, rejected or
730 * filtered out, -errno on other errors.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700731 */
Tejun Heo0e8634b2007-12-15 15:05:05 +0900732static int ata_acpi_run_tf(struct ata_device *dev,
Tejun Heo3264a8d2007-12-15 15:05:06 +0900733 const struct ata_acpi_gtf *gtf,
734 const struct ata_acpi_gtf *prev_gtf)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700735{
Tejun Heo3264a8d2007-12-15 15:05:06 +0900736 struct ata_taskfile *pptf = NULL;
737 struct ata_taskfile tf, ptf, rtf;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900738 unsigned int err_mask;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900739 const char *level;
740 char msg[60];
741 int rc;
Jeff Garzikfc16c252007-02-24 21:05:01 -0500742
Tejun Heo4700c4b2007-05-15 03:28:16 +0900743 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
744 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
745 && (gtf->tf[6] == 0))
746 return 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700747
Tejun Heo3264a8d2007-12-15 15:05:06 +0900748 ata_acpi_gtf_to_tf(dev, gtf, &tf);
749 if (prev_gtf) {
750 ata_acpi_gtf_to_tf(dev, prev_gtf, &ptf);
751 pptf = &ptf;
752 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700753
Tejun Heo3264a8d2007-12-15 15:05:06 +0900754 if (!ata_acpi_filter_tf(&tf, pptf)) {
755 rtf = tf;
756 err_mask = ata_exec_internal(dev, &rtf, NULL,
757 DMA_NONE, NULL, 0, 0);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700758
Tejun Heo3264a8d2007-12-15 15:05:06 +0900759 switch (err_mask) {
760 case 0:
761 level = KERN_DEBUG;
762 snprintf(msg, sizeof(msg), "succeeded");
763 rc = 1;
764 break;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900765
Tejun Heo3264a8d2007-12-15 15:05:06 +0900766 case AC_ERR_DEV:
767 level = KERN_INFO;
768 snprintf(msg, sizeof(msg),
769 "rejected by device (Stat=0x%02x Err=0x%02x)",
770 rtf.command, rtf.feature);
771 rc = 0;
772 break;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900773
Tejun Heo3264a8d2007-12-15 15:05:06 +0900774 default:
775 level = KERN_ERR;
776 snprintf(msg, sizeof(msg),
777 "failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
778 err_mask, rtf.command, rtf.feature);
779 rc = -EIO;
780 break;
781 }
782 } else {
Tejun Heo0e8634b2007-12-15 15:05:05 +0900783 level = KERN_INFO;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900784 snprintf(msg, sizeof(msg), "filtered out");
Tejun Heo0e8634b2007-12-15 15:05:05 +0900785 rc = 0;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900786 }
787
Tejun Heo0e8634b2007-12-15 15:05:05 +0900788 ata_dev_printk(dev, level,
789 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x %s\n",
790 tf.command, tf.feature, tf.nsect, tf.lbal,
791 tf.lbam, tf.lbah, tf.device, msg);
792
793 return rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700794}
795
796/**
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700797 * ata_acpi_exec_tfs - get then write drive taskfile settings
Tejun Heo67465442007-05-15 03:28:16 +0900798 * @dev: target ATA device
Tejun Heo66fa7f22007-12-15 15:05:04 +0900799 * @nr_executed: out paramter for the number of executed commands
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700800 *
Tejun Heo67465442007-05-15 03:28:16 +0900801 * Evaluate _GTF and excute returned taskfiles.
Tejun Heo69b16a52007-05-15 03:28:16 +0900802 *
803 * LOCKING:
804 * EH context.
805 *
806 * RETURNS:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900807 * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
808 * -errno on other errors.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700809 */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900810static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700811{
Tejun Heo3264a8d2007-12-15 15:05:06 +0900812 struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
Tejun Heo67465442007-05-15 03:28:16 +0900813 int gtf_count, i, rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700814
Tejun Heo67465442007-05-15 03:28:16 +0900815 /* get taskfiles */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900816 rc = ata_dev_get_GTF(dev, &gtf);
817 if (rc < 0)
818 return rc;
819 gtf_count = rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700820
Tejun Heo67465442007-05-15 03:28:16 +0900821 /* execute them */
Tejun Heo3264a8d2007-12-15 15:05:06 +0900822 for (i = 0; i < gtf_count; i++, gtf++) {
823 rc = ata_acpi_run_tf(dev, gtf, pgtf);
Tejun Heo0e8634b2007-12-15 15:05:05 +0900824 if (rc < 0)
825 break;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900826 if (rc) {
Tejun Heo0e8634b2007-12-15 15:05:05 +0900827 (*nr_executed)++;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900828 pgtf = gtf;
829 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700830 }
831
Tejun Heo398e0782007-12-15 15:05:03 +0900832 ata_acpi_clear_gtf(dev);
Tejun Heo67465442007-05-15 03:28:16 +0900833
Tejun Heo0e8634b2007-12-15 15:05:05 +0900834 if (rc < 0)
835 return rc;
836 return 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700837}
838
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700839/**
840 * ata_acpi_push_id - send Identify data to drive
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900841 * @dev: target ATA device
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700842 *
843 * _SDD ACPI object: for SATA mode only
844 * Must be after Identify (Packet) Device -- uses its data
845 * ATM this function never returns a failure. It is an optional
846 * method and if it fails for whatever reason, we should still
847 * just keep going.
Tejun Heo69b16a52007-05-15 03:28:16 +0900848 *
849 * LOCKING:
850 * EH context.
851 *
852 * RETURNS:
853 * 0 on success, -errno on failure.
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700854 */
Tejun Heo67465442007-05-15 03:28:16 +0900855static int ata_acpi_push_id(struct ata_device *dev)
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700856{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900857 struct ata_port *ap = dev->link->ap;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900858 int err;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900859 acpi_status status;
860 struct acpi_object_list input;
861 union acpi_object in_params[1];
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700862
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700863 if (ata_msg_probe(ap))
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900864 ata_dev_printk(dev, KERN_DEBUG, "%s: ix = %d, port#: %d\n",
Harvey Harrison7f5e4e82008-03-05 18:24:52 -0800865 __func__, dev->devno, ap->port_no);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700866
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700867 /* Give the drive Identify data to the drive via the _SDD method */
868 /* _SDD: set up input parameters */
869 input.count = 1;
870 input.pointer = in_params;
871 in_params[0].type = ACPI_TYPE_BUFFER;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900872 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
873 in_params[0].buffer.pointer = (u8 *)dev->id;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700874 /* Output buffer: _SDD has no output */
875
876 /* It's OK for _SDD to be missing too. */
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900877 swap_buf_le16(dev->id, ATA_ID_WORDS);
Tejun Heofafbae82007-05-15 03:28:16 +0900878 status = acpi_evaluate_object(dev->acpi_handle, "_SDD", &input, NULL);
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900879 swap_buf_le16(dev->id, ATA_ID_WORDS);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700880
881 err = ACPI_FAILURE(status) ? -EIO : 0;
Tejun Heo69b16a52007-05-15 03:28:16 +0900882 if (err < 0)
883 ata_dev_printk(dev, KERN_WARNING,
884 "ACPI _SDD failed (AE 0x%x)\n", status);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700885
Tejun Heo67465442007-05-15 03:28:16 +0900886 return err;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700887}
888
Tejun Heo67465442007-05-15 03:28:16 +0900889/**
Tejun Heo64578a32007-05-15 03:28:16 +0900890 * ata_acpi_on_suspend - ATA ACPI hook called on suspend
891 * @ap: target ATA port
892 *
893 * This function is called when @ap is about to be suspended. All
894 * devices are already put to sleep but the port_suspend() callback
895 * hasn't been executed yet. Error return from this function aborts
896 * suspend.
897 *
898 * LOCKING:
899 * EH context.
900 *
901 * RETURNS:
902 * 0 on success, -errno on failure.
903 */
904int ata_acpi_on_suspend(struct ata_port *ap)
905{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900906 /* nada */
907 return 0;
Tejun Heo64578a32007-05-15 03:28:16 +0900908}
909
910/**
Tejun Heo67465442007-05-15 03:28:16 +0900911 * ata_acpi_on_resume - ATA ACPI hook called on resume
912 * @ap: target ATA port
913 *
914 * This function is called when @ap is resumed - right after port
915 * itself is resumed but before any EH action is taken.
916 *
917 * LOCKING:
918 * EH context.
919 */
920void ata_acpi_on_resume(struct ata_port *ap)
921{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900922 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
Tejun Heof58229f2007-08-06 18:36:23 +0900923 struct ata_device *dev;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700924
Tejun Heo398e0782007-12-15 15:05:03 +0900925 if (ap->acpi_handle && gtm) {
926 /* _GTM valid */
927
928 /* restore timing parameters */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900929 ata_acpi_stm(ap, gtm);
Tejun Heo64578a32007-05-15 03:28:16 +0900930
Tejun Heo398e0782007-12-15 15:05:03 +0900931 /* _GTF should immediately follow _STM so that it can
932 * use values set by _STM. Cache _GTF result and
933 * schedule _GTF.
934 */
935 ata_link_for_each_dev(dev, &ap->link) {
936 ata_acpi_clear_gtf(dev);
Shaohua Li48feb3c2008-03-25 16:50:45 +0800937 if (ata_dev_enabled(dev) &&
938 ata_dev_get_GTF(dev, NULL) >= 0)
Tejun Heo398e0782007-12-15 15:05:03 +0900939 dev->flags |= ATA_DFLAG_ACPI_PENDING;
940 }
941 } else {
942 /* SATA _GTF needs to be evaulated after _SDD and
943 * there's no reason to evaluate IDE _GTF early
944 * without _STM. Clear cache and schedule _GTF.
945 */
946 ata_link_for_each_dev(dev, &ap->link) {
947 ata_acpi_clear_gtf(dev);
Shaohua Li48feb3c2008-03-25 16:50:45 +0800948 if (ata_dev_enabled(dev))
949 dev->flags |= ATA_DFLAG_ACPI_PENDING;
Tejun Heo398e0782007-12-15 15:05:03 +0900950 }
951 }
Tejun Heo67465442007-05-15 03:28:16 +0900952}
953
954/**
Shaohua Libd3adca2007-11-02 09:32:38 +0800955 * ata_acpi_set_state - set the port power state
956 * @ap: target ATA port
957 * @state: state, on/off
958 *
959 * This function executes the _PS0/_PS3 ACPI method to set the power state.
960 * ACPI spec requires _PS0 when IDE power on and _PS3 when power off
961 */
962void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
963{
964 struct ata_device *dev;
965
966 if (!ap->acpi_handle || (ap->flags & ATA_FLAG_ACPI_SATA))
967 return;
968
969 /* channel first and then drives for power on and vica versa
970 for power off */
971 if (state.event == PM_EVENT_ON)
972 acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D0);
973
974 ata_link_for_each_dev(dev, &ap->link) {
975 if (dev->acpi_handle && ata_dev_enabled(dev))
976 acpi_bus_set_power(dev->acpi_handle,
977 state.event == PM_EVENT_ON ?
978 ACPI_STATE_D0 : ACPI_STATE_D3);
979 }
980 if (state.event != PM_EVENT_ON)
981 acpi_bus_set_power(ap->acpi_handle, ACPI_STATE_D3);
982}
983
984/**
Tejun Heo67465442007-05-15 03:28:16 +0900985 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
986 * @dev: target ATA device
987 *
988 * This function is called when @dev is about to be configured.
989 * IDENTIFY data might have been modified after this hook is run.
990 *
991 * LOCKING:
992 * EH context.
993 *
994 * RETURNS:
995 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
996 * -errno on failure.
997 */
998int ata_acpi_on_devcfg(struct ata_device *dev)
999{
Tejun Heo9af5c9c2007-08-06 18:36:22 +09001000 struct ata_port *ap = dev->link->ap;
1001 struct ata_eh_context *ehc = &ap->link.eh_context;
Tejun Heo67465442007-05-15 03:28:16 +09001002 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
Tejun Heo66fa7f22007-12-15 15:05:04 +09001003 int nr_executed = 0;
Tejun Heo67465442007-05-15 03:28:16 +09001004 int rc;
1005
Tejun Heo67465442007-05-15 03:28:16 +09001006 if (!dev->acpi_handle)
1007 return 0;
1008
1009 /* do we need to do _GTF? */
1010 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
1011 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
1012 return 0;
1013
1014 /* do _SDD if SATA */
1015 if (acpi_sata) {
1016 rc = ata_acpi_push_id(dev);
1017 if (rc)
1018 goto acpi_err;
1019 }
1020
1021 /* do _GTF */
Tejun Heo66fa7f22007-12-15 15:05:04 +09001022 rc = ata_acpi_exec_tfs(dev, &nr_executed);
1023 if (rc)
Tejun Heo67465442007-05-15 03:28:16 +09001024 goto acpi_err;
1025
1026 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
1027
1028 /* refresh IDENTIFY page if any _GTF command has been executed */
Tejun Heo66fa7f22007-12-15 15:05:04 +09001029 if (nr_executed) {
Tejun Heo67465442007-05-15 03:28:16 +09001030 rc = ata_dev_reread_id(dev, 0);
1031 if (rc < 0) {
1032 ata_dev_printk(dev, KERN_ERR, "failed to IDENTIFY "
1033 "after ACPI commands\n");
1034 return rc;
1035 }
1036 }
1037
1038 return 0;
1039
1040 acpi_err:
Tejun Heo66fa7f22007-12-15 15:05:04 +09001041 /* ignore evaluation failure if we can continue safely */
1042 if (rc == -EINVAL && !nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
1043 return 0;
Tejun Heo67465442007-05-15 03:28:16 +09001044
Tejun Heo66fa7f22007-12-15 15:05:04 +09001045 /* fail and let EH retry once more for unknown IO errors */
1046 if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
1047 dev->flags |= ATA_DFLAG_ACPI_FAILED;
1048 return rc;
Tejun Heo67465442007-05-15 03:28:16 +09001049 }
Tejun Heo66fa7f22007-12-15 15:05:04 +09001050
1051 ata_dev_printk(dev, KERN_WARNING,
1052 "ACPI: failed the second time, disabled\n");
1053 dev->acpi_handle = NULL;
1054
1055 /* We can safely continue if no _GTF command has been executed
1056 * and port is not frozen.
1057 */
1058 if (!nr_executed && !(ap->pflags & ATA_PFLAG_FROZEN))
1059 return 0;
1060
Tejun Heo67465442007-05-15 03:28:16 +09001061 return rc;
1062}
Tejun Heo562f0c22007-12-15 15:05:01 +09001063
1064/**
1065 * ata_acpi_on_disable - ATA ACPI hook called when a device is disabled
1066 * @dev: target ATA device
1067 *
1068 * This function is called when @dev is about to be disabled.
1069 *
1070 * LOCKING:
1071 * EH context.
1072 */
1073void ata_acpi_on_disable(struct ata_device *dev)
1074{
Tejun Heo398e0782007-12-15 15:05:03 +09001075 ata_acpi_clear_gtf(dev);
Tejun Heo562f0c22007-12-15 15:05:01 +09001076}