include/scsi/libfc.h

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