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