PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / ata / libata-core.c
blob1a3dbd1b196ecb121b1ee9d34388ecd00c307b71
1 /*
2 * libata-core.c - helper library for ATA
4 * Maintained by: Tejun Heo <tj@kernel.org>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
6 * on emails.
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
15 * any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from http://www.t13.org/ and
31 * http://www.sata-io.org/
33 * Standards documents from:
34 * http://www.t13.org (ATA standards, PCI DMA IDE spec)
35 * http://www.t10.org (SCSI MMC - for ATAPI MMC)
36 * http://www.sata-io.org (SATA)
37 * http://www.compactflash.org (CF)
38 * http://www.qic.org (QIC157 - Tape and DSC)
39 * http://www.ce-ata.org (CE-ATA: not supported)
43 #include <linux/kernel.h>
44 #include <linux/module.h>
45 #include <linux/pci.h>
46 #include <linux/init.h>
47 #include <linux/list.h>
48 #include <linux/mm.h>
49 #include <linux/spinlock.h>
50 #include <linux/blkdev.h>
51 #include <linux/delay.h>
52 #include <linux/timer.h>
53 #include <linux/interrupt.h>
54 #include <linux/completion.h>
55 #include <linux/suspend.h>
56 #include <linux/workqueue.h>
57 #include <linux/scatterlist.h>
58 #include <linux/io.h>
59 #include <linux/async.h>
60 #include <linux/log2.h>
61 #include <linux/slab.h>
62 #include <scsi/scsi.h>
63 #include <scsi/scsi_cmnd.h>
64 #include <scsi/scsi_host.h>
65 #include <linux/libata.h>
66 #include <asm/byteorder.h>
67 #include <linux/cdrom.h>
68 #include <linux/ratelimit.h>
69 #include <linux/pm_runtime.h>
70 #include <linux/platform_device.h>
72 #include "libata.h"
73 #include "libata-transport.h"
75 /* debounce timing parameters in msecs { interval, duration, timeout } */
76 const unsigned long sata_deb_timing_normal[] = { 5, 100, 2000 };
77 const unsigned long sata_deb_timing_hotplug[] = { 25, 500, 2000 };
78 const unsigned long sata_deb_timing_long[] = { 100, 2000, 5000 };
80 const struct ata_port_operations ata_base_port_ops = {
81 .prereset = ata_std_prereset,
82 .postreset = ata_std_postreset,
83 .error_handler = ata_std_error_handler,
84 .sched_eh = ata_std_sched_eh,
85 .end_eh = ata_std_end_eh,
88 const struct ata_port_operations sata_port_ops = {
89 .inherits = &ata_base_port_ops,
91 .qc_defer = ata_std_qc_defer,
92 .hardreset = sata_std_hardreset,
95 static unsigned int ata_dev_init_params(struct ata_device *dev,
96 u16 heads, u16 sectors);
97 static unsigned int ata_dev_set_xfermode(struct ata_device *dev);
98 static void ata_dev_xfermask(struct ata_device *dev);
99 static unsigned long ata_dev_blacklisted(const struct ata_device *dev);
101 atomic_t ata_print_id = ATOMIC_INIT(0);
103 struct ata_force_param {
104 const char *name;
105 unsigned int cbl;
106 int spd_limit;
107 unsigned long xfer_mask;
108 unsigned int horkage_on;
109 unsigned int horkage_off;
110 unsigned int lflags;
113 struct ata_force_ent {
114 int port;
115 int device;
116 struct ata_force_param param;
119 static struct ata_force_ent *ata_force_tbl;
120 static int ata_force_tbl_size;
122 static char ata_force_param_buf[PAGE_SIZE] __initdata;
123 /* param_buf is thrown away after initialization, disallow read */
124 module_param_string(force, ata_force_param_buf, sizeof(ata_force_param_buf), 0);
125 MODULE_PARM_DESC(force, "Force ATA configurations including cable type, link speed and transfer mode (see Documentation/kernel-parameters.txt for details)");
127 static int atapi_enabled = 1;
128 module_param(atapi_enabled, int, 0444);
129 MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on [default])");
131 static int atapi_dmadir = 0;
132 module_param(atapi_dmadir, int, 0444);
133 MODULE_PARM_DESC(atapi_dmadir, "Enable ATAPI DMADIR bridge support (0=off [default], 1=on)");
135 int atapi_passthru16 = 1;
136 module_param(atapi_passthru16, int, 0444);
137 MODULE_PARM_DESC(atapi_passthru16, "Enable ATA_16 passthru for ATAPI devices (0=off, 1=on [default])");
139 int libata_fua = 0;
140 module_param_named(fua, libata_fua, int, 0444);
141 MODULE_PARM_DESC(fua, "FUA support (0=off [default], 1=on)");
143 static int ata_ignore_hpa;
144 module_param_named(ignore_hpa, ata_ignore_hpa, int, 0644);
145 MODULE_PARM_DESC(ignore_hpa, "Ignore HPA limit (0=keep BIOS limits, 1=ignore limits, using full disk)");
147 static int libata_dma_mask = ATA_DMA_MASK_ATA|ATA_DMA_MASK_ATAPI|ATA_DMA_MASK_CFA;
148 module_param_named(dma, libata_dma_mask, int, 0444);
149 MODULE_PARM_DESC(dma, "DMA enable/disable (0x1==ATA, 0x2==ATAPI, 0x4==CF)");
151 static int ata_probe_timeout;
152 module_param(ata_probe_timeout, int, 0444);
153 MODULE_PARM_DESC(ata_probe_timeout, "Set ATA probing timeout (seconds)");
155 int libata_noacpi = 0;
156 module_param_named(noacpi, libata_noacpi, int, 0444);
157 MODULE_PARM_DESC(noacpi, "Disable the use of ACPI in probe/suspend/resume (0=off [default], 1=on)");
159 int libata_allow_tpm = 0;
160 module_param_named(allow_tpm, libata_allow_tpm, int, 0444);
161 MODULE_PARM_DESC(allow_tpm, "Permit the use of TPM commands (0=off [default], 1=on)");
163 static int atapi_an;
164 module_param(atapi_an, int, 0444);
165 MODULE_PARM_DESC(atapi_an, "Enable ATAPI AN media presence notification (0=0ff [default], 1=on)");
167 MODULE_AUTHOR("Jeff Garzik");
168 MODULE_DESCRIPTION("Library module for ATA devices");
169 MODULE_LICENSE("GPL");
170 MODULE_VERSION(DRV_VERSION);
173 static bool ata_sstatus_online(u32 sstatus)
175 return (sstatus & 0xf) == 0x3;
179 * ata_link_next - link iteration helper
180 * @link: the previous link, NULL to start
181 * @ap: ATA port containing links to iterate
182 * @mode: iteration mode, one of ATA_LITER_*
184 * LOCKING:
185 * Host lock or EH context.
187 * RETURNS:
188 * Pointer to the next link.
190 struct ata_link *ata_link_next(struct ata_link *link, struct ata_port *ap,
191 enum ata_link_iter_mode mode)
193 BUG_ON(mode != ATA_LITER_EDGE &&
194 mode != ATA_LITER_PMP_FIRST && mode != ATA_LITER_HOST_FIRST);
196 /* NULL link indicates start of iteration */
197 if (!link)
198 switch (mode) {
199 case ATA_LITER_EDGE:
200 case ATA_LITER_PMP_FIRST:
201 if (sata_pmp_attached(ap))
202 return ap->pmp_link;
203 /* fall through */
204 case ATA_LITER_HOST_FIRST:
205 return &ap->link;
208 /* we just iterated over the host link, what's next? */
209 if (link == &ap->link)
210 switch (mode) {
211 case ATA_LITER_HOST_FIRST:
212 if (sata_pmp_attached(ap))
213 return ap->pmp_link;
214 /* fall through */
215 case ATA_LITER_PMP_FIRST:
216 if (unlikely(ap->slave_link))
217 return ap->slave_link;
218 /* fall through */
219 case ATA_LITER_EDGE:
220 return NULL;
223 /* slave_link excludes PMP */
224 if (unlikely(link == ap->slave_link))
225 return NULL;
227 /* we were over a PMP link */
228 if (++link < ap->pmp_link + ap->nr_pmp_links)
229 return link;
231 if (mode == ATA_LITER_PMP_FIRST)
232 return &ap->link;
234 return NULL;
238 * ata_dev_next - device iteration helper
239 * @dev: the previous device, NULL to start
240 * @link: ATA link containing devices to iterate
241 * @mode: iteration mode, one of ATA_DITER_*
243 * LOCKING:
244 * Host lock or EH context.
246 * RETURNS:
247 * Pointer to the next device.
249 struct ata_device *ata_dev_next(struct ata_device *dev, struct ata_link *link,
250 enum ata_dev_iter_mode mode)
252 BUG_ON(mode != ATA_DITER_ENABLED && mode != ATA_DITER_ENABLED_REVERSE &&
253 mode != ATA_DITER_ALL && mode != ATA_DITER_ALL_REVERSE);
255 /* NULL dev indicates start of iteration */
256 if (!dev)
257 switch (mode) {
258 case ATA_DITER_ENABLED:
259 case ATA_DITER_ALL:
260 dev = link->device;
261 goto check;
262 case ATA_DITER_ENABLED_REVERSE:
263 case ATA_DITER_ALL_REVERSE:
264 dev = link->device + ata_link_max_devices(link) - 1;
265 goto check;
268 next:
269 /* move to the next one */
270 switch (mode) {
271 case ATA_DITER_ENABLED:
272 case ATA_DITER_ALL:
273 if (++dev < link->device + ata_link_max_devices(link))
274 goto check;
275 return NULL;
276 case ATA_DITER_ENABLED_REVERSE:
277 case ATA_DITER_ALL_REVERSE:
278 if (--dev >= link->device)
279 goto check;
280 return NULL;
283 check:
284 if ((mode == ATA_DITER_ENABLED || mode == ATA_DITER_ENABLED_REVERSE) &&
285 !ata_dev_enabled(dev))
286 goto next;
287 return dev;
291 * ata_dev_phys_link - find physical link for a device
292 * @dev: ATA device to look up physical link for
294 * Look up physical link which @dev is attached to. Note that
295 * this is different from @dev->link only when @dev is on slave
296 * link. For all other cases, it's the same as @dev->link.
298 * LOCKING:
299 * Don't care.
301 * RETURNS:
302 * Pointer to the found physical link.
304 struct ata_link *ata_dev_phys_link(struct ata_device *dev)
306 struct ata_port *ap = dev->link->ap;
308 if (!ap->slave_link)
309 return dev->link;
310 if (!dev->devno)
311 return &ap->link;
312 return ap->slave_link;
316 * ata_force_cbl - force cable type according to libata.force
317 * @ap: ATA port of interest
319 * Force cable type according to libata.force and whine about it.
320 * The last entry which has matching port number is used, so it
321 * can be specified as part of device force parameters. For
322 * example, both "a:40c,1.00:udma4" and "1.00:40c,udma4" have the
323 * same effect.
325 * LOCKING:
326 * EH context.
328 void ata_force_cbl(struct ata_port *ap)
330 int i;
332 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
333 const struct ata_force_ent *fe = &ata_force_tbl[i];
335 if (fe->port != -1 && fe->port != ap->print_id)
336 continue;
338 if (fe->param.cbl == ATA_CBL_NONE)
339 continue;
341 ap->cbl = fe->param.cbl;
342 ata_port_notice(ap, "FORCE: cable set to %s\n", fe->param.name);
343 return;
348 * ata_force_link_limits - force link limits according to libata.force
349 * @link: ATA link of interest
351 * Force link flags and SATA spd limit according to libata.force
352 * and whine about it. When only the port part is specified
353 * (e.g. 1:), the limit applies to all links connected to both
354 * the host link and all fan-out ports connected via PMP. If the
355 * device part is specified as 0 (e.g. 1.00:), it specifies the
356 * first fan-out link not the host link. Device number 15 always
357 * points to the host link whether PMP is attached or not. If the
358 * controller has slave link, device number 16 points to it.
360 * LOCKING:
361 * EH context.
363 static void ata_force_link_limits(struct ata_link *link)
365 bool did_spd = false;
366 int linkno = link->pmp;
367 int i;
369 if (ata_is_host_link(link))
370 linkno += 15;
372 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
373 const struct ata_force_ent *fe = &ata_force_tbl[i];
375 if (fe->port != -1 && fe->port != link->ap->print_id)
376 continue;
378 if (fe->device != -1 && fe->device != linkno)
379 continue;
381 /* only honor the first spd limit */
382 if (!did_spd && fe->param.spd_limit) {
383 link->hw_sata_spd_limit = (1 << fe->param.spd_limit) - 1;
384 ata_link_notice(link, "FORCE: PHY spd limit set to %s\n",
385 fe->param.name);
386 did_spd = true;
389 /* let lflags stack */
390 if (fe->param.lflags) {
391 link->flags |= fe->param.lflags;
392 ata_link_notice(link,
393 "FORCE: link flag 0x%x forced -> 0x%x\n",
394 fe->param.lflags, link->flags);
400 * ata_force_xfermask - force xfermask according to libata.force
401 * @dev: ATA device of interest
403 * Force xfer_mask according to libata.force and whine about it.
404 * For consistency with link selection, device number 15 selects
405 * the first device connected to the host link.
407 * LOCKING:
408 * EH context.
410 static void ata_force_xfermask(struct ata_device *dev)
412 int devno = dev->link->pmp + dev->devno;
413 int alt_devno = devno;
414 int i;
416 /* allow n.15/16 for devices attached to host port */
417 if (ata_is_host_link(dev->link))
418 alt_devno += 15;
420 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
421 const struct ata_force_ent *fe = &ata_force_tbl[i];
422 unsigned long pio_mask, mwdma_mask, udma_mask;
424 if (fe->port != -1 && fe->port != dev->link->ap->print_id)
425 continue;
427 if (fe->device != -1 && fe->device != devno &&
428 fe->device != alt_devno)
429 continue;
431 if (!fe->param.xfer_mask)
432 continue;
434 ata_unpack_xfermask(fe->param.xfer_mask,
435 &pio_mask, &mwdma_mask, &udma_mask);
436 if (udma_mask)
437 dev->udma_mask = udma_mask;
438 else if (mwdma_mask) {
439 dev->udma_mask = 0;
440 dev->mwdma_mask = mwdma_mask;
441 } else {
442 dev->udma_mask = 0;
443 dev->mwdma_mask = 0;
444 dev->pio_mask = pio_mask;
447 ata_dev_notice(dev, "FORCE: xfer_mask set to %s\n",
448 fe->param.name);
449 return;
454 * ata_force_horkage - force horkage according to libata.force
455 * @dev: ATA device of interest
457 * Force horkage according to libata.force and whine about it.
458 * For consistency with link selection, device number 15 selects
459 * the first device connected to the host link.
461 * LOCKING:
462 * EH context.
464 static void ata_force_horkage(struct ata_device *dev)
466 int devno = dev->link->pmp + dev->devno;
467 int alt_devno = devno;
468 int i;
470 /* allow n.15/16 for devices attached to host port */
471 if (ata_is_host_link(dev->link))
472 alt_devno += 15;
474 for (i = 0; i < ata_force_tbl_size; i++) {
475 const struct ata_force_ent *fe = &ata_force_tbl[i];
477 if (fe->port != -1 && fe->port != dev->link->ap->print_id)
478 continue;
480 if (fe->device != -1 && fe->device != devno &&
481 fe->device != alt_devno)
482 continue;
484 if (!(~dev->horkage & fe->param.horkage_on) &&
485 !(dev->horkage & fe->param.horkage_off))
486 continue;
488 dev->horkage |= fe->param.horkage_on;
489 dev->horkage &= ~fe->param.horkage_off;
491 ata_dev_notice(dev, "FORCE: horkage modified (%s)\n",
492 fe->param.name);
497 * atapi_cmd_type - Determine ATAPI command type from SCSI opcode
498 * @opcode: SCSI opcode
500 * Determine ATAPI command type from @opcode.
502 * LOCKING:
503 * None.
505 * RETURNS:
506 * ATAPI_{READ|WRITE|READ_CD|PASS_THRU|MISC}
508 int atapi_cmd_type(u8 opcode)
510 switch (opcode) {
511 case GPCMD_READ_10:
512 case GPCMD_READ_12:
513 return ATAPI_READ;
515 case GPCMD_WRITE_10:
516 case GPCMD_WRITE_12:
517 case GPCMD_WRITE_AND_VERIFY_10:
518 return ATAPI_WRITE;
520 case GPCMD_READ_CD:
521 case GPCMD_READ_CD_MSF:
522 return ATAPI_READ_CD;
524 case ATA_16:
525 case ATA_12:
526 if (atapi_passthru16)
527 return ATAPI_PASS_THRU;
528 /* fall thru */
529 default:
530 return ATAPI_MISC;
535 * ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
536 * @tf: Taskfile to convert
537 * @pmp: Port multiplier port
538 * @is_cmd: This FIS is for command
539 * @fis: Buffer into which data will output
541 * Converts a standard ATA taskfile to a Serial ATA
542 * FIS structure (Register - Host to Device).
544 * LOCKING:
545 * Inherited from caller.
547 void ata_tf_to_fis(const struct ata_taskfile *tf, u8 pmp, int is_cmd, u8 *fis)
549 fis[0] = 0x27; /* Register - Host to Device FIS */
550 fis[1] = pmp & 0xf; /* Port multiplier number*/
551 if (is_cmd)
552 fis[1] |= (1 << 7); /* bit 7 indicates Command FIS */
554 fis[2] = tf->command;
555 fis[3] = tf->feature;
557 fis[4] = tf->lbal;
558 fis[5] = tf->lbam;
559 fis[6] = tf->lbah;
560 fis[7] = tf->device;
562 fis[8] = tf->hob_lbal;
563 fis[9] = tf->hob_lbam;
564 fis[10] = tf->hob_lbah;
565 fis[11] = tf->hob_feature;
567 fis[12] = tf->nsect;
568 fis[13] = tf->hob_nsect;
569 fis[14] = 0;
570 fis[15] = tf->ctl;
572 fis[16] = tf->auxiliary & 0xff;
573 fis[17] = (tf->auxiliary >> 8) & 0xff;
574 fis[18] = (tf->auxiliary >> 16) & 0xff;
575 fis[19] = (tf->auxiliary >> 24) & 0xff;
579 * ata_tf_from_fis - Convert SATA FIS to ATA taskfile
580 * @fis: Buffer from which data will be input
581 * @tf: Taskfile to output
583 * Converts a serial ATA FIS structure to a standard ATA taskfile.
585 * LOCKING:
586 * Inherited from caller.
589 void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf)
591 tf->command = fis[2]; /* status */
592 tf->feature = fis[3]; /* error */
594 tf->lbal = fis[4];
595 tf->lbam = fis[5];
596 tf->lbah = fis[6];
597 tf->device = fis[7];
599 tf->hob_lbal = fis[8];
600 tf->hob_lbam = fis[9];
601 tf->hob_lbah = fis[10];
603 tf->nsect = fis[12];
604 tf->hob_nsect = fis[13];
607 static const u8 ata_rw_cmds[] = {
608 /* pio multi */
609 ATA_CMD_READ_MULTI,
610 ATA_CMD_WRITE_MULTI,
611 ATA_CMD_READ_MULTI_EXT,
612 ATA_CMD_WRITE_MULTI_EXT,
616 ATA_CMD_WRITE_MULTI_FUA_EXT,
617 /* pio */
618 ATA_CMD_PIO_READ,
619 ATA_CMD_PIO_WRITE,
620 ATA_CMD_PIO_READ_EXT,
621 ATA_CMD_PIO_WRITE_EXT,
626 /* dma */
627 ATA_CMD_READ,
628 ATA_CMD_WRITE,
629 ATA_CMD_READ_EXT,
630 ATA_CMD_WRITE_EXT,
634 ATA_CMD_WRITE_FUA_EXT
638 * ata_rwcmd_protocol - set taskfile r/w commands and protocol
639 * @tf: command to examine and configure
640 * @dev: device tf belongs to
642 * Examine the device configuration and tf->flags to calculate
643 * the proper read/write commands and protocol to use.
645 * LOCKING:
646 * caller.
648 static int ata_rwcmd_protocol(struct ata_taskfile *tf, struct ata_device *dev)
650 u8 cmd;
652 int index, fua, lba48, write;
654 fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
655 lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
656 write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
658 if (dev->flags & ATA_DFLAG_PIO) {
659 tf->protocol = ATA_PROT_PIO;
660 index = dev->multi_count ? 0 : 8;
661 } else if (lba48 && (dev->link->ap->flags & ATA_FLAG_PIO_LBA48)) {
662 /* Unable to use DMA due to host limitation */
663 tf->protocol = ATA_PROT_PIO;
664 index = dev->multi_count ? 0 : 8;
665 } else {
666 tf->protocol = ATA_PROT_DMA;
667 index = 16;
670 cmd = ata_rw_cmds[index + fua + lba48 + write];
671 if (cmd) {
672 tf->command = cmd;
673 return 0;
675 return -1;
679 * ata_tf_read_block - Read block address from ATA taskfile
680 * @tf: ATA taskfile of interest
681 * @dev: ATA device @tf belongs to
683 * LOCKING:
684 * None.
686 * Read block address from @tf. This function can handle all
687 * three address formats - LBA, LBA48 and CHS. tf->protocol and
688 * flags select the address format to use.
690 * RETURNS:
691 * Block address read from @tf.
693 u64 ata_tf_read_block(struct ata_taskfile *tf, struct ata_device *dev)
695 u64 block = 0;
697 if (tf->flags & ATA_TFLAG_LBA) {
698 if (tf->flags & ATA_TFLAG_LBA48) {
699 block |= (u64)tf->hob_lbah << 40;
700 block |= (u64)tf->hob_lbam << 32;
701 block |= (u64)tf->hob_lbal << 24;
702 } else
703 block |= (tf->device & 0xf) << 24;
705 block |= tf->lbah << 16;
706 block |= tf->lbam << 8;
707 block |= tf->lbal;
708 } else {
709 u32 cyl, head, sect;
711 cyl = tf->lbam | (tf->lbah << 8);
712 head = tf->device & 0xf;
713 sect = tf->lbal;
715 if (!sect) {
716 ata_dev_warn(dev,
717 "device reported invalid CHS sector 0\n");
718 sect = 1; /* oh well */
721 block = (cyl * dev->heads + head) * dev->sectors + sect - 1;
724 return block;
728 * ata_build_rw_tf - Build ATA taskfile for given read/write request
729 * @tf: Target ATA taskfile
730 * @dev: ATA device @tf belongs to
731 * @block: Block address
732 * @n_block: Number of blocks
733 * @tf_flags: RW/FUA etc...
734 * @tag: tag
736 * LOCKING:
737 * None.
739 * Build ATA taskfile @tf for read/write request described by
740 * @block, @n_block, @tf_flags and @tag on @dev.
742 * RETURNS:
744 * 0 on success, -ERANGE if the request is too large for @dev,
745 * -EINVAL if the request is invalid.
747 int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
748 u64 block, u32 n_block, unsigned int tf_flags,
749 unsigned int tag)
751 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
752 tf->flags |= tf_flags;
754 if (ata_ncq_enabled(dev) && likely(tag != ATA_TAG_INTERNAL)) {
755 /* yay, NCQ */
756 if (!lba_48_ok(block, n_block))
757 return -ERANGE;
759 tf->protocol = ATA_PROT_NCQ;
760 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
762 if (tf->flags & ATA_TFLAG_WRITE)
763 tf->command = ATA_CMD_FPDMA_WRITE;
764 else
765 tf->command = ATA_CMD_FPDMA_READ;
767 tf->nsect = tag << 3;
768 tf->hob_feature = (n_block >> 8) & 0xff;
769 tf->feature = n_block & 0xff;
771 tf->hob_lbah = (block >> 40) & 0xff;
772 tf->hob_lbam = (block >> 32) & 0xff;
773 tf->hob_lbal = (block >> 24) & 0xff;
774 tf->lbah = (block >> 16) & 0xff;
775 tf->lbam = (block >> 8) & 0xff;
776 tf->lbal = block & 0xff;
778 tf->device = ATA_LBA;
779 if (tf->flags & ATA_TFLAG_FUA)
780 tf->device |= 1 << 7;
781 } else if (dev->flags & ATA_DFLAG_LBA) {
782 tf->flags |= ATA_TFLAG_LBA;
784 if (lba_28_ok(block, n_block)) {
785 /* use LBA28 */
786 tf->device |= (block >> 24) & 0xf;
787 } else if (lba_48_ok(block, n_block)) {
788 if (!(dev->flags & ATA_DFLAG_LBA48))
789 return -ERANGE;
791 /* use LBA48 */
792 tf->flags |= ATA_TFLAG_LBA48;
794 tf->hob_nsect = (n_block >> 8) & 0xff;
796 tf->hob_lbah = (block >> 40) & 0xff;
797 tf->hob_lbam = (block >> 32) & 0xff;
798 tf->hob_lbal = (block >> 24) & 0xff;
799 } else
800 /* request too large even for LBA48 */
801 return -ERANGE;
803 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
804 return -EINVAL;
806 tf->nsect = n_block & 0xff;
808 tf->lbah = (block >> 16) & 0xff;
809 tf->lbam = (block >> 8) & 0xff;
810 tf->lbal = block & 0xff;
812 tf->device |= ATA_LBA;
813 } else {
814 /* CHS */
815 u32 sect, head, cyl, track;
817 /* The request -may- be too large for CHS addressing. */
818 if (!lba_28_ok(block, n_block))
819 return -ERANGE;
821 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
822 return -EINVAL;
824 /* Convert LBA to CHS */
825 track = (u32)block / dev->sectors;
826 cyl = track / dev->heads;
827 head = track % dev->heads;
828 sect = (u32)block % dev->sectors + 1;
830 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
831 (u32)block, track, cyl, head, sect);
833 /* Check whether the converted CHS can fit.
834 Cylinder: 0-65535
835 Head: 0-15
836 Sector: 1-255*/
837 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
838 return -ERANGE;
840 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
841 tf->lbal = sect;
842 tf->lbam = cyl;
843 tf->lbah = cyl >> 8;
844 tf->device |= head;
847 return 0;
851 * ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
852 * @pio_mask: pio_mask
853 * @mwdma_mask: mwdma_mask
854 * @udma_mask: udma_mask
856 * Pack @pio_mask, @mwdma_mask and @udma_mask into a single
857 * unsigned int xfer_mask.
859 * LOCKING:
860 * None.
862 * RETURNS:
863 * Packed xfer_mask.
865 unsigned long ata_pack_xfermask(unsigned long pio_mask,
866 unsigned long mwdma_mask,
867 unsigned long udma_mask)
869 return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
870 ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
871 ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
875 * ata_unpack_xfermask - Unpack xfer_mask into pio, mwdma and udma masks
876 * @xfer_mask: xfer_mask to unpack
877 * @pio_mask: resulting pio_mask
878 * @mwdma_mask: resulting mwdma_mask
879 * @udma_mask: resulting udma_mask
881 * Unpack @xfer_mask into @pio_mask, @mwdma_mask and @udma_mask.
882 * Any NULL distination masks will be ignored.
884 void ata_unpack_xfermask(unsigned long xfer_mask, unsigned long *pio_mask,
885 unsigned long *mwdma_mask, unsigned long *udma_mask)
887 if (pio_mask)
888 *pio_mask = (xfer_mask & ATA_MASK_PIO) >> ATA_SHIFT_PIO;
889 if (mwdma_mask)
890 *mwdma_mask = (xfer_mask & ATA_MASK_MWDMA) >> ATA_SHIFT_MWDMA;
891 if (udma_mask)
892 *udma_mask = (xfer_mask & ATA_MASK_UDMA) >> ATA_SHIFT_UDMA;
895 static const struct ata_xfer_ent {
896 int shift, bits;
897 u8 base;
898 } ata_xfer_tbl[] = {
899 { ATA_SHIFT_PIO, ATA_NR_PIO_MODES, XFER_PIO_0 },
900 { ATA_SHIFT_MWDMA, ATA_NR_MWDMA_MODES, XFER_MW_DMA_0 },
901 { ATA_SHIFT_UDMA, ATA_NR_UDMA_MODES, XFER_UDMA_0 },
902 { -1, },
906 * ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
907 * @xfer_mask: xfer_mask of interest
909 * Return matching XFER_* value for @xfer_mask. Only the highest
910 * bit of @xfer_mask is considered.
912 * LOCKING:
913 * None.
915 * RETURNS:
916 * Matching XFER_* value, 0xff if no match found.
918 u8 ata_xfer_mask2mode(unsigned long xfer_mask)
920 int highbit = fls(xfer_mask) - 1;
921 const struct ata_xfer_ent *ent;
923 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
924 if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
925 return ent->base + highbit - ent->shift;
926 return 0xff;
930 * ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
931 * @xfer_mode: XFER_* of interest
933 * Return matching xfer_mask for @xfer_mode.
935 * LOCKING:
936 * None.
938 * RETURNS:
939 * Matching xfer_mask, 0 if no match found.
941 unsigned long ata_xfer_mode2mask(u8 xfer_mode)
943 const struct ata_xfer_ent *ent;
945 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
946 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
947 return ((2 << (ent->shift + xfer_mode - ent->base)) - 1)
948 & ~((1 << ent->shift) - 1);
949 return 0;
953 * ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
954 * @xfer_mode: XFER_* of interest
956 * Return matching xfer_shift for @xfer_mode.
958 * LOCKING:
959 * None.
961 * RETURNS:
962 * Matching xfer_shift, -1 if no match found.
964 int ata_xfer_mode2shift(unsigned long xfer_mode)
966 const struct ata_xfer_ent *ent;
968 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
969 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
970 return ent->shift;
971 return -1;
975 * ata_mode_string - convert xfer_mask to string
976 * @xfer_mask: mask of bits supported; only highest bit counts.
978 * Determine string which represents the highest speed
979 * (highest bit in @modemask).
981 * LOCKING:
982 * None.
984 * RETURNS:
985 * Constant C string representing highest speed listed in
986 * @mode_mask, or the constant C string "<n/a>".
988 const char *ata_mode_string(unsigned long xfer_mask)
990 static const char * const xfer_mode_str[] = {
991 "PIO0",
992 "PIO1",
993 "PIO2",
994 "PIO3",
995 "PIO4",
996 "PIO5",
997 "PIO6",
998 "MWDMA0",
999 "MWDMA1",
1000 "MWDMA2",
1001 "MWDMA3",
1002 "MWDMA4",
1003 "UDMA/16",
1004 "UDMA/25",
1005 "UDMA/33",
1006 "UDMA/44",
1007 "UDMA/66",
1008 "UDMA/100",
1009 "UDMA/133",
1010 "UDMA7",
1012 int highbit;
1014 highbit = fls(xfer_mask) - 1;
1015 if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
1016 return xfer_mode_str[highbit];
1017 return "<n/a>";
1020 const char *sata_spd_string(unsigned int spd)
1022 static const char * const spd_str[] = {
1023 "1.5 Gbps",
1024 "3.0 Gbps",
1025 "6.0 Gbps",
1028 if (spd == 0 || (spd - 1) >= ARRAY_SIZE(spd_str))
1029 return "<unknown>";
1030 return spd_str[spd - 1];
1034 * ata_dev_classify - determine device type based on ATA-spec signature
1035 * @tf: ATA taskfile register set for device to be identified
1037 * Determine from taskfile register contents whether a device is
1038 * ATA or ATAPI, as per "Signature and persistence" section
1039 * of ATA/PI spec (volume 1, sect 5.14).
1041 * LOCKING:
1042 * None.
1044 * RETURNS:
1045 * Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, %ATA_DEV_PMP or
1046 * %ATA_DEV_UNKNOWN the event of failure.
1048 unsigned int ata_dev_classify(const struct ata_taskfile *tf)
1050 /* Apple's open source Darwin code hints that some devices only
1051 * put a proper signature into the LBA mid/high registers,
1052 * So, we only check those. It's sufficient for uniqueness.
1054 * ATA/ATAPI-7 (d1532v1r1: Feb. 19, 2003) specified separate
1055 * signatures for ATA and ATAPI devices attached on SerialATA,
1056 * 0x3c/0xc3 and 0x69/0x96 respectively. However, SerialATA
1057 * spec has never mentioned about using different signatures
1058 * for ATA/ATAPI devices. Then, Serial ATA II: Port
1059 * Multiplier specification began to use 0x69/0x96 to identify
1060 * port multpliers and 0x3c/0xc3 to identify SEMB device.
1061 * ATA/ATAPI-7 dropped descriptions about 0x3c/0xc3 and
1062 * 0x69/0x96 shortly and described them as reserved for
1063 * SerialATA.
1065 * We follow the current spec and consider that 0x69/0x96
1066 * identifies a port multiplier and 0x3c/0xc3 a SEMB device.
1067 * Unfortunately, WDC WD1600JS-62MHB5 (a hard drive) reports
1068 * SEMB signature. This is worked around in
1069 * ata_dev_read_id().
1071 if ((tf->lbam == 0) && (tf->lbah == 0)) {
1072 DPRINTK("found ATA device by sig\n");
1073 return ATA_DEV_ATA;
1076 if ((tf->lbam == 0x14) && (tf->lbah == 0xeb)) {
1077 DPRINTK("found ATAPI device by sig\n");
1078 return ATA_DEV_ATAPI;
1081 if ((tf->lbam == 0x69) && (tf->lbah == 0x96)) {
1082 DPRINTK("found PMP device by sig\n");
1083 return ATA_DEV_PMP;
1086 if ((tf->lbam == 0x3c) && (tf->lbah == 0xc3)) {
1087 DPRINTK("found SEMB device by sig (could be ATA device)\n");
1088 return ATA_DEV_SEMB;
1091 DPRINTK("unknown device\n");
1092 return ATA_DEV_UNKNOWN;
1096 * ata_id_string - Convert IDENTIFY DEVICE page into string
1097 * @id: IDENTIFY DEVICE results we will examine
1098 * @s: string into which data is output
1099 * @ofs: offset into identify device page
1100 * @len: length of string to return. must be an even number.
1102 * The strings in the IDENTIFY DEVICE page are broken up into
1103 * 16-bit chunks. Run through the string, and output each
1104 * 8-bit chunk linearly, regardless of platform.
1106 * LOCKING:
1107 * caller.
1110 void ata_id_string(const u16 *id, unsigned char *s,
1111 unsigned int ofs, unsigned int len)
1113 unsigned int c;
1115 BUG_ON(len & 1);
1117 while (len > 0) {
1118 c = id[ofs] >> 8;
1119 *s = c;
1120 s++;
1122 c = id[ofs] & 0xff;
1123 *s = c;
1124 s++;
1126 ofs++;
1127 len -= 2;
1132 * ata_id_c_string - Convert IDENTIFY DEVICE page into C string
1133 * @id: IDENTIFY DEVICE results we will examine
1134 * @s: string into which data is output
1135 * @ofs: offset into identify device page
1136 * @len: length of string to return. must be an odd number.
1138 * This function is identical to ata_id_string except that it
1139 * trims trailing spaces and terminates the resulting string with
1140 * null. @len must be actual maximum length (even number) + 1.
1142 * LOCKING:
1143 * caller.
1145 void ata_id_c_string(const u16 *id, unsigned char *s,
1146 unsigned int ofs, unsigned int len)
1148 unsigned char *p;
1150 ata_id_string(id, s, ofs, len - 1);
1152 p = s + strnlen(s, len - 1);
1153 while (p > s && p[-1] == ' ')
1154 p--;
1155 *p = '\0';
1158 static u64 ata_id_n_sectors(const u16 *id)
1160 if (ata_id_has_lba(id)) {
1161 if (ata_id_has_lba48(id))
1162 return ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1163 else
1164 return ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1165 } else {
1166 if (ata_id_current_chs_valid(id))
1167 return id[ATA_ID_CUR_CYLS] * id[ATA_ID_CUR_HEADS] *
1168 id[ATA_ID_CUR_SECTORS];
1169 else
1170 return id[ATA_ID_CYLS] * id[ATA_ID_HEADS] *
1171 id[ATA_ID_SECTORS];
1175 u64 ata_tf_to_lba48(const struct ata_taskfile *tf)
1177 u64 sectors = 0;
1179 sectors |= ((u64)(tf->hob_lbah & 0xff)) << 40;
1180 sectors |= ((u64)(tf->hob_lbam & 0xff)) << 32;
1181 sectors |= ((u64)(tf->hob_lbal & 0xff)) << 24;
1182 sectors |= (tf->lbah & 0xff) << 16;
1183 sectors |= (tf->lbam & 0xff) << 8;
1184 sectors |= (tf->lbal & 0xff);
1186 return sectors;
1189 u64 ata_tf_to_lba(const struct ata_taskfile *tf)
1191 u64 sectors = 0;
1193 sectors |= (tf->device & 0x0f) << 24;
1194 sectors |= (tf->lbah & 0xff) << 16;
1195 sectors |= (tf->lbam & 0xff) << 8;
1196 sectors |= (tf->lbal & 0xff);
1198 return sectors;
1202 * ata_read_native_max_address - Read native max address
1203 * @dev: target device
1204 * @max_sectors: out parameter for the result native max address
1206 * Perform an LBA48 or LBA28 native size query upon the device in
1207 * question.
1209 * RETURNS:
1210 * 0 on success, -EACCES if command is aborted by the drive.
1211 * -EIO on other errors.
1213 static int ata_read_native_max_address(struct ata_device *dev, u64 *max_sectors)
1215 unsigned int err_mask;
1216 struct ata_taskfile tf;
1217 int lba48 = ata_id_has_lba48(dev->id);
1219 ata_tf_init(dev, &tf);
1221 /* always clear all address registers */
1222 tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1224 if (lba48) {
1225 tf.command = ATA_CMD_READ_NATIVE_MAX_EXT;
1226 tf.flags |= ATA_TFLAG_LBA48;
1227 } else
1228 tf.command = ATA_CMD_READ_NATIVE_MAX;
1230 tf.protocol |= ATA_PROT_NODATA;
1231 tf.device |= ATA_LBA;
1233 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1234 if (err_mask) {
1235 ata_dev_warn(dev,
1236 "failed to read native max address (err_mask=0x%x)\n",
1237 err_mask);
1238 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
1239 return -EACCES;
1240 return -EIO;
1243 if (lba48)
1244 *max_sectors = ata_tf_to_lba48(&tf) + 1;
1245 else
1246 *max_sectors = ata_tf_to_lba(&tf) + 1;
1247 if (dev->horkage & ATA_HORKAGE_HPA_SIZE)
1248 (*max_sectors)--;
1249 return 0;
1253 * ata_set_max_sectors - Set max sectors
1254 * @dev: target device
1255 * @new_sectors: new max sectors value to set for the device
1257 * Set max sectors of @dev to @new_sectors.
1259 * RETURNS:
1260 * 0 on success, -EACCES if command is aborted or denied (due to
1261 * previous non-volatile SET_MAX) by the drive. -EIO on other
1262 * errors.
1264 static int ata_set_max_sectors(struct ata_device *dev, u64 new_sectors)
1266 unsigned int err_mask;
1267 struct ata_taskfile tf;
1268 int lba48 = ata_id_has_lba48(dev->id);
1270 new_sectors--;
1272 ata_tf_init(dev, &tf);
1274 tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1276 if (lba48) {
1277 tf.command = ATA_CMD_SET_MAX_EXT;
1278 tf.flags |= ATA_TFLAG_LBA48;
1280 tf.hob_lbal = (new_sectors >> 24) & 0xff;
1281 tf.hob_lbam = (new_sectors >> 32) & 0xff;
1282 tf.hob_lbah = (new_sectors >> 40) & 0xff;
1283 } else {
1284 tf.command = ATA_CMD_SET_MAX;
1286 tf.device |= (new_sectors >> 24) & 0xf;
1289 tf.protocol |= ATA_PROT_NODATA;
1290 tf.device |= ATA_LBA;
1292 tf.lbal = (new_sectors >> 0) & 0xff;
1293 tf.lbam = (new_sectors >> 8) & 0xff;
1294 tf.lbah = (new_sectors >> 16) & 0xff;
1296 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1297 if (err_mask) {
1298 ata_dev_warn(dev,
1299 "failed to set max address (err_mask=0x%x)\n",
1300 err_mask);
1301 if (err_mask == AC_ERR_DEV &&
1302 (tf.feature & (ATA_ABORTED | ATA_IDNF)))
1303 return -EACCES;
1304 return -EIO;
1307 return 0;
1311 * ata_hpa_resize - Resize a device with an HPA set
1312 * @dev: Device to resize
1314 * Read the size of an LBA28 or LBA48 disk with HPA features and resize
1315 * it if required to the full size of the media. The caller must check
1316 * the drive has the HPA feature set enabled.
1318 * RETURNS:
1319 * 0 on success, -errno on failure.
1321 static int ata_hpa_resize(struct ata_device *dev)
1323 struct ata_eh_context *ehc = &dev->link->eh_context;
1324 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
1325 bool unlock_hpa = ata_ignore_hpa || dev->flags & ATA_DFLAG_UNLOCK_HPA;
1326 u64 sectors = ata_id_n_sectors(dev->id);
1327 u64 native_sectors;
1328 int rc;
1330 /* do we need to do it? */
1331 if (dev->class != ATA_DEV_ATA ||
1332 !ata_id_has_lba(dev->id) || !ata_id_hpa_enabled(dev->id) ||
1333 (dev->horkage & ATA_HORKAGE_BROKEN_HPA))
1334 return 0;
1336 /* read native max address */
1337 rc = ata_read_native_max_address(dev, &native_sectors);
1338 if (rc) {
1339 /* If device aborted the command or HPA isn't going to
1340 * be unlocked, skip HPA resizing.
1342 if (rc == -EACCES || !unlock_hpa) {
1343 ata_dev_warn(dev,
1344 "HPA support seems broken, skipping HPA handling\n");
1345 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1347 /* we can continue if device aborted the command */
1348 if (rc == -EACCES)
1349 rc = 0;
1352 return rc;
1354 dev->n_native_sectors = native_sectors;
1356 /* nothing to do? */
1357 if (native_sectors <= sectors || !unlock_hpa) {
1358 if (!print_info || native_sectors == sectors)
1359 return 0;
1361 if (native_sectors > sectors)
1362 ata_dev_info(dev,
1363 "HPA detected: current %llu, native %llu\n",
1364 (unsigned long long)sectors,
1365 (unsigned long long)native_sectors);
1366 else if (native_sectors < sectors)
1367 ata_dev_warn(dev,
1368 "native sectors (%llu) is smaller than sectors (%llu)\n",
1369 (unsigned long long)native_sectors,
1370 (unsigned long long)sectors);
1371 return 0;
1374 /* let's unlock HPA */
1375 rc = ata_set_max_sectors(dev, native_sectors);
1376 if (rc == -EACCES) {
1377 /* if device aborted the command, skip HPA resizing */
1378 ata_dev_warn(dev,
1379 "device aborted resize (%llu -> %llu), skipping HPA handling\n",
1380 (unsigned long long)sectors,
1381 (unsigned long long)native_sectors);
1382 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1383 return 0;
1384 } else if (rc)
1385 return rc;
1387 /* re-read IDENTIFY data */
1388 rc = ata_dev_reread_id(dev, 0);
1389 if (rc) {
1390 ata_dev_err(dev,
1391 "failed to re-read IDENTIFY data after HPA resizing\n");
1392 return rc;
1395 if (print_info) {
1396 u64 new_sectors = ata_id_n_sectors(dev->id);
1397 ata_dev_info(dev,
1398 "HPA unlocked: %llu -> %llu, native %llu\n",
1399 (unsigned long long)sectors,
1400 (unsigned long long)new_sectors,
1401 (unsigned long long)native_sectors);
1404 return 0;
1408 * ata_dump_id - IDENTIFY DEVICE info debugging output
1409 * @id: IDENTIFY DEVICE page to dump
1411 * Dump selected 16-bit words from the given IDENTIFY DEVICE
1412 * page.
1414 * LOCKING:
1415 * caller.
1418 static inline void ata_dump_id(const u16 *id)
1420 DPRINTK("49==0x%04x "
1421 "53==0x%04x "
1422 "63==0x%04x "
1423 "64==0x%04x "
1424 "75==0x%04x \n",
1425 id[49],
1426 id[53],
1427 id[63],
1428 id[64],
1429 id[75]);
1430 DPRINTK("80==0x%04x "
1431 "81==0x%04x "
1432 "82==0x%04x "
1433 "83==0x%04x "
1434 "84==0x%04x \n",
1435 id[80],
1436 id[81],
1437 id[82],
1438 id[83],
1439 id[84]);
1440 DPRINTK("88==0x%04x "
1441 "93==0x%04x\n",
1442 id[88],
1443 id[93]);
1447 * ata_id_xfermask - Compute xfermask from the given IDENTIFY data
1448 * @id: IDENTIFY data to compute xfer mask from
1450 * Compute the xfermask for this device. This is not as trivial
1451 * as it seems if we must consider early devices correctly.
1453 * FIXME: pre IDE drive timing (do we care ?).
1455 * LOCKING:
1456 * None.
1458 * RETURNS:
1459 * Computed xfermask
1461 unsigned long ata_id_xfermask(const u16 *id)
1463 unsigned long pio_mask, mwdma_mask, udma_mask;
1465 /* Usual case. Word 53 indicates word 64 is valid */
1466 if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
1467 pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
1468 pio_mask <<= 3;
1469 pio_mask |= 0x7;
1470 } else {
1471 /* If word 64 isn't valid then Word 51 high byte holds
1472 * the PIO timing number for the maximum. Turn it into
1473 * a mask.
1475 u8 mode = (id[ATA_ID_OLD_PIO_MODES] >> 8) & 0xFF;
1476 if (mode < 5) /* Valid PIO range */
1477 pio_mask = (2 << mode) - 1;
1478 else
1479 pio_mask = 1;
1481 /* But wait.. there's more. Design your standards by
1482 * committee and you too can get a free iordy field to
1483 * process. However its the speeds not the modes that
1484 * are supported... Note drivers using the timing API
1485 * will get this right anyway
1489 mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;
1491 if (ata_id_is_cfa(id)) {
1493 * Process compact flash extended modes
1495 int pio = (id[ATA_ID_CFA_MODES] >> 0) & 0x7;
1496 int dma = (id[ATA_ID_CFA_MODES] >> 3) & 0x7;
1498 if (pio)
1499 pio_mask |= (1 << 5);
1500 if (pio > 1)
1501 pio_mask |= (1 << 6);
1502 if (dma)
1503 mwdma_mask |= (1 << 3);
1504 if (dma > 1)
1505 mwdma_mask |= (1 << 4);
1508 udma_mask = 0;
1509 if (id[ATA_ID_FIELD_VALID] & (1 << 2))
1510 udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;
1512 return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
1515 static void ata_qc_complete_internal(struct ata_queued_cmd *qc)
1517 struct completion *waiting = qc->private_data;
1519 complete(waiting);
1523 * ata_exec_internal_sg - execute libata internal command
1524 * @dev: Device to which the command is sent
1525 * @tf: Taskfile registers for the command and the result
1526 * @cdb: CDB for packet command
1527 * @dma_dir: Data tranfer direction of the command
1528 * @sgl: sg list for the data buffer of the command
1529 * @n_elem: Number of sg entries
1530 * @timeout: Timeout in msecs (0 for default)
1532 * Executes libata internal command with timeout. @tf contains
1533 * command on entry and result on return. Timeout and error
1534 * conditions are reported via return value. No recovery action
1535 * is taken after a command times out. It's caller's duty to
1536 * clean up after timeout.
1538 * LOCKING:
1539 * None. Should be called with kernel context, might sleep.
1541 * RETURNS:
1542 * Zero on success, AC_ERR_* mask on failure
1544 unsigned ata_exec_internal_sg(struct ata_device *dev,
1545 struct ata_taskfile *tf, const u8 *cdb,
1546 int dma_dir, struct scatterlist *sgl,
1547 unsigned int n_elem, unsigned long timeout)
1549 struct ata_link *link = dev->link;
1550 struct ata_port *ap = link->ap;
1551 u8 command = tf->command;
1552 int auto_timeout = 0;
1553 struct ata_queued_cmd *qc;
1554 unsigned int tag, preempted_tag;
1555 u32 preempted_sactive, preempted_qc_active;
1556 int preempted_nr_active_links;
1557 DECLARE_COMPLETION_ONSTACK(wait);
1558 unsigned long flags;
1559 unsigned int err_mask;
1560 int rc;
1562 spin_lock_irqsave(ap->lock, flags);
1564 /* no internal command while frozen */
1565 if (ap->pflags & ATA_PFLAG_FROZEN) {
1566 spin_unlock_irqrestore(ap->lock, flags);
1567 return AC_ERR_SYSTEM;
1570 /* initialize internal qc */
1572 /* XXX: Tag 0 is used for drivers with legacy EH as some
1573 * drivers choke if any other tag is given. This breaks
1574 * ata_tag_internal() test for those drivers. Don't use new
1575 * EH stuff without converting to it.
1577 if (ap->ops->error_handler)
1578 tag = ATA_TAG_INTERNAL;
1579 else
1580 tag = 0;
1582 if (test_and_set_bit(tag, &ap->qc_allocated))
1583 BUG();
1584 qc = __ata_qc_from_tag(ap, tag);
1586 qc->tag = tag;
1587 qc->scsicmd = NULL;
1588 qc->ap = ap;
1589 qc->dev = dev;
1590 ata_qc_reinit(qc);
1592 preempted_tag = link->active_tag;
1593 preempted_sactive = link->sactive;
1594 preempted_qc_active = ap->qc_active;
1595 preempted_nr_active_links = ap->nr_active_links;
1596 link->active_tag = ATA_TAG_POISON;
1597 link->sactive = 0;
1598 ap->qc_active = 0;
1599 ap->nr_active_links = 0;
1601 /* prepare & issue qc */
1602 qc->tf = *tf;
1603 if (cdb)
1604 memcpy(qc->cdb, cdb, ATAPI_CDB_LEN);
1606 /* some SATA bridges need us to indicate data xfer direction */
1607 if (tf->protocol == ATAPI_PROT_DMA && (dev->flags & ATA_DFLAG_DMADIR) &&
1608 dma_dir == DMA_FROM_DEVICE)
1609 qc->tf.feature |= ATAPI_DMADIR;
1611 qc->flags |= ATA_QCFLAG_RESULT_TF;
1612 qc->dma_dir = dma_dir;
1613 if (dma_dir != DMA_NONE) {
1614 unsigned int i, buflen = 0;
1615 struct scatterlist *sg;
1617 for_each_sg(sgl, sg, n_elem, i)
1618 buflen += sg->length;
1620 ata_sg_init(qc, sgl, n_elem);
1621 qc->nbytes = buflen;
1624 qc->private_data = &wait;
1625 qc->complete_fn = ata_qc_complete_internal;
1627 ata_qc_issue(qc);
1629 spin_unlock_irqrestore(ap->lock, flags);
1631 if (!timeout) {
1632 if (ata_probe_timeout)
1633 timeout = ata_probe_timeout * 1000;
1634 else {
1635 timeout = ata_internal_cmd_timeout(dev, command);
1636 auto_timeout = 1;
1640 if (ap->ops->error_handler)
1641 ata_eh_release(ap);
1643 rc = wait_for_completion_timeout(&wait, msecs_to_jiffies(timeout));
1645 if (ap->ops->error_handler)
1646 ata_eh_acquire(ap);
1648 ata_sff_flush_pio_task(ap);
1650 if (!rc) {
1651 spin_lock_irqsave(ap->lock, flags);
1653 /* We're racing with irq here. If we lose, the
1654 * following test prevents us from completing the qc
1655 * twice. If we win, the port is frozen and will be
1656 * cleaned up by ->post_internal_cmd().
1658 if (qc->flags & ATA_QCFLAG_ACTIVE) {
1659 qc->err_mask |= AC_ERR_TIMEOUT;
1661 if (ap->ops->error_handler)
1662 ata_port_freeze(ap);
1663 else
1664 ata_qc_complete(qc);
1666 if (ata_msg_warn(ap))
1667 ata_dev_warn(dev, "qc timeout (cmd 0x%x)\n",
1668 command);
1671 spin_unlock_irqrestore(ap->lock, flags);
1674 /* do post_internal_cmd */
1675 if (ap->ops->post_internal_cmd)
1676 ap->ops->post_internal_cmd(qc);
1678 /* perform minimal error analysis */
1679 if (qc->flags & ATA_QCFLAG_FAILED) {
1680 if (qc->result_tf.command & (ATA_ERR | ATA_DF))
1681 qc->err_mask |= AC_ERR_DEV;
1683 if (!qc->err_mask)
1684 qc->err_mask |= AC_ERR_OTHER;
1686 if (qc->err_mask & ~AC_ERR_OTHER)
1687 qc->err_mask &= ~AC_ERR_OTHER;
1690 /* finish up */
1691 spin_lock_irqsave(ap->lock, flags);
1693 *tf = qc->result_tf;
1694 err_mask = qc->err_mask;
1696 ata_qc_free(qc);
1697 link->active_tag = preempted_tag;
1698 link->sactive = preempted_sactive;
1699 ap->qc_active = preempted_qc_active;
1700 ap->nr_active_links = preempted_nr_active_links;
1702 spin_unlock_irqrestore(ap->lock, flags);
1704 if ((err_mask & AC_ERR_TIMEOUT) && auto_timeout)
1705 ata_internal_cmd_timed_out(dev, command);
1707 return err_mask;
1711 * ata_exec_internal - execute libata internal command
1712 * @dev: Device to which the command is sent
1713 * @tf: Taskfile registers for the command and the result
1714 * @cdb: CDB for packet command
1715 * @dma_dir: Data tranfer direction of the command
1716 * @buf: Data buffer of the command
1717 * @buflen: Length of data buffer
1718 * @timeout: Timeout in msecs (0 for default)
1720 * Wrapper around ata_exec_internal_sg() which takes simple
1721 * buffer instead of sg list.
1723 * LOCKING:
1724 * None. Should be called with kernel context, might sleep.
1726 * RETURNS:
1727 * Zero on success, AC_ERR_* mask on failure
1729 unsigned ata_exec_internal(struct ata_device *dev,
1730 struct ata_taskfile *tf, const u8 *cdb,
1731 int dma_dir, void *buf, unsigned int buflen,
1732 unsigned long timeout)
1734 struct scatterlist *psg = NULL, sg;
1735 unsigned int n_elem = 0;
1737 if (dma_dir != DMA_NONE) {
1738 WARN_ON(!buf);
1739 sg_init_one(&sg, buf, buflen);
1740 psg = &sg;
1741 n_elem++;
1744 return ata_exec_internal_sg(dev, tf, cdb, dma_dir, psg, n_elem,
1745 timeout);
1749 * ata_do_simple_cmd - execute simple internal command
1750 * @dev: Device to which the command is sent
1751 * @cmd: Opcode to execute
1753 * Execute a 'simple' command, that only consists of the opcode
1754 * 'cmd' itself, without filling any other registers
1756 * LOCKING:
1757 * Kernel thread context (may sleep).
1759 * RETURNS:
1760 * Zero on success, AC_ERR_* mask on failure
1762 unsigned int ata_do_simple_cmd(struct ata_device *dev, u8 cmd)
1764 struct ata_taskfile tf;
1766 ata_tf_init(dev, &tf);
1768 tf.command = cmd;
1769 tf.flags |= ATA_TFLAG_DEVICE;
1770 tf.protocol = ATA_PROT_NODATA;
1772 return ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1776 * ata_pio_need_iordy - check if iordy needed
1777 * @adev: ATA device
1779 * Check if the current speed of the device requires IORDY. Used
1780 * by various controllers for chip configuration.
1782 unsigned int ata_pio_need_iordy(const struct ata_device *adev)
1784 /* Don't set IORDY if we're preparing for reset. IORDY may
1785 * lead to controller lock up on certain controllers if the
1786 * port is not occupied. See bko#11703 for details.
1788 if (adev->link->ap->pflags & ATA_PFLAG_RESETTING)
1789 return 0;
1790 /* Controller doesn't support IORDY. Probably a pointless
1791 * check as the caller should know this.
1793 if (adev->link->ap->flags & ATA_FLAG_NO_IORDY)
1794 return 0;
1795 /* CF spec. r4.1 Table 22 says no iordy on PIO5 and PIO6. */
1796 if (ata_id_is_cfa(adev->id)
1797 && (adev->pio_mode == XFER_PIO_5 || adev->pio_mode == XFER_PIO_6))
1798 return 0;
1799 /* PIO3 and higher it is mandatory */
1800 if (adev->pio_mode > XFER_PIO_2)
1801 return 1;
1802 /* We turn it on when possible */
1803 if (ata_id_has_iordy(adev->id))
1804 return 1;
1805 return 0;
1809 * ata_pio_mask_no_iordy - Return the non IORDY mask
1810 * @adev: ATA device
1812 * Compute the highest mode possible if we are not using iordy. Return
1813 * -1 if no iordy mode is available.
1815 static u32 ata_pio_mask_no_iordy(const struct ata_device *adev)
1817 /* If we have no drive specific rule, then PIO 2 is non IORDY */
1818 if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
1819 u16 pio = adev->id[ATA_ID_EIDE_PIO];
1820 /* Is the speed faster than the drive allows non IORDY ? */
1821 if (pio) {
1822 /* This is cycle times not frequency - watch the logic! */
1823 if (pio > 240) /* PIO2 is 240nS per cycle */
1824 return 3 << ATA_SHIFT_PIO;
1825 return 7 << ATA_SHIFT_PIO;
1828 return 3 << ATA_SHIFT_PIO;
1832 * ata_do_dev_read_id - default ID read method
1833 * @dev: device
1834 * @tf: proposed taskfile
1835 * @id: data buffer
1837 * Issue the identify taskfile and hand back the buffer containing
1838 * identify data. For some RAID controllers and for pre ATA devices
1839 * this function is wrapped or replaced by the driver
1841 unsigned int ata_do_dev_read_id(struct ata_device *dev,
1842 struct ata_taskfile *tf, u16 *id)
1844 return ata_exec_internal(dev, tf, NULL, DMA_FROM_DEVICE,
1845 id, sizeof(id[0]) * ATA_ID_WORDS, 0);
1849 * ata_dev_read_id - Read ID data from the specified device
1850 * @dev: target device
1851 * @p_class: pointer to class of the target device (may be changed)
1852 * @flags: ATA_READID_* flags
1853 * @id: buffer to read IDENTIFY data into
1855 * Read ID data from the specified device. ATA_CMD_ID_ATA is
1856 * performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
1857 * devices. This function also issues ATA_CMD_INIT_DEV_PARAMS
1858 * for pre-ATA4 drives.
1860 * FIXME: ATA_CMD_ID_ATA is optional for early drives and right
1861 * now we abort if we hit that case.
1863 * LOCKING:
1864 * Kernel thread context (may sleep)
1866 * RETURNS:
1867 * 0 on success, -errno otherwise.
1869 int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
1870 unsigned int flags, u16 *id)
1872 struct ata_port *ap = dev->link->ap;
1873 unsigned int class = *p_class;
1874 struct ata_taskfile tf;
1875 unsigned int err_mask = 0;
1876 const char *reason;
1877 bool is_semb = class == ATA_DEV_SEMB;
1878 int may_fallback = 1, tried_spinup = 0;
1879 int rc;
1881 if (ata_msg_ctl(ap))
1882 ata_dev_dbg(dev, "%s: ENTER\n", __func__);
1884 retry:
1885 ata_tf_init(dev, &tf);
1887 switch (class) {
1888 case ATA_DEV_SEMB:
1889 class = ATA_DEV_ATA; /* some hard drives report SEMB sig */
1890 case ATA_DEV_ATA:
1891 tf.command = ATA_CMD_ID_ATA;
1892 break;
1893 case ATA_DEV_ATAPI:
1894 tf.command = ATA_CMD_ID_ATAPI;
1895 break;
1896 default:
1897 rc = -ENODEV;
1898 reason = "unsupported class";
1899 goto err_out;
1902 tf.protocol = ATA_PROT_PIO;
1904 /* Some devices choke if TF registers contain garbage. Make
1905 * sure those are properly initialized.
1907 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1909 /* Device presence detection is unreliable on some
1910 * controllers. Always poll IDENTIFY if available.
1912 tf.flags |= ATA_TFLAG_POLLING;
1914 if (ap->ops->read_id)
1915 err_mask = ap->ops->read_id(dev, &tf, id);
1916 else
1917 err_mask = ata_do_dev_read_id(dev, &tf, id);
1919 if (err_mask) {
1920 if (err_mask & AC_ERR_NODEV_HINT) {
1921 ata_dev_dbg(dev, "NODEV after polling detection\n");
1922 return -ENOENT;
1925 if (is_semb) {
1926 ata_dev_info(dev,
1927 "IDENTIFY failed on device w/ SEMB sig, disabled\n");
1928 /* SEMB is not supported yet */
1929 *p_class = ATA_DEV_SEMB_UNSUP;
1930 return 0;
1933 if ((err_mask == AC_ERR_DEV) && (tf.feature & ATA_ABORTED)) {
1934 /* Device or controller might have reported
1935 * the wrong device class. Give a shot at the
1936 * other IDENTIFY if the current one is
1937 * aborted by the device.
1939 if (may_fallback) {
1940 may_fallback = 0;
1942 if (class == ATA_DEV_ATA)
1943 class = ATA_DEV_ATAPI;
1944 else
1945 class = ATA_DEV_ATA;
1946 goto retry;
1949 /* Control reaches here iff the device aborted
1950 * both flavors of IDENTIFYs which happens
1951 * sometimes with phantom devices.
1953 ata_dev_dbg(dev,
1954 "both IDENTIFYs aborted, assuming NODEV\n");
1955 return -ENOENT;
1958 rc = -EIO;
1959 reason = "I/O error";
1960 goto err_out;
1963 if (dev->horkage & ATA_HORKAGE_DUMP_ID) {
1964 ata_dev_dbg(dev, "dumping IDENTIFY data, "
1965 "class=%d may_fallback=%d tried_spinup=%d\n",
1966 class, may_fallback, tried_spinup);
1967 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET,
1968 16, 2, id, ATA_ID_WORDS * sizeof(*id), true);
1971 /* Falling back doesn't make sense if ID data was read
1972 * successfully at least once.
1974 may_fallback = 0;
1976 swap_buf_le16(id, ATA_ID_WORDS);
1978 /* sanity check */
1979 rc = -EINVAL;
1980 reason = "device reports invalid type";
1982 if (class == ATA_DEV_ATA) {
1983 if (!ata_id_is_ata(id) && !ata_id_is_cfa(id))
1984 goto err_out;
1985 if (ap->host->flags & ATA_HOST_IGNORE_ATA &&
1986 ata_id_is_ata(id)) {
1987 ata_dev_dbg(dev,
1988 "host indicates ignore ATA devices, ignored\n");
1989 return -ENOENT;
1991 } else {
1992 if (ata_id_is_ata(id))
1993 goto err_out;
1996 if (!tried_spinup && (id[2] == 0x37c8 || id[2] == 0x738c)) {
1997 tried_spinup = 1;
1999 * Drive powered-up in standby mode, and requires a specific
2000 * SET_FEATURES spin-up subcommand before it will accept
2001 * anything other than the original IDENTIFY command.
2003 err_mask = ata_dev_set_feature(dev, SETFEATURES_SPINUP, 0);
2004 if (err_mask && id[2] != 0x738c) {
2005 rc = -EIO;
2006 reason = "SPINUP failed";
2007 goto err_out;
2010 * If the drive initially returned incomplete IDENTIFY info,
2011 * we now must reissue the IDENTIFY command.
2013 if (id[2] == 0x37c8)
2014 goto retry;
2017 if ((flags & ATA_READID_POSTRESET) && class == ATA_DEV_ATA) {
2019 * The exact sequence expected by certain pre-ATA4 drives is:
2020 * SRST RESET
2021 * IDENTIFY (optional in early ATA)
2022 * INITIALIZE DEVICE PARAMETERS (later IDE and ATA)
2023 * anything else..
2024 * Some drives were very specific about that exact sequence.
2026 * Note that ATA4 says lba is mandatory so the second check
2027 * should never trigger.
2029 if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
2030 err_mask = ata_dev_init_params(dev, id[3], id[6]);
2031 if (err_mask) {
2032 rc = -EIO;
2033 reason = "INIT_DEV_PARAMS failed";
2034 goto err_out;
2037 /* current CHS translation info (id[53-58]) might be
2038 * changed. reread the identify device info.
2040 flags &= ~ATA_READID_POSTRESET;
2041 goto retry;
2045 *p_class = class;
2047 return 0;
2049 err_out:
2050 if (ata_msg_warn(ap))
2051 ata_dev_warn(dev, "failed to IDENTIFY (%s, err_mask=0x%x)\n",
2052 reason, err_mask);
2053 return rc;
2056 static int ata_do_link_spd_horkage(struct ata_device *dev)
2058 struct ata_link *plink = ata_dev_phys_link(dev);
2059 u32 target, target_limit;
2061 if (!sata_scr_valid(plink))
2062 return 0;
2064 if (dev->horkage & ATA_HORKAGE_1_5_GBPS)
2065 target = 1;
2066 else
2067 return 0;
2069 target_limit = (1 << target) - 1;
2071 /* if already on stricter limit, no need to push further */
2072 if (plink->sata_spd_limit <= target_limit)
2073 return 0;
2075 plink->sata_spd_limit = target_limit;
2077 /* Request another EH round by returning -EAGAIN if link is
2078 * going faster than the target speed. Forward progress is
2079 * guaranteed by setting sata_spd_limit to target_limit above.
2081 if (plink->sata_spd > target) {
2082 ata_dev_info(dev, "applying link speed limit horkage to %s\n",
2083 sata_spd_string(target));
2084 return -EAGAIN;
2086 return 0;
2089 static inline u8 ata_dev_knobble(struct ata_device *dev)
2091 struct ata_port *ap = dev->link->ap;
2093 if (ata_dev_blacklisted(dev) & ATA_HORKAGE_BRIDGE_OK)
2094 return 0;
2096 return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
2099 static int ata_dev_config_ncq(struct ata_device *dev,
2100 char *desc, size_t desc_sz)
2102 struct ata_port *ap = dev->link->ap;
2103 int hdepth = 0, ddepth = ata_id_queue_depth(dev->id);
2104 unsigned int err_mask;
2105 char *aa_desc = "";
2107 if (!ata_id_has_ncq(dev->id)) {
2108 desc[0] = '\0';
2109 return 0;
2111 if (dev->horkage & ATA_HORKAGE_NONCQ) {
2112 snprintf(desc, desc_sz, "NCQ (not used)");
2113 return 0;
2115 if (ap->flags & ATA_FLAG_NCQ) {
2116 hdepth = min(ap->scsi_host->can_queue, ATA_MAX_QUEUE - 1);
2117 dev->flags |= ATA_DFLAG_NCQ;
2120 if (!(dev->horkage & ATA_HORKAGE_BROKEN_FPDMA_AA) &&
2121 (ap->flags & ATA_FLAG_FPDMA_AA) &&
2122 ata_id_has_fpdma_aa(dev->id)) {
2123 err_mask = ata_dev_set_feature(dev, SETFEATURES_SATA_ENABLE,
2124 SATA_FPDMA_AA);
2125 if (err_mask) {
2126 ata_dev_err(dev,
2127 "failed to enable AA (error_mask=0x%x)\n",
2128 err_mask);
2129 if (err_mask != AC_ERR_DEV) {
2130 dev->horkage |= ATA_HORKAGE_BROKEN_FPDMA_AA;
2131 return -EIO;
2133 } else
2134 aa_desc = ", AA";
2137 if (hdepth >= ddepth)
2138 snprintf(desc, desc_sz, "NCQ (depth %d)%s", ddepth, aa_desc);
2139 else
2140 snprintf(desc, desc_sz, "NCQ (depth %d/%d)%s", hdepth,
2141 ddepth, aa_desc);
2143 if ((ap->flags & ATA_FLAG_FPDMA_AUX) &&
2144 ata_id_has_ncq_send_and_recv(dev->id)) {
2145 err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_SEND_RECV,
2146 0, ap->sector_buf, 1);
2147 if (err_mask) {
2148 ata_dev_dbg(dev,
2149 "failed to get NCQ Send/Recv Log Emask 0x%x\n",
2150 err_mask);
2151 } else {
2152 u8 *cmds = dev->ncq_send_recv_cmds;
2154 dev->flags |= ATA_DFLAG_NCQ_SEND_RECV;
2155 memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_SEND_RECV_SIZE);
2157 if (dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM) {
2158 ata_dev_dbg(dev, "disabling queued TRIM support\n");
2159 cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &=
2160 ~ATA_LOG_NCQ_SEND_RECV_DSM_TRIM;
2165 return 0;
2169 * ata_dev_configure - Configure the specified ATA/ATAPI device
2170 * @dev: Target device to configure
2172 * Configure @dev according to @dev->id. Generic and low-level
2173 * driver specific fixups are also applied.
2175 * LOCKING:
2176 * Kernel thread context (may sleep)
2178 * RETURNS:
2179 * 0 on success, -errno otherwise
2181 int ata_dev_configure(struct ata_device *dev)
2183 struct ata_port *ap = dev->link->ap;
2184 struct ata_eh_context *ehc = &dev->link->eh_context;
2185 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
2186 const u16 *id = dev->id;
2187 unsigned long xfer_mask;
2188 unsigned int err_mask;
2189 char revbuf[7]; /* XYZ-99\0 */
2190 char fwrevbuf[ATA_ID_FW_REV_LEN+1];
2191 char modelbuf[ATA_ID_PROD_LEN+1];
2192 int rc;
2194 if (!ata_dev_enabled(dev) && ata_msg_info(ap)) {
2195 ata_dev_info(dev, "%s: ENTER/EXIT -- nodev\n", __func__);
2196 return 0;
2199 if (ata_msg_probe(ap))
2200 ata_dev_dbg(dev, "%s: ENTER\n", __func__);
2202 /* set horkage */
2203 dev->horkage |= ata_dev_blacklisted(dev);
2204 ata_force_horkage(dev);
2206 if (dev->horkage & ATA_HORKAGE_DISABLE) {
2207 ata_dev_info(dev, "unsupported device, disabling\n");
2208 ata_dev_disable(dev);
2209 return 0;
2212 if ((!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) &&
2213 dev->class == ATA_DEV_ATAPI) {
2214 ata_dev_warn(dev, "WARNING: ATAPI is %s, device ignored\n",
2215 atapi_enabled ? "not supported with this driver"
2216 : "disabled");
2217 ata_dev_disable(dev);
2218 return 0;
2221 rc = ata_do_link_spd_horkage(dev);
2222 if (rc)
2223 return rc;
2225 /* some WD SATA-1 drives have issues with LPM, turn on NOLPM for them */
2226 if ((dev->horkage & ATA_HORKAGE_WD_BROKEN_LPM) &&
2227 (id[ATA_ID_SATA_CAPABILITY] & 0xe) == 0x2)
2228 dev->horkage |= ATA_HORKAGE_NOLPM;
2230 if (dev->horkage & ATA_HORKAGE_NOLPM) {
2231 ata_dev_warn(dev, "LPM support broken, forcing max_power\n");
2232 dev->link->ap->target_lpm_policy = ATA_LPM_MAX_POWER;
2235 /* let ACPI work its magic */
2236 rc = ata_acpi_on_devcfg(dev);
2237 if (rc)
2238 return rc;
2240 /* massage HPA, do it early as it might change IDENTIFY data */
2241 rc = ata_hpa_resize(dev);
2242 if (rc)
2243 return rc;
2245 /* print device capabilities */
2246 if (ata_msg_probe(ap))
2247 ata_dev_dbg(dev,
2248 "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
2249 "85:%04x 86:%04x 87:%04x 88:%04x\n",
2250 __func__,
2251 id[49], id[82], id[83], id[84],
2252 id[85], id[86], id[87], id[88]);
2254 /* initialize to-be-configured parameters */
2255 dev->flags &= ~ATA_DFLAG_CFG_MASK;
2256 dev->max_sectors = 0;
2257 dev->cdb_len = 0;
2258 dev->n_sectors = 0;
2259 dev->cylinders = 0;
2260 dev->heads = 0;
2261 dev->sectors = 0;
2262 dev->multi_count = 0;
2265 * common ATA, ATAPI feature tests
2268 /* find max transfer mode; for printk only */
2269 xfer_mask = ata_id_xfermask(id);
2271 if (ata_msg_probe(ap))
2272 ata_dump_id(id);
2274 /* SCSI only uses 4-char revisions, dump full 8 chars from ATA */
2275 ata_id_c_string(dev->id, fwrevbuf, ATA_ID_FW_REV,
2276 sizeof(fwrevbuf));
2278 ata_id_c_string(dev->id, modelbuf, ATA_ID_PROD,
2279 sizeof(modelbuf));
2281 /* ATA-specific feature tests */
2282 if (dev->class == ATA_DEV_ATA) {
2283 if (ata_id_is_cfa(id)) {
2284 /* CPRM may make this media unusable */
2285 if (id[ATA_ID_CFA_KEY_MGMT] & 1)
2286 ata_dev_warn(dev,
2287 "supports DRM functions and may not be fully accessible\n");
2288 snprintf(revbuf, 7, "CFA");
2289 } else {
2290 snprintf(revbuf, 7, "ATA-%d", ata_id_major_version(id));
2291 /* Warn the user if the device has TPM extensions */
2292 if (ata_id_has_tpm(id))
2293 ata_dev_warn(dev,
2294 "supports DRM functions and may not be fully accessible\n");
2297 dev->n_sectors = ata_id_n_sectors(id);
2299 /* get current R/W Multiple count setting */
2300 if ((dev->id[47] >> 8) == 0x80 && (dev->id[59] & 0x100)) {
2301 unsigned int max = dev->id[47] & 0xff;
2302 unsigned int cnt = dev->id[59] & 0xff;
2303 /* only recognize/allow powers of two here */
2304 if (is_power_of_2(max) && is_power_of_2(cnt))
2305 if (cnt <= max)
2306 dev->multi_count = cnt;
2309 if (ata_id_has_lba(id)) {
2310 const char *lba_desc;
2311 char ncq_desc[24];
2313 lba_desc = "LBA";
2314 dev->flags |= ATA_DFLAG_LBA;
2315 if (ata_id_has_lba48(id)) {
2316 dev->flags |= ATA_DFLAG_LBA48;
2317 lba_desc = "LBA48";
2319 if (dev->n_sectors >= (1UL << 28) &&
2320 ata_id_has_flush_ext(id))
2321 dev->flags |= ATA_DFLAG_FLUSH_EXT;
2324 /* config NCQ */
2325 rc = ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
2326 if (rc)
2327 return rc;
2329 /* print device info to dmesg */
2330 if (ata_msg_drv(ap) && print_info) {
2331 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2332 revbuf, modelbuf, fwrevbuf,
2333 ata_mode_string(xfer_mask));
2334 ata_dev_info(dev,
2335 "%llu sectors, multi %u: %s %s\n",
2336 (unsigned long long)dev->n_sectors,
2337 dev->multi_count, lba_desc, ncq_desc);
2339 } else {
2340 /* CHS */
2342 /* Default translation */
2343 dev->cylinders = id[1];
2344 dev->heads = id[3];
2345 dev->sectors = id[6];
2347 if (ata_id_current_chs_valid(id)) {
2348 /* Current CHS translation is valid. */
2349 dev->cylinders = id[54];
2350 dev->heads = id[55];
2351 dev->sectors = id[56];
2354 /* print device info to dmesg */
2355 if (ata_msg_drv(ap) && print_info) {
2356 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2357 revbuf, modelbuf, fwrevbuf,
2358 ata_mode_string(xfer_mask));
2359 ata_dev_info(dev,
2360 "%llu sectors, multi %u, CHS %u/%u/%u\n",
2361 (unsigned long long)dev->n_sectors,
2362 dev->multi_count, dev->cylinders,
2363 dev->heads, dev->sectors);
2367 /* Check and mark DevSlp capability. Get DevSlp timing variables
2368 * from SATA Settings page of Identify Device Data Log.
2370 if (ata_id_has_devslp(dev->id)) {
2371 u8 *sata_setting = ap->sector_buf;
2372 int i, j;
2374 dev->flags |= ATA_DFLAG_DEVSLP;
2375 err_mask = ata_read_log_page(dev,
2376 ATA_LOG_SATA_ID_DEV_DATA,
2377 ATA_LOG_SATA_SETTINGS,
2378 sata_setting,
2380 if (err_mask)
2381 ata_dev_dbg(dev,
2382 "failed to get Identify Device Data, Emask 0x%x\n",
2383 err_mask);
2384 else
2385 for (i = 0; i < ATA_LOG_DEVSLP_SIZE; i++) {
2386 j = ATA_LOG_DEVSLP_OFFSET + i;
2387 dev->devslp_timing[i] = sata_setting[j];
2391 dev->cdb_len = 16;
2394 /* ATAPI-specific feature tests */
2395 else if (dev->class == ATA_DEV_ATAPI) {
2396 const char *cdb_intr_string = "";
2397 const char *atapi_an_string = "";
2398 const char *dma_dir_string = "";
2399 u32 sntf;
2401 rc = atapi_cdb_len(id);
2402 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
2403 if (ata_msg_warn(ap))
2404 ata_dev_warn(dev, "unsupported CDB len\n");
2405 rc = -EINVAL;
2406 goto err_out_nosup;
2408 dev->cdb_len = (unsigned int) rc;
2410 /* Enable ATAPI AN if both the host and device have
2411 * the support. If PMP is attached, SNTF is required
2412 * to enable ATAPI AN to discern between PHY status
2413 * changed notifications and ATAPI ANs.
2415 if (atapi_an &&
2416 (ap->flags & ATA_FLAG_AN) && ata_id_has_atapi_AN(id) &&
2417 (!sata_pmp_attached(ap) ||
2418 sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf) == 0)) {
2419 /* issue SET feature command to turn this on */
2420 err_mask = ata_dev_set_feature(dev,
2421 SETFEATURES_SATA_ENABLE, SATA_AN);
2422 if (err_mask)
2423 ata_dev_err(dev,
2424 "failed to enable ATAPI AN (err_mask=0x%x)\n",
2425 err_mask);
2426 else {
2427 dev->flags |= ATA_DFLAG_AN;
2428 atapi_an_string = ", ATAPI AN";
2432 if (ata_id_cdb_intr(dev->id)) {
2433 dev->flags |= ATA_DFLAG_CDB_INTR;
2434 cdb_intr_string = ", CDB intr";
2437 if (atapi_dmadir || (dev->horkage & ATA_HORKAGE_ATAPI_DMADIR) || atapi_id_dmadir(dev->id)) {
2438 dev->flags |= ATA_DFLAG_DMADIR;
2439 dma_dir_string = ", DMADIR";
2442 if (ata_id_has_da(dev->id)) {
2443 dev->flags |= ATA_DFLAG_DA;
2444 zpodd_init(dev);
2447 /* print device info to dmesg */
2448 if (ata_msg_drv(ap) && print_info)
2449 ata_dev_info(dev,
2450 "ATAPI: %s, %s, max %s%s%s%s\n",
2451 modelbuf, fwrevbuf,
2452 ata_mode_string(xfer_mask),
2453 cdb_intr_string, atapi_an_string,
2454 dma_dir_string);
2457 /* determine max_sectors */
2458 dev->max_sectors = ATA_MAX_SECTORS;
2459 if (dev->flags & ATA_DFLAG_LBA48)
2460 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2462 /* Limit PATA drive on SATA cable bridge transfers to udma5,
2463 200 sectors */
2464 if (ata_dev_knobble(dev)) {
2465 if (ata_msg_drv(ap) && print_info)
2466 ata_dev_info(dev, "applying bridge limits\n");
2467 dev->udma_mask &= ATA_UDMA5;
2468 dev->max_sectors = ATA_MAX_SECTORS;
2471 if ((dev->class == ATA_DEV_ATAPI) &&
2472 (atapi_command_packet_set(id) == TYPE_TAPE)) {
2473 dev->max_sectors = ATA_MAX_SECTORS_TAPE;
2474 dev->horkage |= ATA_HORKAGE_STUCK_ERR;
2477 if (dev->horkage & ATA_HORKAGE_MAX_SEC_128)
2478 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_128,
2479 dev->max_sectors);
2481 if (dev->horkage & ATA_HORKAGE_MAX_SEC_LBA48)
2482 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2484 if (ap->ops->dev_config)
2485 ap->ops->dev_config(dev);
2487 if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
2488 /* Let the user know. We don't want to disallow opens for
2489 rescue purposes, or in case the vendor is just a blithering
2490 idiot. Do this after the dev_config call as some controllers
2491 with buggy firmware may want to avoid reporting false device
2492 bugs */
2494 if (print_info) {
2495 ata_dev_warn(dev,
2496 "Drive reports diagnostics failure. This may indicate a drive\n");
2497 ata_dev_warn(dev,
2498 "fault or invalid emulation. Contact drive vendor for information.\n");
2502 if ((dev->horkage & ATA_HORKAGE_FIRMWARE_WARN) && print_info) {
2503 ata_dev_warn(dev, "WARNING: device requires firmware update to be fully functional\n");
2504 ata_dev_warn(dev, " contact the vendor or visit http://ata.wiki.kernel.org\n");
2507 return 0;
2509 err_out_nosup:
2510 if (ata_msg_probe(ap))
2511 ata_dev_dbg(dev, "%s: EXIT, err\n", __func__);
2512 return rc;
2516 * ata_cable_40wire - return 40 wire cable type
2517 * @ap: port
2519 * Helper method for drivers which want to hardwire 40 wire cable
2520 * detection.
2523 int ata_cable_40wire(struct ata_port *ap)
2525 return ATA_CBL_PATA40;
2529 * ata_cable_80wire - return 80 wire cable type
2530 * @ap: port
2532 * Helper method for drivers which want to hardwire 80 wire cable
2533 * detection.
2536 int ata_cable_80wire(struct ata_port *ap)
2538 return ATA_CBL_PATA80;
2542 * ata_cable_unknown - return unknown PATA cable.
2543 * @ap: port
2545 * Helper method for drivers which have no PATA cable detection.
2548 int ata_cable_unknown(struct ata_port *ap)
2550 return ATA_CBL_PATA_UNK;
2554 * ata_cable_ignore - return ignored PATA cable.
2555 * @ap: port
2557 * Helper method for drivers which don't use cable type to limit
2558 * transfer mode.
2560 int ata_cable_ignore(struct ata_port *ap)
2562 return ATA_CBL_PATA_IGN;
2566 * ata_cable_sata - return SATA cable type
2567 * @ap: port
2569 * Helper method for drivers which have SATA cables
2572 int ata_cable_sata(struct ata_port *ap)
2574 return ATA_CBL_SATA;
2578 * ata_bus_probe - Reset and probe ATA bus
2579 * @ap: Bus to probe
2581 * Master ATA bus probing function. Initiates a hardware-dependent
2582 * bus reset, then attempts to identify any devices found on
2583 * the bus.
2585 * LOCKING:
2586 * PCI/etc. bus probe sem.
2588 * RETURNS:
2589 * Zero on success, negative errno otherwise.
2592 int ata_bus_probe(struct ata_port *ap)
2594 unsigned int classes[ATA_MAX_DEVICES];
2595 int tries[ATA_MAX_DEVICES];
2596 int rc;
2597 struct ata_device *dev;
2599 ata_for_each_dev(dev, &ap->link, ALL)
2600 tries[dev->devno] = ATA_PROBE_MAX_TRIES;
2602 retry:
2603 ata_for_each_dev(dev, &ap->link, ALL) {
2604 /* If we issue an SRST then an ATA drive (not ATAPI)
2605 * may change configuration and be in PIO0 timing. If
2606 * we do a hard reset (or are coming from power on)
2607 * this is true for ATA or ATAPI. Until we've set a
2608 * suitable controller mode we should not touch the
2609 * bus as we may be talking too fast.
2611 dev->pio_mode = XFER_PIO_0;
2612 dev->dma_mode = 0xff;
2614 /* If the controller has a pio mode setup function
2615 * then use it to set the chipset to rights. Don't
2616 * touch the DMA setup as that will be dealt with when
2617 * configuring devices.
2619 if (ap->ops->set_piomode)
2620 ap->ops->set_piomode(ap, dev);
2623 /* reset and determine device classes */
2624 ap->ops->phy_reset(ap);
2626 ata_for_each_dev(dev, &ap->link, ALL) {
2627 if (dev->class != ATA_DEV_UNKNOWN)
2628 classes[dev->devno] = dev->class;
2629 else
2630 classes[dev->devno] = ATA_DEV_NONE;
2632 dev->class = ATA_DEV_UNKNOWN;
2635 /* read IDENTIFY page and configure devices. We have to do the identify
2636 specific sequence bass-ackwards so that PDIAG- is released by
2637 the slave device */
2639 ata_for_each_dev(dev, &ap->link, ALL_REVERSE) {
2640 if (tries[dev->devno])
2641 dev->class = classes[dev->devno];
2643 if (!ata_dev_enabled(dev))
2644 continue;
2646 rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
2647 dev->id);
2648 if (rc)
2649 goto fail;
2652 /* Now ask for the cable type as PDIAG- should have been released */
2653 if (ap->ops->cable_detect)
2654 ap->cbl = ap->ops->cable_detect(ap);
2656 /* We may have SATA bridge glue hiding here irrespective of
2657 * the reported cable types and sensed types. When SATA
2658 * drives indicate we have a bridge, we don't know which end
2659 * of the link the bridge is which is a problem.
2661 ata_for_each_dev(dev, &ap->link, ENABLED)
2662 if (ata_id_is_sata(dev->id))
2663 ap->cbl = ATA_CBL_SATA;
2665 /* After the identify sequence we can now set up the devices. We do
2666 this in the normal order so that the user doesn't get confused */
2668 ata_for_each_dev(dev, &ap->link, ENABLED) {
2669 ap->link.eh_context.i.flags |= ATA_EHI_PRINTINFO;
2670 rc = ata_dev_configure(dev);
2671 ap->link.eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
2672 if (rc)
2673 goto fail;
2676 /* configure transfer mode */
2677 rc = ata_set_mode(&ap->link, &dev);
2678 if (rc)
2679 goto fail;
2681 ata_for_each_dev(dev, &ap->link, ENABLED)
2682 return 0;
2684 return -ENODEV;
2686 fail:
2687 tries[dev->devno]--;
2689 switch (rc) {
2690 case -EINVAL:
2691 /* eeek, something went very wrong, give up */
2692 tries[dev->devno] = 0;
2693 break;
2695 case -ENODEV:
2696 /* give it just one more chance */
2697 tries[dev->devno] = min(tries[dev->devno], 1);
2698 case -EIO:
2699 if (tries[dev->devno] == 1) {
2700 /* This is the last chance, better to slow
2701 * down than lose it.
2703 sata_down_spd_limit(&ap->link, 0);
2704 ata_down_xfermask_limit(dev, ATA_DNXFER_PIO);
2708 if (!tries[dev->devno])
2709 ata_dev_disable(dev);
2711 goto retry;
2715 * sata_print_link_status - Print SATA link status
2716 * @link: SATA link to printk link status about
2718 * This function prints link speed and status of a SATA link.
2720 * LOCKING:
2721 * None.
2723 static void sata_print_link_status(struct ata_link *link)
2725 u32 sstatus, scontrol, tmp;
2727 if (sata_scr_read(link, SCR_STATUS, &sstatus))
2728 return;
2729 sata_scr_read(link, SCR_CONTROL, &scontrol);
2731 if (ata_phys_link_online(link)) {
2732 tmp = (sstatus >> 4) & 0xf;
2733 ata_link_info(link, "SATA link up %s (SStatus %X SControl %X)\n",
2734 sata_spd_string(tmp), sstatus, scontrol);
2735 } else {
2736 ata_link_info(link, "SATA link down (SStatus %X SControl %X)\n",
2737 sstatus, scontrol);
2742 * ata_dev_pair - return other device on cable
2743 * @adev: device
2745 * Obtain the other device on the same cable, or if none is
2746 * present NULL is returned
2749 struct ata_device *ata_dev_pair(struct ata_device *adev)
2751 struct ata_link *link = adev->link;
2752 struct ata_device *pair = &link->device[1 - adev->devno];
2753 if (!ata_dev_enabled(pair))
2754 return NULL;
2755 return pair;
2759 * sata_down_spd_limit - adjust SATA spd limit downward
2760 * @link: Link to adjust SATA spd limit for
2761 * @spd_limit: Additional limit
2763 * Adjust SATA spd limit of @link downward. Note that this
2764 * function only adjusts the limit. The change must be applied
2765 * using sata_set_spd().
2767 * If @spd_limit is non-zero, the speed is limited to equal to or
2768 * lower than @spd_limit if such speed is supported. If
2769 * @spd_limit is slower than any supported speed, only the lowest
2770 * supported speed is allowed.
2772 * LOCKING:
2773 * Inherited from caller.
2775 * RETURNS:
2776 * 0 on success, negative errno on failure
2778 int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
2780 u32 sstatus, spd, mask;
2781 int rc, bit;
2783 if (!sata_scr_valid(link))
2784 return -EOPNOTSUPP;
2786 /* If SCR can be read, use it to determine the current SPD.
2787 * If not, use cached value in link->sata_spd.
2789 rc = sata_scr_read(link, SCR_STATUS, &sstatus);
2790 if (rc == 0 && ata_sstatus_online(sstatus))
2791 spd = (sstatus >> 4) & 0xf;
2792 else
2793 spd = link->sata_spd;
2795 mask = link->sata_spd_limit;
2796 if (mask <= 1)
2797 return -EINVAL;
2799 /* unconditionally mask off the highest bit */
2800 bit = fls(mask) - 1;
2801 mask &= ~(1 << bit);
2803 /* Mask off all speeds higher than or equal to the current
2804 * one. Force 1.5Gbps if current SPD is not available.
2806 if (spd > 1)
2807 mask &= (1 << (spd - 1)) - 1;
2808 else
2809 mask &= 1;
2811 /* were we already at the bottom? */
2812 if (!mask)
2813 return -EINVAL;
2815 if (spd_limit) {
2816 if (mask & ((1 << spd_limit) - 1))
2817 mask &= (1 << spd_limit) - 1;
2818 else {
2819 bit = ffs(mask) - 1;
2820 mask = 1 << bit;
2824 link->sata_spd_limit = mask;
2826 ata_link_warn(link, "limiting SATA link speed to %s\n",
2827 sata_spd_string(fls(mask)));
2829 return 0;
2832 static int __sata_set_spd_needed(struct ata_link *link, u32 *scontrol)
2834 struct ata_link *host_link = &link->ap->link;
2835 u32 limit, target, spd;
2837 limit = link->sata_spd_limit;
2839 /* Don't configure downstream link faster than upstream link.
2840 * It doesn't speed up anything and some PMPs choke on such
2841 * configuration.
2843 if (!ata_is_host_link(link) && host_link->sata_spd)
2844 limit &= (1 << host_link->sata_spd) - 1;
2846 if (limit == UINT_MAX)
2847 target = 0;
2848 else
2849 target = fls(limit);
2851 spd = (*scontrol >> 4) & 0xf;
2852 *scontrol = (*scontrol & ~0xf0) | ((target & 0xf) << 4);
2854 return spd != target;
2858 * sata_set_spd_needed - is SATA spd configuration needed
2859 * @link: Link in question
2861 * Test whether the spd limit in SControl matches
2862 * @link->sata_spd_limit. This function is used to determine
2863 * whether hardreset is necessary to apply SATA spd
2864 * configuration.
2866 * LOCKING:
2867 * Inherited from caller.
2869 * RETURNS:
2870 * 1 if SATA spd configuration is needed, 0 otherwise.
2872 static int sata_set_spd_needed(struct ata_link *link)
2874 u32 scontrol;
2876 if (sata_scr_read(link, SCR_CONTROL, &scontrol))
2877 return 1;
2879 return __sata_set_spd_needed(link, &scontrol);
2883 * sata_set_spd - set SATA spd according to spd limit
2884 * @link: Link to set SATA spd for
2886 * Set SATA spd of @link according to sata_spd_limit.
2888 * LOCKING:
2889 * Inherited from caller.
2891 * RETURNS:
2892 * 0 if spd doesn't need to be changed, 1 if spd has been
2893 * changed. Negative errno if SCR registers are inaccessible.
2895 int sata_set_spd(struct ata_link *link)
2897 u32 scontrol;
2898 int rc;
2900 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
2901 return rc;
2903 if (!__sata_set_spd_needed(link, &scontrol))
2904 return 0;
2906 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
2907 return rc;
2909 return 1;
2913 * This mode timing computation functionality is ported over from
2914 * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
2917 * PIO 0-4, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
2918 * These were taken from ATA/ATAPI-6 standard, rev 0a, except
2919 * for UDMA6, which is currently supported only by Maxtor drives.
2921 * For PIO 5/6 MWDMA 3/4 see the CFA specification 3.0.
2924 static const struct ata_timing ata_timing[] = {
2925 /* { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 0, 960, 0 }, */
2926 { XFER_PIO_0, 70, 290, 240, 600, 165, 150, 0, 600, 0 },
2927 { XFER_PIO_1, 50, 290, 93, 383, 125, 100, 0, 383, 0 },
2928 { XFER_PIO_2, 30, 290, 40, 330, 100, 90, 0, 240, 0 },
2929 { XFER_PIO_3, 30, 80, 70, 180, 80, 70, 0, 180, 0 },
2930 { XFER_PIO_4, 25, 70, 25, 120, 70, 25, 0, 120, 0 },
2931 { XFER_PIO_5, 15, 65, 25, 100, 65, 25, 0, 100, 0 },
2932 { XFER_PIO_6, 10, 55, 20, 80, 55, 20, 0, 80, 0 },
2934 { XFER_SW_DMA_0, 120, 0, 0, 0, 480, 480, 50, 960, 0 },
2935 { XFER_SW_DMA_1, 90, 0, 0, 0, 240, 240, 30, 480, 0 },
2936 { XFER_SW_DMA_2, 60, 0, 0, 0, 120, 120, 20, 240, 0 },
2938 { XFER_MW_DMA_0, 60, 0, 0, 0, 215, 215, 20, 480, 0 },
2939 { XFER_MW_DMA_1, 45, 0, 0, 0, 80, 50, 5, 150, 0 },
2940 { XFER_MW_DMA_2, 25, 0, 0, 0, 70, 25, 5, 120, 0 },
2941 { XFER_MW_DMA_3, 25, 0, 0, 0, 65, 25, 5, 100, 0 },
2942 { XFER_MW_DMA_4, 25, 0, 0, 0, 55, 20, 5, 80, 0 },
2944 /* { XFER_UDMA_SLOW, 0, 0, 0, 0, 0, 0, 0, 0, 150 }, */
2945 { XFER_UDMA_0, 0, 0, 0, 0, 0, 0, 0, 0, 120 },
2946 { XFER_UDMA_1, 0, 0, 0, 0, 0, 0, 0, 0, 80 },
2947 { XFER_UDMA_2, 0, 0, 0, 0, 0, 0, 0, 0, 60 },
2948 { XFER_UDMA_3, 0, 0, 0, 0, 0, 0, 0, 0, 45 },
2949 { XFER_UDMA_4, 0, 0, 0, 0, 0, 0, 0, 0, 30 },
2950 { XFER_UDMA_5, 0, 0, 0, 0, 0, 0, 0, 0, 20 },
2951 { XFER_UDMA_6, 0, 0, 0, 0, 0, 0, 0, 0, 15 },
2953 { 0xFF }
2956 #define ENOUGH(v, unit) (((v)-1)/(unit)+1)
2957 #define EZ(v, unit) ((v)?ENOUGH(v, unit):0)
2959 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
2961 q->setup = EZ(t->setup * 1000, T);
2962 q->act8b = EZ(t->act8b * 1000, T);
2963 q->rec8b = EZ(t->rec8b * 1000, T);
2964 q->cyc8b = EZ(t->cyc8b * 1000, T);
2965 q->active = EZ(t->active * 1000, T);
2966 q->recover = EZ(t->recover * 1000, T);
2967 q->dmack_hold = EZ(t->dmack_hold * 1000, T);
2968 q->cycle = EZ(t->cycle * 1000, T);
2969 q->udma = EZ(t->udma * 1000, UT);
2972 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
2973 struct ata_timing *m, unsigned int what)
2975 if (what & ATA_TIMING_SETUP ) m->setup = max(a->setup, b->setup);
2976 if (what & ATA_TIMING_ACT8B ) m->act8b = max(a->act8b, b->act8b);
2977 if (what & ATA_TIMING_REC8B ) m->rec8b = max(a->rec8b, b->rec8b);
2978 if (what & ATA_TIMING_CYC8B ) m->cyc8b = max(a->cyc8b, b->cyc8b);
2979 if (what & ATA_TIMING_ACTIVE ) m->active = max(a->active, b->active);
2980 if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
2981 if (what & ATA_TIMING_DMACK_HOLD) m->dmack_hold = max(a->dmack_hold, b->dmack_hold);
2982 if (what & ATA_TIMING_CYCLE ) m->cycle = max(a->cycle, b->cycle);
2983 if (what & ATA_TIMING_UDMA ) m->udma = max(a->udma, b->udma);
2986 const struct ata_timing *ata_timing_find_mode(u8 xfer_mode)
2988 const struct ata_timing *t = ata_timing;
2990 while (xfer_mode > t->mode)
2991 t++;
2993 if (xfer_mode == t->mode)
2994 return t;
2996 WARN_ONCE(true, "%s: unable to find timing for xfer_mode 0x%x\n",
2997 __func__, xfer_mode);
2999 return NULL;
3002 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
3003 struct ata_timing *t, int T, int UT)
3005 const u16 *id = adev->id;
3006 const struct ata_timing *s;
3007 struct ata_timing p;
3010 * Find the mode.
3013 if (!(s = ata_timing_find_mode(speed)))
3014 return -EINVAL;
3016 memcpy(t, s, sizeof(*s));
3019 * If the drive is an EIDE drive, it can tell us it needs extended
3020 * PIO/MW_DMA cycle timing.
3023 if (id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
3024 memset(&p, 0, sizeof(p));
3026 if (speed >= XFER_PIO_0 && speed < XFER_SW_DMA_0) {
3027 if (speed <= XFER_PIO_2)
3028 p.cycle = p.cyc8b = id[ATA_ID_EIDE_PIO];
3029 else if ((speed <= XFER_PIO_4) ||
3030 (speed == XFER_PIO_5 && !ata_id_is_cfa(id)))
3031 p.cycle = p.cyc8b = id[ATA_ID_EIDE_PIO_IORDY];
3032 } else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2)
3033 p.cycle = id[ATA_ID_EIDE_DMA_MIN];
3035 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
3039 * Convert the timing to bus clock counts.
3042 ata_timing_quantize(t, t, T, UT);
3045 * Even in DMA/UDMA modes we still use PIO access for IDENTIFY,
3046 * S.M.A.R.T * and some other commands. We have to ensure that the
3047 * DMA cycle timing is slower/equal than the fastest PIO timing.
3050 if (speed > XFER_PIO_6) {
3051 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
3052 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
3056 * Lengthen active & recovery time so that cycle time is correct.
3059 if (t->act8b + t->rec8b < t->cyc8b) {
3060 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
3061 t->rec8b = t->cyc8b - t->act8b;
3064 if (t->active + t->recover < t->cycle) {
3065 t->active += (t->cycle - (t->active + t->recover)) / 2;
3066 t->recover = t->cycle - t->active;
3069 /* In a few cases quantisation may produce enough errors to
3070 leave t->cycle too low for the sum of active and recovery
3071 if so we must correct this */
3072 if (t->active + t->recover > t->cycle)
3073 t->cycle = t->active + t->recover;
3075 return 0;
3079 * ata_timing_cycle2mode - find xfer mode for the specified cycle duration
3080 * @xfer_shift: ATA_SHIFT_* value for transfer type to examine.
3081 * @cycle: cycle duration in ns
3083 * Return matching xfer mode for @cycle. The returned mode is of
3084 * the transfer type specified by @xfer_shift. If @cycle is too
3085 * slow for @xfer_shift, 0xff is returned. If @cycle is faster
3086 * than the fastest known mode, the fasted mode is returned.
3088 * LOCKING:
3089 * None.
3091 * RETURNS:
3092 * Matching xfer_mode, 0xff if no match found.
3094 u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle)
3096 u8 base_mode = 0xff, last_mode = 0xff;
3097 const struct ata_xfer_ent *ent;
3098 const struct ata_timing *t;
3100 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
3101 if (ent->shift == xfer_shift)
3102 base_mode = ent->base;
3104 for (t = ata_timing_find_mode(base_mode);
3105 t && ata_xfer_mode2shift(t->mode) == xfer_shift; t++) {
3106 unsigned short this_cycle;
3108 switch (xfer_shift) {
3109 case ATA_SHIFT_PIO:
3110 case ATA_SHIFT_MWDMA:
3111 this_cycle = t->cycle;
3112 break;
3113 case ATA_SHIFT_UDMA:
3114 this_cycle = t->udma;
3115 break;
3116 default:
3117 return 0xff;
3120 if (cycle > this_cycle)
3121 break;
3123 last_mode = t->mode;
3126 return last_mode;
3130 * ata_down_xfermask_limit - adjust dev xfer masks downward
3131 * @dev: Device to adjust xfer masks
3132 * @sel: ATA_DNXFER_* selector
3134 * Adjust xfer masks of @dev downward. Note that this function
3135 * does not apply the change. Invoking ata_set_mode() afterwards
3136 * will apply the limit.
3138 * LOCKING:
3139 * Inherited from caller.
3141 * RETURNS:
3142 * 0 on success, negative errno on failure
3144 int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel)
3146 char buf[32];
3147 unsigned long orig_mask, xfer_mask;
3148 unsigned long pio_mask, mwdma_mask, udma_mask;
3149 int quiet, highbit;
3151 quiet = !!(sel & ATA_DNXFER_QUIET);
3152 sel &= ~ATA_DNXFER_QUIET;
3154 xfer_mask = orig_mask = ata_pack_xfermask(dev->pio_mask,
3155 dev->mwdma_mask,
3156 dev->udma_mask);
3157 ata_unpack_xfermask(xfer_mask, &pio_mask, &mwdma_mask, &udma_mask);
3159 switch (sel) {
3160 case ATA_DNXFER_PIO:
3161 highbit = fls(pio_mask) - 1;
3162 pio_mask &= ~(1 << highbit);
3163 break;
3165 case ATA_DNXFER_DMA:
3166 if (udma_mask) {
3167 highbit = fls(udma_mask) - 1;
3168 udma_mask &= ~(1 << highbit);
3169 if (!udma_mask)
3170 return -ENOENT;
3171 } else if (mwdma_mask) {
3172 highbit = fls(mwdma_mask) - 1;
3173 mwdma_mask &= ~(1 << highbit);
3174 if (!mwdma_mask)
3175 return -ENOENT;
3177 break;
3179 case ATA_DNXFER_40C:
3180 udma_mask &= ATA_UDMA_MASK_40C;
3181 break;
3183 case ATA_DNXFER_FORCE_PIO0:
3184 pio_mask &= 1;
3185 case ATA_DNXFER_FORCE_PIO:
3186 mwdma_mask = 0;
3187 udma_mask = 0;
3188 break;
3190 default:
3191 BUG();
3194 xfer_mask &= ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
3196 if (!(xfer_mask & ATA_MASK_PIO) || xfer_mask == orig_mask)
3197 return -ENOENT;
3199 if (!quiet) {
3200 if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
3201 snprintf(buf, sizeof(buf), "%s:%s",
3202 ata_mode_string(xfer_mask),
3203 ata_mode_string(xfer_mask & ATA_MASK_PIO));
3204 else
3205 snprintf(buf, sizeof(buf), "%s",
3206 ata_mode_string(xfer_mask));
3208 ata_dev_warn(dev, "limiting speed to %s\n", buf);
3211 ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
3212 &dev->udma_mask);
3214 return 0;
3217 static int ata_dev_set_mode(struct ata_device *dev)
3219 struct ata_port *ap = dev->link->ap;
3220 struct ata_eh_context *ehc = &dev->link->eh_context;
3221 const bool nosetxfer = dev->horkage & ATA_HORKAGE_NOSETXFER;
3222 const char *dev_err_whine = "";
3223 int ign_dev_err = 0;
3224 unsigned int err_mask = 0;
3225 int rc;
3227 dev->flags &= ~ATA_DFLAG_PIO;
3228 if (dev->xfer_shift == ATA_SHIFT_PIO)
3229 dev->flags |= ATA_DFLAG_PIO;
3231 if (nosetxfer && ap->flags & ATA_FLAG_SATA && ata_id_is_sata(dev->id))
3232 dev_err_whine = " (SET_XFERMODE skipped)";
3233 else {
3234 if (nosetxfer)
3235 ata_dev_warn(dev,
3236 "NOSETXFER but PATA detected - can't "
3237 "skip SETXFER, might malfunction\n");
3238 err_mask = ata_dev_set_xfermode(dev);
3241 if (err_mask & ~AC_ERR_DEV)
3242 goto fail;
3244 /* revalidate */
3245 ehc->i.flags |= ATA_EHI_POST_SETMODE;
3246 rc = ata_dev_revalidate(dev, ATA_DEV_UNKNOWN, 0);
3247 ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
3248 if (rc)
3249 return rc;
3251 if (dev->xfer_shift == ATA_SHIFT_PIO) {
3252 /* Old CFA may refuse this command, which is just fine */
3253 if (ata_id_is_cfa(dev->id))
3254 ign_dev_err = 1;
3255 /* Catch several broken garbage emulations plus some pre
3256 ATA devices */
3257 if (ata_id_major_version(dev->id) == 0 &&
3258 dev->pio_mode <= XFER_PIO_2)
3259 ign_dev_err = 1;
3260 /* Some very old devices and some bad newer ones fail
3261 any kind of SET_XFERMODE request but support PIO0-2
3262 timings and no IORDY */
3263 if (!ata_id_has_iordy(dev->id) && dev->pio_mode <= XFER_PIO_2)
3264 ign_dev_err = 1;
3266 /* Early MWDMA devices do DMA but don't allow DMA mode setting.
3267 Don't fail an MWDMA0 set IFF the device indicates it is in MWDMA0 */
3268 if (dev->xfer_shift == ATA_SHIFT_MWDMA &&
3269 dev->dma_mode == XFER_MW_DMA_0 &&
3270 (dev->id[63] >> 8) & 1)
3271 ign_dev_err = 1;
3273 /* if the device is actually configured correctly, ignore dev err */
3274 if (dev->xfer_mode == ata_xfer_mask2mode(ata_id_xfermask(dev->id)))
3275 ign_dev_err = 1;
3277 if (err_mask & AC_ERR_DEV) {
3278 if (!ign_dev_err)
3279 goto fail;
3280 else
3281 dev_err_whine = " (device error ignored)";
3284 DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
3285 dev->xfer_shift, (int)dev->xfer_mode);
3287 ata_dev_info(dev, "configured for %s%s\n",
3288 ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)),
3289 dev_err_whine);
3291 return 0;
3293 fail:
3294 ata_dev_err(dev, "failed to set xfermode (err_mask=0x%x)\n", err_mask);
3295 return -EIO;
3299 * ata_do_set_mode - Program timings and issue SET FEATURES - XFER
3300 * @link: link on which timings will be programmed
3301 * @r_failed_dev: out parameter for failed device
3303 * Standard implementation of the function used to tune and set
3304 * ATA device disk transfer mode (PIO3, UDMA6, etc.). If
3305 * ata_dev_set_mode() fails, pointer to the failing device is
3306 * returned in @r_failed_dev.
3308 * LOCKING:
3309 * PCI/etc. bus probe sem.
3311 * RETURNS:
3312 * 0 on success, negative errno otherwise
3315 int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
3317 struct ata_port *ap = link->ap;
3318 struct ata_device *dev;
3319 int rc = 0, used_dma = 0, found = 0;
3321 /* step 1: calculate xfer_mask */
3322 ata_for_each_dev(dev, link, ENABLED) {
3323 unsigned long pio_mask, dma_mask;
3324 unsigned int mode_mask;
3326 mode_mask = ATA_DMA_MASK_ATA;
3327 if (dev->class == ATA_DEV_ATAPI)
3328 mode_mask = ATA_DMA_MASK_ATAPI;
3329 else if (ata_id_is_cfa(dev->id))
3330 mode_mask = ATA_DMA_MASK_CFA;
3332 ata_dev_xfermask(dev);
3333 ata_force_xfermask(dev);
3335 pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);
3337 if (libata_dma_mask & mode_mask)
3338 dma_mask = ata_pack_xfermask(0, dev->mwdma_mask,
3339 dev->udma_mask);
3340 else
3341 dma_mask = 0;
3343 dev->pio_mode = ata_xfer_mask2mode(pio_mask);
3344 dev->dma_mode = ata_xfer_mask2mode(dma_mask);
3346 found = 1;
3347 if (ata_dma_enabled(dev))
3348 used_dma = 1;
3350 if (!found)
3351 goto out;
3353 /* step 2: always set host PIO timings */
3354 ata_for_each_dev(dev, link, ENABLED) {
3355 if (dev->pio_mode == 0xff) {
3356 ata_dev_warn(dev, "no PIO support\n");
3357 rc = -EINVAL;
3358 goto out;
3361 dev->xfer_mode = dev->pio_mode;
3362 dev->xfer_shift = ATA_SHIFT_PIO;
3363 if (ap->ops->set_piomode)
3364 ap->ops->set_piomode(ap, dev);
3367 /* step 3: set host DMA timings */
3368 ata_for_each_dev(dev, link, ENABLED) {
3369 if (!ata_dma_enabled(dev))
3370 continue;
3372 dev->xfer_mode = dev->dma_mode;
3373 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
3374 if (ap->ops->set_dmamode)
3375 ap->ops->set_dmamode(ap, dev);
3378 /* step 4: update devices' xfer mode */
3379 ata_for_each_dev(dev, link, ENABLED) {
3380 rc = ata_dev_set_mode(dev);
3381 if (rc)
3382 goto out;
3385 /* Record simplex status. If we selected DMA then the other
3386 * host channels are not permitted to do so.
3388 if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
3389 ap->host->simplex_claimed = ap;
3391 out:
3392 if (rc)
3393 *r_failed_dev = dev;
3394 return rc;
3398 * ata_wait_ready - wait for link to become ready
3399 * @link: link to be waited on
3400 * @deadline: deadline jiffies for the operation
3401 * @check_ready: callback to check link readiness
3403 * Wait for @link to become ready. @check_ready should return
3404 * positive number if @link is ready, 0 if it isn't, -ENODEV if
3405 * link doesn't seem to be occupied, other errno for other error
3406 * conditions.
3408 * Transient -ENODEV conditions are allowed for
3409 * ATA_TMOUT_FF_WAIT.
3411 * LOCKING:
3412 * EH context.
3414 * RETURNS:
3415 * 0 if @linke is ready before @deadline; otherwise, -errno.
3417 int ata_wait_ready(struct ata_link *link, unsigned long deadline,
3418 int (*check_ready)(struct ata_link *link))
3420 unsigned long start = jiffies;
3421 unsigned long nodev_deadline;
3422 int warned = 0;
3424 /* choose which 0xff timeout to use, read comment in libata.h */
3425 if (link->ap->host->flags & ATA_HOST_PARALLEL_SCAN)
3426 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT_LONG);
3427 else
3428 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT);
3430 /* Slave readiness can't be tested separately from master. On
3431 * M/S emulation configuration, this function should be called
3432 * only on the master and it will handle both master and slave.
3434 WARN_ON(link == link->ap->slave_link);
3436 if (time_after(nodev_deadline, deadline))
3437 nodev_deadline = deadline;
3439 while (1) {
3440 unsigned long now = jiffies;
3441 int ready, tmp;
3443 ready = tmp = check_ready(link);
3444 if (ready > 0)
3445 return 0;
3448 * -ENODEV could be transient. Ignore -ENODEV if link
3449 * is online. Also, some SATA devices take a long
3450 * time to clear 0xff after reset. Wait for
3451 * ATA_TMOUT_FF_WAIT[_LONG] on -ENODEV if link isn't
3452 * offline.
3454 * Note that some PATA controllers (pata_ali) explode
3455 * if status register is read more than once when
3456 * there's no device attached.
3458 if (ready == -ENODEV) {
3459 if (ata_link_online(link))
3460 ready = 0;
3461 else if ((link->ap->flags & ATA_FLAG_SATA) &&
3462 !ata_link_offline(link) &&
3463 time_before(now, nodev_deadline))
3464 ready = 0;
3467 if (ready)
3468 return ready;
3469 if (time_after(now, deadline))
3470 return -EBUSY;
3472 if (!warned && time_after(now, start + 5 * HZ) &&
3473 (deadline - now > 3 * HZ)) {
3474 ata_link_warn(link,
3475 "link is slow to respond, please be patient "
3476 "(ready=%d)\n", tmp);
3477 warned = 1;
3480 ata_msleep(link->ap, 50);
3485 * ata_wait_after_reset - wait for link to become ready after reset
3486 * @link: link to be waited on
3487 * @deadline: deadline jiffies for the operation
3488 * @check_ready: callback to check link readiness
3490 * Wait for @link to become ready after reset.
3492 * LOCKING:
3493 * EH context.
3495 * RETURNS:
3496 * 0 if @linke is ready before @deadline; otherwise, -errno.
3498 int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
3499 int (*check_ready)(struct ata_link *link))
3501 ata_msleep(link->ap, ATA_WAIT_AFTER_RESET);
3503 return ata_wait_ready(link, deadline, check_ready);
3507 * sata_link_debounce - debounce SATA phy status
3508 * @link: ATA link to debounce SATA phy status for
3509 * @params: timing parameters { interval, duratinon, timeout } in msec
3510 * @deadline: deadline jiffies for the operation
3512 * Make sure SStatus of @link reaches stable state, determined by
3513 * holding the same value where DET is not 1 for @duration polled
3514 * every @interval, before @timeout. Timeout constraints the
3515 * beginning of the stable state. Because DET gets stuck at 1 on
3516 * some controllers after hot unplugging, this functions waits
3517 * until timeout then returns 0 if DET is stable at 1.
3519 * @timeout is further limited by @deadline. The sooner of the
3520 * two is used.
3522 * LOCKING:
3523 * Kernel thread context (may sleep)
3525 * RETURNS:
3526 * 0 on success, -errno on failure.
3528 int sata_link_debounce(struct ata_link *link, const unsigned long *params,
3529 unsigned long deadline)
3531 unsigned long interval = params[0];
3532 unsigned long duration = params[1];
3533 unsigned long last_jiffies, t;
3534 u32 last, cur;
3535 int rc;
3537 t = ata_deadline(jiffies, params[2]);
3538 if (time_before(t, deadline))
3539 deadline = t;
3541 if ((rc = sata_scr_read(link, SCR_STATUS, &cur)))
3542 return rc;
3543 cur &= 0xf;
3545 last = cur;
3546 last_jiffies = jiffies;
3548 while (1) {
3549 ata_msleep(link->ap, interval);
3550 if ((rc = sata_scr_read(link, SCR_STATUS, &cur)))
3551 return rc;
3552 cur &= 0xf;
3554 /* DET stable? */
3555 if (cur == last) {
3556 if (cur == 1 && time_before(jiffies, deadline))
3557 continue;
3558 if (time_after(jiffies,
3559 ata_deadline(last_jiffies, duration)))
3560 return 0;
3561 continue;
3564 /* unstable, start over */
3565 last = cur;
3566 last_jiffies = jiffies;
3568 /* Check deadline. If debouncing failed, return
3569 * -EPIPE to tell upper layer to lower link speed.
3571 if (time_after(jiffies, deadline))
3572 return -EPIPE;
3577 * sata_link_resume - resume SATA link
3578 * @link: ATA link to resume SATA
3579 * @params: timing parameters { interval, duratinon, timeout } in msec
3580 * @deadline: deadline jiffies for the operation
3582 * Resume SATA phy @link and debounce it.
3584 * LOCKING:
3585 * Kernel thread context (may sleep)
3587 * RETURNS:
3588 * 0 on success, -errno on failure.
3590 int sata_link_resume(struct ata_link *link, const unsigned long *params,
3591 unsigned long deadline)
3593 int tries = ATA_LINK_RESUME_TRIES;
3594 u32 scontrol, serror;
3595 int rc;
3597 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3598 return rc;
3601 * Writes to SControl sometimes get ignored under certain
3602 * controllers (ata_piix SIDPR). Make sure DET actually is
3603 * cleared.
3605 do {
3606 scontrol = (scontrol & 0x0f0) | 0x300;
3607 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
3608 return rc;
3610 * Some PHYs react badly if SStatus is pounded
3611 * immediately after resuming. Delay 200ms before
3612 * debouncing.
3614 ata_msleep(link->ap, 200);
3616 /* is SControl restored correctly? */
3617 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3618 return rc;
3619 } while ((scontrol & 0xf0f) != 0x300 && --tries);
3621 if ((scontrol & 0xf0f) != 0x300) {
3622 ata_link_warn(link, "failed to resume link (SControl %X)\n",
3623 scontrol);
3624 return 0;
3627 if (tries < ATA_LINK_RESUME_TRIES)
3628 ata_link_warn(link, "link resume succeeded after %d retries\n",
3629 ATA_LINK_RESUME_TRIES - tries);
3631 if ((rc = sata_link_debounce(link, params, deadline)))
3632 return rc;
3634 /* clear SError, some PHYs require this even for SRST to work */
3635 if (!(rc = sata_scr_read(link, SCR_ERROR, &serror)))
3636 rc = sata_scr_write(link, SCR_ERROR, serror);
3638 return rc != -EINVAL ? rc : 0;
3642 * sata_link_scr_lpm - manipulate SControl IPM and SPM fields
3643 * @link: ATA link to manipulate SControl for
3644 * @policy: LPM policy to configure
3645 * @spm_wakeup: initiate LPM transition to active state
3647 * Manipulate the IPM field of the SControl register of @link
3648 * according to @policy. If @policy is ATA_LPM_MAX_POWER and
3649 * @spm_wakeup is %true, the SPM field is manipulated to wake up
3650 * the link. This function also clears PHYRDY_CHG before
3651 * returning.
3653 * LOCKING:
3654 * EH context.
3656 * RETURNS:
3657 * 0 on succes, -errno otherwise.
3659 int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
3660 bool spm_wakeup)
3662 struct ata_eh_context *ehc = &link->eh_context;
3663 bool woken_up = false;
3664 u32 scontrol;
3665 int rc;
3667 rc = sata_scr_read(link, SCR_CONTROL, &scontrol);
3668 if (rc)
3669 return rc;
3671 switch (policy) {
3672 case ATA_LPM_MAX_POWER:
3673 /* disable all LPM transitions */
3674 scontrol |= (0x7 << 8);
3675 /* initiate transition to active state */
3676 if (spm_wakeup) {
3677 scontrol |= (0x4 << 12);
3678 woken_up = true;
3680 break;
3681 case ATA_LPM_MED_POWER:
3682 /* allow LPM to PARTIAL */
3683 scontrol &= ~(0x1 << 8);
3684 scontrol |= (0x6 << 8);
3685 break;
3686 case ATA_LPM_MIN_POWER:
3687 if (ata_link_nr_enabled(link) > 0)
3688 /* no restrictions on LPM transitions */
3689 scontrol &= ~(0x7 << 8);
3690 else {
3691 /* empty port, power off */
3692 scontrol &= ~0xf;
3693 scontrol |= (0x1 << 2);
3695 break;
3696 default:
3697 WARN_ON(1);
3700 rc = sata_scr_write(link, SCR_CONTROL, scontrol);
3701 if (rc)
3702 return rc;
3704 /* give the link time to transit out of LPM state */
3705 if (woken_up)
3706 msleep(10);
3708 /* clear PHYRDY_CHG from SError */
3709 ehc->i.serror &= ~SERR_PHYRDY_CHG;
3710 return sata_scr_write(link, SCR_ERROR, SERR_PHYRDY_CHG);
3714 * ata_std_prereset - prepare for reset
3715 * @link: ATA link to be reset
3716 * @deadline: deadline jiffies for the operation
3718 * @link is about to be reset. Initialize it. Failure from
3719 * prereset makes libata abort whole reset sequence and give up
3720 * that port, so prereset should be best-effort. It does its
3721 * best to prepare for reset sequence but if things go wrong, it
3722 * should just whine, not fail.
3724 * LOCKING:
3725 * Kernel thread context (may sleep)
3727 * RETURNS:
3728 * 0 on success, -errno otherwise.
3730 int ata_std_prereset(struct ata_link *link, unsigned long deadline)
3732 struct ata_port *ap = link->ap;
3733 struct ata_eh_context *ehc = &link->eh_context;
3734 const unsigned long *timing = sata_ehc_deb_timing(ehc);
3735 int rc;
3737 /* if we're about to do hardreset, nothing more to do */
3738 if (ehc->i.action & ATA_EH_HARDRESET)
3739 return 0;
3741 /* if SATA, resume link */
3742 if (ap->flags & ATA_FLAG_SATA) {
3743 rc = sata_link_resume(link, timing, deadline);
3744 /* whine about phy resume failure but proceed */
3745 if (rc && rc != -EOPNOTSUPP)
3746 ata_link_warn(link,
3747 "failed to resume link for reset (errno=%d)\n",
3748 rc);
3751 /* no point in trying softreset on offline link */
3752 if (ata_phys_link_offline(link))
3753 ehc->i.action &= ~ATA_EH_SOFTRESET;
3755 return 0;
3759 * sata_link_hardreset - reset link via SATA phy reset
3760 * @link: link to reset
3761 * @timing: timing parameters { interval, duratinon, timeout } in msec
3762 * @deadline: deadline jiffies for the operation
3763 * @online: optional out parameter indicating link onlineness
3764 * @check_ready: optional callback to check link readiness
3766 * SATA phy-reset @link using DET bits of SControl register.
3767 * After hardreset, link readiness is waited upon using
3768 * ata_wait_ready() if @check_ready is specified. LLDs are
3769 * allowed to not specify @check_ready and wait itself after this
3770 * function returns. Device classification is LLD's
3771 * responsibility.
3773 * *@online is set to one iff reset succeeded and @link is online
3774 * after reset.
3776 * LOCKING:
3777 * Kernel thread context (may sleep)
3779 * RETURNS:
3780 * 0 on success, -errno otherwise.
3782 int sata_link_hardreset(struct ata_link *link, const unsigned long *timing,
3783 unsigned long deadline,
3784 bool *online, int (*check_ready)(struct ata_link *))
3786 u32 scontrol;
3787 int rc;
3789 DPRINTK("ENTER\n");
3791 if (online)
3792 *online = false;
3794 if (sata_set_spd_needed(link)) {
3795 /* SATA spec says nothing about how to reconfigure
3796 * spd. To be on the safe side, turn off phy during
3797 * reconfiguration. This works for at least ICH7 AHCI
3798 * and Sil3124.
3800 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3801 goto out;
3803 scontrol = (scontrol & 0x0f0) | 0x304;
3805 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
3806 goto out;
3808 sata_set_spd(link);
3811 /* issue phy wake/reset */
3812 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3813 goto out;
3815 scontrol = (scontrol & 0x0f0) | 0x301;
3817 if ((rc = sata_scr_write_flush(link, SCR_CONTROL, scontrol)))
3818 goto out;
3820 /* Couldn't find anything in SATA I/II specs, but AHCI-1.1
3821 * 10.4.2 says at least 1 ms.
3823 ata_msleep(link->ap, 1);
3825 /* bring link back */
3826 rc = sata_link_resume(link, timing, deadline);
3827 if (rc)
3828 goto out;
3829 /* if link is offline nothing more to do */
3830 if (ata_phys_link_offline(link))
3831 goto out;
3833 /* Link is online. From this point, -ENODEV too is an error. */
3834 if (online)
3835 *online = true;
3837 if (sata_pmp_supported(link->ap) && ata_is_host_link(link)) {
3838 /* If PMP is supported, we have to do follow-up SRST.
3839 * Some PMPs don't send D2H Reg FIS after hardreset if
3840 * the first port is empty. Wait only for
3841 * ATA_TMOUT_PMP_SRST_WAIT.
3843 if (check_ready) {
3844 unsigned long pmp_deadline;
3846 pmp_deadline = ata_deadline(jiffies,
3847 ATA_TMOUT_PMP_SRST_WAIT);
3848 if (time_after(pmp_deadline, deadline))
3849 pmp_deadline = deadline;
3850 ata_wait_ready(link, pmp_deadline, check_ready);
3852 rc = -EAGAIN;
3853 goto out;
3856 rc = 0;
3857 if (check_ready)
3858 rc = ata_wait_ready(link, deadline, check_ready);
3859 out:
3860 if (rc && rc != -EAGAIN) {
3861 /* online is set iff link is online && reset succeeded */
3862 if (online)
3863 *online = false;
3864 ata_link_err(link, "COMRESET failed (errno=%d)\n", rc);
3866 DPRINTK("EXIT, rc=%d\n", rc);
3867 return rc;
3871 * sata_std_hardreset - COMRESET w/o waiting or classification
3872 * @link: link to reset
3873 * @class: resulting class of attached device
3874 * @deadline: deadline jiffies for the operation
3876 * Standard SATA COMRESET w/o waiting or classification.
3878 * LOCKING:
3879 * Kernel thread context (may sleep)
3881 * RETURNS:
3882 * 0 if link offline, -EAGAIN if link online, -errno on errors.
3884 int sata_std_hardreset(struct ata_link *link, unsigned int *class,
3885 unsigned long deadline)
3887 const unsigned long *timing = sata_ehc_deb_timing(&link->eh_context);
3888 bool online;
3889 int rc;
3891 /* do hardreset */
3892 rc = sata_link_hardreset(link, timing, deadline, &online, NULL);
3893 return online ? -EAGAIN : rc;
3897 * ata_std_postreset - standard postreset callback
3898 * @link: the target ata_link
3899 * @classes: classes of attached devices
3901 * This function is invoked after a successful reset. Note that
3902 * the device might have been reset more than once using
3903 * different reset methods before postreset is invoked.
3905 * LOCKING:
3906 * Kernel thread context (may sleep)
3908 void ata_std_postreset(struct ata_link *link, unsigned int *classes)
3910 u32 serror;
3912 DPRINTK("ENTER\n");
3914 /* reset complete, clear SError */
3915 if (!sata_scr_read(link, SCR_ERROR, &serror))
3916 sata_scr_write(link, SCR_ERROR, serror);
3918 /* print link status */
3919 sata_print_link_status(link);
3921 DPRINTK("EXIT\n");
3925 * ata_dev_same_device - Determine whether new ID matches configured device
3926 * @dev: device to compare against
3927 * @new_class: class of the new device
3928 * @new_id: IDENTIFY page of the new device
3930 * Compare @new_class and @new_id against @dev and determine
3931 * whether @dev is the device indicated by @new_class and
3932 * @new_id.
3934 * LOCKING:
3935 * None.
3937 * RETURNS:
3938 * 1 if @dev matches @new_class and @new_id, 0 otherwise.
3940 static int ata_dev_same_device(struct ata_device *dev, unsigned int new_class,
3941 const u16 *new_id)
3943 const u16 *old_id = dev->id;
3944 unsigned char model[2][ATA_ID_PROD_LEN + 1];
3945 unsigned char serial[2][ATA_ID_SERNO_LEN + 1];
3947 if (dev->class != new_class) {
3948 ata_dev_info(dev, "class mismatch %d != %d\n",
3949 dev->class, new_class);
3950 return 0;
3953 ata_id_c_string(old_id, model[0], ATA_ID_PROD, sizeof(model[0]));
3954 ata_id_c_string(new_id, model[1], ATA_ID_PROD, sizeof(model[1]));
3955 ata_id_c_string(old_id, serial[0], ATA_ID_SERNO, sizeof(serial[0]));
3956 ata_id_c_string(new_id, serial[1], ATA_ID_SERNO, sizeof(serial[1]));
3958 if (strcmp(model[0], model[1])) {
3959 ata_dev_info(dev, "model number mismatch '%s' != '%s'\n",
3960 model[0], model[1]);
3961 return 0;
3964 if (strcmp(serial[0], serial[1])) {
3965 ata_dev_info(dev, "serial number mismatch '%s' != '%s'\n",
3966 serial[0], serial[1]);
3967 return 0;
3970 return 1;
3974 * ata_dev_reread_id - Re-read IDENTIFY data
3975 * @dev: target ATA device
3976 * @readid_flags: read ID flags
3978 * Re-read IDENTIFY page and make sure @dev is still attached to
3979 * the port.
3981 * LOCKING:
3982 * Kernel thread context (may sleep)
3984 * RETURNS:
3985 * 0 on success, negative errno otherwise
3987 int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags)
3989 unsigned int class = dev->class;
3990 u16 *id = (void *)dev->link->ap->sector_buf;
3991 int rc;
3993 /* read ID data */
3994 rc = ata_dev_read_id(dev, &class, readid_flags, id);
3995 if (rc)
3996 return rc;
3998 /* is the device still there? */
3999 if (!ata_dev_same_device(dev, class, id))
4000 return -ENODEV;
4002 memcpy(dev->id, id, sizeof(id[0]) * ATA_ID_WORDS);
4003 return 0;
4007 * ata_dev_revalidate - Revalidate ATA device
4008 * @dev: device to revalidate
4009 * @new_class: new class code
4010 * @readid_flags: read ID flags
4012 * Re-read IDENTIFY page, make sure @dev is still attached to the
4013 * port and reconfigure it according to the new IDENTIFY page.
4015 * LOCKING:
4016 * Kernel thread context (may sleep)
4018 * RETURNS:
4019 * 0 on success, negative errno otherwise
4021 int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
4022 unsigned int readid_flags)
4024 u64 n_sectors = dev->n_sectors;
4025 u64 n_native_sectors = dev->n_native_sectors;
4026 int rc;
4028 if (!ata_dev_enabled(dev))
4029 return -ENODEV;
4031 /* fail early if !ATA && !ATAPI to avoid issuing [P]IDENTIFY to PMP */
4032 if (ata_class_enabled(new_class) &&
4033 new_class != ATA_DEV_ATA &&
4034 new_class != ATA_DEV_ATAPI &&
4035 new_class != ATA_DEV_SEMB) {
4036 ata_dev_info(dev, "class mismatch %u != %u\n",
4037 dev->class, new_class);
4038 rc = -ENODEV;
4039 goto fail;
4042 /* re-read ID */
4043 rc = ata_dev_reread_id(dev, readid_flags);
4044 if (rc)
4045 goto fail;
4047 /* configure device according to the new ID */
4048 rc = ata_dev_configure(dev);
4049 if (rc)
4050 goto fail;
4052 /* verify n_sectors hasn't changed */
4053 if (dev->class != ATA_DEV_ATA || !n_sectors ||
4054 dev->n_sectors == n_sectors)
4055 return 0;
4057 /* n_sectors has changed */
4058 ata_dev_warn(dev, "n_sectors mismatch %llu != %llu\n",
4059 (unsigned long long)n_sectors,
4060 (unsigned long long)dev->n_sectors);
4063 * Something could have caused HPA to be unlocked
4064 * involuntarily. If n_native_sectors hasn't changed and the
4065 * new size matches it, keep the device.
4067 if (dev->n_native_sectors == n_native_sectors &&
4068 dev->n_sectors > n_sectors && dev->n_sectors == n_native_sectors) {
4069 ata_dev_warn(dev,
4070 "new n_sectors matches native, probably "
4071 "late HPA unlock, n_sectors updated\n");
4072 /* use the larger n_sectors */
4073 return 0;
4077 * Some BIOSes boot w/o HPA but resume w/ HPA locked. Try
4078 * unlocking HPA in those cases.
4080 * https://bugzilla.kernel.org/show_bug.cgi?id=15396
4082 if (dev->n_native_sectors == n_native_sectors &&
4083 dev->n_sectors < n_sectors && n_sectors == n_native_sectors &&
4084 !(dev->horkage & ATA_HORKAGE_BROKEN_HPA)) {
4085 ata_dev_warn(dev,
4086 "old n_sectors matches native, probably "
4087 "late HPA lock, will try to unlock HPA\n");
4088 /* try unlocking HPA */
4089 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
4090 rc = -EIO;
4091 } else
4092 rc = -ENODEV;
4094 /* restore original n_[native_]sectors and fail */
4095 dev->n_native_sectors = n_native_sectors;
4096 dev->n_sectors = n_sectors;
4097 fail:
4098 ata_dev_err(dev, "revalidation failed (errno=%d)\n", rc);
4099 return rc;
4102 struct ata_blacklist_entry {
4103 const char *model_num;
4104 const char *model_rev;
4105 unsigned long horkage;
4108 static const struct ata_blacklist_entry ata_device_blacklist [] = {
4109 /* Devices with DMA related problems under Linux */
4110 { "WDC AC11000H", NULL, ATA_HORKAGE_NODMA },
4111 { "WDC AC22100H", NULL, ATA_HORKAGE_NODMA },
4112 { "WDC AC32500H", NULL, ATA_HORKAGE_NODMA },
4113 { "WDC AC33100H", NULL, ATA_HORKAGE_NODMA },
4114 { "WDC AC31600H", NULL, ATA_HORKAGE_NODMA },
4115 { "WDC AC32100H", "24.09P07", ATA_HORKAGE_NODMA },
4116 { "WDC AC23200L", "21.10N21", ATA_HORKAGE_NODMA },
4117 { "Compaq CRD-8241B", NULL, ATA_HORKAGE_NODMA },
4118 { "CRD-8400B", NULL, ATA_HORKAGE_NODMA },
4119 { "CRD-848[02]B", NULL, ATA_HORKAGE_NODMA },
4120 { "CRD-84", NULL, ATA_HORKAGE_NODMA },
4121 { "SanDisk SDP3B", NULL, ATA_HORKAGE_NODMA },
4122 { "SanDisk SDP3B-64", NULL, ATA_HORKAGE_NODMA },
4123 { "SANYO CD-ROM CRD", NULL, ATA_HORKAGE_NODMA },
4124 { "HITACHI CDR-8", NULL, ATA_HORKAGE_NODMA },
4125 { "HITACHI CDR-8[34]35",NULL, ATA_HORKAGE_NODMA },
4126 { "Toshiba CD-ROM XM-6202B", NULL, ATA_HORKAGE_NODMA },
4127 { "TOSHIBA CD-ROM XM-1702BC", NULL, ATA_HORKAGE_NODMA },
4128 { "CD-532E-A", NULL, ATA_HORKAGE_NODMA },
4129 { "E-IDE CD-ROM CR-840",NULL, ATA_HORKAGE_NODMA },
4130 { "CD-ROM Drive/F5A", NULL, ATA_HORKAGE_NODMA },
4131 { "WPI CDD-820", NULL, ATA_HORKAGE_NODMA },
4132 { "SAMSUNG CD-ROM SC-148C", NULL, ATA_HORKAGE_NODMA },
4133 { "SAMSUNG CD-ROM SC", NULL, ATA_HORKAGE_NODMA },
4134 { "ATAPI CD-ROM DRIVE 40X MAXIMUM",NULL,ATA_HORKAGE_NODMA },
4135 { "_NEC DV5800A", NULL, ATA_HORKAGE_NODMA },
4136 { "SAMSUNG CD-ROM SN-124", "N001", ATA_HORKAGE_NODMA },
4137 { "Seagate STT20000A", NULL, ATA_HORKAGE_NODMA },
4138 { " 2GB ATA Flash Disk", "ADMA428M", ATA_HORKAGE_NODMA },
4139 /* Odd clown on sil3726/4726 PMPs */
4140 { "Config Disk", NULL, ATA_HORKAGE_DISABLE },
4142 /* Weird ATAPI devices */
4143 { "TORiSAN DVD-ROM DRD-N216", NULL, ATA_HORKAGE_MAX_SEC_128 },
4144 { "QUANTUM DAT DAT72-000", NULL, ATA_HORKAGE_ATAPI_MOD16_DMA },
4145 { "Slimtype DVD A DS8A8SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
4146 { "Slimtype DVD A DS8A9SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
4148 /* Devices we expect to fail diagnostics */
4150 /* Devices where NCQ should be avoided */
4151 /* NCQ is slow */
4152 { "WDC WD740ADFD-00", NULL, ATA_HORKAGE_NONCQ },
4153 { "WDC WD740ADFD-00NLR1", NULL, ATA_HORKAGE_NONCQ, },
4154 /* http://thread.gmane.org/gmane.linux.ide/14907 */
4155 { "FUJITSU MHT2060BH", NULL, ATA_HORKAGE_NONCQ },
4156 /* NCQ is broken */
4157 { "Maxtor *", "BANC*", ATA_HORKAGE_NONCQ },
4158 { "Maxtor 7V300F0", "VA111630", ATA_HORKAGE_NONCQ },
4159 { "ST380817AS", "3.42", ATA_HORKAGE_NONCQ },
4160 { "ST3160023AS", "3.42", ATA_HORKAGE_NONCQ },
4161 { "OCZ CORE_SSD", "02.10104", ATA_HORKAGE_NONCQ },
4163 /* Seagate NCQ + FLUSH CACHE firmware bug */
4164 { "ST31500341AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4165 ATA_HORKAGE_FIRMWARE_WARN },
4167 { "ST31000333AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4168 ATA_HORKAGE_FIRMWARE_WARN },
4170 { "ST3640[36]23AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4171 ATA_HORKAGE_FIRMWARE_WARN },
4173 { "ST3320[68]13AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4174 ATA_HORKAGE_FIRMWARE_WARN },
4176 /* Seagate Momentus SpinPoint M8 seem to have FPMDA_AA issues */
4177 { "ST1000LM024 HN-M101MBB", "2AR10001", ATA_HORKAGE_BROKEN_FPDMA_AA },
4179 /* Blacklist entries taken from Silicon Image 3124/3132
4180 Windows driver .inf file - also several Linux problem reports */
4181 { "HTS541060G9SA00", "MB3OC60D", ATA_HORKAGE_NONCQ, },
4182 { "HTS541080G9SA00", "MB4OC60D", ATA_HORKAGE_NONCQ, },
4183 { "HTS541010G9SA00", "MBZOC60D", ATA_HORKAGE_NONCQ, },
4185 /* https://bugzilla.kernel.org/show_bug.cgi?id=15573 */
4186 { "C300-CTFDDAC128MAG", "0001", ATA_HORKAGE_NONCQ, },
4188 /* devices which puke on READ_NATIVE_MAX */
4189 { "HDS724040KLSA80", "KFAOA20N", ATA_HORKAGE_BROKEN_HPA, },
4190 { "WDC WD3200JD-00KLB0", "WD-WCAMR1130137", ATA_HORKAGE_BROKEN_HPA },
4191 { "WDC WD2500JD-00HBB0", "WD-WMAL71490727", ATA_HORKAGE_BROKEN_HPA },
4192 { "MAXTOR 6L080L4", "A93.0500", ATA_HORKAGE_BROKEN_HPA },
4194 /* this one allows HPA unlocking but fails IOs on the area */
4195 { "OCZ-VERTEX", "1.30", ATA_HORKAGE_BROKEN_HPA },
4197 /* Devices which report 1 sector over size HPA */
4198 { "ST340823A", NULL, ATA_HORKAGE_HPA_SIZE, },
4199 { "ST320413A", NULL, ATA_HORKAGE_HPA_SIZE, },
4200 { "ST310211A", NULL, ATA_HORKAGE_HPA_SIZE, },
4202 /* Devices which get the IVB wrong */
4203 { "QUANTUM FIREBALLlct10 05", "A03.0900", ATA_HORKAGE_IVB, },
4204 /* Maybe we should just blacklist TSSTcorp... */
4205 { "TSSTcorp CDDVDW SH-S202[HJN]", "SB0[01]", ATA_HORKAGE_IVB, },
4207 /* Devices that do not need bridging limits applied */
4208 { "MTRON MSP-SATA*", NULL, ATA_HORKAGE_BRIDGE_OK, },
4209 { "BUFFALO HD-QSU2/R5", NULL, ATA_HORKAGE_BRIDGE_OK, },
4211 /* Devices which aren't very happy with higher link speeds */
4212 { "WD My Book", NULL, ATA_HORKAGE_1_5_GBPS, },
4213 { "Seagate FreeAgent GoFlex", NULL, ATA_HORKAGE_1_5_GBPS, },
4216 * Devices which choke on SETXFER. Applies only if both the
4217 * device and controller are SATA.
4219 { "PIONEER DVD-RW DVRTD08", NULL, ATA_HORKAGE_NOSETXFER },
4220 { "PIONEER DVD-RW DVRTD08A", NULL, ATA_HORKAGE_NOSETXFER },
4221 { "PIONEER DVD-RW DVR-215", NULL, ATA_HORKAGE_NOSETXFER },
4222 { "PIONEER DVD-RW DVR-212D", NULL, ATA_HORKAGE_NOSETXFER },
4223 { "PIONEER DVD-RW DVR-216D", NULL, ATA_HORKAGE_NOSETXFER },
4225 /* devices that don't properly handle queued TRIM commands */
4226 { "Micron_M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM, },
4227 { "Crucial_CT???M500SSD1", NULL, ATA_HORKAGE_NO_NCQ_TRIM, },
4230 * Some WD SATA-I drives spin up and down erratically when the link
4231 * is put into the slumber mode. We don't have full list of the
4232 * affected devices. Disable LPM if the device matches one of the
4233 * known prefixes and is SATA-1. As a side effect LPM partial is
4234 * lost too.
4236 * https://bugzilla.kernel.org/show_bug.cgi?id=57211
4238 { "WDC WD800JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4239 { "WDC WD1200JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4240 { "WDC WD1600JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4241 { "WDC WD2000JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4242 { "WDC WD2500JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4243 { "WDC WD3000JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4244 { "WDC WD3200JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4246 /* End Marker */
4251 * glob_match - match a text string against a glob-style pattern
4252 * @text: the string to be examined
4253 * @pattern: the glob-style pattern to be matched against
4255 * Either/both of text and pattern can be empty strings.
4257 * Match text against a glob-style pattern, with wildcards and simple sets:
4259 * ? matches any single character.
4260 * * matches any run of characters.
4261 * [xyz] matches a single character from the set: x, y, or z.
4262 * [a-d] matches a single character from the range: a, b, c, or d.
4263 * [a-d0-9] matches a single character from either range.
4265 * The special characters ?, [, -, or *, can be matched using a set, eg. [*]
4266 * Behaviour with malformed patterns is undefined, though generally reasonable.
4268 * Sample patterns: "SD1?", "SD1[0-5]", "*R0", "SD*1?[012]*xx"
4270 * This function uses one level of recursion per '*' in pattern.
4271 * Since it calls _nothing_ else, and has _no_ explicit local variables,
4272 * this will not cause stack problems for any reasonable use here.
4274 * RETURNS:
4275 * 0 on match, 1 otherwise.
4277 static int glob_match (const char *text, const char *pattern)
4279 do {
4280 /* Match single character or a '?' wildcard */
4281 if (*text == *pattern || *pattern == '?') {
4282 if (!*pattern++)
4283 return 0; /* End of both strings: match */
4284 } else {
4285 /* Match single char against a '[' bracketed ']' pattern set */
4286 if (!*text || *pattern != '[')
4287 break; /* Not a pattern set */
4288 while (*++pattern && *pattern != ']' && *text != *pattern) {
4289 if (*pattern == '-' && *(pattern - 1) != '[')
4290 if (*text > *(pattern - 1) && *text < *(pattern + 1)) {
4291 ++pattern;
4292 break;
4295 if (!*pattern || *pattern == ']')
4296 return 1; /* No match */
4297 while (*pattern && *pattern++ != ']');
4299 } while (*++text && *pattern);
4301 /* Match any run of chars against a '*' wildcard */
4302 if (*pattern == '*') {
4303 if (!*++pattern)
4304 return 0; /* Match: avoid recursion at end of pattern */
4305 /* Loop to handle additional pattern chars after the wildcard */
4306 while (*text) {
4307 if (glob_match(text, pattern) == 0)
4308 return 0; /* Remainder matched */
4309 ++text; /* Absorb (match) this char and try again */
4312 if (!*text && !*pattern)
4313 return 0; /* End of both strings: match */
4314 return 1; /* No match */
4317 static unsigned long ata_dev_blacklisted(const struct ata_device *dev)
4319 unsigned char model_num[ATA_ID_PROD_LEN + 1];
4320 unsigned char model_rev[ATA_ID_FW_REV_LEN + 1];
4321 const struct ata_blacklist_entry *ad = ata_device_blacklist;
4323 ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
4324 ata_id_c_string(dev->id, model_rev, ATA_ID_FW_REV, sizeof(model_rev));
4326 while (ad->model_num) {
4327 if (!glob_match(model_num, ad->model_num)) {
4328 if (ad->model_rev == NULL)
4329 return ad->horkage;
4330 if (!glob_match(model_rev, ad->model_rev))
4331 return ad->horkage;
4333 ad++;
4335 return 0;
4338 static int ata_dma_blacklisted(const struct ata_device *dev)
4340 /* We don't support polling DMA.
4341 * DMA blacklist those ATAPI devices with CDB-intr (and use PIO)
4342 * if the LLDD handles only interrupts in the HSM_ST_LAST state.
4344 if ((dev->link->ap->flags & ATA_FLAG_PIO_POLLING) &&
4345 (dev->flags & ATA_DFLAG_CDB_INTR))
4346 return 1;
4347 return (dev->horkage & ATA_HORKAGE_NODMA) ? 1 : 0;
4351 * ata_is_40wire - check drive side detection
4352 * @dev: device
4354 * Perform drive side detection decoding, allowing for device vendors
4355 * who can't follow the documentation.
4358 static int ata_is_40wire(struct ata_device *dev)
4360 if (dev->horkage & ATA_HORKAGE_IVB)
4361 return ata_drive_40wire_relaxed(dev->id);
4362 return ata_drive_40wire(dev->id);
4366 * cable_is_40wire - 40/80/SATA decider
4367 * @ap: port to consider
4369 * This function encapsulates the policy for speed management
4370 * in one place. At the moment we don't cache the result but
4371 * there is a good case for setting ap->cbl to the result when
4372 * we are called with unknown cables (and figuring out if it
4373 * impacts hotplug at all).
4375 * Return 1 if the cable appears to be 40 wire.
4378 static int cable_is_40wire(struct ata_port *ap)
4380 struct ata_link *link;
4381 struct ata_device *dev;
4383 /* If the controller thinks we are 40 wire, we are. */
4384 if (ap->cbl == ATA_CBL_PATA40)
4385 return 1;
4387 /* If the controller thinks we are 80 wire, we are. */
4388 if (ap->cbl == ATA_CBL_PATA80 || ap->cbl == ATA_CBL_SATA)
4389 return 0;
4391 /* If the system is known to be 40 wire short cable (eg
4392 * laptop), then we allow 80 wire modes even if the drive
4393 * isn't sure.
4395 if (ap->cbl == ATA_CBL_PATA40_SHORT)
4396 return 0;
4398 /* If the controller doesn't know, we scan.
4400 * Note: We look for all 40 wire detects at this point. Any
4401 * 80 wire detect is taken to be 80 wire cable because
4402 * - in many setups only the one drive (slave if present) will
4403 * give a valid detect
4404 * - if you have a non detect capable drive you don't want it
4405 * to colour the choice
4407 ata_for_each_link(link, ap, EDGE) {
4408 ata_for_each_dev(dev, link, ENABLED) {
4409 if (!ata_is_40wire(dev))
4410 return 0;
4413 return 1;
4417 * ata_dev_xfermask - Compute supported xfermask of the given device
4418 * @dev: Device to compute xfermask for
4420 * Compute supported xfermask of @dev and store it in
4421 * dev->*_mask. This function is responsible for applying all
4422 * known limits including host controller limits, device
4423 * blacklist, etc...
4425 * LOCKING:
4426 * None.
4428 static void ata_dev_xfermask(struct ata_device *dev)
4430 struct ata_link *link = dev->link;
4431 struct ata_port *ap = link->ap;
4432 struct ata_host *host = ap->host;
4433 unsigned long xfer_mask;
4435 /* controller modes available */
4436 xfer_mask = ata_pack_xfermask(ap->pio_mask,
4437 ap->mwdma_mask, ap->udma_mask);
4439 /* drive modes available */
4440 xfer_mask &= ata_pack_xfermask(dev->pio_mask,
4441 dev->mwdma_mask, dev->udma_mask);
4442 xfer_mask &= ata_id_xfermask(dev->id);
4445 * CFA Advanced TrueIDE timings are not allowed on a shared
4446 * cable
4448 if (ata_dev_pair(dev)) {
4449 /* No PIO5 or PIO6 */
4450 xfer_mask &= ~(0x03 << (ATA_SHIFT_PIO + 5));
4451 /* No MWDMA3 or MWDMA 4 */
4452 xfer_mask &= ~(0x03 << (ATA_SHIFT_MWDMA + 3));
4455 if (ata_dma_blacklisted(dev)) {
4456 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
4457 ata_dev_warn(dev,
4458 "device is on DMA blacklist, disabling DMA\n");
4461 if ((host->flags & ATA_HOST_SIMPLEX) &&
4462 host->simplex_claimed && host->simplex_claimed != ap) {
4463 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
4464 ata_dev_warn(dev,
4465 "simplex DMA is claimed by other device, disabling DMA\n");
4468 if (ap->flags & ATA_FLAG_NO_IORDY)
4469 xfer_mask &= ata_pio_mask_no_iordy(dev);
4471 if (ap->ops->mode_filter)
4472 xfer_mask = ap->ops->mode_filter(dev, xfer_mask);
4474 /* Apply cable rule here. Don't apply it early because when
4475 * we handle hot plug the cable type can itself change.
4476 * Check this last so that we know if the transfer rate was
4477 * solely limited by the cable.
4478 * Unknown or 80 wire cables reported host side are checked
4479 * drive side as well. Cases where we know a 40wire cable
4480 * is used safely for 80 are not checked here.
4482 if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
4483 /* UDMA/44 or higher would be available */
4484 if (cable_is_40wire(ap)) {
4485 ata_dev_warn(dev,
4486 "limited to UDMA/33 due to 40-wire cable\n");
4487 xfer_mask &= ~(0xF8 << ATA_SHIFT_UDMA);
4490 ata_unpack_xfermask(xfer_mask, &dev->pio_mask,
4491 &dev->mwdma_mask, &dev->udma_mask);
4495 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
4496 * @dev: Device to which command will be sent
4498 * Issue SET FEATURES - XFER MODE command to device @dev
4499 * on port @ap.
4501 * LOCKING:
4502 * PCI/etc. bus probe sem.
4504 * RETURNS:
4505 * 0 on success, AC_ERR_* mask otherwise.
4508 static unsigned int ata_dev_set_xfermode(struct ata_device *dev)
4510 struct ata_taskfile tf;
4511 unsigned int err_mask;
4513 /* set up set-features taskfile */
4514 DPRINTK("set features - xfer mode\n");
4516 /* Some controllers and ATAPI devices show flaky interrupt
4517 * behavior after setting xfer mode. Use polling instead.
4519 ata_tf_init(dev, &tf);
4520 tf.command = ATA_CMD_SET_FEATURES;
4521 tf.feature = SETFEATURES_XFER;
4522 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_POLLING;
4523 tf.protocol = ATA_PROT_NODATA;
4524 /* If we are using IORDY we must send the mode setting command */
4525 if (ata_pio_need_iordy(dev))
4526 tf.nsect = dev->xfer_mode;
4527 /* If the device has IORDY and the controller does not - turn it off */
4528 else if (ata_id_has_iordy(dev->id))
4529 tf.nsect = 0x01;
4530 else /* In the ancient relic department - skip all of this */
4531 return 0;
4533 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4535 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4536 return err_mask;
4540 * ata_dev_set_feature - Issue SET FEATURES - SATA FEATURES
4541 * @dev: Device to which command will be sent
4542 * @enable: Whether to enable or disable the feature
4543 * @feature: The sector count represents the feature to set
4545 * Issue SET FEATURES - SATA FEATURES command to device @dev
4546 * on port @ap with sector count
4548 * LOCKING:
4549 * PCI/etc. bus probe sem.
4551 * RETURNS:
4552 * 0 on success, AC_ERR_* mask otherwise.
4554 unsigned int ata_dev_set_feature(struct ata_device *dev, u8 enable, u8 feature)
4556 struct ata_taskfile tf;
4557 unsigned int err_mask;
4559 /* set up set-features taskfile */
4560 DPRINTK("set features - SATA features\n");
4562 ata_tf_init(dev, &tf);
4563 tf.command = ATA_CMD_SET_FEATURES;
4564 tf.feature = enable;
4565 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4566 tf.protocol = ATA_PROT_NODATA;
4567 tf.nsect = feature;
4569 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4571 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4572 return err_mask;
4574 EXPORT_SYMBOL_GPL(ata_dev_set_feature);
4577 * ata_dev_init_params - Issue INIT DEV PARAMS command
4578 * @dev: Device to which command will be sent
4579 * @heads: Number of heads (taskfile parameter)
4580 * @sectors: Number of sectors (taskfile parameter)
4582 * LOCKING:
4583 * Kernel thread context (may sleep)
4585 * RETURNS:
4586 * 0 on success, AC_ERR_* mask otherwise.
4588 static unsigned int ata_dev_init_params(struct ata_device *dev,
4589 u16 heads, u16 sectors)
4591 struct ata_taskfile tf;
4592 unsigned int err_mask;
4594 /* Number of sectors per track 1-255. Number of heads 1-16 */
4595 if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
4596 return AC_ERR_INVALID;
4598 /* set up init dev params taskfile */
4599 DPRINTK("init dev params \n");
4601 ata_tf_init(dev, &tf);
4602 tf.command = ATA_CMD_INIT_DEV_PARAMS;
4603 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4604 tf.protocol = ATA_PROT_NODATA;
4605 tf.nsect = sectors;
4606 tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
4608 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4609 /* A clean abort indicates an original or just out of spec drive
4610 and we should continue as we issue the setup based on the
4611 drive reported working geometry */
4612 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
4613 err_mask = 0;
4615 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4616 return err_mask;
4620 * ata_sg_clean - Unmap DMA memory associated with command
4621 * @qc: Command containing DMA memory to be released
4623 * Unmap all mapped DMA memory associated with this command.
4625 * LOCKING:
4626 * spin_lock_irqsave(host lock)
4628 void ata_sg_clean(struct ata_queued_cmd *qc)
4630 struct ata_port *ap = qc->ap;
4631 struct scatterlist *sg = qc->sg;
4632 int dir = qc->dma_dir;
4634 WARN_ON_ONCE(sg == NULL);
4636 VPRINTK("unmapping %u sg elements\n", qc->n_elem);
4638 if (qc->n_elem)
4639 dma_unmap_sg(ap->dev, sg, qc->orig_n_elem, dir);
4641 qc->flags &= ~ATA_QCFLAG_DMAMAP;
4642 qc->sg = NULL;
4646 * atapi_check_dma - Check whether ATAPI DMA can be supported
4647 * @qc: Metadata associated with taskfile to check
4649 * Allow low-level driver to filter ATA PACKET commands, returning
4650 * a status indicating whether or not it is OK to use DMA for the
4651 * supplied PACKET command.
4653 * LOCKING:
4654 * spin_lock_irqsave(host lock)
4656 * RETURNS: 0 when ATAPI DMA can be used
4657 * nonzero otherwise
4659 int atapi_check_dma(struct ata_queued_cmd *qc)
4661 struct ata_port *ap = qc->ap;
4663 /* Don't allow DMA if it isn't multiple of 16 bytes. Quite a
4664 * few ATAPI devices choke on such DMA requests.
4666 if (!(qc->dev->horkage & ATA_HORKAGE_ATAPI_MOD16_DMA) &&
4667 unlikely(qc->nbytes & 15))
4668 return 1;
4670 if (ap->ops->check_atapi_dma)
4671 return ap->ops->check_atapi_dma(qc);
4673 return 0;
4677 * ata_std_qc_defer - Check whether a qc needs to be deferred
4678 * @qc: ATA command in question
4680 * Non-NCQ commands cannot run with any other command, NCQ or
4681 * not. As upper layer only knows the queue depth, we are
4682 * responsible for maintaining exclusion. This function checks
4683 * whether a new command @qc can be issued.
4685 * LOCKING:
4686 * spin_lock_irqsave(host lock)
4688 * RETURNS:
4689 * ATA_DEFER_* if deferring is needed, 0 otherwise.
4691 int ata_std_qc_defer(struct ata_queued_cmd *qc)
4693 struct ata_link *link = qc->dev->link;
4695 if (qc->tf.protocol == ATA_PROT_NCQ) {
4696 if (!ata_tag_valid(link->active_tag))
4697 return 0;
4698 } else {
4699 if (!ata_tag_valid(link->active_tag) && !link->sactive)
4700 return 0;
4703 return ATA_DEFER_LINK;
4706 void ata_noop_qc_prep(struct ata_queued_cmd *qc) { }
4709 * ata_sg_init - Associate command with scatter-gather table.
4710 * @qc: Command to be associated
4711 * @sg: Scatter-gather table.
4712 * @n_elem: Number of elements in s/g table.
4714 * Initialize the data-related elements of queued_cmd @qc
4715 * to point to a scatter-gather table @sg, containing @n_elem
4716 * elements.
4718 * LOCKING:
4719 * spin_lock_irqsave(host lock)
4721 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
4722 unsigned int n_elem)
4724 qc->sg = sg;
4725 qc->n_elem = n_elem;
4726 qc->cursg = qc->sg;
4730 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
4731 * @qc: Command with scatter-gather table to be mapped.
4733 * DMA-map the scatter-gather table associated with queued_cmd @qc.
4735 * LOCKING:
4736 * spin_lock_irqsave(host lock)
4738 * RETURNS:
4739 * Zero on success, negative on error.
4742 static int ata_sg_setup(struct ata_queued_cmd *qc)
4744 struct ata_port *ap = qc->ap;
4745 unsigned int n_elem;
4747 VPRINTK("ENTER, ata%u\n", ap->print_id);
4749 n_elem = dma_map_sg(ap->dev, qc->sg, qc->n_elem, qc->dma_dir);
4750 if (n_elem < 1)
4751 return -1;
4753 DPRINTK("%d sg elements mapped\n", n_elem);
4754 qc->orig_n_elem = qc->n_elem;
4755 qc->n_elem = n_elem;
4756 qc->flags |= ATA_QCFLAG_DMAMAP;
4758 return 0;
4762 * swap_buf_le16 - swap halves of 16-bit words in place
4763 * @buf: Buffer to swap
4764 * @buf_words: Number of 16-bit words in buffer.
4766 * Swap halves of 16-bit words if needed to convert from
4767 * little-endian byte order to native cpu byte order, or
4768 * vice-versa.
4770 * LOCKING:
4771 * Inherited from caller.
4773 void swap_buf_le16(u16 *buf, unsigned int buf_words)
4775 #ifdef __BIG_ENDIAN
4776 unsigned int i;
4778 for (i = 0; i < buf_words; i++)
4779 buf[i] = le16_to_cpu(buf[i]);
4780 #endif /* __BIG_ENDIAN */
4784 * ata_qc_new - Request an available ATA command, for queueing
4785 * @ap: target port
4787 * LOCKING:
4788 * None.
4791 static struct ata_queued_cmd *ata_qc_new(struct ata_port *ap)
4793 struct ata_queued_cmd *qc = NULL;
4794 unsigned int i;
4796 /* no command while frozen */
4797 if (unlikely(ap->pflags & ATA_PFLAG_FROZEN))
4798 return NULL;
4800 /* the last tag is reserved for internal command. */
4801 for (i = 0; i < ATA_MAX_QUEUE - 1; i++)
4802 if (!test_and_set_bit(i, &ap->qc_allocated)) {
4803 qc = __ata_qc_from_tag(ap, i);
4804 break;
4807 if (qc)
4808 qc->tag = i;
4810 return qc;
4814 * ata_qc_new_init - Request an available ATA command, and initialize it
4815 * @dev: Device from whom we request an available command structure
4817 * LOCKING:
4818 * None.
4821 struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev)
4823 struct ata_port *ap = dev->link->ap;
4824 struct ata_queued_cmd *qc;
4826 qc = ata_qc_new(ap);
4827 if (qc) {
4828 qc->scsicmd = NULL;
4829 qc->ap = ap;
4830 qc->dev = dev;
4832 ata_qc_reinit(qc);
4835 return qc;
4839 * ata_qc_free - free unused ata_queued_cmd
4840 * @qc: Command to complete
4842 * Designed to free unused ata_queued_cmd object
4843 * in case something prevents using it.
4845 * LOCKING:
4846 * spin_lock_irqsave(host lock)
4848 void ata_qc_free(struct ata_queued_cmd *qc)
4850 struct ata_port *ap;
4851 unsigned int tag;
4853 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
4854 ap = qc->ap;
4856 qc->flags = 0;
4857 tag = qc->tag;
4858 if (likely(ata_tag_valid(tag))) {
4859 qc->tag = ATA_TAG_POISON;
4860 clear_bit(tag, &ap->qc_allocated);
4864 void __ata_qc_complete(struct ata_queued_cmd *qc)
4866 struct ata_port *ap;
4867 struct ata_link *link;
4869 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
4870 WARN_ON_ONCE(!(qc->flags & ATA_QCFLAG_ACTIVE));
4871 ap = qc->ap;
4872 link = qc->dev->link;
4874 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
4875 ata_sg_clean(qc);
4877 /* command should be marked inactive atomically with qc completion */
4878 if (qc->tf.protocol == ATA_PROT_NCQ) {
4879 link->sactive &= ~(1 << qc->tag);
4880 if (!link->sactive)
4881 ap->nr_active_links--;
4882 } else {
4883 link->active_tag = ATA_TAG_POISON;
4884 ap->nr_active_links--;
4887 /* clear exclusive status */
4888 if (unlikely(qc->flags & ATA_QCFLAG_CLEAR_EXCL &&
4889 ap->excl_link == link))
4890 ap->excl_link = NULL;
4892 /* atapi: mark qc as inactive to prevent the interrupt handler
4893 * from completing the command twice later, before the error handler
4894 * is called. (when rc != 0 and atapi request sense is needed)
4896 qc->flags &= ~ATA_QCFLAG_ACTIVE;
4897 ap->qc_active &= ~(1 << qc->tag);
4899 /* call completion callback */
4900 qc->complete_fn(qc);
4903 static void fill_result_tf(struct ata_queued_cmd *qc)
4905 struct ata_port *ap = qc->ap;
4907 qc->result_tf.flags = qc->tf.flags;
4908 ap->ops->qc_fill_rtf(qc);
4911 static void ata_verify_xfer(struct ata_queued_cmd *qc)
4913 struct ata_device *dev = qc->dev;
4915 if (ata_is_nodata(qc->tf.protocol))
4916 return;
4918 if ((dev->mwdma_mask || dev->udma_mask) && ata_is_pio(qc->tf.protocol))
4919 return;
4921 dev->flags &= ~ATA_DFLAG_DUBIOUS_XFER;
4925 * ata_qc_complete - Complete an active ATA command
4926 * @qc: Command to complete
4928 * Indicate to the mid and upper layers that an ATA command has
4929 * completed, with either an ok or not-ok status.
4931 * Refrain from calling this function multiple times when
4932 * successfully completing multiple NCQ commands.
4933 * ata_qc_complete_multiple() should be used instead, which will
4934 * properly update IRQ expect state.
4936 * LOCKING:
4937 * spin_lock_irqsave(host lock)
4939 void ata_qc_complete(struct ata_queued_cmd *qc)
4941 struct ata_port *ap = qc->ap;
4943 /* XXX: New EH and old EH use different mechanisms to
4944 * synchronize EH with regular execution path.
4946 * In new EH, a failed qc is marked with ATA_QCFLAG_FAILED.
4947 * Normal execution path is responsible for not accessing a
4948 * failed qc. libata core enforces the rule by returning NULL
4949 * from ata_qc_from_tag() for failed qcs.
4951 * Old EH depends on ata_qc_complete() nullifying completion
4952 * requests if ATA_QCFLAG_EH_SCHEDULED is set. Old EH does
4953 * not synchronize with interrupt handler. Only PIO task is
4954 * taken care of.
4956 if (ap->ops->error_handler) {
4957 struct ata_device *dev = qc->dev;
4958 struct ata_eh_info *ehi = &dev->link->eh_info;
4960 if (unlikely(qc->err_mask))
4961 qc->flags |= ATA_QCFLAG_FAILED;
4964 * Finish internal commands without any further processing
4965 * and always with the result TF filled.
4967 if (unlikely(ata_tag_internal(qc->tag))) {
4968 fill_result_tf(qc);
4969 __ata_qc_complete(qc);
4970 return;
4974 * Non-internal qc has failed. Fill the result TF and
4975 * summon EH.
4977 if (unlikely(qc->flags & ATA_QCFLAG_FAILED)) {
4978 fill_result_tf(qc);
4979 ata_qc_schedule_eh(qc);
4980 return;
4983 WARN_ON_ONCE(ap->pflags & ATA_PFLAG_FROZEN);
4985 /* read result TF if requested */
4986 if (qc->flags & ATA_QCFLAG_RESULT_TF)
4987 fill_result_tf(qc);
4989 /* Some commands need post-processing after successful
4990 * completion.
4992 switch (qc->tf.command) {
4993 case ATA_CMD_SET_FEATURES:
4994 if (qc->tf.feature != SETFEATURES_WC_ON &&
4995 qc->tf.feature != SETFEATURES_WC_OFF)
4996 break;
4997 /* fall through */
4998 case ATA_CMD_INIT_DEV_PARAMS: /* CHS translation changed */
4999 case ATA_CMD_SET_MULTI: /* multi_count changed */
5000 /* revalidate device */
5001 ehi->dev_action[dev->devno] |= ATA_EH_REVALIDATE;
5002 ata_port_schedule_eh(ap);
5003 break;
5005 case ATA_CMD_SLEEP:
5006 dev->flags |= ATA_DFLAG_SLEEPING;
5007 break;
5010 if (unlikely(dev->flags & ATA_DFLAG_DUBIOUS_XFER))
5011 ata_verify_xfer(qc);
5013 __ata_qc_complete(qc);
5014 } else {
5015 if (qc->flags & ATA_QCFLAG_EH_SCHEDULED)
5016 return;
5018 /* read result TF if failed or requested */
5019 if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
5020 fill_result_tf(qc);
5022 __ata_qc_complete(qc);
5027 * ata_qc_complete_multiple - Complete multiple qcs successfully
5028 * @ap: port in question
5029 * @qc_active: new qc_active mask
5031 * Complete in-flight commands. This functions is meant to be
5032 * called from low-level driver's interrupt routine to complete
5033 * requests normally. ap->qc_active and @qc_active is compared
5034 * and commands are completed accordingly.
5036 * Always use this function when completing multiple NCQ commands
5037 * from IRQ handlers instead of calling ata_qc_complete()
5038 * multiple times to keep IRQ expect status properly in sync.
5040 * LOCKING:
5041 * spin_lock_irqsave(host lock)
5043 * RETURNS:
5044 * Number of completed commands on success, -errno otherwise.
5046 int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active)
5048 int nr_done = 0;
5049 u32 done_mask;
5051 done_mask = ap->qc_active ^ qc_active;
5053 if (unlikely(done_mask & qc_active)) {
5054 ata_port_err(ap, "illegal qc_active transition (%08x->%08x)\n",
5055 ap->qc_active, qc_active);
5056 return -EINVAL;
5059 while (done_mask) {
5060 struct ata_queued_cmd *qc;
5061 unsigned int tag = __ffs(done_mask);
5063 qc = ata_qc_from_tag(ap, tag);
5064 if (qc) {
5065 ata_qc_complete(qc);
5066 nr_done++;
5068 done_mask &= ~(1 << tag);
5071 return nr_done;
5075 * ata_qc_issue - issue taskfile to device
5076 * @qc: command to issue to device
5078 * Prepare an ATA command to submission to device.
5079 * This includes mapping the data into a DMA-able
5080 * area, filling in the S/G table, and finally
5081 * writing the taskfile to hardware, starting the command.
5083 * LOCKING:
5084 * spin_lock_irqsave(host lock)
5086 void ata_qc_issue(struct ata_queued_cmd *qc)
5088 struct ata_port *ap = qc->ap;
5089 struct ata_link *link = qc->dev->link;
5090 u8 prot = qc->tf.protocol;
5092 /* Make sure only one non-NCQ command is outstanding. The
5093 * check is skipped for old EH because it reuses active qc to
5094 * request ATAPI sense.
5096 WARN_ON_ONCE(ap->ops->error_handler && ata_tag_valid(link->active_tag));
5098 if (ata_is_ncq(prot)) {
5099 WARN_ON_ONCE(link->sactive & (1 << qc->tag));
5101 if (!link->sactive)
5102 ap->nr_active_links++;
5103 link->sactive |= 1 << qc->tag;
5104 } else {
5105 WARN_ON_ONCE(link->sactive);
5107 ap->nr_active_links++;
5108 link->active_tag = qc->tag;
5111 qc->flags |= ATA_QCFLAG_ACTIVE;
5112 ap->qc_active |= 1 << qc->tag;
5115 * We guarantee to LLDs that they will have at least one
5116 * non-zero sg if the command is a data command.
5118 if (WARN_ON_ONCE(ata_is_data(prot) &&
5119 (!qc->sg || !qc->n_elem || !qc->nbytes)))
5120 goto sys_err;
5122 if (ata_is_dma(prot) || (ata_is_pio(prot) &&
5123 (ap->flags & ATA_FLAG_PIO_DMA)))
5124 if (ata_sg_setup(qc))
5125 goto sys_err;
5127 /* if device is sleeping, schedule reset and abort the link */
5128 if (unlikely(qc->dev->flags & ATA_DFLAG_SLEEPING)) {
5129 link->eh_info.action |= ATA_EH_RESET;
5130 ata_ehi_push_desc(&link->eh_info, "waking up from sleep");
5131 ata_link_abort(link);
5132 return;
5135 ap->ops->qc_prep(qc);
5137 qc->err_mask |= ap->ops->qc_issue(qc);
5138 if (unlikely(qc->err_mask))
5139 goto err;
5140 return;
5142 sys_err:
5143 qc->err_mask |= AC_ERR_SYSTEM;
5144 err:
5145 ata_qc_complete(qc);
5149 * sata_scr_valid - test whether SCRs are accessible
5150 * @link: ATA link to test SCR accessibility for
5152 * Test whether SCRs are accessible for @link.
5154 * LOCKING:
5155 * None.
5157 * RETURNS:
5158 * 1 if SCRs are accessible, 0 otherwise.
5160 int sata_scr_valid(struct ata_link *link)
5162 struct ata_port *ap = link->ap;
5164 return (ap->flags & ATA_FLAG_SATA) && ap->ops->scr_read;
5168 * sata_scr_read - read SCR register of the specified port
5169 * @link: ATA link to read SCR for
5170 * @reg: SCR to read
5171 * @val: Place to store read value
5173 * Read SCR register @reg of @link into *@val. This function is
5174 * guaranteed to succeed if @link is ap->link, the cable type of
5175 * the port is SATA and the port implements ->scr_read.
5177 * LOCKING:
5178 * None if @link is ap->link. Kernel thread context otherwise.
5180 * RETURNS:
5181 * 0 on success, negative errno on failure.
5183 int sata_scr_read(struct ata_link *link, int reg, u32 *val)
5185 if (ata_is_host_link(link)) {
5186 if (sata_scr_valid(link))
5187 return link->ap->ops->scr_read(link, reg, val);
5188 return -EOPNOTSUPP;
5191 return sata_pmp_scr_read(link, reg, val);
5195 * sata_scr_write - write SCR register of the specified port
5196 * @link: ATA link to write SCR for
5197 * @reg: SCR to write
5198 * @val: value to write
5200 * Write @val to SCR register @reg of @link. This function is
5201 * guaranteed to succeed if @link is ap->link, the cable type of
5202 * the port is SATA and the port implements ->scr_read.
5204 * LOCKING:
5205 * None if @link is ap->link. Kernel thread context otherwise.
5207 * RETURNS:
5208 * 0 on success, negative errno on failure.
5210 int sata_scr_write(struct ata_link *link, int reg, u32 val)
5212 if (ata_is_host_link(link)) {
5213 if (sata_scr_valid(link))
5214 return link->ap->ops->scr_write(link, reg, val);
5215 return -EOPNOTSUPP;
5218 return sata_pmp_scr_write(link, reg, val);
5222 * sata_scr_write_flush - write SCR register of the specified port and flush
5223 * @link: ATA link to write SCR for
5224 * @reg: SCR to write
5225 * @val: value to write
5227 * This function is identical to sata_scr_write() except that this
5228 * function performs flush after writing to the register.
5230 * LOCKING:
5231 * None if @link is ap->link. Kernel thread context otherwise.
5233 * RETURNS:
5234 * 0 on success, negative errno on failure.
5236 int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
5238 if (ata_is_host_link(link)) {
5239 int rc;
5241 if (sata_scr_valid(link)) {
5242 rc = link->ap->ops->scr_write(link, reg, val);
5243 if (rc == 0)
5244 rc = link->ap->ops->scr_read(link, reg, &val);
5245 return rc;
5247 return -EOPNOTSUPP;
5250 return sata_pmp_scr_write(link, reg, val);
5254 * ata_phys_link_online - test whether the given link is online
5255 * @link: ATA link to test
5257 * Test whether @link is online. Note that this function returns
5258 * 0 if online status of @link cannot be obtained, so
5259 * ata_link_online(link) != !ata_link_offline(link).
5261 * LOCKING:
5262 * None.
5264 * RETURNS:
5265 * True if the port online status is available and online.
5267 bool ata_phys_link_online(struct ata_link *link)
5269 u32 sstatus;
5271 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
5272 ata_sstatus_online(sstatus))
5273 return true;
5274 return false;
5278 * ata_phys_link_offline - test whether the given link is offline
5279 * @link: ATA link to test
5281 * Test whether @link is offline. Note that this function
5282 * returns 0 if offline status of @link cannot be obtained, so
5283 * ata_link_online(link) != !ata_link_offline(link).
5285 * LOCKING:
5286 * None.
5288 * RETURNS:
5289 * True if the port offline status is available and offline.
5291 bool ata_phys_link_offline(struct ata_link *link)
5293 u32 sstatus;
5295 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
5296 !ata_sstatus_online(sstatus))
5297 return true;
5298 return false;
5302 * ata_link_online - test whether the given link is online
5303 * @link: ATA link to test
5305 * Test whether @link is online. This is identical to
5306 * ata_phys_link_online() when there's no slave link. When
5307 * there's a slave link, this function should only be called on
5308 * the master link and will return true if any of M/S links is
5309 * online.
5311 * LOCKING:
5312 * None.
5314 * RETURNS:
5315 * True if the port online status is available and online.
5317 bool ata_link_online(struct ata_link *link)
5319 struct ata_link *slave = link->ap->slave_link;
5321 WARN_ON(link == slave); /* shouldn't be called on slave link */
5323 return ata_phys_link_online(link) ||
5324 (slave && ata_phys_link_online(slave));
5328 * ata_link_offline - test whether the given link is offline
5329 * @link: ATA link to test
5331 * Test whether @link is offline. This is identical to
5332 * ata_phys_link_offline() when there's no slave link. When
5333 * there's a slave link, this function should only be called on
5334 * the master link and will return true if both M/S links are
5335 * offline.
5337 * LOCKING:
5338 * None.
5340 * RETURNS:
5341 * True if the port offline status is available and offline.
5343 bool ata_link_offline(struct ata_link *link)
5345 struct ata_link *slave = link->ap->slave_link;
5347 WARN_ON(link == slave); /* shouldn't be called on slave link */
5349 return ata_phys_link_offline(link) &&
5350 (!slave || ata_phys_link_offline(slave));
5353 #ifdef CONFIG_PM
5354 static int ata_port_request_pm(struct ata_port *ap, pm_message_t mesg,
5355 unsigned int action, unsigned int ehi_flags,
5356 int *async)
5358 struct ata_link *link;
5359 unsigned long flags;
5360 int rc = 0;
5362 /* Previous resume operation might still be in
5363 * progress. Wait for PM_PENDING to clear.
5365 if (ap->pflags & ATA_PFLAG_PM_PENDING) {
5366 if (async) {
5367 *async = -EAGAIN;
5368 return 0;
5370 ata_port_wait_eh(ap);
5371 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5374 /* request PM ops to EH */
5375 spin_lock_irqsave(ap->lock, flags);
5377 ap->pm_mesg = mesg;
5378 if (async)
5379 ap->pm_result = async;
5380 else
5381 ap->pm_result = &rc;
5383 ap->pflags |= ATA_PFLAG_PM_PENDING;
5384 ata_for_each_link(link, ap, HOST_FIRST) {
5385 link->eh_info.action |= action;
5386 link->eh_info.flags |= ehi_flags;
5389 ata_port_schedule_eh(ap);
5391 spin_unlock_irqrestore(ap->lock, flags);
5393 /* wait and check result */
5394 if (!async) {
5395 ata_port_wait_eh(ap);
5396 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5399 return rc;
5402 static int __ata_port_suspend_common(struct ata_port *ap, pm_message_t mesg, int *async)
5405 * On some hardware, device fails to respond after spun down
5406 * for suspend. As the device won't be used before being
5407 * resumed, we don't need to touch the device. Ask EH to skip
5408 * the usual stuff and proceed directly to suspend.
5410 * http://thread.gmane.org/gmane.linux.ide/46764
5412 unsigned int ehi_flags = ATA_EHI_QUIET | ATA_EHI_NO_AUTOPSY |
5413 ATA_EHI_NO_RECOVERY;
5414 return ata_port_request_pm(ap, mesg, 0, ehi_flags, async);
5417 static int ata_port_suspend_common(struct device *dev, pm_message_t mesg)
5419 struct ata_port *ap = to_ata_port(dev);
5421 return __ata_port_suspend_common(ap, mesg, NULL);
5424 static int ata_port_suspend(struct device *dev)
5426 if (pm_runtime_suspended(dev))
5427 return 0;
5429 return ata_port_suspend_common(dev, PMSG_SUSPEND);
5432 static int ata_port_do_freeze(struct device *dev)
5434 if (pm_runtime_suspended(dev))
5435 return 0;
5437 return ata_port_suspend_common(dev, PMSG_FREEZE);
5440 static int ata_port_poweroff(struct device *dev)
5442 return ata_port_suspend_common(dev, PMSG_HIBERNATE);
5445 static int __ata_port_resume_common(struct ata_port *ap, pm_message_t mesg,
5446 int *async)
5448 int rc;
5450 rc = ata_port_request_pm(ap, mesg, ATA_EH_RESET,
5451 ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET, async);
5452 return rc;
5455 static int ata_port_resume_common(struct device *dev, pm_message_t mesg)
5457 struct ata_port *ap = to_ata_port(dev);
5459 return __ata_port_resume_common(ap, mesg, NULL);
5462 static int ata_port_resume(struct device *dev)
5464 int rc;
5466 rc = ata_port_resume_common(dev, PMSG_RESUME);
5467 if (!rc) {
5468 pm_runtime_disable(dev);
5469 pm_runtime_set_active(dev);
5470 pm_runtime_enable(dev);
5473 return rc;
5477 * For ODDs, the upper layer will poll for media change every few seconds,
5478 * which will make it enter and leave suspend state every few seconds. And
5479 * as each suspend will cause a hard/soft reset, the gain of runtime suspend
5480 * is very little and the ODD may malfunction after constantly being reset.
5481 * So the idle callback here will not proceed to suspend if a non-ZPODD capable
5482 * ODD is attached to the port.
5484 static int ata_port_runtime_idle(struct device *dev)
5486 struct ata_port *ap = to_ata_port(dev);
5487 struct ata_link *link;
5488 struct ata_device *adev;
5490 ata_for_each_link(link, ap, HOST_FIRST) {
5491 ata_for_each_dev(adev, link, ENABLED)
5492 if (adev->class == ATA_DEV_ATAPI &&
5493 !zpodd_dev_enabled(adev))
5494 return -EBUSY;
5497 return 0;
5500 static int ata_port_runtime_suspend(struct device *dev)
5502 return ata_port_suspend_common(dev, PMSG_AUTO_SUSPEND);
5505 static int ata_port_runtime_resume(struct device *dev)
5507 return ata_port_resume_common(dev, PMSG_AUTO_RESUME);
5510 static const struct dev_pm_ops ata_port_pm_ops = {
5511 .suspend = ata_port_suspend,
5512 .resume = ata_port_resume,
5513 .freeze = ata_port_do_freeze,
5514 .thaw = ata_port_resume,
5515 .poweroff = ata_port_poweroff,
5516 .restore = ata_port_resume,
5518 .runtime_suspend = ata_port_runtime_suspend,
5519 .runtime_resume = ata_port_runtime_resume,
5520 .runtime_idle = ata_port_runtime_idle,
5523 /* sas ports don't participate in pm runtime management of ata_ports,
5524 * and need to resume ata devices at the domain level, not the per-port
5525 * level. sas suspend/resume is async to allow parallel port recovery
5526 * since sas has multiple ata_port instances per Scsi_Host.
5528 int ata_sas_port_async_suspend(struct ata_port *ap, int *async)
5530 return __ata_port_suspend_common(ap, PMSG_SUSPEND, async);
5532 EXPORT_SYMBOL_GPL(ata_sas_port_async_suspend);
5534 int ata_sas_port_async_resume(struct ata_port *ap, int *async)
5536 return __ata_port_resume_common(ap, PMSG_RESUME, async);
5538 EXPORT_SYMBOL_GPL(ata_sas_port_async_resume);
5542 * ata_host_suspend - suspend host
5543 * @host: host to suspend
5544 * @mesg: PM message
5546 * Suspend @host. Actual operation is performed by port suspend.
5548 int ata_host_suspend(struct ata_host *host, pm_message_t mesg)
5550 host->dev->power.power_state = mesg;
5551 return 0;
5555 * ata_host_resume - resume host
5556 * @host: host to resume
5558 * Resume @host. Actual operation is performed by port resume.
5560 void ata_host_resume(struct ata_host *host)
5562 host->dev->power.power_state = PMSG_ON;
5564 #endif
5566 struct device_type ata_port_type = {
5567 .name = "ata_port",
5568 #ifdef CONFIG_PM
5569 .pm = &ata_port_pm_ops,
5570 #endif
5574 * ata_dev_init - Initialize an ata_device structure
5575 * @dev: Device structure to initialize
5577 * Initialize @dev in preparation for probing.
5579 * LOCKING:
5580 * Inherited from caller.
5582 void ata_dev_init(struct ata_device *dev)
5584 struct ata_link *link = ata_dev_phys_link(dev);
5585 struct ata_port *ap = link->ap;
5586 unsigned long flags;
5588 /* SATA spd limit is bound to the attached device, reset together */
5589 link->sata_spd_limit = link->hw_sata_spd_limit;
5590 link->sata_spd = 0;
5592 /* High bits of dev->flags are used to record warm plug
5593 * requests which occur asynchronously. Synchronize using
5594 * host lock.
5596 spin_lock_irqsave(ap->lock, flags);
5597 dev->flags &= ~ATA_DFLAG_INIT_MASK;
5598 dev->horkage = 0;
5599 spin_unlock_irqrestore(ap->lock, flags);
5601 memset((void *)dev + ATA_DEVICE_CLEAR_BEGIN, 0,
5602 ATA_DEVICE_CLEAR_END - ATA_DEVICE_CLEAR_BEGIN);
5603 dev->pio_mask = UINT_MAX;
5604 dev->mwdma_mask = UINT_MAX;
5605 dev->udma_mask = UINT_MAX;
5609 * ata_link_init - Initialize an ata_link structure
5610 * @ap: ATA port link is attached to
5611 * @link: Link structure to initialize
5612 * @pmp: Port multiplier port number
5614 * Initialize @link.
5616 * LOCKING:
5617 * Kernel thread context (may sleep)
5619 void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp)
5621 int i;
5623 /* clear everything except for devices */
5624 memset((void *)link + ATA_LINK_CLEAR_BEGIN, 0,
5625 ATA_LINK_CLEAR_END - ATA_LINK_CLEAR_BEGIN);
5627 link->ap = ap;
5628 link->pmp = pmp;
5629 link->active_tag = ATA_TAG_POISON;
5630 link->hw_sata_spd_limit = UINT_MAX;
5632 /* can't use iterator, ap isn't initialized yet */
5633 for (i = 0; i < ATA_MAX_DEVICES; i++) {
5634 struct ata_device *dev = &link->device[i];
5636 dev->link = link;
5637 dev->devno = dev - link->device;
5638 #ifdef CONFIG_ATA_ACPI
5639 dev->gtf_filter = ata_acpi_gtf_filter;
5640 #endif
5641 ata_dev_init(dev);
5646 * sata_link_init_spd - Initialize link->sata_spd_limit
5647 * @link: Link to configure sata_spd_limit for
5649 * Initialize @link->[hw_]sata_spd_limit to the currently
5650 * configured value.
5652 * LOCKING:
5653 * Kernel thread context (may sleep).
5655 * RETURNS:
5656 * 0 on success, -errno on failure.
5658 int sata_link_init_spd(struct ata_link *link)
5660 u8 spd;
5661 int rc;
5663 rc = sata_scr_read(link, SCR_CONTROL, &link->saved_scontrol);
5664 if (rc)
5665 return rc;
5667 spd = (link->saved_scontrol >> 4) & 0xf;
5668 if (spd)
5669 link->hw_sata_spd_limit &= (1 << spd) - 1;
5671 ata_force_link_limits(link);
5673 link->sata_spd_limit = link->hw_sata_spd_limit;
5675 return 0;
5679 * ata_port_alloc - allocate and initialize basic ATA port resources
5680 * @host: ATA host this allocated port belongs to
5682 * Allocate and initialize basic ATA port resources.
5684 * RETURNS:
5685 * Allocate ATA port on success, NULL on failure.
5687 * LOCKING:
5688 * Inherited from calling layer (may sleep).
5690 struct ata_port *ata_port_alloc(struct ata_host *host)
5692 struct ata_port *ap;
5694 DPRINTK("ENTER\n");
5696 ap = kzalloc(sizeof(*ap), GFP_KERNEL);
5697 if (!ap)
5698 return NULL;
5700 ap->pflags |= ATA_PFLAG_INITIALIZING | ATA_PFLAG_FROZEN;
5701 ap->lock = &host->lock;
5702 ap->print_id = -1;
5703 ap->local_port_no = -1;
5704 ap->host = host;
5705 ap->dev = host->dev;
5707 #if defined(ATA_VERBOSE_DEBUG)
5708 /* turn on all debugging levels */
5709 ap->msg_enable = 0x00FF;
5710 #elif defined(ATA_DEBUG)
5711 ap->msg_enable = ATA_MSG_DRV | ATA_MSG_INFO | ATA_MSG_CTL | ATA_MSG_WARN | ATA_MSG_ERR;
5712 #else
5713 ap->msg_enable = ATA_MSG_DRV | ATA_MSG_ERR | ATA_MSG_WARN;
5714 #endif
5716 mutex_init(&ap->scsi_scan_mutex);
5717 INIT_DELAYED_WORK(&ap->hotplug_task, ata_scsi_hotplug);
5718 INIT_WORK(&ap->scsi_rescan_task, ata_scsi_dev_rescan);
5719 INIT_LIST_HEAD(&ap->eh_done_q);
5720 init_waitqueue_head(&ap->eh_wait_q);
5721 init_completion(&ap->park_req_pending);
5722 init_timer_deferrable(&ap->fastdrain_timer);
5723 ap->fastdrain_timer.function = ata_eh_fastdrain_timerfn;
5724 ap->fastdrain_timer.data = (unsigned long)ap;
5726 ap->cbl = ATA_CBL_NONE;
5728 ata_link_init(ap, &ap->link, 0);
5730 #ifdef ATA_IRQ_TRAP
5731 ap->stats.unhandled_irq = 1;
5732 ap->stats.idle_irq = 1;
5733 #endif
5734 ata_sff_port_init(ap);
5736 return ap;
5739 static void ata_host_release(struct device *gendev, void *res)
5741 struct ata_host *host = dev_get_drvdata(gendev);
5742 int i;
5744 for (i = 0; i < host->n_ports; i++) {
5745 struct ata_port *ap = host->ports[i];
5747 if (!ap)
5748 continue;
5750 if (ap->scsi_host)
5751 scsi_host_put(ap->scsi_host);
5753 kfree(ap->pmp_link);
5754 kfree(ap->slave_link);
5755 kfree(ap);
5756 host->ports[i] = NULL;
5759 dev_set_drvdata(gendev, NULL);
5763 * ata_host_alloc - allocate and init basic ATA host resources
5764 * @dev: generic device this host is associated with
5765 * @max_ports: maximum number of ATA ports associated with this host
5767 * Allocate and initialize basic ATA host resources. LLD calls
5768 * this function to allocate a host, initializes it fully and
5769 * attaches it using ata_host_register().
5771 * @max_ports ports are allocated and host->n_ports is
5772 * initialized to @max_ports. The caller is allowed to decrease
5773 * host->n_ports before calling ata_host_register(). The unused
5774 * ports will be automatically freed on registration.
5776 * RETURNS:
5777 * Allocate ATA host on success, NULL on failure.
5779 * LOCKING:
5780 * Inherited from calling layer (may sleep).
5782 struct ata_host *ata_host_alloc(struct device *dev, int max_ports)
5784 struct ata_host *host;
5785 size_t sz;
5786 int i;
5788 DPRINTK("ENTER\n");
5790 if (!devres_open_group(dev, NULL, GFP_KERNEL))
5791 return NULL;
5793 /* alloc a container for our list of ATA ports (buses) */
5794 sz = sizeof(struct ata_host) + (max_ports + 1) * sizeof(void *);
5795 /* alloc a container for our list of ATA ports (buses) */
5796 host = devres_alloc(ata_host_release, sz, GFP_KERNEL);
5797 if (!host)
5798 goto err_out;
5800 devres_add(dev, host);
5801 dev_set_drvdata(dev, host);
5803 spin_lock_init(&host->lock);
5804 mutex_init(&host->eh_mutex);
5805 host->dev = dev;
5806 host->n_ports = max_ports;
5808 /* allocate ports bound to this host */
5809 for (i = 0; i < max_ports; i++) {
5810 struct ata_port *ap;
5812 ap = ata_port_alloc(host);
5813 if (!ap)
5814 goto err_out;
5816 ap->port_no = i;
5817 host->ports[i] = ap;
5820 devres_remove_group(dev, NULL);
5821 return host;
5823 err_out:
5824 devres_release_group(dev, NULL);
5825 return NULL;
5829 * ata_host_alloc_pinfo - alloc host and init with port_info array
5830 * @dev: generic device this host is associated with
5831 * @ppi: array of ATA port_info to initialize host with
5832 * @n_ports: number of ATA ports attached to this host
5834 * Allocate ATA host and initialize with info from @ppi. If NULL
5835 * terminated, @ppi may contain fewer entries than @n_ports. The
5836 * last entry will be used for the remaining ports.
5838 * RETURNS:
5839 * Allocate ATA host on success, NULL on failure.
5841 * LOCKING:
5842 * Inherited from calling layer (may sleep).
5844 struct ata_host *ata_host_alloc_pinfo(struct device *dev,
5845 const struct ata_port_info * const * ppi,
5846 int n_ports)
5848 const struct ata_port_info *pi;
5849 struct ata_host *host;
5850 int i, j;
5852 host = ata_host_alloc(dev, n_ports);
5853 if (!host)
5854 return NULL;
5856 for (i = 0, j = 0, pi = NULL; i < host->n_ports; i++) {
5857 struct ata_port *ap = host->ports[i];
5859 if (ppi[j])
5860 pi = ppi[j++];
5862 ap->pio_mask = pi->pio_mask;
5863 ap->mwdma_mask = pi->mwdma_mask;
5864 ap->udma_mask = pi->udma_mask;
5865 ap->flags |= pi->flags;
5866 ap->link.flags |= pi->link_flags;
5867 ap->ops = pi->port_ops;
5869 if (!host->ops && (pi->port_ops != &ata_dummy_port_ops))
5870 host->ops = pi->port_ops;
5873 return host;
5877 * ata_slave_link_init - initialize slave link
5878 * @ap: port to initialize slave link for
5880 * Create and initialize slave link for @ap. This enables slave
5881 * link handling on the port.
5883 * In libata, a port contains links and a link contains devices.
5884 * There is single host link but if a PMP is attached to it,
5885 * there can be multiple fan-out links. On SATA, there's usually
5886 * a single device connected to a link but PATA and SATA
5887 * controllers emulating TF based interface can have two - master
5888 * and slave.
5890 * However, there are a few controllers which don't fit into this
5891 * abstraction too well - SATA controllers which emulate TF
5892 * interface with both master and slave devices but also have
5893 * separate SCR register sets for each device. These controllers
5894 * need separate links for physical link handling
5895 * (e.g. onlineness, link speed) but should be treated like a
5896 * traditional M/S controller for everything else (e.g. command
5897 * issue, softreset).
5899 * slave_link is libata's way of handling this class of
5900 * controllers without impacting core layer too much. For
5901 * anything other than physical link handling, the default host
5902 * link is used for both master and slave. For physical link
5903 * handling, separate @ap->slave_link is used. All dirty details
5904 * are implemented inside libata core layer. From LLD's POV, the
5905 * only difference is that prereset, hardreset and postreset are
5906 * called once more for the slave link, so the reset sequence
5907 * looks like the following.
5909 * prereset(M) -> prereset(S) -> hardreset(M) -> hardreset(S) ->
5910 * softreset(M) -> postreset(M) -> postreset(S)
5912 * Note that softreset is called only for the master. Softreset
5913 * resets both M/S by definition, so SRST on master should handle
5914 * both (the standard method will work just fine).
5916 * LOCKING:
5917 * Should be called before host is registered.
5919 * RETURNS:
5920 * 0 on success, -errno on failure.
5922 int ata_slave_link_init(struct ata_port *ap)
5924 struct ata_link *link;
5926 WARN_ON(ap->slave_link);
5927 WARN_ON(ap->flags & ATA_FLAG_PMP);
5929 link = kzalloc(sizeof(*link), GFP_KERNEL);
5930 if (!link)
5931 return -ENOMEM;
5933 ata_link_init(ap, link, 1);
5934 ap->slave_link = link;
5935 return 0;
5938 static void ata_host_stop(struct device *gendev, void *res)
5940 struct ata_host *host = dev_get_drvdata(gendev);
5941 int i;
5943 WARN_ON(!(host->flags & ATA_HOST_STARTED));
5945 for (i = 0; i < host->n_ports; i++) {
5946 struct ata_port *ap = host->ports[i];
5948 if (ap->ops->port_stop)
5949 ap->ops->port_stop(ap);
5952 if (host->ops->host_stop)
5953 host->ops->host_stop(host);
5957 * ata_finalize_port_ops - finalize ata_port_operations
5958 * @ops: ata_port_operations to finalize
5960 * An ata_port_operations can inherit from another ops and that
5961 * ops can again inherit from another. This can go on as many
5962 * times as necessary as long as there is no loop in the
5963 * inheritance chain.
5965 * Ops tables are finalized when the host is started. NULL or
5966 * unspecified entries are inherited from the closet ancestor
5967 * which has the method and the entry is populated with it.
5968 * After finalization, the ops table directly points to all the
5969 * methods and ->inherits is no longer necessary and cleared.
5971 * Using ATA_OP_NULL, inheriting ops can force a method to NULL.
5973 * LOCKING:
5974 * None.
5976 static void ata_finalize_port_ops(struct ata_port_operations *ops)
5978 static DEFINE_SPINLOCK(lock);
5979 const struct ata_port_operations *cur;
5980 void **begin = (void **)ops;
5981 void **end = (void **)&ops->inherits;
5982 void **pp;
5984 if (!ops || !ops->inherits)
5985 return;
5987 spin_lock(&lock);
5989 for (cur = ops->inherits; cur; cur = cur->inherits) {
5990 void **inherit = (void **)cur;
5992 for (pp = begin; pp < end; pp++, inherit++)
5993 if (!*pp)
5994 *pp = *inherit;
5997 for (pp = begin; pp < end; pp++)
5998 if (IS_ERR(*pp))
5999 *pp = NULL;
6001 ops->inherits = NULL;
6003 spin_unlock(&lock);
6007 * ata_host_start - start and freeze ports of an ATA host
6008 * @host: ATA host to start ports for
6010 * Start and then freeze ports of @host. Started status is
6011 * recorded in host->flags, so this function can be called
6012 * multiple times. Ports are guaranteed to get started only
6013 * once. If host->ops isn't initialized yet, its set to the
6014 * first non-dummy port ops.
6016 * LOCKING:
6017 * Inherited from calling layer (may sleep).
6019 * RETURNS:
6020 * 0 if all ports are started successfully, -errno otherwise.
6022 int ata_host_start(struct ata_host *host)
6024 int have_stop = 0;
6025 void *start_dr = NULL;
6026 int i, rc;
6028 if (host->flags & ATA_HOST_STARTED)
6029 return 0;
6031 ata_finalize_port_ops(host->ops);
6033 for (i = 0; i < host->n_ports; i++) {
6034 struct ata_port *ap = host->ports[i];
6036 ata_finalize_port_ops(ap->ops);
6038 if (!host->ops && !ata_port_is_dummy(ap))
6039 host->ops = ap->ops;
6041 if (ap->ops->port_stop)
6042 have_stop = 1;
6045 if (host->ops->host_stop)
6046 have_stop = 1;
6048 if (have_stop) {
6049 start_dr = devres_alloc(ata_host_stop, 0, GFP_KERNEL);
6050 if (!start_dr)
6051 return -ENOMEM;
6054 for (i = 0; i < host->n_ports; i++) {
6055 struct ata_port *ap = host->ports[i];
6057 if (ap->ops->port_start) {
6058 rc = ap->ops->port_start(ap);
6059 if (rc) {
6060 if (rc != -ENODEV)
6061 dev_err(host->dev,
6062 "failed to start port %d (errno=%d)\n",
6063 i, rc);
6064 goto err_out;
6067 ata_eh_freeze_port(ap);
6070 if (start_dr)
6071 devres_add(host->dev, start_dr);
6072 host->flags |= ATA_HOST_STARTED;
6073 return 0;
6075 err_out:
6076 while (--i >= 0) {
6077 struct ata_port *ap = host->ports[i];
6079 if (ap->ops->port_stop)
6080 ap->ops->port_stop(ap);
6082 devres_free(start_dr);
6083 return rc;
6087 * ata_sas_host_init - Initialize a host struct for sas (ipr, libsas)
6088 * @host: host to initialize
6089 * @dev: device host is attached to
6090 * @ops: port_ops
6093 void ata_host_init(struct ata_host *host, struct device *dev,
6094 struct ata_port_operations *ops)
6096 spin_lock_init(&host->lock);
6097 mutex_init(&host->eh_mutex);
6098 host->dev = dev;
6099 host->ops = ops;
6102 void __ata_port_probe(struct ata_port *ap)
6104 struct ata_eh_info *ehi = &ap->link.eh_info;
6105 unsigned long flags;
6107 /* kick EH for boot probing */
6108 spin_lock_irqsave(ap->lock, flags);
6110 ehi->probe_mask |= ATA_ALL_DEVICES;
6111 ehi->action |= ATA_EH_RESET;
6112 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
6114 ap->pflags &= ~ATA_PFLAG_INITIALIZING;
6115 ap->pflags |= ATA_PFLAG_LOADING;
6116 ata_port_schedule_eh(ap);
6118 spin_unlock_irqrestore(ap->lock, flags);
6121 int ata_port_probe(struct ata_port *ap)
6123 int rc = 0;
6125 if (ap->ops->error_handler) {
6126 __ata_port_probe(ap);
6127 ata_port_wait_eh(ap);
6128 } else {
6129 DPRINTK("ata%u: bus probe begin\n", ap->print_id);
6130 rc = ata_bus_probe(ap);
6131 DPRINTK("ata%u: bus probe end\n", ap->print_id);
6133 return rc;
6137 static void async_port_probe(void *data, async_cookie_t cookie)
6139 struct ata_port *ap = data;
6142 * If we're not allowed to scan this host in parallel,
6143 * we need to wait until all previous scans have completed
6144 * before going further.
6145 * Jeff Garzik says this is only within a controller, so we
6146 * don't need to wait for port 0, only for later ports.
6148 if (!(ap->host->flags & ATA_HOST_PARALLEL_SCAN) && ap->port_no != 0)
6149 async_synchronize_cookie(cookie);
6151 (void)ata_port_probe(ap);
6153 /* in order to keep device order, we need to synchronize at this point */
6154 async_synchronize_cookie(cookie);
6156 ata_scsi_scan_host(ap, 1);
6160 * ata_host_register - register initialized ATA host
6161 * @host: ATA host to register
6162 * @sht: template for SCSI host
6164 * Register initialized ATA host. @host is allocated using
6165 * ata_host_alloc() and fully initialized by LLD. This function
6166 * starts ports, registers @host with ATA and SCSI layers and
6167 * probe registered devices.
6169 * LOCKING:
6170 * Inherited from calling layer (may sleep).
6172 * RETURNS:
6173 * 0 on success, -errno otherwise.
6175 int ata_host_register(struct ata_host *host, struct scsi_host_template *sht)
6177 int i, rc;
6179 /* host must have been started */
6180 if (!(host->flags & ATA_HOST_STARTED)) {
6181 dev_err(host->dev, "BUG: trying to register unstarted host\n");
6182 WARN_ON(1);
6183 return -EINVAL;
6186 /* Blow away unused ports. This happens when LLD can't
6187 * determine the exact number of ports to allocate at
6188 * allocation time.
6190 for (i = host->n_ports; host->ports[i]; i++)
6191 kfree(host->ports[i]);
6193 /* give ports names and add SCSI hosts */
6194 for (i = 0; i < host->n_ports; i++) {
6195 host->ports[i]->print_id = atomic_inc_return(&ata_print_id);
6196 host->ports[i]->local_port_no = i + 1;
6199 /* Create associated sysfs transport objects */
6200 for (i = 0; i < host->n_ports; i++) {
6201 rc = ata_tport_add(host->dev,host->ports[i]);
6202 if (rc) {
6203 goto err_tadd;
6207 rc = ata_scsi_add_hosts(host, sht);
6208 if (rc)
6209 goto err_tadd;
6211 /* set cable, sata_spd_limit and report */
6212 for (i = 0; i < host->n_ports; i++) {
6213 struct ata_port *ap = host->ports[i];
6214 unsigned long xfer_mask;
6216 /* set SATA cable type if still unset */
6217 if (ap->cbl == ATA_CBL_NONE && (ap->flags & ATA_FLAG_SATA))
6218 ap->cbl = ATA_CBL_SATA;
6220 /* init sata_spd_limit to the current value */
6221 sata_link_init_spd(&ap->link);
6222 if (ap->slave_link)
6223 sata_link_init_spd(ap->slave_link);
6225 /* print per-port info to dmesg */
6226 xfer_mask = ata_pack_xfermask(ap->pio_mask, ap->mwdma_mask,
6227 ap->udma_mask);
6229 if (!ata_port_is_dummy(ap)) {
6230 ata_port_info(ap, "%cATA max %s %s\n",
6231 (ap->flags & ATA_FLAG_SATA) ? 'S' : 'P',
6232 ata_mode_string(xfer_mask),
6233 ap->link.eh_info.desc);
6234 ata_ehi_clear_desc(&ap->link.eh_info);
6235 } else
6236 ata_port_info(ap, "DUMMY\n");
6239 /* perform each probe asynchronously */
6240 for (i = 0; i < host->n_ports; i++) {
6241 struct ata_port *ap = host->ports[i];
6242 async_schedule(async_port_probe, ap);
6245 return 0;
6247 err_tadd:
6248 while (--i >= 0) {
6249 ata_tport_delete(host->ports[i]);
6251 return rc;
6256 * ata_host_activate - start host, request IRQ and register it
6257 * @host: target ATA host
6258 * @irq: IRQ to request
6259 * @irq_handler: irq_handler used when requesting IRQ
6260 * @irq_flags: irq_flags used when requesting IRQ
6261 * @sht: scsi_host_template to use when registering the host
6263 * After allocating an ATA host and initializing it, most libata
6264 * LLDs perform three steps to activate the host - start host,
6265 * request IRQ and register it. This helper takes necessasry
6266 * arguments and performs the three steps in one go.
6268 * An invalid IRQ skips the IRQ registration and expects the host to
6269 * have set polling mode on the port. In this case, @irq_handler
6270 * should be NULL.
6272 * LOCKING:
6273 * Inherited from calling layer (may sleep).
6275 * RETURNS:
6276 * 0 on success, -errno otherwise.
6278 int ata_host_activate(struct ata_host *host, int irq,
6279 irq_handler_t irq_handler, unsigned long irq_flags,
6280 struct scsi_host_template *sht)
6282 int i, rc;
6284 rc = ata_host_start(host);
6285 if (rc)
6286 return rc;
6288 /* Special case for polling mode */
6289 if (!irq) {
6290 WARN_ON(irq_handler);
6291 return ata_host_register(host, sht);
6294 rc = devm_request_irq(host->dev, irq, irq_handler, irq_flags,
6295 dev_driver_string(host->dev), host);
6296 if (rc)
6297 return rc;
6299 for (i = 0; i < host->n_ports; i++)
6300 ata_port_desc(host->ports[i], "irq %d", irq);
6302 rc = ata_host_register(host, sht);
6303 /* if failed, just free the IRQ and leave ports alone */
6304 if (rc)
6305 devm_free_irq(host->dev, irq, host);
6307 return rc;
6311 * ata_port_detach - Detach ATA port in prepration of device removal
6312 * @ap: ATA port to be detached
6314 * Detach all ATA devices and the associated SCSI devices of @ap;
6315 * then, remove the associated SCSI host. @ap is guaranteed to
6316 * be quiescent on return from this function.
6318 * LOCKING:
6319 * Kernel thread context (may sleep).
6321 static void ata_port_detach(struct ata_port *ap)
6323 unsigned long flags;
6325 if (!ap->ops->error_handler)
6326 goto skip_eh;
6328 /* tell EH we're leaving & flush EH */
6329 spin_lock_irqsave(ap->lock, flags);
6330 ap->pflags |= ATA_PFLAG_UNLOADING;
6331 ata_port_schedule_eh(ap);
6332 spin_unlock_irqrestore(ap->lock, flags);
6334 /* wait till EH commits suicide */
6335 ata_port_wait_eh(ap);
6337 /* it better be dead now */
6338 WARN_ON(!(ap->pflags & ATA_PFLAG_UNLOADED));
6340 cancel_delayed_work_sync(&ap->hotplug_task);
6342 skip_eh:
6343 if (ap->pmp_link) {
6344 int i;
6345 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
6346 ata_tlink_delete(&ap->pmp_link[i]);
6348 /* remove the associated SCSI host */
6349 scsi_remove_host(ap->scsi_host);
6350 ata_tport_delete(ap);
6354 * ata_host_detach - Detach all ports of an ATA host
6355 * @host: Host to detach
6357 * Detach all ports of @host.
6359 * LOCKING:
6360 * Kernel thread context (may sleep).
6362 void ata_host_detach(struct ata_host *host)
6364 int i;
6366 for (i = 0; i < host->n_ports; i++)
6367 ata_port_detach(host->ports[i]);
6369 /* the host is dead now, dissociate ACPI */
6370 ata_acpi_dissociate(host);
6373 #ifdef CONFIG_PCI
6376 * ata_pci_remove_one - PCI layer callback for device removal
6377 * @pdev: PCI device that was removed
6379 * PCI layer indicates to libata via this hook that hot-unplug or
6380 * module unload event has occurred. Detach all ports. Resource
6381 * release is handled via devres.
6383 * LOCKING:
6384 * Inherited from PCI layer (may sleep).
6386 void ata_pci_remove_one(struct pci_dev *pdev)
6388 struct ata_host *host = pci_get_drvdata(pdev);
6390 ata_host_detach(host);
6393 /* move to PCI subsystem */
6394 int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
6396 unsigned long tmp = 0;
6398 switch (bits->width) {
6399 case 1: {
6400 u8 tmp8 = 0;
6401 pci_read_config_byte(pdev, bits->reg, &tmp8);
6402 tmp = tmp8;
6403 break;
6405 case 2: {
6406 u16 tmp16 = 0;
6407 pci_read_config_word(pdev, bits->reg, &tmp16);
6408 tmp = tmp16;
6409 break;
6411 case 4: {
6412 u32 tmp32 = 0;
6413 pci_read_config_dword(pdev, bits->reg, &tmp32);
6414 tmp = tmp32;
6415 break;
6418 default:
6419 return -EINVAL;
6422 tmp &= bits->mask;
6424 return (tmp == bits->val) ? 1 : 0;
6427 #ifdef CONFIG_PM
6428 void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg)
6430 pci_save_state(pdev);
6431 pci_disable_device(pdev);
6433 if (mesg.event & PM_EVENT_SLEEP)
6434 pci_set_power_state(pdev, PCI_D3hot);
6437 int ata_pci_device_do_resume(struct pci_dev *pdev)
6439 int rc;
6441 pci_set_power_state(pdev, PCI_D0);
6442 pci_restore_state(pdev);
6444 rc = pcim_enable_device(pdev);
6445 if (rc) {
6446 dev_err(&pdev->dev,
6447 "failed to enable device after resume (%d)\n", rc);
6448 return rc;
6451 pci_set_master(pdev);
6452 return 0;
6455 int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
6457 struct ata_host *host = pci_get_drvdata(pdev);
6458 int rc = 0;
6460 rc = ata_host_suspend(host, mesg);
6461 if (rc)
6462 return rc;
6464 ata_pci_device_do_suspend(pdev, mesg);
6466 return 0;
6469 int ata_pci_device_resume(struct pci_dev *pdev)
6471 struct ata_host *host = pci_get_drvdata(pdev);
6472 int rc;
6474 rc = ata_pci_device_do_resume(pdev);
6475 if (rc == 0)
6476 ata_host_resume(host);
6477 return rc;
6479 #endif /* CONFIG_PM */
6481 #endif /* CONFIG_PCI */
6484 * ata_platform_remove_one - Platform layer callback for device removal
6485 * @pdev: Platform device that was removed
6487 * Platform layer indicates to libata via this hook that hot-unplug or
6488 * module unload event has occurred. Detach all ports. Resource
6489 * release is handled via devres.
6491 * LOCKING:
6492 * Inherited from platform layer (may sleep).
6494 int ata_platform_remove_one(struct platform_device *pdev)
6496 struct ata_host *host = platform_get_drvdata(pdev);
6498 ata_host_detach(host);
6500 return 0;
6503 static int __init ata_parse_force_one(char **cur,
6504 struct ata_force_ent *force_ent,
6505 const char **reason)
6507 /* FIXME: Currently, there's no way to tag init const data and
6508 * using __initdata causes build failure on some versions of
6509 * gcc. Once __initdataconst is implemented, add const to the
6510 * following structure.
6512 static struct ata_force_param force_tbl[] __initdata = {
6513 { "40c", .cbl = ATA_CBL_PATA40 },
6514 { "80c", .cbl = ATA_CBL_PATA80 },
6515 { "short40c", .cbl = ATA_CBL_PATA40_SHORT },
6516 { "unk", .cbl = ATA_CBL_PATA_UNK },
6517 { "ign", .cbl = ATA_CBL_PATA_IGN },
6518 { "sata", .cbl = ATA_CBL_SATA },
6519 { "1.5Gbps", .spd_limit = 1 },
6520 { "3.0Gbps", .spd_limit = 2 },
6521 { "noncq", .horkage_on = ATA_HORKAGE_NONCQ },
6522 { "ncq", .horkage_off = ATA_HORKAGE_NONCQ },
6523 { "dump_id", .horkage_on = ATA_HORKAGE_DUMP_ID },
6524 { "pio0", .xfer_mask = 1 << (ATA_SHIFT_PIO + 0) },
6525 { "pio1", .xfer_mask = 1 << (ATA_SHIFT_PIO + 1) },
6526 { "pio2", .xfer_mask = 1 << (ATA_SHIFT_PIO + 2) },
6527 { "pio3", .xfer_mask = 1 << (ATA_SHIFT_PIO + 3) },
6528 { "pio4", .xfer_mask = 1 << (ATA_SHIFT_PIO + 4) },
6529 { "pio5", .xfer_mask = 1 << (ATA_SHIFT_PIO + 5) },
6530 { "pio6", .xfer_mask = 1 << (ATA_SHIFT_PIO + 6) },
6531 { "mwdma0", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 0) },
6532 { "mwdma1", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 1) },
6533 { "mwdma2", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 2) },
6534 { "mwdma3", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 3) },
6535 { "mwdma4", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 4) },
6536 { "udma0", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6537 { "udma16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6538 { "udma/16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6539 { "udma1", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6540 { "udma25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6541 { "udma/25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6542 { "udma2", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6543 { "udma33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6544 { "udma/33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6545 { "udma3", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6546 { "udma44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6547 { "udma/44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6548 { "udma4", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6549 { "udma66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6550 { "udma/66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6551 { "udma5", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6552 { "udma100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6553 { "udma/100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6554 { "udma6", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6555 { "udma133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6556 { "udma/133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6557 { "udma7", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 7) },
6558 { "nohrst", .lflags = ATA_LFLAG_NO_HRST },
6559 { "nosrst", .lflags = ATA_LFLAG_NO_SRST },
6560 { "norst", .lflags = ATA_LFLAG_NO_HRST | ATA_LFLAG_NO_SRST },
6561 { "rstonce", .lflags = ATA_LFLAG_RST_ONCE },
6562 { "atapi_dmadir", .horkage_on = ATA_HORKAGE_ATAPI_DMADIR },
6563 { "disable", .horkage_on = ATA_HORKAGE_DISABLE },
6565 char *start = *cur, *p = *cur;
6566 char *id, *val, *endp;
6567 const struct ata_force_param *match_fp = NULL;
6568 int nr_matches = 0, i;
6570 /* find where this param ends and update *cur */
6571 while (*p != '\0' && *p != ',')
6572 p++;
6574 if (*p == '\0')
6575 *cur = p;
6576 else
6577 *cur = p + 1;
6579 *p = '\0';
6581 /* parse */
6582 p = strchr(start, ':');
6583 if (!p) {
6584 val = strstrip(start);
6585 goto parse_val;
6587 *p = '\0';
6589 id = strstrip(start);
6590 val = strstrip(p + 1);
6592 /* parse id */
6593 p = strchr(id, '.');
6594 if (p) {
6595 *p++ = '\0';
6596 force_ent->device = simple_strtoul(p, &endp, 10);
6597 if (p == endp || *endp != '\0') {
6598 *reason = "invalid device";
6599 return -EINVAL;
6603 force_ent->port = simple_strtoul(id, &endp, 10);
6604 if (p == endp || *endp != '\0') {
6605 *reason = "invalid port/link";
6606 return -EINVAL;
6609 parse_val:
6610 /* parse val, allow shortcuts so that both 1.5 and 1.5Gbps work */
6611 for (i = 0; i < ARRAY_SIZE(force_tbl); i++) {
6612 const struct ata_force_param *fp = &force_tbl[i];
6614 if (strncasecmp(val, fp->name, strlen(val)))
6615 continue;
6617 nr_matches++;
6618 match_fp = fp;
6620 if (strcasecmp(val, fp->name) == 0) {
6621 nr_matches = 1;
6622 break;
6626 if (!nr_matches) {
6627 *reason = "unknown value";
6628 return -EINVAL;
6630 if (nr_matches > 1) {
6631 *reason = "ambigious value";
6632 return -EINVAL;
6635 force_ent->param = *match_fp;
6637 return 0;
6640 static void __init ata_parse_force_param(void)
6642 int idx = 0, size = 1;
6643 int last_port = -1, last_device = -1;
6644 char *p, *cur, *next;
6646 /* calculate maximum number of params and allocate force_tbl */
6647 for (p = ata_force_param_buf; *p; p++)
6648 if (*p == ',')
6649 size++;
6651 ata_force_tbl = kzalloc(sizeof(ata_force_tbl[0]) * size, GFP_KERNEL);
6652 if (!ata_force_tbl) {
6653 printk(KERN_WARNING "ata: failed to extend force table, "
6654 "libata.force ignored\n");
6655 return;
6658 /* parse and populate the table */
6659 for (cur = ata_force_param_buf; *cur != '\0'; cur = next) {
6660 const char *reason = "";
6661 struct ata_force_ent te = { .port = -1, .device = -1 };
6663 next = cur;
6664 if (ata_parse_force_one(&next, &te, &reason)) {
6665 printk(KERN_WARNING "ata: failed to parse force "
6666 "parameter \"%s\" (%s)\n",
6667 cur, reason);
6668 continue;
6671 if (te.port == -1) {
6672 te.port = last_port;
6673 te.device = last_device;
6676 ata_force_tbl[idx++] = te;
6678 last_port = te.port;
6679 last_device = te.device;
6682 ata_force_tbl_size = idx;
6685 static int __init ata_init(void)
6687 int rc;
6689 ata_parse_force_param();
6691 rc = ata_sff_init();
6692 if (rc) {
6693 kfree(ata_force_tbl);
6694 return rc;
6697 libata_transport_init();
6698 ata_scsi_transport_template = ata_attach_transport();
6699 if (!ata_scsi_transport_template) {
6700 ata_sff_exit();
6701 rc = -ENOMEM;
6702 goto err_out;
6705 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
6706 return 0;
6708 err_out:
6709 return rc;
6712 static void __exit ata_exit(void)
6714 ata_release_transport(ata_scsi_transport_template);
6715 libata_transport_exit();
6716 ata_sff_exit();
6717 kfree(ata_force_tbl);
6720 subsys_initcall(ata_init);
6721 module_exit(ata_exit);
6723 static DEFINE_RATELIMIT_STATE(ratelimit, HZ / 5, 1);
6725 int ata_ratelimit(void)
6727 return __ratelimit(&ratelimit);
6731 * ata_msleep - ATA EH owner aware msleep
6732 * @ap: ATA port to attribute the sleep to
6733 * @msecs: duration to sleep in milliseconds
6735 * Sleeps @msecs. If the current task is owner of @ap's EH, the
6736 * ownership is released before going to sleep and reacquired
6737 * after the sleep is complete. IOW, other ports sharing the
6738 * @ap->host will be allowed to own the EH while this task is
6739 * sleeping.
6741 * LOCKING:
6742 * Might sleep.
6744 void ata_msleep(struct ata_port *ap, unsigned int msecs)
6746 bool owns_eh = ap && ap->host->eh_owner == current;
6748 if (owns_eh)
6749 ata_eh_release(ap);
6751 msleep(msecs);
6753 if (owns_eh)
6754 ata_eh_acquire(ap);
6758 * ata_wait_register - wait until register value changes
6759 * @ap: ATA port to wait register for, can be NULL
6760 * @reg: IO-mapped register
6761 * @mask: Mask to apply to read register value
6762 * @val: Wait condition
6763 * @interval: polling interval in milliseconds
6764 * @timeout: timeout in milliseconds
6766 * Waiting for some bits of register to change is a common
6767 * operation for ATA controllers. This function reads 32bit LE
6768 * IO-mapped register @reg and tests for the following condition.
6770 * (*@reg & mask) != val
6772 * If the condition is met, it returns; otherwise, the process is
6773 * repeated after @interval_msec until timeout.
6775 * LOCKING:
6776 * Kernel thread context (may sleep)
6778 * RETURNS:
6779 * The final register value.
6781 u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask, u32 val,
6782 unsigned long interval, unsigned long timeout)
6784 unsigned long deadline;
6785 u32 tmp;
6787 tmp = ioread32(reg);
6789 /* Calculate timeout _after_ the first read to make sure
6790 * preceding writes reach the controller before starting to
6791 * eat away the timeout.
6793 deadline = ata_deadline(jiffies, timeout);
6795 while ((tmp & mask) == val && time_before(jiffies, deadline)) {
6796 ata_msleep(ap, interval);
6797 tmp = ioread32(reg);
6800 return tmp;
6804 * Dummy port_ops
6806 static unsigned int ata_dummy_qc_issue(struct ata_queued_cmd *qc)
6808 return AC_ERR_SYSTEM;
6811 static void ata_dummy_error_handler(struct ata_port *ap)
6813 /* truly dummy */
6816 struct ata_port_operations ata_dummy_port_ops = {
6817 .qc_prep = ata_noop_qc_prep,
6818 .qc_issue = ata_dummy_qc_issue,
6819 .error_handler = ata_dummy_error_handler,
6820 .sched_eh = ata_std_sched_eh,
6821 .end_eh = ata_std_end_eh,
6824 const struct ata_port_info ata_dummy_port_info = {
6825 .port_ops = &ata_dummy_port_ops,
6829 * Utility print functions
6831 int ata_port_printk(const struct ata_port *ap, const char *level,
6832 const char *fmt, ...)
6834 struct va_format vaf;
6835 va_list args;
6836 int r;
6838 va_start(args, fmt);
6840 vaf.fmt = fmt;
6841 vaf.va = &args;
6843 r = printk("%sata%u: %pV", level, ap->print_id, &vaf);
6845 va_end(args);
6847 return r;
6849 EXPORT_SYMBOL(ata_port_printk);
6851 int ata_link_printk(const struct ata_link *link, const char *level,
6852 const char *fmt, ...)
6854 struct va_format vaf;
6855 va_list args;
6856 int r;
6858 va_start(args, fmt);
6860 vaf.fmt = fmt;
6861 vaf.va = &args;
6863 if (sata_pmp_attached(link->ap) || link->ap->slave_link)
6864 r = printk("%sata%u.%02u: %pV",
6865 level, link->ap->print_id, link->pmp, &vaf);
6866 else
6867 r = printk("%sata%u: %pV",
6868 level, link->ap->print_id, &vaf);
6870 va_end(args);
6872 return r;
6874 EXPORT_SYMBOL(ata_link_printk);
6876 int ata_dev_printk(const struct ata_device *dev, const char *level,
6877 const char *fmt, ...)
6879 struct va_format vaf;
6880 va_list args;
6881 int r;
6883 va_start(args, fmt);
6885 vaf.fmt = fmt;
6886 vaf.va = &args;
6888 r = printk("%sata%u.%02u: %pV",
6889 level, dev->link->ap->print_id, dev->link->pmp + dev->devno,
6890 &vaf);
6892 va_end(args);
6894 return r;
6896 EXPORT_SYMBOL(ata_dev_printk);
6898 void ata_print_version(const struct device *dev, const char *version)
6900 dev_printk(KERN_DEBUG, dev, "version %s\n", version);
6902 EXPORT_SYMBOL(ata_print_version);
6905 * libata is essentially a library of internal helper functions for
6906 * low-level ATA host controller drivers. As such, the API/ABI is
6907 * likely to change as new drivers are added and updated.
6908 * Do not depend on ABI/API stability.
6910 EXPORT_SYMBOL_GPL(sata_deb_timing_normal);
6911 EXPORT_SYMBOL_GPL(sata_deb_timing_hotplug);
6912 EXPORT_SYMBOL_GPL(sata_deb_timing_long);
6913 EXPORT_SYMBOL_GPL(ata_base_port_ops);
6914 EXPORT_SYMBOL_GPL(sata_port_ops);
6915 EXPORT_SYMBOL_GPL(ata_dummy_port_ops);
6916 EXPORT_SYMBOL_GPL(ata_dummy_port_info);
6917 EXPORT_SYMBOL_GPL(ata_link_next);
6918 EXPORT_SYMBOL_GPL(ata_dev_next);
6919 EXPORT_SYMBOL_GPL(ata_std_bios_param);
6920 EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
6921 EXPORT_SYMBOL_GPL(ata_host_init);
6922 EXPORT_SYMBOL_GPL(ata_host_alloc);
6923 EXPORT_SYMBOL_GPL(ata_host_alloc_pinfo);
6924 EXPORT_SYMBOL_GPL(ata_slave_link_init);
6925 EXPORT_SYMBOL_GPL(ata_host_start);
6926 EXPORT_SYMBOL_GPL(ata_host_register);
6927 EXPORT_SYMBOL_GPL(ata_host_activate);
6928 EXPORT_SYMBOL_GPL(ata_host_detach);
6929 EXPORT_SYMBOL_GPL(ata_sg_init);
6930 EXPORT_SYMBOL_GPL(ata_qc_complete);
6931 EXPORT_SYMBOL_GPL(ata_qc_complete_multiple);
6932 EXPORT_SYMBOL_GPL(atapi_cmd_type);
6933 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
6934 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
6935 EXPORT_SYMBOL_GPL(ata_pack_xfermask);
6936 EXPORT_SYMBOL_GPL(ata_unpack_xfermask);
6937 EXPORT_SYMBOL_GPL(ata_xfer_mask2mode);
6938 EXPORT_SYMBOL_GPL(ata_xfer_mode2mask);
6939 EXPORT_SYMBOL_GPL(ata_xfer_mode2shift);
6940 EXPORT_SYMBOL_GPL(ata_mode_string);
6941 EXPORT_SYMBOL_GPL(ata_id_xfermask);
6942 EXPORT_SYMBOL_GPL(ata_do_set_mode);
6943 EXPORT_SYMBOL_GPL(ata_std_qc_defer);
6944 EXPORT_SYMBOL_GPL(ata_noop_qc_prep);
6945 EXPORT_SYMBOL_GPL(ata_dev_disable);
6946 EXPORT_SYMBOL_GPL(sata_set_spd);
6947 EXPORT_SYMBOL_GPL(ata_wait_after_reset);
6948 EXPORT_SYMBOL_GPL(sata_link_debounce);
6949 EXPORT_SYMBOL_GPL(sata_link_resume);
6950 EXPORT_SYMBOL_GPL(sata_link_scr_lpm);
6951 EXPORT_SYMBOL_GPL(ata_std_prereset);
6952 EXPORT_SYMBOL_GPL(sata_link_hardreset);
6953 EXPORT_SYMBOL_GPL(sata_std_hardreset);
6954 EXPORT_SYMBOL_GPL(ata_std_postreset);
6955 EXPORT_SYMBOL_GPL(ata_dev_classify);
6956 EXPORT_SYMBOL_GPL(ata_dev_pair);
6957 EXPORT_SYMBOL_GPL(ata_ratelimit);
6958 EXPORT_SYMBOL_GPL(ata_msleep);
6959 EXPORT_SYMBOL_GPL(ata_wait_register);
6960 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
6961 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
6962 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
6963 EXPORT_SYMBOL_GPL(ata_scsi_change_queue_depth);
6964 EXPORT_SYMBOL_GPL(__ata_change_queue_depth);
6965 EXPORT_SYMBOL_GPL(sata_scr_valid);
6966 EXPORT_SYMBOL_GPL(sata_scr_read);
6967 EXPORT_SYMBOL_GPL(sata_scr_write);
6968 EXPORT_SYMBOL_GPL(sata_scr_write_flush);
6969 EXPORT_SYMBOL_GPL(ata_link_online);
6970 EXPORT_SYMBOL_GPL(ata_link_offline);
6971 #ifdef CONFIG_PM
6972 EXPORT_SYMBOL_GPL(ata_host_suspend);
6973 EXPORT_SYMBOL_GPL(ata_host_resume);
6974 #endif /* CONFIG_PM */
6975 EXPORT_SYMBOL_GPL(ata_id_string);
6976 EXPORT_SYMBOL_GPL(ata_id_c_string);
6977 EXPORT_SYMBOL_GPL(ata_do_dev_read_id);
6978 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
6980 EXPORT_SYMBOL_GPL(ata_pio_need_iordy);
6981 EXPORT_SYMBOL_GPL(ata_timing_find_mode);
6982 EXPORT_SYMBOL_GPL(ata_timing_compute);
6983 EXPORT_SYMBOL_GPL(ata_timing_merge);
6984 EXPORT_SYMBOL_GPL(ata_timing_cycle2mode);
6986 #ifdef CONFIG_PCI
6987 EXPORT_SYMBOL_GPL(pci_test_config_bits);
6988 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
6989 #ifdef CONFIG_PM
6990 EXPORT_SYMBOL_GPL(ata_pci_device_do_suspend);
6991 EXPORT_SYMBOL_GPL(ata_pci_device_do_resume);
6992 EXPORT_SYMBOL_GPL(ata_pci_device_suspend);
6993 EXPORT_SYMBOL_GPL(ata_pci_device_resume);
6994 #endif /* CONFIG_PM */
6995 #endif /* CONFIG_PCI */
6997 EXPORT_SYMBOL_GPL(ata_platform_remove_one);
6999 EXPORT_SYMBOL_GPL(__ata_ehi_push_desc);
7000 EXPORT_SYMBOL_GPL(ata_ehi_push_desc);
7001 EXPORT_SYMBOL_GPL(ata_ehi_clear_desc);
7002 EXPORT_SYMBOL_GPL(ata_port_desc);
7003 #ifdef CONFIG_PCI
7004 EXPORT_SYMBOL_GPL(ata_port_pbar_desc);
7005 #endif /* CONFIG_PCI */
7006 EXPORT_SYMBOL_GPL(ata_port_schedule_eh);
7007 EXPORT_SYMBOL_GPL(ata_link_abort);
7008 EXPORT_SYMBOL_GPL(ata_port_abort);
7009 EXPORT_SYMBOL_GPL(ata_port_freeze);
7010 EXPORT_SYMBOL_GPL(sata_async_notification);
7011 EXPORT_SYMBOL_GPL(ata_eh_freeze_port);
7012 EXPORT_SYMBOL_GPL(ata_eh_thaw_port);
7013 EXPORT_SYMBOL_GPL(ata_eh_qc_complete);
7014 EXPORT_SYMBOL_GPL(ata_eh_qc_retry);
7015 EXPORT_SYMBOL_GPL(ata_eh_analyze_ncq_error);
7016 EXPORT_SYMBOL_GPL(ata_do_eh);
7017 EXPORT_SYMBOL_GPL(ata_std_error_handler);
7019 EXPORT_SYMBOL_GPL(ata_cable_40wire);
7020 EXPORT_SYMBOL_GPL(ata_cable_80wire);
7021 EXPORT_SYMBOL_GPL(ata_cable_unknown);
7022 EXPORT_SYMBOL_GPL(ata_cable_ignore);
7023 EXPORT_SYMBOL_GPL(ata_cable_sata);