libfc.h 31.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * Copyright(c) 2007 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Maintained at www.Open-FCoE.org
 */

#ifndef _LIBFC_H_
#define _LIBFC_H_

#include <linux/timer.h>
#include <linux/if.h>
25
#include <linux/percpu.h>
26 27 28

#include <scsi/scsi_transport.h>
#include <scsi/scsi_transport_fc.h>
29
#include <scsi/scsi_bsg_fc.h>
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

#include <scsi/fc/fc_fcp.h>
#include <scsi/fc/fc_ns.h>
#include <scsi/fc/fc_els.h>
#include <scsi/fc/fc_gs.h>

#include <scsi/fc_frame.h>

/*
 * libfc error codes
 */
#define	FC_NO_ERR	0	/* no error */
#define	FC_EX_TIMEOUT	1	/* Exchange timeout */
#define	FC_EX_CLOSED	2	/* Exchange closed */

/* some helpful macros */

#define ntohll(x) be64_to_cpu(x)
#define htonll(x) cpu_to_be64(x)

#define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))

#define hton24(p, v)	do {			\
		p[0] = (((v) >> 16) & 0xFF);	\
		p[1] = (((v) >> 8) & 0xFF);	\
		p[2] = ((v) & 0xFF);		\
	} while (0)

58 59 60 61 62 63 64
/**
 * enum fc_lport_state - Local port states
 * @LPORT_ST_DISABLED: Disabled
 * @LPORT_ST_FLOGI:    Fabric login (FLOGI) sent
 * @LPORT_ST_DNS:      Waiting for name server remote port to become ready
 * @LPORT_ST_RPN_ID:   Register port name by ID (RPN_ID) sent
 * @LPORT_ST_RFT_ID:   Register Fibre Channel types by ID (RFT_ID) sent
65
 * @LPORT_ST_RFF_ID:   Register FC-4 Features by ID (RFF_ID) sent
66 67 68 69
 * @LPORT_ST_SCR:      State Change Register (SCR) sent
 * @LPORT_ST_READY:    Ready for use
 * @LPORT_ST_LOGO:     Local port logout (LOGO) sent
 * @LPORT_ST_RESET:    Local port reset
70 71
 */
enum fc_lport_state {
72
	LPORT_ST_DISABLED = 0,
73 74
	LPORT_ST_FLOGI,
	LPORT_ST_DNS,
75
	LPORT_ST_RNN_ID,
76
	LPORT_ST_RSNN_NN,
77
	LPORT_ST_RSPN_ID,
78
	LPORT_ST_RFT_ID,
79
	LPORT_ST_RFF_ID,
80 81 82 83 84 85 86 87 88 89 90 91
	LPORT_ST_SCR,
	LPORT_ST_READY,
	LPORT_ST_LOGO,
	LPORT_ST_RESET
};

enum fc_disc_event {
	DISC_EV_NONE = 0,
	DISC_EV_SUCCESS,
	DISC_EV_FAILED
};

92 93 94 95 96 97 98 99 100 101 102 103
/**
 * enum fc_rport_state - Remote port states
 * @RPORT_ST_INIT:    Initialized
 * @RPORT_ST_PLOGI:   Waiting for PLOGI completion
 * @RPORT_ST_PRLI:    Waiting for PRLI completion
 * @RPORT_ST_RTV:     Waiting for RTV completion
 * @RPORT_ST_READY:   Ready for use
 * @RPORT_ST_LOGO:    Remote port logout (LOGO) sent
 * @RPORT_ST_ADISC:   Discover Address sent
 * @RPORT_ST_DELETE:  Remote port being deleted
 * @RPORT_ST_RESTART: Remote port being deleted and will restart
*/
104
enum fc_rport_state {
105 106 107 108 109 110 111 112 113
	RPORT_ST_INIT,
	RPORT_ST_PLOGI,
	RPORT_ST_PRLI,
	RPORT_ST_RTV,
	RPORT_ST_READY,
	RPORT_ST_LOGO,
	RPORT_ST_ADISC,
	RPORT_ST_DELETE,
	RPORT_ST_RESTART,
114 115 116 117
};

/**
 * struct fc_disc_port - temporary discovery port to hold rport identifiers
118 119 120 121
 * @lp:         Fibre Channel host port instance
 * @peers:      Node for list management during discovery and RSCN processing
 * @rport_work: Work struct for starting the rport state machine
 * @port_id:    Port ID of the discovered port
122 123
 */
struct fc_disc_port {
124 125 126 127
	struct fc_lport    *lp;
	struct list_head   peers;
	struct work_struct rport_work;
	u32                port_id;
128 129
};

