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