libata-scsi.c 83.6 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

J
Jeff Garzik 已提交
54
typedef unsigned int (*ata_xlat_func_t)(struct ata_queued_cmd *qc, const u8 *scsicmd);
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;
}

151 152
/**
 *	ata_cmd_ioctl - Handler for HDIO_DRIVE_CMD ioctl
R
Randy Dunlap 已提交
153
 *	@scsidev: Device to which we are issuing command
154 155 156 157 158 159 160 161 162 163 164 165 166
 *	@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];
167
	u8 args[4], *argbuf = NULL, *sensebuf = NULL;
168
	int argsize = 0;
169
	enum dma_data_direction data_dir;
170
	int cmd_result;
171

172
	if (arg == NULL)
173 174 175 176 177
		return -EINVAL;

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

178 179 180 181
	sensebuf = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_NOIO);
	if (!sensebuf)
		return -ENOMEM;

182 183 184 185 186
	memset(scsi_cmd, 0, sizeof(scsi_cmd));

	if (args[3]) {
		argsize = SECTOR_SIZE * args[3];
		argbuf = kmalloc(argsize, GFP_KERNEL);
187 188 189 190
		if (argbuf == NULL) {
			rc = -ENOMEM;
			goto error;
		}
191 192 193 194

		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 */
195
		data_dir = DMA_FROM_DEVICE;
196 197
	} else {
		scsi_cmd[1]  = (3 << 1); /* Non-data */
198
		scsi_cmd[2]  = 0x20;     /* cc but no off.line or data xfer */
199
		data_dir = DMA_NONE;
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
	}

	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... */
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
	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) {
248 249 250 251 252
		rc = -EIO;
		goto error;
	}

	if ((argbuf)
253
	 && copy_to_user(arg + sizeof(args), argbuf, argsize))
254 255
		rc = -EFAULT;
error:
256
	kfree(sensebuf);
257
	kfree(argbuf);
258 259 260 261 262
	return rc;
}

/**
 *	ata_task_ioctl - Handler for HDIO_DRIVE_TASK ioctl
R
Randy Dunlap 已提交
263
 *	@scsidev: Device to which we are issuing command
264 265 266 267 268 269 270 271 272 273 274 275 276
 *	@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];
	u8 args[7];
277
	struct scsi_sense_hdr sshdr;
278

279
	if (arg == NULL)
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
		return -EINVAL;

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

	memset(scsi_cmd, 0, sizeof(scsi_cmd));
	scsi_cmd[0]  = ATA_16;
	scsi_cmd[1]  = (3 << 1); /* Non-data */
	/* scsi_cmd[2] is already 0 -- no off.line, cc, or data xfer */
	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];
	scsi_cmd[14] = args[0];

	/* Good values for timeout and retries?  Values below
297
	   from scsi_ioctl_send_command() for default case... */
298 299
	if (scsi_execute_req(scsidev, scsi_cmd, DMA_NONE, NULL, 0, &sshdr,
			     (10*HZ), 5))
300 301 302 303 304 305
		rc = -EIO;

	/* Need code to retrieve data from check condition? */
	return rc;
}

L
Linus Torvalds 已提交
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
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;

323 324 325 326 327 328 329 330 331 332
	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 已提交
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
	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 已提交
356
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
357 358 359 360
 *
 *	RETURNS:
 *	Command allocated, or %NULL if none available.
 */
T
Tejun Heo 已提交
361
struct ata_queued_cmd *ata_scsi_qc_new(struct ata_device *dev,
L
Linus Torvalds 已提交
362 363 364 365 366
				       struct scsi_cmnd *cmd,
				       void (*done)(struct scsi_cmnd *))
{
	struct ata_queued_cmd *qc;

T
Tejun Heo 已提交
367
	qc = ata_qc_new_init(dev);
L
Linus Torvalds 已提交
368 369 370 371 372
	if (qc) {
		qc->scsicmd = cmd;
		qc->scsidone = done;

		if (cmd->use_sg) {
373
			qc->__sg = (struct scatterlist *) cmd->request_buffer;
L
Linus Torvalds 已提交
374 375
			qc->n_elem = cmd->use_sg;
		} else {
376
			qc->__sg = &qc->sgent;
L
Linus Torvalds 已提交
377 378 379 380 381 382 383 384 385 386
			qc->n_elem = 1;
		}
	} else {
		cmd->result = (DID_OK << 16) | (QUEUE_FULL << 1);
		done(cmd);
	}

	return qc;
}

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
/**
 *	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
 */
void ata_dump_status(unsigned id, struct ata_taskfile *tf)
{
	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");
		}
	}
}

432 433 434
/**
 *	ata_scsi_device_suspend - suspend ATA device associated with sdev
 *	@sdev: the SCSI device to suspend
435
 *	@mesg: target power management message
436 437 438 439 440 441 442 443 444 445
 *
 *	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.
 */