130 131 132 133 134 135 136 137
/**
 * enum fc_rport_event - Remote port events
 * @RPORT_EV_NONE:   No event
 * @RPORT_EV_READY:  Remote port is ready for use
 * @RPORT_EV_FAILED: State machine failed, remote port is not ready
 * @RPORT_EV_STOP:   Remote port has been stopped
 * @RPORT_EV_LOGO:   Remote port logout (LOGO) sent
 */
138 139
enum fc_rport_event {
	RPORT_EV_NONE = 0,
140
	RPORT_EV_READY,
141 142 143 144 145
	RPORT_EV_FAILED,
	RPORT_EV_STOP,
	RPORT_EV_LOGO
};

146 147
struct fc_rport_priv;

148 149 150 151
/**
 * struct fc_rport_operations - Operations for a remote port
 * @event_callback: Function to be called for remote port events
 */
152
struct fc_rport_operations {
153
	void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
154 155 156 157 158
			       enum fc_rport_event);
};

/**
 * struct fc_rport_libfc_priv - libfc internal information about a remote port
159 160 161 162 163
 * @local_port: The associated local port
 * @rp_state:   Indicates READY for I/O or DELETE when blocked
 * @flags:      REC and RETRY supported flags
 * @e_d_tov:    Error detect timeout value (in msec)
 * @r_a_tov:    Resource allocation timeout value (in msec)
164 165 166 167 168 169 170 171 172 173 174 175
 */
struct fc_rport_libfc_priv {
	struct fc_lport		   *local_port;
	enum fc_rport_state        rp_state;
	u16			   flags;
	#define FC_RP_FLAGS_REC_SUPPORTED	(1 << 0)
	#define FC_RP_FLAGS_RETRY		(1 << 1)
	unsigned int	           e_d_tov;
	unsigned int	           r_a_tov;
};

/**
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
 * struct fc_rport_priv - libfc remote port and discovery info
 * @local_port:     The associated local port
 * @rport:          The FC transport remote port
 * @kref:           Reference counter
 * @rp_state:       Enumeration that tracks progress of PLOGI, PRLI,
 *                  and RTV exchanges
 * @ids:            The remote port identifiers and roles
 * @flags:          REC and RETRY supported flags
 * @max_seq:        Maximum number of concurrent sequences
 * @disc_id:        The discovery identifier
 * @maxframe_size:  The maximum frame size
 * @retries:        The retry count for the current state
 * @e_d_tov:        Error detect timeout value (in msec)
 * @r_a_tov:        Resource allocation timeout value (in msec)
 * @rp_mutex:       The mutex that protects the remote port
 * @retry_work:     Handle for retries
 * @event_callback: Callback when READY, FAILED or LOGO states complete
193
 */
194
struct fc_rport_priv {
195 196 197 198
	struct fc_lport		    *local_port;
	struct fc_rport		    *rport;
	struct kref		    kref;
	enum fc_rport_state         rp_state;
199
	struct fc_rport_identifiers ids;
200 201 202 203 204 205 206 207 208 209 210 211 212 213
	u16			    flags;
	u16		            max_seq;
	u16			    disc_id;
	u16			    maxframe_size;
	unsigned int	            retries;
	unsigned int	            e_d_tov;
	unsigned int	            r_a_tov;
	struct mutex                rp_mutex;
	struct delayed_work	    retry_work;
	enum fc_rport_event         event;
	struct fc_rport_operations  *ops;
	struct list_head            peers;
	struct work_struct          event_work;
	u32			    supported_classes;
214 215
};

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/**
 * struct fcoe_dev_stats - fcoe stats structure
 * @SecondsSinceLastReset: Seconds since the last reset
 * @TxFrames:              Number of transmitted frames
 * @TxWords:               Number of transmitted words
 * @RxFrames:              Number of received frames
 * @RxWords:               Number of received words
 * @ErrorFrames:           Number of received error frames
 * @DumpedFrames:          Number of dumped frames
 * @LinkFailureCount:      Number of link failures
 * @LossOfSignalCount:     Number for signal losses
 * @InvalidTxWordCount:    Number of invalid transmitted words
 * @InvalidCRCCount:       Number of invalid CRCs
 * @InputRequests:         Number of input requests
 * @OutputRequests:        Number of output requests
 * @ControlRequests:       Number of control requests
 * @InputMegabytes:        Number of received megabytes
 * @OutputMegabytes:       Number of transmitted megabytes
234 235
 * @VLinkFailureCount:     Number of virtual link failures
 * @MissDiscAdvCount:      Number of missing FIP discovery advertisement
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
 */
