blob: a70c1c29a7aa2c28e99c9fa352fa6f42b2048d17 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * The low performance USB storage driver (ub).
3 *
4 * Copyright (c) 1999, 2000 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
5 * Copyright (C) 2004 Pete Zaitcev (zaitcev@yahoo.com)
6 *
7 * This work is a part of Linux kernel, is derived from it,
8 * and is not licensed separately. See file COPYING for details.
9 *
10 * TODO (sorted by decreasing priority)
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * -- set readonly flag for CDs, set removable flag for CF readers
12 * -- do inquiry and verify we got a disk and not a tape (for LUN mismatch)
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 * -- verify the 13 conditions and do bulk resets
Pete Zaitcevba6abf12005-07-30 22:38:30 -070014 * -- highmem
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * -- move top_sense and work_bcs into separate allocations (if they survive)
16 * for cache purists and esoteric architectures.
Pete Zaitcevba6abf12005-07-30 22:38:30 -070017 * -- Allocate structure for LUN 0 before the first ub_sync_tur, avoid NULL. ?
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 * -- prune comments, they are too volumnous
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * -- Resove XXX's
Pete Zaitcev1872bce2005-07-27 11:43:51 -070020 * -- CLEAR, CLR2STS, CLRRS seem to be ripe for refactoring.
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 */
22#include <linux/kernel.h>
23#include <linux/module.h>
24#include <linux/usb.h>
Pete Zaitceva00828e2005-10-22 20:15:09 -070025#include <linux/usb_usual.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/timer.h>
Jens Axboe45711f12007-10-22 21:19:53 +020028#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <scsi/scsi.h>
30
31#define DRV_NAME "ub"
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
33#define UB_MAJOR 180
34
35/*
Pete Zaitcev1872bce2005-07-27 11:43:51 -070036 * The command state machine is the key model for understanding of this driver.
37 *
38 * The general rule is that all transitions are done towards the bottom
39 * of the diagram, thus preventing any loops.
40 *
41 * An exception to that is how the STAT state is handled. A counter allows it
42 * to be re-entered along the path marked with [C].
43 *
44 * +--------+
45 * ! INIT !
46 * +--------+
47 * !
48 * ub_scsi_cmd_start fails ->--------------------------------------\
49 * ! !
50 * V !
51 * +--------+ !
52 * ! CMD ! !
53 * +--------+ !
54 * ! +--------+ !
55 * was -EPIPE -->-------------------------------->! CLEAR ! !
56 * ! +--------+ !
57 * ! ! !
58 * was error -->------------------------------------- ! --------->\
59 * ! ! !
60 * /--<-- cmd->dir == NONE ? ! !
61 * ! ! ! !
62 * ! V ! !
63 * ! +--------+ ! !
64 * ! ! DATA ! ! !
65 * ! +--------+ ! !
66 * ! ! +---------+ ! !
67 * ! was -EPIPE -->--------------->! CLR2STS ! ! !
68 * ! ! +---------+ ! !
69 * ! ! ! ! !
70 * ! ! was error -->---- ! --------->\
71 * ! was error -->--------------------- ! ------------- ! --------->\
72 * ! ! ! ! !
73 * ! V ! ! !
74 * \--->+--------+ ! ! !
75 * ! STAT !<--------------------------/ ! !
76 * /--->+--------+ ! !
77 * ! ! ! !
78 * [C] was -EPIPE -->-----------\ ! !
79 * ! ! ! ! !
80 * +<---- len == 0 ! ! !
81 * ! ! ! ! !
82 * ! was error -->--------------------------------------!---------->\
83 * ! ! ! ! !
84 * +<---- bad CSW ! ! !
85 * +<---- bad tag ! ! !
86 * ! ! V ! !
87 * ! ! +--------+ ! !
88 * ! ! ! CLRRS ! ! !
89 * ! ! +--------+ ! !
90 * ! ! ! ! !
91 * \------- ! --------------------[C]--------\ ! !
92 * ! ! ! !
93 * cmd->error---\ +--------+ ! !
94 * ! +--------------->! SENSE !<----------/ !
95 * STAT_FAIL----/ +--------+ !
96 * ! ! V
97 * ! V +--------+
98 * \--------------------------------\--------------------->! DONE !
99 * +--------+
100 */
101
102/*
Pete Zaitcevf4800072005-05-01 16:05:40 -0700103 * This many LUNs per USB device.
104 * Every one of them takes a host, see UB_MAX_HOSTS.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 */
Pete Zaitcev9f793d22005-06-06 13:54:59 -0700106#define UB_MAX_LUNS 9
Pete Zaitcevf4800072005-05-01 16:05:40 -0700107
108/*
109 */
110
Pete Zaitcev4fb729f2005-12-17 02:34:12 -0800111#define UB_PARTS_PER_LUN 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
113#define UB_MAX_CDB_SIZE 16 /* Corresponds to Bulk */
114
115#define UB_SENSE_SIZE 18
116
117/*
118 */
119
120/* command block wrapper */
121struct bulk_cb_wrap {
122 __le32 Signature; /* contains 'USBC' */
123 u32 Tag; /* unique per command id */
124 __le32 DataTransferLength; /* size of data */
125 u8 Flags; /* direction in bit 0 */
Pete Zaitcevf4800072005-05-01 16:05:40 -0700126 u8 Lun; /* LUN */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 u8 Length; /* of of the CDB */
128 u8 CDB[UB_MAX_CDB_SIZE]; /* max command */
129};
130
131#define US_BULK_CB_WRAP_LEN 31
132#define US_BULK_CB_SIGN 0x43425355 /*spells out USBC */
133#define US_BULK_FLAG_IN 1
134#define US_BULK_FLAG_OUT 0
135
136/* command status wrapper */
137struct bulk_cs_wrap {
138 __le32 Signature; /* should = 'USBS' */
139 u32 Tag; /* same as original command */
140 __le32 Residue; /* amount not transferred */
141 u8 Status; /* see below */
142};
143
144#define US_BULK_CS_WRAP_LEN 13
145#define US_BULK_CS_SIGN 0x53425355 /* spells out 'USBS' */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146#define US_BULK_STAT_OK 0
147#define US_BULK_STAT_FAIL 1
148#define US_BULK_STAT_PHASE 2
149
150/* bulk-only class specific requests */
151#define US_BULK_RESET_REQUEST 0xff
152#define US_BULK_GET_MAX_LUN 0xfe
153
154/*
155 */
156struct ub_dev;
157
Pete Zaitcev64bd8452005-09-22 00:48:29 -0700158#define UB_MAX_REQ_SG 9 /* cdrecord requires 32KB and maybe a header */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159#define UB_MAX_SECTORS 64
160
161/*
162 * A second is more than enough for a 32K transfer (UB_MAX_SECTORS)
163 * even if a webcam hogs the bus, but some devices need time to spin up.
164 */
165#define UB_URB_TIMEOUT (HZ*2)
166#define UB_DATA_TIMEOUT (HZ*5) /* ZIP does spin-ups in the data phase */
167#define UB_STAT_TIMEOUT (HZ*5) /* Same spinups and eject for a dataless cmd. */
168#define UB_CTRL_TIMEOUT (HZ/2) /* 500ms ought to be enough to clear a stall */
169
170/*
171 * An instance of a SCSI command in transit.
172 */
173#define UB_DIR_NONE 0
174#define UB_DIR_READ 1
175#define UB_DIR_ILLEGAL2 2
176#define UB_DIR_WRITE 3
177
178#define UB_DIR_CHAR(c) (((c)==UB_DIR_WRITE)? 'w': \
179 (((c)==UB_DIR_READ)? 'r': 'n'))
180
181enum ub_scsi_cmd_state {
182 UB_CMDST_INIT, /* Initial state */
183 UB_CMDST_CMD, /* Command submitted */
184 UB_CMDST_DATA, /* Data phase */
185 UB_CMDST_CLR2STS, /* Clearing before requesting status */
186 UB_CMDST_STAT, /* Status phase */
187 UB_CMDST_CLEAR, /* Clearing a stall (halt, actually) */
Pete Zaitcev1872bce2005-07-27 11:43:51 -0700188 UB_CMDST_CLRRS, /* Clearing before retrying status */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 UB_CMDST_SENSE, /* Sending Request Sense */
190 UB_CMDST_DONE /* Final state */
191};
192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193struct ub_scsi_cmd {
194 unsigned char cdb[UB_MAX_CDB_SIZE];
195 unsigned char cdb_len;
196
197 unsigned char dir; /* 0 - none, 1 - read, 3 - write. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 enum ub_scsi_cmd_state state;
199 unsigned int tag;
200 struct ub_scsi_cmd *next;
201
202 int error; /* Return code - valid upon done */
203 unsigned int act_len; /* Return size */
204 unsigned char key, asc, ascq; /* May be valid if error==-EIO */
205
206 int stat_count; /* Retries getting status. */
207
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 unsigned int len; /* Requested length */
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700209 unsigned int current_sg;
210 unsigned int nsg; /* sgv[nsg] */
211 struct scatterlist sgv[UB_MAX_REQ_SG];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Pete Zaitcevf4800072005-05-01 16:05:40 -0700213 struct ub_lun *lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 void (*done)(struct ub_dev *, struct ub_scsi_cmd *);
215 void *back;
216};
217
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800218struct ub_request {
219 struct request *rq;
220 unsigned int current_try;
221 unsigned int nsg; /* sgv[nsg] */
222 struct scatterlist sgv[UB_MAX_REQ_SG];
223};
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225/*
226 */
227struct ub_capacity {
228 unsigned long nsec; /* Linux size - 512 byte sectors */
229 unsigned int bsize; /* Linux hardsect_size */
230 unsigned int bshift; /* Shift between 512 and hard sects */
231};
232
233/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 * This is a direct take-off from linux/include/completion.h
235 * The difference is that I do not wait on this thing, just poll.
236 * When I want to wait (ub_probe), I just use the stock completion.
237 *
238 * Note that INIT_COMPLETION takes no lock. It is correct. But why
239 * in the bloody hell that thing takes struct instead of pointer to struct
240 * is quite beyond me. I just copied it from the stock completion.
241 */
242struct ub_completion {
243 unsigned int done;
244 spinlock_t lock;
245};
246
247static inline void ub_init_completion(struct ub_completion *x)
248{
249 x->done = 0;
250 spin_lock_init(&x->lock);
251}
252
253#define UB_INIT_COMPLETION(x) ((x).done = 0)
254
255static void ub_complete(struct ub_completion *x)
256{
257 unsigned long flags;
258
259 spin_lock_irqsave(&x->lock, flags);
260 x->done++;
261 spin_unlock_irqrestore(&x->lock, flags);
262}
263
264static int ub_is_completed(struct ub_completion *x)
265{
266 unsigned long flags;
267 int ret;
268
269 spin_lock_irqsave(&x->lock, flags);
270 ret = x->done;
271 spin_unlock_irqrestore(&x->lock, flags);
272 return ret;
273}
274
275/*
276 */
277struct ub_scsi_cmd_queue {
278 int qlen, qmax;
279 struct ub_scsi_cmd *head, *tail;
280};
281
282/*
Pete Zaitcevf4800072005-05-01 16:05:40 -0700283 * The block device instance (one per LUN).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 */
Pete Zaitcevf4800072005-05-01 16:05:40 -0700285struct ub_lun {
286 struct ub_dev *udev;
287 struct list_head link;
288 struct gendisk *disk;
289 int id; /* Host index */
290 int num; /* LUN number */
291 char name[16];
292
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 int changed; /* Media was changed */
294 int removable;
295 int readonly;
Pete Zaitcevf4800072005-05-01 16:05:40 -0700296
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800297 struct ub_request urq;
298
Pete Zaitcevf4800072005-05-01 16:05:40 -0700299 /* Use Ingo's mempool if or when we have more than one command. */
300 /*
301 * Currently we never need more than one command for the whole device.
302 * However, giving every LUN a command is a cheap and automatic way
303 * to enforce fairness between them.
304 */
305 int cmda[1];
306 struct ub_scsi_cmd cmdv[1];
307
308 struct ub_capacity capacity;
309};
310
311/*
312 * The USB device instance.
313 */
314struct ub_dev {
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800315 spinlock_t *lock;
Pete Zaitcevf4800072005-05-01 16:05:40 -0700316 atomic_t poison; /* The USB device is disconnected */
317 int openc; /* protected by ub_lock! */
318 /* kref is too implicit for our taste */
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800319 int reset; /* Reset is running */
Pete Zaitcevf4800072005-05-01 16:05:40 -0700320 unsigned int tagcnt;
321 char name[12];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 struct usb_device *dev;
323 struct usb_interface *intf;
324
Pete Zaitcevf4800072005-05-01 16:05:40 -0700325 struct list_head luns;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327 unsigned int send_bulk_pipe; /* cached pipe values */
328 unsigned int recv_bulk_pipe;
329 unsigned int send_ctrl_pipe;
330 unsigned int recv_ctrl_pipe;
331
332 struct tasklet_struct tasklet;
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 struct ub_scsi_cmd_queue cmd_queue;
335 struct ub_scsi_cmd top_rqs_cmd; /* REQUEST SENSE */
336 unsigned char top_sense[UB_SENSE_SIZE];
337
338 struct ub_completion work_done;
339 struct urb work_urb;
340 struct timer_list work_timer;
341 int last_pipe; /* What might need clearing */
Pete Zaitcev1872bce2005-07-27 11:43:51 -0700342 __le32 signature; /* Learned signature */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 struct bulk_cb_wrap work_bcb;
344 struct bulk_cs_wrap work_bcs;
345 struct usb_ctrlrequest work_cr;
346
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800347 struct work_struct reset_work;
348 wait_queue_head_t reset_wait;
349
Pete Zaitcev64bd8452005-09-22 00:48:29 -0700350 int sg_stat[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351};
352
353/*
354 */
355static void ub_cleanup(struct ub_dev *sc);
Pete Zaitcev6c1eb8c2005-07-30 22:51:52 -0700356static int ub_request_fn_1(struct ub_lun *lun, struct request *rq);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800357static void ub_cmd_build_block(struct ub_dev *sc, struct ub_lun *lun,
358 struct ub_scsi_cmd *cmd, struct ub_request *urq);
359static void ub_cmd_build_packet(struct ub_dev *sc, struct ub_lun *lun,
360 struct ub_scsi_cmd *cmd, struct ub_request *urq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361static void ub_rw_cmd_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700362static void ub_end_rq(struct request *rq, unsigned int status);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800363static int ub_rw_cmd_retry(struct ub_dev *sc, struct ub_lun *lun,
364 struct ub_request *urq, struct ub_scsi_cmd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365static int ub_submit_scsi(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
David Howells7d12e782006-10-05 14:55:46 +0100366static void ub_urb_complete(struct urb *urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367static void ub_scsi_action(unsigned long _dev);
368static void ub_scsi_dispatch(struct ub_dev *sc);
369static void ub_scsi_urb_compl(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700370static void ub_data_start(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371static void ub_state_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd, int rc);
Pete Zaitcev1872bce2005-07-27 11:43:51 -0700372static int __ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373static void ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
Pete Zaitcev1872bce2005-07-27 11:43:51 -0700374static void ub_state_stat_counted(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375static void ub_state_sense(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
376static int ub_submit_clear_stall(struct ub_dev *sc, struct ub_scsi_cmd *cmd,
377 int stalled_pipe);
378static void ub_top_sense_done(struct ub_dev *sc, struct ub_scsi_cmd *scmd);
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -0800379static void ub_reset_enter(struct ub_dev *sc, int try);
David Howellsc4028952006-11-22 14:57:56 +0000380static void ub_reset_task(struct work_struct *work);
Pete Zaitcevf4800072005-05-01 16:05:40 -0700381static int ub_sync_tur(struct ub_dev *sc, struct ub_lun *lun);
382static int ub_sync_read_cap(struct ub_dev *sc, struct ub_lun *lun,
383 struct ub_capacity *ret);
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -0800384static int ub_sync_reset(struct ub_dev *sc);
385static int ub_probe_clear_stall(struct ub_dev *sc, int stalled_pipe);
Pete Zaitcevf4800072005-05-01 16:05:40 -0700386static int ub_probe_lun(struct ub_dev *sc, int lnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388/*
389 */
Pete Zaitceva00828e2005-10-22 20:15:09 -0700390#ifdef CONFIG_USB_LIBUSUAL
391
392#define ub_usb_ids storage_usb_ids
393#else
394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395static struct usb_device_id ub_usb_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, US_SC_SCSI, US_PR_BULK) },
397 { }
398};
399
400MODULE_DEVICE_TABLE(usb, ub_usb_ids);
Pete Zaitceva00828e2005-10-22 20:15:09 -0700401#endif /* CONFIG_USB_LIBUSUAL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
403/*
404 * Find me a way to identify "next free minor" for add_disk(),
405 * and the array disappears the next day. However, the number of
406 * hosts has something to do with the naming and /proc/partitions.
407 * This has to be thought out in detail before changing.
408 * If UB_MAX_HOST was 1000, we'd use a bitmap. Or a better data structure.
409 */
410#define UB_MAX_HOSTS 26
411static char ub_hostv[UB_MAX_HOSTS];
Pete Zaitcevf4800072005-05-01 16:05:40 -0700412
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800413#define UB_QLOCK_NUM 5
414static spinlock_t ub_qlockv[UB_QLOCK_NUM];
415static int ub_qlock_next = 0;
416
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417static DEFINE_SPINLOCK(ub_lock); /* Locks globals and ->openc */
418
419/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 * The id allocator.
421 *
422 * This also stores the host for indexing by minor, which is somewhat dirty.
423 */
424static int ub_id_get(void)
425{
426 unsigned long flags;
427 int i;
428
429 spin_lock_irqsave(&ub_lock, flags);
430 for (i = 0; i < UB_MAX_HOSTS; i++) {
431 if (ub_hostv[i] == 0) {
432 ub_hostv[i] = 1;
433 spin_unlock_irqrestore(&ub_lock, flags);
434 return i;
435 }
436 }
437 spin_unlock_irqrestore(&ub_lock, flags);
438 return -1;
439}
440
441static void ub_id_put(int id)
442{
443 unsigned long flags;
444
445 if (id < 0 || id >= UB_MAX_HOSTS) {
446 printk(KERN_ERR DRV_NAME ": bad host ID %d\n", id);
447 return;
448 }
449
450 spin_lock_irqsave(&ub_lock, flags);
451 if (ub_hostv[id] == 0) {
452 spin_unlock_irqrestore(&ub_lock, flags);
453 printk(KERN_ERR DRV_NAME ": freeing free host ID %d\n", id);
454 return;
455 }
456 ub_hostv[id] = 0;
457 spin_unlock_irqrestore(&ub_lock, flags);
458}
459
460/*
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800461 * This is necessitated by the fact that blk_cleanup_queue does not
462 * necesserily destroy the queue. Instead, it may merely decrease q->refcnt.
463 * Since our blk_init_queue() passes a spinlock common with ub_dev,
464 * we have life time issues when ub_cleanup frees ub_dev.
465 */
466static spinlock_t *ub_next_lock(void)
467{
468 unsigned long flags;
469 spinlock_t *ret;
470
471 spin_lock_irqsave(&ub_lock, flags);
472 ret = &ub_qlockv[ub_qlock_next];
473 ub_qlock_next = (ub_qlock_next + 1) % UB_QLOCK_NUM;
474 spin_unlock_irqrestore(&ub_lock, flags);
475 return ret;
476}
477
478/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 * Downcount for deallocation. This rides on two assumptions:
480 * - once something is poisoned, its refcount cannot grow
481 * - opens cannot happen at this time (del_gendisk was done)
482 * If the above is true, we can drop the lock, which we need for
483 * blk_cleanup_queue(): the silly thing may attempt to sleep.
484 * [Actually, it never needs to sleep for us, but it calls might_sleep()]
485 */
486static void ub_put(struct ub_dev *sc)
487{
488 unsigned long flags;
489
490 spin_lock_irqsave(&ub_lock, flags);
491 --sc->openc;
492 if (sc->openc == 0 && atomic_read(&sc->poison)) {
493 spin_unlock_irqrestore(&ub_lock, flags);
494 ub_cleanup(sc);
495 } else {
496 spin_unlock_irqrestore(&ub_lock, flags);
497 }
498}
499
500/*
501 * Final cleanup and deallocation.
502 */
503static void ub_cleanup(struct ub_dev *sc)
504{
Pete Zaitcevf4800072005-05-01 16:05:40 -0700505 struct list_head *p;
506 struct ub_lun *lun;
Jens Axboe165125e2007-07-24 09:28:11 +0200507 struct request_queue *q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Pete Zaitcevf4800072005-05-01 16:05:40 -0700509 while (!list_empty(&sc->luns)) {
510 p = sc->luns.next;
511 lun = list_entry(p, struct ub_lun, link);
512 list_del(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Pete Zaitcevf4800072005-05-01 16:05:40 -0700514 /* I don't think queue can be NULL. But... Stolen from sx8.c */
515 if ((q = lun->disk->queue) != NULL)
516 blk_cleanup_queue(q);
517 /*
518 * If we zero disk->private_data BEFORE put_disk, we have
519 * to check for NULL all over the place in open, release,
520 * check_media and revalidate, because the block level
521 * semaphore is well inside the put_disk.
522 * But we cannot zero after the call, because *disk is gone.
523 * The sd.c is blatantly racy in this area.
524 */
525 /* disk->private_data = NULL; */
526 put_disk(lun->disk);
527 lun->disk = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Pete Zaitcevf4800072005-05-01 16:05:40 -0700529 ub_id_put(lun->id);
530 kfree(lun);
531 }
532
Pete Zaitcev77ef6c42006-05-03 00:16:00 -0700533 usb_set_intfdata(sc->intf, NULL);
534 usb_put_intf(sc->intf);
535 usb_put_dev(sc->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 kfree(sc);
537}
538
539/*
540 * The "command allocator".
541 */
Pete Zaitcevf4800072005-05-01 16:05:40 -0700542static struct ub_scsi_cmd *ub_get_cmd(struct ub_lun *lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
544 struct ub_scsi_cmd *ret;
545
Pete Zaitcevf4800072005-05-01 16:05:40 -0700546 if (lun->cmda[0])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 return NULL;
Pete Zaitcevf4800072005-05-01 16:05:40 -0700548 ret = &lun->cmdv[0];
549 lun->cmda[0] = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 return ret;
551}
552
Pete Zaitcevf4800072005-05-01 16:05:40 -0700553static void ub_put_cmd(struct ub_lun *lun, struct ub_scsi_cmd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554{
Pete Zaitcevf4800072005-05-01 16:05:40 -0700555 if (cmd != &lun->cmdv[0]) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 printk(KERN_WARNING "%s: releasing a foreign cmd %p\n",
Pete Zaitcevf4800072005-05-01 16:05:40 -0700557 lun->name, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 return;
559 }
Pete Zaitcevf4800072005-05-01 16:05:40 -0700560 if (!lun->cmda[0]) {
561 printk(KERN_WARNING "%s: releasing a free cmd\n", lun->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 return;
563 }
Pete Zaitcevf4800072005-05-01 16:05:40 -0700564 lun->cmda[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566
567/*
568 * The command queue.
569 */
570static void ub_cmdq_add(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
571{
572 struct ub_scsi_cmd_queue *t = &sc->cmd_queue;
573
574 if (t->qlen++ == 0) {
575 t->head = cmd;
576 t->tail = cmd;
577 } else {
578 t->tail->next = cmd;
579 t->tail = cmd;
580 }
581
582 if (t->qlen > t->qmax)
583 t->qmax = t->qlen;
584}
585
586static void ub_cmdq_insert(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
587{
588 struct ub_scsi_cmd_queue *t = &sc->cmd_queue;
589
590 if (t->qlen++ == 0) {
591 t->head = cmd;
592 t->tail = cmd;
593 } else {
594 cmd->next = t->head;
595 t->head = cmd;
596 }
597
598 if (t->qlen > t->qmax)
599 t->qmax = t->qlen;
600}
601
602static struct ub_scsi_cmd *ub_cmdq_pop(struct ub_dev *sc)
603{
604 struct ub_scsi_cmd_queue *t = &sc->cmd_queue;
605 struct ub_scsi_cmd *cmd;
606
607 if (t->qlen == 0)
608 return NULL;
609 if (--t->qlen == 0)
610 t->tail = NULL;
611 cmd = t->head;
612 t->head = cmd->next;
613 cmd->next = NULL;
614 return cmd;
615}
616
617#define ub_cmdq_peek(sc) ((sc)->cmd_queue.head)
618
619/*
620 * The request function is our main entry point
621 */
622
Jens Axboe165125e2007-07-24 09:28:11 +0200623static void ub_request_fn(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624{
Pete Zaitcevf4800072005-05-01 16:05:40 -0700625 struct ub_lun *lun = q->queuedata;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 struct request *rq;
627
628 while ((rq = elv_next_request(q)) != NULL) {
Pete Zaitcev6c1eb8c2005-07-30 22:51:52 -0700629 if (ub_request_fn_1(lun, rq) != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 blk_stop_queue(q);
631 break;
632 }
633 }
634}
635
Pete Zaitcev6c1eb8c2005-07-30 22:51:52 -0700636static int ub_request_fn_1(struct ub_lun *lun, struct request *rq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
Pete Zaitcevf4800072005-05-01 16:05:40 -0700638 struct ub_dev *sc = lun->udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 struct ub_scsi_cmd *cmd;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800640 struct ub_request *urq;
641 int n_elem;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700643 if (atomic_read(&sc->poison)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 blkdev_dequeue_request(rq);
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700645 ub_end_rq(rq, DID_NO_CONNECT << 16);
646 return 0;
647 }
648
649 if (lun->changed && !blk_pc_request(rq)) {
650 blkdev_dequeue_request(rq);
651 ub_end_rq(rq, SAM_STAT_CHECK_CONDITION);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return 0;
653 }
654
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800655 if (lun->urq.rq != NULL)
656 return -1;
Pete Zaitcevf4800072005-05-01 16:05:40 -0700657 if ((cmd = ub_get_cmd(lun)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 return -1;
659 memset(cmd, 0, sizeof(struct ub_scsi_cmd));
Jens Axboe45711f12007-10-22 21:19:53 +0200660 sg_init_table(cmd->sgv, UB_MAX_REQ_SG);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661
662 blkdev_dequeue_request(rq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800664 urq = &lun->urq;
665 memset(urq, 0, sizeof(struct ub_request));
666 urq->rq = rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 /*
669 * get scatterlist from block layer
670 */
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800671 n_elem = blk_rq_map_sg(lun->disk->queue, rq, &urq->sgv[0]);
672 if (n_elem < 0) {
Pete Zaitcevb5600332006-05-25 20:08:50 -0700673 /* Impossible, because blk_rq_map_sg should not hit ENOMEM. */
Pete Zaitcevba6abf12005-07-30 22:38:30 -0700674 printk(KERN_INFO "%s: failed request map (%d)\n",
Pete Zaitcevb5600332006-05-25 20:08:50 -0700675 lun->name, n_elem);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800676 goto drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 }
Pete Zaitcevba6abf12005-07-30 22:38:30 -0700678 if (n_elem > UB_MAX_REQ_SG) { /* Paranoia */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 printk(KERN_WARNING "%s: request with %d segments\n",
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800680 lun->name, n_elem);
681 goto drop;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 }
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800683 urq->nsg = n_elem;
Pete Zaitcev64bd8452005-09-22 00:48:29 -0700684 sc->sg_stat[n_elem < 5 ? n_elem : 5]++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800686 if (blk_pc_request(rq)) {
687 ub_cmd_build_packet(sc, lun, cmd, urq);
688 } else {
689 ub_cmd_build_block(sc, lun, cmd, urq);
690 }
691 cmd->state = UB_CMDST_INIT;
692 cmd->lun = lun;
693 cmd->done = ub_rw_cmd_done;
694 cmd->back = urq;
695
696 cmd->tag = sc->tagcnt++;
697 if (ub_submit_scsi(sc, cmd) != 0)
698 goto drop;
699
700 return 0;
701
702drop:
703 ub_put_cmd(lun, cmd);
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700704 ub_end_rq(rq, DID_ERROR << 16);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800705 return 0;
706}
707
708static void ub_cmd_build_block(struct ub_dev *sc, struct ub_lun *lun,
709 struct ub_scsi_cmd *cmd, struct ub_request *urq)
710{
711 struct request *rq = urq->rq;
712 unsigned int block, nblks;
713
714 if (rq_data_dir(rq) == WRITE)
715 cmd->dir = UB_DIR_WRITE;
716 else
717 cmd->dir = UB_DIR_READ;
718
719 cmd->nsg = urq->nsg;
720 memcpy(cmd->sgv, urq->sgv, sizeof(struct scatterlist) * cmd->nsg);
721
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 /*
723 * build the command
724 *
725 * The call to blk_queue_hardsect_size() guarantees that request
726 * is aligned, but it is given in terms of 512 byte units, always.
727 */
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700728 block = rq->sector >> lun->capacity.bshift;
729 nblks = rq->nr_sectors >> lun->capacity.bshift;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800731 cmd->cdb[0] = (cmd->dir == UB_DIR_READ)? READ_10: WRITE_10;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 /* 10-byte uses 4 bytes of LBA: 2147483648KB, 2097152MB, 2048GB */
733 cmd->cdb[2] = block >> 24;
734 cmd->cdb[3] = block >> 16;
735 cmd->cdb[4] = block >> 8;
736 cmd->cdb[5] = block;
737 cmd->cdb[7] = nblks >> 8;
738 cmd->cdb[8] = nblks;
739 cmd->cdb_len = 10;
740
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700741 cmd->len = rq->nr_sectors * 512;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742}
743
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800744static void ub_cmd_build_packet(struct ub_dev *sc, struct ub_lun *lun,
745 struct ub_scsi_cmd *cmd, struct ub_request *urq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746{
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800747 struct request *rq = urq->rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 if (rq->data_len == 0) {
750 cmd->dir = UB_DIR_NONE;
751 } else {
752 if (rq_data_dir(rq) == WRITE)
753 cmd->dir = UB_DIR_WRITE;
754 else
755 cmd->dir = UB_DIR_READ;
756 }
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700757
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800758 cmd->nsg = urq->nsg;
759 memcpy(cmd->sgv, urq->sgv, sizeof(struct scatterlist) * cmd->nsg);
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700760
761 memcpy(&cmd->cdb, rq->cmd, rq->cmd_len);
762 cmd->cdb_len = rq->cmd_len;
763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 cmd->len = rq->data_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765}
766
767static void ub_rw_cmd_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
768{
Pete Zaitcevf4800072005-05-01 16:05:40 -0700769 struct ub_lun *lun = cmd->lun;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800770 struct ub_request *urq = cmd->back;
771 struct request *rq;
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700772 unsigned int scsi_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800774 rq = urq->rq;
775
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700776 if (cmd->error == 0) {
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700777 if (blk_pc_request(rq)) {
778 if (cmd->act_len >= rq->data_len)
779 rq->data_len = 0;
780 else
781 rq->data_len -= cmd->act_len;
Pete Zaitcevba6abf12005-07-30 22:38:30 -0700782 }
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700783 scsi_status = 0;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700784 } else {
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700785 if (blk_pc_request(rq)) {
786 /* UB_SENSE_SIZE is smaller than SCSI_SENSE_BUFFERSIZE */
787 memcpy(rq->sense, sc->top_sense, UB_SENSE_SIZE);
788 rq->sense_len = UB_SENSE_SIZE;
789 if (sc->top_sense[0] != 0)
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700790 scsi_status = SAM_STAT_CHECK_CONDITION;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700791 else
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700792 scsi_status = DID_ERROR << 16;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800793 } else {
794 if (cmd->error == -EIO) {
795 if (ub_rw_cmd_retry(sc, lun, urq, cmd) == 0)
796 return;
797 }
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700798 scsi_status = SAM_STAT_CHECK_CONDITION;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -0700799 }
800 }
Pete Zaitcevba6abf12005-07-30 22:38:30 -0700801
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800802 urq->rq = NULL;
803
Pete Zaitcevf4800072005-05-01 16:05:40 -0700804 ub_put_cmd(lun, cmd);
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700805 ub_end_rq(rq, scsi_status);
Pete Zaitcevba6abf12005-07-30 22:38:30 -0700806 blk_start_queue(lun->disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807}
808
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700809static void ub_end_rq(struct request *rq, unsigned int scsi_status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
Kiyoshi Ueda7d699ba2007-12-11 17:46:47 -0500811 int error;
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700812
813 if (scsi_status == 0) {
Kiyoshi Ueda7d699ba2007-12-11 17:46:47 -0500814 error = 0;
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700815 } else {
Kiyoshi Ueda7d699ba2007-12-11 17:46:47 -0500816 error = -EIO;
Pete Zaitcevd1ad4ea2006-09-07 16:54:22 -0700817 rq->errors = scsi_status;
818 }
Kiyoshi Ueda7d699ba2007-12-11 17:46:47 -0500819 if (__blk_end_request(rq, error, blk_rq_bytes(rq)))
820 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821}
822
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800823static int ub_rw_cmd_retry(struct ub_dev *sc, struct ub_lun *lun,
824 struct ub_request *urq, struct ub_scsi_cmd *cmd)
825{
826
827 if (atomic_read(&sc->poison))
828 return -ENXIO;
829
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -0800830 ub_reset_enter(sc, urq->current_try);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800831
832 if (urq->current_try >= 3)
833 return -EIO;
834 urq->current_try++;
Pete Zaitcevb5600332006-05-25 20:08:50 -0700835
836 /* Remove this if anyone complains of flooding. */
837 printk(KERN_DEBUG "%s: dir %c len/act %d/%d "
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800838 "[sense %x %02x %02x] retry %d\n",
839 sc->name, UB_DIR_CHAR(cmd->dir), cmd->len, cmd->act_len,
840 cmd->key, cmd->asc, cmd->ascq, urq->current_try);
841
842 memset(cmd, 0, sizeof(struct ub_scsi_cmd));
843 ub_cmd_build_block(sc, lun, cmd, urq);
844
845 cmd->state = UB_CMDST_INIT;
846 cmd->lun = lun;
847 cmd->done = ub_rw_cmd_done;
848 cmd->back = urq;
849
850 cmd->tag = sc->tagcnt++;
851
852#if 0 /* Wasteful */
853 return ub_submit_scsi(sc, cmd);
854#else
855 ub_cmdq_add(sc, cmd);
856 return 0;
857#endif
858}
859
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860/*
861 * Submit a regular SCSI operation (not an auto-sense).
862 *
863 * The Iron Law of Good Submit Routine is:
864 * Zero return - callback is done, Nonzero return - callback is not done.
865 * No exceptions.
866 *
867 * Host is assumed locked.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 */
869static int ub_submit_scsi(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
870{
871
872 if (cmd->state != UB_CMDST_INIT ||
873 (cmd->dir != UB_DIR_NONE && cmd->len == 0)) {
874 return -EINVAL;
875 }
876
877 ub_cmdq_add(sc, cmd);
878 /*
879 * We can call ub_scsi_dispatch(sc) right away here, but it's a little
880 * safer to jump to a tasklet, in case upper layers do something silly.
881 */
882 tasklet_schedule(&sc->tasklet);
883 return 0;
884}
885
886/*
887 * Submit the first URB for the queued command.
888 * This function does not deal with queueing in any way.
889 */
890static int ub_scsi_cmd_start(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
891{
892 struct bulk_cb_wrap *bcb;
893 int rc;
894
895 bcb = &sc->work_bcb;
896
897 /*
898 * ``If the allocation length is eighteen or greater, and a device
899 * server returns less than eithteen bytes of data, the application
900 * client should assume that the bytes not transferred would have been
901 * zeroes had the device server returned those bytes.''
902 *
903 * We zero sense for all commands so that when a packet request
904 * fails it does not return a stale sense.
905 */
906 memset(&sc->top_sense, 0, UB_SENSE_SIZE);
907
908 /* set up the command wrapper */
909 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
910 bcb->Tag = cmd->tag; /* Endianness is not important */
911 bcb->DataTransferLength = cpu_to_le32(cmd->len);
912 bcb->Flags = (cmd->dir == UB_DIR_READ) ? 0x80 : 0;
Pete Zaitcevf4800072005-05-01 16:05:40 -0700913 bcb->Lun = (cmd->lun != NULL) ? cmd->lun->num : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 bcb->Length = cmd->cdb_len;
915
916 /* copy the command payload */
917 memcpy(bcb->CDB, cmd->cdb, UB_MAX_CDB_SIZE);
918
919 UB_INIT_COMPLETION(sc->work_done);
920
921 sc->last_pipe = sc->send_bulk_pipe;
922 usb_fill_bulk_urb(&sc->work_urb, sc->dev, sc->send_bulk_pipe,
923 bcb, US_BULK_CB_WRAP_LEN, ub_urb_complete, sc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
926 /* XXX Clear stalls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 ub_complete(&sc->work_done);
928 return rc;
929 }
930
931 sc->work_timer.expires = jiffies + UB_URB_TIMEOUT;
932 add_timer(&sc->work_timer);
933
934 cmd->state = UB_CMDST_CMD;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 return 0;
936}
937
938/*
939 * Timeout handler.
940 */
941static void ub_urb_timeout(unsigned long arg)
942{
943 struct ub_dev *sc = (struct ub_dev *) arg;
944 unsigned long flags;
945
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800946 spin_lock_irqsave(sc->lock, flags);
Pete Zaitcevb31f8212006-01-05 00:14:02 -0800947 if (!ub_is_completed(&sc->work_done))
948 usb_unlink_urb(&sc->work_urb);
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800949 spin_unlock_irqrestore(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950}
951
952/*
953 * Completion routine for the work URB.
954 *
955 * This can be called directly from usb_submit_urb (while we have
956 * the sc->lock taken) and from an interrupt (while we do NOT have
957 * the sc->lock taken). Therefore, bounce this off to a tasklet.
958 */
David Howells7d12e782006-10-05 14:55:46 +0100959static void ub_urb_complete(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960{
961 struct ub_dev *sc = urb->context;
962
963 ub_complete(&sc->work_done);
964 tasklet_schedule(&sc->tasklet);
965}
966
967static void ub_scsi_action(unsigned long _dev)
968{
969 struct ub_dev *sc = (struct ub_dev *) _dev;
970 unsigned long flags;
971
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800972 spin_lock_irqsave(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 ub_scsi_dispatch(sc);
Pete Zaitcev65b4fe52005-12-28 14:22:17 -0800974 spin_unlock_irqrestore(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975}
976
977static void ub_scsi_dispatch(struct ub_dev *sc)
978{
979 struct ub_scsi_cmd *cmd;
980 int rc;
981
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -0800982 while (!sc->reset && (cmd = ub_cmdq_peek(sc)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 if (cmd->state == UB_CMDST_DONE) {
984 ub_cmdq_pop(sc);
985 (*cmd->done)(sc, cmd);
986 } else if (cmd->state == UB_CMDST_INIT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 if ((rc = ub_scsi_cmd_start(sc, cmd)) == 0)
988 break;
989 cmd->error = rc;
990 cmd->state = UB_CMDST_DONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 } else {
992 if (!ub_is_completed(&sc->work_done))
993 break;
Pete Zaitcevb31f8212006-01-05 00:14:02 -0800994 del_timer(&sc->work_timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 ub_scsi_urb_compl(sc, cmd);
996 }
997 }
998}
999
1000static void ub_scsi_urb_compl(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
1001{
1002 struct urb *urb = &sc->work_urb;
1003 struct bulk_cs_wrap *bcs;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001004 int len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 int rc;
1006
1007 if (atomic_read(&sc->poison)) {
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001008 ub_state_done(sc, cmd, -ENODEV);
1009 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 }
1011
1012 if (cmd->state == UB_CMDST_CLEAR) {
1013 if (urb->status == -EPIPE) {
1014 /*
1015 * STALL while clearning STALL.
1016 * The control pipe clears itself - nothing to do.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001018 printk(KERN_NOTICE "%s: stall on control pipe\n",
1019 sc->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 goto Bad_End;
1021 }
1022
1023 /*
1024 * We ignore the result for the halt clear.
1025 */
1026
1027 /* reset the endpoint toggle */
1028 usb_settoggle(sc->dev, usb_pipeendpoint(sc->last_pipe),
1029 usb_pipeout(sc->last_pipe), 0);
1030
1031 ub_state_sense(sc, cmd);
1032
1033 } else if (cmd->state == UB_CMDST_CLR2STS) {
1034 if (urb->status == -EPIPE) {
Pete Zaitcevf4800072005-05-01 16:05:40 -07001035 printk(KERN_NOTICE "%s: stall on control pipe\n",
1036 sc->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 goto Bad_End;
1038 }
1039
1040 /*
1041 * We ignore the result for the halt clear.
1042 */
1043
1044 /* reset the endpoint toggle */
1045 usb_settoggle(sc->dev, usb_pipeendpoint(sc->last_pipe),
1046 usb_pipeout(sc->last_pipe), 0);
1047
1048 ub_state_stat(sc, cmd);
1049
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001050 } else if (cmd->state == UB_CMDST_CLRRS) {
1051 if (urb->status == -EPIPE) {
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001052 printk(KERN_NOTICE "%s: stall on control pipe\n",
1053 sc->name);
1054 goto Bad_End;
1055 }
1056
1057 /*
1058 * We ignore the result for the halt clear.
1059 */
1060
1061 /* reset the endpoint toggle */
1062 usb_settoggle(sc->dev, usb_pipeendpoint(sc->last_pipe),
1063 usb_pipeout(sc->last_pipe), 0);
1064
1065 ub_state_stat_counted(sc, cmd);
1066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 } else if (cmd->state == UB_CMDST_CMD) {
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001068 switch (urb->status) {
1069 case 0:
1070 break;
1071 case -EOVERFLOW:
1072 goto Bad_End;
1073 case -EPIPE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 rc = ub_submit_clear_stall(sc, cmd, sc->last_pipe);
1075 if (rc != 0) {
1076 printk(KERN_NOTICE "%s: "
Pete Zaitcevf4800072005-05-01 16:05:40 -07001077 "unable to submit clear (%d)\n",
1078 sc->name, rc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 /*
1080 * This is typically ENOMEM or some other such shit.
1081 * Retrying is pointless. Just do Bad End on it...
1082 */
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001083 ub_state_done(sc, cmd, rc);
1084 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 }
1086 cmd->state = UB_CMDST_CLEAR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 return;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001088 case -ESHUTDOWN: /* unplug */
1089 case -EILSEQ: /* unplug timeout on uhci */
1090 ub_state_done(sc, cmd, -ENODEV);
1091 return;
1092 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 goto Bad_End;
1094 }
1095 if (urb->actual_length != US_BULK_CB_WRAP_LEN) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 goto Bad_End;
1097 }
1098
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001099 if (cmd->dir == UB_DIR_NONE || cmd->nsg < 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 ub_state_stat(sc, cmd);
1101 return;
1102 }
1103
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001104 // udelay(125); // usb-storage has this
1105 ub_data_start(sc, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106
1107 } else if (cmd->state == UB_CMDST_DATA) {
1108 if (urb->status == -EPIPE) {
1109 rc = ub_submit_clear_stall(sc, cmd, sc->last_pipe);
1110 if (rc != 0) {
1111 printk(KERN_NOTICE "%s: "
Pete Zaitcevf4800072005-05-01 16:05:40 -07001112 "unable to submit clear (%d)\n",
1113 sc->name, rc);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001114 ub_state_done(sc, cmd, rc);
1115 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 }
1117 cmd->state = UB_CMDST_CLR2STS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118 return;
1119 }
1120 if (urb->status == -EOVERFLOW) {
1121 /*
1122 * A babble? Failure, but we must transfer CSW now.
1123 */
1124 cmd->error = -EOVERFLOW; /* A cheap trick... */
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001125 ub_state_stat(sc, cmd);
1126 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 }
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001128
1129 if (cmd->dir == UB_DIR_WRITE) {
1130 /*
1131 * Do not continue writes in case of a failure.
1132 * Doing so would cause sectors to be mixed up,
1133 * which is worse than sectors lost.
1134 *
1135 * We must try to read the CSW, or many devices
1136 * get confused.
1137 */
1138 len = urb->actual_length;
1139 if (urb->status != 0 ||
1140 len != cmd->sgv[cmd->current_sg].length) {
1141 cmd->act_len += len;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001142
1143 cmd->error = -EIO;
1144 ub_state_stat(sc, cmd);
1145 return;
1146 }
1147
1148 } else {
1149 /*
1150 * If an error occurs on read, we record it, and
1151 * continue to fetch data in order to avoid bubble.
1152 *
1153 * As a small shortcut, we stop if we detect that
1154 * a CSW mixed into data.
1155 */
1156 if (urb->status != 0)
1157 cmd->error = -EIO;
1158
1159 len = urb->actual_length;
1160 if (urb->status != 0 ||
1161 len != cmd->sgv[cmd->current_sg].length) {
1162 if ((len & 0x1FF) == US_BULK_CS_WRAP_LEN)
1163 goto Bad_End;
1164 }
1165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001167 cmd->act_len += urb->actual_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001169 if (++cmd->current_sg < cmd->nsg) {
1170 ub_data_start(sc, cmd);
1171 return;
1172 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 ub_state_stat(sc, cmd);
1174
1175 } else if (cmd->state == UB_CMDST_STAT) {
1176 if (urb->status == -EPIPE) {
1177 rc = ub_submit_clear_stall(sc, cmd, sc->last_pipe);
1178 if (rc != 0) {
1179 printk(KERN_NOTICE "%s: "
Pete Zaitcevf4800072005-05-01 16:05:40 -07001180 "unable to submit clear (%d)\n",
1181 sc->name, rc);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001182 ub_state_done(sc, cmd, rc);
1183 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 }
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001185
1186 /*
1187 * Having a stall when getting CSW is an error, so
1188 * make sure uppper levels are not oblivious to it.
1189 */
1190 cmd->error = -EIO; /* A cheap trick... */
1191
1192 cmd->state = UB_CMDST_CLRRS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 return;
1194 }
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001195
1196 /* Catch everything, including -EOVERFLOW and other nasties. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 if (urb->status != 0)
1198 goto Bad_End;
1199
1200 if (urb->actual_length == 0) {
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001201 ub_state_stat_counted(sc, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 return;
1203 }
1204
1205 /*
1206 * Check the returned Bulk protocol status.
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001207 * The status block has to be validated first.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 */
1209
1210 bcs = &sc->work_bcs;
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001211
1212 if (sc->signature == cpu_to_le32(0)) {
1213 /*
1214 * This is the first reply, so do not perform the check.
1215 * Instead, remember the signature the device uses
1216 * for future checks. But do not allow a nul.
1217 */
1218 sc->signature = bcs->Signature;
1219 if (sc->signature == cpu_to_le32(0)) {
1220 ub_state_stat_counted(sc, cmd);
1221 return;
1222 }
1223 } else {
1224 if (bcs->Signature != sc->signature) {
1225 ub_state_stat_counted(sc, cmd);
1226 return;
1227 }
1228 }
1229
1230 if (bcs->Tag != cmd->tag) {
1231 /*
1232 * This usually happens when we disagree with the
1233 * device's microcode about something. For instance,
1234 * a few of them throw this after timeouts. They buffer
1235 * commands and reply at commands we timed out before.
1236 * Without flushing these replies we loop forever.
1237 */
1238 ub_state_stat_counted(sc, cmd);
1239 return;
1240 }
1241
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001242 len = le32_to_cpu(bcs->Residue);
1243 if (len != cmd->len - cmd->act_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 /*
1245 * It is all right to transfer less, the caller has
1246 * to check. But it's not all right if the device
1247 * counts disagree with our counts.
1248 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 goto Bad_End;
1250 }
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 switch (bcs->Status) {
1253 case US_BULK_STAT_OK:
1254 break;
1255 case US_BULK_STAT_FAIL:
1256 ub_state_sense(sc, cmd);
1257 return;
1258 case US_BULK_STAT_PHASE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 goto Bad_End;
1260 default:
1261 printk(KERN_INFO "%s: unknown CSW status 0x%x\n",
1262 sc->name, bcs->Status);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001263 ub_state_done(sc, cmd, -EINVAL);
1264 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 }
1266
1267 /* Not zeroing error to preserve a babble indicator */
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001268 if (cmd->error != 0) {
1269 ub_state_sense(sc, cmd);
1270 return;
1271 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 cmd->state = UB_CMDST_DONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 ub_cmdq_pop(sc);
1274 (*cmd->done)(sc, cmd);
1275
1276 } else if (cmd->state == UB_CMDST_SENSE) {
1277 ub_state_done(sc, cmd, -EIO);
1278
1279 } else {
1280 printk(KERN_WARNING "%s: "
Pete Zaitcevf4800072005-05-01 16:05:40 -07001281 "wrong command state %d\n",
1282 sc->name, cmd->state);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001283 ub_state_done(sc, cmd, -EINVAL);
1284 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 }
1286 return;
1287
1288Bad_End: /* Little Excel is dead */
1289 ub_state_done(sc, cmd, -EIO);
1290}
1291
1292/*
1293 * Factorization helper for the command state machine:
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001294 * Initiate a data segment transfer.
1295 */
1296static void ub_data_start(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
1297{
1298 struct scatterlist *sg = &cmd->sgv[cmd->current_sg];
1299 int pipe;
1300 int rc;
1301
1302 UB_INIT_COMPLETION(sc->work_done);
1303
1304 if (cmd->dir == UB_DIR_READ)
1305 pipe = sc->recv_bulk_pipe;
1306 else
1307 pipe = sc->send_bulk_pipe;
1308 sc->last_pipe = pipe;
Jens Axboe45711f12007-10-22 21:19:53 +02001309 usb_fill_bulk_urb(&sc->work_urb, sc->dev, pipe, sg_virt(sg),
1310 sg->length, ub_urb_complete, sc);
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001311
1312 if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
1313 /* XXX Clear stalls */
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001314 ub_complete(&sc->work_done);
1315 ub_state_done(sc, cmd, rc);
1316 return;
1317 }
1318
1319 sc->work_timer.expires = jiffies + UB_DATA_TIMEOUT;
1320 add_timer(&sc->work_timer);
1321
1322 cmd->state = UB_CMDST_DATA;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001323}
1324
1325/*
1326 * Factorization helper for the command state machine:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 * Finish the command.
1328 */
1329static void ub_state_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd, int rc)
1330{
1331
1332 cmd->error = rc;
1333 cmd->state = UB_CMDST_DONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 ub_cmdq_pop(sc);
1335 (*cmd->done)(sc, cmd);
1336}
1337
1338/*
1339 * Factorization helper for the command state machine:
1340 * Submit a CSW read.
1341 */
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001342static int __ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343{
1344 int rc;
1345
1346 UB_INIT_COMPLETION(sc->work_done);
1347
1348 sc->last_pipe = sc->recv_bulk_pipe;
1349 usb_fill_bulk_urb(&sc->work_urb, sc->dev, sc->recv_bulk_pipe,
1350 &sc->work_bcs, US_BULK_CS_WRAP_LEN, ub_urb_complete, sc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
1352 if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
1353 /* XXX Clear stalls */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 ub_complete(&sc->work_done);
1355 ub_state_done(sc, cmd, rc);
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001356 return -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 }
1358
1359 sc->work_timer.expires = jiffies + UB_STAT_TIMEOUT;
1360 add_timer(&sc->work_timer);
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001361 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362}
1363
1364/*
1365 * Factorization helper for the command state machine:
1366 * Submit a CSW read and go to STAT state.
1367 */
1368static void ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
1369{
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001370
1371 if (__ub_state_stat(sc, cmd) != 0)
1372 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
1374 cmd->stat_count = 0;
1375 cmd->state = UB_CMDST_STAT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376}
1377
1378/*
1379 * Factorization helper for the command state machine:
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001380 * Submit a CSW read and go to STAT state with counter (along [C] path).
1381 */
1382static void ub_state_stat_counted(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
1383{
1384
1385 if (++cmd->stat_count >= 4) {
1386 ub_state_sense(sc, cmd);
1387 return;
1388 }
1389
1390 if (__ub_state_stat(sc, cmd) != 0)
1391 return;
1392
1393 cmd->state = UB_CMDST_STAT;
Pete Zaitcev1872bce2005-07-27 11:43:51 -07001394}
1395
1396/*
1397 * Factorization helper for the command state machine:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 * Submit a REQUEST SENSE and go to SENSE state.
1399 */
1400static void ub_state_sense(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
1401{
1402 struct ub_scsi_cmd *scmd;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001403 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 int rc;
1405
1406 if (cmd->cdb[0] == REQUEST_SENSE) {
1407 rc = -EPIPE;
1408 goto error;
1409 }
1410
1411 scmd = &sc->top_rqs_cmd;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001412 memset(scmd, 0, sizeof(struct ub_scsi_cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 scmd->cdb[0] = REQUEST_SENSE;
1414 scmd->cdb[4] = UB_SENSE_SIZE;
1415 scmd->cdb_len = 6;
1416 scmd->dir = UB_DIR_READ;
1417 scmd->state = UB_CMDST_INIT;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001418 scmd->nsg = 1;
1419 sg = &scmd->sgv[0];
FUJITA Tomonori4f33a9d2007-10-25 09:17:03 +02001420 sg_init_table(sg, UB_MAX_REQ_SG);
Jens Axboe642f1492007-10-24 11:20:47 +02001421 sg_set_page(sg, virt_to_page(sc->top_sense), UB_SENSE_SIZE,
1422 (unsigned long)sc->top_sense & (PAGE_SIZE-1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 scmd->len = UB_SENSE_SIZE;
Pete Zaitcevf4800072005-05-01 16:05:40 -07001424 scmd->lun = cmd->lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 scmd->done = ub_top_sense_done;
1426 scmd->back = cmd;
1427
1428 scmd->tag = sc->tagcnt++;
1429
1430 cmd->state = UB_CMDST_SENSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
1432 ub_cmdq_insert(sc, scmd);
1433 return;
1434
1435error:
1436 ub_state_done(sc, cmd, rc);
1437}
1438
1439/*
1440 * A helper for the command's state machine:
1441 * Submit a stall clear.
1442 */
1443static int ub_submit_clear_stall(struct ub_dev *sc, struct ub_scsi_cmd *cmd,
1444 int stalled_pipe)
1445{
1446 int endp;
1447 struct usb_ctrlrequest *cr;
1448 int rc;
1449
1450 endp = usb_pipeendpoint(stalled_pipe);
1451 if (usb_pipein (stalled_pipe))
1452 endp |= USB_DIR_IN;
1453
1454 cr = &sc->work_cr;
1455 cr->bRequestType = USB_RECIP_ENDPOINT;
1456 cr->bRequest = USB_REQ_CLEAR_FEATURE;
1457 cr->wValue = cpu_to_le16(USB_ENDPOINT_HALT);
1458 cr->wIndex = cpu_to_le16(endp);
1459 cr->wLength = cpu_to_le16(0);
1460
1461 UB_INIT_COMPLETION(sc->work_done);
1462
1463 usb_fill_control_urb(&sc->work_urb, sc->dev, sc->send_ctrl_pipe,
1464 (unsigned char*) cr, NULL, 0, ub_urb_complete, sc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
1466 if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
1467 ub_complete(&sc->work_done);
1468 return rc;
1469 }
1470
1471 sc->work_timer.expires = jiffies + UB_CTRL_TIMEOUT;
1472 add_timer(&sc->work_timer);
1473 return 0;
1474}
1475
1476/*
1477 */
1478static void ub_top_sense_done(struct ub_dev *sc, struct ub_scsi_cmd *scmd)
1479{
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001480 unsigned char *sense = sc->top_sense;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 struct ub_scsi_cmd *cmd;
1482
1483 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 * Find the command which triggered the unit attention or a check,
1485 * save the sense into it, and advance its state machine.
1486 */
1487 if ((cmd = ub_cmdq_peek(sc)) == NULL) {
1488 printk(KERN_WARNING "%s: sense done while idle\n", sc->name);
1489 return;
1490 }
1491 if (cmd != scmd->back) {
1492 printk(KERN_WARNING "%s: "
Pete Zaitcevf4800072005-05-01 16:05:40 -07001493 "sense done for wrong command 0x%x\n",
1494 sc->name, cmd->tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 return;
1496 }
1497 if (cmd->state != UB_CMDST_SENSE) {
1498 printk(KERN_WARNING "%s: "
Pete Zaitcevf4800072005-05-01 16:05:40 -07001499 "sense done with bad cmd state %d\n",
1500 sc->name, cmd->state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 return;
1502 }
1503
Pete Zaitcev952ba222006-03-02 16:42:59 -08001504 /*
1505 * Ignoring scmd->act_len, because the buffer was pre-zeroed.
1506 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 cmd->key = sense[2] & 0x0F;
1508 cmd->asc = sense[12];
1509 cmd->ascq = sense[13];
1510
1511 ub_scsi_urb_compl(sc, cmd);
1512}
1513
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514/*
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001515 * Reset management
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -08001516 * XXX Move usb_reset_device to khubd. Hogging kevent is not a good thing.
1517 * XXX Make usb_sync_reset asynchronous.
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001518 */
1519
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -08001520static void ub_reset_enter(struct ub_dev *sc, int try)
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001521{
1522
1523 if (sc->reset) {
1524 /* This happens often on multi-LUN devices. */
1525 return;
1526 }
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -08001527 sc->reset = try + 1;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001528
1529#if 0 /* Not needed because the disconnect waits for us. */
1530 unsigned long flags;
1531 spin_lock_irqsave(&ub_lock, flags);
1532 sc->openc++;
1533 spin_unlock_irqrestore(&ub_lock, flags);
1534#endif
1535
1536#if 0 /* We let them stop themselves. */
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001537 struct ub_lun *lun;
Matthias Kaehlckea69228d2007-07-09 12:03:07 -07001538 list_for_each_entry(lun, &sc->luns, link) {
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001539 blk_stop_queue(lun->disk->queue);
1540 }
1541#endif
1542
1543 schedule_work(&sc->reset_work);
1544}
1545
David Howellsc4028952006-11-22 14:57:56 +00001546static void ub_reset_task(struct work_struct *work)
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001547{
David Howellsc4028952006-11-22 14:57:56 +00001548 struct ub_dev *sc = container_of(work, struct ub_dev, reset_work);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001549 unsigned long flags;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001550 struct ub_lun *lun;
1551 int lkr, rc;
1552
1553 if (!sc->reset) {
1554 printk(KERN_WARNING "%s: Running reset unrequested\n",
1555 sc->name);
1556 return;
1557 }
1558
1559 if (atomic_read(&sc->poison)) {
Pete Zaitcevb5600332006-05-25 20:08:50 -07001560 ;
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -08001561 } else if ((sc->reset & 1) == 0) {
1562 ub_sync_reset(sc);
1563 msleep(700); /* usb-storage sleeps 6s (!) */
1564 ub_probe_clear_stall(sc, sc->recv_bulk_pipe);
1565 ub_probe_clear_stall(sc, sc->send_bulk_pipe);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001566 } else if (sc->dev->actconfig->desc.bNumInterfaces != 1) {
Pete Zaitcevb5600332006-05-25 20:08:50 -07001567 ;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001568 } else {
1569 if ((lkr = usb_lock_device_for_reset(sc->dev, sc->intf)) < 0) {
1570 printk(KERN_NOTICE
1571 "%s: usb_lock_device_for_reset failed (%d)\n",
1572 sc->name, lkr);
1573 } else {
1574 rc = usb_reset_device(sc->dev);
1575 if (rc < 0) {
1576 printk(KERN_NOTICE "%s: "
1577 "usb_lock_device_for_reset failed (%d)\n",
1578 sc->name, rc);
1579 }
1580
1581 if (lkr)
1582 usb_unlock_device(sc->dev);
1583 }
1584 }
1585
1586 /*
1587 * In theory, no commands can be running while reset is active,
1588 * so nobody can ask for another reset, and so we do not need any
1589 * queues of resets or anything. We do need a spinlock though,
1590 * to interact with block layer.
1591 */
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08001592 spin_lock_irqsave(sc->lock, flags);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001593 sc->reset = 0;
1594 tasklet_schedule(&sc->tasklet);
Matthias Kaehlckea69228d2007-07-09 12:03:07 -07001595 list_for_each_entry(lun, &sc->luns, link) {
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001596 blk_start_queue(lun->disk->queue);
1597 }
1598 wake_up(&sc->reset_wait);
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08001599 spin_unlock_irqrestore(sc->lock, flags);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08001600}
1601
1602/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001603 * This is called from a process context.
1604 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001605static void ub_revalidate(struct ub_dev *sc, struct ub_lun *lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606{
1607
Pete Zaitcevf4800072005-05-01 16:05:40 -07001608 lun->readonly = 0; /* XXX Query this from the device */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
Pete Zaitcevf4800072005-05-01 16:05:40 -07001610 lun->capacity.nsec = 0;
1611 lun->capacity.bsize = 512;
1612 lun->capacity.bshift = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Pete Zaitcevf4800072005-05-01 16:05:40 -07001614 if (ub_sync_tur(sc, lun) != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 return; /* Not ready */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001616 lun->changed = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617
Pete Zaitcevf4800072005-05-01 16:05:40 -07001618 if (ub_sync_read_cap(sc, lun, &lun->capacity) != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 /*
1620 * The retry here means something is wrong, either with the
1621 * device, with the transport, or with our code.
1622 * We keep this because sd.c has retries for capacity.
1623 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001624 if (ub_sync_read_cap(sc, lun, &lun->capacity) != 0) {
1625 lun->capacity.nsec = 0;
1626 lun->capacity.bsize = 512;
1627 lun->capacity.bshift = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 }
1629 }
1630}
1631
1632/*
1633 * The open funcion.
1634 * This is mostly needed to keep refcounting, but also to support
1635 * media checks on removable media drives.
1636 */
1637static int ub_bd_open(struct inode *inode, struct file *filp)
1638{
1639 struct gendisk *disk = inode->i_bdev->bd_disk;
Pete Zaitcev41fea55e2006-04-28 20:45:49 -07001640 struct ub_lun *lun = disk->private_data;
1641 struct ub_dev *sc = lun->udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 unsigned long flags;
1643 int rc;
1644
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 spin_lock_irqsave(&ub_lock, flags);
1646 if (atomic_read(&sc->poison)) {
1647 spin_unlock_irqrestore(&ub_lock, flags);
1648 return -ENXIO;
1649 }
1650 sc->openc++;
1651 spin_unlock_irqrestore(&ub_lock, flags);
1652
Pete Zaitcevf4800072005-05-01 16:05:40 -07001653 if (lun->removable || lun->readonly)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 check_disk_change(inode->i_bdev);
1655
1656 /*
1657 * The sd.c considers ->media_present and ->changed not equivalent,
1658 * under some pretty murky conditions (a failure of READ CAPACITY).
1659 * We may need it one day.
1660 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001661 if (lun->removable && lun->changed && !(filp->f_flags & O_NDELAY)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 rc = -ENOMEDIUM;
1663 goto err_open;
1664 }
1665
Pete Zaitcevf4800072005-05-01 16:05:40 -07001666 if (lun->readonly && (filp->f_mode & FMODE_WRITE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667 rc = -EROFS;
1668 goto err_open;
1669 }
1670
1671 return 0;
1672
1673err_open:
1674 ub_put(sc);
1675 return rc;
1676}
1677
1678/*
1679 */
1680static int ub_bd_release(struct inode *inode, struct file *filp)
1681{
1682 struct gendisk *disk = inode->i_bdev->bd_disk;
Pete Zaitcevf4800072005-05-01 16:05:40 -07001683 struct ub_lun *lun = disk->private_data;
1684 struct ub_dev *sc = lun->udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685
1686 ub_put(sc);
1687 return 0;
1688}
1689
1690/*
1691 * The ioctl interface.
1692 */
1693static int ub_bd_ioctl(struct inode *inode, struct file *filp,
1694 unsigned int cmd, unsigned long arg)
1695{
1696 struct gendisk *disk = inode->i_bdev->bd_disk;
1697 void __user *usermem = (void __user *) arg;
1698
FUJITA Tomonori45e79a32007-07-09 12:39:20 +02001699 return scsi_cmd_ioctl(filp, disk->queue, disk, cmd, usermem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700}
1701
1702/*
1703 * This is called once a new disk was seen by the block layer or by ub_probe().
1704 * The main onjective here is to discover the features of the media such as
1705 * the capacity, read-only status, etc. USB storage generally does not
1706 * need to be spun up, but if we needed it, this would be the place.
1707 *
1708 * This call can sleep.
1709 *
1710 * The return code is not used.
1711 */
1712static int ub_bd_revalidate(struct gendisk *disk)
1713{
Pete Zaitcevf4800072005-05-01 16:05:40 -07001714 struct ub_lun *lun = disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715
Pete Zaitcevf4800072005-05-01 16:05:40 -07001716 ub_revalidate(lun->udev, lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
1718 /* XXX Support sector size switching like in sr.c */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001719 blk_queue_hardsect_size(disk->queue, lun->capacity.bsize);
1720 set_capacity(disk, lun->capacity.nsec);
1721 // set_disk_ro(sdkp->disk, lun->readonly);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
1723 return 0;
1724}
1725
1726/*
1727 * The check is called by the block layer to verify if the media
1728 * is still available. It is supposed to be harmless, lightweight and
1729 * non-intrusive in case the media was not changed.
1730 *
1731 * This call can sleep.
1732 *
1733 * The return code is bool!
1734 */
1735static int ub_bd_media_changed(struct gendisk *disk)
1736{
Pete Zaitcevf4800072005-05-01 16:05:40 -07001737 struct ub_lun *lun = disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738
Pete Zaitcevf4800072005-05-01 16:05:40 -07001739 if (!lun->removable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 return 0;
1741
1742 /*
1743 * We clean checks always after every command, so this is not
1744 * as dangerous as it looks. If the TEST_UNIT_READY fails here,
1745 * the device is actually not ready with operator or software
1746 * intervention required. One dangerous item might be a drive which
1747 * spins itself down, and come the time to write dirty pages, this
1748 * will fail, then block layer discards the data. Since we never
1749 * spin drives up, such devices simply cannot be used with ub anyway.
1750 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001751 if (ub_sync_tur(lun->udev, lun) != 0) {
1752 lun->changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 return 1;
1754 }
1755
Pete Zaitcevf4800072005-05-01 16:05:40 -07001756 return lun->changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757}
1758
1759static struct block_device_operations ub_bd_fops = {
1760 .owner = THIS_MODULE,
1761 .open = ub_bd_open,
1762 .release = ub_bd_release,
1763 .ioctl = ub_bd_ioctl,
1764 .media_changed = ub_bd_media_changed,
1765 .revalidate_disk = ub_bd_revalidate,
1766};
1767
1768/*
1769 * Common ->done routine for commands executed synchronously.
1770 */
1771static void ub_probe_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
1772{
1773 struct completion *cop = cmd->back;
1774 complete(cop);
1775}
1776
1777/*
1778 * Test if the device has a check condition on it, synchronously.
1779 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001780static int ub_sync_tur(struct ub_dev *sc, struct ub_lun *lun)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781{
1782 struct ub_scsi_cmd *cmd;
1783 enum { ALLOC_SIZE = sizeof(struct ub_scsi_cmd) };
1784 unsigned long flags;
1785 struct completion compl;
1786 int rc;
1787
1788 init_completion(&compl);
1789
1790 rc = -ENOMEM;
Pete Zaitcev29da7932006-02-13 20:35:57 -08001791 if ((cmd = kzalloc(ALLOC_SIZE, GFP_KERNEL)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 goto err_alloc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
1794 cmd->cdb[0] = TEST_UNIT_READY;
1795 cmd->cdb_len = 6;
1796 cmd->dir = UB_DIR_NONE;
1797 cmd->state = UB_CMDST_INIT;
Pete Zaitcevf4800072005-05-01 16:05:40 -07001798 cmd->lun = lun; /* This may be NULL, but that's ok */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 cmd->done = ub_probe_done;
1800 cmd->back = &compl;
1801
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08001802 spin_lock_irqsave(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 cmd->tag = sc->tagcnt++;
1804
1805 rc = ub_submit_scsi(sc, cmd);
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08001806 spin_unlock_irqrestore(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807
Pete Zaitcevb5600332006-05-25 20:08:50 -07001808 if (rc != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 goto err_submit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
1811 wait_for_completion(&compl);
1812
1813 rc = cmd->error;
1814
1815 if (rc == -EIO && cmd->key != 0) /* Retries for benh's key */
1816 rc = cmd->key;
1817
1818err_submit:
1819 kfree(cmd);
1820err_alloc:
1821 return rc;
1822}
1823
1824/*
1825 * Read the SCSI capacity synchronously (for probing).
1826 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07001827static int ub_sync_read_cap(struct ub_dev *sc, struct ub_lun *lun,
1828 struct ub_capacity *ret)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829{
1830 struct ub_scsi_cmd *cmd;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001831 struct scatterlist *sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 char *p;
1833 enum { ALLOC_SIZE = sizeof(struct ub_scsi_cmd) + 8 };
1834 unsigned long flags;
1835 unsigned int bsize, shift;
1836 unsigned long nsec;
1837 struct completion compl;
1838 int rc;
1839
1840 init_completion(&compl);
1841
1842 rc = -ENOMEM;
Pete Zaitcev29da7932006-02-13 20:35:57 -08001843 if ((cmd = kzalloc(ALLOC_SIZE, GFP_KERNEL)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 goto err_alloc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845 p = (char *)cmd + sizeof(struct ub_scsi_cmd);
1846
1847 cmd->cdb[0] = 0x25;
1848 cmd->cdb_len = 10;
1849 cmd->dir = UB_DIR_READ;
1850 cmd->state = UB_CMDST_INIT;
Pete Zaitceva1cf96e2005-08-14 21:16:03 -07001851 cmd->nsg = 1;
1852 sg = &cmd->sgv[0];
FUJITA Tomonori4f33a9d2007-10-25 09:17:03 +02001853 sg_init_table(sg, UB_MAX_REQ_SG);
Jens Axboe642f1492007-10-24 11:20:47 +02001854 sg_set_page(sg, virt_to_page(p), 8, (unsigned long)p & (PAGE_SIZE-1));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 cmd->len = 8;
Pete Zaitcevf4800072005-05-01 16:05:40 -07001856 cmd->lun = lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 cmd->done = ub_probe_done;
1858 cmd->back = &compl;
1859
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08001860 spin_lock_irqsave(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 cmd->tag = sc->tagcnt++;
1862
1863 rc = ub_submit_scsi(sc, cmd);
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08001864 spin_unlock_irqrestore(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
Pete Zaitcevb5600332006-05-25 20:08:50 -07001866 if (rc != 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 goto err_submit;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
1869 wait_for_completion(&compl);
1870
1871 if (cmd->error != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 rc = -EIO;
1873 goto err_read;
1874 }
1875 if (cmd->act_len != 8) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 rc = -EIO;
1877 goto err_read;
1878 }
1879
1880 /* sd.c special-cases sector size of 0 to mean 512. Needed? Safe? */
1881 nsec = be32_to_cpu(*(__be32 *)p) + 1;
1882 bsize = be32_to_cpu(*(__be32 *)(p + 4));
1883 switch (bsize) {
1884 case 512: shift = 0; break;
1885 case 1024: shift = 1; break;
1886 case 2048: shift = 2; break;
1887 case 4096: shift = 3; break;
1888 default:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 rc = -EDOM;
1890 goto err_inv_bsize;
1891 }
1892
1893 ret->bsize = bsize;
1894 ret->bshift = shift;
1895 ret->nsec = nsec << shift;
1896 rc = 0;
1897
1898err_inv_bsize:
1899err_read:
1900err_submit:
1901 kfree(cmd);
1902err_alloc:
1903 return rc;
1904}
1905
1906/*
1907 */
David Howells7d12e782006-10-05 14:55:46 +01001908static void ub_probe_urb_complete(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909{
1910 struct completion *cop = urb->context;
1911 complete(cop);
1912}
1913
1914static void ub_probe_timeout(unsigned long arg)
1915{
1916 struct completion *cop = (struct completion *) arg;
1917 complete(cop);
1918}
1919
1920/*
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -08001921 * Reset with a Bulk reset.
1922 */
1923static int ub_sync_reset(struct ub_dev *sc)
1924{
1925 int ifnum = sc->intf->cur_altsetting->desc.bInterfaceNumber;
1926 struct usb_ctrlrequest *cr;
1927 struct completion compl;
1928 struct timer_list timer;
1929 int rc;
1930
1931 init_completion(&compl);
1932
1933 cr = &sc->work_cr;
1934 cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE;
1935 cr->bRequest = US_BULK_RESET_REQUEST;
1936 cr->wValue = cpu_to_le16(0);
1937 cr->wIndex = cpu_to_le16(ifnum);
1938 cr->wLength = cpu_to_le16(0);
1939
1940 usb_fill_control_urb(&sc->work_urb, sc->dev, sc->send_ctrl_pipe,
1941 (unsigned char*) cr, NULL, 0, ub_probe_urb_complete, &compl);
Pete Zaitcev2c2e4a22006-01-05 00:26:30 -08001942
1943 if ((rc = usb_submit_urb(&sc->work_urb, GFP_KERNEL)) != 0) {
1944 printk(KERN_WARNING
1945 "%s: Unable to submit a bulk reset (%d)\n", sc->name, rc);
1946 return rc;
1947 }
1948
1949 init_timer(&timer);
1950 timer.function = ub_probe_timeout;
1951 timer.data = (unsigned long) &compl;
1952 timer.expires = jiffies + UB_CTRL_TIMEOUT;
1953 add_timer(&timer);
1954
1955 wait_for_completion(&compl);
1956
1957 del_timer_sync(&timer);
1958 usb_kill_urb(&sc->work_urb);
1959
1960 return sc->work_urb.status;
1961}
1962
1963/*
Pete Zaitcevf4800072005-05-01 16:05:40 -07001964 * Get number of LUNs by the way of Bulk GetMaxLUN command.
1965 */
1966static int ub_sync_getmaxlun(struct ub_dev *sc)
1967{
1968 int ifnum = sc->intf->cur_altsetting->desc.bInterfaceNumber;
1969 unsigned char *p;
1970 enum { ALLOC_SIZE = 1 };
1971 struct usb_ctrlrequest *cr;
1972 struct completion compl;
1973 struct timer_list timer;
1974 int nluns;
1975 int rc;
1976
1977 init_completion(&compl);
1978
1979 rc = -ENOMEM;
1980 if ((p = kmalloc(ALLOC_SIZE, GFP_KERNEL)) == NULL)
1981 goto err_alloc;
1982 *p = 55;
1983
1984 cr = &sc->work_cr;
1985 cr->bRequestType = USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
1986 cr->bRequest = US_BULK_GET_MAX_LUN;
1987 cr->wValue = cpu_to_le16(0);
1988 cr->wIndex = cpu_to_le16(ifnum);
1989 cr->wLength = cpu_to_le16(1);
1990
1991 usb_fill_control_urb(&sc->work_urb, sc->dev, sc->recv_ctrl_pipe,
1992 (unsigned char*) cr, p, 1, ub_probe_urb_complete, &compl);
Pete Zaitcevf4800072005-05-01 16:05:40 -07001993
Pete Zaitcevb5600332006-05-25 20:08:50 -07001994 if ((rc = usb_submit_urb(&sc->work_urb, GFP_KERNEL)) != 0)
Pete Zaitcevf4800072005-05-01 16:05:40 -07001995 goto err_submit;
Pete Zaitcevf4800072005-05-01 16:05:40 -07001996
1997 init_timer(&timer);
1998 timer.function = ub_probe_timeout;
1999 timer.data = (unsigned long) &compl;
2000 timer.expires = jiffies + UB_CTRL_TIMEOUT;
2001 add_timer(&timer);
2002
2003 wait_for_completion(&compl);
2004
2005 del_timer_sync(&timer);
2006 usb_kill_urb(&sc->work_urb);
2007
Pete Zaitcevb5600332006-05-25 20:08:50 -07002008 if ((rc = sc->work_urb.status) < 0)
Pete Zaitcev64bd8452005-09-22 00:48:29 -07002009 goto err_io;
Pete Zaitcev64bd8452005-09-22 00:48:29 -07002010
Pete Zaitcevf4800072005-05-01 16:05:40 -07002011 if (sc->work_urb.actual_length != 1) {
Pete Zaitcevf4800072005-05-01 16:05:40 -07002012 nluns = 0;
2013 } else {
2014 if ((nluns = *p) == 55) {
2015 nluns = 0;
2016 } else {
2017 /* GetMaxLUN returns the maximum LUN number */
2018 nluns += 1;
2019 if (nluns > UB_MAX_LUNS)
2020 nluns = UB_MAX_LUNS;
2021 }
Pete Zaitcevf4800072005-05-01 16:05:40 -07002022 }
2023
2024 kfree(p);
2025 return nluns;
2026
Pete Zaitcev64bd8452005-09-22 00:48:29 -07002027err_io:
Pete Zaitcevf4800072005-05-01 16:05:40 -07002028err_submit:
2029 kfree(p);
2030err_alloc:
2031 return rc;
2032}
2033
2034/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 * Clear initial stalls.
2036 */
2037static int ub_probe_clear_stall(struct ub_dev *sc, int stalled_pipe)
2038{
2039 int endp;
2040 struct usb_ctrlrequest *cr;
2041 struct completion compl;
2042 struct timer_list timer;
2043 int rc;
2044
2045 init_completion(&compl);
2046
2047 endp = usb_pipeendpoint(stalled_pipe);
2048 if (usb_pipein (stalled_pipe))
2049 endp |= USB_DIR_IN;
2050
2051 cr = &sc->work_cr;
2052 cr->bRequestType = USB_RECIP_ENDPOINT;
2053 cr->bRequest = USB_REQ_CLEAR_FEATURE;
2054 cr->wValue = cpu_to_le16(USB_ENDPOINT_HALT);
2055 cr->wIndex = cpu_to_le16(endp);
2056 cr->wLength = cpu_to_le16(0);
2057
2058 usb_fill_control_urb(&sc->work_urb, sc->dev, sc->send_ctrl_pipe,
2059 (unsigned char*) cr, NULL, 0, ub_probe_urb_complete, &compl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060
2061 if ((rc = usb_submit_urb(&sc->work_urb, GFP_KERNEL)) != 0) {
2062 printk(KERN_WARNING
2063 "%s: Unable to submit a probe clear (%d)\n", sc->name, rc);
2064 return rc;
2065 }
2066
2067 init_timer(&timer);
2068 timer.function = ub_probe_timeout;
2069 timer.data = (unsigned long) &compl;
2070 timer.expires = jiffies + UB_CTRL_TIMEOUT;
2071 add_timer(&timer);
2072
2073 wait_for_completion(&compl);
2074
2075 del_timer_sync(&timer);
2076 usb_kill_urb(&sc->work_urb);
2077
2078 /* reset the endpoint toggle */
2079 usb_settoggle(sc->dev, endp, usb_pipeout(sc->last_pipe), 0);
2080
2081 return 0;
2082}
2083
2084/*
2085 * Get the pipe settings.
2086 */
2087static int ub_get_pipes(struct ub_dev *sc, struct usb_device *dev,
2088 struct usb_interface *intf)
2089{
2090 struct usb_host_interface *altsetting = intf->cur_altsetting;
2091 struct usb_endpoint_descriptor *ep_in = NULL;
2092 struct usb_endpoint_descriptor *ep_out = NULL;
2093 struct usb_endpoint_descriptor *ep;
2094 int i;
2095
2096 /*
2097 * Find the endpoints we need.
2098 * We are expecting a minimum of 2 endpoints - in and out (bulk).
2099 * We will ignore any others.
2100 */
2101 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
2102 ep = &altsetting->endpoint[i].desc;
2103
2104 /* Is it a BULK endpoint? */
2105 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
2106 == USB_ENDPOINT_XFER_BULK) {
2107 /* BULK in or out? */
Pete Zaitcev643616e2007-03-08 19:56:23 -08002108 if (ep->bEndpointAddress & USB_DIR_IN) {
2109 if (ep_in == NULL)
2110 ep_in = ep;
2111 } else {
2112 if (ep_out == NULL)
2113 ep_out = ep;
2114 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 }
2116 }
2117
2118 if (ep_in == NULL || ep_out == NULL) {
Pete Zaitcevf4800072005-05-01 16:05:40 -07002119 printk(KERN_NOTICE "%s: failed endpoint check\n",
2120 sc->name);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08002121 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 }
2123
2124 /* Calculate and store the pipe values */
2125 sc->send_ctrl_pipe = usb_sndctrlpipe(dev, 0);
2126 sc->recv_ctrl_pipe = usb_rcvctrlpipe(dev, 0);
2127 sc->send_bulk_pipe = usb_sndbulkpipe(dev,
2128 ep_out->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
2129 sc->recv_bulk_pipe = usb_rcvbulkpipe(dev,
2130 ep_in->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
2131
2132 return 0;
2133}
2134
2135/*
2136 * Probing is done in the process context, which allows us to cheat
2137 * and not to build a state machine for the discovery.
2138 */
2139static int ub_probe(struct usb_interface *intf,
2140 const struct usb_device_id *dev_id)
2141{
2142 struct ub_dev *sc;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002143 int nluns;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 int rc;
2145 int i;
2146
Pete Zaitceva00828e2005-10-22 20:15:09 -07002147 if (usb_usual_check_type(dev_id, USB_US_TYPE_UB))
2148 return -ENXIO;
2149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 rc = -ENOMEM;
Pete Zaitcev29da7932006-02-13 20:35:57 -08002151 if ((sc = kzalloc(sizeof(struct ub_dev), GFP_KERNEL)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 goto err_core;
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002153 sc->lock = ub_next_lock();
Pete Zaitcevf4800072005-05-01 16:05:40 -07002154 INIT_LIST_HEAD(&sc->luns);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155 usb_init_urb(&sc->work_urb);
2156 tasklet_init(&sc->tasklet, ub_scsi_action, (unsigned long)sc);
2157 atomic_set(&sc->poison, 0);
David Howellsc4028952006-11-22 14:57:56 +00002158 INIT_WORK(&sc->reset_work, ub_reset_task);
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08002159 init_waitqueue_head(&sc->reset_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160
2161 init_timer(&sc->work_timer);
2162 sc->work_timer.data = (unsigned long) sc;
2163 sc->work_timer.function = ub_urb_timeout;
2164
2165 ub_init_completion(&sc->work_done);
2166 sc->work_done.done = 1; /* A little yuk, but oh well... */
2167
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 sc->dev = interface_to_usbdev(intf);
2169 sc->intf = intf;
2170 // sc->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 usb_set_intfdata(intf, sc);
2172 usb_get_dev(sc->dev);
Pete Zaitcev77ef6c42006-05-03 00:16:00 -07002173 /*
2174 * Since we give the interface struct to the block level through
2175 * disk->driverfs_dev, we have to pin it. Otherwise, block_uevent
2176 * oopses on close after a disconnect (kernels 2.6.16 and up).
2177 */
2178 usb_get_intf(sc->intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
Pete Zaitcevf4800072005-05-01 16:05:40 -07002180 snprintf(sc->name, 12, DRV_NAME "(%d.%d)",
2181 sc->dev->bus->busnum, sc->dev->devnum);
2182
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 /* XXX Verify that we can handle the device (from descriptors) */
2184
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08002185 if (ub_get_pipes(sc, sc->dev, intf) != 0)
2186 goto err_dev_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 /*
2189 * At this point, all USB initialization is done, do upper layer.
2190 * We really hate halfway initialized structures, so from the
2191 * invariants perspective, this ub_dev is fully constructed at
2192 * this point.
2193 */
2194
2195 /*
2196 * This is needed to clear toggles. It is a problem only if we do
2197 * `rmmod ub && modprobe ub` without disconnects, but we like that.
2198 */
Pete Zaitcevc6c88832005-09-22 00:49:45 -07002199#if 0 /* iPod Mini fails if we do this (big white iPod works) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 ub_probe_clear_stall(sc, sc->recv_bulk_pipe);
2201 ub_probe_clear_stall(sc, sc->send_bulk_pipe);
Pete Zaitcevc6c88832005-09-22 00:49:45 -07002202#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
2204 /*
2205 * The way this is used by the startup code is a little specific.
2206 * A SCSI check causes a USB stall. Our common case code sees it
2207 * and clears the check, after which the device is ready for use.
2208 * But if a check was not present, any command other than
2209 * TEST_UNIT_READY ends with a lockup (including REQUEST_SENSE).
2210 *
2211 * If we neglect to clear the SCSI check, the first real command fails
2212 * (which is the capacity readout). We clear that and retry, but why
2213 * causing spurious retries for no reason.
2214 *
2215 * Revalidation may start with its own TEST_UNIT_READY, but that one
2216 * has to succeed, so we clear checks with an additional one here.
2217 * In any case it's not our business how revaliadation is implemented.
2218 */
Pete Zaitcevb5600332006-05-25 20:08:50 -07002219 for (i = 0; i < 3; i++) { /* Retries for the schwag key from KS'04 */
Pete Zaitcevf4800072005-05-01 16:05:40 -07002220 if ((rc = ub_sync_tur(sc, NULL)) <= 0) break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 if (rc != 0x6) break;
2222 msleep(10);
2223 }
2224
Pete Zaitcevf4800072005-05-01 16:05:40 -07002225 nluns = 1;
2226 for (i = 0; i < 3; i++) {
Pete Zaitcev11a223a2006-03-02 16:53:00 -08002227 if ((rc = ub_sync_getmaxlun(sc)) < 0)
Pete Zaitcevf4800072005-05-01 16:05:40 -07002228 break;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002229 if (rc != 0) {
2230 nluns = rc;
2231 break;
2232 }
Pete Zaitcev9f793d22005-06-06 13:54:59 -07002233 msleep(100);
Pete Zaitcevf4800072005-05-01 16:05:40 -07002234 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
Pete Zaitcevf4800072005-05-01 16:05:40 -07002236 for (i = 0; i < nluns; i++) {
2237 ub_probe_lun(sc, i);
2238 }
2239 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08002241err_dev_desc:
Pete Zaitcevf4800072005-05-01 16:05:40 -07002242 usb_set_intfdata(intf, NULL);
Pete Zaitcev77ef6c42006-05-03 00:16:00 -07002243 usb_put_intf(sc->intf);
Pete Zaitcevf4800072005-05-01 16:05:40 -07002244 usb_put_dev(sc->dev);
2245 kfree(sc);
2246err_core:
2247 return rc;
2248}
2249
2250static int ub_probe_lun(struct ub_dev *sc, int lnum)
2251{
2252 struct ub_lun *lun;
Jens Axboe165125e2007-07-24 09:28:11 +02002253 struct request_queue *q;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002254 struct gendisk *disk;
2255 int rc;
2256
2257 rc = -ENOMEM;
Pete Zaitcev29da7932006-02-13 20:35:57 -08002258 if ((lun = kzalloc(sizeof(struct ub_lun), GFP_KERNEL)) == NULL)
Pete Zaitcevf4800072005-05-01 16:05:40 -07002259 goto err_alloc;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002260 lun->num = lnum;
2261
2262 rc = -ENOSR;
2263 if ((lun->id = ub_id_get()) == -1)
2264 goto err_id;
2265
2266 lun->udev = sc;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002267
2268 snprintf(lun->name, 16, DRV_NAME "%c(%d.%d.%d)",
2269 lun->id + 'a', sc->dev->bus->busnum, sc->dev->devnum, lun->num);
2270
2271 lun->removable = 1; /* XXX Query this from the device */
2272 lun->changed = 1; /* ub_revalidate clears only */
Pete Zaitcevf4800072005-05-01 16:05:40 -07002273 ub_revalidate(sc, lun);
2274
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 rc = -ENOMEM;
Pete Zaitcev4fb729f2005-12-17 02:34:12 -08002276 if ((disk = alloc_disk(UB_PARTS_PER_LUN)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 goto err_diskalloc;
2278
Pete Zaitcevf4800072005-05-01 16:05:40 -07002279 sprintf(disk->disk_name, DRV_NAME "%c", lun->id + 'a');
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 disk->major = UB_MAJOR;
Pete Zaitcev4fb729f2005-12-17 02:34:12 -08002281 disk->first_minor = lun->id * UB_PARTS_PER_LUN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002282 disk->fops = &ub_bd_fops;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002283 disk->private_data = lun;
Pete Zaitcev64bd8452005-09-22 00:48:29 -07002284 disk->driverfs_dev = &sc->intf->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
2286 rc = -ENOMEM;
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002287 if ((q = blk_init_queue(ub_request_fn, sc->lock)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 goto err_blkqinit;
2289
2290 disk->queue = q;
2291
Pete Zaitcevf4800072005-05-01 16:05:40 -07002292 blk_queue_bounce_limit(q, BLK_BOUNCE_HIGH);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 blk_queue_max_hw_segments(q, UB_MAX_REQ_SG);
2294 blk_queue_max_phys_segments(q, UB_MAX_REQ_SG);
Pete Zaitcevf4800072005-05-01 16:05:40 -07002295 blk_queue_segment_boundary(q, 0xffffffff); /* Dubious. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 blk_queue_max_sectors(q, UB_MAX_SECTORS);
Pete Zaitcevf4800072005-05-01 16:05:40 -07002297 blk_queue_hardsect_size(q, lun->capacity.bsize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298
Pete Zaitcev688e9fb2006-05-25 20:04:54 -07002299 lun->disk = disk;
Pete Zaitcevf4800072005-05-01 16:05:40 -07002300 q->queuedata = lun;
Pete Zaitcev688e9fb2006-05-25 20:04:54 -07002301 list_add(&lun->link, &sc->luns);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
Pete Zaitcevf4800072005-05-01 16:05:40 -07002303 set_capacity(disk, lun->capacity.nsec);
2304 if (lun->removable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 disk->flags |= GENHD_FL_REMOVABLE;
2306
2307 add_disk(disk);
2308
2309 return 0;
2310
2311err_blkqinit:
2312 put_disk(disk);
2313err_diskalloc:
Pete Zaitcevf4800072005-05-01 16:05:40 -07002314 ub_id_put(lun->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315err_id:
Pete Zaitcevf4800072005-05-01 16:05:40 -07002316 kfree(lun);
2317err_alloc:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002318 return rc;
2319}
2320
2321static void ub_disconnect(struct usb_interface *intf)
2322{
2323 struct ub_dev *sc = usb_get_intfdata(intf);
Pete Zaitcevf4800072005-05-01 16:05:40 -07002324 struct ub_lun *lun;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325 unsigned long flags;
2326
2327 /*
2328 * Prevent ub_bd_release from pulling the rug from under us.
2329 * XXX This is starting to look like a kref.
2330 * XXX Why not to take this ref at probe time?
2331 */
2332 spin_lock_irqsave(&ub_lock, flags);
2333 sc->openc++;
2334 spin_unlock_irqrestore(&ub_lock, flags);
2335
2336 /*
2337 * Fence stall clearnings, operations triggered by unlinkings and so on.
2338 * We do not attempt to unlink any URBs, because we do not trust the
2339 * unlink paths in HC drivers. Also, we get -84 upon disconnect anyway.
2340 */
2341 atomic_set(&sc->poison, 1);
2342
2343 /*
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08002344 * Wait for reset to end, if any.
2345 */
2346 wait_event(sc->reset_wait, !sc->reset);
2347
2348 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349 * Blow away queued commands.
2350 *
2351 * Actually, this never works, because before we get here
2352 * the HCD terminates outstanding URB(s). It causes our
2353 * SCSI command queue to advance, commands fail to submit,
2354 * and the whole queue drains. So, we just use this code to
2355 * print warnings.
2356 */
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002357 spin_lock_irqsave(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002358 {
2359 struct ub_scsi_cmd *cmd;
2360 int cnt = 0;
Pete Zaitcev2c26c9e2005-12-17 02:16:43 -08002361 while ((cmd = ub_cmdq_peek(sc)) != NULL) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 cmd->error = -ENOTCONN;
2363 cmd->state = UB_CMDST_DONE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002364 ub_cmdq_pop(sc);
2365 (*cmd->done)(sc, cmd);
2366 cnt++;
2367 }
2368 if (cnt != 0) {
2369 printk(KERN_WARNING "%s: "
2370 "%d was queued after shutdown\n", sc->name, cnt);
2371 }
2372 }
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002373 spin_unlock_irqrestore(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
2375 /*
2376 * Unregister the upper layer.
2377 */
Matthias Kaehlckea69228d2007-07-09 12:03:07 -07002378 list_for_each_entry(lun, &sc->luns, link) {
Pete Zaitcev688e9fb2006-05-25 20:04:54 -07002379 del_gendisk(lun->disk);
Pete Zaitcevf4800072005-05-01 16:05:40 -07002380 /*
2381 * I wish I could do:
2382 * set_bit(QUEUE_FLAG_DEAD, &q->queue_flags);
2383 * As it is, we rely on our internal poisoning and let
2384 * the upper levels to spin furiously failing all the I/O.
2385 */
2386 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002387
2388 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002389 * Testing for -EINPROGRESS is always a bug, so we are bending
2390 * the rules a little.
2391 */
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002392 spin_lock_irqsave(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002393 if (sc->work_urb.status == -EINPROGRESS) { /* janitors: ignore */
2394 printk(KERN_WARNING "%s: "
2395 "URB is active after disconnect\n", sc->name);
2396 }
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002397 spin_unlock_irqrestore(sc->lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002398
2399 /*
2400 * There is virtually no chance that other CPU runs times so long
2401 * after ub_urb_complete should have called del_timer, but only if HCD
2402 * didn't forget to deliver a callback on unlink.
2403 */
2404 del_timer_sync(&sc->work_timer);
2405
2406 /*
2407 * At this point there must be no commands coming from anyone
2408 * and no URBs left in transit.
2409 */
2410
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 ub_put(sc);
2412}
2413
2414static struct usb_driver ub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002415 .name = "ub",
2416 .probe = ub_probe,
2417 .disconnect = ub_disconnect,
2418 .id_table = ub_usb_ids,
2419};
2420
2421static int __init ub_init(void)
2422{
2423 int rc;
Pete Zaitcev65b4fe52005-12-28 14:22:17 -08002424 int i;
2425
2426 for (i = 0; i < UB_QLOCK_NUM; i++)
2427 spin_lock_init(&ub_qlockv[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 if ((rc = register_blkdev(UB_MAJOR, DRV_NAME)) != 0)
2430 goto err_regblkdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431
2432 if ((rc = usb_register(&ub_driver)) != 0)
2433 goto err_register;
2434
Pete Zaitceva00828e2005-10-22 20:15:09 -07002435 usb_usual_set_present(USB_US_TYPE_UB);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002436 return 0;
2437
2438err_register:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 unregister_blkdev(UB_MAJOR, DRV_NAME);
2440err_regblkdev:
2441 return rc;
2442}
2443
2444static void __exit ub_exit(void)
2445{
2446 usb_deregister(&ub_driver);
2447
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 unregister_blkdev(UB_MAJOR, DRV_NAME);
Pete Zaitceva00828e2005-10-22 20:15:09 -07002449 usb_usual_clear_present(USB_US_TYPE_UB);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002450}
2451
2452module_init(ub_init);
2453module_exit(ub_exit);
2454
2455MODULE_LICENSE("GPL");