Commit | Line | Data |
---|---|---|
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> | |
25 | ||
26 | #include <scsi/scsi_transport.h> | |
27 | #include <scsi/scsi_transport_fc.h> | |
28 | ||
29 | #include <scsi/fc/fc_fcp.h> | |
30 | #include <scsi/fc/fc_ns.h> | |
31 | #include <scsi/fc/fc_els.h> | |
32 | #include <scsi/fc/fc_gs.h> | |
33 | ||
34 | #include <scsi/fc_frame.h> | |
35 | ||
36 | #define LIBFC_DEBUG | |
37 | ||
38 | #ifdef LIBFC_DEBUG | |
39 | /* Log messages */ | |
40 | #define FC_DBG(fmt, args...) \ | |
41 | do { \ | |
42 | printk(KERN_INFO "%s " fmt, __func__, ##args); \ | |
43 | } while (0) | |
44 | #else | |
45 | #define FC_DBG(fmt, args...) | |
46 | #endif | |
47 | ||
48 | /* | |
49 | * libfc error codes | |
50 | */ | |
51 | #define FC_NO_ERR 0 /* no error */ | |
52 | #define FC_EX_TIMEOUT 1 /* Exchange timeout */ | |
53 | #define FC_EX_CLOSED 2 /* Exchange closed */ | |
54 | ||
55 | /* some helpful macros */ | |
56 | ||
57 | #define ntohll(x) be64_to_cpu(x) | |
58 | #define htonll(x) cpu_to_be64(x) | |
59 | ||
60 | #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) | |
61 | ||
62 | #define hton24(p, v) do { \ | |
63 | p[0] = (((v) >> 16) & 0xFF); \ | |
64 | p[1] = (((v) >> 8) & 0xFF); \ | |
65 | p[2] = ((v) & 0xFF); \ | |
66 | } while (0) | |
67 | ||
68 | /* | |
69 | * FC HBA status | |
70 | */ | |
42e9a92f RL |
71 | enum fc_lport_state { |
72 | LPORT_ST_NONE = 0, | |
73 | LPORT_ST_FLOGI, | |
74 | LPORT_ST_DNS, | |
75 | LPORT_ST_RPN_ID, | |
76 | LPORT_ST_RFT_ID, | |
77 | LPORT_ST_SCR, | |
78 | LPORT_ST_READY, | |
79 | LPORT_ST_LOGO, | |
80 | LPORT_ST_RESET | |
81 | }; | |
82 | ||
83 | enum fc_disc_event { | |
84 | DISC_EV_NONE = 0, | |
85 | DISC_EV_SUCCESS, | |
86 | DISC_EV_FAILED | |
87 | }; | |
88 | ||
89 | enum fc_rport_state { | |
90 | RPORT_ST_NONE = 0, | |
91 | RPORT_ST_INIT, /* initialized */ | |
92 | RPORT_ST_PLOGI, /* waiting for PLOGI completion */ | |
93 | RPORT_ST_PRLI, /* waiting for PRLI completion */ | |
94 | RPORT_ST_RTV, /* waiting for RTV completion */ | |
95 | RPORT_ST_READY, /* ready for use */ | |
96 | RPORT_ST_LOGO, /* port logout sent */ | |
97 | }; | |
98 | ||
99 | enum fc_rport_trans_state { | |
100 | FC_PORTSTATE_ROGUE, | |
101 | FC_PORTSTATE_REAL, | |
102 | }; | |
103 | ||
104 | /** | |
105 | * struct fc_disc_port - temporary discovery port to hold rport identifiers | |
106 | * @lp: Fibre Channel host port instance | |
107 | * @peers: node for list management during discovery and RSCN processing | |
108 | * @ids: identifiers structure to pass to fc_remote_port_add() | |
109 | * @rport_work: work struct for starting the rport state machine | |
110 | */ | |
111 | struct fc_disc_port { | |
112 | struct fc_lport *lp; | |
113 | struct list_head peers; | |
114 | struct fc_rport_identifiers ids; | |
115 | struct work_struct rport_work; | |
116 | }; | |
117 | ||
118 | enum fc_rport_event { | |
119 | RPORT_EV_NONE = 0, | |
120 | RPORT_EV_CREATED, | |
121 | RPORT_EV_FAILED, | |
122 | RPORT_EV_STOP, | |
123 | RPORT_EV_LOGO | |
124 | }; | |
125 | ||
126 | struct fc_rport_operations { | |
127 | void (*event_callback)(struct fc_lport *, struct fc_rport *, | |
128 | enum fc_rport_event); | |
129 | }; | |
130 | ||
131 | /** | |
132 | * struct fc_rport_libfc_priv - libfc internal information about a remote port | |
133 | * @local_port: Fibre Channel host port instance | |
134 | * @rp_state: state tracks progress of PLOGI, PRLI, and RTV exchanges | |
135 | * @flags: REC and RETRY supported flags | |
136 | * @max_seq: maximum number of concurrent sequences | |
137 | * @retries: retry count in current state | |
138 | * @e_d_tov: error detect timeout value (in msec) | |
139 | * @r_a_tov: resource allocation timeout value (in msec) | |
140 | * @rp_mutex: mutex protects rport | |
141 | * @retry_work: | |
142 | * @event_callback: Callback for rport READY, FAILED or LOGO | |
143 | */ | |
144 | struct fc_rport_libfc_priv { | |
145 | struct fc_lport *local_port; | |
146 | enum fc_rport_state rp_state; | |
147 | u16 flags; | |
148 | #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0) | |
149 | #define FC_RP_FLAGS_RETRY (1 << 1) | |
150 | u16 max_seq; | |
151 | unsigned int retries; | |
152 | unsigned int e_d_tov; | |
153 | unsigned int r_a_tov; | |
154 | enum fc_rport_trans_state trans_state; | |
155 | struct mutex rp_mutex; | |
156 | struct delayed_work retry_work; | |
157 | enum fc_rport_event event; | |
158 | struct fc_rport_operations *ops; | |
159 | struct list_head peers; | |
160 | struct work_struct event_work; | |
161 | }; | |
162 | ||
163 | #define PRIV_TO_RPORT(x) \ | |
164 | (struct fc_rport *)((void *)x - sizeof(struct fc_rport)); | |
165 | #define RPORT_TO_PRIV(x) \ | |
166 | (struct fc_rport_libfc_priv *)((void *)x + sizeof(struct fc_rport)); | |
167 | ||
168 | struct fc_rport *fc_rport_rogue_create(struct fc_disc_port *); | |
169 | ||
170 | static inline void fc_rport_set_name(struct fc_rport *rport, u64 wwpn, u64 wwnn) | |
171 | { | |
172 | rport->node_name = wwnn; | |
173 | rport->port_name = wwpn; | |
174 | } | |
175 | ||
176 | /* | |
177 | * fcoe stats structure | |
178 | */ | |
179 | struct fcoe_dev_stats { | |
180 | u64 SecondsSinceLastReset; | |
181 | u64 TxFrames; | |
182 | u64 TxWords; | |
183 | u64 RxFrames; | |
184 | u64 RxWords; | |
185 | u64 ErrorFrames; | |
186 | u64 DumpedFrames; | |
187 | u64 LinkFailureCount; | |
188 | u64 LossOfSignalCount; | |
189 | u64 InvalidTxWordCount; | |
190 | u64 InvalidCRCCount; | |
191 | u64 InputRequests; | |
192 | u64 OutputRequests; | |
193 | u64 ControlRequests; | |
194 | u64 InputMegabytes; | |
195 | u64 OutputMegabytes; | |
196 | }; | |
197 | ||
198 | /* | |
199 | * els data is used for passing ELS respone specific | |
200 | * data to send ELS response mainly using infomation | |
201 | * in exchange and sequence in EM layer. | |
202 | */ | |
203 | struct fc_seq_els_data { | |
204 | struct fc_frame *fp; | |
205 | enum fc_els_rjt_reason reason; | |
206 | enum fc_els_rjt_explan explan; | |
207 | }; | |
208 | ||
209 | /* | |
210 | * FCP request structure, one for each scsi cmd request | |
211 | */ | |
212 | struct fc_fcp_pkt { | |
213 | /* | |
214 | * housekeeping stuff | |
215 | */ | |
216 | struct fc_lport *lp; /* handle to hba struct */ | |
217 | u16 state; /* scsi_pkt state state */ | |
218 | u16 tgt_flags; /* target flags */ | |
219 | atomic_t ref_cnt; /* fcp pkt ref count */ | |
220 | spinlock_t scsi_pkt_lock; /* Must be taken before the host lock | |
221 | * if both are held at the same time */ | |
222 | /* | |
223 | * SCSI I/O related stuff | |
224 | */ | |
225 | struct scsi_cmnd *cmd; /* scsi command pointer. set/clear | |
226 | * under host lock */ | |
227 | struct list_head list; /* tracks queued commands. access under | |
228 | * host lock */ | |
229 | /* | |
230 | * timeout related stuff | |
231 | */ | |
232 | struct timer_list timer; /* command timer */ | |
233 | struct completion tm_done; | |
234 | int wait_for_comp; | |
235 | unsigned long start_time; /* start jiffie */ | |
236 | unsigned long end_time; /* end jiffie */ | |
237 | unsigned long last_pkt_time; /* jiffies of last frame received */ | |
238 | ||
239 | /* | |
240 | * scsi cmd and data transfer information | |
241 | */ | |
242 | u32 data_len; | |
243 | /* | |
244 | * transport related veriables | |
245 | */ | |
246 | struct fcp_cmnd cdb_cmd; | |
247 | size_t xfer_len; | |
248 | u32 xfer_contig_end; /* offset of end of contiguous xfer */ | |
249 | u16 max_payload; /* max payload size in bytes */ | |
250 | ||
251 | /* | |
252 | * scsi/fcp return status | |
253 | */ | |
254 | u32 io_status; /* SCSI result upper 24 bits */ | |
255 | u8 cdb_status; | |
256 | u8 status_code; /* FCP I/O status */ | |
257 | /* bit 3 Underrun bit 2: overrun */ | |
258 | u8 scsi_comp_flags; | |
259 | u32 req_flags; /* bit 0: read bit:1 write */ | |
260 | u32 scsi_resid; /* residule length */ | |
261 | ||
262 | struct fc_rport *rport; /* remote port pointer */ | |
263 | struct fc_seq *seq_ptr; /* current sequence pointer */ | |
264 | /* | |
265 | * Error Processing | |
266 | */ | |
267 | u8 recov_retry; /* count of recovery retries */ | |
268 | struct fc_seq *recov_seq; /* sequence for REC or SRR */ | |
269 | }; | |
270 | ||
271 | /* | |
272 | * Structure and function definitions for managing Fibre Channel Exchanges | |
273 | * and Sequences | |
274 | * | |
275 | * fc_exch holds state for one exchange and links to its active sequence. | |
276 | * | |
277 | * fc_seq holds the state for an individual sequence. | |
278 | */ | |
279 | ||
280 | struct fc_exch_mgr; | |
281 | ||
282 | /* | |
283 | * Sequence. | |
284 | */ | |
285 | struct fc_seq { | |
286 | u8 id; /* seq ID */ | |
287 | u16 ssb_stat; /* status flags for sequence status block */ | |
288 | u16 cnt; /* frames sent so far on sequence */ | |
289 | u32 rec_data; /* FC-4 value for REC */ | |
290 | }; | |
291 | ||
292 | #define FC_EX_DONE (1 << 0) /* ep is completed */ | |
293 | #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ | |
294 | ||
295 | /* | |
296 | * Exchange. | |
297 | * | |
298 | * Locking notes: The ex_lock protects following items: | |
299 | * state, esb_stat, f_ctl, seq.ssb_stat | |
300 | * seq_id | |
301 | * sequence allocation | |
302 | */ | |
303 | struct fc_exch { | |
304 | struct fc_exch_mgr *em; /* exchange manager */ | |
305 | u32 state; /* internal driver state */ | |
306 | u16 xid; /* our exchange ID */ | |
307 | struct list_head ex_list; /* free or busy list linkage */ | |
308 | spinlock_t ex_lock; /* lock covering exchange state */ | |
309 | atomic_t ex_refcnt; /* reference counter */ | |
310 | struct delayed_work timeout_work; /* timer for upper level protocols */ | |
311 | struct fc_lport *lp; /* fc device instance */ | |
312 | u16 oxid; /* originator's exchange ID */ | |
313 | u16 rxid; /* responder's exchange ID */ | |
314 | u32 oid; /* originator's FCID */ | |
315 | u32 sid; /* source FCID */ | |
316 | u32 did; /* destination FCID */ | |
317 | u32 esb_stat; /* exchange status for ESB */ | |
318 | u32 r_a_tov; /* r_a_tov from rport (msec) */ | |
319 | u8 seq_id; /* next sequence ID to use */ | |
320 | u32 f_ctl; /* F_CTL flags for sequences */ | |
321 | u8 fh_type; /* frame type */ | |
322 | enum fc_class class; /* class of service */ | |
323 | struct fc_seq seq; /* single sequence */ | |
324 | /* | |
325 | * Handler for responses to this current exchange. | |
326 | */ | |
327 | void (*resp)(struct fc_seq *, struct fc_frame *, void *); | |
328 | void (*destructor)(struct fc_seq *, void *); | |
329 | /* | |
330 | * arg is passed as void pointer to exchange | |
331 | * resp and destructor handlers | |
332 | */ | |
333 | void *arg; | |
334 | }; | |
335 | #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) | |
336 | ||
337 | struct libfc_function_template { | |
338 | ||
42e9a92f RL |
339 | /* |
340 | * Interface to send a FC frame | |
42e9a92f | 341 | * |
0ae4d4ae | 342 | * STATUS: REQUIRED |
42e9a92f | 343 | */ |
0ae4d4ae | 344 | int (*frame_send)(struct fc_lport *lp, struct fc_frame *fp); |
42e9a92f RL |
345 | |
346 | /* | |
0ae4d4ae RL |
347 | * Interface to send ELS/CT frames |
348 | * | |
349 | * STATUS: OPTIONAL | |
42e9a92f RL |
350 | */ |
351 | struct fc_seq *(*elsct_send)(struct fc_lport *lport, | |
352 | struct fc_rport *rport, | |
353 | struct fc_frame *fp, | |
354 | unsigned int op, | |
355 | void (*resp)(struct fc_seq *, | |
356 | struct fc_frame *fp, | |
357 | void *arg), | |
358 | void *arg, u32 timer_msec); | |
42e9a92f RL |
359 | |
360 | /* | |
361 | * Send the FC frame payload using a new exchange and sequence. | |
362 | * | |
363 | * The frame pointer with some of the header's fields must be | |
364 | * filled before calling exch_seq_send(), those fields are, | |
365 | * | |
366 | * - routing control | |
367 | * - FC port did | |
368 | * - FC port sid | |
369 | * - FC header type | |
370 | * - frame control | |
371 | * - parameter or relative offset | |
372 | * | |
373 | * The exchange response handler is set in this routine to resp() | |
374 | * function pointer. It can be called in two scenarios: if a timeout | |
375 | * occurs or if a response frame is received for the exchange. The | |
376 | * fc_frame pointer in response handler will also indicate timeout | |
377 | * as error using IS_ERR related macros. | |
378 | * | |
379 | * The exchange destructor handler is also set in this routine. | |
380 | * The destructor handler is invoked by EM layer when exchange | |
381 | * is about to free, this can be used by caller to free its | |
382 | * resources along with exchange free. | |
383 | * | |
384 | * The arg is passed back to resp and destructor handler. | |
385 | * | |
386 | * The timeout value (in msec) for an exchange is set if non zero | |
387 | * timer_msec argument is specified. The timer is canceled when | |
388 | * it fires or when the exchange is done. The exchange timeout handler | |
389 | * is registered by EM layer. | |
0ae4d4ae RL |
390 | * |
391 | * STATUS: OPTIONAL | |
42e9a92f RL |
392 | */ |
393 | struct fc_seq *(*exch_seq_send)(struct fc_lport *lp, | |
394 | struct fc_frame *fp, | |
395 | void (*resp)(struct fc_seq *sp, | |
396 | struct fc_frame *fp, | |
397 | void *arg), | |
398 | void (*destructor)(struct fc_seq *sp, | |
399 | void *arg), | |
400 | void *arg, unsigned int timer_msec); | |
401 | ||
402 | /* | |
0ae4d4ae RL |
403 | * Send a frame using an existing sequence and exchange. |
404 | * | |
405 | * STATUS: OPTIONAL | |
42e9a92f RL |
406 | */ |
407 | int (*seq_send)(struct fc_lport *lp, struct fc_seq *sp, | |
408 | struct fc_frame *fp); | |
409 | ||
410 | /* | |
0ae4d4ae RL |
411 | * Send an ELS response using infomation from a previous |
412 | * exchange and sequence. | |
413 | * | |
414 | * STATUS: OPTIONAL | |
42e9a92f RL |
415 | */ |
416 | void (*seq_els_rsp_send)(struct fc_seq *sp, enum fc_els_cmd els_cmd, | |
417 | struct fc_seq_els_data *els_data); | |
418 | ||
419 | /* | |
420 | * Abort an exchange and sequence. Generally called because of a | |
421 | * exchange timeout or an abort from the upper layer. | |
422 | * | |
423 | * A timer_msec can be specified for abort timeout, if non-zero | |
424 | * timer_msec value is specified then exchange resp handler | |
425 | * will be called with timeout error if no response to abort. | |
0ae4d4ae RL |
426 | * |
427 | * STATUS: OPTIONAL | |
42e9a92f RL |
428 | */ |
429 | int (*seq_exch_abort)(const struct fc_seq *req_sp, | |
430 | unsigned int timer_msec); | |
431 | ||
432 | /* | |
433 | * Indicate that an exchange/sequence tuple is complete and the memory | |
434 | * allocated for the related objects may be freed. | |
0ae4d4ae RL |
435 | * |
436 | * STATUS: OPTIONAL | |
42e9a92f RL |
437 | */ |
438 | void (*exch_done)(struct fc_seq *sp); | |
439 | ||
440 | /* | |
441 | * Assigns a EM and a free XID for an new exchange and then | |
442 | * allocates a new exchange and sequence pair. | |
443 | * The fp can be used to determine free XID. | |
0ae4d4ae RL |
444 | * |
445 | * STATUS: OPTIONAL | |
42e9a92f RL |
446 | */ |
447 | struct fc_exch *(*exch_get)(struct fc_lport *lp, struct fc_frame *fp); | |
448 | ||
449 | /* | |
450 | * Release previously assigned XID by exch_get API. | |
451 | * The LLD may implement this if XID is assigned by LLD | |
452 | * in exch_get(). | |
0ae4d4ae RL |
453 | * |
454 | * STATUS: OPTIONAL | |
42e9a92f RL |
455 | */ |
456 | void (*exch_put)(struct fc_lport *lp, struct fc_exch_mgr *mp, | |
457 | u16 ex_id); | |
458 | ||
459 | /* | |
460 | * Start a new sequence on the same exchange/sequence tuple. | |
0ae4d4ae RL |
461 | * |
462 | * STATUS: OPTIONAL | |
42e9a92f RL |
463 | */ |
464 | struct fc_seq *(*seq_start_next)(struct fc_seq *sp); | |
465 | ||
466 | /* | |
467 | * Reset an exchange manager, completing all sequences and exchanges. | |
468 | * If s_id is non-zero, reset only exchanges originating from that FID. | |
469 | * If d_id is non-zero, reset only exchanges sending to that FID. | |
0ae4d4ae RL |
470 | * |
471 | * STATUS: OPTIONAL | |
42e9a92f | 472 | */ |
1f6ff364 | 473 | void (*exch_mgr_reset)(struct fc_lport *, |
42e9a92f RL |
474 | u32 s_id, u32 d_id); |
475 | ||
0ae4d4ae RL |
476 | /* |
477 | * Flush the rport work queue. Generally used before shutdown. | |
478 | * | |
479 | * STATUS: OPTIONAL | |
42e9a92f | 480 | */ |
0ae4d4ae | 481 | void (*rport_flush_queue)(void); |
42e9a92f RL |
482 | |
483 | /* | |
0ae4d4ae RL |
484 | * Receive a frame for a local port. |
485 | * | |
486 | * STATUS: OPTIONAL | |
42e9a92f RL |
487 | */ |
488 | void (*lport_recv)(struct fc_lport *lp, struct fc_seq *sp, | |
489 | struct fc_frame *fp); | |
490 | ||
0ae4d4ae RL |
491 | /* |
492 | * Reset the local port. | |
493 | * | |
494 | * STATUS: OPTIONAL | |
42e9a92f | 495 | */ |
0ae4d4ae | 496 | int (*lport_reset)(struct fc_lport *); |
42e9a92f | 497 | |
5101ff99 RL |
498 | /* |
499 | * Create a remote port | |
500 | */ | |
501 | struct fc_rport *(*rport_create)(struct fc_disc_port *); | |
502 | ||
42e9a92f RL |
503 | /* |
504 | * Initiates the RP state machine. It is called from the LP module. | |
505 | * This function will issue the following commands to the N_Port | |
506 | * identified by the FC ID provided. | |
507 | * | |
508 | * - PLOGI | |
509 | * - PRLI | |
510 | * - RTV | |
0ae4d4ae RL |
511 | * |
512 | * STATUS: OPTIONAL | |
42e9a92f RL |
513 | */ |
514 | int (*rport_login)(struct fc_rport *rport); | |
515 | ||
516 | /* | |
517 | * Logoff, and remove the rport from the transport if | |
518 | * it had been added. This will send a LOGO to the target. | |
0ae4d4ae RL |
519 | * |
520 | * STATUS: OPTIONAL | |
42e9a92f RL |
521 | */ |
522 | int (*rport_logoff)(struct fc_rport *rport); | |
523 | ||
524 | /* | |
525 | * Recieve a request from a remote port. | |
0ae4d4ae RL |
526 | * |
527 | * STATUS: OPTIONAL | |
42e9a92f RL |
528 | */ |
529 | void (*rport_recv_req)(struct fc_seq *, struct fc_frame *, | |
530 | struct fc_rport *); | |
531 | ||
0ae4d4ae RL |
532 | /* |
533 | * lookup an rport by it's port ID. | |
534 | * | |
535 | * STATUS: OPTIONAL | |
42e9a92f | 536 | */ |
0ae4d4ae | 537 | struct fc_rport *(*rport_lookup)(const struct fc_lport *, u32); |
42e9a92f RL |
538 | |
539 | /* | |
540 | * Send a fcp cmd from fsp pkt. | |
541 | * Called with the SCSI host lock unlocked and irqs disabled. | |
542 | * | |
543 | * The resp handler is called when FCP_RSP received. | |
544 | * | |
0ae4d4ae | 545 | * STATUS: OPTIONAL |
42e9a92f RL |
546 | */ |
547 | int (*fcp_cmd_send)(struct fc_lport *lp, struct fc_fcp_pkt *fsp, | |
548 | void (*resp)(struct fc_seq *, struct fc_frame *fp, | |
549 | void *arg)); | |
550 | ||
551 | /* | |
0ae4d4ae RL |
552 | * Cleanup the FCP layer, used durring link down and reset |
553 | * | |
554 | * STATUS: OPTIONAL | |
42e9a92f RL |
555 | */ |
556 | void (*fcp_cleanup)(struct fc_lport *lp); | |
557 | ||
558 | /* | |
559 | * Abort all I/O on a local port | |
0ae4d4ae RL |
560 | * |
561 | * STATUS: OPTIONAL | |
42e9a92f RL |
562 | */ |
563 | void (*fcp_abort_io)(struct fc_lport *lp); | |
564 | ||
0ae4d4ae RL |
565 | /* |
566 | * Receive a request for the discovery layer. | |
567 | * | |
568 | * STATUS: OPTIONAL | |
42e9a92f | 569 | */ |
42e9a92f RL |
570 | void (*disc_recv_req)(struct fc_seq *, |
571 | struct fc_frame *, struct fc_lport *); | |
572 | ||
573 | /* | |
574 | * Start discovery for a local port. | |
0ae4d4ae RL |
575 | * |
576 | * STATUS: OPTIONAL | |
42e9a92f RL |
577 | */ |
578 | void (*disc_start)(void (*disc_callback)(struct fc_lport *, | |
579 | enum fc_disc_event), | |
580 | struct fc_lport *); | |
581 | ||
582 | /* | |
583 | * Stop discovery for a given lport. This will remove | |
584 | * all discovered rports | |
0ae4d4ae RL |
585 | * |
586 | * STATUS: OPTIONAL | |
42e9a92f RL |
587 | */ |
588 | void (*disc_stop) (struct fc_lport *); | |
589 | ||
590 | /* | |
591 | * Stop discovery for a given lport. This will block | |
592 | * until all discovered rports are deleted from the | |
593 | * FC transport class | |
0ae4d4ae RL |
594 | * |
595 | * STATUS: OPTIONAL | |
42e9a92f RL |
596 | */ |
597 | void (*disc_stop_final) (struct fc_lport *); | |
598 | }; | |
599 | ||
600 | /* information used by the discovery layer */ | |
601 | struct fc_disc { | |
602 | unsigned char retry_count; | |
603 | unsigned char delay; | |
604 | unsigned char pending; | |
605 | unsigned char requested; | |
606 | unsigned short seq_count; | |
607 | unsigned char buf_len; | |
608 | enum fc_disc_event event; | |
609 | ||
610 | void (*disc_callback)(struct fc_lport *, | |
611 | enum fc_disc_event); | |
612 | ||
613 | struct list_head rports; | |
614 | struct fc_lport *lport; | |
615 | struct mutex disc_mutex; | |
616 | struct fc_gpn_ft_resp partial_buf; /* partial name buffer */ | |
617 | struct delayed_work disc_work; | |
618 | }; | |
619 | ||
620 | struct fc_lport { | |
621 | struct list_head list; | |
622 | ||
623 | /* Associations */ | |
624 | struct Scsi_Host *host; | |
625 | struct fc_exch_mgr *emp; | |
626 | struct fc_rport *dns_rp; | |
627 | struct fc_rport *ptp_rp; | |
628 | void *scsi_priv; | |
629 | struct fc_disc disc; | |
630 | ||
631 | /* Operational Information */ | |
632 | struct libfc_function_template tt; | |
bc0e17f6 VD |
633 | u8 link_up; |
634 | u8 qfull; | |
42e9a92f RL |
635 | enum fc_lport_state state; |
636 | unsigned long boot_time; | |
637 | ||
638 | struct fc_host_statistics host_stats; | |
639 | struct fcoe_dev_stats *dev_stats[NR_CPUS]; | |
640 | u64 wwpn; | |
641 | u64 wwnn; | |
642 | u8 retry_count; | |
643 | ||
644 | /* Capabilities */ | |
645 | u32 sg_supp:1; /* scatter gather supported */ | |
646 | u32 seq_offload:1; /* seq offload supported */ | |
647 | u32 crc_offload:1; /* crc offload supported */ | |
648 | u32 lro_enabled:1; /* large receive offload */ | |
649 | u32 mfs; /* max FC payload size */ | |
650 | unsigned int service_params; | |
651 | unsigned int e_d_tov; | |
652 | unsigned int r_a_tov; | |
653 | u8 max_retry_count; | |
654 | u16 link_speed; | |
655 | u16 link_supported_speeds; | |
656 | u16 lro_xid; /* max xid for fcoe lro */ | |
657 | struct fc_ns_fts fcts; /* FC-4 type masks */ | |
658 | struct fc_els_rnid_gen rnid_gen; /* RNID information */ | |
659 | ||
660 | /* Semaphores */ | |
661 | struct mutex lp_mutex; | |
662 | ||
663 | /* Miscellaneous */ | |
664 | struct delayed_work retry_work; | |
665 | struct delayed_work disc_work; | |
666 | }; | |
667 | ||
668 | /** | |
669 | * FC_LPORT HELPER FUNCTIONS | |
670 | *****************************/ | |
671 | static inline void *lport_priv(const struct fc_lport *lp) | |
672 | { | |
673 | return (void *)(lp + 1); | |
674 | } | |
675 | ||
676 | static inline int fc_lport_test_ready(struct fc_lport *lp) | |
677 | { | |
678 | return lp->state == LPORT_ST_READY; | |
679 | } | |
680 | ||
681 | static inline void fc_set_wwnn(struct fc_lport *lp, u64 wwnn) | |
682 | { | |
683 | lp->wwnn = wwnn; | |
684 | } | |
685 | ||
686 | static inline void fc_set_wwpn(struct fc_lport *lp, u64 wwnn) | |
687 | { | |
688 | lp->wwpn = wwnn; | |
689 | } | |
690 | ||
691 | static inline void fc_lport_state_enter(struct fc_lport *lp, | |
692 | enum fc_lport_state state) | |
693 | { | |
694 | if (state != lp->state) | |
695 | lp->retry_count = 0; | |
696 | lp->state = state; | |
697 | } | |
698 | ||
699 | ||
700 | /** | |
701 | * LOCAL PORT LAYER | |
702 | *****************************/ | |
703 | int fc_lport_init(struct fc_lport *lp); | |
704 | ||
705 | /* | |
706 | * Destroy the specified local port by finding and freeing all | |
707 | * fc_rports associated with it and then by freeing the fc_lport | |
708 | * itself. | |
709 | */ | |
710 | int fc_lport_destroy(struct fc_lport *lp); | |
711 | ||
712 | /* | |
713 | * Logout the specified local port from the fabric | |
714 | */ | |
715 | int fc_fabric_logoff(struct fc_lport *lp); | |
716 | ||
717 | /* | |
718 | * Initiate the LP state machine. This handler will use fc_host_attr | |
719 | * to store the FLOGI service parameters, so fc_host_attr must be | |
720 | * initialized before calling this handler. | |
721 | */ | |
722 | int fc_fabric_login(struct fc_lport *lp); | |
723 | ||
724 | /* | |
725 | * The link is up for the given local port. | |
726 | */ | |
727 | void fc_linkup(struct fc_lport *); | |
728 | ||
729 | /* | |
730 | * Link is down for the given local port. | |
731 | */ | |
732 | void fc_linkdown(struct fc_lport *); | |
733 | ||
42e9a92f RL |
734 | /* |
735 | * Configure the local port. | |
736 | */ | |
737 | int fc_lport_config(struct fc_lport *); | |
738 | ||
739 | /* | |
740 | * Reset the local port. | |
741 | */ | |
742 | int fc_lport_reset(struct fc_lport *); | |
743 | ||
744 | /* | |
745 | * Set the mfs or reset | |
746 | */ | |
747 | int fc_set_mfs(struct fc_lport *lp, u32 mfs); | |
748 | ||
749 | ||
750 | /** | |
751 | * REMOTE PORT LAYER | |
752 | *****************************/ | |
753 | int fc_rport_init(struct fc_lport *lp); | |
754 | void fc_rport_terminate_io(struct fc_rport *rp); | |
755 | ||
756 | /** | |
757 | * DISCOVERY LAYER | |
758 | *****************************/ | |
759 | int fc_disc_init(struct fc_lport *lp); | |
760 | ||
761 | ||
762 | /** | |
763 | * SCSI LAYER | |
764 | *****************************/ | |
765 | /* | |
766 | * Initialize the SCSI block of libfc | |
767 | */ | |
768 | int fc_fcp_init(struct fc_lport *); | |
769 | ||
770 | /* | |
771 | * This section provides an API which allows direct interaction | |
772 | * with the SCSI-ml. Each of these functions satisfies a function | |
773 | * pointer defined in Scsi_Host and therefore is always called | |
774 | * directly from the SCSI-ml. | |
775 | */ | |
776 | int fc_queuecommand(struct scsi_cmnd *sc_cmd, | |
777 | void (*done)(struct scsi_cmnd *)); | |
778 | ||
779 | /* | |
780 | * complete processing of a fcp packet | |
781 | * | |
782 | * This function may sleep if a fsp timer is pending. | |
783 | * The host lock must not be held by caller. | |
784 | */ | |
785 | void fc_fcp_complete(struct fc_fcp_pkt *fsp); | |
786 | ||
787 | /* | |
788 | * Send an ABTS frame to the target device. The sc_cmd argument | |
789 | * is a pointer to the SCSI command to be aborted. | |
790 | */ | |
791 | int fc_eh_abort(struct scsi_cmnd *sc_cmd); | |
792 | ||
793 | /* | |
794 | * Reset a LUN by sending send the tm cmd to the target. | |
795 | */ | |
796 | int fc_eh_device_reset(struct scsi_cmnd *sc_cmd); | |
797 | ||
798 | /* | |
799 | * Reset the host adapter. | |
800 | */ | |
801 | int fc_eh_host_reset(struct scsi_cmnd *sc_cmd); | |
802 | ||
803 | /* | |
804 | * Check rport status. | |
805 | */ | |
806 | int fc_slave_alloc(struct scsi_device *sdev); | |
807 | ||
808 | /* | |
809 | * Adjust the queue depth. | |
810 | */ | |
811 | int fc_change_queue_depth(struct scsi_device *sdev, int qdepth); | |
812 | ||
813 | /* | |
814 | * Change the tag type. | |
815 | */ | |
816 | int fc_change_queue_type(struct scsi_device *sdev, int tag_type); | |
817 | ||
818 | /* | |
819 | * Free memory pools used by the FCP layer. | |
820 | */ | |
821 | void fc_fcp_destroy(struct fc_lport *); | |
822 | ||
823 | /** | |
824 | * ELS/CT interface | |
825 | *****************************/ | |
826 | /* | |
827 | * Initializes ELS/CT interface | |
828 | */ | |
829 | int fc_elsct_init(struct fc_lport *lp); | |
830 | ||
831 | ||
832 | /** | |
833 | * EXCHANGE MANAGER LAYER | |
834 | *****************************/ | |
835 | /* | |
836 | * Initializes Exchange Manager related | |
837 | * function pointers in struct libfc_function_template. | |
838 | */ | |
839 | int fc_exch_init(struct fc_lport *lp); | |
840 | ||
841 | /* | |
842 | * Allocates an Exchange Manager (EM). | |
843 | * | |
844 | * The EM manages exchanges for their allocation and | |
845 | * free, also allows exchange lookup for received | |
846 | * frame. | |
847 | * | |
848 | * The class is used for initializing FC class of | |
849 | * allocated exchange from EM. | |
850 | * | |
851 | * The min_xid and max_xid will limit new | |
852 | * exchange ID (XID) within this range for | |
853 | * a new exchange. | |
854 | * The LLD may choose to have multiple EMs, | |
855 | * e.g. one EM instance per CPU receive thread in LLD. | |
856 | * The LLD can use exch_get() of struct libfc_function_template | |
857 | * to specify XID for a new exchange within | |
858 | * a specified EM instance. | |
859 | * | |
860 | * The em_idx to uniquely identify an EM instance. | |
861 | */ | |
862 | struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *lp, | |
863 | enum fc_class class, | |
864 | u16 min_xid, | |
865 | u16 max_xid); | |
866 | ||
867 | /* | |
868 | * Free an exchange manager. | |
869 | */ | |
870 | void fc_exch_mgr_free(struct fc_exch_mgr *mp); | |
871 | ||
872 | /* | |
873 | * Receive a frame on specified local port and exchange manager. | |
874 | */ | |
875 | void fc_exch_recv(struct fc_lport *lp, struct fc_exch_mgr *mp, | |
876 | struct fc_frame *fp); | |
877 | ||
878 | /* | |
879 | * This function is for exch_seq_send function pointer in | |
880 | * struct libfc_function_template, see comment block on | |
881 | * exch_seq_send for description of this function. | |
882 | */ | |
883 | struct fc_seq *fc_exch_seq_send(struct fc_lport *lp, | |
884 | struct fc_frame *fp, | |
885 | void (*resp)(struct fc_seq *sp, | |
886 | struct fc_frame *fp, | |
887 | void *arg), | |
888 | void (*destructor)(struct fc_seq *sp, | |
889 | void *arg), | |
890 | void *arg, u32 timer_msec); | |
891 | ||
892 | /* | |
893 | * send a frame using existing sequence and exchange. | |
894 | */ | |
895 | int fc_seq_send(struct fc_lport *lp, struct fc_seq *sp, struct fc_frame *fp); | |
896 | ||
897 | /* | |
898 | * Send ELS response using mainly infomation | |
899 | * in exchange and sequence in EM layer. | |
900 | */ | |
901 | void fc_seq_els_rsp_send(struct fc_seq *sp, enum fc_els_cmd els_cmd, | |
902 | struct fc_seq_els_data *els_data); | |
903 | ||
904 | /* | |
905 | * This function is for seq_exch_abort function pointer in | |
906 | * struct libfc_function_template, see comment block on | |
907 | * seq_exch_abort for description of this function. | |
908 | */ | |
909 | int fc_seq_exch_abort(const struct fc_seq *req_sp, unsigned int timer_msec); | |
910 | ||
911 | /* | |
912 | * Indicate that an exchange/sequence tuple is complete and the memory | |
913 | * allocated for the related objects may be freed. | |
914 | */ | |
915 | void fc_exch_done(struct fc_seq *sp); | |
916 | ||
917 | /* | |
918 | * Assigns a EM and XID for a frame and then allocates | |
919 | * a new exchange and sequence pair. | |
920 | * The fp can be used to determine free XID. | |
921 | */ | |
922 | struct fc_exch *fc_exch_get(struct fc_lport *lp, struct fc_frame *fp); | |
923 | ||
924 | /* | |
925 | * Allocate a new exchange and sequence pair. | |
926 | * if ex_id is zero then next free exchange id | |
927 | * from specified exchange manger mp will be assigned. | |
928 | */ | |
929 | struct fc_exch *fc_exch_alloc(struct fc_exch_mgr *mp, | |
930 | struct fc_frame *fp, u16 ex_id); | |
931 | /* | |
932 | * Start a new sequence on the same exchange as the supplied sequence. | |
933 | */ | |
934 | struct fc_seq *fc_seq_start_next(struct fc_seq *sp); | |
935 | ||
936 | /* | |
937 | * Reset an exchange manager, completing all sequences and exchanges. | |
938 | * If s_id is non-zero, reset only exchanges originating from that FID. | |
939 | * If d_id is non-zero, reset only exchanges sending to that FID. | |
940 | */ | |
1f6ff364 | 941 | void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); |
42e9a92f RL |
942 | |
943 | /* | |
944 | * Functions for fc_functions_template | |
945 | */ | |
946 | void fc_get_host_speed(struct Scsi_Host *shost); | |
947 | void fc_get_host_port_type(struct Scsi_Host *shost); | |
948 | void fc_get_host_port_state(struct Scsi_Host *shost); | |
949 | void fc_set_rport_loss_tmo(struct fc_rport *rport, u32 timeout); | |
950 | struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); | |
951 | ||
952 | /* | |
953 | * module setup functions. | |
954 | */ | |
955 | int fc_setup_exch_mgr(void); | |
956 | void fc_destroy_exch_mgr(void); | |
957 | int fc_setup_rport(void); | |
958 | void fc_destroy_rport(void); | |
959 | ||
960 | #endif /* _LIBFC_H_ */ |