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 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 5142e9a92fSRobert Love 5242e9a92fSRobert Love #define hton24(p, v) do { \ 5342e9a92fSRobert Love p[0] = (((v) >> 16) & 0xFF); \ 5442e9a92fSRobert Love p[1] = (((v) >> 8) & 0xFF); \ 5542e9a92fSRobert Love p[2] = ((v) & 0xFF); \ 5642e9a92fSRobert Love } while (0) 5742e9a92fSRobert Love 583a3b42bfSRobert Love /** 593a3b42bfSRobert Love * enum fc_lport_state - Local port states 603a3b42bfSRobert Love * @LPORT_ST_DISABLED: Disabled 613a3b42bfSRobert Love * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent 623a3b42bfSRobert Love * @LPORT_ST_DNS: Waiting for name server remote port to become ready 633a3b42bfSRobert Love * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent 643a3b42bfSRobert Love * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent 65ab593b18SJoe Eykholt * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent 663a3b42bfSRobert Love * @LPORT_ST_SCR: State Change Register (SCR) sent 673a3b42bfSRobert Love * @LPORT_ST_READY: Ready for use 683a3b42bfSRobert Love * @LPORT_ST_LOGO: Local port logout (LOGO) sent 693a3b42bfSRobert Love * @LPORT_ST_RESET: Local port reset 7042e9a92fSRobert Love */ 7142e9a92fSRobert Love enum fc_lport_state { 72b1d9fd55SJoe Eykholt LPORT_ST_DISABLED = 0, 7342e9a92fSRobert Love LPORT_ST_FLOGI, 7442e9a92fSRobert Love LPORT_ST_DNS, 75c9c7bd7aSChris Leech LPORT_ST_RNN_ID, 765baa17c3SChris Leech LPORT_ST_RSNN_NN, 77c9866a54SChris Leech LPORT_ST_RSPN_ID, 7842e9a92fSRobert Love LPORT_ST_RFT_ID, 79ab593b18SJoe Eykholt LPORT_ST_RFF_ID, 8042e9a92fSRobert Love LPORT_ST_SCR, 8142e9a92fSRobert Love LPORT_ST_READY, 8242e9a92fSRobert Love LPORT_ST_LOGO, 8342e9a92fSRobert Love LPORT_ST_RESET 8442e9a92fSRobert Love }; 8542e9a92fSRobert Love 8642e9a92fSRobert Love enum fc_disc_event { 8742e9a92fSRobert Love DISC_EV_NONE = 0, 8842e9a92fSRobert Love DISC_EV_SUCCESS, 8942e9a92fSRobert Love DISC_EV_FAILED 9042e9a92fSRobert Love }; 9142e9a92fSRobert Love 923a3b42bfSRobert Love /** 933a3b42bfSRobert Love * enum fc_rport_state - Remote port states 943a3b42bfSRobert Love * @RPORT_ST_INIT: Initialized 953a3b42bfSRobert Love * @RPORT_ST_PLOGI: Waiting for PLOGI completion 963a3b42bfSRobert Love * @RPORT_ST_PRLI: Waiting for PRLI completion 973a3b42bfSRobert Love * @RPORT_ST_RTV: Waiting for RTV completion 983a3b42bfSRobert Love * @RPORT_ST_READY: Ready for use 993a3b42bfSRobert Love * @RPORT_ST_LOGO: Remote port logout (LOGO) sent 1003a3b42bfSRobert Love * @RPORT_ST_ADISC: Discover Address sent 1013a3b42bfSRobert Love * @RPORT_ST_DELETE: Remote port being deleted 1023a3b42bfSRobert Love * @RPORT_ST_RESTART: Remote port being deleted and will restart 1033a3b42bfSRobert Love */ 10442e9a92fSRobert Love enum fc_rport_state { 1053a3b42bfSRobert Love RPORT_ST_INIT, 1063a3b42bfSRobert Love RPORT_ST_PLOGI, 1073a3b42bfSRobert Love RPORT_ST_PRLI, 1083a3b42bfSRobert Love RPORT_ST_RTV, 1093a3b42bfSRobert Love RPORT_ST_READY, 1103a3b42bfSRobert Love RPORT_ST_LOGO, 1113a3b42bfSRobert Love RPORT_ST_ADISC, 1123a3b42bfSRobert Love RPORT_ST_DELETE, 1133a3b42bfSRobert Love RPORT_ST_RESTART, 11442e9a92fSRobert Love }; 11542e9a92fSRobert Love 11642e9a92fSRobert Love /** 11742e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 11842e9a92fSRobert Love * @lp: Fibre Channel host port instance 1199737e6a7SRobert Love * @peers: Node for list management during discovery and RSCN processing 1209737e6a7SRobert Love * @rport_work: Work struct for starting the rport state machine 1219737e6a7SRobert Love * @port_id: Port ID of the discovered port 12242e9a92fSRobert Love */ 12342e9a92fSRobert Love struct fc_disc_port { 12442e9a92fSRobert Love struct fc_lport *lp; 12542e9a92fSRobert Love struct list_head peers; 12642e9a92fSRobert Love struct work_struct rport_work; 1279737e6a7SRobert Love u32 port_id; 12842e9a92fSRobert Love }; 12942e9a92fSRobert Love 1303a3b42bfSRobert Love /** 1313a3b42bfSRobert Love * enum fc_rport_event - Remote port events 1323a3b42bfSRobert Love * @RPORT_EV_NONE: No event 1333a3b42bfSRobert Love * @RPORT_EV_READY: Remote port is ready for use 1343a3b42bfSRobert Love * @RPORT_EV_FAILED: State machine failed, remote port is not ready 1353a3b42bfSRobert Love * @RPORT_EV_STOP: Remote port has been stopped 1363a3b42bfSRobert Love * @RPORT_EV_LOGO: Remote port logout (LOGO) sent 1373a3b42bfSRobert Love */ 13842e9a92fSRobert Love enum fc_rport_event { 13942e9a92fSRobert Love RPORT_EV_NONE = 0, 1404c0f62b5SJoe Eykholt RPORT_EV_READY, 14142e9a92fSRobert Love RPORT_EV_FAILED, 14242e9a92fSRobert Love RPORT_EV_STOP, 14342e9a92fSRobert Love RPORT_EV_LOGO 14442e9a92fSRobert Love }; 14542e9a92fSRobert Love 1469fb9d328SJoe Eykholt struct fc_rport_priv; 1479fb9d328SJoe Eykholt 1483a3b42bfSRobert Love /** 1493a3b42bfSRobert Love * struct fc_rport_operations - Operations for a remote port 1503a3b42bfSRobert Love * @event_callback: Function to be called for remote port events 1513a3b42bfSRobert Love */ 15242e9a92fSRobert Love struct fc_rport_operations { 1539fb9d328SJoe Eykholt void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, 15442e9a92fSRobert Love enum fc_rport_event); 15542e9a92fSRobert Love }; 15642e9a92fSRobert Love 15742e9a92fSRobert Love /** 15842e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 1593a3b42bfSRobert Love * @local_port: The associated local port 1603a3b42bfSRobert Love * @rp_state: Indicates READY for I/O or DELETE when blocked 1619e9d0452SJoe Eykholt * @flags: REC and RETRY supported flags 1623a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1633a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1649e9d0452SJoe Eykholt */ 1659e9d0452SJoe Eykholt struct fc_rport_libfc_priv { 1669e9d0452SJoe Eykholt struct fc_lport *local_port; 1679e9d0452SJoe Eykholt enum fc_rport_state rp_state; 1689e9d0452SJoe Eykholt u16 flags; 1699e9d0452SJoe Eykholt #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 1709e9d0452SJoe Eykholt #define FC_RP_FLAGS_RETRY (1 << 1) 1719e9d0452SJoe Eykholt unsigned int e_d_tov; 1729e9d0452SJoe Eykholt unsigned int r_a_tov; 1739e9d0452SJoe Eykholt }; 1749e9d0452SJoe Eykholt 1759e9d0452SJoe Eykholt /** 1763a3b42bfSRobert Love * struct fc_rport_priv - libfc remote port and discovery info 1773a3b42bfSRobert Love * @local_port: The associated local port 1783a3b42bfSRobert Love * @rport: The FC transport remote port 1793a3b42bfSRobert Love * @kref: Reference counter 1803a3b42bfSRobert Love * @rp_state: Enumeration that tracks progress of PLOGI, PRLI, 1813a3b42bfSRobert Love * and RTV exchanges 1823a3b42bfSRobert Love * @ids: The remote port identifiers and roles 18342e9a92fSRobert Love * @flags: REC and RETRY supported flags 1843a3b42bfSRobert Love * @max_seq: Maximum number of concurrent sequences 1853a3b42bfSRobert Love * @disc_id: The discovery identifier 1863a3b42bfSRobert Love * @maxframe_size: The maximum frame size 1873a3b42bfSRobert Love * @retries: The retry count for the current state 1883a3b42bfSRobert Love * @e_d_tov: Error detect timeout value (in msec) 1893a3b42bfSRobert Love * @r_a_tov: Resource allocation timeout value (in msec) 1903a3b42bfSRobert Love * @rp_mutex: The mutex that protects the remote port 1913a3b42bfSRobert Love * @retry_work: Handle for retries 1923a3b42bfSRobert Love * @event_callback: Callback when READY, FAILED or LOGO states complete 19342e9a92fSRobert Love */ 1949e9d0452SJoe Eykholt struct fc_rport_priv { 19542e9a92fSRobert Love struct fc_lport *local_port; 196f211fa51SJoe Eykholt struct fc_rport *rport; 197f211fa51SJoe Eykholt struct kref kref; 19842e9a92fSRobert Love enum fc_rport_state rp_state; 199f211fa51SJoe Eykholt struct fc_rport_identifiers ids; 20042e9a92fSRobert Love u16 flags; 20142e9a92fSRobert Love u16 max_seq; 2020f6c6149SJoe Eykholt u16 disc_id; 203f211fa51SJoe Eykholt u16 maxframe_size; 20442e9a92fSRobert Love unsigned int retries; 20542e9a92fSRobert Love unsigned int e_d_tov; 20642e9a92fSRobert Love unsigned int r_a_tov; 20742e9a92fSRobert Love struct mutex rp_mutex; 20842e9a92fSRobert Love struct delayed_work retry_work; 20942e9a92fSRobert Love enum fc_rport_event event; 21042e9a92fSRobert Love struct fc_rport_operations *ops; 21142e9a92fSRobert Love struct list_head peers; 21242e9a92fSRobert Love struct work_struct event_work; 213f211fa51SJoe Eykholt u32 supported_classes; 21442e9a92fSRobert Love }; 21542e9a92fSRobert Love 2163a3b42bfSRobert Love /** 2173a3b42bfSRobert Love * struct fcoe_dev_stats - fcoe stats structure 2183a3b42bfSRobert Love * @SecondsSinceLastReset: Seconds since the last reset 2193a3b42bfSRobert Love * @TxFrames: Number of transmitted frames 2203a3b42bfSRobert Love * @TxWords: Number of transmitted words 2213a3b42bfSRobert Love * @RxFrames: Number of received frames 2223a3b42bfSRobert Love * @RxWords: Number of received words 2233a3b42bfSRobert Love * @ErrorFrames: Number of received error frames 2243a3b42bfSRobert Love * @DumpedFrames: Number of dumped frames 2253a3b42bfSRobert Love * @LinkFailureCount: Number of link failures 2263a3b42bfSRobert Love * @LossOfSignalCount: Number for signal losses 2273a3b42bfSRobert Love * @InvalidTxWordCount: Number of invalid transmitted words 2283a3b42bfSRobert Love * @InvalidCRCCount: Number of invalid CRCs 2293a3b42bfSRobert Love * @InputRequests: Number of input requests 2303a3b42bfSRobert Love * @OutputRequests: Number of output requests 2313a3b42bfSRobert Love * @ControlRequests: Number of control requests 2323a3b42bfSRobert Love * @InputMegabytes: Number of received megabytes 2333a3b42bfSRobert Love * @OutputMegabytes: Number of transmitted megabytes 2346580bbd0SYi Zou * @VLinkFailureCount: Number of virtual link failures 2356580bbd0SYi Zou * @MissDiscAdvCount: Number of missing FIP discovery advertisement 23642e9a92fSRobert Love */ 23742e9a92fSRobert Love struct fcoe_dev_stats { 23842e9a92fSRobert Love u64 SecondsSinceLastReset; 23942e9a92fSRobert Love u64 TxFrames; 24042e9a92fSRobert Love u64 TxWords; 24142e9a92fSRobert Love u64 RxFrames; 24242e9a92fSRobert Love u64 RxWords; 24342e9a92fSRobert Love u64 ErrorFrames; 24442e9a92fSRobert Love u64 DumpedFrames; 24542e9a92fSRobert Love u64 LinkFailureCount; 24642e9a92fSRobert Love u64 LossOfSignalCount; 24742e9a92fSRobert Love u64 InvalidTxWordCount; 24842e9a92fSRobert Love u64 InvalidCRCCount; 24942e9a92fSRobert Love u64 InputRequests; 25042e9a92fSRobert Love u64 OutputRequests; 25142e9a92fSRobert Love u64 ControlRequests; 25242e9a92fSRobert Love u64 InputMegabytes; 25342e9a92fSRobert Love u64 OutputMegabytes; 2546580bbd0SYi Zou u64 VLinkFailureCount; 2556580bbd0SYi Zou u64 MissDiscAdvCount; 25642e9a92fSRobert Love }; 25742e9a92fSRobert Love 2583a3b42bfSRobert Love /** 2593a3b42bfSRobert Love * struct fc_seq_els_data - ELS data used for passing ELS specific responses 2603a3b42bfSRobert Love * @fp: The ELS frame 2613a3b42bfSRobert Love * @reason: The reason for rejection 2623a3b42bfSRobert Love * @explan: The explaination of the rejection 2633a3b42bfSRobert Love * 2643a3b42bfSRobert Love * Mainly used by the exchange manager layer. 26542e9a92fSRobert Love */ 26642e9a92fSRobert Love struct fc_seq_els_data { 26742e9a92fSRobert Love struct fc_frame *fp; 26842e9a92fSRobert Love enum fc_els_rjt_reason reason; 26942e9a92fSRobert Love enum fc_els_rjt_explan explan; 27042e9a92fSRobert Love }; 27142e9a92fSRobert Love 2723a3b42bfSRobert Love /** 2733a3b42bfSRobert Love * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request) 2743a3b42bfSRobert Love * @lp: The associated local port 2753a3b42bfSRobert Love * @state: The state of the I/O 2763a3b42bfSRobert Love * @tgt_flags: Target's flags 2773a3b42bfSRobert Love * @ref_cnt: Reference count 2783a3b42bfSRobert Love * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the 2793a3b42bfSRobert Love * host_lock if both are to be held at the same time) 2803a3b42bfSRobert Love * @cmd: The SCSI command (set and clear with the host_lock held) 2813a3b42bfSRobert Love * @list: Tracks queued commands (accessed with the host_lock held) 2823a3b42bfSRobert Love * @timer: The command timer 2833a3b42bfSRobert Love * @tm_done: Completion indicator 2843a3b42bfSRobert Love * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies) 2853a3b42bfSRobert Love * @start_time: Timestamp indicating the start of the I/O (in jiffies) 2863a3b42bfSRobert Love * @end_time: Timestamp indicating the end of the I/O (in jiffies) 2873a3b42bfSRobert Love * @last_pkt_time: Timestamp of the last frame received (in jiffies) 2883a3b42bfSRobert Love * @data_len: The length of the data 2893a3b42bfSRobert Love * @cdb_cmd: The CDB command 2903a3b42bfSRobert Love * @xfer_len: The transfer length 2913a3b42bfSRobert Love * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange 2923a3b42bfSRobert Love * will be set here if DDP was setup) 2933a3b42bfSRobert Love * @xfer_contig_end: The offset into the buffer if the buffer is contiguous 2943a3b42bfSRobert Love * (Tx and Rx) 2953a3b42bfSRobert Love * @max_payload: The maximum payload size (in bytes) 2963a3b42bfSRobert Love * @io_status: SCSI result (upper 24 bits) 2973a3b42bfSRobert Love * @cdb_status: CDB status 2983a3b42bfSRobert Love * @status_code: FCP I/O status 2993a3b42bfSRobert Love * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun) 3003a3b42bfSRobert Love * @req_flags: Request flags (bit 0: read bit:1 write) 3013a3b42bfSRobert Love * @scsi_resid: SCSI residule length 3023a3b42bfSRobert Love * @rport: The remote port that the SCSI command is targeted at 3033a3b42bfSRobert Love * @seq_ptr: The sequence that will carry the SCSI command 3043a3b42bfSRobert Love * @recov_retry: Number of recovery retries 3053a3b42bfSRobert Love * @recov_seq: The sequence for REC or SRR 30642e9a92fSRobert Love */ 30742e9a92fSRobert Love struct fc_fcp_pkt { 3083a3b42bfSRobert Love /* Housekeeping information */ 3093a3b42bfSRobert Love struct fc_lport *lp; 3103a3b42bfSRobert Love u16 state; 3113a3b42bfSRobert Love u16 tgt_flags; 3123a3b42bfSRobert Love atomic_t ref_cnt; 3133a3b42bfSRobert Love spinlock_t scsi_pkt_lock; 3143a3b42bfSRobert Love 3153a3b42bfSRobert Love /* SCSI I/O related information */ 3163a3b42bfSRobert Love struct scsi_cmnd *cmd; 3173a3b42bfSRobert Love struct list_head list; 3183a3b42bfSRobert Love 3193a3b42bfSRobert Love /* Timeout related information */ 3203a3b42bfSRobert Love struct timer_list timer; 32142e9a92fSRobert Love struct completion tm_done; 32242e9a92fSRobert Love int wait_for_comp; 3233a3b42bfSRobert Love unsigned long start_time; 3243a3b42bfSRobert Love unsigned long end_time; 3253a3b42bfSRobert Love unsigned long last_pkt_time; 32642e9a92fSRobert Love 3273a3b42bfSRobert Love /* SCSI command and data transfer information */ 32842e9a92fSRobert Love u32 data_len; 3293a3b42bfSRobert Love 3303a3b42bfSRobert Love /* Transport related veriables */ 33142e9a92fSRobert Love struct fcp_cmnd cdb_cmd; 33242e9a92fSRobert Love size_t xfer_len; 3333a3b42bfSRobert Love u16 xfer_ddp; 3343a3b42bfSRobert Love u32 xfer_contig_end; 3353a3b42bfSRobert Love u16 max_payload; 33642e9a92fSRobert Love 3373a3b42bfSRobert Love /* SCSI/FCP return status */ 3383a3b42bfSRobert Love u32 io_status; 33942e9a92fSRobert Love u8 cdb_status; 3403a3b42bfSRobert Love u8 status_code; 34142e9a92fSRobert Love u8 scsi_comp_flags; 3423a3b42bfSRobert Love u32 req_flags; 3433a3b42bfSRobert Love u32 scsi_resid; 34442e9a92fSRobert Love 3453a3b42bfSRobert Love /* Associated structures */ 3463a3b42bfSRobert Love struct fc_rport *rport; 3473a3b42bfSRobert Love struct fc_seq *seq_ptr; 3483a3b42bfSRobert Love 3493a3b42bfSRobert Love /* Error Processing information */ 3503a3b42bfSRobert Love u8 recov_retry; 3513a3b42bfSRobert Love struct fc_seq *recov_seq; 35242e9a92fSRobert Love }; 35342e9a92fSRobert Love 35442e9a92fSRobert Love /* 35542e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 35642e9a92fSRobert Love * and Sequences 35742e9a92fSRobert Love * 35842e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 35942e9a92fSRobert Love * 36042e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 36142e9a92fSRobert Love */ 36242e9a92fSRobert Love 36342e9a92fSRobert Love struct fc_exch_mgr; 36496316099SVasu Dev struct fc_exch_mgr_anchor; 365e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 36642e9a92fSRobert Love 3673a3b42bfSRobert Love /** 3683a3b42bfSRobert Love * struct fc_seq - FC sequence 3693a3b42bfSRobert Love * @id: The sequence ID 3703a3b42bfSRobert Love * @ssb_stat: Status flags for the sequence status block (SSB) 3713a3b42bfSRobert Love * @cnt: Number of frames sent so far 3723a3b42bfSRobert Love * @rec_data: FC-4 value for REC 37342e9a92fSRobert Love */ 37442e9a92fSRobert Love struct fc_seq { 3753a3b42bfSRobert Love u8 id; 3763a3b42bfSRobert Love u16 ssb_stat; 3773a3b42bfSRobert Love u16 cnt; 3783a3b42bfSRobert Love u32 rec_data; 37942e9a92fSRobert Love }; 38042e9a92fSRobert Love 38142e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 38242e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 38342e9a92fSRobert Love 3843a3b42bfSRobert Love /** 3853a3b42bfSRobert Love * struct fc_exch - Fibre Channel Exchange 3863a3b42bfSRobert Love * @em: Exchange manager 3873a3b42bfSRobert Love * @pool: Exchange pool 3883a3b42bfSRobert Love * @state: The exchange's state 3893a3b42bfSRobert Love * @xid: The exchange ID 3903a3b42bfSRobert Love * @ex_list: Handle used by the EM to track free exchanges 3913a3b42bfSRobert Love * @ex_lock: Lock that protects the exchange 3923a3b42bfSRobert Love * @ex_refcnt: Reference count 3933a3b42bfSRobert Love * @timeout_work: Handle for timeout handler 3943a3b42bfSRobert Love * @lp: The local port that this exchange is on 3953a3b42bfSRobert Love * @oxid: Originator's exchange ID 3963a3b42bfSRobert Love * @rxid: Responder's exchange ID 3973a3b42bfSRobert Love * @oid: Originator's FCID 3983a3b42bfSRobert Love * @sid: Source FCID 3993a3b42bfSRobert Love * @did: Destination FCID 4003a3b42bfSRobert Love * @esb_stat: ESB exchange status 4013a3b42bfSRobert Love * @r_a_tov: Resouce allocation time out value (in msecs) 4023a3b42bfSRobert Love * @seq_id: The next sequence ID to use 4033a3b42bfSRobert Love * @f_ctl: F_CTL flags for the sequence 4043a3b42bfSRobert Love * @fh_type: The frame type 4053a3b42bfSRobert Love * @class: The class of service 4063a3b42bfSRobert Love * @seq: The sequence in use on this exchange 4073a3b42bfSRobert Love * @resp: Callback for responses on this exchange 4083a3b42bfSRobert Love * @destructor: Called when destroying the exchange 4093a3b42bfSRobert Love * @arg: Passed as a void pointer to the resp() callback 41042e9a92fSRobert Love * 41142e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 41242e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 41342e9a92fSRobert Love * seq_id 41442e9a92fSRobert Love * sequence allocation 41542e9a92fSRobert Love */ 41642e9a92fSRobert Love struct fc_exch { 4173a3b42bfSRobert Love struct fc_exch_mgr *em; 4183a3b42bfSRobert Love struct fc_exch_pool *pool; 4193a3b42bfSRobert Love u32 state; 4203a3b42bfSRobert Love u16 xid; 4213a3b42bfSRobert Love struct list_head ex_list; 4223a3b42bfSRobert Love spinlock_t ex_lock; 4233a3b42bfSRobert Love atomic_t ex_refcnt; 4243a3b42bfSRobert Love struct delayed_work timeout_work; 4253a3b42bfSRobert Love struct fc_lport *lp; 4263a3b42bfSRobert Love u16 oxid; 4273a3b42bfSRobert Love u16 rxid; 4283a3b42bfSRobert Love u32 oid; 4293a3b42bfSRobert Love u32 sid; 4303a3b42bfSRobert Love u32 did; 4313a3b42bfSRobert Love u32 esb_stat; 4323a3b42bfSRobert Love u32 r_a_tov; 4333a3b42bfSRobert Love u8 seq_id; 4343a3b42bfSRobert Love u32 f_ctl; 4353a3b42bfSRobert Love u8 fh_type; 4363a3b42bfSRobert Love enum fc_class class; 4373a3b42bfSRobert Love struct fc_seq seq; 4383a3b42bfSRobert Love 43942e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 44042e9a92fSRobert Love void *arg; 4413a3b42bfSRobert Love 4423a3b42bfSRobert Love void (*destructor)(struct fc_seq *, void *); 4433a3b42bfSRobert Love 44442e9a92fSRobert Love }; 44542e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 44642e9a92fSRobert Love 44742e9a92fSRobert Love 4483a3b42bfSRobert Love struct libfc_function_template { 44942e9a92fSRobert Love /* 45042e9a92fSRobert Love * Interface to send a FC frame 4510ae4d4aeSRobert Love * 4520ae4d4aeSRobert Love * STATUS: REQUIRED 45342e9a92fSRobert Love */ 4543a3b42bfSRobert Love int (*frame_send)(struct fc_lport *, struct fc_frame *); 45542e9a92fSRobert Love 45642e9a92fSRobert Love /* 4570ae4d4aeSRobert Love * Interface to send ELS/CT frames 4580ae4d4aeSRobert Love * 4590ae4d4aeSRobert Love * STATUS: OPTIONAL 46042e9a92fSRobert Love */ 4613a3b42bfSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, 4623a3b42bfSRobert Love struct fc_frame *, unsigned int op, 46342e9a92fSRobert Love void (*resp)(struct fc_seq *, 4643a3b42bfSRobert Love struct fc_frame *, void *arg), 46542e9a92fSRobert Love void *arg, u32 timer_msec); 46642e9a92fSRobert Love 46742e9a92fSRobert Love /* 46842e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 46942e9a92fSRobert Love * 47042e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 47142e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 47242e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 47342e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 47442e9a92fSRobert Love * as error using IS_ERR related macros. 47542e9a92fSRobert Love * 47642e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 47742e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 47842e9a92fSRobert Love * is about to free, this can be used by caller to free its 47942e9a92fSRobert Love * resources along with exchange free. 48042e9a92fSRobert Love * 48142e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 48242e9a92fSRobert Love * 48342e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 48442e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 48542e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 48642e9a92fSRobert Love * is registered by EM layer. 4870ae4d4aeSRobert Love * 4880ae4d4aeSRobert Love * STATUS: OPTIONAL 48942e9a92fSRobert Love */ 4903a3b42bfSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *, 4913a3b42bfSRobert Love void (*resp)(struct fc_seq *, 4923a3b42bfSRobert Love struct fc_frame *, 4933a3b42bfSRobert Love void *), 4943a3b42bfSRobert Love void (*destructor)(struct fc_seq *, 4953a3b42bfSRobert Love void *), 4963a3b42bfSRobert Love void *, unsigned int timer_msec); 49742e9a92fSRobert Love 49842e9a92fSRobert Love /* 499b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given 500b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive. 501b277d2aaSYi Zou * 502b277d2aaSYi Zou * STATUS: OPTIONAL 503b277d2aaSYi Zou */ 5043a3b42bfSRobert Love int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, 5053a3b42bfSRobert Love unsigned int); 506b277d2aaSYi Zou /* 507b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed 508b277d2aaSYi Zou * for the given exchange id. 509b277d2aaSYi Zou * 510b277d2aaSYi Zou * STATUS: OPTIONAL 511b277d2aaSYi Zou */ 5123a3b42bfSRobert Love int (*ddp_done)(struct fc_lport *, u16); 513b277d2aaSYi Zou /* 514b84056bfSYi Zou * Allow LLD to fill its own Link Error Status Block 515b84056bfSYi Zou * 516b84056bfSYi Zou * STATUS: OPTIONAL 517b84056bfSYi Zou */ 518b84056bfSYi Zou void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb); 519b84056bfSYi Zou /* 5200ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 5210ae4d4aeSRobert Love * 5220ae4d4aeSRobert Love * STATUS: OPTIONAL 52342e9a92fSRobert Love */ 5243a3b42bfSRobert Love int (*seq_send)(struct fc_lport *, struct fc_seq *, 5253a3b42bfSRobert Love struct fc_frame *); 52642e9a92fSRobert Love 52742e9a92fSRobert Love /* 5280ae4d4aeSRobert Love * Send an ELS response using infomation from a previous 5290ae4d4aeSRobert Love * exchange and sequence. 5300ae4d4aeSRobert Love * 5310ae4d4aeSRobert Love * STATUS: OPTIONAL 53242e9a92fSRobert Love */ 5333a3b42bfSRobert Love void (*seq_els_rsp_send)(struct fc_seq *, enum fc_els_cmd, 5343a3b42bfSRobert Love struct fc_seq_els_data *); 53542e9a92fSRobert Love 53642e9a92fSRobert Love /* 53742e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 53842e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 53942e9a92fSRobert Love * 54042e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 54142e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 54242e9a92fSRobert Love * will be called with timeout error if no response to abort. 5430ae4d4aeSRobert Love * 5440ae4d4aeSRobert Love * STATUS: OPTIONAL 54542e9a92fSRobert Love */ 5463a3b42bfSRobert Love int (*seq_exch_abort)(const struct fc_seq *, 54742e9a92fSRobert Love unsigned int timer_msec); 54842e9a92fSRobert Love 54942e9a92fSRobert Love /* 55042e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 55142e9a92fSRobert Love * allocated for the related objects may be freed. 5520ae4d4aeSRobert Love * 5530ae4d4aeSRobert Love * STATUS: OPTIONAL 55442e9a92fSRobert Love */ 5553a3b42bfSRobert Love void (*exch_done)(struct fc_seq *); 55642e9a92fSRobert Love 55742e9a92fSRobert Love /* 55842e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 5590ae4d4aeSRobert Love * 5600ae4d4aeSRobert Love * STATUS: OPTIONAL 56142e9a92fSRobert Love */ 5623a3b42bfSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *); 56342e9a92fSRobert Love 56442e9a92fSRobert Love /* 56542e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 56642e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 56742e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 5680ae4d4aeSRobert Love * 5690ae4d4aeSRobert Love * STATUS: OPTIONAL 57042e9a92fSRobert Love */ 5713a3b42bfSRobert Love void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); 57242e9a92fSRobert Love 5730ae4d4aeSRobert Love /* 5740ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 5750ae4d4aeSRobert Love * 5760ae4d4aeSRobert Love * STATUS: OPTIONAL 57742e9a92fSRobert Love */ 5780ae4d4aeSRobert Love void (*rport_flush_queue)(void); 57942e9a92fSRobert Love 58042e9a92fSRobert Love /* 5810ae4d4aeSRobert Love * Receive a frame for a local port. 5820ae4d4aeSRobert Love * 5830ae4d4aeSRobert Love * STATUS: OPTIONAL 58442e9a92fSRobert Love */ 5853a3b42bfSRobert Love void (*lport_recv)(struct fc_lport *, struct fc_seq *, 5863a3b42bfSRobert Love struct fc_frame *); 58742e9a92fSRobert Love 5880ae4d4aeSRobert Love /* 5890ae4d4aeSRobert Love * Reset the local port. 5900ae4d4aeSRobert Love * 5910ae4d4aeSRobert Love * STATUS: OPTIONAL 59242e9a92fSRobert Love */ 5930ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 59442e9a92fSRobert Love 59542e9a92fSRobert Love /* 596093bb6a2SJoe Eykholt * Set the local port FC_ID. 597093bb6a2SJoe Eykholt * 598093bb6a2SJoe Eykholt * This may be provided by the LLD to allow it to be 599093bb6a2SJoe Eykholt * notified when the local port is assigned a FC-ID. 600093bb6a2SJoe Eykholt * 601093bb6a2SJoe Eykholt * The frame, if non-NULL, is the incoming frame with the 602093bb6a2SJoe Eykholt * FLOGI LS_ACC or FLOGI, and may contain the granted MAC 603093bb6a2SJoe Eykholt * address for the LLD. The frame pointer may be NULL if 604093bb6a2SJoe Eykholt * no MAC is associated with this assignment (LOGO or PLOGI). 605093bb6a2SJoe Eykholt * 606093bb6a2SJoe Eykholt * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid. 607093bb6a2SJoe Eykholt * 608093bb6a2SJoe Eykholt * Note: this is called with the local port mutex held. 609093bb6a2SJoe Eykholt * 610093bb6a2SJoe Eykholt * STATUS: OPTIONAL 611093bb6a2SJoe Eykholt */ 612093bb6a2SJoe Eykholt void (*lport_set_port_id)(struct fc_lport *, u32 port_id, 613093bb6a2SJoe Eykholt struct fc_frame *); 614093bb6a2SJoe Eykholt 615093bb6a2SJoe Eykholt /* 6169737e6a7SRobert Love * Create a remote port with a given port ID 6179737e6a7SRobert Love * 6189737e6a7SRobert Love * STATUS: OPTIONAL 6195101ff99SRobert Love */ 6209737e6a7SRobert Love struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 6215101ff99SRobert Love 6225101ff99SRobert Love /* 62342e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 62442e9a92fSRobert Love * This function will issue the following commands to the N_Port 62542e9a92fSRobert Love * identified by the FC ID provided. 62642e9a92fSRobert Love * 62742e9a92fSRobert Love * - PLOGI 62842e9a92fSRobert Love * - PRLI 62942e9a92fSRobert Love * - RTV 6300ae4d4aeSRobert Love * 6310ae4d4aeSRobert Love * STATUS: OPTIONAL 63242e9a92fSRobert Love */ 6339fb9d328SJoe Eykholt int (*rport_login)(struct fc_rport_priv *); 63442e9a92fSRobert Love 63542e9a92fSRobert Love /* 63642e9a92fSRobert Love * Logoff, and remove the rport from the transport if 63742e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 6380ae4d4aeSRobert Love * 6390ae4d4aeSRobert Love * STATUS: OPTIONAL 64042e9a92fSRobert Love */ 6419fb9d328SJoe Eykholt int (*rport_logoff)(struct fc_rport_priv *); 64242e9a92fSRobert Love 64342e9a92fSRobert Love /* 64442e9a92fSRobert Love * Recieve a request from a remote port. 6450ae4d4aeSRobert Love * 6460ae4d4aeSRobert Love * STATUS: OPTIONAL 64742e9a92fSRobert Love */ 64842e9a92fSRobert Love void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 649131203a1SJoe Eykholt struct fc_lport *); 65042e9a92fSRobert Love 6510ae4d4aeSRobert Love /* 6520ae4d4aeSRobert Love * lookup an rport by it's port ID. 6530ae4d4aeSRobert Love * 6540ae4d4aeSRobert Love * STATUS: OPTIONAL 65542e9a92fSRobert Love */ 6569fb9d328SJoe Eykholt struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 65742e9a92fSRobert Love 65842e9a92fSRobert Love /* 659f211fa51SJoe Eykholt * Destroy an rport after final kref_put(). 660f211fa51SJoe Eykholt * The argument is a pointer to the kref inside the fc_rport_priv. 661f211fa51SJoe Eykholt */ 662f211fa51SJoe Eykholt void (*rport_destroy)(struct kref *); 663f211fa51SJoe Eykholt 664f211fa51SJoe Eykholt /* 66542e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 66642e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 66742e9a92fSRobert Love * 66842e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 66942e9a92fSRobert Love * 6700ae4d4aeSRobert Love * STATUS: OPTIONAL 67142e9a92fSRobert Love */ 6723a3b42bfSRobert Love int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, 6733a3b42bfSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, 6743a3b42bfSRobert Love void *)); 67542e9a92fSRobert Love 67642e9a92fSRobert Love /* 6770ae4d4aeSRobert Love * Cleanup the FCP layer, used durring link down and reset 6780ae4d4aeSRobert Love * 6790ae4d4aeSRobert Love * STATUS: OPTIONAL 68042e9a92fSRobert Love */ 6813a3b42bfSRobert Love void (*fcp_cleanup)(struct fc_lport *); 68242e9a92fSRobert Love 68342e9a92fSRobert Love /* 68442e9a92fSRobert Love * Abort all I/O on a local port 6850ae4d4aeSRobert Love * 6860ae4d4aeSRobert Love * STATUS: OPTIONAL 68742e9a92fSRobert Love */ 6883a3b42bfSRobert Love void (*fcp_abort_io)(struct fc_lport *); 68942e9a92fSRobert Love 6900ae4d4aeSRobert Love /* 6910ae4d4aeSRobert Love * Receive a request for the discovery layer. 6920ae4d4aeSRobert Love * 6930ae4d4aeSRobert Love * STATUS: OPTIONAL 69442e9a92fSRobert Love */ 6953a3b42bfSRobert Love void (*disc_recv_req)(struct fc_seq *, struct fc_frame *, 6963a3b42bfSRobert Love struct fc_lport *); 69742e9a92fSRobert Love 69842e9a92fSRobert Love /* 69942e9a92fSRobert Love * Start discovery for a local port. 7000ae4d4aeSRobert Love * 7010ae4d4aeSRobert Love * STATUS: OPTIONAL 70242e9a92fSRobert Love */ 70342e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 70442e9a92fSRobert Love enum fc_disc_event), 70542e9a92fSRobert Love struct fc_lport *); 70642e9a92fSRobert Love 70742e9a92fSRobert Love /* 70842e9a92fSRobert Love * Stop discovery for a given lport. This will remove 70942e9a92fSRobert Love * all discovered rports 7100ae4d4aeSRobert Love * 7110ae4d4aeSRobert Love * STATUS: OPTIONAL 71242e9a92fSRobert Love */ 71342e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 71442e9a92fSRobert Love 71542e9a92fSRobert Love /* 71642e9a92fSRobert Love * Stop discovery for a given lport. This will block 71742e9a92fSRobert Love * until all discovered rports are deleted from the 71842e9a92fSRobert Love * FC transport class 7190ae4d4aeSRobert Love * 7200ae4d4aeSRobert Love * STATUS: OPTIONAL 72142e9a92fSRobert Love */ 72242e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 72342e9a92fSRobert Love }; 72442e9a92fSRobert Love 7253a3b42bfSRobert Love /** 7263a3b42bfSRobert Love * struct fc_disc - Discovery context 7273a3b42bfSRobert Love * @retry_count: Number of retries 7283a3b42bfSRobert Love * @pending: 1 if discovery is pending, 0 if not 7293a3b42bfSRobert Love * @requesting: 1 if discovery has been requested, 0 if not 7303a3b42bfSRobert Love * @seq_count: Number of sequences used for discovery 7313a3b42bfSRobert Love * @buf_len: Length of the discovery buffer 7323a3b42bfSRobert Love * @disc_id: Discovery ID 7333a3b42bfSRobert Love * @rports: List of discovered remote ports 7343a3b42bfSRobert Love * @lport: The local port that discovery is for 7353a3b42bfSRobert Love * @disc_mutex: Mutex that protects the discovery context 7363a3b42bfSRobert Love * @partial_buf: Partial name buffer (if names are returned 7373a3b42bfSRobert Love * in multiple frames) 7383a3b42bfSRobert Love * @disc_work: handle for delayed work context 7393a3b42bfSRobert Love * @disc_callback: Callback routine called when discovery completes 7403a3b42bfSRobert Love */ 74142e9a92fSRobert Love struct fc_disc { 74242e9a92fSRobert Love unsigned char retry_count; 74342e9a92fSRobert Love unsigned char pending; 74442e9a92fSRobert Love unsigned char requested; 74542e9a92fSRobert Love unsigned short seq_count; 74642e9a92fSRobert Love unsigned char buf_len; 7470f6c6149SJoe Eykholt u16 disc_id; 74842e9a92fSRobert Love 74942e9a92fSRobert Love struct list_head rports; 75042e9a92fSRobert Love struct fc_lport *lport; 75142e9a92fSRobert Love struct mutex disc_mutex; 7523a3b42bfSRobert Love struct fc_gpn_ft_resp partial_buf; 75342e9a92fSRobert Love struct delayed_work disc_work; 7543a3b42bfSRobert Love 7553a3b42bfSRobert Love void (*disc_callback)(struct fc_lport *, 7563a3b42bfSRobert Love enum fc_disc_event); 75742e9a92fSRobert Love }; 75842e9a92fSRobert Love 7593a3b42bfSRobert Love /** 7603a3b42bfSRobert Love * struct fc_lport - Local port 7613a3b42bfSRobert Love * @host: The SCSI host associated with a local port 7623a3b42bfSRobert Love * @ema_list: Exchange manager anchor list 7633a3b42bfSRobert Love * @dns_rdata: The directory server remote port 7643a3b42bfSRobert Love * @ptp_rdata: Point to point remote port 7653a3b42bfSRobert Love * @scsi_priv: FCP layer internal data 7663a3b42bfSRobert Love * @disc: Discovery context 7673a3b42bfSRobert Love * @vports: Child vports if N_Port 7683a3b42bfSRobert Love * @vport: Parent vport if VN_Port 7693a3b42bfSRobert Love * @tt: Libfc function template 7703a3b42bfSRobert Love * @link_up: Link state (1 = link up, 0 = link down) 7713a3b42bfSRobert Love * @qfull: Queue state (1 queue is full, 0 queue is not full) 7723a3b42bfSRobert Love * @state: Identifies the state 7733a3b42bfSRobert Love * @boot_time: Timestamp indicating when the local port came online 7743a3b42bfSRobert Love * @host_stats: SCSI host statistics 7753a3b42bfSRobert Love * @dev_stats: FCoE device stats (TODO: libfc should not be 7763a3b42bfSRobert Love * FCoE aware) 7773a3b42bfSRobert Love * @retry_count: Number of retries in the current state 7783a3b42bfSRobert Love * @wwpn: World Wide Port Name 7793a3b42bfSRobert Love * @wwnn: World Wide Node Name 7803a3b42bfSRobert Love * @service_params: Common service parameters 7813a3b42bfSRobert Love * @e_d_tov: Error detection timeout value 7823a3b42bfSRobert Love * @r_a_tov: Resouce allocation timeout value 7833a3b42bfSRobert Love * @rnid_gen: RNID information 7843a3b42bfSRobert Love * @sg_supp: Indicates if scatter gather is supported 7853a3b42bfSRobert Love * @seq_offload: Indicates if sequence offload is supported 7863a3b42bfSRobert Love * @crc_offload: Indicates if CRC offload is supported 7873a3b42bfSRobert Love * @lro_enabled: Indicates if large receive offload is supported 7883a3b42bfSRobert Love * @does_npiv: Supports multiple vports 7893a3b42bfSRobert Love * @npiv_enabled: Switch/fabric allows NPIV 7903a3b42bfSRobert Love * @mfs: The maximum Fibre Channel payload size 7913a3b42bfSRobert Love * @max_retry_count: The maximum retry attempts 7923a3b42bfSRobert Love * @max_rport_retry_count: The maximum remote port retry attempts 7933a3b42bfSRobert Love * @lro_xid: The maximum XID for LRO 7943a3b42bfSRobert Love * @lso_max: The maximum large offload send size 7953a3b42bfSRobert Love * @fcts: FC-4 type mask 7963a3b42bfSRobert Love * @lp_mutex: Mutex to protect the local port 7973a3b42bfSRobert Love * @list: Handle for list of local ports 7983a3b42bfSRobert Love * @retry_work: Handle to local port for delayed retry context 7993a3b42bfSRobert Love */ 80042e9a92fSRobert Love struct fc_lport { 80142e9a92fSRobert Love /* Associations */ 80242e9a92fSRobert Love struct Scsi_Host *host; 80396316099SVasu Dev struct list_head ema_list; 8043a3b42bfSRobert Love struct fc_rport_priv *dns_rdata; 8053a3b42bfSRobert Love struct fc_rport_priv *ptp_rdata; 80642e9a92fSRobert Love void *scsi_priv; 80742e9a92fSRobert Love struct fc_disc disc; 80842e9a92fSRobert Love 8093a3b42bfSRobert Love /* Virtual port information */ 8103a3b42bfSRobert Love struct list_head vports; 8113a3b42bfSRobert Love struct fc_vport *vport; 8123a3b42bfSRobert Love 81342e9a92fSRobert Love /* Operational Information */ 81442e9a92fSRobert Love struct libfc_function_template tt; 815bc0e17f6SVasu Dev u8 link_up; 816bc0e17f6SVasu Dev u8 qfull; 81742e9a92fSRobert Love enum fc_lport_state state; 81842e9a92fSRobert Love unsigned long boot_time; 81942e9a92fSRobert Love struct fc_host_statistics host_stats; 820582b45bcSRobert Love struct fcoe_dev_stats *dev_stats; 82142e9a92fSRobert Love u8 retry_count; 82242e9a92fSRobert Love 8233a3b42bfSRobert Love /* Fabric information */ 8243a3b42bfSRobert Love u64 wwpn; 8253a3b42bfSRobert Love u64 wwnn; 82642e9a92fSRobert Love unsigned int service_params; 82742e9a92fSRobert Love unsigned int e_d_tov; 82842e9a92fSRobert Love unsigned int r_a_tov; 8293a3b42bfSRobert Love struct fc_els_rnid_gen rnid_gen; 8303a3b42bfSRobert Love 8313a3b42bfSRobert Love /* Capabilities */ 8323a3b42bfSRobert Love u32 sg_supp:1; 8333a3b42bfSRobert Love u32 seq_offload:1; 8343a3b42bfSRobert Love u32 crc_offload:1; 8353a3b42bfSRobert Love u32 lro_enabled:1; 8363a3b42bfSRobert Love u32 does_npiv:1; 8373a3b42bfSRobert Love u32 npiv_enabled:1; 8383a3b42bfSRobert Love u32 mfs; 83942e9a92fSRobert Love u8 max_retry_count; 840a3666955SAbhijeet Joglekar u8 max_rport_retry_count; 84142e9a92fSRobert Love u16 link_speed; 84242e9a92fSRobert Love u16 link_supported_speeds; 8433a3b42bfSRobert Love u16 lro_xid; 8443a3b42bfSRobert Love unsigned int lso_max; 8453a3b42bfSRobert Love struct fc_ns_fts fcts; 84642e9a92fSRobert Love 84742e9a92fSRobert Love /* Miscellaneous */ 8483a3b42bfSRobert Love struct mutex lp_mutex; 8493a3b42bfSRobert Love struct list_head list; 85042e9a92fSRobert Love struct delayed_work retry_work; 85142e9a92fSRobert Love }; 85242e9a92fSRobert Love 85334f42a07SRobert Love /* 85442e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 85542e9a92fSRobert Love *****************************/ 8563a3b42bfSRobert Love 8573a3b42bfSRobert Love /** 8583a3b42bfSRobert Love * fc_lport_test_ready() - Determine if a local port is in the READY state 8593a3b42bfSRobert Love * @lport: The local port to test 8603a3b42bfSRobert Love */ 8613a3b42bfSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lport) 86242e9a92fSRobert Love { 8633a3b42bfSRobert Love return lport->state == LPORT_ST_READY; 86442e9a92fSRobert Love } 86542e9a92fSRobert Love 8663a3b42bfSRobert Love /** 8673a3b42bfSRobert Love * fc_set_wwnn() - Set the World Wide Node Name of a local port 8683a3b42bfSRobert Love * @lport: The local port whose WWNN is to be set 8693a3b42bfSRobert Love * @wwnn: The new WWNN 8703a3b42bfSRobert Love */ 8713a3b42bfSRobert Love static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) 87242e9a92fSRobert Love { 8733a3b42bfSRobert Love lport->wwnn = wwnn; 87442e9a92fSRobert Love } 87542e9a92fSRobert Love 8763a3b42bfSRobert Love /** 8773a3b42bfSRobert Love * fc_set_wwpn() - Set the World Wide Port Name of a local port 8783a3b42bfSRobert Love * @lport: The local port whose WWPN is to be set 8793a3b42bfSRobert Love * @wwnn: The new WWPN 8803a3b42bfSRobert Love */ 8813a3b42bfSRobert Love static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) 88242e9a92fSRobert Love { 8833a3b42bfSRobert Love lport->wwpn = wwnn; 88442e9a92fSRobert Love } 88542e9a92fSRobert Love 8863a3b42bfSRobert Love /** 8873a3b42bfSRobert Love * fc_lport_state_enter() - Change a local port's state 8883a3b42bfSRobert Love * @lport: The local port whose state is to change 8893a3b42bfSRobert Love * @state: The new state 8903a3b42bfSRobert Love */ 8913a3b42bfSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lport, 89242e9a92fSRobert Love enum fc_lport_state state) 89342e9a92fSRobert Love { 8943a3b42bfSRobert Love if (state != lport->state) 8953a3b42bfSRobert Love lport->retry_count = 0; 8963a3b42bfSRobert Love lport->state = state; 89742e9a92fSRobert Love } 89842e9a92fSRobert Love 8993a3b42bfSRobert Love /** 9003a3b42bfSRobert Love * fc_lport_init_stats() - Allocate per-CPU statistics for a local port 9013a3b42bfSRobert Love * @lport: The local port whose statistics are to be initialized 9023a3b42bfSRobert Love */ 9033a3b42bfSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lport) 904582b45bcSRobert Love { 9053a3b42bfSRobert Love lport->dev_stats = alloc_percpu(struct fcoe_dev_stats); 9063a3b42bfSRobert Love if (!lport->dev_stats) 907582b45bcSRobert Love return -ENOMEM; 908582b45bcSRobert Love return 0; 909582b45bcSRobert Love } 910582b45bcSRobert Love 9113a3b42bfSRobert Love /** 9123a3b42bfSRobert Love * fc_lport_free_stats() - Free memory for a local port's statistics 9133a3b42bfSRobert Love * @lport: The local port whose statistics are to be freed 9143a3b42bfSRobert Love */ 9153a3b42bfSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lport) 916582b45bcSRobert Love { 9173a3b42bfSRobert Love free_percpu(lport->dev_stats); 918a0a25da2SVasu Dev } 919a0a25da2SVasu Dev 920a0a25da2SVasu Dev /** 9213a3b42bfSRobert Love * fc_lport_get_stats() - Get a local port's statistics 9223a3b42bfSRobert Love * @lport: The local port whose statistics are to be retreived 9233a3b42bfSRobert Love */ 9243a3b42bfSRobert Love static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lport) 9253a3b42bfSRobert Love { 9263a3b42bfSRobert Love return per_cpu_ptr(lport->dev_stats, smp_processor_id()); 9273a3b42bfSRobert Love } 9283a3b42bfSRobert Love 9293a3b42bfSRobert Love /** 9303a3b42bfSRobert Love * lport_priv() - Return the private data from a local port 9313a3b42bfSRobert Love * @lport: The local port whose private data is to be retreived 9323a3b42bfSRobert Love */ 9333a3b42bfSRobert Love static inline void *lport_priv(const struct fc_lport *lport) 9343a3b42bfSRobert Love { 9353a3b42bfSRobert Love return (void *)(lport + 1); 9363a3b42bfSRobert Love } 9373a3b42bfSRobert Love 9383a3b42bfSRobert Love /** 9393a3b42bfSRobert Love * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and 9403a3b42bfSRobert Love * LLD private data 9413a3b42bfSRobert Love * @sht: The SCSI host template 9423a3b42bfSRobert Love * @priv_size: Size of private data 943a0a25da2SVasu Dev * 94486221969SChris Leech * Returns: libfc lport 945a0a25da2SVasu Dev */ 94686221969SChris Leech static inline struct fc_lport * 947a0a25da2SVasu Dev libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 948a0a25da2SVasu Dev { 94986221969SChris Leech struct fc_lport *lport; 95086221969SChris Leech struct Scsi_Host *shost; 95186221969SChris Leech 95286221969SChris Leech shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 95386221969SChris Leech if (!shost) 95486221969SChris Leech return NULL; 95586221969SChris Leech lport = shost_priv(shost); 95686221969SChris Leech lport->host = shost; 95786221969SChris Leech INIT_LIST_HEAD(&lport->ema_list); 958174e1ebfSChris Leech INIT_LIST_HEAD(&lport->vports); 95986221969SChris Leech return lport; 960a0a25da2SVasu Dev } 96142e9a92fSRobert Love 96234f42a07SRobert Love /* 9633a3b42bfSRobert Love * FC_FCP HELPER FUNCTIONS 9643a3b42bfSRobert Love *****************************/ 9653a3b42bfSRobert Love static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 9663a3b42bfSRobert Love { 9673a3b42bfSRobert Love if (fsp && fsp->cmd) 9683a3b42bfSRobert Love return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 9693a3b42bfSRobert Love return false; 9703a3b42bfSRobert Love } 9713a3b42bfSRobert Love 9723a3b42bfSRobert Love /* 97342e9a92fSRobert Love * LOCAL PORT LAYER 97442e9a92fSRobert Love *****************************/ 9753a3b42bfSRobert Love int fc_lport_init(struct fc_lport *); 9763a3b42bfSRobert Love int fc_lport_destroy(struct fc_lport *); 9773a3b42bfSRobert Love int fc_fabric_logoff(struct fc_lport *); 9783a3b42bfSRobert Love int fc_fabric_login(struct fc_lport *); 9798faecddbSChris Leech void __fc_linkup(struct fc_lport *); 98042e9a92fSRobert Love void fc_linkup(struct fc_lport *); 9818faecddbSChris Leech void __fc_linkdown(struct fc_lport *); 98242e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 9833a3b42bfSRobert Love void fc_vport_setlink(struct fc_lport *); 9843a3b42bfSRobert Love void fc_vports_linkchange(struct fc_lport *); 98542e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 98642e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 9873a3b42bfSRobert Love int fc_set_mfs(struct fc_lport *, u32 mfs); 9883a3b42bfSRobert Love struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); 9893a3b42bfSRobert Love struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); 9903a3b42bfSRobert Love int fc_lport_bsg_request(struct fc_bsg_job *); 991a51ab396SSteve Ma 992a51ab396SSteve Ma /* 99342e9a92fSRobert Love * REMOTE PORT LAYER 99442e9a92fSRobert Love *****************************/ 9953a3b42bfSRobert Love int fc_rport_init(struct fc_lport *); 9963a3b42bfSRobert Love void fc_rport_terminate_io(struct fc_rport *); 99742e9a92fSRobert Love 99834f42a07SRobert Love /* 99942e9a92fSRobert Love * DISCOVERY LAYER 100042e9a92fSRobert Love *****************************/ 10013a3b42bfSRobert Love int fc_disc_init(struct fc_lport *); 100242e9a92fSRobert Love 100334f42a07SRobert Love /* 10043a3b42bfSRobert Love * FCP LAYER 100542e9a92fSRobert Love *****************************/ 100642e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 100742e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 100842e9a92fSRobert Love 100934f42a07SRobert Love /* 10103a3b42bfSRobert Love * SCSI INTERACTION LAYER 10113a3b42bfSRobert Love *****************************/ 10123a3b42bfSRobert Love int fc_queuecommand(struct scsi_cmnd *, 10133a3b42bfSRobert Love void (*done)(struct scsi_cmnd *)); 10143a3b42bfSRobert Love int fc_eh_abort(struct scsi_cmnd *); 10153a3b42bfSRobert Love int fc_eh_device_reset(struct scsi_cmnd *); 10163a3b42bfSRobert Love int fc_eh_host_reset(struct scsi_cmnd *); 10173a3b42bfSRobert Love int fc_slave_alloc(struct scsi_device *); 10183a3b42bfSRobert Love int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason); 10193a3b42bfSRobert Love int fc_change_queue_type(struct scsi_device *, int tag_type); 10203a3b42bfSRobert Love 10213a3b42bfSRobert Love /* 102242e9a92fSRobert Love * ELS/CT interface 102342e9a92fSRobert Love *****************************/ 10243a3b42bfSRobert Love int fc_elsct_init(struct fc_lport *); 10253a3b42bfSRobert Love struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, 10263a3b42bfSRobert Love struct fc_frame *, 102711b56188SChris Leech unsigned int op, 102811b56188SChris Leech void (*resp)(struct fc_seq *, 10293a3b42bfSRobert Love struct fc_frame *, 103011b56188SChris Leech void *arg), 103111b56188SChris Leech void *arg, u32 timer_msec); 103211b56188SChris Leech void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 103311b56188SChris Leech void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 103442e9a92fSRobert Love 103542e9a92fSRobert Love 103634f42a07SRobert Love /* 103742e9a92fSRobert Love * EXCHANGE MANAGER LAYER 103842e9a92fSRobert Love *****************************/ 10393a3b42bfSRobert Love int fc_exch_init(struct fc_lport *); 10403a3b42bfSRobert Love struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, 10413a3b42bfSRobert Love struct fc_exch_mgr *, 104296316099SVasu Dev bool (*match)(struct fc_frame *)); 10433a3b42bfSRobert Love void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); 1044174e1ebfSChris Leech int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 10453a3b42bfSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, 10463a3b42bfSRobert Love u16 min_xid, u16 max_xid, 104752ff878cSVasu Dev bool (*match)(struct fc_frame *)); 10483a3b42bfSRobert Love void fc_exch_mgr_free(struct fc_lport *); 10493a3b42bfSRobert Love void fc_exch_recv(struct fc_lport *, struct fc_frame *); 10501f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 105142e9a92fSRobert Love 105242e9a92fSRobert Love /* 105342e9a92fSRobert Love * Functions for fc_functions_template 105442e9a92fSRobert Love */ 10553a3b42bfSRobert Love void fc_get_host_speed(struct Scsi_Host *); 10563a3b42bfSRobert Love void fc_get_host_port_type(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