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(rport, fmt, args...) \
80 struct fc_rport_libfc_priv *rdata = rport->dd_data; \
81 struct fc_lport *lport = rdata->local_port; \
82 FC_RPORT_ID_DBG(lport, rport->port_id, fmt, ##args); \
85 #define FC_FCP_DBG(pkt, fmt, args...) \
86 FC_CHECK_LOGGING(FC_FCP_LOGGING, \
87 printk(KERN_INFO "host%u: fcp: %6x: " fmt, \
88 (pkt)->lp->host->host_no, \
89 pkt->rport->port_id, ##args))
91 #define FC_EXCH_DBG(exch, fmt, args...) \
92 FC_CHECK_LOGGING(FC_EXCH_LOGGING, \
93 printk(KERN_INFO "host%u: xid %4x: " fmt, \
94 (exch)->lp->host->host_no, \
97 #define FC_SCSI_DBG(lport, fmt, args...) \
98 FC_CHECK_LOGGING(FC_SCSI_LOGGING, \
99 printk(KERN_INFO "host%u: scsi: " fmt, \
100 (lport)->host->host_no, ##args))
105 #define FC_NO_ERR 0 /* no error */
106 #define FC_EX_TIMEOUT 1 /* Exchange timeout */
107 #define FC_EX_CLOSED 2 /* Exchange closed */
109 /* some helpful macros */
111 #define ntohll(x) be64_to_cpu(x)
112 #define htonll(x) cpu_to_be64(x)
114 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
116 #define hton24(p, v) do { \
117 p[0] = (((v) >> 16) & 0xFF); \
118 p[1] = (((v) >> 8) & 0xFF); \
119 p[2] = ((v) & 0xFF); \
125 enum fc_lport_state {
126 LPORT_ST_DISABLED = 0,
143 enum fc_rport_state {
144 RPORT_ST_INIT, /* initialized */
145 RPORT_ST_PLOGI, /* waiting for PLOGI completion */
146 RPORT_ST_PRLI, /* waiting for PRLI completion */
147 RPORT_ST_RTV, /* waiting for RTV completion */
148 RPORT_ST_READY, /* ready for use */
149 RPORT_ST_LOGO, /* port logout sent */
150 RPORT_ST_DELETE, /* port being deleted */
153 enum fc_rport_trans_state {
159 * struct fc_disc_port - temporary discovery port to hold rport identifiers
160 * @lp: Fibre Channel host port instance
161 * @peers: node for list management during discovery and RSCN processing
162 * @ids: identifiers structure to pass to fc_remote_port_add()
163 * @rport_work: work struct for starting the rport state machine
165 struct fc_disc_port {
167 struct list_head peers;
168 struct fc_rport_identifiers ids;
169 struct work_struct rport_work;
172 enum fc_rport_event {
180 struct fc_rport_operations {
181 void (*event_callback)(struct fc_lport *, struct fc_rport *,
182 enum fc_rport_event);
186 * struct fc_rport_libfc_priv - libfc internal information about a remote port
187 * @local_port: Fibre Channel host port instance
188 * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges
189 * @flags: REC and RETRY supported flags
190 * @max_seq: maximum number of concurrent sequences
191 * @retries: retry count in current state
192 * @e_d_tov: error detect timeout value (in msec)
193 * @r_a_tov: resource allocation timeout value (in msec)
194 * @rp_mutex: mutex protects rport
196 * @event_callback: Callback for rport READY, FAILED or LOGO
198 struct fc_rport_libfc_priv {
199 struct fc_lport *local_port;
200 enum fc_rport_state rp_state;
202 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
203 #define FC_RP_FLAGS_RETRY (1 << 1)
205 unsigned int retries;
206 unsigned int e_d_tov;
207 unsigned int r_a_tov;
208 enum fc_rport_trans_state trans_state;
209 struct mutex rp_mutex;
210 struct delayed_work retry_work;
211 enum fc_rport_event event;
212 struct fc_rport_operations *ops;
213 struct list_head peers;
214 struct work_struct event_work;
217 #define PRIV_TO_RPORT(x) \
218 (struct fc_rport *)((void *)x - sizeof(struct fc_rport));
219 #define RPORT_TO_PRIV(x) \
220 (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport));
222 struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *);
224 static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn)
226 rport->node_name = wwnn;
227 rport->port_name = wwpn;
231 * fcoe stats structure
233 struct fcoe_dev_stats {
234 u64 SecondsSinceLastReset;
241 u64 LinkFailureCount;
242 u64 LossOfSignalCount;
243 u64 InvalidTxWordCount;
253 * els data is used for passing ELS respone specific
254 * data to send ELS response mainly using infomation
255 * in exchange and sequence in EM layer.
257 struct fc_seq_els_data {
259 enum fc_els_rjt_reason reason;
260 enum fc_els_rjt_explan explan;
264 * FCP request structure, one for each scsi cmd request
270 struct fc_lport *lp; /* handle to hba struct */
271 u16 state; /* scsi_pkt state state */
272 u16 tgt_flags; /* target flags */
273 atomic_t ref_cnt; /* fcp pkt ref count */
274 spinlock_t scsi_pkt_lock; /* Must be taken before the host lock
275 * if both are held at the same time */
277 * SCSI I/O related stuff
279 struct scsi_cmnd *cmd; /* scsi command pointer. set/clear
281 struct list_head list; /* tracks queued commands. access under
284 * timeout related stuff
286 struct timer_list timer; /* command timer */
287 struct completion tm_done;
289 unsigned long start_time; /* start jiffie */
290 unsigned long end_time; /* end jiffie */
291 unsigned long last_pkt_time; /* jiffies of last frame received */
294 * scsi cmd and data transfer information
298 * transport related veriables
300 struct fcp_cmnd cdb_cmd;
302 u16 xfer_ddp; /* this xfer is ddped */
303 u32 xfer_contig_end; /* offset of end of contiguous xfer */
304 u16 max_payload; /* max payload size in bytes */
307 * scsi/fcp return status
309 u32 io_status; /* SCSI result upper 24 bits */
311 u8 status_code; /* FCP I/O status */
312 /* bit 3 Underrun bit 2: overrun */
314 u32 req_flags; /* bit 0: read bit:1 write */
315 u32 scsi_resid; /* residule length */
317 struct fc_rport *rport; /* remote port pointer */
318 struct fc_seq *seq_ptr; /* current sequence pointer */
322 u8 recov_retry; /* count of recovery retries */
323 struct fc_seq *recov_seq; /* sequence for REC or SRR */
326 * FC_FCP HELPER FUNCTIONS
327 *****************************/
328 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
331 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
336 * Structure and function definitions for managing Fibre Channel Exchanges
339 * fc_exch holds state for one exchange and links to its active sequence.
341 * fc_seq holds the state for an individual sequence.
345 struct fc_exch_mgr_anchor;
352 u16 ssb_stat; /* status flags for sequence status block */
353 u16 cnt; /* frames sent so far on sequence */
354 u32 rec_data; /* FC-4 value for REC */
357 #define FC_EX_DONE (1 << 0) /* ep is completed */
358 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
363 * Locking notes: The ex_lock protects following items:
364 * state, esb_stat, f_ctl, seq.ssb_stat
366 * sequence allocation
369 struct fc_exch_mgr *em; /* exchange manager */
370 u32 state; /* internal driver state */
371 u16 xid; /* our exchange ID */
372 struct list_head ex_list; /* free or busy list linkage */
373 spinlock_t ex_lock; /* lock covering exchange state */
374 atomic_t ex_refcnt; /* reference counter */
375 struct delayed_work timeout_work; /* timer for upper level protocols */
376 struct fc_lport *lp; /* fc device instance */
377 u16 oxid; /* originator's exchange ID */
378 u16 rxid; /* responder's exchange ID */
379 u32 oid; /* originator's FCID */
380 u32 sid; /* source FCID */
381 u32 did; /* destination FCID */
382 u32 esb_stat; /* exchange status for ESB */
383 u32 r_a_tov; /* r_a_tov from rport (msec) */
384 u8 seq_id; /* next sequence ID to use */
385 u32 f_ctl; /* F_CTL flags for sequences */
386 u8 fh_type; /* frame type */
387 enum fc_class class; /* class of service */
388 struct fc_seq seq; /* single sequence */
390 * Handler for responses to this current exchange.
392 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
393 void (*destructor)(struct fc_seq *, void *);
395 * arg is passed as void pointer to exchange
396 * resp and destructor handlers
400 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
402 struct libfc_function_template {
405 * Interface to send a FC frame
409 int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp);
412 * Interface to send ELS/CT frames
416 struct fc_seq *(*elsct_send)(struct fc_lport *lport,
417 struct fc_rport *rport,
420 void (*resp)(struct fc_seq *,
423 void *arg, u32 timer_msec);
426 * Send the FC frame payload using a new exchange and sequence.
428 * The frame pointer with some of the header's fields must be
429 * filled before calling exch_seq_send(), those fields are,
436 * - parameter or relative offset
438 * The exchange response handler is set in this routine to resp()
439 * function pointer. It can be called in two scenarios: if a timeout
440 * occurs or if a response frame is received for the exchange. The
441 * fc_frame pointer in response handler will also indicate timeout
442 * as error using IS_ERR related macros.
444 * The exchange destructor handler is also set in this routine.
445 * The destructor handler is invoked by EM layer when exchange
446 * is about to free, this can be used by caller to free its
447 * resources along with exchange free.
449 * The arg is passed back to resp and destructor handler.
451 * The timeout value (in msec) for an exchange is set if non zero
452 * timer_msec argument is specified. The timer is canceled when
453 * it fires or when the exchange is done. The exchange timeout handler
454 * is registered by EM layer.
458 struct fc_seq *(*exch_seq_send)(struct fc_lport *lp,
460 void (*resp)(struct fc_seq *sp,
463 void (*destructor)(struct fc_seq *sp,
465 void *arg, unsigned int timer_msec);
468 * Sets up the DDP context for a given exchange id on the given
469 * scatterlist if LLD supports DDP for large receive.
473 int (*ddp_setup)(struct fc_lport *lp, u16 xid,
474 struct scatterlist *sgl, unsigned int sgc);
476 * Completes the DDP transfer and returns the length of data DDPed
477 * for the given exchange id.
481 int (*ddp_done)(struct fc_lport *lp, u16 xid);
483 * Send a frame using an existing sequence and exchange.
487 int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp,
488 struct fc_frame *fp);
491 * Send an ELS response using infomation from a previous
492 * exchange and sequence.
496 void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd,
497 struct fc_seq_els_data *els_data);
500 * Abort an exchange and sequence. Generally called because of a
501 * exchange timeout or an abort from the upper layer.
503 * A timer_msec can be specified for abort timeout, if non-zero
504 * timer_msec value is specified then exchange resp handler
505 * will be called with timeout error if no response to abort.
509 int (*seq_exch_abort)(const struct fc_seq *req_sp,
510 unsigned int timer_msec);
513 * Indicate that an exchange/sequence tuple is complete and the memory
514 * allocated for the related objects may be freed.
518 void (*exch_done)(struct fc_seq *sp);
521 * Assigns a EM and a free XID for an new exchange and then
522 * allocates a new exchange and sequence pair.
523 * The fp can be used to determine free XID.
527 struct fc_exch *(*exch_get)(struct fc_lport *lp, struct fc_frame *fp);
530 * Release previously assigned XID by exch_get API.
531 * The LLD may implement this if XID is assigned by LLD
536 void (*exch_put)(struct fc_lport *lp, struct fc_exch_mgr *mp,
540 * Start a new sequence on the same exchange/sequence tuple.
544 struct fc_seq *(*seq_start_next)(struct fc_seq *sp);
547 * Reset an exchange manager, completing all sequences and exchanges.
548 * If s_id is non-zero, reset only exchanges originating from that FID.
549 * If d_id is non-zero, reset only exchanges sending to that FID.
553 void (*exch_mgr_reset)(struct fc_lport *,
557 * Flush the rport work queue. Generally used before shutdown.
561 void (*rport_flush_queue)(void);
564 * Receive a frame for a local port.
568 void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp,
569 struct fc_frame *fp);
572 * Reset the local port.
576 int (*lport_reset)(struct fc_lport *);
579 * Create a remote port
581 struct fc_rport *(*rport_create)(struct fc_disc_port *);
584 * Initiates the RP state machine. It is called from the LP module.
585 * This function will issue the following commands to the N_Port
586 * identified by the FC ID provided.
594 int (*rport_login)(struct fc_rport *rport);
597 * Logoff, and remove the rport from the transport if
598 * it had been added. This will send a LOGO to the target.
602 int (*rport_logoff)(struct fc_rport *rport);
605 * Recieve a request from a remote port.
609 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
613 * lookup an rport by it's port ID.
617 struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32);
620 * Send a fcp cmd from fsp pkt.
621 * Called with the SCSI host lock unlocked and irqs disabled.
623 * The resp handler is called when FCP_RSP received.
627 int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp,
628 void (*resp)(struct fc_seq *, struct fc_frame *fp,
632 * Cleanup the FCP layer, used durring link down and reset
636 void (*fcp_cleanup)(struct fc_lport *lp);
639 * Abort all I/O on a local port
643 void (*fcp_abort_io)(struct fc_lport *lp);
646 * Receive a request for the discovery layer.
650 void (*disc_recv_req)(struct fc_seq *,
651 struct fc_frame *, struct fc_lport *);
654 * Start discovery for a local port.
658 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
663 * Stop discovery for a given lport. This will remove
664 * all discovered rports
668 void (*disc_stop) (struct fc_lport *);
671 * Stop discovery for a given lport. This will block
672 * until all discovered rports are deleted from the
677 void (*disc_stop_final) (struct fc_lport *);
680 /* information used by the discovery layer */
682 unsigned char retry_count;
684 unsigned char pending;
685 unsigned char requested;
686 unsigned short seq_count;
687 unsigned char buf_len;
688 enum fc_disc_event event;
690 void (*disc_callback)(struct fc_lport *,
693 struct list_head rports;
694 struct list_head rogue_rports;
695 struct fc_lport *lport;
696 struct mutex disc_mutex;
697 struct fc_gpn_ft_resp partial_buf; /* partial name buffer */
698 struct delayed_work disc_work;
702 struct list_head list;
705 struct Scsi_Host *host;
706 struct fc_exch_mgr *emp;
707 struct list_head ema_list;
708 struct fc_rport *dns_rp;
709 struct fc_rport *ptp_rp;
713 /* Operational Information */
714 struct libfc_function_template tt;
717 enum fc_lport_state state;
718 unsigned long boot_time;
720 struct fc_host_statistics host_stats;
721 struct fcoe_dev_stats *dev_stats;
728 u32 sg_supp:1; /* scatter gather supported */
729 u32 seq_offload:1; /* seq offload supported */
730 u32 crc_offload:1; /* crc offload supported */
731 u32 lro_enabled:1; /* large receive offload */
732 u32 mfs; /* max FC payload size */
733 unsigned int service_params;
734 unsigned int e_d_tov;
735 unsigned int r_a_tov;
737 u8 max_rport_retry_count;
739 u16 link_supported_speeds;
740 u16 lro_xid; /* max xid for fcoe lro */
741 unsigned int lso_max; /* max large send size */
742 struct fc_ns_fts fcts; /* FC-4 type masks */
743 struct fc_els_rnid_gen rnid_gen; /* RNID information */
746 struct mutex lp_mutex;
749 struct delayed_work retry_work;
750 struct delayed_work disc_work;
754 * FC_LPORT HELPER FUNCTIONS
755 *****************************/
756 static inline int fc_lport_test_ready(struct fc_lport *lp)
758 return lp->state == LPORT_ST_READY;
761 static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn)
766 static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn)
771 static inline void fc_lport_state_enter(struct fc_lport *lp,
772 enum fc_lport_state state)
774 if (state != lp->state)
779 static inline int fc_lport_init_stats(struct fc_lport *lp)
781 /* allocate per cpu stats block */
782 lp->dev_stats = alloc_percpu(struct fcoe_dev_stats);
788 static inline void fc_lport_free_stats(struct fc_lport *lp)
790 free_percpu(lp->dev_stats);
793 static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp)
795 return per_cpu_ptr(lp->dev_stats, smp_processor_id());
798 static inline void *lport_priv(const struct fc_lport *lp)
800 return (void *)(lp + 1);
804 * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport
805 * @sht: ptr to the scsi host templ
806 * @priv_size: size of private data after fc_lport
808 * Returns: ptr to Scsi_Host
810 static inline struct Scsi_Host *
811 libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
813 return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size);
818 *****************************/
819 int fc_lport_init(struct fc_lport *lp);
822 * Destroy the specified local port by finding and freeing all
823 * fc_rports associated with it and then by freeing the fc_lport
826 int fc_lport_destroy(struct fc_lport *lp);
829 * Logout the specified local port from the fabric
831 int fc_fabric_logoff(struct fc_lport *lp);
834 * Initiate the LP state machine. This handler will use fc_host_attr
835 * to store the FLOGI service parameters, so fc_host_attr must be
836 * initialized before calling this handler.
838 int fc_fabric_login(struct fc_lport *lp);
841 * The link is up for the given local port.
843 void fc_linkup(struct fc_lport *);
846 * Link is down for the given local port.
848 void fc_linkdown(struct fc_lport *);
851 * Configure the local port.
853 int fc_lport_config(struct fc_lport *);
856 * Reset the local port.
858 int fc_lport_reset(struct fc_lport *);
861 * Set the mfs or reset
863 int fc_set_mfs(struct fc_lport *lp, u32 mfs);
868 *****************************/
869 int fc_rport_init(struct fc_lport *lp);
870 void fc_rport_terminate_io(struct fc_rport *rp);
874 *****************************/
875 int fc_disc_init(struct fc_lport *lp);
880 *****************************/
882 * Initialize the SCSI block of libfc
884 int fc_fcp_init(struct fc_lport *);
887 * This section provides an API which allows direct interaction
888 * with the SCSI-ml. Each of these functions satisfies a function
889 * pointer defined in Scsi_Host and therefore is always called
890 * directly from the SCSI-ml.
892 int fc_queuecommand(struct scsi_cmnd *sc_cmd,
893 void (*done)(struct scsi_cmnd *));
896 * complete processing of a fcp packet
898 * This function may sleep if a fsp timer is pending.
899 * The host lock must not be held by caller.
901 void fc_fcp_complete(struct fc_fcp_pkt *fsp);
904 * Send an ABTS frame to the target device. The sc_cmd argument
905 * is a pointer to the SCSI command to be aborted.
907 int fc_eh_abort(struct scsi_cmnd *sc_cmd);
910 * Reset a LUN by sending send the tm cmd to the target.
912 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
915 * Reset the host adapter.
917 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
920 * Check rport status.
922 int fc_slave_alloc(struct scsi_device *sdev);
925 * Adjust the queue depth.
927 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth);
930 * Change the tag type.
932 int fc_change_queue_type(struct scsi_device *sdev, int tag_type);
935 * Free memory pools used by the FCP layer.
937 void fc_fcp_destroy(struct fc_lport *);
940 * Set up direct-data placement for this I/O request
942 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid);
946 *****************************/
948 * Initializes ELS/CT interface
950 int fc_elsct_init(struct fc_lport *lp);
954 * EXCHANGE MANAGER LAYER
955 *****************************/
957 * Initializes Exchange Manager related
958 * function pointers in struct libfc_function_template.
960 int fc_exch_init(struct fc_lport *lp);
963 * Adds Exchange Manager (EM) mp to lport.
965 * Adds specified mp to lport using struct fc_exch_mgr_anchor,
966 * the struct fc_exch_mgr_anchor allows same EM sharing by
967 * more than one lport with their specified match function,
968 * the match function is used in allocating exchange from
971 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport,
972 struct fc_exch_mgr *mp,
973 bool (*match)(struct fc_frame *));
976 * Deletes Exchange Manager (EM) from lport by removing
977 * its anchor ema from lport.
979 * If removed anchor ema was the last user of its associated EM
980 * then also destroys associated EM.
982 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema);
985 * Allocates an Exchange Manager (EM).
987 * The EM manages exchanges for their allocation and
988 * free, also allows exchange lookup for received
991 * The class is used for initializing FC class of
992 * allocated exchange from EM.
994 * The min_xid and max_xid will limit new
995 * exchange ID (XID) within this range for
997 * The LLD may choose to have multiple EMs,
998 * e.g. one EM instance per CPU receive thread in LLD.
999 * The LLD can use exch_get() of struct libfc_function_template
1000 * to specify XID for a new exchange within
1001 * a specified EM instance.
1003 * The em_idx to uniquely identify an EM instance.
1005 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp,
1006 enum fc_class class,
1011 * Free an exchange manager.
1013 void fc_exch_mgr_free(struct fc_exch_mgr *mp);
1016 * Receive a frame on specified local port and exchange manager.
1018 void fc_exch_recv(struct fc_lport *lp, struct fc_exch_mgr *mp,
1019 struct fc_frame *fp);
1022 * This function is for exch_seq_send function pointer in
1023 * struct libfc_function_template, see comment block on
1024 * exch_seq_send for description of this function.
1026 struct fc_seq *fc_exch_seq_send(struct fc_lport *lp,
1027 struct fc_frame *fp,
1028 void (*resp)(struct fc_seq *sp,
1029 struct fc_frame *fp,
1031 void (*destructor)(struct fc_seq *sp,
1033 void *arg, u32 timer_msec);
1036 * send a frame using existing sequence and exchange.
1038 int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp);
1041 * Send ELS response using mainly infomation
1042 * in exchange and sequence in EM layer.
1044 void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd,
1045 struct fc_seq_els_data *els_data);
1048 * This function is for seq_exch_abort function pointer in
1049 * struct libfc_function_template, see comment block on
1050 * seq_exch_abort for description of this function.
1052 int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec);
1055 * Indicate that an exchange/sequence tuple is complete and the memory
1056 * allocated for the related objects may be freed.
1058 void fc_exch_done(struct fc_seq *sp);
1061 * Assigns a EM and XID for a frame and then allocates
1062 * a new exchange and sequence pair.
1063 * The fp can be used to determine free XID.
1065 struct fc_exch *fc_exch_get(struct fc_lport *lp, struct fc_frame *fp);
1068 * Allocate a new exchange and sequence pair.
1069 * if ex_id is zero then next free exchange id
1070 * from specified exchange manger mp will be assigned.
1072 struct fc_exch *fc_exch_alloc(struct fc_exch_mgr *mp,
1073 struct fc_frame *fp, u16 ex_id);
1075 * Start a new sequence on the same exchange as the supplied sequence.
1077 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
1080 * Reset an exchange manager, completing all sequences and exchanges.
1081 * If s_id is non-zero, reset only exchanges originating from that FID.
1082 * If d_id is non-zero, reset only exchanges sending to that FID.
1084 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1087 * Functions for fc_functions_template
1089 void fc_get_host_speed(struct Scsi_Host *shost);
1090 void fc_get_host_port_type(struct Scsi_Host *shost);
1091 void fc_get_host_port_state(struct Scsi_Host *shost);
1092 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout);
1093 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1096 * module setup functions.
1098 int fc_setup_exch_mgr(void);
1099 void fc_destroy_exch_mgr(void);
1100 int fc_setup_rport(void);
1101 void fc_destroy_rport(void);
1103 #endif /* _LIBFC_H_ */