Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright(c) 2007 Intel Corporation. All rights reserved. |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify it |
| 5 | * under the terms and conditions of the GNU General Public License, |
| 6 | * version 2, as published by the Free Software Foundation. |
| 7 | * |
| 8 | * This program is distributed in the hope it will be useful, but WITHOUT |
| 9 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 10 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 11 | * more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU General Public License along with |
| 14 | * this program; if not, write to the Free Software Foundation, Inc., |
| 15 | * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. |
| 16 | * |
| 17 | * Maintained at www.Open-FCoE.org |
| 18 | */ |
| 19 | |
| 20 | #ifndef _LIBFC_H_ |
| 21 | #define _LIBFC_H_ |
| 22 | |
| 23 | #include <linux/timer.h> |
| 24 | #include <linux/if.h> |
Robert Love | 582b45b | 2009-03-31 15:51:50 -0700 | [diff] [blame] | 25 | #include <linux/percpu.h> |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 26 | |
| 27 | #include <scsi/scsi_transport.h> |
| 28 | #include <scsi/scsi_transport_fc.h> |
| 29 | |
| 30 | #include <scsi/fc/fc_fcp.h> |
| 31 | #include <scsi/fc/fc_ns.h> |
| 32 | #include <scsi/fc/fc_els.h> |
| 33 | #include <scsi/fc/fc_gs.h> |
| 34 | |
| 35 | #include <scsi/fc_frame.h> |
| 36 | |
| 37 | #define LIBFC_DEBUG |
| 38 | |
| 39 | #ifdef LIBFC_DEBUG |
| 40 | /* Log messages */ |
| 41 | #define FC_DBG(fmt, args...) \ |
| 42 | do { \ |
| 43 | printk(KERN_INFO "%s " fmt, __func__, ##args); \ |
| 44 | } while (0) |
| 45 | #else |
| 46 | #define FC_DBG(fmt, args...) |
| 47 | #endif |
| 48 | |
| 49 | /* |
| 50 | * libfc error codes |
| 51 | */ |
| 52 | #define FC_NO_ERR 0 /* no error */ |
| 53 | #define FC_EX_TIMEOUT 1 /* Exchange timeout */ |
| 54 | #define FC_EX_CLOSED 2 /* Exchange closed */ |
| 55 | |
| 56 | /* some helpful macros */ |
| 57 | |
| 58 | #define ntohll(x) be64_to_cpu(x) |
| 59 | #define htonll(x) cpu_to_be64(x) |
| 60 | |
| 61 | #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) |
| 62 | |
| 63 | #define hton24(p, v) do { \ |
| 64 | p[0] = (((v) >> 16) & 0xFF); \ |
| 65 | p[1] = (((v) >> 8) & 0xFF); \ |
| 66 | p[2] = ((v) & 0xFF); \ |
| 67 | } while (0) |
| 68 | |
| 69 | /* |
| 70 | * FC HBA status |
| 71 | */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 72 | enum fc_lport_state { |
| 73 | LPORT_ST_NONE = 0, |
| 74 | LPORT_ST_FLOGI, |
| 75 | LPORT_ST_DNS, |
| 76 | LPORT_ST_RPN_ID, |
| 77 | LPORT_ST_RFT_ID, |
| 78 | LPORT_ST_SCR, |
| 79 | LPORT_ST_READY, |
| 80 | LPORT_ST_LOGO, |
| 81 | LPORT_ST_RESET |
| 82 | }; |
| 83 | |
| 84 | enum fc_disc_event { |
| 85 | DISC_EV_NONE = 0, |
| 86 | DISC_EV_SUCCESS, |
| 87 | DISC_EV_FAILED |
| 88 | }; |
| 89 | |
| 90 | enum fc_rport_state { |
| 91 | RPORT_ST_NONE = 0, |
| 92 | RPORT_ST_INIT, /* initialized */ |
| 93 | RPORT_ST_PLOGI, /* waiting for PLOGI completion */ |
| 94 | RPORT_ST_PRLI, /* waiting for PRLI completion */ |
| 95 | RPORT_ST_RTV, /* waiting for RTV completion */ |
| 96 | RPORT_ST_READY, /* ready for use */ |
| 97 | RPORT_ST_LOGO, /* port logout sent */ |
| 98 | }; |
| 99 | |
| 100 | enum fc_rport_trans_state { |
| 101 | FC_PORTSTATE_ROGUE, |
| 102 | FC_PORTSTATE_REAL, |
| 103 | }; |
| 104 | |
| 105 | /** |
| 106 | * struct fc_disc_port - temporary discovery port to hold rport identifiers |
| 107 | * @lp: Fibre Channel host port instance |
| 108 | * @peers: node for list management during discovery and RSCN processing |
| 109 | * @ids: identifiers structure to pass to fc_remote_port_add() |
| 110 | * @rport_work: work struct for starting the rport state machine |
| 111 | */ |
| 112 | struct fc_disc_port { |
| 113 | struct fc_lport *lp; |
| 114 | struct list_head peers; |
| 115 | struct fc_rport_identifiers ids; |
| 116 | struct work_struct rport_work; |
| 117 | }; |
| 118 | |
| 119 | enum fc_rport_event { |
| 120 | RPORT_EV_NONE = 0, |
| 121 | RPORT_EV_CREATED, |
| 122 | RPORT_EV_FAILED, |
| 123 | RPORT_EV_STOP, |
| 124 | RPORT_EV_LOGO |
| 125 | }; |
| 126 | |
| 127 | struct fc_rport_operations { |
| 128 | void (*event_callback)(struct fc_lport *, struct fc_rport *, |
| 129 | enum fc_rport_event); |
| 130 | }; |
| 131 | |
| 132 | /** |
| 133 | * struct fc_rport_libfc_priv - libfc internal information about a remote port |
| 134 | * @local_port: Fibre Channel host port instance |
| 135 | * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges |
| 136 | * @flags: REC and RETRY supported flags |
| 137 | * @max_seq: maximum number of concurrent sequences |
| 138 | * @retries: retry count in current state |
| 139 | * @e_d_tov: error detect timeout value (in msec) |
| 140 | * @r_a_tov: resource allocation timeout value (in msec) |
| 141 | * @rp_mutex: mutex protects rport |
| 142 | * @retry_work: |
| 143 | * @event_callback: Callback for rport READY, FAILED or LOGO |
| 144 | */ |
| 145 | struct fc_rport_libfc_priv { |
| 146 | struct fc_lport *local_port; |
| 147 | enum fc_rport_state rp_state; |
| 148 | u16 flags; |
| 149 | #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) |
| 150 | #define FC_RP_FLAGS_RETRY (1 << 1) |
| 151 | u16 max_seq; |
| 152 | unsigned int retries; |
| 153 | unsigned int e_d_tov; |
| 154 | unsigned int r_a_tov; |
| 155 | enum fc_rport_trans_state trans_state; |
| 156 | struct mutex rp_mutex; |
| 157 | struct delayed_work retry_work; |
| 158 | enum fc_rport_event event; |
| 159 | struct fc_rport_operations *ops; |
| 160 | struct list_head peers; |
| 161 | struct work_struct event_work; |
| 162 | }; |
| 163 | |
| 164 | #define PRIV_TO_RPORT(x) \ |
| 165 | (struct fc_rport *)((void *)x - sizeof(struct fc_rport)); |
| 166 | #define RPORT_TO_PRIV(x) \ |
| 167 | (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport)); |
| 168 | |
| 169 | struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *); |
| 170 | |
| 171 | static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn) |
| 172 | { |
| 173 | rport->node_name = wwnn; |
| 174 | rport->port_name = wwpn; |
| 175 | } |
| 176 | |
| 177 | /* |
| 178 | * fcoe stats structure |
| 179 | */ |
| 180 | struct fcoe_dev_stats { |
| 181 | u64 SecondsSinceLastReset; |
| 182 | u64 TxFrames; |
| 183 | u64 TxWords; |
| 184 | u64 RxFrames; |
| 185 | u64 RxWords; |
| 186 | u64 ErrorFrames; |
| 187 | u64 DumpedFrames; |
| 188 | u64 LinkFailureCount; |
| 189 | u64 LossOfSignalCount; |
| 190 | u64 InvalidTxWordCount; |
| 191 | u64 InvalidCRCCount; |
| 192 | u64 InputRequests; |
| 193 | u64 OutputRequests; |
| 194 | u64 ControlRequests; |
| 195 | u64 InputMegabytes; |
| 196 | u64 OutputMegabytes; |
| 197 | }; |
| 198 | |
| 199 | /* |
| 200 | * els data is used for passing ELS respone specific |
| 201 | * data to send ELS response mainly using infomation |
| 202 | * in exchange and sequence in EM layer. |
| 203 | */ |
| 204 | struct fc_seq_els_data { |
| 205 | struct fc_frame *fp; |
| 206 | enum fc_els_rjt_reason reason; |
| 207 | enum fc_els_rjt_explan explan; |
| 208 | }; |
| 209 | |
| 210 | /* |
| 211 | * FCP request structure, one for each scsi cmd request |
| 212 | */ |
| 213 | struct fc_fcp_pkt { |
| 214 | /* |
| 215 | * housekeeping stuff |
| 216 | */ |
| 217 | struct fc_lport *lp; /* handle to hba struct */ |
| 218 | u16 state; /* scsi_pkt state state */ |
| 219 | u16 tgt_flags; /* target flags */ |
| 220 | atomic_t ref_cnt; /* fcp pkt ref count */ |
| 221 | spinlock_t scsi_pkt_lock; /* Must be taken before the host lock |
| 222 | * if both are held at the same time */ |
| 223 | /* |
| 224 | * SCSI I/O related stuff |
| 225 | */ |
| 226 | struct scsi_cmnd *cmd; /* scsi command pointer. set/clear |
| 227 | * under host lock */ |
| 228 | struct list_head list; /* tracks queued commands. access under |
| 229 | * host lock */ |
| 230 | /* |
| 231 | * timeout related stuff |
| 232 | */ |
| 233 | struct timer_list timer; /* command timer */ |
| 234 | struct completion tm_done; |
| 235 | int wait_for_comp; |
| 236 | unsigned long start_time; /* start jiffie */ |
| 237 | unsigned long end_time; /* end jiffie */ |
| 238 | unsigned long last_pkt_time; /* jiffies of last frame received */ |
| 239 | |
| 240 | /* |
| 241 | * scsi cmd and data transfer information |
| 242 | */ |
| 243 | u32 data_len; |
| 244 | /* |
| 245 | * transport related veriables |
| 246 | */ |
| 247 | struct fcp_cmnd cdb_cmd; |
| 248 | size_t xfer_len; |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 249 | u16 xfer_ddp; /* this xfer is ddped */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 250 | u32 xfer_contig_end; /* offset of end of contiguous xfer */ |
| 251 | u16 max_payload; /* max payload size in bytes */ |
| 252 | |
| 253 | /* |
| 254 | * scsi/fcp return status |
| 255 | */ |
| 256 | u32 io_status; /* SCSI result upper 24 bits */ |
| 257 | u8 cdb_status; |
| 258 | u8 status_code; /* FCP I/O status */ |
| 259 | /* bit 3 Underrun bit 2: overrun */ |
| 260 | u8 scsi_comp_flags; |
| 261 | u32 req_flags; /* bit 0: read bit:1 write */ |
| 262 | u32 scsi_resid; /* residule length */ |
| 263 | |
| 264 | struct fc_rport *rport; /* remote port pointer */ |
| 265 | struct fc_seq *seq_ptr; /* current sequence pointer */ |
| 266 | /* |
| 267 | * Error Processing |
| 268 | */ |
| 269 | u8 recov_retry; /* count of recovery retries */ |
| 270 | struct fc_seq *recov_seq; /* sequence for REC or SRR */ |
| 271 | }; |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 272 | /* |
| 273 | * FC_FCP HELPER FUNCTIONS |
| 274 | *****************************/ |
| 275 | static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) |
| 276 | { |
| 277 | if (fsp && fsp->cmd) |
| 278 | return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; |
| 279 | return false; |
| 280 | } |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 281 | |
| 282 | /* |
| 283 | * Structure and function definitions for managing Fibre Channel Exchanges |
| 284 | * and Sequences |
| 285 | * |
| 286 | * fc_exch holds state for one exchange and links to its active sequence. |
| 287 | * |
| 288 | * fc_seq holds the state for an individual sequence. |
| 289 | */ |
| 290 | |
| 291 | struct fc_exch_mgr; |
| 292 | |
| 293 | /* |
| 294 | * Sequence. |
| 295 | */ |
| 296 | struct fc_seq { |
| 297 | u8 id; /* seq ID */ |
| 298 | u16 ssb_stat; /* status flags for sequence status block */ |
| 299 | u16 cnt; /* frames sent so far on sequence */ |
| 300 | u32 rec_data; /* FC-4 value for REC */ |
| 301 | }; |
| 302 | |
| 303 | #define FC_EX_DONE (1 << 0) /* ep is completed */ |
| 304 | #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ |
| 305 | |
| 306 | /* |
| 307 | * Exchange. |
| 308 | * |
| 309 | * Locking notes: The ex_lock protects following items: |
| 310 | * state, esb_stat, f_ctl, seq.ssb_stat |
| 311 | * seq_id |
| 312 | * sequence allocation |
| 313 | */ |
| 314 | struct fc_exch { |
| 315 | struct fc_exch_mgr *em; /* exchange manager */ |
| 316 | u32 state; /* internal driver state */ |
| 317 | u16 xid; /* our exchange ID */ |
| 318 | struct list_head ex_list; /* free or busy list linkage */ |
| 319 | spinlock_t ex_lock; /* lock covering exchange state */ |
| 320 | atomic_t ex_refcnt; /* reference counter */ |
| 321 | struct delayed_work timeout_work; /* timer for upper level protocols */ |
| 322 | struct fc_lport *lp; /* fc device instance */ |
| 323 | u16 oxid; /* originator's exchange ID */ |
| 324 | u16 rxid; /* responder's exchange ID */ |
| 325 | u32 oid; /* originator's FCID */ |
| 326 | u32 sid; /* source FCID */ |
| 327 | u32 did; /* destination FCID */ |
| 328 | u32 esb_stat; /* exchange status for ESB */ |
| 329 | u32 r_a_tov; /* r_a_tov from rport (msec) */ |
| 330 | u8 seq_id; /* next sequence ID to use */ |
| 331 | u32 f_ctl; /* F_CTL flags for sequences */ |
| 332 | u8 fh_type; /* frame type */ |
| 333 | enum fc_class class; /* class of service */ |
| 334 | struct fc_seq seq; /* single sequence */ |
| 335 | /* |
| 336 | * Handler for responses to this current exchange. |
| 337 | */ |
| 338 | void (*resp)(struct fc_seq *, struct fc_frame *, void *); |
| 339 | void (*destructor)(struct fc_seq *, void *); |
| 340 | /* |
| 341 | * arg is passed as void pointer to exchange |
| 342 | * resp and destructor handlers |
| 343 | */ |
| 344 | void *arg; |
| 345 | }; |
| 346 | #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) |
| 347 | |
| 348 | struct libfc_function_template { |
| 349 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 350 | /* |
| 351 | * Interface to send a FC frame |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 352 | * |
| 353 | * STATUS: REQUIRED |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 354 | */ |
| 355 | int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); |
| 356 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 357 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 358 | * Interface to send ELS/CT frames |
| 359 | * |
| 360 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 361 | */ |
| 362 | struct fc_seq *(*elsct_send)(struct fc_lport *lport, |
| 363 | struct fc_rport *rport, |
| 364 | struct fc_frame *fp, |
| 365 | unsigned int op, |
| 366 | void (*resp)(struct fc_seq *, |
| 367 | struct fc_frame *fp, |
| 368 | void *arg), |
| 369 | void *arg, u32 timer_msec); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 370 | |
| 371 | /* |
| 372 | * Send the FC frame payload using a new exchange and sequence. |
| 373 | * |
| 374 | * The frame pointer with some of the header's fields must be |
| 375 | * filled before calling exch_seq_send(), those fields are, |
| 376 | * |
| 377 | * - routing control |
| 378 | * - FC port did |
| 379 | * - FC port sid |
| 380 | * - FC header type |
| 381 | * - frame control |
| 382 | * - parameter or relative offset |
| 383 | * |
| 384 | * The exchange response handler is set in this routine to resp() |
| 385 | * function pointer. It can be called in two scenarios: if a timeout |
| 386 | * occurs or if a response frame is received for the exchange. The |
| 387 | * fc_frame pointer in response handler will also indicate timeout |
| 388 | * as error using IS_ERR related macros. |
| 389 | * |
| 390 | * The exchange destructor handler is also set in this routine. |
| 391 | * The destructor handler is invoked by EM layer when exchange |
| 392 | * is about to free, this can be used by caller to free its |
| 393 | * resources along with exchange free. |
| 394 | * |
| 395 | * The arg is passed back to resp and destructor handler. |
| 396 | * |
| 397 | * The timeout value (in msec) for an exchange is set if non zero |
| 398 | * timer_msec argument is specified. The timer is canceled when |
| 399 | * it fires or when the exchange is done. The exchange timeout handler |
| 400 | * is registered by EM layer. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 401 | * |
| 402 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 403 | */ |
| 404 | struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, |
| 405 | struct fc_frame *fp, |
| 406 | void (*resp)(struct fc_seq *sp, |
| 407 | struct fc_frame *fp, |
| 408 | void *arg), |
| 409 | void (*destructor)(struct fc_seq *sp, |
| 410 | void *arg), |
| 411 | void *arg, unsigned int timer_msec); |
| 412 | |
| 413 | /* |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 414 | * Sets up the DDP context for a given exchange id on the given |
| 415 | * scatterlist if LLD supports DDP for large receive. |
| 416 | * |
| 417 | * STATUS: OPTIONAL |
| 418 | */ |
| 419 | int (*ddp_setup)(struct fc_lport *lp, u16 xid, |
| 420 | struct scatterlist *sgl, unsigned int sgc); |
| 421 | /* |
| 422 | * Completes the DDP transfer and returns the length of data DDPed |
| 423 | * for the given exchange id. |
| 424 | * |
| 425 | * STATUS: OPTIONAL |
| 426 | */ |
| 427 | int (*ddp_done)(struct fc_lport *lp, u16 xid); |
| 428 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 429 | * Send a frame using an existing sequence and exchange. |
| 430 | * |
| 431 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 432 | */ |
| 433 | int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, |
| 434 | struct fc_frame *fp); |
| 435 | |
| 436 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 437 | * Send an ELS response using infomation from a previous |
| 438 | * exchange and sequence. |
| 439 | * |
| 440 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 441 | */ |
| 442 | void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, |
| 443 | struct fc_seq_els_data *els_data); |
| 444 | |
| 445 | /* |
| 446 | * Abort an exchange and sequence. Generally called because of a |
| 447 | * exchange timeout or an abort from the upper layer. |
| 448 | * |
| 449 | * A timer_msec can be specified for abort timeout, if non-zero |
| 450 | * timer_msec value is specified then exchange resp handler |
| 451 | * will be called with timeout error if no response to abort. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 452 | * |
| 453 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 454 | */ |
| 455 | int (*seq_exch_abort)(const struct fc_seq *req_sp, |
| 456 | unsigned int timer_msec); |
| 457 | |
| 458 | /* |
| 459 | * Indicate that an exchange/sequence tuple is complete and the memory |
| 460 | * allocated for the related objects may be freed. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 461 | * |
| 462 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 463 | */ |
| 464 | void (*exch_done)(struct fc_seq *sp); |
| 465 | |
| 466 | /* |
| 467 | * Assigns a EM and a free XID for an new exchange and then |
| 468 | * allocates a new exchange and sequence pair. |
| 469 | * The fp can be used to determine free XID. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 470 | * |
| 471 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 472 | */ |
| 473 | struct fc_exch *(*exch_get)(struct fc_lport *lp, struct fc_frame *fp); |
| 474 | |
| 475 | /* |
| 476 | * Release previously assigned XID by exch_get API. |
| 477 | * The LLD may implement this if XID is assigned by LLD |
| 478 | * in exch_get(). |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 479 | * |
| 480 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 481 | */ |
| 482 | void (*exch_put)(struct fc_lport *lp, struct fc_exch_mgr *mp, |
| 483 | u16 ex_id); |
| 484 | |
| 485 | /* |
| 486 | * Start a new sequence on the same exchange/sequence tuple. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 487 | * |
| 488 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 489 | */ |
| 490 | struct fc_seq *(*seq_start_next)(struct fc_seq *sp); |
| 491 | |
| 492 | /* |
| 493 | * Reset an exchange manager, completing all sequences and exchanges. |
| 494 | * If s_id is non-zero, reset only exchanges originating from that FID. |
| 495 | * If d_id is non-zero, reset only exchanges sending to that FID. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 496 | * |
| 497 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 498 | */ |
Abhijeet Joglekar | 1f6ff36 | 2009-02-27 10:54:35 -0800 | [diff] [blame] | 499 | void (*exch_mgr_reset)(struct fc_lport *, |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 500 | u32 s_id, u32 d_id); |
| 501 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 502 | /* |
| 503 | * Flush the rport work queue. Generally used before shutdown. |
| 504 | * |
| 505 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 506 | */ |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 507 | void (*rport_flush_queue)(void); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 508 | |
| 509 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 510 | * Receive a frame for a local port. |
| 511 | * |
| 512 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 513 | */ |
| 514 | void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, |
| 515 | struct fc_frame *fp); |
| 516 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 517 | /* |
| 518 | * Reset the local port. |
| 519 | * |
| 520 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 521 | */ |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 522 | int (*lport_reset)(struct fc_lport *); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 523 | |
| 524 | /* |
Robert Love | 5101ff9 | 2009-02-27 10:55:18 -0800 | [diff] [blame] | 525 | * Create a remote port |
| 526 | */ |
| 527 | struct fc_rport *(*rport_create)(struct fc_disc_port *); |
| 528 | |
| 529 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 530 | * Initiates the RP state machine. It is called from the LP module. |
| 531 | * This function will issue the following commands to the N_Port |
| 532 | * identified by the FC ID provided. |
| 533 | * |
| 534 | * - PLOGI |
| 535 | * - PRLI |
| 536 | * - RTV |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 537 | * |
| 538 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 539 | */ |
| 540 | int (*rport_login)(struct fc_rport *rport); |
| 541 | |
| 542 | /* |
| 543 | * Logoff, and remove the rport from the transport if |
| 544 | * it had been added. This will send a LOGO to the target. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 545 | * |
| 546 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 547 | */ |
| 548 | int (*rport_logoff)(struct fc_rport *rport); |
| 549 | |
| 550 | /* |
| 551 | * Recieve a request from a remote port. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 552 | * |
| 553 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 554 | */ |
| 555 | void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, |
| 556 | struct fc_rport *); |
| 557 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 558 | /* |
| 559 | * lookup an rport by it's port ID. |
| 560 | * |
| 561 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 562 | */ |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 563 | struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 564 | |
| 565 | /* |
| 566 | * Send a fcp cmd from fsp pkt. |
| 567 | * Called with the SCSI host lock unlocked and irqs disabled. |
| 568 | * |
| 569 | * The resp handler is called when FCP_RSP received. |
| 570 | * |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 571 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 572 | */ |
| 573 | int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, |
| 574 | void (*resp)(struct fc_seq *, struct fc_frame *fp, |
| 575 | void *arg)); |
| 576 | |
| 577 | /* |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 578 | * Cleanup the FCP layer, used durring link down and reset |
| 579 | * |
| 580 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 581 | */ |
| 582 | void (*fcp_cleanup)(struct fc_lport *lp); |
| 583 | |
| 584 | /* |
| 585 | * Abort all I/O on a local port |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 586 | * |
| 587 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 588 | */ |
| 589 | void (*fcp_abort_io)(struct fc_lport *lp); |
| 590 | |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 591 | /* |
| 592 | * Receive a request for the discovery layer. |
| 593 | * |
| 594 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 595 | */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 596 | void (*disc_recv_req)(struct fc_seq *, |
| 597 | struct fc_frame *, struct fc_lport *); |
| 598 | |
| 599 | /* |
| 600 | * Start discovery for a local port. |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 601 | * |
| 602 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 603 | */ |
| 604 | void (*disc_start)(void (*disc_callback)(struct fc_lport *, |
| 605 | enum fc_disc_event), |
| 606 | struct fc_lport *); |
| 607 | |
| 608 | /* |
| 609 | * Stop discovery for a given lport. This will remove |
| 610 | * all discovered rports |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 611 | * |
| 612 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 613 | */ |
| 614 | void (*disc_stop) (struct fc_lport *); |
| 615 | |
| 616 | /* |
| 617 | * Stop discovery for a given lport. This will block |
| 618 | * until all discovered rports are deleted from the |
| 619 | * FC transport class |
Robert Love | 0ae4d4a | 2009-02-27 10:55:39 -0800 | [diff] [blame] | 620 | * |
| 621 | * STATUS: OPTIONAL |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 622 | */ |
| 623 | void (*disc_stop_final) (struct fc_lport *); |
| 624 | }; |
| 625 | |
| 626 | /* information used by the discovery layer */ |
| 627 | struct fc_disc { |
| 628 | unsigned char retry_count; |
| 629 | unsigned char delay; |
| 630 | unsigned char pending; |
| 631 | unsigned char requested; |
| 632 | unsigned short seq_count; |
| 633 | unsigned char buf_len; |
| 634 | enum fc_disc_event event; |
| 635 | |
| 636 | void (*disc_callback)(struct fc_lport *, |
| 637 | enum fc_disc_event); |
| 638 | |
| 639 | struct list_head rports; |
| 640 | struct fc_lport *lport; |
| 641 | struct mutex disc_mutex; |
| 642 | struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ |
| 643 | struct delayed_work disc_work; |
| 644 | }; |
| 645 | |
| 646 | struct fc_lport { |
| 647 | struct list_head list; |
| 648 | |
| 649 | /* Associations */ |
| 650 | struct Scsi_Host *host; |
| 651 | struct fc_exch_mgr *emp; |
| 652 | struct fc_rport *dns_rp; |
| 653 | struct fc_rport *ptp_rp; |
| 654 | void *scsi_priv; |
| 655 | struct fc_disc disc; |
| 656 | |
| 657 | /* Operational Information */ |
| 658 | struct libfc_function_template tt; |
Vasu Dev | bc0e17f | 2009-02-27 10:54:57 -0800 | [diff] [blame] | 659 | u8 link_up; |
| 660 | u8 qfull; |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 661 | enum fc_lport_state state; |
| 662 | unsigned long boot_time; |
| 663 | |
| 664 | struct fc_host_statistics host_stats; |
Robert Love | 582b45b | 2009-03-31 15:51:50 -0700 | [diff] [blame] | 665 | struct fcoe_dev_stats *dev_stats; |
| 666 | |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 667 | u64 wwpn; |
| 668 | u64 wwnn; |
| 669 | u8 retry_count; |
| 670 | |
| 671 | /* Capabilities */ |
| 672 | u32 sg_supp:1; /* scatter gather supported */ |
| 673 | u32 seq_offload:1; /* seq offload supported */ |
| 674 | u32 crc_offload:1; /* crc offload supported */ |
| 675 | u32 lro_enabled:1; /* large receive offload */ |
| 676 | u32 mfs; /* max FC payload size */ |
| 677 | unsigned int service_params; |
| 678 | unsigned int e_d_tov; |
| 679 | unsigned int r_a_tov; |
| 680 | u8 max_retry_count; |
| 681 | u16 link_speed; |
| 682 | u16 link_supported_speeds; |
| 683 | u16 lro_xid; /* max xid for fcoe lro */ |
Yi Zou | ea1e9a9 | 2009-02-27 14:07:04 -0800 | [diff] [blame] | 684 | unsigned int lso_max; /* max large send size */ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 685 | struct fc_ns_fts fcts; /* FC-4 type masks */ |
| 686 | struct fc_els_rnid_gen rnid_gen; /* RNID information */ |
| 687 | |
| 688 | /* Semaphores */ |
| 689 | struct mutex lp_mutex; |
| 690 | |
| 691 | /* Miscellaneous */ |
| 692 | struct delayed_work retry_work; |
| 693 | struct delayed_work disc_work; |
| 694 | }; |
| 695 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 696 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 697 | * FC_LPORT HELPER FUNCTIONS |
| 698 | *****************************/ |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 699 | static inline int fc_lport_test_ready(struct fc_lport *lp) |
| 700 | { |
| 701 | return lp->state == LPORT_ST_READY; |
| 702 | } |
| 703 | |
| 704 | static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) |
| 705 | { |
| 706 | lp->wwnn = wwnn; |
| 707 | } |
| 708 | |
| 709 | static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) |
| 710 | { |
| 711 | lp->wwpn = wwnn; |
| 712 | } |
| 713 | |
| 714 | static inline void fc_lport_state_enter(struct fc_lport *lp, |
| 715 | enum fc_lport_state state) |
| 716 | { |
| 717 | if (state != lp->state) |
| 718 | lp->retry_count = 0; |
| 719 | lp->state = state; |
| 720 | } |
| 721 | |
Robert Love | 582b45b | 2009-03-31 15:51:50 -0700 | [diff] [blame] | 722 | static inline int fc_lport_init_stats(struct fc_lport *lp) |
| 723 | { |
| 724 | /* allocate per cpu stats block */ |
| 725 | lp->dev_stats = alloc_percpu(struct fcoe_dev_stats); |
| 726 | if (!lp->dev_stats) |
| 727 | return -ENOMEM; |
| 728 | return 0; |
| 729 | } |
| 730 | |
| 731 | static inline void fc_lport_free_stats(struct fc_lport *lp) |
| 732 | { |
| 733 | free_percpu(lp->dev_stats); |
| 734 | } |
| 735 | |
| 736 | static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp) |
| 737 | { |
| 738 | return per_cpu_ptr(lp->dev_stats, smp_processor_id()); |
| 739 | } |
| 740 | |
Vasu Dev | a0a25da | 2009-03-17 11:42:29 -0700 | [diff] [blame] | 741 | static inline void *lport_priv(const struct fc_lport *lp) |
| 742 | { |
| 743 | return (void *)(lp + 1); |
| 744 | } |
| 745 | |
| 746 | /** |
| 747 | * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport |
| 748 | * @sht: ptr to the scsi host templ |
| 749 | * @priv_size: size of private data after fc_lport |
| 750 | * |
| 751 | * Returns: ptr to Scsi_Host |
| 752 | */ |
| 753 | static inline struct Scsi_Host * |
| 754 | libfc_host_alloc(struct scsi_host_template *sht, int priv_size) |
| 755 | { |
| 756 | return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size); |
| 757 | } |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 758 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 759 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 760 | * LOCAL PORT LAYER |
| 761 | *****************************/ |
| 762 | int fc_lport_init(struct fc_lport *lp); |
| 763 | |
| 764 | /* |
| 765 | * Destroy the specified local port by finding and freeing all |
| 766 | * fc_rports associated with it and then by freeing the fc_lport |
| 767 | * itself. |
| 768 | */ |
| 769 | int fc_lport_destroy(struct fc_lport *lp); |
| 770 | |
| 771 | /* |
| 772 | * Logout the specified local port from the fabric |
| 773 | */ |
| 774 | int fc_fabric_logoff(struct fc_lport *lp); |
| 775 | |
| 776 | /* |
| 777 | * Initiate the LP state machine. This handler will use fc_host_attr |
| 778 | * to store the FLOGI service parameters, so fc_host_attr must be |
| 779 | * initialized before calling this handler. |
| 780 | */ |
| 781 | int fc_fabric_login(struct fc_lport *lp); |
| 782 | |
| 783 | /* |
| 784 | * The link is up for the given local port. |
| 785 | */ |
| 786 | void fc_linkup(struct fc_lport *); |
| 787 | |
| 788 | /* |
| 789 | * Link is down for the given local port. |
| 790 | */ |
| 791 | void fc_linkdown(struct fc_lport *); |
| 792 | |
| 793 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 794 | * Configure the local port. |
| 795 | */ |
| 796 | int fc_lport_config(struct fc_lport *); |
| 797 | |
| 798 | /* |
| 799 | * Reset the local port. |
| 800 | */ |
| 801 | int fc_lport_reset(struct fc_lport *); |
| 802 | |
| 803 | /* |
| 804 | * Set the mfs or reset |
| 805 | */ |
| 806 | int fc_set_mfs(struct fc_lport *lp, u32 mfs); |
| 807 | |
| 808 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 809 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 810 | * REMOTE PORT LAYER |
| 811 | *****************************/ |
| 812 | int fc_rport_init(struct fc_lport *lp); |
| 813 | void fc_rport_terminate_io(struct fc_rport *rp); |
| 814 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 815 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 816 | * DISCOVERY LAYER |
| 817 | *****************************/ |
| 818 | int fc_disc_init(struct fc_lport *lp); |
| 819 | |
| 820 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 821 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 822 | * SCSI LAYER |
| 823 | *****************************/ |
| 824 | /* |
| 825 | * Initialize the SCSI block of libfc |
| 826 | */ |
| 827 | int fc_fcp_init(struct fc_lport *); |
| 828 | |
| 829 | /* |
| 830 | * This section provides an API which allows direct interaction |
| 831 | * with the SCSI-ml. Each of these functions satisfies a function |
| 832 | * pointer defined in Scsi_Host and therefore is always called |
| 833 | * directly from the SCSI-ml. |
| 834 | */ |
| 835 | int fc_queuecommand(struct scsi_cmnd *sc_cmd, |
| 836 | void (*done)(struct scsi_cmnd *)); |
| 837 | |
| 838 | /* |
| 839 | * complete processing of a fcp packet |
| 840 | * |
| 841 | * This function may sleep if a fsp timer is pending. |
| 842 | * The host lock must not be held by caller. |
| 843 | */ |
| 844 | void fc_fcp_complete(struct fc_fcp_pkt *fsp); |
| 845 | |
| 846 | /* |
| 847 | * Send an ABTS frame to the target device. The sc_cmd argument |
| 848 | * is a pointer to the SCSI command to be aborted. |
| 849 | */ |
| 850 | int fc_eh_abort(struct scsi_cmnd *sc_cmd); |
| 851 | |
| 852 | /* |
| 853 | * Reset a LUN by sending send the tm cmd to the target. |
| 854 | */ |
| 855 | int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); |
| 856 | |
| 857 | /* |
| 858 | * Reset the host adapter. |
| 859 | */ |
| 860 | int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); |
| 861 | |
| 862 | /* |
| 863 | * Check rport status. |
| 864 | */ |
| 865 | int fc_slave_alloc(struct scsi_device *sdev); |
| 866 | |
| 867 | /* |
| 868 | * Adjust the queue depth. |
| 869 | */ |
| 870 | int fc_change_queue_depth(struct scsi_device *sdev, int qdepth); |
| 871 | |
| 872 | /* |
| 873 | * Change the tag type. |
| 874 | */ |
| 875 | int fc_change_queue_type(struct scsi_device *sdev, int tag_type); |
| 876 | |
| 877 | /* |
| 878 | * Free memory pools used by the FCP layer. |
| 879 | */ |
| 880 | void fc_fcp_destroy(struct fc_lport *); |
| 881 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 882 | /* |
Yi Zou | b277d2a | 2009-02-27 14:07:21 -0800 | [diff] [blame] | 883 | * Set up direct-data placement for this I/O request |
| 884 | */ |
| 885 | void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid); |
| 886 | |
| 887 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 888 | * ELS/CT interface |
| 889 | *****************************/ |
| 890 | /* |
| 891 | * Initializes ELS/CT interface |
| 892 | */ |
| 893 | int fc_elsct_init(struct fc_lport *lp); |
| 894 | |
| 895 | |
Robert Love | 34f42a0 | 2009-02-27 10:55:45 -0800 | [diff] [blame] | 896 | /* |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 897 | * EXCHANGE MANAGER LAYER |
| 898 | *****************************/ |
| 899 | /* |
| 900 | * Initializes Exchange Manager related |
| 901 | * function pointers in struct libfc_function_template. |
| 902 | */ |
| 903 | int fc_exch_init(struct fc_lport *lp); |
| 904 | |
| 905 | /* |
| 906 | * Allocates an Exchange Manager (EM). |
| 907 | * |
| 908 | * The EM manages exchanges for their allocation and |
| 909 | * free, also allows exchange lookup for received |
| 910 | * frame. |
| 911 | * |
| 912 | * The class is used for initializing FC class of |
| 913 | * allocated exchange from EM. |
| 914 | * |
| 915 | * The min_xid and max_xid will limit new |
| 916 | * exchange ID (XID) within this range for |
| 917 | * a new exchange. |
| 918 | * The LLD may choose to have multiple EMs, |
| 919 | * e.g. one EM instance per CPU receive thread in LLD. |
| 920 | * The LLD can use exch_get() of struct libfc_function_template |
| 921 | * to specify XID for a new exchange within |
| 922 | * a specified EM instance. |
| 923 | * |
| 924 | * The em_idx to uniquely identify an EM instance. |
| 925 | */ |
| 926 | struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, |
| 927 | enum fc_class class, |
| 928 | u16 min_xid, |
| 929 | u16 max_xid); |
| 930 | |
| 931 | /* |
| 932 | * Free an exchange manager. |
| 933 | */ |
| 934 | void fc_exch_mgr_free(struct fc_exch_mgr *mp); |
| 935 | |
| 936 | /* |
| 937 | * Receive a frame on specified local port and exchange manager. |
| 938 | */ |
| 939 | void fc_exch_recv(struct fc_lport *lp, struct fc_exch_mgr *mp, |
| 940 | struct fc_frame *fp); |
| 941 | |
| 942 | /* |
| 943 | * This function is for exch_seq_send function pointer in |
| 944 | * struct libfc_function_template, see comment block on |
| 945 | * exch_seq_send for description of this function. |
| 946 | */ |
| 947 | struct fc_seq *fc_exch_seq_send(struct fc_lport *lp, |
| 948 | struct fc_frame *fp, |
| 949 | void (*resp)(struct fc_seq *sp, |
| 950 | struct fc_frame *fp, |
| 951 | void *arg), |
| 952 | void (*destructor)(struct fc_seq *sp, |
| 953 | void *arg), |
| 954 | void *arg, u32 timer_msec); |
| 955 | |
| 956 | /* |
| 957 | * send a frame using existing sequence and exchange. |
| 958 | */ |
| 959 | int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp); |
| 960 | |
| 961 | /* |
| 962 | * Send ELS response using mainly infomation |
| 963 | * in exchange and sequence in EM layer. |
| 964 | */ |
| 965 | void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd, |
| 966 | struct fc_seq_els_data *els_data); |
| 967 | |
| 968 | /* |
| 969 | * This function is for seq_exch_abort function pointer in |
| 970 | * struct libfc_function_template, see comment block on |
| 971 | * seq_exch_abort for description of this function. |
| 972 | */ |
| 973 | int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec); |
| 974 | |
| 975 | /* |
| 976 | * Indicate that an exchange/sequence tuple is complete and the memory |
| 977 | * allocated for the related objects may be freed. |
| 978 | */ |
| 979 | void fc_exch_done(struct fc_seq *sp); |
| 980 | |
| 981 | /* |
| 982 | * Assigns a EM and XID for a frame and then allocates |
| 983 | * a new exchange and sequence pair. |
| 984 | * The fp can be used to determine free XID. |
| 985 | */ |
| 986 | struct fc_exch *fc_exch_get(struct fc_lport *lp, struct fc_frame *fp); |
| 987 | |
| 988 | /* |
| 989 | * Allocate a new exchange and sequence pair. |
| 990 | * if ex_id is zero then next free exchange id |
| 991 | * from specified exchange manger mp will be assigned. |
| 992 | */ |
| 993 | struct fc_exch *fc_exch_alloc(struct fc_exch_mgr *mp, |
| 994 | struct fc_frame *fp, u16 ex_id); |
| 995 | /* |
| 996 | * Start a new sequence on the same exchange as the supplied sequence. |
| 997 | */ |
| 998 | struct fc_seq *fc_seq_start_next(struct fc_seq *sp); |
| 999 | |
| 1000 | /* |
| 1001 | * Reset an exchange manager, completing all sequences and exchanges. |
| 1002 | * If s_id is non-zero, reset only exchanges originating from that FID. |
| 1003 | * If d_id is non-zero, reset only exchanges sending to that FID. |
| 1004 | */ |
Abhijeet Joglekar | 1f6ff36 | 2009-02-27 10:54:35 -0800 | [diff] [blame] | 1005 | void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); |
Robert Love | 42e9a92 | 2008-12-09 15:10:17 -0800 | [diff] [blame] | 1006 | |
| 1007 | /* |
| 1008 | * Functions for fc_functions_template |
| 1009 | */ |
| 1010 | void fc_get_host_speed(struct Scsi_Host *shost); |
| 1011 | void fc_get_host_port_type(struct Scsi_Host *shost); |
| 1012 | void fc_get_host_port_state(struct Scsi_Host *shost); |
| 1013 | void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); |
| 1014 | struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); |
| 1015 | |
| 1016 | /* |
| 1017 | * module setup functions. |
| 1018 | */ |
| 1019 | int fc_setup_exch_mgr(void); |
| 1020 | void fc_destroy_exch_mgr(void); |
| 1021 | int fc_setup_rport(void); |
| 1022 | void fc_destroy_rport(void); |
| 1023 | |
| 1024 | #endif /* _LIBFC_H_ */ |