Linux Audio

Check our new training course

Loading...
v4.6
   1/*
   2 * USB Attached SCSI
   3 * Note that this is not the same as the USB Mass Storage driver
   4 *
   5 * Copyright Hans de Goede <hdegoede@redhat.com> for Red Hat, Inc. 2013 - 2016
   6 * Copyright Matthew Wilcox for Intel Corp, 2010
   7 * Copyright Sarah Sharp for Intel Corp, 2010
   8 *
   9 * Distributed under the terms of the GNU GPL, version two.
  10 */
  11
  12#include <linux/blkdev.h>
  13#include <linux/slab.h>
  14#include <linux/types.h>
  15#include <linux/module.h>
  16#include <linux/usb.h>
  17#include <linux/usb_usual.h>
  18#include <linux/usb/hcd.h>
  19#include <linux/usb/storage.h>
  20#include <linux/usb/uas.h>
  21
  22#include <scsi/scsi.h>
  23#include <scsi/scsi_eh.h>
  24#include <scsi/scsi_dbg.h>
  25#include <scsi/scsi_cmnd.h>
  26#include <scsi/scsi_device.h>
  27#include <scsi/scsi_host.h>
  28#include <scsi/scsi_tcq.h>
  29
  30#include "uas-detect.h"
  31#include "scsiglue.h"
  32
  33#define MAX_CMNDS 256
 
 
 
 
 
 
 
 
 
  34
  35struct uas_dev_info {
  36	struct usb_interface *intf;
  37	struct usb_device *udev;
  38	struct usb_anchor cmd_urbs;
  39	struct usb_anchor sense_urbs;
  40	struct usb_anchor data_urbs;
  41	unsigned long flags;
  42	int qdepth, resetting;
  43	unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
  44	unsigned use_streams:1;
  45	unsigned shutdown:1;
  46	struct scsi_cmnd *cmnd[MAX_CMNDS];
  47	spinlock_t lock;
  48	struct work_struct work;
  49};
  50
  51enum {
  52	SUBMIT_STATUS_URB	= BIT(1),
  53	ALLOC_DATA_IN_URB	= BIT(2),
  54	SUBMIT_DATA_IN_URB	= BIT(3),
  55	ALLOC_DATA_OUT_URB	= BIT(4),
  56	SUBMIT_DATA_OUT_URB	= BIT(5),
  57	ALLOC_CMD_URB		= BIT(6),
  58	SUBMIT_CMD_URB		= BIT(7),
  59	COMMAND_INFLIGHT        = BIT(8),
  60	DATA_IN_URB_INFLIGHT    = BIT(9),
  61	DATA_OUT_URB_INFLIGHT   = BIT(10),
  62	COMMAND_ABORTED         = BIT(11),
  63	IS_IN_WORK_LIST         = BIT(12),
  64};
  65
  66/* Overrides scsi_pointer */
  67struct uas_cmd_info {
  68	unsigned int state;
  69	unsigned int uas_tag;
  70	struct urb *cmd_urb;
 
 
  71	struct urb *data_in_urb;
  72	struct urb *data_out_urb;
 
  73};
  74
  75/* I hate forward declarations, but I actually have a loop */
  76static int uas_submit_urbs(struct scsi_cmnd *cmnd,
  77				struct uas_dev_info *devinfo);
  78static void uas_do_work(struct work_struct *work);
  79static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
  80static void uas_free_streams(struct uas_dev_info *devinfo);
  81static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
  82				int status);
  83
  84static void uas_do_work(struct work_struct *work)
  85{
  86	struct uas_dev_info *devinfo =
  87		container_of(work, struct uas_dev_info, work);
  88	struct uas_cmd_info *cmdinfo;
  89	struct scsi_cmnd *cmnd;
  90	unsigned long flags;
  91	int i, err;
  92
  93	spin_lock_irqsave(&devinfo->lock, flags);
 
 
  94
  95	if (devinfo->resetting)
  96		goto out;
  97
  98	for (i = 0; i < devinfo->qdepth; i++) {
  99		if (!devinfo->cmnd[i])
 100			continue;
 101
 102		cmnd = devinfo->cmnd[i];
 103		cmdinfo = (void *)&cmnd->SCp;
 104
 105		if (!(cmdinfo->state & IS_IN_WORK_LIST))
 106			continue;
 107
 108		err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
 109		if (!err)
 110			cmdinfo->state &= ~IS_IN_WORK_LIST;
 111		else
 112			schedule_work(&devinfo->work);
 113	}
 114out:
 115	spin_unlock_irqrestore(&devinfo->lock, flags);
 116}
 117
 118static void uas_add_work(struct uas_cmd_info *cmdinfo)
 119{
 120	struct scsi_pointer *scp = (void *)cmdinfo;
 121	struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
 122	struct uas_dev_info *devinfo = cmnd->device->hostdata;
 123
 124	lockdep_assert_held(&devinfo->lock);
 125	cmdinfo->state |= IS_IN_WORK_LIST;
 126	schedule_work(&devinfo->work);
 127}
 128
 129static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
 130{
 131	struct uas_cmd_info *cmdinfo;
 132	struct scsi_cmnd *cmnd;
 133	unsigned long flags;
 134	int i, err;
 135
 136	spin_lock_irqsave(&devinfo->lock, flags);
 137	for (i = 0; i < devinfo->qdepth; i++) {
 138		if (!devinfo->cmnd[i])
 139			continue;
 140
 141		cmnd = devinfo->cmnd[i];
 142		cmdinfo = (void *)&cmnd->SCp;
 143		uas_log_cmd_state(cmnd, __func__, 0);
 144		/* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
 145		cmdinfo->state &= ~COMMAND_INFLIGHT;
 146		cmnd->result = result << 16;
 147		err = uas_try_complete(cmnd, __func__);
 148		WARN_ON(err != 0);
 
 
 
 149	}
 150	spin_unlock_irqrestore(&devinfo->lock, flags);
 151}
 152
 153static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
 154{
 155	struct sense_iu *sense_iu = urb->transfer_buffer;
 156	struct scsi_device *sdev = cmnd->device;
 157
 158	if (urb->actual_length > 16) {
 159		unsigned len = be16_to_cpup(&sense_iu->len);
 160		if (len + 16 != urb->actual_length) {
 161			int newlen = min(len + 16, urb->actual_length) - 16;
 162			if (newlen < 0)
 163				newlen = 0;
 164			sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
 165				"disagrees with IU sense data length %d, "
 166				"using %d bytes of sense data\n", __func__,
 167					urb->actual_length, len, newlen);
 168			len = newlen;
 169		}
 170		memcpy(cmnd->sense_buffer, sense_iu->sense, len);
 171	}
 172
 173	cmnd->result = sense_iu->status;
 
 174}
 175
 176static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
 177			      int status)
 178{
 179	struct uas_cmd_info *ci = (void *)&cmnd->SCp;
 180	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 181
 182	scmd_printk(KERN_INFO, cmnd,
 183		    "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
 184		    prefix, status, cmdinfo->uas_tag,
 185		    (ci->state & SUBMIT_STATUS_URB)     ? " s-st"  : "",
 186		    (ci->state & ALLOC_DATA_IN_URB)     ? " a-in"  : "",
 187		    (ci->state & SUBMIT_DATA_IN_URB)    ? " s-in"  : "",
 188		    (ci->state & ALLOC_DATA_OUT_URB)    ? " a-out" : "",
 189		    (ci->state & SUBMIT_DATA_OUT_URB)   ? " s-out" : "",
 190		    (ci->state & ALLOC_CMD_URB)         ? " a-cmd" : "",
 191		    (ci->state & SUBMIT_CMD_URB)        ? " s-cmd" : "",
 192		    (ci->state & COMMAND_INFLIGHT)      ? " CMD"   : "",
 193		    (ci->state & DATA_IN_URB_INFLIGHT)  ? " IN"    : "",
 194		    (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT"   : "",
 195		    (ci->state & COMMAND_ABORTED)       ? " abort" : "",
 196		    (ci->state & IS_IN_WORK_LIST)       ? " work"  : "");
 197	scsi_print_command(cmnd);
 198}
 199
 200static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
 201{
 202	struct uas_cmd_info *cmdinfo;
 203
 204	if (!cmnd)
 205		return;
 206
 207	cmdinfo = (void *)&cmnd->SCp;
 208
 209	if (cmdinfo->state & SUBMIT_CMD_URB)
 210		usb_free_urb(cmdinfo->cmd_urb);
 211
 212	/* data urbs may have never gotten their submit flag set */
 213	if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
 214		usb_free_urb(cmdinfo->data_in_urb);
 215	if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
 216		usb_free_urb(cmdinfo->data_out_urb);
 217}
 218
 219static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
 220{
 221	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 222	struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
 
 
 
 
 
 
 
 
 
 
 223
 224	lockdep_assert_held(&devinfo->lock);
 225	if (cmdinfo->state & (COMMAND_INFLIGHT |
 226			      DATA_IN_URB_INFLIGHT |
 227			      DATA_OUT_URB_INFLIGHT |
 228			      COMMAND_ABORTED))
 229		return -EBUSY;
 230	devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
 231	uas_free_unsubmitted_urbs(cmnd);
 232	cmnd->scsi_done(cmnd);
 233	return 0;
 234}
 235
 236static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
 237			  unsigned direction)
 238{
 239	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 240	int err;
 241
 242	cmdinfo->state |= direction | SUBMIT_STATUS_URB;
 243	err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
 244	if (err) {
 245		uas_add_work(cmdinfo);
 
 
 
 246	}
 247}
 248
 249static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
 250{
 251	u8 response_code = riu->response_code;
 252
 253	switch (response_code) {
 254	case RC_INCORRECT_LUN:
 255		cmnd->result = DID_BAD_TARGET << 16;
 256		break;
 257	case RC_TMF_SUCCEEDED:
 258		cmnd->result = DID_OK << 16;
 259		break;
 260	case RC_TMF_NOT_SUPPORTED:
 261		cmnd->result = DID_TARGET_FAILURE << 16;
 262		break;
 263	default:
 264		uas_log_cmd_state(cmnd, "response iu", response_code);
 265		cmnd->result = DID_ERROR << 16;
 266		break;
 267	}
 268
 269	return response_code == RC_TMF_SUCCEEDED;
 270}
 271
 272static void uas_stat_cmplt(struct urb *urb)
 273{
 274	struct iu *iu = urb->transfer_buffer;
 275	struct Scsi_Host *shost = urb->context;
 276	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
 277	struct urb *data_in_urb = NULL;
 278	struct urb *data_out_urb = NULL;
 279	struct scsi_cmnd *cmnd;
 280	struct uas_cmd_info *cmdinfo;
 281	unsigned long flags;
 282	unsigned int idx;
 283	int status = urb->status;
 284	bool success;
 285
 286	spin_lock_irqsave(&devinfo->lock, flags);
 287
 288	if (devinfo->resetting)
 289		goto out;
 290
 291	if (status) {
 292		if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
 293			dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
 294		goto out;
 295	}
 296
 297	idx = be16_to_cpup(&iu->tag) - 1;
 298	if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
 299		dev_err(&urb->dev->dev,
 300			"stat urb: no pending cmd for uas-tag %d\n", idx + 1);
 301		goto out;
 302	}
 303
 304	cmnd = devinfo->cmnd[idx];
 305	cmdinfo = (void *)&cmnd->SCp;
 306
 307	if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
 308		uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
 309		goto out;
 
 
 
 
 
 
 
 
 310	}
 311
 312	switch (iu->iu_id) {
 313	case IU_ID_STATUS:
 314		uas_sense(urb, cmnd);
 315		if (cmnd->result != 0) {
 316			/* cancel data transfers on error */
 317			data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
 318			data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
 319		}
 320		cmdinfo->state &= ~COMMAND_INFLIGHT;
 321		uas_try_complete(cmnd, __func__);
 
 322		break;
 323	case IU_ID_READ_READY:
 324		if (!cmdinfo->data_in_urb ||
 325				(cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
 326			uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
 327			break;
 328		}
 329		uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
 330		break;
 331	case IU_ID_WRITE_READY:
 332		if (!cmdinfo->data_out_urb ||
 333				(cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
 334			uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
 335			break;
 336		}
 337		uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
 338		break;
 339	case IU_ID_RESPONSE:
 340		cmdinfo->state &= ~COMMAND_INFLIGHT;
 341		success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
 342		if (!success) {
 343			/* Error, cancel data transfers */
 344			data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
 345			data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
 346		}
 347		uas_try_complete(cmnd, __func__);
 348		break;
 349	default:
 350		uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
 
 351	}
 352out:
 353	usb_free_urb(urb);
 354	spin_unlock_irqrestore(&devinfo->lock, flags);
 355
 356	/* Unlinking of data urbs must be done without holding the lock */
 357	if (data_in_urb) {
 358		usb_unlink_urb(data_in_urb);
 359		usb_put_urb(data_in_urb);
 360	}
 361	if (data_out_urb) {
 362		usb_unlink_urb(data_out_urb);
 363		usb_put_urb(data_out_urb);
 364	}
 365}
 366
 367static void uas_data_cmplt(struct urb *urb)
 368{
 369	struct scsi_cmnd *cmnd = urb->context;
 370	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 371	struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
 372	struct scsi_data_buffer *sdb = NULL;
 373	unsigned long flags;
 374	int status = urb->status;
 375
 376	spin_lock_irqsave(&devinfo->lock, flags);
 377
 378	if (cmdinfo->data_in_urb == urb) {
 379		sdb = scsi_in(cmnd);
 380		cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
 381		cmdinfo->data_in_urb = NULL;
 382	} else if (cmdinfo->data_out_urb == urb) {
 383		sdb = scsi_out(cmnd);
 384		cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
 385		cmdinfo->data_out_urb = NULL;
 386	}
 387	if (sdb == NULL) {
 388		WARN_ON_ONCE(1);
 389		goto out;
 390	}
 391
 392	if (devinfo->resetting)
 393		goto out;
 394
 395	/* Data urbs should not complete before the cmd urb is submitted */
 396	if (cmdinfo->state & SUBMIT_CMD_URB) {
 397		uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
 398		goto out;
 399	}
 400
 401	if (status) {
 402		if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
 403			uas_log_cmd_state(cmnd, "data cmplt err", status);
 404		/* error: no data transfered */
 405		sdb->resid = sdb->length;
 406	} else {
 407		sdb->resid = sdb->length - urb->actual_length;
 408	}
 409	uas_try_complete(cmnd, __func__);
 410out:
 411	usb_free_urb(urb);
 412	spin_unlock_irqrestore(&devinfo->lock, flags);
 413}
 414
 415static void uas_cmd_cmplt(struct urb *urb)
 416{
 417	if (urb->status)
 418		dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
 419
 420	usb_free_urb(urb);
 421}
 422
 423static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
 424				      struct scsi_cmnd *cmnd,
 425				      enum dma_data_direction dir)
 
 426{
 427	struct usb_device *udev = devinfo->udev;
 428	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 429	struct urb *urb = usb_alloc_urb(0, gfp);
 430	struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
 431		? scsi_in(cmnd) : scsi_out(cmnd);
 432	unsigned int pipe = (dir == DMA_FROM_DEVICE)
 433		? devinfo->data_in_pipe : devinfo->data_out_pipe;
 434
 435	if (!urb)
 436		goto out;
 437	usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
 438			  uas_data_cmplt, cmnd);
 439	if (devinfo->use_streams)
 440		urb->stream_id = cmdinfo->uas_tag;
 441	urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
 442	urb->sg = sdb->table.sgl;
 443 out:
 444	return urb;
 445}
 446
 447static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
 448				       struct scsi_cmnd *cmnd)
 449{
 450	struct usb_device *udev = devinfo->udev;
 451	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 452	struct urb *urb = usb_alloc_urb(0, gfp);
 453	struct sense_iu *iu;
 454
 455	if (!urb)
 456		goto out;
 457
 458	iu = kzalloc(sizeof(*iu), gfp);
 459	if (!iu)
 460		goto free;
 461
 462	usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
 463			  uas_stat_cmplt, cmnd->device->host);
 464	if (devinfo->use_streams)
 465		urb->stream_id = cmdinfo->uas_tag;
 466	urb->transfer_flags |= URB_FREE_BUFFER;
 467 out:
 468	return urb;
 469 free:
 470	usb_free_urb(urb);
 471	return NULL;
 472}
 473
 474static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
 475					struct scsi_cmnd *cmnd)
 476{
 477	struct usb_device *udev = devinfo->udev;
 478	struct scsi_device *sdev = cmnd->device;
 479	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 480	struct urb *urb = usb_alloc_urb(0, gfp);
 481	struct command_iu *iu;
 482	int len;
 483
 484	if (!urb)
 485		goto out;
 486
 487	len = cmnd->cmd_len - 16;
 488	if (len < 0)
 489		len = 0;
 490	len = ALIGN(len, 4);
 491	iu = kzalloc(sizeof(*iu) + len, gfp);
 492	if (!iu)
 493		goto free;
 494
 495	iu->iu_id = IU_ID_COMMAND;
 496	iu->tag = cpu_to_be16(cmdinfo->uas_tag);
 
 
 
 497	iu->prio_attr = UAS_SIMPLE_TAG;
 498	iu->len = len;
 499	int_to_scsilun(sdev->lun, &iu->lun);
 500	memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
 501
 502	usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
 503							uas_cmd_cmplt, NULL);
 504	urb->transfer_flags |= URB_FREE_BUFFER;
 505 out:
 506	return urb;
 507 free:
 508	usb_free_urb(urb);
 509	return NULL;
 510}
 511
 512/*
 513 * Why should I request the Status IU before sending the Command IU?  Spec
 514 * says to, but also says the device may receive them in any order.  Seems
 515 * daft to me.
 516 */
 517
 518static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
 519{
 520	struct uas_dev_info *devinfo = cmnd->device->hostdata;
 521	struct urb *urb;
 522	int err;
 523
 524	urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
 525	if (!urb)
 526		return NULL;
 527	usb_anchor_urb(urb, &devinfo->sense_urbs);
 528	err = usb_submit_urb(urb, gfp);
 529	if (err) {
 530		usb_unanchor_urb(urb);
 531		uas_log_cmd_state(cmnd, "sense submit err", err);
 532		usb_free_urb(urb);
 533		return NULL;
 534	}
 535	return urb;
 536}
 537
 538static int uas_submit_urbs(struct scsi_cmnd *cmnd,
 539			   struct uas_dev_info *devinfo)
 540{
 541	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 542	struct urb *urb;
 543	int err;
 544
 545	lockdep_assert_held(&devinfo->lock);
 
 
 
 
 
 
 
 546	if (cmdinfo->state & SUBMIT_STATUS_URB) {
 547		urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
 548		if (!urb)
 
 549			return SCSI_MLQUEUE_DEVICE_BUSY;
 
 550		cmdinfo->state &= ~SUBMIT_STATUS_URB;
 551	}
 552
 553	if (cmdinfo->state & ALLOC_DATA_IN_URB) {
 554		cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
 555							cmnd, DMA_FROM_DEVICE);
 
 556		if (!cmdinfo->data_in_urb)
 557			return SCSI_MLQUEUE_DEVICE_BUSY;
 558		cmdinfo->state &= ~ALLOC_DATA_IN_URB;
 559	}
 560
 561	if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
 562		usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
 563		err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
 564		if (err) {
 565			usb_unanchor_urb(cmdinfo->data_in_urb);
 566			uas_log_cmd_state(cmnd, "data in submit err", err);
 567			return SCSI_MLQUEUE_DEVICE_BUSY;
 568		}
 569		cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
 570		cmdinfo->state |= DATA_IN_URB_INFLIGHT;
 571	}
 572
 573	if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
 574		cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
 575							cmnd, DMA_TO_DEVICE);
 
 576		if (!cmdinfo->data_out_urb)
 577			return SCSI_MLQUEUE_DEVICE_BUSY;
 578		cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
 579	}
 580
 581	if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
 582		usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
 583		err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
 584		if (err) {
 585			usb_unanchor_urb(cmdinfo->data_out_urb);
 586			uas_log_cmd_state(cmnd, "data out submit err", err);
 587			return SCSI_MLQUEUE_DEVICE_BUSY;
 588		}
 589		cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
 590		cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
 591	}
 592
 593	if (cmdinfo->state & ALLOC_CMD_URB) {
 594		cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
 
 595		if (!cmdinfo->cmd_urb)
 596			return SCSI_MLQUEUE_DEVICE_BUSY;
 597		cmdinfo->state &= ~ALLOC_CMD_URB;
 598	}
 599
 600	if (cmdinfo->state & SUBMIT_CMD_URB) {
 601		usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
 602		err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
 603		if (err) {
 604			usb_unanchor_urb(cmdinfo->cmd_urb);
 605			uas_log_cmd_state(cmnd, "cmd submit err", err);
 606			return SCSI_MLQUEUE_DEVICE_BUSY;
 607		}
 608		cmdinfo->cmd_urb = NULL;
 609		cmdinfo->state &= ~SUBMIT_CMD_URB;
 610		cmdinfo->state |= COMMAND_INFLIGHT;
 611	}
 612
 613	return 0;
 614}
 615
 616static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
 617					void (*done)(struct scsi_cmnd *))
 618{
 619	struct scsi_device *sdev = cmnd->device;
 620	struct uas_dev_info *devinfo = sdev->hostdata;
 621	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 622	unsigned long flags;
 623	int idx, err;
 624
 625	BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
 626
 627	/* Re-check scsi_block_requests now that we've the host-lock */
 628	if (cmnd->device->host->host_self_blocked)
 629		return SCSI_MLQUEUE_DEVICE_BUSY;
 630
 631	if ((devinfo->flags & US_FL_NO_ATA_1X) &&
 632			(cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
 633		memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
 634		       sizeof(usb_stor_sense_invalidCDB));
 635		cmnd->result = SAM_STAT_CHECK_CONDITION;
 636		cmnd->scsi_done(cmnd);
 637		return 0;
 638	}
 639
 640	spin_lock_irqsave(&devinfo->lock, flags);
 641
 642	if (devinfo->resetting) {
 643		cmnd->result = DID_ERROR << 16;
 644		cmnd->scsi_done(cmnd);
 645		spin_unlock_irqrestore(&devinfo->lock, flags);
 646		return 0;
 647	}
 648
 649	/* Find a free uas-tag */
 650	for (idx = 0; idx < devinfo->qdepth; idx++) {
 651		if (!devinfo->cmnd[idx])
 652			break;
 653	}
 654	if (idx == devinfo->qdepth) {
 655		spin_unlock_irqrestore(&devinfo->lock, flags);
 656		return SCSI_MLQUEUE_DEVICE_BUSY;
 657	}
 658
 659	cmnd->scsi_done = done;
 660
 661	memset(cmdinfo, 0, sizeof(*cmdinfo));
 662	cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
 663	cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
 664
 665	switch (cmnd->sc_data_direction) {
 666	case DMA_FROM_DEVICE:
 667		cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
 668		break;
 669	case DMA_BIDIRECTIONAL:
 670		cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
 671	case DMA_TO_DEVICE:
 672		cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
 673	case DMA_NONE:
 674		break;
 675	}
 676
 677	if (!devinfo->use_streams)
 678		cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
 
 
 
 679
 680	err = uas_submit_urbs(cmnd, devinfo);
 681	if (err) {
 682		/* If we did nothing, give up now */
 683		if (cmdinfo->state & SUBMIT_STATUS_URB) {
 684			spin_unlock_irqrestore(&devinfo->lock, flags);
 685			return SCSI_MLQUEUE_DEVICE_BUSY;
 686		}
 687		uas_add_work(cmdinfo);
 
 
 
 688	}
 689
 690	devinfo->cmnd[idx] = cmnd;
 691	spin_unlock_irqrestore(&devinfo->lock, flags);
 692	return 0;
 693}
 694
 695static DEF_SCSI_QCMD(uas_queuecommand)
 696
 697/*
 698 * For now we do not support actually sending an abort to the device, so
 699 * this eh always fails. Still we must define it to make sure that we've
 700 * dropped all references to the cmnd in question once this function exits.
 701 */
 702static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
 703{
 704	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 705	struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
 706	struct urb *data_in_urb = NULL;
 707	struct urb *data_out_urb = NULL;
 708	unsigned long flags;
 709
 710	spin_lock_irqsave(&devinfo->lock, flags);
 711
 712	uas_log_cmd_state(cmnd, __func__, 0);
 713
 714	/* Ensure that try_complete does not call scsi_done */
 715	cmdinfo->state |= COMMAND_ABORTED;
 716
 717	/* Drop all refs to this cmnd, kill data urbs to break their ref */
 718	devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
 719	if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
 720		data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
 721	if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
 722		data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
 723
 724	uas_free_unsubmitted_urbs(cmnd);
 
 
 
 
 725
 726	spin_unlock_irqrestore(&devinfo->lock, flags);
 
 
 727
 728	if (data_in_urb) {
 729		usb_kill_urb(data_in_urb);
 730		usb_put_urb(data_in_urb);
 731	}
 732	if (data_out_urb) {
 733		usb_kill_urb(data_out_urb);
 734		usb_put_urb(data_out_urb);
 735	}
 736
 
 
 
 737	return FAILED;
 738}
 739
 740static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
 741{
 742	struct scsi_device *sdev = cmnd->device;
 743	struct uas_dev_info *devinfo = sdev->hostdata;
 744	struct usb_device *udev = devinfo->udev;
 745	unsigned long flags;
 746	int err;
 747
 748	err = usb_lock_device_for_reset(udev, devinfo->intf);
 749	if (err) {
 750		shost_printk(KERN_ERR, sdev->host,
 751			     "%s FAILED to get lock err %d\n", __func__, err);
 752		return FAILED;
 753	}
 754
 755	shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
 756
 757	spin_lock_irqsave(&devinfo->lock, flags);
 758	devinfo->resetting = 1;
 759	spin_unlock_irqrestore(&devinfo->lock, flags);
 760
 761	usb_kill_anchored_urbs(&devinfo->cmd_urbs);
 762	usb_kill_anchored_urbs(&devinfo->sense_urbs);
 763	usb_kill_anchored_urbs(&devinfo->data_urbs);
 764	uas_zap_pending(devinfo, DID_RESET);
 765
 766	err = usb_reset_device(udev);
 767
 768	spin_lock_irqsave(&devinfo->lock, flags);
 769	devinfo->resetting = 0;
 770	spin_unlock_irqrestore(&devinfo->lock, flags);
 771
 772	usb_unlock_device(udev);
 
 773
 774	if (err) {
 775		shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
 776			     __func__, err);
 777		return FAILED;
 778	}
 779
 780	shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
 781	return SUCCESS;
 782}
 783
 784static int uas_target_alloc(struct scsi_target *starget)
 785{
 786	struct uas_dev_info *devinfo = (struct uas_dev_info *)
 787			dev_to_shost(starget->dev.parent)->hostdata;
 788
 789	if (devinfo->flags & US_FL_NO_REPORT_LUNS)
 790		starget->no_report_luns = 1;
 791
 792	return 0;
 793}
 794
 795static int uas_slave_alloc(struct scsi_device *sdev)
 796{
 797	struct uas_dev_info *devinfo =
 798		(struct uas_dev_info *)sdev->host->hostdata;
 799
 800	sdev->hostdata = devinfo;
 801
 802	/* USB has unusual DMA-alignment requirements: Although the
 803	 * starting address of each scatter-gather element doesn't matter,
 804	 * the length of each element except the last must be divisible
 805	 * by the Bulk maxpacket value.  There's currently no way to
 806	 * express this by block-layer constraints, so we'll cop out
 807	 * and simply require addresses to be aligned at 512-byte
 808	 * boundaries.  This is okay since most block I/O involves
 809	 * hardware sectors that are multiples of 512 bytes in length,
 810	 * and since host controllers up through USB 2.0 have maxpacket
 811	 * values no larger than 512.
 812	 *
 813	 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
 814	 * values can be as large as 2048.  To make that work properly
 815	 * will require changes to the block layer.
 816	 */
 817	blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
 818
 819	if (devinfo->flags & US_FL_MAX_SECTORS_64)
 820		blk_queue_max_hw_sectors(sdev->request_queue, 64);
 821	else if (devinfo->flags & US_FL_MAX_SECTORS_240)
 822		blk_queue_max_hw_sectors(sdev->request_queue, 240);
 823
 824	return 0;
 825}
 826
 827static int uas_slave_configure(struct scsi_device *sdev)
 828{
 829	struct uas_dev_info *devinfo = sdev->hostdata;
 830
 831	if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
 832		sdev->no_report_opcodes = 1;
 833
 834	/* A few buggy USB-ATA bridges don't understand FUA */
 835	if (devinfo->flags & US_FL_BROKEN_FUA)
 836		sdev->broken_fua = 1;
 837
 838	return 0;
 839}
 840
 841static struct scsi_host_template uas_host_template = {
 842	.module = THIS_MODULE,
 843	.name = "uas",
 844	.queuecommand = uas_queuecommand,
 845	.target_alloc = uas_target_alloc,
 846	.slave_alloc = uas_slave_alloc,
 847	.slave_configure = uas_slave_configure,
 848	.eh_abort_handler = uas_eh_abort_handler,
 
 
 849	.eh_bus_reset_handler = uas_eh_bus_reset_handler,
 850	.can_queue = MAX_CMNDS,
 851	.this_id = -1,
 852	.sg_tablesize = SG_NONE,
 
 853	.skip_settle_delay = 1,
 
 854};
 855
 856#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
 857		    vendorName, productName, useProtocol, useTransport, \
 858		    initFunction, flags) \
 859{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
 860	.driver_info = (flags) }
 861
 862static struct usb_device_id uas_usb_ids[] = {
 863#	include "unusual_uas.h"
 864	{ USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
 865	{ USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
 
 
 866	{ }
 867};
 868MODULE_DEVICE_TABLE(usb, uas_usb_ids);
 869
 870#undef UNUSUAL_DEV
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 871
 872static int uas_switch_interface(struct usb_device *udev,
 873				struct usb_interface *intf)
 874{
 875	int alt;
 
 876
 877	alt = uas_find_uas_alt_setting(intf);
 878	if (alt < 0)
 879		return alt;
 
 
 
 
 
 
 
 
 880
 881	return usb_set_interface(udev,
 882			intf->altsetting[0].desc.bInterfaceNumber, alt);
 883}
 884
 885static int uas_configure_endpoints(struct uas_dev_info *devinfo)
 886{
 887	struct usb_host_endpoint *eps[4] = { };
 
 888	struct usb_device *udev = devinfo->udev;
 889	int r;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 890
 891	r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
 892	if (r)
 893		return r;
 894
 895	devinfo->cmd_pipe = usb_sndbulkpipe(udev,
 896					    usb_endpoint_num(&eps[0]->desc));
 897	devinfo->status_pipe = usb_rcvbulkpipe(udev,
 898					    usb_endpoint_num(&eps[1]->desc));
 899	devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
 900					    usb_endpoint_num(&eps[2]->desc));
 901	devinfo->data_out_pipe = usb_sndbulkpipe(udev,
 902					    usb_endpoint_num(&eps[3]->desc));
 
 
 
 
 
 
 
 
 
 
 
 
 903
 904	if (udev->speed < USB_SPEED_SUPER) {
 905		devinfo->qdepth = 32;
 
 
 906		devinfo->use_streams = 0;
 907	} else {
 908		devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
 909						    3, MAX_CMNDS, GFP_NOIO);
 910		if (devinfo->qdepth < 0)
 911			return devinfo->qdepth;
 912		devinfo->use_streams = 1;
 913	}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 914
 915	return 0;
 
 
 
 
 916}
 917
 918static void uas_free_streams(struct uas_dev_info *devinfo)
 919{
 920	struct usb_device *udev = devinfo->udev;
 921	struct usb_host_endpoint *eps[3];
 922
 923	eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
 924	eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
 925	eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
 926	usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
 927}
 928
 
 
 
 
 
 
 929static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
 930{
 931	int result = -ENOMEM;
 932	struct Scsi_Host *shost = NULL;
 933	struct uas_dev_info *devinfo;
 934	struct usb_device *udev = interface_to_usbdev(intf);
 935	unsigned long dev_flags;
 936
 937	if (!uas_use_uas_driver(intf, id, &dev_flags))
 938		return -ENODEV;
 939
 940	if (uas_switch_interface(udev, intf))
 941		return -ENODEV;
 942
 943	shost = scsi_host_alloc(&uas_host_template,
 944				sizeof(struct uas_dev_info));
 
 
 
 
 945	if (!shost)
 946		goto set_alt0;
 947
 948	shost->max_cmd_len = 16 + 252;
 949	shost->max_id = 1;
 950	shost->max_lun = 256;
 951	shost->max_channel = 0;
 952	shost->sg_tablesize = udev->bus->sg_tablesize;
 953
 954	devinfo = (struct uas_dev_info *)shost->hostdata;
 955	devinfo->intf = intf;
 956	devinfo->udev = udev;
 957	devinfo->resetting = 0;
 958	devinfo->shutdown = 0;
 959	devinfo->flags = dev_flags;
 960	init_usb_anchor(&devinfo->cmd_urbs);
 961	init_usb_anchor(&devinfo->sense_urbs);
 962	init_usb_anchor(&devinfo->data_urbs);
 963	spin_lock_init(&devinfo->lock);
 964	INIT_WORK(&devinfo->work, uas_do_work);
 965
 966	result = uas_configure_endpoints(devinfo);
 967	if (result)
 968		goto set_alt0;
 969
 970	/*
 971	 * 1 tag is reserved for untagged commands +
 972	 * 1 tag to avoid off by one errors in some bridge firmwares
 973	 */
 974	shost->can_queue = devinfo->qdepth - 2;
 975
 976	usb_set_intfdata(intf, shost);
 977	result = scsi_add_host(shost, &intf->dev);
 978	if (result)
 979		goto free_streams;
 
 
 
 
 
 
 980
 981	scsi_scan_host(shost);
 
 982	return result;
 983
 984free_streams:
 
 
 
 985	uas_free_streams(devinfo);
 986	usb_set_intfdata(intf, NULL);
 987set_alt0:
 988	usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
 989	if (shost)
 990		scsi_host_put(shost);
 991	return result;
 992}
 993
 994static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
 995{
 996	unsigned long flags;
 997	int i, r = 1;
 998
 999	spin_lock_irqsave(&devinfo->lock, flags);
1000
1001	for (i = 0; i < devinfo->qdepth; i++) {
1002		if (devinfo->cmnd[i]) {
1003			r = 0; /* Not empty */
1004			break;
1005		}
1006	}
1007
1008	spin_unlock_irqrestore(&devinfo->lock, flags);
1009
1010	return r;
1011}
1012
1013/*
1014 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1015 * get empty while there still is more work to do due to sense-urbs completing
1016 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1017 */
1018static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1019{
1020	unsigned long start_time;
1021	int r;
1022
1023	start_time = jiffies;
1024	do {
1025		flush_work(&devinfo->work);
1026
1027		r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1028		if (r == 0)
1029			return -ETIME;
1030
1031		r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1032		if (r == 0)
1033			return -ETIME;
1034
1035		if (time_after(jiffies, start_time + 5 * HZ))
1036			return -ETIME;
1037	} while (!uas_cmnd_list_empty(devinfo));
1038
1039	return 0;
1040}
1041
1042static int uas_pre_reset(struct usb_interface *intf)
1043{
1044	struct Scsi_Host *shost = usb_get_intfdata(intf);
1045	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1046	unsigned long flags;
1047
1048	if (devinfo->shutdown)
1049		return 0;
1050
1051	/* Block new requests */
1052	spin_lock_irqsave(shost->host_lock, flags);
1053	scsi_block_requests(shost);
1054	spin_unlock_irqrestore(shost->host_lock, flags);
1055
1056	if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1057		shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1058		scsi_unblock_requests(shost);
1059		return 1;
1060	}
1061
1062	uas_free_streams(devinfo);
1063
1064	return 0;
1065}
1066
1067static int uas_post_reset(struct usb_interface *intf)
1068{
1069	struct Scsi_Host *shost = usb_get_intfdata(intf);
1070	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1071	unsigned long flags;
1072	int err;
1073
1074	if (devinfo->shutdown)
1075		return 0;
1076
1077	err = uas_configure_endpoints(devinfo);
1078	if (err) {
1079		shost_printk(KERN_ERR, shost,
1080			     "%s: alloc streams error %d after reset",
1081			     __func__, err);
1082		return 1;
1083	}
1084
1085	spin_lock_irqsave(shost->host_lock, flags);
1086	scsi_report_bus_reset(shost, 0);
1087	spin_unlock_irqrestore(shost->host_lock, flags);
1088
1089	scsi_unblock_requests(shost);
1090
1091	return 0;
1092}
1093
1094static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1095{
1096	struct Scsi_Host *shost = usb_get_intfdata(intf);
1097	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1098
1099	if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1100		shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1101		return -ETIME;
1102	}
1103
1104	return 0;
1105}
1106
1107static int uas_resume(struct usb_interface *intf)
1108{
1109	return 0;
1110}
1111
1112static int uas_reset_resume(struct usb_interface *intf)
1113{
1114	struct Scsi_Host *shost = usb_get_intfdata(intf);
1115	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1116	unsigned long flags;
1117	int err;
1118
1119	err = uas_configure_endpoints(devinfo);
1120	if (err) {
1121		shost_printk(KERN_ERR, shost,
1122			     "%s: alloc streams error %d after reset",
1123			     __func__, err);
1124		return -EIO;
1125	}
1126
1127	spin_lock_irqsave(shost->host_lock, flags);
1128	scsi_report_bus_reset(shost, 0);
1129	spin_unlock_irqrestore(shost->host_lock, flags);
1130
1131	return 0;
1132}
1133
1134static void uas_disconnect(struct usb_interface *intf)
1135{
1136	struct Scsi_Host *shost = usb_get_intfdata(intf);
1137	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1138	unsigned long flags;
1139
1140	spin_lock_irqsave(&devinfo->lock, flags);
1141	devinfo->resetting = 1;
1142	spin_unlock_irqrestore(&devinfo->lock, flags);
1143
1144	cancel_work_sync(&devinfo->work);
1145	usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1146	usb_kill_anchored_urbs(&devinfo->sense_urbs);
1147	usb_kill_anchored_urbs(&devinfo->data_urbs);
1148	uas_zap_pending(devinfo, DID_NO_CONNECT);
1149
1150	scsi_remove_host(shost);
 
 
1151	uas_free_streams(devinfo);
1152	scsi_host_put(shost);
1153}
1154
1155/*
1156 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1157 * hang on reboot when the device is still in uas mode. Note the reset is
1158 * necessary as some devices won't revert to usb-storage mode without it.
1159 */
1160static void uas_shutdown(struct device *dev)
1161{
1162	struct usb_interface *intf = to_usb_interface(dev);
1163	struct usb_device *udev = interface_to_usbdev(intf);
1164	struct Scsi_Host *shost = usb_get_intfdata(intf);
1165	struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1166
1167	if (system_state != SYSTEM_RESTART)
1168		return;
1169
1170	devinfo->shutdown = 1;
1171	uas_free_streams(devinfo);
1172	usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1173	usb_reset_device(udev);
1174}
1175
1176static struct usb_driver uas_driver = {
1177	.name = "uas",
1178	.probe = uas_probe,
1179	.disconnect = uas_disconnect,
1180	.pre_reset = uas_pre_reset,
1181	.post_reset = uas_post_reset,
1182	.suspend = uas_suspend,
1183	.resume = uas_resume,
1184	.reset_resume = uas_reset_resume,
1185	.drvwrap.driver.shutdown = uas_shutdown,
1186	.id_table = uas_usb_ids,
1187};
1188
1189module_usb_driver(uas_driver);
1190
1191MODULE_LICENSE("GPL");
1192MODULE_AUTHOR(
1193	"Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");
v3.5.6
  1/*
  2 * USB Attached SCSI
  3 * Note that this is not the same as the USB Mass Storage driver
  4 *
 
  5 * Copyright Matthew Wilcox for Intel Corp, 2010
  6 * Copyright Sarah Sharp for Intel Corp, 2010
  7 *
  8 * Distributed under the terms of the GNU GPL, version two.
  9 */
 10
 11#include <linux/blkdev.h>
 12#include <linux/slab.h>
 13#include <linux/types.h>
 14#include <linux/module.h>
 15#include <linux/usb.h>
 
 16#include <linux/usb/hcd.h>
 17#include <linux/usb/storage.h>
 18#include <linux/usb/uas.h>
 19
 20#include <scsi/scsi.h>
 
 21#include <scsi/scsi_dbg.h>
 22#include <scsi/scsi_cmnd.h>
 23#include <scsi/scsi_device.h>
 24#include <scsi/scsi_host.h>
 25#include <scsi/scsi_tcq.h>
 26
 27/*
 28 * The r00-r01c specs define this version of the SENSE IU data structure.
 29 * It's still in use by several different firmware releases.
 30 */
 31struct sense_iu_old {
 32	__u8 iu_id;
 33	__u8 rsvd1;
 34	__be16 tag;
 35	__be16 len;
 36	__u8 status;
 37	__u8 service_response;
 38	__u8 sense[SCSI_SENSE_BUFFERSIZE];
 39};
 40
 41struct uas_dev_info {
 42	struct usb_interface *intf;
 43	struct usb_device *udev;
 44	int qdepth;
 
 
 
 
 45	unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
 46	unsigned use_streams:1;
 47	unsigned uas_sense_old:1;
 48	struct scsi_cmnd *cmnd;
 49	struct urb *status_urb; /* used only if stream support is available */
 
 50};
 51
 52enum {
 53	ALLOC_STATUS_URB	= (1 << 0),
 54	SUBMIT_STATUS_URB	= (1 << 1),
 55	ALLOC_DATA_IN_URB	= (1 << 2),
 56	SUBMIT_DATA_IN_URB	= (1 << 3),
 57	ALLOC_DATA_OUT_URB	= (1 << 4),
 58	SUBMIT_DATA_OUT_URB	= (1 << 5),
 59	ALLOC_CMD_URB		= (1 << 6),
 60	SUBMIT_CMD_URB		= (1 << 7),
 
 
 
 
 61};
 62
 63/* Overrides scsi_pointer */
 64struct uas_cmd_info {
 65	unsigned int state;
 66	unsigned int stream;
 67	struct urb *cmd_urb;
 68	/* status_urb is used only if stream support isn't available */
 69	struct urb *status_urb;
 70	struct urb *data_in_urb;
 71	struct urb *data_out_urb;
 72	struct list_head list;
 73};
 74
 75/* I hate forward declarations, but I actually have a loop */
 76static int uas_submit_urbs(struct scsi_cmnd *cmnd,
 77				struct uas_dev_info *devinfo, gfp_t gfp);
 78static void uas_do_work(struct work_struct *work);
 
 
 
 
 
 
 
 
 
 
 
 
 
 79
 80static DECLARE_WORK(uas_work, uas_do_work);
 81static DEFINE_SPINLOCK(uas_work_lock);
 82static LIST_HEAD(uas_work_list);
 83
 84static void uas_do_work(struct work_struct *work)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 85{
 86	struct uas_cmd_info *cmdinfo;
 87	struct uas_cmd_info *temp;
 88	struct list_head list;
 89	int err;
 90
 91	spin_lock_irq(&uas_work_lock);
 92	list_replace_init(&uas_work_list, &list);
 93	spin_unlock_irq(&uas_work_lock);
 94
 95	list_for_each_entry_safe(cmdinfo, temp, &list, list) {
 96		struct scsi_pointer *scp = (void *)cmdinfo;
 97		struct scsi_cmnd *cmnd = container_of(scp,
 98							struct scsi_cmnd, SCp);
 99		err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_NOIO);
100		if (err) {
101			list_del(&cmdinfo->list);
102			spin_lock_irq(&uas_work_lock);
103			list_add_tail(&cmdinfo->list, &uas_work_list);
104			spin_unlock_irq(&uas_work_lock);
105			schedule_work(&uas_work);
106		}
107	}
 
