// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  libata-core.c - helper library for ATA
 *
 *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
 *  Copyright 2003-2004 Jeff Garzik
 *
 *  libata documentation is available via 'make {ps|pdf}docs',
 *  as Documentation/driver-api/libata.rst
 *
 *  Hardware documentation available from http://www.t13.org/ and
 *  http://www.sata-io.org/
 *
 *  Standards documents from:
 *      http://www.t13.org (ATA standards, PCI DMA IDE spec)
 *      http://www.t10.org (SCSI MMC - for ATAPI MMC)
 *      http://www.sata-io.org (SATA)
 *      http://www.compactflash.org (CF)
 *      http://www.qic.org (QIC157 - Tape and DSC)
 *      http://www.ce-ata.org (CE-ATA: not supported)
 *
 * libata is essentially a library of internal helper functions for
 * low-level ATA host controller drivers.  As such, the API/ABI is
 * likely to change as new drivers are added and updated.
 * Do not depend on ABI/API stability.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/init.h>
#include <linux/list.h>
#include <linux/mm.h>
#include <linux/spinlock.h>
#include <linux/blkdev.h>
#include <linux/delay.h>
#include <linux/timer.h>
#include <linux/time.h>
#include <linux/interrupt.h>
#include <linux/completion.h>
#include <linux/suspend.h>
#include <linux/workqueue.h>
#include <linux/scatterlist.h>
#include <linux/io.h>
#include <linux/log2.h>
#include <linux/slab.h>
#include <linux/glob.h>
#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_host.h>
#include <linux/libata.h>
#include <asm/byteorder.h>
#include <asm/unaligned.h>
#include <linux/cdrom.h>
#include <linux/ratelimit.h>
#include <linux/leds.h>
#include <linux/pm_runtime.h>
#include <linux/platform_device.h>
#include <asm/setup.h>

#define CREATE_TRACE_POINTS
#include <trace/events/libata.h>

#include "libata.h"
#include "libata-transport.h"

const struct ata_port_operations ata_base_port_ops = {
        .prereset               = ata_std_prereset,
        .postreset              = ata_std_postreset,
        .error_handler          = ata_std_error_handler,
        .sched_eh               = ata_std_sched_eh,
        .end_eh                 = ata_std_end_eh,
};

const struct ata_port_operations sata_port_ops = {
        .inherits               = &ata_base_port_ops,

        .qc_defer               = ata_std_qc_defer,
        .hardreset              = sata_std_hardreset,
};
EXPORT_SYMBOL_GPL(sata_port_ops);

static unsigned int ata_dev_init_params(struct ata_device *dev,
                                        u16 heads, u16 sectors);
static unsigned int ata_dev_set_xfermode(struct ata_device *dev);
static void ata_dev_xfermask(struct ata_device *dev);
static unsigned long ata_dev_blacklisted(const struct ata_device *dev);

atomic_t ata_print_id = ATOMIC_INIT(0);

#ifdef CONFIG_ATA_FORCE
struct ata_force_param {
        const char      *name;
        u8              cbl;
        u8              spd_limit;
        unsigned long   xfer_mask;
        unsigned int    horkage_on;
        unsigned int    horkage_off;
        u16             lflags;
};

struct ata_force_ent {
        int                     port;
        int                     device;
        struct ata_force_param  param;
};

static struct ata_force_ent *ata_force_tbl;
static int ata_force_tbl_size;

static char ata_force_param_buf[COMMAND_LINE_SIZE] __initdata;
/* param_buf is thrown away after initialization, disallow read */
module_param_string(force, ata_force_param_buf, sizeof(ata_force_param_buf), 0);
MODULE_PARM_DESC(force, "Force ATA configurations including cable type, link speed and transfer mode (see Documentation/admin-guide/kernel-parameters.rst for details)");
#endif

static int atapi_enabled = 1;
module_param(atapi_enabled, int, 0444);
MODULE_PARM_DESC(atapi_enabled, "Enable discovery of ATAPI devices (0=off, 1=on [default])");

static int atapi_dmadir = 0;
module_param(atapi_dmadir, int, 0444);
MODULE_PARM_DESC(atapi_dmadir, "Enable ATAPI DMADIR bridge support (0=off [default], 1=on)");

int atapi_passthru16 = 1;
module_param(atapi_passthru16, int, 0444);
MODULE_PARM_DESC(atapi_passthru16, "Enable ATA_16 passthru for ATAPI devices (0=off, 1=on [default])");

int libata_fua = 0;
module_param_named(fua, libata_fua, int, 0444);
MODULE_PARM_DESC(fua, "FUA support (0=off [default], 1=on)");

static int ata_ignore_hpa;
module_param_named(ignore_hpa, ata_ignore_hpa, int, 0644);
MODULE_PARM_DESC(ignore_hpa, "Ignore HPA limit (0=keep BIOS limits, 1=ignore limits, using full disk)");

static int libata_dma_mask = ATA_DMA_MASK_ATA|ATA_DMA_MASK_ATAPI|ATA_DMA_MASK_CFA;
module_param_named(dma, libata_dma_mask, int, 0444);
MODULE_PARM_DESC(dma, "DMA enable/disable (0x1==ATA, 0x2==ATAPI, 0x4==CF)");

static int ata_probe_timeout;
module_param(ata_probe_timeout, int, 0444);
MODULE_PARM_DESC(ata_probe_timeout, "Set ATA probing timeout (seconds)");

int libata_noacpi = 0;
module_param_named(noacpi, libata_noacpi, int, 0444);
MODULE_PARM_DESC(noacpi, "Disable the use of ACPI in probe/suspend/resume (0=off [default], 1=on)");

int libata_allow_tpm = 0;
module_param_named(allow_tpm, libata_allow_tpm, int, 0444);
MODULE_PARM_DESC(allow_tpm, "Permit the use of TPM commands (0=off [default], 1=on)");

static int atapi_an;
module_param(atapi_an, int, 0444);
MODULE_PARM_DESC(atapi_an, "Enable ATAPI AN media presence notification (0=0ff [default], 1=on)");

MODULE_AUTHOR("Jeff Garzik");
MODULE_DESCRIPTION("Library module for ATA devices");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);


static bool ata_sstatus_online(u32 sstatus)
{
        return (sstatus & 0xf) == 0x3;
}

/**
 *      ata_link_next - link iteration helper
 *      @link: the previous link, NULL to start
 *      @ap: ATA port containing links to iterate
 *      @mode: iteration mode, one of ATA_LITER_*
 *
 *      LOCKING:
 *      Host lock or EH context.
 *
 *      RETURNS:
 *      Pointer to the next link.
 */
struct ata_link *ata_link_next(struct ata_link *link, struct ata_port *ap,
                               enum ata_link_iter_mode mode)
{
        BUG_ON(mode != ATA_LITER_EDGE &&
               mode != ATA_LITER_PMP_FIRST && mode != ATA_LITER_HOST_FIRST);

        /* NULL link indicates start of iteration */
        if (!link)
                switch (mode) {
                case ATA_LITER_EDGE:
                case ATA_LITER_PMP_FIRST:
                        if (sata_pmp_attached(ap))
                                return ap->pmp_link;
                        fallthrough;
                case ATA_LITER_HOST_FIRST:
                        return &ap->link;
                }

        /* we just iterated over the host link, what's next? */
        if (link == &ap->link)
                switch (mode) {
                case ATA_LITER_HOST_FIRST:
                        if (sata_pmp_attached(ap))
                                return ap->pmp_link;
                        fallthrough;
                case ATA_LITER_PMP_FIRST:
                        if (unlikely(ap->slave_link))
                                return ap->slave_link;
                        fallthrough;
                case ATA_LITER_EDGE:
                        return NULL;
                }

        /* slave_link excludes PMP */
        if (unlikely(link == ap->slave_link))
                return NULL;

        /* we were over a PMP link */
        if (++link < ap->pmp_link + ap->nr_pmp_links)
                return link;

        if (mode == ATA_LITER_PMP_FIRST)
                return &ap->link;

        return NULL;
}
EXPORT_SYMBOL_GPL(ata_link_next);

/**
 *      ata_dev_next - device iteration helper
 *      @dev: the previous device, NULL to start
 *      @link: ATA link containing devices to iterate
 *      @mode: iteration mode, one of ATA_DITER_*
 *
 *      LOCKING:
 *      Host lock or EH context.
 *
 *      RETURNS:
 *      Pointer to the next device.
 */
struct ata_device *ata_dev_next(struct ata_device *dev, struct ata_link *link,
                                enum ata_dev_iter_mode mode)
{
        BUG_ON(mode != ATA_DITER_ENABLED && mode != ATA_DITER_ENABLED_REVERSE &&
               mode != ATA_DITER_ALL && mode != ATA_DITER_ALL_REVERSE);

        /* NULL dev indicates start of iteration */
        if (!dev)
                switch (mode) {
                case ATA_DITER_ENABLED:
                case ATA_DITER_ALL:
                        dev = link->device;
                        goto check;
                case ATA_DITER_ENABLED_REVERSE:
                case ATA_DITER_ALL_REVERSE:
                        dev = link->device + ata_link_max_devices(link) - 1;
                        goto check;
                }

 next:
        /* move to the next one */
        switch (mode) {
        case ATA_DITER_ENABLED:
        case ATA_DITER_ALL:
                if (++dev < link->device + ata_link_max_devices(link))
                        goto check;
                return NULL;
        case ATA_DITER_ENABLED_REVERSE:
        case ATA_DITER_ALL_REVERSE:
                if (--dev >= link->device)
                        goto check;
                return NULL;
        }

 check:
        if ((mode == ATA_DITER_ENABLED || mode == ATA_DITER_ENABLED_REVERSE) &&
            !ata_dev_enabled(dev))
                goto next;
        return dev;
}
EXPORT_SYMBOL_GPL(ata_dev_next);

/**
 *      ata_dev_phys_link - find physical link for a device
 *      @dev: ATA device to look up physical link for
 *
 *      Look up physical link which @dev is attached to.  Note that
 *      this is different from @dev->link only when @dev is on slave
 *      link.  For all other cases, it's the same as @dev->link.
 *
 *      LOCKING:
 *      Don't care.
 *
 *      RETURNS:
 *      Pointer to the found physical link.
 */
struct ata_link *ata_dev_phys_link(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;

        if (!ap->slave_link)
                return dev->link;
        if (!dev->devno)
                return &ap->link;
        return ap->slave_link;
}

#ifdef CONFIG_ATA_FORCE
/**
 *      ata_force_cbl - force cable type according to libata.force
 *      @ap: ATA port of interest
 *
 *      Force cable type according to libata.force and whine about it.
 *      The last entry which has matching port number is used, so it
 *      can be specified as part of device force parameters.  For
 *      example, both "a:40c,1.00:udma4" and "1.00:40c,udma4" have the
 *      same effect.
 *
 *      LOCKING:
 *      EH context.
 */
void ata_force_cbl(struct ata_port *ap)
{
        int i;

        for (i = ata_force_tbl_size - 1; i >= 0; i--) {
                const struct ata_force_ent *fe = &ata_force_tbl[i];

                if (fe->port != -1 && fe->port != ap->print_id)
                        continue;

                if (fe->param.cbl == ATA_CBL_NONE)
                        continue;

                ap->cbl = fe->param.cbl;
                ata_port_notice(ap, "FORCE: cable set to %s\n", fe->param.name);
                return;
        }
}

/**
 *      ata_force_link_limits - force link limits according to libata.force
 *      @link: ATA link of interest
 *
 *      Force link flags and SATA spd limit according to libata.force
 *      and whine about it.  When only the port part is specified
 *      (e.g. 1:), the limit applies to all links connected to both
 *      the host link and all fan-out ports connected via PMP.  If the
 *      device part is specified as 0 (e.g. 1.00:), it specifies the
 *      first fan-out link not the host link.  Device number 15 always
 *      points to the host link whether PMP is attached or not.  If the
 *      controller has slave link, device number 16 points to it.
 *
 *      LOCKING:
 *      EH context.
 */
static void ata_force_link_limits(struct ata_link *link)
{
        bool did_spd = false;
        int linkno = link->pmp;
        int i;

        if (ata_is_host_link(link))
                linkno += 15;

        for (i = ata_force_tbl_size - 1; i >= 0; i--) {
                const struct ata_force_ent *fe = &ata_force_tbl[i];

                if (fe->port != -1 && fe->port != link->ap->print_id)
                        continue;

                if (fe->device != -1 && fe->device != linkno)
                        continue;

                /* only honor the first spd limit */
                if (!did_spd && fe->param.spd_limit) {
                        link->hw_sata_spd_limit = (1 << fe->param.spd_limit) - 1;
                        ata_link_notice(link, "FORCE: PHY spd limit set to %s\n",
                                        fe->param.name);
                        did_spd = true;
                }

                /* let lflags stack */
                if (fe->param.lflags) {
                        link->flags |= fe->param.lflags;
                        ata_link_notice(link,
                                        "FORCE: link flag 0x%x forced -> 0x%x\n",
                                        fe->param.lflags, link->flags);
                }
        }
}

/**
 *      ata_force_xfermask - force xfermask according to libata.force
 *      @dev: ATA device of interest
 *
 *      Force xfer_mask according to libata.force and whine about it.
 *      For consistency with link selection, device number 15 selects
 *      the first device connected to the host link.
 *
 *      LOCKING:
 *      EH context.
 */
static void ata_force_xfermask(struct ata_device *dev)
{
        int devno = dev->link->pmp + dev->devno;
        int alt_devno = devno;
        int i;

        /* allow n.15/16 for devices attached to host port */
        if (ata_is_host_link(dev->link))
                alt_devno += 15;

        for (i = ata_force_tbl_size - 1; i >= 0; i--) {
                const struct ata_force_ent *fe = &ata_force_tbl[i];
                unsigned long pio_mask, mwdma_mask, udma_mask;

                if (fe->port != -1 && fe->port != dev->link->ap->print_id)
                        continue;

                if (fe->device != -1 && fe->device != devno &&
                    fe->device != alt_devno)
                        continue;

                if (!fe->param.xfer_mask)
                        continue;

                ata_unpack_xfermask(fe->param.xfer_mask,
                                    &pio_mask, &mwdma_mask, &udma_mask);
                if (udma_mask)
                        dev->udma_mask = udma_mask;
                else if (mwdma_mask) {
                        dev->udma_mask = 0;
                        dev->mwdma_mask = mwdma_mask;
                } else {
                        dev->udma_mask = 0;
                        dev->mwdma_mask = 0;
                        dev->pio_mask = pio_mask;
                }

                ata_dev_notice(dev, "FORCE: xfer_mask set to %s\n",
                               fe->param.name);
                return;
        }
}

/**
 *      ata_force_horkage - force horkage according to libata.force
 *      @dev: ATA device of interest
 *
 *      Force horkage according to libata.force and whine about it.
 *      For consistency with link selection, device number 15 selects
 *      the first device connected to the host link.
 *
 *      LOCKING:
 *      EH context.
 */
static void ata_force_horkage(struct ata_device *dev)
{
        int devno = dev->link->pmp + dev->devno;
        int alt_devno = devno;
        int i;

        /* allow n.15/16 for devices attached to host port */
        if (ata_is_host_link(dev->link))
                alt_devno += 15;

        for (i = 0; i < ata_force_tbl_size; i++) {
                const struct ata_force_ent *fe = &ata_force_tbl[i];

                if (fe->port != -1 && fe->port != dev->link->ap->print_id)
                        continue;

                if (fe->device != -1 && fe->device != devno &&
                    fe->device != alt_devno)
                        continue;

                if (!(~dev->horkage & fe->param.horkage_on) &&
                    !(dev->horkage & fe->param.horkage_off))
                        continue;

                dev->horkage |= fe->param.horkage_on;
                dev->horkage &= ~fe->param.horkage_off;

                ata_dev_notice(dev, "FORCE: horkage modified (%s)\n",
                               fe->param.name);
        }
}
#else
static inline void ata_force_link_limits(struct ata_link *link) { }
static inline void ata_force_xfermask(struct ata_device *dev) { }
static inline void ata_force_horkage(struct ata_device *dev) { }
#endif

/**
 *      atapi_cmd_type - Determine ATAPI command type from SCSI opcode
 *      @opcode: SCSI opcode
 *
 *      Determine ATAPI command type from @opcode.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      ATAPI_{READ|WRITE|READ_CD|PASS_THRU|MISC}
 */
int atapi_cmd_type(u8 opcode)
{
        switch (opcode) {
        case GPCMD_READ_10:
        case GPCMD_READ_12:
                return ATAPI_READ;

        case GPCMD_WRITE_10:
        case GPCMD_WRITE_12:
        case GPCMD_WRITE_AND_VERIFY_10:
                return ATAPI_WRITE;

        case GPCMD_READ_CD:
        case GPCMD_READ_CD_MSF:
                return ATAPI_READ_CD;

        case ATA_16:
        case ATA_12:
                if (atapi_passthru16)
                        return ATAPI_PASS_THRU;
                fallthrough;
        default:
                return ATAPI_MISC;
        }
}
EXPORT_SYMBOL_GPL(atapi_cmd_type);

