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