142e9a92fSRobert Love /* 242e9a92fSRobert Love * Copyright(c) 2007 Intel Corporation. All rights reserved. 342e9a92fSRobert Love * 442e9a92fSRobert Love * This program is free software; you can redistribute it and/or modify it 542e9a92fSRobert Love * under the terms and conditions of the GNU General Public License, 642e9a92fSRobert Love * version 2, as published by the Free Software Foundation. 742e9a92fSRobert Love * 842e9a92fSRobert Love * This program is distributed in the hope it will be useful, but WITHOUT 942e9a92fSRobert Love * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1042e9a92fSRobert Love * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 1142e9a92fSRobert Love * more details. 1242e9a92fSRobert Love * 1342e9a92fSRobert Love * You should have received a copy of the GNU General Public License along with 1442e9a92fSRobert Love * this program; if not, write to the Free Software Foundation, Inc., 1542e9a92fSRobert Love * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 1642e9a92fSRobert Love * 1742e9a92fSRobert Love * Maintained at www.Open-FCoE.org 1842e9a92fSRobert Love */ 1942e9a92fSRobert Love 2042e9a92fSRobert Love #ifndef _LIBFC_H_ 2142e9a92fSRobert Love #define _LIBFC_H_ 2242e9a92fSRobert Love 2342e9a92fSRobert Love #include <linux/timer.h> 2442e9a92fSRobert Love #include <linux/if.h> 25582b45bcSRobert Love #include <linux/percpu.h> 2642e9a92fSRobert Love 2742e9a92fSRobert Love #include <scsi/scsi_transport.h> 2842e9a92fSRobert Love #include <scsi/scsi_transport_fc.h> 29a51ab396SSteve Ma #include <scsi/scsi_bsg_fc.h> 3042e9a92fSRobert Love 3142e9a92fSRobert Love #include <scsi/fc/fc_fcp.h> 3242e9a92fSRobert Love #include <scsi/fc/fc_ns.h> 3342e9a92fSRobert Love #include <scsi/fc/fc_els.h> 3442e9a92fSRobert Love #include <scsi/fc/fc_gs.h> 3542e9a92fSRobert Love 3642e9a92fSRobert Love #include <scsi/fc_frame.h> 3742e9a92fSRobert Love 3896ad8464SJoe Eykholt #define FC_FC4_PROV_SIZE (FC_TYPE_FCP + 1) /* size of tables */ 3996ad8464SJoe Eykholt 4042e9a92fSRobert Love /* 4142e9a92fSRobert Love * libfc error codes 4242e9a92fSRobert Love */ 4342e9a92fSRobert Love #define FC_NO_ERR 0 /* no error */ 4442e9a92fSRobert Love #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 4542e9a92fSRobert Love #define FC_EX_CLOSED 2 /* Exchange closed */ 4642e9a92fSRobert Love 473a3b42bfSRobert Love /** 483a3b42bfSRobert Love * enum fc_lport_state - Local port states 493a3b42bfSRobert Love * @LPORT_ST_DISABLED: Disabled 503a3b42bfSRobert Love * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent 513a3b42bfSRobert Love * @LPORT_ST_DNS: Waiting for name server remote port to become ready 523a3b42bfSRobert Love * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent 533a3b42bfSRobert Love * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent 54ab593b18SJoe Eykholt * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent 553a3b42bfSRobert Love * @LPORT_ST_SCR: State Change Register (SCR) sent 563a3b42bfSRobert Love * @LPORT_ST_READY: Ready for use 573a3b42bfSRobert Love * @LPORT_ST_LOGO: Local port logout (LOGO) sent 583a3b42bfSRobert Love * @LPORT_ST_RESET: Local port reset 5942e9a92fSRobert Love */ 6042e9a92fSRobert Love enum fc_lport_state { 61b1d9fd55SJoe Eykholt LPORT_ST_DISABLED = 0, 6242e9a92fSRobert Love LPORT_ST_FLOGI, 6342e9a92fSRobert Love LPORT_ST_DNS, 64c9c7bd7aSChris Leech LPORT_ST_RNN_ID, 655baa17c3SChris Leech LPORT_ST_RSNN_NN, 66c9866a54SChris Leech LPORT_ST_RSPN_ID, 6742e9a92fSRobert Love LPORT_ST_RFT_ID, 68ab593b18SJoe Eykholt LPORT_ST_RFF_ID, 6942e9a92fSRobert Love LPORT_ST_SCR, 7042e9a92fSRobert Love LPORT_ST_READY, 7142e9a92fSRobert Love LPORT_ST_LOGO, 7242e9a92fSRobert Love LPORT_ST_RESET 7342e9a92fSRobert Love }; 7442e9a92fSRobert Love 7542e9a92fSRobert Love enum fc_disc_event { 7642e9a92fSRobert Love DISC_EV_NONE = 0, 7742e9a92fSRobert Love DISC_EV_SUCCESS, 7842e9a92fSRobert Love DISC_EV_FAILED 7942e9a92fSRobert Love }; 8042e9a92fSRobert Love 813a3b42bfSRobert Love /** 823a3b42bfSRobert Love * enum fc_rport_state - Remote port states 833a3b42bfSRobert Love * @RPORT_ST_INIT: Initialized 84a7b12a27SJoe Eykholt * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint 85a7b12a27SJoe Eykholt * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint 863a3b42bfSRobert Love * @RPORT_ST_PLOGI: Waiting for PLOGI completion 873a3b42bfSRobert Love * @RPORT_ST_PRLI: Waiting for PRLI completion 883a3b42bfSRobert Love * @RPORT_ST_RTV: Waiting for RTV completion 893a3b42bfSRobert Love * @RPORT_ST_READY: Ready for use 903a3b42bfSRobert Love * @RPORT_ST_ADISC: Discover Address sent 913a3b42bfSRobert Love * @RPORT_ST_DELETE: Remote port being deleted 923a3b42bfSRobert Love */ 9342e9a92fSRobert Love enum fc_rport_state { 943a3b42bfSRobert Love RPORT_ST_INIT, 95a7b12a27SJoe Eykholt RPORT_ST_FLOGI, 96a7b12a27SJoe Eykholt RPORT_ST_PLOGI_WAIT, 973a3b42bfSRobert Love RPORT_ST_PLOGI, 983a3b42bfSRobert Love RPORT_ST_PRLI, 993a3b42bfSRobert Love RPORT_ST_RTV, 1003a3b42bfSRobert Love RPORT_ST_READY, 1013a3b42bfSRobert Love RPORT_ST_ADISC, 1023a3b42bfSRobert Love RPORT_ST_DELETE, 10342e9a92fSRobert Love }; 10442e9a92fSRobert Love 10542e9a92fSRobert Love /** 10642e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 10742e9a92fSRobert Love * @lp: Fibre Channel host port instance 1089737e6a7SRobert Love * @peers: Node for list management during discovery and RSCN processing 1099737e6a7SRobert Love * @rport_work: Work struct for starting the rport state machine 1109737e6a7SRobert Love * @port_id: Port ID of the discovered port 11142e9a92fSRobert Love */ 11242e9a92fSRobert Love struct fc_disc_port { 11342e9a92fSRobert Love struct fc_lport *lp; 11442e9a92fSRobert Love struct list_head peers; 11542e9a92fSRobert Love struct work_struct rport_work; 1169737e6a7SRobert Love u32 port_id; 11742e9a92fSRobert Love }; 11842e9a92fSRobert Love 1193a3b42bfSRobert Love /** 1203a3b42bfSRobert Love * enum fc_rport_event - Remote port events 1213a3b42bfSRobert Love * @RPORT_EV_NONE: No event 1223a3b42bfSRobert Love * @RPORT_EV_READY: Remote port is ready for use 1233a3b42bfSRobert Love * @RPORT_EV_FAILED: State machine failed, remote port is not ready 1243a3b42bfSRobert Love * @RPORT_EV_STOP: Remote port has been stopped 1253a3b42bfSRobert Love * @RPORT_EV_LOGO: Remote port logout (LOGO) sent 1263a3b42bfSRobert Love */ 12742e9a92fSRobert Love enum fc_rport_event { 12842e9a92fSRobert Love RPORT_EV_NONE = 0, 1294c0f62b5SJoe Eykholt RPORT_EV_READY, 13042e9a92fSRobert Love RPORT_EV_FAILED, 13142e9a92fSRobert Love RPORT_EV_STOP, 13242e9a92fSRobert Love RPORT_EV_LOGO 13342e9a92fSRobert Love }; 13442e9a92fSRobert Love 1359fb9d328SJoe Eykholt struct fc_rport_priv; 1369fb9d328SJoe Eykholt 1373a3b42bfSRobert Love /** 1383a3b42bfSRobert Love * struct fc_rport_operations - Operations for a remote port 1393a3b42bfSRobert Love * @event_callback: Function to be called for remote port events 1403a3b42bfSRobert Love */ 14142e9a92fSRobert Love struct fc_rport_operations { 1429fb9d328SJoe Eykholt void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, 14342e9a92fSRobert Love enum fc_rport_event); 14442e9a92fSRobert Love }; 14542e9a92fSRobert Love 14642e9a92fSRobert Love /** 14742e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 1483a3b42bfSRobert Love * @local_port: The associated local port 1493a3b42bfSRobert Love * @rp_state: Indicates READY for I/O or DELETE when blocked 1509e9d0452SJoe Eykholt * @flags: REC and RETRY supported flags 1513a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1523a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1539e9d0452SJoe Eykholt */ 1549e9d0452SJoe Eykholt struct fc_rport_libfc_priv { 1559e9d0452SJoe Eykholt struct fc_lport *local_port; 1569e9d0452SJoe Eykholt enum fc_rport_state rp_state; 1579e9d0452SJoe Eykholt u16 flags; 1589e9d0452SJoe Eykholt #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 1599e9d0452SJoe Eykholt #define FC_RP_FLAGS_RETRY (1 << 1) 1604b2164d4SJoe Eykholt #define FC_RP_STARTED (1 << 2) 16175a2792dSBhanu Prakash Gollapudi #define FC_RP_FLAGS_CONF_REQ (1 << 3) 1629e9d0452SJoe Eykholt unsigned int e_d_tov; 1639e9d0452SJoe Eykholt unsigned int r_a_tov; 1649e9d0452SJoe Eykholt }; 1659e9d0452SJoe Eykholt 1669e9d0452SJoe Eykholt /** 1673a3b42bfSRobert Love * struct fc_rport_priv - libfc remote port and discovery info 1683a3b42bfSRobert Love * @local_port: The associated local port 1693a3b42bfSRobert Love * @rport: The FC transport remote port 1703a3b42bfSRobert Love * @kref: Reference counter 1713a3b42bfSRobert Love * @rp_state: Enumeration that tracks progress of PLOGI, PRLI, 1723a3b42bfSRobert Love * and RTV exchanges 1733a3b42bfSRobert Love * @ids: The remote port identifiers and roles 1744b2164d4SJoe Eykholt * @flags: STARTED, REC and RETRY_SUPPORTED flags 1753a3b42bfSRobert Love * @max_seq: Maximum number of concurrent sequences 1763a3b42bfSRobert Love * @disc_id: The discovery identifier 1773a3b42bfSRobert Love * @maxframe_size: The maximum frame size 1783a3b42bfSRobert Love * @retries: The retry count for the current state 179f034260dSJoe Eykholt * @major_retries: The retry count for the entire PLOGI/PRLI state machine 1803a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1813a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1823a3b42bfSRobert Love * @rp_mutex: The mutex that protects the remote port 1833a3b42bfSRobert Love * @retry_work: Handle for retries 1843a3b42bfSRobert Love * @event_callback: Callback when READY, FAILED or LOGO states complete 18596ad8464SJoe Eykholt * @prli_count: Count of open PRLI sessions in providers 18642e90414SJoe Eykholt * @rcu: Structure used for freeing in an RCU-safe manner 18742e9a92fSRobert Love */ 1889e9d0452SJoe Eykholt struct fc_rport_priv { 18942e9a92fSRobert Love struct fc_lport *local_port; 190f211fa51SJoe Eykholt struct fc_rport *rport; 191f211fa51SJoe Eykholt struct kref kref; 19242e9a92fSRobert Love enum fc_rport_state rp_state; 193f211fa51SJoe Eykholt struct fc_rport_identifiers ids; 19442e9a92fSRobert Love u16 flags; 19542e9a92fSRobert Love u16 max_seq; 1960f6c6149SJoe Eykholt u16 disc_id; 197f211fa51SJoe Eykholt u16 maxframe_size; 19842e9a92fSRobert Love unsigned int retries; 199f034260dSJoe Eykholt unsigned int major_retries; 20042e9a92fSRobert Love unsigned int e_d_tov; 20142e9a92fSRobert Love unsigned int r_a_tov; 20242e9a92fSRobert Love struct mutex rp_mutex; 20342e9a92fSRobert Love struct delayed_work retry_work; 20442e9a92fSRobert Love enum fc_rport_event event; 20542e9a92fSRobert Love struct fc_rport_operations *ops; 20642e9a92fSRobert Love struct list_head peers; 20742e9a92fSRobert Love struct work_struct event_work; 208f211fa51SJoe Eykholt u32 supported_classes; 20996ad8464SJoe Eykholt u16 prli_count; 21042e90414SJoe Eykholt struct rcu_head rcu; 21175a2792dSBhanu Prakash Gollapudi u16 sp_features; 21275a2792dSBhanu Prakash Gollapudi u8 spp_type; 21375a2792dSBhanu Prakash Gollapudi void (*lld_event_callback)(struct fc_lport *, 21475a2792dSBhanu Prakash Gollapudi struct fc_rport_priv *, 21575a2792dSBhanu Prakash Gollapudi enum fc_rport_event); 21642e9a92fSRobert Love }; 21742e9a92fSRobert Love 2183a3b42bfSRobert Love /** 2193a3b42bfSRobert Love * struct fcoe_dev_stats - fcoe stats structure 2203a3b42bfSRobert Love * @SecondsSinceLastReset: Seconds since the last reset 2213a3b42bfSRobert Love * @TxFrames: Number of transmitted frames 2223a3b42bfSRobert Love * @TxWords: Number of transmitted words 2233a3b42bfSRobert Love * @RxFrames: Number of received frames 2243a3b42bfSRobert Love * @RxWords: Number of received words 2253a3b42bfSRobert Love * @ErrorFrames: Number of received error frames 2263a3b42bfSRobert Love * @DumpedFrames: Number of dumped frames 2273a3b42bfSRobert Love * @LinkFailureCount: Number of link failures 2283a3b42bfSRobert Love * @LossOfSignalCount: Number for signal losses 2293a3b42bfSRobert Love * @InvalidTxWordCount: Number of invalid transmitted words 2303a3b42bfSRobert Love * @InvalidCRCCount: Number of invalid CRCs 2313a3b42bfSRobert Love * @InputRequests: Number of input requests 2323a3b42bfSRobert Love * @OutputRequests: Number of output requests 2333a3b42bfSRobert Love * @ControlRequests: Number of control requests 2345f0e385fSJoe Eykholt * @InputBytes: Number of received bytes 2355f0e385fSJoe Eykholt * @OutputBytes: Number of transmitted bytes 2366580bbd0SYi Zou * @VLinkFailureCount: Number of virtual link failures 2376580bbd0SYi Zou * @MissDiscAdvCount: Number of missing FIP discovery advertisement 23842e9a92fSRobert Love */ 23942e9a92fSRobert Love struct fcoe_dev_stats { 24042e9a92fSRobert Love u64 SecondsSinceLastReset; 24142e9a92fSRobert Love u64 TxFrames; 24242e9a92fSRobert Love u64 TxWords; 24342e9a92fSRobert Love u64 RxFrames; 24442e9a92fSRobert Love u64 RxWords; 24542e9a92fSRobert Love u64 ErrorFrames; 24642e9a92fSRobert Love u64 DumpedFrames; 24742e9a92fSRobert Love u64 LinkFailureCount; 24842e9a92fSRobert Love u64 LossOfSignalCount; 24942e9a92fSRobert Love u64 InvalidTxWordCount; 25042e9a92fSRobert Love u64 InvalidCRCCount; 25142e9a92fSRobert Love u64 InputRequests; 25242e9a92fSRobert Love u64 OutputRequests; 25342e9a92fSRobert Love u64 ControlRequests; 2545f0e385fSJoe Eykholt u64 InputBytes; 2555f0e385fSJoe Eykholt u64 OutputBytes; 2566580bbd0SYi Zou u64 VLinkFailureCount; 2576580bbd0SYi Zou u64 MissDiscAdvCount; 25842e9a92fSRobert Love }; 25942e9a92fSRobert Love 2603a3b42bfSRobert Love /** 2613a3b42bfSRobert Love * struct fc_seq_els_data - ELS data used for passing ELS specific responses 2623a3b42bfSRobert Love * @reason: The reason for rejection 26325985edcSLucas De Marchi * @explan: The explanation of the rejection 2643a3b42bfSRobert Love * 2653a3b42bfSRobert Love * Mainly used by the exchange manager layer. 26642e9a92fSRobert Love */ 26742e9a92fSRobert Love struct fc_seq_els_data { 26842e9a92fSRobert Love enum fc_els_rjt_reason reason; 26942e9a92fSRobert Love enum fc_els_rjt_explan explan; 27042e9a92fSRobert Love }; 27142e9a92fSRobert Love 2723a3b42bfSRobert Love /** 2733a3b42bfSRobert Love * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request) 2743a3b42bfSRobert Love * @lp: The associated local port 2753a3b42bfSRobert Love * @state: The state of the I/O 2763a3b42bfSRobert Love * @ref_cnt: Reference count 2773a3b42bfSRobert Love * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the 2783a3b42bfSRobert Love * host_lock if both are to be held at the same time) 2793a3b42bfSRobert Love * @cmd: The SCSI command (set and clear with the host_lock held) 2803a3b42bfSRobert Love * @list: Tracks queued commands (accessed with the host_lock held) 2813a3b42bfSRobert Love * @timer: The command timer 2823a3b42bfSRobert Love * @tm_done: Completion indicator 2833a3b42bfSRobert Love * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies) 2843a3b42bfSRobert Love * @data_len: The length of the data 2853a3b42bfSRobert Love * @cdb_cmd: The CDB command 2863a3b42bfSRobert Love * @xfer_len: The transfer length 2873a3b42bfSRobert Love * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange 2883a3b42bfSRobert Love * will be set here if DDP was setup) 2893a3b42bfSRobert Love * @xfer_contig_end: The offset into the buffer if the buffer is contiguous 2903a3b42bfSRobert Love * (Tx and Rx) 2913a3b42bfSRobert Love * @max_payload: The maximum payload size (in bytes) 2923a3b42bfSRobert Love * @io_status: SCSI result (upper 24 bits) 2933a3b42bfSRobert Love * @cdb_status: CDB status 2943a3b42bfSRobert Love * @status_code: FCP I/O status 2953a3b42bfSRobert Love * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun) 2963a3b42bfSRobert Love * @req_flags: Request flags (bit 0: read bit:1 write) 2973a3b42bfSRobert Love * @scsi_resid: SCSI residule length 2983a3b42bfSRobert Love * @rport: The remote port that the SCSI command is targeted at 2993a3b42bfSRobert Love * @seq_ptr: The sequence that will carry the SCSI command 3003a3b42bfSRobert Love * @recov_retry: Number of recovery retries 3013a3b42bfSRobert Love * @recov_seq: The sequence for REC or SRR 30242e9a92fSRobert Love */ 30342e9a92fSRobert Love struct fc_fcp_pkt { 3043a3b42bfSRobert Love spinlock_t scsi_pkt_lock; 305ed26cfecSVasu Dev atomic_t ref_cnt; 306ed26cfecSVasu Dev 307ed26cfecSVasu Dev /* SCSI command and data transfer information */ 308ed26cfecSVasu Dev u32 data_len; 3093a3b42bfSRobert Love 3103a3b42bfSRobert Love /* SCSI I/O related information */ 3113a3b42bfSRobert Love struct scsi_cmnd *cmd; 3123a3b42bfSRobert Love struct list_head list; 3133a3b42bfSRobert Love 314ed26cfecSVasu Dev /* Housekeeping information */ 315ed26cfecSVasu Dev struct fc_lport *lp; 316ed26cfecSVasu Dev u8 state; 31742e9a92fSRobert Love 3183a3b42bfSRobert Love /* SCSI/FCP return status */ 31942e9a92fSRobert Love u8 cdb_status; 3203a3b42bfSRobert Love u8 status_code; 32142e9a92fSRobert Love u8 scsi_comp_flags; 322ed26cfecSVasu Dev u32 io_status; 3233a3b42bfSRobert Love u32 req_flags; 3243a3b42bfSRobert Love u32 scsi_resid; 32542e9a92fSRobert Love 326ed26cfecSVasu Dev /* Transport related veriables */ 327ed26cfecSVasu Dev size_t xfer_len; 328ed26cfecSVasu Dev struct fcp_cmnd cdb_cmd; 329ed26cfecSVasu Dev u32 xfer_contig_end; 330ed26cfecSVasu Dev u16 max_payload; 331ed26cfecSVasu Dev u16 xfer_ddp; 332ed26cfecSVasu Dev 3333a3b42bfSRobert Love /* Associated structures */ 3343a3b42bfSRobert Love struct fc_rport *rport; 3353a3b42bfSRobert Love struct fc_seq *seq_ptr; 3363a3b42bfSRobert Love 337ed26cfecSVasu Dev /* Timeout/error related information */ 338ed26cfecSVasu Dev struct timer_list timer; 339ed26cfecSVasu Dev int wait_for_comp; 340ed26cfecSVasu Dev u32 recov_retry; 3413a3b42bfSRobert Love struct fc_seq *recov_seq; 342ed26cfecSVasu Dev struct completion tm_done; 343ed26cfecSVasu Dev } ____cacheline_aligned_in_smp; 34442e9a92fSRobert Love 34542e9a92fSRobert Love /* 34642e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 34742e9a92fSRobert Love * and Sequences 34842e9a92fSRobert Love * 34942e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 35042e9a92fSRobert Love * 35142e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 35242e9a92fSRobert Love */ 35342e9a92fSRobert Love 35442e9a92fSRobert Love struct fc_exch_mgr; 35596316099SVasu Dev struct fc_exch_mgr_anchor; 356e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 35742e9a92fSRobert Love 3583a3b42bfSRobert Love /** 3593a3b42bfSRobert Love * struct fc_seq - FC sequence 3603a3b42bfSRobert Love * @id: The sequence ID 3613a3b42bfSRobert Love * @ssb_stat: Status flags for the sequence status block (SSB) 3623a3b42bfSRobert Love * @cnt: Number of frames sent so far 3633a3b42bfSRobert Love * @rec_data: FC-4 value for REC 36442e9a92fSRobert Love */ 36542e9a92fSRobert Love struct fc_seq { 3663a3b42bfSRobert Love u8 id; 3673a3b42bfSRobert Love u16 ssb_stat; 3683a3b42bfSRobert Love u16 cnt; 3693a3b42bfSRobert Love u32 rec_data; 37042e9a92fSRobert Love }; 37142e9a92fSRobert Love 37242e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 37342e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 37442e9a92fSRobert Love 3753a3b42bfSRobert Love /** 3763a3b42bfSRobert Love * struct fc_exch - Fibre Channel Exchange 3773a3b42bfSRobert Love * @em: Exchange manager 3783a3b42bfSRobert Love * @pool: Exchange pool 3793a3b42bfSRobert Love * @state: The exchange's state 3803a3b42bfSRobert Love * @xid: The exchange ID 3813a3b42bfSRobert Love * @ex_list: Handle used by the EM to track free exchanges 3823a3b42bfSRobert Love * @ex_lock: Lock that protects the exchange 3833a3b42bfSRobert Love * @ex_refcnt: Reference count 3843a3b42bfSRobert Love * @timeout_work: Handle for timeout handler 3853a3b42bfSRobert Love * @lp: The local port that this exchange is on 3863a3b42bfSRobert Love * @oxid: Originator's exchange ID 3873a3b42bfSRobert Love * @rxid: Responder's exchange ID 3883a3b42bfSRobert Love * @oid: Originator's FCID 3893a3b42bfSRobert Love * @sid: Source FCID 3903a3b42bfSRobert Love * @did: Destination FCID 3913a3b42bfSRobert Love * @esb_stat: ESB exchange status 3923a3b42bfSRobert Love * @r_a_tov: Resouce allocation time out value (in msecs) 3933a3b42bfSRobert Love * @seq_id: The next sequence ID to use 394f60e12e9SJoe Eykholt * @encaps: encapsulation information for lower-level driver 3953a3b42bfSRobert Love * @f_ctl: F_CTL flags for the sequence 3963a3b42bfSRobert Love * @fh_type: The frame type 3973a3b42bfSRobert Love * @class: The class of service 3983a3b42bfSRobert Love * @seq: The sequence in use on this exchange 3993a3b42bfSRobert Love * @resp: Callback for responses on this exchange 4003a3b42bfSRobert Love * @destructor: Called when destroying the exchange 4013a3b42bfSRobert Love * @arg: Passed as a void pointer to the resp() callback 40242e9a92fSRobert Love * 40342e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 40442e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 40542e9a92fSRobert Love * seq_id 40642e9a92fSRobert Love * sequence allocation 40742e9a92fSRobert Love */ 40842e9a92fSRobert Love struct fc_exch { 4093a3b42bfSRobert Love struct fc_exch_mgr *em; 4103a3b42bfSRobert Love struct fc_exch_pool *pool; 4113a3b42bfSRobert Love u32 state; 4123a3b42bfSRobert Love u16 xid; 4133a3b42bfSRobert Love struct list_head ex_list; 4143a3b42bfSRobert Love spinlock_t ex_lock; 4153a3b42bfSRobert Love atomic_t ex_refcnt; 4163a3b42bfSRobert Love struct delayed_work timeout_work; 4173a3b42bfSRobert Love struct fc_lport *lp; 4183a3b42bfSRobert Love u16 oxid; 4193a3b42bfSRobert Love u16 rxid; 4203a3b42bfSRobert Love u32 oid; 4213a3b42bfSRobert Love u32 sid; 4223a3b42bfSRobert Love u32 did; 4233a3b42bfSRobert Love u32 esb_stat; 4243a3b42bfSRobert Love u32 r_a_tov; 4253a3b42bfSRobert Love u8 seq_id; 426f60e12e9SJoe Eykholt u8 encaps; 4273a3b42bfSRobert Love u32 f_ctl; 4283a3b42bfSRobert Love u8 fh_type; 4293a3b42bfSRobert Love enum fc_class class; 4303a3b42bfSRobert Love struct fc_seq seq; 4313a3b42bfSRobert Love 43242e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 43342e9a92fSRobert Love void *arg; 4343a3b42bfSRobert Love 4353a3b42bfSRobert Love void (*destructor)(struct fc_seq *, void *); 4363a3b42bfSRobert Love 43742e9a92fSRobert Love }; 43842e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 43942e9a92fSRobert Love 44042e9a92fSRobert Love 4413a3b42bfSRobert Love struct libfc_function_template { 44242e9a92fSRobert Love /* 44342e9a92fSRobert Love * Interface to send a FC frame 4440ae4d4aeSRobert Love * 4450ae4d4aeSRobert Love * STATUS: REQUIRED 44642e9a92fSRobert Love */ 4473a3b42bfSRobert Love int (*frame_send)(struct fc_lport *, struct fc_frame *); 44842e9a92fSRobert Love 44942e9a92fSRobert Love /* 4500ae4d4aeSRobert Love * Interface to send ELS/CT frames 4510ae4d4aeSRobert Love * 4520ae4d4aeSRobert Love * STATUS: OPTIONAL 45342e9a92fSRobert Love */ 4543a3b42bfSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, 4553a3b42bfSRobert Love struct fc_frame *, unsigned int op, 45642e9a92fSRobert Love void (*resp)(struct fc_seq *, 4573a3b42bfSRobert Love struct fc_frame *, void *arg), 45842e9a92fSRobert Love void *arg, u32 timer_msec); 45942e9a92fSRobert Love 46042e9a92fSRobert Love /* 46142e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 46242e9a92fSRobert Love * 46342e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 46442e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 46542e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 46642e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 46742e9a92fSRobert Love * as error using IS_ERR related macros. 46842e9a92fSRobert Love * 46942e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 47042e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 47142e9a92fSRobert Love * is about to free, this can be used by caller to free its 47242e9a92fSRobert Love * resources along with exchange free. 47342e9a92fSRobert Love * 47442e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 47542e9a92fSRobert Love * 47642e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 47742e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 47842e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 47942e9a92fSRobert Love * is registered by EM layer. 4800ae4d4aeSRobert Love * 4810ae4d4aeSRobert Love * STATUS: OPTIONAL 48242e9a92fSRobert Love */ 4833a3b42bfSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *, 4843a3b42bfSRobert Love void (*resp)(struct fc_seq *, 4853a3b42bfSRobert Love struct fc_frame *, 4863a3b42bfSRobert Love void *), 4873a3b42bfSRobert Love void (*destructor)(struct fc_seq *, 4883a3b42bfSRobert Love void *), 4893a3b42bfSRobert Love void *, unsigned int timer_msec); 49042e9a92fSRobert Love 49142e9a92fSRobert Love /* 492b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given 493b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive. 494b277d2aaSYi Zou * 495b277d2aaSYi Zou * STATUS: OPTIONAL 496b277d2aaSYi Zou */ 4973a3b42bfSRobert Love int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, 4983a3b42bfSRobert Love unsigned int); 499b277d2aaSYi Zou /* 500b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed 501b277d2aaSYi Zou * for the given exchange id. 502b277d2aaSYi Zou * 503b277d2aaSYi Zou * STATUS: OPTIONAL 504b277d2aaSYi Zou */ 5053a3b42bfSRobert Love int (*ddp_done)(struct fc_lport *, u16); 506b277d2aaSYi Zou /* 50733dc362bSYi Zou * Sets up the DDP context for a given exchange id on the given 50833dc362bSYi Zou * scatterlist if LLD supports DDP for FCoE target. 50933dc362bSYi Zou * 51033dc362bSYi Zou * STATUS: OPTIONAL 51133dc362bSYi Zou */ 51233dc362bSYi Zou int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *, 51333dc362bSYi Zou unsigned int); 51433dc362bSYi Zou /* 515b84056bfSYi Zou * Allow LLD to fill its own Link Error Status Block 516b84056bfSYi Zou * 517b84056bfSYi Zou * STATUS: OPTIONAL 518b84056bfSYi Zou */ 519b84056bfSYi Zou void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb); 520b84056bfSYi Zou /* 5210ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 5220ae4d4aeSRobert Love * 5230ae4d4aeSRobert Love * STATUS: OPTIONAL 52442e9a92fSRobert Love */ 5253a3b42bfSRobert Love int (*seq_send)(struct fc_lport *, struct fc_seq *, 5263a3b42bfSRobert Love struct fc_frame *); 52742e9a92fSRobert Love 52842e9a92fSRobert Love /* 52925985edcSLucas De Marchi * Send an ELS response using information from the received frame. 5300ae4d4aeSRobert Love * 5310ae4d4aeSRobert Love * STATUS: OPTIONAL 53242e9a92fSRobert Love */ 53392261156SJoe Eykholt void (*seq_els_rsp_send)(struct fc_frame *, enum fc_els_cmd, 5343a3b42bfSRobert Love struct fc_seq_els_data *); 53542e9a92fSRobert Love 53642e9a92fSRobert Love /* 53742e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 53842e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 53942e9a92fSRobert Love * 54042e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 54142e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 54242e9a92fSRobert Love * will be called with timeout error if no response to abort. 5430ae4d4aeSRobert Love * 5440ae4d4aeSRobert Love * STATUS: OPTIONAL 54542e9a92fSRobert Love */ 5463a3b42bfSRobert Love int (*seq_exch_abort)(const struct fc_seq *, 54742e9a92fSRobert Love unsigned int timer_msec); 54842e9a92fSRobert Love 54942e9a92fSRobert Love /* 55042e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 55142e9a92fSRobert Love * allocated for the related objects may be freed. 5520ae4d4aeSRobert Love * 5530ae4d4aeSRobert Love * STATUS: OPTIONAL 55442e9a92fSRobert Love */ 5553a3b42bfSRobert Love void (*exch_done)(struct fc_seq *); 55642e9a92fSRobert Love 55742e9a92fSRobert Love /* 55842e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 5590ae4d4aeSRobert Love * 5600ae4d4aeSRobert Love * STATUS: OPTIONAL 56142e9a92fSRobert Love */ 5623a3b42bfSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *); 56342e9a92fSRobert Love 56442e9a92fSRobert Love /* 5651a5c2d7eSJoe Eykholt * Set a response handler for the exchange of the sequence. 5661a5c2d7eSJoe Eykholt * 5671a5c2d7eSJoe Eykholt * STATUS: OPTIONAL 5681a5c2d7eSJoe Eykholt */ 5691a5c2d7eSJoe Eykholt void (*seq_set_resp)(struct fc_seq *sp, 5701a5c2d7eSJoe Eykholt void (*resp)(struct fc_seq *, struct fc_frame *, 5711a5c2d7eSJoe Eykholt void *), 5721a5c2d7eSJoe Eykholt void *arg); 5731a5c2d7eSJoe Eykholt 5741a5c2d7eSJoe Eykholt /* 575239e8104SJoe Eykholt * Assign a sequence for an incoming request frame. 576239e8104SJoe Eykholt * 577239e8104SJoe Eykholt * STATUS: OPTIONAL 578239e8104SJoe Eykholt */ 579239e8104SJoe Eykholt struct fc_seq *(*seq_assign)(struct fc_lport *, struct fc_frame *); 580239e8104SJoe Eykholt 581239e8104SJoe Eykholt /* 58262bdb645SJoe Eykholt * Release the reference on the sequence returned by seq_assign(). 58362bdb645SJoe Eykholt * 58462bdb645SJoe Eykholt * STATUS: OPTIONAL 58562bdb645SJoe Eykholt */ 58662bdb645SJoe Eykholt void (*seq_release)(struct fc_seq *); 58762bdb645SJoe Eykholt 58862bdb645SJoe Eykholt /* 58942e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 59042e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 59142e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 5920ae4d4aeSRobert Love * 5930ae4d4aeSRobert Love * STATUS: OPTIONAL 59442e9a92fSRobert Love */ 5953a3b42bfSRobert Love void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); 59642e9a92fSRobert Love 5970ae4d4aeSRobert Love /* 5980ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 5990ae4d4aeSRobert Love * 6000ae4d4aeSRobert Love * STATUS: OPTIONAL 60142e9a92fSRobert Love */ 6020ae4d4aeSRobert Love void (*rport_flush_queue)(void); 60342e9a92fSRobert Love 60442e9a92fSRobert Love /* 6050ae4d4aeSRobert Love * Receive a frame for a local port. 6060ae4d4aeSRobert Love * 6070ae4d4aeSRobert Love * STATUS: OPTIONAL 60842e9a92fSRobert Love */ 60992261156SJoe Eykholt void (*lport_recv)(struct fc_lport *, struct fc_frame *); 61042e9a92fSRobert Love 6110ae4d4aeSRobert Love /* 6120ae4d4aeSRobert Love * Reset the local port. 6130ae4d4aeSRobert Love * 6140ae4d4aeSRobert Love * STATUS: OPTIONAL 61542e9a92fSRobert Love */ 6160ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 61742e9a92fSRobert Love 61842e9a92fSRobert Love /* 619093bb6a2SJoe Eykholt * Set the local port FC_ID. 620093bb6a2SJoe Eykholt * 621093bb6a2SJoe Eykholt * This may be provided by the LLD to allow it to be 622093bb6a2SJoe Eykholt * notified when the local port is assigned a FC-ID. 623093bb6a2SJoe Eykholt * 624093bb6a2SJoe Eykholt * The frame, if non-NULL, is the incoming frame with the 625093bb6a2SJoe Eykholt * FLOGI LS_ACC or FLOGI, and may contain the granted MAC 626093bb6a2SJoe Eykholt * address for the LLD. The frame pointer may be NULL if 627093bb6a2SJoe Eykholt * no MAC is associated with this assignment (LOGO or PLOGI). 628093bb6a2SJoe Eykholt * 629093bb6a2SJoe Eykholt * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid. 630093bb6a2SJoe Eykholt * 631093bb6a2SJoe Eykholt * Note: this is called with the local port mutex held. 632093bb6a2SJoe Eykholt * 633093bb6a2SJoe Eykholt * STATUS: OPTIONAL 634093bb6a2SJoe Eykholt */ 635093bb6a2SJoe Eykholt void (*lport_set_port_id)(struct fc_lport *, u32 port_id, 636093bb6a2SJoe Eykholt struct fc_frame *); 637093bb6a2SJoe Eykholt 638093bb6a2SJoe Eykholt /* 6399737e6a7SRobert Love * Create a remote port with a given port ID 6409737e6a7SRobert Love * 6419737e6a7SRobert Love * STATUS: OPTIONAL 6425101ff99SRobert Love */ 6439737e6a7SRobert Love struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 6445101ff99SRobert Love 6455101ff99SRobert Love /* 64642e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 64742e9a92fSRobert Love * This function will issue the following commands to the N_Port 64842e9a92fSRobert Love * identified by the FC ID provided. 64942e9a92fSRobert Love * 65042e9a92fSRobert Love * - PLOGI 65142e9a92fSRobert Love * - PRLI 65242e9a92fSRobert Love * - RTV 6530ae4d4aeSRobert Love * 6540ae4d4aeSRobert Love * STATUS: OPTIONAL 65542e9a92fSRobert Love */ 6569fb9d328SJoe Eykholt int (*rport_login)(struct fc_rport_priv *); 65742e9a92fSRobert Love 65842e9a92fSRobert Love /* 65942e9a92fSRobert Love * Logoff, and remove the rport from the transport if 66042e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 6610ae4d4aeSRobert Love * 6620ae4d4aeSRobert Love * STATUS: OPTIONAL 66342e9a92fSRobert Love */ 6649fb9d328SJoe Eykholt int (*rport_logoff)(struct fc_rport_priv *); 66542e9a92fSRobert Love 66642e9a92fSRobert Love /* 66725985edcSLucas De Marchi * Receive a request from a remote port. 6680ae4d4aeSRobert Love * 6690ae4d4aeSRobert Love * STATUS: OPTIONAL 67042e9a92fSRobert Love */ 67192261156SJoe Eykholt void (*rport_recv_req)(struct fc_lport *, struct fc_frame *); 67242e9a92fSRobert Love 6730ae4d4aeSRobert Love /* 6740ae4d4aeSRobert Love * lookup an rport by it's port ID. 6750ae4d4aeSRobert Love * 6760ae4d4aeSRobert Love * STATUS: OPTIONAL 67742e9a92fSRobert Love */ 6789fb9d328SJoe Eykholt struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 67942e9a92fSRobert Love 68042e9a92fSRobert Love /* 681f211fa51SJoe Eykholt * Destroy an rport after final kref_put(). 682f211fa51SJoe Eykholt * The argument is a pointer to the kref inside the fc_rport_priv. 683f211fa51SJoe Eykholt */ 684f211fa51SJoe Eykholt void (*rport_destroy)(struct kref *); 685f211fa51SJoe Eykholt 686f211fa51SJoe Eykholt /* 68775a2792dSBhanu Prakash Gollapudi * Callback routine after the remote port is logged in 68875a2792dSBhanu Prakash Gollapudi * 68975a2792dSBhanu Prakash Gollapudi * STATUS: OPTIONAL 69075a2792dSBhanu Prakash Gollapudi */ 69175a2792dSBhanu Prakash Gollapudi void (*rport_event_callback)(struct fc_lport *, 69275a2792dSBhanu Prakash Gollapudi struct fc_rport_priv *, 69375a2792dSBhanu Prakash Gollapudi enum fc_rport_event); 69475a2792dSBhanu Prakash Gollapudi 69575a2792dSBhanu Prakash Gollapudi /* 69642e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 69742e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 69842e9a92fSRobert Love * 69942e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 70042e9a92fSRobert Love * 7010ae4d4aeSRobert Love * STATUS: OPTIONAL 70242e9a92fSRobert Love */ 7033a3b42bfSRobert Love int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, 7043a3b42bfSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, 7053a3b42bfSRobert Love void *)); 70642e9a92fSRobert Love 70742e9a92fSRobert Love /* 70825985edcSLucas De Marchi * Cleanup the FCP layer, used during link down and reset 7090ae4d4aeSRobert Love * 7100ae4d4aeSRobert Love * STATUS: OPTIONAL 71142e9a92fSRobert Love */ 7123a3b42bfSRobert Love void (*fcp_cleanup)(struct fc_lport *); 71342e9a92fSRobert Love 71442e9a92fSRobert Love /* 71542e9a92fSRobert Love * Abort all I/O on a local port 7160ae4d4aeSRobert Love * 7170ae4d4aeSRobert Love * STATUS: OPTIONAL 71842e9a92fSRobert Love */ 7193a3b42bfSRobert Love void (*fcp_abort_io)(struct fc_lport *); 72042e9a92fSRobert Love 7210ae4d4aeSRobert Love /* 7220ae4d4aeSRobert Love * Receive a request for the discovery layer. 7230ae4d4aeSRobert Love * 7240ae4d4aeSRobert Love * STATUS: OPTIONAL 72542e9a92fSRobert Love */ 72692261156SJoe Eykholt void (*disc_recv_req)(struct fc_lport *, struct fc_frame *); 72742e9a92fSRobert Love 72842e9a92fSRobert Love /* 72942e9a92fSRobert Love * Start discovery for a local port. 7300ae4d4aeSRobert Love * 7310ae4d4aeSRobert Love * STATUS: OPTIONAL 73242e9a92fSRobert Love */ 73342e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 73442e9a92fSRobert Love enum fc_disc_event), 73542e9a92fSRobert Love struct fc_lport *); 73642e9a92fSRobert Love 73742e9a92fSRobert Love /* 73842e9a92fSRobert Love * Stop discovery for a given lport. This will remove 73942e9a92fSRobert Love * all discovered rports 7400ae4d4aeSRobert Love * 7410ae4d4aeSRobert Love * STATUS: OPTIONAL 74242e9a92fSRobert Love */ 74342e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 74442e9a92fSRobert Love 74542e9a92fSRobert Love /* 74642e9a92fSRobert Love * Stop discovery for a given lport. This will block 74742e9a92fSRobert Love * until all discovered rports are deleted from the 74842e9a92fSRobert Love * FC transport class 7490ae4d4aeSRobert Love * 7500ae4d4aeSRobert Love * STATUS: OPTIONAL 75142e9a92fSRobert Love */ 75242e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 75342e9a92fSRobert Love }; 75442e9a92fSRobert Love 7553a3b42bfSRobert Love /** 7563a3b42bfSRobert Love * struct fc_disc - Discovery context 7573a3b42bfSRobert Love * @retry_count: Number of retries 7583a3b42bfSRobert Love * @pending: 1 if discovery is pending, 0 if not 759c531b9b4SBhanu Prakash Gollapudi * @requested: 1 if discovery has been requested, 0 if not 7603a3b42bfSRobert Love * @seq_count: Number of sequences used for discovery 7613a3b42bfSRobert Love * @buf_len: Length of the discovery buffer 7623a3b42bfSRobert Love * @disc_id: Discovery ID 7633a3b42bfSRobert Love * @rports: List of discovered remote ports 7640685230cSJoe Eykholt * @priv: Private pointer for use by discovery code 7653a3b42bfSRobert Love * @disc_mutex: Mutex that protects the discovery context 7663a3b42bfSRobert Love * @partial_buf: Partial name buffer (if names are returned 7673a3b42bfSRobert Love * in multiple frames) 7683a3b42bfSRobert Love * @disc_work: handle for delayed work context 7693a3b42bfSRobert Love * @disc_callback: Callback routine called when discovery completes 7703a3b42bfSRobert Love */ 77142e9a92fSRobert Love struct fc_disc { 77242e9a92fSRobert Love unsigned char retry_count; 77342e9a92fSRobert Love unsigned char pending; 77442e9a92fSRobert Love unsigned char requested; 77542e9a92fSRobert Love unsigned short seq_count; 77642e9a92fSRobert Love unsigned char buf_len; 7770f6c6149SJoe Eykholt u16 disc_id; 77842e9a92fSRobert Love 77942e9a92fSRobert Love struct list_head rports; 7800685230cSJoe Eykholt void *priv; 78142e9a92fSRobert Love struct mutex disc_mutex; 7823a3b42bfSRobert Love struct fc_gpn_ft_resp partial_buf; 78342e9a92fSRobert Love struct delayed_work disc_work; 7843a3b42bfSRobert Love 7853a3b42bfSRobert Love void (*disc_callback)(struct fc_lport *, 7863a3b42bfSRobert Love enum fc_disc_event); 78742e9a92fSRobert Love }; 78842e9a92fSRobert Love 78970d53b04SJoe Eykholt /* 79070d53b04SJoe Eykholt * Local port notifier and events. 79170d53b04SJoe Eykholt */ 79270d53b04SJoe Eykholt extern struct blocking_notifier_head fc_lport_notifier_head; 79370d53b04SJoe Eykholt enum fc_lport_event { 79470d53b04SJoe Eykholt FC_LPORT_EV_ADD, 79570d53b04SJoe Eykholt FC_LPORT_EV_DEL, 79670d53b04SJoe Eykholt }; 79770d53b04SJoe Eykholt 7983a3b42bfSRobert Love /** 7993a3b42bfSRobert Love * struct fc_lport - Local port 8003a3b42bfSRobert Love * @host: The SCSI host associated with a local port 8013a3b42bfSRobert Love * @ema_list: Exchange manager anchor list 8023a3b42bfSRobert Love * @dns_rdata: The directory server remote port 8033a3b42bfSRobert Love * @ptp_rdata: Point to point remote port 8043a3b42bfSRobert Love * @scsi_priv: FCP layer internal data 8053a3b42bfSRobert Love * @disc: Discovery context 8063a3b42bfSRobert Love * @vports: Child vports if N_Port 8073a3b42bfSRobert Love * @vport: Parent vport if VN_Port 8083a3b42bfSRobert Love * @tt: Libfc function template 8093a3b42bfSRobert Love * @link_up: Link state (1 = link up, 0 = link down) 8103a3b42bfSRobert Love * @qfull: Queue state (1 queue is full, 0 queue is not full) 8113a3b42bfSRobert Love * @state: Identifies the state 8123a3b42bfSRobert Love * @boot_time: Timestamp indicating when the local port came online 8133a3b42bfSRobert Love * @host_stats: SCSI host statistics 8143a3b42bfSRobert Love * @dev_stats: FCoE device stats (TODO: libfc should not be 8153a3b42bfSRobert Love * FCoE aware) 8163a3b42bfSRobert Love * @retry_count: Number of retries in the current state 8177b2787ecSRobert Love * @port_id: FC Port ID 8183a3b42bfSRobert Love * @wwpn: World Wide Port Name 8193a3b42bfSRobert Love * @wwnn: World Wide Node Name 8203a3b42bfSRobert Love * @service_params: Common service parameters 8213a3b42bfSRobert Love * @e_d_tov: Error detection timeout value 8223a3b42bfSRobert Love * @r_a_tov: Resouce allocation timeout value 8233a3b42bfSRobert Love * @rnid_gen: RNID information 8243a3b42bfSRobert Love * @sg_supp: Indicates if scatter gather is supported 8253a3b42bfSRobert Love * @seq_offload: Indicates if sequence offload is supported 8263a3b42bfSRobert Love * @crc_offload: Indicates if CRC offload is supported 8273a3b42bfSRobert Love * @lro_enabled: Indicates if large receive offload is supported 8283a3b42bfSRobert Love * @does_npiv: Supports multiple vports 8293a3b42bfSRobert Love * @npiv_enabled: Switch/fabric allows NPIV 8303a3b42bfSRobert Love * @mfs: The maximum Fibre Channel payload size 8313a3b42bfSRobert Love * @max_retry_count: The maximum retry attempts 8323a3b42bfSRobert Love * @max_rport_retry_count: The maximum remote port retry attempts 833f90377abSJoe Eykholt * @rport_priv_size: Size needed by driver after struct fc_rport_priv 8343a3b42bfSRobert Love * @lro_xid: The maximum XID for LRO 8353a3b42bfSRobert Love * @lso_max: The maximum large offload send size 8363a3b42bfSRobert Love * @fcts: FC-4 type mask 8373a3b42bfSRobert Love * @lp_mutex: Mutex to protect the local port 83870d53b04SJoe Eykholt * @list: Linkage on list of vport peers 8393a3b42bfSRobert Love * @retry_work: Handle to local port for delayed retry context 840baf9fdf0SJoe Eykholt * @prov: Pointers available for use by passive FC-4 providers 84170d53b04SJoe Eykholt * @lport_list: Linkage on module-wide list of local ports 8423a3b42bfSRobert Love */ 84342e9a92fSRobert Love struct fc_lport { 84442e9a92fSRobert Love /* Associations */ 84542e9a92fSRobert Love struct Scsi_Host *host; 84696316099SVasu Dev struct list_head ema_list; 8473a3b42bfSRobert Love struct fc_rport_priv *dns_rdata; 8483a3b42bfSRobert Love struct fc_rport_priv *ptp_rdata; 84942e9a92fSRobert Love void *scsi_priv; 85042e9a92fSRobert Love struct fc_disc disc; 85142e9a92fSRobert Love 8523a3b42bfSRobert Love /* Virtual port information */ 8533a3b42bfSRobert Love struct list_head vports; 8543a3b42bfSRobert Love struct fc_vport *vport; 8553a3b42bfSRobert Love 85642e9a92fSRobert Love /* Operational Information */ 85742e9a92fSRobert Love struct libfc_function_template tt; 858bc0e17f6SVasu Dev u8 link_up; 859bc0e17f6SVasu Dev u8 qfull; 86042e9a92fSRobert Love enum fc_lport_state state; 86142e9a92fSRobert Love unsigned long boot_time; 86242e9a92fSRobert Love struct fc_host_statistics host_stats; 863582b45bcSRobert Love struct fcoe_dev_stats *dev_stats; 86442e9a92fSRobert Love u8 retry_count; 86542e9a92fSRobert Love 8663a3b42bfSRobert Love /* Fabric information */ 8677b2787ecSRobert Love u32 port_id; 8683a3b42bfSRobert Love u64 wwpn; 8693a3b42bfSRobert Love u64 wwnn; 87042e9a92fSRobert Love unsigned int service_params; 87142e9a92fSRobert Love unsigned int e_d_tov; 87242e9a92fSRobert Love unsigned int r_a_tov; 8733a3b42bfSRobert Love struct fc_els_rnid_gen rnid_gen; 8743a3b42bfSRobert Love 8753a3b42bfSRobert Love /* Capabilities */ 8763a3b42bfSRobert Love u32 sg_supp:1; 8773a3b42bfSRobert Love u32 seq_offload:1; 8783a3b42bfSRobert Love u32 crc_offload:1; 8793a3b42bfSRobert Love u32 lro_enabled:1; 8803a3b42bfSRobert Love u32 does_npiv:1; 8813a3b42bfSRobert Love u32 npiv_enabled:1; 8823726f358SJoe Eykholt u32 point_to_multipoint:1; 8833a3b42bfSRobert Love u32 mfs; 88442e9a92fSRobert Love u8 max_retry_count; 885a3666955SAbhijeet Joglekar u8 max_rport_retry_count; 886f90377abSJoe Eykholt u16 rport_priv_size; 88742e9a92fSRobert Love u16 link_speed; 88842e9a92fSRobert Love u16 link_supported_speeds; 8893a3b42bfSRobert Love u16 lro_xid; 8903a3b42bfSRobert Love unsigned int lso_max; 8913a3b42bfSRobert Love struct fc_ns_fts fcts; 89242e9a92fSRobert Love 89342e9a92fSRobert Love /* Miscellaneous */ 8943a3b42bfSRobert Love struct mutex lp_mutex; 8953a3b42bfSRobert Love struct list_head list; 89642e9a92fSRobert Love struct delayed_work retry_work; 897baf9fdf0SJoe Eykholt void *prov[FC_FC4_PROV_SIZE]; 89870d53b04SJoe Eykholt struct list_head lport_list; 89942e9a92fSRobert Love }; 90042e9a92fSRobert Love 90196ad8464SJoe Eykholt /** 90296ad8464SJoe Eykholt * struct fc4_prov - FC-4 provider registration 90396ad8464SJoe Eykholt * @prli: Handler for incoming PRLI 90496ad8464SJoe Eykholt * @prlo: Handler for session reset 90596ad8464SJoe Eykholt * @recv: Handler for incoming request 90696ad8464SJoe Eykholt * @module: Pointer to module. May be NULL. 90796ad8464SJoe Eykholt */ 90896ad8464SJoe Eykholt struct fc4_prov { 90996ad8464SJoe Eykholt int (*prli)(struct fc_rport_priv *, u32 spp_len, 91096ad8464SJoe Eykholt const struct fc_els_spp *spp_in, 91196ad8464SJoe Eykholt struct fc_els_spp *spp_out); 91296ad8464SJoe Eykholt void (*prlo)(struct fc_rport_priv *); 91396ad8464SJoe Eykholt void (*recv)(struct fc_lport *, struct fc_frame *); 91496ad8464SJoe Eykholt struct module *module; 91596ad8464SJoe Eykholt }; 91696ad8464SJoe Eykholt 91796ad8464SJoe Eykholt /* 91896ad8464SJoe Eykholt * Register FC-4 provider with libfc. 91996ad8464SJoe Eykholt */ 92096ad8464SJoe Eykholt int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *); 92196ad8464SJoe Eykholt void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *); 92296ad8464SJoe Eykholt 92334f42a07SRobert Love /* 92442e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 92542e9a92fSRobert Love *****************************/ 9263a3b42bfSRobert Love 9273a3b42bfSRobert Love /** 9283a3b42bfSRobert Love * fc_lport_test_ready() - Determine if a local port is in the READY state 9293a3b42bfSRobert Love * @lport: The local port to test 9303a3b42bfSRobert Love */ 9313a3b42bfSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lport) 93242e9a92fSRobert Love { 9333a3b42bfSRobert Love return lport->state == LPORT_ST_READY; 93442e9a92fSRobert Love } 93542e9a92fSRobert Love 9363a3b42bfSRobert Love /** 9373a3b42bfSRobert Love * fc_set_wwnn() - Set the World Wide Node Name of a local port 9383a3b42bfSRobert Love * @lport: The local port whose WWNN is to be set 9393a3b42bfSRobert Love * @wwnn: The new WWNN 9403a3b42bfSRobert Love */ 9413a3b42bfSRobert Love static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) 94242e9a92fSRobert Love { 9433a3b42bfSRobert Love lport->wwnn = wwnn; 94442e9a92fSRobert Love } 94542e9a92fSRobert Love 9463a3b42bfSRobert Love /** 9473a3b42bfSRobert Love * fc_set_wwpn() - Set the World Wide Port Name of a local port 9483a3b42bfSRobert Love * @lport: The local port whose WWPN is to be set 9493a3b42bfSRobert Love * @wwnn: The new WWPN 9503a3b42bfSRobert Love */ 9513a3b42bfSRobert Love static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) 95242e9a92fSRobert Love { 9533a3b42bfSRobert Love lport->wwpn = wwnn; 95442e9a92fSRobert Love } 95542e9a92fSRobert Love 9563a3b42bfSRobert Love /** 9573a3b42bfSRobert Love * fc_lport_state_enter() - Change a local port's state 9583a3b42bfSRobert Love * @lport: The local port whose state is to change 9593a3b42bfSRobert Love * @state: The new state 9603a3b42bfSRobert Love */ 9613a3b42bfSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lport, 96242e9a92fSRobert Love enum fc_lport_state state) 96342e9a92fSRobert Love { 9643a3b42bfSRobert Love if (state != lport->state) 9653a3b42bfSRobert Love lport->retry_count = 0; 9663a3b42bfSRobert Love lport->state = state; 96742e9a92fSRobert Love } 96842e9a92fSRobert Love 9693a3b42bfSRobert Love /** 9703a3b42bfSRobert Love * fc_lport_init_stats() - Allocate per-CPU statistics for a local port 9713a3b42bfSRobert Love * @lport: The local port whose statistics are to be initialized 9723a3b42bfSRobert Love */ 9733a3b42bfSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lport) 974582b45bcSRobert Love { 9753a3b42bfSRobert Love lport->dev_stats = alloc_percpu(struct fcoe_dev_stats); 9763a3b42bfSRobert Love if (!lport->dev_stats) 977582b45bcSRobert Love return -ENOMEM; 978582b45bcSRobert Love return 0; 979582b45bcSRobert Love } 980582b45bcSRobert Love 9813a3b42bfSRobert Love /** 9823a3b42bfSRobert Love * fc_lport_free_stats() - Free memory for a local port's statistics 9833a3b42bfSRobert Love * @lport: The local port whose statistics are to be freed 9843a3b42bfSRobert Love */ 9853a3b42bfSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lport) 986582b45bcSRobert Love { 9873a3b42bfSRobert Love free_percpu(lport->dev_stats); 988a0a25da2SVasu Dev } 989a0a25da2SVasu Dev 990a0a25da2SVasu Dev /** 9913a3b42bfSRobert Love * lport_priv() - Return the private data from a local port 9923a3b42bfSRobert Love * @lport: The local port whose private data is to be retreived 9933a3b42bfSRobert Love */ 9943a3b42bfSRobert Love static inline void *lport_priv(const struct fc_lport *lport) 9953a3b42bfSRobert Love { 9963a3b42bfSRobert Love return (void *)(lport + 1); 9973a3b42bfSRobert Love } 9983a3b42bfSRobert Love 9993a3b42bfSRobert Love /** 10003a3b42bfSRobert Love * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and 10013a3b42bfSRobert Love * LLD private data 10023a3b42bfSRobert Love * @sht: The SCSI host template 10033a3b42bfSRobert Love * @priv_size: Size of private data 1004a0a25da2SVasu Dev * 100586221969SChris Leech * Returns: libfc lport 1006a0a25da2SVasu Dev */ 100786221969SChris Leech static inline struct fc_lport * 1008a0a25da2SVasu Dev libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 1009a0a25da2SVasu Dev { 101086221969SChris Leech struct fc_lport *lport; 101186221969SChris Leech struct Scsi_Host *shost; 101286221969SChris Leech 101386221969SChris Leech shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 101486221969SChris Leech if (!shost) 101586221969SChris Leech return NULL; 101686221969SChris Leech lport = shost_priv(shost); 101786221969SChris Leech lport->host = shost; 101886221969SChris Leech INIT_LIST_HEAD(&lport->ema_list); 1019174e1ebfSChris Leech INIT_LIST_HEAD(&lport->vports); 102086221969SChris Leech return lport; 1021a0a25da2SVasu Dev } 102242e9a92fSRobert Love 102334f42a07SRobert Love /* 10243a3b42bfSRobert Love * FC_FCP HELPER FUNCTIONS 10253a3b42bfSRobert Love *****************************/ 10263a3b42bfSRobert Love static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 10273a3b42bfSRobert Love { 10283a3b42bfSRobert Love if (fsp && fsp->cmd) 10293a3b42bfSRobert Love return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 10303a3b42bfSRobert Love return false; 10313a3b42bfSRobert Love } 10323a3b42bfSRobert Love 10333a3b42bfSRobert Love /* 103442e9a92fSRobert Love * LOCAL PORT LAYER 103542e9a92fSRobert Love *****************************/ 10363a3b42bfSRobert Love int fc_lport_init(struct fc_lport *); 10373a3b42bfSRobert Love int fc_lport_destroy(struct fc_lport *); 10383a3b42bfSRobert Love int fc_fabric_logoff(struct fc_lport *); 10393a3b42bfSRobert Love int fc_fabric_login(struct fc_lport *); 10408faecddbSChris Leech void __fc_linkup(struct fc_lport *); 104142e9a92fSRobert Love void fc_linkup(struct fc_lport *); 10428faecddbSChris Leech void __fc_linkdown(struct fc_lport *); 104342e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 10443a3b42bfSRobert Love void fc_vport_setlink(struct fc_lport *); 10453a3b42bfSRobert Love void fc_vports_linkchange(struct fc_lport *); 104642e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 104742e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 10483a3b42bfSRobert Love int fc_set_mfs(struct fc_lport *, u32 mfs); 10493a3b42bfSRobert Love struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); 10503a3b42bfSRobert Love struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); 10513a3b42bfSRobert Love int fc_lport_bsg_request(struct fc_bsg_job *); 10523726f358SJoe Eykholt void fc_lport_set_local_id(struct fc_lport *, u32 port_id); 105370d53b04SJoe Eykholt void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *); 1054a51ab396SSteve Ma 1055a51ab396SSteve Ma /* 105642e9a92fSRobert Love * REMOTE PORT LAYER 105742e9a92fSRobert Love *****************************/ 10583a3b42bfSRobert Love int fc_rport_init(struct fc_lport *); 10593a3b42bfSRobert Love void fc_rport_terminate_io(struct fc_rport *); 106042e9a92fSRobert Love 106134f42a07SRobert Love /* 106242e9a92fSRobert Love * DISCOVERY LAYER 106342e9a92fSRobert Love *****************************/ 10643a3b42bfSRobert Love int fc_disc_init(struct fc_lport *); 106542e9a92fSRobert Love 10660685230cSJoe Eykholt static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc) 10670685230cSJoe Eykholt { 10680685230cSJoe Eykholt return container_of(disc, struct fc_lport, disc); 10690685230cSJoe Eykholt } 10700685230cSJoe Eykholt 107134f42a07SRobert Love /* 10723a3b42bfSRobert Love * FCP LAYER 107342e9a92fSRobert Love *****************************/ 107442e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 107542e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 107642e9a92fSRobert Love 107734f42a07SRobert Love /* 10783a3b42bfSRobert Love * SCSI INTERACTION LAYER 10793a3b42bfSRobert Love *****************************/ 1080f281233dSJeff Garzik int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *); 10813a3b42bfSRobert Love int fc_eh_abort(struct scsi_cmnd *); 10823a3b42bfSRobert Love int fc_eh_device_reset(struct scsi_cmnd *); 10833a3b42bfSRobert Love int fc_eh_host_reset(struct scsi_cmnd *); 10843a3b42bfSRobert Love int fc_slave_alloc(struct scsi_device *); 10853a3b42bfSRobert Love int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason); 10863a3b42bfSRobert Love int fc_change_queue_type(struct scsi_device *, int tag_type); 10873a3b42bfSRobert Love 10883a3b42bfSRobert Love /* 108942e9a92fSRobert Love * ELS/CT interface 109042e9a92fSRobert Love *****************************/ 10913a3b42bfSRobert Love int fc_elsct_init(struct fc_lport *); 10923a3b42bfSRobert Love struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, 10933a3b42bfSRobert Love struct fc_frame *, 109411b56188SChris Leech unsigned int op, 109511b56188SChris Leech void (*resp)(struct fc_seq *, 10963a3b42bfSRobert Love struct fc_frame *, 109711b56188SChris Leech void *arg), 109811b56188SChris Leech void *arg, u32 timer_msec); 109911b56188SChris Leech void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 110011b56188SChris Leech void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 110124f089e2SJoe Eykholt void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *, 110224f089e2SJoe Eykholt enum fc_rctl, u32 parm_offset); 110324f089e2SJoe Eykholt void fc_fill_hdr(struct fc_frame *, const struct fc_frame *, 110424f089e2SJoe Eykholt enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset); 110542e9a92fSRobert Love 110642e9a92fSRobert Love 110734f42a07SRobert Love /* 110842e9a92fSRobert Love * EXCHANGE MANAGER LAYER 110942e9a92fSRobert Love *****************************/ 11103a3b42bfSRobert Love int fc_exch_init(struct fc_lport *); 11113a3b42bfSRobert Love struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, 11123a3b42bfSRobert Love struct fc_exch_mgr *, 111396316099SVasu Dev bool (*match)(struct fc_frame *)); 11143a3b42bfSRobert Love void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); 1115174e1ebfSChris Leech int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 11163a3b42bfSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, 11173a3b42bfSRobert Love u16 min_xid, u16 max_xid, 111852ff878cSVasu Dev bool (*match)(struct fc_frame *)); 11193a3b42bfSRobert Love void fc_exch_mgr_free(struct fc_lport *); 11203a3b42bfSRobert Love void fc_exch_recv(struct fc_lport *, struct fc_frame *); 11211f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 112242e9a92fSRobert Love 112342e9a92fSRobert Love /* 112442e9a92fSRobert Love * Functions for fc_functions_template 112542e9a92fSRobert Love */ 11263a3b42bfSRobert Love void fc_get_host_speed(struct Scsi_Host *); 11273a3b42bfSRobert Love void fc_get_host_port_state(struct Scsi_Host *); 11283a3b42bfSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout); 112942e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 113042e9a92fSRobert Love 113142e9a92fSRobert Love #endif /* _LIBFC_H_ */ 1132