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