blob: de3836412bf32ecc97b12971ae3b7303fbb01fd3 [file] [log] [blame]
Greg Kroah-Hartman5fd54ac2017-11-03 11:28:30 +01001// SPDX-License-Identifier: GPL-2.0
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02002/*
3 * USB Attached SCSI
4 * Note that this is not the same as the USB Mass Storage driver
5 *
Hans de Goede13630742016-04-12 12:27:09 +02006 * Copyright Hans de Goede <hdegoede@redhat.com> for Red Hat, Inc. 2013 - 2016
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02007 * Copyright Matthew Wilcox for Intel Corp, 2010
8 * Copyright Sarah Sharp for Intel Corp, 2010
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02009 */
10
11#include <linux/blkdev.h>
12#include <linux/slab.h>
13#include <linux/types.h>
Paul Gortmaker6eb0de82011-07-03 16:09:31 -040014#include <linux/module.h>
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020015#include <linux/usb.h>
Hans de Goede79b4c062013-10-25 17:04:33 +010016#include <linux/usb_usual.h>
Sebastian Andrzej Siewiorc898add2012-01-11 12:42:32 +010017#include <linux/usb/hcd.h>
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020018#include <linux/usb/storage.h>
Sebastian Andrzej Siewior348748b2012-01-11 12:45:56 +010019#include <linux/usb/uas.h>
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020020
21#include <scsi/scsi.h>
Hans de Goede4de7a3732013-10-22 16:10:44 +010022#include <scsi/scsi_eh.h>
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020023#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
Hans de Goede82aa0382013-10-21 08:53:31 +010029#include "uas-detect.h"
Hans de Goede59307852014-09-15 16:04:12 +020030#include "scsiglue.h"
Hans de Goede82aa0382013-10-21 08:53:31 +010031
Hans de Goede5e61aed2014-09-13 12:26:32 +020032#define MAX_CMNDS 256
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020033
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020034struct uas_dev_info {
35 struct usb_interface *intf;
36 struct usb_device *udev;
Gerd Hoffmanna0e39e32012-09-25 10:47:04 +020037 struct usb_anchor cmd_urbs;
Gerd Hoffmannbdd000f2012-06-19 09:54:53 +020038 struct usb_anchor sense_urbs;
39 struct usb_anchor data_urbs;
Hans de Goede59307852014-09-15 16:04:12 +020040 unsigned long flags;
Gerd Hoffmann023b5152012-06-19 09:54:54 +020041 int qdepth, resetting;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020042 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
43 unsigned use_streams:1;
Hans de Goededa65c2b2013-11-11 11:51:42 +010044 unsigned shutdown:1;
Hans de Goede5e61aed2014-09-13 12:26:32 +020045 struct scsi_cmnd *cmnd[MAX_CMNDS];
Gerd Hoffmanne0648522012-09-25 10:47:08 +020046 spinlock_t lock;
Gerd Hoffmann1bf81982013-09-13 13:27:12 +020047 struct work_struct work;
EJ Hsu3e998622020-01-30 01:25:06 -080048 struct work_struct scan_work; /* for async scanning */
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020049};
50
51enum {
Oliver Neukum76433192015-11-05 16:20:36 +010052 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),
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020064};
65
66/* Overrides scsi_pointer */
67struct uas_cmd_info {
68 unsigned int state;
Hans de Goedee28e2f2f2014-10-12 12:19:40 +020069 unsigned int uas_tag;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020070 struct urb *cmd_urb;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020071 struct urb *data_in_urb;
72 struct urb *data_out_urb;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020073};
74
75/* I hate forward declarations, but I actually have a loop */
76static int uas_submit_urbs(struct scsi_cmnd *cmnd,
Oliver Neukumb36d8392015-11-03 16:43:17 +010077 struct uas_dev_info *devinfo);
Sarah Sharpea9da1c2011-12-02 11:55:44 -080078static void uas_do_work(struct work_struct *work);
Gerd Hoffmann4c456972012-11-30 11:54:44 +010079static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
Gerd Hoffmannd89bd832013-09-13 13:27:11 +020080static void uas_free_streams(struct uas_dev_info *devinfo);
Hans de Goede1ad7ed52014-09-13 12:26:49 +020081static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
82 int status);
Gerd Hoffmannaa8f6122012-11-30 11:54:40 +010083
Oliver Neukumf6cc6092020-04-15 16:17:50 +020084/*
85 * This driver needs its own workqueue, as we need to control memory allocation.
86 *
87 * In the course of error handling and power management uas_wait_for_pending_cmnds()
88 * needs to flush pending work items. In these contexts we cannot allocate memory
89 * by doing block IO as we would deadlock. For the same reason we cannot wait
90 * for anything allocating memory not heeding these constraints.
91 *
92 * So we have to control all work items that can be on the workqueue we flush.
93 * Hence we cannot share a queue and need our own.
94 */
95static struct workqueue_struct *workqueue;
96
Matthew Wilcox115bb1f2010-10-07 13:05:23 +020097static void uas_do_work(struct work_struct *work)
98{
Gerd Hoffmann1bf81982013-09-13 13:27:12 +020099 struct uas_dev_info *devinfo =
100 container_of(work, struct uas_dev_info, work);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200101 struct uas_cmd_info *cmdinfo;
Hans de Goede43cd99c2014-09-13 12:26:38 +0200102 struct scsi_cmnd *cmnd;
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200103 unsigned long flags;
Hans de Goede43cd99c2014-09-13 12:26:38 +0200104 int i, err;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200105
Gerd Hoffmann1bf81982013-09-13 13:27:12 +0200106 spin_lock_irqsave(&devinfo->lock, flags);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200107
108 if (devinfo->resetting)
109 goto out;
110
Hans de Goede43cd99c2014-09-13 12:26:38 +0200111 for (i = 0; i < devinfo->qdepth; i++) {
112 if (!devinfo->cmnd[i])
113 continue;
114
115 cmnd = devinfo->cmnd[i];
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800116 cmdinfo = scsi_cmd_priv(cmnd);
Hans de Goede61c09ce2013-11-12 13:44:20 +0100117
118 if (!(cmdinfo->state & IS_IN_WORK_LIST))
119 continue;
120
Oliver Neukumb36d8392015-11-03 16:43:17 +0100121 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
Hans de Goede61c09ce2013-11-12 13:44:20 +0100122 if (!err)
Gerd Hoffmannefefecf2012-11-30 11:54:42 +0100123 cmdinfo->state &= ~IS_IN_WORK_LIST;
Hans de Goede61c09ce2013-11-12 13:44:20 +0100124 else
Oliver Neukumf6cc6092020-04-15 16:17:50 +0200125 queue_work(workqueue, &devinfo->work);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200126 }
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200127out:
Gerd Hoffmann4c456972012-11-30 11:54:44 +0100128 spin_unlock_irqrestore(&devinfo->lock, flags);
129}
130
EJ Hsu3e998622020-01-30 01:25:06 -0800131static void uas_scan_work(struct work_struct *work)
132{
133 struct uas_dev_info *devinfo =
134 container_of(work, struct uas_dev_info, scan_work);
135 struct Scsi_Host *shost = usb_get_intfdata(devinfo->intf);
136
137 dev_dbg(&devinfo->intf->dev, "starting scan\n");
138 scsi_scan_host(shost);
139 dev_dbg(&devinfo->intf->dev, "scan complete\n");
140}
141
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800142static void uas_add_work(struct scsi_cmnd *cmnd)
Gerd Hoffmann1bf81982013-09-13 13:27:12 +0200143{
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800144 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Gerd Hoffmann1bf81982013-09-13 13:27:12 +0200145 struct uas_dev_info *devinfo = cmnd->device->hostdata;
146
Sanjeev Sharmaab945ef2014-08-12 12:10:21 +0530147 lockdep_assert_held(&devinfo->lock);
Gerd Hoffmann1bf81982013-09-13 13:27:12 +0200148 cmdinfo->state |= IS_IN_WORK_LIST;
Oliver Neukumf6cc6092020-04-15 16:17:50 +0200149 queue_work(workqueue, &devinfo->work);
Gerd Hoffmann1bf81982013-09-13 13:27:12 +0200150}
151
Hans de Goede15893492014-09-13 12:26:36 +0200152static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
Gerd Hoffmann326349f2013-09-13 13:27:13 +0200153{
154 struct uas_cmd_info *cmdinfo;
Hans de Goede43cd99c2014-09-13 12:26:38 +0200155 struct scsi_cmnd *cmnd;
Gerd Hoffmann326349f2013-09-13 13:27:13 +0200156 unsigned long flags;
Hans de Goede43cd99c2014-09-13 12:26:38 +0200157 int i, err;
Gerd Hoffmann326349f2013-09-13 13:27:13 +0200158
159 spin_lock_irqsave(&devinfo->lock, flags);
Hans de Goede43cd99c2014-09-13 12:26:38 +0200160 for (i = 0; i < devinfo->qdepth; i++) {
161 if (!devinfo->cmnd[i])
162 continue;
163
164 cmnd = devinfo->cmnd[i];
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800165 cmdinfo = scsi_cmd_priv(cmnd);
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200166 uas_log_cmd_state(cmnd, __func__, 0);
Hans de Goede9c15c572014-09-13 12:26:37 +0200167 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
168 cmdinfo->state &= ~COMMAND_INFLIGHT;
Hans de Goede15893492014-09-13 12:26:36 +0200169 cmnd->result = result << 16;
Hans de Goede9c15c572014-09-13 12:26:37 +0200170 err = uas_try_complete(cmnd, __func__);
171 WARN_ON(err != 0);
Gerd Hoffmann326349f2013-09-13 13:27:13 +0200172 }
173 spin_unlock_irqrestore(&devinfo->lock, flags);
174}
175
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200176static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
177{
178 struct sense_iu *sense_iu = urb->transfer_buffer;
179 struct scsi_device *sdev = cmnd->device;
180
181 if (urb->actual_length > 16) {
182 unsigned len = be16_to_cpup(&sense_iu->len);
183 if (len + 16 != urb->actual_length) {
184 int newlen = min(len + 16, urb->actual_length) - 16;
185 if (newlen < 0)
186 newlen = 0;
187 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
188 "disagrees with IU sense data length %d, "
189 "using %d bytes of sense data\n", __func__,
190 urb->actual_length, len, newlen);
191 len = newlen;
192 }
193 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
194 }
195
196 cmnd->result = sense_iu->status;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200197}
198
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200199static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
200 int status)
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200201{
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800202 struct uas_cmd_info *ci = scsi_cmd_priv(cmnd);
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200203
Oliver Neukum5963dec2020-04-15 16:17:49 +0200204 if (status == -ENODEV) /* too late */
205 return;
206
Hans de Goede60d9f672014-09-13 12:26:34 +0200207 scmd_printk(KERN_INFO, cmnd,
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200208 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800209 prefix, status, ci->uas_tag,
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200210 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
211 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
212 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
213 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
214 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
215 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
216 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
217 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
218 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
219 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
Gerd Hoffmannb06e48a2012-11-30 11:54:41 +0100220 (ci->state & COMMAND_ABORTED) ? " abort" : "",
Gerd Hoffmannefefecf2012-11-30 11:54:42 +0100221 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
Hans de Goede6dcd8ec2014-09-13 12:26:45 +0200222 scsi_print_command(cmnd);
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200223}
224
Hans de Goede4c5481e2014-09-13 12:26:41 +0200225static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
226{
227 struct uas_cmd_info *cmdinfo;
228
229 if (!cmnd)
230 return;
231
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800232 cmdinfo = scsi_cmd_priv(cmnd);
Hans de Goede4c5481e2014-09-13 12:26:41 +0200233
234 if (cmdinfo->state & SUBMIT_CMD_URB)
235 usb_free_urb(cmdinfo->cmd_urb);
236
237 /* data urbs may have never gotten their submit flag set */
238 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
239 usb_free_urb(cmdinfo->data_in_urb);
240 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
241 usb_free_urb(cmdinfo->data_out_urb);
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200242}
243
244static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
245{
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800246 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200247 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200248
Sanjeev Sharmaab945ef2014-08-12 12:10:21 +0530249 lockdep_assert_held(&devinfo->lock);
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200250 if (cmdinfo->state & (COMMAND_INFLIGHT |
251 DATA_IN_URB_INFLIGHT |
Gerd Hoffmannb06e48a2012-11-30 11:54:41 +0100252 DATA_OUT_URB_INFLIGHT |
Hans de Goede616f0e62014-09-13 12:26:40 +0200253 COMMAND_ABORTED))
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200254 return -EBUSY;
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200255 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
Hans de Goede4c5481e2014-09-13 12:26:41 +0200256 uas_free_unsubmitted_urbs(cmnd);
Bart Van Assche46c97942021-10-07 13:46:10 -0700257 scsi_done(cmnd);
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200258 return 0;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200259}
260
261static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200262 unsigned direction)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200263{
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800264 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200265 int err;
266
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200267 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
Oliver Neukumb36d8392015-11-03 16:43:17 +0100268 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200269 if (err) {
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800270 uas_add_work(cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200271 }
272}
273
Oliver Neukumaa742682016-01-19 10:51:09 +0100274static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
275{
276 u8 response_code = riu->response_code;
277
278 switch (response_code) {
279 case RC_INCORRECT_LUN:
Oliver Neukum8036a7e2020-09-16 11:40:26 +0200280 set_host_byte(cmnd, DID_BAD_TARGET);
Oliver Neukumaa742682016-01-19 10:51:09 +0100281 break;
282 case RC_TMF_SUCCEEDED:
Oliver Neukum8036a7e2020-09-16 11:40:26 +0200283 set_host_byte(cmnd, DID_OK);
Oliver Neukumaa742682016-01-19 10:51:09 +0100284 break;
285 case RC_TMF_NOT_SUPPORTED:
Mike Christief1d0d5c2022-08-11 20:00:20 -0500286 set_host_byte(cmnd, DID_BAD_TARGET);
Oliver Neukumaa742682016-01-19 10:51:09 +0100287 break;
288 default:
289 uas_log_cmd_state(cmnd, "response iu", response_code);
Oliver Neukum8036a7e2020-09-16 11:40:26 +0200290 set_host_byte(cmnd, DID_ERROR);
Oliver Neukumaa742682016-01-19 10:51:09 +0100291 break;
292 }
293
294 return response_code == RC_TMF_SUCCEEDED;
295}
296
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200297static void uas_stat_cmplt(struct urb *urb)
298{
299 struct iu *iu = urb->transfer_buffer;
Sebastian Andrzej Siewior22188f42011-12-19 20:22:39 +0100300 struct Scsi_Host *shost = urb->context;
Hans de Goede21fc05b2013-11-13 09:32:22 +0100301 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goede60d9f672014-09-13 12:26:34 +0200302 struct urb *data_in_urb = NULL;
303 struct urb *data_out_urb = NULL;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200304 struct scsi_cmnd *cmnd;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200305 struct uas_cmd_info *cmdinfo;
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200306 unsigned long flags;
Hans de Goede5e61aed2014-09-13 12:26:32 +0200307 unsigned int idx;
Oliver Neukumcca26be2015-08-24 11:10:43 +0200308 int status = urb->status;
Oliver Neukumaa742682016-01-19 10:51:09 +0100309 bool success;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200310
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200311 spin_lock_irqsave(&devinfo->lock, flags);
312
313 if (devinfo->resetting)
314 goto out;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200315
Oliver Neukumcca26be2015-08-24 11:10:43 +0200316 if (status) {
317 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
318 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200319 goto out;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200320 }
321
Hans de Goede5e61aed2014-09-13 12:26:32 +0200322 idx = be16_to_cpup(&iu->tag) - 1;
323 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
324 dev_err(&urb->dev->dev,
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200325 "stat urb: no pending cmd for uas-tag %d\n", idx + 1);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200326 goto out;
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200327 }
328
Hans de Goede5e61aed2014-09-13 12:26:32 +0200329 cmnd = devinfo->cmnd[idx];
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800330 cmdinfo = scsi_cmd_priv(cmnd);
Hans de Goeded89da032014-09-13 12:26:33 +0200331
332 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200333 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
Hans de Goeded89da032014-09-13 12:26:33 +0200334 goto out;
335 }
336
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200337 switch (iu->iu_id) {
338 case IU_ID_STATUS:
Hans de Goede5ad22cf2014-09-13 12:26:47 +0200339 uas_sense(urb, cmnd);
Gerd Hoffmann8aac8632012-06-19 09:54:52 +0200340 if (cmnd->result != 0) {
341 /* cancel data transfers on error */
Hans de Goede60d9f672014-09-13 12:26:34 +0200342 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
343 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
Gerd Hoffmann8aac8632012-06-19 09:54:52 +0200344 }
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200345 cmdinfo->state &= ~COMMAND_INFLIGHT;
346 uas_try_complete(cmnd, __func__);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200347 break;
348 case IU_ID_READ_READY:
Hans de Goede8e453152013-11-15 10:04:11 +0100349 if (!cmdinfo->data_in_urb ||
350 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200351 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
Hans de Goede8e453152013-11-15 10:04:11 +0100352 break;
353 }
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200354 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
355 break;
356 case IU_ID_WRITE_READY:
Hans de Goede8e453152013-11-15 10:04:11 +0100357 if (!cmdinfo->data_out_urb ||
358 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200359 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
Hans de Goede8e453152013-11-15 10:04:11 +0100360 break;
361 }
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200362 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
363 break;
Hans de Goedefac1f482014-09-13 12:26:51 +0200364 case IU_ID_RESPONSE:
Hans de Goedefac1f482014-09-13 12:26:51 +0200365 cmdinfo->state &= ~COMMAND_INFLIGHT;
Oliver Neukumaa742682016-01-19 10:51:09 +0100366 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
367 if (!success) {
368 /* Error, cancel data transfers */
369 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
370 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
371 }
Hans de Goedefac1f482014-09-13 12:26:51 +0200372 uas_try_complete(cmnd, __func__);
373 break;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200374 default:
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200375 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200376 }
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200377out:
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200378 usb_free_urb(urb);
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200379 spin_unlock_irqrestore(&devinfo->lock, flags);
Hans de Goede60d9f672014-09-13 12:26:34 +0200380
381 /* Unlinking of data urbs must be done without holding the lock */
382 if (data_in_urb) {
383 usb_unlink_urb(data_in_urb);
384 usb_put_urb(data_in_urb);
385 }
386 if (data_out_urb) {
387 usb_unlink_urb(data_out_urb);
388 usb_put_urb(data_out_urb);
389 }
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200390}
391
Gerd Hoffmannc621a812012-06-19 09:54:48 +0200392static void uas_data_cmplt(struct urb *urb)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200393{
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200394 struct scsi_cmnd *cmnd = urb->context;
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800395 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200396 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100397 struct scsi_data_buffer *sdb = &cmnd->sdb;
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200398 unsigned long flags;
Oliver Neukumcca26be2015-08-24 11:10:43 +0200399 int status = urb->status;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200400
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200401 spin_lock_irqsave(&devinfo->lock, flags);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200402
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200403 if (cmdinfo->data_in_urb == urb) {
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200404 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
Hans de Goede85fea822014-09-13 12:26:35 +0200405 cmdinfo->data_in_urb = NULL;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200406 } else if (cmdinfo->data_out_urb == urb) {
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200407 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
Hans de Goede85fea822014-09-13 12:26:35 +0200408 cmdinfo->data_out_urb = NULL;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200409 }
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200410
411 if (devinfo->resetting)
412 goto out;
413
Hans de Goeded89da032014-09-13 12:26:33 +0200414 /* Data urbs should not complete before the cmd urb is submitted */
415 if (cmdinfo->state & SUBMIT_CMD_URB) {
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200416 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
Hans de Goeded89da032014-09-13 12:26:33 +0200417 goto out;
418 }
419
Oliver Neukumcca26be2015-08-24 11:10:43 +0200420 if (status) {
421 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
422 uas_log_cmd_state(cmnd, "data cmplt err", status);
Gerd Hoffmann8aac8632012-06-19 09:54:52 +0200423 /* error: no data transfered */
Bart Van Assche229531b2019-02-08 13:25:01 -0800424 scsi_set_resid(cmnd, sdb->length);
Gerd Hoffmann8aac8632012-06-19 09:54:52 +0200425 } else {
Bart Van Assche229531b2019-02-08 13:25:01 -0800426 scsi_set_resid(cmnd, sdb->length - urb->actual_length);
Gerd Hoffmann8aac8632012-06-19 09:54:52 +0200427 }
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200428 uas_try_complete(cmnd, __func__);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200429out:
Hans de Goede85fea822014-09-13 12:26:35 +0200430 usb_free_urb(urb);
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200431 spin_unlock_irqrestore(&devinfo->lock, flags);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200432}
433
Hans de Goede876285c2013-11-07 08:52:42 +0100434static void uas_cmd_cmplt(struct urb *urb)
435{
Hans de Goedeb6823c52014-09-13 12:26:39 +0200436 if (urb->status)
437 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
Hans de Goede876285c2013-11-07 08:52:42 +0100438
Hans de Goede876285c2013-11-07 08:52:42 +0100439 usb_free_urb(urb);
440}
441
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200442static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200443 struct scsi_cmnd *cmnd,
444 enum dma_data_direction dir)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200445{
446 struct usb_device *udev = devinfo->udev;
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800447 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200448 struct urb *urb = usb_alloc_urb(0, gfp);
Christoph Hellwigae3d56d2019-01-29 09:33:07 +0100449 struct scsi_data_buffer *sdb = &cmnd->sdb;
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200450 unsigned int pipe = (dir == DMA_FROM_DEVICE)
451 ? devinfo->data_in_pipe : devinfo->data_out_pipe;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200452
453 if (!urb)
454 goto out;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200455 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
456 uas_data_cmplt, cmnd);
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200457 if (devinfo->use_streams)
458 urb->stream_id = cmdinfo->uas_tag;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200459 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
460 urb->sg = sdb->table.sgl;
461 out:
462 return urb;
463}
464
465static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200466 struct scsi_cmnd *cmnd)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200467{
468 struct usb_device *udev = devinfo->udev;
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800469 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200470 struct urb *urb = usb_alloc_urb(0, gfp);
471 struct sense_iu *iu;
472
473 if (!urb)
474 goto out;
475
Matthew Wilcoxac563cf2010-12-15 15:44:03 -0500476 iu = kzalloc(sizeof(*iu), gfp);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200477 if (!iu)
478 goto free;
479
480 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200481 uas_stat_cmplt, cmnd->device->host);
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200482 if (devinfo->use_streams)
483 urb->stream_id = cmdinfo->uas_tag;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200484 urb->transfer_flags |= URB_FREE_BUFFER;
485 out:
486 return urb;
487 free:
488 usb_free_urb(urb);
489 return NULL;
490}
491
492static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
Hans de Goedea887cd32013-10-17 19:47:28 +0200493 struct scsi_cmnd *cmnd)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200494{
495 struct usb_device *udev = devinfo->udev;
496 struct scsi_device *sdev = cmnd->device;
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800497 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200498 struct urb *urb = usb_alloc_urb(0, gfp);
499 struct command_iu *iu;
500 int len;
501
502 if (!urb)
503 goto out;
504
505 len = cmnd->cmd_len - 16;
506 if (len < 0)
507 len = 0;
508 len = ALIGN(len, 4);
Matthew Wilcoxac563cf2010-12-15 15:44:03 -0500509 iu = kzalloc(sizeof(*iu) + len, gfp);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200510 if (!iu)
511 goto free;
512
513 iu->iu_id = IU_ID_COMMAND;
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200514 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
Christoph Hellwig02e031c2010-11-10 14:54:09 +0100515 iu->prio_attr = UAS_SIMPLE_TAG;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200516 iu->len = len;
517 int_to_scsilun(sdev->lun, &iu->lun);
518 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
519
520 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
Hans de Goedeb6823c52014-09-13 12:26:39 +0200521 uas_cmd_cmplt, NULL);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200522 urb->transfer_flags |= URB_FREE_BUFFER;
523 out:
524 return urb;
525 free:
526 usb_free_urb(urb);
527 return NULL;
528}
529
530/*
531 * Why should I request the Status IU before sending the Command IU? Spec
532 * says to, but also says the device may receive them in any order. Seems
533 * daft to me.
534 */
535
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200536static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200537{
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200538 struct uas_dev_info *devinfo = cmnd->device->hostdata;
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200539 struct urb *urb;
Hans de Goede876285c2013-11-07 08:52:42 +0100540 int err;
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200541
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200542 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200543 if (!urb)
Hans de Goede70cf0fb2013-10-29 10:37:23 +0100544 return NULL;
Hans de Goeded5f808d2013-10-17 19:30:26 +0200545 usb_anchor_urb(urb, &devinfo->sense_urbs);
Hans de Goede876285c2013-11-07 08:52:42 +0100546 err = usb_submit_urb(urb, gfp);
547 if (err) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200548 usb_unanchor_urb(urb);
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200549 uas_log_cmd_state(cmnd, "sense submit err", err);
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200550 usb_free_urb(urb);
Hans de Goede70cf0fb2013-10-29 10:37:23 +0100551 return NULL;
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200552 }
Hans de Goede70cf0fb2013-10-29 10:37:23 +0100553 return urb;
Gerd Hoffmanne9bd7e12012-06-19 09:54:50 +0200554}
555
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200556static int uas_submit_urbs(struct scsi_cmnd *cmnd,
Oliver Neukumb36d8392015-11-03 16:43:17 +0100557 struct uas_dev_info *devinfo)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200558{
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800559 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Hans de Goede70cf0fb2013-10-29 10:37:23 +0100560 struct urb *urb;
Hans de Goede876285c2013-11-07 08:52:42 +0100561 int err;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200562
Sanjeev Sharmaab945ef2014-08-12 12:10:21 +0530563 lockdep_assert_held(&devinfo->lock);
Matthew Wilcox92a3f762010-12-15 15:44:04 -0500564 if (cmdinfo->state & SUBMIT_STATUS_URB) {
Oliver Neukumb36d8392015-11-03 16:43:17 +0100565 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
Hans de Goede70cf0fb2013-10-29 10:37:23 +0100566 if (!urb)
567 return SCSI_MLQUEUE_DEVICE_BUSY;
Matthew Wilcox92a3f762010-12-15 15:44:04 -0500568 cmdinfo->state &= ~SUBMIT_STATUS_URB;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200569 }
570
571 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
Oliver Neukumb36d8392015-11-03 16:43:17 +0100572 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200573 cmnd, DMA_FROM_DEVICE);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200574 if (!cmdinfo->data_in_urb)
575 return SCSI_MLQUEUE_DEVICE_BUSY;
576 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
577 }
578
579 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200580 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
Oliver Neukumb36d8392015-11-03 16:43:17 +0100581 err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
Hans de Goede876285c2013-11-07 08:52:42 +0100582 if (err) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200583 usb_unanchor_urb(cmdinfo->data_in_urb);
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200584 uas_log_cmd_state(cmnd, "data in submit err", err);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200585 return SCSI_MLQUEUE_DEVICE_BUSY;
586 }
587 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200588 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200589 }
590
591 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
Oliver Neukumb36d8392015-11-03 16:43:17 +0100592 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
Hans de Goede2d75b9c2014-10-03 12:08:56 +0200593 cmnd, DMA_TO_DEVICE);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200594 if (!cmdinfo->data_out_urb)
595 return SCSI_MLQUEUE_DEVICE_BUSY;
596 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
597 }
598
599 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200600 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
Oliver Neukumb36d8392015-11-03 16:43:17 +0100601 err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
Hans de Goede876285c2013-11-07 08:52:42 +0100602 if (err) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200603 usb_unanchor_urb(cmdinfo->data_out_urb);
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200604 uas_log_cmd_state(cmnd, "data out submit err", err);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200605 return SCSI_MLQUEUE_DEVICE_BUSY;
606 }
607 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200608 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200609 }
610
611 if (cmdinfo->state & ALLOC_CMD_URB) {
Oliver Neukumb36d8392015-11-03 16:43:17 +0100612 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200613 if (!cmdinfo->cmd_urb)
614 return SCSI_MLQUEUE_DEVICE_BUSY;
615 cmdinfo->state &= ~ALLOC_CMD_URB;
616 }
617
618 if (cmdinfo->state & SUBMIT_CMD_URB) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200619 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
Oliver Neukumb36d8392015-11-03 16:43:17 +0100620 err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
Hans de Goede876285c2013-11-07 08:52:42 +0100621 if (err) {
Hans de Goeded5f808d2013-10-17 19:30:26 +0200622 usb_unanchor_urb(cmdinfo->cmd_urb);
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200623 uas_log_cmd_state(cmnd, "cmd submit err", err);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200624 return SCSI_MLQUEUE_DEVICE_BUSY;
625 }
Gerd Hoffmanna0e39e32012-09-25 10:47:04 +0200626 cmdinfo->cmd_urb = NULL;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200627 cmdinfo->state &= ~SUBMIT_CMD_URB;
Gerd Hoffmannb1d67692012-06-19 09:54:51 +0200628 cmdinfo->state |= COMMAND_INFLIGHT;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200629 }
630
631 return 0;
632}
633
Bart Van Asscheaf049df2021-10-07 13:46:14 -0700634static int uas_queuecommand_lck(struct scsi_cmnd *cmnd)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200635{
636 struct scsi_device *sdev = cmnd->device;
637 struct uas_dev_info *devinfo = sdev->hostdata;
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800638 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200639 unsigned long flags;
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200640 int idx, err;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200641
Hans de Goedef9dc0242014-09-13 12:26:42 +0200642 /* Re-check scsi_block_requests now that we've the host-lock */
643 if (cmnd->device->host->host_self_blocked)
644 return SCSI_MLQUEUE_DEVICE_BUSY;
645
Hans de Goede59307852014-09-15 16:04:12 +0200646 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
647 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
648 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
649 sizeof(usb_stor_sense_invalidCDB));
650 cmnd->result = SAM_STAT_CHECK_CONDITION;
Bart Van Assche46c97942021-10-07 13:46:10 -0700651 scsi_done(cmnd);
Hans de Goede59307852014-09-15 16:04:12 +0200652 return 0;
653 }
654
Hans de Goedec6f63202013-11-13 09:24:15 +0100655 spin_lock_irqsave(&devinfo->lock, flags);
656
Gerd Hoffmannf8be6bf2012-11-30 11:54:45 +0100657 if (devinfo->resetting) {
Oliver Neukum8036a7e2020-09-16 11:40:26 +0200658 set_host_byte(cmnd, DID_ERROR);
Bart Van Assche46c97942021-10-07 13:46:10 -0700659 scsi_done(cmnd);
Oliver Neukumeb2a86a2020-09-16 11:40:25 +0200660 goto zombie;
Gerd Hoffmannf8be6bf2012-11-30 11:54:45 +0100661 }
662
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200663 /* Find a free uas-tag */
664 for (idx = 0; idx < devinfo->qdepth; idx++) {
665 if (!devinfo->cmnd[idx])
666 break;
667 }
668 if (idx == devinfo->qdepth) {
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200669 spin_unlock_irqrestore(&devinfo->lock, flags);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200670 return SCSI_MLQUEUE_DEVICE_BUSY;
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200671 }
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200672
Hans de Goede5e61aed2014-09-13 12:26:32 +0200673 memset(cmdinfo, 0, sizeof(*cmdinfo));
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200674 cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
Hans de Goedee0620002014-09-13 12:26:31 +0200675 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200676
677 switch (cmnd->sc_data_direction) {
678 case DMA_FROM_DEVICE:
679 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
680 break;
681 case DMA_BIDIRECTIONAL:
682 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
Gustavo A. R. Silvadf561f662020-08-23 17:36:59 -0500683 fallthrough;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200684 case DMA_TO_DEVICE:
685 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
Gustavo A. R. Silva93c747e2020-11-20 12:40:27 -0600686 break;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200687 case DMA_NONE:
688 break;
689 }
690
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200691 if (!devinfo->use_streams)
Gerd Hoffmanndb32de12012-06-19 09:54:49 +0200692 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200693
Oliver Neukumb36d8392015-11-03 16:43:17 +0100694 err = uas_submit_urbs(cmnd, devinfo);
Oliver Neukumeb2a86a2020-09-16 11:40:25 +0200695 /*
696 * in case of fatal errors the SCSI layer is peculiar
697 * a command that has finished is a success for the purpose
698 * of queueing, no matter how fatal the error
699 */
700 if (err == -ENODEV) {
Oliver Neukum8036a7e2020-09-16 11:40:26 +0200701 set_host_byte(cmnd, DID_ERROR);
Bart Van Assche46c97942021-10-07 13:46:10 -0700702 scsi_done(cmnd);
Oliver Neukumeb2a86a2020-09-16 11:40:25 +0200703 goto zombie;
704 }
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200705 if (err) {
706 /* If we did nothing, give up now */
Matthew Wilcox92a3f762010-12-15 15:44:04 -0500707 if (cmdinfo->state & SUBMIT_STATUS_URB) {
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200708 spin_unlock_irqrestore(&devinfo->lock, flags);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200709 return SCSI_MLQUEUE_DEVICE_BUSY;
710 }
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800711 uas_add_work(cmnd);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200712 }
713
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200714 devinfo->cmnd[idx] = cmnd;
Oliver Neukumeb2a86a2020-09-16 11:40:25 +0200715zombie:
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200716 spin_unlock_irqrestore(&devinfo->lock, flags);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200717 return 0;
718}
719
Jeff Garzikf2812332010-11-16 02:10:29 -0500720static DEF_SCSI_QCMD(uas_queuecommand)
721
Hans de Goede616f0e62014-09-13 12:26:40 +0200722/*
723 * For now we do not support actually sending an abort to the device, so
724 * this eh always fails. Still we must define it to make sure that we've
725 * dropped all references to the cmnd in question once this function exits.
726 */
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200727static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
728{
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800729 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200730 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
Hans de Goede616f0e62014-09-13 12:26:40 +0200731 struct urb *data_in_urb = NULL;
732 struct urb *data_out_urb = NULL;
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200733 unsigned long flags;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200734
Gerd Hoffmanne0648522012-09-25 10:47:08 +0200735 spin_lock_irqsave(&devinfo->lock, flags);
Hans de Goedec6f63202013-11-13 09:24:15 +0100736
Hans de Goede1ad7ed52014-09-13 12:26:49 +0200737 uas_log_cmd_state(cmnd, __func__, 0);
Hans de Goede616f0e62014-09-13 12:26:40 +0200738
739 /* Ensure that try_complete does not call scsi_done */
740 cmdinfo->state |= COMMAND_ABORTED;
741
742 /* Drop all refs to this cmnd, kill data urbs to break their ref */
Hans de Goedee28e2f2f2014-10-12 12:19:40 +0200743 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
Hans de Goede616f0e62014-09-13 12:26:40 +0200744 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
745 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
746 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
747 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
748
Hans de Goede4c5481e2014-09-13 12:26:41 +0200749 uas_free_unsubmitted_urbs(cmnd);
750
Hans de Goede616f0e62014-09-13 12:26:40 +0200751 spin_unlock_irqrestore(&devinfo->lock, flags);
752
753 if (data_in_urb) {
754 usb_kill_urb(data_in_urb);
755 usb_put_urb(data_in_urb);
756 }
757 if (data_out_urb) {
758 usb_kill_urb(data_out_urb);
759 usb_put_urb(data_out_urb);
Hans de Goedec6f63202013-11-13 09:24:15 +0100760 }
761
Hans de Goede616f0e62014-09-13 12:26:40 +0200762 return FAILED;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200763}
764
Hannes Reineckee13849b2017-08-25 13:57:01 +0200765static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200766{
767 struct scsi_device *sdev = cmnd->device;
768 struct uas_dev_info *devinfo = sdev->hostdata;
769 struct usb_device *udev = devinfo->udev;
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200770 unsigned long flags;
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200771 int err;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200772
Hans de Goedebe326f42013-09-22 16:27:02 +0200773 err = usb_lock_device_for_reset(udev, devinfo->intf);
774 if (err) {
775 shost_printk(KERN_ERR, sdev->host,
776 "%s FAILED to get lock err %d\n", __func__, err);
777 return FAILED;
778 }
779
Gerd Hoffmann326349f2013-09-13 13:27:13 +0200780 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200781
782 spin_lock_irqsave(&devinfo->lock, flags);
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200783 devinfo->resetting = 1;
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200784 spin_unlock_irqrestore(&devinfo->lock, flags);
785
Gerd Hoffmanna0e39e32012-09-25 10:47:04 +0200786 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200787 usb_kill_anchored_urbs(&devinfo->sense_urbs);
788 usb_kill_anchored_urbs(&devinfo->data_urbs);
Hans de Goede15893492014-09-13 12:26:36 +0200789 uas_zap_pending(devinfo, DID_RESET);
790
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200791 err = usb_reset_device(udev);
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200792
793 spin_lock_irqsave(&devinfo->lock, flags);
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200794 devinfo->resetting = 0;
Hans de Goedeb7b5d112014-09-13 12:26:30 +0200795 spin_unlock_irqrestore(&devinfo->lock, flags);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200796
Hans de Goedebe326f42013-09-22 16:27:02 +0200797 usb_unlock_device(udev);
798
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200799 if (err) {
Hans de Goedece39fe62014-09-13 12:26:50 +0200800 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
801 __func__, err);
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200802 return FAILED;
803 }
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200804
Gerd Hoffmann023b5152012-06-19 09:54:54 +0200805 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
806 return SUCCESS;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200807}
808
Hans de Goede13630742016-04-12 12:27:09 +0200809static int uas_target_alloc(struct scsi_target *starget)
810{
811 struct uas_dev_info *devinfo = (struct uas_dev_info *)
812 dev_to_shost(starget->dev.parent)->hostdata;
813
814 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
815 starget->no_report_luns = 1;
816
817 return 0;
818}
819
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200820static int uas_slave_alloc(struct scsi_device *sdev)
821{
Hans de Goedeee136af2015-04-21 11:20:31 +0200822 struct uas_dev_info *devinfo =
823 (struct uas_dev_info *)sdev->host->hostdata;
824
825 sdev->hostdata = devinfo;
Hans de Goede37599f92013-11-15 10:04:31 +0100826
Felipe Balbif0183a32016-04-18 13:09:11 +0300827 /*
Oliver Neukum3ae62a42019-04-30 12:21:45 +0200828 * The protocol has no requirements on alignment in the strict sense.
829 * Controllers may or may not have alignment restrictions.
830 * As this is not exported, we use an extremely conservative guess.
Hans de Goede37599f92013-11-15 10:04:31 +0100831 */
832 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
833
Greg Kroah-Hartmand5c65d32020-12-04 16:00:34 +0100834 if (devinfo->flags & US_FL_MAX_SECTORS_64)
835 blk_queue_max_hw_sectors(sdev->request_queue, 64);
836 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
837 blk_queue_max_hw_sectors(sdev->request_queue, 240);
838
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200839 return 0;
840}
841
842static int uas_slave_configure(struct scsi_device *sdev)
843{
844 struct uas_dev_info *devinfo = sdev->hostdata;
Hans de Goede734016b2014-09-16 18:36:52 +0200845
846 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
847 sdev->no_report_opcodes = 1;
848
Dmitry Katsubo9fa62b12015-11-20 01:30:44 +0100849 /* A few buggy USB-ATA bridges don't understand FUA */
850 if (devinfo->flags & US_FL_BROKEN_FUA)
851 sdev->broken_fua = 1;
852
Alexander Kappner8c4e97dd2018-05-18 21:50:15 -0700853 /* UAS also needs to support FL_ALWAYS_SYNC */
854 if (devinfo->flags & US_FL_ALWAYS_SYNC) {
855 sdev->skip_ms_page_3f = 1;
856 sdev->skip_ms_page_8 = 1;
857 sdev->wce_default_on = 1;
858 }
Oliver Neukum42d1c6d2018-08-09 16:03:37 +0200859
Oliver Neukumbff000c2019-11-14 12:27:56 +0100860 /* Some disks cannot handle READ_CAPACITY_16 */
861 if (devinfo->flags & US_FL_NO_READ_CAPACITY_16)
862 sdev->no_read_capacity_16 = 1;
863
Oliver Neukum80106222020-12-09 16:26:39 +0100864 /* Some disks cannot handle WRITE_SAME */
865 if (devinfo->flags & US_FL_NO_SAME)
866 sdev->no_write_same = 1;
Oliver Neukum42d1c6d2018-08-09 16:03:37 +0200867 /*
868 * Some disks return the total number of blocks in response
869 * to READ CAPACITY rather than the highest block number.
870 * If this device makes that mistake, tell the sd driver.
871 */
872 if (devinfo->flags & US_FL_FIX_CAPACITY)
873 sdev->fix_capacity = 1;
874
875 /*
Oliver Neukum335cbbd2019-11-14 12:27:57 +0100876 * in some cases we have to guess
877 */
878 if (devinfo->flags & US_FL_CAPACITY_HEURISTICS)
879 sdev->guess_capacity = 1;
880
881 /*
Oliver Neukum42d1c6d2018-08-09 16:03:37 +0200882 * Some devices don't like MODE SENSE with page=0x3f,
883 * which is the command used for checking if a device
884 * is write-protected. Now that we tell the sd driver
885 * to do a 192-byte transfer with this command the
886 * majority of devices work fine, but a few still can't
887 * handle it. The sd driver will simply assume those
888 * devices are write-enabled.
889 */
890 if (devinfo->flags & US_FL_NO_WP_DETECT)
891 sdev->skip_ms_page_3f = 1;
892
Hans de Goede593224e2016-05-31 09:18:03 +0200893 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200894 return 0;
895}
896
897static struct scsi_host_template uas_host_template = {
898 .module = THIS_MODULE,
899 .name = "uas",
900 .queuecommand = uas_queuecommand,
Hans de Goede13630742016-04-12 12:27:09 +0200901 .target_alloc = uas_target_alloc,
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200902 .slave_alloc = uas_slave_alloc,
903 .slave_configure = uas_slave_configure,
904 .eh_abort_handler = uas_eh_abort_handler,
Hannes Reineckee13849b2017-08-25 13:57:01 +0200905 .eh_device_reset_handler = uas_eh_device_reset_handler,
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200906 .this_id = -1,
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200907 .skip_settle_delay = 1,
Christoph Hellwig4af14d12018-12-13 16:17:09 +0100908 .dma_boundary = PAGE_SIZE - 1,
Bart Van Assche5dfcf1a2022-02-18 11:51:13 -0800909 .cmd_size = sizeof(struct uas_cmd_info),
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200910};
911
Hans de Goede79b4c062013-10-25 17:04:33 +0100912#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
913 vendorName, productName, useProtocol, useTransport, \
914 initFunction, flags) \
915{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
916 .driver_info = (flags) }
917
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200918static struct usb_device_id uas_usb_ids[] = {
Hans de Goede79b4c062013-10-25 17:04:33 +0100919# include "unusual_uas.h"
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200920 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
921 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200922 { }
923};
924MODULE_DEVICE_TABLE(usb, uas_usb_ids);
925
Hans de Goede79b4c062013-10-25 17:04:33 +0100926#undef UNUSUAL_DEV
927
Hans de Goedee1be0672013-10-21 08:00:58 +0100928static int uas_switch_interface(struct usb_device *udev,
929 struct usb_interface *intf)
930{
Alan Stern786de922017-09-22 11:56:49 -0400931 struct usb_host_interface *alt;
Hans de Goedee1be0672013-10-21 08:00:58 +0100932
933 alt = uas_find_uas_alt_setting(intf);
Alan Stern786de922017-09-22 11:56:49 -0400934 if (!alt)
935 return -ENODEV;
Hans de Goedee1be0672013-10-21 08:00:58 +0100936
Alan Stern786de922017-09-22 11:56:49 -0400937 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
938 alt->desc.bAlternateSetting);
Hans de Goedee1be0672013-10-21 08:00:58 +0100939}
940
Hans de Goede58d51442013-10-29 10:23:26 +0100941static int uas_configure_endpoints(struct uas_dev_info *devinfo)
Hans de Goede34f11e52013-10-29 08:54:48 +0100942{
943 struct usb_host_endpoint *eps[4] = { };
944 struct usb_device *udev = devinfo->udev;
945 int r;
946
Hans de Goede34f11e52013-10-29 08:54:48 +0100947 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
Hans de Goede74d71ae2013-10-29 10:10:36 +0100948 if (r)
949 return r;
Hans de Goede34f11e52013-10-29 08:54:48 +0100950
Hans de Goede74d71ae2013-10-29 10:10:36 +0100951 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
952 usb_endpoint_num(&eps[0]->desc));
953 devinfo->status_pipe = usb_rcvbulkpipe(udev,
954 usb_endpoint_num(&eps[1]->desc));
955 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
956 usb_endpoint_num(&eps[2]->desc));
957 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
958 usb_endpoint_num(&eps[3]->desc));
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200959
Hans de Goedee5e55812014-09-13 12:26:43 +0200960 if (udev->speed < USB_SPEED_SUPER) {
Hans de Goedee2875c32014-08-01 17:33:08 +0200961 devinfo->qdepth = 32;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200962 devinfo->use_streams = 0;
963 } else {
Hans de Goede58d51442013-10-29 10:23:26 +0100964 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
Hans de Goede5e61aed2014-09-13 12:26:32 +0200965 3, MAX_CMNDS, GFP_NOIO);
Hans de Goede58d51442013-10-29 10:23:26 +0100966 if (devinfo->qdepth < 0)
967 return devinfo->qdepth;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200968 devinfo->use_streams = 1;
969 }
Hans de Goede58d51442013-10-29 10:23:26 +0100970
971 return 0;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200972}
973
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +0100974static void uas_free_streams(struct uas_dev_info *devinfo)
975{
976 struct usb_device *udev = devinfo->udev;
977 struct usb_host_endpoint *eps[3];
978
979 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
980 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
981 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
Oliver Neukum94d72f02014-03-28 11:25:50 +0100982 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +0100983}
984
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200985static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
986{
Hans de Goede6ce82132013-10-17 19:00:45 +0200987 int result = -ENOMEM;
988 struct Scsi_Host *shost = NULL;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200989 struct uas_dev_info *devinfo;
990 struct usb_device *udev = interface_to_usbdev(intf);
Hans de Goedea5011d42015-04-21 11:20:30 +0200991 unsigned long dev_flags;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200992
Hans de Goedea5011d42015-04-21 11:20:30 +0200993 if (!uas_use_uas_driver(intf, id, &dev_flags))
Hans de Goede79b4c062013-10-25 17:04:33 +0100994 return -ENODEV;
995
Matthew Wilcox89dc2902010-12-15 15:44:05 -0500996 if (uas_switch_interface(udev, intf))
997 return -ENODEV;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +0200998
Hans de Goede21fc05b2013-11-13 09:32:22 +0100999 shost = scsi_host_alloc(&uas_host_template,
1000 sizeof(struct uas_dev_info));
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001001 if (!shost)
Hans de Goede6ce82132013-10-17 19:00:45 +02001002 goto set_alt0;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001003
1004 shost->max_cmd_len = 16 + 252;
1005 shost->max_id = 1;
Gerd Hoffmannbde027b2013-01-25 15:03:36 +01001006 shost->max_lun = 256;
1007 shost->max_channel = 0;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001008 shost->sg_tablesize = udev->bus->sg_tablesize;
1009
Hans de Goede21fc05b2013-11-13 09:32:22 +01001010 devinfo = (struct uas_dev_info *)shost->hostdata;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001011 devinfo->intf = intf;
1012 devinfo->udev = udev;
Gerd Hoffmann023b5152012-06-19 09:54:54 +02001013 devinfo->resetting = 0;
Hans de Goededa65c2b2013-11-11 11:51:42 +01001014 devinfo->shutdown = 0;
Hans de Goedea5011d42015-04-21 11:20:30 +02001015 devinfo->flags = dev_flags;
Gerd Hoffmanna0e39e32012-09-25 10:47:04 +02001016 init_usb_anchor(&devinfo->cmd_urbs);
Gerd Hoffmannbdd000f2012-06-19 09:54:53 +02001017 init_usb_anchor(&devinfo->sense_urbs);
1018 init_usb_anchor(&devinfo->data_urbs);
Gerd Hoffmanne0648522012-09-25 10:47:08 +02001019 spin_lock_init(&devinfo->lock);
Gerd Hoffmann1bf81982013-09-13 13:27:12 +02001020 INIT_WORK(&devinfo->work, uas_do_work);
EJ Hsu3e998622020-01-30 01:25:06 -08001021 INIT_WORK(&devinfo->scan_work, uas_scan_work);
Hans de Goede58d51442013-10-29 10:23:26 +01001022
1023 result = uas_configure_endpoints(devinfo);
1024 if (result)
1025 goto set_alt0;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001026
Hans de Goede198de512016-04-12 12:27:08 +02001027 /*
1028 * 1 tag is reserved for untagged commands +
1029 * 1 tag to avoid off by one errors in some bridge firmwares
1030 */
1031 shost->can_queue = devinfo->qdepth - 2;
1032
Oliver Neukumc637f1fa2014-03-28 11:29:25 +01001033 usb_set_intfdata(intf, shost);
Greg Kroah-Hartmand5c65d32020-12-04 16:00:34 +01001034 result = scsi_add_host(shost, &intf->dev);
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +01001035 if (result)
Hans de Goede6ce82132013-10-17 19:00:45 +02001036 goto free_streams;
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +01001037
EJ Hsu3e998622020-01-30 01:25:06 -08001038 /* Submit the delayed_work for SCSI-device scanning */
1039 schedule_work(&devinfo->scan_work);
1040
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001041 return result;
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +01001042
Hans de Goede6ce82132013-10-17 19:00:45 +02001043free_streams:
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +01001044 uas_free_streams(devinfo);
Oliver Neukumc637f1fa2014-03-28 11:29:25 +01001045 usb_set_intfdata(intf, NULL);
Hans de Goede6ce82132013-10-17 19:00:45 +02001046set_alt0:
1047 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001048 if (shost)
1049 scsi_host_put(shost);
1050 return result;
1051}
1052
Hans de Goedef9dc0242014-09-13 12:26:42 +02001053static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1054{
1055 unsigned long flags;
1056 int i, r = 1;
1057
1058 spin_lock_irqsave(&devinfo->lock, flags);
1059
1060 for (i = 0; i < devinfo->qdepth; i++) {
1061 if (devinfo->cmnd[i]) {
1062 r = 0; /* Not empty */
1063 break;
1064 }
1065 }
1066
1067 spin_unlock_irqrestore(&devinfo->lock, flags);
1068
1069 return r;
1070}
1071
1072/*
1073 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1074 * get empty while there still is more work to do due to sense-urbs completing
1075 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1076 */
1077static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1078{
1079 unsigned long start_time;
1080 int r;
1081
1082 start_time = jiffies;
1083 do {
1084 flush_work(&devinfo->work);
1085
1086 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1087 if (r == 0)
1088 return -ETIME;
1089
1090 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1091 if (r == 0)
1092 return -ETIME;
1093
1094 if (time_after(jiffies, start_time + 5 * HZ))
1095 return -ETIME;
1096 } while (!uas_cmnd_list_empty(devinfo));
1097
1098 return 0;
1099}
1100
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001101static int uas_pre_reset(struct usb_interface *intf)
1102{
Hans de Goede4de7a3732013-10-22 16:10:44 +01001103 struct Scsi_Host *shost = usb_get_intfdata(intf);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001104 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goede4de7a3732013-10-22 16:10:44 +01001105 unsigned long flags;
1106
Hans de Goededa65c2b2013-11-11 11:51:42 +01001107 if (devinfo->shutdown)
1108 return 0;
1109
Hans de Goede4de7a3732013-10-22 16:10:44 +01001110 /* Block new requests */
1111 spin_lock_irqsave(shost->host_lock, flags);
1112 scsi_block_requests(shost);
1113 spin_unlock_irqrestore(shost->host_lock, flags);
1114
Hans de Goedef9dc0242014-09-13 12:26:42 +02001115 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
Hans de Goede4de7a3732013-10-22 16:10:44 +01001116 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
Hans de Goedef9dc0242014-09-13 12:26:42 +02001117 scsi_unblock_requests(shost);
Hans de Goede4de7a3732013-10-22 16:10:44 +01001118 return 1;
1119 }
1120
1121 uas_free_streams(devinfo);
1122
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001123 return 0;
1124}
1125
1126static int uas_post_reset(struct usb_interface *intf)
1127{
Hans de Goede4de7a3732013-10-22 16:10:44 +01001128 struct Scsi_Host *shost = usb_get_intfdata(intf);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001129 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goede4de7a3732013-10-22 16:10:44 +01001130 unsigned long flags;
Hans de Goedece39fe62014-09-13 12:26:50 +02001131 int err;
Hans de Goede4de7a3732013-10-22 16:10:44 +01001132
Hans de Goededa65c2b2013-11-11 11:51:42 +01001133 if (devinfo->shutdown)
1134 return 0;
1135
Hans de Goedece39fe62014-09-13 12:26:50 +02001136 err = uas_configure_endpoints(devinfo);
Oliver Neukum9a513c92018-03-06 15:04:24 +01001137 if (err && err != -ENODEV)
Hans de Goede58d51442013-10-29 10:23:26 +01001138 shost_printk(KERN_ERR, shost,
Hans de Goedece39fe62014-09-13 12:26:50 +02001139 "%s: alloc streams error %d after reset",
1140 __func__, err);
Hans de Goede4de7a3732013-10-22 16:10:44 +01001141
Oliver Neukumcbeef222018-01-11 13:10:16 +01001142 /* we must unblock the host in every case lest we deadlock */
Hans de Goede4de7a3732013-10-22 16:10:44 +01001143 spin_lock_irqsave(shost->host_lock, flags);
1144 scsi_report_bus_reset(shost, 0);
1145 spin_unlock_irqrestore(shost->host_lock, flags);
1146
1147 scsi_unblock_requests(shost);
1148
Oliver Neukumcbeef222018-01-11 13:10:16 +01001149 return err ? 1 : 0;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001150}
1151
Hans de Goede0df1f662013-11-07 08:47:05 +01001152static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1153{
1154 struct Scsi_Host *shost = usb_get_intfdata(intf);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001155 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goede0df1f662013-11-07 08:47:05 +01001156
Hans de Goedef9dc0242014-09-13 12:26:42 +02001157 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
Hans de Goede0df1f662013-11-07 08:47:05 +01001158 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1159 return -ETIME;
1160 }
1161
1162 return 0;
1163}
1164
1165static int uas_resume(struct usb_interface *intf)
1166{
1167 return 0;
1168}
1169
1170static int uas_reset_resume(struct usb_interface *intf)
1171{
1172 struct Scsi_Host *shost = usb_get_intfdata(intf);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001173 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goede0df1f662013-11-07 08:47:05 +01001174 unsigned long flags;
Hans de Goedece39fe62014-09-13 12:26:50 +02001175 int err;
Hans de Goede0df1f662013-11-07 08:47:05 +01001176
Hans de Goedece39fe62014-09-13 12:26:50 +02001177 err = uas_configure_endpoints(devinfo);
1178 if (err) {
Hans de Goede0df1f662013-11-07 08:47:05 +01001179 shost_printk(KERN_ERR, shost,
Hans de Goedece39fe62014-09-13 12:26:50 +02001180 "%s: alloc streams error %d after reset",
1181 __func__, err);
Hans de Goede0df1f662013-11-07 08:47:05 +01001182 return -EIO;
1183 }
1184
1185 spin_lock_irqsave(shost->host_lock, flags);
1186 scsi_report_bus_reset(shost, 0);
1187 spin_unlock_irqrestore(shost->host_lock, flags);
1188
1189 return 0;
1190}
1191
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001192static void uas_disconnect(struct usb_interface *intf)
1193{
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001194 struct Scsi_Host *shost = usb_get_intfdata(intf);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001195 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goedeb7b5d112014-09-13 12:26:30 +02001196 unsigned long flags;
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001197
Hans de Goedeb7b5d112014-09-13 12:26:30 +02001198 spin_lock_irqsave(&devinfo->lock, flags);
Gerd Hoffmann4c456972012-11-30 11:54:44 +01001199 devinfo->resetting = 1;
Hans de Goedeb7b5d112014-09-13 12:26:30 +02001200 spin_unlock_irqrestore(&devinfo->lock, flags);
1201
Gerd Hoffmann1bf81982013-09-13 13:27:12 +02001202 cancel_work_sync(&devinfo->work);
Gerd Hoffmanna0e39e32012-09-25 10:47:04 +02001203 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
Gerd Hoffmannbdd000f2012-06-19 09:54:53 +02001204 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1205 usb_kill_anchored_urbs(&devinfo->data_urbs);
Hans de Goede15893492014-09-13 12:26:36 +02001206 uas_zap_pending(devinfo, DID_NO_CONNECT);
1207
EJ Hsu3e998622020-01-30 01:25:06 -08001208 /*
1209 * Prevent SCSI scanning (if it hasn't started yet)
1210 * or wait for the SCSI-scanning routine to stop.
1211 */
1212 cancel_work_sync(&devinfo->scan_work);
1213
Gerd Hoffmann4c456972012-11-30 11:54:44 +01001214 scsi_remove_host(shost);
Sebastian Andrzej Siewiordae51542011-12-19 17:06:08 +01001215 uas_free_streams(devinfo);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001216 scsi_host_put(shost);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001217}
1218
Hans de Goededa65c2b2013-11-11 11:51:42 +01001219/*
1220 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1221 * hang on reboot when the device is still in uas mode. Note the reset is
1222 * necessary as some devices won't revert to usb-storage mode without it.
1223 */
1224static void uas_shutdown(struct device *dev)
1225{
1226 struct usb_interface *intf = to_usb_interface(dev);
1227 struct usb_device *udev = interface_to_usbdev(intf);
1228 struct Scsi_Host *shost = usb_get_intfdata(intf);
Hans de Goede21fc05b2013-11-13 09:32:22 +01001229 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
Hans de Goededa65c2b2013-11-11 11:51:42 +01001230
1231 if (system_state != SYSTEM_RESTART)
1232 return;
1233
1234 devinfo->shutdown = 1;
1235 uas_free_streams(devinfo);
1236 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1237 usb_reset_device(udev);
1238}
1239
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001240static struct usb_driver uas_driver = {
1241 .name = "uas",
1242 .probe = uas_probe,
1243 .disconnect = uas_disconnect,
1244 .pre_reset = uas_pre_reset,
1245 .post_reset = uas_post_reset,
Hans de Goede0df1f662013-11-07 08:47:05 +01001246 .suspend = uas_suspend,
1247 .resume = uas_resume,
1248 .reset_resume = uas_reset_resume,
Hans de Goededa65c2b2013-11-11 11:51:42 +01001249 .drvwrap.driver.shutdown = uas_shutdown,
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001250 .id_table = uas_usb_ids,
1251};
1252
Oliver Neukumf6cc6092020-04-15 16:17:50 +02001253static int __init uas_init(void)
1254{
1255 int rv;
1256
1257 workqueue = alloc_workqueue("uas", WQ_MEM_RECLAIM, 0);
1258 if (!workqueue)
1259 return -ENOMEM;
1260
1261 rv = usb_register(&uas_driver);
1262 if (rv) {
1263 destroy_workqueue(workqueue);
1264 return -ENOMEM;
1265 }
1266
1267 return 0;
1268}
1269
1270static void __exit uas_exit(void)
1271{
1272 usb_deregister(&uas_driver);
1273 destroy_workqueue(workqueue);
1274}
1275
1276module_init(uas_init);
1277module_exit(uas_exit);
Matthew Wilcox115bb1f2010-10-07 13:05:23 +02001278
1279MODULE_LICENSE("GPL");
Matthias Maennich32bca2d2019-09-06 11:32:35 +01001280MODULE_IMPORT_NS(USB_STORAGE);
Hans de Goedef50a4962013-10-28 10:48:04 +00001281MODULE_AUTHOR(
1282 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");