1a61127c2SThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
242e9a92fSRobert Love /*
342e9a92fSRobert Love * Copyright(c) 2007 Intel Corporation. All rights reserved.
442e9a92fSRobert Love *
542e9a92fSRobert Love * Maintained at www.Open-FCoE.org
642e9a92fSRobert Love */
742e9a92fSRobert Love
842e9a92fSRobert Love #ifndef _LIBFC_H_
942e9a92fSRobert Love #define _LIBFC_H_
1042e9a92fSRobert Love
1142e9a92fSRobert Love #include <linux/timer.h>
1242e9a92fSRobert Love #include <linux/if.h>
13582b45bcSRobert Love #include <linux/percpu.h>
1422c70d1aSElena Reshetova #include <linux/refcount.h>
1542e9a92fSRobert Love
1642e9a92fSRobert Love #include <scsi/scsi_transport.h>
1742e9a92fSRobert Love #include <scsi/scsi_transport_fc.h>
18a51ab396SSteve Ma #include <scsi/scsi_bsg_fc.h>
1942e9a92fSRobert Love
2042e9a92fSRobert Love #include <scsi/fc/fc_fcp.h>
2142e9a92fSRobert Love #include <scsi/fc/fc_ns.h>
22d78c317fSNeerav Parikh #include <scsi/fc/fc_ms.h>
2342e9a92fSRobert Love #include <scsi/fc/fc_els.h>
2442e9a92fSRobert Love #include <scsi/fc/fc_gs.h>
2542e9a92fSRobert Love
2642e9a92fSRobert Love #include <scsi/fc_frame.h>
2742e9a92fSRobert Love
2896ad8464SJoe Eykholt #define FC_FC4_PROV_SIZE (FC_TYPE_FCP + 1) /* size of tables */
2996ad8464SJoe Eykholt
3042e9a92fSRobert Love /*
3142e9a92fSRobert Love * libfc error codes
3242e9a92fSRobert Love */
3342e9a92fSRobert Love #define FC_NO_ERR 0 /* no error */
3442e9a92fSRobert Love #define FC_EX_TIMEOUT 1 /* Exchange timeout */
3542e9a92fSRobert Love #define FC_EX_CLOSED 2 /* Exchange closed */
369f9504a7SHannes Reinecke #define FC_EX_ALLOC_ERR 3 /* Exchange allocation failed */
379f9504a7SHannes Reinecke #define FC_EX_XMIT_ERR 4 /* Exchange transmit failed */
389f9504a7SHannes Reinecke #define FC_EX_ELS_RJT 5 /* ELS rejected */
399f9504a7SHannes Reinecke #define FC_EX_INV_LOGIN 6 /* Login not completed */
409f9504a7SHannes Reinecke #define FC_EX_SEQ_ERR 6 /* Exchange sequence error */
4142e9a92fSRobert Love
423a3b42bfSRobert Love /**
433a3b42bfSRobert Love * enum fc_lport_state - Local port states
443a3b42bfSRobert Love * @LPORT_ST_DISABLED: Disabled
453a3b42bfSRobert Love * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent
463a3b42bfSRobert Love * @LPORT_ST_DNS: Waiting for name server remote port to become ready
473a3b42bfSRobert Love * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent
483a3b42bfSRobert Love * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent
49ab593b18SJoe Eykholt * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent
50d78c317fSNeerav Parikh * @LPORT_ST_FDMI: Waiting for mgmt server rport to become ready
51d78c317fSNeerav Parikh * @LPORT_ST_RHBA:
523a3b42bfSRobert Love * @LPORT_ST_SCR: State Change Register (SCR) sent
533a3b42bfSRobert Love * @LPORT_ST_READY: Ready for use
543a3b42bfSRobert Love * @LPORT_ST_LOGO: Local port logout (LOGO) sent
553a3b42bfSRobert Love * @LPORT_ST_RESET: Local port reset
5642e9a92fSRobert Love */
5742e9a92fSRobert Love enum fc_lport_state {
58b1d9fd55SJoe Eykholt LPORT_ST_DISABLED = 0,
5942e9a92fSRobert Love LPORT_ST_FLOGI,
6042e9a92fSRobert Love LPORT_ST_DNS,
61c9c7bd7aSChris Leech LPORT_ST_RNN_ID,
625baa17c3SChris Leech LPORT_ST_RSNN_NN,
63c9866a54SChris Leech LPORT_ST_RSPN_ID,
6442e9a92fSRobert Love LPORT_ST_RFT_ID,
65ab593b18SJoe Eykholt LPORT_ST_RFF_ID,
66d78c317fSNeerav Parikh LPORT_ST_FDMI,
67d78c317fSNeerav Parikh LPORT_ST_RHBA,
68d78c317fSNeerav Parikh LPORT_ST_RPA,
69d78c317fSNeerav Parikh LPORT_ST_DHBA,
70d78c317fSNeerav Parikh LPORT_ST_DPRT,
7142e9a92fSRobert Love LPORT_ST_SCR,
7242e9a92fSRobert Love LPORT_ST_READY,
7342e9a92fSRobert Love LPORT_ST_LOGO,
7442e9a92fSRobert Love LPORT_ST_RESET
7542e9a92fSRobert Love };
7642e9a92fSRobert Love
7742e9a92fSRobert Love enum fc_disc_event {
7842e9a92fSRobert Love DISC_EV_NONE = 0,
7942e9a92fSRobert Love DISC_EV_SUCCESS,
8042e9a92fSRobert Love DISC_EV_FAILED
8142e9a92fSRobert Love };
8242e9a92fSRobert Love
833a3b42bfSRobert Love /**
843a3b42bfSRobert Love * enum fc_rport_state - Remote port states
853a3b42bfSRobert Love * @RPORT_ST_INIT: Initialized
86a7b12a27SJoe Eykholt * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint
87a7b12a27SJoe Eykholt * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint
883a3b42bfSRobert Love * @RPORT_ST_PLOGI: Waiting for PLOGI completion
893a3b42bfSRobert Love * @RPORT_ST_PRLI: Waiting for PRLI completion
903a3b42bfSRobert Love * @RPORT_ST_RTV: Waiting for RTV completion
913a3b42bfSRobert Love * @RPORT_ST_READY: Ready for use
923a3b42bfSRobert Love * @RPORT_ST_ADISC: Discover Address sent
933a3b42bfSRobert Love * @RPORT_ST_DELETE: Remote port being deleted
943a3b42bfSRobert Love */
9542e9a92fSRobert Love enum fc_rport_state {
963a3b42bfSRobert Love RPORT_ST_INIT,
97a7b12a27SJoe Eykholt RPORT_ST_FLOGI,
98a7b12a27SJoe Eykholt RPORT_ST_PLOGI_WAIT,
993a3b42bfSRobert Love RPORT_ST_PLOGI,
1003a3b42bfSRobert Love RPORT_ST_PRLI,
1013a3b42bfSRobert Love RPORT_ST_RTV,
1023a3b42bfSRobert Love RPORT_ST_READY,
1033a3b42bfSRobert Love RPORT_ST_ADISC,
1043a3b42bfSRobert Love RPORT_ST_DELETE,
10542e9a92fSRobert Love };
10642e9a92fSRobert Love
10742e9a92fSRobert Love /**
10842e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers
10942e9a92fSRobert Love * @lp: Fibre Channel host port instance
1109737e6a7SRobert Love * @peers: Node for list management during discovery and RSCN processing
1119737e6a7SRobert Love * @rport_work: Work struct for starting the rport state machine
1129737e6a7SRobert Love * @port_id: Port ID of the discovered port
11342e9a92fSRobert Love */
11442e9a92fSRobert Love struct fc_disc_port {
11542e9a92fSRobert Love struct fc_lport *lp;
11642e9a92fSRobert Love struct list_head peers;
11742e9a92fSRobert Love struct work_struct rport_work;
1189737e6a7SRobert Love u32 port_id;
11942e9a92fSRobert Love };
12042e9a92fSRobert Love
1213a3b42bfSRobert Love /**
1223a3b42bfSRobert Love * enum fc_rport_event - Remote port events
1233a3b42bfSRobert Love * @RPORT_EV_NONE: No event
1243a3b42bfSRobert Love * @RPORT_EV_READY: Remote port is ready for use
1253a3b42bfSRobert Love * @RPORT_EV_FAILED: State machine failed, remote port is not ready
1263a3b42bfSRobert Love * @RPORT_EV_STOP: Remote port has been stopped
1273a3b42bfSRobert Love * @RPORT_EV_LOGO: Remote port logout (LOGO) sent
1283a3b42bfSRobert Love */
12942e9a92fSRobert Love enum fc_rport_event {
13042e9a92fSRobert Love RPORT_EV_NONE = 0,
1314c0f62b5SJoe Eykholt RPORT_EV_READY,
13242e9a92fSRobert Love RPORT_EV_FAILED,
13342e9a92fSRobert Love RPORT_EV_STOP,
13442e9a92fSRobert Love RPORT_EV_LOGO
13542e9a92fSRobert Love };
13642e9a92fSRobert Love
1379fb9d328SJoe Eykholt struct fc_rport_priv;
1389fb9d328SJoe Eykholt
1393a3b42bfSRobert Love /**
1403a3b42bfSRobert Love * struct fc_rport_operations - Operations for a remote port
1413a3b42bfSRobert Love * @event_callback: Function to be called for remote port events
1423a3b42bfSRobert Love */
14342e9a92fSRobert Love struct fc_rport_operations {
1449fb9d328SJoe Eykholt void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
14542e9a92fSRobert Love enum fc_rport_event);
14642e9a92fSRobert Love };
14742e9a92fSRobert Love
14842e9a92fSRobert Love /**
14942e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port
1503a3b42bfSRobert Love * @local_port: The associated local port
1513a3b42bfSRobert Love * @rp_state: Indicates READY for I/O or DELETE when blocked
1529e9d0452SJoe Eykholt * @flags: REC and RETRY supported flags
1533a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec)
1543a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec)
1559e9d0452SJoe Eykholt */
1569e9d0452SJoe Eykholt struct fc_rport_libfc_priv {
1579e9d0452SJoe Eykholt struct fc_lport *local_port;
1589e9d0452SJoe Eykholt enum fc_rport_state rp_state;
1599e9d0452SJoe Eykholt u16 flags;
1609e9d0452SJoe Eykholt #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
1619e9d0452SJoe Eykholt #define FC_RP_FLAGS_RETRY (1 << 1)
1624b2164d4SJoe Eykholt #define FC_RP_STARTED (1 << 2)
16375a2792dSBhanu Prakash Gollapudi #define FC_RP_FLAGS_CONF_REQ (1 << 3)
1649e9d0452SJoe Eykholt unsigned int e_d_tov;
1659e9d0452SJoe Eykholt unsigned int r_a_tov;
1669e9d0452SJoe Eykholt };
1679e9d0452SJoe Eykholt
1689e9d0452SJoe Eykholt /**
1693a3b42bfSRobert Love * struct fc_rport_priv - libfc remote port and discovery info
1703a3b42bfSRobert Love * @local_port: The associated local port
1713a3b42bfSRobert Love * @rport: The FC transport remote port
1723a3b42bfSRobert Love * @kref: Reference counter
1733a3b42bfSRobert Love * @rp_state: Enumeration that tracks progress of PLOGI, PRLI,
1743a3b42bfSRobert Love * and RTV exchanges
1753a3b42bfSRobert Love * @ids: The remote port identifiers and roles
1764b2164d4SJoe Eykholt * @flags: STARTED, REC and RETRY_SUPPORTED flags
1773a3b42bfSRobert Love * @max_seq: Maximum number of concurrent sequences
1783a3b42bfSRobert Love * @disc_id: The discovery identifier
1793a3b42bfSRobert Love * @maxframe_size: The maximum frame size
1803a3b42bfSRobert Love * @retries: The retry count for the current state
181f034260dSJoe Eykholt * @major_retries: The retry count for the entire PLOGI/PRLI state machine
1823a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec)
1833a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec)
1843a3b42bfSRobert Love * @rp_mutex: The mutex that protects the remote port
1853a3b42bfSRobert Love * @retry_work: Handle for retries
1863a3b42bfSRobert Love * @event_callback: Callback when READY, FAILED or LOGO states complete
18796ad8464SJoe Eykholt * @prli_count: Count of open PRLI sessions in providers
18842e90414SJoe Eykholt * @rcu: Structure used for freeing in an RCU-safe manner
18942e9a92fSRobert Love */
1909e9d0452SJoe Eykholt struct fc_rport_priv {
19142e9a92fSRobert Love struct fc_lport *local_port;
192f211fa51SJoe Eykholt struct fc_rport *rport;
193f211fa51SJoe Eykholt struct kref kref;
19442e9a92fSRobert Love enum fc_rport_state rp_state;
195f211fa51SJoe Eykholt struct fc_rport_identifiers ids;
19642e9a92fSRobert Love u16 flags;
19742e9a92fSRobert Love u16 max_seq;
1980f6c6149SJoe Eykholt u16 disc_id;
199f211fa51SJoe Eykholt u16 maxframe_size;
20042e9a92fSRobert Love unsigned int retries;
201f034260dSJoe Eykholt unsigned int major_retries;
20242e9a92fSRobert Love unsigned int e_d_tov;
20342e9a92fSRobert Love unsigned int r_a_tov;
20442e9a92fSRobert Love struct mutex rp_mutex;
20542e9a92fSRobert Love struct delayed_work retry_work;
20642e9a92fSRobert Love enum fc_rport_event event;
20742e9a92fSRobert Love struct fc_rport_operations *ops;
20842e9a92fSRobert Love struct list_head peers;
20942e9a92fSRobert Love struct work_struct event_work;
210f211fa51SJoe Eykholt u32 supported_classes;
21196ad8464SJoe Eykholt u16 prli_count;
21242e90414SJoe Eykholt struct rcu_head rcu;
21375a2792dSBhanu Prakash Gollapudi u16 sp_features;
21475a2792dSBhanu Prakash Gollapudi u8 spp_type;
21575a2792dSBhanu Prakash Gollapudi void (*lld_event_callback)(struct fc_lport *,
21675a2792dSBhanu Prakash Gollapudi struct fc_rport_priv *,
21775a2792dSBhanu Prakash Gollapudi enum fc_rport_event);
21842e9a92fSRobert Love };
21942e9a92fSRobert Love
2203a3b42bfSRobert Love /**
2211bd49b48SVasu Dev * struct fc_stats - fc stats structure
2223a3b42bfSRobert Love * @SecondsSinceLastReset: Seconds since the last reset
2233a3b42bfSRobert Love * @TxFrames: Number of transmitted frames
2243a3b42bfSRobert Love * @TxWords: Number of transmitted words
2253a3b42bfSRobert Love * @RxFrames: Number of received frames
2263a3b42bfSRobert Love * @RxWords: Number of received words
2273a3b42bfSRobert Love * @ErrorFrames: Number of received error frames
2283a3b42bfSRobert Love * @DumpedFrames: Number of dumped frames
2290f02a665SVasu Dev * @FcpPktAllocFails: Number of fcp packet allocation failures
2300f02a665SVasu Dev * @FcpPktAborts: Number of fcp packet aborts
2310f02a665SVasu Dev * @FcpFrameAllocFails: Number of fcp frame allocation failures
2323a3b42bfSRobert Love * @LinkFailureCount: Number of link failures
2333a3b42bfSRobert Love * @LossOfSignalCount: Number for signal losses
2343a3b42bfSRobert Love * @InvalidTxWordCount: Number of invalid transmitted words
2353a3b42bfSRobert Love * @InvalidCRCCount: Number of invalid CRCs
2363a3b42bfSRobert Love * @InputRequests: Number of input requests
2373a3b42bfSRobert Love * @OutputRequests: Number of output requests
2383a3b42bfSRobert Love * @ControlRequests: Number of control requests
2395f0e385fSJoe Eykholt * @InputBytes: Number of received bytes
2405f0e385fSJoe Eykholt * @OutputBytes: Number of transmitted bytes
2416580bbd0SYi Zou * @VLinkFailureCount: Number of virtual link failures
2426580bbd0SYi Zou * @MissDiscAdvCount: Number of missing FIP discovery advertisement
24342e9a92fSRobert Love */
2441bd49b48SVasu Dev struct fc_stats {
24542e9a92fSRobert Love u64 SecondsSinceLastReset;
24642e9a92fSRobert Love u64 TxFrames;
24742e9a92fSRobert Love u64 TxWords;
24842e9a92fSRobert Love u64 RxFrames;
24942e9a92fSRobert Love u64 RxWords;
25042e9a92fSRobert Love u64 ErrorFrames;
25142e9a92fSRobert Love u64 DumpedFrames;
2520f02a665SVasu Dev u64 FcpPktAllocFails;
2530f02a665SVasu Dev u64 FcpPktAborts;
2540f02a665SVasu Dev u64 FcpFrameAllocFails;
25542e9a92fSRobert Love u64 LinkFailureCount;
25642e9a92fSRobert Love u64 LossOfSignalCount;
25742e9a92fSRobert Love u64 InvalidTxWordCount;
25842e9a92fSRobert Love u64 InvalidCRCCount;
25942e9a92fSRobert Love u64 InputRequests;
26042e9a92fSRobert Love u64 OutputRequests;
26142e9a92fSRobert Love u64 ControlRequests;
2625f0e385fSJoe Eykholt u64 InputBytes;
2635f0e385fSJoe Eykholt u64 OutputBytes;
2646580bbd0SYi Zou u64 VLinkFailureCount;
2656580bbd0SYi Zou u64 MissDiscAdvCount;
26642e9a92fSRobert Love };
26742e9a92fSRobert Love
2683a3b42bfSRobert Love /**
2693a3b42bfSRobert Love * struct fc_seq_els_data - ELS data used for passing ELS specific responses
2703a3b42bfSRobert Love * @reason: The reason for rejection
27125985edcSLucas De Marchi * @explan: The explanation of the rejection
2723a3b42bfSRobert Love *
2733a3b42bfSRobert Love * Mainly used by the exchange manager layer.
27442e9a92fSRobert Love */
27542e9a92fSRobert Love struct fc_seq_els_data {
27642e9a92fSRobert Love enum fc_els_rjt_reason reason;
27742e9a92fSRobert Love enum fc_els_rjt_explan explan;
27842e9a92fSRobert Love };
27942e9a92fSRobert Love
2803a3b42bfSRobert Love /**
2813a3b42bfSRobert Love * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
2823a3b42bfSRobert Love * @lp: The associated local port
2833a3b42bfSRobert Love * @state: The state of the I/O
2843a3b42bfSRobert Love * @ref_cnt: Reference count
2853a3b42bfSRobert Love * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the
2863a3b42bfSRobert Love * host_lock if both are to be held at the same time)
2873a3b42bfSRobert Love * @cmd: The SCSI command (set and clear with the host_lock held)
2883a3b42bfSRobert Love * @list: Tracks queued commands (accessed with the host_lock held)
2893a3b42bfSRobert Love * @timer: The command timer
2903a3b42bfSRobert Love * @tm_done: Completion indicator
2913a3b42bfSRobert Love * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies)
2923a3b42bfSRobert Love * @data_len: The length of the data
2933a3b42bfSRobert Love * @cdb_cmd: The CDB command
2943a3b42bfSRobert Love * @xfer_len: The transfer length
2953a3b42bfSRobert Love * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange
2963a3b42bfSRobert Love * will be set here if DDP was setup)
2973a3b42bfSRobert Love * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
2983a3b42bfSRobert Love * (Tx and Rx)
2993a3b42bfSRobert Love * @max_payload: The maximum payload size (in bytes)
3003a3b42bfSRobert Love * @io_status: SCSI result (upper 24 bits)
3013a3b42bfSRobert Love * @cdb_status: CDB status
3023a3b42bfSRobert Love * @status_code: FCP I/O status
3033a3b42bfSRobert Love * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
3043a3b42bfSRobert Love * @req_flags: Request flags (bit 0: read bit:1 write)
3053a3b42bfSRobert Love * @scsi_resid: SCSI residule length
3063a3b42bfSRobert Love * @rport: The remote port that the SCSI command is targeted at
3073a3b42bfSRobert Love * @seq_ptr: The sequence that will carry the SCSI command
3083a3b42bfSRobert Love * @recov_retry: Number of recovery retries
3093a3b42bfSRobert Love * @recov_seq: The sequence for REC or SRR
31042e9a92fSRobert Love */
31142e9a92fSRobert Love struct fc_fcp_pkt {
3123a3b42bfSRobert Love spinlock_t scsi_pkt_lock;
31322c70d1aSElena Reshetova refcount_t ref_cnt;
314ed26cfecSVasu Dev
315ed26cfecSVasu Dev /* SCSI command and data transfer information */
316ed26cfecSVasu Dev u32 data_len;
3173a3b42bfSRobert Love
3183a3b42bfSRobert Love /* SCSI I/O related information */
3193a3b42bfSRobert Love struct scsi_cmnd *cmd;
3203a3b42bfSRobert Love struct list_head list;
3213a3b42bfSRobert Love
322ed26cfecSVasu Dev /* Housekeeping information */
323ed26cfecSVasu Dev struct fc_lport *lp;
324ed26cfecSVasu Dev u8 state;
32542e9a92fSRobert Love
3263a3b42bfSRobert Love /* SCSI/FCP return status */
32742e9a92fSRobert Love u8 cdb_status;
3283a3b42bfSRobert Love u8 status_code;
32942e9a92fSRobert Love u8 scsi_comp_flags;
330ed26cfecSVasu Dev u32 io_status;
3313a3b42bfSRobert Love u32 req_flags;
3323a3b42bfSRobert Love u32 scsi_resid;
33342e9a92fSRobert Love
334ed26cfecSVasu Dev /* Transport related veriables */
335ed26cfecSVasu Dev size_t xfer_len;
336ed26cfecSVasu Dev struct fcp_cmnd cdb_cmd;
337ed26cfecSVasu Dev u32 xfer_contig_end;
338ed26cfecSVasu Dev u16 max_payload;
339ed26cfecSVasu Dev u16 xfer_ddp;
340ed26cfecSVasu Dev
3413a3b42bfSRobert Love /* Associated structures */
3423a3b42bfSRobert Love struct fc_rport *rport;
3433a3b42bfSRobert Love struct fc_seq *seq_ptr;
3443a3b42bfSRobert Love
345ed26cfecSVasu Dev /* Timeout/error related information */
346ed26cfecSVasu Dev struct timer_list timer;
347ed26cfecSVasu Dev int wait_for_comp;
348ad3120cfSHannes Reinecke int timer_delay;
349ed26cfecSVasu Dev u32 recov_retry;
3503a3b42bfSRobert Love struct fc_seq *recov_seq;
351ed26cfecSVasu Dev struct completion tm_done;
352ed26cfecSVasu Dev } ____cacheline_aligned_in_smp;
35342e9a92fSRobert Love
35442e9a92fSRobert Love /*
3555d21aa36SBart Van Assche * @fsp should be tested and set under the scsi_pkt_queue lock
3565d21aa36SBart Van Assche */
3575d21aa36SBart Van Assche struct libfc_cmd_priv {
3585d21aa36SBart Van Assche struct fc_fcp_pkt *fsp;
3595d21aa36SBart Van Assche u32 resid_len;
3605d21aa36SBart Van Assche u8 status;
3615d21aa36SBart Van Assche };
3625d21aa36SBart Van Assche
3635d21aa36SBart Van Assche /*
36442e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges
36542e9a92fSRobert Love * and Sequences
36642e9a92fSRobert Love *
36742e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence.
36842e9a92fSRobert Love *
36942e9a92fSRobert Love * fc_seq holds the state for an individual sequence.
37042e9a92fSRobert Love */
37142e9a92fSRobert Love
37242e9a92fSRobert Love struct fc_exch_mgr;
37396316099SVasu Dev struct fc_exch_mgr_anchor;
374e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
37542e9a92fSRobert Love
3763a3b42bfSRobert Love /**
3773a3b42bfSRobert Love * struct fc_seq - FC sequence
3783a3b42bfSRobert Love * @id: The sequence ID
3793a3b42bfSRobert Love * @ssb_stat: Status flags for the sequence status block (SSB)
3803a3b42bfSRobert Love * @cnt: Number of frames sent so far
3813a3b42bfSRobert Love * @rec_data: FC-4 value for REC
38242e9a92fSRobert Love */
38342e9a92fSRobert Love struct fc_seq {
3843a3b42bfSRobert Love u8 id;
3853a3b42bfSRobert Love u16 ssb_stat;
3863a3b42bfSRobert Love u16 cnt;
3873a3b42bfSRobert Love u32 rec_data;
38842e9a92fSRobert Love };
38942e9a92fSRobert Love
39042e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */
39142e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
3929ca1e182SHannes Reinecke #define FC_EX_QUARANTINE (1 << 2) /* exch is quarantined */
39342e9a92fSRobert Love
3943a3b42bfSRobert Love /**
3953a3b42bfSRobert Love * struct fc_exch - Fibre Channel Exchange
3963a3b42bfSRobert Love * @em: Exchange manager
3973a3b42bfSRobert Love * @pool: Exchange pool
3983a3b42bfSRobert Love * @state: The exchange's state
3993a3b42bfSRobert Love * @xid: The exchange ID
4003a3b42bfSRobert Love * @ex_list: Handle used by the EM to track free exchanges
4013a3b42bfSRobert Love * @ex_lock: Lock that protects the exchange
4023a3b42bfSRobert Love * @ex_refcnt: Reference count
4033a3b42bfSRobert Love * @timeout_work: Handle for timeout handler
4043a3b42bfSRobert Love * @lp: The local port that this exchange is on
4053a3b42bfSRobert Love * @oxid: Originator's exchange ID
4063a3b42bfSRobert Love * @rxid: Responder's exchange ID
4073a3b42bfSRobert Love * @oid: Originator's FCID
4083a3b42bfSRobert Love * @sid: Source FCID
4093a3b42bfSRobert Love * @did: Destination FCID
4103a3b42bfSRobert Love * @esb_stat: ESB exchange status
41140d6b939SZhen Lei * @r_a_tov: Resource allocation time out value (in msecs)
4123a3b42bfSRobert Love * @seq_id: The next sequence ID to use
413f60e12e9SJoe Eykholt * @encaps: encapsulation information for lower-level driver
4143a3b42bfSRobert Love * @f_ctl: F_CTL flags for the sequence
4153a3b42bfSRobert Love * @fh_type: The frame type
4163a3b42bfSRobert Love * @class: The class of service
4173a3b42bfSRobert Love * @seq: The sequence in use on this exchange
4187030fd62SBart Van Assche * @resp_active: Number of tasks that are concurrently executing @resp().
4197030fd62SBart Van Assche * @resp_task: If @resp_active > 0, either the task executing @resp(), the
4207030fd62SBart Van Assche * task that has been interrupted to execute the soft-IRQ
4217030fd62SBart Van Assche * executing @resp() or NULL if more than one task is executing
4227030fd62SBart Van Assche * @resp concurrently.
4237030fd62SBart Van Assche * @resp_wq: Waitqueue for the tasks waiting on @resp_active.
4243a3b42bfSRobert Love * @resp: Callback for responses on this exchange
4253a3b42bfSRobert Love * @destructor: Called when destroying the exchange
4263a3b42bfSRobert Love * @arg: Passed as a void pointer to the resp() callback
42742e9a92fSRobert Love *
42842e9a92fSRobert Love * Locking notes: The ex_lock protects following items:
42942e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat
43042e9a92fSRobert Love * seq_id
43142e9a92fSRobert Love * sequence allocation
43242e9a92fSRobert Love */
43342e9a92fSRobert Love struct fc_exch {
4343a3b42bfSRobert Love spinlock_t ex_lock;
4353a3b42bfSRobert Love atomic_t ex_refcnt;
43649a19889SVasu Dev enum fc_class class;
43749a19889SVasu Dev struct fc_exch_mgr *em;
43849a19889SVasu Dev struct fc_exch_pool *pool;
43949a19889SVasu Dev struct list_head ex_list;
4403a3b42bfSRobert Love struct fc_lport *lp;
44149a19889SVasu Dev u32 esb_stat;
44249a19889SVasu Dev u8 state;
44349a19889SVasu Dev u8 fh_type;
44449a19889SVasu Dev u8 seq_id;
44549a19889SVasu Dev u8 encaps;
44649a19889SVasu Dev u16 xid;
4473a3b42bfSRobert Love u16 oxid;
4483a3b42bfSRobert Love u16 rxid;
4493a3b42bfSRobert Love u32 oid;
4503a3b42bfSRobert Love u32 sid;
4513a3b42bfSRobert Love u32 did;
4523a3b42bfSRobert Love u32 r_a_tov;
4533a3b42bfSRobert Love u32 f_ctl;
4543a3b42bfSRobert Love struct fc_seq seq;
4557030fd62SBart Van Assche int resp_active;
4567030fd62SBart Van Assche struct task_struct *resp_task;
4577030fd62SBart Van Assche wait_queue_head_t resp_wq;
45842e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *);
45942e9a92fSRobert Love void *arg;
4603a3b42bfSRobert Love void (*destructor)(struct fc_seq *, void *);
46149a19889SVasu Dev struct delayed_work timeout_work;
46249a19889SVasu Dev } ____cacheline_aligned_in_smp;
46342e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
46442e9a92fSRobert Love
46542e9a92fSRobert Love
4663a3b42bfSRobert Love struct libfc_function_template {
46742e9a92fSRobert Love /*
46842e9a92fSRobert Love * Interface to send a FC frame
4690ae4d4aeSRobert Love *
4700ae4d4aeSRobert Love * STATUS: REQUIRED
47142e9a92fSRobert Love */
4723a3b42bfSRobert Love int (*frame_send)(struct fc_lport *, struct fc_frame *);
47342e9a92fSRobert Love
47442e9a92fSRobert Love /*
4750ae4d4aeSRobert Love * Interface to send ELS/CT frames
4760ae4d4aeSRobert Love *
4770ae4d4aeSRobert Love * STATUS: OPTIONAL
47842e9a92fSRobert Love */
4793a3b42bfSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
4803a3b42bfSRobert Love struct fc_frame *, unsigned int op,
48142e9a92fSRobert Love void (*resp)(struct fc_seq *,
4823a3b42bfSRobert Love struct fc_frame *, void *arg),
48342e9a92fSRobert Love void *arg, u32 timer_msec);
48442e9a92fSRobert Love
48542e9a92fSRobert Love /*
486b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given
487b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive.
488b277d2aaSYi Zou *
489b277d2aaSYi Zou * STATUS: OPTIONAL
490b277d2aaSYi Zou */
4913a3b42bfSRobert Love int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
4923a3b42bfSRobert Love unsigned int);
493b277d2aaSYi Zou /*
494b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed
495b277d2aaSYi Zou * for the given exchange id.
496b277d2aaSYi Zou *
497b277d2aaSYi Zou * STATUS: OPTIONAL
498b277d2aaSYi Zou */
4993a3b42bfSRobert Love int (*ddp_done)(struct fc_lport *, u16);
500b277d2aaSYi Zou /*
50133dc362bSYi Zou * Sets up the DDP context for a given exchange id on the given
5021bd49b48SVasu Dev * scatterlist if LLD supports DDP for target.
50333dc362bSYi Zou *
50433dc362bSYi Zou * STATUS: OPTIONAL
50533dc362bSYi Zou */
50633dc362bSYi Zou int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *,
50733dc362bSYi Zou unsigned int);
50833dc362bSYi Zou /*
509b84056bfSYi Zou * Allow LLD to fill its own Link Error Status Block
510b84056bfSYi Zou *
511b84056bfSYi Zou * STATUS: OPTIONAL
512b84056bfSYi Zou */
513b84056bfSYi Zou void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
51442e9a92fSRobert Love
51542e9a92fSRobert Love /*
51642e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges.
51742e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID.
51842e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID.
5190ae4d4aeSRobert Love *
5200ae4d4aeSRobert Love * STATUS: OPTIONAL
52142e9a92fSRobert Love */
5223a3b42bfSRobert Love void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
52342e9a92fSRobert Love
5240ae4d4aeSRobert Love /*
525093bb6a2SJoe Eykholt * Set the local port FC_ID.
526093bb6a2SJoe Eykholt *
527093bb6a2SJoe Eykholt * This may be provided by the LLD to allow it to be
528093bb6a2SJoe Eykholt * notified when the local port is assigned a FC-ID.
529093bb6a2SJoe Eykholt *
530093bb6a2SJoe Eykholt * The frame, if non-NULL, is the incoming frame with the
531093bb6a2SJoe Eykholt * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
532093bb6a2SJoe Eykholt * address for the LLD. The frame pointer may be NULL if
533093bb6a2SJoe Eykholt * no MAC is associated with this assignment (LOGO or PLOGI).
534093bb6a2SJoe Eykholt *
535093bb6a2SJoe Eykholt * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
536093bb6a2SJoe Eykholt *
537093bb6a2SJoe Eykholt * Note: this is called with the local port mutex held.
538093bb6a2SJoe Eykholt *
539093bb6a2SJoe Eykholt * STATUS: OPTIONAL
540093bb6a2SJoe Eykholt */
541093bb6a2SJoe Eykholt void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
542093bb6a2SJoe Eykholt struct fc_frame *);
543093bb6a2SJoe Eykholt
544093bb6a2SJoe Eykholt /*
54575a2792dSBhanu Prakash Gollapudi * Callback routine after the remote port is logged in
54675a2792dSBhanu Prakash Gollapudi *
54775a2792dSBhanu Prakash Gollapudi * STATUS: OPTIONAL
54875a2792dSBhanu Prakash Gollapudi */
54975a2792dSBhanu Prakash Gollapudi void (*rport_event_callback)(struct fc_lport *,
55075a2792dSBhanu Prakash Gollapudi struct fc_rport_priv *,
55175a2792dSBhanu Prakash Gollapudi enum fc_rport_event);
55275a2792dSBhanu Prakash Gollapudi
55375a2792dSBhanu Prakash Gollapudi /*
55442e9a92fSRobert Love * Send a fcp cmd from fsp pkt.
55542e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled.
55642e9a92fSRobert Love *
55742e9a92fSRobert Love * The resp handler is called when FCP_RSP received.
55842e9a92fSRobert Love *
5590ae4d4aeSRobert Love * STATUS: OPTIONAL
56042e9a92fSRobert Love */
5613a3b42bfSRobert Love int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
5623a3b42bfSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *,
5633a3b42bfSRobert Love void *));
56442e9a92fSRobert Love
56542e9a92fSRobert Love /*
56625985edcSLucas De Marchi * Cleanup the FCP layer, used during link down and reset
5670ae4d4aeSRobert Love *
5680ae4d4aeSRobert Love * STATUS: OPTIONAL
56942e9a92fSRobert Love */
5703a3b42bfSRobert Love void (*fcp_cleanup)(struct fc_lport *);
57142e9a92fSRobert Love
57242e9a92fSRobert Love /*
57342e9a92fSRobert Love * Abort all I/O on a local port
5740ae4d4aeSRobert Love *
5750ae4d4aeSRobert Love * STATUS: OPTIONAL
57642e9a92fSRobert Love */
5773a3b42bfSRobert Love void (*fcp_abort_io)(struct fc_lport *);
57842e9a92fSRobert Love
5790ae4d4aeSRobert Love /*
5800ae4d4aeSRobert Love * Receive a request for the discovery layer.
5810ae4d4aeSRobert Love *
5820ae4d4aeSRobert Love * STATUS: OPTIONAL
58342e9a92fSRobert Love */
58492261156SJoe Eykholt void (*disc_recv_req)(struct fc_lport *, struct fc_frame *);
58542e9a92fSRobert Love
58642e9a92fSRobert Love /*
58742e9a92fSRobert Love * Start discovery for a local port.
5880ae4d4aeSRobert Love *
5890ae4d4aeSRobert Love * STATUS: OPTIONAL
59042e9a92fSRobert Love */
59142e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *,
59242e9a92fSRobert Love enum fc_disc_event),
59342e9a92fSRobert Love struct fc_lport *);
59442e9a92fSRobert Love
59542e9a92fSRobert Love /*
59642e9a92fSRobert Love * Stop discovery for a given lport. This will remove
59742e9a92fSRobert Love * all discovered rports
5980ae4d4aeSRobert Love *
5990ae4d4aeSRobert Love * STATUS: OPTIONAL
60042e9a92fSRobert Love */
60142e9a92fSRobert Love void (*disc_stop) (struct fc_lport *);
60242e9a92fSRobert Love
60342e9a92fSRobert Love /*
60442e9a92fSRobert Love * Stop discovery for a given lport. This will block
60542e9a92fSRobert Love * until all discovered rports are deleted from the
60642e9a92fSRobert Love * FC transport class
6070ae4d4aeSRobert Love *
6080ae4d4aeSRobert Love * STATUS: OPTIONAL
60942e9a92fSRobert Love */
61042e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *);
61142e9a92fSRobert Love };
61242e9a92fSRobert Love
6133a3b42bfSRobert Love /**
6143a3b42bfSRobert Love * struct fc_disc - Discovery context
6153a3b42bfSRobert Love * @retry_count: Number of retries
6163a3b42bfSRobert Love * @pending: 1 if discovery is pending, 0 if not
617c531b9b4SBhanu Prakash Gollapudi * @requested: 1 if discovery has been requested, 0 if not
6183a3b42bfSRobert Love * @seq_count: Number of sequences used for discovery
6193a3b42bfSRobert Love * @buf_len: Length of the discovery buffer
6203a3b42bfSRobert Love * @disc_id: Discovery ID
6213a3b42bfSRobert Love * @rports: List of discovered remote ports
6220685230cSJoe Eykholt * @priv: Private pointer for use by discovery code
6233a3b42bfSRobert Love * @disc_mutex: Mutex that protects the discovery context
6243a3b42bfSRobert Love * @partial_buf: Partial name buffer (if names are returned
6253a3b42bfSRobert Love * in multiple frames)
6263a3b42bfSRobert Love * @disc_work: handle for delayed work context
6273a3b42bfSRobert Love * @disc_callback: Callback routine called when discovery completes
6283a3b42bfSRobert Love */
62942e9a92fSRobert Love struct fc_disc {
63042e9a92fSRobert Love unsigned char retry_count;
63142e9a92fSRobert Love unsigned char pending;
63242e9a92fSRobert Love unsigned char requested;
63342e9a92fSRobert Love unsigned short seq_count;
63442e9a92fSRobert Love unsigned char buf_len;
6350f6c6149SJoe Eykholt u16 disc_id;
63642e9a92fSRobert Love
63742e9a92fSRobert Love struct list_head rports;
6380685230cSJoe Eykholt void *priv;
63942e9a92fSRobert Love struct mutex disc_mutex;
6403a3b42bfSRobert Love struct fc_gpn_ft_resp partial_buf;
64142e9a92fSRobert Love struct delayed_work disc_work;
6423a3b42bfSRobert Love
6433a3b42bfSRobert Love void (*disc_callback)(struct fc_lport *,
6443a3b42bfSRobert Love enum fc_disc_event);
64542e9a92fSRobert Love };
64642e9a92fSRobert Love
64770d53b04SJoe Eykholt /*
64870d53b04SJoe Eykholt * Local port notifier and events.
64970d53b04SJoe Eykholt */
65070d53b04SJoe Eykholt extern struct blocking_notifier_head fc_lport_notifier_head;
65170d53b04SJoe Eykholt enum fc_lport_event {
65270d53b04SJoe Eykholt FC_LPORT_EV_ADD,
65370d53b04SJoe Eykholt FC_LPORT_EV_DEL,
65470d53b04SJoe Eykholt };
65570d53b04SJoe Eykholt
6563a3b42bfSRobert Love /**
6573a3b42bfSRobert Love * struct fc_lport - Local port
6583a3b42bfSRobert Love * @host: The SCSI host associated with a local port
6593a3b42bfSRobert Love * @ema_list: Exchange manager anchor list
6603a3b42bfSRobert Love * @dns_rdata: The directory server remote port
661d78c317fSNeerav Parikh * @ms_rdata: The management server remote port
6623a3b42bfSRobert Love * @ptp_rdata: Point to point remote port
6633a3b42bfSRobert Love * @scsi_priv: FCP layer internal data
6643a3b42bfSRobert Love * @disc: Discovery context
6653a3b42bfSRobert Love * @vports: Child vports if N_Port
6663a3b42bfSRobert Love * @vport: Parent vport if VN_Port
6673a3b42bfSRobert Love * @tt: Libfc function template
6683a3b42bfSRobert Love * @link_up: Link state (1 = link up, 0 = link down)
6693a3b42bfSRobert Love * @qfull: Queue state (1 queue is full, 0 queue is not full)
6703a3b42bfSRobert Love * @state: Identifies the state
6713a3b42bfSRobert Love * @boot_time: Timestamp indicating when the local port came online
6723a3b42bfSRobert Love * @host_stats: SCSI host statistics
6731bd49b48SVasu Dev * @stats: FC local port stats (TODO separate libfc LLD stats)
6743a3b42bfSRobert Love * @retry_count: Number of retries in the current state
6757b2787ecSRobert Love * @port_id: FC Port ID
6763a3b42bfSRobert Love * @wwpn: World Wide Port Name
6773a3b42bfSRobert Love * @wwnn: World Wide Node Name
6783a3b42bfSRobert Love * @service_params: Common service parameters
6793a3b42bfSRobert Love * @e_d_tov: Error detection timeout value
68040d6b939SZhen Lei * @r_a_tov: Resource allocation timeout value
6813a3b42bfSRobert Love * @rnid_gen: RNID information
6823a3b42bfSRobert Love * @sg_supp: Indicates if scatter gather is supported
6833a3b42bfSRobert Love * @seq_offload: Indicates if sequence offload is supported
6843a3b42bfSRobert Love * @crc_offload: Indicates if CRC offload is supported
6853a3b42bfSRobert Love * @lro_enabled: Indicates if large receive offload is supported
6863a3b42bfSRobert Love * @does_npiv: Supports multiple vports
6873a3b42bfSRobert Love * @npiv_enabled: Switch/fabric allows NPIV
6883a3b42bfSRobert Love * @mfs: The maximum Fibre Channel payload size
6893a3b42bfSRobert Love * @max_retry_count: The maximum retry attempts
6903a3b42bfSRobert Love * @max_rport_retry_count: The maximum remote port retry attempts
691f90377abSJoe Eykholt * @rport_priv_size: Size needed by driver after struct fc_rport_priv
6923a3b42bfSRobert Love * @lro_xid: The maximum XID for LRO
6933a3b42bfSRobert Love * @lso_max: The maximum large offload send size
6943a3b42bfSRobert Love * @fcts: FC-4 type mask
6953a3b42bfSRobert Love * @lp_mutex: Mutex to protect the local port
69670d53b04SJoe Eykholt * @list: Linkage on list of vport peers
6973a3b42bfSRobert Love * @retry_work: Handle to local port for delayed retry context
698baf9fdf0SJoe Eykholt * @prov: Pointers available for use by passive FC-4 providers
69970d53b04SJoe Eykholt * @lport_list: Linkage on module-wide list of local ports
7003a3b42bfSRobert Love */
70142e9a92fSRobert Love struct fc_lport {
70242e9a92fSRobert Love /* Associations */
70342e9a92fSRobert Love struct Scsi_Host *host;
70496316099SVasu Dev struct list_head ema_list;
7053a3b42bfSRobert Love struct fc_rport_priv *dns_rdata;
706d78c317fSNeerav Parikh struct fc_rport_priv *ms_rdata;
7073a3b42bfSRobert Love struct fc_rport_priv *ptp_rdata;
70842e9a92fSRobert Love void *scsi_priv;
70942e9a92fSRobert Love struct fc_disc disc;
71042e9a92fSRobert Love
7113a3b42bfSRobert Love /* Virtual port information */
7123a3b42bfSRobert Love struct list_head vports;
7133a3b42bfSRobert Love struct fc_vport *vport;
7143a3b42bfSRobert Love
71542e9a92fSRobert Love /* Operational Information */
71642e9a92fSRobert Love struct libfc_function_template tt;
717bc0e17f6SVasu Dev u8 link_up;
718bc0e17f6SVasu Dev u8 qfull;
7199a6cf881SHannes Reinecke u16 vlan;
72042e9a92fSRobert Love enum fc_lport_state state;
72142e9a92fSRobert Love unsigned long boot_time;
72242e9a92fSRobert Love struct fc_host_statistics host_stats;
7231bd49b48SVasu Dev struct fc_stats __percpu *stats;
72442e9a92fSRobert Love u8 retry_count;
72542e9a92fSRobert Love
7263a3b42bfSRobert Love /* Fabric information */
7277b2787ecSRobert Love u32 port_id;
7283a3b42bfSRobert Love u64 wwpn;
7293a3b42bfSRobert Love u64 wwnn;
73042e9a92fSRobert Love unsigned int service_params;
73142e9a92fSRobert Love unsigned int e_d_tov;
73242e9a92fSRobert Love unsigned int r_a_tov;
7333a3b42bfSRobert Love struct fc_els_rnid_gen rnid_gen;
7343a3b42bfSRobert Love
7353a3b42bfSRobert Love /* Capabilities */
7363a3b42bfSRobert Love u32 sg_supp:1;
7373a3b42bfSRobert Love u32 seq_offload:1;
7383a3b42bfSRobert Love u32 crc_offload:1;
7393a3b42bfSRobert Love u32 lro_enabled:1;
7403a3b42bfSRobert Love u32 does_npiv:1;
7413a3b42bfSRobert Love u32 npiv_enabled:1;
7423726f358SJoe Eykholt u32 point_to_multipoint:1;
743d78c317fSNeerav Parikh u32 fdmi_enabled:1;
7443a3b42bfSRobert Love u32 mfs;
74542e9a92fSRobert Love u8 max_retry_count;
746a3666955SAbhijeet Joglekar u8 max_rport_retry_count;
747f90377abSJoe Eykholt u16 rport_priv_size;
74842e9a92fSRobert Love u16 link_speed;
74942e9a92fSRobert Love u16 link_supported_speeds;
7503a3b42bfSRobert Love u16 lro_xid;
7513a3b42bfSRobert Love unsigned int lso_max;
7523a3b42bfSRobert Love struct fc_ns_fts fcts;
75342e9a92fSRobert Love
75442e9a92fSRobert Love /* Miscellaneous */
7553a3b42bfSRobert Love struct mutex lp_mutex;
7563a3b42bfSRobert Love struct list_head list;
75742e9a92fSRobert Love struct delayed_work retry_work;
758baf9fdf0SJoe Eykholt void *prov[FC_FC4_PROV_SIZE];
75970d53b04SJoe Eykholt struct list_head lport_list;
76042e9a92fSRobert Love };
76142e9a92fSRobert Love
76296ad8464SJoe Eykholt /**
76396ad8464SJoe Eykholt * struct fc4_prov - FC-4 provider registration
76496ad8464SJoe Eykholt * @prli: Handler for incoming PRLI
76596ad8464SJoe Eykholt * @prlo: Handler for session reset
76696ad8464SJoe Eykholt * @recv: Handler for incoming request
76796ad8464SJoe Eykholt * @module: Pointer to module. May be NULL.
76896ad8464SJoe Eykholt */
76996ad8464SJoe Eykholt struct fc4_prov {
77096ad8464SJoe Eykholt int (*prli)(struct fc_rport_priv *, u32 spp_len,
77196ad8464SJoe Eykholt const struct fc_els_spp *spp_in,
77296ad8464SJoe Eykholt struct fc_els_spp *spp_out);
77396ad8464SJoe Eykholt void (*prlo)(struct fc_rport_priv *);
77496ad8464SJoe Eykholt void (*recv)(struct fc_lport *, struct fc_frame *);
77596ad8464SJoe Eykholt struct module *module;
77696ad8464SJoe Eykholt };
77796ad8464SJoe Eykholt
77896ad8464SJoe Eykholt /*
77996ad8464SJoe Eykholt * Register FC-4 provider with libfc.
78096ad8464SJoe Eykholt */
78196ad8464SJoe Eykholt int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *);
78296ad8464SJoe Eykholt void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *);
78396ad8464SJoe Eykholt
78434f42a07SRobert Love /*
78542e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS
78642e9a92fSRobert Love *****************************/
7873a3b42bfSRobert Love
7883a3b42bfSRobert Love /**
7893a3b42bfSRobert Love * fc_lport_test_ready() - Determine if a local port is in the READY state
7903a3b42bfSRobert Love * @lport: The local port to test
7913a3b42bfSRobert Love */
fc_lport_test_ready(struct fc_lport * lport)7923a3b42bfSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lport)
79342e9a92fSRobert Love {
7943a3b42bfSRobert Love return lport->state == LPORT_ST_READY;
79542e9a92fSRobert Love }
79642e9a92fSRobert Love
7973a3b42bfSRobert Love /**
7983a3b42bfSRobert Love * fc_set_wwnn() - Set the World Wide Node Name of a local port
7993a3b42bfSRobert Love * @lport: The local port whose WWNN is to be set
8003a3b42bfSRobert Love * @wwnn: The new WWNN
8013a3b42bfSRobert Love */
fc_set_wwnn(struct fc_lport * lport,u64 wwnn)8023a3b42bfSRobert Love static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
80342e9a92fSRobert Love {
8043a3b42bfSRobert Love lport->wwnn = wwnn;
80542e9a92fSRobert Love }
80642e9a92fSRobert Love
8073a3b42bfSRobert Love /**
8083a3b42bfSRobert Love * fc_set_wwpn() - Set the World Wide Port Name of a local port
8093a3b42bfSRobert Love * @lport: The local port whose WWPN is to be set
81067d35e70SFam Zheng * @wwpn: The new WWPN
8113a3b42bfSRobert Love */
fc_set_wwpn(struct fc_lport * lport,u64 wwpn)81267d35e70SFam Zheng static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwpn)
81342e9a92fSRobert Love {
81467d35e70SFam Zheng lport->wwpn = wwpn;
81542e9a92fSRobert Love }
81642e9a92fSRobert Love
8173a3b42bfSRobert Love /**
8183a3b42bfSRobert Love * fc_lport_state_enter() - Change a local port's state
8193a3b42bfSRobert Love * @lport: The local port whose state is to change
8203a3b42bfSRobert Love * @state: The new state
8213a3b42bfSRobert Love */
fc_lport_state_enter(struct fc_lport * lport,enum fc_lport_state state)8223a3b42bfSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lport,
82342e9a92fSRobert Love enum fc_lport_state state)
82442e9a92fSRobert Love {
8253a3b42bfSRobert Love if (state != lport->state)
8263a3b42bfSRobert Love lport->retry_count = 0;
8273a3b42bfSRobert Love lport->state = state;
82842e9a92fSRobert Love }
82942e9a92fSRobert Love
8303a3b42bfSRobert Love /**
8313a3b42bfSRobert Love * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
8323a3b42bfSRobert Love * @lport: The local port whose statistics are to be initialized
8333a3b42bfSRobert Love */
fc_lport_init_stats(struct fc_lport * lport)8343a3b42bfSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lport)
835582b45bcSRobert Love {
8361bd49b48SVasu Dev lport->stats = alloc_percpu(struct fc_stats);
8371bd49b48SVasu Dev if (!lport->stats)
838582b45bcSRobert Love return -ENOMEM;
839582b45bcSRobert Love return 0;
840582b45bcSRobert Love }
841582b45bcSRobert Love
8423a3b42bfSRobert Love /**
8433a3b42bfSRobert Love * fc_lport_free_stats() - Free memory for a local port's statistics
8443a3b42bfSRobert Love * @lport: The local port whose statistics are to be freed
8453a3b42bfSRobert Love */
fc_lport_free_stats(struct fc_lport * lport)8463a3b42bfSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lport)
847582b45bcSRobert Love {
8481bd49b48SVasu Dev free_percpu(lport->stats);
849a0a25da2SVasu Dev }
850a0a25da2SVasu Dev
851a0a25da2SVasu Dev /**
8523a3b42bfSRobert Love * lport_priv() - Return the private data from a local port
85340d6b939SZhen Lei * @lport: The local port whose private data is to be retrieved
8543a3b42bfSRobert Love */
lport_priv(const struct fc_lport * lport)8553a3b42bfSRobert Love static inline void *lport_priv(const struct fc_lport *lport)
8563a3b42bfSRobert Love {
8573a3b42bfSRobert Love return (void *)(lport + 1);
8583a3b42bfSRobert Love }
8593a3b42bfSRobert Love
8603a3b42bfSRobert Love /**
8613a3b42bfSRobert Love * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
8623a3b42bfSRobert Love * LLD private data
8633a3b42bfSRobert Love * @sht: The SCSI host template
8643a3b42bfSRobert Love * @priv_size: Size of private data
865a0a25da2SVasu Dev *
86686221969SChris Leech * Returns: libfc lport
867a0a25da2SVasu Dev */
86886221969SChris Leech static inline struct fc_lport *
libfc_host_alloc(const struct scsi_host_template * sht,int priv_size)869*e0d3f2c6SBart Van Assche libfc_host_alloc(const struct scsi_host_template *sht, int priv_size)
870a0a25da2SVasu Dev {
87186221969SChris Leech struct fc_lport *lport;
87286221969SChris Leech struct Scsi_Host *shost;
87386221969SChris Leech
87486221969SChris Leech shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
87586221969SChris Leech if (!shost)
87686221969SChris Leech return NULL;
87786221969SChris Leech lport = shost_priv(shost);
87886221969SChris Leech lport->host = shost;
87986221969SChris Leech INIT_LIST_HEAD(&lport->ema_list);
880174e1ebfSChris Leech INIT_LIST_HEAD(&lport->vports);
88186221969SChris Leech return lport;
882a0a25da2SVasu Dev }
88342e9a92fSRobert Love
88434f42a07SRobert Love /*
8853a3b42bfSRobert Love * FC_FCP HELPER FUNCTIONS
8863a3b42bfSRobert Love *****************************/
fc_fcp_is_read(const struct fc_fcp_pkt * fsp)8873a3b42bfSRobert Love static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
8883a3b42bfSRobert Love {
8893a3b42bfSRobert Love if (fsp && fsp->cmd)
8903a3b42bfSRobert Love return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
8913a3b42bfSRobert Love return false;
8923a3b42bfSRobert Love }
8933a3b42bfSRobert Love
8943a3b42bfSRobert Love /*
89542e9a92fSRobert Love * LOCAL PORT LAYER
89642e9a92fSRobert Love *****************************/
8973a3b42bfSRobert Love int fc_lport_init(struct fc_lport *);
8983a3b42bfSRobert Love int fc_lport_destroy(struct fc_lport *);
8993a3b42bfSRobert Love int fc_fabric_logoff(struct fc_lport *);
9003a3b42bfSRobert Love int fc_fabric_login(struct fc_lport *);
9018faecddbSChris Leech void __fc_linkup(struct fc_lport *);
90242e9a92fSRobert Love void fc_linkup(struct fc_lport *);
9038faecddbSChris Leech void __fc_linkdown(struct fc_lport *);
90442e9a92fSRobert Love void fc_linkdown(struct fc_lport *);
9053a3b42bfSRobert Love void fc_vport_setlink(struct fc_lport *);
9063a3b42bfSRobert Love void fc_vports_linkchange(struct fc_lport *);
90742e9a92fSRobert Love int fc_lport_config(struct fc_lport *);
90842e9a92fSRobert Love int fc_lport_reset(struct fc_lport *);
909c5cb444cSHannes Reinecke void fc_lport_recv(struct fc_lport *lport, struct fc_frame *fp);
9103a3b42bfSRobert Love int fc_set_mfs(struct fc_lport *, u32 mfs);
9113a3b42bfSRobert Love struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
9123a3b42bfSRobert Love struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
91375cc8cfcSJohannes Thumshirn int fc_lport_bsg_request(struct bsg_job *);
9143726f358SJoe Eykholt void fc_lport_set_local_id(struct fc_lport *, u32 port_id);
91570d53b04SJoe Eykholt void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *);
916a51ab396SSteve Ma
917a51ab396SSteve Ma /*
91842e9a92fSRobert Love * REMOTE PORT LAYER
91942e9a92fSRobert Love *****************************/
9203a3b42bfSRobert Love void fc_rport_terminate_io(struct fc_rport *);
921e87b7777SHannes Reinecke struct fc_rport_priv *fc_rport_lookup(const struct fc_lport *lport,
922e87b7777SHannes Reinecke u32 port_id);
9232580064bSHannes Reinecke struct fc_rport_priv *fc_rport_create(struct fc_lport *, u32);
924944ef968SHannes Reinecke void fc_rport_destroy(struct kref *kref);
92505d7d3b0SHannes Reinecke int fc_rport_login(struct fc_rport_priv *rdata);
926c96c792aSHannes Reinecke int fc_rport_logoff(struct fc_rport_priv *rdata);
927e76ee65fSHannes Reinecke void fc_rport_recv_req(struct fc_lport *lport, struct fc_frame *fp);
9285922a957SHannes Reinecke void fc_rport_flush_queue(void);
92942e9a92fSRobert Love
93034f42a07SRobert Love /*
93142e9a92fSRobert Love * DISCOVERY LAYER
93242e9a92fSRobert Love *****************************/
9330807619dSRobert Love void fc_disc_init(struct fc_lport *);
9340807619dSRobert Love void fc_disc_config(struct fc_lport *, void *);
93542e9a92fSRobert Love
fc_disc_lport(struct fc_disc * disc)9360685230cSJoe Eykholt static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
9370685230cSJoe Eykholt {
9380685230cSJoe Eykholt return container_of(disc, struct fc_lport, disc);
9390685230cSJoe Eykholt }
9400685230cSJoe Eykholt
94134f42a07SRobert Love /*
9423a3b42bfSRobert Love * FCP LAYER
94342e9a92fSRobert Love *****************************/
94442e9a92fSRobert Love int fc_fcp_init(struct fc_lport *);
94542e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *);
94642e9a92fSRobert Love
94734f42a07SRobert Love /*
9483a3b42bfSRobert Love * SCSI INTERACTION LAYER
9493a3b42bfSRobert Love *****************************/
950f281233dSJeff Garzik int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
9513a3b42bfSRobert Love int fc_eh_abort(struct scsi_cmnd *);
9523a3b42bfSRobert Love int fc_eh_device_reset(struct scsi_cmnd *);
9533a3b42bfSRobert Love int fc_eh_host_reset(struct scsi_cmnd *);
9543a3b42bfSRobert Love int fc_slave_alloc(struct scsi_device *);
9553a3b42bfSRobert Love
9563a3b42bfSRobert Love /*
95742e9a92fSRobert Love * ELS/CT interface
95842e9a92fSRobert Love *****************************/
9593a3b42bfSRobert Love int fc_elsct_init(struct fc_lport *);
9603a3b42bfSRobert Love struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
9613a3b42bfSRobert Love struct fc_frame *,
96211b56188SChris Leech unsigned int op,
96311b56188SChris Leech void (*resp)(struct fc_seq *,
9643a3b42bfSRobert Love struct fc_frame *,
96511b56188SChris Leech void *arg),
96611b56188SChris Leech void *arg, u32 timer_msec);
96711b56188SChris Leech void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
96811b56188SChris Leech void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
96924f089e2SJoe Eykholt void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *,
97024f089e2SJoe Eykholt enum fc_rctl, u32 parm_offset);
97124f089e2SJoe Eykholt void fc_fill_hdr(struct fc_frame *, const struct fc_frame *,
97224f089e2SJoe Eykholt enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset);
97342e9a92fSRobert Love
97442e9a92fSRobert Love
97534f42a07SRobert Love /*
97642e9a92fSRobert Love * EXCHANGE MANAGER LAYER
97742e9a92fSRobert Love *****************************/
9783a3b42bfSRobert Love int fc_exch_init(struct fc_lport *);
9794e5fae7aSVasu Dev void fc_exch_update_stats(struct fc_lport *lport);
9803afd2d15SHannes Reinecke struct fc_seq *fc_exch_seq_send(struct fc_lport *lport,
9813afd2d15SHannes Reinecke struct fc_frame *fp,
9823afd2d15SHannes Reinecke void (*resp)(struct fc_seq *,
9833afd2d15SHannes Reinecke struct fc_frame *fp,
9843afd2d15SHannes Reinecke void *arg),
9853afd2d15SHannes Reinecke void (*destructor)(struct fc_seq *, void *),
9863afd2d15SHannes Reinecke void *arg, u32 timer_msec);
9877ab24dd1SHannes Reinecke void fc_seq_els_rsp_send(struct fc_frame *, enum fc_els_cmd,
9887ab24dd1SHannes Reinecke struct fc_seq_els_data *);
989c6865b30SHannes Reinecke struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
990f1d61e6eSHannes Reinecke void fc_seq_set_resp(struct fc_seq *sp,
991f1d61e6eSHannes Reinecke void (*resp)(struct fc_seq *, struct fc_frame *, void *),
992f1d61e6eSHannes Reinecke void *arg);
99396d564e2SHannes Reinecke struct fc_seq *fc_seq_assign(struct fc_lport *lport, struct fc_frame *fp);
9949625cc48SHannes Reinecke void fc_seq_release(struct fc_seq *sp);
9953a3b42bfSRobert Love struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
9963a3b42bfSRobert Love struct fc_exch_mgr *,
99796316099SVasu Dev bool (*match)(struct fc_frame *));
9983a3b42bfSRobert Love void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
999174e1ebfSChris Leech int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
10003a3b42bfSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
10013a3b42bfSRobert Love u16 min_xid, u16 max_xid,
100252ff878cSVasu Dev bool (*match)(struct fc_frame *));
10033a3b42bfSRobert Love void fc_exch_mgr_free(struct fc_lport *);
10043a3b42bfSRobert Love void fc_exch_recv(struct fc_lport *, struct fc_frame *);
10051f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
10060cac937dSHannes Reinecke int fc_seq_send(struct fc_lport *lport, struct fc_seq *sp, struct fc_frame *fp);
10070ebaed17SHannes Reinecke int fc_seq_exch_abort(const struct fc_seq *, unsigned int timer_msec);
1008768c72ccSHannes Reinecke void fc_exch_done(struct fc_seq *sp);
100942e9a92fSRobert Love
101042e9a92fSRobert Love /*
101142e9a92fSRobert Love * Functions for fc_functions_template
101242e9a92fSRobert Love */
10133a3b42bfSRobert Love void fc_get_host_speed(struct Scsi_Host *);
10143a3b42bfSRobert Love void fc_get_host_port_state(struct Scsi_Host *);
10153a3b42bfSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
101642e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
101742e9a92fSRobert Love
101842e9a92fSRobert Love #endif /* _LIBFC_H_ */
1019