ub.c 62.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * The low performance USB storage driver (ub).
 *
 * Copyright (c) 1999, 2000 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
 * Copyright (C) 2004 Pete Zaitcev (zaitcev@yahoo.com)
 *
 * This work is a part of Linux kernel, is derived from it,
 * and is not licensed separately. See file COPYING for details.
 *
 * TODO (sorted by decreasing priority)
11
 *  -- Return sense now that rq allows it (we always auto-sense anyway).
L
Linus Torvalds 已提交
12 13 14
 *  -- set readonly flag for CDs, set removable flag for CF readers
 *  -- do inquiry and verify we got a disk and not a tape (for LUN mismatch)
 *  -- verify the 13 conditions and do bulk resets
15
 *  -- highmem
L
Linus Torvalds 已提交
16 17
 *  -- move top_sense and work_bcs into separate allocations (if they survive)
 *     for cache purists and esoteric architectures.
18
 *  -- Allocate structure for LUN 0 before the first ub_sync_tur, avoid NULL. ?
L
Linus Torvalds 已提交
19 20
 *  -- prune comments, they are too volumnous
 *  -- Resove XXX's
P
Pete Zaitcev 已提交
21
 *  -- CLEAR, CLR2STS, CLRRS seem to be ripe for refactoring.
L
Linus Torvalds 已提交
22 23 24 25
 */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/usb.h>
26
#include <linux/usb_usual.h>
L
Linus Torvalds 已提交
27 28
#include <linux/blkdev.h>
#include <linux/timer.h>
J
Jens Axboe 已提交
29
#include <linux/scatterlist.h>
L
Linus Torvalds 已提交
30 31 32 33 34 35
#include <scsi/scsi.h>

#define DRV_NAME "ub"

#define UB_MAJOR 180

P
Pete Zaitcev 已提交
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
/*
 * The command state machine is the key model for understanding of this driver.
 *
 * The general rule is that all transitions are done towards the bottom
 * of the diagram, thus preventing any loops.
 *
 * An exception to that is how the STAT state is handled. A counter allows it
 * to be re-entered along the path marked with [C].
 *
 *       +--------+
 *       ! INIT   !
 *       +--------+
 *           !
 *        ub_scsi_cmd_start fails ->--------------------------------------\
 *           !                                                            !
 *           V                                                            !
 *       +--------+                                                       !
 *       ! CMD    !                                                       !
 *       +--------+                                                       !
 *           !                                            +--------+      !
 *         was -EPIPE -->-------------------------------->! CLEAR  !      !
 *           !                                            +--------+      !
 *           !                                                !           !
 *         was error -->------------------------------------- ! --------->\
 *           !                                                !           !
 *  /--<-- cmd->dir == NONE ?                                 !           !
 *  !        !                                                !           !
 *  !        V                                                !           !
 *  !    +--------+                                           !           !
 *  !    ! DATA   !                                           !           !
 *  !    +--------+                                           !           !
 *  !        !                           +---------+          !           !
 *  !      was -EPIPE -->--------------->! CLR2STS !          !           !
 *  !        !                           +---------+          !           !
 *  !        !                                !               !           !
 *  !        !                              was error -->---- ! --------->\
 *  !      was error -->--------------------- ! ------------- ! --------->\
 *  !        !                                !               !           !
 *  !        V                                !               !           !
 *  \--->+--------+                           !               !           !
 *       ! STAT   !<--------------------------/               !           !
 *  /--->+--------+                                           !           !
 *  !        !                                                !           !
 * [C]     was -EPIPE -->-----------\                         !           !
 *  !        !                      !                         !           !
 *  +<---- len == 0                 !                         !           !
 *  !        !                      !                         !           !
 *  !      was error -->--------------------------------------!---------->\
 *  !        !                      !                         !           !
 *  +<---- bad CSW                  !                         !           !
 *  +<---- bad tag                  !                         !           !
 *  !        !                      V                         !           !
 *  !        !                 +--------+                     !           !
 *  !        !                 ! CLRRS  !                     !           !
 *  !        !                 +--------+                     !           !
 *  !        !                      !                         !           !
 *  \------- ! --------------------[C]--------\               !           !
 *           !                                !               !           !
 *         cmd->error---\                +--------+           !           !
 *           !          +--------------->! SENSE  !<----------/           !
 *         STAT_FAIL----/                +--------+                       !
 *           !                                !                           V
 *           !                                V                      +--------+
 *           \--------------------------------\--------------------->! DONE   !
 *                                                                   +--------+
 */

L
Linus Torvalds 已提交
103
/*
104 105
 * This many LUNs per USB device.
 * Every one of them takes a host, see UB_MAX_HOSTS.
L
Linus Torvalds 已提交
106
 */
P
Pete Zaitcev 已提交
107
#define UB_MAX_LUNS   9
108 109 110 111

/*
 */

P
Pete Zaitcev 已提交
112
#define UB_PARTS_PER_LUN      8
L
Linus Torvalds 已提交
113 114 115 116 117 118 119 120 121 122 123 124 125 126

#define UB_MAX_CDB_SIZE      16		/* Corresponds to Bulk */

#define UB_SENSE_SIZE  18

/*
 */

/* command block wrapper */
struct bulk_cb_wrap {
	__le32	Signature;		/* contains 'USBC' */
	u32	Tag;			/* unique per command id */
	__le32	DataTransferLength;	/* size of data */
	u8	Flags;			/* direction in bit 0 */
127
	u8	Lun;			/* LUN */
L
Linus Torvalds 已提交
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
	u8	Length;			/* of of the CDB */
	u8	CDB[UB_MAX_CDB_SIZE];	/* max command */
};

#define US_BULK_CB_WRAP_LEN	31
#define US_BULK_CB_SIGN		0x43425355	/*spells out USBC */
#define US_BULK_FLAG_IN		1
#define US_BULK_FLAG_OUT	0

/* command status wrapper */
struct bulk_cs_wrap {
	__le32	Signature;		/* should = 'USBS' */
	u32	Tag;			/* same as original command */
	__le32	Residue;		/* amount not transferred */
	u8	Status;			/* see below */
};

#define US_BULK_CS_WRAP_LEN	13
#define US_BULK_CS_SIGN		0x53425355	/* spells out 'USBS' */
#define US_BULK_STAT_OK		0
#define US_BULK_STAT_FAIL	1
#define US_BULK_STAT_PHASE	2

/* bulk-only class specific requests */
#define US_BULK_RESET_REQUEST	0xff
#define US_BULK_GET_MAX_LUN	0xfe

/*
 */
struct ub_dev;

P
Pete Zaitcev 已提交
159
#define UB_MAX_REQ_SG	9	/* cdrecord requires 32KB and maybe a header */
L
Linus Torvalds 已提交
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
#define UB_MAX_SECTORS 64

/*
 * A second is more than enough for a 32K transfer (UB_MAX_SECTORS)
 * even if a webcam hogs the bus, but some devices need time to spin up.
 */
#define UB_URB_TIMEOUT	(HZ*2)
#define UB_DATA_TIMEOUT	(HZ*5)	/* ZIP does spin-ups in the data phase */
#define UB_STAT_TIMEOUT	(HZ*5)	/* Same spinups and eject for a dataless cmd. */
#define UB_CTRL_TIMEOUT	(HZ/2)	/* 500ms ought to be enough to clear a stall */

/*
 * An instance of a SCSI command in transit.
 */
#define UB_DIR_NONE	0
#define UB_DIR_READ	1
#define UB_DIR_ILLEGAL2	2
#define UB_DIR_WRITE	3

#define UB_DIR_CHAR(c)  (((c)==UB_DIR_WRITE)? 'w': \
			 (((c)==UB_DIR_READ)? 'r': 'n'))

enum ub_scsi_cmd_state {
	UB_CMDST_INIT,			/* Initial state */
	UB_CMDST_CMD,			/* Command submitted */
	UB_CMDST_DATA,			/* Data phase */
	UB_CMDST_CLR2STS,		/* Clearing before requesting status */
	UB_CMDST_STAT,			/* Status phase */
	UB_CMDST_CLEAR,			/* Clearing a stall (halt, actually) */
P
Pete Zaitcev 已提交
189
	UB_CMDST_CLRRS,			/* Clearing before retrying status */
L
Linus Torvalds 已提交
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
	UB_CMDST_SENSE,			/* Sending Request Sense */
	UB_CMDST_DONE			/* Final state */
};

struct ub_scsi_cmd {
	unsigned char cdb[UB_MAX_CDB_SIZE];
	unsigned char cdb_len;

	unsigned char dir;		/* 0 - none, 1 - read, 3 - write. */
	enum ub_scsi_cmd_state state;
	unsigned int tag;
	struct ub_scsi_cmd *next;

	int error;			/* Return code - valid upon done */
	unsigned int act_len;		/* Return size */
	unsigned char key, asc, ascq;	/* May be valid if error==-EIO */

	int stat_count;			/* Retries getting status. */
P
Pete Zaitcev 已提交
208
	unsigned int timeo;		/* jiffies until rq->timeout changes */
L
Linus Torvalds 已提交
209 210

	unsigned int len;		/* Requested length */
211 212 213
	unsigned int current_sg;
	unsigned int nsg;		/* sgv[nsg] */
	struct scatterlist sgv[UB_MAX_REQ_SG];
L
Linus Torvalds 已提交
214

215
	struct ub_lun *lun;
L
Linus Torvalds 已提交
216 217 218 219
	void (*done)(struct ub_dev *, struct ub_scsi_cmd *);
	void *back;
};

220 221 222 223 224 225 226
struct ub_request {
	struct request *rq;
	unsigned int current_try;
	unsigned int nsg;		/* sgv[nsg] */
	struct scatterlist sgv[UB_MAX_REQ_SG];
};

L
Linus Torvalds 已提交
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
/*
 */
struct ub_capacity {
	unsigned long nsec;		/* Linux size - 512 byte sectors */
	unsigned int bsize;		/* Linux hardsect_size */
	unsigned int bshift;		/* Shift between 512 and hard sects */
};

/*
 * This is a direct take-off from linux/include/completion.h
 * The difference is that I do not wait on this thing, just poll.
 * When I want to wait (ub_probe), I just use the stock completion.
 *
 * Note that INIT_COMPLETION takes no lock. It is correct. But why
 * in the bloody hell that thing takes struct instead of pointer to struct
 * is quite beyond me. I just copied it from the stock completion.
 */
struct ub_completion {
	unsigned int done;
	spinlock_t lock;
};

static inline void ub_init_completion(struct ub_completion *x)
{
	x->done = 0;
	spin_lock_init(&x->lock);
}

#define UB_INIT_COMPLETION(x)	((x).done = 0)

static void ub_complete(struct ub_completion *x)
{
	unsigned long flags;

	spin_lock_irqsave(&x->lock, flags);
	x->done++;
	spin_unlock_irqrestore(&x->lock, flags);
}

static int ub_is_completed(struct ub_completion *x)
{
	unsigned long flags;
	int ret;

	spin_lock_irqsave(&x->lock, flags);
	ret = x->done;
	spin_unlock_irqrestore(&x->lock, flags);
	return ret;
}

/*
 */
struct ub_scsi_cmd_queue {
	int qlen, qmax;
	struct ub_scsi_cmd *head, *tail;
};

/*
285 286 287 288 289 290 291 292 293 294 295 296 297 298
 * The block device instance (one per LUN).
 */
struct ub_lun {
	struct ub_dev *udev;
	struct list_head link;
	struct gendisk *disk;
	int id;				/* Host index */
	int num;			/* LUN number */
	char name[16];

	int changed;			/* Media was changed */
	int removable;
	int readonly;

299 300
	struct ub_request urq;

301 302 303 304 305 306 307 308 309 310 311 312 313 314
	/* Use Ingo's mempool if or when we have more than one command. */
	/*
	 * Currently we never need more than one command for the whole device.
	 * However, giving every LUN a command is a cheap and automatic way
	 * to enforce fairness between them.
	 */
	int cmda[1];
	struct ub_scsi_cmd cmdv[1];

	struct ub_capacity capacity; 
};

/*
 * The USB device instance.
L
Linus Torvalds 已提交
315 316
 */