108}
109
110static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
111{
112	struct sense_iu *sense_iu = urb->transfer_buffer;
113	struct scsi_device *sdev = cmnd->device;
114
115	if (urb->actual_length > 16) {
116		unsigned len = be16_to_cpup(&sense_iu->len);
117		if (len + 16 != urb->actual_length) {
118			int newlen = min(len + 16, urb->actual_length) - 16;
119			if (newlen < 0)
120				newlen = 0;
121			sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
122				"disagrees with IU sense data length %d, "
123				"using %d bytes of sense data\n", __func__,
124					urb->actual_length, len, newlen);
125			len = newlen;
126		}
127		memcpy(cmnd->sense_buffer, sense_iu->sense, len);
128	}
129
130	cmnd->result = sense_iu->status;
131	cmnd->scsi_done(cmnd);
132}
133
134static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
135{
136	struct sense_iu_old *sense_iu = urb->transfer_buffer;
137	struct scsi_device *sdev = cmnd->device;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
138
139	if (urb->actual_length > 8) {
140		unsigned len = be16_to_cpup(&sense_iu->len) - 2;
141		if (len + 8 != urb->actual_length) {
142			int newlen = min(len + 8, urb->actual_length) - 8;
143			if (newlen < 0)
144				newlen = 0;
145			sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
146				"disagrees with IU sense data length %d, "
147				"using %d bytes of sense data\n", __func__,
148					urb->actual_length, len, newlen);
149			len = newlen;
150		}
151		memcpy(cmnd->sense_buffer, sense_iu->sense, len);
152	}
153
154	cmnd->result = sense_iu->status;
 
 
 
 
 
 
 
