blob: 3d22dfd6720945bcd0ca1cb133d98a83d6218311 [file] [log] [blame]
Robert Love42e9a922008-12-09 15:10:17 -08001/*
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>
Robert Love582b45b2009-03-31 15:51:50 -070025#include <linux/percpu.h>
Robert Love42e9a922008-12-09 15:10:17 -080026
27#include <scsi/scsi_transport.h>
28#include <scsi/scsi_transport_fc.h>
29
30#include <scsi/fc/fc_fcp.h>
31#include <scsi/fc/fc_ns.h>
32#include <scsi/fc/fc_els.h>
33#include <scsi/fc/fc_gs.h>
34
35#include <scsi/fc_frame.h>
36
Robert Love42e9a922008-12-09 15:10:17 -080037/*
38 * libfc error codes
39 */
40#define FC_NO_ERR 0 /* no error */
41#define FC_EX_TIMEOUT 1 /* Exchange timeout */
42#define FC_EX_CLOSED 2 /* Exchange closed */
43
44/* some helpful macros */
45
46#define ntohll(x) be64_to_cpu(x)
47#define htonll(x) cpu_to_be64(x)
48
49#define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
50
51#define hton24(p, v) do { \
52 p[0] = (((v) >> 16) & 0xFF); \
53 p[1] = (((v) >> 8) & 0xFF); \
54 p[2] = ((v) & 0xFF); \
55 } while (0)
56
57/*
58 * FC HBA status
59 */
Robert Love42e9a922008-12-09 15:10:17 -080060enum fc_lport_state {
Joe Eykholtb1d9fd52009-07-29 17:04:22 -070061 LPORT_ST_DISABLED = 0,
Robert Love42e9a922008-12-09 15:10:17 -080062 LPORT_ST_FLOGI,
63 LPORT_ST_DNS,
Chris Leechc9c7bd72009-11-03 11:46:51 -080064 LPORT_ST_RNN_ID,
Robert Love42e9a922008-12-09 15:10:17 -080065 LPORT_ST_RFT_ID,
66 LPORT_ST_SCR,
67 LPORT_ST_READY,
68 LPORT_ST_LOGO,
69 LPORT_ST_RESET
70};
71
72enum fc_disc_event {
73 DISC_EV_NONE = 0,
74 DISC_EV_SUCCESS,
75 DISC_EV_FAILED
76};
77
78enum fc_rport_state {
Robert Love42e9a922008-12-09 15:10:17 -080079 RPORT_ST_INIT, /* initialized */
80 RPORT_ST_PLOGI, /* waiting for PLOGI completion */
81 RPORT_ST_PRLI, /* waiting for PRLI completion */
82 RPORT_ST_RTV, /* waiting for RTV completion */
83 RPORT_ST_READY, /* ready for use */
84 RPORT_ST_LOGO, /* port logout sent */
Joe Eykholt370c3bd2009-08-25 14:03:47 -070085 RPORT_ST_ADISC, /* Discover Address sent */
Joe Eykholt14194052009-07-29 17:04:43 -070086 RPORT_ST_DELETE, /* port being deleted */
Joe Eykholtb4a9c7e2009-10-21 16:28:30 -070087 RPORT_ST_RESTART, /* remote port being deleted and will restart */
Robert Love42e9a922008-12-09 15:10:17 -080088};
89
Robert Love42e9a922008-12-09 15:10:17 -080090/**
91 * struct fc_disc_port - temporary discovery port to hold rport identifiers
Robert Love9737e6a2009-08-25 14:02:59 -070092 * @lp: Fibre Channel host port instance
93 * @peers: Node for list management during discovery and RSCN processing
94 * @rport_work: Work struct for starting the rport state machine
95 * @port_id: Port ID of the discovered port
Robert Love42e9a922008-12-09 15:10:17 -080096 */
97struct fc_disc_port {
98 struct fc_lport *lp;
99 struct list_head peers;
Robert Love42e9a922008-12-09 15:10:17 -0800100 struct work_struct rport_work;
Robert Love9737e6a2009-08-25 14:02:59 -0700101 u32 port_id;
Robert Love42e9a922008-12-09 15:10:17 -0800102};
103
104enum fc_rport_event {
105 RPORT_EV_NONE = 0,
Joe Eykholt4c0f62b2009-08-25 14:01:12 -0700106 RPORT_EV_READY,
Robert Love42e9a922008-12-09 15:10:17 -0800107 RPORT_EV_FAILED,
108 RPORT_EV_STOP,
109 RPORT_EV_LOGO
110};
111
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700112struct fc_rport_priv;
113
Robert Love42e9a922008-12-09 15:10:17 -0800114struct fc_rport_operations {
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700115 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
Robert Love42e9a922008-12-09 15:10:17 -0800116 enum fc_rport_event);
117};
118
119/**
120 * struct fc_rport_libfc_priv - libfc internal information about a remote port
121 * @local_port: Fibre Channel host port instance
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700122 * @rp_state: indicates READY for I/O or DELETE when blocked.
123 * @flags: REC and RETRY supported flags
124 * @e_d_tov: error detect timeout value (in msec)
125 * @r_a_tov: resource allocation timeout value (in msec)
126 */
127struct fc_rport_libfc_priv {
128 struct fc_lport *local_port;
129 enum fc_rport_state rp_state;
130 u16 flags;
131 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
132 #define FC_RP_FLAGS_RETRY (1 << 1)
133 unsigned int e_d_tov;
134 unsigned int r_a_tov;
135};
136
137/**
138 * struct fc_rport_priv - libfc rport and discovery info about a remote port
139 * @local_port: Fibre Channel host port instance
Joe Eykholtf211fa52009-08-25 14:01:01 -0700140 * @rport: transport remote port
141 * @kref: reference counter
Robert Love42e9a922008-12-09 15:10:17 -0800142 * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges
Joe Eykholtf211fa52009-08-25 14:01:01 -0700143 * @ids: remote port identifiers and roles
Robert Love42e9a922008-12-09 15:10:17 -0800144 * @flags: REC and RETRY supported flags
145 * @max_seq: maximum number of concurrent sequences
Joe Eykholt0f6c614982009-08-25 14:02:11 -0700146 * @disc_id: discovery identifier
Joe Eykholtf211fa52009-08-25 14:01:01 -0700147 * @maxframe_size: maximum frame size
Robert Love42e9a922008-12-09 15:10:17 -0800148 * @retries: retry count in current state
149 * @e_d_tov: error detect timeout value (in msec)
150 * @r_a_tov: resource allocation timeout value (in msec)
151 * @rp_mutex: mutex protects rport
152 * @retry_work:
153 * @event_callback: Callback for rport READY, FAILED or LOGO
154 */
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700155struct fc_rport_priv {
Robert Love42e9a922008-12-09 15:10:17 -0800156 struct fc_lport *local_port;
Joe Eykholtf211fa52009-08-25 14:01:01 -0700157 struct fc_rport *rport;
158 struct kref kref;
Robert Love42e9a922008-12-09 15:10:17 -0800159 enum fc_rport_state rp_state;
Joe Eykholtf211fa52009-08-25 14:01:01 -0700160 struct fc_rport_identifiers ids;
Robert Love42e9a922008-12-09 15:10:17 -0800161 u16 flags;
Robert Love42e9a922008-12-09 15:10:17 -0800162 u16 max_seq;
Joe Eykholt0f6c614982009-08-25 14:02:11 -0700163 u16 disc_id;
Joe Eykholtf211fa52009-08-25 14:01:01 -0700164 u16 maxframe_size;
Robert Love42e9a922008-12-09 15:10:17 -0800165 unsigned int retries;
166 unsigned int e_d_tov;
167 unsigned int r_a_tov;
Robert Love42e9a922008-12-09 15:10:17 -0800168 struct mutex rp_mutex;
169 struct delayed_work retry_work;
170 enum fc_rport_event event;
171 struct fc_rport_operations *ops;
172 struct list_head peers;
173 struct work_struct event_work;
Joe Eykholtf211fa52009-08-25 14:01:01 -0700174 u32 supported_classes;
Robert Love42e9a922008-12-09 15:10:17 -0800175};
176
Robert Love42e9a922008-12-09 15:10:17 -0800177/*
178 * fcoe stats structure
179 */
180struct fcoe_dev_stats {
181 u64 SecondsSinceLastReset;
182 u64 TxFrames;
183 u64 TxWords;
184 u64 RxFrames;
185 u64 RxWords;
186 u64 ErrorFrames;
187 u64 DumpedFrames;
188 u64 LinkFailureCount;
189 u64 LossOfSignalCount;
190 u64 InvalidTxWordCount;
191 u64 InvalidCRCCount;
192 u64 InputRequests;
193 u64 OutputRequests;
194 u64 ControlRequests;
195 u64 InputMegabytes;
196 u64 OutputMegabytes;
197};
198
199/*
200 * els data is used for passing ELS respone specific
201 * data to send ELS response mainly using infomation
202 * in exchange and sequence in EM layer.
203 */
204struct fc_seq_els_data {
205 struct fc_frame *fp;
206 enum fc_els_rjt_reason reason;
207 enum fc_els_rjt_explan explan;
208};
209
210/*
211 * FCP request structure, one for each scsi cmd request
212 */
213struct fc_fcp_pkt {
214 /*
215 * housekeeping stuff
216 */
217 struct fc_lport *lp; /* handle to hba struct */
218 u16 state; /* scsi_pkt state state */
219 u16 tgt_flags; /* target flags */
220 atomic_t ref_cnt; /* fcp pkt ref count */
221 spinlock_t scsi_pkt_lock; /* Must be taken before the host lock
222 * if both are held at the same time */
223 /*
224 * SCSI I/O related stuff
225 */
226 struct scsi_cmnd *cmd; /* scsi command pointer. set/clear
227 * under host lock */
228 struct list_head list; /* tracks queued commands. access under
229 * host lock */
230 /*
231 * timeout related stuff
232 */
233 struct timer_list timer; /* command timer */
234 struct completion tm_done;
235 int wait_for_comp;
236 unsigned long start_time; /* start jiffie */
237 unsigned long end_time; /* end jiffie */
238 unsigned long last_pkt_time; /* jiffies of last frame received */
239
240 /*
241 * scsi cmd and data transfer information
242 */
243 u32 data_len;
244 /*
245 * transport related veriables
246 */
247 struct fcp_cmnd cdb_cmd;
248 size_t xfer_len;
Yi Zoub277d2a2009-02-27 14:07:21 -0800249 u16 xfer_ddp; /* this xfer is ddped */
Robert Love42e9a922008-12-09 15:10:17 -0800250 u32 xfer_contig_end; /* offset of end of contiguous xfer */
251 u16 max_payload; /* max payload size in bytes */
252
253 /*
254 * scsi/fcp return status
255 */
256 u32 io_status; /* SCSI result upper 24 bits */
257 u8 cdb_status;
258 u8 status_code; /* FCP I/O status */
259 /* bit 3 Underrun bit 2: overrun */
260 u8 scsi_comp_flags;
261 u32 req_flags; /* bit 0: read bit:1 write */
262 u32 scsi_resid; /* residule length */
263
264 struct fc_rport *rport; /* remote port pointer */
265 struct fc_seq *seq_ptr; /* current sequence pointer */
266 /*
267 * Error Processing
268 */
269 u8 recov_retry; /* count of recovery retries */
270 struct fc_seq *recov_seq; /* sequence for REC or SRR */
271};
Yi Zoub277d2a2009-02-27 14:07:21 -0800272/*
273 * FC_FCP HELPER FUNCTIONS
274 *****************************/
275static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
276{
277 if (fsp && fsp->cmd)
278 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
279 return false;
280}
Robert Love42e9a922008-12-09 15:10:17 -0800281
282/*
283 * Structure and function definitions for managing Fibre Channel Exchanges
284 * and Sequences
285 *
286 * fc_exch holds state for one exchange and links to its active sequence.
287 *
288 * fc_seq holds the state for an individual sequence.
289 */
290
291struct fc_exch_mgr;
Vasu Dev96316092009-07-29 17:05:00 -0700292struct fc_exch_mgr_anchor;
Vasu Deve4bc50b2009-08-25 13:58:47 -0700293extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
Robert Love42e9a922008-12-09 15:10:17 -0800294
295/*
296 * Sequence.
297 */
298struct fc_seq {
299 u8 id; /* seq ID */
300 u16 ssb_stat; /* status flags for sequence status block */
301 u16 cnt; /* frames sent so far on sequence */
302 u32 rec_data; /* FC-4 value for REC */
303};
304
305#define FC_EX_DONE (1 << 0) /* ep is completed */
306#define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
307
308/*
309 * Exchange.
310 *
311 * Locking notes: The ex_lock protects following items:
312 * state, esb_stat, f_ctl, seq.ssb_stat
313 * seq_id
314 * sequence allocation
315 */
316struct fc_exch {
317 struct fc_exch_mgr *em; /* exchange manager */
Vasu Devb2f00912009-08-25 13:58:53 -0700318 struct fc_exch_pool *pool; /* per cpu exches pool */
Robert Love42e9a922008-12-09 15:10:17 -0800319 u32 state; /* internal driver state */
320 u16 xid; /* our exchange ID */
321 struct list_head ex_list; /* free or busy list linkage */
322 spinlock_t ex_lock; /* lock covering exchange state */
323 atomic_t ex_refcnt; /* reference counter */
324 struct delayed_work timeout_work; /* timer for upper level protocols */
325 struct fc_lport *lp; /* fc device instance */
326 u16 oxid; /* originator's exchange ID */
327 u16 rxid; /* responder's exchange ID */
328 u32 oid; /* originator's FCID */
329 u32 sid; /* source FCID */
330 u32 did; /* destination FCID */
331 u32 esb_stat; /* exchange status for ESB */
332 u32 r_a_tov; /* r_a_tov from rport (msec) */
333 u8 seq_id; /* next sequence ID to use */
334 u32 f_ctl; /* F_CTL flags for sequences */
335 u8 fh_type; /* frame type */
336 enum fc_class class; /* class of service */
337 struct fc_seq seq; /* single sequence */
338 /*
339 * Handler for responses to this current exchange.
340 */
341 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
342 void (*destructor)(struct fc_seq *, void *);
343 /*
344 * arg is passed as void pointer to exchange
345 * resp and destructor handlers
346 */
347 void *arg;
348};
349#define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
350
351struct libfc_function_template {
352
Robert Love42e9a922008-12-09 15:10:17 -0800353 /*
354 * Interface to send a FC frame
Robert Love0ae4d4a2009-02-27 10:55:39 -0800355 *
356 * STATUS: REQUIRED
Robert Love42e9a922008-12-09 15:10:17 -0800357 */
358 int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp);
359
Robert Love42e9a922008-12-09 15:10:17 -0800360 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800361 * Interface to send ELS/CT frames
362 *
363 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800364 */
365 struct fc_seq *(*elsct_send)(struct fc_lport *lport,
Joe Eykholta46f3272009-08-25 14:00:55 -0700366 u32 did,
Robert Love42e9a922008-12-09 15:10:17 -0800367 struct fc_frame *fp,
368 unsigned int op,
369 void (*resp)(struct fc_seq *,
370 struct fc_frame *fp,
371 void *arg),
372 void *arg, u32 timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800373
374 /*
375 * Send the FC frame payload using a new exchange and sequence.
376 *
377 * The frame pointer with some of the header's fields must be
378 * filled before calling exch_seq_send(), those fields are,
379 *
380 * - routing control
381 * - FC port did
382 * - FC port sid
383 * - FC header type
384 * - frame control
385 * - parameter or relative offset
386 *
387 * The exchange response handler is set in this routine to resp()
388 * function pointer. It can be called in two scenarios: if a timeout
389 * occurs or if a response frame is received for the exchange. The
390 * fc_frame pointer in response handler will also indicate timeout
391 * as error using IS_ERR related macros.
392 *
393 * The exchange destructor handler is also set in this routine.
394 * The destructor handler is invoked by EM layer when exchange
395 * is about to free, this can be used by caller to free its
396 * resources along with exchange free.
397 *
398 * The arg is passed back to resp and destructor handler.
399 *
400 * The timeout value (in msec) for an exchange is set if non zero
401 * timer_msec argument is specified. The timer is canceled when
402 * it fires or when the exchange is done. The exchange timeout handler
403 * is registered by EM layer.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800404 *
405 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800406 */
407 struct fc_seq *(*exch_seq_send)(struct fc_lport *lp,
408 struct fc_frame *fp,
409 void (*resp)(struct fc_seq *sp,
410 struct fc_frame *fp,
411 void *arg),
412 void (*destructor)(struct fc_seq *sp,
413 void *arg),
414 void *arg, unsigned int timer_msec);
415
416 /*
Yi Zoub277d2a2009-02-27 14:07:21 -0800417 * Sets up the DDP context for a given exchange id on the given
418 * scatterlist if LLD supports DDP for large receive.
419 *
420 * STATUS: OPTIONAL
421 */
422 int (*ddp_setup)(struct fc_lport *lp, u16 xid,
423 struct scatterlist *sgl, unsigned int sgc);
424 /*
425 * Completes the DDP transfer and returns the length of data DDPed
426 * for the given exchange id.
427 *
428 * STATUS: OPTIONAL
429 */
430 int (*ddp_done)(struct fc_lport *lp, u16 xid);
431 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800432 * Send a frame using an existing sequence and exchange.
433 *
434 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800435 */
436 int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp,
437 struct fc_frame *fp);
438
439 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800440 * Send an ELS response using infomation from a previous
441 * exchange and sequence.
442 *
443 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800444 */
445 void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd,
446 struct fc_seq_els_data *els_data);
447
448 /*
449 * Abort an exchange and sequence. Generally called because of a
450 * exchange timeout or an abort from the upper layer.
451 *
452 * A timer_msec can be specified for abort timeout, if non-zero
453 * timer_msec value is specified then exchange resp handler
454 * will be called with timeout error if no response to abort.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800455 *
456 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800457 */
458 int (*seq_exch_abort)(const struct fc_seq *req_sp,
459 unsigned int timer_msec);
460
461 /*
462 * Indicate that an exchange/sequence tuple is complete and the memory
463 * allocated for the related objects may be freed.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800464 *
465 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800466 */
467 void (*exch_done)(struct fc_seq *sp);
468
469 /*
Robert Love42e9a922008-12-09 15:10:17 -0800470 * Start a new sequence on the same exchange/sequence tuple.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800471 *
472 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800473 */
474 struct fc_seq *(*seq_start_next)(struct fc_seq *sp);
475
476 /*
477 * Reset an exchange manager, completing all sequences and exchanges.
478 * If s_id is non-zero, reset only exchanges originating from that FID.
479 * If d_id is non-zero, reset only exchanges sending to that FID.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800480 *
481 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800482 */
Abhijeet Joglekar1f6ff362009-02-27 10:54:35 -0800483 void (*exch_mgr_reset)(struct fc_lport *,
Robert Love42e9a922008-12-09 15:10:17 -0800484 u32 s_id, u32 d_id);
485
Robert Love0ae4d4a2009-02-27 10:55:39 -0800486 /*
487 * Flush the rport work queue. Generally used before shutdown.
488 *
489 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800490 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800491 void (*rport_flush_queue)(void);
Robert Love42e9a922008-12-09 15:10:17 -0800492
493 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800494 * Receive a frame for a local port.
495 *
496 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800497 */
498 void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp,
499 struct fc_frame *fp);
500
Robert Love0ae4d4a2009-02-27 10:55:39 -0800501 /*
502 * Reset the local port.
503 *
504 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800505 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800506 int (*lport_reset)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800507
508 /*
Robert Love9737e6a2009-08-25 14:02:59 -0700509 * Create a remote port with a given port ID
510 *
511 * STATUS: OPTIONAL
Robert Love5101ff92009-02-27 10:55:18 -0800512 */
Robert Love9737e6a2009-08-25 14:02:59 -0700513 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
Robert Love5101ff92009-02-27 10:55:18 -0800514
515 /*
Robert Love42e9a922008-12-09 15:10:17 -0800516 * Initiates the RP state machine. It is called from the LP module.
517 * This function will issue the following commands to the N_Port
518 * identified by the FC ID provided.
519 *
520 * - PLOGI
521 * - PRLI
522 * - RTV
Robert Love0ae4d4a2009-02-27 10:55:39 -0800523 *
524 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800525 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700526 int (*rport_login)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800527
528 /*
529 * Logoff, and remove the rport from the transport if
530 * it had been added. This will send a LOGO to the target.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800531 *
532 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800533 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700534 int (*rport_logoff)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800535
536 /*
537 * Recieve a request from a remote port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800538 *
539 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800540 */
541 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
Joe Eykholt131203a2009-08-25 14:03:10 -0700542 struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800543
Robert Love0ae4d4a2009-02-27 10:55:39 -0800544 /*
545 * lookup an rport by it's port ID.
546 *
547 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800548 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700549 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
Robert Love42e9a922008-12-09 15:10:17 -0800550
551 /*
Joe Eykholtf211fa52009-08-25 14:01:01 -0700552 * Destroy an rport after final kref_put().
553 * The argument is a pointer to the kref inside the fc_rport_priv.
554 */
555 void (*rport_destroy)(struct kref *);
556
557 /*
Robert Love42e9a922008-12-09 15:10:17 -0800558 * Send a fcp cmd from fsp pkt.
559 * Called with the SCSI host lock unlocked and irqs disabled.
560 *
561 * The resp handler is called when FCP_RSP received.
562 *
Robert Love0ae4d4a2009-02-27 10:55:39 -0800563 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800564 */
565 int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp,
566 void (*resp)(struct fc_seq *, struct fc_frame *fp,
567 void *arg));
568
569 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800570 * Cleanup the FCP layer, used durring link down and reset
571 *
572 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800573 */
574 void (*fcp_cleanup)(struct fc_lport *lp);
575
576 /*
577 * Abort all I/O on a local port
Robert Love0ae4d4a2009-02-27 10:55:39 -0800578 *
579 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800580 */
581 void (*fcp_abort_io)(struct fc_lport *lp);
582
Robert Love0ae4d4a2009-02-27 10:55:39 -0800583 /*
584 * Receive a request for the discovery layer.
585 *
586 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800587 */
Robert Love42e9a922008-12-09 15:10:17 -0800588 void (*disc_recv_req)(struct fc_seq *,
589 struct fc_frame *, struct fc_lport *);
590
591 /*
592 * Start discovery for a local port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800593 *
594 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800595 */
596 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
597 enum fc_disc_event),
598 struct fc_lport *);
599
600 /*
601 * Stop discovery for a given lport. This will remove
602 * all discovered rports
Robert Love0ae4d4a2009-02-27 10:55:39 -0800603 *
604 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800605 */
606 void (*disc_stop) (struct fc_lport *);
607
608 /*
609 * Stop discovery for a given lport. This will block
610 * until all discovered rports are deleted from the
611 * FC transport class
Robert Love0ae4d4a2009-02-27 10:55:39 -0800612 *
613 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800614 */
615 void (*disc_stop_final) (struct fc_lport *);
616};
617
618/* information used by the discovery layer */
619struct fc_disc {
620 unsigned char retry_count;
Robert Love42e9a922008-12-09 15:10:17 -0800621 unsigned char pending;
622 unsigned char requested;
623 unsigned short seq_count;
624 unsigned char buf_len;
Joe Eykholt0f6c614982009-08-25 14:02:11 -0700625 u16 disc_id;
Robert Love42e9a922008-12-09 15:10:17 -0800626
627 void (*disc_callback)(struct fc_lport *,
628 enum fc_disc_event);
629
630 struct list_head rports;
631 struct fc_lport *lport;
632 struct mutex disc_mutex;
633 struct fc_gpn_ft_resp partial_buf; /* partial name buffer */
634 struct delayed_work disc_work;
635};
636
637struct fc_lport {
638 struct list_head list;
639
640 /* Associations */
641 struct Scsi_Host *host;
Vasu Dev96316092009-07-29 17:05:00 -0700642 struct list_head ema_list;
Chris Leech174e1eb2009-11-03 11:46:14 -0800643 struct list_head vports; /* child vports if N_Port */
644 struct fc_vport *vport; /* parent vport if VN_Port */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700645 struct fc_rport_priv *dns_rp;
646 struct fc_rport_priv *ptp_rp;
Robert Love42e9a922008-12-09 15:10:17 -0800647 void *scsi_priv;
648 struct fc_disc disc;
649
650 /* Operational Information */
651 struct libfc_function_template tt;
Vasu Devbc0e17f2009-02-27 10:54:57 -0800652 u8 link_up;
653 u8 qfull;
Robert Love42e9a922008-12-09 15:10:17 -0800654 enum fc_lport_state state;
655 unsigned long boot_time;
656
657 struct fc_host_statistics host_stats;
Robert Love582b45b2009-03-31 15:51:50 -0700658 struct fcoe_dev_stats *dev_stats;
659
Robert Love42e9a922008-12-09 15:10:17 -0800660 u64 wwpn;
661 u64 wwnn;
662 u8 retry_count;
663
664 /* Capabilities */
665 u32 sg_supp:1; /* scatter gather supported */
666 u32 seq_offload:1; /* seq offload supported */
667 u32 crc_offload:1; /* crc offload supported */
668 u32 lro_enabled:1; /* large receive offload */
Chris Leech174e1eb2009-11-03 11:46:14 -0800669 u32 does_npiv:1; /* supports multiple vports */
670 u32 npiv_enabled:1; /* switch/fabric allows NPIV */
Robert Love42e9a922008-12-09 15:10:17 -0800671 u32 mfs; /* max FC payload size */
672 unsigned int service_params;
673 unsigned int e_d_tov;
674 unsigned int r_a_tov;
675 u8 max_retry_count;
Abhijeet Joglekara3666952009-05-01 10:01:26 -0700676 u8 max_rport_retry_count;
Robert Love42e9a922008-12-09 15:10:17 -0800677 u16 link_speed;
678 u16 link_supported_speeds;
679 u16 lro_xid; /* max xid for fcoe lro */
Yi Zouea1e9a92009-02-27 14:07:04 -0800680 unsigned int lso_max; /* max large send size */
Robert Love42e9a922008-12-09 15:10:17 -0800681 struct fc_ns_fts fcts; /* FC-4 type masks */
682 struct fc_els_rnid_gen rnid_gen; /* RNID information */
683
684 /* Semaphores */
685 struct mutex lp_mutex;
686
687 /* Miscellaneous */
688 struct delayed_work retry_work;
Robert Love42e9a922008-12-09 15:10:17 -0800689};
690
Robert Love34f42a02009-02-27 10:55:45 -0800691/*
Robert Love42e9a922008-12-09 15:10:17 -0800692 * FC_LPORT HELPER FUNCTIONS
693 *****************************/
Robert Love42e9a922008-12-09 15:10:17 -0800694static inline int fc_lport_test_ready(struct fc_lport *lp)
695{
696 return lp->state == LPORT_ST_READY;
697}
698
699static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn)
700{
701 lp->wwnn = wwnn;
702}
703
704static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn)
705{
706 lp->wwpn = wwnn;
707}
708
709static inline void fc_lport_state_enter(struct fc_lport *lp,
710 enum fc_lport_state state)
711{
712 if (state != lp->state)
713 lp->retry_count = 0;
714 lp->state = state;
715}
716
Robert Love582b45b2009-03-31 15:51:50 -0700717static inline int fc_lport_init_stats(struct fc_lport *lp)
718{
719 /* allocate per cpu stats block */
720 lp->dev_stats = alloc_percpu(struct fcoe_dev_stats);
721 if (!lp->dev_stats)
722 return -ENOMEM;
723 return 0;
724}
725
726static inline void fc_lport_free_stats(struct fc_lport *lp)
727{
728 free_percpu(lp->dev_stats);
729}
730
731static inline struct fcoe_dev_stats *fc_lport_get_stats(struct fc_lport *lp)
732{
733 return per_cpu_ptr(lp->dev_stats, smp_processor_id());
734}
735
Vasu Deva0a25da2009-03-17 11:42:29 -0700736static inline void *lport_priv(const struct fc_lport *lp)
737{
738 return (void *)(lp + 1);
739}
740
741/**
742 * libfc_host_alloc() - Allocate a Scsi_Host with room for the fc_lport
743 * @sht: ptr to the scsi host templ
744 * @priv_size: size of private data after fc_lport
745 *
Chris Leech86221962009-11-03 11:46:08 -0800746 * Returns: libfc lport
Vasu Deva0a25da2009-03-17 11:42:29 -0700747 */
Chris Leech86221962009-11-03 11:46:08 -0800748static inline struct fc_lport *
Vasu Deva0a25da2009-03-17 11:42:29 -0700749libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
750{
Chris Leech86221962009-11-03 11:46:08 -0800751 struct fc_lport *lport;
752 struct Scsi_Host *shost;
753
754 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
755 if (!shost)
756 return NULL;
757 lport = shost_priv(shost);
758 lport->host = shost;
759 INIT_LIST_HEAD(&lport->ema_list);
Chris Leech174e1eb2009-11-03 11:46:14 -0800760 INIT_LIST_HEAD(&lport->vports);
Chris Leech86221962009-11-03 11:46:08 -0800761 return lport;
Vasu Deva0a25da2009-03-17 11:42:29 -0700762}
Robert Love42e9a922008-12-09 15:10:17 -0800763
Robert Love34f42a02009-02-27 10:55:45 -0800764/*
Robert Love42e9a922008-12-09 15:10:17 -0800765 * LOCAL PORT LAYER
766 *****************************/
767int fc_lport_init(struct fc_lport *lp);
768
769/*
770 * Destroy the specified local port by finding and freeing all
771 * fc_rports associated with it and then by freeing the fc_lport
772 * itself.
773 */
774int fc_lport_destroy(struct fc_lport *lp);
775
776/*
777 * Logout the specified local port from the fabric
778 */
779int fc_fabric_logoff(struct fc_lport *lp);
780
781/*
782 * Initiate the LP state machine. This handler will use fc_host_attr
783 * to store the FLOGI service parameters, so fc_host_attr must be
784 * initialized before calling this handler.
785 */
786int fc_fabric_login(struct fc_lport *lp);
787
788/*
789 * The link is up for the given local port.
790 */
Chris Leech8faecdd2009-11-03 11:46:19 -0800791void __fc_linkup(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800792void fc_linkup(struct fc_lport *);
793
794/*
795 * Link is down for the given local port.
796 */
Chris Leech8faecdd2009-11-03 11:46:19 -0800797void __fc_linkdown(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800798void fc_linkdown(struct fc_lport *);
799
800/*
Robert Love42e9a922008-12-09 15:10:17 -0800801 * Configure the local port.
802 */
803int fc_lport_config(struct fc_lport *);
804
805/*
806 * Reset the local port.
807 */
808int fc_lport_reset(struct fc_lport *);
809
810/*
811 * Set the mfs or reset
812 */
813int fc_set_mfs(struct fc_lport *lp, u32 mfs);
814
Chris Leech174e1eb2009-11-03 11:46:14 -0800815/*
816 * Allocate a new lport struct for an NPIV VN_Port
817 */
818struct fc_lport *libfc_vport_create(struct fc_vport *vport, int privsize);
819
820/*
821 * Find an NPIV VN_Port by port ID
822 */
823struct fc_lport *fc_vport_id_lookup(struct fc_lport *n_port, u32 port_id);
Robert Love42e9a922008-12-09 15:10:17 -0800824
Robert Love34f42a02009-02-27 10:55:45 -0800825/*
Chris Leech8faecdd2009-11-03 11:46:19 -0800826 * NPIV VN_Port link state management
827 */
828void fc_vport_setlink(struct fc_lport *vn_port);
829void fc_vports_linkchange(struct fc_lport *n_port);
830
831/*
Robert Love42e9a922008-12-09 15:10:17 -0800832 * REMOTE PORT LAYER
833 *****************************/
834int fc_rport_init(struct fc_lport *lp);
835void fc_rport_terminate_io(struct fc_rport *rp);
836
Robert Love34f42a02009-02-27 10:55:45 -0800837/*
Robert Love42e9a922008-12-09 15:10:17 -0800838 * DISCOVERY LAYER
839 *****************************/
840int fc_disc_init(struct fc_lport *lp);
841
842
Robert Love34f42a02009-02-27 10:55:45 -0800843/*
Robert Love42e9a922008-12-09 15:10:17 -0800844 * SCSI LAYER
845 *****************************/
846/*
847 * Initialize the SCSI block of libfc
848 */
849int fc_fcp_init(struct fc_lport *);
850
851/*
852 * This section provides an API which allows direct interaction
853 * with the SCSI-ml. Each of these functions satisfies a function
854 * pointer defined in Scsi_Host and therefore is always called
855 * directly from the SCSI-ml.
856 */
857int fc_queuecommand(struct scsi_cmnd *sc_cmd,
858 void (*done)(struct scsi_cmnd *));
859
860/*
Robert Love42e9a922008-12-09 15:10:17 -0800861 * Send an ABTS frame to the target device. The sc_cmd argument
862 * is a pointer to the SCSI command to be aborted.
863 */
864int fc_eh_abort(struct scsi_cmnd *sc_cmd);
865
866/*
867 * Reset a LUN by sending send the tm cmd to the target.
868 */
869int fc_eh_device_reset(struct scsi_cmnd *sc_cmd);
870
871/*
872 * Reset the host adapter.
873 */
874int fc_eh_host_reset(struct scsi_cmnd *sc_cmd);
875
876/*
877 * Check rport status.
878 */
879int fc_slave_alloc(struct scsi_device *sdev);
880
881/*
882 * Adjust the queue depth.
883 */
Mike Christiee881a172009-10-15 17:46:39 -0700884int fc_change_queue_depth(struct scsi_device *sdev, int qdepth, int reason);
Robert Love42e9a922008-12-09 15:10:17 -0800885
886/*
887 * Change the tag type.
888 */
889int fc_change_queue_type(struct scsi_device *sdev, int tag_type);
890
891/*
892 * Free memory pools used by the FCP layer.
893 */
894void fc_fcp_destroy(struct fc_lport *);
895
Robert Love34f42a02009-02-27 10:55:45 -0800896/*
Robert Love42e9a922008-12-09 15:10:17 -0800897 * ELS/CT interface
898 *****************************/
899/*
900 * Initializes ELS/CT interface
901 */
902int fc_elsct_init(struct fc_lport *lp);
Chris Leech11b56182009-11-03 11:46:29 -0800903struct fc_seq *fc_elsct_send(struct fc_lport *lport,
904 u32 did,
905 struct fc_frame *fp,
906 unsigned int op,
907 void (*resp)(struct fc_seq *,
908 struct fc_frame *fp,
909 void *arg),
910 void *arg, u32 timer_msec);
911void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
912void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
Robert Love42e9a922008-12-09 15:10:17 -0800913
914
Robert Love34f42a02009-02-27 10:55:45 -0800915/*
Robert Love42e9a922008-12-09 15:10:17 -0800916 * EXCHANGE MANAGER LAYER
917 *****************************/
918/*
919 * Initializes Exchange Manager related
920 * function pointers in struct libfc_function_template.
921 */
922int fc_exch_init(struct fc_lport *lp);
923
924/*
Vasu Dev96316092009-07-29 17:05:00 -0700925 * Adds Exchange Manager (EM) mp to lport.
926 *
927 * Adds specified mp to lport using struct fc_exch_mgr_anchor,
928 * the struct fc_exch_mgr_anchor allows same EM sharing by
929 * more than one lport with their specified match function,
930 * the match function is used in allocating exchange from
931 * added mp.
932 */
933struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *lport,
934 struct fc_exch_mgr *mp,
935 bool (*match)(struct fc_frame *));
936
937/*
938 * Deletes Exchange Manager (EM) from lport by removing
939 * its anchor ema from lport.
940 *
941 * If removed anchor ema was the last user of its associated EM
942 * then also destroys associated EM.
943 */
944void fc_exch_mgr_del(struct fc_exch_mgr_anchor *ema);
945
946/*
Chris Leech174e1eb2009-11-03 11:46:14 -0800947 * Clone an exchange manager list, getting reference holds for each EM.
948 * This is for use with NPIV and sharing the X_ID space between VN_Ports.
949 */
950int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
951
952/*
Robert Love42e9a922008-12-09 15:10:17 -0800953 * Allocates an Exchange Manager (EM).
954 *
955 * The EM manages exchanges for their allocation and
956 * free, also allows exchange lookup for received
957 * frame.
958 *
959 * The class is used for initializing FC class of
960 * allocated exchange from EM.
961 *
962 * The min_xid and max_xid will limit new
963 * exchange ID (XID) within this range for
964 * a new exchange.
965 * The LLD may choose to have multiple EMs,
966 * e.g. one EM instance per CPU receive thread in LLD.
Robert Love42e9a922008-12-09 15:10:17 -0800967 *
Vasu Dev52ff8782009-07-29 17:05:10 -0700968 * Specified match function is used in allocating exchanges
969 * from newly allocated EM.
Robert Love42e9a922008-12-09 15:10:17 -0800970 */
971struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp,
972 enum fc_class class,
973 u16 min_xid,
Vasu Dev52ff8782009-07-29 17:05:10 -0700974 u16 max_xid,
975 bool (*match)(struct fc_frame *));
Robert Love42e9a922008-12-09 15:10:17 -0800976
977/*
Vasu Dev52ff8782009-07-29 17:05:10 -0700978 * Free all exchange managers of a lport.
Robert Love42e9a922008-12-09 15:10:17 -0800979 */
Vasu Dev52ff8782009-07-29 17:05:10 -0700980void fc_exch_mgr_free(struct fc_lport *lport);
Robert Love42e9a922008-12-09 15:10:17 -0800981
982/*
983 * Receive a frame on specified local port and exchange manager.
984 */
Vasu Dev52ff8782009-07-29 17:05:10 -0700985void fc_exch_recv(struct fc_lport *lp, struct fc_frame *fp);
Robert Love42e9a922008-12-09 15:10:17 -0800986
987/*
Vasu Devb2f00912009-08-25 13:58:53 -0700988 * Reset all EMs of a lport, releasing its all sequences and
989 * exchanges. If sid is non-zero, then reset only exchanges
990 * we sourced from that FID. If did is non-zero, reset only
991 * exchanges destined to that FID.
Robert Love42e9a922008-12-09 15:10:17 -0800992 */
Abhijeet Joglekar1f6ff362009-02-27 10:54:35 -0800993void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -0800994
995/*
996 * Functions for fc_functions_template
997 */
998void fc_get_host_speed(struct Scsi_Host *shost);
999void fc_get_host_port_type(struct Scsi_Host *shost);
1000void fc_get_host_port_state(struct Scsi_Host *shost);
1001void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout);
1002struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1003
Robert Love42e9a922008-12-09 15:10:17 -08001004#endif /* _LIBFC_H_ */