446
int ata_scsi_device_suspend(struct scsi_device *sdev, pm_message_t mesg)
J
Jens Axboe 已提交
447
{
448
	struct ata_port *ap = ata_shost_to_port(sdev->host);
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
	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;
473
	if (mesg.event != PM_EVENT_SUSPEND)
474 475 476 477 478 479
		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 已提交
480

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
	/* 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)
498
		sdev->sdev_gendev.power.power_state = mesg;
499
	return rc;
J
Jens Axboe 已提交
500 501
}

502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
/**
 *	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 已提交
517
{
518
	struct ata_port *ap = ata_shost_to_port(sdev->host);
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
	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 已提交
555 556
}

L
Linus Torvalds 已提交
557 558
/**
 *	ata_to_sense_error - convert ATA error to SCSI error
R
Randy Dunlap 已提交
559
 *	@id: ATA device number
L
Linus Torvalds 已提交
560
 *	@drv_stat: value contained in ATA status register
561 562 563 564
 *	@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
565
 *	@verbose: be verbose
L
Linus Torvalds 已提交
566
 *
567 568 569
 *	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 已提交
570 571
 *
 *	LOCKING:
J
Jeff Garzik 已提交
572
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
573
 */
574
void ata_to_sense_error(unsigned id, u8 drv_stat, u8 drv_err, u8 *sk, u8 *asc,
575
			u8 *ascq, int verbose)
L
Linus Torvalds 已提交
576
{
577
	int i;
J
Jeff Garzik 已提交
578

L
Linus Torvalds 已提交
579
	/* Based on the 3ware driver translation table */
580
	static const unsigned char sense_table[][4] = {
L
Linus Torvalds 已提交
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
		/* 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
	};
611
	static const unsigned char stat_table[][4] = {
L
Linus Torvalds 已提交
612 613 614 615 616 617 618 619 620 621 622
		/* 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
	 */
623 624
	if (drv_stat & ATA_BUSY) {
		drv_err = 0;	/* Ignore the err bits, they're invalid */
L
Linus Torvalds 已提交
625
	}
626 627 628 629 630

	if (drv_err) {
		/* Look for drv_err */
		for (i = 0; sense_table[i][0] != 0xFF; i++) {
			/* Look for best matches first */
631
			if ((sense_table[i][0] & drv_err) ==
632 633 634 635 636 637 638 639
			    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 */
640 641 642
		if (verbose)
			printk(KERN_WARNING "ata%u: no sense translation for "
			       "error 0x%02x\n", id, drv_err);
L
Linus Torvalds 已提交
643
	}
644 645 646 647 648 649 650 651

	/* 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 已提交
652
		}
653 654
	}
	/* No error?  Undecoded? */
655 656 657
	if (verbose)
		printk(KERN_WARNING "ata%u: no sense translation for "
		       "status: 0x%02x\n", id, drv_stat);
658

659 660 661 662 663
	/* 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;
664 665

 translate_done:
666 667 668 669
	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);
670 671 672 673
	return;
}

/*
674
 *	ata_gen_passthru_sense - Generate check condition sense block.
675 676 677 678 679 680 681 682 683
 *	@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:
684
 *	None.
685
 */
686
static void ata_gen_passthru_sense(struct ata_queued_cmd *qc)
687 688
{
	struct scsi_cmnd *cmd = qc->scsicmd;
689
	struct ata_taskfile *tf = &qc->result_tf;
690 691
	unsigned char *sb = cmd->sense_buffer;
	unsigned char *desc = sb + 8;
692
	int verbose = qc->ap->ops->error_handler == NULL;
693 694 695

	memset(sb, 0, SCSI_SENSE_BUFFERSIZE);

696
	cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
697 698 699 700 701

	/*
	 * Use ata_to_sense_error() to map status register bits
	 * onto sense key, asc & ascq.
	 */
702 703
	if (qc->err_mask ||
	    tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
704
		ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
705
				   &sb[1], &sb[2], &sb[3], verbose);
706
		sb[1] &= 0x0f;
L
Linus Torvalds 已提交
707 708
	}

709 710 711 712
	/*
	 * Sense data is current and format is descriptor.
	 */
	sb[0] = 0x72;
L
Linus Torvalds 已提交
713

714 715
	desc[0] = 0x09;

716 717 718
	/* set length of additional sense data */
	sb[7] = 14;
	desc[1] = 12;
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741

	/*
	 * 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 已提交
742
	}
743
}
L
Linus Torvalds 已提交
744

745
/**
746
 *	ata_gen_ata_sense - generate a SCSI fixed sense block
747 748
 *	@qc: Command that we are erroring out
 *
749 750
 *	Generate sense block for a failed ATA command @qc.  Descriptor
 *	format is used to accomodate LBA48 block address.
751 752
 *
 *	LOCKING:
753
 *	None.
754
 */
755
static void ata_gen_ata_sense(struct ata_queued_cmd *qc)
756
{
757
	struct ata_device *dev = qc->dev;
758
	struct scsi_cmnd *cmd = qc->scsicmd;
759
	struct ata_taskfile *tf = &qc->result_tf;
760
	unsigned char *sb = cmd->sense_buffer;
761
	unsigned char *desc = sb + 8;
762
	int verbose = qc->ap->ops->error_handler == NULL;
763
	u64 block;
764 765 766

	memset(sb, 0, SCSI_SENSE_BUFFERSIZE);

767
	cmd->result = (DRIVER_SENSE << 24) | SAM_STAT_CHECK_CONDITION;
768

769 770 771 772
	/* sense data is current and format is descriptor */
	sb[0] = 0x72;

	/* Use ata_to_sense_error() to map status register bits
773 774
	 * onto sense key, asc & ascq.
	 */
775 776
	if (qc->err_mask ||
	    tf->command & (ATA_BUSY | ATA_DF | ATA_ERR | ATA_DRQ)) {
777
		ata_to_sense_error(qc->ap->id, tf->command, tf->feature,
778 779
				   &sb[1], &sb[2], &sb[3], verbose);
		sb[1] &= 0x0f;
L
Linus Torvalds 已提交
780 781
	}

782
	block = ata_tf_read_block(&qc->result_tf, dev);
783

784 785 786 787
	/* information sense data descriptor */
	sb[7] = 12;
	desc[0] = 0x00;
	desc[1] = 10;
788

789 790 791 792 793 794 795
	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 已提交
796 797
}

798 799 800 801 802 803 804 805 806
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)
{
807 808
	/* configure max sectors */
	blk_queue_max_sectors(sdev->request_queue, dev->max_sectors);
809

810
	/* SATA DMA transfers must be multiples of 4 byte, so
811 812 813 814 815 816 817
	 * 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);
	}
818 819 820 821 822 823 824 825

	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);
	}
826 827
}

L
Linus Torvalds 已提交
828 829 830 831 832 833 834 835 836 837 838 839 840 841
/**
 *	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)
{
842 843 844
	struct ata_port *ap = ata_shost_to_port(sdev->host);
	struct ata_device *dev = __ata_scsi_find_dev(ap, sdev);

845
	ata_scsi_sdev_config(sdev);
L
Linus Torvalds 已提交
846 847 848

	blk_queue_max_phys_segments(sdev->request_queue, LIBATA_MAX_PRD);

849
	if (dev)
850
		ata_scsi_dev_config(sdev, dev);
L
Linus Torvalds 已提交
851 852 853 854

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

855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
/**
 *	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;

878
	spin_lock_irqsave(ap->lock, flags);
879 880 881 882 883 884 885
	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);
	}
886
	spin_unlock_irqrestore(ap->lock, flags);
887 888
}

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
/**
 *	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;
908
	unsigned long flags;
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
	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);
924 925 926 927 928 929 930 931

	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);

932 933 934
	return queue_depth;
}

935 936 937 938 939 940 941 942 943 944 945
/**
 *	ata_scsi_start_stop_xlat - Translate SCSI START STOP UNIT command
 *	@qc: Storage for translated ATA taskfile
 *	@scsicmd: SCSI command to translate
 *
 *	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 已提交
946
 *	spin_lock_irqsave(host lock)
947 948 949 950 951 952
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */

static unsigned int ata_scsi_start_stop_xlat(struct ata_queued_cmd *qc,
J
Jeff Garzik 已提交
953
					     const u8 *scsicmd)
954 955 956 957 958 959 960 961 962
{
	struct ata_taskfile *tf = &qc->tf;

	tf->flags |= ATA_TFLAG_DEVICE | ATA_TFLAG_ISADDR;
	tf->protocol = ATA_PROT_NODATA;
	if (scsicmd[1] & 0x1) {
		;	/* ignore IMMED bit, violates sat-r05 */
	}
	if (scsicmd[4] & 0x2)
963
		goto invalid_fld;       /* LOEJ bit set not supported */
964
	if (((scsicmd[4] >> 4) & 0xf) != 0)
965
		goto invalid_fld;       /* power conditions not supported */
966 967
	if (scsicmd[4] & 0x1) {
		tf->nsect = 1;	/* 1 sector, lba=0 */
968 969

		if (qc->dev->flags & ATA_DFLAG_LBA) {
970
			tf->flags |= ATA_TFLAG_LBA;
971 972 973 974 975 976 977 978 979 980 981 982

			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 */
		}

983 984 985 986 987 988 989 990 991 992 993 994 995 996
		tf->command = ATA_CMD_VERIFY;	/* READ VERIFY */
	} else {
		tf->nsect = 0;	/* time period value (0 implies now) */
		tf->command = ATA_CMD_STANDBY;
		/* Consider: ATA STANDBY IMMEDIATE command */
	}
	/*
	 * 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;
997 998 999 1000 1001

invalid_fld:
	ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x0);
	/* "Invalid field in cbd" */
	return 1;
1002 1003 1004
}


L
Linus Torvalds 已提交
1005 1006 1007 1008 1009 1010 1011 1012 1013
/**
 *	ata_scsi_flush_xlat - Translate SCSI SYNCHRONIZE CACHE command
 *	@qc: Storage for translated ATA taskfile
 *	@scsicmd: SCSI command to translate (ignored)
 *
 *	Sets up an ATA taskfile to issue FLUSH CACHE or
 *	FLUSH CACHE EXT.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1014
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1015 1016 1017 1018 1019
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */

J
Jeff Garzik 已提交
1020
static unsigned int ata_scsi_flush_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
L
Linus Torvalds 已提交
1021 1022 1023 1024 1025 1026
{
	struct ata_taskfile *tf = &qc->tf;

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

1027
	if (qc->dev->flags & ATA_DFLAG_FLUSH_EXT)
L
Linus Torvalds 已提交
1028 1029 1030 1031 1032 1033 1034
		tf->command = ATA_CMD_FLUSH_EXT;
	else
		tf->command = ATA_CMD_FLUSH;

	return 0;
}

1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
/**
 *	scsi_6_lba_len - Get LBA and transfer length
 *	@scsicmd: SCSI command to translate
 *
 *	Calculate LBA and transfer length for 6-byte commands.
 *
 *	RETURNS:
 *	@plba: the LBA
 *	@plen: the transfer length
 */

J
Jeff Garzik 已提交
1046
static void scsi_6_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072
{
	u64 lba = 0;
	u32 len = 0;

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

	lba |= ((u64)scsicmd[2]) << 8;
	lba |= ((u64)scsicmd[3]);

	len |= ((u32)scsicmd[4]);

	*plba = lba;
	*plen = len;
}

/**
 *	scsi_10_lba_len - Get LBA and transfer length
 *	@scsicmd: SCSI command to translate
 *
 *	Calculate LBA and transfer length for 10-byte commands.
 *
 *	RETURNS:
 *	@plba: the LBA
 *	@plen: the transfer length
 */

J
Jeff Garzik 已提交
1073
static void scsi_10_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
{
	u64 lba = 0;
	u32 len = 0;

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

	lba |= ((u64)scsicmd[2]) << 24;
	lba |= ((u64)scsicmd[3]) << 16;
	lba |= ((u64)scsicmd[4]) << 8;
	lba |= ((u64)scsicmd[5]);

	len |= ((u32)scsicmd[7]) << 8;
	len |= ((u32)scsicmd[8]);

	*plba = lba;
	*plen = len;
}

/**
 *	scsi_16_lba_len - Get LBA and transfer length
 *	@scsicmd: SCSI command to translate
 *
 *	Calculate LBA and transfer length for 16-byte commands.
 *
 *	RETURNS:
 *	@plba: the LBA
 *	@plen: the transfer length
 */

J
Jeff Garzik 已提交
1103
static void scsi_16_lba_len(const u8 *scsicmd, u64 *plba, u32 *plen)
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
{
	u64 lba = 0;
	u32 len = 0;

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

	lba |= ((u64)scsicmd[2]) << 56;
	lba |= ((u64)scsicmd[3]) << 48;
	lba |= ((u64)scsicmd[4]) << 40;
	lba |= ((u64)scsicmd[5]) << 32;
	lba |= ((u64)scsicmd[6]) << 24;
	lba |= ((u64)scsicmd[7]) << 16;
	lba |= ((u64)scsicmd[8]) << 8;
	lba |= ((u64)scsicmd[9]);

	len |= ((u32)scsicmd[10]) << 24;
	len |= ((u32)scsicmd[11]) << 16;
	len |= ((u32)scsicmd[12]) << 8;
	len |= ((u32)scsicmd[13]);

	*plba = lba;
	*plen = len;
}

L
Linus Torvalds 已提交
1128 1129 1130 1131 1132 1133 1134 1135
/**
 *	ata_scsi_verify_xlat - Translate SCSI VERIFY command into an ATA one
 *	@qc: Storage for translated ATA taskfile
 *	@scsicmd: SCSI command to translate
 *
 *	Converts SCSI VERIFY command to an ATA READ VERIFY command.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1136
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1137 1138 1139 1140 1141
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */

J
Jeff Garzik 已提交
1142
static unsigned int ata_scsi_verify_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
L
Linus Torvalds 已提交
1143 1144
{
	struct ata_taskfile *tf = &qc->tf;
1145
	struct ata_device *dev = qc->dev;
L
Linus Torvalds 已提交
1146
	u64 dev_sectors = qc->dev->n_sectors;
1147 1148
	u64 block;
	u32 n_block;
L
Linus Torvalds 已提交
1149 1150 1151 1152

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

1153 1154 1155 1156
	if (scsicmd[0] == VERIFY)
		scsi_10_lba_len(scsicmd, &block, &n_block);
	else if (scsicmd[0] == VERIFY_16)
		scsi_16_lba_len(scsicmd, &block, &n_block);
L
Linus Torvalds 已提交
1157
	else
1158
		goto invalid_fld;
L
Linus Torvalds 已提交
1159

1160
	if (!n_block)
1161
		goto nothing_to_do;
1162
	if (block >= dev_sectors)
1163
		goto out_of_range;
1164
	if ((block + n_block) > dev_sectors)
1165
		goto out_of_range;
L
Linus Torvalds 已提交
1166

1167 1168 1169
	if (dev->flags & ATA_DFLAG_LBA) {
		tf->flags |= ATA_TFLAG_LBA;

1170 1171 1172 1173 1174 1175 1176
		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;
1177 1178 1179

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

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

1184 1185 1186
			tf->hob_lbah = (block >> 40) & 0xff;
			tf->hob_lbam = (block >> 32) & 0xff;
			tf->hob_lbal = (block >> 24) & 0xff;
1187 1188 1189
		} else
			/* request too large even for LBA48 */
			goto out_of_range;
1190 1191

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

1193 1194 1195
		tf->lbah = (block >> 16) & 0xff;
		tf->lbam = (block >> 8) & 0xff;
		tf->lbal = block & 0xff;
L
Linus Torvalds 已提交
1196

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

1202 1203
		if (!lba_28_ok(block, n_block))
			goto out_of_range;
1204

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

1211 1212
		DPRINTK("block %u track %u cyl %u head %u sect %u\n",
			(u32)block, track, cyl, head, sect);
1213 1214 1215

		/* Check whether the converted CHS can fit.
		   Cylinder: 0-65535
1216 1217
		   Head: 0-15
		   Sector: 1-255*/
1218
		if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1219
			goto out_of_range;
1220

1221 1222 1223 1224 1225 1226 1227
		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 已提交
1228 1229

	return 0;
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243

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

out_of_range:
	ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
	/* "Logical Block Address out of range" */
	return 1;

nothing_to_do:
	qc->scsicmd->result = SAM_STAT_GOOD;
	return 1;
L
Linus Torvalds 已提交
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
}

/**
 *	ata_scsi_rw_xlat - Translate SCSI r/w command into an ATA one
 *	@qc: Storage for translated ATA taskfile
 *	@scsicmd: SCSI command to translate
 *
 *	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 已提交
1260
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1261 1262 1263 1264 1265
 *
 *	RETURNS:
 *	Zero on success, non-zero on error.
 */

J
Jeff Garzik 已提交
1266
static unsigned int ata_scsi_rw_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
L
Linus Torvalds 已提交
1267 1268
{
	struct ata_taskfile *tf = &qc->tf;
1269
	struct ata_device *dev = qc->dev;
1270 1271
	u64 block;
	u32 n_block;
L
Linus Torvalds 已提交
1272

T
Tejun Heo 已提交
1273
	qc->flags |= ATA_QCFLAG_IO;
L
Linus Torvalds 已提交
1274 1275
	tf->flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;

1276 1277
	if (scsicmd[0] == WRITE_10 || scsicmd[0] == WRITE_6 ||
	    scsicmd[0] == WRITE_16)
L
Linus Torvalds 已提交
1278 1279
		tf->flags |= ATA_TFLAG_WRITE;

T
Tejun Heo 已提交
1280
	/* Calculate the SCSI LBA, transfer length and FUA. */
1281 1282 1283 1284
	switch (scsicmd[0]) {
	case READ_10:
	case WRITE_10:
		scsi_10_lba_len(scsicmd, &block, &n_block);
T
Tejun Heo 已提交
1285 1286
		if (unlikely(scsicmd[1] & (1 << 3)))
			tf->flags |= ATA_TFLAG_FUA;
1287 1288 1289 1290
		break;
	case READ_6:
	case WRITE_6:
		scsi_6_lba_len(scsicmd, &block, &n_block);
1291 1292 1293 1294

		/* for 6-byte r/w commands, transfer length 0
		 * means 256 blocks of data, not 0 block.
		 */
1295 1296
		if (!n_block)
			n_block = 256;
1297 1298 1299 1300
		break;
	case READ_16:
	case WRITE_16:
		scsi_16_lba_len(scsicmd, &block, &n_block);
T
Tejun Heo 已提交
1301 1302
		if (unlikely(scsicmd[1] & (1 << 3)))
			tf->flags |= ATA_TFLAG_FUA;
1303 1304
		break;
	default:
1305
		DPRINTK("no-byte command\n");
1306
		goto invalid_fld;
L
Linus Torvalds 已提交
1307 1308
	}

1309 1310
	/* Check and compose ATA command */
	if (!n_block)
1311 1312 1313 1314
		/* 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 已提交
1315 1316
		 *
		 * WARNING: one or two older ATA drives treat 0 as 0...
1317
		 */
1318
		goto nothing_to_do;
L
Linus Torvalds 已提交
1319

1320 1321
	if ((dev->flags & (ATA_DFLAG_PIO | ATA_DFLAG_NCQ_OFF |
			   ATA_DFLAG_NCQ)) == ATA_DFLAG_NCQ) {
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
		/* yay, NCQ */
		if (!lba_48_ok(block, n_block))
			goto out_of_range;

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

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

		qc->nsect = n_block;

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

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

		tf->device = 1 << 6;
		if (tf->flags & ATA_TFLAG_FUA)
			tf->device |= 1 << 7;
	} else if (dev->flags & ATA_DFLAG_LBA) {
1351 1352
		tf->flags |= ATA_TFLAG_LBA;

1353 1354 1355 1356 1357
		if (lba_28_ok(block, n_block)) {
			/* use LBA28 */
			tf->device |= (block >> 24) & 0xf;
		} else if (lba_48_ok(block, n_block)) {
			if (!(dev->flags & ATA_DFLAG_LBA48))
1358
				goto out_of_range;
L
Linus Torvalds 已提交
1359

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

1363 1364 1365 1366 1367
			tf->hob_nsect = (n_block >> 8) & 0xff;

			tf->hob_lbah = (block >> 40) & 0xff;
			tf->hob_lbam = (block >> 32) & 0xff;
			tf->hob_lbal = (block >> 24) & 0xff;
1368 1369 1370
		} else
			/* request too large even for LBA48 */
			goto out_of_range;
1371

T
Tejun Heo 已提交
1372 1373
		if (unlikely(ata_rwcmd_protocol(qc) < 0))
			goto invalid_fld;
1374

1375 1376
		qc->nsect = n_block;
		tf->nsect = n_block & 0xff;
L
Linus Torvalds 已提交
1377

1378 1379 1380
		tf->lbah = (block >> 16) & 0xff;
		tf->lbam = (block >> 8) & 0xff;
		tf->lbal = block & 0xff;
L
Linus Torvalds 已提交
1381

1382
		tf->device |= ATA_LBA;
1383
	} else {
1384 1385 1386 1387
		/* CHS */
		u32 sect, head, cyl, track;

		/* The request -may- be too large for CHS addressing. */
1388
		if (!lba_28_ok(block, n_block))
1389
			goto out_of_range;
1390

T
Tejun Heo 已提交
1391 1392
		if (unlikely(ata_rwcmd_protocol(qc) < 0))
			goto invalid_fld;
1393

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

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

1403 1404
		/* Check whether the converted CHS can fit.
		   Cylinder: 0-65535
1405 1406
		   Head: 0-15
		   Sector: 1-255*/
1407
		if ((cyl >> 16) || (head >> 4) || (sect >> 8) || (!sect))
1408
			goto out_of_range;
1409

1410 1411 1412 1413 1414 1415
		qc->nsect = n_block;
		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 已提交
1416 1417
	}

1418
	return 0;
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432

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

out_of_range:
	ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x21, 0x0);
	/* "Logical Block Address out of range" */
	return 1;

nothing_to_do:
	qc->scsicmd->result = SAM_STAT_GOOD;
	return 1;
L
Linus Torvalds 已提交
1433 1434
}

1435
static void ata_scsi_qc_complete(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
1436
{
1437
	struct ata_port *ap = qc->ap;
L
Linus Torvalds 已提交
1438
	struct scsi_cmnd *cmd = qc->scsicmd;
1439
	u8 *cdb = cmd->cmnd;
1440
 	int need_sense = (qc->err_mask != 0);
1441

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

1454 1455 1456 1457 1458 1459 1460
	/* 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.
	 */
1461 1462
	if (((cdb[0] == ATA_16) || (cdb[0] == ATA_12)) &&
 	    ((cdb[2] & 0x20) || need_sense)) {
1463
		ata_gen_passthru_sense(qc);
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
	} 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.
			 */
1474
			ata_gen_ata_sense(qc);
1475 1476
		}
	}
L
Linus Torvalds 已提交
1477

1478 1479
	if (need_sense && !ap->ops->error_handler)
		ata_dump_status(ap->id, &qc->result_tf);
L
Linus Torvalds 已提交
1480 1481 1482

	qc->scsidone(cmd);

1483
	ata_qc_free(qc);
L
Linus Torvalds 已提交
1484 1485
}

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
/**
 *	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 已提交
1497
 *	spin_lock_irqsave(host lock)
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
 *
 *	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;

	if (!(dev->flags & ATA_DFLAG_NCQ))
		return 0;

	if (is_io) {
		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 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
/**
 *	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.
 *
1533 1534 1535 1536 1537 1538
 *	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 已提交
1539
 *	LOCKING:
J
Jeff Garzik 已提交
1540
 *	spin_lock_irqsave(host lock)
1541 1542 1543 1544
 *
 *	RETURNS:
 *	0 on success, SCSI_ML_QUEUE_DEVICE_BUSY if the command
 *	needs to be deferred.
L
Linus Torvalds 已提交
1545
 */
1546 1547 1548
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 已提交
1549 1550 1551
{
	struct ata_queued_cmd *qc;
	u8 *scsicmd = cmd->cmnd;
1552
	int is_io = xlat_func == ata_scsi_rw_xlat;
L
Linus Torvalds 已提交
1553 1554 1555

	VPRINTK("ENTER\n");

1556 1557 1558
	if (unlikely(ata_scmd_need_defer(dev, is_io)))
		goto defer;

T
Tejun Heo 已提交
1559
	qc = ata_scsi_qc_new(dev, cmd, done);
L
Linus Torvalds 已提交
1560
	if (!qc)
1561
		goto err_mem;
L
Linus Torvalds 已提交
1562 1563

	/* data is present; dma-map it */
1564 1565
	if (cmd->sc_data_direction == DMA_FROM_DEVICE ||
	    cmd->sc_data_direction == DMA_TO_DEVICE) {
L
Linus Torvalds 已提交
1566
		if (unlikely(cmd->request_bufflen < 1)) {
1567 1568
			ata_dev_printk(dev, KERN_WARNING,
				       "WARNING: zero len r/w req\n");
1569
			goto err_did;
L
Linus Torvalds 已提交
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
		}

		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;

	if (xlat_func(qc, scsicmd))
1584
		goto early_finish;
L
Linus Torvalds 已提交
1585 1586

	/* select device, send command to hardware */
1587
	ata_qc_issue(qc);
L
Linus Torvalds 已提交
1588 1589

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

1592 1593 1594 1595
early_finish:
        ata_qc_free(qc);
	done(cmd);
	DPRINTK("EXIT - early finish (good or error)\n");
1596
	return 0;
1597 1598

err_did:
L
Linus Torvalds 已提交
1599
	ata_qc_free(qc);
1600 1601
	cmd->result = (DID_ERROR << 16);
	done(cmd);
1602
err_mem:
1603
	DPRINTK("EXIT - internal\n");
1604
	return 0;
1605 1606 1607 1608

defer:
	DPRINTK("EXIT - defer\n");
	return SCSI_MLQUEUE_DEVICE_BUSY;
L
Linus Torvalds 已提交
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
}

/**
 *	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 已提交
1619
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652
 *
 *	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;
		buf = kmap_atomic(sg->page, KM_USER0) + sg->offset;
		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 已提交
1653
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
 */

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;
		kunmap_atomic(buf - sg->offset, KM_USER0);
	}
}

/**
 *	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
1675 1676
 *	completed successfully (0), or not (in which case cmd->result
 *	and sense buffer are assumed to be set).
L
Linus Torvalds 已提交
1677 1678
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1679
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
 */

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);

1695
	if (rc == 0)
L
Linus Torvalds 已提交
1696
		cmd->result = SAM_STAT_GOOD;
1697
	args->done(cmd);
L
Linus Torvalds 已提交
1698 1699
}