155	cmnd->scsi_done(cmnd);
 
156}
157
158static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
159							unsigned direction)
160{
161	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
162	int err;
163
164	cmdinfo->state = direction;
165	err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
166	if (err) {
167		spin_lock(&uas_work_lock);
168		list_add_tail(&cmdinfo->list, &uas_work_list);
169		spin_unlock(&uas_work_lock);
170		schedule_work(&uas_work);
171	}
172}
173
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
174static void uas_stat_cmplt(struct urb *urb)
175{
176	struct iu *iu = urb->transfer_buffer;
177	struct Scsi_Host *shost = urb->context;
178	struct uas_dev_info *devinfo = (void *)shost->hostdata[0];
 
 
179	struct scsi_cmnd *cmnd;
180	u16 tag;
181	int ret;
 
 
 
182
183	if (urb->status) {
184		dev_err(&urb->dev->dev, "URB BAD STATUS %d\n", urb->status);
185		if (devinfo->use_streams)
186			usb_free_urb(urb);
187		return;
 
 
 
 
 
 
 
 
 
 
 
188	}
189
190	tag = be16_to_cpup(&iu->tag) - 1;
191	if (tag == 0)
192		cmnd = devinfo->cmnd;
193	else
194		cmnd = scsi_host_find_tag(shost, tag - 1);
195	if (!cmnd) {
196		if (devinfo->use_streams) {
197			usb_free_urb(urb);
198			return;
199		}
200		ret = usb_submit_urb(urb, GFP_ATOMIC);
201		if (ret)
202			dev_err(&urb->dev->dev, "failed submit status urb\n");
203		return;
204	}
205
206	switch (iu->iu_id) {
207	case IU_ID_STATUS:
208		if (devinfo->cmnd == cmnd)
209			devinfo->cmnd = NULL;
210
211		if (urb->actual_length < 16)
212			devinfo->uas_sense_old = 1;
213		if (devinfo->uas_sense_old)
214			uas_sense_old(urb, cmnd);
215		else
216			uas_sense(urb, cmnd);
217		break;
218	case IU_ID_READ_READY:
 
 
 
 
 
219		uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
220		break;
221	case IU_ID_WRITE_READY:
 
 
 
 
 
222		uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
223		break;
 
 
 
 
 
 
 
 
 
 
224	default:
225		scmd_printk(KERN_ERR, cmnd,
226			"Bogus IU (%d) received on status pipe\n", iu->iu_id);
227	}
 
 
 
228
229	if (devinfo->use_streams) {
230		usb_free_urb(urb);
231		return;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
232	}
233
234	ret = usb_submit_urb(urb, GFP_ATOMIC);
235	if (ret)
236		dev_err(&urb->dev->dev, "failed submit status urb\n");
 
 
 
 
 
 
 
 
 
237}
238
239static void uas_data_cmplt(struct urb *urb)
240{
241	struct scsi_data_buffer *sdb = urb->context;
242	sdb->resid = sdb->length - urb->actual_length;
 
243	usb_free_urb(urb);
244}
245
246static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
247				unsigned int pipe, u16 stream_id,
248				struct scsi_data_buffer *sdb,
249				enum dma_data_direction dir)
250{
251	struct usb_device *udev = devinfo->udev;
 
252	struct urb *urb = usb_alloc_urb(0, gfp);
 
 
 
 
253
254	if (!urb)
255		goto out;
256	usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length, uas_data_cmplt,
257									sdb);
258	if (devinfo->use_streams)
259		urb->stream_id = stream_id;
260	urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
261	urb->sg = sdb->table.sgl;
262 out:
263	return urb;
264}
265
266static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
267		struct Scsi_Host *shost, u16 stream_id)
268{
269	struct usb_device *udev = devinfo->udev;
 
270	struct urb *urb = usb_alloc_urb(0, gfp);
271	struct sense_iu *iu;
272
273	if (!urb)
274		goto out;
275
276	iu = kzalloc(sizeof(*iu), gfp);
277	if (!iu)
278		goto free;
279
280	usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
281						uas_stat_cmplt, shost);
282	urb->stream_id = stream_id;
 
