libata-scsi.c 84.0 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
 *  libata-scsi.c - helper library for ATA
 *
 *  Maintained by:  Jeff Garzik <jgarzik@pobox.com>
 *    		    Please ALWAYS copy linux-ide@vger.kernel.org
 *		    on emails.
 *
 *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
 *  Copyright 2003-2004 Jeff Garzik
 *
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; see the file COPYING.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *
 *  libata documentation is available via 'make {ps|pdf}docs',
 *  as Documentation/DocBook/libata.*
 *
 *  Hardware documentation available from
 *  - http://www.t10.org/
 *  - http://www.t13.org/
 *
L
Linus Torvalds 已提交
34 35 36 37 38 39 40
 */

#include <linux/kernel.h>
#include <linux/blkdev.h>
#include <linux/spinlock.h>
#include <scsi/scsi.h>
#include <scsi/scsi_host.h>
41
#include <scsi/scsi_cmnd.h>
42
#include <scsi/scsi_eh.h>
J
Jeff Garzik 已提交
43
#include <scsi/scsi_device.h>
44
#include <scsi/scsi_tcq.h>
45
#include <scsi/scsi_transport.h>
L
Linus Torvalds 已提交
46
#include <linux/libata.h>
47
#include <linux/hdreg.h>
L
Linus Torvalds 已提交
48 49 50 51
#include <asm/uaccess.h>

#include "libata.h"

52 53
#define SECTOR_SIZE	512

54
typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc);
55 56 57 58 59

static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
					const struct scsi_device *scsidev);
static struct ata_device * ata_scsi_find_dev(struct ata_port *ap,
					    const struct scsi_device *scsidev);
60 61
static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
			      unsigned int id, unsigned int lun);
62

L
Linus Torvalds 已提交
63

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
#define RW_RECOVERY_MPAGE 0x1
#define RW_RECOVERY_MPAGE_LEN 12
#define CACHE_MPAGE 0x8
#define CACHE_MPAGE_LEN 20
#define CONTROL_MPAGE 0xa
#define CONTROL_MPAGE_LEN 12
#define ALL_MPAGES 0x3f
#define ALL_SUB_MPAGES 0xff


static const u8 def_rw_recovery_mpage[] = {
	RW_RECOVERY_MPAGE,
	RW_RECOVERY_MPAGE_LEN - 2,
	(1 << 7) |	/* AWRE, sat-r06 say it shall be 0 */
	    (1 << 6),	/* ARRE (auto read reallocation) */
	0,		/* read retry count */
	0, 0, 0, 0,
	0,		/* write retry count */
	0, 0, 0
};

static const u8 def_cache_mpage[CACHE_MPAGE_LEN] = {
	CACHE_MPAGE,
	CACHE_MPAGE_LEN - 2,
	0,		/* contains WCE, needs to be 0 for logic */
	0, 0, 0, 0, 0, 0, 0, 0, 0,
	0,		/* contains DRA, needs to be 0 for logic */
	0, 0, 0, 0, 0, 0, 0
};

static const u8 def_control_mpage[CONTROL_MPAGE_LEN] = {
	CONTROL_MPAGE,
	CONTROL_MPAGE_LEN - 2,
	2,	/* DSENSE=0, GLTSD=1 */
	0,	/* [QAM+QERR may be 1, see 05-359r1] */
	0, 0, 0, 0, 0xff, 0xff,
	0, 30	/* extended self test time, see 05-359r1 */
};

103 104 105 106 107
/*
 * libata transport template.  libata doesn't do real transport stuff.
 * It just needs the eh_timed_out hook.
 */
struct scsi_transport_template ata_scsi_transport_template = {
108
	.eh_strategy_handler	= ata_scsi_error,
109
	.eh_timed_out		= ata_scsi_timed_out,
T
Tejun Heo 已提交
110
	.user_scan		= ata_scsi_user_scan,
111 112
};

L
Linus Torvalds 已提交
113

114 115 116 117 118 119 120 121
static void ata_scsi_invalid_field(struct scsi_cmnd *cmd,
				   void (*done)(struct scsi_cmnd *))
{
	ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x24, 0x0);
	/* "Invalid field in cbd" */
	done(cmd);
}

L
Linus Torvalds 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/**
 *	ata_std_bios_param - generic bios head/sector/cylinder calculator used by sd.
 *	@sdev: SCSI device for which BIOS geometry is to be determined
 *	@bdev: block device associated with @sdev
 *	@capacity: capacity of SCSI device
 *	@geom: location to which geometry will be output
 *
 *	Generic bios head/sector/cylinder calculator
 *	used by sd. Most BIOSes nowadays expect a XXX/255/16  (CHS)
 *	mapping. Some situations may arise where the disk is not
 *	bootable if this is not used.
 *
 *	LOCKING:
 *	Defined by the SCSI layer.  We don't really care.
 *
 *	RETURNS:
 *	Zero.
 */
int ata_std_bios_param(struct scsi_device *sdev, struct block_device *bdev,
		       sector_t capacity, int geom[])
{
	geom[0] = 255;
	geom[1] = 63;
	sector_div(capacity, 255*63);
	geom[2] = capacity;

	return 0;
}

T
Tejun Heo 已提交
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
/**
 *	ata_get_identity - Handler for HDIO_GET_IDENTITY ioctl
 *	@sdev: SCSI device to get identify data for
 *	@arg: User buffer area for identify data
 *
 *	LOCKING:
 *	Defined by the SCSI layer.  We don't really care.
 *
 *	RETURNS:
 *	Zero on success, negative errno on error.
 */
static int ata_get_identity(struct scsi_device *sdev, void __user *arg)
{
	struct ata_port *ap = ata_shost_to_port(sdev->host);
	struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
	u16 __user *dst = arg;
	char buf[40];

	if (!dev)
		return -ENOMSG;

	if (copy_to_user(dst, dev->id, ATA_ID_WORDS * sizeof(u16)))
		return -EFAULT;

	ata_id_string(dev->id, buf, ATA_ID_PROD, ATA_ID_PROD_LEN);
	if (copy_to_user(dst + ATA_ID_PROD, buf, ATA_ID_PROD_LEN))
		return -EFAULT;

	ata_id_string(dev->id, buf, ATA_ID_FW_REV, ATA_ID_FW_REV_LEN);
	if (copy_to_user(dst + ATA_ID_FW_REV, buf, ATA_ID_FW_REV_LEN))
		return -EFAULT;

	ata_id_string(dev->id, buf, ATA_ID_SERNO, ATA_ID_SERNO_LEN);
	if (copy_to_user(dst + ATA_ID_SERNO, buf, ATA_ID_SERNO_LEN))
		return -EFAULT;

	return 0;
}

190 191
/**
 *	ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
R
Randy Dunlap 已提交
192
 *	@scsidev: Device to which we are issuing command
193 194 195 196 197 198 199 200 201 202 203 204
 *	@arg: User provided data for issuing command
 *
 *	LOCKING:
 *	Defined by the SCSI layer.  We don't really care.
 *
 *	RETURNS:
 *	Zero on success, negative errno on error.
 */
int ata_cmd_ioctl(struct scsi_device *scsidev, void __user *arg)
{
	int rc = 0;
	u8 scsi_cmd[MAX_COMMAND_SIZE];
205
	u8 args[4], *argbuf = NULL, *sensebuf = NULL;
206
	int argsize = 0;
207
	enum dma_data_direction data_dir;
208
	int cmd_result;
209

210
	if (arg == NULL)
211 212 213 214 215
		return -EINVAL;

	if (copy_from_user(args, arg, sizeof(args)))
		return -EFAULT;

216 217 218 219
	sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
	if (!sensebuf)
		return -ENOMEM;

220 221 222 223 224
	memset(scsi_cmd, 0, sizeof(scsi_cmd));

	if (args[3]) {
		argsize = SECTOR_SIZE * args[3];
		argbuf = kmalloc(argsize, GFP_KERNEL);
225 226 227 228
		if (argbuf == NULL) {
			rc = -ENOMEM;
			goto error;
		}
229 230 231 232

		scsi_cmd[1]  = (4 << 1); /* PIO Data-in */
		scsi_cmd[2]  = 0x0e;     /* no off.line or cc, read from dev,
		                            block count in sector count field */
233
		data_dir = DMA_FROM_DEVICE;
234 235
	} else {
		scsi_cmd[1]  = (3 << 1); /* Non-data */
236
		scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
237
		data_dir = DMA_NONE;
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
	}

	scsi_cmd[0] = ATA_16;

	scsi_cmd[4] = args[2];
	if (args[0] == WIN_SMART) { /* hack -- ide driver does this too... */
		scsi_cmd[6]  = args[3];
		scsi_cmd[8]  = args[1];
		scsi_cmd[10] = 0x4f;
		scsi_cmd[12] = 0xc2;
	} else {
		scsi_cmd[6]  = args[1];
	}
	scsi_cmd[14] = args[0];

	/* Good values for timeout and retries?  Values below
	   from scsi_ioctl_send_command() for default case... */
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
	cmd_result = scsi_execute(scsidev, scsi_cmd, data_dir, argbuf, argsize,
	                          sensebuf, (10*HZ), 5, 0);

	if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
		u8 *desc = sensebuf + 8;
		cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */

		/* If we set cc then ATA pass-through will cause a
		 * check condition even if no error. Filter that. */
		if (cmd_result & SAM_STAT_CHECK_CONDITION) {
			struct scsi_sense_hdr sshdr;
			scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
			                      &sshdr);
			if (sshdr.sense_key==0 &&
			    sshdr.asc==0 && sshdr.ascq==0)
				cmd_result &= ~SAM_STAT_CHECK_CONDITION;
		}

		/* Send userspace a few ATA registers (same as drivers/ide) */
		if (sensebuf[0] == 0x72 &&     /* format is "descriptor" */
		    desc[0] == 0x09 ) {        /* code is "ATA Descriptor" */
			args[0] = desc[13];    /* status */
			args[1] = desc[3];     /* error */
			args[2] = desc[5];     /* sector count (0:7) */
			if (copy_to_user(arg, args, sizeof(args)))
				rc = -EFAULT;
		}
	}


	if (cmd_result) {
286 287 288 289 290
		rc = -EIO;
		goto error;
	}

	if ((argbuf)
291
	 && copy_to_user(arg + sizeof(args), argbuf, argsize))
292 293
		rc = -EFAULT;
error:
294
	kfree(sensebuf);
295
	kfree(argbuf);
296 297 298 299 300
	return rc;
}

/**
 *	ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
R
Randy Dunlap 已提交
301
 *	@scsidev: Device to which we are issuing command
302 303 304 305 306 307 308 309 310 311 312 313
 *	@arg: User provided data for issuing command
 *
 *	LOCKING:
 *	Defined by the SCSI layer.  We don't really care.
 *
 *	RETURNS:
 *	Zero on success, negative errno on error.
 */
int ata_task_ioctl(struct scsi_device *scsidev, void __user *arg)
{
	int rc = 0;
	u8 scsi_cmd[MAX_COMMAND_SIZE];
314 315
	u8 args[7], *sensebuf = NULL;
	int cmd_result;
316

317
	if (arg == NULL)
318 319 320 321 322
		return -EINVAL;

	if (copy_from_user(args, arg, sizeof(args)))
		return -EFAULT;

323 324 325 326
	sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
	if (!sensebuf)
		return -ENOMEM;

327 328 329
	memset(scsi_cmd, 0, sizeof(scsi_cmd));
	scsi_cmd[0]  = ATA_16;
	scsi_cmd[1]  = (3 << 1); /* Non-data */
330
	scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
331 332 333 334 335
	scsi_cmd[4]  = args[1];
	scsi_cmd[6]  = args[2];
	scsi_cmd[8]  = args[3];
	scsi_cmd[10] = args[4];
	scsi_cmd[12] = args[5];
M
Mark Lord 已提交
336
	scsi_cmd[13] = args[6] & 0x0f;
337 338 339
	scsi_cmd[14] = args[0];

	/* Good values for timeout and retries?  Values below
340
	   from scsi_ioctl_send_command() for default case... */
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
	cmd_result = scsi_execute(scsidev, scsi_cmd, DMA_NONE, NULL, 0,
				sensebuf, (10*HZ), 5, 0);

	if (driver_byte(cmd_result) == DRIVER_SENSE) {/* sense data available */
		u8 *desc = sensebuf + 8;
		cmd_result &= ~(0xFF<<24); /* DRIVER_SENSE is not an error */

		/* If we set cc then ATA pass-through will cause a
		 * check condition even if no error. Filter that. */
		if (cmd_result & SAM_STAT_CHECK_CONDITION) {
			struct scsi_sense_hdr sshdr;
			scsi_normalize_sense(sensebuf, SCSI_SENSE_BUFFERSIZE,
						&sshdr);
			if (sshdr.sense_key==0 &&
				sshdr.asc==0 && sshdr.ascq==0)
				cmd_result &= ~SAM_STAT_CHECK_CONDITION;
		}

		/* Send userspace ATA registers */
		if (sensebuf[0] == 0x72 &&	/* format is "descriptor" */
				desc[0] == 0x09) {/* code is "ATA Descriptor" */
			args[0] = desc[13];	/* status */
			args[1] = desc[3];	/* error */
			args[2] = desc[5];	/* sector count (0:7) */
			args[3] = desc[7];	/* lbal */
			args[4] = desc[9];	/* lbam */
			args[5] = desc[11];	/* lbah */
			args[6] = desc[12];	/* select */
			if (copy_to_user(arg, args, sizeof(args)))
				rc = -EFAULT;
		}
	}

	if (cmd_result) {
375
		rc = -EIO;
376 377
		goto error;
	}
378

379 380
 error:
	kfree(sensebuf);
381 382 383
	return rc;
}

L
Linus Torvalds 已提交
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
int ata_scsi_ioctl(struct scsi_device *scsidev, int cmd, void __user *arg)
{
	int val = -EINVAL, rc = -EINVAL;

	switch (cmd) {
	case ATA_IOC_GET_IO32:
		val = 0;
		if (copy_to_user(arg, &val, 1))
			return -EFAULT;
		return 0;

	case ATA_IOC_SET_IO32:
		val = (unsigned long) arg;
		if (val != 0)
			return -EINVAL;
		return 0;

T
Tejun Heo 已提交
401 402 403
	case HDIO_GET_IDENTITY:
		return ata_get_identity(scsidev, arg);

404 405 406 407 408 409 410 411 412 413
	case HDIO_DRIVE_CMD:
		if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
			return -EACCES;
		return ata_cmd_ioctl(scsidev, arg);

	case HDIO_DRIVE_TASK:
		if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
			return -EACCES;
		return ata_task_ioctl(scsidev, arg);

L
Linus Torvalds 已提交
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
	default:
		rc = -ENOTTY;
		break;
	}

	return rc;
}

/**
 *	ata_scsi_qc_new - acquire new ata_queued_cmd reference
 *	@dev: ATA device to which the new command is attached
 *	@cmd: SCSI command that originated this ATA command
 *	@done: SCSI command completion function
 *
 *	Obtain a reference to an unused ata_queued_cmd structure,
 *	which is the basic libata structure representing a single
 *	ATA command sent to the hardware.
 *
 *	If a command was available, fill in the SCSI-specific
 *	portions of the structure with information on the
 *	current command.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
437
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
438 439 440 441
 *
 *	RETURNS:
 *	Command allocated, or %NULL if none available.
 */
