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>
26 #include <scsi/scsi_transport.h>
27 #include <scsi/scsi_transport_fc.h>
29 #include <scsi/fc/fc_fcp.h>
30 #include <scsi/fc/fc_ns.h>
31 #include <scsi/fc/fc_els.h>
32 #include <scsi/fc/fc_gs.h>
34 #include <scsi/fc_frame.h>
40 #define FC_DBG(fmt, args...) \
42 printk(KERN_INFO "%s " fmt, __func__, ##args); \
45 #define FC_DBG(fmt, args...)
51 #define FC_NO_ERR 0 /* no error */
52 #define FC_EX_TIMEOUT 1 /* Exchange timeout */
53 #define FC_EX_CLOSED 2 /* Exchange closed */
55 /* some helpful macros */
57 #define ntohll(x) be64_to_cpu(x)
58 #define htonll(x) cpu_to_be64(x)
60 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
62 #define hton24(p, v) do { \
63 p[0] = (((v) >> 16) & 0xFF); \
64 p[1] = (((v) >> 8) & 0xFF); \
65 p[2] = ((v) & 0xFF); \
91 RPORT_ST_INIT, /* initialized */
92 RPORT_ST_PLOGI, /* waiting for PLOGI completion */
93 RPORT_ST_PRLI, /* waiting for PRLI completion */
94 RPORT_ST_RTV, /* waiting for RTV completion */
95 RPORT_ST_READY, /* ready for use */
96 RPORT_ST_LOGO, /* port logout sent */
99 enum fc_rport_trans_state {
105 * struct fc_disc_port - temporary discovery port to hold rport identifiers
106 * @lp: Fibre Channel host port instance
107 * @peers: node for list management during discovery and RSCN processing
108 * @ids: identifiers structure to pass to fc_remote_port_add()
109 * @rport_work: work struct for starting the rport state machine
111 struct fc_disc_port {
113 struct list_head peers;
114 struct fc_rport_identifiers ids;
115 struct work_struct rport_work;
118 enum fc_rport_event {
126 struct fc_rport_operations {
127 void (*event_callback)(struct fc_lport *, struct fc_rport *,
128 enum fc_rport_event);
132 * struct fc_rport_libfc_priv - libfc internal information about a remote port
133 * @local_port: Fibre Channel host port instance
134 * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges
135 * @flags: REC and RETRY supported flags
136 * @max_seq: maximum number of concurrent sequences
137 * @retries: retry count in current state
138 * @e_d_tov: error detect timeout value (in msec)
139 * @r_a_tov: resource allocation timeout value (in msec)
140 * @rp_mutex: mutex protects rport
142 * @event_callback: Callback for rport READY, FAILED or LOGO
144 struct fc_rport_libfc_priv {
145 struct fc_lport *local_port;
146 enum fc_rport_state rp_state;
148 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
149 #define FC_RP_FLAGS_RETRY (1 << 1)
151 unsigned int retries;
152 unsigned int e_d_tov;
153 unsigned int r_a_tov;
154 enum fc_rport_trans_state trans_state;
155 struct mutex rp_mutex;
156 struct delayed_work retry_work;
157 enum fc_rport_event event;
158 struct fc_rport_operations *ops;
159 struct list_head peers;
160 struct work_struct event_work;
163 #define PRIV_TO_RPORT(x) \
164 (struct fc_rport *)((void *)x - sizeof(struct fc_rport));
165 #define RPORT_TO_PRIV(x) \
166 (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport));
168 struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *);
170 static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn)
172 rport->node_name = wwnn;
173 rport->port_name = wwpn;
177 * fcoe stats structure
179 struct fcoe_dev_stats {
180 u64 SecondsSinceLastReset;
187 u64 LinkFailureCount;
188 u64 LossOfSignalCount;
189 u64 InvalidTxWordCount;
199 * els data is used for passing ELS respone specific
200 * data to send ELS response mainly using infomation
201 * in exchange and sequence in EM layer.
203 struct fc_seq_els_data {
205 enum fc_els_rjt_reason reason;
206 enum fc_els_rjt_explan explan;
210 * FCP request structure, one for each scsi cmd request
216 struct fc_lport *lp; /* handle to hba struct */
217 u16 state; /* scsi_pkt state state */
218 u16 tgt_flags; /* target flags */
219 atomic_t ref_cnt; /* fcp pkt ref count */
220 spinlock_t scsi_pkt_lock; /* Must be taken before the host lock
221 * if both are held at the same time */
223 * SCSI I/O related stuff
225 struct scsi_cmnd *cmd; /* scsi command pointer. set/clear
227 struct list_head list; /* tracks queued commands. access under
230 * timeout related stuff
232 struct timer_list timer; /* command timer */
233 struct completion tm_done;
235 unsigned long start_time; /* start jiffie */
236 unsigned long end_time; /* end jiffie */
237 unsigned long last_pkt_time; /* jiffies of last frame received */
240 * scsi cmd and data transfer information
244 * transport related veriables
246 struct fcp_cmnd cdb_cmd;
248 u32 xfer_contig_end; /* offset of end of contiguous xfer */
249 u16 max_payload; /* max payload size in bytes */
252 * scsi/fcp return status
254 u32 io_status; /* SCSI result upper 24 bits */
256 u8 status_code; /* FCP I/O status */
257 /* bit 3 Underrun bit 2: overrun */
259 u32 req_flags; /* bit 0: read bit:1 write */
260 u32 scsi_resid; /* residule length */
262 struct fc_rport *rport; /* remote port pointer */
263 struct fc_seq *seq_ptr; /* current sequence pointer */
267 u8 recov_retry; /* count of recovery retries */
268 struct fc_seq *recov_seq; /* sequence for REC or SRR */
272 * Structure and function definitions for managing Fibre Channel Exchanges
275 * fc_exch holds state for one exchange and links to its active sequence.
277 * fc_seq holds the state for an individual sequence.
287 u16 ssb_stat; /* status flags for sequence status block */
288 u16 cnt; /* frames sent so far on sequence */
289 u32 rec_data; /* FC-4 value for REC */
292 #define FC_EX_DONE (1 << 0) /* ep is completed */
293 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
298 * Locking notes: The ex_lock protects following items:
299 * state, esb_stat, f_ctl, seq.ssb_stat
301 * sequence allocation
304 struct fc_exch_mgr *em; /* exchange manager */
305 u32 state; /* internal driver state */
306 u16 xid; /* our exchange ID */
307 struct list_head ex_list; /* free or busy list linkage */
308 spinlock_t ex_lock; /* lock covering exchange state */
309 atomic_t ex_refcnt; /* reference counter */
310 struct delayed_work timeout_work; /* timer for upper level protocols */
311 struct fc_lport *lp; /* fc device instance */
312 u16 oxid; /* originator's exchange ID */
313 u16 rxid; /* responder's exchange ID */
314 u32 oid; /* originator's FCID */
315 u32 sid; /* source FCID */
316 u32 did; /* destination FCID */
317 u32 esb_stat; /* exchange status for ESB */
318 u32 r_a_tov; /* r_a_tov from rport (msec) */
319 u8 seq_id; /* next sequence ID to use */
320 u32 f_ctl; /* F_CTL flags for sequences */
321 u8 fh_type; /* frame type */
322 enum fc_class class; /* class of service */
323 struct fc_seq seq; /* single sequence */
325 * Handler for responses to this current exchange.
327 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
328 void (*destructor)(struct fc_seq *, void *);
330 * arg is passed as void pointer to exchange
331 * resp and destructor handlers
335 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
337 struct libfc_function_template {
340 * Interface to send a FC frame
344 int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp);
347 * Interface to send ELS/CT frames
351 struct fc_seq *(*elsct_send)(struct fc_lport *lport,
352 struct fc_rport *rport,
355 void (*resp)(struct fc_seq *,
358 void *arg, u32 timer_msec);
361 * Send the FC frame payload using a new exchange and sequence.
363 * The frame pointer with some of the header's fields must be
364 * filled before calling exch_seq_send(), those fields are,
371 * - parameter or relative offset
373 * The exchange response handler is set in this routine to resp()
374 * function pointer. It can be called in two scenarios: if a timeout
375 * occurs or if a response frame is received for the exchange. The
376 * fc_frame pointer in response handler will also indicate timeout
377 * as error using IS_ERR related macros.
379 * The exchange destructor handler is also set in this routine.
380 * The destructor handler is invoked by EM layer when exchange
381 * is about to free, this can be used by caller to free its
382 * resources along with exchange free.
384 * The arg is passed back to resp and destructor handler.
386 * The timeout value (in msec) for an exchange is set if non zero
387 * timer_msec argument is specified. The timer is canceled when
388 * it fires or when the exchange is done. The exchange timeout handler
389 * is registered by EM layer.
393 struct fc_seq *(*exch_seq_send)(struct fc_lport *lp,
395 void (*resp)(struct fc_seq *sp,
398 void (*destructor)(struct fc_seq *sp,
400 void *arg, unsigned int timer_msec);
403 * Send a frame using an existing sequence and exchange.
407 int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp,
408 struct fc_frame *fp);
411 * Send an ELS response using infomation from a previous
412 * exchange and sequence.
416 void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd,
417 struct fc_seq_els_data *els_data);
420 * Abort an exchange and sequence. Generally called because of a
421 * exchange timeout or an abort from the upper layer.
423 * A timer_msec can be specified for abort timeout, if non-zero
424 * timer_msec value is specified then exchange resp handler
425 * will be called with timeout error if no response to abort.
429 int (*seq_exch_abort)(const struct fc_seq *req_sp,
430 unsigned int timer_msec);
433 * Indicate that an exchange/sequence tuple is complete and the memory
434 * allocated for the related objects may be freed.
438 void (*exch_done)(struct fc_seq *sp);
441 * Assigns a EM and a free XID for an new exchange and then
442 * allocates a new exchange and sequence pair.
443 * The fp can be used to determine free XID.
447 struct fc_exch *(*exch_get)(struct fc_lport *lp, struct fc_frame *fp);
450 * Release previously assigned XID by exch_get API.
451 * The LLD may implement this if XID is assigned by LLD
456 void (*exch_put)(struct fc_lport *lp, struct fc_exch_mgr *mp,
460 * Start a new sequence on the same exchange/sequence tuple.
464 struct fc_seq *(*seq_start_next)(struct fc_seq *sp);
467 * Reset an exchange manager, completing all sequences and exchanges.
468 * If s_id is non-zero, reset only exchanges originating from that FID.
469 * If d_id is non-zero, reset only exchanges sending to that FID.
473 void (*exch_mgr_reset)(struct fc_lport *,
477 * Flush the rport work queue. Generally used before shutdown.
481 void (*rport_flush_queue)(void);
484 * Receive a frame for a local port.
488 void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp,
489 struct fc_frame *fp);
492 * Reset the local port.
496 int (*lport_reset)(struct fc_lport *);
499 * Create a remote port
501 struct fc_rport *(*rport_create)(struct fc_disc_port *);
504 * Initiates the RP state machine. It is called from the LP module.
505 * This function will issue the following commands to the N_Port
506 * identified by the FC ID provided.
514 int (*rport_login)(struct fc_rport *rport);
517 * Logoff, and remove the rport from the transport if
518 * it had been added. This will send a LOGO to the target.
522 int (*rport_logoff)(struct fc_rport *rport);
525 * Recieve a request from a remote port.
529 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
533 * lookup an rport by it's port ID.
537 struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32);
540 * Send a fcp cmd from fsp pkt.
541 * Called with the SCSI host lock unlocked and irqs disabled.
543 * The resp handler is called when FCP_RSP received.
547 int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp,
548 void (*resp)(struct fc_seq *, struct fc_frame *fp,
552 * Cleanup the FCP layer, used durring link down and reset
556 void (*fcp_cleanup)(struct fc_lport *lp);
559 * Abort all I/O on a local port
563 void (*fcp_abort_io)(struct fc_lport *lp);
566 * Receive a request for the discovery layer.
570 void (*disc_recv_req)(struct fc_seq *,
571 struct fc_frame *, struct fc_lport *);
574 * Start discovery for a local port.
578 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
583 * Stop discovery for a given lport. This will remove
584 * all discovered rports
588 void (*disc_stop) (struct fc_lport *);
591 * Stop discovery for a given lport. This will block
592 * until all discovered rports are deleted from the
597 void (*disc_stop_final) (struct fc_lport *);
600 /* information used by the discovery layer */
602 unsigned char retry_count;
604 unsigned char pending;
605 unsigned char requested;
606 unsigned short seq_count;
607 unsigned char buf_len;
608 enum fc_disc_event event;
610 void (*disc_callback)(struct fc_lport *,
613 struct list_head rports;
614 struct fc_lport *lport;
615 struct mutex disc_mutex;
616 struct fc_gpn_ft_resp partial_buf; /* partial name buffer */
617 struct delayed_work disc_work;
621 struct list_head list;
624 struct Scsi_Host *host;
625 struct fc_exch_mgr *emp;
626 struct fc_rport *dns_rp;
627 struct fc_rport *ptp_rp;
631 /* Operational Information */
632 struct libfc_function_template tt;
635 enum fc_lport_state state;
636 unsigned long boot_time;
638 struct fc_host_statistics host_stats;
639 struct fcoe_dev_stats *dev_stats[NR_CPUS];
645 u32 sg_supp:1; /* scatter gather supported */
646 u32 seq_offload:1; /* seq offload supported */
647 u32 crc_offload:1; /* crc offload supported */
648 u32 lro_enabled:1; /* large receive offload */
649 u32 mfs; /* max FC payload size */
650 unsigned int service_params;
651 unsigned int e_d_tov;
652 unsigned int r_a_tov;
655 u16 link_supported_speeds;
656 u16 lro_xid; /* max xid for fcoe lro */
657 unsigned int lso_max; /* max large send size */
658 struct fc_ns_fts fcts; /* FC-4 type masks */
659 struct fc_els_rnid_gen rnid_gen; /* RNID information */
662 struct mutex lp_mutex;
665 struct delayed_work retry_work;
666 struct delayed_work disc_work;
670 * FC_LPORT HELPER FUNCTIONS
671 *****************************/
672 static inline void *lport_priv(const struct fc_lport *lp)
674 return (void *)(lp + 1);
677 static inline int fc_lport_test_ready(struct fc_lport *lp)
679 return lp->state == LPORT_ST_READY;
682 static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn)
687 static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn)
692 static inline void fc_lport_state_enter(struct fc_lport *lp,
693 enum fc_lport_state state)
695 if (state != lp->state)
703 *****************************/
704 int fc_lport_init(struct fc_lport *lp);
707 * Destroy the specified local port by finding and freeing all
708 * fc_rports associated with it and then by freeing the fc_lport
711 int fc_lport_destroy(struct fc_lport *lp);
714 * Logout the specified local port from the fabric
716 int fc_fabric_logoff(struct fc_lport *lp);
719 * Initiate the LP state machine. This handler will use fc_host_attr
720 * to store the FLOGI service parameters, so fc_host_attr must be
721 * initialized before calling this handler.
723 int fc_fabric_login(struct fc_lport *lp);
726 * The link is up for the given local port.
728 void fc_linkup(struct fc_lport *);
731 * Link is down for the given local port.
733 void fc_linkdown(struct fc_lport *);
736 * Configure the local port.
738 int fc_lport_config(struct fc_lport *);
741 * Reset the local port.
743 int fc_lport_reset(struct fc_lport *);
746 * Set the mfs or reset
748 int fc_set_mfs(struct fc_lport *lp, u32 mfs);
753 *****************************/
754 int fc_rport_init(struct fc_lport *lp);
755 void fc_rport_terminate_io(struct fc_rport *rp);
759 *****************************/
760 int fc_disc_init(struct fc_lport *lp);
765 *****************************/
767 * Initialize the SCSI block of libfc
769 int fc_fcp_init(struct fc_lport *);
772 * This section provides an API which allows direct interaction
773 * with the SCSI-ml. Each of these functions satisfies a function
774 * pointer defined in Scsi_Host and therefore is always called
775 * directly from the SCSI-ml.
777 int fc_queuecommand(struct scsi_cmnd *sc_cmd,
778 void (*done)(struct scsi_cmnd *));
781 * complete processing of a fcp packet
783 * This function may sleep if a fsp timer is pending.
784 * The host lock must not be held by caller.
786 void fc_fcp_complete(struct fc_fcp_pkt *fsp);
789 * Send an ABTS frame to the target device. The sc_cmd argument
790 * is a pointer to the SCSI command to be aborted.
792 int fc_eh_abort(struct scsi_cmnd *sc_cmd);
795 * Reset a LUN by sending send the tm cmd to the target.
797 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
800 * Reset the host adapter.
802 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
805 * Check rport status.
807 int fc_slave_alloc(struct scsi_device *sdev);
810 * Adjust the queue depth.
812 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth);
815 * Change the tag type.
817 int fc_change_queue_type(struct scsi_device *sdev, int tag_type);
820 * Free memory pools used by the FCP layer.
822 void fc_fcp_destroy(struct fc_lport *);
826 *****************************/
828 * Initializes ELS/CT interface
830 int fc_elsct_init(struct fc_lport *lp);
834 * EXCHANGE MANAGER LAYER
835 *****************************/
837 * Initializes Exchange Manager related
838 * function pointers in struct libfc_function_template.
840 int fc_exch_init(struct fc_lport *lp);
843 * Allocates an Exchange Manager (EM).
845 * The EM manages exchanges for their allocation and
846 * free, also allows exchange lookup for received
849 * The class is used for initializing FC class of
850 * allocated exchange from EM.
852 * The min_xid and max_xid will limit new
853 * exchange ID (XID) within this range for
855 * The LLD may choose to have multiple EMs,
856 * e.g. one EM instance per CPU receive thread in LLD.
857 * The LLD can use exch_get() of struct libfc_function_template
858 * to specify XID for a new exchange within
859 * a specified EM instance.
861 * The em_idx to uniquely identify an EM instance.
863 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp,
869 * Free an exchange manager.
871 void fc_exch_mgr_free(struct fc_exch_mgr *mp);
874 * Receive a frame on specified local port and exchange manager.
876 void fc_exch_recv(struct fc_lport *lp, struct fc_exch_mgr *mp,
877 struct fc_frame *fp);
880 * This function is for exch_seq_send function pointer in
881 * struct libfc_function_template, see comment block on
882 * exch_seq_send for description of this function.
884 struct fc_seq *fc_exch_seq_send(struct fc_lport *lp,
886 void (*resp)(struct fc_seq *sp,
889 void (*destructor)(struct fc_seq *sp,
891 void *arg, u32 timer_msec);
894 * send a frame using existing sequence and exchange.
896 int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp);
899 * Send ELS response using mainly infomation
900 * in exchange and sequence in EM layer.
902 void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd,
903 struct fc_seq_els_data *els_data);
906 * This function is for seq_exch_abort function pointer in
907 * struct libfc_function_template, see comment block on
908 * seq_exch_abort for description of this function.
910 int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec);
913 * Indicate that an exchange/sequence tuple is complete and the memory
914 * allocated for the related objects may be freed.
916 void fc_exch_done(struct fc_seq *sp);
919 * Assigns a EM and XID for a frame and then allocates
920 * a new exchange and sequence pair.
921 * The fp can be used to determine free XID.
923 struct fc_exch *fc_exch_get(struct fc_lport *lp, struct fc_frame *fp);
926 * Allocate a new exchange and sequence pair.
927 * if ex_id is zero then next free exchange id
928 * from specified exchange manger mp will be assigned.
930 struct fc_exch *fc_exch_alloc(struct fc_exch_mgr *mp,
931 struct fc_frame *fp, u16 ex_id);
933 * Start a new sequence on the same exchange as the supplied sequence.
935 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
938 * Reset an exchange manager, completing all sequences and exchanges.
939 * If s_id is non-zero, reset only exchanges originating from that FID.
940 * If d_id is non-zero, reset only exchanges sending to that FID.
942 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
945 * Functions for fc_functions_template
947 void fc_get_host_speed(struct Scsi_Host *shost);
948 void fc_get_host_port_type(struct Scsi_Host *shost);
949 void fc_get_host_port_state(struct Scsi_Host *shost);
950 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout);
951 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
954 * module setup functions.
956 int fc_setup_exch_mgr(void);
957 void fc_destroy_exch_mgr(void);
958 int fc_setup_rport(void);
959 void fc_destroy_rport(void);
961 #endif /* _LIBFC_H_ */