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