struct ub_dev {
P
Pete Zaitcev 已提交
317
	spinlock_t *lock;
L
Linus Torvalds 已提交
318 319 320
	atomic_t poison;		/* The USB device is disconnected */
	int openc;			/* protected by ub_lock! */
					/* kref is too implicit for our taste */
321
	int reset;			/* Reset is running */
P
Pete Zaitcev 已提交
322
	int bad_resid;
L
Linus Torvalds 已提交
323
	unsigned int tagcnt;
324
	char name[12];
L
Linus Torvalds 已提交
325 326 327
	struct usb_device *dev;
	struct usb_interface *intf;

328
	struct list_head luns;
L
Linus Torvalds 已提交
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344

	unsigned int send_bulk_pipe;	/* cached pipe values */
	unsigned int recv_bulk_pipe;
	unsigned int send_ctrl_pipe;
	unsigned int recv_ctrl_pipe;

	struct tasklet_struct tasklet;

	struct ub_scsi_cmd_queue cmd_queue;
	struct ub_scsi_cmd top_rqs_cmd;	/* REQUEST SENSE */
	unsigned char top_sense[UB_SENSE_SIZE];

	struct ub_completion work_done;
	struct urb work_urb;
	struct timer_list work_timer;
	int last_pipe;			/* What might need clearing */
P
Pete Zaitcev 已提交
345
	__le32 signature;		/* Learned signature */
L
Linus Torvalds 已提交
346 347 348 349
	struct bulk_cb_wrap work_bcb;
	struct bulk_cs_wrap work_bcs;
	struct usb_ctrlrequest work_cr;

350 351
	struct work_struct reset_work;
	wait_queue_head_t reset_wait;
L
Linus Torvalds 已提交
352 353 354 355 356
};

/*
 */
static void ub_cleanup(struct ub_dev *sc);
357
static int ub_request_fn_1(struct ub_lun *lun, struct request *rq);
358 359 360 361
static void ub_cmd_build_block(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_scsi_cmd *cmd, struct ub_request *urq);
static void ub_cmd_build_packet(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_scsi_cmd *cmd, struct ub_request *urq);
L
Linus Torvalds 已提交
362
static void ub_rw_cmd_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
363 364
static void ub_end_rq(struct request *rq, unsigned int status,
    unsigned int cmd_len);