static const u8 ata_rw_cmds[] = {
        /* pio multi */
        ATA_CMD_READ_MULTI,
        ATA_CMD_WRITE_MULTI,
        ATA_CMD_READ_MULTI_EXT,
        ATA_CMD_WRITE_MULTI_EXT,
        0,
        0,
        0,
        ATA_CMD_WRITE_MULTI_FUA_EXT,
        /* pio */
        ATA_CMD_PIO_READ,
        ATA_CMD_PIO_WRITE,
        ATA_CMD_PIO_READ_EXT,
        ATA_CMD_PIO_WRITE_EXT,
        0,
        0,
        0,
        0,
        /* dma */
        ATA_CMD_READ,
        ATA_CMD_WRITE,
        ATA_CMD_READ_EXT,
        ATA_CMD_WRITE_EXT,
        0,
        0,
        0,
        ATA_CMD_WRITE_FUA_EXT
};

/**
 *      ata_rwcmd_protocol - set taskfile r/w commands and protocol
 *      @tf: command to examine and configure
 *      @dev: device tf belongs to
 *
 *      Examine the device configuration and tf->flags to calculate
 *      the proper read/write commands and protocol to use.
 *
 *      LOCKING:
 *      caller.
 */
static int ata_rwcmd_protocol(struct ata_taskfile *tf, struct ata_device *dev)
{
        u8 cmd;

        int index, fua, lba48, write;

        fua = (tf->flags & ATA_TFLAG_FUA) ? 4 : 0;
        lba48 = (tf->flags & ATA_TFLAG_LBA48) ? 2 : 0;
        write = (tf->flags & ATA_TFLAG_WRITE) ? 1 : 0;

        if (dev->flags & ATA_DFLAG_PIO) {
                tf->protocol = ATA_PROT_PIO;
                index = dev->multi_count ? 0 : 8;
        } else if (lba48 && (dev->link->ap->flags & ATA_FLAG_PIO_LBA48)) {
                /* Unable to use DMA due to host limitation */
                tf->protocol = ATA_PROT_PIO;
                index = dev->multi_count ? 0 : 8;
        } else {
                tf->protocol = ATA_PROT_DMA;
                index = 16;
        }

        cmd = ata_rw_cmds[index + fua + lba48 + write];
        if (cmd) {
                tf->command = cmd;
                return 0;
        }
        return -1;
}

/**
 *      ata_tf_read_block - Read block address from ATA taskfile
 *      @tf: ATA taskfile of interest
 *      @dev: ATA device @tf belongs to
 *
 *      LOCKING:
 *      None.
 *
 *      Read block address from @tf.  This function can handle all
 *      three address formats - LBA, LBA48 and CHS.  tf->protocol and
 *      flags select the address format to use.
 *
 *      RETURNS:
 *      Block address read from @tf.
 */
u64 ata_tf_read_block(const struct ata_taskfile *tf, struct ata_device *dev)
{
        u64 block = 0;

        if (tf->flags & ATA_TFLAG_LBA) {
                if (tf->flags & ATA_TFLAG_LBA48) {
                        block |= (u64)tf->hob_lbah << 40;
                        block |= (u64)tf->hob_lbam << 32;
                        block |= (u64)tf->hob_lbal << 24;
                } else
                        block |= (tf->device & 0xf) << 24;

                block |= tf->lbah << 16;
                block |= tf->lbam << 8;
                block |= tf->lbal;
        } else {
                u32 cyl, head, sect;

                cyl = tf->lbam | (tf->lbah << 8);
                head = tf->device & 0xf;
                sect = tf->lbal;

                if (!sect) {
                        ata_dev_warn(dev,
                                     "device reported invalid CHS sector 0\n");
                        return U64_MAX;
                }

                block = (cyl * dev->heads + head) * dev->sectors + sect - 1;
        }

        return block;
}

/**
 *      ata_build_rw_tf - Build ATA taskfile for given read/write request
 *      @tf: Target ATA taskfile
 *      @dev: ATA device @tf belongs to
 *      @block: Block address
 *      @n_block: Number of blocks
 *      @tf_flags: RW/FUA etc...
 *      @tag: tag
 *      @class: IO priority class
 *
 *      LOCKING:
 *      None.
 *
 *      Build ATA taskfile @tf for read/write request described by
 *      @block, @n_block, @tf_flags and @tag on @dev.
 *
 *      RETURNS:
 *
 *      0 on success, -ERANGE if the request is too large for @dev,
 *      -EINVAL if the request is invalid.
 */
int ata_build_rw_tf(struct ata_taskfile *tf, struct ata_device *dev,
                    u64 block, u32 n_block, unsigned int tf_flags,
                    unsigned int tag, int class)
{
        tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
        tf->flags |= tf_flags;

        if (ata_ncq_enabled(dev) && !ata_tag_internal(tag)) {
                /* yay, NCQ */
                if (!lba_48_ok(block, n_block))
                        return -ERANGE;

                tf->protocol = ATA_PROT_NCQ;
                tf->flags |= ATA_TFLAG_LBA | ATA_TFLAG_LBA48;

                if (tf->flags & ATA_TFLAG_WRITE)
                        tf->command = ATA_CMD_FPDMA_WRITE;
                else
                        tf->command = ATA_CMD_FPDMA_READ;

                tf->nsect = tag << 3;
                tf->hob_feature = (n_block >> 8) & 0xff;
                tf->feature = n_block & 0xff;

                tf->hob_lbah = (block >> 40) & 0xff;
                tf->hob_lbam = (block >> 32) & 0xff;
                tf->hob_lbal = (block >> 24) & 0xff;
                tf->lbah = (block >> 16) & 0xff;
                tf->lbam = (block >> 8) & 0xff;
                tf->lbal = block & 0xff;

                tf->device = ATA_LBA;
                if (tf->flags & ATA_TFLAG_FUA)
                        tf->device |= 1 << 7;

                if (dev->flags & ATA_DFLAG_NCQ_PRIO) {
                        if (class == IOPRIO_CLASS_RT)
                                tf->hob_nsect |= ATA_PRIO_HIGH <<
                                                 ATA_SHIFT_PRIO;
                }
        } else if (dev->flags & ATA_DFLAG_LBA) {
                tf->flags |= ATA_TFLAG_LBA;

                if (lba_28_ok(block, n_block)) {
                        /* use LBA28 */
                        tf->device |= (block >> 24) & 0xf;
                } else if (lba_48_ok(block, n_block)) {
                        if (!(dev->flags & ATA_DFLAG_LBA48))
                                return -ERANGE;

                        /* use LBA48 */
                        tf->flags |= ATA_TFLAG_LBA48;

                        tf->hob_nsect = (n_block >> 8) & 0xff;

                        tf->hob_lbah = (block >> 40) & 0xff;
                        tf->hob_lbam = (block >> 32) & 0xff;
                        tf->hob_lbal = (block >> 24) & 0xff;
                } else
                        /* request too large even for LBA48 */
                        return -ERANGE;

                if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
                        return -EINVAL;

                tf->nsect = n_block & 0xff;

                tf->lbah = (block >> 16) & 0xff;
                tf->lbam = (block >> 8) & 0xff;
                tf->lbal = block & 0xff;

                tf->device |= ATA_LBA;
        } else {
                /* CHS */
                u32 sect, head, cyl, track;

                /* The request -may- be too large for CHS addressing. */
                if (!lba_28_ok(block, n_block))
                        return -ERANGE;

                if (unlikely(ata_rwcmd_protocol(tf, dev) < 0))
                        return -EINVAL;

                /* Convert LBA to CHS */
                track = (u32)block / dev->sectors;
                cyl   = track / dev->heads;
                head  = track % dev->heads;
                sect  = (u32)block % dev->sectors + 1;

                DPRINTK("block %u track %u cyl %u head %u sect %u\n",
                        (u32)block, track, cyl, head, sect);

                /* Check whether the converted CHS can fit.
                   Cylinder: 0-65535
                   Head: 0-15
                   Sector: 1-255*/
                if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
                        return -ERANGE;

                tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
                tf->lbal = sect;
                tf->lbam = cyl;
                tf->lbah = cyl >> 8;
                tf->device |= head;
        }

        return 0;
}

/**
 *      ata_pack_xfermask - Pack pio, mwdma and udma masks into xfer_mask
 *      @pio_mask: pio_mask
 *      @mwdma_mask: mwdma_mask
 *      @udma_mask: udma_mask
 *
 *      Pack @pio_mask, @mwdma_mask and @udma_mask into a single
 *      unsigned int xfer_mask.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Packed xfer_mask.
 */
unsigned long ata_pack_xfermask(unsigned long pio_mask,
                                unsigned long mwdma_mask,
                                unsigned long udma_mask)
{
        return ((pio_mask << ATA_SHIFT_PIO) & ATA_MASK_PIO) |
                ((mwdma_mask << ATA_SHIFT_MWDMA) & ATA_MASK_MWDMA) |
                ((udma_mask << ATA_SHIFT_UDMA) & ATA_MASK_UDMA);
}
EXPORT_SYMBOL_GPL(ata_pack_xfermask);

/**
 *      ata_unpack_xfermask - Unpack xfer_mask into pio, mwdma and udma masks
 *      @xfer_mask: xfer_mask to unpack
 *      @pio_mask: resulting pio_mask
 *      @mwdma_mask: resulting mwdma_mask
 *      @udma_mask: resulting udma_mask
 *
 *      Unpack @xfer_mask into @pio_mask, @mwdma_mask and @udma_mask.
 *      Any NULL destination masks will be ignored.
 */
void ata_unpack_xfermask(unsigned long xfer_mask, unsigned long *pio_mask,
                         unsigned long *mwdma_mask, unsigned long *udma_mask)
{
        if (pio_mask)
                *pio_mask = (xfer_mask & ATA_MASK_PIO) >> ATA_SHIFT_PIO;
        if (mwdma_mask)
                *mwdma_mask = (xfer_mask & ATA_MASK_MWDMA) >> ATA_SHIFT_MWDMA;
        if (udma_mask)
                *udma_mask = (xfer_mask & ATA_MASK_UDMA) >> ATA_SHIFT_UDMA;
}

static const struct ata_xfer_ent {
        int shift, bits;
        u8 base;
} ata_xfer_tbl[] = {
        { ATA_SHIFT_PIO, ATA_NR_PIO_MODES, XFER_PIO_0 },
        { ATA_SHIFT_MWDMA, ATA_NR_MWDMA_MODES, XFER_MW_DMA_0 },
        { ATA_SHIFT_UDMA, ATA_NR_UDMA_MODES, XFER_UDMA_0 },
        { -1, },
};

/**
 *      ata_xfer_mask2mode - Find matching XFER_* for the given xfer_mask
 *      @xfer_mask: xfer_mask of interest
 *
 *      Return matching XFER_* value for @xfer_mask.  Only the highest
 *      bit of @xfer_mask is considered.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Matching XFER_* value, 0xff if no match found.
 */
u8 ata_xfer_mask2mode(unsigned long xfer_mask)
{
        int highbit = fls(xfer_mask) - 1;
        const struct ata_xfer_ent *ent;

        for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
                if (highbit >= ent->shift && highbit < ent->shift + ent->bits)
                        return ent->base + highbit - ent->shift;
        return 0xff;
}
EXPORT_SYMBOL_GPL(ata_xfer_mask2mode);

/**
 *      ata_xfer_mode2mask - Find matching xfer_mask for XFER_*
 *      @xfer_mode: XFER_* of interest
 *
 *      Return matching xfer_mask for @xfer_mode.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Matching xfer_mask, 0 if no match found.
 */
unsigned long ata_xfer_mode2mask(u8 xfer_mode)
{
        const struct ata_xfer_ent *ent;

        for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
                if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
                        return ((2 << (ent->shift + xfer_mode - ent->base)) - 1)
                                & ~((1 << ent->shift) - 1);
        return 0;
}
EXPORT_SYMBOL_GPL(ata_xfer_mode2mask);

/**
 *      ata_xfer_mode2shift - Find matching xfer_shift for XFER_*
 *      @xfer_mode: XFER_* of interest
 *
 *      Return matching xfer_shift for @xfer_mode.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Matching xfer_shift, -1 if no match found.
 */
int ata_xfer_mode2shift(unsigned long xfer_mode)
{
        const struct ata_xfer_ent *ent;

        for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
                if (xfer_mode >= ent->base && xfer_mode < ent->base + ent->bits)
                        return ent->shift;
        return -1;
}
EXPORT_SYMBOL_GPL(ata_xfer_mode2shift);

/**
 *      ata_mode_string - convert xfer_mask to string
 *      @xfer_mask: mask of bits supported; only highest bit counts.
 *
 *      Determine string which represents the highest speed
 *      (highest bit in @modemask).
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Constant C string representing highest speed listed in
 *      @mode_mask, or the constant C string "<n/a>".
 */
const char *ata_mode_string(unsigned long xfer_mask)
{
        static const char * const xfer_mode_str[] = {
                "PIO0",
                "PIO1",
                "PIO2",
                "PIO3",
                "PIO4",
                "PIO5",
                "PIO6",
                "MWDMA0",
                "MWDMA1",
                "MWDMA2",
                "MWDMA3",
                "MWDMA4",
                "UDMA/16",
                "UDMA/25",
                "UDMA/33",
                "UDMA/44",
                "UDMA/66",
                "UDMA/100",
                "UDMA/133",
                "UDMA7",
        };
        int highbit;

        highbit = fls(xfer_mask) - 1;
        if (highbit >= 0 && highbit < ARRAY_SIZE(xfer_mode_str))
                return xfer_mode_str[highbit];
        return "<n/a>";
}
EXPORT_SYMBOL_GPL(ata_mode_string);

const char *sata_spd_string(unsigned int spd)
{
        static const char * const spd_str[] = {
                "1.5 Gbps",
                "3.0 Gbps",
                "6.0 Gbps",
        };

        if (spd == 0 || (spd - 1) >= ARRAY_SIZE(spd_str))
                return "<unknown>";
        return spd_str[spd - 1];
}

/**
 *      ata_dev_classify - determine device type based on ATA-spec signature
 *      @tf: ATA taskfile register set for device to be identified
 *
 *      Determine from taskfile register contents whether a device is
 *      ATA or ATAPI, as per "Signature and persistence" section
 *      of ATA/PI spec (volume 1, sect 5.14).
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Device type, %ATA_DEV_ATA, %ATA_DEV_ATAPI, %ATA_DEV_PMP,
 *      %ATA_DEV_ZAC, or %ATA_DEV_UNKNOWN the event of failure.
 */
unsigned int ata_dev_classify(const struct ata_taskfile *tf)
{
        /* Apple's open source Darwin code hints that some devices only
         * put a proper signature into the LBA mid/high registers,
         * So, we only check those.  It's sufficient for uniqueness.
         *
         * ATA/ATAPI-7 (d1532v1r1: Feb. 19, 2003) specified separate
         * signatures for ATA and ATAPI devices attached on SerialATA,
         * 0x3c/0xc3 and 0x69/0x96 respectively.  However, SerialATA
         * spec has never mentioned about using different signatures
         * for ATA/ATAPI devices.  Then, Serial ATA II: Port
         * Multiplier specification began to use 0x69/0x96 to identify
         * port multpliers and 0x3c/0xc3 to identify SEMB device.
         * ATA/ATAPI-7 dropped descriptions about 0x3c/0xc3 and
         * 0x69/0x96 shortly and described them as reserved for

         * SerialATA.
         *
         * We follow the current spec and consider that 0x69/0x96
         * identifies a port multiplier and 0x3c/0xc3 a SEMB device.
         * Unfortunately, WDC WD1600JS-62MHB5 (a hard drive) reports
         * SEMB signature.  This is worked around in
         * ata_dev_read_id().
         */
        if ((tf->lbam == 0) && (tf->lbah == 0)) {
                DPRINTK("found ATA device by sig\n");
                return ATA_DEV_ATA;
        }

        if ((tf->lbam == 0x14) && (tf->lbah == 0xeb)) {
                DPRINTK("found ATAPI device by sig\n");
                return ATA_DEV_ATAPI;
        }

        if ((tf->lbam == 0x69) && (tf->lbah == 0x96)) {
                DPRINTK("found PMP device by sig\n");
                return ATA_DEV_PMP;
        }

        if ((tf->lbam == 0x3c) && (tf->lbah == 0xc3)) {
                DPRINTK("found SEMB device by sig (could be ATA device)\n");
                return ATA_DEV_SEMB;
        }

        if ((tf->lbam == 0xcd) && (tf->lbah == 0xab)) {
                DPRINTK("found ZAC device by sig\n");
                return ATA_DEV_ZAC;
        }

        DPRINTK("unknown device\n");
        return ATA_DEV_UNKNOWN;
}
EXPORT_SYMBOL_GPL(ata_dev_classify);

/**
 *      ata_id_string - Convert IDENTIFY DEVICE page into string
 *      @id: IDENTIFY DEVICE results we will examine
 *      @s: string into which data is output
 *      @ofs: offset into identify device page
 *      @len: length of string to return. must be an even number.
 *
 *      The strings in the IDENTIFY DEVICE page are broken up into
 *      16-bit chunks.  Run through the string, and output each
 *      8-bit chunk linearly, regardless of platform.
 *
 *      LOCKING:
 *      caller.
 */

