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 * @rport_work: Work struct for starting the rport state machine
154 * @port_id: Port ID of the discovered port
156 struct fc_disc_port {
158 struct list_head peers;
159 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 * @disc_id: discovery identifier
206 * @maxframe_size: maximum frame size
207 * @retries: retry count in current state
208 * @e_d_tov: error detect timeout value (in msec)
209 * @r_a_tov: resource allocation timeout value (in msec)
210 * @rp_mutex: mutex protects rport
212 * @event_callback: Callback for rport READY, FAILED or LOGO
214 struct fc_rport_priv {
215 struct fc_lport *local_port;
216 struct fc_rport *rport;
218 enum fc_rport_state rp_state;
219 struct fc_rport_identifiers ids;
224 unsigned int retries;
225 unsigned int e_d_tov;
226 unsigned int r_a_tov;
227 struct mutex rp_mutex;
228 struct delayed_work retry_work;
229 enum fc_rport_event event;
230 struct fc_rport_operations *ops;
231 struct list_head peers;
232 struct work_struct event_work;
233 u32 supported_classes;
237 * fcoe stats structure
239 struct fcoe_dev_stats {
240 u64 SecondsSinceLastReset;
247 u64 LinkFailureCount;
248 u64 LossOfSignalCount;
249 u64 InvalidTxWordCount;
259 * els data is used for passing ELS respone specific
260 * data to send ELS response mainly using infomation
261 * in exchange and sequence in EM layer.
263 struct fc_seq_els_data {
265 enum fc_els_rjt_reason reason;
266 enum fc_els_rjt_explan explan;
270 * FCP request structure, one for each scsi cmd request
276 struct fc_lport *lp; /* handle to hba struct */
277 u16 state; /* scsi_pkt state state */
278 u16 tgt_flags; /* target flags */
279 atomic_t ref_cnt; /* fcp pkt ref count */
280 spinlock_t scsi_pkt_lock; /* Must be taken before the host lock
281 * if both are held at the same time */
283 * SCSI I/O related stuff
285 struct scsi_cmnd *cmd; /* scsi command pointer. set/clear
287 struct list_head list; /* tracks queued commands. access under
290 * timeout related stuff
292 struct timer_list timer; /* command timer */
293 struct completion tm_done;
295 unsigned long start_time; /* start jiffie */
296 unsigned long end_time; /* end jiffie */
297 unsigned long last_pkt_time; /* jiffies of last frame received */
300 * scsi cmd and data transfer information
304 * transport related veriables
306 struct fcp_cmnd cdb_cmd;
308 u16 xfer_ddp; /* this xfer is ddped */
309 u32 xfer_contig_end; /* offset of end of contiguous xfer */
310 u16 max_payload; /* max payload size in bytes */
313 * scsi/fcp return status
315 u32 io_status; /* SCSI result upper 24 bits */
317 u8 status_code; /* FCP I/O status */
318 /* bit 3 Underrun bit 2: overrun */
320 u32 req_flags; /* bit 0: read bit:1 write */
321 u32 scsi_resid; /* residule length */
323 struct fc_rport *rport; /* remote port pointer */
324 struct fc_seq *seq_ptr; /* current sequence pointer */
328 u8 recov_retry; /* count of recovery retries */
329 struct fc_seq *recov_seq; /* sequence for REC or SRR */
332 * FC_FCP HELPER FUNCTIONS
333 *****************************/
334 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
337 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
342 * Structure and function definitions for managing Fibre Channel Exchanges
345 * fc_exch holds state for one exchange and links to its active sequence.
347 * fc_seq holds the state for an individual sequence.
351 struct fc_exch_mgr_anchor;
352 extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
359 u16 ssb_stat; /* status flags for sequence status block */
360 u16 cnt; /* frames sent so far on sequence */
361 u32 rec_data; /* FC-4 value for REC */
364 #define FC_EX_DONE (1 << 0) /* ep is completed */
365 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
370 * Locking notes: The ex_lock protects following items:
371 * state, esb_stat, f_ctl, seq.ssb_stat
373 * sequence allocation
376 struct fc_exch_mgr *em; /* exchange manager */
377 struct fc_exch_pool *pool; /* per cpu exches pool */
378 u32 state; /* internal driver state */
379 u16 xid; /* our exchange ID */
380 struct list_head ex_list; /* free or busy list linkage */
381 spinlock_t ex_lock; /* lock covering exchange state */
382 atomic_t ex_refcnt; /* reference counter */
383 struct delayed_work timeout_work; /* timer for upper level protocols */
384 struct fc_lport *lp; /* fc device instance */
385 u16 oxid; /* originator's exchange ID */
386 u16 rxid; /* responder's exchange ID */
387 u32 oid; /* originator's FCID */
388 u32 sid; /* source FCID */
389 u32 did; /* destination FCID */
390 u32 esb_stat; /* exchange status for ESB */
391 u32 r_a_tov; /* r_a_tov from rport (msec) */
392 u8 seq_id; /* next sequence ID to use */
393 u32 f_ctl; /* F_CTL flags for sequences */
394 u8 fh_type; /* frame type */
395 enum fc_class class; /* class of service */
396 struct fc_seq seq; /* single sequence */
398 * Handler for responses to this current exchange.
400 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
401 void (*destructor)(struct fc_seq *, void *);
403 * arg is passed as void pointer to exchange
404 * resp and destructor handlers
408 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
410 struct libfc_function_template {
413 * Interface to send a FC frame
417 int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp);
420 * Interface to send ELS/CT frames
424 struct fc_seq *(*elsct_send)(struct fc_lport *lport,
428 void (*resp)(struct fc_seq *,
431 void *arg, u32 timer_msec);
434 * Send the FC frame payload using a new exchange and sequence.
436 * The frame pointer with some of the header's fields must be
437 * filled before calling exch_seq_send(), those fields are,
444 * - parameter or relative offset
446 * The exchange response handler is set in this routine to resp()
447 * function pointer. It can be called in two scenarios: if a timeout
448 * occurs or if a response frame is received for the exchange. The
449 * fc_frame pointer in response handler will also indicate timeout
450 * as error using IS_ERR related macros.
452 * The exchange destructor handler is also set in this routine.
453 * The destructor handler is invoked by EM layer when exchange
454 * is about to free, this can be used by caller to free its
455 * resources along with exchange free.
457 * The arg is passed back to resp and destructor handler.
459 * The timeout value (in msec) for an exchange is set if non zero
460 * timer_msec argument is specified. The timer is canceled when
461 * it fires or when the exchange is done. The exchange timeout handler
462 * is registered by EM layer.
466 struct fc_seq *(*exch_seq_send)(struct fc_lport *lp,
468 void (*resp)(struct fc_seq *sp,
471 void (*destructor)(struct fc_seq *sp,
473 void *arg, unsigned int timer_msec);
476 * Sets up the DDP context for a given exchange id on the given
477 * scatterlist if LLD supports DDP for large receive.
481 int (*ddp_setup)(struct fc_lport *lp, u16 xid,
482 struct scatterlist *sgl, unsigned int sgc);
484 * Completes the DDP transfer and returns the length of data DDPed
485 * for the given exchange id.
489 int (*ddp_done)(struct fc_lport *lp, u16 xid);
491 * Send a frame using an existing sequence and exchange.
495 int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp,
496 struct fc_frame *fp);
499 * Send an ELS response using infomation from a previous
500 * exchange and sequence.
504 void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd,
505 struct fc_seq_els_data *els_data);
508 * Abort an exchange and sequence. Generally called because of a
509 * exchange timeout or an abort from the upper layer.
511 * A timer_msec can be specified for abort timeout, if non-zero
512 * timer_msec value is specified then exchange resp handler
513 * will be called with timeout error if no response to abort.
517 int (*seq_exch_abort)(const struct fc_seq *req_sp,
518 unsigned int timer_msec);
521 * Indicate that an exchange/sequence tuple is complete and the memory
522 * allocated for the related objects may be freed.
526 void (*exch_done)(struct fc_seq *sp);
529 * Start a new sequence on the same exchange/sequence tuple.
533 struct fc_seq *(*seq_start_next)(struct fc_seq *sp);
536 * Reset an exchange manager, completing all sequences and exchanges.
537 * If s_id is non-zero, reset only exchanges originating from that FID.
538 * If d_id is non-zero, reset only exchanges sending to that FID.
542 void (*exch_mgr_reset)(struct fc_lport *,
546 * Flush the rport work queue. Generally used before shutdown.
550 void (*rport_flush_queue)(void);
553 * Receive a frame for a local port.
557 void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp,
558 struct fc_frame *fp);
561 * Reset the local port.
565 int (*lport_reset)(struct fc_lport *);
568 * Create a remote port with a given port ID
572 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
575 * Initiates the RP state machine. It is called from the LP module.
576 * This function will issue the following commands to the N_Port
577 * identified by the FC ID provided.
585 int (*rport_login)(struct fc_rport_priv *);
588 * Logoff, and remove the rport from the transport if
589 * it had been added. This will send a LOGO to the target.
593 int (*rport_logoff)(struct fc_rport_priv *);
596 * Recieve a request from a remote port.
600 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
604 * lookup an rport by it's port ID.
608 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
611 * Destroy an rport after final kref_put().
612 * The argument is a pointer to the kref inside the fc_rport_priv.
614 void (*rport_destroy)(struct kref *);
617 * Send a fcp cmd from fsp pkt.
618 * Called with the SCSI host lock unlocked and irqs disabled.
620 * The resp handler is called when FCP_RSP received.
624 int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp,
625 void (*resp)(struct fc_seq *, struct fc_frame *fp,
629 * Cleanup the FCP layer, used durring link down and reset
633 void (*fcp_cleanup)(struct fc_lport *lp);
636 * Abort all I/O on a local port
640 void (*fcp_abort_io)(struct fc_lport *lp);
643 * Receive a request for the discovery layer.
647 void (*disc_recv_req)(struct fc_seq *,
648 struct fc_frame *, struct fc_lport *);
651 * Start discovery for a local port.
655 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
660 * Stop discovery for a given lport. This will remove
661 * all discovered rports
665 void (*disc_stop) (struct fc_lport *);
668 * Stop discovery for a given lport. This will block
669 * until all discovered rports are deleted from the
674 void (*disc_stop_final) (struct fc_lport *);
677 /* information used by the discovery layer */
679 unsigned char retry_count;
680 unsigned char pending;
681 unsigned char requested;
682 unsigned short seq_count;
683 unsigned char buf_len;
686 void (*disc_callback)(struct fc_lport *,
689 struct list_head rports;
690 struct fc_lport *lport;
691 struct mutex disc_mutex;
692 struct fc_gpn_ft_resp partial_buf; /* partial name buffer */
693 struct delayed_work disc_work;
697 struct list_head list;
700 struct Scsi_Host *host;
701 struct list_head ema_list;
702 struct fc_rport_priv *dns_rp;
703 struct fc_rport_priv *ptp_rp;
707 /* Operational Information */
708 struct libfc_function_template tt;
711 enum fc_lport_state state;
712 unsigned long boot_time;
714 struct fc_host_statistics host_stats;
715 struct fcoe_dev_stats *dev_stats;
722 u32 sg_supp:1; /* scatter gather supported */
723 u32 seq_offload:1; /* seq offload supported */
724 u32 crc_offload:1; /* crc offload supported */
725 u32 lro_enabled:1; /* large receive offload */
726 u32 mfs; /* max FC payload size */
727 unsigned int service_params;
728 unsigned int e_d_tov;
729 unsigned int r_a_tov;
731 u8 max_rport_retry_count;
733 u16 link_supported_speeds;
734 u16 lro_xid; /* max xid for fcoe lro */
735 unsigned int lso_max; /* max large send size */
736 struct fc_ns_fts fcts; /* FC-4 type masks */
737 struct fc_els_rnid_gen rnid_gen; /* RNID information */
740 struct mutex lp_mutex;
743 struct delayed_work retry_work;
744 struct delayed_work disc_work;
748 * FC_LPORT HELPER FUNCTIONS
749 *****************************/
750 static inline int fc_lport_test_ready(struct fc_lport *lp)
752 return lp->state == LPORT_ST_READY;
755 static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn)
760 static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn)
765 static inline void fc_lport_state_enter(struct fc_lport *lp,
766 enum fc_lport_state state)
768 if (state != lp->state)
773 static inline int fc_lport_init_stats(struct fc_lport *lp)
775 /* allocate per cpu stats block */
776 lp->dev_stats = alloc_percpu(struct fcoe_dev_stats);
782 static inline void fc_lport_free_stats(struct fc_lport *lp)
784 free_percpu(lp->dev_stats);
787 static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp)
789 return per_cpu_ptr(lp->dev_stats, smp_processor_id());
792 static inline void *lport_priv(const struct fc_lport *lp)
794 return (void *)(lp + 1);
798 * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport
799 * @sht: ptr to the scsi host templ
800 * @priv_size: size of private data after fc_lport
802 * Returns: ptr to Scsi_Host
804 static inline struct Scsi_Host *
805 libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
807 return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size);
812 *****************************/
813 int fc_lport_init(struct fc_lport *lp);
816 * Destroy the specified local port by finding and freeing all
817 * fc_rports associated with it and then by freeing the fc_lport
820 int fc_lport_destroy(struct fc_lport *lp);
823 * Logout the specified local port from the fabric
825 int fc_fabric_logoff(struct fc_lport *lp);
828 * Initiate the LP state machine. This handler will use fc_host_attr
829 * to store the FLOGI service parameters, so fc_host_attr must be
830 * initialized before calling this handler.
832 int fc_fabric_login(struct fc_lport *lp);
835 * The link is up for the given local port.
837 void fc_linkup(struct fc_lport *);
840 * Link is down for the given local port.
842 void fc_linkdown(struct fc_lport *);
845 * Configure the local port.
847 int fc_lport_config(struct fc_lport *);
850 * Reset the local port.
852 int fc_lport_reset(struct fc_lport *);
855 * Set the mfs or reset
857 int fc_set_mfs(struct fc_lport *lp, u32 mfs);
862 *****************************/
863 int fc_rport_init(struct fc_lport *lp);
864 void fc_rport_terminate_io(struct fc_rport *rp);
868 *****************************/
869 int fc_disc_init(struct fc_lport *lp);
874 *****************************/
876 * Initialize the SCSI block of libfc
878 int fc_fcp_init(struct fc_lport *);
881 * This section provides an API which allows direct interaction
882 * with the SCSI-ml. Each of these functions satisfies a function
883 * pointer defined in Scsi_Host and therefore is always called
884 * directly from the SCSI-ml.
886 int fc_queuecommand(struct scsi_cmnd *sc_cmd,
887 void (*done)(struct scsi_cmnd *));
890 * complete processing of a fcp packet
892 * This function may sleep if a fsp timer is pending.
893 * The host lock must not be held by caller.
895 void fc_fcp_complete(struct fc_fcp_pkt *fsp);
898 * Send an ABTS frame to the target device. The sc_cmd argument
899 * is a pointer to the SCSI command to be aborted.
901 int fc_eh_abort(struct scsi_cmnd *sc_cmd);
904 * Reset a LUN by sending send the tm cmd to the target.
906 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
909 * Reset the host adapter.
911 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
914 * Check rport status.
916 int fc_slave_alloc(struct scsi_device *sdev);
919 * Adjust the queue depth.
921 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth);
924 * Change the tag type.
926 int fc_change_queue_type(struct scsi_device *sdev, int tag_type);
929 * Free memory pools used by the FCP layer.
931 void fc_fcp_destroy(struct fc_lport *);
934 * Set up direct-data placement for this I/O request
936 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid);
940 *****************************/
942 * Initializes ELS/CT interface
944 int fc_elsct_init(struct fc_lport *lp);
948 * EXCHANGE MANAGER LAYER
949 *****************************/
951 * Initializes Exchange Manager related
952 * function pointers in struct libfc_function_template.
954 int fc_exch_init(struct fc_lport *lp);
957 * Adds Exchange Manager (EM) mp to lport.
959 * Adds specified mp to lport using struct fc_exch_mgr_anchor,
960 * the struct fc_exch_mgr_anchor allows same EM sharing by
961 * more than one lport with their specified match function,
962 * the match function is used in allocating exchange from
965 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport,
966 struct fc_exch_mgr *mp,
967 bool (*match)(struct fc_frame *));
970 * Deletes Exchange Manager (EM) from lport by removing
971 * its anchor ema from lport.
973 * If removed anchor ema was the last user of its associated EM
974 * then also destroys associated EM.
976 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema);
979 * Allocates an Exchange Manager (EM).
981 * The EM manages exchanges for their allocation and
982 * free, also allows exchange lookup for received
985 * The class is used for initializing FC class of
986 * allocated exchange from EM.
988 * The min_xid and max_xid will limit new
989 * exchange ID (XID) within this range for
991 * The LLD may choose to have multiple EMs,
992 * e.g. one EM instance per CPU receive thread in LLD.
994 * Specified match function is used in allocating exchanges
995 * from newly allocated EM.
997 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp,
1001 bool (*match)(struct fc_frame *));
1004 * Free all exchange managers of a lport.
1006 void fc_exch_mgr_free(struct fc_lport *lport);
1009 * Receive a frame on specified local port and exchange manager.
1011 void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp);
1014 * This function is for exch_seq_send function pointer in
1015 * struct libfc_function_template, see comment block on
1016 * exch_seq_send for description of this function.
1018 struct fc_seq *fc_exch_seq_send(struct fc_lport *lp,
1019 struct fc_frame *fp,
1020 void (*resp)(struct fc_seq *sp,
1021 struct fc_frame *fp,
1023 void (*destructor)(struct fc_seq *sp,
1025 void *arg, u32 timer_msec);
1028 * send a frame using existing sequence and exchange.
1030 int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp);
1033 * Send ELS response using mainly infomation
1034 * in exchange and sequence in EM layer.
1036 void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd,
1037 struct fc_seq_els_data *els_data);
1040 * This function is for seq_exch_abort function pointer in
1041 * struct libfc_function_template, see comment block on
1042 * seq_exch_abort for description of this function.
1044 int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec);
1047 * Indicate that an exchange/sequence tuple is complete and the memory
1048 * allocated for the related objects may be freed.
1050 void fc_exch_done(struct fc_seq *sp);
1053 * Allocate a new exchange and sequence pair.
1055 struct fc_exch *fc_exch_alloc(struct fc_lport *lport, struct fc_frame *fp);
1057 * Start a new sequence on the same exchange as the supplied sequence.
1059 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
1063 * Reset all EMs of a lport, releasing its all sequences and
1064 * exchanges. If sid is non-zero, then reset only exchanges
1065 * we sourced from that FID. If did is non-zero, reset only
1066 * exchanges destined to that FID.
1068 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1071 * Functions for fc_functions_template
1073 void fc_get_host_speed(struct Scsi_Host *shost);
1074 void fc_get_host_port_type(struct Scsi_Host *shost);
1075 void fc_get_host_port_state(struct Scsi_Host *shost);
1076 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout);
1077 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1080 * module setup functions.
1082 int fc_setup_exch_mgr(void);
1083 void fc_destroy_exch_mgr(void);
1084 int fc_setup_rport(void);
1085 void fc_destroy_rport(void);
1087 #endif /* _LIBFC_H_ */