365 366
static int ub_rw_cmd_retry(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_request *urq, struct ub_scsi_cmd *cmd);
L
Linus Torvalds 已提交
367
static int ub_submit_scsi(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
368
static void ub_urb_complete(struct urb *urb);
L
Linus Torvalds 已提交
369 370 371
static void ub_scsi_action(unsigned long _dev);
static void ub_scsi_dispatch(struct ub_dev *sc);
static void ub_scsi_urb_compl(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
372
static void ub_data_start(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
L
Linus Torvalds 已提交
373
static void ub_state_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd, int rc);
P
Pete Zaitcev 已提交
374
static int __ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
L
Linus Torvalds 已提交
375
static void ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
P
Pete Zaitcev 已提交
376
static void ub_state_stat_counted(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
L
Linus Torvalds 已提交
377 378 379 380
static void ub_state_sense(struct ub_dev *sc, struct ub_scsi_cmd *cmd);
static int ub_submit_clear_stall(struct ub_dev *sc, struct ub_scsi_cmd *cmd,
    int stalled_pipe);
static void ub_top_sense_done(struct ub_dev *sc, struct ub_scsi_cmd *scmd);
P
Pete Zaitcev 已提交
381
static void ub_reset_enter(struct ub_dev *sc, int try);
D
David Howells 已提交
382
static void ub_reset_task(struct work_struct *work);
383 384 385
static int ub_sync_tur(struct ub_dev *sc, struct ub_lun *lun);
static int ub_sync_read_cap(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_capacity *ret);
P
Pete Zaitcev 已提交
386 387
static int ub_sync_reset(struct ub_dev *sc);
static int ub_probe_clear_stall(struct ub_dev *sc, int stalled_pipe);
388
static int ub_probe_lun(struct ub_dev *sc, int lnum);
L
Linus Torvalds 已提交
389 390 391

/*
 */
392 393 394 395 396
#ifdef CONFIG_USB_LIBUSUAL

#define ub_usb_ids  storage_usb_ids
#else

L
Linus Torvalds 已提交
397 398 399 400 401 402
static struct usb_device_id ub_usb_ids[] = {
	{ USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, US_SC_SCSI, US_PR_BULK) },
	{ }
};

MODULE_DEVICE_TABLE(usb, ub_usb_ids);
403
#endif /* CONFIG_USB_LIBUSUAL */
L
Linus Torvalds 已提交
404 405 406 407 408 409 410 411 412 413

/*
 * Find me a way to identify "next free minor" for add_disk(),
 * and the array disappears the next day. However, the number of
 * hosts has something to do with the naming and /proc/partitions.
 * This has to be thought out in detail before changing.
 * If UB_MAX_HOST was 1000, we'd use a bitmap. Or a better data structure.
 */
#define UB_MAX_HOSTS  26
static char ub_hostv[UB_MAX_HOSTS];
414

P
Pete Zaitcev 已提交
415 416 417 418
#define UB_QLOCK_NUM 5
static spinlock_t ub_qlockv[UB_QLOCK_NUM];
static int ub_qlock_next = 0;

L
Linus Torvalds 已提交
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
static DEFINE_SPINLOCK(ub_lock);	/* Locks globals and ->openc */

/*
 * The id allocator.
 *
 * This also stores the host for indexing by minor, which is somewhat dirty.
 */
static int ub_id_get(void)
{
	unsigned long flags;
	int i;

	spin_lock_irqsave(&ub_lock, flags);
	for (i = 0; i < UB_MAX_HOSTS; i++) {
		if (ub_hostv[i] == 0) {
			ub_hostv[i] = 1;
			spin_unlock_irqrestore(&ub_lock, flags);
			return i;
		}
	}
	spin_unlock_irqrestore(&ub_lock, flags);
	return -1;
}

static void ub_id_put(int id)
{
	unsigned long flags;

	if (id < 0 || id >= UB_MAX_HOSTS) {
		printk(KERN_ERR DRV_NAME ": bad host ID %d\n", id);
		return;
	}

	spin_lock_irqsave(&ub_lock, flags);
	if (ub_hostv[id] == 0) {
		spin_unlock_irqrestore(&ub_lock, flags);
		printk(KERN_ERR DRV_NAME ": freeing free host ID %d\n", id);
		return;
	}
	ub_hostv[id] = 0;
	spin_unlock_irqrestore(&ub_lock, flags);
}

P
Pete Zaitcev 已提交
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
/*
 * This is necessitated by the fact that blk_cleanup_queue does not
 * necesserily destroy the queue. Instead, it may merely decrease q->refcnt.
 * Since our blk_init_queue() passes a spinlock common with ub_dev,
 * we have life time issues when ub_cleanup frees ub_dev.
 */
static spinlock_t *ub_next_lock(void)
{
	unsigned long flags;
	spinlock_t *ret;

	spin_lock_irqsave(&ub_lock, flags);
	ret = &ub_qlockv[ub_qlock_next];
	ub_qlock_next = (ub_qlock_next + 1) % UB_QLOCK_NUM;
	spin_unlock_irqrestore(&ub_lock, flags);
	return ret;
}

L
Linus Torvalds 已提交
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
/*
 * Downcount for deallocation. This rides on two assumptions:
 *  - once something is poisoned, its refcount cannot grow
 *  - opens cannot happen at this time (del_gendisk was done)
 * If the above is true, we can drop the lock, which we need for
 * blk_cleanup_queue(): the silly thing may attempt to sleep.
 * [Actually, it never needs to sleep for us, but it calls might_sleep()]
 */
static void ub_put(struct ub_dev *sc)
{
	unsigned long flags;

	spin_lock_irqsave(&ub_lock, flags);
	--sc->openc;
	if (sc->openc == 0 && atomic_read(&sc->poison)) {
		spin_unlock_irqrestore(&ub_lock, flags);
		ub_cleanup(sc);
	} else {
		spin_unlock_irqrestore(&ub_lock, flags);
	}
}

/*
 * Final cleanup and deallocation.
 */
static void ub_cleanup(struct ub_dev *sc)
{
507 508
	struct list_head *p;
	struct ub_lun *lun;
509
	struct request_queue *q;
L
Linus Torvalds 已提交
510

511 512 513 514
	while (!list_empty(&sc->luns)) {
		p = sc->luns.next;
		lun = list_entry(p, struct ub_lun, link);
		list_del(p);
L
Linus Torvalds 已提交
515

516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
		/* I don't think queue can be NULL. But... Stolen from sx8.c */
		if ((q = lun->disk->queue) != NULL)
			blk_cleanup_queue(q);
		/*
		 * If we zero disk->private_data BEFORE put_disk, we have
		 * to check for NULL all over the place in open, release,
		 * check_media and revalidate, because the block level
		 * semaphore is well inside the put_disk.
		 * But we cannot zero after the call, because *disk is gone.
		 * The sd.c is blatantly racy in this area.
		 */
		/* disk->private_data = NULL; */
		put_disk(lun->disk);
		lun->disk = NULL;

		ub_id_put(lun->id);
		kfree(lun);
	}
L
Linus Torvalds 已提交
534

535 536 537
	usb_set_intfdata(sc->intf, NULL);
	usb_put_intf(sc->intf);
	usb_put_dev(sc->dev);
L
Linus Torvalds 已提交
538 539 540 541 542 543
	kfree(sc);
}

/*
 * The "command allocator".
 */
544
static struct ub_scsi_cmd *ub_get_cmd(struct ub_lun *lun)
L
Linus Torvalds 已提交
545 546 547
{
	struct ub_scsi_cmd *ret;

548
	if (lun->cmda[0])
L
Linus Torvalds 已提交
549
		return NULL;
550 551
	ret = &lun->cmdv[0];
	lun->cmda[0] = 1;
L
Linus Torvalds 已提交
552 553 554
	return ret;
}

555
static void ub_put_cmd(struct ub_lun *lun, struct ub_scsi_cmd *cmd)
L
Linus Torvalds 已提交
556
{
557
	if (cmd != &lun->cmdv[0]) {
L
Linus Torvalds 已提交
558
		printk(KERN_WARNING "%s: releasing a foreign cmd %p\n",
559
		    lun->name, cmd);
L
Linus Torvalds 已提交
560 561
		return;
	}
562 563
	if (!lun->cmda[0]) {
		printk(KERN_WARNING "%s: releasing a free cmd\n", lun->name);
L
Linus Torvalds 已提交
564 565
		return;
	}
566
	lun->cmda[0] = 0;
L
Linus Torvalds 已提交
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
}

/*
 * The command queue.
 */
static void ub_cmdq_add(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct ub_scsi_cmd_queue *t = &sc->cmd_queue;

	if (t->qlen++ == 0) {
		t->head = cmd;
		t->tail = cmd;
	} else {
		t->tail->next = cmd;
		t->tail = cmd;
	}

	if (t->qlen > t->qmax)
		t->qmax = t->qlen;
}

static void ub_cmdq_insert(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct ub_scsi_cmd_queue *t = &sc->cmd_queue;

	if (t->qlen++ == 0) {
		t->head = cmd;
		t->tail = cmd;
	} else {
		cmd->next = t->head;
		t->head = cmd;
	}

	if (t->qlen > t->qmax)
		t->qmax = t->qlen;
}

static struct ub_scsi_cmd *ub_cmdq_pop(struct ub_dev *sc)
{
	struct ub_scsi_cmd_queue *t = &sc->cmd_queue;
	struct ub_scsi_cmd *cmd;

	if (t->qlen == 0)
		return NULL;
	if (--t->qlen == 0)
		t->tail = NULL;
	cmd = t->head;
	t->head = cmd->next;
	cmd->next = NULL;
	return cmd;
}

#define ub_cmdq_peek(sc)  ((sc)->cmd_queue.head)

/*
 * The request function is our main entry point
 */

625
static void ub_request_fn(struct request_queue *q)
L
Linus Torvalds 已提交
626
{
627
	struct ub_lun *lun = q->queuedata;
L
Linus Torvalds 已提交
628 629 630
	struct request *rq;

	while ((rq = elv_next_request(q)) != NULL) {
631
		if (ub_request_fn_1(lun, rq) != 0) {
L
Linus Torvalds 已提交
632 633 634 635 636 637
			blk_stop_queue(q);
			break;
		}
	}
}

638
static int ub_request_fn_1(struct ub_lun *lun, struct request *rq)
L
Linus Torvalds 已提交
639
{
640
	struct ub_dev *sc = lun->udev;
L
Linus Torvalds 已提交
641
	struct ub_scsi_cmd *cmd;
642 643
	struct ub_request *urq;
	int n_elem;
L
Linus Torvalds 已提交
644

645
	if (atomic_read(&sc->poison)) {
L
Linus Torvalds 已提交
646
		blkdev_dequeue_request(rq);
647
		ub_end_rq(rq, DID_NO_CONNECT << 16, blk_rq_bytes(rq));
648 649 650 651 652
		return 0;
	}

	if (lun->changed && !blk_pc_request(rq)) {
		blkdev_dequeue_request(rq);
653
		ub_end_rq(rq, SAM_STAT_CHECK_CONDITION, blk_rq_bytes(rq));
L
Linus Torvalds 已提交
654 655 656
		return 0;
	}

657 658
	if (lun->urq.rq != NULL)
		return -1;
659
	if ((cmd = ub_get_cmd(lun)) == NULL)
L
Linus Torvalds 已提交
660 661 662 663
		return -1;
	memset(cmd, 0, sizeof(struct ub_scsi_cmd));

	blkdev_dequeue_request(rq);
664 665 666 667 668 669 670 671

	urq = &lun->urq;
	memset(urq, 0, sizeof(struct ub_request));
	urq->rq = rq;

	/*
	 * get scatterlist from block layer
	 */
672
	sg_init_table(&urq->sgv[0], UB_MAX_REQ_SG);
673 674
	n_elem = blk_rq_map_sg(lun->disk->queue, rq, &urq->sgv[0]);
	if (n_elem < 0) {
P
Pete Zaitcev 已提交
675
		/* Impossible, because blk_rq_map_sg should not hit ENOMEM. */
676
		printk(KERN_INFO "%s: failed request map (%d)\n",
P
Pete Zaitcev 已提交
677
		    lun->name, n_elem);
678 679 680 681 682 683 684 685 686
		goto drop;
	}
	if (n_elem > UB_MAX_REQ_SG) {	/* Paranoia */
		printk(KERN_WARNING "%s: request with %d segments\n",
		    lun->name, n_elem);
		goto drop;
	}
	urq->nsg = n_elem;

L
Linus Torvalds 已提交
687
	if (blk_pc_request(rq)) {
688
		ub_cmd_build_packet(sc, lun, cmd, urq);
L
Linus Torvalds 已提交
689
	} else {
690
		ub_cmd_build_block(sc, lun, cmd, urq);
L
Linus Torvalds 已提交
691 692
	}
	cmd->state = UB_CMDST_INIT;
693
	cmd->lun = lun;
L
Linus Torvalds 已提交
694
	cmd->done = ub_rw_cmd_done;
695
	cmd->back = urq;
L
Linus Torvalds 已提交
696 697

	cmd->tag = sc->tagcnt++;
698 699 700 701
	if (ub_submit_scsi(sc, cmd) != 0)
		goto drop;

	return 0;
L
Linus Torvalds 已提交
702

703 704
drop:
	ub_put_cmd(lun, cmd);
705
	ub_end_rq(rq, DID_ERROR << 16, blk_rq_bytes(rq));
L
Linus Torvalds 已提交
706 707 708
	return 0;
}

709 710
static void ub_cmd_build_block(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_scsi_cmd *cmd, struct ub_request *urq)
L
Linus Torvalds 已提交
711
{
712
	struct request *rq = urq->rq;
713
	unsigned int block, nblks;
L
Linus Torvalds 已提交
714 715

	if (rq_data_dir(rq) == WRITE)
716
		cmd->dir = UB_DIR_WRITE;
L
Linus Torvalds 已提交
717
	else
718
		cmd->dir = UB_DIR_READ;
L
Linus Torvalds 已提交
719

720 721
	cmd->nsg = urq->nsg;
	memcpy(cmd->sgv, urq->sgv, sizeof(struct scatterlist) * cmd->nsg);
L
Linus Torvalds 已提交
722 723 724 725 726 727 728

	/*
	 * build the command
	 *
	 * The call to blk_queue_hardsect_size() guarantees that request
	 * is aligned, but it is given in terms of 512 byte units, always.
	 */
729 730
	block = rq->sector >> lun->capacity.bshift;
	nblks = rq->nr_sectors >> lun->capacity.bshift;
731

732
	cmd->cdb[0] = (cmd->dir == UB_DIR_READ)? READ_10: WRITE_10;
L
Linus Torvalds 已提交
733 734 735 736 737 738 739 740 741
	/* 10-byte uses 4 bytes of LBA: 2147483648KB, 2097152MB, 2048GB */
	cmd->cdb[2] = block >> 24;
	cmd->cdb[3] = block >> 16;
	cmd->cdb[4] = block >> 8;
	cmd->cdb[5] = block;
	cmd->cdb[7] = nblks >> 8;
	cmd->cdb[8] = nblks;
	cmd->cdb_len = 10;

742
	cmd->len = rq->nr_sectors * 512;
L
Linus Torvalds 已提交
743 744
}

745 746
static void ub_cmd_build_packet(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_scsi_cmd *cmd, struct ub_request *urq)
L
Linus Torvalds 已提交
747
{
748
	struct request *rq = urq->rq;
L
Linus Torvalds 已提交
749 750 751 752 753 754 755 756 757

	if (rq->data_len == 0) {
		cmd->dir = UB_DIR_NONE;
	} else {
		if (rq_data_dir(rq) == WRITE)
			cmd->dir = UB_DIR_WRITE;
		else
			cmd->dir = UB_DIR_READ;
	}
758

759 760
	cmd->nsg = urq->nsg;
	memcpy(cmd->sgv, urq->sgv, sizeof(struct scatterlist) * cmd->nsg);
761 762 763 764

	memcpy(&cmd->cdb, rq->cmd, rq->cmd_len);
	cmd->cdb_len = rq->cmd_len;

L
Linus Torvalds 已提交
765
	cmd->len = rq->data_len;
P
Pete Zaitcev 已提交
766 767 768 769 770 771

	/*
	 * To reapply this to every URB is not as incorrect as it looks.
	 * In return, we avoid any complicated tracking calculations.
	 */
	cmd->timeo = rq->timeout;
L
Linus Torvalds 已提交
772 773 774 775
}

static void ub_rw_cmd_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
776
	struct ub_lun *lun = cmd->lun;
777 778
	struct ub_request *urq = cmd->back;
	struct request *rq;
779
	unsigned int scsi_status;
780
	unsigned int cmd_len;
L
Linus Torvalds 已提交
781

782 783
	rq = urq->rq;

784 785 786 787 788 789
	if (cmd->error == 0) {
		if (blk_pc_request(rq)) {
			if (cmd->act_len >= rq->data_len)
				rq->data_len = 0;
			else
				rq->data_len -= cmd->act_len;
790 791 792 793 794 795 796
			scsi_status = 0;
		} else {
			if (cmd->act_len != cmd->len) {
				scsi_status = SAM_STAT_CHECK_CONDITION;
			} else {
				scsi_status = 0;
			}
797
		}
798 799 800 801 802 803
	} else {
		if (blk_pc_request(rq)) {
			/* UB_SENSE_SIZE is smaller than SCSI_SENSE_BUFFERSIZE */
			memcpy(rq->sense, sc->top_sense, UB_SENSE_SIZE);
			rq->sense_len = UB_SENSE_SIZE;
			if (sc->top_sense[0] != 0)
804
				scsi_status = SAM_STAT_CHECK_CONDITION;
805
			else
806
				scsi_status = DID_ERROR << 16;
807
		} else {
P
Pete Zaitcev 已提交
808 809 810 811
			if (cmd->error == -EIO &&
			    (cmd->key == 0 ||
			     cmd->key == MEDIUM_ERROR ||
			     cmd->key == UNIT_ATTENTION)) {
812 813 814
				if (ub_rw_cmd_retry(sc, lun, urq, cmd) == 0)
					return;
			}
815
			scsi_status = SAM_STAT_CHECK_CONDITION;
816 817
		}
	}
818

819 820
	urq->rq = NULL;

821
	cmd_len = cmd->len;
822
	ub_put_cmd(lun, cmd);
823
	ub_end_rq(rq, scsi_status, cmd_len);
824
	blk_start_queue(lun->disk->queue);
L
Linus Torvalds 已提交
825 826
}

827 828
static void ub_end_rq(struct request *rq, unsigned int scsi_status,
    unsigned int cmd_len)
L
Linus Torvalds 已提交
829
{
830
	int error;
831
	long rqlen;
832 833

	if (scsi_status == 0) {
834
		error = 0;
835
	} else {
836
		error = -EIO;
837 838
		rq->errors = scsi_status;
	}
839 840 841 842 843 844
	rqlen = blk_rq_bytes(rq);    /* Oddly enough, this is the residue. */
	if (__blk_end_request(rq, error, cmd_len)) {
		printk(KERN_WARNING DRV_NAME
		    ": __blk_end_request blew, %s-cmd total %u rqlen %ld\n",
		    blk_pc_request(rq)? "pc": "fs", cmd_len, rqlen);
	}
L
Linus Torvalds 已提交
845 846
}

847 848 849 850 851 852 853
static int ub_rw_cmd_retry(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_request *urq, struct ub_scsi_cmd *cmd)
{

	if (atomic_read(&sc->poison))
		return -ENXIO;

P
Pete Zaitcev 已提交
854
	ub_reset_enter(sc, urq->current_try);
855 856 857 858

	if (urq->current_try >= 3)
		return -EIO;
	urq->current_try++;
P
Pete Zaitcev 已提交
859 860 861

	/* Remove this if anyone complains of flooding. */
	printk(KERN_DEBUG "%s: dir %c len/act %d/%d "
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
	    "[sense %x %02x %02x] retry %d\n",
	    sc->name, UB_DIR_CHAR(cmd->dir), cmd->len, cmd->act_len,
	    cmd->key, cmd->asc, cmd->ascq, urq->current_try);

	memset(cmd, 0, sizeof(struct ub_scsi_cmd));
	ub_cmd_build_block(sc, lun, cmd, urq);

	cmd->state = UB_CMDST_INIT;
	cmd->lun = lun;
	cmd->done = ub_rw_cmd_done;
	cmd->back = urq;

	cmd->tag = sc->tagcnt++;

#if 0 /* Wasteful */
	return ub_submit_scsi(sc, cmd);
#else
	ub_cmdq_add(sc, cmd);
	return 0;
#endif
}

L
Linus Torvalds 已提交
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
/*
 * Submit a regular SCSI operation (not an auto-sense).
 *
 * The Iron Law of Good Submit Routine is:
 * Zero return - callback is done, Nonzero return - callback is not done.
 * No exceptions.
 *
 * Host is assumed locked.
 */
static int ub_submit_scsi(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{

	if (cmd->state != UB_CMDST_INIT ||
	    (cmd->dir != UB_DIR_NONE && cmd->len == 0)) {
		return -EINVAL;
	}

	ub_cmdq_add(sc, cmd);
	/*
	 * We can call ub_scsi_dispatch(sc) right away here, but it's a little
	 * safer to jump to a tasklet, in case upper layers do something silly.
	 */
	tasklet_schedule(&sc->tasklet);
	return 0;
}

/*
 * Submit the first URB for the queued command.
 * This function does not deal with queueing in any way.
 */
static int ub_scsi_cmd_start(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct bulk_cb_wrap *bcb;
	int rc;

	bcb = &sc->work_bcb;

	/*
	 * ``If the allocation length is eighteen or greater, and a device
	 * server returns less than eithteen bytes of data, the application
	 * client should assume that the bytes not transferred would have been
	 * zeroes had the device server returned those bytes.''
	 *
	 * We zero sense for all commands so that when a packet request
	 * fails it does not return a stale sense.
	 */
	memset(&sc->top_sense, 0, UB_SENSE_SIZE);

	/* set up the command wrapper */
	bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
	bcb->Tag = cmd->tag;		/* Endianness is not important */
	bcb->DataTransferLength = cpu_to_le32(cmd->len);
	bcb->Flags = (cmd->dir == UB_DIR_READ) ? 0x80 : 0;
937
	bcb->Lun = (cmd->lun != NULL) ? cmd->lun->num : 0;
L
Linus Torvalds 已提交
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
	bcb->Length = cmd->cdb_len;

	/* copy the command payload */
	memcpy(bcb->CDB, cmd->cdb, UB_MAX_CDB_SIZE);

	UB_INIT_COMPLETION(sc->work_done);

	sc->last_pipe = sc->send_bulk_pipe;
	usb_fill_bulk_urb(&sc->work_urb, sc->dev, sc->send_bulk_pipe,
	    bcb, US_BULK_CB_WRAP_LEN, ub_urb_complete, sc);

	if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
		/* XXX Clear stalls */
		ub_complete(&sc->work_done);
		return rc;
	}

	sc->work_timer.expires = jiffies + UB_URB_TIMEOUT;
	add_timer(&sc->work_timer);

	cmd->state = UB_CMDST_CMD;
	return 0;
}

/*
 * Timeout handler.
 */
static void ub_urb_timeout(unsigned long arg)
{
	struct ub_dev *sc = (struct ub_dev *) arg;
	unsigned long flags;

P
Pete Zaitcev 已提交
970
	spin_lock_irqsave(sc->lock, flags);
971 972
	if (!ub_is_completed(&sc->work_done))
		usb_unlink_urb(&sc->work_urb);
P
Pete Zaitcev 已提交
973
	spin_unlock_irqrestore(sc->lock, flags);
L
Linus Torvalds 已提交
974 975 976 977 978 979 980 981 982
}

/*
 * Completion routine for the work URB.
 *
 * This can be called directly from usb_submit_urb (while we have
 * the sc->lock taken) and from an interrupt (while we do NOT have
 * the sc->lock taken). Therefore, bounce this off to a tasklet.
 */
983
static void ub_urb_complete(struct urb *urb)
L
Linus Torvalds 已提交
984 985 986 987 988 989 990 991 992 993 994 995
{
	struct ub_dev *sc = urb->context;

	ub_complete(&sc->work_done);
	tasklet_schedule(&sc->tasklet);
}

static void ub_scsi_action(unsigned long _dev)
{
	struct ub_dev *sc = (struct ub_dev *) _dev;
	unsigned long flags;

P
Pete Zaitcev 已提交
996
	spin_lock_irqsave(sc->lock, flags);
L
Linus Torvalds 已提交
997
	ub_scsi_dispatch(sc);
P
Pete Zaitcev 已提交
998
	spin_unlock_irqrestore(sc->lock, flags);
L
Linus Torvalds 已提交
999 1000 1001 1002 1003 1004 1005
}

static void ub_scsi_dispatch(struct ub_dev *sc)
{
	struct ub_scsi_cmd *cmd;
	int rc;

1006
	while (!sc->reset && (cmd = ub_cmdq_peek(sc)) != NULL) {
L
Linus Torvalds 已提交
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
		if (cmd->state == UB_CMDST_DONE) {
			ub_cmdq_pop(sc);
			(*cmd->done)(sc, cmd);
		} else if (cmd->state == UB_CMDST_INIT) {
			if ((rc = ub_scsi_cmd_start(sc, cmd)) == 0)
				break;
			cmd->error = rc;
			cmd->state = UB_CMDST_DONE;
		} else {
			if (!ub_is_completed(&sc->work_done))
				break;
1018
			del_timer(&sc->work_timer);
L
Linus Torvalds 已提交
1019 1020 1021 1022 1023 1024 1025 1026 1027
			ub_scsi_urb_compl(sc, cmd);
		}
	}
}

static void ub_scsi_urb_compl(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct urb *urb = &sc->work_urb;
	struct bulk_cs_wrap *bcs;
1028
	int len;
L
Linus Torvalds 已提交
1029 1030 1031
	int rc;

	if (atomic_read(&sc->poison)) {
1032 1033
		ub_state_done(sc, cmd, -ENODEV);
		return;
L
Linus Torvalds 已提交
1034 1035 1036 1037 1038 1039 1040 1041
	}

	if (cmd->state == UB_CMDST_CLEAR) {
		if (urb->status == -EPIPE) {
			/*
			 * STALL while clearning STALL.
			 * The control pipe clears itself - nothing to do.
			 */
1042 1043
			printk(KERN_NOTICE "%s: stall on control pipe\n",
			    sc->name);
L
Linus Torvalds 已提交
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
			goto Bad_End;
		}

		/*
		 * We ignore the result for the halt clear.
		 */

		/* reset the endpoint toggle */
		usb_settoggle(sc->dev, usb_pipeendpoint(sc->last_pipe),
			usb_pipeout(sc->last_pipe), 0);

		ub_state_sense(sc, cmd);

	} else if (cmd->state == UB_CMDST_CLR2STS) {
		if (urb->status == -EPIPE) {
1059 1060
			printk(KERN_NOTICE "%s: stall on control pipe\n",
			    sc->name);
L
Linus Torvalds 已提交
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073
			goto Bad_End;
		}

		/*
		 * We ignore the result for the halt clear.
		 */

		/* reset the endpoint toggle */
		usb_settoggle(sc->dev, usb_pipeendpoint(sc->last_pipe),
			usb_pipeout(sc->last_pipe), 0);

		ub_state_stat(sc, cmd);

P
Pete Zaitcev 已提交
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
	} else if (cmd->state == UB_CMDST_CLRRS) {
		if (urb->status == -EPIPE) {
			printk(KERN_NOTICE "%s: stall on control pipe\n",
			    sc->name);
			goto Bad_End;
		}

		/*
		 * We ignore the result for the halt clear.
		 */

		/* reset the endpoint toggle */
		usb_settoggle(sc->dev, usb_pipeendpoint(sc->last_pipe),
			usb_pipeout(sc->last_pipe), 0);

		ub_state_stat_counted(sc, cmd);

L
Linus Torvalds 已提交
1091
	} else if (cmd->state == UB_CMDST_CMD) {
1092 1093 1094 1095 1096 1097
		switch (urb->status) {
		case 0:
			break;
		case -EOVERFLOW:
			goto Bad_End;
		case -EPIPE:
L
Linus Torvalds 已提交
1098 1099 1100
			rc = ub_submit_clear_stall(sc, cmd, sc->last_pipe);
			if (rc != 0) {
				printk(KERN_NOTICE "%s: "
1101 1102
				    "unable to submit clear (%d)\n",
				    sc->name, rc);
L
Linus Torvalds 已提交
1103 1104 1105 1106
				/*
				 * This is typically ENOMEM or some other such shit.
				 * Retrying is pointless. Just do Bad End on it...
				 */
1107 1108
				ub_state_done(sc, cmd, rc);
				return;
L
Linus Torvalds 已提交
1109 1110 1111
			}
			cmd->state = UB_CMDST_CLEAR;
			return;
1112 1113 1114 1115 1116
		case -ESHUTDOWN:	/* unplug */
		case -EILSEQ:		/* unplug timeout on uhci */
			ub_state_done(sc, cmd, -ENODEV);
			return;
		default:
L
Linus Torvalds 已提交
1117 1118 1119 1120 1121 1122
			goto Bad_End;
		}
		if (urb->actual_length != US_BULK_CB_WRAP_LEN) {
			goto Bad_End;
		}

1123
		if (cmd->dir == UB_DIR_NONE || cmd->nsg < 1) {
L
Linus Torvalds 已提交
1124 1125 1126 1127
			ub_state_stat(sc, cmd);
			return;
		}

1128 1129
		// udelay(125);		// usb-storage has this
		ub_data_start(sc, cmd);
L
Linus Torvalds 已提交
1130 1131 1132 1133 1134 1135

	} else if (cmd->state == UB_CMDST_DATA) {
		if (urb->status == -EPIPE) {
			rc = ub_submit_clear_stall(sc, cmd, sc->last_pipe);
			if (rc != 0) {
				printk(KERN_NOTICE "%s: "
1136 1137
				    "unable to submit clear (%d)\n",
				    sc->name, rc);
1138 1139
				ub_state_done(sc, cmd, rc);
				return;
L
Linus Torvalds 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148
			}
			cmd->state = UB_CMDST_CLR2STS;
			return;
		}
		if (urb->status == -EOVERFLOW) {
			/*
			 * A babble? Failure, but we must transfer CSW now.
			 */
			cmd->error = -EOVERFLOW;	/* A cheap trick... */
1149 1150
			ub_state_stat(sc, cmd);
			return;
L
Linus Torvalds 已提交
1151
		}
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

		if (cmd->dir == UB_DIR_WRITE) {
			/*
			 * Do not continue writes in case of a failure.
			 * Doing so would cause sectors to be mixed up,
			 * which is worse than sectors lost.
			 *
			 * We must try to read the CSW, or many devices
			 * get confused.
			 */
			len = urb->actual_length;
			if (urb->status != 0 ||
			    len != cmd->sgv[cmd->current_sg].length) {
				cmd->act_len += len;

				cmd->error = -EIO;
				ub_state_stat(sc, cmd);
				return;
			}

		} else {
			/*
			 * If an error occurs on read, we record it, and
			 * continue to fetch data in order to avoid bubble.
			 *
			 * As a small shortcut, we stop if we detect that
			 * a CSW mixed into data.
			 */
			if (urb->status != 0)
				cmd->error = -EIO;

			len = urb->actual_length;
			if (urb->status != 0 ||
			    len != cmd->sgv[cmd->current_sg].length) {
				if ((len & 0x1FF) == US_BULK_CS_WRAP_LEN)
					goto Bad_End;
			}
		}
L
Linus Torvalds 已提交
1190

1191
		cmd->act_len += urb->actual_length;
L
Linus Torvalds 已提交
1192

1193 1194 1195 1196
		if (++cmd->current_sg < cmd->nsg) {
			ub_data_start(sc, cmd);
			return;
		}
L
Linus Torvalds 已提交
1197 1198 1199 1200 1201 1202 1203
		ub_state_stat(sc, cmd);

	} else if (cmd->state == UB_CMDST_STAT) {
		if (urb->status == -EPIPE) {
			rc = ub_submit_clear_stall(sc, cmd, sc->last_pipe);
			if (rc != 0) {
				printk(KERN_NOTICE "%s: "
1204 1205
				    "unable to submit clear (%d)\n",
				    sc->name, rc);
1206 1207
				ub_state_done(sc, cmd, rc);
				return;
L
Linus Torvalds 已提交
1208
			}
P
Pete Zaitcev 已提交
1209 1210 1211 1212 1213 1214 1215 1216

			/*
			 * Having a stall when getting CSW is an error, so
			 * make sure uppper levels are not oblivious to it.
			 */
			cmd->error = -EIO;		/* A cheap trick... */

			cmd->state = UB_CMDST_CLRRS;
L
Linus Torvalds 已提交
1217 1218
			return;
		}
1219 1220

		/* Catch everything, including -EOVERFLOW and other nasties. */
L
Linus Torvalds 已提交
1221 1222 1223 1224
		if (urb->status != 0)
			goto Bad_End;

		if (urb->actual_length == 0) {
P
Pete Zaitcev 已提交
1225
			ub_state_stat_counted(sc, cmd);
L
Linus Torvalds 已提交
1226 1227 1228 1229 1230
			return;
		}

		/*
		 * Check the returned Bulk protocol status.
P
Pete Zaitcev 已提交
1231
		 * The status block has to be validated first.
L
Linus Torvalds 已提交
1232 1233 1234
		 */

		bcs = &sc->work_bcs;
P
Pete Zaitcev 已提交
1235 1236

		if (sc->signature == cpu_to_le32(0)) {
L
Linus Torvalds 已提交
1237
			/*
P
Pete Zaitcev 已提交
1238 1239 1240
			 * This is the first reply, so do not perform the check.
			 * Instead, remember the signature the device uses
			 * for future checks. But do not allow a nul.
L
Linus Torvalds 已提交
1241
			 */
P
Pete Zaitcev 已提交
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
			sc->signature = bcs->Signature;
			if (sc->signature == cpu_to_le32(0)) {
				ub_state_stat_counted(sc, cmd);
				return;
			}
		} else {
			if (bcs->Signature != sc->signature) {
				ub_state_stat_counted(sc, cmd);
				return;
			}
L
Linus Torvalds 已提交
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
		}

		if (bcs->Tag != cmd->tag) {
			/*
			 * This usually happens when we disagree with the
			 * device's microcode about something. For instance,
			 * a few of them throw this after timeouts. They buffer
			 * commands and reply at commands we timed out before.
			 * Without flushing these replies we loop forever.
			 */
P
Pete Zaitcev 已提交
1262
			ub_state_stat_counted(sc, cmd);
L
Linus Torvalds 已提交
1263 1264 1265
			return;
		}

P
Pete Zaitcev 已提交
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
		if (!sc->bad_resid) {
			len = le32_to_cpu(bcs->Residue);
			if (len != cmd->len - cmd->act_len) {
				/*
				 * Only start ignoring if this cmd ended well.
				 */
				if (cmd->len == cmd->act_len) {
					printk(KERN_NOTICE "%s: "
					    "bad residual %d of %d, ignoring\n",
					    sc->name, len, cmd->len);
					sc->bad_resid = 1;
				}
			}
P
Pete Zaitcev 已提交
1279 1280
		}

L
Linus Torvalds 已提交
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
		switch (bcs->Status) {
		case US_BULK_STAT_OK:
			break;
		case US_BULK_STAT_FAIL:
			ub_state_sense(sc, cmd);
			return;
		case US_BULK_STAT_PHASE:
			goto Bad_End;
		default:
			printk(KERN_INFO "%s: unknown CSW status 0x%x\n",
			    sc->name, bcs->Status);
1292 1293
			ub_state_done(sc, cmd, -EINVAL);
			return;
L
Linus Torvalds 已提交
1294 1295 1296
		}

		/* Not zeroing error to preserve a babble indicator */
P
Pete Zaitcev 已提交
1297 1298 1299 1300
		if (cmd->error != 0) {
			ub_state_sense(sc, cmd);
			return;
		}
L
Linus Torvalds 已提交
1301 1302 1303 1304 1305 1306 1307 1308
		cmd->state = UB_CMDST_DONE;
		ub_cmdq_pop(sc);
		(*cmd->done)(sc, cmd);

	} else if (cmd->state == UB_CMDST_SENSE) {
		ub_state_done(sc, cmd, -EIO);

	} else {
P
Pete Zaitcev 已提交
1309
		printk(KERN_WARNING "%s: wrong command state %d\n",
1310
		    sc->name, cmd->state);
1311 1312
		ub_state_done(sc, cmd, -EINVAL);
		return;
L
Linus Torvalds 已提交
1313 1314 1315 1316 1317 1318 1319
	}
	return;

Bad_End: /* Little Excel is dead */
	ub_state_done(sc, cmd, -EIO);
}

1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
/*
 * Factorization helper for the command state machine:
 * Initiate a data segment transfer.
 */
static void ub_data_start(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct scatterlist *sg = &cmd->sgv[cmd->current_sg];
	int pipe;
	int rc;

	UB_INIT_COMPLETION(sc->work_done);

	if (cmd->dir == UB_DIR_READ)
		pipe = sc->recv_bulk_pipe;
	else
		pipe = sc->send_bulk_pipe;
	sc->last_pipe = pipe;
J
Jens Axboe 已提交
1337 1338
	usb_fill_bulk_urb(&sc->work_urb, sc->dev, pipe, sg_virt(sg),
	    sg->length, ub_urb_complete, sc);
1339 1340 1341 1342 1343 1344 1345 1346

	if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
		/* XXX Clear stalls */
		ub_complete(&sc->work_done);
		ub_state_done(sc, cmd, rc);
		return;
	}

P
Pete Zaitcev 已提交
1347 1348 1349 1350
	if (cmd->timeo)
		sc->work_timer.expires = jiffies + cmd->timeo;
	else
		sc->work_timer.expires = jiffies + UB_DATA_TIMEOUT;
1351 1352 1353 1354 1355
	add_timer(&sc->work_timer);

	cmd->state = UB_CMDST_DATA;
}

