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