1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
/**
 *	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 已提交
1716 1717 1718 1719 1720 1721 1722
/**
 *	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 已提交
1723
 *	with non-VPD INQUIRY command output.
L
Linus Torvalds 已提交
1724 1725
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1726
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
 */

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);
1750 1751
		ata_id_string(args->id, &rbuf[16], ATA_ID_PROD_OFS, 16);
		ata_id_string(args->id, &rbuf[32], ATA_ID_FW_REV_OFS, 4);
L
Linus Torvalds 已提交
1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
		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 已提交
1774
 *	ata_scsiop_inq_00 - Simulate INQUIRY VPD page 0, list of pages
L
Linus Torvalds 已提交
1775 1776 1777 1778
 *	@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 已提交
1779
 *	Returns list of inquiry VPD pages available.
L
Linus Torvalds 已提交
1780 1781
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1782
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
 */

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 已提交
1793
	rbuf[3] = sizeof(pages);	/* number of supported VPD pages */
L
Linus Torvalds 已提交
1794 1795 1796 1797 1798 1799 1800 1801

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

	return 0;
}

/**
J
Jeff Garzik 已提交
1802
 *	ata_scsiop_inq_80 - Simulate INQUIRY VPD page 80, device serial number
L
Linus Torvalds 已提交
1803 1804 1805 1806 1807 1808 1809
 *	@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 已提交
1810
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
 */

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,
		ATA_SERNO_LEN,		/* page len */
	};
	memcpy(rbuf, hdr, sizeof(hdr));

	if (buflen > (ATA_SERNO_LEN + 4 - 1))
