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 377414705eSRobert Love #define FC_LIBFC_LOGGING 0x01 /* General logging, not categorized */ 387414705eSRobert Love #define FC_LPORT_LOGGING 0x02 /* lport layer logging */ 397414705eSRobert Love #define FC_DISC_LOGGING 0x04 /* discovery layer logging */ 407414705eSRobert Love #define FC_RPORT_LOGGING 0x08 /* rport layer logging */ 417414705eSRobert Love #define FC_FCP_LOGGING 0x10 /* I/O path logging */ 427414705eSRobert Love #define FC_EM_LOGGING 0x20 /* Exchange Manager logging */ 437414705eSRobert Love #define FC_EXCH_LOGGING 0x40 /* Exchange/Sequence logging */ 447414705eSRobert Love #define FC_SCSI_LOGGING 0x80 /* SCSI logging (mostly error handling) */ 4542e9a92fSRobert Love 467414705eSRobert Love extern unsigned int fc_debug_logging; 477414705eSRobert Love 487414705eSRobert Love #define FC_CHECK_LOGGING(LEVEL, CMD) \ 4942e9a92fSRobert Love do { \ 507414705eSRobert Love if (unlikely(fc_debug_logging & LEVEL)) \ 517414705eSRobert Love do { \ 527414705eSRobert Love CMD; \ 537414705eSRobert Love } while (0); \ 54beb29a6dSJoe Eykholt } while (0) 557414705eSRobert Love 567414705eSRobert Love #define FC_LIBFC_DBG(fmt, args...) \ 577414705eSRobert Love FC_CHECK_LOGGING(FC_LIBFC_LOGGING, \ 58beb29a6dSJoe Eykholt printk(KERN_INFO "libfc: " fmt, ##args)) 597414705eSRobert Love 607414705eSRobert Love #define FC_LPORT_DBG(lport, fmt, args...) \ 617414705eSRobert Love FC_CHECK_LOGGING(FC_LPORT_LOGGING, \ 627f74549fSJoe Eykholt printk(KERN_INFO "host%u: lport %6x: " fmt, \ 637f74549fSJoe Eykholt (lport)->host->host_no, \ 647f74549fSJoe Eykholt fc_host_port_id((lport)->host), ##args)) 657414705eSRobert Love 667414705eSRobert Love #define FC_DISC_DBG(disc, fmt, args...) \ 677414705eSRobert Love FC_CHECK_LOGGING(FC_DISC_LOGGING, \ 687f74549fSJoe Eykholt printk(KERN_INFO "host%u: disc: " fmt, \ 697f74549fSJoe Eykholt (disc)->lport->host->host_no, \ 70beb29a6dSJoe Eykholt ##args)) 717414705eSRobert Love 727f74549fSJoe Eykholt #define FC_RPORT_ID_DBG(lport, port_id, fmt, args...) \ 737f74549fSJoe Eykholt FC_CHECK_LOGGING(FC_RPORT_LOGGING, \ 747f74549fSJoe Eykholt printk(KERN_INFO "host%u: rport %6x: " fmt, \ 757f74549fSJoe Eykholt (lport)->host->host_no, \ 767f74549fSJoe Eykholt (port_id), ##args)) 777f74549fSJoe Eykholt 787414705eSRobert Love #define FC_RPORT_DBG(rport, fmt, args...) \ 797414705eSRobert Love do { \ 80ab28f1fdSJoe Eykholt struct fc_rport_priv *rdata = rport->dd_data; \ 817414705eSRobert Love struct fc_lport *lport = rdata->local_port; \ 827f74549fSJoe Eykholt FC_RPORT_ID_DBG(lport, rport->port_id, fmt, ##args); \ 83beb29a6dSJoe Eykholt } while (0) 847414705eSRobert Love 857414705eSRobert Love #define FC_FCP_DBG(pkt, fmt, args...) \ 867414705eSRobert Love FC_CHECK_LOGGING(FC_FCP_LOGGING, \ 877f74549fSJoe Eykholt printk(KERN_INFO "host%u: fcp: %6x: " fmt, \ 887f74549fSJoe Eykholt (pkt)->lp->host->host_no, \ 89beb29a6dSJoe Eykholt pkt->rport->port_id, ##args)) 907414705eSRobert Love 917414705eSRobert Love #define FC_EXCH_DBG(exch, fmt, args...) \ 927414705eSRobert Love FC_CHECK_LOGGING(FC_EXCH_LOGGING, \ 937f74549fSJoe Eykholt printk(KERN_INFO "host%u: xid %4x: " fmt, \ 947f74549fSJoe Eykholt (exch)->lp->host->host_no, \ 95beb29a6dSJoe Eykholt exch->xid, ##args)) 967414705eSRobert Love 977414705eSRobert Love #define FC_SCSI_DBG(lport, fmt, args...) \ 987414705eSRobert Love FC_CHECK_LOGGING(FC_SCSI_LOGGING, \ 997f74549fSJoe Eykholt printk(KERN_INFO "host%u: scsi: " fmt, \ 1007f74549fSJoe Eykholt (lport)->host->host_no, ##args)) 10142e9a92fSRobert Love 10242e9a92fSRobert Love /* 10342e9a92fSRobert Love * libfc error codes 10442e9a92fSRobert Love */ 10542e9a92fSRobert Love #define FC_NO_ERR 0 /* no error */ 10642e9a92fSRobert Love #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 10742e9a92fSRobert Love #define FC_EX_CLOSED 2 /* Exchange closed */ 10842e9a92fSRobert Love 10942e9a92fSRobert Love /* some helpful macros */ 11042e9a92fSRobert Love 11142e9a92fSRobert Love #define ntohll(x) be64_to_cpu(x) 11242e9a92fSRobert Love #define htonll(x) cpu_to_be64(x) 11342e9a92fSRobert Love 11442e9a92fSRobert Love #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 11542e9a92fSRobert Love 11642e9a92fSRobert Love #define hton24(p, v) do { \ 11742e9a92fSRobert Love p[0] = (((v) >> 16) & 0xFF); \ 11842e9a92fSRobert Love p[1] = (((v) >> 8) & 0xFF); \ 11942e9a92fSRobert Love p[2] = ((v) & 0xFF); \ 12042e9a92fSRobert Love } while (0) 12142e9a92fSRobert Love 12242e9a92fSRobert Love /* 12342e9a92fSRobert Love * FC HBA status 12442e9a92fSRobert Love */ 12542e9a92fSRobert Love enum fc_lport_state { 126b1d9fd55SJoe Eykholt LPORT_ST_DISABLED = 0, 12742e9a92fSRobert Love LPORT_ST_FLOGI, 12842e9a92fSRobert Love LPORT_ST_DNS, 12942e9a92fSRobert Love LPORT_ST_RPN_ID, 13042e9a92fSRobert Love LPORT_ST_RFT_ID, 13142e9a92fSRobert Love LPORT_ST_SCR, 13242e9a92fSRobert Love LPORT_ST_READY, 13342e9a92fSRobert Love LPORT_ST_LOGO, 13442e9a92fSRobert Love LPORT_ST_RESET 13542e9a92fSRobert Love }; 13642e9a92fSRobert Love 13742e9a92fSRobert Love enum fc_disc_event { 13842e9a92fSRobert Love DISC_EV_NONE = 0, 13942e9a92fSRobert Love DISC_EV_SUCCESS, 14042e9a92fSRobert Love DISC_EV_FAILED 14142e9a92fSRobert Love }; 14242e9a92fSRobert Love 14342e9a92fSRobert Love enum fc_rport_state { 14442e9a92fSRobert Love RPORT_ST_INIT, /* initialized */ 14542e9a92fSRobert Love RPORT_ST_PLOGI, /* waiting for PLOGI completion */ 14642e9a92fSRobert Love RPORT_ST_PRLI, /* waiting for PRLI completion */ 14742e9a92fSRobert Love RPORT_ST_RTV, /* waiting for RTV completion */ 14842e9a92fSRobert Love RPORT_ST_READY, /* ready for use */ 14942e9a92fSRobert Love RPORT_ST_LOGO, /* port logout sent */ 15014194054SJoe Eykholt RPORT_ST_DELETE, /* port being deleted */ 15142e9a92fSRobert Love }; 15242e9a92fSRobert Love 15342e9a92fSRobert Love enum fc_rport_trans_state { 15442e9a92fSRobert Love FC_PORTSTATE_ROGUE, 15542e9a92fSRobert Love FC_PORTSTATE_REAL, 15642e9a92fSRobert Love }; 15742e9a92fSRobert Love 15842e9a92fSRobert Love /** 15942e9a92fSRobert Love * struct fc_disc_port - temporary discovery port to hold rport identifiers 16042e9a92fSRobert Love * @lp: Fibre Channel host port instance 16142e9a92fSRobert Love * @peers: node for list management during discovery and RSCN processing 16242e9a92fSRobert Love * @ids: identifiers structure to pass to fc_remote_port_add() 16342e9a92fSRobert Love * @rport_work: work struct for starting the rport state machine 16442e9a92fSRobert Love */ 16542e9a92fSRobert Love struct fc_disc_port { 16642e9a92fSRobert Love struct fc_lport *lp; 16742e9a92fSRobert Love struct list_head peers; 16842e9a92fSRobert Love struct fc_rport_identifiers ids; 16942e9a92fSRobert Love struct work_struct rport_work; 17042e9a92fSRobert Love }; 17142e9a92fSRobert Love 17242e9a92fSRobert Love enum fc_rport_event { 17342e9a92fSRobert Love RPORT_EV_NONE = 0, 17442e9a92fSRobert Love RPORT_EV_CREATED, 17542e9a92fSRobert Love RPORT_EV_FAILED, 17642e9a92fSRobert Love RPORT_EV_STOP, 17742e9a92fSRobert Love RPORT_EV_LOGO 17842e9a92fSRobert Love }; 17942e9a92fSRobert Love 180ab28f1fdSJoe Eykholt /* 181ab28f1fdSJoe Eykholt * Temporary definition to prepare for split off from fc_rport_libfc_priv 182ab28f1fdSJoe Eykholt * of a separately-allocated structure called fc_rport_priv. This will 183ab28f1fdSJoe Eykholt * be the primary object for the discovery and rport state machines. 184ab28f1fdSJoe Eykholt * This definition is just to make this patch series easier to review. 185ab28f1fdSJoe Eykholt */ 186ab28f1fdSJoe Eykholt #define fc_rport_priv fc_rport_libfc_priv 187ab28f1fdSJoe Eykholt 18842e9a92fSRobert Love struct fc_rport_operations { 18942e9a92fSRobert Love void (*event_callback)(struct fc_lport *, struct fc_rport *, 19042e9a92fSRobert Love enum fc_rport_event); 19142e9a92fSRobert Love }; 19242e9a92fSRobert Love 19342e9a92fSRobert Love /** 19442e9a92fSRobert Love * struct fc_rport_libfc_priv - libfc internal information about a remote port 19542e9a92fSRobert Love * @local_port: Fibre Channel host port instance 19642e9a92fSRobert Love * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges 19742e9a92fSRobert Love * @flags: REC and RETRY supported flags 19842e9a92fSRobert Love * @max_seq: maximum number of concurrent sequences 19942e9a92fSRobert Love * @retries: retry count in current state 20042e9a92fSRobert Love * @e_d_tov: error detect timeout value (in msec) 20142e9a92fSRobert Love * @r_a_tov: resource allocation timeout value (in msec) 20242e9a92fSRobert Love * @rp_mutex: mutex protects rport 20342e9a92fSRobert Love * @retry_work: 20442e9a92fSRobert Love * @event_callback: Callback for rport READY, FAILED or LOGO 20542e9a92fSRobert Love */ 20642e9a92fSRobert Love struct fc_rport_libfc_priv { 20742e9a92fSRobert Love struct fc_lport *local_port; 20842e9a92fSRobert Love enum fc_rport_state rp_state; 20942e9a92fSRobert Love u16 flags; 21042e9a92fSRobert Love #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 21142e9a92fSRobert Love #define FC_RP_FLAGS_RETRY (1 << 1) 21242e9a92fSRobert Love u16 max_seq; 21342e9a92fSRobert Love unsigned int retries; 21442e9a92fSRobert Love unsigned int e_d_tov; 21542e9a92fSRobert Love unsigned int r_a_tov; 21642e9a92fSRobert Love enum fc_rport_trans_state trans_state; 21742e9a92fSRobert Love struct mutex rp_mutex; 21842e9a92fSRobert Love struct delayed_work retry_work; 21942e9a92fSRobert Love enum fc_rport_event event; 22042e9a92fSRobert Love struct fc_rport_operations *ops; 22142e9a92fSRobert Love struct list_head peers; 22242e9a92fSRobert Love struct work_struct event_work; 22342e9a92fSRobert Love }; 22442e9a92fSRobert Love 22542e9a92fSRobert Love #define PRIV_TO_RPORT(x) \ 226922aa210SJoe Eykholt ((struct fc_rport *)((void *)(x) - sizeof(struct fc_rport))) 22742e9a92fSRobert Love #define RPORT_TO_PRIV(x) \ 228922aa210SJoe Eykholt ((struct fc_rport_libfc_priv *)((void *)(x) + sizeof(struct fc_rport))) 22942e9a92fSRobert Love 23042e9a92fSRobert Love static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn) 23142e9a92fSRobert Love { 23242e9a92fSRobert Love rport->node_name = wwnn; 23342e9a92fSRobert Love rport->port_name = wwpn; 23442e9a92fSRobert Love } 23542e9a92fSRobert Love 23642e9a92fSRobert Love /* 23742e9a92fSRobert Love * fcoe stats structure 23842e9a92fSRobert Love */ 23942e9a92fSRobert Love struct fcoe_dev_stats { 24042e9a92fSRobert Love u64 SecondsSinceLastReset; 24142e9a92fSRobert Love u64 TxFrames; 24242e9a92fSRobert Love u64 TxWords; 24342e9a92fSRobert Love u64 RxFrames; 24442e9a92fSRobert Love u64 RxWords; 24542e9a92fSRobert Love u64 ErrorFrames; 24642e9a92fSRobert Love u64 DumpedFrames; 24742e9a92fSRobert Love u64 LinkFailureCount; 24842e9a92fSRobert Love u64 LossOfSignalCount; 24942e9a92fSRobert Love u64 InvalidTxWordCount; 25042e9a92fSRobert Love u64 InvalidCRCCount; 25142e9a92fSRobert Love u64 InputRequests; 25242e9a92fSRobert Love u64 OutputRequests; 25342e9a92fSRobert Love u64 ControlRequests; 25442e9a92fSRobert Love u64 InputMegabytes; 25542e9a92fSRobert Love u64 OutputMegabytes; 25642e9a92fSRobert Love }; 25742e9a92fSRobert Love 25842e9a92fSRobert Love /* 25942e9a92fSRobert Love * els data is used for passing ELS respone specific 26042e9a92fSRobert Love * data to send ELS response mainly using infomation 26142e9a92fSRobert Love * in exchange and sequence in EM layer. 26242e9a92fSRobert Love */ 26342e9a92fSRobert Love struct fc_seq_els_data { 26442e9a92fSRobert Love struct fc_frame *fp; 26542e9a92fSRobert Love enum fc_els_rjt_reason reason; 26642e9a92fSRobert Love enum fc_els_rjt_explan explan; 26742e9a92fSRobert Love }; 26842e9a92fSRobert Love 26942e9a92fSRobert Love /* 27042e9a92fSRobert Love * FCP request structure, one for each scsi cmd request 27142e9a92fSRobert Love */ 27242e9a92fSRobert Love struct fc_fcp_pkt { 27342e9a92fSRobert Love /* 27442e9a92fSRobert Love * housekeeping stuff 27542e9a92fSRobert Love */ 27642e9a92fSRobert Love struct fc_lport *lp; /* handle to hba struct */ 27742e9a92fSRobert Love u16 state; /* scsi_pkt state state */ 27842e9a92fSRobert Love u16 tgt_flags; /* target flags */ 27942e9a92fSRobert Love atomic_t ref_cnt; /* fcp pkt ref count */ 28042e9a92fSRobert Love spinlock_t scsi_pkt_lock; /* Must be taken before the host lock 28142e9a92fSRobert Love * if both are held at the same time */ 28242e9a92fSRobert Love /* 28342e9a92fSRobert Love * SCSI I/O related stuff 28442e9a92fSRobert Love */ 28542e9a92fSRobert Love struct scsi_cmnd *cmd; /* scsi command pointer. set/clear 28642e9a92fSRobert Love * under host lock */ 28742e9a92fSRobert Love struct list_head list; /* tracks queued commands. access under 28842e9a92fSRobert Love * host lock */ 28942e9a92fSRobert Love /* 29042e9a92fSRobert Love * timeout related stuff 29142e9a92fSRobert Love */ 29242e9a92fSRobert Love struct timer_list timer; /* command timer */ 29342e9a92fSRobert Love struct completion tm_done; 29442e9a92fSRobert Love int wait_for_comp; 29542e9a92fSRobert Love unsigned long start_time; /* start jiffie */ 29642e9a92fSRobert Love unsigned long end_time; /* end jiffie */ 29742e9a92fSRobert Love unsigned long last_pkt_time; /* jiffies of last frame received */ 29842e9a92fSRobert Love 29942e9a92fSRobert Love /* 30042e9a92fSRobert Love * scsi cmd and data transfer information 30142e9a92fSRobert Love */ 30242e9a92fSRobert Love u32 data_len; 30342e9a92fSRobert Love /* 30442e9a92fSRobert Love * transport related veriables 30542e9a92fSRobert Love */ 30642e9a92fSRobert Love struct fcp_cmnd cdb_cmd; 30742e9a92fSRobert Love size_t xfer_len; 308b277d2aaSYi Zou u16 xfer_ddp; /* this xfer is ddped */ 30942e9a92fSRobert Love u32 xfer_contig_end; /* offset of end of contiguous xfer */ 31042e9a92fSRobert Love u16 max_payload; /* max payload size in bytes */ 31142e9a92fSRobert Love 31242e9a92fSRobert Love /* 31342e9a92fSRobert Love * scsi/fcp return status 31442e9a92fSRobert Love */ 31542e9a92fSRobert Love u32 io_status; /* SCSI result upper 24 bits */ 31642e9a92fSRobert Love u8 cdb_status; 31742e9a92fSRobert Love u8 status_code; /* FCP I/O status */ 31842e9a92fSRobert Love /* bit 3 Underrun bit 2: overrun */ 31942e9a92fSRobert Love u8 scsi_comp_flags; 32042e9a92fSRobert Love u32 req_flags; /* bit 0: read bit:1 write */ 32142e9a92fSRobert Love u32 scsi_resid; /* residule length */ 32242e9a92fSRobert Love 32342e9a92fSRobert Love struct fc_rport *rport; /* remote port pointer */ 32442e9a92fSRobert Love struct fc_seq *seq_ptr; /* current sequence pointer */ 32542e9a92fSRobert Love /* 32642e9a92fSRobert Love * Error Processing 32742e9a92fSRobert Love */ 32842e9a92fSRobert Love u8 recov_retry; /* count of recovery retries */ 32942e9a92fSRobert Love struct fc_seq *recov_seq; /* sequence for REC or SRR */ 33042e9a92fSRobert Love }; 331b277d2aaSYi Zou /* 332b277d2aaSYi Zou * FC_FCP HELPER FUNCTIONS 333b277d2aaSYi Zou *****************************/ 334b277d2aaSYi Zou static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 335b277d2aaSYi Zou { 336b277d2aaSYi Zou if (fsp && fsp->cmd) 337b277d2aaSYi Zou return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 338b277d2aaSYi Zou return false; 339b277d2aaSYi Zou } 34042e9a92fSRobert Love 34142e9a92fSRobert Love /* 34242e9a92fSRobert Love * Structure and function definitions for managing Fibre Channel Exchanges 34342e9a92fSRobert Love * and Sequences 34442e9a92fSRobert Love * 34542e9a92fSRobert Love * fc_exch holds state for one exchange and links to its active sequence. 34642e9a92fSRobert Love * 34742e9a92fSRobert Love * fc_seq holds the state for an individual sequence. 34842e9a92fSRobert Love */ 34942e9a92fSRobert Love 35042e9a92fSRobert Love struct fc_exch_mgr; 35196316099SVasu Dev struct fc_exch_mgr_anchor; 352e4bc50beSVasu Dev extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 35342e9a92fSRobert Love 35442e9a92fSRobert Love /* 35542e9a92fSRobert Love * Sequence. 35642e9a92fSRobert Love */ 35742e9a92fSRobert Love struct fc_seq { 35842e9a92fSRobert Love u8 id; /* seq ID */ 35942e9a92fSRobert Love u16 ssb_stat; /* status flags for sequence status block */ 36042e9a92fSRobert Love u16 cnt; /* frames sent so far on sequence */ 36142e9a92fSRobert Love u32 rec_data; /* FC-4 value for REC */ 36242e9a92fSRobert Love }; 36342e9a92fSRobert Love 36442e9a92fSRobert Love #define FC_EX_DONE (1 << 0) /* ep is completed */ 36542e9a92fSRobert Love #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 36642e9a92fSRobert Love 36742e9a92fSRobert Love /* 36842e9a92fSRobert Love * Exchange. 36942e9a92fSRobert Love * 37042e9a92fSRobert Love * Locking notes: The ex_lock protects following items: 37142e9a92fSRobert Love * state, esb_stat, f_ctl, seq.ssb_stat 37242e9a92fSRobert Love * seq_id 37342e9a92fSRobert Love * sequence allocation 37442e9a92fSRobert Love */ 37542e9a92fSRobert Love struct fc_exch { 37642e9a92fSRobert Love struct fc_exch_mgr *em; /* exchange manager */ 377b2f0091fSVasu Dev struct fc_exch_pool *pool; /* per cpu exches pool */ 37842e9a92fSRobert Love u32 state; /* internal driver state */ 37942e9a92fSRobert Love u16 xid; /* our exchange ID */ 38042e9a92fSRobert Love struct list_head ex_list; /* free or busy list linkage */ 38142e9a92fSRobert Love spinlock_t ex_lock; /* lock covering exchange state */ 38242e9a92fSRobert Love atomic_t ex_refcnt; /* reference counter */ 38342e9a92fSRobert Love struct delayed_work timeout_work; /* timer for upper level protocols */ 38442e9a92fSRobert Love struct fc_lport *lp; /* fc device instance */ 38542e9a92fSRobert Love u16 oxid; /* originator's exchange ID */ 38642e9a92fSRobert Love u16 rxid; /* responder's exchange ID */ 38742e9a92fSRobert Love u32 oid; /* originator's FCID */ 38842e9a92fSRobert Love u32 sid; /* source FCID */ 38942e9a92fSRobert Love u32 did; /* destination FCID */ 39042e9a92fSRobert Love u32 esb_stat; /* exchange status for ESB */ 39142e9a92fSRobert Love u32 r_a_tov; /* r_a_tov from rport (msec) */ 39242e9a92fSRobert Love u8 seq_id; /* next sequence ID to use */ 39342e9a92fSRobert Love u32 f_ctl; /* F_CTL flags for sequences */ 39442e9a92fSRobert Love u8 fh_type; /* frame type */ 39542e9a92fSRobert Love enum fc_class class; /* class of service */ 39642e9a92fSRobert Love struct fc_seq seq; /* single sequence */ 39742e9a92fSRobert Love /* 39842e9a92fSRobert Love * Handler for responses to this current exchange. 39942e9a92fSRobert Love */ 40042e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *, void *); 40142e9a92fSRobert Love void (*destructor)(struct fc_seq *, void *); 40242e9a92fSRobert Love /* 40342e9a92fSRobert Love * arg is passed as void pointer to exchange 40442e9a92fSRobert Love * resp and destructor handlers 40542e9a92fSRobert Love */ 40642e9a92fSRobert Love void *arg; 40742e9a92fSRobert Love }; 40842e9a92fSRobert Love #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 40942e9a92fSRobert Love 41042e9a92fSRobert Love struct libfc_function_template { 41142e9a92fSRobert Love 41242e9a92fSRobert Love /* 41342e9a92fSRobert Love * Interface to send a FC frame 4140ae4d4aeSRobert Love * 4150ae4d4aeSRobert Love * STATUS: REQUIRED 41642e9a92fSRobert Love */ 41742e9a92fSRobert Love int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); 41842e9a92fSRobert Love 41942e9a92fSRobert Love /* 4200ae4d4aeSRobert Love * Interface to send ELS/CT frames 4210ae4d4aeSRobert Love * 4220ae4d4aeSRobert Love * STATUS: OPTIONAL 42342e9a92fSRobert Love */ 42442e9a92fSRobert Love struct fc_seq *(*elsct_send)(struct fc_lport *lport, 42542e9a92fSRobert Love struct fc_rport *rport, 42642e9a92fSRobert Love struct fc_frame *fp, 42742e9a92fSRobert Love unsigned int op, 42842e9a92fSRobert Love void (*resp)(struct fc_seq *, 42942e9a92fSRobert Love struct fc_frame *fp, 43042e9a92fSRobert Love void *arg), 43142e9a92fSRobert Love void *arg, u32 timer_msec); 43242e9a92fSRobert Love 43342e9a92fSRobert Love /* 43442e9a92fSRobert Love * Send the FC frame payload using a new exchange and sequence. 43542e9a92fSRobert Love * 43642e9a92fSRobert Love * The frame pointer with some of the header's fields must be 43742e9a92fSRobert Love * filled before calling exch_seq_send(), those fields are, 43842e9a92fSRobert Love * 43942e9a92fSRobert Love * - routing control 44042e9a92fSRobert Love * - FC port did 44142e9a92fSRobert Love * - FC port sid 44242e9a92fSRobert Love * - FC header type 44342e9a92fSRobert Love * - frame control 44442e9a92fSRobert Love * - parameter or relative offset 44542e9a92fSRobert Love * 44642e9a92fSRobert Love * The exchange response handler is set in this routine to resp() 44742e9a92fSRobert Love * function pointer. It can be called in two scenarios: if a timeout 44842e9a92fSRobert Love * occurs or if a response frame is received for the exchange. The 44942e9a92fSRobert Love * fc_frame pointer in response handler will also indicate timeout 45042e9a92fSRobert Love * as error using IS_ERR related macros. 45142e9a92fSRobert Love * 45242e9a92fSRobert Love * The exchange destructor handler is also set in this routine. 45342e9a92fSRobert Love * The destructor handler is invoked by EM layer when exchange 45442e9a92fSRobert Love * is about to free, this can be used by caller to free its 45542e9a92fSRobert Love * resources along with exchange free. 45642e9a92fSRobert Love * 45742e9a92fSRobert Love * The arg is passed back to resp and destructor handler. 45842e9a92fSRobert Love * 45942e9a92fSRobert Love * The timeout value (in msec) for an exchange is set if non zero 46042e9a92fSRobert Love * timer_msec argument is specified. The timer is canceled when 46142e9a92fSRobert Love * it fires or when the exchange is done. The exchange timeout handler 46242e9a92fSRobert Love * is registered by EM layer. 4630ae4d4aeSRobert Love * 4640ae4d4aeSRobert Love * STATUS: OPTIONAL 46542e9a92fSRobert Love */ 46642e9a92fSRobert Love struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, 46742e9a92fSRobert Love struct fc_frame *fp, 46842e9a92fSRobert Love void (*resp)(struct fc_seq *sp, 46942e9a92fSRobert Love struct fc_frame *fp, 47042e9a92fSRobert Love void *arg), 47142e9a92fSRobert Love void (*destructor)(struct fc_seq *sp, 47242e9a92fSRobert Love void *arg), 47342e9a92fSRobert Love void *arg, unsigned int timer_msec); 47442e9a92fSRobert Love 47542e9a92fSRobert Love /* 476b277d2aaSYi Zou * Sets up the DDP context for a given exchange id on the given 477b277d2aaSYi Zou * scatterlist if LLD supports DDP for large receive. 478b277d2aaSYi Zou * 479b277d2aaSYi Zou * STATUS: OPTIONAL 480b277d2aaSYi Zou */ 481b277d2aaSYi Zou int (*ddp_setup)(struct fc_lport *lp, u16 xid, 482b277d2aaSYi Zou struct scatterlist *sgl, unsigned int sgc); 483b277d2aaSYi Zou /* 484b277d2aaSYi Zou * Completes the DDP transfer and returns the length of data DDPed 485b277d2aaSYi Zou * for the given exchange id. 486b277d2aaSYi Zou * 487b277d2aaSYi Zou * STATUS: OPTIONAL 488b277d2aaSYi Zou */ 489b277d2aaSYi Zou int (*ddp_done)(struct fc_lport *lp, u16 xid); 490b277d2aaSYi Zou /* 4910ae4d4aeSRobert Love * Send a frame using an existing sequence and exchange. 4920ae4d4aeSRobert Love * 4930ae4d4aeSRobert Love * STATUS: OPTIONAL 49442e9a92fSRobert Love */ 49542e9a92fSRobert Love int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, 49642e9a92fSRobert Love struct fc_frame *fp); 49742e9a92fSRobert Love 49842e9a92fSRobert Love /* 4990ae4d4aeSRobert Love * Send an ELS response using infomation from a previous 5000ae4d4aeSRobert Love * exchange and sequence. 5010ae4d4aeSRobert Love * 5020ae4d4aeSRobert Love * STATUS: OPTIONAL 50342e9a92fSRobert Love */ 50442e9a92fSRobert Love void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, 50542e9a92fSRobert Love struct fc_seq_els_data *els_data); 50642e9a92fSRobert Love 50742e9a92fSRobert Love /* 50842e9a92fSRobert Love * Abort an exchange and sequence. Generally called because of a 50942e9a92fSRobert Love * exchange timeout or an abort from the upper layer. 51042e9a92fSRobert Love * 51142e9a92fSRobert Love * A timer_msec can be specified for abort timeout, if non-zero 51242e9a92fSRobert Love * timer_msec value is specified then exchange resp handler 51342e9a92fSRobert Love * will be called with timeout error if no response to abort. 5140ae4d4aeSRobert Love * 5150ae4d4aeSRobert Love * STATUS: OPTIONAL 51642e9a92fSRobert Love */ 51742e9a92fSRobert Love int (*seq_exch_abort)(const struct fc_seq *req_sp, 51842e9a92fSRobert Love unsigned int timer_msec); 51942e9a92fSRobert Love 52042e9a92fSRobert Love /* 52142e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 52242e9a92fSRobert Love * allocated for the related objects may be freed. 5230ae4d4aeSRobert Love * 5240ae4d4aeSRobert Love * STATUS: OPTIONAL 52542e9a92fSRobert Love */ 52642e9a92fSRobert Love void (*exch_done)(struct fc_seq *sp); 52742e9a92fSRobert Love 52842e9a92fSRobert Love /* 52942e9a92fSRobert Love * Start a new sequence on the same exchange/sequence tuple. 5300ae4d4aeSRobert Love * 5310ae4d4aeSRobert Love * STATUS: OPTIONAL 53242e9a92fSRobert Love */ 53342e9a92fSRobert Love struct fc_seq *(*seq_start_next)(struct fc_seq *sp); 53442e9a92fSRobert Love 53542e9a92fSRobert Love /* 53642e9a92fSRobert Love * Reset an exchange manager, completing all sequences and exchanges. 53742e9a92fSRobert Love * If s_id is non-zero, reset only exchanges originating from that FID. 53842e9a92fSRobert Love * If d_id is non-zero, reset only exchanges sending to that FID. 5390ae4d4aeSRobert Love * 5400ae4d4aeSRobert Love * STATUS: OPTIONAL 54142e9a92fSRobert Love */ 5421f6ff364SAbhijeet Joglekar void (*exch_mgr_reset)(struct fc_lport *, 54342e9a92fSRobert Love u32 s_id, u32 d_id); 54442e9a92fSRobert Love 5450ae4d4aeSRobert Love /* 5460ae4d4aeSRobert Love * Flush the rport work queue. Generally used before shutdown. 5470ae4d4aeSRobert Love * 5480ae4d4aeSRobert Love * STATUS: OPTIONAL 54942e9a92fSRobert Love */ 5500ae4d4aeSRobert Love void (*rport_flush_queue)(void); 55142e9a92fSRobert Love 55242e9a92fSRobert Love /* 5530ae4d4aeSRobert Love * Receive a frame for a local port. 5540ae4d4aeSRobert Love * 5550ae4d4aeSRobert Love * STATUS: OPTIONAL 55642e9a92fSRobert Love */ 55742e9a92fSRobert Love void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, 55842e9a92fSRobert Love struct fc_frame *fp); 55942e9a92fSRobert Love 5600ae4d4aeSRobert Love /* 5610ae4d4aeSRobert Love * Reset the local port. 5620ae4d4aeSRobert Love * 5630ae4d4aeSRobert Love * STATUS: OPTIONAL 56442e9a92fSRobert Love */ 5650ae4d4aeSRobert Love int (*lport_reset)(struct fc_lport *); 56642e9a92fSRobert Love 56742e9a92fSRobert Love /* 5685101ff99SRobert Love * Create a remote port 5695101ff99SRobert Love */ 570795d86f5SJoe Eykholt struct fc_rport *(*rport_create)(struct fc_lport *, 571795d86f5SJoe Eykholt struct fc_rport_identifiers *); 5725101ff99SRobert Love 5735101ff99SRobert Love /* 57442e9a92fSRobert Love * Initiates the RP state machine. It is called from the LP module. 57542e9a92fSRobert Love * This function will issue the following commands to the N_Port 57642e9a92fSRobert Love * identified by the FC ID provided. 57742e9a92fSRobert Love * 57842e9a92fSRobert Love * - PLOGI 57942e9a92fSRobert Love * - PRLI 58042e9a92fSRobert Love * - RTV 5810ae4d4aeSRobert Love * 5820ae4d4aeSRobert Love * STATUS: OPTIONAL 58342e9a92fSRobert Love */ 58442e9a92fSRobert Love int (*rport_login)(struct fc_rport *rport); 58542e9a92fSRobert Love 58642e9a92fSRobert Love /* 58742e9a92fSRobert Love * Logoff, and remove the rport from the transport if 58842e9a92fSRobert Love * it had been added. This will send a LOGO to the target. 5890ae4d4aeSRobert Love * 5900ae4d4aeSRobert Love * STATUS: OPTIONAL 59142e9a92fSRobert Love */ 59242e9a92fSRobert Love int (*rport_logoff)(struct fc_rport *rport); 59342e9a92fSRobert Love 59442e9a92fSRobert Love /* 59542e9a92fSRobert Love * Recieve a request from a remote port. 5960ae4d4aeSRobert Love * 5970ae4d4aeSRobert Love * STATUS: OPTIONAL 59842e9a92fSRobert Love */ 59942e9a92fSRobert Love void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 60042e9a92fSRobert Love struct fc_rport *); 60142e9a92fSRobert Love 6020ae4d4aeSRobert Love /* 6030ae4d4aeSRobert Love * lookup an rport by it's port ID. 6040ae4d4aeSRobert Love * 6050ae4d4aeSRobert Love * STATUS: OPTIONAL 60642e9a92fSRobert Love */ 6070ae4d4aeSRobert Love struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32); 60842e9a92fSRobert Love 60942e9a92fSRobert Love /* 61042e9a92fSRobert Love * Send a fcp cmd from fsp pkt. 61142e9a92fSRobert Love * Called with the SCSI host lock unlocked and irqs disabled. 61242e9a92fSRobert Love * 61342e9a92fSRobert Love * The resp handler is called when FCP_RSP received. 61442e9a92fSRobert Love * 6150ae4d4aeSRobert Love * STATUS: OPTIONAL 61642e9a92fSRobert Love */ 61742e9a92fSRobert Love int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, 61842e9a92fSRobert Love void (*resp)(struct fc_seq *, struct fc_frame *fp, 61942e9a92fSRobert Love void *arg)); 62042e9a92fSRobert Love 62142e9a92fSRobert Love /* 6220ae4d4aeSRobert Love * Cleanup the FCP layer, used durring link down and reset 6230ae4d4aeSRobert Love * 6240ae4d4aeSRobert Love * STATUS: OPTIONAL 62542e9a92fSRobert Love */ 62642e9a92fSRobert Love void (*fcp_cleanup)(struct fc_lport *lp); 62742e9a92fSRobert Love 62842e9a92fSRobert Love /* 62942e9a92fSRobert Love * Abort all I/O on a local port 6300ae4d4aeSRobert Love * 6310ae4d4aeSRobert Love * STATUS: OPTIONAL 63242e9a92fSRobert Love */ 63342e9a92fSRobert Love void (*fcp_abort_io)(struct fc_lport *lp); 63442e9a92fSRobert Love 6350ae4d4aeSRobert Love /* 6360ae4d4aeSRobert Love * Receive a request for the discovery layer. 6370ae4d4aeSRobert Love * 6380ae4d4aeSRobert Love * STATUS: OPTIONAL 63942e9a92fSRobert Love */ 64042e9a92fSRobert Love void (*disc_recv_req)(struct fc_seq *, 64142e9a92fSRobert Love struct fc_frame *, struct fc_lport *); 64242e9a92fSRobert Love 64342e9a92fSRobert Love /* 64442e9a92fSRobert Love * Start discovery for a local port. 6450ae4d4aeSRobert Love * 6460ae4d4aeSRobert Love * STATUS: OPTIONAL 64742e9a92fSRobert Love */ 64842e9a92fSRobert Love void (*disc_start)(void (*disc_callback)(struct fc_lport *, 64942e9a92fSRobert Love enum fc_disc_event), 65042e9a92fSRobert Love struct fc_lport *); 65142e9a92fSRobert Love 65242e9a92fSRobert Love /* 65342e9a92fSRobert Love * Stop discovery for a given lport. This will remove 65442e9a92fSRobert Love * all discovered rports 6550ae4d4aeSRobert Love * 6560ae4d4aeSRobert Love * STATUS: OPTIONAL 65742e9a92fSRobert Love */ 65842e9a92fSRobert Love void (*disc_stop) (struct fc_lport *); 65942e9a92fSRobert Love 66042e9a92fSRobert Love /* 66142e9a92fSRobert Love * Stop discovery for a given lport. This will block 66242e9a92fSRobert Love * until all discovered rports are deleted from the 66342e9a92fSRobert Love * FC transport class 6640ae4d4aeSRobert Love * 6650ae4d4aeSRobert Love * STATUS: OPTIONAL 66642e9a92fSRobert Love */ 66742e9a92fSRobert Love void (*disc_stop_final) (struct fc_lport *); 66842e9a92fSRobert Love }; 66942e9a92fSRobert Love 67042e9a92fSRobert Love /* information used by the discovery layer */ 67142e9a92fSRobert Love struct fc_disc { 67242e9a92fSRobert Love unsigned char retry_count; 67342e9a92fSRobert Love unsigned char delay; 67442e9a92fSRobert Love unsigned char pending; 67542e9a92fSRobert Love unsigned char requested; 67642e9a92fSRobert Love unsigned short seq_count; 67742e9a92fSRobert Love unsigned char buf_len; 67842e9a92fSRobert Love enum fc_disc_event event; 67942e9a92fSRobert Love 68042e9a92fSRobert Love void (*disc_callback)(struct fc_lport *, 68142e9a92fSRobert Love enum fc_disc_event); 68242e9a92fSRobert Love 68342e9a92fSRobert Love struct list_head rports; 684b4c6f546SAbhijeet Joglekar struct list_head rogue_rports; 68542e9a92fSRobert Love struct fc_lport *lport; 68642e9a92fSRobert Love struct mutex disc_mutex; 68742e9a92fSRobert Love struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ 68842e9a92fSRobert Love struct delayed_work disc_work; 68942e9a92fSRobert Love }; 69042e9a92fSRobert Love 69142e9a92fSRobert Love struct fc_lport { 69242e9a92fSRobert Love struct list_head list; 69342e9a92fSRobert Love 69442e9a92fSRobert Love /* Associations */ 69542e9a92fSRobert Love struct Scsi_Host *host; 69696316099SVasu Dev struct list_head ema_list; 69742e9a92fSRobert Love struct fc_rport *dns_rp; 69842e9a92fSRobert Love struct fc_rport *ptp_rp; 69942e9a92fSRobert Love void *scsi_priv; 70042e9a92fSRobert Love struct fc_disc disc; 70142e9a92fSRobert Love 70242e9a92fSRobert Love /* Operational Information */ 70342e9a92fSRobert Love struct libfc_function_template tt; 704bc0e17f6SVasu Dev u8 link_up; 705bc0e17f6SVasu Dev u8 qfull; 70642e9a92fSRobert Love enum fc_lport_state state; 70742e9a92fSRobert Love unsigned long boot_time; 70842e9a92fSRobert Love 70942e9a92fSRobert Love struct fc_host_statistics host_stats; 710582b45bcSRobert Love struct fcoe_dev_stats *dev_stats; 711582b45bcSRobert Love 71242e9a92fSRobert Love u64 wwpn; 71342e9a92fSRobert Love u64 wwnn; 71442e9a92fSRobert Love u8 retry_count; 71542e9a92fSRobert Love 71642e9a92fSRobert Love /* Capabilities */ 71742e9a92fSRobert Love u32 sg_supp:1; /* scatter gather supported */ 71842e9a92fSRobert Love u32 seq_offload:1; /* seq offload supported */ 71942e9a92fSRobert Love u32 crc_offload:1; /* crc offload supported */ 72042e9a92fSRobert Love u32 lro_enabled:1; /* large receive offload */ 72142e9a92fSRobert Love u32 mfs; /* max FC payload size */ 72242e9a92fSRobert Love unsigned int service_params; 72342e9a92fSRobert Love unsigned int e_d_tov; 72442e9a92fSRobert Love unsigned int r_a_tov; 72542e9a92fSRobert Love u8 max_retry_count; 726a3666955SAbhijeet Joglekar u8 max_rport_retry_count; 72742e9a92fSRobert Love u16 link_speed; 72842e9a92fSRobert Love u16 link_supported_speeds; 72942e9a92fSRobert Love u16 lro_xid; /* max xid for fcoe lro */ 730ea1e9a9dSYi Zou unsigned int lso_max; /* max large send size */ 73142e9a92fSRobert Love struct fc_ns_fts fcts; /* FC-4 type masks */ 73242e9a92fSRobert Love struct fc_els_rnid_gen rnid_gen; /* RNID information */ 73342e9a92fSRobert Love 73442e9a92fSRobert Love /* Semaphores */ 73542e9a92fSRobert Love struct mutex lp_mutex; 73642e9a92fSRobert Love 73742e9a92fSRobert Love /* Miscellaneous */ 73842e9a92fSRobert Love struct delayed_work retry_work; 73942e9a92fSRobert Love struct delayed_work disc_work; 74042e9a92fSRobert Love }; 74142e9a92fSRobert Love 74234f42a07SRobert Love /* 74342e9a92fSRobert Love * FC_LPORT HELPER FUNCTIONS 74442e9a92fSRobert Love *****************************/ 74542e9a92fSRobert Love static inline int fc_lport_test_ready(struct fc_lport *lp) 74642e9a92fSRobert Love { 74742e9a92fSRobert Love return lp->state == LPORT_ST_READY; 74842e9a92fSRobert Love } 74942e9a92fSRobert Love 75042e9a92fSRobert Love static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) 75142e9a92fSRobert Love { 75242e9a92fSRobert Love lp->wwnn = wwnn; 75342e9a92fSRobert Love } 75442e9a92fSRobert Love 75542e9a92fSRobert Love static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) 75642e9a92fSRobert Love { 75742e9a92fSRobert Love lp->wwpn = wwnn; 75842e9a92fSRobert Love } 75942e9a92fSRobert Love 76042e9a92fSRobert Love static inline void fc_lport_state_enter(struct fc_lport *lp, 76142e9a92fSRobert Love enum fc_lport_state state) 76242e9a92fSRobert Love { 76342e9a92fSRobert Love if (state != lp->state) 76442e9a92fSRobert Love lp->retry_count = 0; 76542e9a92fSRobert Love lp->state = state; 76642e9a92fSRobert Love } 76742e9a92fSRobert Love 768582b45bcSRobert Love static inline int fc_lport_init_stats(struct fc_lport *lp) 769582b45bcSRobert Love { 770582b45bcSRobert Love /* allocate per cpu stats block */ 771582b45bcSRobert Love lp->dev_stats = alloc_percpu(struct fcoe_dev_stats); 772582b45bcSRobert Love if (!lp->dev_stats) 773582b45bcSRobert Love return -ENOMEM; 774582b45bcSRobert Love return 0; 775582b45bcSRobert Love } 776582b45bcSRobert Love 777582b45bcSRobert Love static inline void fc_lport_free_stats(struct fc_lport *lp) 778582b45bcSRobert Love { 779582b45bcSRobert Love free_percpu(lp->dev_stats); 780582b45bcSRobert Love } 781582b45bcSRobert Love 782582b45bcSRobert Love static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp) 783582b45bcSRobert Love { 784582b45bcSRobert Love return per_cpu_ptr(lp->dev_stats, smp_processor_id()); 785582b45bcSRobert Love } 786582b45bcSRobert Love 787a0a25da2SVasu Dev static inline void *lport_priv(const struct fc_lport *lp) 788a0a25da2SVasu Dev { 789a0a25da2SVasu Dev return (void *)(lp + 1); 790a0a25da2SVasu Dev } 791a0a25da2SVasu Dev 792a0a25da2SVasu Dev /** 793a0a25da2SVasu Dev * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport 794a0a25da2SVasu Dev * @sht: ptr to the scsi host templ 795a0a25da2SVasu Dev * @priv_size: size of private data after fc_lport 796a0a25da2SVasu Dev * 797a0a25da2SVasu Dev * Returns: ptr to Scsi_Host 798a0a25da2SVasu Dev */ 799a0a25da2SVasu Dev static inline struct Scsi_Host * 800a0a25da2SVasu Dev libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 801a0a25da2SVasu Dev { 802a0a25da2SVasu Dev return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size); 803a0a25da2SVasu Dev } 80442e9a92fSRobert Love 80534f42a07SRobert Love /* 80642e9a92fSRobert Love * LOCAL PORT LAYER 80742e9a92fSRobert Love *****************************/ 80842e9a92fSRobert Love int fc_lport_init(struct fc_lport *lp); 80942e9a92fSRobert Love 81042e9a92fSRobert Love /* 81142e9a92fSRobert Love * Destroy the specified local port by finding and freeing all 81242e9a92fSRobert Love * fc_rports associated with it and then by freeing the fc_lport 81342e9a92fSRobert Love * itself. 81442e9a92fSRobert Love */ 81542e9a92fSRobert Love int fc_lport_destroy(struct fc_lport *lp); 81642e9a92fSRobert Love 81742e9a92fSRobert Love /* 81842e9a92fSRobert Love * Logout the specified local port from the fabric 81942e9a92fSRobert Love */ 82042e9a92fSRobert Love int fc_fabric_logoff(struct fc_lport *lp); 82142e9a92fSRobert Love 82242e9a92fSRobert Love /* 82342e9a92fSRobert Love * Initiate the LP state machine. This handler will use fc_host_attr 82442e9a92fSRobert Love * to store the FLOGI service parameters, so fc_host_attr must be 82542e9a92fSRobert Love * initialized before calling this handler. 82642e9a92fSRobert Love */ 82742e9a92fSRobert Love int fc_fabric_login(struct fc_lport *lp); 82842e9a92fSRobert Love 82942e9a92fSRobert Love /* 83042e9a92fSRobert Love * The link is up for the given local port. 83142e9a92fSRobert Love */ 83242e9a92fSRobert Love void fc_linkup(struct fc_lport *); 83342e9a92fSRobert Love 83442e9a92fSRobert Love /* 83542e9a92fSRobert Love * Link is down for the given local port. 83642e9a92fSRobert Love */ 83742e9a92fSRobert Love void fc_linkdown(struct fc_lport *); 83842e9a92fSRobert Love 83942e9a92fSRobert Love /* 84042e9a92fSRobert Love * Configure the local port. 84142e9a92fSRobert Love */ 84242e9a92fSRobert Love int fc_lport_config(struct fc_lport *); 84342e9a92fSRobert Love 84442e9a92fSRobert Love /* 84542e9a92fSRobert Love * Reset the local port. 84642e9a92fSRobert Love */ 84742e9a92fSRobert Love int fc_lport_reset(struct fc_lport *); 84842e9a92fSRobert Love 84942e9a92fSRobert Love /* 85042e9a92fSRobert Love * Set the mfs or reset 85142e9a92fSRobert Love */ 85242e9a92fSRobert Love int fc_set_mfs(struct fc_lport *lp, u32 mfs); 85342e9a92fSRobert Love 85442e9a92fSRobert Love 85534f42a07SRobert Love /* 85642e9a92fSRobert Love * REMOTE PORT LAYER 85742e9a92fSRobert Love *****************************/ 85842e9a92fSRobert Love int fc_rport_init(struct fc_lport *lp); 85942e9a92fSRobert Love void fc_rport_terminate_io(struct fc_rport *rp); 86042e9a92fSRobert Love 86134f42a07SRobert Love /* 86242e9a92fSRobert Love * DISCOVERY LAYER 86342e9a92fSRobert Love *****************************/ 86442e9a92fSRobert Love int fc_disc_init(struct fc_lport *lp); 86542e9a92fSRobert Love 86642e9a92fSRobert Love 86734f42a07SRobert Love /* 86842e9a92fSRobert Love * SCSI LAYER 86942e9a92fSRobert Love *****************************/ 87042e9a92fSRobert Love /* 87142e9a92fSRobert Love * Initialize the SCSI block of libfc 87242e9a92fSRobert Love */ 87342e9a92fSRobert Love int fc_fcp_init(struct fc_lport *); 87442e9a92fSRobert Love 87542e9a92fSRobert Love /* 87642e9a92fSRobert Love * This section provides an API which allows direct interaction 87742e9a92fSRobert Love * with the SCSI-ml. Each of these functions satisfies a function 87842e9a92fSRobert Love * pointer defined in Scsi_Host and therefore is always called 87942e9a92fSRobert Love * directly from the SCSI-ml. 88042e9a92fSRobert Love */ 88142e9a92fSRobert Love int fc_queuecommand(struct scsi_cmnd *sc_cmd, 88242e9a92fSRobert Love void (*done)(struct scsi_cmnd *)); 88342e9a92fSRobert Love 88442e9a92fSRobert Love /* 88542e9a92fSRobert Love * complete processing of a fcp packet 88642e9a92fSRobert Love * 88742e9a92fSRobert Love * This function may sleep if a fsp timer is pending. 88842e9a92fSRobert Love * The host lock must not be held by caller. 88942e9a92fSRobert Love */ 89042e9a92fSRobert Love void fc_fcp_complete(struct fc_fcp_pkt *fsp); 89142e9a92fSRobert Love 89242e9a92fSRobert Love /* 89342e9a92fSRobert Love * Send an ABTS frame to the target device. The sc_cmd argument 89442e9a92fSRobert Love * is a pointer to the SCSI command to be aborted. 89542e9a92fSRobert Love */ 89642e9a92fSRobert Love int fc_eh_abort(struct scsi_cmnd *sc_cmd); 89742e9a92fSRobert Love 89842e9a92fSRobert Love /* 89942e9a92fSRobert Love * Reset a LUN by sending send the tm cmd to the target. 90042e9a92fSRobert Love */ 90142e9a92fSRobert Love int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); 90242e9a92fSRobert Love 90342e9a92fSRobert Love /* 90442e9a92fSRobert Love * Reset the host adapter. 90542e9a92fSRobert Love */ 90642e9a92fSRobert Love int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); 90742e9a92fSRobert Love 90842e9a92fSRobert Love /* 90942e9a92fSRobert Love * Check rport status. 91042e9a92fSRobert Love */ 91142e9a92fSRobert Love int fc_slave_alloc(struct scsi_device *sdev); 91242e9a92fSRobert Love 91342e9a92fSRobert Love /* 91442e9a92fSRobert Love * Adjust the queue depth. 91542e9a92fSRobert Love */ 91642e9a92fSRobert Love int fc_change_queue_depth(struct scsi_device *sdev, int qdepth); 91742e9a92fSRobert Love 91842e9a92fSRobert Love /* 91942e9a92fSRobert Love * Change the tag type. 92042e9a92fSRobert Love */ 92142e9a92fSRobert Love int fc_change_queue_type(struct scsi_device *sdev, int tag_type); 92242e9a92fSRobert Love 92342e9a92fSRobert Love /* 92442e9a92fSRobert Love * Free memory pools used by the FCP layer. 92542e9a92fSRobert Love */ 92642e9a92fSRobert Love void fc_fcp_destroy(struct fc_lport *); 92742e9a92fSRobert Love 92834f42a07SRobert Love /* 929b277d2aaSYi Zou * Set up direct-data placement for this I/O request 930b277d2aaSYi Zou */ 931b277d2aaSYi Zou void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid); 932b277d2aaSYi Zou 933b277d2aaSYi Zou /* 93442e9a92fSRobert Love * ELS/CT interface 93542e9a92fSRobert Love *****************************/ 93642e9a92fSRobert Love /* 93742e9a92fSRobert Love * Initializes ELS/CT interface 93842e9a92fSRobert Love */ 93942e9a92fSRobert Love int fc_elsct_init(struct fc_lport *lp); 94042e9a92fSRobert Love 94142e9a92fSRobert Love 94234f42a07SRobert Love /* 94342e9a92fSRobert Love * EXCHANGE MANAGER LAYER 94442e9a92fSRobert Love *****************************/ 94542e9a92fSRobert Love /* 94642e9a92fSRobert Love * Initializes Exchange Manager related 94742e9a92fSRobert Love * function pointers in struct libfc_function_template. 94842e9a92fSRobert Love */ 94942e9a92fSRobert Love int fc_exch_init(struct fc_lport *lp); 95042e9a92fSRobert Love 95142e9a92fSRobert Love /* 95296316099SVasu Dev * Adds Exchange Manager (EM) mp to lport. 95396316099SVasu Dev * 95496316099SVasu Dev * Adds specified mp to lport using struct fc_exch_mgr_anchor, 95596316099SVasu Dev * the struct fc_exch_mgr_anchor allows same EM sharing by 95696316099SVasu Dev * more than one lport with their specified match function, 95796316099SVasu Dev * the match function is used in allocating exchange from 95896316099SVasu Dev * added mp. 95996316099SVasu Dev */ 96096316099SVasu Dev struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport, 96196316099SVasu Dev struct fc_exch_mgr *mp, 96296316099SVasu Dev bool (*match)(struct fc_frame *)); 96396316099SVasu Dev 96496316099SVasu Dev /* 96596316099SVasu Dev * Deletes Exchange Manager (EM) from lport by removing 96696316099SVasu Dev * its anchor ema from lport. 96796316099SVasu Dev * 96896316099SVasu Dev * If removed anchor ema was the last user of its associated EM 96996316099SVasu Dev * then also destroys associated EM. 97096316099SVasu Dev */ 97196316099SVasu Dev void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema); 97296316099SVasu Dev 97396316099SVasu Dev /* 97442e9a92fSRobert Love * Allocates an Exchange Manager (EM). 97542e9a92fSRobert Love * 97642e9a92fSRobert Love * The EM manages exchanges for their allocation and 97742e9a92fSRobert Love * free, also allows exchange lookup for received 97842e9a92fSRobert Love * frame. 97942e9a92fSRobert Love * 98042e9a92fSRobert Love * The class is used for initializing FC class of 98142e9a92fSRobert Love * allocated exchange from EM. 98242e9a92fSRobert Love * 98342e9a92fSRobert Love * The min_xid and max_xid will limit new 98442e9a92fSRobert Love * exchange ID (XID) within this range for 98542e9a92fSRobert Love * a new exchange. 98642e9a92fSRobert Love * The LLD may choose to have multiple EMs, 98742e9a92fSRobert Love * e.g. one EM instance per CPU receive thread in LLD. 98842e9a92fSRobert Love * 98952ff878cSVasu Dev * Specified match function is used in allocating exchanges 99052ff878cSVasu Dev * from newly allocated EM. 99142e9a92fSRobert Love */ 99242e9a92fSRobert Love struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, 99342e9a92fSRobert Love enum fc_class class, 99442e9a92fSRobert Love u16 min_xid, 99552ff878cSVasu Dev u16 max_xid, 99652ff878cSVasu Dev bool (*match)(struct fc_frame *)); 99742e9a92fSRobert Love 99842e9a92fSRobert Love /* 99952ff878cSVasu Dev * Free all exchange managers of a lport. 100042e9a92fSRobert Love */ 100152ff878cSVasu Dev void fc_exch_mgr_free(struct fc_lport *lport); 100242e9a92fSRobert Love 100342e9a92fSRobert Love /* 100442e9a92fSRobert Love * Receive a frame on specified local port and exchange manager. 100542e9a92fSRobert Love */ 100652ff878cSVasu Dev void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp); 100742e9a92fSRobert Love 100842e9a92fSRobert Love /* 100942e9a92fSRobert Love * This function is for exch_seq_send function pointer in 101042e9a92fSRobert Love * struct libfc_function_template, see comment block on 101142e9a92fSRobert Love * exch_seq_send for description of this function. 101242e9a92fSRobert Love */ 101342e9a92fSRobert Love struct fc_seq *fc_exch_seq_send(struct fc_lport *lp, 101442e9a92fSRobert Love struct fc_frame *fp, 101542e9a92fSRobert Love void (*resp)(struct fc_seq *sp, 101642e9a92fSRobert Love struct fc_frame *fp, 101742e9a92fSRobert Love void *arg), 101842e9a92fSRobert Love void (*destructor)(struct fc_seq *sp, 101942e9a92fSRobert Love void *arg), 102042e9a92fSRobert Love void *arg, u32 timer_msec); 102142e9a92fSRobert Love 102242e9a92fSRobert Love /* 102342e9a92fSRobert Love * send a frame using existing sequence and exchange. 102442e9a92fSRobert Love */ 102542e9a92fSRobert Love int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp); 102642e9a92fSRobert Love 102742e9a92fSRobert Love /* 102842e9a92fSRobert Love * Send ELS response using mainly infomation 102942e9a92fSRobert Love * in exchange and sequence in EM layer. 103042e9a92fSRobert Love */ 103142e9a92fSRobert Love void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd, 103242e9a92fSRobert Love struct fc_seq_els_data *els_data); 103342e9a92fSRobert Love 103442e9a92fSRobert Love /* 103542e9a92fSRobert Love * This function is for seq_exch_abort function pointer in 103642e9a92fSRobert Love * struct libfc_function_template, see comment block on 103742e9a92fSRobert Love * seq_exch_abort for description of this function. 103842e9a92fSRobert Love */ 103942e9a92fSRobert Love int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec); 104042e9a92fSRobert Love 104142e9a92fSRobert Love /* 104242e9a92fSRobert Love * Indicate that an exchange/sequence tuple is complete and the memory 104342e9a92fSRobert Love * allocated for the related objects may be freed. 104442e9a92fSRobert Love */ 104542e9a92fSRobert Love void fc_exch_done(struct fc_seq *sp); 104642e9a92fSRobert Love 104742e9a92fSRobert Love /* 104842e9a92fSRobert Love * Allocate a new exchange and sequence pair. 104942e9a92fSRobert Love */ 105052ff878cSVasu Dev struct fc_exch *fc_exch_alloc(struct fc_lport *lport, struct fc_frame *fp); 105142e9a92fSRobert Love /* 105242e9a92fSRobert Love * Start a new sequence on the same exchange as the supplied sequence. 105342e9a92fSRobert Love */ 105442e9a92fSRobert Love struct fc_seq *fc_seq_start_next(struct fc_seq *sp); 105542e9a92fSRobert Love 1056b2f0091fSVasu Dev 105742e9a92fSRobert Love /* 1058b2f0091fSVasu Dev * Reset all EMs of a lport, releasing its all sequences and 1059b2f0091fSVasu Dev * exchanges. If sid is non-zero, then reset only exchanges 1060b2f0091fSVasu Dev * we sourced from that FID. If did is non-zero, reset only 1061b2f0091fSVasu Dev * exchanges destined to that FID. 106242e9a92fSRobert Love */ 10631f6ff364SAbhijeet Joglekar void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 106442e9a92fSRobert Love 106542e9a92fSRobert Love /* 106642e9a92fSRobert Love * Functions for fc_functions_template 106742e9a92fSRobert Love */ 106842e9a92fSRobert Love void fc_get_host_speed(struct Scsi_Host *shost); 106942e9a92fSRobert Love void fc_get_host_port_type(struct Scsi_Host *shost); 107042e9a92fSRobert Love void fc_get_host_port_state(struct Scsi_Host *shost); 107142e9a92fSRobert Love void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); 107242e9a92fSRobert Love struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 107342e9a92fSRobert Love 107442e9a92fSRobert Love /* 107542e9a92fSRobert Love * module setup functions. 107642e9a92fSRobert Love */ 107742e9a92fSRobert Love int fc_setup_exch_mgr(void); 107842e9a92fSRobert Love void fc_destroy_exch_mgr(void); 107942e9a92fSRobert Love int fc_setup_rport(void); 108042e9a92fSRobert Love void fc_destroy_rport(void); 108142e9a92fSRobert Love 108242e9a92fSRobert Love #endif /* _LIBFC_H_ */ 1083