struct fcoe_dev_stats {
	u64		SecondsSinceLastReset;
	u64		TxFrames;
	u64		TxWords;
	u64		RxFrames;
	u64		RxWords;
	u64		ErrorFrames;
	u64		DumpedFrames;
	u64		LinkFailureCount;
	u64		LossOfSignalCount;
	u64		InvalidTxWordCount;
	u64		InvalidCRCCount;
	u64		InputRequests;
	u64		OutputRequests;
	u64		ControlRequests;
	u64		InputMegabytes;
	u64		OutputMegabytes;
254 255
	u64		VLinkFailureCount;
	u64		MissDiscAdvCount;
256 257
};

258 259 260 261 262 263 264
/**
 * struct fc_seq_els_data - ELS data used for passing ELS specific responses
 * @fp:     The ELS frame
 * @reason: The reason for rejection
 * @explan: The explaination of the rejection
 *
 * Mainly used by the exchange manager layer.
265 266 267 268 269 270 271
 */
struct fc_seq_els_data {
	struct fc_frame *fp;
	enum fc_els_rjt_reason reason;
	enum fc_els_rjt_explan explan;
};

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/**
 * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
 * @lp:              The associated local port
 * @state:           The state of the I/O
 * @tgt_flags:       Target's flags
 * @ref_cnt:         Reference count
 * @scsi_pkt_lock:   Lock to protect the SCSI packet (must be taken before the
 *                   host_lock if both are to be held at the same time)
 * @cmd:             The SCSI command (set and clear with the host_lock held)
 * @list:            Tracks queued commands (accessed with the host_lock held)
 * @timer:           The command timer
 * @tm_done:         Completion indicator
 * @wait_for_comp:   Indicator to wait for completion of the I/O (in jiffies)
 * @start_time:      Timestamp indicating the start of the I/O (in jiffies)
 * @end_time:        Timestamp indicating the end of the I/O (in jiffies)
 * @last_pkt_time:   Timestamp of the last frame received (in jiffies)
 * @data_len:        The length of the data
 * @cdb_cmd:         The CDB command
 * @xfer_len:        The transfer length
 * @xfer_ddp:        Indicates if this transfer used DDP (XID of the exchange
 *                   will be set here if DDP was setup)
 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
 *                   (Tx and Rx)
 * @max_payload:     The maximum payload size (in bytes)
 * @io_status:       SCSI result (upper 24 bits)
 * @cdb_status:      CDB status
 * @status_code:     FCP I/O status
 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
 * @req_flags:       Request flags (bit 0: read bit:1 write)
 * @scsi_resid:      SCSI residule length
 * @rport:           The remote port that the SCSI command is targeted at
 * @seq_ptr:         The sequence that will carry the SCSI command
 * @recov_retry:     Number of recovery retries
 * @recov_seq:       The sequence for REC or SRR
306 307
 */
struct fc_fcp_pkt {
308 309 310 311 312 313 314 315 316 317 318 319 320
	/* Housekeeping information */
	struct fc_lport   *lp;
	u16		  state;
	u16		  tgt_flags;
	atomic_t	  ref_cnt;
	spinlock_t	  scsi_pkt_lock;

	/* SCSI I/O related information */
	struct scsi_cmnd  *cmd;
	struct list_head  list;

	/* Timeout related information */
	struct timer_list timer;
321
	struct completion tm_done;
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
	int	          wait_for_comp;
	unsigned long	  start_time;
	unsigned long	  end_time;
	unsigned long	  last_pkt_time;

	/* SCSI command and data transfer information */
	u32		  data_len;

	/* Transport related veriables */
	struct fcp_cmnd   cdb_cmd;
	size_t		  xfer_len;
	u16		  xfer_ddp;
	u32		  xfer_contig_end;
	u16		  max_payload;

	/* SCSI/FCP return status */
	u32		  io_status;
	u8		  cdb_status;
	u8		  status_code;
	u8		  scsi_comp_flags;
	u32		  req_flags;
	u32		  scsi_resid;

	/* Associated structures */
	struct fc_rport	  *rport;
	struct fc_seq	  *seq_ptr;

	/* Error Processing information */
	u8		  recov_retry;
	struct fc_seq	  *recov_seq;
352 353 354 355 356 357 358 359 360 361 362 363
};

/*
 * Structure and function definitions for managing Fibre Channel Exchanges
 * and Sequences
 *
 * fc_exch holds state for one exchange and links to its active sequence.
 *
 * fc_seq holds the state for an individual sequence.
 */

struct fc_exch_mgr;
364
struct fc_exch_mgr_anchor;
365
extern u16 fc_cpu_mask;	/* cpu mask for possible cpus */
366

367 368 369 370 371 372
/**
 * struct fc_seq - FC sequence
 * @id:       The sequence ID
 * @ssb_stat: Status flags for the sequence status block (SSB)
 * @cnt:      Number of frames sent so far
 * @rec_data: FC-4 value for REC
373 374
 */
