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 100a7b12a27SJoe Eykholt * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint 101a7b12a27SJoe Eykholt * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint 1023a3b42bfSRobert Love * @RPORT_ST_PLOGI: Waiting for PLOGI completion 1033a3b42bfSRobert Love * @RPORT_ST_PRLI: Waiting for PRLI completion 1043a3b42bfSRobert Love * @RPORT_ST_RTV: Waiting for RTV completion 1053a3b42bfSRobert Love * @RPORT_ST_READY: Ready for use 1063a3b42bfSRobert Love * @RPORT_ST_LOGO: Remote port logout (LOGO) sent 1073a3b42bfSRobert Love * @RPORT_ST_ADISC: Discover Address sent 1083a3b42bfSRobert Love * @RPORT_ST_DELETE: Remote port being deleted 1093a3b42bfSRobert Love */ 11042e9a92fSRobert Love enum fc_rport_state { 1113a3b42bfSRobert Love RPORT_ST_INIT, 112a7b12a27SJoe Eykholt RPORT_ST_FLOGI, 113a7b12a27SJoe Eykholt RPORT_ST_PLOGI_WAIT, 1143a3b42bfSRobert Love RPORT_ST_PLOGI, 1153a3b42bfSRobert Love RPORT_ST_PRLI, 1163a3b42bfSRobert Love RPORT_ST_RTV, 1173a3b42bfSRobert Love RPORT_ST_READY, 1183a3b42bfSRobert Love RPORT_ST_LOGO, 1193a3b42bfSRobert Love RPORT_ST_ADISC, 1203a3b42bfSRobert Love RPORT_ST_DELETE, 12142e9a92fSRobert Love }; 12242e9a92fSRobert Love 12342e9a92fSRobert Love /** 12442e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 12542e9a92fSRobert Love * @lp: Fibre Channel host port instance 1269737e6a7SRobert Love * @peers: Node for list management during discovery and RSCN processing 1279737e6a7SRobert Love * @rport_work: Work struct for starting the rport state machine 1289737e6a7SRobert Love * @port_id: Port ID of the discovered port 12942e9a92fSRobert Love */ 13042e9a92fSRobert Love struct fc_disc_port { 13142e9a92fSRobert Love struct fc_lport *lp; 13242e9a92fSRobert Love struct list_head peers; 13342e9a92fSRobert Love struct work_struct rport_work; 1349737e6a7SRobert Love u32 port_id; 13542e9a92fSRobert Love }; 13642e9a92fSRobert Love 1373a3b42bfSRobert Love /** 1383a3b42bfSRobert Love * enum fc_rport_event - Remote port events 1393a3b42bfSRobert Love * @RPORT_EV_NONE: No event 1403a3b42bfSRobert Love * @RPORT_EV_READY: Remote port is ready for use 1413a3b42bfSRobert Love * @RPORT_EV_FAILED: State machine failed, remote port is not ready 1423a3b42bfSRobert Love * @RPORT_EV_STOP: Remote port has been stopped 1433a3b42bfSRobert Love * @RPORT_EV_LOGO: Remote port logout (LOGO) sent 1443a3b42bfSRobert Love */ 14542e9a92fSRobert Love enum fc_rport_event { 14642e9a92fSRobert Love RPORT_EV_NONE = 0, 1474c0f62b5SJoe Eykholt RPORT_EV_READY, 14842e9a92fSRobert Love RPORT_EV_FAILED, 14942e9a92fSRobert Love RPORT_EV_STOP, 15042e9a92fSRobert Love RPORT_EV_LOGO 15142e9a92fSRobert Love }; 15242e9a92fSRobert Love 1539fb9d328SJoe Eykholt struct fc_rport_priv; 1549fb9d328SJoe Eykholt 1553a3b42bfSRobert Love /** 1563a3b42bfSRobert Love * struct fc_rport_operations - Operations for a remote port 1573a3b42bfSRobert Love * @event_callback: Function to be called for remote port events 1583a3b42bfSRobert Love */ 15942e9a92fSRobert Love struct fc_rport_operations { 1609fb9d328SJoe Eykholt void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, 16142e9a92fSRobert Love enum fc_rport_event); 16242e9a92fSRobert Love }; 16342e9a92fSRobert Love 16442e9a92fSRobert Love /** 16542e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 1663a3b42bfSRobert Love * @local_port: The associated local port 1673a3b42bfSRobert Love * @rp_state: Indicates READY for I/O or DELETE when blocked 1689e9d0452SJoe Eykholt * @flags: REC and RETRY supported flags 1693a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1703a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1719e9d0452SJoe Eykholt */ 1729e9d0452SJoe Eykholt struct fc_rport_libfc_priv { 1739e9d0452SJoe Eykholt struct fc_lport *local_port; 1749e9d0452SJoe Eykholt enum fc_rport_state rp_state; 1759e9d0452SJoe Eykholt u16 flags; 1769e9d0452SJoe Eykholt #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 1779e9d0452SJoe Eykholt #define FC_RP_FLAGS_RETRY (1 << 1) 1784b2164d4SJoe Eykholt #define FC_RP_STARTED (1 << 2) 1799e9d0452SJoe Eykholt unsigned int e_d_tov; 1809e9d0452SJoe Eykholt unsigned int r_a_tov; 1819e9d0452SJoe Eykholt }; 1829e9d0452SJoe Eykholt 1839e9d0452SJoe Eykholt /** 1843a3b42bfSRobert Love * struct fc_rport_priv - libfc remote port and discovery info 1853a3b42bfSRobert Love * @local_port: The associated local port 1863a3b42bfSRobert Love * @rport: The FC transport remote port 1873a3b42bfSRobert Love * @kref: Reference counter 1883a3b42bfSRobert Love * @rp_state: Enumeration that tracks progress of PLOGI, PRLI, 1893a3b42bfSRobert Love * and RTV exchanges 1903a3b42bfSRobert Love * @ids: The remote port identifiers and roles 1914b2164d4SJoe Eykholt * @flags: STARTED, REC and RETRY_SUPPORTED flags 1923a3b42bfSRobert Love * @max_seq: Maximum number of concurrent sequences 1933a3b42bfSRobert Love * @disc_id: The discovery identifier 1943a3b42bfSRobert Love * @maxframe_size: The maximum frame size 1953a3b42bfSRobert Love * @retries: The retry count for the current state 196f034260dSJoe Eykholt * @major_retries: The retry count for the entire PLOGI/PRLI state machine 1973a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1983a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1993a3b42bfSRobert Love * @rp_mutex: The mutex that protects the remote port 2003a3b42bfSRobert Love * @retry_work: Handle for retries 2013a3b42bfSRobert Love * @event_callback: Callback when READY, FAILED or LOGO states complete 20242e90414SJoe Eykholt * @rcu: Structure used for freeing in an RCU-safe manner 20342e9a92fSRobert Love */ 2049e9d0452SJoe Eykholt struct fc_rport_priv { 20542e9a92fSRobert Love struct fc_lport *local_port; 206f211fa51SJoe Eykholt struct fc_rport *rport; 207f211fa51SJoe Eykholt struct kref kref; 20842e9a92fSRobert Love enum fc_rport_state rp_state; 209f211fa51SJoe Eykholt struct fc_rport_identifiers ids; 21042e9a92fSRobert Love u16 flags; 21142e9a92fSRobert Love u16 max_seq; 2120f6c6149SJoe Eykholt u16 disc_id; 213f211fa51SJoe Eykholt u16 maxframe_size; 21442e9a92fSRobert Love unsigned int retries; 215f034260dSJoe Eykholt unsigned int major_retries; 21642e9a92fSRobert Love unsigned int e_d_tov; 21742e9a92fSRobert Love unsigned int r_a_tov; 21842e9a92fSRobert Love struct mutex rp_mutex; 21942e9a92fSRobert Love struct delayed_work retry_work; 22042e9a92fSRobert Love enum fc_rport_event event; 22142e9a92fSRobert Love struct fc_rport_operations *ops; 22242e9a92fSRobert Love struct list_head peers; 22342e9a92fSRobert Love struct work_struct event_work; 224f211fa51SJoe Eykholt u32 supported_classes; 22542e90414SJoe Eykholt struct rcu_head rcu; 22642e9a92fSRobert Love }; 22742e9a92fSRobert Love 2283a3b42bfSRobert Love /** 2293a3b42bfSRobert Love * struct fcoe_dev_stats - fcoe stats structure 2303a3b42bfSRobert Love * @SecondsSinceLastReset: Seconds since the last reset 2313a3b42bfSRobert Love * @TxFrames: Number of transmitted frames 2323a3b42bfSRobert Love * @TxWords: Number of transmitted words 2333a3b42bfSRobert Love * @RxFrames: Number of received frames 2343a3b42bfSRobert Love * @RxWords: Number of received words 2353a3b42bfSRobert Love * @ErrorFrames: Number of received error frames 2363a3b42bfSRobert Love * @DumpedFrames: Number of dumped frames 2373a3b42bfSRobert Love * @LinkFailureCount: Number of link failures 2383a3b42bfSRobert Love * @LossOfSignalCount: Number for signal losses 2393a3b42bfSRobert Love * @InvalidTxWordCount: Number of invalid transmitted words 2403a3b42bfSRobert Love * @InvalidCRCCount: Number of invalid CRCs 2413a3b42bfSRobert Love * @InputRequests: Number of input requests 2423a3b42bfSRobert Love * @OutputRequests: Number of output requests 2433a3b42bfSRobert Love * @ControlRequests: Number of control requests 2443a3b42bfSRobert Love * @InputMegabytes: Number of received megabytes 2453a3b42bfSRobert Love * @OutputMegabytes: Number of transmitted megabytes 2466580bbd0SYi Zou * @VLinkFailureCount: Number of virtual link failures 2476580bbd0SYi Zou * @MissDiscAdvCount: Number of missing FIP discovery advertisement 24842e9a92fSRobert Love */ 24942e9a92fSRobert Love struct fcoe_dev_stats { 25042e9a92fSRobert Love u64 SecondsSinceLastReset; 25142e9a92fSRobert Love u64 TxFrames; 25242e9a92fSRobert Love u64 TxWords; 25342e9a92fSRobert Love u64 RxFrames; 25442e9a92fSRobert Love u64 RxWords; 25542e9a92fSRobert Love u64 ErrorFrames; 25642e9a92fSRobert Love u64 DumpedFrames; 25742e9a92fSRobert Love u64 LinkFailureCount; 25842e9a92fSRobert Love u64 LossOfSignalCount; 25942e9a92fSRobert Love u64 InvalidTxWordCount; 26042e9a92fSRobert Love u64 InvalidCRCCount; 26142e9a92fSRobert Love u64 InputRequests; 26242e9a92fSRobert Love u64 OutputRequests; 26342e9a92fSRobert Love u64 ControlRequests; 26442e9a92fSRobert Love u64 InputMegabytes; 26542e9a92fSRobert Love u64 OutputMegabytes; 2666580bbd0SYi Zou u64 VLinkFailureCount; 2676580bbd0SYi Zou u64 MissDiscAdvCount; 26842e9a92fSRobert Love }; 26942e9a92fSRobert Love 2703a3b42bfSRobert Love /** 2713a3b42bfSRobert Love * struct fc_seq_els_data - ELS data used for passing ELS specific responses 2723a3b42bfSRobert Love * @fp: The ELS frame 2733a3b42bfSRobert Love * @reason: The reason for rejection 2743a3b42bfSRobert Love * @explan: The explaination of the rejection 2753a3b42bfSRobert Love * 2763a3b42bfSRobert Love * Mainly used by the exchange manager layer. 27742e9a92fSRobert Love */ 27842e9a92fSRobert Love struct fc_seq_els_data { 27942e9a92fSRobert Love struct fc_frame *fp; 28042e9a92fSRobert Love enum fc_els_rjt_reason reason; 28142e9a92fSRobert Love enum fc_els_rjt_explan explan; 28242e9a92fSRobert Love }; 28342e9a92fSRobert Love 2843a3b42bfSRobert Love /** 2853a3b42bfSRobert Love * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request) 2863a3b42bfSRobert Love * @lp: The associated local port 2873a3b42bfSRobert Love * @state: The state of the I/O 2883a3b42bfSRobert Love * @tgt_flags: Target's flags 2893a3b42bfSRobert Love * @ref_cnt: Reference count 2903a3b42bfSRobert Love * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the 2913a3b42bfSRobert Love * host_lock if both are to be held at the same time) 2923a3b42bfSRobert Love * @cmd: The SCSI command (set and clear with the host_lock held) 2933a3b42bfSRobert Love * @list: Tracks queued commands (accessed with the host_lock held) 2943a3b42bfSRobert Love * @timer: The command timer 2953a3b42bfSRobert Love * @tm_done: Completion indicator 2963a3b42bfSRobert Love * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies) 2973a3b42bfSRobert Love * @start_time: Timestamp indicating the start of the I/O (in jiffies) 2983a3b42bfSRobert Love * @end_time: Timestamp indicating the end of the I/O (in jiffies) 2993a3b42bfSRobert Love * @last_pkt_time: Timestamp of the last frame received (in jiffies) 3003a3b42bfSRobert Love * @data_len: The length of the data 3013a3b42bfSRobert Love * @cdb_cmd: The CDB command 3023a3b42bfSRobert Love * @xfer_len: The transfer length 3033a3b42bfSRobert Love * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange 3043a3b42bfSRobert Love * will be set here if DDP was setup) 3053a3b42bfSRobert Love * @xfer_contig_end: The offset into the buffer if the buffer is contiguous 3063a3b42bfSRobert Love * (Tx and Rx) 3073a3b42bfSRobert Love * @max_payload: The maximum payload size (in bytes) 3083a3b42bfSRobert Love * @io_status: SCSI result (upper 24 bits) 3093a3b42bfSRobert Love * @cdb_status: CDB status 3103a3b42bfSRobert Love * @status_code: FCP I/O status 3113a3b42bfSRobert Love * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun) 3123a3b42bfSRobert Love * @req_flags: Request flags (bit 0: read bit:1 write) 3133a3b42bfSRobert Love * @scsi_resid: SCSI residule length 3143a3b42bfSRobert Love * @rport: The remote port that the SCSI command is targeted at 3153a3b42bfSRobert Love * @seq_ptr: The sequence that will carry the SCSI command 3163a3b42bfSRobert Love * @recov_retry: Number of recovery retries 3173a3b42bfSRobert Love * @recov_seq: The sequence for REC or SRR 31842e9a92fSRobert Love */ 31942e9a92fSRobert Love struct fc_fcp_pkt { 3203a3b42bfSRobert Love /* Housekeeping information */ 3213a3b42bfSRobert Love struct fc_lport *lp; 3223a3b42bfSRobert Love u16 state; 3233a3b42bfSRobert Love u16 tgt_flags; 3243a3b42bfSRobert Love atomic_t ref_cnt; 3253a3b42bfSRobert Love spinlock_t scsi_pkt_lock; 3263a3b42bfSRobert Love 3273a3b42bfSRobert Love /* SCSI I/O related information */ 3283a3b42bfSRobert Love struct scsi_cmnd *cmd; 3293a3b42bfSRobert Love struct list_head list; 3303a3b42bfSRobert Love 3313a3b42bfSRobert Love /* Timeout related information */ 3323a3b42bfSRobert Love struct timer_list timer; 33342e9a92fSRobert Love struct completion tm_done; 33442e9a92fSRobert Love int wait_for_comp; 3353a3b42bfSRobert Love unsigned long start_time; 3363a3b42bfSRobert Love unsigned long end_time; 3373a3b42bfSRobert Love unsigned long last_pkt_time; 33842e9a92fSRobert Love 3393a3b42bfSRobert Love /* SCSI command and data transfer information */ 34042e9a92fSRobert Love u32 data_len; 3413a3b42bfSRobert Love 3423a3b42bfSRobert Love /* Transport related veriables */ 34342e9a92fSRobert Love struct fcp_cmnd cdb_cmd; 34442e9a92fSRobert Love size_t xfer_len; 3453a3b42bfSRobert Love u16 xfer_ddp; 3463a3b42bfSRobert Love u32 xfer_contig_end; 3473a3b42bfSRobert Love u16 max_payload; 34842e9a92fSRobert Love 3493a3b42bfSRobert Love /* SCSI/FCP return status */ 3503a3b42bfSRobert Love u32 io_status; 35142e9a92fSRobert Love u8 cdb_status; 3523a3b42bfSRobert Love u8 status_code; 35342e9a92fSRobert Love u8 scsi_comp_flags; 3543a3b42bfSRobert Love u32 req_flags; 3553a3b42bfSRobert Love u32 scsi_resid; 35642e9a92fSRobert Love 3573a3b42bfSRobert Love /* Associated structures */ 3583a3b42bfSRobert Love struct fc_rport *rport; 3593a3b42bfSRobert Love struct fc_seq *seq_ptr; 3603a3b42bfSRobert Love 3613a3b42bfSRobert Love /* Error Processing information */ 3623a3b42bfSRobert Love u8 recov_retry; 3633a3b42bfSRobert Love struct fc_seq *recov_seq; 36442e9a92fSRobert Love }; 36542e9a92fSRobert Love 36642e9a92fSRobert Love /* 36742e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 36842e9a92fSRobert Love * and Sequences 36942e9a92fSRobert Love * 37042e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 37142e9a92fSRobert Love * 37242e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 37342e9a92fSRobert Love */ 37442e9a92fSRobert Love 37542e9a92fSRobert Love struct fc_exch_mgr; 37696316099SVasu Dev struct fc_exch_mgr_anchor; 377e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 37842e9a92fSRobert Love 3793a3b42bfSRobert Love /** 3803a3b42bfSRobert Love * struct fc_seq - FC sequence 3813a3b42bfSRobert Love * @id: The sequence ID 3823a3b42bfSRobert Love * @ssb_stat: Status flags for the sequence status block (SSB) 3833a3b42bfSRobert Love * @cnt: Number of frames sent so far 3843a3b42bfSRobert Love * @rec_data: FC-4 value for REC 38542e9a92fSRobert Love */ 38642e9a92fSRobert Love struct fc_seq { 3873a3b42bfSRobert Love u8 id; 3883a3b42bfSRobert Love u16 ssb_stat; 3893a3b42bfSRobert Love u16 cnt; 3903a3b42bfSRobert Love u32 rec_data; 39142e9a92fSRobert Love }; 39242e9a92fSRobert Love 39342e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 39442e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 39542e9a92fSRobert Love 3963a3b42bfSRobert Love /** 3973a3b42bfSRobert Love * struct fc_exch - Fibre Channel Exchange 3983a3b42bfSRobert Love * @em: Exchange manager 3993a3b42bfSRobert Love * @pool: Exchange pool 4003a3b42bfSRobert Love * @state: The exchange's state 4013a3b42bfSRobert Love * @xid: The exchange ID 4023a3b42bfSRobert Love * @ex_list: Handle used by the EM to track free exchanges 4033a3b42bfSRobert Love * @ex_lock: Lock that protects the exchange 4043a3b42bfSRobert Love * @ex_refcnt: Reference count 4053a3b42bfSRobert Love * @timeout_work: Handle for timeout handler 4063a3b42bfSRobert Love * @lp: The local port that this exchange is on 4073a3b42bfSRobert Love * @oxid: Originator's exchange ID 4083a3b42bfSRobert Love * @rxid: Responder's exchange ID 4093a3b42bfSRobert Love * @oid: Originator's FCID 4103a3b42bfSRobert Love * @sid: Source FCID 4113a3b42bfSRobert Love * @did: Destination FCID 4123a3b42bfSRobert Love * @esb_stat: ESB exchange status 4133a3b42bfSRobert Love * @r_a_tov: Resouce allocation time out value (in msecs) 4143a3b42bfSRobert Love * @seq_id: The next sequence ID to use 4153a3b42bfSRobert Love * @f_ctl: F_CTL flags for the sequence 4163a3b42bfSRobert Love * @fh_type: The frame type 4173a3b42bfSRobert Love * @class: The class of service 4183a3b42bfSRobert Love * @seq: The sequence in use on this exchange 4193a3b42bfSRobert Love * @resp: Callback for responses on this exchange 4203a3b42bfSRobert Love * @destructor: Called when destroying the exchange 4213a3b42bfSRobert Love * @arg: Passed as a void pointer to the resp() callback 42242e9a92fSRobert Love * 42342e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 42442e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 42542e9a92fSRobert Love * seq_id 42642e9a92fSRobert Love * sequence allocation 42742e9a92fSRobert Love */ 42842e9a92fSRobert Love struct fc_exch { 4293a3b42bfSRobert Love struct fc_exch_mgr *em; 4303a3b42bfSRobert Love struct fc_exch_pool *pool; 4313a3b42bfSRobert Love u32 state; 4323a3b42bfSRobert Love u16 xid; 4333a3b42bfSRobert Love struct list_head ex_list; 4343a3b42bfSRobert Love spinlock_t ex_lock; 4353a3b42bfSRobert Love atomic_t ex_refcnt; 4363a3b42bfSRobert Love struct delayed_work timeout_work; 4373a3b42bfSRobert Love struct fc_lport *lp; 4383a3b42bfSRobert Love u16 oxid; 4393a3b42bfSRobert Love u16 rxid; 4403a3b42bfSRobert Love u32 oid; 4413a3b42bfSRobert Love u32 sid; 4423a3b42bfSRobert Love u32 did; 4433a3b42bfSRobert Love u32 esb_stat; 4443a3b42bfSRobert Love u32 r_a_tov; 4453a3b42bfSRobert Love u8 seq_id; 4463a3b42bfSRobert Love u32 f_ctl; 4473a3b42bfSRobert Love u8 fh_type; 4483a3b42bfSRobert Love enum fc_class class; 4493a3b42bfSRobert Love struct fc_seq seq; 4503a3b42bfSRobert Love 45142e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 45242e9a92fSRobert Love void *arg; 4533a3b42bfSRobert Love 4543a3b42bfSRobert Love void (*destructor)(struct fc_seq *, void *); 4553a3b42bfSRobert Love 45642e9a92fSRobert Love }; 45742e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 45842e9a92fSRobert Love 45942e9a92fSRobert Love 4603a3b42bfSRobert Love struct libfc_function_template { 46142e9a92fSRobert Love /* 46242e9a92fSRobert Love * Interface to send a FC frame 4630ae4d4aeSRobert Love * 4640ae4d4aeSRobert Love * STATUS: REQUIRED 46542e9a92fSRobert Love */ 4663a3b42bfSRobert Love int (*frame_send)(struct fc_lport *, struct fc_frame *); 46742e9a92fSRobert Love 46842e9a92fSRobert Love /* 4690ae4d4aeSRobert Love * Interface to send ELS/CT frames 4700ae4d4aeSRobert Love * 4710ae4d4aeSRobert Love * STATUS: OPTIONAL 47242e9a92fSRobert Love */ 4733a3b42bfSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, 4743a3b42bfSRobert Love struct fc_frame *, unsigned int op, 47542e9a92fSRobert Love void (*resp)(struct fc_seq *, 4763a3b42bfSRobert Love struct fc_frame *, void *arg), 47742e9a92fSRobert Love void *arg, u32 timer_msec); 47842e9a92fSRobert Love 47942e9a92fSRobert Love /* 48042e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 48142e9a92fSRobert Love * 48242e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 48342e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 48442e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 48542e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 48642e9a92fSRobert Love * as error using IS_ERR related macros. 48742e9a92fSRobert Love * 48842e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 48942e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 49042e9a92fSRobert Love * is about to free, this can be used by caller to free its 49142e9a92fSRobert Love * resources along with exchange free. 49242e9a92fSRobert Love * 49342e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 49442e9a92fSRobert Love * 49542e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 49642e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 49742e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 49842e9a92fSRobert Love * is registered by EM layer. 4990ae4d4aeSRobert Love * 5000ae4d4aeSRobert Love * STATUS: OPTIONAL 50142e9a92fSRobert Love */ 5023a3b42bfSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *, 5033a3b42bfSRobert Love void (*resp)(struct fc_seq *, 5043a3b42bfSRobert Love struct fc_frame *, 5053a3b42bfSRobert Love void *), 5063a3b42bfSRobert Love void (*destructor)(struct fc_seq *, 5073a3b42bfSRobert Love void *), 5083a3b42bfSRobert Love void *, unsigned int timer_msec); 50942e9a92fSRobert Love 51042e9a92fSRobert Love /* 511b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given 512b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive. 513b277d2aaSYi Zou * 514b277d2aaSYi Zou * STATUS: OPTIONAL 515b277d2aaSYi Zou */ 5163a3b42bfSRobert Love int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, 5173a3b42bfSRobert Love unsigned int); 518b277d2aaSYi Zou /* 519b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed 520b277d2aaSYi Zou * for the given exchange id. 521b277d2aaSYi Zou * 522b277d2aaSYi Zou * STATUS: OPTIONAL 523b277d2aaSYi Zou */ 5243a3b42bfSRobert Love int (*ddp_done)(struct fc_lport *, u16); 525b277d2aaSYi Zou /* 526b84056bfSYi Zou * Allow LLD to fill its own Link Error Status Block 527b84056bfSYi Zou * 528b84056bfSYi Zou * STATUS: OPTIONAL 529b84056bfSYi Zou */ 530b84056bfSYi Zou void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb); 531b84056bfSYi Zou /* 5320ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 5330ae4d4aeSRobert Love * 5340ae4d4aeSRobert Love * STATUS: OPTIONAL 53542e9a92fSRobert Love */ 5363a3b42bfSRobert Love int (*seq_send)(struct fc_lport *, struct fc_seq *, 5373a3b42bfSRobert Love struct fc_frame *); 53842e9a92fSRobert Love 53942e9a92fSRobert Love /* 5400ae4d4aeSRobert Love * Send an ELS response using infomation from a previous 5410ae4d4aeSRobert Love * exchange and sequence. 5420ae4d4aeSRobert Love * 5430ae4d4aeSRobert Love * STATUS: OPTIONAL 54442e9a92fSRobert Love */ 5453a3b42bfSRobert Love void (*seq_els_rsp_send)(struct fc_seq *, enum fc_els_cmd, 5463a3b42bfSRobert Love struct fc_seq_els_data *); 54742e9a92fSRobert Love 54842e9a92fSRobert Love /* 54942e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 55042e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 55142e9a92fSRobert Love * 55242e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 55342e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 55442e9a92fSRobert Love * will be called with timeout error if no response to abort. 5550ae4d4aeSRobert Love * 5560ae4d4aeSRobert Love * STATUS: OPTIONAL 55742e9a92fSRobert Love */ 5583a3b42bfSRobert Love int (*seq_exch_abort)(const struct fc_seq *, 55942e9a92fSRobert Love unsigned int timer_msec); 56042e9a92fSRobert Love 56142e9a92fSRobert Love /* 56242e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 56342e9a92fSRobert Love * allocated for the related objects may be freed. 5640ae4d4aeSRobert Love * 5650ae4d4aeSRobert Love * STATUS: OPTIONAL 56642e9a92fSRobert Love */ 5673a3b42bfSRobert Love void (*exch_done)(struct fc_seq *); 56842e9a92fSRobert Love 56942e9a92fSRobert Love /* 57042e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 5710ae4d4aeSRobert Love * 5720ae4d4aeSRobert Love * STATUS: OPTIONAL 57342e9a92fSRobert Love */ 5743a3b42bfSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *); 57542e9a92fSRobert Love 57642e9a92fSRobert Love /* 57742e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 57842e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 57942e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 5800ae4d4aeSRobert Love * 5810ae4d4aeSRobert Love * STATUS: OPTIONAL 58242e9a92fSRobert Love */ 5833a3b42bfSRobert Love void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); 58442e9a92fSRobert Love 5850ae4d4aeSRobert Love /* 5860ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 5870ae4d4aeSRobert Love * 5880ae4d4aeSRobert Love * STATUS: OPTIONAL 58942e9a92fSRobert Love */ 5900ae4d4aeSRobert Love void (*rport_flush_queue)(void); 59142e9a92fSRobert Love 59242e9a92fSRobert Love /* 5930ae4d4aeSRobert Love * Receive a frame for a local port. 5940ae4d4aeSRobert Love * 5950ae4d4aeSRobert Love * STATUS: OPTIONAL 59642e9a92fSRobert Love */ 5973a3b42bfSRobert Love void (*lport_recv)(struct fc_lport *, struct fc_seq *, 5983a3b42bfSRobert Love struct fc_frame *); 59942e9a92fSRobert Love 6000ae4d4aeSRobert Love /* 6010ae4d4aeSRobert Love * Reset the local port. 6020ae4d4aeSRobert Love * 6030ae4d4aeSRobert Love * STATUS: OPTIONAL 60442e9a92fSRobert Love */ 6050ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 60642e9a92fSRobert Love 60742e9a92fSRobert Love /* 608093bb6a2SJoe Eykholt * Set the local port FC_ID. 609093bb6a2SJoe Eykholt * 610093bb6a2SJoe Eykholt * This may be provided by the LLD to allow it to be 611093bb6a2SJoe Eykholt * notified when the local port is assigned a FC-ID. 612093bb6a2SJoe Eykholt * 613093bb6a2SJoe Eykholt * The frame, if non-NULL, is the incoming frame with the 614093bb6a2SJoe Eykholt * FLOGI LS_ACC or FLOGI, and may contain the granted MAC 615093bb6a2SJoe Eykholt * address for the LLD. The frame pointer may be NULL if 616093bb6a2SJoe Eykholt * no MAC is associated with this assignment (LOGO or PLOGI). 617093bb6a2SJoe Eykholt * 618093bb6a2SJoe Eykholt * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid. 619093bb6a2SJoe Eykholt * 620093bb6a2SJoe Eykholt * Note: this is called with the local port mutex held. 621093bb6a2SJoe Eykholt * 622093bb6a2SJoe Eykholt * STATUS: OPTIONAL 623093bb6a2SJoe Eykholt */ 624093bb6a2SJoe Eykholt void (*lport_set_port_id)(struct fc_lport *, u32 port_id, 625093bb6a2SJoe Eykholt struct fc_frame *); 626093bb6a2SJoe Eykholt 627093bb6a2SJoe Eykholt /* 6289737e6a7SRobert Love * Create a remote port with a given port ID 6299737e6a7SRobert Love * 6309737e6a7SRobert Love * STATUS: OPTIONAL 6315101ff99SRobert Love */ 6329737e6a7SRobert Love struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 6335101ff99SRobert Love 6345101ff99SRobert Love /* 63542e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 63642e9a92fSRobert Love * This function will issue the following commands to the N_Port 63742e9a92fSRobert Love * identified by the FC ID provided. 63842e9a92fSRobert Love * 63942e9a92fSRobert Love * - PLOGI 64042e9a92fSRobert Love * - PRLI 64142e9a92fSRobert Love * - RTV 6420ae4d4aeSRobert Love * 6430ae4d4aeSRobert Love * STATUS: OPTIONAL 64442e9a92fSRobert Love */ 6459fb9d328SJoe Eykholt int (*rport_login)(struct fc_rport_priv *); 64642e9a92fSRobert Love 64742e9a92fSRobert Love /* 64842e9a92fSRobert Love * Logoff, and remove the rport from the transport if 64942e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 6500ae4d4aeSRobert Love * 6510ae4d4aeSRobert Love * STATUS: OPTIONAL 65242e9a92fSRobert Love */ 6539fb9d328SJoe Eykholt int (*rport_logoff)(struct fc_rport_priv *); 65442e9a92fSRobert Love 65542e9a92fSRobert Love /* 65642e9a92fSRobert Love * Recieve a request from a remote port. 6570ae4d4aeSRobert Love * 6580ae4d4aeSRobert Love * STATUS: OPTIONAL 65942e9a92fSRobert Love */ 66042e9a92fSRobert Love void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 661131203a1SJoe Eykholt struct fc_lport *); 66242e9a92fSRobert Love 6630ae4d4aeSRobert Love /* 6640ae4d4aeSRobert Love * lookup an rport by it's port ID. 6650ae4d4aeSRobert Love * 6660ae4d4aeSRobert Love * STATUS: OPTIONAL 66742e9a92fSRobert Love */ 6689fb9d328SJoe Eykholt struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 66942e9a92fSRobert Love 67042e9a92fSRobert Love /* 671f211fa51SJoe Eykholt * Destroy an rport after final kref_put(). 672f211fa51SJoe Eykholt * The argument is a pointer to the kref inside the fc_rport_priv. 673f211fa51SJoe Eykholt */ 674f211fa51SJoe Eykholt void (*rport_destroy)(struct kref *); 675f211fa51SJoe Eykholt 676f211fa51SJoe Eykholt /* 67742e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 67842e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 67942e9a92fSRobert Love * 68042e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 68142e9a92fSRobert Love * 6820ae4d4aeSRobert Love * STATUS: OPTIONAL 68342e9a92fSRobert Love */ 6843a3b42bfSRobert Love int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, 6853a3b42bfSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, 6863a3b42bfSRobert Love void *)); 68742e9a92fSRobert Love 68842e9a92fSRobert Love /* 6890ae4d4aeSRobert Love * Cleanup the FCP layer, used durring link down and reset 6900ae4d4aeSRobert Love * 6910ae4d4aeSRobert Love * STATUS: OPTIONAL 69242e9a92fSRobert Love */ 6933a3b42bfSRobert Love void (*fcp_cleanup)(struct fc_lport *); 69442e9a92fSRobert Love 69542e9a92fSRobert Love /* 69642e9a92fSRobert Love * Abort all I/O on a local port 6970ae4d4aeSRobert Love * 6980ae4d4aeSRobert Love * STATUS: OPTIONAL 69942e9a92fSRobert Love */ 7003a3b42bfSRobert Love void (*fcp_abort_io)(struct fc_lport *); 70142e9a92fSRobert Love 7020ae4d4aeSRobert Love /* 7030ae4d4aeSRobert Love * Receive a request for the discovery layer. 7040ae4d4aeSRobert Love * 7050ae4d4aeSRobert Love * STATUS: OPTIONAL 70642e9a92fSRobert Love */ 7073a3b42bfSRobert Love void (*disc_recv_req)(struct fc_seq *, struct fc_frame *, 7083a3b42bfSRobert Love struct fc_lport *); 70942e9a92fSRobert Love 71042e9a92fSRobert Love /* 71142e9a92fSRobert Love * Start discovery for a local port. 7120ae4d4aeSRobert Love * 7130ae4d4aeSRobert Love * STATUS: OPTIONAL 71442e9a92fSRobert Love */ 71542e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 71642e9a92fSRobert Love enum fc_disc_event), 71742e9a92fSRobert Love struct fc_lport *); 71842e9a92fSRobert Love 71942e9a92fSRobert Love /* 72042e9a92fSRobert Love * Stop discovery for a given lport. This will remove 72142e9a92fSRobert Love * all discovered rports 7220ae4d4aeSRobert Love * 7230ae4d4aeSRobert Love * STATUS: OPTIONAL 72442e9a92fSRobert Love */ 72542e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 72642e9a92fSRobert Love 72742e9a92fSRobert Love /* 72842e9a92fSRobert Love * Stop discovery for a given lport. This will block 72942e9a92fSRobert Love * until all discovered rports are deleted from the 73042e9a92fSRobert Love * FC transport class 7310ae4d4aeSRobert Love * 7320ae4d4aeSRobert Love * STATUS: OPTIONAL 73342e9a92fSRobert Love */ 73442e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 73542e9a92fSRobert Love }; 73642e9a92fSRobert Love 7373a3b42bfSRobert Love /** 7383a3b42bfSRobert Love * struct fc_disc - Discovery context 7393a3b42bfSRobert Love * @retry_count: Number of retries 7403a3b42bfSRobert Love * @pending: 1 if discovery is pending, 0 if not 7413a3b42bfSRobert Love * @requesting: 1 if discovery has been requested, 0 if not 7423a3b42bfSRobert Love * @seq_count: Number of sequences used for discovery 7433a3b42bfSRobert Love * @buf_len: Length of the discovery buffer 7443a3b42bfSRobert Love * @disc_id: Discovery ID 7453a3b42bfSRobert Love * @rports: List of discovered remote ports 7460685230cSJoe Eykholt * @priv: Private pointer for use by discovery code 7473a3b42bfSRobert Love * @disc_mutex: Mutex that protects the discovery context 7483a3b42bfSRobert Love * @partial_buf: Partial name buffer (if names are returned 7493a3b42bfSRobert Love * in multiple frames) 7503a3b42bfSRobert Love * @disc_work: handle for delayed work context 7513a3b42bfSRobert Love * @disc_callback: Callback routine called when discovery completes 7523a3b42bfSRobert Love */ 75342e9a92fSRobert Love struct fc_disc { 75442e9a92fSRobert Love unsigned char retry_count; 75542e9a92fSRobert Love unsigned char pending; 75642e9a92fSRobert Love unsigned char requested; 75742e9a92fSRobert Love unsigned short seq_count; 75842e9a92fSRobert Love unsigned char buf_len; 7590f6c6149SJoe Eykholt u16 disc_id; 76042e9a92fSRobert Love 76142e9a92fSRobert Love struct list_head rports; 7620685230cSJoe Eykholt void *priv; 76342e9a92fSRobert Love struct mutex disc_mutex; 7643a3b42bfSRobert Love struct fc_gpn_ft_resp partial_buf; 76542e9a92fSRobert Love struct delayed_work disc_work; 7663a3b42bfSRobert Love 7673a3b42bfSRobert Love void (*disc_callback)(struct fc_lport *, 7683a3b42bfSRobert Love enum fc_disc_event); 76942e9a92fSRobert Love }; 77042e9a92fSRobert Love 7713a3b42bfSRobert Love /** 7723a3b42bfSRobert Love * struct fc_lport - Local port 7733a3b42bfSRobert Love * @host: The SCSI host associated with a local port 7743a3b42bfSRobert Love * @ema_list: Exchange manager anchor list 7753a3b42bfSRobert Love * @dns_rdata: The directory server remote port 7763a3b42bfSRobert Love * @ptp_rdata: Point to point remote port 7773a3b42bfSRobert Love * @scsi_priv: FCP layer internal data 7783a3b42bfSRobert Love * @disc: Discovery context 7793a3b42bfSRobert Love * @vports: Child vports if N_Port 7803a3b42bfSRobert Love * @vport: Parent vport if VN_Port 7813a3b42bfSRobert Love * @tt: Libfc function template 7823a3b42bfSRobert Love * @link_up: Link state (1 = link up, 0 = link down) 7833a3b42bfSRobert Love * @qfull: Queue state (1 queue is full, 0 queue is not full) 7843a3b42bfSRobert Love * @state: Identifies the state 7853a3b42bfSRobert Love * @boot_time: Timestamp indicating when the local port came online 7863a3b42bfSRobert Love * @host_stats: SCSI host statistics 7873a3b42bfSRobert Love * @dev_stats: FCoE device stats (TODO: libfc should not be 7883a3b42bfSRobert Love * FCoE aware) 7893a3b42bfSRobert Love * @retry_count: Number of retries in the current state 7907b2787ecSRobert Love * @port_id: FC Port ID 7913a3b42bfSRobert Love * @wwpn: World Wide Port Name 7923a3b42bfSRobert Love * @wwnn: World Wide Node Name 7933a3b42bfSRobert Love * @service_params: Common service parameters 7943a3b42bfSRobert Love * @e_d_tov: Error detection timeout value 7953a3b42bfSRobert Love * @r_a_tov: Resouce allocation timeout value 7963a3b42bfSRobert Love * @rnid_gen: RNID information 7973a3b42bfSRobert Love * @sg_supp: Indicates if scatter gather is supported 7983a3b42bfSRobert Love * @seq_offload: Indicates if sequence offload is supported 7993a3b42bfSRobert Love * @crc_offload: Indicates if CRC offload is supported 8003a3b42bfSRobert Love * @lro_enabled: Indicates if large receive offload is supported 8013a3b42bfSRobert Love * @does_npiv: Supports multiple vports 8023a3b42bfSRobert Love * @npiv_enabled: Switch/fabric allows NPIV 8033a3b42bfSRobert Love * @mfs: The maximum Fibre Channel payload size 8043a3b42bfSRobert Love * @max_retry_count: The maximum retry attempts 8053a3b42bfSRobert Love * @max_rport_retry_count: The maximum remote port retry attempts 806f90377abSJoe Eykholt * @rport_priv_size: Size needed by driver after struct fc_rport_priv 8073a3b42bfSRobert Love * @lro_xid: The maximum XID for LRO 8083a3b42bfSRobert Love * @lso_max: The maximum large offload send size 8093a3b42bfSRobert Love * @fcts: FC-4 type mask 8103a3b42bfSRobert Love * @lp_mutex: Mutex to protect the local port 8113a3b42bfSRobert Love * @list: Handle for list of local ports 8123a3b42bfSRobert Love * @retry_work: Handle to local port for delayed retry context 8133a3b42bfSRobert Love */ 81442e9a92fSRobert Love struct fc_lport { 81542e9a92fSRobert Love /* Associations */ 81642e9a92fSRobert Love struct Scsi_Host *host; 81796316099SVasu Dev struct list_head ema_list; 8183a3b42bfSRobert Love struct fc_rport_priv *dns_rdata; 8193a3b42bfSRobert Love struct fc_rport_priv *ptp_rdata; 82042e9a92fSRobert Love void *scsi_priv; 82142e9a92fSRobert Love struct fc_disc disc; 82242e9a92fSRobert Love 8233a3b42bfSRobert Love /* Virtual port information */ 8243a3b42bfSRobert Love struct list_head vports; 8253a3b42bfSRobert Love struct fc_vport *vport; 8263a3b42bfSRobert Love 82742e9a92fSRobert Love /* Operational Information */ 82842e9a92fSRobert Love struct libfc_function_template tt; 829bc0e17f6SVasu Dev u8 link_up; 830bc0e17f6SVasu Dev u8 qfull; 83142e9a92fSRobert Love enum fc_lport_state state; 83242e9a92fSRobert Love unsigned long boot_time; 83342e9a92fSRobert Love struct fc_host_statistics host_stats; 834582b45bcSRobert Love struct fcoe_dev_stats *dev_stats; 83542e9a92fSRobert Love u8 retry_count; 83642e9a92fSRobert Love 8373a3b42bfSRobert Love /* Fabric information */ 8387b2787ecSRobert Love u32 port_id; 8393a3b42bfSRobert Love u64 wwpn; 8403a3b42bfSRobert Love u64 wwnn; 84142e9a92fSRobert Love unsigned int service_params; 84242e9a92fSRobert Love unsigned int e_d_tov; 84342e9a92fSRobert Love unsigned int r_a_tov; 8443a3b42bfSRobert Love struct fc_els_rnid_gen rnid_gen; 8453a3b42bfSRobert Love 8463a3b42bfSRobert Love /* Capabilities */ 8473a3b42bfSRobert Love u32 sg_supp:1; 8483a3b42bfSRobert Love u32 seq_offload:1; 8493a3b42bfSRobert Love u32 crc_offload:1; 8503a3b42bfSRobert Love u32 lro_enabled:1; 8513a3b42bfSRobert Love u32 does_npiv:1; 8523a3b42bfSRobert Love u32 npiv_enabled:1; 8533726f358SJoe Eykholt u32 point_to_multipoint:1; 8543a3b42bfSRobert Love u32 mfs; 85542e9a92fSRobert Love u8 max_retry_count; 856a3666955SAbhijeet Joglekar u8 max_rport_retry_count; 857f90377abSJoe Eykholt u16 rport_priv_size; 85842e9a92fSRobert Love u16 link_speed; 85942e9a92fSRobert Love u16 link_supported_speeds; 8603a3b42bfSRobert Love u16 lro_xid; 8613a3b42bfSRobert Love unsigned int lso_max; 8623a3b42bfSRobert Love struct fc_ns_fts fcts; 86342e9a92fSRobert Love 86442e9a92fSRobert Love /* Miscellaneous */ 8653a3b42bfSRobert Love struct mutex lp_mutex; 8663a3b42bfSRobert Love struct list_head list; 86742e9a92fSRobert Love struct delayed_work retry_work; 86842e9a92fSRobert Love }; 86942e9a92fSRobert Love 87034f42a07SRobert Love /* 87142e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 87242e9a92fSRobert Love *****************************/ 8733a3b42bfSRobert Love 8743a3b42bfSRobert Love /** 8753a3b42bfSRobert Love * fc_lport_test_ready() - Determine if a local port is in the READY state 8763a3b42bfSRobert Love * @lport: The local port to test 8773a3b42bfSRobert Love */ 8783a3b42bfSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lport) 87942e9a92fSRobert Love { 8803a3b42bfSRobert Love return lport->state == LPORT_ST_READY; 88142e9a92fSRobert Love } 88242e9a92fSRobert Love 8833a3b42bfSRobert Love /** 8843a3b42bfSRobert Love * fc_set_wwnn() - Set the World Wide Node Name of a local port 8853a3b42bfSRobert Love * @lport: The local port whose WWNN is to be set 8863a3b42bfSRobert Love * @wwnn: The new WWNN 8873a3b42bfSRobert Love */ 8883a3b42bfSRobert Love static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) 88942e9a92fSRobert Love { 8903a3b42bfSRobert Love lport->wwnn = wwnn; 89142e9a92fSRobert Love } 89242e9a92fSRobert Love 8933a3b42bfSRobert Love /** 8943a3b42bfSRobert Love * fc_set_wwpn() - Set the World Wide Port Name of a local port 8953a3b42bfSRobert Love * @lport: The local port whose WWPN is to be set 8963a3b42bfSRobert Love * @wwnn: The new WWPN 8973a3b42bfSRobert Love */ 8983a3b42bfSRobert Love static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) 89942e9a92fSRobert Love { 9003a3b42bfSRobert Love lport->wwpn = wwnn; 90142e9a92fSRobert Love } 90242e9a92fSRobert Love 9033a3b42bfSRobert Love /** 9043a3b42bfSRobert Love * fc_lport_state_enter() - Change a local port's state 9053a3b42bfSRobert Love * @lport: The local port whose state is to change 9063a3b42bfSRobert Love * @state: The new state 9073a3b42bfSRobert Love */ 9083a3b42bfSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lport, 90942e9a92fSRobert Love enum fc_lport_state state) 91042e9a92fSRobert Love { 9113a3b42bfSRobert Love if (state != lport->state) 9123a3b42bfSRobert Love lport->retry_count = 0; 9133a3b42bfSRobert Love lport->state = state; 91442e9a92fSRobert Love } 91542e9a92fSRobert Love 9163a3b42bfSRobert Love /** 9173a3b42bfSRobert Love * fc_lport_init_stats() - Allocate per-CPU statistics for a local port 9183a3b42bfSRobert Love * @lport: The local port whose statistics are to be initialized 9193a3b42bfSRobert Love */ 9203a3b42bfSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lport) 921582b45bcSRobert Love { 9223a3b42bfSRobert Love lport->dev_stats = alloc_percpu(struct fcoe_dev_stats); 9233a3b42bfSRobert Love if (!lport->dev_stats) 924582b45bcSRobert Love return -ENOMEM; 925582b45bcSRobert Love return 0; 926582b45bcSRobert Love } 927582b45bcSRobert Love 9283a3b42bfSRobert Love /** 9293a3b42bfSRobert Love * fc_lport_free_stats() - Free memory for a local port's statistics 9303a3b42bfSRobert Love * @lport: The local port whose statistics are to be freed 9313a3b42bfSRobert Love */ 9323a3b42bfSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lport) 933582b45bcSRobert Love { 9343a3b42bfSRobert Love free_percpu(lport->dev_stats); 935a0a25da2SVasu Dev } 936a0a25da2SVasu Dev 937a0a25da2SVasu Dev /** 9383a3b42bfSRobert Love * lport_priv() - Return the private data from a local port 9393a3b42bfSRobert Love * @lport: The local port whose private data is to be retreived 9403a3b42bfSRobert Love */ 9413a3b42bfSRobert Love static inline void *lport_priv(const struct fc_lport *lport) 9423a3b42bfSRobert Love { 9433a3b42bfSRobert Love return (void *)(lport + 1); 9443a3b42bfSRobert Love } 9453a3b42bfSRobert Love 9463a3b42bfSRobert Love /** 9473a3b42bfSRobert Love * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and 9483a3b42bfSRobert Love * LLD private data 9493a3b42bfSRobert Love * @sht: The SCSI host template 9503a3b42bfSRobert Love * @priv_size: Size of private data 951a0a25da2SVasu Dev * 95286221969SChris Leech * Returns: libfc lport 953a0a25da2SVasu Dev */ 95486221969SChris Leech static inline struct fc_lport * 955a0a25da2SVasu Dev libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 956a0a25da2SVasu Dev { 95786221969SChris Leech struct fc_lport *lport; 95886221969SChris Leech struct Scsi_Host *shost; 95986221969SChris Leech 96086221969SChris Leech shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 96186221969SChris Leech if (!shost) 96286221969SChris Leech return NULL; 96386221969SChris Leech lport = shost_priv(shost); 96486221969SChris Leech lport->host = shost; 96586221969SChris Leech INIT_LIST_HEAD(&lport->ema_list); 966174e1ebfSChris Leech INIT_LIST_HEAD(&lport->vports); 96786221969SChris Leech return lport; 968a0a25da2SVasu Dev } 96942e9a92fSRobert Love 97034f42a07SRobert Love /* 9713a3b42bfSRobert Love * FC_FCP HELPER FUNCTIONS 9723a3b42bfSRobert Love *****************************/ 9733a3b42bfSRobert Love static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 9743a3b42bfSRobert Love { 9753a3b42bfSRobert Love if (fsp && fsp->cmd) 9763a3b42bfSRobert Love return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 9773a3b42bfSRobert Love return false; 9783a3b42bfSRobert Love } 9793a3b42bfSRobert Love 9803a3b42bfSRobert Love /* 98142e9a92fSRobert Love * LOCAL PORT LAYER 98242e9a92fSRobert Love *****************************/ 9833a3b42bfSRobert Love int fc_lport_init(struct fc_lport *); 9843a3b42bfSRobert Love int fc_lport_destroy(struct fc_lport *); 9853a3b42bfSRobert Love int fc_fabric_logoff(struct fc_lport *); 9863a3b42bfSRobert Love int fc_fabric_login(struct fc_lport *); 9878faecddbSChris Leech void __fc_linkup(struct fc_lport *); 98842e9a92fSRobert Love void fc_linkup(struct fc_lport *); 9898faecddbSChris Leech void __fc_linkdown(struct fc_lport *); 99042e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 9913a3b42bfSRobert Love void fc_vport_setlink(struct fc_lport *); 9923a3b42bfSRobert Love void fc_vports_linkchange(struct fc_lport *); 99342e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 99442e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 9953a3b42bfSRobert Love int fc_set_mfs(struct fc_lport *, u32 mfs); 9963a3b42bfSRobert Love struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); 9973a3b42bfSRobert Love struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); 9983a3b42bfSRobert Love int fc_lport_bsg_request(struct fc_bsg_job *); 9993726f358SJoe Eykholt void fc_lport_set_local_id(struct fc_lport *, u32 port_id); 1000a51ab396SSteve Ma 1001a51ab396SSteve Ma /* 100242e9a92fSRobert Love * REMOTE PORT LAYER 100342e9a92fSRobert Love *****************************/ 10043a3b42bfSRobert Love int fc_rport_init(struct fc_lport *); 10053a3b42bfSRobert Love void fc_rport_terminate_io(struct fc_rport *); 100642e9a92fSRobert Love 100734f42a07SRobert Love /* 100842e9a92fSRobert Love * DISCOVERY LAYER 100942e9a92fSRobert Love *****************************/ 10103a3b42bfSRobert Love int fc_disc_init(struct fc_lport *); 101142e9a92fSRobert Love 10120685230cSJoe Eykholt static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc) 10130685230cSJoe Eykholt { 10140685230cSJoe Eykholt return container_of(disc, struct fc_lport, disc); 10150685230cSJoe Eykholt } 10160685230cSJoe Eykholt 101734f42a07SRobert Love /* 10183a3b42bfSRobert Love * FCP LAYER 101942e9a92fSRobert Love *****************************/ 102042e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 102142e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 102242e9a92fSRobert Love 102334f42a07SRobert Love /* 10243a3b42bfSRobert Love * SCSI INTERACTION LAYER 10253a3b42bfSRobert Love *****************************/ 10263a3b42bfSRobert Love int fc_queuecommand(struct scsi_cmnd *, 10273a3b42bfSRobert Love void (*done)(struct scsi_cmnd *)); 10283a3b42bfSRobert Love int fc_eh_abort(struct scsi_cmnd *); 10293a3b42bfSRobert Love int fc_eh_device_reset(struct scsi_cmnd *); 10303a3b42bfSRobert Love int fc_eh_host_reset(struct scsi_cmnd *); 10313a3b42bfSRobert Love int fc_slave_alloc(struct scsi_device *); 10323a3b42bfSRobert Love int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason); 10333a3b42bfSRobert Love int fc_change_queue_type(struct scsi_device *, int tag_type); 10343a3b42bfSRobert Love 10353a3b42bfSRobert Love /* 103642e9a92fSRobert Love * ELS/CT interface 103742e9a92fSRobert Love *****************************/ 10383a3b42bfSRobert Love int fc_elsct_init(struct fc_lport *); 10393a3b42bfSRobert Love struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, 10403a3b42bfSRobert Love struct fc_frame *, 104111b56188SChris Leech unsigned int op, 104211b56188SChris Leech void (*resp)(struct fc_seq *, 10433a3b42bfSRobert Love struct fc_frame *, 104411b56188SChris Leech void *arg), 104511b56188SChris Leech void *arg, u32 timer_msec); 104611b56188SChris Leech void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 104711b56188SChris Leech void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 104842e9a92fSRobert Love 104942e9a92fSRobert Love 105034f42a07SRobert Love /* 105142e9a92fSRobert Love * EXCHANGE MANAGER LAYER 105242e9a92fSRobert Love *****************************/ 10533a3b42bfSRobert Love int fc_exch_init(struct fc_lport *); 10543a3b42bfSRobert Love struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, 10553a3b42bfSRobert Love struct fc_exch_mgr *, 105696316099SVasu Dev bool (*match)(struct fc_frame *)); 10573a3b42bfSRobert Love void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); 1058174e1ebfSChris Leech int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 10593a3b42bfSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, 10603a3b42bfSRobert Love u16 min_xid, u16 max_xid, 106152ff878cSVasu Dev bool (*match)(struct fc_frame *)); 10623a3b42bfSRobert Love void fc_exch_mgr_free(struct fc_lport *); 10633a3b42bfSRobert Love void fc_exch_recv(struct fc_lport *, struct fc_frame *); 10641f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 106542e9a92fSRobert Love 106642e9a92fSRobert Love /* 106742e9a92fSRobert Love * Functions for fc_functions_template 106842e9a92fSRobert Love */ 10693a3b42bfSRobert Love void fc_get_host_speed(struct Scsi_Host *); 10703a3b42bfSRobert Love void fc_get_host_port_state(struct Scsi_Host *); 10713a3b42bfSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout); 107242e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 107342e9a92fSRobert Love 107442e9a92fSRobert Love #endif /* _LIBFC_H_ */ 1075