ovl: factor out ovl_get_index_fh() helper
[linux/fpc-iii.git] / drivers / ata / libata-core.c
blob8193b38a1cae7a8d738fb4c29828654dd02f0572
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/driver-api/libata.rst
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/time.h>
54 #include <linux/interrupt.h>
55 #include <linux/completion.h>
56 #include <linux/suspend.h>
57 #include <linux/workqueue.h>
58 #include <linux/scatterlist.h>
59 #include <linux/io.h>
60 #include <linux/async.h>
61 #include <linux/log2.h>
62 #include <linux/slab.h>
63 #include <linux/glob.h>
64 #include <scsi/scsi.h>
65 #include <scsi/scsi_cmnd.h>
66 #include <scsi/scsi_host.h>
67 #include <linux/libata.h>
68 #include <asm/byteorder.h>
69 #include <asm/unaligned.h>
70 #include <linux/cdrom.h>
71 #include <linux/ratelimit.h>
72 #include <linux/leds.h>
73 #include <linux/pm_runtime.h>
74 #include <linux/platform_device.h>
76 #define CREATE_TRACE_POINTS
77 #include <trace/events/libata.h>
79 #include "libata.h"
80 #include "libata-transport.h"
82 /* debounce timing parameters in msecs { interval, duration, timeout } */
83 const unsigned long sata_deb_timing_normal[] = { 5, 100, 2000 };
84 const unsigned long sata_deb_timing_hotplug[] = { 25, 500, 2000 };
85 const unsigned long sata_deb_timing_long[] = { 100, 2000, 5000 };
87 const struct ata_port_operations ata_base_port_ops = {
88 .prereset = ata_std_prereset,
89 .postreset = ata_std_postreset,
90 .error_handler = ata_std_error_handler,
91 .sched_eh = ata_std_sched_eh,
92 .end_eh = ata_std_end_eh,
95 const struct ata_port_operations sata_port_ops = {
96 .inherits = &ata_base_port_ops,
98 .qc_defer = ata_std_qc_defer,
99 .hardreset = sata_std_hardreset,
102 static unsigned int ata_dev_init_params(struct ata_device *dev,
103 u16 heads, u16 sectors);
104 static unsigned int ata_dev_set_xfermode(struct ata_device *dev);
105 static void ata_dev_xfermask(struct ata_device *dev);
106 static unsigned long ata_dev_blacklisted(const struct ata_device *dev);
108 atomic_t ata_print_id = ATOMIC_INIT(0);
110 struct ata_force_param {
111 const char *name;
112 unsigned int cbl;
113 int spd_limit;
114 unsigned long xfer_mask;
115 unsigned int horkage_on;
116 unsigned int horkage_off;
117 unsigned int lflags;
120 struct ata_force_ent {
121 int port;
122 int device;
123 struct ata_force_param param;
126 static struct ata_force_ent *ata_force_tbl;
127 static int ata_force_tbl_size;
129 static char ata_force_param_buf[PAGE_SIZE] __initdata;
130 /* param_buf is thrown away after initialization, disallow read */
131 module_param_string(force, ata_force_param_buf, sizeof(ata_force_param_buf), 0);
132 MODULE_PARM_DESC(force, "Force ATA configurations including cable type, link speed and transfer mode (see Documentation/admin-guide/kernel-parameters.rst for details)");
134 static int atapi_enabled = 1;
135 module_param(atapi_enabled, int, 0444);
136 MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on [default])");
138 static int atapi_dmadir = 0;
139 module_param(atapi_dmadir, int, 0444);
140 MODULE_PARM_DESC(atapi_dmadir, "Enable ATAPI DMADIR bridge support (0=off [default], 1=on)");
142 int atapi_passthru16 = 1;
143 module_param(atapi_passthru16, int, 0444);
144 MODULE_PARM_DESC(atapi_passthru16, "Enable ATA_16 passthru for ATAPI devices (0=off, 1=on [default])");
146 int libata_fua = 0;
147 module_param_named(fua, libata_fua, int, 0444);
148 MODULE_PARM_DESC(fua, "FUA support (0=off [default], 1=on)");
150 static int ata_ignore_hpa;
151 module_param_named(ignore_hpa, ata_ignore_hpa, int, 0644);
152 MODULE_PARM_DESC(ignore_hpa, "Ignore HPA limit (0=keep BIOS limits, 1=ignore limits, using full disk)");
154 static int libata_dma_mask = ATA_DMA_MASK_ATA|ATA_DMA_MASK_ATAPI|ATA_DMA_MASK_CFA;
155 module_param_named(dma, libata_dma_mask, int, 0444);
156 MODULE_PARM_DESC(dma, "DMA enable/disable (0x1==ATA, 0x2==ATAPI, 0x4==CF)");
158 static int ata_probe_timeout;
159 module_param(ata_probe_timeout, int, 0444);
160 MODULE_PARM_DESC(ata_probe_timeout, "Set ATA probing timeout (seconds)");
162 int libata_noacpi = 0;
163 module_param_named(noacpi, libata_noacpi, int, 0444);
164 MODULE_PARM_DESC(noacpi, "Disable the use of ACPI in probe/suspend/resume (0=off [default], 1=on)");
166 int libata_allow_tpm = 0;
167 module_param_named(allow_tpm, libata_allow_tpm, int, 0444);
168 MODULE_PARM_DESC(allow_tpm, "Permit the use of TPM commands (0=off [default], 1=on)");
170 static int atapi_an;
171 module_param(atapi_an, int, 0444);
172 MODULE_PARM_DESC(atapi_an, "Enable ATAPI AN media presence notification (0=0ff [default], 1=on)");
174 MODULE_AUTHOR("Jeff Garzik");
175 MODULE_DESCRIPTION("Library module for ATA devices");
176 MODULE_LICENSE("GPL");
177 MODULE_VERSION(DRV_VERSION);
180 static bool ata_sstatus_online(u32 sstatus)
182 return (sstatus & 0xf) == 0x3;
186 * ata_link_next - link iteration helper
187 * @link: the previous link, NULL to start
188 * @ap: ATA port containing links to iterate
189 * @mode: iteration mode, one of ATA_LITER_*
191 * LOCKING:
192 * Host lock or EH context.
194 * RETURNS:
195 * Pointer to the next link.
197 struct ata_link *ata_link_next(struct ata_link *link, struct ata_port *ap,
198 enum ata_link_iter_mode mode)
200 BUG_ON(mode != ATA_LITER_EDGE &&
201 mode != ATA_LITER_PMP_FIRST && mode != ATA_LITER_HOST_FIRST);
203 /* NULL link indicates start of iteration */
204 if (!link)
205 switch (mode) {
206 case ATA_LITER_EDGE:
207 case ATA_LITER_PMP_FIRST:
208 if (sata_pmp_attached(ap))
209 return ap->pmp_link;
210 /* fall through */
211 case ATA_LITER_HOST_FIRST:
212 return &ap->link;
215 /* we just iterated over the host link, what's next? */
216 if (link == &ap->link)
217 switch (mode) {
218 case ATA_LITER_HOST_FIRST:
219 if (sata_pmp_attached(ap))
220 return ap->pmp_link;
221 /* fall through */
222 case ATA_LITER_PMP_FIRST:
223 if (unlikely(ap->slave_link))
224 return ap->slave_link;
225 /* fall through */
226 case ATA_LITER_EDGE:
227 return NULL;
230 /* slave_link excludes PMP */
231 if (unlikely(link == ap->slave_link))
232 return NULL;
234 /* we were over a PMP link */
235 if (++link < ap->pmp_link + ap->nr_pmp_links)
236 return link;
238 if (mode == ATA_LITER_PMP_FIRST)
239 return &ap->link;
241 return NULL;
245 * ata_dev_next - device iteration helper
246 * @dev: the previous device, NULL to start
247 * @link: ATA link containing devices to iterate
248 * @mode: iteration mode, one of ATA_DITER_*
250 * LOCKING:
251 * Host lock or EH context.
253 * RETURNS:
254 * Pointer to the next device.
256 struct ata_device *ata_dev_next(struct ata_device *dev, struct ata_link *link,
257 enum ata_dev_iter_mode mode)
259 BUG_ON(mode != ATA_DITER_ENABLED && mode != ATA_DITER_ENABLED_REVERSE &&
260 mode != ATA_DITER_ALL && mode != ATA_DITER_ALL_REVERSE);
262 /* NULL dev indicates start of iteration */
263 if (!dev)
264 switch (mode) {
265 case ATA_DITER_ENABLED:
266 case ATA_DITER_ALL:
267 dev = link->device;
268 goto check;
269 case ATA_DITER_ENABLED_REVERSE:
270 case ATA_DITER_ALL_REVERSE:
271 dev = link->device + ata_link_max_devices(link) - 1;
272 goto check;
275 next:
276 /* move to the next one */
277 switch (mode) {
278 case ATA_DITER_ENABLED:
279 case ATA_DITER_ALL:
280 if (++dev < link->device + ata_link_max_devices(link))
281 goto check;
282 return NULL;
283 case ATA_DITER_ENABLED_REVERSE:
284 case ATA_DITER_ALL_REVERSE:
285 if (--dev >= link->device)
286 goto check;
287 return NULL;
290 check:
291 if ((mode == ATA_DITER_ENABLED || mode == ATA_DITER_ENABLED_REVERSE) &&
292 !ata_dev_enabled(dev))
293 goto next;
294 return dev;
298 * ata_dev_phys_link - find physical link for a device
299 * @dev: ATA device to look up physical link for
301 * Look up physical link which @dev is attached to. Note that
302 * this is different from @dev->link only when @dev is on slave
303 * link. For all other cases, it's the same as @dev->link.
305 * LOCKING:
306 * Don't care.
308 * RETURNS:
309 * Pointer to the found physical link.
311 struct ata_link *ata_dev_phys_link(struct ata_device *dev)
313 struct ata_port *ap = dev->link->ap;
315 if (!ap->slave_link)
316 return dev->link;
317 if (!dev->devno)
318 return &ap->link;
319 return ap->slave_link;
323 * ata_force_cbl - force cable type according to libata.force
324 * @ap: ATA port of interest
326 * Force cable type according to libata.force and whine about it.
327 * The last entry which has matching port number is used, so it
328 * can be specified as part of device force parameters. For
329 * example, both "a:40c,1.00:udma4" and "1.00:40c,udma4" have the
330 * same effect.
332 * LOCKING:
333 * EH context.
335 void ata_force_cbl(struct ata_port *ap)
337 int i;
339 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
340 const struct ata_force_ent *fe = &ata_force_tbl[i];
342 if (fe->port != -1 && fe->port != ap->print_id)
343 continue;
345 if (fe->param.cbl == ATA_CBL_NONE)
346 continue;
348 ap->cbl = fe->param.cbl;
349 ata_port_notice(ap, "FORCE: cable set to %s\n", fe->param.name);
350 return;
355 * ata_force_link_limits - force link limits according to libata.force
356 * @link: ATA link of interest
358 * Force link flags and SATA spd limit according to libata.force
359 * and whine about it. When only the port part is specified
360 * (e.g. 1:), the limit applies to all links connected to both
361 * the host link and all fan-out ports connected via PMP. If the
362 * device part is specified as 0 (e.g. 1.00:), it specifies the
363 * first fan-out link not the host link. Device number 15 always
364 * points to the host link whether PMP is attached or not. If the
365 * controller has slave link, device number 16 points to it.
367 * LOCKING:
368 * EH context.
370 static void ata_force_link_limits(struct ata_link *link)
372 bool did_spd = false;
373 int linkno = link->pmp;
374 int i;
376 if (ata_is_host_link(link))
377 linkno += 15;
379 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
380 const struct ata_force_ent *fe = &ata_force_tbl[i];
382 if (fe->port != -1 && fe->port != link->ap->print_id)
383 continue;
385 if (fe->device != -1 && fe->device != linkno)
386 continue;
388 /* only honor the first spd limit */
389 if (!did_spd && fe->param.spd_limit) {
390 link->hw_sata_spd_limit = (1 << fe->param.spd_limit) - 1;
391 ata_link_notice(link, "FORCE: PHY spd limit set to %s\n",
392 fe->param.name);
393 did_spd = true;
396 /* let lflags stack */
397 if (fe->param.lflags) {
398 link->flags |= fe->param.lflags;
399 ata_link_notice(link,
400 "FORCE: link flag 0x%x forced -> 0x%x\n",
401 fe->param.lflags, link->flags);
407 * ata_force_xfermask - force xfermask according to libata.force
408 * @dev: ATA device of interest
410 * Force xfer_mask according to libata.force and whine about it.
411 * For consistency with link selection, device number 15 selects
412 * the first device connected to the host link.
414 * LOCKING:
415 * EH context.
417 static void ata_force_xfermask(struct ata_device *dev)
419 int devno = dev->link->pmp + dev->devno;
420 int alt_devno = devno;
421 int i;
423 /* allow n.15/16 for devices attached to host port */
424 if (ata_is_host_link(dev->link))
425 alt_devno += 15;
427 for (i = ata_force_tbl_size - 1; i >= 0; i--) {
428 const struct ata_force_ent *fe = &ata_force_tbl[i];
429 unsigned long pio_mask, mwdma_mask, udma_mask;
431 if (fe->port != -1 && fe->port != dev->link->ap->print_id)
432 continue;
434 if (fe->device != -1 && fe->device != devno &&
435 fe->device != alt_devno)
436 continue;
438 if (!fe->param.xfer_mask)
439 continue;
441 ata_unpack_xfermask(fe->param.xfer_mask,
442 &pio_mask, &mwdma_mask, &udma_mask);
443 if (udma_mask)
444 dev->udma_mask = udma_mask;
445 else if (mwdma_mask) {
446 dev->udma_mask = 0;
447 dev->mwdma_mask = mwdma_mask;
448 } else {
449 dev->udma_mask = 0;
450 dev->mwdma_mask = 0;
451 dev->pio_mask = pio_mask;
454 ata_dev_notice(dev, "FORCE: xfer_mask set to %s\n",
455 fe->param.name);
456 return;
461 * ata_force_horkage - force horkage according to libata.force
462 * @dev: ATA device of interest
464 * Force horkage according to libata.force and whine about it.
465 * For consistency with link selection, device number 15 selects
466 * the first device connected to the host link.
468 * LOCKING:
469 * EH context.
471 static void ata_force_horkage(struct ata_device *dev)
473 int devno = dev->link->pmp + dev->devno;
474 int alt_devno = devno;
475 int i;
477 /* allow n.15/16 for devices attached to host port */
478 if (ata_is_host_link(dev->link))
479 alt_devno += 15;
481 for (i = 0; i < ata_force_tbl_size; i++) {
482 const struct ata_force_ent *fe = &ata_force_tbl[i];
484 if (fe->port != -1 && fe->port != dev->link->ap->print_id)
485 continue;
487 if (fe->device != -1 && fe->device != devno &&
488 fe->device != alt_devno)
489 continue;
491 if (!(~dev->horkage & fe->param.horkage_on) &&
492 !(dev->horkage & fe->param.horkage_off))
493 continue;
495 dev->horkage |= fe->param.horkage_on;
496 dev->horkage &= ~fe->param.horkage_off;
498 ata_dev_notice(dev, "FORCE: horkage modified (%s)\n",
499 fe->param.name);
504 * atapi_cmd_type - Determine ATAPI command type from SCSI opcode
505 * @opcode: SCSI opcode
507 * Determine ATAPI command type from @opcode.
509 * LOCKING:
510 * None.
512 * RETURNS:
513 * ATAPI_{READ|WRITE|READ_CD|PASS_THRU|MISC}
515 int atapi_cmd_type(u8 opcode)
517 switch (opcode) {
518 case GPCMD_READ_10:
519 case GPCMD_READ_12:
520 return ATAPI_READ;
522 case GPCMD_WRITE_10:
523 case GPCMD_WRITE_12:
524 case GPCMD_WRITE_AND_VERIFY_10:
525 return ATAPI_WRITE;
527 case GPCMD_READ_CD:
528 case GPCMD_READ_CD_MSF:
529 return ATAPI_READ_CD;
531 case ATA_16:
532 case ATA_12:
533 if (atapi_passthru16)
534 return ATAPI_PASS_THRU;
535 /* fall thru */
536 default:
537 return ATAPI_MISC;
542 * ata_tf_to_fis - Convert ATA taskfile to SATA FIS structure
543 * @tf: Taskfile to convert
544 * @pmp: Port multiplier port
545 * @is_cmd: This FIS is for command
546 * @fis: Buffer into which data will output
548 * Converts a standard ATA taskfile to a Serial ATA
549 * FIS structure (Register - Host to Device).
551 * LOCKING:
552 * Inherited from caller.
554 void ata_tf_to_fis(const struct ata_taskfile *tf, u8 pmp, int is_cmd, u8 *fis)
556 fis[0] = 0x27; /* Register - Host to Device FIS */
557 fis[1] = pmp & 0xf; /* Port multiplier number*/
558 if (is_cmd)
559 fis[1] |= (1 << 7); /* bit 7 indicates Command FIS */
561 fis[2] = tf->command;
562 fis[3] = tf->feature;
564 fis[4] = tf->lbal;
565 fis[5] = tf->lbam;
566 fis[6] = tf->lbah;
567 fis[7] = tf->device;
569 fis[8] = tf->hob_lbal;
570 fis[9] = tf->hob_lbam;
571 fis[10] = tf->hob_lbah;
572 fis[11] = tf->hob_feature;
574 fis[12] = tf->nsect;
575 fis[13] = tf->hob_nsect;
576 fis[14] = 0;
577 fis[15] = tf->ctl;
579 fis[16] = tf->auxiliary & 0xff;
580 fis[17] = (tf->auxiliary >> 8) & 0xff;
581 fis[18] = (tf->auxiliary >> 16) & 0xff;
582 fis[19] = (tf->auxiliary >> 24) & 0xff;
586 * ata_tf_from_fis - Convert SATA FIS to ATA taskfile
587 * @fis: Buffer from which data will be input
588 * @tf: Taskfile to output
590 * Converts a serial ATA FIS structure to a standard ATA taskfile.
592 * LOCKING:
593 * Inherited from caller.
596 void ata_tf_from_fis(const u8 *fis, struct ata_taskfile *tf)
598 tf->command = fis[2]; /* status */
599 tf->feature = fis[3]; /* error */
601 tf->lbal = fis[4];
602 tf->lbam = fis[5];
603 tf->lbah = fis[6];
604 tf->device = fis[7];
606 tf->hob_lbal = fis[8];
607 tf->hob_lbam = fis[9];
608 tf->hob_lbah = fis[10];
610 tf->nsect = fis[12];
611 tf->hob_nsect = fis[13];
614 static const u8 ata_rw_cmds[] = {
615 /* pio multi */
616 ATA_CMD_READ_MULTI,
617 ATA_CMD_WRITE_MULTI,
618 ATA_CMD_READ_MULTI_EXT,
619 ATA_CMD_WRITE_MULTI_EXT,
623 ATA_CMD_WRITE_MULTI_FUA_EXT,
624 /* pio */
625 ATA_CMD_PIO_READ,
626 ATA_CMD_PIO_WRITE,
627 ATA_CMD_PIO_READ_EXT,
628 ATA_CMD_PIO_WRITE_EXT,
633 /* dma */
634 ATA_CMD_READ,
635 ATA_CMD_WRITE,
636 ATA_CMD_READ_EXT,
637 ATA_CMD_WRITE_EXT,
641 ATA_CMD_WRITE_FUA_EXT
645 * ata_rwcmd_protocol - set taskfile r/w commands and protocol
646 * @tf: command to examine and configure
647 * @dev: device tf belongs to
649 * Examine the device configuration and tf->flags to calculate
650 * the proper read/write commands and protocol to use.
652 * LOCKING:
653 * caller.
655 static int ata_rwcmd_protocol(struct ata_taskfile *tf, struct ata_device *dev)
657 u8 cmd;
659 int index, fua, lba48, write;
661 fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
662 lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
663 write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;
665 if (dev->flags & ATA_DFLAG_PIO) {
666 tf->protocol = ATA_PROT_PIO;
667 index = dev->multi_count ? 0 : 8;
668 } else if (lba48 && (dev->link->ap->flags & ATA_FLAG_PIO_LBA48)) {
669 /* Unable to use DMA due to host limitation */
670 tf->protocol = ATA_PROT_PIO;
671 index = dev->multi_count ? 0 : 8;
672 } else {
673 tf->protocol = ATA_PROT_DMA;
674 index = 16;
677 cmd = ata_rw_cmds[index + fua + lba48 + write];
678 if (cmd) {
679 tf->command = cmd;
680 return 0;
682 return -1;
686 * ata_tf_read_block - Read block address from ATA taskfile
687 * @tf: ATA taskfile of interest
688 * @dev: ATA device @tf belongs to
690 * LOCKING:
691 * None.
693 * Read block address from @tf. This function can handle all
694 * three address formats - LBA, LBA48 and CHS. tf->protocol and
695 * flags select the address format to use.
697 * RETURNS:
698 * Block address read from @tf.
700 u64 ata_tf_read_block(const struct ata_taskfile *tf, struct ata_device *dev)
702 u64 block = 0;
704 if (tf->flags & ATA_TFLAG_LBA) {
705 if (tf->flags & ATA_TFLAG_LBA48) {
706 block |= (u64)tf->hob_lbah << 40;
707 block |= (u64)tf->hob_lbam << 32;
708 block |= (u64)tf->hob_lbal << 24;
709 } else
710 block |= (tf->device & 0xf) << 24;
712 block |= tf->lbah << 16;
713 block |= tf->lbam << 8;
714 block |= tf->lbal;
715 } else {
716 u32 cyl, head, sect;
718 cyl = tf->lbam | (tf->lbah << 8);
719 head = tf->device & 0xf;
720 sect = tf->lbal;
722 if (!sect) {
723 ata_dev_warn(dev,
724 "device reported invalid CHS sector 0\n");
725 return U64_MAX;
728 block = (cyl * dev->heads + head) * dev->sectors + sect - 1;
731 return block;
735 * ata_build_rw_tf - Build ATA taskfile for given read/write request
736 * @tf: Target ATA taskfile
737 * @dev: ATA device @tf belongs to
738 * @block: Block address
739 * @n_block: Number of blocks
740 * @tf_flags: RW/FUA etc...
741 * @tag: tag
742 * @class: IO priority class
744 * LOCKING:
745 * None.
747 * Build ATA taskfile @tf for read/write request described by
748 * @block, @n_block, @tf_flags and @tag on @dev.
750 * RETURNS:
752 * 0 on success, -ERANGE if the request is too large for @dev,
753 * -EINVAL if the request is invalid.
755 int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
756 u64 block, u32 n_block, unsigned int tf_flags,
757 unsigned int tag, int class)
759 tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
760 tf->flags |= tf_flags;
762 if (ata_ncq_enabled(dev) && likely(tag != ATA_TAG_INTERNAL)) {
763 /* yay, NCQ */
764 if (!lba_48_ok(block, n_block))
765 return -ERANGE;
767 tf->protocol = ATA_PROT_NCQ;
768 tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;
770 if (tf->flags & ATA_TFLAG_WRITE)
771 tf->command = ATA_CMD_FPDMA_WRITE;
772 else
773 tf->command = ATA_CMD_FPDMA_READ;
775 tf->nsect = tag << 3;
776 tf->hob_feature = (n_block >> 8) & 0xff;
777 tf->feature = n_block & 0xff;
779 tf->hob_lbah = (block >> 40) & 0xff;
780 tf->hob_lbam = (block >> 32) & 0xff;
781 tf->hob_lbal = (block >> 24) & 0xff;
782 tf->lbah = (block >> 16) & 0xff;
783 tf->lbam = (block >> 8) & 0xff;
784 tf->lbal = block & 0xff;
786 tf->device = ATA_LBA;
787 if (tf->flags & ATA_TFLAG_FUA)
788 tf->device |= 1 << 7;
790 if (dev->flags & ATA_DFLAG_NCQ_PRIO) {
791 if (class == IOPRIO_CLASS_RT)
792 tf->hob_nsect |= ATA_PRIO_HIGH <<
793 ATA_SHIFT_PRIO;
795 } else if (dev->flags & ATA_DFLAG_LBA) {
796 tf->flags |= ATA_TFLAG_LBA;
798 if (lba_28_ok(block, n_block)) {
799 /* use LBA28 */
800 tf->device |= (block >> 24) & 0xf;
801 } else if (lba_48_ok(block, n_block)) {
802 if (!(dev->flags & ATA_DFLAG_LBA48))
803 return -ERANGE;
805 /* use LBA48 */
806 tf->flags |= ATA_TFLAG_LBA48;
808 tf->hob_nsect = (n_block >> 8) & 0xff;
810 tf->hob_lbah = (block >> 40) & 0xff;
811 tf->hob_lbam = (block >> 32) & 0xff;
812 tf->hob_lbal = (block >> 24) & 0xff;
813 } else
814 /* request too large even for LBA48 */
815 return -ERANGE;
817 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
818 return -EINVAL;
820 tf->nsect = n_block & 0xff;
822 tf->lbah = (block >> 16) & 0xff;
823 tf->lbam = (block >> 8) & 0xff;
824 tf->lbal = block & 0xff;
826 tf->device |= ATA_LBA;
827 } else {
828 /* CHS */
829 u32 sect, head, cyl, track;
831 /* The request -may- be too large for CHS addressing. */
832 if (!lba_28_ok(block, n_block))
833 return -ERANGE;
835 if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
836 return -EINVAL;
838 /* Convert LBA to CHS */
839 track = (u32)block / dev->sectors;
840 cyl = track / dev->heads;
841 head = track % dev->heads;
842 sect = (u32)block % dev->sectors + 1;
844 DPRINTK("block %u track %u cyl %u head %u sect %u\n",
845 (u32)block, track, cyl, head, sect);
847 /* Check whether the converted CHS can fit.
848 Cylinder: 0-65535
849 Head: 0-15
850 Sector: 1-255*/
851 if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
852 return -ERANGE;
854 tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
855 tf->lbal = sect;
856 tf->lbam = cyl;
857 tf->lbah = cyl >> 8;
858 tf->device |= head;
861 return 0;
865 * ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
866 * @pio_mask: pio_mask
867 * @mwdma_mask: mwdma_mask
868 * @udma_mask: udma_mask
870 * Pack @pio_mask, @mwdma_mask and @udma_mask into a single
871 * unsigned int xfer_mask.
873 * LOCKING:
874 * None.
876 * RETURNS:
877 * Packed xfer_mask.
879 unsigned long ata_pack_xfermask(unsigned long pio_mask,
880 unsigned long mwdma_mask,
881 unsigned long udma_mask)
883 return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
884 ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
885 ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
889 * ata_unpack_xfermask - Unpack xfer_mask into pio, mwdma and udma masks
890 * @xfer_mask: xfer_mask to unpack
891 * @pio_mask: resulting pio_mask
892 * @mwdma_mask: resulting mwdma_mask
893 * @udma_mask: resulting udma_mask
895 * Unpack @xfer_mask into @pio_mask, @mwdma_mask and @udma_mask.
896 * Any NULL destination masks will be ignored.
898 void ata_unpack_xfermask(unsigned long xfer_mask, unsigned long *pio_mask,
899 unsigned long *mwdma_mask, unsigned long *udma_mask)
901 if (pio_mask)
902 *pio_mask = (xfer_mask & ATA_MASK_PIO) >> ATA_SHIFT_PIO;
903 if (mwdma_mask)
904 *mwdma_mask = (xfer_mask & ATA_MASK_MWDMA) >> ATA_SHIFT_MWDMA;
905 if (udma_mask)
906 *udma_mask = (xfer_mask & ATA_MASK_UDMA) >> ATA_SHIFT_UDMA;
909 static const struct ata_xfer_ent {
910 int shift, bits;
911 u8 base;
912 } ata_xfer_tbl[] = {
913 { ATA_SHIFT_PIO, ATA_NR_PIO_MODES, XFER_PIO_0 },
914 { ATA_SHIFT_MWDMA, ATA_NR_MWDMA_MODES, XFER_MW_DMA_0 },
915 { ATA_SHIFT_UDMA, ATA_NR_UDMA_MODES, XFER_UDMA_0 },
916 { -1, },
920 * ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
921 * @xfer_mask: xfer_mask of interest
923 * Return matching XFER_* value for @xfer_mask. Only the highest
924 * bit of @xfer_mask is considered.
926 * LOCKING:
927 * None.
929 * RETURNS:
930 * Matching XFER_* value, 0xff if no match found.
932 u8 ata_xfer_mask2mode(unsigned long xfer_mask)
934 int highbit = fls(xfer_mask) - 1;
935 const struct ata_xfer_ent *ent;
937 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
938 if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
939 return ent->base + highbit - ent->shift;
940 return 0xff;
944 * ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
945 * @xfer_mode: XFER_* of interest
947 * Return matching xfer_mask for @xfer_mode.
949 * LOCKING:
950 * None.
952 * RETURNS:
953 * Matching xfer_mask, 0 if no match found.
955 unsigned long ata_xfer_mode2mask(u8 xfer_mode)
957 const struct ata_xfer_ent *ent;
959 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
960 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
961 return ((2 << (ent->shift + xfer_mode - ent->base)) - 1)
962 & ~((1 << ent->shift) - 1);
963 return 0;
967 * ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
968 * @xfer_mode: XFER_* of interest
970 * Return matching xfer_shift for @xfer_mode.
972 * LOCKING:
973 * None.
975 * RETURNS:
976 * Matching xfer_shift, -1 if no match found.
978 int ata_xfer_mode2shift(unsigned long xfer_mode)
980 const struct ata_xfer_ent *ent;
982 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
983 if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
984 return ent->shift;
985 return -1;
989 * ata_mode_string - convert xfer_mask to string
990 * @xfer_mask: mask of bits supported; only highest bit counts.
992 * Determine string which represents the highest speed
993 * (highest bit in @modemask).
995 * LOCKING:
996 * None.
998 * RETURNS:
999 * Constant C string representing highest speed listed in
1000 * @mode_mask, or the constant C string "<n/a>".
1002 const char *ata_mode_string(unsigned long xfer_mask)
1004 static const char * const xfer_mode_str[] = {
1005 "PIO0",
1006 "PIO1",
1007 "PIO2",
1008 "PIO3",
1009 "PIO4",
1010 "PIO5",
1011 "PIO6",
1012 "MWDMA0",
1013 "MWDMA1",
1014 "MWDMA2",
1015 "MWDMA3",
1016 "MWDMA4",
1017 "UDMA/16",
1018 "UDMA/25",
1019 "UDMA/33",
1020 "UDMA/44",
1021 "UDMA/66",
1022 "UDMA/100",
1023 "UDMA/133",
1024 "UDMA7",
1026 int highbit;
1028 highbit = fls(xfer_mask) - 1;
1029 if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
1030 return xfer_mode_str[highbit];
1031 return "<n/a>";
1034 const char *sata_spd_string(unsigned int spd)
1036 static const char * const spd_str[] = {
1037 "1.5 Gbps",
1038 "3.0 Gbps",
1039 "6.0 Gbps",
1042 if (spd == 0 || (spd - 1) >= ARRAY_SIZE(spd_str))
1043 return "<unknown>";
1044 return spd_str[spd - 1];
1048 * ata_dev_classify - determine device type based on ATA-spec signature
1049 * @tf: ATA taskfile register set for device to be identified
1051 * Determine from taskfile register contents whether a device is
1052 * ATA or ATAPI, as per "Signature and persistence" section
1053 * of ATA/PI spec (volume 1, sect 5.14).
1055 * LOCKING:
1056 * None.
1058 * RETURNS:
1059 * Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, %ATA_DEV_PMP,
1060 * %ATA_DEV_ZAC, or %ATA_DEV_UNKNOWN the event of failure.
1062 unsigned int ata_dev_classify(const struct ata_taskfile *tf)
1064 /* Apple's open source Darwin code hints that some devices only
1065 * put a proper signature into the LBA mid/high registers,
1066 * So, we only check those. It's sufficient for uniqueness.
1068 * ATA/ATAPI-7 (d1532v1r1: Feb. 19, 2003) specified separate
1069 * signatures for ATA and ATAPI devices attached on SerialATA,
1070 * 0x3c/0xc3 and 0x69/0x96 respectively. However, SerialATA
1071 * spec has never mentioned about using different signatures
1072 * for ATA/ATAPI devices. Then, Serial ATA II: Port
1073 * Multiplier specification began to use 0x69/0x96 to identify
1074 * port multpliers and 0x3c/0xc3 to identify SEMB device.
1075 * ATA/ATAPI-7 dropped descriptions about 0x3c/0xc3 and
1076 * 0x69/0x96 shortly and described them as reserved for
1077 * SerialATA.
1079 * We follow the current spec and consider that 0x69/0x96
1080 * identifies a port multiplier and 0x3c/0xc3 a SEMB device.
1081 * Unfortunately, WDC WD1600JS-62MHB5 (a hard drive) reports
1082 * SEMB signature. This is worked around in
1083 * ata_dev_read_id().
1085 if ((tf->lbam == 0) && (tf->lbah == 0)) {
1086 DPRINTK("found ATA device by sig\n");
1087 return ATA_DEV_ATA;
1090 if ((tf->lbam == 0x14) && (tf->lbah == 0xeb)) {
1091 DPRINTK("found ATAPI device by sig\n");
1092 return ATA_DEV_ATAPI;
1095 if ((tf->lbam == 0x69) && (tf->lbah == 0x96)) {
1096 DPRINTK("found PMP device by sig\n");
1097 return ATA_DEV_PMP;
1100 if ((tf->lbam == 0x3c) && (tf->lbah == 0xc3)) {
1101 DPRINTK("found SEMB device by sig (could be ATA device)\n");
1102 return ATA_DEV_SEMB;
1105 if ((tf->lbam == 0xcd) && (tf->lbah == 0xab)) {
1106 DPRINTK("found ZAC device by sig\n");
1107 return ATA_DEV_ZAC;
1110 DPRINTK("unknown device\n");
1111 return ATA_DEV_UNKNOWN;
1115 * ata_id_string - Convert IDENTIFY DEVICE page into string
1116 * @id: IDENTIFY DEVICE results we will examine
1117 * @s: string into which data is output
1118 * @ofs: offset into identify device page
1119 * @len: length of string to return. must be an even number.
1121 * The strings in the IDENTIFY DEVICE page are broken up into
1122 * 16-bit chunks. Run through the string, and output each
1123 * 8-bit chunk linearly, regardless of platform.
1125 * LOCKING:
1126 * caller.
1129 void ata_id_string(const u16 *id, unsigned char *s,
1130 unsigned int ofs, unsigned int len)
1132 unsigned int c;
1134 BUG_ON(len & 1);
1136 while (len > 0) {
1137 c = id[ofs] >> 8;
1138 *s = c;
1139 s++;
1141 c = id[ofs] & 0xff;
1142 *s = c;
1143 s++;
1145 ofs++;
1146 len -= 2;
1151 * ata_id_c_string - Convert IDENTIFY DEVICE page into C string
1152 * @id: IDENTIFY DEVICE results we will examine
1153 * @s: string into which data is output
1154 * @ofs: offset into identify device page
1155 * @len: length of string to return. must be an odd number.
1157 * This function is identical to ata_id_string except that it
1158 * trims trailing spaces and terminates the resulting string with
1159 * null. @len must be actual maximum length (even number) + 1.
1161 * LOCKING:
1162 * caller.
1164 void ata_id_c_string(const u16 *id, unsigned char *s,
1165 unsigned int ofs, unsigned int len)
1167 unsigned char *p;
1169 ata_id_string(id, s, ofs, len - 1);
1171 p = s + strnlen(s, len - 1);
1172 while (p > s && p[-1] == ' ')
1173 p--;
1174 *p = '\0';
1177 static u64 ata_id_n_sectors(const u16 *id)
1179 if (ata_id_has_lba(id)) {
1180 if (ata_id_has_lba48(id))
1181 return ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
1182 else
1183 return ata_id_u32(id, ATA_ID_LBA_CAPACITY);
1184 } else {
1185 if (ata_id_current_chs_valid(id))
1186 return id[ATA_ID_CUR_CYLS] * id[ATA_ID_CUR_HEADS] *
1187 id[ATA_ID_CUR_SECTORS];
1188 else
1189 return id[ATA_ID_CYLS] * id[ATA_ID_HEADS] *
1190 id[ATA_ID_SECTORS];
1194 u64 ata_tf_to_lba48(const struct ata_taskfile *tf)
1196 u64 sectors = 0;
1198 sectors |= ((u64)(tf->hob_lbah & 0xff)) << 40;
1199 sectors |= ((u64)(tf->hob_lbam & 0xff)) << 32;
1200 sectors |= ((u64)(tf->hob_lbal & 0xff)) << 24;
1201 sectors |= (tf->lbah & 0xff) << 16;
1202 sectors |= (tf->lbam & 0xff) << 8;
1203 sectors |= (tf->lbal & 0xff);
1205 return sectors;
1208 u64 ata_tf_to_lba(const struct ata_taskfile *tf)
1210 u64 sectors = 0;
1212 sectors |= (tf->device & 0x0f) << 24;
1213 sectors |= (tf->lbah & 0xff) << 16;
1214 sectors |= (tf->lbam & 0xff) << 8;
1215 sectors |= (tf->lbal & 0xff);
1217 return sectors;
1221 * ata_read_native_max_address - Read native max address
1222 * @dev: target device
1223 * @max_sectors: out parameter for the result native max address
1225 * Perform an LBA48 or LBA28 native size query upon the device in
1226 * question.
1228 * RETURNS:
1229 * 0 on success, -EACCES if command is aborted by the drive.
1230 * -EIO on other errors.
1232 static int ata_read_native_max_address(struct ata_device *dev, u64 *max_sectors)
1234 unsigned int err_mask;
1235 struct ata_taskfile tf;
1236 int lba48 = ata_id_has_lba48(dev->id);
1238 ata_tf_init(dev, &tf);
1240 /* always clear all address registers */
1241 tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1243 if (lba48) {
1244 tf.command = ATA_CMD_READ_NATIVE_MAX_EXT;
1245 tf.flags |= ATA_TFLAG_LBA48;
1246 } else
1247 tf.command = ATA_CMD_READ_NATIVE_MAX;
1249 tf.protocol = ATA_PROT_NODATA;
1250 tf.device |= ATA_LBA;
1252 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1253 if (err_mask) {
1254 ata_dev_warn(dev,
1255 "failed to read native max address (err_mask=0x%x)\n",
1256 err_mask);
1257 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
1258 return -EACCES;
1259 return -EIO;
1262 if (lba48)
1263 *max_sectors = ata_tf_to_lba48(&tf) + 1;
1264 else
1265 *max_sectors = ata_tf_to_lba(&tf) + 1;
1266 if (dev->horkage & ATA_HORKAGE_HPA_SIZE)
1267 (*max_sectors)--;
1268 return 0;
1272 * ata_set_max_sectors - Set max sectors
1273 * @dev: target device
1274 * @new_sectors: new max sectors value to set for the device
1276 * Set max sectors of @dev to @new_sectors.
1278 * RETURNS:
1279 * 0 on success, -EACCES if command is aborted or denied (due to
1280 * previous non-volatile SET_MAX) by the drive. -EIO on other
1281 * errors.
1283 static int ata_set_max_sectors(struct ata_device *dev, u64 new_sectors)
1285 unsigned int err_mask;
1286 struct ata_taskfile tf;
1287 int lba48 = ata_id_has_lba48(dev->id);
1289 new_sectors--;
1291 ata_tf_init(dev, &tf);
1293 tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
1295 if (lba48) {
1296 tf.command = ATA_CMD_SET_MAX_EXT;
1297 tf.flags |= ATA_TFLAG_LBA48;
1299 tf.hob_lbal = (new_sectors >> 24) & 0xff;
1300 tf.hob_lbam = (new_sectors >> 32) & 0xff;
1301 tf.hob_lbah = (new_sectors >> 40) & 0xff;
1302 } else {
1303 tf.command = ATA_CMD_SET_MAX;
1305 tf.device |= (new_sectors >> 24) & 0xf;
1308 tf.protocol = ATA_PROT_NODATA;
1309 tf.device |= ATA_LBA;
1311 tf.lbal = (new_sectors >> 0) & 0xff;
1312 tf.lbam = (new_sectors >> 8) & 0xff;
1313 tf.lbah = (new_sectors >> 16) & 0xff;
1315 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
1316 if (err_mask) {
1317 ata_dev_warn(dev,
1318 "failed to set max address (err_mask=0x%x)\n",
1319 err_mask);
1320 if (err_mask == AC_ERR_DEV &&
1321 (tf.feature & (ATA_ABORTED | ATA_IDNF)))
1322 return -EACCES;
1323 return -EIO;
1326 return 0;
1330 * ata_hpa_resize - Resize a device with an HPA set
1331 * @dev: Device to resize
1333 * Read the size of an LBA28 or LBA48 disk with HPA features and resize
1334 * it if required to the full size of the media. The caller must check
1335 * the drive has the HPA feature set enabled.
1337 * RETURNS:
1338 * 0 on success, -errno on failure.
1340 static int ata_hpa_resize(struct ata_device *dev)
1342 struct ata_eh_context *ehc = &dev->link->eh_context;
1343 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
1344 bool unlock_hpa = ata_ignore_hpa || dev->flags & ATA_DFLAG_UNLOCK_HPA;
1345 u64 sectors = ata_id_n_sectors(dev->id);
1346 u64 native_sectors;
1347 int rc;
1349 /* do we need to do it? */
1350 if ((dev->class != ATA_DEV_ATA && dev->class != ATA_DEV_ZAC) ||
1351 !ata_id_has_lba(dev->id) || !ata_id_hpa_enabled(dev->id) ||
1352 (dev->horkage & ATA_HORKAGE_BROKEN_HPA))
1353 return 0;
1355 /* read native max address */
1356 rc = ata_read_native_max_address(dev, &native_sectors);
1357 if (rc) {
1358 /* If device aborted the command or HPA isn't going to
1359 * be unlocked, skip HPA resizing.
1361 if (rc == -EACCES || !unlock_hpa) {
1362 ata_dev_warn(dev,
1363 "HPA support seems broken, skipping HPA handling\n");
1364 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1366 /* we can continue if device aborted the command */
1367 if (rc == -EACCES)
1368 rc = 0;
1371 return rc;
1373 dev->n_native_sectors = native_sectors;
1375 /* nothing to do? */
1376 if (native_sectors <= sectors || !unlock_hpa) {
1377 if (!print_info || native_sectors == sectors)
1378 return 0;
1380 if (native_sectors > sectors)
1381 ata_dev_info(dev,
1382 "HPA detected: current %llu, native %llu\n",
1383 (unsigned long long)sectors,
1384 (unsigned long long)native_sectors);
1385 else if (native_sectors < sectors)
1386 ata_dev_warn(dev,
1387 "native sectors (%llu) is smaller than sectors (%llu)\n",
1388 (unsigned long long)native_sectors,
1389 (unsigned long long)sectors);
1390 return 0;
1393 /* let's unlock HPA */
1394 rc = ata_set_max_sectors(dev, native_sectors);
1395 if (rc == -EACCES) {
1396 /* if device aborted the command, skip HPA resizing */
1397 ata_dev_warn(dev,
1398 "device aborted resize (%llu -> %llu), skipping HPA handling\n",
1399 (unsigned long long)sectors,
1400 (unsigned long long)native_sectors);
1401 dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
1402 return 0;
1403 } else if (rc)
1404 return rc;
1406 /* re-read IDENTIFY data */
1407 rc = ata_dev_reread_id(dev, 0);
1408 if (rc) {
1409 ata_dev_err(dev,
1410 "failed to re-read IDENTIFY data after HPA resizing\n");
1411 return rc;
1414 if (print_info) {
1415 u64 new_sectors = ata_id_n_sectors(dev->id);
1416 ata_dev_info(dev,
1417 "HPA unlocked: %llu -> %llu, native %llu\n",
1418 (unsigned long long)sectors,
1419 (unsigned long long)new_sectors,
1420 (unsigned long long)native_sectors);
1423 return 0;
1427 * ata_dump_id - IDENTIFY DEVICE info debugging output
1428 * @id: IDENTIFY DEVICE page to dump
1430 * Dump selected 16-bit words from the given IDENTIFY DEVICE
1431 * page.
1433 * LOCKING:
1434 * caller.
1437 static inline void ata_dump_id(const u16 *id)
1439 DPRINTK("49==0x%04x "
1440 "53==0x%04x "
1441 "63==0x%04x "
1442 "64==0x%04x "
1443 "75==0x%04x \n",
1444 id[49],
1445 id[53],
1446 id[63],
1447 id[64],
1448 id[75]);
1449 DPRINTK("80==0x%04x "
1450 "81==0x%04x "
1451 "82==0x%04x "
1452 "83==0x%04x "
1453 "84==0x%04x \n",
1454 id[80],
1455 id[81],
1456 id[82],
1457 id[83],
1458 id[84]);
1459 DPRINTK("88==0x%04x "
1460 "93==0x%04x\n",
1461 id[88],
1462 id[93]);
1466 * ata_id_xfermask - Compute xfermask from the given IDENTIFY data
1467 * @id: IDENTIFY data to compute xfer mask from
1469 * Compute the xfermask for this device. This is not as trivial
1470 * as it seems if we must consider early devices correctly.
1472 * FIXME: pre IDE drive timing (do we care ?).
1474 * LOCKING:
1475 * None.
1477 * RETURNS:
1478 * Computed xfermask
1480 unsigned long ata_id_xfermask(const u16 *id)
1482 unsigned long pio_mask, mwdma_mask, udma_mask;
1484 /* Usual case. Word 53 indicates word 64 is valid */
1485 if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
1486 pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
1487 pio_mask <<= 3;
1488 pio_mask |= 0x7;
1489 } else {
1490 /* If word 64 isn't valid then Word 51 high byte holds
1491 * the PIO timing number for the maximum. Turn it into
1492 * a mask.
1494 u8 mode = (id[ATA_ID_OLD_PIO_MODES] >> 8) & 0xFF;
1495 if (mode < 5) /* Valid PIO range */
1496 pio_mask = (2 << mode) - 1;
1497 else
1498 pio_mask = 1;
1500 /* But wait.. there's more. Design your standards by
1501 * committee and you too can get a free iordy field to
1502 * process. However its the speeds not the modes that
1503 * are supported... Note drivers using the timing API
1504 * will get this right anyway
1508 mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;
1510 if (ata_id_is_cfa(id)) {
1512 * Process compact flash extended modes
1514 int pio = (id[ATA_ID_CFA_MODES] >> 0) & 0x7;
1515 int dma = (id[ATA_ID_CFA_MODES] >> 3) & 0x7;
1517 if (pio)
1518 pio_mask |= (1 << 5);
1519 if (pio > 1)
1520 pio_mask |= (1 << 6);
1521 if (dma)
1522 mwdma_mask |= (1 << 3);
1523 if (dma > 1)
1524 mwdma_mask |= (1 << 4);
1527 udma_mask = 0;
1528 if (id[ATA_ID_FIELD_VALID] & (1 << 2))
1529 udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;
1531 return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
1534 static void ata_qc_complete_internal(struct ata_queued_cmd *qc)
1536 struct completion *waiting = qc->private_data;
1538 complete(waiting);
1542 * ata_exec_internal_sg - execute libata internal command
1543 * @dev: Device to which the command is sent
1544 * @tf: Taskfile registers for the command and the result
1545 * @cdb: CDB for packet command
1546 * @dma_dir: Data transfer direction of the command
1547 * @sgl: sg list for the data buffer of the command
1548 * @n_elem: Number of sg entries
1549 * @timeout: Timeout in msecs (0 for default)
1551 * Executes libata internal command with timeout. @tf contains
1552 * command on entry and result on return. Timeout and error
1553 * conditions are reported via return value. No recovery action
1554 * is taken after a command times out. It's caller's duty to
1555 * clean up after timeout.
1557 * LOCKING:
1558 * None. Should be called with kernel context, might sleep.
1560 * RETURNS:
1561 * Zero on success, AC_ERR_* mask on failure
1563 unsigned ata_exec_internal_sg(struct ata_device *dev,
1564 struct ata_taskfile *tf, const u8 *cdb,
1565 int dma_dir, struct scatterlist *sgl,
1566 unsigned int n_elem, unsigned long timeout)
1568 struct ata_link *link = dev->link;
1569 struct ata_port *ap = link->ap;
1570 u8 command = tf->command;
1571 int auto_timeout = 0;
1572 struct ata_queued_cmd *qc;
1573 unsigned int tag, preempted_tag;
1574 u32 preempted_sactive, preempted_qc_active;
1575 int preempted_nr_active_links;
1576 DECLARE_COMPLETION_ONSTACK(wait);
1577 unsigned long flags;
1578 unsigned int err_mask;
1579 int rc;
1581 spin_lock_irqsave(ap->lock, flags);
1583 /* no internal command while frozen */
1584 if (ap->pflags & ATA_PFLAG_FROZEN) {
1585 spin_unlock_irqrestore(ap->lock, flags);
1586 return AC_ERR_SYSTEM;
1589 /* initialize internal qc */
1591 /* XXX: Tag 0 is used for drivers with legacy EH as some
1592 * drivers choke if any other tag is given. This breaks
1593 * ata_tag_internal() test for those drivers. Don't use new
1594 * EH stuff without converting to it.
1596 if (ap->ops->error_handler)
1597 tag = ATA_TAG_INTERNAL;
1598 else
1599 tag = 0;
1601 qc = __ata_qc_from_tag(ap, tag);
1603 qc->tag = tag;
1604 qc->scsicmd = NULL;
1605 qc->ap = ap;
1606 qc->dev = dev;
1607 ata_qc_reinit(qc);
1609 preempted_tag = link->active_tag;
1610 preempted_sactive = link->sactive;
1611 preempted_qc_active = ap->qc_active;
1612 preempted_nr_active_links = ap->nr_active_links;
1613 link->active_tag = ATA_TAG_POISON;
1614 link->sactive = 0;
1615 ap->qc_active = 0;
1616 ap->nr_active_links = 0;
1618 /* prepare & issue qc */
1619 qc->tf = *tf;
1620 if (cdb)
1621 memcpy(qc->cdb, cdb, ATAPI_CDB_LEN);
1623 /* some SATA bridges need us to indicate data xfer direction */
1624 if (tf->protocol == ATAPI_PROT_DMA && (dev->flags & ATA_DFLAG_DMADIR) &&
1625 dma_dir == DMA_FROM_DEVICE)
1626 qc->tf.feature |= ATAPI_DMADIR;
1628 qc->flags |= ATA_QCFLAG_RESULT_TF;
1629 qc->dma_dir = dma_dir;
1630 if (dma_dir != DMA_NONE) {
1631 unsigned int i, buflen = 0;
1632 struct scatterlist *sg;
1634 for_each_sg(sgl, sg, n_elem, i)
1635 buflen += sg->length;
1637 ata_sg_init(qc, sgl, n_elem);
1638 qc->nbytes = buflen;
1641 qc->private_data = &wait;
1642 qc->complete_fn = ata_qc_complete_internal;
1644 ata_qc_issue(qc);
1646 spin_unlock_irqrestore(ap->lock, flags);
1648 if (!timeout) {
1649 if (ata_probe_timeout)
1650 timeout = ata_probe_timeout * 1000;
1651 else {
1652 timeout = ata_internal_cmd_timeout(dev, command);
1653 auto_timeout = 1;
1657 if (ap->ops->error_handler)
1658 ata_eh_release(ap);
1660 rc = wait_for_completion_timeout(&wait, msecs_to_jiffies(timeout));
1662 if (ap->ops->error_handler)
1663 ata_eh_acquire(ap);
1665 ata_sff_flush_pio_task(ap);
1667 if (!rc) {
1668 spin_lock_irqsave(ap->lock, flags);
1670 /* We're racing with irq here. If we lose, the
1671 * following test prevents us from completing the qc
1672 * twice. If we win, the port is frozen and will be
1673 * cleaned up by ->post_internal_cmd().
1675 if (qc->flags & ATA_QCFLAG_ACTIVE) {
1676 qc->err_mask |= AC_ERR_TIMEOUT;
1678 if (ap->ops->error_handler)
1679 ata_port_freeze(ap);
1680 else
1681 ata_qc_complete(qc);
1683 if (ata_msg_warn(ap))
1684 ata_dev_warn(dev, "qc timeout (cmd 0x%x)\n",
1685 command);
1688 spin_unlock_irqrestore(ap->lock, flags);
1691 /* do post_internal_cmd */
1692 if (ap->ops->post_internal_cmd)
1693 ap->ops->post_internal_cmd(qc);
1695 /* perform minimal error analysis */
1696 if (qc->flags & ATA_QCFLAG_FAILED) {
1697 if (qc->result_tf.command & (ATA_ERR | ATA_DF))
1698 qc->err_mask |= AC_ERR_DEV;
1700 if (!qc->err_mask)
1701 qc->err_mask |= AC_ERR_OTHER;
1703 if (qc->err_mask & ~AC_ERR_OTHER)
1704 qc->err_mask &= ~AC_ERR_OTHER;
1705 } else if (qc->tf.command == ATA_CMD_REQ_SENSE_DATA) {
1706 qc->result_tf.command |= ATA_SENSE;
1709 /* finish up */
1710 spin_lock_irqsave(ap->lock, flags);
1712 *tf = qc->result_tf;
1713 err_mask = qc->err_mask;
1715 ata_qc_free(qc);
1716 link->active_tag = preempted_tag;
1717 link->sactive = preempted_sactive;
1718 ap->qc_active = preempted_qc_active;
1719 ap->nr_active_links = preempted_nr_active_links;
1721 spin_unlock_irqrestore(ap->lock, flags);
1723 if ((err_mask & AC_ERR_TIMEOUT) && auto_timeout)
1724 ata_internal_cmd_timed_out(dev, command);
1726 return err_mask;
1730 * ata_exec_internal - execute libata internal command
1731 * @dev: Device to which the command is sent
1732 * @tf: Taskfile registers for the command and the result
1733 * @cdb: CDB for packet command
1734 * @dma_dir: Data transfer direction of the command
1735 * @buf: Data buffer of the command
1736 * @buflen: Length of data buffer
1737 * @timeout: Timeout in msecs (0 for default)
1739 * Wrapper around ata_exec_internal_sg() which takes simple
1740 * buffer instead of sg list.
1742 * LOCKING:
1743 * None. Should be called with kernel context, might sleep.
1745 * RETURNS:
1746 * Zero on success, AC_ERR_* mask on failure
1748 unsigned ata_exec_internal(struct ata_device *dev,
1749 struct ata_taskfile *tf, const u8 *cdb,
1750 int dma_dir, void *buf, unsigned int buflen,
1751 unsigned long timeout)
1753 struct scatterlist *psg = NULL, sg;
1754 unsigned int n_elem = 0;
1756 if (dma_dir != DMA_NONE) {
1757 WARN_ON(!buf);
1758 sg_init_one(&sg, buf, buflen);
1759 psg = &sg;
1760 n_elem++;
1763 return ata_exec_internal_sg(dev, tf, cdb, dma_dir, psg, n_elem,
1764 timeout);
1768 * ata_pio_need_iordy - check if iordy needed
1769 * @adev: ATA device
1771 * Check if the current speed of the device requires IORDY. Used
1772 * by various controllers for chip configuration.
1774 unsigned int ata_pio_need_iordy(const struct ata_device *adev)
1776 /* Don't set IORDY if we're preparing for reset. IORDY may
1777 * lead to controller lock up on certain controllers if the
1778 * port is not occupied. See bko#11703 for details.
1780 if (adev->link->ap->pflags & ATA_PFLAG_RESETTING)
1781 return 0;
1782 /* Controller doesn't support IORDY. Probably a pointless
1783 * check as the caller should know this.
1785 if (adev->link->ap->flags & ATA_FLAG_NO_IORDY)
1786 return 0;
1787 /* CF spec. r4.1 Table 22 says no iordy on PIO5 and PIO6. */
1788 if (ata_id_is_cfa(adev->id)
1789 && (adev->pio_mode == XFER_PIO_5 || adev->pio_mode == XFER_PIO_6))
1790 return 0;
1791 /* PIO3 and higher it is mandatory */
1792 if (adev->pio_mode > XFER_PIO_2)
1793 return 1;
1794 /* We turn it on when possible */
1795 if (ata_id_has_iordy(adev->id))
1796 return 1;
1797 return 0;
1801 * ata_pio_mask_no_iordy - Return the non IORDY mask
1802 * @adev: ATA device
1804 * Compute the highest mode possible if we are not using iordy. Return
1805 * -1 if no iordy mode is available.
1807 static u32 ata_pio_mask_no_iordy(const struct ata_device *adev)
1809 /* If we have no drive specific rule, then PIO 2 is non IORDY */
1810 if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
1811 u16 pio = adev->id[ATA_ID_EIDE_PIO];
1812 /* Is the speed faster than the drive allows non IORDY ? */
1813 if (pio) {
1814 /* This is cycle times not frequency - watch the logic! */
1815 if (pio > 240) /* PIO2 is 240nS per cycle */
1816 return 3 << ATA_SHIFT_PIO;
1817 return 7 << ATA_SHIFT_PIO;
1820 return 3 << ATA_SHIFT_PIO;
1824 * ata_do_dev_read_id - default ID read method
1825 * @dev: device
1826 * @tf: proposed taskfile
1827 * @id: data buffer
1829 * Issue the identify taskfile and hand back the buffer containing
1830 * identify data. For some RAID controllers and for pre ATA devices
1831 * this function is wrapped or replaced by the driver
1833 unsigned int ata_do_dev_read_id(struct ata_device *dev,
1834 struct ata_taskfile *tf, u16 *id)
1836 return ata_exec_internal(dev, tf, NULL, DMA_FROM_DEVICE,
1837 id, sizeof(id[0]) * ATA_ID_WORDS, 0);
1841 * ata_dev_read_id - Read ID data from the specified device
1842 * @dev: target device
1843 * @p_class: pointer to class of the target device (may be changed)
1844 * @flags: ATA_READID_* flags
1845 * @id: buffer to read IDENTIFY data into
1847 * Read ID data from the specified device. ATA_CMD_ID_ATA is
1848 * performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
1849 * devices. This function also issues ATA_CMD_INIT_DEV_PARAMS
1850 * for pre-ATA4 drives.
1852 * FIXME: ATA_CMD_ID_ATA is optional for early drives and right
1853 * now we abort if we hit that case.
1855 * LOCKING:
1856 * Kernel thread context (may sleep)
1858 * RETURNS:
1859 * 0 on success, -errno otherwise.
1861 int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
1862 unsigned int flags, u16 *id)
1864 struct ata_port *ap = dev->link->ap;
1865 unsigned int class = *p_class;
1866 struct ata_taskfile tf;
1867 unsigned int err_mask = 0;
1868 const char *reason;
1869 bool is_semb = class == ATA_DEV_SEMB;
1870 int may_fallback = 1, tried_spinup = 0;
1871 int rc;
1873 if (ata_msg_ctl(ap))
1874 ata_dev_dbg(dev, "%s: ENTER\n", __func__);
1876 retry:
1877 ata_tf_init(dev, &tf);
1879 switch (class) {
1880 case ATA_DEV_SEMB:
1881 class = ATA_DEV_ATA; /* some hard drives report SEMB sig */
1882 /* fall through */
1883 case ATA_DEV_ATA:
1884 case ATA_DEV_ZAC:
1885 tf.command = ATA_CMD_ID_ATA;
1886 break;
1887 case ATA_DEV_ATAPI:
1888 tf.command = ATA_CMD_ID_ATAPI;
1889 break;
1890 default:
1891 rc = -ENODEV;
1892 reason = "unsupported class";
1893 goto err_out;
1896 tf.protocol = ATA_PROT_PIO;
1898 /* Some devices choke if TF registers contain garbage. Make
1899 * sure those are properly initialized.
1901 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1903 /* Device presence detection is unreliable on some
1904 * controllers. Always poll IDENTIFY if available.
1906 tf.flags |= ATA_TFLAG_POLLING;
1908 if (ap->ops->read_id)
1909 err_mask = ap->ops->read_id(dev, &tf, id);
1910 else
1911 err_mask = ata_do_dev_read_id(dev, &tf, id);
1913 if (err_mask) {
1914 if (err_mask & AC_ERR_NODEV_HINT) {
1915 ata_dev_dbg(dev, "NODEV after polling detection\n");
1916 return -ENOENT;
1919 if (is_semb) {
1920 ata_dev_info(dev,
1921 "IDENTIFY failed on device w/ SEMB sig, disabled\n");
1922 /* SEMB is not supported yet */
1923 *p_class = ATA_DEV_SEMB_UNSUP;
1924 return 0;
1927 if ((err_mask == AC_ERR_DEV) && (tf.feature & ATA_ABORTED)) {
1928 /* Device or controller might have reported
1929 * the wrong device class. Give a shot at the
1930 * other IDENTIFY if the current one is
1931 * aborted by the device.
1933 if (may_fallback) {
1934 may_fallback = 0;
1936 if (class == ATA_DEV_ATA)
1937 class = ATA_DEV_ATAPI;
1938 else
1939 class = ATA_DEV_ATA;
1940 goto retry;
1943 /* Control reaches here iff the device aborted
1944 * both flavors of IDENTIFYs which happens
1945 * sometimes with phantom devices.
1947 ata_dev_dbg(dev,
1948 "both IDENTIFYs aborted, assuming NODEV\n");
1949 return -ENOENT;
1952 rc = -EIO;
1953 reason = "I/O error";
1954 goto err_out;
1957 if (dev->horkage & ATA_HORKAGE_DUMP_ID) {
1958 ata_dev_dbg(dev, "dumping IDENTIFY data, "
1959 "class=%d may_fallback=%d tried_spinup=%d\n",
1960 class, may_fallback, tried_spinup);
1961 print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET,
1962 16, 2, id, ATA_ID_WORDS * sizeof(*id), true);
1965 /* Falling back doesn't make sense if ID data was read
1966 * successfully at least once.
1968 may_fallback = 0;
1970 swap_buf_le16(id, ATA_ID_WORDS);
1972 /* sanity check */
1973 rc = -EINVAL;
1974 reason = "device reports invalid type";
1976 if (class == ATA_DEV_ATA || class == ATA_DEV_ZAC) {
1977 if (!ata_id_is_ata(id) && !ata_id_is_cfa(id))
1978 goto err_out;
1979 if (ap->host->flags & ATA_HOST_IGNORE_ATA &&
1980 ata_id_is_ata(id)) {
1981 ata_dev_dbg(dev,
1982 "host indicates ignore ATA devices, ignored\n");
1983 return -ENOENT;
1985 } else {
1986 if (ata_id_is_ata(id))
1987 goto err_out;
1990 if (!tried_spinup && (id[2] == 0x37c8 || id[2] == 0x738c)) {
1991 tried_spinup = 1;
1993 * Drive powered-up in standby mode, and requires a specific
1994 * SET_FEATURES spin-up subcommand before it will accept
1995 * anything other than the original IDENTIFY command.
1997 err_mask = ata_dev_set_feature(dev, SETFEATURES_SPINUP, 0);
1998 if (err_mask && id[2] != 0x738c) {
1999 rc = -EIO;
2000 reason = "SPINUP failed";
2001 goto err_out;
2004 * If the drive initially returned incomplete IDENTIFY info,
2005 * we now must reissue the IDENTIFY command.
2007 if (id[2] == 0x37c8)
2008 goto retry;
2011 if ((flags & ATA_READID_POSTRESET) &&
2012 (class == ATA_DEV_ATA || class == ATA_DEV_ZAC)) {
2014 * The exact sequence expected by certain pre-ATA4 drives is:
2015 * SRST RESET
2016 * IDENTIFY (optional in early ATA)
2017 * INITIALIZE DEVICE PARAMETERS (later IDE and ATA)
2018 * anything else..
2019 * Some drives were very specific about that exact sequence.
2021 * Note that ATA4 says lba is mandatory so the second check
2022 * should never trigger.
2024 if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
2025 err_mask = ata_dev_init_params(dev, id[3], id[6]);
2026 if (err_mask) {
2027 rc = -EIO;
2028 reason = "INIT_DEV_PARAMS failed";
2029 goto err_out;
2032 /* current CHS translation info (id[53-58]) might be
2033 * changed. reread the identify device info.
2035 flags &= ~ATA_READID_POSTRESET;
2036 goto retry;
2040 *p_class = class;
2042 return 0;
2044 err_out:
2045 if (ata_msg_warn(ap))
2046 ata_dev_warn(dev, "failed to IDENTIFY (%s, err_mask=0x%x)\n",
2047 reason, err_mask);
2048 return rc;
2052 * ata_read_log_page - read a specific log page
2053 * @dev: target device
2054 * @log: log to read
2055 * @page: page to read
2056 * @buf: buffer to store read page
2057 * @sectors: number of sectors to read
2059 * Read log page using READ_LOG_EXT command.
2061 * LOCKING:
2062 * Kernel thread context (may sleep).
2064 * RETURNS:
2065 * 0 on success, AC_ERR_* mask otherwise.
2067 unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
2068 u8 page, void *buf, unsigned int sectors)
2070 unsigned long ap_flags = dev->link->ap->flags;
2071 struct ata_taskfile tf;
2072 unsigned int err_mask;
2073 bool dma = false;
2075 DPRINTK("read log page - log 0x%x, page 0x%x\n", log, page);
2078 * Return error without actually issuing the command on controllers
2079 * which e.g. lockup on a read log page.
2081 if (ap_flags & ATA_FLAG_NO_LOG_PAGE)
2082 return AC_ERR_DEV;
2084 retry:
2085 ata_tf_init(dev, &tf);
2086 if (dev->dma_mode && ata_id_has_read_log_dma_ext(dev->id) &&
2087 !(dev->horkage & ATA_HORKAGE_NO_DMA_LOG)) {
2088 tf.command = ATA_CMD_READ_LOG_DMA_EXT;
2089 tf.protocol = ATA_PROT_DMA;
2090 dma = true;
2091 } else {
2092 tf.command = ATA_CMD_READ_LOG_EXT;
2093 tf.protocol = ATA_PROT_PIO;
2094 dma = false;
2096 tf.lbal = log;
2097 tf.lbam = page;
2098 tf.nsect = sectors;
2099 tf.hob_nsect = sectors >> 8;
2100 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_LBA48 | ATA_TFLAG_DEVICE;
2102 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_FROM_DEVICE,
2103 buf, sectors * ATA_SECT_SIZE, 0);
2105 if (err_mask && dma) {
2106 dev->horkage |= ATA_HORKAGE_NO_DMA_LOG;
2107 ata_dev_warn(dev, "READ LOG DMA EXT failed, trying PIO\n");
2108 goto retry;
2111 DPRINTK("EXIT, err_mask=%x\n", err_mask);
2112 return err_mask;
2115 static bool ata_log_supported(struct ata_device *dev, u8 log)
2117 struct ata_port *ap = dev->link->ap;
2119 if (ata_read_log_page(dev, ATA_LOG_DIRECTORY, 0, ap->sector_buf, 1))
2120 return false;
2121 return get_unaligned_le16(&ap->sector_buf[log * 2]) ? true : false;
2124 static bool ata_identify_page_supported(struct ata_device *dev, u8 page)
2126 struct ata_port *ap = dev->link->ap;
2127 unsigned int err, i;
2129 if (!ata_log_supported(dev, ATA_LOG_IDENTIFY_DEVICE)) {
2130 ata_dev_warn(dev, "ATA Identify Device Log not supported\n");
2131 return false;
2135 * Read IDENTIFY DEVICE data log, page 0, to figure out if the page is
2136 * supported.
2138 err = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE, 0, ap->sector_buf,
2140 if (err) {
2141 ata_dev_info(dev,
2142 "failed to get Device Identify Log Emask 0x%x\n",
2143 err);
2144 return false;
2147 for (i = 0; i < ap->sector_buf[8]; i++) {
2148 if (ap->sector_buf[9 + i] == page)
2149 return true;
2152 return false;
2155 static int ata_do_link_spd_horkage(struct ata_device *dev)
2157 struct ata_link *plink = ata_dev_phys_link(dev);
2158 u32 target, target_limit;
2160 if (!sata_scr_valid(plink))
2161 return 0;
2163 if (dev->horkage & ATA_HORKAGE_1_5_GBPS)
2164 target = 1;
2165 else
2166 return 0;
2168 target_limit = (1 << target) - 1;
2170 /* if already on stricter limit, no need to push further */
2171 if (plink->sata_spd_limit <= target_limit)
2172 return 0;
2174 plink->sata_spd_limit = target_limit;
2176 /* Request another EH round by returning -EAGAIN if link is
2177 * going faster than the target speed. Forward progress is
2178 * guaranteed by setting sata_spd_limit to target_limit above.
2180 if (plink->sata_spd > target) {
2181 ata_dev_info(dev, "applying link speed limit horkage to %s\n",
2182 sata_spd_string(target));
2183 return -EAGAIN;
2185 return 0;
2188 static inline u8 ata_dev_knobble(struct ata_device *dev)
2190 struct ata_port *ap = dev->link->ap;
2192 if (ata_dev_blacklisted(dev) & ATA_HORKAGE_BRIDGE_OK)
2193 return 0;
2195 return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
2198 static void ata_dev_config_ncq_send_recv(struct ata_device *dev)
2200 struct ata_port *ap = dev->link->ap;
2201 unsigned int err_mask;
2203 if (!ata_log_supported(dev, ATA_LOG_NCQ_SEND_RECV)) {
2204 ata_dev_warn(dev, "NCQ Send/Recv Log not supported\n");
2205 return;
2207 err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_SEND_RECV,
2208 0, ap->sector_buf, 1);
2209 if (err_mask) {
2210 ata_dev_dbg(dev,
2211 "failed to get NCQ Send/Recv Log Emask 0x%x\n",
2212 err_mask);
2213 } else {
2214 u8 *cmds = dev->ncq_send_recv_cmds;
2216 dev->flags |= ATA_DFLAG_NCQ_SEND_RECV;
2217 memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_SEND_RECV_SIZE);
2219 if (dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM) {
2220 ata_dev_dbg(dev, "disabling queued TRIM support\n");
2221 cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &=
2222 ~ATA_LOG_NCQ_SEND_RECV_DSM_TRIM;
2227 static void ata_dev_config_ncq_non_data(struct ata_device *dev)
2229 struct ata_port *ap = dev->link->ap;
2230 unsigned int err_mask;
2232 if (!ata_log_supported(dev, ATA_LOG_NCQ_NON_DATA)) {
2233 ata_dev_warn(dev,
2234 "NCQ Send/Recv Log not supported\n");
2235 return;
2237 err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_NON_DATA,
2238 0, ap->sector_buf, 1);
2239 if (err_mask) {
2240 ata_dev_dbg(dev,
2241 "failed to get NCQ Non-Data Log Emask 0x%x\n",
2242 err_mask);
2243 } else {
2244 u8 *cmds = dev->ncq_non_data_cmds;
2246 memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_NON_DATA_SIZE);
2250 static void ata_dev_config_ncq_prio(struct ata_device *dev)
2252 struct ata_port *ap = dev->link->ap;
2253 unsigned int err_mask;
2255 if (!(dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE)) {
2256 dev->flags &= ~ATA_DFLAG_NCQ_PRIO;
2257 return;
2260 err_mask = ata_read_log_page(dev,
2261 ATA_LOG_IDENTIFY_DEVICE,
2262 ATA_LOG_SATA_SETTINGS,
2263 ap->sector_buf,
2265 if (err_mask) {
2266 ata_dev_dbg(dev,
2267 "failed to get Identify Device data, Emask 0x%x\n",
2268 err_mask);
2269 return;
2272 if (ap->sector_buf[ATA_LOG_NCQ_PRIO_OFFSET] & BIT(3)) {
2273 dev->flags |= ATA_DFLAG_NCQ_PRIO;
2274 } else {
2275 dev->flags &= ~ATA_DFLAG_NCQ_PRIO;
2276 ata_dev_dbg(dev, "SATA page does not support priority\n");
2281 static int ata_dev_config_ncq(struct ata_device *dev,
2282 char *desc, size_t desc_sz)
2284 struct ata_port *ap = dev->link->ap;
2285 int hdepth = 0, ddepth = ata_id_queue_depth(dev->id);
2286 unsigned int err_mask;
2287 char *aa_desc = "";
2289 if (!ata_id_has_ncq(dev->id)) {
2290 desc[0] = '\0';
2291 return 0;
2293 if (dev->horkage & ATA_HORKAGE_NONCQ) {
2294 snprintf(desc, desc_sz, "NCQ (not used)");
2295 return 0;
2297 if (ap->flags & ATA_FLAG_NCQ) {
2298 hdepth = min(ap->scsi_host->can_queue, ATA_MAX_QUEUE - 1);
2299 dev->flags |= ATA_DFLAG_NCQ;
2302 if (!(dev->horkage & ATA_HORKAGE_BROKEN_FPDMA_AA) &&
2303 (ap->flags & ATA_FLAG_FPDMA_AA) &&
2304 ata_id_has_fpdma_aa(dev->id)) {
2305 err_mask = ata_dev_set_feature(dev, SETFEATURES_SATA_ENABLE,
2306 SATA_FPDMA_AA);
2307 if (err_mask) {
2308 ata_dev_err(dev,
2309 "failed to enable AA (error_mask=0x%x)\n",
2310 err_mask);
2311 if (err_mask != AC_ERR_DEV) {
2312 dev->horkage |= ATA_HORKAGE_BROKEN_FPDMA_AA;
2313 return -EIO;
2315 } else
2316 aa_desc = ", AA";
2319 if (hdepth >= ddepth)
2320 snprintf(desc, desc_sz, "NCQ (depth %d)%s", ddepth, aa_desc);
2321 else
2322 snprintf(desc, desc_sz, "NCQ (depth %d/%d)%s", hdepth,
2323 ddepth, aa_desc);
2325 if ((ap->flags & ATA_FLAG_FPDMA_AUX)) {
2326 if (ata_id_has_ncq_send_and_recv(dev->id))
2327 ata_dev_config_ncq_send_recv(dev);
2328 if (ata_id_has_ncq_non_data(dev->id))
2329 ata_dev_config_ncq_non_data(dev);
2330 if (ata_id_has_ncq_prio(dev->id))
2331 ata_dev_config_ncq_prio(dev);
2334 return 0;
2337 static void ata_dev_config_sense_reporting(struct ata_device *dev)
2339 unsigned int err_mask;
2341 if (!ata_id_has_sense_reporting(dev->id))
2342 return;
2344 if (ata_id_sense_reporting_enabled(dev->id))
2345 return;
2347 err_mask = ata_dev_set_feature(dev, SETFEATURE_SENSE_DATA, 0x1);
2348 if (err_mask) {
2349 ata_dev_dbg(dev,
2350 "failed to enable Sense Data Reporting, Emask 0x%x\n",
2351 err_mask);
2355 static void ata_dev_config_zac(struct ata_device *dev)
2357 struct ata_port *ap = dev->link->ap;
2358 unsigned int err_mask;
2359 u8 *identify_buf = ap->sector_buf;
2361 dev->zac_zones_optimal_open = U32_MAX;
2362 dev->zac_zones_optimal_nonseq = U32_MAX;
2363 dev->zac_zones_max_open = U32_MAX;
2366 * Always set the 'ZAC' flag for Host-managed devices.
2368 if (dev->class == ATA_DEV_ZAC)
2369 dev->flags |= ATA_DFLAG_ZAC;
2370 else if (ata_id_zoned_cap(dev->id) == 0x01)
2372 * Check for host-aware devices.
2374 dev->flags |= ATA_DFLAG_ZAC;
2376 if (!(dev->flags & ATA_DFLAG_ZAC))
2377 return;
2379 if (!ata_identify_page_supported(dev, ATA_LOG_ZONED_INFORMATION)) {
2380 ata_dev_warn(dev,
2381 "ATA Zoned Information Log not supported\n");
2382 return;
2386 * Read IDENTIFY DEVICE data log, page 9 (Zoned-device information)
2388 err_mask = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE,
2389 ATA_LOG_ZONED_INFORMATION,
2390 identify_buf, 1);
2391 if (!err_mask) {
2392 u64 zoned_cap, opt_open, opt_nonseq, max_open;
2394 zoned_cap = get_unaligned_le64(&identify_buf[8]);
2395 if ((zoned_cap >> 63))
2396 dev->zac_zoned_cap = (zoned_cap & 1);
2397 opt_open = get_unaligned_le64(&identify_buf[24]);
2398 if ((opt_open >> 63))
2399 dev->zac_zones_optimal_open = (u32)opt_open;
2400 opt_nonseq = get_unaligned_le64(&identify_buf[32]);
2401 if ((opt_nonseq >> 63))
2402 dev->zac_zones_optimal_nonseq = (u32)opt_nonseq;
2403 max_open = get_unaligned_le64(&identify_buf[40]);
2404 if ((max_open >> 63))
2405 dev->zac_zones_max_open = (u32)max_open;
2409 static void ata_dev_config_trusted(struct ata_device *dev)
2411 struct ata_port *ap = dev->link->ap;
2412 u64 trusted_cap;
2413 unsigned int err;
2415 if (!ata_id_has_trusted(dev->id))
2416 return;
2418 if (!ata_identify_page_supported(dev, ATA_LOG_SECURITY)) {
2419 ata_dev_warn(dev,
2420 "Security Log not supported\n");
2421 return;
2424 err = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE, ATA_LOG_SECURITY,
2425 ap->sector_buf, 1);
2426 if (err) {
2427 ata_dev_dbg(dev,
2428 "failed to read Security Log, Emask 0x%x\n", err);
2429 return;
2432 trusted_cap = get_unaligned_le64(&ap->sector_buf[40]);
2433 if (!(trusted_cap & (1ULL << 63))) {
2434 ata_dev_dbg(dev,
2435 "Trusted Computing capability qword not valid!\n");
2436 return;
2439 if (trusted_cap & (1 << 0))
2440 dev->flags |= ATA_DFLAG_TRUSTED;
2444 * ata_dev_configure - Configure the specified ATA/ATAPI device
2445 * @dev: Target device to configure
2447 * Configure @dev according to @dev->id. Generic and low-level
2448 * driver specific fixups are also applied.
2450 * LOCKING:
2451 * Kernel thread context (may sleep)
2453 * RETURNS:
2454 * 0 on success, -errno otherwise
2456 int ata_dev_configure(struct ata_device *dev)
2458 struct ata_port *ap = dev->link->ap;
2459 struct ata_eh_context *ehc = &dev->link->eh_context;
2460 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
2461 const u16 *id = dev->id;
2462 unsigned long xfer_mask;
2463 unsigned int err_mask;
2464 char revbuf[7]; /* XYZ-99\0 */
2465 char fwrevbuf[ATA_ID_FW_REV_LEN+1];
2466 char modelbuf[ATA_ID_PROD_LEN+1];
2467 int rc;
2469 if (!ata_dev_enabled(dev) && ata_msg_info(ap)) {
2470 ata_dev_info(dev, "%s: ENTER/EXIT -- nodev\n", __func__);
2471 return 0;
2474 if (ata_msg_probe(ap))
2475 ata_dev_dbg(dev, "%s: ENTER\n", __func__);
2477 /* set horkage */
2478 dev->horkage |= ata_dev_blacklisted(dev);
2479 ata_force_horkage(dev);
2481 if (dev->horkage & ATA_HORKAGE_DISABLE) {
2482 ata_dev_info(dev, "unsupported device, disabling\n");
2483 ata_dev_disable(dev);
2484 return 0;
2487 if ((!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) &&
2488 dev->class == ATA_DEV_ATAPI) {
2489 ata_dev_warn(dev, "WARNING: ATAPI is %s, device ignored\n",
2490 atapi_enabled ? "not supported with this driver"
2491 : "disabled");
2492 ata_dev_disable(dev);
2493 return 0;
2496 rc = ata_do_link_spd_horkage(dev);
2497 if (rc)
2498 return rc;
2500 /* some WD SATA-1 drives have issues with LPM, turn on NOLPM for them */
2501 if ((dev->horkage & ATA_HORKAGE_WD_BROKEN_LPM) &&
2502 (id[ATA_ID_SATA_CAPABILITY] & 0xe) == 0x2)
2503 dev->horkage |= ATA_HORKAGE_NOLPM;
2505 if (dev->horkage & ATA_HORKAGE_NOLPM) {
2506 ata_dev_warn(dev, "LPM support broken, forcing max_power\n");
2507 dev->link->ap->target_lpm_policy = ATA_LPM_MAX_POWER;
2510 /* let ACPI work its magic */
2511 rc = ata_acpi_on_devcfg(dev);
2512 if (rc)
2513 return rc;
2515 /* massage HPA, do it early as it might change IDENTIFY data */
2516 rc = ata_hpa_resize(dev);
2517 if (rc)
2518 return rc;
2520 /* print device capabilities */
2521 if (ata_msg_probe(ap))
2522 ata_dev_dbg(dev,
2523 "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
2524 "85:%04x 86:%04x 87:%04x 88:%04x\n",
2525 __func__,
2526 id[49], id[82], id[83], id[84],
2527 id[85], id[86], id[87], id[88]);
2529 /* initialize to-be-configured parameters */
2530 dev->flags &= ~ATA_DFLAG_CFG_MASK;
2531 dev->max_sectors = 0;
2532 dev->cdb_len = 0;
2533 dev->n_sectors = 0;
2534 dev->cylinders = 0;
2535 dev->heads = 0;
2536 dev->sectors = 0;
2537 dev->multi_count = 0;
2540 * common ATA, ATAPI feature tests
2543 /* find max transfer mode; for printk only */
2544 xfer_mask = ata_id_xfermask(id);
2546 if (ata_msg_probe(ap))
2547 ata_dump_id(id);
2549 /* SCSI only uses 4-char revisions, dump full 8 chars from ATA */
2550 ata_id_c_string(dev->id, fwrevbuf, ATA_ID_FW_REV,
2551 sizeof(fwrevbuf));
2553 ata_id_c_string(dev->id, modelbuf, ATA_ID_PROD,
2554 sizeof(modelbuf));
2556 /* ATA-specific feature tests */
2557 if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
2558 if (ata_id_is_cfa(id)) {
2559 /* CPRM may make this media unusable */
2560 if (id[ATA_ID_CFA_KEY_MGMT] & 1)
2561 ata_dev_warn(dev,
2562 "supports DRM functions and may not be fully accessible\n");
2563 snprintf(revbuf, 7, "CFA");
2564 } else {
2565 snprintf(revbuf, 7, "ATA-%d", ata_id_major_version(id));
2566 /* Warn the user if the device has TPM extensions */
2567 if (ata_id_has_tpm(id))
2568 ata_dev_warn(dev,
2569 "supports DRM functions and may not be fully accessible\n");
2572 dev->n_sectors = ata_id_n_sectors(id);
2574 /* get current R/W Multiple count setting */
2575 if ((dev->id[47] >> 8) == 0x80 && (dev->id[59] & 0x100)) {
2576 unsigned int max = dev->id[47] & 0xff;
2577 unsigned int cnt = dev->id[59] & 0xff;
2578 /* only recognize/allow powers of two here */
2579 if (is_power_of_2(max) && is_power_of_2(cnt))
2580 if (cnt <= max)
2581 dev->multi_count = cnt;
2584 if (ata_id_has_lba(id)) {
2585 const char *lba_desc;
2586 char ncq_desc[24];
2588 lba_desc = "LBA";
2589 dev->flags |= ATA_DFLAG_LBA;
2590 if (ata_id_has_lba48(id)) {
2591 dev->flags |= ATA_DFLAG_LBA48;
2592 lba_desc = "LBA48";
2594 if (dev->n_sectors >= (1UL << 28) &&
2595 ata_id_has_flush_ext(id))
2596 dev->flags |= ATA_DFLAG_FLUSH_EXT;
2599 /* config NCQ */
2600 rc = ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
2601 if (rc)
2602 return rc;
2604 /* print device info to dmesg */
2605 if (ata_msg_drv(ap) && print_info) {
2606 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2607 revbuf, modelbuf, fwrevbuf,
2608 ata_mode_string(xfer_mask));
2609 ata_dev_info(dev,
2610 "%llu sectors, multi %u: %s %s\n",
2611 (unsigned long long)dev->n_sectors,
2612 dev->multi_count, lba_desc, ncq_desc);
2614 } else {
2615 /* CHS */
2617 /* Default translation */
2618 dev->cylinders = id[1];
2619 dev->heads = id[3];
2620 dev->sectors = id[6];
2622 if (ata_id_current_chs_valid(id)) {
2623 /* Current CHS translation is valid. */
2624 dev->cylinders = id[54];
2625 dev->heads = id[55];
2626 dev->sectors = id[56];
2629 /* print device info to dmesg */
2630 if (ata_msg_drv(ap) && print_info) {
2631 ata_dev_info(dev, "%s: %s, %s, max %s\n",
2632 revbuf, modelbuf, fwrevbuf,
2633 ata_mode_string(xfer_mask));
2634 ata_dev_info(dev,
2635 "%llu sectors, multi %u, CHS %u/%u/%u\n",
2636 (unsigned long long)dev->n_sectors,
2637 dev->multi_count, dev->cylinders,
2638 dev->heads, dev->sectors);
2642 /* Check and mark DevSlp capability. Get DevSlp timing variables
2643 * from SATA Settings page of Identify Device Data Log.
2645 if (ata_id_has_devslp(dev->id)) {
2646 u8 *sata_setting = ap->sector_buf;
2647 int i, j;
2649 dev->flags |= ATA_DFLAG_DEVSLP;
2650 err_mask = ata_read_log_page(dev,
2651 ATA_LOG_IDENTIFY_DEVICE,
2652 ATA_LOG_SATA_SETTINGS,
2653 sata_setting,
2655 if (err_mask)
2656 ata_dev_dbg(dev,
2657 "failed to get Identify Device Data, Emask 0x%x\n",
2658 err_mask);
2659 else
2660 for (i = 0; i < ATA_LOG_DEVSLP_SIZE; i++) {
2661 j = ATA_LOG_DEVSLP_OFFSET + i;
2662 dev->devslp_timing[i] = sata_setting[j];
2665 ata_dev_config_sense_reporting(dev);
2666 ata_dev_config_zac(dev);
2667 ata_dev_config_trusted(dev);
2668 dev->cdb_len = 32;
2671 /* ATAPI-specific feature tests */
2672 else if (dev->class == ATA_DEV_ATAPI) {
2673 const char *cdb_intr_string = "";
2674 const char *atapi_an_string = "";
2675 const char *dma_dir_string = "";
2676 u32 sntf;
2678 rc = atapi_cdb_len(id);
2679 if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
2680 if (ata_msg_warn(ap))
2681 ata_dev_warn(dev, "unsupported CDB len\n");
2682 rc = -EINVAL;
2683 goto err_out_nosup;
2685 dev->cdb_len = (unsigned int) rc;
2687 /* Enable ATAPI AN if both the host and device have
2688 * the support. If PMP is attached, SNTF is required
2689 * to enable ATAPI AN to discern between PHY status
2690 * changed notifications and ATAPI ANs.
2692 if (atapi_an &&
2693 (ap->flags & ATA_FLAG_AN) && ata_id_has_atapi_AN(id) &&
2694 (!sata_pmp_attached(ap) ||
2695 sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf) == 0)) {
2696 /* issue SET feature command to turn this on */
2697 err_mask = ata_dev_set_feature(dev,
2698 SETFEATURES_SATA_ENABLE, SATA_AN);
2699 if (err_mask)
2700 ata_dev_err(dev,
2701 "failed to enable ATAPI AN (err_mask=0x%x)\n",
2702 err_mask);
2703 else {
2704 dev->flags |= ATA_DFLAG_AN;
2705 atapi_an_string = ", ATAPI AN";
2709 if (ata_id_cdb_intr(dev->id)) {
2710 dev->flags |= ATA_DFLAG_CDB_INTR;
2711 cdb_intr_string = ", CDB intr";
2714 if (atapi_dmadir || (dev->horkage & ATA_HORKAGE_ATAPI_DMADIR) || atapi_id_dmadir(dev->id)) {
2715 dev->flags |= ATA_DFLAG_DMADIR;
2716 dma_dir_string = ", DMADIR";
2719 if (ata_id_has_da(dev->id)) {
2720 dev->flags |= ATA_DFLAG_DA;
2721 zpodd_init(dev);
2724 /* print device info to dmesg */
2725 if (ata_msg_drv(ap) && print_info)
2726 ata_dev_info(dev,
2727 "ATAPI: %s, %s, max %s%s%s%s\n",
2728 modelbuf, fwrevbuf,
2729 ata_mode_string(xfer_mask),
2730 cdb_intr_string, atapi_an_string,
2731 dma_dir_string);
2734 /* determine max_sectors */
2735 dev->max_sectors = ATA_MAX_SECTORS;
2736 if (dev->flags & ATA_DFLAG_LBA48)
2737 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2739 /* Limit PATA drive on SATA cable bridge transfers to udma5,
2740 200 sectors */
2741 if (ata_dev_knobble(dev)) {
2742 if (ata_msg_drv(ap) && print_info)
2743 ata_dev_info(dev, "applying bridge limits\n");
2744 dev->udma_mask &= ATA_UDMA5;
2745 dev->max_sectors = ATA_MAX_SECTORS;
2748 if ((dev->class == ATA_DEV_ATAPI) &&
2749 (atapi_command_packet_set(id) == TYPE_TAPE)) {
2750 dev->max_sectors = ATA_MAX_SECTORS_TAPE;
2751 dev->horkage |= ATA_HORKAGE_STUCK_ERR;
2754 if (dev->horkage & ATA_HORKAGE_MAX_SEC_128)
2755 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_128,
2756 dev->max_sectors);
2758 if (dev->horkage & ATA_HORKAGE_MAX_SEC_1024)
2759 dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_1024,
2760 dev->max_sectors);
2762 if (dev->horkage & ATA_HORKAGE_MAX_SEC_LBA48)
2763 dev->max_sectors = ATA_MAX_SECTORS_LBA48;
2765 if (ap->ops->dev_config)
2766 ap->ops->dev_config(dev);
2768 if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
2769 /* Let the user know. We don't want to disallow opens for
2770 rescue purposes, or in case the vendor is just a blithering
2771 idiot. Do this after the dev_config call as some controllers
2772 with buggy firmware may want to avoid reporting false device
2773 bugs */
2775 if (print_info) {
2776 ata_dev_warn(dev,
2777 "Drive reports diagnostics failure. This may indicate a drive\n");
2778 ata_dev_warn(dev,
2779 "fault or invalid emulation. Contact drive vendor for information.\n");
2783 if ((dev->horkage & ATA_HORKAGE_FIRMWARE_WARN) && print_info) {
2784 ata_dev_warn(dev, "WARNING: device requires firmware update to be fully functional\n");
2785 ata_dev_warn(dev, " contact the vendor or visit http://ata.wiki.kernel.org\n");
2788 return 0;
2790 err_out_nosup:
2791 if (ata_msg_probe(ap))
2792 ata_dev_dbg(dev, "%s: EXIT, err\n", __func__);
2793 return rc;
2797 * ata_cable_40wire - return 40 wire cable type
2798 * @ap: port
2800 * Helper method for drivers which want to hardwire 40 wire cable
2801 * detection.
2804 int ata_cable_40wire(struct ata_port *ap)
2806 return ATA_CBL_PATA40;
2810 * ata_cable_80wire - return 80 wire cable type
2811 * @ap: port
2813 * Helper method for drivers which want to hardwire 80 wire cable
2814 * detection.
2817 int ata_cable_80wire(struct ata_port *ap)
2819 return ATA_CBL_PATA80;
2823 * ata_cable_unknown - return unknown PATA cable.
2824 * @ap: port
2826 * Helper method for drivers which have no PATA cable detection.
2829 int ata_cable_unknown(struct ata_port *ap)
2831 return ATA_CBL_PATA_UNK;
2835 * ata_cable_ignore - return ignored PATA cable.
2836 * @ap: port
2838 * Helper method for drivers which don't use cable type to limit
2839 * transfer mode.
2841 int ata_cable_ignore(struct ata_port *ap)
2843 return ATA_CBL_PATA_IGN;
2847 * ata_cable_sata - return SATA cable type
2848 * @ap: port
2850 * Helper method for drivers which have SATA cables
2853 int ata_cable_sata(struct ata_port *ap)
2855 return ATA_CBL_SATA;
2859 * ata_bus_probe - Reset and probe ATA bus
2860 * @ap: Bus to probe
2862 * Master ATA bus probing function. Initiates a hardware-dependent
2863 * bus reset, then attempts to identify any devices found on
2864 * the bus.
2866 * LOCKING:
2867 * PCI/etc. bus probe sem.
2869 * RETURNS:
2870 * Zero on success, negative errno otherwise.
2873 int ata_bus_probe(struct ata_port *ap)
2875 unsigned int classes[ATA_MAX_DEVICES];
2876 int tries[ATA_MAX_DEVICES];
2877 int rc;
2878 struct ata_device *dev;
2880 ata_for_each_dev(dev, &ap->link, ALL)
2881 tries[dev->devno] = ATA_PROBE_MAX_TRIES;
2883 retry:
2884 ata_for_each_dev(dev, &ap->link, ALL) {
2885 /* If we issue an SRST then an ATA drive (not ATAPI)
2886 * may change configuration and be in PIO0 timing. If
2887 * we do a hard reset (or are coming from power on)
2888 * this is true for ATA or ATAPI. Until we've set a
2889 * suitable controller mode we should not touch the
2890 * bus as we may be talking too fast.
2892 dev->pio_mode = XFER_PIO_0;
2893 dev->dma_mode = 0xff;
2895 /* If the controller has a pio mode setup function
2896 * then use it to set the chipset to rights. Don't
2897 * touch the DMA setup as that will be dealt with when
2898 * configuring devices.
2900 if (ap->ops->set_piomode)
2901 ap->ops->set_piomode(ap, dev);
2904 /* reset and determine device classes */
2905 ap->ops->phy_reset(ap);
2907 ata_for_each_dev(dev, &ap->link, ALL) {
2908 if (dev->class != ATA_DEV_UNKNOWN)
2909 classes[dev->devno] = dev->class;
2910 else
2911 classes[dev->devno] = ATA_DEV_NONE;
2913 dev->class = ATA_DEV_UNKNOWN;
2916 /* read IDENTIFY page and configure devices. We have to do the identify
2917 specific sequence bass-ackwards so that PDIAG- is released by
2918 the slave device */
2920 ata_for_each_dev(dev, &ap->link, ALL_REVERSE) {
2921 if (tries[dev->devno])
2922 dev->class = classes[dev->devno];
2924 if (!ata_dev_enabled(dev))
2925 continue;
2927 rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
2928 dev->id);
2929 if (rc)
2930 goto fail;
2933 /* Now ask for the cable type as PDIAG- should have been released */
2934 if (ap->ops->cable_detect)
2935 ap->cbl = ap->ops->cable_detect(ap);
2937 /* We may have SATA bridge glue hiding here irrespective of
2938 * the reported cable types and sensed types. When SATA
2939 * drives indicate we have a bridge, we don't know which end
2940 * of the link the bridge is which is a problem.
2942 ata_for_each_dev(dev, &ap->link, ENABLED)
2943 if (ata_id_is_sata(dev->id))
2944 ap->cbl = ATA_CBL_SATA;
2946 /* After the identify sequence we can now set up the devices. We do
2947 this in the normal order so that the user doesn't get confused */
2949 ata_for_each_dev(dev, &ap->link, ENABLED) {
2950 ap->link.eh_context.i.flags |= ATA_EHI_PRINTINFO;
2951 rc = ata_dev_configure(dev);
2952 ap->link.eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
2953 if (rc)
2954 goto fail;
2957 /* configure transfer mode */
2958 rc = ata_set_mode(&ap->link, &dev);
2959 if (rc)
2960 goto fail;
2962 ata_for_each_dev(dev, &ap->link, ENABLED)
2963 return 0;
2965 return -ENODEV;
2967 fail:
2968 tries[dev->devno]--;
2970 switch (rc) {
2971 case -EINVAL:
2972 /* eeek, something went very wrong, give up */
2973 tries[dev->devno] = 0;
2974 break;
2976 case -ENODEV:
2977 /* give it just one more chance */
2978 tries[dev->devno] = min(tries[dev->devno], 1);
2979 /* fall through */
2980 case -EIO:
2981 if (tries[dev->devno] == 1) {
2982 /* This is the last chance, better to slow
2983 * down than lose it.
2985 sata_down_spd_limit(&ap->link, 0);
2986 ata_down_xfermask_limit(dev, ATA_DNXFER_PIO);
2990 if (!tries[dev->devno])
2991 ata_dev_disable(dev);
2993 goto retry;
2997 * sata_print_link_status - Print SATA link status
2998 * @link: SATA link to printk link status about
3000 * This function prints link speed and status of a SATA link.
3002 * LOCKING:
3003 * None.
3005 static void sata_print_link_status(struct ata_link *link)
3007 u32 sstatus, scontrol, tmp;
3009 if (sata_scr_read(link, SCR_STATUS, &sstatus))
3010 return;
3011 sata_scr_read(link, SCR_CONTROL, &scontrol);
3013 if (ata_phys_link_online(link)) {
3014 tmp = (sstatus >> 4) & 0xf;
3015 ata_link_info(link, "SATA link up %s (SStatus %X SControl %X)\n",
3016 sata_spd_string(tmp), sstatus, scontrol);
3017 } else {
3018 ata_link_info(link, "SATA link down (SStatus %X SControl %X)\n",
3019 sstatus, scontrol);
3024 * ata_dev_pair - return other device on cable
3025 * @adev: device
3027 * Obtain the other device on the same cable, or if none is
3028 * present NULL is returned
3031 struct ata_device *ata_dev_pair(struct ata_device *adev)
3033 struct ata_link *link = adev->link;
3034 struct ata_device *pair = &link->device[1 - adev->devno];
3035 if (!ata_dev_enabled(pair))
3036 return NULL;
3037 return pair;
3041 * sata_down_spd_limit - adjust SATA spd limit downward
3042 * @link: Link to adjust SATA spd limit for
3043 * @spd_limit: Additional limit
3045 * Adjust SATA spd limit of @link downward. Note that this
3046 * function only adjusts the limit. The change must be applied
3047 * using sata_set_spd().
3049 * If @spd_limit is non-zero, the speed is limited to equal to or
3050 * lower than @spd_limit if such speed is supported. If
3051 * @spd_limit is slower than any supported speed, only the lowest
3052 * supported speed is allowed.
3054 * LOCKING:
3055 * Inherited from caller.
3057 * RETURNS:
3058 * 0 on success, negative errno on failure
3060 int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
3062 u32 sstatus, spd, mask;
3063 int rc, bit;
3065 if (!sata_scr_valid(link))
3066 return -EOPNOTSUPP;
3068 /* If SCR can be read, use it to determine the current SPD.
3069 * If not, use cached value in link->sata_spd.
3071 rc = sata_scr_read(link, SCR_STATUS, &sstatus);
3072 if (rc == 0 && ata_sstatus_online(sstatus))
3073 spd = (sstatus >> 4) & 0xf;
3074 else
3075 spd = link->sata_spd;
3077 mask = link->sata_spd_limit;
3078 if (mask <= 1)
3079 return -EINVAL;
3081 /* unconditionally mask off the highest bit */
3082 bit = fls(mask) - 1;
3083 mask &= ~(1 << bit);
3086 * Mask off all speeds higher than or equal to the current one. At
3087 * this point, if current SPD is not available and we previously
3088 * recorded the link speed from SStatus, the driver has already
3089 * masked off the highest bit so mask should already be 1 or 0.
3090 * Otherwise, we should not force 1.5Gbps on a link where we have
3091 * not previously recorded speed from SStatus. Just return in this
3092 * case.
3094 if (spd > 1)
3095 mask &= (1 << (spd - 1)) - 1;
3096 else
3097 return -EINVAL;
3099 /* were we already at the bottom? */
3100 if (!mask)
3101 return -EINVAL;
3103 if (spd_limit) {
3104 if (mask & ((1 << spd_limit) - 1))
3105 mask &= (1 << spd_limit) - 1;
3106 else {
3107 bit = ffs(mask) - 1;
3108 mask = 1 << bit;
3112 link->sata_spd_limit = mask;
3114 ata_link_warn(link, "limiting SATA link speed to %s\n",
3115 sata_spd_string(fls(mask)));
3117 return 0;
3120 static int __sata_set_spd_needed(struct ata_link *link, u32 *scontrol)
3122 struct ata_link *host_link = &link->ap->link;
3123 u32 limit, target, spd;
3125 limit = link->sata_spd_limit;
3127 /* Don't configure downstream link faster than upstream link.
3128 * It doesn't speed up anything and some PMPs choke on such
3129 * configuration.
3131 if (!ata_is_host_link(link) && host_link->sata_spd)
3132 limit &= (1 << host_link->sata_spd) - 1;
3134 if (limit == UINT_MAX)
3135 target = 0;
3136 else
3137 target = fls(limit);
3139 spd = (*scontrol >> 4) & 0xf;
3140 *scontrol = (*scontrol & ~0xf0) | ((target & 0xf) << 4);
3142 return spd != target;
3146 * sata_set_spd_needed - is SATA spd configuration needed
3147 * @link: Link in question
3149 * Test whether the spd limit in SControl matches
3150 * @link->sata_spd_limit. This function is used to determine
3151 * whether hardreset is necessary to apply SATA spd
3152 * configuration.
3154 * LOCKING:
3155 * Inherited from caller.
3157 * RETURNS:
3158 * 1 if SATA spd configuration is needed, 0 otherwise.
3160 static int sata_set_spd_needed(struct ata_link *link)
3162 u32 scontrol;
3164 if (sata_scr_read(link, SCR_CONTROL, &scontrol))
3165 return 1;
3167 return __sata_set_spd_needed(link, &scontrol);
3171 * sata_set_spd - set SATA spd according to spd limit
3172 * @link: Link to set SATA spd for
3174 * Set SATA spd of @link according to sata_spd_limit.
3176 * LOCKING:
3177 * Inherited from caller.
3179 * RETURNS:
3180 * 0 if spd doesn't need to be changed, 1 if spd has been
3181 * changed. Negative errno if SCR registers are inaccessible.
3183 int sata_set_spd(struct ata_link *link)
3185 u32 scontrol;
3186 int rc;
3188 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3189 return rc;
3191 if (!__sata_set_spd_needed(link, &scontrol))
3192 return 0;
3194 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
3195 return rc;
3197 return 1;
3201 * This mode timing computation functionality is ported over from
3202 * drivers/ide/ide-timing.h and was originally written by Vojtech Pavlik
3205 * PIO 0-4, MWDMA 0-2 and UDMA 0-6 timings (in nanoseconds).
3206 * These were taken from ATA/ATAPI-6 standard, rev 0a, except
3207 * for UDMA6, which is currently supported only by Maxtor drives.
3209 * For PIO 5/6 MWDMA 3/4 see the CFA specification 3.0.
3212 static const struct ata_timing ata_timing[] = {
3213 /* { XFER_PIO_SLOW, 120, 290, 240, 960, 290, 240, 0, 960, 0 }, */
3214 { XFER_PIO_0, 70, 290, 240, 600, 165, 150, 0, 600, 0 },
3215 { XFER_PIO_1, 50, 290, 93, 383, 125, 100, 0, 383, 0 },
3216 { XFER_PIO_2, 30, 290, 40, 330, 100, 90, 0, 240, 0 },
3217 { XFER_PIO_3, 30, 80, 70, 180, 80, 70, 0, 180, 0 },
3218 { XFER_PIO_4, 25, 70, 25, 120, 70, 25, 0, 120, 0 },
3219 { XFER_PIO_5, 15, 65, 25, 100, 65, 25, 0, 100, 0 },
3220 { XFER_PIO_6, 10, 55, 20, 80, 55, 20, 0, 80, 0 },
3222 { XFER_SW_DMA_0, 120, 0, 0, 0, 480, 480, 50, 960, 0 },
3223 { XFER_SW_DMA_1, 90, 0, 0, 0, 240, 240, 30, 480, 0 },
3224 { XFER_SW_DMA_2, 60, 0, 0, 0, 120, 120, 20, 240, 0 },
3226 { XFER_MW_DMA_0, 60, 0, 0, 0, 215, 215, 20, 480, 0 },
3227 { XFER_MW_DMA_1, 45, 0, 0, 0, 80, 50, 5, 150, 0 },
3228 { XFER_MW_DMA_2, 25, 0, 0, 0, 70, 25, 5, 120, 0 },
3229 { XFER_MW_DMA_3, 25, 0, 0, 0, 65, 25, 5, 100, 0 },
3230 { XFER_MW_DMA_4, 25, 0, 0, 0, 55, 20, 5, 80, 0 },
3232 /* { XFER_UDMA_SLOW, 0, 0, 0, 0, 0, 0, 0, 0, 150 }, */
3233 { XFER_UDMA_0, 0, 0, 0, 0, 0, 0, 0, 0, 120 },
3234 { XFER_UDMA_1, 0, 0, 0, 0, 0, 0, 0, 0, 80 },
3235 { XFER_UDMA_2, 0, 0, 0, 0, 0, 0, 0, 0, 60 },
3236 { XFER_UDMA_3, 0, 0, 0, 0, 0, 0, 0, 0, 45 },
3237 { XFER_UDMA_4, 0, 0, 0, 0, 0, 0, 0, 0, 30 },
3238 { XFER_UDMA_5, 0, 0, 0, 0, 0, 0, 0, 0, 20 },
3239 { XFER_UDMA_6, 0, 0, 0, 0, 0, 0, 0, 0, 15 },
3241 { 0xFF }
3244 #define ENOUGH(v, unit) (((v)-1)/(unit)+1)
3245 #define EZ(v, unit) ((v)?ENOUGH(((v) * 1000), unit):0)
3247 static void ata_timing_quantize(const struct ata_timing *t, struct ata_timing *q, int T, int UT)
3249 q->setup = EZ(t->setup, T);
3250 q->act8b = EZ(t->act8b, T);
3251 q->rec8b = EZ(t->rec8b, T);
3252 q->cyc8b = EZ(t->cyc8b, T);
3253 q->active = EZ(t->active, T);
3254 q->recover = EZ(t->recover, T);
3255 q->dmack_hold = EZ(t->dmack_hold, T);
3256 q->cycle = EZ(t->cycle, T);
3257 q->udma = EZ(t->udma, UT);
3260 void ata_timing_merge(const struct ata_timing *a, const struct ata_timing *b,
3261 struct ata_timing *m, unsigned int what)
3263 if (what & ATA_TIMING_SETUP ) m->setup = max(a->setup, b->setup);
3264 if (what & ATA_TIMING_ACT8B ) m->act8b = max(a->act8b, b->act8b);
3265 if (what & ATA_TIMING_REC8B ) m->rec8b = max(a->rec8b, b->rec8b);
3266 if (what & ATA_TIMING_CYC8B ) m->cyc8b = max(a->cyc8b, b->cyc8b);
3267 if (what & ATA_TIMING_ACTIVE ) m->active = max(a->active, b->active);
3268 if (what & ATA_TIMING_RECOVER) m->recover = max(a->recover, b->recover);
3269 if (what & ATA_TIMING_DMACK_HOLD) m->dmack_hold = max(a->dmack_hold, b->dmack_hold);
3270 if (what & ATA_TIMING_CYCLE ) m->cycle = max(a->cycle, b->cycle);
3271 if (what & ATA_TIMING_UDMA ) m->udma = max(a->udma, b->udma);
3274 const struct ata_timing *ata_timing_find_mode(u8 xfer_mode)
3276 const struct ata_timing *t = ata_timing;
3278 while (xfer_mode > t->mode)
3279 t++;
3281 if (xfer_mode == t->mode)
3282 return t;
3284 WARN_ONCE(true, "%s: unable to find timing for xfer_mode 0x%x\n",
3285 __func__, xfer_mode);
3287 return NULL;
3290 int ata_timing_compute(struct ata_device *adev, unsigned short speed,
3291 struct ata_timing *t, int T, int UT)
3293 const u16 *id = adev->id;
3294 const struct ata_timing *s;
3295 struct ata_timing p;
3298 * Find the mode.
3301 if (!(s = ata_timing_find_mode(speed)))
3302 return -EINVAL;
3304 memcpy(t, s, sizeof(*s));
3307 * If the drive is an EIDE drive, it can tell us it needs extended
3308 * PIO/MW_DMA cycle timing.
3311 if (id[ATA_ID_FIELD_VALID] & 2) { /* EIDE drive */
3312 memset(&p, 0, sizeof(p));
3314 if (speed >= XFER_PIO_0 && speed < XFER_SW_DMA_0) {
3315 if (speed <= XFER_PIO_2)
3316 p.cycle = p.cyc8b = id[ATA_ID_EIDE_PIO];
3317 else if ((speed <= XFER_PIO_4) ||
3318 (speed == XFER_PIO_5 && !ata_id_is_cfa(id)))
3319 p.cycle = p.cyc8b = id[ATA_ID_EIDE_PIO_IORDY];
3320 } else if (speed >= XFER_MW_DMA_0 && speed <= XFER_MW_DMA_2)
3321 p.cycle = id[ATA_ID_EIDE_DMA_MIN];
3323 ata_timing_merge(&p, t, t, ATA_TIMING_CYCLE | ATA_TIMING_CYC8B);
3327 * Convert the timing to bus clock counts.
3330 ata_timing_quantize(t, t, T, UT);
3333 * Even in DMA/UDMA modes we still use PIO access for IDENTIFY,
3334 * S.M.A.R.T * and some other commands. We have to ensure that the
3335 * DMA cycle timing is slower/equal than the fastest PIO timing.
3338 if (speed > XFER_PIO_6) {
3339 ata_timing_compute(adev, adev->pio_mode, &p, T, UT);
3340 ata_timing_merge(&p, t, t, ATA_TIMING_ALL);
3344 * Lengthen active & recovery time so that cycle time is correct.
3347 if (t->act8b + t->rec8b < t->cyc8b) {
3348 t->act8b += (t->cyc8b - (t->act8b + t->rec8b)) / 2;
3349 t->rec8b = t->cyc8b - t->act8b;
3352 if (t->active + t->recover < t->cycle) {
3353 t->active += (t->cycle - (t->active + t->recover)) / 2;
3354 t->recover = t->cycle - t->active;
3357 /* In a few cases quantisation may produce enough errors to
3358 leave t->cycle too low for the sum of active and recovery
3359 if so we must correct this */
3360 if (t->active + t->recover > t->cycle)
3361 t->cycle = t->active + t->recover;
3363 return 0;
3367 * ata_timing_cycle2mode - find xfer mode for the specified cycle duration
3368 * @xfer_shift: ATA_SHIFT_* value for transfer type to examine.
3369 * @cycle: cycle duration in ns
3371 * Return matching xfer mode for @cycle. The returned mode is of
3372 * the transfer type specified by @xfer_shift. If @cycle is too
3373 * slow for @xfer_shift, 0xff is returned. If @cycle is faster
3374 * than the fastest known mode, the fasted mode is returned.
3376 * LOCKING:
3377 * None.
3379 * RETURNS:
3380 * Matching xfer_mode, 0xff if no match found.
3382 u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle)
3384 u8 base_mode = 0xff, last_mode = 0xff;
3385 const struct ata_xfer_ent *ent;
3386 const struct ata_timing *t;
3388 for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
3389 if (ent->shift == xfer_shift)
3390 base_mode = ent->base;
3392 for (t = ata_timing_find_mode(base_mode);
3393 t && ata_xfer_mode2shift(t->mode) == xfer_shift; t++) {
3394 unsigned short this_cycle;
3396 switch (xfer_shift) {
3397 case ATA_SHIFT_PIO:
3398 case ATA_SHIFT_MWDMA:
3399 this_cycle = t->cycle;
3400 break;
3401 case ATA_SHIFT_UDMA:
3402 this_cycle = t->udma;
3403 break;
3404 default:
3405 return 0xff;
3408 if (cycle > this_cycle)
3409 break;
3411 last_mode = t->mode;
3414 return last_mode;
3418 * ata_down_xfermask_limit - adjust dev xfer masks downward
3419 * @dev: Device to adjust xfer masks
3420 * @sel: ATA_DNXFER_* selector
3422 * Adjust xfer masks of @dev downward. Note that this function
3423 * does not apply the change. Invoking ata_set_mode() afterwards
3424 * will apply the limit.
3426 * LOCKING:
3427 * Inherited from caller.
3429 * RETURNS:
3430 * 0 on success, negative errno on failure
3432 int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel)
3434 char buf[32];
3435 unsigned long orig_mask, xfer_mask;
3436 unsigned long pio_mask, mwdma_mask, udma_mask;
3437 int quiet, highbit;
3439 quiet = !!(sel & ATA_DNXFER_QUIET);
3440 sel &= ~ATA_DNXFER_QUIET;
3442 xfer_mask = orig_mask = ata_pack_xfermask(dev->pio_mask,
3443 dev->mwdma_mask,
3444 dev->udma_mask);
3445 ata_unpack_xfermask(xfer_mask, &pio_mask, &mwdma_mask, &udma_mask);
3447 switch (sel) {
3448 case ATA_DNXFER_PIO:
3449 highbit = fls(pio_mask) - 1;
3450 pio_mask &= ~(1 << highbit);
3451 break;
3453 case ATA_DNXFER_DMA:
3454 if (udma_mask) {
3455 highbit = fls(udma_mask) - 1;
3456 udma_mask &= ~(1 << highbit);
3457 if (!udma_mask)
3458 return -ENOENT;
3459 } else if (mwdma_mask) {
3460 highbit = fls(mwdma_mask) - 1;
3461 mwdma_mask &= ~(1 << highbit);
3462 if (!mwdma_mask)
3463 return -ENOENT;
3465 break;
3467 case ATA_DNXFER_40C:
3468 udma_mask &= ATA_UDMA_MASK_40C;
3469 break;
3471 case ATA_DNXFER_FORCE_PIO0:
3472 pio_mask &= 1;
3473 /* fall through */
3474 case ATA_DNXFER_FORCE_PIO:
3475 mwdma_mask = 0;
3476 udma_mask = 0;
3477 break;
3479 default:
3480 BUG();
3483 xfer_mask &= ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
3485 if (!(xfer_mask & ATA_MASK_PIO) || xfer_mask == orig_mask)
3486 return -ENOENT;
3488 if (!quiet) {
3489 if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
3490 snprintf(buf, sizeof(buf), "%s:%s",
3491 ata_mode_string(xfer_mask),
3492 ata_mode_string(xfer_mask & ATA_MASK_PIO));
3493 else
3494 snprintf(buf, sizeof(buf), "%s",
3495 ata_mode_string(xfer_mask));
3497 ata_dev_warn(dev, "limiting speed to %s\n", buf);
3500 ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
3501 &dev->udma_mask);
3503 return 0;
3506 static int ata_dev_set_mode(struct ata_device *dev)
3508 struct ata_port *ap = dev->link->ap;
3509 struct ata_eh_context *ehc = &dev->link->eh_context;
3510 const bool nosetxfer = dev->horkage & ATA_HORKAGE_NOSETXFER;
3511 const char *dev_err_whine = "";
3512 int ign_dev_err = 0;
3513 unsigned int err_mask = 0;
3514 int rc;
3516 dev->flags &= ~ATA_DFLAG_PIO;
3517 if (dev->xfer_shift == ATA_SHIFT_PIO)
3518 dev->flags |= ATA_DFLAG_PIO;
3520 if (nosetxfer && ap->flags & ATA_FLAG_SATA && ata_id_is_sata(dev->id))
3521 dev_err_whine = " (SET_XFERMODE skipped)";
3522 else {
3523 if (nosetxfer)
3524 ata_dev_warn(dev,
3525 "NOSETXFER but PATA detected - can't "
3526 "skip SETXFER, might malfunction\n");
3527 err_mask = ata_dev_set_xfermode(dev);
3530 if (err_mask & ~AC_ERR_DEV)
3531 goto fail;
3533 /* revalidate */
3534 ehc->i.flags |= ATA_EHI_POST_SETMODE;
3535 rc = ata_dev_revalidate(dev, ATA_DEV_UNKNOWN, 0);
3536 ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
3537 if (rc)
3538 return rc;
3540 if (dev->xfer_shift == ATA_SHIFT_PIO) {
3541 /* Old CFA may refuse this command, which is just fine */
3542 if (ata_id_is_cfa(dev->id))
3543 ign_dev_err = 1;
3544 /* Catch several broken garbage emulations plus some pre
3545 ATA devices */
3546 if (ata_id_major_version(dev->id) == 0 &&
3547 dev->pio_mode <= XFER_PIO_2)
3548 ign_dev_err = 1;
3549 /* Some very old devices and some bad newer ones fail
3550 any kind of SET_XFERMODE request but support PIO0-2
3551 timings and no IORDY */
3552 if (!ata_id_has_iordy(dev->id) && dev->pio_mode <= XFER_PIO_2)
3553 ign_dev_err = 1;
3555 /* Early MWDMA devices do DMA but don't allow DMA mode setting.
3556 Don't fail an MWDMA0 set IFF the device indicates it is in MWDMA0 */
3557 if (dev->xfer_shift == ATA_SHIFT_MWDMA &&
3558 dev->dma_mode == XFER_MW_DMA_0 &&
3559 (dev->id[63] >> 8) & 1)
3560 ign_dev_err = 1;
3562 /* if the device is actually configured correctly, ignore dev err */
3563 if (dev->xfer_mode == ata_xfer_mask2mode(ata_id_xfermask(dev->id)))
3564 ign_dev_err = 1;
3566 if (err_mask & AC_ERR_DEV) {
3567 if (!ign_dev_err)
3568 goto fail;
3569 else
3570 dev_err_whine = " (device error ignored)";
3573 DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
3574 dev->xfer_shift, (int)dev->xfer_mode);
3576 ata_dev_info(dev, "configured for %s%s\n",
3577 ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)),
3578 dev_err_whine);
3580 return 0;
3582 fail:
3583 ata_dev_err(dev, "failed to set xfermode (err_mask=0x%x)\n", err_mask);
3584 return -EIO;
3588 * ata_do_set_mode - Program timings and issue SET FEATURES - XFER
3589 * @link: link on which timings will be programmed
3590 * @r_failed_dev: out parameter for failed device
3592 * Standard implementation of the function used to tune and set
3593 * ATA device disk transfer mode (PIO3, UDMA6, etc.). If
3594 * ata_dev_set_mode() fails, pointer to the failing device is
3595 * returned in @r_failed_dev.
3597 * LOCKING:
3598 * PCI/etc. bus probe sem.
3600 * RETURNS:
3601 * 0 on success, negative errno otherwise
3604 int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
3606 struct ata_port *ap = link->ap;
3607 struct ata_device *dev;
3608 int rc = 0, used_dma = 0, found = 0;
3610 /* step 1: calculate xfer_mask */
3611 ata_for_each_dev(dev, link, ENABLED) {
3612 unsigned long pio_mask, dma_mask;
3613 unsigned int mode_mask;
3615 mode_mask = ATA_DMA_MASK_ATA;
3616 if (dev->class == ATA_DEV_ATAPI)
3617 mode_mask = ATA_DMA_MASK_ATAPI;
3618 else if (ata_id_is_cfa(dev->id))
3619 mode_mask = ATA_DMA_MASK_CFA;
3621 ata_dev_xfermask(dev);
3622 ata_force_xfermask(dev);
3624 pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);
3626 if (libata_dma_mask & mode_mask)
3627 dma_mask = ata_pack_xfermask(0, dev->mwdma_mask,
3628 dev->udma_mask);
3629 else
3630 dma_mask = 0;
3632 dev->pio_mode = ata_xfer_mask2mode(pio_mask);
3633 dev->dma_mode = ata_xfer_mask2mode(dma_mask);
3635 found = 1;
3636 if (ata_dma_enabled(dev))
3637 used_dma = 1;
3639 if (!found)
3640 goto out;
3642 /* step 2: always set host PIO timings */
3643 ata_for_each_dev(dev, link, ENABLED) {
3644 if (dev->pio_mode == 0xff) {
3645 ata_dev_warn(dev, "no PIO support\n");
3646 rc = -EINVAL;
3647 goto out;
3650 dev->xfer_mode = dev->pio_mode;
3651 dev->xfer_shift = ATA_SHIFT_PIO;
3652 if (ap->ops->set_piomode)
3653 ap->ops->set_piomode(ap, dev);
3656 /* step 3: set host DMA timings */
3657 ata_for_each_dev(dev, link, ENABLED) {
3658 if (!ata_dma_enabled(dev))
3659 continue;
3661 dev->xfer_mode = dev->dma_mode;
3662 dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
3663 if (ap->ops->set_dmamode)
3664 ap->ops->set_dmamode(ap, dev);
3667 /* step 4: update devices' xfer mode */
3668 ata_for_each_dev(dev, link, ENABLED) {
3669 rc = ata_dev_set_mode(dev);
3670 if (rc)
3671 goto out;
3674 /* Record simplex status. If we selected DMA then the other
3675 * host channels are not permitted to do so.
3677 if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
3678 ap->host->simplex_claimed = ap;
3680 out:
3681 if (rc)
3682 *r_failed_dev = dev;
3683 return rc;
3687 * ata_wait_ready - wait for link to become ready
3688 * @link: link to be waited on
3689 * @deadline: deadline jiffies for the operation
3690 * @check_ready: callback to check link readiness
3692 * Wait for @link to become ready. @check_ready should return
3693 * positive number if @link is ready, 0 if it isn't, -ENODEV if
3694 * link doesn't seem to be occupied, other errno for other error
3695 * conditions.
3697 * Transient -ENODEV conditions are allowed for
3698 * ATA_TMOUT_FF_WAIT.
3700 * LOCKING:
3701 * EH context.
3703 * RETURNS:
3704 * 0 if @link is ready before @deadline; otherwise, -errno.
3706 int ata_wait_ready(struct ata_link *link, unsigned long deadline,
3707 int (*check_ready)(struct ata_link *link))
3709 unsigned long start = jiffies;
3710 unsigned long nodev_deadline;
3711 int warned = 0;
3713 /* choose which 0xff timeout to use, read comment in libata.h */
3714 if (link->ap->host->flags & ATA_HOST_PARALLEL_SCAN)
3715 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT_LONG);
3716 else
3717 nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT);
3719 /* Slave readiness can't be tested separately from master. On
3720 * M/S emulation configuration, this function should be called
3721 * only on the master and it will handle both master and slave.
3723 WARN_ON(link == link->ap->slave_link);
3725 if (time_after(nodev_deadline, deadline))
3726 nodev_deadline = deadline;
3728 while (1) {
3729 unsigned long now = jiffies;
3730 int ready, tmp;
3732 ready = tmp = check_ready(link);
3733 if (ready > 0)
3734 return 0;
3737 * -ENODEV could be transient. Ignore -ENODEV if link
3738 * is online. Also, some SATA devices take a long
3739 * time to clear 0xff after reset. Wait for
3740 * ATA_TMOUT_FF_WAIT[_LONG] on -ENODEV if link isn't
3741 * offline.
3743 * Note that some PATA controllers (pata_ali) explode
3744 * if status register is read more than once when
3745 * there's no device attached.
3747 if (ready == -ENODEV) {
3748 if (ata_link_online(link))
3749 ready = 0;
3750 else if ((link->ap->flags & ATA_FLAG_SATA) &&
3751 !ata_link_offline(link) &&
3752 time_before(now, nodev_deadline))
3753 ready = 0;
3756 if (ready)
3757 return ready;
3758 if (time_after(now, deadline))
3759 return -EBUSY;
3761 if (!warned && time_after(now, start + 5 * HZ) &&
3762 (deadline - now > 3 * HZ)) {
3763 ata_link_warn(link,
3764 "link is slow to respond, please be patient "
3765 "(ready=%d)\n", tmp);
3766 warned = 1;
3769 ata_msleep(link->ap, 50);
3774 * ata_wait_after_reset - wait for link to become ready after reset
3775 * @link: link to be waited on
3776 * @deadline: deadline jiffies for the operation
3777 * @check_ready: callback to check link readiness
3779 * Wait for @link to become ready after reset.
3781 * LOCKING:
3782 * EH context.
3784 * RETURNS:
3785 * 0 if @link is ready before @deadline; otherwise, -errno.
3787 int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
3788 int (*check_ready)(struct ata_link *link))
3790 ata_msleep(link->ap, ATA_WAIT_AFTER_RESET);
3792 return ata_wait_ready(link, deadline, check_ready);
3796 * sata_link_debounce - debounce SATA phy status
3797 * @link: ATA link to debounce SATA phy status for
3798 * @params: timing parameters { interval, duration, timeout } in msec
3799 * @deadline: deadline jiffies for the operation
3801 * Make sure SStatus of @link reaches stable state, determined by
3802 * holding the same value where DET is not 1 for @duration polled
3803 * every @interval, before @timeout. Timeout constraints the
3804 * beginning of the stable state. Because DET gets stuck at 1 on
3805 * some controllers after hot unplugging, this functions waits
3806 * until timeout then returns 0 if DET is stable at 1.
3808 * @timeout is further limited by @deadline. The sooner of the
3809 * two is used.
3811 * LOCKING:
3812 * Kernel thread context (may sleep)
3814 * RETURNS:
3815 * 0 on success, -errno on failure.
3817 int sata_link_debounce(struct ata_link *link, const unsigned long *params,
3818 unsigned long deadline)
3820 unsigned long interval = params[0];
3821 unsigned long duration = params[1];
3822 unsigned long last_jiffies, t;
3823 u32 last, cur;
3824 int rc;
3826 t = ata_deadline(jiffies, params[2]);
3827 if (time_before(t, deadline))
3828 deadline = t;
3830 if ((rc = sata_scr_read(link, SCR_STATUS, &cur)))
3831 return rc;
3832 cur &= 0xf;
3834 last = cur;
3835 last_jiffies = jiffies;
3837 while (1) {
3838 ata_msleep(link->ap, interval);
3839 if ((rc = sata_scr_read(link, SCR_STATUS, &cur)))
3840 return rc;
3841 cur &= 0xf;
3843 /* DET stable? */
3844 if (cur == last) {
3845 if (cur == 1 && time_before(jiffies, deadline))
3846 continue;
3847 if (time_after(jiffies,
3848 ata_deadline(last_jiffies, duration)))
3849 return 0;
3850 continue;
3853 /* unstable, start over */
3854 last = cur;
3855 last_jiffies = jiffies;
3857 /* Check deadline. If debouncing failed, return
3858 * -EPIPE to tell upper layer to lower link speed.
3860 if (time_after(jiffies, deadline))
3861 return -EPIPE;
3866 * sata_link_resume - resume SATA link
3867 * @link: ATA link to resume SATA
3868 * @params: timing parameters { interval, duration, timeout } in msec
3869 * @deadline: deadline jiffies for the operation
3871 * Resume SATA phy @link and debounce it.
3873 * LOCKING:
3874 * Kernel thread context (may sleep)
3876 * RETURNS:
3877 * 0 on success, -errno on failure.
3879 int sata_link_resume(struct ata_link *link, const unsigned long *params,
3880 unsigned long deadline)
3882 int tries = ATA_LINK_RESUME_TRIES;
3883 u32 scontrol, serror;
3884 int rc;
3886 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3887 return rc;
3890 * Writes to SControl sometimes get ignored under certain
3891 * controllers (ata_piix SIDPR). Make sure DET actually is
3892 * cleared.
3894 do {
3895 scontrol = (scontrol & 0x0f0) | 0x300;
3896 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
3897 return rc;
3899 * Some PHYs react badly if SStatus is pounded
3900 * immediately after resuming. Delay 200ms before
3901 * debouncing.
3903 if (!(link->flags & ATA_LFLAG_NO_DB_DELAY))
3904 ata_msleep(link->ap, 200);
3906 /* is SControl restored correctly? */
3907 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
3908 return rc;
3909 } while ((scontrol & 0xf0f) != 0x300 && --tries);
3911 if ((scontrol & 0xf0f) != 0x300) {
3912 ata_link_warn(link, "failed to resume link (SControl %X)\n",
3913 scontrol);
3914 return 0;
3917 if (tries < ATA_LINK_RESUME_TRIES)
3918 ata_link_warn(link, "link resume succeeded after %d retries\n",
3919 ATA_LINK_RESUME_TRIES - tries);
3921 if ((rc = sata_link_debounce(link, params, deadline)))
3922 return rc;
3924 /* clear SError, some PHYs require this even for SRST to work */
3925 if (!(rc = sata_scr_read(link, SCR_ERROR, &serror)))
3926 rc = sata_scr_write(link, SCR_ERROR, serror);
3928 return rc != -EINVAL ? rc : 0;
3932 * sata_link_scr_lpm - manipulate SControl IPM and SPM fields
3933 * @link: ATA link to manipulate SControl for
3934 * @policy: LPM policy to configure
3935 * @spm_wakeup: initiate LPM transition to active state
3937 * Manipulate the IPM field of the SControl register of @link
3938 * according to @policy. If @policy is ATA_LPM_MAX_POWER and
3939 * @spm_wakeup is %true, the SPM field is manipulated to wake up
3940 * the link. This function also clears PHYRDY_CHG before
3941 * returning.
3943 * LOCKING:
3944 * EH context.
3946 * RETURNS:
3947 * 0 on success, -errno otherwise.
3949 int sata_link_scr_lpm(struct ata_link *link, enum ata_lpm_policy policy,
3950 bool spm_wakeup)
3952 struct ata_eh_context *ehc = &link->eh_context;
3953 bool woken_up = false;
3954 u32 scontrol;
3955 int rc;
3957 rc = sata_scr_read(link, SCR_CONTROL, &scontrol);
3958 if (rc)
3959 return rc;
3961 switch (policy) {
3962 case ATA_LPM_MAX_POWER:
3963 /* disable all LPM transitions */
3964 scontrol |= (0x7 << 8);
3965 /* initiate transition to active state */
3966 if (spm_wakeup) {
3967 scontrol |= (0x4 << 12);
3968 woken_up = true;
3970 break;
3971 case ATA_LPM_MED_POWER:
3972 /* allow LPM to PARTIAL */
3973 scontrol &= ~(0x1 << 8);
3974 scontrol |= (0x6 << 8);
3975 break;
3976 case ATA_LPM_MED_POWER_WITH_DIPM:
3977 case ATA_LPM_MIN_POWER:
3978 if (ata_link_nr_enabled(link) > 0)
3979 /* no restrictions on LPM transitions */
3980 scontrol &= ~(0x7 << 8);
3981 else {
3982 /* empty port, power off */
3983 scontrol &= ~0xf;
3984 scontrol |= (0x1 << 2);
3986 break;
3987 default:
3988 WARN_ON(1);
3991 rc = sata_scr_write(link, SCR_CONTROL, scontrol);
3992 if (rc)
3993 return rc;
3995 /* give the link time to transit out of LPM state */
3996 if (woken_up)
3997 msleep(10);
3999 /* clear PHYRDY_CHG from SError */
4000 ehc->i.serror &= ~SERR_PHYRDY_CHG;
4001 return sata_scr_write(link, SCR_ERROR, SERR_PHYRDY_CHG);
4005 * ata_std_prereset - prepare for reset
4006 * @link: ATA link to be reset
4007 * @deadline: deadline jiffies for the operation
4009 * @link is about to be reset. Initialize it. Failure from
4010 * prereset makes libata abort whole reset sequence and give up
4011 * that port, so prereset should be best-effort. It does its
4012 * best to prepare for reset sequence but if things go wrong, it
4013 * should just whine, not fail.
4015 * LOCKING:
4016 * Kernel thread context (may sleep)
4018 * RETURNS:
4019 * 0 on success, -errno otherwise.
4021 int ata_std_prereset(struct ata_link *link, unsigned long deadline)
4023 struct ata_port *ap = link->ap;
4024 struct ata_eh_context *ehc = &link->eh_context;
4025 const unsigned long *timing = sata_ehc_deb_timing(ehc);
4026 int rc;
4028 /* if we're about to do hardreset, nothing more to do */
4029 if (ehc->i.action & ATA_EH_HARDRESET)
4030 return 0;
4032 /* if SATA, resume link */
4033 if (ap->flags & ATA_FLAG_SATA) {
4034 rc = sata_link_resume(link, timing, deadline);
4035 /* whine about phy resume failure but proceed */
4036 if (rc && rc != -EOPNOTSUPP)
4037 ata_link_warn(link,
4038 "failed to resume link for reset (errno=%d)\n",
4039 rc);
4042 /* no point in trying softreset on offline link */
4043 if (ata_phys_link_offline(link))
4044 ehc->i.action &= ~ATA_EH_SOFTRESET;
4046 return 0;
4050 * sata_link_hardreset - reset link via SATA phy reset
4051 * @link: link to reset
4052 * @timing: timing parameters { interval, duration, timeout } in msec
4053 * @deadline: deadline jiffies for the operation
4054 * @online: optional out parameter indicating link onlineness
4055 * @check_ready: optional callback to check link readiness
4057 * SATA phy-reset @link using DET bits of SControl register.
4058 * After hardreset, link readiness is waited upon using
4059 * ata_wait_ready() if @check_ready is specified. LLDs are
4060 * allowed to not specify @check_ready and wait itself after this
4061 * function returns. Device classification is LLD's
4062 * responsibility.
4064 * *@online is set to one iff reset succeeded and @link is online
4065 * after reset.
4067 * LOCKING:
4068 * Kernel thread context (may sleep)
4070 * RETURNS:
4071 * 0 on success, -errno otherwise.
4073 int sata_link_hardreset(struct ata_link *link, const unsigned long *timing,
4074 unsigned long deadline,
4075 bool *online, int (*check_ready)(struct ata_link *))
4077 u32 scontrol;
4078 int rc;
4080 DPRINTK("ENTER\n");
4082 if (online)
4083 *online = false;
4085 if (sata_set_spd_needed(link)) {
4086 /* SATA spec says nothing about how to reconfigure
4087 * spd. To be on the safe side, turn off phy during
4088 * reconfiguration. This works for at least ICH7 AHCI
4089 * and Sil3124.
4091 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
4092 goto out;
4094 scontrol = (scontrol & 0x0f0) | 0x304;
4096 if ((rc = sata_scr_write(link, SCR_CONTROL, scontrol)))
4097 goto out;
4099 sata_set_spd(link);
4102 /* issue phy wake/reset */
4103 if ((rc = sata_scr_read(link, SCR_CONTROL, &scontrol)))
4104 goto out;
4106 scontrol = (scontrol & 0x0f0) | 0x301;
4108 if ((rc = sata_scr_write_flush(link, SCR_CONTROL, scontrol)))
4109 goto out;
4111 /* Couldn't find anything in SATA I/II specs, but AHCI-1.1
4112 * 10.4.2 says at least 1 ms.
4114 ata_msleep(link->ap, 1);
4116 /* bring link back */
4117 rc = sata_link_resume(link, timing, deadline);
4118 if (rc)
4119 goto out;
4120 /* if link is offline nothing more to do */
4121 if (ata_phys_link_offline(link))
4122 goto out;
4124 /* Link is online. From this point, -ENODEV too is an error. */
4125 if (online)
4126 *online = true;
4128 if (sata_pmp_supported(link->ap) && ata_is_host_link(link)) {
4129 /* If PMP is supported, we have to do follow-up SRST.
4130 * Some PMPs don't send D2H Reg FIS after hardreset if
4131 * the first port is empty. Wait only for
4132 * ATA_TMOUT_PMP_SRST_WAIT.
4134 if (check_ready) {
4135 unsigned long pmp_deadline;
4137 pmp_deadline = ata_deadline(jiffies,
4138 ATA_TMOUT_PMP_SRST_WAIT);
4139 if (time_after(pmp_deadline, deadline))
4140 pmp_deadline = deadline;
4141 ata_wait_ready(link, pmp_deadline, check_ready);
4143 rc = -EAGAIN;
4144 goto out;
4147 rc = 0;
4148 if (check_ready)
4149 rc = ata_wait_ready(link, deadline, check_ready);
4150 out:
4151 if (rc && rc != -EAGAIN) {
4152 /* online is set iff link is online && reset succeeded */
4153 if (online)
4154 *online = false;
4155 ata_link_err(link, "COMRESET failed (errno=%d)\n", rc);
4157 DPRINTK("EXIT, rc=%d\n", rc);
4158 return rc;
4162 * sata_std_hardreset - COMRESET w/o waiting or classification
4163 * @link: link to reset
4164 * @class: resulting class of attached device
4165 * @deadline: deadline jiffies for the operation
4167 * Standard SATA COMRESET w/o waiting or classification.
4169 * LOCKING:
4170 * Kernel thread context (may sleep)
4172 * RETURNS:
4173 * 0 if link offline, -EAGAIN if link online, -errno on errors.
4175 int sata_std_hardreset(struct ata_link *link, unsigned int *class,
4176 unsigned long deadline)
4178 const unsigned long *timing = sata_ehc_deb_timing(&link->eh_context);
4179 bool online;
4180 int rc;
4182 /* do hardreset */
4183 rc = sata_link_hardreset(link, timing, deadline, &online, NULL);
4184 return online ? -EAGAIN : rc;
4188 * ata_std_postreset - standard postreset callback
4189 * @link: the target ata_link
4190 * @classes: classes of attached devices
4192 * This function is invoked after a successful reset. Note that
4193 * the device might have been reset more than once using
4194 * different reset methods before postreset is invoked.
4196 * LOCKING:
4197 * Kernel thread context (may sleep)
4199 void ata_std_postreset(struct ata_link *link, unsigned int *classes)
4201 u32 serror;
4203 DPRINTK("ENTER\n");
4205 /* reset complete, clear SError */
4206 if (!sata_scr_read(link, SCR_ERROR, &serror))
4207 sata_scr_write(link, SCR_ERROR, serror);
4209 /* print link status */
4210 sata_print_link_status(link);
4212 DPRINTK("EXIT\n");
4216 * ata_dev_same_device - Determine whether new ID matches configured device
4217 * @dev: device to compare against
4218 * @new_class: class of the new device
4219 * @new_id: IDENTIFY page of the new device
4221 * Compare @new_class and @new_id against @dev and determine
4222 * whether @dev is the device indicated by @new_class and
4223 * @new_id.
4225 * LOCKING:
4226 * None.
4228 * RETURNS:
4229 * 1 if @dev matches @new_class and @new_id, 0 otherwise.
4231 static int ata_dev_same_device(struct ata_device *dev, unsigned int new_class,
4232 const u16 *new_id)
4234 const u16 *old_id = dev->id;
4235 unsigned char model[2][ATA_ID_PROD_LEN + 1];
4236 unsigned char serial[2][ATA_ID_SERNO_LEN + 1];
4238 if (dev->class != new_class) {
4239 ata_dev_info(dev, "class mismatch %d != %d\n",
4240 dev->class, new_class);
4241 return 0;
4244 ata_id_c_string(old_id, model[0], ATA_ID_PROD, sizeof(model[0]));
4245 ata_id_c_string(new_id, model[1], ATA_ID_PROD, sizeof(model[1]));
4246 ata_id_c_string(old_id, serial[0], ATA_ID_SERNO, sizeof(serial[0]));
4247 ata_id_c_string(new_id, serial[1], ATA_ID_SERNO, sizeof(serial[1]));
4249 if (strcmp(model[0], model[1])) {
4250 ata_dev_info(dev, "model number mismatch '%s' != '%s'\n",
4251 model[0], model[1]);
4252 return 0;
4255 if (strcmp(serial[0], serial[1])) {
4256 ata_dev_info(dev, "serial number mismatch '%s' != '%s'\n",
4257 serial[0], serial[1]);
4258 return 0;
4261 return 1;
4265 * ata_dev_reread_id - Re-read IDENTIFY data
4266 * @dev: target ATA device
4267 * @readid_flags: read ID flags
4269 * Re-read IDENTIFY page and make sure @dev is still attached to
4270 * the port.
4272 * LOCKING:
4273 * Kernel thread context (may sleep)
4275 * RETURNS:
4276 * 0 on success, negative errno otherwise
4278 int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags)
4280 unsigned int class = dev->class;
4281 u16 *id = (void *)dev->link->ap->sector_buf;
4282 int rc;
4284 /* read ID data */
4285 rc = ata_dev_read_id(dev, &class, readid_flags, id);
4286 if (rc)
4287 return rc;
4289 /* is the device still there? */
4290 if (!ata_dev_same_device(dev, class, id))
4291 return -ENODEV;
4293 memcpy(dev->id, id, sizeof(id[0]) * ATA_ID_WORDS);
4294 return 0;
4298 * ata_dev_revalidate - Revalidate ATA device
4299 * @dev: device to revalidate
4300 * @new_class: new class code
4301 * @readid_flags: read ID flags
4303 * Re-read IDENTIFY page, make sure @dev is still attached to the
4304 * port and reconfigure it according to the new IDENTIFY page.
4306 * LOCKING:
4307 * Kernel thread context (may sleep)
4309 * RETURNS:
4310 * 0 on success, negative errno otherwise
4312 int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
4313 unsigned int readid_flags)
4315 u64 n_sectors = dev->n_sectors;
4316 u64 n_native_sectors = dev->n_native_sectors;
4317 int rc;
4319 if (!ata_dev_enabled(dev))
4320 return -ENODEV;
4322 /* fail early if !ATA && !ATAPI to avoid issuing [P]IDENTIFY to PMP */
4323 if (ata_class_enabled(new_class) &&
4324 new_class != ATA_DEV_ATA &&
4325 new_class != ATA_DEV_ATAPI &&
4326 new_class != ATA_DEV_ZAC &&
4327 new_class != ATA_DEV_SEMB) {
4328 ata_dev_info(dev, "class mismatch %u != %u\n",
4329 dev->class, new_class);
4330 rc = -ENODEV;
4331 goto fail;
4334 /* re-read ID */
4335 rc = ata_dev_reread_id(dev, readid_flags);
4336 if (rc)
4337 goto fail;
4339 /* configure device according to the new ID */
4340 rc = ata_dev_configure(dev);
4341 if (rc)
4342 goto fail;
4344 /* verify n_sectors hasn't changed */
4345 if (dev->class != ATA_DEV_ATA || !n_sectors ||
4346 dev->n_sectors == n_sectors)
4347 return 0;
4349 /* n_sectors has changed */
4350 ata_dev_warn(dev, "n_sectors mismatch %llu != %llu\n",
4351 (unsigned long long)n_sectors,
4352 (unsigned long long)dev->n_sectors);
4355 * Something could have caused HPA to be unlocked
4356 * involuntarily. If n_native_sectors hasn't changed and the
4357 * new size matches it, keep the device.
4359 if (dev->n_native_sectors == n_native_sectors &&
4360 dev->n_sectors > n_sectors && dev->n_sectors == n_native_sectors) {
4361 ata_dev_warn(dev,
4362 "new n_sectors matches native, probably "
4363 "late HPA unlock, n_sectors updated\n");
4364 /* use the larger n_sectors */
4365 return 0;
4369 * Some BIOSes boot w/o HPA but resume w/ HPA locked. Try
4370 * unlocking HPA in those cases.
4372 * https://bugzilla.kernel.org/show_bug.cgi?id=15396
4374 if (dev->n_native_sectors == n_native_sectors &&
4375 dev->n_sectors < n_sectors && n_sectors == n_native_sectors &&
4376 !(dev->horkage & ATA_HORKAGE_BROKEN_HPA)) {
4377 ata_dev_warn(dev,
4378 "old n_sectors matches native, probably "
4379 "late HPA lock, will try to unlock HPA\n");
4380 /* try unlocking HPA */
4381 dev->flags |= ATA_DFLAG_UNLOCK_HPA;
4382 rc = -EIO;
4383 } else
4384 rc = -ENODEV;
4386 /* restore original n_[native_]sectors and fail */
4387 dev->n_native_sectors = n_native_sectors;
4388 dev->n_sectors = n_sectors;
4389 fail:
4390 ata_dev_err(dev, "revalidation failed (errno=%d)\n", rc);
4391 return rc;
4394 struct ata_blacklist_entry {
4395 const char *model_num;
4396 const char *model_rev;
4397 unsigned long horkage;
4400 static const struct ata_blacklist_entry ata_device_blacklist [] = {
4401 /* Devices with DMA related problems under Linux */
4402 { "WDC AC11000H", NULL, ATA_HORKAGE_NODMA },
4403 { "WDC AC22100H", NULL, ATA_HORKAGE_NODMA },
4404 { "WDC AC32500H", NULL, ATA_HORKAGE_NODMA },
4405 { "WDC AC33100H", NULL, ATA_HORKAGE_NODMA },
4406 { "WDC AC31600H", NULL, ATA_HORKAGE_NODMA },
4407 { "WDC AC32100H", "24.09P07", ATA_HORKAGE_NODMA },
4408 { "WDC AC23200L", "21.10N21", ATA_HORKAGE_NODMA },
4409 { "Compaq CRD-8241B", NULL, ATA_HORKAGE_NODMA },
4410 { "CRD-8400B", NULL, ATA_HORKAGE_NODMA },
4411 { "CRD-848[02]B", NULL, ATA_HORKAGE_NODMA },
4412 { "CRD-84", NULL, ATA_HORKAGE_NODMA },
4413 { "SanDisk SDP3B", NULL, ATA_HORKAGE_NODMA },
4414 { "SanDisk SDP3B-64", NULL, ATA_HORKAGE_NODMA },
4415 { "SANYO CD-ROM CRD", NULL, ATA_HORKAGE_NODMA },
4416 { "HITACHI CDR-8", NULL, ATA_HORKAGE_NODMA },
4417 { "HITACHI CDR-8[34]35",NULL, ATA_HORKAGE_NODMA },
4418 { "Toshiba CD-ROM XM-6202B", NULL, ATA_HORKAGE_NODMA },
4419 { "TOSHIBA CD-ROM XM-1702BC", NULL, ATA_HORKAGE_NODMA },
4420 { "CD-532E-A", NULL, ATA_HORKAGE_NODMA },
4421 { "E-IDE CD-ROM CR-840",NULL, ATA_HORKAGE_NODMA },
4422 { "CD-ROM Drive/F5A", NULL, ATA_HORKAGE_NODMA },
4423 { "WPI CDD-820", NULL, ATA_HORKAGE_NODMA },
4424 { "SAMSUNG CD-ROM SC-148C", NULL, ATA_HORKAGE_NODMA },
4425 { "SAMSUNG CD-ROM SC", NULL, ATA_HORKAGE_NODMA },
4426 { "ATAPI CD-ROM DRIVE 40X MAXIMUM",NULL,ATA_HORKAGE_NODMA },
4427 { "_NEC DV5800A", NULL, ATA_HORKAGE_NODMA },
4428 { "SAMSUNG CD-ROM SN-124", "N001", ATA_HORKAGE_NODMA },
4429 { "Seagate STT20000A", NULL, ATA_HORKAGE_NODMA },
4430 { " 2GB ATA Flash Disk", "ADMA428M", ATA_HORKAGE_NODMA },
4431 { "VRFDFC22048UCHC-TE*", NULL, ATA_HORKAGE_NODMA },
4432 /* Odd clown on sil3726/4726 PMPs */
4433 { "Config Disk", NULL, ATA_HORKAGE_DISABLE },
4435 /* Weird ATAPI devices */
4436 { "TORiSAN DVD-ROM DRD-N216", NULL, ATA_HORKAGE_MAX_SEC_128 },
4437 { "QUANTUM DAT DAT72-000", NULL, ATA_HORKAGE_ATAPI_MOD16_DMA },
4438 { "Slimtype DVD A DS8A8SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
4439 { "Slimtype DVD A DS8A9SH", NULL, ATA_HORKAGE_MAX_SEC_LBA48 },
4442 * Causes silent data corruption with higher max sects.
4443 * http://lkml.kernel.org/g/x49wpy40ysk.fsf@segfault.boston.devel.redhat.com
4445 { "ST380013AS", "3.20", ATA_HORKAGE_MAX_SEC_1024 },
4448 * These devices time out with higher max sects.
4449 * https://bugzilla.kernel.org/show_bug.cgi?id=121671
4451 { "LITEON CX1-JB*-HP", NULL, ATA_HORKAGE_MAX_SEC_1024 },
4453 /* Devices we expect to fail diagnostics */
4455 /* Devices where NCQ should be avoided */
4456 /* NCQ is slow */
4457 { "WDC WD740ADFD-00", NULL, ATA_HORKAGE_NONCQ },
4458 { "WDC WD740ADFD-00NLR1", NULL, ATA_HORKAGE_NONCQ, },
4459 /* http://thread.gmane.org/gmane.linux.ide/14907 */
4460 { "FUJITSU MHT2060BH", NULL, ATA_HORKAGE_NONCQ },
4461 /* NCQ is broken */
4462 { "Maxtor *", "BANC*", ATA_HORKAGE_NONCQ },
4463 { "Maxtor 7V300F0", "VA111630", ATA_HORKAGE_NONCQ },
4464 { "ST380817AS", "3.42", ATA_HORKAGE_NONCQ },
4465 { "ST3160023AS", "3.42", ATA_HORKAGE_NONCQ },
4466 { "OCZ CORE_SSD", "02.10104", ATA_HORKAGE_NONCQ },
4468 /* Seagate NCQ + FLUSH CACHE firmware bug */
4469 { "ST31500341AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4470 ATA_HORKAGE_FIRMWARE_WARN },
4472 { "ST31000333AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4473 ATA_HORKAGE_FIRMWARE_WARN },
4475 { "ST3640[36]23AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4476 ATA_HORKAGE_FIRMWARE_WARN },
4478 { "ST3320[68]13AS", "SD1[5-9]", ATA_HORKAGE_NONCQ |
4479 ATA_HORKAGE_FIRMWARE_WARN },
4481 /* drives which fail FPDMA_AA activation (some may freeze afterwards) */
4482 { "ST1000LM024 HN-M101MBB", "2AR10001", ATA_HORKAGE_BROKEN_FPDMA_AA },
4483 { "ST1000LM024 HN-M101MBB", "2BA30001", ATA_HORKAGE_BROKEN_FPDMA_AA },
4484 { "VB0250EAVER", "HPG7", ATA_HORKAGE_BROKEN_FPDMA_AA },
4486 /* Blacklist entries taken from Silicon Image 3124/3132
4487 Windows driver .inf file - also several Linux problem reports */
4488 { "HTS541060G9SA00", "MB3OC60D", ATA_HORKAGE_NONCQ, },
4489 { "HTS541080G9SA00", "MB4OC60D", ATA_HORKAGE_NONCQ, },
4490 { "HTS541010G9SA00", "MBZOC60D", ATA_HORKAGE_NONCQ, },
4492 /* https://bugzilla.kernel.org/show_bug.cgi?id=15573 */
4493 { "C300-CTFDDAC128MAG", "0001", ATA_HORKAGE_NONCQ, },
4495 /* devices which puke on READ_NATIVE_MAX */
4496 { "HDS724040KLSA80", "KFAOA20N", ATA_HORKAGE_BROKEN_HPA, },
4497 { "WDC WD3200JD-00KLB0", "WD-WCAMR1130137", ATA_HORKAGE_BROKEN_HPA },
4498 { "WDC WD2500JD-00HBB0", "WD-WMAL71490727", ATA_HORKAGE_BROKEN_HPA },
4499 { "MAXTOR 6L080L4", "A93.0500", ATA_HORKAGE_BROKEN_HPA },
4501 /* this one allows HPA unlocking but fails IOs on the area */
4502 { "OCZ-VERTEX", "1.30", ATA_HORKAGE_BROKEN_HPA },
4504 /* Devices which report 1 sector over size HPA */
4505 { "ST340823A", NULL, ATA_HORKAGE_HPA_SIZE, },
4506 { "ST320413A", NULL, ATA_HORKAGE_HPA_SIZE, },
4507 { "ST310211A", NULL, ATA_HORKAGE_HPA_SIZE, },
4509 /* Devices which get the IVB wrong */
4510 { "QUANTUM FIREBALLlct10 05", "A03.0900", ATA_HORKAGE_IVB, },
4511 /* Maybe we should just blacklist TSSTcorp... */
4512 { "TSSTcorp CDDVDW SH-S202[HJN]", "SB0[01]", ATA_HORKAGE_IVB, },
4514 /* Devices that do not need bridging limits applied */
4515 { "MTRON MSP-SATA*", NULL, ATA_HORKAGE_BRIDGE_OK, },
4516 { "BUFFALO HD-QSU2/R5", NULL, ATA_HORKAGE_BRIDGE_OK, },
4518 /* Devices which aren't very happy with higher link speeds */
4519 { "WD My Book", NULL, ATA_HORKAGE_1_5_GBPS, },
4520 { "Seagate FreeAgent GoFlex", NULL, ATA_HORKAGE_1_5_GBPS, },
4523 * Devices which choke on SETXFER. Applies only if both the
4524 * device and controller are SATA.
4526 { "PIONEER DVD-RW DVRTD08", NULL, ATA_HORKAGE_NOSETXFER },
4527 { "PIONEER DVD-RW DVRTD08A", NULL, ATA_HORKAGE_NOSETXFER },
4528 { "PIONEER DVD-RW DVR-215", NULL, ATA_HORKAGE_NOSETXFER },
4529 { "PIONEER DVD-RW DVR-212D", NULL, ATA_HORKAGE_NOSETXFER },
4530 { "PIONEER DVD-RW DVR-216D", NULL, ATA_HORKAGE_NOSETXFER },
4532 /* devices that don't properly handle queued TRIM commands */
4533 { "Micron_M500_*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4534 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4535 { "Crucial_CT*M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4536 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4537 { "Micron_M5[15]0_*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
4538 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4539 { "Crucial_CT*M550*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
4540 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4541 { "Crucial_CT*MX100*", "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
4542 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4543 { "Samsung SSD 8*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4544 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4545 { "FCCT*M500*", NULL, ATA_HORKAGE_NO_NCQ_TRIM |
4546 ATA_HORKAGE_ZERO_AFTER_TRIM, },
4548 /* devices that don't properly handle TRIM commands */
4549 { "SuperSSpeed S238*", NULL, ATA_HORKAGE_NOTRIM, },
4552 * As defined, the DRAT (Deterministic Read After Trim) and RZAT
4553 * (Return Zero After Trim) flags in the ATA Command Set are
4554 * unreliable in the sense that they only define what happens if
4555 * the device successfully executed the DSM TRIM command. TRIM
4556 * is only advisory, however, and the device is free to silently
4557 * ignore all or parts of the request.
4559 * Whitelist drives that are known to reliably return zeroes
4560 * after TRIM.
4564 * The intel 510 drive has buggy DRAT/RZAT. Explicitly exclude
4565 * that model before whitelisting all other intel SSDs.
4567 { "INTEL*SSDSC2MH*", NULL, 0, },
4569 { "Micron*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4570 { "Crucial*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4571 { "INTEL*SSD*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4572 { "SSD*INTEL*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4573 { "Samsung*SSD*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4574 { "SAMSUNG*SSD*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4575 { "ST[1248][0248]0[FH]*", NULL, ATA_HORKAGE_ZERO_AFTER_TRIM, },
4578 * Some WD SATA-I drives spin up and down erratically when the link
4579 * is put into the slumber mode. We don't have full list of the
4580 * affected devices. Disable LPM if the device matches one of the
4581 * known prefixes and is SATA-1. As a side effect LPM partial is
4582 * lost too.
4584 * https://bugzilla.kernel.org/show_bug.cgi?id=57211
4586 { "WDC WD800JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4587 { "WDC WD1200JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4588 { "WDC WD1600JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4589 { "WDC WD2000JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4590 { "WDC WD2500JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4591 { "WDC WD3000JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4592 { "WDC WD3200JD-*", NULL, ATA_HORKAGE_WD_BROKEN_LPM },
4594 /* End Marker */
4598 static unsigned long ata_dev_blacklisted(const struct ata_device *dev)
4600 unsigned char model_num[ATA_ID_PROD_LEN + 1];
4601 unsigned char model_rev[ATA_ID_FW_REV_LEN + 1];
4602 const struct ata_blacklist_entry *ad = ata_device_blacklist;
4604 ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
4605 ata_id_c_string(dev->id, model_rev, ATA_ID_FW_REV, sizeof(model_rev));
4607 while (ad->model_num) {
4608 if (glob_match(ad->model_num, model_num)) {
4609 if (ad->model_rev == NULL)
4610 return ad->horkage;
4611 if (glob_match(ad->model_rev, model_rev))
4612 return ad->horkage;
4614 ad++;
4616 return 0;
4619 static int ata_dma_blacklisted(const struct ata_device *dev)
4621 /* We don't support polling DMA.
4622 * DMA blacklist those ATAPI devices with CDB-intr (and use PIO)
4623 * if the LLDD handles only interrupts in the HSM_ST_LAST state.
4625 if ((dev->link->ap->flags & ATA_FLAG_PIO_POLLING) &&
4626 (dev->flags & ATA_DFLAG_CDB_INTR))
4627 return 1;
4628 return (dev->horkage & ATA_HORKAGE_NODMA) ? 1 : 0;
4632 * ata_is_40wire - check drive side detection
4633 * @dev: device
4635 * Perform drive side detection decoding, allowing for device vendors
4636 * who can't follow the documentation.
4639 static int ata_is_40wire(struct ata_device *dev)
4641 if (dev->horkage & ATA_HORKAGE_IVB)
4642 return ata_drive_40wire_relaxed(dev->id);
4643 return ata_drive_40wire(dev->id);
4647 * cable_is_40wire - 40/80/SATA decider
4648 * @ap: port to consider
4650 * This function encapsulates the policy for speed management
4651 * in one place. At the moment we don't cache the result but
4652 * there is a good case for setting ap->cbl to the result when
4653 * we are called with unknown cables (and figuring out if it
4654 * impacts hotplug at all).
4656 * Return 1 if the cable appears to be 40 wire.
4659 static int cable_is_40wire(struct ata_port *ap)
4661 struct ata_link *link;
4662 struct ata_device *dev;
4664 /* If the controller thinks we are 40 wire, we are. */
4665 if (ap->cbl == ATA_CBL_PATA40)
4666 return 1;
4668 /* If the controller thinks we are 80 wire, we are. */
4669 if (ap->cbl == ATA_CBL_PATA80 || ap->cbl == ATA_CBL_SATA)
4670 return 0;
4672 /* If the system is known to be 40 wire short cable (eg
4673 * laptop), then we allow 80 wire modes even if the drive
4674 * isn't sure.
4676 if (ap->cbl == ATA_CBL_PATA40_SHORT)
4677 return 0;
4679 /* If the controller doesn't know, we scan.
4681 * Note: We look for all 40 wire detects at this point. Any
4682 * 80 wire detect is taken to be 80 wire cable because
4683 * - in many setups only the one drive (slave if present) will
4684 * give a valid detect
4685 * - if you have a non detect capable drive you don't want it
4686 * to colour the choice
4688 ata_for_each_link(link, ap, EDGE) {
4689 ata_for_each_dev(dev, link, ENABLED) {
4690 if (!ata_is_40wire(dev))
4691 return 0;
4694 return 1;
4698 * ata_dev_xfermask - Compute supported xfermask of the given device
4699 * @dev: Device to compute xfermask for
4701 * Compute supported xfermask of @dev and store it in
4702 * dev->*_mask. This function is responsible for applying all
4703 * known limits including host controller limits, device
4704 * blacklist, etc...
4706 * LOCKING:
4707 * None.
4709 static void ata_dev_xfermask(struct ata_device *dev)
4711 struct ata_link *link = dev->link;
4712 struct ata_port *ap = link->ap;
4713 struct ata_host *host = ap->host;
4714 unsigned long xfer_mask;
4716 /* controller modes available */
4717 xfer_mask = ata_pack_xfermask(ap->pio_mask,
4718 ap->mwdma_mask, ap->udma_mask);
4720 /* drive modes available */
4721 xfer_mask &= ata_pack_xfermask(dev->pio_mask,
4722 dev->mwdma_mask, dev->udma_mask);
4723 xfer_mask &= ata_id_xfermask(dev->id);
4726 * CFA Advanced TrueIDE timings are not allowed on a shared
4727 * cable
4729 if (ata_dev_pair(dev)) {
4730 /* No PIO5 or PIO6 */
4731 xfer_mask &= ~(0x03 << (ATA_SHIFT_PIO + 5));
4732 /* No MWDMA3 or MWDMA 4 */
4733 xfer_mask &= ~(0x03 << (ATA_SHIFT_MWDMA + 3));
4736 if (ata_dma_blacklisted(dev)) {
4737 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
4738 ata_dev_warn(dev,
4739 "device is on DMA blacklist, disabling DMA\n");
4742 if ((host->flags & ATA_HOST_SIMPLEX) &&
4743 host->simplex_claimed && host->simplex_claimed != ap) {
4744 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
4745 ata_dev_warn(dev,
4746 "simplex DMA is claimed by other device, disabling DMA\n");
4749 if (ap->flags & ATA_FLAG_NO_IORDY)
4750 xfer_mask &= ata_pio_mask_no_iordy(dev);
4752 if (ap->ops->mode_filter)
4753 xfer_mask = ap->ops->mode_filter(dev, xfer_mask);
4755 /* Apply cable rule here. Don't apply it early because when
4756 * we handle hot plug the cable type can itself change.
4757 * Check this last so that we know if the transfer rate was
4758 * solely limited by the cable.
4759 * Unknown or 80 wire cables reported host side are checked
4760 * drive side as well. Cases where we know a 40wire cable
4761 * is used safely for 80 are not checked here.
4763 if (xfer_mask & (0xF8 << ATA_SHIFT_UDMA))
4764 /* UDMA/44 or higher would be available */
4765 if (cable_is_40wire(ap)) {
4766 ata_dev_warn(dev,
4767 "limited to UDMA/33 due to 40-wire cable\n");
4768 xfer_mask &= ~(0xF8 << ATA_SHIFT_UDMA);
4771 ata_unpack_xfermask(xfer_mask, &dev->pio_mask,
4772 &dev->mwdma_mask, &dev->udma_mask);
4776 * ata_dev_set_xfermode - Issue SET FEATURES - XFER MODE command
4777 * @dev: Device to which command will be sent
4779 * Issue SET FEATURES - XFER MODE command to device @dev
4780 * on port @ap.
4782 * LOCKING:
4783 * PCI/etc. bus probe sem.
4785 * RETURNS:
4786 * 0 on success, AC_ERR_* mask otherwise.
4789 static unsigned int ata_dev_set_xfermode(struct ata_device *dev)
4791 struct ata_taskfile tf;
4792 unsigned int err_mask;
4794 /* set up set-features taskfile */
4795 DPRINTK("set features - xfer mode\n");
4797 /* Some controllers and ATAPI devices show flaky interrupt
4798 * behavior after setting xfer mode. Use polling instead.
4800 ata_tf_init(dev, &tf);
4801 tf.command = ATA_CMD_SET_FEATURES;
4802 tf.feature = SETFEATURES_XFER;
4803 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_POLLING;
4804 tf.protocol = ATA_PROT_NODATA;
4805 /* If we are using IORDY we must send the mode setting command */
4806 if (ata_pio_need_iordy(dev))
4807 tf.nsect = dev->xfer_mode;
4808 /* If the device has IORDY and the controller does not - turn it off */
4809 else if (ata_id_has_iordy(dev->id))
4810 tf.nsect = 0x01;
4811 else /* In the ancient relic department - skip all of this */
4812 return 0;
4814 /* On some disks, this command causes spin-up, so we need longer timeout */
4815 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 15000);
4817 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4818 return err_mask;
4822 * ata_dev_set_feature - Issue SET FEATURES - SATA FEATURES
4823 * @dev: Device to which command will be sent
4824 * @enable: Whether to enable or disable the feature
4825 * @feature: The sector count represents the feature to set
4827 * Issue SET FEATURES - SATA FEATURES command to device @dev
4828 * on port @ap with sector count
4830 * LOCKING:
4831 * PCI/etc. bus probe sem.
4833 * RETURNS:
4834 * 0 on success, AC_ERR_* mask otherwise.
4836 unsigned int ata_dev_set_feature(struct ata_device *dev, u8 enable, u8 feature)
4838 struct ata_taskfile tf;
4839 unsigned int err_mask;
4840 unsigned long timeout = 0;
4842 /* set up set-features taskfile */
4843 DPRINTK("set features - SATA features\n");
4845 ata_tf_init(dev, &tf);
4846 tf.command = ATA_CMD_SET_FEATURES;
4847 tf.feature = enable;
4848 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4849 tf.protocol = ATA_PROT_NODATA;
4850 tf.nsect = feature;
4852 if (enable == SETFEATURES_SPINUP)
4853 timeout = ata_probe_timeout ?
4854 ata_probe_timeout * 1000 : SETFEATURES_SPINUP_TIMEOUT;
4855 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, timeout);
4857 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4858 return err_mask;
4860 EXPORT_SYMBOL_GPL(ata_dev_set_feature);
4863 * ata_dev_init_params - Issue INIT DEV PARAMS command
4864 * @dev: Device to which command will be sent
4865 * @heads: Number of heads (taskfile parameter)
4866 * @sectors: Number of sectors (taskfile parameter)
4868 * LOCKING:
4869 * Kernel thread context (may sleep)
4871 * RETURNS:
4872 * 0 on success, AC_ERR_* mask otherwise.
4874 static unsigned int ata_dev_init_params(struct ata_device *dev,
4875 u16 heads, u16 sectors)
4877 struct ata_taskfile tf;
4878 unsigned int err_mask;
4880 /* Number of sectors per track 1-255. Number of heads 1-16 */
4881 if (sectors < 1 || sectors > 255 || heads < 1 || heads > 16)
4882 return AC_ERR_INVALID;
4884 /* set up init dev params taskfile */
4885 DPRINTK("init dev params \n");
4887 ata_tf_init(dev, &tf);
4888 tf.command = ATA_CMD_INIT_DEV_PARAMS;
4889 tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
4890 tf.protocol = ATA_PROT_NODATA;
4891 tf.nsect = sectors;
4892 tf.device |= (heads - 1) & 0x0f; /* max head = num. of heads - 1 */
4894 err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
4895 /* A clean abort indicates an original or just out of spec drive
4896 and we should continue as we issue the setup based on the
4897 drive reported working geometry */
4898 if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
4899 err_mask = 0;
4901 DPRINTK("EXIT, err_mask=%x\n", err_mask);
4902 return err_mask;
4906 * atapi_check_dma - Check whether ATAPI DMA can be supported
4907 * @qc: Metadata associated with taskfile to check
4909 * Allow low-level driver to filter ATA PACKET commands, returning
4910 * a status indicating whether or not it is OK to use DMA for the
4911 * supplied PACKET command.
4913 * LOCKING:
4914 * spin_lock_irqsave(host lock)
4916 * RETURNS: 0 when ATAPI DMA can be used
4917 * nonzero otherwise
4919 int atapi_check_dma(struct ata_queued_cmd *qc)
4921 struct ata_port *ap = qc->ap;
4923 /* Don't allow DMA if it isn't multiple of 16 bytes. Quite a
4924 * few ATAPI devices choke on such DMA requests.
4926 if (!(qc->dev->horkage & ATA_HORKAGE_ATAPI_MOD16_DMA) &&
4927 unlikely(qc->nbytes & 15))
4928 return 1;
4930 if (ap->ops->check_atapi_dma)
4931 return ap->ops->check_atapi_dma(qc);
4933 return 0;
4937 * ata_std_qc_defer - Check whether a qc needs to be deferred
4938 * @qc: ATA command in question
4940 * Non-NCQ commands cannot run with any other command, NCQ or
4941 * not. As upper layer only knows the queue depth, we are
4942 * responsible for maintaining exclusion. This function checks
4943 * whether a new command @qc can be issued.
4945 * LOCKING:
4946 * spin_lock_irqsave(host lock)
4948 * RETURNS:
4949 * ATA_DEFER_* if deferring is needed, 0 otherwise.
4951 int ata_std_qc_defer(struct ata_queued_cmd *qc)
4953 struct ata_link *link = qc->dev->link;
4955 if (ata_is_ncq(qc->tf.protocol)) {
4956 if (!ata_tag_valid(link->active_tag))
4957 return 0;
4958 } else {
4959 if (!ata_tag_valid(link->active_tag) && !link->sactive)
4960 return 0;
4963 return ATA_DEFER_LINK;
4966 void ata_noop_qc_prep(struct ata_queued_cmd *qc) { }
4969 * ata_sg_init - Associate command with scatter-gather table.
4970 * @qc: Command to be associated
4971 * @sg: Scatter-gather table.
4972 * @n_elem: Number of elements in s/g table.
4974 * Initialize the data-related elements of queued_cmd @qc
4975 * to point to a scatter-gather table @sg, containing @n_elem
4976 * elements.
4978 * LOCKING:
4979 * spin_lock_irqsave(host lock)
4981 void ata_sg_init(struct ata_queued_cmd *qc, struct scatterlist *sg,
4982 unsigned int n_elem)
4984 qc->sg = sg;
4985 qc->n_elem = n_elem;
4986 qc->cursg = qc->sg;
4989 #ifdef CONFIG_HAS_DMA
4992 * ata_sg_clean - Unmap DMA memory associated with command
4993 * @qc: Command containing DMA memory to be released
4995 * Unmap all mapped DMA memory associated with this command.
4997 * LOCKING:
4998 * spin_lock_irqsave(host lock)
5000 static void ata_sg_clean(struct ata_queued_cmd *qc)
5002 struct ata_port *ap = qc->ap;
5003 struct scatterlist *sg = qc->sg;
5004 int dir = qc->dma_dir;
5006 WARN_ON_ONCE(sg == NULL);
5008 VPRINTK("unmapping %u sg elements\n", qc->n_elem);
5010 if (qc->n_elem)
5011 dma_unmap_sg(ap->dev, sg, qc->orig_n_elem, dir);
5013 qc->flags &= ~ATA_QCFLAG_DMAMAP;
5014 qc->sg = NULL;
5018 * ata_sg_setup - DMA-map the scatter-gather table associated with a command.
5019 * @qc: Command with scatter-gather table to be mapped.
5021 * DMA-map the scatter-gather table associated with queued_cmd @qc.
5023 * LOCKING:
5024 * spin_lock_irqsave(host lock)
5026 * RETURNS:
5027 * Zero on success, negative on error.
5030 static int ata_sg_setup(struct ata_queued_cmd *qc)
5032 struct ata_port *ap = qc->ap;
5033 unsigned int n_elem;
5035 VPRINTK("ENTER, ata%u\n", ap->print_id);
5037 n_elem = dma_map_sg(ap->dev, qc->sg, qc->n_elem, qc->dma_dir);
5038 if (n_elem < 1)
5039 return -1;
5041 DPRINTK("%d sg elements mapped\n", n_elem);
5042 qc->orig_n_elem = qc->n_elem;
5043 qc->n_elem = n_elem;
5044 qc->flags |= ATA_QCFLAG_DMAMAP;
5046 return 0;
5049 #else /* !CONFIG_HAS_DMA */
5051 static inline void ata_sg_clean(struct ata_queued_cmd *qc) {}
5052 static inline int ata_sg_setup(struct ata_queued_cmd *qc) { return -1; }
5054 #endif /* !CONFIG_HAS_DMA */
5057 * swap_buf_le16 - swap halves of 16-bit words in place
5058 * @buf: Buffer to swap
5059 * @buf_words: Number of 16-bit words in buffer.
5061 * Swap halves of 16-bit words if needed to convert from
5062 * little-endian byte order to native cpu byte order, or
5063 * vice-versa.
5065 * LOCKING:
5066 * Inherited from caller.
5068 void swap_buf_le16(u16 *buf, unsigned int buf_words)
5070 #ifdef __BIG_ENDIAN
5071 unsigned int i;
5073 for (i = 0; i < buf_words; i++)
5074 buf[i] = le16_to_cpu(buf[i]);
5075 #endif /* __BIG_ENDIAN */
5079 * ata_qc_new_init - Request an available ATA command, and initialize it
5080 * @dev: Device from whom we request an available command structure
5081 * @tag: tag
5083 * LOCKING:
5084 * None.
5087 struct ata_queued_cmd *ata_qc_new_init(struct ata_device *dev, int tag)
5089 struct ata_port *ap = dev->link->ap;
5090 struct ata_queued_cmd *qc;
5092 /* no command while frozen */
5093 if (unlikely(ap->pflags & ATA_PFLAG_FROZEN))
5094 return NULL;
5096 /* libsas case */
5097 if (ap->flags & ATA_FLAG_SAS_HOST) {
5098 tag = ata_sas_allocate_tag(ap);
5099 if (tag < 0)
5100 return NULL;
5103 qc = __ata_qc_from_tag(ap, tag);
5104 qc->tag = tag;
5105 qc->scsicmd = NULL;
5106 qc->ap = ap;
5107 qc->dev = dev;
5109 ata_qc_reinit(qc);
5111 return qc;
5115 * ata_qc_free - free unused ata_queued_cmd
5116 * @qc: Command to complete
5118 * Designed to free unused ata_queued_cmd object
5119 * in case something prevents using it.
5121 * LOCKING:
5122 * spin_lock_irqsave(host lock)
5124 void ata_qc_free(struct ata_queued_cmd *qc)
5126 struct ata_port *ap;
5127 unsigned int tag;
5129 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
5130 ap = qc->ap;
5132 qc->flags = 0;
5133 tag = qc->tag;
5134 if (likely(ata_tag_valid(tag))) {
5135 qc->tag = ATA_TAG_POISON;
5136 if (ap->flags & ATA_FLAG_SAS_HOST)
5137 ata_sas_free_tag(tag, ap);
5141 void __ata_qc_complete(struct ata_queued_cmd *qc)
5143 struct ata_port *ap;
5144 struct ata_link *link;
5146 WARN_ON_ONCE(qc == NULL); /* ata_qc_from_tag _might_ return NULL */
5147 WARN_ON_ONCE(!(qc->flags & ATA_QCFLAG_ACTIVE));
5148 ap = qc->ap;
5149 link = qc->dev->link;
5151 if (likely(qc->flags & ATA_QCFLAG_DMAMAP))
5152 ata_sg_clean(qc);
5154 /* command should be marked inactive atomically with qc completion */
5155 if (ata_is_ncq(qc->tf.protocol)) {
5156 link->sactive &= ~(1 << qc->tag);
5157 if (!link->sactive)
5158 ap->nr_active_links--;
5159 } else {
5160 link->active_tag = ATA_TAG_POISON;
5161 ap->nr_active_links--;
5164 /* clear exclusive status */
5165 if (unlikely(qc->flags & ATA_QCFLAG_CLEAR_EXCL &&
5166 ap->excl_link == link))
5167 ap->excl_link = NULL;
5169 /* atapi: mark qc as inactive to prevent the interrupt handler
5170 * from completing the command twice later, before the error handler
5171 * is called. (when rc != 0 and atapi request sense is needed)
5173 qc->flags &= ~ATA_QCFLAG_ACTIVE;
5174 ap->qc_active &= ~(1 << qc->tag);
5176 /* call completion callback */
5177 qc->complete_fn(qc);
5180 static void fill_result_tf(struct ata_queued_cmd *qc)
5182 struct ata_port *ap = qc->ap;
5184 qc->result_tf.flags = qc->tf.flags;
5185 ap->ops->qc_fill_rtf(qc);
5188 static void ata_verify_xfer(struct ata_queued_cmd *qc)
5190 struct ata_device *dev = qc->dev;
5192 if (!ata_is_data(qc->tf.protocol))
5193 return;
5195 if ((dev->mwdma_mask || dev->udma_mask) && ata_is_pio(qc->tf.protocol))
5196 return;
5198 dev->flags &= ~ATA_DFLAG_DUBIOUS_XFER;
5202 * ata_qc_complete - Complete an active ATA command
5203 * @qc: Command to complete
5205 * Indicate to the mid and upper layers that an ATA command has
5206 * completed, with either an ok or not-ok status.
5208 * Refrain from calling this function multiple times when
5209 * successfully completing multiple NCQ commands.
5210 * ata_qc_complete_multiple() should be used instead, which will
5211 * properly update IRQ expect state.
5213 * LOCKING:
5214 * spin_lock_irqsave(host lock)
5216 void ata_qc_complete(struct ata_queued_cmd *qc)
5218 struct ata_port *ap = qc->ap;
5220 /* Trigger the LED (if available) */
5221 ledtrig_disk_activity();
5223 /* XXX: New EH and old EH use different mechanisms to
5224 * synchronize EH with regular execution path.
5226 * In new EH, a failed qc is marked with ATA_QCFLAG_FAILED.
5227 * Normal execution path is responsible for not accessing a
5228 * failed qc. libata core enforces the rule by returning NULL
5229 * from ata_qc_from_tag() for failed qcs.
5231 * Old EH depends on ata_qc_complete() nullifying completion
5232 * requests if ATA_QCFLAG_EH_SCHEDULED is set. Old EH does
5233 * not synchronize with interrupt handler. Only PIO task is
5234 * taken care of.
5236 if (ap->ops->error_handler) {
5237 struct ata_device *dev = qc->dev;
5238 struct ata_eh_info *ehi = &dev->link->eh_info;
5240 if (unlikely(qc->err_mask))
5241 qc->flags |= ATA_QCFLAG_FAILED;
5244 * Finish internal commands without any further processing
5245 * and always with the result TF filled.
5247 if (unlikely(ata_tag_internal(qc->tag))) {
5248 fill_result_tf(qc);
5249 trace_ata_qc_complete_internal(qc);
5250 __ata_qc_complete(qc);
5251 return;
5255 * Non-internal qc has failed. Fill the result TF and
5256 * summon EH.
5258 if (unlikely(qc->flags & ATA_QCFLAG_FAILED)) {
5259 fill_result_tf(qc);
5260 trace_ata_qc_complete_failed(qc);
5261 ata_qc_schedule_eh(qc);
5262 return;
5265 WARN_ON_ONCE(ap->pflags & ATA_PFLAG_FROZEN);
5267 /* read result TF if requested */
5268 if (qc->flags & ATA_QCFLAG_RESULT_TF)
5269 fill_result_tf(qc);
5271 trace_ata_qc_complete_done(qc);
5272 /* Some commands need post-processing after successful
5273 * completion.
5275 switch (qc->tf.command) {
5276 case ATA_CMD_SET_FEATURES:
5277 if (qc->tf.feature != SETFEATURES_WC_ON &&
5278 qc->tf.feature != SETFEATURES_WC_OFF &&
5279 qc->tf.feature != SETFEATURES_RA_ON &&
5280 qc->tf.feature != SETFEATURES_RA_OFF)
5281 break;
5282 /* fall through */
5283 case ATA_CMD_INIT_DEV_PARAMS: /* CHS translation changed */
5284 case ATA_CMD_SET_MULTI: /* multi_count changed */
5285 /* revalidate device */
5286 ehi->dev_action[dev->devno] |= ATA_EH_REVALIDATE;
5287 ata_port_schedule_eh(ap);
5288 break;
5290 case ATA_CMD_SLEEP:
5291 dev->flags |= ATA_DFLAG_SLEEPING;
5292 break;
5295 if (unlikely(dev->flags & ATA_DFLAG_DUBIOUS_XFER))
5296 ata_verify_xfer(qc);
5298 __ata_qc_complete(qc);
5299 } else {
5300 if (qc->flags & ATA_QCFLAG_EH_SCHEDULED)
5301 return;
5303 /* read result TF if failed or requested */
5304 if (qc->err_mask || qc->flags & ATA_QCFLAG_RESULT_TF)
5305 fill_result_tf(qc);
5307 __ata_qc_complete(qc);
5312 * ata_qc_complete_multiple - Complete multiple qcs successfully
5313 * @ap: port in question
5314 * @qc_active: new qc_active mask
5316 * Complete in-flight commands. This functions is meant to be
5317 * called from low-level driver's interrupt routine to complete
5318 * requests normally. ap->qc_active and @qc_active is compared
5319 * and commands are completed accordingly.
5321 * Always use this function when completing multiple NCQ commands
5322 * from IRQ handlers instead of calling ata_qc_complete()
5323 * multiple times to keep IRQ expect status properly in sync.
5325 * LOCKING:
5326 * spin_lock_irqsave(host lock)
5328 * RETURNS:
5329 * Number of completed commands on success, -errno otherwise.
5331 int ata_qc_complete_multiple(struct ata_port *ap, u32 qc_active)
5333 int nr_done = 0;
5334 u32 done_mask;
5336 done_mask = ap->qc_active ^ qc_active;
5338 if (unlikely(done_mask & qc_active)) {
5339 ata_port_err(ap, "illegal qc_active transition (%08x->%08x)\n",
5340 ap->qc_active, qc_active);
5341 return -EINVAL;
5344 while (done_mask) {
5345 struct ata_queued_cmd *qc;
5346 unsigned int tag = __ffs(done_mask);
5348 qc = ata_qc_from_tag(ap, tag);
5349 if (qc) {
5350 ata_qc_complete(qc);
5351 nr_done++;
5353 done_mask &= ~(1 << tag);
5356 return nr_done;
5360 * ata_qc_issue - issue taskfile to device
5361 * @qc: command to issue to device
5363 * Prepare an ATA command to submission to device.
5364 * This includes mapping the data into a DMA-able
5365 * area, filling in the S/G table, and finally
5366 * writing the taskfile to hardware, starting the command.
5368 * LOCKING:
5369 * spin_lock_irqsave(host lock)
5371 void ata_qc_issue(struct ata_queued_cmd *qc)
5373 struct ata_port *ap = qc->ap;
5374 struct ata_link *link = qc->dev->link;
5375 u8 prot = qc->tf.protocol;
5377 /* Make sure only one non-NCQ command is outstanding. The
5378 * check is skipped for old EH because it reuses active qc to
5379 * request ATAPI sense.
5381 WARN_ON_ONCE(ap->ops->error_handler && ata_tag_valid(link->active_tag));
5383 if (ata_is_ncq(prot)) {
5384 WARN_ON_ONCE(link->sactive & (1 << qc->tag));
5386 if (!link->sactive)
5387 ap->nr_active_links++;
5388 link->sactive |= 1 << qc->tag;
5389 } else {
5390 WARN_ON_ONCE(link->sactive);
5392 ap->nr_active_links++;
5393 link->active_tag = qc->tag;
5396 qc->flags |= ATA_QCFLAG_ACTIVE;
5397 ap->qc_active |= 1 << qc->tag;
5400 * We guarantee to LLDs that they will have at least one
5401 * non-zero sg if the command is a data command.
5403 if (WARN_ON_ONCE(ata_is_data(prot) &&
5404 (!qc->sg || !qc->n_elem || !qc->nbytes)))
5405 goto sys_err;
5407 if (ata_is_dma(prot) || (ata_is_pio(prot) &&
5408 (ap->flags & ATA_FLAG_PIO_DMA)))
5409 if (ata_sg_setup(qc))
5410 goto sys_err;
5412 /* if device is sleeping, schedule reset and abort the link */
5413 if (unlikely(qc->dev->flags & ATA_DFLAG_SLEEPING)) {
5414 link->eh_info.action |= ATA_EH_RESET;
5415 ata_ehi_push_desc(&link->eh_info, "waking up from sleep");
5416 ata_link_abort(link);
5417 return;
5420 ap->ops->qc_prep(qc);
5421 trace_ata_qc_issue(qc);
5422 qc->err_mask |= ap->ops->qc_issue(qc);
5423 if (unlikely(qc->err_mask))
5424 goto err;
5425 return;
5427 sys_err:
5428 qc->err_mask |= AC_ERR_SYSTEM;
5429 err:
5430 ata_qc_complete(qc);
5434 * sata_scr_valid - test whether SCRs are accessible
5435 * @link: ATA link to test SCR accessibility for
5437 * Test whether SCRs are accessible for @link.
5439 * LOCKING:
5440 * None.
5442 * RETURNS:
5443 * 1 if SCRs are accessible, 0 otherwise.
5445 int sata_scr_valid(struct ata_link *link)
5447 struct ata_port *ap = link->ap;
5449 return (ap->flags & ATA_FLAG_SATA) && ap->ops->scr_read;
5453 * sata_scr_read - read SCR register of the specified port
5454 * @link: ATA link to read SCR for
5455 * @reg: SCR to read
5456 * @val: Place to store read value
5458 * Read SCR register @reg of @link into *@val. This function is
5459 * guaranteed to succeed if @link is ap->link, the cable type of
5460 * the port is SATA and the port implements ->scr_read.
5462 * LOCKING:
5463 * None if @link is ap->link. Kernel thread context otherwise.
5465 * RETURNS:
5466 * 0 on success, negative errno on failure.
5468 int sata_scr_read(struct ata_link *link, int reg, u32 *val)
5470 if (ata_is_host_link(link)) {
5471 if (sata_scr_valid(link))
5472 return link->ap->ops->scr_read(link, reg, val);
5473 return -EOPNOTSUPP;
5476 return sata_pmp_scr_read(link, reg, val);
5480 * sata_scr_write - write SCR register of the specified port
5481 * @link: ATA link to write SCR for
5482 * @reg: SCR to write
5483 * @val: value to write
5485 * Write @val to SCR register @reg of @link. This function is
5486 * guaranteed to succeed if @link is ap->link, the cable type of
5487 * the port is SATA and the port implements ->scr_read.
5489 * LOCKING:
5490 * None if @link is ap->link. Kernel thread context otherwise.
5492 * RETURNS:
5493 * 0 on success, negative errno on failure.
5495 int sata_scr_write(struct ata_link *link, int reg, u32 val)
5497 if (ata_is_host_link(link)) {
5498 if (sata_scr_valid(link))
5499 return link->ap->ops->scr_write(link, reg, val);
5500 return -EOPNOTSUPP;
5503 return sata_pmp_scr_write(link, reg, val);
5507 * sata_scr_write_flush - write SCR register of the specified port and flush
5508 * @link: ATA link to write SCR for
5509 * @reg: SCR to write
5510 * @val: value to write
5512 * This function is identical to sata_scr_write() except that this
5513 * function performs flush after writing to the register.
5515 * LOCKING:
5516 * None if @link is ap->link. Kernel thread context otherwise.
5518 * RETURNS:
5519 * 0 on success, negative errno on failure.
5521 int sata_scr_write_flush(struct ata_link *link, int reg, u32 val)
5523 if (ata_is_host_link(link)) {
5524 int rc;
5526 if (sata_scr_valid(link)) {
5527 rc = link->ap->ops->scr_write(link, reg, val);
5528 if (rc == 0)
5529 rc = link->ap->ops->scr_read(link, reg, &val);
5530 return rc;
5532 return -EOPNOTSUPP;
5535 return sata_pmp_scr_write(link, reg, val);
5539 * ata_phys_link_online - test whether the given link is online
5540 * @link: ATA link to test
5542 * Test whether @link is online. Note that this function returns
5543 * 0 if online status of @link cannot be obtained, so
5544 * ata_link_online(link) != !ata_link_offline(link).
5546 * LOCKING:
5547 * None.
5549 * RETURNS:
5550 * True if the port online status is available and online.
5552 bool ata_phys_link_online(struct ata_link *link)
5554 u32 sstatus;
5556 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
5557 ata_sstatus_online(sstatus))
5558 return true;
5559 return false;
5563 * ata_phys_link_offline - test whether the given link is offline
5564 * @link: ATA link to test
5566 * Test whether @link is offline. Note that this function
5567 * returns 0 if offline status of @link cannot be obtained, so
5568 * ata_link_online(link) != !ata_link_offline(link).
5570 * LOCKING:
5571 * None.
5573 * RETURNS:
5574 * True if the port offline status is available and offline.
5576 bool ata_phys_link_offline(struct ata_link *link)
5578 u32 sstatus;
5580 if (sata_scr_read(link, SCR_STATUS, &sstatus) == 0 &&
5581 !ata_sstatus_online(sstatus))
5582 return true;
5583 return false;
5587 * ata_link_online - test whether the given link is online
5588 * @link: ATA link to test
5590 * Test whether @link is online. This is identical to
5591 * ata_phys_link_online() when there's no slave link. When
5592 * there's a slave link, this function should only be called on
5593 * the master link and will return true if any of M/S links is
5594 * online.
5596 * LOCKING:
5597 * None.
5599 * RETURNS:
5600 * True if the port online status is available and online.
5602 bool ata_link_online(struct ata_link *link)
5604 struct ata_link *slave = link->ap->slave_link;
5606 WARN_ON(link == slave); /* shouldn't be called on slave link */
5608 return ata_phys_link_online(link) ||
5609 (slave && ata_phys_link_online(slave));
5613 * ata_link_offline - test whether the given link is offline
5614 * @link: ATA link to test
5616 * Test whether @link is offline. This is identical to
5617 * ata_phys_link_offline() when there's no slave link. When
5618 * there's a slave link, this function should only be called on
5619 * the master link and will return true if both M/S links are
5620 * offline.
5622 * LOCKING:
5623 * None.
5625 * RETURNS:
5626 * True if the port offline status is available and offline.
5628 bool ata_link_offline(struct ata_link *link)
5630 struct ata_link *slave = link->ap->slave_link;
5632 WARN_ON(link == slave); /* shouldn't be called on slave link */
5634 return ata_phys_link_offline(link) &&
5635 (!slave || ata_phys_link_offline(slave));
5638 #ifdef CONFIG_PM
5639 static void ata_port_request_pm(struct ata_port *ap, pm_message_t mesg,
5640 unsigned int action, unsigned int ehi_flags,
5641 bool async)
5643 struct ata_link *link;
5644 unsigned long flags;
5646 /* Previous resume operation might still be in
5647 * progress. Wait for PM_PENDING to clear.
5649 if (ap->pflags & ATA_PFLAG_PM_PENDING) {
5650 ata_port_wait_eh(ap);
5651 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5654 /* request PM ops to EH */
5655 spin_lock_irqsave(ap->lock, flags);
5657 ap->pm_mesg = mesg;
5658 ap->pflags |= ATA_PFLAG_PM_PENDING;
5659 ata_for_each_link(link, ap, HOST_FIRST) {
5660 link->eh_info.action |= action;
5661 link->eh_info.flags |= ehi_flags;
5664 ata_port_schedule_eh(ap);
5666 spin_unlock_irqrestore(ap->lock, flags);
5668 if (!async) {
5669 ata_port_wait_eh(ap);
5670 WARN_ON(ap->pflags & ATA_PFLAG_PM_PENDING);
5675 * On some hardware, device fails to respond after spun down for suspend. As
5676 * the device won't be used before being resumed, we don't need to touch the
5677 * device. Ask EH to skip the usual stuff and proceed directly to suspend.
5679 * http://thread.gmane.org/gmane.linux.ide/46764
5681 static const unsigned int ata_port_suspend_ehi = ATA_EHI_QUIET
5682 | ATA_EHI_NO_AUTOPSY
5683 | ATA_EHI_NO_RECOVERY;
5685 static void ata_port_suspend(struct ata_port *ap, pm_message_t mesg)
5687 ata_port_request_pm(ap, mesg, 0, ata_port_suspend_ehi, false);
5690 static void ata_port_suspend_async(struct ata_port *ap, pm_message_t mesg)
5692 ata_port_request_pm(ap, mesg, 0, ata_port_suspend_ehi, true);
5695 static int ata_port_pm_suspend(struct device *dev)
5697 struct ata_port *ap = to_ata_port(dev);
5699 if (pm_runtime_suspended(dev))
5700 return 0;
5702 ata_port_suspend(ap, PMSG_SUSPEND);
5703 return 0;
5706 static int ata_port_pm_freeze(struct device *dev)
5708 struct ata_port *ap = to_ata_port(dev);
5710 if (pm_runtime_suspended(dev))
5711 return 0;
5713 ata_port_suspend(ap, PMSG_FREEZE);
5714 return 0;
5717 static int ata_port_pm_poweroff(struct device *dev)
5719 ata_port_suspend(to_ata_port(dev), PMSG_HIBERNATE);
5720 return 0;
5723 static const unsigned int ata_port_resume_ehi = ATA_EHI_NO_AUTOPSY
5724 | ATA_EHI_QUIET;
5726 static void ata_port_resume(struct ata_port *ap, pm_message_t mesg)
5728 ata_port_request_pm(ap, mesg, ATA_EH_RESET, ata_port_resume_ehi, false);
5731 static void ata_port_resume_async(struct ata_port *ap, pm_message_t mesg)
5733 ata_port_request_pm(ap, mesg, ATA_EH_RESET, ata_port_resume_ehi, true);
5736 static int ata_port_pm_resume(struct device *dev)
5738 ata_port_resume_async(to_ata_port(dev), PMSG_RESUME);
5739 pm_runtime_disable(dev);
5740 pm_runtime_set_active(dev);
5741 pm_runtime_enable(dev);
5742 return 0;
5746 * For ODDs, the upper layer will poll for media change every few seconds,
5747 * which will make it enter and leave suspend state every few seconds. And
5748 * as each suspend will cause a hard/soft reset, the gain of runtime suspend
5749 * is very little and the ODD may malfunction after constantly being reset.
5750 * So the idle callback here will not proceed to suspend if a non-ZPODD capable
5751 * ODD is attached to the port.
5753 static int ata_port_runtime_idle(struct device *dev)
5755 struct ata_port *ap = to_ata_port(dev);
5756 struct ata_link *link;
5757 struct ata_device *adev;
5759 ata_for_each_link(link, ap, HOST_FIRST) {
5760 ata_for_each_dev(adev, link, ENABLED)
5761 if (adev->class == ATA_DEV_ATAPI &&
5762 !zpodd_dev_enabled(adev))
5763 return -EBUSY;
5766 return 0;
5769 static int ata_port_runtime_suspend(struct device *dev)
5771 ata_port_suspend(to_ata_port(dev), PMSG_AUTO_SUSPEND);
5772 return 0;
5775 static int ata_port_runtime_resume(struct device *dev)
5777 ata_port_resume(to_ata_port(dev), PMSG_AUTO_RESUME);
5778 return 0;
5781 static const struct dev_pm_ops ata_port_pm_ops = {
5782 .suspend = ata_port_pm_suspend,
5783 .resume = ata_port_pm_resume,
5784 .freeze = ata_port_pm_freeze,
5785 .thaw = ata_port_pm_resume,
5786 .poweroff = ata_port_pm_poweroff,
5787 .restore = ata_port_pm_resume,
5789 .runtime_suspend = ata_port_runtime_suspend,
5790 .runtime_resume = ata_port_runtime_resume,
5791 .runtime_idle = ata_port_runtime_idle,
5794 /* sas ports don't participate in pm runtime management of ata_ports,
5795 * and need to resume ata devices at the domain level, not the per-port
5796 * level. sas suspend/resume is async to allow parallel port recovery
5797 * since sas has multiple ata_port instances per Scsi_Host.
5799 void ata_sas_port_suspend(struct ata_port *ap)
5801 ata_port_suspend_async(ap, PMSG_SUSPEND);
5803 EXPORT_SYMBOL_GPL(ata_sas_port_suspend);
5805 void ata_sas_port_resume(struct ata_port *ap)
5807 ata_port_resume_async(ap, PMSG_RESUME);
5809 EXPORT_SYMBOL_GPL(ata_sas_port_resume);
5812 * ata_host_suspend - suspend host
5813 * @host: host to suspend
5814 * @mesg: PM message
5816 * Suspend @host. Actual operation is performed by port suspend.
5818 int ata_host_suspend(struct ata_host *host, pm_message_t mesg)
5820 host->dev->power.power_state = mesg;
5821 return 0;
5825 * ata_host_resume - resume host
5826 * @host: host to resume
5828 * Resume @host. Actual operation is performed by port resume.
5830 void ata_host_resume(struct ata_host *host)
5832 host->dev->power.power_state = PMSG_ON;
5834 #endif
5836 const struct device_type ata_port_type = {
5837 .name = "ata_port",
5838 #ifdef CONFIG_PM
5839 .pm = &ata_port_pm_ops,
5840 #endif
5844 * ata_dev_init - Initialize an ata_device structure
5845 * @dev: Device structure to initialize
5847 * Initialize @dev in preparation for probing.
5849 * LOCKING:
5850 * Inherited from caller.
5852 void ata_dev_init(struct ata_device *dev)
5854 struct ata_link *link = ata_dev_phys_link(dev);
5855 struct ata_port *ap = link->ap;
5856 unsigned long flags;
5858 /* SATA spd limit is bound to the attached device, reset together */
5859 link->sata_spd_limit = link->hw_sata_spd_limit;
5860 link->sata_spd = 0;
5862 /* High bits of dev->flags are used to record warm plug
5863 * requests which occur asynchronously. Synchronize using
5864 * host lock.
5866 spin_lock_irqsave(ap->lock, flags);
5867 dev->flags &= ~ATA_DFLAG_INIT_MASK;
5868 dev->horkage = 0;
5869 spin_unlock_irqrestore(ap->lock, flags);
5871 memset((void *)dev + ATA_DEVICE_CLEAR_BEGIN, 0,
5872 ATA_DEVICE_CLEAR_END - ATA_DEVICE_CLEAR_BEGIN);
5873 dev->pio_mask = UINT_MAX;
5874 dev->mwdma_mask = UINT_MAX;
5875 dev->udma_mask = UINT_MAX;
5879 * ata_link_init - Initialize an ata_link structure
5880 * @ap: ATA port link is attached to
5881 * @link: Link structure to initialize
5882 * @pmp: Port multiplier port number
5884 * Initialize @link.
5886 * LOCKING:
5887 * Kernel thread context (may sleep)
5889 void ata_link_init(struct ata_port *ap, struct ata_link *link, int pmp)
5891 int i;
5893 /* clear everything except for devices */
5894 memset((void *)link + ATA_LINK_CLEAR_BEGIN, 0,
5895 ATA_LINK_CLEAR_END - ATA_LINK_CLEAR_BEGIN);
5897 link->ap = ap;
5898 link->pmp = pmp;
5899 link->active_tag = ATA_TAG_POISON;
5900 link->hw_sata_spd_limit = UINT_MAX;
5902 /* can't use iterator, ap isn't initialized yet */
5903 for (i = 0; i < ATA_MAX_DEVICES; i++) {
5904 struct ata_device *dev = &link->device[i];
5906 dev->link = link;
5907 dev->devno = dev - link->device;
5908 #ifdef CONFIG_ATA_ACPI
5909 dev->gtf_filter = ata_acpi_gtf_filter;
5910 #endif
5911 ata_dev_init(dev);
5916 * sata_link_init_spd - Initialize link->sata_spd_limit
5917 * @link: Link to configure sata_spd_limit for
5919 * Initialize @link->[hw_]sata_spd_limit to the currently
5920 * configured value.
5922 * LOCKING:
5923 * Kernel thread context (may sleep).
5925 * RETURNS:
5926 * 0 on success, -errno on failure.
5928 int sata_link_init_spd(struct ata_link *link)
5930 u8 spd;
5931 int rc;
5933 rc = sata_scr_read(link, SCR_CONTROL, &link->saved_scontrol);
5934 if (rc)
5935 return rc;
5937 spd = (link->saved_scontrol >> 4) & 0xf;
5938 if (spd)
5939 link->hw_sata_spd_limit &= (1 << spd) - 1;
5941 ata_force_link_limits(link);
5943 link->sata_spd_limit = link->hw_sata_spd_limit;
5945 return 0;
5949 * ata_port_alloc - allocate and initialize basic ATA port resources
5950 * @host: ATA host this allocated port belongs to
5952 * Allocate and initialize basic ATA port resources.
5954 * RETURNS:
5955 * Allocate ATA port on success, NULL on failure.
5957 * LOCKING:
5958 * Inherited from calling layer (may sleep).
5960 struct ata_port *ata_port_alloc(struct ata_host *host)
5962 struct ata_port *ap;
5964 DPRINTK("ENTER\n");
5966 ap = kzalloc(sizeof(*ap), GFP_KERNEL);
5967 if (!ap)
5968 return NULL;
5970 ap->pflags |= ATA_PFLAG_INITIALIZING | ATA_PFLAG_FROZEN;
5971 ap->lock = &host->lock;
5972 ap->print_id = -1;
5973 ap->local_port_no = -1;
5974 ap->host = host;
5975 ap->dev = host->dev;
5977 #if defined(ATA_VERBOSE_DEBUG)
5978 /* turn on all debugging levels */
5979 ap->msg_enable = 0x00FF;
5980 #elif defined(ATA_DEBUG)
5981 ap->msg_enable = ATA_MSG_DRV | ATA_MSG_INFO | ATA_MSG_CTL | ATA_MSG_WARN | ATA_MSG_ERR;
5982 #else
5983 ap->msg_enable = ATA_MSG_DRV | ATA_MSG_ERR | ATA_MSG_WARN;
5984 #endif
5986 mutex_init(&ap->scsi_scan_mutex);
5987 INIT_DELAYED_WORK(&ap->hotplug_task, ata_scsi_hotplug);
5988 INIT_WORK(&ap->scsi_rescan_task, ata_scsi_dev_rescan);
5989 INIT_LIST_HEAD(&ap->eh_done_q);
5990 init_waitqueue_head(&ap->eh_wait_q);
5991 init_completion(&ap->park_req_pending);
5992 timer_setup(&ap->fastdrain_timer, ata_eh_fastdrain_timerfn,
5993 TIMER_DEFERRABLE);
5995 ap->cbl = ATA_CBL_NONE;
5997 ata_link_init(ap, &ap->link, 0);
5999 #ifdef ATA_IRQ_TRAP
6000 ap->stats.unhandled_irq = 1;
6001 ap->stats.idle_irq = 1;
6002 #endif
6003 ata_sff_port_init(ap);
6005 return ap;
6008 static void ata_host_release(struct device *gendev, void *res)
6010 struct ata_host *host = dev_get_drvdata(gendev);
6011 int i;
6013 for (i = 0; i < host->n_ports; i++) {
6014 struct ata_port *ap = host->ports[i];
6016 if (!ap)
6017 continue;
6019 if (ap->scsi_host)
6020 scsi_host_put(ap->scsi_host);
6022 kfree(ap->pmp_link);
6023 kfree(ap->slave_link);
6024 kfree(ap);
6025 host->ports[i] = NULL;
6028 dev_set_drvdata(gendev, NULL);
6032 * ata_host_alloc - allocate and init basic ATA host resources
6033 * @dev: generic device this host is associated with
6034 * @max_ports: maximum number of ATA ports associated with this host
6036 * Allocate and initialize basic ATA host resources. LLD calls
6037 * this function to allocate a host, initializes it fully and
6038 * attaches it using ata_host_register().
6040 * @max_ports ports are allocated and host->n_ports is
6041 * initialized to @max_ports. The caller is allowed to decrease
6042 * host->n_ports before calling ata_host_register(). The unused
6043 * ports will be automatically freed on registration.
6045 * RETURNS:
6046 * Allocate ATA host on success, NULL on failure.
6048 * LOCKING:
6049 * Inherited from calling layer (may sleep).
6051 struct ata_host *ata_host_alloc(struct device *dev, int max_ports)
6053 struct ata_host *host;
6054 size_t sz;
6055 int i;
6057 DPRINTK("ENTER\n");
6059 if (!devres_open_group(dev, NULL, GFP_KERNEL))
6060 return NULL;
6062 /* alloc a container for our list of ATA ports (buses) */
6063 sz = sizeof(struct ata_host) + (max_ports + 1) * sizeof(void *);
6064 /* alloc a container for our list of ATA ports (buses) */
6065 host = devres_alloc(ata_host_release, sz, GFP_KERNEL);
6066 if (!host)
6067 goto err_out;
6069 devres_add(dev, host);
6070 dev_set_drvdata(dev, host);
6072 spin_lock_init(&host->lock);
6073 mutex_init(&host->eh_mutex);
6074 host->dev = dev;
6075 host->n_ports = max_ports;
6077 /* allocate ports bound to this host */
6078 for (i = 0; i < max_ports; i++) {
6079 struct ata_port *ap;
6081 ap = ata_port_alloc(host);
6082 if (!ap)
6083 goto err_out;
6085 ap->port_no = i;
6086 host->ports[i] = ap;
6089 devres_remove_group(dev, NULL);
6090 return host;
6092 err_out:
6093 devres_release_group(dev, NULL);
6094 return NULL;
6098 * ata_host_alloc_pinfo - alloc host and init with port_info array
6099 * @dev: generic device this host is associated with
6100 * @ppi: array of ATA port_info to initialize host with
6101 * @n_ports: number of ATA ports attached to this host
6103 * Allocate ATA host and initialize with info from @ppi. If NULL
6104 * terminated, @ppi may contain fewer entries than @n_ports. The
6105 * last entry will be used for the remaining ports.
6107 * RETURNS:
6108 * Allocate ATA host on success, NULL on failure.
6110 * LOCKING:
6111 * Inherited from calling layer (may sleep).
6113 struct ata_host *ata_host_alloc_pinfo(struct device *dev,
6114 const struct ata_port_info * const * ppi,
6115 int n_ports)
6117 const struct ata_port_info *pi;
6118 struct ata_host *host;
6119 int i, j;
6121 host = ata_host_alloc(dev, n_ports);
6122 if (!host)
6123 return NULL;
6125 for (i = 0, j = 0, pi = NULL; i < host->n_ports; i++) {
6126 struct ata_port *ap = host->ports[i];
6128 if (ppi[j])
6129 pi = ppi[j++];
6131 ap->pio_mask = pi->pio_mask;
6132 ap->mwdma_mask = pi->mwdma_mask;
6133 ap->udma_mask = pi->udma_mask;
6134 ap->flags |= pi->flags;
6135 ap->link.flags |= pi->link_flags;
6136 ap->ops = pi->port_ops;
6138 if (!host->ops && (pi->port_ops != &ata_dummy_port_ops))
6139 host->ops = pi->port_ops;
6142 return host;
6146 * ata_slave_link_init - initialize slave link
6147 * @ap: port to initialize slave link for
6149 * Create and initialize slave link for @ap. This enables slave
6150 * link handling on the port.
6152 * In libata, a port contains links and a link contains devices.
6153 * There is single host link but if a PMP is attached to it,
6154 * there can be multiple fan-out links. On SATA, there's usually
6155 * a single device connected to a link but PATA and SATA
6156 * controllers emulating TF based interface can have two - master
6157 * and slave.
6159 * However, there are a few controllers which don't fit into this
6160 * abstraction too well - SATA controllers which emulate TF
6161 * interface with both master and slave devices but also have
6162 * separate SCR register sets for each device. These controllers
6163 * need separate links for physical link handling
6164 * (e.g. onlineness, link speed) but should be treated like a
6165 * traditional M/S controller for everything else (e.g. command
6166 * issue, softreset).
6168 * slave_link is libata's way of handling this class of
6169 * controllers without impacting core layer too much. For
6170 * anything other than physical link handling, the default host
6171 * link is used for both master and slave. For physical link
6172 * handling, separate @ap->slave_link is used. All dirty details
6173 * are implemented inside libata core layer. From LLD's POV, the
6174 * only difference is that prereset, hardreset and postreset are
6175 * called once more for the slave link, so the reset sequence
6176 * looks like the following.
6178 * prereset(M) -> prereset(S) -> hardreset(M) -> hardreset(S) ->
6179 * softreset(M) -> postreset(M) -> postreset(S)
6181 * Note that softreset is called only for the master. Softreset
6182 * resets both M/S by definition, so SRST on master should handle
6183 * both (the standard method will work just fine).
6185 * LOCKING:
6186 * Should be called before host is registered.
6188 * RETURNS:
6189 * 0 on success, -errno on failure.
6191 int ata_slave_link_init(struct ata_port *ap)
6193 struct ata_link *link;
6195 WARN_ON(ap->slave_link);
6196 WARN_ON(ap->flags & ATA_FLAG_PMP);
6198 link = kzalloc(sizeof(*link), GFP_KERNEL);
6199 if (!link)
6200 return -ENOMEM;
6202 ata_link_init(ap, link, 1);
6203 ap->slave_link = link;
6204 return 0;
6207 static void ata_host_stop(struct device *gendev, void *res)
6209 struct ata_host *host = dev_get_drvdata(gendev);
6210 int i;
6212 WARN_ON(!(host->flags & ATA_HOST_STARTED));
6214 for (i = 0; i < host->n_ports; i++) {
6215 struct ata_port *ap = host->ports[i];
6217 if (ap->ops->port_stop)
6218 ap->ops->port_stop(ap);
6221 if (host->ops->host_stop)
6222 host->ops->host_stop(host);
6226 * ata_finalize_port_ops - finalize ata_port_operations
6227 * @ops: ata_port_operations to finalize
6229 * An ata_port_operations can inherit from another ops and that
6230 * ops can again inherit from another. This can go on as many
6231 * times as necessary as long as there is no loop in the
6232 * inheritance chain.
6234 * Ops tables are finalized when the host is started. NULL or
6235 * unspecified entries are inherited from the closet ancestor
6236 * which has the method and the entry is populated with it.
6237 * After finalization, the ops table directly points to all the
6238 * methods and ->inherits is no longer necessary and cleared.
6240 * Using ATA_OP_NULL, inheriting ops can force a method to NULL.
6242 * LOCKING:
6243 * None.
6245 static void ata_finalize_port_ops(struct ata_port_operations *ops)
6247 static DEFINE_SPINLOCK(lock);
6248 const struct ata_port_operations *cur;
6249 void **begin = (void **)ops;
6250 void **end = (void **)&ops->inherits;
6251 void **pp;
6253 if (!ops || !ops->inherits)
6254 return;
6256 spin_lock(&lock);
6258 for (cur = ops->inherits; cur; cur = cur->inherits) {
6259 void **inherit = (void **)cur;
6261 for (pp = begin; pp < end; pp++, inherit++)
6262 if (!*pp)
6263 *pp = *inherit;
6266 for (pp = begin; pp < end; pp++)
6267 if (IS_ERR(*pp))
6268 *pp = NULL;
6270 ops->inherits = NULL;
6272 spin_unlock(&lock);
6276 * ata_host_start - start and freeze ports of an ATA host
6277 * @host: ATA host to start ports for
6279 * Start and then freeze ports of @host. Started status is
6280 * recorded in host->flags, so this function can be called
6281 * multiple times. Ports are guaranteed to get started only
6282 * once. If host->ops isn't initialized yet, its set to the
6283 * first non-dummy port ops.
6285 * LOCKING:
6286 * Inherited from calling layer (may sleep).
6288 * RETURNS:
6289 * 0 if all ports are started successfully, -errno otherwise.
6291 int ata_host_start(struct ata_host *host)
6293 int have_stop = 0;
6294 void *start_dr = NULL;
6295 int i, rc;
6297 if (host->flags & ATA_HOST_STARTED)
6298 return 0;
6300 ata_finalize_port_ops(host->ops);
6302 for (i = 0; i < host->n_ports; i++) {
6303 struct ata_port *ap = host->ports[i];
6305 ata_finalize_port_ops(ap->ops);
6307 if (!host->ops && !ata_port_is_dummy(ap))
6308 host->ops = ap->ops;
6310 if (ap->ops->port_stop)
6311 have_stop = 1;
6314 if (host->ops->host_stop)
6315 have_stop = 1;
6317 if (have_stop) {
6318 start_dr = devres_alloc(ata_host_stop, 0, GFP_KERNEL);
6319 if (!start_dr)
6320 return -ENOMEM;
6323 for (i = 0; i < host->n_ports; i++) {
6324 struct ata_port *ap = host->ports[i];
6326 if (ap->ops->port_start) {
6327 rc = ap->ops->port_start(ap);
6328 if (rc) {
6329 if (rc != -ENODEV)
6330 dev_err(host->dev,
6331 "failed to start port %d (errno=%d)\n",
6332 i, rc);
6333 goto err_out;
6336 ata_eh_freeze_port(ap);
6339 if (start_dr)
6340 devres_add(host->dev, start_dr);
6341 host->flags |= ATA_HOST_STARTED;
6342 return 0;
6344 err_out:
6345 while (--i >= 0) {
6346 struct ata_port *ap = host->ports[i];
6348 if (ap->ops->port_stop)
6349 ap->ops->port_stop(ap);
6351 devres_free(start_dr);
6352 return rc;
6356 * ata_sas_host_init - Initialize a host struct for sas (ipr, libsas)
6357 * @host: host to initialize
6358 * @dev: device host is attached to
6359 * @ops: port_ops
6362 void ata_host_init(struct ata_host *host, struct device *dev,
6363 struct ata_port_operations *ops)
6365 spin_lock_init(&host->lock);
6366 mutex_init(&host->eh_mutex);
6367 host->n_tags = ATA_MAX_QUEUE - 1;
6368 host->dev = dev;
6369 host->ops = ops;
6372 void __ata_port_probe(struct ata_port *ap)
6374 struct ata_eh_info *ehi = &ap->link.eh_info;
6375 unsigned long flags;
6377 /* kick EH for boot probing */
6378 spin_lock_irqsave(ap->lock, flags);
6380 ehi->probe_mask |= ATA_ALL_DEVICES;
6381 ehi->action |= ATA_EH_RESET;
6382 ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;
6384 ap->pflags &= ~ATA_PFLAG_INITIALIZING;
6385 ap->pflags |= ATA_PFLAG_LOADING;
6386 ata_port_schedule_eh(ap);
6388 spin_unlock_irqrestore(ap->lock, flags);
6391 int ata_port_probe(struct ata_port *ap)
6393 int rc = 0;
6395 if (ap->ops->error_handler) {
6396 __ata_port_probe(ap);
6397 ata_port_wait_eh(ap);
6398 } else {
6399 DPRINTK("ata%u: bus probe begin\n", ap->print_id);
6400 rc = ata_bus_probe(ap);
6401 DPRINTK("ata%u: bus probe end\n", ap->print_id);
6403 return rc;
6407 static void async_port_probe(void *data, async_cookie_t cookie)
6409 struct ata_port *ap = data;
6412 * If we're not allowed to scan this host in parallel,
6413 * we need to wait until all previous scans have completed
6414 * before going further.
6415 * Jeff Garzik says this is only within a controller, so we
6416 * don't need to wait for port 0, only for later ports.
6418 if (!(ap->host->flags & ATA_HOST_PARALLEL_SCAN) && ap->port_no != 0)
6419 async_synchronize_cookie(cookie);
6421 (void)ata_port_probe(ap);
6423 /* in order to keep device order, we need to synchronize at this point */
6424 async_synchronize_cookie(cookie);
6426 ata_scsi_scan_host(ap, 1);
6430 * ata_host_register - register initialized ATA host
6431 * @host: ATA host to register
6432 * @sht: template for SCSI host
6434 * Register initialized ATA host. @host is allocated using
6435 * ata_host_alloc() and fully initialized by LLD. This function
6436 * starts ports, registers @host with ATA and SCSI layers and
6437 * probe registered devices.
6439 * LOCKING:
6440 * Inherited from calling layer (may sleep).
6442 * RETURNS:
6443 * 0 on success, -errno otherwise.
6445 int ata_host_register(struct ata_host *host, struct scsi_host_template *sht)
6447 int i, rc;
6449 host->n_tags = clamp(sht->can_queue, 1, ATA_MAX_QUEUE - 1);
6451 /* host must have been started */
6452 if (!(host->flags & ATA_HOST_STARTED)) {
6453 dev_err(host->dev, "BUG: trying to register unstarted host\n");
6454 WARN_ON(1);
6455 return -EINVAL;
6458 /* Blow away unused ports. This happens when LLD can't
6459 * determine the exact number of ports to allocate at
6460 * allocation time.
6462 for (i = host->n_ports; host->ports[i]; i++)
6463 kfree(host->ports[i]);
6465 /* give ports names and add SCSI hosts */
6466 for (i = 0; i < host->n_ports; i++) {
6467 host->ports[i]->print_id = atomic_inc_return(&ata_print_id);
6468 host->ports[i]->local_port_no = i + 1;
6471 /* Create associated sysfs transport objects */
6472 for (i = 0; i < host->n_ports; i++) {
6473 rc = ata_tport_add(host->dev,host->ports[i]);
6474 if (rc) {
6475 goto err_tadd;
6479 rc = ata_scsi_add_hosts(host, sht);
6480 if (rc)
6481 goto err_tadd;
6483 /* set cable, sata_spd_limit and report */
6484 for (i = 0; i < host->n_ports; i++) {
6485 struct ata_port *ap = host->ports[i];
6486 unsigned long xfer_mask;
6488 /* set SATA cable type if still unset */
6489 if (ap->cbl == ATA_CBL_NONE && (ap->flags & ATA_FLAG_SATA))
6490 ap->cbl = ATA_CBL_SATA;
6492 /* init sata_spd_limit to the current value */
6493 sata_link_init_spd(&ap->link);
6494 if (ap->slave_link)
6495 sata_link_init_spd(ap->slave_link);
6497 /* print per-port info to dmesg */
6498 xfer_mask = ata_pack_xfermask(ap->pio_mask, ap->mwdma_mask,
6499 ap->udma_mask);
6501 if (!ata_port_is_dummy(ap)) {
6502 ata_port_info(ap, "%cATA max %s %s\n",
6503 (ap->flags & ATA_FLAG_SATA) ? 'S' : 'P',
6504 ata_mode_string(xfer_mask),
6505 ap->link.eh_info.desc);
6506 ata_ehi_clear_desc(&ap->link.eh_info);
6507 } else
6508 ata_port_info(ap, "DUMMY\n");
6511 /* perform each probe asynchronously */
6512 for (i = 0; i < host->n_ports; i++) {
6513 struct ata_port *ap = host->ports[i];
6514 async_schedule(async_port_probe, ap);
6517 return 0;
6519 err_tadd:
6520 while (--i >= 0) {
6521 ata_tport_delete(host->ports[i]);
6523 return rc;
6528 * ata_host_activate - start host, request IRQ and register it
6529 * @host: target ATA host
6530 * @irq: IRQ to request
6531 * @irq_handler: irq_handler used when requesting IRQ
6532 * @irq_flags: irq_flags used when requesting IRQ
6533 * @sht: scsi_host_template to use when registering the host
6535 * After allocating an ATA host and initializing it, most libata
6536 * LLDs perform three steps to activate the host - start host,
6537 * request IRQ and register it. This helper takes necessary
6538 * arguments and performs the three steps in one go.
6540 * An invalid IRQ skips the IRQ registration and expects the host to
6541 * have set polling mode on the port. In this case, @irq_handler
6542 * should be NULL.
6544 * LOCKING:
6545 * Inherited from calling layer (may sleep).
6547 * RETURNS:
6548 * 0 on success, -errno otherwise.
6550 int ata_host_activate(struct ata_host *host, int irq,
6551 irq_handler_t irq_handler, unsigned long irq_flags,
6552 struct scsi_host_template *sht)
6554 int i, rc;
6555 char *irq_desc;
6557 rc = ata_host_start(host);
6558 if (rc)
6559 return rc;
6561 /* Special case for polling mode */
6562 if (!irq) {
6563 WARN_ON(irq_handler);
6564 return ata_host_register(host, sht);
6567 irq_desc = devm_kasprintf(host->dev, GFP_KERNEL, "%s[%s]",
6568 dev_driver_string(host->dev),
6569 dev_name(host->dev));
6570 if (!irq_desc)
6571 return -ENOMEM;
6573 rc = devm_request_irq(host->dev, irq, irq_handler, irq_flags,
6574 irq_desc, host);
6575 if (rc)
6576 return rc;
6578 for (i = 0; i < host->n_ports; i++)
6579 ata_port_desc(host->ports[i], "irq %d", irq);
6581 rc = ata_host_register(host, sht);
6582 /* if failed, just free the IRQ and leave ports alone */
6583 if (rc)
6584 devm_free_irq(host->dev, irq, host);
6586 return rc;
6590 * ata_port_detach - Detach ATA port in preparation of device removal
6591 * @ap: ATA port to be detached
6593 * Detach all ATA devices and the associated SCSI devices of @ap;
6594 * then, remove the associated SCSI host. @ap is guaranteed to
6595 * be quiescent on return from this function.
6597 * LOCKING:
6598 * Kernel thread context (may sleep).
6600 static void ata_port_detach(struct ata_port *ap)
6602 unsigned long flags;
6603 struct ata_link *link;
6604 struct ata_device *dev;
6606 if (!ap->ops->error_handler)
6607 goto skip_eh;
6609 /* tell EH we're leaving & flush EH */
6610 spin_lock_irqsave(ap->lock, flags);
6611 ap->pflags |= ATA_PFLAG_UNLOADING;
6612 ata_port_schedule_eh(ap);
6613 spin_unlock_irqrestore(ap->lock, flags);
6615 /* wait till EH commits suicide */
6616 ata_port_wait_eh(ap);
6618 /* it better be dead now */
6619 WARN_ON(!(ap->pflags & ATA_PFLAG_UNLOADED));
6621 cancel_delayed_work_sync(&ap->hotplug_task);
6623 skip_eh:
6624 /* clean up zpodd on port removal */
6625 ata_for_each_link(link, ap, HOST_FIRST) {
6626 ata_for_each_dev(dev, link, ALL) {
6627 if (zpodd_dev_enabled(dev))
6628 zpodd_exit(dev);
6631 if (ap->pmp_link) {
6632 int i;
6633 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
6634 ata_tlink_delete(&ap->pmp_link[i]);
6636 /* remove the associated SCSI host */
6637 scsi_remove_host(ap->scsi_host);
6638 ata_tport_delete(ap);
6642 * ata_host_detach - Detach all ports of an ATA host
6643 * @host: Host to detach
6645 * Detach all ports of @host.
6647 * LOCKING:
6648 * Kernel thread context (may sleep).
6650 void ata_host_detach(struct ata_host *host)
6652 int i;
6654 for (i = 0; i < host->n_ports; i++)
6655 ata_port_detach(host->ports[i]);
6657 /* the host is dead now, dissociate ACPI */
6658 ata_acpi_dissociate(host);
6661 #ifdef CONFIG_PCI
6664 * ata_pci_remove_one - PCI layer callback for device removal
6665 * @pdev: PCI device that was removed
6667 * PCI layer indicates to libata via this hook that hot-unplug or
6668 * module unload event has occurred. Detach all ports. Resource
6669 * release is handled via devres.
6671 * LOCKING:
6672 * Inherited from PCI layer (may sleep).
6674 void ata_pci_remove_one(struct pci_dev *pdev)
6676 struct ata_host *host = pci_get_drvdata(pdev);
6678 ata_host_detach(host);
6681 /* move to PCI subsystem */
6682 int pci_test_config_bits(struct pci_dev *pdev, const struct pci_bits *bits)
6684 unsigned long tmp = 0;
6686 switch (bits->width) {
6687 case 1: {
6688 u8 tmp8 = 0;
6689 pci_read_config_byte(pdev, bits->reg, &tmp8);
6690 tmp = tmp8;
6691 break;
6693 case 2: {
6694 u16 tmp16 = 0;
6695 pci_read_config_word(pdev, bits->reg, &tmp16);
6696 tmp = tmp16;
6697 break;
6699 case 4: {
6700 u32 tmp32 = 0;
6701 pci_read_config_dword(pdev, bits->reg, &tmp32);
6702 tmp = tmp32;
6703 break;
6706 default:
6707 return -EINVAL;
6710 tmp &= bits->mask;
6712 return (tmp == bits->val) ? 1 : 0;
6715 #ifdef CONFIG_PM
6716 void ata_pci_device_do_suspend(struct pci_dev *pdev, pm_message_t mesg)
6718 pci_save_state(pdev);
6719 pci_disable_device(pdev);
6721 if (mesg.event & PM_EVENT_SLEEP)
6722 pci_set_power_state(pdev, PCI_D3hot);
6725 int ata_pci_device_do_resume(struct pci_dev *pdev)
6727 int rc;
6729 pci_set_power_state(pdev, PCI_D0);
6730 pci_restore_state(pdev);
6732 rc = pcim_enable_device(pdev);
6733 if (rc) {
6734 dev_err(&pdev->dev,
6735 "failed to enable device after resume (%d)\n", rc);
6736 return rc;
6739 pci_set_master(pdev);
6740 return 0;
6743 int ata_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
6745 struct ata_host *host = pci_get_drvdata(pdev);
6746 int rc = 0;
6748 rc = ata_host_suspend(host, mesg);
6749 if (rc)
6750 return rc;
6752 ata_pci_device_do_suspend(pdev, mesg);
6754 return 0;
6757 int ata_pci_device_resume(struct pci_dev *pdev)
6759 struct ata_host *host = pci_get_drvdata(pdev);
6760 int rc;
6762 rc = ata_pci_device_do_resume(pdev);
6763 if (rc == 0)
6764 ata_host_resume(host);
6765 return rc;
6767 #endif /* CONFIG_PM */
6769 #endif /* CONFIG_PCI */
6772 * ata_platform_remove_one - Platform layer callback for device removal
6773 * @pdev: Platform device that was removed
6775 * Platform layer indicates to libata via this hook that hot-unplug or
6776 * module unload event has occurred. Detach all ports. Resource
6777 * release is handled via devres.
6779 * LOCKING:
6780 * Inherited from platform layer (may sleep).
6782 int ata_platform_remove_one(struct platform_device *pdev)
6784 struct ata_host *host = platform_get_drvdata(pdev);
6786 ata_host_detach(host);
6788 return 0;
6791 static int __init ata_parse_force_one(char **cur,
6792 struct ata_force_ent *force_ent,
6793 const char **reason)
6795 static const struct ata_force_param force_tbl[] __initconst = {
6796 { "40c", .cbl = ATA_CBL_PATA40 },
6797 { "80c", .cbl = ATA_CBL_PATA80 },
6798 { "short40c", .cbl = ATA_CBL_PATA40_SHORT },
6799 { "unk", .cbl = ATA_CBL_PATA_UNK },
6800 { "ign", .cbl = ATA_CBL_PATA_IGN },
6801 { "sata", .cbl = ATA_CBL_SATA },
6802 { "1.5Gbps", .spd_limit = 1 },
6803 { "3.0Gbps", .spd_limit = 2 },
6804 { "noncq", .horkage_on = ATA_HORKAGE_NONCQ },
6805 { "ncq", .horkage_off = ATA_HORKAGE_NONCQ },
6806 { "noncqtrim", .horkage_on = ATA_HORKAGE_NO_NCQ_TRIM },
6807 { "ncqtrim", .horkage_off = ATA_HORKAGE_NO_NCQ_TRIM },
6808 { "dump_id", .horkage_on = ATA_HORKAGE_DUMP_ID },
6809 { "pio0", .xfer_mask = 1 << (ATA_SHIFT_PIO + 0) },
6810 { "pio1", .xfer_mask = 1 << (ATA_SHIFT_PIO + 1) },
6811 { "pio2", .xfer_mask = 1 << (ATA_SHIFT_PIO + 2) },
6812 { "pio3", .xfer_mask = 1 << (ATA_SHIFT_PIO + 3) },
6813 { "pio4", .xfer_mask = 1 << (ATA_SHIFT_PIO + 4) },
6814 { "pio5", .xfer_mask = 1 << (ATA_SHIFT_PIO + 5) },
6815 { "pio6", .xfer_mask = 1 << (ATA_SHIFT_PIO + 6) },
6816 { "mwdma0", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 0) },
6817 { "mwdma1", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 1) },
6818 { "mwdma2", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 2) },
6819 { "mwdma3", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 3) },
6820 { "mwdma4", .xfer_mask = 1 << (ATA_SHIFT_MWDMA + 4) },
6821 { "udma0", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6822 { "udma16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6823 { "udma/16", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 0) },
6824 { "udma1", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6825 { "udma25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6826 { "udma/25", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 1) },
6827 { "udma2", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6828 { "udma33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6829 { "udma/33", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 2) },
6830 { "udma3", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6831 { "udma44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6832 { "udma/44", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 3) },
6833 { "udma4", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6834 { "udma66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6835 { "udma/66", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 4) },
6836 { "udma5", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6837 { "udma100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6838 { "udma/100", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 5) },
6839 { "udma6", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6840 { "udma133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6841 { "udma/133", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 6) },
6842 { "udma7", .xfer_mask = 1 << (ATA_SHIFT_UDMA + 7) },
6843 { "nohrst", .lflags = ATA_LFLAG_NO_HRST },
6844 { "nosrst", .lflags = ATA_LFLAG_NO_SRST },
6845 { "norst", .lflags = ATA_LFLAG_NO_HRST | ATA_LFLAG_NO_SRST },
6846 { "rstonce", .lflags = ATA_LFLAG_RST_ONCE },
6847 { "atapi_dmadir", .horkage_on = ATA_HORKAGE_ATAPI_DMADIR },
6848 { "disable", .horkage_on = ATA_HORKAGE_DISABLE },
6850 char *start = *cur, *p = *cur;
6851 char *id, *val, *endp;
6852 const struct ata_force_param *match_fp = NULL;
6853 int nr_matches = 0, i;
6855 /* find where this param ends and update *cur */
6856 while (*p != '\0' && *p != ',')
6857 p++;
6859 if (*p == '\0')
6860 *cur = p;
6861 else
6862 *cur = p + 1;
6864 *p = '\0';
6866 /* parse */
6867 p = strchr(start, ':');
6868 if (!p) {
6869 val = strstrip(start);
6870 goto parse_val;
6872 *p = '\0';
6874 id = strstrip(start);
6875 val = strstrip(p + 1);
6877 /* parse id */
6878 p = strchr(id, '.');
6879 if (p) {
6880 *p++ = '\0';
6881 force_ent->device = simple_strtoul(p, &endp, 10);
6882 if (p == endp || *endp != '\0') {
6883 *reason = "invalid device";
6884 return -EINVAL;
6888 force_ent->port = simple_strtoul(id, &endp, 10);
6889 if (id == endp || *endp != '\0') {
6890 *reason = "invalid port/link";
6891 return -EINVAL;
6894 parse_val:
6895 /* parse val, allow shortcuts so that both 1.5 and 1.5Gbps work */
6896 for (i = 0; i < ARRAY_SIZE(force_tbl); i++) {
6897 const struct ata_force_param *fp = &force_tbl[i];
6899 if (strncasecmp(val, fp->name, strlen(val)))
6900 continue;
6902 nr_matches++;
6903 match_fp = fp;
6905 if (strcasecmp(val, fp->name) == 0) {
6906 nr_matches = 1;
6907 break;
6911 if (!nr_matches) {
6912 *reason = "unknown value";
6913 return -EINVAL;
6915 if (nr_matches > 1) {
6916 *reason = "ambiguous value";
6917 return -EINVAL;
6920 force_ent->param = *match_fp;
6922 return 0;
6925 static void __init ata_parse_force_param(void)
6927 int idx = 0, size = 1;
6928 int last_port = -1, last_device = -1;
6929 char *p, *cur, *next;
6931 /* calculate maximum number of params and allocate force_tbl */
6932 for (p = ata_force_param_buf; *p; p++)
6933 if (*p == ',')
6934 size++;
6936 ata_force_tbl = kzalloc(sizeof(ata_force_tbl[0]) * size, GFP_KERNEL);
6937 if (!ata_force_tbl) {
6938 printk(KERN_WARNING "ata: failed to extend force table, "
6939 "libata.force ignored\n");
6940 return;
6943 /* parse and populate the table */
6944 for (cur = ata_force_param_buf; *cur != '\0'; cur = next) {
6945 const char *reason = "";
6946 struct ata_force_ent te = { .port = -1, .device = -1 };
6948 next = cur;
6949 if (ata_parse_force_one(&next, &te, &reason)) {
6950 printk(KERN_WARNING "ata: failed to parse force "
6951 "parameter \"%s\" (%s)\n",
6952 cur, reason);
6953 continue;
6956 if (te.port == -1) {
6957 te.port = last_port;
6958 te.device = last_device;
6961 ata_force_tbl[idx++] = te;
6963 last_port = te.port;
6964 last_device = te.device;
6967 ata_force_tbl_size = idx;
6970 static int __init ata_init(void)
6972 int rc;
6974 ata_parse_force_param();
6976 rc = ata_sff_init();
6977 if (rc) {
6978 kfree(ata_force_tbl);
6979 return rc;
6982 libata_transport_init();
6983 ata_scsi_transport_template = ata_attach_transport();
6984 if (!ata_scsi_transport_template) {
6985 ata_sff_exit();
6986 rc = -ENOMEM;
6987 goto err_out;
6990 printk(KERN_DEBUG "libata version " DRV_VERSION " loaded.\n");
6991 return 0;
6993 err_out:
6994 return rc;
6997 static void __exit ata_exit(void)
6999 ata_release_transport(ata_scsi_transport_template);
7000 libata_transport_exit();
7001 ata_sff_exit();
7002 kfree(ata_force_tbl);
7005 subsys_initcall(ata_init);
7006 module_exit(ata_exit);
7008 static DEFINE_RATELIMIT_STATE(ratelimit, HZ / 5, 1);
7010 int ata_ratelimit(void)
7012 return __ratelimit(&ratelimit);
7016 * ata_msleep - ATA EH owner aware msleep
7017 * @ap: ATA port to attribute the sleep to
7018 * @msecs: duration to sleep in milliseconds
7020 * Sleeps @msecs. If the current task is owner of @ap's EH, the
7021 * ownership is released before going to sleep and reacquired
7022 * after the sleep is complete. IOW, other ports sharing the
7023 * @ap->host will be allowed to own the EH while this task is
7024 * sleeping.
7026 * LOCKING:
7027 * Might sleep.
7029 void ata_msleep(struct ata_port *ap, unsigned int msecs)
7031 bool owns_eh = ap && ap->host->eh_owner == current;
7033 if (owns_eh)
7034 ata_eh_release(ap);
7036 if (msecs < 20) {
7037 unsigned long usecs = msecs * USEC_PER_MSEC;
7038 usleep_range(usecs, usecs + 50);
7039 } else {
7040 msleep(msecs);
7043 if (owns_eh)
7044 ata_eh_acquire(ap);
7048 * ata_wait_register - wait until register value changes
7049 * @ap: ATA port to wait register for, can be NULL
7050 * @reg: IO-mapped register
7051 * @mask: Mask to apply to read register value
7052 * @val: Wait condition
7053 * @interval: polling interval in milliseconds
7054 * @timeout: timeout in milliseconds
7056 * Waiting for some bits of register to change is a common
7057 * operation for ATA controllers. This function reads 32bit LE
7058 * IO-mapped register @reg and tests for the following condition.
7060 * (*@reg & mask) != val
7062 * If the condition is met, it returns; otherwise, the process is
7063 * repeated after @interval_msec until timeout.
7065 * LOCKING:
7066 * Kernel thread context (may sleep)
7068 * RETURNS:
7069 * The final register value.
7071 u32 ata_wait_register(struct ata_port *ap, void __iomem *reg, u32 mask, u32 val,
7072 unsigned long interval, unsigned long timeout)
7074 unsigned long deadline;
7075 u32 tmp;
7077 tmp = ioread32(reg);
7079 /* Calculate timeout _after_ the first read to make sure
7080 * preceding writes reach the controller before starting to
7081 * eat away the timeout.
7083 deadline = ata_deadline(jiffies, timeout);
7085 while ((tmp & mask) == val && time_before(jiffies, deadline)) {
7086 ata_msleep(ap, interval);
7087 tmp = ioread32(reg);
7090 return tmp;
7094 * sata_lpm_ignore_phy_events - test if PHY event should be ignored
7095 * @link: Link receiving the event
7097 * Test whether the received PHY event has to be ignored or not.
7099 * LOCKING:
7100 * None:
7102 * RETURNS:
7103 * True if the event has to be ignored.
7105 bool sata_lpm_ignore_phy_events(struct ata_link *link)
7107 unsigned long lpm_timeout = link->last_lpm_change +
7108 msecs_to_jiffies(ATA_TMOUT_SPURIOUS_PHY);
7110 /* if LPM is enabled, PHYRDY doesn't mean anything */
7111 if (link->lpm_policy > ATA_LPM_MAX_POWER)
7112 return true;
7114 /* ignore the first PHY event after the LPM policy changed
7115 * as it is might be spurious
7117 if ((link->flags & ATA_LFLAG_CHANGED) &&
7118 time_before(jiffies, lpm_timeout))
7119 return true;
7121 return false;
7123 EXPORT_SYMBOL_GPL(sata_lpm_ignore_phy_events);
7126 * Dummy port_ops
7128 static unsigned int ata_dummy_qc_issue(struct ata_queued_cmd *qc)
7130 return AC_ERR_SYSTEM;
7133 static void ata_dummy_error_handler(struct ata_port *ap)
7135 /* truly dummy */
7138 struct ata_port_operations ata_dummy_port_ops = {
7139 .qc_prep = ata_noop_qc_prep,
7140 .qc_issue = ata_dummy_qc_issue,
7141 .error_handler = ata_dummy_error_handler,
7142 .sched_eh = ata_std_sched_eh,
7143 .end_eh = ata_std_end_eh,
7146 const struct ata_port_info ata_dummy_port_info = {
7147 .port_ops = &ata_dummy_port_ops,
7151 * Utility print functions
7153 void ata_port_printk(const struct ata_port *ap, const char *level,
7154 const char *fmt, ...)
7156 struct va_format vaf;
7157 va_list args;
7159 va_start(args, fmt);
7161 vaf.fmt = fmt;
7162 vaf.va = &args;
7164 printk("%sata%u: %pV", level, ap->print_id, &vaf);
7166 va_end(args);
7168 EXPORT_SYMBOL(ata_port_printk);
7170 void ata_link_printk(const struct ata_link *link, const char *level,
7171 const char *fmt, ...)
7173 struct va_format vaf;
7174 va_list args;
7176 va_start(args, fmt);
7178 vaf.fmt = fmt;
7179 vaf.va = &args;
7181 if (sata_pmp_attached(link->ap) || link->ap->slave_link)
7182 printk("%sata%u.%02u: %pV",
7183 level, link->ap->print_id, link->pmp, &vaf);
7184 else
7185 printk("%sata%u: %pV",
7186 level, link->ap->print_id, &vaf);
7188 va_end(args);
7190 EXPORT_SYMBOL(ata_link_printk);
7192 void ata_dev_printk(const struct ata_device *dev, const char *level,
7193 const char *fmt, ...)
7195 struct va_format vaf;
7196 va_list args;
7198 va_start(args, fmt);
7200 vaf.fmt = fmt;
7201 vaf.va = &args;
7203 printk("%sata%u.%02u: %pV",
7204 level, dev->link->ap->print_id, dev->link->pmp + dev->devno,
7205 &vaf);
7207 va_end(args);
7209 EXPORT_SYMBOL(ata_dev_printk);
7211 void ata_print_version(const struct device *dev, const char *version)
7213 dev_printk(KERN_DEBUG, dev, "version %s\n", version);
7215 EXPORT_SYMBOL(ata_print_version);
7218 * libata is essentially a library of internal helper functions for
7219 * low-level ATA host controller drivers. As such, the API/ABI is
7220 * likely to change as new drivers are added and updated.
7221 * Do not depend on ABI/API stability.
7223 EXPORT_SYMBOL_GPL(sata_deb_timing_normal);
7224 EXPORT_SYMBOL_GPL(sata_deb_timing_hotplug);
7225 EXPORT_SYMBOL_GPL(sata_deb_timing_long);
7226 EXPORT_SYMBOL_GPL(ata_base_port_ops);
7227 EXPORT_SYMBOL_GPL(sata_port_ops);
7228 EXPORT_SYMBOL_GPL(ata_dummy_port_ops);
7229 EXPORT_SYMBOL_GPL(ata_dummy_port_info);
7230 EXPORT_SYMBOL_GPL(ata_link_next);
7231 EXPORT_SYMBOL_GPL(ata_dev_next);
7232 EXPORT_SYMBOL_GPL(ata_std_bios_param);
7233 EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
7234 EXPORT_SYMBOL_GPL(ata_host_init);
7235 EXPORT_SYMBOL_GPL(ata_host_alloc);
7236 EXPORT_SYMBOL_GPL(ata_host_alloc_pinfo);
7237 EXPORT_SYMBOL_GPL(ata_slave_link_init);
7238 EXPORT_SYMBOL_GPL(ata_host_start);
7239 EXPORT_SYMBOL_GPL(ata_host_register);
7240 EXPORT_SYMBOL_GPL(ata_host_activate);
7241 EXPORT_SYMBOL_GPL(ata_host_detach);
7242 EXPORT_SYMBOL_GPL(ata_sg_init);
7243 EXPORT_SYMBOL_GPL(ata_qc_complete);
7244 EXPORT_SYMBOL_GPL(ata_qc_complete_multiple);
7245 EXPORT_SYMBOL_GPL(atapi_cmd_type);
7246 EXPORT_SYMBOL_GPL(ata_tf_to_fis);
7247 EXPORT_SYMBOL_GPL(ata_tf_from_fis);
7248 EXPORT_SYMBOL_GPL(ata_pack_xfermask);
7249 EXPORT_SYMBOL_GPL(ata_unpack_xfermask);
7250 EXPORT_SYMBOL_GPL(ata_xfer_mask2mode);
7251 EXPORT_SYMBOL_GPL(ata_xfer_mode2mask);
7252 EXPORT_SYMBOL_GPL(ata_xfer_mode2shift);
7253 EXPORT_SYMBOL_GPL(ata_mode_string);
7254 EXPORT_SYMBOL_GPL(ata_id_xfermask);
7255 EXPORT_SYMBOL_GPL(ata_do_set_mode);
7256 EXPORT_SYMBOL_GPL(ata_std_qc_defer);
7257 EXPORT_SYMBOL_GPL(ata_noop_qc_prep);
7258 EXPORT_SYMBOL_GPL(ata_dev_disable);
7259 EXPORT_SYMBOL_GPL(sata_set_spd);
7260 EXPORT_SYMBOL_GPL(ata_wait_after_reset);
7261 EXPORT_SYMBOL_GPL(sata_link_debounce);
7262 EXPORT_SYMBOL_GPL(sata_link_resume);
7263 EXPORT_SYMBOL_GPL(sata_link_scr_lpm);
7264 EXPORT_SYMBOL_GPL(ata_std_prereset);
7265 EXPORT_SYMBOL_GPL(sata_link_hardreset);
7266 EXPORT_SYMBOL_GPL(sata_std_hardreset);
7267 EXPORT_SYMBOL_GPL(ata_std_postreset);
7268 EXPORT_SYMBOL_GPL(ata_dev_classify);
7269 EXPORT_SYMBOL_GPL(ata_dev_pair);
7270 EXPORT_SYMBOL_GPL(ata_ratelimit);
7271 EXPORT_SYMBOL_GPL(ata_msleep);
7272 EXPORT_SYMBOL_GPL(ata_wait_register);
7273 EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
7274 EXPORT_SYMBOL_GPL(ata_scsi_slave_config);
7275 EXPORT_SYMBOL_GPL(ata_scsi_slave_destroy);
7276 EXPORT_SYMBOL_GPL(ata_scsi_change_queue_depth);
7277 EXPORT_SYMBOL_GPL(__ata_change_queue_depth);
7278 EXPORT_SYMBOL_GPL(sata_scr_valid);
7279 EXPORT_SYMBOL_GPL(sata_scr_read);
7280 EXPORT_SYMBOL_GPL(sata_scr_write);
7281 EXPORT_SYMBOL_GPL(sata_scr_write_flush);
7282 EXPORT_SYMBOL_GPL(ata_link_online);
7283 EXPORT_SYMBOL_GPL(ata_link_offline);
7284 #ifdef CONFIG_PM
7285 EXPORT_SYMBOL_GPL(ata_host_suspend);
7286 EXPORT_SYMBOL_GPL(ata_host_resume);
7287 #endif /* CONFIG_PM */
7288 EXPORT_SYMBOL_GPL(ata_id_string);
7289 EXPORT_SYMBOL_GPL(ata_id_c_string);
7290 EXPORT_SYMBOL_GPL(ata_do_dev_read_id);
7291 EXPORT_SYMBOL_GPL(ata_scsi_simulate);
7293 EXPORT_SYMBOL_GPL(ata_pio_need_iordy);
7294 EXPORT_SYMBOL_GPL(ata_timing_find_mode);
7295 EXPORT_SYMBOL_GPL(ata_timing_compute);
7296 EXPORT_SYMBOL_GPL(ata_timing_merge);
7297 EXPORT_SYMBOL_GPL(ata_timing_cycle2mode);
7299 #ifdef CONFIG_PCI
7300 EXPORT_SYMBOL_GPL(pci_test_config_bits);
7301 EXPORT_SYMBOL_GPL(ata_pci_remove_one);
7302 #ifdef CONFIG_PM
7303 EXPORT_SYMBOL_GPL(ata_pci_device_do_suspend);
7304 EXPORT_SYMBOL_GPL(ata_pci_device_do_resume);
7305 EXPORT_SYMBOL_GPL(ata_pci_device_suspend);
7306 EXPORT_SYMBOL_GPL(ata_pci_device_resume);
7307 #endif /* CONFIG_PM */
7308 #endif /* CONFIG_PCI */
7310 EXPORT_SYMBOL_GPL(ata_platform_remove_one);
7312 EXPORT_SYMBOL_GPL(__ata_ehi_push_desc);
7313 EXPORT_SYMBOL_GPL(ata_ehi_push_desc);
7314 EXPORT_SYMBOL_GPL(ata_ehi_clear_desc);
7315 EXPORT_SYMBOL_GPL(ata_port_desc);
7316 #ifdef CONFIG_PCI
7317 EXPORT_SYMBOL_GPL(ata_port_pbar_desc);
7318 #endif /* CONFIG_PCI */
7319 EXPORT_SYMBOL_GPL(ata_port_schedule_eh);
7320 EXPORT_SYMBOL_GPL(ata_link_abort);
7321 EXPORT_SYMBOL_GPL(ata_port_abort);
7322 EXPORT_SYMBOL_GPL(ata_port_freeze);
7323 EXPORT_SYMBOL_GPL(sata_async_notification);
7324 EXPORT_SYMBOL_GPL(ata_eh_freeze_port);
7325 EXPORT_SYMBOL_GPL(ata_eh_thaw_port);
7326 EXPORT_SYMBOL_GPL(ata_eh_qc_complete);
7327 EXPORT_SYMBOL_GPL(ata_eh_qc_retry);
7328 EXPORT_SYMBOL_GPL(ata_eh_analyze_ncq_error);
7329 EXPORT_SYMBOL_GPL(ata_do_eh);
7330 EXPORT_SYMBOL_GPL(ata_std_error_handler);
7332 EXPORT_SYMBOL_GPL(ata_cable_40wire);
7333 EXPORT_SYMBOL_GPL(ata_cable_80wire);
7334 EXPORT_SYMBOL_GPL(ata_cable_unknown);
7335 EXPORT_SYMBOL_GPL(ata_cable_ignore);
7336 EXPORT_SYMBOL_GPL(ata_cable_sata);