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> 2942e9a92fSRobert Love 3042e9a92fSRobert Love #include <scsi/fc/fc_fcp.h> 3142e9a92fSRobert Love #include <scsi/fc/fc_ns.h> 3242e9a92fSRobert Love #include <scsi/fc/fc_els.h> 3342e9a92fSRobert Love #include <scsi/fc/fc_gs.h> 3442e9a92fSRobert Love 3542e9a92fSRobert Love #include <scsi/fc_frame.h> 3642e9a92fSRobert Love 3742e9a92fSRobert Love /* 3842e9a92fSRobert Love * libfc error codes 3942e9a92fSRobert Love */ 4042e9a92fSRobert Love #define FC_NO_ERR 0 /* no error */ 4142e9a92fSRobert Love #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 4242e9a92fSRobert Love #define FC_EX_CLOSED 2 /* Exchange closed */ 4342e9a92fSRobert Love 4442e9a92fSRobert Love /* some helpful macros */ 4542e9a92fSRobert Love 4642e9a92fSRobert Love #define ntohll(x) be64_to_cpu(x) 4742e9a92fSRobert Love #define htonll(x) cpu_to_be64(x) 4842e9a92fSRobert Love 4942e9a92fSRobert Love #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 5042e9a92fSRobert Love 5142e9a92fSRobert Love #define hton24(p, v) do { \ 5242e9a92fSRobert Love p[0] = (((v) >> 16) & 0xFF); \ 5342e9a92fSRobert Love p[1] = (((v) >> 8) & 0xFF); \ 5442e9a92fSRobert Love p[2] = ((v) & 0xFF); \ 5542e9a92fSRobert Love } while (0) 5642e9a92fSRobert Love 5742e9a92fSRobert Love /* 5842e9a92fSRobert Love * FC HBA status 5942e9a92fSRobert Love */ 6042e9a92fSRobert Love enum fc_lport_state { 61b1d9fd55SJoe Eykholt LPORT_ST_DISABLED = 0, 6242e9a92fSRobert Love LPORT_ST_FLOGI, 6342e9a92fSRobert Love LPORT_ST_DNS, 6442e9a92fSRobert Love LPORT_ST_RPN_ID, 6542e9a92fSRobert Love LPORT_ST_RFT_ID, 6642e9a92fSRobert Love LPORT_ST_SCR, 6742e9a92fSRobert Love LPORT_ST_READY, 6842e9a92fSRobert Love LPORT_ST_LOGO, 6942e9a92fSRobert Love LPORT_ST_RESET 7042e9a92fSRobert Love }; 7142e9a92fSRobert Love 7242e9a92fSRobert Love enum fc_disc_event { 7342e9a92fSRobert Love DISC_EV_NONE = 0, 7442e9a92fSRobert Love DISC_EV_SUCCESS, 7542e9a92fSRobert Love DISC_EV_FAILED 7642e9a92fSRobert Love }; 7742e9a92fSRobert Love 7842e9a92fSRobert Love enum fc_rport_state { 7942e9a92fSRobert Love RPORT_ST_INIT, /* initialized */ 8042e9a92fSRobert Love RPORT_ST_PLOGI, /* waiting for PLOGI completion */ 8142e9a92fSRobert Love RPORT_ST_PRLI, /* waiting for PRLI completion */ 8242e9a92fSRobert Love RPORT_ST_RTV, /* waiting for RTV completion */ 8342e9a92fSRobert Love RPORT_ST_READY, /* ready for use */ 8442e9a92fSRobert Love RPORT_ST_LOGO, /* port logout sent */ 85370c3bd0SJoe Eykholt RPORT_ST_ADISC, /* Discover Address sent */ 8614194054SJoe Eykholt RPORT_ST_DELETE, /* port being deleted */ 87b4a9c7edSJoe Eykholt RPORT_ST_RESTART, /* remote port being deleted and will restart */ 8842e9a92fSRobert Love }; 8942e9a92fSRobert Love 9042e9a92fSRobert Love /** 9142e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 9242e9a92fSRobert Love * @lp: Fibre Channel host port instance 939737e6a7SRobert Love * @peers: Node for list management during discovery and RSCN processing 949737e6a7SRobert Love * @rport_work: Work struct for starting the rport state machine 959737e6a7SRobert Love * @port_id: Port ID of the discovered port 9642e9a92fSRobert Love */ 9742e9a92fSRobert Love struct fc_disc_port { 9842e9a92fSRobert Love struct fc_lport *lp; 9942e9a92fSRobert Love struct list_head peers; 10042e9a92fSRobert Love struct work_struct rport_work; 1019737e6a7SRobert Love u32 port_id; 10242e9a92fSRobert Love }; 10342e9a92fSRobert Love 10442e9a92fSRobert Love enum fc_rport_event { 10542e9a92fSRobert Love RPORT_EV_NONE = 0, 1064c0f62b5SJoe Eykholt RPORT_EV_READY, 10742e9a92fSRobert Love RPORT_EV_FAILED, 10842e9a92fSRobert Love RPORT_EV_STOP, 10942e9a92fSRobert Love RPORT_EV_LOGO 11042e9a92fSRobert Love }; 11142e9a92fSRobert Love 1129fb9d328SJoe Eykholt struct fc_rport_priv; 1139fb9d328SJoe Eykholt 11442e9a92fSRobert Love struct fc_rport_operations { 1159fb9d328SJoe Eykholt void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, 11642e9a92fSRobert Love enum fc_rport_event); 11742e9a92fSRobert Love }; 11842e9a92fSRobert Love 11942e9a92fSRobert Love /** 12042e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 12142e9a92fSRobert Love * @local_port: Fibre Channel host port instance 1229e9d0452SJoe Eykholt * @rp_state: indicates READY for I/O or DELETE when blocked. 1239e9d0452SJoe Eykholt * @flags: REC and RETRY supported flags 1249e9d0452SJoe Eykholt * @e_d_tov: error detect timeout value (in msec) 1259e9d0452SJoe Eykholt * @r_a_tov: resource allocation timeout value (in msec) 1269e9d0452SJoe Eykholt */ 1279e9d0452SJoe Eykholt struct fc_rport_libfc_priv { 1289e9d0452SJoe Eykholt struct fc_lport *local_port; 1299e9d0452SJoe Eykholt enum fc_rport_state rp_state; 1309e9d0452SJoe Eykholt u16 flags; 1319e9d0452SJoe Eykholt #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 1329e9d0452SJoe Eykholt #define FC_RP_FLAGS_RETRY (1 << 1) 1339e9d0452SJoe Eykholt unsigned int e_d_tov; 1349e9d0452SJoe Eykholt unsigned int r_a_tov; 1359e9d0452SJoe Eykholt }; 1369e9d0452SJoe Eykholt 1379e9d0452SJoe Eykholt /** 1389e9d0452SJoe Eykholt * struct fc_rport_priv - libfc rport and discovery info about a remote port 1399e9d0452SJoe Eykholt * @local_port: Fibre Channel host port instance 140f211fa51SJoe Eykholt * @rport: transport remote port 141f211fa51SJoe Eykholt * @kref: reference counter 14242e9a92fSRobert Love * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges 143f211fa51SJoe Eykholt * @ids: remote port identifiers and roles 14442e9a92fSRobert Love * @flags: REC and RETRY supported flags 14542e9a92fSRobert Love * @max_seq: maximum number of concurrent sequences 1460f6c6149SJoe Eykholt * @disc_id: discovery identifier 147f211fa51SJoe Eykholt * @maxframe_size: maximum frame size 14842e9a92fSRobert Love * @retries: retry count in current state 14942e9a92fSRobert Love * @e_d_tov: error detect timeout value (in msec) 15042e9a92fSRobert Love * @r_a_tov: resource allocation timeout value (in msec) 15142e9a92fSRobert Love * @rp_mutex: mutex protects rport 15242e9a92fSRobert Love * @retry_work: 15342e9a92fSRobert Love * @event_callback: Callback for rport READY, FAILED or LOGO 15442e9a92fSRobert Love */ 1559e9d0452SJoe Eykholt struct fc_rport_priv { 15642e9a92fSRobert Love struct fc_lport *local_port; 157f211fa51SJoe Eykholt struct fc_rport *rport; 158f211fa51SJoe Eykholt struct kref kref; 15942e9a92fSRobert Love enum fc_rport_state rp_state; 160f211fa51SJoe Eykholt struct fc_rport_identifiers ids; 16142e9a92fSRobert Love u16 flags; 16242e9a92fSRobert Love u16 max_seq; 1630f6c6149SJoe Eykholt u16 disc_id; 164f211fa51SJoe Eykholt u16 maxframe_size; 16542e9a92fSRobert Love unsigned int retries; 16642e9a92fSRobert Love unsigned int e_d_tov; 16742e9a92fSRobert Love unsigned int r_a_tov; 16842e9a92fSRobert Love struct mutex rp_mutex; 16942e9a92fSRobert Love struct delayed_work retry_work; 17042e9a92fSRobert Love enum fc_rport_event event; 17142e9a92fSRobert Love struct fc_rport_operations *ops; 17242e9a92fSRobert Love struct list_head peers; 17342e9a92fSRobert Love struct work_struct event_work; 174f211fa51SJoe Eykholt u32 supported_classes; 17542e9a92fSRobert Love }; 17642e9a92fSRobert Love 17742e9a92fSRobert Love /* 17842e9a92fSRobert Love * fcoe stats structure 17942e9a92fSRobert Love */ 18042e9a92fSRobert Love struct fcoe_dev_stats { 18142e9a92fSRobert Love u64 SecondsSinceLastReset; 18242e9a92fSRobert Love u64 TxFrames; 18342e9a92fSRobert Love u64 TxWords; 18442e9a92fSRobert Love u64 RxFrames; 18542e9a92fSRobert Love u64 RxWords; 18642e9a92fSRobert Love u64 ErrorFrames; 18742e9a92fSRobert Love u64 DumpedFrames; 18842e9a92fSRobert Love u64 LinkFailureCount; 18942e9a92fSRobert Love u64 LossOfSignalCount; 19042e9a92fSRobert Love u64 InvalidTxWordCount; 19142e9a92fSRobert Love u64 InvalidCRCCount; 19242e9a92fSRobert Love u64 InputRequests; 19342e9a92fSRobert Love u64 OutputRequests; 19442e9a92fSRobert Love u64 ControlRequests; 19542e9a92fSRobert Love u64 InputMegabytes; 19642e9a92fSRobert Love u64 OutputMegabytes; 19742e9a92fSRobert Love }; 19842e9a92fSRobert Love 19942e9a92fSRobert Love /* 20042e9a92fSRobert Love * els data is used for passing ELS respone specific 20142e9a92fSRobert Love * data to send ELS response mainly using infomation 20242e9a92fSRobert Love * in exchange and sequence in EM layer. 20342e9a92fSRobert Love */ 20442e9a92fSRobert Love struct fc_seq_els_data { 20542e9a92fSRobert Love struct fc_frame *fp; 20642e9a92fSRobert Love enum fc_els_rjt_reason reason; 20742e9a92fSRobert Love enum fc_els_rjt_explan explan; 20842e9a92fSRobert Love }; 20942e9a92fSRobert Love 21042e9a92fSRobert Love /* 21142e9a92fSRobert Love * FCP request structure, one for each scsi cmd request 21242e9a92fSRobert Love */ 21342e9a92fSRobert Love struct fc_fcp_pkt { 21442e9a92fSRobert Love /* 21542e9a92fSRobert Love * housekeeping stuff 21642e9a92fSRobert Love */ 21742e9a92fSRobert Love struct fc_lport *lp; /* handle to hba struct */ 21842e9a92fSRobert Love u16 state; /* scsi_pkt state state */ 21942e9a92fSRobert Love u16 tgt_flags; /* target flags */ 22042e9a92fSRobert Love atomic_t ref_cnt; /* fcp pkt ref count */ 22142e9a92fSRobert Love spinlock_t scsi_pkt_lock; /* Must be taken before the host lock 22242e9a92fSRobert Love * if both are held at the same time */ 22342e9a92fSRobert Love /* 22442e9a92fSRobert Love * SCSI I/O related stuff 22542e9a92fSRobert Love */ 22642e9a92fSRobert Love struct scsi_cmnd *cmd; /* scsi command pointer. set/clear 22742e9a92fSRobert Love * under host lock */ 22842e9a92fSRobert Love struct list_head list; /* tracks queued commands. access under 22942e9a92fSRobert Love * host lock */ 23042e9a92fSRobert Love /* 23142e9a92fSRobert Love * timeout related stuff 23242e9a92fSRobert Love */ 23342e9a92fSRobert Love struct timer_list timer; /* command timer */ 23442e9a92fSRobert Love struct completion tm_done; 23542e9a92fSRobert Love int wait_for_comp; 23642e9a92fSRobert Love unsigned long start_time; /* start jiffie */ 23742e9a92fSRobert Love unsigned long end_time; /* end jiffie */ 23842e9a92fSRobert Love unsigned long last_pkt_time; /* jiffies of last frame received */ 23942e9a92fSRobert Love 24042e9a92fSRobert Love /* 24142e9a92fSRobert Love * scsi cmd and data transfer information 24242e9a92fSRobert Love */ 24342e9a92fSRobert Love u32 data_len; 24442e9a92fSRobert Love /* 24542e9a92fSRobert Love * transport related veriables 24642e9a92fSRobert Love */ 24742e9a92fSRobert Love struct fcp_cmnd cdb_cmd; 24842e9a92fSRobert Love size_t xfer_len; 249b277d2aaSYi Zou u16 xfer_ddp; /* this xfer is ddped */ 25042e9a92fSRobert Love u32 xfer_contig_end; /* offset of end of contiguous xfer */ 25142e9a92fSRobert Love u16 max_payload; /* max payload size in bytes */ 25242e9a92fSRobert Love 25342e9a92fSRobert Love /* 25442e9a92fSRobert Love * scsi/fcp return status 25542e9a92fSRobert Love */ 25642e9a92fSRobert Love u32 io_status; /* SCSI result upper 24 bits */ 25742e9a92fSRobert Love u8 cdb_status; 25842e9a92fSRobert Love u8 status_code; /* FCP I/O status */ 25942e9a92fSRobert Love /* bit 3 Underrun bit 2: overrun */ 26042e9a92fSRobert Love u8 scsi_comp_flags; 26142e9a92fSRobert Love u32 req_flags; /* bit 0: read bit:1 write */ 26242e9a92fSRobert Love u32 scsi_resid; /* residule length */ 26342e9a92fSRobert Love 26442e9a92fSRobert Love struct fc_rport *rport; /* remote port pointer */ 26542e9a92fSRobert Love struct fc_seq *seq_ptr; /* current sequence pointer */ 26642e9a92fSRobert Love /* 26742e9a92fSRobert Love * Error Processing 26842e9a92fSRobert Love */ 26942e9a92fSRobert Love u8 recov_retry; /* count of recovery retries */ 27042e9a92fSRobert Love struct fc_seq *recov_seq; /* sequence for REC or SRR */ 27142e9a92fSRobert Love }; 272b277d2aaSYi Zou /* 273b277d2aaSYi Zou * FC_FCP HELPER FUNCTIONS 274b277d2aaSYi Zou *****************************/ 275b277d2aaSYi Zou static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 276b277d2aaSYi Zou { 277b277d2aaSYi Zou if (fsp && fsp->cmd) 278b277d2aaSYi Zou return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 279b277d2aaSYi Zou return false; 280b277d2aaSYi Zou } 28142e9a92fSRobert Love 28242e9a92fSRobert Love /* 28342e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 28442e9a92fSRobert Love * and Sequences 28542e9a92fSRobert Love * 28642e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 28742e9a92fSRobert Love * 28842e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 28942e9a92fSRobert Love */ 29042e9a92fSRobert Love 29142e9a92fSRobert Love struct fc_exch_mgr; 29296316099SVasu Dev struct fc_exch_mgr_anchor; 293e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 29442e9a92fSRobert Love 29542e9a92fSRobert Love /* 29642e9a92fSRobert Love * Sequence. 29742e9a92fSRobert Love */ 29842e9a92fSRobert Love struct fc_seq { 29942e9a92fSRobert Love u8 id; /* seq ID */ 30042e9a92fSRobert Love u16 ssb_stat; /* status flags for sequence status block */ 30142e9a92fSRobert Love u16 cnt; /* frames sent so far on sequence */ 30242e9a92fSRobert Love u32 rec_data; /* FC-4 value for REC */ 30342e9a92fSRobert Love }; 30442e9a92fSRobert Love 30542e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 30642e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 30742e9a92fSRobert Love 30842e9a92fSRobert Love /* 30942e9a92fSRobert Love * Exchange. 31042e9a92fSRobert Love * 31142e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 31242e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 31342e9a92fSRobert Love * seq_id 31442e9a92fSRobert Love * sequence allocation 31542e9a92fSRobert Love */ 31642e9a92fSRobert Love struct fc_exch { 31742e9a92fSRobert Love struct fc_exch_mgr *em; /* exchange manager */ 318b2f0091fSVasu Dev struct fc_exch_pool *pool; /* per cpu exches pool */ 31942e9a92fSRobert Love u32 state; /* internal driver state */ 32042e9a92fSRobert Love u16 xid; /* our exchange ID */ 32142e9a92fSRobert Love struct list_head ex_list; /* free or busy list linkage */ 32242e9a92fSRobert Love spinlock_t ex_lock; /* lock covering exchange state */ 32342e9a92fSRobert Love atomic_t ex_refcnt; /* reference counter */ 32442e9a92fSRobert Love struct delayed_work timeout_work; /* timer for upper level protocols */ 32542e9a92fSRobert Love struct fc_lport *lp; /* fc device instance */ 32642e9a92fSRobert Love u16 oxid; /* originator's exchange ID */ 32742e9a92fSRobert Love u16 rxid; /* responder's exchange ID */ 32842e9a92fSRobert Love u32 oid; /* originator's FCID */ 32942e9a92fSRobert Love u32 sid; /* source FCID */ 33042e9a92fSRobert Love u32 did; /* destination FCID */ 33142e9a92fSRobert Love u32 esb_stat; /* exchange status for ESB */ 33242e9a92fSRobert Love u32 r_a_tov; /* r_a_tov from rport (msec) */ 33342e9a92fSRobert Love u8 seq_id; /* next sequence ID to use */ 33442e9a92fSRobert Love u32 f_ctl; /* F_CTL flags for sequences */ 33542e9a92fSRobert Love u8 fh_type; /* frame type */ 33642e9a92fSRobert Love enum fc_class class; /* class of service */ 33742e9a92fSRobert Love struct fc_seq seq; /* single sequence */ 33842e9a92fSRobert Love /* 33942e9a92fSRobert Love * Handler for responses to this current exchange. 34042e9a92fSRobert Love */ 34142e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 34242e9a92fSRobert Love void (*destructor)(struct fc_seq *, void *); 34342e9a92fSRobert Love /* 34442e9a92fSRobert Love * arg is passed as void pointer to exchange 34542e9a92fSRobert Love * resp and destructor handlers 34642e9a92fSRobert Love */ 34742e9a92fSRobert Love void *arg; 34842e9a92fSRobert Love }; 34942e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 35042e9a92fSRobert Love 35142e9a92fSRobert Love struct libfc_function_template { 35242e9a92fSRobert Love 35342e9a92fSRobert Love /* 35442e9a92fSRobert Love * Interface to send a FC frame 3550ae4d4aeSRobert Love * 3560ae4d4aeSRobert Love * STATUS: REQUIRED 35742e9a92fSRobert Love */ 35842e9a92fSRobert Love int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); 35942e9a92fSRobert Love 36042e9a92fSRobert Love /* 3610ae4d4aeSRobert Love * Interface to send ELS/CT frames 3620ae4d4aeSRobert Love * 3630ae4d4aeSRobert Love * STATUS: OPTIONAL 36442e9a92fSRobert Love */ 36542e9a92fSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *lport, 366a46f327aSJoe Eykholt u32 did, 36742e9a92fSRobert Love struct fc_frame *fp, 36842e9a92fSRobert Love unsigned int op, 36942e9a92fSRobert Love void (*resp)(struct fc_seq *, 37042e9a92fSRobert Love struct fc_frame *fp, 37142e9a92fSRobert Love void *arg), 37242e9a92fSRobert Love void *arg, u32 timer_msec); 37342e9a92fSRobert Love 37442e9a92fSRobert Love /* 37542e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 37642e9a92fSRobert Love * 37742e9a92fSRobert Love * The frame pointer with some of the header's fields must be 37842e9a92fSRobert Love * filled before calling exch_seq_send(), those fields are, 37942e9a92fSRobert Love * 38042e9a92fSRobert Love * - routing control 38142e9a92fSRobert Love * - FC port did 38242e9a92fSRobert Love * - FC port sid 38342e9a92fSRobert Love * - FC header type 38442e9a92fSRobert Love * - frame control 38542e9a92fSRobert Love * - parameter or relative offset 38642e9a92fSRobert Love * 38742e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 38842e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 38942e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 39042e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 39142e9a92fSRobert Love * as error using IS_ERR related macros. 39242e9a92fSRobert Love * 39342e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 39442e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 39542e9a92fSRobert Love * is about to free, this can be used by caller to free its 39642e9a92fSRobert Love * resources along with exchange free. 39742e9a92fSRobert Love * 39842e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 39942e9a92fSRobert Love * 40042e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 40142e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 40242e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 40342e9a92fSRobert Love * is registered by EM layer. 4040ae4d4aeSRobert Love * 4050ae4d4aeSRobert Love * STATUS: OPTIONAL 40642e9a92fSRobert Love */ 40742e9a92fSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, 40842e9a92fSRobert Love struct fc_frame *fp, 40942e9a92fSRobert Love void (*resp)(struct fc_seq *sp, 41042e9a92fSRobert Love struct fc_frame *fp, 41142e9a92fSRobert Love void *arg), 41242e9a92fSRobert Love void (*destructor)(struct fc_seq *sp, 41342e9a92fSRobert Love void *arg), 41442e9a92fSRobert Love void *arg, unsigned int timer_msec); 41542e9a92fSRobert Love 41642e9a92fSRobert Love /* 417b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given 418b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive. 419b277d2aaSYi Zou * 420b277d2aaSYi Zou * STATUS: OPTIONAL 421b277d2aaSYi Zou */ 422b277d2aaSYi Zou int (*ddp_setup)(struct fc_lport *lp, u16 xid, 423b277d2aaSYi Zou struct scatterlist *sgl, unsigned int sgc); 424b277d2aaSYi Zou /* 425b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed 426b277d2aaSYi Zou * for the given exchange id. 427b277d2aaSYi Zou * 428b277d2aaSYi Zou * STATUS: OPTIONAL 429b277d2aaSYi Zou */ 430b277d2aaSYi Zou int (*ddp_done)(struct fc_lport *lp, u16 xid); 431b277d2aaSYi Zou /* 4320ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 4330ae4d4aeSRobert Love * 4340ae4d4aeSRobert Love * STATUS: OPTIONAL 43542e9a92fSRobert Love */ 43642e9a92fSRobert Love int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, 43742e9a92fSRobert Love struct fc_frame *fp); 43842e9a92fSRobert Love 43942e9a92fSRobert Love /* 4400ae4d4aeSRobert Love * Send an ELS response using infomation from a previous 4410ae4d4aeSRobert Love * exchange and sequence. 4420ae4d4aeSRobert Love * 4430ae4d4aeSRobert Love * STATUS: OPTIONAL 44442e9a92fSRobert Love */ 44542e9a92fSRobert Love void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, 44642e9a92fSRobert Love struct fc_seq_els_data *els_data); 44742e9a92fSRobert Love 44842e9a92fSRobert Love /* 44942e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 45042e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 45142e9a92fSRobert Love * 45242e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 45342e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 45442e9a92fSRobert Love * will be called with timeout error if no response to abort. 4550ae4d4aeSRobert Love * 4560ae4d4aeSRobert Love * STATUS: OPTIONAL 45742e9a92fSRobert Love */ 45842e9a92fSRobert Love int (*seq_exch_abort)(const struct fc_seq *req_sp, 45942e9a92fSRobert Love unsigned int timer_msec); 46042e9a92fSRobert Love 46142e9a92fSRobert Love /* 46242e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 46342e9a92fSRobert Love * allocated for the related objects may be freed. 4640ae4d4aeSRobert Love * 4650ae4d4aeSRobert Love * STATUS: OPTIONAL 46642e9a92fSRobert Love */ 46742e9a92fSRobert Love void (*exch_done)(struct fc_seq *sp); 46842e9a92fSRobert Love 46942e9a92fSRobert Love /* 47042e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 4710ae4d4aeSRobert Love * 4720ae4d4aeSRobert Love * STATUS: OPTIONAL 47342e9a92fSRobert Love */ 47442e9a92fSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *sp); 47542e9a92fSRobert Love 47642e9a92fSRobert Love /* 47742e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 47842e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 47942e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 4800ae4d4aeSRobert Love * 4810ae4d4aeSRobert Love * STATUS: OPTIONAL 48242e9a92fSRobert Love */ 4831f6ff364SAbhijeet Joglekar void (*exch_mgr_reset)(struct fc_lport *, 48442e9a92fSRobert Love u32 s_id, u32 d_id); 48542e9a92fSRobert Love 4860ae4d4aeSRobert Love /* 4870ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 4880ae4d4aeSRobert Love * 4890ae4d4aeSRobert Love * STATUS: OPTIONAL 49042e9a92fSRobert Love */ 4910ae4d4aeSRobert Love void (*rport_flush_queue)(void); 49242e9a92fSRobert Love 49342e9a92fSRobert Love /* 4940ae4d4aeSRobert Love * Receive a frame for a local port. 4950ae4d4aeSRobert Love * 4960ae4d4aeSRobert Love * STATUS: OPTIONAL 49742e9a92fSRobert Love */ 49842e9a92fSRobert Love void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, 49942e9a92fSRobert Love struct fc_frame *fp); 50042e9a92fSRobert Love 5010ae4d4aeSRobert Love /* 5020ae4d4aeSRobert Love * Reset the local port. 5030ae4d4aeSRobert Love * 5040ae4d4aeSRobert Love * STATUS: OPTIONAL 50542e9a92fSRobert Love */ 5060ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 50742e9a92fSRobert Love 50842e9a92fSRobert Love /* 5099737e6a7SRobert Love * Create a remote port with a given port ID 5109737e6a7SRobert Love * 5119737e6a7SRobert Love * STATUS: OPTIONAL 5125101ff99SRobert Love */ 5139737e6a7SRobert Love struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 5145101ff99SRobert Love 5155101ff99SRobert Love /* 51642e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 51742e9a92fSRobert Love * This function will issue the following commands to the N_Port 51842e9a92fSRobert Love * identified by the FC ID provided. 51942e9a92fSRobert Love * 52042e9a92fSRobert Love * - PLOGI 52142e9a92fSRobert Love * - PRLI 52242e9a92fSRobert Love * - RTV 5230ae4d4aeSRobert Love * 5240ae4d4aeSRobert Love * STATUS: OPTIONAL 52542e9a92fSRobert Love */ 5269fb9d328SJoe Eykholt int (*rport_login)(struct fc_rport_priv *); 52742e9a92fSRobert Love 52842e9a92fSRobert Love /* 52942e9a92fSRobert Love * Logoff, and remove the rport from the transport if 53042e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 5310ae4d4aeSRobert Love * 5320ae4d4aeSRobert Love * STATUS: OPTIONAL 53342e9a92fSRobert Love */ 5349fb9d328SJoe Eykholt int (*rport_logoff)(struct fc_rport_priv *); 53542e9a92fSRobert Love 53642e9a92fSRobert Love /* 53742e9a92fSRobert Love * Recieve a request from a remote port. 5380ae4d4aeSRobert Love * 5390ae4d4aeSRobert Love * STATUS: OPTIONAL 54042e9a92fSRobert Love */ 54142e9a92fSRobert Love void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 542131203a1SJoe Eykholt struct fc_lport *); 54342e9a92fSRobert Love 5440ae4d4aeSRobert Love /* 5450ae4d4aeSRobert Love * lookup an rport by it's port ID. 5460ae4d4aeSRobert Love * 5470ae4d4aeSRobert Love * STATUS: OPTIONAL 54842e9a92fSRobert Love */ 5499fb9d328SJoe Eykholt struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 55042e9a92fSRobert Love 55142e9a92fSRobert Love /* 552f211fa51SJoe Eykholt * Destroy an rport after final kref_put(). 553f211fa51SJoe Eykholt * The argument is a pointer to the kref inside the fc_rport_priv. 554f211fa51SJoe Eykholt */ 555f211fa51SJoe Eykholt void (*rport_destroy)(struct kref *); 556f211fa51SJoe Eykholt 557f211fa51SJoe Eykholt /* 55842e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 55942e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 56042e9a92fSRobert Love * 56142e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 56242e9a92fSRobert Love * 5630ae4d4aeSRobert Love * STATUS: OPTIONAL 56442e9a92fSRobert Love */ 56542e9a92fSRobert Love int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, 56642e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *fp, 56742e9a92fSRobert Love void *arg)); 56842e9a92fSRobert Love 56942e9a92fSRobert Love /* 5700ae4d4aeSRobert Love * Cleanup the FCP layer, used durring link down and reset 5710ae4d4aeSRobert Love * 5720ae4d4aeSRobert Love * STATUS: OPTIONAL 57342e9a92fSRobert Love */ 57442e9a92fSRobert Love void (*fcp_cleanup)(struct fc_lport *lp); 57542e9a92fSRobert Love 57642e9a92fSRobert Love /* 57742e9a92fSRobert Love * Abort all I/O on a local port 5780ae4d4aeSRobert Love * 5790ae4d4aeSRobert Love * STATUS: OPTIONAL 58042e9a92fSRobert Love */ 58142e9a92fSRobert Love void (*fcp_abort_io)(struct fc_lport *lp); 58242e9a92fSRobert Love 5830ae4d4aeSRobert Love /* 5840ae4d4aeSRobert Love * Receive a request for the discovery layer. 5850ae4d4aeSRobert Love * 5860ae4d4aeSRobert Love * STATUS: OPTIONAL 58742e9a92fSRobert Love */ 58842e9a92fSRobert Love void (*disc_recv_req)(struct fc_seq *, 58942e9a92fSRobert Love struct fc_frame *, struct fc_lport *); 59042e9a92fSRobert Love 59142e9a92fSRobert Love /* 59242e9a92fSRobert Love * Start discovery for a local port. 5930ae4d4aeSRobert Love * 5940ae4d4aeSRobert Love * STATUS: OPTIONAL 59542e9a92fSRobert Love */ 59642e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 59742e9a92fSRobert Love enum fc_disc_event), 59842e9a92fSRobert Love struct fc_lport *); 59942e9a92fSRobert Love 60042e9a92fSRobert Love /* 60142e9a92fSRobert Love * Stop discovery for a given lport. This will remove 60242e9a92fSRobert Love * all discovered rports 6030ae4d4aeSRobert Love * 6040ae4d4aeSRobert Love * STATUS: OPTIONAL 60542e9a92fSRobert Love */ 60642e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 60742e9a92fSRobert Love 60842e9a92fSRobert Love /* 60942e9a92fSRobert Love * Stop discovery for a given lport. This will block 61042e9a92fSRobert Love * until all discovered rports are deleted from the 61142e9a92fSRobert Love * FC transport class 6120ae4d4aeSRobert Love * 6130ae4d4aeSRobert Love * STATUS: OPTIONAL 61442e9a92fSRobert Love */ 61542e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 61642e9a92fSRobert Love }; 61742e9a92fSRobert Love 61842e9a92fSRobert Love /* information used by the discovery layer */ 61942e9a92fSRobert Love struct fc_disc { 62042e9a92fSRobert Love unsigned char retry_count; 62142e9a92fSRobert Love unsigned char pending; 62242e9a92fSRobert Love unsigned char requested; 62342e9a92fSRobert Love unsigned short seq_count; 62442e9a92fSRobert Love unsigned char buf_len; 6250f6c6149SJoe Eykholt u16 disc_id; 62642e9a92fSRobert Love 62742e9a92fSRobert Love void (*disc_callback)(struct fc_lport *, 62842e9a92fSRobert Love enum fc_disc_event); 62942e9a92fSRobert Love 63042e9a92fSRobert Love struct list_head rports; 63142e9a92fSRobert Love struct fc_lport *lport; 63242e9a92fSRobert Love struct mutex disc_mutex; 63342e9a92fSRobert Love struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ 63442e9a92fSRobert Love struct delayed_work disc_work; 63542e9a92fSRobert Love }; 63642e9a92fSRobert Love 63742e9a92fSRobert Love struct fc_lport { 63842e9a92fSRobert Love struct list_head list; 63942e9a92fSRobert Love 64042e9a92fSRobert Love /* Associations */ 64142e9a92fSRobert Love struct Scsi_Host *host; 64296316099SVasu Dev struct list_head ema_list; 643174e1ebfSChris Leech struct list_head vports; /* child vports if N_Port */ 644174e1ebfSChris Leech struct fc_vport *vport; /* parent vport if VN_Port */ 6459fb9d328SJoe Eykholt struct fc_rport_priv *dns_rp; 6469fb9d328SJoe Eykholt struct fc_rport_priv *ptp_rp; 64742e9a92fSRobert Love void *scsi_priv; 64842e9a92fSRobert Love struct fc_disc disc; 64942e9a92fSRobert Love 65042e9a92fSRobert Love /* Operational Information */ 65142e9a92fSRobert Love struct libfc_function_template tt; 652bc0e17f6SVasu Dev u8 link_up; 653bc0e17f6SVasu Dev u8 qfull; 65442e9a92fSRobert Love enum fc_lport_state state; 65542e9a92fSRobert Love unsigned long boot_time; 65642e9a92fSRobert Love 65742e9a92fSRobert Love struct fc_host_statistics host_stats; 658582b45bcSRobert Love struct fcoe_dev_stats *dev_stats; 659582b45bcSRobert Love 66042e9a92fSRobert Love u64 wwpn; 66142e9a92fSRobert Love u64 wwnn; 66242e9a92fSRobert Love u8 retry_count; 66342e9a92fSRobert Love 66442e9a92fSRobert Love /* Capabilities */ 66542e9a92fSRobert Love u32 sg_supp:1; /* scatter gather supported */ 66642e9a92fSRobert Love u32 seq_offload:1; /* seq offload supported */ 66742e9a92fSRobert Love u32 crc_offload:1; /* crc offload supported */ 66842e9a92fSRobert Love u32 lro_enabled:1; /* large receive offload */ 669174e1ebfSChris Leech u32 does_npiv:1; /* supports multiple vports */ 670174e1ebfSChris Leech u32 npiv_enabled:1; /* switch/fabric allows NPIV */ 67142e9a92fSRobert Love u32 mfs; /* max FC payload size */ 67242e9a92fSRobert Love unsigned int service_params; 67342e9a92fSRobert Love unsigned int e_d_tov; 67442e9a92fSRobert Love unsigned int r_a_tov; 67542e9a92fSRobert Love u8 max_retry_count; 676a3666955SAbhijeet Joglekar u8 max_rport_retry_count; 67742e9a92fSRobert Love u16 link_speed; 67842e9a92fSRobert Love u16 link_supported_speeds; 67942e9a92fSRobert Love u16 lro_xid; /* max xid for fcoe lro */ 680ea1e9a9dSYi Zou unsigned int lso_max; /* max large send size */ 68142e9a92fSRobert Love struct fc_ns_fts fcts; /* FC-4 type masks */ 68242e9a92fSRobert Love struct fc_els_rnid_gen rnid_gen; /* RNID information */ 68342e9a92fSRobert Love 68442e9a92fSRobert Love /* Semaphores */ 68542e9a92fSRobert Love struct mutex lp_mutex; 68642e9a92fSRobert Love 68742e9a92fSRobert Love /* Miscellaneous */ 68842e9a92fSRobert Love struct delayed_work retry_work; 68942e9a92fSRobert Love }; 69042e9a92fSRobert Love 69134f42a07SRobert Love /* 69242e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 69342e9a92fSRobert Love *****************************/ 69442e9a92fSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lp) 69542e9a92fSRobert Love { 69642e9a92fSRobert Love return lp->state == LPORT_ST_READY; 69742e9a92fSRobert Love } 69842e9a92fSRobert Love 69942e9a92fSRobert Love static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) 70042e9a92fSRobert Love { 70142e9a92fSRobert Love lp->wwnn = wwnn; 70242e9a92fSRobert Love } 70342e9a92fSRobert Love 70442e9a92fSRobert Love static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) 70542e9a92fSRobert Love { 70642e9a92fSRobert Love lp->wwpn = wwnn; 70742e9a92fSRobert Love } 70842e9a92fSRobert Love 70942e9a92fSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lp, 71042e9a92fSRobert Love enum fc_lport_state state) 71142e9a92fSRobert Love { 71242e9a92fSRobert Love if (state != lp->state) 71342e9a92fSRobert Love lp->retry_count = 0; 71442e9a92fSRobert Love lp->state = state; 71542e9a92fSRobert Love } 71642e9a92fSRobert Love 717582b45bcSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lp) 718582b45bcSRobert Love { 719582b45bcSRobert Love /* allocate per cpu stats block */ 720582b45bcSRobert Love lp->dev_stats = alloc_percpu(struct fcoe_dev_stats); 721582b45bcSRobert Love if (!lp->dev_stats) 722582b45bcSRobert Love return -ENOMEM; 723582b45bcSRobert Love return 0; 724582b45bcSRobert Love } 725582b45bcSRobert Love 726582b45bcSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lp) 727582b45bcSRobert Love { 728582b45bcSRobert Love free_percpu(lp->dev_stats); 729582b45bcSRobert Love } 730582b45bcSRobert Love 731582b45bcSRobert Love static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp) 732582b45bcSRobert Love { 733582b45bcSRobert Love return per_cpu_ptr(lp->dev_stats, smp_processor_id()); 734582b45bcSRobert Love } 735582b45bcSRobert Love 736a0a25da2SVasu Dev static inline void *lport_priv(const struct fc_lport *lp) 737a0a25da2SVasu Dev { 738a0a25da2SVasu Dev return (void *)(lp + 1); 739a0a25da2SVasu Dev } 740a0a25da2SVasu Dev 741a0a25da2SVasu Dev /** 742a0a25da2SVasu Dev * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport 743a0a25da2SVasu Dev * @sht: ptr to the scsi host templ 744a0a25da2SVasu Dev * @priv_size: size of private data after fc_lport 745a0a25da2SVasu Dev * 74686221969SChris Leech * Returns: libfc lport 747a0a25da2SVasu Dev */ 74886221969SChris Leech static inline struct fc_lport * 749a0a25da2SVasu Dev libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 750a0a25da2SVasu Dev { 75186221969SChris Leech struct fc_lport *lport; 75286221969SChris Leech struct Scsi_Host *shost; 75386221969SChris Leech 75486221969SChris Leech shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 75586221969SChris Leech if (!shost) 75686221969SChris Leech return NULL; 75786221969SChris Leech lport = shost_priv(shost); 75886221969SChris Leech lport->host = shost; 75986221969SChris Leech INIT_LIST_HEAD(&lport->ema_list); 760174e1ebfSChris Leech INIT_LIST_HEAD(&lport->vports); 76186221969SChris Leech return lport; 762a0a25da2SVasu Dev } 76342e9a92fSRobert Love 76434f42a07SRobert Love /* 76542e9a92fSRobert Love * LOCAL PORT LAYER 76642e9a92fSRobert Love *****************************/ 76742e9a92fSRobert Love int fc_lport_init(struct fc_lport *lp); 76842e9a92fSRobert Love 76942e9a92fSRobert Love /* 77042e9a92fSRobert Love * Destroy the specified local port by finding and freeing all 77142e9a92fSRobert Love * fc_rports associated with it and then by freeing the fc_lport 77242e9a92fSRobert Love * itself. 77342e9a92fSRobert Love */ 77442e9a92fSRobert Love int fc_lport_destroy(struct fc_lport *lp); 77542e9a92fSRobert Love 77642e9a92fSRobert Love /* 77742e9a92fSRobert Love * Logout the specified local port from the fabric 77842e9a92fSRobert Love */ 77942e9a92fSRobert Love int fc_fabric_logoff(struct fc_lport *lp); 78042e9a92fSRobert Love 78142e9a92fSRobert Love /* 78242e9a92fSRobert Love * Initiate the LP state machine. This handler will use fc_host_attr 78342e9a92fSRobert Love * to store the FLOGI service parameters, so fc_host_attr must be 78442e9a92fSRobert Love * initialized before calling this handler. 78542e9a92fSRobert Love */ 78642e9a92fSRobert Love int fc_fabric_login(struct fc_lport *lp); 78742e9a92fSRobert Love 78842e9a92fSRobert Love /* 78942e9a92fSRobert Love * The link is up for the given local port. 79042e9a92fSRobert Love */ 7918faecddbSChris Leech void __fc_linkup(struct fc_lport *); 79242e9a92fSRobert Love void fc_linkup(struct fc_lport *); 79342e9a92fSRobert Love 79442e9a92fSRobert Love /* 79542e9a92fSRobert Love * Link is down for the given local port. 79642e9a92fSRobert Love */ 7978faecddbSChris Leech void __fc_linkdown(struct fc_lport *); 79842e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 79942e9a92fSRobert Love 80042e9a92fSRobert Love /* 80142e9a92fSRobert Love * Configure the local port. 80242e9a92fSRobert Love */ 80342e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 80442e9a92fSRobert Love 80542e9a92fSRobert Love /* 80642e9a92fSRobert Love * Reset the local port. 80742e9a92fSRobert Love */ 80842e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 80942e9a92fSRobert Love 81042e9a92fSRobert Love /* 81142e9a92fSRobert Love * Set the mfs or reset 81242e9a92fSRobert Love */ 81342e9a92fSRobert Love int fc_set_mfs(struct fc_lport *lp, u32 mfs); 81442e9a92fSRobert Love 815174e1ebfSChris Leech /* 816174e1ebfSChris Leech * Allocate a new lport struct for an NPIV VN_Port 817174e1ebfSChris Leech */ 818174e1ebfSChris Leech struct fc_lport *libfc_vport_create(struct fc_vport *vport, int privsize); 819174e1ebfSChris Leech 820174e1ebfSChris Leech /* 821174e1ebfSChris Leech * Find an NPIV VN_Port by port ID 822174e1ebfSChris Leech */ 823174e1ebfSChris Leech struct fc_lport *fc_vport_id_lookup(struct fc_lport *n_port, u32 port_id); 82442e9a92fSRobert Love 82534f42a07SRobert Love /* 8268faecddbSChris Leech * NPIV VN_Port link state management 8278faecddbSChris Leech */ 8288faecddbSChris Leech void fc_vport_setlink(struct fc_lport *vn_port); 8298faecddbSChris Leech void fc_vports_linkchange(struct fc_lport *n_port); 8308faecddbSChris Leech 8318faecddbSChris Leech /* 83242e9a92fSRobert Love * REMOTE PORT LAYER 83342e9a92fSRobert Love *****************************/ 83442e9a92fSRobert Love int fc_rport_init(struct fc_lport *lp); 83542e9a92fSRobert Love void fc_rport_terminate_io(struct fc_rport *rp); 83642e9a92fSRobert Love 83734f42a07SRobert Love /* 83842e9a92fSRobert Love * DISCOVERY LAYER 83942e9a92fSRobert Love *****************************/ 84042e9a92fSRobert Love int fc_disc_init(struct fc_lport *lp); 84142e9a92fSRobert Love 84242e9a92fSRobert Love 84334f42a07SRobert Love /* 84442e9a92fSRobert Love * SCSI LAYER 84542e9a92fSRobert Love *****************************/ 84642e9a92fSRobert Love /* 84742e9a92fSRobert Love * Initialize the SCSI block of libfc 84842e9a92fSRobert Love */ 84942e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 85042e9a92fSRobert Love 85142e9a92fSRobert Love /* 85242e9a92fSRobert Love * This section provides an API which allows direct interaction 85342e9a92fSRobert Love * with the SCSI-ml. Each of these functions satisfies a function 85442e9a92fSRobert Love * pointer defined in Scsi_Host and therefore is always called 85542e9a92fSRobert Love * directly from the SCSI-ml. 85642e9a92fSRobert Love */ 85742e9a92fSRobert Love int fc_queuecommand(struct scsi_cmnd *sc_cmd, 85842e9a92fSRobert Love void (*done)(struct scsi_cmnd *)); 85942e9a92fSRobert Love 86042e9a92fSRobert Love /* 86142e9a92fSRobert Love * Send an ABTS frame to the target device. The sc_cmd argument 86242e9a92fSRobert Love * is a pointer to the SCSI command to be aborted. 86342e9a92fSRobert Love */ 86442e9a92fSRobert Love int fc_eh_abort(struct scsi_cmnd *sc_cmd); 86542e9a92fSRobert Love 86642e9a92fSRobert Love /* 86742e9a92fSRobert Love * Reset a LUN by sending send the tm cmd to the target. 86842e9a92fSRobert Love */ 86942e9a92fSRobert Love int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); 87042e9a92fSRobert Love 87142e9a92fSRobert Love /* 87242e9a92fSRobert Love * Reset the host adapter. 87342e9a92fSRobert Love */ 87442e9a92fSRobert Love int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); 87542e9a92fSRobert Love 87642e9a92fSRobert Love /* 87742e9a92fSRobert Love * Check rport status. 87842e9a92fSRobert Love */ 87942e9a92fSRobert Love int fc_slave_alloc(struct scsi_device *sdev); 88042e9a92fSRobert Love 88142e9a92fSRobert Love /* 88242e9a92fSRobert Love * Adjust the queue depth. 88342e9a92fSRobert Love */ 884e881a172SMike Christie int fc_change_queue_depth(struct scsi_device *sdev, int qdepth, int reason); 88542e9a92fSRobert Love 88642e9a92fSRobert Love /* 88742e9a92fSRobert Love * Change the tag type. 88842e9a92fSRobert Love */ 88942e9a92fSRobert Love int fc_change_queue_type(struct scsi_device *sdev, int tag_type); 89042e9a92fSRobert Love 89142e9a92fSRobert Love /* 89242e9a92fSRobert Love * Free memory pools used by the FCP layer. 89342e9a92fSRobert Love */ 89442e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 89542e9a92fSRobert Love 89634f42a07SRobert Love /* 89742e9a92fSRobert Love * ELS/CT interface 89842e9a92fSRobert Love *****************************/ 89942e9a92fSRobert Love /* 90042e9a92fSRobert Love * Initializes ELS/CT interface 90142e9a92fSRobert Love */ 90242e9a92fSRobert Love int fc_elsct_init(struct fc_lport *lp); 90311b56188SChris Leech struct fc_seq *fc_elsct_send(struct fc_lport *lport, 90411b56188SChris Leech u32 did, 90511b56188SChris Leech struct fc_frame *fp, 90611b56188SChris Leech unsigned int op, 90711b56188SChris Leech void (*resp)(struct fc_seq *, 90811b56188SChris Leech struct fc_frame *fp, 90911b56188SChris Leech void *arg), 91011b56188SChris Leech void *arg, u32 timer_msec); 91111b56188SChris Leech void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 91211b56188SChris Leech void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 91342e9a92fSRobert Love 91442e9a92fSRobert Love 91534f42a07SRobert Love /* 91642e9a92fSRobert Love * EXCHANGE MANAGER LAYER 91742e9a92fSRobert Love *****************************/ 91842e9a92fSRobert Love /* 91942e9a92fSRobert Love * Initializes Exchange Manager related 92042e9a92fSRobert Love * function pointers in struct libfc_function_template. 92142e9a92fSRobert Love */ 92242e9a92fSRobert Love int fc_exch_init(struct fc_lport *lp); 92342e9a92fSRobert Love 92442e9a92fSRobert Love /* 92596316099SVasu Dev * Adds Exchange Manager (EM) mp to lport. 92696316099SVasu Dev * 92796316099SVasu Dev * Adds specified mp to lport using struct fc_exch_mgr_anchor, 92896316099SVasu Dev * the struct fc_exch_mgr_anchor allows same EM sharing by 92996316099SVasu Dev * more than one lport with their specified match function, 93096316099SVasu Dev * the match function is used in allocating exchange from 93196316099SVasu Dev * added mp. 93296316099SVasu Dev */ 93396316099SVasu Dev struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport, 93496316099SVasu Dev struct fc_exch_mgr *mp, 93596316099SVasu Dev bool (*match)(struct fc_frame *)); 93696316099SVasu Dev 93796316099SVasu Dev /* 93896316099SVasu Dev * Deletes Exchange Manager (EM) from lport by removing 93996316099SVasu Dev * its anchor ema from lport. 94096316099SVasu Dev * 94196316099SVasu Dev * If removed anchor ema was the last user of its associated EM 94296316099SVasu Dev * then also destroys associated EM. 94396316099SVasu Dev */ 94496316099SVasu Dev void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema); 94596316099SVasu Dev 94696316099SVasu Dev /* 947174e1ebfSChris Leech * Clone an exchange manager list, getting reference holds for each EM. 948174e1ebfSChris Leech * This is for use with NPIV and sharing the X_ID space between VN_Ports. 949174e1ebfSChris Leech */ 950174e1ebfSChris Leech int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 951174e1ebfSChris Leech 952174e1ebfSChris Leech /* 95342e9a92fSRobert Love * Allocates an Exchange Manager (EM). 95442e9a92fSRobert Love * 95542e9a92fSRobert Love * The EM manages exchanges for their allocation and 95642e9a92fSRobert Love * free, also allows exchange lookup for received 95742e9a92fSRobert Love * frame. 95842e9a92fSRobert Love * 95942e9a92fSRobert Love * The class is used for initializing FC class of 96042e9a92fSRobert Love * allocated exchange from EM. 96142e9a92fSRobert Love * 96242e9a92fSRobert Love * The min_xid and max_xid will limit new 96342e9a92fSRobert Love * exchange ID (XID) within this range for 96442e9a92fSRobert Love * a new exchange. 96542e9a92fSRobert Love * The LLD may choose to have multiple EMs, 96642e9a92fSRobert Love * e.g. one EM instance per CPU receive thread in LLD. 96742e9a92fSRobert Love * 96852ff878cSVasu Dev * Specified match function is used in allocating exchanges 96952ff878cSVasu Dev * from newly allocated EM. 97042e9a92fSRobert Love */ 97142e9a92fSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, 97242e9a92fSRobert Love enum fc_class class, 97342e9a92fSRobert Love u16 min_xid, 97452ff878cSVasu Dev u16 max_xid, 97552ff878cSVasu Dev bool (*match)(struct fc_frame *)); 97642e9a92fSRobert Love 97742e9a92fSRobert Love /* 97852ff878cSVasu Dev * Free all exchange managers of a lport. 97942e9a92fSRobert Love */ 98052ff878cSVasu Dev void fc_exch_mgr_free(struct fc_lport *lport); 98142e9a92fSRobert Love 98242e9a92fSRobert Love /* 98342e9a92fSRobert Love * Receive a frame on specified local port and exchange manager. 98442e9a92fSRobert Love */ 98552ff878cSVasu Dev void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp); 98642e9a92fSRobert Love 98742e9a92fSRobert Love /* 988b2f0091fSVasu Dev * Reset all EMs of a lport, releasing its all sequences and 989b2f0091fSVasu Dev * exchanges. If sid is non-zero, then reset only exchanges 990b2f0091fSVasu Dev * we sourced from that FID. If did is non-zero, reset only 991b2f0091fSVasu Dev * exchanges destined to that FID. 99242e9a92fSRobert Love */ 9931f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 99442e9a92fSRobert Love 99542e9a92fSRobert Love /* 99642e9a92fSRobert Love * Functions for fc_functions_template 99742e9a92fSRobert Love */ 99842e9a92fSRobert Love void fc_get_host_speed(struct Scsi_Host *shost); 99942e9a92fSRobert Love void fc_get_host_port_type(struct Scsi_Host *shost); 100042e9a92fSRobert Love void fc_get_host_port_state(struct Scsi_Host *shost); 100142e9a92fSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); 100242e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 100342e9a92fSRobert Love 100442e9a92fSRobert Love #endif /* _LIBFC_H_ */ 1005