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