1825 1826
		ata_id_string(args->id, (unsigned char *) &rbuf[4],
			      ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
L
Linus Torvalds 已提交
1827 1828 1829 1830 1831

	return 0;
}

/**
J
Jeff Garzik 已提交
1832
 *	ata_scsiop_inq_83 - Simulate INQUIRY VPD page 83, device identity
L
Linus Torvalds 已提交
1833 1834 1835 1836
 *	@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 已提交
1837 1838 1839 1840
 *	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 已提交
1841 1842
 *
 *	LOCKING:
J
Jeff Garzik 已提交
1843
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
1844 1845 1846 1847 1848
 */

unsigned int ata_scsiop_inq_83(struct ata_scsi_args *args, u8 *rbuf,
			      unsigned int buflen)
{
J
Jeff Garzik 已提交
1849 1850 1851
	int num;
	const int sat_model_serial_desc_len = 68;
	const int ata_model_byte_len = 40;
L
Linus Torvalds 已提交
1852

J
Jeff Garzik 已提交
1853 1854 1855 1856 1857
	rbuf[1] = 0x83;			/* this page code */
	num = 4;

	if (buflen > (ATA_SERNO_LEN + num + 3)) {
		/* piv=0, assoc=lu, code_set=ACSII, designator=vendor */
1858
		rbuf[num + 0] = 2;
J
Jeff Garzik 已提交
1859 1860 1861 1862 1863
		rbuf[num + 3] = ATA_SERNO_LEN;
		num += 4;
		ata_id_string(args->id, (unsigned char *) rbuf + num,
			      ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
		num += ATA_SERNO_LEN;
L
Linus Torvalds 已提交
1864
	}
J
Jeff Garzik 已提交
1865 1866 1867
	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 */
1868 1869
		rbuf[num + 0] = 2;
		rbuf[num + 1] = 1;
J
Jeff Garzik 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
		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,
			      ATA_ID_PROD_OFS, ata_model_byte_len);
		num += ata_model_byte_len;
		ata_id_string(args->id, (unsigned char *) rbuf + num,
			      ATA_ID_SERNO_OFS, ATA_SERNO_LEN);
		num += ATA_SERNO_LEN;
	}
	rbuf[3] = num - 4;    /* page len (assume less than 256 bytes) */
