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> 25 #include <linux/percpu.h> 26 27 #include <scsi/scsi_transport.h> 28 #include <scsi/scsi_transport_fc.h> 29 #include <scsi/scsi_bsg_fc.h> 30 31 #include <scsi/fc/fc_fcp.h> 32 #include <scsi/fc/fc_ns.h> 33 #include <scsi/fc/fc_els.h> 34 #include <scsi/fc/fc_gs.h> 35 36 #include <scsi/fc_frame.h> 37 38 #define FC_FC4_PROV_SIZE (FC_TYPE_FCP + 1) /* size of tables */ 39 40 /* 41 * libfc error codes 42 */ 43 #define FC_NO_ERR 0 /* no error */ 44 #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 45 #define FC_EX_CLOSED 2 /* Exchange closed */ 46 47 /** 48 * enum fc_lport_state - Local port states 49 * @LPORT_ST_DISABLED: Disabled 50 * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent 51 * @LPORT_ST_DNS: Waiting for name server remote port to become ready 52 * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent 53 * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent 54 * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent 55 * @LPORT_ST_SCR: State Change Register (SCR) sent 56 * @LPORT_ST_READY: Ready for use 57 * @LPORT_ST_LOGO: Local port logout (LOGO) sent 58 * @LPORT_ST_RESET: Local port reset 59 */ 60 enum fc_lport_state { 61 LPORT_ST_DISABLED = 0, 62 LPORT_ST_FLOGI, 63 LPORT_ST_DNS, 64 LPORT_ST_RNN_ID, 65 LPORT_ST_RSNN_NN, 66 LPORT_ST_RSPN_ID, 67 LPORT_ST_RFT_ID, 68 LPORT_ST_RFF_ID, 69 LPORT_ST_SCR, 70 LPORT_ST_READY, 71 LPORT_ST_LOGO, 72 LPORT_ST_RESET 73 }; 74 75 enum fc_disc_event { 76 DISC_EV_NONE = 0, 77 DISC_EV_SUCCESS, 78 DISC_EV_FAILED 79 }; 80 81 /** 82 * enum fc_rport_state - Remote port states 83 * @RPORT_ST_INIT: Initialized 84 * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint 85 * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint 86 * @RPORT_ST_PLOGI: Waiting for PLOGI completion 87 * @RPORT_ST_PRLI: Waiting for PRLI completion 88 * @RPORT_ST_RTV: Waiting for RTV completion 89 * @RPORT_ST_READY: Ready for use 90 * @RPORT_ST_ADISC: Discover Address sent 91 * @RPORT_ST_DELETE: Remote port being deleted 92 */ 93 enum fc_rport_state { 94 RPORT_ST_INIT, 95 RPORT_ST_FLOGI, 96 RPORT_ST_PLOGI_WAIT, 97 RPORT_ST_PLOGI, 98 RPORT_ST_PRLI, 99 RPORT_ST_RTV, 100 RPORT_ST_READY, 101 RPORT_ST_ADISC, 102 RPORT_ST_DELETE, 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 * @rport_work: Work struct for starting the rport state machine 110 * @port_id: Port ID of the discovered port 111 */ 112 struct fc_disc_port { 113 struct fc_lport *lp; 114 struct list_head peers; 115 struct work_struct rport_work; 116 u32 port_id; 117 }; 118 119 /** 120 * enum fc_rport_event - Remote port events 121 * @RPORT_EV_NONE: No event 122 * @RPORT_EV_READY: Remote port is ready for use 123 * @RPORT_EV_FAILED: State machine failed, remote port is not ready 124 * @RPORT_EV_STOP: Remote port has been stopped 125 * @RPORT_EV_LOGO: Remote port logout (LOGO) sent 126 */ 127 enum fc_rport_event { 128 RPORT_EV_NONE = 0, 129 RPORT_EV_READY, 130 RPORT_EV_FAILED, 131 RPORT_EV_STOP, 132 RPORT_EV_LOGO 133 }; 134 135 struct fc_rport_priv; 136 137 /** 138 * struct fc_rport_operations - Operations for a remote port 139 * @event_callback: Function to be called for remote port events 140 */ 141 struct fc_rport_operations { 142 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, 143 enum fc_rport_event); 144 }; 145 146 /** 147 * struct fc_rport_libfc_priv - libfc internal information about a remote port 148 * @local_port: The associated local port 149 * @rp_state: Indicates READY for I/O or DELETE when blocked 150 * @flags: REC and RETRY supported flags 151 * @e_d_tov: Error detect timeout value (in msec) 152 * @r_a_tov: Resource allocation timeout value (in msec) 153 */ 154 struct fc_rport_libfc_priv { 155 struct fc_lport *local_port; 156 enum fc_rport_state rp_state; 157 u16 flags; 158 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 159 #define FC_RP_FLAGS_RETRY (1 << 1) 160 #define FC_RP_STARTED (1 << 2) 161 #define FC_RP_FLAGS_CONF_REQ (1 << 3) 162 unsigned int e_d_tov; 163 unsigned int r_a_tov; 164 }; 165 166 /** 167 * struct fc_rport_priv - libfc remote port and discovery info 168 * @local_port: The associated local port 169 * @rport: The FC transport remote port 170 * @kref: Reference counter 171 * @rp_state: Enumeration that tracks progress of PLOGI, PRLI, 172 * and RTV exchanges 173 * @ids: The remote port identifiers and roles 174 * @flags: STARTED, REC and RETRY_SUPPORTED flags 175 * @max_seq: Maximum number of concurrent sequences 176 * @disc_id: The discovery identifier 177 * @maxframe_size: The maximum frame size 178 * @retries: The retry count for the current state 179 * @major_retries: The retry count for the entire PLOGI/PRLI state machine 180 * @e_d_tov: Error detect timeout value (in msec) 181 * @r_a_tov: Resource allocation timeout value (in msec) 182 * @rp_mutex: The mutex that protects the remote port 183 * @retry_work: Handle for retries 184 * @event_callback: Callback when READY, FAILED or LOGO states complete 185 * @prli_count: Count of open PRLI sessions in providers 186 * @rcu: Structure used for freeing in an RCU-safe manner 187 */ 188 struct fc_rport_priv { 189 struct fc_lport *local_port; 190 struct fc_rport *rport; 191 struct kref kref; 192 enum fc_rport_state rp_state; 193 struct fc_rport_identifiers ids; 194 u16 flags; 195 u16 max_seq; 196 u16 disc_id; 197 u16 maxframe_size; 198 unsigned int retries; 199 unsigned int major_retries; 200 unsigned int e_d_tov; 201 unsigned int r_a_tov; 202 struct mutex rp_mutex; 203 struct delayed_work retry_work; 204 enum fc_rport_event event; 205 struct fc_rport_operations *ops; 206 struct list_head peers; 207 struct work_struct event_work; 208 u32 supported_classes; 209 u16 prli_count; 210 struct rcu_head rcu; 211 u16 sp_features; 212 u8 spp_type; 213 void (*lld_event_callback)(struct fc_lport *, 214 struct fc_rport_priv *, 215 enum fc_rport_event); 216 }; 217 218 /** 219 * struct fcoe_dev_stats - fcoe stats structure 220 * @SecondsSinceLastReset: Seconds since the last reset 221 * @TxFrames: Number of transmitted frames 222 * @TxWords: Number of transmitted words 223 * @RxFrames: Number of received frames 224 * @RxWords: Number of received words 225 * @ErrorFrames: Number of received error frames 226 * @DumpedFrames: Number of dumped frames 227 * @LinkFailureCount: Number of link failures 228 * @LossOfSignalCount: Number for signal losses 229 * @InvalidTxWordCount: Number of invalid transmitted words 230 * @InvalidCRCCount: Number of invalid CRCs 231 * @InputRequests: Number of input requests 232 * @OutputRequests: Number of output requests 233 * @ControlRequests: Number of control requests 234 * @InputBytes: Number of received bytes 235 * @OutputBytes: Number of transmitted bytes 236 * @VLinkFailureCount: Number of virtual link failures 237 * @MissDiscAdvCount: Number of missing FIP discovery advertisement 238 */ 239 struct fcoe_dev_stats { 240 u64 SecondsSinceLastReset; 241 u64 TxFrames; 242 u64 TxWords; 243 u64 RxFrames; 244 u64 RxWords; 245 u64 ErrorFrames; 246 u64 DumpedFrames; 247 u64 LinkFailureCount; 248 u64 LossOfSignalCount; 249 u64 InvalidTxWordCount; 250 u64 InvalidCRCCount; 251 u64 InputRequests; 252 u64 OutputRequests; 253 u64 ControlRequests; 254 u64 InputBytes; 255 u64 OutputBytes; 256 u64 VLinkFailureCount; 257 u64 MissDiscAdvCount; 258 }; 259 260 /** 261 * struct fc_seq_els_data - ELS data used for passing ELS specific responses 262 * @reason: The reason for rejection 263 * @explan: The explanation of the rejection 264 * 265 * Mainly used by the exchange manager layer. 266 */ 267 struct fc_seq_els_data { 268 enum fc_els_rjt_reason reason; 269 enum fc_els_rjt_explan explan; 270 }; 271 272 /** 273 * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request) 274 * @lp: The associated local port 275 * @state: The state of the I/O 276 * @ref_cnt: Reference count 277 * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the 278 * host_lock if both are to be held at the same time) 279 * @cmd: The SCSI command (set and clear with the host_lock held) 280 * @list: Tracks queued commands (accessed with the host_lock held) 281 * @timer: The command timer 282 * @tm_done: Completion indicator 283 * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies) 284 * @data_len: The length of the data 285 * @cdb_cmd: The CDB command 286 * @xfer_len: The transfer length 287 * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange 288 * will be set here if DDP was setup) 289 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous 290 * (Tx and Rx) 291 * @max_payload: The maximum payload size (in bytes) 292 * @io_status: SCSI result (upper 24 bits) 293 * @cdb_status: CDB status 294 * @status_code: FCP I/O status 295 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun) 296 * @req_flags: Request flags (bit 0: read bit:1 write) 297 * @scsi_resid: SCSI residule length 298 * @rport: The remote port that the SCSI command is targeted at 299 * @seq_ptr: The sequence that will carry the SCSI command 300 * @recov_retry: Number of recovery retries 301 * @recov_seq: The sequence for REC or SRR 302 */ 303 struct fc_fcp_pkt { 304 spinlock_t scsi_pkt_lock; 305 atomic_t ref_cnt; 306 307 /* SCSI command and data transfer information */ 308 u32 data_len; 309 310 /* SCSI I/O related information */ 311 struct scsi_cmnd *cmd; 312 struct list_head list; 313 314 /* Housekeeping information */ 315 struct fc_lport *lp; 316 u8 state; 317 318 /* SCSI/FCP return status */ 319 u8 cdb_status; 320 u8 status_code; 321 u8 scsi_comp_flags; 322 u32 io_status; 323 u32 req_flags; 324 u32 scsi_resid; 325 326 /* Transport related veriables */ 327 size_t xfer_len; 328 struct fcp_cmnd cdb_cmd; 329 u32 xfer_contig_end; 330 u16 max_payload; 331 u16 xfer_ddp; 332 333 /* Associated structures */ 334 struct fc_rport *rport; 335 struct fc_seq *seq_ptr; 336 337 /* Timeout/error related information */ 338 struct timer_list timer; 339 int wait_for_comp; 340 u32 recov_retry; 341 struct fc_seq *recov_seq; 342 struct completion tm_done; 343 } ____cacheline_aligned_in_smp; 344 345 /* 346 * Structure and function definitions for managing Fibre Channel Exchanges 347 * and Sequences 348 * 349 * fc_exch holds state for one exchange and links to its active sequence. 350 * 351 * fc_seq holds the state for an individual sequence. 352 */ 353 354 struct fc_exch_mgr; 355 struct fc_exch_mgr_anchor; 356 extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 357 358 /** 359 * struct fc_seq - FC sequence 360 * @id: The sequence ID 361 * @ssb_stat: Status flags for the sequence status block (SSB) 362 * @cnt: Number of frames sent so far 363 * @rec_data: FC-4 value for REC 364 */ 365 struct fc_seq { 366 u8 id; 367 u16 ssb_stat; 368 u16 cnt; 369 u32 rec_data; 370 }; 371 372 #define FC_EX_DONE (1 << 0) /* ep is completed */ 373 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 374 375 /** 376 * struct fc_exch - Fibre Channel Exchange 377 * @em: Exchange manager 378 * @pool: Exchange pool 379 * @state: The exchange's state 380 * @xid: The exchange ID 381 * @ex_list: Handle used by the EM to track free exchanges 382 * @ex_lock: Lock that protects the exchange 383 * @ex_refcnt: Reference count 384 * @timeout_work: Handle for timeout handler 385 * @lp: The local port that this exchange is on 386 * @oxid: Originator's exchange ID 387 * @rxid: Responder's exchange ID 388 * @oid: Originator's FCID 389 * @sid: Source FCID 390 * @did: Destination FCID 391 * @esb_stat: ESB exchange status 392 * @r_a_tov: Resouce allocation time out value (in msecs) 393 * @seq_id: The next sequence ID to use 394 * @encaps: encapsulation information for lower-level driver 395 * @f_ctl: F_CTL flags for the sequence 396 * @fh_type: The frame type 397 * @class: The class of service 398 * @seq: The sequence in use on this exchange 399 * @resp: Callback for responses on this exchange 400 * @destructor: Called when destroying the exchange 401 * @arg: Passed as a void pointer to the resp() callback 402 * 403 * Locking notes: The ex_lock protects following items: 404 * state, esb_stat, f_ctl, seq.ssb_stat 405 * seq_id 406 * sequence allocation 407 */ 408 struct fc_exch { 409 spinlock_t ex_lock; 410 atomic_t ex_refcnt; 411 enum fc_class class; 412 struct fc_exch_mgr *em; 413 struct fc_exch_pool *pool; 414 struct list_head ex_list; 415 struct fc_lport *lp; 416 u32 esb_stat; 417 u8 state; 418 u8 fh_type; 419 u8 seq_id; 420 u8 encaps; 421 u16 xid; 422 u16 oxid; 423 u16 rxid; 424 u32 oid; 425 u32 sid; 426 u32 did; 427 u32 r_a_tov; 428 u32 f_ctl; 429 struct fc_seq seq; 430 void (*resp)(struct fc_seq *, struct fc_frame *, void *); 431 void *arg; 432 void (*destructor)(struct fc_seq *, void *); 433 struct delayed_work timeout_work; 434 } ____cacheline_aligned_in_smp; 435 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 436 437 438 struct libfc_function_template { 439 /* 440 * Interface to send a FC frame 441 * 442 * STATUS: REQUIRED 443 */ 444 int (*frame_send)(struct fc_lport *, struct fc_frame *); 445 446 /* 447 * Interface to send ELS/CT frames 448 * 449 * STATUS: OPTIONAL 450 */ 451 struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, 452 struct fc_frame *, unsigned int op, 453 void (*resp)(struct fc_seq *, 454 struct fc_frame *, void *arg), 455 void *arg, u32 timer_msec); 456 457 /* 458 * Send the FC frame payload using a new exchange and sequence. 459 * 460 * The exchange response handler is set in this routine to resp() 461 * function pointer. It can be called in two scenarios: if a timeout 462 * occurs or if a response frame is received for the exchange. The 463 * fc_frame pointer in response handler will also indicate timeout 464 * as error using IS_ERR related macros. 465 * 466 * The exchange destructor handler is also set in this routine. 467 * The destructor handler is invoked by EM layer when exchange 468 * is about to free, this can be used by caller to free its 469 * resources along with exchange free. 470 * 471 * The arg is passed back to resp and destructor handler. 472 * 473 * The timeout value (in msec) for an exchange is set if non zero 474 * timer_msec argument is specified. The timer is canceled when 475 * it fires or when the exchange is done. The exchange timeout handler 476 * is registered by EM layer. 477 * 478 * STATUS: OPTIONAL 479 */ 480 struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *, 481 void (*resp)(struct fc_seq *, 482 struct fc_frame *, 483 void *), 484 void (*destructor)(struct fc_seq *, 485 void *), 486 void *, unsigned int timer_msec); 487 488 /* 489 * Sets up the DDP context for a given exchange id on the given 490 * scatterlist if LLD supports DDP for large receive. 491 * 492 * STATUS: OPTIONAL 493 */ 494 int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, 495 unsigned int); 496 /* 497 * Completes the DDP transfer and returns the length of data DDPed 498 * for the given exchange id. 499 * 500 * STATUS: OPTIONAL 501 */ 502 int (*ddp_done)(struct fc_lport *, u16); 503 /* 504 * Sets up the DDP context for a given exchange id on the given 505 * scatterlist if LLD supports DDP for FCoE target. 506 * 507 * STATUS: OPTIONAL 508 */ 509 int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *, 510 unsigned int); 511 /* 512 * Allow LLD to fill its own Link Error Status Block 513 * 514 * STATUS: OPTIONAL 515 */ 516 void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb); 517 /* 518 * Send a frame using an existing sequence and exchange. 519 * 520 * STATUS: OPTIONAL 521 */ 522 int (*seq_send)(struct fc_lport *, struct fc_seq *, 523 struct fc_frame *); 524 525 /* 526 * Send an ELS response using information from the received frame. 527 * 528 * STATUS: OPTIONAL 529 */ 530 void (*seq_els_rsp_send)(struct fc_frame *, enum fc_els_cmd, 531 struct fc_seq_els_data *); 532 533 /* 534 * Abort an exchange and sequence. Generally called because of a 535 * exchange timeout or an abort from the upper layer. 536 * 537 * A timer_msec can be specified for abort timeout, if non-zero 538 * timer_msec value is specified then exchange resp handler 539 * will be called with timeout error if no response to abort. 540 * 541 * STATUS: OPTIONAL 542 */ 543 int (*seq_exch_abort)(const struct fc_seq *, 544 unsigned int timer_msec); 545 546 /* 547 * Indicate that an exchange/sequence tuple is complete and the memory 548 * allocated for the related objects may be freed. 549 * 550 * STATUS: OPTIONAL 551 */ 552 void (*exch_done)(struct fc_seq *); 553 554 /* 555 * Start a new sequence on the same exchange/sequence tuple. 556 * 557 * STATUS: OPTIONAL 558 */ 559 struct fc_seq *(*seq_start_next)(struct fc_seq *); 560 561 /* 562 * Set a response handler for the exchange of the sequence. 563 * 564 * STATUS: OPTIONAL 565 */ 566 void (*seq_set_resp)(struct fc_seq *sp, 567 void (*resp)(struct fc_seq *, struct fc_frame *, 568 void *), 569 void *arg); 570 571 /* 572 * Assign a sequence for an incoming request frame. 573 * 574 * STATUS: OPTIONAL 575 */ 576 struct fc_seq *(*seq_assign)(struct fc_lport *, struct fc_frame *); 577 578 /* 579 * Release the reference on the sequence returned by seq_assign(). 580 * 581 * STATUS: OPTIONAL 582 */ 583 void (*seq_release)(struct fc_seq *); 584 585 /* 586 * Reset an exchange manager, completing all sequences and exchanges. 587 * If s_id is non-zero, reset only exchanges originating from that FID. 588 * If d_id is non-zero, reset only exchanges sending to that FID. 589 * 590 * STATUS: OPTIONAL 591 */ 592 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); 593 594 /* 595 * Flush the rport work queue. Generally used before shutdown. 596 * 597 * STATUS: OPTIONAL 598 */ 599 void (*rport_flush_queue)(void); 600 601 /* 602 * Receive a frame for a local port. 603 * 604 * STATUS: OPTIONAL 605 */ 606 void (*lport_recv)(struct fc_lport *, struct fc_frame *); 607 608 /* 609 * Reset the local port. 610 * 611 * STATUS: OPTIONAL 612 */ 613 int (*lport_reset)(struct fc_lport *); 614 615 /* 616 * Set the local port FC_ID. 617 * 618 * This may be provided by the LLD to allow it to be 619 * notified when the local port is assigned a FC-ID. 620 * 621 * The frame, if non-NULL, is the incoming frame with the 622 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC 623 * address for the LLD. The frame pointer may be NULL if 624 * no MAC is associated with this assignment (LOGO or PLOGI). 625 * 626 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid. 627 * 628 * Note: this is called with the local port mutex held. 629 * 630 * STATUS: OPTIONAL 631 */ 632 void (*lport_set_port_id)(struct fc_lport *, u32 port_id, 633 struct fc_frame *); 634 635 /* 636 * Create a remote port with a given port ID 637 * 638 * STATUS: OPTIONAL 639 */ 640 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 641 642 /* 643 * Initiates the RP state machine. It is called from the LP module. 644 * This function will issue the following commands to the N_Port 645 * identified by the FC ID provided. 646 * 647 * - PLOGI 648 * - PRLI 649 * - RTV 650 * 651 * STATUS: OPTIONAL 652 */ 653 int (*rport_login)(struct fc_rport_priv *); 654 655 /* 656 * Logoff, and remove the rport from the transport if 657 * it had been added. This will send a LOGO to the target. 658 * 659 * STATUS: OPTIONAL 660 */ 661 int (*rport_logoff)(struct fc_rport_priv *); 662 663 /* 664 * Receive a request from a remote port. 665 * 666 * STATUS: OPTIONAL 667 */ 668 void (*rport_recv_req)(struct fc_lport *, struct fc_frame *); 669 670 /* 671 * lookup an rport by it's port ID. 672 * 673 * STATUS: OPTIONAL 674 */ 675 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 676 677 /* 678 * Destroy an rport after final kref_put(). 679 * The argument is a pointer to the kref inside the fc_rport_priv. 680 */ 681 void (*rport_destroy)(struct kref *); 682 683 /* 684 * Callback routine after the remote port is logged in 685 * 686 * STATUS: OPTIONAL 687 */ 688 void (*rport_event_callback)(struct fc_lport *, 689 struct fc_rport_priv *, 690 enum fc_rport_event); 691 692 /* 693 * Send a fcp cmd from fsp pkt. 694 * Called with the SCSI host lock unlocked and irqs disabled. 695 * 696 * The resp handler is called when FCP_RSP received. 697 * 698 * STATUS: OPTIONAL 699 */ 700 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, 701 void (*resp)(struct fc_seq *, struct fc_frame *, 702 void *)); 703 704 /* 705 * Cleanup the FCP layer, used during link down and reset 706 * 707 * STATUS: OPTIONAL 708 */ 709 void (*fcp_cleanup)(struct fc_lport *); 710 711 /* 712 * Abort all I/O on a local port 713 * 714 * STATUS: OPTIONAL 715 */ 716 void (*fcp_abort_io)(struct fc_lport *); 717 718 /* 719 * Receive a request for the discovery layer. 720 * 721 * STATUS: OPTIONAL 722 */ 723 void (*disc_recv_req)(struct fc_lport *, struct fc_frame *); 724 725 /* 726 * Start discovery for a local port. 727 * 728 * STATUS: OPTIONAL 729 */ 730 void (*disc_start)(void (*disc_callback)(struct fc_lport *, 731 enum fc_disc_event), 732 struct fc_lport *); 733 734 /* 735 * Stop discovery for a given lport. This will remove 736 * all discovered rports 737 * 738 * STATUS: OPTIONAL 739 */ 740 void (*disc_stop) (struct fc_lport *); 741 742 /* 743 * Stop discovery for a given lport. This will block 744 * until all discovered rports are deleted from the 745 * FC transport class 746 * 747 * STATUS: OPTIONAL 748 */ 749 void (*disc_stop_final) (struct fc_lport *); 750 }; 751 752 /** 753 * struct fc_disc - Discovery context 754 * @retry_count: Number of retries 755 * @pending: 1 if discovery is pending, 0 if not 756 * @requested: 1 if discovery has been requested, 0 if not 757 * @seq_count: Number of sequences used for discovery 758 * @buf_len: Length of the discovery buffer 759 * @disc_id: Discovery ID 760 * @rports: List of discovered remote ports 761 * @priv: Private pointer for use by discovery code 762 * @disc_mutex: Mutex that protects the discovery context 763 * @partial_buf: Partial name buffer (if names are returned 764 * in multiple frames) 765 * @disc_work: handle for delayed work context 766 * @disc_callback: Callback routine called when discovery completes 767 */ 768 struct fc_disc { 769 unsigned char retry_count; 770 unsigned char pending; 771 unsigned char requested; 772 unsigned short seq_count; 773 unsigned char buf_len; 774 u16 disc_id; 775 776 struct list_head rports; 777 void *priv; 778 struct mutex disc_mutex; 779 struct fc_gpn_ft_resp partial_buf; 780 struct delayed_work disc_work; 781 782 void (*disc_callback)(struct fc_lport *, 783 enum fc_disc_event); 784 }; 785 786 /* 787 * Local port notifier and events. 788 */ 789 extern struct blocking_notifier_head fc_lport_notifier_head; 790 enum fc_lport_event { 791 FC_LPORT_EV_ADD, 792 FC_LPORT_EV_DEL, 793 }; 794 795 /** 796 * struct fc_lport - Local port 797 * @host: The SCSI host associated with a local port 798 * @ema_list: Exchange manager anchor list 799 * @dns_rdata: The directory server remote port 800 * @ptp_rdata: Point to point remote port 801 * @scsi_priv: FCP layer internal data 802 * @disc: Discovery context 803 * @vports: Child vports if N_Port 804 * @vport: Parent vport if VN_Port 805 * @tt: Libfc function template 806 * @link_up: Link state (1 = link up, 0 = link down) 807 * @qfull: Queue state (1 queue is full, 0 queue is not full) 808 * @state: Identifies the state 809 * @boot_time: Timestamp indicating when the local port came online 810 * @host_stats: SCSI host statistics 811 * @dev_stats: FCoE device stats (TODO: libfc should not be 812 * FCoE aware) 813 * @retry_count: Number of retries in the current state 814 * @port_id: FC Port ID 815 * @wwpn: World Wide Port Name 816 * @wwnn: World Wide Node Name 817 * @service_params: Common service parameters 818 * @e_d_tov: Error detection timeout value 819 * @r_a_tov: Resouce allocation timeout value 820 * @rnid_gen: RNID information 821 * @sg_supp: Indicates if scatter gather is supported 822 * @seq_offload: Indicates if sequence offload is supported 823 * @crc_offload: Indicates if CRC offload is supported 824 * @lro_enabled: Indicates if large receive offload is supported 825 * @does_npiv: Supports multiple vports 826 * @npiv_enabled: Switch/fabric allows NPIV 827 * @mfs: The maximum Fibre Channel payload size 828 * @max_retry_count: The maximum retry attempts 829 * @max_rport_retry_count: The maximum remote port retry attempts 830 * @rport_priv_size: Size needed by driver after struct fc_rport_priv 831 * @lro_xid: The maximum XID for LRO 832 * @lso_max: The maximum large offload send size 833 * @fcts: FC-4 type mask 834 * @lp_mutex: Mutex to protect the local port 835 * @list: Linkage on list of vport peers 836 * @retry_work: Handle to local port for delayed retry context 837 * @prov: Pointers available for use by passive FC-4 providers 838 * @lport_list: Linkage on module-wide list of local ports 839 */ 840 struct fc_lport { 841 /* Associations */ 842 struct Scsi_Host *host; 843 struct list_head ema_list; 844 struct fc_rport_priv *dns_rdata; 845 struct fc_rport_priv *ptp_rdata; 846 void *scsi_priv; 847 struct fc_disc disc; 848 849 /* Virtual port information */ 850 struct list_head vports; 851 struct fc_vport *vport; 852 853 /* Operational Information */ 854 struct libfc_function_template tt; 855 u8 link_up; 856 u8 qfull; 857 enum fc_lport_state state; 858 unsigned long boot_time; 859 struct fc_host_statistics host_stats; 860 struct fcoe_dev_stats __percpu *dev_stats; 861 u8 retry_count; 862 863 /* Fabric information */ 864 u32 port_id; 865 u64 wwpn; 866 u64 wwnn; 867 unsigned int service_params; 868 unsigned int e_d_tov; 869 unsigned int r_a_tov; 870 struct fc_els_rnid_gen rnid_gen; 871 872 /* Capabilities */ 873 u32 sg_supp:1; 874 u32 seq_offload:1; 875 u32 crc_offload:1; 876 u32 lro_enabled:1; 877 u32 does_npiv:1; 878 u32 npiv_enabled:1; 879 u32 point_to_multipoint:1; 880 u32 mfs; 881 u8 max_retry_count; 882 u8 max_rport_retry_count; 883 u16 rport_priv_size; 884 u16 link_speed; 885 u16 link_supported_speeds; 886 u16 lro_xid; 887 unsigned int lso_max; 888 struct fc_ns_fts fcts; 889 890 /* Miscellaneous */ 891 struct mutex lp_mutex; 892 struct list_head list; 893 struct delayed_work retry_work; 894 void *prov[FC_FC4_PROV_SIZE]; 895 struct list_head lport_list; 896 }; 897 898 /** 899 * struct fc4_prov - FC-4 provider registration 900 * @prli: Handler for incoming PRLI 901 * @prlo: Handler for session reset 902 * @recv: Handler for incoming request 903 * @module: Pointer to module. May be NULL. 904 */ 905 struct fc4_prov { 906 int (*prli)(struct fc_rport_priv *, u32 spp_len, 907 const struct fc_els_spp *spp_in, 908 struct fc_els_spp *spp_out); 909 void (*prlo)(struct fc_rport_priv *); 910 void (*recv)(struct fc_lport *, struct fc_frame *); 911 struct module *module; 912 }; 913 914 /* 915 * Register FC-4 provider with libfc. 916 */ 917 int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *); 918 void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *); 919 920 /* 921 * FC_LPORT HELPER FUNCTIONS 922 *****************************/ 923 924 /** 925 * fc_lport_test_ready() - Determine if a local port is in the READY state 926 * @lport: The local port to test 927 */ 928 static inline int fc_lport_test_ready(struct fc_lport *lport) 929 { 930 return lport->state == LPORT_ST_READY; 931 } 932 933 /** 934 * fc_set_wwnn() - Set the World Wide Node Name of a local port 935 * @lport: The local port whose WWNN is to be set 936 * @wwnn: The new WWNN 937 */ 938 static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) 939 { 940 lport->wwnn = wwnn; 941 } 942 943 /** 944 * fc_set_wwpn() - Set the World Wide Port Name of a local port 945 * @lport: The local port whose WWPN is to be set 946 * @wwnn: The new WWPN 947 */ 948 static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) 949 { 950 lport->wwpn = wwnn; 951 } 952 953 /** 954 * fc_lport_state_enter() - Change a local port's state 955 * @lport: The local port whose state is to change 956 * @state: The new state 957 */ 958 static inline void fc_lport_state_enter(struct fc_lport *lport, 959 enum fc_lport_state state) 960 { 961 if (state != lport->state) 962 lport->retry_count = 0; 963 lport->state = state; 964 } 965 966 /** 967 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port 968 * @lport: The local port whose statistics are to be initialized 969 */ 970 static inline int fc_lport_init_stats(struct fc_lport *lport) 971 { 972 lport->dev_stats = alloc_percpu(struct fcoe_dev_stats); 973 if (!lport->dev_stats) 974 return -ENOMEM; 975 return 0; 976 } 977 978 /** 979 * fc_lport_free_stats() - Free memory for a local port's statistics 980 * @lport: The local port whose statistics are to be freed 981 */ 982 static inline void fc_lport_free_stats(struct fc_lport *lport) 983 { 984 free_percpu(lport->dev_stats); 985 } 986 987 /** 988 * lport_priv() - Return the private data from a local port 989 * @lport: The local port whose private data is to be retreived 990 */ 991 static inline void *lport_priv(const struct fc_lport *lport) 992 { 993 return (void *)(lport + 1); 994 } 995 996 /** 997 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and 998 * LLD private data 999 * @sht: The SCSI host template 1000 * @priv_size: Size of private data 1001 * 1002 * Returns: libfc lport 1003 */ 1004 static inline struct fc_lport * 1005 libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 1006 { 1007 struct fc_lport *lport; 1008 struct Scsi_Host *shost; 1009 1010 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 1011 if (!shost) 1012 return NULL; 1013 lport = shost_priv(shost); 1014 lport->host = shost; 1015 INIT_LIST_HEAD(&lport->ema_list); 1016 INIT_LIST_HEAD(&lport->vports); 1017 return lport; 1018 } 1019 1020 /* 1021 * FC_FCP HELPER FUNCTIONS 1022 *****************************/ 1023 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 1024 { 1025 if (fsp && fsp->cmd) 1026 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 1027 return false; 1028 } 1029 1030 /* 1031 * LOCAL PORT LAYER 1032 *****************************/ 1033 int fc_lport_init(struct fc_lport *); 1034 int fc_lport_destroy(struct fc_lport *); 1035 int fc_fabric_logoff(struct fc_lport *); 1036 int fc_fabric_login(struct fc_lport *); 1037 void __fc_linkup(struct fc_lport *); 1038 void fc_linkup(struct fc_lport *); 1039 void __fc_linkdown(struct fc_lport *); 1040 void fc_linkdown(struct fc_lport *); 1041 void fc_vport_setlink(struct fc_lport *); 1042 void fc_vports_linkchange(struct fc_lport *); 1043 int fc_lport_config(struct fc_lport *); 1044 int fc_lport_reset(struct fc_lport *); 1045 int fc_set_mfs(struct fc_lport *, u32 mfs); 1046 struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); 1047 struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); 1048 int fc_lport_bsg_request(struct fc_bsg_job *); 1049 void fc_lport_set_local_id(struct fc_lport *, u32 port_id); 1050 void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *); 1051 1052 /* 1053 * REMOTE PORT LAYER 1054 *****************************/ 1055 int fc_rport_init(struct fc_lport *); 1056 void fc_rport_terminate_io(struct fc_rport *); 1057 1058 /* 1059 * DISCOVERY LAYER 1060 *****************************/ 1061 int fc_disc_init(struct fc_lport *); 1062 1063 static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc) 1064 { 1065 return container_of(disc, struct fc_lport, disc); 1066 } 1067 1068 /* 1069 * FCP LAYER 1070 *****************************/ 1071 int fc_fcp_init(struct fc_lport *); 1072 void fc_fcp_destroy(struct fc_lport *); 1073 1074 /* 1075 * SCSI INTERACTION LAYER 1076 *****************************/ 1077 int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *); 1078 int fc_eh_abort(struct scsi_cmnd *); 1079 int fc_eh_device_reset(struct scsi_cmnd *); 1080 int fc_eh_host_reset(struct scsi_cmnd *); 1081 int fc_slave_alloc(struct scsi_device *); 1082 int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason); 1083 int fc_change_queue_type(struct scsi_device *, int tag_type); 1084 1085 /* 1086 * ELS/CT interface 1087 *****************************/ 1088 int fc_elsct_init(struct fc_lport *); 1089 struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, 1090 struct fc_frame *, 1091 unsigned int op, 1092 void (*resp)(struct fc_seq *, 1093 struct fc_frame *, 1094 void *arg), 1095 void *arg, u32 timer_msec); 1096 void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 1097 void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 1098 void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *, 1099 enum fc_rctl, u32 parm_offset); 1100 void fc_fill_hdr(struct fc_frame *, const struct fc_frame *, 1101 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset); 1102 1103 1104 /* 1105 * EXCHANGE MANAGER LAYER 1106 *****************************/ 1107 int fc_exch_init(struct fc_lport *); 1108 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, 1109 struct fc_exch_mgr *, 1110 bool (*match)(struct fc_frame *)); 1111 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); 1112 int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 1113 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, 1114 u16 min_xid, u16 max_xid, 1115 bool (*match)(struct fc_frame *)); 1116 void fc_exch_mgr_free(struct fc_lport *); 1117 void fc_exch_recv(struct fc_lport *, struct fc_frame *); 1118 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 1119 1120 /* 1121 * Functions for fc_functions_template 1122 */ 1123 void fc_get_host_speed(struct Scsi_Host *); 1124 void fc_get_host_port_state(struct Scsi_Host *); 1125 void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout); 1126 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 1127 1128 #endif /* _LIBFC_H_ */ 1129