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> 2542e9a92fSRobert Love 2642e9a92fSRobert Love #include <scsi/scsi_transport.h> 2742e9a92fSRobert Love #include <scsi/scsi_transport_fc.h> 2842e9a92fSRobert Love 2942e9a92fSRobert Love #include <scsi/fc/fc_fcp.h> 3042e9a92fSRobert Love #include <scsi/fc/fc_ns.h> 3142e9a92fSRobert Love #include <scsi/fc/fc_els.h> 3242e9a92fSRobert Love #include <scsi/fc/fc_gs.h> 3342e9a92fSRobert Love 3442e9a92fSRobert Love #include <scsi/fc_frame.h> 3542e9a92fSRobert Love 3642e9a92fSRobert Love #define LIBFC_DEBUG 3742e9a92fSRobert Love 3842e9a92fSRobert Love #ifdef LIBFC_DEBUG 3942e9a92fSRobert Love /* Log messages */ 4042e9a92fSRobert Love #define FC_DBG(fmt, args...) \ 4142e9a92fSRobert Love do { \ 4242e9a92fSRobert Love printk(KERN_INFO "%s " fmt, __func__, ##args); \ 4342e9a92fSRobert Love } while (0) 4442e9a92fSRobert Love #else 4542e9a92fSRobert Love #define FC_DBG(fmt, args...) 4642e9a92fSRobert Love #endif 4742e9a92fSRobert Love 4842e9a92fSRobert Love /* 4942e9a92fSRobert Love * libfc error codes 5042e9a92fSRobert Love */ 5142e9a92fSRobert Love #define FC_NO_ERR 0 /* no error */ 5242e9a92fSRobert Love #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 5342e9a92fSRobert Love #define FC_EX_CLOSED 2 /* Exchange closed */ 5442e9a92fSRobert Love 5542e9a92fSRobert Love /* some helpful macros */ 5642e9a92fSRobert Love 5742e9a92fSRobert Love #define ntohll(x) be64_to_cpu(x) 5842e9a92fSRobert Love #define htonll(x) cpu_to_be64(x) 5942e9a92fSRobert Love 6042e9a92fSRobert Love #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 6142e9a92fSRobert Love 6242e9a92fSRobert Love #define hton24(p, v) do { \ 6342e9a92fSRobert Love p[0] = (((v) >> 16) & 0xFF); \ 6442e9a92fSRobert Love p[1] = (((v) >> 8) & 0xFF); \ 6542e9a92fSRobert Love p[2] = ((v) & 0xFF); \ 6642e9a92fSRobert Love } while (0) 6742e9a92fSRobert Love 6842e9a92fSRobert Love /* 6942e9a92fSRobert Love * FC HBA status 7042e9a92fSRobert Love */ 7142e9a92fSRobert Love enum fc_lport_state { 7242e9a92fSRobert Love LPORT_ST_NONE = 0, 7342e9a92fSRobert Love LPORT_ST_FLOGI, 7442e9a92fSRobert Love LPORT_ST_DNS, 7542e9a92fSRobert Love LPORT_ST_RPN_ID, 7642e9a92fSRobert Love LPORT_ST_RFT_ID, 7742e9a92fSRobert Love LPORT_ST_SCR, 7842e9a92fSRobert Love LPORT_ST_READY, 7942e9a92fSRobert Love LPORT_ST_LOGO, 8042e9a92fSRobert Love LPORT_ST_RESET 8142e9a92fSRobert Love }; 8242e9a92fSRobert Love 8342e9a92fSRobert Love enum fc_disc_event { 8442e9a92fSRobert Love DISC_EV_NONE = 0, 8542e9a92fSRobert Love DISC_EV_SUCCESS, 8642e9a92fSRobert Love DISC_EV_FAILED 8742e9a92fSRobert Love }; 8842e9a92fSRobert Love 8942e9a92fSRobert Love enum fc_rport_state { 9042e9a92fSRobert Love RPORT_ST_NONE = 0, 9142e9a92fSRobert Love RPORT_ST_INIT, /* initialized */ 9242e9a92fSRobert Love RPORT_ST_PLOGI, /* waiting for PLOGI completion */ 9342e9a92fSRobert Love RPORT_ST_PRLI, /* waiting for PRLI completion */ 9442e9a92fSRobert Love RPORT_ST_RTV, /* waiting for RTV completion */ 9542e9a92fSRobert Love RPORT_ST_READY, /* ready for use */ 9642e9a92fSRobert Love RPORT_ST_LOGO, /* port logout sent */ 9742e9a92fSRobert Love }; 9842e9a92fSRobert Love 9942e9a92fSRobert Love enum fc_rport_trans_state { 10042e9a92fSRobert Love FC_PORTSTATE_ROGUE, 10142e9a92fSRobert Love FC_PORTSTATE_REAL, 10242e9a92fSRobert Love }; 10342e9a92fSRobert Love 10442e9a92fSRobert Love /** 10542e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 10642e9a92fSRobert Love * @lp: Fibre Channel host port instance 10742e9a92fSRobert Love * @peers: node for list management during discovery and RSCN processing 10842e9a92fSRobert Love * @ids: identifiers structure to pass to fc_remote_port_add() 10942e9a92fSRobert Love * @rport_work: work struct for starting the rport state machine 11042e9a92fSRobert Love */ 11142e9a92fSRobert Love struct fc_disc_port { 11242e9a92fSRobert Love struct fc_lport *lp; 11342e9a92fSRobert Love struct list_head peers; 11442e9a92fSRobert Love struct fc_rport_identifiers ids; 11542e9a92fSRobert Love struct work_struct rport_work; 11642e9a92fSRobert Love }; 11742e9a92fSRobert Love 11842e9a92fSRobert Love enum fc_rport_event { 11942e9a92fSRobert Love RPORT_EV_NONE = 0, 12042e9a92fSRobert Love RPORT_EV_CREATED, 12142e9a92fSRobert Love RPORT_EV_FAILED, 12242e9a92fSRobert Love RPORT_EV_STOP, 12342e9a92fSRobert Love RPORT_EV_LOGO 12442e9a92fSRobert Love }; 12542e9a92fSRobert Love 12642e9a92fSRobert Love struct fc_rport_operations { 12742e9a92fSRobert Love void (*event_callback)(struct fc_lport *, struct fc_rport *, 12842e9a92fSRobert Love enum fc_rport_event); 12942e9a92fSRobert Love }; 13042e9a92fSRobert Love 13142e9a92fSRobert Love /** 13242e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 13342e9a92fSRobert Love * @local_port: Fibre Channel host port instance 13442e9a92fSRobert Love * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges 13542e9a92fSRobert Love * @flags: REC and RETRY supported flags 13642e9a92fSRobert Love * @max_seq: maximum number of concurrent sequences 13742e9a92fSRobert Love * @retries: retry count in current state 13842e9a92fSRobert Love * @e_d_tov: error detect timeout value (in msec) 13942e9a92fSRobert Love * @r_a_tov: resource allocation timeout value (in msec) 14042e9a92fSRobert Love * @rp_mutex: mutex protects rport 14142e9a92fSRobert Love * @retry_work: 14242e9a92fSRobert Love * @event_callback: Callback for rport READY, FAILED or LOGO 14342e9a92fSRobert Love */ 14442e9a92fSRobert Love struct fc_rport_libfc_priv { 14542e9a92fSRobert Love struct fc_lport *local_port; 14642e9a92fSRobert Love enum fc_rport_state rp_state; 14742e9a92fSRobert Love u16 flags; 14842e9a92fSRobert Love #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 14942e9a92fSRobert Love #define FC_RP_FLAGS_RETRY (1 << 1) 15042e9a92fSRobert Love u16 max_seq; 15142e9a92fSRobert Love unsigned int retries; 15242e9a92fSRobert Love unsigned int e_d_tov; 15342e9a92fSRobert Love unsigned int r_a_tov; 15442e9a92fSRobert Love enum fc_rport_trans_state trans_state; 15542e9a92fSRobert Love struct mutex rp_mutex; 15642e9a92fSRobert Love struct delayed_work retry_work; 15742e9a92fSRobert Love enum fc_rport_event event; 15842e9a92fSRobert Love struct fc_rport_operations *ops; 15942e9a92fSRobert Love struct list_head peers; 16042e9a92fSRobert Love struct work_struct event_work; 16142e9a92fSRobert Love }; 16242e9a92fSRobert Love 16342e9a92fSRobert Love #define PRIV_TO_RPORT(x) \ 16442e9a92fSRobert Love (struct fc_rport *)((void *)x - sizeof(struct fc_rport)); 16542e9a92fSRobert Love #define RPORT_TO_PRIV(x) \ 16642e9a92fSRobert Love (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport)); 16742e9a92fSRobert Love 16842e9a92fSRobert Love struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *); 16942e9a92fSRobert Love 17042e9a92fSRobert Love static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn) 17142e9a92fSRobert Love { 17242e9a92fSRobert Love rport->node_name = wwnn; 17342e9a92fSRobert Love rport->port_name = wwpn; 17442e9a92fSRobert Love } 17542e9a92fSRobert Love 17642e9a92fSRobert Love /* 17742e9a92fSRobert Love * fcoe stats structure 17842e9a92fSRobert Love */ 17942e9a92fSRobert Love struct fcoe_dev_stats { 18042e9a92fSRobert Love u64 SecondsSinceLastReset; 18142e9a92fSRobert Love u64 TxFrames; 18242e9a92fSRobert Love u64 TxWords; 18342e9a92fSRobert Love u64 RxFrames; 18442e9a92fSRobert Love u64 RxWords; 18542e9a92fSRobert Love u64 ErrorFrames; 18642e9a92fSRobert Love u64 DumpedFrames; 18742e9a92fSRobert Love u64 LinkFailureCount; 18842e9a92fSRobert Love u64 LossOfSignalCount; 18942e9a92fSRobert Love u64 InvalidTxWordCount; 19042e9a92fSRobert Love u64 InvalidCRCCount; 19142e9a92fSRobert Love u64 InputRequests; 19242e9a92fSRobert Love u64 OutputRequests; 19342e9a92fSRobert Love u64 ControlRequests; 19442e9a92fSRobert Love u64 InputMegabytes; 19542e9a92fSRobert Love u64 OutputMegabytes; 19642e9a92fSRobert Love }; 19742e9a92fSRobert Love 19842e9a92fSRobert Love /* 19942e9a92fSRobert Love * els data is used for passing ELS respone specific 20042e9a92fSRobert Love * data to send ELS response mainly using infomation 20142e9a92fSRobert Love * in exchange and sequence in EM layer. 20242e9a92fSRobert Love */ 20342e9a92fSRobert Love struct fc_seq_els_data { 20442e9a92fSRobert Love struct fc_frame *fp; 20542e9a92fSRobert Love enum fc_els_rjt_reason reason; 20642e9a92fSRobert Love enum fc_els_rjt_explan explan; 20742e9a92fSRobert Love }; 20842e9a92fSRobert Love 20942e9a92fSRobert Love /* 21042e9a92fSRobert Love * FCP request structure, one for each scsi cmd request 21142e9a92fSRobert Love */ 21242e9a92fSRobert Love struct fc_fcp_pkt { 21342e9a92fSRobert Love /* 21442e9a92fSRobert Love * housekeeping stuff 21542e9a92fSRobert Love */ 21642e9a92fSRobert Love struct fc_lport *lp; /* handle to hba struct */ 21742e9a92fSRobert Love u16 state; /* scsi_pkt state state */ 21842e9a92fSRobert Love u16 tgt_flags; /* target flags */ 21942e9a92fSRobert Love atomic_t ref_cnt; /* fcp pkt ref count */ 22042e9a92fSRobert Love spinlock_t scsi_pkt_lock; /* Must be taken before the host lock 22142e9a92fSRobert Love * if both are held at the same time */ 22242e9a92fSRobert Love /* 22342e9a92fSRobert Love * SCSI I/O related stuff 22442e9a92fSRobert Love */ 22542e9a92fSRobert Love struct scsi_cmnd *cmd; /* scsi command pointer. set/clear 22642e9a92fSRobert Love * under host lock */ 22742e9a92fSRobert Love struct list_head list; /* tracks queued commands. access under 22842e9a92fSRobert Love * host lock */ 22942e9a92fSRobert Love /* 23042e9a92fSRobert Love * timeout related stuff 23142e9a92fSRobert Love */ 23242e9a92fSRobert Love struct timer_list timer; /* command timer */ 23342e9a92fSRobert Love struct completion tm_done; 23442e9a92fSRobert Love int wait_for_comp; 23542e9a92fSRobert Love unsigned long start_time; /* start jiffie */ 23642e9a92fSRobert Love unsigned long end_time; /* end jiffie */ 23742e9a92fSRobert Love unsigned long last_pkt_time; /* jiffies of last frame received */ 23842e9a92fSRobert Love 23942e9a92fSRobert Love /* 24042e9a92fSRobert Love * scsi cmd and data transfer information 24142e9a92fSRobert Love */ 24242e9a92fSRobert Love u32 data_len; 24342e9a92fSRobert Love /* 24442e9a92fSRobert Love * transport related veriables 24542e9a92fSRobert Love */ 24642e9a92fSRobert Love struct fcp_cmnd cdb_cmd; 24742e9a92fSRobert Love size_t xfer_len; 24842e9a92fSRobert Love u32 xfer_contig_end; /* offset of end of contiguous xfer */ 24942e9a92fSRobert Love u16 max_payload; /* max payload size in bytes */ 25042e9a92fSRobert Love 25142e9a92fSRobert Love /* 25242e9a92fSRobert Love * scsi/fcp return status 25342e9a92fSRobert Love */ 25442e9a92fSRobert Love u32 io_status; /* SCSI result upper 24 bits */ 25542e9a92fSRobert Love u8 cdb_status; 25642e9a92fSRobert Love u8 status_code; /* FCP I/O status */ 25742e9a92fSRobert Love /* bit 3 Underrun bit 2: overrun */ 25842e9a92fSRobert Love u8 scsi_comp_flags; 25942e9a92fSRobert Love u32 req_flags; /* bit 0: read bit:1 write */ 26042e9a92fSRobert Love u32 scsi_resid; /* residule length */ 26142e9a92fSRobert Love 26242e9a92fSRobert Love struct fc_rport *rport; /* remote port pointer */ 26342e9a92fSRobert Love struct fc_seq *seq_ptr; /* current sequence pointer */ 26442e9a92fSRobert Love /* 26542e9a92fSRobert Love * Error Processing 26642e9a92fSRobert Love */ 26742e9a92fSRobert Love u8 recov_retry; /* count of recovery retries */ 26842e9a92fSRobert Love struct fc_seq *recov_seq; /* sequence for REC or SRR */ 26942e9a92fSRobert Love }; 27042e9a92fSRobert Love 27142e9a92fSRobert Love /* 27242e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 27342e9a92fSRobert Love * and Sequences 27442e9a92fSRobert Love * 27542e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 27642e9a92fSRobert Love * 27742e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 27842e9a92fSRobert Love */ 27942e9a92fSRobert Love 28042e9a92fSRobert Love struct fc_exch_mgr; 28142e9a92fSRobert Love 28242e9a92fSRobert Love /* 28342e9a92fSRobert Love * Sequence. 28442e9a92fSRobert Love */ 28542e9a92fSRobert Love struct fc_seq { 28642e9a92fSRobert Love u8 id; /* seq ID */ 28742e9a92fSRobert Love u16 ssb_stat; /* status flags for sequence status block */ 28842e9a92fSRobert Love u16 cnt; /* frames sent so far on sequence */ 28942e9a92fSRobert Love u32 rec_data; /* FC-4 value for REC */ 29042e9a92fSRobert Love }; 29142e9a92fSRobert Love 29242e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 29342e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 29442e9a92fSRobert Love 29542e9a92fSRobert Love /* 29642e9a92fSRobert Love * Exchange. 29742e9a92fSRobert Love * 29842e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 29942e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 30042e9a92fSRobert Love * seq_id 30142e9a92fSRobert Love * sequence allocation 30242e9a92fSRobert Love */ 30342e9a92fSRobert Love struct fc_exch { 30442e9a92fSRobert Love struct fc_exch_mgr *em; /* exchange manager */ 30542e9a92fSRobert Love u32 state; /* internal driver state */ 30642e9a92fSRobert Love u16 xid; /* our exchange ID */ 30742e9a92fSRobert Love struct list_head ex_list; /* free or busy list linkage */ 30842e9a92fSRobert Love spinlock_t ex_lock; /* lock covering exchange state */ 30942e9a92fSRobert Love atomic_t ex_refcnt; /* reference counter */ 31042e9a92fSRobert Love struct delayed_work timeout_work; /* timer for upper level protocols */ 31142e9a92fSRobert Love struct fc_lport *lp; /* fc device instance */ 31242e9a92fSRobert Love u16 oxid; /* originator's exchange ID */ 31342e9a92fSRobert Love u16 rxid; /* responder's exchange ID */ 31442e9a92fSRobert Love u32 oid; /* originator's FCID */ 31542e9a92fSRobert Love u32 sid; /* source FCID */ 31642e9a92fSRobert Love u32 did; /* destination FCID */ 31742e9a92fSRobert Love u32 esb_stat; /* exchange status for ESB */ 31842e9a92fSRobert Love u32 r_a_tov; /* r_a_tov from rport (msec) */ 31942e9a92fSRobert Love u8 seq_id; /* next sequence ID to use */ 32042e9a92fSRobert Love u32 f_ctl; /* F_CTL flags for sequences */ 32142e9a92fSRobert Love u8 fh_type; /* frame type */ 32242e9a92fSRobert Love enum fc_class class; /* class of service */ 32342e9a92fSRobert Love struct fc_seq seq; /* single sequence */ 32442e9a92fSRobert Love /* 32542e9a92fSRobert Love * Handler for responses to this current exchange. 32642e9a92fSRobert Love */ 32742e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 32842e9a92fSRobert Love void (*destructor)(struct fc_seq *, void *); 32942e9a92fSRobert Love /* 33042e9a92fSRobert Love * arg is passed as void pointer to exchange 33142e9a92fSRobert Love * resp and destructor handlers 33242e9a92fSRobert Love */ 33342e9a92fSRobert Love void *arg; 33442e9a92fSRobert Love }; 33542e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 33642e9a92fSRobert Love 33742e9a92fSRobert Love struct libfc_function_template { 33842e9a92fSRobert Love 33942e9a92fSRobert Love /* 34042e9a92fSRobert Love * Interface to send a FC frame 3410ae4d4aeSRobert Love * 3420ae4d4aeSRobert Love * STATUS: REQUIRED 34342e9a92fSRobert Love */ 34442e9a92fSRobert Love int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); 34542e9a92fSRobert Love 34642e9a92fSRobert Love /* 3470ae4d4aeSRobert Love * Interface to send ELS/CT frames 3480ae4d4aeSRobert Love * 3490ae4d4aeSRobert Love * STATUS: OPTIONAL 35042e9a92fSRobert Love */ 35142e9a92fSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *lport, 35242e9a92fSRobert Love struct fc_rport *rport, 35342e9a92fSRobert Love struct fc_frame *fp, 35442e9a92fSRobert Love unsigned int op, 35542e9a92fSRobert Love void (*resp)(struct fc_seq *, 35642e9a92fSRobert Love struct fc_frame *fp, 35742e9a92fSRobert Love void *arg), 35842e9a92fSRobert Love void *arg, u32 timer_msec); 35942e9a92fSRobert Love 36042e9a92fSRobert Love /* 36142e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 36242e9a92fSRobert Love * 36342e9a92fSRobert Love * The frame pointer with some of the header's fields must be 36442e9a92fSRobert Love * filled before calling exch_seq_send(), those fields are, 36542e9a92fSRobert Love * 36642e9a92fSRobert Love * - routing control 36742e9a92fSRobert Love * - FC port did 36842e9a92fSRobert Love * - FC port sid 36942e9a92fSRobert Love * - FC header type 37042e9a92fSRobert Love * - frame control 37142e9a92fSRobert Love * - parameter or relative offset 37242e9a92fSRobert Love * 37342e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 37442e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 37542e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 37642e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 37742e9a92fSRobert Love * as error using IS_ERR related macros. 37842e9a92fSRobert Love * 37942e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 38042e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 38142e9a92fSRobert Love * is about to free, this can be used by caller to free its 38242e9a92fSRobert Love * resources along with exchange free. 38342e9a92fSRobert Love * 38442e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 38542e9a92fSRobert Love * 38642e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 38742e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 38842e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 38942e9a92fSRobert Love * is registered by EM layer. 3900ae4d4aeSRobert Love * 3910ae4d4aeSRobert Love * STATUS: OPTIONAL 39242e9a92fSRobert Love */ 39342e9a92fSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, 39442e9a92fSRobert Love struct fc_frame *fp, 39542e9a92fSRobert Love void (*resp)(struct fc_seq *sp, 39642e9a92fSRobert Love struct fc_frame *fp, 39742e9a92fSRobert Love void *arg), 39842e9a92fSRobert Love void (*destructor)(struct fc_seq *sp, 39942e9a92fSRobert Love void *arg), 40042e9a92fSRobert Love void *arg, unsigned int timer_msec); 40142e9a92fSRobert Love 40242e9a92fSRobert Love /* 4030ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 4040ae4d4aeSRobert Love * 4050ae4d4aeSRobert Love * STATUS: OPTIONAL 40642e9a92fSRobert Love */ 40742e9a92fSRobert Love int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, 40842e9a92fSRobert Love struct fc_frame *fp); 40942e9a92fSRobert Love 41042e9a92fSRobert Love /* 4110ae4d4aeSRobert Love * Send an ELS response using infomation from a previous 4120ae4d4aeSRobert Love * exchange and sequence. 4130ae4d4aeSRobert Love * 4140ae4d4aeSRobert Love * STATUS: OPTIONAL 41542e9a92fSRobert Love */ 41642e9a92fSRobert Love void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, 41742e9a92fSRobert Love struct fc_seq_els_data *els_data); 41842e9a92fSRobert Love 41942e9a92fSRobert Love /* 42042e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 42142e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 42242e9a92fSRobert Love * 42342e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 42442e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 42542e9a92fSRobert Love * will be called with timeout error if no response to abort. 4260ae4d4aeSRobert Love * 4270ae4d4aeSRobert Love * STATUS: OPTIONAL 42842e9a92fSRobert Love */ 42942e9a92fSRobert Love int (*seq_exch_abort)(const struct fc_seq *req_sp, 43042e9a92fSRobert Love unsigned int timer_msec); 43142e9a92fSRobert Love 43242e9a92fSRobert Love /* 43342e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 43442e9a92fSRobert Love * allocated for the related objects may be freed. 4350ae4d4aeSRobert Love * 4360ae4d4aeSRobert Love * STATUS: OPTIONAL 43742e9a92fSRobert Love */ 43842e9a92fSRobert Love void (*exch_done)(struct fc_seq *sp); 43942e9a92fSRobert Love 44042e9a92fSRobert Love /* 44142e9a92fSRobert Love * Assigns a EM and a free XID for an new exchange and then 44242e9a92fSRobert Love * allocates a new exchange and sequence pair. 44342e9a92fSRobert Love * The fp can be used to determine free XID. 4440ae4d4aeSRobert Love * 4450ae4d4aeSRobert Love * STATUS: OPTIONAL 44642e9a92fSRobert Love */ 44742e9a92fSRobert Love struct fc_exch *(*exch_get)(struct fc_lport *lp, struct fc_frame *fp); 44842e9a92fSRobert Love 44942e9a92fSRobert Love /* 45042e9a92fSRobert Love * Release previously assigned XID by exch_get API. 45142e9a92fSRobert Love * The LLD may implement this if XID is assigned by LLD 45242e9a92fSRobert Love * in exch_get(). 4530ae4d4aeSRobert Love * 4540ae4d4aeSRobert Love * STATUS: OPTIONAL 45542e9a92fSRobert Love */ 45642e9a92fSRobert Love void (*exch_put)(struct fc_lport *lp, struct fc_exch_mgr *mp, 45742e9a92fSRobert Love u16 ex_id); 45842e9a92fSRobert Love 45942e9a92fSRobert Love /* 46042e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 4610ae4d4aeSRobert Love * 4620ae4d4aeSRobert Love * STATUS: OPTIONAL 46342e9a92fSRobert Love */ 46442e9a92fSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *sp); 46542e9a92fSRobert Love 46642e9a92fSRobert Love /* 46742e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 46842e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 46942e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 4700ae4d4aeSRobert Love * 4710ae4d4aeSRobert Love * STATUS: OPTIONAL 47242e9a92fSRobert Love */ 4731f6ff364SAbhijeet Joglekar void (*exch_mgr_reset)(struct fc_lport *, 47442e9a92fSRobert Love u32 s_id, u32 d_id); 47542e9a92fSRobert Love 4760ae4d4aeSRobert Love /* 4770ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 4780ae4d4aeSRobert Love * 4790ae4d4aeSRobert Love * STATUS: OPTIONAL 48042e9a92fSRobert Love */ 4810ae4d4aeSRobert Love void (*rport_flush_queue)(void); 48242e9a92fSRobert Love 48342e9a92fSRobert Love /* 4840ae4d4aeSRobert Love * Receive a frame for a local port. 4850ae4d4aeSRobert Love * 4860ae4d4aeSRobert Love * STATUS: OPTIONAL 48742e9a92fSRobert Love */ 48842e9a92fSRobert Love void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, 48942e9a92fSRobert Love struct fc_frame *fp); 49042e9a92fSRobert Love 4910ae4d4aeSRobert Love /* 4920ae4d4aeSRobert Love * Reset the local port. 4930ae4d4aeSRobert Love * 4940ae4d4aeSRobert Love * STATUS: OPTIONAL 49542e9a92fSRobert Love */ 4960ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 49742e9a92fSRobert Love 49842e9a92fSRobert Love /* 4995101ff99SRobert Love * Create a remote port 5005101ff99SRobert Love */ 5015101ff99SRobert Love struct fc_rport *(*rport_create)(struct fc_disc_port *); 5025101ff99SRobert Love 5035101ff99SRobert Love /* 50442e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 50542e9a92fSRobert Love * This function will issue the following commands to the N_Port 50642e9a92fSRobert Love * identified by the FC ID provided. 50742e9a92fSRobert Love * 50842e9a92fSRobert Love * - PLOGI 50942e9a92fSRobert Love * - PRLI 51042e9a92fSRobert Love * - RTV 5110ae4d4aeSRobert Love * 5120ae4d4aeSRobert Love * STATUS: OPTIONAL 51342e9a92fSRobert Love */ 51442e9a92fSRobert Love int (*rport_login)(struct fc_rport *rport); 51542e9a92fSRobert Love 51642e9a92fSRobert Love /* 51742e9a92fSRobert Love * Logoff, and remove the rport from the transport if 51842e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 5190ae4d4aeSRobert Love * 5200ae4d4aeSRobert Love * STATUS: OPTIONAL 52142e9a92fSRobert Love */ 52242e9a92fSRobert Love int (*rport_logoff)(struct fc_rport *rport); 52342e9a92fSRobert Love 52442e9a92fSRobert Love /* 52542e9a92fSRobert Love * Recieve a request from a remote port. 5260ae4d4aeSRobert Love * 5270ae4d4aeSRobert Love * STATUS: OPTIONAL 52842e9a92fSRobert Love */ 52942e9a92fSRobert Love void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 53042e9a92fSRobert Love struct fc_rport *); 53142e9a92fSRobert Love 5320ae4d4aeSRobert Love /* 5330ae4d4aeSRobert Love * lookup an rport by it's port ID. 5340ae4d4aeSRobert Love * 5350ae4d4aeSRobert Love * STATUS: OPTIONAL 53642e9a92fSRobert Love */ 5370ae4d4aeSRobert Love struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32); 53842e9a92fSRobert Love 53942e9a92fSRobert Love /* 54042e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 54142e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 54242e9a92fSRobert Love * 54342e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 54442e9a92fSRobert Love * 5450ae4d4aeSRobert Love * STATUS: OPTIONAL 54642e9a92fSRobert Love */ 54742e9a92fSRobert Love int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, 54842e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *fp, 54942e9a92fSRobert Love void *arg)); 55042e9a92fSRobert Love 55142e9a92fSRobert Love /* 5520ae4d4aeSRobert Love * Cleanup the FCP layer, used durring link down and reset 5530ae4d4aeSRobert Love * 5540ae4d4aeSRobert Love * STATUS: OPTIONAL 55542e9a92fSRobert Love */ 55642e9a92fSRobert Love void (*fcp_cleanup)(struct fc_lport *lp); 55742e9a92fSRobert Love 55842e9a92fSRobert Love /* 55942e9a92fSRobert Love * Abort all I/O on a local port 5600ae4d4aeSRobert Love * 5610ae4d4aeSRobert Love * STATUS: OPTIONAL 56242e9a92fSRobert Love */ 56342e9a92fSRobert Love void (*fcp_abort_io)(struct fc_lport *lp); 56442e9a92fSRobert Love 5650ae4d4aeSRobert Love /* 5660ae4d4aeSRobert Love * Receive a request for the discovery layer. 5670ae4d4aeSRobert Love * 5680ae4d4aeSRobert Love * STATUS: OPTIONAL 56942e9a92fSRobert Love */ 57042e9a92fSRobert Love void (*disc_recv_req)(struct fc_seq *, 57142e9a92fSRobert Love struct fc_frame *, struct fc_lport *); 57242e9a92fSRobert Love 57342e9a92fSRobert Love /* 57442e9a92fSRobert Love * Start discovery for a local port. 5750ae4d4aeSRobert Love * 5760ae4d4aeSRobert Love * STATUS: OPTIONAL 57742e9a92fSRobert Love */ 57842e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 57942e9a92fSRobert Love enum fc_disc_event), 58042e9a92fSRobert Love struct fc_lport *); 58142e9a92fSRobert Love 58242e9a92fSRobert Love /* 58342e9a92fSRobert Love * Stop discovery for a given lport. This will remove 58442e9a92fSRobert Love * all discovered rports 5850ae4d4aeSRobert Love * 5860ae4d4aeSRobert Love * STATUS: OPTIONAL 58742e9a92fSRobert Love */ 58842e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 58942e9a92fSRobert Love 59042e9a92fSRobert Love /* 59142e9a92fSRobert Love * Stop discovery for a given lport. This will block 59242e9a92fSRobert Love * until all discovered rports are deleted from the 59342e9a92fSRobert Love * FC transport class 5940ae4d4aeSRobert Love * 5950ae4d4aeSRobert Love * STATUS: OPTIONAL 59642e9a92fSRobert Love */ 59742e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 59842e9a92fSRobert Love }; 59942e9a92fSRobert Love 60042e9a92fSRobert Love /* information used by the discovery layer */ 60142e9a92fSRobert Love struct fc_disc { 60242e9a92fSRobert Love unsigned char retry_count; 60342e9a92fSRobert Love unsigned char delay; 60442e9a92fSRobert Love unsigned char pending; 60542e9a92fSRobert Love unsigned char requested; 60642e9a92fSRobert Love unsigned short seq_count; 60742e9a92fSRobert Love unsigned char buf_len; 60842e9a92fSRobert Love enum fc_disc_event event; 60942e9a92fSRobert Love 61042e9a92fSRobert Love void (*disc_callback)(struct fc_lport *, 61142e9a92fSRobert Love enum fc_disc_event); 61242e9a92fSRobert Love 61342e9a92fSRobert Love struct list_head rports; 61442e9a92fSRobert Love struct fc_lport *lport; 61542e9a92fSRobert Love struct mutex disc_mutex; 61642e9a92fSRobert Love struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ 61742e9a92fSRobert Love struct delayed_work disc_work; 61842e9a92fSRobert Love }; 61942e9a92fSRobert Love 62042e9a92fSRobert Love struct fc_lport { 62142e9a92fSRobert Love struct list_head list; 62242e9a92fSRobert Love 62342e9a92fSRobert Love /* Associations */ 62442e9a92fSRobert Love struct Scsi_Host *host; 62542e9a92fSRobert Love struct fc_exch_mgr *emp; 62642e9a92fSRobert Love struct fc_rport *dns_rp; 62742e9a92fSRobert Love struct fc_rport *ptp_rp; 62842e9a92fSRobert Love void *scsi_priv; 62942e9a92fSRobert Love struct fc_disc disc; 63042e9a92fSRobert Love 63142e9a92fSRobert Love /* Operational Information */ 63242e9a92fSRobert Love struct libfc_function_template tt; 633bc0e17f6SVasu Dev u8 link_up; 634bc0e17f6SVasu Dev u8 qfull; 63542e9a92fSRobert Love enum fc_lport_state state; 63642e9a92fSRobert Love unsigned long boot_time; 63742e9a92fSRobert Love 63842e9a92fSRobert Love struct fc_host_statistics host_stats; 63942e9a92fSRobert Love struct fcoe_dev_stats *dev_stats[NR_CPUS]; 64042e9a92fSRobert Love u64 wwpn; 64142e9a92fSRobert Love u64 wwnn; 64242e9a92fSRobert Love u8 retry_count; 64342e9a92fSRobert Love 64442e9a92fSRobert Love /* Capabilities */ 64542e9a92fSRobert Love u32 sg_supp:1; /* scatter gather supported */ 64642e9a92fSRobert Love u32 seq_offload:1; /* seq offload supported */ 64742e9a92fSRobert Love u32 crc_offload:1; /* crc offload supported */ 64842e9a92fSRobert Love u32 lro_enabled:1; /* large receive offload */ 64942e9a92fSRobert Love u32 mfs; /* max FC payload size */ 65042e9a92fSRobert Love unsigned int service_params; 65142e9a92fSRobert Love unsigned int e_d_tov; 65242e9a92fSRobert Love unsigned int r_a_tov; 65342e9a92fSRobert Love u8 max_retry_count; 65442e9a92fSRobert Love u16 link_speed; 65542e9a92fSRobert Love u16 link_supported_speeds; 65642e9a92fSRobert Love u16 lro_xid; /* max xid for fcoe lro */ 65742e9a92fSRobert Love struct fc_ns_fts fcts; /* FC-4 type masks */ 65842e9a92fSRobert Love struct fc_els_rnid_gen rnid_gen; /* RNID information */ 65942e9a92fSRobert Love 66042e9a92fSRobert Love /* Semaphores */ 66142e9a92fSRobert Love struct mutex lp_mutex; 66242e9a92fSRobert Love 66342e9a92fSRobert Love /* Miscellaneous */ 66442e9a92fSRobert Love struct delayed_work retry_work; 66542e9a92fSRobert Love struct delayed_work disc_work; 66642e9a92fSRobert Love }; 66742e9a92fSRobert Love 66842e9a92fSRobert Love /** 66942e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 67042e9a92fSRobert Love *****************************/ 67142e9a92fSRobert Love static inline void *lport_priv(const struct fc_lport *lp) 67242e9a92fSRobert Love { 67342e9a92fSRobert Love return (void *)(lp + 1); 67442e9a92fSRobert Love } 67542e9a92fSRobert Love 67642e9a92fSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lp) 67742e9a92fSRobert Love { 67842e9a92fSRobert Love return lp->state == LPORT_ST_READY; 67942e9a92fSRobert Love } 68042e9a92fSRobert Love 68142e9a92fSRobert Love static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) 68242e9a92fSRobert Love { 68342e9a92fSRobert Love lp->wwnn = wwnn; 68442e9a92fSRobert Love } 68542e9a92fSRobert Love 68642e9a92fSRobert Love static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) 68742e9a92fSRobert Love { 68842e9a92fSRobert Love lp->wwpn = wwnn; 68942e9a92fSRobert Love } 69042e9a92fSRobert Love 69142e9a92fSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lp, 69242e9a92fSRobert Love enum fc_lport_state state) 69342e9a92fSRobert Love { 69442e9a92fSRobert Love if (state != lp->state) 69542e9a92fSRobert Love lp->retry_count = 0; 69642e9a92fSRobert Love lp->state = state; 69742e9a92fSRobert Love } 69842e9a92fSRobert Love 69942e9a92fSRobert Love 70042e9a92fSRobert Love /** 70142e9a92fSRobert Love * LOCAL PORT LAYER 70242e9a92fSRobert Love *****************************/ 70342e9a92fSRobert Love int fc_lport_init(struct fc_lport *lp); 70442e9a92fSRobert Love 70542e9a92fSRobert Love /* 70642e9a92fSRobert Love * Destroy the specified local port by finding and freeing all 70742e9a92fSRobert Love * fc_rports associated with it and then by freeing the fc_lport 70842e9a92fSRobert Love * itself. 70942e9a92fSRobert Love */ 71042e9a92fSRobert Love int fc_lport_destroy(struct fc_lport *lp); 71142e9a92fSRobert Love 71242e9a92fSRobert Love /* 71342e9a92fSRobert Love * Logout the specified local port from the fabric 71442e9a92fSRobert Love */ 71542e9a92fSRobert Love int fc_fabric_logoff(struct fc_lport *lp); 71642e9a92fSRobert Love 71742e9a92fSRobert Love /* 71842e9a92fSRobert Love * Initiate the LP state machine. This handler will use fc_host_attr 71942e9a92fSRobert Love * to store the FLOGI service parameters, so fc_host_attr must be 72042e9a92fSRobert Love * initialized before calling this handler. 72142e9a92fSRobert Love */ 72242e9a92fSRobert Love int fc_fabric_login(struct fc_lport *lp); 72342e9a92fSRobert Love 72442e9a92fSRobert Love /* 72542e9a92fSRobert Love * The link is up for the given local port. 72642e9a92fSRobert Love */ 72742e9a92fSRobert Love void fc_linkup(struct fc_lport *); 72842e9a92fSRobert Love 72942e9a92fSRobert Love /* 73042e9a92fSRobert Love * Link is down for the given local port. 73142e9a92fSRobert Love */ 73242e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 73342e9a92fSRobert Love 73442e9a92fSRobert Love /* 73542e9a92fSRobert Love * Configure the local port. 73642e9a92fSRobert Love */ 73742e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 73842e9a92fSRobert Love 73942e9a92fSRobert Love /* 74042e9a92fSRobert Love * Reset the local port. 74142e9a92fSRobert Love */ 74242e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 74342e9a92fSRobert Love 74442e9a92fSRobert Love /* 74542e9a92fSRobert Love * Set the mfs or reset 74642e9a92fSRobert Love */ 74742e9a92fSRobert Love int fc_set_mfs(struct fc_lport *lp, u32 mfs); 74842e9a92fSRobert Love 74942e9a92fSRobert Love 75042e9a92fSRobert Love /** 75142e9a92fSRobert Love * REMOTE PORT LAYER 75242e9a92fSRobert Love *****************************/ 75342e9a92fSRobert Love int fc_rport_init(struct fc_lport *lp); 75442e9a92fSRobert Love void fc_rport_terminate_io(struct fc_rport *rp); 75542e9a92fSRobert Love 75642e9a92fSRobert Love /** 75742e9a92fSRobert Love * DISCOVERY LAYER 75842e9a92fSRobert Love *****************************/ 75942e9a92fSRobert Love int fc_disc_init(struct fc_lport *lp); 76042e9a92fSRobert Love 76142e9a92fSRobert Love 76242e9a92fSRobert Love /** 76342e9a92fSRobert Love * SCSI LAYER 76442e9a92fSRobert Love *****************************/ 76542e9a92fSRobert Love /* 76642e9a92fSRobert Love * Initialize the SCSI block of libfc 76742e9a92fSRobert Love */ 76842e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 76942e9a92fSRobert Love 77042e9a92fSRobert Love /* 77142e9a92fSRobert Love * This section provides an API which allows direct interaction 77242e9a92fSRobert Love * with the SCSI-ml. Each of these functions satisfies a function 77342e9a92fSRobert Love * pointer defined in Scsi_Host and therefore is always called 77442e9a92fSRobert Love * directly from the SCSI-ml. 77542e9a92fSRobert Love */ 77642e9a92fSRobert Love int fc_queuecommand(struct scsi_cmnd *sc_cmd, 77742e9a92fSRobert Love void (*done)(struct scsi_cmnd *)); 77842e9a92fSRobert Love 77942e9a92fSRobert Love /* 78042e9a92fSRobert Love * complete processing of a fcp packet 78142e9a92fSRobert Love * 78242e9a92fSRobert Love * This function may sleep if a fsp timer is pending. 78342e9a92fSRobert Love * The host lock must not be held by caller. 78442e9a92fSRobert Love */ 78542e9a92fSRobert Love void fc_fcp_complete(struct fc_fcp_pkt *fsp); 78642e9a92fSRobert Love 78742e9a92fSRobert Love /* 78842e9a92fSRobert Love * Send an ABTS frame to the target device. The sc_cmd argument 78942e9a92fSRobert Love * is a pointer to the SCSI command to be aborted. 79042e9a92fSRobert Love */ 79142e9a92fSRobert Love int fc_eh_abort(struct scsi_cmnd *sc_cmd); 79242e9a92fSRobert Love 79342e9a92fSRobert Love /* 79442e9a92fSRobert Love * Reset a LUN by sending send the tm cmd to the target. 79542e9a92fSRobert Love */ 79642e9a92fSRobert Love int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); 79742e9a92fSRobert Love 79842e9a92fSRobert Love /* 79942e9a92fSRobert Love * Reset the host adapter. 80042e9a92fSRobert Love */ 80142e9a92fSRobert Love int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); 80242e9a92fSRobert Love 80342e9a92fSRobert Love /* 80442e9a92fSRobert Love * Check rport status. 80542e9a92fSRobert Love */ 80642e9a92fSRobert Love int fc_slave_alloc(struct scsi_device *sdev); 80742e9a92fSRobert Love 80842e9a92fSRobert Love /* 80942e9a92fSRobert Love * Adjust the queue depth. 81042e9a92fSRobert Love */ 81142e9a92fSRobert Love int fc_change_queue_depth(struct scsi_device *sdev, int qdepth); 81242e9a92fSRobert Love 81342e9a92fSRobert Love /* 81442e9a92fSRobert Love * Change the tag type. 81542e9a92fSRobert Love */ 81642e9a92fSRobert Love int fc_change_queue_type(struct scsi_device *sdev, int tag_type); 81742e9a92fSRobert Love 81842e9a92fSRobert Love /* 81942e9a92fSRobert Love * Free memory pools used by the FCP layer. 82042e9a92fSRobert Love */ 82142e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 82242e9a92fSRobert Love 82342e9a92fSRobert Love /** 82442e9a92fSRobert Love * ELS/CT interface 82542e9a92fSRobert Love *****************************/ 82642e9a92fSRobert Love /* 82742e9a92fSRobert Love * Initializes ELS/CT interface 82842e9a92fSRobert Love */ 82942e9a92fSRobert Love int fc_elsct_init(struct fc_lport *lp); 83042e9a92fSRobert Love 83142e9a92fSRobert Love 83242e9a92fSRobert Love /** 83342e9a92fSRobert Love * EXCHANGE MANAGER LAYER 83442e9a92fSRobert Love *****************************/ 83542e9a92fSRobert Love /* 83642e9a92fSRobert Love * Initializes Exchange Manager related 83742e9a92fSRobert Love * function pointers in struct libfc_function_template. 83842e9a92fSRobert Love */ 83942e9a92fSRobert Love int fc_exch_init(struct fc_lport *lp); 84042e9a92fSRobert Love 84142e9a92fSRobert Love /* 84242e9a92fSRobert Love * Allocates an Exchange Manager (EM). 84342e9a92fSRobert Love * 84442e9a92fSRobert Love * The EM manages exchanges for their allocation and 84542e9a92fSRobert Love * free, also allows exchange lookup for received 84642e9a92fSRobert Love * frame. 84742e9a92fSRobert Love * 84842e9a92fSRobert Love * The class is used for initializing FC class of 84942e9a92fSRobert Love * allocated exchange from EM. 85042e9a92fSRobert Love * 85142e9a92fSRobert Love * The min_xid and max_xid will limit new 85242e9a92fSRobert Love * exchange ID (XID) within this range for 85342e9a92fSRobert Love * a new exchange. 85442e9a92fSRobert Love * The LLD may choose to have multiple EMs, 85542e9a92fSRobert Love * e.g. one EM instance per CPU receive thread in LLD. 85642e9a92fSRobert Love * The LLD can use exch_get() of struct libfc_function_template 85742e9a92fSRobert Love * to specify XID for a new exchange within 85842e9a92fSRobert Love * a specified EM instance. 85942e9a92fSRobert Love * 86042e9a92fSRobert Love * The em_idx to uniquely identify an EM instance. 86142e9a92fSRobert Love */ 86242e9a92fSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, 86342e9a92fSRobert Love enum fc_class class, 86442e9a92fSRobert Love u16 min_xid, 86542e9a92fSRobert Love u16 max_xid); 86642e9a92fSRobert Love 86742e9a92fSRobert Love /* 86842e9a92fSRobert Love * Free an exchange manager. 86942e9a92fSRobert Love */ 87042e9a92fSRobert Love void fc_exch_mgr_free(struct fc_exch_mgr *mp); 87142e9a92fSRobert Love 87242e9a92fSRobert Love /* 87342e9a92fSRobert Love * Receive a frame on specified local port and exchange manager. 87442e9a92fSRobert Love */ 87542e9a92fSRobert Love void fc_exch_recv(struct fc_lport *lp, struct fc_exch_mgr *mp, 87642e9a92fSRobert Love struct fc_frame *fp); 87742e9a92fSRobert Love 87842e9a92fSRobert Love /* 87942e9a92fSRobert Love * This function is for exch_seq_send function pointer in 88042e9a92fSRobert Love * struct libfc_function_template, see comment block on 88142e9a92fSRobert Love * exch_seq_send for description of this function. 88242e9a92fSRobert Love */ 88342e9a92fSRobert Love struct fc_seq *fc_exch_seq_send(struct fc_lport *lp, 88442e9a92fSRobert Love struct fc_frame *fp, 88542e9a92fSRobert Love void (*resp)(struct fc_seq *sp, 88642e9a92fSRobert Love struct fc_frame *fp, 88742e9a92fSRobert Love void *arg), 88842e9a92fSRobert Love void (*destructor)(struct fc_seq *sp, 88942e9a92fSRobert Love void *arg), 89042e9a92fSRobert Love void *arg, u32 timer_msec); 89142e9a92fSRobert Love 89242e9a92fSRobert Love /* 89342e9a92fSRobert Love * send a frame using existing sequence and exchange. 89442e9a92fSRobert Love */ 89542e9a92fSRobert Love int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp); 89642e9a92fSRobert Love 89742e9a92fSRobert Love /* 89842e9a92fSRobert Love * Send ELS response using mainly infomation 89942e9a92fSRobert Love * in exchange and sequence in EM layer. 90042e9a92fSRobert Love */ 90142e9a92fSRobert Love void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd, 90242e9a92fSRobert Love struct fc_seq_els_data *els_data); 90342e9a92fSRobert Love 90442e9a92fSRobert Love /* 90542e9a92fSRobert Love * This function is for seq_exch_abort function pointer in 90642e9a92fSRobert Love * struct libfc_function_template, see comment block on 90742e9a92fSRobert Love * seq_exch_abort for description of this function. 90842e9a92fSRobert Love */ 90942e9a92fSRobert Love int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec); 91042e9a92fSRobert Love 91142e9a92fSRobert Love /* 91242e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 91342e9a92fSRobert Love * allocated for the related objects may be freed. 91442e9a92fSRobert Love */ 91542e9a92fSRobert Love void fc_exch_done(struct fc_seq *sp); 91642e9a92fSRobert Love 91742e9a92fSRobert Love /* 91842e9a92fSRobert Love * Assigns a EM and XID for a frame and then allocates 91942e9a92fSRobert Love * a new exchange and sequence pair. 92042e9a92fSRobert Love * The fp can be used to determine free XID. 92142e9a92fSRobert Love */ 92242e9a92fSRobert Love struct fc_exch *fc_exch_get(struct fc_lport *lp, struct fc_frame *fp); 92342e9a92fSRobert Love 92442e9a92fSRobert Love /* 92542e9a92fSRobert Love * Allocate a new exchange and sequence pair. 92642e9a92fSRobert Love * if ex_id is zero then next free exchange id 92742e9a92fSRobert Love * from specified exchange manger mp will be assigned. 92842e9a92fSRobert Love */ 92942e9a92fSRobert Love struct fc_exch *fc_exch_alloc(struct fc_exch_mgr *mp, 93042e9a92fSRobert Love struct fc_frame *fp, u16 ex_id); 93142e9a92fSRobert Love /* 93242e9a92fSRobert Love * Start a new sequence on the same exchange as the supplied sequence. 93342e9a92fSRobert Love */ 93442e9a92fSRobert Love struct fc_seq *fc_seq_start_next(struct fc_seq *sp); 93542e9a92fSRobert Love 93642e9a92fSRobert Love /* 93742e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 93842e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 93942e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 94042e9a92fSRobert Love */ 9411f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 94242e9a92fSRobert Love 94342e9a92fSRobert Love /* 94442e9a92fSRobert Love * Functions for fc_functions_template 94542e9a92fSRobert Love */ 94642e9a92fSRobert Love void fc_get_host_speed(struct Scsi_Host *shost); 94742e9a92fSRobert Love void fc_get_host_port_type(struct Scsi_Host *shost); 94842e9a92fSRobert Love void fc_get_host_port_state(struct Scsi_Host *shost); 94942e9a92fSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); 95042e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 95142e9a92fSRobert Love 95242e9a92fSRobert Love /* 95342e9a92fSRobert Love * module setup functions. 95442e9a92fSRobert Love */ 95542e9a92fSRobert Love int fc_setup_exch_mgr(void); 95642e9a92fSRobert Love void fc_destroy_exch_mgr(void); 95742e9a92fSRobert Love int fc_setup_rport(void); 95842e9a92fSRobert Love void fc_destroy_rport(void); 95942e9a92fSRobert Love 96042e9a92fSRobert Love #endif /* _LIBFC_H_ */ 961