442 443 444
static struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
					      struct scsi_cmnd *cmd,
					      void (*done)(struct scsi_cmnd *))
L
Linus Torvalds 已提交
445 446 447
{
	struct ata_queued_cmd *qc;

T
Tejun Heo 已提交
448
	qc = ata_qc_new_init(dev);
L
Linus Torvalds 已提交
449 450 451 452 453
	if (qc) {
		qc->scsicmd = cmd;
		qc->scsidone = done;

		if (cmd->use_sg) {
454
			qc->__sg = (struct scatterlist *) cmd->request_buffer;
L
Linus Torvalds 已提交
455
			qc->n_elem = cmd->use_sg;
B
Brian King 已提交
456
		} else if (cmd->request_bufflen) {
457
			qc->__sg = &qc->sgent;
L
Linus Torvalds 已提交
458 459 460 461 462 463 464 465 466 467
			qc->n_elem = 1;
		}
	} else {
		cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
		done(cmd);
	}

	return qc;
}

468 469 470 471 472 473 474 475 476 477 478 479
/**
 *	ata_dump_status - user friendly display of error info
 *	@id: id of the port in question
 *	@tf: ptr to filled out taskfile
 *
 *	Decode and dump the ATA error/status registers for the user so
 *	that they have some idea what really happened at the non
 *	make-believe layer.
 *
 *	LOCKING:
 *	inherited from caller
 */
480
static void ata_dump_status(unsigned id, struct ata_taskfile *tf)
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
{
	u8 stat = tf->command, err = tf->feature;

	printk(KERN_WARNING "ata%u: status=0x%02x { ", id, stat);
	if (stat & ATA_BUSY) {
		printk("Busy }\n");	/* Data is not valid in this case */
	} else {
		if (stat & 0x40)	printk("DriveReady ");
		if (stat & 0x20)	printk("DeviceFault ");
		if (stat & 0x10)	printk("SeekComplete ");
		if (stat & 0x08)	printk("DataRequest ");
		if (stat & 0x04)	printk("CorrectedError ");
		if (stat & 0x02)	printk("Index ");
		if (stat & 0x01)	printk("Error ");
		printk("}\n");

		if (err) {
			printk(KERN_WARNING "ata%u: error=0x%02x { ", id, err);
			if (err & 0x04)		printk("DriveStatusError ");
			if (err & 0x80) {
				if (err & 0x04)	printk("BadCRC ");
				else		printk("Sector ");
			}
			if (err & 0x40)		printk("UncorrectableError ");
			if (err & 0x10)		printk("SectorIdNotFound ");
			if (err & 0x02)		printk("TrackZeroNotFound ");
			if (err & 0x01)		printk("AddrMarkNotFound ");
			printk("}\n");
		}
	}
}

513 514 515
/**
 *	ata_scsi_device_suspend - suspend ATA device associated with sdev
 *	@sdev: the SCSI device to suspend
516
 *	@mesg: target power management message
517 518 519 520 521 522 523 524 525 526
 *
 *	Request suspend EH action on the ATA device associated with
 *	@sdev and wait for the operation to complete.
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 *
 *	RETURNS:
 *	0 on success, -errno otherwise.
 */
527
int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t mesg)
J
Jens Axboe 已提交
528
{
529
	struct ata_port *ap = ata_shost_to_port(sdev->host);
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
	struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
	unsigned long flags;
	unsigned int action;
	int rc = 0;

	if (!dev)
		goto out;

	spin_lock_irqsave(ap->lock, flags);

	/* wait for the previous resume to complete */
	while (dev->flags & ATA_DFLAG_SUSPENDED) {
		spin_unlock_irqrestore(ap->lock, flags);
		ata_port_wait_eh(ap);
		spin_lock_irqsave(ap->lock, flags);
	}

	/* if @sdev is already detached, nothing to do */
	if (sdev->sdev_state == SDEV_OFFLINE ||
	    sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
		goto out_unlock;

	/* request suspend */
	action = ATA_EH_SUSPEND;
554
	if (mesg.event != PM_EVENT_SUSPEND)
555 556 557 558 559 560
		action |= ATA_EH_PM_FREEZE;
	ap->eh_info.dev_action[dev->devno] |= action;
	ap->eh_info.flags |= ATA_EHI_QUIET;
	ata_port_schedule_eh(ap);

	spin_unlock_irqrestore(ap->lock, flags);
J
Jens Axboe 已提交
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
	/* wait for EH to do the job */
	ata_port_wait_eh(ap);

	spin_lock_irqsave(ap->lock, flags);

	/* If @sdev is still attached but the associated ATA device
	 * isn't suspended, the operation failed.
	 */
	if (sdev->sdev_state != SDEV_OFFLINE &&
	    sdev->sdev_state != SDEV_CANCEL && sdev->sdev_state != SDEV_DEL &&
	    !(dev->flags & ATA_DFLAG_SUSPENDED))
		rc = -EIO;

 out_unlock:
	spin_unlock_irqrestore(ap->lock, flags);
 out:
	if (rc == 0)
579
		sdev->sdev_gendev.power.power_state = mesg;
580
	return rc;
J
Jens Axboe 已提交
581 582
}

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
/**
 *	ata_scsi_device_resume - resume ATA device associated with sdev
 *	@sdev: the SCSI device to resume
 *
 *	Request resume EH action on the ATA device associated with
 *	@sdev and return immediately.  This enables parallel
 *	wakeup/spinup of devices.
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 *
 *	RETURNS:
 *	0.
 */
int ata_scsi_device_resume(struct scsi_device *sdev)
J
Jens Axboe 已提交
598
{
599
	struct ata_port *ap = ata_shost_to_port(sdev->host);
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
	struct ata_device *dev = ata_scsi_find_dev(ap, sdev);
	struct ata_eh_info *ehi = &ap->eh_info;
	unsigned long flags;
	unsigned int action;

	if (!dev)
		goto out;

	spin_lock_irqsave(ap->lock, flags);

	/* if @sdev is already detached, nothing to do */
	if (sdev->sdev_state == SDEV_OFFLINE ||
	    sdev->sdev_state == SDEV_CANCEL || sdev->sdev_state == SDEV_DEL)
		goto out_unlock;

	/* request resume */
	action = ATA_EH_RESUME;
	if (sdev->sdev_gendev.power.power_state.event == PM_EVENT_SUSPEND)
		__ata_ehi_hotplugged(ehi);
	else
		action |= ATA_EH_PM_FREEZE | ATA_EH_SOFTRESET;
	ehi->dev_action[dev->devno] |= action;

	/* We don't want autopsy and verbose EH messages.  Disable
	 * those if we're the only device on this link.
	 */
	if (ata_port_max_devices(ap) == 1)
		ehi->flags |= ATA_EHI_NO_AUTOPSY | ATA_EHI_QUIET;

	ata_port_schedule_eh(ap);

 out_unlock:
	spin_unlock_irqrestore(ap->lock, flags);
 out:
	sdev->sdev_gendev.power.power_state = PMSG_ON;
	return 0;
J
Jens Axboe 已提交
636 637
}

L
Linus Torvalds 已提交
638 639
/**
 *	ata_to_sense_error - convert ATA error to SCSI error
R
Randy Dunlap 已提交
640
 *	@id: ATA device number
L
Linus Torvalds 已提交
641
 *	@drv_stat: value contained in ATA status register
642 643 644 645
 *	@drv_err: value contained in ATA error register
 *	@sk: the sense key we'll fill out
 *	@asc: the additional sense code we'll fill out
 *	@ascq: the additional sense code qualifier we'll fill out
646
 *	@verbose: be verbose
L
Linus Torvalds 已提交
647
 *
648 649 650
 *	Converts an ATA error into a SCSI error.  Fill out pointers to
 *	SK, ASC, and ASCQ bytes for later use in fixed or descriptor
 *	format sense blocks.
L
Linus Torvalds 已提交
651 652
 *
 *	LOCKING:
J
Jeff Garzik 已提交
653
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
654
 */
655 656
static void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk,
			       u8 *asc, u8 *ascq, int verbose)
L
Linus Torvalds 已提交
657
{
658
	int i;
J
Jeff Garzik 已提交
659

L
Linus Torvalds 已提交
660
	/* Based on the 3ware driver translation table */
661
	static const unsigned char sense_table[][4] = {
L
Linus Torvalds 已提交
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
		/* BBD|ECC|ID|MAR */
		{0xd1, 		ABORTED_COMMAND, 0x00, 0x00}, 	// Device busy                  Aborted command
		/* BBD|ECC|ID */
		{0xd0,  	ABORTED_COMMAND, 0x00, 0x00}, 	// Device busy                  Aborted command
		/* ECC|MC|MARK */
		{0x61, 		HARDWARE_ERROR, 0x00, 0x00}, 	// Device fault                 Hardware error
		/* ICRC|ABRT */		/* NB: ICRC & !ABRT is BBD */
		{0x84, 		ABORTED_COMMAND, 0x47, 0x00}, 	// Data CRC error               SCSI parity error
		/* MC|ID|ABRT|TRK0|MARK */
		{0x37, 		NOT_READY, 0x04, 0x00}, 	// Unit offline                 Not ready
		/* MCR|MARK */
		{0x09, 		NOT_READY, 0x04, 0x00}, 	// Unrecovered disk error       Not ready
		/*  Bad address mark */
		{0x01, 		MEDIUM_ERROR, 0x13, 0x00}, 	// Address mark not found       Address mark not found for data field
		/* TRK0 */
		{0x02, 		HARDWARE_ERROR, 0x00, 0x00}, 	// Track 0 not found		  Hardware error
		/* Abort & !ICRC */
		{0x04, 		ABORTED_COMMAND, 0x00, 0x00}, 	// Aborted command              Aborted command
		/* Media change request */
		{0x08, 		NOT_READY, 0x04, 0x00}, 	// Media change request	  FIXME: faking offline
		/* SRV */
		{0x10, 		ABORTED_COMMAND, 0x14, 0x00}, 	// ID not found                 Recorded entity not found
		/* Media change */
		{0x08,  	NOT_READY, 0x04, 0x00}, 	// Media change		  FIXME: faking offline
		/* ECC */
		{0x40, 		MEDIUM_ERROR, 0x11, 0x04}, 	// Uncorrectable ECC error      Unrecovered read error
		/* BBD - block marked bad */
		{0x80, 		MEDIUM_ERROR, 0x11, 0x04}, 	// Block marked bad		  Medium error, unrecovered read error
		{0xFF, 0xFF, 0xFF, 0xFF}, // END mark
	};
692
	static const unsigned char stat_table[][4] = {
L
Linus Torvalds 已提交
693 694 695 696 697 698 699 700 701 702 703
		/* Must be first because BUSY means no other bits valid */
		{0x80, 		ABORTED_COMMAND, 0x47, 0x00},	// Busy, fake parity for now
		{0x20, 		HARDWARE_ERROR,  0x00, 0x00}, 	// Device fault
		{0x08, 		ABORTED_COMMAND, 0x47, 0x00},	// Timed out in xfer, fake parity for now
		{0x04, 		RECOVERED_ERROR, 0x11, 0x00},	// Recovered ECC error	  Medium error, recovered
		{0xFF, 0xFF, 0xFF, 0xFF}, // END mark
	};

	/*
	 *	Is this an error we can process/parse
	 */
704 705
	if (drv_stat & ATA_BUSY) {
		drv_err = 0;	/* Ignore the err bits, they're invalid */
L
Linus Torvalds 已提交
706
	}
707 708 709 710 711

	if (drv_err) {
		/* Look for drv_err */
		for (i = 0; sense_table[i][0] != 0xFF; i++) {
			/* Look for best matches first */
712
			if ((sense_table[i][0] & drv_err) ==
713 714 715 716 717 718 719 720
			    sense_table[i][0]) {
				*sk = sense_table[i][1];
				*asc = sense_table[i][2];
				*ascq = sense_table[i][3];
				goto translate_done;
			}
		}
		/* No immediate match */
721 722 723
		if (verbose)
			printk(KERN_WARNING "ata%u: no sense translation for "
			       "error 0x%02x\n", id, drv_err);
L
Linus Torvalds 已提交
724
	}
725 726 727 728 729 730 731 732

	/* Fall back to interpreting status bits */
	for (i = 0; stat_table[i][0] != 0xFF; i++) {
		if (stat_table[i][0] & drv_stat) {
			*sk = stat_table[i][1];
			*asc = stat_table[i][2];
			*ascq = stat_table[i][3];
			goto translate_done;
L
Linus Torvalds 已提交
733
		}
734 735
	}
	/* No error?  Undecoded? */
736 737 738
	if (verbose)
		printk(KERN_WARNING "ata%u: no sense translation for "
		       "status: 0x%02x\n", id, drv_stat);
739

740 741 742 743 744
	/* We need a sensible error return here, which is tricky, and one
	   that won't cause people to do things like return a disk wrongly */
	*sk = ABORTED_COMMAND;
	*asc = 0x00;
	*ascq = 0x00;
745 746

 translate_done:
747 748 749 750
	if (verbose)
		printk(KERN_ERR "ata%u: translated ATA stat/err 0x%02x/%02x "
		       "to SCSI SK/ASC/ASCQ 0x%x/%02x/%02x\n",
		       id, drv_stat, drv_err, *sk, *asc, *ascq);
751 752 753 754
	return;
}

/*
755
 *	ata_gen_passthru_sense - Generate check condition sense block.
756 757 758 759 760 761 762 763 764
 *	@qc: Command that completed.
 *
 *	This function is specific to the ATA descriptor format sense
 *	block specified for the ATA pass through commands.  Regardless
 *	of whether the command errored or not, return a sense
 *	block. Copy all controller registers into the sense
 *	block. Clear sense key, ASC & ASCQ if there is no error.
 *
 *	LOCKING:
765
 *	None.
766
 */
767
static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
768 769
{
	struct scsi_cmnd *cmd = qc->scsicmd;
770
	struct ata_taskfile *tf = &qc->result_tf;
771 772
	unsigned char *sb = cmd->sense_buffer;
	unsigned char *desc = sb + 8;
773
	int verbose = qc->ap->ops->error_handler == NULL;
774 775 776

	memset(sb, 0, SCSI_SENSE_BUFFERSIZE);

777
	cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
778 779 780 781 782

	/*
	 * Use ata_to_sense_error() to map status register bits
	 * onto sense key, asc & ascq.
	 */
783 784
	if (qc->err_mask ||
	    tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
785
		ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
786
				   &sb[1], &sb[2], &sb[3], verbose);
787
		sb[1] &= 0x0f;
L
Linus Torvalds 已提交
788 789
	}

790 791 792 793
	/*
	 * Sense data is current and format is descriptor.
	 */
	sb[0] = 0x72;
L
Linus Torvalds 已提交
794

795 796
	desc[0] = 0x09;

797 798 799
	/* set length of additional sense data */
	sb[7] = 14;
	desc[1] = 12;
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822

	/*
	 * Copy registers into sense buffer.
	 */
	desc[2] = 0x00;
	desc[3] = tf->feature;	/* == error reg */
	desc[5] = tf->nsect;
	desc[7] = tf->lbal;
	desc[9] = tf->lbam;
	desc[11] = tf->lbah;
	desc[12] = tf->device;
	desc[13] = tf->command; /* == status reg */

	/*
	 * Fill in Extend bit, and the high order bytes
	 * if applicable.
	 */
	if (tf->flags & ATA_TFLAG_LBA48) {
		desc[2] |= 0x01;
		desc[4] = tf->hob_nsect;
		desc[6] = tf->hob_lbal;
		desc[8] = tf->hob_lbam;
		desc[10] = tf->hob_lbah;
L
Linus Torvalds 已提交
823
	}
