include/scsi/libfc.h

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