L
Linus Torvalds 已提交
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
/*
 * Factorization helper for the command state machine:
 * Finish the command.
 */
static void ub_state_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd, int rc)
{

	cmd->error = rc;
	cmd->state = UB_CMDST_DONE;
	ub_cmdq_pop(sc);
	(*cmd->done)(sc, cmd);
}

/*
 * Factorization helper for the command state machine:
 * Submit a CSW read.
 */
P
Pete Zaitcev 已提交
1373
static int __ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
L
Linus Torvalds 已提交
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
{
	int rc;

	UB_INIT_COMPLETION(sc->work_done);

	sc->last_pipe = sc->recv_bulk_pipe;
	usb_fill_bulk_urb(&sc->work_urb, sc->dev, sc->recv_bulk_pipe,
	    &sc->work_bcs, US_BULK_CS_WRAP_LEN, ub_urb_complete, sc);

	if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
		/* XXX Clear stalls */
		ub_complete(&sc->work_done);
		ub_state_done(sc, cmd, rc);
P
Pete Zaitcev 已提交
1387
		return -1;
L
Linus Torvalds 已提交
1388 1389
	}

P
Pete Zaitcev 已提交
1390 1391 1392 1393
	if (cmd->timeo)
		sc->work_timer.expires = jiffies + cmd->timeo;
	else
		sc->work_timer.expires = jiffies + UB_STAT_TIMEOUT;
