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