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