L
Linus Torvalds 已提交
1394
	add_timer(&sc->work_timer);
P
Pete Zaitcev 已提交
1395
	return 0;
L
Linus Torvalds 已提交
1396 1397 1398 1399 1400 1401 1402 1403
}

/*
 * Factorization helper for the command state machine:
 * Submit a CSW read and go to STAT state.
 */
static void ub_state_stat(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
P
Pete Zaitcev 已提交
1404 1405 1406

	if (__ub_state_stat(sc, cmd) != 0)
		return;
L
Linus Torvalds 已提交
1407 1408 1409

	cmd->stat_count = 0;
	cmd->state = UB_CMDST_STAT;
P
Pete Zaitcev 已提交
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
}

/*
 * Factorization helper for the command state machine:
 * Submit a CSW read and go to STAT state with counter (along [C] path).
 */
static void ub_state_stat_counted(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{

	if (++cmd->stat_count >= 4) {
		ub_state_sense(sc, cmd);
		return;
	}

	if (__ub_state_stat(sc, cmd) != 0)
		return;

	cmd->state = UB_CMDST_STAT;
L
Linus Torvalds 已提交
1428 1429 1430 1431 1432 1433 1434 1435 1436
}

/*
 * Factorization helper for the command state machine:
 * Submit a REQUEST SENSE and go to SENSE state.
 */
static void ub_state_sense(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct ub_scsi_cmd *scmd;
1437
	struct scatterlist *sg;
L
Linus Torvalds 已提交
1438 1439 1440 1441 1442 1443 1444 1445
	int rc;

	if (cmd->cdb[0] == REQUEST_SENSE) {
		rc = -EPIPE;
		goto error;
	}

	scmd = &sc->top_rqs_cmd;
1446
	memset(scmd, 0, sizeof(struct ub_scsi_cmd));
L
Linus Torvalds 已提交
1447 1448 1449 1450 1451
	scmd->cdb[0] = REQUEST_SENSE;
	scmd->cdb[4] = UB_SENSE_SIZE;
	scmd->cdb_len = 6;
	scmd->dir = UB_DIR_READ;
	scmd->state = UB_CMDST_INIT;
1452 1453
	scmd->nsg = 1;
	sg = &scmd->sgv[0];
1454
	sg_init_table(sg, UB_MAX_REQ_SG);
1455 1456
	sg_set_page(sg, virt_to_page(sc->top_sense), UB_SENSE_SIZE,
			(unsigned long)sc->top_sense & (PAGE_SIZE-1));
L
Linus Torvalds 已提交
1457
	scmd->len = UB_SENSE_SIZE;
1458
	scmd->lun = cmd->lun;
L
Linus Torvalds 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
	scmd->done = ub_top_sense_done;
	scmd->back = cmd;

	scmd->tag = sc->tagcnt++;

	cmd->state = UB_CMDST_SENSE;

	ub_cmdq_insert(sc, scmd);
	return;

error:
	ub_state_done(sc, cmd, rc);
}

/*
 * A helper for the command's state machine:
 * Submit a stall clear.
 */
static int ub_submit_clear_stall(struct ub_dev *sc, struct ub_scsi_cmd *cmd,
    int stalled_pipe)
{
	int endp;
	struct usb_ctrlrequest *cr;
	int rc;

	endp = usb_pipeendpoint(stalled_pipe);
	if (usb_pipein (stalled_pipe))
		endp |= USB_DIR_IN;

	cr = &sc->work_cr;
	cr->bRequestType = USB_RECIP_ENDPOINT;
	cr->bRequest = USB_REQ_CLEAR_FEATURE;
	cr->wValue = cpu_to_le16(USB_ENDPOINT_HALT);
	cr->wIndex = cpu_to_le16(endp);
	cr->wLength = cpu_to_le16(0);

	UB_INIT_COMPLETION(sc->work_done);

	usb_fill_control_urb(&sc->work_urb, sc->dev, sc->send_ctrl_pipe,
	    (unsigned char*) cr, NULL, 0, ub_urb_complete, sc);

	if ((rc = usb_submit_urb(&sc->work_urb, GFP_ATOMIC)) != 0) {
		ub_complete(&sc->work_done);
		return rc;
	}

	sc->work_timer.expires = jiffies + UB_CTRL_TIMEOUT;
	add_timer(&sc->work_timer);
	return 0;
}

/*
 */
static void ub_top_sense_done(struct ub_dev *sc, struct ub_scsi_cmd *scmd)
{
1514
	unsigned char *sense = sc->top_sense;
L
Linus Torvalds 已提交
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526
	struct ub_scsi_cmd *cmd;

	/*
	 * Find the command which triggered the unit attention or a check,
	 * save the sense into it, and advance its state machine.
	 */
	if ((cmd = ub_cmdq_peek(sc)) == NULL) {
		printk(KERN_WARNING "%s: sense done while idle\n", sc->name);
		return;
	}
	if (cmd != scmd->back) {
		printk(KERN_WARNING "%s: "
1527 1528
		    "sense done for wrong command 0x%x\n",
		    sc->name, cmd->tag);
L
Linus Torvalds 已提交
1529 1530 1531
		return;
	}
	if (cmd->state != UB_CMDST_SENSE) {
P
Pete Zaitcev 已提交
1532
		printk(KERN_WARNING "%s: sense done with bad cmd state %d\n",
1533
		    sc->name, cmd->state);
L
Linus Torvalds 已提交
1534 1535 1536
		return;
	}

P
Pete Zaitcev 已提交
1537 1538 1539
	/*
	 * Ignoring scmd->act_len, because the buffer was pre-zeroed.
	 */
L
Linus Torvalds 已提交
1540 1541 1542 1543 1544 1545 1546
	cmd->key = sense[2] & 0x0F;
	cmd->asc = sense[12];
	cmd->ascq = sense[13];

	ub_scsi_urb_compl(sc, cmd);
}

1547 1548 1549 1550
/*
 * Reset management
 */

P
Pete Zaitcev 已提交
1551
static void ub_reset_enter(struct ub_dev *sc, int try)
1552 1553 1554 1555 1556 1557
{

	if (sc->reset) {
		/* This happens often on multi-LUN devices. */
		return;
	}
P
Pete Zaitcev 已提交
1558
	sc->reset = try + 1;
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568

#if 0 /* Not needed because the disconnect waits for us. */
	unsigned long flags;
	spin_lock_irqsave(&ub_lock, flags);
	sc->openc++;
	spin_unlock_irqrestore(&ub_lock, flags);
#endif

#if 0 /* We let them stop themselves. */
	struct ub_lun *lun;
1569
	list_for_each_entry(lun, &sc->luns, link) {
1570 1571 1572 1573 1574 1575 1576
		blk_stop_queue(lun->disk->queue);
	}
#endif

	schedule_work(&sc->reset_work);
}

D
David Howells 已提交
1577
static void ub_reset_task(struct work_struct *work)
1578
{
D
David Howells 已提交
1579
	struct ub_dev *sc = container_of(work, struct ub_dev, reset_work);
1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
	unsigned long flags;
	struct ub_lun *lun;
	int lkr, rc;

	if (!sc->reset) {
		printk(KERN_WARNING "%s: Running reset unrequested\n",
		    sc->name);
		return;
	}

	if (atomic_read(&sc->poison)) {
P
Pete Zaitcev 已提交
1591
		;
P
Pete Zaitcev 已提交
1592 1593 1594 1595 1596
	} else if ((sc->reset & 1) == 0) {
		ub_sync_reset(sc);
		msleep(700);	/* usb-storage sleeps 6s (!) */
		ub_probe_clear_stall(sc, sc->recv_bulk_pipe);
		ub_probe_clear_stall(sc, sc->send_bulk_pipe);
1597
	} else if (sc->dev->actconfig->desc.bNumInterfaces != 1) {
P
Pete Zaitcev 已提交
1598
		;
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
	} else {
		if ((lkr = usb_lock_device_for_reset(sc->dev, sc->intf)) < 0) {
			printk(KERN_NOTICE
			    "%s: usb_lock_device_for_reset failed (%d)\n",
			    sc->name, lkr);
		} else {
			rc = usb_reset_device(sc->dev);
			if (rc < 0) {
				printk(KERN_NOTICE "%s: "
				    "usb_lock_device_for_reset failed (%d)\n",
				    sc->name, rc);
			}

			if (lkr)
				usb_unlock_device(sc->dev);
		}
	}

	/*
	 * In theory, no commands can be running while reset is active,
	 * so nobody can ask for another reset, and so we do not need any
	 * queues of resets or anything. We do need a spinlock though,
	 * to interact with block layer.
	 */
P
Pete Zaitcev 已提交
1623
	spin_lock_irqsave(sc->lock, flags);
1624 1625
	sc->reset = 0;
	tasklet_schedule(&sc->tasklet);
1626
	list_for_each_entry(lun, &sc->luns, link) {
1627 1628 1629
		blk_start_queue(lun->disk->queue);
	}
	wake_up(&sc->reset_wait);
P
Pete Zaitcev 已提交
1630
	spin_unlock_irqrestore(sc->lock, flags);
1631 1632
}

1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
/*
 * XXX Reset brackets are too much hassle to implement, so just stub them
 * in order to prevent forced unbinding (which deadlocks solid when our
 * ->disconnect method waits for the reset to complete and this kills keventd).
 *
 * XXX Tell Alan to move usb_unlock_device inside of usb_reset_device,
 * or else the post_reset is invoked, and restats I/O on a locked device.
 */
static int ub_pre_reset(struct usb_interface *iface) {
	return 0;
}

static int ub_post_reset(struct usb_interface *iface) {
	return 0;
}

L
Linus Torvalds 已提交
1649 1650 1651
/*
 * This is called from a process context.
 */
1652
static void ub_revalidate(struct ub_dev *sc, struct ub_lun *lun)
L
Linus Torvalds 已提交
1653 1654
{

1655
	lun->readonly = 0;	/* XXX Query this from the device */
L
Linus Torvalds 已提交
1656

1657 1658 1659
	lun->capacity.nsec = 0;
	lun->capacity.bsize = 512;
	lun->capacity.bshift = 0;
L
Linus Torvalds 已提交
1660

1661
	if (ub_sync_tur(sc, lun) != 0)
L
Linus Torvalds 已提交
1662
		return;			/* Not ready */
1663
	lun->changed = 0;
L
Linus Torvalds 已提交
1664

1665
	if (ub_sync_read_cap(sc, lun, &lun->capacity) != 0) {
L
Linus Torvalds 已提交
1666 1667 1668 1669 1670
		/*
		 * The retry here means something is wrong, either with the
		 * device, with the transport, or with our code.
		 * We keep this because sd.c has retries for capacity.
		 */
1671 1672 1673 1674
		if (ub_sync_read_cap(sc, lun, &lun->capacity) != 0) {
			lun->capacity.nsec = 0;
			lun->capacity.bsize = 512;
			lun->capacity.bshift = 0;
L
Linus Torvalds 已提交
1675 1676 1677 1678 1679 1680 1681 1682 1683
		}
	}
}

/*
 * The open funcion.
 * This is mostly needed to keep refcounting, but also to support
 * media checks on removable media drives.
 */
A
Al Viro 已提交
1684
static int ub_bd_open(struct block_device *bdev, fmode_t mode)
L
Linus Torvalds 已提交
1685
{
A
Al Viro 已提交
1686
	struct ub_lun *lun = bdev->bd_disk->private_data;
1687
	struct ub_dev *sc = lun->udev;
L
Linus Torvalds 已提交
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
	unsigned long flags;
	int rc;

	spin_lock_irqsave(&ub_lock, flags);
	if (atomic_read(&sc->poison)) {
		spin_unlock_irqrestore(&ub_lock, flags);
		return -ENXIO;
	}
	sc->openc++;
	spin_unlock_irqrestore(&ub_lock, flags);

1699
	if (lun->removable || lun->readonly)
A
Al Viro 已提交
1700
		check_disk_change(bdev);
L
Linus Torvalds 已提交
1701 1702 1703 1704 1705 1706

	/*
	 * The sd.c considers ->media_present and ->changed not equivalent,
	 * under some pretty murky conditions (a failure of READ CAPACITY).
	 * We may need it one day.
	 */
A
Al Viro 已提交
1707
	if (lun->removable && lun->changed && !(mode & FMODE_NDELAY)) {
L
Linus Torvalds 已提交
1708 1709 1710 1711
		rc = -ENOMEDIUM;
		goto err_open;
	}

A
Al Viro 已提交
1712
	if (lun->readonly && (mode & FMODE_WRITE)) {
L
Linus Torvalds 已提交
1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
		rc = -EROFS;
		goto err_open;
	}

	return 0;

err_open:
	ub_put(sc);
	return rc;
}

/*
 */
A
Al Viro 已提交
1726
static int ub_bd_release(struct gendisk *disk, fmode_t mode)
L
Linus Torvalds 已提交
1727
{
1728 1729
	struct ub_lun *lun = disk->private_data;
	struct ub_dev *sc = lun->udev;
L
Linus Torvalds 已提交
1730 1731 1732 1733 1734 1735 1736 1737

	ub_put(sc);
	return 0;
}

/*
 * The ioctl interface.
 */
A
Al Viro 已提交
1738
static int ub_bd_ioctl(struct block_device *bdev, fmode_t mode,
L
Linus Torvalds 已提交
1739 1740
    unsigned int cmd, unsigned long arg)
{
A
Al Viro 已提交
1741
	struct gendisk *disk = bdev->bd_disk;
L
Linus Torvalds 已提交
1742 1743
	void __user *usermem = (void __user *) arg;

A
Al Viro 已提交
1744
	return scsi_cmd_ioctl(disk->queue, disk, mode, cmd, usermem);
L
Linus Torvalds 已提交
1745 1746 1747
}

/*
P
Pete Zaitcev 已提交
1748
 * This is called by check_disk_change if we reported a media change.
L
Linus Torvalds 已提交
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758
 * The main onjective here is to discover the features of the media such as
 * the capacity, read-only status, etc. USB storage generally does not
 * need to be spun up, but if we needed it, this would be the place.
 *
 * This call can sleep.
 *
 * The return code is not used.
 */
static int ub_bd_revalidate(struct gendisk *disk)
{
1759 1760 1761
	struct ub_lun *lun = disk->private_data;

	ub_revalidate(lun->udev, lun);
L
Linus Torvalds 已提交
1762 1763

	/* XXX Support sector size switching like in sr.c */
1764 1765 1766
	blk_queue_hardsect_size(disk->queue, lun->capacity.bsize);
	set_capacity(disk, lun->capacity.nsec);
	// set_disk_ro(sdkp->disk, lun->readonly);
L
Linus Torvalds 已提交
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781

	return 0;
}

/*
 * The check is called by the block layer to verify if the media
 * is still available. It is supposed to be harmless, lightweight and
 * non-intrusive in case the media was not changed.
 *
 * This call can sleep.
 *
 * The return code is bool!
 */
static int ub_bd_media_changed(struct gendisk *disk)
{
1782
	struct ub_lun *lun = disk->private_data;
L
Linus Torvalds 已提交
1783

1784
	if (!lun->removable)
L
Linus Torvalds 已提交
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
		return 0;

	/*
	 * We clean checks always after every command, so this is not
	 * as dangerous as it looks. If the TEST_UNIT_READY fails here,
	 * the device is actually not ready with operator or software
	 * intervention required. One dangerous item might be a drive which
	 * spins itself down, and come the time to write dirty pages, this
	 * will fail, then block layer discards the data. Since we never
	 * spin drives up, such devices simply cannot be used with ub anyway.
	 */
1796 1797
	if (ub_sync_tur(lun->udev, lun) != 0) {
		lun->changed = 1;
L
Linus Torvalds 已提交
1798 1799 1800
		return 1;
	}

1801
	return lun->changed;
L
Linus Torvalds 已提交
1802 1803 1804 1805
}

static struct block_device_operations ub_bd_fops = {
	.owner		= THIS_MODULE,
A
Al Viro 已提交
1806 1807 1808
	.open		= ub_bd_open,
	.release	= ub_bd_release,
	.locked_ioctl	= ub_bd_ioctl,
L
Linus Torvalds 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
	.media_changed	= ub_bd_media_changed,
	.revalidate_disk = ub_bd_revalidate,
};

/*
 * Common ->done routine for commands executed synchronously.
 */
static void ub_probe_done(struct ub_dev *sc, struct ub_scsi_cmd *cmd)
{
	struct completion *cop = cmd->back;
	complete(cop);
}

/*
 * Test if the device has a check condition on it, synchronously.
 */
1825
static int ub_sync_tur(struct ub_dev *sc, struct ub_lun *lun)
L
Linus Torvalds 已提交
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
{
	struct ub_scsi_cmd *cmd;
	enum { ALLOC_SIZE = sizeof(struct ub_scsi_cmd) };
	unsigned long flags;
	struct completion compl;
	int rc;

	init_completion(&compl);

	rc = -ENOMEM;
P
Pete Zaitcev 已提交
1836
	if ((cmd = kzalloc(ALLOC_SIZE, GFP_KERNEL)) == NULL)
L
Linus Torvalds 已提交
1837 1838 1839 1840 1841 1842
		goto err_alloc;

	cmd->cdb[0] = TEST_UNIT_READY;
	cmd->cdb_len = 6;
	cmd->dir = UB_DIR_NONE;
	cmd->state = UB_CMDST_INIT;
1843
	cmd->lun = lun;			/* This may be NULL, but that's ok */
L
Linus Torvalds 已提交
1844 1845 1846
	cmd->done = ub_probe_done;
	cmd->back = &compl;

P
Pete Zaitcev 已提交
1847
	spin_lock_irqsave(sc->lock, flags);
L
Linus Torvalds 已提交
1848 1849 1850
	cmd->tag = sc->tagcnt++;

	rc = ub_submit_scsi(sc, cmd);
P
Pete Zaitcev 已提交
1851
	spin_unlock_irqrestore(sc->lock, flags);
L
Linus Torvalds 已提交
1852

P
Pete Zaitcev 已提交
1853
	if (rc != 0)
L
Linus Torvalds 已提交
1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
		goto err_submit;

	wait_for_completion(&compl);

	rc = cmd->error;

	if (rc == -EIO && cmd->key != 0)	/* Retries for benh's key */
		rc = cmd->key;

err_submit:
	kfree(cmd);
err_alloc:
	return rc;
}

/*
 * Read the SCSI capacity synchronously (for probing).
 */
1872 1873
static int ub_sync_read_cap(struct ub_dev *sc, struct ub_lun *lun,
    struct ub_capacity *ret)
L
Linus Torvalds 已提交
1874 1875
{
	struct ub_scsi_cmd *cmd;
1876
	struct scatterlist *sg;
L
Linus Torvalds 已提交
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
	char *p;
	enum { ALLOC_SIZE = sizeof(struct ub_scsi_cmd) + 8 };
	unsigned long flags;
	unsigned int bsize, shift;
	unsigned long nsec;
	struct completion compl;
	int rc;

	init_completion(&compl);

	rc = -ENOMEM;
P
Pete Zaitcev 已提交
1888
	if ((cmd = kzalloc(ALLOC_SIZE, GFP_KERNEL)) == NULL)
L
Linus Torvalds 已提交
1889 1890 1891 1892 1893 1894 1895
		goto err_alloc;
	p = (char *)cmd + sizeof(struct ub_scsi_cmd);

	cmd->cdb[0] = 0x25;
	cmd->cdb_len = 10;
	cmd->dir = UB_DIR_READ;
	cmd->state = UB_CMDST_INIT;
1896 1897
	cmd->nsg = 1;
	sg = &cmd->sgv[0];
1898
	sg_init_table(sg, UB_MAX_REQ_SG);
1899
	sg_set_page(sg, virt_to_page(p), 8, (unsigned long)p & (PAGE_SIZE-1));
L
Linus Torvalds 已提交
1900
	cmd->len = 8;
1901
	cmd->lun = lun;
L
Linus Torvalds 已提交
1902 1903 1904
	cmd->done = ub_probe_done;
	cmd->back = &compl;

P
Pete Zaitcev 已提交
1905
	spin_lock_irqsave(sc->lock, flags);
L
Linus Torvalds 已提交
1906 1907 1908
	cmd->tag = sc->tagcnt++;

	rc = ub_submit_scsi(sc, cmd);
P
Pete Zaitcev 已提交
1909
	spin_unlock_irqrestore(sc->lock, flags);
L
Linus Torvalds 已提交
1910

P
Pete Zaitcev 已提交
1911
	if (rc != 0)
L
Linus Torvalds 已提交
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
		goto err_submit;

	wait_for_completion(&compl);

	if (cmd->error != 0) {
		rc = -EIO;
		goto err_read;
	}
	if (cmd->act_len != 8) {
		rc = -EIO;
		goto err_read;
	}

	/* sd.c special-cases sector size of 0 to mean 512. Needed? Safe? */
	nsec = be32_to_cpu(*(__be32 *)p) + 1;
	bsize = be32_to_cpu(*(__be32 *)(p + 4));
	switch (bsize) {
	case 512:	shift = 0;	break;
	case 1024:	shift = 1;	break;
	case 2048:	shift = 2;	break;
	case 4096:	shift = 3;	break;
	default:
		rc = -EDOM;
		goto err_inv_bsize;
	}

	ret->bsize = bsize;
	ret->bshift = shift;
	ret->nsec = nsec << shift;
	rc = 0;

err_inv_bsize:
err_read:
err_submit:
	kfree(cmd);
err_alloc:
	return rc;
}

/*
 */
1953
static void ub_probe_urb_complete(struct urb *urb)
L
Linus Torvalds 已提交
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
{
	struct completion *cop = urb->context;
	complete(cop);
}

static void ub_probe_timeout(unsigned long arg)
{
	struct completion *cop = (struct completion *) arg;
	complete(cop);
}

P
Pete Zaitcev 已提交
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
/*
 * Reset with a Bulk reset.
 */
static int ub_sync_reset(struct ub_dev *sc)
{
	int ifnum = sc->intf->cur_altsetting->desc.bInterfaceNumber;
	struct usb_ctrlrequest *cr;
	struct completion compl;
	struct timer_list timer;
	int rc;

	init_completion(&compl);

	cr = &sc->work_cr;
	cr->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE;
	cr->bRequest = US_BULK_RESET_REQUEST;
	cr->wValue = cpu_to_le16(0);
	cr->wIndex = cpu_to_le16(ifnum);
	cr->wLength = cpu_to_le16(0);

	usb_fill_control_urb(&sc->work_urb, sc->dev, sc->send_ctrl_pipe,
	    (unsigned char*) cr, NULL, 0, ub_probe_urb_complete, &compl);

	if ((rc = usb_submit_urb(&sc->work_urb, GFP_KERNEL)) != 0) {
		printk(KERN_WARNING
		     "%s: Unable to submit a bulk reset (%d)\n", sc->name, rc);
		return rc;
	}

	init_timer(&timer);
	timer.function = ub_probe_timeout;
	timer.data = (unsigned long) &compl;
	timer.expires = jiffies + UB_CTRL_TIMEOUT;
	add_timer(&timer);

	wait_for_completion(&compl);

	del_timer_sync(&timer);
	usb_kill_urb(&sc->work_urb);

	return sc->work_urb.status;
}

2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038
/*
 * Get number of LUNs by the way of Bulk GetMaxLUN command.
 */
static int ub_sync_getmaxlun(struct ub_dev *sc)
{
	int ifnum = sc->intf->cur_altsetting->desc.bInterfaceNumber;
	unsigned char *p;
	enum { ALLOC_SIZE = 1 };
	struct usb_ctrlrequest *cr;
	struct completion compl;
	struct timer_list timer;
	int nluns;
	int rc;

	init_completion(&compl);

	rc = -ENOMEM;
	if ((p = kmalloc(ALLOC_SIZE, GFP_KERNEL)) == NULL)
		goto err_alloc;
	*p = 55;

	cr = &sc->work_cr;
	cr->bRequestType = USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE;
	cr->bRequest = US_BULK_GET_MAX_LUN;
	cr->wValue = cpu_to_le16(0);
	cr->wIndex = cpu_to_le16(ifnum);
	cr->wLength = cpu_to_le16(1);

	usb_fill_control_urb(&sc->work_urb, sc->dev, sc->recv_ctrl_pipe,
	    (unsigned char*) cr, p, 1, ub_probe_urb_complete, &compl);

P
Pete Zaitcev 已提交
2039
	if ((rc = usb_submit_urb(&sc->work_urb, GFP_KERNEL)) != 0)
2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
		goto err_submit;

	init_timer(&timer);
	timer.function = ub_probe_timeout;
	timer.data = (unsigned long) &compl;
	timer.expires = jiffies + UB_CTRL_TIMEOUT;
	add_timer(&timer);

	wait_for_completion(&compl);

	del_timer_sync(&timer);
	usb_kill_urb(&sc->work_urb);

P
Pete Zaitcev 已提交
2053
	if ((rc = sc->work_urb.status) < 0)
P
Pete Zaitcev 已提交
2054 2055
		goto err_io;

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
	if (sc->work_urb.actual_length != 1) {
		nluns = 0;
	} else {
		if ((nluns = *p) == 55) {
			nluns = 0;
		} else {
  			/* GetMaxLUN returns the maximum LUN number */
			nluns += 1;
			if (nluns > UB_MAX_LUNS)
				nluns = UB_MAX_LUNS;
		}
	}

	kfree(p);
	return nluns;

P
Pete Zaitcev 已提交
2072
err_io:
2073 2074 2075 2076 2077 2078
err_submit:
	kfree(p);
err_alloc:
	return rc;
}

L
Linus Torvalds 已提交
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152
/*
 * Clear initial stalls.
 */
static int ub_probe_clear_stall(struct ub_dev *sc, int stalled_pipe)
{
	int endp;
	struct usb_ctrlrequest *cr;
	struct completion compl;
	struct timer_list timer;
	int rc;

	init_completion(&compl);

	endp = usb_pipeendpoint(stalled_pipe);
	if (usb_pipein (stalled_pipe))
		endp |= USB_DIR_IN;

	cr = &sc->work_cr;
	cr->bRequestType = USB_RECIP_ENDPOINT;
	cr->bRequest = USB_REQ_CLEAR_FEATURE;
	cr->wValue = cpu_to_le16(USB_ENDPOINT_HALT);
	cr->wIndex = cpu_to_le16(endp);
	cr->wLength = cpu_to_le16(0);

	usb_fill_control_urb(&sc->work_urb, sc->dev, sc->send_ctrl_pipe,
	    (unsigned char*) cr, NULL, 0, ub_probe_urb_complete, &compl);

	if ((rc = usb_submit_urb(&sc->work_urb, GFP_KERNEL)) != 0) {
		printk(KERN_WARNING
		     "%s: Unable to submit a probe clear (%d)\n", sc->name, rc);
		return rc;
	}

	init_timer(&timer);
	timer.function = ub_probe_timeout;
	timer.data = (unsigned long) &compl;
	timer.expires = jiffies + UB_CTRL_TIMEOUT;
	add_timer(&timer);

	wait_for_completion(&compl);

	del_timer_sync(&timer);
	usb_kill_urb(&sc->work_urb);

	/* reset the endpoint toggle */
	usb_settoggle(sc->dev, endp, usb_pipeout(sc->last_pipe), 0);

	return 0;
}

/*
 * Get the pipe settings.
 */
static int ub_get_pipes(struct ub_dev *sc, struct usb_device *dev,
    struct usb_interface *intf)
{
	struct usb_host_interface *altsetting = intf->cur_altsetting;
	struct usb_endpoint_descriptor *ep_in = NULL;
	struct usb_endpoint_descriptor *ep_out = NULL;
	struct usb_endpoint_descriptor *ep;
	int i;

	/*
	 * Find the endpoints we need.
	 * We are expecting a minimum of 2 endpoints - in and out (bulk).
	 * We will ignore any others.
	 */
	for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
		ep = &altsetting->endpoint[i].desc;

		/* Is it a BULK endpoint? */
		if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
				== USB_ENDPOINT_XFER_BULK) {
			/* BULK in or out? */
2153 2154 2155 2156 2157 2158 2159
			if (ep->bEndpointAddress & USB_DIR_IN) {
				if (ep_in == NULL)
					ep_in = ep;
			} else {
				if (ep_out == NULL)
					ep_out = ep;
			}
L
Linus Torvalds 已提交
2160 2161 2162 2163
		}
	}

	if (ep_in == NULL || ep_out == NULL) {
P
Pete Zaitcev 已提交
2164
		printk(KERN_NOTICE "%s: failed endpoint check\n", sc->name);
2165
		return -ENODEV;
L
Linus Torvalds 已提交
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186
	}

	/* Calculate and store the pipe values */
	sc->send_ctrl_pipe = usb_sndctrlpipe(dev, 0);
	sc->recv_ctrl_pipe = usb_rcvctrlpipe(dev, 0);
	sc->send_bulk_pipe = usb_sndbulkpipe(dev,
		ep_out->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
	sc->recv_bulk_pipe = usb_rcvbulkpipe(dev, 
		ep_in->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);

	return 0;
}