struct fc_seq {
375 376 377 378
	u8  id;
	u16 ssb_stat;
	u16 cnt;
	u32 rec_data;
379 380 381 382 383
};

#define FC_EX_DONE		(1 << 0) /* ep is completed */
#define FC_EX_RST_CLEANUP	(1 << 1) /* reset is forcing completion */

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
/**
 * struct fc_exch - Fibre Channel Exchange
 * @em:           Exchange manager
 * @pool:         Exchange pool
 * @state:        The exchange's state
 * @xid:          The exchange ID
 * @ex_list:      Handle used by the EM to track free exchanges
 * @ex_lock:      Lock that protects the exchange
 * @ex_refcnt:    Reference count
 * @timeout_work: Handle for timeout handler
 * @lp:           The local port that this exchange is on
 * @oxid:         Originator's exchange ID
 * @rxid:         Responder's exchange ID
 * @oid:          Originator's FCID
 * @sid:          Source FCID
 * @did:          Destination FCID
 * @esb_stat:     ESB exchange status
 * @r_a_tov:      Resouce allocation time out value (in msecs)
 * @seq_id:       The next sequence ID to use
 * @f_ctl:        F_CTL flags for the sequence
 * @fh_type:      The frame type
 * @class:        The class of service
 * @seq:          The sequence in use on this exchange
 * @resp:         Callback for responses on this exchange
 * @destructor:   Called when destroying the exchange
 * @arg:          Passed as a void pointer to the resp() callback
410 411 412 413 414 415 416
 *
 * Locking notes: The ex_lock protects following items:
 *	state, esb_stat, f_ctl, seq.ssb_stat
 *	seq_id
 *	sequence allocation
 */
struct fc_exch {
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
	struct fc_exch_mgr  *em;
	struct fc_exch_pool *pool;
	u32		    state;
	u16		    xid;
	struct list_head    ex_list;
	spinlock_t	    ex_lock;
	atomic_t	    ex_refcnt;
	struct delayed_work timeout_work;
	struct fc_lport	    *lp;
	u16		    oxid;
	u16		    rxid;
	u32		    oid;
	u32		    sid;
	u32		    did;
	u32		    esb_stat;
	u32		    r_a_tov;
	u8		    seq_id;
	u32		    f_ctl;
	u8		    fh_type;
	enum fc_class	    class;
	struct fc_seq	    seq;

	void		    (*resp)(struct fc_seq *, struct fc_frame *, void *);
	void		    *arg;

	void		    (*destructor)(struct fc_seq *, void *);

444 445 446 447
};
#define	fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)


448
struct libfc_function_template {
449 450 451
	/*
	 * Interface to send a FC frame
	 *
452
	 * STATUS: REQUIRED
453
	 */
454
	int (*frame_send)(struct fc_lport *, struct fc_frame *);
455 456

	/*
457 458 459
	 * Interface to send ELS/CT frames
	 *
	 * STATUS: OPTIONAL
460
	 */
461 462
	struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
				     struct fc_frame *, unsigned int op,
463
				     void (*resp)(struct fc_seq *,
464
					     struct fc_frame *, void *arg),
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
				     void *arg, u32 timer_msec);

	/*
	 * Send the FC frame payload using a new exchange and sequence.
	 *
	 * The exchange response handler is set in this routine to resp()
	 * function pointer. It can be called in two scenarios: if a timeout
	 * occurs or if a response frame is received for the exchange. The
	 * fc_frame pointer in response handler will also indicate timeout
	 * as error using IS_ERR related macros.
	 *
	 * The exchange destructor handler is also set in this routine.
	 * The destructor handler is invoked by EM layer when exchange
	 * is about to free, this can be used by caller to free its
	 * resources along with exchange free.
	 *
	 * The arg is passed back to resp and destructor handler.
	 *
	 * The timeout value (in msec) for an exchange is set if non zero
	 * timer_msec argument is specified. The timer is canceled when
	 * it fires or when the exchange is done. The exchange timeout handler
	 * is registered by EM layer.
487 488
	 *
	 * STATUS: OPTIONAL
489
	 */
490 491 492 493 494 495 496
	struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *,
					void (*resp)(struct fc_seq *,
						     struct fc_frame *,
						     void *),
					void (*destructor)(struct fc_seq *,
							   void *),
					void *, unsigned int timer_msec);
497

498 499 500 501 502 503
	/*
	 * Sets up the DDP context for a given exchange id on the given
	 * scatterlist if LLD supports DDP for large receive.
	 *
	 * STATUS: OPTIONAL
	 */
504 505
	int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
			 unsigned int);
