blob: e1379b4e8faf569c6f95131577bba6c4c392e2b0 [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/**
Vasu Dev1bd49b42012-05-25 10:26:43 -0700227 * struct fc_stats - fc stats structure
Robert Love3a3b42b2009-11-03 11:47:39 -0800228 * @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
Vasu Dev0f02a662012-05-25 10:26:48 -0700235 * @FcpPktAllocFails: Number of fcp packet allocation failures
236 * @FcpPktAborts: Number of fcp packet aborts
237 * @FcpFrameAllocFails: Number of fcp frame allocation failures
Robert Love3a3b42b2009-11-03 11:47:39 -0800238 * @LinkFailureCount: Number of link failures
239 * @LossOfSignalCount: Number for signal losses
240 * @InvalidTxWordCount: Number of invalid transmitted words
241 * @InvalidCRCCount: Number of invalid CRCs
242 * @InputRequests: Number of input requests
243 * @OutputRequests: Number of output requests
244 * @ControlRequests: Number of control requests
Joe Eykholt5f0e3852010-11-30 16:20:18 -0800245 * @InputBytes: Number of received bytes
246 * @OutputBytes: Number of transmitted bytes
Yi Zou6580bbd2009-11-20 14:54:52 -0800247 * @VLinkFailureCount: Number of virtual link failures
248 * @MissDiscAdvCount: Number of missing FIP discovery advertisement
Robert Love42e9a922008-12-09 15:10:17 -0800249 */
Vasu Dev1bd49b42012-05-25 10:26:43 -0700250struct fc_stats {
Robert Love42e9a922008-12-09 15:10:17 -0800251 u64 SecondsSinceLastReset;
252 u64 TxFrames;
253 u64 TxWords;
254 u64 RxFrames;
255 u64 RxWords;
256 u64 ErrorFrames;
257 u64 DumpedFrames;
Vasu Dev0f02a662012-05-25 10:26:48 -0700258 u64 FcpPktAllocFails;
259 u64 FcpPktAborts;
260 u64 FcpFrameAllocFails;
Robert Love42e9a922008-12-09 15:10:17 -0800261 u64 LinkFailureCount;
262 u64 LossOfSignalCount;
263 u64 InvalidTxWordCount;
264 u64 InvalidCRCCount;
265 u64 InputRequests;
266 u64 OutputRequests;
267 u64 ControlRequests;
Joe Eykholt5f0e3852010-11-30 16:20:18 -0800268 u64 InputBytes;
269 u64 OutputBytes;
Yi Zou6580bbd2009-11-20 14:54:52 -0800270 u64 VLinkFailureCount;
271 u64 MissDiscAdvCount;
Robert Love42e9a922008-12-09 15:10:17 -0800272};
273
Robert Love3a3b42b2009-11-03 11:47:39 -0800274/**
275 * struct fc_seq_els_data - ELS data used for passing ELS specific responses
Robert Love3a3b42b2009-11-03 11:47:39 -0800276 * @reason: The reason for rejection
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300277 * @explan: The explanation of the rejection
Robert Love3a3b42b2009-11-03 11:47:39 -0800278 *
279 * Mainly used by the exchange manager layer.
Robert Love42e9a922008-12-09 15:10:17 -0800280 */
281struct fc_seq_els_data {
Robert Love42e9a922008-12-09 15:10:17 -0800282 enum fc_els_rjt_reason reason;
283 enum fc_els_rjt_explan explan;
284};
285
Robert Love3a3b42b2009-11-03 11:47:39 -0800286/**
287 * struct fc_fcp_pkt - FCP request structure (one for each scsi_cmnd request)
288 * @lp: The associated local port
289 * @state: The state of the I/O
Robert Love3a3b42b2009-11-03 11:47:39 -0800290 * @ref_cnt: Reference count
291 * @scsi_pkt_lock: Lock to protect the SCSI packet (must be taken before the
292 * host_lock if both are to be held at the same time)
293 * @cmd: The SCSI command (set and clear with the host_lock held)
294 * @list: Tracks queued commands (accessed with the host_lock held)
295 * @timer: The command timer
296 * @tm_done: Completion indicator
297 * @wait_for_comp: Indicator to wait for completion of the I/O (in jiffies)
Robert Love3a3b42b2009-11-03 11:47:39 -0800298 * @data_len: The length of the data
299 * @cdb_cmd: The CDB command
300 * @xfer_len: The transfer length
301 * @xfer_ddp: Indicates if this transfer used DDP (XID of the exchange
302 * will be set here if DDP was setup)
303 * @xfer_contig_end: The offset into the buffer if the buffer is contiguous
304 * (Tx and Rx)
305 * @max_payload: The maximum payload size (in bytes)
306 * @io_status: SCSI result (upper 24 bits)
307 * @cdb_status: CDB status
308 * @status_code: FCP I/O status
309 * @scsi_comp_flags: Completion flags (bit 3 Underrun bit 2: overrun)
310 * @req_flags: Request flags (bit 0: read bit:1 write)
311 * @scsi_resid: SCSI residule length
312 * @rport: The remote port that the SCSI command is targeted at
313 * @seq_ptr: The sequence that will carry the SCSI command
314 * @recov_retry: Number of recovery retries
315 * @recov_seq: The sequence for REC or SRR
Robert Love42e9a922008-12-09 15:10:17 -0800316 */
317struct fc_fcp_pkt {
Robert Love3a3b42b2009-11-03 11:47:39 -0800318 spinlock_t scsi_pkt_lock;
Vasu Deved26cfe2011-09-27 21:37:57 -0700319 atomic_t ref_cnt;
320
321 /* SCSI command and data transfer information */
322 u32 data_len;
Robert Love3a3b42b2009-11-03 11:47:39 -0800323
324 /* SCSI I/O related information */
325 struct scsi_cmnd *cmd;
326 struct list_head list;
327
Vasu Deved26cfe2011-09-27 21:37:57 -0700328 /* Housekeeping information */
329 struct fc_lport *lp;
330 u8 state;
Robert Love42e9a922008-12-09 15:10:17 -0800331
Robert Love3a3b42b2009-11-03 11:47:39 -0800332 /* SCSI/FCP return status */
Robert Love3a3b42b2009-11-03 11:47:39 -0800333 u8 cdb_status;
334 u8 status_code;
335 u8 scsi_comp_flags;
Vasu Deved26cfe2011-09-27 21:37:57 -0700336 u32 io_status;
Robert Love3a3b42b2009-11-03 11:47:39 -0800337 u32 req_flags;
338 u32 scsi_resid;
339
Vasu Deved26cfe2011-09-27 21:37:57 -0700340 /* Transport related veriables */
341 size_t xfer_len;
342 struct fcp_cmnd cdb_cmd;
343 u32 xfer_contig_end;
344 u16 max_payload;
345 u16 xfer_ddp;
346
Robert Love3a3b42b2009-11-03 11:47:39 -0800347 /* Associated structures */
348 struct fc_rport *rport;
349 struct fc_seq *seq_ptr;
350
Vasu Deved26cfe2011-09-27 21:37:57 -0700351 /* Timeout/error related information */
352 struct timer_list timer;
353 int wait_for_comp;
354 u32 recov_retry;
Robert Love3a3b42b2009-11-03 11:47:39 -0800355 struct fc_seq *recov_seq;
Vasu Deved26cfe2011-09-27 21:37:57 -0700356 struct completion tm_done;
357} ____cacheline_aligned_in_smp;
Robert Love42e9a922008-12-09 15:10:17 -0800358
359/*
360 * Structure and function definitions for managing Fibre Channel Exchanges
361 * and Sequences
362 *
363 * fc_exch holds state for one exchange and links to its active sequence.
364 *
365 * fc_seq holds the state for an individual sequence.
366 */
367
368struct fc_exch_mgr;
Vasu Dev96316092009-07-29 17:05:00 -0700369struct fc_exch_mgr_anchor;
Robert Love3a3b42b2009-11-03 11:47:39 -0800370extern u16 fc_cpu_mask; /* cpu mask for possible cpus */
Robert Love42e9a922008-12-09 15:10:17 -0800371
Robert Love3a3b42b2009-11-03 11:47:39 -0800372/**
373 * struct fc_seq - FC sequence
374 * @id: The sequence ID
375 * @ssb_stat: Status flags for the sequence status block (SSB)
376 * @cnt: Number of frames sent so far
377 * @rec_data: FC-4 value for REC
Robert Love42e9a922008-12-09 15:10:17 -0800378 */
379struct fc_seq {
Robert Love3a3b42b2009-11-03 11:47:39 -0800380 u8 id;
381 u16 ssb_stat;
382 u16 cnt;
383 u32 rec_data;
Robert Love42e9a922008-12-09 15:10:17 -0800384};
385
386#define FC_EX_DONE (1 << 0) /* ep is completed */
387#define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */
388
Robert Love3a3b42b2009-11-03 11:47:39 -0800389/**
390 * struct fc_exch - Fibre Channel Exchange
391 * @em: Exchange manager
392 * @pool: Exchange pool
393 * @state: The exchange's state
394 * @xid: The exchange ID
395 * @ex_list: Handle used by the EM to track free exchanges
396 * @ex_lock: Lock that protects the exchange
397 * @ex_refcnt: Reference count
398 * @timeout_work: Handle for timeout handler
399 * @lp: The local port that this exchange is on
400 * @oxid: Originator's exchange ID
401 * @rxid: Responder's exchange ID
402 * @oid: Originator's FCID
403 * @sid: Source FCID
404 * @did: Destination FCID
405 * @esb_stat: ESB exchange status
406 * @r_a_tov: Resouce allocation time out value (in msecs)
407 * @seq_id: The next sequence ID to use
Joe Eykholtf60e12e2010-07-20 15:20:14 -0700408 * @encaps: encapsulation information for lower-level driver
Robert Love3a3b42b2009-11-03 11:47:39 -0800409 * @f_ctl: F_CTL flags for the sequence
410 * @fh_type: The frame type
411 * @class: The class of service
412 * @seq: The sequence in use on this exchange
413 * @resp: Callback for responses on this exchange
414 * @destructor: Called when destroying the exchange
415 * @arg: Passed as a void pointer to the resp() callback
Robert Love42e9a922008-12-09 15:10:17 -0800416 *
417 * Locking notes: The ex_lock protects following items:
418 * state, esb_stat, f_ctl, seq.ssb_stat
419 * seq_id
420 * sequence allocation
421 */
422struct fc_exch {
Robert Love3a3b42b2009-11-03 11:47:39 -0800423 spinlock_t ex_lock;
424 atomic_t ex_refcnt;
Vasu Dev49a19882011-09-27 21:38:02 -0700425 enum fc_class class;
426 struct fc_exch_mgr *em;
427 struct fc_exch_pool *pool;
428 struct list_head ex_list;
Robert Love3a3b42b2009-11-03 11:47:39 -0800429 struct fc_lport *lp;
Vasu Dev49a19882011-09-27 21:38:02 -0700430 u32 esb_stat;
431 u8 state;
432 u8 fh_type;
433 u8 seq_id;
434 u8 encaps;
435 u16 xid;
Robert Love3a3b42b2009-11-03 11:47:39 -0800436 u16 oxid;
437 u16 rxid;
438 u32 oid;
439 u32 sid;
440 u32 did;
Robert Love3a3b42b2009-11-03 11:47:39 -0800441 u32 r_a_tov;
Robert Love3a3b42b2009-11-03 11:47:39 -0800442 u32 f_ctl;
Vasu Dev49a19882011-09-27 21:38:02 -0700443 struct fc_seq seq;
Robert Love3a3b42b2009-11-03 11:47:39 -0800444 void (*resp)(struct fc_seq *, struct fc_frame *, void *);
445 void *arg;
Robert Love3a3b42b2009-11-03 11:47:39 -0800446 void (*destructor)(struct fc_seq *, void *);
Vasu Dev49a19882011-09-27 21:38:02 -0700447 struct delayed_work timeout_work;
448} ____cacheline_aligned_in_smp;
Robert Love42e9a922008-12-09 15:10:17 -0800449#define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq)
450
Robert Love42e9a922008-12-09 15:10:17 -0800451
Robert Love3a3b42b2009-11-03 11:47:39 -0800452struct libfc_function_template {
Robert Love42e9a922008-12-09 15:10:17 -0800453 /*
454 * Interface to send a FC frame
Robert Love0ae4d4a2009-02-27 10:55:39 -0800455 *
456 * STATUS: REQUIRED
Robert Love42e9a922008-12-09 15:10:17 -0800457 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800458 int (*frame_send)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800459
Robert Love42e9a922008-12-09 15:10:17 -0800460 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800461 * Interface to send ELS/CT frames
462 *
463 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800464 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800465 struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did,
466 struct fc_frame *, unsigned int op,
Robert Love42e9a922008-12-09 15:10:17 -0800467 void (*resp)(struct fc_seq *,
Robert Love3a3b42b2009-11-03 11:47:39 -0800468 struct fc_frame *, void *arg),
Robert Love42e9a922008-12-09 15:10:17 -0800469 void *arg, u32 timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800470
471 /*
472 * Send the FC frame payload using a new exchange and sequence.
473 *
Robert Love42e9a922008-12-09 15:10:17 -0800474 * The exchange response handler is set in this routine to resp()
475 * function pointer. It can be called in two scenarios: if a timeout
476 * occurs or if a response frame is received for the exchange. The
477 * fc_frame pointer in response handler will also indicate timeout
478 * as error using IS_ERR related macros.
479 *
480 * The exchange destructor handler is also set in this routine.
481 * The destructor handler is invoked by EM layer when exchange
482 * is about to free, this can be used by caller to free its
483 * resources along with exchange free.
484 *
485 * The arg is passed back to resp and destructor handler.
486 *
487 * The timeout value (in msec) for an exchange is set if non zero
488 * timer_msec argument is specified. The timer is canceled when
489 * it fires or when the exchange is done. The exchange timeout handler
490 * is registered by EM layer.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800491 *
492 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800493 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800494 struct fc_seq *(*exch_seq_send)(struct fc_lport *, struct fc_frame *,
495 void (*resp)(struct fc_seq *,
496 struct fc_frame *,
497 void *),
498 void (*destructor)(struct fc_seq *,
499 void *),
500 void *, unsigned int timer_msec);
Robert Love42e9a922008-12-09 15:10:17 -0800501
502 /*
Yi Zoub277d2a2009-02-27 14:07:21 -0800503 * Sets up the DDP context for a given exchange id on the given
504 * scatterlist if LLD supports DDP for large receive.
505 *
506 * STATUS: OPTIONAL
507 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800508 int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *,
509 unsigned int);
Yi Zoub277d2a2009-02-27 14:07:21 -0800510 /*
511 * Completes the DDP transfer and returns the length of data DDPed
512 * for the given exchange id.
513 *
514 * STATUS: OPTIONAL
515 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800516 int (*ddp_done)(struct fc_lport *, u16);
Yi Zoub277d2a2009-02-27 14:07:21 -0800517 /*
Yi Zou33dc3622011-06-20 16:59:05 -0700518 * Sets up the DDP context for a given exchange id on the given
Vasu Dev1bd49b42012-05-25 10:26:43 -0700519 * scatterlist if LLD supports DDP for target.
Yi Zou33dc3622011-06-20 16:59:05 -0700520 *
521 * STATUS: OPTIONAL
522 */
523 int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *,
524 unsigned int);
525 /*
Yi Zoub84056b2009-11-20 14:55:19 -0800526 * Allow LLD to fill its own Link Error Status Block
527 *
528 * STATUS: OPTIONAL
529 */
530 void (*get_lesb)(struct fc_lport *, struct fc_els_lesb *lesb);
531 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800532 * Send a frame using an existing sequence and exchange.
533 *
534 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800535 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800536 int (*seq_send)(struct fc_lport *, struct fc_seq *,
537 struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800538
539 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300540 * Send an ELS response using information from the received frame.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800541 *
542 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800543 */
Joe Eykholt922611562010-07-20 15:21:12 -0700544 void (*seq_els_rsp_send)(struct fc_frame *, enum fc_els_cmd,
Robert Love3a3b42b2009-11-03 11:47:39 -0800545 struct fc_seq_els_data *);
Robert Love42e9a922008-12-09 15:10:17 -0800546
547 /*
548 * Abort an exchange and sequence. Generally called because of a
549 * exchange timeout or an abort from the upper layer.
550 *
551 * A timer_msec can be specified for abort timeout, if non-zero
552 * timer_msec value is specified then exchange resp handler
553 * will be called with timeout error if no response to abort.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800554 *
555 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800556 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800557 int (*seq_exch_abort)(const struct fc_seq *,
Robert Love42e9a922008-12-09 15:10:17 -0800558 unsigned int timer_msec);
559
560 /*
561 * Indicate that an exchange/sequence tuple is complete and the memory
562 * allocated for the related objects may be freed.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800563 *
564 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800565 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800566 void (*exch_done)(struct fc_seq *);
Robert Love42e9a922008-12-09 15:10:17 -0800567
568 /*
Robert Love42e9a922008-12-09 15:10:17 -0800569 * Start a new sequence on the same exchange/sequence tuple.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800570 *
571 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800572 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800573 struct fc_seq *(*seq_start_next)(struct fc_seq *);
Robert Love42e9a922008-12-09 15:10:17 -0800574
575 /*
Joe Eykholt1a5c2d72011-01-28 16:04:08 -0800576 * Set a response handler for the exchange of the sequence.
577 *
578 * STATUS: OPTIONAL
579 */
580 void (*seq_set_resp)(struct fc_seq *sp,
581 void (*resp)(struct fc_seq *, struct fc_frame *,
582 void *),
583 void *arg);
584
585 /*
Joe Eykholt239e8102010-07-20 15:21:07 -0700586 * Assign a sequence for an incoming request frame.
587 *
588 * STATUS: OPTIONAL
589 */
590 struct fc_seq *(*seq_assign)(struct fc_lport *, struct fc_frame *);
591
592 /*
Joe Eykholt62bdb642011-01-28 16:04:34 -0800593 * Release the reference on the sequence returned by seq_assign().
594 *
595 * STATUS: OPTIONAL
596 */
597 void (*seq_release)(struct fc_seq *);
598
599 /*
Robert Love42e9a922008-12-09 15:10:17 -0800600 * Reset an exchange manager, completing all sequences and exchanges.
601 * If s_id is non-zero, reset only exchanges originating from that FID.
602 * If d_id is non-zero, reset only exchanges sending to that FID.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800603 *
604 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800605 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800606 void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -0800607
Robert Love0ae4d4a2009-02-27 10:55:39 -0800608 /*
609 * Flush the rport work queue. Generally used before shutdown.
610 *
611 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800612 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800613 void (*rport_flush_queue)(void);
Robert Love42e9a922008-12-09 15:10:17 -0800614
615 /*
Robert Love0ae4d4a2009-02-27 10:55:39 -0800616 * Receive a frame for a local port.
617 *
618 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800619 */
Joe Eykholt922611562010-07-20 15:21:12 -0700620 void (*lport_recv)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800621
Robert Love0ae4d4a2009-02-27 10:55:39 -0800622 /*
623 * Reset the local port.
624 *
625 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800626 */
Robert Love0ae4d4a2009-02-27 10:55:39 -0800627 int (*lport_reset)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800628
629 /*
Joe Eykholt093bb6a2009-11-03 11:49:05 -0800630 * Set the local port FC_ID.
631 *
632 * This may be provided by the LLD to allow it to be
633 * notified when the local port is assigned a FC-ID.
634 *
635 * The frame, if non-NULL, is the incoming frame with the
636 * FLOGI LS_ACC or FLOGI, and may contain the granted MAC
637 * address for the LLD. The frame pointer may be NULL if
638 * no MAC is associated with this assignment (LOGO or PLOGI).
639 *
640 * If FC_ID is non-zero, r_a_tov and e_d_tov must be valid.
641 *
642 * Note: this is called with the local port mutex held.
643 *
644 * STATUS: OPTIONAL
645 */
646 void (*lport_set_port_id)(struct fc_lport *, u32 port_id,
647 struct fc_frame *);
648
649 /*
Robert Love9737e6a2009-08-25 14:02:59 -0700650 * Create a remote port with a given port ID
651 *
652 * STATUS: OPTIONAL
Robert Love5101ff92009-02-27 10:55:18 -0800653 */
Robert Love9737e6a2009-08-25 14:02:59 -0700654 struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32);
Robert Love5101ff92009-02-27 10:55:18 -0800655
656 /*
Robert Love42e9a922008-12-09 15:10:17 -0800657 * Initiates the RP state machine. It is called from the LP module.
658 * This function will issue the following commands to the N_Port
659 * identified by the FC ID provided.
660 *
661 * - PLOGI
662 * - PRLI
663 * - RTV
Robert Love0ae4d4a2009-02-27 10:55:39 -0800664 *
665 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800666 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700667 int (*rport_login)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800668
669 /*
670 * Logoff, and remove the rport from the transport if
671 * it had been added. This will send a LOGO to the target.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800672 *
673 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800674 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700675 int (*rport_logoff)(struct fc_rport_priv *);
Robert Love42e9a922008-12-09 15:10:17 -0800676
677 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300678 * Receive a request from a remote port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800679 *
680 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800681 */
Joe Eykholt922611562010-07-20 15:21:12 -0700682 void (*rport_recv_req)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800683
Robert Love0ae4d4a2009-02-27 10:55:39 -0800684 /*
685 * lookup an rport by it's port ID.
686 *
687 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800688 */
Joe Eykholt9fb9d322009-08-25 14:00:50 -0700689 struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32);
Robert Love42e9a922008-12-09 15:10:17 -0800690
691 /*
Joe Eykholtf211fa52009-08-25 14:01:01 -0700692 * Destroy an rport after final kref_put().
693 * The argument is a pointer to the kref inside the fc_rport_priv.
694 */
695 void (*rport_destroy)(struct kref *);
696
697 /*
Bhanu Prakash Gollapudi75a27922011-01-28 16:05:27 -0800698 * Callback routine after the remote port is logged in
699 *
700 * STATUS: OPTIONAL
701 */
702 void (*rport_event_callback)(struct fc_lport *,
703 struct fc_rport_priv *,
704 enum fc_rport_event);
705
706 /*
Robert Love42e9a922008-12-09 15:10:17 -0800707 * Send a fcp cmd from fsp pkt.
708 * Called with the SCSI host lock unlocked and irqs disabled.
709 *
710 * The resp handler is called when FCP_RSP received.
711 *
Robert Love0ae4d4a2009-02-27 10:55:39 -0800712 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800713 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800714 int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *,
715 void (*resp)(struct fc_seq *, struct fc_frame *,
716 void *));
Robert Love42e9a922008-12-09 15:10:17 -0800717
718 /*
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300719 * Cleanup the FCP layer, used during link down and reset
Robert Love0ae4d4a2009-02-27 10:55:39 -0800720 *
721 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800722 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800723 void (*fcp_cleanup)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800724
725 /*
726 * Abort all I/O on a local port
Robert Love0ae4d4a2009-02-27 10:55:39 -0800727 *
728 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800729 */
Robert Love3a3b42b2009-11-03 11:47:39 -0800730 void (*fcp_abort_io)(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -0800731
Robert Love0ae4d4a2009-02-27 10:55:39 -0800732 /*
733 * Receive a request for the discovery layer.
734 *
735 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800736 */
Joe Eykholt922611562010-07-20 15:21:12 -0700737 void (*disc_recv_req)(struct fc_lport *, struct fc_frame *);
Robert Love42e9a922008-12-09 15:10:17 -0800738
739 /*
740 * Start discovery for a local port.
Robert Love0ae4d4a2009-02-27 10:55:39 -0800741 *
742 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800743 */
744 void (*disc_start)(void (*disc_callback)(struct fc_lport *,
745 enum fc_disc_event),
746 struct fc_lport *);
747
748 /*
749 * Stop discovery for a given lport. This will remove
750 * all discovered rports
Robert Love0ae4d4a2009-02-27 10:55:39 -0800751 *
752 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800753 */
754 void (*disc_stop) (struct fc_lport *);
755
756 /*
757 * Stop discovery for a given lport. This will block
758 * until all discovered rports are deleted from the
759 * FC transport class
Robert Love0ae4d4a2009-02-27 10:55:39 -0800760 *
761 * STATUS: OPTIONAL
Robert Love42e9a922008-12-09 15:10:17 -0800762 */
763 void (*disc_stop_final) (struct fc_lport *);
764};
765
Robert Love3a3b42b2009-11-03 11:47:39 -0800766/**
767 * struct fc_disc - Discovery context
768 * @retry_count: Number of retries
769 * @pending: 1 if discovery is pending, 0 if not
Bhanu Prakash Gollapudic531b9b2010-10-08 17:12:36 -0700770 * @requested: 1 if discovery has been requested, 0 if not
Robert Love3a3b42b2009-11-03 11:47:39 -0800771 * @seq_count: Number of sequences used for discovery
772 * @buf_len: Length of the discovery buffer
773 * @disc_id: Discovery ID
774 * @rports: List of discovered remote ports
Joe Eykholt06852302010-07-20 15:19:53 -0700775 * @priv: Private pointer for use by discovery code
Robert Love3a3b42b2009-11-03 11:47:39 -0800776 * @disc_mutex: Mutex that protects the discovery context
777 * @partial_buf: Partial name buffer (if names are returned
778 * in multiple frames)
779 * @disc_work: handle for delayed work context
780 * @disc_callback: Callback routine called when discovery completes
781 */
Robert Love42e9a922008-12-09 15:10:17 -0800782struct fc_disc {
Robert Love3a3b42b2009-11-03 11:47:39 -0800783 unsigned char retry_count;
784 unsigned char pending;
785 unsigned char requested;
786 unsigned short seq_count;
787 unsigned char buf_len;
788 u16 disc_id;
789
790 struct list_head rports;
Joe Eykholt06852302010-07-20 15:19:53 -0700791 void *priv;
Robert Love3a3b42b2009-11-03 11:47:39 -0800792 struct mutex disc_mutex;
793 struct fc_gpn_ft_resp partial_buf;
794 struct delayed_work disc_work;
Robert Love42e9a922008-12-09 15:10:17 -0800795
796 void (*disc_callback)(struct fc_lport *,
797 enum fc_disc_event);
Robert Love42e9a922008-12-09 15:10:17 -0800798};
799
Joe Eykholt70d53b02011-01-28 16:04:18 -0800800/*
801 * Local port notifier and events.
802 */
803extern struct blocking_notifier_head fc_lport_notifier_head;
804enum fc_lport_event {
805 FC_LPORT_EV_ADD,
806 FC_LPORT_EV_DEL,
807};
808
Robert Love3a3b42b2009-11-03 11:47:39 -0800809/**
810 * struct fc_lport - Local port
811 * @host: The SCSI host associated with a local port
812 * @ema_list: Exchange manager anchor list
813 * @dns_rdata: The directory server remote port
Neerav Parikhd78c3172012-01-22 17:30:05 -0800814 * @ms_rdata: The management server remote port
Robert Love3a3b42b2009-11-03 11:47:39 -0800815 * @ptp_rdata: Point to point remote port
816 * @scsi_priv: FCP layer internal data
817 * @disc: Discovery context
818 * @vports: Child vports if N_Port
819 * @vport: Parent vport if VN_Port
820 * @tt: Libfc function template
821 * @link_up: Link state (1 = link up, 0 = link down)
822 * @qfull: Queue state (1 queue is full, 0 queue is not full)
823 * @state: Identifies the state
824 * @boot_time: Timestamp indicating when the local port came online
825 * @host_stats: SCSI host statistics
Vasu Dev1bd49b42012-05-25 10:26:43 -0700826 * @stats: FC local port stats (TODO separate libfc LLD stats)
Robert Love3a3b42b2009-11-03 11:47:39 -0800827 * @retry_count: Number of retries in the current state
Robert Love7b2787e2010-05-07 15:18:41 -0700828 * @port_id: FC Port ID
Robert Love3a3b42b2009-11-03 11:47:39 -0800829 * @wwpn: World Wide Port Name
830 * @wwnn: World Wide Node Name
831 * @service_params: Common service parameters
832 * @e_d_tov: Error detection timeout value
833 * @r_a_tov: Resouce allocation timeout value
834 * @rnid_gen: RNID information
835 * @sg_supp: Indicates if scatter gather is supported
836 * @seq_offload: Indicates if sequence offload is supported
837 * @crc_offload: Indicates if CRC offload is supported
838 * @lro_enabled: Indicates if large receive offload is supported
839 * @does_npiv: Supports multiple vports
840 * @npiv_enabled: Switch/fabric allows NPIV
841 * @mfs: The maximum Fibre Channel payload size
842 * @max_retry_count: The maximum retry attempts
843 * @max_rport_retry_count: The maximum remote port retry attempts
Joe Eykholtf90377a2010-07-20 15:19:42 -0700844 * @rport_priv_size: Size needed by driver after struct fc_rport_priv
Robert Love3a3b42b2009-11-03 11:47:39 -0800845 * @lro_xid: The maximum XID for LRO
846 * @lso_max: The maximum large offload send size
847 * @fcts: FC-4 type mask
848 * @lp_mutex: Mutex to protect the local port
Joe Eykholt70d53b02011-01-28 16:04:18 -0800849 * @list: Linkage on list of vport peers
Robert Love3a3b42b2009-11-03 11:47:39 -0800850 * @retry_work: Handle to local port for delayed retry context
Joe Eykholtbaf9fdf2011-01-28 16:04:13 -0800851 * @prov: Pointers available for use by passive FC-4 providers
Joe Eykholt70d53b02011-01-28 16:04:18 -0800852 * @lport_list: Linkage on module-wide list of local ports
Robert Love3a3b42b2009-11-03 11:47:39 -0800853 */
Robert Love42e9a922008-12-09 15:10:17 -0800854struct fc_lport {
Robert Love42e9a922008-12-09 15:10:17 -0800855 /* Associations */
Robert Love3a3b42b2009-11-03 11:47:39 -0800856 struct Scsi_Host *host;
857 struct list_head ema_list;
858 struct fc_rport_priv *dns_rdata;
Neerav Parikhd78c3172012-01-22 17:30:05 -0800859 struct fc_rport_priv *ms_rdata;
Robert Love3a3b42b2009-11-03 11:47:39 -0800860 struct fc_rport_priv *ptp_rdata;
861 void *scsi_priv;
862 struct fc_disc disc;
863
864 /* Virtual port information */
865 struct list_head vports;
866 struct fc_vport *vport;
Robert Love42e9a922008-12-09 15:10:17 -0800867
868 /* Operational Information */
869 struct libfc_function_template tt;
Robert Love3a3b42b2009-11-03 11:47:39 -0800870 u8 link_up;
871 u8 qfull;
872 enum fc_lport_state state;
873 unsigned long boot_time;
874 struct fc_host_statistics host_stats;
Vasu Dev1bd49b42012-05-25 10:26:43 -0700875 struct fc_stats __percpu *stats;
Robert Love3a3b42b2009-11-03 11:47:39 -0800876 u8 retry_count;
Robert Love42e9a922008-12-09 15:10:17 -0800877
Robert Love3a3b42b2009-11-03 11:47:39 -0800878 /* Fabric information */
Robert Love7b2787e2010-05-07 15:18:41 -0700879 u32 port_id;
Robert Love3a3b42b2009-11-03 11:47:39 -0800880 u64 wwpn;
881 u64 wwnn;
882 unsigned int service_params;
883 unsigned int e_d_tov;
884 unsigned int r_a_tov;
885 struct fc_els_rnid_gen rnid_gen;
Robert Love42e9a922008-12-09 15:10:17 -0800886
887 /* Capabilities */
Robert Love3a3b42b2009-11-03 11:47:39 -0800888 u32 sg_supp:1;
889 u32 seq_offload:1;
890 u32 crc_offload:1;
891 u32 lro_enabled:1;
892 u32 does_npiv:1;
893 u32 npiv_enabled:1;
Joe Eykholt3726f352010-07-20 15:20:03 -0700894 u32 point_to_multipoint:1;
Neerav Parikhd78c3172012-01-22 17:30:05 -0800895 u32 fdmi_enabled:1;
Robert Love3a3b42b2009-11-03 11:47:39 -0800896 u32 mfs;
897 u8 max_retry_count;
898 u8 max_rport_retry_count;
Joe Eykholtf90377a2010-07-20 15:19:42 -0700899 u16 rport_priv_size;
Robert Love3a3b42b2009-11-03 11:47:39 -0800900 u16 link_speed;
901 u16 link_supported_speeds;
902 u16 lro_xid;
903 unsigned int lso_max;
904 struct fc_ns_fts fcts;
Robert Love42e9a922008-12-09 15:10:17 -0800905
906 /* Miscellaneous */
Robert Love3a3b42b2009-11-03 11:47:39 -0800907 struct mutex lp_mutex;
908 struct list_head list;
909 struct delayed_work retry_work;
Joe Eykholtbaf9fdf2011-01-28 16:04:13 -0800910 void *prov[FC_FC4_PROV_SIZE];
Joe Eykholt70d53b02011-01-28 16:04:18 -0800911 struct list_head lport_list;
Robert Love42e9a922008-12-09 15:10:17 -0800912};
913
Joe Eykholt96ad8462011-01-28 16:04:02 -0800914/**
915 * struct fc4_prov - FC-4 provider registration
916 * @prli: Handler for incoming PRLI
917 * @prlo: Handler for session reset
918 * @recv: Handler for incoming request
919 * @module: Pointer to module. May be NULL.
920 */
921struct fc4_prov {
922 int (*prli)(struct fc_rport_priv *, u32 spp_len,
923 const struct fc_els_spp *spp_in,
924 struct fc_els_spp *spp_out);
925 void (*prlo)(struct fc_rport_priv *);
926 void (*recv)(struct fc_lport *, struct fc_frame *);
927 struct module *module;
928};
929
930/*
931 * Register FC-4 provider with libfc.
932 */
933int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *);
934void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *);
935
Robert Love34f42a02009-02-27 10:55:45 -0800936/*
Robert Love42e9a922008-12-09 15:10:17 -0800937 * FC_LPORT HELPER FUNCTIONS
938 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -0800939
940/**
941 * fc_lport_test_ready() - Determine if a local port is in the READY state
942 * @lport: The local port to test
943 */
944static inline int fc_lport_test_ready(struct fc_lport *lport)
Robert Love42e9a922008-12-09 15:10:17 -0800945{
Robert Love3a3b42b2009-11-03 11:47:39 -0800946 return lport->state == LPORT_ST_READY;
Robert Love42e9a922008-12-09 15:10:17 -0800947}
948
Robert Love3a3b42b2009-11-03 11:47:39 -0800949/**
950 * fc_set_wwnn() - Set the World Wide Node Name of a local port
951 * @lport: The local port whose WWNN is to be set
952 * @wwnn: The new WWNN
953 */
954static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn)
Robert Love42e9a922008-12-09 15:10:17 -0800955{
Robert Love3a3b42b2009-11-03 11:47:39 -0800956 lport->wwnn = wwnn;
Robert Love42e9a922008-12-09 15:10:17 -0800957}
958
Robert Love3a3b42b2009-11-03 11:47:39 -0800959/**
960 * fc_set_wwpn() - Set the World Wide Port Name of a local port
961 * @lport: The local port whose WWPN is to be set
962 * @wwnn: The new WWPN
963 */
964static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn)
Robert Love42e9a922008-12-09 15:10:17 -0800965{
Robert Love3a3b42b2009-11-03 11:47:39 -0800966 lport->wwpn = wwnn;
Robert Love42e9a922008-12-09 15:10:17 -0800967}
968
Robert Love3a3b42b2009-11-03 11:47:39 -0800969/**
970 * fc_lport_state_enter() - Change a local port's state
971 * @lport: The local port whose state is to change
972 * @state: The new state
973 */
974static inline void fc_lport_state_enter(struct fc_lport *lport,
Robert Love42e9a922008-12-09 15:10:17 -0800975 enum fc_lport_state state)
976{
Robert Love3a3b42b2009-11-03 11:47:39 -0800977 if (state != lport->state)
978 lport->retry_count = 0;
979 lport->state = state;
Robert Love42e9a922008-12-09 15:10:17 -0800980}
981
Robert Love3a3b42b2009-11-03 11:47:39 -0800982/**
983 * fc_lport_init_stats() - Allocate per-CPU statistics for a local port
984 * @lport: The local port whose statistics are to be initialized
985 */
986static inline int fc_lport_init_stats(struct fc_lport *lport)
Robert Love582b45b2009-03-31 15:51:50 -0700987{
Vasu Dev1bd49b42012-05-25 10:26:43 -0700988 lport->stats = alloc_percpu(struct fc_stats);
989 if (!lport->stats)
Robert Love582b45b2009-03-31 15:51:50 -0700990 return -ENOMEM;
991 return 0;
992}
993
Robert Love3a3b42b2009-11-03 11:47:39 -0800994/**
995 * fc_lport_free_stats() - Free memory for a local port's statistics
996 * @lport: The local port whose statistics are to be freed
997 */
998static inline void fc_lport_free_stats(struct fc_lport *lport)
Robert Love582b45b2009-03-31 15:51:50 -0700999{
Vasu Dev1bd49b42012-05-25 10:26:43 -07001000 free_percpu(lport->stats);
Vasu Deva0a25da2009-03-17 11:42:29 -07001001}
1002
1003/**
Robert Love3a3b42b2009-11-03 11:47:39 -08001004 * lport_priv() - Return the private data from a local port
1005 * @lport: The local port whose private data is to be retreived
1006 */
1007static inline void *lport_priv(const struct fc_lport *lport)
1008{
1009 return (void *)(lport + 1);
1010}
1011
1012/**
1013 * libfc_host_alloc() - Allocate a Scsi_Host with room for a local port and
1014 * LLD private data
1015 * @sht: The SCSI host template
1016 * @priv_size: Size of private data
Vasu Deva0a25da2009-03-17 11:42:29 -07001017 *
Chris Leech86221962009-11-03 11:46:08 -08001018 * Returns: libfc lport
Vasu Deva0a25da2009-03-17 11:42:29 -07001019 */
Chris Leech86221962009-11-03 11:46:08 -08001020static inline struct fc_lport *
Vasu Deva0a25da2009-03-17 11:42:29 -07001021libfc_host_alloc(struct scsi_host_template *sht, int priv_size)
1022{
Chris Leech86221962009-11-03 11:46:08 -08001023 struct fc_lport *lport;
1024 struct Scsi_Host *shost;
1025
1026 shost = scsi_host_alloc(sht, sizeof(*lport) + priv_size);
1027 if (!shost)
1028 return NULL;
1029 lport = shost_priv(shost);
1030 lport->host = shost;
1031 INIT_LIST_HEAD(&lport->ema_list);
Chris Leech174e1eb2009-11-03 11:46:14 -08001032 INIT_LIST_HEAD(&lport->vports);
Chris Leech86221962009-11-03 11:46:08 -08001033 return lport;
Vasu Deva0a25da2009-03-17 11:42:29 -07001034}
Robert Love42e9a922008-12-09 15:10:17 -08001035
Robert Love34f42a02009-02-27 10:55:45 -08001036/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001037 * FC_FCP HELPER FUNCTIONS
1038 *****************************/
1039static inline bool fc_fcp_is_read(const struct fc_fcp_pkt *fsp)
1040{
1041 if (fsp && fsp->cmd)
1042 return fsp->cmd->sc_data_direction == DMA_FROM_DEVICE;
1043 return false;
1044}
1045
1046/*
Robert Love42e9a922008-12-09 15:10:17 -08001047 * LOCAL PORT LAYER
1048 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001049int fc_lport_init(struct fc_lport *);
1050int fc_lport_destroy(struct fc_lport *);
1051int fc_fabric_logoff(struct fc_lport *);
1052int fc_fabric_login(struct fc_lport *);
Chris Leech8faecdd2009-11-03 11:46:19 -08001053void __fc_linkup(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001054void fc_linkup(struct fc_lport *);
Chris Leech8faecdd2009-11-03 11:46:19 -08001055void __fc_linkdown(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001056void fc_linkdown(struct fc_lport *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001057void fc_vport_setlink(struct fc_lport *);
1058void fc_vports_linkchange(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001059int fc_lport_config(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001060int fc_lport_reset(struct fc_lport *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001061int fc_set_mfs(struct fc_lport *, u32 mfs);
1062struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize);
1063struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id);
1064int fc_lport_bsg_request(struct fc_bsg_job *);
Joe Eykholt3726f352010-07-20 15:20:03 -07001065void fc_lport_set_local_id(struct fc_lport *, u32 port_id);
Joe Eykholt70d53b02011-01-28 16:04:18 -08001066void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *);
Steve Maa51ab392009-11-03 11:47:34 -08001067
1068/*
Robert Love42e9a922008-12-09 15:10:17 -08001069 * REMOTE PORT LAYER
1070 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001071int fc_rport_init(struct fc_lport *);
1072void fc_rport_terminate_io(struct fc_rport *);
Robert Love42e9a922008-12-09 15:10:17 -08001073
Robert Love34f42a02009-02-27 10:55:45 -08001074/*
Robert Love42e9a922008-12-09 15:10:17 -08001075 * DISCOVERY LAYER
1076 *****************************/
Robert Love08076192013-03-25 11:00:28 -07001077void fc_disc_init(struct fc_lport *);
1078void fc_disc_config(struct fc_lport *, void *);
Robert Love42e9a922008-12-09 15:10:17 -08001079
Joe Eykholt06852302010-07-20 15:19:53 -07001080static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc)
1081{
1082 return container_of(disc, struct fc_lport, disc);
1083}
1084
Robert Love34f42a02009-02-27 10:55:45 -08001085/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001086 * FCP LAYER
Robert Love42e9a922008-12-09 15:10:17 -08001087 *****************************/
Robert Love42e9a922008-12-09 15:10:17 -08001088int fc_fcp_init(struct fc_lport *);
Robert Love42e9a922008-12-09 15:10:17 -08001089void fc_fcp_destroy(struct fc_lport *);
1090
Robert Love34f42a02009-02-27 10:55:45 -08001091/*
Robert Love3a3b42b2009-11-03 11:47:39 -08001092 * SCSI INTERACTION LAYER
1093 *****************************/
Jeff Garzikf2812332010-11-16 02:10:29 -05001094int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001095int fc_eh_abort(struct scsi_cmnd *);
1096int fc_eh_device_reset(struct scsi_cmnd *);
1097int fc_eh_host_reset(struct scsi_cmnd *);
1098int fc_slave_alloc(struct scsi_device *);
1099int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason);
1100int fc_change_queue_type(struct scsi_device *, int tag_type);
1101
1102/*
Robert Love42e9a922008-12-09 15:10:17 -08001103 * ELS/CT interface
1104 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001105int fc_elsct_init(struct fc_lport *);
1106struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did,
1107 struct fc_frame *,
Chris Leech11b56182009-11-03 11:46:29 -08001108 unsigned int op,
1109 void (*resp)(struct fc_seq *,
Robert Love3a3b42b2009-11-03 11:47:39 -08001110 struct fc_frame *,
Chris Leech11b56182009-11-03 11:46:29 -08001111 void *arg),
1112 void *arg, u32 timer_msec);
1113void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *);
1114void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *);
Joe Eykholt24f089e2010-07-20 15:21:01 -07001115void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *,
1116 enum fc_rctl, u32 parm_offset);
1117void fc_fill_hdr(struct fc_frame *, const struct fc_frame *,
1118 enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset);
Robert Love42e9a922008-12-09 15:10:17 -08001119
1120
Robert Love34f42a02009-02-27 10:55:45 -08001121/*
Robert Love42e9a922008-12-09 15:10:17 -08001122 * EXCHANGE MANAGER LAYER
1123 *****************************/
Robert Love3a3b42b2009-11-03 11:47:39 -08001124int fc_exch_init(struct fc_lport *);
Vasu Dev4e5fae72012-05-25 10:26:54 -07001125void fc_exch_update_stats(struct fc_lport *lport);
Robert Love3a3b42b2009-11-03 11:47:39 -08001126struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *,
1127 struct fc_exch_mgr *,
Vasu Dev96316092009-07-29 17:05:00 -07001128 bool (*match)(struct fc_frame *));
Robert Love3a3b42b2009-11-03 11:47:39 -08001129void fc_exch_mgr_del(struct fc_exch_mgr_anchor *);
Chris Leech174e1eb2009-11-03 11:46:14 -08001130int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst);
Robert Love3a3b42b2009-11-03 11:47:39 -08001131struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class,
1132 u16 min_xid, u16 max_xid,
Vasu Dev52ff8782009-07-29 17:05:10 -07001133 bool (*match)(struct fc_frame *));
Robert Love3a3b42b2009-11-03 11:47:39 -08001134void fc_exch_mgr_free(struct fc_lport *);
1135void fc_exch_recv(struct fc_lport *, struct fc_frame *);
Abhijeet Joglekar1f6ff362009-02-27 10:54:35 -08001136void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id);
Robert Love42e9a922008-12-09 15:10:17 -08001137
1138/*
1139 * Functions for fc_functions_template
1140 */
Robert Love3a3b42b2009-11-03 11:47:39 -08001141void fc_get_host_speed(struct Scsi_Host *);
Robert Love3a3b42b2009-11-03 11:47:39 -08001142void fc_get_host_port_state(struct Scsi_Host *);
1143void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout);
Robert Love42e9a922008-12-09 15:10:17 -08001144struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *);
1145
Robert Love42e9a922008-12-09 15:10:17 -08001146#endif /* _LIBFC_H_ */