L
Linus Torvalds 已提交
1882 1883 1884 1885
	return 0;
}

/**
J
Jeff Garzik 已提交
1886
 *	ata_scsiop_noop - Command handler that simply returns success.
L
Linus Torvalds 已提交
1887 1888 1889 1890 1891 1892 1893 1894
 *	@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 已提交
1895
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
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 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949
 */

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)
{
1950
	u8 page[CACHE_MPAGE_LEN];
L
Linus Torvalds 已提交
1951

1952
	memcpy(page, def_cache_mpage, sizeof(page));
L
Linus Torvalds 已提交
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
	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)
{
1976 1977 1978
	ata_msense_push(ptr_io, last, def_control_mpage,
			sizeof(def_control_mpage));
	return sizeof(def_control_mpage);
L
Linus Torvalds 已提交
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
}

/**
 *	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)
{

1996 1997 1998
	ata_msense_push(ptr_io, last, def_rw_recovery_mpage,
			sizeof(def_rw_recovery_mpage));
	return sizeof(def_rw_recovery_mpage);
L
Linus Torvalds 已提交
1999 2000
}

2001 2002 2003 2004 2005 2006 2007 2008
/*
 * 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)
{
	unsigned char model[41], fw[9];

J
Jeff Garzik 已提交
2009 2010
	if (!libata_fua)
		return 0;
2011 2012 2013
	if (!ata_id_has_fua(id))
		return 0;

2014 2015
	ata_id_c_string(id, model, ATA_ID_PROD_OFS, sizeof(model));
	ata_id_c_string(id, fw, ATA_ID_FW_REV_OFS, sizeof(fw));
2016

2017
	if (strcmp(model, "Maxtor"))
2018
		return 1;
2019
	if (strcmp(fw, "BANC1G10"))
2020 2021 2022 2023 2024
		return 1;

	return 0; /* blacklisted */
}

L
Linus Torvalds 已提交
2025 2026 2027 2028 2029 2030
/**
 *	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.
 *
2031 2032 2033
 *	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 已提交
2034 2035
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2036
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2037 2038 2039 2040 2041
 */

unsigned int ata_scsiop_mode_sense(struct ata_scsi_args *args, u8 *rbuf,
				  unsigned int buflen)
{
T
Tejun Heo 已提交
2042
	struct ata_device *dev = args->dev;
L
Linus Torvalds 已提交
2043
	u8 *scsicmd = args->cmd->cmnd, *p, *last;
2044 2045 2046 2047 2048 2049 2050
	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 已提交
2051
	u8 dpofua;
L
Linus Torvalds 已提交
2052 2053 2054 2055

	VPRINTK("ENTER\n");

	six_byte = (scsicmd[0] == MODE_SENSE);
2056 2057 2058
	ebd = !(scsicmd[1] & 0x8);      /* dbd bit inverted == edb */
	/*
	 * LLBA bit in msense(10) ignored (compliant)
L
Linus Torvalds 已提交
2059
	 */
2060

L
Linus Torvalds 已提交
2061
	page_control = scsicmd[2] >> 6;
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
	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 已提交
2072

2073 2074 2075 2076 2077 2078 2079 2080
	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 已提交
2081 2082

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

2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095
	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 已提交
2096 2097 2098
		output_len += ata_msense_rw_recovery(&p, last);
		break;

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

2103
	case CONTROL_MPAGE: {
L
Linus Torvalds 已提交
2104 2105 2106 2107
		output_len += ata_msense_ctl_mode(&p, last);
		break;
		}

2108
	case ALL_MPAGES:
L
Linus Torvalds 已提交
2109 2110 2111 2112 2113 2114
		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 */
2115
		goto invalid_fld;
L
Linus Torvalds 已提交
2116 2117
	}