283	urb->transfer_flags |= URB_FREE_BUFFER;
284 out:
285	return urb;
286 free:
287	usb_free_urb(urb);
288	return NULL;
289}
290
291static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
292					struct scsi_cmnd *cmnd, u16 stream_id)
293{
294	struct usb_device *udev = devinfo->udev;
295	struct scsi_device *sdev = cmnd->device;
 
296	struct urb *urb = usb_alloc_urb(0, gfp);
297	struct command_iu *iu;
298	int len;
299
300	if (!urb)
301		goto out;
302
303	len = cmnd->cmd_len - 16;
304	if (len < 0)
305		len = 0;
306	len = ALIGN(len, 4);
307	iu = kzalloc(sizeof(*iu) + len, gfp);
308	if (!iu)
309		goto free;
310
311	iu->iu_id = IU_ID_COMMAND;
312	if (blk_rq_tagged(cmnd->request))
313		iu->tag = cpu_to_be16(cmnd->request->tag + 2);
314	else
315		iu->tag = cpu_to_be16(1);
316	iu->prio_attr = UAS_SIMPLE_TAG;
317	iu->len = len;
318	int_to_scsilun(sdev->lun, &iu->lun);
319	memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
320
321	usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
322							usb_free_urb, NULL);
323	urb->transfer_flags |= URB_FREE_BUFFER;
324 out:
325	return urb;
326 free:
327	usb_free_urb(urb);
328	return NULL;
329}
330
331/*
332 * Why should I request the Status IU before sending the Command IU?  Spec
333 * says to, but also says the device may receive them in any order.  Seems
334 * daft to me.
335 */
336
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
337static int uas_submit_urbs(struct scsi_cmnd *cmnd,
338					struct uas_dev_info *devinfo, gfp_t gfp)
339{
340	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 
 
341
342	if (cmdinfo->state & ALLOC_STATUS_URB) {
343		cmdinfo->status_urb = uas_alloc_sense_urb(devinfo, gfp,
344				cmnd->device->host, cmdinfo->stream);
345		if (!cmdinfo->status_urb)
346			return SCSI_MLQUEUE_DEVICE_BUSY;
347		cmdinfo->state &= ~ALLOC_STATUS_URB;
348	}
349
350	if (cmdinfo->state & SUBMIT_STATUS_URB) {
351		if (usb_submit_urb(cmdinfo->status_urb, gfp)) {
352			scmd_printk(KERN_INFO, cmnd,
353					"sense urb submission failure\n");
354			return SCSI_MLQUEUE_DEVICE_BUSY;
355		}
356		cmdinfo->state &= ~SUBMIT_STATUS_URB;
357	}
358
359	if (cmdinfo->state & ALLOC_DATA_IN_URB) {
360		cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
361					devinfo->data_in_pipe, cmdinfo->stream,
362					scsi_in(cmnd), DMA_FROM_DEVICE);
363		if (!cmdinfo->data_in_urb)
364			return SCSI_MLQUEUE_DEVICE_BUSY;
365		cmdinfo->state &= ~ALLOC_DATA_IN_URB;
366	}
367
368	if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
369		if (usb_submit_urb(cmdinfo->data_in_urb, gfp)) {
370			scmd_printk(KERN_INFO, cmnd,
371					"data in urb submission failure\n");
 
 
372			return SCSI_MLQUEUE_DEVICE_BUSY;
373		}
374		cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
 