824
}
L
Linus Torvalds 已提交
825

826
/**
827
 *	ata_gen_ata_sense - generate a SCSI fixed sense block
828 829
 *	@qc: Command that we are erroring out
 *
830 831
 *	Generate sense block for a failed ATA command @qc.  Descriptor
 *	format is used to accomodate LBA48 block address.
832 833
 *
 *	LOCKING:
834
 *	None.
835
 */
836
static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
837
{
838
	struct ata_device *dev = qc->dev;
839
	struct scsi_cmnd *cmd = qc->scsicmd;
840
	struct ata_taskfile *tf = &qc->result_tf;
841
	unsigned char *sb = cmd->sense_buffer;
842
	unsigned char *desc = sb + 8;
843
	int verbose = qc->ap->ops->error_handler == NULL;
844
	u64 block;
845 846 847

	memset(sb, 0, SCSI_SENSE_BUFFERSIZE);

848
	cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
849

850 851 852 853
	/* sense data is current and format is descriptor */
	sb[0] = 0x72;

	/* Use ata_to_sense_error() to map status register bits
854 855
	 * onto sense key, asc & ascq.
	 */
856 857
	if (qc->err_mask ||
	    tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
858
		ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
859 860
				   &sb[1], &sb[2], &sb[3], verbose);
		sb[1] &= 0x0f;
L
Linus Torvalds 已提交
861 862
	}

863
	block = ata_tf_read_block(&qc->result_tf, dev);
864

865 866 867 868
	/* information sense data descriptor */
	sb[7] = 12;
	desc[0] = 0x00;
	desc[1] = 10;
869

870 871 872 873 874 875 876
	desc[2] |= 0x80;	/* valid */
	desc[6] = block >> 40;
	desc[7] = block >> 32;
	desc[8] = block >> 24;
	desc[9] = block >> 16;
	desc[10] = block >> 8;
	desc[11] = block;
L
Linus Torvalds 已提交
877 878
}

879 880 881 882 883 884 885 886 887
static void ata_scsi_sdev_config(struct scsi_device *sdev)
{
	sdev->use_10_for_rw = 1;
	sdev->use_10_for_ms = 1;
}

static void ata_scsi_dev_config(struct scsi_device *sdev,
				struct ata_device *dev)
{
888 889
	/* configure max sectors */
	blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
890

891
	/* SATA DMA transfers must be multiples of 4 byte, so
892 893 894 895 896 897 898
	 * we need to pad ATAPI transfers using an extra sg.
	 * Decrement max hw segments accordingly.
	 */
	if (dev->class == ATA_DEV_ATAPI) {
		request_queue_t *q = sdev->request_queue;
		blk_queue_max_hw_segments(q, q->max_hw_segments - 1);
	}
899 900 901 902 903 904 905 906

	if (dev->flags & ATA_DFLAG_NCQ) {
		int depth;

		depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
		depth = min(ATA_MAX_QUEUE - 1, depth);
		scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, depth);
	}
907 908
}

L
Linus Torvalds 已提交
909 910 911 912 913 914 915 916 917 918 919 920 921 922
/**
 *	ata_scsi_slave_config - Set SCSI device attributes
 *	@sdev: SCSI device to examine
 *
 *	This is called before we actually start reading
 *	and writing to the device, to configure certain
 *	SCSI mid-layer behaviors.
 *
 *	LOCKING:
 *	Defined by SCSI layer.  We don't really care.
 */

int ata_scsi_slave_config(struct scsi_device *sdev)
{
923 924 925
	struct ata_port *ap = ata_shost_to_port(sdev->host);
	struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);

926
	ata_scsi_sdev_config(sdev);
L
Linus Torvalds 已提交
927 928 929

	blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);

930
	if (dev)
931
		ata_scsi_dev_config(sdev, dev);
L
Linus Torvalds 已提交
932 933 934 935

	return 0;	/* scsi layer doesn't check return value, sigh */
}

936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
/**
 *	ata_scsi_slave_destroy - SCSI device is about to be destroyed
 *	@sdev: SCSI device to be destroyed
 *
 *	@sdev is about to be destroyed for hot/warm unplugging.  If
 *	this unplugging was initiated by libata as indicated by NULL
 *	dev->sdev, this function doesn't have to do anything.
 *	Otherwise, SCSI layer initiated warm-unplug is in progress.
 *	Clear dev->sdev, schedule the device for ATA detach and invoke
 *	EH.
 *
 *	LOCKING:
 *	Defined by SCSI layer.  We don't really care.
 */
void ata_scsi_slave_destroy(struct scsi_device *sdev)
{
	struct ata_port *ap = ata_shost_to_port(sdev->host);
	unsigned long flags;
	struct ata_device *dev;

	if (!ap->ops->error_handler)
		return;

959
	spin_lock_irqsave(ap->lock, flags);
960 961 962 963 964 965 966
	dev = __ata_scsi_find_dev(ap, sdev);
	if (dev && dev->sdev) {
		/* SCSI device already in CANCEL state, no need to offline it */
		dev->sdev = NULL;
		dev->flags |= ATA_DFLAG_DETACH;
		ata_port_schedule_eh(ap);
	}
967
	spin_unlock_irqrestore(ap->lock, flags);
968 969
}

970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988
/**
 *	ata_scsi_change_queue_depth - SCSI callback for queue depth config
 *	@sdev: SCSI device to configure queue depth for
 *	@queue_depth: new queue depth
 *
 *	This is libata standard hostt->change_queue_depth callback.
 *	SCSI will call into this callback when user tries to set queue
 *	depth via sysfs.
 *
 *	LOCKING:
 *	SCSI layer (we don't care)
 *
 *	RETURNS:
 *	Newly configured queue depth.
 */
int ata_scsi_change_queue_depth(struct scsi_device *sdev, int queue_depth)
{
	struct ata_port *ap = ata_shost_to_port(sdev->host);
	struct ata_device *dev;
989
	unsigned long flags;
990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
	int max_depth;

	if (queue_depth < 1)
		return sdev->queue_depth;

	dev = ata_scsi_find_dev(ap, sdev);
	if (!dev || !ata_dev_enabled(dev))
		return sdev->queue_depth;

	max_depth = min(sdev->host->can_queue, ata_id_queue_depth(dev->id));
	max_depth = min(ATA_MAX_QUEUE - 1, max_depth);
	if (queue_depth > max_depth)
		queue_depth = max_depth;

	scsi_adjust_queue_depth(sdev, MSG_SIMPLE_TAG, queue_depth);
1005 1006 1007 1008 1009 1010 1011 1012

	spin_lock_irqsave(ap->lock, flags);
	if (queue_depth > 1)
		dev->flags &= ~ATA_DFLAG_NCQ_OFF;
	else
		dev->flags |= ATA_DFLAG_NCQ_OFF;
	spin_unlock_irqrestore(ap->lock, flags);

1013 1014 1015
	return queue_depth;
}

1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
/**
 *	ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
 *	@qc: Storage for translated ATA taskfile
 *
 *	Sets up an ATA taskfile to issue STANDBY (to stop) or READ VERIFY
 *	(to start). Perhaps these commands should be preceded by
 *	CHECK POWER MODE to see what power mode the device is already in.
 *	[See SAT revision 5 at www.t10.org]
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1026
 *	spin_lock_irqsave(host lock)
1027 1028 1029 1030
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */
1031
static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc)
1032
{
1033
	struct scsi_cmnd *scmd = qc->scsicmd;
1034
	struct ata_taskfile *tf = &qc->tf;
1035
	const u8 *cdb = scmd->cmnd;
1036

1037 1038 1039
	if (scmd->cmd_len < 5)
		goto invalid_fld;

1040 1041
	tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
	tf->protocol = ATA_PROT_NODATA;
1042
	if (cdb[1] & 0x1) {
1043 1044
		;	/* ignore IMMED bit, violates sat-r05 */
	}
1045
	if (cdb[4] & 0x2)
1046
		goto invalid_fld;       /* LOEJ bit set not supported */
1047
	if (((cdb[4] >> 4) & 0xf) != 0)
1048
		goto invalid_fld;       /* power conditions not supported */
1049
	if (cdb[4] & 0x1) {
1050
		tf->nsect = 1;	/* 1 sector, lba=0 */
1051 1052

		if (qc->dev->flags & ATA_DFLAG_LBA) {
1053
			tf->flags |= ATA_TFLAG_LBA;
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065

			tf->lbah = 0x0;
			tf->lbam = 0x0;
			tf->lbal = 0x0;
			tf->device |= ATA_LBA;
		} else {
			/* CHS */
			tf->lbal = 0x1; /* sect */
			tf->lbam = 0x0; /* cyl low */
			tf->lbah = 0x0; /* cyl high */
		}

1066
		tf->command = ATA_CMD_VERIFY;	/* READ VERIFY */
1067 1068 1069 1070
	} else
		/* Issue ATA STANDBY IMMEDIATE command */
		tf->command = ATA_CMD_STANDBYNOW1;

1071 1072 1073 1074 1075 1076 1077 1078
	/*
	 * Standby and Idle condition timers could be implemented but that
	 * would require libata to implement the Power condition mode page
	 * and allow the user to change it. Changing mode pages requires
	 * MODE SELECT to be implemented.
	 */

	return 0;
1079 1080

invalid_fld:
1081
	ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1082 1083
	/* "Invalid field in cbd" */
	return 1;
1084 1085 1086
}


L
Linus Torvalds 已提交
1087 1088 1089 1090 1091 1092 1093 1094
/**
 *	ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
 *	@qc: Storage for translated ATA taskfile
 *
 *	Sets up an ATA taskfile to issue FLUSH CACHE or
 *	FLUSH CACHE EXT.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1095
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1096 1097 1098 1099
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */
1100
static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
1101 1102 1103 1104 1105 1106
{
	struct ata_taskfile *tf = &qc->tf;

	tf->flags |= ATA_TFLAG_DEVICE;
	tf->protocol = ATA_PROT_NODATA;

1107
	if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
L
Linus Torvalds 已提交
1108 1109 1110 1111 1112 1113 1114
		tf->command = ATA_CMD_FLUSH_EXT;
	else
		tf->command = ATA_CMD_FLUSH;

	return 0;
}

1115 1116
/**
 *	scsi_6_lba_len - Get LBA and transfer length
1117
 *	@cdb: SCSI command to translate
1118 1119 1120 1121 1122 1123 1124
 *
 *	Calculate LBA and transfer length for 6-byte commands.
 *
 *	RETURNS:
 *	@plba: the LBA
 *	@plen: the transfer length
 */
1125
static void scsi_6_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1126 1127 1128 1129 1130 1131
{
	u64 lba = 0;
	u32 len = 0;

	VPRINTK("six-byte command\n");

1132 1133
	lba |= ((u64)cdb[2]) << 8;
	lba |= ((u64)cdb[3]);
1134

1135
	len |= ((u32)cdb[4]);
1136 1137 1138 1139 1140 1141 1142

	*plba = lba;
	*plen = len;
}

/**
 *	scsi_10_lba_len - Get LBA and transfer length
1143
 *	@cdb: SCSI command to translate
1144 1145 1146 1147 1148 1149 1150
 *
 *	Calculate LBA and transfer length for 10-byte commands.
 *
 *	RETURNS:
 *	@plba: the LBA
 *	@plen: the transfer length
 */
1151
static void scsi_10_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1152 1153 1154 1155 1156 1157
{
	u64 lba = 0;
	u32 len = 0;

	VPRINTK("ten-byte command\n");

1158 1159 1160 1161
	lba |= ((u64)cdb[2]) << 24;
	lba |= ((u64)cdb[3]) << 16;
	lba |= ((u64)cdb[4]) << 8;
	lba |= ((u64)cdb[5]);
1162

1163 1164
	len |= ((u32)cdb[7]) << 8;
	len |= ((u32)cdb[8]);
1165 1166 1167 1168 1169 1170 1171

	*plba = lba;
	*plen = len;
}

/**
 *	scsi_16_lba_len - Get LBA and transfer length
1172
 *	@cdb: SCSI command to translate
1173 1174 1175 1176 1177 1178 1179
 *
 *	Calculate LBA and transfer length for 16-byte commands.
 *
 *	RETURNS:
 *	@plba: the LBA
 *	@plen: the transfer length
 */
1180
static void scsi_16_lba_len(const u8 *cdb, u64 *plba, u32 *plen)
1181 1182 1183 1184 1185 1186
{
	u64 lba = 0;
	u32 len = 0;

	VPRINTK("sixteen-byte command\n");

1187 1188 1189 1190 1191 1192 1193 1194
	lba |= ((u64)cdb[2]) << 56;
	lba |= ((u64)cdb[3]) << 48;
	lba |= ((u64)cdb[4]) << 40;
	lba |= ((u64)cdb[5]) << 32;
	lba |= ((u64)cdb[6]) << 24;
	lba |= ((u64)cdb[7]) << 16;
	lba |= ((u64)cdb[8]) << 8;
	lba |= ((u64)cdb[9]);
1195

1196 1197 1198 1199
	len |= ((u32)cdb[10]) << 24;
	len |= ((u32)cdb[11]) << 16;
	len |= ((u32)cdb[12]) << 8;
	len |= ((u32)cdb[13]);
1200 1201 1202 1203 1204

	*plba = lba;
	*plen = len;
}