2118 2119
	if (minlen < 1)
		return 0;
T
Tejun Heo 已提交
2120 2121

	dpofua = 0;
2122
	if (ata_dev_supports_fua(args->id) && (dev->flags & ATA_DFLAG_LBA48) &&
T
Tejun Heo 已提交
2123 2124 2125
	    (!(dev->flags & ATA_DFLAG_PIO) || dev->multi_count))
		dpofua = 1 << 4;

L
Linus Torvalds 已提交
2126 2127 2128
	if (six_byte) {
		output_len--;
		rbuf[0] = output_len;
T
Tejun Heo 已提交
2129 2130
		if (minlen > 2)
			rbuf[2] |= dpofua;
2131 2132 2133 2134 2135 2136 2137
		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 已提交
2138 2139 2140
	} else {
		output_len -= 2;
		rbuf[0] = output_len >> 8;
2141 2142
		if (minlen > 1)
			rbuf[1] = output_len;
T
Tejun Heo 已提交
2143 2144
		if (minlen > 3)
			rbuf[3] |= dpofua;
2145 2146 2147 2148 2149 2150 2151
		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 已提交
2152 2153
	}
	return 0;
2154 2155 2156 2157 2158 2159 2160 2161 2162 2163

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 已提交
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
}

/**
 *	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:
2175
 *	None.
L
Linus Torvalds 已提交
2176 2177 2178 2179
 */
unsigned int ata_scsiop_read_cap(struct ata_scsi_args *args, u8 *rbuf,
			        unsigned int buflen)
{
2180
	u64 last_lba = args->dev->n_sectors - 1; /* LBA of the last block */
L
Linus Torvalds 已提交
2181 2182 2183 2184

	VPRINTK("ENTER\n");

	if (args->cmd->cmnd[0] == READ_CAPACITY) {
2185 2186
		if (last_lba >= 0xffffffffULL)
			last_lba = 0xffffffff;
2187

L
Linus Torvalds 已提交
2188
		/* sector count, 32-bit */
2189 2190 2191 2192
		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 已提交
2193 2194

		/* sector size */
2195 2196
		ATA_SCSI_RBUF_SET(6, ATA_SECT_SIZE >> 8);
		ATA_SCSI_RBUF_SET(7, ATA_SECT_SIZE);
L
Linus Torvalds 已提交
2197 2198
	} else {
		/* sector count, 64-bit */
2199 2200 2201 2202 2203 2204 2205 2206
		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 已提交
2207 2208

		/* sector size */
2209 2210
		ATA_SCSI_RBUF_SET(10, ATA_SECT_SIZE >> 8);
		ATA_SCSI_RBUF_SET(11, ATA_SECT_SIZE);
L
Linus Torvalds 已提交
2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
	}

	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 已提交
2225
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236
 */

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;
}

2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264
/**
 *	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 已提交
2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276
/**
 *	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 已提交
2277
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2278 2279 2280 2281 2282
 */

void ata_scsi_badcmd(struct scsi_cmnd *cmd, void (*done)(struct scsi_cmnd *), u8 asc, u8 ascq)
{
	DPRINTK("ENTER\n");
2283
	ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, asc, ascq);
L
Linus Torvalds 已提交
2284 2285 2286 2287

	done(cmd);
}

2288
static void atapi_sense_complete(struct ata_queued_cmd *qc)
2289
{
2290
	if (qc->err_mask && ((qc->err_mask & AC_ERR_DEV) == 0)) {
2291 2292 2293 2294 2295
		/* 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
		 */
2296
		ata_gen_passthru_sense(qc);
2297
	}
2298

2299
	qc->scsidone(qc->scsicmd);
2300
	ata_qc_free(qc);
2301
}
2302

2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314
/* 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");
2315 2316 2317 2318

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

2319 2320 2321 2322 2323 2324 2325 2326
	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);

2327 2328 2329
	ata_sg_init_one(qc, cmd->sense_buffer, sizeof(cmd->sense_buffer));
	qc->dma_dir = DMA_FROM_DEVICE;

2330
	memset(&qc->cdb, 0, qc->dev->cdb_len);
2331 2332 2333 2334 2335 2336
	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;

2337 2338 2339 2340 2341 2342 2343 2344
	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;
	}
2345 2346
	qc->nbytes = SCSI_SENSE_BUFFERSIZE;

2347
	qc->complete_fn = atapi_sense_complete;
2348

2349
	ata_qc_issue(qc);
2350 2351 2352 2353

	DPRINTK("EXIT\n");
}

2354
static void atapi_qc_complete(struct ata_queued_cmd *qc)
L
Linus Torvalds 已提交
2355 2356
{
	struct scsi_cmnd *cmd = qc->scsicmd;
2357
	unsigned int err_mask = qc->err_mask;
L
Linus Torvalds 已提交
2358

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

2361 2362 2363 2364 2365 2366 2367 2368 2369 2370
	/* 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
			 */
2371
			ata_gen_passthru_sense(qc);
2372 2373
		}

2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
		/* 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;

2387 2388 2389 2390 2391 2392 2393
		qc->scsicmd->result = SAM_STAT_CHECK_CONDITION;
		qc->scsidone(cmd);
		ata_qc_free(qc);
		return;
	}

	/* successful completion or old EH failure path */
2394
	if (unlikely(err_mask & AC_ERR_DEV)) {
L
Linus Torvalds 已提交
2395
		cmd->result = SAM_STAT_CHECK_CONDITION;
2396
		atapi_request_sense(qc);
2397
		return;
2398
	} else if (unlikely(err_mask)) {
2399 2400 2401 2402 2403
		/* 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
		 */
2404
		ata_gen_passthru_sense(qc);
2405
	} else {
L
Linus Torvalds 已提交
2406 2407
		u8 *scsicmd = cmd->cmnd;

2408
		if ((scsicmd[0] == INQUIRY) && ((scsicmd[1] & 0x03) == 0)) {
L
Linus Torvalds 已提交
2409 2410 2411 2412
			u8 *buf = NULL;
			unsigned int buflen;

			buflen = ata_scsi_rbuf_get(cmd, &buf);
2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426

	/* 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 已提交
2427 2428
			ata_scsi_rbuf_put(cmd, buf);
		}
2429

L
Linus Torvalds 已提交
2430 2431 2432 2433
		cmd->result = SAM_STAT_GOOD;
	}

	qc->scsidone(cmd);
2434
	ata_qc_free(qc);
L
Linus Torvalds 已提交
2435 2436 2437 2438 2439 2440 2441
}
/**
 *	atapi_xlat - Initialize PACKET taskfile
 *	@qc: command structure to be initialized
 *	@scsicmd: SCSI CDB associated with this PACKET command
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2442
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2443 2444 2445 2446 2447
 *
 *	RETURNS:
 *	Zero on success, non-zero on failure.
 */

J
Jeff Garzik 已提交
2448
static unsigned int atapi_xlat(struct ata_queued_cmd *qc, const u8 *scsicmd)
L
Linus Torvalds 已提交
2449 2450 2451 2452
{
	struct scsi_cmnd *cmd = qc->scsicmd;
	struct ata_device *dev = qc->dev;
	int using_pio = (dev->flags & ATA_DFLAG_PIO);
2453
	int nodata = (cmd->sc_data_direction == DMA_NONE);
L
Linus Torvalds 已提交
2454 2455 2456 2457 2458 2459

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

2460
	memcpy(&qc->cdb, scsicmd, dev->cdb_len);
L
Linus Torvalds 已提交
2461 2462 2463 2464

	qc->complete_fn = atapi_qc_complete;

	qc->tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE;
2465
	if (cmd->sc_data_direction == DMA_TO_DEVICE) {
L
Linus Torvalds 已提交
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486
		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;

2487 2488
		if (atapi_dmadir && (cmd->sc_data_direction != DMA_TO_DEVICE))
			/* some SATA bridges need us to indicate data xfer direction */
L
Linus Torvalds 已提交
2489 2490 2491
			qc->tf.feature |= ATAPI_DMADIR;
	}

2492
	qc->nbytes = cmd->request_bufflen;
L
Linus Torvalds 已提交
2493 2494 2495 2496

	return 0;
}

2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513
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);
}