506 507 508 509 510 511
	/*
	 * Completes the DDP transfer and returns the length of data DDPed
	 * for the given exchange id.
	 *
	 * STATUS: OPTIONAL
	 */
512
	int (*ddp_done)(struct fc_lport *, u16);
513 514 515 516 517 518
	/*
	 * Allow LLD to fill its own Link Error Status Block
	 *
	 * STATUS: OPTIONAL
	 */
	void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
519
	/*
520 521 522
	 * Send a frame using an existing sequence and exchange.
	 *
	 * STATUS: OPTIONAL
523
	 */
524 525
	int (*seq_send)(struct fc_lport *, struct fc_seq *,
			struct fc_frame *);
526 527

	/*
528 529 530 531
	 * Send an ELS response using infomation from a previous
	 * exchange and sequence.
	 *
	 * STATUS: OPTIONAL
532
	 */
533 534
	void (*seq_els_rsp_send)(struct fc_seq *, enum fc_els_cmd,
				 struct fc_seq_els_data *);
535 536 537 538 539 540 541 542

	/*
	 * Abort an exchange and sequence. Generally called because of a
	 * exchange timeout or an abort from the upper layer.
	 *
	 * A timer_msec can be specified for abort timeout, if non-zero
	 * timer_msec value is specified then exchange resp handler
	 * will be called with timeout error if no response to abort.
543 544
	 *
	 * STATUS: OPTIONAL
545
	 */
546
	int (*seq_exch_abort)(const struct fc_seq *,
547 548 549 550 551
			      unsigned int timer_msec);

	/*
	 * Indicate that an exchange/sequence tuple is complete and the memory
	 * allocated for the related objects may be freed.
552 553
	 *
	 * STATUS: OPTIONAL
554
	 */
555
	void (*exch_done)(struct fc_seq *);
556 557 558

	/*
	 * Start a new sequence on the same exchange/sequence tuple.
559 560
	 *
	 * STATUS: OPTIONAL
561
	 */
562
	struct fc_seq *(*seq_start_next)(struct fc_seq *);
563 564 565 566 567

	/*
	 * Reset an exchange manager, completing all sequences and exchanges.
	 * If s_id is non-zero, reset only exchanges originating from that FID.
	 * If d_id is non-zero, reset only exchanges sending to that FID.
568 569
	 *
	 * STATUS: OPTIONAL
570
	 */
571
	void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
572

573 574 575 576
	/*
	 * Flush the rport work queue. Generally used before shutdown.
	 *
	 * STATUS: OPTIONAL
577
	 */
578
	void (*rport_flush_queue)(void);
579 580

	/*
581 582 583
	 * Receive a frame for a local port.
	 *
	 * STATUS: OPTIONAL
584
	 */
585 586
	void (*lport_recv)(struct fc_lport *, struct fc_seq *,
			   struct fc_frame *);
587

588 589 590 591
	/*
	 * Reset the local port.
	 *
	 * STATUS: OPTIONAL
592
	 */
593
	int (*lport_reset)(struct fc_lport *);
594

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
	/*
	 * Set the local port FC_ID.
	 *
	 * This may be provided by the LLD to allow it to be
	 * notified when the local port is assigned a FC-ID.
	 *
	 * The frame, if non-NULL, is the incoming frame with the
	 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
	 * address for the LLD.  The frame pointer may be NULL if
	 * no MAC is associated with this assignment (LOGO or PLOGI).
	 *
	 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
	 *
	 * Note: this is called with the local port mutex held.
	 *
	 * STATUS: OPTIONAL
	 */
	void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
				  struct fc_frame *);

615
	/*
616 617 618
	 * Create a remote port with a given port ID
	 *
	 * STATUS: OPTIONAL
619
	 */
620
	struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
621

622 623 624 625 626 627 628 629
	/*
	 * Initiates the RP state machine. It is called from the LP module.
	 * This function will issue the following commands to the N_Port
	 * identified by the FC ID provided.
	 *
	 * - PLOGI
	 * - PRLI
	 * - RTV
630 631
	 *
	 * STATUS: OPTIONAL
632
	 */
633
	int (*rport_login)(struct fc_rport_priv *);
634 635 636 637

	/*
	 * Logoff, and remove the rport from the transport if
	 * it had been added. This will send a LOGO to the target.
638 639
	 *
	 * STATUS: OPTIONAL
640
	 */
641
	int (*rport_logoff)(struct fc_rport_priv *);
642 643 644

	/*
	 * Recieve a request from a remote port.
645 646
	 *
	 * STATUS: OPTIONAL
647 648
	 */
	void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
649
			       struct fc_lport *);
650

651 652 653 654
	/*
	 * lookup an rport by it's port ID.
	 *
	 * STATUS: OPTIONAL
655
	 */
656
	struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