L
Linus Torvalds 已提交
1205 1206 1207 1208 1209 1210 1211
/**
 *	ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
 *	@qc: Storage for translated ATA taskfile
 *
 *	Converts SCSI VERIFY command to an ATA READ VERIFY command.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1212
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1213 1214 1215 1216
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */
1217
static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
1218
{
1219
	struct scsi_cmnd *scmd = qc->scsicmd;
L
Linus Torvalds 已提交
1220
	struct ata_taskfile *tf = &qc->tf;
1221
	struct ata_device *dev = qc->dev;
L
Linus Torvalds 已提交
1222
	u64 dev_sectors = qc->dev->n_sectors;
1223
	const u8 *cdb = scmd->cmnd;
1224 1225
	u64 block;
	u32 n_block;
L
Linus Torvalds 已提交
1226 1227 1228 1229

	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
	tf->protocol = ATA_PROT_NODATA;

1230 1231 1232
	if (cdb[0] == VERIFY) {
		if (scmd->cmd_len < 10)
			goto invalid_fld;
1233
		scsi_10_lba_len(cdb, &block, &n_block);
1234 1235 1236
	} else if (cdb[0] == VERIFY_16) {
		if (scmd->cmd_len < 16)
			goto invalid_fld;
1237
		scsi_16_lba_len(cdb, &block, &n_block);
1238
	} else
1239
		goto invalid_fld;
L
Linus Torvalds 已提交
1240

1241
	if (!n_block)
1242
		goto nothing_to_do;
1243
	if (block >= dev_sectors)
1244
		goto out_of_range;
1245
	if ((block + n_block) > dev_sectors)
1246
		goto out_of_range;
L
Linus Torvalds 已提交
1247

1248 1249 1250
	if (dev->flags & ATA_DFLAG_LBA) {
		tf->flags |= ATA_TFLAG_LBA;

1251 1252 1253 1254 1255 1256 1257
		if (lba_28_ok(block, n_block)) {
			/* use LBA28 */
			tf->command = ATA_CMD_VERIFY;
			tf->device |= (block >> 24) & 0xf;
		} else if (lba_48_ok(block, n_block)) {
			if (!(dev->flags & ATA_DFLAG_LBA48))
				goto out_of_range;
1258 1259 1260

			/* use LBA48 */
			tf->flags |= ATA_TFLAG_LBA48;
1261
			tf->command = ATA_CMD_VERIFY_EXT;
L
Linus Torvalds 已提交
1262

1263
			tf->hob_nsect = (n_block >> 8) & 0xff;
L
Linus Torvalds 已提交
1264

1265 1266 1267
			tf->hob_lbah = (block >> 40) & 0xff;
			tf->hob_lbam = (block >> 32) & 0xff;
			tf->hob_lbal = (block >> 24) & 0xff;
1268 1269 1270
		} else
			/* request too large even for LBA48 */
			goto out_of_range;
1271 1272

		tf->nsect = n_block & 0xff;
L
Linus Torvalds 已提交
1273

1274 1275 1276
		tf->lbah = (block >> 16) & 0xff;
		tf->lbam = (block >> 8) & 0xff;
		tf->lbal = block & 0xff;
L
Linus Torvalds 已提交
1277

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

1283 1284
		if (!lba_28_ok(block, n_block))
			goto out_of_range;
1285

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

1292 1293
		DPRINTK("block %u track %u cyl %u head %u sect %u\n",
			(u32)block, track, cyl, head, sect);
1294 1295 1296

		/* Check whether the converted CHS can fit.
		   Cylinder: 0-65535
1297 1298
		   Head: 0-15
		   Sector: 1-255*/
1299
		if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1300
			goto out_of_range;
1301

1302 1303 1304 1305 1306 1307 1308
		tf->command = ATA_CMD_VERIFY;
		tf->nsect = n_block & 0xff; /* Sector count 0 means 256 sectors */
		tf->lbal = sect;
		tf->lbam = cyl;
		tf->lbah = cyl >> 8;
		tf->device |= head;
	}
L
Linus Torvalds 已提交
1309 1310

	return 0;
1311 1312

invalid_fld:
1313
	ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1314 1315 1316 1317
	/* "Invalid field in cbd" */
	return 1;

out_of_range:
1318
	ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1319 1320 1321 1322
	/* "Logical Block Address out of range" */
	return 1;

nothing_to_do:
1323
	scmd->result = SAM_STAT_GOOD;
1324
	return 1;
L
Linus Torvalds 已提交
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
}

/**
 *	ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
 *	@qc: Storage for translated ATA taskfile
 *
 *	Converts any of six SCSI read/write commands into the
 *	ATA counterpart, including starting sector (LBA),
 *	sector count, and taking into account the device's LBA48
 *	support.
 *
 *	Commands %READ_6, %READ_10, %READ_16, %WRITE_6, %WRITE_10, and
 *	%WRITE_16 are currently supported.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1340
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1341 1342 1343 1344
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */
1345
static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
1346
{
1347
	struct scsi_cmnd *scmd = qc->scsicmd;
1348
	const u8 *cdb = scmd->cmnd;
1349
	unsigned int tf_flags = 0;
1350 1351
	u64 block;
	u32 n_block;
1352
	int rc;
L
Linus Torvalds 已提交
1353

1354
	if (cdb[0] == WRITE_10 || cdb[0] == WRITE_6 || cdb[0] == WRITE_16)
1355
		tf_flags |= ATA_TFLAG_WRITE;
L
Linus Torvalds 已提交
1356

T
Tejun Heo 已提交
1357
	/* Calculate the SCSI LBA, transfer length and FUA. */
1358
	switch (cdb[0]) {
1359 1360
	case READ_10:
	case WRITE_10:
1361 1362
		if (unlikely(scmd->cmd_len < 10))
			goto invalid_fld;
1363 1364
		scsi_10_lba_len(cdb, &block, &n_block);
		if (unlikely(cdb[1] & (1 << 3)))
1365
			tf_flags |= ATA_TFLAG_FUA;
1366 1367 1368
		break;
	case READ_6:
	case WRITE_6:
1369 1370
		if (unlikely(scmd->cmd_len < 6))
			goto invalid_fld;
1371
		scsi_6_lba_len(cdb, &block, &n_block);
1372 1373 1374 1375

		/* for 6-byte r/w commands, transfer length 0
		 * means 256 blocks of data, not 0 block.
		 */
1376 1377
		if (!n_block)
			n_block = 256;
1378 1379 1380
		break;
	case READ_16:
	case WRITE_16:
1381 1382
		if (unlikely(scmd->cmd_len < 16))
			goto invalid_fld;
1383 1384
		scsi_16_lba_len(cdb, &block, &n_block);
		if (unlikely(cdb[1] & (1 << 3)))
1385
			tf_flags |= ATA_TFLAG_FUA;
1386 1387
		break;
	default:
1388
		DPRINTK("no-byte command\n");
1389
		goto invalid_fld;
L
Linus Torvalds 已提交
1390 1391
	}

1392 1393
	/* Check and compose ATA command */
	if (!n_block)
1394 1395 1396 1397
		/* For 10-byte and 16-byte SCSI R/W commands, transfer
		 * length 0 means transfer 0 block of data.
		 * However, for ATA R/W commands, sector count 0 means
		 * 256 or 65536 sectors, not 0 sectors as in SCSI.
A
Alan Cox 已提交
1398 1399
		 *
		 * WARNING: one or two older ATA drives treat 0 as 0...
1400
		 */
1401
		goto nothing_to_do;
L
Linus Torvalds 已提交
1402

1403
	qc->flags |= ATA_QCFLAG_IO;
T
Tejun Heo 已提交
1404
	qc->nbytes = n_block * ATA_SECT_SIZE;
L
Linus Torvalds 已提交
1405

1406 1407 1408 1409
	rc = ata_build_rw_tf(&qc->tf, qc->dev, block, n_block, tf_flags,
			     qc->tag);
	if (likely(rc == 0))
		return 0;
1410

1411 1412 1413
	if (rc == -ERANGE)
		goto out_of_range;
	/* treat all other errors as -EINVAL, fall through */
1414
invalid_fld:
1415
	ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x0);
1416 1417 1418 1419
	/* "Invalid field in cbd" */
	return 1;

out_of_range:
1420
	ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x21, 0x0);
1421 1422 1423 1424
	/* "Logical Block Address out of range" */
	return 1;

nothing_to_do:
1425
	scmd->result = SAM_STAT_GOOD;
1426
	return 1;
L
Linus Torvalds 已提交
1427 1428
}

1429
static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
1430
{
1431
	struct ata_port *ap = qc->ap;
L
Linus Torvalds 已提交
1432
	struct scsi_cmnd *cmd = qc->scsicmd;
1433
	u8 *cdb = cmd->cmnd;
1434
 	int need_sense = (qc->err_mask != 0);
1435

1436 1437 1438 1439
	/* We snoop the SET_FEATURES - Write Cache ON/OFF command, and
	 * schedule EH_REVALIDATE operation to update the IDENTIFY DEVICE
	 * cache
	 */
1440 1441
	if (ap->ops->error_handler &&
	    !need_sense && (qc->tf.command == ATA_CMD_SET_FEATURES) &&
1442 1443
	    ((qc->tf.feature == SETFEATURES_WC_ON) ||
	     (qc->tf.feature == SETFEATURES_WC_OFF))) {
1444 1445
		ap->eh_info.action |= ATA_EH_REVALIDATE;
		ata_port_schedule_eh(ap);
1446 1447
	}

1448 1449 1450 1451 1452 1453 1454
	/* For ATA pass thru (SAT) commands, generate a sense block if
	 * user mandated it or if there's an error.  Note that if we
	 * generate because the user forced us to, a check condition
	 * is generated and the ATA register values are returned
	 * whether the command completed successfully or not. If there
	 * was no error, SK, ASC and ASCQ will all be zero.
	 */
1455 1456
	if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
 	    ((cdb[2] & 0x20) || need_sense)) {
1457
		ata_gen_passthru_sense(qc);
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
	} else {
		if (!need_sense) {
			cmd->result = SAM_STAT_GOOD;
		} else {
			/* TODO: decide which descriptor format to use
			 * for 48b LBA devices and call that here
			 * instead of the fixed desc, which is only
			 * good for smaller LBA (and maybe CHS?)
			 * devices.
			 */
1468
			ata_gen_ata_sense(qc);
1469 1470
		}
	}
L
Linus Torvalds 已提交
1471

1472 1473
	if (need_sense && !ap->ops->error_handler)
		ata_dump_status(ap->id, &qc->result_tf);
L
Linus Torvalds 已提交
1474 1475 1476

	qc->scsidone(cmd);

1477
	ata_qc_free(qc);
L
Linus Torvalds 已提交
1478 1479
}

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
/**
 *	ata_scmd_need_defer - Check whether we need to defer scmd
 *	@dev: ATA device to which the command is addressed
 *	@is_io: Is the command IO (and thus possibly NCQ)?
 *
 *	NCQ and non-NCQ commands cannot run together.  As upper layer
 *	only knows the queue depth, we are responsible for maintaining
 *	exclusion.  This function checks whether a new command can be
 *	issued to @dev.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1491
 *	spin_lock_irqsave(host lock)
1492 1493 1494 1495 1496 1497 1498
 *
 *	RETURNS:
 *	1 if deferring is needed, 0 otherwise.
 */
static int ata_scmd_need_defer(struct ata_device *dev, int is_io)
{
	struct ata_port *ap = dev->ap;
T
Tejun Heo 已提交
1499
	int is_ncq = is_io && ata_ncq_enabled(dev);
1500

T
Tejun Heo 已提交
1501
	if (is_ncq) {
1502 1503 1504 1505 1506 1507 1508 1509 1510
		if (!ata_tag_valid(ap->active_tag))
			return 0;
	} else {
		if (!ata_tag_valid(ap->active_tag) && !ap->sactive)
			return 0;
	}
	return 1;
}

L
Linus Torvalds 已提交
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
/**
 *	ata_scsi_translate - Translate then issue SCSI command to ATA device
 *	@dev: ATA device to which the command is addressed
 *	@cmd: SCSI command to execute
 *	@done: SCSI command completion function
 *	@xlat_func: Actor which translates @cmd to an ATA taskfile
 *
 *	Our ->queuecommand() function has decided that the SCSI
 *	command issued can be directly translated into an ATA
 *	command, rather than handled internally.
 *
 *	This function sets up an ata_queued_cmd structure for the
 *	SCSI command, and sends that ata_queued_cmd to the hardware.
 *
1525 1526 1527 1528 1529 1530
 *	The xlat_func argument (actor) returns 0 if ready to execute
 *	ATA command, else 1 to finish translation. If 1 is returned
 *	then cmd->result (and possibly cmd->sense_buffer) are assumed
 *	to be set reflecting an error condition or clean (early)
 *	termination.
 *
L
Linus Torvalds 已提交
1531
 *	LOCKING:
J
Jeff Garzik 已提交
1532
 *	spin_lock_irqsave(host lock)
1533 1534 1535 1536
 *
 *	RETURNS:
 *	0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
 *	needs to be deferred.
L
Linus Torvalds 已提交
1537
 */
1538 1539 1540
static int ata_scsi_translate(struct ata_device *dev, struct scsi_cmnd *cmd,
			      void (*done)(struct scsi_cmnd *),
			      ata_xlat_func_t xlat_func)
L
Linus Torvalds 已提交
1541 1542
{
	struct ata_queued_cmd *qc;
1543
	int is_io = xlat_func == ata_scsi_rw_xlat;
L
Linus Torvalds 已提交
1544 1545 1546

	VPRINTK("ENTER\n");

1547 1548 1549
	if (unlikely(ata_scmd_need_defer(dev, is_io)))
		goto defer;

T
Tejun Heo 已提交
1550
	qc = ata_scsi_qc_new(dev, cmd, done);
L
Linus Torvalds 已提交
1551
	if (!qc)
1552
		goto err_mem;
L
Linus Torvalds 已提交
1553 1554

	/* data is present; dma-map it */
1555 1556
	if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
	    cmd->sc_data_direction == DMA_TO_DEVICE) {
L
Linus Torvalds 已提交
1557
		if (unlikely(cmd->request_bufflen < 1)) {
1558 1559
			ata_dev_printk(dev, KERN_WARNING,
				       "WARNING: zero len r/w req\n");
1560
			goto err_did;
L
Linus Torvalds 已提交
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
		}

		if (cmd->use_sg)
			ata_sg_init(qc, cmd->request_buffer, cmd->use_sg);
		else
			ata_sg_init_one(qc, cmd->request_buffer,
					cmd->request_bufflen);

		qc->dma_dir = cmd->sc_data_direction;
	}

	qc->complete_fn = ata_scsi_qc_complete;

1574
	if (xlat_func(qc))
1575
		goto early_finish;
L
Linus Torvalds 已提交
1576 1577

	/* select device, send command to hardware */
1578
	ata_qc_issue(qc);
L
Linus Torvalds 已提交
1579 1580

	VPRINTK("EXIT\n");
1581
	return 0;
L
Linus Torvalds 已提交
1582

1583 1584 1585 1586
early_finish:
        ata_qc_free(qc);
	done(cmd);
	DPRINTK("EXIT - early finish (good or error)\n");
1587
	return 0;
1588 1589

err_did:
L
Linus Torvalds 已提交
1590
	ata_qc_free(qc);
1591 1592
	cmd->result = (DID_ERROR << 16);
	done(cmd);
1593
err_mem:
1594
	DPRINTK("EXIT - internal\n");
1595
	return 0;
1596 1597 1598 1599

defer:
	DPRINTK("EXIT - defer\n");
	return SCSI_MLQUEUE_DEVICE_BUSY;
L
Linus Torvalds 已提交
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
}

/**
 *	ata_scsi_rbuf_get - Map response buffer.
 *	@cmd: SCSI command containing buffer to be mapped.
 *	@buf_out: Pointer to mapped area.
 *
 *	Maps buffer contained within SCSI command @cmd.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1610
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624
 *
 *	RETURNS:
 *	Length of response buffer.
 */

static unsigned int ata_scsi_rbuf_get(struct scsi_cmnd *cmd, u8 **buf_out)
{
	u8 *buf;
	unsigned int buflen;

	if (cmd->use_sg) {
		struct scatterlist *sg;

		sg = (struct scatterlist *) cmd->request_buffer;
1625
		buf = kmap_atomic(sg->page, KM_IRQ0) + sg->offset;
L
Linus Torvalds 已提交
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
		buflen = sg->length;
	} else {
		buf = cmd->request_buffer;
		buflen = cmd->request_bufflen;
	}

	*buf_out = buf;
	return buflen;
}

/**
 *	ata_scsi_rbuf_put - Unmap response buffer.
 *	@cmd: SCSI command containing buffer to be unmapped.
 *	@buf: buffer to unmap
 *
 *	Unmaps response buffer contained within @cmd.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1644
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1645 1646 1647 1648 1649 1650 1651 1652
 */