2514 2515 2516 2517 2518 2519 2520
/**
 *	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 已提交
2521
 *	spin_lock_irqsave(host lock)
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
 *
 *	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 已提交
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
/**
 *	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 已提交
2555
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2556 2557 2558 2559 2560
 *
 *	RETURNS:
 *	Associated ATA device, or %NULL if not found.
 */
static struct ata_device *
J
Jeff Garzik 已提交
2561
ata_scsi_find_dev(struct ata_port *ap, const struct scsi_device *scsidev)
L
Linus Torvalds 已提交
2562
{
2563
	struct ata_device *dev = __ata_scsi_find_dev(ap, scsidev);
L
Linus Torvalds 已提交
2564

2565
	if (unlikely(!dev || !ata_scsi_dev_enabled(dev)))
L
Linus Torvalds 已提交
2566 2567 2568 2569 2570
		return NULL;

	return dev;
}

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 2607 2608 2609 2610 2611
/*
 *	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
R
Randy Dunlap 已提交
2612
 *	@scsicmd: SCSI command to convert
2613 2614 2615 2616 2617 2618 2619
 *
 *	Handles either 12 or 16-byte versions of the CDB.
 *
 *	RETURNS:
 *	Zero on success, non-zero on failure.
 */
static unsigned int
2620
ata_scsi_pass_thru(struct ata_queued_cmd *qc, const u8 *scsicmd)
2621 2622 2623
{
	struct ata_taskfile *tf = &(qc->tf);
	struct scsi_cmnd *cmd = qc->scsicmd;
2624
	struct ata_device *dev = qc->dev;
2625 2626

	if ((tf->protocol = ata_scsi_map_proto(scsicmd[1])) == ATA_PROT_UNKNOWN)
2627
		goto invalid_fld;
2628

2629 2630 2631
	/* 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;
2632

2633 2634 2635 2636
	if (scsicmd[1] & 0xe0)
		/* PIO multi not supported yet */
		goto invalid_fld;

2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680
	/*
	 * 12 and 16 byte CDBs use different offsets to
	 * provide the various register values.
	 */
	if (scsicmd[0] == ATA_16) {
		/*
		 * 16-byte CDB - may contain extended commands.
		 *
		 * If that is the case, copy the upper byte register values.
		 */
		if (scsicmd[1] & 0x01) {
			tf->hob_feature = scsicmd[3];
			tf->hob_nsect = scsicmd[5];
			tf->hob_lbal = scsicmd[7];
			tf->hob_lbam = scsicmd[9];
			tf->hob_lbah = scsicmd[11];
			tf->flags |= ATA_TFLAG_LBA48;
		} else
			tf->flags &= ~ATA_TFLAG_LBA48;

		/*
		 * Always copy low byte, device and command registers.
		 */
		tf->feature = scsicmd[4];
		tf->nsect = scsicmd[6];
		tf->lbal = scsicmd[8];
		tf->lbam = scsicmd[10];
		tf->lbah = scsicmd[12];
		tf->device = scsicmd[13];
		tf->command = scsicmd[14];
	} else {
		/*
		 * 12-byte CDB - incapable of extended commands.
		 */
		tf->flags &= ~ATA_TFLAG_LBA48;

		tf->feature = scsicmd[3];
		tf->nsect = scsicmd[4];
		tf->lbal = scsicmd[5];
		tf->lbam = scsicmd[6];
		tf->lbah = scsicmd[7];
		tf->device = scsicmd[8];
		tf->command = scsicmd[9];
	}
2681 2682 2683 2684 2685 2686
	/*
	 * 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;
2687 2688 2689 2690 2691 2692 2693 2694 2695 2696

	/*
	 * 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))
2697
		goto invalid_fld;
2698 2699 2700 2701 2702 2703 2704 2705

	/*
	 * 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);

2706
	if (cmd->sc_data_direction == DMA_TO_DEVICE)
2707 2708 2709 2710 2711 2712 2713 2714
		tf->flags |= ATA_TFLAG_WRITE;

	/*
	 * Set transfer length.
	 *
	 * TODO: find out if we need to do more here to
	 *       cover scatter/gather case.
	 */
2715
	qc->nsect = cmd->request_bufflen / ATA_SECT_SIZE;
2716

2717 2718 2719
	/* request result TF */
	qc->flags |= ATA_QCFLAG_RESULT_TF;

2720
	return 0;
2721 2722 2723 2724 2725

 invalid_fld:
	ata_scsi_set_sense(qc->scsicmd, ILLEGAL_REQUEST, 0x24, 0x00);
	/* "Invalid field in cdb" */
	return 1;
2726 2727
}

L
Linus Torvalds 已提交
2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759
/**
 *	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;
2760 2761 2762 2763

	case ATA_12:
	case ATA_16:
		return ata_scsi_pass_thru;
2764

2765 2766
	case START_STOP:
		return ata_scsi_start_stop_xlat;
L
Linus Torvalds 已提交
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795
	}

	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
}

2796 2797 2798
static inline int __ata_scsi_queuecmd(struct scsi_cmnd *cmd,
				      void (*done)(struct scsi_cmnd *),
				      struct ata_device *dev)
2799
{
2800 2801
	int rc = 0;

2802 2803 2804 2805 2806
	if (dev->class == ATA_DEV_ATA) {
		ata_xlat_func_t xlat_func = ata_get_xlat_func(dev,
							      cmd->cmnd[0]);

		if (xlat_func)
2807
			rc = ata_scsi_translate(dev, cmd, done, xlat_func);
2808
		else
T
Tejun Heo 已提交
2809
			ata_scsi_simulate(dev, cmd, done);
2810
	} else
2811 2812 2813
		rc = ata_scsi_translate(dev, cmd, done, atapi_xlat);

	return rc;
2814 2815
}

L
Linus Torvalds 已提交
2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828
/**
 *	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 已提交
2829
 *	Releases scsi-layer-held lock, and obtains host lock.
L
Linus Torvalds 已提交
2830 2831
 *
 *	RETURNS:
2832 2833
 *	Return value from __ata_scsi_queuecmd() if @cmd can be queued,
 *	0 otherwise.
L
Linus Torvalds 已提交
2834 2835 2836 2837 2838 2839
 */
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 已提交
2840
	struct Scsi_Host *shost = scsidev->host;
2841
	int rc = 0;
L
Linus Torvalds 已提交
2842

2843
	ap = ata_shost_to_port(shost);
J
Jeff Garzik 已提交
2844 2845

	spin_unlock(shost->host_lock);
2846
	spin_lock(ap->lock);
L
Linus Torvalds 已提交
2847 2848 2849 2850

	ata_scsi_dump_cdb(ap, cmd);

	dev = ata_scsi_find_dev(ap, scsidev);
2851
	if (likely(dev))
2852
		rc = __ata_scsi_queuecmd(cmd, done, dev);
2853
	else {
L
Linus Torvalds 已提交
2854 2855 2856 2857
		cmd->result = (DID_BAD_TARGET << 16);
		done(cmd);
	}

2858
	spin_unlock(ap->lock);
J
Jeff Garzik 已提交
2859
	spin_lock(shost->host_lock);
2860
	return rc;
L
Linus Torvalds 已提交
2861 2862 2863 2864
}

