blob: 8f9dfba3fcf0379a27438d7f2723399f036287e2 [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>
Neerav Parikhd78c3172012-01-22 17:30:05 -080033#include <scsi/fc/fc_ms.h>
Robert Love42e9a922008-12-09 15:10:17 -080034#include <scsi/fc/fc_els.h>
35#include <scsi/fc/fc_gs.h>
36
37#include <scsi/fc_frame.h>
38
Joe Eykholt96ad8462011-01-28 16:04:02 -080039#define FC_FC4_PROV_SIZE (FC_TYPE_FCP + 1) /* size of tables */
40
Robert Love42e9a922008-12-09 15:10:17 -080041/*
42 * libfc error codes
43 */
44#define FC_NO_ERR 0 /* no error */
45#define FC_EX_TIMEOUT 1 /* Exchange timeout */
46#define FC_EX_CLOSED 2 /* Exchange closed */
47
Robert Love3a3b42b2009-11-03 11:47:39 -080048/**
49 * enum fc_lport_state - Local port states
50 * @LPORT_ST_DISABLED: Disabled
51 * @LPORT_ST_FLOGI: Fabric login (FLOGI) sent
52 * @LPORT_ST_DNS: Waiting for name server remote port to become ready
53 * @LPORT_ST_RPN_ID: Register port name by ID (RPN_ID) sent
54 * @LPORT_ST_RFT_ID: Register Fibre Channel types by ID (RFT_ID) sent
Joe Eykholtab593b12009-11-03 11:49:27 -080055 * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent
Neerav Parikhd78c3172012-01-22 17:30:05 -080056 * @LPORT_ST_FDMI: Waiting for mgmt server rport to become ready
57 * @LPORT_ST_RHBA:
Robert Love3a3b42b2009-11-03 11:47:39 -080058 * @LPORT_ST_SCR: State Change Register (SCR) sent
59 * @LPORT_ST_READY: Ready for use
60 * @LPORT_ST_LOGO: Local port logout (LOGO) sent
61 * @LPORT_ST_RESET: Local port reset
Robert Love42e9a922008-12-09 15:10:17 -080062 */
Robert Love42e9a922008-12-09 15:10:17 -080063enum fc_lport_state {
Joe Eykholtb1d9fd52009-07-29 17:04:22 -070064 LPORT_ST_DISABLED = 0,
Robert Love42e9a922008-12-09 15:10:17 -080065 LPORT_ST_FLOGI,
66 LPORT_ST_DNS,
Chris Leechc9c7bd72009-11-03 11:46:51 -080067 LPORT_ST_RNN_ID,
Chris Leech5baa17c2009-11-03 11:46:56 -080068 LPORT_ST_RSNN_NN,
Chris Leechc9866a52009-11-03 11:47:01 -080069 LPORT_ST_RSPN_ID,
Robert Love42e9a922008-12-09 15:10:17 -080070 LPORT_ST_RFT_ID,
Joe Eykholtab593b12009-11-03 11:49:27 -080071 LPORT_ST_RFF_ID,
Neerav Parikhd78c3172012-01-22 17:30:05 -080072 LPORT_ST_FDMI,
73 LPORT_ST_RHBA,
74 LPORT_ST_RPA,
75 LPORT_ST_DHBA,
76 LPORT_ST_DPRT,
Robert Love42e9a922008-12-09 15:10:17 -080077 LPORT_ST_SCR,
78 LPORT_ST_READY,
79 LPORT_ST_LOGO,
80 LPORT_ST_RESET
81};
82
83enum fc_disc_event {
84 DISC_EV_NONE = 0,
85 DISC_EV_SUCCESS,
86 DISC_EV_FAILED
87};
88
Robert Love3a3b42b2009-11-03 11:47:39 -080089/**
90 * enum fc_rport_state - Remote port states
91 * @RPORT_ST_INIT: Initialized
Joe Eykholta7b12a22010-07-20 15:20:08 -070092 * @RPORT_ST_FLOGI: Waiting for FLOGI completion for point-to-multipoint
93 * @RPORT_ST_PLOGI_WAIT: Waiting for peer to login for point-to-multipoint
Robert Love3a3b42b2009-11-03 11:47:39 -080094 * @RPORT_ST_PLOGI: Waiting for PLOGI completion
95 * @RPORT_ST_PRLI: Waiting for PRLI completion
96 * @RPORT_ST_RTV: Waiting for RTV completion
97 * @RPORT_ST_READY: Ready for use
Robert Love3a3b42b2009-11-03 11:47:39 -080098 * @RPORT_ST_ADISC: Discover Address sent
99 * @RPORT_ST_DELETE: Remote port being deleted
Robert Love3a3b42b2009-11-03 11:47:39 -0800100*/
Robert Love42e9a922008-12-09 15:10:17 -0800101enum fc_rport_state {
Robert Love3a3b42b2009-11-03 11:47:39 -0800102 RPORT_ST_INIT,
Joe Eykholta7b12a22010-07-20 15:20:08 -0700103 RPORT_ST_FLOGI,
104 RPORT_ST_PLOGI_WAIT,
Robert Love3a3b42b2009-11-03 11:47:39 -0800105 RPORT_ST_PLOGI,
106 RPORT_ST_PRLI,
107 RPORT_ST_RTV,
108 RPORT_ST_READY,
Robert Love3a3b42b2009-11-03 11:47:39 -0800109 RPORT_ST_ADISC,
110 RPORT_ST_DELETE,
Robert Love42e9a922008-12-09 15:10:17 -0800111};
112
Robert Love42e9a922008-12-09 15:10:17 -0800113/**
114 * struct fc_disc_port - temporary discovery port to hold rport identifiers
Robert Love9737e6a2009-08-25 14:02:59 -0700115 * @lp: Fibre Channel host port instance
116 * @peers: Node for list management during discovery and RSCN processing
117 * @rport_work: Work struct for starting the rport state machine
118 * @port_id: Port ID of the discovered port
Robert Love42e9a922008-12-09 15:10:17 -0800119 */
120struct fc_disc_port {
Robert Love3a3b42b2009-11-03 11:47:39 -0800121 struct fc_lport *lp;
122 struct list_head peers;
123 struct work_struct rport_work;
124 u32 port_id;
Robert Love42e9a922008-12-09 15:10:17 -0800125};
126
Robert Love3a3b42b2009-11-03 11:47:39 -0800127/**
128 * enum fc_rport_event - Remote port events
129 * @RPORT_EV_NONE: No event
130 * @RPORT_EV_READY: Remote port is ready for use
131 * @RPORT_EV_FAILED: State machine failed, remote port is not ready
132 * @RPORT_EV_STOP: Remote port has been stopped
133 * @RPORT_EV_LOGO: Remote port logout (LOGO) sent
134 */
Robert Love42e9a922008-12-09 15:10:17 -0800135enum fc_rport_event {
136 RPORT_EV_NONE = 0,
Joe Eykholt4c0f62b2009-08-25 14:01:12 -0700137 RPORT_EV_READY,
Robert Love42e9a922008-12-09 15:10:17 -0800138 RPORT_EV_FAILED,
139 RPORT_EV_STOP,
140 RPORT_EV_LOGO
141};
142
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700143struct fc_rport_priv;
144
Robert Love3a3b42b2009-11-03 11:47:39 -0800145/**
146 * struct fc_rport_operations - Operations for a remote port
147 * @event_callback: Function to be called for remote port events
148 */
Robert Love42e9a922008-12-09 15:10:17 -0800149struct fc_rport_operations {
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700150 void (*event_callback)(struct fc_lport *, struct fc_rport_priv *,
Robert Love42e9a922008-12-09 15:10:17 -0800151 enum fc_rport_event);
152};
153
154/**
155 * struct fc_rport_libfc_priv - libfc internal information about a remote port
Robert Love3a3b42b2009-11-03 11:47:39 -0800156 * @local_port: The associated local port
157 * @rp_state: Indicates READY for I/O or DELETE when blocked
158 * @flags: REC and RETRY supported flags
159 * @e_d_tov: Error detect timeout value (in msec)
160 * @r_a_tov: Resource allocation timeout value (in msec)
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700161 */
162struct fc_rport_libfc_priv {
163 struct fc_lport *local_port;
164 enum fc_rport_state rp_state;
165 u16 flags;
166 #define FC_RP_FLAGS_REC_SUPPORTED (1 << 0)
167 #define FC_RP_FLAGS_RETRY (1 << 1)
Joe Eykholt4b2164d2010-06-11 16:44:51 -0700168 #define FC_RP_STARTED (1 << 2)
Bhanu Prakash Gollapudi75a27922011-01-28 16:05:27 -0800169 #define FC_RP_FLAGS_CONF_REQ (1 << 3)
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700170 unsigned int e_d_tov;
171 unsigned int r_a_tov;
172};
173
174/**
Robert Love3a3b42b2009-11-03 11:47:39 -0800175 * struct fc_rport_priv - libfc remote port and discovery info
176 * @local_port: The associated local port
177 * @rport: The FC transport remote port
178 * @kref: Reference counter
179 * @rp_state: Enumeration that tracks progress of PLOGI, PRLI,
180 * and RTV exchanges
181 * @ids: The remote port identifiers and roles
Joe Eykholt4b2164d2010-06-11 16:44:51 -0700182 * @flags: STARTED, REC and RETRY_SUPPORTED flags
Robert Love3a3b42b2009-11-03 11:47:39 -0800183 * @max_seq: Maximum number of concurrent sequences
184 * @disc_id: The discovery identifier
185 * @maxframe_size: The maximum frame size
186 * @retries: The retry count for the current state
Joe Eykholtf0342602010-06-11 16:44:57 -0700187 * @major_retries: The retry count for the entire PLOGI/PRLI state machine
Robert Love3a3b42b2009-11-03 11:47:39 -0800188 * @e_d_tov: Error detect timeout value (in msec)
189 * @r_a_tov: Resource allocation timeout value (in msec)
190 * @rp_mutex: The mutex that protects the remote port
191 * @retry_work: Handle for retries
192 * @event_callback: Callback when READY, FAILED or LOGO states complete
Joe Eykholt96ad8462011-01-28 16:04:02 -0800193 * @prli_count: Count of open PRLI sessions in providers
Joe Eykholt42e90412010-07-20 15:19:37 -0700194 * @rcu: Structure used for freeing in an RCU-safe manner
Robert Love42e9a922008-12-09 15:10:17 -0800195 */
Joe Eykholt9e9d0452009-08-25 14:01:18 -0700196struct fc_rport_priv {
Robert Love3a3b42b2009-11-03 11:47:39 -0800197 struct fc_lport *local_port;
198 struct fc_rport *rport;
199 struct kref kref;
200 enum fc_rport_state rp_state;
Joe Eykholtf211fa52009-08-25 14:01:01 -0700201 struct fc_rport_identifiers ids;
Robert Love3a3b42b2009-11-03 11:47:39 -0800202 u16 flags;
203 u16 max_seq;
204 u16 disc_id;
205 u16 maxframe_size;
206 unsigned int retries;
Joe Eykholtf0342602010-06-11 16:44:57 -0700207 unsigned int major_retries;
Robert Love3a3b42b2009-11-03 11:47:39 -0800208 unsigned int e_d_tov;
209 unsigned int r_a_tov;
210 struct mutex rp_mutex;
211 struct delayed_work retry_work;
212 enum fc_rport_event event;
213 struct fc_rport_operations *ops;
214 struct list_head peers;
215 struct work_struct event_work;
216 u32 supported_classes;
Joe Eykholt96ad8462011-01-28 16:04:02 -0800217 u16 prli_count;
Joe Eykholt42e90412010-07-20 15:19:37 -0700218 struct rcu_head rcu;
Bhanu Prakash Gollapudi75a27922011-01-28 16:05:27 -0800219 u16 sp_features;
220 u8 spp_type;
221 void (*lld_event_callback)(struct fc_lport *,
222 struct fc_rport_priv *,
223 enum fc_rport_event);
Robert Love42e9a922008-12-09 15:10:17 -0800224};
225
Robert Love3a3b42b2009-11-03 11:47:39 -0800226/**
227 * struct fcoe_dev_stats - fcoe stats structure
228 * @SecondsSinceLastReset: Seconds since the last reset
229 * @TxFrames: Number of transmitted frames
230 * @TxWords: Number of transmitted words
231 * @RxFrames: Number of received frames
232 * @RxWords: Number of received words
233 * @ErrorFrames: Number of received error frames
234 * @DumpedFrames: Number of dumped frames
235 * @LinkFailureCount: Number of link failures
236 * @LossOfSignalCount: Number for signal losses
237 * @InvalidTxWordCount: Number of invalid transmitted words
238 * @InvalidCRCCount: Number of invalid CRCs
239 * @InputRequests: Number of input requests
240 * @OutputRequests: Number of output requests
241 * @ControlRequests: Number of control requests
Joe Eykholt5f0e3852010-11-30 16:20:18 -0800242 * @InputBytes: Number of received bytes
243 * @OutputBytes: Number of transmitted bytes
Yi Zou6580bbd2009-11-20 14:54:52 -0800244 * @VLinkFailureCount: Number of virtual link failures
245 * @MissDiscAdvCount: Number of missing FIP discovery advertisement
Robert Love42e9a922008-12-09 15:10:17 -0800246 */
247struct fcoe_dev_stats {
248 u64 SecondsSinceLastReset;
249 u64 TxFrames;
250 u64 TxWords;
251 u64 RxFrames;
252 u64 RxWords;
253 u64 ErrorFrames;
254 u64 DumpedFrames;
255 u64 LinkFailureCount;
256 u64 LossOfSignalCount;
257 u64 InvalidTxWordCount;
258 u64 InvalidCRCCount;
259 u64 InputRequests;
260 u64 OutputRequests;
261 u64 ControlRequests;
Joe Eykholt5f0e3852010-11-30 16:20:18 -0800262 u64 InputBytes;
263 u64 OutputBytes;
Yi Zou6580bbd2009-11-20 14:54:52 -0800264 u64 VLinkFailureCount;
265 u64 MissDiscAdvCount;
Robert Love42e9a922008-12-09 15:10:17 -0800266};
267
Robert Love3a3b42b2009-11-03 11:47:39 -0800268/**
269 * struct fc_seq_els_data - ELS data used for passing ELS specific responses
Robert Love3a3b42b2009-11-03 11:47:39 -0800270 * @reason: The reason for rejection
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300271 * @explan: The explanation of the rejection
Robert Love3a3b42b2009-11-03 11:47:39 -0800272 *
273 * Mainly used by the exchange manager layer.
Robert Love42e9a922008-12-09 15:10:17 -0800274 */
275struct fc_seq_els_data {
Robert Love42e9a922008-12-09 15:10:17 -0800276 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
Robert Love3a3b42b2009-11-03 11:47:39 -0800284 * @ref_cnt: Reference count
285 * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the
286 * host_lock if both are to be held at the same time)
287 * @cmd: The SCSI command (set and clear with the host_lock held)
288 * @list: Tracks queued commands (accessed with the host_lock held)
289 * @timer: The command timer
290 * @tm_done: Completion indicator
291 * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies)
Robert Love3a3b42b2009-11-03 11:47:39 -0800292 * @data_len: The length of the data
293 * @cdb_cmd: The CDB command
294 * @xfer_len: The transfer length
295 * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange
296 * will be set here if DDP was setup)
297 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
298 * (Tx and Rx)
299 * @max_payload: The maximum payload size (in bytes)
300 * @io_status: SCSI result (upper 24 bits)
301 * @cdb_status: CDB status
302 * @status_code: FCP I/O status
303 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
304 * @req_flags: Request flags (bit 0: read bit:1 write)
305 * @scsi_resid: SCSI residule length
306 * @rport: The remote port that the SCSI command is targeted at
307 * @seq_ptr: The sequence that will carry the SCSI command
308 * @recov_retry: Number of recovery retries
309 * @recov_seq: The sequence for REC or SRR
Robert Love42e9a922008-12-09 15:10:17 -0800310 */
311struct fc_fcp_pkt {
Robert Love3a3b42b2009-11-03 11:47:39 -0800312 spinlock_t scsi_pkt_lock;
Vasu Deved26cfe2011-09-27 21:37:57 -0700313 atomic_t ref_cnt;
314
315 /* SCSI command and data transfer information */
316 u32 data_len;
Robert Love3a3b42b2009-11-03 11:47:39 -0800317
318 /* SCSI I/O related information */
319 struct scsi_cmnd *cmd;
320 struct list_head list;
321
Vasu Deved26cfe2011-09-27 21:37:57 -0700322 /* Housekeeping information */
323 struct fc_lport *lp;
324 u8 state;
Robert Love42e9a922008-12-09 15:10:17 -0800325
Robert Love3a3b42b2009-11-03 11:47:39 -0800326 /* SCSI/FCP return status */
Robert Love3a3b42b2009-11-03 11:47:39 -0800327 u8 cdb_status;
328 u8 status_code;
329 u8 scsi_comp_flags;
Vasu Deved26cfe2011-09-27 21:37:57 -0700330 u32 io_status;
Robert Love3a3b42b2009-11-03 11:47:39 -0800331 u32 req_flags;
332 u32 scsi_resid;
333
Vasu Deved26cfe2011-09-27 21:37:57 -0700334 /* Transport related veriables */
335 size_t xfer_len;
336 struct fcp_cmnd cdb_cmd;
337 u32 xfer_contig_end;
338 u16 max_payload;
339 u16 xfer_ddp;
340
Robert Love3a3b42b2009-11-03 11:47:39 -0800341 /* Associated structures */
342 struct fc_rport *rport;
343 struct fc_seq *seq_ptr;
344
Vasu Deved26cfe2011-09-27 21:37:57 -0700345 /* Timeout/error related information */
346 struct timer_list timer;
347 int wait_for_comp;
348 u32 recov_retry;
Robert Love3a3b42b2009-11-03 11:47:39 -0800349 struct fc_seq *recov_seq;
Vasu Deved26cfe2011-09-27 21:37:57 -0700350 struct completion tm_done;
351} ____cacheline_aligned_in_smp;
Robert Love42e9a922008-12-09 15:10:17 -0800352
353/*
354 * Structure and function definitions for managing Fibre Channel Exchanges
355 * and Sequences
356 *
357 * fc_exch holds state for one exchange and links to its active sequence.
358 *
359 * fc_seq holds the state for an individual sequence.
360 */
361
362struct fc_exch_mgr;
Vasu Dev96316092009-07-29 17:05:00 -0700363struct fc_exch_mgr_anchor;
Robert Love3a3b42b2009-11-03 11:47:39 -0800364extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
Robert Love42e9a922008-12-09 15:10:17 -0800365
Robert Love3a3b42b2009-11-03 11:47:39 -0800366/**
367 * struct fc_seq - FC sequence
368 * @id: The sequence ID
369 * @ssb_stat: Status flags for the sequence status block (SSB)
370 * @cnt: Number of frames sent so far
371 * @rec_data: FC-4 value for REC
Robert Love42e9a922008-12-09 15:10:17 -0800372 */
373struct fc_seq {
Robert Love3a3b42b2009-11-03 11:47:39 -0800374 u8 id;
375 u16 ssb_stat;
376 u16 cnt;
377 u32 rec_data;
Robert Love42e9a922008-12-09 15:10:17 -0800378};
379
380#define FC_EX_DONE (1 << 0) /* ep is completed */
381#define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
382
Robert Love3a3b42b2009-11-03 11:47:39 -0800383/**
384 * struct fc_exch - Fibre Channel Exchange
385 * @em: Exchange manager
386 * @pool: Exchange pool
387 * @state: The exchange's state
388 * @xid: The exchange ID
389 * @ex_list: Handle used by the EM to track free exchanges
390 * @ex_lock: Lock that protects the exchange
391 * @ex_refcnt: Reference count
392 * @timeout_work: Handle for timeout handler
393 * @lp: The local port that this exchange is on
394 * @oxid: Originator's exchange ID
395 * @rxid: Responder's exchange ID
396 * @oid: Originator's FCID
397 * @sid: Source FCID
398 * @did: Destination FCID
399 * @esb_stat: ESB exchange status
400 * @r_a_tov: Resouce allocation time out value (in msecs)
401 * @seq_id: The next sequence ID to use
Joe Eykholtf60e12e2010-07-20 15:20:14 -0700402 * @encaps: encapsulation information for lower-level driver
Robert Love3a3b42b2009-11-03 11:47:39 -0800403 * @f_ctl: F_CTL flags for the sequence
404 * @fh_type: The frame type
405 * @class: The class of service
406 * @seq: The sequence in use on this exchange
407 * @resp: Callback for responses on this exchange
408 * @destructor: Called when destroying the exchange
409 * @arg: Passed as a void pointer to the resp() callback
Robert Love42e9a922008-12-09 15:10:17 -0800410 *
411 * Locking notes: The ex_lock protects following items:
412 * state, esb_stat, f_ctl, seq.ssb_stat
413 * seq_id
414 * sequence allocation
415 */
416struct fc_exch {
Robert Love3a3b42b2009-11-03 11:47:39 -0800417 spinlock_t ex_lock;
418 atomic_t ex_refcnt;
Vasu Dev49a19882011-09-27 21:38:02 -0700419 enum fc_class class;
420 struct fc_exch_mgr *em;
421 struct fc_exch_pool *pool;
422 struct list_head ex_list;
Robert Love3a3b42b2009-11-03 11:47:39 -0800423 struct fc_lport *lp;
Vasu Dev49a19882011-09-27 21:38:02 -0700424 u32 esb_stat;
425 u8 state;
426 u8 fh_type;
427 u8 seq_id;
428 u8 encaps;
429 u16 xid;
Robert Love3a3b42b2009-11-03 11:47:39 -0800430 u16 oxid;
431 u16 rxid;
432 u32 oid;
433 u32 sid;
434 u32 did;
Robert Love3a3b42b2009-11-03 11:47:39 -0800435 u32 r_a_tov;
Robert Love3a3b42b2009-11-03 11:47:39 -0800436 u32 f_ctl;
Vasu Dev49a19882011-09-27 21:38:02 -0700437 struct fc_seq seq;
Robert Love3a3b42b2009-11-03 11:47:39 -0800438 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
439 void *arg;
Robert Love3a3b42b2009-11-03 11:47:39 -0800440 void (*destructor)(struct fc_seq *, void *);
Vasu Dev49a19882011-09-27 21:38:02 -0700441 struct delayed_work timeout_work;
442} ____cacheline_aligned_in_smp;
Robert Love42e9a922008-12-09 15:10:17 -0800443#define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
444
Robert Love42e9a922008-12-09 15:10:17 -0800445
Robert Love3a3b42b2009-11-03 11:47:39 -0800446struct libfc_function_template {
Robert Love42e9a922008-12-09 15:10:17 -0800447 /*
448 * Interface to send a FC frame
Robert Love0ae4d4a2009-02-27 10:55:39 -0800449 *
450 * STATUS: REQUIRED
Robert Love42e9a922008-12-09 15:10:17 -0800451 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800452 int (*frame_send)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800453
Robert Love42e9a922008-12-09 15:10:17 -0800454 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800455 * Interface to send ELS/CT frames
456 *
457 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800458 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800459 struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
460 struct fc_frame *, unsigned int op,
Robert Love42e9a922008-12-09 15:10:17 -0800461 void (*resp)(struct fc_seq *,
Robert Love3a3b42b2009-11-03 11:47:39 -0800462 struct fc_frame *, void *arg),
Robert Love42e9a922008-12-09 15:10:17 -0800463 void *arg, u32 timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800464
465 /*
466 * Send the FC frame payload using a new exchange and sequence.
467 *
Robert Love42e9a922008-12-09 15:10:17 -0800468 * The exchange response handler is set in this routine to resp()
469 * function pointer. It can be called in two scenarios: if a timeout
470 * occurs or if a response frame is received for the exchange. The
471 * fc_frame pointer in response handler will also indicate timeout
472 * as error using IS_ERR related macros.
473 *
474 * The exchange destructor handler is also set in this routine.
475 * The destructor handler is invoked by EM layer when exchange
476 * is about to free, this can be used by caller to free its
477 * resources along with exchange free.
478 *
479 * The arg is passed back to resp and destructor handler.
480 *
481 * The timeout value (in msec) for an exchange is set if non zero
482 * timer_msec argument is specified. The timer is canceled when
483 * it fires or when the exchange is done. The exchange timeout handler
484 * is registered by EM layer.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800485 *
486 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800487 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800488 struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *,
489 void (*resp)(struct fc_seq *,
490 struct fc_frame *,
491 void *),
492 void (*destructor)(struct fc_seq *,
493 void *),
494 void *, unsigned int timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800495
496 /*
Yi Zoub277d2a2009-02-27 14:07:21 -0800497 * Sets up the DDP context for a given exchange id on the given
498 * scatterlist if LLD supports DDP for large receive.
499 *
500 * STATUS: OPTIONAL
501 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800502 int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
503 unsigned int);
Yi Zoub277d2a2009-02-27 14:07:21 -0800504 /*
505 * Completes the DDP transfer and returns the length of data DDPed
506 * for the given exchange id.
507 *
508 * STATUS: OPTIONAL
509 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800510 int (*ddp_done)(struct fc_lport *, u16);
Yi Zoub277d2a2009-02-27 14:07:21 -0800511 /*
Yi Zou33dc3622011-06-20 16:59:05 -0700512 * Sets up the DDP context for a given exchange id on the given
513 * scatterlist if LLD supports DDP for FCoE target.
514 *
515 * STATUS: OPTIONAL
516 */
517 int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *,
518 unsigned int);
519 /*
Yi Zoub84056b2009-11-20 14:55:19 -0800520 * Allow LLD to fill its own Link Error Status Block
521 *
522 * STATUS: OPTIONAL
523 */
524 void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
525 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800526 * Send a frame using an existing sequence and exchange.
527 *
528 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800529 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800530 int (*seq_send)(struct fc_lport *, struct fc_seq *,
531 struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800532
533 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300534 * Send an ELS response using information from the received frame.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800535 *
536 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800537 */
Joe Eykholt922611562010-07-20 15:21:12 -0700538 void (*seq_els_rsp_send)(struct fc_frame *, enum fc_els_cmd,
Robert Love3a3b42b2009-11-03 11:47:39 -0800539 struct fc_seq_els_data *);
Robert Love42e9a922008-12-09 15:10:17 -0800540
541 /*
542 * Abort an exchange and sequence. Generally called because of a
543 * exchange timeout or an abort from the upper layer.
544 *
545 * A timer_msec can be specified for abort timeout, if non-zero
546 * timer_msec value is specified then exchange resp handler
547 * will be called with timeout error if no response to abort.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800548 *
549 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800550 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800551 int (*seq_exch_abort)(const struct fc_seq *,
Robert Love42e9a922008-12-09 15:10:17 -0800552 unsigned int timer_msec);
553
554 /*
555 * Indicate that an exchange/sequence tuple is complete and the memory
556 * allocated for the related objects may be freed.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800557 *
558 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800559 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800560 void (*exch_done)(struct fc_seq *);
Robert Love42e9a922008-12-09 15:10:17 -0800561
562 /*
Robert Love42e9a922008-12-09 15:10:17 -0800563 * Start a new sequence on the same exchange/sequence tuple.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800564 *
565 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800566 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800567 struct fc_seq *(*seq_start_next)(struct fc_seq *);
Robert Love42e9a922008-12-09 15:10:17 -0800568
569 /*
Joe Eykholt1a5c2d72011-01-28 16:04:08 -0800570 * Set a response handler for the exchange of the sequence.
571 *
572 * STATUS: OPTIONAL
573 */
574 void (*seq_set_resp)(struct fc_seq *sp,
575 void (*resp)(struct fc_seq *, struct fc_frame *,
576 void *),
577 void *arg);
578
579 /*
Joe Eykholt239e8102010-07-20 15:21:07 -0700580 * Assign a sequence for an incoming request frame.
581 *
582 * STATUS: OPTIONAL
583 */
584 struct fc_seq *(*seq_assign)(struct fc_lport *, struct fc_frame *);
585
586 /*
Joe Eykholt62bdb642011-01-28 16:04:34 -0800587 * Release the reference on the sequence returned by seq_assign().
588 *
589 * STATUS: OPTIONAL
590 */
591 void (*seq_release)(struct fc_seq *);
592
593 /*
Robert Love42e9a922008-12-09 15:10:17 -0800594 * Reset an exchange manager, completing all sequences and exchanges.
595 * If s_id is non-zero, reset only exchanges originating from that FID.
596 * If d_id is non-zero, reset only exchanges sending to that FID.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800597 *
598 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800599 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800600 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -0800601
Robert Love0ae4d4a2009-02-27 10:55:39 -0800602 /*
603 * Flush the rport work queue. Generally used before shutdown.
604 *
605 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800606 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800607 void (*rport_flush_queue)(void);
Robert Love42e9a922008-12-09 15:10:17 -0800608
609 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800610 * Receive a frame for a local port.
611 *
612 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800613 */
Joe Eykholt922611562010-07-20 15:21:12 -0700614 void (*lport_recv)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800615
Robert Love0ae4d4a2009-02-27 10:55:39 -0800616 /*
617 * Reset the local port.
618 *
619 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800620 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800621 int (*lport_reset)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800622
623 /*
Joe Eykholt093bb6a2009-11-03 11:49:05 -0800624 * Set the local port FC_ID.
625 *
626 * This may be provided by the LLD to allow it to be
627 * notified when the local port is assigned a FC-ID.
628 *
629 * The frame, if non-NULL, is the incoming frame with the
630 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
631 * address for the LLD. The frame pointer may be NULL if
632 * no MAC is associated with this assignment (LOGO or PLOGI).
633 *
634 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
635 *
636 * Note: this is called with the local port mutex held.
637 *
638 * STATUS: OPTIONAL
639 */
640 void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
641 struct fc_frame *);
642
643 /*
Robert Love9737e6a2009-08-25 14:02:59 -0700644 * Create a remote port with a given port ID
645 *
646 * STATUS: OPTIONAL
Robert Love5101ff92009-02-27 10:55:18 -0800647 */
Robert Love9737e6a2009-08-25 14:02:59 -0700648 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
Robert Love5101ff92009-02-27 10:55:18 -0800649
650 /*
Robert Love42e9a922008-12-09 15:10:17 -0800651 * Initiates the RP state machine. It is called from the LP module.
652 * This function will issue the following commands to the N_Port
653 * identified by the FC ID provided.
654 *
655 * - PLOGI
656 * - PRLI
657 * - RTV
Robert Love0ae4d4a2009-02-27 10:55:39 -0800658 *
659 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800660 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700661 int (*rport_login)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800662
663 /*
664 * Logoff, and remove the rport from the transport if
665 * it had been added. This will send a LOGO to the target.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800666 *
667 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800668 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700669 int (*rport_logoff)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800670
671 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300672 * Receive a request from a remote port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800673 *
674 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800675 */
Joe Eykholt922611562010-07-20 15:21:12 -0700676 void (*rport_recv_req)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800677
Robert Love0ae4d4a2009-02-27 10:55:39 -0800678 /*
679 * lookup an rport by it's port ID.
680 *
681 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800682 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700683 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
Robert Love42e9a922008-12-09 15:10:17 -0800684
685 /*
Joe Eykholtf211fa52009-08-25 14:01:01 -0700686 * Destroy an rport after final kref_put().
687 * The argument is a pointer to the kref inside the fc_rport_priv.
688 */
689 void (*rport_destroy)(struct kref *);
690
691 /*
Bhanu Prakash Gollapudi75a27922011-01-28 16:05:27 -0800692 * Callback routine after the remote port is logged in
693 *
694 * STATUS: OPTIONAL
695 */
696 void (*rport_event_callback)(struct fc_lport *,
697 struct fc_rport_priv *,
698 enum fc_rport_event);
699
700 /*
Robert Love42e9a922008-12-09 15:10:17 -0800701 * Send a fcp cmd from fsp pkt.
702 * Called with the SCSI host lock unlocked and irqs disabled.
703 *
704 * The resp handler is called when FCP_RSP received.
705 *
Robert Love0ae4d4a2009-02-27 10:55:39 -0800706 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800707 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800708 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
709 void (*resp)(struct fc_seq *, struct fc_frame *,
710 void *));
Robert Love42e9a922008-12-09 15:10:17 -0800711
712 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300713 * Cleanup the FCP layer, used during link down and reset
Robert Love0ae4d4a2009-02-27 10:55:39 -0800714 *
715 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800716 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800717 void (*fcp_cleanup)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800718
719 /*
720 * Abort all I/O on a local port
Robert Love0ae4d4a2009-02-27 10:55:39 -0800721 *
722 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800723 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800724 void (*fcp_abort_io)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800725
Robert Love0ae4d4a2009-02-27 10:55:39 -0800726 /*
727 * Receive a request for the discovery layer.
728 *
729 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800730 */
Joe Eykholt922611562010-07-20 15:21:12 -0700731 void (*disc_recv_req)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800732
733 /*
734 * Start discovery for a local port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800735 *
736 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800737 */
738 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
739 enum fc_disc_event),
740 struct fc_lport *);
741
742 /*
743 * Stop discovery for a given lport. This will remove
744 * all discovered rports
Robert Love0ae4d4a2009-02-27 10:55:39 -0800745 *
746 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800747 */
748 void (*disc_stop) (struct fc_lport *);
749
750 /*
751 * Stop discovery for a given lport. This will block
752 * until all discovered rports are deleted from the
753 * FC transport class
Robert Love0ae4d4a2009-02-27 10:55:39 -0800754 *
755 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800756 */
757 void (*disc_stop_final) (struct fc_lport *);
758};
759
Robert Love3a3b42b2009-11-03 11:47:39 -0800760/**
761 * struct fc_disc - Discovery context
762 * @retry_count: Number of retries
763 * @pending: 1 if discovery is pending, 0 if not
Bhanu Prakash Gollapudic531b9b2010-10-08 17:12:36 -0700764 * @requested: 1 if discovery has been requested, 0 if not
Robert Love3a3b42b2009-11-03 11:47:39 -0800765 * @seq_count: Number of sequences used for discovery
766 * @buf_len: Length of the discovery buffer
767 * @disc_id: Discovery ID
768 * @rports: List of discovered remote ports
Joe Eykholt06852302010-07-20 15:19:53 -0700769 * @priv: Private pointer for use by discovery code
Robert Love3a3b42b2009-11-03 11:47:39 -0800770 * @disc_mutex: Mutex that protects the discovery context
771 * @partial_buf: Partial name buffer (if names are returned
772 * in multiple frames)
773 * @disc_work: handle for delayed work context
774 * @disc_callback: Callback routine called when discovery completes
775 */
Robert Love42e9a922008-12-09 15:10:17 -0800776struct fc_disc {
Robert Love3a3b42b2009-11-03 11:47:39 -0800777 unsigned char retry_count;
778 unsigned char pending;
779 unsigned char requested;
780 unsigned short seq_count;
781 unsigned char buf_len;
782 u16 disc_id;
783
784 struct list_head rports;
Joe Eykholt06852302010-07-20 15:19:53 -0700785 void *priv;
Robert Love3a3b42b2009-11-03 11:47:39 -0800786 struct mutex disc_mutex;
787 struct fc_gpn_ft_resp partial_buf;
788 struct delayed_work disc_work;
Robert Love42e9a922008-12-09 15:10:17 -0800789
790 void (*disc_callback)(struct fc_lport *,
791 enum fc_disc_event);
Robert Love42e9a922008-12-09 15:10:17 -0800792};
793
Joe Eykholt70d53b02011-01-28 16:04:18 -0800794/*
795 * Local port notifier and events.
796 */
797extern struct blocking_notifier_head fc_lport_notifier_head;
798enum fc_lport_event {
799 FC_LPORT_EV_ADD,
800 FC_LPORT_EV_DEL,
801};
802
Robert Love3a3b42b2009-11-03 11:47:39 -0800803/**
804 * struct fc_lport - Local port
805 * @host: The SCSI host associated with a local port
806 * @ema_list: Exchange manager anchor list
807 * @dns_rdata: The directory server remote port
Neerav Parikhd78c3172012-01-22 17:30:05 -0800808 * @ms_rdata: The management server remote port
Robert Love3a3b42b2009-11-03 11:47:39 -0800809 * @ptp_rdata: Point to point remote port
810 * @scsi_priv: FCP layer internal data
811 * @disc: Discovery context
812 * @vports: Child vports if N_Port
813 * @vport: Parent vport if VN_Port
814 * @tt: Libfc function template
815 * @link_up: Link state (1 = link up, 0 = link down)
816 * @qfull: Queue state (1 queue is full, 0 queue is not full)
817 * @state: Identifies the state
818 * @boot_time: Timestamp indicating when the local port came online
819 * @host_stats: SCSI host statistics
820 * @dev_stats: FCoE device stats (TODO: libfc should not be
821 * FCoE aware)
822 * @retry_count: Number of retries in the current state
Robert Love7b2787e2010-05-07 15:18:41 -0700823 * @port_id: FC Port ID
Robert Love3a3b42b2009-11-03 11:47:39 -0800824 * @wwpn: World Wide Port Name
825 * @wwnn: World Wide Node Name
826 * @service_params: Common service parameters
827 * @e_d_tov: Error detection timeout value
828 * @r_a_tov: Resouce allocation timeout value
829 * @rnid_gen: RNID information
830 * @sg_supp: Indicates if scatter gather is supported
831 * @seq_offload: Indicates if sequence offload is supported
832 * @crc_offload: Indicates if CRC offload is supported
833 * @lro_enabled: Indicates if large receive offload is supported
834 * @does_npiv: Supports multiple vports
835 * @npiv_enabled: Switch/fabric allows NPIV
836 * @mfs: The maximum Fibre Channel payload size
837 * @max_retry_count: The maximum retry attempts
838 * @max_rport_retry_count: The maximum remote port retry attempts
Joe Eykholtf90377a2010-07-20 15:19:42 -0700839 * @rport_priv_size: Size needed by driver after struct fc_rport_priv
Robert Love3a3b42b2009-11-03 11:47:39 -0800840 * @lro_xid: The maximum XID for LRO
841 * @lso_max: The maximum large offload send size
842 * @fcts: FC-4 type mask
843 * @lp_mutex: Mutex to protect the local port
Joe Eykholt70d53b02011-01-28 16:04:18 -0800844 * @list: Linkage on list of vport peers
Robert Love3a3b42b2009-11-03 11:47:39 -0800845 * @retry_work: Handle to local port for delayed retry context
Joe Eykholtbaf9fdf2011-01-28 16:04:13 -0800846 * @prov: Pointers available for use by passive FC-4 providers
Joe Eykholt70d53b02011-01-28 16:04:18 -0800847 * @lport_list: Linkage on module-wide list of local ports
Robert Love3a3b42b2009-11-03 11:47:39 -0800848 */
Robert Love42e9a922008-12-09 15:10:17 -0800849struct fc_lport {
Robert Love42e9a922008-12-09 15:10:17 -0800850 /* Associations */
Robert Love3a3b42b2009-11-03 11:47:39 -0800851 struct Scsi_Host *host;
852 struct list_head ema_list;
853 struct fc_rport_priv *dns_rdata;
Neerav Parikhd78c3172012-01-22 17:30:05 -0800854 struct fc_rport_priv *ms_rdata;
Robert Love3a3b42b2009-11-03 11:47:39 -0800855 struct fc_rport_priv *ptp_rdata;
856 void *scsi_priv;
857 struct fc_disc disc;
858
859 /* Virtual port information */
860 struct list_head vports;
861 struct fc_vport *vport;
Robert Love42e9a922008-12-09 15:10:17 -0800862
863 /* Operational Information */
864 struct libfc_function_template tt;
Robert Love3a3b42b2009-11-03 11:47:39 -0800865 u8 link_up;
866 u8 qfull;
867 enum fc_lport_state state;
868 unsigned long boot_time;
869 struct fc_host_statistics host_stats;
Bart Van Asschec6b21c92012-01-13 17:26:20 -0800870 struct fcoe_dev_stats __percpu *dev_stats;
Robert Love3a3b42b2009-11-03 11:47:39 -0800871 u8 retry_count;
Robert Love42e9a922008-12-09 15:10:17 -0800872
Robert Love3a3b42b2009-11-03 11:47:39 -0800873 /* Fabric information */
Robert Love7b2787e2010-05-07 15:18:41 -0700874 u32 port_id;
Robert Love3a3b42b2009-11-03 11:47:39 -0800875 u64 wwpn;
876 u64 wwnn;
877 unsigned int service_params;
878 unsigned int e_d_tov;
879 unsigned int r_a_tov;
880 struct fc_els_rnid_gen rnid_gen;
Robert Love42e9a922008-12-09 15:10:17 -0800881
882 /* Capabilities */
Robert Love3a3b42b2009-11-03 11:47:39 -0800883 u32 sg_supp:1;
884 u32 seq_offload:1;
885 u32 crc_offload:1;
886 u32 lro_enabled:1;
887 u32 does_npiv:1;
888 u32 npiv_enabled:1;
Joe Eykholt3726f352010-07-20 15:20:03 -0700889 u32 point_to_multipoint:1;
Neerav Parikhd78c3172012-01-22 17:30:05 -0800890 u32 fdmi_enabled:1;
Robert Love3a3b42b2009-11-03 11:47:39 -0800891 u32 mfs;
892 u8 max_retry_count;
893 u8 max_rport_retry_count;
Joe Eykholtf90377a2010-07-20 15:19:42 -0700894 u16 rport_priv_size;
Robert Love3a3b42b2009-11-03 11:47:39 -0800895 u16 link_speed;
896 u16 link_supported_speeds;
897 u16 lro_xid;
898 unsigned int lso_max;
899 struct fc_ns_fts fcts;
Robert Love42e9a922008-12-09 15:10:17 -0800900
901 /* Miscellaneous */
Robert Love3a3b42b2009-11-03 11:47:39 -0800902 struct mutex lp_mutex;
903 struct list_head list;
904 struct delayed_work retry_work;
Joe Eykholtbaf9fdf2011-01-28 16:04:13 -0800905 void *prov[FC_FC4_PROV_SIZE];
Joe Eykholt70d53b02011-01-28 16:04:18 -0800906 struct list_head lport_list;
Robert Love42e9a922008-12-09 15:10:17 -0800907};
908
Joe Eykholt96ad8462011-01-28 16:04:02 -0800909/**
910 * struct fc4_prov - FC-4 provider registration
911 * @prli: Handler for incoming PRLI
912 * @prlo: Handler for session reset
913 * @recv: Handler for incoming request
914 * @module: Pointer to module. May be NULL.
915 */
916struct fc4_prov {
917 int (*prli)(struct fc_rport_priv *, u32 spp_len,
918 const struct fc_els_spp *spp_in,
919 struct fc_els_spp *spp_out);
920 void (*prlo)(struct fc_rport_priv *);
921 void (*recv)(struct fc_lport *, struct fc_frame *);
922 struct module *module;
923};
924
925/*
926 * Register FC-4 provider with libfc.
927 */
928int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *);
929void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *);
930
Robert Love34f42a02009-02-27 10:55:45 -0800931/*
Robert Love42e9a922008-12-09 15:10:17 -0800932 * FC_LPORT HELPER FUNCTIONS
933 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -0800934
935/**
936 * fc_lport_test_ready() - Determine if a local port is in the READY state
937 * @lport: The local port to test
938 */
939static inline int fc_lport_test_ready(struct fc_lport *lport)
Robert Love42e9a922008-12-09 15:10:17 -0800940{
Robert Love3a3b42b2009-11-03 11:47:39 -0800941 return lport->state == LPORT_ST_READY;
Robert Love42e9a922008-12-09 15:10:17 -0800942}
943
Robert Love3a3b42b2009-11-03 11:47:39 -0800944/**
945 * fc_set_wwnn() - Set the World Wide Node Name of a local port
946 * @lport: The local port whose WWNN is to be set
947 * @wwnn: The new WWNN
948 */
949static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
Robert Love42e9a922008-12-09 15:10:17 -0800950{
Robert Love3a3b42b2009-11-03 11:47:39 -0800951 lport->wwnn = wwnn;
Robert Love42e9a922008-12-09 15:10:17 -0800952}
953
Robert Love3a3b42b2009-11-03 11:47:39 -0800954/**
955 * fc_set_wwpn() - Set the World Wide Port Name of a local port
956 * @lport: The local port whose WWPN is to be set
957 * @wwnn: The new WWPN
958 */
959static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn)
Robert Love42e9a922008-12-09 15:10:17 -0800960{
Robert Love3a3b42b2009-11-03 11:47:39 -0800961 lport->wwpn = wwnn;
Robert Love42e9a922008-12-09 15:10:17 -0800962}
963
Robert Love3a3b42b2009-11-03 11:47:39 -0800964/**
965 * fc_lport_state_enter() - Change a local port's state
966 * @lport: The local port whose state is to change
967 * @state: The new state
968 */
969static inline void fc_lport_state_enter(struct fc_lport *lport,
Robert Love42e9a922008-12-09 15:10:17 -0800970 enum fc_lport_state state)
971{
Robert Love3a3b42b2009-11-03 11:47:39 -0800972 if (state != lport->state)
973 lport->retry_count = 0;
974 lport->state = state;
Robert Love42e9a922008-12-09 15:10:17 -0800975}
976
Robert Love3a3b42b2009-11-03 11:47:39 -0800977/**
978 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
979 * @lport: The local port whose statistics are to be initialized
980 */
981static inline int fc_lport_init_stats(struct fc_lport *lport)
Robert Love582b45b2009-03-31 15:51:50 -0700982{
Robert Love3a3b42b2009-11-03 11:47:39 -0800983 lport->dev_stats = alloc_percpu(struct fcoe_dev_stats);
984 if (!lport->dev_stats)
Robert Love582b45b2009-03-31 15:51:50 -0700985 return -ENOMEM;
986 return 0;
987}
988
Robert Love3a3b42b2009-11-03 11:47:39 -0800989/**
990 * fc_lport_free_stats() - Free memory for a local port's statistics
991 * @lport: The local port whose statistics are to be freed
992 */
993static inline void fc_lport_free_stats(struct fc_lport *lport)
Robert Love582b45b2009-03-31 15:51:50 -0700994{
Robert Love3a3b42b2009-11-03 11:47:39 -0800995 free_percpu(lport->dev_stats);
Vasu Deva0a25da2009-03-17 11:42:29 -0700996}
997
998/**
Robert Love3a3b42b2009-11-03 11:47:39 -0800999 * lport_priv() - Return the private data from a local port
1000 * @lport: The local port whose private data is to be retreived
1001 */
1002static inline void *lport_priv(const struct fc_lport *lport)
1003{
1004 return (void *)(lport + 1);
1005}
1006
1007/**
1008 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
1009 * LLD private data
1010 * @sht: The SCSI host template
1011 * @priv_size: Size of private data
Vasu Deva0a25da2009-03-17 11:42:29 -07001012 *
Chris Leech86221962009-11-03 11:46:08 -08001013 * Returns: libfc lport
Vasu Deva0a25da2009-03-17 11:42:29 -07001014 */
Chris Leech86221962009-11-03 11:46:08 -08001015static inline struct fc_lport *
Vasu Deva0a25da2009-03-17 11:42:29 -07001016libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
1017{
Chris Leech86221962009-11-03 11:46:08 -08001018 struct fc_lport *lport;
1019 struct Scsi_Host *shost;
1020
1021 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
1022 if (!shost)
1023 return NULL;
1024 lport = shost_priv(shost);
1025 lport->host = shost;
1026 INIT_LIST_HEAD(&lport->ema_list);
Chris Leech174e1eb2009-11-03 11:46:14 -08001027 INIT_LIST_HEAD(&lport->vports);
Chris Leech86221962009-11-03 11:46:08 -08001028 return lport;
Vasu Deva0a25da2009-03-17 11:42:29 -07001029}
Robert Love42e9a922008-12-09 15:10:17 -08001030
Robert Love34f42a02009-02-27 10:55:45 -08001031/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001032 * FC_FCP HELPER FUNCTIONS
1033 *****************************/
1034static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
1035{
1036 if (fsp && fsp->cmd)
1037 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
1038 return false;
1039}
1040
1041/*
Robert Love42e9a922008-12-09 15:10:17 -08001042 * LOCAL PORT LAYER
1043 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001044int fc_lport_init(struct fc_lport *);
1045int fc_lport_destroy(struct fc_lport *);
1046int fc_fabric_logoff(struct fc_lport *);
1047int fc_fabric_login(struct fc_lport *);
Chris Leech8faecdd2009-11-03 11:46:19 -08001048void __fc_linkup(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001049void fc_linkup(struct fc_lport *);
Chris Leech8faecdd2009-11-03 11:46:19 -08001050void __fc_linkdown(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001051void fc_linkdown(struct fc_lport *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001052void fc_vport_setlink(struct fc_lport *);
1053void fc_vports_linkchange(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001054int fc_lport_config(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001055int fc_lport_reset(struct fc_lport *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001056int fc_set_mfs(struct fc_lport *, u32 mfs);
1057struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
1058struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
1059int fc_lport_bsg_request(struct fc_bsg_job *);
Joe Eykholt3726f352010-07-20 15:20:03 -07001060void fc_lport_set_local_id(struct fc_lport *, u32 port_id);
Joe Eykholt70d53b02011-01-28 16:04:18 -08001061void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *);
Steve Maa51ab392009-11-03 11:47:34 -08001062
1063/*
Robert Love42e9a922008-12-09 15:10:17 -08001064 * REMOTE PORT LAYER
1065 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001066int fc_rport_init(struct fc_lport *);
1067void fc_rport_terminate_io(struct fc_rport *);
Robert Love42e9a922008-12-09 15:10:17 -08001068
Robert Love34f42a02009-02-27 10:55:45 -08001069/*
Robert Love42e9a922008-12-09 15:10:17 -08001070 * DISCOVERY LAYER
1071 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001072int fc_disc_init(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001073
Joe Eykholt06852302010-07-20 15:19:53 -07001074static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
1075{
1076 return container_of(disc, struct fc_lport, disc);
1077}
1078
Robert Love34f42a02009-02-27 10:55:45 -08001079/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001080 * FCP LAYER
Robert Love42e9a922008-12-09 15:10:17 -08001081 *****************************/
Robert Love42e9a922008-12-09 15:10:17 -08001082int fc_fcp_init(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001083void fc_fcp_destroy(struct fc_lport *);
1084
Robert Love34f42a02009-02-27 10:55:45 -08001085/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001086 * SCSI INTERACTION LAYER
1087 *****************************/
Jeff Garzikf2812332010-11-16 02:10:29 -05001088int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001089int fc_eh_abort(struct scsi_cmnd *);
1090int fc_eh_device_reset(struct scsi_cmnd *);
1091int fc_eh_host_reset(struct scsi_cmnd *);
1092int fc_slave_alloc(struct scsi_device *);
1093int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason);
1094int fc_change_queue_type(struct scsi_device *, int tag_type);
1095
1096/*
Robert Love42e9a922008-12-09 15:10:17 -08001097 * ELS/CT interface
1098 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001099int fc_elsct_init(struct fc_lport *);
1100struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
1101 struct fc_frame *,
Chris Leech11b56182009-11-03 11:46:29 -08001102 unsigned int op,
1103 void (*resp)(struct fc_seq *,
Robert Love3a3b42b2009-11-03 11:47:39 -08001104 struct fc_frame *,
Chris Leech11b56182009-11-03 11:46:29 -08001105 void *arg),
1106 void *arg, u32 timer_msec);
1107void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
1108void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
Joe Eykholt24f089e2010-07-20 15:21:01 -07001109void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *,
1110 enum fc_rctl, u32 parm_offset);
1111void fc_fill_hdr(struct fc_frame *, const struct fc_frame *,
1112 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset);
Robert Love42e9a922008-12-09 15:10:17 -08001113
1114
Robert Love34f42a02009-02-27 10:55:45 -08001115/*
Robert Love42e9a922008-12-09 15:10:17 -08001116 * EXCHANGE MANAGER LAYER
1117 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001118int fc_exch_init(struct fc_lport *);
1119struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
1120 struct fc_exch_mgr *,
Vasu Dev96316092009-07-29 17:05:00 -07001121 bool (*match)(struct fc_frame *));
Robert Love3a3b42b2009-11-03 11:47:39 -08001122void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
Chris Leech174e1eb2009-11-03 11:46:14 -08001123int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
Robert Love3a3b42b2009-11-03 11:47:39 -08001124struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
1125 u16 min_xid, u16 max_xid,
Vasu Dev52ff8782009-07-29 17:05:10 -07001126 bool (*match)(struct fc_frame *));
Robert Love3a3b42b2009-11-03 11:47:39 -08001127void fc_exch_mgr_free(struct fc_lport *);
1128void fc_exch_recv(struct fc_lport *, struct fc_frame *);
Abhijeet Joglekar1f6ff362009-02-27 10:54:35 -08001129void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -08001130
1131/*
1132 * Functions for fc_functions_template
1133 */
Robert Love3a3b42b2009-11-03 11:47:39 -08001134void fc_get_host_speed(struct Scsi_Host *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001135void fc_get_host_port_state(struct Scsi_Host *);
1136void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
Robert Love42e9a922008-12-09 15:10:17 -08001137struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1138
Robert Love42e9a922008-12-09 15:10:17 -08001139#endif /* _LIBFC_H_ */