void ata_id_string(const u16 *id, unsigned char *s,
                   unsigned int ofs, unsigned int len)
{
        unsigned int c;

        BUG_ON(len & 1);

        while (len > 0) {
                c = id[ofs] >> 8;
                *s = c;
                s++;

                c = id[ofs] & 0xff;
                *s = c;
                s++;

                ofs++;
                len -= 2;
        }
}
EXPORT_SYMBOL_GPL(ata_id_string);

/**
 *      ata_id_c_string - Convert IDENTIFY DEVICE page into C string
 *      @id: IDENTIFY DEVICE results we will examine
 *      @s: string into which data is output
 *      @ofs: offset into identify device page
 *      @len: length of string to return. must be an odd number.
 *
 *      This function is identical to ata_id_string except that it
 *      trims trailing spaces and terminates the resulting string with
 *      null.  @len must be actual maximum length (even number) + 1.
 *
 *      LOCKING:
 *      caller.
 */
void ata_id_c_string(const u16 *id, unsigned char *s,
                     unsigned int ofs, unsigned int len)
{
        unsigned char *p;

        ata_id_string(id, s, ofs, len - 1);

        p = s + strnlen(s, len - 1);
        while (p > s && p[-1] == ' ')
                p--;
        *p = '\0';
}
EXPORT_SYMBOL_GPL(ata_id_c_string);

static u64 ata_id_n_sectors(const u16 *id)
{
        if (ata_id_has_lba(id)) {
                if (ata_id_has_lba48(id))
                        return ata_id_u64(id, ATA_ID_LBA_CAPACITY_2);
                else
                        return ata_id_u32(id, ATA_ID_LBA_CAPACITY);
        } else {
                if (ata_id_current_chs_valid(id))
                        return id[ATA_ID_CUR_CYLS] * id[ATA_ID_CUR_HEADS] *
                               id[ATA_ID_CUR_SECTORS];
                else
                        return id[ATA_ID_CYLS] * id[ATA_ID_HEADS] *
                               id[ATA_ID_SECTORS];
        }
}

u64 ata_tf_to_lba48(const struct ata_taskfile *tf)
{
        u64 sectors = 0;

        sectors |= ((u64)(tf->hob_lbah & 0xff)) << 40;
        sectors |= ((u64)(tf->hob_lbam & 0xff)) << 32;
        sectors |= ((u64)(tf->hob_lbal & 0xff)) << 24;
        sectors |= (tf->lbah & 0xff) << 16;
        sectors |= (tf->lbam & 0xff) << 8;
        sectors |= (tf->lbal & 0xff);

        return sectors;
}

u64 ata_tf_to_lba(const struct ata_taskfile *tf)
{
        u64 sectors = 0;

        sectors |= (tf->device & 0x0f) << 24;
        sectors |= (tf->lbah & 0xff) << 16;
        sectors |= (tf->lbam & 0xff) << 8;
        sectors |= (tf->lbal & 0xff);

        return sectors;
}

/**
 *      ata_read_native_max_address - Read native max address
 *      @dev: target device
 *      @max_sectors: out parameter for the result native max address
 *
 *      Perform an LBA48 or LBA28 native size query upon the device in
 *      question.
 *
 *      RETURNS:
 *      0 on success, -EACCES if command is aborted by the drive.
 *      -EIO on other errors.
 */
static int ata_read_native_max_address(struct ata_device *dev, u64 *max_sectors)
{
        unsigned int err_mask;
        struct ata_taskfile tf;
        int lba48 = ata_id_has_lba48(dev->id);

        ata_tf_init(dev, &tf);

        /* always clear all address registers */
        tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;

        if (lba48) {
                tf.command = ATA_CMD_READ_NATIVE_MAX_EXT;
                tf.flags |= ATA_TFLAG_LBA48;
        } else
                tf.command = ATA_CMD_READ_NATIVE_MAX;

        tf.protocol = ATA_PROT_NODATA;
        tf.device |= ATA_LBA;

        err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
        if (err_mask) {
                ata_dev_warn(dev,
                             "failed to read native max address (err_mask=0x%x)\n",
                             err_mask);
                if (err_mask == AC_ERR_DEV && (tf.feature & ATA_ABORTED))
                        return -EACCES;
                return -EIO;
        }

        if (lba48)
                *max_sectors = ata_tf_to_lba48(&tf) + 1;
        else
                *max_sectors = ata_tf_to_lba(&tf) + 1;
        if (dev->horkage & ATA_HORKAGE_HPA_SIZE)
                (*max_sectors)--;
        return 0;
}

/**
 *      ata_set_max_sectors - Set max sectors
 *      @dev: target device
 *      @new_sectors: new max sectors value to set for the device
 *
 *      Set max sectors of @dev to @new_sectors.
 *
 *      RETURNS:
 *      0 on success, -EACCES if command is aborted or denied (due to
 *      previous non-volatile SET_MAX) by the drive.  -EIO on other
 *      errors.
 */
static int ata_set_max_sectors(struct ata_device *dev, u64 new_sectors)
{
        unsigned int err_mask;
        struct ata_taskfile tf;
        int lba48 = ata_id_has_lba48(dev->id);

        new_sectors--;

        ata_tf_init(dev, &tf);

        tf.flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;

        if (lba48) {
                tf.command = ATA_CMD_SET_MAX_EXT;
                tf.flags |= ATA_TFLAG_LBA48;

                tf.hob_lbal = (new_sectors >> 24) & 0xff;
                tf.hob_lbam = (new_sectors >> 32) & 0xff;
                tf.hob_lbah = (new_sectors >> 40) & 0xff;
        } else {
                tf.command = ATA_CMD_SET_MAX;

                tf.device |= (new_sectors >> 24) & 0xf;
        }

        tf.protocol = ATA_PROT_NODATA;
        tf.device |= ATA_LBA;

        tf.lbal = (new_sectors >> 0) & 0xff;
        tf.lbam = (new_sectors >> 8) & 0xff;
        tf.lbah = (new_sectors >> 16) & 0xff;

        err_mask = ata_exec_internal(dev, &tf, NULL, DMA_NONE, NULL, 0, 0);
        if (err_mask) {
                ata_dev_warn(dev,
                             "failed to set max address (err_mask=0x%x)\n",
                             err_mask);
                if (err_mask == AC_ERR_DEV &&
                    (tf.feature & (ATA_ABORTED | ATA_IDNF)))
                        return -EACCES;
                return -EIO;
        }

        return 0;
}

/**
 *      ata_hpa_resize          -       Resize a device with an HPA set
 *      @dev: Device to resize
 *
 *      Read the size of an LBA28 or LBA48 disk with HPA features and resize
 *      it if required to the full size of the media. The caller must check
 *      the drive has the HPA feature set enabled.
 *
 *      RETURNS:
 *      0 on success, -errno on failure.
 */
static int ata_hpa_resize(struct ata_device *dev)
{
        struct ata_eh_context *ehc = &dev->link->eh_context;
        int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
        bool unlock_hpa = ata_ignore_hpa || dev->flags & ATA_DFLAG_UNLOCK_HPA;
        u64 sectors = ata_id_n_sectors(dev->id);
        u64 native_sectors;
        int rc;

        /* do we need to do it? */
        if ((dev->class != ATA_DEV_ATA && dev->class != ATA_DEV_ZAC) ||
            !ata_id_has_lba(dev->id) || !ata_id_hpa_enabled(dev->id) ||
            (dev->horkage & ATA_HORKAGE_BROKEN_HPA))
                return 0;

        /* read native max address */
        rc = ata_read_native_max_address(dev, &native_sectors);
        if (rc) {
                /* If device aborted the command or HPA isn't going to
                 * be unlocked, skip HPA resizing.
                 */
                if (rc == -EACCES || !unlock_hpa) {
                        ata_dev_warn(dev,
                                     "HPA support seems broken, skipping HPA handling\n");
                        dev->horkage |= ATA_HORKAGE_BROKEN_HPA;

                        /* we can continue if device aborted the command */
                        if (rc == -EACCES)
                                rc = 0;
                }

                return rc;
        }
        dev->n_native_sectors = native_sectors;

        /* nothing to do? */
        if (native_sectors <= sectors || !unlock_hpa) {
                if (!print_info || native_sectors == sectors)
                        return 0;

                if (native_sectors > sectors)
                        ata_dev_info(dev,
                                "HPA detected: current %llu, native %llu\n",
                                (unsigned long long)sectors,
                                (unsigned long long)native_sectors);
                else if (native_sectors < sectors)
                        ata_dev_warn(dev,
                                "native sectors (%llu) is smaller than sectors (%llu)\n",
                                (unsigned long long)native_sectors,
                                (unsigned long long)sectors);
                return 0;
        }

        /* let's unlock HPA */
        rc = ata_set_max_sectors(dev, native_sectors);
        if (rc == -EACCES) {
                /* if device aborted the command, skip HPA resizing */
                ata_dev_warn(dev,
                             "device aborted resize (%llu -> %llu), skipping HPA handling\n",
                             (unsigned long long)sectors,
                             (unsigned long long)native_sectors);
                dev->horkage |= ATA_HORKAGE_BROKEN_HPA;
                return 0;
        } else if (rc)
                return rc;

        /* re-read IDENTIFY data */
        rc = ata_dev_reread_id(dev, 0);
        if (rc) {
                ata_dev_err(dev,
                            "failed to re-read IDENTIFY data after HPA resizing\n");
                return rc;
        }

        if (print_info) {
                u64 new_sectors = ata_id_n_sectors(dev->id);
                ata_dev_info(dev,
                        "HPA unlocked: %llu -> %llu, native %llu\n",
                        (unsigned long long)sectors,
                        (unsigned long long)new_sectors,
                        (unsigned long long)native_sectors);
        }

        return 0;
}

/**
 *      ata_dump_id - IDENTIFY DEVICE info debugging output
 *      @id: IDENTIFY DEVICE page to dump
 *
 *      Dump selected 16-bit words from the given IDENTIFY DEVICE
 *      page.
 *
 *      LOCKING:
 *      caller.
 */

static inline void ata_dump_id(const u16 *id)
{
        DPRINTK("49==0x%04x  "
                "53==0x%04x  "
                "63==0x%04x  "
                "64==0x%04x  "
                "75==0x%04x  \n",
                id[49],
                id[53],
                id[63],
                id[64],
                id[75]);
        DPRINTK("80==0x%04x  "
                "81==0x%04x  "
                "82==0x%04x  "
                "83==0x%04x  "
                "84==0x%04x  \n",
                id[80],
                id[81],
                id[82],
                id[83],
                id[84]);
        DPRINTK("88==0x%04x  "
                "93==0x%04x\n",
                id[88],
                id[93]);
}

/**
 *      ata_id_xfermask - Compute xfermask from the given IDENTIFY data
 *      @id: IDENTIFY data to compute xfer mask from
 *
 *      Compute the xfermask for this device. This is not as trivial
 *      as it seems if we must consider early devices correctly.
 *
 *      FIXME: pre IDE drive timing (do we care ?).
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Computed xfermask
 */
unsigned long ata_id_xfermask(const u16 *id)
{
        unsigned long pio_mask, mwdma_mask, udma_mask;

        /* Usual case. Word 53 indicates word 64 is valid */
        if (id[ATA_ID_FIELD_VALID] & (1 << 1)) {
                pio_mask = id[ATA_ID_PIO_MODES] & 0x03;
                pio_mask <<= 3;
                pio_mask |= 0x7;
        } else {
                /* If word 64 isn't valid then Word 51 high byte holds
                 * the PIO timing number for the maximum. Turn it into
                 * a mask.
                 */
                u8 mode = (id[ATA_ID_OLD_PIO_MODES] >> 8) & 0xFF;
                if (mode < 5)   /* Valid PIO range */
                        pio_mask = (2 << mode) - 1;
                else
                        pio_mask = 1;

                /* But wait.. there's more. Design your standards by
                 * committee and you too can get a free iordy field to
                 * process. However its the speeds not the modes that
                 * are supported... Note drivers using the timing API
                 * will get this right anyway
                 */
        }

        mwdma_mask = id[ATA_ID_MWDMA_MODES] & 0x07;

        if (ata_id_is_cfa(id)) {
                /*
                 *      Process compact flash extended modes
                 */
                int pio = (id[ATA_ID_CFA_MODES] >> 0) & 0x7;
                int dma = (id[ATA_ID_CFA_MODES] >> 3) & 0x7;

                if (pio)
                        pio_mask |= (1 << 5);
                if (pio > 1)
                        pio_mask |= (1 << 6);
                if (dma)
                        mwdma_mask |= (1 << 3);
                if (dma > 1)
                        mwdma_mask |= (1 << 4);
        }

        udma_mask = 0;
        if (id[ATA_ID_FIELD_VALID] & (1 << 2))
                udma_mask = id[ATA_ID_UDMA_MODES] & 0xff;

        return ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);
}
EXPORT_SYMBOL_GPL(ata_id_xfermask);

static void ata_qc_complete_internal(struct ata_queued_cmd *qc)
{
        struct completion *waiting = qc->private_data;

        complete(waiting);
}

/**
 *      ata_exec_internal_sg - execute libata internal command
 *      @dev: Device to which the command is sent
 *      @tf: Taskfile registers for the command and the result
 *      @cdb: CDB for packet command
 *      @dma_dir: Data transfer direction of the command
 *      @sgl: sg list for the data buffer of the command
 *      @n_elem: Number of sg entries
 *      @timeout: Timeout in msecs (0 for default)
 *
 *      Executes libata internal command with timeout.  @tf contains
 *      command on entry and result on return.  Timeout and error
 *      conditions are reported via return value.  No recovery action
 *      is taken after a command times out.  It's caller's duty to
 *      clean up after timeout.
 *
 *      LOCKING:
 *      None.  Should be called with kernel context, might sleep.
 *
 *      RETURNS:
 *      Zero on success, AC_ERR_* mask on failure
 */
unsigned ata_exec_internal_sg(struct ata_device *dev,
                              struct ata_taskfile *tf, const u8 *cdb,
                              int dma_dir, struct scatterlist *sgl,
                              unsigned int n_elem, unsigned long timeout)
{
        struct ata_link *link = dev->link;
        struct ata_port *ap = link->ap;
        u8 command = tf->command;
        int auto_timeout = 0;
        struct ata_queued_cmd *qc;
        unsigned int preempted_tag;
        u32 preempted_sactive;
        u64 preempted_qc_active;
        int preempted_nr_active_links;
        DECLARE_COMPLETION_ONSTACK(wait);
        unsigned long flags;
        unsigned int err_mask;
        int rc;

        spin_lock_irqsave(ap->lock, flags);

        /* no internal command while frozen */
        if (ap->pflags & ATA_PFLAG_FROZEN) {
                spin_unlock_irqrestore(ap->lock, flags);
                return AC_ERR_SYSTEM;
        }

        /* initialize internal qc */
        qc = __ata_qc_from_tag(ap, ATA_TAG_INTERNAL);

        qc->tag = ATA_TAG_INTERNAL;
        qc->hw_tag = 0;
        qc->scsicmd = NULL;
        qc->ap = ap;
        qc->dev = dev;
        ata_qc_reinit(qc);

        preempted_tag = link->active_tag;
        preempted_sactive = link->sactive;
        preempted_qc_active = ap->qc_active;
        preempted_nr_active_links = ap->nr_active_links;
        link->active_tag = ATA_TAG_POISON;
        link->sactive = 0;
        ap->qc_active = 0;
        ap->nr_active_links = 0;

        /* prepare & issue qc */
        qc->tf = *tf;
        if (cdb)
                memcpy(qc->cdb, cdb, ATAPI_CDB_LEN);

        /* some SATA bridges need us to indicate data xfer direction */
        if (tf->protocol == ATAPI_PROT_DMA && (dev->flags & ATA_DFLAG_DMADIR) &&
            dma_dir == DMA_FROM_DEVICE)
                qc->tf.feature |= ATAPI_DMADIR;

        qc->flags |= ATA_QCFLAG_RESULT_TF;
        qc->dma_dir = dma_dir;
        if (dma_dir != DMA_NONE) {
                unsigned int i, buflen = 0;
                struct scatterlist *sg;

                for_each_sg(sgl, sg, n_elem, i)
                        buflen += sg->length;

                ata_sg_init(qc, sgl, n_elem);
                qc->nbytes = buflen;
        }

        qc->private_data = &wait;
        qc->complete_fn = ata_qc_complete_internal;

        ata_qc_issue(qc);

        spin_unlock_irqrestore(ap->lock, flags);

        if (!timeout) {
                if (ata_probe_timeout)
                        timeout = ata_probe_timeout * 1000;
                else {
                        timeout = ata_internal_cmd_timeout(dev, command);
                        auto_timeout = 1;
                }
        }

        if (ap->ops->error_handler)
                ata_eh_release(ap);

        rc = wait_for_completion_timeout(&wait, msecs_to_jiffies(timeout));

        if (ap->ops->error_handler)
                ata_eh_acquire(ap);

        ata_sff_flush_pio_task(ap);

        if (!rc) {
                spin_lock_irqsave(ap->lock, flags);

                /* We're racing with irq here.  If we lose, the
                 * following test prevents us from completing the qc
                 * twice.  If we win, the port is frozen and will be
                 * cleaned up by ->post_internal_cmd().
                 */
                if (qc->flags & ATA_QCFLAG_ACTIVE) {
                        qc->err_mask |= AC_ERR_TIMEOUT;

                        if (ap->ops->error_handler)
                                ata_port_freeze(ap);
                        else
                                ata_qc_complete(qc);

                        if (ata_msg_warn(ap))
                                ata_dev_warn(dev, "qc timeout (cmd 0x%x)\n",
                                             command);
                }

                spin_unlock_irqrestore(ap->lock, flags);
        }

        /* do post_internal_cmd */
        if (ap->ops->post_internal_cmd)
                ap->ops->post_internal_cmd(qc);

        /* perform minimal error analysis */
        if (qc->flags & ATA_QCFLAG_FAILED) {
                if (qc->result_tf.command & (ATA_ERR | ATA_DF))
                        qc->err_mask |= AC_ERR_DEV;

                if (!qc->err_mask)
                        qc->err_mask |= AC_ERR_OTHER;

                if (qc->err_mask & ~AC_ERR_OTHER)
                        qc->err_mask &= ~AC_ERR_OTHER;
        } else if (qc->tf.command == ATA_CMD_REQ_SENSE_DATA) {
                qc->result_tf.command |= ATA_SENSE;
        }

        /* finish up */
        spin_lock_irqsave(ap->lock, flags);

        *tf = qc->result_tf;
        err_mask = qc->err_mask;

        ata_qc_free(qc);
        link->active_tag = preempted_tag;
        link->sactive = preempted_sactive;
        ap->qc_active = preempted_qc_active;
        ap->nr_active_links = preempted_nr_active_links;

        spin_unlock_irqrestore(ap->lock, flags);

        if ((err_mask & AC_ERR_TIMEOUT) && auto_timeout)
                ata_internal_cmd_timed_out(dev, command);

        return err_mask;
}