static inline void ata_scsi_rbuf_put(struct scsi_cmnd *cmd, u8 *buf)
{
	if (cmd->use_sg) {
		struct scatterlist *sg;

		sg = (struct scatterlist *) cmd->request_buffer;
1653
		kunmap_atomic(buf - sg->offset, KM_IRQ0);
L
Linus Torvalds 已提交
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
	}
}

/**
 *	ata_scsi_rbuf_fill - wrapper for SCSI command simulators
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@actor: Callback hook for desired SCSI command simulator
 *
 *	Takes care of the hard work of simulating a SCSI command...
 *	Mapping the response buffer, calling the command's handler,
 *	and handling the handler's return value.  This return value
 *	indicates whether the handler wishes the SCSI command to be
1666 1667
 *	completed successfully (0), or not (in which case cmd->result
 *	and sense buffer are assumed to be set).
L
Linus Torvalds 已提交
1668 1669
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1670
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
 */

void ata_scsi_rbuf_fill(struct ata_scsi_args *args,
		        unsigned int (*actor) (struct ata_scsi_args *args,
			     		   u8 *rbuf, unsigned int buflen))
{
	u8 *rbuf;
	unsigned int buflen, rc;
	struct scsi_cmnd *cmd = args->cmd;

	buflen = ata_scsi_rbuf_get(cmd, &rbuf);
	memset(rbuf, 0, buflen);
	rc = actor(args, rbuf, buflen);
	ata_scsi_rbuf_put(cmd, rbuf);

1686
	if (rc == 0)
L
Linus Torvalds 已提交
1687
		cmd->result = SAM_STAT_GOOD;
1688
	args->done(cmd);
L
Linus Torvalds 已提交
1689 1690
}

1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706
/**
 *	ATA_SCSI_RBUF_SET - helper to set values in SCSI response buffer
 *	@idx: byte index into SCSI response buffer
 *	@val: value to set
 *
 *	To be used by SCSI command simulator functions.  This macros
 *	expects two local variables, u8 *rbuf and unsigned int buflen,
 *	are in scope.
 *
 *	LOCKING:
 *	None.
 */
#define ATA_SCSI_RBUF_SET(idx, val) do { \
		if ((idx) < buflen) rbuf[(idx)] = (u8)(val); \
	} while (0)

L
Linus Torvalds 已提交
1707 1708 1709 1710 1711 1712 1713
/**
 *	ata_scsiop_inq_std - Simulate INQUIRY command
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
 *	Returns standard device identification data associated
J
Jeff Garzik 已提交
1714
 *	with non-VPD INQUIRY command output.
L
Linus Torvalds 已提交
1715 1716
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1717
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740
 */

unsigned int ata_scsiop_inq_std(struct ata_scsi_args *args, u8 *rbuf,
			       unsigned int buflen)
{
	u8 hdr[] = {
		TYPE_DISK,
		0,
		0x5,	/* claim SPC-3 version compatibility */
		2,
		95 - 4
	};

	/* set scsi removeable (RMB) bit per ata bit */
	if (ata_id_removeable(args->id))
		hdr[1] |= (1 << 7);

	VPRINTK("ENTER\n");

	memcpy(rbuf, hdr, sizeof(hdr));

	if (buflen > 35) {
		memcpy(&rbuf[8], "ATA     ", 8);
1741 1742
		ata_id_string(args->id, &rbuf[16], ATA_ID_PROD, 16);
		ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV, 4);
L
Linus Torvalds 已提交
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
		if (rbuf[32] == 0 || rbuf[32] == ' ')
			memcpy(&rbuf[32], "n/a ", 4);
	}

	if (buflen > 63) {
		const u8 versions[] = {
			0x60,	/* SAM-3 (no version claimed) */

			0x03,
			0x20,	/* SBC-2 (no version claimed) */

			0x02,
			0x60	/* SPC-3 (no version claimed) */
		};

		memcpy(rbuf + 59, versions, sizeof(versions));
	}

	return 0;
}

/**
J
Jeff Garzik 已提交
1765
 *	ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
L
Linus Torvalds 已提交
1766 1767 1768 1769
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
J
Jeff Garzik 已提交
1770
 *	Returns list of inquiry VPD pages available.
L
Linus Torvalds 已提交
1771 1772
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1773
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
 */

unsigned int ata_scsiop_inq_00(struct ata_scsi_args *args, u8 *rbuf,
			      unsigned int buflen)
{
	const u8 pages[] = {
		0x00,	/* page 0x00, this page */
		0x80,	/* page 0x80, unit serial no page */
		0x83	/* page 0x83, device ident page */
	};
J
Jeff Garzik 已提交
1784
	rbuf[3] = sizeof(pages);	/* number of supported VPD pages */
L
Linus Torvalds 已提交
1785 1786 1787 1788 1789 1790 1791 1792

	if (buflen > 6)
		memcpy(rbuf + 4, pages, sizeof(pages));

	return 0;
}

/**
J
Jeff Garzik 已提交
1793
 *	ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
L
Linus Torvalds 已提交
1794 1795 1796 1797 1798 1799 1800
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
 *	Returns ATA device serial number.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1801
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1802 1803 1804 1805 1806 1807 1808 1809 1810
 */

unsigned int ata_scsiop_inq_80(struct ata_scsi_args *args, u8 *rbuf,
			      unsigned int buflen)
{
	const u8 hdr[] = {
		0,
		0x80,			/* this page code */
		0,
1811
		ATA_ID_SERNO_LEN,	/* page len */
L
Linus Torvalds 已提交
1812 1813 1814
	};
	memcpy(rbuf, hdr, sizeof(hdr));

1815
	if (buflen > (ATA_ID_SERNO_LEN + 4 - 1))
1816
		ata_id_string(args->id, (unsigned char *) &rbuf[4],
1817
			      ATA_ID_SERNO, ATA_ID_SERNO_LEN);
L
Linus Torvalds 已提交
1818 1819 1820 1821 1822

	return 0;
}

/**
J
Jeff Garzik 已提交
1823
 *	ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
L
Linus Torvalds 已提交
1824 1825 1826 1827
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
J
Jeff Garzik 已提交
1828 1829 1830 1831
 *	Yields two logical unit device identification designators:
 *	 - vendor specific ASCII containing the ATA serial number
 *	 - SAT defined "t10 vendor id based" containing ASCII vendor
 *	   name ("ATA     "), model and serial numbers.
L
Linus Torvalds 已提交
1832 1833
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1834
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1835 1836 1837 1838 1839
 */

unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
			      unsigned int buflen)
{
J
Jeff Garzik 已提交
1840 1841
	int num;
	const int sat_model_serial_desc_len = 68;
L
Linus Torvalds 已提交
1842

J
Jeff Garzik 已提交
1843 1844 1845
	rbuf[1] = 0x83;			/* this page code */
	num = 4;

1846
	if (buflen > (ATA_ID_SERNO_LEN + num + 3)) {
J
Jeff Garzik 已提交
1847
		/* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1848
		rbuf[num + 0] = 2;
1849
		rbuf[num + 3] = ATA_ID_SERNO_LEN;
J
Jeff Garzik 已提交
1850 1851
		num += 4;
		ata_id_string(args->id, (unsigned char *) rbuf + num,
1852 1853
			      ATA_ID_SERNO, ATA_ID_SERNO_LEN);
		num += ATA_ID_SERNO_LEN;
L
Linus Torvalds 已提交
1854
	}
J
Jeff Garzik 已提交
1855 1856 1857
	if (buflen > (sat_model_serial_desc_len + num + 3)) {
		/* SAT defined lu model and serial numbers descriptor */
		/* piv=0, assoc=lu, code_set=ACSII, designator=t10 vendor id */
1858 1859
		rbuf[num + 0] = 2;
		rbuf[num + 1] = 1;
J
Jeff Garzik 已提交
1860 1861 1862 1863 1864
		rbuf[num + 3] = sat_model_serial_desc_len;
		num += 4;
		memcpy(rbuf + num, "ATA     ", 8);
		num += 8;
		ata_id_string(args->id, (unsigned char *) rbuf + num,
1865 1866
			      ATA_ID_PROD, ATA_ID_PROD_LEN);
		num += ATA_ID_PROD_LEN;
J
Jeff Garzik 已提交
1867
		ata_id_string(args->id, (unsigned char *) rbuf + num,
1868 1869
			      ATA_ID_SERNO, ATA_ID_SERNO_LEN);
		num += ATA_ID_SERNO_LEN;
J
Jeff Garzik 已提交
1870 1871
	}
	rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
L
Linus Torvalds 已提交
1872 1873 1874 1875
	return 0;
}

/**
J
Jeff Garzik 已提交
1876
 *	ata_scsiop_noop - Command handler that simply returns success.
L
Linus Torvalds 已提交
1877 1878 1879 1880 1881 1882 1883 1884
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
 *	No operation.  Simply returns success to caller, to indicate
 *	that the caller should successfully complete this SCSI command.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1885
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939
 */

unsigned int ata_scsiop_noop(struct ata_scsi_args *args, u8 *rbuf,
			    unsigned int buflen)
{
	VPRINTK("ENTER\n");
	return 0;
}

/**
 *	ata_msense_push - Push data onto MODE SENSE data output buffer
 *	@ptr_io: (input/output) Location to store more output data
 *	@last: End of output data buffer
 *	@buf: Pointer to BLOB being added to output buffer
 *	@buflen: Length of BLOB
 *
 *	Store MODE SENSE data on an output buffer.
 *
 *	LOCKING:
 *	None.
 */

static void ata_msense_push(u8 **ptr_io, const u8 *last,
			    const u8 *buf, unsigned int buflen)
{
	u8 *ptr = *ptr_io;

	if ((ptr + buflen - 1) > last)
		return;

	memcpy(ptr, buf, buflen);

	ptr += buflen;

	*ptr_io = ptr;
}

/**
 *	ata_msense_caching - Simulate MODE SENSE caching info page
 *	@id: device IDENTIFY data
 *	@ptr_io: (input/output) Location to store more output data
 *	@last: End of output data buffer
 *
 *	Generate a caching info page, which conditionally indicates
 *	write caching to the SCSI layer, depending on device
 *	capabilities.
 *
 *	LOCKING:
 *	None.
 */

static unsigned int ata_msense_caching(u16 *id, u8 **ptr_io,
				       const u8 *last)
{
1940
	u8 page[CACHE_MPAGE_LEN];
L
Linus Torvalds 已提交
1941

1942
	memcpy(page, def_cache_mpage, sizeof(page));
L
Linus Torvalds 已提交
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
	if (ata_id_wcache_enabled(id))
		page[2] |= (1 << 2);	/* write cache enable */
	if (!ata_id_rahead_enabled(id))
		page[12] |= (1 << 5);	/* disable read ahead */

	ata_msense_push(ptr_io, last, page, sizeof(page));
	return sizeof(page);
}

/**
 *	ata_msense_ctl_mode - Simulate MODE SENSE control mode page
 *	@dev: Device associated with this MODE SENSE command
 *	@ptr_io: (input/output) Location to store more output data
 *	@last: End of output data buffer
 *
 *	Generate a generic MODE SENSE control mode page.
 *
 *	LOCKING:
 *	None.
 */

static unsigned int ata_msense_ctl_mode(u8 **ptr_io, const u8 *last)
{
1966 1967 1968
	ata_msense_push(ptr_io, last, def_control_mpage,
			sizeof(def_control_mpage));
	return sizeof(def_control_mpage);
L
Linus Torvalds 已提交
1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985
}

/**
 *	ata_msense_rw_recovery - Simulate MODE SENSE r/w error recovery page
 *	@dev: Device associated with this MODE SENSE command
 *	@ptr_io: (input/output) Location to store more output data
 *	@last: End of output data buffer
 *
 *	Generate a generic MODE SENSE r/w error recovery page.
 *
 *	LOCKING:
 *	None.
 */

static unsigned int ata_msense_rw_recovery(u8 **ptr_io, const u8 *last)
{

1986 1987 1988
	ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
			sizeof(def_rw_recovery_mpage));
	return sizeof(def_rw_recovery_mpage);
L
Linus Torvalds 已提交
1989 1990
}

1991 1992 1993 1994 1995 1996
/*
 * We can turn this into a real blacklist if it's needed, for now just
 * blacklist any Maxtor BANC1G10 revision firmware
 */
static int ata_dev_supports_fua(u16 *id)
{
1997
	unsigned char model[ATA_ID_PROD_LEN + 1], fw[ATA_ID_FW_REV_LEN + 1];
1998

J
Jeff Garzik 已提交
1999 2000
	if (!libata_fua)
		return 0;
2001 2002 2003
	if (!ata_id_has_fua(id))
		return 0;

2004 2005
	ata_id_c_string(id, model, ATA_ID_PROD, sizeof(model));
	ata_id_c_string(id, fw, ATA_ID_FW_REV, sizeof(fw));
2006

2007
	if (strcmp(model, "Maxtor"))
2008
		return 1;
2009
	if (strcmp(fw, "BANC1G10"))
2010 2011 2012 2013 2014
		return 1;

	return 0; /* blacklisted */
}

L
Linus Torvalds 已提交
2015 2016 2017 2018 2019 2020
/**
 *	ata_scsiop_mode_sense - Simulate MODE SENSE 6, 10 commands
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
2021 2022 2023
 *	Simulate MODE SENSE commands. Assume this is invoked for direct
 *	access devices (e.g. disks) only. There should be no block
 *	descriptor for other device types.
L
Linus Torvalds 已提交
2024 2025
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2026
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2027 2028 2029 2030 2031
 */

unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
				  unsigned int buflen)
{
T
Tejun Heo 已提交
2032
	struct ata_device *dev = args->dev;
L
Linus Torvalds 已提交
2033
	u8 *scsicmd = args->cmd->cmnd, *p, *last;
2034 2035 2036 2037 2038 2039 2040
	const u8 sat_blk_desc[] = {
		0, 0, 0, 0,	/* number of blocks: sat unspecified */
		0,
		0, 0x2, 0x0	/* block length: 512 bytes */
	};
	u8 pg, spg;
	unsigned int ebd, page_control, six_byte, output_len, alloc_len, minlen;
T
Tejun Heo 已提交
2041
	u8 dpofua;
L
Linus Torvalds 已提交
2042 2043 2044 2045

	VPRINTK("ENTER\n");

	six_byte = (scsicmd[0] == MODE_SENSE);
2046 2047 2048
	ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
	/*
	 * LLBA bit in msense(10) ignored (compliant)
L
Linus Torvalds 已提交
2049
	 */
2050

L
Linus Torvalds 已提交
2051
	page_control = scsicmd[2] >> 6;
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
	switch (page_control) {
	case 0: /* current */
		break;  /* supported */
	case 3: /* saved */
		goto saving_not_supp;
	case 1: /* changeable */
	case 2: /* defaults */
	default:
		goto invalid_fld;
	}
L
Linus Torvalds 已提交
2062

2063 2064 2065 2066 2067 2068 2069 2070
	if (six_byte) {
		output_len = 4 + (ebd ? 8 : 0);
		alloc_len = scsicmd[4];
	} else {
		output_len = 8 + (ebd ? 8 : 0);
		alloc_len = (scsicmd[7] << 8) + scsicmd[8];
	}
	minlen = (alloc_len < buflen) ? alloc_len : buflen;
L
Linus Torvalds 已提交
2071 2072

	p = rbuf + output_len;
2073
	last = rbuf + minlen - 1;
L
Linus Torvalds 已提交
2074

2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
	pg = scsicmd[2] & 0x3f;
	spg = scsicmd[3];
	/*
	 * No mode subpages supported (yet) but asking for _all_
	 * subpages may be valid
	 */
	if (spg && (spg != ALL_SUB_MPAGES))
		goto invalid_fld;

	switch(pg) {
	case RW_RECOVERY_MPAGE:
L
Linus Torvalds 已提交
2086 2087 2088
		output_len += ata_msense_rw_recovery(&p, last);
		break;

2089
	case CACHE_MPAGE:
L
Linus Torvalds 已提交
2090 2091 2092
		output_len += ata_msense_caching(args->id, &p, last);
		break;

2093
	case CONTROL_MPAGE: {
L
Linus Torvalds 已提交
2094 2095 2096 2097
		output_len += ata_msense_ctl_mode(&p, last);
		break;
		}

2098
	case ALL_MPAGES:
L
Linus Torvalds 已提交
2099 2100 2101 2102 2103 2104
		output_len += ata_msense_rw_recovery(&p, last);
		output_len += ata_msense_caching(args->id, &p, last);
		output_len += ata_msense_ctl_mode(&p, last);
		break;

	default:		/* invalid page code */
2105
		goto invalid_fld;
L
Linus Torvalds 已提交
2106 2107
	}

2108 2109
	if (minlen < 1)
		return 0;
T
Tejun Heo 已提交
2110 2111

	dpofua = 0;
2112
	if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
T
Tejun Heo 已提交
2113 2114 2115
	    (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
		dpofua = 1 << 4;

L
Linus Torvalds 已提交
2116 2117 2118
	if (six_byte) {
		output_len--;
		rbuf[0] = output_len;
T
Tejun Heo 已提交
2119 2120
		if (minlen > 2)
			rbuf[2] |= dpofua;
2121 2122 2123 2124 2125 2126 2127
		if (ebd) {
			if (minlen > 3)
				rbuf[3] = sizeof(sat_blk_desc);
			if (minlen > 11)
				memcpy(rbuf + 4, sat_blk_desc,
				       sizeof(sat_blk_desc));
		}
L
Linus Torvalds 已提交
2128 2129 2130
	} else {
		output_len -= 2;
		rbuf[0] = output_len >> 8;
2131 2132
		if (minlen > 1)
			rbuf[1] = output_len;
T
Tejun Heo 已提交
2133 2134
		if (minlen > 3)
			rbuf[3] |= dpofua;
2135 2136 2137 2138 2139 2140 2141
		if (ebd) {
			if (minlen > 7)
				rbuf[7] = sizeof(sat_blk_desc);
			if (minlen > 15)
				memcpy(rbuf + 8, sat_blk_desc,
				       sizeof(sat_blk_desc));
		}
L
Linus Torvalds 已提交
2142 2143
	}
	return 0;
2144 2145 2146 2147 2148 2149 2150 2151 2152 2153

invalid_fld:
	ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x24, 0x0);
	/* "Invalid field in cbd" */
	return 1;

saving_not_supp:
	ata_scsi_set_sense(args->cmd, ILLEGAL_REQUEST, 0x39, 0x0);
	 /* "Saving parameters not supported" */
	return 1;
L
Linus Torvalds 已提交
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164
}

/**
 *	ata_scsiop_read_cap - Simulate READ CAPACITY[ 16] commands
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
 *	Simulate READ CAPACITY commands.
 *
 *	LOCKING:
2165
 *	None.
L
Linus Torvalds 已提交
2166 2167 2168 2169
 */
unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
			        unsigned int buflen)
{
2170
	u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
L
Linus Torvalds 已提交
2171 2172 2173 2174

	VPRINTK("ENTER\n");

	if (args->cmd->cmnd[0] == READ_CAPACITY) {
2175 2176
		if (last_lba >= 0xffffffffULL)
			last_lba = 0xffffffff;
2177

L
Linus Torvalds 已提交
2178
		/* sector count, 32-bit */
2179 2180 2181 2182
		ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 3));
		ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 2));
		ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 1));
		ATA_SCSI_RBUF_SET(3, last_lba);
L
Linus Torvalds 已提交
2183 2184

		/* sector size */
2185 2186
		ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
		ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
L
Linus Torvalds 已提交
2187 2188
	} else {
		/* sector count, 64-bit */
2189 2190 2191 2192 2193 2194 2195 2196
		ATA_SCSI_RBUF_SET(0, last_lba >> (8 * 7));
		ATA_SCSI_RBUF_SET(1, last_lba >> (8 * 6));
		ATA_SCSI_RBUF_SET(2, last_lba >> (8 * 5));
		ATA_SCSI_RBUF_SET(3, last_lba >> (8 * 4));
		ATA_SCSI_RBUF_SET(4, last_lba >> (8 * 3));
		ATA_SCSI_RBUF_SET(5, last_lba >> (8 * 2));
		ATA_SCSI_RBUF_SET(6, last_lba >> (8 * 1));
		ATA_SCSI_RBUF_SET(7, last_lba);
L
Linus Torvalds 已提交
2197 2198

		/* sector size */
2199 2200
		ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
		ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
L
Linus Torvalds 已提交
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
	}

	return 0;
}

/**
 *	ata_scsiop_report_luns - Simulate REPORT LUNS command
 *	@args: device IDENTIFY data / SCSI command of interest.
 *	@rbuf: Response buffer, to which simulated SCSI cmd output is sent.
 *	@buflen: Response buffer length.
 *
 *	Simulate REPORT LUNS command.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2215
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
 */

unsigned int ata_scsiop_report_luns(struct ata_scsi_args *args, u8 *rbuf,
				   unsigned int buflen)
{
	VPRINTK("ENTER\n");
	rbuf[3] = 8;	/* just one lun, LUN 0, size 8 bytes */

	return 0;
}

2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254
/**
 *	ata_scsi_set_sense - Set SCSI sense data and status
 *	@cmd: SCSI request to be handled
 *	@sk: SCSI-defined sense key
 *	@asc: SCSI-defined additional sense code
 *	@ascq: SCSI-defined additional sense code qualifier
 *
 *	Helper function that builds a valid fixed format, current
 *	response code and the given sense key (sk), additional sense
 *	code (asc) and additional sense code qualifier (ascq) with
 *	a SCSI command status of %SAM_STAT_CHECK_CONDITION and
 *	DRIVER_SENSE set in the upper bits of scsi_cmnd::result .
 *
 *	LOCKING:
 *	Not required
 */

void ata_scsi_set_sense(struct scsi_cmnd *cmd, u8 sk, u8 asc, u8 ascq)
{
	cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;

	cmd->sense_buffer[0] = 0x70;	/* fixed format, current */
	cmd->sense_buffer[2] = sk;
	cmd->sense_buffer[7] = 18 - 8;	/* additional sense length */
	cmd->sense_buffer[12] = asc;
	cmd->sense_buffer[13] = ascq;
}

L
Linus Torvalds 已提交
2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
/**
 *	ata_scsi_badcmd - End a SCSI request with an error
 *	@cmd: SCSI request to be handled
 *	@done: SCSI command completion function
 *	@asc: SCSI-defined additional sense code
 *	@ascq: SCSI-defined additional sense code qualifier
 *
 *	Helper function that completes a SCSI command with
 *	%SAM_STAT_CHECK_CONDITION, with a sense key %ILLEGAL_REQUEST
 *	and the specified additional sense codes.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2267
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2268 2269 2270 2271 2272
 */

void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
{
	DPRINTK("ENTER\n");
2273
	ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
L
Linus Torvalds 已提交
2274 2275 2276 2277

	done(cmd);
}

2278
static void atapi_sense_complete(struct ata_queued_cmd *qc)
2279
{
2280
	if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2281 2282 2283 2284 2285
		/* FIXME: not quite right; we don't want the
		 * translation of taskfile registers into
		 * a sense descriptors, since that's only
		 * correct for ATA, not ATAPI
		 */
2286
		ata_gen_passthru_sense(qc);
2287
	}
2288

2289
	qc->scsidone(qc->scsicmd);
2290
	ata_qc_free(qc);
2291
}
2292

2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304
/* is it pointless to prefer PIO for "safety reasons"? */
static inline int ata_pio_use_silly(struct ata_port *ap)
{
	return (ap->flags & ATA_FLAG_PIO_DMA);
}

static void atapi_request_sense(struct ata_queued_cmd *qc)
{
	struct ata_port *ap = qc->ap;
	struct scsi_cmnd *cmd = qc->scsicmd;

	DPRINTK("ATAPI request sense\n");
2305 2306 2307 2308

	/* FIXME: is this needed? */
	memset(cmd->sense_buffer, 0, sizeof(cmd->sense_buffer));

2309 2310 2311 2312 2313 2314 2315 2316
	ap->ops->tf_read(ap, &qc->tf);

	/* fill these in, for the case where they are -not- overwritten */
	cmd->sense_buffer[0] = 0x70;
	cmd->sense_buffer[2] = qc->tf.feature >> 4;

	ata_qc_reinit(qc);

2317 2318 2319
	ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
	qc->dma_dir = DMA_FROM_DEVICE;

2320
	memset(&qc->cdb, 0, qc->dev->cdb_len);
2321 2322 2323 2324 2325 2326
	qc->cdb[0] = REQUEST_SENSE;
	qc->cdb[4] = SCSI_SENSE_BUFFERSIZE;

	qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
	qc->tf.command = ATA_CMD_PACKET;

2327 2328 2329 2330 2331 2332 2333 2334
	if (ata_pio_use_silly(ap)) {
		qc->tf.protocol = ATA_PROT_ATAPI_DMA;
		qc->tf.feature |= ATAPI_PKT_DMA;
	} else {
		qc->tf.protocol = ATA_PROT_ATAPI;
		qc->tf.lbam = (8 * 1024) & 0xff;
		qc->tf.lbah = (8 * 1024) >> 8;
	}
2335 2336
	qc->nbytes = SCSI_SENSE_BUFFERSIZE;

2337
	qc->complete_fn = atapi_sense_complete;
2338

2339
	ata_qc_issue(qc);
2340 2341 2342 2343

	DPRINTK("EXIT\n");
}

2344
static void atapi_qc_complete(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
2345 2346
{
	struct scsi_cmnd *cmd = qc->scsicmd;
2347
	unsigned int err_mask = qc->err_mask;
L
Linus Torvalds 已提交
2348

2349
	VPRINTK("ENTER, err_mask 0x%X\n", err_mask);
J
Jeff Garzik 已提交
2350

2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
	/* handle completion from new EH */
	if (unlikely(qc->ap->ops->error_handler &&
		     (err_mask || qc->flags & ATA_QCFLAG_SENSE_VALID))) {

		if (!(qc->flags & ATA_QCFLAG_SENSE_VALID)) {
			/* FIXME: not quite right; we don't want the
			 * translation of taskfile registers into a
			 * sense descriptors, since that's only
			 * correct for ATA, not ATAPI
			 */
2361
			ata_gen_passthru_sense(qc);
2362 2363
		}

2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376
		/* SCSI EH automatically locks door if sdev->locked is
		 * set.  Sometimes door lock request continues to
		 * fail, for example, when no media is present.  This
		 * creates a loop - SCSI EH issues door lock which
		 * fails and gets invoked again to acquire sense data
		 * for the failed command.
		 *
		 * If door lock fails, always clear sdev->locked to
		 * avoid this infinite loop.
		 */
		if (qc->cdb[0] == ALLOW_MEDIUM_REMOVAL)
			qc->dev->sdev->locked = 0;

2377 2378 2379 2380 2381 2382 2383
		qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
		qc->scsidone(cmd);
		ata_qc_free(qc);
		return;
	}

	/* successful completion or old EH failure path */
2384
	if (unlikely(err_mask & AC_ERR_DEV)) {
L
Linus Torvalds 已提交
2385
		cmd->result = SAM_STAT_CHECK_CONDITION;
2386
		atapi_request_sense(qc);
2387
		return;
2388
	} else if (unlikely(err_mask)) {
2389 2390 2391 2392 2393
		/* FIXME: not quite right; we don't want the
		 * translation of taskfile registers into
		 * a sense descriptors, since that's only
		 * correct for ATA, not ATAPI
		 */
2394
		ata_gen_passthru_sense(qc);
2395
	} else {
L
Linus Torvalds 已提交
2396 2397
		u8 *scsicmd = cmd->cmnd;

2398
		if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
L
Linus Torvalds 已提交
2399 2400 2401 2402
			u8 *buf = NULL;
			unsigned int buflen;

			buflen = ata_scsi_rbuf_get(cmd, &buf);
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416

	/* ATAPI devices typically report zero for their SCSI version,
	 * and sometimes deviate from the spec WRT response data
	 * format.  If SCSI version is reported as zero like normal,
	 * then we make the following fixups:  1) Fake MMC-5 version,
	 * to indicate to the Linux scsi midlayer this is a modern
	 * device.  2) Ensure response data format / ATAPI information
	 * are always correct.
	 */
			if (buf[2] == 0) {
				buf[2] = 0x5;
				buf[3] = 0x32;
			}

L
Linus Torvalds 已提交
2417 2418
			ata_scsi_rbuf_put(cmd, buf);
		}
2419

L
Linus Torvalds 已提交
2420 2421 2422 2423
		cmd->result = SAM_STAT_GOOD;
	}

	qc->scsidone(cmd);
2424
	ata_qc_free(qc);
L
Linus Torvalds 已提交
2425 2426 2427 2428 2429 2430
}
/**
 *	atapi_xlat - Initialize PACKET taskfile
 *	@qc: command structure to be initialized
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2431
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2432 2433 2434 2435
 *
 *	RETURNS:
 *	Zero on success, non-zero on failure.
 */
