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 #include <linux/refcount.h>
27 
28 #include <scsi/scsi_transport.h>
29 #include <scsi/scsi_transport_fc.h>
30 #include <scsi/scsi_bsg_fc.h>
31 
32 #include <scsi/fc/fc_fcp.h>
33 #include <scsi/fc/fc_ns.h>
34 #include <scsi/fc/fc_ms.h>
35 #include <scsi/fc/fc_els.h>
36 #include <scsi/fc/fc_gs.h>
37 
38 #include <scsi/fc_frame.h>
39 
40 #define	FC_FC4_PROV_SIZE	(FC_TYPE_FCP + 1)	/* size of tables */
41 
42 /*
43  * libfc error codes
44  */
45 #define	FC_NO_ERR	0	/* no error */
46 #define	FC_EX_TIMEOUT	1	/* Exchange timeout */
47 #define	FC_EX_CLOSED	2	/* Exchange closed */
48 #define FC_EX_ALLOC_ERR	3	/* Exchange allocation failed */
49 #define FC_EX_XMIT_ERR	4	/* Exchange transmit failed */
50 #define FC_EX_ELS_RJT	5	/* ELS rejected */
51 #define FC_EX_INV_LOGIN	6	/* Login not completed */
52 #define FC_EX_SEQ_ERR	6	/* Exchange sequence error */
53 
54 /**
55  * enum fc_lport_state - Local port states
56  * @LPORT_ST_DISABLED: Disabled
57  * @LPORT_ST_FLOGI:    Fabric login (FLOGI) sent
58  * @LPORT_ST_DNS:      Waiting for name server remote port to become ready
59  * @LPORT_ST_RPN_ID:   Register port name by ID (RPN_ID) sent
60  * @LPORT_ST_RFT_ID:   Register Fibre Channel types by ID (RFT_ID) sent
61  * @LPORT_ST_RFF_ID:   Register FC-4 Features by ID (RFF_ID) sent
62  * @LPORT_ST_FDMI:     Waiting for mgmt server rport to become ready
63  * @LPORT_ST_RHBA:
64  * @LPORT_ST_SCR:      State Change Register (SCR) sent
65  * @LPORT_ST_READY:    Ready for use
66  * @LPORT_ST_LOGO:     Local port logout (LOGO) sent
67  * @LPORT_ST_RESET:    Local port reset
68  */
69 enum fc_lport_state {
70 	LPORT_ST_DISABLED = 0,
71 	LPORT_ST_FLOGI,
72 	LPORT_ST_DNS,
73 	LPORT_ST_RNN_ID,
74 	LPORT_ST_RSNN_NN,
75 	LPORT_ST_RSPN_ID,
76 	LPORT_ST_RFT_ID,
77 	LPORT_ST_RFF_ID,
78 	LPORT_ST_FDMI,
79 	LPORT_ST_RHBA,
80 	LPORT_ST_RPA,
81 	LPORT_ST_DHBA,
82 	LPORT_ST_DPRT,
83 	LPORT_ST_SCR,
84 	LPORT_ST_READY,
85 	LPORT_ST_LOGO,
86 	LPORT_ST_RESET
87 };
88 
89 enum fc_disc_event {
90 	DISC_EV_NONE = 0,
91 	DISC_EV_SUCCESS,
92 	DISC_EV_FAILED
93 };
94 
95 /**
96  * enum fc_rport_state - Remote port states
97  * @RPORT_ST_INIT:    Initialized
98  * @RPORT_ST_FLOGI:   Waiting for FLOGI completion for point-to-multipoint
99  * @RPORT_ST_PLOGI_WAIT:   Waiting for peer to login for point-to-multipoint
100  * @RPORT_ST_PLOGI:   Waiting for PLOGI completion
101  * @RPORT_ST_PRLI:    Waiting for PRLI completion
102  * @RPORT_ST_RTV:     Waiting for RTV completion
103  * @RPORT_ST_READY:   Ready for use
104  * @RPORT_ST_ADISC:   Discover Address sent
105  * @RPORT_ST_DELETE:  Remote port being deleted
106 */
107 enum fc_rport_state {
108 	RPORT_ST_INIT,
109 	RPORT_ST_FLOGI,
110 	RPORT_ST_PLOGI_WAIT,
111 	RPORT_ST_PLOGI,
112 	RPORT_ST_PRLI,
113 	RPORT_ST_RTV,
114 	RPORT_ST_READY,
115 	RPORT_ST_ADISC,
116 	RPORT_ST_DELETE,
117 };
118 
119 /**
120  * struct fc_disc_port - temporary discovery port to hold rport identifiers
121  * @lp:         Fibre Channel host port instance
122  * @peers:      Node for list management during discovery and RSCN processing
123  * @rport_work: Work struct for starting the rport state machine
124  * @port_id:    Port ID of the discovered port
125  */
126 struct fc_disc_port {
127 	struct fc_lport    *lp;
128 	struct list_head   peers;
129 	struct work_struct rport_work;
130 	u32                port_id;
131 };
132 
133 /**
134  * enum fc_rport_event - Remote port events
135  * @RPORT_EV_NONE:   No event
136  * @RPORT_EV_READY:  Remote port is ready for use
137  * @RPORT_EV_FAILED: State machine failed, remote port is not ready
138  * @RPORT_EV_STOP:   Remote port has been stopped
139  * @RPORT_EV_LOGO:   Remote port logout (LOGO) sent
140  */
141 enum fc_rport_event {
142 	RPORT_EV_NONE = 0,
143 	RPORT_EV_READY,
144 	RPORT_EV_FAILED,
145 	RPORT_EV_STOP,
146 	RPORT_EV_LOGO
147 };
148 
149 struct fc_rport_priv;
150 
151 /**
152  * struct fc_rport_operations - Operations for a remote port
153  * @event_callback: Function to be called for remote port events
154  */
155 struct fc_rport_operations {
156 	void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
157 			       enum fc_rport_event);
158 };
159 
160 /**
161  * struct fc_rport_libfc_priv - libfc internal information about a remote port
162  * @local_port: The associated local port
163  * @rp_state:   Indicates READY for I/O or DELETE when blocked
164  * @flags:      REC and RETRY supported flags
165  * @e_d_tov:    Error detect timeout value (in msec)
166  * @r_a_tov:    Resource allocation timeout value (in msec)
167  */
168 struct fc_rport_libfc_priv {
169 	struct fc_lport		   *local_port;
170 	enum fc_rport_state        rp_state;
171 	u16			   flags;
172 	#define FC_RP_FLAGS_REC_SUPPORTED	(1 << 0)
173 	#define FC_RP_FLAGS_RETRY		(1 << 1)
174 	#define FC_RP_STARTED			(1 << 2)
175 	#define FC_RP_FLAGS_CONF_REQ		(1 << 3)
176 	unsigned int	           e_d_tov;
177 	unsigned int	           r_a_tov;
178 };
179 
180 /**
181  * struct fc_rport_priv - libfc remote port and discovery info
182  * @local_port:     The associated local port
183  * @rport:          The FC transport remote port
184  * @kref:           Reference counter
185  * @rp_state:       Enumeration that tracks progress of PLOGI, PRLI,
186  *                  and RTV exchanges
187  * @ids:            The remote port identifiers and roles
188  * @flags:          STARTED, REC and RETRY_SUPPORTED flags
189  * @max_seq:        Maximum number of concurrent sequences
190  * @disc_id:        The discovery identifier
191  * @maxframe_size:  The maximum frame size
192  * @retries:        The retry count for the current state
193  * @major_retries:  The retry count for the entire PLOGI/PRLI state machine
194  * @e_d_tov:        Error detect timeout value (in msec)
195  * @r_a_tov:        Resource allocation timeout value (in msec)
196  * @rp_mutex:       The mutex that protects the remote port
197  * @retry_work:     Handle for retries
198  * @event_callback: Callback when READY, FAILED or LOGO states complete
199  * @prli_count:     Count of open PRLI sessions in providers
200  * @rcu:	    Structure used for freeing in an RCU-safe manner
201  */
202 struct fc_rport_priv {
203 	struct fc_lport		    *local_port;
204 	struct fc_rport		    *rport;
205 	struct kref		    kref;
206 	enum fc_rport_state         rp_state;
207 	struct fc_rport_identifiers ids;
208 	u16			    flags;
209 	u16		            max_seq;
210 	u16			    disc_id;
211 	u16			    maxframe_size;
212 	unsigned int	            retries;
213 	unsigned int	            major_retries;
214 	unsigned int	            e_d_tov;
215 	unsigned int	            r_a_tov;
216 	struct mutex                rp_mutex;
217 	struct delayed_work	    retry_work;
218 	enum fc_rport_event         event;
219 	struct fc_rport_operations  *ops;
220 	struct list_head            peers;
221 	struct work_struct          event_work;
222 	u32			    supported_classes;
223 	u16                         prli_count;
224 	struct rcu_head		    rcu;
225 	u16			    sp_features;
226 	u8			    spp_type;
227 	void			    (*lld_event_callback)(struct fc_lport *,
228 						      struct fc_rport_priv *,
229 						      enum fc_rport_event);
230 };
231 
232 /**
233  * struct fc_stats - fc stats structure
234  * @SecondsSinceLastReset: Seconds since the last reset
235  * @TxFrames:              Number of transmitted frames
236  * @TxWords:               Number of transmitted words
237  * @RxFrames:              Number of received frames
238  * @RxWords:               Number of received words
239  * @ErrorFrames:           Number of received error frames
240  * @DumpedFrames:          Number of dumped frames
241  * @FcpPktAllocFails:      Number of fcp packet allocation failures
242  * @FcpPktAborts:          Number of fcp packet aborts
243  * @FcpFrameAllocFails:    Number of fcp frame allocation failures
244  * @LinkFailureCount:      Number of link failures
245  * @LossOfSignalCount:     Number for signal losses
246  * @InvalidTxWordCount:    Number of invalid transmitted words
247  * @InvalidCRCCount:       Number of invalid CRCs
248  * @InputRequests:         Number of input requests
249  * @OutputRequests:        Number of output requests
250  * @ControlRequests:       Number of control requests
251  * @InputBytes:            Number of received bytes
252  * @OutputBytes:           Number of transmitted bytes
253  * @VLinkFailureCount:     Number of virtual link failures
254  * @MissDiscAdvCount:      Number of missing FIP discovery advertisement
255  */
256 struct fc_stats {
257 	u64		SecondsSinceLastReset;
258 	u64		TxFrames;
259 	u64		TxWords;
260 	u64		RxFrames;
261 	u64		RxWords;
262 	u64		ErrorFrames;
263 	u64		DumpedFrames;
264 	u64		FcpPktAllocFails;
265 	u64		FcpPktAborts;
266 	u64		FcpFrameAllocFails;
267 	u64		LinkFailureCount;
268 	u64		LossOfSignalCount;
269 	u64		InvalidTxWordCount;
270 	u64		InvalidCRCCount;
271 	u64		InputRequests;
272 	u64		OutputRequests;
273 	u64		ControlRequests;
274 	u64		InputBytes;
275 	u64		OutputBytes;
276 	u64		VLinkFailureCount;
277 	u64		MissDiscAdvCount;
278 };
279 
280 /**
281  * struct fc_seq_els_data - ELS data used for passing ELS specific responses
282  * @reason: The reason for rejection
283  * @explan: The explanation of the rejection
284  *
285  * Mainly used by the exchange manager layer.
286  */
287 struct fc_seq_els_data {
288 	enum fc_els_rjt_reason reason;
289 	enum fc_els_rjt_explan explan;
290 };
291 
292 /**
293  * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
294  * @lp:              The associated local port
295  * @state:           The state of the I/O
296  * @ref_cnt:         Reference count
297  * @scsi_pkt_lock:   Lock to protect the SCSI packet (must be taken before the
298  *                   host_lock if both are to be held at the same time)
299  * @cmd:             The SCSI command (set and clear with the host_lock held)
300  * @list:            Tracks queued commands (accessed with the host_lock held)
301  * @timer:           The command timer
302  * @tm_done:         Completion indicator
303  * @wait_for_comp:   Indicator to wait for completion of the I/O (in jiffies)
304  * @data_len:        The length of the data
305  * @cdb_cmd:         The CDB command
306  * @xfer_len:        The transfer length
307  * @xfer_ddp:        Indicates if this transfer used DDP (XID of the exchange
308  *                   will be set here if DDP was setup)
309  * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
310  *                   (Tx and Rx)
311  * @max_payload:     The maximum payload size (in bytes)
312  * @io_status:       SCSI result (upper 24 bits)
313  * @cdb_status:      CDB status
314  * @status_code:     FCP I/O status
315  * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
316  * @req_flags:       Request flags (bit 0: read bit:1 write)
317  * @scsi_resid:      SCSI residule length
318  * @rport:           The remote port that the SCSI command is targeted at
319  * @seq_ptr:         The sequence that will carry the SCSI command
320  * @recov_retry:     Number of recovery retries
321  * @recov_seq:       The sequence for REC or SRR
322  */
323 struct fc_fcp_pkt {
324 	spinlock_t	  scsi_pkt_lock;
325 	refcount_t	  ref_cnt;
326 
327 	/* SCSI command and data transfer information */
328 	u32		  data_len;
329 
330 	/* SCSI I/O related information */
331 	struct scsi_cmnd  *cmd;
332 	struct list_head  list;
333 
334 	/* Housekeeping information */
335 	struct fc_lport   *lp;
336 	u8		  state;
337 
338 	/* SCSI/FCP return status */
339 	u8		  cdb_status;
340 	u8		  status_code;
341 	u8		  scsi_comp_flags;
342 	u32		  io_status;
343 	u32		  req_flags;
344 	u32		  scsi_resid;
345 
346 	/* Transport related veriables */
347 	size_t		  xfer_len;
348 	struct fcp_cmnd   cdb_cmd;
349 	u32		  xfer_contig_end;
350 	u16		  max_payload;
351 	u16		  xfer_ddp;
352 
353 	/* Associated structures */
354 	struct fc_rport	  *rport;
355 	struct fc_seq	  *seq_ptr;
356 
357 	/* Timeout/error related information */
358 	struct timer_list timer;
359 	int		  wait_for_comp;
360 	int		  timer_delay;
361 	u32		  recov_retry;
362 	struct fc_seq	  *recov_seq;
363 	struct completion tm_done;
364 } ____cacheline_aligned_in_smp;
365 
366 /*
367  * Structure and function definitions for managing Fibre Channel Exchanges
368  * and Sequences
369  *
370  * fc_exch holds state for one exchange and links to its active sequence.
371  *
372  * fc_seq holds the state for an individual sequence.
373  */
374 
375 struct fc_exch_mgr;
376 struct fc_exch_mgr_anchor;
377 extern u16 fc_cpu_mask;	/* cpu mask for possible cpus */
378 
379 /**
380  * struct fc_seq - FC sequence
381  * @id:       The sequence ID
382  * @ssb_stat: Status flags for the sequence status block (SSB)
383  * @cnt:      Number of frames sent so far
384  * @rec_data: FC-4 value for REC
385  */
386 struct fc_seq {
387 	u8  id;
388 	u16 ssb_stat;
389 	u16 cnt;
390 	u32 rec_data;
391 };
392 
393 #define FC_EX_DONE		(1 << 0) /* ep is completed */
394 #define FC_EX_RST_CLEANUP	(1 << 1) /* reset is forcing completion */
395 #define FC_EX_QUARANTINE	(1 << 2) /* exch is quarantined */
396 
397 /**
398  * struct fc_exch - Fibre Channel Exchange
399  * @em:           Exchange manager
400  * @pool:         Exchange pool
401  * @state:        The exchange's state
402  * @xid:          The exchange ID
403  * @ex_list:      Handle used by the EM to track free exchanges
404  * @ex_lock:      Lock that protects the exchange
405  * @ex_refcnt:    Reference count
406  * @timeout_work: Handle for timeout handler
407  * @lp:           The local port that this exchange is on
408  * @oxid:         Originator's exchange ID
409  * @rxid:         Responder's exchange ID
410  * @oid:          Originator's FCID
411  * @sid:          Source FCID
412  * @did:          Destination FCID
413  * @esb_stat:     ESB exchange status
414  * @r_a_tov:      Resouce allocation time out value (in msecs)
415  * @seq_id:       The next sequence ID to use
416  * @encaps:       encapsulation information for lower-level driver
417  * @f_ctl:        F_CTL flags for the sequence
418  * @fh_type:      The frame type
419  * @class:        The class of service
420  * @seq:          The sequence in use on this exchange
421  * @resp_active:  Number of tasks that are concurrently executing @resp().
422  * @resp_task:    If @resp_active > 0, either the task executing @resp(), the
423  *                task that has been interrupted to execute the soft-IRQ
424  *                executing @resp() or NULL if more than one task is executing
425  *                @resp concurrently.
426  * @resp_wq:      Waitqueue for the tasks waiting on @resp_active.
427  * @resp:         Callback for responses on this exchange
428  * @destructor:   Called when destroying the exchange
429  * @arg:          Passed as a void pointer to the resp() callback
430  *
431  * Locking notes: The ex_lock protects following items:
432  *	state, esb_stat, f_ctl, seq.ssb_stat
433  *	seq_id
434  *	sequence allocation
435  */
436 struct fc_exch {
437 	spinlock_t	    ex_lock;
438 	atomic_t	    ex_refcnt;
439 	enum fc_class	    class;
440 	struct fc_exch_mgr  *em;
441 	struct fc_exch_pool *pool;
442 	struct list_head    ex_list;
443 	struct fc_lport	    *lp;
444 	u32		    esb_stat;
445 	u8		    state;
446 	u8		    fh_type;
447 	u8		    seq_id;
448 	u8		    encaps;
449 	u16		    xid;
450 	u16		    oxid;
451 	u16		    rxid;
452 	u32		    oid;
453 	u32		    sid;
454 	u32		    did;
455 	u32		    r_a_tov;
456 	u32		    f_ctl;
457 	struct fc_seq       seq;
458 	int		    resp_active;
459 	struct task_struct  *resp_task;
460 	wait_queue_head_t   resp_wq;
461 	void		    (*resp)(struct fc_seq *, struct fc_frame *, void *);
462 	void		    *arg;
463 	void		    (*destructor)(struct fc_seq *, void *);
464 	struct delayed_work timeout_work;
465 } ____cacheline_aligned_in_smp;
466 #define	fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
467 
468 
469 struct libfc_function_template {
470 	/*
471 	 * Interface to send a FC frame
472 	 *
473 	 * STATUS: REQUIRED
474 	 */
475 	int (*frame_send)(struct fc_lport *, struct fc_frame *);
476 
477 	/*
478 	 * Interface to send ELS/CT frames
479 	 *
480 	 * STATUS: OPTIONAL
481 	 */
482 	struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
483 				     struct fc_frame *, unsigned int op,
484 				     void (*resp)(struct fc_seq *,
485 					     struct fc_frame *, void *arg),
486 				     void *arg, u32 timer_msec);
487 
488 	/*
489 	 * Sets up the DDP context for a given exchange id on the given
490 	 * scatterlist if LLD supports DDP for large receive.
491 	 *
492 	 * STATUS: OPTIONAL
493 	 */
494 	int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
495 			 unsigned int);
496 	/*
497 	 * Completes the DDP transfer and returns the length of data DDPed
498 	 * for the given exchange id.
499 	 *
500 	 * STATUS: OPTIONAL
501 	 */
502 	int (*ddp_done)(struct fc_lport *, u16);
503 	/*
504 	 * Sets up the DDP context for a given exchange id on the given
505 	 * scatterlist if LLD supports DDP for target.
506 	 *
507 	 * STATUS: OPTIONAL
508 	 */
509 	int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *,
510 			  unsigned int);
511 	/*
512 	 * Allow LLD to fill its own Link Error Status Block
513 	 *
514 	 * STATUS: OPTIONAL
515 	 */
516 	void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
517 
518 	/*
519 	 * Reset an exchange manager, completing all sequences and exchanges.
520 	 * If s_id is non-zero, reset only exchanges originating from that FID.
521 	 * If d_id is non-zero, reset only exchanges sending to that FID.
522 	 *
523 	 * STATUS: OPTIONAL
524 	 */
525 	void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
526 
527 	/*
528 	 * Set the local port FC_ID.
529 	 *
530 	 * This may be provided by the LLD to allow it to be
531 	 * notified when the local port is assigned a FC-ID.
532 	 *
533 	 * The frame, if non-NULL, is the incoming frame with the
534 	 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
535 	 * address for the LLD.  The frame pointer may be NULL if
536 	 * no MAC is associated with this assignment (LOGO or PLOGI).
537 	 *
538 	 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
539 	 *
540 	 * Note: this is called with the local port mutex held.
541 	 *
542 	 * STATUS: OPTIONAL
543 	 */
544 	void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
545 				  struct fc_frame *);
546 
547 	/*
548 	 * Callback routine after the remote port is logged in
549 	 *
550 	 * STATUS: OPTIONAL
551 	 */
552 	void (*rport_event_callback)(struct fc_lport *,
553 				     struct fc_rport_priv *,
554 				     enum fc_rport_event);
555 
556 	/*
557 	 * Send a fcp cmd from fsp pkt.
558 	 * Called with the SCSI host lock unlocked and irqs disabled.
559 	 *
560 	 * The resp handler is called when FCP_RSP received.
561 	 *
562 	 * STATUS: OPTIONAL
563 	 */
564 	int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
565 			    void (*resp)(struct fc_seq *, struct fc_frame *,
566 					 void *));
567 
568 	/*
569 	 * Cleanup the FCP layer, used during link down and reset
570 	 *
571 	 * STATUS: OPTIONAL
572 	 */
573 	void (*fcp_cleanup)(struct fc_lport *);
574 
575 	/*
576 	 * Abort all I/O on a local port
577 	 *
578 	 * STATUS: OPTIONAL
579 	 */
580 	void (*fcp_abort_io)(struct fc_lport *);
581 
582 	/*
583 	 * Receive a request for the discovery layer.
584 	 *
585 	 * STATUS: OPTIONAL
586 	 */
587 	void (*disc_recv_req)(struct fc_lport *, struct fc_frame *);
588 
589 	/*
590 	 * Start discovery for a local port.
591 	 *
592 	 * STATUS: OPTIONAL
593 	 */
594 	void (*disc_start)(void (*disc_callback)(struct fc_lport *,
595 						 enum fc_disc_event),
596 			   struct fc_lport *);
597 
598 	/*
599 	 * Stop discovery for a given lport. This will remove
600 	 * all discovered rports
601 	 *
602 	 * STATUS: OPTIONAL
603 	 */
604 	void (*disc_stop) (struct fc_lport *);
605 
606 	/*
607 	 * Stop discovery for a given lport. This will block
608 	 * until all discovered rports are deleted from the
609 	 * FC transport class
610 	 *
611 	 * STATUS: OPTIONAL
612 	 */
613 	void (*disc_stop_final) (struct fc_lport *);
614 };
615 
616 /**
617  * struct fc_disc - Discovery context
618  * @retry_count:   Number of retries
619  * @pending:       1 if discovery is pending, 0 if not
620  * @requested:     1 if discovery has been requested, 0 if not
621  * @seq_count:     Number of sequences used for discovery
622  * @buf_len:       Length of the discovery buffer
623  * @disc_id:       Discovery ID
624  * @rports:        List of discovered remote ports
625  * @priv:          Private pointer for use by discovery code
626  * @disc_mutex:    Mutex that protects the discovery context
627  * @partial_buf:   Partial name buffer (if names are returned
628  *                 in multiple frames)
629  * @disc_work:     handle for delayed work context
630  * @disc_callback: Callback routine called when discovery completes
631  */
632 struct fc_disc {
633 	unsigned char         retry_count;
634 	unsigned char         pending;
635 	unsigned char         requested;
636 	unsigned short        seq_count;
637 	unsigned char         buf_len;
638 	u16                   disc_id;
639 
640 	struct list_head      rports;
641 	void		      *priv;
642 	struct mutex	      disc_mutex;
643 	struct fc_gpn_ft_resp partial_buf;
644 	struct delayed_work   disc_work;
645 
646 	void (*disc_callback)(struct fc_lport *,
647 			      enum fc_disc_event);
648 };
649 
650 /*
651  * Local port notifier and events.
652  */
653 extern struct blocking_notifier_head fc_lport_notifier_head;
654 enum fc_lport_event {
655 	FC_LPORT_EV_ADD,
656 	FC_LPORT_EV_DEL,
657 };
658 
659 /**
660  * struct fc_lport - Local port
661  * @host:                  The SCSI host associated with a local port
662  * @ema_list:              Exchange manager anchor list
663  * @dns_rdata:             The directory server remote port
664  * @ms_rdata:		   The management server remote port
665  * @ptp_rdata:             Point to point remote port
666  * @scsi_priv:             FCP layer internal data
667  * @disc:                  Discovery context
668  * @vports:                Child vports if N_Port
669  * @vport:                 Parent vport if VN_Port
670  * @tt:                    Libfc function template
671  * @link_up:               Link state (1 = link up, 0 = link down)
672  * @qfull:                 Queue state (1 queue is full, 0 queue is not full)
673  * @state:                 Identifies the state
674  * @boot_time:             Timestamp indicating when the local port came online
675  * @host_stats:            SCSI host statistics
676  * @stats:                 FC local port stats (TODO separate libfc LLD stats)
677  * @retry_count:           Number of retries in the current state
678  * @port_id:               FC Port ID
679  * @wwpn:                  World Wide Port Name
680  * @wwnn:                  World Wide Node Name
681  * @service_params:        Common service parameters
682  * @e_d_tov:               Error detection timeout value
683  * @r_a_tov:               Resouce allocation timeout value
684  * @rnid_gen:              RNID information
685  * @sg_supp:               Indicates if scatter gather is supported
686  * @seq_offload:           Indicates if sequence offload is supported
687  * @crc_offload:           Indicates if CRC offload is supported
688  * @lro_enabled:           Indicates if large receive offload is supported
689  * @does_npiv:             Supports multiple vports
690  * @npiv_enabled:          Switch/fabric allows NPIV
691  * @mfs:                   The maximum Fibre Channel payload size
692  * @max_retry_count:       The maximum retry attempts
693  * @max_rport_retry_count: The maximum remote port retry attempts
694  * @rport_priv_size:       Size needed by driver after struct fc_rport_priv
695  * @lro_xid:               The maximum XID for LRO
696  * @lso_max:               The maximum large offload send size
697  * @fcts:                  FC-4 type mask
698  * @lp_mutex:              Mutex to protect the local port
699  * @list:                  Linkage on list of vport peers
700  * @retry_work:            Handle to local port for delayed retry context
701  * @prov:		   Pointers available for use by passive FC-4 providers
702  * @lport_list:            Linkage on module-wide list of local ports
703  */
704 struct fc_lport {
705 	/* Associations */
706 	struct Scsi_Host	       *host;
707 	struct list_head	       ema_list;
708 	struct fc_rport_priv	       *dns_rdata;
709 	struct fc_rport_priv	       *ms_rdata;
710 	struct fc_rport_priv	       *ptp_rdata;
711 	void			       *scsi_priv;
712 	struct fc_disc                 disc;
713 
714 	/* Virtual port information */
715 	struct list_head	       vports;
716 	struct fc_vport		       *vport;
717 
718 	/* Operational Information */
719 	struct libfc_function_template tt;
720 	u8			       link_up;
721 	u8			       qfull;
722 	u16			       vlan;
723 	enum fc_lport_state	       state;
724 	unsigned long		       boot_time;
725 	struct fc_host_statistics      host_stats;
726 	struct fc_stats	__percpu       *stats;
727 	u8			       retry_count;
728 
729 	/* Fabric information */
730 	u32                            port_id;
731 	u64			       wwpn;
732 	u64			       wwnn;
733 	unsigned int		       service_params;
734 	unsigned int		       e_d_tov;
735 	unsigned int		       r_a_tov;
736 	struct fc_els_rnid_gen	       rnid_gen;
737 
738 	/* Capabilities */
739 	u32			       sg_supp:1;
740 	u32			       seq_offload:1;
741 	u32			       crc_offload:1;
742 	u32			       lro_enabled:1;
743 	u32			       does_npiv:1;
744 	u32			       npiv_enabled:1;
745 	u32			       point_to_multipoint:1;
746 	u32			       fdmi_enabled:1;
747 	u32			       mfs;
748 	u8			       max_retry_count;
749 	u8			       max_rport_retry_count;
750 	u16			       rport_priv_size;
751 	u16			       link_speed;
752 	u16			       link_supported_speeds;
753 	u16			       lro_xid;
754 	unsigned int		       lso_max;
755 	struct fc_ns_fts	       fcts;
756 
757 	/* Miscellaneous */
758 	struct mutex                   lp_mutex;
759 	struct list_head               list;
760 	struct delayed_work	       retry_work;
761 	void			       *prov[FC_FC4_PROV_SIZE];
762 	struct list_head               lport_list;
763 };
764 
765 /**
766  * struct fc4_prov - FC-4 provider registration
767  * @prli:               Handler for incoming PRLI
768  * @prlo:               Handler for session reset
769  * @recv:		Handler for incoming request
770  * @module:		Pointer to module.  May be NULL.
771  */
772 struct fc4_prov {
773 	int (*prli)(struct fc_rport_priv *, u32 spp_len,
774 		    const struct fc_els_spp *spp_in,
775 		    struct fc_els_spp *spp_out);
776 	void (*prlo)(struct fc_rport_priv *);
777 	void (*recv)(struct fc_lport *, struct fc_frame *);
778 	struct module *module;
779 };
780 
781 /*
782  * Register FC-4 provider with libfc.
783  */
784 int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *);
785 void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *);
786 
787 /*
788  * FC_LPORT HELPER FUNCTIONS
789  *****************************/
790 
791 /**
792  * fc_lport_test_ready() - Determine if a local port is in the READY state
793  * @lport: The local port to test
794  */
fc_lport_test_ready(struct fc_lport * lport)795 static inline int fc_lport_test_ready(struct fc_lport *lport)
796 {
797 	return lport->state == LPORT_ST_READY;
798 }
799 
800 /**
801  * fc_set_wwnn() - Set the World Wide Node Name of a local port
802  * @lport: The local port whose WWNN is to be set
803  * @wwnn:  The new WWNN
804  */
fc_set_wwnn(struct fc_lport * lport,u64 wwnn)805 static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
806 {
807 	lport->wwnn = wwnn;
808 }
809 
810 /**
811  * fc_set_wwpn() - Set the World Wide Port Name of a local port
812  * @lport: The local port whose WWPN is to be set
813  * @wwpn:  The new WWPN
814  */
fc_set_wwpn(struct fc_lport * lport,u64 wwpn)815 static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwpn)
816 {
817 	lport->wwpn = wwpn;
818 }
819 
820 /**
821  * fc_lport_state_enter() - Change a local port's state
822  * @lport: The local port whose state is to change
823  * @state: The new state
824  */
fc_lport_state_enter(struct fc_lport * lport,enum fc_lport_state state)825 static inline void fc_lport_state_enter(struct fc_lport *lport,
826 					enum fc_lport_state state)
827 {
828 	if (state != lport->state)
829 		lport->retry_count = 0;
830 	lport->state = state;
831 }
832 
833 /**
834  * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
835  * @lport: The local port whose statistics are to be initialized
836  */
fc_lport_init_stats(struct fc_lport * lport)837 static inline int fc_lport_init_stats(struct fc_lport *lport)
838 {
839 	lport->stats = alloc_percpu(struct fc_stats);
840 	if (!lport->stats)
841 		return -ENOMEM;
842 	return 0;
843 }
844 
845 /**
846  * fc_lport_free_stats() - Free memory for a local port's statistics
847  * @lport: The local port whose statistics are to be freed
848  */
fc_lport_free_stats(struct fc_lport * lport)849 static inline void fc_lport_free_stats(struct fc_lport *lport)
850 {
851 	free_percpu(lport->stats);
852 }
853 
854 /**
855  * lport_priv() - Return the private data from a local port
856  * @lport: The local port whose private data is to be retreived
857  */
lport_priv(const struct fc_lport * lport)858 static inline void *lport_priv(const struct fc_lport *lport)
859 {
860 	return (void *)(lport + 1);
861 }
862 
863 /**
864  * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
865  *                      LLD private data
866  * @sht:       The SCSI host template
867  * @priv_size: Size of private data
868  *
869  * Returns: libfc lport
870  */
871 static inline struct fc_lport *
libfc_host_alloc(struct scsi_host_template * sht,int priv_size)872 libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
873 {
874 	struct fc_lport *lport;
875 	struct Scsi_Host *shost;
876 
877 	shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
878 	if (!shost)
879 		return NULL;
880 	lport = shost_priv(shost);
881 	lport->host = shost;
882 	INIT_LIST_HEAD(&lport->ema_list);
883 	INIT_LIST_HEAD(&lport->vports);
884 	return lport;
885 }
886 
887 /*
888  * FC_FCP HELPER FUNCTIONS
889  *****************************/
fc_fcp_is_read(const struct fc_fcp_pkt * fsp)890 static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
891 {
892 	if (fsp && fsp->cmd)
893 		return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
894 	return false;
895 }
896 
897 /*
898  * LOCAL PORT LAYER
899  *****************************/
900 int fc_lport_init(struct fc_lport *);
901 int fc_lport_destroy(struct fc_lport *);
902 int fc_fabric_logoff(struct fc_lport *);
903 int fc_fabric_login(struct fc_lport *);
904 void __fc_linkup(struct fc_lport *);
905 void fc_linkup(struct fc_lport *);
906 void __fc_linkdown(struct fc_lport *);
907 void fc_linkdown(struct fc_lport *);
908 void fc_vport_setlink(struct fc_lport *);
909 void fc_vports_linkchange(struct fc_lport *);
910 int fc_lport_config(struct fc_lport *);
911 int fc_lport_reset(struct fc_lport *);
912 void fc_lport_recv(struct fc_lport *lport, struct fc_frame *fp);
913 int fc_set_mfs(struct fc_lport *, u32 mfs);
914 struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
915 struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
916 int fc_lport_bsg_request(struct bsg_job *);
917 void fc_lport_set_local_id(struct fc_lport *, u32 port_id);
918 void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *);
919 
920 /*
921  * REMOTE PORT LAYER
922  *****************************/
923 void fc_rport_terminate_io(struct fc_rport *);
924 struct fc_rport_priv *fc_rport_lookup(const struct fc_lport *lport,
925 				      u32 port_id);
926 struct fc_rport_priv *fc_rport_create(struct fc_lport *, u32);
927 void fc_rport_destroy(struct kref *kref);
928 int fc_rport_login(struct fc_rport_priv *rdata);
929 int fc_rport_logoff(struct fc_rport_priv *rdata);
930 void fc_rport_recv_req(struct fc_lport *lport, struct fc_frame *fp);
931 void fc_rport_flush_queue(void);
932 
933 /*
934  * DISCOVERY LAYER
935  *****************************/
936 void fc_disc_init(struct fc_lport *);
937 void fc_disc_config(struct fc_lport *, void *);
938 
fc_disc_lport(struct fc_disc * disc)939 static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
940 {
941 	return container_of(disc, struct fc_lport, disc);
942 }
943 
944 /*
945  * FCP LAYER
946  *****************************/
947 int fc_fcp_init(struct fc_lport *);
948 void fc_fcp_destroy(struct fc_lport *);
949 
950 /*
951  * SCSI INTERACTION LAYER
952  *****************************/
953 int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
954 int fc_eh_abort(struct scsi_cmnd *);
955 int fc_eh_device_reset(struct scsi_cmnd *);
956 int fc_eh_host_reset(struct scsi_cmnd *);
957 int fc_slave_alloc(struct scsi_device *);
958 
959 /*
960  * ELS/CT interface
961  *****************************/
962 int fc_elsct_init(struct fc_lport *);
963 struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
964 				    struct fc_frame *,
965 				    unsigned int op,
966 				    void (*resp)(struct fc_seq *,
967 						 struct fc_frame *,
968 						 void *arg),
969 				    void *arg, u32 timer_msec);
970 void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
971 void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
972 void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *,
973 		       enum fc_rctl, u32 parm_offset);
974 void fc_fill_hdr(struct fc_frame *, const struct fc_frame *,
975 		 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset);
976 
977 
978 /*
979  * EXCHANGE MANAGER LAYER
980  *****************************/
981 int fc_exch_init(struct fc_lport *);
982 void fc_exch_update_stats(struct fc_lport *lport);
983 struct fc_seq *fc_exch_seq_send(struct fc_lport *lport,
984 				struct fc_frame *fp,
985 				void (*resp)(struct fc_seq *,
986 					     struct fc_frame *fp,
987 					     void *arg),
988 				void (*destructor)(struct fc_seq *, void *),
989 				void *arg, u32 timer_msec);
990 void fc_seq_els_rsp_send(struct fc_frame *, enum fc_els_cmd,
991 			 struct fc_seq_els_data *);
992 struct fc_seq *fc_seq_start_next(struct fc_seq *sp);
993 void fc_seq_set_resp(struct fc_seq *sp,
994 		     void (*resp)(struct fc_seq *, struct fc_frame *, void *),
995 		     void *arg);
996 struct fc_seq *fc_seq_assign(struct fc_lport *lport, struct fc_frame *fp);
997 void fc_seq_release(struct fc_seq *sp);
998 struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
999 					   struct fc_exch_mgr *,
1000 					   bool (*match)(struct fc_frame *));
1001 void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
1002 int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
1003 struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
1004 				      u16 min_xid, u16 max_xid,
1005 				      bool (*match)(struct fc_frame *));
1006 void fc_exch_mgr_free(struct fc_lport *);
1007 void fc_exch_recv(struct fc_lport *, struct fc_frame *);
1008 void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
1009 int fc_seq_send(struct fc_lport *lport, struct fc_seq *sp, struct fc_frame *fp);
1010 int fc_seq_exch_abort(const struct fc_seq *, unsigned int timer_msec);
1011 void fc_exch_done(struct fc_seq *sp);
1012 
1013 /*
1014  * Functions for fc_functions_template
1015  */
1016 void fc_get_host_speed(struct Scsi_Host *);
1017 void fc_get_host_port_state(struct Scsi_Host *);
1018 void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
1019 struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1020 
1021 #endif /* _LIBFC_H_ */
1022