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.
508 fp = fc_frame_alloc(lport, using_sg ? 0 : tlen);
512 data = fc_frame_header_get(fp) + 1;
513 fh_parm_offset = frame_offset;
514 fr_max_payload(fp) = fsp->max_payload;
516 sg_bytes = min(tlen, sg->length - offset);
518 get_page(sg_page(sg));
519 skb_fill_page_desc(fp_skb(fp),
520 skb_shinfo(fp_skb(fp))->nr_frags,
521 sg_page(sg), sg->offset + offset,
523 fp_skb(fp)->data_len += sg_bytes;
524 fr_len(fp) += sg_bytes;
525 fp_skb(fp)->truesize += PAGE_SIZE;
527 size_t off = offset + sg->offset;
530 * The scatterlist item may be bigger than PAGE_SIZE,
531 * but we must not cross pages inside the kmap.
533 sg_bytes = min(sg_bytes, (size_t) (PAGE_SIZE -
534 (off & ~PAGE_MASK)));
535 page_addr = kmap_atomic(sg_page(sg) +
538 memcpy(data, (char *)page_addr + (off & ~PAGE_MASK),
540 kunmap_atomic(page_addr, KM_SOFTIRQ0);
544 frame_offset += sg_bytes;
546 remaining -= sg_bytes;
548 if ((skb_shinfo(fp_skb(fp))->nr_frags < FC_FRAME_SG_LEN) &&
553 * Send sequence with transfer sequence initiative in case
554 * this is last FCP frame of the sequence.
557 f_ctl |= FC_FC_SEQ_INIT | FC_FC_END_SEQ;
559 ep = fc_seq_exch(seq);
560 fc_fill_fc_hdr(fp, FC_RCTL_DD_SOL_DATA, ep->did, ep->sid,
561 FC_TYPE_FCP, f_ctl, fh_parm_offset);
564 * send fragment using for a sequence.
566 error = lport->tt.seq_send(lport, seq, fp);
568 WARN_ON(1); /* send error should be rare */
569 fc_fcp_retry_cmd(fsp);
574 fsp->xfer_len += seq_blen; /* premature count? */
579 * fc_fcp_abts_resp() - Send an ABTS response
580 * @fsp: The FCP packet that is being aborted
581 * @fp: The response frame
583 static void fc_fcp_abts_resp(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
586 struct fc_ba_rjt *brp;
587 struct fc_frame_header *fh;
589 fh = fc_frame_header_get(fp);
590 switch (fh->fh_r_ctl) {
594 brp = fc_frame_payload_get(fp, sizeof(*brp));
595 if (brp && brp->br_reason == FC_BA_RJT_LOG_ERR)
600 * we will let the command timeout
601 * and scsi-ml recover in this case,
602 * therefore cleared the ba_done flag.
608 fsp->state |= FC_SRB_ABORTED;
609 fsp->state &= ~FC_SRB_ABORT_PENDING;
611 if (fsp->wait_for_comp)
612 complete(&fsp->tm_done);
614 fc_fcp_complete_locked(fsp);
619 * fc_fcp_reduce_can_queue() - Reduce the can_queue value for a local port
620 * @lport: The local port to reduce can_queue on
622 * If we are getting memory allocation failures, then we may
623 * be trying to execute too many commands. We let the running
624 * commands complete or timeout, then try again with a reduced
625 * can_queue. Eventually we will hit the point where we run
626 * on all reserved structs.
628 static void fc_fcp_reduce_can_queue(struct fc_lport *lport)
630 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
634 spin_lock_irqsave(lport->host->host_lock, flags);
639 can_queue = lport->host->can_queue;
643 lport->host->can_queue = can_queue;
644 shost_printk(KERN_ERR, lport->host, "libfc: Could not allocate frame.\n"
645 "Reducing can_queue to %d.\n", can_queue);
647 spin_unlock_irqrestore(lport->host->host_lock, flags);
651 * fc_fcp_recv() - Reveive an FCP frame
652 * @seq: The sequence the frame is on
653 * @fp: The received frame
654 * @arg: The related FCP packet
656 * Context: Called from Soft IRQ context. Can not be called
657 * holding the FCP packet list lock.
659 static void fc_fcp_recv(struct fc_seq *seq, struct fc_frame *fp, void *arg)
661 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)arg;
662 struct fc_lport *lport = fsp->lp;
663 struct fc_frame_header *fh;
664 struct fcp_txrdy *dd;
671 fh = fc_frame_header_get(fp);
672 r_ctl = fh->fh_r_ctl;
674 if (!(lport->state & LPORT_ST_READY))
676 if (fc_fcp_lock_pkt(fsp))
678 fsp->last_pkt_time = jiffies;
680 if (fh->fh_type == FC_TYPE_BLS) {
681 fc_fcp_abts_resp(fsp, fp);
685 if (fsp->state & (FC_SRB_ABORTED | FC_SRB_ABORT_PENDING))
688 if (r_ctl == FC_RCTL_DD_DATA_DESC) {
690 * received XFER RDY from the target
691 * need to send data to the target
693 WARN_ON(fr_flags(fp) & FCPHF_CRC_UNCHECKED);
694 dd = fc_frame_payload_get(fp, sizeof(*dd));
697 rc = fc_fcp_send_data(fsp, seq,
698 (size_t) ntohl(dd->ft_data_ro),
699 (size_t) ntohl(dd->ft_burst_len));
701 seq->rec_data = fsp->xfer_len;
702 else if (rc == -ENOMEM)
703 fsp->state |= FC_SRB_NOMEM;
704 } else if (r_ctl == FC_RCTL_DD_SOL_DATA) {
706 * received a DATA frame
707 * next we will copy the data to the system buffer
709 WARN_ON(fr_len(fp) < sizeof(*fh)); /* len may be 0 */
710 fc_fcp_recv_data(fsp, fp);
711 seq->rec_data = fsp->xfer_contig_end;
712 } else if (r_ctl == FC_RCTL_DD_CMD_STATUS) {
713 WARN_ON(fr_flags(fp) & FCPHF_CRC_UNCHECKED);
715 fc_fcp_resp(fsp, fp);
717 FC_FCP_DBG(fsp, "unexpected frame. r_ctl %x\n", r_ctl);
720 fc_fcp_unlock_pkt(fsp);
725 fc_fcp_error(fsp, fp);
726 else if (rc == -ENOMEM)
727 fc_fcp_reduce_can_queue(lport);
731 * fc_fcp_resp() - Handler for FCP responses
732 * @fsp: The FCP packet the response is for
733 * @fp: The response frame
735 static void fc_fcp_resp(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
737 struct fc_frame_header *fh;
738 struct fcp_resp *fc_rp;
739 struct fcp_resp_ext *rp_ex;
740 struct fcp_resp_rsp_info *fc_rp_info;
748 fh = (struct fc_frame_header *)fr_hdr(fp);
749 if (unlikely(plen < sizeof(*fh) + sizeof(*fc_rp)))
752 fc_rp = (struct fcp_resp *)(fh + 1);
753 fsp->cdb_status = fc_rp->fr_status;
754 flags = fc_rp->fr_flags;
755 fsp->scsi_comp_flags = flags;
756 expected_len = fsp->data_len;
758 /* if ddp, update xfer len */
759 fc_fcp_ddp_done(fsp);
761 if (unlikely((flags & ~FCP_CONF_REQ) || fc_rp->fr_status)) {
762 rp_ex = (void *)(fc_rp + 1);
763 if (flags & (FCP_RSP_LEN_VAL | FCP_SNS_LEN_VAL)) {
764 if (plen < sizeof(*fc_rp) + sizeof(*rp_ex))
766 fc_rp_info = (struct fcp_resp_rsp_info *)(rp_ex + 1);
767 if (flags & FCP_RSP_LEN_VAL) {
768 respl = ntohl(rp_ex->fr_rsp_len);
769 if (respl != sizeof(*fc_rp_info))
771 if (fsp->wait_for_comp) {
772 /* Abuse cdb_status for rsp code */
773 fsp->cdb_status = fc_rp_info->rsp_code;
774 complete(&fsp->tm_done);
776 * tmfs will not have any scsi cmd so
783 if (flags & FCP_SNS_LEN_VAL) {
784 snsl = ntohl(rp_ex->fr_sns_len);
785 if (snsl > SCSI_SENSE_BUFFERSIZE)
786 snsl = SCSI_SENSE_BUFFERSIZE;
787 memcpy(fsp->cmd->sense_buffer,
788 (char *)fc_rp_info + respl, snsl);
791 if (flags & (FCP_RESID_UNDER | FCP_RESID_OVER)) {
792 if (plen < sizeof(*fc_rp) + sizeof(rp_ex->fr_resid))
794 if (flags & FCP_RESID_UNDER) {
795 fsp->scsi_resid = ntohl(rp_ex->fr_resid);
797 * The cmnd->underflow is the minimum number of
798 * bytes that must be transfered for this
799 * command. Provided a sense condition is not
800 * present, make sure the actual amount
801 * transferred is at least the underflow value
804 if (!(flags & FCP_SNS_LEN_VAL) &&
805 (fc_rp->fr_status == 0) &&
806 (scsi_bufflen(fsp->cmd) -
807 fsp->scsi_resid) < fsp->cmd->underflow)
809 expected_len -= fsp->scsi_resid;
811 fsp->status_code = FC_ERROR;
815 fsp->state |= FC_SRB_RCV_STATUS;
818 * Check for missing or extra data frames.
820 if (unlikely(fsp->xfer_len != expected_len)) {
821 if (fsp->xfer_len < expected_len) {
823 * Some data may be queued locally,
824 * Wait a at least one jiffy to see if it is delivered.
825 * If this expires without data, we may do SRR.
827 fc_fcp_timer_set(fsp, 2);
830 fsp->status_code = FC_DATA_OVRRUN;
831 FC_FCP_DBG(fsp, "tgt %6x xfer len %zx greater than expected, "
832 "len %x, data len %x\n",
834 fsp->xfer_len, expected_len, fsp->data_len);
836 fc_fcp_complete_locked(fsp);
840 FC_FCP_DBG(fsp, "short FCP response. flags 0x%x len %u respl %u "
841 "snsl %u\n", flags, fr_len(fp), respl, snsl);
843 fsp->status_code = FC_ERROR;
844 fc_fcp_complete_locked(fsp);
848 * fc_fcp_complete_locked() - Complete processing of a fcp_pkt with the
850 * @fsp: The FCP packet to be completed
852 * This function may sleep if a timer is pending. The packet lock must be
853 * held, and the host lock must not be held.
855 static void fc_fcp_complete_locked(struct fc_fcp_pkt *fsp)
857 struct fc_lport *lport = fsp->lp;
862 if (fsp->state & FC_SRB_ABORT_PENDING)
865 if (fsp->state & FC_SRB_ABORTED) {
866 if (!fsp->status_code)
867 fsp->status_code = FC_CMD_ABORTED;
870 * Test for transport underrun, independent of response
873 if (fsp->xfer_len < fsp->data_len && !fsp->io_status &&
874 (!(fsp->scsi_comp_flags & FCP_RESID_UNDER) ||
875 fsp->xfer_len < fsp->data_len - fsp->scsi_resid)) {
876 fsp->status_code = FC_DATA_UNDRUN;
884 if (unlikely(fsp->scsi_comp_flags & FCP_CONF_REQ)) {
885 struct fc_frame *conf_frame;
888 csp = lport->tt.seq_start_next(seq);
889 conf_frame = fc_frame_alloc(fsp->lp, 0);
891 f_ctl = FC_FC_SEQ_INIT;
892 f_ctl |= FC_FC_LAST_SEQ | FC_FC_END_SEQ;
893 ep = fc_seq_exch(seq);
894 fc_fill_fc_hdr(conf_frame, FC_RCTL_DD_SOL_CTL,
896 FC_TYPE_FCP, f_ctl, 0);
897 lport->tt.seq_send(lport, csp, conf_frame);
900 lport->tt.exch_done(seq);
906 * fc_fcp_cleanup_cmd() - Cancel the active exchange on a fcp_pkt
907 * @fsp: The FCP packet whose exchanges should be canceled
908 * @error: The reason for the cancellation
910 static void fc_fcp_cleanup_cmd(struct fc_fcp_pkt *fsp, int error)
912 struct fc_lport *lport = fsp->lp;
915 lport->tt.exch_done(fsp->seq_ptr);
918 fsp->status_code = error;
922 * fc_fcp_cleanup_each_cmd() - Cancel all exchanges on a local port
923 * @lport: The local port whose exchanges should be canceled
924 * @id: The target's ID
926 * @error: The reason for cancellation
928 * If lun or id is -1, they are ignored.
930 static void fc_fcp_cleanup_each_cmd(struct fc_lport *lport, unsigned int id,
931 unsigned int lun, int error)
933 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
934 struct fc_fcp_pkt *fsp;
935 struct scsi_cmnd *sc_cmd;
938 spin_lock_irqsave(lport->host->host_lock, flags);
940 list_for_each_entry(fsp, &si->scsi_pkt_queue, list) {
942 if (id != -1 && scmd_id(sc_cmd) != id)
945 if (lun != -1 && sc_cmd->device->lun != lun)
948 fc_fcp_pkt_hold(fsp);
949 spin_unlock_irqrestore(lport->host->host_lock, flags);
951 if (!fc_fcp_lock_pkt(fsp)) {
952 fc_fcp_cleanup_cmd(fsp, error);
954 fc_fcp_unlock_pkt(fsp);
957 fc_fcp_pkt_release(fsp);
958 spin_lock_irqsave(lport->host->host_lock, flags);
960 * while we dropped the lock multiple pkts could
961 * have been released, so we have to start over.
965 spin_unlock_irqrestore(lport->host->host_lock, flags);
969 * fc_fcp_abort_io() - Abort all FCP-SCSI exchanges on a local port
970 * @lport: The local port whose exchanges are to be aborted
972 static void fc_fcp_abort_io(struct fc_lport *lport)
974 fc_fcp_cleanup_each_cmd(lport, -1, -1, FC_HRD_ERROR);
978 * fc_fcp_pkt_send() - Send a fcp_pkt
979 * @lport: The local port to send the FCP packet on
980 * @fsp: The FCP packet to send
982 * Return: Zero for success and -1 for failure
983 * Locks: Called with the host lock and irqs disabled.
985 static int fc_fcp_pkt_send(struct fc_lport *lport, struct fc_fcp_pkt *fsp)
987 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
990 fsp->cmd->SCp.ptr = (char *)fsp;
991 fsp->cdb_cmd.fc_dl = htonl(fsp->data_len);
992 fsp->cdb_cmd.fc_flags = fsp->req_flags & ~FCP_CFL_LEN_MASK;
994 int_to_scsilun(fsp->cmd->device->lun,
995 (struct scsi_lun *)fsp->cdb_cmd.fc_lun);
996 memcpy(fsp->cdb_cmd.fc_cdb, fsp->cmd->cmnd, fsp->cmd->cmd_len);
997 list_add_tail(&fsp->list, &si->scsi_pkt_queue);
999 spin_unlock_irq(lport->host->host_lock);
1000 rc = lport->tt.fcp_cmd_send(lport, fsp, fc_fcp_recv);
1001 spin_lock_irq(lport->host->host_lock);
1003 list_del(&fsp->list);
1009 * fc_fcp_cmd_send() - Send a FCP command
1010 * @lport: The local port to send the command on
1011 * @fsp: The FCP packet the command is on
1012 * @resp: The handler for the response
1014 static int fc_fcp_cmd_send(struct fc_lport *lport, struct fc_fcp_pkt *fsp,
1015 void (*resp)(struct fc_seq *,
1016 struct fc_frame *fp,
1019 struct fc_frame *fp;
1021 struct fc_rport *rport;
1022 struct fc_rport_libfc_priv *rpriv;
1023 const size_t len = sizeof(fsp->cdb_cmd);
1026 if (fc_fcp_lock_pkt(fsp))
1029 fp = fc_frame_alloc(lport, sizeof(fsp->cdb_cmd));
1035 memcpy(fc_frame_payload_get(fp, len), &fsp->cdb_cmd, len);
1038 fsp->max_payload = rport->maxframe_size;
1039 rpriv = rport->dd_data;
1041 fc_fill_fc_hdr(fp, FC_RCTL_DD_UNSOL_CMD, rport->port_id,
1042 fc_host_port_id(rpriv->local_port->host), FC_TYPE_FCP,
1043 FC_FC_FIRST_SEQ | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
1045 seq = lport->tt.exch_seq_send(lport, fp, resp, fc_fcp_pkt_destroy,
1051 fsp->last_pkt_time = jiffies;
1053 fc_fcp_pkt_hold(fsp); /* hold for fc_fcp_pkt_destroy */
1055 setup_timer(&fsp->timer, fc_fcp_timeout, (unsigned long)fsp);
1056 fc_fcp_timer_set(fsp,
1057 (fsp->tgt_flags & FC_RP_FLAGS_REC_SUPPORTED) ?
1058 FC_SCSI_REC_TOV : FC_SCSI_ER_TIMEOUT);
1060 fc_fcp_unlock_pkt(fsp);
1065 * fc_fcp_error() - Handler for FCP layer errors
1066 * @fsp: The FCP packet the error is on
1067 * @fp: The frame that has errored
1069 static void fc_fcp_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
1071 int error = PTR_ERR(fp);
1073 if (fc_fcp_lock_pkt(fsp))
1076 if (error == -FC_EX_CLOSED) {
1077 fc_fcp_retry_cmd(fsp);
1082 * clear abort pending, because the lower layer
1083 * decided to force completion.
1085 fsp->state &= ~FC_SRB_ABORT_PENDING;
1086 fsp->status_code = FC_CMD_PLOGO;
1087 fc_fcp_complete_locked(fsp);
1089 fc_fcp_unlock_pkt(fsp);
1093 * fc_fcp_pkt_abort() - Abort a fcp_pkt
1094 * @fsp: The FCP packet to abort on
1096 * Called to send an abort and then wait for abort completion
1098 static int fc_fcp_pkt_abort(struct fc_fcp_pkt *fsp)
1102 if (fc_fcp_send_abort(fsp))
1105 init_completion(&fsp->tm_done);
1106 fsp->wait_for_comp = 1;
1108 spin_unlock_bh(&fsp->scsi_pkt_lock);
1109 rc = wait_for_completion_timeout(&fsp->tm_done, FC_SCSI_TM_TOV);
1110 spin_lock_bh(&fsp->scsi_pkt_lock);
1111 fsp->wait_for_comp = 0;
1114 FC_FCP_DBG(fsp, "target abort cmd failed\n");
1116 } else if (fsp->state & FC_SRB_ABORTED) {
1117 FC_FCP_DBG(fsp, "target abort cmd passed\n");
1119 fc_fcp_complete_locked(fsp);
1126 * fc_lun_reset_send() - Send LUN reset command
1127 * @data: The FCP packet that identifies the LUN to be reset
1129 static void fc_lun_reset_send(unsigned long data)
1131 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)data;
1132 struct fc_lport *lport = fsp->lp;
1133 if (lport->tt.fcp_cmd_send(lport, fsp, fc_tm_done)) {
1134 if (fsp->recov_retry++ >= FC_MAX_RECOV_RETRY)
1136 if (fc_fcp_lock_pkt(fsp))
1138 setup_timer(&fsp->timer, fc_lun_reset_send, (unsigned long)fsp);
1139 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1140 fc_fcp_unlock_pkt(fsp);
1145 * fc_lun_reset() - Send a LUN RESET command to a device
1146 * and wait for the reply
1147 * @lport: The local port to sent the comand on
1148 * @fsp: The FCP packet that identifies the LUN to be reset
1149 * @id: The SCSI command ID
1150 * @lun: The LUN ID to be reset
1152 static int fc_lun_reset(struct fc_lport *lport, struct fc_fcp_pkt *fsp,
1153 unsigned int id, unsigned int lun)
1157 fsp->cdb_cmd.fc_dl = htonl(fsp->data_len);
1158 fsp->cdb_cmd.fc_tm_flags = FCP_TMF_LUN_RESET;
1159 int_to_scsilun(lun, (struct scsi_lun *)fsp->cdb_cmd.fc_lun);
1161 fsp->wait_for_comp = 1;
1162 init_completion(&fsp->tm_done);
1164 fc_lun_reset_send((unsigned long)fsp);
1167 * wait for completion of reset
1168 * after that make sure all commands are terminated
1170 rc = wait_for_completion_timeout(&fsp->tm_done, FC_SCSI_TM_TOV);
1172 spin_lock_bh(&fsp->scsi_pkt_lock);
1173 fsp->state |= FC_SRB_COMPL;
1174 spin_unlock_bh(&fsp->scsi_pkt_lock);
1176 del_timer_sync(&fsp->timer);
1178 spin_lock_bh(&fsp->scsi_pkt_lock);
1180 lport->tt.exch_done(fsp->seq_ptr);
1181 fsp->seq_ptr = NULL;
1183 fsp->wait_for_comp = 0;
1184 spin_unlock_bh(&fsp->scsi_pkt_lock);
1187 FC_SCSI_DBG(lport, "lun reset failed\n");
1191 /* cdb_status holds the tmf's rsp code */
1192 if (fsp->cdb_status != FCP_TMF_CMPL)
1195 FC_SCSI_DBG(lport, "lun reset to lun %u completed\n", lun);
1196 fc_fcp_cleanup_each_cmd(lport, id, lun, FC_CMD_ABORTED);
1201 * fc_tm_done() - Task Managment response handler
1202 * @seq: The sequence that the response is on
1203 * @fp: The response frame
1204 * @arg: The FCP packet the response is for
1206 static void fc_tm_done(struct fc_seq *seq, struct fc_frame *fp, void *arg)
1208 struct fc_fcp_pkt *fsp = arg;
1209 struct fc_frame_header *fh;
1213 * If there is an error just let it timeout or wait
1214 * for TMF to be aborted if it timedout.
1216 * scsi-eh will escalate for when either happens.
1221 if (fc_fcp_lock_pkt(fsp))
1225 * raced with eh timeout handler.
1227 if (!fsp->seq_ptr || !fsp->wait_for_comp) {
1228 spin_unlock_bh(&fsp->scsi_pkt_lock);
1232 fh = fc_frame_header_get(fp);
1233 if (fh->fh_type != FC_TYPE_BLS)
1234 fc_fcp_resp(fsp, fp);
1235 fsp->seq_ptr = NULL;
1236 fsp->lp->tt.exch_done(seq);
1238 fc_fcp_unlock_pkt(fsp);
1242 * fc_fcp_cleanup() - Cleanup all FCP exchanges on a local port
1243 * @lport: The local port to be cleaned up
1245 static void fc_fcp_cleanup(struct fc_lport *lport)
1247 fc_fcp_cleanup_each_cmd(lport, -1, -1, FC_ERROR);
1251 * fc_fcp_timeout() - Handler for fcp_pkt timeouts
1252 * @data: The FCP packet that has timed out
1254 * If REC is supported then just issue it and return. The REC exchange will
1255 * complete or time out and recovery can continue at that point. Otherwise,
1256 * if the response has been received without all the data it has been
1257 * ER_TIMEOUT since the response was received. If the response has not been
1258 * received we see if data was received recently. If it has been then we
1259 * continue waiting, otherwise, we abort the command.
1261 static void fc_fcp_timeout(unsigned long data)
1263 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)data;
1264 struct fc_rport *rport = fsp->rport;
1265 struct fc_rport_libfc_priv *rpriv = rport->dd_data;
1267 if (fc_fcp_lock_pkt(fsp))
1270 if (fsp->cdb_cmd.fc_tm_flags)
1273 fsp->state |= FC_SRB_FCP_PROCESSING_TMO;
1275 if (rpriv->flags & FC_RP_FLAGS_REC_SUPPORTED)
1277 else if (time_after_eq(fsp->last_pkt_time + (FC_SCSI_ER_TIMEOUT / 2),
1279 fc_fcp_timer_set(fsp, FC_SCSI_ER_TIMEOUT);
1280 else if (fsp->state & FC_SRB_RCV_STATUS)
1281 fc_fcp_complete_locked(fsp);
1283 fc_timeout_error(fsp);
1284 fsp->state &= ~FC_SRB_FCP_PROCESSING_TMO;
1286 fc_fcp_unlock_pkt(fsp);
1290 * fc_fcp_rec() - Send a REC ELS request
1291 * @fsp: The FCP packet to send the REC request on
1293 static void fc_fcp_rec(struct fc_fcp_pkt *fsp)
1295 struct fc_lport *lport;
1296 struct fc_frame *fp;
1297 struct fc_rport *rport;
1298 struct fc_rport_libfc_priv *rpriv;
1302 rpriv = rport->dd_data;
1303 if (!fsp->seq_ptr || rpriv->rp_state != RPORT_ST_READY) {
1304 fsp->status_code = FC_HRD_ERROR;
1306 fc_fcp_complete_locked(fsp);
1309 fp = fc_frame_alloc(lport, sizeof(struct fc_els_rec));
1313 fr_seq(fp) = fsp->seq_ptr;
1314 fc_fill_fc_hdr(fp, FC_RCTL_ELS_REQ, rport->port_id,
1315 fc_host_port_id(rpriv->local_port->host), FC_TYPE_ELS,
1316 FC_FC_FIRST_SEQ | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
1317 if (lport->tt.elsct_send(lport, rport->port_id, fp, ELS_REC,
1318 fc_fcp_rec_resp, fsp,
1319 jiffies_to_msecs(FC_SCSI_REC_TOV))) {
1320 fc_fcp_pkt_hold(fsp); /* hold while REC outstanding */
1324 if (fsp->recov_retry++ < FC_MAX_RECOV_RETRY)
1325 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1327 fc_timeout_error(fsp);
1331 * fc_fcp_rec_resp() - Handler for REC ELS responses
1332 * @seq: The sequence the response is on
1333 * @fp: The response frame
1334 * @arg: The FCP packet the response is on
1336 * If the response is a reject then the scsi layer will handle
1337 * the timeout. If the response is a LS_ACC then if the I/O was not completed
1338 * set the timeout and return. If the I/O was completed then complete the
1339 * exchange and tell the SCSI layer.
1341 static void fc_fcp_rec_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg)
1343 struct fc_fcp_pkt *fsp = (struct fc_fcp_pkt *)arg;
1344 struct fc_els_rec_acc *recp;
1345 struct fc_els_ls_rjt *rjt;
1349 enum dma_data_direction data_dir;
1351 struct fc_rport_libfc_priv *rpriv;
1354 fc_fcp_rec_error(fsp, fp);
1358 if (fc_fcp_lock_pkt(fsp))
1361 fsp->recov_retry = 0;
1362 opcode = fc_frame_payload_op(fp);
1363 if (opcode == ELS_LS_RJT) {
1364 rjt = fc_frame_payload_get(fp, sizeof(*rjt));
1365 switch (rjt->er_reason) {
1367 FC_FCP_DBG(fsp, "device %x unexpected REC reject "
1368 "reason %d expl %d\n",
1369 fsp->rport->port_id, rjt->er_reason,
1373 FC_FCP_DBG(fsp, "device does not support REC\n");
1374 rpriv = fsp->rport->dd_data;
1376 * if we do not spport RECs or got some bogus
1377 * reason then resetup timer so we check for
1380 rpriv->flags &= ~FC_RP_FLAGS_REC_SUPPORTED;
1381 fc_fcp_timer_set(fsp, FC_SCSI_ER_TIMEOUT);
1386 * If no data transfer, the command frame got dropped
1387 * so we just retry. If data was transferred, we
1388 * lost the response but the target has no record,
1389 * so we abort and retry.
1391 if (rjt->er_explan == ELS_EXPL_OXID_RXID &&
1392 fsp->xfer_len == 0) {
1393 fc_fcp_retry_cmd(fsp);
1396 fc_timeout_error(fsp);
1399 } else if (opcode == ELS_LS_ACC) {
1400 if (fsp->state & FC_SRB_ABORTED)
1403 data_dir = fsp->cmd->sc_data_direction;
1404 recp = fc_frame_payload_get(fp, sizeof(*recp));
1405 offset = ntohl(recp->reca_fc4value);
1406 e_stat = ntohl(recp->reca_e_stat);
1408 if (e_stat & ESB_ST_COMPLETE) {
1411 * The exchange is complete.
1413 * For output, we must've lost the response.
1414 * For input, all data must've been sent.
1415 * We lost may have lost the response
1416 * (and a confirmation was requested) and maybe
1419 * If all data received, send SRR
1420 * asking for response. If partial data received,
1421 * or gaps, SRR requests data at start of gap.
1422 * Recovery via SRR relies on in-order-delivery.
1424 if (data_dir == DMA_TO_DEVICE) {
1425 r_ctl = FC_RCTL_DD_CMD_STATUS;
1426 } else if (fsp->xfer_contig_end == offset) {
1427 r_ctl = FC_RCTL_DD_CMD_STATUS;
1429 offset = fsp->xfer_contig_end;
1430 r_ctl = FC_RCTL_DD_SOL_DATA;
1432 fc_fcp_srr(fsp, r_ctl, offset);
1433 } else if (e_stat & ESB_ST_SEQ_INIT) {
1436 * The remote port has the initiative, so just
1437 * keep waiting for it to complete.
1439 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1443 * The exchange is incomplete, we have seq. initiative.
1444 * Lost response with requested confirmation,
1445 * lost confirmation, lost transfer ready or
1448 * For output, if not all data was received, ask
1449 * for transfer ready to be repeated.
1451 * If we received or sent all the data, send SRR to
1454 * If we lost a response, we may have lost some read
1457 r_ctl = FC_RCTL_DD_SOL_DATA;
1458 if (data_dir == DMA_TO_DEVICE) {
1459 r_ctl = FC_RCTL_DD_CMD_STATUS;
1460 if (offset < fsp->data_len)
1461 r_ctl = FC_RCTL_DD_DATA_DESC;
1462 } else if (offset == fsp->xfer_contig_end) {
1463 r_ctl = FC_RCTL_DD_CMD_STATUS;
1464 } else if (fsp->xfer_contig_end < offset) {
1465 offset = fsp->xfer_contig_end;
1467 fc_fcp_srr(fsp, r_ctl, offset);
1471 fc_fcp_unlock_pkt(fsp);
1473 fc_fcp_pkt_release(fsp); /* drop hold for outstanding REC */
1478 * fc_fcp_rec_error() - Handler for REC errors
1479 * @fsp: The FCP packet the error is on
1480 * @fp: The REC frame
1482 static void fc_fcp_rec_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
1484 int error = PTR_ERR(fp);
1486 if (fc_fcp_lock_pkt(fsp))
1491 fc_fcp_retry_cmd(fsp);
1495 FC_FCP_DBG(fsp, "REC %p fid %x error unexpected error %d\n",
1496 fsp, fsp->rport->port_id, error);
1497 fsp->status_code = FC_CMD_PLOGO;
1500 case -FC_EX_TIMEOUT:
1502 * Assume REC or LS_ACC was lost.
1503 * The exchange manager will have aborted REC, so retry.
1505 FC_FCP_DBG(fsp, "REC fid %x error error %d retry %d/%d\n",
1506 fsp->rport->port_id, error, fsp->recov_retry,
1507 FC_MAX_RECOV_RETRY);
1508 if (fsp->recov_retry++ < FC_MAX_RECOV_RETRY)
1511 fc_timeout_error(fsp);
1514 fc_fcp_unlock_pkt(fsp);
1516 fc_fcp_pkt_release(fsp); /* drop hold for outstanding REC */
1520 * fc_timeout_error() - Handler for fcp_pkt timeouts
1521 * @fsp: The FCP packt that has timed out
1523 static void fc_timeout_error(struct fc_fcp_pkt *fsp)
1525 fsp->status_code = FC_CMD_TIME_OUT;
1526 fsp->cdb_status = 0;
1529 * if this fails then we let the scsi command timer fire and
1532 fc_fcp_send_abort(fsp);
1536 * fc_fcp_srr() - Send a SRR request (Sequence Retransmission Request)
1537 * @fsp: The FCP packet the SRR is to be sent on
1538 * @r_ctl: The R_CTL field for the SRR request
1539 * This is called after receiving status but insufficient data, or
1540 * when expecting status but the request has timed out.
1542 static void fc_fcp_srr(struct fc_fcp_pkt *fsp, enum fc_rctl r_ctl, u32 offset)
1544 struct fc_lport *lport = fsp->lp;
1545 struct fc_rport *rport;
1546 struct fc_rport_libfc_priv *rpriv;
1547 struct fc_exch *ep = fc_seq_exch(fsp->seq_ptr);
1549 struct fcp_srr *srr;
1550 struct fc_frame *fp;
1554 rpriv = rport->dd_data;
1555 cdb_op = fsp->cdb_cmd.fc_cdb[0];
1557 if (!(rpriv->flags & FC_RP_FLAGS_RETRY) ||
1558 rpriv->rp_state != RPORT_ST_READY)
1559 goto retry; /* shouldn't happen */
1560 fp = fc_frame_alloc(lport, sizeof(*srr));
1564 srr = fc_frame_payload_get(fp, sizeof(*srr));
1565 memset(srr, 0, sizeof(*srr));
1566 srr->srr_op = ELS_SRR;
1567 srr->srr_ox_id = htons(ep->oxid);
1568 srr->srr_rx_id = htons(ep->rxid);
1569 srr->srr_r_ctl = r_ctl;
1570 srr->srr_rel_off = htonl(offset);
1572 fc_fill_fc_hdr(fp, FC_RCTL_ELS4_REQ, rport->port_id,
1573 fc_host_port_id(rpriv->local_port->host), FC_TYPE_FCP,
1574 FC_FC_FIRST_SEQ | FC_FC_END_SEQ | FC_FC_SEQ_INIT, 0);
1576 seq = lport->tt.exch_seq_send(lport, fp, fc_fcp_srr_resp, NULL,
1577 fsp, jiffies_to_msecs(FC_SCSI_REC_TOV));
1581 fsp->recov_seq = seq;
1582 fsp->xfer_len = offset;
1583 fsp->xfer_contig_end = offset;
1584 fsp->state &= ~FC_SRB_RCV_STATUS;
1585 fc_fcp_pkt_hold(fsp); /* hold for outstanding SRR */
1588 fc_fcp_retry_cmd(fsp);
1592 * fc_fcp_srr_resp() - Handler for SRR response
1593 * @seq: The sequence the SRR is on
1594 * @fp: The SRR frame
1595 * @arg: The FCP packet the SRR is on
1597 static void fc_fcp_srr_resp(struct fc_seq *seq, struct fc_frame *fp, void *arg)
1599 struct fc_fcp_pkt *fsp = arg;
1600 struct fc_frame_header *fh;
1603 fc_fcp_srr_error(fsp, fp);
1607 if (fc_fcp_lock_pkt(fsp))
1610 fh = fc_frame_header_get(fp);
1612 * BUG? fc_fcp_srr_error calls exch_done which would release
1613 * the ep. But if fc_fcp_srr_error had got -FC_EX_TIMEOUT,
1614 * then fc_exch_timeout would be sending an abort. The exch_done
1615 * call by fc_fcp_srr_error would prevent fc_exch.c from seeing
1616 * an abort response though.
1618 if (fh->fh_type == FC_TYPE_BLS) {
1619 fc_fcp_unlock_pkt(fsp);
1623 fsp->recov_seq = NULL;
1624 switch (fc_frame_payload_op(fp)) {
1626 fsp->recov_retry = 0;
1627 fc_fcp_timer_set(fsp, FC_SCSI_REC_TOV);
1631 fc_timeout_error(fsp);
1634 fc_fcp_unlock_pkt(fsp);
1635 fsp->lp->tt.exch_done(seq);
1638 fc_fcp_pkt_release(fsp); /* drop hold for outstanding SRR */
1642 * fc_fcp_srr_error() - Handler for SRR errors
1643 * @fsp: The FCP packet that the SRR error is on
1644 * @fp: The SRR frame
1646 static void fc_fcp_srr_error(struct fc_fcp_pkt *fsp, struct fc_frame *fp)
1648 if (fc_fcp_lock_pkt(fsp))
1650 fsp->lp->tt.exch_done(fsp->recov_seq);
1651 fsp->recov_seq = NULL;
1652 switch (PTR_ERR(fp)) {
1653 case -FC_EX_TIMEOUT:
1654 if (fsp->recov_retry++ < FC_MAX_RECOV_RETRY)
1657 fc_timeout_error(fsp);
1659 case -FC_EX_CLOSED: /* e.g., link failure */
1662 fc_fcp_retry_cmd(fsp);
1665 fc_fcp_unlock_pkt(fsp);
1667 fc_fcp_pkt_release(fsp); /* drop hold for outstanding SRR */
1671 * fc_fcp_lport_queue_ready() - Determine if the lport and it's queue is ready
1672 * @lport: The local port to be checked
1674 static inline int fc_fcp_lport_queue_ready(struct fc_lport *lport)
1677 return (lport->state == LPORT_ST_READY) &&
1678 lport->link_up && !lport->qfull;
1682 * fc_queuecommand() - The queuecommand function of the SCSI template
1683 * @cmd: The scsi_cmnd to be executed
1684 * @done: The callback function to be called when the scsi_cmnd is complete
1686 * This is the i/o strategy routine, called by the SCSI layer. This routine
1687 * is called with the host_lock held.
1689 int fc_queuecommand(struct scsi_cmnd *sc_cmd, void (*done)(struct scsi_cmnd *))
1691 struct fc_lport *lport;
1692 struct fc_rport *rport = starget_to_rport(scsi_target(sc_cmd->device));
1693 struct fc_fcp_pkt *fsp;
1694 struct fc_rport_libfc_priv *rpriv;
1697 struct fcoe_dev_stats *stats;
1699 lport = shost_priv(sc_cmd->device->host);
1701 rval = fc_remote_port_chkready(rport);
1703 sc_cmd->result = rval;
1708 if (!*(struct fc_remote_port **)rport->dd_data) {
1710 * rport is transitioning from blocked/deleted to
1713 sc_cmd->result = DID_IMM_RETRY << 16;
1718 rpriv = rport->dd_data;
1720 if (!fc_fcp_lport_queue_ready(lport)) {
1721 rc = SCSI_MLQUEUE_HOST_BUSY;
1725 fsp = fc_fcp_pkt_alloc(lport, GFP_ATOMIC);
1727 rc = SCSI_MLQUEUE_HOST_BUSY;
1732 * build the libfc request pkt
1734 fsp->cmd = sc_cmd; /* save the cmd */
1735 fsp->lp = lport; /* save the softc ptr */
1736 fsp->rport = rport; /* set the remote port ptr */
1737 fsp->xfer_ddp = FC_XID_UNKNOWN;
1738 sc_cmd->scsi_done = done;
1741 * set up the transfer length
1743 fsp->data_len = scsi_bufflen(sc_cmd);
1747 * setup the data direction
1749 stats = fc_lport_get_stats(lport);
1750 if (sc_cmd->sc_data_direction == DMA_FROM_DEVICE) {
1751 fsp->req_flags = FC_SRB_READ;
1752 stats->InputRequests++;
1753 stats->InputMegabytes = fsp->data_len;
1754 } else if (sc_cmd->sc_data_direction == DMA_TO_DEVICE) {
1755 fsp->req_flags = FC_SRB_WRITE;
1756 stats->OutputRequests++;
1757 stats->OutputMegabytes = fsp->data_len;
1760 stats->ControlRequests++;
1763 fsp->tgt_flags = rpriv->flags;
1765 init_timer(&fsp->timer);
1766 fsp->timer.data = (unsigned long)fsp;
1769 * send it to the lower layer
1770 * if we get -1 return then put the request in the pending
1773 rval = fc_fcp_pkt_send(lport, fsp);
1775 fsp->state = FC_SRB_FREE;
1776 fc_fcp_pkt_release(fsp);
1777 rc = SCSI_MLQUEUE_HOST_BUSY;
1782 EXPORT_SYMBOL(fc_queuecommand);
1785 * fc_io_compl() - Handle responses for completed commands
1786 * @fsp: The FCP packet that is complete
1788 * Translates fcp_pkt errors to a Linux SCSI errors.
1789 * The fcp packet lock must be held when calling.
1791 static void fc_io_compl(struct fc_fcp_pkt *fsp)
1793 struct fc_fcp_internal *si;
1794 struct scsi_cmnd *sc_cmd;
1795 struct fc_lport *lport;
1796 unsigned long flags;
1798 /* release outstanding ddp context */
1799 fc_fcp_ddp_done(fsp);
1801 fsp->state |= FC_SRB_COMPL;
1802 if (!(fsp->state & FC_SRB_FCP_PROCESSING_TMO)) {
1803 spin_unlock_bh(&fsp->scsi_pkt_lock);
1804 del_timer_sync(&fsp->timer);
1805 spin_lock_bh(&fsp->scsi_pkt_lock);
1809 si = fc_get_scsi_internal(lport);
1810 spin_lock_irqsave(lport->host->host_lock, flags);
1812 spin_unlock_irqrestore(lport->host->host_lock, flags);
1817 * if a command timed out while we had to try and throttle IO
1818 * and it is now getting cleaned up, then we are about to
1819 * try again so clear the throttled flag incase we get more
1822 if (si->throttled && fsp->state & FC_SRB_NOMEM)
1828 if (!sc_cmd->SCp.ptr) {
1829 spin_unlock_irqrestore(lport->host->host_lock, flags);
1833 CMD_SCSI_STATUS(sc_cmd) = fsp->cdb_status;
1834 switch (fsp->status_code) {
1836 if (fsp->cdb_status == 0) {
1840 sc_cmd->result = DID_OK << 16;
1841 if (fsp->scsi_resid)
1842 CMD_RESID_LEN(sc_cmd) = fsp->scsi_resid;
1845 * transport level I/O was ok but scsi
1846 * has non zero status
1848 sc_cmd->result = (DID_OK << 16) | fsp->cdb_status;
1852 sc_cmd->result = DID_ERROR << 16;
1854 case FC_DATA_UNDRUN:
1855 if ((fsp->cdb_status == 0) && !(fsp->req_flags & FC_SRB_READ)) {
1857 * scsi status is good but transport level
1860 sc_cmd->result = (fsp->state & FC_SRB_RCV_STATUS ?
1861 DID_OK : DID_ERROR) << 16;
1864 * scsi got underrun, this is an error
1866 CMD_RESID_LEN(sc_cmd) = fsp->scsi_resid;
1867 sc_cmd->result = (DID_ERROR << 16) | fsp->cdb_status;
1870 case FC_DATA_OVRRUN:
1872 * overrun is an error
1874 sc_cmd->result = (DID_ERROR << 16) | fsp->cdb_status;
1876 case FC_CMD_ABORTED:
1877 sc_cmd->result = (DID_ERROR << 16) | fsp->io_status;
1879 case FC_CMD_TIME_OUT:
1880 sc_cmd->result = (DID_BUS_BUSY << 16) | fsp->io_status;
1883 sc_cmd->result = (DID_RESET << 16);
1886 sc_cmd->result = (DID_NO_CONNECT << 16);
1889 sc_cmd->result = (DID_ERROR << 16);
1893 list_del(&fsp->list);
1894 sc_cmd->SCp.ptr = NULL;
1895 sc_cmd->scsi_done(sc_cmd);
1896 spin_unlock_irqrestore(lport->host->host_lock, flags);
1898 /* release ref from initial allocation in queue command */
1899 fc_fcp_pkt_release(fsp);
1903 * fc_eh_abort() - Abort a command
1904 * @sc_cmd: The SCSI command to abort
1906 * From SCSI host template.
1907 * Send an ABTS to the target device and wait for the response.
1909 int fc_eh_abort(struct scsi_cmnd *sc_cmd)
1911 struct fc_fcp_pkt *fsp;
1912 struct fc_lport *lport;
1914 unsigned long flags;
1916 lport = shost_priv(sc_cmd->device->host);
1917 if (lport->state != LPORT_ST_READY)
1919 else if (!lport->link_up)
1922 spin_lock_irqsave(lport->host->host_lock, flags);
1923 fsp = CMD_SP(sc_cmd);
1925 /* command completed while scsi eh was setting up */
1926 spin_unlock_irqrestore(lport->host->host_lock, flags);
1929 /* grab a ref so the fsp and sc_cmd cannot be relased from under us */
1930 fc_fcp_pkt_hold(fsp);
1931 spin_unlock_irqrestore(lport->host->host_lock, flags);
1933 if (fc_fcp_lock_pkt(fsp)) {
1934 /* completed while we were waiting for timer to be deleted */
1939 rc = fc_fcp_pkt_abort(fsp);
1940 fc_fcp_unlock_pkt(fsp);
1943 fc_fcp_pkt_release(fsp);
1946 EXPORT_SYMBOL(fc_eh_abort);
1949 * fc_eh_device_reset() - Reset a single LUN
1950 * @sc_cmd: The SCSI command which identifies the device whose
1951 * LUN is to be reset
1953 * Set from SCSI host template.
1955 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd)
1957 struct fc_lport *lport;
1958 struct fc_fcp_pkt *fsp;
1959 struct fc_rport *rport = starget_to_rport(scsi_target(sc_cmd->device));
1963 rval = fc_remote_port_chkready(rport);
1967 lport = shost_priv(sc_cmd->device->host);
1969 if (lport->state != LPORT_ST_READY)
1972 FC_SCSI_DBG(lport, "Resetting rport (%6x)\n", rport->port_id);
1974 fsp = fc_fcp_pkt_alloc(lport, GFP_NOIO);
1976 printk(KERN_WARNING "libfc: could not allocate scsi_pkt\n");
1977 sc_cmd->result = DID_NO_CONNECT << 16;
1982 * Build the libfc request pkt. Do not set the scsi cmnd, because
1983 * the sc passed in is not setup for execution like when sent
1984 * through the queuecommand callout.
1986 fsp->lp = lport; /* save the softc ptr */
1987 fsp->rport = rport; /* set the remote port ptr */
1990 * flush outstanding commands
1992 rc = fc_lun_reset(lport, fsp, scmd_id(sc_cmd), sc_cmd->device->lun);
1993 fsp->state = FC_SRB_FREE;
1994 fc_fcp_pkt_release(fsp);
1999 EXPORT_SYMBOL(fc_eh_device_reset);
2002 * fc_eh_host_reset() - Reset a Scsi_Host.
2003 * @sc_cmd: The SCSI command that identifies the SCSI host to be reset
2005 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd)
2007 struct Scsi_Host *shost = sc_cmd->device->host;
2008 struct fc_lport *lport = shost_priv(shost);
2009 unsigned long wait_tmo;
2011 FC_SCSI_DBG(lport, "Resetting host\n");
2013 lport->tt.lport_reset(lport);
2014 wait_tmo = jiffies + FC_HOST_RESET_TIMEOUT;
2015 while (!fc_fcp_lport_queue_ready(lport) && time_before(jiffies,
2019 if (fc_fcp_lport_queue_ready(lport)) {
2020 shost_printk(KERN_INFO, shost, "libfc: Host reset succeeded "
2021 "on port (%6x)\n", fc_host_port_id(lport->host));
2024 shost_printk(KERN_INFO, shost, "libfc: Host reset failed, "
2025 "port (%6x) is not ready.\n",
2026 fc_host_port_id(lport->host));
2030 EXPORT_SYMBOL(fc_eh_host_reset);
2033 * fc_slave_alloc() - Configure the queue depth of a Scsi_Host
2034 * @sdev: The SCSI device that identifies the SCSI host
2036 * Configures queue depth based on host's cmd_per_len. If not set
2037 * then we use the libfc default.
2039 int fc_slave_alloc(struct scsi_device *sdev)
2041 struct fc_rport *rport = starget_to_rport(scsi_target(sdev));
2043 if (!rport || fc_remote_port_chkready(rport))
2046 if (sdev->tagged_supported)
2047 scsi_activate_tcq(sdev, FC_FCP_DFLT_QUEUE_DEPTH);
2049 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev),
2050 FC_FCP_DFLT_QUEUE_DEPTH);
2054 EXPORT_SYMBOL(fc_slave_alloc);
2057 * fc_change_queue_depth() - Change a device's queue depth
2058 * @sdev: The SCSI device whose queue depth is to change
2059 * @qdepth: The new queue depth
2060 * @reason: The resason for the change
2062 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth, int reason)
2065 case SCSI_QDEPTH_DEFAULT:
2066 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), qdepth);
2068 case SCSI_QDEPTH_QFULL:
2069 scsi_track_queue_full(sdev, qdepth);
2071 case SCSI_QDEPTH_RAMP_UP:
2072 scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev), qdepth);
2077 return sdev->queue_depth;
2079 EXPORT_SYMBOL(fc_change_queue_depth);
2082 * fc_change_queue_type() - Change a device's queue type
2083 * @sdev: The SCSI device whose queue depth is to change
2084 * @tag_type: Identifier for queue type
2086 int fc_change_queue_type(struct scsi_device *sdev, int tag_type)
2088 if (sdev->tagged_supported) {
2089 scsi_set_tag_type(sdev, tag_type);
2091 scsi_activate_tcq(sdev, sdev->queue_depth);
2093 scsi_deactivate_tcq(sdev, sdev->queue_depth);
2099 EXPORT_SYMBOL(fc_change_queue_type);
2102 * fc_fcp_destory() - Tear down the FCP layer for a given local port
2103 * @lport: The local port that no longer needs the FCP layer
2105 void fc_fcp_destroy(struct fc_lport *lport)
2107 struct fc_fcp_internal *si = fc_get_scsi_internal(lport);
2109 if (!list_empty(&si->scsi_pkt_queue))
2110 printk(KERN_ERR "libfc: Leaked SCSI packets when destroying "
2111 "port (%6x)\n", fc_host_port_id(lport->host));
2113 mempool_destroy(si->scsi_pkt_pool);
2115 lport->scsi_priv = NULL;
2117 EXPORT_SYMBOL(fc_fcp_destroy);
2123 scsi_pkt_cachep = kmem_cache_create("libfc_fcp_pkt",
2124 sizeof(struct fc_fcp_pkt),
2125 0, SLAB_HWCACHE_ALIGN, NULL);
2126 if (!scsi_pkt_cachep) {
2127 printk(KERN_ERR "libfc: Unable to allocate SRB cache, "
2128 "module load failed!");
2135 void fc_destroy_fcp()
2137 if (scsi_pkt_cachep)
2138 kmem_cache_destroy(scsi_pkt_cachep);
2142 * fc_fcp_init() - Initialize the FCP layer for a local port
2143 * @lport: The local port to initialize the exchange layer for
2145 int fc_fcp_init(struct fc_lport *lport)
2148 struct fc_fcp_internal *si;
2150 if (!lport->tt.fcp_cmd_send)
2151 lport->tt.fcp_cmd_send = fc_fcp_cmd_send;
2153 if (!lport->tt.fcp_cleanup)
2154 lport->tt.fcp_cleanup = fc_fcp_cleanup;
2156 if (!lport->tt.fcp_abort_io)
2157 lport->tt.fcp_abort_io = fc_fcp_abort_io;
2159 si = kzalloc(sizeof(struct fc_fcp_internal), GFP_KERNEL);
2162 lport->scsi_priv = si;
2163 INIT_LIST_HEAD(&si->scsi_pkt_queue);
2165 si->scsi_pkt_pool = mempool_create_slab_pool(2, scsi_pkt_cachep);
2166 if (!si->scsi_pkt_pool) {
2176 EXPORT_SYMBOL(fc_fcp_init);