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