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