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