/**
 *	ata_scsi_simulate - simulate SCSI command on ATA device
2865
 *	@dev: the target device
L
Linus Torvalds 已提交
2866 2867 2868 2869 2870 2871 2872
 *	@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 已提交
2873
 *	spin_lock_irqsave(host lock)
L
Linus Torvalds 已提交
2874 2875
 */

T
Tejun Heo 已提交
2876
void ata_scsi_simulate(struct ata_device *dev, struct scsi_cmnd *cmd,
L
Linus Torvalds 已提交
2877 2878 2879
		      void (*done)(struct scsi_cmnd *))
{
	struct ata_scsi_args args;
J
Jeff Garzik 已提交
2880
	const u8 *scsicmd = cmd->cmnd;
L
Linus Torvalds 已提交
2881

T
Tejun Heo 已提交
2882 2883
	args.dev = dev;
	args.id = dev->id;
L
Linus Torvalds 已提交
2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900
	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?  */
2901
				ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2902 2903 2904 2905 2906 2907 2908 2909 2910
			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
2911
				ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2912 2913 2914 2915 2916 2917 2918 2919 2920
			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 */
2921
			ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2922 2923 2924 2925 2926 2927 2928 2929 2930 2931
			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
2932
				ata_scsi_invalid_field(cmd, done);
L
Linus Torvalds 已提交
2933 2934 2935 2936 2937 2938
			break;

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

2939
		/* mandatory commands we haven't implemented yet */
L
Linus Torvalds 已提交
2940 2941 2942 2943
		case REQUEST_SENSE:

		/* all other commands */
		default:
2944 2945 2946
			ata_scsi_set_sense(cmd, ILLEGAL_REQUEST, 0x20, 0x0);
			/* "Invalid command operation code" */
			done(cmd);
L
Linus Torvalds 已提交
2947 2948 2949 2950
			break;
	}
}

J
Jeff Garzik 已提交
2951 2952 2953 2954
void ata_scsi_scan_host(struct ata_port *ap)
{
	unsigned int i;

2955
	if (ap->flags & ATA_FLAG_DISABLED)
J
Jeff Garzik 已提交
2956 2957
		return;

2958
	for (i = 0; i < ATA_MAX_DEVICES; i++) {
2959 2960 2961 2962 2963
		struct ata_device *dev = &ap->device[i];
		struct scsi_device *sdev;

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

J
Jeff Garzik 已提交
2965
		sdev = __scsi_add_device(ap->scsi_host, 0, i, 0, NULL);
2966 2967 2968 2969
		if (!IS_ERR(sdev)) {
			dev->sdev = sdev;
			scsi_device_put(sdev);
		}
2970
	}
J
Jeff Garzik 已提交
2971
}
2972 2973 2974 2975 2976 2977 2978

/**
 *	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 已提交
2979
 *	function is called with host lock which protects dev->sdev
2980 2981 2982
 *	against clearing.
 *
 *	LOCKING:
J
Jeff Garzik 已提交
2983
 *	spin_lock_irqsave(host lock)
2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995
 *
 *	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;
}
2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018

/**
 *	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 已提交
3019
	mutex_lock(&ap->scsi_host->scan_mutex);
3020
	spin_lock_irqsave(ap->lock, flags);
3021

J
Jeff Garzik 已提交
3022
	/* clearing dev->sdev is protected by host lock */
3023 3024 3025 3026 3027
	sdev = dev->sdev;
	dev->sdev = NULL;

	if (sdev) {
		/* If user initiated unplug races with us, sdev can go
J
Jeff Garzik 已提交
3028
		 * away underneath us after the host lock and
3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043
		 * 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;
		}
	}

3044
	spin_unlock_irqrestore(ap->lock, flags);
J
Jeff Garzik 已提交
3045
	mutex_unlock(&ap->scsi_host->scan_mutex);
3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072

	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
 *	@data: Pointer to ATA port to perform SCSI hotplug on
 *
 *	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).
 */
void ata_scsi_hotplug(void *data)
{
	struct ata_port *ap = data;
	int i;

3073
	if (ap->pflags & ATA_PFLAG_UNLOADING) {
3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087
		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;

3088
		spin_lock_irqsave(ap->lock, flags);
3089
		dev->flags &= ~ATA_DFLAG_DETACHED;
3090
		spin_unlock_irqrestore(ap->lock, flags);
3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111

		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) {
			queue_delayed_work(ata_aux_wq, &ap->hotplug_task, HZ);
			break;
		}
	}

	DPRINTK("EXIT\n");
}
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 3140 3141 3142

/**
 *	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;

3143
	spin_lock_irqsave(ap->lock, flags);
3144 3145 3146 3147 3148 3149 3150 3151 3152 3153

	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;
3154
			ap->eh_info.flags |= ATA_EHI_RESUME_LINK;
3155 3156 3157 3158
		} else
			rc = -EINVAL;
	}

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

	return rc;
}
3168 3169

/**
3170 3171
 *	ata_scsi_dev_rescan - initiate scsi_rescan_device()
 *	@data: Pointer to ATA port to perform scsi_rescan_device()
3172
 *
3173 3174 3175 3176
 *	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.
3177
 *
3178 3179
 *	LOCKING:
 *	Kernel thread context (may sleep).
3180 3181 3182 3183 3184 3185 3186 3187 3188 3189
 */
void ata_scsi_dev_rescan(void *data)
{
	struct ata_port *ap = data;
	struct ata_device *dev;
	unsigned int i;

	for (i = 0; i < ATA_MAX_DEVICES; i++) {
		dev = &ap->device[i];

3190
		if (ata_dev_enabled(dev) && dev->sdev)
3191 3192 3193
			scsi_rescan_device(&(dev->sdev->sdev_gendev));
	}
}
3194 3195 3196

/**
 *	ata_sas_port_alloc - Allocate port for a SAS attached SATA device
3197
 *	@host: ATA host container for all SAS ports
3198
 *	@port_info: Information from low-level host driver
J
Jeff Garzik 已提交
3199
 *	@shost: SCSI host that the scsi device is attached to
3200 3201 3202 3203 3204 3205 3206 3207
 *
 *	LOCKING:
 *	PCI/etc. bus probe sem.
 *
 *	RETURNS:
 *	ata_port pointer on success / NULL on failure.
 */

J
Jeff Garzik 已提交
3208
struct ata_port *ata_sas_port_alloc(struct ata_host *host,
3209
				    struct ata_port_info *port_info,
J
Jeff Garzik 已提交
3210
				    struct Scsi_Host *shost)
3211 3212 3213 3214 3215 3216 3217
{
	struct ata_port *ap = kzalloc(sizeof(*ap), GFP_KERNEL);
	struct ata_probe_ent *ent;

	if (!ap)
		return NULL;

J
Jeff Garzik 已提交
3218
	ent = ata_probe_ent_alloc(host->dev, port_info);
3219 3220 3221 3222 3223
	if (!ent) {
		kfree(ap);
		return NULL;
	}

J
Jeff Garzik 已提交
3224 3225
	ata_port_init(ap, host, ent, 0);
	ap->lock = shost->host_lock;
3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 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 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325
	kfree(ent);
	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)
{
	ap->ops->port_stop(ap);
	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:
3326 3327
 *	Return value from __ata_scsi_queuecmd() if @cmd can be queued,
 *	0 otherwise.
3328 3329 3330 3331 3332
 */

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

3335 3336 3337
	ata_scsi_dump_cdb(ap, cmd);

	if (likely(ata_scsi_dev_enabled(ap->device)))
3338
		rc = __ata_scsi_queuecmd(cmd, done, ap->device);
3339 3340 3341 3342
	else {
		cmd->result = (DID_BAD_TARGET << 16);
		done(cmd);
	}
3343
	return rc;
3344 3345
}
EXPORT_SYMBOL_GPL(ata_sas_queuecmd);