657

658 659 660 661 662 663
	/*
	 * Destroy an rport after final kref_put().
	 * The argument is a pointer to the kref inside the fc_rport_priv.
	 */
	void (*rport_destroy)(struct kref *);

664 665 666 667 668 669
	/*
	 * Send a fcp cmd from fsp pkt.
	 * Called with the SCSI host lock unlocked and irqs disabled.
	 *
	 * The resp handler is called when FCP_RSP received.
	 *
670
	 * STATUS: OPTIONAL
671
	 */
672 673 674
	int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
			    void (*resp)(struct fc_seq *, struct fc_frame *,
					 void *));
675 676

	/*
677 678 679
	 * Cleanup the FCP layer, used durring link down and reset
	 *
	 * STATUS: OPTIONAL
680
	 */
681
	void (*fcp_cleanup)(struct fc_lport *);
682 683 684

	/*
	 * Abort all I/O on a local port
685 686
	 *
	 * STATUS: OPTIONAL
687
	 */
688
	void (*fcp_abort_io)(struct fc_lport *);
689

690 691 692 693
	/*
	 * Receive a request for the discovery layer.
	 *
	 * STATUS: OPTIONAL
694
	 */
695 696
	void (*disc_recv_req)(struct fc_seq *, struct fc_frame *,
			      struct fc_lport *);
697 698 699

	/*
	 * Start discovery for a local port.
700 701
	 *
	 * STATUS: OPTIONAL
702 703 704 705 706 707 708 709
	 */
	void (*disc_start)(void (*disc_callback)(struct fc_lport *,
						 enum fc_disc_event),
			   struct fc_lport *);

	/*
	 * Stop discovery for a given lport. This will remove
	 * all discovered rports
710 711
	 *
	 * STATUS: OPTIONAL
712 713 714 715 716 717 718
	 */
	void (*disc_stop) (struct fc_lport *);

	/*
	 * Stop discovery for a given lport. This will block
	 * until all discovered rports are deleted from the
	 * FC transport class
719 720
	 *
	 * STATUS: OPTIONAL
721 722 723 724
	 */
	void (*disc_stop_final) (struct fc_lport *);
};

725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
/**
 * struct fc_disc - Discovery context
 * @retry_count:   Number of retries
 * @pending:       1 if discovery is pending, 0 if not
 * @requesting:    1 if discovery has been requested, 0 if not
 * @seq_count:     Number of sequences used for discovery
 * @buf_len:       Length of the discovery buffer
 * @disc_id:       Discovery ID
 * @rports:        List of discovered remote ports
 * @lport:         The local port that discovery is for
 * @disc_mutex:    Mutex that protects the discovery context
 * @partial_buf:   Partial name buffer (if names are returned
 *                 in multiple frames)
 * @disc_work:     handle for delayed work context
 * @disc_callback: Callback routine called when discovery completes
 */
741
struct fc_disc {
742 743 744 745 746 747 748 749 750 751 752 753
	unsigned char         retry_count;
	unsigned char         pending;
	unsigned char         requested;
	unsigned short        seq_count;
	unsigned char         buf_len;
	u16                   disc_id;

	struct list_head      rports;
	struct fc_lport	      *lport;
	struct mutex	      disc_mutex;
	struct fc_gpn_ft_resp partial_buf;
	struct delayed_work   disc_work;
754 755 756 757 758

	void (*disc_callback)(struct fc_lport *,
			      enum fc_disc_event);
};

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
/**
 * struct fc_lport - Local port
 * @host:                  The SCSI host associated with a local port
 * @ema_list:              Exchange manager anchor list
 * @dns_rdata:             The directory server remote port
 * @ptp_rdata:             Point to point remote port
 * @scsi_priv:             FCP layer internal data
 * @disc:                  Discovery context
 * @vports:                Child vports if N_Port
 * @vport:                 Parent vport if VN_Port
 * @tt:                    Libfc function template
 * @link_up:               Link state (1 = link up, 0 = link down)
 * @qfull:                 Queue state (1 queue is full, 0 queue is not full)
 * @state:                 Identifies the state
 * @boot_time:             Timestamp indicating when the local port came online
 * @host_stats:            SCSI host statistics
 * @dev_stats:             FCoE device stats (TODO: libfc should not be
 *                         FCoE aware)
 * @retry_count:           Number of retries in the current state
 * @wwpn:                  World Wide Port Name
 * @wwnn:                  World Wide Node Name
 * @service_params:        Common service parameters
 * @e_d_tov:               Error detection timeout value
 * @r_a_tov:               Resouce allocation timeout value
 * @rnid_gen:              RNID information
 * @sg_supp:               Indicates if scatter gather is supported
 * @seq_offload:           Indicates if sequence offload is supported
 * @crc_offload:           Indicates if CRC offload is supported
 * @lro_enabled:           Indicates if large receive offload is supported
 * @does_npiv:             Supports multiple vports
 * @npiv_enabled:          Switch/fabric allows NPIV
 * @mfs:                   The maximum Fibre Channel payload size
 * @max_retry_count:       The maximum retry attempts
 * @max_rport_retry_count: The maximum remote port retry attempts
 * @lro_xid:               The maximum XID for LRO
 * @lso_max:               The maximum large offload send size
 * @fcts:                  FC-4 type mask
 * @lp_mutex:              Mutex to protect the local port
 * @list:                  Handle for list of local ports
 * @retry_work:            Handle to local port for delayed retry context
 */
