File Index
Files and directories
Sign in
FILE

libata-scsi.c

File preview with syntax highlighting.

linux-6.19.14/drivers/ata/libata-scsi.c C
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 *  libata-scsi.c - helper library for ATA
   4 *
   5 *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
   6 *  Copyright 2003-2004 Jeff Garzik
   7 *
   8 *  libata documentation is available via 'make {ps|pdf}docs',
   9 *  as Documentation/driver-api/libata.rst
  10 *
  11 *  Hardware documentation available from
  12 *  - http://www.t10.org/
  13 *  - http://www.t13.org/
  14 */
  15
  16#include <linux/compat.h>
  17#include <linux/slab.h>
  18#include <linux/kernel.h>
  19#include <linux/blkdev.h>
  20#include <linux/spinlock.h>
  21#include <linux/export.h>
  22#include <scsi/scsi.h>
  23#include <scsi/scsi_host.h>
  24#include <scsi/scsi_cmnd.h>
  25#include <scsi/scsi_eh.h>
  26#include <scsi/scsi_device.h>
  27#include <scsi/scsi_tcq.h>
  28#include <scsi/scsi_transport.h>
  29#include <linux/libata.h>
  30#include <linux/hdreg.h>
  31#include <linux/uaccess.h>
  32#include <linux/suspend.h>
  33#include <linux/unaligned.h>
  34#include <linux/ioprio.h>
  35#include <linux/of.h>
  36
  37#include "libata.h"
  38#include "libata-transport.h"
  39
  40#define ATA_SCSI_RBUF_SIZE	2048
  41
  42static DEFINE_SPINLOCK(ata_scsi_rbuf_lock);
  43static u8 ata_scsi_rbuf[ATA_SCSI_RBUF_SIZE];
  44
  45typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
  46
  47static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
  48					const struct scsi_device *scsidev);
  49
  50#define RW_RECOVERY_MPAGE		0x1
  51#define RW_RECOVERY_MPAGE_LEN		12
  52#define CACHE_MPAGE			0x8
  53#define CACHE_MPAGE_LEN			20
  54#define CONTROL_MPAGE			0xa
  55#define CONTROL_MPAGE_LEN		12
  56#define ALL_MPAGES			0x3f
  57#define ALL_SUB_MPAGES			0xff
  58#define CDL_T2A_SUB_MPAGE		0x07
  59#define CDL_T2B_SUB_MPAGE		0x08
  60#define CDL_T2_SUB_MPAGE_LEN		232
  61#define ATA_FEATURE_SUB_MPAGE		0xf2
  62#define ATA_FEATURE_SUB_MPAGE_LEN	16
  63
  64static const u8 def_rw_recovery_mpage[RW_RECOVERY_MPAGE_LEN] = {
  65	RW_RECOVERY_MPAGE,
  66	RW_RECOVERY_MPAGE_LEN - 2,
  67	(1 << 7),	/* AWRE */
  68	0,		/* read retry count */
  69	0, 0, 0, 0,
  70	0,		/* write retry count */
  71	0, 0, 0
  72};
  73
  74static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
  75	CACHE_MPAGE,
  76	CACHE_MPAGE_LEN - 2,
  77	0,		/* contains WCE, needs to be 0 for logic */
  78	0, 0, 0, 0, 0, 0, 0, 0, 0,
  79	0,		/* contains DRA, needs to be 0 for logic */
  80	0, 0, 0, 0, 0, 0, 0
  81};
  82
  83static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
  84	CONTROL_MPAGE,
  85	CONTROL_MPAGE_LEN - 2,
  86	2,	/* DSENSE=0, GLTSD=1 */
  87	0,	/* [QAM+QERR may be 1, see 05-359r1] */
  88	0, 0, 0, 0, 0xff, 0xff,
  89	0, 30	/* extended self test time, see 05-359r1 */
  90};
  91
  92static ssize_t ata_scsi_park_show(struct device *device,
  93				  struct device_attribute *attr, char *buf)
  94{
  95	struct scsi_device *sdev = to_scsi_device(device);
  96	struct ata_port *ap;
  97	struct ata_link *link;
  98	struct ata_device *dev;
  99	unsigned long now;
 100	unsigned int msecs;
 101	int rc = 0;
 102
 103	ap = ata_shost_to_port(sdev->host);
 104
 105	spin_lock_irq(ap->lock);
 106	dev = ata_scsi_find_dev(ap, sdev);
 107	if (!dev) {
 108		rc = -ENODEV;
 109		goto unlock;
 110	}
 111	if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
 112		rc = -EOPNOTSUPP;
 113		goto unlock;
 114	}
 115
 116	link = dev->link;
 117	now = jiffies;
 118	if (ap->pflags & ATA_PFLAG_EH_IN_PROGRESS &&
 119	    link->eh_context.unloaded_mask & (1 << dev->devno) &&
 120	    time_after(dev->unpark_deadline, now))
 121		msecs = jiffies_to_msecs(dev->unpark_deadline - now);
 122	else
 123		msecs = 0;
 124
 125unlock:
 126	spin_unlock_irq(ap->lock);
 127
 128	return rc ? rc : sysfs_emit(buf, "%u\n", msecs);
 129}
 130
 131static ssize_t ata_scsi_park_store(struct device *device,
 132				   struct device_attribute *attr,
 133				   const char *buf, size_t len)
 134{
 135	struct scsi_device *sdev = to_scsi_device(device);
 136	struct ata_port *ap;
 137	struct ata_device *dev;
 138	int input;
 139	unsigned long flags;
 140	int rc;
 141
 142	rc = kstrtoint(buf, 10, &input);
 143	if (rc)
 144		return rc;
 145	if (input < -2)
 146		return -EINVAL;
 147	if (input > ATA_TMOUT_MAX_PARK) {
 148		rc = -EOVERFLOW;
 149		input = ATA_TMOUT_MAX_PARK;
 150	}
 151
 152	ap = ata_shost_to_port(sdev->host);
 153
 154	spin_lock_irqsave(ap->lock, flags);
 155	dev = ata_scsi_find_dev(ap, sdev);
 156	if (unlikely(!dev)) {
 157		rc = -ENODEV;
 158		goto unlock;
 159	}
 160	if (dev->class != ATA_DEV_ATA &&
 161	    dev->class != ATA_DEV_ZAC) {
 162		rc = -EOPNOTSUPP;
 163		goto unlock;
 164	}
 165
 166	if (input >= 0) {
 167		if (dev->flags & ATA_DFLAG_NO_UNLOAD) {
 168			rc = -EOPNOTSUPP;
 169			goto unlock;
 170		}
 171
 172		dev->unpark_deadline = ata_deadline(jiffies, input);
 173		dev->link->eh_info.dev_action[dev->devno] |= ATA_EH_PARK;
 174		ata_port_schedule_eh(ap);
 175		complete(&ap->park_req_pending);
 176	} else {
 177		switch (input) {
 178		case -1:
 179			dev->flags &= ~ATA_DFLAG_NO_UNLOAD;
 180			break;
 181		case -2:
 182			dev->flags |= ATA_DFLAG_NO_UNLOAD;
 183			break;
 184		}
 185	}
 186unlock:
 187	spin_unlock_irqrestore(ap->lock, flags);
 188
 189	return rc ? rc : len;
 190}
 191DEVICE_ATTR(unload_heads, S_IRUGO | S_IWUSR,
 192	    ata_scsi_park_show, ata_scsi_park_store);
 193EXPORT_SYMBOL_GPL(dev_attr_unload_heads);
 194
 195bool ata_scsi_sense_is_valid(u8 sk, u8 asc, u8 ascq)
 196{
 197	/*
 198	 * If sk == NO_SENSE, and asc + ascq == NO ADDITIONAL SENSE INFORMATION,
 199	 * then there is no sense data to add.
 200	 */
 201	if (sk == 0 && asc == 0 && ascq == 0)
 202		return false;
 203
 204	/* If sk > COMPLETED, sense data is bogus. */
 205	if (sk > COMPLETED)
 206		return false;
 207
 208	return true;
 209}
 210
 211void ata_scsi_set_sense(struct ata_device *dev, struct scsi_cmnd *cmd,
 212			u8 sk, u8 asc, u8 ascq)
 213{
 214	bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
 215
 216	scsi_build_sense(cmd, d_sense, sk, asc, ascq);
 217}
 218
 219static void ata_scsi_set_sense_information(struct ata_queued_cmd *qc)
 220{
 221	u64 information;
 222
 223	if (!(qc->flags & ATA_QCFLAG_RTF_FILLED)) {
 224		ata_dev_dbg(qc->dev,
 225			    "missing result TF: can't set INFORMATION sense field\n");
 226		return;
 227	}
 228
 229	information = ata_tf_read_block(&qc->result_tf, qc->dev);
 230	if (information == U64_MAX)
 231		return;
 232
 233	scsi_set_sense_information(qc->scsicmd->sense_buffer,
 234				   SCSI_SENSE_BUFFERSIZE, information);
 235}
 236
 237/**
 238 *	ata_scsi_set_passthru_sense_fields - Set ATA fields in sense buffer
 239 *	@qc: ATA PASS-THROUGH command.
 240 *
 241 *	Populates "ATA Status Return sense data descriptor" / "Fixed format
 242 *	sense data" with ATA taskfile fields.
 243 *
 244 *	LOCKING:
 245 *	None.
 246 */
 247static void ata_scsi_set_passthru_sense_fields(struct ata_queued_cmd *qc)
 248{
 249	struct ata_device *dev = qc->dev;
 250	struct scsi_cmnd *cmd = qc->scsicmd;
 251	struct ata_taskfile *tf = &qc->result_tf;
 252	unsigned char *sb = cmd->sense_buffer;
 253
 254	if (!(qc->flags & ATA_QCFLAG_RTF_FILLED)) {
 255		ata_dev_dbg(dev,
 256			    "missing result TF: can't set ATA PT sense fields\n");
 257		return;
 258	}
 259
 260	if ((sb[0] & 0x7f) >= 0x72) {
 261		unsigned char *desc;
 262		u8 len;
 263
 264		/* descriptor format */
 265		len = sb[7];
 266		desc = (char *)scsi_sense_desc_find(sb, len + 8, 9);
 267		if (!desc) {
 268			if (SCSI_SENSE_BUFFERSIZE < len + 14)
 269				return;
 270			sb[7] = len + 14;
 271			desc = sb + 8 + len;
 272		}
 273		desc[0] = 9;
 274		desc[1] = 12;
 275		/*
 276		 * Copy registers into sense buffer.
 277		 */
 278		desc[2] = 0x00;
 279		desc[3] = tf->error;
 280		desc[5] = tf->nsect;
 281		desc[7] = tf->lbal;
 282		desc[9] = tf->lbam;
 283		desc[11] = tf->lbah;
 284		desc[12] = tf->device;
 285		desc[13] = tf->status;
 286
 287		/*
 288		 * Fill in Extend bit, and the high order bytes
 289		 * if applicable.
 290		 */
 291		if (tf->flags & ATA_TFLAG_LBA48) {
 292			desc[2] |= 0x01;
 293			desc[4] = tf->hob_nsect;
 294			desc[6] = tf->hob_lbal;
 295			desc[8] = tf->hob_lbam;
 296			desc[10] = tf->hob_lbah;
 297		}
 298	} else {
 299		/* Fixed sense format */
 300		sb[0] |= 0x80;
 301		sb[3] = tf->error;
 302		sb[4] = tf->status;
 303		sb[5] = tf->device;
 304		sb[6] = tf->nsect;
 305		if (tf->flags & ATA_TFLAG_LBA48)  {
 306			sb[8] |= 0x80;
 307			if (tf->hob_nsect)
 308				sb[8] |= 0x40;
 309			if (tf->hob_lbal || tf->hob_lbam || tf->hob_lbah)
 310				sb[8] |= 0x20;
 311		}
 312		sb[9] = tf->lbal;
 313		sb[10] = tf->lbam;
 314		sb[11] = tf->lbah;
 315	}
 316}
 317
 318static void ata_scsi_set_invalid_field(struct ata_device *dev,
 319				       struct scsi_cmnd *cmd, u16 field, u8 bit)
 320{
 321	ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x24, 0x0);
 322	/* "Invalid field in CDB" */
 323	scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
 324				     field, bit, 1);
 325}
 326
 327static void ata_scsi_set_invalid_parameter(struct ata_device *dev,
 328					   struct scsi_cmnd *cmd, u16 field)
 329{
 330	/* "Invalid field in parameter list" */
 331	ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x26, 0x0);
 332	scsi_set_sense_field_pointer(cmd->sense_buffer, SCSI_SENSE_BUFFERSIZE,
 333				     field, 0xff, 0);
 334}
 335
 336static struct attribute *ata_common_sdev_attrs[] = {
 337	&dev_attr_unload_heads.attr,
 338	NULL
 339};
 340
 341static const struct attribute_group ata_common_sdev_attr_group = {
 342	.attrs = ata_common_sdev_attrs
 343};
 344
 345const struct attribute_group *ata_common_sdev_groups[] = {
 346	&ata_common_sdev_attr_group,
 347	NULL
 348};
 349EXPORT_SYMBOL_GPL(ata_common_sdev_groups);
 350
 351/**
 352 *	ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
 353 *	@sdev: SCSI device for which BIOS geometry is to be determined
 354 *	@unused: gendisk associated with @sdev
 355 *	@capacity: capacity of SCSI device
 356 *	@geom: location to which geometry will be output
 357 *
 358 *	Generic bios head/sector/cylinder calculator
 359 *	used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
 360 *	mapping. Some situations may arise where the disk is not
 361 *	bootable if this is not used.
 362 *
 363 *	LOCKING:
 364 *	Defined by the SCSI layer.  We don't really care.
 365 *
 366 *	RETURNS:
 367 *	Zero.
 368 */
 369int ata_std_bios_param(struct scsi_device *sdev, struct gendisk *unused,
 370		       sector_t capacity, int geom[])
 371{
 372	geom[0] = 255;
 373	geom[1] = 63;
 374	sector_div(capacity, 255*63);
 375	geom[2] = capacity;
 376
 377	return 0;
 378}
 379EXPORT_SYMBOL_GPL(ata_std_bios_param);
 380
 381/**
 382 *	ata_scsi_unlock_native_capacity - unlock native capacity
 383 *	@sdev: SCSI device to adjust device capacity for
 384 *
 385 *	This function is called if a partition on @sdev extends beyond
 386 *	the end of the device.  It requests EH to unlock HPA.
 387 *
 388 *	LOCKING:
 389 *	Defined by the SCSI layer.  Might sleep.
 390 */
 391void ata_scsi_unlock_native_capacity(struct scsi_device *sdev)
 392{
 393	struct ata_port *ap = ata_shost_to_port(sdev->host);
 394	struct ata_device *dev;
 395	unsigned long flags;
 396
 397	spin_lock_irqsave(ap->lock, flags);
 398
 399	dev = ata_scsi_find_dev(ap, sdev);
 400	if (dev && dev->n_sectors < dev->n_native_sectors) {
 401		dev->flags |= ATA_DFLAG_UNLOCK_HPA;
 402		dev->link->eh_info.action |= ATA_EH_RESET;
 403		ata_port_schedule_eh(ap);
 404	}
 405
 406	spin_unlock_irqrestore(ap->lock, flags);
 407	ata_port_wait_eh(ap);
 408}
 409EXPORT_SYMBOL_GPL(ata_scsi_unlock_native_capacity);
 410
 411/**
 412 *	ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
 413 *	@ap: target port
 414 *	@sdev: SCSI device to get identify data for
 415 *	@arg: User buffer area for identify data
 416 *
 417 *	LOCKING:
 418 *	Defined by the SCSI layer.  We don't really care.
 419 *
 420 *	RETURNS:
 421 *	Zero on success, negative errno on error.
 422 */
 423static int ata_get_identity(struct ata_port *ap, struct scsi_device *sdev,
 424			    void __user *arg)
 425{
 426	struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
 427	u16 __user *dst = arg;
 428	char buf[40];
 429
 430	if (!dev)
 431		return -ENOMSG;
 432
 433	if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
 434		return -EFAULT;
 435
 436	ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
 437	if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
 438		return -EFAULT;
 439
 440	ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
 441	if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
 442		return -EFAULT;
 443
 444	ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
 445	if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
 446		return -EFAULT;
 447
 448	return 0;
 449}
 450
 451/**
 452 *	ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
 453 *	@scsidev: Device to which we are issuing command
 454 *	@arg: User provided data for issuing command
 455 *
 456 *	LOCKING:
 457 *	Defined by the SCSI layer.  We don't really care.
 458 *
 459 *	RETURNS:
 460 *	Zero on success, negative errno on error.
 461 */
 462int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
 463{
 464	int rc = 0;
 465	u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
 466	u8 scsi_cmd[MAX_COMMAND_SIZE];
 467	u8 args[4], *argbuf = NULL;
 468	int argsize = 0;
 469	struct scsi_sense_hdr sshdr;
 470	const struct scsi_exec_args exec_args = {
 471		.sshdr = &sshdr,
 472		.sense = sensebuf,
 473		.sense_len = sizeof(sensebuf),
 474	};
 475	int cmd_result;
 476
 477	if (arg == NULL)
 478		return -EINVAL;
 479
 480	if (copy_from_user(args, arg, sizeof(args)))
 481		return -EFAULT;
 482
 483	memset(sensebuf, 0, sizeof(sensebuf));
 484	memset(scsi_cmd, 0, sizeof(scsi_cmd));
 485
 486	if (args[3]) {
 487		argsize = ATA_SECT_SIZE * args[3];
 488		argbuf = kmalloc(argsize, GFP_KERNEL);
 489		if (argbuf == NULL) {
 490			rc = -ENOMEM;
 491			goto error;
 492		}
 493
 494		scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
 495		scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
 496					    block count in sector count field */
 497	} else {
 498		scsi_cmd[1]  = (3 << 1); /* Non-data */
 499		scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
 500	}
 501
 502	scsi_cmd[0] = ATA_16;
 503
 504	scsi_cmd[4] = args[2];
 505	if (args[0] == ATA_CMD_SMART) { /* hack -- ide driver does this too */
 506		scsi_cmd[6]  = args[3];
 507		scsi_cmd[8]  = args[1];
 508		scsi_cmd[10] = ATA_SMART_LBAM_PASS;
 509		scsi_cmd[12] = ATA_SMART_LBAH_PASS;
 510	} else {
 511		scsi_cmd[6]  = args[1];
 512	}
 513	scsi_cmd[14] = args[0];
 514
 515	/* Good values for timeout and retries?  Values below
 516	   from scsi_ioctl_send_command() for default case... */
 517	cmd_result = scsi_execute_cmd(scsidev, scsi_cmd, REQ_OP_DRV_IN, argbuf,
 518				      argsize, 10 * HZ, 5, &exec_args);
 519	if (cmd_result < 0) {
 520		rc = cmd_result;
 521		goto error;
 522	}
 523	if (scsi_sense_valid(&sshdr)) {/* sense data available */
 524		u8 *desc = sensebuf + 8;
 525
 526		/* If we set cc then ATA pass-through will cause a
 527		 * check condition even if no error. Filter that. */
 528		if (scsi_status_is_check_condition(cmd_result)) {
 529			if (sshdr.sense_key == RECOVERED_ERROR &&
 530			    sshdr.asc == 0 && sshdr.ascq == 0x1d)
 531				cmd_result &= ~SAM_STAT_CHECK_CONDITION;
 532		}
 533
 534		/* Send userspace a few ATA registers (same as drivers/ide) */
 535		if (sensebuf[0] == 0x72 &&	/* format is "descriptor" */
 536		    desc[0] == 0x09) {		/* code is "ATA Descriptor" */
 537			args[0] = desc[13];	/* status */
 538			args[1] = desc[3];	/* error */
 539			args[2] = desc[5];	/* sector count (0:7) */
 540			if (copy_to_user(arg, args, sizeof(args)))
 541				rc = -EFAULT;
 542		}
 543	}
 544
 545
 546	if (cmd_result) {
 547		rc = -EIO;
 548		goto error;
 549	}
 550
 551	if ((argbuf)
 552	 && copy_to_user(arg + sizeof(args), argbuf, argsize))
 553		rc = -EFAULT;
 554error:
 555	kfree(argbuf);
 556	return rc;
 557}
 558
 559/**
 560 *	ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
 561 *	@scsidev: Device to which we are issuing command
 562 *	@arg: User provided data for issuing command
 563 *
 564 *	LOCKING:
 565 *	Defined by the SCSI layer.  We don't really care.
 566 *
 567 *	RETURNS:
 568 *	Zero on success, negative errno on error.
 569 */
 570int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
 571{
 572	int rc = 0;
 573	u8 sensebuf[SCSI_SENSE_BUFFERSIZE];
 574	u8 scsi_cmd[MAX_COMMAND_SIZE];
 575	u8 args[7];
 576	struct scsi_sense_hdr sshdr;
 577	int cmd_result;
 578	const struct scsi_exec_args exec_args = {
 579		.sshdr = &sshdr,
 580		.sense = sensebuf,
 581		.sense_len = sizeof(sensebuf),
 582	};
 583
 584	if (arg == NULL)
 585		return -EINVAL;
 586
 587	if (copy_from_user(args, arg, sizeof(args)))
 588		return -EFAULT;
 589
 590	memset(sensebuf, 0, sizeof(sensebuf));
 591	memset(scsi_cmd, 0, sizeof(scsi_cmd));
 592	scsi_cmd[0]  = ATA_16;
 593	scsi_cmd[1]  = (3 << 1); /* Non-data */
 594	scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
 595	scsi_cmd[4]  = args[1];
 596	scsi_cmd[6]  = args[2];
 597	scsi_cmd[8]  = args[3];
 598	scsi_cmd[10] = args[4];
 599	scsi_cmd[12] = args[5];
 600	scsi_cmd[13] = args[6] & 0x4f;
 601	scsi_cmd[14] = args[0];
 602
 603	/* Good values for timeout and retries?  Values below
 604	   from scsi_ioctl_send_command() for default case... */
 605	cmd_result = scsi_execute_cmd(scsidev, scsi_cmd, REQ_OP_DRV_IN, NULL,
 606				      0, 10 * HZ, 5, &exec_args);
 607	if (cmd_result < 0) {
 608		rc = cmd_result;
 609		goto error;
 610	}
 611	if (scsi_sense_valid(&sshdr)) {/* sense data available */
 612		u8 *desc = sensebuf + 8;
 613
 614		/* If we set cc then ATA pass-through will cause a
 615		 * check condition even if no error. Filter that. */
 616		if (cmd_result & SAM_STAT_CHECK_CONDITION) {
 617			if (sshdr.sense_key == RECOVERED_ERROR &&
 618			    sshdr.asc == 0 && sshdr.ascq == 0x1d)
 619				cmd_result &= ~SAM_STAT_CHECK_CONDITION;
 620		}
 621
 622		/* Send userspace ATA registers */
 623		if (sensebuf[0] == 0x72 &&	/* format is "descriptor" */
 624				desc[0] == 0x09) {/* code is "ATA Descriptor" */
 625			args[0] = desc[13];	/* status */
 626			args[1] = desc[3];	/* error */
 627			args[2] = desc[5];	/* sector count (0:7) */
 628			args[3] = desc[7];	/* lbal */
 629			args[4] = desc[9];	/* lbam */
 630			args[5] = desc[11];	/* lbah */
 631			args[6] = desc[12];	/* select */
 632			if (copy_to_user(arg, args, sizeof(args)))
 633				rc = -EFAULT;
 634		}
 635	}
 636
 637	if (cmd_result) {
 638		rc = -EIO;
 639		goto error;
 640	}
 641
 642 error:
 643	return rc;
 644}
 645
 646static bool ata_ioc32(struct ata_port *ap)
 647{
 648	if (ap->flags & ATA_FLAG_PIO_DMA)
 649		return true;
 650	if (ap->pflags & ATA_PFLAG_PIO32)
 651		return true;
 652	return false;
 653}
 654
 655/*
 656 * This handles both native and compat commands, so anything added
 657 * here must have a compatible argument, or check in_compat_syscall()
 658 */
 659int ata_sas_scsi_ioctl(struct ata_port *ap, struct scsi_device *scsidev,
 660		     unsigned int cmd, void __user *arg)
 661{
 662	unsigned long val;
 663	int rc = -EINVAL;
 664	unsigned long flags;
 665
 666	switch (cmd) {
 667	case HDIO_GET_32BIT:
 668		spin_lock_irqsave(ap->lock, flags);
 669		val = ata_ioc32(ap);
 670		spin_unlock_irqrestore(ap->lock, flags);
 671#ifdef CONFIG_COMPAT
 672		if (in_compat_syscall())
 673			return put_user(val, (compat_ulong_t __user *)arg);
 674#endif
 675		return put_user(val, (unsigned long __user *)arg);
 676
 677	case HDIO_SET_32BIT:
 678		val = (unsigned long) arg;
 679		rc = 0;
 680		spin_lock_irqsave(ap->lock, flags);
 681		if (ap->pflags & ATA_PFLAG_PIO32CHANGE) {
 682			if (val)
 683				ap->pflags |= ATA_PFLAG_PIO32;
 684			else
 685				ap->pflags &= ~ATA_PFLAG_PIO32;
 686		} else {
 687			if (val != ata_ioc32(ap))
 688				rc = -EINVAL;
 689		}
 690		spin_unlock_irqrestore(ap->lock, flags);
 691		return rc;
 692
 693	case HDIO_GET_IDENTITY:
 694		return ata_get_identity(ap, scsidev, arg);
 695
 696	case HDIO_DRIVE_CMD:
 697		if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 698			return -EACCES;
 699		return ata_cmd_ioctl(scsidev, arg);
 700
 701	case HDIO_DRIVE_TASK:
 702		if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
 703			return -EACCES;
 704		return ata_task_ioctl(scsidev, arg);
 705
 706	default:
 707		rc = -ENOTTY;
 708		break;
 709	}
 710
 711	return rc;
 712}
 713EXPORT_SYMBOL_GPL(ata_sas_scsi_ioctl);
 714
 715int ata_scsi_ioctl(struct scsi_device *scsidev, unsigned int cmd,
 716		   void __user *arg)
 717{
 718	return ata_sas_scsi_ioctl(ata_shost_to_port(scsidev->host),
 719				scsidev, cmd, arg);
 720}
 721EXPORT_SYMBOL_GPL(ata_scsi_ioctl);
 722
 723/**
 724 *	ata_scsi_qc_new - acquire new ata_queued_cmd reference
 725 *	@dev: ATA device to which the new command is attached
 726 *	@cmd: SCSI command that originated this ATA command
 727 *
 728 *	Obtain a reference to an unused ata_queued_cmd structure,
 729 *	which is the basic libata structure representing a single
 730 *	ATA command sent to the hardware.
 731 *
 732 *	If a command was available, fill in the SCSI-specific
 733 *	portions of the structure with information on the
 734 *	current command.
 735 *
 736 *	LOCKING:
 737 *	spin_lock_irqsave(host lock)
 738 *
 739 *	RETURNS:
 740 *	Command allocated, or %NULL if none available.
 741 */
 742static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
 743					      struct scsi_cmnd *cmd)
 744{
 745	struct ata_port *ap = dev->link->ap;
 746	struct ata_queued_cmd *qc;
 747	int tag;
 748
 749	if (unlikely(ata_port_is_frozen(ap)))
 750		goto fail;
 751
 752	if (ap->flags & ATA_FLAG_SAS_HOST) {
 753		/*
 754		 * SAS hosts may queue > ATA_MAX_QUEUE commands so use
 755		 * unique per-device budget token as a tag.
 756		 */
 757		if (WARN_ON_ONCE(cmd->budget_token >= ATA_MAX_QUEUE))
 758			goto fail;
 759		tag = cmd->budget_token;
 760	} else {
 761		tag = scsi_cmd_to_rq(cmd)->tag;
 762	}
 763
 764	qc = __ata_qc_from_tag(ap, tag);
 765	qc->tag = qc->hw_tag = tag;
 766	qc->ap = ap;
 767	qc->dev = dev;
 768
 769	ata_qc_reinit(qc);
 770
 771	qc->scsicmd = cmd;
 772	qc->scsidone = scsi_done;
 773
 774	qc->sg = scsi_sglist(cmd);
 775	qc->n_elem = scsi_sg_count(cmd);
 776
 777	if (scsi_cmd_to_rq(cmd)->rq_flags & RQF_QUIET)
 778		qc->flags |= ATA_QCFLAG_QUIET;
 779
 780	return qc;
 781
 782fail:
 783	set_host_byte(cmd, DID_OK);
 784	set_status_byte(cmd, SAM_STAT_TASK_SET_FULL);
 785	scsi_done(cmd);
 786	return NULL;
 787}
 788
 789static void ata_qc_set_pc_nbytes(struct ata_queued_cmd *qc)
 790{
 791	struct scsi_cmnd *scmd = qc->scsicmd;
 792
 793	qc->extrabytes = scmd->extra_len;
 794	qc->nbytes = scsi_bufflen(scmd) + qc->extrabytes;
 795}
 796
 797/**
 798 *	ata_to_sense_error - convert ATA error to SCSI error
 799 *	@drv_stat: value contained in ATA status register
 800 *	@drv_err: value contained in ATA error register
 801 *	@sk: the sense key we'll fill out
 802 *	@asc: the additional sense code we'll fill out
 803 *	@ascq: the additional sense code qualifier we'll fill out
 804 *
 805 *	Converts an ATA error into a SCSI error.  Fill out pointers to
 806 *	SK, ASC, and ASCQ bytes for later use in fixed or descriptor
 807 *	format sense blocks.
 808 *
 809 *	LOCKING:
 810 *	spin_lock_irqsave(host lock)
 811 */
 812static void ata_to_sense_error(u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
 813			       u8 *ascq)
 814{
 815	int i;
 816
 817	/* Based on the 3ware driver translation table */
 818	static const unsigned char sense_table[][4] = {
 819		/* BBD|ECC|ID|MAR */
 820		{0xd1,		ABORTED_COMMAND, 0x00, 0x00},
 821			// Device busy                  Aborted command
 822		/* BBD|ECC|ID */
 823		{0xd0,		ABORTED_COMMAND, 0x00, 0x00},
 824			// Device busy                  Aborted command
 825		/* ECC|MC|MARK */
 826		{0x61,		HARDWARE_ERROR, 0x00, 0x00},
 827			// Device fault                 Hardware error
 828		/* ICRC|ABRT */		/* NB: ICRC & !ABRT is BBD */
 829		{0x84,		ABORTED_COMMAND, 0x47, 0x00},
 830			// Data CRC error               SCSI parity error
 831		/* MC|ID|ABRT|TRK0|MARK */
 832		{0x37,		NOT_READY, 0x04, 0x00},
 833			// Unit offline                 Not ready
 834		/* MCR|MARK */
 835		{0x09,		NOT_READY, 0x04, 0x00},
 836			// Unrecovered disk error       Not ready
 837		/*  Bad address mark */
 838		{0x01,		MEDIUM_ERROR, 0x13, 0x00},
 839			// Address mark not found for data field
 840		/* TRK0 - Track 0 not found */
 841		{0x02,		HARDWARE_ERROR, 0x00, 0x00},
 842			// Hardware error
 843		/* Abort: 0x04 is not translated here, see below */
 844		/* Media change request */
 845		{0x08,		NOT_READY, 0x04, 0x00},
 846			// FIXME: faking offline
 847		/* SRV/IDNF - ID not found */
 848		{0x10,		ILLEGAL_REQUEST, 0x21, 0x00},
 849			// Logical address out of range
 850		/* MC - Media Changed */
 851		{0x20,		UNIT_ATTENTION, 0x28, 0x00},
 852			// Not ready to ready change, medium may have changed
 853		/* ECC - Uncorrectable ECC error */
 854		{0x40,		MEDIUM_ERROR, 0x11, 0x04},
 855			// Unrecovered read error
 856		/* BBD - block marked bad */
 857		{0x80,		MEDIUM_ERROR, 0x11, 0x04},
 858			// Block marked bad	Medium error, unrecovered read error
 859		{0xFF, 0xFF, 0xFF, 0xFF}, // END mark
 860	};
 861	static const unsigned char stat_table[][4] = {
 862		/* Busy: must be first because BUSY means no other bits valid */
 863		{ ATA_BUSY,	ABORTED_COMMAND, 0x00, 0x00 },
 864		/* Device fault: INTERNAL TARGET FAILURE */
 865		{ ATA_DF,	HARDWARE_ERROR,  0x44, 0x00 },
 866		/* Corrected data error */
 867		{ ATA_CORR,	RECOVERED_ERROR, 0x00, 0x00 },
 868
 869		{ 0xFF, 0xFF, 0xFF, 0xFF }, /* END mark */
 870	};
 871
 872	/*
 873	 *	Is this an error we can process/parse
 874	 */
 875	if (drv_stat & ATA_BUSY) {
 876		drv_err = 0;	/* Ignore the err bits, they're invalid */
 877	}
 878
 879	if (drv_err) {
 880		/* Look for drv_err */
 881		for (i = 0; sense_table[i][0] != 0xFF; i++) {
 882			/* Look for best matches first */
 883			if ((sense_table[i][0] & drv_err) ==
 884			    sense_table[i][0]) {
 885				*sk = sense_table[i][1];
 886				*asc = sense_table[i][2];
 887				*ascq = sense_table[i][3];
 888				return;
 889			}
 890		}
 891	}
 892
 893	/*
 894	 * Fall back to interpreting status bits.  Note that if the drv_err
 895	 * has only the ABRT bit set, we decode drv_stat.  ABRT by itself
 896	 * is not descriptive enough.
 897	 */
 898	for (i = 0; stat_table[i][0] != 0xFF; i++) {
 899		if (stat_table[i][0] & drv_stat) {
 900			*sk = stat_table[i][1];
 901			*asc = stat_table[i][2];
 902			*ascq = stat_table[i][3];
 903			return;
 904		}
 905	}
 906
 907	/*
 908	 * We need a sensible error return here, which is tricky, and one
 909	 * that won't cause people to do things like return a disk wrongly.
 910	 */
 911	*sk = ABORTED_COMMAND;
 912	*asc = 0x00;
 913	*ascq = 0x00;
 914}
 915
 916/*
 917 *	ata_gen_passthru_sense - Generate check condition sense block.
 918 *	@qc: Command that completed.
 919 *
 920 *	This function is specific to the ATA pass through commands.
 921 *	Regardless of whether the command errored or not, return a sense
 922 *	block. If there was no error, we get the request from an ATA
 923 *	passthrough command, so we use the following sense data:
 924 *	sk = RECOVERED ERROR
 925 *	asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
 926 *      
 927 *
 928 *	LOCKING:
 929 *	None.
 930 */
 931static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
 932{
 933	struct ata_device *dev = qc->dev;
 934	struct scsi_cmnd *cmd = qc->scsicmd;
 935	struct ata_taskfile *tf = &qc->result_tf;
 936	u8 sense_key, asc, ascq;
 937
 938	if (!(qc->flags & ATA_QCFLAG_RTF_FILLED)) {
 939		ata_dev_dbg(dev,
 940			    "missing result TF: can't generate ATA PT sense data\n");
 941		if (qc->err_mask)
 942			ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
 943		return;
 944	}
 945
 946	/*
 947	 * Use ata_to_sense_error() to map status register bits
 948	 * onto sense key, asc & ascq.
 949	 */
 950	if (qc->err_mask ||
 951	    tf->status & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
 952		ata_to_sense_error(tf->status, tf->error,
 953				   &sense_key, &asc, &ascq);
 954		ata_scsi_set_sense(qc->dev, cmd, sense_key, asc, ascq);
 955	} else {
 956		/*
 957		 * ATA PASS-THROUGH INFORMATION AVAILABLE
 958		 *
 959		 * Note: we are supposed to call ata_scsi_set_sense(), which
 960		 * respects the D_SENSE bit, instead of unconditionally
 961		 * generating the sense data in descriptor format. However,
 962		 * because hdparm, hddtemp, and udisks incorrectly assume sense
 963		 * data in descriptor format, without even looking at the
 964		 * RESPONSE CODE field in the returned sense data (to see which
 965		 * format the returned sense data is in), we are stuck with
 966		 * being bug compatible with older kernels.
 967		 */
 968		scsi_build_sense(cmd, 1, RECOVERED_ERROR, 0, 0x1D);
 969	}
 970}
 971
 972/**
 973 *	ata_gen_ata_sense - generate a SCSI fixed sense block
 974 *	@qc: Command that we are erroring out
 975 *
 976 *	Generate sense block for a failed ATA command @qc.
 977 *
 978 *	LOCKING:
 979 *	None.
 980 */
 981static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
 982{
 983	struct ata_device *dev = qc->dev;
 984	struct scsi_cmnd *cmd = qc->scsicmd;
 985	struct ata_taskfile *tf = &qc->result_tf;
 986	u8 sense_key, asc, ascq;
 987
 988	if (ata_dev_disabled(dev)) {
 989		/* Device disabled after error recovery */
 990		/* LOGICAL UNIT NOT READY, HARD RESET REQUIRED */
 991		ata_scsi_set_sense(dev, cmd, NOT_READY, 0x04, 0x21);
 992		return;
 993	}
 994
 995	if (ata_id_is_locked(dev->id)) {
 996		/* Security locked */
 997		/* LOGICAL UNIT ACCESS NOT AUTHORIZED */
 998		ata_scsi_set_sense(dev, cmd, DATA_PROTECT, 0x74, 0x71);
 999		return;
1000	}
1001
1002	if (!(qc->flags & ATA_QCFLAG_RTF_FILLED)) {
1003		ata_dev_dbg(dev,
1004			    "Missing result TF: reporting aborted command\n");
1005		goto aborted;
1006	}
1007
1008	/* Use ata_to_sense_error() to map status register bits
1009	 * onto sense key, asc & ascq.
1010	 */
1011	if (qc->err_mask ||
1012	    tf->status & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
1013		ata_to_sense_error(tf->status, tf->error,
1014				   &sense_key, &asc, &ascq);
1015		ata_scsi_set_sense(dev, cmd, sense_key, asc, ascq);
1016		return;
1017	}
1018
1019	/* Could not decode error */
1020	ata_dev_warn(dev,
1021		"Could not decode error 0x%x, status 0x%x (err_mask=0x%x)\n",
1022		tf->error, tf->status, qc->err_mask);
1023aborted:
1024	ata_scsi_set_sense(dev, cmd, ABORTED_COMMAND, 0, 0);
1025}
1026
1027void ata_scsi_sdev_config(struct scsi_device *sdev)
1028{
1029	sdev->use_10_for_rw = 1;
1030	sdev->use_10_for_ms = 1;
1031	sdev->no_write_same = 1;
1032
1033	/* Schedule policy is determined by ->qc_defer() callback and
1034	 * it needs to see every deferred qc.  Set dev_blocked to 1 to
1035	 * prevent SCSI midlayer from automatically deferring
1036	 * requests.
1037	 */
1038	sdev->max_device_blocked = 1;
1039}
1040
1041/**
1042 *	ata_scsi_dma_need_drain - Check whether data transfer may overflow
1043 *	@rq: request to be checked
1044 *
1045 *	ATAPI commands which transfer variable length data to host
1046 *	might overflow due to application error or hardware bug.  This
1047 *	function checks whether overflow should be drained and ignored
1048 *	for @request.
1049 *
1050 *	LOCKING:
1051 *	None.
1052 *
1053 *	RETURNS:
1054 *	1 if ; otherwise, 0.
1055 */
1056bool ata_scsi_dma_need_drain(struct request *rq)
1057{
1058	struct scsi_cmnd *scmd = blk_mq_rq_to_pdu(rq);
1059
1060	return atapi_cmd_type(scmd->cmnd[0]) == ATAPI_MISC;
1061}
1062EXPORT_SYMBOL_GPL(ata_scsi_dma_need_drain);
1063
1064int ata_scsi_dev_config(struct scsi_device *sdev, struct queue_limits *lim,
1065		struct ata_device *dev)
1066{
1067	int depth = 1;
1068
1069	if (!ata_id_has_unload(dev->id))
1070		dev->flags |= ATA_DFLAG_NO_UNLOAD;
1071
1072	/* configure max sectors */
1073	dev->max_sectors = min(dev->max_sectors, sdev->host->max_sectors);
1074	lim->max_hw_sectors = dev->max_sectors;
1075
1076	if (dev->class == ATA_DEV_ATAPI) {
1077		sdev->sector_size = ATA_SECT_SIZE;
1078
1079		/* set DMA padding */
1080		lim->dma_pad_mask = ATA_DMA_PAD_SZ - 1;
1081
1082		/* make room for appending the drain */
1083		lim->max_segments--;
1084
1085		sdev->dma_drain_len = ATAPI_MAX_DRAIN;
1086		sdev->dma_drain_buf = kmalloc(sdev->dma_drain_len, GFP_NOIO);
1087		if (!sdev->dma_drain_buf) {
1088			ata_dev_err(dev, "drain buffer allocation failed\n");
1089			return -ENOMEM;
1090		}
1091	} else {
1092		sdev->sector_size = ata_id_logical_sector_size(dev->id);
1093
1094		/*
1095		 * Ask the sd driver to issue START STOP UNIT on runtime suspend
1096		 * and resume and shutdown only. For system level suspend/resume,
1097		 * devices power state is handled directly by libata EH.
1098		 * Given that disks are always spun up on system resume, also
1099		 * make sure that the sd driver forces runtime suspended disks
1100		 * to be resumed to correctly reflect the power state of the
1101		 * device.
1102		 */
1103		sdev->manage_runtime_start_stop = 1;
1104		sdev->manage_shutdown = 1;
1105		sdev->manage_restart = ata_acpi_dev_manage_restart(dev);
1106		sdev->force_runtime_start_on_system_start = 1;
1107	}
1108
1109	/*
1110	 * ata_pio_sectors() expects buffer for each sector to not cross
1111	 * page boundary.  Enforce it by requiring buffers to be sector
1112	 * aligned, which works iff sector_size is not larger than
1113	 * PAGE_SIZE.  ATAPI devices also need the alignment as
1114	 * IDENTIFY_PACKET is executed as ATA_PROT_PIO.
1115	 */
1116	if (sdev->sector_size > PAGE_SIZE)
1117		ata_dev_warn(dev,
1118			"sector_size=%u > PAGE_SIZE, PIO may malfunction\n",
1119			sdev->sector_size);
1120
1121	lim->dma_alignment = sdev->sector_size - 1;
1122
1123	if (dev->flags & ATA_DFLAG_AN)
1124		set_bit(SDEV_EVT_MEDIA_CHANGE, sdev->supported_events);
1125
1126	if (ata_ncq_supported(dev))
1127		depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
1128	depth = min(ATA_MAX_QUEUE, depth);
1129	scsi_change_queue_depth(sdev, depth);
1130
1131	if (dev->flags & ATA_DFLAG_TRUSTED)
1132		sdev->security_supported = 1;
1133
1134	dev->sdev = sdev;
1135	return 0;
1136}
1137
1138/**
1139 *	ata_scsi_sdev_init - Early setup of SCSI device
1140 *	@sdev: SCSI device to examine
1141 *
1142 *	This is called from scsi_alloc_sdev() when the scsi device
1143 *	associated with an ATA device is scanned on a port.
1144 *
1145 *	LOCKING:
1146 *	Defined by SCSI layer.  We don't really care.
1147 */
1148
1149int ata_scsi_sdev_init(struct scsi_device *sdev)
1150{
1151	struct ata_port *ap = ata_shost_to_port(sdev->host);
1152	struct device_link *link;
1153
1154	ata_scsi_sdev_config(sdev);
1155
1156	/*
1157	 * Create a link from the ata_port device to the scsi device to ensure
1158	 * that PM does suspend/resume in the correct order: the scsi device is
1159	 * consumer (child) and the ata port the supplier (parent).
1160	 */
1161	link = device_link_add(&sdev->sdev_gendev, &ap->tdev,
1162			       DL_FLAG_STATELESS |
1163			       DL_FLAG_PM_RUNTIME | DL_FLAG_RPM_ACTIVE);
1164	if (!link) {
1165		ata_port_err(ap, "Failed to create link to scsi device %s\n",
1166			     dev_name(&sdev->sdev_gendev));
1167		return -ENODEV;
1168	}
1169
1170	return 0;
1171}
1172EXPORT_SYMBOL_GPL(ata_scsi_sdev_init);
1173
1174/**
1175 *	ata_scsi_sdev_configure - Set SCSI device attributes
1176 *	@sdev: SCSI device to examine
1177 *	@lim: queue limits
1178 *
1179 *	This is called before we actually start reading
1180 *	and writing to the device, to configure certain
1181 *	SCSI mid-layer behaviors.
1182 *
1183 *	LOCKING:
1184 *	Defined by SCSI layer.  We don't really care.
1185 */
1186
1187int ata_scsi_sdev_configure(struct scsi_device *sdev, struct queue_limits *lim)
1188{
1189	struct ata_port *ap = ata_shost_to_port(sdev->host);
1190	struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);
1191
1192	if (dev)
1193		return ata_scsi_dev_config(sdev, lim, dev);
1194
1195	return 0;
1196}
1197EXPORT_SYMBOL_GPL(ata_scsi_sdev_configure);
1198
1199/**
1200 *	ata_scsi_sdev_destroy - SCSI device is about to be destroyed
1201 *	@sdev: SCSI device to be destroyed
1202 *
1203 *	@sdev is about to be destroyed for hot/warm unplugging.  If
1204 *	this unplugging was initiated by libata as indicated by NULL
1205 *	dev->sdev, this function doesn't have to do anything.
1206 *	Otherwise, SCSI layer initiated warm-unplug is in progress.
1207 *	Clear dev->sdev, schedule the device for ATA detach and invoke
1208 *	EH.
1209 *
1210 *	LOCKING:
1211 *	Defined by SCSI layer.  We don't really care.
1212 */
1213void ata_scsi_sdev_destroy(struct scsi_device *sdev)
1214{
1215	struct ata_port *ap = ata_shost_to_port(sdev->host);
1216	unsigned long flags;
1217	struct ata_device *dev;
1218
1219	device_link_remove(&sdev->sdev_gendev, &ap->tdev);
1220
1221	spin_lock_irqsave(ap->lock, flags);
1222	dev = __ata_scsi_find_dev(ap, sdev);
1223	if (dev && dev->sdev) {
1224		/* SCSI device already in CANCEL state, no need to offline it */
1225		dev->sdev = NULL;
1226		dev->flags |= ATA_DFLAG_DETACH;
1227		ata_port_schedule_eh(ap);
1228	}
1229	spin_unlock_irqrestore(ap->lock, flags);
1230
1231	kfree(sdev->dma_drain_buf);
1232}
1233EXPORT_SYMBOL_GPL(ata_scsi_sdev_destroy);
1234
1235/**
1236 *	ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
1237 *	@qc: Storage for translated ATA taskfile
1238 *
1239 *	Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
1240 *	(to start). Perhaps these commands should be preceded by
1241 *	CHECK POWER MODE to see what power mode the device is already in.
1242 *	[See SAT revision 5 at www.t10.org]
1243 *
1244 *	LOCKING:
1245 *	spin_lock_irqsave(host lock)
1246 *
1247 *	RETURNS:
1248 *	Zero on success, non-zero on error.
1249 */
1250static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1251{
1252	struct scsi_cmnd *scmd = qc->scsicmd;
1253	const u8 *cdb = scmd->cmnd;
1254	u16 fp;
1255	u8 bp = 0xff;
1256
1257	if (scmd->cmd_len < 5) {
1258		fp = 4;
1259		goto invalid_fld;
1260	}
1261
1262	/* LOEJ bit set not supported */
1263	if (cdb[4] & 0x2) {
1264		fp = 4;
1265		bp = 1;
1266		goto invalid_fld;
1267	}
1268
1269	/* Power conditions not supported */
1270	if (((cdb[4] >> 4) & 0xf) != 0) {
1271		fp = 4;
1272		bp = 3;
1273		goto invalid_fld;
1274	}
1275
1276	/* Ignore IMMED bit (cdb[1] & 0x1), violates sat-r05 */
1277	if (!ata_dev_power_init_tf(qc->dev, &qc->tf, cdb[4] & 0x1)) {
1278		ata_scsi_set_sense(qc->dev, scmd, ABORTED_COMMAND, 0, 0);
1279		return 1;
1280	}
1281
1282	/*
1283	 * Standby and Idle condition timers could be implemented but that
1284	 * would require libata to implement the Power condition mode page
1285	 * and allow the user to change it. Changing mode pages requires
1286	 * MODE SELECT to be implemented.
1287	 */
1288
1289	return 0;
1290
1291 invalid_fld:
1292	ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
1293	return 1;
1294}
1295
1296/**
1297 *	ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
1298 *	@qc: Storage for translated ATA taskfile
1299 *
1300 *	Sets up an ATA taskfile to issue FLUSH CACHE or
1301 *	FLUSH CACHE EXT.
1302 *
1303 *	LOCKING:
1304 *	spin_lock_irqsave(host lock)
1305 *
1306 *	RETURNS:
1307 *	Zero on success, non-zero on error.
1308 */
1309static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
1310{
1311	struct ata_taskfile *tf = &qc->tf;
1312
1313	tf->flags |= ATA_TFLAG_DEVICE;
1314	tf->protocol = ATA_PROT_NODATA;
1315
1316	if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
1317		tf->command = ATA_CMD_FLUSH_EXT;
1318	else
1319		tf->command = ATA_CMD_FLUSH;
1320
1321	/* flush is critical for IO integrity, consider it an IO command */
1322	qc->flags |= ATA_QCFLAG_IO;
1323
1324	return 0;
1325}
1326
1327/**
1328 *	scsi_6_lba_len - Get LBA and transfer length
1329 *	@cdb: SCSI command to translate
1330 *
1331 *	Calculate LBA and transfer length for 6-byte commands.
1332 *
1333 *	RETURNS:
1334 *	@plba: the LBA
1335 *	@plen: the transfer length
1336 */
1337static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1338{
1339	*plba = get_unaligned_be24(&cdb[1]) & 0x1fffff;
1340	*plen = cdb[4];
1341}
1342
1343/**
1344 *	scsi_10_lba_len - Get LBA and transfer length
1345 *	@cdb: SCSI command to translate
1346 *
1347 *	Calculate LBA and transfer length for 10-byte commands.
1348 *
1349 *	RETURNS:
1350 *	@plba: the LBA
1351 *	@plen: the transfer length
1352 */
1353static inline void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1354{
1355	*plba = get_unaligned_be32(&cdb[2]);
1356	*plen = get_unaligned_be16(&cdb[7]);
1357}
1358
1359/**
1360 *	scsi_16_lba_len - Get LBA and transfer length
1361 *	@cdb: SCSI command to translate
1362 *
1363 *	Calculate LBA and transfer length for 16-byte commands.
1364 *
1365 *	RETURNS:
1366 *	@plba: the LBA
1367 *	@plen: the transfer length
1368 */
1369static inline void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1370{
1371	*plba = get_unaligned_be64(&cdb[2]);
1372	*plen = get_unaligned_be32(&cdb[10]);
1373}
1374
1375/**
1376 *	scsi_dld - Get duration limit descriptor index
1377 *	@cdb: SCSI command to translate
1378 *
1379 *	Returns the dld bits indicating the index of a command duration limit
1380 *	descriptor.
1381 */
1382static inline int scsi_dld(const u8 *cdb)
1383{
1384	return ((cdb[1] & 0x01) << 2) | ((cdb[14] >> 6) & 0x03);
1385}
1386
1387/**
1388 *	ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
1389 *	@qc: Storage for translated ATA taskfile
1390 *
1391 *	Converts SCSI VERIFY command to an ATA READ VERIFY command.
1392 *
1393 *	LOCKING:
1394 *	spin_lock_irqsave(host lock)
1395 *
1396 *	RETURNS:
1397 *	Zero on success, non-zero on error.
1398 */
1399static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
1400{
1401	struct scsi_cmnd *scmd = qc->scsicmd;
1402	struct ata_taskfile *tf = &qc->tf;
1403	struct ata_device *dev = qc->dev;
1404	u64 dev_sectors = qc->dev->n_sectors;
1405	const u8 *cdb = scmd->cmnd;
1406	u64 block;
1407	u32 n_block;
1408	u16 fp;
1409
1410	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
1411	tf->protocol = ATA_PROT_NODATA;
1412
1413	switch (cdb[0]) {
1414	case VERIFY:
1415		if (scmd->cmd_len < 10) {
1416			fp = 9;
1417			goto invalid_fld;
1418		}
1419		scsi_10_lba_len(cdb, &block, &n_block);
1420		break;
1421	case VERIFY_16:
1422		if (scmd->cmd_len < 16) {
1423			fp = 15;
1424			goto invalid_fld;
1425		}
1426		scsi_16_lba_len(cdb, &block, &n_block);
1427		break;
1428	default:
1429		fp = 0;
1430		goto invalid_fld;
1431	}
1432
1433	if (!n_block)
1434		goto nothing_to_do;
1435	if (block >= dev_sectors)
1436		goto out_of_range;
1437	if ((block + n_block) > dev_sectors)
1438		goto out_of_range;
1439
1440	if (dev->flags & ATA_DFLAG_LBA) {
1441		tf->flags |= ATA_TFLAG_LBA;
1442
1443		if (lba_28_ok(block, n_block)) {
1444			/* use LBA28 */
1445			tf->command = ATA_CMD_VERIFY;
1446			tf->device |= (block >> 24) & 0xf;
1447		} else if (lba_48_ok(block, n_block)) {
1448			if (!(dev->flags & ATA_DFLAG_LBA48))
1449				goto out_of_range;
1450
1451			/* use LBA48 */
1452			tf->flags |= ATA_TFLAG_LBA48;
1453			tf->command = ATA_CMD_VERIFY_EXT;
1454
1455			tf->hob_nsect = (n_block >> 8) & 0xff;
1456
1457			tf->hob_lbah = (block >> 40) & 0xff;
1458			tf->hob_lbam = (block >> 32) & 0xff;
1459			tf->hob_lbal = (block >> 24) & 0xff;
1460		} else
1461			/* request too large even for LBA48 */
1462			goto out_of_range;
1463
1464		tf->nsect = n_block & 0xff;
1465
1466		tf->lbah = (block >> 16) & 0xff;
1467		tf->lbam = (block >> 8) & 0xff;
1468		tf->lbal = block & 0xff;
1469
1470		tf->device |= ATA_LBA;
1471	} else {
1472		/* CHS */
1473		u32 sect, head, cyl, track;
1474
1475		if (!lba_28_ok(block, n_block))
1476			goto out_of_range;
1477
1478		/* Convert LBA to CHS */
1479		track = (u32)block / dev->sectors;
1480		cyl   = track / dev->heads;
1481		head  = track % dev->heads;
1482		sect  = (u32)block % dev->sectors + 1;
1483
1484		/* Check whether the converted CHS can fit.
1485		   Cylinder: 0-65535
1486		   Head: 0-15
1487		   Sector: 1-255*/
1488		if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1489			goto out_of_range;
1490
1491		tf->command = ATA_CMD_VERIFY;
1492		tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
1493		tf->lbal = sect;
1494		tf->lbam = cyl;
1495		tf->lbah = cyl >> 8;
1496		tf->device |= head;
1497	}
1498
1499	return 0;
1500
1501invalid_fld:
1502	ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1503	return 1;
1504
1505out_of_range:
1506	ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1507	/* "Logical Block Address out of range" */
1508	return 1;
1509
1510nothing_to_do:
1511	scmd->result = SAM_STAT_GOOD;
1512	return 1;
1513}
1514
1515static bool ata_check_nblocks(struct scsi_cmnd *scmd, u32 n_blocks)
1516{
1517	struct request *rq = scsi_cmd_to_rq(scmd);
1518	u32 req_blocks;
1519
1520	if (!blk_rq_is_passthrough(rq))
1521		return true;
1522
1523	req_blocks = blk_rq_bytes(rq) / scmd->device->sector_size;
1524	if (n_blocks > req_blocks)
1525		return false;
1526
1527	return true;
1528}
1529
1530/**
1531 *	ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
1532 *	@qc: Storage for translated ATA taskfile
1533 *
1534 *	Converts any of six SCSI read/write commands into the
1535 *	ATA counterpart, including starting sector (LBA),
1536 *	sector count, and taking into account the device's LBA48
1537 *	support.
1538 *
1539 *	Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
1540 *	%WRITE_16 are currently supported.
1541 *
1542 *	LOCKING:
1543 *	spin_lock_irqsave(host lock)
1544 *
1545 *	RETURNS:
1546 *	Zero on success, non-zero on error.
1547 */
1548static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
1549{
1550	struct scsi_cmnd *scmd = qc->scsicmd;
1551	const u8 *cdb = scmd->cmnd;
1552	struct request *rq = scsi_cmd_to_rq(scmd);
1553	int class = IOPRIO_PRIO_CLASS(req_get_ioprio(rq));
1554	unsigned int tf_flags = 0;
1555	int dld = 0;
1556	u64 block;
1557	u32 n_block;
1558	int rc;
1559	u16 fp = 0;
1560
1561	switch (cdb[0]) {
1562	case WRITE_6:
1563	case WRITE_10:
1564	case WRITE_16:
1565		tf_flags |= ATA_TFLAG_WRITE;
1566		break;
1567	}
1568
1569	/* Calculate the SCSI LBA, transfer length and FUA. */
1570	switch (cdb[0]) {
1571	case READ_10:
1572	case WRITE_10:
1573		if (unlikely(scmd->cmd_len < 10)) {
1574			fp = 9;
1575			goto invalid_fld;
1576		}
1577		scsi_10_lba_len(cdb, &block, &n_block);
1578		if (cdb[1] & (1 << 3))
1579			tf_flags |= ATA_TFLAG_FUA;
1580		if (!ata_check_nblocks(scmd, n_block))
1581			goto invalid_fld;
1582		break;
1583	case READ_6:
1584	case WRITE_6:
1585		if (unlikely(scmd->cmd_len < 6)) {
1586			fp = 5;
1587			goto invalid_fld;
1588		}
1589		scsi_6_lba_len(cdb, &block, &n_block);
1590
1591		/* for 6-byte r/w commands, transfer length 0
1592		 * means 256 blocks of data, not 0 block.
1593		 */
1594		if (!n_block)
1595			n_block = 256;
1596		if (!ata_check_nblocks(scmd, n_block))
1597			goto invalid_fld;
1598		break;
1599	case READ_16:
1600	case WRITE_16:
1601		if (unlikely(scmd->cmd_len < 16)) {
1602			fp = 15;
1603			goto invalid_fld;
1604		}
1605		scsi_16_lba_len(cdb, &block, &n_block);
1606		dld = scsi_dld(cdb);
1607		if (cdb[1] & (1 << 3))
1608			tf_flags |= ATA_TFLAG_FUA;
1609		if (!ata_check_nblocks(scmd, n_block))
1610			goto invalid_fld;
1611		break;
1612	default:
1613		fp = 0;
1614		goto invalid_fld;
1615	}
1616
1617	/* Check and compose ATA command */
1618	if (!n_block)
1619		/* For 10-byte and 16-byte SCSI R/W commands, transfer
1620		 * length 0 means transfer 0 block of data.
1621		 * However, for ATA R/W commands, sector count 0 means
1622		 * 256 or 65536 sectors, not 0 sectors as in SCSI.
1623		 *
1624		 * WARNING: one or two older ATA drives treat 0 as 0...
1625		 */
1626		goto nothing_to_do;
1627
1628	qc->flags |= ATA_QCFLAG_IO;
1629	qc->nbytes = n_block * scmd->device->sector_size;
1630
1631	rc = ata_build_rw_tf(qc, block, n_block, tf_flags, dld, class);
1632	if (likely(rc == 0))
1633		return 0;
1634
1635	if (rc == -ERANGE)
1636		goto out_of_range;
1637	/* treat all other errors as -EINVAL, fall through */
1638invalid_fld:
1639	ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
1640	return 1;
1641
1642out_of_range:
1643	ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1644	/* "Logical Block Address out of range" */
1645	return 1;
1646
1647nothing_to_do:
1648	scmd->result = SAM_STAT_GOOD;
1649	return 1;
1650}
1651
1652static void ata_qc_done(struct ata_queued_cmd *qc)
1653{
1654	struct scsi_cmnd *cmd = qc->scsicmd;
1655	void (*done)(struct scsi_cmnd *) = qc->scsidone;
1656
1657	ata_qc_free(qc);
1658	done(cmd);
1659}
1660
1661void ata_scsi_deferred_qc_work(struct work_struct *work)
1662{
1663	struct ata_port *ap =
1664		container_of(work, struct ata_port, deferred_qc_work);
1665	struct ata_queued_cmd *qc;
1666	unsigned long flags;
1667
1668	spin_lock_irqsave(ap->lock, flags);
1669
1670	/*
1671	 * If we still have a deferred qc and we are not in EH, issue it. In
1672	 * such case, we should not need any more deferring the qc, so warn if
1673	 * qc_defer() says otherwise.
1674	 */
1675	qc = ap->deferred_qc;
1676	if (qc && !ata_port_eh_scheduled(ap)) {
1677		WARN_ON_ONCE(ap->ops->qc_defer(qc));
1678		ap->deferred_qc = NULL;
1679		ata_qc_issue(qc);
1680	}
1681
1682	spin_unlock_irqrestore(ap->lock, flags);
1683}
1684
1685void ata_scsi_requeue_deferred_qc(struct ata_port *ap)
1686{
1687	struct ata_queued_cmd *qc = ap->deferred_qc;
1688	struct scsi_cmnd *scmd;
1689
1690	lockdep_assert_held(ap->lock);
1691
1692	/*
1693	 * If we have a deferred qc when a reset occurs or NCQ commands fail,
1694	 * do not try to be smart about what to do with this deferred command
1695	 * and simply retry it by completing it with DID_SOFT_ERROR.
1696	 */
1697	if (!qc)
1698		return;
1699
1700	scmd = qc->scsicmd;
1701	ap->deferred_qc = NULL;
1702	cancel_work(&ap->deferred_qc_work);
1703	ata_qc_free(qc);
1704	scmd->result = (DID_SOFT_ERROR << 16);
1705	scsi_done(scmd);
1706}
1707
1708static void ata_scsi_schedule_deferred_qc(struct ata_port *ap)
1709{
1710	struct ata_queued_cmd *qc = ap->deferred_qc;
1711
1712	lockdep_assert_held(ap->lock);
1713
1714	/*
1715	 * If we have a deferred qc, then qc_defer() is defined and we can use
1716	 * this callback to determine if this qc is good to go, unless EH has
1717	 * been scheduled.
1718	 */
1719	if (!qc)
1720		return;
1721
1722	if (ata_port_eh_scheduled(ap)) {
1723		ata_scsi_requeue_deferred_qc(ap);
1724		return;
1725	}
1726	if (!ap->ops->qc_defer(qc))
1727		queue_work(system_highpri_wq, &ap->deferred_qc_work);
1728}
1729
1730static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
1731{
1732	struct ata_port *ap = qc->ap;
1733	struct scsi_cmnd *cmd = qc->scsicmd;
1734	u8 *cdb = cmd->cmnd;
1735	bool have_sense = qc->flags & ATA_QCFLAG_SENSE_VALID;
1736	bool is_ata_passthru = cdb[0] == ATA_16 || cdb[0] == ATA_12;
1737	bool is_ck_cond_request = cdb[2] & 0x20;
1738	bool is_error = qc->err_mask != 0;
1739
1740	/* For ATA pass thru (SAT) commands, generate a sense block if
1741	 * user mandated it or if there's an error.  Note that if we
1742	 * generate because the user forced us to [CK_COND=1], a check
1743	 * condition is generated and the ATA register values are returned
1744	 * whether the command completed successfully or not. If there
1745	 * was no error, and CK_COND=1, we use the following sense data:
1746	 * sk = RECOVERED ERROR
1747	 * asc,ascq = ATA PASS-THROUGH INFORMATION AVAILABLE
1748	 */
1749	if (is_ata_passthru && (is_ck_cond_request || is_error || have_sense)) {
1750		if (!have_sense)
1751			ata_gen_passthru_sense(qc);
1752		ata_scsi_set_passthru_sense_fields(qc);
1753		if (is_ck_cond_request)
1754			set_status_byte(qc->scsicmd, SAM_STAT_CHECK_CONDITION);
1755	} else if (is_error) {
1756		if (!have_sense)
1757			ata_gen_ata_sense(qc);
1758		ata_scsi_set_sense_information(qc);
1759	}
1760
1761	ata_qc_done(qc);
1762
1763	ata_scsi_schedule_deferred_qc(ap);
1764}
1765
1766static int ata_scsi_qc_issue(struct ata_port *ap, struct ata_queued_cmd *qc)
1767{
1768	int ret;
1769
1770	if (!ap->ops->qc_defer)
1771		goto issue;
1772
1773	/*
1774	 * If we already have a deferred qc, then rely on the SCSI layer to
1775	 * requeue and defer all incoming commands until the deferred qc is
1776	 * processed, once all on-going commands complete.
1777	 */
1778	if (ap->deferred_qc) {
1779		ata_qc_free(qc);
1780		return SCSI_MLQUEUE_DEVICE_BUSY;
1781	}
1782
1783	/* Check if the command needs to be deferred. */
1784	ret = ap->ops->qc_defer(qc);
1785	switch (ret) {
1786	case 0:
1787		break;
1788	case ATA_DEFER_LINK:
1789		ret = SCSI_MLQUEUE_DEVICE_BUSY;
1790		break;
1791	case ATA_DEFER_PORT:
1792		ret = SCSI_MLQUEUE_HOST_BUSY;
1793		break;
1794	default:
1795		WARN_ON_ONCE(1);
1796		ret = SCSI_MLQUEUE_HOST_BUSY;
1797		break;
1798	}
1799
1800	if (ret) {
1801		/*
1802		 * We must defer this qc: if this is not an NCQ command, keep
1803		 * this qc as a deferred one and report to the SCSI layer that
1804		 * we issued it so that it is not requeued. The deferred qc will
1805		 * be issued with the port deferred_qc_work once all on-going
1806		 * commands complete.
1807		 */
1808		if (!ata_is_ncq(qc->tf.protocol)) {
1809			ap->deferred_qc = qc;
1810			return 0;
1811		}
1812
1813		/* Force a requeue of the command to defer its execution. */
1814		ata_qc_free(qc);
1815		return ret;
1816	}
1817
1818issue:
1819	ata_qc_issue(qc);
1820
1821	return 0;
1822}
1823
1824/**
1825 *	ata_scsi_translate - Translate then issue SCSI command to ATA device
1826 *	@dev: ATA device to which the command is addressed
1827 *	@cmd: SCSI command to execute
1828 *	@xlat_func: Actor which translates @cmd to an ATA taskfile
1829 *
1830 *	Our ->queuecommand() function has decided that the SCSI
1831 *	command issued can be directly translated into an ATA
1832 *	command, rather than handled internally.
1833 *
1834 *	This function sets up an ata_queued_cmd structure for the
1835 *	SCSI command, and sends that ata_queued_cmd to the hardware.
1836 *
1837 *	The xlat_func argument (actor) returns 0 if ready to execute
1838 *	ATA command, else 1 to finish translation. If 1 is returned
1839 *	then cmd->result (and possibly cmd->sense_buffer) are assumed
1840 *	to be set reflecting an error condition or clean (early)
1841 *	termination.
1842 *
1843 *	LOCKING:
1844 *	spin_lock_irqsave(host lock)
1845 *
1846 *	RETURNS:
1847 *	0 on success, SCSI_ML_QUEUE_DEVICE_BUSY or SCSI_MLQUEUE_HOST_BUSY if the
1848 *	command needs to be deferred.
1849 */
1850static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
1851			      ata_xlat_func_t xlat_func)
1852{
1853	struct ata_port *ap = dev->link->ap;
1854	struct ata_queued_cmd *qc;
1855
1856	lockdep_assert_held(ap->lock);
1857
1858	/*
1859	 * ata_scsi_qc_new() calls scsi_done(cmd) in case of failure. So we
1860	 * have nothing further to do when allocating a qc fails.
1861	 */
1862	qc = ata_scsi_qc_new(dev, cmd);
1863	if (!qc)
1864		return 0;
1865
1866	/* data is present; dma-map it */
1867	if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
1868	    cmd->sc_data_direction == DMA_TO_DEVICE) {
1869		if (unlikely(scsi_bufflen(cmd) < 1)) {
1870			ata_dev_warn(dev, "WARNING: zero len r/w req\n");
1871			cmd->result = (DID_ERROR << 16);
1872			goto done;
1873		}
1874
1875		ata_sg_init(qc, scsi_sglist(cmd), scsi_sg_count(cmd));
1876		qc->dma_dir = cmd->sc_data_direction;
1877	}
1878
1879	qc->complete_fn = ata_scsi_qc_complete;
1880
1881	if (xlat_func(qc))
1882		goto done;
1883
1884	return ata_scsi_qc_issue(ap, qc);
1885
1886done:
1887	ata_qc_free(qc);
1888	scsi_done(cmd);
1889	return 0;
1890}
1891
1892/**
1893 *	ata_scsi_rbuf_fill - wrapper for SCSI command simulators
1894 *	@dev: Target device.
1895 *	@cmd: SCSI command of interest.
1896 *	@actor: Callback hook for desired SCSI command simulator
1897 *
1898 *	Takes care of the hard work of simulating a SCSI command...
1899 *	Mapping the response buffer, calling the command's handler,
1900 *	and handling the handler's return value.  This return value
1901 *	indicates whether the handler wishes the SCSI command to be
1902 *	completed successfully (0), or not (in which case cmd->result
1903 *	and sense buffer are assumed to be set).
1904 *
1905 *	LOCKING:
1906 *	spin_lock_irqsave(host lock)
1907 */
1908static void ata_scsi_rbuf_fill(struct ata_device *dev, struct scsi_cmnd *cmd,
1909		unsigned int (*actor)(struct ata_device *dev,
1910				      struct scsi_cmnd *cmd, u8 *rbuf))
1911{
1912	unsigned long flags;
1913	unsigned int len;
1914
1915	spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
1916
1917	memset(ata_scsi_rbuf, 0, ATA_SCSI_RBUF_SIZE);
1918	len = actor(dev, cmd, ata_scsi_rbuf);
1919	if (len) {
1920		sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd),
1921				    ata_scsi_rbuf, ATA_SCSI_RBUF_SIZE);
1922		cmd->result = SAM_STAT_GOOD;
1923		if (scsi_bufflen(cmd) > len)
1924			scsi_set_resid(cmd, scsi_bufflen(cmd) - len);
1925	}
1926
1927	spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
1928}
1929
1930/**
1931 *	ata_scsiop_inq_std - Simulate standard INQUIRY command
1932 *	@dev: Target device.
1933 *	@cmd: SCSI command of interest.
1934 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
1935 *
1936 *	Returns standard device identification data associated
1937 *	with non-VPD INQUIRY command output.
1938 *
1939 *	LOCKING:
1940 *	spin_lock_irqsave(host lock)
1941 */
1942static unsigned int ata_scsiop_inq_std(struct ata_device *dev,
1943				       struct scsi_cmnd *cmd, u8 *rbuf)
1944{
1945	static const u8 versions[] = {
1946		0x00,
1947		0x60,	/* SAM-3 (no version claimed) */
1948
1949		0x03,
1950		0x20,	/* SBC-2 (no version claimed) */
1951
1952		0x03,
1953		0x00	/* SPC-3 (no version claimed) */
1954	};
1955	static const u8 versions_zbc[] = {
1956		0x00,
1957		0xA0,	/* SAM-5 (no version claimed) */
1958
1959		0x06,
1960		0x00,	/* SBC-4 (no version claimed) */
1961
1962		0x05,
1963		0xC0,	/* SPC-5 (no version claimed) */
1964
1965		0x60,
1966		0x24,   /* ZBC r05 */
1967	};
1968
1969	u8 hdr[] = {
1970		TYPE_DISK,
1971		0,
1972		0x5,	/* claim SPC-3 version compatibility */
1973		2,
1974		95 - 4,
1975		0,
1976		0,
1977		2
1978	};
1979
1980	/*
1981	 * Set the SCSI Removable Media Bit (RMB) if the ATA removable media
1982	 * device bit (obsolete since ATA-8 ACS) is set.
1983	 */
1984	if (ata_id_removable(dev->id))
1985		hdr[1] |= (1 << 7);
1986
1987	if (dev->class == ATA_DEV_ZAC) {
1988		hdr[0] = TYPE_ZBC;
1989		hdr[2] = 0x7; /* claim SPC-5 version compatibility */
1990	}
1991
1992	if (dev->flags & ATA_DFLAG_CDL)
1993		hdr[2] = 0xd; /* claim SPC-6 version compatibility */
1994
1995	memcpy(rbuf, hdr, sizeof(hdr));
1996	memcpy(&rbuf[8], "ATA     ", 8);
1997	ata_id_string(dev->id, &rbuf[16], ATA_ID_PROD, 16);
1998
1999	/* From SAT, use last 2 words from fw rev unless they are spaces */
2000	ata_id_string(dev->id, &rbuf[32], ATA_ID_FW_REV + 2, 4);
2001	if (strncmp(&rbuf[32], "    ", 4) == 0)
2002		ata_id_string(dev->id, &rbuf[32], ATA_ID_FW_REV, 4);
2003
2004	if (rbuf[32] == 0 || rbuf[32] == ' ')
2005		memcpy(&rbuf[32], "n/a ", 4);
2006
2007	if (ata_id_zoned_cap(dev->id) || dev->class == ATA_DEV_ZAC)
2008		memcpy(rbuf + 58, versions_zbc, sizeof(versions_zbc));
2009	else
2010		memcpy(rbuf + 58, versions, sizeof(versions));
2011
2012	/*
2013	 * Include all 8 possible version descriptors, even if not all of
2014	 * them are popoulated.
2015	 */
2016	return 96;
2017}
2018
2019/**
2020 *	ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
2021 *	@dev: Target device.
2022 *	@cmd: SCSI command of interest.
2023 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2024 *
2025 *	Returns list of inquiry VPD pages available.
2026 *
2027 *	LOCKING:
2028 *	spin_lock_irqsave(host lock)
2029 */
2030static unsigned int ata_scsiop_inq_00(struct ata_device *dev,
2031				      struct scsi_cmnd *cmd, u8 *rbuf)
2032{
2033	int i, num_pages = 0;
2034	static const u8 pages[] = {
2035		0x00,	/* page 0x00, this page */
2036		0x80,	/* page 0x80, unit serial no page */
2037		0x83,	/* page 0x83, device ident page */
2038		0x89,	/* page 0x89, ata info page */
2039		0xb0,	/* page 0xb0, block limits page */
2040		0xb1,	/* page 0xb1, block device characteristics page */
2041		0xb2,	/* page 0xb2, thin provisioning page */
2042		0xb6,	/* page 0xb6, zoned block device characteristics */
2043		0xb9,	/* page 0xb9, concurrent positioning ranges */
2044	};
2045
2046	for (i = 0; i < sizeof(pages); i++) {
2047		if (pages[i] == 0xb6 && !ata_dev_is_zac(dev))
2048			continue;
2049		rbuf[num_pages + 4] = pages[i];
2050		num_pages++;
2051	}
2052	rbuf[3] = num_pages;	/* number of supported VPD pages */
2053
2054	return get_unaligned_be16(&rbuf[2]) + 4;
2055}
2056
2057/**
2058 *	ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
2059 *	@dev: Target device.
2060 *	@cmd: SCSI command of interest.
2061 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2062 *
2063 *	Returns ATA device serial number.
2064 *
2065 *	LOCKING:
2066 *	spin_lock_irqsave(host lock)
2067 */
2068static unsigned int ata_scsiop_inq_80(struct ata_device *dev,
2069				      struct scsi_cmnd *cmd, u8 *rbuf)
2070{
2071	static const u8 hdr[] = {
2072		0,
2073		0x80,			/* this page code */
2074		0,
2075		ATA_ID_SERNO_LEN,	/* page len */
2076	};
2077
2078	memcpy(rbuf, hdr, sizeof(hdr));
2079	ata_id_string(dev->id, (unsigned char *) &rbuf[4],
2080		      ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2081
2082	return get_unaligned_be16(&rbuf[2]) + 4;
2083}
2084
2085/**
2086 *	ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
2087 *	@dev: Target device.
2088 *	@cmd: SCSI command of interest.
2089 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2090 *
2091 *	Yields two logical unit device identification designators:
2092 *	 - vendor specific ASCII containing the ATA serial number
2093 *	 - SAT defined "t10 vendor id based" containing ASCII vendor
2094 *	   name ("ATA     "), model and serial numbers.
2095 *
2096 *	LOCKING:
2097 *	spin_lock_irqsave(host lock)
2098 */
2099static unsigned int ata_scsiop_inq_83(struct ata_device *dev,
2100				      struct scsi_cmnd *cmd, u8 *rbuf)
2101{
2102	const int sat_model_serial_desc_len = 68;
2103	int num;
2104
2105	rbuf[1] = 0x83;			/* this page code */
2106	num = 4;
2107
2108	/* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
2109	rbuf[num + 0] = 2;
2110	rbuf[num + 3] = ATA_ID_SERNO_LEN;
2111	num += 4;
2112	ata_id_string(dev->id, (unsigned char *) rbuf + num,
2113		      ATA_ID_SERNO, ATA_ID_SERNO_LEN);
2114	num += ATA_ID_SERNO_LEN;
2115
2116	/* SAT defined lu model and serial numbers descriptor */
2117	/* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
2118	rbuf[num + 0] = 2;
2119	rbuf[num + 1] = 1;
2120	rbuf[num + 3] = sat_model_serial_desc_len;
2121	num += 4;
2122	memcpy(rbuf + num, "ATA     ", 8);
2123	num += 8;
2124	ata_id_string(dev->id, (unsigned char *) rbuf + num, ATA_ID_PROD,
2125		      ATA_ID_PROD_LEN);
2126	num += ATA_ID_PROD_LEN;
2127	ata_id_string(dev->id, (unsigned char *) rbuf + num, ATA_ID_SERNO,
2128		      ATA_ID_SERNO_LEN);
2129	num += ATA_ID_SERNO_LEN;
2130
2131	if (ata_id_has_wwn(dev->id)) {
2132		/* SAT defined lu world wide name */
2133		/* piv=0, assoc=lu, code_set=binary, designator=NAA */
2134		rbuf[num + 0] = 1;
2135		rbuf[num + 1] = 3;
2136		rbuf[num + 3] = ATA_ID_WWN_LEN;
2137		num += 4;
2138		ata_id_string(dev->id, (unsigned char *) rbuf + num,
2139			      ATA_ID_WWN, ATA_ID_WWN_LEN);
2140		num += ATA_ID_WWN_LEN;
2141	}
2142	rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
2143
2144	return get_unaligned_be16(&rbuf[2]) + 4;
2145}
2146
2147/**
2148 *	ata_scsiop_inq_89 - Simulate INQUIRY VPD page 89, ATA info
2149 *	@dev: Target device.
2150 *	@cmd: SCSI command of interest.
2151 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2152 *
2153 *	Yields SAT-specified ATA VPD page.
2154 *
2155 *	LOCKING:
2156 *	spin_lock_irqsave(host lock)
2157 */
2158static unsigned int ata_scsiop_inq_89(struct ata_device *dev,
2159				      struct scsi_cmnd *cmd, u8 *rbuf)
2160{
2161	rbuf[1] = 0x89;			/* our page code */
2162	rbuf[2] = (0x238 >> 8);		/* page size fixed at 238h */
2163	rbuf[3] = (0x238 & 0xff);
2164
2165	memcpy(&rbuf[8], "linux   ", 8);
2166	memcpy(&rbuf[16], "libata          ", 16);
2167	memcpy(&rbuf[32], DRV_VERSION, 4);
2168
2169	rbuf[36] = 0x34;		/* force D2H Reg FIS (34h) */
2170	rbuf[37] = (1 << 7);		/* bit 7 indicates Command FIS */
2171					/* TODO: PMP? */
2172
2173	/* we don't store the ATA device signature, so we fake it */
2174	rbuf[38] = ATA_DRDY;		/* really, this is Status reg */
2175	rbuf[40] = 0x1;
2176	rbuf[48] = 0x1;
2177
2178	rbuf[56] = ATA_CMD_ID_ATA;
2179
2180	memcpy(&rbuf[60], &dev->id[0], 512);
2181
2182	return get_unaligned_be16(&rbuf[2]) + 4;
2183}
2184
2185/**
2186 *	ata_scsiop_inq_b0 - Simulate INQUIRY VPD page B0, Block Limits
2187 *	@dev: Target device.
2188 *	@cmd: SCSI command of interest.
2189 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2190 *
2191 *	Return data for the VPD page B0h (Block Limits).
2192 *
2193 *	LOCKING:
2194 *	spin_lock_irqsave(host lock)
2195 */
2196static unsigned int ata_scsiop_inq_b0(struct ata_device *dev,
2197				      struct scsi_cmnd *cmd, u8 *rbuf)
2198{
2199	u16 min_io_sectors;
2200
2201	rbuf[1] = 0xb0;
2202	rbuf[3] = 0x3c;		/* required VPD size with unmap support */
2203
2204	/*
2205	 * Optimal transfer length granularity.
2206	 *
2207	 * This is always one physical block, but for disks with a smaller
2208	 * logical than physical sector size we need to figure out what the
2209	 * latter is.
2210	 */
2211	min_io_sectors = 1 << ata_id_log2_per_physical_sector(dev->id);
2212	put_unaligned_be16(min_io_sectors, &rbuf[6]);
2213
2214	/*
2215	 * Optimal unmap granularity.
2216	 *
2217	 * The ATA spec doesn't even know about a granularity or alignment
2218	 * for the TRIM command.  We can leave away most of the unmap related
2219	 * VPD page entries, but we have specifify a granularity to signal
2220	 * that we support some form of unmap - in thise case via WRITE SAME
2221	 * with the unmap bit set.
2222	 */
2223	if (ata_id_has_trim(dev->id)) {
2224		u64 max_blocks = 65535 * ATA_MAX_TRIM_RNUM;
2225
2226		if (dev->quirks & ATA_QUIRK_MAX_TRIM_128M)
2227			max_blocks = 128 << (20 - SECTOR_SHIFT);
2228
2229		put_unaligned_be64(max_blocks, &rbuf[36]);
2230		put_unaligned_be32(1, &rbuf[28]);
2231	}
2232
2233	return get_unaligned_be16(&rbuf[2]) + 4;
2234}
2235
2236/**
2237 *	ata_scsiop_inq_b1 - Simulate INQUIRY VPD page B1, Block Device
2238 *			    Characteristics
2239 *	@dev: Target device.
2240 *	@cmd: SCSI command of interest.
2241 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2242 *
2243 *	Return data for the VPD page B1h (Block Device Characteristics).
2244 *
2245 *	LOCKING:
2246 *	spin_lock_irqsave(host lock)
2247 */
2248static unsigned int ata_scsiop_inq_b1(struct ata_device *dev,
2249				      struct scsi_cmnd *cmd, u8 *rbuf)
2250{
2251	int form_factor = ata_id_form_factor(dev->id);
2252	int media_rotation_rate = ata_id_rotation_rate(dev->id);
2253	u8 zoned = ata_id_zoned_cap(dev->id);
2254
2255	rbuf[1] = 0xb1;
2256	rbuf[3] = 0x3c;
2257	rbuf[4] = media_rotation_rate >> 8;
2258	rbuf[5] = media_rotation_rate;
2259	rbuf[7] = form_factor;
2260	if (zoned)
2261		rbuf[8] = (zoned << 4);
2262
2263	return get_unaligned_be16(&rbuf[2]) + 4;
2264}
2265
2266/**
2267 *	ata_scsiop_inq_b2 - Simulate INQUIRY VPD page B2, Logical Block
2268 *			    Provisioning
2269 *	@dev: Target device.
2270 *	@cmd: SCSI command of interest.
2271 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2272 *
2273 *	Return data for the VPD page B2h (Logical Block Provisioning).
2274 *
2275 *	LOCKING:
2276 *	spin_lock_irqsave(host lock)
2277 */
2278static unsigned int ata_scsiop_inq_b2(struct ata_device *dev,
2279				      struct scsi_cmnd *cmd, u8 *rbuf)
2280{
2281	/* SCSI Thin Provisioning VPD page: SBC-3 rev 22 or later */
2282	rbuf[1] = 0xb2;
2283	rbuf[3] = 0x4;
2284	rbuf[5] = 1 << 6;	/* TPWS */
2285
2286	return get_unaligned_be16(&rbuf[2]) + 4;
2287}
2288
2289/**
2290 *	ata_scsiop_inq_b6 - Simulate INQUIRY VPD page B6, Zoned Block Device
2291 *			    Characteristics
2292 *	@dev: Target device.
2293 *	@cmd: SCSI command of interest.
2294 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2295 *
2296 *	Return data for the VPD page B2h (Zoned Block Device Characteristics).
2297 *
2298 *	LOCKING:
2299 *	spin_lock_irqsave(host lock)
2300 */
2301static unsigned int ata_scsiop_inq_b6(struct ata_device *dev,
2302				      struct scsi_cmnd *cmd, u8 *rbuf)
2303{
2304	if (!ata_dev_is_zac(dev)) {
2305		ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
2306		return 0;
2307	}
2308
2309	/*
2310	 * zbc-r05 SCSI Zoned Block device characteristics VPD page
2311	 */
2312	rbuf[1] = 0xb6;
2313	rbuf[3] = 0x3C;
2314
2315	/*
2316	 * URSWRZ bit is only meaningful for host-managed ZAC drives
2317	 */
2318	if (dev->zac_zoned_cap & 1)
2319		rbuf[4] |= 1;
2320	put_unaligned_be32(dev->zac_zones_optimal_open, &rbuf[8]);
2321	put_unaligned_be32(dev->zac_zones_optimal_nonseq, &rbuf[12]);
2322	put_unaligned_be32(dev->zac_zones_max_open, &rbuf[16]);
2323
2324	return get_unaligned_be16(&rbuf[2]) + 4;
2325}
2326
2327/**
2328 *	ata_scsiop_inq_b9 - Simulate INQUIRY VPD page B9, Concurrent Positioning
2329 *			    Ranges
2330 *	@dev: Target device.
2331 *	@cmd: SCSI command of interest.
2332 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2333 *
2334 *	Return data for the VPD page B9h (Concurrent Positioning Ranges).
2335 *
2336 *	LOCKING:
2337 *	spin_lock_irqsave(host lock)
2338 */
2339static unsigned int ata_scsiop_inq_b9(struct ata_device *dev,
2340				      struct scsi_cmnd *cmd, u8 *rbuf)
2341{
2342	struct ata_cpr_log *cpr_log = dev->cpr_log;
2343	u8 *desc = &rbuf[64];
2344	int i;
2345
2346	if (!cpr_log) {
2347		ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
2348		return 0;
2349	}
2350
2351	/* SCSI Concurrent Positioning Ranges VPD page: SBC-5 rev 1 or later */
2352	rbuf[1] = 0xb9;
2353	put_unaligned_be16(64 + (int)cpr_log->nr_cpr * 32 - 4, &rbuf[2]);
2354
2355	for (i = 0; i < cpr_log->nr_cpr; i++, desc += 32) {
2356		desc[0] = cpr_log->cpr[i].num;
2357		desc[1] = cpr_log->cpr[i].num_storage_elements;
2358		put_unaligned_be64(cpr_log->cpr[i].start_lba, &desc[8]);
2359		put_unaligned_be64(cpr_log->cpr[i].num_lbas, &desc[16]);
2360	}
2361
2362	return get_unaligned_be16(&rbuf[2]) + 4;
2363}
2364
2365/**
2366 *	ata_scsiop_inquiry - Simulate INQUIRY command
2367 *	@dev: Target device.
2368 *	@cmd: SCSI command of interest.
2369 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2370 *
2371 *	Returns data associated with an INQUIRY command output.
2372 *
2373 *	LOCKING:
2374 *	spin_lock_irqsave(host lock)
2375 */
2376static unsigned int ata_scsiop_inquiry(struct ata_device *dev,
2377				       struct scsi_cmnd *cmd, u8 *rbuf)
2378{
2379	const u8 *scsicmd = cmd->cmnd;
2380
2381	/* is CmdDt set?  */
2382	if (scsicmd[1] & 2) {
2383		ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
2384		return 0;
2385	}
2386
2387	/* Is EVPD clear? */
2388	if ((scsicmd[1] & 1) == 0)
2389		return ata_scsiop_inq_std(dev, cmd, rbuf);
2390
2391	switch (scsicmd[2]) {
2392	case 0x00:
2393		return ata_scsiop_inq_00(dev, cmd, rbuf);
2394	case 0x80:
2395		return ata_scsiop_inq_80(dev, cmd, rbuf);
2396	case 0x83:
2397		return ata_scsiop_inq_83(dev, cmd, rbuf);
2398	case 0x89:
2399		return ata_scsiop_inq_89(dev, cmd, rbuf);
2400	case 0xb0:
2401		return ata_scsiop_inq_b0(dev, cmd, rbuf);
2402	case 0xb1:
2403		return ata_scsiop_inq_b1(dev, cmd, rbuf);
2404	case 0xb2:
2405		return ata_scsiop_inq_b2(dev, cmd, rbuf);
2406	case 0xb6:
2407		return ata_scsiop_inq_b6(dev, cmd, rbuf);
2408	case 0xb9:
2409		return ata_scsiop_inq_b9(dev, cmd, rbuf);
2410	default:
2411		ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
2412		return 0;
2413	}
2414}
2415
2416/**
2417 *	modecpy - Prepare response for MODE SENSE
2418 *	@dest: output buffer
2419 *	@src: data being copied
2420 *	@n: length of mode page
2421 *	@changeable: whether changeable parameters are requested
2422 *
2423 *	Generate a generic MODE SENSE page for either current or changeable
2424 *	parameters.
2425 *
2426 *	LOCKING:
2427 *	None.
2428 */
2429static void modecpy(u8 *dest, const u8 *src, int n, bool changeable)
2430{
2431	if (changeable) {
2432		memcpy(dest, src, 2);
2433		memset(dest + 2, 0, n - 2);
2434	} else {
2435		memcpy(dest, src, n);
2436	}
2437}
2438
2439/**
2440 *	ata_msense_caching - Simulate MODE SENSE caching info page
2441 *	@id: device IDENTIFY data
2442 *	@buf: output buffer
2443 *	@changeable: whether changeable parameters are requested
2444 *
2445 *	Generate a caching info page, which conditionally indicates
2446 *	write caching to the SCSI layer, depending on device
2447 *	capabilities.
2448 *
2449 *	LOCKING:
2450 *	None.
2451 */
2452static unsigned int ata_msense_caching(u16 *id, u8 *buf, bool changeable)
2453{
2454	modecpy(buf, def_cache_mpage, sizeof(def_cache_mpage), changeable);
2455	if (changeable) {
2456		buf[2] |= (1 << 2);	/* ata_mselect_caching() */
2457	} else {
2458		buf[2] |= (ata_id_wcache_enabled(id) << 2);	/* write cache enable */
2459		buf[12] |= (!ata_id_rahead_enabled(id) << 5);	/* disable read ahead */
2460	}
2461	return sizeof(def_cache_mpage);
2462}
2463
2464/*
2465 * Simulate MODE SENSE control mode page, sub-page 0.
2466 */
2467static unsigned int ata_msense_control_spg0(struct ata_device *dev, u8 *buf,
2468					    bool changeable)
2469{
2470	modecpy(buf, def_control_mpage,
2471		sizeof(def_control_mpage), changeable);
2472	if (changeable) {
2473		/* ata_mselect_control() */
2474		buf[2] |= (1 << 2);
2475	} else {
2476		bool d_sense = (dev->flags & ATA_DFLAG_D_SENSE);
2477
2478		/* descriptor format sense data */
2479		buf[2] |= (d_sense << 2);
2480	}
2481
2482	return sizeof(def_control_mpage);
2483}
2484
2485/*
2486 * Translate an ATA duration limit in microseconds to a SCSI duration limit
2487 * using the t2cdlunits 0xa (10ms). Since the SCSI duration limits are 2-bytes
2488 * only, take care of overflows.
2489 */
2490static inline u16 ata_xlat_cdl_limit(u8 *buf)
2491{
2492	u32 limit = get_unaligned_le32(buf);
2493
2494	return min_t(u32, limit / 10000, 65535);
2495}
2496
2497/*
2498 * Simulate MODE SENSE control mode page, sub-pages 07h and 08h
2499 * (command duration limits T2A and T2B mode pages).
2500 */
2501static unsigned int ata_msense_control_spgt2(struct ata_device *dev, u8 *buf,
2502					     u8 spg)
2503{
2504	u8 *b, *cdl, *desc;
2505	u32 policy;
2506	int i;
2507
2508	if (!(dev->flags & ATA_DFLAG_CDL) || !dev->cdl)
2509		return 0;
2510
2511	cdl = dev->cdl->desc_log_buf;
2512
2513	/*
2514	 * Fill the subpage. The first four bytes of the T2A/T2B mode pages
2515	 * are a header. The PAGE LENGTH field is the size of the page
2516	 * excluding the header.
2517	 */
2518	buf[0] = CONTROL_MPAGE;
2519	buf[1] = spg;
2520	put_unaligned_be16(CDL_T2_SUB_MPAGE_LEN - 4, &buf[2]);
2521	if (spg == CDL_T2A_SUB_MPAGE) {
2522		/*
2523		 * Read descriptors map to the T2A page:
2524		 * set perf_vs_duration_guidleine.
2525		 */
2526		buf[7] = (cdl[0] & 0x03) << 4;
2527		desc = cdl + 64;
2528	} else {
2529		/* Write descriptors map to the T2B page */
2530		desc = cdl + 288;
2531	}
2532
2533	/* Fill the T2 page descriptors */
2534	b = &buf[8];
2535	policy = get_unaligned_le32(&cdl[0]);
2536	for (i = 0; i < 7; i++, b += 32, desc += 32) {
2537		/* t2cdlunits: fixed to 10ms */
2538		b[0] = 0x0a;
2539
2540		/* Max inactive time and its policy */
2541		put_unaligned_be16(ata_xlat_cdl_limit(&desc[8]), &b[2]);
2542		b[6] = ((policy >> 8) & 0x0f) << 4;
2543
2544		/* Max active time and its policy */
2545		put_unaligned_be16(ata_xlat_cdl_limit(&desc[4]), &b[4]);
2546		b[6] |= (policy >> 4) & 0x0f;
2547
2548		/* Command duration guideline and its policy */
2549		put_unaligned_be16(ata_xlat_cdl_limit(&desc[16]), &b[10]);
2550		b[14] = policy & 0x0f;
2551	}
2552
2553	return CDL_T2_SUB_MPAGE_LEN;
2554}
2555
2556/*
2557 * Simulate MODE SENSE control mode page, sub-page f2h
2558 * (ATA feature control mode page).
2559 */
2560static unsigned int ata_msense_control_ata_feature(struct ata_device *dev,
2561						   u8 *buf)
2562{
2563	/* PS=0, SPF=1 */
2564	buf[0] = CONTROL_MPAGE | (1 << 6);
2565	buf[1] = ATA_FEATURE_SUB_MPAGE;
2566
2567	/*
2568	 * The first four bytes of ATA Feature Control mode page are a header.
2569	 * The PAGE LENGTH field is the size of the page excluding the header.
2570	 */
2571	put_unaligned_be16(ATA_FEATURE_SUB_MPAGE_LEN - 4, &buf[2]);
2572
2573	if (dev->flags & ATA_DFLAG_CDL_ENABLED)
2574		buf[4] = 0x02; /* T2A and T2B pages enabled */
2575	else
2576		buf[4] = 0;
2577
2578	return ATA_FEATURE_SUB_MPAGE_LEN;
2579}
2580
2581/**
2582 *	ata_msense_control - Simulate MODE SENSE control mode page
2583 *	@dev: ATA device of interest
2584 *	@buf: output buffer
2585 *	@spg: sub-page code
2586 *	@changeable: whether changeable parameters are requested
2587 *
2588 *	Generate a generic MODE SENSE control mode page.
2589 *
2590 *	LOCKING:
2591 *	None.
2592 */
2593static unsigned int ata_msense_control(struct ata_device *dev, u8 *buf,
2594				       u8 spg, bool changeable)
2595{
2596	unsigned int n;
2597
2598	switch (spg) {
2599	case 0:
2600		return ata_msense_control_spg0(dev, buf, changeable);
2601	case CDL_T2A_SUB_MPAGE:
2602	case CDL_T2B_SUB_MPAGE:
2603		return ata_msense_control_spgt2(dev, buf, spg);
2604	case ATA_FEATURE_SUB_MPAGE:
2605		return ata_msense_control_ata_feature(dev, buf);
2606	case ALL_SUB_MPAGES:
2607		n = ata_msense_control_spg0(dev, buf, changeable);
2608		n += ata_msense_control_spgt2(dev, buf + n, CDL_T2A_SUB_MPAGE);
2609		n += ata_msense_control_spgt2(dev, buf + n, CDL_T2B_SUB_MPAGE);
2610		n += ata_msense_control_ata_feature(dev, buf + n);
2611		return n;
2612	default:
2613		return 0;
2614	}
2615}
2616
2617/**
2618 *	ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
2619 *	@buf: output buffer
2620 *	@changeable: whether changeable parameters are requested
2621 *
2622 *	Generate a generic MODE SENSE r/w error recovery page.
2623 *
2624 *	LOCKING:
2625 *	None.
2626 */
2627static unsigned int ata_msense_rw_recovery(u8 *buf, bool changeable)
2628{
2629	modecpy(buf, def_rw_recovery_mpage, sizeof(def_rw_recovery_mpage),
2630		changeable);
2631	return sizeof(def_rw_recovery_mpage);
2632}
2633
2634/**
2635 *	ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
2636 *	@dev: Target device.
2637 *	@cmd: SCSI command of interest.
2638 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2639 *
2640 *	Simulate MODE SENSE commands. Assume this is invoked for direct
2641 *	access devices (e.g. disks) only. There should be no block
2642 *	descriptor for other device types.
2643 *
2644 *	LOCKING:
2645 *	spin_lock_irqsave(host lock)
2646 */
2647static unsigned int ata_scsiop_mode_sense(struct ata_device *dev,
2648					  struct scsi_cmnd *cmd, u8 *rbuf)
2649{
2650	u8 *scsicmd = cmd->cmnd, *p = rbuf;
2651	static const u8 sat_blk_desc[] = {
2652		0, 0, 0, 0,	/* number of blocks: sat unspecified */
2653		0,
2654		0, 0x2, 0x0	/* block length: 512 bytes */
2655	};
2656	u8 pg, spg;
2657	unsigned int ebd, page_control, six_byte;
2658	u8 dpofua = 0, bp = 0xff;
2659	u16 fp;
2660
2661	six_byte = (scsicmd[0] == MODE_SENSE);
2662	ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
2663	/*
2664	 * LLBA bit in msense(10) ignored (compliant)
2665	 */
2666
2667	page_control = scsicmd[2] >> 6;
2668	switch (page_control) {
2669	case 0: /* current */
2670	case 1: /* changeable */
2671	case 2: /* defaults */
2672		break;  /* supported */
2673	case 3: /* saved */
2674		goto saving_not_supp;
2675	default:
2676		fp = 2;
2677		bp = 6;
2678		goto invalid_fld;
2679	}
2680
2681	if (six_byte)
2682		p += 4 + (ebd ? 8 : 0);
2683	else
2684		p += 8 + (ebd ? 8 : 0);
2685
2686	pg = scsicmd[2] & 0x3f;
2687	spg = scsicmd[3];
2688
2689	/*
2690	 * Supported subpages: all subpages and sub-pages 07h, 08h and f2h of
2691	 * the control page.
2692	 */
2693	if (spg) {
2694		switch (spg) {
2695		case ALL_SUB_MPAGES:
2696			break;
2697		case CDL_T2A_SUB_MPAGE:
2698		case CDL_T2B_SUB_MPAGE:
2699		case ATA_FEATURE_SUB_MPAGE:
2700			if (dev->flags & ATA_DFLAG_CDL && pg == CONTROL_MPAGE)
2701				break;
2702			fallthrough;
2703		default:
2704			fp = 3;
2705			goto invalid_fld;
2706		}
2707	}
2708
2709	switch(pg) {
2710	case RW_RECOVERY_MPAGE:
2711		p += ata_msense_rw_recovery(p, page_control == 1);
2712		break;
2713
2714	case CACHE_MPAGE:
2715		p += ata_msense_caching(dev->id, p, page_control == 1);
2716		break;
2717
2718	case CONTROL_MPAGE:
2719		p += ata_msense_control(dev, p, spg, page_control == 1);
2720		break;
2721
2722	case ALL_MPAGES:
2723		p += ata_msense_rw_recovery(p, page_control == 1);
2724		p += ata_msense_caching(dev->id, p, page_control == 1);
2725		p += ata_msense_control(dev, p, spg, page_control == 1);
2726		break;
2727
2728	default:		/* invalid page code */
2729		fp = 2;
2730		goto invalid_fld;
2731	}
2732
2733	if (dev->flags & ATA_DFLAG_FUA)
2734		dpofua = 1 << 4;
2735
2736	if (six_byte) {
2737		rbuf[0] = p - rbuf - 1;
2738		rbuf[2] |= dpofua;
2739		if (ebd) {
2740			rbuf[3] = sizeof(sat_blk_desc);
2741			memcpy(rbuf + 4, sat_blk_desc, sizeof(sat_blk_desc));
2742		}
2743
2744		return rbuf[0] + 1;
2745	}
2746
2747	put_unaligned_be16(p - rbuf - 2, &rbuf[0]);
2748	rbuf[3] |= dpofua;
2749	if (ebd) {
2750		rbuf[7] = sizeof(sat_blk_desc);
2751		memcpy(rbuf + 8, sat_blk_desc, sizeof(sat_blk_desc));
2752	}
2753
2754	return get_unaligned_be16(&rbuf[0]) + 2;
2755
2756invalid_fld:
2757	ata_scsi_set_invalid_field(dev, cmd, fp, bp);
2758	return 0;
2759
2760saving_not_supp:
2761	ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x39, 0x0);
2762	 /* "Saving parameters not supported" */
2763	return 0;
2764}
2765
2766/**
2767 *	ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
2768 *	@dev: Target device.
2769 *	@cmd: SCSI command of interest.
2770 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2771 *
2772 *	Simulate READ CAPACITY commands.
2773 *
2774 *	LOCKING:
2775 *	None.
2776 */
2777static unsigned int ata_scsiop_read_cap(struct ata_device *dev,
2778					struct scsi_cmnd *cmd, u8 *rbuf)
2779{
2780	u8 *scsicmd = cmd->cmnd;
2781	u64 last_lba = dev->n_sectors - 1; /* LBA of the last block */
2782	u32 sector_size; /* physical sector size in bytes */
2783	u8 log2_per_phys;
2784	u16 lowest_aligned;
2785
2786	sector_size = ata_id_logical_sector_size(dev->id);
2787	log2_per_phys = ata_id_log2_per_physical_sector(dev->id);
2788	lowest_aligned = ata_id_logical_sector_offset(dev->id, log2_per_phys);
2789
2790	if (scsicmd[0] == READ_CAPACITY) {
2791		if (last_lba >= 0xffffffffULL)
2792			last_lba = 0xffffffff;
2793
2794		/* sector count, 32-bit */
2795		rbuf[0] = last_lba >> (8 * 3);
2796		rbuf[1] = last_lba >> (8 * 2);
2797		rbuf[2] = last_lba >> (8 * 1);
2798		rbuf[3] = last_lba;
2799
2800		/* sector size */
2801		rbuf[4] = sector_size >> (8 * 3);
2802		rbuf[5] = sector_size >> (8 * 2);
2803		rbuf[6] = sector_size >> (8 * 1);
2804		rbuf[7] = sector_size;
2805
2806		return 8;
2807	}
2808
2809	/*
2810	 * READ CAPACITY 16 command is defined as a service action
2811	 * (SERVICE_ACTION_IN_16 command).
2812	 */
2813	if (scsicmd[0] != SERVICE_ACTION_IN_16 ||
2814	    (scsicmd[1] & 0x1f) != SAI_READ_CAPACITY_16) {
2815		ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
2816		return 0;
2817	}
2818
2819	/* sector count, 64-bit */
2820	rbuf[0] = last_lba >> (8 * 7);
2821	rbuf[1] = last_lba >> (8 * 6);
2822	rbuf[2] = last_lba >> (8 * 5);
2823	rbuf[3] = last_lba >> (8 * 4);
2824	rbuf[4] = last_lba >> (8 * 3);
2825	rbuf[5] = last_lba >> (8 * 2);
2826	rbuf[6] = last_lba >> (8 * 1);
2827	rbuf[7] = last_lba;
2828
2829	/* sector size */
2830	rbuf[ 8] = sector_size >> (8 * 3);
2831	rbuf[ 9] = sector_size >> (8 * 2);
2832	rbuf[10] = sector_size >> (8 * 1);
2833	rbuf[11] = sector_size;
2834
2835	if (ata_id_zoned_cap(dev->id) || dev->class == ATA_DEV_ZAC)
2836		rbuf[12] = (1 << 4); /* RC_BASIS */
2837	rbuf[13] = log2_per_phys;
2838	rbuf[14] = (lowest_aligned >> 8) & 0x3f;
2839	rbuf[15] = lowest_aligned;
2840
2841	if (ata_id_has_trim(dev->id) && !(dev->quirks & ATA_QUIRK_NOTRIM)) {
2842		rbuf[14] |= 0x80; /* LBPME */
2843
2844		if (ata_id_has_zero_after_trim(dev->id) &&
2845		    dev->quirks & ATA_QUIRK_ZERO_AFTER_TRIM) {
2846			ata_dev_info(dev, "Enabling discard_zeroes_data\n");
2847			rbuf[14] |= 0x40; /* LBPRZ */
2848		}
2849	}
2850
2851	return 16;
2852}
2853
2854/**
2855 *	ata_scsiop_report_luns - Simulate REPORT LUNS command
2856 *	@dev: Target device.
2857 *	@cmd: SCSI command of interest.
2858 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
2859 *
2860 *	Simulate REPORT LUNS command.
2861 *
2862 *	LOCKING:
2863 *	spin_lock_irqsave(host lock)
2864 */
2865static unsigned int ata_scsiop_report_luns(struct ata_device *dev,
2866					   struct scsi_cmnd *cmd, u8 *rbuf)
2867{
2868	rbuf[3] = 8;	/* just one lun, LUN 0, size 8 bytes */
2869
2870	return 16;
2871}
2872
2873/*
2874 * ATAPI devices typically report zero for their SCSI version, and sometimes
2875 * deviate from the spec WRT response data format.  If SCSI version is
2876 * reported as zero like normal, then we make the following fixups:
2877 *   1) Fake MMC-5 version, to indicate to the Linux scsi midlayer this is a
2878 *	modern device.
2879 *   2) Ensure response data format / ATAPI information are always correct.
2880 */
2881static void atapi_fixup_inquiry(struct scsi_cmnd *cmd)
2882{
2883	u8 buf[4];
2884
2885	sg_copy_to_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2886	if (buf[2] == 0) {
2887		buf[2] = 0x5;
2888		buf[3] = 0x32;
2889	}
2890	sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, 4);
2891}
2892
2893static void atapi_qc_complete(struct ata_queued_cmd *qc)
2894{
2895	struct scsi_cmnd *cmd = qc->scsicmd;
2896	unsigned int err_mask = qc->err_mask;
2897
2898	/* handle completion from EH */
2899	if (unlikely(err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID)) {
2900
2901		if (!(qc->flags & ATA_QCFLAG_SENSE_VALID))
2902			ata_gen_passthru_sense(qc);
2903
2904		/* SCSI EH automatically locks door if sdev->locked is
2905		 * set.  Sometimes door lock request continues to
2906		 * fail, for example, when no media is present.  This
2907		 * creates a loop - SCSI EH issues door lock which
2908		 * fails and gets invoked again to acquire sense data
2909		 * for the failed command.
2910		 *
2911		 * If door lock fails, always clear sdev->locked to
2912		 * avoid this infinite loop.
2913		 *
2914		 * This may happen before SCSI scan is complete.  Make
2915		 * sure qc->dev->sdev isn't NULL before dereferencing.
2916		 */
2917		if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL && qc->dev->sdev)
2918			qc->dev->sdev->locked = 0;
2919
2920		qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
2921		ata_qc_done(qc);
2922		return;
2923	}
2924
2925	/* successful completion path */
2926	if (cmd->cmnd[0] == INQUIRY && (cmd->cmnd[1] & 0x03) == 0)
2927		atapi_fixup_inquiry(cmd);
2928	cmd->result = SAM_STAT_GOOD;
2929
2930	ata_qc_done(qc);
2931}
2932/**
2933 *	atapi_xlat - Initialize PACKET taskfile
2934 *	@qc: command structure to be initialized
2935 *
2936 *	LOCKING:
2937 *	spin_lock_irqsave(host lock)
2938 *
2939 *	RETURNS:
2940 *	Zero on success, non-zero on failure.
2941 */
2942static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
2943{
2944	struct scsi_cmnd *scmd = qc->scsicmd;
2945	struct ata_device *dev = qc->dev;
2946	int nodata = (scmd->sc_data_direction == DMA_NONE);
2947	int using_pio = !nodata && (dev->flags & ATA_DFLAG_PIO);
2948	unsigned int nbytes;
2949
2950	memset(qc->cdb, 0, dev->cdb_len);
2951	memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
2952
2953	qc->complete_fn = atapi_qc_complete;
2954
2955	qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2956	if (scmd->sc_data_direction == DMA_TO_DEVICE) {
2957		qc->tf.flags |= ATA_TFLAG_WRITE;
2958	}
2959
2960	qc->tf.command = ATA_CMD_PACKET;
2961	ata_qc_set_pc_nbytes(qc);
2962
2963	/* check whether ATAPI DMA is safe */
2964	if (!nodata && !using_pio && atapi_check_dma(qc))
2965		using_pio = 1;
2966
2967	/* Some controller variants snoop this value for Packet
2968	 * transfers to do state machine and FIFO management.  Thus we
2969	 * want to set it properly, and for DMA where it is
2970	 * effectively meaningless.
2971	 */
2972	nbytes = min(ata_qc_raw_nbytes(qc), (unsigned int)63 * 1024);
2973
2974	/* Most ATAPI devices which honor transfer chunk size don't
2975	 * behave according to the spec when odd chunk size which
2976	 * matches the transfer length is specified.  If the number of
2977	 * bytes to transfer is 2n+1.  According to the spec, what
2978	 * should happen is to indicate that 2n+1 is going to be
2979	 * transferred and transfer 2n+2 bytes where the last byte is
2980	 * padding.
2981	 *
2982	 * In practice, this doesn't happen.  ATAPI devices first
2983	 * indicate and transfer 2n bytes and then indicate and
2984	 * transfer 2 bytes where the last byte is padding.
2985	 *
2986	 * This inconsistency confuses several controllers which
2987	 * perform PIO using DMA such as Intel AHCIs and sil3124/32.
2988	 * These controllers use actual number of transferred bytes to
2989	 * update DMA pointer and transfer of 4n+2 bytes make those
2990	 * controller push DMA pointer by 4n+4 bytes because SATA data
2991	 * FISes are aligned to 4 bytes.  This causes data corruption
2992	 * and buffer overrun.
2993	 *
2994	 * Always setting nbytes to even number solves this problem
2995	 * because then ATAPI devices don't have to split data at 2n
2996	 * boundaries.
2997	 */
2998	if (nbytes & 0x1)
2999		nbytes++;
3000
3001	qc->tf.lbam = (nbytes & 0xFF);
3002	qc->tf.lbah = (nbytes >> 8);
3003
3004	if (nodata)
3005		qc->tf.protocol = ATAPI_PROT_NODATA;
3006	else if (using_pio)
3007		qc->tf.protocol = ATAPI_PROT_PIO;
3008	else {
3009		/* DMA data xfer */
3010		qc->tf.protocol = ATAPI_PROT_DMA;
3011		qc->tf.feature |= ATAPI_PKT_DMA;
3012
3013		if ((dev->flags & ATA_DFLAG_DMADIR) &&
3014		    (scmd->sc_data_direction != DMA_TO_DEVICE))
3015			/* some SATA bridges need us to indicate data xfer direction */
3016			qc->tf.feature |= ATAPI_DMADIR;
3017	}
3018
3019
3020	/* FIXME: We need to translate 0x05 READ_BLOCK_LIMITS to a MODE_SENSE
3021	   as ATAPI tape drives don't get this right otherwise */
3022	return 0;
3023}
3024
3025static struct ata_device *ata_find_dev(struct ata_port *ap, unsigned int devno)
3026{
3027	/*
3028	 * For the non-PMP case, ata_link_max_devices() returns 1 (SATA case),
3029	 * or 2 (IDE master + slave case). However, the former case includes
3030	 * libsas hosted devices which are numbered per scsi host, leading
3031	 * to devno potentially being larger than 0 but with each struct
3032	 * ata_device having its own struct ata_port and struct ata_link.
3033	 * To accommodate these, ignore devno and always use device number 0.
3034	 */
3035	if (likely(!sata_pmp_attached(ap))) {
3036		int link_max_devices = ata_link_max_devices(&ap->link);
3037
3038		if (link_max_devices == 1)
3039			return &ap->link.device[0];
3040
3041		if (devno < link_max_devices)
3042			return &ap->link.device[devno];
3043
3044		return NULL;
3045	}
3046
3047	/*
3048	 * For PMP-attached devices, the device number corresponds to C
3049	 * (channel) of SCSI [H:C:I:L], indicating the port pmp link
3050	 * for the device.
3051	 */
3052	if (devno < ap->nr_pmp_links)
3053		return &ap->pmp_link[devno].device[0];
3054
3055	return NULL;
3056}
3057
3058static struct ata_device *__ata_scsi_find_dev(struct ata_port *ap,
3059					      const struct scsi_device *scsidev)
3060{
3061	int devno;
3062
3063	/* skip commands not addressed to targets we simulate */
3064	if (!sata_pmp_attached(ap)) {
3065		if (unlikely(scsidev->channel || scsidev->lun))
3066			return NULL;
3067		devno = scsidev->id;
3068	} else {
3069		if (unlikely(scsidev->id || scsidev->lun))
3070			return NULL;
3071		devno = scsidev->channel;
3072	}
3073
3074	return ata_find_dev(ap, devno);
3075}
3076
3077/**
3078 *	ata_scsi_find_dev - lookup ata_device from scsi_cmnd
3079 *	@ap: ATA port to which the device is attached
3080 *	@scsidev: SCSI device from which we derive the ATA device
3081 *
3082 *	Given various information provided in struct scsi_cmnd,
3083 *	map that onto an ATA bus, and using that mapping
3084 *	determine which ata_device is associated with the
3085 *	SCSI command to be sent.
3086 *
3087 *	LOCKING:
3088 *	spin_lock_irqsave(host lock)
3089 *
3090 *	RETURNS:
3091 *	Associated ATA device, or %NULL if not found.
3092 */
3093struct ata_device *
3094ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
3095{
3096	struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
3097
3098	if (!ata_adapter_is_online(ap))
3099		return NULL;
3100
3101	if (unlikely(!dev || !ata_dev_enabled(dev)))
3102		return NULL;
3103
3104	return dev;
3105}
3106
3107/*
3108 *	ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
3109 *	@byte1: Byte 1 from pass-thru CDB.
3110 *
3111 *	RETURNS:
3112 *	ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
3113 */
3114static u8
3115ata_scsi_map_proto(u8 byte1)
3116{
3117	switch((byte1 & 0x1e) >> 1) {
3118	case 3:		/* Non-data */
3119		return ATA_PROT_NODATA;
3120
3121	case 6:		/* DMA */
3122	case 10:	/* UDMA Data-in */
3123	case 11:	/* UDMA Data-Out */
3124		return ATA_PROT_DMA;
3125
3126	case 4:		/* PIO Data-in */
3127	case 5:		/* PIO Data-out */
3128		return ATA_PROT_PIO;
3129
3130	case 12:	/* FPDMA */
3131		return ATA_PROT_NCQ;
3132
3133	case 0:		/* Hard Reset */
3134	case 1:		/* SRST */
3135	case 8:		/* Device Diagnostic */
3136	case 9:		/* Device Reset */
3137	case 7:		/* DMA Queued */
3138	case 15:	/* Return Response Info */
3139	default:	/* Reserved */
3140		break;
3141	}
3142
3143	return ATA_PROT_UNKNOWN;
3144}
3145
3146/**
3147 *	ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
3148 *	@qc: command structure to be initialized
3149 *
3150 *	Handles either 12, 16, or 32-byte versions of the CDB.
3151 *
3152 *	RETURNS:
3153 *	Zero on success, non-zero on failure.
3154 */
3155static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
3156{
3157	struct ata_taskfile *tf = &(qc->tf);
3158	struct scsi_cmnd *scmd = qc->scsicmd;
3159	struct ata_device *dev = qc->dev;
3160	const u8 *cdb = scmd->cmnd;
3161	u16 fp;
3162	u16 cdb_offset = 0;
3163
3164	/* 7Fh variable length cmd means a ata pass-thru(32) */
3165	if (cdb[0] == VARIABLE_LENGTH_CMD)
3166		cdb_offset = 9;
3167
3168	tf->protocol = ata_scsi_map_proto(cdb[1 + cdb_offset]);
3169	if (tf->protocol == ATA_PROT_UNKNOWN) {
3170		fp = 1;
3171		goto invalid_fld;
3172	}
3173
3174	if ((cdb[2 + cdb_offset] & 0x3) == 0) {
3175		/*
3176		 * When T_LENGTH is zero (No data is transferred), dir should
3177		 * be DMA_NONE.
3178		 */
3179		if (scmd->sc_data_direction != DMA_NONE) {
3180			fp = 2 + cdb_offset;
3181			goto invalid_fld;
3182		}
3183
3184		if (ata_is_ncq(tf->protocol))
3185			tf->protocol = ATA_PROT_NCQ_NODATA;
3186	}
3187
3188	/* enable LBA */
3189	tf->flags |= ATA_TFLAG_LBA;
3190
3191	/*
3192	 * 12 and 16 byte CDBs use different offsets to
3193	 * provide the various register values.
3194	 */
3195	switch (cdb[0]) {
3196	case ATA_16:
3197		/*
3198		 * 16-byte CDB - may contain extended commands.
3199		 *
3200		 * If that is the case, copy the upper byte register values.
3201		 */
3202		if (cdb[1] & 0x01) {
3203			tf->hob_feature = cdb[3];
3204			tf->hob_nsect = cdb[5];
3205			tf->hob_lbal = cdb[7];
3206			tf->hob_lbam = cdb[9];
3207			tf->hob_lbah = cdb[11];
3208			tf->flags |= ATA_TFLAG_LBA48;
3209		} else
3210			tf->flags &= ~ATA_TFLAG_LBA48;
3211
3212		/*
3213		 * Always copy low byte, device and command registers.
3214		 */
3215		tf->feature = cdb[4];
3216		tf->nsect = cdb[6];
3217		tf->lbal = cdb[8];
3218		tf->lbam = cdb[10];
3219		tf->lbah = cdb[12];
3220		tf->device = cdb[13];
3221		tf->command = cdb[14];
3222		break;
3223	case ATA_12:
3224		/*
3225		 * 12-byte CDB - incapable of extended commands.
3226		 */
3227		tf->flags &= ~ATA_TFLAG_LBA48;
3228
3229		tf->feature = cdb[3];
3230		tf->nsect = cdb[4];
3231		tf->lbal = cdb[5];
3232		tf->lbam = cdb[6];
3233		tf->lbah = cdb[7];
3234		tf->device = cdb[8];
3235		tf->command = cdb[9];
3236		break;
3237	default:
3238		/*
3239		 * 32-byte CDB - may contain extended command fields.
3240		 *
3241		 * If that is the case, copy the upper byte register values.
3242		 */
3243		if (cdb[10] & 0x01) {
3244			tf->hob_feature = cdb[20];
3245			tf->hob_nsect = cdb[22];
3246			tf->hob_lbal = cdb[16];
3247			tf->hob_lbam = cdb[15];
3248			tf->hob_lbah = cdb[14];
3249			tf->flags |= ATA_TFLAG_LBA48;
3250		} else
3251			tf->flags &= ~ATA_TFLAG_LBA48;
3252
3253		tf->feature = cdb[21];
3254		tf->nsect = cdb[23];
3255		tf->lbal = cdb[19];
3256		tf->lbam = cdb[18];
3257		tf->lbah = cdb[17];
3258		tf->device = cdb[24];
3259		tf->command = cdb[25];
3260		tf->auxiliary = get_unaligned_be32(&cdb[28]);
3261		break;
3262	}
3263
3264	/* For NCQ commands copy the tag value */
3265	if (ata_is_ncq(tf->protocol))
3266		tf->nsect = qc->hw_tag << 3;
3267
3268	/* enforce correct master/slave bit */
3269	tf->device = dev->devno ?
3270		tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
3271
3272	switch (tf->command) {
3273	/* READ/WRITE LONG use a non-standard sect_size */
3274	case ATA_CMD_READ_LONG:
3275	case ATA_CMD_READ_LONG_ONCE:
3276	case ATA_CMD_WRITE_LONG:
3277	case ATA_CMD_WRITE_LONG_ONCE:
3278		if (tf->protocol != ATA_PROT_PIO || tf->nsect != 1) {
3279			fp = 1;
3280			goto invalid_fld;
3281		}
3282		qc->sect_size = scsi_bufflen(scmd);
3283		break;
3284
3285	/* commands using reported Logical Block size (e.g. 512 or 4K) */
3286	case ATA_CMD_CFA_WRITE_NE:
3287	case ATA_CMD_CFA_TRANS_SECT:
3288	case ATA_CMD_CFA_WRITE_MULT_NE:
3289	/* XXX: case ATA_CMD_CFA_WRITE_SECTORS_WITHOUT_ERASE: */
3290	case ATA_CMD_READ:
3291	case ATA_CMD_READ_EXT:
3292	case ATA_CMD_READ_QUEUED:
3293	/* XXX: case ATA_CMD_READ_QUEUED_EXT: */
3294	case ATA_CMD_FPDMA_READ:
3295	case ATA_CMD_READ_MULTI:
3296	case ATA_CMD_READ_MULTI_EXT:
3297	case ATA_CMD_PIO_READ:
3298	case ATA_CMD_PIO_READ_EXT:
3299	case ATA_CMD_READ_STREAM_DMA_EXT:
3300	case ATA_CMD_READ_STREAM_EXT:
3301	case ATA_CMD_VERIFY:
3302	case ATA_CMD_VERIFY_EXT:
3303	case ATA_CMD_WRITE:
3304	case ATA_CMD_WRITE_EXT:
3305	case ATA_CMD_WRITE_FUA_EXT:
3306	case ATA_CMD_WRITE_QUEUED:
3307	case ATA_CMD_WRITE_QUEUED_FUA_EXT:
3308	case ATA_CMD_FPDMA_WRITE:
3309	case ATA_CMD_WRITE_MULTI:
3310	case ATA_CMD_WRITE_MULTI_EXT:
3311	case ATA_CMD_WRITE_MULTI_FUA_EXT:
3312	case ATA_CMD_PIO_WRITE:
3313	case ATA_CMD_PIO_WRITE_EXT:
3314	case ATA_CMD_WRITE_STREAM_DMA_EXT:
3315	case ATA_CMD_WRITE_STREAM_EXT:
3316		qc->sect_size = scmd->device->sector_size;
3317		break;
3318
3319	/* Everything else uses 512 byte "sectors" */
3320	default:
3321		qc->sect_size = ATA_SECT_SIZE;
3322	}
3323
3324	/*
3325	 * Set flags so that all registers will be written, pass on
3326	 * write indication (used for PIO/DMA setup), result TF is
3327	 * copied back and we don't whine too much about its failure.
3328	 */
3329	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
3330	if (scmd->sc_data_direction == DMA_TO_DEVICE)
3331		tf->flags |= ATA_TFLAG_WRITE;
3332
3333	qc->flags |= ATA_QCFLAG_RESULT_TF | ATA_QCFLAG_QUIET;
3334
3335	/*
3336	 * Set transfer length.
3337	 *
3338	 * TODO: find out if we need to do more here to
3339	 *       cover scatter/gather case.
3340	 */
3341	ata_qc_set_pc_nbytes(qc);
3342
3343	/* We may not issue DMA commands if no DMA mode is set */
3344	if (tf->protocol == ATA_PROT_DMA && !ata_dma_enabled(dev)) {
3345		fp = 1;
3346		goto invalid_fld;
3347	}
3348
3349	/* We may not issue NCQ commands to devices not supporting NCQ */
3350	if (ata_is_ncq(tf->protocol) && !ata_ncq_enabled(dev)) {
3351		fp = 1;
3352		goto invalid_fld;
3353	}
3354
3355	/* sanity check for pio multi commands */
3356	if ((cdb[1] & 0xe0) && !is_multi_taskfile(tf)) {
3357		fp = 1;
3358		goto invalid_fld;
3359	}
3360
3361	if (is_multi_taskfile(tf)) {
3362		unsigned int multi_count = 1 << (cdb[1] >> 5);
3363
3364		/* compare the passed through multi_count
3365		 * with the cached multi_count of libata
3366		 */
3367		if (multi_count != dev->multi_count)
3368			ata_dev_warn(dev, "invalid multi_count %u ignored\n",
3369				     multi_count);
3370	}
3371
3372	/*
3373	 * Filter SET_FEATURES - XFER MODE command -- otherwise,
3374	 * SET_FEATURES - XFER MODE must be preceded/succeeded
3375	 * by an update to hardware-specific registers for each
3376	 * controller (i.e. the reason for ->set_piomode(),
3377	 * ->set_dmamode(), and ->post_set_mode() hooks).
3378	 */
3379	if (tf->command == ATA_CMD_SET_FEATURES &&
3380	    tf->feature == SETFEATURES_XFER) {
3381		fp = (cdb[0] == ATA_16) ? 4 : 3;
3382		goto invalid_fld;
3383	}
3384
3385	/*
3386	 * Filter TPM commands by default. These provide an
3387	 * essentially uncontrolled encrypted "back door" between
3388	 * applications and the disk. Set libata.allow_tpm=1 if you
3389	 * have a real reason for wanting to use them. This ensures
3390	 * that installed software cannot easily mess stuff up without
3391	 * user intent. DVR type users will probably ship with this enabled
3392	 * for movie content management.
3393	 *
3394	 * Note that for ATA8 we can issue a DCS change and DCS freeze lock
3395	 * for this and should do in future but that it is not sufficient as
3396	 * DCS is an optional feature set. Thus we also do the software filter
3397	 * so that we comply with the TC consortium stated goal that the user
3398	 * can turn off TC features of their system.
3399	 */
3400	if (tf->command >= 0x5C && tf->command <= 0x5F && !libata_allow_tpm) {
3401		fp = (cdb[0] == ATA_16) ? 14 : 9;
3402		goto invalid_fld;
3403	}
3404
3405	return 0;
3406
3407 invalid_fld:
3408	ata_scsi_set_invalid_field(dev, scmd, fp, 0xff);
3409	return 1;
3410}
3411
3412/**
3413 * ata_format_dsm_trim_descr() - SATL Write Same to DSM Trim
3414 * @cmd: SCSI command being translated
3415 * @trmax: Maximum number of entries that will fit in sector_size bytes.
3416 * @sector: Starting sector
3417 * @count: Total Range of request in logical sectors
3418 *
3419 * Rewrite the WRITE SAME descriptor to be a DSM TRIM little-endian formatted
3420 * descriptor.
3421 *
3422 * Upto 64 entries of the format:
3423 *   63:48 Range Length
3424 *   47:0  LBA
3425 *
3426 *  Range Length of 0 is ignored.
3427 *  LBA's should be sorted order and not overlap.
3428 *
3429 * NOTE: this is the same format as ADD LBA(S) TO NV CACHE PINNED SET
3430 *
3431 * Return: Number of bytes copied into sglist.
3432 */
3433static size_t ata_format_dsm_trim_descr(struct scsi_cmnd *cmd, u32 trmax,
3434					u64 sector, u32 count)
3435{
3436	struct scsi_device *sdp = cmd->device;
3437	size_t len = sdp->sector_size;
3438	size_t r;
3439	__le64 *buf;
3440	u32 i = 0;
3441	unsigned long flags;
3442
3443	WARN_ON(len > ATA_SCSI_RBUF_SIZE);
3444
3445	if (len > ATA_SCSI_RBUF_SIZE)
3446		len = ATA_SCSI_RBUF_SIZE;
3447
3448	spin_lock_irqsave(&ata_scsi_rbuf_lock, flags);
3449	buf = ((void *)ata_scsi_rbuf);
3450	memset(buf, 0, len);
3451	while (i < trmax) {
3452		u64 entry = sector |
3453			((u64)(count > 0xffff ? 0xffff : count) << 48);
3454		buf[i++] = __cpu_to_le64(entry);
3455		if (count <= 0xffff)
3456			break;
3457		count -= 0xffff;
3458		sector += 0xffff;
3459	}
3460	r = sg_copy_from_buffer(scsi_sglist(cmd), scsi_sg_count(cmd), buf, len);
3461	spin_unlock_irqrestore(&ata_scsi_rbuf_lock, flags);
3462
3463	return r;
3464}
3465
3466/**
3467 * ata_scsi_write_same_xlat() - SATL Write Same to ATA SCT Write Same
3468 * @qc: Command to be translated
3469 *
3470 * Translate a SCSI WRITE SAME command to be either a DSM TRIM command or
3471 * an SCT Write Same command.
3472 * Based on WRITE SAME has the UNMAP flag:
3473 *
3474 *   - When set translate to DSM TRIM
3475 *   - When clear translate to SCT Write Same
3476 */
3477static unsigned int ata_scsi_write_same_xlat(struct ata_queued_cmd *qc)
3478{
3479	struct ata_taskfile *tf = &qc->tf;
3480	struct scsi_cmnd *scmd = qc->scsicmd;
3481	struct scsi_device *sdp = scmd->device;
3482	size_t len = sdp->sector_size;
3483	struct ata_device *dev = qc->dev;
3484	const u8 *cdb = scmd->cmnd;
3485	u64 block;
3486	u32 n_block;
3487	const u32 trmax = len >> 3;
3488	u32 size;
3489	u16 fp;
3490	u8 bp = 0xff;
3491	u8 unmap = cdb[1] & 0x8;
3492
3493	/* we may not issue DMA commands if no DMA mode is set */
3494	if (unlikely(!ata_dma_enabled(dev)))
3495		goto invalid_opcode;
3496
3497	/*
3498	 * We only allow sending this command through the block layer,
3499	 * as it modifies the DATA OUT buffer, which would corrupt user
3500	 * memory for SG_IO commands.
3501	 */
3502	if (unlikely(blk_rq_is_passthrough(scsi_cmd_to_rq(scmd))))
3503		goto invalid_opcode;
3504
3505	if (unlikely(scmd->cmd_len < 16)) {
3506		fp = 15;
3507		goto invalid_fld;
3508	}
3509	scsi_16_lba_len(cdb, &block, &n_block);
3510
3511	if (!unmap || (dev->quirks & ATA_QUIRK_NOTRIM) ||
3512	    !ata_id_has_trim(dev->id)) {
3513		fp = 1;
3514		bp = 3;
3515		goto invalid_fld;
3516	}
3517	/* If the request is too large the cmd is invalid */
3518	if (n_block > 0xffff * trmax) {
3519		fp = 2;
3520		goto invalid_fld;
3521	}
3522
3523	/*
3524	 * WRITE SAME always has a sector sized buffer as payload, this
3525	 * should never be a multiple entry S/G list.
3526	 */
3527	if (!scsi_sg_count(scmd))
3528		goto invalid_param_len;
3529
3530	/*
3531	 * size must match sector size in bytes
3532	 * For DATA SET MANAGEMENT TRIM in ACS-2 nsect (aka count)
3533	 * is defined as number of 512 byte blocks to be transferred.
3534	 */
3535
3536	size = ata_format_dsm_trim_descr(scmd, trmax, block, n_block);
3537	if (size != len)
3538		goto invalid_param_len;
3539
3540	if (ata_ncq_enabled(dev) && ata_fpdma_dsm_supported(dev)) {
3541		/* Newer devices support queued TRIM commands */
3542		tf->protocol = ATA_PROT_NCQ;
3543		tf->command = ATA_CMD_FPDMA_SEND;
3544		tf->hob_nsect = ATA_SUBCMD_FPDMA_SEND_DSM & 0x1f;
3545		tf->nsect = qc->hw_tag << 3;
3546		tf->hob_feature = (size / 512) >> 8;
3547		tf->feature = size / 512;
3548
3549		tf->auxiliary = 1;
3550	} else {
3551		tf->protocol = ATA_PROT_DMA;
3552		tf->hob_feature = 0;
3553		tf->feature = ATA_DSM_TRIM;
3554		tf->hob_nsect = (size / 512) >> 8;
3555		tf->nsect = size / 512;
3556		tf->command = ATA_CMD_DSM;
3557	}
3558
3559	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48 |
3560		     ATA_TFLAG_WRITE;
3561
3562	ata_qc_set_pc_nbytes(qc);
3563
3564	return 0;
3565
3566invalid_fld:
3567	ata_scsi_set_invalid_field(dev, scmd, fp, bp);
3568	return 1;
3569invalid_param_len:
3570	/* "Parameter list length error" */
3571	ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3572	return 1;
3573invalid_opcode:
3574	/* "Invalid command operation code" */
3575	ata_scsi_set_sense(dev, scmd, ILLEGAL_REQUEST, 0x20, 0x0);
3576	return 1;
3577}
3578
3579/**
3580 *	ata_scsiop_maint_in - Simulate a subset of MAINTENANCE_IN
3581 *	@dev: Target device.
3582 *	@cmd: SCSI command of interest.
3583 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
3584 *
3585 *	Yields a subset to satisfy scsi_report_opcode()
3586 *
3587 *	LOCKING:
3588 *	spin_lock_irqsave(host lock)
3589 */
3590static unsigned int ata_scsiop_maint_in(struct ata_device *dev,
3591					struct scsi_cmnd *cmd, u8 *rbuf)
3592{
3593	u8 *cdb = cmd->cmnd;
3594	u8 supported = 0, cdlp = 0, rwcdlp = 0;
3595
3596	if ((cdb[1] & 0x1f) != MI_REPORT_SUPPORTED_OPERATION_CODES) {
3597		ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
3598		return 0;
3599	}
3600
3601	if (cdb[2] != 1 && cdb[2] != 3) {
3602		ata_dev_warn(dev, "invalid command format %d\n", cdb[2]);
3603		ata_scsi_set_invalid_field(dev, cmd, 2, 0xff);
3604		return 0;
3605	}
3606
3607	switch (cdb[3]) {
3608	case INQUIRY:
3609	case MODE_SENSE:
3610	case MODE_SENSE_10:
3611	case READ_CAPACITY:
3612	case SERVICE_ACTION_IN_16:
3613	case REPORT_LUNS:
3614	case REQUEST_SENSE:
3615	case SYNCHRONIZE_CACHE:
3616	case SYNCHRONIZE_CACHE_16:
3617	case REZERO_UNIT:
3618	case SEEK_6:
3619	case SEEK_10:
3620	case TEST_UNIT_READY:
3621	case SEND_DIAGNOSTIC:
3622	case MAINTENANCE_IN:
3623	case READ_6:
3624	case READ_10:
3625	case WRITE_6:
3626	case WRITE_10:
3627	case ATA_12:
3628	case ATA_16:
3629	case VERIFY:
3630	case VERIFY_16:
3631	case MODE_SELECT:
3632	case MODE_SELECT_10:
3633	case START_STOP:
3634		supported = 3;
3635		break;
3636	case READ_16:
3637		supported = 3;
3638		if (dev->flags & ATA_DFLAG_CDL) {
3639			/*
3640			 * CDL read descriptors map to the T2A page, that is,
3641			 * rwcdlp = 0x01 and cdlp = 0x01
3642			 */
3643			rwcdlp = 0x01;
3644			cdlp = 0x01 << 3;
3645		}
3646		break;
3647	case WRITE_16:
3648		supported = 3;
3649		if (dev->flags & ATA_DFLAG_CDL) {
3650			/*
3651			 * CDL write descriptors map to the T2B page, that is,
3652			 * rwcdlp = 0x01 and cdlp = 0x02
3653			 */
3654			rwcdlp = 0x01;
3655			cdlp = 0x02 << 3;
3656		}
3657		break;
3658	case ZBC_IN:
3659	case ZBC_OUT:
3660		if (ata_id_zoned_cap(dev->id) ||
3661		    dev->class == ATA_DEV_ZAC)
3662			supported = 3;
3663		break;
3664	case SECURITY_PROTOCOL_IN:
3665	case SECURITY_PROTOCOL_OUT:
3666		if (dev->flags & ATA_DFLAG_TRUSTED)
3667			supported = 3;
3668		break;
3669	default:
3670		break;
3671	}
3672
3673	/* One command format */
3674	rbuf[0] = rwcdlp;
3675	rbuf[1] = cdlp | supported;
3676
3677	return 4;
3678}
3679
3680/**
3681 *	ata_scsi_report_zones_complete - convert ATA output
3682 *	@qc: command structure returning the data
3683 *
3684 *	Convert T-13 little-endian field representation into
3685 *	T-10 big-endian field representation.
3686 *	What a mess.
3687 */
3688static void ata_scsi_report_zones_complete(struct ata_queued_cmd *qc)
3689{
3690	struct scsi_cmnd *scmd = qc->scsicmd;
3691	struct sg_mapping_iter miter;
3692	unsigned long flags;
3693	unsigned int bytes = 0;
3694
3695	sg_miter_start(&miter, scsi_sglist(scmd), scsi_sg_count(scmd),
3696		       SG_MITER_TO_SG | SG_MITER_ATOMIC);
3697
3698	local_irq_save(flags);
3699	while (sg_miter_next(&miter)) {
3700		unsigned int offset = 0;
3701
3702		if (bytes == 0) {
3703			char *hdr;
3704			u32 list_length;
3705			u64 max_lba, opt_lba;
3706			u16 same;
3707
3708			/* Swizzle header */
3709			hdr = miter.addr;
3710			list_length = get_unaligned_le32(&hdr[0]);
3711			same = get_unaligned_le16(&hdr[4]);
3712			max_lba = get_unaligned_le64(&hdr[8]);
3713			opt_lba = get_unaligned_le64(&hdr[16]);
3714			put_unaligned_be32(list_length, &hdr[0]);
3715			hdr[4] = same & 0xf;
3716			put_unaligned_be64(max_lba, &hdr[8]);
3717			put_unaligned_be64(opt_lba, &hdr[16]);
3718			offset += 64;
3719			bytes += 64;
3720		}
3721		while (offset < miter.length) {
3722			char *rec;
3723			u8 cond, type, non_seq, reset;
3724			u64 size, start, wp;
3725
3726			/* Swizzle zone descriptor */
3727			rec = miter.addr + offset;
3728			type = rec[0] & 0xf;
3729			cond = (rec[1] >> 4) & 0xf;
3730			non_seq = (rec[1] & 2);
3731			reset = (rec[1] & 1);
3732			size = get_unaligned_le64(&rec[8]);
3733			start = get_unaligned_le64(&rec[16]);
3734			wp = get_unaligned_le64(&rec[24]);
3735			rec[0] = type;
3736			rec[1] = (cond << 4) | non_seq | reset;
3737			put_unaligned_be64(size, &rec[8]);
3738			put_unaligned_be64(start, &rec[16]);
3739			put_unaligned_be64(wp, &rec[24]);
3740			WARN_ON(offset + 64 > miter.length);
3741			offset += 64;
3742			bytes += 64;
3743		}
3744	}
3745	sg_miter_stop(&miter);
3746	local_irq_restore(flags);
3747
3748	ata_scsi_qc_complete(qc);
3749}
3750
3751static unsigned int ata_scsi_zbc_in_xlat(struct ata_queued_cmd *qc)
3752{
3753	struct ata_taskfile *tf = &qc->tf;
3754	struct scsi_cmnd *scmd = qc->scsicmd;
3755	const u8 *cdb = scmd->cmnd;
3756	u16 sect, fp = (u16)-1;
3757	u8 sa, options, bp = 0xff;
3758	u64 block;
3759	u32 n_block;
3760
3761	if (unlikely(scmd->cmd_len < 16)) {
3762		ata_dev_warn(qc->dev, "invalid cdb length %d\n",
3763			     scmd->cmd_len);
3764		fp = 15;
3765		goto invalid_fld;
3766	}
3767	scsi_16_lba_len(cdb, &block, &n_block);
3768	if (n_block != scsi_bufflen(scmd)) {
3769		ata_dev_warn(qc->dev, "non-matching transfer count (%d/%d)\n",
3770			     n_block, scsi_bufflen(scmd));
3771		goto invalid_param_len;
3772	}
3773	sa = cdb[1] & 0x1f;
3774	if (sa != ZI_REPORT_ZONES) {
3775		ata_dev_warn(qc->dev, "invalid service action %d\n", sa);
3776		fp = 1;
3777		goto invalid_fld;
3778	}
3779	/*
3780	 * ZAC allows only for transfers in 512 byte blocks,
3781	 * and uses a 16 bit value for the transfer count.
3782	 */
3783	if ((n_block / 512) > 0xffff || n_block < 512 || (n_block % 512)) {
3784		ata_dev_warn(qc->dev, "invalid transfer count %d\n", n_block);
3785		goto invalid_param_len;
3786	}
3787	sect = n_block / 512;
3788	options = cdb[14] & 0xbf;
3789
3790	if (ata_ncq_enabled(qc->dev) &&
3791	    ata_fpdma_zac_mgmt_in_supported(qc->dev)) {
3792		tf->protocol = ATA_PROT_NCQ;
3793		tf->command = ATA_CMD_FPDMA_RECV;
3794		tf->hob_nsect = ATA_SUBCMD_FPDMA_RECV_ZAC_MGMT_IN & 0x1f;
3795		tf->nsect = qc->hw_tag << 3;
3796		tf->feature = sect & 0xff;
3797		tf->hob_feature = (sect >> 8) & 0xff;
3798		tf->auxiliary = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES | (options << 8);
3799	} else {
3800		tf->command = ATA_CMD_ZAC_MGMT_IN;
3801		tf->feature = ATA_SUBCMD_ZAC_MGMT_IN_REPORT_ZONES;
3802		tf->protocol = ATA_PROT_DMA;
3803		tf->hob_feature = options;
3804		tf->hob_nsect = (sect >> 8) & 0xff;
3805		tf->nsect = sect & 0xff;
3806	}
3807	tf->device = ATA_LBA;
3808	tf->lbah = (block >> 16) & 0xff;
3809	tf->lbam = (block >> 8) & 0xff;
3810	tf->lbal = block & 0xff;
3811	tf->hob_lbah = (block >> 40) & 0xff;
3812	tf->hob_lbam = (block >> 32) & 0xff;
3813	tf->hob_lbal = (block >> 24) & 0xff;
3814
3815	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3816	qc->flags |= ATA_QCFLAG_RESULT_TF;
3817
3818	ata_qc_set_pc_nbytes(qc);
3819
3820	qc->complete_fn = ata_scsi_report_zones_complete;
3821
3822	return 0;
3823
3824invalid_fld:
3825	ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
3826	return 1;
3827
3828invalid_param_len:
3829	/* "Parameter list length error" */
3830	ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3831	return 1;
3832}
3833
3834static unsigned int ata_scsi_zbc_out_xlat(struct ata_queued_cmd *qc)
3835{
3836	struct ata_taskfile *tf = &qc->tf;
3837	struct scsi_cmnd *scmd = qc->scsicmd;
3838	struct ata_device *dev = qc->dev;
3839	const u8 *cdb = scmd->cmnd;
3840	u8 all, sa;
3841	u64 block;
3842	u32 n_block;
3843	u16 fp = (u16)-1;
3844
3845	if (unlikely(scmd->cmd_len < 16)) {
3846		fp = 15;
3847		goto invalid_fld;
3848	}
3849
3850	sa = cdb[1] & 0x1f;
3851	if ((sa != ZO_CLOSE_ZONE) && (sa != ZO_FINISH_ZONE) &&
3852	    (sa != ZO_OPEN_ZONE) && (sa != ZO_RESET_WRITE_POINTER)) {
3853		fp = 1;
3854		goto invalid_fld;
3855	}
3856
3857	scsi_16_lba_len(cdb, &block, &n_block);
3858	if (n_block) {
3859		/*
3860		 * ZAC MANAGEMENT OUT doesn't define any length
3861		 */
3862		goto invalid_param_len;
3863	}
3864
3865	all = cdb[14] & 0x1;
3866	if (all) {
3867		/*
3868		 * Ignore the block address (zone ID) as defined by ZBC.
3869		 */
3870		block = 0;
3871	} else if (block >= dev->n_sectors) {
3872		/*
3873		 * Block must be a valid zone ID (a zone start LBA).
3874		 */
3875		fp = 2;
3876		goto invalid_fld;
3877	}
3878
3879	if (ata_ncq_enabled(qc->dev) &&
3880	    ata_fpdma_zac_mgmt_out_supported(qc->dev)) {
3881		tf->protocol = ATA_PROT_NCQ_NODATA;
3882		tf->command = ATA_CMD_NCQ_NON_DATA;
3883		tf->feature = ATA_SUBCMD_NCQ_NON_DATA_ZAC_MGMT_OUT;
3884		tf->nsect = qc->hw_tag << 3;
3885		tf->auxiliary = sa | ((u16)all << 8);
3886	} else {
3887		tf->protocol = ATA_PROT_NODATA;
3888		tf->command = ATA_CMD_ZAC_MGMT_OUT;
3889		tf->feature = sa;
3890		tf->hob_feature = all;
3891	}
3892	tf->lbah = (block >> 16) & 0xff;
3893	tf->lbam = (block >> 8) & 0xff;
3894	tf->lbal = block & 0xff;
3895	tf->hob_lbah = (block >> 40) & 0xff;
3896	tf->hob_lbam = (block >> 32) & 0xff;
3897	tf->hob_lbal = (block >> 24) & 0xff;
3898	tf->device = ATA_LBA;
3899	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
3900
3901	return 0;
3902
3903 invalid_fld:
3904	ata_scsi_set_invalid_field(qc->dev, scmd, fp, 0xff);
3905	return 1;
3906invalid_param_len:
3907	/* "Parameter list length error" */
3908	ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
3909	return 1;
3910}
3911
3912/**
3913 *	ata_mselect_caching - Simulate MODE SELECT for caching info page
3914 *	@qc: Storage for translated ATA taskfile
3915 *	@buf: input buffer
3916 *	@len: number of valid bytes in the input buffer
3917 *	@fp: out parameter for the failed field on error
3918 *
3919 *	Prepare a taskfile to modify caching information for the device.
3920 *
3921 *	LOCKING:
3922 *	None.
3923 */
3924static int ata_mselect_caching(struct ata_queued_cmd *qc,
3925			       const u8 *buf, int len, u16 *fp)
3926{
3927	struct ata_taskfile *tf = &qc->tf;
3928	struct ata_device *dev = qc->dev;
3929	u8 mpage[CACHE_MPAGE_LEN];
3930	u8 wce;
3931	int i;
3932
3933	/*
3934	 * The first two bytes of def_cache_mpage are a header, so offsets
3935	 * in mpage are off by 2 compared to buf.  Same for len.
3936	 */
3937
3938	if (len != CACHE_MPAGE_LEN - 2) {
3939		*fp = min(len, CACHE_MPAGE_LEN - 2);
3940		return -EINVAL;
3941	}
3942
3943	wce = buf[0] & (1 << 2);
3944
3945	/*
3946	 * Check that read-only bits are not modified.
3947	 */
3948	ata_msense_caching(dev->id, mpage, false);
3949	for (i = 0; i < CACHE_MPAGE_LEN - 2; i++) {
3950		if (i == 0)
3951			continue;
3952		if (mpage[i + 2] != buf[i]) {
3953			*fp = i;
3954			return -EINVAL;
3955		}
3956	}
3957
3958	tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
3959	tf->protocol = ATA_PROT_NODATA;
3960	tf->nsect = 0;
3961	tf->command = ATA_CMD_SET_FEATURES;
3962	tf->feature = wce ? SETFEATURES_WC_ON : SETFEATURES_WC_OFF;
3963	return 0;
3964}
3965
3966/*
3967 * Simulate MODE SELECT control mode page, sub-page 0.
3968 */
3969static int ata_mselect_control_spg0(struct ata_queued_cmd *qc,
3970				    const u8 *buf, int len, u16 *fp)
3971{
3972	struct ata_device *dev = qc->dev;
3973	u8 mpage[CONTROL_MPAGE_LEN];
3974	u8 d_sense;
3975	int i;
3976
3977	/*
3978	 * The first two bytes of def_control_mpage are a header, so offsets
3979	 * in mpage are off by 2 compared to buf.  Same for len.
3980	 */
3981
3982	if (len != CONTROL_MPAGE_LEN - 2) {
3983		*fp = min(len, CONTROL_MPAGE_LEN - 2);
3984		return -EINVAL;
3985	}
3986
3987	d_sense = buf[0] & (1 << 2);
3988
3989	/*
3990	 * Check that read-only bits are not modified.
3991	 */
3992	ata_msense_control_spg0(dev, mpage, false);
3993	for (i = 0; i < CONTROL_MPAGE_LEN - 2; i++) {
3994		if (i == 0)
3995			continue;
3996		if (mpage[2 + i] != buf[i]) {
3997			*fp = i;
3998			return -EINVAL;
3999		}
4000	}
4001	if (d_sense & (1 << 2))
4002		dev->flags |= ATA_DFLAG_D_SENSE;
4003	else
4004		dev->flags &= ~ATA_DFLAG_D_SENSE;
4005	return 0;
4006}
4007
4008/*
4009 * Translate MODE SELECT control mode page, sub-page f2h (ATA feature mode
4010 * page) into a SET FEATURES command.
4011 */
4012static int ata_mselect_control_ata_feature(struct ata_queued_cmd *qc,
4013					   const u8 *buf, int len, u16 *fp)
4014{
4015	struct ata_device *dev = qc->dev;
4016	struct ata_taskfile *tf = &qc->tf;
4017	u8 cdl_action;
4018
4019	/*
4020	 * The first four bytes of ATA Feature Control mode page are a header,
4021	 * so offsets in mpage are off by 4 compared to buf.  Same for len.
4022	 */
4023	if (len != ATA_FEATURE_SUB_MPAGE_LEN - 4) {
4024		*fp = min(len, ATA_FEATURE_SUB_MPAGE_LEN - 4);
4025		return -EINVAL;
4026	}
4027
4028	/* Check cdl_ctrl */
4029	switch (buf[0] & 0x03) {
4030	case 0:
4031		/* Disable CDL */
4032		ata_dev_dbg(dev, "Disabling CDL\n");
4033		cdl_action = 0;
4034		dev->flags &= ~ATA_DFLAG_CDL_ENABLED;
4035		break;
4036	case 0x02:
4037		/*
4038		 * Enable CDL. Since CDL is mutually exclusive with NCQ
4039		 * priority, allow this only if NCQ priority is disabled.
4040		 */
4041		if (dev->flags & ATA_DFLAG_NCQ_PRIO_ENABLED) {
4042			ata_dev_err(dev,
4043				"NCQ priority must be disabled to enable CDL\n");
4044			return -EINVAL;
4045		}
4046		ata_dev_dbg(dev, "Enabling CDL\n");
4047		cdl_action = 1;
4048		dev->flags |= ATA_DFLAG_CDL_ENABLED;
4049		break;
4050	default:
4051		*fp = 0;
4052		return -EINVAL;
4053	}
4054
4055	tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
4056	tf->protocol = ATA_PROT_NODATA;
4057	tf->command = ATA_CMD_SET_FEATURES;
4058	tf->feature = SETFEATURES_CDL;
4059	tf->nsect = cdl_action;
4060
4061	return 1;
4062}
4063
4064/**
4065 *	ata_mselect_control - Simulate MODE SELECT for control page
4066 *	@qc: Storage for translated ATA taskfile
4067 *	@spg: target sub-page of the control page
4068 *	@buf: input buffer
4069 *	@len: number of valid bytes in the input buffer
4070 *	@fp: out parameter for the failed field on error
4071 *
4072 *	Prepare a taskfile to modify caching information for the device.
4073 *
4074 *	LOCKING:
4075 *	None.
4076 */
4077static int ata_mselect_control(struct ata_queued_cmd *qc, u8 spg,
4078			       const u8 *buf, int len, u16 *fp)
4079{
4080	switch (spg) {
4081	case 0:
4082		return ata_mselect_control_spg0(qc, buf, len, fp);
4083	case ATA_FEATURE_SUB_MPAGE:
4084		return ata_mselect_control_ata_feature(qc, buf, len, fp);
4085	default:
4086		return -EINVAL;
4087	}
4088}
4089
4090/**
4091 *	ata_scsi_mode_select_xlat - Simulate MODE SELECT 6, 10 commands
4092 *	@qc: Storage for translated ATA taskfile
4093 *
4094 *	Converts a MODE SELECT command to an ATA SET FEATURES taskfile.
4095 *	Assume this is invoked for direct access devices (e.g. disks) only.
4096 *	There should be no block descriptor for other device types.
4097 *
4098 *	LOCKING:
4099 *	spin_lock_irqsave(host lock)
4100 */
4101static unsigned int ata_scsi_mode_select_xlat(struct ata_queued_cmd *qc)
4102{
4103	struct scsi_cmnd *scmd = qc->scsicmd;
4104	const u8 *cdb = scmd->cmnd;
4105	u8 pg, spg;
4106	unsigned six_byte, pg_len, hdr_len, bd_len;
4107	int len, ret;
4108	u16 fp = (u16)-1;
4109	u8 bp = 0xff;
4110	u8 buffer[64];
4111	const u8 *p = buffer;
4112
4113	six_byte = (cdb[0] == MODE_SELECT);
4114	if (six_byte) {
4115		if (scmd->cmd_len < 5) {
4116			fp = 4;
4117			goto invalid_fld;
4118		}
4119
4120		len = cdb[4];
4121		hdr_len = 4;
4122	} else {
4123		if (scmd->cmd_len < 9) {
4124			fp = 8;
4125			goto invalid_fld;
4126		}
4127
4128		len = get_unaligned_be16(&cdb[7]);
4129		hdr_len = 8;
4130	}
4131
4132	/* We only support PF=1, SP=0.  */
4133	if ((cdb[1] & 0x11) != 0x10) {
4134		fp = 1;
4135		bp = (cdb[1] & 0x01) ? 1 : 5;
4136		goto invalid_fld;
4137	}
4138
4139	/* Test early for possible overrun.  */
4140	if (!scsi_sg_count(scmd) || scsi_sglist(scmd)->length < len)
4141		goto invalid_param_len;
4142
4143	/* Move past header and block descriptors.  */
4144	if (len < hdr_len)
4145		goto invalid_param_len;
4146
4147	if (!sg_copy_to_buffer(scsi_sglist(scmd), scsi_sg_count(scmd),
4148			       buffer, sizeof(buffer)))
4149		goto invalid_param_len;
4150
4151	if (six_byte)
4152		bd_len = p[3];
4153	else
4154		bd_len = get_unaligned_be16(&p[6]);
4155
4156	len -= hdr_len;
4157	p += hdr_len;
4158	if (len < bd_len)
4159		goto invalid_param_len;
4160	if (bd_len != 0 && bd_len != 8) {
4161		fp = (six_byte) ? 3 : 6;
4162		fp += bd_len + hdr_len;
4163		goto invalid_param;
4164	}
4165
4166	len -= bd_len;
4167	p += bd_len;
4168	if (len == 0)
4169		goto skip;
4170
4171	/* Parse both possible formats for the mode page headers.  */
4172	pg = p[0] & 0x3f;
4173	if (p[0] & 0x40) {
4174		if (len < 4)
4175			goto invalid_param_len;
4176
4177		spg = p[1];
4178		pg_len = get_unaligned_be16(&p[2]);
4179		p += 4;
4180		len -= 4;
4181	} else {
4182		if (len < 2)
4183			goto invalid_param_len;
4184
4185		spg = 0;
4186		pg_len = p[1];
4187		p += 2;
4188		len -= 2;
4189	}
4190
4191	/*
4192	 * Supported subpages: all subpages and ATA feature sub-page f2h of
4193	 * the control page.
4194	 */
4195	if (spg) {
4196		switch (spg) {
4197		case ALL_SUB_MPAGES:
4198			/* All subpages is not supported for the control page */
4199			if (pg == CONTROL_MPAGE) {
4200				fp = (p[0] & 0x40) ? 1 : 0;
4201				fp += hdr_len + bd_len;
4202				goto invalid_param;
4203			}
4204			break;
4205		case ATA_FEATURE_SUB_MPAGE:
4206			if (qc->dev->flags & ATA_DFLAG_CDL &&
4207			    pg == CONTROL_MPAGE)
4208				break;
4209			fallthrough;
4210		default:
4211			fp = (p[0] & 0x40) ? 1 : 0;
4212			fp += hdr_len + bd_len;
4213			goto invalid_param;
4214		}
4215	}
4216	if (pg_len > len)
4217		goto invalid_param_len;
4218
4219	switch (pg) {
4220	case CACHE_MPAGE:
4221		if (ata_mselect_caching(qc, p, pg_len, &fp) < 0) {
4222			fp += hdr_len + bd_len;
4223			goto invalid_param;
4224		}
4225		break;
4226	case CONTROL_MPAGE:
4227		ret = ata_mselect_control(qc, spg, p, pg_len, &fp);
4228		if (ret < 0) {
4229			fp += hdr_len + bd_len;
4230			goto invalid_param;
4231		}
4232		if (!ret)
4233			goto skip; /* No ATA command to send */
4234		break;
4235	default:
4236		/* Invalid page code */
4237		fp = bd_len + hdr_len;
4238		goto invalid_param;
4239	}
4240
4241	/*
4242	 * Only one page has changeable data, so we only support setting one
4243	 * page at a time.
4244	 */
4245	if (len > pg_len)
4246		goto invalid_param;
4247
4248	return 0;
4249
4250 invalid_fld:
4251	ata_scsi_set_invalid_field(qc->dev, scmd, fp, bp);
4252	return 1;
4253
4254 invalid_param:
4255	ata_scsi_set_invalid_parameter(qc->dev, scmd, fp);
4256	return 1;
4257
4258 invalid_param_len:
4259	/* "Parameter list length error" */
4260	ata_scsi_set_sense(qc->dev, scmd, ILLEGAL_REQUEST, 0x1a, 0x0);
4261	return 1;
4262
4263 skip:
4264	scmd->result = SAM_STAT_GOOD;
4265	return 1;
4266}
4267
4268static u8 ata_scsi_trusted_op(u32 len, bool send, bool dma)
4269{
4270	if (len == 0)
4271		return ATA_CMD_TRUSTED_NONDATA;
4272	else if (send)
4273		return dma ? ATA_CMD_TRUSTED_SND_DMA : ATA_CMD_TRUSTED_SND;
4274	else
4275		return dma ? ATA_CMD_TRUSTED_RCV_DMA : ATA_CMD_TRUSTED_RCV;
4276}
4277
4278static unsigned int ata_scsi_security_inout_xlat(struct ata_queued_cmd *qc)
4279{
4280	struct scsi_cmnd *scmd = qc->scsicmd;
4281	const u8 *cdb = scmd->cmnd;
4282	struct ata_taskfile *tf = &qc->tf;
4283	u8 secp = cdb[1];
4284	bool send = (cdb[0] == SECURITY_PROTOCOL_OUT);
4285	u16 spsp = get_unaligned_be16(&cdb[2]);
4286	u32 len = get_unaligned_be32(&cdb[6]);
4287	bool dma = !(qc->dev->flags & ATA_DFLAG_PIO);
4288
4289	/*
4290	 * We don't support the ATA "security" protocol.
4291	 */
4292	if (secp == 0xef) {
4293		ata_scsi_set_invalid_field(qc->dev, scmd, 1, 0);
4294		return 1;
4295	}
4296
4297	if (cdb[4] & 7) { /* INC_512 */
4298		if (len > 0xffff) {
4299			ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4300			return 1;
4301		}
4302	} else {
4303		if (len > 0x01fffe00) {
4304			ata_scsi_set_invalid_field(qc->dev, scmd, 6, 0);
4305			return 1;
4306		}
4307
4308		/* convert to the sector-based ATA addressing */
4309		len = (len + 511) / 512;
4310	}
4311
4312	tf->protocol = dma ? ATA_PROT_DMA : ATA_PROT_PIO;
4313	tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR | ATA_TFLAG_LBA;
4314	if (send)
4315		tf->flags |= ATA_TFLAG_WRITE;
4316	tf->command = ata_scsi_trusted_op(len, send, dma);
4317	tf->feature = secp;
4318	tf->lbam = spsp & 0xff;
4319	tf->lbah = spsp >> 8;
4320
4321	if (len) {
4322		tf->nsect = len & 0xff;
4323		tf->lbal = len >> 8;
4324	} else {
4325		if (!send)
4326			tf->lbah = (1 << 7);
4327	}
4328
4329	ata_qc_set_pc_nbytes(qc);
4330	return 0;
4331}
4332
4333/**
4334 *	ata_scsi_var_len_cdb_xlat - SATL variable length CDB to Handler
4335 *	@qc: Command to be translated
4336 *
4337 *	Translate a SCSI variable length CDB to specified commands.
4338 *	It checks a service action value in CDB to call corresponding handler.
4339 *
4340 *	RETURNS:
4341 *	Zero on success, non-zero on failure
4342 *
4343 */
4344static unsigned int ata_scsi_var_len_cdb_xlat(struct ata_queued_cmd *qc)
4345{
4346	struct scsi_cmnd *scmd = qc->scsicmd;
4347	const u8 *cdb = scmd->cmnd;
4348	const u16 sa = get_unaligned_be16(&cdb[8]);
4349
4350	/*
4351	 * if service action represents a ata pass-thru(32) command,
4352	 * then pass it to ata_scsi_pass_thru handler.
4353	 */
4354	if (sa == ATA_32)
4355		return ata_scsi_pass_thru(qc);
4356
4357	/* unsupported service action */
4358	return 1;
4359}
4360
4361/**
4362 *	ata_get_xlat_func - check if SCSI to ATA translation is possible
4363 *	@dev: ATA device
4364 *	@cmd: SCSI command opcode to consider
4365 *
4366 *	Look up the SCSI command given, and determine whether the
4367 *	SCSI command is to be translated or simulated.
4368 *
4369 *	RETURNS:
4370 *	Pointer to translation function if possible, %NULL if not.
4371 */
4372
4373static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
4374{
4375	switch (cmd) {
4376	case READ_6:
4377	case READ_10:
4378	case READ_16:
4379
4380	case WRITE_6:
4381	case WRITE_10:
4382	case WRITE_16:
4383		return ata_scsi_rw_xlat;
4384
4385	case WRITE_SAME_16:
4386		return ata_scsi_write_same_xlat;
4387
4388	case SYNCHRONIZE_CACHE:
4389	case SYNCHRONIZE_CACHE_16:
4390		if (ata_try_flush_cache(dev))
4391			return ata_scsi_flush_xlat;
4392		break;
4393
4394	case VERIFY:
4395	case VERIFY_16:
4396		return ata_scsi_verify_xlat;
4397
4398	case ATA_12:
4399	case ATA_16:
4400		return ata_scsi_pass_thru;
4401
4402	case VARIABLE_LENGTH_CMD:
4403		return ata_scsi_var_len_cdb_xlat;
4404
4405	case MODE_SELECT:
4406	case MODE_SELECT_10:
4407		return ata_scsi_mode_select_xlat;
4408
4409	case ZBC_IN:
4410		return ata_scsi_zbc_in_xlat;
4411
4412	case ZBC_OUT:
4413		return ata_scsi_zbc_out_xlat;
4414
4415	case SECURITY_PROTOCOL_IN:
4416	case SECURITY_PROTOCOL_OUT:
4417		if (!(dev->flags & ATA_DFLAG_TRUSTED))
4418			break;
4419		return ata_scsi_security_inout_xlat;
4420
4421	case START_STOP:
4422		return ata_scsi_start_stop_xlat;
4423	}
4424
4425	return NULL;
4426}
4427
4428int __ata_scsi_queuecmd(struct scsi_cmnd *scmd, struct ata_device *dev)
4429{
4430	struct ata_port *ap = dev->link->ap;
4431	u8 scsi_op = scmd->cmnd[0];
4432	ata_xlat_func_t xlat_func;
4433
4434	/*
4435	 * scsi_queue_rq() will defer commands if scsi_host_in_recovery().
4436	 * However, this check is done without holding the ap->lock (a libata
4437	 * specific lock), so we can have received an error irq since then,
4438	 * therefore we must check if EH is pending or running, while holding
4439	 * ap->lock.
4440	 */
4441	if (ata_port_eh_scheduled(ap))
4442		return SCSI_MLQUEUE_DEVICE_BUSY;
4443
4444	if (unlikely(!scmd->cmd_len))
4445		goto bad_cdb_len;
4446
4447	if (dev->class == ATA_DEV_ATA || dev->class == ATA_DEV_ZAC) {
4448		if (unlikely(scmd->cmd_len > dev->cdb_len))
4449			goto bad_cdb_len;
4450
4451		xlat_func = ata_get_xlat_func(dev, scsi_op);
4452	} else if (likely((scsi_op != ATA_16) || !atapi_passthru16)) {
4453		/* relay SCSI command to ATAPI device */
4454		int len = COMMAND_SIZE(scsi_op);
4455
4456		if (unlikely(len > scmd->cmd_len ||
4457			     len > dev->cdb_len ||
4458			     scmd->cmd_len > ATAPI_CDB_LEN))
4459			goto bad_cdb_len;
4460
4461		xlat_func = atapi_xlat;
4462	} else {
4463		/* ATA_16 passthru, treat as an ATA command */
4464		if (unlikely(scmd->cmd_len > 16))
4465			goto bad_cdb_len;
4466
4467		xlat_func = ata_get_xlat_func(dev, scsi_op);
4468	}
4469
4470	if (xlat_func)
4471		return ata_scsi_translate(dev, scmd, xlat_func);
4472
4473	ata_scsi_simulate(dev, scmd);
4474
4475	return 0;
4476
4477 bad_cdb_len:
4478	scmd->result = DID_ERROR << 16;
4479	scsi_done(scmd);
4480	return 0;
4481}
4482
4483/**
4484 *	ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
4485 *	@shost: SCSI host of command to be sent
4486 *	@cmd: SCSI command to be sent
4487 *
4488 *	In some cases, this function translates SCSI commands into
4489 *	ATA taskfiles, and queues the taskfiles to be sent to
4490 *	hardware.  In other cases, this function simulates a
4491 *	SCSI device by evaluating and responding to certain
4492 *	SCSI commands.  This creates the overall effect of
4493 *	ATA and ATAPI devices appearing as SCSI devices.
4494 *
4495 *	LOCKING:
4496 *	ATA host lock
4497 *
4498 *	RETURNS:
4499 *	Return value from __ata_scsi_queuecmd() if @cmd can be queued,
4500 *	0 otherwise.
4501 */
4502int ata_scsi_queuecmd(struct Scsi_Host *shost, struct scsi_cmnd *cmd)
4503{
4504	struct ata_port *ap;
4505	struct ata_device *dev;
4506	struct scsi_device *scsidev = cmd->device;
4507	int rc = 0;
4508	unsigned long irq_flags;
4509
4510	ap = ata_shost_to_port(shost);
4511
4512	spin_lock_irqsave(ap->lock, irq_flags);
4513
4514	dev = ata_scsi_find_dev(ap, scsidev);
4515	if (likely(dev))
4516		rc = __ata_scsi_queuecmd(cmd, dev);
4517	else {
4518		cmd->result = (DID_BAD_TARGET << 16);
4519		scsi_done(cmd);
4520	}
4521
4522	spin_unlock_irqrestore(ap->lock, irq_flags);
4523
4524	return rc;
4525}
4526EXPORT_SYMBOL_GPL(ata_scsi_queuecmd);
4527
4528/**
4529 *	ata_scsi_simulate - simulate SCSI command on ATA device
4530 *	@dev: the target device
4531 *	@cmd: SCSI command being sent to device.
4532 *
4533 *	Interprets and directly executes a select list of SCSI commands
4534 *	that can be handled internally.
4535 *
4536 *	LOCKING:
4537 *	spin_lock_irqsave(host lock)
4538 */
4539
4540void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd)
4541{
4542	const u8 *scsicmd = cmd->cmnd;
4543	u8 tmp8;
4544
4545	switch(scsicmd[0]) {
4546	case INQUIRY:
4547		ata_scsi_rbuf_fill(dev, cmd, ata_scsiop_inquiry);
4548		break;
4549
4550	case MODE_SENSE:
4551	case MODE_SENSE_10:
4552		ata_scsi_rbuf_fill(dev, cmd, ata_scsiop_mode_sense);
4553		break;
4554
4555	case READ_CAPACITY:
4556	case SERVICE_ACTION_IN_16:
4557		ata_scsi_rbuf_fill(dev, cmd, ata_scsiop_read_cap);
4558		break;
4559
4560	case REPORT_LUNS:
4561		ata_scsi_rbuf_fill(dev, cmd, ata_scsiop_report_luns);
4562		break;
4563
4564	case REQUEST_SENSE:
4565		ata_scsi_set_sense(dev, cmd, 0, 0, 0);
4566		break;
4567
4568	/* if we reach this, then writeback caching is disabled,
4569	 * turning this into a no-op.
4570	 */
4571	case SYNCHRONIZE_CACHE:
4572	case SYNCHRONIZE_CACHE_16:
4573		fallthrough;
4574
4575	/* no-op's, complete with success */
4576	case REZERO_UNIT:
4577	case SEEK_6:
4578	case SEEK_10:
4579	case TEST_UNIT_READY:
4580		break;
4581
4582	case SEND_DIAGNOSTIC:
4583		tmp8 = scsicmd[1] & ~(1 << 3);
4584		if (tmp8 != 0x4 || scsicmd[3] || scsicmd[4])
4585			ata_scsi_set_invalid_field(dev, cmd, 1, 0xff);
4586		break;
4587
4588	case MAINTENANCE_IN:
4589		ata_scsi_rbuf_fill(dev, cmd, ata_scsiop_maint_in);
4590		break;
4591
4592	/* all other commands */
4593	default:
4594		ata_scsi_set_sense(dev, cmd, ILLEGAL_REQUEST, 0x20, 0x0);
4595		/* "Invalid command operation code" */
4596		break;
4597	}
4598
4599	scsi_done(cmd);
4600}
4601
4602int ata_scsi_add_hosts(struct ata_host *host, const struct scsi_host_template *sht)
4603{
4604	int i, rc;
4605
4606	for (i = 0; i < host->n_ports; i++) {
4607		struct ata_port *ap = host->ports[i];
4608		struct Scsi_Host *shost;
4609
4610		rc = -ENOMEM;
4611		shost = scsi_host_alloc(sht, sizeof(struct ata_port *));
4612		if (!shost)
4613			goto err_alloc;
4614
4615		shost->eh_noresume = 1;
4616		*(struct ata_port **)&shost->hostdata[0] = ap;
4617		ap->scsi_host = shost;
4618
4619		shost->transportt = ata_scsi_transport_template;
4620		shost->unique_id = ap->print_id;
4621		shost->max_id = 16;
4622		shost->max_lun = 1;
4623		shost->max_channel = 1;
4624		shost->max_cmd_len = 32;
4625
4626		/* Schedule policy is determined by ->qc_defer()
4627		 * callback and it needs to see every deferred qc.
4628		 * Set host_blocked to 1 to prevent SCSI midlayer from
4629		 * automatically deferring requests.
4630		 */
4631		shost->max_host_blocked = 1;
4632
4633		rc = scsi_add_host_with_dma(shost, &ap->tdev, ap->host->dev);
4634		if (rc)
4635			goto err_alloc;
4636	}
4637
4638	return 0;
4639
4640 err_alloc:
4641	while (--i >= 0) {
4642		struct Scsi_Host *shost = host->ports[i]->scsi_host;
4643
4644		/* scsi_host_put() is in ata_devres_release() */
4645		scsi_remove_host(shost);
4646	}
4647	return rc;
4648}
4649
4650#ifdef CONFIG_OF
4651static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4652{
4653	struct scsi_device *sdev = dev->sdev;
4654	struct device *d = ap->host->dev;
4655	struct device_node *np = d->of_node;
4656	struct device_node *child;
4657
4658	for_each_available_child_of_node(np, child) {
4659		int ret;
4660		u32 val;
4661
4662		ret = of_property_read_u32(child, "reg", &val);
4663		if (ret)
4664			continue;
4665		if (val == dev->devno) {
4666			dev_dbg(d, "found matching device node\n");
4667			sdev->sdev_gendev.of_node = child;
4668			return;
4669		}
4670	}
4671}
4672#else
4673static void ata_scsi_assign_ofnode(struct ata_device *dev, struct ata_port *ap)
4674{
4675}
4676#endif
4677
4678void ata_scsi_scan_host(struct ata_port *ap, int sync)
4679{
4680	int tries = 5;
4681	struct ata_device *last_failed_dev = NULL;
4682	struct ata_link *link;
4683	struct ata_device *dev;
4684
4685 repeat:
4686	ata_for_each_link(link, ap, EDGE) {
4687		ata_for_each_dev(dev, link, ENABLED) {
4688			struct scsi_device *sdev;
4689			int channel = 0, id = 0;
4690
4691			if (dev->sdev)
4692				continue;
4693
4694			if (ata_is_host_link(link))
4695				id = dev->devno;
4696			else
4697				channel = link->pmp;
4698
4699			sdev = __scsi_add_device(ap->scsi_host, channel, id, 0,
4700						 NULL);
4701			if (!IS_ERR(sdev)) {
4702				dev->sdev = sdev;
4703				ata_scsi_assign_ofnode(dev, ap);
4704				scsi_device_put(sdev);
4705			} else {
4706				dev->sdev = NULL;
4707			}
4708		}
4709	}
4710
4711	/* If we scanned while EH was in progress or allocation
4712	 * failure occurred, scan would have failed silently.  Check
4713	 * whether all devices are attached.
4714	 */
4715	ata_for_each_link(link, ap, EDGE) {
4716		ata_for_each_dev(dev, link, ENABLED) {
4717			if (!dev->sdev)
4718				goto exit_loop;
4719		}
4720	}
4721 exit_loop:
4722	if (!link)
4723		return;
4724
4725	/* we're missing some SCSI devices */
4726	if (sync) {
4727		/* If caller requested synchrnous scan && we've made
4728		 * any progress, sleep briefly and repeat.
4729		 */
4730		if (dev != last_failed_dev) {
4731			msleep(100);
4732			last_failed_dev = dev;
4733			goto repeat;
4734		}
4735
4736		/* We might be failing to detect boot device, give it
4737		 * a few more chances.
4738		 */
4739		if (--tries) {
4740			msleep(100);
4741			goto repeat;
4742		}
4743
4744		ata_port_err(ap,
4745			     "WARNING: synchronous SCSI scan failed without making any progress, switching to async\n");
4746	}
4747
4748	queue_delayed_work(system_long_wq, &ap->hotplug_task,
4749			   round_jiffies_relative(HZ));
4750}
4751
4752/**
4753 *	ata_scsi_offline_dev - offline attached SCSI device
4754 *	@dev: ATA device to offline attached SCSI device for
4755 *
4756 *	This function is called from ata_eh_detach_dev() and is responsible for
4757 *	taking the SCSI device attached to @dev offline.  This function is
4758 *	called with host lock which protects dev->sdev against clearing.
4759 *
4760 *	LOCKING:
4761 *	spin_lock_irqsave(host lock)
4762 *
4763 *	RETURNS:
4764 *	true if attached SCSI device exists, false otherwise.
4765 */
4766bool ata_scsi_offline_dev(struct ata_device *dev)
4767{
4768	if (dev->sdev) {
4769		scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
4770		return true;
4771	}
4772	return false;
4773}
4774
4775/**
4776 *	ata_scsi_remove_dev - remove attached SCSI device
4777 *	@dev: ATA device to remove attached SCSI device for
4778 *
4779 *	This function is called from ata_eh_scsi_hotplug() and
4780 *	responsible for removing the SCSI device attached to @dev.
4781 *
4782 *	LOCKING:
4783 *	Kernel thread context (may sleep).
4784 */
4785static void ata_scsi_remove_dev(struct ata_device *dev)
4786{
4787	struct ata_port *ap = dev->link->ap;
4788	struct scsi_device *sdev;
4789	unsigned long flags;
4790
4791	/* Alas, we need to grab scan_mutex to ensure SCSI device
4792	 * state doesn't change underneath us and thus
4793	 * scsi_device_get() always succeeds.  The mutex locking can
4794	 * be removed if there is __scsi_device_get() interface which
4795	 * increments reference counts regardless of device state.
4796	 */
4797	mutex_lock(&ap->scsi_host->scan_mutex);
4798	spin_lock_irqsave(ap->lock, flags);
4799
4800	/* clearing dev->sdev is protected by host lock */
4801	sdev = dev->sdev;
4802	dev->sdev = NULL;
4803
4804	if (sdev) {
4805		/* If user initiated unplug races with us, sdev can go
4806		 * away underneath us after the host lock and
4807		 * scan_mutex are released.  Hold onto it.
4808		 */
4809		if (scsi_device_get(sdev) == 0) {
4810			/* The following ensures the attached sdev is
4811			 * offline on return from ata_scsi_offline_dev()
4812			 * regardless it wins or loses the race
4813			 * against this function.
4814			 */
4815			scsi_device_set_state(sdev, SDEV_OFFLINE);
4816		} else {
4817			WARN_ON(1);
4818			sdev = NULL;
4819		}
4820	}
4821
4822	spin_unlock_irqrestore(ap->lock, flags);
4823	mutex_unlock(&ap->scsi_host->scan_mutex);
4824
4825	if (sdev) {
4826		ata_dev_info(dev, "detaching (SCSI %s)\n",
4827			     dev_name(&sdev->sdev_gendev));
4828
4829		scsi_remove_device(sdev);
4830		scsi_device_put(sdev);
4831	}
4832}
4833
4834static void ata_scsi_handle_link_detach(struct ata_link *link)
4835{
4836	struct ata_port *ap = link->ap;
4837	struct ata_device *dev;
4838
4839	ata_for_each_dev(dev, link, ALL) {
4840		unsigned long flags;
4841
4842		spin_lock_irqsave(ap->lock, flags);
4843		if (!(dev->flags & ATA_DFLAG_DETACHED)) {
4844			spin_unlock_irqrestore(ap->lock, flags);
4845			continue;
4846		}
4847
4848		dev->flags &= ~ATA_DFLAG_DETACHED;
4849		spin_unlock_irqrestore(ap->lock, flags);
4850
4851		ata_scsi_remove_dev(dev);
4852	}
4853}
4854
4855/**
4856 *	ata_scsi_media_change_notify - send media change event
4857 *	@dev: Pointer to the disk device with media change event
4858 *
4859 *	Tell the block layer to send a media change notification
4860 *	event.
4861 *
4862 * 	LOCKING:
4863 * 	spin_lock_irqsave(host lock)
4864 */
4865void ata_scsi_media_change_notify(struct ata_device *dev)
4866{
4867	if (dev->sdev)
4868		sdev_evt_send_simple(dev->sdev, SDEV_EVT_MEDIA_CHANGE,
4869				     GFP_ATOMIC);
4870}
4871
4872/**
4873 *	ata_scsi_hotplug - SCSI part of hotplug
4874 *	@work: Pointer to ATA port to perform SCSI hotplug on
4875 *
4876 *	Perform SCSI part of hotplug.  It's executed from a separate
4877 *	workqueue after EH completes.  This is necessary because SCSI
4878 *	hot plugging requires working EH and hot unplugging is
4879 *	synchronized with hot plugging with a mutex.
4880 *
4881 *	LOCKING:
4882 *	Kernel thread context (may sleep).
4883 */
4884void ata_scsi_hotplug(struct work_struct *work)
4885{
4886	struct ata_port *ap =
4887		container_of(work, struct ata_port, hotplug_task.work);
4888	int i;
4889
4890	if (ap->pflags & ATA_PFLAG_UNLOADING)
4891		return;
4892
4893	mutex_lock(&ap->scsi_scan_mutex);
4894
4895	/* Unplug detached devices.  We cannot use link iterator here
4896	 * because PMP links have to be scanned even if PMP is
4897	 * currently not attached.  Iterate manually.
4898	 */
4899	ata_scsi_handle_link_detach(&ap->link);
4900	if (ap->pmp_link)
4901		for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
4902			ata_scsi_handle_link_detach(&ap->pmp_link[i]);
4903
4904	/* scan for new ones */
4905	ata_scsi_scan_host(ap, 0);
4906
4907	mutex_unlock(&ap->scsi_scan_mutex);
4908}
4909
4910/**
4911 *	ata_scsi_user_scan - indication for user-initiated bus scan
4912 *	@shost: SCSI host to scan
4913 *	@channel: Channel to scan
4914 *	@id: ID to scan
4915 *	@lun: LUN to scan
4916 *
4917 *	This function is called when user explicitly requests bus
4918 *	scan.  Set probe pending flag and invoke EH.
4919 *
4920 *	LOCKING:
4921 *	SCSI layer (we don't care)
4922 *
4923 *	RETURNS:
4924 *	Zero.
4925 */
4926int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
4927		       unsigned int id, u64 lun)
4928{
4929	struct ata_port *ap = ata_shost_to_port(shost);
4930	unsigned long flags;
4931	int devno, rc = 0;
4932
4933	if (lun != SCAN_WILD_CARD && lun)
4934		return -EINVAL;
4935
4936	if (!sata_pmp_attached(ap)) {
4937		if (channel != SCAN_WILD_CARD && channel)
4938			return -EINVAL;
4939		devno = id;
4940	} else {
4941		if (id != SCAN_WILD_CARD && id)
4942			return -EINVAL;
4943		devno = channel;
4944	}
4945
4946	spin_lock_irqsave(ap->lock, flags);
4947
4948	if (devno == SCAN_WILD_CARD) {
4949		struct ata_link *link;
4950
4951		ata_for_each_link(link, ap, EDGE) {
4952			struct ata_eh_info *ehi = &link->eh_info;
4953			ehi->probe_mask |= ATA_ALL_DEVICES;
4954			ehi->action |= ATA_EH_RESET;
4955		}
4956	} else {
4957		struct ata_device *dev = ata_find_dev(ap, devno);
4958
4959		if (dev) {
4960			struct ata_eh_info *ehi = &dev->link->eh_info;
4961			ehi->probe_mask |= 1 << dev->devno;
4962			ehi->action |= ATA_EH_RESET;
4963		} else
4964			rc = -EINVAL;
4965	}
4966
4967	if (rc == 0) {
4968		ata_port_schedule_eh(ap);
4969		spin_unlock_irqrestore(ap->lock, flags);
4970		ata_port_wait_eh(ap);
4971	} else
4972		spin_unlock_irqrestore(ap->lock, flags);
4973
4974	return rc;
4975}
4976
4977/**
4978 *	ata_scsi_dev_rescan - initiate scsi_rescan_device()
4979 *	@work: Pointer to ATA port to perform scsi_rescan_device()
4980 *
4981 *	After ATA pass thru (SAT) commands are executed successfully,
4982 *	libata need to propagate the changes to SCSI layer.
4983 *
4984 *	LOCKING:
4985 *	Kernel thread context (may sleep).
4986 */
4987void ata_scsi_dev_rescan(struct work_struct *work)
4988{
4989	struct ata_port *ap =
4990		container_of(work, struct ata_port, scsi_rescan_task.work);
4991	struct ata_link *link;
4992	struct ata_device *dev;
4993	unsigned long flags;
4994	bool do_resume;
4995	int ret = 0;
4996
4997	mutex_lock(&ap->scsi_scan_mutex);
4998	spin_lock_irqsave(ap->lock, flags);
4999
5000	ata_for_each_link(link, ap, EDGE) {
5001		ata_for_each_dev(dev, link, ENABLED) {
5002			struct scsi_device *sdev = dev->sdev;
5003
5004			/*
5005			 * If the port was suspended before this was scheduled,
5006			 * bail out.
5007			 */
5008			if (ap->pflags & ATA_PFLAG_SUSPENDED)
5009				goto unlock_ap;
5010
5011			if (!sdev)
5012				continue;
5013			if (scsi_device_get(sdev))
5014				continue;
5015
5016			do_resume = dev->flags & ATA_DFLAG_RESUMING;
5017
5018			spin_unlock_irqrestore(ap->lock, flags);
5019			if (do_resume) {
5020				ret = scsi_resume_device(sdev);
5021				if (ret == -EWOULDBLOCK) {
5022					scsi_device_put(sdev);
5023					goto unlock_scan;
5024				}
5025				dev->flags &= ~ATA_DFLAG_RESUMING;
5026			}
5027			ret = scsi_rescan_device(sdev);
5028			scsi_device_put(sdev);
5029			spin_lock_irqsave(ap->lock, flags);
5030
5031			if (ret)
5032				goto unlock_ap;
5033		}
5034	}
5035
5036unlock_ap:
5037	spin_unlock_irqrestore(ap->lock, flags);
5038unlock_scan:
5039	mutex_unlock(&ap->scsi_scan_mutex);
5040
5041	/* Reschedule with a delay if scsi_rescan_device() returned an error */
5042	if (ret)
5043		schedule_delayed_work(&ap->scsi_rescan_task,
5044				      msecs_to_jiffies(5));
5045}
~/ Read-only file preview.