/**
 *      ata_exec_internal - execute libata internal command
 *      @dev: Device to which the command is sent
 *      @tf: Taskfile registers for the command and the result
 *      @cdb: CDB for packet command
 *      @dma_dir: Data transfer direction of the command
 *      @buf: Data buffer of the command
 *      @buflen: Length of data buffer
 *      @timeout: Timeout in msecs (0 for default)
 *
 *      Wrapper around ata_exec_internal_sg() which takes simple
 *      buffer instead of sg list.
 *
 *      LOCKING:
 *      None.  Should be called with kernel context, might sleep.
 *
 *      RETURNS:
 *      Zero on success, AC_ERR_* mask on failure
 */
unsigned ata_exec_internal(struct ata_device *dev,
                           struct ata_taskfile *tf, const u8 *cdb,
                           int dma_dir, void *buf, unsigned int buflen,
                           unsigned long timeout)
{
        struct scatterlist *psg = NULL, sg;
        unsigned int n_elem = 0;

        if (dma_dir != DMA_NONE) {
                WARN_ON(!buf);
                sg_init_one(&sg, buf, buflen);
                psg = &sg;
                n_elem++;
        }

        return ata_exec_internal_sg(dev, tf, cdb, dma_dir, psg, n_elem,
                                    timeout);
}

/**
 *      ata_pio_need_iordy      -       check if iordy needed
 *      @adev: ATA device
 *
 *      Check if the current speed of the device requires IORDY. Used
 *      by various controllers for chip configuration.
 */
unsigned int ata_pio_need_iordy(const struct ata_device *adev)
{
        /* Don't set IORDY if we're preparing for reset.  IORDY may
         * lead to controller lock up on certain controllers if the
         * port is not occupied.  See bko#11703 for details.
         */
        if (adev->link->ap->pflags & ATA_PFLAG_RESETTING)
                return 0;
        /* Controller doesn't support IORDY.  Probably a pointless
         * check as the caller should know this.
         */
        if (adev->link->ap->flags & ATA_FLAG_NO_IORDY)
                return 0;
        /* CF spec. r4.1 Table 22 says no iordy on PIO5 and PIO6.  */
        if (ata_id_is_cfa(adev->id)
            && (adev->pio_mode == XFER_PIO_5 || adev->pio_mode == XFER_PIO_6))
                return 0;
        /* PIO3 and higher it is mandatory */
        if (adev->pio_mode > XFER_PIO_2)
                return 1;
        /* We turn it on when possible */
        if (ata_id_has_iordy(adev->id))
                return 1;
        return 0;
}
EXPORT_SYMBOL_GPL(ata_pio_need_iordy);

/**
 *      ata_pio_mask_no_iordy   -       Return the non IORDY mask
 *      @adev: ATA device
 *
 *      Compute the highest mode possible if we are not using iordy. Return
 *      -1 if no iordy mode is available.
 */
static u32 ata_pio_mask_no_iordy(const struct ata_device *adev)
{
        /* If we have no drive specific rule, then PIO 2 is non IORDY */
        if (adev->id[ATA_ID_FIELD_VALID] & 2) { /* EIDE */
                u16 pio = adev->id[ATA_ID_EIDE_PIO];
                /* Is the speed faster than the drive allows non IORDY ? */
                if (pio) {
                        /* This is cycle times not frequency - watch the logic! */
                        if (pio > 240)  /* PIO2 is 240nS per cycle */
                                return 3 << ATA_SHIFT_PIO;
                        return 7 << ATA_SHIFT_PIO;
                }
        }
        return 3 << ATA_SHIFT_PIO;
}

/**
 *      ata_do_dev_read_id              -       default ID read method
 *      @dev: device
 *      @tf: proposed taskfile
 *      @id: data buffer
 *
 *      Issue the identify taskfile and hand back the buffer containing
 *      identify data. For some RAID controllers and for pre ATA devices
 *      this function is wrapped or replaced by the driver
 */
unsigned int ata_do_dev_read_id(struct ata_device *dev,
                                        struct ata_taskfile *tf, u16 *id)
{
        return ata_exec_internal(dev, tf, NULL, DMA_FROM_DEVICE,
                                     id, sizeof(id[0]) * ATA_ID_WORDS, 0);
}
EXPORT_SYMBOL_GPL(ata_do_dev_read_id);

/**
 *      ata_dev_read_id - Read ID data from the specified device
 *      @dev: target device
 *      @p_class: pointer to class of the target device (may be changed)
 *      @flags: ATA_READID_* flags
 *      @id: buffer to read IDENTIFY data into
 *
 *      Read ID data from the specified device.  ATA_CMD_ID_ATA is
 *      performed on ATA devices and ATA_CMD_ID_ATAPI on ATAPI
 *      devices.  This function also issues ATA_CMD_INIT_DEV_PARAMS
 *      for pre-ATA4 drives.
 *
 *      FIXME: ATA_CMD_ID_ATA is optional for early drives and right
 *      now we abort if we hit that case.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 *
 *      RETURNS:
 *      0 on success, -errno otherwise.
 */
int ata_dev_read_id(struct ata_device *dev, unsigned int *p_class,
                    unsigned int flags, u16 *id)
{
        struct ata_port *ap = dev->link->ap;
        unsigned int class = *p_class;
        struct ata_taskfile tf;
        unsigned int err_mask = 0;
        const char *reason;
        bool is_semb = class == ATA_DEV_SEMB;
        int may_fallback = 1, tried_spinup = 0;
        int rc;

        if (ata_msg_ctl(ap))
                ata_dev_dbg(dev, "%s: ENTER\n", __func__);

retry:
        ata_tf_init(dev, &tf);

        switch (class) {
        case ATA_DEV_SEMB:
                class = ATA_DEV_ATA;    /* some hard drives report SEMB sig */
                fallthrough;
        case ATA_DEV_ATA:
        case ATA_DEV_ZAC:
                tf.command = ATA_CMD_ID_ATA;
                break;
        case ATA_DEV_ATAPI:
                tf.command = ATA_CMD_ID_ATAPI;
                break;
        default:
                rc = -ENODEV;
                reason = "unsupported class";
                goto err_out;
        }

        tf.protocol = ATA_PROT_PIO;

        /* Some devices choke if TF registers contain garbage.  Make
         * sure those are properly initialized.
         */
        tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;

        /* Device presence detection is unreliable on some
         * controllers.  Always poll IDENTIFY if available.
         */
        tf.flags |= ATA_TFLAG_POLLING;

        if (ap->ops->read_id)
                err_mask = ap->ops->read_id(dev, &tf, id);
        else
                err_mask = ata_do_dev_read_id(dev, &tf, id);

        if (err_mask) {
                if (err_mask & AC_ERR_NODEV_HINT) {
                        ata_dev_dbg(dev, "NODEV after polling detection\n");
                        return -ENOENT;
                }

                if (is_semb) {
                        ata_dev_info(dev,
                     "IDENTIFY failed on device w/ SEMB sig, disabled\n");
                        /* SEMB is not supported yet */
                        *p_class = ATA_DEV_SEMB_UNSUP;
                        return 0;
                }

                if ((err_mask == AC_ERR_DEV) && (tf.feature & ATA_ABORTED)) {
                        /* Device or controller might have reported
                         * the wrong device class.  Give a shot at the
                         * other IDENTIFY if the current one is
                         * aborted by the device.
                         */
                        if (may_fallback) {
                                may_fallback = 0;

                                if (class == ATA_DEV_ATA)
                                        class = ATA_DEV_ATAPI;
                                else
                                        class = ATA_DEV_ATA;
                                goto retry;
                        }

                        /* Control reaches here iff the device aborted
                         * both flavors of IDENTIFYs which happens
                         * sometimes with phantom devices.
                         */
                        ata_dev_dbg(dev,
                                    "both IDENTIFYs aborted, assuming NODEV\n");
                        return -ENOENT;
                }

                rc = -EIO;
                reason = "I/O error";
                goto err_out;
        }

        if (dev->horkage & ATA_HORKAGE_DUMP_ID) {
                ata_dev_dbg(dev, "dumping IDENTIFY data, "
                            "class=%d may_fallback=%d tried_spinup=%d\n",
                            class, may_fallback, tried_spinup);
                print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET,
                               16, 2, id, ATA_ID_WORDS * sizeof(*id), true);
        }

        /* Falling back doesn't make sense if ID data was read
         * successfully at least once.
         */
        may_fallback = 0;

        swap_buf_le16(id, ATA_ID_WORDS);

        /* sanity check */
        rc = -EINVAL;
        reason = "device reports invalid type";

        if (class == ATA_DEV_ATA || class == ATA_DEV_ZAC) {
                if (!ata_id_is_ata(id) && !ata_id_is_cfa(id))
                        goto err_out;
                if (ap->host->flags & ATA_HOST_IGNORE_ATA &&
                                                        ata_id_is_ata(id)) {
                        ata_dev_dbg(dev,
                                "host indicates ignore ATA devices, ignored\n");
                        return -ENOENT;
                }
        } else {
                if (ata_id_is_ata(id))
                        goto err_out;
        }

        if (!tried_spinup && (id[2] == 0x37c8 || id[2] == 0x738c)) {
                tried_spinup = 1;
                /*
                 * Drive powered-up in standby mode, and requires a specific
                 * SET_FEATURES spin-up subcommand before it will accept
                 * anything other than the original IDENTIFY command.
                 */
                err_mask = ata_dev_set_feature(dev, SETFEATURES_SPINUP, 0);
                if (err_mask && id[2] != 0x738c) {
                        rc = -EIO;
                        reason = "SPINUP failed";
                        goto err_out;
                }
                /*
                 * If the drive initially returned incomplete IDENTIFY info,
                 * we now must reissue the IDENTIFY command.
                 */
                if (id[2] == 0x37c8)
                        goto retry;
        }

        if ((flags & ATA_READID_POSTRESET) &&
            (class == ATA_DEV_ATA || class == ATA_DEV_ZAC)) {
                /*
                 * The exact sequence expected by certain pre-ATA4 drives is:
                 * SRST RESET
                 * IDENTIFY (optional in early ATA)
                 * INITIALIZE DEVICE PARAMETERS (later IDE and ATA)
                 * anything else..
                 * Some drives were very specific about that exact sequence.
                 *
                 * Note that ATA4 says lba is mandatory so the second check
                 * should never trigger.
                 */
                if (ata_id_major_version(id) < 4 || !ata_id_has_lba(id)) {
                        err_mask = ata_dev_init_params(dev, id[3], id[6]);
                        if (err_mask) {
                                rc = -EIO;
                                reason = "INIT_DEV_PARAMS failed";
                                goto err_out;
                        }

                        /* current CHS translation info (id[53-58]) might be
                         * changed. reread the identify device info.
                         */
                        flags &= ~ATA_READID_POSTRESET;
                        goto retry;
                }
        }

        *p_class = class;

        return 0;

 err_out:
        if (ata_msg_warn(ap))
                ata_dev_warn(dev, "failed to IDENTIFY (%s, err_mask=0x%x)\n",
                             reason, err_mask);
        return rc;
}

/**
 *      ata_read_log_page - read a specific log page
 *      @dev: target device
 *      @log: log to read
 *      @page: page to read
 *      @buf: buffer to store read page
 *      @sectors: number of sectors to read
 *
 *      Read log page using READ_LOG_EXT command.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep).
 *
 *      RETURNS:
 *      0 on success, AC_ERR_* mask otherwise.
 */
unsigned int ata_read_log_page(struct ata_device *dev, u8 log,
                               u8 page, void *buf, unsigned int sectors)
{
        unsigned long ap_flags = dev->link->ap->flags;
        struct ata_taskfile tf;
        unsigned int err_mask;
        bool dma = false;

        DPRINTK("read log page - log 0x%x, page 0x%x\n", log, page);

        /*
         * Return error without actually issuing the command on controllers
         * which e.g. lockup on a read log page.

         */
        if (ap_flags & ATA_FLAG_NO_LOG_PAGE)
                return AC_ERR_DEV;

retry:
        ata_tf_init(dev, &tf);
        if (dev->dma_mode && ata_id_has_read_log_dma_ext(dev->id) &&
            !(dev->horkage & ATA_HORKAGE_NO_DMA_LOG)) {
                tf.command = ATA_CMD_READ_LOG_DMA_EXT;
                tf.protocol = ATA_PROT_DMA;
                dma = true;
        } else {
                tf.command = ATA_CMD_READ_LOG_EXT;
                tf.protocol = ATA_PROT_PIO;
                dma = false;
        }
        tf.lbal = log;
        tf.lbam = page;
        tf.nsect = sectors;
        tf.hob_nsect = sectors >> 8;
        tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_LBA48 | ATA_TFLAG_DEVICE;

        err_mask = ata_exec_internal(dev, &tf, NULL, DMA_FROM_DEVICE,
                                     buf, sectors * ATA_SECT_SIZE, 0);

        if (err_mask && dma) {
                dev->horkage |= ATA_HORKAGE_NO_DMA_LOG;
                ata_dev_warn(dev, "READ LOG DMA EXT failed, trying PIO\n");
                goto retry;
        }

        DPRINTK("EXIT, err_mask=%x\n", err_mask);
        return err_mask;
}

static bool ata_log_supported(struct ata_device *dev, u8 log)
{
        struct ata_port *ap = dev->link->ap;

        if (ata_read_log_page(dev, ATA_LOG_DIRECTORY, 0, ap->sector_buf, 1))
                return false;
        return get_unaligned_le16(&ap->sector_buf[log * 2]) ? true : false;
}

static bool ata_identify_page_supported(struct ata_device *dev, u8 page)
{
        struct ata_port *ap = dev->link->ap;
        unsigned int err, i;

        if (!ata_log_supported(dev, ATA_LOG_IDENTIFY_DEVICE)) {
                ata_dev_warn(dev, "ATA Identify Device Log not supported\n");
                return false;
        }

        /*
         * Read IDENTIFY DEVICE data log, page 0, to figure out if the page is
         * supported.
         */
        err = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE, 0, ap->sector_buf,
                                1);
        if (err) {
                ata_dev_info(dev,
                             "failed to get Device Identify Log Emask 0x%x\n",
                             err);
                return false;
        }

        for (i = 0; i < ap->sector_buf[8]; i++) {
                if (ap->sector_buf[9 + i] == page)
                        return true;
        }

        return false;
}

static int ata_do_link_spd_horkage(struct ata_device *dev)
{
        struct ata_link *plink = ata_dev_phys_link(dev);
        u32 target, target_limit;

        if (!sata_scr_valid(plink))
                return 0;

        if (dev->horkage & ATA_HORKAGE_1_5_GBPS)
                target = 1;
        else
                return 0;

        target_limit = (1 << target) - 1;

        /* if already on stricter limit, no need to push further */
        if (plink->sata_spd_limit <= target_limit)
                return 0;

        plink->sata_spd_limit = target_limit;

        /* Request another EH round by returning -EAGAIN if link is
         * going faster than the target speed.  Forward progress is
         * guaranteed by setting sata_spd_limit to target_limit above.
         */
        if (plink->sata_spd > target) {
                ata_dev_info(dev, "applying link speed limit horkage to %s\n",
                             sata_spd_string(target));
                return -EAGAIN;
        }
        return 0;
}

static inline u8 ata_dev_knobble(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;

        if (ata_dev_blacklisted(dev) & ATA_HORKAGE_BRIDGE_OK)
                return 0;

        return ((ap->cbl == ATA_CBL_SATA) && (!ata_id_is_sata(dev->id)));
}

