Pileus Git - ~andy/linux/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
  30 #include <scsi/fc/fc_fcp.h>
  31 #include <scsi/fc/fc_ns.h>
  32 #include <scsi/fc/fc_els.h>
  33 #include <scsi/fc/fc_gs.h>
  34
  35 #include <scsi/fc_frame.h>
  36
  37 #define FC_LIBFC_LOGGING 0x01 /* General logging, not categorized */
  38 #define FC_LPORT_LOGGING 0x02 /* lport layer logging */
  39 #define FC_DISC_LOGGING  0x04 /* discovery layer logging */
  40 #define FC_RPORT_LOGGING 0x08 /* rport layer logging */
  41 #define FC_FCP_LOGGING   0x10 /* I/O path logging */
  42 #define FC_EM_LOGGING    0x20 /* Exchange Manager logging */
  43 #define FC_EXCH_LOGGING  0x40 /* Exchange/Sequence logging */
  44 #define FC_SCSI_LOGGING  0x80 /* SCSI logging (mostly error handling) */
  45
  46 extern unsigned int fc_debug_logging;
  47
  48 #define FC_CHECK_LOGGING(LEVEL, CMD)                            \
  49 do {                                                            \
  50         if (unlikely(fc_debug_logging & LEVEL))                 \
  51                 do {                                            \
  52                         CMD;                                    \
  53                 } while (0);                                    \
  54 } while (0)
  55
  56 #define FC_LIBFC_DBG(fmt, args...)                                      \
  57         FC_CHECK_LOGGING(FC_LIBFC_LOGGING,                              \
  58                          printk(KERN_INFO "libfc: " fmt, ##args))
  59
  60 #define FC_LPORT_DBG(lport, fmt, args...)                               \
  61         FC_CHECK_LOGGING(FC_LPORT_LOGGING,                              \
  62                          printk(KERN_INFO "host%u: lport %6x: " fmt,    \
  63                                 (lport)->host->host_no,                 \
  64                                 fc_host_port_id((lport)->host), ##args))
  65
  66 #define FC_DISC_DBG(disc, fmt, args...)                                 \
  67         FC_CHECK_LOGGING(FC_DISC_LOGGING,                               \
  68                          printk(KERN_INFO "host%u: disc: " fmt,         \
  69                                 (disc)->lport->host->host_no,           \
  70                                 ##args))
  71
  72 #define FC_RPORT_ID_DBG(lport, port_id, fmt, args...)                   \
  73         FC_CHECK_LOGGING(FC_RPORT_LOGGING,                              \
  74                          printk(KERN_INFO "host%u: rport %6x: " fmt,    \
  75                                 (lport)->host->host_no,                 \
  76                                 (port_id), ##args))
  77
  78 #define FC_RPORT_DBG(rport, fmt, args...)                               \
  79 do {                                                                    \
  80         struct fc_rport_libfc_priv *rdata = rport->dd_data;             \
  81         struct fc_lport *lport = rdata->local_port;                     \
  82         FC_RPORT_ID_DBG(lport, rport->port_id, fmt, ##args);            \
  83 } while (0)
  84
  85 #define FC_FCP_DBG(pkt, fmt, args...)                                   \
  86         FC_CHECK_LOGGING(FC_FCP_LOGGING,                                \
  87                          printk(KERN_INFO "host%u: fcp: %6x: " fmt,     \
  88                                 (pkt)->lp->host->host_no,               \
  89                                 pkt->rport->port_id, ##args))
  90
  91 #define FC_EXCH_DBG(exch, fmt, args...)                                 \
  92         FC_CHECK_LOGGING(FC_EXCH_LOGGING,                               \
  93                          printk(KERN_INFO "host%u: xid %4x: " fmt,      \
  94                                 (exch)->lp->host->host_no,              \
  95                                 exch->xid, ##args))
  96
  97 #define FC_SCSI_DBG(lport, fmt, args...)                                \
  98         FC_CHECK_LOGGING(FC_SCSI_LOGGING,                               \
  99                          printk(KERN_INFO "host%u: scsi: " fmt,         \
 100                                 (lport)->host->host_no, ##args))
 101
 102 /*
 103  * libfc error codes
 104  */
 105 #define FC_NO_ERR       0       /* no error */
 106 #define FC_EX_TIMEOUT   1       /* Exchange timeout */
 107 #define FC_EX_CLOSED    2       /* Exchange closed */
 108
 109 /* some helpful macros */
 110
 111 #define ntohll(x) be64_to_cpu(x)
 112 #define htonll(x) cpu_to_be64(x)
 113
 114 #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
 115
 116 #define hton24(p, v)    do {                    \
 117                 p[0] = (((v) >> 16) & 0xFF);    \
 118                 p[1] = (((v) >> 8) & 0xFF);     \
 119                 p[2] = ((v) & 0xFF);            \
 120         } while (0)
 121
 122 /*
 123  * FC HBA status
 124  */
 125 enum fc_lport_state {
 126         LPORT_ST_DISABLED = 0,
 127         LPORT_ST_FLOGI,
 128         LPORT_ST_DNS,
 129         LPORT_ST_RPN_ID,
 130         LPORT_ST_RFT_ID,
 131         LPORT_ST_SCR,
 132         LPORT_ST_READY,
 133         LPORT_ST_LOGO,
 134         LPORT_ST_RESET
 135 };
 136
 137 enum fc_disc_event {
 138         DISC_EV_NONE = 0,
 139         DISC_EV_SUCCESS,
 140         DISC_EV_FAILED
 141 };
 142
 143 enum fc_rport_state {
 144         RPORT_ST_INIT,          /* initialized */
 145         RPORT_ST_PLOGI,         /* waiting for PLOGI completion */
 146         RPORT_ST_PRLI,          /* waiting for PRLI completion */
 147         RPORT_ST_RTV,           /* waiting for RTV completion */
 148         RPORT_ST_READY,         /* ready for use */
 149         RPORT_ST_LOGO,          /* port logout sent */
 150         RPORT_ST_DELETE,        /* port being deleted */
 151 };
 152
 153 enum fc_rport_trans_state {
 154         FC_PORTSTATE_ROGUE,
 155         FC_PORTSTATE_REAL,
 156 };
 157
 158 /**
 159  * struct fc_disc_port - temporary discovery port to hold rport identifiers
 160  * @lp: Fibre Channel host port instance
 161  * @peers: node for list management during discovery and RSCN processing
 162  * @ids: identifiers structure to pass to fc_remote_port_add()
 163  * @rport_work: work struct for starting the rport state machine
 164  */
 165 struct fc_disc_port {
 166         struct fc_lport             *lp;
 167         struct list_head            peers;
 168         struct fc_rport_identifiers ids;
 169         struct work_struct          rport_work;
 170 };
 171
 172 enum fc_rport_event {
 173         RPORT_EV_NONE = 0,
 174         RPORT_EV_CREATED,
 175         RPORT_EV_FAILED,
 176         RPORT_EV_STOP,
 177         RPORT_EV_LOGO
 178 };
 179
 180 struct fc_rport_operations {
 181         void (*event_callback)(struct fc_lport *, struct fc_rport *,
 182                                enum fc_rport_event);
 183 };
 184
 185 /**
 186  * struct fc_rport_libfc_priv - libfc internal information about a remote port
 187  * @local_port: Fibre Channel host port instance
 188  * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges
 189  * @flags: REC and RETRY supported flags
 190  * @max_seq: maximum number of concurrent sequences
 191  * @retries: retry count in current state
 192  * @e_d_tov: error detect timeout value (in msec)
 193  * @r_a_tov: resource allocation timeout value (in msec)
 194  * @rp_mutex: mutex protects rport
 195  * @retry_work:
 196  * @event_callback: Callback for rport READY, FAILED or LOGO
 197  */
 198 struct fc_rport_libfc_priv {
 199         struct fc_lport            *local_port;
 200         enum fc_rport_state        rp_state;
 201         u16                        flags;
 202         #define FC_RP_FLAGS_REC_SUPPORTED       (1 << 0)
 203         #define FC_RP_FLAGS_RETRY               (1 << 1)
 204         u16                        max_seq;
 205         unsigned int               retries;
 206         unsigned int               e_d_tov;
 207         unsigned int               r_a_tov;
 208         enum fc_rport_trans_state  trans_state;
 209         struct mutex               rp_mutex;
 210         struct delayed_work        retry_work;
 211         enum fc_rport_event        event;
 212         struct fc_rport_operations *ops;
 213         struct list_head           peers;
 214         struct work_struct         event_work;
 215 };
 216
 217 #define PRIV_TO_RPORT(x)                                                \
 218         (struct fc_rport *)((void *)x - sizeof(struct fc_rport));
 219 #define RPORT_TO_PRIV(x)                                                \
 220         (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport));
 221
 222 struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *);
 223
 224 static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn)
 225 {
 226         rport->node_name = wwnn;
 227         rport->port_name = wwpn;
 228 }
 229
 230 /*
 231  * fcoe stats structure
 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  * els data is used for passing ELS respone specific
 254  * data to send ELS response mainly using infomation
 255  * in exchange and sequence in EM layer.
 256  */
 257 struct fc_seq_els_data {
 258         struct fc_frame *fp;
 259         enum fc_els_rjt_reason reason;
 260         enum fc_els_rjt_explan explan;
 261 };
 262
 263 /*
 264  * FCP request structure, one for each scsi cmd request
 265  */
 266 struct fc_fcp_pkt {
 267         /*
 268          * housekeeping stuff
 269          */
 270         struct fc_lport *lp;    /* handle to hba struct */
 271         u16             state;          /* scsi_pkt state state */
 272         u16             tgt_flags;      /* target flags  */
 273         atomic_t        ref_cnt;        /* fcp pkt ref count */
 274         spinlock_t      scsi_pkt_lock;  /* Must be taken before the host lock
 275                                          * if both are held at the same time */
 276         /*
 277          * SCSI I/O related stuff
 278          */
 279         struct scsi_cmnd *cmd;          /* scsi command pointer. set/clear
 280                                          * under host lock */
 281         struct list_head list;          /* tracks queued commands. access under
 282                                          * host lock */
 283         /*
 284          * timeout related stuff
 285          */
 286         struct timer_list timer;        /* command timer */
 287         struct completion tm_done;
 288         int     wait_for_comp;
 289         unsigned long   start_time;     /* start jiffie */
 290         unsigned long   end_time;       /* end jiffie */
 291         unsigned long   last_pkt_time;   /* jiffies of last frame received */
 292
 293         /*
 294          * scsi cmd and data transfer information
 295          */
 296         u32             data_len;
 297         /*
 298          * transport related veriables
 299          */
 300         struct fcp_cmnd cdb_cmd;
 301         size_t          xfer_len;
 302         u16             xfer_ddp;       /* this xfer is ddped */
 303         u32             xfer_contig_end; /* offset of end of contiguous xfer */
 304         u16             max_payload;    /* max payload size in bytes */
 305
 306         /*
 307          * scsi/fcp return status
 308          */
 309         u32             io_status;      /* SCSI result upper 24 bits */
 310         u8              cdb_status;
 311         u8              status_code;    /* FCP I/O status */
 312         /* bit 3 Underrun bit 2: overrun */
 313         u8              scsi_comp_flags;
 314         u32             req_flags;      /* bit 0: read bit:1 write */
 315         u32             scsi_resid;     /* residule length */
 316
 317         struct fc_rport *rport;         /* remote port pointer */
 318         struct fc_seq   *seq_ptr;       /* current sequence pointer */
 319         /*
 320          * Error Processing
 321          */
 322         u8              recov_retry;    /* count of recovery retries */
 323         struct fc_seq   *recov_seq;     /* sequence for REC or SRR */
 324 };
 325 /*
 326  * FC_FCP HELPER FUNCTIONS
 327  *****************************/
 328 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
 329 {
 330         if (fsp && fsp->cmd)
 331                 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
 332         return false;
 333 }
 334
 335 /*
 336  * Structure and function definitions for managing Fibre Channel Exchanges
 337  * and Sequences
 338  *
 339  * fc_exch holds state for one exchange and links to its active sequence.
 340  *
 341  * fc_seq holds the state for an individual sequence.
 342  */
 343
 344 struct fc_exch_mgr;
 345 struct fc_exch_mgr_anchor;
 346 extern u16      fc_cpu_mask;    /* cpu mask for possible cpus */
 347
 348 /*
 349  * Sequence.
 350  */
 351 struct fc_seq {
 352         u8      id;             /* seq ID */
 353         u16     ssb_stat;       /* status flags for sequence status block */
 354         u16     cnt;            /* frames sent so far on sequence */
 355         u32     rec_data;       /* FC-4 value for REC */
 356 };
 357
 358 #define FC_EX_DONE              (1 << 0) /* ep is completed */
 359 #define FC_EX_RST_CLEANUP       (1 << 1) /* reset is forcing completion */
 360
 361 /*
 362  * Exchange.
 363  *
 364  * Locking notes: The ex_lock protects following items:
 365  *      state, esb_stat, f_ctl, seq.ssb_stat
 366  *      seq_id
 367  *      sequence allocation
 368  */
 369 struct fc_exch {
 370         struct fc_exch_mgr *em;         /* exchange manager */
 371         u32             state;          /* internal driver state */
 372         u16             xid;            /* our exchange ID */
 373         struct list_head        ex_list;        /* free or busy list linkage */
 374         spinlock_t      ex_lock;        /* lock covering exchange state */
 375         atomic_t        ex_refcnt;      /* reference counter */
 376         struct delayed_work timeout_work; /* timer for upper level protocols */
 377         struct fc_lport *lp;            /* fc device instance */
 378         u16             oxid;           /* originator's exchange ID */
 379         u16             rxid;           /* responder's exchange ID */
 380         u32             oid;            /* originator's FCID */
 381         u32             sid;            /* source FCID */
 382         u32             did;            /* destination FCID */
 383         u32             esb_stat;       /* exchange status for ESB */
 384         u32             r_a_tov;        /* r_a_tov from rport (msec) */
 385         u8              seq_id;         /* next sequence ID to use */
 386         u32             f_ctl;          /* F_CTL flags for sequences */
 387         u8              fh_type;        /* frame type */
 388         enum fc_class   class;          /* class of service */
 389         struct fc_seq   seq;            /* single sequence */
 390         /*
 391          * Handler for responses to this current exchange.
 392          */
 393         void            (*resp)(struct fc_seq *, struct fc_frame *, void *);
 394         void            (*destructor)(struct fc_seq *, void *);
 395         /*
 396          * arg is passed as void pointer to exchange
 397          * resp and destructor handlers
 398          */
 399         void            *arg;
 400 };
 401 #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
 402
 403 struct libfc_function_template {
 404
 405         /*
 406          * Interface to send a FC frame
 407          *
 408          * STATUS: REQUIRED
 409          */
 410         int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp);
 411
 412         /*
 413          * Interface to send ELS/CT frames
 414          *
 415          * STATUS: OPTIONAL
 416          */
 417         struct fc_seq *(*elsct_send)(struct fc_lport *lport,
 418                                      struct fc_rport *rport,
 419                                      struct fc_frame *fp,
 420                                      unsigned int op,
 421                                      void (*resp)(struct fc_seq *,
 422                                              struct fc_frame *fp,
 423                                              void *arg),
 424                                      void *arg, u32 timer_msec);
 425
 426         /*
 427          * Send the FC frame payload using a new exchange and sequence.
 428          *
 429          * The frame pointer with some of the header's fields must be
 430          * filled before calling exch_seq_send(), those fields are,
 431          *
 432          * - routing control
 433          * - FC port did
 434          * - FC port sid
 435          * - FC header type
 436          * - frame control
 437          * - parameter or relative offset
 438          *
 439          * The exchange response handler is set in this routine to resp()
 440          * function pointer. It can be called in two scenarios: if a timeout
 441          * occurs or if a response frame is received for the exchange. The
 442          * fc_frame pointer in response handler will also indicate timeout
 443          * as error using IS_ERR related macros.
 444          *
 445          * The exchange destructor handler is also set in this routine.
 446          * The destructor handler is invoked by EM layer when exchange
 447          * is about to free, this can be used by caller to free its
 448          * resources along with exchange free.
 449          *
 450          * The arg is passed back to resp and destructor handler.
 451          *
 452          * The timeout value (in msec) for an exchange is set if non zero
 453          * timer_msec argument is specified. The timer is canceled when
 454          * it fires or when the exchange is done. The exchange timeout handler
 455          * is registered by EM layer.
 456          *
 457          * STATUS: OPTIONAL
 458          */
 459         struct fc_seq *(*exch_seq_send)(struct fc_lport *lp,
 460                                         struct fc_frame *fp,
 461                                         void (*resp)(struct fc_seq *sp,
 462                                                      struct fc_frame *fp,
 463                                                      void *arg),
 464                                         void (*destructor)(struct fc_seq *sp,
 465                                                            void *arg),
 466                                         void *arg, unsigned int timer_msec);
 467
 468         /*
 469          * Sets up the DDP context for a given exchange id on the given
 470          * scatterlist if LLD supports DDP for large receive.
 471          *
 472          * STATUS: OPTIONAL
 473          */
 474         int (*ddp_setup)(struct fc_lport *lp, u16 xid,
 475                          struct scatterlist *sgl, unsigned int sgc);
 476         /*
 477          * Completes the DDP transfer and returns the length of data DDPed
 478          * for the given exchange id.
 479          *
 480          * STATUS: OPTIONAL
 481          */
 482         int (*ddp_done)(struct fc_lport *lp, u16 xid);
 483         /*
 484          * Send a frame using an existing sequence and exchange.
 485          *
 486          * STATUS: OPTIONAL
 487          */
 488         int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp,
 489                         struct fc_frame *fp);
 490
 491         /*
 492          * Send an ELS response using infomation from a previous
 493          * exchange and sequence.
 494          *
 495          * STATUS: OPTIONAL
 496          */
 497         void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd,
 498                                  struct fc_seq_els_data *els_data);
 499
 500         /*
 501          * Abort an exchange and sequence. Generally called because of a
 502          * exchange timeout or an abort from the upper layer.
 503          *
 504          * A timer_msec can be specified for abort timeout, if non-zero
 505          * timer_msec value is specified then exchange resp handler
 506          * will be called with timeout error if no response to abort.
 507          *
 508          * STATUS: OPTIONAL
 509          */
 510         int (*seq_exch_abort)(const struct fc_seq *req_sp,
 511                               unsigned int timer_msec);
 512
 513         /*
 514          * Indicate that an exchange/sequence tuple is complete and the memory
 515          * allocated for the related objects may be freed.
 516          *
 517          * STATUS: OPTIONAL
 518          */
 519         void (*exch_done)(struct fc_seq *sp);
 520
 521         /*
 522          * Start a new sequence on the same exchange/sequence tuple.
 523          *
 524          * STATUS: OPTIONAL
 525          */
 526         struct fc_seq *(*seq_start_next)(struct fc_seq *sp);
 527
 528         /*
 529          * Reset an exchange manager, completing all sequences and exchanges.
 530          * If s_id is non-zero, reset only exchanges originating from that FID.
 531          * If d_id is non-zero, reset only exchanges sending to that FID.
 532          *
 533          * STATUS: OPTIONAL
 534          */
 535         void (*exch_mgr_reset)(struct fc_lport *,
 536                                u32 s_id, u32 d_id);
 537
 538         /*
 539          * Flush the rport work queue. Generally used before shutdown.
 540          *
 541          * STATUS: OPTIONAL
 542          */
 543         void (*rport_flush_queue)(void);
 544
 545         /*
 546          * Receive a frame for a local port.
 547          *
 548          * STATUS: OPTIONAL
 549          */
 550         void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp,
 551                            struct fc_frame *fp);
 552
 553         /*
 554          * Reset the local port.
 555          *
 556          * STATUS: OPTIONAL
 557          */
 558         int (*lport_reset)(struct fc_lport *);
 559
 560         /*
 561          * Create a remote port
 562          */
 563         struct fc_rport *(*rport_create)(struct fc_disc_port *);
 564
 565         /*
 566          * Initiates the RP state machine. It is called from the LP module.
 567          * This function will issue the following commands to the N_Port
 568          * identified by the FC ID provided.
 569          *
 570          * - PLOGI
 571          * - PRLI
 572          * - RTV
 573          *
 574          * STATUS: OPTIONAL
 575          */
 576         int (*rport_login)(struct fc_rport *rport);
 577
 578         /*
 579          * Logoff, and remove the rport from the transport if
 580          * it had been added. This will send a LOGO to the target.
 581          *
 582          * STATUS: OPTIONAL
 583          */
 584         int (*rport_logoff)(struct fc_rport *rport);
 585
 586         /*
 587          * Recieve a request from a remote port.
 588          *
 589          * STATUS: OPTIONAL
 590          */
 591         void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
 592                                struct fc_rport *);
 593
 594         /*
 595          * lookup an rport by it's port ID.
 596          *
 597          * STATUS: OPTIONAL
 598          */
 599         struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32);
 600
 601         /*
 602          * Send a fcp cmd from fsp pkt.
 603          * Called with the SCSI host lock unlocked and irqs disabled.
 604          *
 605          * The resp handler is called when FCP_RSP received.
 606          *
 607          * STATUS: OPTIONAL
 608          */
 609         int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp,
 610                             void (*resp)(struct fc_seq *, struct fc_frame *fp,
 611                                          void *arg));
 612
 613         /*
 614          * Cleanup the FCP layer, used durring link down and reset
 615          *
 616          * STATUS: OPTIONAL
 617          */
 618         void (*fcp_cleanup)(struct fc_lport *lp);
 619
 620         /*
 621          * Abort all I/O on a local port
 622          *
 623          * STATUS: OPTIONAL
 624          */
 625         void (*fcp_abort_io)(struct fc_lport *lp);
 626
 627         /*
 628          * Receive a request for the discovery layer.
 629          *
 630          * STATUS: OPTIONAL
 631          */
 632         void (*disc_recv_req)(struct fc_seq *,
 633                               struct fc_frame *, struct fc_lport *);
 634
 635         /*
 636          * Start discovery for a local port.
 637          *
 638          * STATUS: OPTIONAL
 639          */
 640         void (*disc_start)(void (*disc_callback)(struct fc_lport *,
 641                                                  enum fc_disc_event),
 642                            struct fc_lport *);
 643
 644         /*
 645          * Stop discovery for a given lport. This will remove
 646          * all discovered rports
 647          *
 648          * STATUS: OPTIONAL
 649          */
 650         void (*disc_stop) (struct fc_lport *);
 651
 652         /*
 653          * Stop discovery for a given lport. This will block
 654          * until all discovered rports are deleted from the
 655          * FC transport class
 656          *
 657          * STATUS: OPTIONAL
 658          */
 659         void (*disc_stop_final) (struct fc_lport *);
 660 };
 661
 662 /* information used by the discovery layer */
 663 struct fc_disc {
 664         unsigned char           retry_count;
 665         unsigned char           delay;
 666         unsigned char           pending;
 667         unsigned char           requested;
 668         unsigned short          seq_count;
 669         unsigned char           buf_len;
 670         enum fc_disc_event      event;
 671
 672         void (*disc_callback)(struct fc_lport *,
 673                               enum fc_disc_event);
 674
 675         struct list_head         rports;
 676         struct list_head         rogue_rports;
 677         struct fc_lport         *lport;
 678         struct mutex            disc_mutex;
 679         struct fc_gpn_ft_resp   partial_buf;    /* partial name buffer */
 680         struct delayed_work     disc_work;
 681 };
 682
 683 struct fc_lport {
 684         struct list_head list;
 685
 686         /* Associations */
 687         struct Scsi_Host        *host;
 688         struct list_head        ema_list;
 689         struct fc_rport         *dns_rp;
 690         struct fc_rport         *ptp_rp;
 691         void                    *scsi_priv;
 692         struct fc_disc          disc;
 693
 694         /* Operational Information */
 695         struct libfc_function_template tt;
 696         u8                      link_up;
 697         u8                      qfull;
 698         enum fc_lport_state     state;
 699         unsigned long           boot_time;
 700
 701         struct fc_host_statistics host_stats;
 702         struct fcoe_dev_stats   *dev_stats;
 703
 704         u64                     wwpn;
 705         u64                     wwnn;
 706         u8                      retry_count;
 707
 708         /* Capabilities */
 709         u32                     sg_supp:1;      /* scatter gather supported */
 710         u32                     seq_offload:1;  /* seq offload supported */
 711         u32                     crc_offload:1;  /* crc offload supported */
 712         u32                     lro_enabled:1;  /* large receive offload */
 713         u32                     mfs;            /* max FC payload size */
 714         unsigned int            service_params;
 715         unsigned int            e_d_tov;
 716         unsigned int            r_a_tov;
 717         u8                      max_retry_count;
 718         u8                      max_rport_retry_count;
 719         u16                     link_speed;
 720         u16                     link_supported_speeds;
 721         u16                     lro_xid;        /* max xid for fcoe lro */
 722         unsigned int            lso_max;        /* max large send size */
 723         struct fc_ns_fts        fcts;           /* FC-4 type masks */
 724         struct fc_els_rnid_gen  rnid_gen;       /* RNID information */
 725
 726         /* Semaphores */
 727         struct mutex lp_mutex;
 728
 729         /* Miscellaneous */
 730         struct delayed_work     retry_work;
 731         struct delayed_work     disc_work;
 732 };
 733
 734 /*
 735  * FC_LPORT HELPER FUNCTIONS
 736  *****************************/
 737 static inline int fc_lport_test_ready(struct fc_lport *lp)
 738 {
 739         return lp->state == LPORT_ST_READY;
 740 }
 741
 742 static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn)
 743 {
 744         lp->wwnn = wwnn;
 745 }
 746
 747 static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn)
 748 {
 749         lp->wwpn = wwnn;
 750 }
 751
 752 static inline void fc_lport_state_enter(struct fc_lport *lp,
 753                                         enum fc_lport_state state)
 754 {
 755         if (state != lp->state)
 756                 lp->retry_count = 0;
 757         lp->state = state;
 758 }
 759
 760 static inline int fc_lport_init_stats(struct fc_lport *lp)
 761 {
 762         /* allocate per cpu stats block */
 763         lp->dev_stats = alloc_percpu(struct fcoe_dev_stats);
 764         if (!lp->dev_stats)
 765                 return -ENOMEM;
 766         return 0;
 767 }
 768
 769 static inline void fc_lport_free_stats(struct fc_lport *lp)
 770 {
 771         free_percpu(lp->dev_stats);
 772 }
 773
 774 static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp)
 775 {
 776         return per_cpu_ptr(lp->dev_stats, smp_processor_id());
 777 }
 778
 779 static inline void *lport_priv(const struct fc_lport *lp)
 780 {
 781         return (void *)(lp + 1);
 782 }
 783
 784 /**
 785  * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport
 786  * @sht: ptr to the scsi host templ
 787  * @priv_size: size of private data after fc_lport
 788  *
 789  * Returns: ptr to Scsi_Host
 790  */
 791 static inline struct Scsi_Host *
 792 libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
 793 {
 794         return scsi_host_alloc(sht, sizeof(struct fc_lport) + priv_size);
 795 }
 796
 797 /*
 798  * LOCAL PORT LAYER
 799  *****************************/
 800 int fc_lport_init(struct fc_lport *lp);
 801
 802 /*
 803  * Destroy the specified local port by finding and freeing all
 804  * fc_rports associated with it and then by freeing the fc_lport
 805  * itself.
 806  */
 807 int fc_lport_destroy(struct fc_lport *lp);
 808
 809 /*
 810  * Logout the specified local port from the fabric
 811  */
 812 int fc_fabric_logoff(struct fc_lport *lp);
 813
 814 /*
 815  * Initiate the LP state machine. This handler will use fc_host_attr
 816  * to store the FLOGI service parameters, so fc_host_attr must be
 817  * initialized before calling this handler.
 818  */
 819 int fc_fabric_login(struct fc_lport *lp);
 820
 821 /*
 822  * The link is up for the given local port.
 823  */
 824 void fc_linkup(struct fc_lport *);
 825
 826 /*
 827  * Link is down for the given local port.
 828  */
 829 void fc_linkdown(struct fc_lport *);
 830
 831 /*
 832  * Configure the local port.
 833  */
 834 int fc_lport_config(struct fc_lport *);
 835
 836 /*
 837  * Reset the local port.
 838  */
 839 int fc_lport_reset(struct fc_lport *);
 840
 841 /*
 842  * Set the mfs or reset
 843  */
 844 int fc_set_mfs(struct fc_lport *lp, u32 mfs);
 845
 846
 847 /*
 848  * REMOTE PORT LAYER
 849  *****************************/
 850 int fc_rport_init(struct fc_lport *lp);
 851 void fc_rport_terminate_io(struct fc_rport *rp);
 852
 853 /*
 854  * DISCOVERY LAYER
 855  *****************************/
 856 int fc_disc_init(struct fc_lport *lp);
 857
 858
 859 /*
 860  * SCSI LAYER
 861  *****************************/
 862 /*
 863  * Initialize the SCSI block of libfc
 864  */
 865 int fc_fcp_init(struct fc_lport *);
 866
 867 /*
 868  * This section provides an API which allows direct interaction
 869  * with the SCSI-ml. Each of these functions satisfies a function
 870  * pointer defined in Scsi_Host and therefore is always called
 871  * directly from the SCSI-ml.
 872  */
 873 int fc_queuecommand(struct scsi_cmnd *sc_cmd,
 874                     void (*done)(struct scsi_cmnd *));
 875
 876 /*
 877  * complete processing of a fcp packet
 878  *
 879  * This function may sleep if a fsp timer is pending.
 880  * The host lock must not be held by caller.
 881  */
 882 void fc_fcp_complete(struct fc_fcp_pkt *fsp);
 883
 884 /*
 885  * Send an ABTS frame to the target device. The sc_cmd argument
 886  * is a pointer to the SCSI command to be aborted.
 887  */
 888 int fc_eh_abort(struct scsi_cmnd *sc_cmd);
 889
 890 /*
 891  * Reset a LUN by sending send the tm cmd to the target.
 892  */
 893 int fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
 894
 895 /*
 896  * Reset the host adapter.
 897  */
 898 int fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
 899
 900 /*
 901  * Check rport status.
 902  */
 903 int fc_slave_alloc(struct scsi_device *sdev);
 904
 905 /*
 906  * Adjust the queue depth.
 907  */
 908 int fc_change_queue_depth(struct scsi_device *sdev, int qdepth);
 909
 910 /*
 911  * Change the tag type.
 912  */
 913 int fc_change_queue_type(struct scsi_device *sdev, int tag_type);
 914
 915 /*
 916  * Free memory pools used by the FCP layer.
 917  */
 918 void fc_fcp_destroy(struct fc_lport *);
 919
 920 /*
 921  * Set up direct-data placement for this I/O request
 922  */
 923 void fc_fcp_ddp_setup(struct fc_fcp_pkt *fsp, u16 xid);
 924
 925 /*
 926  * ELS/CT interface
 927  *****************************/
 928 /*
 929  * Initializes ELS/CT interface
 930  */
 931 int fc_elsct_init(struct fc_lport *lp);
 932
 933
 934 /*
 935  * EXCHANGE MANAGER LAYER
 936  *****************************/
 937 /*
 938  * Initializes Exchange Manager related
 939  * function pointers in struct libfc_function_template.
 940  */
 941 int fc_exch_init(struct fc_lport *lp);
 942
 943 /*
 944  * Adds Exchange Manager (EM) mp to lport.
 945  *
 946  * Adds specified mp to lport using struct fc_exch_mgr_anchor,
 947  * the struct fc_exch_mgr_anchor allows same EM sharing by
 948  * more than one lport with their specified match function,
 949  * the match function is used in allocating exchange from
 950  * added mp.
 951  */
 952 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport,
 953                                            struct fc_exch_mgr *mp,
 954                                            bool (*match)(struct fc_frame *));
 955
 956 /*
 957  * Deletes Exchange Manager (EM) from lport by removing
 958  * its anchor ema from lport.
 959  *
 960  * If removed anchor ema was the last user of its associated EM
 961  * then also destroys associated EM.
 962  */
 963 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema);
 964
 965 /*
 966  * Allocates an Exchange Manager (EM).
 967  *
 968  * The EM manages exchanges for their allocation and
 969  * free, also allows exchange lookup for received
 970  * frame.
 971  *
 972  * The class is used for initializing FC class of
 973  * allocated exchange from EM.
 974  *
 975  * The min_xid and max_xid will limit new
 976  * exchange ID (XID) within this range for
 977  * a new exchange.
 978  * The LLD may choose to have multiple EMs,
 979  * e.g. one EM instance per CPU receive thread in LLD.
 980  *
 981  * Specified match function is used in allocating exchanges
 982  * from newly allocated EM.
 983  */
 984 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp,
 985                                       enum fc_class class,
 986                                       u16 min_xid,
 987                                       u16 max_xid,
 988                                       bool (*match)(struct fc_frame *));
 989
 990 /*
 991  * Free all exchange managers of a lport.
 992  */
 993 void fc_exch_mgr_free(struct fc_lport *lport);
 994
 995 /*
 996  * Receive a frame on specified local port and exchange manager.
 997  */
 998 void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp);
 999
