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>
29 #include <scsi/scsi_bsg_fc.h>
31 #include <scsi/fc/fc_fcp.h>
32 #include <scsi/fc/fc_ns.h>
33 #include <scsi/fc/fc_ms.h>
34 #include <scsi/fc/fc_els.h>
35 #include <scsi/fc/fc_gs.h>
37 #include <scsi/fc_frame.h>
39 #define FC_FC4_PROV_SIZE (FC_TYPE_FCP + 1) /* size of tables */
44 #define FC_NO_ERR 0 /* no error */
45 #define FC_EX_TIMEOUT 1 /* Exchange timeout */
46 #define FC_EX_CLOSED 2 /* Exchange closed */
47 #define FC_EX_ALLOC_ERR 3 /* Exchange allocation failed */
48 #define FC_EX_XMIT_ERR 4 /* Exchange transmit failed */
49 #define FC_EX_ELS_RJT 5 /* ELS rejected */
50 #define FC_EX_INV_LOGIN 6 /* Login not completed */
51 #define FC_EX_SEQ_ERR 6 /* Exchange sequence error */
54 * enum fc_lport_state - Local port states
55 * @LPORT_ST_DISABLED: Disabled
56 * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent
57 * @LPORT_ST_DNS: Waiting for name server remote port to become ready
58 * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent
59 * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent
60 * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent
61 * @LPORT_ST_FDMI: Waiting for mgmt server rport to become ready
63 * @LPORT_ST_SCR: State Change Register (SCR) sent
64 * @LPORT_ST_READY: Ready for use
65 * @LPORT_ST_LOGO: Local port logout (LOGO) sent
66 * @LPORT_ST_RESET: Local port reset
69 LPORT_ST_DISABLED = 0,
95 * enum fc_rport_state - Remote port states
96 * @RPORT_ST_INIT: Initialized
97 * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint
98 * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint
99 * @RPORT_ST_PLOGI: Waiting for PLOGI completion
100 * @RPORT_ST_PRLI: Waiting for PRLI completion
101 * @RPORT_ST_RTV: Waiting for RTV completion
102 * @RPORT_ST_READY: Ready for use
103 * @RPORT_ST_ADISC: Discover Address sent
104 * @RPORT_ST_DELETE: Remote port being deleted
106 enum fc_rport_state {
119 * struct fc_disc_port - temporary discovery port to hold rport identifiers
120 * @lp: Fibre Channel host port instance
121 * @peers: Node for list management during discovery and RSCN processing
122 * @rport_work: Work struct for starting the rport state machine
123 * @port_id: Port ID of the discovered port
125 struct fc_disc_port {
127 struct list_head peers;
128 struct work_struct rport_work;
133 * enum fc_rport_event - Remote port events
134 * @RPORT_EV_NONE: No event
135 * @RPORT_EV_READY: Remote port is ready for use
136 * @RPORT_EV_FAILED: State machine failed, remote port is not ready
137 * @RPORT_EV_STOP: Remote port has been stopped
138 * @RPORT_EV_LOGO: Remote port logout (LOGO) sent
140 enum fc_rport_event {
148 struct fc_rport_priv;
151 * struct fc_rport_operations - Operations for a remote port
152 * @event_callback: Function to be called for remote port events
154 struct fc_rport_operations {
155 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
156 enum fc_rport_event);
160 * struct fc_rport_libfc_priv - libfc internal information about a remote port
161 * @local_port: The associated local port
162 * @rp_state: Indicates READY for I/O or DELETE when blocked
163 * @flags: REC and RETRY supported flags
164 * @e_d_tov: Error detect timeout value (in msec)
165 * @r_a_tov: Resource allocation timeout value (in msec)
167 struct fc_rport_libfc_priv {
168 struct fc_lport *local_port;
169 enum fc_rport_state rp_state;
171 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
172 #define FC_RP_FLAGS_RETRY (1 << 1)
173 #define FC_RP_STARTED (1 << 2)
174 #define FC_RP_FLAGS_CONF_REQ (1 << 3)
175 unsigned int e_d_tov;
176 unsigned int r_a_tov;
180 * struct fc_rport_priv - libfc remote port and discovery info
181 * @local_port: The associated local port
182 * @rport: The FC transport remote port
183 * @kref: Reference counter
184 * @rp_state: Enumeration that tracks progress of PLOGI, PRLI,
186 * @ids: The remote port identifiers and roles
187 * @flags: STARTED, REC and RETRY_SUPPORTED flags
188 * @max_seq: Maximum number of concurrent sequences
189 * @disc_id: The discovery identifier
190 * @maxframe_size: The maximum frame size
191 * @retries: The retry count for the current state
192 * @major_retries: The retry count for the entire PLOGI/PRLI state machine
193 * @e_d_tov: Error detect timeout value (in msec)
194 * @r_a_tov: Resource allocation timeout value (in msec)
195 * @rp_mutex: The mutex that protects the remote port
196 * @retry_work: Handle for retries
197 * @event_callback: Callback when READY, FAILED or LOGO states complete
198 * @prli_count: Count of open PRLI sessions in providers
199 * @rcu: Structure used for freeing in an RCU-safe manner
201 struct fc_rport_priv {
202 struct fc_lport *local_port;
203 struct fc_rport *rport;
205 enum fc_rport_state rp_state;
206 struct fc_rport_identifiers ids;
211 unsigned int retries;
212 unsigned int major_retries;
213 unsigned int e_d_tov;
214 unsigned int r_a_tov;
215 struct mutex rp_mutex;
216 struct delayed_work retry_work;
217 enum fc_rport_event event;
218 struct fc_rport_operations *ops;
219 struct list_head peers;
220 struct work_struct event_work;
221 u32 supported_classes;
226 void (*lld_event_callback)(struct fc_lport *,
227 struct fc_rport_priv *,
228 enum fc_rport_event);
232 * struct fc_stats - fc stats structure
233 * @SecondsSinceLastReset: Seconds since the last reset
234 * @TxFrames: Number of transmitted frames
235 * @TxWords: Number of transmitted words
236 * @RxFrames: Number of received frames
237 * @RxWords: Number of received words
238 * @ErrorFrames: Number of received error frames
239 * @DumpedFrames: Number of dumped frames
240 * @FcpPktAllocFails: Number of fcp packet allocation failures
241 * @FcpPktAborts: Number of fcp packet aborts
242 * @FcpFrameAllocFails: Number of fcp frame allocation failures
243 * @LinkFailureCount: Number of link failures
244 * @LossOfSignalCount: Number for signal losses
245 * @InvalidTxWordCount: Number of invalid transmitted words
246 * @InvalidCRCCount: Number of invalid CRCs
247 * @InputRequests: Number of input requests
248 * @OutputRequests: Number of output requests
249 * @ControlRequests: Number of control requests
250 * @InputBytes: Number of received bytes
251 * @OutputBytes: Number of transmitted bytes
252 * @VLinkFailureCount: Number of virtual link failures
253 * @MissDiscAdvCount: Number of missing FIP discovery advertisement
256 u64 SecondsSinceLastReset;
263 u64 FcpPktAllocFails;
265 u64 FcpFrameAllocFails;
266 u64 LinkFailureCount;
267 u64 LossOfSignalCount;
268 u64 InvalidTxWordCount;
275 u64 VLinkFailureCount;
276 u64 MissDiscAdvCount;
280 * struct fc_seq_els_data - ELS data used for passing ELS specific responses
281 * @reason: The reason for rejection
282 * @explan: The explanation of the rejection
284 * Mainly used by the exchange manager layer.
286 struct fc_seq_els_data {
287 enum fc_els_rjt_reason reason;
288 enum fc_els_rjt_explan explan;
292 * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
293 * @lp: The associated local port
294 * @state: The state of the I/O
295 * @ref_cnt: Reference count
296 * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the
297 * host_lock if both are to be held at the same time)
298 * @cmd: The SCSI command (set and clear with the host_lock held)
299 * @list: Tracks queued commands (accessed with the host_lock held)
300 * @timer: The command timer
301 * @tm_done: Completion indicator
302 * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies)
303 * @data_len: The length of the data
304 * @cdb_cmd: The CDB command
305 * @xfer_len: The transfer length
306 * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange
307 * will be set here if DDP was setup)
308 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
310 * @max_payload: The maximum payload size (in bytes)
311 * @io_status: SCSI result (upper 24 bits)
312 * @cdb_status: CDB status
313 * @status_code: FCP I/O status
314 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
315 * @req_flags: Request flags (bit 0: read bit:1 write)
316 * @scsi_resid: SCSI residule length
317 * @rport: The remote port that the SCSI command is targeted at
318 * @seq_ptr: The sequence that will carry the SCSI command
319 * @recov_retry: Number of recovery retries
320 * @recov_seq: The sequence for REC or SRR
323 spinlock_t scsi_pkt_lock;
326 /* SCSI command and data transfer information */
329 /* SCSI I/O related information */
330 struct scsi_cmnd *cmd;
331 struct list_head list;
333 /* Housekeeping information */
337 /* SCSI/FCP return status */
345 /* Transport related veriables */
347 struct fcp_cmnd cdb_cmd;
352 /* Associated structures */
353 struct fc_rport *rport;
354 struct fc_seq *seq_ptr;
356 /* Timeout/error related information */
357 struct timer_list timer;
361 struct fc_seq *recov_seq;
362 struct completion tm_done;
363 } ____cacheline_aligned_in_smp;
366 * Structure and function definitions for managing Fibre Channel Exchanges
369 * fc_exch holds state for one exchange and links to its active sequence.
371 * fc_seq holds the state for an individual sequence.
375 struct fc_exch_mgr_anchor;
376 extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
379 * struct fc_seq - FC sequence
380 * @id: The sequence ID
381 * @ssb_stat: Status flags for the sequence status block (SSB)
382 * @cnt: Number of frames sent so far
383 * @rec_data: FC-4 value for REC
392 #define FC_EX_DONE (1 << 0) /* ep is completed */
393 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
394 #define FC_EX_QUARANTINE (1 << 2) /* exch is quarantined */
397 * struct fc_exch - Fibre Channel Exchange
398 * @em: Exchange manager
399 * @pool: Exchange pool
400 * @state: The exchange's state
401 * @xid: The exchange ID
402 * @ex_list: Handle used by the EM to track free exchanges
403 * @ex_lock: Lock that protects the exchange
404 * @ex_refcnt: Reference count
405 * @timeout_work: Handle for timeout handler
406 * @lp: The local port that this exchange is on
407 * @oxid: Originator's exchange ID
408 * @rxid: Responder's exchange ID
409 * @oid: Originator's FCID
411 * @did: Destination FCID
412 * @esb_stat: ESB exchange status
413 * @r_a_tov: Resouce allocation time out value (in msecs)
414 * @seq_id: The next sequence ID to use
415 * @encaps: encapsulation information for lower-level driver
416 * @f_ctl: F_CTL flags for the sequence
417 * @fh_type: The frame type
418 * @class: The class of service
419 * @seq: The sequence in use on this exchange
420 * @resp_active: Number of tasks that are concurrently executing @resp().
421 * @resp_task: If @resp_active > 0, either the task executing @resp(), the
422 * task that has been interrupted to execute the soft-IRQ
423 * executing @resp() or NULL if more than one task is executing
424 * @resp concurrently.
425 * @resp_wq: Waitqueue for the tasks waiting on @resp_active.
426 * @resp: Callback for responses on this exchange
427 * @destructor: Called when destroying the exchange
428 * @arg: Passed as a void pointer to the resp() callback
430 * Locking notes: The ex_lock protects following items:
431 * state, esb_stat, f_ctl, seq.ssb_stat
433 * sequence allocation
439 struct fc_exch_mgr *em;
440 struct fc_exch_pool *pool;
441 struct list_head ex_list;
458 struct task_struct *resp_task;
459 wait_queue_head_t resp_wq;
460 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
462 void (*destructor)(struct fc_seq *, void *);
463 struct delayed_work timeout_work;
464 } ____cacheline_aligned_in_smp;
465 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
468 struct libfc_function_template {
470 * Interface to send a FC frame
474 int (*frame_send)(struct fc_lport *, struct fc_frame *);
477 * Interface to send ELS/CT frames
481 struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
482 struct fc_frame *, unsigned int op,
483 void (*resp)(struct fc_seq *,
484 struct fc_frame *, void *arg),
485 void *arg, u32 timer_msec);
488 * Sets up the DDP context for a given exchange id on the given
489 * scatterlist if LLD supports DDP for large receive.
493 int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
496 * Completes the DDP transfer and returns the length of data DDPed
497 * for the given exchange id.
501 int (*ddp_done)(struct fc_lport *, u16);
503 * Sets up the DDP context for a given exchange id on the given
504 * scatterlist if LLD supports DDP for target.
508 int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *,
511 * Allow LLD to fill its own Link Error Status Block
515 void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
517 * Send a frame using an existing sequence and exchange.
521 int (*seq_send)(struct fc_lport *, struct fc_seq *,
525 * Abort an exchange and sequence. Generally called because of a
526 * exchange timeout or an abort from the upper layer.
528 * A timer_msec can be specified for abort timeout, if non-zero
529 * timer_msec value is specified then exchange resp handler
530 * will be called with timeout error if no response to abort.
534 int (*seq_exch_abort)(const struct fc_seq *,
535 unsigned int timer_msec);
538 * Indicate that an exchange/sequence tuple is complete and the memory
539 * allocated for the related objects may be freed.
543 void (*exch_done)(struct fc_seq *);
546 * Start a new sequence on the same exchange/sequence tuple.
550 struct fc_seq *(*seq_start_next)(struct fc_seq *);
553 * Set a response handler for the exchange of the sequence.
557 void (*seq_set_resp)(struct fc_seq *sp,
558 void (*resp)(struct fc_seq *, struct fc_frame *,
563 * Assign a sequence for an incoming request frame.
567 struct fc_seq *(*seq_assign)(struct fc_lport *, struct fc_frame *);
570 * Release the reference on the sequence returned by seq_assign().
574 void (*seq_release)(struct fc_seq *);
577 * Reset an exchange manager, completing all sequences and exchanges.
578 * If s_id is non-zero, reset only exchanges originating from that FID.
579 * If d_id is non-zero, reset only exchanges sending to that FID.
583 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
586 * Flush the rport work queue. Generally used before shutdown.
590 void (*rport_flush_queue)(void);
593 * Set the local port FC_ID.
595 * This may be provided by the LLD to allow it to be
596 * notified when the local port is assigned a FC-ID.
598 * The frame, if non-NULL, is the incoming frame with the
599 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
600 * address for the LLD. The frame pointer may be NULL if
601 * no MAC is associated with this assignment (LOGO or PLOGI).
603 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
605 * Note: this is called with the local port mutex held.
609 void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
613 * Logoff, and remove the rport from the transport if
614 * it had been added. This will send a LOGO to the target.
618 int (*rport_logoff)(struct fc_rport_priv *);
621 * Receive a request from a remote port.
625 void (*rport_recv_req)(struct fc_lport *, struct fc_frame *);
628 * Callback routine after the remote port is logged in
632 void (*rport_event_callback)(struct fc_lport *,
633 struct fc_rport_priv *,
634 enum fc_rport_event);
637 * Send a fcp cmd from fsp pkt.
638 * Called with the SCSI host lock unlocked and irqs disabled.
640 * The resp handler is called when FCP_RSP received.
644 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
645 void (*resp)(struct fc_seq *, struct fc_frame *,
649 * Cleanup the FCP layer, used during link down and reset
653 void (*fcp_cleanup)(struct fc_lport *);
656 * Abort all I/O on a local port
660 void (*fcp_abort_io)(struct fc_lport *);
663 * Receive a request for the discovery layer.
667 void (*disc_recv_req)(struct fc_lport *, struct fc_frame *);
670 * Start discovery for a local port.
674 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
679 * Stop discovery for a given lport. This will remove
680 * all discovered rports
684 void (*disc_stop) (struct fc_lport *);
687 * Stop discovery for a given lport. This will block
688 * until all discovered rports are deleted from the
693 void (*disc_stop_final) (struct fc_lport *);
697 * struct fc_disc - Discovery context
698 * @retry_count: Number of retries
699 * @pending: 1 if discovery is pending, 0 if not
700 * @requested: 1 if discovery has been requested, 0 if not
701 * @seq_count: Number of sequences used for discovery
702 * @buf_len: Length of the discovery buffer
703 * @disc_id: Discovery ID
704 * @rports: List of discovered remote ports
705 * @priv: Private pointer for use by discovery code
706 * @disc_mutex: Mutex that protects the discovery context
707 * @partial_buf: Partial name buffer (if names are returned
708 * in multiple frames)
709 * @disc_work: handle for delayed work context
710 * @disc_callback: Callback routine called when discovery completes
713 unsigned char retry_count;
714 unsigned char pending;
715 unsigned char requested;
716 unsigned short seq_count;
717 unsigned char buf_len;
720 struct list_head rports;
722 struct mutex disc_mutex;
723 struct fc_gpn_ft_resp partial_buf;
724 struct delayed_work disc_work;
726 void (*disc_callback)(struct fc_lport *,
731 * Local port notifier and events.
733 extern struct blocking_notifier_head fc_lport_notifier_head;
734 enum fc_lport_event {
740 * struct fc_lport - Local port
741 * @host: The SCSI host associated with a local port
742 * @ema_list: Exchange manager anchor list
743 * @dns_rdata: The directory server remote port
744 * @ms_rdata: The management server remote port
745 * @ptp_rdata: Point to point remote port
746 * @scsi_priv: FCP layer internal data
747 * @disc: Discovery context
748 * @vports: Child vports if N_Port
749 * @vport: Parent vport if VN_Port
750 * @tt: Libfc function template
751 * @link_up: Link state (1 = link up, 0 = link down)
752 * @qfull: Queue state (1 queue is full, 0 queue is not full)
753 * @state: Identifies the state
754 * @boot_time: Timestamp indicating when the local port came online
755 * @host_stats: SCSI host statistics
756 * @stats: FC local port stats (TODO separate libfc LLD stats)
757 * @retry_count: Number of retries in the current state
758 * @port_id: FC Port ID
759 * @wwpn: World Wide Port Name
760 * @wwnn: World Wide Node Name
761 * @service_params: Common service parameters
762 * @e_d_tov: Error detection timeout value
763 * @r_a_tov: Resouce allocation timeout value
764 * @rnid_gen: RNID information
765 * @sg_supp: Indicates if scatter gather is supported
766 * @seq_offload: Indicates if sequence offload is supported
767 * @crc_offload: Indicates if CRC offload is supported
768 * @lro_enabled: Indicates if large receive offload is supported
769 * @does_npiv: Supports multiple vports
770 * @npiv_enabled: Switch/fabric allows NPIV
771 * @mfs: The maximum Fibre Channel payload size
772 * @max_retry_count: The maximum retry attempts
773 * @max_rport_retry_count: The maximum remote port retry attempts
774 * @rport_priv_size: Size needed by driver after struct fc_rport_priv
775 * @lro_xid: The maximum XID for LRO
776 * @lso_max: The maximum large offload send size
777 * @fcts: FC-4 type mask
778 * @lp_mutex: Mutex to protect the local port
779 * @list: Linkage on list of vport peers
780 * @retry_work: Handle to local port for delayed retry context
781 * @prov: Pointers available for use by passive FC-4 providers
782 * @lport_list: Linkage on module-wide list of local ports
786 struct Scsi_Host *host;
787 struct list_head ema_list;
788 struct fc_rport_priv *dns_rdata;
789 struct fc_rport_priv *ms_rdata;
790 struct fc_rport_priv *ptp_rdata;
794 /* Virtual port information */
795 struct list_head vports;
796 struct fc_vport *vport;
798 /* Operational Information */
799 struct libfc_function_template tt;
803 enum fc_lport_state state;
804 unsigned long boot_time;
805 struct fc_host_statistics host_stats;
806 struct fc_stats __percpu *stats;
809 /* Fabric information */
813 unsigned int service_params;
814 unsigned int e_d_tov;
815 unsigned int r_a_tov;
816 struct fc_els_rnid_gen rnid_gen;
825 u32 point_to_multipoint:1;
829 u8 max_rport_retry_count;
832 u16 link_supported_speeds;
834 unsigned int lso_max;
835 struct fc_ns_fts fcts;
838 struct mutex lp_mutex;
839 struct list_head list;
840 struct delayed_work retry_work;
841 void *prov[FC_FC4_PROV_SIZE];
842 struct list_head lport_list;
846 * struct fc4_prov - FC-4 provider registration
847 * @prli: Handler for incoming PRLI
848 * @prlo: Handler for session reset
849 * @recv: Handler for incoming request
850 * @module: Pointer to module. May be NULL.
853 int (*prli)(struct fc_rport_priv *, u32 spp_len,
854 const struct fc_els_spp *spp_in,
855 struct fc_els_spp *spp_out);
856 void (*prlo)(struct fc_rport_priv *);
857 void (*recv)(struct fc_lport *, struct fc_frame *);
858 struct module *module;
862 * Register FC-4 provider with libfc.
864 int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *);
865 void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *);
868 * FC_LPORT HELPER FUNCTIONS
869 *****************************/
872 * fc_lport_test_ready() - Determine if a local port is in the READY state
873 * @lport: The local port to test
875 static inline int fc_lport_test_ready(struct fc_lport *lport)
877 return lport->state == LPORT_ST_READY;
881 * fc_set_wwnn() - Set the World Wide Node Name of a local port
882 * @lport: The local port whose WWNN is to be set
883 * @wwnn: The new WWNN
885 static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
891 * fc_set_wwpn() - Set the World Wide Port Name of a local port
892 * @lport: The local port whose WWPN is to be set
893 * @wwnn: The new WWPN
895 static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn)
901 * fc_lport_state_enter() - Change a local port's state
902 * @lport: The local port whose state is to change
903 * @state: The new state
905 static inline void fc_lport_state_enter(struct fc_lport *lport,
906 enum fc_lport_state state)
908 if (state != lport->state)
909 lport->retry_count = 0;
910 lport->state = state;
914 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
915 * @lport: The local port whose statistics are to be initialized
917 static inline int fc_lport_init_stats(struct fc_lport *lport)
919 lport->stats = alloc_percpu(struct fc_stats);
926 * fc_lport_free_stats() - Free memory for a local port's statistics
927 * @lport: The local port whose statistics are to be freed
929 static inline void fc_lport_free_stats(struct fc_lport *lport)
931 free_percpu(lport->stats);
935 * lport_priv() - Return the private data from a local port
936 * @lport: The local port whose private data is to be retreived
938 static inline void *lport_priv(const struct fc_lport *lport)
940 return (void *)(lport + 1);
944 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
946 * @sht: The SCSI host template
947 * @priv_size: Size of private data
949 * Returns: libfc lport
951 static inline struct fc_lport *
952 libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
954 struct fc_lport *lport;
955 struct Scsi_Host *shost;
957 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
960 lport = shost_priv(shost);
962 INIT_LIST_HEAD(&lport->ema_list);
963 INIT_LIST_HEAD(&lport->vports);
968 * FC_FCP HELPER FUNCTIONS
969 *****************************/
970 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
973 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
979 *****************************/
980 int fc_lport_init(struct fc_lport *);
981 int fc_lport_destroy(struct fc_lport *);
982 int fc_fabric_logoff(struct fc_lport *);
983 int fc_fabric_login(struct fc_lport *);
984 void __fc_linkup(struct fc_lport *);
985 void fc_linkup(struct fc_lport *);
986 void __fc_linkdown(struct fc_lport *);
987 void fc_linkdown(struct fc_lport *);
988 void fc_vport_setlink(struct fc_lport *);
989 void fc_vports_linkchange(struct fc_lport *);
990 int fc_lport_config(struct fc_lport *);
991 int fc_lport_reset(struct fc_lport *);
992 void fc_lport_recv(struct fc_lport *lport, struct fc_frame *fp);
993 int fc_set_mfs(struct fc_lport *, u32 mfs);
994 struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
995 struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
996 int fc_lport_bsg_request(struct fc_bsg_job *);
997 void fc_lport_set_local_id(struct fc_lport *, u32 port_id);
998 void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *);
1002 *****************************/
1003 int fc_rport_init(struct fc_lport *);
1004 void fc_rport_terminate_io(struct fc_rport *);
1005 struct fc_rport_priv *fc_rport_lookup(const struct fc_lport *lport,
1007 struct fc_rport_priv *fc_rport_create(struct fc_lport *, u32);
1008 void fc_rport_destroy(struct kref *kref);
1009 int fc_rport_login(struct fc_rport_priv *rdata);
1013 *****************************/
1014 void fc_disc_init(struct fc_lport *);
1015 void fc_disc_config(struct fc_lport *, void *);
1017 static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
1019 return container_of(disc, struct fc_lport, disc);
1024 *****************************/
1025 int fc_fcp_init(struct fc_lport *);
1026 void fc_fcp_destroy(struct fc_lport *);
1029 * SCSI INTERACTION LAYER
1030 *****************************/
1031 int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
1032 int fc_eh_abort(struct scsi_cmnd *);
1033 int fc_eh_device_reset(struct scsi_cmnd *);
1034 int fc_eh_host_reset(struct scsi_cmnd *);
1035 int fc_slave_alloc(struct scsi_device *);
1039 *****************************/
1040 int fc_elsct_init(struct fc_lport *);
1041 struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
1044 void (*resp)(struct fc_seq *,
1047 void *arg, u32 timer_msec);
1048 void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
1049 void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
1050 void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *,
1051 enum fc_rctl, u32 parm_offset);
1052 void fc_fill_hdr(struct fc_frame *, const struct fc_frame *,
1053 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset);
1057 * EXCHANGE MANAGER LAYER
1058 *****************************/
1059 int fc_exch_init(struct fc_lport *);
1060 void fc_exch_update_stats(struct fc_lport *lport);
1061 struct fc_seq *fc_exch_seq_send(struct fc_lport *lport,
1062 struct fc_frame *fp,
1063 void (*resp)(struct fc_seq *,
1064 struct fc_frame *fp,
1066 void (*destructor)(struct fc_seq *, void *),
1067 void *arg, u32 timer_msec);
1068 void fc_seq_els_rsp_send(struct fc_frame *, enum fc_els_cmd,
1069 struct fc_seq_els_data *);
1070 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
1071 struct fc_exch_mgr *,
1072 bool (*match)(struct fc_frame *));
1073 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
1074 int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
1075 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
1076 u16 min_xid, u16 max_xid,
1077 bool (*match)(struct fc_frame *));
1078 void fc_exch_mgr_free(struct fc_lport *);
1079 void fc_exch_recv(struct fc_lport *, struct fc_frame *);
1080 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1083 * Functions for fc_functions_template
1085 void fc_get_host_speed(struct Scsi_Host *);
1086 void fc_get_host_port_state(struct Scsi_Host *);
1087 void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
1088 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1090 #endif /* _LIBFC_H_ */