2 * Copyright(c) 2007 Intel Corporation. All rights reserved.
3 * Copyright(c) 2008 Red Hat, Inc. All rights reserved.
4 * Copyright(c) 2008 Mike Christie
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 * Maintained at www.Open-FCoE.org
22 #include <linux/module.h>
23 #include <linux/delay.h>
24 #include <linux/kernel.h>
25 #include <linux/types.h>
26 #include <linux/spinlock.h>
27 #include <linux/scatterlist.h>
28 #include <linux/err.h>
29 #include <linux/crc32.h>
31 #include <scsi/scsi_tcq.h>
32 #include <scsi/scsi.h>
33 #include <scsi/scsi_host.h>
34 #include <scsi/scsi_device.h>
35 #include <scsi/scsi_cmnd.h>
37 #include <scsi/fc/fc_fc2.h>
39 #include <scsi/libfc.h>
40 #include <scsi/fc_encode.h>
44 struct kmem_cache *scsi_pkt_cachep;
46 /* SRB state definitions */
47 #define FC_SRB_FREE 0 /* cmd is free */
48 #define FC_SRB_CMD_SENT (1 << 0) /* cmd has been sent */
49 #define FC_SRB_RCV_STATUS (1 << 1) /* response has arrived */
50 #define FC_SRB_ABORT_PENDING (1 << 2) /* cmd abort sent to device */
51 #define FC_SRB_ABORTED (1 << 3) /* abort acknowleged */
52 #define FC_SRB_DISCONTIG (1 << 4) /* non-sequential data recvd */
53 #define FC_SRB_COMPL (1 << 5) /* fc_io_compl has been run */
54 #define FC_SRB_FCP_PROCESSING_TMO (1 << 6) /* timer function processing */
55 #define FC_SRB_NOMEM (1 << 7) /* dropped to out of mem */
57 #define FC_SRB_READ (1 << 1)
58 #define FC_SRB_WRITE (1 << 0)
61 * The SCp.ptr should be tested and set under the host lock. NULL indicates
62 * that the command has been retruned to the scsi layer.
64 #define CMD_SP(Cmnd) ((struct fc_fcp_pkt *)(Cmnd)->SCp.ptr)
65 #define CMD_ENTRY_STATUS(Cmnd) ((Cmnd)->SCp.have_data_in)
66 #define CMD_COMPL_STATUS(Cmnd) ((Cmnd)->SCp.this_residual)
67 #define CMD_SCSI_STATUS(Cmnd) ((Cmnd)->SCp.Status)
68 #define CMD_RESID_LEN(Cmnd) ((Cmnd)->SCp.buffers_residual)
71 * struct fc_fcp_internal - FCP layer internal data
72 * @scsi_pkt_pool: Memory pool to draw FCP packets from
73 * @scsi_pkt_queue: Current FCP packets
74 * @throttled: The FCP packet queue is throttled
76 struct fc_fcp_internal {
77 mempool_t *scsi_pkt_pool;
78 struct list_head scsi_pkt_queue;
82 #define fc_get_scsi_internal(x) ((struct fc_fcp_internal *)(x)->scsi_priv)
86 * FC scsi I/O related functions
88 static void fc_fcp_recv_data(struct fc_fcp_pkt *, struct fc_frame *);
89 static void fc_fcp_recv(struct fc_seq *, struct fc_frame *, void *);
90 static void fc_fcp_resp(struct fc_fcp_pkt *, struct fc_frame *);
91 static void fc_fcp_complete_locked(struct fc_fcp_pkt *);
92 static void fc_tm_done(struct fc_seq *, struct fc_frame *, void *);
93 static void fc_fcp_error(struct fc_fcp_pkt *, struct fc_frame *);
94 static void fc_timeout_error(struct fc_fcp_pkt *);
95 static void fc_fcp_timeout(unsigned long);
96 static void fc_fcp_rec(struct fc_fcp_pkt *);
97 static void fc_fcp_rec_error(struct fc_fcp_pkt *, struct fc_frame *);
98 static void fc_fcp_rec_resp(struct fc_seq *, struct fc_frame *, void *);
99 static void fc_io_compl(struct fc_fcp_pkt *);
101 static void fc_fcp_srr(struct fc_fcp_pkt *, enum fc_rctl, u32);
102 static void fc_fcp_srr_resp(struct fc_seq *, struct fc_frame *, void *);
103 static void fc_fcp_srr_error(struct fc_fcp_pkt *, struct fc_frame *);
106 * command status codes
108 #define FC_COMPLETE 0
109 #define FC_CMD_ABORTED 1
110 #define FC_CMD_RESET 2
111 #define FC_CMD_PLOGO 3
113 #define FC_TRANS_ERR 5
114 #define FC_DATA_OVRRUN 6
115 #define FC_DATA_UNDRUN 7
117 #define FC_HRD_ERROR 9
118 #define FC_CMD_TIME_OUT 10
121 * Error recovery timeout values.
123 #define FC_SCSI_ER_TIMEOUT (10 * HZ)
124 #define FC_SCSI_TM_TOV (10 * HZ)
125 #define FC_SCSI_REC_TOV (2 * HZ)
126 #define FC_HOST_RESET_TIMEOUT (30 * HZ)
128 #define FC_MAX_ERROR_CNT 5
129 #define FC_MAX_RECOV_RETRY 3
131 #define FC_FCP_DFLT_QUEUE_DEPTH 32
134 * fc_fcp_pkt_alloc() - Allocate a fcp_pkt
135 * @lport: The local port that the FCP packet is for
136 * @gfp: GFP flags for allocation
138 * Return value: fcp_pkt structure or null on allocation failure.
139 * Context: Can be called from process context, no lock is required.
141 static struct fc_fcp_pkt *fc_fcp_pkt_alloc(struct fc_lport *lport, gfp_t gfp)
143 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
144 struct fc_fcp_pkt *fsp;
146 fsp = mempool_alloc(si->scsi_pkt_pool, gfp);
148 memset(fsp, 0, sizeof(*fsp));
150 atomic_set(&fsp->ref_cnt, 1);
151 init_timer(&fsp->timer);
152 INIT_LIST_HEAD(&fsp->list);
153 spin_lock_init(&fsp->scsi_pkt_lock);
159 * fc_fcp_pkt_release() - Release hold on a fcp_pkt
160 * @fsp: The FCP packet to be released
162 * Context: Can be called from process or interrupt context,
163 * no lock is required.
165 static void fc_fcp_pkt_release(struct fc_fcp_pkt *fsp)
167 if (atomic_dec_and_test(&fsp->ref_cnt)) {
168 struct fc_fcp_internal *si = fc_get_scsi_internal(fsp->lp);
170 mempool_free(fsp, si->scsi_pkt_pool);
175 * fc_fcp_pkt_hold() - Hold a fcp_pkt
176 * @fsp: The FCP packet to be held
178 static void fc_fcp_pkt_hold(struct fc_fcp_pkt *fsp)
180 atomic_inc(&fsp->ref_cnt);
184 * fc_fcp_pkt_destory() - Release hold on a fcp_pkt
185 * @seq: The sequence that the FCP packet is on (required by destructor API)
186 * @fsp: The FCP packet to be released
188 * This routine is called by a destructor callback in the exch_seq_send()
189 * routine of the libfc Transport Template. The 'struct fc_seq' is a required
190 * argument even though it is not used by this routine.
192 * Context: No locking required.
194 static void fc_fcp_pkt_destroy(struct fc_seq *seq, void *fsp)
196 fc_fcp_pkt_release(fsp);
200 * fc_fcp_lock_pkt() - Lock a fcp_pkt and increase its reference count
201 * @fsp: The FCP packet to be locked and incremented
203 * We should only return error if we return a command to SCSI-ml before
204 * getting a response. This can happen in cases where we send a abort, but
205 * do not wait for the response and the abort and command can be passing
206 * each other on the wire/network-layer.
208 * Note: this function locks the packet and gets a reference to allow
209 * callers to call the completion function while the lock is held and
210 * not have to worry about the packets refcount.
212 * TODO: Maybe we should just have callers grab/release the lock and
213 * have a function that they call to verify the fsp and grab a ref if
216 static inline int fc_fcp_lock_pkt(struct fc_fcp_pkt *fsp)
218 spin_lock_bh(&fsp->scsi_pkt_lock);
219 if (fsp->state & FC_SRB_COMPL) {
220 spin_unlock_bh(&fsp->scsi_pkt_lock);
224 fc_fcp_pkt_hold(fsp);
229 * fc_fcp_unlock_pkt() - Release a fcp_pkt's lock and decrement its
231 * @fsp: The FCP packet to be unlocked and decremented
233 static inline void fc_fcp_unlock_pkt(struct fc_fcp_pkt *fsp)
235 spin_unlock_bh(&fsp->scsi_pkt_lock);
236 fc_fcp_pkt_release(fsp);
240 * fc_fcp_timer_set() - Start a timer for a fcp_pkt
241 * @fsp: The FCP packet to start a timer for
242 * @delay: The timeout period for the timer
244 static void fc_fcp_timer_set(struct fc_fcp_pkt *fsp, unsigned long delay)
246 if (!(fsp->state & FC_SRB_COMPL))
247 mod_timer(&fsp->timer, jiffies + delay);
251 * fc_fcp_send_abort() - Send an abort for exchanges associated with a
253 * @fsp: The FCP packet to abort exchanges on
255 static int fc_fcp_send_abort(struct fc_fcp_pkt *fsp)
260 fsp->state |= FC_SRB_ABORT_PENDING;
261 return fsp->lp->tt.seq_exch_abort(fsp->seq_ptr, 0);
265 * fc_fcp_retry_cmd() - Retry a fcp_pkt
266 * @fsp: The FCP packet to be retried
268 * Sets the status code to be FC_ERROR and then calls
269 * fc_fcp_complete_locked() which in turn calls fc_io_compl().
270 * fc_io_compl() will notify the SCSI-ml that the I/O is done.
271 * The SCSI-ml will retry the command.
273 static void fc_fcp_retry_cmd(struct fc_fcp_pkt *fsp)
276 fsp->lp->tt.exch_done(fsp->seq_ptr);
280 fsp->state &= ~FC_SRB_ABORT_PENDING;
282 fsp->status_code = FC_ERROR;
283 fc_fcp_complete_locked(fsp);
287 * fc_fcp_ddp_setup() - Calls a LLD's ddp_setup routine to set up DDP context
288 * @fsp: The FCP packet that will manage the DDP frames
289 * @xid: The XID that will be used for the DDP exchange
291 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid)
293 struct fc_lport *lport;
299 if ((fsp->req_flags & FC_SRB_READ) &&
300 (lport->lro_enabled) && (lport->tt.ddp_setup)) {
301 if (lport->tt.ddp_setup(lport, xid, scsi_sglist(fsp->cmd),
302 scsi_sg_count(fsp->cmd)))
308 * fc_fcp_ddp_done() - Calls a LLD's ddp_done routine to release any
309 * DDP related resources for a fcp_pkt
310 * @fsp: The FCP packet that DDP had been used on
312 static void fc_fcp_ddp_done(struct fc_fcp_pkt *fsp)
314 struct fc_lport *lport;
319 if (fsp->xfer_ddp == FC_XID_UNKNOWN)
323 if (lport->tt.ddp_done) {
324 fsp->xfer_len = lport->tt.ddp_done(lport, fsp->xfer_ddp);
325 fsp->xfer_ddp = FC_XID_UNKNOWN;
330 * fc_fcp_recv_data() - Handler for receiving SCSI-FCP data from a target
331 * @fsp: The FCP packet the data is on
332 * @fp: The data frame
334 static void fc_fcp_recv_data(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
336 struct scsi_cmnd *sc = fsp->cmd;
337 struct fc_lport *lport = fsp->lp;
338 struct fcoe_dev_stats *stats;
339 struct fc_frame_header *fh;
346 struct scatterlist *sg;
349 fh = fc_frame_header_get(fp);
350 offset = ntohl(fh->fh_parm_offset);
351 start_offset = offset;
352 len = fr_len(fp) - sizeof(*fh);
353 buf = fc_frame_payload_get(fp, 0);
355 /* if this I/O is ddped, update xfer len */
356 fc_fcp_ddp_done(fsp);
358 if (offset + len > fsp->data_len) {
359 /* this should never happen */
360 if ((fr_flags(fp) & FCPHF_CRC_UNCHECKED) &&
361 fc_frame_crc_check(fp))
363 FC_FCP_DBG(fsp, "data received past end. len %zx offset %zx "
364 "data_len %x\n", len, offset, fsp->data_len);
365 fc_fcp_retry_cmd(fsp);
368 if (offset != fsp->xfer_len)
369 fsp->state |= FC_SRB_DISCONTIG;
371 sg = scsi_sglist(sc);
372 nents = scsi_sg_count(sc);
374 if (!(fr_flags(fp) & FCPHF_CRC_UNCHECKED)) {
375 copy_len = fc_copy_buffer_to_sglist(buf, len, sg, &nents,
376 &offset, KM_SOFTIRQ0, NULL);
378 crc = crc32(~0, (u8 *) fh, sizeof(*fh));
379 copy_len = fc_copy_buffer_to_sglist(buf, len, sg, &nents,
380 &offset, KM_SOFTIRQ0, &crc);
381 buf = fc_frame_payload_get(fp, 0);
383 crc = crc32(crc, buf + len, 4 - (len % 4));
385 if (~crc != le32_to_cpu(fr_crc(fp))) {
387 stats = fc_lport_get_stats(lport);
388 stats->ErrorFrames++;
389 /* FIXME - per cpu count, not total count! */
390 if (stats->InvalidCRCCount++ < 5)
391 printk(KERN_WARNING "libfc: CRC error on data "
392 "frame for port (%6x)\n",
393 fc_host_port_id(lport->host));
395 * Assume the frame is total garbage.
396 * We may have copied it over the good part
398 * If so, we need to retry the entire operation.
399 * Otherwise, ignore it.
401 if (fsp->state & FC_SRB_DISCONTIG)
402 fc_fcp_retry_cmd(fsp);
407 if (fsp->xfer_contig_end == start_offset)
408 fsp->xfer_contig_end += copy_len;
409 fsp->xfer_len += copy_len;
412 * In the very rare event that this data arrived after the response
413 * and completes the transfer, call the completion handler.
415 if (unlikely(fsp->state & FC_SRB_RCV_STATUS) &&
416 fsp->xfer_len == fsp->data_len - fsp->scsi_resid)
417 fc_fcp_complete_locked(fsp);
421 * fc_fcp_send_data() - Send SCSI data to a target
422 * @fsp: The FCP packet the data is on
423 * @sp: The sequence the data is to be sent on
424 * @offset: The starting offset for this data request
425 * @seq_blen: The burst length for this data request
427 * Called after receiving a Transfer Ready data descriptor.
428 * If the LLD is capable of sequence offload then send down the
429 * seq_blen ammount of data in single frame, otherwise send
430 * multiple frames of the maximum frame payload supported by
433 static int fc_fcp_send_data(struct fc_fcp_pkt *fsp, struct fc_seq *seq,
434 size_t offset, size_t seq_blen)
437 struct scsi_cmnd *sc;
438 struct scatterlist *sg;
439 struct fc_frame *fp = NULL;
440 struct fc_lport *lport = fsp->lp;
445 size_t frame_offset, fh_parm_offset;
449 int using_sg = lport->sg_supp;
452 WARN_ON(seq_blen <= 0);
453 if (unlikely(offset + seq_blen > fsp->data_len)) {
454 /* this should never happen */
455 FC_FCP_DBG(fsp, "xfer-ready past end. seq_blen %zx "
456 "offset %zx\n", seq_blen, offset);
457 fc_fcp_send_abort(fsp);
459 } else if (offset != fsp->xfer_len) {
460 /* Out of Order Data Request - no problem, but unexpected. */
461 FC_FCP_DBG(fsp, "xfer-ready non-contiguous. "
462 "seq_blen %zx offset %zx\n", seq_blen, offset);
466 * if LLD is capable of seq_offload then set transport
467 * burst length (t_blen) to seq_blen, otherwise set t_blen
468 * to max FC frame payload previously set in fsp->max_payload.
470 t_blen = fsp->max_payload;
471 if (lport->seq_offload) {
472 t_blen = min(seq_blen, (size_t)lport->lso_max);
473 FC_FCP_DBG(fsp, "fsp=%p:lso:blen=%zx lso_max=0x%x t_blen=%zx\n",
474 fsp, seq_blen, lport->lso_max, t_blen);
477 WARN_ON(t_blen < FC_MIN_MAX_PAYLOAD);
479 t_blen &= ~(512 - 1); /* round down to block size */
480 WARN_ON(t_blen < FC_MIN_MAX_PAYLOAD); /* won't go below 256 */
483 remaining = seq_blen;
484 fh_parm_offset = frame_offset = offset;
486 seq = lport->tt.seq_start_next(seq);
487 f_ctl = FC_FC_REL_OFF;
490 sg = scsi_sglist(sc);
492 while (remaining > 0 && sg) {
493 if (offset >= sg->length) {
494 offset -= sg->length;
499 tlen = min(t_blen, remaining);
502 * TODO. Temporary workaround. fc_seq_send() can't
503 * handle odd lengths in non-linear skbs.
504 * This will be the final fragment only.
509 fp = _fc_frame_alloc(lport, 0);
513 fp = fc_frame_alloc(lport, tlen);
517 data = (void *)(fr_hdr(fp)) +
518 sizeof(struct fc_frame_header);
520 fh_parm_offset = frame_offset;
521 fr_max_payload(fp) = fsp->max_payload;
523 sg_bytes = min(tlen, sg->length - offset);
525 get_page(sg_page(sg));
526 skb_fill_page_desc(fp_skb(fp),
527 skb_shinfo(fp_skb(fp))->nr_frags,
528 sg_page(sg), sg->offset + offset,
530 fp_skb(fp)->data_len += sg_bytes;
531 fr_len(fp) += sg_bytes;
532 fp_skb(fp)->truesize += PAGE_SIZE;
534 size_t off = offset + sg->offset;
537 * The scatterlist item may be bigger than PAGE_SIZE,
538 * but we must not cross pages inside the kmap.
540 sg_bytes = min(sg_bytes, (size_t) (PAGE_SIZE -
541 (off & ~PAGE_MASK)));
542 page_addr = kmap_atomic(sg_page(sg) +
545 memcpy(data, (char *)page_addr + (off & ~PAGE_MASK),
547 kunmap_atomic(page_addr, KM_SOFTIRQ0);
551 frame_offset += sg_bytes;
553 remaining -= sg_bytes;
555 if ((skb_shinfo(fp_skb(fp))->nr_frags < FC_FRAME_SG_LEN) &&
560 * Send sequence with transfer sequence initiative in case
561 * this is last FCP frame of the sequence.
564 f_ctl |= FC_FC_SEQ_INIT | FC_FC_END_SEQ;
566 ep = fc_seq_exch(seq);
567 fc_fill_fc_hdr(fp, FC_RCTL_DD_SOL_DATA, ep->did, ep->sid,
568 FC_TYPE_FCP, f_ctl, fh_parm_offset);
571 * send fragment using for a sequence.
573 error = lport->tt.seq_send(lport, seq, fp);
575 WARN_ON(1); /* send error should be rare */
576 fc_fcp_retry_cmd(fsp);
581 fsp->xfer_len += seq_blen; /* premature count? */
586 * fc_fcp_abts_resp() - Send an ABTS response
587 * @fsp: The FCP packet that is being aborted
588 * @fp: The response frame
590 static void fc_fcp_abts_resp(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
593 struct fc_ba_rjt *brp;
594 struct fc_frame_header *fh;
596 fh = fc_frame_header_get(fp);
597 switch (fh->fh_r_ctl) {
601 brp = fc_frame_payload_get(fp, sizeof(*brp));
602 if (brp && brp->br_reason == FC_BA_RJT_LOG_ERR)
607 * we will let the command timeout
608 * and scsi-ml recover in this case,
609 * therefore cleared the ba_done flag.
615 fsp->state |= FC_SRB_ABORTED;
616 fsp->state &= ~FC_SRB_ABORT_PENDING;
618 if (fsp->wait_for_comp)
619 complete(&fsp->tm_done);
621 fc_fcp_complete_locked(fsp);
626 * fc_fcp_reduce_can_queue() - Reduce the can_queue value for a local port
627 * @lport: The local port to reduce can_queue on
629 * If we are getting memory allocation failures, then we may
630 * be trying to execute too many commands. We let the running
631 * commands complete or timeout, then try again with a reduced
632 * can_queue. Eventually we will hit the point where we run
633 * on all reserved structs.
635 static void fc_fcp_reduce_can_queue(struct fc_lport *lport)
637 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
641 spin_lock_irqsave(lport->host->host_lock, flags);
646 can_queue = lport->host->can_queue;
650 lport->host->can_queue = can_queue;
651 shost_printk(KERN_ERR, lport->host, "libfc: Could not allocate frame.\n"
652 "Reducing can_queue to %d.\n", can_queue);
654 spin_unlock_irqrestore(lport->host->host_lock, flags);
658 * fc_fcp_recv() - Reveive an FCP frame
659 * @seq: The sequence the frame is on
660 * @fp: The received frame
661 * @arg: The related FCP packet
663 * Context: Called from Soft IRQ context. Can not be called
664 * holding the FCP packet list lock.
666 static void fc_fcp_recv(struct fc_seq *seq, struct fc_frame *fp, void *arg)
668 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)arg;
669 struct fc_lport *lport = fsp->lp;
670 struct fc_frame_header *fh;
671 struct fcp_txrdy *dd;
678 fh = fc_frame_header_get(fp);
679 r_ctl = fh->fh_r_ctl;
681 if (!(lport->state & LPORT_ST_READY))
683 if (fc_fcp_lock_pkt(fsp))
685 fsp->last_pkt_time = jiffies;
687 if (fh->fh_type == FC_TYPE_BLS) {
688 fc_fcp_abts_resp(fsp, fp);
692 if (fsp->state & (FC_SRB_ABORTED | FC_SRB_ABORT_PENDING))
695 if (r_ctl == FC_RCTL_DD_DATA_DESC) {
697 * received XFER RDY from the target
698 * need to send data to the target
700 WARN_ON(fr_flags(fp) & FCPHF_CRC_UNCHECKED);
701 dd = fc_frame_payload_get(fp, sizeof(*dd));
704 rc = fc_fcp_send_data(fsp, seq,
705 (size_t) ntohl(dd->ft_data_ro),
706 (size_t) ntohl(dd->ft_burst_len));
708 seq->rec_data = fsp->xfer_len;
709 else if (rc == -ENOMEM)
710 fsp->state |= FC_SRB_NOMEM;
711 } else if (r_ctl == FC_RCTL_DD_SOL_DATA) {
713 * received a DATA frame
714 * next we will copy the data to the system buffer
716 WARN_ON(fr_len(fp) < sizeof(*fh)); /* len may be 0 */
717 fc_fcp_recv_data(fsp, fp);
718 seq->rec_data = fsp->xfer_contig_end;
719 } else if (r_ctl == FC_RCTL_DD_CMD_STATUS) {
720 WARN_ON(fr_flags(fp) & FCPHF_CRC_UNCHECKED);
722 fc_fcp_resp(fsp, fp);
724 FC_FCP_DBG(fsp, "unexpected frame. r_ctl %x\n", r_ctl);
727 fc_fcp_unlock_pkt(fsp);
732 fc_fcp_error(fsp, fp);
733 else if (rc == -ENOMEM)
734 fc_fcp_reduce_can_queue(lport);
738 * fc_fcp_resp() - Handler for FCP responses
739 * @fsp: The FCP packet the response is for
740 * @fp: The response frame
742 static void fc_fcp_resp(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
744 struct fc_frame_header *fh;
745 struct fcp_resp *fc_rp;
746 struct fcp_resp_ext *rp_ex;
747 struct fcp_resp_rsp_info *fc_rp_info;
755 fh = (struct fc_frame_header *)fr_hdr(fp);
756 if (unlikely(plen < sizeof(*fh) + sizeof(*fc_rp)))
759 fc_rp = (struct fcp_resp *)(fh + 1);
760 fsp->cdb_status = fc_rp->fr_status;
761 flags = fc_rp->fr_flags;
762 fsp->scsi_comp_flags = flags;
763 expected_len = fsp->data_len;
765 /* if ddp, update xfer len */
766 fc_fcp_ddp_done(fsp);
768 if (unlikely((flags & ~FCP_CONF_REQ) || fc_rp->fr_status)) {
769 rp_ex = (void *)(fc_rp + 1);
770 if (flags & (FCP_RSP_LEN_VAL | FCP_SNS_LEN_VAL)) {
771 if (plen < sizeof(*fc_rp) + sizeof(*rp_ex))
773 fc_rp_info = (struct fcp_resp_rsp_info *)(rp_ex + 1);
774 if (flags & FCP_RSP_LEN_VAL) {
775 respl = ntohl(rp_ex->fr_rsp_len);
776 if (respl != sizeof(*fc_rp_info))
778 if (fsp->wait_for_comp) {
779 /* Abuse cdb_status for rsp code */
780 fsp->cdb_status = fc_rp_info->rsp_code;
781 complete(&fsp->tm_done);
783 * tmfs will not have any scsi cmd so
790 if (flags & FCP_SNS_LEN_VAL) {
791 snsl = ntohl(rp_ex->fr_sns_len);
792 if (snsl > SCSI_SENSE_BUFFERSIZE)
793 snsl = SCSI_SENSE_BUFFERSIZE;
794 memcpy(fsp->cmd->sense_buffer,
795 (char *)fc_rp_info + respl, snsl);
798 if (flags & (FCP_RESID_UNDER | FCP_RESID_OVER)) {
799 if (plen < sizeof(*fc_rp) + sizeof(rp_ex->fr_resid))
801 if (flags & FCP_RESID_UNDER) {
802 fsp->scsi_resid = ntohl(rp_ex->fr_resid);
804 * The cmnd->underflow is the minimum number of
805 * bytes that must be transfered for this
806 * command. Provided a sense condition is not
807 * present, make sure the actual amount
808 * transferred is at least the underflow value
811 if (!(flags & FCP_SNS_LEN_VAL) &&
812 (fc_rp->fr_status == 0) &&
813 (scsi_bufflen(fsp->cmd) -
814 fsp->scsi_resid) < fsp->cmd->underflow)
816 expected_len -= fsp->scsi_resid;
818 fsp->status_code = FC_ERROR;
822 fsp->state |= FC_SRB_RCV_STATUS;
825 * Check for missing or extra data frames.
827 if (unlikely(fsp->xfer_len != expected_len)) {
828 if (fsp->xfer_len < expected_len) {
830 * Some data may be queued locally,
831 * Wait a at least one jiffy to see if it is delivered.
832 * If this expires without data, we may do SRR.
834 fc_fcp_timer_set(fsp, 2);
837 fsp->status_code = FC_DATA_OVRRUN;
838 FC_FCP_DBG(fsp, "tgt %6x xfer len %zx greater than expected, "
839 "len %x, data len %x\n",
841 fsp->xfer_len, expected_len, fsp->data_len);
843 fc_fcp_complete_locked(fsp);
847 FC_FCP_DBG(fsp, "short FCP response. flags 0x%x len %u respl %u "
848 "snsl %u\n", flags, fr_len(fp), respl, snsl);
850 fsp->status_code = FC_ERROR;
851 fc_fcp_complete_locked(fsp);
855 * fc_fcp_complete_locked() - Complete processing of a fcp_pkt with the
857 * @fsp: The FCP packet to be completed
859 * This function may sleep if a timer is pending. The packet lock must be
860 * held, and the host lock must not be held.
862 static void fc_fcp_complete_locked(struct fc_fcp_pkt *fsp)
864 struct fc_lport *lport = fsp->lp;
869 if (fsp->state & FC_SRB_ABORT_PENDING)
872 if (fsp->state & FC_SRB_ABORTED) {
873 if (!fsp->status_code)
874 fsp->status_code = FC_CMD_ABORTED;
877 * Test for transport underrun, independent of response
880 if (fsp->xfer_len < fsp->data_len && !fsp->io_status &&
881 (!(fsp->scsi_comp_flags & FCP_RESID_UNDER) ||
882 fsp->xfer_len < fsp->data_len - fsp->scsi_resid)) {
883 fsp->status_code = FC_DATA_UNDRUN;
891 if (unlikely(fsp->scsi_comp_flags & FCP_CONF_REQ)) {
892 struct fc_frame *conf_frame;
895 csp = lport->tt.seq_start_next(seq);
896 conf_frame = fc_frame_alloc(fsp->lp, 0);
898 f_ctl = FC_FC_SEQ_INIT;
899 f_ctl |= FC_FC_LAST_SEQ | FC_FC_END_SEQ;
900 ep = fc_seq_exch(seq);
901 fc_fill_fc_hdr(conf_frame, FC_RCTL_DD_SOL_CTL,
903 FC_TYPE_FCP, f_ctl, 0);
904 lport->tt.seq_send(lport, csp, conf_frame);
907 lport->tt.exch_done(seq);
913 * fc_fcp_cleanup_cmd() - Cancel the active exchange on a fcp_pkt
914 * @fsp: The FCP packet whose exchanges should be canceled
915 * @error: The reason for the cancellation
917 static void fc_fcp_cleanup_cmd(struct fc_fcp_pkt *fsp, int error)
919 struct fc_lport *lport = fsp->lp;
922 lport->tt.exch_done(fsp->seq_ptr);
925 fsp->status_code = error;
929 * fc_fcp_cleanup_each_cmd() - Cancel all exchanges on a local port
930 * @lport: The local port whose exchanges should be canceled
931 * @id: The target's ID
933 * @error: The reason for cancellation
935 * If lun or id is -1, they are ignored.
937 static void fc_fcp_cleanup_each_cmd(struct fc_lport *lport, unsigned int id,
938 unsigned int lun, int error)
940 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
941 struct fc_fcp_pkt *fsp;
942 struct scsi_cmnd *sc_cmd;
945 spin_lock_irqsave(lport->host->host_lock, flags);
947 list_for_each_entry(fsp, &si->scsi_pkt_queue, list) {
949 if (id != -1 && scmd_id(sc_cmd) != id)
952 if (lun != -1 && sc_cmd->device->lun != lun)
955 fc_fcp_pkt_hold(fsp);
956 spin_unlock_irqrestore(lport->host->host_lock, flags);
958 if (!fc_fcp_lock_pkt(fsp)) {
959 fc_fcp_cleanup_cmd(fsp, error);
961 fc_fcp_unlock_pkt(fsp);
964 fc_fcp_pkt_release(fsp);
965 spin_lock_irqsave(lport->host->host_lock, flags);
967 * while we dropped the lock multiple pkts could
968 * have been released, so we have to start over.
972 spin_unlock_irqrestore(lport->host->host_lock, flags);
976 * fc_fcp_abort_io() - Abort all FCP-SCSI exchanges on a local port
977 * @lport: The local port whose exchanges are to be aborted
979 static void fc_fcp_abort_io(struct fc_lport *lport)
981 fc_fcp_cleanup_each_cmd(lport, -1, -1, FC_HRD_ERROR);
985 * fc_fcp_pkt_send() - Send a fcp_pkt
986 * @lport: The local port to send the FCP packet on
987 * @fsp: The FCP packet to send
989 * Return: Zero for success and -1 for failure
990 * Locks: Called with the host lock and irqs disabled.
992 static int fc_fcp_pkt_send(struct fc_lport *lport, struct fc_fcp_pkt *fsp)
994 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
997 fsp->cmd->SCp.ptr = (char *)fsp;
998 fsp->cdb_cmd.fc_dl = htonl(fsp->data_len);
999 fsp->cdb_cmd.fc_flags = fsp->req_flags & ~FCP_CFL_LEN_MASK;
1001 int_to_scsilun(fsp->cmd->device->lun,
1002 (struct scsi_lun *)fsp->cdb_cmd.fc_lun);
1003 memcpy(fsp->cdb_cmd.fc_cdb, fsp->cmd->cmnd, fsp->cmd->cmd_len);
1004 list_add_tail(&fsp->list, &si->scsi_pkt_queue);
1006 spin_unlock_irq(lport->host->host_lock);
1007 rc = lport->tt.fcp_cmd_send(lport, fsp, fc_fcp_recv);
1008 spin_lock_irq(lport->host->host_lock);
1010 list_del(&fsp->list);
1016 * fc_fcp_cmd_send() - Send a FCP command
1017 * @lport: The local port to send the command on
1018 * @fsp: The FCP packet the command is on
1019 * @resp: The handler for the response
1021 static int fc_fcp_cmd_send(struct fc_lport *lport, struct fc_fcp_pkt *fsp,
1022 void (*resp)(struct fc_seq *,
1023 struct fc_frame *fp,
1026 struct fc_frame *fp;
1028 struct fc_rport *rport;
1029 struct fc_rport_libfc_priv *rpriv;
1030 const size_t len = sizeof(fsp->cdb_cmd);
1033 if (fc_fcp_lock_pkt(fsp))
1036 fp = fc_frame_alloc(lport, sizeof(fsp->cdb_cmd));
1042 memcpy(fc_frame_payload_get(fp, len), &fsp->cdb_cmd, len);
1045 fsp->max_payload = rport->maxframe_size;
1046 rpriv = rport->dd_data;
1048 fc_fill_fc_hdr(fp, FC_RCTL_DD_UNSOL_CMD, rport->port_id,
1049 fc_host_port_id(rpriv->local_port->host), FC_TYPE_FCP,
1050 FC_FC_FIRST_SEQ | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
1052 seq = lport->tt.exch_seq_send(lport, fp, resp, fc_fcp_pkt_destroy,
1058 fsp->last_pkt_time = jiffies;
1060 fc_fcp_pkt_hold(fsp); /* hold for fc_fcp_pkt_destroy */
1062 setup_timer(&fsp->timer, fc_fcp_timeout, (unsigned long)fsp);
1063 fc_fcp_timer_set(fsp,
1064 (fsp->tgt_flags & FC_RP_FLAGS_REC_SUPPORTED) ?
1065 FC_SCSI_REC_TOV : FC_SCSI_ER_TIMEOUT);
1067 fc_fcp_unlock_pkt(fsp);
1072 * fc_fcp_error() - Handler for FCP layer errors
1073 * @fsp: The FCP packet the error is on
1074 * @fp: The frame that has errored
1076 static void fc_fcp_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
1078 int error = PTR_ERR(fp);
1080 if (fc_fcp_lock_pkt(fsp))
1083 if (error == -FC_EX_CLOSED) {
1084 fc_fcp_retry_cmd(fsp);
1089 * clear abort pending, because the lower layer
1090 * decided to force completion.
1092 fsp->state &= ~FC_SRB_ABORT_PENDING;
1093 fsp->status_code = FC_CMD_PLOGO;
1094 fc_fcp_complete_locked(fsp);
1096 fc_fcp_unlock_pkt(fsp);
1100 * fc_fcp_pkt_abort() - Abort a fcp_pkt
1101 * @fsp: The FCP packet to abort on
1103 * Called to send an abort and then wait for abort completion
1105 static int fc_fcp_pkt_abort(struct fc_fcp_pkt *fsp)
1109 if (fc_fcp_send_abort(fsp))
1112 init_completion(&fsp->tm_done);
1113 fsp->wait_for_comp = 1;
1115 spin_unlock_bh(&fsp->scsi_pkt_lock);
1116 rc = wait_for_completion_timeout(&fsp->tm_done, FC_SCSI_TM_TOV);
1117 spin_lock_bh(&fsp->scsi_pkt_lock);
1118 fsp->wait_for_comp = 0;
1121 FC_FCP_DBG(fsp, "target abort cmd failed\n");
1123 } else if (fsp->state & FC_SRB_ABORTED) {
1124 FC_FCP_DBG(fsp, "target abort cmd passed\n");
1126 fc_fcp_complete_locked(fsp);
1133 * fc_lun_reset_send() - Send LUN reset command
1134 * @data: The FCP packet that identifies the LUN to be reset
1136 static void fc_lun_reset_send(unsigned long data)
1138 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)data;
1139 struct fc_lport *lport = fsp->lp;
1140 if (lport->tt.fcp_cmd_send(lport, fsp, fc_tm_done)) {
1141 if (fsp->recov_retry++ >= FC_MAX_RECOV_RETRY)
1143 if (fc_fcp_lock_pkt(fsp))
1145 setup_timer(&fsp->timer, fc_lun_reset_send, (unsigned long)fsp);
1146 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1147 fc_fcp_unlock_pkt(fsp);
1152 * fc_lun_reset() - Send a LUN RESET command to a device
1153 * and wait for the reply
1154 * @lport: The local port to sent the comand on
1155 * @fsp: The FCP packet that identifies the LUN to be reset
1156 * @id: The SCSI command ID
1157 * @lun: The LUN ID to be reset
1159 static int fc_lun_reset(struct fc_lport *lport, struct fc_fcp_pkt *fsp,
1160 unsigned int id, unsigned int lun)
1164 fsp->cdb_cmd.fc_dl = htonl(fsp->data_len);
1165 fsp->cdb_cmd.fc_tm_flags = FCP_TMF_LUN_RESET;
1166 int_to_scsilun(lun, (struct scsi_lun *)fsp->cdb_cmd.fc_lun);
1168 fsp->wait_for_comp = 1;
1169 init_completion(&fsp->tm_done);
1171 fc_lun_reset_send((unsigned long)fsp);
1174 * wait for completion of reset
1175 * after that make sure all commands are terminated
1177 rc = wait_for_completion_timeout(&fsp->tm_done, FC_SCSI_TM_TOV);
1179 spin_lock_bh(&fsp->scsi_pkt_lock);
1180 fsp->state |= FC_SRB_COMPL;
1181 spin_unlock_bh(&fsp->scsi_pkt_lock);
1183 del_timer_sync(&fsp->timer);
1185 spin_lock_bh(&fsp->scsi_pkt_lock);
1187 lport->tt.exch_done(fsp->seq_ptr);
1188 fsp->seq_ptr = NULL;
1190 fsp->wait_for_comp = 0;
1191 spin_unlock_bh(&fsp->scsi_pkt_lock);
1194 FC_SCSI_DBG(lport, "lun reset failed\n");
1198 /* cdb_status holds the tmf's rsp code */
1199 if (fsp->cdb_status != FCP_TMF_CMPL)
1202 FC_SCSI_DBG(lport, "lun reset to lun %u completed\n", lun);
1203 fc_fcp_cleanup_each_cmd(lport, id, lun, FC_CMD_ABORTED);
1208 * fc_tm_done() - Task Managment response handler
1209 * @seq: The sequence that the response is on
1210 * @fp: The response frame
1211 * @arg: The FCP packet the response is for
1213 static void fc_tm_done(struct fc_seq *seq, struct fc_frame *fp, void *arg)
1215 struct fc_fcp_pkt *fsp = arg;
1216 struct fc_frame_header *fh;
1220 * If there is an error just let it timeout or wait
1221 * for TMF to be aborted if it timedout.
1223 * scsi-eh will escalate for when either happens.
1228 if (fc_fcp_lock_pkt(fsp))
1232 * raced with eh timeout handler.
1234 if (!fsp->seq_ptr || !fsp->wait_for_comp) {
1235 spin_unlock_bh(&fsp->scsi_pkt_lock);
1239 fh = fc_frame_header_get(fp);
1240 if (fh->fh_type != FC_TYPE_BLS)
1241 fc_fcp_resp(fsp, fp);
1242 fsp->seq_ptr = NULL;
1243 fsp->lp->tt.exch_done(seq);
1245 fc_fcp_unlock_pkt(fsp);
1249 * fc_fcp_cleanup() - Cleanup all FCP exchanges on a local port
1250 * @lport: The local port to be cleaned up
1252 static void fc_fcp_cleanup(struct fc_lport *lport)
1254 fc_fcp_cleanup_each_cmd(lport, -1, -1, FC_ERROR);
1258 * fc_fcp_timeout() - Handler for fcp_pkt timeouts
1259 * @data: The FCP packet that has timed out
1261 * If REC is supported then just issue it and return. The REC exchange will
1262 * complete or time out and recovery can continue at that point. Otherwise,
1263 * if the response has been received without all the data it has been
1264 * ER_TIMEOUT since the response was received. If the response has not been
1265 * received we see if data was received recently. If it has been then we
1266 * continue waiting, otherwise, we abort the command.
1268 static void fc_fcp_timeout(unsigned long data)
1270 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)data;
1271 struct fc_rport *rport = fsp->rport;
1272 struct fc_rport_libfc_priv *rpriv = rport->dd_data;
1274 if (fc_fcp_lock_pkt(fsp))
1277 if (fsp->cdb_cmd.fc_tm_flags)
1280 fsp->state |= FC_SRB_FCP_PROCESSING_TMO;
1282 if (rpriv->flags & FC_RP_FLAGS_REC_SUPPORTED)
1284 else if (time_after_eq(fsp->last_pkt_time + (FC_SCSI_ER_TIMEOUT / 2),
1286 fc_fcp_timer_set(fsp, FC_SCSI_ER_TIMEOUT);
1287 else if (fsp->state & FC_SRB_RCV_STATUS)
1288 fc_fcp_complete_locked(fsp);
1290 fc_timeout_error(fsp);
1291 fsp->state &= ~FC_SRB_FCP_PROCESSING_TMO;
1293 fc_fcp_unlock_pkt(fsp);
1297 * fc_fcp_rec() - Send a REC ELS request
1298 * @fsp: The FCP packet to send the REC request on
1300 static void fc_fcp_rec(struct fc_fcp_pkt *fsp)
1302 struct fc_lport *lport;
1303 struct fc_frame *fp;
1304 struct fc_rport *rport;
1305 struct fc_rport_libfc_priv *rpriv;
1309 rpriv = rport->dd_data;
1310 if (!fsp->seq_ptr || rpriv->rp_state != RPORT_ST_READY) {
1311 fsp->status_code = FC_HRD_ERROR;
1313 fc_fcp_complete_locked(fsp);
1316 fp = fc_frame_alloc(lport, sizeof(struct fc_els_rec));
1320 fr_seq(fp) = fsp->seq_ptr;
1321 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REQ, rport->port_id,
1322 fc_host_port_id(rpriv->local_port->host), FC_TYPE_ELS,
1323 FC_FC_FIRST_SEQ | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
1324 if (lport->tt.elsct_send(lport, rport->port_id, fp, ELS_REC,
1325 fc_fcp_rec_resp, fsp,
1326 jiffies_to_msecs(FC_SCSI_REC_TOV))) {
1327 fc_fcp_pkt_hold(fsp); /* hold while REC outstanding */
1331 if (fsp->recov_retry++ < FC_MAX_RECOV_RETRY)
1332 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1334 fc_timeout_error(fsp);
1338 * fc_fcp_rec_resp() - Handler for REC ELS responses
1339 * @seq: The sequence the response is on
1340 * @fp: The response frame
1341 * @arg: The FCP packet the response is on
1343 * If the response is a reject then the scsi layer will handle
1344 * the timeout. If the response is a LS_ACC then if the I/O was not completed
1345 * set the timeout and return. If the I/O was completed then complete the
1346 * exchange and tell the SCSI layer.
1348 static void fc_fcp_rec_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg)
1350 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)arg;
1351 struct fc_els_rec_acc *recp;
1352 struct fc_els_ls_rjt *rjt;
1356 enum dma_data_direction data_dir;
1358 struct fc_rport_libfc_priv *rpriv;
1361 fc_fcp_rec_error(fsp, fp);
1365 if (fc_fcp_lock_pkt(fsp))
1368 fsp->recov_retry = 0;
1369 opcode = fc_frame_payload_op(fp);
1370 if (opcode == ELS_LS_RJT) {
1371 rjt = fc_frame_payload_get(fp, sizeof(*rjt));
1372 switch (rjt->er_reason) {
1374 FC_FCP_DBG(fsp, "device %x unexpected REC reject "
1375 "reason %d expl %d\n",
1376 fsp->rport->port_id, rjt->er_reason,
1380 FC_FCP_DBG(fsp, "device does not support REC\n");
1381 rpriv = fsp->rport->dd_data;
1383 * if we do not spport RECs or got some bogus
1384 * reason then resetup timer so we check for
1387 rpriv->flags &= ~FC_RP_FLAGS_REC_SUPPORTED;
1388 fc_fcp_timer_set(fsp, FC_SCSI_ER_TIMEOUT);
1393 * If no data transfer, the command frame got dropped
1394 * so we just retry. If data was transferred, we
1395 * lost the response but the target has no record,
1396 * so we abort and retry.
1398 if (rjt->er_explan == ELS_EXPL_OXID_RXID &&
1399 fsp->xfer_len == 0) {
1400 fc_fcp_retry_cmd(fsp);
1403 fc_timeout_error(fsp);
1406 } else if (opcode == ELS_LS_ACC) {
1407 if (fsp->state & FC_SRB_ABORTED)
1410 data_dir = fsp->cmd->sc_data_direction;
1411 recp = fc_frame_payload_get(fp, sizeof(*recp));
1412 offset = ntohl(recp->reca_fc4value);
1413 e_stat = ntohl(recp->reca_e_stat);
1415 if (e_stat & ESB_ST_COMPLETE) {
1418 * The exchange is complete.
1420 * For output, we must've lost the response.
1421 * For input, all data must've been sent.
1422 * We lost may have lost the response
1423 * (and a confirmation was requested) and maybe
1426 * If all data received, send SRR
1427 * asking for response. If partial data received,
1428 * or gaps, SRR requests data at start of gap.
1429 * Recovery via SRR relies on in-order-delivery.
1431 if (data_dir == DMA_TO_DEVICE) {
1432 r_ctl = FC_RCTL_DD_CMD_STATUS;
1433 } else if (fsp->xfer_contig_end == offset) {
1434 r_ctl = FC_RCTL_DD_CMD_STATUS;
1436 offset = fsp->xfer_contig_end;
1437 r_ctl = FC_RCTL_DD_SOL_DATA;
1439 fc_fcp_srr(fsp, r_ctl, offset);
1440 } else if (e_stat & ESB_ST_SEQ_INIT) {
1443 * The remote port has the initiative, so just
1444 * keep waiting for it to complete.
1446 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1450 * The exchange is incomplete, we have seq. initiative.
1451 * Lost response with requested confirmation,
1452 * lost confirmation, lost transfer ready or
1455 * For output, if not all data was received, ask
1456 * for transfer ready to be repeated.
1458 * If we received or sent all the data, send SRR to
1461 * If we lost a response, we may have lost some read
1464 r_ctl = FC_RCTL_DD_SOL_DATA;
1465 if (data_dir == DMA_TO_DEVICE) {
1466 r_ctl = FC_RCTL_DD_CMD_STATUS;
1467 if (offset < fsp->data_len)
1468 r_ctl = FC_RCTL_DD_DATA_DESC;
1469 } else if (offset == fsp->xfer_contig_end) {
1470 r_ctl = FC_RCTL_DD_CMD_STATUS;
1471 } else if (fsp->xfer_contig_end < offset) {
1472 offset = fsp->xfer_contig_end;
1474 fc_fcp_srr(fsp, r_ctl, offset);
1478 fc_fcp_unlock_pkt(fsp);
1480 fc_fcp_pkt_release(fsp); /* drop hold for outstanding REC */
1485 * fc_fcp_rec_error() - Handler for REC errors
1486 * @fsp: The FCP packet the error is on
1487 * @fp: The REC frame
1489 static void fc_fcp_rec_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
1491 int error = PTR_ERR(fp);
1493 if (fc_fcp_lock_pkt(fsp))
1498 fc_fcp_retry_cmd(fsp);
1502 FC_FCP_DBG(fsp, "REC %p fid %x error unexpected error %d\n",
1503 fsp, fsp->rport->port_id, error);
1504 fsp->status_code = FC_CMD_PLOGO;
1507 case -FC_EX_TIMEOUT:
1509 * Assume REC or LS_ACC was lost.
1510 * The exchange manager will have aborted REC, so retry.
1512 FC_FCP_DBG(fsp, "REC fid %x error error %d retry %d/%d\n",
1513 fsp->rport->port_id, error, fsp->recov_retry,
1514 FC_MAX_RECOV_RETRY);
1515 if (fsp->recov_retry++ < FC_MAX_RECOV_RETRY)
1518 fc_timeout_error(fsp);
1521 fc_fcp_unlock_pkt(fsp);
1523 fc_fcp_pkt_release(fsp); /* drop hold for outstanding REC */
1527 * fc_timeout_error() - Handler for fcp_pkt timeouts
1528 * @fsp: The FCP packt that has timed out
1530 static void fc_timeout_error(struct fc_fcp_pkt *fsp)
1532 fsp->status_code = FC_CMD_TIME_OUT;
1533 fsp->cdb_status = 0;
1536 * if this fails then we let the scsi command timer fire and
1539 fc_fcp_send_abort(fsp);
1543 * fc_fcp_srr() - Send a SRR request (Sequence Retransmission Request)
1544 * @fsp: The FCP packet the SRR is to be sent on
1545 * @r_ctl: The R_CTL field for the SRR request
1546 * This is called after receiving status but insufficient data, or
1547 * when expecting status but the request has timed out.
1549 static void fc_fcp_srr(struct fc_fcp_pkt *fsp, enum fc_rctl r_ctl, u32 offset)
1551 struct fc_lport *lport = fsp->lp;
1552 struct fc_rport *rport;
1553 struct fc_rport_libfc_priv *rpriv;
1554 struct fc_exch *ep = fc_seq_exch(fsp->seq_ptr);
1556 struct fcp_srr *srr;
1557 struct fc_frame *fp;
1561 rpriv = rport->dd_data;
1562 cdb_op = fsp->cdb_cmd.fc_cdb[0];
1564 if (!(rpriv->flags & FC_RP_FLAGS_RETRY) ||
1565 rpriv->rp_state != RPORT_ST_READY)
1566 goto retry; /* shouldn't happen */
1567 fp = fc_frame_alloc(lport, sizeof(*srr));
1571 srr = fc_frame_payload_get(fp, sizeof(*srr));
1572 memset(srr, 0, sizeof(*srr));
1573 srr->srr_op = ELS_SRR;
1574 srr->srr_ox_id = htons(ep->oxid);
1575 srr->srr_rx_id = htons(ep->rxid);
1576 srr->srr_r_ctl = r_ctl;
1577 srr->srr_rel_off = htonl(offset);
1579 fc_fill_fc_hdr(fp, FC_RCTL_ELS4_REQ, rport->port_id,
1580 fc_host_port_id(rpriv->local_port->host), FC_TYPE_FCP,
1581 FC_FC_FIRST_SEQ | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
1583 seq = lport->tt.exch_seq_send(lport, fp, fc_fcp_srr_resp, NULL,
1584 fsp, jiffies_to_msecs(FC_SCSI_REC_TOV));
1588 fsp->recov_seq = seq;
1589 fsp->xfer_len = offset;
1590 fsp->xfer_contig_end = offset;
1591 fsp->state &= ~FC_SRB_RCV_STATUS;
1592 fc_fcp_pkt_hold(fsp); /* hold for outstanding SRR */
1595 fc_fcp_retry_cmd(fsp);
1599 * fc_fcp_srr_resp() - Handler for SRR response
1600 * @seq: The sequence the SRR is on
1601 * @fp: The SRR frame
1602 * @arg: The FCP packet the SRR is on
1604 static void fc_fcp_srr_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg)
1606 struct fc_fcp_pkt *fsp = arg;
1607 struct fc_frame_header *fh;
1610 fc_fcp_srr_error(fsp, fp);
1614 if (fc_fcp_lock_pkt(fsp))
1617 fh = fc_frame_header_get(fp);
1619 * BUG? fc_fcp_srr_error calls exch_done which would release
1620 * the ep. But if fc_fcp_srr_error had got -FC_EX_TIMEOUT,
1621 * then fc_exch_timeout would be sending an abort. The exch_done
1622 * call by fc_fcp_srr_error would prevent fc_exch.c from seeing
1623 * an abort response though.
1625 if (fh->fh_type == FC_TYPE_BLS) {
1626 fc_fcp_unlock_pkt(fsp);
1630 fsp->recov_seq = NULL;
1631 switch (fc_frame_payload_op(fp)) {
1633 fsp->recov_retry = 0;
1634 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1638 fc_timeout_error(fsp);
1641 fc_fcp_unlock_pkt(fsp);
1642 fsp->lp->tt.exch_done(seq);
1645 fc_fcp_pkt_release(fsp); /* drop hold for outstanding SRR */
1649 * fc_fcp_srr_error() - Handler for SRR errors
1650 * @fsp: The FCP packet that the SRR error is on
1651 * @fp: The SRR frame
1653 static void fc_fcp_srr_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
1655 if (fc_fcp_lock_pkt(fsp))
1657 fsp->lp->tt.exch_done(fsp->recov_seq);
1658 fsp->recov_seq = NULL;
1659 switch (PTR_ERR(fp)) {
1660 case -FC_EX_TIMEOUT:
1661 if (fsp->recov_retry++ < FC_MAX_RECOV_RETRY)
1664 fc_timeout_error(fsp);
1666 case -FC_EX_CLOSED: /* e.g., link failure */
1669 fc_fcp_retry_cmd(fsp);
1672 fc_fcp_unlock_pkt(fsp);
1674 fc_fcp_pkt_release(fsp); /* drop hold for outstanding SRR */
1678 * fc_fcp_lport_queue_ready() - Determine if the lport and it's queue is ready
1679 * @lport: The local port to be checked
1681 static inline int fc_fcp_lport_queue_ready(struct fc_lport *lport)
1684 return (lport->state == LPORT_ST_READY) &&
1685 lport->link_up && !lport->qfull;
1689 * fc_queuecommand() - The queuecommand function of the SCSI template
1690 * @cmd: The scsi_cmnd to be executed
1691 * @done: The callback function to be called when the scsi_cmnd is complete
1693 * This is the i/o strategy routine, called by the SCSI layer. This routine
1694 * is called with the host_lock held.
1696 int fc_queuecommand(struct scsi_cmnd *sc_cmd, void (*done)(struct scsi_cmnd *))
1698 struct fc_lport *lport;
1699 struct fc_rport *rport = starget_to_rport(scsi_target(sc_cmd->device));
1700 struct fc_fcp_pkt *fsp;
1701 struct fc_rport_libfc_priv *rpriv;
1704 struct fcoe_dev_stats *stats;
1706 lport = shost_priv(sc_cmd->device->host);
1708 rval = fc_remote_port_chkready(rport);
1710 sc_cmd->result = rval;
1715 if (!*(struct fc_remote_port **)rport->dd_data) {
1717 * rport is transitioning from blocked/deleted to
1720 sc_cmd->result = DID_IMM_RETRY << 16;
1725 rpriv = rport->dd_data;
1727 if (!fc_fcp_lport_queue_ready(lport)) {
1728 rc = SCSI_MLQUEUE_HOST_BUSY;
1732 fsp = fc_fcp_pkt_alloc(lport, GFP_ATOMIC);
1734 rc = SCSI_MLQUEUE_HOST_BUSY;
1739 * build the libfc request pkt
1741 fsp->cmd = sc_cmd; /* save the cmd */
1742 fsp->lp = lport; /* save the softc ptr */
1743 fsp->rport = rport; /* set the remote port ptr */
1744 fsp->xfer_ddp = FC_XID_UNKNOWN;
1745 sc_cmd->scsi_done = done;
1748 * set up the transfer length
1750 fsp->data_len = scsi_bufflen(sc_cmd);
1754 * setup the data direction
1756 stats = fc_lport_get_stats(lport);
1757 if (sc_cmd->sc_data_direction == DMA_FROM_DEVICE) {
1758 fsp->req_flags = FC_SRB_READ;
1759 stats->InputRequests++;
1760 stats->InputMegabytes = fsp->data_len;
1761 } else if (sc_cmd->sc_data_direction == DMA_TO_DEVICE) {
1762 fsp->req_flags = FC_SRB_WRITE;
1763 stats->OutputRequests++;
1764 stats->OutputMegabytes = fsp->data_len;
1767 stats->ControlRequests++;
1770 fsp->tgt_flags = rpriv->flags;
1772 init_timer(&fsp->timer);
1773 fsp->timer.data = (unsigned long)fsp;
1776 * send it to the lower layer
1777 * if we get -1 return then put the request in the pending
1780 rval = fc_fcp_pkt_send(lport, fsp);
1782 fsp->state = FC_SRB_FREE;
1783 fc_fcp_pkt_release(fsp);
1784 rc = SCSI_MLQUEUE_HOST_BUSY;
1789 EXPORT_SYMBOL(fc_queuecommand);
1792 * fc_io_compl() - Handle responses for completed commands
1793 * @fsp: The FCP packet that is complete
1795 * Translates fcp_pkt errors to a Linux SCSI errors.
1796 * The fcp packet lock must be held when calling.
1798 static void fc_io_compl(struct fc_fcp_pkt *fsp)
1800 struct fc_fcp_internal *si;
1801 struct scsi_cmnd *sc_cmd;
1802 struct fc_lport *lport;
1803 unsigned long flags;
1805 /* release outstanding ddp context */
1806 fc_fcp_ddp_done(fsp);
1808 fsp->state |= FC_SRB_COMPL;
1809 if (!(fsp->state & FC_SRB_FCP_PROCESSING_TMO)) {
1810 spin_unlock_bh(&fsp->scsi_pkt_lock);
1811 del_timer_sync(&fsp->timer);
1812 spin_lock_bh(&fsp->scsi_pkt_lock);
1816 si = fc_get_scsi_internal(lport);
1817 spin_lock_irqsave(lport->host->host_lock, flags);
1819 spin_unlock_irqrestore(lport->host->host_lock, flags);
1824 * if a command timed out while we had to try and throttle IO
1825 * and it is now getting cleaned up, then we are about to
1826 * try again so clear the throttled flag incase we get more
1829 if (si->throttled && fsp->state & FC_SRB_NOMEM)
1835 if (!sc_cmd->SCp.ptr) {
1836 spin_unlock_irqrestore(lport->host->host_lock, flags);
1840 CMD_SCSI_STATUS(sc_cmd) = fsp->cdb_status;
1841 switch (fsp->status_code) {
1843 if (fsp->cdb_status == 0) {
1847 sc_cmd->result = DID_OK << 16;
1848 if (fsp->scsi_resid)
1849 CMD_RESID_LEN(sc_cmd) = fsp->scsi_resid;
1852 * transport level I/O was ok but scsi
1853 * has non zero status
1855 sc_cmd->result = (DID_OK << 16) | fsp->cdb_status;
1859 sc_cmd->result = DID_ERROR << 16;
1861 case FC_DATA_UNDRUN:
1862 if ((fsp->cdb_status == 0) && !(fsp->req_flags & FC_SRB_READ)) {
1864 * scsi status is good but transport level
1867 sc_cmd->result = (fsp->state & FC_SRB_RCV_STATUS ?
1868 DID_OK : DID_ERROR) << 16;
1871 * scsi got underrun, this is an error
1873 CMD_RESID_LEN(sc_cmd) = fsp->scsi_resid;
1874 sc_cmd->result = (DID_ERROR << 16) | fsp->cdb_status;
1877 case FC_DATA_OVRRUN:
1879 * overrun is an error
1881 sc_cmd->result = (DID_ERROR << 16) | fsp->cdb_status;
1883 case FC_CMD_ABORTED:
1884 sc_cmd->result = (DID_ERROR << 16) | fsp->io_status;
1886 case FC_CMD_TIME_OUT:
1887 sc_cmd->result = (DID_BUS_BUSY << 16) | fsp->io_status;
1890 sc_cmd->result = (DID_RESET << 16);
1893 sc_cmd->result = (DID_NO_CONNECT << 16);
1896 sc_cmd->result = (DID_ERROR << 16);
1900 list_del(&fsp->list);
1901 sc_cmd->SCp.ptr = NULL;
1902 sc_cmd->scsi_done(sc_cmd);
1903 spin_unlock_irqrestore(lport->host->host_lock, flags);
1905 /* release ref from initial allocation in queue command */
1906 fc_fcp_pkt_release(fsp);
1910 * fc_eh_abort() - Abort a command
1911 * @sc_cmd: The SCSI command to abort
1913 * From SCSI host template.
1914 * Send an ABTS to the target device and wait for the response.
1916 int fc_eh_abort(struct scsi_cmnd *sc_cmd)
1918 struct fc_fcp_pkt *fsp;
1919 struct fc_lport *lport;
1921 unsigned long flags;
1923 lport = shost_priv(sc_cmd->device->host);
1924 if (lport->state != LPORT_ST_READY)
1926 else if (!lport->link_up)
1929 spin_lock_irqsave(lport->host->host_lock, flags);
1930 fsp = CMD_SP(sc_cmd);
1932 /* command completed while scsi eh was setting up */
1933 spin_unlock_irqrestore(lport->host->host_lock, flags);
1936 /* grab a ref so the fsp and sc_cmd cannot be relased from under us */
1937 fc_fcp_pkt_hold(fsp);
1938 spin_unlock_irqrestore(lport->host->host_lock, flags);
1940 if (fc_fcp_lock_pkt(fsp)) {
1941 /* completed while we were waiting for timer to be deleted */
1946 rc = fc_fcp_pkt_abort(fsp);
1947 fc_fcp_unlock_pkt(fsp);
1950 fc_fcp_pkt_release(fsp);
1953 EXPORT_SYMBOL(fc_eh_abort);
1956 * fc_eh_device_reset() - Reset a single LUN
1957 * @sc_cmd: The SCSI command which identifies the device whose
1958 * LUN is to be reset
1960 * Set from SCSI host template.
1962 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd)
1964 struct fc_lport *lport;
1965 struct fc_fcp_pkt *fsp;
1966 struct fc_rport *rport = starget_to_rport(scsi_target(sc_cmd->device));
1970 rval = fc_remote_port_chkready(rport);
1974 lport = shost_priv(sc_cmd->device->host);
1976 if (lport->state != LPORT_ST_READY)
1979 FC_SCSI_DBG(lport, "Resetting rport (%6x)\n", rport->port_id);
1981 fsp = fc_fcp_pkt_alloc(lport, GFP_NOIO);
1983 printk(KERN_WARNING "libfc: could not allocate scsi_pkt\n");
1984 sc_cmd->result = DID_NO_CONNECT << 16;
1989 * Build the libfc request pkt. Do not set the scsi cmnd, because
1990 * the sc passed in is not setup for execution like when sent
1991 * through the queuecommand callout.
1993 fsp->lp = lport; /* save the softc ptr */
1994 fsp->rport = rport; /* set the remote port ptr */
1997 * flush outstanding commands
1999 rc = fc_lun_reset(lport, fsp, scmd_id(sc_cmd), sc_cmd->device->lun);
2000 fsp->state = FC_SRB_FREE;
2001 fc_fcp_pkt_release(fsp);
2006 EXPORT_SYMBOL(fc_eh_device_reset);
2009 * fc_eh_host_reset() - Reset a Scsi_Host.
2010 * @sc_cmd: The SCSI command that identifies the SCSI host to be reset
2012 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd)
2014 struct Scsi_Host *shost = sc_cmd->device->host;
2015 struct fc_lport *lport = shost_priv(shost);
2016 unsigned long wait_tmo;
2018 FC_SCSI_DBG(lport, "Resetting host\n");
2020 lport->tt.lport_reset(lport);
2021 wait_tmo = jiffies + FC_HOST_RESET_TIMEOUT;
2022 while (!fc_fcp_lport_queue_ready(lport) && time_before(jiffies,
2026 if (fc_fcp_lport_queue_ready(lport)) {
2027 shost_printk(KERN_INFO, shost, "libfc: Host reset succeeded "
2028 "on port (%6x)\n", fc_host_port_id(lport->host));
2031 shost_printk(KERN_INFO, shost, "libfc: Host reset failed, "
2032 "port (%6x) is not ready.\n",
2033 fc_host_port_id(lport->host));
2037 EXPORT_SYMBOL(fc_eh_host_reset);
2040 * fc_slave_alloc() - Configure the queue depth of a Scsi_Host
2041 * @sdev: The SCSI device that identifies the SCSI host
2043 * Configures queue depth based on host's cmd_per_len. If not set
2044 * then we use the libfc default.
2046 int fc_slave_alloc(struct scsi_device *sdev)
2048 struct fc_rport *rport = starget_to_rport(scsi_target(sdev));
2050 if (!rport || fc_remote_port_chkready(rport))
2053 if (sdev->tagged_supported)
2054 scsi_activate_tcq(sdev, FC_FCP_DFLT_QUEUE_DEPTH);
2056 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev),
2057 FC_FCP_DFLT_QUEUE_DEPTH);
2061 EXPORT_SYMBOL(fc_slave_alloc);
2064 * fc_change_queue_depth() - Change a device's queue depth
2065 * @sdev: The SCSI device whose queue depth is to change
2066 * @qdepth: The new queue depth
2067 * @reason: The resason for the change
2069 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth, int reason)
2072 case SCSI_QDEPTH_DEFAULT:
2073 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), qdepth);
2075 case SCSI_QDEPTH_QFULL:
2076 scsi_track_queue_full(sdev, qdepth);
2078 case SCSI_QDEPTH_RAMP_UP:
2079 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), qdepth);
2084 return sdev->queue_depth;
2086 EXPORT_SYMBOL(fc_change_queue_depth);
2089 * fc_change_queue_type() - Change a device's queue type
2090 * @sdev: The SCSI device whose queue depth is to change
2091 * @tag_type: Identifier for queue type
2093 int fc_change_queue_type(struct scsi_device *sdev, int tag_type)
2095 if (sdev->tagged_supported) {
2096 scsi_set_tag_type(sdev, tag_type);
2098 scsi_activate_tcq(sdev, sdev->queue_depth);
2100 scsi_deactivate_tcq(sdev, sdev->queue_depth);
2106 EXPORT_SYMBOL(fc_change_queue_type);
2109 * fc_fcp_destory() - Tear down the FCP layer for a given local port
2110 * @lport: The local port that no longer needs the FCP layer
2112 void fc_fcp_destroy(struct fc_lport *lport)
2114 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
2116 if (!list_empty(&si->scsi_pkt_queue))
2117 printk(KERN_ERR "libfc: Leaked SCSI packets when destroying "
2118 "port (%6x)\n", fc_host_port_id(lport->host));
2120 mempool_destroy(si->scsi_pkt_pool);
2122 lport->scsi_priv = NULL;
2124 EXPORT_SYMBOL(fc_fcp_destroy);
2130 scsi_pkt_cachep = kmem_cache_create("libfc_fcp_pkt",
2131 sizeof(struct fc_fcp_pkt),
2132 0, SLAB_HWCACHE_ALIGN, NULL);
2133 if (!scsi_pkt_cachep) {
2134 printk(KERN_ERR "libfc: Unable to allocate SRB cache, "
2135 "module load failed!");
2142 void fc_destroy_fcp()
2144 if (scsi_pkt_cachep)
2145 kmem_cache_destroy(scsi_pkt_cachep);
2149 * fc_fcp_init() - Initialize the FCP layer for a local port
2150 * @lport: The local port to initialize the exchange layer for
2152 int fc_fcp_init(struct fc_lport *lport)
2155 struct fc_fcp_internal *si;
2157 if (!lport->tt.fcp_cmd_send)
2158 lport->tt.fcp_cmd_send = fc_fcp_cmd_send;
2160 if (!lport->tt.fcp_cleanup)
2161 lport->tt.fcp_cleanup = fc_fcp_cleanup;
2163 if (!lport->tt.fcp_abort_io)
2164 lport->tt.fcp_abort_io = fc_fcp_abort_io;
2166 si = kzalloc(sizeof(struct fc_fcp_internal), GFP_KERNEL);
2169 lport->scsi_priv = si;
2170 INIT_LIST_HEAD(&si->scsi_pkt_queue);
2172 si->scsi_pkt_pool = mempool_create_slab_pool(2, scsi_pkt_cachep);
2173 if (!si->scsi_pkt_pool) {
2183 EXPORT_SYMBOL(fc_fcp_init);