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