1// SPDX-License-Identifier: GPL-2.0-only
2/*
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
10#include <linux/module.h>
11#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>
19#include <linux/slab.h>
20#include <linux/pm_runtime.h>
21#include <scsi/scsi_device.h>
22#include "libata.h"
23
24unsigned int ata_acpi_gtf_filter = ATA_ACPI_FILTER_DEFAULT;
25module_param_named(acpi_gtf_filter, ata_acpi_gtf_filter, int, 0644);
26MODULE_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)");
27
28#define NO_PORT_MULT 0xffff
29#define SATA_ADR(root, pmp) (((root) << 16) | (pmp))
30
31#define REGS_PER_GTF 7
32struct ata_acpi_gtf {
33 u8 tf[REGS_PER_GTF]; /* regs. 0x1f1 - 0x1f7 */
34} __packed;
35
36static void ata_acpi_clear_gtf(struct ata_device *dev)
37{
38 kfree(objp: dev->gtf_cache);
39 dev->gtf_cache = NULL;
40}
41
42struct 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
52/**
53 * ata_dev_acpi_handle - provide the acpi_handle for an ata_device
54 * @dev: the acpi_handle returned will correspond to this device
55 *
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
58 * or ACPI is disabled for this device due to consecutive errors.
59 */
60acpi_handle ata_dev_acpi_handle(struct ata_device *dev)
61{
62 return dev->flags & ATA_DFLAG_ACPI_DISABLED ?
63 NULL : ACPI_HANDLE(&dev->tdev);
64}
65
66/* @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
75 ata_for_each_link(tlink, ap, EDGE)
76 ata_for_each_dev(tdev, tlink, ALL)
77 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
88 *
89 * All ACPI bay / device related 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,
101 u32 event)
102{
103 struct ata_eh_info *ehi = &ap->link.eh_info;
104 int wait = 0;
105 unsigned long flags;
106
107 spin_lock_irqsave(ap->lock, flags);
108 /*
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 */
113 switch (event) {
114 case ACPI_NOTIFY_BUS_CHECK:
115 case ACPI_NOTIFY_DEVICE_CHECK:
116 ata_ehi_push_desc(ehi, fmt: "ACPI event");
117
118 ata_ehi_hotplugged(ehi);
119 ata_port_freeze(ap);
120 break;
121 case ACPI_NOTIFY_EJECT_REQUEST:
122 ata_ehi_push_desc(ehi, fmt: "ACPI event");
123
124 ata_acpi_detach_device(ap, dev);
125 wait = 1;
126 break;
127 }
128
129 spin_unlock_irqrestore(lock: ap->lock, flags);
130
131 if (wait)
132 ata_port_wait_eh(ap);
133}
134
135static int ata_acpi_dev_notify_dock(struct acpi_device *adev, u32 event)
136{
137 struct ata_device *dev = ata_hotplug_data(adev->hp).dev;
138 ata_acpi_handle_hotplug(ap: dev->link->ap, dev, event);
139 return 0;
140}
141
142static int ata_acpi_ap_notify_dock(struct acpi_device *adev, u32 event)
143{
144 ata_acpi_handle_hotplug(ata_hotplug_data(adev->hp).ap, NULL, event);
145 return 0;
146}
147
148static 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(buf: event_string, size: 20, fmt: "BAY_EVENT=%d", event);
163 kobject_uevent_env(kobj, action: KOBJ_CHANGE, envp);
164 }
165}
166
167static void ata_acpi_ap_uevent(struct acpi_device *adev, u32 event)
168{
169 ata_acpi_uevent(ata_hotplug_data(adev->hp).ap, NULL, event);
170}
171
172static void ata_acpi_dev_uevent(struct acpi_device *adev, u32 event)
173{
174 struct ata_device *dev = ata_hotplug_data(adev->hp).dev;
175 ata_acpi_uevent(ap: dev->link->ap, dev, event);
176}
177
178/* bind acpi handle to pata port */
179void ata_acpi_bind_port(struct ata_port *ap)
180{
181 struct acpi_device *host_companion = ACPI_COMPANION(ap->host->dev);
182 struct acpi_device *adev;
183 struct ata_acpi_hotplug_context *context;
184
185 if (libata_noacpi || ap->flags & ATA_FLAG_ACPI_SATA || !host_companion)
186 return;
187
188 acpi_preset_companion(dev: &ap->tdev, parent: host_companion, addr: ap->port_no);
189
190 if (ata_acpi_gtm(ap, stm: &ap->__acpi_init_gtm) == 0)
191 ap->pflags |= ATA_PFLAG_INIT_GTM_VALID;
192
193 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, hp: &context->hp, notify: ata_acpi_ap_notify_dock,
203 uevent: ata_acpi_ap_uevent);
204}
205
206void ata_acpi_bind_dev(struct ata_device *dev)
207{
208 struct ata_port *ap = dev->link->ap;
209 struct acpi_device *port_companion = ACPI_COMPANION(&ap->tdev);
210 struct acpi_device *host_companion = ACPI_COMPANION(ap->host->dev);
211 struct acpi_device *parent, *adev;
212 struct ata_acpi_hotplug_context *context;
213 u64 adr;
214
215 /*
216 * For both sata/pata devices, host companion device is required.
217 * For pata device, port companion device is also required.
218 */
219 if (libata_noacpi || !host_companion ||
220 (!(ap->flags & ATA_FLAG_ACPI_SATA) && !port_companion))
221 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);
228 parent = host_companion;
229 } else {
230 adr = dev->devno;
231 parent = port_companion;
232 }
233
234 acpi_preset_companion(dev: &dev->tdev, parent, addr: adr);
235 adev = ACPI_COMPANION(&dev->tdev);
236 if (!adev || adev->hp)
237 return;
238
239 context = kzalloc(sizeof(*context), GFP_KERNEL);
240 if (!context)
241 return;
242
243 context->data.dev = dev;
244 acpi_initialize_hp_context(adev, hp: &context->hp, notify: ata_acpi_dev_notify_dock,
245 uevent: ata_acpi_dev_uevent);
246}
247
248/**
249 * 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{
260 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
269 if (ACPI_HANDLE(&ap->tdev) && gtm)
270 ata_acpi_stm(ap, stm: gtm);
271 }
272}
273
274/**
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)
288{
289 struct acpi_buffer output = { .length = ACPI_ALLOCATE_BUFFER };
290 union acpi_object *out_obj;
291 acpi_status status;
292 int rc = 0;
293 acpi_handle handle = ACPI_HANDLE(&ap->tdev);
294
295 if (!handle)
296 return -EINVAL;
297
298 status = acpi_evaluate_object(object: handle, pathname: "_GTM", NULL, return_object_buffer: &output);
299
300 rc = -ENOENT;
301 if (status == AE_NOT_FOUND)
302 goto out_free;
303
304 rc = -EINVAL;
305 if (ACPI_FAILURE(status)) {
306 ata_port_err(ap, "ACPI get timing mode failed (AE 0x%x)\n",
307 status);
308 goto out_free;
309 }
310
311 out_obj = output.pointer;
312 if (out_obj->type != ACPI_TYPE_BUFFER) {
313 ata_port_warn(ap, "_GTM returned unexpected object type 0x%x\n",
314 out_obj->type);
315
316 goto out_free;
317 }
318
319 if (out_obj->buffer.length != sizeof(struct ata_acpi_gtm)) {
320 ata_port_err(ap, "_GTM returned invalid length %d\n",
321 out_obj->buffer.length);
322 goto out_free;
323 }
324
325 memcpy(to: gtm, from: out_obj->buffer.pointer, len: sizeof(struct ata_acpi_gtm));
326 rc = 0;
327 out_free:
328 kfree(objp: output.pointer);
329 return rc;
330}
331
332EXPORT_SYMBOL_GPL(ata_acpi_gtm);
333
334/**
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 */
347int ata_acpi_stm(struct ata_port *ap, const struct ata_acpi_gtm *stm)
348{
349 acpi_status status;
350 struct ata_acpi_gtm stm_buf = *stm;
351 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);
356 in_params[0].buffer.pointer = (u8 *)&stm_buf;
357 /* Buffers for id may need byteswapping ? */
358 in_params[1].type = ACPI_TYPE_BUFFER;
359 in_params[1].buffer.length = 512;
360 in_params[1].buffer.pointer = (u8 *)ap->link.device[0].id;
361 in_params[2].type = ACPI_TYPE_BUFFER;
362 in_params[2].buffer.length = 512;
363 in_params[2].buffer.pointer = (u8 *)ap->link.device[1].id;
364
365 input.count = 3;
366 input.pointer = in_params;
367
368 status = acpi_evaluate_object(ACPI_HANDLE(&ap->tdev), pathname: "_STM",
369 parameter_objects: &input, NULL);
370
371 if (status == AE_NOT_FOUND)
372 return -ENOENT;
373 if (ACPI_FAILURE(status)) {
374 ata_port_err(ap, "ACPI set timing mode failed (status=0x%x)\n",
375 status);
376 return -EINVAL;
377 }
378 return 0;
379}
380
381EXPORT_SYMBOL_GPL(ata_acpi_stm);
382
383/**
384 * ata_dev_get_GTF - get the drive bootup default taskfile settings
385 * @dev: target ATA device
386 * @gtf: output parameter for buffer containing _GTF taskfile arrays
387 *
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 *
396 * LOCKING:
397 * EH context.
398 *
399 * RETURNS:
400 * Number of taskfiles on success, 0 if _GTF doesn't exist. -EINVAL
401 * if _GTF is invalid.
402 */
403static int ata_dev_get_GTF(struct ata_device *dev, struct ata_acpi_gtf **gtf)
404{
405 acpi_status status;
406 struct acpi_buffer output;
407 union acpi_object *out_obj;
408 int rc = 0;
409
410 /* if _GTF is cached, use the cached value */
411 if (dev->gtf_cache) {
412 out_obj = dev->gtf_cache;
413 goto done;
414 }
415
416 /* set up output buffer */
417 output.length = ACPI_ALLOCATE_BUFFER;
418 output.pointer = NULL; /* ACPI-CA sets this; save/free it later */
419
420 /* _GTF has no input parameters */
421 status = acpi_evaluate_object(object: ata_dev_acpi_handle(dev), pathname: "_GTF", NULL,
422 return_object_buffer: &output);
423 out_obj = dev->gtf_cache = output.pointer;
424
425 if (ACPI_FAILURE(status)) {
426 if (status != AE_NOT_FOUND) {
427 ata_dev_warn(dev, "_GTF evaluation failed (AE 0x%x)\n",
428 status);
429 rc = -EINVAL;
430 }
431 goto out_free;
432 }
433
434 if (!output.length || !output.pointer) {
435 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);
438 rc = -EINVAL;
439 goto out_free;
440 }
441
442 if (out_obj->type != ACPI_TYPE_BUFFER) {
443 ata_dev_warn(dev, "_GTF unexpected object type 0x%x\n",
444 out_obj->type);
445 rc = -EINVAL;
446 goto out_free;
447 }
448
449 if (out_obj->buffer.length % REGS_PER_GTF) {
450 ata_dev_warn(dev, "unexpected _GTF length (%d)\n",
451 out_obj->buffer.length);
452 rc = -EINVAL;
453 goto out_free;
454 }
455
456 done:
457 rc = out_obj->buffer.length / REGS_PER_GTF;
458 if (gtf) {
459 *gtf = (void *)out_obj->buffer.pointer;
460 ata_dev_dbg(dev, "returning gtf=%p, gtf_count=%d\n",
461 *gtf, rc);
462 }
463 return rc;
464
465 out_free:
466 ata_acpi_clear_gtf(dev);
467 return rc;
468}
469
470/**
471 * ata_acpi_gtm_xfermask - determine xfermode from GTM parameter
472 * @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 */
483unsigned int ata_acpi_gtm_xfermask(struct ata_device *dev,
484 const struct ata_acpi_gtm *gtm)
485{
486 unsigned int xfer_mask = 0;
487 unsigned int type;
488 int unit;
489 u8 mode;
490
491 /* we always use the 0 slot for crap hardware */
492 unit = dev->devno;
493 if (!(gtm->flags & 0x10))
494 unit = 0;
495
496 /* PIO */
497 mode = ata_timing_cycle2mode(xfer_shift: ATA_SHIFT_PIO, cycle: gtm->drive[unit].pio);
498 xfer_mask |= ata_xfer_mode2mask(xfer_mode: mode);
499
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 */
504 if (!(gtm->flags & (1 << (2 * unit))))
505 type = ATA_SHIFT_MWDMA;
506 else
507 type = ATA_SHIFT_UDMA;
508
509 mode = ata_timing_cycle2mode(xfer_shift: type, cycle: gtm->drive[unit].dma);
510 xfer_mask |= ata_xfer_mode2mask(xfer_mode: mode);
511
512 return xfer_mask;
513}
514EXPORT_SYMBOL_GPL(ata_acpi_gtm_xfermask);
515
516/**
517 * ata_acpi_cbl_pata_type - Return PATA cable type
518 * @ap: Port to check
519 *
520 * Return ATA_CBL_PATA* according to the transfer mode selected by BIOS
521 */
522int ata_acpi_cbl_pata_type(struct ata_port *ap)
523{
524 struct ata_device *dev;
525 int ret = ATA_CBL_PATA_UNK;
526 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
527
528 if (!gtm)
529 return ATA_CBL_PATA40;
530
531 ata_for_each_dev(dev, &ap->link, ENABLED) {
532 unsigned int xfer_mask, udma_mask;
533
534 xfer_mask = ata_acpi_gtm_xfermask(dev, gtm);
535 ata_unpack_xfermask(xfer_mask, NULL, NULL, udma_mask: &udma_mask);
536
537 ret = ATA_CBL_PATA40;
538
539 if (udma_mask & ~ATA_UDMA_MASK_40C) {
540 ret = ATA_CBL_PATA80;
541 break;
542 }
543 }
544
545 return ret;
546}
547EXPORT_SYMBOL_GPL(ata_acpi_cbl_pata_type);
548
549static void ata_acpi_gtf_to_tf(struct ata_device *dev,
550 const struct ata_acpi_gtf *gtf,
551 struct ata_taskfile *tf)
552{
553 ata_tf_init(dev, tf);
554
555 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
556 tf->protocol = ATA_PROT_NODATA;
557 tf->error = gtf->tf[0]; /* 0x1f1 */
558 tf->nsect = gtf->tf[1]; /* 0x1f2 */
559 tf->lbal = gtf->tf[2]; /* 0x1f3 */
560 tf->lbam = gtf->tf[3]; /* 0x1f4 */
561 tf->lbah = gtf->tf[4]; /* 0x1f5 */
562 tf->device = gtf->tf[5]; /* 0x1f6 */
563 tf->status = gtf->tf[6]; /* 0x1f7 */
564}
565
566static int ata_acpi_filter_tf(struct ata_device *dev,
567 const struct ata_taskfile *tf,
568 const struct ata_taskfile *ptf)
569{
570 if (dev->gtf_filter & ATA_ACPI_FILTER_SETXFER) {
571 /* libata doesn't use ACPI to configure transfer mode.
572 * It will only confuse device configuration. Skip.
573 */
574 if (tf->command == ATA_CMD_SET_FEATURES &&
575 tf->feature == SETFEATURES_XFER)
576 return 1;
577 }
578
579 if (dev->gtf_filter & ATA_ACPI_FILTER_LOCK) {
580 /* BIOS writers, sorry but we don't wanna lock
581 * features unless the user explicitly said so.
582 */
583
584 /* DEVICE CONFIGURATION FREEZE LOCK */
585 if (tf->command == ATA_CMD_CONF_OVERLAY &&
586 tf->feature == ATA_DCO_FREEZE_LOCK)
587 return 1;
588
589 /* SECURITY FREEZE LOCK */
590 if (tf->command == ATA_CMD_SEC_FREEZE_LOCK)
591 return 1;
592
593 /* SET MAX LOCK and SET MAX FREEZE LOCK */
594 if ((!ptf || ptf->command != ATA_CMD_READ_NATIVE_MAX) &&
595 tf->command == ATA_CMD_SET_MAX &&
596 (tf->feature == ATA_SET_MAX_LOCK ||
597 tf->feature == ATA_SET_MAX_FREEZE_LOCK))
598 return 1;
599 }
600
601 if (tf->command == ATA_CMD_SET_FEATURES &&
602 tf->feature == SETFEATURES_SATA_ENABLE) {
603 /* inhibit enabling DIPM */
604 if (dev->gtf_filter & ATA_ACPI_FILTER_DIPM &&
605 tf->nsect == SATA_DIPM)
606 return 1;
607
608 /* inhibit FPDMA non-zero offset */
609 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_OFFSET &&
610 (tf->nsect == SATA_FPDMA_OFFSET ||
611 tf->nsect == SATA_FPDMA_IN_ORDER))
612 return 1;
613
614 /* inhibit FPDMA auto activation */
615 if (dev->gtf_filter & ATA_ACPI_FILTER_FPDMA_AA &&
616 tf->nsect == SATA_FPDMA_AA)
617 return 1;
618 }
619
620 return 0;
621}
622
623/**
624 * ata_acpi_run_tf - send taskfile registers to host controller
625 * @dev: target ATA device
626 * @gtf: raw ATA taskfile register set (0x1f1 - 0x1f7)
627 * @prev_gtf: previous command
628 *
629 * Outputs ATA taskfile to standard ATA host controller.
630 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
631 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
632 * hob_lbal, hob_lbam, and hob_lbah.
633 *
634 * This function waits for idle (!BUSY and !DRQ) after writing
635 * registers. If the control register has a new value, this
636 * function also waits for idle after writing control and before
637 * writing the remaining registers.
638 *
639 * LOCKING:
640 * EH context.
641 *
642 * RETURNS:
643 * 1 if command is executed successfully. 0 if ignored, rejected or
644 * filtered out, -errno on other errors.
645 */
646static int ata_acpi_run_tf(struct ata_device *dev,
647 const struct ata_acpi_gtf *gtf,
648 const struct ata_acpi_gtf *prev_gtf)
649{
650 struct ata_taskfile *pptf = NULL;
651 struct ata_taskfile tf, ptf, rtf;
652 unsigned int err_mask;
653 const char *descr;
654 int rc;
655
656 if ((gtf->tf[0] == 0) && (gtf->tf[1] == 0) && (gtf->tf[2] == 0)
657 && (gtf->tf[3] == 0) && (gtf->tf[4] == 0) && (gtf->tf[5] == 0)
658 && (gtf->tf[6] == 0))
659 return 0;
660
661 ata_acpi_gtf_to_tf(dev, gtf, tf: &tf);
662 if (prev_gtf) {
663 ata_acpi_gtf_to_tf(dev, gtf: prev_gtf, tf: &ptf);
664 pptf = &ptf;
665 }
666
667 descr = ata_get_cmd_name(command: tf.command);
668
669 if (!ata_acpi_filter_tf(dev, tf: &tf, ptf: pptf)) {
670 rtf = tf;
671 err_mask = ata_exec_internal(dev, tf: &rtf, NULL,
672 dma_dir: DMA_NONE, NULL, buflen: 0, timeout: 0);
673
674 switch (err_mask) {
675 case 0:
676 ata_dev_dbg(dev,
677 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
678 "(%s) succeeded\n",
679 tf.command, tf.feature, tf.nsect, tf.lbal,
680 tf.lbam, tf.lbah, tf.device, descr);
681 rc = 1;
682 break;
683
684 case AC_ERR_DEV:
685 ata_dev_info(dev,
686 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
687 "(%s) rejected by device (Stat=0x%02x Err=0x%02x)",
688 tf.command, tf.feature, tf.nsect, tf.lbal,
689 tf.lbam, tf.lbah, tf.device, descr,
690 rtf.status, rtf.error);
691 rc = 0;
692 break;
693
694 default:
695 ata_dev_err(dev,
696 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
697 "(%s) failed (Emask=0x%x Stat=0x%02x Err=0x%02x)",
698 tf.command, tf.feature, tf.nsect, tf.lbal,
699 tf.lbam, tf.lbah, tf.device, descr,
700 err_mask, rtf.status, rtf.error);
701 rc = -EIO;
702 break;
703 }
704 } else {
705 ata_dev_info(dev,
706 "ACPI cmd %02x/%02x:%02x:%02x:%02x:%02x:%02x"
707 "(%s) filtered out\n",
708 tf.command, tf.feature, tf.nsect, tf.lbal,
709 tf.lbam, tf.lbah, tf.device, descr);
710 rc = 0;
711 }
712 return rc;
713}
714
715/**
716 * ata_acpi_exec_tfs - get then write drive taskfile settings
717 * @dev: target ATA device
718 * @nr_executed: out parameter for the number of executed commands
719 *
720 * Evaluate _GTF and execute returned taskfiles.
721 *
722 * LOCKING:
723 * EH context.
724 *
725 * RETURNS:
726 * Number of executed taskfiles on success, 0 if _GTF doesn't exist.
727 * -errno on other errors.
728 */
729static int ata_acpi_exec_tfs(struct ata_device *dev, int *nr_executed)
730{
731 struct ata_acpi_gtf *gtf = NULL, *pgtf = NULL;
732 int gtf_count, i, rc;
733
734 /* get taskfiles */
735 rc = ata_dev_get_GTF(dev, gtf: &gtf);
736 if (rc < 0)
737 return rc;
738 gtf_count = rc;
739
740 /* execute them */
741 for (i = 0; i < gtf_count; i++, gtf++) {
742 rc = ata_acpi_run_tf(dev, gtf, prev_gtf: pgtf);
743 if (rc < 0)
744 break;
745 if (rc) {
746 (*nr_executed)++;
747 pgtf = gtf;
748 }
749 }
750
751 ata_acpi_clear_gtf(dev);
752
753 if (rc < 0)
754 return rc;
755 return 0;
756}
757
758/**
759 * ata_acpi_push_id - send Identify data to drive
760 * @dev: target ATA device
761 *
762 * _SDD ACPI object: for SATA mode only
763 * Must be after Identify (Packet) Device -- uses its data
764 * ATM this function never returns a failure. It is an optional
765 * method and if it fails for whatever reason, we should still
766 * just keep going.
767 *
768 * LOCKING:
769 * EH context.
770 *
771 * RETURNS:
772 * 0 on success, -ENOENT if _SDD doesn't exist, -errno on failure.
773 */
774static int ata_acpi_push_id(struct ata_device *dev)
775{
776 struct ata_port *ap = dev->link->ap;
777 acpi_status status;
778 struct acpi_object_list input;
779 union acpi_object in_params[1];
780
781 ata_dev_dbg(dev, "%s: ix = %d, port#: %d\n",
782 __func__, dev->devno, ap->port_no);
783
784 /* Give the drive Identify data to the drive via the _SDD method */
785 /* _SDD: set up input parameters */
786 input.count = 1;
787 input.pointer = in_params;
788 in_params[0].type = ACPI_TYPE_BUFFER;
789 in_params[0].buffer.length = sizeof(dev->id[0]) * ATA_ID_WORDS;
790 in_params[0].buffer.pointer = (u8 *)dev->id;
791 /* Output buffer: _SDD has no output */
792
793 /* It's OK for _SDD to be missing too. */
794 swap_buf_le16(buf: dev->id, buf_words: ATA_ID_WORDS);
795 status = acpi_evaluate_object(object: ata_dev_acpi_handle(dev), pathname: "_SDD", parameter_objects: &input,
796 NULL);
797 swap_buf_le16(buf: dev->id, buf_words: ATA_ID_WORDS);
798
799 if (status == AE_NOT_FOUND)
800 return -ENOENT;
801
802 if (ACPI_FAILURE(status)) {
803 ata_dev_warn(dev, "ACPI _SDD failed (AE 0x%x)\n", status);
804 return -EIO;
805 }
806
807 return 0;
808}
809
810/**
811 * ata_acpi_on_resume - ATA ACPI hook called on resume
812 * @ap: target ATA port
813 *
814 * This function is called when @ap is resumed - right after port
815 * itself is resumed but before any EH action is taken.
816 *
817 * LOCKING:
818 * EH context.
819 */
820void ata_acpi_on_resume(struct ata_port *ap)
821{
822 const struct ata_acpi_gtm *gtm = ata_acpi_init_gtm(ap);
823 struct ata_device *dev;
824
825 if (ACPI_HANDLE(&ap->tdev) && gtm) {
826 /* _GTM valid */
827
828 /* restore timing parameters */
829 ata_acpi_stm(ap, gtm);
830
831 /* _GTF should immediately follow _STM so that it can
832 * use values set by _STM. Cache _GTF result and
833 * schedule _GTF.
834 */
835 ata_for_each_dev(dev, &ap->link, ALL) {
836 ata_acpi_clear_gtf(dev);
837 if (ata_dev_enabled(dev) &&
838 ata_dev_acpi_handle(dev) &&
839 ata_dev_get_GTF(dev, NULL) >= 0)
840 dev->flags |= ATA_DFLAG_ACPI_PENDING;
841 }
842 } else {
843 /* SATA _GTF needs to be evaluated after _SDD and
844 * there's no reason to evaluate IDE _GTF early
845 * without _STM. Clear cache and schedule _GTF.
846 */
847 ata_for_each_dev(dev, &ap->link, ALL) {
848 ata_acpi_clear_gtf(dev);
849 if (ata_dev_enabled(dev))
850 dev->flags |= ATA_DFLAG_ACPI_PENDING;
851 }
852 }
853}
854
855static int ata_acpi_choose_suspend_state(struct ata_device *dev, bool runtime)
856{
857 int d_max_in = ACPI_STATE_D3_COLD;
858 if (!runtime)
859 goto out;
860
861 /*
862 * For ATAPI, runtime D3 cold is only allowed
863 * for ZPODD in zero power ready state
864 */
865 if (dev->class == ATA_DEV_ATAPI &&
866 !(zpodd_dev_enabled(dev) && zpodd_zpready(dev)))
867 d_max_in = ACPI_STATE_D3_HOT;
868
869out:
870 return acpi_pm_device_sleep_state(&dev->tdev, NULL, d_max_in);
871}
872
873static void sata_acpi_set_state(struct ata_port *ap, pm_message_t state)
874{
875 bool runtime = PMSG_IS_AUTO(state);
876 struct ata_device *dev;
877 acpi_handle handle;
878 int acpi_state;
879
880 ata_for_each_dev(dev, &ap->link, ENABLED) {
881 handle = ata_dev_acpi_handle(dev);
882 if (!handle)
883 continue;
884
885 if (!(state.event & PM_EVENT_RESUME)) {
886 acpi_state = ata_acpi_choose_suspend_state(dev, runtime);
887 if (acpi_state == ACPI_STATE_D0)
888 continue;
889 if (runtime && zpodd_dev_enabled(dev) &&
890 acpi_state == ACPI_STATE_D3_COLD)
891 zpodd_enable_run_wake(dev);
892 acpi_bus_set_power(handle, state: acpi_state);
893 } else {
894 if (runtime && zpodd_dev_enabled(dev))
895 zpodd_disable_run_wake(dev);
896 acpi_bus_set_power(handle, ACPI_STATE_D0);
897 }
898 }
899}
900
901/* ACPI spec requires _PS0 when IDE power on and _PS3 when power off */
902static void pata_acpi_set_state(struct ata_port *ap, pm_message_t state)
903{
904 struct ata_device *dev;
905 acpi_handle port_handle;
906
907 port_handle = ACPI_HANDLE(&ap->tdev);
908 if (!port_handle)
909 return;
910
911 /* channel first and then drives for power on and vica versa
912 for power off */
913 if (state.event & PM_EVENT_RESUME)
914 acpi_bus_set_power(handle: port_handle, ACPI_STATE_D0);
915
916 ata_for_each_dev(dev, &ap->link, ENABLED) {
917 acpi_handle dev_handle = ata_dev_acpi_handle(dev);
918 if (!dev_handle)
919 continue;
920
921 acpi_bus_set_power(handle: dev_handle, state: state.event & PM_EVENT_RESUME ?
922 ACPI_STATE_D0 : ACPI_STATE_D3_COLD);
923 }
924
925 if (!(state.event & PM_EVENT_RESUME))
926 acpi_bus_set_power(handle: port_handle, ACPI_STATE_D3_COLD);
927}
928
929/**
930 * ata_acpi_set_state - set the port power state
931 * @ap: target ATA port
932 * @state: state, on/off
933 *
934 * This function sets a proper ACPI D state for the device on
935 * system and runtime PM operations.
936 */
937void ata_acpi_set_state(struct ata_port *ap, pm_message_t state)
938{
939 if (ap->flags & ATA_FLAG_ACPI_SATA)
940 sata_acpi_set_state(ap, state);
941 else
942 pata_acpi_set_state(ap, state);
943}
944
945/**
946 * ata_acpi_on_devcfg - ATA ACPI hook called on device donfiguration
947 * @dev: target ATA device
948 *
949 * This function is called when @dev is about to be configured.
950 * IDENTIFY data might have been modified after this hook is run.
951 *
952 * LOCKING:
953 * EH context.
954 *
955 * RETURNS:
956 * Positive number if IDENTIFY data needs to be refreshed, 0 if not,
957 * -errno on failure.
958 */
959int ata_acpi_on_devcfg(struct ata_device *dev)
960{
961 struct ata_port *ap = dev->link->ap;
962 struct ata_eh_context *ehc = &ap->link.eh_context;
963 int acpi_sata = ap->flags & ATA_FLAG_ACPI_SATA;
964 int nr_executed = 0;
965 int rc;
966
967 if (!ata_dev_acpi_handle(dev))
968 return 0;
969
970 /* do we need to do _GTF? */
971 if (!(dev->flags & ATA_DFLAG_ACPI_PENDING) &&
972 !(acpi_sata && (ehc->i.flags & ATA_EHI_DID_HARDRESET)))
973 return 0;
974
975 /* do _SDD if SATA */
976 if (acpi_sata) {
977 rc = ata_acpi_push_id(dev);
978 if (rc && rc != -ENOENT)
979 goto acpi_err;
980 }
981
982 /* do _GTF */
983 rc = ata_acpi_exec_tfs(dev, nr_executed: &nr_executed);
984 if (rc)
985 goto acpi_err;
986
987 dev->flags &= ~ATA_DFLAG_ACPI_PENDING;
988
989 /* refresh IDENTIFY page if any _GTF command has been executed */
990 if (nr_executed) {
991 rc = ata_dev_reread_id(dev, readid_flags: 0);
992 if (rc < 0) {
993 ata_dev_err(dev,
994 "failed to IDENTIFY after ACPI commands\n");
995 return rc;
996 }
997 }
998
999 return 0;
1000
1001 acpi_err:
1002 /* ignore evaluation failure if we can continue safely */
1003 if (rc == -EINVAL && !nr_executed && !ata_port_is_frozen(ap))
1004 return 0;
1005
1006 /* fail and let EH retry once more for unknown IO errors */
1007 if (!(dev->flags & ATA_DFLAG_ACPI_FAILED)) {
1008 dev->flags |= ATA_DFLAG_ACPI_FAILED;
1009 return rc;
1010 }
1011
1012 dev->flags |= ATA_DFLAG_ACPI_DISABLED;
1013 ata_dev_warn(dev, "ACPI: failed the second time, disabled\n");
1014
1015 /* We can safely continue if no _GTF command has been executed
1016 * and port is not frozen.
1017 */
1018 if (!nr_executed && !ata_port_is_frozen(ap))
1019 return 0;
1020
1021 return rc;
1022}
1023
1024/**
1025 * ata_acpi_on_disable - ATA ACPI hook called when a device is disabled
1026 * @dev: target ATA device
1027 *
1028 * This function is called when @dev is about to be disabled.
1029 *
1030 * LOCKING:
1031 * EH context.
1032 */
1033void ata_acpi_on_disable(struct ata_device *dev)
1034{
1035 ata_acpi_clear_gtf(dev);
1036}
1037