800 801
struct fc_lport {
	/* Associations */
802 803 804 805 806 807 808 809 810 811
	struct Scsi_Host	       *host;
	struct list_head	       ema_list;
	struct fc_rport_priv	       *dns_rdata;
	struct fc_rport_priv	       *ptp_rdata;
	void			       *scsi_priv;
	struct fc_disc                 disc;

	/* Virtual port information */
	struct list_head	       vports;
	struct fc_vport		       *vport;
812 813 814

	/* Operational Information */
	struct libfc_function_template tt;
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
	u8			       link_up;
	u8			       qfull;
	enum fc_lport_state	       state;
	unsigned long		       boot_time;
	struct fc_host_statistics      host_stats;
	struct fcoe_dev_stats	       *dev_stats;
	u8			       retry_count;

	/* Fabric information */
	u64			       wwpn;
	u64			       wwnn;
	unsigned int		       service_params;
	unsigned int		       e_d_tov;
	unsigned int		       r_a_tov;
	struct fc_els_rnid_gen	       rnid_gen;
830 831

	/* Capabilities */
832 833 834 835 836 837 838 839 840 841 842 843 844 845
	u32			       sg_supp:1;
	u32			       seq_offload:1;
	u32			       crc_offload:1;
	u32			       lro_enabled:1;
	u32			       does_npiv:1;
	u32			       npiv_enabled:1;
	u32			       mfs;
	u8			       max_retry_count;
	u8			       max_rport_retry_count;
	u16			       link_speed;
	u16			       link_supported_speeds;
	u16			       lro_xid;
	unsigned int		       lso_max;
	struct fc_ns_fts	       fcts;
846 847

	/* Miscellaneous */
848 849 850
	struct mutex                   lp_mutex;
	struct list_head               list;
	struct delayed_work	       retry_work;
851 852
};

853
/*
854 855
 * FC_LPORT HELPER FUNCTIONS
 *****************************/
856 857 858 859 860 861

/**
 * fc_lport_test_ready() - Determine if a local port is in the READY state
 * @lport: The local port to test
 */
static inline int fc_lport_test_ready(struct fc_lport *lport)
862
{
863
	return lport->state == LPORT_ST_READY;
864 865
}

866 867 868 869 870 871
/**
 * fc_set_wwnn() - Set the World Wide Node Name of a local port
 * @lport: The local port whose WWNN is to be set
 * @wwnn:  The new WWNN
 */
static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
872
{
873
	lport->wwnn = wwnn;
874 875
}

876 877 878 879 880 881
/**
 * fc_set_wwpn() - Set the World Wide Port Name of a local port
 * @lport: The local port whose WWPN is to be set
 * @wwnn:  The new WWPN
 */
static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn)
882
{
883
	lport->wwpn = wwnn;
884 885
}

886 887 888 889 890 891
/**
 * fc_lport_state_enter() - Change a local port's state
 * @lport: The local port whose state is to change
 * @state: The new state
 */
static inline void fc_lport_state_enter(struct fc_lport *lport,
892 893
					enum fc_lport_state state)
{
894 895 896
	if (state != lport->state)
		lport->retry_count = 0;
	lport->state = state;
897 898
}

899 900 901 902 903
/**
 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
 * @lport: The local port whose statistics are to be initialized
 */
static inline int fc_lport_init_stats(struct fc_lport *lport)
904
{
905 906
	lport->dev_stats = alloc_percpu(struct fcoe_dev_stats);
	if (!lport->dev_stats)
907 908 909 910
		return -ENOMEM;
	return 0;
}

911 912 913 914 915
/**
 * fc_lport_free_stats() - Free memory for a local port's statistics
 * @lport: The local port whose statistics are to be freed
 */
static inline void fc_lport_free_stats(struct fc_lport *lport)
916
{
917
	free_percpu(lport->dev_stats);
918 919
}

920 921 922 923 924
/**
 * fc_lport_get_stats() - Get a local port's statistics
 * @lport: The local port whose statistics are to be retreived
 */