2436
static unsigned int atapi_xlat(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
2437
{
2438
	struct scsi_cmnd *scmd = qc->scsicmd;
L
Linus Torvalds 已提交
2439 2440
	struct ata_device *dev = qc->dev;
	int using_pio = (dev->flags & ATA_DFLAG_PIO);
2441
	int nodata = (scmd->sc_data_direction == DMA_NONE);
L
Linus Torvalds 已提交
2442 2443 2444 2445 2446 2447

	if (!using_pio)
		/* Check whether ATAPI DMA is safe */
		if (ata_check_atapi_dma(qc))
			using_pio = 1;

2448 2449
	memset(qc->cdb, 0, dev->cdb_len);
	memcpy(qc->cdb, scmd->cmnd, scmd->cmd_len);
L
Linus Torvalds 已提交
2450 2451 2452 2453

	qc->complete_fn = atapi_qc_complete;

	qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2454
	if (scmd->sc_data_direction == DMA_TO_DEVICE) {
L
Linus Torvalds 已提交
2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
		qc->tf.flags |= ATA_TFLAG_WRITE;
		DPRINTK("direction: write\n");
	}

	qc->tf.command = ATA_CMD_PACKET;

	/* no data, or PIO data xfer */
	if (using_pio || nodata) {
		if (nodata)
			qc->tf.protocol = ATA_PROT_ATAPI_NODATA;
		else
			qc->tf.protocol = ATA_PROT_ATAPI;
		qc->tf.lbam = (8 * 1024) & 0xff;
		qc->tf.lbah = (8 * 1024) >> 8;
	}

	/* DMA data xfer */
	else {
		qc->tf.protocol = ATA_PROT_ATAPI_DMA;
		qc->tf.feature |= ATAPI_PKT_DMA;

2476
		if (atapi_dmadir && (scmd->sc_data_direction != DMA_TO_DEVICE))
2477
			/* some SATA bridges need us to indicate data xfer direction */
L
Linus Torvalds 已提交
2478 2479 2480
			qc->tf.feature |= ATAPI_DMADIR;
	}

2481
	qc->nbytes = scmd->request_bufflen;
L
Linus Torvalds 已提交
2482 2483 2484 2485

	return 0;
}

2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
static struct ata_device * ata_find_dev(struct ata_port *ap, int id)
{
	if (likely(id < ATA_MAX_DEVICES))
		return &ap->device[id];
	return NULL;
}

static struct ata_device * __ata_scsi_find_dev(struct ata_port *ap,
					const struct scsi_device *scsidev)
{
	/* skip commands not addressed to targets we simulate */
	if (unlikely(scsidev->channel || scsidev->lun))
		return NULL;

	return ata_find_dev(ap, scsidev->id);
}

2503 2504 2505 2506 2507 2508 2509
/**
 *	ata_scsi_dev_enabled - determine if device is enabled
 *	@dev: ATA device
 *
 *	Determine if commands should be sent to the specified device.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2510
 *	spin_lock_irqsave(host lock)
2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532
 *
 *	RETURNS:
 *	0 if commands are not allowed / 1 if commands are allowed
 */

static int ata_scsi_dev_enabled(struct ata_device *dev)
{
	if (unlikely(!ata_dev_enabled(dev)))
		return 0;

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

	return 1;
}

L
Linus Torvalds 已提交
2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
/**
 *	ata_scsi_find_dev - lookup ata_device from scsi_cmnd
 *	@ap: ATA port to which the device is attached
 *	@scsidev: SCSI device from which we derive the ATA device
 *
 *	Given various information provided in struct scsi_cmnd,
 *	map that onto an ATA bus, and using that mapping
 *	determine which ata_device is associated with the
 *	SCSI command to be sent.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2544
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2545 2546 2547 2548 2549
 *
 *	RETURNS:
 *	Associated ATA device, or %NULL if not found.
 */
static struct ata_device *
J
Jeff Garzik 已提交
2550
ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
L
Linus Torvalds 已提交
2551
{
2552
	struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
L
Linus Torvalds 已提交
2553

2554
	if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
L
Linus Torvalds 已提交
2555 2556 2557 2558 2559
		return NULL;

	return dev;
}

2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606
/*
 *	ata_scsi_map_proto - Map pass-thru protocol value to taskfile value.
 *	@byte1: Byte 1 from pass-thru CDB.
 *
 *	RETURNS:
 *	ATA_PROT_UNKNOWN if mapping failed/unimplemented, protocol otherwise.
 */
static u8
ata_scsi_map_proto(u8 byte1)
{
	switch((byte1 & 0x1e) >> 1) {
		case 3:		/* Non-data */
			return ATA_PROT_NODATA;

		case 6:		/* DMA */
			return ATA_PROT_DMA;

		case 4:		/* PIO Data-in */
		case 5:		/* PIO Data-out */
			return ATA_PROT_PIO;

		case 10:	/* Device Reset */
		case 0:		/* Hard Reset */
		case 1:		/* SRST */
		case 2:		/* Bus Idle */
		case 7:		/* Packet */
		case 8:		/* DMA Queued */
		case 9:		/* Device Diagnostic */
		case 11:	/* UDMA Data-in */
		case 12:	/* UDMA Data-Out */
		case 13:	/* FPDMA */
		default:	/* Reserved */
			break;
	}

	return ATA_PROT_UNKNOWN;
}

/**
 *	ata_scsi_pass_thru - convert ATA pass-thru CDB to taskfile
 *	@qc: command structure to be initialized
 *
 *	Handles either 12 or 16-byte versions of the CDB.
 *
 *	RETURNS:
 *	Zero on success, non-zero on failure.
 */
2607
static unsigned int ata_scsi_pass_thru(struct ata_queued_cmd *qc)
2608 2609
{
	struct ata_taskfile *tf = &(qc->tf);
2610
	struct scsi_cmnd *scmd = qc->scsicmd;
2611
	struct ata_device *dev = qc->dev;
2612
	const u8 *cdb = scmd->cmnd;
2613

2614
	if ((tf->protocol = ata_scsi_map_proto(cdb[1])) == ATA_PROT_UNKNOWN)
2615
		goto invalid_fld;
2616

2617 2618 2619
	/* We may not issue DMA commands if no DMA mode is set */
	if (tf->protocol == ATA_PROT_DMA && dev->dma_mode == 0)
		goto invalid_fld;
2620

2621
	if (cdb[1] & 0xe0)
2622 2623 2624
		/* PIO multi not supported yet */
		goto invalid_fld;

2625 2626 2627 2628
	/*
	 * 12 and 16 byte CDBs use different offsets to
	 * provide the various register values.
	 */
2629
	if (cdb[0] == ATA_16) {
2630 2631 2632 2633 2634
		/*
		 * 16-byte CDB - may contain extended commands.
		 *
		 * If that is the case, copy the upper byte register values.
		 */
2635 2636 2637 2638 2639 2640
		if (cdb[1] & 0x01) {
			tf->hob_feature = cdb[3];
			tf->hob_nsect = cdb[5];
			tf->hob_lbal = cdb[7];
			tf->hob_lbam = cdb[9];
			tf->hob_lbah = cdb[11];
2641 2642 2643 2644 2645 2646 2647
			tf->flags |= ATA_TFLAG_LBA48;
		} else
			tf->flags &= ~ATA_TFLAG_LBA48;

		/*
		 * Always copy low byte, device and command registers.
		 */
2648 2649 2650 2651 2652 2653 2654
		tf->feature = cdb[4];
		tf->nsect = cdb[6];
		tf->lbal = cdb[8];
		tf->lbam = cdb[10];
		tf->lbah = cdb[12];
		tf->device = cdb[13];
		tf->command = cdb[14];
2655 2656 2657 2658 2659 2660
	} else {
		/*
		 * 12-byte CDB - incapable of extended commands.
		 */
		tf->flags &= ~ATA_TFLAG_LBA48;

2661 2662 2663 2664 2665 2666 2667
		tf->feature = cdb[3];
		tf->nsect = cdb[4];
		tf->lbal = cdb[5];
		tf->lbam = cdb[6];
		tf->lbah = cdb[7];
		tf->device = cdb[8];
		tf->command = cdb[9];
2668
	}
2669 2670 2671 2672 2673 2674
	/*
	 * If slave is possible, enforce correct master/slave bit
	*/
	if (qc->ap->flags & ATA_FLAG_SLAVE_POSS)
		tf->device = qc->dev->devno ?
			tf->device | ATA_DEV1 : tf->device & ~ATA_DEV1;
2675 2676 2677 2678 2679 2680 2681 2682 2683 2684

	/*
	 * Filter SET_FEATURES - XFER MODE command -- otherwise,
	 * SET_FEATURES - XFER MODE must be preceded/succeeded
	 * by an update to hardware-specific registers for each
	 * controller (i.e. the reason for ->set_piomode(),
	 * ->set_dmamode(), and ->post_set_mode() hooks).
	 */
	if ((tf->command == ATA_CMD_SET_FEATURES)
	 && (tf->feature == SETFEATURES_XFER))
2685
		goto invalid_fld;
2686 2687 2688 2689 2690 2691 2692 2693

	/*
	 * Set flags so that all registers will be written,
	 * and pass on write indication (used for PIO/DMA
	 * setup.)
	 */
	tf->flags |= (ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE);

2694
	if (scmd->sc_data_direction == DMA_TO_DEVICE)
2695 2696 2697 2698 2699 2700 2701 2702
		tf->flags |= ATA_TFLAG_WRITE;

	/*
	 * Set transfer length.
	 *
	 * TODO: find out if we need to do more here to
	 *       cover scatter/gather case.
	 */
T
Tejun Heo 已提交
2703
	qc->nbytes = scmd->request_bufflen;
2704

2705 2706 2707
	/* request result TF */
	qc->flags |= ATA_QCFLAG_RESULT_TF;

2708
	return 0;
2709 2710

 invalid_fld:
2711
	ata_scsi_set_sense(scmd, ILLEGAL_REQUEST, 0x24, 0x00);
2712 2713
	/* "Invalid field in cdb" */
	return 1;
2714 2715
}

L
Linus Torvalds 已提交
2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747
/**
 *	ata_get_xlat_func - check if SCSI to ATA translation is possible
 *	@dev: ATA device
 *	@cmd: SCSI command opcode to consider
 *
 *	Look up the SCSI command given, and determine whether the
 *	SCSI command is to be translated or simulated.
 *
 *	RETURNS:
 *	Pointer to translation function if possible, %NULL if not.
 */

static inline ata_xlat_func_t ata_get_xlat_func(struct ata_device *dev, u8 cmd)
{
	switch (cmd) {
	case READ_6:
	case READ_10:
	case READ_16:

	case WRITE_6:
	case WRITE_10:
	case WRITE_16:
		return ata_scsi_rw_xlat;

	case SYNCHRONIZE_CACHE:
		if (ata_try_flush_cache(dev))
			return ata_scsi_flush_xlat;
		break;

	case VERIFY:
	case VERIFY_16:
		return ata_scsi_verify_xlat;
2748 2749 2750 2751

	case ATA_12:
	case ATA_16:
		return ata_scsi_pass_thru;
2752

2753 2754
	case START_STOP:
		return ata_scsi_start_stop_xlat;
L
Linus Torvalds 已提交
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783
	}

	return NULL;
}

/**
 *	ata_scsi_dump_cdb - dump SCSI command contents to dmesg
 *	@ap: ATA port to which the command was being sent
 *	@cmd: SCSI command to dump
 *
 *	Prints the contents of a SCSI command via printk().
 */

static inline void ata_scsi_dump_cdb(struct ata_port *ap,
				     struct scsi_cmnd *cmd)
{
#ifdef ATA_DEBUG
	struct scsi_device *scsidev = cmd->device;
	u8 *scsicmd = cmd->cmnd;

	DPRINTK("CDB (%u:%d,%d,%d) %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
		ap->id,
		scsidev->channel, scsidev->id, scsidev->lun,
		scsicmd[0], scsicmd[1], scsicmd[2], scsicmd[3],
		scsicmd[4], scsicmd[5], scsicmd[6], scsicmd[7],
		scsicmd[8]);
#endif
}

2784
static inline int __ata_scsi_queuecmd(struct scsi_cmnd *scmd,
2785 2786
				      void (*done)(struct scsi_cmnd *),
				      struct ata_device *dev)
2787
{
2788 2789
	int rc = 0;

2790 2791 2792 2793 2794 2795 2796
	if (unlikely(!scmd->cmd_len)) {
		ata_dev_printk(dev, KERN_WARNING, "WARNING: zero len CDB\n");
		scmd->result = DID_ERROR << 16;
		done(scmd);
		return 0;
	}

2797 2798
	if (dev->class == ATA_DEV_ATA) {
		ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
2799
							      scmd->cmnd[0]);
2800 2801

		if (xlat_func)
2802
			rc = ata_scsi_translate(dev, scmd, done, xlat_func);
2803
		else
2804
			ata_scsi_simulate(dev, scmd, done);
2805
	} else
2806
		rc = ata_scsi_translate(dev, scmd, done, atapi_xlat);
2807 2808

	return rc;
2809 2810
}

L
Linus Torvalds 已提交
2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823
/**
 *	ata_scsi_queuecmd - Issue SCSI cdb to libata-managed device
 *	@cmd: SCSI command to be sent
 *	@done: Completion function, called when command is complete
 *
 *	In some cases, this function translates SCSI commands into
 *	ATA taskfiles, and queues the taskfiles to be sent to
 *	hardware.  In other cases, this function simulates a
 *	SCSI device by evaluating and responding to certain
 *	SCSI commands.  This creates the overall effect of
 *	ATA and ATAPI devices appearing as SCSI devices.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2824
 *	Releases scsi-layer-held lock, and obtains host lock.
L
Linus Torvalds 已提交
2825 2826
 *
 *	RETURNS:
2827 2828
 *	Return value from __ata_scsi_queuecmd() if @cmd can be queued,
 *	0 otherwise.
L
Linus Torvalds 已提交
2829 2830 2831 2832 2833 2834
 */
int ata_scsi_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *))
{
	struct ata_port *ap;
	struct ata_device *dev;
	struct scsi_device *scsidev = cmd->device;
J
Jeff Garzik 已提交
2835
	struct Scsi_Host *shost = scsidev->host;
2836
	int rc = 0;
L
Linus Torvalds 已提交
2837

2838
	ap = ata_shost_to_port(shost);
J
Jeff Garzik 已提交
2839 2840

	spin_unlock(shost->host_lock);
2841
	spin_lock(ap->lock);
L
Linus Torvalds 已提交
2842 2843 2844 2845

	ata_scsi_dump_cdb(ap, cmd);

	dev = ata_scsi_find_dev(ap, scsidev);
2846
	if (likely(dev))
2847
		rc = __ata_scsi_queuecmd(cmd, done, dev);
2848
	else {
L
Linus Torvalds 已提交
2849 2850 2851 2852
		cmd->result = (DID_BAD_TARGET << 16);
		done(cmd);
	}

2853
	spin_unlock(ap->lock);
J
Jeff Garzik 已提交
2854
	spin_lock(shost->host_lock);
2855
	return rc;
L
Linus Torvalds 已提交
2856 2857 2858 2859
}

/**
 *	ata_scsi_simulate - simulate SCSI command on ATA device
2860
 *	@dev: the target device
L
Linus Torvalds 已提交
2861 2862 2863 2864 2865 2866 2867
 *	@cmd: SCSI command being sent to device.
 *	@done: SCSI command completion function.
 *
 *	Interprets and directly executes a select list of SCSI commands
 *	that can be handled internally.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2868
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2869 2870
 */

T
Tejun Heo 已提交
2871
void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
L
Linus Torvalds 已提交
2872 2873 2874
		      void (*done)(struct scsi_cmnd *))
{
	struct ata_scsi_args args;
J
Jeff Garzik 已提交
2875
	const u8 *scsicmd = cmd->cmnd;
L
Linus Torvalds 已提交
2876

T
Tejun Heo 已提交
2877 2878
	args.dev = dev;
	args.id = dev->id;
L
Linus Torvalds 已提交
2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895
	args.cmd = cmd;
	args.done = done;

	switch(scsicmd[0]) {
		/* no-op's, complete with success */
		case SYNCHRONIZE_CACHE:
		case REZERO_UNIT:
		case SEEK_6:
		case SEEK_10:
		case TEST_UNIT_READY:
		case FORMAT_UNIT:		/* FIXME: correct? */
		case SEND_DIAGNOSTIC:		/* FIXME: correct? */
			ata_scsi_rbuf_fill(&args, ata_scsiop_noop);
			break;

		case INQUIRY:
			if (scsicmd[1] & 2)	           /* is CmdDt set?  */
2896
				ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2897 2898 2899 2900 2901 2902 2903 2904 2905
			else if ((scsicmd[1] & 1) == 0)    /* is EVPD clear? */
				ata_scsi_rbuf_fill(&args, ata_scsiop_inq_std);
			else if (scsicmd[2] == 0x00)
				ata_scsi_rbuf_fill(&args, ata_scsiop_inq_00);
			else if (scsicmd[2] == 0x80)
				ata_scsi_rbuf_fill(&args, ata_scsiop_inq_80);
			else if (scsicmd[2] == 0x83)
				ata_scsi_rbuf_fill(&args, ata_scsiop_inq_83);
			else
2906
				ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2907 2908 2909 2910 2911 2912 2913 2914 2915
			break;

		case MODE_SENSE:
		case MODE_SENSE_10:
			ata_scsi_rbuf_fill(&args, ata_scsiop_mode_sense);
			break;

		case MODE_SELECT:	/* unconditionally return */
		case MODE_SELECT_10:	/* bad-field-in-cdb */
2916
			ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926
			break;

		case READ_CAPACITY:
			ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
			break;

		case SERVICE_ACTION_IN:
			if ((scsicmd[1] & 0x1f) == SAI_READ_CAPACITY_16)
				ata_scsi_rbuf_fill(&args, ata_scsiop_read_cap);
			else
2927
				ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2928 2929 2930 2931 2932 2933
			break;

		case REPORT_LUNS:
			ata_scsi_rbuf_fill(&args, ata_scsiop_report_luns);
			break;

2934
		/* mandatory commands we haven't implemented yet */
L
Linus Torvalds 已提交
2935 2936 2937 2938
		case REQUEST_SENSE:

		/* all other commands */
		default:
2939 2940 2941
			ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
			/* "Invalid command operation code" */
			done(cmd);
L
Linus Torvalds 已提交
2942 2943 2944 2945
			break;
	}
}

