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