blob: 5f64e593cca8e2bea353a8164216ebdd62c471f4 [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>
Steve Maa51ab392009-11-03 11:47:34 -080029#include <scsi/scsi_bsg_fc.h>
Robert Love42e9a922008-12-09 15:10:17 -080030
31#include <scsi/fc/fc_fcp.h>
32#include <scsi/fc/fc_ns.h>
33#include <scsi/fc/fc_els.h>
34#include <scsi/fc/fc_gs.h>
35
36#include <scsi/fc_frame.h>
37
Robert Love42e9a922008-12-09 15:10:17 -080038/*
39 * libfc error codes
40 */
41#define FC_NO_ERR 0 /* no error */
42#define FC_EX_TIMEOUT 1 /* Exchange timeout */
43#define FC_EX_CLOSED 2 /* Exchange closed */
44
45/* some helpful macros */
46
47#define ntohll(x) be64_to_cpu(x)
48#define htonll(x) cpu_to_be64(x)
49
Robert Love42e9a922008-12-09 15:10:17 -080050
Joe Eykholt0b2f74a2010-04-09 14:22:39 -070051static inline u32 ntoh24(const u8 *p)
52{
53 return (p[0] << 16) | (p[1] << 8) | p[2];
54}
55
56static inline void hton24(u8 *p, u32 v)
57{
58 p[0] = (v >> 16) & 0xff;
59 p[1] = (v >> 8) & 0xff;
60 p[2] = v & 0xff;
61}
Robert Love42e9a922008-12-09 15:10:17 -080062
Robert Love3a3b42b2009-11-03 11:47:39 -080063/**
64 * enum fc_lport_state - Local port states
65 * @LPORT_ST_DISABLED: Disabled
66 * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent
67 * @LPORT_ST_DNS: Waiting for name server remote port to become ready
68 * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent
69 * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent
Joe Eykholtab593b12009-11-03 11:49:27 -080070 * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent
Robert Love3a3b42b2009-11-03 11:47:39 -080071 * @LPORT_ST_SCR: State Change Register (SCR) sent
72 * @LPORT_ST_READY: Ready for use
73 * @LPORT_ST_LOGO: Local port logout (LOGO) sent
74 * @LPORT_ST_RESET: Local port reset
Robert Love42e9a922008-12-09 15:10:17 -080075 */
Robert Love42e9a922008-12-09 15:10:17 -080076enum fc_lport_state {
Joe Eykholtb1d9fd52009-07-29 17:04:22 -070077 LPORT_ST_DISABLED = 0,
Robert Love42e9a922008-12-09 15:10:17 -080078 LPORT_ST_FLOGI,
79 LPORT_ST_DNS,
Chris Leechc9c7bd72009-11-03 11:46:51 -080080 LPORT_ST_RNN_ID,
Chris Leech5baa17c2009-11-03 11:46:56 -080081 LPORT_ST_RSNN_NN,
Chris Leechc9866a52009-11-03 11:47:01 -080082 LPORT_ST_RSPN_ID,
Robert Love42e9a922008-12-09 15:10:17 -080083 LPORT_ST_RFT_ID,
Joe Eykholtab593b12009-11-03 11:49:27 -080084 LPORT_ST_RFF_ID,
Robert Love42e9a922008-12-09 15:10:17 -080085 LPORT_ST_SCR,
86 LPORT_ST_READY,
87 LPORT_ST_LOGO,
88 LPORT_ST_RESET
89};
90
91enum fc_disc_event {
92 DISC_EV_NONE = 0,
93 DISC_EV_SUCCESS,
94 DISC_EV_FAILED
95};
96
Robert Love3a3b42b2009-11-03 11:47:39 -080097/**
98 * enum fc_rport_state - Remote port states
99 * @RPORT_ST_INIT: Initialized
100 * @RPORT_ST_PLOGI: Waiting for PLOGI completion
101 * @RPORT_ST_PRLI: Waiting for PRLI completion
102 * @RPORT_ST_RTV: Waiting for RTV completion
103 * @RPORT_ST_READY: Ready for use
104 * @RPORT_ST_LOGO: Remote port logout (LOGO) sent
105 * @RPORT_ST_ADISC: Discover Address sent
106 * @RPORT_ST_DELETE: Remote port being deleted
Robert Love3a3b42b2009-11-03 11:47:39 -0800107*/
Robert Love42e9a922008-12-09 15:10:17 -0800108enum fc_rport_state {
Robert Love3a3b42b2009-11-03 11:47:39 -0800109 RPORT_ST_INIT,
110 RPORT_ST_PLOGI,
111 RPORT_ST_PRLI,
112 RPORT_ST_RTV,
113 RPORT_ST_READY,
114 RPORT_ST_LOGO,
115 RPORT_ST_ADISC,
116 RPORT_ST_DELETE,
Robert Love42e9a922008-12-09 15:10:17 -0800117};
118
Robert Love42e9a922008-12-09 15:10:17 -0800119/**
120 * struct fc_disc_port - temporary discovery port to hold rport identifiers
Robert Love9737e6a2009-08-25 14:02:59 -0700121 * @lp: Fibre Channel host port instance
122 * @peers: Node for list management during discovery and RSCN processing
123 * @rport_work: Work struct for starting the rport state machine
124 * @port_id: Port ID of the discovered port
Robert Love42e9a922008-12-09 15:10:17 -0800125 */
126struct fc_disc_port {
Robert Love3a3b42b2009-11-03 11:47:39 -0800127 struct fc_lport *lp;
128 struct list_head peers;
129 struct work_struct rport_work;
130 u32 port_id;
Robert Love42e9a922008-12-09 15:10:17 -0800131};
132
Robert Love3a3b42b2009-11-03 11:47:39 -0800133/**
134 * enum fc_rport_event - Remote port events
135 * @RPORT_EV_NONE: No event
136 * @RPORT_EV_READY: Remote port is ready for use
137 * @RPORT_EV_FAILED: State machine failed, remote port is not ready
138 * @RPORT_EV_STOP: Remote port has been stopped
139 * @RPORT_EV_LOGO: Remote port logout (LOGO) sent
140 */
Robert Love42e9a922008-12-09 15:10:17 -0800141enum fc_rport_event {
142 RPORT_EV_NONE = 0,
Joe Eykholt4c0f62b2009-08-25 14:01:12 -0700143 RPORT_EV_READY,
Robert Love42e9a922008-12-09 15:10:17 -0800144 RPORT_EV_FAILED,
145 RPORT_EV_STOP,
146 RPORT_EV_LOGO
147};
148
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700149struct fc_rport_priv;
150
Robert Love3a3b42b2009-11-03 11:47:39 -0800151/**
152 * struct fc_rport_operations - Operations for a remote port
153 * @event_callback: Function to be called for remote port events
154 */
Robert Love42e9a922008-12-09 15:10:17 -0800155struct fc_rport_operations {
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700156 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
Robert Love42e9a922008-12-09 15:10:17 -0800157 enum fc_rport_event);
158};
159
160/**
161 * struct fc_rport_libfc_priv - libfc internal information about a remote port
Robert Love3a3b42b2009-11-03 11:47:39 -0800162 * @local_port: The associated local port
163 * @rp_state: Indicates READY for I/O or DELETE when blocked
164 * @flags: REC and RETRY supported flags
165 * @e_d_tov: Error detect timeout value (in msec)
166 * @r_a_tov: Resource allocation timeout value (in msec)
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700167 */
168struct fc_rport_libfc_priv {
169 struct fc_lport *local_port;
170 enum fc_rport_state rp_state;
171 u16 flags;
172 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
173 #define FC_RP_FLAGS_RETRY (1 << 1)
Joe Eykholt4b2164d2010-06-11 16:44:51 -0700174 #define FC_RP_STARTED (1 << 2)
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700175 unsigned int e_d_tov;
176 unsigned int r_a_tov;
177};
178
179/**
Robert Love3a3b42b2009-11-03 11:47:39 -0800180 * struct fc_rport_priv - libfc remote port and discovery info
181 * @local_port: The associated local port
182 * @rport: The FC transport remote port
183 * @kref: Reference counter
184 * @rp_state: Enumeration that tracks progress of PLOGI, PRLI,
185 * and RTV exchanges
186 * @ids: The remote port identifiers and roles
Joe Eykholt4b2164d2010-06-11 16:44:51 -0700187 * @flags: STARTED, REC and RETRY_SUPPORTED flags
Robert Love3a3b42b2009-11-03 11:47:39 -0800188 * @max_seq: Maximum number of concurrent sequences
189 * @disc_id: The discovery identifier
190 * @maxframe_size: The maximum frame size
191 * @retries: The retry count for the current state
Joe Eykholtf0342602010-06-11 16:44:57 -0700192 * @major_retries: The retry count for the entire PLOGI/PRLI state machine
Robert Love3a3b42b2009-11-03 11:47:39 -0800193 * @e_d_tov: Error detect timeout value (in msec)
194 * @r_a_tov: Resource allocation timeout value (in msec)
195 * @rp_mutex: The mutex that protects the remote port
196 * @retry_work: Handle for retries
197 * @event_callback: Callback when READY, FAILED or LOGO states complete
Joe Eykholt42e90412010-07-20 15:19:37 -0700198 * @rcu: Structure used for freeing in an RCU-safe manner
Robert Love42e9a922008-12-09 15:10:17 -0800199 */
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700200struct fc_rport_priv {
Robert Love3a3b42b2009-11-03 11:47:39 -0800201 struct fc_lport *local_port;
202 struct fc_rport *rport;
203 struct kref kref;
204 enum fc_rport_state rp_state;
Joe Eykholtf211fa52009-08-25 14:01:01 -0700205 struct fc_rport_identifiers ids;
Robert Love3a3b42b2009-11-03 11:47:39 -0800206 u16 flags;
207 u16 max_seq;
208 u16 disc_id;
209 u16 maxframe_size;
210 unsigned int retries;
Joe Eykholtf0342602010-06-11 16:44:57 -0700211 unsigned int major_retries;
Robert Love3a3b42b2009-11-03 11:47:39 -0800212 unsigned int e_d_tov;
213 unsigned int r_a_tov;
214 struct mutex rp_mutex;
215 struct delayed_work retry_work;
216 enum fc_rport_event event;
217 struct fc_rport_operations *ops;
218 struct list_head peers;
219 struct work_struct event_work;
220 u32 supported_classes;
Joe Eykholt42e90412010-07-20 15:19:37 -0700221 struct rcu_head rcu;
Robert Love42e9a922008-12-09 15:10:17 -0800222};
223
Robert Love3a3b42b2009-11-03 11:47:39 -0800224/**
225 * struct fcoe_dev_stats - fcoe stats structure
226 * @SecondsSinceLastReset: Seconds since the last reset
227 * @TxFrames: Number of transmitted frames
228 * @TxWords: Number of transmitted words
229 * @RxFrames: Number of received frames
230 * @RxWords: Number of received words
231 * @ErrorFrames: Number of received error frames
232 * @DumpedFrames: Number of dumped frames
233 * @LinkFailureCount: Number of link failures
234 * @LossOfSignalCount: Number for signal losses
235 * @InvalidTxWordCount: Number of invalid transmitted words
236 * @InvalidCRCCount: Number of invalid CRCs
237 * @InputRequests: Number of input requests
238 * @OutputRequests: Number of output requests
239 * @ControlRequests: Number of control requests
240 * @InputMegabytes: Number of received megabytes
241 * @OutputMegabytes: Number of transmitted megabytes
Yi Zou6580bbd2009-11-20 14:54:52 -0800242 * @VLinkFailureCount: Number of virtual link failures
243 * @MissDiscAdvCount: Number of missing FIP discovery advertisement
Robert Love42e9a922008-12-09 15:10:17 -0800244 */
245struct fcoe_dev_stats {
246 u64 SecondsSinceLastReset;
247 u64 TxFrames;
248 u64 TxWords;
249 u64 RxFrames;
250 u64 RxWords;
251 u64 ErrorFrames;
252 u64 DumpedFrames;
253 u64 LinkFailureCount;
254 u64 LossOfSignalCount;
255 u64 InvalidTxWordCount;
256 u64 InvalidCRCCount;
257 u64 InputRequests;
258 u64 OutputRequests;
259 u64 ControlRequests;
260 u64 InputMegabytes;
261 u64 OutputMegabytes;
Yi Zou6580bbd2009-11-20 14:54:52 -0800262 u64 VLinkFailureCount;
263 u64 MissDiscAdvCount;
Robert Love42e9a922008-12-09 15:10:17 -0800264};
265
Robert Love3a3b42b2009-11-03 11:47:39 -0800266/**
267 * struct fc_seq_els_data - ELS data used for passing ELS specific responses
268 * @fp: The ELS frame
269 * @reason: The reason for rejection
270 * @explan: The explaination of the rejection
271 *
272 * Mainly used by the exchange manager layer.
Robert Love42e9a922008-12-09 15:10:17 -0800273 */
274struct fc_seq_els_data {
275 struct fc_frame *fp;
276 enum fc_els_rjt_reason reason;
277 enum fc_els_rjt_explan explan;
278};
279
Robert Love3a3b42b2009-11-03 11:47:39 -0800280/**
281 * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
282 * @lp: The associated local port
283 * @state: The state of the I/O
284 * @tgt_flags: Target's flags
285 * @ref_cnt: Reference count
286 * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the
287 * host_lock if both are to be held at the same time)
288 * @cmd: The SCSI command (set and clear with the host_lock held)
289 * @list: Tracks queued commands (accessed with the host_lock held)
290 * @timer: The command timer
291 * @tm_done: Completion indicator
292 * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies)
293 * @start_time: Timestamp indicating the start of the I/O (in jiffies)
294 * @end_time: Timestamp indicating the end of the I/O (in jiffies)
295 * @last_pkt_time: Timestamp of the last frame received (in jiffies)
296 * @data_len: The length of the data
297 * @cdb_cmd: The CDB command
298 * @xfer_len: The transfer length
299 * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange
300 * will be set here if DDP was setup)
301 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
302 * (Tx and Rx)
303 * @max_payload: The maximum payload size (in bytes)
304 * @io_status: SCSI result (upper 24 bits)
305 * @cdb_status: CDB status
306 * @status_code: FCP I/O status
307 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
308 * @req_flags: Request flags (bit 0: read bit:1 write)
309 * @scsi_resid: SCSI residule length
310 * @rport: The remote port that the SCSI command is targeted at
311 * @seq_ptr: The sequence that will carry the SCSI command
312 * @recov_retry: Number of recovery retries
313 * @recov_seq: The sequence for REC or SRR
Robert Love42e9a922008-12-09 15:10:17 -0800314 */
315struct fc_fcp_pkt {
Robert Love3a3b42b2009-11-03 11:47:39 -0800316 /* Housekeeping information */
317 struct fc_lport *lp;
318 u16 state;
319 u16 tgt_flags;
320 atomic_t ref_cnt;
321 spinlock_t scsi_pkt_lock;
322
323 /* SCSI I/O related information */
324 struct scsi_cmnd *cmd;
325 struct list_head list;
326
327 /* Timeout related information */
328 struct timer_list timer;
Robert Love42e9a922008-12-09 15:10:17 -0800329 struct completion tm_done;
Robert Love3a3b42b2009-11-03 11:47:39 -0800330 int wait_for_comp;
331 unsigned long start_time;
332 unsigned long end_time;
333 unsigned long last_pkt_time;
Robert Love42e9a922008-12-09 15:10:17 -0800334
Robert Love3a3b42b2009-11-03 11:47:39 -0800335 /* SCSI command and data transfer information */
336 u32 data_len;
Robert Love42e9a922008-12-09 15:10:17 -0800337
Robert Love3a3b42b2009-11-03 11:47:39 -0800338 /* Transport related veriables */
339 struct fcp_cmnd cdb_cmd;
340 size_t xfer_len;
341 u16 xfer_ddp;
342 u32 xfer_contig_end;
343 u16 max_payload;
Robert Love42e9a922008-12-09 15:10:17 -0800344
Robert Love3a3b42b2009-11-03 11:47:39 -0800345 /* SCSI/FCP return status */
346 u32 io_status;
347 u8 cdb_status;
348 u8 status_code;
349 u8 scsi_comp_flags;
350 u32 req_flags;
351 u32 scsi_resid;
352
353 /* Associated structures */
354 struct fc_rport *rport;
355 struct fc_seq *seq_ptr;
356
357 /* Error Processing information */
358 u8 recov_retry;
359 struct fc_seq *recov_seq;
Robert Love42e9a922008-12-09 15:10:17 -0800360};
361
362/*
363 * Structure and function definitions for managing Fibre Channel Exchanges
364 * and Sequences
365 *
366 * fc_exch holds state for one exchange and links to its active sequence.
367 *
368 * fc_seq holds the state for an individual sequence.
369 */
370
371struct fc_exch_mgr;
Vasu Dev96316092009-07-29 17:05:00 -0700372struct fc_exch_mgr_anchor;
Robert Love3a3b42b2009-11-03 11:47:39 -0800373extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
Robert Love42e9a922008-12-09 15:10:17 -0800374
Robert Love3a3b42b2009-11-03 11:47:39 -0800375/**
376 * struct fc_seq - FC sequence
377 * @id: The sequence ID
378 * @ssb_stat: Status flags for the sequence status block (SSB)
379 * @cnt: Number of frames sent so far
380 * @rec_data: FC-4 value for REC
Robert Love42e9a922008-12-09 15:10:17 -0800381 */
382struct fc_seq {
Robert Love3a3b42b2009-11-03 11:47:39 -0800383 u8 id;
384 u16 ssb_stat;
385 u16 cnt;
386 u32 rec_data;
Robert Love42e9a922008-12-09 15:10:17 -0800387};
388
389#define FC_EX_DONE (1 << 0) /* ep is completed */
390#define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
391
Robert Love3a3b42b2009-11-03 11:47:39 -0800392/**
393 * struct fc_exch - Fibre Channel Exchange
394 * @em: Exchange manager
395 * @pool: Exchange pool
396 * @state: The exchange's state
397 * @xid: The exchange ID
398 * @ex_list: Handle used by the EM to track free exchanges
399 * @ex_lock: Lock that protects the exchange
400 * @ex_refcnt: Reference count
401 * @timeout_work: Handle for timeout handler
402 * @lp: The local port that this exchange is on
403 * @oxid: Originator's exchange ID
404 * @rxid: Responder's exchange ID
405 * @oid: Originator's FCID
406 * @sid: Source FCID
407 * @did: Destination FCID
408 * @esb_stat: ESB exchange status
409 * @r_a_tov: Resouce allocation time out value (in msecs)
410 * @seq_id: The next sequence ID to use
411 * @f_ctl: F_CTL flags for the sequence
412 * @fh_type: The frame type
413 * @class: The class of service
414 * @seq: The sequence in use on this exchange
415 * @resp: Callback for responses on this exchange
416 * @destructor: Called when destroying the exchange
417 * @arg: Passed as a void pointer to the resp() callback
Robert Love42e9a922008-12-09 15:10:17 -0800418 *
419 * Locking notes: The ex_lock protects following items:
420 * state, esb_stat, f_ctl, seq.ssb_stat
421 * seq_id
422 * sequence allocation
423 */
424struct fc_exch {
Robert Love3a3b42b2009-11-03 11:47:39 -0800425 struct fc_exch_mgr *em;
426 struct fc_exch_pool *pool;
427 u32 state;
428 u16 xid;
429 struct list_head ex_list;
430 spinlock_t ex_lock;
431 atomic_t ex_refcnt;
432 struct delayed_work timeout_work;
433 struct fc_lport *lp;
434 u16 oxid;
435 u16 rxid;
436 u32 oid;
437 u32 sid;
438 u32 did;
439 u32 esb_stat;
440 u32 r_a_tov;
441 u8 seq_id;
442 u32 f_ctl;
443 u8 fh_type;
444 enum fc_class class;
445 struct fc_seq seq;
446
447 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
448 void *arg;
449
450 void (*destructor)(struct fc_seq *, void *);
451
Robert Love42e9a922008-12-09 15:10:17 -0800452};
453#define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
454
Robert Love42e9a922008-12-09 15:10:17 -0800455
Robert Love3a3b42b2009-11-03 11:47:39 -0800456struct libfc_function_template {
Robert Love42e9a922008-12-09 15:10:17 -0800457 /*
458 * Interface to send a FC frame
Robert Love0ae4d4a2009-02-27 10:55:39 -0800459 *
460 * STATUS: REQUIRED
Robert Love42e9a922008-12-09 15:10:17 -0800461 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800462 int (*frame_send)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800463
Robert Love42e9a922008-12-09 15:10:17 -0800464 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800465 * Interface to send ELS/CT frames
466 *
467 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800468 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800469 struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
470 struct fc_frame *, unsigned int op,
Robert Love42e9a922008-12-09 15:10:17 -0800471 void (*resp)(struct fc_seq *,
Robert Love3a3b42b2009-11-03 11:47:39 -0800472 struct fc_frame *, void *arg),
Robert Love42e9a922008-12-09 15:10:17 -0800473 void *arg, u32 timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800474
475 /*
476 * Send the FC frame payload using a new exchange and sequence.
477 *
Robert Love42e9a922008-12-09 15:10:17 -0800478 * The exchange response handler is set in this routine to resp()
479 * function pointer. It can be called in two scenarios: if a timeout
480 * occurs or if a response frame is received for the exchange. The
481 * fc_frame pointer in response handler will also indicate timeout
482 * as error using IS_ERR related macros.
483 *
484 * The exchange destructor handler is also set in this routine.
485 * The destructor handler is invoked by EM layer when exchange
486 * is about to free, this can be used by caller to free its
487 * resources along with exchange free.
488 *
489 * The arg is passed back to resp and destructor handler.
490 *
491 * The timeout value (in msec) for an exchange is set if non zero
492 * timer_msec argument is specified. The timer is canceled when
493 * it fires or when the exchange is done. The exchange timeout handler
494 * is registered by EM layer.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800495 *
496 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800497 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800498 struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *,
499 void (*resp)(struct fc_seq *,
500 struct fc_frame *,
501 void *),
502 void (*destructor)(struct fc_seq *,
503 void *),
504 void *, unsigned int timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800505
506 /*
Yi Zoub277d2a2009-02-27 14:07:21 -0800507 * Sets up the DDP context for a given exchange id on the given
508 * scatterlist if LLD supports DDP for large receive.
509 *
510 * STATUS: OPTIONAL
511 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800512 int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
513 unsigned int);
Yi Zoub277d2a2009-02-27 14:07:21 -0800514 /*
515 * Completes the DDP transfer and returns the length of data DDPed
516 * for the given exchange id.
517 *
518 * STATUS: OPTIONAL
519 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800520 int (*ddp_done)(struct fc_lport *, u16);
Yi Zoub277d2a2009-02-27 14:07:21 -0800521 /*
Yi Zoub84056b2009-11-20 14:55:19 -0800522 * Allow LLD to fill its own Link Error Status Block
523 *
524 * STATUS: OPTIONAL
525 */
526 void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
527 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800528 * Send a frame using an existing sequence and exchange.
529 *
530 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800531 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800532 int (*seq_send)(struct fc_lport *, struct fc_seq *,
533 struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800534
535 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800536 * Send an ELS response using infomation from a previous
537 * exchange and sequence.
538 *
539 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800540 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800541 void (*seq_els_rsp_send)(struct fc_seq *, enum fc_els_cmd,
542 struct fc_seq_els_data *);
Robert Love42e9a922008-12-09 15:10:17 -0800543
544 /*
545 * Abort an exchange and sequence. Generally called because of a
546 * exchange timeout or an abort from the upper layer.
547 *
548 * A timer_msec can be specified for abort timeout, if non-zero
549 * timer_msec value is specified then exchange resp handler
550 * will be called with timeout error if no response to abort.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800551 *
552 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800553 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800554 int (*seq_exch_abort)(const struct fc_seq *,
Robert Love42e9a922008-12-09 15:10:17 -0800555 unsigned int timer_msec);
556
557 /*
558 * Indicate that an exchange/sequence tuple is complete and the memory
559 * allocated for the related objects may be freed.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800560 *
561 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800562 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800563 void (*exch_done)(struct fc_seq *);
Robert Love42e9a922008-12-09 15:10:17 -0800564
565 /*
Robert Love42e9a922008-12-09 15:10:17 -0800566 * Start a new sequence on the same exchange/sequence tuple.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800567 *
568 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800569 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800570 struct fc_seq *(*seq_start_next)(struct fc_seq *);
Robert Love42e9a922008-12-09 15:10:17 -0800571
572 /*
573 * Reset an exchange manager, completing all sequences and exchanges.
574 * If s_id is non-zero, reset only exchanges originating from that FID.
575 * If d_id is non-zero, reset only exchanges sending to that FID.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800576 *
577 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800578 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800579 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -0800580
Robert Love0ae4d4a2009-02-27 10:55:39 -0800581 /*
582 * Flush the rport work queue. Generally used before shutdown.
583 *
584 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800585 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800586 void (*rport_flush_queue)(void);
Robert Love42e9a922008-12-09 15:10:17 -0800587
588 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800589 * Receive a frame for a local port.
590 *
591 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800592 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800593 void (*lport_recv)(struct fc_lport *, struct fc_seq *,
594 struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800595
Robert Love0ae4d4a2009-02-27 10:55:39 -0800596 /*
597 * Reset the local port.
598 *
599 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800600 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800601 int (*lport_reset)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800602
603 /*
Joe Eykholt093bb6a2009-11-03 11:49:05 -0800604 * Set the local port FC_ID.
605 *
606 * This may be provided by the LLD to allow it to be
607 * notified when the local port is assigned a FC-ID.
608 *
609 * The frame, if non-NULL, is the incoming frame with the
610 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
611 * address for the LLD. The frame pointer may be NULL if
612 * no MAC is associated with this assignment (LOGO or PLOGI).
613 *
614 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
615 *
616 * Note: this is called with the local port mutex held.
617 *
618 * STATUS: OPTIONAL
619 */
620 void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
621 struct fc_frame *);
622
623 /*
Robert Love9737e6a2009-08-25 14:02:59 -0700624 * Create a remote port with a given port ID
625 *
626 * STATUS: OPTIONAL
Robert Love5101ff92009-02-27 10:55:18 -0800627 */
Robert Love9737e6a2009-08-25 14:02:59 -0700628 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
Robert Love5101ff92009-02-27 10:55:18 -0800629
630 /*
Robert Love42e9a922008-12-09 15:10:17 -0800631 * Initiates the RP state machine. It is called from the LP module.
632 * This function will issue the following commands to the N_Port
633 * identified by the FC ID provided.
634 *
635 * - PLOGI
636 * - PRLI
637 * - RTV
Robert Love0ae4d4a2009-02-27 10:55:39 -0800638 *
639 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800640 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700641 int (*rport_login)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800642
643 /*
644 * Logoff, and remove the rport from the transport if
645 * it had been added. This will send a LOGO to the target.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800646 *
647 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800648 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700649 int (*rport_logoff)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800650
651 /*
652 * Recieve a request from a remote port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800653 *
654 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800655 */
656 void (*rport_recv_req)(struct fc_seq *, struct fc_frame *,
Joe Eykholt131203a2009-08-25 14:03:10 -0700657 struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800658
Robert Love0ae4d4a2009-02-27 10:55:39 -0800659 /*
660 * lookup an rport by it's port ID.
661 *
662 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800663 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700664 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
Robert Love42e9a922008-12-09 15:10:17 -0800665
666 /*
Joe Eykholtf211fa52009-08-25 14:01:01 -0700667 * Destroy an rport after final kref_put().
668 * The argument is a pointer to the kref inside the fc_rport_priv.
669 */
670 void (*rport_destroy)(struct kref *);
671
672 /*
Robert Love42e9a922008-12-09 15:10:17 -0800673 * Send a fcp cmd from fsp pkt.
674 * Called with the SCSI host lock unlocked and irqs disabled.
675 *
676 * The resp handler is called when FCP_RSP received.
677 *
Robert Love0ae4d4a2009-02-27 10:55:39 -0800678 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800679 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800680 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
681 void (*resp)(struct fc_seq *, struct fc_frame *,
682 void *));
Robert Love42e9a922008-12-09 15:10:17 -0800683
684 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800685 * Cleanup the FCP layer, used durring link down and reset
686 *
687 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800688 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800689 void (*fcp_cleanup)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800690
691 /*
692 * Abort all I/O on a local port
Robert Love0ae4d4a2009-02-27 10:55:39 -0800693 *
694 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800695 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800696 void (*fcp_abort_io)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800697
Robert Love0ae4d4a2009-02-27 10:55:39 -0800698 /*
699 * Receive a request for the discovery layer.
700 *
701 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800702 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800703 void (*disc_recv_req)(struct fc_seq *, struct fc_frame *,
704 struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800705
706 /*
707 * Start discovery for a local port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800708 *
709 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800710 */
711 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
712 enum fc_disc_event),
713 struct fc_lport *);
714
715 /*
716 * Stop discovery for a given lport. This will remove
717 * all discovered rports
Robert Love0ae4d4a2009-02-27 10:55:39 -0800718 *
719 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800720 */
721 void (*disc_stop) (struct fc_lport *);
722
723 /*
724 * Stop discovery for a given lport. This will block
725 * until all discovered rports are deleted from the
726 * FC transport class
Robert Love0ae4d4a2009-02-27 10:55:39 -0800727 *
728 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800729 */
730 void (*disc_stop_final) (struct fc_lport *);
731};
732
Robert Love3a3b42b2009-11-03 11:47:39 -0800733/**
734 * struct fc_disc - Discovery context
735 * @retry_count: Number of retries
736 * @pending: 1 if discovery is pending, 0 if not
737 * @requesting: 1 if discovery has been requested, 0 if not
738 * @seq_count: Number of sequences used for discovery
739 * @buf_len: Length of the discovery buffer
740 * @disc_id: Discovery ID
741 * @rports: List of discovered remote ports
Joe Eykholt06852302010-07-20 15:19:53 -0700742 * @priv: Private pointer for use by discovery code
Robert Love3a3b42b2009-11-03 11:47:39 -0800743 * @disc_mutex: Mutex that protects the discovery context
744 * @partial_buf: Partial name buffer (if names are returned
745 * in multiple frames)
746 * @disc_work: handle for delayed work context
747 * @disc_callback: Callback routine called when discovery completes
748 */
Robert Love42e9a922008-12-09 15:10:17 -0800749struct fc_disc {
Robert Love3a3b42b2009-11-03 11:47:39 -0800750 unsigned char retry_count;
751 unsigned char pending;
752 unsigned char requested;
753 unsigned short seq_count;
754 unsigned char buf_len;
755 u16 disc_id;
756
757 struct list_head rports;
Joe Eykholt06852302010-07-20 15:19:53 -0700758 void *priv;
Robert Love3a3b42b2009-11-03 11:47:39 -0800759 struct mutex disc_mutex;
760 struct fc_gpn_ft_resp partial_buf;
761 struct delayed_work disc_work;
Robert Love42e9a922008-12-09 15:10:17 -0800762
763 void (*disc_callback)(struct fc_lport *,
764 enum fc_disc_event);
Robert Love42e9a922008-12-09 15:10:17 -0800765};
766
Robert Love3a3b42b2009-11-03 11:47:39 -0800767/**
768 * struct fc_lport - Local port
769 * @host: The SCSI host associated with a local port
770 * @ema_list: Exchange manager anchor list
771 * @dns_rdata: The directory server remote port
772 * @ptp_rdata: Point to point remote port
773 * @scsi_priv: FCP layer internal data
774 * @disc: Discovery context
775 * @vports: Child vports if N_Port
776 * @vport: Parent vport if VN_Port
777 * @tt: Libfc function template
778 * @link_up: Link state (1 = link up, 0 = link down)
779 * @qfull: Queue state (1 queue is full, 0 queue is not full)
780 * @state: Identifies the state
781 * @boot_time: Timestamp indicating when the local port came online
782 * @host_stats: SCSI host statistics
783 * @dev_stats: FCoE device stats (TODO: libfc should not be
784 * FCoE aware)
785 * @retry_count: Number of retries in the current state
Robert Love7b2787e2010-05-07 15:18:41 -0700786 * @port_id: FC Port ID
Robert Love3a3b42b2009-11-03 11:47:39 -0800787 * @wwpn: World Wide Port Name
788 * @wwnn: World Wide Node Name
789 * @service_params: Common service parameters
790 * @e_d_tov: Error detection timeout value
791 * @r_a_tov: Resouce allocation timeout value
792 * @rnid_gen: RNID information
793 * @sg_supp: Indicates if scatter gather is supported
794 * @seq_offload: Indicates if sequence offload is supported
795 * @crc_offload: Indicates if CRC offload is supported
796 * @lro_enabled: Indicates if large receive offload is supported
797 * @does_npiv: Supports multiple vports
798 * @npiv_enabled: Switch/fabric allows NPIV
799 * @mfs: The maximum Fibre Channel payload size
800 * @max_retry_count: The maximum retry attempts
801 * @max_rport_retry_count: The maximum remote port retry attempts
Joe Eykholtf90377a2010-07-20 15:19:42 -0700802 * @rport_priv_size: Size needed by driver after struct fc_rport_priv
Robert Love3a3b42b2009-11-03 11:47:39 -0800803 * @lro_xid: The maximum XID for LRO
804 * @lso_max: The maximum large offload send size
805 * @fcts: FC-4 type mask
806 * @lp_mutex: Mutex to protect the local port
807 * @list: Handle for list of local ports
808 * @retry_work: Handle to local port for delayed retry context
809 */
Robert Love42e9a922008-12-09 15:10:17 -0800810struct fc_lport {
Robert Love42e9a922008-12-09 15:10:17 -0800811 /* Associations */
Robert Love3a3b42b2009-11-03 11:47:39 -0800812 struct Scsi_Host *host;
813 struct list_head ema_list;
814 struct fc_rport_priv *dns_rdata;
815 struct fc_rport_priv *ptp_rdata;
816 void *scsi_priv;
817 struct fc_disc disc;
818
819 /* Virtual port information */
820 struct list_head vports;
821 struct fc_vport *vport;
Robert Love42e9a922008-12-09 15:10:17 -0800822
823 /* Operational Information */
824 struct libfc_function_template tt;
Robert Love3a3b42b2009-11-03 11:47:39 -0800825 u8 link_up;
826 u8 qfull;
827 enum fc_lport_state state;
828 unsigned long boot_time;
829 struct fc_host_statistics host_stats;
830 struct fcoe_dev_stats *dev_stats;
831 u8 retry_count;
Robert Love42e9a922008-12-09 15:10:17 -0800832
Robert Love3a3b42b2009-11-03 11:47:39 -0800833 /* Fabric information */
Robert Love7b2787e2010-05-07 15:18:41 -0700834 u32 port_id;
Robert Love3a3b42b2009-11-03 11:47:39 -0800835 u64 wwpn;
836 u64 wwnn;
837 unsigned int service_params;
838 unsigned int e_d_tov;
839 unsigned int r_a_tov;
840 struct fc_els_rnid_gen rnid_gen;
Robert Love42e9a922008-12-09 15:10:17 -0800841
842 /* Capabilities */
Robert Love3a3b42b2009-11-03 11:47:39 -0800843 u32 sg_supp:1;
844 u32 seq_offload:1;
845 u32 crc_offload:1;
846 u32 lro_enabled:1;
847 u32 does_npiv:1;
848 u32 npiv_enabled:1;
849 u32 mfs;
850 u8 max_retry_count;
851 u8 max_rport_retry_count;
Joe Eykholtf90377a2010-07-20 15:19:42 -0700852 u16 rport_priv_size;
Robert Love3a3b42b2009-11-03 11:47:39 -0800853 u16 link_speed;
854 u16 link_supported_speeds;
855 u16 lro_xid;
856 unsigned int lso_max;
857 struct fc_ns_fts fcts;
Robert Love42e9a922008-12-09 15:10:17 -0800858
859 /* Miscellaneous */
Robert Love3a3b42b2009-11-03 11:47:39 -0800860 struct mutex lp_mutex;
861 struct list_head list;
862 struct delayed_work retry_work;
Robert Love42e9a922008-12-09 15:10:17 -0800863};
864
Robert Love34f42a02009-02-27 10:55:45 -0800865/*
Robert Love42e9a922008-12-09 15:10:17 -0800866 * FC_LPORT HELPER FUNCTIONS
867 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -0800868
869/**
870 * fc_lport_test_ready() - Determine if a local port is in the READY state
871 * @lport: The local port to test
872 */
873static inline int fc_lport_test_ready(struct fc_lport *lport)
Robert Love42e9a922008-12-09 15:10:17 -0800874{
Robert Love3a3b42b2009-11-03 11:47:39 -0800875 return lport->state == LPORT_ST_READY;
Robert Love42e9a922008-12-09 15:10:17 -0800876}
877
Robert Love3a3b42b2009-11-03 11:47:39 -0800878/**
879 * fc_set_wwnn() - Set the World Wide Node Name of a local port
880 * @lport: The local port whose WWNN is to be set
881 * @wwnn: The new WWNN
882 */
883static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
Robert Love42e9a922008-12-09 15:10:17 -0800884{
Robert Love3a3b42b2009-11-03 11:47:39 -0800885 lport->wwnn = wwnn;
Robert Love42e9a922008-12-09 15:10:17 -0800886}
887
Robert Love3a3b42b2009-11-03 11:47:39 -0800888/**
889 * fc_set_wwpn() - Set the World Wide Port Name of a local port
890 * @lport: The local port whose WWPN is to be set
891 * @wwnn: The new WWPN
892 */
893static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn)
Robert Love42e9a922008-12-09 15:10:17 -0800894{
Robert Love3a3b42b2009-11-03 11:47:39 -0800895 lport->wwpn = wwnn;
Robert Love42e9a922008-12-09 15:10:17 -0800896}
897
Robert Love3a3b42b2009-11-03 11:47:39 -0800898/**
899 * fc_lport_state_enter() - Change a local port's state
900 * @lport: The local port whose state is to change
901 * @state: The new state
902 */
903static inline void fc_lport_state_enter(struct fc_lport *lport,
Robert Love42e9a922008-12-09 15:10:17 -0800904 enum fc_lport_state state)
905{
Robert Love3a3b42b2009-11-03 11:47:39 -0800906 if (state != lport->state)
907 lport->retry_count = 0;
908 lport->state = state;
Robert Love42e9a922008-12-09 15:10:17 -0800909}
910
Robert Love3a3b42b2009-11-03 11:47:39 -0800911/**
912 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
913 * @lport: The local port whose statistics are to be initialized
914 */
915static inline int fc_lport_init_stats(struct fc_lport *lport)
Robert Love582b45b2009-03-31 15:51:50 -0700916{
Robert Love3a3b42b2009-11-03 11:47:39 -0800917 lport->dev_stats = alloc_percpu(struct fcoe_dev_stats);
918 if (!lport->dev_stats)
Robert Love582b45b2009-03-31 15:51:50 -0700919 return -ENOMEM;
920 return 0;
921}
922
Robert Love3a3b42b2009-11-03 11:47:39 -0800923/**
924 * fc_lport_free_stats() - Free memory for a local port's statistics
925 * @lport: The local port whose statistics are to be freed
926 */
927static inline void fc_lport_free_stats(struct fc_lport *lport)
Robert Love582b45b2009-03-31 15:51:50 -0700928{
Robert Love3a3b42b2009-11-03 11:47:39 -0800929 free_percpu(lport->dev_stats);
Vasu Deva0a25da2009-03-17 11:42:29 -0700930}
931
932/**
Robert Love3a3b42b2009-11-03 11:47:39 -0800933 * lport_priv() - Return the private data from a local port
934 * @lport: The local port whose private data is to be retreived
935 */
936static inline void *lport_priv(const struct fc_lport *lport)
937{
938 return (void *)(lport + 1);
939}
940
941/**
942 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
943 * LLD private data
944 * @sht: The SCSI host template
945 * @priv_size: Size of private data
Vasu Deva0a25da2009-03-17 11:42:29 -0700946 *
Chris Leech86221962009-11-03 11:46:08 -0800947 * Returns: libfc lport
Vasu Deva0a25da2009-03-17 11:42:29 -0700948 */
Chris Leech86221962009-11-03 11:46:08 -0800949static inline struct fc_lport *
Vasu Deva0a25da2009-03-17 11:42:29 -0700950libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
951{
Chris Leech86221962009-11-03 11:46:08 -0800952 struct fc_lport *lport;
953 struct Scsi_Host *shost;
954
955 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
956 if (!shost)
957 return NULL;
958 lport = shost_priv(shost);
959 lport->host = shost;
960 INIT_LIST_HEAD(&lport->ema_list);
Chris Leech174e1eb2009-11-03 11:46:14 -0800961 INIT_LIST_HEAD(&lport->vports);
Chris Leech86221962009-11-03 11:46:08 -0800962 return lport;
Vasu Deva0a25da2009-03-17 11:42:29 -0700963}
Robert Love42e9a922008-12-09 15:10:17 -0800964
Robert Love34f42a02009-02-27 10:55:45 -0800965/*
Robert Love3a3b42b2009-11-03 11:47:39 -0800966 * FC_FCP HELPER FUNCTIONS
967 *****************************/
968static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
969{
970 if (fsp && fsp->cmd)
971 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
972 return false;
973}
974
975/*
Robert Love42e9a922008-12-09 15:10:17 -0800976 * LOCAL PORT LAYER
977 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -0800978int fc_lport_init(struct fc_lport *);
979int fc_lport_destroy(struct fc_lport *);
980int fc_fabric_logoff(struct fc_lport *);
981int fc_fabric_login(struct fc_lport *);
Chris Leech8faecdd2009-11-03 11:46:19 -0800982void __fc_linkup(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800983void fc_linkup(struct fc_lport *);
Chris Leech8faecdd2009-11-03 11:46:19 -0800984void __fc_linkdown(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800985void fc_linkdown(struct fc_lport *);
Robert Love3a3b42b2009-11-03 11:47:39 -0800986void fc_vport_setlink(struct fc_lport *);
987void fc_vports_linkchange(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800988int fc_lport_config(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800989int fc_lport_reset(struct fc_lport *);
Robert Love3a3b42b2009-11-03 11:47:39 -0800990int fc_set_mfs(struct fc_lport *, u32 mfs);
991struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
992struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
993int fc_lport_bsg_request(struct fc_bsg_job *);
Steve Maa51ab392009-11-03 11:47:34 -0800994
995/*
Robert Love42e9a922008-12-09 15:10:17 -0800996 * REMOTE PORT LAYER
997 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -0800998int fc_rport_init(struct fc_lport *);
999void fc_rport_terminate_io(struct fc_rport *);
Robert Love42e9a922008-12-09 15:10:17 -08001000
Robert Love34f42a02009-02-27 10:55:45 -08001001/*
Robert Love42e9a922008-12-09 15:10:17 -08001002 * DISCOVERY LAYER
1003 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001004int fc_disc_init(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001005
Joe Eykholt06852302010-07-20 15:19:53 -07001006static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
1007{
1008 return container_of(disc, struct fc_lport, disc);
1009}
1010
Robert Love34f42a02009-02-27 10:55:45 -08001011/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001012 * FCP LAYER
Robert Love42e9a922008-12-09 15:10:17 -08001013 *****************************/
Robert Love42e9a922008-12-09 15:10:17 -08001014int fc_fcp_init(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001015void fc_fcp_destroy(struct fc_lport *);
1016
Robert Love34f42a02009-02-27 10:55:45 -08001017/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001018 * SCSI INTERACTION LAYER
1019 *****************************/
1020int fc_queuecommand(struct scsi_cmnd *,
1021 void (*done)(struct scsi_cmnd *));
1022int fc_eh_abort(struct scsi_cmnd *);
1023int fc_eh_device_reset(struct scsi_cmnd *);
1024int fc_eh_host_reset(struct scsi_cmnd *);
1025int fc_slave_alloc(struct scsi_device *);
1026int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason);
1027int fc_change_queue_type(struct scsi_device *, int tag_type);
1028
1029/*
Robert Love42e9a922008-12-09 15:10:17 -08001030 * ELS/CT interface
1031 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001032int fc_elsct_init(struct fc_lport *);
1033struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
1034 struct fc_frame *,
Chris Leech11b56182009-11-03 11:46:29 -08001035 unsigned int op,
1036 void (*resp)(struct fc_seq *,
Robert Love3a3b42b2009-11-03 11:47:39 -08001037 struct fc_frame *,
Chris Leech11b56182009-11-03 11:46:29 -08001038 void *arg),
1039 void *arg, u32 timer_msec);
1040void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
1041void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
Robert Love42e9a922008-12-09 15:10:17 -08001042
1043
Robert Love34f42a02009-02-27 10:55:45 -08001044/*
Robert Love42e9a922008-12-09 15:10:17 -08001045 * EXCHANGE MANAGER LAYER
1046 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001047int fc_exch_init(struct fc_lport *);
1048struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
1049 struct fc_exch_mgr *,
Vasu Dev96316092009-07-29 17:05:00 -07001050 bool (*match)(struct fc_frame *));
Robert Love3a3b42b2009-11-03 11:47:39 -08001051void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
Chris Leech174e1eb2009-11-03 11:46:14 -08001052int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
Robert Love3a3b42b2009-11-03 11:47:39 -08001053struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
1054 u16 min_xid, u16 max_xid,
Vasu Dev52ff8782009-07-29 17:05:10 -07001055 bool (*match)(struct fc_frame *));
Robert Love3a3b42b2009-11-03 11:47:39 -08001056void fc_exch_mgr_free(struct fc_lport *);
1057void fc_exch_recv(struct fc_lport *, struct fc_frame *);
Abhijeet Joglekar1f6ff362009-02-27 10:54:35 -08001058void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -08001059
1060/*
1061 * Functions for fc_functions_template
1062 */
Robert Love3a3b42b2009-11-03 11:47:39 -08001063void fc_get_host_speed(struct Scsi_Host *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001064void fc_get_host_port_state(struct Scsi_Host *);
1065void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
Robert Love42e9a922008-12-09 15:10:17 -08001066struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1067
Robert Love42e9a922008-12-09 15:10:17 -08001068#endif /* _LIBFC_H_ */