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