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