/*
 * Probing is done in the process context, which allows us to cheat
 * and not to build a state machine for the discovery.
 */
static int ub_probe(struct usb_interface *intf,
    const struct usb_device_id *dev_id)
{
	struct ub_dev *sc;
2187
	int nluns;
L
Linus Torvalds 已提交
2188 2189 2190
	int rc;
	int i;

2191 2192 2193
	if (usb_usual_check_type(dev_id, USB_US_TYPE_UB))
		return -ENXIO;

L
Linus Torvalds 已提交
2194
	rc = -ENOMEM;
P
Pete Zaitcev 已提交
2195
	if ((sc = kzalloc(sizeof(struct ub_dev), GFP_KERNEL)) == NULL)
L
Linus Torvalds 已提交
2196
		goto err_core;
P
Pete Zaitcev 已提交
2197
	sc->lock = ub_next_lock();
2198
	INIT_LIST_HEAD(&sc->luns);
L
Linus Torvalds 已提交
2199 2200 2201
	usb_init_urb(&sc->work_urb);
	tasklet_init(&sc->tasklet, ub_scsi_action, (unsigned long)sc);
	atomic_set(&sc->poison, 0);
D
David Howells 已提交
2202
	INIT_WORK(&sc->reset_work, ub_reset_task);
2203
	init_waitqueue_head(&sc->reset_wait);
L
Linus Torvalds 已提交
2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216

	init_timer(&sc->work_timer);
	sc->work_timer.data = (unsigned long) sc;
	sc->work_timer.function = ub_urb_timeout;

	ub_init_completion(&sc->work_done);
	sc->work_done.done = 1;		/* A little yuk, but oh well... */

	sc->dev = interface_to_usbdev(intf);
	sc->intf = intf;
	// sc->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
	usb_set_intfdata(intf, sc);
	usb_get_dev(sc->dev);
2217 2218 2219 2220 2221 2222
	/*
	 * Since we give the interface struct to the block level through
	 * disk->driverfs_dev, we have to pin it. Otherwise, block_uevent
	 * oopses on close after a disconnect (kernels 2.6.16 and up).
	 */
	usb_get_intf(sc->intf);
L
Linus Torvalds 已提交
2223

2224 2225 2226
	snprintf(sc->name, 12, DRV_NAME "(%d.%d)",
	    sc->dev->bus->busnum, sc->dev->devnum);

L
Linus Torvalds 已提交
2227 2228
	/* XXX Verify that we can handle the device (from descriptors) */

2229 2230
	if (ub_get_pipes(sc, sc->dev, intf) != 0)
		goto err_dev_desc;
L
Linus Torvalds 已提交
2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242

	/*
	 * At this point, all USB initialization is done, do upper layer.
	 * We really hate halfway initialized structures, so from the
	 * invariants perspective, this ub_dev is fully constructed at
	 * this point.
	 */

	/*
	 * This is needed to clear toggles. It is a problem only if we do
	 * `rmmod ub && modprobe ub` without disconnects, but we like that.
	 */
2243
#if 0 /* iPod Mini fails if we do this (big white iPod works) */
L
Linus Torvalds 已提交
2244 2245
	ub_probe_clear_stall(sc, sc->recv_bulk_pipe);
	ub_probe_clear_stall(sc, sc->send_bulk_pipe);
2246
#endif
L
Linus Torvalds 已提交
2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262

	/*
	 * The way this is used by the startup code is a little specific.
	 * A SCSI check causes a USB stall. Our common case code sees it
	 * and clears the check, after which the device is ready for use.
	 * But if a check was not present, any command other than
	 * TEST_UNIT_READY ends with a lockup (including REQUEST_SENSE).
	 *
	 * If we neglect to clear the SCSI check, the first real command fails
	 * (which is the capacity readout). We clear that and retry, but why
	 * causing spurious retries for no reason.
	 *
	 * Revalidation may start with its own TEST_UNIT_READY, but that one
	 * has to succeed, so we clear checks with an additional one here.
	 * In any case it's not our business how revaliadation is implemented.
	 */
P
Pete Zaitcev 已提交
2263
	for (i = 0; i < 3; i++) {  /* Retries for the schwag key from KS'04 */
2264
		if ((rc = ub_sync_tur(sc, NULL)) <= 0) break;
L
Linus Torvalds 已提交
2265 2266 2267 2268
		if (rc != 0x6) break;
		msleep(10);
	}

2269 2270
	nluns = 1;
	for (i = 0; i < 3; i++) {
2271
		if ((rc = ub_sync_getmaxlun(sc)) < 0)
2272 2273 2274 2275 2276
			break;
		if (rc != 0) {
			nluns = rc;
			break;
		}
P
Pete Zaitcev 已提交
2277
		msleep(100);
2278
	}
L
Linus Torvalds 已提交
2279

2280 2281 2282 2283 2284
	for (i = 0; i < nluns; i++) {
		ub_probe_lun(sc, i);
	}
	return 0;

2285
err_dev_desc:
2286
	usb_set_intfdata(intf, NULL);
2287
	usb_put_intf(sc->intf);
2288 2289 2290 2291 2292 2293 2294 2295 2296
	usb_put_dev(sc->dev);
	kfree(sc);
err_core:
	return rc;
}