static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lport)
925
{
926
	return per_cpu_ptr(lport->dev_stats, smp_processor_id());
927 928
}

929 930 931 932 933
/**
 * lport_priv() - Return the private data from a local port
 * @lport: The local port whose private data is to be retreived
 */
static inline void *lport_priv(const struct fc_lport *lport)
934
{
935
	return (void *)(lport + 1);
936 937 938
}

/**
939 940 941 942
 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
 *                      LLD private data
 * @sht:       The SCSI host template
 * @priv_size: Size of private data
943
 *
944
 * Returns: libfc lport
945
 */
946
static inline struct fc_lport *
947 948
libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
{
949 950 951 952 953 954 955 956 957
	struct fc_lport *lport;
	struct Scsi_Host *shost;

	shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
	if (!shost)
		return NULL;
	lport = shost_priv(shost);
	lport->host = shost;
	INIT_LIST_HEAD(&lport->ema_list);
958
	INIT_LIST_HEAD(&lport->vports);
959
	return lport;
960
}
961

962
/*
963
 * FC_FCP HELPER FUNCTIONS
964
 *****************************/
965 966 967 968 969 970
static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
{
	if (fsp && fsp->cmd)
		return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
	return false;
}
971 972

/*
973 974 975 976 977 978
 * LOCAL PORT LAYER
 *****************************/
int fc_lport_init(struct fc_lport *);
int fc_lport_destroy(struct fc_lport *);
int fc_fabric_logoff(struct fc_lport *);
int fc_fabric_login(struct fc_lport *);
979
void __fc_linkup(struct fc_lport *);
980
void fc_linkup(struct fc_lport *);
981
void __fc_linkdown(struct fc_lport *);
982
void fc_linkdown(struct fc_lport *);
983 984
void fc_vport_setlink(struct fc_lport *);
void fc_vports_linkchange(struct fc_lport *);
985 986
int fc_lport_config(struct fc_lport *);
int fc_lport_reset(struct fc_lport *);
987 988 989 990
int fc_set_mfs(struct fc_lport *, u32 mfs);
struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
int fc_lport_bsg_request(struct fc_bsg_job *);
991

992
/*
993 994
 * REMOTE PORT LAYER
 *****************************/
995 996
int fc_rport_init(struct fc_lport *);
void fc_rport_terminate_io(struct fc_rport *);
997

998
/*
999 1000
 * DISCOVERY LAYER
 *****************************/
1001
int fc_disc_init(struct fc_lport *);
1002

1003
/*
1004
 * FCP LAYER
1005 1006
 *****************************/
int fc_fcp_init(struct fc_lport *);
1007
void fc_fcp_destroy(struct fc_lport *);
1008 1009

/*
1010 1011 1012
 * SCSI INTERACTION LAYER
 *****************************/
int fc_queuecommand(struct scsi_cmnd *,
1013
		    void (*done)(struct scsi_cmnd *));
1014 1015 1016 1017 1018 1019
int fc_eh_abort(struct scsi_cmnd *);
int fc_eh_device_reset(struct scsi_cmnd *);
int fc_eh_host_reset(struct scsi_cmnd *);
int fc_slave_alloc(struct scsi_device *);
int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason);
int fc_change_queue_type(struct scsi_device *, int tag_type);
1020

1021
/*
1022 1023
 * ELS/CT interface
 *****************************/
1024 1025 1026
int fc_elsct_init(struct fc_lport *);
struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
				    struct fc_frame *,
1027 1028
				    unsigned int op,
				    void (*resp)(struct fc_seq *,
1029
						 struct fc_frame *,
1030 1031 1032 1033
						 void *arg),
				    void *arg, u32 timer_msec);
void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
1034 1035


1036
/*
1037 1038
 * EXCHANGE MANAGER LAYER
 *****************************/
1039 1040 1041
int fc_exch_init(struct fc_lport *);
struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
					   struct fc_exch_mgr *,
1042
					   bool (*match)(struct fc_frame *));
1043
void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
1044
int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
1045 1046
struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
				      u16 min_xid, u16 max_xid,
1047
				      bool (*match)(struct fc_frame *));
1048 1049
void fc_exch_mgr_free(struct fc_lport *);
void fc_exch_recv(struct fc_lport *, struct fc_frame *);
1050
void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1051 1052 1053 1054

/*
 * Functions for fc_functions_template
 */
1055 1056 1057 1058
void fc_get_host_speed(struct Scsi_Host *);
void fc_get_host_port_type(struct Scsi_Host *);
void fc_get_host_port_state(struct Scsi_Host *);
void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
1059 1060 1061
struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);

#endif /* _LIBFC_H_ */