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 u32 recov_retry; 360 struct fc_seq *recov_seq; 361 struct completion tm_done; 362 } ____cacheline_aligned_in_smp; 363 364 /* 365 * Structure and function definitions for managing Fibre Channel Exchanges 366 * and Sequences 367 * 368 * fc_exch holds state for one exchange and links to its active sequence. 369 * 370 * fc_seq holds the state for an individual sequence. 371 */ 372 373 struct fc_exch_mgr; 374 struct fc_exch_mgr_anchor; 375 extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ 376 377 /** 378 * struct fc_seq - FC sequence 379 * @id: The sequence ID 380 * @ssb_stat: Status flags for the sequence status block (SSB) 381 * @cnt: Number of frames sent so far 382 * @rec_data: FC-4 value for REC 383 */ 384 struct fc_seq { 385 u8 id; 386 u16 ssb_stat; 387 u16 cnt; 388 u32 rec_data; 389 }; 390 391 #define FC_EX_DONE (1 << 0) /* ep is completed */ 392 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 393 394 /** 395 * struct fc_exch - Fibre Channel Exchange 396 * @em: Exchange manager 397 * @pool: Exchange pool 398 * @state: The exchange's state 399 * @xid: The exchange ID 400 * @ex_list: Handle used by the EM to track free exchanges 401 * @ex_lock: Lock that protects the exchange 402 * @ex_refcnt: Reference count 403 * @timeout_work: Handle for timeout handler 404 * @lp: The local port that this exchange is on 405 * @oxid: Originator's exchange ID 406 * @rxid: Responder's exchange ID 407 * @oid: Originator's FCID 408 * @sid: Source FCID 409 * @did: Destination FCID 410 * @esb_stat: ESB exchange status 411 * @r_a_tov: Resouce allocation time out value (in msecs) 412 * @seq_id: The next sequence ID to use 413 * @encaps: encapsulation information for lower-level driver 414 * @f_ctl: F_CTL flags for the sequence 415 * @fh_type: The frame type 416 * @class: The class of service 417 * @seq: The sequence in use on this exchange 418 * @resp_active: Number of tasks that are concurrently executing @resp(). 419 * @resp_task: If @resp_active > 0, either the task executing @resp(), the 420 * task that has been interrupted to execute the soft-IRQ 421 * executing @resp() or NULL if more than one task is executing 422 * @resp concurrently. 423 * @resp_wq: Waitqueue for the tasks waiting on @resp_active. 424 * @resp: Callback for responses on this exchange 425 * @destructor: Called when destroying the exchange 426 * @arg: Passed as a void pointer to the resp() callback 427 * 428 * Locking notes: The ex_lock protects following items: 429 * state, esb_stat, f_ctl, seq.ssb_stat 430 * seq_id 431 * sequence allocation 432 */ 433 struct fc_exch { 434 spinlock_t ex_lock; 435 atomic_t ex_refcnt; 436 enum fc_class class; 437 struct fc_exch_mgr *em; 438 struct fc_exch_pool *pool; 439 struct list_head ex_list; 440 struct fc_lport *lp; 441 u32 esb_stat; 442 u8 state; 443 u8 fh_type; 444 u8 seq_id; 445 u8 encaps; 446 u16 xid; 447 u16 oxid; 448 u16 rxid; 449 u32 oid; 450 u32 sid; 451 u32 did; 452 u32 r_a_tov; 453 u32 f_ctl; 454 struct fc_seq seq; 455 int resp_active; 456 struct task_struct *resp_task; 457 wait_queue_head_t resp_wq; 458 void (*resp)(struct fc_seq *, struct fc_frame *, void *); 459 void *arg; 460 void (*destructor)(struct fc_seq *, void *); 461 struct delayed_work timeout_work; 462 } ____cacheline_aligned_in_smp; 463 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 464 465 466 struct libfc_function_template { 467 /* 468 * Interface to send a FC frame 469 * 470 * STATUS: REQUIRED 471 */ 472 int (*frame_send)(struct fc_lport *, struct fc_frame *); 473 474 /* 475 * Interface to send ELS/CT frames 476 * 477 * STATUS: OPTIONAL 478 */ 479 struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, 480 struct fc_frame *, unsigned int op, 481 void (*resp)(struct fc_seq *, 482 struct fc_frame *, void *arg), 483 void *arg, u32 timer_msec); 484 485 /* 486 * Send the FC frame payload using a new exchange and sequence. 487 * 488 * The exchange response handler is set in this routine to resp() 489 * function pointer. It can be called in two scenarios: if a timeout 490 * occurs or if a response frame is received for the exchange. The 491 * fc_frame pointer in response handler will also indicate timeout 492 * as error using IS_ERR related macros. 493 * 494 * The exchange destructor handler is also set in this routine. 495 * The destructor handler is invoked by EM layer when exchange 496 * is about to free, this can be used by caller to free its 497 * resources along with exchange free. 498 * 499 * The arg is passed back to resp and destructor handler. 500 * 501 * The timeout value (in msec) for an exchange is set if non zero 502 * timer_msec argument is specified. The timer is canceled when 503 * it fires or when the exchange is done. The exchange timeout handler 504 * is registered by EM layer. 505 * 506 * STATUS: OPTIONAL 507 */ 508 struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *, 509 void (*resp)(struct fc_seq *, 510 struct fc_frame *, 511 void *), 512 void (*destructor)(struct fc_seq *, 513 void *), 514 void *, unsigned int timer_msec); 515 516 /* 517 * Sets up the DDP context for a given exchange id on the given 518 * scatterlist if LLD supports DDP for large receive. 519 * 520 * STATUS: OPTIONAL 521 */ 522 int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, 523 unsigned int); 524 /* 525 * Completes the DDP transfer and returns the length of data DDPed 526 * for the given exchange id. 527 * 528 * STATUS: OPTIONAL 529 */ 530 int (*ddp_done)(struct fc_lport *, u16); 531 /* 532 * Sets up the DDP context for a given exchange id on the given 533 * scatterlist if LLD supports DDP for target. 534 * 535 * STATUS: OPTIONAL 536 */ 537 int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *, 538 unsigned int); 539 /* 540 * Allow LLD to fill its own Link Error Status Block 541 * 542 * STATUS: OPTIONAL 543 */ 544 void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb); 545 /* 546 * Send a frame using an existing sequence and exchange. 547 * 548 * STATUS: OPTIONAL 549 */ 550 int (*seq_send)(struct fc_lport *, struct fc_seq *, 551 struct fc_frame *); 552 553 /* 554 * Send an ELS response using information from the received frame. 555 * 556 * STATUS: OPTIONAL 557 */ 558 void (*seq_els_rsp_send)(struct fc_frame *, enum fc_els_cmd, 559 struct fc_seq_els_data *); 560 561 /* 562 * Abort an exchange and sequence. Generally called because of a 563 * exchange timeout or an abort from the upper layer. 564 * 565 * A timer_msec can be specified for abort timeout, if non-zero 566 * timer_msec value is specified then exchange resp handler 567 * will be called with timeout error if no response to abort. 568 * 569 * STATUS: OPTIONAL 570 */ 571 int (*seq_exch_abort)(const struct fc_seq *, 572 unsigned int timer_msec); 573 574 /* 575 * Indicate that an exchange/sequence tuple is complete and the memory 576 * allocated for the related objects may be freed. 577 * 578 * STATUS: OPTIONAL 579 */ 580 void (*exch_done)(struct fc_seq *); 581 582 /* 583 * Start a new sequence on the same exchange/sequence tuple. 584 * 585 * STATUS: OPTIONAL 586 */ 587 struct fc_seq *(*seq_start_next)(struct fc_seq *); 588 589 /* 590 * Set a response handler for the exchange of the sequence. 591 * 592 * STATUS: OPTIONAL 593 */ 594 void (*seq_set_resp)(struct fc_seq *sp, 595 void (*resp)(struct fc_seq *, struct fc_frame *, 596 void *), 597 void *arg); 598 599 /* 600 * Assign a sequence for an incoming request frame. 601 * 602 * STATUS: OPTIONAL 603 */ 604 struct fc_seq *(*seq_assign)(struct fc_lport *, struct fc_frame *); 605 606 /* 607 * Release the reference on the sequence returned by seq_assign(). 608 * 609 * STATUS: OPTIONAL 610 */ 611 void (*seq_release)(struct fc_seq *); 612 613 /* 614 * Reset an exchange manager, completing all sequences and exchanges. 615 * If s_id is non-zero, reset only exchanges originating from that FID. 616 * If d_id is non-zero, reset only exchanges sending to that FID. 617 * 618 * STATUS: OPTIONAL 619 */ 620 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); 621 622 /* 623 * Flush the rport work queue. Generally used before shutdown. 624 * 625 * STATUS: OPTIONAL 626 */ 627 void (*rport_flush_queue)(void); 628 629 /* 630 * Receive a frame for a local port. 631 * 632 * STATUS: OPTIONAL 633 */ 634 void (*lport_recv)(struct fc_lport *, struct fc_frame *); 635 636 /* 637 * Reset the local port. 638 * 639 * STATUS: OPTIONAL 640 */ 641 int (*lport_reset)(struct fc_lport *); 642 643 /* 644 * Set the local port FC_ID. 645 * 646 * This may be provided by the LLD to allow it to be 647 * notified when the local port is assigned a FC-ID. 648 * 649 * The frame, if non-NULL, is the incoming frame with the 650 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC 651 * address for the LLD. The frame pointer may be NULL if 652 * no MAC is associated with this assignment (LOGO or PLOGI). 653 * 654 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid. 655 * 656 * Note: this is called with the local port mutex held. 657 * 658 * STATUS: OPTIONAL 659 */ 660 void (*lport_set_port_id)(struct fc_lport *, u32 port_id, 661 struct fc_frame *); 662 663 /* 664 * Create a remote port with a given port ID 665 * 666 * STATUS: OPTIONAL 667 */ 668 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); 669 670 /* 671 * Initiates the RP state machine. It is called from the LP module. 672 * This function will issue the following commands to the N_Port 673 * identified by the FC ID provided. 674 * 675 * - PLOGI 676 * - PRLI 677 * - RTV 678 * 679 * STATUS: OPTIONAL 680 */ 681 int (*rport_login)(struct fc_rport_priv *); 682 683 /* 684 * Logoff, and remove the rport from the transport if 685 * it had been added. This will send a LOGO to the target. 686 * 687 * STATUS: OPTIONAL 688 */ 689 int (*rport_logoff)(struct fc_rport_priv *); 690 691 /* 692 * Receive a request from a remote port. 693 * 694 * STATUS: OPTIONAL 695 */ 696 void (*rport_recv_req)(struct fc_lport *, struct fc_frame *); 697 698 /* 699 * lookup an rport by it's port ID. 700 * 701 * STATUS: OPTIONAL 702 */ 703 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); 704 705 /* 706 * Destroy an rport after final kref_put(). 707 * The argument is a pointer to the kref inside the fc_rport_priv. 708 */ 709 void (*rport_destroy)(struct kref *); 710 711 /* 712 * Callback routine after the remote port is logged in 713 * 714 * STATUS: OPTIONAL 715 */ 716 void (*rport_event_callback)(struct fc_lport *, 717 struct fc_rport_priv *, 718 enum fc_rport_event); 719 720 /* 721 * Send a fcp cmd from fsp pkt. 722 * Called with the SCSI host lock unlocked and irqs disabled. 723 * 724 * The resp handler is called when FCP_RSP received. 725 * 726 * STATUS: OPTIONAL 727 */ 728 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, 729 void (*resp)(struct fc_seq *, struct fc_frame *, 730 void *)); 731 732 /* 733 * Cleanup the FCP layer, used during link down and reset 734 * 735 * STATUS: OPTIONAL 736 */ 737 void (*fcp_cleanup)(struct fc_lport *); 738 739 /* 740 * Abort all I/O on a local port 741 * 742 * STATUS: OPTIONAL 743 */ 744 void (*fcp_abort_io)(struct fc_lport *); 745 746 /* 747 * Receive a request for the discovery layer. 748 * 749 * STATUS: OPTIONAL 750 */ 751 void (*disc_recv_req)(struct fc_lport *, struct fc_frame *); 752 753 /* 754 * Start discovery for a local port. 755 * 756 * STATUS: OPTIONAL 757 */ 758 void (*disc_start)(void (*disc_callback)(struct fc_lport *, 759 enum fc_disc_event), 760 struct fc_lport *); 761 762 /* 763 * Stop discovery for a given lport. This will remove 764 * all discovered rports 765 * 766 * STATUS: OPTIONAL 767 */ 768 void (*disc_stop) (struct fc_lport *); 769 770 /* 771 * Stop discovery for a given lport. This will block 772 * until all discovered rports are deleted from the 773 * FC transport class 774 * 775 * STATUS: OPTIONAL 776 */ 777 void (*disc_stop_final) (struct fc_lport *); 778 }; 779 780 /** 781 * struct fc_disc - Discovery context 782 * @retry_count: Number of retries 783 * @pending: 1 if discovery is pending, 0 if not 784 * @requested: 1 if discovery has been requested, 0 if not 785 * @seq_count: Number of sequences used for discovery 786 * @buf_len: Length of the discovery buffer 787 * @disc_id: Discovery ID 788 * @rports: List of discovered remote ports 789 * @priv: Private pointer for use by discovery code 790 * @disc_mutex: Mutex that protects the discovery context 791 * @partial_buf: Partial name buffer (if names are returned 792 * in multiple frames) 793 * @disc_work: handle for delayed work context 794 * @disc_callback: Callback routine called when discovery completes 795 */ 796 struct fc_disc { 797 unsigned char retry_count; 798 unsigned char pending; 799 unsigned char requested; 800 unsigned short seq_count; 801 unsigned char buf_len; 802 u16 disc_id; 803 804 struct list_head rports; 805 void *priv; 806 struct mutex disc_mutex; 807 struct fc_gpn_ft_resp partial_buf; 808 struct delayed_work disc_work; 809 810 void (*disc_callback)(struct fc_lport *, 811 enum fc_disc_event); 812 }; 813 814 /* 815 * Local port notifier and events. 816 */ 817 extern struct blocking_notifier_head fc_lport_notifier_head; 818 enum fc_lport_event { 819 FC_LPORT_EV_ADD, 820 FC_LPORT_EV_DEL, 821 }; 822 823 /** 824 * struct fc_lport - Local port 825 * @host: The SCSI host associated with a local port 826 * @ema_list: Exchange manager anchor list 827 * @dns_rdata: The directory server remote port 828 * @ms_rdata: The management server remote port 829 * @ptp_rdata: Point to point remote port 830 * @scsi_priv: FCP layer internal data 831 * @disc: Discovery context 832 * @vports: Child vports if N_Port 833 * @vport: Parent vport if VN_Port 834 * @tt: Libfc function template 835 * @link_up: Link state (1 = link up, 0 = link down) 836 * @qfull: Queue state (1 queue is full, 0 queue is not full) 837 * @state: Identifies the state 838 * @boot_time: Timestamp indicating when the local port came online 839 * @host_stats: SCSI host statistics 840 * @stats: FC local port stats (TODO separate libfc LLD stats) 841 * @retry_count: Number of retries in the current state 842 * @port_id: FC Port ID 843 * @wwpn: World Wide Port Name 844 * @wwnn: World Wide Node Name 845 * @service_params: Common service parameters 846 * @e_d_tov: Error detection timeout value 847 * @r_a_tov: Resouce allocation timeout value 848 * @rnid_gen: RNID information 849 * @sg_supp: Indicates if scatter gather is supported 850 * @seq_offload: Indicates if sequence offload is supported 851 * @crc_offload: Indicates if CRC offload is supported 852 * @lro_enabled: Indicates if large receive offload is supported 853 * @does_npiv: Supports multiple vports 854 * @npiv_enabled: Switch/fabric allows NPIV 855 * @mfs: The maximum Fibre Channel payload size 856 * @max_retry_count: The maximum retry attempts 857 * @max_rport_retry_count: The maximum remote port retry attempts 858 * @rport_priv_size: Size needed by driver after struct fc_rport_priv 859 * @lro_xid: The maximum XID for LRO 860 * @lso_max: The maximum large offload send size 861 * @fcts: FC-4 type mask 862 * @lp_mutex: Mutex to protect the local port 863 * @list: Linkage on list of vport peers 864 * @retry_work: Handle to local port for delayed retry context 865 * @prov: Pointers available for use by passive FC-4 providers 866 * @lport_list: Linkage on module-wide list of local ports 867 */ 868 struct fc_lport { 869 /* Associations */ 870 struct Scsi_Host *host; 871 struct list_head ema_list; 872 struct fc_rport_priv *dns_rdata; 873 struct fc_rport_priv *ms_rdata; 874 struct fc_rport_priv *ptp_rdata; 875 void *scsi_priv; 876 struct fc_disc disc; 877 878 /* Virtual port information */ 879 struct list_head vports; 880 struct fc_vport *vport; 881 882 /* Operational Information */ 883 struct libfc_function_template tt; 884 u8 link_up; 885 u8 qfull; 886 u16 vlan; 887 enum fc_lport_state state; 888 unsigned long boot_time; 889 struct fc_host_statistics host_stats; 890 struct fc_stats __percpu *stats; 891 u8 retry_count; 892 893 /* Fabric information */ 894 u32 port_id; 895 u64 wwpn; 896 u64 wwnn; 897 unsigned int service_params; 898 unsigned int e_d_tov; 899 unsigned int r_a_tov; 900 struct fc_els_rnid_gen rnid_gen; 901 902 /* Capabilities */ 903 u32 sg_supp:1; 904 u32 seq_offload:1; 905 u32 crc_offload:1; 906 u32 lro_enabled:1; 907 u32 does_npiv:1; 908 u32 npiv_enabled:1; 909 u32 point_to_multipoint:1; 910 u32 fdmi_enabled:1; 911 u32 mfs; 912 u8 max_retry_count; 913 u8 max_rport_retry_count; 914 u16 rport_priv_size; 915 u16 link_speed; 916 u16 link_supported_speeds; 917 u16 lro_xid; 918 unsigned int lso_max; 919 struct fc_ns_fts fcts; 920 921 /* Miscellaneous */ 922 struct mutex lp_mutex; 923 struct list_head list; 924 struct delayed_work retry_work; 925 void *prov[FC_FC4_PROV_SIZE]; 926 struct list_head lport_list; 927 }; 928 929 /** 930 * struct fc4_prov - FC-4 provider registration 931 * @prli: Handler for incoming PRLI 932 * @prlo: Handler for session reset 933 * @recv: Handler for incoming request 934 * @module: Pointer to module. May be NULL. 935 */ 936 struct fc4_prov { 937 int (*prli)(struct fc_rport_priv *, u32 spp_len, 938 const struct fc_els_spp *spp_in, 939 struct fc_els_spp *spp_out); 940 void (*prlo)(struct fc_rport_priv *); 941 void (*recv)(struct fc_lport *, struct fc_frame *); 942 struct module *module; 943 }; 944 945 /* 946 * Register FC-4 provider with libfc. 947 */ 948 int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *); 949 void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *); 950 951 /* 952 * FC_LPORT HELPER FUNCTIONS 953 *****************************/ 954 955 /** 956 * fc_lport_test_ready() - Determine if a local port is in the READY state 957 * @lport: The local port to test 958 */ 959 static inline int fc_lport_test_ready(struct fc_lport *lport) 960 { 961 return lport->state == LPORT_ST_READY; 962 } 963 964 /** 965 * fc_set_wwnn() - Set the World Wide Node Name of a local port 966 * @lport: The local port whose WWNN is to be set 967 * @wwnn: The new WWNN 968 */ 969 static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) 970 { 971 lport->wwnn = wwnn; 972 } 973 974 /** 975 * fc_set_wwpn() - Set the World Wide Port Name of a local port 976 * @lport: The local port whose WWPN is to be set 977 * @wwnn: The new WWPN 978 */ 979 static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) 980 { 981 lport->wwpn = wwnn; 982 } 983 984 /** 985 * fc_lport_state_enter() - Change a local port's state 986 * @lport: The local port whose state is to change 987 * @state: The new state 988 */ 989 static inline void fc_lport_state_enter(struct fc_lport *lport, 990 enum fc_lport_state state) 991 { 992 if (state != lport->state) 993 lport->retry_count = 0; 994 lport->state = state; 995 } 996 997 /** 998 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port 999 * @lport: The local port whose statistics are to be initialized 1000 */ 1001 static inline int fc_lport_init_stats(struct fc_lport *lport) 1002 { 1003 lport->stats = alloc_percpu(struct fc_stats); 1004 if (!lport->stats) 1005 return -ENOMEM; 1006 return 0; 1007 } 1008 1009 /** 1010 * fc_lport_free_stats() - Free memory for a local port's statistics 1011 * @lport: The local port whose statistics are to be freed 1012 */ 1013 static inline void fc_lport_free_stats(struct fc_lport *lport) 1014 { 1015 free_percpu(lport->stats); 1016 } 1017 1018 /** 1019 * lport_priv() - Return the private data from a local port 1020 * @lport: The local port whose private data is to be retreived 1021 */ 1022 static inline void *lport_priv(const struct fc_lport *lport) 1023 { 1024 return (void *)(lport + 1); 1025 } 1026 1027 /** 1028 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and 1029 * LLD private data 1030 * @sht: The SCSI host template 1031 * @priv_size: Size of private data 1032 * 1033 * Returns: libfc lport 1034 */ 1035 static inline struct fc_lport * 1036 libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 1037 { 1038 struct fc_lport *lport; 1039 struct Scsi_Host *shost; 1040 1041 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size); 1042 if (!shost) 1043 return NULL; 1044 lport = shost_priv(shost); 1045 lport->host = shost; 1046 INIT_LIST_HEAD(&lport->ema_list); 1047 INIT_LIST_HEAD(&lport->vports); 1048 return lport; 1049 } 1050 1051 /* 1052 * FC_FCP HELPER FUNCTIONS 1053 *****************************/ 1054 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 1055 { 1056 if (fsp && fsp->cmd) 1057 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 1058 return false; 1059 } 1060 1061 /* 1062 * LOCAL PORT LAYER 1063 *****************************/ 1064 int fc_lport_init(struct fc_lport *); 1065 int fc_lport_destroy(struct fc_lport *); 1066 int fc_fabric_logoff(struct fc_lport *); 1067 int fc_fabric_login(struct fc_lport *); 1068 void __fc_linkup(struct fc_lport *); 1069 void fc_linkup(struct fc_lport *); 1070 void __fc_linkdown(struct fc_lport *); 1071 void fc_linkdown(struct fc_lport *); 1072 void fc_vport_setlink(struct fc_lport *); 1073 void fc_vports_linkchange(struct fc_lport *); 1074 int fc_lport_config(struct fc_lport *); 1075 int fc_lport_reset(struct fc_lport *); 1076 int fc_set_mfs(struct fc_lport *, u32 mfs); 1077 struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); 1078 struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); 1079 int fc_lport_bsg_request(struct fc_bsg_job *); 1080 void fc_lport_set_local_id(struct fc_lport *, u32 port_id); 1081 void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *); 1082 1083 /* 1084 * REMOTE PORT LAYER 1085 *****************************/ 1086 int fc_rport_init(struct fc_lport *); 1087 void fc_rport_terminate_io(struct fc_rport *); 1088 1089 /* 1090 * DISCOVERY LAYER 1091 *****************************/ 1092 void fc_disc_init(struct fc_lport *); 1093 void fc_disc_config(struct fc_lport *, void *); 1094 1095 static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc) 1096 { 1097 return container_of(disc, struct fc_lport, disc); 1098 } 1099 1100 /* 1101 * FCP LAYER 1102 *****************************/ 1103 int fc_fcp_init(struct fc_lport *); 1104 void fc_fcp_destroy(struct fc_lport *); 1105 1106 /* 1107 * SCSI INTERACTION LAYER 1108 *****************************/ 1109 int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *); 1110 int fc_eh_abort(struct scsi_cmnd *); 1111 int fc_eh_device_reset(struct scsi_cmnd *); 1112 int fc_eh_host_reset(struct scsi_cmnd *); 1113 int fc_slave_alloc(struct scsi_device *); 1114 1115 /* 1116 * ELS/CT interface 1117 *****************************/ 1118 int fc_elsct_init(struct fc_lport *); 1119 struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, 1120 struct fc_frame *, 1121 unsigned int op, 1122 void (*resp)(struct fc_seq *, 1123 struct fc_frame *, 1124 void *arg), 1125 void *arg, u32 timer_msec); 1126 void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); 1127 void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); 1128 void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *, 1129 enum fc_rctl, u32 parm_offset); 1130 void fc_fill_hdr(struct fc_frame *, const struct fc_frame *, 1131 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset); 1132 1133 1134 /* 1135 * EXCHANGE MANAGER LAYER 1136 *****************************/ 1137 int fc_exch_init(struct fc_lport *); 1138 void fc_exch_update_stats(struct fc_lport *lport); 1139 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, 1140 struct fc_exch_mgr *, 1141 bool (*match)(struct fc_frame *)); 1142 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); 1143 int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); 1144 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, 1145 u16 min_xid, u16 max_xid, 1146 bool (*match)(struct fc_frame *)); 1147 void fc_exch_mgr_free(struct fc_lport *); 1148 void fc_exch_recv(struct fc_lport *, struct fc_frame *); 1149 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 1150 1151 /* 1152 * Functions for fc_functions_template 1153 */ 1154 void fc_get_host_speed(struct Scsi_Host *); 1155 void fc_get_host_port_state(struct Scsi_Host *); 1156 void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout); 1157 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 1158 1159 #endif /* _LIBFC_H_ */ 1160