static int ub_probe_lun(struct ub_dev *sc, int lnum)
{
	struct ub_lun *lun;
2297
	struct request_queue *q;
2298 2299 2300 2301
	struct gendisk *disk;
	int rc;

	rc = -ENOMEM;
P
Pete Zaitcev 已提交
2302
	if ((lun = kzalloc(sizeof(struct ub_lun), GFP_KERNEL)) == NULL)
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317
		goto err_alloc;
	lun->num = lnum;

	rc = -ENOSR;
	if ((lun->id = ub_id_get()) == -1)
		goto err_id;

	lun->udev = sc;

	snprintf(lun->name, 16, DRV_NAME "%c(%d.%d.%d)",
	    lun->id + 'a', sc->dev->bus->busnum, sc->dev->devnum, lun->num);

	lun->removable = 1;		/* XXX Query this from the device */
	lun->changed = 1;		/* ub_revalidate clears only */
	ub_revalidate(sc, lun);
L
Linus Torvalds 已提交
2318 2319

	rc = -ENOMEM;
P
Pete Zaitcev 已提交
2320
	if ((disk = alloc_disk(UB_PARTS_PER_LUN)) == NULL)
L
Linus Torvalds 已提交
2321 2322
		goto err_diskalloc;

2323
	sprintf(disk->disk_name, DRV_NAME "%c", lun->id + 'a');
L
Linus Torvalds 已提交
2324
	disk->major = UB_MAJOR;
P
Pete Zaitcev 已提交
2325
	disk->first_minor = lun->id * UB_PARTS_PER_LUN;
L
Linus Torvalds 已提交
2326
	disk->fops = &ub_bd_fops;
2327
	disk->private_data = lun;
P
Pete Zaitcev 已提交
2328
	disk->driverfs_dev = &sc->intf->dev;
L
Linus Torvalds 已提交
2329 2330

	rc = -ENOMEM;
P
Pete Zaitcev 已提交
2331
	if ((q = blk_init_queue(ub_request_fn, sc->lock)) == NULL)
L
Linus Torvalds 已提交
2332 2333 2334 2335
		goto err_blkqinit;

	disk->queue = q;

2336
	blk_queue_bounce_limit(q, BLK_BOUNCE_HIGH);
L
Linus Torvalds 已提交
2337 2338
	blk_queue_max_hw_segments(q, UB_MAX_REQ_SG);
	blk_queue_max_phys_segments(q, UB_MAX_REQ_SG);
2339
	blk_queue_segment_boundary(q, 0xffffffff);	/* Dubious. */
L
Linus Torvalds 已提交
2340
	blk_queue_max_sectors(q, UB_MAX_SECTORS);
2341
	blk_queue_hardsect_size(q, lun->capacity.bsize);
L
Linus Torvalds 已提交
2342

P
Pete Zaitcev 已提交
2343
	lun->disk = disk;
2344
	q->queuedata = lun;
P
Pete Zaitcev 已提交
2345
	list_add(&lun->link, &sc->luns);
L
Linus Torvalds 已提交
2346

2347 2348
	set_capacity(disk, lun->capacity.nsec);
	if (lun->removable)
L
Linus Torvalds 已提交
2349 2350 2351 2352 2353 2354 2355 2356 2357
		disk->flags |= GENHD_FL_REMOVABLE;

	add_disk(disk);

	return 0;

err_blkqinit:
	put_disk(disk);
err_diskalloc:
2358
	ub_id_put(lun->id);
L
Linus Torvalds 已提交
2359
err_id:
2360 2361
	kfree(lun);
err_alloc:
L
Linus Torvalds 已提交
2362 2363 2364 2365 2366 2367
	return rc;
}

