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