projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[SCSI] libfc: add fc_fill_reply_hdr() and fc_fill_hdr()
[deliverable/linux.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
42e9a92f
RL		 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
3a3b42bf
RL		 45/**
46 * enum fc_lport_state - Local port states
47 * @LPORT_ST_DISABLED: Disabled
48 * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent
49 * @LPORT_ST_DNS: Waiting for name server remote port to become ready
50 * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent
51 * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent
ab593b18 52 * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent
3a3b42bf
RL		 53 * @LPORT_ST_SCR: State Change Register (SCR) sent
54 * @LPORT_ST_READY: Ready for use
55 * @LPORT_ST_LOGO: Local port logout (LOGO) sent
56 * @LPORT_ST_RESET: Local port reset
42e9a92f 57 */
42e9a92f 58enum fc_lport_state {
b1d9fd55 59 LPORT_ST_DISABLED = 0,
42e9a92f
RL		 60 LPORT_ST_FLOGI,
61 LPORT_ST_DNS,
c9c7bd7a 62 LPORT_ST_RNN_ID,
5baa17c3 63 LPORT_ST_RSNN_NN,
c9866a54 64 LPORT_ST_RSPN_ID,
42e9a92f 65 LPORT_ST_RFT_ID,
ab593b18 66 LPORT_ST_RFF_ID,
42e9a92f
RL		 67 LPORT_ST_SCR,
68 LPORT_ST_READY,
69 LPORT_ST_LOGO,
70 LPORT_ST_RESET
71};
72
73enum fc_disc_event {
74 DISC_EV_NONE = 0,
75 DISC_EV_SUCCESS,
76 DISC_EV_FAILED
77};
78
3a3b42bf
RL		 79/**
80 * enum fc_rport_state - Remote port states
81 * @RPORT_ST_INIT: Initialized
a7b12a27
JE		 82 * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint
83 * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint
3a3b42bf
RL		 84 * @RPORT_ST_PLOGI: Waiting for PLOGI completion
85 * @RPORT_ST_PRLI: Waiting for PRLI completion
86 * @RPORT_ST_RTV: Waiting for RTV completion
87 * @RPORT_ST_READY: Ready for use
3a3b42bf
RL		 88 * @RPORT_ST_ADISC: Discover Address sent
89 * @RPORT_ST_DELETE: Remote port being deleted
3a3b42bf 90*/
42e9a92f 91enum fc_rport_state {
3a3b42bf 92 RPORT_ST_INIT,
a7b12a27
JE		 93 RPORT_ST_FLOGI,
94 RPORT_ST_PLOGI_WAIT,
3a3b42bf
RL		 95 RPORT_ST_PLOGI,
96 RPORT_ST_PRLI,
97 RPORT_ST_RTV,
98 RPORT_ST_READY,
3a3b42bf
RL		 99 RPORT_ST_ADISC,
100 RPORT_ST_DELETE,
42e9a92f
RL		 101};
102
42e9a92f
RL		 103/**
104 * struct fc_disc_port - temporary discovery port to hold rport identifiers
9737e6a7
RL		 105 * @lp: Fibre Channel host port instance
106 * @peers: Node for list management during discovery and RSCN processing
107 * @rport_work: Work struct for starting the rport state machine
108 * @port_id: Port ID of the discovered port
42e9a92f
RL		 109 */
110struct fc_disc_port {
3a3b42bf
RL		 111 struct fc_lport *lp;
112 struct list_head peers;
113 struct work_struct rport_work;
114 u32 port_id;
42e9a92f
RL		 115};
116
3a3b42bf
RL		 117/**
118 * enum fc_rport_event - Remote port events
119 * @RPORT_EV_NONE: No event
120 * @RPORT_EV_READY: Remote port is ready for use
121 * @RPORT_EV_FAILED: State machine failed, remote port is not ready
122 * @RPORT_EV_STOP: Remote port has been stopped
123 * @RPORT_EV_LOGO: Remote port logout (LOGO) sent
124 */
42e9a92f
RL		 125enum fc_rport_event {
126 RPORT_EV_NONE = 0,
4c0f62b5 127 RPORT_EV_READY,
42e9a92f
RL		 128 RPORT_EV_FAILED,
129 RPORT_EV_STOP,
130 RPORT_EV_LOGO
131};
132
9fb9d328
JE		 133struct fc_rport_priv;
134
3a3b42bf
RL		 135/**
136 * struct fc_rport_operations - Operations for a remote port
137 * @event_callback: Function to be called for remote port events
138 */
42e9a92f 139struct fc_rport_operations {
9fb9d328 140 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
42e9a92f
RL		 141 enum fc_rport_event);
142};
143
144/**
145 * struct fc_rport_libfc_priv - libfc internal information about a remote port
3a3b42bf
RL		 146 * @local_port: The associated local port
147 * @rp_state: Indicates READY for I/O or DELETE when blocked
148 * @flags: REC and RETRY supported flags
149 * @e_d_tov: Error detect timeout value (in msec)
150 * @r_a_tov: Resource allocation timeout value (in msec)
9e9d0452
JE		 151 */
152struct fc_rport_libfc_priv {
153 struct fc_lport *local_port;
154 enum fc_rport_state rp_state;
155 u16 flags;
156 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
157 #define FC_RP_FLAGS_RETRY (1 << 1)
4b2164d4 158 #define FC_RP_STARTED (1 << 2)
9e9d0452
JE		 159 unsigned int e_d_tov;
160 unsigned int r_a_tov;
161};
162
163/**
3a3b42bf
RL		 164 * struct fc_rport_priv - libfc remote port and discovery info
165 * @local_port: The associated local port
166 * @rport: The FC transport remote port
167 * @kref: Reference counter
168 * @rp_state: Enumeration that tracks progress of PLOGI, PRLI,
169 * and RTV exchanges
170 * @ids: The remote port identifiers and roles
4b2164d4 171 * @flags: STARTED, REC and RETRY_SUPPORTED flags
3a3b42bf
RL		 172 * @max_seq: Maximum number of concurrent sequences
173 * @disc_id: The discovery identifier
174 * @maxframe_size: The maximum frame size
175 * @retries: The retry count for the current state
f034260d 176 * @major_retries: The retry count for the entire PLOGI/PRLI state machine
3a3b42bf
RL		 177 * @e_d_tov: Error detect timeout value (in msec)
178 * @r_a_tov: Resource allocation timeout value (in msec)
179 * @rp_mutex: The mutex that protects the remote port
180 * @retry_work: Handle for retries
181 * @event_callback: Callback when READY, FAILED or LOGO states complete
42e90414 182 * @rcu: Structure used for freeing in an RCU-safe manner
42e9a92f 183 */
9e9d0452 184struct fc_rport_priv {
3a3b42bf
RL		 185 struct fc_lport *local_port;
186 struct fc_rport *rport;
187 struct kref kref;
188 enum fc_rport_state rp_state;
f211fa51 189 struct fc_rport_identifiers ids;
3a3b42bf
RL		 190 u16 flags;
191 u16 max_seq;
192 u16 disc_id;
193 u16 maxframe_size;
194 unsigned int retries;
f034260d 195 unsigned int major_retries;
3a3b42bf
RL		 196 unsigned int e_d_tov;
197 unsigned int r_a_tov;
198 struct mutex rp_mutex;
199 struct delayed_work retry_work;
200 enum fc_rport_event event;
201 struct fc_rport_operations *ops;
202 struct list_head peers;
203 struct work_struct event_work;
204 u32 supported_classes;
42e90414 205 struct rcu_head rcu;
42e9a92f
RL		 206};
207
3a3b42bf
RL		 208/**
209 * struct fcoe_dev_stats - fcoe stats structure
210 * @SecondsSinceLastReset: Seconds since the last reset
211 * @TxFrames: Number of transmitted frames
212 * @TxWords: Number of transmitted words
213 * @RxFrames: Number of received frames
214 * @RxWords: Number of received words
215 * @ErrorFrames: Number of received error frames
216 * @DumpedFrames: Number of dumped frames
217 * @LinkFailureCount: Number of link failures
218 * @LossOfSignalCount: Number for signal losses
219 * @InvalidTxWordCount: Number of invalid transmitted words
220 * @InvalidCRCCount: Number of invalid CRCs
221 * @InputRequests: Number of input requests
222 * @OutputRequests: Number of output requests
223 * @ControlRequests: Number of control requests
224 * @InputMegabytes: Number of received megabytes
225 * @OutputMegabytes: Number of transmitted megabytes
6580bbd0
YZ		 226 * @VLinkFailureCount: Number of virtual link failures
227 * @MissDiscAdvCount: Number of missing FIP discovery advertisement
42e9a92f
RL		 228 */
229struct fcoe_dev_stats {
230 u64 SecondsSinceLastReset;
231 u64 TxFrames;
232 u64 TxWords;
233 u64 RxFrames;
234 u64 RxWords;
235 u64 ErrorFrames;
236 u64 DumpedFrames;
237 u64 LinkFailureCount;
238 u64 LossOfSignalCount;
239 u64 InvalidTxWordCount;
240 u64 InvalidCRCCount;
241 u64 InputRequests;
242 u64 OutputRequests;
243 u64 ControlRequests;
244 u64 InputMegabytes;
245 u64 OutputMegabytes;
6580bbd0
YZ		 246 u64 VLinkFailureCount;
247 u64 MissDiscAdvCount;
42e9a92f
RL		 248};
249
3a3b42bf
RL		 250/**
251 * struct fc_seq_els_data - ELS data used for passing ELS specific responses
252 * @fp: The ELS frame
253 * @reason: The reason for rejection
254 * @explan: The explaination of the rejection
255 *
256 * Mainly used by the exchange manager layer.
42e9a92f
RL		 257 */
258struct fc_seq_els_data {
259 struct fc_frame *fp;
260 enum fc_els_rjt_reason reason;
261 enum fc_els_rjt_explan explan;
262};
263
3a3b42bf
RL		 264/**
265 * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
266 * @lp: The associated local port
267 * @state: The state of the I/O
268 * @tgt_flags: Target's flags
269 * @ref_cnt: Reference count
270 * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the
271 * host_lock if both are to be held at the same time)
272 * @cmd: The SCSI command (set and clear with the host_lock held)
273 * @list: Tracks queued commands (accessed with the host_lock held)
274 * @timer: The command timer
275 * @tm_done: Completion indicator
276 * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies)
277 * @start_time: Timestamp indicating the start of the I/O (in jiffies)
278 * @end_time: Timestamp indicating the end of the I/O (in jiffies)
279 * @last_pkt_time: Timestamp of the last frame received (in jiffies)
280 * @data_len: The length of the data
281 * @cdb_cmd: The CDB command
282 * @xfer_len: The transfer length
283 * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange
284 * will be set here if DDP was setup)
285 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
286 * (Tx and Rx)
287 * @max_payload: The maximum payload size (in bytes)
288 * @io_status: SCSI result (upper 24 bits)
289 * @cdb_status: CDB status
290 * @status_code: FCP I/O status
291 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
292 * @req_flags: Request flags (bit 0: read bit:1 write)
293 * @scsi_resid: SCSI residule length
294 * @rport: The remote port that the SCSI command is targeted at
295 * @seq_ptr: The sequence that will carry the SCSI command
296 * @recov_retry: Number of recovery retries
297 * @recov_seq: The sequence for REC or SRR
42e9a92f
RL		 298 */
299struct fc_fcp_pkt {
3a3b42bf
RL		 300 /* Housekeeping information */
301 struct fc_lport *lp;
302 u16 state;
303 u16 tgt_flags;
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 /*
0ae4d4ae
RL		 522 * Send an ELS response using infomation from a previous
523 * exchange and sequence.
524 *
525 * STATUS: OPTIONAL
42e9a92f 526 */
3a3b42bf
RL		 527 void (*seq_els_rsp_send)(struct fc_seq *, enum fc_els_cmd,
528 struct fc_seq_els_data *);
42e9a92f
RL		 529
530 /*
531 * Abort an exchange and sequence. Generally called because of a
532 * exchange timeout or an abort from the upper layer.
533 *
534 * A timer_msec can be specified for abort timeout, if non-zero
535 * timer_msec value is specified then exchange resp handler
536 * will be called with timeout error if no response to abort.
0ae4d4ae
RL		 537 *
538 * STATUS: OPTIONAL
42e9a92f 539 */
3a3b42bf 540 int (*seq_exch_abort)(const struct fc_seq *,
42e9a92f
RL		 541 unsigned int timer_msec);
542
543 /*
544 * Indicate that an exchange/sequence tuple is complete and the memory
545 * allocated for the related objects may be freed.
0ae4d4ae
RL		 546 *
547 * STATUS: OPTIONAL
42e9a92f 548 */
3a3b42bf 549 void (*exch_done)(struct fc_seq *);
42e9a92f 550
42e9a92f
RL		 551 /*
552 * Start a new sequence on the same exchange/sequence tuple.
0ae4d4ae
RL		 553 *
554 * STATUS: OPTIONAL
42e9a92f 555 */
3a3b42bf 556 struct fc_seq *(*seq_start_next)(struct fc_seq *);
42e9a92f
RL		 557
558 /*
559 * Reset an exchange manager, completing all sequences and exchanges.
560 * If s_id is non-zero, reset only exchanges originating from that FID.
561 * If d_id is non-zero, reset only exchanges sending to that FID.
0ae4d4ae
RL		 562 *
563 * STATUS: OPTIONAL
42e9a92f 564 */
3a3b42bf 565 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
42e9a92f 566
0ae4d4ae
RL		 567 /*
568 * Flush the rport work queue. Generally used before shutdown.
569 *
570 * STATUS: OPTIONAL
42e9a92f 571 */
0ae4d4ae 572 void (*rport_flush_queue)(void);
42e9a92f
RL		 573
574 /*
0ae4d4ae
RL		 575 * Receive a frame for a local port.
576 *
577 * STATUS: OPTIONAL
42e9a92f 578 */
3a3b42bf
RL		 579 void (*lport_recv)(struct fc_lport *, struct fc_seq *,
580 struct fc_frame *);
42e9a92f 581
0ae4d4ae
RL		 582 /*
583 * Reset the local port.
584 *
585 * STATUS: OPTIONAL
42e9a92f 586 */
0ae4d4ae 587 int (*lport_reset)(struct fc_lport *);
42e9a92f 588
093bb6a2
JE		 589 /*
590 * Set the local port FC_ID.
591 *
592 * This may be provided by the LLD to allow it to be
593 * notified when the local port is assigned a FC-ID.
594 *
595 * The frame, if non-NULL, is the incoming frame with the
596 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
597 * address for the LLD. The frame pointer may be NULL if
598 * no MAC is associated with this assignment (LOGO or PLOGI).
599 *
600 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
601 *
602 * Note: this is called with the local port mutex held.
603 *
604 * STATUS: OPTIONAL
605 */
606 void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
607 struct fc_frame *);
608
5101ff99 609 /*
9737e6a7
RL		 610 * Create a remote port with a given port ID
611 *
612 * STATUS: OPTIONAL
5101ff99 613 */
9737e6a7 614 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
5101ff99 615
42e9a92f
RL		 616 /*
617 * Initiates the RP state machine. It is called from the LP module.
618 * This function will issue the following commands to the N_Port
619 * identified by the FC ID provided.
620 *
621 * - PLOGI
622 * - PRLI
623 * - RTV
0ae4d4ae
RL		 624 *
625 * STATUS: OPTIONAL
42e9a92f 626 */
9fb9d328 627 int (*rport_login)(struct fc_rport_priv *);
42e9a92f
RL		 628
629 /*
630 * Logoff, and remove the rport from the transport if
631 * it had been added. This will send a LOGO to the target.
0ae4d4ae
RL		 632 *
633 * STATUS: OPTIONAL
42e9a92f 634 */
9fb9d328 635 int (*rport_logoff)(struct fc_rport_priv *);
42e9a92f
RL		 636
637 /*
638 * Recieve a request from a remote port.
0ae4d4ae
RL		 639 *
640 * STATUS: OPTIONAL
42e9a92f
RL		 641 */
642 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
131203a1 643 struct fc_lport *);
42e9a92f 644
0ae4d4ae
RL		 645 /*
646 * lookup an rport by it's port ID.
647 *
648 * STATUS: OPTIONAL
42e9a92f 649 */
9fb9d328 650 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
42e9a92f 651
f211fa51
JE		 652 /*
653 * Destroy an rport after final kref_put().
654 * The argument is a pointer to the kref inside the fc_rport_priv.
655 */
656 void (*rport_destroy)(struct kref *);
657
42e9a92f
RL		 658 /*
659 * Send a fcp cmd from fsp pkt.
660 * Called with the SCSI host lock unlocked and irqs disabled.
661 *
662 * The resp handler is called when FCP_RSP received.
663 *
0ae4d4ae 664 * STATUS: OPTIONAL
42e9a92f 665 */
3a3b42bf
RL		 666 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
667 void (*resp)(struct fc_seq *, struct fc_frame *,
668 void *));
42e9a92f
RL		 669
670 /*
0ae4d4ae
RL		 671 * Cleanup the FCP layer, used durring link down and reset
672 *
673 * STATUS: OPTIONAL
42e9a92f 674 */
3a3b42bf 675 void (*fcp_cleanup)(struct fc_lport *);
42e9a92f
RL		 676
677 /*
678 * Abort all I/O on a local port
0ae4d4ae
RL		 679 *
680 * STATUS: OPTIONAL
42e9a92f 681 */
3a3b42bf 682 void (*fcp_abort_io)(struct fc_lport *);
42e9a92f 683
0ae4d4ae
RL		 684 /*
685 * Receive a request for the discovery layer.
686 *
687 * STATUS: OPTIONAL
42e9a92f 688 */
3a3b42bf
RL		 689 void (*disc_recv_req)(struct fc_seq *, struct fc_frame *,
690 struct fc_lport *);
42e9a92f
RL		 691
692 /*
693 * Start discovery for a local port.
0ae4d4ae
RL		 694 *
695 * STATUS: OPTIONAL
42e9a92f
RL		 696 */
697 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
698 enum fc_disc_event),
699 struct fc_lport *);
700
701 /*
702 * Stop discovery for a given lport. This will remove
703 * all discovered rports
0ae4d4ae
RL		 704 *
705 * STATUS: OPTIONAL
42e9a92f
RL		 706 */
707 void (*disc_stop) (struct fc_lport *);
708
709 /*
710 * Stop discovery for a given lport. This will block
711 * until all discovered rports are deleted from the
712 * FC transport class
0ae4d4ae
RL		 713 *
714 * STATUS: OPTIONAL
42e9a92f
RL		 715 */
716 void (*disc_stop_final) (struct fc_lport *);
717};
718
3a3b42bf
RL		 719/**
720 * struct fc_disc - Discovery context
721 * @retry_count: Number of retries
722 * @pending: 1 if discovery is pending, 0 if not
723 * @requesting: 1 if discovery has been requested, 0 if not
724 * @seq_count: Number of sequences used for discovery
725 * @buf_len: Length of the discovery buffer
726 * @disc_id: Discovery ID
727 * @rports: List of discovered remote ports
0685230c 728 * @priv: Private pointer for use by discovery code
3a3b42bf
RL		 729 * @disc_mutex: Mutex that protects the discovery context
730 * @partial_buf: Partial name buffer (if names are returned
731 * in multiple frames)
732 * @disc_work: handle for delayed work context
733 * @disc_callback: Callback routine called when discovery completes
734 */
42e9a92f 735struct fc_disc {
3a3b42bf
RL		 736 unsigned char retry_count;
737 unsigned char pending;
738 unsigned char requested;
739 unsigned short seq_count;
740 unsigned char buf_len;
741 u16 disc_id;
742
743 struct list_head rports;
0685230c 744 void *priv;
3a3b42bf
RL		 745 struct mutex disc_mutex;
746 struct fc_gpn_ft_resp partial_buf;
747 struct delayed_work disc_work;
42e9a92f
RL		 748
749 void (*disc_callback)(struct fc_lport *,
750 enum fc_disc_event);
42e9a92f
RL		 751};
752
3a3b42bf
RL		 753/**
754 * struct fc_lport - Local port
755 * @host: The SCSI host associated with a local port
756 * @ema_list: Exchange manager anchor list
757 * @dns_rdata: The directory server remote port
758 * @ptp_rdata: Point to point remote port
759 * @scsi_priv: FCP layer internal data
760 * @disc: Discovery context
761 * @vports: Child vports if N_Port
762 * @vport: Parent vport if VN_Port
763 * @tt: Libfc function template
764 * @link_up: Link state (1 = link up, 0 = link down)
765 * @qfull: Queue state (1 queue is full, 0 queue is not full)
766 * @state: Identifies the state
767 * @boot_time: Timestamp indicating when the local port came online
768 * @host_stats: SCSI host statistics
769 * @dev_stats: FCoE device stats (TODO: libfc should not be
770 * FCoE aware)
771 * @retry_count: Number of retries in the current state
7b2787ec 772 * @port_id: FC Port ID
3a3b42bf
RL		 773 * @wwpn: World Wide Port Name
774 * @wwnn: World Wide Node Name
775 * @service_params: Common service parameters
776 * @e_d_tov: Error detection timeout value
777 * @r_a_tov: Resouce allocation timeout value
778 * @rnid_gen: RNID information
779 * @sg_supp: Indicates if scatter gather is supported
780 * @seq_offload: Indicates if sequence offload is supported
781 * @crc_offload: Indicates if CRC offload is supported
782 * @lro_enabled: Indicates if large receive offload is supported
783 * @does_npiv: Supports multiple vports
784 * @npiv_enabled: Switch/fabric allows NPIV
785 * @mfs: The maximum Fibre Channel payload size
786 * @max_retry_count: The maximum retry attempts
787 * @max_rport_retry_count: The maximum remote port retry attempts
f90377ab 788 * @rport_priv_size: Size needed by driver after struct fc_rport_priv
3a3b42bf
RL		 789 * @lro_xid: The maximum XID for LRO
790 * @lso_max: The maximum large offload send size
791 * @fcts: FC-4 type mask
792 * @lp_mutex: Mutex to protect the local port
793 * @list: Handle for list of local ports
794 * @retry_work: Handle to local port for delayed retry context
795 */
42e9a92f 796struct fc_lport {
42e9a92f 797 /* Associations */
3a3b42bf
RL		 798 struct Scsi_Host *host;
799 struct list_head ema_list;
800 struct fc_rport_priv *dns_rdata;
801 struct fc_rport_priv *ptp_rdata;
802 void *scsi_priv;
803 struct fc_disc disc;
804
805 /* Virtual port information */
806 struct list_head vports;
807 struct fc_vport *vport;
42e9a92f
RL		 808
809 /* Operational Information */
810 struct libfc_function_template tt;
3a3b42bf
RL		 811 u8 link_up;
812 u8 qfull;
813 enum fc_lport_state state;
814 unsigned long boot_time;
815 struct fc_host_statistics host_stats;
816 struct fcoe_dev_stats *dev_stats;
817 u8 retry_count;
818
819 /* Fabric information */
7b2787ec 820 u32 port_id;
3a3b42bf
RL		 821 u64 wwpn;
822 u64 wwnn;
823 unsigned int service_params;
824 unsigned int e_d_tov;
825 unsigned int r_a_tov;
826 struct fc_els_rnid_gen rnid_gen;
42e9a92f
RL		 827
828 /* Capabilities */
3a3b42bf
RL		 829 u32 sg_supp:1;
830 u32 seq_offload:1;
831 u32 crc_offload:1;
832 u32 lro_enabled:1;
833 u32 does_npiv:1;
834 u32 npiv_enabled:1;
3726f358 835 u32 point_to_multipoint:1;
3a3b42bf
RL		 836 u32 mfs;
837 u8 max_retry_count;
838 u8 max_rport_retry_count;
f90377ab 839 u16 rport_priv_size;
3a3b42bf
RL		 840 u16 link_speed;
841 u16 link_supported_speeds;
842 u16 lro_xid;
843 unsigned int lso_max;
844 struct fc_ns_fts fcts;
42e9a92f
RL		 845
846 /* Miscellaneous */
3a3b42bf
RL		 847 struct mutex lp_mutex;
848 struct list_head list;
849 struct delayed_work retry_work;
42e9a92f
RL		 850};
851
34f42a07 852/*
42e9a92f
RL		 853 * FC_LPORT HELPER FUNCTIONS
854 *****************************/
3a3b42bf
RL		 855
856/**
857 * fc_lport_test_ready() - Determine if a local port is in the READY state
858 * @lport: The local port to test
859 */
860static inline int fc_lport_test_ready(struct fc_lport *lport)
42e9a92f 861{
3a3b42bf 862 return lport->state == LPORT_ST_READY;
42e9a92f
RL		 863}
864
3a3b42bf
RL		 865/**
866 * fc_set_wwnn() - Set the World Wide Node Name of a local port
867 * @lport: The local port whose WWNN is to be set
868 * @wwnn: The new WWNN
869 */
870static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
42e9a92f 871{
3a3b42bf 872 lport->wwnn = wwnn;
42e9a92f
RL		 873}
874
3a3b42bf
RL		 875/**
876 * fc_set_wwpn() - Set the World Wide Port Name of a local port
877 * @lport: The local port whose WWPN is to be set
878 * @wwnn: The new WWPN
879 */
880static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn)
42e9a92f 881{
3a3b42bf 882 lport->wwpn = wwnn;
42e9a92f
RL		 883}
884
3a3b42bf
RL		 885/**
886 * fc_lport_state_enter() - Change a local port's state
887 * @lport: The local port whose state is to change
888 * @state: The new state
889 */
890static inline void fc_lport_state_enter(struct fc_lport *lport,
42e9a92f
RL		 891 enum fc_lport_state state)
892{
3a3b42bf
RL		 893 if (state != lport->state)
894 lport->retry_count = 0;
895 lport->state = state;
42e9a92f
RL		 896}
897
3a3b42bf
RL		 898/**
899 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
900 * @lport: The local port whose statistics are to be initialized
901 */
902static inline int fc_lport_init_stats(struct fc_lport *lport)
582b45bc 903{
3a3b42bf
RL		 904 lport->dev_stats = alloc_percpu(struct fcoe_dev_stats);
905 if (!lport->dev_stats)
582b45bc
RL		 906 return -ENOMEM;
907 return 0;
908}
909
3a3b42bf
RL		 910/**
911 * fc_lport_free_stats() - Free memory for a local port's statistics
912 * @lport: The local port whose statistics are to be freed
913 */
914static inline void fc_lport_free_stats(struct fc_lport *lport)
582b45bc 915{
3a3b42bf 916 free_percpu(lport->dev_stats);
582b45bc
RL		 917}
918
3a3b42bf
RL		 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 */
923static inline void *lport_priv(const struct fc_lport *lport)
a0a25da2 924{
3a3b42bf 925 return (void *)(lport + 1);
a0a25da2
VD		 926}
927
928/**
3a3b42bf
RL		 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
a0a25da2 933 *
86221969 934 * Returns: libfc lport
a0a25da2 935 */
86221969 936static inline struct fc_lport *
a0a25da2
VD		 937libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
938{
86221969
CL		 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);
174e1ebf 948 INIT_LIST_HEAD(&lport->vports);
86221969 949 return lport;
a0a25da2 950}
42e9a92f 951
34f42a07 952/*
3a3b42bf 953 * FC_FCP HELPER FUNCTIONS
42e9a92f 954 *****************************/
3a3b42bf
RL		 955static 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}
42e9a92f
RL		 961
962/*
3a3b42bf
RL		 963 * LOCAL PORT LAYER
964 *****************************/
965int fc_lport_init(struct fc_lport *);
966int fc_lport_destroy(struct fc_lport *);
967int fc_fabric_logoff(struct fc_lport *);
968int fc_fabric_login(struct fc_lport *);
8faecddb 969void __fc_linkup(struct fc_lport *);
42e9a92f 970void fc_linkup(struct fc_lport *);
8faecddb 971void __fc_linkdown(struct fc_lport *);
42e9a92f 972void fc_linkdown(struct fc_lport *);
3a3b42bf
RL		 973void fc_vport_setlink(struct fc_lport *);
974void fc_vports_linkchange(struct fc_lport *);
42e9a92f 975int fc_lport_config(struct fc_lport *);
42e9a92f 976int fc_lport_reset(struct fc_lport *);
3a3b42bf
RL		 977int fc_set_mfs(struct fc_lport *, u32 mfs);
978struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
979struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
980int fc_lport_bsg_request(struct fc_bsg_job *);
3726f358 981void fc_lport_set_local_id(struct fc_lport *, u32 port_id);
a51ab396 982
34f42a07 983/*
42e9a92f
RL		 984 * REMOTE PORT LAYER
985 *****************************/
3a3b42bf
RL		 986int fc_rport_init(struct fc_lport *);
987void fc_rport_terminate_io(struct fc_rport *);
42e9a92f 988
34f42a07 989/*
42e9a92f
RL		 990 * DISCOVERY LAYER
991 *****************************/
3a3b42bf 992int fc_disc_init(struct fc_lport *);
42e9a92f 993
0685230c
JE		 994static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
995{
996 return container_of(disc, struct fc_lport, disc);
997}
998
34f42a07 999/*
3a3b42bf 1000 * FCP LAYER
42e9a92f 1001 *****************************/
42e9a92f 1002int fc_fcp_init(struct fc_lport *);
3a3b42bf 1003void fc_fcp_destroy(struct fc_lport *);
42e9a92f
RL		 1004
1005/*
3a3b42bf
RL		 1006 * SCSI INTERACTION LAYER
1007 *****************************/
1008int fc_queuecommand(struct scsi_cmnd *,
42e9a92f 1009 void (*done)(struct scsi_cmnd *));
3a3b42bf
RL		 1010int fc_eh_abort(struct scsi_cmnd *);
1011int fc_eh_device_reset(struct scsi_cmnd *);
1012int fc_eh_host_reset(struct scsi_cmnd *);
1013int fc_slave_alloc(struct scsi_device *);
1014int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason);
1015int fc_change_queue_type(struct scsi_device *, int tag_type);
42e9a92f 1016
34f42a07 1017/*
42e9a92f
RL		 1018 * ELS/CT interface
1019 *****************************/
3a3b42bf
RL		 1020int fc_elsct_init(struct fc_lport *);
1021struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
1022 struct fc_frame *,
11b56188
CL		 1023 unsigned int op,
1024 void (*resp)(struct fc_seq *,
3a3b42bf 1025 struct fc_frame *,
11b56188
CL		 1026 void *arg),
1027 void *arg, u32 timer_msec);
1028void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
1029void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
24f089e2
JE		 1030void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *,
1031 enum fc_rctl, u32 parm_offset);
1032void fc_fill_hdr(struct fc_frame *, const struct fc_frame *,
1033 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset);
42e9a92f
RL		 1034
1035
34f42a07 1036/*
42e9a92f
RL		 1037 * EXCHANGE MANAGER LAYER
1038 *****************************/
3a3b42bf
RL		 1039int fc_exch_init(struct fc_lport *);
1040struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
1041 struct fc_exch_mgr *,
96316099 1042 bool (*match)(struct fc_frame *));
3a3b42bf 1043void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
174e1ebf 1044int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
3a3b42bf
RL		 1045struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
1046 u16 min_xid, u16 max_xid,
52ff878c 1047 bool (*match)(struct fc_frame *));
3a3b42bf
RL		 1048void fc_exch_mgr_free(struct fc_lport *);
1049void fc_exch_recv(struct fc_lport *, struct fc_frame *);
1f6ff364 1050void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
42e9a92f
RL		 1051
1052/*
1053 * Functions for fc_functions_template
1054 */
3a3b42bf 1055void fc_get_host_speed(struct Scsi_Host *);
3a3b42bf
RL		 1056void fc_get_host_port_state(struct Scsi_Host *);
1057void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
42e9a92f
RL		 1058struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1059
42e9a92f 1060#endif /* _LIBFC_H_ */
Linux kernel - Deliverables
This page took 0.266005 seconds and 5 git commands to generate.