375	}
376
377	if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
378		cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
379					devinfo->data_out_pipe, cmdinfo->stream,
380					scsi_out(cmnd), DMA_TO_DEVICE);
381		if (!cmdinfo->data_out_urb)
382			return SCSI_MLQUEUE_DEVICE_BUSY;
383		cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
384	}
385
386	if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
387		if (usb_submit_urb(cmdinfo->data_out_urb, gfp)) {
388			scmd_printk(KERN_INFO, cmnd,
389					"data out urb submission failure\n");
 
 
390			return SCSI_MLQUEUE_DEVICE_BUSY;
391		}
392		cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
 
393	}
394
395	if (cmdinfo->state & ALLOC_CMD_URB) {
396		cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd,
397							cmdinfo->stream);
398		if (!cmdinfo->cmd_urb)
399			return SCSI_MLQUEUE_DEVICE_BUSY;
400		cmdinfo->state &= ~ALLOC_CMD_URB;
401	}
402
403	if (cmdinfo->state & SUBMIT_CMD_URB) {
404		if (usb_submit_urb(cmdinfo->cmd_urb, gfp)) {
405			scmd_printk(KERN_INFO, cmnd,
406					"cmd urb submission failure\n");
 
 
407			return SCSI_MLQUEUE_DEVICE_BUSY;
408		}
 
409		cmdinfo->state &= ~SUBMIT_CMD_URB;
 
410	}
411
412	return 0;
413}
414
415static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
416					void (*done)(struct scsi_cmnd *))
417{
418	struct scsi_device *sdev = cmnd->device;
419	struct uas_dev_info *devinfo = sdev->hostdata;
420	struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
421	int err;
 
422
423	BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
424
425	if (devinfo->cmnd)
 
426		return SCSI_MLQUEUE_DEVICE_BUSY;
427
428	if (blk_rq_tagged(cmnd->request)) {
429		cmdinfo->stream = cmnd->request->tag + 2;
430	} else {
431		devinfo->cmnd = cmnd;
432		cmdinfo->stream = 1;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
433	}
434
435	cmnd->scsi_done = done;
436
437	cmdinfo->state = ALLOC_STATUS_URB | SUBMIT_STATUS_URB |
438			ALLOC_CMD_URB | SUBMIT_CMD_URB;
 
439
440	switch (cmnd->sc_data_direction) {
441	case DMA_FROM_DEVICE:
442		cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
443		break;
444	case DMA_BIDIRECTIONAL:
445		cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
446	case DMA_TO_DEVICE:
447		cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
448	case DMA_NONE:
449		break;
450	}
451
452	if (!devinfo->use_streams) {
453		cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB |
454				ALLOC_STATUS_URB | SUBMIT_STATUS_URB);
455		cmdinfo->stream = 0;
456	}
457
458	err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
459	if (err) {
460		/* If we did nothing, give up now */
461		if (cmdinfo->state & SUBMIT_STATUS_URB) {
462			usb_free_urb(cmdinfo->status_urb);
463			return SCSI_MLQUEUE_DEVICE_BUSY;
464		}
465		spin_lock(&uas_work_lock);
466		list_add_tail(&cmdinfo->list, &uas_work_list);
467		spin_unlock(&uas_work_lock);
468		schedule_work(&uas_work);
469	}
470
 
 
471	return 0;
472}
473
474static DEF_SCSI_QCMD(uas_queuecommand)
475
 
 
 
 
 
