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 3842e9a92fSRobert Love /* 3942e9a92fSRobert Love * libfc error codes 4042e9a92fSRobert Love */ 4142e9a92fSRobert Love #define FC_NO_ERR 0 /* no error */ 4242e9a92fSRobert Love #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 4342e9a92fSRobert Love #define FC_EX_CLOSED 2 /* Exchange closed */ 4442e9a92fSRobert Love 4542e9a92fSRobert Love /* some helpful macros */ 4642e9a92fSRobert Love 4742e9a92fSRobert Love #define ntohll(x) be64_to_cpu(x) 4842e9a92fSRobert Love #define htonll(x) cpu_to_be64(x) 4942e9a92fSRobert Love 5042e9a92fSRobert Love 510b2f74a4SJoe Eykholt static inline u32 ntoh24(const u8 *p) 520b2f74a4SJoe Eykholt { 530b2f74a4SJoe Eykholt return (p[0] << 16) | (p[1] << 8) | p[2]; 540b2f74a4SJoe Eykholt } 550b2f74a4SJoe Eykholt 560b2f74a4SJoe Eykholt static inline void hton24(u8 *p, u32 v) 570b2f74a4SJoe Eykholt { 580b2f74a4SJoe Eykholt p[0] = (v >> 16) & 0xff; 590b2f74a4SJoe Eykholt p[1] = (v >> 8) & 0xff; 600b2f74a4SJoe Eykholt p[2] = v & 0xff; 610b2f74a4SJoe Eykholt } 6242e9a92fSRobert Love 633a3b42bfSRobert Love /** 643a3b42bfSRobert Love * enum fc_lport_state - Local port states 653a3b42bfSRobert Love * @LPORT_ST_DISABLED: Disabled 663a3b42bfSRobert Love * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent 673a3b42bfSRobert Love * @LPORT_ST_DNS: Waiting for name server remote port to become ready 683a3b42bfSRobert Love * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent 693a3b42bfSRobert Love * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent 70ab593b18SJoe Eykholt * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent 713a3b42bfSRobert Love * @LPORT_ST_SCR: State Change Register (SCR) sent 723a3b42bfSRobert Love * @LPORT_ST_READY: Ready for use 733a3b42bfSRobert Love * @LPORT_ST_LOGO: Local port logout (LOGO) sent 743a3b42bfSRobert Love * @LPORT_ST_RESET: Local port reset 7542e9a92fSRobert Love */ 7642e9a92fSRobert Love enum fc_lport_state { 77b1d9fd55SJoe Eykholt LPORT_ST_DISABLED = 0, 7842e9a92fSRobert Love LPORT_ST_FLOGI, 7942e9a92fSRobert Love LPORT_ST_DNS, 80c9c7bd7aSChris Leech LPORT_ST_RNN_ID, 815baa17c3SChris Leech LPORT_ST_RSNN_NN, 82c9866a54SChris Leech LPORT_ST_RSPN_ID, 8342e9a92fSRobert Love LPORT_ST_RFT_ID, 84ab593b18SJoe Eykholt LPORT_ST_RFF_ID, 8542e9a92fSRobert Love LPORT_ST_SCR, 8642e9a92fSRobert Love LPORT_ST_READY, 8742e9a92fSRobert Love LPORT_ST_LOGO, 8842e9a92fSRobert Love LPORT_ST_RESET 8942e9a92fSRobert Love }; 9042e9a92fSRobert Love 9142e9a92fSRobert Love enum fc_disc_event { 9242e9a92fSRobert Love DISC_EV_NONE = 0, 9342e9a92fSRobert Love DISC_EV_SUCCESS, 9442e9a92fSRobert Love DISC_EV_FAILED 9542e9a92fSRobert Love }; 9642e9a92fSRobert Love 973a3b42bfSRobert Love /** 983a3b42bfSRobert Love * enum fc_rport_state - Remote port states 993a3b42bfSRobert Love * @RPORT_ST_INIT: Initialized 1003a3b42bfSRobert Love * @RPORT_ST_PLOGI: Waiting for PLOGI completion 1013a3b42bfSRobert Love * @RPORT_ST_PRLI: Waiting for PRLI completion 1023a3b42bfSRobert Love * @RPORT_ST_RTV: Waiting for RTV completion 1033a3b42bfSRobert Love * @RPORT_ST_READY: Ready for use 1043a3b42bfSRobert Love * @RPORT_ST_LOGO: Remote port logout (LOGO) sent 1053a3b42bfSRobert Love * @RPORT_ST_ADISC: Discover Address sent 1063a3b42bfSRobert Love * @RPORT_ST_DELETE: Remote port being deleted 1073a3b42bfSRobert Love */ 10842e9a92fSRobert Love enum fc_rport_state { 1093a3b42bfSRobert Love RPORT_ST_INIT, 1103a3b42bfSRobert Love RPORT_ST_PLOGI, 1113a3b42bfSRobert Love RPORT_ST_PRLI, 1123a3b42bfSRobert Love RPORT_ST_RTV, 1133a3b42bfSRobert Love RPORT_ST_READY, 1143a3b42bfSRobert Love RPORT_ST_LOGO, 1153a3b42bfSRobert Love RPORT_ST_ADISC, 1163a3b42bfSRobert Love RPORT_ST_DELETE, 11742e9a92fSRobert Love }; 11842e9a92fSRobert Love 11942e9a92fSRobert Love /** 12042e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 12142e9a92fSRobert Love * @lp: Fibre Channel host port instance 1229737e6a7SRobert Love * @peers: Node for list management during discovery and RSCN processing 1239737e6a7SRobert Love * @rport_work: Work struct for starting the rport state machine 1249737e6a7SRobert Love * @port_id: Port ID of the discovered port 12542e9a92fSRobert Love */ 12642e9a92fSRobert Love struct fc_disc_port { 12742e9a92fSRobert Love struct fc_lport *lp; 12842e9a92fSRobert Love struct list_head peers; 12942e9a92fSRobert Love struct work_struct rport_work; 1309737e6a7SRobert Love u32 port_id; 13142e9a92fSRobert Love }; 13242e9a92fSRobert Love 1333a3b42bfSRobert Love /** 1343a3b42bfSRobert Love * enum fc_rport_event - Remote port events 1353a3b42bfSRobert Love * @RPORT_EV_NONE: No event 1363a3b42bfSRobert Love * @RPORT_EV_READY: Remote port is ready for use 1373a3b42bfSRobert Love * @RPORT_EV_FAILED: State machine failed, remote port is not ready 1383a3b42bfSRobert Love * @RPORT_EV_STOP: Remote port has been stopped 1393a3b42bfSRobert Love * @RPORT_EV_LOGO: Remote port logout (LOGO) sent 1403a3b42bfSRobert Love */ 14142e9a92fSRobert Love enum fc_rport_event { 14242e9a92fSRobert Love RPORT_EV_NONE = 0, 1434c0f62b5SJoe Eykholt RPORT_EV_READY, 14442e9a92fSRobert Love RPORT_EV_FAILED, 14542e9a92fSRobert Love RPORT_EV_STOP, 14642e9a92fSRobert Love RPORT_EV_LOGO 14742e9a92fSRobert Love }; 14842e9a92fSRobert Love 1499fb9d328SJoe Eykholt struct fc_rport_priv; 1509fb9d328SJoe Eykholt 1513a3b42bfSRobert Love /** 1523a3b42bfSRobert Love * struct fc_rport_operations - Operations for a remote port 1533a3b42bfSRobert Love * @event_callback: Function to be called for remote port events 1543a3b42bfSRobert Love */ 15542e9a92fSRobert Love struct fc_rport_operations { 1569fb9d328SJoe Eykholt void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, 15742e9a92fSRobert Love enum fc_rport_event); 15842e9a92fSRobert Love }; 15942e9a92fSRobert Love 16042e9a92fSRobert Love /** 16142e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 1623a3b42bfSRobert Love * @local_port: The associated local port 1633a3b42bfSRobert Love * @rp_state: Indicates READY for I/O or DELETE when blocked 1649e9d0452SJoe Eykholt * @flags: REC and RETRY supported flags 1653a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1663a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1679e9d0452SJoe Eykholt */ 1689e9d0452SJoe Eykholt struct fc_rport_libfc_priv { 1699e9d0452SJoe Eykholt struct fc_lport *local_port; 1709e9d0452SJoe Eykholt enum fc_rport_state rp_state; 1719e9d0452SJoe Eykholt u16 flags; 1729e9d0452SJoe Eykholt #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 1739e9d0452SJoe Eykholt #define FC_RP_FLAGS_RETRY (1 << 1) 1744b2164d4SJoe Eykholt #define FC_RP_STARTED (1 << 2) 1759e9d0452SJoe Eykholt unsigned int e_d_tov; 1769e9d0452SJoe Eykholt unsigned int r_a_tov; 1779e9d0452SJoe Eykholt }; 1789e9d0452SJoe Eykholt 1799e9d0452SJoe Eykholt /** 1803a3b42bfSRobert Love * struct fc_rport_priv - libfc remote port and discovery info 1813a3b42bfSRobert Love * @local_port: The associated local port 1823a3b42bfSRobert Love * @rport: The FC transport remote port 1833a3b42bfSRobert Love * @kref: Reference counter 1843a3b42bfSRobert Love * @rp_state: Enumeration that tracks progress of PLOGI, PRLI, 1853a3b42bfSRobert Love * and RTV exchanges 1863a3b42bfSRobert Love * @ids: The remote port identifiers and roles 1874b2164d4SJoe Eykholt * @flags: STARTED, REC and RETRY_SUPPORTED flags 1883a3b42bfSRobert Love * @max_seq: Maximum number of concurrent sequences 1893a3b42bfSRobert Love * @disc_id: The discovery identifier 1903a3b42bfSRobert Love * @maxframe_size: The maximum frame size 1913a3b42bfSRobert Love * @retries: The retry count for the current state 192f034260dSJoe Eykholt * @major_retries: The retry count for the entire PLOGI/PRLI state machine 1933a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1943a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1953a3b42bfSRobert Love * @rp_mutex: The mutex that protects the remote port 1963a3b42bfSRobert Love * @retry_work: Handle for retries 1973a3b42bfSRobert Love * @event_callback: Callback when READY, FAILED or LOGO states complete 19842e90414SJoe Eykholt * @rcu: Structure used for freeing in an RCU-safe manner 19942e9a92fSRobert Love */ 2009e9d0452SJoe Eykholt struct fc_rport_priv { 20142e9a92fSRobert Love struct fc_lport *local_port; 202f211fa51SJoe Eykholt struct fc_rport *rport; 203f211fa51SJoe Eykholt struct kref kref; 20442e9a92fSRobert Love enum fc_rport_state rp_state; 205f211fa51SJoe Eykholt struct fc_rport_identifiers ids; 20642e9a92fSRobert Love u16 flags; 20742e9a92fSRobert Love u16 max_seq; 2080f6c6149SJoe Eykholt u16 disc_id; 209f211fa51SJoe Eykholt u16 maxframe_size; 21042e9a92fSRobert Love unsigned int retries; 211f034260dSJoe Eykholt unsigned int major_retries; 21242e9a92fSRobert Love unsigned int e_d_tov; 21342e9a92fSRobert Love unsigned int r_a_tov; 21442e9a92fSRobert Love struct mutex rp_mutex; 21542e9a92fSRobert Love struct delayed_work retry_work; 21642e9a92fSRobert Love enum fc_rport_event event; 21742e9a92fSRobert Love struct fc_rport_operations *ops; 21842e9a92fSRobert Love struct list_head peers; 21942e9a92fSRobert Love struct work_struct event_work; 220f211fa51SJoe Eykholt u32 supported_classes; 22142e90414SJoe Eykholt struct rcu_head rcu; 22242e9a92fSRobert Love }; 22342e9a92fSRobert Love 2243a3b42bfSRobert Love /** 2253a3b42bfSRobert Love * struct fcoe_dev_stats - fcoe stats structure 2263a3b42bfSRobert Love * @SecondsSinceLastReset: Seconds since the last reset 2273a3b42bfSRobert Love * @TxFrames: Number of transmitted frames 2283a3b42bfSRobert Love * @TxWords: Number of transmitted words 2293a3b42bfSRobert Love * @RxFrames: Number of received frames 2303a3b42bfSRobert Love * @RxWords: Number of received words 2313a3b42bfSRobert Love * @ErrorFrames: Number of received error frames 2323a3b42bfSRobert Love * @DumpedFrames: Number of dumped frames 2333a3b42bfSRobert Love * @LinkFailureCount: Number of link failures 2343a3b42bfSRobert Love * @LossOfSignalCount: Number for signal losses 2353a3b42bfSRobert Love * @InvalidTxWordCount: Number of invalid transmitted words 2363a3b42bfSRobert Love * @InvalidCRCCount: Number of invalid CRCs 2373a3b42bfSRobert Love * @InputRequests: Number of input requests 2383a3b42bfSRobert Love * @OutputRequests: Number of output requests 2393a3b42bfSRobert Love * @ControlRequests: Number of control requests 2403a3b42bfSRobert Love * @InputMegabytes: Number of received megabytes 2413a3b42bfSRobert Love * @OutputMegabytes: Number of transmitted megabytes 2426580bbd0SYi Zou * @VLinkFailureCount: Number of virtual link failures 2436580bbd0SYi Zou * @MissDiscAdvCount: Number of missing FIP discovery advertisement 24442e9a92fSRobert Love */ 24542e9a92fSRobert Love struct fcoe_dev_stats { 24642e9a92fSRobert Love u64 SecondsSinceLastReset; 24742e9a92fSRobert Love u64 TxFrames; 24842e9a92fSRobert Love u64 TxWords; 24942e9a92fSRobert Love u64 RxFrames; 25042e9a92fSRobert Love u64 RxWords; 25142e9a92fSRobert Love u64 ErrorFrames; 25242e9a92fSRobert Love u64 DumpedFrames; 25342e9a92fSRobert Love u64 LinkFailureCount; 25442e9a92fSRobert Love u64 LossOfSignalCount; 25542e9a92fSRobert Love u64 InvalidTxWordCount; 25642e9a92fSRobert Love u64 InvalidCRCCount; 25742e9a92fSRobert Love u64 InputRequests; 25842e9a92fSRobert Love u64 OutputRequests; 25942e9a92fSRobert Love u64 ControlRequests; 26042e9a92fSRobert Love u64 InputMegabytes; 26142e9a92fSRobert Love u64 OutputMegabytes; 2626580bbd0SYi Zou u64 VLinkFailureCount; 2636580bbd0SYi Zou u64 MissDiscAdvCount; 26442e9a92fSRobert Love }; 26542e9a92fSRobert Love 2663a3b42bfSRobert Love /** 2673a3b42bfSRobert Love * struct fc_seq_els_data - ELS data used for passing ELS specific responses 2683a3b42bfSRobert Love * @fp: The ELS frame 2693a3b42bfSRobert Love * @reason: The reason for rejection 2703a3b42bfSRobert Love * @explan: The explaination of the rejection 2713a3b42bfSRobert Love * 2723a3b42bfSRobert Love * Mainly used by the exchange manager layer. 27342e9a92fSRobert Love */ 27442e9a92fSRobert Love struct fc_seq_els_data { 27542e9a92fSRobert Love struct fc_frame *fp; 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 * @tgt_flags: Target's flags 2853a3b42bfSRobert Love * @ref_cnt: Reference count 2863a3b42bfSRobert Love * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the 2873a3b42bfSRobert Love * host_lock if both are to be held at the same time) 2883a3b42bfSRobert Love * @cmd: The SCSI command (set and clear with the host_lock held) 2893a3b42bfSRobert Love * @list: Tracks queued commands (accessed with the host_lock held) 2903a3b42bfSRobert Love * @timer: The command timer 2913a3b42bfSRobert Love * @tm_done: Completion indicator 2923a3b42bfSRobert Love * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies) 2933a3b42bfSRobert Love * @start_time: Timestamp indicating the start of the I/O (in jiffies) 2943a3b42bfSRobert Love * @end_time: Timestamp indicating the end of the I/O (in jiffies) 2953a3b42bfSRobert Love * @last_pkt_time: Timestamp of the last frame received (in jiffies) 2963a3b42bfSRobert Love * @data_len: The length of the data 2973a3b42bfSRobert Love * @cdb_cmd: The CDB command 2983a3b42bfSRobert Love * @xfer_len: The transfer length 2993a3b42bfSRobert Love * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange 3003a3b42bfSRobert Love * will be set here if DDP was setup) 3013a3b42bfSRobert Love * @xfer_contig_end: The offset into the buffer if the buffer is contiguous 3023a3b42bfSRobert Love * (Tx and Rx) 3033a3b42bfSRobert Love * @max_payload: The maximum payload size (in bytes) 3043a3b42bfSRobert Love * @io_status: SCSI result (upper 24 bits) 3053a3b42bfSRobert Love * @cdb_status: CDB status 3063a3b42bfSRobert Love * @status_code: FCP I/O status 3073a3b42bfSRobert Love * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun) 3083a3b42bfSRobert Love * @req_flags: Request flags (bit 0: read bit:1 write) 3093a3b42bfSRobert Love * @scsi_resid: SCSI residule length 3103a3b42bfSRobert Love * @rport: The remote port that the SCSI command is targeted at 3113a3b42bfSRobert Love * @seq_ptr: The sequence that will carry the SCSI command 3123a3b42bfSRobert Love * @recov_retry: Number of recovery retries 3133a3b42bfSRobert Love * @recov_seq: The sequence for REC or SRR 31442e9a92fSRobert Love */ 31542e9a92fSRobert Love struct fc_fcp_pkt { 3163a3b42bfSRobert Love /* Housekeeping information */ 3173a3b42bfSRobert Love struct fc_lport *lp; 3183a3b42bfSRobert Love u16 state; 3193a3b42bfSRobert Love u16 tgt_flags; 3203a3b42bfSRobert Love atomic_t ref_cnt; 3213a3b42bfSRobert Love spinlock_t scsi_pkt_lock; 3223a3b42bfSRobert Love 3233a3b42bfSRobert Love /* SCSI I/O related information */ 3243a3b42bfSRobert Love struct scsi_cmnd *cmd; 3253a3b42bfSRobert Love struct list_head list; 3263a3b42bfSRobert Love 3273a3b42bfSRobert Love /* Timeout related information */ 3283a3b42bfSRobert Love struct timer_list timer; 32942e9a92fSRobert Love struct completion tm_done; 33042e9a92fSRobert Love int wait_for_comp; 3313a3b42bfSRobert Love unsigned long start_time; 3323a3b42bfSRobert Love unsigned long end_time; 3333a3b42bfSRobert Love unsigned long last_pkt_time; 33442e9a92fSRobert Love 3353a3b42bfSRobert Love /* SCSI command and data transfer information */ 33642e9a92fSRobert Love u32 data_len; 3373a3b42bfSRobert Love 3383a3b42bfSRobert Love /* Transport related veriables */ 33942e9a92fSRobert Love struct fcp_cmnd cdb_cmd; 34042e9a92fSRobert Love size_t xfer_len; 3413a3b42bfSRobert Love u16 xfer_ddp; 3423a3b42bfSRobert Love u32 xfer_contig_end; 3433a3b42bfSRobert Love u16 max_payload; 34442e9a92fSRobert Love 3453a3b42bfSRobert Love /* SCSI/FCP return status */ 3463a3b42bfSRobert Love u32 io_status; 34742e9a92fSRobert Love u8 cdb_status; 3483a3b42bfSRobert Love u8 status_code; 34942e9a92fSRobert Love u8 scsi_comp_flags; 3503a3b42bfSRobert Love u32 req_flags; 3513a3b42bfSRobert Love u32 scsi_resid; 35242e9a92fSRobert Love 3533a3b42bfSRobert Love /* Associated structures */ 3543a3b42bfSRobert Love struct fc_rport *rport; 3553a3b42bfSRobert Love struct fc_seq *seq_ptr; 3563a3b42bfSRobert Love 3573a3b42bfSRobert Love /* Error Processing information */ 3583a3b42bfSRobert Love u8 recov_retry; 3593a3b42bfSRobert Love struct fc_seq *recov_seq; 36042e9a92fSRobert Love }; 36142e9a92fSRobert Love 36242e9a92fSRobert Love /* 36342e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 36442e9a92fSRobert Love * and Sequences 36542e9a92fSRobert Love * 36642e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 36742e9a92fSRobert Love * 36842e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 36942e9a92fSRobert Love */ 37042e9a92fSRobert Love 37142e9a92fSRobert Love struct fc_exch_mgr; 37296316099SVasu Dev struct fc_exch_mgr_anchor; 373e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 37442e9a92fSRobert Love 3753a3b42bfSRobert Love /** 3763a3b42bfSRobert Love * struct fc_seq - FC sequence 3773a3b42bfSRobert Love * @id: The sequence ID 3783a3b42bfSRobert Love * @ssb_stat: Status flags for the sequence status block (SSB) 3793a3b42bfSRobert Love * @cnt: Number of frames sent so far 3803a3b42bfSRobert Love * @rec_data: FC-4 value for REC 38142e9a92fSRobert Love */ 38242e9a92fSRobert Love struct fc_seq { 3833a3b42bfSRobert Love u8 id; 3843a3b42bfSRobert Love u16 ssb_stat; 3853a3b42bfSRobert Love u16 cnt; 3863a3b42bfSRobert Love u32 rec_data; 38742e9a92fSRobert Love }; 38842e9a92fSRobert Love 38942e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 39042e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 39142e9a92fSRobert Love 3923a3b42bfSRobert Love /** 3933a3b42bfSRobert Love * struct fc_exch - Fibre Channel Exchange 3943a3b42bfSRobert Love * @em: Exchange manager 3953a3b42bfSRobert Love * @pool: Exchange pool 3963a3b42bfSRobert Love * @state: The exchange's state 3973a3b42bfSRobert Love * @xid: The exchange ID 3983a3b42bfSRobert Love * @ex_list: Handle used by the EM to track free exchanges 3993a3b42bfSRobert Love * @ex_lock: Lock that protects the exchange 4003a3b42bfSRobert Love * @ex_refcnt: Reference count 4013a3b42bfSRobert Love * @timeout_work: Handle for timeout handler 4023a3b42bfSRobert Love * @lp: The local port that this exchange is on 4033a3b42bfSRobert Love * @oxid: Originator's exchange ID 4043a3b42bfSRobert Love * @rxid: Responder's exchange ID 4053a3b42bfSRobert Love * @oid: Originator's FCID 4063a3b42bfSRobert Love * @sid: Source FCID 4073a3b42bfSRobert Love * @did: Destination FCID 4083a3b42bfSRobert Love * @esb_stat: ESB exchange status 4093a3b42bfSRobert Love * @r_a_tov: Resouce allocation time out value (in msecs) 4103a3b42bfSRobert Love * @seq_id: The next sequence ID to use 4113a3b42bfSRobert Love * @f_ctl: F_CTL flags for the sequence 4123a3b42bfSRobert Love * @fh_type: The frame type 4133a3b42bfSRobert Love * @class: The class of service 4143a3b42bfSRobert Love * @seq: The sequence in use on this exchange 4153a3b42bfSRobert Love * @resp: Callback for responses on this exchange 4163a3b42bfSRobert Love * @destructor: Called when destroying the exchange 4173a3b42bfSRobert Love * @arg: Passed as a void pointer to the resp() callback 41842e9a92fSRobert Love * 41942e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 42042e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 42142e9a92fSRobert Love * seq_id 42242e9a92fSRobert Love * sequence allocation 42342e9a92fSRobert Love */ 42442e9a92fSRobert Love struct fc_exch { 4253a3b42bfSRobert Love struct fc_exch_mgr *em; 4263a3b42bfSRobert Love struct fc_exch_pool *pool; 4273a3b42bfSRobert Love u32 state; 4283a3b42bfSRobert Love u16 xid; 4293a3b42bfSRobert Love struct list_head ex_list; 4303a3b42bfSRobert Love spinlock_t ex_lock; 4313a3b42bfSRobert Love atomic_t ex_refcnt; 4323a3b42bfSRobert Love struct delayed_work timeout_work; 4333a3b42bfSRobert Love struct fc_lport *lp; 4343a3b42bfSRobert Love u16 oxid; 4353a3b42bfSRobert Love u16 rxid; 4363a3b42bfSRobert Love u32 oid; 4373a3b42bfSRobert Love u32 sid; 4383a3b42bfSRobert Love u32 did; 4393a3b42bfSRobert Love u32 esb_stat; 4403a3b42bfSRobert Love u32 r_a_tov; 4413a3b42bfSRobert Love u8 seq_id; 4423a3b42bfSRobert Love u32 f_ctl; 4433a3b42bfSRobert Love u8 fh_type; 4443a3b42bfSRobert Love enum fc_class class; 4453a3b42bfSRobert Love struct fc_seq seq; 4463a3b42bfSRobert Love 44742e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 44842e9a92fSRobert Love void *arg; 4493a3b42bfSRobert Love 4503a3b42bfSRobert Love void (*destructor)(struct fc_seq *, void *); 4513a3b42bfSRobert Love 45242e9a92fSRobert Love }; 45342e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 45442e9a92fSRobert Love 45542e9a92fSRobert Love 4563a3b42bfSRobert Love struct libfc_function_template { 45742e9a92fSRobert Love /* 45842e9a92fSRobert Love * Interface to send a FC frame 4590ae4d4aeSRobert Love * 4600ae4d4aeSRobert Love * STATUS: REQUIRED 46142e9a92fSRobert Love */ 4623a3b42bfSRobert Love int (*frame_send)(struct fc_lport *, struct fc_frame *); 46342e9a92fSRobert Love 46442e9a92fSRobert Love /* 4650ae4d4aeSRobert Love * Interface to send ELS/CT frames 4660ae4d4aeSRobert Love * 4670ae4d4aeSRobert Love * STATUS: OPTIONAL 46842e9a92fSRobert Love */ 4693a3b42bfSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, 4703a3b42bfSRobert Love struct fc_frame *, unsigned int op, 47142e9a92fSRobert Love void (*resp)(struct fc_seq *, 4723a3b42bfSRobert Love struct fc_frame *, void *arg), 47342e9a92fSRobert Love void *arg, u32 timer_msec); 47442e9a92fSRobert Love 47542e9a92fSRobert Love /* 47642e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 47742e9a92fSRobert Love * 47842e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 47942e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 48042e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 48142e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 48242e9a92fSRobert Love * as error using IS_ERR related macros. 48342e9a92fSRobert Love * 48442e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 48542e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 48642e9a92fSRobert Love * is about to free, this can be used by caller to free its 48742e9a92fSRobert Love * resources along with exchange free. 48842e9a92fSRobert Love * 48942e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 49042e9a92fSRobert Love * 49142e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 49242e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 49342e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 49442e9a92fSRobert Love * is registered by EM layer. 4950ae4d4aeSRobert Love * 4960ae4d4aeSRobert Love * STATUS: OPTIONAL 49742e9a92fSRobert Love */ 4983a3b42bfSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *, 4993a3b42bfSRobert Love void (*resp)(struct fc_seq *, 5003a3b42bfSRobert Love struct fc_frame *, 5013a3b42bfSRobert Love void *), 5023a3b42bfSRobert Love void (*destructor)(struct fc_seq *, 5033a3b42bfSRobert Love void *), 5043a3b42bfSRobert Love void *, unsigned int timer_msec); 50542e9a92fSRobert Love 50642e9a92fSRobert Love /* 507b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given 508b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive. 509b277d2aaSYi Zou * 510b277d2aaSYi Zou * STATUS: OPTIONAL 511b277d2aaSYi Zou */ 5123a3b42bfSRobert Love int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, 5133a3b42bfSRobert Love unsigned int); 514b277d2aaSYi Zou /* 515b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed 516b277d2aaSYi Zou * for the given exchange id. 517b277d2aaSYi Zou * 518b277d2aaSYi Zou * STATUS: OPTIONAL 519b277d2aaSYi Zou */ 5203a3b42bfSRobert Love int (*ddp_done)(struct fc_lport *, u16); 521b277d2aaSYi Zou /* 522b84056bfSYi Zou * Allow LLD to fill its own Link Error Status Block 523b84056bfSYi Zou * 524b84056bfSYi Zou * STATUS: OPTIONAL 525b84056bfSYi Zou */ 526b84056bfSYi Zou void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb); 527b84056bfSYi Zou /* 5280ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 5290ae4d4aeSRobert Love * 5300ae4d4aeSRobert Love * STATUS: OPTIONAL 53142e9a92fSRobert Love */ 5323a3b42bfSRobert Love int (*seq_send)(struct fc_lport *, struct fc_seq *, 5333a3b42bfSRobert Love struct fc_frame *); 53442e9a92fSRobert Love 53542e9a92fSRobert Love /* 5360ae4d4aeSRobert Love * Send an ELS response using infomation from a previous 5370ae4d4aeSRobert Love * exchange and sequence. 5380ae4d4aeSRobert Love * 5390ae4d4aeSRobert Love * STATUS: OPTIONAL 54042e9a92fSRobert Love */ 5413a3b42bfSRobert Love void (*seq_els_rsp_send)(struct fc_seq *, enum fc_els_cmd, 5423a3b42bfSRobert Love struct fc_seq_els_data *); 54342e9a92fSRobert Love 54442e9a92fSRobert Love /* 54542e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 54642e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 54742e9a92fSRobert Love * 54842e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 54942e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 55042e9a92fSRobert Love * will be called with timeout error if no response to abort. 5510ae4d4aeSRobert Love * 5520ae4d4aeSRobert Love * STATUS: OPTIONAL 55342e9a92fSRobert Love */ 5543a3b42bfSRobert Love int (*seq_exch_abort)(const struct fc_seq *, 55542e9a92fSRobert Love unsigned int timer_msec); 55642e9a92fSRobert Love 55742e9a92fSRobert Love /* 55842e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 55942e9a92fSRobert Love * allocated for the related objects may be freed. 5600ae4d4aeSRobert Love * 5610ae4d4aeSRobert Love * STATUS: OPTIONAL 56242e9a92fSRobert Love */ 5633a3b42bfSRobert Love void (*exch_done)(struct fc_seq *); 56442e9a92fSRobert Love 56542e9a92fSRobert Love /* 56642e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 5670ae4d4aeSRobert Love * 5680ae4d4aeSRobert Love * STATUS: OPTIONAL 56942e9a92fSRobert Love */ 5703a3b42bfSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *); 57142e9a92fSRobert Love 57242e9a92fSRobert Love /* 57342e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 57442e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 57542e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 5760ae4d4aeSRobert Love * 5770ae4d4aeSRobert Love * STATUS: OPTIONAL 57842e9a92fSRobert Love */ 5793a3b42bfSRobert Love void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); 58042e9a92fSRobert Love 5810ae4d4aeSRobert Love /* 5820ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 5830ae4d4aeSRobert Love * 5840ae4d4aeSRobert Love * STATUS: OPTIONAL 58542e9a92fSRobert Love */ 5860ae4d4aeSRobert Love void (*rport_flush_queue)(void); 58742e9a92fSRobert Love 58842e9a92fSRobert Love /* 5890ae4d4aeSRobert Love * Receive a frame for a local port. 5900ae4d4aeSRobert Love * 5910ae4d4aeSRobert Love * STATUS: OPTIONAL 59242e9a92fSRobert Love */ 5933a3b42bfSRobert Love void (*lport_recv)(struct fc_lport *, struct fc_seq *, 5943a3b42bfSRobert Love struct fc_frame *); 59542e9a92fSRobert Love 5960ae4d4aeSRobert Love /* 5970ae4d4aeSRobert Love * Reset the local port. 5980ae4d4aeSRobert Love * 5990ae4d4aeSRobert Love * STATUS: OPTIONAL 60042e9a92fSRobert Love */ 6010ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 60242e9a92fSRobert Love 60342e9a92fSRobert Love /* 604093bb6a2SJoe Eykholt * Set the local port FC_ID. 605093bb6a2SJoe Eykholt * 606093bb6a2SJoe Eykholt * This may be provided by the LLD to allow it to be 607093bb6a2SJoe Eykholt * notified when the local port is assigned a FC-ID. 608093bb6a2SJoe Eykholt * 609093bb6a2SJoe Eykholt * The frame, if non-NULL, is the incoming frame with the 610093bb6a2SJoe Eykholt * FLOGI LS_ACC or FLOGI, and may contain the granted MAC 611093bb6a2SJoe Eykholt * address for the LLD. The frame pointer may be NULL if 612093bb6a2SJoe Eykholt * no MAC is associated with this assignment (LOGO or PLOGI). 613093bb6a2SJoe Eykholt * 614093bb6a2SJoe Eykholt * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid. 615093bb6a2SJoe Eykholt * 616093bb6a2SJoe Eykholt * Note: this is called with the local port mutex held. 617093bb6a2SJoe Eykholt * 618093bb6a2SJoe Eykholt * STATUS: OPTIONAL 619093bb6a2SJoe Eykholt */ 620093bb6a2SJoe Eykholt void (*lport_set_port_id)(struct fc_lport *, u32 port_id, 621093bb6a2SJoe Eykholt struct fc_frame *); 622093bb6a2SJoe Eykholt 623093bb6a2SJoe Eykholt /* 6249737e6a7SRobert Love * Create a remote port with a given port ID 6259737e6a7SRobert Love * 6269737e6a7SRobert Love * STATUS: OPTIONAL 6275101ff99SRobert Love */ 6289737e6a7SRobert Love struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 6295101ff99SRobert Love 6305101ff99SRobert Love /* 63142e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 63242e9a92fSRobert Love * This function will issue the following commands to the N_Port 63342e9a92fSRobert Love * identified by the FC ID provided. 63442e9a92fSRobert Love * 63542e9a92fSRobert Love * - PLOGI 63642e9a92fSRobert Love * - PRLI 63742e9a92fSRobert Love * - RTV 6380ae4d4aeSRobert Love * 6390ae4d4aeSRobert Love * STATUS: OPTIONAL 64042e9a92fSRobert Love */ 6419fb9d328SJoe Eykholt int (*rport_login)(struct fc_rport_priv *); 64242e9a92fSRobert Love 64342e9a92fSRobert Love /* 64442e9a92fSRobert Love * Logoff, and remove the rport from the transport if 64542e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 6460ae4d4aeSRobert Love * 6470ae4d4aeSRobert Love * STATUS: OPTIONAL 64842e9a92fSRobert Love */ 6499fb9d328SJoe Eykholt int (*rport_logoff)(struct fc_rport_priv *); 65042e9a92fSRobert Love 65142e9a92fSRobert Love /* 65242e9a92fSRobert Love * Recieve a request from a remote port. 6530ae4d4aeSRobert Love * 6540ae4d4aeSRobert Love * STATUS: OPTIONAL 65542e9a92fSRobert Love */ 65642e9a92fSRobert Love void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 657131203a1SJoe Eykholt struct fc_lport *); 65842e9a92fSRobert Love 6590ae4d4aeSRobert Love /* 6600ae4d4aeSRobert Love * lookup an rport by it's port ID. 6610ae4d4aeSRobert Love * 6620ae4d4aeSRobert Love * STATUS: OPTIONAL 66342e9a92fSRobert Love */ 6649fb9d328SJoe Eykholt struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 66542e9a92fSRobert Love 66642e9a92fSRobert Love /* 667f211fa51SJoe Eykholt * Destroy an rport after final kref_put(). 668f211fa51SJoe Eykholt * The argument is a pointer to the kref inside the fc_rport_priv. 669f211fa51SJoe Eykholt */ 670f211fa51SJoe Eykholt void (*rport_destroy)(struct kref *); 671f211fa51SJoe Eykholt 672f211fa51SJoe Eykholt /* 67342e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 67442e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 67542e9a92fSRobert Love * 67642e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 67742e9a92fSRobert Love * 6780ae4d4aeSRobert Love * STATUS: OPTIONAL 67942e9a92fSRobert Love */ 6803a3b42bfSRobert Love int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, 6813a3b42bfSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, 6823a3b42bfSRobert Love void *)); 68342e9a92fSRobert Love 68442e9a92fSRobert Love /* 6850ae4d4aeSRobert Love * Cleanup the FCP layer, used durring link down and reset 6860ae4d4aeSRobert Love * 6870ae4d4aeSRobert Love * STATUS: OPTIONAL 68842e9a92fSRobert Love */ 6893a3b42bfSRobert Love void (*fcp_cleanup)(struct fc_lport *); 69042e9a92fSRobert Love 69142e9a92fSRobert Love /* 69242e9a92fSRobert Love * Abort all I/O on a local port 6930ae4d4aeSRobert Love * 6940ae4d4aeSRobert Love * STATUS: OPTIONAL 69542e9a92fSRobert Love */ 6963a3b42bfSRobert Love void (*fcp_abort_io)(struct fc_lport *); 69742e9a92fSRobert Love 6980ae4d4aeSRobert Love /* 6990ae4d4aeSRobert Love * Receive a request for the discovery layer. 7000ae4d4aeSRobert Love * 7010ae4d4aeSRobert Love * STATUS: OPTIONAL 70242e9a92fSRobert Love */ 7033a3b42bfSRobert Love void (*disc_recv_req)(struct fc_seq *, struct fc_frame *, 7043a3b42bfSRobert Love struct fc_lport *); 70542e9a92fSRobert Love 70642e9a92fSRobert Love /* 70742e9a92fSRobert Love * Start discovery for a local port. 7080ae4d4aeSRobert Love * 7090ae4d4aeSRobert Love * STATUS: OPTIONAL 71042e9a92fSRobert Love */ 71142e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 71242e9a92fSRobert Love enum fc_disc_event), 71342e9a92fSRobert Love struct fc_lport *); 71442e9a92fSRobert Love 71542e9a92fSRobert Love /* 71642e9a92fSRobert Love * Stop discovery for a given lport. This will remove 71742e9a92fSRobert Love * all discovered rports 7180ae4d4aeSRobert Love * 7190ae4d4aeSRobert Love * STATUS: OPTIONAL 72042e9a92fSRobert Love */ 72142e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 72242e9a92fSRobert Love 72342e9a92fSRobert Love /* 72442e9a92fSRobert Love * Stop discovery for a given lport. This will block 72542e9a92fSRobert Love * until all discovered rports are deleted from the 72642e9a92fSRobert Love * FC transport class 7270ae4d4aeSRobert Love * 7280ae4d4aeSRobert Love * STATUS: OPTIONAL 72942e9a92fSRobert Love */ 73042e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 73142e9a92fSRobert Love }; 73242e9a92fSRobert Love 7333a3b42bfSRobert Love /** 7343a3b42bfSRobert Love * struct fc_disc - Discovery context 7353a3b42bfSRobert Love * @retry_count: Number of retries 7363a3b42bfSRobert Love * @pending: 1 if discovery is pending, 0 if not 7373a3b42bfSRobert Love * @requesting: 1 if discovery has been requested, 0 if not 7383a3b42bfSRobert Love * @seq_count: Number of sequences used for discovery 7393a3b42bfSRobert Love * @buf_len: Length of the discovery buffer 7403a3b42bfSRobert Love * @disc_id: Discovery ID 7413a3b42bfSRobert Love * @rports: List of discovered remote ports 7423a3b42bfSRobert Love * @lport: The local port that discovery is for 7433a3b42bfSRobert Love * @disc_mutex: Mutex that protects the discovery context 7443a3b42bfSRobert Love * @partial_buf: Partial name buffer (if names are returned 7453a3b42bfSRobert Love * in multiple frames) 7463a3b42bfSRobert Love * @disc_work: handle for delayed work context 7473a3b42bfSRobert Love * @disc_callback: Callback routine called when discovery completes 7483a3b42bfSRobert Love */ 74942e9a92fSRobert Love struct fc_disc { 75042e9a92fSRobert Love unsigned char retry_count; 75142e9a92fSRobert Love unsigned char pending; 75242e9a92fSRobert Love unsigned char requested; 75342e9a92fSRobert Love unsigned short seq_count; 75442e9a92fSRobert Love unsigned char buf_len; 7550f6c6149SJoe Eykholt u16 disc_id; 75642e9a92fSRobert Love 75742e9a92fSRobert Love struct list_head rports; 75842e9a92fSRobert Love struct fc_lport *lport; 75942e9a92fSRobert Love struct mutex disc_mutex; 7603a3b42bfSRobert Love struct fc_gpn_ft_resp partial_buf; 76142e9a92fSRobert Love struct delayed_work disc_work; 7623a3b42bfSRobert Love 7633a3b42bfSRobert Love void (*disc_callback)(struct fc_lport *, 7643a3b42bfSRobert Love enum fc_disc_event); 76542e9a92fSRobert Love }; 76642e9a92fSRobert Love 7673a3b42bfSRobert Love /** 7683a3b42bfSRobert Love * struct fc_lport - Local port 7693a3b42bfSRobert Love * @host: The SCSI host associated with a local port 7703a3b42bfSRobert Love * @ema_list: Exchange manager anchor list 7713a3b42bfSRobert Love * @dns_rdata: The directory server remote port 7723a3b42bfSRobert Love * @ptp_rdata: Point to point remote port 7733a3b42bfSRobert Love * @scsi_priv: FCP layer internal data 7743a3b42bfSRobert Love * @disc: Discovery context 7753a3b42bfSRobert Love * @vports: Child vports if N_Port 7763a3b42bfSRobert Love * @vport: Parent vport if VN_Port 7773a3b42bfSRobert Love * @tt: Libfc function template 7783a3b42bfSRobert Love * @link_up: Link state (1 = link up, 0 = link down) 7793a3b42bfSRobert Love * @qfull: Queue state (1 queue is full, 0 queue is not full) 7803a3b42bfSRobert Love * @state: Identifies the state 7813a3b42bfSRobert Love * @boot_time: Timestamp indicating when the local port came online 7823a3b42bfSRobert Love * @host_stats: SCSI host statistics 7833a3b42bfSRobert Love * @dev_stats: FCoE device stats (TODO: libfc should not be 7843a3b42bfSRobert Love * FCoE aware) 7853a3b42bfSRobert Love * @retry_count: Number of retries in the current state 7867b2787ecSRobert Love * @port_id: FC Port ID 7873a3b42bfSRobert Love * @wwpn: World Wide Port Name 7883a3b42bfSRobert Love * @wwnn: World Wide Node Name 7893a3b42bfSRobert Love * @service_params: Common service parameters 7903a3b42bfSRobert Love * @e_d_tov: Error detection timeout value 7913a3b42bfSRobert Love * @r_a_tov: Resouce allocation timeout value 7923a3b42bfSRobert Love * @rnid_gen: RNID information 7933a3b42bfSRobert Love * @sg_supp: Indicates if scatter gather is supported 7943a3b42bfSRobert Love * @seq_offload: Indicates if sequence offload is supported 7953a3b42bfSRobert Love * @crc_offload: Indicates if CRC offload is supported 7963a3b42bfSRobert Love * @lro_enabled: Indicates if large receive offload is supported 7973a3b42bfSRobert Love * @does_npiv: Supports multiple vports 7983a3b42bfSRobert Love * @npiv_enabled: Switch/fabric allows NPIV 7993a3b42bfSRobert Love * @mfs: The maximum Fibre Channel payload size 8003a3b42bfSRobert Love * @max_retry_count: The maximum retry attempts 8013a3b42bfSRobert Love * @max_rport_retry_count: The maximum remote port retry attempts 8023a3b42bfSRobert Love * @lro_xid: The maximum XID for LRO 8033a3b42bfSRobert Love * @lso_max: The maximum large offload send size 8043a3b42bfSRobert Love * @fcts: FC-4 type mask 8053a3b42bfSRobert Love * @lp_mutex: Mutex to protect the local port 8063a3b42bfSRobert Love * @list: Handle for list of local ports 8073a3b42bfSRobert Love * @retry_work: Handle to local port for delayed retry context 8083a3b42bfSRobert Love */ 80942e9a92fSRobert Love struct fc_lport { 81042e9a92fSRobert Love /* Associations */ 81142e9a92fSRobert Love struct Scsi_Host *host; 81296316099SVasu Dev struct list_head ema_list; 8133a3b42bfSRobert Love struct fc_rport_priv *dns_rdata; 8143a3b42bfSRobert Love struct fc_rport_priv *ptp_rdata; 81542e9a92fSRobert Love void *scsi_priv; 81642e9a92fSRobert Love struct fc_disc disc; 81742e9a92fSRobert Love 8183a3b42bfSRobert Love /* Virtual port information */ 8193a3b42bfSRobert Love struct list_head vports; 8203a3b42bfSRobert Love struct fc_vport *vport; 8213a3b42bfSRobert Love 82242e9a92fSRobert Love /* Operational Information */ 82342e9a92fSRobert Love struct libfc_function_template tt; 824bc0e17f6SVasu Dev u8 link_up; 825bc0e17f6SVasu Dev u8 qfull; 82642e9a92fSRobert Love enum fc_lport_state state; 82742e9a92fSRobert Love unsigned long boot_time; 82842e9a92fSRobert Love struct fc_host_statistics host_stats; 829582b45bcSRobert Love struct fcoe_dev_stats *dev_stats; 83042e9a92fSRobert Love u8 retry_count; 83142e9a92fSRobert Love 8323a3b42bfSRobert Love /* Fabric information */ 8337b2787ecSRobert Love u32 port_id; 8343a3b42bfSRobert Love u64 wwpn; 8353a3b42bfSRobert Love u64 wwnn; 83642e9a92fSRobert Love unsigned int service_params; 83742e9a92fSRobert Love unsigned int e_d_tov; 83842e9a92fSRobert Love unsigned int r_a_tov; 8393a3b42bfSRobert Love struct fc_els_rnid_gen rnid_gen; 8403a3b42bfSRobert Love 8413a3b42bfSRobert Love /* Capabilities */ 8423a3b42bfSRobert Love u32 sg_supp:1; 8433a3b42bfSRobert Love u32 seq_offload:1; 8443a3b42bfSRobert Love u32 crc_offload:1; 8453a3b42bfSRobert Love u32 lro_enabled:1; 8463a3b42bfSRobert Love u32 does_npiv:1; 8473a3b42bfSRobert Love u32 npiv_enabled:1; 8483a3b42bfSRobert Love u32 mfs; 84942e9a92fSRobert Love u8 max_retry_count; 850a3666955SAbhijeet Joglekar u8 max_rport_retry_count; 85142e9a92fSRobert Love u16 link_speed; 85242e9a92fSRobert Love u16 link_supported_speeds; 8533a3b42bfSRobert Love u16 lro_xid; 8543a3b42bfSRobert Love unsigned int lso_max; 8553a3b42bfSRobert Love struct fc_ns_fts fcts; 85642e9a92fSRobert Love 85742e9a92fSRobert Love /* Miscellaneous */ 8583a3b42bfSRobert Love struct mutex lp_mutex; 8593a3b42bfSRobert Love struct list_head list; 86042e9a92fSRobert Love struct delayed_work retry_work; 86142e9a92fSRobert Love }; 86242e9a92fSRobert Love 86334f42a07SRobert Love /* 86442e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 86542e9a92fSRobert Love *****************************/ 8663a3b42bfSRobert Love 8673a3b42bfSRobert Love /** 8683a3b42bfSRobert Love * fc_lport_test_ready() - Determine if a local port is in the READY state 8693a3b42bfSRobert Love * @lport: The local port to test 8703a3b42bfSRobert Love */ 8713a3b42bfSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lport) 87242e9a92fSRobert Love { 8733a3b42bfSRobert Love return lport->state == LPORT_ST_READY; 87442e9a92fSRobert Love } 87542e9a92fSRobert Love 8763a3b42bfSRobert Love /** 8773a3b42bfSRobert Love * fc_set_wwnn() - Set the World Wide Node Name of a local port 8783a3b42bfSRobert Love * @lport: The local port whose WWNN is to be set 8793a3b42bfSRobert Love * @wwnn: The new WWNN 8803a3b42bfSRobert Love */ 8813a3b42bfSRobert Love static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) 88242e9a92fSRobert Love { 8833a3b42bfSRobert Love lport->wwnn = wwnn; 88442e9a92fSRobert Love } 88542e9a92fSRobert Love 8863a3b42bfSRobert Love /** 8873a3b42bfSRobert Love * fc_set_wwpn() - Set the World Wide Port Name of a local port 8883a3b42bfSRobert Love * @lport: The local port whose WWPN is to be set 8893a3b42bfSRobert Love * @wwnn: The new WWPN 8903a3b42bfSRobert Love */ 8913a3b42bfSRobert Love static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) 89242e9a92fSRobert Love { 8933a3b42bfSRobert Love lport->wwpn = wwnn; 89442e9a92fSRobert Love } 89542e9a92fSRobert Love 8963a3b42bfSRobert Love /** 8973a3b42bfSRobert Love * fc_lport_state_enter() - Change a local port's state 8983a3b42bfSRobert Love * @lport: The local port whose state is to change 8993a3b42bfSRobert Love * @state: The new state 9003a3b42bfSRobert Love */ 9013a3b42bfSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lport, 90242e9a92fSRobert Love enum fc_lport_state state) 90342e9a92fSRobert Love { 9043a3b42bfSRobert Love if (state != lport->state) 9053a3b42bfSRobert Love lport->retry_count = 0; 9063a3b42bfSRobert Love lport->state = state; 90742e9a92fSRobert Love } 90842e9a92fSRobert Love 9093a3b42bfSRobert Love /** 9103a3b42bfSRobert Love * fc_lport_init_stats() - Allocate per-CPU statistics for a local port 9113a3b42bfSRobert Love * @lport: The local port whose statistics are to be initialized 9123a3b42bfSRobert Love */ 9133a3b42bfSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lport) 914582b45bcSRobert Love { 9153a3b42bfSRobert Love lport->dev_stats = alloc_percpu(struct fcoe_dev_stats); 9163a3b42bfSRobert Love if (!lport->dev_stats) 917582b45bcSRobert Love return -ENOMEM; 918582b45bcSRobert Love return 0; 919582b45bcSRobert Love } 920582b45bcSRobert Love 9213a3b42bfSRobert Love /** 9223a3b42bfSRobert Love * fc_lport_free_stats() - Free memory for a local port's statistics 9233a3b42bfSRobert Love * @lport: The local port whose statistics are to be freed 9243a3b42bfSRobert Love */ 9253a3b42bfSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lport) 926582b45bcSRobert Love { 9273a3b42bfSRobert Love free_percpu(lport->dev_stats); 928a0a25da2SVasu Dev } 929a0a25da2SVasu Dev 930a0a25da2SVasu Dev /** 9313a3b42bfSRobert Love * lport_priv() - Return the private data from a local port 9323a3b42bfSRobert Love * @lport: The local port whose private data is to be retreived 9333a3b42bfSRobert Love */ 9343a3b42bfSRobert Love static inline void *lport_priv(const struct fc_lport *lport) 9353a3b42bfSRobert Love { 9363a3b42bfSRobert Love return (void *)(lport + 1); 9373a3b42bfSRobert Love } 9383a3b42bfSRobert Love 9393a3b42bfSRobert Love /** 9403a3b42bfSRobert Love * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and 9413a3b42bfSRobert Love * LLD private data 9423a3b42bfSRobert Love * @sht: The SCSI host template 9433a3b42bfSRobert Love * @priv_size: Size of private data 944a0a25da2SVasu Dev * 94586221969SChris Leech * Returns: libfc lport 946a0a25da2SVasu Dev */ 94786221969SChris Leech static inline struct fc_lport * 948a0a25da2SVasu Dev libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 949a0a25da2SVasu Dev { 95086221969SChris Leech struct fc_lport *lport; 95186221969SChris Leech struct Scsi_Host *shost; 95286221969SChris Leech 95386221969SChris Leech shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 95486221969SChris Leech if (!shost) 95586221969SChris Leech return NULL; 95686221969SChris Leech lport = shost_priv(shost); 95786221969SChris Leech lport->host = shost; 95886221969SChris Leech INIT_LIST_HEAD(&lport->ema_list); 959174e1ebfSChris Leech INIT_LIST_HEAD(&lport->vports); 96086221969SChris Leech return lport; 961a0a25da2SVasu Dev } 96242e9a92fSRobert Love 96334f42a07SRobert Love /* 9643a3b42bfSRobert Love * FC_FCP HELPER FUNCTIONS 9653a3b42bfSRobert Love *****************************/ 9663a3b42bfSRobert Love static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 9673a3b42bfSRobert Love { 9683a3b42bfSRobert Love if (fsp && fsp->cmd) 9693a3b42bfSRobert Love return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 9703a3b42bfSRobert Love return false; 9713a3b42bfSRobert Love } 9723a3b42bfSRobert Love 9733a3b42bfSRobert Love /* 97442e9a92fSRobert Love * LOCAL PORT LAYER 97542e9a92fSRobert Love *****************************/ 9763a3b42bfSRobert Love int fc_lport_init(struct fc_lport *); 9773a3b42bfSRobert Love int fc_lport_destroy(struct fc_lport *); 9783a3b42bfSRobert Love int fc_fabric_logoff(struct fc_lport *); 9793a3b42bfSRobert Love int fc_fabric_login(struct fc_lport *); 9808faecddbSChris Leech void __fc_linkup(struct fc_lport *); 98142e9a92fSRobert Love void fc_linkup(struct fc_lport *); 9828faecddbSChris Leech void __fc_linkdown(struct fc_lport *); 98342e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 9843a3b42bfSRobert Love void fc_vport_setlink(struct fc_lport *); 9853a3b42bfSRobert Love void fc_vports_linkchange(struct fc_lport *); 98642e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 98742e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 9883a3b42bfSRobert Love int fc_set_mfs(struct fc_lport *, u32 mfs); 9893a3b42bfSRobert Love struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); 9903a3b42bfSRobert Love struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); 9913a3b42bfSRobert Love int fc_lport_bsg_request(struct fc_bsg_job *); 992a51ab396SSteve Ma 993a51ab396SSteve Ma /* 99442e9a92fSRobert Love * REMOTE PORT LAYER 99542e9a92fSRobert Love *****************************/ 9963a3b42bfSRobert Love int fc_rport_init(struct fc_lport *); 9973a3b42bfSRobert Love void fc_rport_terminate_io(struct fc_rport *); 99842e9a92fSRobert Love 99934f42a07SRobert Love /* 100042e9a92fSRobert Love * DISCOVERY LAYER 100142e9a92fSRobert Love *****************************/ 10023a3b42bfSRobert Love int fc_disc_init(struct fc_lport *); 100342e9a92fSRobert Love 100434f42a07SRobert Love /* 10053a3b42bfSRobert Love * FCP LAYER 100642e9a92fSRobert Love *****************************/ 100742e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 100842e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 100942e9a92fSRobert Love 101034f42a07SRobert Love /* 10113a3b42bfSRobert Love * SCSI INTERACTION LAYER 10123a3b42bfSRobert Love *****************************/ 10133a3b42bfSRobert Love int fc_queuecommand(struct scsi_cmnd *, 10143a3b42bfSRobert Love void (*done)(struct scsi_cmnd *)); 10153a3b42bfSRobert Love int fc_eh_abort(struct scsi_cmnd *); 10163a3b42bfSRobert Love int fc_eh_device_reset(struct scsi_cmnd *); 10173a3b42bfSRobert Love int fc_eh_host_reset(struct scsi_cmnd *); 10183a3b42bfSRobert Love int fc_slave_alloc(struct scsi_device *); 10193a3b42bfSRobert Love int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason); 10203a3b42bfSRobert Love int fc_change_queue_type(struct scsi_device *, int tag_type); 10213a3b42bfSRobert Love 10223a3b42bfSRobert Love /* 102342e9a92fSRobert Love * ELS/CT interface 102442e9a92fSRobert Love *****************************/ 10253a3b42bfSRobert Love int fc_elsct_init(struct fc_lport *); 10263a3b42bfSRobert Love struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, 10273a3b42bfSRobert Love struct fc_frame *, 102811b56188SChris Leech unsigned int op, 102911b56188SChris Leech void (*resp)(struct fc_seq *, 10303a3b42bfSRobert Love struct fc_frame *, 103111b56188SChris Leech void *arg), 103211b56188SChris Leech void *arg, u32 timer_msec); 103311b56188SChris Leech void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 103411b56188SChris Leech void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 103542e9a92fSRobert Love 103642e9a92fSRobert Love 103734f42a07SRobert Love /* 103842e9a92fSRobert Love * EXCHANGE MANAGER LAYER 103942e9a92fSRobert Love *****************************/ 10403a3b42bfSRobert Love int fc_exch_init(struct fc_lport *); 10413a3b42bfSRobert Love struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, 10423a3b42bfSRobert Love struct fc_exch_mgr *, 104396316099SVasu Dev bool (*match)(struct fc_frame *)); 10443a3b42bfSRobert Love void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); 1045174e1ebfSChris Leech int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 10463a3b42bfSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, 10473a3b42bfSRobert Love u16 min_xid, u16 max_xid, 104852ff878cSVasu Dev bool (*match)(struct fc_frame *)); 10493a3b42bfSRobert Love void fc_exch_mgr_free(struct fc_lport *); 10503a3b42bfSRobert Love void fc_exch_recv(struct fc_lport *, struct fc_frame *); 10511f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 105242e9a92fSRobert Love 105342e9a92fSRobert Love /* 105442e9a92fSRobert Love * Functions for fc_functions_template 105542e9a92fSRobert Love */ 10563a3b42bfSRobert Love void fc_get_host_speed(struct Scsi_Host *); 10573a3b42bfSRobert Love void fc_get_host_port_state(struct Scsi_Host *); 10583a3b42bfSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout); 105942e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 106042e9a92fSRobert Love 106142e9a92fSRobert Love #endif /* _LIBFC_H_ */ 1062