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