1000 /*
1001  * This function is for exch_seq_send function pointer in
1002  * struct libfc_function_template, see comment block on
1003  * exch_seq_send for description of this function.
1004  */
1005 struct fc_seq *fc_exch_seq_send(struct fc_lport *lp,
1006                                 struct fc_frame *fp,
1007                                 void (*resp)(struct fc_seq *sp,
1008                                              struct fc_frame *fp,
1009                                              void *arg),
1010                                 void (*destructor)(struct fc_seq *sp,
1011                                                    void *arg),
1012                                 void *arg, u32 timer_msec);
1013
1014 /*
1015  * send a frame using existing sequence and exchange.
1016  */
1017 int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp);
1018
1019 /*
1020  * Send ELS response using mainly infomation
1021  * in exchange and sequence in EM layer.
1022  */
1023 void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd,
1024                          struct fc_seq_els_data *els_data);
1025
1026 /*
1027  * This function is for seq_exch_abort function pointer in
1028  * struct libfc_function_template, see comment block on
1029  * seq_exch_abort for description of this function.
1030  */
1031 int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec);
1032
1033 /*
1034  * Indicate that an exchange/sequence tuple is complete and the memory
1035  * allocated for the related objects may be freed.
1036  */
1037 void fc_exch_done(struct fc_seq *sp);
1038
1039 /*
1040  * Allocate a new exchange and sequence pair.
1041  */
1042 struct fc_exch *fc_exch_alloc(struct fc_lport *lport, struct fc_frame *fp);
1043 /*
1044  * Start a new sequence on the same exchange as the supplied sequence.
1045  */
1046 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
1047
1048 /*
1049  * Reset an exchange manager, completing all sequences and exchanges.
1050  * If s_id is non-zero, reset only exchanges originating from that FID.
1051  * If d_id is non-zero, reset only exchanges sending to that FID.
1052  */
1053 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1054
1055 /*
1056  * Functions for fc_functions_template
1057  */
1058 void fc_get_host_speed(struct Scsi_Host *shost);
1059 void fc_get_host_port_type(struct Scsi_Host *shost);
1060 void fc_get_host_port_state(struct Scsi_Host *shost);
1061 void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout);
1062 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1063
1064 /*
1065  * module setup functions.
1066  */
1067 int fc_setup_exch_mgr(void);
1068 void fc_destroy_exch_mgr(void);
1069 int fc_setup_rport(void);
1070 void fc_destroy_rport(void);
1071
1072 #endif /* _LIBFC_H_ */