J
Jeff Garzik 已提交
2946 2947 2948 2949
void ata_scsi_scan_host(struct ata_port *ap)
{
	unsigned int i;

2950
	if (ap->flags & ATA_FLAG_DISABLED)
J
Jeff Garzik 已提交
2951 2952
		return;

2953
	for (i = 0; i < ATA_MAX_DEVICES; i++) {
2954 2955 2956 2957 2958
		struct ata_device *dev = &ap->device[i];
		struct scsi_device *sdev;

		if (!ata_dev_enabled(dev) || dev->sdev)
			continue;
2959

J
Jeff Garzik 已提交
2960
		sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2961 2962 2963 2964
		if (!IS_ERR(sdev)) {
			dev->sdev = sdev;
			scsi_device_put(sdev);
		}
2965
	}
J
Jeff Garzik 已提交
2966
}
2967 2968 2969 2970 2971 2972 2973

/**
 *	ata_scsi_offline_dev - offline attached SCSI device
 *	@dev: ATA device to offline attached SCSI device for
 *
 *	This function is called from ata_eh_hotplug() and responsible
 *	for taking the SCSI device attached to @dev offline.  This
J
Jeff Garzik 已提交
2974
 *	function is called with host lock which protects dev->sdev
2975 2976 2977
 *	against clearing.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2978
 *	spin_lock_irqsave(host lock)
2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990
 *
 *	RETURNS:
 *	1 if attached SCSI device exists, 0 otherwise.
 */
int ata_scsi_offline_dev(struct ata_device *dev)
{
	if (dev->sdev) {
		scsi_device_set_state(dev->sdev, SDEV_OFFLINE);
		return 1;
	}
	return 0;
}
2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013

/**
 *	ata_scsi_remove_dev - remove attached SCSI device
 *	@dev: ATA device to remove attached SCSI device for
 *
 *	This function is called from ata_eh_scsi_hotplug() and
 *	responsible for removing the SCSI device attached to @dev.
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 */
static void ata_scsi_remove_dev(struct ata_device *dev)
{
	struct ata_port *ap = dev->ap;
	struct scsi_device *sdev;
	unsigned long flags;

	/* Alas, we need to grab scan_mutex to ensure SCSI device
	 * state doesn't change underneath us and thus
	 * scsi_device_get() always succeeds.  The mutex locking can
	 * be removed if there is __scsi_device_get() interface which
	 * increments reference counts regardless of device state.
	 */
J
Jeff Garzik 已提交
3014
	mutex_lock(&ap->scsi_host->scan_mutex);
3015
	spin_lock_irqsave(ap->lock, flags);
3016

J
Jeff Garzik 已提交
3017
	/* clearing dev->sdev is protected by host lock */
3018 3019 3020 3021 3022
	sdev = dev->sdev;
	dev->sdev = NULL;

	if (sdev) {
		/* If user initiated unplug races with us, sdev can go
J
Jeff Garzik 已提交
3023
		 * away underneath us after the host lock and
3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038
		 * scan_mutex are released.  Hold onto it.
		 */
		if (scsi_device_get(sdev) == 0) {
			/* The following ensures the attached sdev is
			 * offline on return from ata_scsi_offline_dev()
			 * regardless it wins or loses the race
			 * against this function.
			 */
			scsi_device_set_state(sdev, SDEV_OFFLINE);
		} else {
			WARN_ON(1);
			sdev = NULL;
		}
	}

3039
	spin_unlock_irqrestore(ap->lock, flags);
J
Jeff Garzik 已提交
3040
	mutex_unlock(&ap->scsi_host->scan_mutex);
3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052

	if (sdev) {
		ata_dev_printk(dev, KERN_INFO, "detaching (SCSI %s)\n",
			       sdev->sdev_gendev.bus_id);

		scsi_remove_device(sdev);
		scsi_device_put(sdev);
	}
}

/**
 *	ata_scsi_hotplug - SCSI part of hotplug
3053
 *	@work: Pointer to ATA port to perform SCSI hotplug on
3054 3055 3056 3057 3058 3059 3060 3061 3062
 *
 *	Perform SCSI part of hotplug.  It's executed from a separate
 *	workqueue after EH completes.  This is necessary because SCSI
 *	hot plugging requires working EH and hot unplugging is
 *	synchronized with hot plugging with a mutex.
 *
 *	LOCKING:
 *	Kernel thread context (may sleep).
 */
3063
void ata_scsi_hotplug(struct work_struct *work)
3064
{
3065 3066
	struct ata_port *ap =
		container_of(work, struct ata_port, hotplug_task.work);
3067 3068
	int i;

3069
	if (ap->pflags & ATA_PFLAG_UNLOADING) {
3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
		DPRINTK("ENTER/EXIT - unloading\n");
		return;
	}

	DPRINTK("ENTER\n");

	/* unplug detached devices */
	for (i = 0; i < ATA_MAX_DEVICES; i++) {
		struct ata_device *dev = &ap->device[i];
		unsigned long flags;

		if (!(dev->flags & ATA_DFLAG_DETACHED))
			continue;

3084
		spin_lock_irqsave(ap->lock, flags);
3085
		dev->flags &= ~ATA_DFLAG_DETACHED;
3086
		spin_unlock_irqrestore(ap->lock, flags);
3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100

		ata_scsi_remove_dev(dev);
	}

	/* scan for new ones */
	ata_scsi_scan_host(ap);

	/* If we scanned while EH was in progress, scan would have
	 * failed silently.  Requeue if there are enabled but
	 * unattached devices.
	 */
	for (i = 0; i < ATA_MAX_DEVICES; i++) {
		struct ata_device *dev = &ap->device[i];
		if (ata_dev_enabled(dev) && !dev->sdev) {
3101 3102
			queue_delayed_work(ata_aux_wq, &ap->hotplug_task,
				round_jiffies_relative(HZ));
3103 3104 3105 3106 3107 3108
			break;
		}
	}

	DPRINTK("EXIT\n");
}
3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139

/**
 *	ata_scsi_user_scan - indication for user-initiated bus scan
 *	@shost: SCSI host to scan
 *	@channel: Channel to scan
 *	@id: ID to scan
 *	@lun: LUN to scan
 *
 *	This function is called when user explicitly requests bus
 *	scan.  Set probe pending flag and invoke EH.
 *
 *	LOCKING:
 *	SCSI layer (we don't care)
 *
 *	RETURNS:
 *	Zero.
 */
static int ata_scsi_user_scan(struct Scsi_Host *shost, unsigned int channel,
			      unsigned int id, unsigned int lun)
{
	struct ata_port *ap = ata_shost_to_port(shost);
	unsigned long flags;
	int rc = 0;

	if (!ap->ops->error_handler)
		return -EOPNOTSUPP;

	if ((channel != SCAN_WILD_CARD && channel != 0) ||
	    (lun != SCAN_WILD_CARD && lun != 0))
		return -EINVAL;

3140
	spin_lock_irqsave(ap->lock, flags);
3141 3142 3143 3144 3145 3146 3147 3148 3149 3150

	if (id == SCAN_WILD_CARD) {
		ap->eh_info.probe_mask |= (1 << ATA_MAX_DEVICES) - 1;
		ap->eh_info.action |= ATA_EH_SOFTRESET;
	} else {
		struct ata_device *dev = ata_find_dev(ap, id);

		if (dev) {
			ap->eh_info.probe_mask |= 1 << dev->devno;
			ap->eh_info.action |= ATA_EH_SOFTRESET;
3151
			ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3152 3153 3154 3155
		} else
			rc = -EINVAL;
	}

3156
	if (rc == 0) {
3157
		ata_port_schedule_eh(ap);
3158 3159 3160 3161
		spin_unlock_irqrestore(ap->lock, flags);
		ata_port_wait_eh(ap);
	} else
		spin_unlock_irqrestore(ap->lock, flags);
3162 3163 3164

	return rc;
}
3165 3166

/**
3167
 *	ata_scsi_dev_rescan - initiate scsi_rescan_device()
3168
 *	@work: Pointer to ATA port to perform scsi_rescan_device()
3169
 *
3170 3171 3172 3173
 *	After ATA pass thru (SAT) commands are executed successfully,
 *	libata need to propagate the changes to SCSI layer.  This
 *	function must be executed from ata_aux_wq such that sdev
 *	attach/detach don't race with rescan.
3174
 *
3175 3176
 *	LOCKING:
 *	Kernel thread context (may sleep).
3177
 */
3178
void ata_scsi_dev_rescan(struct work_struct *work)
3179
{
3180 3181
	struct ata_port *ap =
		container_of(work, struct ata_port, scsi_rescan_task);
3182
	unsigned long flags;
3183 3184
	unsigned int i;

3185 3186
	spin_lock_irqsave(ap->lock, flags);

3187
	for (i = 0; i < ATA_MAX_DEVICES; i++) {
3188 3189
		struct ata_device *dev = &ap->device[i];
		struct scsi_device *sdev = dev->sdev;
3190

3191 3192 3193 3194 3195 3196 3197 3198 3199
		if (!ata_dev_enabled(dev) || !sdev)
			continue;
		if (scsi_device_get(sdev))
			continue;

		spin_unlock_irqrestore(ap->lock, flags);
		scsi_rescan_device(&(sdev->sdev_gendev));
		scsi_device_put(sdev);
		spin_lock_irqsave(ap->lock, flags);
3200
	}
3201 3202

	spin_unlock_irqrestore(ap->lock, flags);
3203
}
3204 3205 3206

/**
 *	ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3207
 *	@host: ATA host container for all SAS ports
3208
 *	@port_info: Information from low-level host driver
J
Jeff Garzik 已提交
3209
 *	@shost: SCSI host that the scsi device is attached to
3210 3211 3212 3213 3214 3215 3216 3217
 *
 *	LOCKING:
 *	PCI/etc. bus probe sem.
 *
 *	RETURNS:
 *	ata_port pointer on success / NULL on failure.
 */

J
Jeff Garzik 已提交
3218
struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3219
				    struct ata_port_info *port_info,
J
Jeff Garzik 已提交
3220
				    struct Scsi_Host *shost)
3221 3222 3223 3224 3225 3226 3227
{
	struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
	struct ata_probe_ent *ent;

	if (!ap)
		return NULL;

J
Jeff Garzik 已提交
3228
	ent = ata_probe_ent_alloc(host->dev, port_info);
3229 3230 3231 3232 3233
	if (!ent) {
		kfree(ap);
		return NULL;
	}

J
Jeff Garzik 已提交
3234 3235
	ata_port_init(ap, host, ent, 0);
	ap->lock = shost->host_lock;
3236
	devm_kfree(host->dev, ent);
3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306
	return ap;
}
EXPORT_SYMBOL_GPL(ata_sas_port_alloc);

/**
 *	ata_sas_port_start - Set port up for dma.
 *	@ap: Port to initialize
 *
 *	Called just after data structures for each port are
 *	initialized.  Allocates DMA pad.
 *
 *	May be used as the port_start() entry in ata_port_operations.
 *
 *	LOCKING:
 *	Inherited from caller.
 */
int ata_sas_port_start(struct ata_port *ap)
{
	return ata_pad_alloc(ap, ap->dev);
}
EXPORT_SYMBOL_GPL(ata_sas_port_start);

/**
 *	ata_port_stop - Undo ata_sas_port_start()
 *	@ap: Port to shut down
 *
 *	Frees the DMA pad.
 *
 *	May be used as the port_stop() entry in ata_port_operations.
 *
 *	LOCKING:
 *	Inherited from caller.
 */

void ata_sas_port_stop(struct ata_port *ap)
{
	ata_pad_free(ap, ap->dev);
}
EXPORT_SYMBOL_GPL(ata_sas_port_stop);

/**
 *	ata_sas_port_init - Initialize a SATA device
 *	@ap: SATA port to initialize
 *
 *	LOCKING:
 *	PCI/etc. bus probe sem.
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */

int ata_sas_port_init(struct ata_port *ap)
{
	int rc = ap->ops->port_start(ap);

	if (!rc)
		rc = ata_bus_probe(ap);

	return rc;
}
EXPORT_SYMBOL_GPL(ata_sas_port_init);

/**
 *	ata_sas_port_destroy - Destroy a SATA port allocated by ata_sas_port_alloc
 *	@ap: SATA port to destroy
 *
 */

void ata_sas_port_destroy(struct ata_port *ap)
{
3307 3308
	if (ap->ops->port_stop)
		ap->ops->port_stop(ap);
3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
	kfree(ap);
}
EXPORT_SYMBOL_GPL(ata_sas_port_destroy);

/**
 *	ata_sas_slave_configure - Default slave_config routine for libata devices
 *	@sdev: SCSI device to configure
 *	@ap: ATA port to which SCSI device is attached
 *
 *	RETURNS:
 *	Zero.
 */

int ata_sas_slave_configure(struct scsi_device *sdev, struct ata_port *ap)
{
	ata_scsi_sdev_config(sdev);
	ata_scsi_dev_config(sdev, ap->device);
	return 0;
}
EXPORT_SYMBOL_GPL(ata_sas_slave_configure);

/**
 *	ata_sas_queuecmd - Issue SCSI cdb to libata-managed device
 *	@cmd: SCSI command to be sent
 *	@done: Completion function, called when command is complete
 *	@ap:	ATA port to which the command is being sent
 *
 *	RETURNS:
3337 3338
 *	Return value from __ata_scsi_queuecmd() if @cmd can be queued,
 *	0 otherwise.
3339 3340 3341 3342 3343
 */

int ata_sas_queuecmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *),
		     struct ata_port *ap)
{
3344 3345
	int rc = 0;

3346 3347 3348
	ata_scsi_dump_cdb(ap, cmd);

	if (likely(ata_scsi_dev_enabled(ap->device)))
3349
		rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3350 3351 3352 3353
	else {
		cmd->result = (DID_BAD_TARGET << 16);
		done(cmd);
	}
3354
	return rc;
3355 3356
}
EXPORT_SYMBOL_GPL(ata_sas_queuecmd);