static void ata_dev_config_ncq_send_recv(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        unsigned int err_mask;

        if (!ata_log_supported(dev, ATA_LOG_NCQ_SEND_RECV)) {
                ata_dev_warn(dev, "NCQ Send/Recv Log not supported\n");
                return;
        }
        err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_SEND_RECV,
                                     0, ap->sector_buf, 1);
        if (err_mask) {
                ata_dev_dbg(dev,
                            "failed to get NCQ Send/Recv Log Emask 0x%x\n",
                            err_mask);
        } else {
                u8 *cmds = dev->ncq_send_recv_cmds;

                dev->flags |= ATA_DFLAG_NCQ_SEND_RECV;
                memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_SEND_RECV_SIZE);

                if (dev->horkage & ATA_HORKAGE_NO_NCQ_TRIM) {
                        ata_dev_dbg(dev, "disabling queued TRIM support\n");
                        cmds[ATA_LOG_NCQ_SEND_RECV_DSM_OFFSET] &=
                                ~ATA_LOG_NCQ_SEND_RECV_DSM_TRIM;
                }
        }
}

static void ata_dev_config_ncq_non_data(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        unsigned int err_mask;

        if (!ata_log_supported(dev, ATA_LOG_NCQ_NON_DATA)) {
                ata_dev_warn(dev,
                             "NCQ Send/Recv Log not supported\n");
                return;
        }
        err_mask = ata_read_log_page(dev, ATA_LOG_NCQ_NON_DATA,
                                     0, ap->sector_buf, 1);
        if (err_mask) {
                ata_dev_dbg(dev,
                            "failed to get NCQ Non-Data Log Emask 0x%x\n",
                            err_mask);
        } else {
                u8 *cmds = dev->ncq_non_data_cmds;

                memcpy(cmds, ap->sector_buf, ATA_LOG_NCQ_NON_DATA_SIZE);
        }
}

static void ata_dev_config_ncq_prio(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        unsigned int err_mask;

        if (!(dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLE)) {
                dev->flags &= ~ATA_DFLAG_NCQ_PRIO;
                return;
        }

        err_mask = ata_read_log_page(dev,
                                     ATA_LOG_IDENTIFY_DEVICE,
                                     ATA_LOG_SATA_SETTINGS,
                                     ap->sector_buf,
                                     1);
        if (err_mask) {
                ata_dev_dbg(dev,
                            "failed to get Identify Device data, Emask 0x%x\n",
                            err_mask);
                return;
        }

        if (ap->sector_buf[ATA_LOG_NCQ_PRIO_OFFSET] & BIT(3)) {
                dev->flags |= ATA_DFLAG_NCQ_PRIO;
        } else {
                dev->flags &= ~ATA_DFLAG_NCQ_PRIO;
                ata_dev_dbg(dev, "SATA page does not support priority\n");
        }

}

static int ata_dev_config_ncq(struct ata_device *dev,
                               char *desc, size_t desc_sz)
{
        struct ata_port *ap = dev->link->ap;
        int hdepth = 0, ddepth = ata_id_queue_depth(dev->id);
        unsigned int err_mask;
        char *aa_desc = "";

        if (!ata_id_has_ncq(dev->id)) {
                desc[0] = '\0';
                return 0;
        }
        if (!IS_ENABLED(CONFIG_SATA_HOST))
                return 0;
        if (dev->horkage & ATA_HORKAGE_NONCQ) {
                snprintf(desc, desc_sz, "NCQ (not used)");
                return 0;
        }
        if (ap->flags & ATA_FLAG_NCQ) {
                hdepth = min(ap->scsi_host->can_queue, ATA_MAX_QUEUE);
                dev->flags |= ATA_DFLAG_NCQ;
        }

        if (!(dev->horkage & ATA_HORKAGE_BROKEN_FPDMA_AA) &&
                (ap->flags & ATA_FLAG_FPDMA_AA) &&
                ata_id_has_fpdma_aa(dev->id)) {
                err_mask = ata_dev_set_feature(dev, SETFEATURES_SATA_ENABLE,
                        SATA_FPDMA_AA);
                if (err_mask) {
                        ata_dev_err(dev,
                                    "failed to enable AA (error_mask=0x%x)\n",
                                    err_mask);
                        if (err_mask != AC_ERR_DEV) {
                                dev->horkage |= ATA_HORKAGE_BROKEN_FPDMA_AA;
                                return -EIO;
                        }
                } else
                        aa_desc = ", AA";
        }

        if (hdepth >= ddepth)
                snprintf(desc, desc_sz, "NCQ (depth %d)%s", ddepth, aa_desc);
        else
                snprintf(desc, desc_sz, "NCQ (depth %d/%d)%s", hdepth,
                        ddepth, aa_desc);

        if ((ap->flags & ATA_FLAG_FPDMA_AUX)) {
                if (ata_id_has_ncq_send_and_recv(dev->id))
                        ata_dev_config_ncq_send_recv(dev);
                if (ata_id_has_ncq_non_data(dev->id))
                        ata_dev_config_ncq_non_data(dev);
                if (ata_id_has_ncq_prio(dev->id))
                        ata_dev_config_ncq_prio(dev);
        }

        return 0;
}

static void ata_dev_config_sense_reporting(struct ata_device *dev)
{
        unsigned int err_mask;

        if (!ata_id_has_sense_reporting(dev->id))
                return;

        if (ata_id_sense_reporting_enabled(dev->id))
                return;

        err_mask = ata_dev_set_feature(dev, SETFEATURE_SENSE_DATA, 0x1);
        if (err_mask) {
                ata_dev_dbg(dev,
                            "failed to enable Sense Data Reporting, Emask 0x%x\n",
                            err_mask);
        }
}

static void ata_dev_config_zac(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        unsigned int err_mask;
        u8 *identify_buf = ap->sector_buf;

        dev->zac_zones_optimal_open = U32_MAX;
        dev->zac_zones_optimal_nonseq = U32_MAX;
        dev->zac_zones_max_open = U32_MAX;

        /*
         * Always set the 'ZAC' flag for Host-managed devices.
         */
        if (dev->class == ATA_DEV_ZAC)
                dev->flags |= ATA_DFLAG_ZAC;
        else if (ata_id_zoned_cap(dev->id) == 0x01)
                /*
                 * Check for host-aware devices.
                 */
                dev->flags |= ATA_DFLAG_ZAC;

        if (!(dev->flags & ATA_DFLAG_ZAC))
                return;

        if (!ata_identify_page_supported(dev, ATA_LOG_ZONED_INFORMATION)) {
                ata_dev_warn(dev,
                             "ATA Zoned Information Log not supported\n");
                return;
        }

        /*
         * Read IDENTIFY DEVICE data log, page 9 (Zoned-device information)
         */
        err_mask = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE,
                                     ATA_LOG_ZONED_INFORMATION,
                                     identify_buf, 1);
        if (!err_mask) {
                u64 zoned_cap, opt_open, opt_nonseq, max_open;

                zoned_cap = get_unaligned_le64(&identify_buf[8]);
                if ((zoned_cap >> 63))
                        dev->zac_zoned_cap = (zoned_cap & 1);
                opt_open = get_unaligned_le64(&identify_buf[24]);
                if ((opt_open >> 63))
                        dev->zac_zones_optimal_open = (u32)opt_open;
                opt_nonseq = get_unaligned_le64(&identify_buf[32]);
                if ((opt_nonseq >> 63))
                        dev->zac_zones_optimal_nonseq = (u32)opt_nonseq;
                max_open = get_unaligned_le64(&identify_buf[40]);
                if ((max_open >> 63))
                        dev->zac_zones_max_open = (u32)max_open;
        }
}

static void ata_dev_config_trusted(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        u64 trusted_cap;
        unsigned int err;

        if (!ata_id_has_trusted(dev->id))
                return;

        if (!ata_identify_page_supported(dev, ATA_LOG_SECURITY)) {
                ata_dev_warn(dev,
                             "Security Log not supported\n");
                return;
        }

        err = ata_read_log_page(dev, ATA_LOG_IDENTIFY_DEVICE, ATA_LOG_SECURITY,
                        ap->sector_buf, 1);
        if (err) {
                ata_dev_dbg(dev,
                            "failed to read Security Log, Emask 0x%x\n", err);
                return;
        }

        trusted_cap = get_unaligned_le64(&ap->sector_buf[40]);
        if (!(trusted_cap & (1ULL << 63))) {
                ata_dev_dbg(dev,
                            "Trusted Computing capability qword not valid!\n");
                return;
        }

        if (trusted_cap & (1 << 0))
                dev->flags |= ATA_DFLAG_TRUSTED;
}

/**
 *      ata_dev_configure - Configure the specified ATA/ATAPI device
 *      @dev: Target device to configure
 *
 *      Configure @dev according to @dev->id.  Generic and low-level
 *      driver specific fixups are also applied.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 *
 *      RETURNS:
 *      0 on success, -errno otherwise
 */
int ata_dev_configure(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        struct ata_eh_context *ehc = &dev->link->eh_context;
        int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
        const u16 *id = dev->id;
        unsigned long xfer_mask;
        unsigned int err_mask;
        char revbuf[7];         /* XYZ-99\0 */
        char fwrevbuf[ATA_ID_FW_REV_LEN+1];
        char modelbuf[ATA_ID_PROD_LEN+1];
        int rc;

        if (!ata_dev_enabled(dev) && ata_msg_info(ap)) {
                ata_dev_info(dev, "%s: ENTER/EXIT -- nodev\n", __func__);
                return 0;
        }

        if (ata_msg_probe(ap))
                ata_dev_dbg(dev, "%s: ENTER\n", __func__);

        /* set horkage */
        dev->horkage |= ata_dev_blacklisted(dev);
        ata_force_horkage(dev);

        if (dev->horkage & ATA_HORKAGE_DISABLE) {
                ata_dev_info(dev, "unsupported device, disabling\n");
                ata_dev_disable(dev);
                return 0;
        }

        if ((!atapi_enabled || (ap->flags & ATA_FLAG_NO_ATAPI)) &&
            dev->class == ATA_DEV_ATAPI) {
                ata_dev_warn(dev, "WARNING: ATAPI is %s, device ignored\n",
                             atapi_enabled ? "not supported with this driver"
                             : "disabled");
                ata_dev_disable(dev);
                return 0;
        }

        rc = ata_do_link_spd_horkage(dev);
        if (rc)
                return rc;

        /* some WD SATA-1 drives have issues with LPM, turn on NOLPM for them */
        if ((dev->horkage & ATA_HORKAGE_WD_BROKEN_LPM) &&
            (id[ATA_ID_SATA_CAPABILITY] & 0xe) == 0x2)
                dev->horkage |= ATA_HORKAGE_NOLPM;

        if (ap->flags & ATA_FLAG_NO_LPM)
                dev->horkage |= ATA_HORKAGE_NOLPM;

        if (dev->horkage & ATA_HORKAGE_NOLPM) {
                ata_dev_warn(dev, "LPM support broken, forcing max_power\n");
                dev->link->ap->target_lpm_policy = ATA_LPM_MAX_POWER;
        }

        /* let ACPI work its magic */
        rc = ata_acpi_on_devcfg(dev);
        if (rc)
                return rc;

        /* massage HPA, do it early as it might change IDENTIFY data */
        rc = ata_hpa_resize(dev);
        if (rc)
                return rc;

        /* print device capabilities */
        if (ata_msg_probe(ap))
                ata_dev_dbg(dev,
                            "%s: cfg 49:%04x 82:%04x 83:%04x 84:%04x "
                            "85:%04x 86:%04x 87:%04x 88:%04x\n",
                            __func__,
                            id[49], id[82], id[83], id[84],
                            id[85], id[86], id[87], id[88]);

        /* initialize to-be-configured parameters */
        dev->flags &= ~ATA_DFLAG_CFG_MASK;
        dev->max_sectors = 0;
        dev->cdb_len = 0;
        dev->n_sectors = 0;
        dev->cylinders = 0;
        dev->heads = 0;
        dev->sectors = 0;
        dev->multi_count = 0;

        /*
         * common ATA, ATAPI feature tests
         */

        /* find max transfer mode; for printk only */
        xfer_mask = ata_id_xfermask(id);

        if (ata_msg_probe(ap))
                ata_dump_id(id);

        /* SCSI only uses 4-char revisions, dump full 8 chars from ATA */
        ata_id_c_string(dev->id, fwrevbuf, ATA_ID_FW_REV,
                        sizeof(fwrevbuf));

        ata_id_c_string(dev->id, modelbuf, ATA_ID_PROD,
                        sizeof(modelbuf));

        /* ATA-specific feature tests */
        if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
                if (ata_id_is_cfa(id)) {
                        /* CPRM may make this media unusable */
                        if (id[ATA_ID_CFA_KEY_MGMT] & 1)
                                ata_dev_warn(dev,
        "supports DRM functions and may not be fully accessible\n");
                        snprintf(revbuf, 7, "CFA");
                } else {
                        snprintf(revbuf, 7, "ATA-%d", ata_id_major_version(id));
                        /* Warn the user if the device has TPM extensions */
                        if (ata_id_has_tpm(id))
                                ata_dev_warn(dev,
        "supports DRM functions and may not be fully accessible\n");
                }

                dev->n_sectors = ata_id_n_sectors(id);

                /* get current R/W Multiple count setting */
                if ((dev->id[47] >> 8) == 0x80 && (dev->id[59] & 0x100)) {
                        unsigned int max = dev->id[47] & 0xff;
                        unsigned int cnt = dev->id[59] & 0xff;
                        /* only recognize/allow powers of two here */
                        if (is_power_of_2(max) && is_power_of_2(cnt))
                                if (cnt <= max)
                                        dev->multi_count = cnt;
                }

                if (ata_id_has_lba(id)) {
                        const char *lba_desc;
                        char ncq_desc[24];

                        lba_desc = "LBA";
                        dev->flags |= ATA_DFLAG_LBA;
                        if (ata_id_has_lba48(id)) {
                                dev->flags |= ATA_DFLAG_LBA48;
                                lba_desc = "LBA48";

                                if (dev->n_sectors >= (1UL << 28) &&
                                    ata_id_has_flush_ext(id))
                                        dev->flags |= ATA_DFLAG_FLUSH_EXT;
                        }

                        /* config NCQ */
                        rc = ata_dev_config_ncq(dev, ncq_desc, sizeof(ncq_desc));
                        if (rc)
                                return rc;

                        /* print device info to dmesg */
                        if (ata_msg_drv(ap) && print_info) {
                                ata_dev_info(dev, "%s: %s, %s, max %s\n",
                                             revbuf, modelbuf, fwrevbuf,
                                             ata_mode_string(xfer_mask));
                                ata_dev_info(dev,
                                             "%llu sectors, multi %u: %s %s\n",
                                        (unsigned long long)dev->n_sectors,
                                        dev->multi_count, lba_desc, ncq_desc);
                        }
                } else {
                        /* CHS */

                        /* Default translation */
                        dev->cylinders  = id[1];
                        dev->heads      = id[3];
                        dev->sectors    = id[6];

                        if (ata_id_current_chs_valid(id)) {
                                /* Current CHS translation is valid. */
                                dev->cylinders = id[54];
                                dev->heads     = id[55];
                                dev->sectors   = id[56];
                        }

                        /* print device info to dmesg */
                        if (ata_msg_drv(ap) && print_info) {
                                ata_dev_info(dev, "%s: %s, %s, max %s\n",
                                             revbuf,    modelbuf, fwrevbuf,
                                             ata_mode_string(xfer_mask));
                                ata_dev_info(dev,
                                             "%llu sectors, multi %u, CHS %u/%u/%u\n",
                                             (unsigned long long)dev->n_sectors,
                                             dev->multi_count, dev->cylinders,
                                             dev->heads, dev->sectors);
                        }
                }

                /* Check and mark DevSlp capability. Get DevSlp timing variables
                 * from SATA Settings page of Identify Device Data Log.
                 */
                if (ata_id_has_devslp(dev->id)) {
                        u8 *sata_setting = ap->sector_buf;
                        int i, j;

                        dev->flags |= ATA_DFLAG_DEVSLP;
                        err_mask = ata_read_log_page(dev,
                                                     ATA_LOG_IDENTIFY_DEVICE,
                                                     ATA_LOG_SATA_SETTINGS,
                                                     sata_setting,
                                                     1);
                        if (err_mask)
                                ata_dev_dbg(dev,
                                            "failed to get Identify Device Data, Emask 0x%x\n",
                                            err_mask);
                        else
                                for (i = 0; i < ATA_LOG_DEVSLP_SIZE; i++) {
                                        j = ATA_LOG_DEVSLP_OFFSET + i;
                                        dev->devslp_timing[i] = sata_setting[j];
                                }
                }
                ata_dev_config_sense_reporting(dev);
                ata_dev_config_zac(dev);
                ata_dev_config_trusted(dev);
                dev->cdb_len = 32;
        }

        /* ATAPI-specific feature tests */
        else if (dev->class == ATA_DEV_ATAPI) {
                const char *cdb_intr_string = "";
                const char *atapi_an_string = "";
                const char *dma_dir_string = "";
                u32 sntf;

                rc = atapi_cdb_len(id);
                if ((rc < 12) || (rc > ATAPI_CDB_LEN)) {
                        if (ata_msg_warn(ap))
                                ata_dev_warn(dev, "unsupported CDB len\n");
                        rc = -EINVAL;
                        goto err_out_nosup;
                }
                dev->cdb_len = (unsigned int) rc;

                /* Enable ATAPI AN if both the host and device have
                 * the support.  If PMP is attached, SNTF is required
                 * to enable ATAPI AN to discern between PHY status
                 * changed notifications and ATAPI ANs.
                 */
                if (atapi_an &&
                    (ap->flags & ATA_FLAG_AN) && ata_id_has_atapi_AN(id) &&
                    (!sata_pmp_attached(ap) ||
                     sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf) == 0)) {
                        /* issue SET feature command to turn this on */
                        err_mask = ata_dev_set_feature(dev,
                                        SETFEATURES_SATA_ENABLE, SATA_AN);
                        if (err_mask)
                                ata_dev_err(dev,
                                            "failed to enable ATAPI AN (err_mask=0x%x)\n",
                                            err_mask);
                        else {
                                dev->flags |= ATA_DFLAG_AN;
                                atapi_an_string = ", ATAPI AN";
                        }
                }

                if (ata_id_cdb_intr(dev->id)) {
                        dev->flags |= ATA_DFLAG_CDB_INTR;
                        cdb_intr_string = ", CDB intr";
                }

                if (atapi_dmadir || (dev->horkage & ATA_HORKAGE_ATAPI_DMADIR) || atapi_id_dmadir(dev->id)) {
                        dev->flags |= ATA_DFLAG_DMADIR;
                        dma_dir_string = ", DMADIR";
                }

                if (ata_id_has_da(dev->id)) {
                        dev->flags |= ATA_DFLAG_DA;
                        zpodd_init(dev);
                }

                /* print device info to dmesg */
                if (ata_msg_drv(ap) && print_info)
                        ata_dev_info(dev,
                                     "ATAPI: %s, %s, max %s%s%s%s\n",
                                     modelbuf, fwrevbuf,
                                     ata_mode_string(xfer_mask),
                                     cdb_intr_string, atapi_an_string,
                                     dma_dir_string);
        }

        /* determine max_sectors */
        dev->max_sectors = ATA_MAX_SECTORS;
        if (dev->flags & ATA_DFLAG_LBA48)
                dev->max_sectors = ATA_MAX_SECTORS_LBA48;

        /* Limit PATA drive on SATA cable bridge transfers to udma5,
           200 sectors */
        if (ata_dev_knobble(dev)) {
                if (ata_msg_drv(ap) && print_info)
                        ata_dev_info(dev, "applying bridge limits\n");
                dev->udma_mask &= ATA_UDMA5;
                dev->max_sectors = ATA_MAX_SECTORS;
        }

        if ((dev->class == ATA_DEV_ATAPI) &&
            (atapi_command_packet_set(id) == TYPE_TAPE)) {
                dev->max_sectors = ATA_MAX_SECTORS_TAPE;
                dev->horkage |= ATA_HORKAGE_STUCK_ERR;
        }

        if (dev->horkage & ATA_HORKAGE_MAX_SEC_128)
                dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_128,
                                         dev->max_sectors);

        if (dev->horkage & ATA_HORKAGE_MAX_SEC_1024)
                dev->max_sectors = min_t(unsigned int, ATA_MAX_SECTORS_1024,
                                         dev->max_sectors);

        if (dev->horkage & ATA_HORKAGE_MAX_SEC_LBA48)
                dev->max_sectors = ATA_MAX_SECTORS_LBA48;

        if (ap->ops->dev_config)
                ap->ops->dev_config(dev);

        if (dev->horkage & ATA_HORKAGE_DIAGNOSTIC) {
                /* Let the user know. We don't want to disallow opens for
                   rescue purposes, or in case the vendor is just a blithering
                   idiot. Do this after the dev_config call as some controllers
                   with buggy firmware may want to avoid reporting false device
                   bugs */

                if (print_info) {
                        ata_dev_warn(dev,
"Drive reports diagnostics failure. This may indicate a drive\n");
                        ata_dev_warn(dev,
"fault or invalid emulation. Contact drive vendor for information.\n");
                }
        }

        if ((dev->horkage & ATA_HORKAGE_FIRMWARE_WARN) && print_info) {
                ata_dev_warn(dev, "WARNING: device requires firmware update to be fully functional\n");
                ata_dev_warn(dev, "         contact the vendor or visit http://ata.wiki.kernel.org\n");
        }

        return 0;

