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