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 30 #include <scsi/fc/fc_fcp.h> 31 #include <scsi/fc/fc_ns.h> 32 #include <scsi/fc/fc_els.h> 33 #include <scsi/fc/fc_gs.h> 34 35 #include <scsi/fc_frame.h> 36 37 #define FC_LIBFC_LOGGING 0x01 /* General logging, not categorized */ 38 #define FC_LPORT_LOGGING 0x02 /* lport layer logging */ 39 #define FC_DISC_LOGGING 0x04 /* discovery layer logging */ 40 #define FC_RPORT_LOGGING 0x08 /* rport layer logging */ 41 #define FC_FCP_LOGGING 0x10 /* I/O path logging */ 42 #define FC_EM_LOGGING 0x20 /* Exchange Manager logging */ 43 #define FC_EXCH_LOGGING 0x40 /* Exchange/Sequence logging */ 44 #define FC_SCSI_LOGGING 0x80 /* SCSI logging (mostly error handling) */ 45 46 extern unsigned int fc_debug_logging; 47 48 #define FC_CHECK_LOGGING(LEVEL, CMD) \ 49 do { \ 50 if (unlikely(fc_debug_logging & LEVEL)) \ 51 do { \ 52 CMD; \ 53 } while (0); \ 54 } while (0) 55 56 #define FC_LIBFC_DBG(fmt, args...) \ 57 FC_CHECK_LOGGING(FC_LIBFC_LOGGING, \ 58 printk(KERN_INFO "libfc: " fmt, ##args)) 59 60 #define FC_LPORT_DBG(lport, fmt, args...) \ 61 FC_CHECK_LOGGING(FC_LPORT_LOGGING, \ 62 printk(KERN_INFO "host%u: lport %6x: " fmt, \ 63 (lport)->host->host_no, \ 64 fc_host_port_id((lport)->host), ##args)) 65 66 #define FC_DISC_DBG(disc, fmt, args...) \ 67 FC_CHECK_LOGGING(FC_DISC_LOGGING, \ 68 printk(KERN_INFO "host%u: disc: " fmt, \ 69 (disc)->lport->host->host_no, \ 70 ##args)) 71 72 #define FC_RPORT_ID_DBG(lport, port_id, fmt, args...) \ 73 FC_CHECK_LOGGING(FC_RPORT_LOGGING, \ 74 printk(KERN_INFO "host%u: rport %6x: " fmt, \ 75 (lport)->host->host_no, \ 76 (port_id), ##args)) 77 78 #define FC_RPORT_DBG(rport, fmt, args...) \ 79 do { \ 80 struct fc_rport_libfc_priv *rdata = rport->dd_data; \ 81 struct fc_lport *lport = rdata->local_port; \ 82 FC_RPORT_ID_DBG(lport, rport->port_id, fmt, ##args); \ 83 } while (0) 84 85 #define FC_FCP_DBG(pkt, fmt, args...) \ 86 FC_CHECK_LOGGING(FC_FCP_LOGGING, \ 87 printk(KERN_INFO "host%u: fcp: %6x: " fmt, \ 88 (pkt)->lp->host->host_no, \ 89 pkt->rport->port_id, ##args)) 90 91 #define FC_EM_DBG(em, fmt, args...) \ 92 FC_CHECK_LOGGING(FC_EM_LOGGING, \ 93 printk(KERN_INFO "host%u: em: " fmt, \ 94 (em)->lp->host->host_no, \ 95 ##args)) 96 97 #define FC_EXCH_DBG(exch, fmt, args...) \ 98 FC_CHECK_LOGGING(FC_EXCH_LOGGING, \ 99 printk(KERN_INFO "host%u: xid %4x: " fmt, \ 100 (exch)->lp->host->host_no, \ 101 exch->xid, ##args)) 102 103 #define FC_SCSI_DBG(lport, fmt, args...) \ 104 FC_CHECK_LOGGING(FC_SCSI_LOGGING, \ 105 printk(KERN_INFO "host%u: scsi: " fmt, \ 106 (lport)->host->host_no, ##args)) 107 108 /* 109 * libfc error codes 110 */ 111 #define FC_NO_ERR 0 /* no error */ 112 #define FC_EX_TIMEOUT 1 /* Exchange timeout */ 113 #define FC_EX_CLOSED 2 /* Exchange closed */ 114 115 /* some helpful macros */ 116 117 #define ntohll(x) be64_to_cpu(x) 118 #define htonll(x) cpu_to_be64(x) 119 120 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 121 122 #define hton24(p, v) do { \ 123 p[0] = (((v) >> 16) & 0xFF); \ 124 p[1] = (((v) >> 8) & 0xFF); \ 125 p[2] = ((v) & 0xFF); \ 126 } while (0) 127 128 /* 129 * FC HBA status 130 */ 131 enum fc_lport_state { 132 LPORT_ST_DISABLED = 0, 133 LPORT_ST_FLOGI, 134 LPORT_ST_DNS, 135 LPORT_ST_RPN_ID, 136 LPORT_ST_RFT_ID, 137 LPORT_ST_SCR, 138 LPORT_ST_READY, 139 LPORT_ST_LOGO, 140 LPORT_ST_RESET 141 }; 142 143 enum fc_disc_event { 144 DISC_EV_NONE = 0, 145 DISC_EV_SUCCESS, 146 DISC_EV_FAILED 147 }; 148 149 enum fc_rport_state { 150 RPORT_ST_INIT, /* initialized */ 151 RPORT_ST_PLOGI, /* waiting for PLOGI completion */ 152 RPORT_ST_PRLI, /* waiting for PRLI completion */ 153 RPORT_ST_RTV, /* waiting for RTV completion */ 154 RPORT_ST_READY, /* ready for use */ 155 RPORT_ST_LOGO, /* port logout sent */ 156 RPORT_ST_DELETE, /* port being deleted */ 157 }; 158 159 enum fc_rport_trans_state { 160 FC_PORTSTATE_ROGUE, 161 FC_PORTSTATE_REAL, 162 }; 163 164 /** 165 * struct fc_disc_port - temporary discovery port to hold rport identifiers 166 * @lp: Fibre Channel host port instance 167 * @peers: node for list management during discovery and RSCN processing 168 * @ids: identifiers structure to pass to fc_remote_port_add() 169 * @rport_work: work struct for starting the rport state machine 170 */ 171 struct fc_disc_port { 172 struct fc_lport *lp; 173 struct list_head peers; 174 struct fc_rport_identifiers ids; 175 struct work_struct rport_work; 176 }; 177 178 enum fc_rport_event { 179 RPORT_EV_NONE = 0, 180 RPORT_EV_CREATED, 181 RPORT_EV_FAILED, 182 RPORT_EV_STOP, 183 RPORT_EV_LOGO 184 }; 185 186 struct fc_rport_operations { 187 void (*event_callback)(struct fc_lport *, struct fc_rport *, 188 enum fc_rport_event); 189 }; 190 191 /** 192 * struct fc_rport_libfc_priv - libfc internal information about a remote port 193 * @local_port: Fibre Channel host port instance 194 * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges 195 * @flags: REC and RETRY supported flags 196 * @max_seq: maximum number of concurrent sequences 197 * @retries: retry count in current state 198 * @e_d_tov: error detect timeout value (in msec) 199 * @r_a_tov: resource allocation timeout value (in msec) 200 * @rp_mutex: mutex protects rport 201 * @retry_work: 202 * @event_callback: Callback for rport READY, FAILED or LOGO 203 */ 204 struct fc_rport_libfc_priv { 205 struct fc_lport *local_port; 206 enum fc_rport_state rp_state; 207 u16 flags; 208 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) 209 #define FC_RP_FLAGS_RETRY (1 << 1) 210 u16 max_seq; 211 unsigned int retries; 212 unsigned int e_d_tov; 213 unsigned int r_a_tov; 214 enum fc_rport_trans_state trans_state; 215 struct mutex rp_mutex; 216 struct delayed_work retry_work; 217 enum fc_rport_event event; 218 struct fc_rport_operations *ops; 219 struct list_head peers; 220 struct work_struct event_work; 221 }; 222 223 #define PRIV_TO_RPORT(x) \ 224 (struct fc_rport *)((void *)x - sizeof(struct fc_rport)); 225 #define RPORT_TO_PRIV(x) \ 226 (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport)); 227 228 struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *); 229 230 static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn) 231 { 232 rport->node_name = wwnn; 233 rport->port_name = wwpn; 234 } 235 236 /* 237 * fcoe stats structure 238 */ 239 struct fcoe_dev_stats { 240 u64 SecondsSinceLastReset; 241 u64 TxFrames; 242 u64 TxWords; 243 u64 RxFrames; 244 u64 RxWords; 245 u64 ErrorFrames; 246 u64 DumpedFrames; 247 u64 LinkFailureCount; 248 u64 LossOfSignalCount; 249 u64 InvalidTxWordCount; 250 u64 InvalidCRCCount; 251 u64 InputRequests; 252 u64 OutputRequests; 253 u64 ControlRequests; 254 u64 InputMegabytes; 255 u64 OutputMegabytes; 256 }; 257 258 /* 259 * els data is used for passing ELS respone specific 260 * data to send ELS response mainly using infomation 261 * in exchange and sequence in EM layer. 262 */ 263 struct fc_seq_els_data { 264 struct fc_frame *fp; 265 enum fc_els_rjt_reason reason; 266 enum fc_els_rjt_explan explan; 267 }; 268 269 /* 270 * FCP request structure, one for each scsi cmd request 271 */ 272 struct fc_fcp_pkt { 273 /* 274 * housekeeping stuff 275 */ 276 struct fc_lport *lp; /* handle to hba struct */ 277 u16 state; /* scsi_pkt state state */ 278 u16 tgt_flags; /* target flags */ 279 atomic_t ref_cnt; /* fcp pkt ref count */ 280 spinlock_t scsi_pkt_lock; /* Must be taken before the host lock 281 * if both are held at the same time */ 282 /* 283 * SCSI I/O related stuff 284 */ 285 struct scsi_cmnd *cmd; /* scsi command pointer. set/clear 286 * under host lock */ 287 struct list_head list; /* tracks queued commands. access under 288 * host lock */ 289 /* 290 * timeout related stuff 291 */ 292 struct timer_list timer; /* command timer */ 293 struct completion tm_done; 294 int wait_for_comp; 295 unsigned long start_time; /* start jiffie */ 296 unsigned long end_time; /* end jiffie */ 297 unsigned long last_pkt_time; /* jiffies of last frame received */ 298 299 /* 300 * scsi cmd and data transfer information 301 */ 302 u32 data_len; 303 /* 304 * transport related veriables 305 */ 306 struct fcp_cmnd cdb_cmd; 307 size_t xfer_len; 308 u16 xfer_ddp; /* this xfer is ddped */ 309 u32 xfer_contig_end; /* offset of end of contiguous xfer */ 310 u16 max_payload; /* max payload size in bytes */ 311 312 /* 313 * scsi/fcp return status 314 */ 315 u32 io_status; /* SCSI result upper 24 bits */ 316 u8 cdb_status; 317 u8 status_code; /* FCP I/O status */ 318 /* bit 3 Underrun bit 2: overrun */ 319 u8 scsi_comp_flags; 320 u32 req_flags; /* bit 0: read bit:1 write */ 321 u32 scsi_resid; /* residule length */ 322 323 struct fc_rport *rport; /* remote port pointer */ 324 struct fc_seq *seq_ptr; /* current sequence pointer */ 325 /* 326 * Error Processing 327 */ 328 u8 recov_retry; /* count of recovery retries */ 329 struct fc_seq *recov_seq; /* sequence for REC or SRR */ 330 }; 331 /* 332 * FC_FCP HELPER FUNCTIONS 333 *****************************/ 334 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp) 335 { 336 if (fsp && fsp->cmd) 337 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE; 338 return false; 339 } 340 341 /* 342 * Structure and function definitions for managing Fibre Channel Exchanges 343 * and Sequences 344 * 345 * fc_exch holds state for one exchange and links to its active sequence. 346 * 347 * fc_seq holds the state for an individual sequence. 348 */ 349 350 struct fc_exch_mgr; 351 352 /* 353 * Sequence. 354 */ 355 struct fc_seq { 356 u8 id; /* seq ID */ 357 u16 ssb_stat; /* status flags for sequence status block */ 358 u16 cnt; /* frames sent so far on sequence */ 359 u32 rec_data; /* FC-4 value for REC */ 360 }; 361 362 #define FC_EX_DONE (1 << 0) /* ep is completed */ 363 #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ 364 365 /* 366 * Exchange. 367 * 368 * Locking notes: The ex_lock protects following items: 369 * state, esb_stat, f_ctl, seq.ssb_stat 370 * seq_id 371 * sequence allocation 372 */ 373 struct fc_exch { 374 struct fc_exch_mgr *em; /* exchange manager */ 375 u32 state; /* internal driver state */ 376 u16 xid; /* our exchange ID */ 377 struct list_head ex_list; /* free or busy list linkage */ 378 spinlock_t ex_lock; /* lock covering exchange state */ 379 atomic_t ex_refcnt; /* reference counter */ 380 struct delayed_work timeout_work; /* timer for upper level protocols */ 381 struct fc_lport *lp; /* fc device instance */ 382 u16 oxid; /* originator's exchange ID */ 383 u16 rxid; /* responder's exchange ID */ 384 u32 oid; /* originator's FCID */ 385 u32 sid; /* source FCID */ 386 u32 did; /* destination FCID */ 387 u32 esb_stat; /* exchange status for ESB */ 388 u32 r_a_tov; /* r_a_tov from rport (msec) */ 389 u8 seq_id; /* next sequence ID to use */ 390 u32 f_ctl; /* F_CTL flags for sequences */ 391 u8 fh_type; /* frame type */ 392 enum fc_class class; /* class of service */ 393 struct fc_seq seq; /* single sequence */ 394 /* 395 * Handler for responses to this current exchange. 396 */ 397 void (*resp)(struct fc_seq *, struct fc_frame *, void *); 398 void (*destructor)(struct fc_seq *, void *); 399 /* 400 * arg is passed as void pointer to exchange 401 * resp and destructor handlers 402 */ 403 void *arg; 404 }; 405 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) 406 407 struct libfc_function_template { 408 409 /* 410 * Interface to send a FC frame 411 * 412 * STATUS: REQUIRED 413 */ 414 int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); 415 416 /* 417 * Interface to send ELS/CT frames 418 * 419 * STATUS: OPTIONAL 420 */ 421 struct fc_seq *(*elsct_send)(struct fc_lport *lport, 422 struct fc_rport *rport, 423 struct fc_frame *fp, 424 unsigned int op, 425 void (*resp)(struct fc_seq *, 426 struct fc_frame *fp, 427 void *arg), 428 void *arg, u32 timer_msec); 429 430 /* 431 * Send the FC frame payload using a new exchange and sequence. 432 * 433 * The frame pointer with some of the header's fields must be 434 * filled before calling exch_seq_send(), those fields are, 435 * 436 * - routing control 437 * - FC port did 438 * - FC port sid 439 * - FC header type 440 * - frame control 441 * - parameter or relative offset 442 * 443 * The exchange response handler is set in this routine to resp() 444 * function pointer. It can be called in two scenarios: if a timeout 445 * occurs or if a response frame is received for the exchange. The 446 * fc_frame pointer in response handler will also indicate timeout 447 * as error using IS_ERR related macros. 448 * 449 * The exchange destructor handler is also set in this routine. 450 * The destructor handler is invoked by EM layer when exchange 451 * is about to free, this can be used by caller to free its 452 * resources along with exchange free. 453 * 454 * The arg is passed back to resp and destructor handler. 455 * 456 * The timeout value (in msec) for an exchange is set if non zero 457 * timer_msec argument is specified. The timer is canceled when 458 * it fires or when the exchange is done. The exchange timeout handler 459 * is registered by EM layer. 460 * 461 * STATUS: OPTIONAL 462 */ 463 struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, 464 struct fc_frame *fp, 465 void (*resp)(struct fc_seq *sp, 466 struct fc_frame *fp, 467 void *arg), 468 void (*destructor)(struct fc_seq *sp, 469 void *arg), 470 void *arg, unsigned int timer_msec); 471 472 /* 473 * Sets up the DDP context for a given exchange id on the given 474 * scatterlist if LLD supports DDP for large receive. 475 * 476 * STATUS: OPTIONAL 477 */ 478 int (*ddp_setup)(struct fc_lport *lp, u16 xid, 479 struct scatterlist *sgl, unsigned int sgc); 480 /* 481 * Completes the DDP transfer and returns the length of data DDPed 482 * for the given exchange id. 483 * 484 * STATUS: OPTIONAL 485 */ 486 int (*ddp_done)(struct fc_lport *lp, u16 xid); 487 /* 488 * Send a frame using an existing sequence and exchange. 489 * 490 * STATUS: OPTIONAL 491 */ 492 int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, 493 struct fc_frame *fp); 494 495 /* 496 * Send an ELS response using infomation from a previous 497 * exchange and sequence. 498 * 499 * STATUS: OPTIONAL 500 */ 501 void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, 502 struct fc_seq_els_data *els_data); 503 504 /* 505 * Abort an exchange and sequence. Generally called because of a 506 * exchange timeout or an abort from the upper layer. 507 * 508 * A timer_msec can be specified for abort timeout, if non-zero 509 * timer_msec value is specified then exchange resp handler 510 * will be called with timeout error if no response to abort. 511 * 512 * STATUS: OPTIONAL 513 */ 514 int (*seq_exch_abort)(const struct fc_seq *req_sp, 515 unsigned int timer_msec); 516 517 /* 518 * Indicate that an exchange/sequence tuple is complete and the memory 519 * allocated for the related objects may be freed. 520 * 521 * STATUS: OPTIONAL 522 */ 523 void (*exch_done)(struct fc_seq *sp); 524 525 /* 526 * Assigns a EM and a free XID for an new exchange and then 527 * allocates a new exchange and sequence pair. 528 * The fp can be used to determine free XID. 529 * 530 * STATUS: OPTIONAL 531 */ 532 struct fc_exch *(*exch_get)(struct fc_lport *lp, struct fc_frame *fp); 533 534 /* 535 * Release previously assigned XID by exch_get API. 536 * The LLD may implement this if XID is assigned by LLD 537 * in exch_get(). 538 * 539 * STATUS: OPTIONAL 540 */ 541 void (*exch_put)(struct fc_lport *lp, struct fc_exch_mgr *mp, 542 u16 ex_id); 543 544 /* 545 * Start a new sequence on the same exchange/sequence tuple. 546 * 547 * STATUS: OPTIONAL 548 */ 549 struct fc_seq *(*seq_start_next)(struct fc_seq *sp); 550 551 /* 552 * Reset an exchange manager, completing all sequences and exchanges. 553 * If s_id is non-zero, reset only exchanges originating from that FID. 554 * If d_id is non-zero, reset only exchanges sending to that FID. 555 * 556 * STATUS: OPTIONAL 557 */ 558 void (*exch_mgr_reset)(struct fc_lport *, 559 u32 s_id, u32 d_id); 560 561 /* 562 * Flush the rport work queue. Generally used before shutdown. 563 * 564 * STATUS: OPTIONAL 565 */ 566 void (*rport_flush_queue)(void); 567 568 /* 569 * Receive a frame for a local port. 570 * 571 * STATUS: OPTIONAL 572 */ 573 void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, 574 struct fc_frame *fp); 575 576 /* 577 * Reset the local port. 578 * 579 * STATUS: OPTIONAL 580 */ 581 int (*lport_reset)(struct fc_lport *); 582 583 /* 584 * Create a remote port 585 */ 586 struct fc_rport *(*rport_create)(struct fc_disc_port *); 587 588 /* 589 * Initiates the RP state machine. It is called from the LP module. 590 * This function will issue the following commands to the N_Port 591 * identified by the FC ID provided. 592 * 593 * - PLOGI 594 * - PRLI 595 * - RTV 596 * 597 * STATUS: OPTIONAL 598 */ 599 int (*rport_login)(struct fc_rport *rport); 600 601 /* 602 * Logoff, and remove the rport from the transport if 603 * it had been added. This will send a LOGO to the target. 604 * 605 * STATUS: OPTIONAL 606 */ 607 int (*rport_logoff)(struct fc_rport *rport); 608 609 /* 610 * Recieve a request from a remote port. 611 * 612 * STATUS: OPTIONAL 613 */ 614 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, 615 struct fc_rport *); 616 617 /* 618 * lookup an rport by it's port ID. 619 * 620 * STATUS: OPTIONAL 621 */ 622 struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32); 623 624 /* 625 * Send a fcp cmd from fsp pkt. 626 * Called with the SCSI host lock unlocked and irqs disabled. 627 * 628 * The resp handler is called when FCP_RSP received. 629 * 630 * STATUS: OPTIONAL 631 */ 632 int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, 633 void (*resp)(struct fc_seq *, struct fc_frame *fp, 634 void *arg)); 635 636 /* 637 * Cleanup the FCP layer, used durring link down and reset 638 * 639 * STATUS: OPTIONAL 640 */ 641 void (*fcp_cleanup)(struct fc_lport *lp); 642 643 /* 644 * Abort all I/O on a local port 645 * 646 * STATUS: OPTIONAL 647 */ 648 void (*fcp_abort_io)(struct fc_lport *lp); 649 650 /* 651 * Receive a request for the discovery layer. 652 * 653 * STATUS: OPTIONAL 654 */ 655 void (*disc_recv_req)(struct fc_seq *, 656 struct fc_frame *, struct fc_lport *); 657 658 /* 659 * Start discovery for a local port. 660 * 661 * STATUS: OPTIONAL 662 */ 663 void (*disc_start)(void (*disc_callback)(struct fc_lport *, 664 enum fc_disc_event), 665 struct fc_lport *); 666 667 /* 668 * Stop discovery for a given lport. This will remove 669 * all discovered rports 670 * 671 * STATUS: OPTIONAL 672 */ 673 void (*disc_stop) (struct fc_lport *); 674 675 /* 676 * Stop discovery for a given lport. This will block 677 * until all discovered rports are deleted from the 678 * FC transport class 679 * 680 * STATUS: OPTIONAL 681 */ 682 void (*disc_stop_final) (struct fc_lport *); 683 }; 684 685 /* information used by the discovery layer */ 686 struct fc_disc { 687 unsigned char retry_count; 688 unsigned char delay; 689 unsigned char pending; 690 unsigned char requested; 691 unsigned short seq_count; 692 unsigned char buf_len; 693 enum fc_disc_event event; 694 695 void (*disc_callback)(struct fc_lport *, 696 enum fc_disc_event); 697 698 struct list_head rports; 699 struct list_head rogue_rports; 700 struct fc_lport *lport; 701 struct mutex disc_mutex; 702 struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ 703 struct delayed_work disc_work; 704 }; 705 706 struct fc_lport { 707 struct list_head list; 708 709 /* Associations */ 710 struct Scsi_Host *host; 711 struct fc_exch_mgr *emp; 712 struct fc_rport *dns_rp; 713 struct fc_rport *ptp_rp; 714 void *scsi_priv; 715 struct fc_disc disc; 716 717 /* Operational Information */ 718 struct libfc_function_template tt; 719 u8 link_up; 720 u8 qfull; 721 enum fc_lport_state state; 722 unsigned long boot_time; 723 724 struct fc_host_statistics host_stats; 725 struct fcoe_dev_stats *dev_stats; 726 727 u64 wwpn; 728 u64 wwnn; 729 u8 retry_count; 730 731 /* Capabilities */ 732 u32 sg_supp:1; /* scatter gather supported */ 733 u32 seq_offload:1; /* seq offload supported */ 734 u32 crc_offload:1; /* crc offload supported */ 735 u32 lro_enabled:1; /* large receive offload */ 736 u32 mfs; /* max FC payload size */ 737 unsigned int service_params; 738 unsigned int e_d_tov; 739 unsigned int r_a_tov; 740 u8 max_retry_count; 741 u8 max_rport_retry_count; 742 u16 link_speed; 743 u16 link_supported_speeds; 744 u16 lro_xid; /* max xid for fcoe lro */ 745 unsigned int lso_max; /* max large send size */ 746 struct fc_ns_fts fcts; /* FC-4 type masks */ 747 struct fc_els_rnid_gen rnid_gen; /* RNID information */ 748 749 /* Semaphores */ 750 struct mutex lp_mutex; 751 752 /* Miscellaneous */ 753 struct delayed_work retry_work; 754 struct delayed_work disc_work; 755 }; 756 757 /* 758 * FC_LPORT HELPER FUNCTIONS 759 *****************************/ 760 static inline int fc_lport_test_ready(struct fc_lport *lp) 761 { 762 return lp->state == LPORT_ST_READY; 763 } 764 765 static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) 766 { 767 lp->wwnn = wwnn; 768 } 769 770 static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) 771 { 772 lp->wwpn = wwnn; 773 } 774 775 static inline void fc_lport_state_enter(struct fc_lport *lp, 776 enum fc_lport_state state) 777 { 778 if (state != lp->state) 779 lp->retry_count = 0; 780 lp->state = state; 781 } 782 783 static inline int fc_lport_init_stats(struct fc_lport *lp) 784 { 785 /* allocate per cpu stats block */ 786 lp->dev_stats = alloc_percpu(struct fcoe_dev_stats); 787 if (!lp->dev_stats) 788 return -ENOMEM; 789 return 0; 790 } 791 792 static inline void fc_lport_free_stats(struct fc_lport *lp) 793 { 794 free_percpu(lp->dev_stats); 795 } 796 797 static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp) 798 { 799 return per_cpu_ptr(lp->dev_stats, smp_processor_id()); 800 } 801 802 static inline void *lport_priv(const struct fc_lport *lp) 803 { 804 return (void *)(lp + 1); 805 } 806 807 /** 808 * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport 809 * @sht: ptr to the scsi host templ 810 * @priv_size: size of private data after fc_lport 811 * 812 * Returns: ptr to Scsi_Host 813 */ 814 static inline struct Scsi_Host * 815 libfc_host_alloc(struct scsi_host_template *sht, int priv_size) 816 { 817 return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size); 818 } 819 820 /* 821 * LOCAL PORT LAYER 822 *****************************/ 823 int fc_lport_init(struct fc_lport *lp); 824 825 /* 826 * Destroy the specified local port by finding and freeing all 827 * fc_rports associated with it and then by freeing the fc_lport 828 * itself. 829 */ 830 int fc_lport_destroy(struct fc_lport *lp); 831 832 /* 833 * Logout the specified local port from the fabric 834 */ 835 int fc_fabric_logoff(struct fc_lport *lp); 836 837 /* 838 * Initiate the LP state machine. This handler will use fc_host_attr 839 * to store the FLOGI service parameters, so fc_host_attr must be 840 * initialized before calling this handler. 841 */ 842 int fc_fabric_login(struct fc_lport *lp); 843 844 /* 845 * The link is up for the given local port. 846 */ 847 void fc_linkup(struct fc_lport *); 848 849 /* 850 * Link is down for the given local port. 851 */ 852 void fc_linkdown(struct fc_lport *); 853 854 /* 855 * Configure the local port. 856 */ 857 int fc_lport_config(struct fc_lport *); 858 859 /* 860 * Reset the local port. 861 */ 862 int fc_lport_reset(struct fc_lport *); 863 864 /* 865 * Set the mfs or reset 866 */ 867 int fc_set_mfs(struct fc_lport *lp, u32 mfs); 868 869 870 /* 871 * REMOTE PORT LAYER 872 *****************************/ 873 int fc_rport_init(struct fc_lport *lp); 874 void fc_rport_terminate_io(struct fc_rport *rp); 875 876 /* 877 * DISCOVERY LAYER 878 *****************************/ 879 int fc_disc_init(struct fc_lport *lp); 880 881 882 /* 883 * SCSI LAYER 884 *****************************/ 885 /* 886 * Initialize the SCSI block of libfc 887 */ 888 int fc_fcp_init(struct fc_lport *); 889 890 /* 891 * This section provides an API which allows direct interaction 892 * with the SCSI-ml. Each of these functions satisfies a function 893 * pointer defined in Scsi_Host and therefore is always called 894 * directly from the SCSI-ml. 895 */ 896 int fc_queuecommand(struct scsi_cmnd *sc_cmd, 897 void (*done)(struct scsi_cmnd *)); 898 899 /* 900 * complete processing of a fcp packet 901 * 902 * This function may sleep if a fsp timer is pending. 903 * The host lock must not be held by caller. 904 */ 905 void fc_fcp_complete(struct fc_fcp_pkt *fsp); 906 907 /* 908 * Send an ABTS frame to the target device. The sc_cmd argument 909 * is a pointer to the SCSI command to be aborted. 910 */ 911 int fc_eh_abort(struct scsi_cmnd *sc_cmd); 912 913 /* 914 * Reset a LUN by sending send the tm cmd to the target. 915 */ 916 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); 917 918 /* 919 * Reset the host adapter. 920 */ 921 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); 922 923 /* 924 * Check rport status. 925 */ 926 int fc_slave_alloc(struct scsi_device *sdev); 927 928 /* 929 * Adjust the queue depth. 930 */ 931 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth); 932 933 /* 934 * Change the tag type. 935 */ 936 int fc_change_queue_type(struct scsi_device *sdev, int tag_type); 937 938 /* 939 * Free memory pools used by the FCP layer. 940 */ 941 void fc_fcp_destroy(struct fc_lport *); 942 943 /* 944 * Set up direct-data placement for this I/O request 945 */ 946 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid); 947 948 /* 949 * ELS/CT interface 950 *****************************/ 951 /* 952 * Initializes ELS/CT interface 953 */ 954 int fc_elsct_init(struct fc_lport *lp); 955 956 957 /* 958 * EXCHANGE MANAGER LAYER 959 *****************************/ 960 /* 961 * Initializes Exchange Manager related 962 * function pointers in struct libfc_function_template. 963 */ 964 int fc_exch_init(struct fc_lport *lp); 965 966 /* 967 * Allocates an Exchange Manager (EM). 968 * 969 * The EM manages exchanges for their allocation and 970 * free, also allows exchange lookup for received 971 * frame. 972 * 973 * The class is used for initializing FC class of 974 * allocated exchange from EM. 975 * 976 * The min_xid and max_xid will limit new 977 * exchange ID (XID) within this range for 978 * a new exchange. 979 * The LLD may choose to have multiple EMs, 980 * e.g. one EM instance per CPU receive thread in LLD. 981 * The LLD can use exch_get() of struct libfc_function_template 982 * to specify XID for a new exchange within 983 * a specified EM instance. 984 * 985 * The em_idx to uniquely identify an EM instance. 986 */ 987 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, 988 enum fc_class class, 989 u16 min_xid, 990 u16 max_xid); 991 992 /* 993 * Free an exchange manager. 994 */ 995 void fc_exch_mgr_free(struct fc_exch_mgr *mp); 996 997 /* 998 * Receive a frame on specified local port and exchange manager. 999 */ 1000 void fc_exch_recv(struct fc_lport *lp, struct fc_exch_mgr *mp, 1001 struct fc_frame *fp); 1002 1003 /* 1004 * This function is for exch_seq_send function pointer in 1005 * struct libfc_function_template, see comment block on 1006 * exch_seq_send for description of this function. 1007 */ 1008 struct fc_seq *fc_exch_seq_send(struct fc_lport *lp, 1009 struct fc_frame *fp, 1010 void (*resp)(struct fc_seq *sp, 1011 struct fc_frame *fp, 1012 void *arg), 1013 void (*destructor)(struct fc_seq *sp, 1014 void *arg), 1015 void *arg, u32 timer_msec); 1016 1017 /* 1018 * send a frame using existing sequence and exchange. 1019 */ 1020 int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp); 1021 1022 /* 1023 * Send ELS response using mainly infomation 1024 * in exchange and sequence in EM layer. 1025 */ 1026 void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd, 1027 struct fc_seq_els_data *els_data); 1028 1029 /* 1030 * This function is for seq_exch_abort function pointer in 1031 * struct libfc_function_template, see comment block on 1032 * seq_exch_abort for description of this function. 1033 */ 1034 int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec); 1035 1036 /* 1037 * Indicate that an exchange/sequence tuple is complete and the memory 1038 * allocated for the related objects may be freed. 1039 */ 1040 void fc_exch_done(struct fc_seq *sp); 1041 1042 /* 1043 * Assigns a EM and XID for a frame and then allocates 1044 * a new exchange and sequence pair. 1045 * The fp can be used to determine free XID. 1046 */ 1047 struct fc_exch *fc_exch_get(struct fc_lport *lp, struct fc_frame *fp); 1048 1049 /* 1050 * Allocate a new exchange and sequence pair. 1051 * if ex_id is zero then next free exchange id 1052 * from specified exchange manger mp will be assigned. 1053 */ 1054 struct fc_exch *fc_exch_alloc(struct fc_exch_mgr *mp, 1055 struct fc_frame *fp, u16 ex_id); 1056 /* 1057 * Start a new sequence on the same exchange as the supplied sequence. 1058 */ 1059 struct fc_seq *fc_seq_start_next(struct fc_seq *sp); 1060 1061 /* 1062 * Reset an exchange manager, completing all sequences and exchanges. 1063 * If s_id is non-zero, reset only exchanges originating from that FID. 1064 * If d_id is non-zero, reset only exchanges sending to that FID. 1065 */ 1066 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); 1067 1068 /* 1069 * Functions for fc_functions_template 1070 */ 1071 void fc_get_host_speed(struct Scsi_Host *shost); 1072 void fc_get_host_port_type(struct Scsi_Host *shost); 1073 void fc_get_host_port_state(struct Scsi_Host *shost); 1074 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); 1075 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); 1076 1077 /* 1078 * module setup functions. 1079 */ 1080 int fc_setup_exch_mgr(void); 1081 void fc_destroy_exch_mgr(void); 1082 int fc_setup_rport(void); 1083 void fc_destroy_rport(void); 1084 1085 #endif /* _LIBFC_H_ */ 1086