476static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
477{
478	struct scsi_device *sdev = cmnd->device;
479	sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
480							cmnd->request->tag);
 
 
 
 
 
 
 
 
 
481
482/* XXX: Send ABORT TASK Task Management command */
483	return FAILED;
484}
 
 
 
485
486static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
487{
488	struct scsi_device *sdev = cmnd->device;
489	sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
490							cmnd->request->tag);
491
492/* XXX: Send LOGICAL UNIT RESET Task Management command */
493	return FAILED;
494}
495
496static int uas_eh_target_reset_handler(struct scsi_cmnd *cmnd)
497{
498	struct scsi_device *sdev = cmnd->device;
499	sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
500							cmnd->request->tag);
 
 
 
501
502/* XXX: Can we reset just the one USB interface?
503 * Would calling usb_set_interface() have the right effect?
504 */
505	return FAILED;
506}
507
508static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
509{
510	struct scsi_device *sdev = cmnd->device;
511	struct uas_dev_info *devinfo = sdev->hostdata;
512	struct usb_device *udev = devinfo->udev;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
513
514	sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
515							cmnd->request->tag);
 
516
517	if (usb_reset_device(udev))
518		return SUCCESS;
519
520	return FAILED;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
521}
522
523static int uas_slave_alloc(struct scsi_device *sdev)
524{
525	sdev->hostdata = (void *)sdev->host->hostdata[0];
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
526	return 0;
527}
528
529static int uas_slave_configure(struct scsi_device *sdev)
530{
531	struct uas_dev_info *devinfo = sdev->hostdata;
532	scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
533	scsi_activate_tcq(sdev, devinfo->qdepth - 2);
 
 
 
 
 
 
534	return 0;
535}
536
537static struct scsi_host_template uas_host_template = {
538	.module = THIS_MODULE,
539	.name = "uas",
540	.queuecommand = uas_queuecommand,
 
541	.slave_alloc = uas_slave_alloc,
542	.slave_configure = uas_slave_configure,
543	.eh_abort_handler = uas_eh_abort_handler,
544	.eh_device_reset_handler = uas_eh_device_reset_handler,
545	.eh_target_reset_handler = uas_eh_target_reset_handler,
546	.eh_bus_reset_handler = uas_eh_bus_reset_handler,
547	.can_queue = 65536,	/* Is there a limit on the _host_ ? */
548	.this_id = -1,
549	.sg_tablesize = SG_NONE,
550	.cmd_per_lun = 1,	/* until we override it */
551	.skip_settle_delay = 1,
552	.ordered_tag = 1,
553};
554
 
 
 
 
 
 
555static struct usb_device_id uas_usb_ids[] = {
 
556	{ USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
557	{ USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
558	/* 0xaa is a prototype device I happen to have access to */
559	{ USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
560	{ }
561};
562MODULE_DEVICE_TABLE(usb, uas_usb_ids);
563
564static int uas_is_interface(struct usb_host_interface *intf)
565{
566	return (intf->desc.bInterfaceClass == USB_CLASS_MASS_STORAGE &&
567		intf->desc.bInterfaceSubClass == USB_SC_SCSI &&
568		intf->desc.bInterfaceProtocol == USB_PR_UAS);
569}
570
571static int uas_isnt_supported(struct usb_device *udev)
572{
573	struct usb_hcd *hcd = bus_to_hcd(udev->bus);
574
575	dev_warn(&udev->dev, "The driver for the USB controller %s does not "
576			"support scatter-gather which is\n",
577			hcd->driver->description);
578	dev_warn(&udev->dev, "required by the UAS driver. Please try an"
579			"alternative USB controller if you wish to use UAS.\n");
580	return -ENODEV;
581}
582
583static int uas_switch_interface(struct usb_device *udev,
584						struct usb_interface *intf)
585{
586	int i;
587	int sg_supported = udev->bus->sg_tablesize != 0;
588
589	for (i = 0; i < intf->num_altsetting; i++) {
590		struct usb_host_interface *alt = &intf->altsetting[i];
591
592		if (uas_is_interface(alt)) {
593			if (!sg_supported)
594				return uas_isnt_supported(udev);
595			return usb_set_interface(udev,
596						alt->desc.bInterfaceNumber,
597						alt->desc.bAlternateSetting);
598		}
599	}
600
601	return -ENODEV;
 
602}
603
604static void uas_configure_endpoints(struct uas_dev_info *devinfo)
605{
606	struct usb_host_endpoint *eps[4] = { };
607	struct usb_interface *intf = devinfo->intf;
608	struct usb_device *udev = devinfo->udev;
609	struct usb_host_endpoint *endpoint = intf->cur_altsetting->endpoint;
610	unsigned i, n_endpoints = intf->cur_altsetting->desc.bNumEndpoints;
611
612	devinfo->uas_sense_old = 0;
613	devinfo->cmnd = NULL;
614
615	for (i = 0; i < n_endpoints; i++) {
616		unsigned char *extra = endpoint[i].extra;
617		int len = endpoint[i].extralen;
618		while (len > 1) {
619			if (extra[1] == USB_DT_PIPE_USAGE) {
620				unsigned pipe_id = extra[2];
621				if (pipe_id > 0 && pipe_id < 5)
622					eps[pipe_id - 1] = &endpoint[i];
623				break;
624			}
625			len -= extra[0];
626			extra += extra[0];
627		}
628	}
629
630	/*
631	 * Assume that if we didn't find a control pipe descriptor, we're
632	 * using a device with old firmware that happens to be set up like
633	 * this.
634	 */
635	if (!eps[0]) {
636		devinfo->cmd_pipe = usb_sndbulkpipe(udev, 1);
637		devinfo->status_pipe = usb_rcvbulkpipe(udev, 1);
638		devinfo->data_in_pipe = usb_rcvbulkpipe(udev, 2);
639		devinfo->data_out_pipe = usb_sndbulkpipe(udev, 2);
640
641		eps[1] = usb_pipe_endpoint(udev, devinfo->status_pipe);
642		eps[2] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
643		eps[3] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
644	} else {
645		devinfo->cmd_pipe = usb_sndbulkpipe(udev,
646						eps[0]->desc.bEndpointAddress);
647		devinfo->status_pipe = usb_rcvbulkpipe(udev,
648						eps[1]->desc.bEndpointAddress);
649		devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
650						eps[2]->desc.bEndpointAddress);
651		devinfo->data_out_pipe = usb_sndbulkpipe(udev,
652						eps[3]->desc.bEndpointAddress);
653	}
654
655	devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1, 3, 256,
656								GFP_KERNEL);
657	if (devinfo->qdepth < 0) {
658		devinfo->qdepth = 256;
659		devinfo->use_streams = 0;
660	} else {
 
 
 
 
661		devinfo->use_streams = 1;
662	}
663}
664
665static int uas_alloc_status_urb(struct uas_dev_info *devinfo,
666		struct Scsi_Host *shost)
667{
668	if (devinfo->use_streams) {
669		devinfo->status_urb = NULL;
670		return 0;
671	}
672
673	devinfo->status_urb = uas_alloc_sense_urb(devinfo, GFP_KERNEL,
674			shost, 0);
675	if (!devinfo->status_urb)
676		goto err_s_urb;
677
678	if (usb_submit_urb(devinfo->status_urb, GFP_KERNEL))
679		goto err_submit_urb;
680
681	return 0;
682err_submit_urb:
683	usb_free_urb(devinfo->status_urb);
684err_s_urb:
685	return -ENOMEM;
686}
687
688static void uas_free_streams(struct uas_dev_info *devinfo)
689{
690	struct usb_device *udev = devinfo->udev;
691	struct usb_host_endpoint *eps[3];
692
693	eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
694	eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
695	eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
696	usb_free_streams(devinfo->intf, eps, 3, GFP_KERNEL);
697}
698
699/*
700 * XXX: What I'd like to do here is register a SCSI host for each USB host in
701 * the system.  Follow usb-storage's design of registering a SCSI host for
702 * each USB device for the moment.  Can implement this by walking up the
703 * USB hierarchy until we find a USB host.
704 */
705static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
706{
707	int result;
708	struct Scsi_Host *shost;
709	struct uas_dev_info *devinfo;
710	struct usb_device *udev = interface_to_usbdev(intf);
 
 
 
 
711
712	if (uas_switch_interface(udev, intf))
713		return -ENODEV;
714
715	devinfo = kmalloc(sizeof(struct uas_dev_info), GFP_KERNEL);
716	if (!devinfo)
717		return -ENOMEM;
718
719	result = -ENOMEM;
720	shost = scsi_host_alloc(&uas_host_template, sizeof(void *));
721	if (!shost)
722		goto free;
723
724	shost->max_cmd_len = 16 + 252;
725	shost->max_id = 1;
 
 
726	shost->sg_tablesize = udev->bus->sg_tablesize;
727
 
728	devinfo->intf = intf;
729	devinfo->udev = udev;
730	uas_configure_endpoints(devinfo);
 
 
 
 
 
 
 
731
732	result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
733	if (result)
734		goto free;
 
 
 
 
 
 
735
 
736	result = scsi_add_host(shost, &intf->dev);
737	if (result)
738		goto deconfig_eps;
739
740	shost->hostdata[0] = (unsigned long)devinfo;
741
742	result = uas_alloc_status_urb(devinfo, shost);
743	if (result)
744		goto err_alloc_status;
745
746	scsi_scan_host(shost);
747	usb_set_intfdata(intf, shost);
748	return result;
749
750err_alloc_status:
751	scsi_remove_host(shost);
752	shost = NULL;
753deconfig_eps:
754	uas_free_streams(devinfo);
755 free:
756	kfree(devinfo);
 
757	if (shost)
758		scsi_host_put(shost);
759	return result;
760}
761
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
762static int uas_pre_reset(struct usb_interface *intf)
763{
764/* XXX: Need to return 1 if it's not our device in error handling */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
765	return 0;
766}
767
768static int uas_post_reset(struct usb_interface *intf)
769{
770/* XXX: Need to return 1 if it's not our device in error handling */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
771	return 0;
772}
773
774static void uas_disconnect(struct usb_interface *intf)
775{
776	struct Scsi_Host *shost = usb_get_intfdata(intf);
777	struct uas_dev_info *devinfo = (void *)shost->hostdata[0];
 
 
 
 
 
 
 
 
 
 
 
778
779	scsi_remove_host(shost);
780	usb_kill_urb(devinfo->status_urb);
781	usb_free_urb(devinfo->status_urb);
782	uas_free_streams(devinfo);
783	kfree(devinfo);
784}
785
786/*
787 * XXX: Should this plug into libusual so we can auto-upgrade devices from
788 * Bulk-Only to UAS?
 
789 */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
790static struct usb_driver uas_driver = {
791	.name = "uas",
792	.probe = uas_probe,
793	.disconnect = uas_disconnect,
794	.pre_reset = uas_pre_reset,
795	.post_reset = uas_post_reset,
 
 
 
 
796	.id_table = uas_usb_ids,
797};
798
799module_usb_driver(uas_driver);
800
801MODULE_LICENSE("GPL");
802MODULE_AUTHOR("Matthew Wilcox and Sarah Sharp");