blob: d36e71f475abdc876b8513563cc50bd5ded2c650 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -07002/*
3 * libata-acpi.c
4 * Provides ACPI support for PATA/SATA.
5 *
6 * Copyright (C) 2006 Intel Corp.
7 * Copyright (C) 2006 Randy Dunlap
8 */
9
Tejun Heo3264a8d2007-12-15 15:05:06 +090010#include <linux/module.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070011#include <linux/ata.h>
12#include <linux/delay.h>
13#include <linux/device.h>
14#include <linux/errno.h>
15#include <linux/kernel.h>
16#include <linux/acpi.h>
17#include <linux/libata.h>
18#include <linux/pci.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/slab.h>
Lin Ming3bd46600a72012-06-25 16:13:06 +080020#include <linux/pm_runtime.h>
Matthew Garrett237d8442007-10-03 01:24:16 +010021#include <scsi/scsi_device.h>
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070022#include "libata.h"
23
Tejun Heo110f66d2009-09-16 04:17:28 +090024unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
Tejun Heo3264a8d2007-12-15 15:05:06 +090025module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
Tejun Heofa5b5612009-09-16 04:17:02 +090026MODULE_PARM_DESC(acpi_gtf_filter, "filter mask for ACPI _GTF commands, set to filter out (0x1=set xfermode, 0x2=lock/freeze lock, 0x4=DIPM, 0x8=FPDMA non-zero offset, 0x10=FPDMA DMA Setup FIS auto-activate)");
Tejun Heo3264a8d2007-12-15 15:05:06 +090027
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070028#define NO_PORT_MULT 0xffff
Jeff Garzik2dcb4072007-10-19 06:42:56 -040029#define SATA_ADR(root, pmp) (((root) << 16) | (pmp))
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070030
31#define REGS_PER_GTF 7
Tejun Heo4700c4b2007-05-15 03:28:16 +090032struct ata_acpi_gtf {
33 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
34} __packed;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070035
Tejun Heo398e0782007-12-15 15:05:03 +090036static void ata_acpi_clear_gtf(struct ata_device *dev)
37{
38 kfree(dev->gtf_cache);
39 dev->gtf_cache = NULL;
40}
41
Rafael J. Wysocki5d513202014-02-22 00:48:31 +010042struct ata_acpi_hotplug_context {
43 struct acpi_hotplug_context hp;
44 union {
45 struct ata_port *ap;
46 struct ata_device *dev;
47 } data;
48};
49
50#define ata_hotplug_data(context) (container_of((context), struct ata_acpi_hotplug_context, hp)->data)
51
Matthew Garrett30dcf762012-06-25 16:13:04 +080052/**
Matthew Garrett30dcf762012-06-25 16:13:04 +080053 * ata_dev_acpi_handle - provide the acpi_handle for an ata_device
Aaron Luf1bc1e42013-08-23 10:17:54 +080054 * @dev: the acpi_handle returned will correspond to this device
Matthew Garrett30dcf762012-06-25 16:13:04 +080055 *
56 * Returns the acpi_handle for the ACPI namespace object corresponding to
57 * the ata_device passed into the function, or NULL if no such object exists
Aaron Luf1bc1e42013-08-23 10:17:54 +080058 * or ACPI is disabled for this device due to consecutive errors.
Matthew Garrett30dcf762012-06-25 16:13:04 +080059 */
60acpi_handle ata_dev_acpi_handle(struct ata_device *dev)
Matthew Garrett6b66d952012-06-25 16:13:03 +080061{
Aaron Luf1bc1e42013-08-23 10:17:54 +080062 return dev->flags & ATA_DFLAG_ACPI_DISABLED ?
63 NULL : ACPI_HANDLE(&dev->tdev);
Matthew Garrett6b66d952012-06-25 16:13:03 +080064}
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -070065
Holger Macht664d0802008-06-03 20:27:59 +020066/* @ap and @dev are the same as ata_acpi_handle_hotplug() */
67static void ata_acpi_detach_device(struct ata_port *ap, struct ata_device *dev)
68{
69 if (dev)
70 dev->flags |= ATA_DFLAG_DETACH;
71 else {
72 struct ata_link *tlink;
73 struct ata_device *tdev;
74
Tejun Heo1eca4362008-11-03 20:03:17 +090075 ata_for_each_link(tlink, ap, EDGE)
76 ata_for_each_dev(tdev, tlink, ALL)
Holger Macht664d0802008-06-03 20:27:59 +020077 tdev->flags |= ATA_DFLAG_DETACH;
78 }
79
80 ata_port_schedule_eh(ap);
81}
82
83/**
84 * ata_acpi_handle_hotplug - ACPI event handler backend
85 * @ap: ATA port ACPI event occurred
86 * @dev: ATA device ACPI event occurred (can be NULL)
87 * @event: ACPI event which occurred
Holger Macht664d0802008-06-03 20:27:59 +020088 *
89 * All ACPI bay / device realted events end up in this function. If
90 * the event is port-wide @dev is NULL. If the event is specific to a
91 * device, @dev points to it.
92 *
93 * Hotplug (as opposed to unplug) notification is always handled as
94 * port-wide while unplug only kills the target device on device-wide
95 * event.
96 *
97 * LOCKING:
98 * ACPI notify handler context. May sleep.
99 */
100static void ata_acpi_handle_hotplug(struct ata_port *ap, struct ata_device *dev,
Shaohua Lif730ae12008-08-28 10:05:45 +0800101 u32 event)
Matthew Garrett237d8442007-10-03 01:24:16 +0100102{
Holger Macht664d0802008-06-03 20:27:59 +0200103 struct ata_eh_info *ehi = &ap->link.eh_info;
Tejun Heo233f1122008-03-12 14:24:43 +0900104 int wait = 0;
105 unsigned long flags;
Zhang Rui3c1e3892008-07-11 09:42:03 -0400106
Holger Macht664d0802008-06-03 20:27:59 +0200107 spin_lock_irqsave(ap->lock, flags);
Shaohua Lif730ae12008-08-28 10:05:45 +0800108 /*
109 * When dock driver calls into the routine, it will always use
110 * ACPI_NOTIFY_BUS_CHECK/ACPI_NOTIFY_DEVICE_CHECK for add and
111 * ACPI_NOTIFY_EJECT_REQUEST for remove
112 */
Tejun Heo233f1122008-03-12 14:24:43 +0900113 switch (event) {
114 case ACPI_NOTIFY_BUS_CHECK:
115 case ACPI_NOTIFY_DEVICE_CHECK:
116 ata_ehi_push_desc(ehi, "ACPI event");
Jeff Garzikc85665f2008-05-19 17:56:10 -0400117
Shaohua Lif730ae12008-08-28 10:05:45 +0800118 ata_ehi_hotplugged(ehi);
119 ata_port_freeze(ap);
Holger Macht664d0802008-06-03 20:27:59 +0200120 break;
121 case ACPI_NOTIFY_EJECT_REQUEST:
122 ata_ehi_push_desc(ehi, "ACPI event");
123
Holger Macht664d0802008-06-03 20:27:59 +0200124 ata_acpi_detach_device(ap, dev);
125 wait = 1;
126 break;
Matthew Garrett237d8442007-10-03 01:24:16 +0100127 }
128
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100129 spin_unlock_irqrestore(ap->lock, flags);
130
Aaron Luf1bc1e42013-08-23 10:17:54 +0800131 if (wait)
Matthew Garrettae6c23c2008-05-19 17:29:34 +0100132 ata_port_wait_eh(ap);
Holger Macht664d0802008-06-03 20:27:59 +0200133}
134
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100135static int ata_acpi_dev_notify_dock(struct acpi_device *adev, u32 event)
Holger Macht664d0802008-06-03 20:27:59 +0200136{
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100137 struct ata_device *dev = ata_hotplug_data(adev->hp).dev;
Shaohua Lif730ae12008-08-28 10:05:45 +0800138 ata_acpi_handle_hotplug(dev->link->ap, dev, event);
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100139 return 0;
Holger Macht664d0802008-06-03 20:27:59 +0200140}
141
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100142static int ata_acpi_ap_notify_dock(struct acpi_device *adev, u32 event)
Holger Macht664d0802008-06-03 20:27:59 +0200143{
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100144 ata_acpi_handle_hotplug(ata_hotplug_data(adev->hp).ap, NULL, event);
145 return 0;
Matthew Garrett237d8442007-10-03 01:24:16 +0100146}
147
Shaohua Li1253f7a2008-08-28 10:06:16 +0800148static void ata_acpi_uevent(struct ata_port *ap, struct ata_device *dev,
149 u32 event)
150{
151 struct kobject *kobj = NULL;
152 char event_string[20];
153 char *envp[] = { event_string, NULL };
154
155 if (dev) {
156 if (dev->sdev)
157 kobj = &dev->sdev->sdev_gendev.kobj;
158 } else
159 kobj = &ap->dev->kobj;
160
161 if (kobj) {
162 snprintf(event_string, 20, "BAY_EVENT=%d", event);
163 kobject_uevent_env(kobj, KOBJ_CHANGE, envp);
164 }
165}
166
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100167static void ata_acpi_ap_uevent(struct acpi_device *adev, u32 event)
Shaohua Li1253f7a2008-08-28 10:06:16 +0800168{
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100169 ata_acpi_uevent(ata_hotplug_data(adev->hp).ap, NULL, event);
Shaohua Li1253f7a2008-08-28 10:06:16 +0800170}
171
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100172static void ata_acpi_dev_uevent(struct acpi_device *adev, u32 event)
Shaohua Li1253f7a2008-08-28 10:06:16 +0800173{
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100174 struct ata_device *dev = ata_hotplug_data(adev->hp).dev;
Shaohua Li1253f7a2008-08-28 10:06:16 +0800175 ata_acpi_uevent(dev->link->ap, dev, event);
176}
177
Aaron Luf1bc1e42013-08-23 10:17:54 +0800178/* bind acpi handle to pata port */
179void ata_acpi_bind_port(struct ata_port *ap)
Aaron Lu44521522013-06-20 09:38:34 +0800180{
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100181 struct acpi_device *host_companion = ACPI_COMPANION(ap->host->dev);
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100182 struct acpi_device *adev;
183 struct ata_acpi_hotplug_context *context;
Aaron Lu44521522013-06-20 09:38:34 +0800184
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100185 if (libata_noacpi || ap->flags & ATA_FLAG_ACPI_SATA || !host_companion)
Aaron Luf1bc1e42013-08-23 10:17:54 +0800186 return;
Aaron Lu44521522013-06-20 09:38:34 +0800187
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100188 acpi_preset_companion(&ap->tdev, host_companion, ap->port_no);
Aaron Lu44521522013-06-20 09:38:34 +0800189
Aaron Luf1bc1e42013-08-23 10:17:54 +0800190 if (ata_acpi_gtm(ap, &ap->__acpi_init_gtm) == 0)
191 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
Aaron Lu44521522013-06-20 09:38:34 +0800192
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100193 adev = ACPI_COMPANION(&ap->tdev);
194 if (!adev || adev->hp)
195 return;
196
197 context = kzalloc(sizeof(*context), GFP_KERNEL);
198 if (!context)
199 return;
200
201 context->data.ap = ap;
202 acpi_initialize_hp_context(adev, &context->hp, ata_acpi_ap_notify_dock,
203 ata_acpi_ap_uevent);
Aaron Luf1bc1e42013-08-23 10:17:54 +0800204}
Aaron Lu44521522013-06-20 09:38:34 +0800205
Aaron Luf1bc1e42013-08-23 10:17:54 +0800206void ata_acpi_bind_dev(struct ata_device *dev)
207{
208 struct ata_port *ap = dev->link->ap;
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100209 struct acpi_device *port_companion = ACPI_COMPANION(&ap->tdev);
210 struct acpi_device *host_companion = ACPI_COMPANION(ap->host->dev);
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100211 struct acpi_device *parent, *adev;
212 struct ata_acpi_hotplug_context *context;
Aaron Luf1bc1e42013-08-23 10:17:54 +0800213 u64 adr;
214
215 /*
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100216 * For both sata/pata devices, host companion device is required.
217 * For pata device, port companion device is also required.
Aaron Luf1bc1e42013-08-23 10:17:54 +0800218 */
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100219 if (libata_noacpi || !host_companion ||
220 (!(ap->flags & ATA_FLAG_ACPI_SATA) && !port_companion))
Aaron Luf1bc1e42013-08-23 10:17:54 +0800221 return;
222
223 if (ap->flags & ATA_FLAG_ACPI_SATA) {
224 if (!sata_pmp_attached(ap))
225 adr = SATA_ADR(ap->port_no, NO_PORT_MULT);
226 else
227 adr = SATA_ADR(ap->port_no, dev->link->pmp);
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100228 parent = host_companion;
Aaron Luf1bc1e42013-08-23 10:17:54 +0800229 } else {
230 adr = dev->devno;
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100231 parent = port_companion;
Aaron Lu44521522013-06-20 09:38:34 +0800232 }
Aaron Luf1bc1e42013-08-23 10:17:54 +0800233
Rafael J. Wysocki9c5ad362013-11-28 23:58:28 +0100234 acpi_preset_companion(&dev->tdev, parent, adr);
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100235 adev = ACPI_COMPANION(&dev->tdev);
236 if (!adev || adev->hp)
237 return;
Aaron Luf1bc1e42013-08-23 10:17:54 +0800238
Rafael J. Wysocki5d513202014-02-22 00:48:31 +0100239 context = kzalloc(sizeof(*context), GFP_KERNEL);
240 if (!context)
241 return;
242
243 context->data.dev = dev;
244 acpi_initialize_hp_context(adev, &context->hp, ata_acpi_dev_notify_dock,
245 ata_acpi_dev_uevent);
Aaron Lu44521522013-06-20 09:38:34 +0800246}
247
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700248/**
Tejun Heo562f0c22007-12-15 15:05:01 +0900249 * ata_acpi_dissociate - dissociate ATA host from ACPI objects
250 * @host: target ATA host
251 *
252 * This function is called during driver detach after the whole host
253 * is shut down.
254 *
255 * LOCKING:
256 * EH context.
257 */
258void ata_acpi_dissociate(struct ata_host *host)
259{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900260 int i;
261
262 /* Restore initial _GTM values so that driver which attaches
263 * afterward can use them too.
264 */
265 for (i = 0; i < host->n_ports; i++) {
266 struct ata_port *ap = host->ports[i];
267 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
268
Aaron Luf1bc1e42013-08-23 10:17:54 +0800269 if (ACPI_HANDLE(&ap->tdev) && gtm)
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900270 ata_acpi_stm(ap, gtm);
271 }
Tejun Heo562f0c22007-12-15 15:05:01 +0900272}
273
Aaron Luf1bc1e42013-08-23 10:17:54 +0800274/**
275 * ata_acpi_gtm - execute _GTM
276 * @ap: target ATA port
277 * @gtm: out parameter for _GTM result
278 *
279 * Evaluate _GTM and store the result in @gtm.
280 *
281 * LOCKING:
282 * EH context.
283 *
284 * RETURNS:
285 * 0 on success, -ENOENT if _GTM doesn't exist, -errno on failure.
286 */
287int ata_acpi_gtm(struct ata_port *ap, struct ata_acpi_gtm *gtm)
Tejun Heo64578a3de2007-05-15 03:28:16 +0900288{
289 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
290 union acpi_object *out_obj;
291 acpi_status status;
292 int rc = 0;
Aaron Luf1bc1e42013-08-23 10:17:54 +0800293 acpi_handle handle = ACPI_HANDLE(&ap->tdev);
294
295 if (!handle)
296 return -EINVAL;
Tejun Heo64578a3de2007-05-15 03:28:16 +0900297
Aaron Lud66af4d2013-04-27 09:33:07 +0800298 status = acpi_evaluate_object(handle, "_GTM", NULL, &output);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900299
300 rc = -ENOENT;
301 if (status == AE_NOT_FOUND)
302 goto out_free;
303
304 rc = -EINVAL;
305 if (ACPI_FAILURE(status)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700306 ata_port_err(ap, "ACPI get timing mode failed (AE 0x%x)\n",
307 status);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900308 goto out_free;
309 }
310
311 out_obj = output.pointer;
312 if (out_obj->type != ACPI_TYPE_BUFFER) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700313 ata_port_warn(ap, "_GTM returned unexpected object type 0x%x\n",
314 out_obj->type);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900315
316 goto out_free;
317 }
318
319 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700320 ata_port_err(ap, "_GTM returned invalid length %d\n",
321 out_obj->buffer.length);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900322 goto out_free;
323 }
324
325 memcpy(gtm, out_obj->buffer.pointer, sizeof(struct ata_acpi_gtm));
326 rc = 0;
327 out_free:
328 kfree(output.pointer);
329 return rc;
330}
331
Alan Coxbadff032007-10-04 21:28:18 +0100332EXPORT_SYMBOL_GPL(ata_acpi_gtm);
333
Tejun Heo64578a3de2007-05-15 03:28:16 +0900334/**
335 * ata_acpi_stm - execute _STM
336 * @ap: target ATA port
337 * @stm: timing parameter to _STM
338 *
339 * Evaluate _STM with timing parameter @stm.
340 *
341 * LOCKING:
342 * EH context.
343 *
344 * RETURNS:
345 * 0 on success, -ENOENT if _STM doesn't exist, -errno on failure.
346 */
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900347int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
Tejun Heo64578a3de2007-05-15 03:28:16 +0900348{
349 acpi_status status;
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900350 struct ata_acpi_gtm stm_buf = *stm;
Tejun Heo64578a3de2007-05-15 03:28:16 +0900351 struct acpi_object_list input;
352 union acpi_object in_params[3];
353
354 in_params[0].type = ACPI_TYPE_BUFFER;
355 in_params[0].buffer.length = sizeof(struct ata_acpi_gtm);
Tejun Heo0d02f0b2007-12-15 15:04:57 +0900356 in_params[0].buffer.pointer = (u8 *)&stm_buf;
Tejun Heo64578a3de2007-05-15 03:28:16 +0900357 /* Buffers for id may need byteswapping ? */
358 in_params[1].type = ACPI_TYPE_BUFFER;
359 in_params[1].buffer.length = 512;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900360 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
Tejun Heo64578a3de2007-05-15 03:28:16 +0900361 in_params[2].type = ACPI_TYPE_BUFFER;
362 in_params[2].buffer.length = 512;
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900363 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
Tejun Heo64578a3de2007-05-15 03:28:16 +0900364
365 input.count = 3;
366 input.pointer = in_params;
367
Aaron Luf1bc1e42013-08-23 10:17:54 +0800368 status = acpi_evaluate_object(ACPI_HANDLE(&ap->tdev), "_STM",
369 &input, NULL);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900370
371 if (status == AE_NOT_FOUND)
372 return -ENOENT;
373 if (ACPI_FAILURE(status)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700374 ata_port_err(ap, "ACPI set timing mode failed (status=0x%x)\n",
375 status);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900376 return -EINVAL;
377 }
378 return 0;
379}
380
Alan Coxbadff032007-10-04 21:28:18 +0100381EXPORT_SYMBOL_GPL(ata_acpi_stm);
382
Tejun Heo64578a3de2007-05-15 03:28:16 +0900383/**
Tejun Heo4700c4b2007-05-15 03:28:16 +0900384 * ata_dev_get_GTF - get the drive bootup default taskfile settings
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900385 * @dev: target ATA device
Tejun Heo4700c4b2007-05-15 03:28:16 +0900386 * @gtf: output parameter for buffer containing _GTF taskfile arrays
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700387 *
388 * This applies to both PATA and SATA drives.
389 *
390 * The _GTF method has no input parameters.
391 * It returns a variable number of register set values (registers
392 * hex 1F1..1F7, taskfiles).
393 * The <variable number> is not known in advance, so have ACPI-CA
394 * allocate the buffer as needed and return it, then free it later.
395 *
Tejun Heo4700c4b2007-05-15 03:28:16 +0900396 * LOCKING:
397 * EH context.
398 *
399 * RETURNS:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900400 * Number of taskfiles on success, 0 if _GTF doesn't exist. -EINVAL
401 * if _GTF is invalid.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700402 */
Tejun Heo398e0782007-12-15 15:05:03 +0900403static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700404{
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900405 acpi_status status;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900406 struct acpi_buffer output;
407 union acpi_object *out_obj;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900408 int rc = 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700409
Tejun Heo398e0782007-12-15 15:05:03 +0900410 /* if _GTF is cached, use the cached value */
411 if (dev->gtf_cache) {
412 out_obj = dev->gtf_cache;
413 goto done;
414 }
415
Tejun Heo4700c4b2007-05-15 03:28:16 +0900416 /* set up output buffer */
417 output.length = ACPI_ALLOCATE_BUFFER;
418 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700419
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700420 /* _GTF has no input parameters */
Matthew Garrett30dcf762012-06-25 16:13:04 +0800421 status = acpi_evaluate_object(ata_dev_acpi_handle(dev), "_GTF", NULL,
422 &output);
Tejun Heo398e0782007-12-15 15:05:03 +0900423 out_obj = dev->gtf_cache = output.pointer;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900424
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700425 if (ACPI_FAILURE(status)) {
Tejun Heo4700c4b2007-05-15 03:28:16 +0900426 if (status != AE_NOT_FOUND) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700427 ata_dev_warn(dev, "_GTF evaluation failed (AE 0x%x)\n",
428 status);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900429 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900430 }
431 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700432 }
433
434 if (!output.length || !output.pointer) {
Hannes Reinecke17a1e1b2021-12-21 08:21:05 +0100435 ata_dev_dbg(dev, "Run _GTF: length or ptr is NULL (0x%llx, 0x%p)\n",
436 (unsigned long long)output.length,
437 output.pointer);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900438 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900439 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700440 }
441
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700442 if (out_obj->type != ACPI_TYPE_BUFFER) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700443 ata_dev_warn(dev, "_GTF unexpected object type 0x%x\n",
444 out_obj->type);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900445 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900446 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700447 }
448
Tejun Heo4700c4b2007-05-15 03:28:16 +0900449 if (out_obj->buffer.length % REGS_PER_GTF) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700450 ata_dev_warn(dev, "unexpected _GTF length (%d)\n",
451 out_obj->buffer.length);
Tejun Heo66fa7f22007-12-15 15:05:04 +0900452 rc = -EINVAL;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900453 goto out_free;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700454 }
455
Tejun Heo398e0782007-12-15 15:05:03 +0900456 done:
Tejun Heo4700c4b2007-05-15 03:28:16 +0900457 rc = out_obj->buffer.length / REGS_PER_GTF;
Tejun Heo398e0782007-12-15 15:05:03 +0900458 if (gtf) {
459 *gtf = (void *)out_obj->buffer.pointer;
Hannes Reinecke17a1e1b2021-12-21 08:21:05 +0100460 ata_dev_dbg(dev, "returning gtf=%p, gtf_count=%d\n",
461 *gtf, rc);
Tejun Heo398e0782007-12-15 15:05:03 +0900462 }
Tejun Heo4700c4b2007-05-15 03:28:16 +0900463 return rc;
464
465 out_free:
Tejun Heo398e0782007-12-15 15:05:03 +0900466 ata_acpi_clear_gtf(dev);
Tejun Heo4700c4b2007-05-15 03:28:16 +0900467 return rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700468}
469
Tejun Heo7c77fa42007-12-18 16:33:03 +0900470/**
Lee Jonesc86a2a22021-03-18 08:51:49 +0000471 * ata_acpi_gtm_xfermask - determine xfermode from GTM parameter
Tejun Heo7c77fa42007-12-18 16:33:03 +0900472 * @dev: target device
473 * @gtm: GTM parameter to use
474 *
475 * Determine xfermask for @dev from @gtm.
476 *
477 * LOCKING:
478 * None.
479 *
480 * RETURNS:
481 * Determined xfermask.
482 */
Sergey Shtylyovf0a6d772022-06-14 22:51:47 +0300483unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
484 const struct ata_acpi_gtm *gtm)
Tejun Heo7c77fa42007-12-18 16:33:03 +0900485{
Sergey Shtylyovf0a6d772022-06-14 22:51:47 +0300486 unsigned int xfer_mask = 0;
Tejun Heoa0f79b92007-12-18 16:33:05 +0900487 unsigned int type;
488 int unit;
489 u8 mode;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900490
491 /* we always use the 0 slot for crap hardware */
492 unit = dev->devno;
493 if (!(gtm->flags & 0x10))
494 unit = 0;
495
Tejun Heoa0f79b92007-12-18 16:33:05 +0900496 /* PIO */
497 mode = ata_timing_cycle2mode(ATA_SHIFT_PIO, gtm->drive[unit].pio);
498 xfer_mask |= ata_xfer_mode2mask(mode);
Tejun Heo7c77fa42007-12-18 16:33:03 +0900499
500 /* See if we have MWDMA or UDMA data. We don't bother with
501 * MWDMA if UDMA is available as this means the BIOS set UDMA
502 * and our error changedown if it works is UDMA to PIO anyway.
503 */
Tejun Heoa0f79b92007-12-18 16:33:05 +0900504 if (!(gtm->flags & (1 << (2 * unit))))
505 type = ATA_SHIFT_MWDMA;
506 else
507 type = ATA_SHIFT_UDMA;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900508
Tejun Heoa0f79b92007-12-18 16:33:05 +0900509 mode = ata_timing_cycle2mode(type, gtm->drive[unit].dma);
510 xfer_mask |= ata_xfer_mode2mask(mode);
511
512 return xfer_mask;
Tejun Heo7c77fa42007-12-18 16:33:03 +0900513}
514EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
515
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700516/**
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400517 * ata_acpi_cbl_80wire - Check for 80 wire cable
518 * @ap: Port to check
Tejun Heo021ee9a2007-12-18 16:33:06 +0900519 * @gtm: GTM data to use
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400520 *
Tejun Heo021ee9a2007-12-18 16:33:06 +0900521 * Return 1 if the @gtm indicates the BIOS selected an 80wire mode.
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400522 */
Tejun Heo021ee9a2007-12-18 16:33:06 +0900523int ata_acpi_cbl_80wire(struct ata_port *ap, const struct ata_acpi_gtm *gtm)
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400524{
Tejun Heo021ee9a2007-12-18 16:33:06 +0900525 struct ata_device *dev;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400526
Tejun Heo1eca4362008-11-03 20:03:17 +0900527 ata_for_each_dev(dev, &ap->link, ENABLED) {
Sergey Shtylyovf0a6d772022-06-14 22:51:47 +0300528 unsigned int xfer_mask, udma_mask;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400529
Tejun Heo021ee9a2007-12-18 16:33:06 +0900530 xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
531 ata_unpack_xfermask(xfer_mask, NULL, NULL, &udma_mask);
532
533 if (udma_mask & ~ATA_UDMA_MASK_40C)
534 return 1;
535 }
536
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400537 return 0;
538}
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400539EXPORT_SYMBOL_GPL(ata_acpi_cbl_80wire);
540
Tejun Heo3264a8d2007-12-15 15:05:06 +0900541static void ata_acpi_gtf_to_tf(struct ata_device *dev,
542 const struct ata_acpi_gtf *gtf,
543 struct ata_taskfile *tf)
544{
545 ata_tf_init(dev, tf);
546
547 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
548 tf->protocol = ATA_PROT_NODATA;
Sergey Shtylyovefcef262022-02-15 21:49:26 +0300549 tf->error = gtf->tf[0]; /* 0x1f1 */
Tejun Heo3264a8d2007-12-15 15:05:06 +0900550 tf->nsect = gtf->tf[1]; /* 0x1f2 */
551 tf->lbal = gtf->tf[2]; /* 0x1f3 */
552 tf->lbam = gtf->tf[3]; /* 0x1f4 */
553 tf->lbah = gtf->tf[4]; /* 0x1f5 */
554 tf->device = gtf->tf[5]; /* 0x1f6 */
Sergey Shtylyovefcef262022-02-15 21:49:26 +0300555 tf->status = gtf->tf[6]; /* 0x1f7 */
Tejun Heo3264a8d2007-12-15 15:05:06 +0900556}
557
Tejun Heo110f66d2009-09-16 04:17:28 +0900558static int ata_acpi_filter_tf(struct ata_device *dev,
559 const struct ata_taskfile *tf,
Tejun Heo3264a8d2007-12-15 15:05:06 +0900560 const struct ata_taskfile *ptf)
561{
Tejun Heo110f66d2009-09-16 04:17:28 +0900562 if (dev->gtf_filter & ATA_ACPI_FILTER_SETXFER) {
Tejun Heo3264a8d2007-12-15 15:05:06 +0900563 /* libata doesn't use ACPI to configure transfer mode.
564 * It will only confuse device configuration. Skip.
565 */
566 if (tf->command == ATA_CMD_SET_FEATURES &&
567 tf->feature == SETFEATURES_XFER)
568 return 1;
569 }
570
Tejun Heo110f66d2009-09-16 04:17:28 +0900571 if (dev->gtf_filter & ATA_ACPI_FILTER_LOCK) {
Tejun Heo3264a8d2007-12-15 15:05:06 +0900572 /* BIOS writers, sorry but we don't wanna lock
573 * features unless the user explicitly said so.
574 */
575
576 /* DEVICE CONFIGURATION FREEZE LOCK */
577 if (tf->command == ATA_CMD_CONF_OVERLAY &&
578 tf->feature == ATA_DCO_FREEZE_LOCK)
579 return 1;
580
581 /* SECURITY FREEZE LOCK */
582 if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
583 return 1;
584
585 /* SET MAX LOCK and SET MAX FREEZE LOCK */
586 if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
587 tf->command == ATA_CMD_SET_MAX &&
588 (tf->feature == ATA_SET_MAX_LOCK ||
589 tf->feature == ATA_SET_MAX_FREEZE_LOCK))
590 return 1;
591 }
592
Tejun Heofa5b5612009-09-16 04:17:02 +0900593 if (tf->command == ATA_CMD_SET_FEATURES &&
594 tf->feature == SETFEATURES_SATA_ENABLE) {
Tejun Heob3449912008-07-06 23:15:03 +0900595 /* inhibit enabling DIPM */
Tejun Heo110f66d2009-09-16 04:17:28 +0900596 if (dev->gtf_filter & ATA_ACPI_FILTER_DIPM &&
Tejun Heob3449912008-07-06 23:15:03 +0900597 tf->nsect == SATA_DIPM)
598 return 1;
Tejun Heofa5b5612009-09-16 04:17:02 +0900599
600 /* inhibit FPDMA non-zero offset */
Tejun Heo110f66d2009-09-16 04:17:28 +0900601 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_OFFSET &&
Tejun Heofa5b5612009-09-16 04:17:02 +0900602 (tf->nsect == SATA_FPDMA_OFFSET ||
603 tf->nsect == SATA_FPDMA_IN_ORDER))
604 return 1;
605
606 /* inhibit FPDMA auto activation */
Tejun Heo110f66d2009-09-16 04:17:28 +0900607 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_AA &&
Tejun Heofa5b5612009-09-16 04:17:02 +0900608 tf->nsect == SATA_FPDMA_AA)
609 return 1;
Tejun Heob3449912008-07-06 23:15:03 +0900610 }
611
Tejun Heo3264a8d2007-12-15 15:05:06 +0900612 return 0;
613}
614
Alan Coxe1ddb4b2007-08-16 02:33:36 -0400615/**
Tejun Heo0e8634b2007-12-15 15:05:05 +0900616 * ata_acpi_run_tf - send taskfile registers to host controller
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900617 * @dev: target ATA device
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700618 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
Lee Jonesc86a2a22021-03-18 08:51:49 +0000619 * @prev_gtf: previous command
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700620 *
Sergei Shtylyov3696df32011-02-04 22:04:17 +0300621 * Outputs ATA taskfile to standard ATA host controller.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700622 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
623 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
624 * hob_lbal, hob_lbam, and hob_lbah.
625 *
626 * This function waits for idle (!BUSY and !DRQ) after writing
627 * registers. If the control register has a new value, this
628 * function also waits for idle after writing control and before
629 * writing the remaining registers.
630 *
Tejun Heo4700c4b2007-05-15 03:28:16 +0900631 * LOCKING:
632 * EH context.
633 *
634 * RETURNS:
Tejun Heo3264a8d2007-12-15 15:05:06 +0900635 * 1 if command is executed successfully. 0 if ignored, rejected or
636 * filtered out, -errno on other errors.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700637 */
Tejun Heo0e8634b2007-12-15 15:05:05 +0900638static int ata_acpi_run_tf(struct ata_device *dev,
Tejun Heo3264a8d2007-12-15 15:05:06 +0900639 const struct ata_acpi_gtf *gtf,
640 const struct ata_acpi_gtf *prev_gtf)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700641{
Tejun Heo3264a8d2007-12-15 15:05:06 +0900642 struct ata_taskfile *pptf = NULL;
643 struct ata_taskfile tf, ptf, rtf;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900644 unsigned int err_mask;
Robert Hancock65211482009-07-14 20:43:39 -0600645 const char *descr;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900646 int rc;
Jeff Garzikfc16c252007-02-24 21:05:01 -0500647
Tejun Heo4700c4b2007-05-15 03:28:16 +0900648 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
649 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
650 && (gtf->tf[6] == 0))
651 return 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700652
Tejun Heo3264a8d2007-12-15 15:05:06 +0900653 ata_acpi_gtf_to_tf(dev, gtf, &tf);
654 if (prev_gtf) {
655 ata_acpi_gtf_to_tf(dev, prev_gtf, &ptf);
656 pptf = &ptf;
657 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700658
Hannes Reinecked4520902021-12-21 08:20:36 +0100659 descr = ata_get_cmd_name(tf.command);
Hannes Reinecke742bef42021-12-21 08:20:35 +0100660
Tejun Heo110f66d2009-09-16 04:17:28 +0900661 if (!ata_acpi_filter_tf(dev, &tf, pptf)) {
Tejun Heo3264a8d2007-12-15 15:05:06 +0900662 rtf = tf;
663 err_mask = ata_exec_internal(dev, &rtf, NULL,
664 DMA_NONE, NULL, 0, 0);
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700665
Tejun Heo3264a8d2007-12-15 15:05:06 +0900666 switch (err_mask) {
667 case 0:
Hannes Reinecke742bef42021-12-21 08:20:35 +0100668 ata_dev_dbg(dev,
669 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
670 "(%s) succeeded\n",
671 tf.command, tf.feature, tf.nsect, tf.lbal,
672 tf.lbam, tf.lbah, tf.device, descr);
Tejun Heo3264a8d2007-12-15 15:05:06 +0900673 rc = 1;
674 break;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900675
Tejun Heo3264a8d2007-12-15 15:05:06 +0900676 case AC_ERR_DEV:
Hannes Reinecke742bef42021-12-21 08:20:35 +0100677 ata_dev_info(dev,
678 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
679 "(%s) rejected by device (Stat=0x%02x Err=0x%02x)",
680 tf.command, tf.feature, tf.nsect, tf.lbal,
681 tf.lbam, tf.lbah, tf.device, descr,
Sergey Shtylyovefcef262022-02-15 21:49:26 +0300682 rtf.status, rtf.error);
Tejun Heo3264a8d2007-12-15 15:05:06 +0900683 rc = 0;
684 break;
Tejun Heo0e8634b2007-12-15 15:05:05 +0900685
Tejun Heo3264a8d2007-12-15 15:05:06 +0900686 default:
Hannes Reinecke742bef42021-12-21 08:20:35 +0100687 ata_dev_err(dev,
688 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
689 "(%s) failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
690 tf.command, tf.feature, tf.nsect, tf.lbal,
691 tf.lbam, tf.lbah, tf.device, descr,
Sergey Shtylyovefcef262022-02-15 21:49:26 +0300692 err_mask, rtf.status, rtf.error);
Tejun Heo3264a8d2007-12-15 15:05:06 +0900693 rc = -EIO;
694 break;
695 }
696 } else {
Hannes Reinecke742bef42021-12-21 08:20:35 +0100697 ata_dev_info(dev,
698 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
699 "(%s) filtered out\n",
700 tf.command, tf.feature, tf.nsect, tf.lbal,
701 tf.lbam, tf.lbah, tf.device, descr);
Tejun Heo0e8634b2007-12-15 15:05:05 +0900702 rc = 0;
Tejun Heo4700c4b2007-05-15 03:28:16 +0900703 }
Tejun Heo0e8634b2007-12-15 15:05:05 +0900704 return rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700705}
706
707/**
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700708 * ata_acpi_exec_tfs - get then write drive taskfile settings
Tejun Heo67465442007-05-15 03:28:16 +0900709 * @dev: target ATA device
Martin Olsson98a17082009-04-22 18:21:29 +0200710 * @nr_executed: out parameter for the number of executed commands
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700711 *
Martin Olsson98a17082009-04-22 18:21:29 +0200712 * Evaluate _GTF and execute returned taskfiles.
Tejun Heo69b16a52007-05-15 03:28:16 +0900713 *
714 * LOCKING:
715 * EH context.
716 *
717 * RETURNS:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900718 * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
719 * -errno on other errors.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700720 */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900721static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700722{
Tejun Heo3264a8d2007-12-15 15:05:06 +0900723 struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
Tejun Heo67465442007-05-15 03:28:16 +0900724 int gtf_count, i, rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700725
Tejun Heo67465442007-05-15 03:28:16 +0900726 /* get taskfiles */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900727 rc = ata_dev_get_GTF(dev, &gtf);
728 if (rc < 0)
729 return rc;
730 gtf_count = rc;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700731
Tejun Heo67465442007-05-15 03:28:16 +0900732 /* execute them */
Tejun Heo3264a8d2007-12-15 15:05:06 +0900733 for (i = 0; i < gtf_count; i++, gtf++) {
734 rc = ata_acpi_run_tf(dev, gtf, pgtf);
Tejun Heo0e8634b2007-12-15 15:05:05 +0900735 if (rc < 0)
736 break;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900737 if (rc) {
Tejun Heo0e8634b2007-12-15 15:05:05 +0900738 (*nr_executed)++;
Tejun Heo3264a8d2007-12-15 15:05:06 +0900739 pgtf = gtf;
740 }
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700741 }
742
Tejun Heo398e0782007-12-15 15:05:03 +0900743 ata_acpi_clear_gtf(dev);
Tejun Heo67465442007-05-15 03:28:16 +0900744
Tejun Heo0e8634b2007-12-15 15:05:05 +0900745 if (rc < 0)
746 return rc;
747 return 0;
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700748}
749
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700750/**
751 * ata_acpi_push_id - send Identify data to drive
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900752 * @dev: target ATA device
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700753 *
754 * _SDD ACPI object: for SATA mode only
755 * Must be after Identify (Packet) Device -- uses its data
756 * ATM this function never returns a failure. It is an optional
757 * method and if it fails for whatever reason, we should still
758 * just keep going.
Tejun Heo69b16a52007-05-15 03:28:16 +0900759 *
760 * LOCKING:
761 * EH context.
762 *
763 * RETURNS:
Tejun Heof2406772009-11-18 22:24:21 +0900764 * 0 on success, -ENOENT if _SDD doesn't exist, -errno on failure.
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700765 */
Tejun Heo67465442007-05-15 03:28:16 +0900766static int ata_acpi_push_id(struct ata_device *dev)
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700767{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900768 struct ata_port *ap = dev->link->ap;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900769 acpi_status status;
770 struct acpi_object_list input;
771 union acpi_object in_params[1];
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700772
Hannes Reinecke17a1e1b2021-12-21 08:21:05 +0100773 ata_dev_dbg(dev, "%s: ix = %d, port#: %d\n",
774 __func__, dev->devno, ap->port_no);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700775
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700776 /* Give the drive Identify data to the drive via the _SDD method */
777 /* _SDD: set up input parameters */
778 input.count = 1;
779 input.pointer = in_params;
780 in_params[0].type = ACPI_TYPE_BUFFER;
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900781 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
782 in_params[0].buffer.pointer = (u8 *)dev->id;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700783 /* Output buffer: _SDD has no output */
784
785 /* It's OK for _SDD to be missing too. */
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900786 swap_buf_le16(dev->id, ATA_ID_WORDS);
Matthew Garrett30dcf762012-06-25 16:13:04 +0800787 status = acpi_evaluate_object(ata_dev_acpi_handle(dev), "_SDD", &input,
788 NULL);
Tejun Heo3a32a8e2007-05-05 23:50:38 +0900789 swap_buf_le16(dev->id, ATA_ID_WORDS);
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700790
Tejun Heof2406772009-11-18 22:24:21 +0900791 if (status == AE_NOT_FOUND)
792 return -ENOENT;
793
794 if (ACPI_FAILURE(status)) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700795 ata_dev_warn(dev, "ACPI _SDD failed (AE 0x%x)\n", status);
Tejun Heof2406772009-11-18 22:24:21 +0900796 return -EIO;
797 }
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700798
Tejun Heof2406772009-11-18 22:24:21 +0900799 return 0;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700800}
801
Tejun Heo67465442007-05-15 03:28:16 +0900802/**
803 * ata_acpi_on_resume - ATA ACPI hook called on resume
804 * @ap: target ATA port
805 *
806 * This function is called when @ap is resumed - right after port
807 * itself is resumed but before any EH action is taken.
808 *
809 * LOCKING:
810 * EH context.
811 */
812void ata_acpi_on_resume(struct ata_port *ap)
813{
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900814 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
Tejun Heof58229f2007-08-06 18:36:23 +0900815 struct ata_device *dev;
Kristen Carlson Accardi7ea1fbc2006-09-28 11:29:12 -0700816
Aaron Luf1bc1e42013-08-23 10:17:54 +0800817 if (ACPI_HANDLE(&ap->tdev) && gtm) {
Tejun Heo398e0782007-12-15 15:05:03 +0900818 /* _GTM valid */
819
820 /* restore timing parameters */
Tejun Heoc05e6ff2007-12-15 15:05:02 +0900821 ata_acpi_stm(ap, gtm);
Tejun Heo64578a3de2007-05-15 03:28:16 +0900822
Tejun Heo398e0782007-12-15 15:05:03 +0900823 /* _GTF should immediately follow _STM so that it can
824 * use values set by _STM. Cache _GTF result and
825 * schedule _GTF.
826 */
Tejun Heo1eca4362008-11-03 20:03:17 +0900827 ata_for_each_dev(dev, &ap->link, ALL) {
Tejun Heo398e0782007-12-15 15:05:03 +0900828 ata_acpi_clear_gtf(dev);
Shaohua Li48feb3c2008-03-25 16:50:45 +0800829 if (ata_dev_enabled(dev) &&
Aaron Luc75da202014-03-14 13:46:09 +0800830 ata_dev_acpi_handle(dev) &&
Shaohua Li48feb3c2008-03-25 16:50:45 +0800831 ata_dev_get_GTF(dev, NULL) >= 0)
Tejun Heo398e0782007-12-15 15:05:03 +0900832 dev->flags |= ATA_DFLAG_ACPI_PENDING;
833 }
834 } else {
835 /* SATA _GTF needs to be evaulated after _SDD and
836 * there's no reason to evaluate IDE _GTF early
837 * without _STM. Clear cache and schedule _GTF.
838 */
Tejun Heo1eca4362008-11-03 20:03:17 +0900839 ata_for_each_dev(dev, &ap->link, ALL) {
Tejun Heo398e0782007-12-15 15:05:03 +0900840 ata_acpi_clear_gtf(dev);
Shaohua Li48feb3c2008-03-25 16:50:45 +0800841 if (ata_dev_enabled(dev))
842 dev->flags |= ATA_DFLAG_ACPI_PENDING;
Tejun Heo398e0782007-12-15 15:05:03 +0900843 }
844 }
Tejun Heo67465442007-05-15 03:28:16 +0900845}
846
Aaron Lua7ff60d2013-01-25 14:29:35 +0800847static int ata_acpi_choose_suspend_state(struct ata_device *dev, bool runtime)
Shaohua Libd3adca2007-11-02 09:32:38 +0800848{
Aaron Lu21334202013-01-15 17:21:01 +0800849 int d_max_in = ACPI_STATE_D3_COLD;
Aaron Lua7ff60d2013-01-25 14:29:35 +0800850 if (!runtime)
851 goto out;
Aaron Lu21334202013-01-15 17:21:01 +0800852
853 /*
854 * For ATAPI, runtime D3 cold is only allowed
855 * for ZPODD in zero power ready state
856 */
857 if (dev->class == ATA_DEV_ATAPI &&
858 !(zpodd_dev_enabled(dev) && zpodd_zpready(dev)))
859 d_max_in = ACPI_STATE_D3_HOT;
860
Aaron Lua7ff60d2013-01-25 14:29:35 +0800861out:
Aaron Luf1bc1e42013-08-23 10:17:54 +0800862 return acpi_pm_device_sleep_state(&dev->tdev, NULL, d_max_in);
Aaron Lu21334202013-01-15 17:21:01 +0800863}
864
Aaron Lua7ff60d2013-01-25 14:29:35 +0800865static void sata_acpi_set_state(struct ata_port *ap, pm_message_t state)
866{
867 bool runtime = PMSG_IS_AUTO(state);
Shaohua Libd3adca2007-11-02 09:32:38 +0800868 struct ata_device *dev;
Lin Mingfebe53b2012-06-25 16:13:05 +0800869 acpi_handle handle;
Lin Ming3bd46600a72012-06-25 16:13:06 +0800870 int acpi_state;
Shaohua Libd3adca2007-11-02 09:32:38 +0800871
Tejun Heo1eca4362008-11-03 20:03:17 +0900872 ata_for_each_dev(dev, &ap->link, ENABLED) {
Lin Mingfebe53b2012-06-25 16:13:05 +0800873 handle = ata_dev_acpi_handle(dev);
Lin Ming3bd46600a72012-06-25 16:13:06 +0800874 if (!handle)
875 continue;
876
Aaron Lua7ff60d2013-01-25 14:29:35 +0800877 if (!(state.event & PM_EVENT_RESUME)) {
878 acpi_state = ata_acpi_choose_suspend_state(dev, runtime);
879 if (acpi_state == ACPI_STATE_D0)
880 continue;
881 if (runtime && zpodd_dev_enabled(dev) &&
882 acpi_state == ACPI_STATE_D3_COLD)
883 zpodd_enable_run_wake(dev);
884 acpi_bus_set_power(handle, acpi_state);
Lin Ming3bd46600a72012-06-25 16:13:06 +0800885 } else {
Aaron Lua7ff60d2013-01-25 14:29:35 +0800886 if (runtime && zpodd_dev_enabled(dev))
887 zpodd_disable_run_wake(dev);
Lin Ming3bd46600a72012-06-25 16:13:06 +0800888 acpi_bus_set_power(handle, ACPI_STATE_D0);
889 }
Shaohua Libd3adca2007-11-02 09:32:38 +0800890 }
Aaron Lua7ff60d2013-01-25 14:29:35 +0800891}
Lin Mingfebe53b2012-06-25 16:13:05 +0800892
Aaron Lua7ff60d2013-01-25 14:29:35 +0800893/* ACPI spec requires _PS0 when IDE power on and _PS3 when power off */
894static void pata_acpi_set_state(struct ata_port *ap, pm_message_t state)
895{
896 struct ata_device *dev;
897 acpi_handle port_handle;
898
Aaron Luf1bc1e42013-08-23 10:17:54 +0800899 port_handle = ACPI_HANDLE(&ap->tdev);
Aaron Lua7ff60d2013-01-25 14:29:35 +0800900 if (!port_handle)
901 return;
902
903 /* channel first and then drives for power on and vica versa
904 for power off */
905 if (state.event & PM_EVENT_RESUME)
906 acpi_bus_set_power(port_handle, ACPI_STATE_D0);
907
908 ata_for_each_dev(dev, &ap->link, ENABLED) {
909 acpi_handle dev_handle = ata_dev_acpi_handle(dev);
910 if (!dev_handle)
911 continue;
912
913 acpi_bus_set_power(dev_handle, state.event & PM_EVENT_RESUME ?
Rafael J. Wysocki8ad928d2013-07-30 14:36:20 +0200914 ACPI_STATE_D0 : ACPI_STATE_D3_COLD);
Aaron Lua7ff60d2013-01-25 14:29:35 +0800915 }
916
917 if (!(state.event & PM_EVENT_RESUME))
Rafael J. Wysocki8ad928d2013-07-30 14:36:20 +0200918 acpi_bus_set_power(port_handle, ACPI_STATE_D3_COLD);
Aaron Lua7ff60d2013-01-25 14:29:35 +0800919}
920
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700921/**
922 * ata_acpi_set_state - set the port power state
923 * @ap: target ATA port
924 * @state: state, on/off
925 *
Aaron Lua7ff60d2013-01-25 14:29:35 +0800926 * This function sets a proper ACPI D state for the device on
927 * system and runtime PM operations.
Kristen Carlson Accardi11ef6972006-09-28 11:29:01 -0700928 */
929void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
930{
Aaron Lua7ff60d2013-01-25 14:29:35 +0800931 if (ap->flags & ATA_FLAG_ACPI_SATA)
932 sata_acpi_set_state(ap, state);
933 else
934 pata_acpi_set_state(ap, state);
Shaohua Libd3adca2007-11-02 09:32:38 +0800935}
936
937/**
Tejun Heo67465442007-05-15 03:28:16 +0900938 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
939 * @dev: target ATA device
940 *
941 * This function is called when @dev is about to be configured.
942 * IDENTIFY data might have been modified after this hook is run.
943 *
944 * LOCKING:
945 * EH context.
946 *
947 * RETURNS:
948 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
949 * -errno on failure.
950 */
951int ata_acpi_on_devcfg(struct ata_device *dev)
952{
Tejun Heo9af5c9c2007-08-06 18:36:22 +0900953 struct ata_port *ap = dev->link->ap;
954 struct ata_eh_context *ehc = &ap->link.eh_context;
Tejun Heo67465442007-05-15 03:28:16 +0900955 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
Tejun Heo66fa7f22007-12-15 15:05:04 +0900956 int nr_executed = 0;
Tejun Heo67465442007-05-15 03:28:16 +0900957 int rc;
958
Matthew Garrett30dcf762012-06-25 16:13:04 +0800959 if (!ata_dev_acpi_handle(dev))
Tejun Heo67465442007-05-15 03:28:16 +0900960 return 0;
961
962 /* do we need to do _GTF? */
963 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
964 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
965 return 0;
966
967 /* do _SDD if SATA */
968 if (acpi_sata) {
969 rc = ata_acpi_push_id(dev);
Tejun Heof2406772009-11-18 22:24:21 +0900970 if (rc && rc != -ENOENT)
Tejun Heo67465442007-05-15 03:28:16 +0900971 goto acpi_err;
972 }
973
974 /* do _GTF */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900975 rc = ata_acpi_exec_tfs(dev, &nr_executed);
976 if (rc)
Tejun Heo67465442007-05-15 03:28:16 +0900977 goto acpi_err;
978
979 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
980
981 /* refresh IDENTIFY page if any _GTF command has been executed */
Tejun Heo66fa7f22007-12-15 15:05:04 +0900982 if (nr_executed) {
Tejun Heo67465442007-05-15 03:28:16 +0900983 rc = ata_dev_reread_id(dev, 0);
984 if (rc < 0) {
Joe Perchesa9a79df2011-04-15 15:51:59 -0700985 ata_dev_err(dev,
986 "failed to IDENTIFY after ACPI commands\n");
Tejun Heo67465442007-05-15 03:28:16 +0900987 return rc;
988 }
989 }
990
991 return 0;
992
993 acpi_err:
Tejun Heo66fa7f22007-12-15 15:05:04 +0900994 /* ignore evaluation failure if we can continue safely */
Niklas Cassel4cb7c6f2022-10-07 15:23:38 +0200995 if (rc == -EINVAL && !nr_executed && !ata_port_is_frozen(ap))
Tejun Heo66fa7f22007-12-15 15:05:04 +0900996 return 0;
Tejun Heo67465442007-05-15 03:28:16 +0900997
Tejun Heo66fa7f22007-12-15 15:05:04 +0900998 /* fail and let EH retry once more for unknown IO errors */
999 if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
1000 dev->flags |= ATA_DFLAG_ACPI_FAILED;
1001 return rc;
Tejun Heo67465442007-05-15 03:28:16 +09001002 }
Tejun Heo66fa7f22007-12-15 15:05:04 +09001003
Aaron Lu0d0cdb02012-11-26 13:55:25 +08001004 dev->flags |= ATA_DFLAG_ACPI_DISABLED;
Joe Perchesa9a79df2011-04-15 15:51:59 -07001005 ata_dev_warn(dev, "ACPI: failed the second time, disabled\n");
Tejun Heo66fa7f22007-12-15 15:05:04 +09001006
1007 /* We can safely continue if no _GTF command has been executed
1008 * and port is not frozen.
1009 */
Niklas Cassel4cb7c6f2022-10-07 15:23:38 +02001010 if (!nr_executed && !ata_port_is_frozen(ap))
Tejun Heo66fa7f22007-12-15 15:05:04 +09001011 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}