2 * Copyright(c) 2007 Intel Corporation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
17 * Maintained at www.Open-FCoE.org
23 #include <linux/timer.h>
25 #include <linux/percpu.h>
27 #include <scsi/scsi_transport.h>
28 #include <scsi/scsi_transport_fc.h>
30 #include <scsi/fc/fc_fcp.h>
31 #include <scsi/fc/fc_ns.h>
32 #include <scsi/fc/fc_els.h>
33 #include <scsi/fc/fc_gs.h>
35 #include <scsi/fc_frame.h>
37 #define FC_LIBFC_LOGGING 0x01 /* General logging, not categorized */
38 #define FC_LPORT_LOGGING 0x02 /* lport layer logging */
39 #define FC_DISC_LOGGING 0x04 /* discovery layer logging */
40 #define FC_RPORT_LOGGING 0x08 /* rport layer logging */
41 #define FC_FCP_LOGGING 0x10 /* I/O path logging */
42 #define FC_EM_LOGGING 0x20 /* Exchange Manager logging */
43 #define FC_EXCH_LOGGING 0x40 /* Exchange/Sequence logging */
44 #define FC_SCSI_LOGGING 0x80 /* SCSI logging (mostly error handling) */
46 extern unsigned int fc_debug_logging;
48 #define FC_CHECK_LOGGING(LEVEL, CMD) \
50 if (unlikely(fc_debug_logging & LEVEL)) \
56 #define FC_LIBFC_DBG(fmt, args...) \
57 FC_CHECK_LOGGING(FC_LIBFC_LOGGING, \
58 printk(KERN_INFO "libfc: " fmt, ##args))
60 #define FC_LPORT_DBG(lport, fmt, args...) \
61 FC_CHECK_LOGGING(FC_LPORT_LOGGING, \
62 printk(KERN_INFO "host%u: lport %6x: " fmt, \
63 (lport)->host->host_no, \
64 fc_host_port_id((lport)->host), ##args))
66 #define FC_DISC_DBG(disc, fmt, args...) \
67 FC_CHECK_LOGGING(FC_DISC_LOGGING, \
68 printk(KERN_INFO "host%u: disc: " fmt, \
69 (disc)->lport->host->host_no, \
72 #define FC_RPORT_ID_DBG(lport, port_id, fmt, args...) \
73 FC_CHECK_LOGGING(FC_RPORT_LOGGING, \
74 printk(KERN_INFO "host%u: rport %6x: " fmt, \
75 (lport)->host->host_no, \
78 #define FC_RPORT_DBG(rdata, fmt, args...) \
79 FC_RPORT_ID_DBG((rdata)->local_port, (rdata)->ids.port_id, fmt, ##args)
81 #define FC_FCP_DBG(pkt, fmt, args...) \
82 FC_CHECK_LOGGING(FC_FCP_LOGGING, \
83 printk(KERN_INFO "host%u: fcp: %6x: " fmt, \
84 (pkt)->lp->host->host_no, \
85 pkt->rport->port_id, ##args))
87 #define FC_EXCH_DBG(exch, fmt, args...) \
88 FC_CHECK_LOGGING(FC_EXCH_LOGGING, \
89 printk(KERN_INFO "host%u: xid %4x: " fmt, \
90 (exch)->lp->host->host_no, \
93 #define FC_SCSI_DBG(lport, fmt, args...) \
94 FC_CHECK_LOGGING(FC_SCSI_LOGGING, \
95 printk(KERN_INFO "host%u: scsi: " fmt, \
96 (lport)->host->host_no, ##args))
101 #define FC_NO_ERR 0 /* no error */
102 #define FC_EX_TIMEOUT 1 /* Exchange timeout */
103 #define FC_EX_CLOSED 2 /* Exchange closed */
105 /* some helpful macros */
107 #define ntohll(x) be64_to_cpu(x)
108 #define htonll(x) cpu_to_be64(x)
110 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
112 #define hton24(p, v) do { \
113 p[0] = (((v) >> 16) & 0xFF); \
114 p[1] = (((v) >> 8) & 0xFF); \
115 p[2] = ((v) & 0xFF); \
121 enum fc_lport_state {
122 LPORT_ST_DISABLED = 0,
139 enum fc_rport_state {
140 RPORT_ST_INIT, /* initialized */
141 RPORT_ST_PLOGI, /* waiting for PLOGI completion */
142 RPORT_ST_PRLI, /* waiting for PRLI completion */
143 RPORT_ST_RTV, /* waiting for RTV completion */
144 RPORT_ST_READY, /* ready for use */
145 RPORT_ST_LOGO, /* port logout sent */
146 RPORT_ST_DELETE, /* port being deleted */
150 * struct fc_disc_port - temporary discovery port to hold rport identifiers
151 * @lp: Fibre Channel host port instance
152 * @peers: node for list management during discovery and RSCN processing
153 * @ids: identifiers structure to pass to fc_remote_port_add()
154 * @rport_work: work struct for starting the rport state machine
156 struct fc_disc_port {
158 struct list_head peers;
159 struct fc_rport_identifiers ids;
160 struct work_struct rport_work;
163 enum fc_rport_event {
171 struct fc_rport_priv;
173 struct fc_rport_operations {
174 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
175 enum fc_rport_event);
179 * struct fc_rport_libfc_priv - libfc internal information about a remote port
180 * @local_port: Fibre Channel host port instance
181 * @rp_state: indicates READY for I/O or DELETE when blocked.
182 * @flags: REC and RETRY supported flags
183 * @e_d_tov: error detect timeout value (in msec)
184 * @r_a_tov: resource allocation timeout value (in msec)
186 struct fc_rport_libfc_priv {
187 struct fc_lport *local_port;
188 enum fc_rport_state rp_state;
190 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
191 #define FC_RP_FLAGS_RETRY (1 << 1)
192 unsigned int e_d_tov;
193 unsigned int r_a_tov;
197 * struct fc_rport_priv - libfc rport and discovery info about a remote port
198 * @local_port: Fibre Channel host port instance
199 * @rport: transport remote port
200 * @kref: reference counter
201 * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges
202 * @ids: remote port identifiers and roles
203 * @flags: REC and RETRY supported flags
204 * @max_seq: maximum number of concurrent sequences
205 * @maxframe_size: maximum frame size
206 * @retries: retry count in current state
207 * @e_d_tov: error detect timeout value (in msec)
208 * @r_a_tov: resource allocation timeout value (in msec)
209 * @rp_mutex: mutex protects rport
211 * @event_callback: Callback for rport READY, FAILED or LOGO
213 struct fc_rport_priv {
214 struct fc_lport *local_port;
215 struct fc_rport *rport;
217 enum fc_rport_state rp_state;
218 struct fc_rport_identifiers ids;
222 unsigned int retries;
223 unsigned int e_d_tov;
224 unsigned int r_a_tov;
225 struct mutex rp_mutex;
226 struct delayed_work retry_work;
227 enum fc_rport_event event;
228 struct fc_rport_operations *ops;
229 struct list_head peers;
230 struct work_struct event_work;
231 u32 supported_classes;
235 * fcoe stats structure
237 struct fcoe_dev_stats {
238 u64 SecondsSinceLastReset;
245 u64 LinkFailureCount;
246 u64 LossOfSignalCount;
247 u64 InvalidTxWordCount;
257 * els data is used for passing ELS respone specific
258 * data to send ELS response mainly using infomation
259 * in exchange and sequence in EM layer.
261 struct fc_seq_els_data {
263 enum fc_els_rjt_reason reason;
264 enum fc_els_rjt_explan explan;
268 * FCP request structure, one for each scsi cmd request
274 struct fc_lport *lp; /* handle to hba struct */
275 u16 state; /* scsi_pkt state state */
276 u16 tgt_flags; /* target flags */
277 atomic_t ref_cnt; /* fcp pkt ref count */
278 spinlock_t scsi_pkt_lock; /* Must be taken before the host lock
279 * if both are held at the same time */
281 * SCSI I/O related stuff
283 struct scsi_cmnd *cmd; /* scsi command pointer. set/clear
285 struct list_head list; /* tracks queued commands. access under
288 * timeout related stuff
290 struct timer_list timer; /* command timer */
291 struct completion tm_done;
293 unsigned long start_time; /* start jiffie */
294 unsigned long end_time; /* end jiffie */
295 unsigned long last_pkt_time; /* jiffies of last frame received */
298 * scsi cmd and data transfer information
302 * transport related veriables
304 struct fcp_cmnd cdb_cmd;
306 u16 xfer_ddp; /* this xfer is ddped */
307 u32 xfer_contig_end; /* offset of end of contiguous xfer */
308 u16 max_payload; /* max payload size in bytes */
311 * scsi/fcp return status
313 u32 io_status; /* SCSI result upper 24 bits */
315 u8 status_code; /* FCP I/O status */
316 /* bit 3 Underrun bit 2: overrun */
318 u32 req_flags; /* bit 0: read bit:1 write */
319 u32 scsi_resid; /* residule length */
321 struct fc_rport *rport; /* remote port pointer */
322 struct fc_seq *seq_ptr; /* current sequence pointer */
326 u8 recov_retry; /* count of recovery retries */
327 struct fc_seq *recov_seq; /* sequence for REC or SRR */
330 * FC_FCP HELPER FUNCTIONS
331 *****************************/
332 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
335 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
340 * Structure and function definitions for managing Fibre Channel Exchanges
343 * fc_exch holds state for one exchange and links to its active sequence.
345 * fc_seq holds the state for an individual sequence.
349 struct fc_exch_mgr_anchor;
350 extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
357 u16 ssb_stat; /* status flags for sequence status block */
358 u16 cnt; /* frames sent so far on sequence */
359 u32 rec_data; /* FC-4 value for REC */
362 #define FC_EX_DONE (1 << 0) /* ep is completed */
363 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
368 * Locking notes: The ex_lock protects following items:
369 * state, esb_stat, f_ctl, seq.ssb_stat
371 * sequence allocation
374 struct fc_exch_mgr *em; /* exchange manager */
375 struct fc_exch_pool *pool; /* per cpu exches pool */
376 u32 state; /* internal driver state */
377 u16 xid; /* our exchange ID */
378 struct list_head ex_list; /* free or busy list linkage */
379 spinlock_t ex_lock; /* lock covering exchange state */
380 atomic_t ex_refcnt; /* reference counter */
381 struct delayed_work timeout_work; /* timer for upper level protocols */
382 struct fc_lport *lp; /* fc device instance */
383 u16 oxid; /* originator's exchange ID */
384 u16 rxid; /* responder's exchange ID */
385 u32 oid; /* originator's FCID */
386 u32 sid; /* source FCID */
387 u32 did; /* destination FCID */
388 u32 esb_stat; /* exchange status for ESB */
389 u32 r_a_tov; /* r_a_tov from rport (msec) */
390 u8 seq_id; /* next sequence ID to use */
391 u32 f_ctl; /* F_CTL flags for sequences */
392 u8 fh_type; /* frame type */
393 enum fc_class class; /* class of service */
394 struct fc_seq seq; /* single sequence */
396 * Handler for responses to this current exchange.
398 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
399 void (*destructor)(struct fc_seq *, void *);
401 * arg is passed as void pointer to exchange
402 * resp and destructor handlers
406 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
408 struct libfc_function_template {
411 * Interface to send a FC frame
415 int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp);
418 * Interface to send ELS/CT frames
422 struct fc_seq *(*elsct_send)(struct fc_lport *lport,
426 void (*resp)(struct fc_seq *,
429 void *arg, u32 timer_msec);
432 * Send the FC frame payload using a new exchange and sequence.
434 * The frame pointer with some of the header's fields must be
435 * filled before calling exch_seq_send(), those fields are,
442 * - parameter or relative offset
444 * The exchange response handler is set in this routine to resp()
445 * function pointer. It can be called in two scenarios: if a timeout
446 * occurs or if a response frame is received for the exchange. The
447 * fc_frame pointer in response handler will also indicate timeout
448 * as error using IS_ERR related macros.
450 * The exchange destructor handler is also set in this routine.
451 * The destructor handler is invoked by EM layer when exchange
452 * is about to free, this can be used by caller to free its
453 * resources along with exchange free.
455 * The arg is passed back to resp and destructor handler.
457 * The timeout value (in msec) for an exchange is set if non zero
458 * timer_msec argument is specified. The timer is canceled when
459 * it fires or when the exchange is done. The exchange timeout handler
460 * is registered by EM layer.
464 struct fc_seq *(*exch_seq_send)(struct fc_lport *lp,
466 void (*resp)(struct fc_seq *sp,
469 void (*destructor)(struct fc_seq *sp,
471 void *arg, unsigned int timer_msec);
474 * Sets up the DDP context for a given exchange id on the given
475 * scatterlist if LLD supports DDP for large receive.
479 int (*ddp_setup)(struct fc_lport *lp, u16 xid,
480 struct scatterlist *sgl, unsigned int sgc);
482 * Completes the DDP transfer and returns the length of data DDPed
483 * for the given exchange id.
487 int (*ddp_done)(struct fc_lport *lp, u16 xid);
489 * Send a frame using an existing sequence and exchange.
493 int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp,
494 struct fc_frame *fp);
497 * Send an ELS response using infomation from a previous
498 * exchange and sequence.
502 void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd,
503 struct fc_seq_els_data *els_data);
506 * Abort an exchange and sequence. Generally called because of a
507 * exchange timeout or an abort from the upper layer.
509 * A timer_msec can be specified for abort timeout, if non-zero
510 * timer_msec value is specified then exchange resp handler
511 * will be called with timeout error if no response to abort.
515 int (*seq_exch_abort)(const struct fc_seq *req_sp,
516 unsigned int timer_msec);
519 * Indicate that an exchange/sequence tuple is complete and the memory
520 * allocated for the related objects may be freed.
524 void (*exch_done)(struct fc_seq *sp);
527 * Start a new sequence on the same exchange/sequence tuple.
531 struct fc_seq *(*seq_start_next)(struct fc_seq *sp);
534 * Reset an exchange manager, completing all sequences and exchanges.
535 * If s_id is non-zero, reset only exchanges originating from that FID.
536 * If d_id is non-zero, reset only exchanges sending to that FID.
540 void (*exch_mgr_reset)(struct fc_lport *,
544 * Flush the rport work queue. Generally used before shutdown.
548 void (*rport_flush_queue)(void);
551 * Receive a frame for a local port.
555 void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp,
556 struct fc_frame *fp);
559 * Reset the local port.
563 int (*lport_reset)(struct fc_lport *);
566 * Create a remote port
568 struct fc_rport_priv *(*rport_create)(struct fc_lport *,
569 struct fc_rport_identifiers *);
572 * Initiates the RP state machine. It is called from the LP module.
573 * This function will issue the following commands to the N_Port
574 * identified by the FC ID provided.
582 int (*rport_login)(struct fc_rport_priv *);
585 * Logoff, and remove the rport from the transport if
586 * it had been added. This will send a LOGO to the target.
590 int (*rport_logoff)(struct fc_rport_priv *);
593 * Recieve a request from a remote port.
597 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
598 struct fc_rport_priv *);
601 * lookup an rport by it's port ID.
605 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
608 * Destroy an rport after final kref_put().
609 * The argument is a pointer to the kref inside the fc_rport_priv.
611 void (*rport_destroy)(struct kref *);
614 * Send a fcp cmd from fsp pkt.
615 * Called with the SCSI host lock unlocked and irqs disabled.
617 * The resp handler is called when FCP_RSP received.
621 int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp,
622 void (*resp)(struct fc_seq *, struct fc_frame *fp,
626 * Cleanup the FCP layer, used durring link down and reset
630 void (*fcp_cleanup)(struct fc_lport *lp);
633 * Abort all I/O on a local port
637 void (*fcp_abort_io)(struct fc_lport *lp);
640 * Receive a request for the discovery layer.
644 void (*disc_recv_req)(struct fc_seq *,
645 struct fc_frame *, struct fc_lport *);
648 * Start discovery for a local port.
652 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
657 * Stop discovery for a given lport. This will remove
658 * all discovered rports
662 void (*disc_stop) (struct fc_lport *);
665 * Stop discovery for a given lport. This will block
666 * until all discovered rports are deleted from the
671 void (*disc_stop_final) (struct fc_lport *);
674 /* information used by the discovery layer */
676 unsigned char retry_count;
677 unsigned char pending;
678 unsigned char requested;
679 unsigned short seq_count;
680 unsigned char buf_len;
682 void (*disc_callback)(struct fc_lport *,
685 struct list_head rports;
686 struct fc_lport *lport;
687 struct mutex disc_mutex;
688 struct fc_gpn_ft_resp partial_buf; /* partial name buffer */
689 struct delayed_work disc_work;
693 struct list_head list;
696 struct Scsi_Host *host;
697 struct list_head ema_list;
698 struct fc_rport_priv *dns_rp;
699 struct fc_rport_priv *ptp_rp;
703 /* Operational Information */
704 struct libfc_function_template tt;
707 enum fc_lport_state state;
708 unsigned long boot_time;
710 struct fc_host_statistics host_stats;
711 struct fcoe_dev_stats *dev_stats;
718 u32 sg_supp:1; /* scatter gather supported */
719 u32 seq_offload:1; /* seq offload supported */
720 u32 crc_offload:1; /* crc offload supported */
721 u32 lro_enabled:1; /* large receive offload */
722 u32 mfs; /* max FC payload size */
723 unsigned int service_params;
724 unsigned int e_d_tov;
725 unsigned int r_a_tov;
727 u8 max_rport_retry_count;
729 u16 link_supported_speeds;
730 u16 lro_xid; /* max xid for fcoe lro */
731 unsigned int lso_max; /* max large send size */
732 struct fc_ns_fts fcts; /* FC-4 type masks */
733 struct fc_els_rnid_gen rnid_gen; /* RNID information */
736 struct mutex lp_mutex;
739 struct delayed_work retry_work;
740 struct delayed_work disc_work;
744 * FC_LPORT HELPER FUNCTIONS
745 *****************************/
746 static inline int fc_lport_test_ready(struct fc_lport *lp)
748 return lp->state == LPORT_ST_READY;
751 static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn)
756 static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn)
761 static inline void fc_lport_state_enter(struct fc_lport *lp,
762 enum fc_lport_state state)
764 if (state != lp->state)
769 static inline int fc_lport_init_stats(struct fc_lport *lp)
771 /* allocate per cpu stats block */
772 lp->dev_stats = alloc_percpu(struct fcoe_dev_stats);
778 static inline void fc_lport_free_stats(struct fc_lport *lp)
780 free_percpu(lp->dev_stats);
783 static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp)
785 return per_cpu_ptr(lp->dev_stats, smp_processor_id());
788 static inline void *lport_priv(const struct fc_lport *lp)
790 return (void *)(lp + 1);
794 * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport
795 * @sht: ptr to the scsi host templ
796 * @priv_size: size of private data after fc_lport
798 * Returns: ptr to Scsi_Host
800 static inline struct Scsi_Host *
801 libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
803 return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size);
808 *****************************/
809 int fc_lport_init(struct fc_lport *lp);
812 * Destroy the specified local port by finding and freeing all
813 * fc_rports associated with it and then by freeing the fc_lport
816 int fc_lport_destroy(struct fc_lport *lp);
819 * Logout the specified local port from the fabric
821 int fc_fabric_logoff(struct fc_lport *lp);
824 * Initiate the LP state machine. This handler will use fc_host_attr
825 * to store the FLOGI service parameters, so fc_host_attr must be
826 * initialized before calling this handler.
828 int fc_fabric_login(struct fc_lport *lp);
831 * The link is up for the given local port.
833 void fc_linkup(struct fc_lport *);
836 * Link is down for the given local port.
838 void fc_linkdown(struct fc_lport *);
841 * Configure the local port.
843 int fc_lport_config(struct fc_lport *);
846 * Reset the local port.
848 int fc_lport_reset(struct fc_lport *);
851 * Set the mfs or reset
853 int fc_set_mfs(struct fc_lport *lp, u32 mfs);
858 *****************************/
859 int fc_rport_init(struct fc_lport *lp);
860 void fc_rport_terminate_io(struct fc_rport *rp);
864 *****************************/
865 int fc_disc_init(struct fc_lport *lp);
870 *****************************/
872 * Initialize the SCSI block of libfc
874 int fc_fcp_init(struct fc_lport *);
877 * This section provides an API which allows direct interaction
878 * with the SCSI-ml. Each of these functions satisfies a function
879 * pointer defined in Scsi_Host and therefore is always called
880 * directly from the SCSI-ml.
882 int fc_queuecommand(struct scsi_cmnd *sc_cmd,
883 void (*done)(struct scsi_cmnd *));
886 * complete processing of a fcp packet
888 * This function may sleep if a fsp timer is pending.
889 * The host lock must not be held by caller.
891 void fc_fcp_complete(struct fc_fcp_pkt *fsp);
894 * Send an ABTS frame to the target device. The sc_cmd argument
895 * is a pointer to the SCSI command to be aborted.
897 int fc_eh_abort(struct scsi_cmnd *sc_cmd);
900 * Reset a LUN by sending send the tm cmd to the target.
902 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
905 * Reset the host adapter.
907 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
910 * Check rport status.
912 int fc_slave_alloc(struct scsi_device *sdev);
915 * Adjust the queue depth.
917 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth);
920 * Change the tag type.
922 int fc_change_queue_type(struct scsi_device *sdev, int tag_type);
925 * Free memory pools used by the FCP layer.
927 void fc_fcp_destroy(struct fc_lport *);
930 * Set up direct-data placement for this I/O request
932 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid);
936 *****************************/
938 * Initializes ELS/CT interface
940 int fc_elsct_init(struct fc_lport *lp);
944 * EXCHANGE MANAGER LAYER
945 *****************************/
947 * Initializes Exchange Manager related
948 * function pointers in struct libfc_function_template.
950 int fc_exch_init(struct fc_lport *lp);
953 * Adds Exchange Manager (EM) mp to lport.
955 * Adds specified mp to lport using struct fc_exch_mgr_anchor,
956 * the struct fc_exch_mgr_anchor allows same EM sharing by
957 * more than one lport with their specified match function,
958 * the match function is used in allocating exchange from
961 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport,
962 struct fc_exch_mgr *mp,
963 bool (*match)(struct fc_frame *));
966 * Deletes Exchange Manager (EM) from lport by removing
967 * its anchor ema from lport.
969 * If removed anchor ema was the last user of its associated EM
970 * then also destroys associated EM.
972 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema);
975 * Allocates an Exchange Manager (EM).
977 * The EM manages exchanges for their allocation and
978 * free, also allows exchange lookup for received
981 * The class is used for initializing FC class of
982 * allocated exchange from EM.
984 * The min_xid and max_xid will limit new
985 * exchange ID (XID) within this range for
987 * The LLD may choose to have multiple EMs,
988 * e.g. one EM instance per CPU receive thread in LLD.
990 * Specified match function is used in allocating exchanges
991 * from newly allocated EM.
993 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp,
997 bool (*match)(struct fc_frame *));
1000 * Free all exchange managers of a lport.
1002 void fc_exch_mgr_free(struct fc_lport *lport);
1005 * Receive a frame on specified local port and exchange manager.
1007 void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp);
1010 * This function is for exch_seq_send function pointer in
1011 * struct libfc_function_template, see comment block on
1012 * exch_seq_send for description of this function.
1014 struct fc_seq *fc_exch_seq_send(struct fc_lport *lp,
1015 struct fc_frame *fp,
1016 void (*resp)(struct fc_seq *sp,
1017 struct fc_frame *fp,
1019 void (*destructor)(struct fc_seq *sp,
1021 void *arg, u32 timer_msec);
1024 * send a frame using existing sequence and exchange.
1026 int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp);
1029 * Send ELS response using mainly infomation
1030 * in exchange and sequence in EM layer.
1032 void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd,
1033 struct fc_seq_els_data *els_data);
1036 * This function is for seq_exch_abort function pointer in
1037 * struct libfc_function_template, see comment block on
1038 * seq_exch_abort for description of this function.
1040 int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec);
1043 * Indicate that an exchange/sequence tuple is complete and the memory
1044 * allocated for the related objects may be freed.
1046 void fc_exch_done(struct fc_seq *sp);
1049 * Allocate a new exchange and sequence pair.
1051 struct fc_exch *fc_exch_alloc(struct fc_lport *lport, struct fc_frame *fp);
1053 * Start a new sequence on the same exchange as the supplied sequence.
1055 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
1059 * Reset all EMs of a lport, releasing its all sequences and
1060 * exchanges. If sid is non-zero, then reset only exchanges
1061 * we sourced from that FID. If did is non-zero, reset only
1062 * exchanges destined to that FID.
1064 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1067 * Functions for fc_functions_template
1069 void fc_get_host_speed(struct Scsi_Host *shost);
1070 void fc_get_host_port_type(struct Scsi_Host *shost);
1071 void fc_get_host_port_state(struct Scsi_Host *shost);
1072 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout);
1073 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1076 * module setup functions.
1078 int fc_setup_exch_mgr(void);
1079 void fc_destroy_exch_mgr(void);
1080 int fc_setup_rport(void);
1081 void fc_destroy_rport(void);
1083 #endif /* _LIBFC_H_ */