err_out_nosup:
        if (ata_msg_probe(ap))
                ata_dev_dbg(dev, "%s: EXIT, err\n", __func__);
        return rc;
}

/**
 *      ata_cable_40wire        -       return 40 wire cable type
 *      @ap: port
 *
 *      Helper method for drivers which want to hardwire 40 wire cable
 *      detection.
 */

int ata_cable_40wire(struct ata_port *ap)
{
        return ATA_CBL_PATA40;
}
EXPORT_SYMBOL_GPL(ata_cable_40wire);

/**
 *      ata_cable_80wire        -       return 80 wire cable type
 *      @ap: port
 *
 *      Helper method for drivers which want to hardwire 80 wire cable
 *      detection.
 */

int ata_cable_80wire(struct ata_port *ap)
{
        return ATA_CBL_PATA80;
}
EXPORT_SYMBOL_GPL(ata_cable_80wire);

/**
 *      ata_cable_unknown       -       return unknown PATA cable.
 *      @ap: port
 *
 *      Helper method for drivers which have no PATA cable detection.
 */

int ata_cable_unknown(struct ata_port *ap)
{
        return ATA_CBL_PATA_UNK;
}
EXPORT_SYMBOL_GPL(ata_cable_unknown);

/**
 *      ata_cable_ignore        -       return ignored PATA cable.
 *      @ap: port
 *
 *      Helper method for drivers which don't use cable type to limit
 *      transfer mode.
 */
int ata_cable_ignore(struct ata_port *ap)
{
        return ATA_CBL_PATA_IGN;
}
EXPORT_SYMBOL_GPL(ata_cable_ignore);

/**
 *      ata_cable_sata  -       return SATA cable type
 *      @ap: port
 *
 *      Helper method for drivers which have SATA cables
 */

int ata_cable_sata(struct ata_port *ap)
{
        return ATA_CBL_SATA;
}
EXPORT_SYMBOL_GPL(ata_cable_sata);

/**
 *      ata_bus_probe - Reset and probe ATA bus
 *      @ap: Bus to probe
 *
 *      Master ATA bus probing function.  Initiates a hardware-dependent
 *      bus reset, then attempts to identify any devices found on
 *      the bus.
 *
 *      LOCKING:
 *      PCI/etc. bus probe sem.
 *
 *      RETURNS:
 *      Zero on success, negative errno otherwise.
 */

int ata_bus_probe(struct ata_port *ap)
{
        unsigned int classes[ATA_MAX_DEVICES];
        int tries[ATA_MAX_DEVICES];
        int rc;
        struct ata_device *dev;

        ata_for_each_dev(dev, &ap->link, ALL)
                tries[dev->devno] = ATA_PROBE_MAX_TRIES;

 retry:
        ata_for_each_dev(dev, &ap->link, ALL) {
                /* If we issue an SRST then an ATA drive (not ATAPI)
                 * may change configuration and be in PIO0 timing. If
                 * we do a hard reset (or are coming from power on)
                 * this is true for ATA or ATAPI. Until we've set a
                 * suitable controller mode we should not touch the
                 * bus as we may be talking too fast.
                 */
                dev->pio_mode = XFER_PIO_0;
                dev->dma_mode = 0xff;

                /* If the controller has a pio mode setup function
                 * then use it to set the chipset to rights. Don't
                 * touch the DMA setup as that will be dealt with when
                 * configuring devices.
                 */
                if (ap->ops->set_piomode)
                        ap->ops->set_piomode(ap, dev);
        }

        /* reset and determine device classes */
        ap->ops->phy_reset(ap);

        ata_for_each_dev(dev, &ap->link, ALL) {
                if (dev->class != ATA_DEV_UNKNOWN)
                        classes[dev->devno] = dev->class;
                else
                        classes[dev->devno] = ATA_DEV_NONE;

                dev->class = ATA_DEV_UNKNOWN;
        }

        /* read IDENTIFY page and configure devices. We have to do the identify
           specific sequence bass-ackwards so that PDIAG- is released by
           the slave device */

        ata_for_each_dev(dev, &ap->link, ALL_REVERSE) {
                if (tries[dev->devno])
                        dev->class = classes[dev->devno];

                if (!ata_dev_enabled(dev))
                        continue;

                rc = ata_dev_read_id(dev, &dev->class, ATA_READID_POSTRESET,
                                     dev->id);
                if (rc)
                        goto fail;
        }

        /* Now ask for the cable type as PDIAG- should have been released */
        if (ap->ops->cable_detect)
                ap->cbl = ap->ops->cable_detect(ap);

        /* We may have SATA bridge glue hiding here irrespective of
         * the reported cable types and sensed types.  When SATA
         * drives indicate we have a bridge, we don't know which end
         * of the link the bridge is which is a problem.
         */
        ata_for_each_dev(dev, &ap->link, ENABLED)
                if (ata_id_is_sata(dev->id))
                        ap->cbl = ATA_CBL_SATA;

        /* After the identify sequence we can now set up the devices. We do
           this in the normal order so that the user doesn't get confused */

        ata_for_each_dev(dev, &ap->link, ENABLED) {
                ap->link.eh_context.i.flags |= ATA_EHI_PRINTINFO;
                rc = ata_dev_configure(dev);
                ap->link.eh_context.i.flags &= ~ATA_EHI_PRINTINFO;
                if (rc)
                        goto fail;
        }

        /* configure transfer mode */
        rc = ata_set_mode(&ap->link, &dev);
        if (rc)
                goto fail;

        ata_for_each_dev(dev, &ap->link, ENABLED)
                return 0;

        return -ENODEV;

 fail:
        tries[dev->devno]--;

        switch (rc) {
        case -EINVAL:
                /* eeek, something went very wrong, give up */
                tries[dev->devno] = 0;
                break;

        case -ENODEV:
                /* give it just one more chance */
                tries[dev->devno] = min(tries[dev->devno], 1);
                fallthrough;
        case -EIO:
                if (tries[dev->devno] == 1) {
                        /* This is the last chance, better to slow
                         * down than lose it.
                         */
                        sata_down_spd_limit(&ap->link, 0);
                        ata_down_xfermask_limit(dev, ATA_DNXFER_PIO);
                }
        }

        if (!tries[dev->devno])
                ata_dev_disable(dev);

        goto retry;
}

/**
 *      sata_print_link_status - Print SATA link status
 *      @link: SATA link to printk link status about
 *
 *      This function prints link speed and status of a SATA link.
 *
 *      LOCKING:
 *      None.
 */
static void sata_print_link_status(struct ata_link *link)
{
        u32 sstatus, scontrol, tmp;

        if (sata_scr_read(link, SCR_STATUS, &sstatus))
                return;
        sata_scr_read(link, SCR_CONTROL, &scontrol);

        if (ata_phys_link_online(link)) {
                tmp = (sstatus >> 4) & 0xf;
                ata_link_info(link, "SATA link up %s (SStatus %X SControl %X)\n",
                              sata_spd_string(tmp), sstatus, scontrol);
        } else {
                ata_link_info(link, "SATA link down (SStatus %X SControl %X)\n",
                              sstatus, scontrol);
        }
}

/**
 *      ata_dev_pair            -       return other device on cable
 *      @adev: device
 *
 *      Obtain the other device on the same cable, or if none is
 *      present NULL is returned
 */

struct ata_device *ata_dev_pair(struct ata_device *adev)
{
        struct ata_link *link = adev->link;
        struct ata_device *pair = &link->device[1 - adev->devno];
        if (!ata_dev_enabled(pair))
                return NULL;
        return pair;
}
EXPORT_SYMBOL_GPL(ata_dev_pair);

/**
 *      sata_down_spd_limit - adjust SATA spd limit downward
 *      @link: Link to adjust SATA spd limit for
 *      @spd_limit: Additional limit
 *
 *      Adjust SATA spd limit of @link downward.  Note that this
 *      function only adjusts the limit.  The change must be applied
 *      using sata_set_spd().
 *
 *      If @spd_limit is non-zero, the speed is limited to equal to or
 *      lower than @spd_limit if such speed is supported.  If
 *      @spd_limit is slower than any supported speed, only the lowest
 *      supported speed is allowed.
 *
 *      LOCKING:
 *      Inherited from caller.
 *
 *      RETURNS:
 *      0 on success, negative errno on failure
 */
int sata_down_spd_limit(struct ata_link *link, u32 spd_limit)
{
        u32 sstatus, spd, mask;
        int rc, bit;

        if (!sata_scr_valid(link))
                return -EOPNOTSUPP;

        /* If SCR can be read, use it to determine the current SPD.

         * If not, use cached value in link->sata_spd.
         */
        rc = sata_scr_read(link, SCR_STATUS, &sstatus);
        if (rc == 0 && ata_sstatus_online(sstatus))
                spd = (sstatus >> 4) & 0xf;
        else
                spd = link->sata_spd;

        mask = link->sata_spd_limit;
        if (mask <= 1)
                return -EINVAL;

        /* unconditionally mask off the highest bit */
        bit = fls(mask) - 1;
        mask &= ~(1 << bit);

        /*
         * Mask off all speeds higher than or equal to the current one.  At
         * this point, if current SPD is not available and we previously
         * recorded the link speed from SStatus, the driver has already
         * masked off the highest bit so mask should already be 1 or 0.
         * Otherwise, we should not force 1.5Gbps on a link where we have
         * not previously recorded speed from SStatus.  Just return in this
         * case.
         */
        if (spd > 1)
                mask &= (1 << (spd - 1)) - 1;
        else
                return -EINVAL;

        /* were we already at the bottom? */
        if (!mask)
                return -EINVAL;

        if (spd_limit) {
                if (mask & ((1 << spd_limit) - 1))
                        mask &= (1 << spd_limit) - 1;
                else {
                        bit = ffs(mask) - 1;
                        mask = 1 << bit;
                }
        }

        link->sata_spd_limit = mask;

        ata_link_warn(link, "limiting SATA link speed to %s\n",
                      sata_spd_string(fls(mask)));

        return 0;
}

#ifdef CONFIG_ATA_ACPI
/**
 *      ata_timing_cycle2mode - find xfer mode for the specified cycle duration
 *      @xfer_shift: ATA_SHIFT_* value for transfer type to examine.
 *      @cycle: cycle duration in ns
 *
 *      Return matching xfer mode for @cycle.  The returned mode is of
 *      the transfer type specified by @xfer_shift.  If @cycle is too
 *      slow for @xfer_shift, 0xff is returned.  If @cycle is faster
 *      than the fastest known mode, the fasted mode is returned.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      Matching xfer_mode, 0xff if no match found.
 */
u8 ata_timing_cycle2mode(unsigned int xfer_shift, int cycle)
{
        u8 base_mode = 0xff, last_mode = 0xff;
        const struct ata_xfer_ent *ent;
        const struct ata_timing *t;

        for (ent = ata_xfer_tbl; ent->shift >= 0; ent++)
                if (ent->shift == xfer_shift)
                        base_mode = ent->base;

        for (t = ata_timing_find_mode(base_mode);
             t && ata_xfer_mode2shift(t->mode) == xfer_shift; t++) {
                unsigned short this_cycle;

                switch (xfer_shift) {
                case ATA_SHIFT_PIO:
                case ATA_SHIFT_MWDMA:
                        this_cycle = t->cycle;
                        break;
                case ATA_SHIFT_UDMA:
                        this_cycle = t->udma;
                        break;
                default:
                        return 0xff;
                }

                if (cycle > this_cycle)
                        break;

                last_mode = t->mode;
        }

        return last_mode;
}
#endif

/**
 *      ata_down_xfermask_limit - adjust dev xfer masks downward
 *      @dev: Device to adjust xfer masks
 *      @sel: ATA_DNXFER_* selector
 *
 *      Adjust xfer masks of @dev downward.  Note that this function
 *      does not apply the change.  Invoking ata_set_mode() afterwards
 *      will apply the limit.
 *
 *      LOCKING:
 *      Inherited from caller.
 *
 *      RETURNS:
 *      0 on success, negative errno on failure
 */
