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