Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/s390/linux
[linux-2.6.git] / drivers / ata / libata-core.c
blob83b1a9fb2d4418f441c5fa0eb508dbe2819f562c
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 dev->flags |= ATA_DFLAG_NCQ_SEND_RECV;
2153 memcpy(dev->ncq_send_recv_cmds, ap->sector_buf,
2154 ATA_LOG_NCQ_SEND_RECV_SIZE);
2158 return 0;
2162 * ata_dev_configure - Configure the specified ATA/ATAPI device
2163 * @dev: Target device to configure
2165 * Configure @dev according to @dev->id. Generic and low-level
2166 * driver specific fixups are also applied.
2168 * LOCKING:
2169 * Kernel thread context (may sleep)
2171 * RETURNS:
2172 * 0 on success, -errno otherwise
2174 int ata_dev_configure(struct ata_device *dev)
2176 struct ata_port *ap = dev->link->ap;
2177 struct ata_eh_context *ehc = &dev->link->eh_context;
2178 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
2179 const u16 *id = dev->id;
2180 unsigned long xfer_mask;
2181 unsigned int err_mask;
2182 char revbuf[7]; /* XYZ-99\0 */
2183 char fwrevbuf[ATA_ID_FW_REV_LEN+1];
2184 char modelbuf[ATA_ID_PROD_LEN+1];
2185 int rc;
2187 if (!ata_dev_enabled(dev) && ata_msg_info(ap)) {
2188 ata_dev_info(dev, "%s: ENTER/EXIT -- nodev\n", __func__);
2189 return 0;
2192 if (ata_msg_probe(ap))
2193 ata_dev_dbg(dev, "%s: ENTER\n", __func__);
2195 /* set horkage */
2196 dev->horkage |= ata_dev_blacklisted(dev);
2197 ata_force_horkage(dev);
2199 if (dev->horkage & ATA_HORKAGE_DISABLE) {
2200 ata_dev_info(dev, "unsupported device, disabling\n");
2201 ata_dev_disable(dev);
2202 return 0;
2205 if ((!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) &&
2206 dev->class == ATA_DEV_ATAPI) {
2207 ata_dev_warn(dev, "WARNING: ATAPI is %s, device ignored\n",
2208 atapi_enabled ? "not supported with this driver"
2209 : "disabled");
2210 ata_dev_disable(dev);
2211 return 0;
2214 rc = ata_do_link_spd_horkage(dev);
2215 if (rc)
2216 return rc;
2218 /* let ACPI work its magic */
2219 rc = ata_acpi_on_devcfg(dev);
2220 if (rc)
2221 return rc;
2223 /* massage HPA, do it early as it might change IDENTIFY data */
2224 rc = ata_hpa_resize(dev);
2225 if (rc)
2226 return rc;
2228 /* print device capabilities */
2229 if (ata_msg_probe(ap))
2230 ata_dev_dbg(dev,
2231 "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
2232 "85:%04x 86:%04x 87:%04x 88:%04x\n",
2233 __func__,
2234 id[49], id[82], id[83], id[84],
2235 id[85], id[86], id[87], id[88]);
2237 /* initialize to-be-configured parameters */
2238 dev->flags &= ~ATA_DFLAG_CFG_MASK;
2239 dev->max_sectors = 0;
2240 dev->cdb_len = 0;
2241 dev->n_sectors = 0;
2242 dev->cylinders = 0;
2243 dev->heads = 0;
2244 dev->sectors = 0;
2245 dev->multi_count = 0;
2248 * common ATA, ATAPI feature tests
2251 /* find max transfer mode; for printk only */
2252 xfer_mask = ata_id_xfermask(id);
2254 if (ata_msg_probe(ap))
2255 ata_dump_id(id);
2257 /* SCSI only uses 4-char revisions, dump full 8 chars from ATA */
2258 ata_id_c_string(dev->id, fwrevbuf, ATA_ID_FW_REV,
2259 sizeof(fwrevbuf));
2261 ata_id_c_string(dev->id, modelbuf, ATA_ID_PROD,
2262 sizeof(modelbuf));
2264 /* ATA-specific feature tests */
2265 if (dev->class == ATA_DEV_ATA) {
2266 if (ata_id_is_cfa(id)) {
2267 /* CPRM may make this media unusable */
2268 if (id[ATA_ID_CFA_KEY_MGMT] & 1)
2269 ata_dev_warn(dev,
2270 "supports DRM functions and may not be fully accessible\n");
2271 snprintf(revbuf, 7, "CFA");
2272 } else {
2273 snprintf(revbuf, 7, "ATA-%d", ata_id_major_version(id));
2274 /* Warn the user if the device has TPM extensions */
2275 if (ata_id_has_tpm(id))
2276 ata_dev_warn(dev,
2277 "supports DRM functions and may not be fully accessible\n");
2280 dev->n_sectors = ata_id_n_sectors(id);
2282 /* get current R/W Multiple count setting */
2283 if ((dev->id[47] >> 8) == 0x80 && (dev->id[59] & 0x100)) {
2284 unsigned int max = dev->id[47] & 0xff;
2285 unsigned int cnt = dev->id[59] & 0xff;
2286 /* only recognize/allow powers of two here */
2287 if (is_power_of_2(max) && is_power_of_2(cnt))
2288 if (cnt <= max)
2289 dev->multi_count = cnt;
2292 if (ata_id_has_lba(id)) {
2293 const char *lba_desc;
2294 char ncq_desc[24];
2296 lba_desc = "LBA";
2297 dev->flags |= ATA_DFLAG_LBA;
2298 if (ata_id_has_lba48(id)) {
2299 dev->flags |= ATA_DFLAG_LBA48;
2300 lba_desc = "LBA48";
2302 if (dev->n_sectors >= (1UL << 28) &&
2303 ata_id_has_flush_ext(id))
2304 dev->flags |= ATA_DFLAG_FLUSH_EXT;
2307 /* config NCQ */
2308 rc = ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
2309 if (rc)
2310 return rc;
2312 /* print device info to dmesg */
2313 if (ata_msg_drv(ap) && print_info) {
2314 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2315 revbuf, modelbuf, fwrevbuf,
2316 ata_mode_string(xfer_mask));
2317 ata_dev_info(dev,
2318 "%llu sectors, multi %u: %s %s\n",
2319 (unsigned long long)dev->n_sectors,
2320 dev->multi_count, lba_desc, ncq_desc);
2322 } else {
2323 /* CHS */
2325 /* Default translation */
2326 dev->cylinders = id[1];
2327 dev->heads = id[3];
2328 dev->sectors = id[6];
2330 if (ata_id_current_chs_valid(id)) {
2331 /* Current CHS translation is valid. */
2332 dev->cylinders = id[54];
2333 dev->heads = id[55];
2334 dev->sectors = id[56];
2337 /* print device info to dmesg */
2338 if (ata_msg_drv(ap) && print_info) {
2339 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2340 revbuf, modelbuf, fwrevbuf,
2341 ata_mode_string(xfer_mask));
2342 ata_dev_info(dev,
2343 "%llu sectors, multi %u, CHS %u/%u/%u\n",
2344 (unsigned long long)dev->n_sectors,
2345 dev->multi_count, dev->cylinders,
2346 dev->heads, dev->sectors);
2350 /* Check and mark DevSlp capability. Get DevSlp timing variables
2351 * from SATA Settings page of Identify Device Data Log.
2353 if (ata_id_has_devslp(dev->id)) {
2354 u8 *sata_setting = ap->sector_buf;
2355 int i, j;
2357 dev->flags |= ATA_DFLAG_DEVSLP;
2358 err_mask = ata_read_log_page(dev,
2359 ATA_LOG_SATA_ID_DEV_DATA,
2360 ATA_LOG_SATA_SETTINGS,
2361 sata_setting,
2363 if (err_mask)
2364 ata_dev_dbg(dev,
2365 "failed to get Identify Device Data, Emask 0x%x\n",
2366 err_mask);
2367 else
2368 for (i = 0; i < ATA_LOG_DEVSLP_SIZE; i++) {
2369 j = ATA_LOG_DEVSLP_OFFSET + i;
2370 dev->devslp_timing[i] = sata_setting[j];
2374 dev->cdb_len = 16;
2377 /* ATAPI-specific feature tests */
2378 else if (dev->class == ATA_DEV_ATAPI) {
2379 const char *cdb_intr_string = "";
2380 const char *atapi_an_string = "";
2381 const char *dma_dir_string = "";
2382 u32 sntf;
2384 rc = atapi_cdb_len(id);
2385 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
2386 if (ata_msg_warn(ap))
2387 ata_dev_warn(dev, "unsupported CDB len\n");
2388 rc = -EINVAL;
2389 goto err_out_nosup;
2391 dev->cdb_len = (unsigned int) rc;
2393 /* Enable ATAPI AN if both the host and device have
2394 * the support. If PMP is attached, SNTF is required
2395 * to enable ATAPI AN to discern between PHY status
2396 * changed notifications and ATAPI ANs.
2398 if (atapi_an &&
2399 (ap->flags & ATA_FLAG_AN) && ata_id_has_atapi_AN(id) &&
2400 (!sata_pmp_attached(ap) ||
2401 sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf) == 0)) {
2402 /* issue SET feature command to turn this on */
2403 err_mask = ata_dev_set_feature(dev,
2404 SETFEATURES_SATA_ENABLE, SATA_AN);
2405 if (err_mask)
2406 ata_dev_err(dev,
2407 "failed to enable ATAPI AN (err_mask=0x%x)\n",
2408 err_mask);
2409 else {
2410 dev->flags |= ATA_DFLAG_AN;
2411 atapi_an_string = ", ATAPI AN";
2415 if (ata_id_cdb_intr(dev->id)) {
2416 dev->flags |= ATA_DFLAG_CDB_INTR;
2417 cdb_intr_string = ", CDB intr";
2420 if (atapi_dmadir || (dev->horkage & ATA_HORKAGE_ATAPI_DMADIR) || atapi_id_dmadir(dev->id)) {
2421 dev->flags |= ATA_DFLAG_DMADIR;
2422 dma_dir_string = ", DMADIR";
2425 if (ata_id_has_da(dev->id)) {
2426 dev->flags |= ATA_DFLAG_DA;
2427 zpodd_init(dev);
2430 /* print device info to dmesg */
2431 if (ata_msg_drv(ap) && print_info)
2432 ata_dev_info(dev,
2433 "ATAPI: %s, %s, max %s%s%s%s\n",
2434 modelbuf, fwrevbuf,
2435 ata_mode_string(xfer_mask),
2436 cdb_intr_string, atapi_an_string,
2437 dma_dir_string);
2440 /* determine max_sectors */
2441 dev->max_sectors = ATA_MAX_SECTORS;
2442 if (dev->flags & ATA_DFLAG_LBA48)
2443 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2445 /* Limit PATA drive on SATA cable bridge transfers to udma5,
2446 200 sectors */
2447 if (ata_dev_knobble(dev)) {
2448 if (ata_msg_drv(ap) && print_info)
2449 ata_dev_info(dev, "applying bridge limits\n");
2450 dev->udma_mask &= ATA_UDMA5;
2451 dev->max_sectors = ATA_MAX_SECTORS;
2454 if ((dev->class == ATA_DEV_ATAPI) &&
2455 (atapi_command_packet_set(id) == TYPE_TAPE)) {
2456 dev->max_sectors = ATA_MAX_SECTORS_TAPE;
2457 dev->horkage |= ATA_HORKAGE_STUCK_ERR;
2460 if (dev->horkage & ATA_HORKAGE_MAX_SEC_128)
2461 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_128,
2462 dev->max_sectors);
2464 if (dev->horkage & ATA_HORKAGE_MAX_SEC_LBA48)
2465 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2467 if (ap->ops->dev_config)
2468 ap->ops->dev_config(dev);
2470 if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
2471 /* Let the user know. We don't want to disallow opens for
2472 rescue purposes, or in case the vendor is just a blithering
2473 idiot. Do this after the dev_config call as some controllers
2474 with buggy firmware may want to avoid reporting false device
2475 bugs */
2477 if (print_info) {
2478 ata_dev_warn(dev,
2479 "Drive reports diagnostics failure. This may indicate a drive\n");
2480 ata_dev_warn(dev,
2481 "fault or invalid emulation. Contact drive vendor for information.\n");
2485 if ((dev->horkage & ATA_HORKAGE_FIRMWARE_WARN) && print_info) {
2486 ata_dev_warn(dev, "WARNING: device requires firmware update to be fully functional\n");
2487 ata_dev_warn(dev, " contact the vendor or visit http://ata.wiki.kernel.org\n");
2490 return 0;
2492 err_out_nosup:
2493 if (ata_msg_probe(ap))
2494 ata_dev_dbg(dev, "%s: EXIT, err\n", __func__);
2495 return rc;
2499 * ata_cable_40wire - return 40 wire cable type
2500 * @ap: port
2502 * Helper method for drivers which want to hardwire 40 wire cable
2503 * detection.
2506 int ata_cable_40wire(struct ata_port *ap)
2508 return ATA_CBL_PATA40;
2512 * ata_cable_80wire - return 80 wire cable type
2513 * @ap: port
2515 * Helper method for drivers which want to hardwire 80 wire cable
2516 * detection.
2519 int ata_cable_80wire(struct ata_port *ap)
2521 return ATA_CBL_PATA80;
2525 * ata_cable_unknown - return unknown PATA cable.
2526 * @ap: port
2528 * Helper method for drivers which have no PATA cable detection.
2531 int ata_cable_unknown(struct ata_port *ap)
2533 return ATA_CBL_PATA_UNK;
2537 * ata_cable_ignore - return ignored PATA cable.
2538 * @ap: port
2540 * Helper method for drivers which don't use cable type to limit
2541 * transfer mode.
2543 int ata_cable_ignore(struct ata_port *ap)
2545 return ATA_CBL_PATA_IGN;
2549 * ata_cable_sata - return SATA cable type
2550 * @ap: port
2552 * Helper method for drivers which have SATA cables
2555 int ata_cable_sata(struct ata_port *ap)
2557 return ATA_CBL_SATA;
2561 * ata_bus_probe - Reset and probe ATA bus
2562 * @ap: Bus to probe
2564 * Master ATA bus probing function. Initiates a hardware-dependent
2565 * bus reset, then attempts to identify any devices found on
2566 * the bus.
2568 * LOCKING:
2569 * PCI/etc. bus probe sem.
2571 * RETURNS:
2572 * Zero on success, negative errno otherwise.
2575 int ata_bus_probe(struct ata_port *ap)
2577 unsigned int classes[ATA_MAX_DEVICES];
2578 int tries[ATA_MAX_DEVICES];
2579 int rc;
2580 struct ata_device *dev;
2582 ata_for_each_dev(dev, &ap->link, ALL)
2583 tries[dev->devno] = ATA_PROBE_MAX_TRIES;
2585 retry:
2586 ata_for_each_dev(dev, &ap->link, ALL) {
2587 /* If we issue an SRST then an ATA drive (not ATAPI)
2588 * may change configuration and be in PIO0 timing. If
2589 * we do a hard reset (or are coming from power on)
2590 * this is true for ATA or ATAPI. Until we've set a
2591 * suitable controller mode we should not touch the
2592 * bus as we may be talking too fast.
2594 dev->pio_mode = XFER_PIO_0;
2595 dev->dma_mode = 0xff;
2597 /* If the controller has a pio mode setup function
2598 * then use it to set the chipset to rights. Don't
2599 * touch the DMA setup as that will be dealt with when
2600 * configuring devices.
2602 if (ap->ops->set_piomode)
2603 ap->ops->set_piomode(ap, dev);
2606 /* reset and determine device classes */
2607 ap->ops->phy_reset(ap);
2609 ata_for_each_dev(dev, &ap->link, ALL) {
2610 if (dev->class != ATA_DEV_UNKNOWN)
2611 classes[dev->devno] = dev->class;
2612 else
2613 classes[dev->devno] = ATA_DEV_NONE;
2615 dev->class = ATA_DEV_UNKNOWN;
2618 /* read IDENTIFY page and configure devices. We have to do the identify
2619 specific sequence bass-ackwards so that PDIAG- is released by
2620 the slave device */
2622 ata_for_each_dev(dev, &ap->link, ALL_REVERSE) {
2623 if (tries[dev->devno])
2624 dev->class = classes[dev->devno];
2626 if (!ata_dev_enabled(dev))
2627 continue;
2629 rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
2630 dev->id);
2631 if (rc)
2632 goto fail;
2635 /* Now ask for the cable type as PDIAG- should have been released */
2636 if (ap->ops->cable_detect)
2637 ap->cbl = ap->ops->cable_detect(ap);
2639 /* We may have SATA bridge glue hiding here irrespective of
2640 * the reported cable types and sensed types. When SATA
2641 * drives indicate we have a bridge, we don't know which end
2642 * of the link the bridge is which is a problem.
2644 ata_for_each_dev(dev, &ap->link, ENABLED)
2645 if (ata_id_is_sata(dev->id))
2646 ap->cbl = ATA_CBL_SATA;
2648 /* After the identify sequence we can now set up the devices. We do
2649 this in the normal order so that the user doesn't get confused */
2651 ata_for_each_dev(dev, &ap->link, ENABLED) {
2652 ap->link.eh_context.i.flags |= ATA_EHI_PRINTINFO;
2653 rc = ata_dev_configure(dev);
2654 ap->link.eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
2655 if (rc)
2656 goto fail;
2659 /* configure transfer mode */
2660 rc = ata_set_mode(&ap->link, &dev);
2661 if (rc)
2662 goto fail;
2664 ata_for_each_dev(dev, &ap->link, ENABLED)
2665 return 0;
2667 return -ENODEV;
2669 fail:
2670 tries[dev->devno]--;
2672 switch (rc) {
2673 case -EINVAL:
2674 /* eeek, something went very wrong, give up */
2675 tries[dev->devno] = 0;
2676 break;
2678 case -ENODEV:
2679 /* give it just one more chance */
2680 tries[dev->devno] = min(tries[dev->devno], 1);
2681 case -EIO:
2682 if (tries[dev->devno] == 1) {
2683 /* This is the last chance, better to slow
2684 * down than lose it.
2686 sata_down_spd_limit(&ap->link, 0);
2687 ata_down_xfermask_limit(dev, ATA_DNXFER_PIO);
2691 if (!tries[dev->devno])
2692 ata_dev_disable(dev);
2694 goto retry;
2698 * sata_print_link_status - Print SATA link status
2699 * @link: SATA link to printk link status about
2701 * This function prints link speed and status of a SATA link.
2703 * LOCKING:
2704 * None.
2706 static void sata_print_link_status(struct ata_link *link)
2708 u32 sstatus, scontrol, tmp;
2710 if (sata_scr_read(link, SCR_STATUS, &sstatus))
2711 return;
2712 sata_scr_read(link, SCR_CONTROL, &scontrol);
2714 if (ata_phys_link_online(link)) {
2715 tmp = (sstatus >> 4) & 0xf;
2716 ata_link_info(link, "SATA link up %s (SStatus %X SControl %X)\n",
2717 sata_spd_string(tmp), sstatus, scontrol);
2718 } else {
2719 ata_link_info(link, "SATA link down (SStatus %X SControl %X)\n",
2720 sstatus, scontrol);
2725 * ata_dev_pair - return other device on cable
2726 * @adev: device
2728 * Obtain the other device on the same cable, or if none is
2729 * present NULL is returned
2732 struct ata_device *ata_dev_pair(struct ata_device *adev)
2734 struct ata_link *link = adev->link;
2735 struct ata_device *pair = &link->device[1 - adev->devno];
2736 if (!ata_dev_enabled(pair))
2737 return NULL;
2738 return pair;
2742 * sata_down_spd_limit - adjust SATA spd limit downward
2743 * @link: Link to adjust SATA spd limit for
2744 * @spd_limit: Additional limit
2746 * Adjust SATA spd limit of @link downward. Note that this
2747 * function only adjusts the limit. The change must be applied
2748 * using sata_set_spd().
2750 * If @spd_limit is non-zero, the speed is limited to equal to or
2751 * lower than @spd_limit if such speed is supported. If
2752 * @spd_limit is slower than any supported speed, only the lowest
2753 * supported speed is allowed.
2755 * LOCKING:
2756 * Inherited from caller.
2758 * RETURNS:
2759 * 0 on success, negative errno on failure
2761 int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
2763 u32 sstatus, spd, mask;
2764 int rc, bit;
2766 if (!sata_scr_valid(link))
2767 return -EOPNOTSUPP;
2769 /* If SCR can be read, use it to determine the current SPD.
2770 * If not, use cached value in link->sata_spd.
2772 rc = sata_scr_read(link, SCR_STATUS, &sstatus);
2773 if (rc == 0 && ata_sstatus_online(sstatus))
2774 spd = (sstatus >> 4) & 0xf;
2775 else
2776 spd = link->sata_spd;
2778 mask = link->sata_spd_limit;
2779 if (mask <= 1)
2780 return -EINVAL;
2782 /* unconditionally mask off the highest bit */
2783 bit = fls(mask) - 1;
2784 mask &= ~(1 << bit);
2786 /* Mask off all speeds higher than or equal to the current
2787 * one. Force 1.5Gbps if current SPD is not available.
2789 if (spd > 1)
2790 mask &= (1 << (spd - 1)) - 1;
2791 else
2792 mask &= 1;
2794 /* were we already at the bottom? */
2795 if (!mask)
2796 return -EINVAL;
2798 if (spd_limit) {
2799 if (mask & ((1 << spd_limit) - 1))
2800 mask &= (1 << spd_limit) - 1;
2801 else {
2802 bit = ffs(mask) - 1;
2803 mask = 1 << bit;
2807 link->sata_spd_limit = mask;
2809 ata_link_warn(link, "limiting SATA link speed to %s\n",
2810 sata_spd_string(fls(mask)));
2812 return 0;
2815 static int __sata_set_spd_needed(struct ata_link *link, u32 *scontrol)
2817 struct ata_link *host_link = &link->ap->link;
2818 u32 limit, target, spd;
2820 limit = link->sata_spd_limit;
2822 /* Don't configure downstream link faster than upstream link.
2823 * It doesn't speed up anything and some PMPs choke on such
2824 * configuration.
2826 if (!ata_is_host_link(link) && host_link->sata_spd)
2827 limit &= (1 << host_link->sata_spd) - 1;
2829 if (limit == UINT_MAX)
2830 target = 0;
2831 else
2832 target = fls(limit);
2834 spd = (*scontrol >> 4) & 0xf;
2835 *scontrol = (*scontrol & ~0xf0) | ((target & 0xf) << 4);
2837 return spd != target;
2841 * sata_set_spd_needed - is SATA spd configuration needed
2842 * @link: Link in question
2844 * Test whether the spd limit in SControl matches
2845 * @link->sata_spd_limit. This function is used to determine
2846 * whether hardreset is necessary to apply SATA spd
2847 * configuration.
2849 * LOCKING:
2850 * Inherited from caller.
2852 * RETURNS:
2853 * 1 if SATA spd configuration is needed, 0 otherwise.
2855 static int sata_set_spd_needed(struct ata_link *link)
2857 u32 scontrol;
2859 if (sata_scr_read(link, SCR_CONTROL, &scontrol))
2860 return 1;
2862 return __sata_set_spd_needed(link, &scontrol);
2866 * sata_set_spd - set SATA spd according to spd limit
2867 * @link: Link to set SATA spd for
2869 * Set SATA spd of @link according to sata_spd_limit.
2871 * LOCKING:
2872 * Inherited from caller.
2874 * RETURNS:
2875 * 0 if spd doesn't need to be changed, 1 if spd has been
2876 * changed. Negative errno if SCR registers are inaccessible.
2878 int sata_set_spd(struct ata_link *link)
2880 u32 scontrol;
2881 int rc;
2883 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
2884 return rc;
2886 if (!__sata_set_spd_needed(link, &scontrol))
2887 return 0;
2889 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
2890 return rc;
2892 return 1;
2896 * This mode timing computation functionality is ported over from
2897 * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
2900 * PIO 0-4, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
2901 * These were taken from ATA/ATAPI-6 standard, rev 0a, except
2902 * for UDMA6, which is currently supported only by Maxtor drives.
2904 * For PIO 5/6 MWDMA 3/4 see the CFA specification 3.0.
2907 static const struct ata_timing ata_timing[] = {
2908 /* { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 0, 960, 0 }, */
2909 { XFER_PIO_0, 70, 290, 240, 600, 165, 150, 0, 600, 0 },
2910 { XFER_PIO_1, 50, 290, 93, 383, 125, 100, 0, 383, 0 },
2911 { XFER_PIO_2, 30, 290, 40, 330, 100, 90, 0, 240, 0 },
2912 { XFER_PIO_3, 30, 80, 70, 180, 80, 70, 0, 180, 0 },
2913 { XFER_PIO_4, 25, 70, 25, 120, 70, 25, 0, 120, 0 },
2914 { XFER_PIO_5, 15, 65, 25, 100, 65, 25, 0, 100, 0 },
2915 { XFER_PIO_6, 10, 55, 20, 80, 55, 20, 0, 80, 0 },
2917 { XFER_SW_DMA_0, 120, 0, 0, 0, 480, 480, 50, 960, 0 },
2918 { XFER_SW_DMA_1, 90, 0, 0, 0, 240, 240, 30, 480, 0 },
2919 { XFER_SW_DMA_2, 60, 0, 0, 0, 120, 120, 20, 240, 0 },
2921 { XFER_MW_DMA_0, 60, 0, 0, 0, 215, 215, 20, 480, 0 },
2922 { XFER_MW_DMA_1, 45, 0, 0, 0, 80, 50, 5, 150, 0 },
2923 { XFER_MW_DMA_2, 25, 0, 0, 0, 70, 25, 5, 120, 0 },
2924 { XFER_MW_DMA_3, 25, 0, 0, 0, 65, 25, 5, 100, 0 },
2925 { XFER_MW_DMA_4, 25, 0, 0, 0, 55, 20, 5, 80, 0 },
2927 /* { XFER_UDMA_SLOW, 0, 0, 0, 0, 0, 0, 0, 0, 150 }, */
2928 { XFER_UDMA_0, 0, 0, 0, 0, 0, 0, 0, 0, 120 },
2929 { XFER_UDMA_1, 0, 0, 0, 0, 0, 0, 0, 0, 80 },
2930 { XFER_UDMA_2, 0, 0, 0, 0, 0, 0, 0, 0, 60 },
2931 { XFER_UDMA_3, 0, 0, 0, 0, 0, 0, 0, 0, 45 },
2932 { XFER_UDMA_4, 0, 0, 0, 0, 0, 0, 0, 0, 30 },
2933 { XFER_UDMA_5, 0, 0, 0, 0, 0, 0, 0, 0, 20 },
2934 { XFER_UDMA_6, 0, 0, 0, 0, 0, 0, 0, 0, 15 },
2936 { 0xFF }
2939 #define ENOUGH(v, unit) (((v)-1)/(unit)+1)
2940 #define EZ(v, unit) ((v)?ENOUGH(v, unit):0)
2942 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
2944 q->setup = EZ(t->setup * 1000, T);
2945 q->act8b = EZ(t->act8b * 1000, T);
2946 q->rec8b = EZ(t->rec8b * 1000, T);
2947 q->cyc8b = EZ(t->cyc8b * 1000, T);
2948 q->active = EZ(t->active * 1000, T);
2949 q->recover = EZ(t->recover * 1000, T);
2950 q->dmack_hold = EZ(t->dmack_hold * 1000, T);
2951 q->cycle = EZ(t->cycle * 1000, T);
2952 q->udma = EZ(t->udma * 1000, UT);
2955 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
2956 struct ata_timing *m, unsigned int what)
2958 if (what & ATA_TIMING_SETUP ) m->setup = max(a->setup, b->setup);
2959 if (what & ATA_TIMING_ACT8B ) m->act8b = max(a->act8b, b->act8b);
2960 if (what & ATA_TIMING_REC8B ) m->rec8b = max(a->rec8b, b->rec8b);
2961 if (what & ATA_TIMING_CYC8B ) m->cyc8b = max(a->cyc8b, b->cyc8b);
2962 if (what & ATA_TIMING_ACTIVE ) m->active = max(a->active, b->active);
2963 if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
2964 if (what & ATA_TIMING_DMACK_HOLD) m->dmack_hold = max(a->dmack_hold, b->dmack_hold);
2965 if (what & ATA_TIMING_CYCLE ) m->cycle = max(a->cycle, b->cycle);
2966 if (what & ATA_TIMING_UDMA ) m->udma = max(a->udma, b->udma);
2969 const struct ata_timing *ata_timing_find_mode(u8 xfer_mode)
2971 const struct ata_timing *t = ata_timing;
2973 while (xfer_mode > t->mode)
2974 t++;
2976 if (xfer_mode == t->mode)
2977 return t;
2979 WARN_ONCE(true, "%s: unable to find timing for xfer_mode 0x%x\n",
2980 __func__, xfer_mode);
2982 return NULL;
2985 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
2986 struct ata_timing *t, int T, int UT)
2988 const u16 *id = adev->id;
2989 const struct ata_timing *s;
2990 struct ata_timing p;
2993 * Find the mode.
2996 if (!(s = ata_timing_find_mode(speed)))
2997 return -EINVAL;
2999 memcpy(t, s, sizeof(*s));
3002 * If the drive is an EIDE drive, it can tell us it needs extended
3003 * PIO/MW_DMA cycle timing.
3006 if (id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
3007 memset(&p, 0, sizeof(p));
3009 if (speed >= XFER_PIO_0 && speed < XFER_SW_DMA_0) {
3010 if (speed <= XFER_PIO_2)
3011 p.cycle = p.cyc8b = id[ATA_ID_EIDE_PIO];
3012 else if ((speed <= XFER_PIO_4) ||
3013 (speed == XFER_PIO_5 && !ata_id_is_cfa(id)))
3014 p.cycle = p.cyc8b = id[ATA_ID_EIDE_PIO_IORDY];
3015 } else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2)
3016 p.cycle = id[ATA_ID_EIDE_DMA_MIN];
3018 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
3022 * Convert the timing to bus clock counts.
3025 ata_timing_quantize(t, t, T, UT);
3028 * Even in DMA/UDMA modes we still use PIO access for IDENTIFY,
3029 * S.M.A.R.T * and some other commands. We have to ensure that the
3030 * DMA cycle timing is slower/equal than the fastest PIO timing.
3033 if (speed > XFER_PIO_6) {
3034 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
3035 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
3039 * Lengthen active & recovery time so that cycle time is correct.
3042 if (t->act8b + t->rec8b < t->cyc8b) {
3043 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
3044 t->rec8b = t->cyc8b - t->act8b;
3047 if (t->active + t->recover < t->cycle) {
3048 t->active += (t->cycle - (t->active + t->recover)) / 2;
3049 t->recover = t->cycle - t->active;
3052 /* In a few cases quantisation may produce enough errors to
3053 leave t->cycle too low for the sum of active and recovery
3054 if so we must correct this */
3055 if (t->active + t->recover > t->cycle)
3056 t->cycle = t->active + t->recover;
3058 return 0;
3062 * ata_timing_cycle2mode - find xfer mode for the specified cycle duration
3063 * @xfer_shift: ATA_SHIFT_* value for transfer type to examine.
3064 * @cycle: cycle duration in ns
3066 * Return matching xfer mode for @cycle. The returned mode is of
3067 * the transfer type specified by @xfer_shift. If @cycle is too
3068 * slow for @xfer_shift, 0xff is returned. If @cycle is faster
3069 * than the fastest known mode, the fasted mode is returned.
3071 * LOCKING:
3072 * None.
3074 * RETURNS:
3075 * Matching xfer_mode, 0xff if no match found.
3077 u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle)
3079 u8 base_mode = 0xff, last_mode = 0xff;
3080 const struct ata_xfer_ent *ent;
3081 const struct ata_timing *t;
3083 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
3084 if (ent->shift == xfer_shift)
3085 base_mode = ent->base;
3087 for (t = ata_timing_find_mode(base_mode);
3088 t && ata_xfer_mode2shift(t->mode) == xfer_shift; t++) {
3089 unsigned short this_cycle;
3091 switch (xfer_shift) {
3092 case ATA_SHIFT_PIO:
3093 case ATA_SHIFT_MWDMA:
3094 this_cycle = t->cycle;
3095 break;
3096 case ATA_SHIFT_UDMA:
3097 this_cycle = t->udma;
3098 break;
3099 default:
3100 return 0xff;
3103 if (cycle > this_cycle)
3104 break;
3106 last_mode = t->mode;
3109 return last_mode;
3113 * ata_down_xfermask_limit - adjust dev xfer masks downward
3114 * @dev: Device to adjust xfer masks
3115 * @sel: ATA_DNXFER_* selector
3117 * Adjust xfer masks of @dev downward. Note that this function
3118 * does not apply the change. Invoking ata_set_mode() afterwards
3119 * will apply the limit.
3121 * LOCKING:
3122 * Inherited from caller.
3124 * RETURNS:
3125 * 0 on success, negative errno on failure
3127 int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel)
3129 char buf[32];
3130 unsigned long orig_mask, xfer_mask;
3131 unsigned long pio_mask, mwdma_mask, udma_mask;
3132 int quiet, highbit;
3134 quiet = !!(sel & ATA_DNXFER_QUIET);
3135 sel &= ~ATA_DNXFER_QUIET;
3137 xfer_mask = orig_mask = ata_pack_xfermask(dev->pio_mask,
3138 dev->mwdma_mask,
3139 dev->udma_mask);
3140 ata_unpack_xfermask(xfer_mask, &pio_mask, &mwdma_mask, &udma_mask);
3142 switch (sel) {
3143 case ATA_DNXFER_PIO:
3144 highbit = fls(pio_mask) - 1;
3145 pio_mask &= ~(1 << highbit);
3146 break;
3148 case ATA_DNXFER_DMA:
3149 if (udma_mask) {
3150 highbit = fls(udma_mask) - 1;
3151 udma_mask &= ~(1 << highbit);
3152 if (!udma_mask)
3153 return -ENOENT;
3154 } else if (mwdma_mask) {
3155 highbit = fls(mwdma_mask) - 1;
3156 mwdma_mask &= ~(1 << highbit);
3157 if (!mwdma_mask)
3158 return -ENOENT;
3160 break;
3162 case ATA_DNXFER_40C:
3163 udma_mask &= ATA_UDMA_MASK_40C;
3164 break;
3166 case ATA_DNXFER_FORCE_PIO0:
3167 pio_mask &= 1;
3168 case ATA_DNXFER_FORCE_PIO:
3169 mwdma_mask = 0;
3170 udma_mask = 0;
3171 break;
3173 default:
3174 BUG();
3177 xfer_mask &= ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
3179 if (!(xfer_mask & ATA_MASK_PIO) || xfer_mask == orig_mask)
3180 return -ENOENT;
3182 if (!quiet) {
3183 if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
3184 snprintf(buf, sizeof(buf), "%s:%s",
3185 ata_mode_string(xfer_mask),
3186 ata_mode_string(xfer_mask & ATA_MASK_PIO));
3187 else
3188 snprintf(buf, sizeof(buf), "%s",
3189 ata_mode_string(xfer_mask));
3191 ata_dev_warn(dev, "limiting speed to %s\n", buf);
3194 ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
3195 &dev->udma_mask);
3197 return 0;
3200 static int ata_dev_set_mode(struct ata_device *dev)
3202 struct ata_port *ap = dev->link->ap;
3203 struct ata_eh_context *ehc = &dev->link->eh_context;
3204 const bool nosetxfer = dev->horkage & ATA_HORKAGE_NOSETXFER;
3205 const char *dev_err_whine = "";
3206 int ign_dev_err = 0;
3207 unsigned int err_mask = 0;
3208 int rc;
3210 dev->flags &= ~ATA_DFLAG_PIO;
3211 if (dev->xfer_shift == ATA_SHIFT_PIO)
3212 dev->flags |= ATA_DFLAG_PIO;
3214 if (nosetxfer && ap->flags & ATA_FLAG_SATA && ata_id_is_sata(dev->id))
3215 dev_err_whine = " (SET_XFERMODE skipped)";
3216 else {
3217 if (nosetxfer)
3218 ata_dev_warn(dev,
3219 "NOSETXFER but PATA detected - can't "
3220 "skip SETXFER, might malfunction\n");
3221 err_mask = ata_dev_set_xfermode(dev);
3224 if (err_mask & ~AC_ERR_DEV)
3225 goto fail;
3227 /* revalidate */
3228 ehc->i.flags |= ATA_EHI_POST_SETMODE;
3229 rc = ata_dev_revalidate(dev, ATA_DEV_UNKNOWN, 0);
3230 ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
3231 if (rc)
3232 return rc;
3234 if (dev->xfer_shift == ATA_SHIFT_PIO) {
3235 /* Old CFA may refuse this command, which is just fine */
3236 if (ata_id_is_cfa(dev->id))
3237 ign_dev_err = 1;
3238 /* Catch several broken garbage emulations plus some pre
3239 ATA devices */
3240 if (ata_id_major_version(dev->id) == 0 &&
3241 dev->pio_mode <= XFER_PIO_2)
3242 ign_dev_err = 1;
3243 /* Some very old devices and some bad newer ones fail
3244 any kind of SET_XFERMODE request but support PIO0-2
3245 timings and no IORDY */
3246 if (!ata_id_has_iordy(dev->id) && dev->pio_mode <= XFER_PIO_2)
3247 ign_dev_err = 1;
3249 /* Early MWDMA devices do DMA but don't allow DMA mode setting.
3250 Don't fail an MWDMA0 set IFF the device indicates it is in MWDMA0 */
3251 if (dev->xfer_shift == ATA_SHIFT_MWDMA &&
3252 dev->dma_mode == XFER_MW_DMA_0 &&
3253 (dev->id[63] >> 8) & 1)
3254 ign_dev_err = 1;
3256 /* if the device is actually configured correctly, ignore dev err */
3257 if (dev->xfer_mode == ata_xfer_mask2mode(ata_id_xfermask(dev->id)))
3258 ign_dev_err = 1;
3260 if (err_mask & AC_ERR_DEV) {
3261 if (!ign_dev_err)
3262 goto fail;
3263 else
3264 dev_err_whine = " (device error ignored)";
3267 DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
3268 dev->xfer_shift, (int)dev->xfer_mode);
3270 ata_dev_info(dev, "configured for %s%s\n",
3271 ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)),
3272 dev_err_whine);
3274 return 0;
3276 fail:
3277 ata_dev_err(dev, "failed to set xfermode (err_mask=0x%x)\n", err_mask);
3278 return -EIO;
3282 * ata_do_set_mode - Program timings and issue SET FEATURES - XFER
3283 * @link: link on which timings will be programmed
3284 * @r_failed_dev: out parameter for failed device
3286 * Standard implementation of the function used to tune and set
3287 * ATA device disk transfer mode (PIO3, UDMA6, etc.). If
3288 * ata_dev_set_mode() fails, pointer to the failing device is
3289 * returned in @r_failed_dev.
3291 * LOCKING:
3292 * PCI/etc. bus probe sem.
3294 * RETURNS:
3295 * 0 on success, negative errno otherwise
3298 int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
3300 struct ata_port *ap = link->ap;
3301 struct ata_device *dev;
3302 int rc = 0, used_dma = 0, found = 0;
3304 /* step 1: calculate xfer_mask */
3305 ata_for_each_dev(dev, link, ENABLED) {
3306 unsigned long pio_mask, dma_mask;
3307 unsigned int mode_mask;
3309 mode_mask = ATA_DMA_MASK_ATA;
3310 if (dev->class == ATA_DEV_ATAPI)
3311 mode_mask = ATA_DMA_MASK_ATAPI;
3312 else if (ata_id_is_cfa(dev->id))
3313 mode_mask = ATA_DMA_MASK_CFA;
3315 ata_dev_xfermask(dev);
3316 ata_force_xfermask(dev);
3318 pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);
3320 if (libata_dma_mask & mode_mask)
3321 dma_mask = ata_pack_xfermask(0, dev->mwdma_mask,
3322 dev->udma_mask);
3323 else
3324 dma_mask = 0;
3326 dev->pio_mode = ata_xfer_mask2mode(pio_mask);
3327 dev->dma_mode = ata_xfer_mask2mode(dma_mask);
3329 found = 1;
3330 if (ata_dma_enabled(dev))
3331 used_dma = 1;
3333 if (!found)
3334 goto out;
3336 /* step 2: always set host PIO timings */
3337 ata_for_each_dev(dev, link, ENABLED) {
3338 if (dev->pio_mode == 0xff) {
3339 ata_dev_warn(dev, "no PIO support\n");
3340 rc = -EINVAL;
3341 goto out;
3344 dev->xfer_mode = dev->pio_mode;
3345 dev->xfer_shift = ATA_SHIFT_PIO;
3346 if (ap->ops->set_piomode)
3347 ap->ops->set_piomode(ap, dev);
3350 /* step 3: set host DMA timings */
3351 ata_for_each_dev(dev, link, ENABLED) {
3352 if (!ata_dma_enabled(dev))
3353 continue;
3355 dev->xfer_mode = dev->dma_mode;
3356 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
3357 if (ap->ops->set_dmamode)
3358 ap->ops->set_dmamode(ap, dev);
3361 /* step 4: update devices' xfer mode */
3362 ata_for_each_dev(dev, link, ENABLED) {
3363 rc = ata_dev_set_mode(dev);
3364 if (rc)
3365 goto out;
3368 /* Record simplex status. If we selected DMA then the other
3369 * host channels are not permitted to do so.
3371 if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
3372 ap->host->simplex_claimed = ap;
3374 out:
3375 if (rc)
3376 *r_failed_dev = dev;
3377 return rc;
3381 * ata_wait_ready - wait for link to become ready
3382 * @link: link to be waited on
3383 * @deadline: deadline jiffies for the operation
3384 * @check_ready: callback to check link readiness
3386 * Wait for @link to become ready. @check_ready should return
3387 * positive number if @link is ready, 0 if it isn't, -ENODEV if
3388 * link doesn't seem to be occupied, other errno for other error
3389 * conditions.
3391 * Transient -ENODEV conditions are allowed for
3392 * ATA_TMOUT_FF_WAIT.
3394 * LOCKING:
3395 * EH context.
3397 * RETURNS:
3398 * 0 if @linke is ready before @deadline; otherwise, -errno.
3400 int ata_wait_ready(struct ata_link *link, unsigned long deadline,
3401 int (*check_ready)(struct ata_link *link))
3403 unsigned long start = jiffies;
3404 unsigned long nodev_deadline;
3405 int warned = 0;
3407 /* choose which 0xff timeout to use, read comment in libata.h */
3408 if (link->ap->host->flags & ATA_HOST_PARALLEL_SCAN)
3409 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT_LONG);
3410 else
3411 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT);
3413 /* Slave readiness can't be tested separately from master. On
3414 * M/S emulation configuration, this function should be called
3415 * only on the master and it will handle both master and slave.
3417 WARN_ON(link == link->ap->slave_link);
3419 if (time_after(nodev_deadline, deadline))
3420 nodev_deadline = deadline;
3422 while (1) {
3423 unsigned long now = jiffies;
3424 int ready, tmp;
3426 ready = tmp = check_ready(link);
3427 if (ready > 0)
3428 return 0;
3431 * -ENODEV could be transient. Ignore -ENODEV if link
3432 * is online. Also, some SATA devices take a long
3433 * time to clear 0xff after reset. Wait for
3434 * ATA_TMOUT_FF_WAIT[_LONG] on -ENODEV if link isn't
3435 * offline.
3437 * Note that some PATA controllers (pata_ali) explode
3438 * if status register is read more than once when
3439 * there's no device attached.
3441 if (ready == -ENODEV) {
3442 if (ata_link_online(link))
3443 ready = 0;
3444 else if ((link->ap->flags & ATA_FLAG_SATA) &&
3445 !ata_link_offline(link) &&
3446 time_before(now, nodev_deadline))
3447 ready = 0;
3450 if (ready)
3451 return ready;
3452 if (time_after(now, deadline))
3453 return -EBUSY;
3455 if (!warned && time_after(now, start + 5 * HZ) &&
3456 (deadline - now > 3 * HZ)) {
3457 ata_link_warn(link,
3458 "link is slow to respond, please be patient "
3459 "(ready=%d)\n", tmp);
3460 warned = 1;
3463 ata_msleep(link->ap, 50);
3468 * ata_wait_after_reset - wait for link to become ready after reset
3469 * @link: link to be waited on
3470 * @deadline: deadline jiffies for the operation
3471 * @check_ready: callback to check link readiness
3473 * Wait for @link to become ready after reset.
3475 * LOCKING:
3476 * EH context.
3478 * RETURNS:
3479 * 0 if @linke is ready before @deadline; otherwise, -errno.
3481 int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
3482 int (*check_ready)(struct ata_link *link))
3484 ata_msleep(link->ap, ATA_WAIT_AFTER_RESET);
3486 return ata_wait_ready(link, deadline, check_ready);
3490 * sata_link_debounce - debounce SATA phy status
3491 * @link: ATA link to debounce SATA phy status for
3492 * @params: timing parameters { interval, duratinon, timeout } in msec
3493 * @deadline: deadline jiffies for the operation
3495 * Make sure SStatus of @link reaches stable state, determined by
3496 * holding the same value where DET is not 1 for @duration polled
3497 * every @interval, before @timeout. Timeout constraints the
3498 * beginning of the stable state. Because DET gets stuck at 1 on
3499 * some controllers after hot unplugging, this functions waits
3500 * until timeout then returns 0 if DET is stable at 1.
3502 * @timeout is further limited by @deadline. The sooner of the
3503 * two is used.
3505 * LOCKING:
3506 * Kernel thread context (may sleep)
3508 * RETURNS:
3509 * 0 on success, -errno on failure.
3511 int sata_link_debounce(struct ata_link *link, const unsigned long *params,
3512 unsigned long deadline)
3514 unsigned long interval = params[0];
3515 unsigned long duration = params[1];
3516 unsigned long last_jiffies, t;
3517 u32 last, cur;
3518 int rc;
3520 t = ata_deadline(jiffies, params[2]);
3521 if (time_before(t, deadline))
3522 deadline = t;
3524 if ((rc = sata_scr_read(link, SCR_STATUS, &cur)))
3525 return rc;
3526 cur &= 0xf;
3528 last = cur;
3529 last_jiffies = jiffies;
3531 while (1) {
3532 ata_msleep(link->ap, interval);
3533 if ((rc = sata_scr_read(link, SCR_STATUS, &cur)))
3534 return rc;
3535 cur &= 0xf;
3537 /* DET stable? */
3538 if (cur == last) {
3539 if (cur == 1 && time_before(jiffies, deadline))
3540 continue;
3541 if (time_after(jiffies,
3542 ata_deadline(last_jiffies, duration)))
3543 return 0;
3544 continue;
3547 /* unstable, start over */
3548 last = cur;
3549 last_jiffies = jiffies;
3551 /* Check deadline. If debouncing failed, return
3552 * -EPIPE to tell upper layer to lower link speed.
3554 if (time_after(jiffies, deadline))
3555 return -EPIPE;
3560 * sata_link_resume - resume SATA link
3561 * @link: ATA link to resume SATA
3562 * @params: timing parameters { interval, duratinon, timeout } in msec
3563 * @deadline: deadline jiffies for the operation
3565 * Resume SATA phy @link and debounce it.
3567 * LOCKING:
3568 * Kernel thread context (may sleep)
3570 * RETURNS:
3571 * 0 on success, -errno on failure.
3573 int sata_link_resume(struct ata_link *link, const unsigned long *params,
3574 unsigned long deadline)
3576 int tries = ATA_LINK_RESUME_TRIES;
3577 u32 scontrol, serror;
3578 int rc;
3580 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3581 return rc;
3584 * Writes to SControl sometimes get ignored under certain
3585 * controllers (ata_piix SIDPR). Make sure DET actually is
3586 * cleared.
3588 do {
3589 scontrol = (scontrol & 0x0f0) | 0x300;
3590 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
3591 return rc;
3593 * Some PHYs react badly if SStatus is pounded
3594 * immediately after resuming. Delay 200ms before
3595 * debouncing.
3597 ata_msleep(link->ap, 200);
3599 /* is SControl restored correctly? */
3600 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3601 return rc;
3602 } while ((scontrol & 0xf0f) != 0x300 && --tries);
3604 if ((scontrol & 0xf0f) != 0x300) {
3605 ata_link_warn(link, "failed to resume link (SControl %X)\n",
3606 scontrol);
3607 return 0;
3610 if (tries < ATA_LINK_RESUME_TRIES)
3611 ata_link_warn(link, "link resume succeeded after %d retries\n",
3612 ATA_LINK_RESUME_TRIES - tries);
3614 if ((rc = sata_link_debounce(link, params, deadline)))
3615 return rc;
3617 /* clear SError, some PHYs require this even for SRST to work */
3618 if (!(rc = sata_scr_read(link, SCR_ERROR, &serror)))
3619 rc = sata_scr_write(link, SCR_ERROR, serror);
3621 return rc != -EINVAL ? rc : 0;
3625 * sata_link_scr_lpm - manipulate SControl IPM and SPM fields
3626 * @link: ATA link to manipulate SControl for
3627 * @policy: LPM policy to configure
3628 * @spm_wakeup: initiate LPM transition to active state
3630 * Manipulate the IPM field of the SControl register of @link
3631 * according to @policy. If @policy is ATA_LPM_MAX_POWER and
3632 * @spm_wakeup is %true, the SPM field is manipulated to wake up
3633 * the link. This function also clears PHYRDY_CHG before
3634 * returning.
3636 * LOCKING:
3637 * EH context.
3639 * RETURNS:
3640 * 0 on succes, -errno otherwise.
3642 int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
3643 bool spm_wakeup)
3645 struct ata_eh_context *ehc = &link->eh_context;
3646 bool woken_up = false;
3647 u32 scontrol;
3648 int rc;
3650 rc = sata_scr_read(link, SCR_CONTROL, &scontrol);
3651 if (rc)
3652 return rc;
3654 switch (policy) {
3655 case ATA_LPM_MAX_POWER:
3656 /* disable all LPM transitions */
3657 scontrol |= (0x7 << 8);
3658 /* initiate transition to active state */
3659 if (spm_wakeup) {
3660 scontrol |= (0x4 << 12);
3661 woken_up = true;
3663 break;
3664 case ATA_LPM_MED_POWER:
3665 /* allow LPM to PARTIAL */
3666 scontrol &= ~(0x1 << 8);
3667 scontrol |= (0x6 << 8);
3668 break;
3669 case ATA_LPM_MIN_POWER:
3670 if (ata_link_nr_enabled(link) > 0)
3671 /* no restrictions on LPM transitions */
3672 scontrol &= ~(0x7 << 8);
3673 else {
3674 /* empty port, power off */
3675 scontrol &= ~0xf;
3676 scontrol |= (0x1 << 2);
3678 break;
3679 default:
3680 WARN_ON(1);
3683 rc = sata_scr_write(link, SCR_CONTROL, scontrol);
3684 if (rc)
3685 return rc;
3687 /* give the link time to transit out of LPM state */
3688 if (woken_up)
3689 msleep(10);
3691 /* clear PHYRDY_CHG from SError */
3692 ehc->i.serror &= ~SERR_PHYRDY_CHG;
3693 return sata_scr_write(link, SCR_ERROR, SERR_PHYRDY_CHG);
3697 * ata_std_prereset - prepare for reset
3698 * @link: ATA link to be reset
3699 * @deadline: deadline jiffies for the operation
3701 * @link is about to be reset. Initialize it. Failure from
3702 * prereset makes libata abort whole reset sequence and give up
3703 * that port, so prereset should be best-effort. It does its
3704 * best to prepare for reset sequence but if things go wrong, it
3705 * should just whine, not fail.
3707 * LOCKING:
3708 * Kernel thread context (may sleep)
3710 * RETURNS:
3711 * 0 on success, -errno otherwise.
3713 int ata_std_prereset(struct ata_link *link, unsigned long deadline)
3715 struct ata_port *ap = link->ap;
3716 struct ata_eh_context *ehc = &link->eh_context;
3717 const unsigned long *timing = sata_ehc_deb_timing(ehc);
3718 int rc;
3720 /* if we're about to do hardreset, nothing more to do */
3721 if (ehc->i.action & ATA_EH_HARDRESET)
3722 return 0;
3724 /* if SATA, resume link */
3725 if (ap->flags & ATA_FLAG_SATA) {
3726 rc = sata_link_resume(link, timing, deadline);
3727 /* whine about phy resume failure but proceed */
3728 if (rc && rc != -EOPNOTSUPP)
3729 ata_link_warn(link,
3730 "failed to resume link for reset (errno=%d)\n",
3731 rc);
3734 /* no point in trying softreset on offline link */
3735 if (ata_phys_link_offline(link))
3736 ehc->i.action &= ~ATA_EH_SOFTRESET;
3738 return 0;
3742 * sata_link_hardreset - reset link via SATA phy reset
3743 * @link: link to reset
3744 * @timing: timing parameters { interval, duratinon, timeout } in msec
3745 * @deadline: deadline jiffies for the operation
3746 * @online: optional out parameter indicating link onlineness
3747 * @check_ready: optional callback to check link readiness
3749 * SATA phy-reset @link using DET bits of SControl register.
3750 * After hardreset, link readiness is waited upon using
3751 * ata_wait_ready() if @check_ready is specified. LLDs are
3752 * allowed to not specify @check_ready and wait itself after this
3753 * function returns. Device classification is LLD's
3754 * responsibility.
3756 * *@online is set to one iff reset succeeded and @link is online
3757 * after reset.
3759 * LOCKING:
3760 * Kernel thread context (may sleep)
3762 * RETURNS:
3763 * 0 on success, -errno otherwise.
3765 int sata_link_hardreset(struct ata_link *link, const unsigned long *timing,
3766 unsigned long deadline,
3767 bool *online, int (*check_ready)(struct ata_link *))
3769 u32 scontrol;
3770 int rc;
3772 DPRINTK("ENTER\n");
3774 if (online)
3775 *online = false;
3777 if (sata_set_spd_needed(link)) {
3778 /* SATA spec says nothing about how to reconfigure
3779 * spd. To be on the safe side, turn off phy during
3780 * reconfiguration. This works for at least ICH7 AHCI
3781 * and Sil3124.
3783 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3784 goto out;
3786 scontrol = (scontrol & 0x0f0) | 0x304;
3788 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
3789 goto out;
3791 sata_set_spd(link);
3794 /* issue phy wake/reset */
3795 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3796 goto out;
3798 scontrol = (scontrol & 0x0f0) | 0x301;
3800 if ((rc = sata_scr_write_flush(link, SCR_CONTROL, scontrol)))
3801 goto out;
3803 /* Couldn't find anything in SATA I/II specs, but AHCI-1.1
3804 * 10.4.2 says at least 1 ms.
3806 ata_msleep(link->ap, 1);
3808 /* bring link back */
3809 rc = sata_link_resume(link, timing, deadline);
3810 if (rc)
3811 goto out;
3812 /* if link is offline nothing more to do */
3813 if (ata_phys_link_offline(link))
3814 goto out;
3816 /* Link is online. From this point, -ENODEV too is an error. */
3817 if (online)
3818 *online = true;
3820 if (sata_pmp_supported(link->ap) && ata_is_host_link(link)) {
3821 /* If PMP is supported, we have to do follow-up SRST.
3822 * Some PMPs don't send D2H Reg FIS after hardreset if
3823 * the first port is empty. Wait only for
3824 * ATA_TMOUT_PMP_SRST_WAIT.
3826 if (check_ready) {
3827 unsigned long pmp_deadline;
3829 pmp_deadline = ata_deadline(jiffies,
3830 ATA_TMOUT_PMP_SRST_WAIT);
3831 if (time_after(pmp_deadline, deadline))
3832 pmp_deadline = deadline;
3833 ata_wait_ready(link, pmp_deadline, check_ready);
3835 rc = -EAGAIN;
3836 goto out;
3839 rc = 0;
3840 if (check_ready)
3841 rc = ata_wait_ready(link, deadline, check_ready);
3842 out:
3843 if (rc && rc != -EAGAIN) {
3844 /* online is set iff link is online && reset succeeded */
3845 if (online)
3846 *online = false;
3847 ata_link_err(link, "COMRESET failed (errno=%d)\n", rc);
3849 DPRINTK("EXIT, rc=%d\n", rc);
3850 return rc;
3854 * sata_std_hardreset - COMRESET w/o waiting or classification
3855 * @link: link to reset
3856 * @class: resulting class of attached device
3857 * @deadline: deadline jiffies for the operation
3859 * Standard SATA COMRESET w/o waiting or classification.
3861 * LOCKING:
3862 * Kernel thread context (may sleep)
3864 * RETURNS:
3865 * 0 if link offline, -EAGAIN if link online, -errno on errors.
3867 int sata_std_hardreset(struct ata_link *link, unsigned int *class,
3868 unsigned long deadline)
3870 const unsigned long *timing = sata_ehc_deb_timing(&link->eh_context);
3871 bool online;
3872 int rc;
3874 /* do hardreset */
3875 rc = sata_link_hardreset(link, timing, deadline, &online, NULL);
3876 return online ? -EAGAIN : rc;
3880 * ata_std_postreset - standard postreset callback
3881 * @link: the target ata_link
3882 * @classes: classes of attached devices
3884 * This function is invoked after a successful reset. Note that
3885 * the device might have been reset more than once using
3886 * different reset methods before postreset is invoked.
3888 * LOCKING:
3889 * Kernel thread context (may sleep)
3891 void ata_std_postreset(struct ata_link *link, unsigned int *classes)
3893 u32 serror;
3895 DPRINTK("ENTER\n");
3897 /* reset complete, clear SError */
3898 if (!sata_scr_read(link, SCR_ERROR, &serror))
3899 sata_scr_write(link, SCR_ERROR, serror);
3901 /* print link status */
3902 sata_print_link_status(link);
3904 DPRINTK("EXIT\n");
3908 * ata_dev_same_device - Determine whether new ID matches configured device
3909 * @dev: device to compare against
3910 * @new_class: class of the new device
3911 * @new_id: IDENTIFY page of the new device
3913 * Compare @new_class and @new_id against @dev and determine
3914 * whether @dev is the device indicated by @new_class and
3915 * @new_id.
3917 * LOCKING:
3918 * None.
3920 * RETURNS:
3921 * 1 if @dev matches @new_class and @new_id, 0 otherwise.
3923 static int ata_dev_same_device(struct ata_device *dev, unsigned int new_class,
3924 const u16 *new_id)
3926 const u16 *old_id = dev->id;
3927 unsigned char model[2][ATA_ID_PROD_LEN + 1];
3928 unsigned char serial[2][ATA_ID_SERNO_LEN + 1];
3930 if (dev->class != new_class) {
3931 ata_dev_info(dev, "class mismatch %d != %d\n",
3932 dev->class, new_class);
3933 return 0;
3936 ata_id_c_string(old_id, model[0], ATA_ID_PROD, sizeof(model[0]));
3937 ata_id_c_string(new_id, model[1], ATA_ID_PROD, sizeof(model[1]));
3938 ata_id_c_string(old_id, serial[0], ATA_ID_SERNO, sizeof(serial[0]));
3939 ata_id_c_string(new_id, serial[1], ATA_ID_SERNO, sizeof(serial[1]));
3941 if (strcmp(model[0], model[1])) {
3942 ata_dev_info(dev, "model number mismatch '%s' != '%s'\n",
3943 model[0], model[1]);
3944 return 0;
3947 if (strcmp(serial[0], serial[1])) {
3948 ata_dev_info(dev, "serial number mismatch '%s' != '%s'\n",
3949 serial[0], serial[1]);
3950 return 0;
3953 return 1;
3957 * ata_dev_reread_id - Re-read IDENTIFY data
3958 * @dev: target ATA device
3959 * @readid_flags: read ID flags
3961 * Re-read IDENTIFY page and make sure @dev is still attached to
3962 * the port.
3964 * LOCKING:
3965 * Kernel thread context (may sleep)
3967 * RETURNS:
3968 * 0 on success, negative errno otherwise
3970 int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags)
3972 unsigned int class = dev->class;
3973 u16 *id = (void *)dev->link->ap->sector_buf;
3974 int rc;
3976 /* read ID data */
3977 rc = ata_dev_read_id(dev, &class, readid_flags, id);
3978 if (rc)
3979 return rc;
3981 /* is the device still there? */
3982 if (!ata_dev_same_device(dev, class, id))
3983 return -ENODEV;
3985 memcpy(dev->id, id, sizeof(id[0]) * ATA_ID_WORDS);
3986 return 0;
3990 * ata_dev_revalidate - Revalidate ATA device
3991 * @dev: device to revalidate
3992 * @new_class: new class code
3993 * @readid_flags: read ID flags
3995 * Re-read IDENTIFY page, make sure @dev is still attached to the
3996 * port and reconfigure it according to the new IDENTIFY page.
3998 * LOCKING:
3999 * Kernel thread context (may sleep)
4001 * RETURNS:
4002 * 0 on success, negative errno otherwise
4004 int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
4005 unsigned int readid_flags)
4007 u64 n_sectors = dev->n_sectors;
4008 u64 n_native_sectors = dev->n_native_sectors;
4009 int rc;
4011 if (!ata_dev_enabled(dev))
4012 return -ENODEV;
4014 /* fail early if !ATA && !ATAPI to avoid issuing [P]IDENTIFY to PMP */
4015 if (ata_class_enabled(new_class) &&
4016 new_class != ATA_DEV_ATA &&
4017 new_class != ATA_DEV_ATAPI &&
4018 new_class != ATA_DEV_SEMB) {
4019 ata_dev_info(dev, "class mismatch %u != %u\n",
4020 dev->class, new_class);
4021 rc = -ENODEV;
4022 goto fail;
4025 /* re-read ID */
4026 rc = ata_dev_reread_id(dev, readid_flags);
4027 if (rc)
4028 goto fail;
4030 /* configure device according to the new ID */
4031 rc = ata_dev_configure(dev);
4032 if (rc)
4033 goto fail;
4035 /* verify n_sectors hasn't changed */
4036 if (dev->class != ATA_DEV_ATA || !n_sectors ||
4037 dev->n_sectors == n_sectors)
4038 return 0;
4040 /* n_sectors has changed */
4041 ata_dev_warn(dev, "n_sectors mismatch %llu != %llu\n",
4042 (unsigned long long)n_sectors,
4043 (unsigned long long)dev->n_sectors);
4046 * Something could have caused HPA to be unlocked
4047 * involuntarily. If n_native_sectors hasn't changed and the
4048 * new size matches it, keep the device.
4050 if (dev->n_native_sectors == n_native_sectors &&
4051 dev->n_sectors > n_sectors && dev->n_sectors == n_native_sectors) {
4052 ata_dev_warn(dev,
4053 "new n_sectors matches native, probably "
4054 "late HPA unlock, n_sectors updated\n");
4055 /* use the larger n_sectors */
4056 return 0;
4060 * Some BIOSes boot w/o HPA but resume w/ HPA locked. Try
4061 * unlocking HPA in those cases.
4063 * https://bugzilla.kernel.org/show_bug.cgi?id=15396
4065 if (dev->n_native_sectors == n_native_sectors &&
4066 dev->n_sectors < n_sectors && n_sectors == n_native_sectors &&
4067 !(dev->horkage & ATA_HORKAGE_BROKEN_HPA)) {
4068 ata_dev_warn(dev,
4069 "old n_sectors matches native, probably "
4070 "late HPA lock, will try to unlock HPA\n");
4071 /* try unlocking HPA */
4072 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
4073 rc = -EIO;
4074 } else
4075 rc = -ENODEV;
4077 /* restore original n_[native_]sectors and fail */
4078 dev->n_native_sectors = n_native_sectors;
4079 dev->n_sectors = n_sectors;
4080 fail:
4081 ata_dev_err(dev, "revalidation failed (errno=%d)\n", rc);
4082 return rc;
4085 struct ata_blacklist_entry {
4086 const char *model_num;
4087 const char *model_rev;
4088 unsigned long horkage;
4091 static const struct ata_blacklist_entry ata_device_blacklist [] = {
4092 /* Devices with DMA related problems under Linux */
4093 { "WDC AC11000H", NULL, ATA_HORKAGE_NODMA },
4094 { "WDC AC22100H", NULL, ATA_HORKAGE_NODMA },
4095 { "WDC AC32500H", NULL, ATA_HORKAGE_NODMA },
4096 { "WDC AC33100H", NULL, ATA_HORKAGE_NODMA },
4097 { "WDC AC31600H", NULL, ATA_HORKAGE_NODMA },
4098 { "WDC AC32100H", "24.09P07", ATA_HORKAGE_NODMA },
4099 { "WDC AC23200L", "21.10N21", ATA_HORKAGE_NODMA },
4100 { "Compaq CRD-8241B", NULL, ATA_HORKAGE_NODMA },
4101 { "CRD-8400B", NULL, ATA_HORKAGE_NODMA },
4102 { "CRD-848[02]B", NULL, ATA_HORKAGE_NODMA },
4103 { "CRD-84", NULL, ATA_HORKAGE_NODMA },
4104 { "SanDisk SDP3B", NULL, ATA_HORKAGE_NODMA },
4105 { "SanDisk SDP3B-64", NULL, ATA_HORKAGE_NODMA },
4106 { "SANYO CD-ROM CRD", NULL, ATA_HORKAGE_NODMA },
4107 { "HITACHI CDR-8", NULL, ATA_HORKAGE_NODMA },
4108 { "HITACHI CDR-8[34]35",NULL, ATA_HORKAGE_NODMA },
4109 { "Toshiba CD-ROM XM-6202B", NULL, ATA_HORKAGE_NODMA },
4110 { "TOSHIBA CD-ROM XM-1702BC", NULL, ATA_HORKAGE_NODMA },
4111 { "CD-532E-A", NULL, ATA_HORKAGE_NODMA },
4112 { "E-IDE CD-ROM CR-840",NULL, ATA_HORKAGE_NODMA },
4113 { "CD-ROM Drive/F5A", NULL, ATA_HORKAGE_NODMA },
4114 { "WPI CDD-820", NULL, ATA_HORKAGE_NODMA },
4115 { "SAMSUNG CD-ROM SC-148C", NULL, ATA_HORKAGE_NODMA },
4116 { "SAMSUNG CD-ROM SC", NULL, ATA_HORKAGE_NODMA },
4117 { "ATAPI CD-ROM DRIVE 40X MAXIMUM",NULL,ATA_HORKAGE_NODMA },
4118 { "_NEC DV5800A", NULL, ATA_HORKAGE_NODMA },
4119 { "SAMSUNG CD-ROM SN-124", "N001", ATA_HORKAGE_NODMA },
4120 { "Seagate STT20000A", NULL, ATA_HORKAGE_NODMA },
4121 { " 2GB ATA Flash Disk", "ADMA428M", ATA_HORKAGE_NODMA },
4122 /* Odd clown on sil3726/4726 PMPs */
4123 { "Config Disk", NULL, ATA_HORKAGE_DISABLE },
4125 /* Weird ATAPI devices */
4126 { "TORiSAN DVD-ROM DRD-N216", NULL, ATA_HORKAGE_MAX_SEC_128 },
4127 { "QUANTUM DAT DAT72-000", NULL, ATA_HORKAGE_ATAPI_MOD16_DMA },
4128 { "Slimtype DVD A DS8A8SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
4130 /* Devices we expect to fail diagnostics */
4132 /* Devices where NCQ should be avoided */
4133 /* NCQ is slow */
4134 { "WDC WD740ADFD-00", NULL, ATA_HORKAGE_NONCQ },
4135 { "WDC WD740ADFD-00NLR1", NULL, ATA_HORKAGE_NONCQ, },
4136 /* http://thread.gmane.org/gmane.linux.ide/14907 */
4137 { "FUJITSU MHT2060BH", NULL, ATA_HORKAGE_NONCQ },
4138 /* NCQ is broken */
4139 { "Maxtor *", "BANC*", ATA_HORKAGE_NONCQ },
4140 { "Maxtor 7V300F0", "VA111630", ATA_HORKAGE_NONCQ },
4141 { "ST380817AS", "3.42", ATA_HORKAGE_NONCQ },
4142 { "ST3160023AS", "3.42", ATA_HORKAGE_NONCQ },
4143 { "OCZ CORE_SSD", "02.10104", ATA_HORKAGE_NONCQ },
4145 /* Seagate NCQ + FLUSH CACHE firmware bug */
4146 { "ST31500341AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4147 ATA_HORKAGE_FIRMWARE_WARN },
4149 { "ST31000333AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4150 ATA_HORKAGE_FIRMWARE_WARN },
4152 { "ST3640[36]23AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4153 ATA_HORKAGE_FIRMWARE_WARN },
4155 { "ST3320[68]13AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4156 ATA_HORKAGE_FIRMWARE_WARN },
4158 /* Blacklist entries taken from Silicon Image 3124/3132
4159 Windows driver .inf file - also several Linux problem reports */
4160 { "HTS541060G9SA00", "MB3OC60D", ATA_HORKAGE_NONCQ, },
4161 { "HTS541080G9SA00", "MB4OC60D", ATA_HORKAGE_NONCQ, },
4162 { "HTS541010G9SA00", "MBZOC60D", ATA_HORKAGE_NONCQ, },
4164 /* https://bugzilla.kernel.org/show_bug.cgi?id=15573 */
4165 { "C300-CTFDDAC128MAG", "0001", ATA_HORKAGE_NONCQ, },
4167 /* devices which puke on READ_NATIVE_MAX */
4168 { "HDS724040KLSA80", "KFAOA20N", ATA_HORKAGE_BROKEN_HPA, },
4169 { "WDC WD3200JD-00KLB0", "WD-WCAMR1130137", ATA_HORKAGE_BROKEN_HPA },
4170 { "WDC WD2500JD-00HBB0", "WD-WMAL71490727", ATA_HORKAGE_BROKEN_HPA },
4171 { "MAXTOR 6L080L4", "A93.0500", ATA_HORKAGE_BROKEN_HPA },
4173 /* this one allows HPA unlocking but fails IOs on the area */
4174 { "OCZ-VERTEX", "1.30", ATA_HORKAGE_BROKEN_HPA },
4176 /* Devices which report 1 sector over size HPA */
4177 { "ST340823A", NULL, ATA_HORKAGE_HPA_SIZE, },
4178 { "ST320413A", NULL, ATA_HORKAGE_HPA_SIZE, },
4179 { "ST310211A", NULL, ATA_HORKAGE_HPA_SIZE, },
4181 /* Devices which get the IVB wrong */
4182 { "QUANTUM FIREBALLlct10 05", "A03.0900", ATA_HORKAGE_IVB, },
4183 /* Maybe we should just blacklist TSSTcorp... */
4184 { "TSSTcorp CDDVDW SH-S202[HJN]", "SB0[01]", ATA_HORKAGE_IVB, },
4186 /* Devices that do not need bridging limits applied */
4187 { "MTRON MSP-SATA*", NULL, ATA_HORKAGE_BRIDGE_OK, },
4188 { "BUFFALO HD-QSU2/R5", NULL, ATA_HORKAGE_BRIDGE_OK, },
4190 /* Devices which aren't very happy with higher link speeds */
4191 { "WD My Book", NULL, ATA_HORKAGE_1_5_GBPS, },
4192 { "Seagate FreeAgent GoFlex", NULL, ATA_HORKAGE_1_5_GBPS, },
4195 * Devices which choke on SETXFER. Applies only if both the
4196 * device and controller are SATA.
4198 { "PIONEER DVD-RW DVRTD08", NULL, ATA_HORKAGE_NOSETXFER },
4199 { "PIONEER DVD-RW DVRTD08A", NULL, ATA_HORKAGE_NOSETXFER },
4200 { "PIONEER DVD-RW DVR-215", NULL, ATA_HORKAGE_NOSETXFER },
4201 { "PIONEER DVD-RW DVR-212D", NULL, ATA_HORKAGE_NOSETXFER },
4202 { "PIONEER DVD-RW DVR-216D", NULL, ATA_HORKAGE_NOSETXFER },
4204 /* End Marker */
4209 * glob_match - match a text string against a glob-style pattern
4210 * @text: the string to be examined
4211 * @pattern: the glob-style pattern to be matched against
4213 * Either/both of text and pattern can be empty strings.
4215 * Match text against a glob-style pattern, with wildcards and simple sets:
4217 * ? matches any single character.
4218 * * matches any run of characters.
4219 * [xyz] matches a single character from the set: x, y, or z.
4220 * [a-d] matches a single character from the range: a, b, c, or d.
4221 * [a-d0-9] matches a single character from either range.
4223 * The special characters ?, [, -, or *, can be matched using a set, eg. [*]
4224 * Behaviour with malformed patterns is undefined, though generally reasonable.
4226 * Sample patterns: "SD1?", "SD1[0-5]", "*R0", "SD*1?[012]*xx"
4228 * This function uses one level of recursion per '*' in pattern.
4229 * Since it calls _nothing_ else, and has _no_ explicit local variables,
4230 * this will not cause stack problems for any reasonable use here.
4232 * RETURNS:
4233 * 0 on match, 1 otherwise.
4235 static int glob_match (const char *text, const char *pattern)
4237 do {
4238 /* Match single character or a '?' wildcard */
4239 if (*text == *pattern || *pattern == '?') {
4240 if (!*pattern++)
4241 return 0; /* End of both strings: match */
4242 } else {
4243 /* Match single char against a '[' bracketed ']' pattern set */
4244 if (!*text || *pattern != '[')
4245 break; /* Not a pattern set */
4246 while (*++pattern && *pattern != ']' && *text != *pattern) {
4247 if (*pattern == '-' && *(pattern - 1) != '[')
4248 if (*text > *(pattern - 1) && *text < *(pattern + 1)) {
4249 ++pattern;
4250 break;
4253 if (!*pattern || *pattern == ']')
4254 return 1; /* No match */
4255 while (*pattern && *pattern++ != ']');
4257 } while (*++text && *pattern);
4259 /* Match any run of chars against a '*' wildcard */
4260 if (*pattern == '*') {
4261 if (!*++pattern)
4262 return 0; /* Match: avoid recursion at end of pattern */
4263 /* Loop to handle additional pattern chars after the wildcard */
4264 while (*text) {
4265 if (glob_match(text, pattern) == 0)
4266 return 0; /* Remainder matched */
4267 ++text; /* Absorb (match) this char and try again */
4270 if (!*text && !*pattern)
4271 return 0; /* End of both strings: match */
4272 return 1; /* No match */
4275 static unsigned long ata_dev_blacklisted(const struct ata_device *dev)
4277 unsigned char model_num[ATA_ID_PROD_LEN + 1];
4278 unsigned char model_rev[ATA_ID_FW_REV_LEN + 1];
4279 const struct ata_blacklist_entry *ad = ata_device_blacklist;
4281 ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
4282 ata_id_c_string(dev->id, model_rev, ATA_ID_FW_REV, sizeof(model_rev));
4284 while (ad->model_num) {
4285 if (!glob_match(model_num, ad->model_num)) {
4286 if (ad->model_rev == NULL)
4287 return ad->horkage;
4288 if (!glob_match(model_rev, ad->model_rev))
4289 return ad->horkage;
4291 ad++;
4293 return 0;
4296 static int ata_dma_blacklisted(const struct ata_device *dev)
4298 /* We don't support polling DMA.
4299 * DMA blacklist those ATAPI devices with CDB-intr (and use PIO)
4300 * if the LLDD handles only interrupts in the HSM_ST_LAST state.
4302 if ((dev->link->ap->flags & ATA_FLAG_PIO_POLLING) &&
4303 (dev->flags & ATA_DFLAG_CDB_INTR))
4304 return 1;
4305 return (dev->horkage & ATA_HORKAGE_NODMA) ? 1 : 0;
4309 * ata_is_40wire - check drive side detection
4310 * @dev: device
4312 * Perform drive side detection decoding, allowing for device vendors
4313 * who can't follow the documentation.
4316 static int ata_is_40wire(struct ata_device *dev)
4318 if (dev->horkage & ATA_HORKAGE_IVB)
4319 return ata_drive_40wire_relaxed(dev->id);
4320 return ata_drive_40wire(dev->id);
4324 * cable_is_40wire - 40/80/SATA decider
4325 * @ap: port to consider
4327 * This function encapsulates the policy for speed management
4328 * in one place. At the moment we don't cache the result but
4329 * there is a good case for setting ap->cbl to the result when
4330 * we are called with unknown cables (and figuring out if it
4331 * impacts hotplug at all).
4333 * Return 1 if the cable appears to be 40 wire.
4336 static int cable_is_40wire(struct ata_port *ap)
4338 struct ata_link *link;
4339 struct ata_device *dev;
4341 /* If the controller thinks we are 40 wire, we are. */
4342 if (ap->cbl == ATA_CBL_PATA40)
4343 return 1;
4345 /* If the controller thinks we are 80 wire, we are. */
4346 if (ap->cbl == ATA_CBL_PATA80 || ap->cbl == ATA_CBL_SATA)
4347 return 0;
4349 /* If the system is known to be 40 wire short cable (eg
4350 * laptop), then we allow 80 wire modes even if the drive
4351 * isn't sure.
4353 if (ap->cbl == ATA_CBL_PATA40_SHORT)
4354 return 0;
4356 /* If the controller doesn't know, we scan.
4358 * Note: We look for all 40 wire detects at this point. Any
4359 * 80 wire detect is taken to be 80 wire cable because
4360 * - in many setups only the one drive (slave if present) will
4361 * give a valid detect
4362 * - if you have a non detect capable drive you don't want it
4363 * to colour the choice
4365 ata_for_each_link(link, ap, EDGE) {
4366 ata_for_each_dev(dev, link, ENABLED) {
4367 if (!ata_is_40wire(dev))
4368 return 0;
4371 return 1;
4375 * ata_dev_xfermask - Compute supported xfermask of the given device
4376 * @dev: Device to compute xfermask for
4378 * Compute supported xfermask of @dev and store it in
4379 * dev->*_mask. This function is responsible for applying all
4380 * known limits including host controller limits, device
4381 * blacklist, etc...
4383 * LOCKING:
4384 * None.
4386 static void ata_dev_xfermask(struct ata_device *dev)
4388 struct ata_link *link = dev->link;
4389 struct ata_port *ap = link->ap;
4390 struct ata_host *host = ap->host;
4391 unsigned long xfer_mask;
4393 /* controller modes available */
4394 xfer_mask = ata_pack_xfermask(ap->pio_mask,
4395 ap->mwdma_mask, ap->udma_mask);
4397 /* drive modes available */
4398 xfer_mask &= ata_pack_xfermask(dev->pio_mask,
4399 dev->mwdma_mask, dev->udma_mask);
4400 xfer_mask &= ata_id_xfermask(dev->id);
4403 * CFA Advanced TrueIDE timings are not allowed on a shared
4404 * cable
4406 if (ata_dev_pair(dev)) {
4407 /* No PIO5 or PIO6 */
4408 xfer_mask &= ~(0x03 << (ATA_SHIFT_PIO + 5));
4409 /* No MWDMA3 or MWDMA 4 */
4410 xfer_mask &= ~(0x03 << (ATA_SHIFT_MWDMA + 3));
4413 if (ata_dma_blacklisted(dev)) {
4414 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
4415 ata_dev_warn(dev,
4416 "device is on DMA blacklist, disabling DMA\n");
4419 if ((host->flags & ATA_HOST_SIMPLEX) &&
4420 host->simplex_claimed && host->simplex_claimed != ap) {
4421 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
4422 ata_dev_warn(dev,
4423 "simplex DMA is claimed by other device, disabling DMA\n");
4426 if (ap->flags & ATA_FLAG_NO_IORDY)
4427 xfer_mask &= ata_pio_mask_no_iordy(dev);
4429 if (ap->ops->mode_filter)
4430 xfer_mask = ap->ops->mode_filter(dev, xfer_mask);
4432 /* Apply cable rule here. Don't apply it early because when
4433 * we handle hot plug the cable type can itself change.
4434 * Check this last so that we know if the transfer rate was
4435 * solely limited by the cable.
4436 * Unknown or 80 wire cables reported host side are checked
4437 * drive side as well. Cases where we know a 40wire cable
4438 * is used safely for 80 are not checked here.
4440 if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
4441 /* UDMA/44 or higher would be available */
4442 if (cable_is_40wire(ap)) {
4443 ata_dev_warn(dev,
4444 "limited to UDMA/33 due to 40-wire cable\n");
4445 xfer_mask &= ~(0xF8 << ATA_SHIFT_UDMA);
4448 ata_unpack_xfermask(xfer_mask, &dev->pio_mask,
4449 &dev->mwdma_mask, &dev->udma_mask);
4453 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
4454 * @dev: Device to which command will be sent
4456 * Issue SET FEATURES - XFER MODE command to device @dev
4457 * on port @ap.
4459 * LOCKING:
4460 * PCI/etc. bus probe sem.
4462 * RETURNS:
4463 * 0 on success, AC_ERR_* mask otherwise.
4466 static unsigned int ata_dev_set_xfermode(struct ata_device *dev)
4468 struct ata_taskfile tf;
4469 unsigned int err_mask;
4471 /* set up set-features taskfile */
4472 DPRINTK("set features - xfer mode\n");
4474 /* Some controllers and ATAPI devices show flaky interrupt
4475 * behavior after setting xfer mode. Use polling instead.
4477 ata_tf_init(dev, &tf);
4478 tf.command = ATA_CMD_SET_FEATURES;
4479 tf.feature = SETFEATURES_XFER;
4480 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_POLLING;
4481 tf.protocol = ATA_PROT_NODATA;
4482 /* If we are using IORDY we must send the mode setting command */
4483 if (ata_pio_need_iordy(dev))
4484 tf.nsect = dev->xfer_mode;
4485 /* If the device has IORDY and the controller does not - turn it off */
4486 else if (ata_id_has_iordy(dev->id))
4487 tf.nsect = 0x01;
4488 else /* In the ancient relic department - skip all of this */
4489 return 0;
4491 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4493 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4494 return err_mask;
4498 * ata_dev_set_feature - Issue SET FEATURES - SATA FEATURES
4499 * @dev: Device to which command will be sent
4500 * @enable: Whether to enable or disable the feature
4501 * @feature: The sector count represents the feature to set
4503 * Issue SET FEATURES - SATA FEATURES command to device @dev
4504 * on port @ap with sector count
4506 * LOCKING:
4507 * PCI/etc. bus probe sem.
4509 * RETURNS:
4510 * 0 on success, AC_ERR_* mask otherwise.
4512 unsigned int ata_dev_set_feature(struct ata_device *dev, u8 enable, u8 feature)
4514 struct ata_taskfile tf;
4515 unsigned int err_mask;
4517 /* set up set-features taskfile */
4518 DPRINTK("set features - SATA features\n");
4520 ata_tf_init(dev, &tf);
4521 tf.command = ATA_CMD_SET_FEATURES;
4522 tf.feature = enable;
4523 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4524 tf.protocol = ATA_PROT_NODATA;
4525 tf.nsect = feature;
4527 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4529 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4530 return err_mask;
4532 EXPORT_SYMBOL_GPL(ata_dev_set_feature);
4535 * ata_dev_init_params - Issue INIT DEV PARAMS command
4536 * @dev: Device to which command will be sent
4537 * @heads: Number of heads (taskfile parameter)
4538 * @sectors: Number of sectors (taskfile parameter)
4540 * LOCKING:
4541 * Kernel thread context (may sleep)
4543 * RETURNS:
4544 * 0 on success, AC_ERR_* mask otherwise.
4546 static unsigned int ata_dev_init_params(struct ata_device *dev,
4547 u16 heads, u16 sectors)
4549 struct ata_taskfile tf;
4550 unsigned int err_mask;
4552 /* Number of sectors per track 1-255. Number of heads 1-16 */
4553 if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
4554 return AC_ERR_INVALID;
4556 /* set up init dev params taskfile */
4557 DPRINTK("init dev params \n");
4559 ata_tf_init(dev, &tf);
4560 tf.command = ATA_CMD_INIT_DEV_PARAMS;
4561 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4562 tf.protocol = ATA_PROT_NODATA;
4563 tf.nsect = sectors;
4564 tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
4566 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4567 /* A clean abort indicates an original or just out of spec drive
4568 and we should continue as we issue the setup based on the
4569 drive reported working geometry */
4570 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
4571 err_mask = 0;
4573 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4574 return err_mask;
4578 * ata_sg_clean - Unmap DMA memory associated with command
4579 * @qc: Command containing DMA memory to be released
4581 * Unmap all mapped DMA memory associated with this command.
4583 * LOCKING:
4584 * spin_lock_irqsave(host lock)
4586 void ata_sg_clean(struct ata_queued_cmd *qc)
4588 struct ata_port *ap = qc->ap;
4589 struct scatterlist *sg = qc->sg;
4590 int dir = qc->dma_dir;
4592 WARN_ON_ONCE(sg == NULL);
4594 VPRINTK("unmapping %u sg elements\n", qc->n_elem);
4596 if (qc->n_elem)
4597 dma_unmap_sg(ap->dev, sg, qc->orig_n_elem, dir);
4599 qc->flags &= ~ATA_QCFLAG_DMAMAP;
4600 qc->sg = NULL;
4604 * atapi_check_dma - Check whether ATAPI DMA can be supported
4605 * @qc: Metadata associated with taskfile to check
4607 * Allow low-level driver to filter ATA PACKET commands, returning
4608 * a status indicating whether or not it is OK to use DMA for the
4609 * supplied PACKET command.
4611 * LOCKING:
4612 * spin_lock_irqsave(host lock)
4614 * RETURNS: 0 when ATAPI DMA can be used
4615 * nonzero otherwise
4617 int atapi_check_dma(struct ata_queued_cmd *qc)
4619 struct ata_port *ap = qc->ap;
4621 /* Don't allow DMA if it isn't multiple of 16 bytes. Quite a
4622 * few ATAPI devices choke on such DMA requests.
4624 if (!(qc->dev->horkage & ATA_HORKAGE_ATAPI_MOD16_DMA) &&
4625 unlikely(qc->nbytes & 15))
4626 return 1;
4628 if (ap->ops->check_atapi_dma)
4629 return ap->ops->check_atapi_dma(qc);
4631 return 0;
4635 * ata_std_qc_defer - Check whether a qc needs to be deferred
4636 * @qc: ATA command in question
4638 * Non-NCQ commands cannot run with any other command, NCQ or
4639 * not. As upper layer only knows the queue depth, we are
4640 * responsible for maintaining exclusion. This function checks
4641 * whether a new command @qc can be issued.
4643 * LOCKING:
4644 * spin_lock_irqsave(host lock)
4646 * RETURNS:
4647 * ATA_DEFER_* if deferring is needed, 0 otherwise.
4649 int ata_std_qc_defer(struct ata_queued_cmd *qc)
4651 struct ata_link *link = qc->dev->link;
4653 if (qc->tf.protocol == ATA_PROT_NCQ) {
4654 if (!ata_tag_valid(link->active_tag))
4655 return 0;
4656 } else {
4657 if (!ata_tag_valid(link->active_tag) && !link->sactive)
4658 return 0;
4661 return ATA_DEFER_LINK;
4664 void ata_noop_qc_prep(struct ata_queued_cmd *qc) { }
4667 * ata_sg_init - Associate command with scatter-gather table.
4668 * @qc: Command to be associated
4669 * @sg: Scatter-gather table.
4670 * @n_elem: Number of elements in s/g table.
4672 * Initialize the data-related elements of queued_cmd @qc
4673 * to point to a scatter-gather table @sg, containing @n_elem
4674 * elements.
4676 * LOCKING:
4677 * spin_lock_irqsave(host lock)
4679 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
4680 unsigned int n_elem)
4682 qc->sg = sg;
4683 qc->n_elem = n_elem;
4684 qc->cursg = qc->sg;
4688 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
4689 * @qc: Command with scatter-gather table to be mapped.
4691 * DMA-map the scatter-gather table associated with queued_cmd @qc.
4693 * LOCKING:
4694 * spin_lock_irqsave(host lock)
4696 * RETURNS:
4697 * Zero on success, negative on error.
4700 static int ata_sg_setup(struct ata_queued_cmd *qc)
4702 struct ata_port *ap = qc->ap;
4703 unsigned int n_elem;
4705 VPRINTK("ENTER, ata%u\n", ap->print_id);
4707 n_elem = dma_map_sg(ap->dev, qc->sg, qc->n_elem, qc->dma_dir);
4708 if (n_elem < 1)
4709 return -1;
4711 DPRINTK("%d sg elements mapped\n", n_elem);
4712 qc->orig_n_elem = qc->n_elem;
4713 qc->n_elem = n_elem;
4714 qc->flags |= ATA_QCFLAG_DMAMAP;
4716 return 0;
4720 * swap_buf_le16 - swap halves of 16-bit words in place
4721 * @buf: Buffer to swap
4722 * @buf_words: Number of 16-bit words in buffer.
4724 * Swap halves of 16-bit words if needed to convert from
4725 * little-endian byte order to native cpu byte order, or
4726 * vice-versa.
4728 * LOCKING:
4729 * Inherited from caller.
4731 void swap_buf_le16(u16 *buf, unsigned int buf_words)
4733 #ifdef __BIG_ENDIAN
4734 unsigned int i;
4736 for (i = 0; i < buf_words; i++)
4737 buf[i] = le16_to_cpu(buf[i]);
4738 #endif /* __BIG_ENDIAN */
4742 * ata_qc_new - Request an available ATA command, for queueing
4743 * @ap: target port
4745 * LOCKING:
4746 * None.
4749 static struct ata_queued_cmd *ata_qc_new(struct ata_port *ap)
4751 struct ata_queued_cmd *qc = NULL;
4752 unsigned int i;
4754 /* no command while frozen */
4755 if (unlikely(ap->pflags & ATA_PFLAG_FROZEN))
4756 return NULL;
4758 /* the last tag is reserved for internal command. */
4759 for (i = 0; i < ATA_MAX_QUEUE - 1; i++)
4760 if (!test_and_set_bit(i, &ap->qc_allocated)) {
4761 qc = __ata_qc_from_tag(ap, i);
4762 break;
4765 if (qc)
4766 qc->tag = i;
4768 return qc;
4772 * ata_qc_new_init - Request an available ATA command, and initialize it
4773 * @dev: Device from whom we request an available command structure
4775 * LOCKING:
4776 * None.
4779 struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev)
4781 struct ata_port *ap = dev->link->ap;
4782 struct ata_queued_cmd *qc;
4784 qc = ata_qc_new(ap);
4785 if (qc) {
4786 qc->scsicmd = NULL;
4787 qc->ap = ap;
4788 qc->dev = dev;
4790 ata_qc_reinit(qc);
4793 return qc;
4797 * ata_qc_free - free unused ata_queued_cmd
4798 * @qc: Command to complete
4800 * Designed to free unused ata_queued_cmd object
4801 * in case something prevents using it.
4803 * LOCKING:
4804 * spin_lock_irqsave(host lock)
4806 void ata_qc_free(struct ata_queued_cmd *qc)
4808 struct ata_port *ap;
4809 unsigned int tag;
4811 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
4812 ap = qc->ap;
4814 qc->flags = 0;
4815 tag = qc->tag;
4816 if (likely(ata_tag_valid(tag))) {
4817 qc->tag = ATA_TAG_POISON;
4818 clear_bit(tag, &ap->qc_allocated);
4822 void __ata_qc_complete(struct ata_queued_cmd *qc)
4824 struct ata_port *ap;
4825 struct ata_link *link;
4827 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
4828 WARN_ON_ONCE(!(qc->flags & ATA_QCFLAG_ACTIVE));
4829 ap = qc->ap;
4830 link = qc->dev->link;
4832 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
4833 ata_sg_clean(qc);
4835 /* command should be marked inactive atomically with qc completion */
4836 if (qc->tf.protocol == ATA_PROT_NCQ) {
4837 link->sactive &= ~(1 << qc->tag);
4838 if (!link->sactive)
4839 ap->nr_active_links--;
4840 } else {
4841 link->active_tag = ATA_TAG_POISON;
4842 ap->nr_active_links--;
4845 /* clear exclusive status */
4846 if (unlikely(qc->flags & ATA_QCFLAG_CLEAR_EXCL &&
4847 ap->excl_link == link))
4848 ap->excl_link = NULL;
4850 /* atapi: mark qc as inactive to prevent the interrupt handler
4851 * from completing the command twice later, before the error handler
4852 * is called. (when rc != 0 and atapi request sense is needed)
4854 qc->flags &= ~ATA_QCFLAG_ACTIVE;
4855 ap->qc_active &= ~(1 << qc->tag);
4857 /* call completion callback */
4858 qc->complete_fn(qc);
4861 static void fill_result_tf(struct ata_queued_cmd *qc)
4863 struct ata_port *ap = qc->ap;
4865 qc->result_tf.flags = qc->tf.flags;
4866 ap->ops->qc_fill_rtf(qc);
4869 static void ata_verify_xfer(struct ata_queued_cmd *qc)
4871 struct ata_device *dev = qc->dev;
4873 if (ata_is_nodata(qc->tf.protocol))
4874 return;
4876 if ((dev->mwdma_mask || dev->udma_mask) && ata_is_pio(qc->tf.protocol))
4877 return;
4879 dev->flags &= ~ATA_DFLAG_DUBIOUS_XFER;
4883 * ata_qc_complete - Complete an active ATA command
4884 * @qc: Command to complete
4886 * Indicate to the mid and upper layers that an ATA command has
4887 * completed, with either an ok or not-ok status.
4889 * Refrain from calling this function multiple times when
4890 * successfully completing multiple NCQ commands.
4891 * ata_qc_complete_multiple() should be used instead, which will
4892 * properly update IRQ expect state.
4894 * LOCKING:
4895 * spin_lock_irqsave(host lock)
4897 void ata_qc_complete(struct ata_queued_cmd *qc)
4899 struct ata_port *ap = qc->ap;
4901 /* XXX: New EH and old EH use different mechanisms to
4902 * synchronize EH with regular execution path.
4904 * In new EH, a failed qc is marked with ATA_QCFLAG_FAILED.
4905 * Normal execution path is responsible for not accessing a
4906 * failed qc. libata core enforces the rule by returning NULL
4907 * from ata_qc_from_tag() for failed qcs.
4909 * Old EH depends on ata_qc_complete() nullifying completion
4910 * requests if ATA_QCFLAG_EH_SCHEDULED is set. Old EH does
4911 * not synchronize with interrupt handler. Only PIO task is
4912 * taken care of.
4914 if (ap->ops->error_handler) {
4915 struct ata_device *dev = qc->dev;
4916 struct ata_eh_info *ehi = &dev->link->eh_info;
4918 if (unlikely(qc->err_mask))
4919 qc->flags |= ATA_QCFLAG_FAILED;
4922 * Finish internal commands without any further processing
4923 * and always with the result TF filled.
4925 if (unlikely(ata_tag_internal(qc->tag))) {
4926 fill_result_tf(qc);
4927 __ata_qc_complete(qc);
4928 return;
4932 * Non-internal qc has failed. Fill the result TF and
4933 * summon EH.
4935 if (unlikely(qc->flags & ATA_QCFLAG_FAILED)) {
4936 fill_result_tf(qc);
4937 ata_qc_schedule_eh(qc);
4938 return;
4941 WARN_ON_ONCE(ap->pflags & ATA_PFLAG_FROZEN);
4943 /* read result TF if requested */
4944 if (qc->flags & ATA_QCFLAG_RESULT_TF)
4945 fill_result_tf(qc);
4947 /* Some commands need post-processing after successful
4948 * completion.
4950 switch (qc->tf.command) {
4951 case ATA_CMD_SET_FEATURES:
4952 if (qc->tf.feature != SETFEATURES_WC_ON &&
4953 qc->tf.feature != SETFEATURES_WC_OFF)
4954 break;
4955 /* fall through */
4956 case ATA_CMD_INIT_DEV_PARAMS: /* CHS translation changed */
4957 case ATA_CMD_SET_MULTI: /* multi_count changed */
4958 /* revalidate device */
4959 ehi->dev_action[dev->devno] |= ATA_EH_REVALIDATE;
4960 ata_port_schedule_eh(ap);
4961 break;
4963 case ATA_CMD_SLEEP:
4964 dev->flags |= ATA_DFLAG_SLEEPING;
4965 break;
4968 if (unlikely(dev->flags & ATA_DFLAG_DUBIOUS_XFER))
4969 ata_verify_xfer(qc);
4971 __ata_qc_complete(qc);
4972 } else {
4973 if (qc->flags & ATA_QCFLAG_EH_SCHEDULED)
4974 return;
4976 /* read result TF if failed or requested */
4977 if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
4978 fill_result_tf(qc);
4980 __ata_qc_complete(qc);
4985 * ata_qc_complete_multiple - Complete multiple qcs successfully
4986 * @ap: port in question
4987 * @qc_active: new qc_active mask
4989 * Complete in-flight commands. This functions is meant to be
4990 * called from low-level driver's interrupt routine to complete
4991 * requests normally. ap->qc_active and @qc_active is compared
4992 * and commands are completed accordingly.
4994 * Always use this function when completing multiple NCQ commands
4995 * from IRQ handlers instead of calling ata_qc_complete()
4996 * multiple times to keep IRQ expect status properly in sync.
4998 * LOCKING:
4999 * spin_lock_irqsave(host lock)
5001 * RETURNS:
5002 * Number of completed commands on success, -errno otherwise.
5004 int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active)
5006 int nr_done = 0;
5007 u32 done_mask;
5009 done_mask = ap->qc_active ^ qc_active;
5011 if (unlikely(done_mask & qc_active)) {
5012 ata_port_err(ap, "illegal qc_active transition (%08x->%08x)\n",
5013 ap->qc_active, qc_active);
5014 return -EINVAL;
5017 while (done_mask) {
5018 struct ata_queued_cmd *qc;
5019 unsigned int tag = __ffs(done_mask);
5021 qc = ata_qc_from_tag(ap, tag);
5022 if (qc) {
5023 ata_qc_complete(qc);
5024 nr_done++;
5026 done_mask &= ~(1 << tag);
5029 return nr_done;
5033 * ata_qc_issue - issue taskfile to device
5034 * @qc: command to issue to device
5036 * Prepare an ATA command to submission to device.
5037 * This includes mapping the data into a DMA-able
5038 * area, filling in the S/G table, and finally
5039 * writing the taskfile to hardware, starting the command.
5041 * LOCKING:
5042 * spin_lock_irqsave(host lock)
5044 void ata_qc_issue(struct ata_queued_cmd *qc)
5046 struct ata_port *ap = qc->ap;
5047 struct ata_link *link = qc->dev->link;
5048 u8 prot = qc->tf.protocol;
5050 /* Make sure only one non-NCQ command is outstanding. The
5051 * check is skipped for old EH because it reuses active qc to
5052 * request ATAPI sense.
5054 WARN_ON_ONCE(ap->ops->error_handler && ata_tag_valid(link->active_tag));
5056 if (ata_is_ncq(prot)) {
5057 WARN_ON_ONCE(link->sactive & (1 << qc->tag));
5059 if (!link->sactive)
5060 ap->nr_active_links++;
5061 link->sactive |= 1 << qc->tag;
5062 } else {
5063 WARN_ON_ONCE(link->sactive);
5065 ap->nr_active_links++;
5066 link->active_tag = qc->tag;
5069 qc->flags |= ATA_QCFLAG_ACTIVE;
5070 ap->qc_active |= 1 << qc->tag;
5073 * We guarantee to LLDs that they will have at least one
5074 * non-zero sg if the command is a data command.
5076 if (WARN_ON_ONCE(ata_is_data(prot) &&
5077 (!qc->sg || !qc->n_elem || !qc->nbytes)))
5078 goto sys_err;
5080 if (ata_is_dma(prot) || (ata_is_pio(prot) &&
5081 (ap->flags & ATA_FLAG_PIO_DMA)))
5082 if (ata_sg_setup(qc))
5083 goto sys_err;
5085 /* if device is sleeping, schedule reset and abort the link */
5086 if (unlikely(qc->dev->flags & ATA_DFLAG_SLEEPING)) {
5087 link->eh_info.action |= ATA_EH_RESET;
5088 ata_ehi_push_desc(&link->eh_info, "waking up from sleep");
5089 ata_link_abort(link);
5090 return;
5093 ap->ops->qc_prep(qc);
5095 qc->err_mask |= ap->ops->qc_issue(qc);
5096 if (unlikely(qc->err_mask))
5097 goto err;
5098 return;
5100 sys_err:
5101 qc->err_mask |= AC_ERR_SYSTEM;
5102 err:
5103 ata_qc_complete(qc);
5107 * sata_scr_valid - test whether SCRs are accessible
5108 * @link: ATA link to test SCR accessibility for
5110 * Test whether SCRs are accessible for @link.
5112 * LOCKING:
5113 * None.
5115 * RETURNS:
5116 * 1 if SCRs are accessible, 0 otherwise.
5118 int sata_scr_valid(struct ata_link *link)
5120 struct ata_port *ap = link->ap;
5122 return (ap->flags & ATA_FLAG_SATA) && ap->ops->scr_read;
5126 * sata_scr_read - read SCR register of the specified port
5127 * @link: ATA link to read SCR for
5128 * @reg: SCR to read
5129 * @val: Place to store read value
5131 * Read SCR register @reg of @link into *@val. This function is
5132 * guaranteed to succeed if @link is ap->link, the cable type of
5133 * the port is SATA and the port implements ->scr_read.
5135 * LOCKING:
5136 * None if @link is ap->link. Kernel thread context otherwise.
5138 * RETURNS:
5139 * 0 on success, negative errno on failure.
5141 int sata_scr_read(struct ata_link *link, int reg, u32 *val)
5143 if (ata_is_host_link(link)) {
5144 if (sata_scr_valid(link))
5145 return link->ap->ops->scr_read(link, reg, val);
5146 return -EOPNOTSUPP;
5149 return sata_pmp_scr_read(link, reg, val);
5153 * sata_scr_write - write SCR register of the specified port
5154 * @link: ATA link to write SCR for
5155 * @reg: SCR to write
5156 * @val: value to write
5158 * Write @val to SCR register @reg of @link. This function is
5159 * guaranteed to succeed if @link is ap->link, the cable type of
5160 * the port is SATA and the port implements ->scr_read.
5162 * LOCKING:
5163 * None if @link is ap->link. Kernel thread context otherwise.
5165 * RETURNS:
5166 * 0 on success, negative errno on failure.
5168 int sata_scr_write(struct ata_link *link, int reg, u32 val)
5170 if (ata_is_host_link(link)) {
5171 if (sata_scr_valid(link))
5172 return link->ap->ops->scr_write(link, reg, val);
5173 return -EOPNOTSUPP;
5176 return sata_pmp_scr_write(link, reg, val);
5180 * sata_scr_write_flush - write SCR register of the specified port and flush
5181 * @link: ATA link to write SCR for
5182 * @reg: SCR to write
5183 * @val: value to write
5185 * This function is identical to sata_scr_write() except that this
5186 * function performs flush after writing to the register.
5188 * LOCKING:
5189 * None if @link is ap->link. Kernel thread context otherwise.
5191 * RETURNS:
5192 * 0 on success, negative errno on failure.
5194 int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
5196 if (ata_is_host_link(link)) {
5197 int rc;
5199 if (sata_scr_valid(link)) {
5200 rc = link->ap->ops->scr_write(link, reg, val);
5201 if (rc == 0)
5202 rc = link->ap->ops->scr_read(link, reg, &val);
5203 return rc;
5205 return -EOPNOTSUPP;
5208 return sata_pmp_scr_write(link, reg, val);
5212 * ata_phys_link_online - test whether the given link is online
5213 * @link: ATA link to test
5215 * Test whether @link is online. Note that this function returns
5216 * 0 if online status of @link cannot be obtained, so
5217 * ata_link_online(link) != !ata_link_offline(link).
5219 * LOCKING:
5220 * None.
5222 * RETURNS:
5223 * True if the port online status is available and online.
5225 bool ata_phys_link_online(struct ata_link *link)
5227 u32 sstatus;
5229 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
5230 ata_sstatus_online(sstatus))
5231 return true;
5232 return false;
5236 * ata_phys_link_offline - test whether the given link is offline
5237 * @link: ATA link to test
5239 * Test whether @link is offline. Note that this function
5240 * returns 0 if offline status of @link cannot be obtained, so
5241 * ata_link_online(link) != !ata_link_offline(link).
5243 * LOCKING:
5244 * None.
5246 * RETURNS:
5247 * True if the port offline status is available and offline.
5249 bool ata_phys_link_offline(struct ata_link *link)
5251 u32 sstatus;
5253 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
5254 !ata_sstatus_online(sstatus))
5255 return true;
5256 return false;
5260 * ata_link_online - test whether the given link is online
5261 * @link: ATA link to test
5263 * Test whether @link is online. This is identical to
5264 * ata_phys_link_online() when there's no slave link. When
5265 * there's a slave link, this function should only be called on
5266 * the master link and will return true if any of M/S links is
5267 * online.
5269 * LOCKING:
5270 * None.
5272 * RETURNS:
5273 * True if the port online status is available and online.
5275 bool ata_link_online(struct ata_link *link)
5277 struct ata_link *slave = link->ap->slave_link;
5279 WARN_ON(link == slave); /* shouldn't be called on slave link */
5281 return ata_phys_link_online(link) ||
5282 (slave && ata_phys_link_online(slave));
5286 * ata_link_offline - test whether the given link is offline
5287 * @link: ATA link to test
5289 * Test whether @link is offline. This is identical to
5290 * ata_phys_link_offline() when there's no slave link. When
5291 * there's a slave link, this function should only be called on
5292 * the master link and will return true if both M/S links are
5293 * offline.
5295 * LOCKING:
5296 * None.
5298 * RETURNS:
5299 * True if the port offline status is available and offline.
5301 bool ata_link_offline(struct ata_link *link)
5303 struct ata_link *slave = link->ap->slave_link;
5305 WARN_ON(link == slave); /* shouldn't be called on slave link */
5307 return ata_phys_link_offline(link) &&
5308 (!slave || ata_phys_link_offline(slave));
5311 #ifdef CONFIG_PM
5312 static int ata_port_request_pm(struct ata_port *ap, pm_message_t mesg,
5313 unsigned int action, unsigned int ehi_flags,
5314 int *async)
5316 struct ata_link *link;
5317 unsigned long flags;
5318 int rc = 0;
5320 /* Previous resume operation might still be in
5321 * progress. Wait for PM_PENDING to clear.
5323 if (ap->pflags & ATA_PFLAG_PM_PENDING) {
5324 if (async) {
5325 *async = -EAGAIN;
5326 return 0;
5328 ata_port_wait_eh(ap);
5329 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5332 /* request PM ops to EH */
5333 spin_lock_irqsave(ap->lock, flags);
5335 ap->pm_mesg = mesg;
5336 if (async)
5337 ap->pm_result = async;
5338 else
5339 ap->pm_result = &rc;
5341 ap->pflags |= ATA_PFLAG_PM_PENDING;
5342 ata_for_each_link(link, ap, HOST_FIRST) {
5343 link->eh_info.action |= action;
5344 link->eh_info.flags |= ehi_flags;
5347 ata_port_schedule_eh(ap);
5349 spin_unlock_irqrestore(ap->lock, flags);
5351 /* wait and check result */
5352 if (!async) {
5353 ata_port_wait_eh(ap);
5354 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5357 return rc;
5360 static int __ata_port_suspend_common(struct ata_port *ap, pm_message_t mesg, int *async)
5363 * On some hardware, device fails to respond after spun down
5364 * for suspend. As the device won't be used before being
5365 * resumed, we don't need to touch the device. Ask EH to skip
5366 * the usual stuff and proceed directly to suspend.
5368 * http://thread.gmane.org/gmane.linux.ide/46764
5370 unsigned int ehi_flags = ATA_EHI_QUIET | ATA_EHI_NO_AUTOPSY |
5371 ATA_EHI_NO_RECOVERY;
5372 return ata_port_request_pm(ap, mesg, 0, ehi_flags, async);
5375 static int ata_port_suspend_common(struct device *dev, pm_message_t mesg)
5377 struct ata_port *ap = to_ata_port(dev);
5379 return __ata_port_suspend_common(ap, mesg, NULL);
5382 static int ata_port_suspend(struct device *dev)
5384 if (pm_runtime_suspended(dev))
5385 return 0;
5387 return ata_port_suspend_common(dev, PMSG_SUSPEND);
5390 static int ata_port_do_freeze(struct device *dev)
5392 if (pm_runtime_suspended(dev))
5393 return 0;
5395 return ata_port_suspend_common(dev, PMSG_FREEZE);
5398 static int ata_port_poweroff(struct device *dev)
5400 return ata_port_suspend_common(dev, PMSG_HIBERNATE);
5403 static int __ata_port_resume_common(struct ata_port *ap, pm_message_t mesg,
5404 int *async)
5406 int rc;
5408 rc = ata_port_request_pm(ap, mesg, ATA_EH_RESET,
5409 ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET, async);
5410 return rc;
5413 static int ata_port_resume_common(struct device *dev, pm_message_t mesg)
5415 struct ata_port *ap = to_ata_port(dev);
5417 return __ata_port_resume_common(ap, mesg, NULL);
5420 static int ata_port_resume(struct device *dev)
5422 int rc;
5424 rc = ata_port_resume_common(dev, PMSG_RESUME);
5425 if (!rc) {
5426 pm_runtime_disable(dev);
5427 pm_runtime_set_active(dev);
5428 pm_runtime_enable(dev);
5431 return rc;
5435 * For ODDs, the upper layer will poll for media change every few seconds,
5436 * which will make it enter and leave suspend state every few seconds. And
5437 * as each suspend will cause a hard/soft reset, the gain of runtime suspend
5438 * is very little and the ODD may malfunction after constantly being reset.
5439 * So the idle callback here will not proceed to suspend if a non-ZPODD capable
5440 * ODD is attached to the port.
5442 static int ata_port_runtime_idle(struct device *dev)
5444 struct ata_port *ap = to_ata_port(dev);
5445 struct ata_link *link;
5446 struct ata_device *adev;
5448 ata_for_each_link(link, ap, HOST_FIRST) {
5449 ata_for_each_dev(adev, link, ENABLED)
5450 if (adev->class == ATA_DEV_ATAPI &&
5451 !zpodd_dev_enabled(adev))
5452 return -EBUSY;
5455 return 0;
5458 static int ata_port_runtime_suspend(struct device *dev)
5460 return ata_port_suspend_common(dev, PMSG_AUTO_SUSPEND);
5463 static int ata_port_runtime_resume(struct device *dev)
5465 return ata_port_resume_common(dev, PMSG_AUTO_RESUME);
5468 static const struct dev_pm_ops ata_port_pm_ops = {
5469 .suspend = ata_port_suspend,
5470 .resume = ata_port_resume,
5471 .freeze = ata_port_do_freeze,
5472 .thaw = ata_port_resume,
5473 .poweroff = ata_port_poweroff,
5474 .restore = ata_port_resume,
5476 .runtime_suspend = ata_port_runtime_suspend,
5477 .runtime_resume = ata_port_runtime_resume,
5478 .runtime_idle = ata_port_runtime_idle,
5481 /* sas ports don't participate in pm runtime management of ata_ports,
5482 * and need to resume ata devices at the domain level, not the per-port
5483 * level. sas suspend/resume is async to allow parallel port recovery
5484 * since sas has multiple ata_port instances per Scsi_Host.
5486 int ata_sas_port_async_suspend(struct ata_port *ap, int *async)
5488 return __ata_port_suspend_common(ap, PMSG_SUSPEND, async);
5490 EXPORT_SYMBOL_GPL(ata_sas_port_async_suspend);
5492 int ata_sas_port_async_resume(struct ata_port *ap, int *async)
5494 return __ata_port_resume_common(ap, PMSG_RESUME, async);
5496 EXPORT_SYMBOL_GPL(ata_sas_port_async_resume);
5500 * ata_host_suspend - suspend host
5501 * @host: host to suspend
5502 * @mesg: PM message
5504 * Suspend @host. Actual operation is performed by port suspend.
5506 int ata_host_suspend(struct ata_host *host, pm_message_t mesg)
5508 host->dev->power.power_state = mesg;
5509 return 0;
5513 * ata_host_resume - resume host
5514 * @host: host to resume
5516 * Resume @host. Actual operation is performed by port resume.
5518 void ata_host_resume(struct ata_host *host)
5520 host->dev->power.power_state = PMSG_ON;
5522 #endif
5524 struct device_type ata_port_type = {
5525 .name = "ata_port",
5526 #ifdef CONFIG_PM
5527 .pm = &ata_port_pm_ops,
5528 #endif
5532 * ata_dev_init - Initialize an ata_device structure
5533 * @dev: Device structure to initialize
5535 * Initialize @dev in preparation for probing.
5537 * LOCKING:
5538 * Inherited from caller.
5540 void ata_dev_init(struct ata_device *dev)
5542 struct ata_link *link = ata_dev_phys_link(dev);
5543 struct ata_port *ap = link->ap;
5544 unsigned long flags;
5546 /* SATA spd limit is bound to the attached device, reset together */
5547 link->sata_spd_limit = link->hw_sata_spd_limit;
5548 link->sata_spd = 0;
5550 /* High bits of dev->flags are used to record warm plug
5551 * requests which occur asynchronously. Synchronize using
5552 * host lock.
5554 spin_lock_irqsave(ap->lock, flags);
5555 dev->flags &= ~ATA_DFLAG_INIT_MASK;
5556 dev->horkage = 0;
5557 spin_unlock_irqrestore(ap->lock, flags);
5559 memset((void *)dev + ATA_DEVICE_CLEAR_BEGIN, 0,
5560 ATA_DEVICE_CLEAR_END - ATA_DEVICE_CLEAR_BEGIN);
5561 dev->pio_mask = UINT_MAX;
5562 dev->mwdma_mask = UINT_MAX;
5563 dev->udma_mask = UINT_MAX;
5567 * ata_link_init - Initialize an ata_link structure
5568 * @ap: ATA port link is attached to
5569 * @link: Link structure to initialize
5570 * @pmp: Port multiplier port number
5572 * Initialize @link.
5574 * LOCKING:
5575 * Kernel thread context (may sleep)
5577 void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp)
5579 int i;
5581 /* clear everything except for devices */
5582 memset((void *)link + ATA_LINK_CLEAR_BEGIN, 0,
5583 ATA_LINK_CLEAR_END - ATA_LINK_CLEAR_BEGIN);
5585 link->ap = ap;
5586 link->pmp = pmp;
5587 link->active_tag = ATA_TAG_POISON;
5588 link->hw_sata_spd_limit = UINT_MAX;
5590 /* can't use iterator, ap isn't initialized yet */
5591 for (i = 0; i < ATA_MAX_DEVICES; i++) {
5592 struct ata_device *dev = &link->device[i];
5594 dev->link = link;
5595 dev->devno = dev - link->device;
5596 #ifdef CONFIG_ATA_ACPI
5597 dev->gtf_filter = ata_acpi_gtf_filter;
5598 #endif
5599 ata_dev_init(dev);
5604 * sata_link_init_spd - Initialize link->sata_spd_limit
5605 * @link: Link to configure sata_spd_limit for
5607 * Initialize @link->[hw_]sata_spd_limit to the currently
5608 * configured value.
5610 * LOCKING:
5611 * Kernel thread context (may sleep).
5613 * RETURNS:
5614 * 0 on success, -errno on failure.
5616 int sata_link_init_spd(struct ata_link *link)
5618 u8 spd;
5619 int rc;
5621 rc = sata_scr_read(link, SCR_CONTROL, &link->saved_scontrol);
5622 if (rc)
5623 return rc;
5625 spd = (link->saved_scontrol >> 4) & 0xf;
5626 if (spd)
5627 link->hw_sata_spd_limit &= (1 << spd) - 1;
5629 ata_force_link_limits(link);
5631 link->sata_spd_limit = link->hw_sata_spd_limit;
5633 return 0;
5637 * ata_port_alloc - allocate and initialize basic ATA port resources
5638 * @host: ATA host this allocated port belongs to
5640 * Allocate and initialize basic ATA port resources.
5642 * RETURNS:
5643 * Allocate ATA port on success, NULL on failure.
5645 * LOCKING:
5646 * Inherited from calling layer (may sleep).
5648 struct ata_port *ata_port_alloc(struct ata_host *host)
5650 struct ata_port *ap;
5652 DPRINTK("ENTER\n");
5654 ap = kzalloc(sizeof(*ap), GFP_KERNEL);
5655 if (!ap)
5656 return NULL;
5658 ap->pflags |= ATA_PFLAG_INITIALIZING | ATA_PFLAG_FROZEN;
5659 ap->lock = &host->lock;
5660 ap->print_id = -1;
5661 ap->local_port_no = -1;
5662 ap->host = host;
5663 ap->dev = host->dev;
5665 #if defined(ATA_VERBOSE_DEBUG)
5666 /* turn on all debugging levels */
5667 ap->msg_enable = 0x00FF;
5668 #elif defined(ATA_DEBUG)
5669 ap->msg_enable = ATA_MSG_DRV | ATA_MSG_INFO | ATA_MSG_CTL | ATA_MSG_WARN | ATA_MSG_ERR;
5670 #else
5671 ap->msg_enable = ATA_MSG_DRV | ATA_MSG_ERR | ATA_MSG_WARN;
5672 #endif
5674 mutex_init(&ap->scsi_scan_mutex);
5675 INIT_DELAYED_WORK(&ap->hotplug_task, ata_scsi_hotplug);
5676 INIT_WORK(&ap->scsi_rescan_task, ata_scsi_dev_rescan);
5677 INIT_LIST_HEAD(&ap->eh_done_q);
5678 init_waitqueue_head(&ap->eh_wait_q);
5679 init_completion(&ap->park_req_pending);
5680 init_timer_deferrable(&ap->fastdrain_timer);
5681 ap->fastdrain_timer.function = ata_eh_fastdrain_timerfn;
5682 ap->fastdrain_timer.data = (unsigned long)ap;
5684 ap->cbl = ATA_CBL_NONE;
5686 ata_link_init(ap, &ap->link, 0);
5688 #ifdef ATA_IRQ_TRAP
5689 ap->stats.unhandled_irq = 1;
5690 ap->stats.idle_irq = 1;
5691 #endif
5692 ata_sff_port_init(ap);
5694 return ap;
5697 static void ata_host_release(struct device *gendev, void *res)
5699 struct ata_host *host = dev_get_drvdata(gendev);
5700 int i;
5702 for (i = 0; i < host->n_ports; i++) {
5703 struct ata_port *ap = host->ports[i];
5705 if (!ap)
5706 continue;
5708 if (ap->scsi_host)
5709 scsi_host_put(ap->scsi_host);
5711 kfree(ap->pmp_link);
5712 kfree(ap->slave_link);
5713 kfree(ap);
5714 host->ports[i] = NULL;
5717 dev_set_drvdata(gendev, NULL);
5721 * ata_host_alloc - allocate and init basic ATA host resources
5722 * @dev: generic device this host is associated with
5723 * @max_ports: maximum number of ATA ports associated with this host
5725 * Allocate and initialize basic ATA host resources. LLD calls
5726 * this function to allocate a host, initializes it fully and
5727 * attaches it using ata_host_register().
5729 * @max_ports ports are allocated and host->n_ports is
5730 * initialized to @max_ports. The caller is allowed to decrease
5731 * host->n_ports before calling ata_host_register(). The unused
5732 * ports will be automatically freed on registration.
5734 * RETURNS:
5735 * Allocate ATA host on success, NULL on failure.
5737 * LOCKING:
5738 * Inherited from calling layer (may sleep).
5740 struct ata_host *ata_host_alloc(struct device *dev, int max_ports)
5742 struct ata_host *host;
5743 size_t sz;
5744 int i;
5746 DPRINTK("ENTER\n");
5748 if (!devres_open_group(dev, NULL, GFP_KERNEL))
5749 return NULL;
5751 /* alloc a container for our list of ATA ports (buses) */
5752 sz = sizeof(struct ata_host) + (max_ports + 1) * sizeof(void *);
5753 /* alloc a container for our list of ATA ports (buses) */
5754 host = devres_alloc(ata_host_release, sz, GFP_KERNEL);
5755 if (!host)
5756 goto err_out;
5758 devres_add(dev, host);
5759 dev_set_drvdata(dev, host);
5761 spin_lock_init(&host->lock);
5762 mutex_init(&host->eh_mutex);
5763 host->dev = dev;
5764 host->n_ports = max_ports;
5766 /* allocate ports bound to this host */
5767 for (i = 0; i < max_ports; i++) {
5768 struct ata_port *ap;
5770 ap = ata_port_alloc(host);
5771 if (!ap)
5772 goto err_out;
5774 ap->port_no = i;
5775 host->ports[i] = ap;
5778 devres_remove_group(dev, NULL);
5779 return host;
5781 err_out:
5782 devres_release_group(dev, NULL);
5783 return NULL;
5787 * ata_host_alloc_pinfo - alloc host and init with port_info array
5788 * @dev: generic device this host is associated with
5789 * @ppi: array of ATA port_info to initialize host with
5790 * @n_ports: number of ATA ports attached to this host
5792 * Allocate ATA host and initialize with info from @ppi. If NULL
5793 * terminated, @ppi may contain fewer entries than @n_ports. The
5794 * last entry will be used for the remaining ports.
5796 * RETURNS:
5797 * Allocate ATA host on success, NULL on failure.
5799 * LOCKING:
5800 * Inherited from calling layer (may sleep).
5802 struct ata_host *ata_host_alloc_pinfo(struct device *dev,
5803 const struct ata_port_info * const * ppi,
5804 int n_ports)
5806 const struct ata_port_info *pi;
5807 struct ata_host *host;
5808 int i, j;
5810 host = ata_host_alloc(dev, n_ports);
5811 if (!host)
5812 return NULL;
5814 for (i = 0, j = 0, pi = NULL; i < host->n_ports; i++) {
5815 struct ata_port *ap = host->ports[i];
5817 if (ppi[j])
5818 pi = ppi[j++];
5820 ap->pio_mask = pi->pio_mask;
5821 ap->mwdma_mask = pi->mwdma_mask;
5822 ap->udma_mask = pi->udma_mask;
5823 ap->flags |= pi->flags;
5824 ap->link.flags |= pi->link_flags;
5825 ap->ops = pi->port_ops;
5827 if (!host->ops && (pi->port_ops != &ata_dummy_port_ops))
5828 host->ops = pi->port_ops;
5831 return host;
5835 * ata_slave_link_init - initialize slave link
5836 * @ap: port to initialize slave link for
5838 * Create and initialize slave link for @ap. This enables slave
5839 * link handling on the port.
5841 * In libata, a port contains links and a link contains devices.
5842 * There is single host link but if a PMP is attached to it,
5843 * there can be multiple fan-out links. On SATA, there's usually
5844 * a single device connected to a link but PATA and SATA
5845 * controllers emulating TF based interface can have two - master
5846 * and slave.
5848 * However, there are a few controllers which don't fit into this
5849 * abstraction too well - SATA controllers which emulate TF
5850 * interface with both master and slave devices but also have
5851 * separate SCR register sets for each device. These controllers
5852 * need separate links for physical link handling
5853 * (e.g. onlineness, link speed) but should be treated like a
5854 * traditional M/S controller for everything else (e.g. command
5855 * issue, softreset).
5857 * slave_link is libata's way of handling this class of
5858 * controllers without impacting core layer too much. For
5859 * anything other than physical link handling, the default host
5860 * link is used for both master and slave. For physical link
5861 * handling, separate @ap->slave_link is used. All dirty details
5862 * are implemented inside libata core layer. From LLD's POV, the
5863 * only difference is that prereset, hardreset and postreset are
5864 * called once more for the slave link, so the reset sequence
5865 * looks like the following.
5867 * prereset(M) -> prereset(S) -> hardreset(M) -> hardreset(S) ->
5868 * softreset(M) -> postreset(M) -> postreset(S)
5870 * Note that softreset is called only for the master. Softreset
5871 * resets both M/S by definition, so SRST on master should handle
5872 * both (the standard method will work just fine).
5874 * LOCKING:
5875 * Should be called before host is registered.
5877 * RETURNS:
5878 * 0 on success, -errno on failure.
5880 int ata_slave_link_init(struct ata_port *ap)
5882 struct ata_link *link;
5884 WARN_ON(ap->slave_link);
5885 WARN_ON(ap->flags & ATA_FLAG_PMP);
5887 link = kzalloc(sizeof(*link), GFP_KERNEL);
5888 if (!link)
5889 return -ENOMEM;
5891 ata_link_init(ap, link, 1);
5892 ap->slave_link = link;
5893 return 0;
5896 static void ata_host_stop(struct device *gendev, void *res)
5898 struct ata_host *host = dev_get_drvdata(gendev);
5899 int i;
5901 WARN_ON(!(host->flags & ATA_HOST_STARTED));
5903 for (i = 0; i < host->n_ports; i++) {
5904 struct ata_port *ap = host->ports[i];
5906 if (ap->ops->port_stop)
5907 ap->ops->port_stop(ap);
5910 if (host->ops->host_stop)
5911 host->ops->host_stop(host);
5915 * ata_finalize_port_ops - finalize ata_port_operations
5916 * @ops: ata_port_operations to finalize
5918 * An ata_port_operations can inherit from another ops and that
5919 * ops can again inherit from another. This can go on as many
5920 * times as necessary as long as there is no loop in the
5921 * inheritance chain.
5923 * Ops tables are finalized when the host is started. NULL or
5924 * unspecified entries are inherited from the closet ancestor
5925 * which has the method and the entry is populated with it.
5926 * After finalization, the ops table directly points to all the
5927 * methods and ->inherits is no longer necessary and cleared.
5929 * Using ATA_OP_NULL, inheriting ops can force a method to NULL.
5931 * LOCKING:
5932 * None.
5934 static void ata_finalize_port_ops(struct ata_port_operations *ops)
5936 static DEFINE_SPINLOCK(lock);
5937 const struct ata_port_operations *cur;
5938 void **begin = (void **)ops;
5939 void **end = (void **)&ops->inherits;
5940 void **pp;
5942 if (!ops || !ops->inherits)
5943 return;
5945 spin_lock(&lock);
5947 for (cur = ops->inherits; cur; cur = cur->inherits) {
5948 void **inherit = (void **)cur;
5950 for (pp = begin; pp < end; pp++, inherit++)
5951 if (!*pp)
5952 *pp = *inherit;
5955 for (pp = begin; pp < end; pp++)
5956 if (IS_ERR(*pp))
5957 *pp = NULL;
5959 ops->inherits = NULL;
5961 spin_unlock(&lock);
5965 * ata_host_start - start and freeze ports of an ATA host
5966 * @host: ATA host to start ports for
5968 * Start and then freeze ports of @host. Started status is
5969 * recorded in host->flags, so this function can be called
5970 * multiple times. Ports are guaranteed to get started only
5971 * once. If host->ops isn't initialized yet, its set to the
5972 * first non-dummy port ops.
5974 * LOCKING:
5975 * Inherited from calling layer (may sleep).
5977 * RETURNS:
5978 * 0 if all ports are started successfully, -errno otherwise.
5980 int ata_host_start(struct ata_host *host)
5982 int have_stop = 0;
5983 void *start_dr = NULL;
5984 int i, rc;
5986 if (host->flags & ATA_HOST_STARTED)
5987 return 0;
5989 ata_finalize_port_ops(host->ops);
5991 for (i = 0; i < host->n_ports; i++) {
5992 struct ata_port *ap = host->ports[i];
5994 ata_finalize_port_ops(ap->ops);
5996 if (!host->ops && !ata_port_is_dummy(ap))
5997 host->ops = ap->ops;
5999 if (ap->ops->port_stop)
6000 have_stop = 1;
6003 if (host->ops->host_stop)
6004 have_stop = 1;
6006 if (have_stop) {
6007 start_dr = devres_alloc(ata_host_stop, 0, GFP_KERNEL);
6008 if (!start_dr)
6009 return -ENOMEM;
6012 for (i = 0; i < host->n_ports; i++) {
6013 struct ata_port *ap = host->ports[i];
6015 if (ap->ops->port_start) {
6016 rc = ap->ops->port_start(ap);
6017 if (rc) {
6018 if (rc != -ENODEV)
6019 dev_err(host->dev,
6020 "failed to start port %d (errno=%d)\n",
6021 i, rc);
6022 goto err_out;
6025 ata_eh_freeze_port(ap);
6028 if (start_dr)
6029 devres_add(host->dev, start_dr);
6030 host->flags |= ATA_HOST_STARTED;
6031 return 0;
6033 err_out:
6034 while (--i >= 0) {
6035 struct ata_port *ap = host->ports[i];
6037 if (ap->ops->port_stop)
6038 ap->ops->port_stop(ap);
6040 devres_free(start_dr);
6041 return rc;
6045 * ata_sas_host_init - Initialize a host struct for sas (ipr, libsas)
6046 * @host: host to initialize
6047 * @dev: device host is attached to
6048 * @ops: port_ops
6051 void ata_host_init(struct ata_host *host, struct device *dev,
6052 struct ata_port_operations *ops)
6054 spin_lock_init(&host->lock);
6055 mutex_init(&host->eh_mutex);
6056 host->dev = dev;
6057 host->ops = ops;
6060 void __ata_port_probe(struct ata_port *ap)
6062 struct ata_eh_info *ehi = &ap->link.eh_info;
6063 unsigned long flags;
6065 /* kick EH for boot probing */
6066 spin_lock_irqsave(ap->lock, flags);
6068 ehi->probe_mask |= ATA_ALL_DEVICES;
6069 ehi->action |= ATA_EH_RESET;
6070 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
6072 ap->pflags &= ~ATA_PFLAG_INITIALIZING;
6073 ap->pflags |= ATA_PFLAG_LOADING;
6074 ata_port_schedule_eh(ap);
6076 spin_unlock_irqrestore(ap->lock, flags);
6079 int ata_port_probe(struct ata_port *ap)
6081 int rc = 0;
6083 if (ap->ops->error_handler) {
6084 __ata_port_probe(ap);
6085 ata_port_wait_eh(ap);
6086 } else {
6087 DPRINTK("ata%u: bus probe begin\n", ap->print_id);
6088 rc = ata_bus_probe(ap);
6089 DPRINTK("ata%u: bus probe end\n", ap->print_id);
6091 return rc;
6095 static void async_port_probe(void *data, async_cookie_t cookie)
6097 struct ata_port *ap = data;
6100 * If we're not allowed to scan this host in parallel,
6101 * we need to wait until all previous scans have completed
6102 * before going further.
6103 * Jeff Garzik says this is only within a controller, so we
6104 * don't need to wait for port 0, only for later ports.
6106 if (!(ap->host->flags & ATA_HOST_PARALLEL_SCAN) && ap->port_no != 0)
6107 async_synchronize_cookie(cookie);
6109 (void)ata_port_probe(ap);
6111 /* in order to keep device order, we need to synchronize at this point */
6112 async_synchronize_cookie(cookie);
6114 ata_scsi_scan_host(ap, 1);
6118 * ata_host_register - register initialized ATA host
6119 * @host: ATA host to register
6120 * @sht: template for SCSI host
6122 * Register initialized ATA host. @host is allocated using
6123 * ata_host_alloc() and fully initialized by LLD. This function
6124 * starts ports, registers @host with ATA and SCSI layers and
6125 * probe registered devices.
6127 * LOCKING:
6128 * Inherited from calling layer (may sleep).
6130 * RETURNS:
6131 * 0 on success, -errno otherwise.
6133 int ata_host_register(struct ata_host *host, struct scsi_host_template *sht)
6135 int i, rc;
6137 /* host must have been started */
6138 if (!(host->flags & ATA_HOST_STARTED)) {
6139 dev_err(host->dev, "BUG: trying to register unstarted host\n");
6140 WARN_ON(1);
6141 return -EINVAL;
6144 /* Blow away unused ports. This happens when LLD can't
6145 * determine the exact number of ports to allocate at
6146 * allocation time.
6148 for (i = host->n_ports; host->ports[i]; i++)
6149 kfree(host->ports[i]);
6151 /* give ports names and add SCSI hosts */
6152 for (i = 0; i < host->n_ports; i++) {
6153 host->ports[i]->print_id = atomic_inc_return(&ata_print_id);
6154 host->ports[i]->local_port_no = i + 1;
6157 /* Create associated sysfs transport objects */
6158 for (i = 0; i < host->n_ports; i++) {
6159 rc = ata_tport_add(host->dev,host->ports[i]);
6160 if (rc) {
6161 goto err_tadd;
6165 rc = ata_scsi_add_hosts(host, sht);
6166 if (rc)
6167 goto err_tadd;
6169 /* set cable, sata_spd_limit and report */
6170 for (i = 0; i < host->n_ports; i++) {
6171 struct ata_port *ap = host->ports[i];
6172 unsigned long xfer_mask;
6174 /* set SATA cable type if still unset */
6175 if (ap->cbl == ATA_CBL_NONE && (ap->flags & ATA_FLAG_SATA))
6176 ap->cbl = ATA_CBL_SATA;
6178 /* init sata_spd_limit to the current value */
6179 sata_link_init_spd(&ap->link);
6180 if (ap->slave_link)
6181 sata_link_init_spd(ap->slave_link);
6183 /* print per-port info to dmesg */
6184 xfer_mask = ata_pack_xfermask(ap->pio_mask, ap->mwdma_mask,
6185 ap->udma_mask);
6187 if (!ata_port_is_dummy(ap)) {
6188 ata_port_info(ap, "%cATA max %s %s\n",
6189 (ap->flags & ATA_FLAG_SATA) ? 'S' : 'P',
6190 ata_mode_string(xfer_mask),
6191 ap->link.eh_info.desc);
6192 ata_ehi_clear_desc(&ap->link.eh_info);
6193 } else
6194 ata_port_info(ap, "DUMMY\n");
6197 /* perform each probe asynchronously */
6198 for (i = 0; i < host->n_ports; i++) {
6199 struct ata_port *ap = host->ports[i];
6200 async_schedule(async_port_probe, ap);
6203 return 0;
6205 err_tadd:
6206 while (--i >= 0) {
6207 ata_tport_delete(host->ports[i]);
6209 return rc;
6214 * ata_host_activate - start host, request IRQ and register it
6215 * @host: target ATA host
6216 * @irq: IRQ to request
6217 * @irq_handler: irq_handler used when requesting IRQ
6218 * @irq_flags: irq_flags used when requesting IRQ
6219 * @sht: scsi_host_template to use when registering the host
6221 * After allocating an ATA host and initializing it, most libata
6222 * LLDs perform three steps to activate the host - start host,
6223 * request IRQ and register it. This helper takes necessasry
6224 * arguments and performs the three steps in one go.
6226 * An invalid IRQ skips the IRQ registration and expects the host to
6227 * have set polling mode on the port. In this case, @irq_handler
6228 * should be NULL.
6230 * LOCKING:
6231 * Inherited from calling layer (may sleep).
6233 * RETURNS:
6234 * 0 on success, -errno otherwise.
6236 int ata_host_activate(struct ata_host *host, int irq,
6237 irq_handler_t irq_handler, unsigned long irq_flags,
6238 struct scsi_host_template *sht)
6240 int i, rc;
6242 rc = ata_host_start(host);
6243 if (rc)
6244 return rc;
6246 /* Special case for polling mode */
6247 if (!irq) {
6248 WARN_ON(irq_handler);
6249 return ata_host_register(host, sht);
6252 rc = devm_request_irq(host->dev, irq, irq_handler, irq_flags,
6253 dev_driver_string(host->dev), host);
6254 if (rc)
6255 return rc;
6257 for (i = 0; i < host->n_ports; i++)
6258 ata_port_desc(host->ports[i], "irq %d", irq);
6260 rc = ata_host_register(host, sht);
6261 /* if failed, just free the IRQ and leave ports alone */
6262 if (rc)
6263 devm_free_irq(host->dev, irq, host);
6265 return rc;
6269 * ata_port_detach - Detach ATA port in prepration of device removal
6270 * @ap: ATA port to be detached
6272 * Detach all ATA devices and the associated SCSI devices of @ap;
6273 * then, remove the associated SCSI host. @ap is guaranteed to
6274 * be quiescent on return from this function.
6276 * LOCKING:
6277 * Kernel thread context (may sleep).
6279 static void ata_port_detach(struct ata_port *ap)
6281 unsigned long flags;
6283 if (!ap->ops->error_handler)
6284 goto skip_eh;
6286 /* tell EH we're leaving & flush EH */
6287 spin_lock_irqsave(ap->lock, flags);
6288 ap->pflags |= ATA_PFLAG_UNLOADING;
6289 ata_port_schedule_eh(ap);
6290 spin_unlock_irqrestore(ap->lock, flags);
6292 /* wait till EH commits suicide */
6293 ata_port_wait_eh(ap);
6295 /* it better be dead now */
6296 WARN_ON(!(ap->pflags & ATA_PFLAG_UNLOADED));
6298 cancel_delayed_work_sync(&ap->hotplug_task);
6300 skip_eh:
6301 if (ap->pmp_link) {
6302 int i;
6303 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
6304 ata_tlink_delete(&ap->pmp_link[i]);
6306 ata_tport_delete(ap);
6308 /* remove the associated SCSI host */
6309 scsi_remove_host(ap->scsi_host);
6313 * ata_host_detach - Detach all ports of an ATA host
6314 * @host: Host to detach
6316 * Detach all ports of @host.
6318 * LOCKING:
6319 * Kernel thread context (may sleep).
6321 void ata_host_detach(struct ata_host *host)
6323 int i;
6325 for (i = 0; i < host->n_ports; i++)
6326 ata_port_detach(host->ports[i]);
6328 /* the host is dead now, dissociate ACPI */
6329 ata_acpi_dissociate(host);
6332 #ifdef CONFIG_PCI
6335 * ata_pci_remove_one - PCI layer callback for device removal
6336 * @pdev: PCI device that was removed
6338 * PCI layer indicates to libata via this hook that hot-unplug or
6339 * module unload event has occurred. Detach all ports. Resource
6340 * release is handled via devres.
6342 * LOCKING:
6343 * Inherited from PCI layer (may sleep).
6345 void ata_pci_remove_one(struct pci_dev *pdev)
6347 struct ata_host *host = pci_get_drvdata(pdev);
6349 ata_host_detach(host);
6352 /* move to PCI subsystem */
6353 int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
6355 unsigned long tmp = 0;
6357 switch (bits->width) {
6358 case 1: {
6359 u8 tmp8 = 0;
6360 pci_read_config_byte(pdev, bits->reg, &tmp8);
6361 tmp = tmp8;
6362 break;
6364 case 2: {
6365 u16 tmp16 = 0;
6366 pci_read_config_word(pdev, bits->reg, &tmp16);
6367 tmp = tmp16;
6368 break;
6370 case 4: {
6371 u32 tmp32 = 0;
6372 pci_read_config_dword(pdev, bits->reg, &tmp32);
6373 tmp = tmp32;
6374 break;
6377 default:
6378 return -EINVAL;
6381 tmp &= bits->mask;
6383 return (tmp == bits->val) ? 1 : 0;
6386 #ifdef CONFIG_PM
6387 void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg)
6389 pci_save_state(pdev);
6390 pci_disable_device(pdev);
6392 if (mesg.event & PM_EVENT_SLEEP)
6393 pci_set_power_state(pdev, PCI_D3hot);
6396 int ata_pci_device_do_resume(struct pci_dev *pdev)
6398 int rc;
6400 pci_set_power_state(pdev, PCI_D0);
6401 pci_restore_state(pdev);
6403 rc = pcim_enable_device(pdev);
6404 if (rc) {
6405 dev_err(&pdev->dev,
6406 "failed to enable device after resume (%d)\n", rc);
6407 return rc;
6410 pci_set_master(pdev);
6411 return 0;
6414 int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
6416 struct ata_host *host = pci_get_drvdata(pdev);
6417 int rc = 0;
6419 rc = ata_host_suspend(host, mesg);
6420 if (rc)
6421 return rc;
6423 ata_pci_device_do_suspend(pdev, mesg);
6425 return 0;
6428 int ata_pci_device_resume(struct pci_dev *pdev)
6430 struct ata_host *host = pci_get_drvdata(pdev);
6431 int rc;
6433 rc = ata_pci_device_do_resume(pdev);
6434 if (rc == 0)
6435 ata_host_resume(host);
6436 return rc;
6438 #endif /* CONFIG_PM */
6440 #endif /* CONFIG_PCI */
6443 * ata_platform_remove_one - Platform layer callback for device removal
6444 * @pdev: Platform device that was removed
6446 * Platform layer indicates to libata via this hook that hot-unplug or
6447 * module unload event has occurred. Detach all ports. Resource
6448 * release is handled via devres.
6450 * LOCKING:
6451 * Inherited from platform layer (may sleep).
6453 int ata_platform_remove_one(struct platform_device *pdev)
6455 struct ata_host *host = platform_get_drvdata(pdev);
6457 ata_host_detach(host);
6459 return 0;
6462 static int __init ata_parse_force_one(char **cur,
6463 struct ata_force_ent *force_ent,
6464 const char **reason)
6466 /* FIXME: Currently, there's no way to tag init const data and
6467 * using __initdata causes build failure on some versions of
6468 * gcc. Once __initdataconst is implemented, add const to the
6469 * following structure.
6471 static struct ata_force_param force_tbl[] __initdata = {
6472 { "40c", .cbl = ATA_CBL_PATA40 },
6473 { "80c", .cbl = ATA_CBL_PATA80 },
6474 { "short40c", .cbl = ATA_CBL_PATA40_SHORT },
6475 { "unk", .cbl = ATA_CBL_PATA_UNK },
6476 { "ign", .cbl = ATA_CBL_PATA_IGN },
6477 { "sata", .cbl = ATA_CBL_SATA },
6478 { "1.5Gbps", .spd_limit = 1 },
6479 { "3.0Gbps", .spd_limit = 2 },
6480 { "noncq", .horkage_on = ATA_HORKAGE_NONCQ },
6481 { "ncq", .horkage_off = ATA_HORKAGE_NONCQ },
6482 { "dump_id", .horkage_on = ATA_HORKAGE_DUMP_ID },
6483 { "pio0", .xfer_mask = 1 << (ATA_SHIFT_PIO + 0) },
6484 { "pio1", .xfer_mask = 1 << (ATA_SHIFT_PIO + 1) },
6485 { "pio2", .xfer_mask = 1 << (ATA_SHIFT_PIO + 2) },
6486 { "pio3", .xfer_mask = 1 << (ATA_SHIFT_PIO + 3) },
6487 { "pio4", .xfer_mask = 1 << (ATA_SHIFT_PIO + 4) },
6488 { "pio5", .xfer_mask = 1 << (ATA_SHIFT_PIO + 5) },
6489 { "pio6", .xfer_mask = 1 << (ATA_SHIFT_PIO + 6) },
6490 { "mwdma0", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 0) },
6491 { "mwdma1", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 1) },
6492 { "mwdma2", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 2) },
6493 { "mwdma3", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 3) },
6494 { "mwdma4", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 4) },
6495 { "udma0", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6496 { "udma16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6497 { "udma/16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6498 { "udma1", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6499 { "udma25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6500 { "udma/25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6501 { "udma2", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6502 { "udma33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6503 { "udma/33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6504 { "udma3", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6505 { "udma44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6506 { "udma/44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6507 { "udma4", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6508 { "udma66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6509 { "udma/66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6510 { "udma5", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6511 { "udma100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6512 { "udma/100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6513 { "udma6", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6514 { "udma133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6515 { "udma/133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6516 { "udma7", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 7) },
6517 { "nohrst", .lflags = ATA_LFLAG_NO_HRST },
6518 { "nosrst", .lflags = ATA_LFLAG_NO_SRST },
6519 { "norst", .lflags = ATA_LFLAG_NO_HRST | ATA_LFLAG_NO_SRST },
6520 { "rstonce", .lflags = ATA_LFLAG_RST_ONCE },
6521 { "atapi_dmadir", .horkage_on = ATA_HORKAGE_ATAPI_DMADIR },
6523 char *start = *cur, *p = *cur;
6524 char *id, *val, *endp;
6525 const struct ata_force_param *match_fp = NULL;
6526 int nr_matches = 0, i;
6528 /* find where this param ends and update *cur */
6529 while (*p != '\0' && *p != ',')
6530 p++;
6532 if (*p == '\0')
6533 *cur = p;
6534 else
6535 *cur = p + 1;
6537 *p = '\0';
6539 /* parse */
6540 p = strchr(start, ':');
6541 if (!p) {
6542 val = strstrip(start);
6543 goto parse_val;
6545 *p = '\0';
6547 id = strstrip(start);
6548 val = strstrip(p + 1);
6550 /* parse id */
6551 p = strchr(id, '.');
6552 if (p) {
6553 *p++ = '\0';
6554 force_ent->device = simple_strtoul(p, &endp, 10);
6555 if (p == endp || *endp != '\0') {
6556 *reason = "invalid device";
6557 return -EINVAL;
6561 force_ent->port = simple_strtoul(id, &endp, 10);
6562 if (p == endp || *endp != '\0') {
6563 *reason = "invalid port/link";
6564 return -EINVAL;
6567 parse_val:
6568 /* parse val, allow shortcuts so that both 1.5 and 1.5Gbps work */
6569 for (i = 0; i < ARRAY_SIZE(force_tbl); i++) {
6570 const struct ata_force_param *fp = &force_tbl[i];
6572 if (strncasecmp(val, fp->name, strlen(val)))
6573 continue;
6575 nr_matches++;
6576 match_fp = fp;
6578 if (strcasecmp(val, fp->name) == 0) {
6579 nr_matches = 1;
6580 break;
6584 if (!nr_matches) {
6585 *reason = "unknown value";
6586 return -EINVAL;
6588 if (nr_matches > 1) {
6589 *reason = "ambigious value";
6590 return -EINVAL;
6593 force_ent->param = *match_fp;
6595 return 0;
6598 static void __init ata_parse_force_param(void)
6600 int idx = 0, size = 1;
6601 int last_port = -1, last_device = -1;
6602 char *p, *cur, *next;
6604 /* calculate maximum number of params and allocate force_tbl */
6605 for (p = ata_force_param_buf; *p; p++)
6606 if (*p == ',')
6607 size++;
6609 ata_force_tbl = kzalloc(sizeof(ata_force_tbl[0]) * size, GFP_KERNEL);
6610 if (!ata_force_tbl) {
6611 printk(KERN_WARNING "ata: failed to extend force table, "
6612 "libata.force ignored\n");
6613 return;
6616 /* parse and populate the table */
6617 for (cur = ata_force_param_buf; *cur != '\0'; cur = next) {
6618 const char *reason = "";
6619 struct ata_force_ent te = { .port = -1, .device = -1 };
6621 next = cur;
6622 if (ata_parse_force_one(&next, &te, &reason)) {
6623 printk(KERN_WARNING "ata: failed to parse force "
6624 "parameter \"%s\" (%s)\n",
6625 cur, reason);
6626 continue;
6629 if (te.port == -1) {
6630 te.port = last_port;
6631 te.device = last_device;
6634 ata_force_tbl[idx++] = te;
6636 last_port = te.port;
6637 last_device = te.device;
6640 ata_force_tbl_size = idx;
6643 static int __init ata_init(void)
6645 int rc;
6647 ata_parse_force_param();
6649 rc = ata_sff_init();
6650 if (rc) {
6651 kfree(ata_force_tbl);
6652 return rc;
6655 libata_transport_init();
6656 ata_scsi_transport_template = ata_attach_transport();
6657 if (!ata_scsi_transport_template) {
6658 ata_sff_exit();
6659 rc = -ENOMEM;
6660 goto err_out;
6663 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
6664 return 0;
6666 err_out:
6667 return rc;
6670 static void __exit ata_exit(void)
6672 ata_release_transport(ata_scsi_transport_template);
6673 libata_transport_exit();
6674 ata_sff_exit();
6675 kfree(ata_force_tbl);
6678 subsys_initcall(ata_init);
6679 module_exit(ata_exit);
6681 static DEFINE_RATELIMIT_STATE(ratelimit, HZ / 5, 1);
6683 int ata_ratelimit(void)
6685 return __ratelimit(&ratelimit);
6689 * ata_msleep - ATA EH owner aware msleep
6690 * @ap: ATA port to attribute the sleep to
6691 * @msecs: duration to sleep in milliseconds
6693 * Sleeps @msecs. If the current task is owner of @ap's EH, the
6694 * ownership is released before going to sleep and reacquired
6695 * after the sleep is complete. IOW, other ports sharing the
6696 * @ap->host will be allowed to own the EH while this task is
6697 * sleeping.
6699 * LOCKING:
6700 * Might sleep.
6702 void ata_msleep(struct ata_port *ap, unsigned int msecs)
6704 bool owns_eh = ap && ap->host->eh_owner == current;
6706 if (owns_eh)
6707 ata_eh_release(ap);
6709 msleep(msecs);
6711 if (owns_eh)
6712 ata_eh_acquire(ap);
6716 * ata_wait_register - wait until register value changes
6717 * @ap: ATA port to wait register for, can be NULL
6718 * @reg: IO-mapped register
6719 * @mask: Mask to apply to read register value
6720 * @val: Wait condition
6721 * @interval: polling interval in milliseconds
6722 * @timeout: timeout in milliseconds
6724 * Waiting for some bits of register to change is a common
6725 * operation for ATA controllers. This function reads 32bit LE
6726 * IO-mapped register @reg and tests for the following condition.
6728 * (*@reg & mask) != val
6730 * If the condition is met, it returns; otherwise, the process is
6731 * repeated after @interval_msec until timeout.
6733 * LOCKING:
6734 * Kernel thread context (may sleep)
6736 * RETURNS:
6737 * The final register value.
6739 u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask, u32 val,
6740 unsigned long interval, unsigned long timeout)
6742 unsigned long deadline;
6743 u32 tmp;
6745 tmp = ioread32(reg);
6747 /* Calculate timeout _after_ the first read to make sure
6748 * preceding writes reach the controller before starting to
6749 * eat away the timeout.
6751 deadline = ata_deadline(jiffies, timeout);
6753 while ((tmp & mask) == val && time_before(jiffies, deadline)) {
6754 ata_msleep(ap, interval);
6755 tmp = ioread32(reg);
6758 return tmp;
6762 * Dummy port_ops
6764 static unsigned int ata_dummy_qc_issue(struct ata_queued_cmd *qc)
6766 return AC_ERR_SYSTEM;
6769 static void ata_dummy_error_handler(struct ata_port *ap)
6771 /* truly dummy */
6774 struct ata_port_operations ata_dummy_port_ops = {
6775 .qc_prep = ata_noop_qc_prep,
6776 .qc_issue = ata_dummy_qc_issue,
6777 .error_handler = ata_dummy_error_handler,
6778 .sched_eh = ata_std_sched_eh,
6779 .end_eh = ata_std_end_eh,
6782 const struct ata_port_info ata_dummy_port_info = {
6783 .port_ops = &ata_dummy_port_ops,
6787 * Utility print functions
6789 int ata_port_printk(const struct ata_port *ap, const char *level,
6790 const char *fmt, ...)
6792 struct va_format vaf;
6793 va_list args;
6794 int r;
6796 va_start(args, fmt);
6798 vaf.fmt = fmt;
6799 vaf.va = &args;
6801 r = printk("%sata%u: %pV", level, ap->print_id, &vaf);
6803 va_end(args);
6805 return r;
6807 EXPORT_SYMBOL(ata_port_printk);
6809 int ata_link_printk(const struct ata_link *link, const char *level,
6810 const char *fmt, ...)
6812 struct va_format vaf;
6813 va_list args;
6814 int r;
6816 va_start(args, fmt);
6818 vaf.fmt = fmt;
6819 vaf.va = &args;
6821 if (sata_pmp_attached(link->ap) || link->ap->slave_link)
6822 r = printk("%sata%u.%02u: %pV",
6823 level, link->ap->print_id, link->pmp, &vaf);
6824 else
6825 r = printk("%sata%u: %pV",
6826 level, link->ap->print_id, &vaf);
6828 va_end(args);
6830 return r;
6832 EXPORT_SYMBOL(ata_link_printk);
6834 int ata_dev_printk(const struct ata_device *dev, const char *level,
6835 const char *fmt, ...)
6837 struct va_format vaf;
6838 va_list args;
6839 int r;
6841 va_start(args, fmt);
6843 vaf.fmt = fmt;
6844 vaf.va = &args;
6846 r = printk("%sata%u.%02u: %pV",
6847 level, dev->link->ap->print_id, dev->link->pmp + dev->devno,
6848 &vaf);
6850 va_end(args);
6852 return r;
6854 EXPORT_SYMBOL(ata_dev_printk);
6856 void ata_print_version(const struct device *dev, const char *version)
6858 dev_printk(KERN_DEBUG, dev, "version %s\n", version);
6860 EXPORT_SYMBOL(ata_print_version);
6863 * libata is essentially a library of internal helper functions for
6864 * low-level ATA host controller drivers. As such, the API/ABI is
6865 * likely to change as new drivers are added and updated.
6866 * Do not depend on ABI/API stability.
6868 EXPORT_SYMBOL_GPL(sata_deb_timing_normal);
6869 EXPORT_SYMBOL_GPL(sata_deb_timing_hotplug);
6870 EXPORT_SYMBOL_GPL(sata_deb_timing_long);
6871 EXPORT_SYMBOL_GPL(ata_base_port_ops);
6872 EXPORT_SYMBOL_GPL(sata_port_ops);
6873 EXPORT_SYMBOL_GPL(ata_dummy_port_ops);
6874 EXPORT_SYMBOL_GPL(ata_dummy_port_info);
6875 EXPORT_SYMBOL_GPL(ata_link_next);
6876 EXPORT_SYMBOL_GPL(ata_dev_next);
6877 EXPORT_SYMBOL_GPL(ata_std_bios_param);
6878 EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
6879 EXPORT_SYMBOL_GPL(ata_host_init);
6880 EXPORT_SYMBOL_GPL(ata_host_alloc);
6881 EXPORT_SYMBOL_GPL(ata_host_alloc_pinfo);
6882 EXPORT_SYMBOL_GPL(ata_slave_link_init);
6883 EXPORT_SYMBOL_GPL(ata_host_start);
6884 EXPORT_SYMBOL_GPL(ata_host_register);
6885 EXPORT_SYMBOL_GPL(ata_host_activate);
6886 EXPORT_SYMBOL_GPL(ata_host_detach);
6887 EXPORT_SYMBOL_GPL(ata_sg_init);
6888 EXPORT_SYMBOL_GPL(ata_qc_complete);
6889 EXPORT_SYMBOL_GPL(ata_qc_complete_multiple);
6890 EXPORT_SYMBOL_GPL(atapi_cmd_type);
6891 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
6892 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
6893 EXPORT_SYMBOL_GPL(ata_pack_xfermask);
6894 EXPORT_SYMBOL_GPL(ata_unpack_xfermask);
6895 EXPORT_SYMBOL_GPL(ata_xfer_mask2mode);
6896 EXPORT_SYMBOL_GPL(ata_xfer_mode2mask);
6897 EXPORT_SYMBOL_GPL(ata_xfer_mode2shift);
6898 EXPORT_SYMBOL_GPL(ata_mode_string);
6899 EXPORT_SYMBOL_GPL(ata_id_xfermask);
6900 EXPORT_SYMBOL_GPL(ata_do_set_mode);
6901 EXPORT_SYMBOL_GPL(ata_std_qc_defer);
6902 EXPORT_SYMBOL_GPL(ata_noop_qc_prep);
6903 EXPORT_SYMBOL_GPL(ata_dev_disable);
6904 EXPORT_SYMBOL_GPL(sata_set_spd);
6905 EXPORT_SYMBOL_GPL(ata_wait_after_reset);
6906 EXPORT_SYMBOL_GPL(sata_link_debounce);
6907 EXPORT_SYMBOL_GPL(sata_link_resume);
6908 EXPORT_SYMBOL_GPL(sata_link_scr_lpm);
6909 EXPORT_SYMBOL_GPL(ata_std_prereset);
6910 EXPORT_SYMBOL_GPL(sata_link_hardreset);
6911 EXPORT_SYMBOL_GPL(sata_std_hardreset);
6912 EXPORT_SYMBOL_GPL(ata_std_postreset);
6913 EXPORT_SYMBOL_GPL(ata_dev_classify);
6914 EXPORT_SYMBOL_GPL(ata_dev_pair);
6915 EXPORT_SYMBOL_GPL(ata_ratelimit);
6916 EXPORT_SYMBOL_GPL(ata_msleep);
6917 EXPORT_SYMBOL_GPL(ata_wait_register);
6918 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
6919 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
6920 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
6921 EXPORT_SYMBOL_GPL(ata_scsi_change_queue_depth);
6922 EXPORT_SYMBOL_GPL(__ata_change_queue_depth);
6923 EXPORT_SYMBOL_GPL(sata_scr_valid);
6924 EXPORT_SYMBOL_GPL(sata_scr_read);
6925 EXPORT_SYMBOL_GPL(sata_scr_write);
6926 EXPORT_SYMBOL_GPL(sata_scr_write_flush);
6927 EXPORT_SYMBOL_GPL(ata_link_online);
6928 EXPORT_SYMBOL_GPL(ata_link_offline);
6929 #ifdef CONFIG_PM
6930 EXPORT_SYMBOL_GPL(ata_host_suspend);
6931 EXPORT_SYMBOL_GPL(ata_host_resume);
6932 #endif /* CONFIG_PM */
6933 EXPORT_SYMBOL_GPL(ata_id_string);
6934 EXPORT_SYMBOL_GPL(ata_id_c_string);
6935 EXPORT_SYMBOL_GPL(ata_do_dev_read_id);
6936 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
6938 EXPORT_SYMBOL_GPL(ata_pio_need_iordy);
6939 EXPORT_SYMBOL_GPL(ata_timing_find_mode);
6940 EXPORT_SYMBOL_GPL(ata_timing_compute);
6941 EXPORT_SYMBOL_GPL(ata_timing_merge);
6942 EXPORT_SYMBOL_GPL(ata_timing_cycle2mode);
6944 #ifdef CONFIG_PCI
6945 EXPORT_SYMBOL_GPL(pci_test_config_bits);
6946 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
6947 #ifdef CONFIG_PM
6948 EXPORT_SYMBOL_GPL(ata_pci_device_do_suspend);
6949 EXPORT_SYMBOL_GPL(ata_pci_device_do_resume);
6950 EXPORT_SYMBOL_GPL(ata_pci_device_suspend);
6951 EXPORT_SYMBOL_GPL(ata_pci_device_resume);
6952 #endif /* CONFIG_PM */
6953 #endif /* CONFIG_PCI */
6955 EXPORT_SYMBOL_GPL(ata_platform_remove_one);
6957 EXPORT_SYMBOL_GPL(__ata_ehi_push_desc);
6958 EXPORT_SYMBOL_GPL(ata_ehi_push_desc);
6959 EXPORT_SYMBOL_GPL(ata_ehi_clear_desc);
6960 EXPORT_SYMBOL_GPL(ata_port_desc);
6961 #ifdef CONFIG_PCI
6962 EXPORT_SYMBOL_GPL(ata_port_pbar_desc);
6963 #endif /* CONFIG_PCI */
6964 EXPORT_SYMBOL_GPL(ata_port_schedule_eh);
6965 EXPORT_SYMBOL_GPL(ata_link_abort);
6966 EXPORT_SYMBOL_GPL(ata_port_abort);
6967 EXPORT_SYMBOL_GPL(ata_port_freeze);
6968 EXPORT_SYMBOL_GPL(sata_async_notification);
6969 EXPORT_SYMBOL_GPL(ata_eh_freeze_port);
6970 EXPORT_SYMBOL_GPL(ata_eh_thaw_port);
6971 EXPORT_SYMBOL_GPL(ata_eh_qc_complete);
6972 EXPORT_SYMBOL_GPL(ata_eh_qc_retry);
6973 EXPORT_SYMBOL_GPL(ata_eh_analyze_ncq_error);
6974 EXPORT_SYMBOL_GPL(ata_do_eh);
6975 EXPORT_SYMBOL_GPL(ata_std_error_handler);
6977 EXPORT_SYMBOL_GPL(ata_cable_40wire);
6978 EXPORT_SYMBOL_GPL(ata_cable_80wire);
6979 EXPORT_SYMBOL_GPL(ata_cable_unknown);
6980 EXPORT_SYMBOL_GPL(ata_cable_ignore);
6981 EXPORT_SYMBOL_GPL(ata_cable_sata);