static void ub_disconnect(struct usb_interface *intf)
{
	struct ub_dev *sc = usb_get_intfdata(intf);
2368
	struct ub_lun *lun;
L
Linus Torvalds 已提交
2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
	unsigned long flags;

	/*
	 * Prevent ub_bd_release from pulling the rug from under us.
	 * XXX This is starting to look like a kref.
	 * XXX Why not to take this ref at probe time?
	 */
	spin_lock_irqsave(&ub_lock, flags);
	sc->openc++;
	spin_unlock_irqrestore(&ub_lock, flags);

	/*
P
Pete Zaitcev 已提交
2381
	 * Fence stall clearings, operations triggered by unlinkings and so on.
L
Linus Torvalds 已提交
2382 2383 2384 2385 2386
	 * We do not attempt to unlink any URBs, because we do not trust the
	 * unlink paths in HC drivers. Also, we get -84 upon disconnect anyway.
	 */
	atomic_set(&sc->poison, 1);

2387 2388 2389 2390 2391
	/*
	 * Wait for reset to end, if any.
	 */
	wait_event(sc->reset_wait, !sc->reset);

L
Linus Torvalds 已提交
2392 2393 2394 2395 2396 2397 2398 2399 2400
	/*
	 * Blow away queued commands.
	 *
	 * Actually, this never works, because before we get here
	 * the HCD terminates outstanding URB(s). It causes our
	 * SCSI command queue to advance, commands fail to submit,
	 * and the whole queue drains. So, we just use this code to
	 * print warnings.
	 */
P
Pete Zaitcev 已提交
2401
	spin_lock_irqsave(sc->lock, flags);
L
Linus Torvalds 已提交
2402 2403 2404
	{
		struct ub_scsi_cmd *cmd;
		int cnt = 0;
2405
		while ((cmd = ub_cmdq_peek(sc)) != NULL) {
L
Linus Torvalds 已提交
2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416
			cmd->error = -ENOTCONN;
			cmd->state = UB_CMDST_DONE;
			ub_cmdq_pop(sc);
			(*cmd->done)(sc, cmd);
			cnt++;
		}
		if (cnt != 0) {
			printk(KERN_WARNING "%s: "
			    "%d was queued after shutdown\n", sc->name, cnt);
		}
	}
P
Pete Zaitcev 已提交
2417
	spin_unlock_irqrestore(sc->lock, flags);
L
Linus Torvalds 已提交
2418 2419 2420 2421

	/*
	 * Unregister the upper layer.
	 */
2422
	list_for_each_entry(lun, &sc->luns, link) {
P
Pete Zaitcev 已提交
2423
		del_gendisk(lun->disk);
2424 2425
		/*
		 * I wish I could do:
N
Nick Piggin 已提交
2426
		 *    queue_flag_set(QUEUE_FLAG_DEAD, q);
2427 2428 2429 2430
		 * As it is, we rely on our internal poisoning and let
		 * the upper levels to spin furiously failing all the I/O.
		 */
	}
L
Linus Torvalds 已提交
2431 2432 2433 2434 2435

	/*
	 * Testing for -EINPROGRESS is always a bug, so we are bending
	 * the rules a little.
	 */
P
Pete Zaitcev 已提交
2436
	spin_lock_irqsave(sc->lock, flags);
L
Linus Torvalds 已提交
2437 2438 2439 2440
	if (sc->work_urb.status == -EINPROGRESS) {	/* janitors: ignore */
		printk(KERN_WARNING "%s: "
		    "URB is active after disconnect\n", sc->name);
	}
P
Pete Zaitcev 已提交
2441
	spin_unlock_irqrestore(sc->lock, flags);
L
Linus Torvalds 已提交
2442 2443

	/*
P
Pete Zaitcev 已提交
2444
	 * There is virtually no chance that other CPU runs a timeout so long
L
Linus Torvalds 已提交
2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
	 * after ub_urb_complete should have called del_timer, but only if HCD
	 * didn't forget to deliver a callback on unlink.
	 */
	del_timer_sync(&sc->work_timer);

	/*
	 * At this point there must be no commands coming from anyone
	 * and no URBs left in transit.
	 */

	ub_put(sc);
}

static struct usb_driver ub_driver = {
	.name =		"ub",
	.probe =	ub_probe,
	.disconnect =	ub_disconnect,
	.id_table =	ub_usb_ids,
2463 2464
	.pre_reset =	ub_pre_reset,
	.post_reset =	ub_post_reset,
L
Linus Torvalds 已提交
2465 2466 2467 2468 2469
};

static int __init ub_init(void)
{
	int rc;
P
Pete Zaitcev 已提交
2470 2471 2472 2473
	int i;

	for (i = 0; i < UB_QLOCK_NUM; i++)
		spin_lock_init(&ub_qlockv[i]);
L
Linus Torvalds 已提交
2474 2475 2476 2477 2478 2479 2480

	if ((rc = register_blkdev(UB_MAJOR, DRV_NAME)) != 0)
		goto err_regblkdev;

	if ((rc = usb_register(&ub_driver)) != 0)
		goto err_register;

2481
	usb_usual_set_present(USB_US_TYPE_UB);
L
Linus Torvalds 已提交
2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494
	return 0;

err_register:
	unregister_blkdev(UB_MAJOR, DRV_NAME);
err_regblkdev:
	return rc;
}

static void __exit ub_exit(void)
{
	usb_deregister(&ub_driver);

	unregister_blkdev(UB_MAJOR, DRV_NAME);
2495
	usb_usual_clear_present(USB_US_TYPE_UB);
L
Linus Torvalds 已提交
2496 2497 2498 2499 2500 2501
}

module_init(ub_init);
module_exit(ub_exit);

MODULE_LICENSE("GPL");