int ata_down_xfermask_limit(struct ata_device *dev, unsigned int sel)
{
        char buf[32];
        unsigned long orig_mask, xfer_mask;
        unsigned long pio_mask, mwdma_mask, udma_mask;
        int quiet, highbit;

        quiet = !!(sel & ATA_DNXFER_QUIET);
        sel &= ~ATA_DNXFER_QUIET;

        xfer_mask = orig_mask = ata_pack_xfermask(dev->pio_mask,
                                                  dev->mwdma_mask,
                                                  dev->udma_mask);
        ata_unpack_xfermask(xfer_mask, &pio_mask, &mwdma_mask, &udma_mask);

        switch (sel) {
        case ATA_DNXFER_PIO:
                highbit = fls(pio_mask) - 1;
                pio_mask &= ~(1 << highbit);
                break;

        case ATA_DNXFER_DMA:
                if (udma_mask) {
                        highbit = fls(udma_mask) - 1;
                        udma_mask &= ~(1 << highbit);
                        if (!udma_mask)
                                return -ENOENT;
                } else if (mwdma_mask) {
                        highbit = fls(mwdma_mask) - 1;
                        mwdma_mask &= ~(1 << highbit);
                        if (!mwdma_mask)
                                return -ENOENT;
                }
                break;

        case ATA_DNXFER_40C:
                udma_mask &= ATA_UDMA_MASK_40C;
                break;

        case ATA_DNXFER_FORCE_PIO0:
                pio_mask &= 1;
                fallthrough;
        case ATA_DNXFER_FORCE_PIO:
                mwdma_mask = 0;
                udma_mask = 0;
                break;

        default:
                BUG();
        }

        xfer_mask &= ata_pack_xfermask(pio_mask, mwdma_mask, udma_mask);

        if (!(xfer_mask & ATA_MASK_PIO) || xfer_mask == orig_mask)
                return -ENOENT;

        if (!quiet) {
                if (xfer_mask & (ATA_MASK_MWDMA | ATA_MASK_UDMA))
                        snprintf(buf, sizeof(buf), "%s:%s",
                                 ata_mode_string(xfer_mask),
                                 ata_mode_string(xfer_mask & ATA_MASK_PIO));
                else
                        snprintf(buf, sizeof(buf), "%s",
                                 ata_mode_string(xfer_mask));

                ata_dev_warn(dev, "limiting speed to %s\n", buf);
        }

        ata_unpack_xfermask(xfer_mask, &dev->pio_mask, &dev->mwdma_mask,
                            &dev->udma_mask);

        return 0;
}

static int ata_dev_set_mode(struct ata_device *dev)
{
        struct ata_port *ap = dev->link->ap;
        struct ata_eh_context *ehc = &dev->link->eh_context;
        const bool nosetxfer = dev->horkage & ATA_HORKAGE_NOSETXFER;
        const char *dev_err_whine = "";
        int ign_dev_err = 0;
        unsigned int err_mask = 0;
        int rc;

        dev->flags &= ~ATA_DFLAG_PIO;
        if (dev->xfer_shift == ATA_SHIFT_PIO)
                dev->flags |= ATA_DFLAG_PIO;

        if (nosetxfer && ap->flags & ATA_FLAG_SATA && ata_id_is_sata(dev->id))
                dev_err_whine = " (SET_XFERMODE skipped)";
        else {
                if (nosetxfer)
                        ata_dev_warn(dev,
                                     "NOSETXFER but PATA detected - can't "
                                     "skip SETXFER, might malfunction\n");
                err_mask = ata_dev_set_xfermode(dev);
        }

        if (err_mask & ~AC_ERR_DEV)
                goto fail;

        /* revalidate */
        ehc->i.flags |= ATA_EHI_POST_SETMODE;
        rc = ata_dev_revalidate(dev, ATA_DEV_UNKNOWN, 0);
        ehc->i.flags &= ~ATA_EHI_POST_SETMODE;
        if (rc)
                return rc;

        if (dev->xfer_shift == ATA_SHIFT_PIO) {
                /* Old CFA may refuse this command, which is just fine */
                if (ata_id_is_cfa(dev->id))
                        ign_dev_err = 1;
                /* Catch several broken garbage emulations plus some pre
                   ATA devices */
                if (ata_id_major_version(dev->id) == 0 &&
                                        dev->pio_mode <= XFER_PIO_2)
                        ign_dev_err = 1;
                /* Some very old devices and some bad newer ones fail
                   any kind of SET_XFERMODE request but support PIO0-2
                   timings and no IORDY */
                if (!ata_id_has_iordy(dev->id) && dev->pio_mode <= XFER_PIO_2)
                        ign_dev_err = 1;
        }
        /* Early MWDMA devices do DMA but don't allow DMA mode setting.
           Don't fail an MWDMA0 set IFF the device indicates it is in MWDMA0 */
        if (dev->xfer_shift == ATA_SHIFT_MWDMA &&
            dev->dma_mode == XFER_MW_DMA_0 &&
            (dev->id[63] >> 8) & 1)
                ign_dev_err = 1;

        /* if the device is actually configured correctly, ignore dev err */
        if (dev->xfer_mode == ata_xfer_mask2mode(ata_id_xfermask(dev->id)))
                ign_dev_err = 1;

        if (err_mask & AC_ERR_DEV) {
                if (!ign_dev_err)
                        goto fail;
                else
                        dev_err_whine = " (device error ignored)";
        }

        DPRINTK("xfer_shift=%u, xfer_mode=0x%x\n",
                dev->xfer_shift, (int)dev->xfer_mode);

        if (!(ehc->i.flags & ATA_EHI_QUIET) ||
            ehc->i.flags & ATA_EHI_DID_HARDRESET)
                ata_dev_info(dev, "configured for %s%s\n",
                             ata_mode_string(ata_xfer_mode2mask(dev->xfer_mode)),
                             dev_err_whine);

        return 0;

 fail:
        ata_dev_err(dev, "failed to set xfermode (err_mask=0x%x)\n", err_mask);
        return -EIO;
}

/**
 *      ata_do_set_mode - Program timings and issue SET FEATURES - XFER
 *      @link: link on which timings will be programmed
 *      @r_failed_dev: out parameter for failed device
 *
 *      Standard implementation of the function used to tune and set
 *      ATA device disk transfer mode (PIO3, UDMA6, etc.).  If
 *      ata_dev_set_mode() fails, pointer to the failing device is
 *      returned in @r_failed_dev.
 *
 *      LOCKING:
 *      PCI/etc. bus probe sem.
 *
 *      RETURNS:
 *      0 on success, negative errno otherwise
 */

int ata_do_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
{
        struct ata_port *ap = link->ap;
        struct ata_device *dev;
        int rc = 0, used_dma = 0, found = 0;

        /* step 1: calculate xfer_mask */
        ata_for_each_dev(dev, link, ENABLED) {
                unsigned long pio_mask, dma_mask;
                unsigned int mode_mask;

                mode_mask = ATA_DMA_MASK_ATA;
                if (dev->class == ATA_DEV_ATAPI)
                        mode_mask = ATA_DMA_MASK_ATAPI;
                else if (ata_id_is_cfa(dev->id))
                        mode_mask = ATA_DMA_MASK_CFA;

                ata_dev_xfermask(dev);
                ata_force_xfermask(dev);

                pio_mask = ata_pack_xfermask(dev->pio_mask, 0, 0);

                if (libata_dma_mask & mode_mask)
                        dma_mask = ata_pack_xfermask(0, dev->mwdma_mask,
                                                     dev->udma_mask);
                else
                        dma_mask = 0;

                dev->pio_mode = ata_xfer_mask2mode(pio_mask);
                dev->dma_mode = ata_xfer_mask2mode(dma_mask);

                found = 1;
                if (ata_dma_enabled(dev))
                        used_dma = 1;
        }
        if (!found)
                goto out;

        /* step 2: always set host PIO timings */
        ata_for_each_dev(dev, link, ENABLED) {
                if (dev->pio_mode == 0xff) {
                        ata_dev_warn(dev, "no PIO support\n");
                        rc = -EINVAL;
                        goto out;
                }

                dev->xfer_mode = dev->pio_mode;
                dev->xfer_shift = ATA_SHIFT_PIO;
                if (ap->ops->set_piomode)
                        ap->ops->set_piomode(ap, dev);
        }

        /* step 3: set host DMA timings */
        ata_for_each_dev(dev, link, ENABLED) {
                if (!ata_dma_enabled(dev))
                        continue;

                dev->xfer_mode = dev->dma_mode;
                dev->xfer_shift = ata_xfer_mode2shift(dev->dma_mode);
                if (ap->ops->set_dmamode)
                        ap->ops->set_dmamode(ap, dev);
        }

        /* step 4: update devices' xfer mode */
        ata_for_each_dev(dev, link, ENABLED) {
                rc = ata_dev_set_mode(dev);
                if (rc)
                        goto out;
        }

        /* Record simplex status. If we selected DMA then the other
         * host channels are not permitted to do so.
         */
        if (used_dma && (ap->host->flags & ATA_HOST_SIMPLEX))
                ap->host->simplex_claimed = ap;

 out:
        if (rc)
                *r_failed_dev = dev;
        return rc;
}
EXPORT_SYMBOL_GPL(ata_do_set_mode);

/**
 *      ata_wait_ready - wait for link to become ready
 *      @link: link to be waited on
 *      @deadline: deadline jiffies for the operation
 *      @check_ready: callback to check link readiness
 *
 *      Wait for @link to become ready.  @check_ready should return
 *      positive number if @link is ready, 0 if it isn't, -ENODEV if
 *      link doesn't seem to be occupied, other errno for other error
 *      conditions.
 *
 *      Transient -ENODEV conditions are allowed for
 *      ATA_TMOUT_FF_WAIT.
 *
 *      LOCKING:
 *      EH context.
 *
 *      RETURNS:
 *      0 if @link is ready before @deadline; otherwise, -errno.
 */
int ata_wait_ready(struct ata_link *link, unsigned long deadline,
                   int (*check_ready)(struct ata_link *link))
{
        unsigned long start = jiffies;
        unsigned long nodev_deadline;
        int warned = 0;

        /* choose which 0xff timeout to use, read comment in libata.h */
        if (link->ap->host->flags & ATA_HOST_PARALLEL_SCAN)
                nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT_LONG);
        else
                nodev_deadline = ata_deadline(start, ATA_TMOUT_FF_WAIT);

        /* Slave readiness can't be tested separately from master.  On
         * M/S emulation configuration, this function should be called
         * only on the master and it will handle both master and slave.
         */
        WARN_ON(link == link->ap->slave_link);

        if (time_after(nodev_deadline, deadline))
                nodev_deadline = deadline;

        while (1) {
                unsigned long now = jiffies;
                int ready, tmp;

                ready = tmp = check_ready(link);
                if (ready > 0)
                        return 0;

                /*
                 * -ENODEV could be transient.  Ignore -ENODEV if link
                 * is online.  Also, some SATA devices take a long
                 * time to clear 0xff after reset.  Wait for
                 * ATA_TMOUT_FF_WAIT[_LONG] on -ENODEV if link isn't
                 * offline.
                 *
                 * Note that some PATA controllers (pata_ali) explode
                 * if status register is read more than once when
                 * there's no device attached.
                 */
                if (ready == -ENODEV) {
                        if (ata_link_online(link))
                                ready = 0;
                        else if ((link->ap->flags & ATA_FLAG_SATA) &&
                                 !ata_link_offline(link) &&
                                 time_before(now, nodev_deadline))
                                ready = 0;
                }

                if (ready)
                        return ready;
                if (time_after(now, deadline))
                        return -EBUSY;

                if (!warned && time_after(now, start + 5 * HZ) &&
                    (deadline - now > 3 * HZ)) {
                        ata_link_warn(link,
                                "link is slow to respond, please be patient "
                                "(ready=%d)\n", tmp);
                        warned = 1;
                }

                ata_msleep(link->ap, 50);
        }
}

/**
 *      ata_wait_after_reset - wait for link to become ready after reset
 *      @link: link to be waited on
 *      @deadline: deadline jiffies for the operation
 *      @check_ready: callback to check link readiness
 *
 *      Wait for @link to become ready after reset.
 *
 *      LOCKING:
 *      EH context.
 *
 *      RETURNS:
 *      0 if @link is ready before @deadline; otherwise, -errno.
 */
int ata_wait_after_reset(struct ata_link *link, unsigned long deadline,
                                int (*check_ready)(struct ata_link *link))
{
        ata_msleep(link->ap, ATA_WAIT_AFTER_RESET);

        return ata_wait_ready(link, deadline, check_ready);
}
EXPORT_SYMBOL_GPL(ata_wait_after_reset);

/**
 *      ata_std_prereset - prepare for reset
 *      @link: ATA link to be reset
 *      @deadline: deadline jiffies for the operation
 *
 *      @link is about to be reset.  Initialize it.  Failure from
 *      prereset makes libata abort whole reset sequence and give up
 *      that port, so prereset should be best-effort.  It does its
 *      best to prepare for reset sequence but if things go wrong, it
 *      should just whine, not fail.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 *
 *      RETURNS:
 *      0 on success, -errno otherwise.
 */
int ata_std_prereset(struct ata_link *link, unsigned long deadline)
{
        struct ata_port *ap = link->ap;
        struct ata_eh_context *ehc = &link->eh_context;
        const unsigned long *timing = sata_ehc_deb_timing(ehc);
        int rc;

        /* if we're about to do hardreset, nothing more to do */
        if (ehc->i.action & ATA_EH_HARDRESET)
                return 0;

        /* if SATA, resume link */
        if (ap->flags & ATA_FLAG_SATA) {
                rc = sata_link_resume(link, timing, deadline);
                /* whine about phy resume failure but proceed */
                if (rc && rc != -EOPNOTSUPP)
                        ata_link_warn(link,
                                      "failed to resume link for reset (errno=%d)\n",
                                      rc);
        }

        /* no point in trying softreset on offline link */
        if (ata_phys_link_offline(link))
                ehc->i.action &= ~ATA_EH_SOFTRESET;

        return 0;
}
EXPORT_SYMBOL_GPL(ata_std_prereset);

/**
 *      sata_std_hardreset - COMRESET w/o waiting or classification
 *      @link: link to reset
 *      @class: resulting class of attached device
 *      @deadline: deadline jiffies for the operation
 *
 *      Standard SATA COMRESET w/o waiting or classification.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 *
 *      RETURNS:
 *      0 if link offline, -EAGAIN if link online, -errno on errors.
 */
int sata_std_hardreset(struct ata_link *link, unsigned int *class,
                       unsigned long deadline)
{
        const unsigned long *timing = sata_ehc_deb_timing(&link->eh_context);
        bool online;
        int rc;

        /* do hardreset */
        rc = sata_link_hardreset(link, timing, deadline, &online, NULL);
        return online ? -EAGAIN : rc;
}
EXPORT_SYMBOL_GPL(sata_std_hardreset);

/**
 *      ata_std_postreset - standard postreset callback
 *      @link: the target ata_link
 *      @classes: classes of attached devices
 *
 *      This function is invoked after a successful reset.  Note that
 *      the device might have been reset more than once using
 *      different reset methods before postreset is invoked.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 */
void ata_std_postreset(struct ata_link *link, unsigned int *classes)
{
        u32 serror;

        DPRINTK("ENTER\n");

        /* reset complete, clear SError */
        if (!sata_scr_read(link, SCR_ERROR, &serror))
                sata_scr_write(link, SCR_ERROR, serror);

        /* print link status */
        sata_print_link_status(link);

        DPRINTK("EXIT\n");
}
EXPORT_SYMBOL_GPL(ata_std_postreset);

/**
 *      ata_dev_same_device - Determine whether new ID matches configured device
 *      @dev: device to compare against
 *      @new_class: class of the new device
 *      @new_id: IDENTIFY page of the new device
 *
 *      Compare @new_class and @new_id against @dev and determine
 *      whether @dev is the device indicated by @new_class and
 *      @new_id.
 *
 *      LOCKING:
 *      None.
 *
 *      RETURNS:
 *      1 if @dev matches @new_class and @new_id, 0 otherwise.
 */
static int ata_dev_same_device(struct ata_device *dev, unsigned int new_class,
                               const u16 *new_id)
{
        const u16 *old_id = dev->id;
        unsigned char model[2][ATA_ID_PROD_LEN + 1];
        unsigned char serial[2][ATA_ID_SERNO_LEN + 1];

        if (dev->class != new_class) {
                ata_dev_info(dev, "class mismatch %d != %d\n",
                             dev->class, new_class);
                return 0;
        }

        ata_id_c_string(old_id, model[0], ATA_ID_PROD, sizeof(model[0]));
        ata_id_c_string(new_id, model[1], ATA_ID_PROD, sizeof(model[1]));
        ata_id_c_string(old_id, serial[0], ATA_ID_SERNO, sizeof(serial[0]));
        ata_id_c_string(new_id, serial[1], ATA_ID_SERNO, sizeof(serial[1]));

        if (strcmp(model[0], model[1])) {
                ata_dev_info(dev, "model number mismatch '%s' != '%s'\n",
                             model[0], model[1]);
                return 0;
        }

        if (strcmp(serial[0], serial[1])) {
                ata_dev_info(dev, "serial number mismatch '%s' != '%s'\n",
                             serial[0], serial[1]);
                return 0;
        }

        return 1;
}

/**
 *      ata_dev_reread_id - Re-read IDENTIFY data
 *      @dev: target ATA device
 *      @readid_flags: read ID flags
 *
 *      Re-read IDENTIFY page and make sure @dev is still attached to
 *      the port.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 *
 *      RETURNS:
 *      0 on success, negative errno otherwise
 */
int ata_dev_reread_id(struct ata_device *dev, unsigned int readid_flags)
{
        unsigned int class = dev->class;
        u16 *id = (void *)dev->link->ap->sector_buf;
        int rc;

        /* read ID data */
        rc = ata_dev_read_id(dev, &class, readid_flags, id);
        if (rc)
                return rc;

        /* is the device still there? */
        if (!ata_dev_same_device(dev, class, id))
                return -ENODEV;

        memcpy(dev->id, id, sizeof(id[0]) * ATA_ID_WORDS);
        return 0;
}

