Linux Audio

Check our new training course

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