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