/**
 *      ata_dev_revalidate - Revalidate ATA device
 *      @dev: device to revalidate
 *      @new_class: new class code
 *      @readid_flags: read ID flags
 *
 *      Re-read IDENTIFY page, make sure @dev is still attached to the
 *      port and reconfigure it according to the new IDENTIFY page.
 *
 *      LOCKING:
 *      Kernel thread context (may sleep)
 *
 *      RETURNS:
 *      0 on success, negative errno otherwise
 */
int ata_dev_revalidate(struct ata_device *dev, unsigned int new_class,
                       unsigned int readid_flags)
{
        u64 n_sectors = dev->n_sectors;
        u64 n_native_sectors = dev->n_native_sectors;
        int rc;

        if (!ata_dev_enabled(dev))
                return -ENODEV;

        /* fail early if !ATA && !ATAPI to avoid issuing [P]IDENTIFY to PMP */
        if (ata_class_enabled(new_class) &&
            new_class != ATA_DEV_ATA &&
            new_class != ATA_DEV_ATAPI &&
            new_class != ATA_DEV_ZAC &&
            new_class != ATA_DEV_SEMB) {
                ata_dev_info(dev, "class mismatch %u != %u\n",
                             dev->class, new_class);
                rc = -ENODEV;
                goto fail;
        }

        /* re-read ID */
        rc = ata_dev_reread_id(dev, readid_flags);
        if (rc)
                goto fail;

        /* configure device according to the new ID */
        rc = ata_dev_configure(dev);
        if (rc)
                goto fail;

        /* verify n_sectors hasn't changed */
        if (dev->class != ATA_DEV_ATA || !n_sectors ||
            dev->n_sectors == n_sectors)
                return 0;

        /* n_sectors has changed */
        ata_dev_warn(dev, "n_sectors mismatch %llu != %llu\n",
                     (unsigned long long)n_sectors,
                     (unsigned long long)dev->n_sectors);

        /*
         * Something could have caused HPA to be unlocked
         * involuntarily.  If n_native_sectors hasn't changed and the
         * new size matches it, keep the device.
         */
        if (dev->n_native_sectors == n_native_sectors &&
            dev->n_sectors > n_sectors && dev->n_sectors == n_native_sectors) {
                ata_dev_warn(dev,
                             "new n_sectors matches native, probably "
                             "late HPA unlock, n_sectors updated\n");
                /* use the larger n_sectors */
                return 0;
        }

        /*
         * Some BIOSes boot w/o HPA but resume w/ HPA locked.  Try
         * unlocking HPA in those cases.
         *
         * https://bugzilla.kernel.org/show_bug.cgi?id=15396
         */
        if (dev->n_native_sectors == n_native_sectors &&
            dev->n_sectors < n_sectors && n_sectors == n_native_sectors &&
            !(dev->horkage & ATA_HORKAGE_BROKEN_HPA)) {
                ata_dev_warn(dev,
                             "old n_sectors matches native, probably "
                             "late HPA lock, will try to unlock HPA\n");
                /* try unlocking HPA */
                dev->flags |= ATA_DFLAG_UNLOCK_HPA;
                rc = -EIO;
        } else
                rc = -ENODEV;

        /* restore original n_[native_]sectors and fail */
        dev->n_native_sectors = n_native_sectors;
        dev->n_sectors = n_sectors;
 fail:
        ata_dev_err(dev, "revalidation failed (errno=%d)\n", rc);
        return rc;
}

struct ata_blacklist_entry {
        const char *model_num;
        const char *model_rev;
        unsigned long horkage;
};

static const struct ata_blacklist_entry ata_device_blacklist [] = {
        /* Devices with DMA related problems under Linux */
        { "WDC AC11000H",       NULL,           ATA_HORKAGE_NODMA },
        { "WDC AC22100H",       NULL,           ATA_HORKAGE_NODMA },
        { "WDC AC32500H",       NULL,           ATA_HORKAGE_NODMA },
        { "WDC AC33100H",       NULL,           ATA_HORKAGE_NODMA },
        { "WDC AC31600H",       NULL,           ATA_HORKAGE_NODMA },
        { "WDC AC32100H",       "24.09P07",     ATA_HORKAGE_NODMA },
        { "WDC AC23200L",       "21.10N21",     ATA_HORKAGE_NODMA },
        { "Compaq CRD-8241B",   NULL,           ATA_HORKAGE_NODMA },
        { "CRD-8400B",          NULL,           ATA_HORKAGE_NODMA },
        { "CRD-848[02]B",       NULL,           ATA_HORKAGE_NODMA },
        { "CRD-84",             NULL,           ATA_HORKAGE_NODMA },
        { "SanDisk SDP3B",      NULL,           ATA_HORKAGE_NODMA },
        { "SanDisk SDP3B-64",   NULL,           ATA_HORKAGE_NODMA },
        { "SANYO CD-ROM CRD",   NULL,           ATA_HORKAGE_NODMA },
        { "HITACHI CDR-8",      NULL,           ATA_HORKAGE_NODMA },
        { "HITACHI CDR-8[34]35",NULL,           ATA_HORKAGE_NODMA },
        { "Toshiba CD-ROM XM-6202B", NULL,      ATA_HORKAGE_NODMA },
        { "TOSHIBA CD-ROM XM-1702BC", NULL,     ATA_HORKAGE_NODMA },
        { "CD-532E-A",          NULL,           ATA_HORKAGE_NODMA },
        { "E-IDE CD-ROM CR-840",NULL,           ATA_HORKAGE_NODMA },
        { "CD-ROM Drive/F5A",   NULL,           ATA_HORKAGE_NODMA },
        { "WPI CDD-820",        NULL,           ATA_HORKAGE_NODMA },
        { "SAMSUNG CD-ROM SC-148C", NULL,       ATA_HORKAGE_NODMA },
        { "SAMSUNG CD-ROM SC",  NULL,           ATA_HORKAGE_NODMA },
        { "ATAPI CD-ROM DRIVE 40X MAXIMUM",NULL,ATA_HORKAGE_NODMA },
        { "_NEC DV5800A",       NULL,           ATA_HORKAGE_NODMA },
        { "SAMSUNG CD-ROM SN-124", "N001",      ATA_HORKAGE_NODMA },
        { "Seagate STT20000A", NULL,            ATA_HORKAGE_NODMA },
        { " 2GB ATA Flash Disk", "ADMA428M",    ATA_HORKAGE_NODMA },
        { "VRFDFC22048UCHC-TE*", NULL,          ATA_HORKAGE_NODMA },
        /* Odd clown on sil3726/4726 PMPs */
        { "Config  Disk",       NULL,           ATA_HORKAGE_DISABLE },

        /* Weird ATAPI devices */
        { "TORiSAN DVD-ROM DRD-N216", NULL,     ATA_HORKAGE_MAX_SEC_128 },
        { "QUANTUM DAT    DAT72-000", NULL,     ATA_HORKAGE_ATAPI_MOD16_DMA },
        { "Slimtype DVD A  DS8A8SH", NULL,      ATA_HORKAGE_MAX_SEC_LBA48 },
        { "Slimtype DVD A  DS8A9SH", NULL,      ATA_HORKAGE_MAX_SEC_LBA48 },

        /*
         * Causes silent data corruption with higher max sects.
         * http://lkml.kernel.org/g/x49wpy40ysk.fsf@segfault.boston.devel.redhat.com
         */
        { "ST380013AS",         "3.20",         ATA_HORKAGE_MAX_SEC_1024 },

        /*
         * These devices time out with higher max sects.
         * https://bugzilla.kernel.org/show_bug.cgi?id=121671
         */
        { "LITEON CX1-JB*-HP",  NULL,           ATA_HORKAGE_MAX_SEC_1024 },
        { "LITEON EP1-*",       NULL,           ATA_HORKAGE_MAX_SEC_1024 },

        /* Devices we expect to fail diagnostics */

        /* Devices where NCQ should be avoided */
        /* NCQ is slow */
        { "WDC WD740ADFD-00",   NULL,           ATA_HORKAGE_NONCQ },
        { "WDC WD740ADFD-00NLR1", NULL,         ATA_HORKAGE_NONCQ, },
        /* http://thread.gmane.org/gmane.linux.ide/14907 */
        { "FUJITSU MHT2060BH",  NULL,           ATA_HORKAGE_NONCQ },
        /* NCQ is broken */
        { "Maxtor *",           "BANC*",        ATA_HORKAGE_NONCQ },
        { "Maxtor 7V300F0",     "VA111630",     ATA_HORKAGE_NONCQ },
        { "ST380817AS",         "3.42",         ATA_HORKAGE_NONCQ },
        { "ST3160023AS",        "3.42",         ATA_HORKAGE_NONCQ },
        { "OCZ CORE_SSD",       "02.10104",     ATA_HORKAGE_NONCQ },

        /* Seagate NCQ + FLUSH CACHE firmware bug */
        { "ST31500341AS",       "SD1[5-9]",     ATA_HORKAGE_NONCQ |
                                                ATA_HORKAGE_FIRMWARE_WARN },

        { "ST31000333AS",       "SD1[5-9]",     ATA_HORKAGE_NONCQ |
                                                ATA_HORKAGE_FIRMWARE_WARN },

        { "ST3640[36]23AS",     "SD1[5-9]",     ATA_HORKAGE_NONCQ |
                                                ATA_HORKAGE_FIRMWARE_WARN },

        { "ST3320[68]13AS",     "SD1[5-9]",     ATA_HORKAGE_NONCQ |
                                                ATA_HORKAGE_FIRMWARE_WARN },

        /* drives which fail FPDMA_AA activation (some may freeze afterwards)
           the ST disks also have LPM issues */
        { "ST1000LM024 HN-M101MBB", NULL,       ATA_HORKAGE_BROKEN_FPDMA_AA |
                                                ATA_HORKAGE_NOLPM, },
        { "VB0250EAVER",        "HPG7",         ATA_HORKAGE_BROKEN_FPDMA_AA },

        /* Blacklist entries taken from Silicon Image 3124/3132
           Windows driver .inf file - also several Linux problem reports */
        { "HTS541060G9SA00",    "MB3OC60D",     ATA_HORKAGE_NONCQ, },
        { "HTS541080G9SA00",    "MB4OC60D",     ATA_HORKAGE_NONCQ, },
        { "HTS541010G9SA00",    "MBZOC60D",     ATA_HORKAGE_NONCQ, },

        /* https://bugzilla.kernel.org/show_bug.cgi?id=15573 */
        { "C300-CTFDDAC128MAG", "0001",         ATA_HORKAGE_NONCQ, },

        /* Sandisk SD7/8/9s lock up hard on large trims */
        { "SanDisk SD[789]*",   NULL,           ATA_HORKAGE_MAX_TRIM_128M, },

        /* devices which puke on READ_NATIVE_MAX */
        { "HDS724040KLSA80",    "KFAOA20N",     ATA_HORKAGE_BROKEN_HPA, },
        { "WDC WD3200JD-00KLB0", "WD-WCAMR1130137", ATA_HORKAGE_BROKEN_HPA },
        { "WDC WD2500JD-00HBB0", "WD-WMAL71490727", ATA_HORKAGE_BROKEN_HPA },
        { "MAXTOR 6L080L4",     "A93.0500",     ATA_HORKAGE_BROKEN_HPA },

        /* this one allows HPA unlocking but fails IOs on the area */
        { "OCZ-VERTEX",             "1.30",     ATA_HORKAGE_BROKEN_HPA },

        /* Devices which report 1 sector over size HPA */
        { "ST340823A",          NULL,           ATA_HORKAGE_HPA_SIZE, },
        { "ST320413A",          NULL,           ATA_HORKAGE_HPA_SIZE, },
        { "ST310211A",          NULL,           ATA_HORKAGE_HPA_SIZE, },

        /* Devices which get the IVB wrong */
        { "QUANTUM FIREBALLlct10 05", "A03.0900", ATA_HORKAGE_IVB, },
        /* Maybe we should just blacklist TSSTcorp... */
        { "TSSTcorp CDDVDW SH-S202[HJN]", "SB0[01]",  ATA_HORKAGE_IVB, },

        /* Devices that do not need bridging limits applied */
        { "MTRON MSP-SATA*",            NULL,   ATA_HORKAGE_BRIDGE_OK, },
        { "BUFFALO HD-QSU2/R5",         NULL,   ATA_HORKAGE_BRIDGE_OK, },

        /* Devices which aren't very happy with higher link speeds */
        { "WD My Book",                 NULL,   ATA_HORKAGE_1_5_GBPS, },
        { "Seagate FreeAgent GoFlex",   NULL,   ATA_HORKAGE_1_5_GBPS, },

        /*
         * Devices which choke on SETXFER.  Applies only if both the
         * device and controller are SATA.
         */
        { "PIONEER DVD-RW  DVRTD08",    NULL,   ATA_HORKAGE_NOSETXFER },
        { "PIONEER DVD-RW  DVRTD08A",   NULL,   ATA_HORKAGE_NOSETXFER },
        { "PIONEER DVD-RW  DVR-215",    NULL,   ATA_HORKAGE_NOSETXFER },
        { "PIONEER DVD-RW  DVR-212D",   NULL,   ATA_HORKAGE_NOSETXFER },
        { "PIONEER DVD-RW  DVR-216D",   NULL,   ATA_HORKAGE_NOSETXFER },

        /* Crucial BX100 SSD 500GB has broken LPM support */
        { "CT500BX100SSD1",             NULL,   ATA_HORKAGE_NOLPM },

        /* 512GB MX100 with MU01 firmware has both queued TRIM and LPM issues */
        { "Crucial_CT512MX100*",        "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM |
                                                ATA_HORKAGE_NOLPM, },
        /* 512GB MX100 with newer firmware has only LPM issues */
        { "Crucial_CT512MX100*",        NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM |
                                                ATA_HORKAGE_NOLPM, },

        /* 480GB+ M500 SSDs have both queued TRIM and LPM issues */
        { "Crucial_CT480M500*",         NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM |
                                                ATA_HORKAGE_NOLPM, },
        { "Crucial_CT960M500*",         NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM |
                                                ATA_HORKAGE_NOLPM, },

        /* These specific Samsung models/firmware-revs do not handle LPM well */
        { "SAMSUNG MZMPC128HBFU-000MV", "CXM14M1Q", ATA_HORKAGE_NOLPM, },
        { "SAMSUNG SSD PM830 mSATA *",  "CXM13D1Q", ATA_HORKAGE_NOLPM, },
        { "SAMSUNG MZ7TD256HAFV-000L9", NULL,       ATA_HORKAGE_NOLPM, },
        { "SAMSUNG MZ7TE512HMHP-000L1", "EXT06L0Q", ATA_HORKAGE_NOLPM, },

        /* devices that don't properly handle queued TRIM commands */
        { "Micron_M500IT_*",            "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Micron_M500_*",              NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Crucial_CT*M500*",           NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Micron_M5[15]0_*",           "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Crucial_CT*M550*",           "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Crucial_CT*MX100*",          "MU01", ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Samsung SSD 840*",           NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Samsung SSD 850*",           NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "FCCT*M500*",                 NULL,   ATA_HORKAGE_NO_NCQ_TRIM |
                                                ATA_HORKAGE_ZERO_AFTER_TRIM, },

        /* devices that don't properly handle TRIM commands */
        { "SuperSSpeed S238*",          NULL,   ATA_HORKAGE_NOTRIM, },

        /*
         * As defined, the DRAT (Deterministic Read After Trim) and RZAT
         * (Return Zero After Trim) flags in the ATA Command Set are
         * unreliable in the sense that they only define what happens if
         * the device successfully executed the DSM TRIM command. TRIM
         * is only advisory, however, and the device is free to silently
         * ignore all or parts of the request.
         *
         * Whitelist drives that are known to reliably return zeroes
         * after TRIM.
         */

        /*
         * The intel 510 drive has buggy DRAT/RZAT. Explicitly exclude
         * that model before whitelisting all other intel SSDs.
         */
        { "INTEL*SSDSC2MH*",            NULL,   0, },

        { "Micron*",                    NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Crucial*",                   NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "INTEL*SSD*",                 NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "SSD*INTEL*",                 NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "Samsung*SSD*",               NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "SAMSUNG*SSD*",               NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "SAMSUNG*MZ7KM*",             NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },
        { "ST[1248][0248]0[FH]*",       NULL,   ATA_HORKAGE_ZERO_AFTER_TRIM, },

        /*
         * Some WD SATA-I drives spin up and down erratically when the link
         * is put into the slumber mode.  We don't have full list of the
         * affected devices.  Disable LPM if the device matches one of the
         * known prefixes and is SATA-1.  As a side effect LPM partial is
         * lost too.
         *
         * https://bugzilla.kernel.org/show_bug.cgi?id=57211
         */
        { "WDC WD800JD-*",              NULL,   ATA_HORKAGE_WD_BROKEN_LPM },
        { "WDC WD1200JD-*",             NULL,   ATA_HORKAGE_WD_BROKEN_LPM },
        { "WDC WD1600JD-*",             NULL,   ATA_HORKAGE_WD_BROKEN_LPM },
        { "WDC WD2000JD-*",             NULL,   ATA_HORKAGE_WD_BROKEN_LPM },
        { "WDC WD2500JD-*",             NULL,   ATA_HORKAGE_WD_BROKEN_LPM },
        { "WDC WD3000JD-*",             NULL,   ATA_HORKAGE_WD_BROKEN_LPM },