MOXA linux-2.6.x / linux-2.6.9-uc0 from sdlinux-moxaart.tgz
[linux-2.6.9-moxart.git] / drivers / scsi / scsi_lib.c
blob994cb4f21005d863a68168359aeae0a3e4aa001e
1 /*
2 * scsi_lib.c Copyright (C) 1999 Eric Youngdale
4 * SCSI queueing library.
5 * Initial versions: Eric Youngdale (eric@andante.org).
6 * Based upon conversations with large numbers
7 * of people at Linux Expo.
8 */
10 #include <linux/bio.h>
11 #include <linux/blkdev.h>
12 #include <linux/completion.h>
13 #include <linux/kernel.h>
14 #include <linux/mempool.h>
15 #include <linux/slab.h>
16 #include <linux/init.h>
17 #include <linux/pci.h>
19 #include <scsi/scsi.h>
20 #include <scsi/scsi_dbg.h>
21 #include <scsi/scsi_device.h>
22 #include <scsi/scsi_driver.h>
23 #include <scsi/scsi_eh.h>
24 #include <scsi/scsi_host.h>
25 #include <scsi/scsi_request.h>
27 #include "scsi_priv.h"
28 #include "scsi_logging.h"
31 #define SG_MEMPOOL_NR (sizeof(scsi_sg_pools)/sizeof(struct scsi_host_sg_pool))
32 #define SG_MEMPOOL_SIZE 32
34 struct scsi_host_sg_pool {
35 size_t size;
36 char *name;
37 kmem_cache_t *slab;
38 mempool_t *pool;
41 #if (SCSI_MAX_PHYS_SEGMENTS < 32)
42 #error SCSI_MAX_PHYS_SEGMENTS is too small
43 #endif
45 #define SP(x) { x, "sgpool-" #x }
46 struct scsi_host_sg_pool scsi_sg_pools[] = {
47 SP(8),
48 SP(16),
49 SP(32),
50 #if (SCSI_MAX_PHYS_SEGMENTS > 32)
51 SP(64),
52 #if (SCSI_MAX_PHYS_SEGMENTS > 64)
53 SP(128),
54 #if (SCSI_MAX_PHYS_SEGMENTS > 128)
55 SP(256),
56 #if (SCSI_MAX_PHYS_SEGMENTS > 256)
57 #error SCSI_MAX_PHYS_SEGMENTS is too large
58 #endif
59 #endif
60 #endif
61 #endif
62 };
63 #undef SP
67 * Function: scsi_insert_special_req()
69 * Purpose: Insert pre-formed request into request queue.
71 * Arguments: sreq - request that is ready to be queued.
72 * at_head - boolean. True if we should insert at head
73 * of queue, false if we should insert at tail.
75 * Lock status: Assumed that lock is not held upon entry.
77 * Returns: Nothing
79 * Notes: This function is called from character device and from
80 * ioctl types of functions where the caller knows exactly
81 * what SCSI command needs to be issued. The idea is that
82 * we merely inject the command into the queue (at the head
83 * for now), and then call the queue request function to actually
84 * process it.
86 int scsi_insert_special_req(struct scsi_request *sreq, int at_head)
89 * Because users of this function are apt to reuse requests with no
90 * modification, we have to sanitise the request flags here
92 sreq->sr_request->flags &= ~REQ_DONTPREP;
93 blk_insert_request(sreq->sr_device->request_queue, sreq->sr_request,
94 at_head, sreq, 0);
95 return 0;
99 * Function: scsi_queue_insert()
101 * Purpose: Insert a command in the midlevel queue.
103 * Arguments: cmd - command that we are adding to queue.
104 * reason - why we are inserting command to queue.
106 * Lock status: Assumed that lock is not held upon entry.
108 * Returns: Nothing.
110 * Notes: We do this for one of two cases. Either the host is busy
111 * and it cannot accept any more commands for the time being,
112 * or the device returned QUEUE_FULL and can accept no more
113 * commands.
114 * Notes: This could be called either from an interrupt context or a
115 * normal process context.
117 int scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
119 struct Scsi_Host *host = cmd->device->host;
120 struct scsi_device *device = cmd->device;
122 SCSI_LOG_MLQUEUE(1,
123 printk("Inserting command %p into mlqueue\n", cmd));
126 * We are inserting the command into the ml queue. First, we
127 * cancel the timer, so it doesn't time out.
129 scsi_delete_timer(cmd);
132 * Next, set the appropriate busy bit for the device/host.
134 * If the host/device isn't busy, assume that something actually
135 * completed, and that we should be able to queue a command now.
137 * Note that the prior mid-layer assumption that any host could
138 * always queue at least one command is now broken. The mid-layer
139 * will implement a user specifiable stall (see
140 * scsi_host.max_host_blocked and scsi_device.max_device_blocked)
141 * if a command is requeued with no other commands outstanding
142 * either for the device or for the host.
144 if (reason == SCSI_MLQUEUE_HOST_BUSY)
145 host->host_blocked = host->max_host_blocked;
146 else if (reason == SCSI_MLQUEUE_DEVICE_BUSY)
147 device->device_blocked = device->max_device_blocked;
150 * Register the fact that we own the thing for now.
152 cmd->state = SCSI_STATE_MLQUEUE;
153 cmd->owner = SCSI_OWNER_MIDLEVEL;
156 * Decrement the counters, since these commands are no longer
157 * active on the host/device.
159 scsi_device_unbusy(device);
162 * Insert this command at the head of the queue for it's device.
163 * It will go before all other commands that are already in the queue.
165 * NOTE: there is magic here about the way the queue is plugged if
166 * we have no outstanding commands.
168 * Although this *doesn't* plug the queue, it does call the request
169 * function. The SCSI request function detects the blocked condition
170 * and plugs the queue appropriately.
172 blk_insert_request(device->request_queue, cmd->request, 1, cmd, 1);
173 return 0;
177 * Function: scsi_do_req
179 * Purpose: Queue a SCSI request
181 * Arguments: sreq - command descriptor.
182 * cmnd - actual SCSI command to be performed.
183 * buffer - data buffer.
184 * bufflen - size of data buffer.
185 * done - completion function to be run.
186 * timeout - how long to let it run before timeout.
187 * retries - number of retries we allow.
189 * Lock status: No locks held upon entry.
191 * Returns: Nothing.
193 * Notes: This function is only used for queueing requests for things
194 * like ioctls and character device requests - this is because
195 * we essentially just inject a request into the queue for the
196 * device.
198 * In order to support the scsi_device_quiesce function, we
199 * now inject requests on the *head* of the device queue
200 * rather than the tail.
202 void scsi_do_req(struct scsi_request *sreq, const void *cmnd,
203 void *buffer, unsigned bufflen,
204 void (*done)(struct scsi_cmnd *),
205 int timeout, int retries)
208 * If the upper level driver is reusing these things, then
209 * we should release the low-level block now. Another one will
210 * be allocated later when this request is getting queued.
212 __scsi_release_request(sreq);
215 * Our own function scsi_done (which marks the host as not busy,
216 * disables the timeout counter, etc) will be called by us or by the
217 * scsi_hosts[host].queuecommand() function needs to also call
218 * the completion function for the high level driver.
220 memcpy(sreq->sr_cmnd, cmnd, sizeof(sreq->sr_cmnd));
221 sreq->sr_bufflen = bufflen;
222 sreq->sr_buffer = buffer;
223 sreq->sr_allowed = retries;
224 sreq->sr_done = done;
225 sreq->sr_timeout_per_command = timeout;
227 if (sreq->sr_cmd_len == 0)
228 sreq->sr_cmd_len = COMMAND_SIZE(sreq->sr_cmnd[0]);
231 * head injection *required* here otherwise quiesce won't work
233 scsi_insert_special_req(sreq, 1);
236 static void scsi_wait_done(struct scsi_cmnd *cmd)
238 struct request *req = cmd->request;
239 struct request_queue *q = cmd->device->request_queue;
240 unsigned long flags;
242 req->rq_status = RQ_SCSI_DONE; /* Busy, but indicate request done */
244 spin_lock_irqsave(q->queue_lock, flags);
245 if (blk_rq_tagged(req))
246 blk_queue_end_tag(q, req);
247 spin_unlock_irqrestore(q->queue_lock, flags);
249 if (req->waiting)
250 complete(req->waiting);
253 void scsi_wait_req(struct scsi_request *sreq, const void *cmnd, void *buffer,
254 unsigned bufflen, int timeout, int retries)
256 DECLARE_COMPLETION(wait);
258 sreq->sr_request->waiting = &wait;
259 sreq->sr_request->rq_status = RQ_SCSI_BUSY;
260 scsi_do_req(sreq, cmnd, buffer, bufflen, scsi_wait_done,
261 timeout, retries);
262 wait_for_completion(&wait);
263 sreq->sr_request->waiting = NULL;
264 if (sreq->sr_request->rq_status != RQ_SCSI_DONE)
265 sreq->sr_result |= (DRIVER_ERROR << 24);
267 __scsi_release_request(sreq);
271 * Function: scsi_init_cmd_errh()
273 * Purpose: Initialize cmd fields related to error handling.
275 * Arguments: cmd - command that is ready to be queued.
277 * Returns: Nothing
279 * Notes: This function has the job of initializing a number of
280 * fields related to error handling. Typically this will
281 * be called once for each command, as required.
283 static int scsi_init_cmd_errh(struct scsi_cmnd *cmd)
285 cmd->owner = SCSI_OWNER_MIDLEVEL;
286 cmd->serial_number = 0;
287 cmd->serial_number_at_timeout = 0;
288 cmd->abort_reason = 0;
290 memset(cmd->sense_buffer, 0, sizeof cmd->sense_buffer);
292 if (cmd->cmd_len == 0)
293 cmd->cmd_len = COMMAND_SIZE(cmd->cmnd[0]);
296 * We need saved copies of a number of fields - this is because
297 * error handling may need to overwrite these with different values
298 * to run different commands, and once error handling is complete,
299 * we will need to restore these values prior to running the actual
300 * command.
302 cmd->old_use_sg = cmd->use_sg;
303 cmd->old_cmd_len = cmd->cmd_len;
304 cmd->sc_old_data_direction = cmd->sc_data_direction;
305 cmd->old_underflow = cmd->underflow;
306 memcpy(cmd->data_cmnd, cmd->cmnd, sizeof(cmd->cmnd));
307 cmd->buffer = cmd->request_buffer;
308 cmd->bufflen = cmd->request_bufflen;
309 cmd->internal_timeout = NORMAL_TIMEOUT;
310 cmd->abort_reason = 0;
312 return 1;
316 * Function: scsi_setup_cmd_retry()
318 * Purpose: Restore the command state for a retry
320 * Arguments: cmd - command to be restored
322 * Returns: Nothing
324 * Notes: Immediately prior to retrying a command, we need
325 * to restore certain fields that we saved above.
327 void scsi_setup_cmd_retry(struct scsi_cmnd *cmd)
329 memcpy(cmd->cmnd, cmd->data_cmnd, sizeof(cmd->data_cmnd));
330 cmd->request_buffer = cmd->buffer;
331 cmd->request_bufflen = cmd->bufflen;
332 cmd->use_sg = cmd->old_use_sg;
333 cmd->cmd_len = cmd->old_cmd_len;
334 cmd->sc_data_direction = cmd->sc_old_data_direction;
335 cmd->underflow = cmd->old_underflow;
338 void scsi_device_unbusy(struct scsi_device *sdev)
340 struct Scsi_Host *shost = sdev->host;
341 unsigned long flags;
343 spin_lock_irqsave(shost->host_lock, flags);
344 shost->host_busy--;
345 if (unlikely(test_bit(SHOST_RECOVERY, &shost->shost_state) &&
346 shost->host_failed))
347 scsi_eh_wakeup(shost);
348 spin_unlock(shost->host_lock);
349 spin_lock(&sdev->sdev_lock);
350 sdev->device_busy--;
351 spin_unlock_irqrestore(&sdev->sdev_lock, flags);
355 * Called for single_lun devices on IO completion. Clear starget_sdev_user,
356 * and call blk_run_queue for all the scsi_devices on the target -
357 * including current_sdev first.
359 * Called with *no* scsi locks held.
361 static void scsi_single_lun_run(struct scsi_device *current_sdev)
363 struct Scsi_Host *shost = current_sdev->host;
364 struct scsi_device *sdev, *tmp;
365 unsigned long flags;
367 spin_lock_irqsave(shost->host_lock, flags);
368 current_sdev->sdev_target->starget_sdev_user = NULL;
369 spin_unlock_irqrestore(shost->host_lock, flags);
372 * Call blk_run_queue for all LUNs on the target, starting with
373 * current_sdev. We race with others (to set starget_sdev_user),
374 * but in most cases, we will be first. Ideally, each LU on the
375 * target would get some limited time or requests on the target.
377 blk_run_queue(current_sdev->request_queue);
379 spin_lock_irqsave(shost->host_lock, flags);
380 if (current_sdev->sdev_target->starget_sdev_user)
381 goto out;
382 list_for_each_entry_safe(sdev, tmp, &current_sdev->same_target_siblings,
383 same_target_siblings) {
384 if (scsi_device_get(sdev))
385 continue;
387 spin_unlock_irqrestore(shost->host_lock, flags);
388 blk_run_queue(sdev->request_queue);
389 spin_lock_irqsave(shost->host_lock, flags);
391 scsi_device_put(sdev);
393 out:
394 spin_unlock_irqrestore(shost->host_lock, flags);
398 * Function: scsi_run_queue()
400 * Purpose: Select a proper request queue to serve next
402 * Arguments: q - last request's queue
404 * Returns: Nothing
406 * Notes: The previous command was completely finished, start
407 * a new one if possible.
409 static void scsi_run_queue(struct request_queue *q)
411 struct scsi_device *sdev = q->queuedata;
412 struct Scsi_Host *shost = sdev->host;
413 unsigned long flags;
415 if (sdev->single_lun)
416 scsi_single_lun_run(sdev);
418 spin_lock_irqsave(shost->host_lock, flags);
419 while (!list_empty(&shost->starved_list) &&
420 !shost->host_blocked && !shost->host_self_blocked &&
421 !((shost->can_queue > 0) &&
422 (shost->host_busy >= shost->can_queue))) {
424 * As long as shost is accepting commands and we have
425 * starved queues, call blk_run_queue. scsi_request_fn
426 * drops the queue_lock and can add us back to the
427 * starved_list.
429 * host_lock protects the starved_list and starved_entry.
430 * scsi_request_fn must get the host_lock before checking
431 * or modifying starved_list or starved_entry.
433 sdev = list_entry(shost->starved_list.next,
434 struct scsi_device, starved_entry);
435 list_del_init(&sdev->starved_entry);
436 spin_unlock_irqrestore(shost->host_lock, flags);
438 blk_run_queue(sdev->request_queue);
440 spin_lock_irqsave(shost->host_lock, flags);
441 if (unlikely(!list_empty(&sdev->starved_entry)))
443 * sdev lost a race, and was put back on the
444 * starved list. This is unlikely but without this
445 * in theory we could loop forever.
447 break;
449 spin_unlock_irqrestore(shost->host_lock, flags);
451 blk_run_queue(q);
455 * Function: scsi_requeue_command()
457 * Purpose: Handle post-processing of completed commands.
459 * Arguments: q - queue to operate on
460 * cmd - command that may need to be requeued.
462 * Returns: Nothing
464 * Notes: After command completion, there may be blocks left
465 * over which weren't finished by the previous command
466 * this can be for a number of reasons - the main one is
467 * I/O errors in the middle of the request, in which case
468 * we need to request the blocks that come after the bad
469 * sector.
471 static void scsi_requeue_command(struct request_queue *q, struct scsi_cmnd *cmd)
473 cmd->request->flags &= ~REQ_DONTPREP;
474 blk_insert_request(q, cmd->request, 1, cmd, 1);
476 scsi_run_queue(q);
479 void scsi_next_command(struct scsi_cmnd *cmd)
481 struct request_queue *q = cmd->device->request_queue;
483 scsi_put_command(cmd);
484 scsi_run_queue(q);
487 void scsi_run_host_queues(struct Scsi_Host *shost)
489 struct scsi_device *sdev;
491 shost_for_each_device(sdev, shost)
492 scsi_run_queue(sdev->request_queue);
496 * Function: scsi_end_request()
498 * Purpose: Post-processing of completed commands called from interrupt
499 * handler or a bottom-half handler.
501 * Arguments: cmd - command that is complete.
502 * uptodate - 1 if I/O indicates success, 0 for I/O error.
503 * sectors - number of sectors we want to mark.
504 * requeue - indicates whether we should requeue leftovers.
505 * frequeue - indicates that if we release the command block
506 * that the queue request function should be called.
508 * Lock status: Assumed that lock is not held upon entry.
510 * Returns: Nothing
512 * Notes: This is called for block device requests in order to
513 * mark some number of sectors as complete.
515 * We are guaranteeing that the request queue will be goosed
516 * at some point during this call.
518 static struct scsi_cmnd *scsi_end_request(struct scsi_cmnd *cmd, int uptodate,
519 int bytes, int requeue)
521 request_queue_t *q = cmd->device->request_queue;
522 struct request *req = cmd->request;
523 unsigned long flags;
526 * If there are blocks left over at the end, set up the command
527 * to queue the remainder of them.
529 if (end_that_request_chunk(req, uptodate, bytes)) {
530 int leftover = (req->hard_nr_sectors << 9);
532 if (blk_pc_request(req))
533 leftover = req->data_len;
535 /* kill remainder if no retrys */
536 if (!uptodate && blk_noretry_request(req))
537 end_that_request_chunk(req, 0, leftover);
538 else {
539 if (requeue)
541 * Bleah. Leftovers again. Stick the
542 * leftovers in the front of the
543 * queue, and goose the queue again.
545 scsi_requeue_command(q, cmd);
547 return cmd;
551 add_disk_randomness(req->rq_disk);
553 spin_lock_irqsave(q->queue_lock, flags);
554 if (blk_rq_tagged(req))
555 blk_queue_end_tag(q, req);
556 end_that_request_last(req);
557 spin_unlock_irqrestore(q->queue_lock, flags);
560 * This will goose the queue request function at the end, so we don't
561 * need to worry about launching another command.
563 scsi_next_command(cmd);
564 return NULL;
567 static struct scatterlist *scsi_alloc_sgtable(struct scsi_cmnd *cmd, int gfp_mask)
569 struct scsi_host_sg_pool *sgp;
570 struct scatterlist *sgl;
572 BUG_ON(!cmd->use_sg);
574 switch (cmd->use_sg) {
575 case 1 ... 8:
576 cmd->sglist_len = 0;
577 break;
578 case 9 ... 16:
579 cmd->sglist_len = 1;
580 break;
581 case 17 ... 32:
582 cmd->sglist_len = 2;
583 break;
584 #if (SCSI_MAX_PHYS_SEGMENTS > 32)
585 case 33 ... 64:
586 cmd->sglist_len = 3;
587 break;
588 #if (SCSI_MAX_PHYS_SEGMENTS > 64)
589 case 65 ... 128:
590 cmd->sglist_len = 4;
591 break;
592 #if (SCSI_MAX_PHYS_SEGMENTS > 128)
593 case 129 ... 256:
594 cmd->sglist_len = 5;
595 break;
596 #endif
597 #endif
598 #endif
599 default:
600 return NULL;
603 sgp = scsi_sg_pools + cmd->sglist_len;
604 sgl = mempool_alloc(sgp->pool, gfp_mask);
605 if (sgl)
606 memset(sgl, 0, sgp->size);
607 return sgl;
610 static void scsi_free_sgtable(struct scatterlist *sgl, int index)
612 struct scsi_host_sg_pool *sgp;
614 BUG_ON(index > SG_MEMPOOL_NR);
616 sgp = scsi_sg_pools + index;
617 mempool_free(sgl, sgp->pool);
621 * Function: scsi_release_buffers()
623 * Purpose: Completion processing for block device I/O requests.
625 * Arguments: cmd - command that we are bailing.
627 * Lock status: Assumed that no lock is held upon entry.
629 * Returns: Nothing
631 * Notes: In the event that an upper level driver rejects a
632 * command, we must release resources allocated during
633 * the __init_io() function. Primarily this would involve
634 * the scatter-gather table, and potentially any bounce
635 * buffers.
637 static void scsi_release_buffers(struct scsi_cmnd *cmd)
639 struct request *req = cmd->request;
642 * Free up any indirection buffers we allocated for DMA purposes.
644 if (cmd->use_sg)
645 scsi_free_sgtable(cmd->request_buffer, cmd->sglist_len);
646 else if (cmd->request_buffer != req->buffer)
647 kfree(cmd->request_buffer);
650 * Zero these out. They now point to freed memory, and it is
651 * dangerous to hang onto the pointers.
653 cmd->buffer = NULL;
654 cmd->bufflen = 0;
655 cmd->request_buffer = NULL;
656 cmd->request_bufflen = 0;
660 * Function: scsi_io_completion()
662 * Purpose: Completion processing for block device I/O requests.
664 * Arguments: cmd - command that is finished.
666 * Lock status: Assumed that no lock is held upon entry.
668 * Returns: Nothing
670 * Notes: This function is matched in terms of capabilities to
671 * the function that created the scatter-gather list.
672 * In other words, if there are no bounce buffers
673 * (the normal case for most drivers), we don't need
674 * the logic to deal with cleaning up afterwards.
676 * We must do one of several things here:
678 * a) Call scsi_end_request. This will finish off the
679 * specified number of sectors. If we are done, the
680 * command block will be released, and the queue
681 * function will be goosed. If we are not done, then
682 * scsi_end_request will directly goose the queue.
684 * b) We can just use scsi_requeue_command() here. This would
685 * be used if we just wanted to retry, for example.
687 void scsi_io_completion(struct scsi_cmnd *cmd, unsigned int good_bytes,
688 unsigned int block_bytes)
690 int result = cmd->result;
691 int this_count = cmd->bufflen;
692 request_queue_t *q = cmd->device->request_queue;
693 struct request *req = cmd->request;
694 int clear_errors = 1;
697 * Free up any indirection buffers we allocated for DMA purposes.
698 * For the case of a READ, we need to copy the data out of the
699 * bounce buffer and into the real buffer.
701 if (cmd->use_sg)
702 scsi_free_sgtable(cmd->buffer, cmd->sglist_len);
703 else if (cmd->buffer != req->buffer) {
704 if (rq_data_dir(req) == READ) {
705 unsigned long flags;
706 char *to = bio_kmap_irq(req->bio, &flags);
707 memcpy(to, cmd->buffer, cmd->bufflen);
708 bio_kunmap_irq(to, &flags);
710 kfree(cmd->buffer);
713 if (blk_pc_request(req)) { /* SG_IO ioctl from block level */
714 req->errors = (driver_byte(result) & DRIVER_SENSE) ?
715 (CHECK_CONDITION << 1) : (result & 0xff);
716 if (result) {
717 clear_errors = 0;
718 if (cmd->sense_buffer[0] & 0x70) {
719 int len = 8 + cmd->sense_buffer[7];
721 if (len > SCSI_SENSE_BUFFERSIZE)
722 len = SCSI_SENSE_BUFFERSIZE;
723 memcpy(req->sense, cmd->sense_buffer, len);
724 req->sense_len = len;
726 } else
727 req->data_len -= cmd->bufflen;
731 * Zero these out. They now point to freed memory, and it is
732 * dangerous to hang onto the pointers.
734 cmd->buffer = NULL;
735 cmd->bufflen = 0;
736 cmd->request_buffer = NULL;
737 cmd->request_bufflen = 0;
740 * Next deal with any sectors which we were able to correctly
741 * handle.
743 if (good_bytes >= 0) {
744 SCSI_LOG_HLCOMPLETE(1, printk("%ld sectors total, %d bytes done.\n",
745 req->nr_sectors, good_bytes));
746 SCSI_LOG_HLCOMPLETE(1, printk("use_sg is %d\n", cmd->use_sg));
748 if (clear_errors)
749 req->errors = 0;
751 * If multiple sectors are requested in one buffer, then
752 * they will have been finished off by the first command.
753 * If not, then we have a multi-buffer command.
755 * If block_bytes != 0, it means we had a medium error
756 * of some sort, and that we want to mark some number of
757 * sectors as not uptodate. Thus we want to inhibit
758 * requeueing right here - we will requeue down below
759 * when we handle the bad sectors.
761 cmd = scsi_end_request(cmd, 1, good_bytes, result == 0);
764 * If the command completed without error, then either finish off the
765 * rest of the command, or start a new one.
767 if (result == 0 || cmd == NULL ) {
768 return;
772 * Now, if we were good little boys and girls, Santa left us a request
773 * sense buffer. We can extract information from this, so we
774 * can choose a block to remap, etc.
776 if (driver_byte(result) != 0) {
777 if ((cmd->sense_buffer[0] & 0x7f) == 0x70) {
779 * If the device is in the process of becoming ready,
780 * retry.
782 if (cmd->sense_buffer[12] == 0x04 &&
783 cmd->sense_buffer[13] == 0x01) {
784 scsi_requeue_command(q, cmd);
785 return;
787 if ((cmd->sense_buffer[2] & 0xf) == UNIT_ATTENTION) {
788 if (cmd->device->removable) {
789 /* detected disc change. set a bit
790 * and quietly refuse further access.
792 cmd->device->changed = 1;
793 cmd = scsi_end_request(cmd, 0,
794 this_count, 1);
795 return;
796 } else {
798 * Must have been a power glitch, or a
799 * bus reset. Could not have been a
800 * media change, so we just retry the
801 * request and see what happens.
803 scsi_requeue_command(q, cmd);
804 return;
809 * If we had an ILLEGAL REQUEST returned, then we may have
810 * performed an unsupported command. The only thing this
811 * should be would be a ten byte read where only a six byte
812 * read was supported. Also, on a system where READ CAPACITY
813 * failed, we may have read past the end of the disk.
816 switch (cmd->sense_buffer[2]) {
817 case ILLEGAL_REQUEST:
818 if (cmd->device->use_10_for_rw &&
819 (cmd->cmnd[0] == READ_10 ||
820 cmd->cmnd[0] == WRITE_10)) {
821 cmd->device->use_10_for_rw = 0;
823 * This will cause a retry with a 6-byte
824 * command.
826 scsi_requeue_command(q, cmd);
827 result = 0;
828 } else {
829 cmd = scsi_end_request(cmd, 0, this_count, 1);
830 return;
832 break;
833 case NOT_READY:
834 printk(KERN_INFO "Device %s not ready.\n",
835 req->rq_disk ? req->rq_disk->disk_name : "");
836 cmd = scsi_end_request(cmd, 0, this_count, 1);
837 return;
838 break;
839 case MEDIUM_ERROR:
840 case VOLUME_OVERFLOW:
841 printk("scsi%d: ERROR on channel %d, id %d, lun %d, CDB: ",
842 cmd->device->host->host_no, (int) cmd->device->channel,
843 (int) cmd->device->id, (int) cmd->device->lun);
844 __scsi_print_command(cmd->data_cmnd);
845 scsi_print_sense("", cmd);
846 cmd = scsi_end_request(cmd, 0, block_bytes, 1);
847 return;
848 default:
849 break;
851 } /* driver byte != 0 */
852 if (host_byte(result) == DID_RESET) {
854 * Third party bus reset or reset for error
855 * recovery reasons. Just retry the request
856 * and see what happens.
858 scsi_requeue_command(q, cmd);
859 return;
861 if (result) {
862 printk("SCSI error : <%d %d %d %d> return code = 0x%x\n",
863 cmd->device->host->host_no,
864 cmd->device->channel,
865 cmd->device->id,
866 cmd->device->lun, result);
868 if (driver_byte(result) & DRIVER_SENSE)
869 scsi_print_sense("", cmd);
871 * Mark a single buffer as not uptodate. Queue the remainder.
872 * We sometimes get this cruft in the event that a medium error
873 * isn't properly reported.
875 block_bytes = req->hard_cur_sectors << 9;
876 if (!block_bytes)
877 block_bytes = req->data_len;
878 cmd = scsi_end_request(cmd, 0, block_bytes, 1);
883 * Function: scsi_init_io()
885 * Purpose: SCSI I/O initialize function.
887 * Arguments: cmd - Command descriptor we wish to initialize
889 * Returns: 0 on success
890 * BLKPREP_DEFER if the failure is retryable
891 * BLKPREP_KILL if the failure is fatal
893 static int scsi_init_io(struct scsi_cmnd *cmd)
895 struct request *req = cmd->request;
896 struct scatterlist *sgpnt;
897 int count;
900 * if this is a rq->data based REQ_BLOCK_PC, setup for a non-sg xfer
902 if ((req->flags & REQ_BLOCK_PC) && !req->bio) {
903 cmd->request_bufflen = req->data_len;
904 cmd->request_buffer = req->data;
905 req->buffer = req->data;
906 cmd->use_sg = 0;
907 return 0;
911 * we used to not use scatter-gather for single segment request,
912 * but now we do (it makes highmem I/O easier to support without
913 * kmapping pages)
915 cmd->use_sg = req->nr_phys_segments;
918 * if sg table allocation fails, requeue request later.
920 sgpnt = scsi_alloc_sgtable(cmd, GFP_ATOMIC);
921 if (unlikely(!sgpnt)) {
922 req->flags |= REQ_SPECIAL;
923 return BLKPREP_DEFER;
926 cmd->request_buffer = (char *) sgpnt;
927 cmd->request_bufflen = req->nr_sectors << 9;
928 if (blk_pc_request(req))
929 cmd->request_bufflen = req->data_len;
930 req->buffer = NULL;
933 * Next, walk the list, and fill in the addresses and sizes of
934 * each segment.
936 count = blk_rq_map_sg(req->q, req, cmd->request_buffer);
939 * mapped well, send it off
941 if (likely(count <= cmd->use_sg)) {
942 cmd->use_sg = count;
943 return 0;
946 printk(KERN_ERR "Incorrect number of segments after building list\n");
947 printk(KERN_ERR "counted %d, received %d\n", count, cmd->use_sg);
948 printk(KERN_ERR "req nr_sec %lu, cur_nr_sec %u\n", req->nr_sectors,
949 req->current_nr_sectors);
951 /* release the command and kill it */
952 scsi_release_buffers(cmd);
953 scsi_put_command(cmd);
954 return BLKPREP_KILL;
957 static int scsi_issue_flush_fn(request_queue_t *q, struct gendisk *disk,
958 sector_t *error_sector)
960 struct scsi_device *sdev = q->queuedata;
961 struct scsi_driver *drv;
963 if (sdev->sdev_state != SDEV_RUNNING)
964 return -ENXIO;
966 drv = *(struct scsi_driver **) disk->private_data;
967 if (drv->issue_flush)
968 return drv->issue_flush(&sdev->sdev_gendev, error_sector);
970 return -EOPNOTSUPP;
973 static int scsi_prep_fn(struct request_queue *q, struct request *req)
975 struct scsi_device *sdev = q->queuedata;
976 struct scsi_cmnd *cmd;
977 int specials_only = 0;
980 * Just check to see if the device is online. If it isn't, we
981 * refuse to process any commands. The device must be brought
982 * online before trying any recovery commands
984 if (unlikely(!scsi_device_online(sdev))) {
985 #if 0 //johnson remove 2008-01-10
986 printk(KERN_ERR "scsi%d (%d:%d): rejecting I/O to offline device\n",sdev->host->host_no, sdev->id, sdev->lun);
987 #endif
988 return BLKPREP_KILL;
990 if (unlikely(sdev->sdev_state != SDEV_RUNNING)) {
991 /* OK, we're not in a running state don't prep
992 * user commands */
993 if (sdev->sdev_state == SDEV_DEL) {
994 /* Device is fully deleted, no commands
995 * at all allowed down */
996 #if 0 //johnson remove 2008-01-10
997 printk(KERN_ERR "scsi%d (%d:%d): rejecting I/O to dead device\n",sdev->host->host_no, sdev->id, sdev->lun);
998 #endif
999 return BLKPREP_KILL;
1001 /* OK, we only allow special commands (i.e. not
1002 * user initiated ones */
1003 specials_only = sdev->sdev_state;
1007 * Find the actual device driver associated with this command.
1008 * The SPECIAL requests are things like character device or
1009 * ioctls, which did not originate from ll_rw_blk. Note that
1010 * the special field is also used to indicate the cmd for
1011 * the remainder of a partially fulfilled request that can
1012 * come up when there is a medium error. We have to treat
1013 * these two cases differently. We differentiate by looking
1014 * at request->cmd, as this tells us the real story.
1016 if (req->flags & REQ_SPECIAL) {
1017 struct scsi_request *sreq = req->special;
1019 if (sreq->sr_magic == SCSI_REQ_MAGIC) {
1020 cmd = scsi_get_command(sreq->sr_device, GFP_ATOMIC);
1021 if (unlikely(!cmd))
1022 goto defer;
1023 scsi_init_cmd_from_req(cmd, sreq);
1024 } else
1025 cmd = req->special;
1026 } else if (req->flags & (REQ_CMD | REQ_BLOCK_PC)) {
1028 if(unlikely(specials_only)) {
1029 if(specials_only == SDEV_QUIESCE)
1030 return BLKPREP_DEFER;
1031 #if 0 //johnson remove 2008-01-10
1032 printk(KERN_ERR "scsi%d (%d:%d): rejecting I/O to device being removed\n",
1033 sdev->host->host_no, sdev->id, sdev->lun);
1034 #endif
1035 return BLKPREP_KILL;
1040 * Now try and find a command block that we can use.
1042 if (!req->special) {
1043 cmd = scsi_get_command(sdev, GFP_ATOMIC);
1044 if (unlikely(!cmd))
1045 goto defer;
1046 } else
1047 cmd = req->special;
1049 /* pull a tag out of the request if we have one */
1050 cmd->tag = req->tag;
1051 } else {
1052 blk_dump_rq_flags(req, "SCSI bad req");
1053 return BLKPREP_KILL;
1056 /* note the overloading of req->special. When the tag
1057 * is active it always means cmd. If the tag goes
1058 * back for re-queueing, it may be reset */
1059 req->special = cmd;
1060 cmd->request = req;
1063 * FIXME: drop the lock here because the functions below
1064 * expect to be called without the queue lock held. Also,
1065 * previously, we dequeued the request before dropping the
1066 * lock. We hope REQ_STARTED prevents anything untoward from
1067 * happening now.
1069 if (req->flags & (REQ_CMD | REQ_BLOCK_PC)) {
1070 struct scsi_driver *drv;
1071 int ret;
1074 * This will do a couple of things:
1075 * 1) Fill in the actual SCSI command.
1076 * 2) Fill in any other upper-level specific fields
1077 * (timeout).
1079 * If this returns 0, it means that the request failed
1080 * (reading past end of disk, reading offline device,
1081 * etc). This won't actually talk to the device, but
1082 * some kinds of consistency checking may cause the
1083 * request to be rejected immediately.
1087 * This sets up the scatter-gather table (allocating if
1088 * required).
1090 ret = scsi_init_io(cmd);
1091 if (ret) /* BLKPREP_KILL return also releases the command */
1092 return ret;
1095 * Initialize the actual SCSI command for this request.
1097 drv = *(struct scsi_driver **)req->rq_disk->private_data;
1098 if (unlikely(!drv->init_command(cmd))) {
1099 scsi_release_buffers(cmd);
1100 scsi_put_command(cmd);
1101 return BLKPREP_KILL;
1106 * The request is now prepped, no need to come back here
1108 req->flags |= REQ_DONTPREP;
1109 return BLKPREP_OK;
1111 defer:
1112 /* If we defer, the elv_next_request() returns NULL, but the
1113 * queue must be restarted, so we plug here if no returning
1114 * command will automatically do that. */
1115 if (sdev->device_busy == 0)
1116 blk_plug_device(q);
1117 return BLKPREP_DEFER;
1121 * scsi_dev_queue_ready: if we can send requests to sdev, return 1 else
1122 * return 0.
1124 * Called with the queue_lock held.
1126 static inline int scsi_dev_queue_ready(struct request_queue *q,
1127 struct scsi_device *sdev)
1129 if (sdev->device_busy >= sdev->queue_depth)
1130 return 0;
1131 if (sdev->device_busy == 0 && sdev->device_blocked) {
1133 * unblock after device_blocked iterates to zero
1135 if (--sdev->device_blocked == 0) {
1136 SCSI_LOG_MLQUEUE(3,
1137 printk("scsi%d (%d:%d) unblocking device at"
1138 " zero depth\n", sdev->host->host_no,
1139 sdev->id, sdev->lun));
1140 } else {
1141 blk_plug_device(q);
1142 return 0;
1145 if (sdev->device_blocked)
1146 return 0;
1148 return 1;
1152 * scsi_host_queue_ready: if we can send requests to shost, return 1 else
1153 * return 0. We must end up running the queue again whenever 0 is
1154 * returned, else IO can hang.
1156 * Called with host_lock held.
1158 static inline int scsi_host_queue_ready(struct request_queue *q,
1159 struct Scsi_Host *shost,
1160 struct scsi_device *sdev)
1162 if (test_bit(SHOST_RECOVERY, &shost->shost_state))
1163 return 0;
1164 if (shost->host_busy == 0 && shost->host_blocked) {
1166 * unblock after host_blocked iterates to zero
1168 if (--shost->host_blocked == 0) {
1169 SCSI_LOG_MLQUEUE(3,
1170 printk("scsi%d unblocking host at zero depth\n",
1171 shost->host_no));
1172 } else {
1173 blk_plug_device(q);
1174 return 0;
1177 if ((shost->can_queue > 0 && shost->host_busy >= shost->can_queue) ||
1178 shost->host_blocked || shost->host_self_blocked) {
1179 if (list_empty(&sdev->starved_entry))
1180 list_add_tail(&sdev->starved_entry, &shost->starved_list);
1181 return 0;
1184 /* We're OK to process the command, so we can't be starved */
1185 if (!list_empty(&sdev->starved_entry))
1186 list_del_init(&sdev->starved_entry);
1188 return 1;
1192 * Function: scsi_request_fn()
1194 * Purpose: Main strategy routine for SCSI.
1196 * Arguments: q - Pointer to actual queue.
1198 * Returns: Nothing
1200 * Lock status: IO request lock assumed to be held when called.
1202 static void scsi_request_fn(struct request_queue *q)
1204 struct scsi_device *sdev = q->queuedata;
1205 struct Scsi_Host *shost = sdev->host;
1206 struct scsi_cmnd *cmd;
1207 struct request *req;
1209 if(!get_device(&sdev->sdev_gendev))
1210 /* We must be tearing the block queue down already */
1211 return;
1214 * To start with, we keep looping until the queue is empty, or until
1215 * the host is no longer able to accept any more requests.
1217 while (!blk_queue_plugged(q)) {
1218 int rtn;
1220 * get next queueable request. We do this early to make sure
1221 * that the request is fully prepared even if we cannot
1222 * accept it.
1224 req = elv_next_request(q);
1225 if (!req || !scsi_dev_queue_ready(q, sdev))
1226 break;
1228 if (unlikely(!scsi_device_online(sdev))) {
1229 #if 0 //johnson remove 2008-01-10
1230 printk(KERN_ERR "scsi%d (%d:%d): rejecting I/O to offline device\n",
1231 sdev->host->host_no, sdev->id, sdev->lun);
1232 #endif
1233 blkdev_dequeue_request(req);
1234 req->flags |= REQ_QUIET;
1235 while (end_that_request_first(req, 0, req->nr_sectors))
1237 end_that_request_last(req);
1238 continue;
1243 * Remove the request from the request list.
1245 if (!(blk_queue_tagged(q) && !blk_queue_start_tag(q, req)))
1246 blkdev_dequeue_request(req);
1247 sdev->device_busy++;
1249 spin_unlock(q->queue_lock);
1250 spin_lock(shost->host_lock);
1252 if (!scsi_host_queue_ready(q, shost, sdev))
1253 goto not_ready;
1254 if (sdev->single_lun) {
1255 if (sdev->sdev_target->starget_sdev_user &&
1256 sdev->sdev_target->starget_sdev_user != sdev)
1257 goto not_ready;
1258 sdev->sdev_target->starget_sdev_user = sdev;
1260 shost->host_busy++;
1263 * XXX(hch): This is rather suboptimal, scsi_dispatch_cmd will
1264 * take the lock again.
1266 spin_unlock_irq(shost->host_lock);
1268 cmd = req->special;
1269 if (unlikely(cmd == NULL)) {
1270 printk(KERN_CRIT "impossible request in %s.\n"
1271 "please mail a stack trace to "
1272 "linux-scsi@vger.kernel.org",
1273 __FUNCTION__);
1274 BUG();
1278 * Finally, initialize any error handling parameters, and set up
1279 * the timers for timeouts.
1281 scsi_init_cmd_errh(cmd);
1284 * Dispatch the command to the low-level driver.
1286 rtn = scsi_dispatch_cmd(cmd);
1287 spin_lock_irq(q->queue_lock);
1288 if(rtn) {
1289 /* we're refusing the command; because of
1290 * the way locks get dropped, we need to
1291 * check here if plugging is required */
1292 if(sdev->device_busy == 0)
1293 blk_plug_device(q);
1295 break;
1299 goto out;
1301 not_ready:
1302 spin_unlock_irq(shost->host_lock);
1305 * lock q, handle tag, requeue req, and decrement device_busy. We
1306 * must return with queue_lock held.
1308 * Decrementing device_busy without checking it is OK, as all such
1309 * cases (host limits or settings) should run the queue at some
1310 * later time.
1312 spin_lock_irq(q->queue_lock);
1313 blk_requeue_request(q, req);
1314 sdev->device_busy--;
1315 if(sdev->device_busy == 0)
1316 blk_plug_device(q);
1317 out:
1318 /* must be careful here...if we trigger the ->remove() function
1319 * we cannot be holding the q lock */
1320 spin_unlock_irq(q->queue_lock);
1321 put_device(&sdev->sdev_gendev);
1322 spin_lock_irq(q->queue_lock);
1325 u64 scsi_calculate_bounce_limit(struct Scsi_Host *shost)
1327 struct device *host_dev;
1329 if (shost->unchecked_isa_dma)
1330 return BLK_BOUNCE_ISA;
1332 host_dev = scsi_get_device(shost);
1333 if (PCI_DMA_BUS_IS_PHYS && host_dev && host_dev->dma_mask)
1334 return *host_dev->dma_mask;
1337 * Platforms with virtual-DMA translation
1338 * hardware have no practical limit.
1340 return BLK_BOUNCE_ANY;
1343 struct request_queue *scsi_alloc_queue(struct scsi_device *sdev)
1345 struct Scsi_Host *shost = sdev->host;
1346 struct request_queue *q;
1348 q = blk_init_queue(scsi_request_fn, &sdev->sdev_lock);
1349 if (!q)
1350 return NULL;
1352 blk_queue_prep_rq(q, scsi_prep_fn);
1354 blk_queue_max_hw_segments(q, shost->sg_tablesize);
1355 blk_queue_max_phys_segments(q, SCSI_MAX_PHYS_SEGMENTS);
1356 blk_queue_max_sectors(q, shost->max_sectors);
1357 blk_queue_bounce_limit(q, scsi_calculate_bounce_limit(shost));
1358 blk_queue_segment_boundary(q, shost->dma_boundary);
1359 blk_queue_issue_flush_fn(q, scsi_issue_flush_fn);
1361 if (!shost->use_clustering)
1362 clear_bit(QUEUE_FLAG_CLUSTER, &q->queue_flags);
1363 return q;
1366 void scsi_free_queue(struct request_queue *q)
1368 blk_cleanup_queue(q);
1372 * Function: scsi_block_requests()
1374 * Purpose: Utility function used by low-level drivers to prevent further
1375 * commands from being queued to the device.
1377 * Arguments: shost - Host in question
1379 * Returns: Nothing
1381 * Lock status: No locks are assumed held.
1383 * Notes: There is no timer nor any other means by which the requests
1384 * get unblocked other than the low-level driver calling
1385 * scsi_unblock_requests().
1387 void scsi_block_requests(struct Scsi_Host *shost)
1389 shost->host_self_blocked = 1;
1393 * Function: scsi_unblock_requests()
1395 * Purpose: Utility function used by low-level drivers to allow further
1396 * commands from being queued to the device.
1398 * Arguments: shost - Host in question
1400 * Returns: Nothing
1402 * Lock status: No locks are assumed held.
1404 * Notes: There is no timer nor any other means by which the requests
1405 * get unblocked other than the low-level driver calling
1406 * scsi_unblock_requests().
1408 * This is done as an API function so that changes to the
1409 * internals of the scsi mid-layer won't require wholesale
1410 * changes to drivers that use this feature.
1412 void scsi_unblock_requests(struct Scsi_Host *shost)
1414 shost->host_self_blocked = 0;
1415 scsi_run_host_queues(shost);
1418 int __init scsi_init_queue(void)
1420 int i;
1422 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1423 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1424 int size = sgp->size * sizeof(struct scatterlist);
1426 sgp->slab = kmem_cache_create(sgp->name, size, 0,
1427 SLAB_HWCACHE_ALIGN, NULL, NULL);
1428 if (!sgp->slab) {
1429 printk(KERN_ERR "SCSI: can't init sg slab %s\n",
1430 sgp->name);
1433 sgp->pool = mempool_create(SG_MEMPOOL_SIZE,
1434 mempool_alloc_slab, mempool_free_slab,
1435 sgp->slab);
1436 if (!sgp->pool) {
1437 printk(KERN_ERR "SCSI: can't init sg mempool %s\n",
1438 sgp->name);
1442 return 0;
1445 void scsi_exit_queue(void)
1447 int i;
1449 for (i = 0; i < SG_MEMPOOL_NR; i++) {
1450 struct scsi_host_sg_pool *sgp = scsi_sg_pools + i;
1451 mempool_destroy(sgp->pool);
1452 kmem_cache_destroy(sgp->slab);
1456 * __scsi_mode_sense - issue a mode sense, falling back from 10 to
1457 * six bytes if necessary.
1458 * @sreq: SCSI request to fill in with the MODE_SENSE
1459 * @dbd: set if mode sense will allow block descriptors to be returned
1460 * @modepage: mode page being requested
1461 * @buffer: request buffer (may not be smaller than eight bytes)
1462 * @len: length of request buffer.
1463 * @timeout: command timeout
1464 * @retries: number of retries before failing
1465 * @data: returns a structure abstracting the mode header data
1467 * Returns zero if unsuccessful, or the header offset (either 4
1468 * or 8 depending on whether a six or ten byte command was
1469 * issued) if successful.
1472 __scsi_mode_sense(struct scsi_request *sreq, int dbd, int modepage,
1473 unsigned char *buffer, int len, int timeout, int retries,
1474 struct scsi_mode_data *data) {
1475 unsigned char cmd[12];
1476 int use_10_for_ms;
1477 int header_length;
1479 memset(data, 0, sizeof(*data));
1480 memset(&cmd[0], 0, 12);
1481 cmd[1] = dbd & 0x18; /* allows DBD and LLBA bits */
1482 cmd[2] = modepage;
1484 retry:
1485 use_10_for_ms = sreq->sr_device->use_10_for_ms;
1487 if (use_10_for_ms) {
1488 if (len < 8)
1489 len = 8;
1491 cmd[0] = MODE_SENSE_10;
1492 cmd[8] = len;
1493 header_length = 8;
1494 } else {
1495 if (len < 4)
1496 len = 4;
1498 cmd[0] = MODE_SENSE;
1499 cmd[4] = len;
1500 header_length = 4;
1503 sreq->sr_cmd_len = 0;
1504 sreq->sr_sense_buffer[0] = 0;
1505 sreq->sr_sense_buffer[2] = 0;
1506 sreq->sr_data_direction = DMA_FROM_DEVICE;
1508 memset(buffer, 0, len);
1510 scsi_wait_req(sreq, cmd, buffer, len, timeout, retries);
1512 /* This code looks awful: what it's doing is making sure an
1513 * ILLEGAL REQUEST sense return identifies the actual command
1514 * byte as the problem. MODE_SENSE commands can return
1515 * ILLEGAL REQUEST if the code page isn't supported */
1516 if (use_10_for_ms && ! scsi_status_is_good(sreq->sr_result) &&
1517 (driver_byte(sreq->sr_result) & DRIVER_SENSE) &&
1518 sreq->sr_sense_buffer[2] == ILLEGAL_REQUEST &&
1519 (sreq->sr_sense_buffer[4] & 0x40) == 0x40 &&
1520 sreq->sr_sense_buffer[5] == 0 &&
1521 sreq->sr_sense_buffer[6] == 0 ) {
1522 sreq->sr_device->use_10_for_ms = 0;
1523 goto retry;
1526 if(scsi_status_is_good(sreq->sr_result)) {
1527 data->header_length = header_length;
1528 if(use_10_for_ms) {
1529 data->length = buffer[0]*256 + buffer[1] + 2;
1530 data->medium_type = buffer[2];
1531 data->device_specific = buffer[3];
1532 data->longlba = buffer[4] & 0x01;
1533 data->block_descriptor_length = buffer[6]*256
1534 + buffer[7];
1535 } else {
1536 data->length = buffer[0] + 1;
1537 data->medium_type = buffer[1];
1538 data->device_specific = buffer[2];
1539 data->block_descriptor_length = buffer[3];
1543 return sreq->sr_result;
1547 * scsi_mode_sense - issue a mode sense, falling back from 10 to
1548 * six bytes if necessary.
1549 * @sdev: scsi device to send command to.
1550 * @dbd: set if mode sense will disable block descriptors in the return
1551 * @modepage: mode page being requested
1552 * @buffer: request buffer (may not be smaller than eight bytes)
1553 * @len: length of request buffer.
1554 * @timeout: command timeout
1555 * @retries: number of retries before failing
1557 * Returns zero if unsuccessful, or the header offset (either 4
1558 * or 8 depending on whether a six or ten byte command was
1559 * issued) if successful.
1562 scsi_mode_sense(struct scsi_device *sdev, int dbd, int modepage,
1563 unsigned char *buffer, int len, int timeout, int retries,
1564 struct scsi_mode_data *data)
1566 struct scsi_request *sreq = scsi_allocate_request(sdev, GFP_KERNEL);
1567 int ret;
1569 if (!sreq)
1570 return -1;
1572 ret = __scsi_mode_sense(sreq, dbd, modepage, buffer, len,
1573 timeout, retries, data);
1575 scsi_release_request(sreq);
1577 return ret;
1581 scsi_test_unit_ready(struct scsi_device *sdev, int timeout, int retries)
1583 struct scsi_request *sreq;
1584 char cmd[] = {
1585 TEST_UNIT_READY, 0, 0, 0, 0, 0,
1587 int result;
1589 sreq = scsi_allocate_request(sdev, GFP_KERNEL);
1590 if (!sreq)
1591 return -ENOMEM;
1593 sreq->sr_data_direction = DMA_NONE;
1594 scsi_wait_req(sreq, cmd, NULL, 0, timeout, retries);
1596 if ((driver_byte(sreq->sr_result) & DRIVER_SENSE) &&
1597 (sreq->sr_sense_buffer[2] & 0x0f) == UNIT_ATTENTION &&
1598 sdev->removable) {
1599 sdev->changed = 1;
1600 sreq->sr_result = 0;
1602 result = sreq->sr_result;
1603 scsi_release_request(sreq);
1604 return result;
1606 EXPORT_SYMBOL(scsi_test_unit_ready);
1609 * scsi_device_set_state - Take the given device through the device
1610 * state model.
1611 * @sdev: scsi device to change the state of.
1612 * @state: state to change to.
1614 * Returns zero if unsuccessful or an error if the requested
1615 * transition is illegal.
1618 scsi_device_set_state(struct scsi_device *sdev, enum scsi_device_state state)
1620 enum scsi_device_state oldstate = sdev->sdev_state;
1622 if (state == oldstate)
1623 return 0;
1625 switch (state) {
1626 case SDEV_CREATED:
1627 /* There are no legal states that come back to
1628 * created. This is the manually initialised start
1629 * state */
1630 goto illegal;
1632 case SDEV_RUNNING:
1633 switch (oldstate) {
1634 case SDEV_CREATED:
1635 case SDEV_OFFLINE:
1636 case SDEV_QUIESCE:
1637 break;
1638 default:
1639 goto illegal;
1641 break;
1643 case SDEV_QUIESCE:
1644 switch (oldstate) {
1645 case SDEV_RUNNING:
1646 case SDEV_OFFLINE:
1647 break;
1648 default:
1649 goto illegal;
1651 break;
1653 case SDEV_OFFLINE:
1654 switch (oldstate) {
1655 case SDEV_CREATED:
1656 case SDEV_RUNNING:
1657 case SDEV_QUIESCE:
1658 break;
1659 default:
1660 goto illegal;
1662 break;
1664 case SDEV_CANCEL:
1665 switch (oldstate) {
1666 case SDEV_CREATED:
1667 case SDEV_RUNNING:
1668 case SDEV_OFFLINE:
1669 break;
1670 default:
1671 goto illegal;
1673 break;
1675 case SDEV_DEL:
1676 switch (oldstate) {
1677 case SDEV_CANCEL:
1678 break;
1679 default:
1680 goto illegal;
1682 break;
1685 sdev->sdev_state = state;
1686 return 0;
1688 illegal:
1689 dev_printk(KERN_ERR, &sdev->sdev_gendev,
1690 "Illegal state transition %s->%s\n",
1691 scsi_device_state_name(oldstate),
1692 scsi_device_state_name(state));
1693 WARN_ON(1);
1694 return -EINVAL;
1696 EXPORT_SYMBOL(scsi_device_set_state);
1699 * scsi_device_quiesce - Block user issued commands.
1700 * @sdev: scsi device to quiesce.
1702 * This works by trying to transition to the SDEV_QUIESCE state
1703 * (which must be a legal transition). When the device is in this
1704 * state, only special requests will be accepted, all others will
1705 * be deferred. Since special requests may also be requeued requests,
1706 * a successful return doesn't guarantee the device will be
1707 * totally quiescent.
1709 * Must be called with user context, may sleep.
1711 * Returns zero if unsuccessful or an error if not.
1714 scsi_device_quiesce(struct scsi_device *sdev)
1716 int err = scsi_device_set_state(sdev, SDEV_QUIESCE);
1717 if (err)
1718 return err;
1720 scsi_run_queue(sdev->request_queue);
1721 while (sdev->device_busy) {
1722 schedule_timeout(HZ/5);
1723 scsi_run_queue(sdev->request_queue);
1725 return 0;
1727 EXPORT_SYMBOL(scsi_device_quiesce);
1730 * scsi_device_resume - Restart user issued commands to a quiesced device.
1731 * @sdev: scsi device to resume.
1733 * Moves the device from quiesced back to running and restarts the
1734 * queues.
1736 * Must be called with user context, may sleep.
1738 void
1739 scsi_device_resume(struct scsi_device *sdev)
1741 if(scsi_device_set_state(sdev, SDEV_RUNNING))
1742 return;
1743 scsi_run_queue(sdev->request_queue);
1745 EXPORT_SYMBOL(scsi_device_resume);