Commit | Line | Data |
---|---|---|
42e9a92f RL |
1 | /* |
2 | * Copyright(c) 2007 Intel Corporation. All rights reserved. | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify it | |
5 | * under the terms and conditions of the GNU General Public License, | |
6 | * version 2, as published by the Free Software Foundation. | |
7 | * | |
8 | * This program is distributed in the hope it will be useful, but WITHOUT | |
9 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
10 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
11 | * more details. | |
12 | * | |
13 | * You should have received a copy of the GNU General Public License along with | |
14 | * this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. | |
16 | * | |
17 | * Maintained at www.Open-FCoE.org | |
18 | */ | |
19 | ||
20 | #ifndef _LIBFC_H_ | |
21 | #define _LIBFC_H_ | |
22 | ||
23 | #include <linux/timer.h> | |
24 | #include <linux/if.h> | |
582b45bc | 25 | #include <linux/percpu.h> |
42e9a92f RL |
26 | |
27 | #include <scsi/scsi_transport.h> | |
28 | #include <scsi/scsi_transport_fc.h> | |
a51ab396 | 29 | #include <scsi/scsi_bsg_fc.h> |
42e9a92f RL |
30 | |
31 | #include <scsi/fc/fc_fcp.h> | |
32 | #include <scsi/fc/fc_ns.h> | |
d78c317f | 33 | #include <scsi/fc/fc_ms.h> |
42e9a92f RL |
34 | #include <scsi/fc/fc_els.h> |
35 | #include <scsi/fc/fc_gs.h> | |
36 | ||
37 | #include <scsi/fc_frame.h> | |
38 | ||
96ad8464 JE |
39 | #define FC_FC4_PROV_SIZE (FC_TYPE_FCP + 1) /* size of tables */ |
40 | ||
42e9a92f RL |
41 | /* |
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 | ||
3a3b42bf RL |
48 | /** |
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 | |
ab593b18 | 55 | * @LPORT_ST_RFF_ID: Register FC-4 Features by ID (RFF_ID) sent |
d78c317f NP |
56 | * @LPORT_ST_FDMI: Waiting for mgmt server rport to become ready |
57 | * @LPORT_ST_RHBA: | |
3a3b42bf RL |
58 | * @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 | |
42e9a92f | 62 | */ |
42e9a92f | 63 | enum fc_lport_state { |
b1d9fd55 | 64 | LPORT_ST_DISABLED = 0, |
42e9a92f RL |
65 | LPORT_ST_FLOGI, |
66 | LPORT_ST_DNS, | |
c9c7bd7a | 67 | LPORT_ST_RNN_ID, |
5baa17c3 | 68 | LPORT_ST_RSNN_NN, |
c9866a54 | 69 | LPORT_ST_RSPN_ID, |
42e9a92f | 70 | LPORT_ST_RFT_ID, |
ab593b18 | 71 | LPORT_ST_RFF_ID, |
d78c317f NP |
72 | LPORT_ST_FDMI, |
73 | LPORT_ST_RHBA, | |
74 | LPORT_ST_RPA, | |
75 | LPORT_ST_DHBA, | |
76 | LPORT_ST_DPRT, | |
42e9a92f RL |
77 | LPORT_ST_SCR, |
78 | LPORT_ST_READY, | |
79 | LPORT_ST_LOGO, | |
80 | LPORT_ST_RESET | |
81 | }; | |
82 | ||
83 | enum fc_disc_event { | |
84 | DISC_EV_NONE = 0, | |
85 | DISC_EV_SUCCESS, | |
86 | DISC_EV_FAILED | |
87 | }; | |
88 | ||
3a3b42bf RL |
89 | /** |
90 | * enum fc_rport_state - Remote port states | |
91 | * @RPORT_ST_INIT: Initialized | |
a7b12a27 JE |
92 | * @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 | |
3a3b42bf RL |
94 | * @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 | |
3a3b42bf RL |
98 | * @RPORT_ST_ADISC: Discover Address sent |
99 | * @RPORT_ST_DELETE: Remote port being deleted | |
3a3b42bf | 100 | */ |
42e9a92f | 101 | enum fc_rport_state { |
3a3b42bf | 102 | RPORT_ST_INIT, |
a7b12a27 JE |
103 | RPORT_ST_FLOGI, |
104 | RPORT_ST_PLOGI_WAIT, | |
3a3b42bf RL |
105 | RPORT_ST_PLOGI, |
106 | RPORT_ST_PRLI, | |
107 | RPORT_ST_RTV, | |
108 | RPORT_ST_READY, | |
3a3b42bf RL |
109 | RPORT_ST_ADISC, |
110 | RPORT_ST_DELETE, | |
42e9a92f RL |
111 | }; |
112 | ||
42e9a92f RL |
113 | /** |
114 | * struct fc_disc_port - temporary discovery port to hold rport identifiers | |
9737e6a7 RL |
115 | * @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 | |
42e9a92f RL |
119 | */ |
120 | struct fc_disc_port { | |
3a3b42bf RL |
121 | struct fc_lport *lp; |
122 | struct list_head peers; | |
123 | struct work_struct rport_work; | |
124 | u32 port_id; | |
42e9a92f RL |
125 | }; |
126 | ||
3a3b42bf RL |
127 | /** |
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 | */ | |
42e9a92f RL |
135 | enum fc_rport_event { |
136 | RPORT_EV_NONE = 0, | |
4c0f62b5 | 137 | RPORT_EV_READY, |
42e9a92f RL |
138 | RPORT_EV_FAILED, |
139 | RPORT_EV_STOP, | |
140 | RPORT_EV_LOGO | |
141 | }; | |
142 | ||
9fb9d328 JE |
143 | struct fc_rport_priv; |
144 | ||
3a3b42bf RL |
145 | /** |
146 | * struct fc_rport_operations - Operations for a remote port | |
147 | * @event_callback: Function to be called for remote port events | |
148 | */ | |
42e9a92f | 149 | struct fc_rport_operations { |
9fb9d328 | 150 | void (*event_callback)(struct fc_lport *, struct fc_rport_priv *, |
42e9a92f RL |
151 | enum fc_rport_event); |
152 | }; | |
153 | ||
154 | /** | |
155 | * struct fc_rport_libfc_priv - libfc internal information about a remote port | |
3a3b42bf RL |
156 | * @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) | |
9e9d0452 JE |
161 | */ |
162 | struct 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) | |
4b2164d4 | 168 | #define FC_RP_STARTED (1 << 2) |
75a2792d | 169 | #define FC_RP_FLAGS_CONF_REQ (1 << 3) |
9e9d0452 JE |
170 | unsigned int e_d_tov; |
171 | unsigned int r_a_tov; | |
172 | }; | |
173 | ||
174 | /** | |
3a3b42bf RL |
175 | * 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 | |
4b2164d4 | 182 | * @flags: STARTED, REC and RETRY_SUPPORTED flags |
3a3b42bf RL |
183 | * @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 | |
f034260d | 187 | * @major_retries: The retry count for the entire PLOGI/PRLI state machine |
3a3b42bf RL |
188 | * @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 | |
96ad8464 | 193 | * @prli_count: Count of open PRLI sessions in providers |
42e90414 | 194 | * @rcu: Structure used for freeing in an RCU-safe manner |
42e9a92f | 195 | */ |
9e9d0452 | 196 | struct fc_rport_priv { |
3a3b42bf RL |
197 | struct fc_lport *local_port; |
198 | struct fc_rport *rport; | |
199 | struct kref kref; | |
200 | enum fc_rport_state rp_state; | |
f211fa51 | 201 | struct fc_rport_identifiers ids; |
3a3b42bf RL |
202 | u16 flags; |
203 | u16 max_seq; | |
204 | u16 disc_id; | |
205 | u16 maxframe_size; | |
206 | unsigned int retries; | |
f034260d | 207 | unsigned int major_retries; |
3a3b42bf RL |
208 | 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; | |
96ad8464 | 217 | u16 prli_count; |
42e90414 | 218 | struct rcu_head rcu; |
75a2792d BPG |
219 | 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); | |
42e9a92f RL |
224 | }; |
225 | ||
3a3b42bf | 226 | /** |
1bd49b48 | 227 | * struct fc_stats - fc stats structure |
3a3b42bf RL |
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 | |
0f02a665 VD |
235 | * @FcpPktAllocFails: Number of fcp packet allocation failures |
236 | * @FcpPktAborts: Number of fcp packet aborts | |
237 | * @FcpFrameAllocFails: Number of fcp frame allocation failures | |
3a3b42bf RL |
238 | * @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 | |
5f0e385f JE |
245 | * @InputBytes: Number of received bytes |
246 | * @OutputBytes: Number of transmitted bytes | |
6580bbd0 YZ |
247 | * @VLinkFailureCount: Number of virtual link failures |
248 | * @MissDiscAdvCount: Number of missing FIP discovery advertisement | |
42e9a92f | 249 | */ |
1bd49b48 | 250 | struct fc_stats { |
42e9a92f RL |
251 | u64 SecondsSinceLastReset; |
252 | u64 TxFrames; | |
253 | u64 TxWords; | |
254 | u64 RxFrames; | |
255 | u64 RxWords; | |
256 | u64 ErrorFrames; | |
257 | u64 DumpedFrames; | |
0f02a665 VD |
258 | u64 FcpPktAllocFails; |
259 | u64 FcpPktAborts; | |
260 | u64 FcpFrameAllocFails; | |
42e9a92f RL |
261 | u64 LinkFailureCount; |
262 | u64 LossOfSignalCount; | |
263 | u64 InvalidTxWordCount; | |
264 | u64 InvalidCRCCount; | |
265 | u64 InputRequests; | |
266 | u64 OutputRequests; | |
267 | u64 ControlRequests; | |
5f0e385f JE |
268 | u64 InputBytes; |
269 | u64 OutputBytes; | |
6580bbd0 YZ |
270 | u64 VLinkFailureCount; |
271 | u64 MissDiscAdvCount; | |
42e9a92f RL |
272 | }; |
273 | ||
3a3b42bf RL |
274 | /** |
275 | * struct fc_seq_els_data - ELS data used for passing ELS specific responses | |
3a3b42bf | 276 | * @reason: The reason for rejection |
25985edc | 277 | * @explan: The explanation of the rejection |
3a3b42bf RL |
278 | * |
279 | * Mainly used by the exchange manager layer. | |
42e9a92f RL |
280 | */ |
281 | struct fc_seq_els_data { | |
42e9a92f RL |
282 | enum fc_els_rjt_reason reason; |
283 | enum fc_els_rjt_explan explan; | |
284 | }; | |
285 | ||
3a3b42bf RL |
286 | /** |
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 | |
3a3b42bf RL |
290 | * @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) | |
3a3b42bf RL |
298 | * @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 | |
42e9a92f RL |
316 | */ |
317 | struct fc_fcp_pkt { | |
3a3b42bf | 318 | spinlock_t scsi_pkt_lock; |
ed26cfec VD |
319 | atomic_t ref_cnt; |
320 | ||
321 | /* SCSI command and data transfer information */ | |
322 | u32 data_len; | |
3a3b42bf RL |
323 | |
324 | /* SCSI I/O related information */ | |
325 | struct scsi_cmnd *cmd; | |
326 | struct list_head list; | |
327 | ||
ed26cfec VD |
328 | /* Housekeeping information */ |
329 | struct fc_lport *lp; | |
330 | u8 state; | |
3a3b42bf RL |
331 | |
332 | /* SCSI/FCP return status */ | |
3a3b42bf RL |
333 | u8 cdb_status; |
334 | u8 status_code; | |
335 | u8 scsi_comp_flags; | |
ed26cfec | 336 | u32 io_status; |
3a3b42bf RL |
337 | u32 req_flags; |
338 | u32 scsi_resid; | |
339 | ||
ed26cfec VD |
340 | /* 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 | ||
3a3b42bf RL |
347 | /* Associated structures */ |
348 | struct fc_rport *rport; | |
349 | struct fc_seq *seq_ptr; | |
350 | ||
ed26cfec VD |
351 | /* Timeout/error related information */ |
352 | struct timer_list timer; | |
353 | int wait_for_comp; | |
354 | u32 recov_retry; | |
3a3b42bf | 355 | struct fc_seq *recov_seq; |
ed26cfec VD |
356 | struct completion tm_done; |
357 | } ____cacheline_aligned_in_smp; | |
42e9a92f RL |
358 | |
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 | ||
368 | struct fc_exch_mgr; | |
96316099 | 369 | struct fc_exch_mgr_anchor; |
3a3b42bf | 370 | extern u16 fc_cpu_mask; /* cpu mask for possible cpus */ |
42e9a92f | 371 | |
3a3b42bf RL |
372 | /** |
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 | |
42e9a92f RL |
378 | */ |
379 | struct fc_seq { | |
3a3b42bf RL |
380 | u8 id; |
381 | u16 ssb_stat; | |
382 | u16 cnt; | |
383 | u32 rec_data; | |
42e9a92f RL |
384 | }; |
385 | ||
386 | #define FC_EX_DONE (1 << 0) /* ep is completed */ | |
387 | #define FC_EX_RST_CLEANUP (1 << 1) /* reset is forcing completion */ | |
388 | ||
3a3b42bf RL |
389 | /** |
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 | |
f60e12e9 | 408 | * @encaps: encapsulation information for lower-level driver |
3a3b42bf RL |
409 | * @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 | |
42e9a92f RL |
416 | * |
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 | */ | |
422 | struct fc_exch { | |
49a19889 VD |
423 | spinlock_t ex_lock; |
424 | atomic_t ex_refcnt; | |
425 | enum fc_class class; | |
3a3b42bf RL |
426 | struct fc_exch_mgr *em; |
427 | struct fc_exch_pool *pool; | |
3a3b42bf | 428 | struct list_head ex_list; |
3a3b42bf | 429 | struct fc_lport *lp; |
49a19889 VD |
430 | u32 esb_stat; |
431 | u8 state; | |
432 | u8 fh_type; | |
433 | u8 seq_id; | |
434 | u8 encaps; | |
435 | u16 xid; | |
3a3b42bf RL |
436 | u16 oxid; |
437 | u16 rxid; | |
438 | u32 oid; | |
439 | u32 sid; | |
440 | u32 did; | |
3a3b42bf | 441 | u32 r_a_tov; |
3a3b42bf | 442 | u32 f_ctl; |
49a19889 | 443 | struct fc_seq seq; |
3a3b42bf RL |
444 | void (*resp)(struct fc_seq *, struct fc_frame *, void *); |
445 | void *arg; | |
3a3b42bf | 446 | void (*destructor)(struct fc_seq *, void *); |
49a19889 VD |
447 | struct delayed_work timeout_work; |
448 | } ____cacheline_aligned_in_smp; | |
42e9a92f RL |
449 | #define fc_seq_exch(sp) container_of(sp, struct fc_exch, seq) |
450 | ||
42e9a92f | 451 | |
3a3b42bf | 452 | struct libfc_function_template { |
42e9a92f RL |
453 | /* |
454 | * Interface to send a FC frame | |
42e9a92f | 455 | * |
0ae4d4ae | 456 | * STATUS: REQUIRED |
42e9a92f | 457 | */ |
3a3b42bf | 458 | int (*frame_send)(struct fc_lport *, struct fc_frame *); |
42e9a92f RL |
459 | |
460 | /* | |
0ae4d4ae RL |
461 | * Interface to send ELS/CT frames |
462 | * | |
463 | * STATUS: OPTIONAL | |
42e9a92f | 464 | */ |
3a3b42bf RL |
465 | struct fc_seq *(*elsct_send)(struct fc_lport *, u32 did, |
466 | struct fc_frame *, unsigned int op, | |
42e9a92f | 467 | void (*resp)(struct fc_seq *, |
3a3b42bf | 468 | struct fc_frame *, void *arg), |
42e9a92f | 469 | void *arg, u32 timer_msec); |
42e9a92f RL |
470 | |
471 | /* | |
472 | * Send the FC frame payload using a new exchange and sequence. | |
473 | * | |
42e9a92f RL |
474 | * 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. | |
0ae4d4ae RL |
491 | * |
492 | * STATUS: OPTIONAL | |
42e9a92f | 493 | */ |
3a3b42bf RL |
494 | 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); | |
42e9a92f | 501 | |
b277d2aa YZ |
502 | /* |
503 | * 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 | */ | |
3a3b42bf RL |
508 | int (*ddp_setup)(struct fc_lport *, u16, struct scatterlist *, |
509 | unsigned int); | |
b277d2aa YZ |
510 | /* |
511 | * Completes the DDP transfer and returns the length of data DDPed | |
512 | * for the given exchange id. | |
513 | * | |
514 | * STATUS: OPTIONAL | |
515 | */ | |
3a3b42bf | 516 | int (*ddp_done)(struct fc_lport *, u16); |
33dc362b YZ |
517 | /* |
518 | * Sets up the DDP context for a given exchange id on the given | |
1bd49b48 | 519 | * scatterlist if LLD supports DDP for target. |
33dc362b YZ |
520 | * |
521 | * STATUS: OPTIONAL | |
522 | */ | |
523 | int (*ddp_target)(struct fc_lport *, u16, struct scatterlist *, | |
524 | unsigned int); | |
b84056bf YZ |
525 | /* |
526 | * 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); | |
42e9a92f | 531 | /* |
0ae4d4ae RL |
532 | * Send a frame using an existing sequence and exchange. |
533 | * | |
534 | * STATUS: OPTIONAL | |
42e9a92f | 535 | */ |
3a3b42bf RL |
536 | int (*seq_send)(struct fc_lport *, struct fc_seq *, |
537 | struct fc_frame *); | |
42e9a92f RL |
538 | |
539 | /* | |
25985edc | 540 | * Send an ELS response using information from the received frame. |
0ae4d4ae RL |
541 | * |
542 | * STATUS: OPTIONAL | |
42e9a92f | 543 | */ |
92261156 | 544 | void (*seq_els_rsp_send)(struct fc_frame *, enum fc_els_cmd, |
3a3b42bf | 545 | struct fc_seq_els_data *); |
42e9a92f RL |
546 | |
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. | |
0ae4d4ae RL |
554 | * |
555 | * STATUS: OPTIONAL | |
42e9a92f | 556 | */ |
3a3b42bf | 557 | int (*seq_exch_abort)(const struct fc_seq *, |
42e9a92f RL |
558 | 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. | |
0ae4d4ae RL |
563 | * |
564 | * STATUS: OPTIONAL | |
42e9a92f | 565 | */ |
3a3b42bf | 566 | void (*exch_done)(struct fc_seq *); |
42e9a92f | 567 | |
42e9a92f RL |
568 | /* |
569 | * Start a new sequence on the same exchange/sequence tuple. | |
0ae4d4ae RL |
570 | * |
571 | * STATUS: OPTIONAL | |
42e9a92f | 572 | */ |
3a3b42bf | 573 | struct fc_seq *(*seq_start_next)(struct fc_seq *); |
42e9a92f | 574 | |
1a5c2d7e JE |
575 | /* |
576 | * 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 | ||
239e8104 JE |
585 | /* |
586 | * 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 | ||
62bdb645 JE |
592 | /* |
593 | * Release the reference on the sequence returned by seq_assign(). | |
594 | * | |
595 | * STATUS: OPTIONAL | |
596 | */ | |
597 | void (*seq_release)(struct fc_seq *); | |
598 | ||
42e9a92f RL |
599 | /* |
600 | * 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. | |
0ae4d4ae RL |
603 | * |
604 | * STATUS: OPTIONAL | |
42e9a92f | 605 | */ |
3a3b42bf | 606 | void (*exch_mgr_reset)(struct fc_lport *, u32 s_id, u32 d_id); |
42e9a92f | 607 | |
0ae4d4ae RL |
608 | /* |
609 | * Flush the rport work queue. Generally used before shutdown. | |
610 | * | |
611 | * STATUS: OPTIONAL | |
42e9a92f | 612 | */ |
0ae4d4ae | 613 | void (*rport_flush_queue)(void); |
42e9a92f RL |
614 | |
615 | /* | |
0ae4d4ae RL |
616 | * Receive a frame for a local port. |
617 | * | |
618 | * STATUS: OPTIONAL | |
42e9a92f | 619 | */ |
92261156 | 620 | void (*lport_recv)(struct fc_lport *, struct fc_frame *); |
42e9a92f | 621 | |
0ae4d4ae RL |
622 | /* |
623 | * Reset the local port. | |
624 | * | |
625 | * STATUS: OPTIONAL | |
42e9a92f | 626 | */ |
0ae4d4ae | 627 | int (*lport_reset)(struct fc_lport *); |
42e9a92f | 628 | |
093bb6a2 JE |
629 | /* |
630 | * 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 | ||
5101ff99 | 649 | /* |
9737e6a7 RL |
650 | * Create a remote port with a given port ID |
651 | * | |
652 | * STATUS: OPTIONAL | |
5101ff99 | 653 | */ |
9737e6a7 | 654 | struct fc_rport_priv *(*rport_create)(struct fc_lport *, u32); |
5101ff99 | 655 | |
42e9a92f RL |
656 | /* |
657 | * 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 | |
0ae4d4ae RL |
664 | * |
665 | * STATUS: OPTIONAL | |
42e9a92f | 666 | */ |
9fb9d328 | 667 | int (*rport_login)(struct fc_rport_priv *); |
42e9a92f RL |
668 | |
669 | /* | |
670 | * Logoff, and remove the rport from the transport if | |
671 | * it had been added. This will send a LOGO to the target. | |
0ae4d4ae RL |
672 | * |
673 | * STATUS: OPTIONAL | |
42e9a92f | 674 | */ |
9fb9d328 | 675 | int (*rport_logoff)(struct fc_rport_priv *); |
42e9a92f RL |
676 | |
677 | /* | |
25985edc | 678 | * Receive a request from a remote port. |
0ae4d4ae RL |
679 | * |
680 | * STATUS: OPTIONAL | |
42e9a92f | 681 | */ |
92261156 | 682 | void (*rport_recv_req)(struct fc_lport *, struct fc_frame *); |
42e9a92f | 683 | |
0ae4d4ae RL |
684 | /* |
685 | * lookup an rport by it's port ID. | |
686 | * | |
687 | * STATUS: OPTIONAL | |
42e9a92f | 688 | */ |
9fb9d328 | 689 | struct fc_rport_priv *(*rport_lookup)(const struct fc_lport *, u32); |
42e9a92f | 690 | |
f211fa51 JE |
691 | /* |
692 | * 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 | ||
75a2792d BPG |
697 | /* |
698 | * 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 | ||
42e9a92f RL |
706 | /* |
707 | * 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 | * | |
0ae4d4ae | 712 | * STATUS: OPTIONAL |
42e9a92f | 713 | */ |
3a3b42bf RL |
714 | int (*fcp_cmd_send)(struct fc_lport *, struct fc_fcp_pkt *, |
715 | void (*resp)(struct fc_seq *, struct fc_frame *, | |
716 | void *)); | |
42e9a92f RL |
717 | |
718 | /* | |
25985edc | 719 | * Cleanup the FCP layer, used during link down and reset |
0ae4d4ae RL |
720 | * |
721 | * STATUS: OPTIONAL | |
42e9a92f | 722 | */ |
3a3b42bf | 723 | void (*fcp_cleanup)(struct fc_lport *); |
42e9a92f RL |
724 | |
725 | /* | |
726 | * Abort all I/O on a local port | |
0ae4d4ae RL |
727 | * |
728 | * STATUS: OPTIONAL | |
42e9a92f | 729 | */ |
3a3b42bf | 730 | void (*fcp_abort_io)(struct fc_lport *); |
42e9a92f | 731 | |
0ae4d4ae RL |
732 | /* |
733 | * Receive a request for the discovery layer. | |
734 | * | |
735 | * STATUS: OPTIONAL | |
42e9a92f | 736 | */ |
92261156 | 737 | void (*disc_recv_req)(struct fc_lport *, struct fc_frame *); |
42e9a92f RL |
738 | |
739 | /* | |
740 | * Start discovery for a local port. | |
0ae4d4ae RL |
741 | * |
742 | * STATUS: OPTIONAL | |
42e9a92f RL |
743 | */ |
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 | |
0ae4d4ae RL |
751 | * |
752 | * STATUS: OPTIONAL | |
42e9a92f RL |
753 | */ |
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 | |
0ae4d4ae RL |
760 | * |
761 | * STATUS: OPTIONAL | |
42e9a92f RL |
762 | */ |
763 | void (*disc_stop_final) (struct fc_lport *); | |
764 | }; | |
765 | ||
3a3b42bf RL |
766 | /** |
767 | * struct fc_disc - Discovery context | |
768 | * @retry_count: Number of retries | |
769 | * @pending: 1 if discovery is pending, 0 if not | |
c531b9b4 | 770 | * @requested: 1 if discovery has been requested, 0 if not |
3a3b42bf RL |
771 | * @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 | |
0685230c | 775 | * @priv: Private pointer for use by discovery code |
3a3b42bf RL |
776 | * @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 | */ | |
42e9a92f | 782 | struct fc_disc { |
3a3b42bf RL |
783 | 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; | |
0685230c | 791 | void *priv; |
3a3b42bf RL |
792 | struct mutex disc_mutex; |
793 | struct fc_gpn_ft_resp partial_buf; | |
794 | struct delayed_work disc_work; | |
42e9a92f RL |
795 | |
796 | void (*disc_callback)(struct fc_lport *, | |
797 | enum fc_disc_event); | |
42e9a92f RL |
798 | }; |
799 | ||
70d53b04 JE |
800 | /* |
801 | * Local port notifier and events. | |
802 | */ | |
803 | extern struct blocking_notifier_head fc_lport_notifier_head; | |
804 | enum fc_lport_event { | |
805 | FC_LPORT_EV_ADD, | |
806 | FC_LPORT_EV_DEL, | |
807 | }; | |
808 | ||
3a3b42bf RL |
809 | /** |
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 | |
d78c317f | 814 | * @ms_rdata: The management server remote port |
3a3b42bf RL |
815 | * @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 | |
1bd49b48 | 826 | * @stats: FC local port stats (TODO separate libfc LLD stats) |
3a3b42bf | 827 | * @retry_count: Number of retries in the current state |
7b2787ec | 828 | * @port_id: FC Port ID |
3a3b42bf RL |
829 | * @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 | |
f90377ab | 844 | * @rport_priv_size: Size needed by driver after struct fc_rport_priv |
3a3b42bf RL |
845 | * @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 | |
70d53b04 | 849 | * @list: Linkage on list of vport peers |
3a3b42bf | 850 | * @retry_work: Handle to local port for delayed retry context |
baf9fdf0 | 851 | * @prov: Pointers available for use by passive FC-4 providers |
70d53b04 | 852 | * @lport_list: Linkage on module-wide list of local ports |
3a3b42bf | 853 | */ |
42e9a92f | 854 | struct fc_lport { |
42e9a92f | 855 | /* Associations */ |
3a3b42bf RL |
856 | struct Scsi_Host *host; |
857 | struct list_head ema_list; | |
858 | struct fc_rport_priv *dns_rdata; | |
d78c317f | 859 | struct fc_rport_priv *ms_rdata; |
3a3b42bf RL |
860 | 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; | |
42e9a92f RL |
867 | |
868 | /* Operational Information */ | |
869 | struct libfc_function_template tt; | |
3a3b42bf RL |
870 | u8 link_up; |
871 | u8 qfull; | |
872 | enum fc_lport_state state; | |
873 | unsigned long boot_time; | |
874 | struct fc_host_statistics host_stats; | |
1bd49b48 | 875 | struct fc_stats __percpu *stats; |
3a3b42bf RL |
876 | u8 retry_count; |
877 | ||
878 | /* Fabric information */ | |
7b2787ec | 879 | u32 port_id; |
3a3b42bf RL |
880 | 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; | |
42e9a92f RL |
886 | |
887 | /* Capabilities */ | |
3a3b42bf RL |
888 | 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; | |
3726f358 | 894 | u32 point_to_multipoint:1; |
d78c317f | 895 | u32 fdmi_enabled:1; |
3a3b42bf RL |
896 | u32 mfs; |
897 | u8 max_retry_count; | |
898 | u8 max_rport_retry_count; | |
f90377ab | 899 | u16 rport_priv_size; |
3a3b42bf RL |
900 | u16 link_speed; |
901 | u16 link_supported_speeds; | |
902 | u16 lro_xid; | |
903 | unsigned int lso_max; | |
904 | struct fc_ns_fts fcts; | |
42e9a92f RL |
905 | |
906 | /* Miscellaneous */ | |
3a3b42bf RL |
907 | struct mutex lp_mutex; |
908 | struct list_head list; | |
909 | struct delayed_work retry_work; | |
baf9fdf0 | 910 | void *prov[FC_FC4_PROV_SIZE]; |
70d53b04 | 911 | struct list_head lport_list; |
42e9a92f RL |
912 | }; |
913 | ||
96ad8464 JE |
914 | /** |
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 | */ | |
921 | struct 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 | */ | |
933 | int fc_fc4_register_provider(enum fc_fh_type type, struct fc4_prov *); | |
934 | void fc_fc4_deregister_provider(enum fc_fh_type type, struct fc4_prov *); | |
935 | ||
34f42a07 | 936 | /* |
42e9a92f RL |
937 | * FC_LPORT HELPER FUNCTIONS |
938 | *****************************/ | |
3a3b42bf RL |
939 | |
940 | /** | |
941 | * fc_lport_test_ready() - Determine if a local port is in the READY state | |
942 | * @lport: The local port to test | |
943 | */ | |
944 | static inline int fc_lport_test_ready(struct fc_lport *lport) | |
42e9a92f | 945 | { |
3a3b42bf | 946 | return lport->state == LPORT_ST_READY; |
42e9a92f RL |
947 | } |
948 | ||
3a3b42bf RL |
949 | /** |
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 | */ | |
954 | static inline void fc_set_wwnn(struct fc_lport *lport, u64 wwnn) | |
42e9a92f | 955 | { |
3a3b42bf | 956 | lport->wwnn = wwnn; |
42e9a92f RL |
957 | } |
958 | ||
3a3b42bf RL |
959 | /** |
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 | */ | |
964 | static inline void fc_set_wwpn(struct fc_lport *lport, u64 wwnn) | |
42e9a92f | 965 | { |
3a3b42bf | 966 | lport->wwpn = wwnn; |
42e9a92f RL |
967 | } |
968 | ||
3a3b42bf RL |
969 | /** |
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 | */ | |
974 | static inline void fc_lport_state_enter(struct fc_lport *lport, | |
42e9a92f RL |
975 | enum fc_lport_state state) |
976 | { | |
3a3b42bf RL |
977 | if (state != lport->state) |
978 | lport->retry_count = 0; | |
979 | lport->state = state; | |
42e9a92f RL |
980 | } |
981 | ||
3a3b42bf RL |
982 | /** |
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 | */ | |
986 | static inline int fc_lport_init_stats(struct fc_lport *lport) | |
582b45bc | 987 | { |
1bd49b48 VD |
988 | lport->stats = alloc_percpu(struct fc_stats); |
989 | if (!lport->stats) | |
582b45bc RL |
990 | return -ENOMEM; |
991 | return 0; | |
992 | } | |
993 | ||
3a3b42bf RL |
994 | /** |
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 | */ | |
998 | static inline void fc_lport_free_stats(struct fc_lport *lport) | |
582b45bc | 999 | { |
1bd49b48 | 1000 | free_percpu(lport->stats); |
582b45bc RL |
1001 | } |
1002 | ||
3a3b42bf RL |
1003 | /** |
1004 | * lport_priv() - Return the private data from a local port | |
1005 | * @lport: The local port whose private data is to be retreived | |
1006 | */ | |
1007 | static inline void *lport_priv(const struct fc_lport *lport) | |
a0a25da2 | 1008 | { |
3a3b42bf | 1009 | return (void *)(lport + 1); |
a0a25da2 VD |
1010 | } |
1011 | ||
1012 | /** | |
3a3b42bf RL |
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 | |
a0a25da2 | 1017 | * |
86221969 | 1018 | * Returns: libfc lport |
a0a25da2 | 1019 | */ |
86221969 | 1020 | static inline struct fc_lport * |
a0a25da2 VD |
1021 | libfc_host_alloc(struct scsi_host_template *sht, int priv_size) |
1022 | { | |
86221969 CL |
1023 | 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); | |
174e1ebf | 1032 | INIT_LIST_HEAD(&lport->vports); |
86221969 | 1033 | return lport; |
a0a25da2 | 1034 | } |
42e9a92f | 1035 | |
34f42a07 | 1036 | /* |
3a3b42bf | 1037 | * FC_FCP HELPER FUNCTIONS |
42e9a92f | 1038 | *****************************/ |
3a3b42bf RL |
1039 | static 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 | } | |
42e9a92f RL |
1045 | |
1046 | /* | |
3a3b42bf RL |
1047 | * LOCAL PORT LAYER |
1048 | *****************************/ | |
1049 | int fc_lport_init(struct fc_lport *); | |
1050 | int fc_lport_destroy(struct fc_lport *); | |
1051 | int fc_fabric_logoff(struct fc_lport *); | |
1052 | int fc_fabric_login(struct fc_lport *); | |
8faecddb | 1053 | void __fc_linkup(struct fc_lport *); |
42e9a92f | 1054 | void fc_linkup(struct fc_lport *); |
8faecddb | 1055 | void __fc_linkdown(struct fc_lport *); |
42e9a92f | 1056 | void fc_linkdown(struct fc_lport *); |
3a3b42bf RL |
1057 | void fc_vport_setlink(struct fc_lport *); |
1058 | void fc_vports_linkchange(struct fc_lport *); | |
42e9a92f | 1059 | int fc_lport_config(struct fc_lport *); |
42e9a92f | 1060 | int fc_lport_reset(struct fc_lport *); |
3a3b42bf RL |
1061 | int fc_set_mfs(struct fc_lport *, u32 mfs); |
1062 | struct fc_lport *libfc_vport_create(struct fc_vport *, int privsize); | |
1063 | struct fc_lport *fc_vport_id_lookup(struct fc_lport *, u32 port_id); | |
1064 | int fc_lport_bsg_request(struct fc_bsg_job *); | |
3726f358 | 1065 | void fc_lport_set_local_id(struct fc_lport *, u32 port_id); |
70d53b04 | 1066 | void fc_lport_iterate(void (*func)(struct fc_lport *, void *), void *); |
a51ab396 | 1067 | |
34f42a07 | 1068 | /* |
42e9a92f RL |
1069 | * REMOTE PORT LAYER |
1070 | *****************************/ | |
3a3b42bf RL |
1071 | int fc_rport_init(struct fc_lport *); |
1072 | void fc_rport_terminate_io(struct fc_rport *); | |
42e9a92f | 1073 | |
34f42a07 | 1074 | /* |
42e9a92f RL |
1075 | * DISCOVERY LAYER |
1076 | *****************************/ | |
3a3b42bf | 1077 | int fc_disc_init(struct fc_lport *); |
42e9a92f | 1078 | |
0685230c JE |
1079 | static inline struct fc_lport *fc_disc_lport(struct fc_disc *disc) |
1080 | { | |
1081 | return container_of(disc, struct fc_lport, disc); | |
1082 | } | |
1083 | ||
34f42a07 | 1084 | /* |
3a3b42bf | 1085 | * FCP LAYER |
42e9a92f | 1086 | *****************************/ |
42e9a92f | 1087 | int fc_fcp_init(struct fc_lport *); |
3a3b42bf | 1088 | void fc_fcp_destroy(struct fc_lport *); |
42e9a92f RL |
1089 | |
1090 | /* | |
3a3b42bf RL |
1091 | * SCSI INTERACTION LAYER |
1092 | *****************************/ | |
f281233d | 1093 | int fc_queuecommand(struct Scsi_Host *, struct scsi_cmnd *); |
3a3b42bf RL |
1094 | int fc_eh_abort(struct scsi_cmnd *); |
1095 | int fc_eh_device_reset(struct scsi_cmnd *); | |
1096 | int fc_eh_host_reset(struct scsi_cmnd *); | |
1097 | int fc_slave_alloc(struct scsi_device *); | |
1098 | int fc_change_queue_depth(struct scsi_device *, int qdepth, int reason); | |
1099 | int fc_change_queue_type(struct scsi_device *, int tag_type); | |
42e9a92f | 1100 | |
34f42a07 | 1101 | /* |
42e9a92f RL |
1102 | * ELS/CT interface |
1103 | *****************************/ | |
3a3b42bf RL |
1104 | int fc_elsct_init(struct fc_lport *); |
1105 | struct fc_seq *fc_elsct_send(struct fc_lport *, u32 did, | |
1106 | struct fc_frame *, | |
11b56188 CL |
1107 | unsigned int op, |
1108 | void (*resp)(struct fc_seq *, | |
3a3b42bf | 1109 | struct fc_frame *, |
11b56188 CL |
1110 | void *arg), |
1111 | void *arg, u32 timer_msec); | |
1112 | void fc_lport_flogi_resp(struct fc_seq *, struct fc_frame *, void *); | |
1113 | void fc_lport_logo_resp(struct fc_seq *, struct fc_frame *, void *); | |
24f089e2 JE |
1114 | void fc_fill_reply_hdr(struct fc_frame *, const struct fc_frame *, |
1115 | enum fc_rctl, u32 parm_offset); | |
1116 | void fc_fill_hdr(struct fc_frame *, const struct fc_frame *, | |
1117 | enum fc_rctl, u32 f_ctl, u16 seq_cnt, u32 parm_offset); | |
42e9a92f RL |
1118 | |
1119 | ||
34f42a07 | 1120 | /* |
42e9a92f RL |
1121 | * EXCHANGE MANAGER LAYER |
1122 | *****************************/ | |
3a3b42bf RL |
1123 | int fc_exch_init(struct fc_lport *); |
1124 | struct fc_exch_mgr_anchor *fc_exch_mgr_add(struct fc_lport *, | |
1125 | struct fc_exch_mgr *, | |
96316099 | 1126 | bool (*match)(struct fc_frame *)); |
3a3b42bf | 1127 | void fc_exch_mgr_del(struct fc_exch_mgr_anchor *); |
174e1ebf | 1128 | int fc_exch_mgr_list_clone(struct fc_lport *src, struct fc_lport *dst); |
3a3b42bf RL |
1129 | struct fc_exch_mgr *fc_exch_mgr_alloc(struct fc_lport *, enum fc_class class, |
1130 | u16 min_xid, u16 max_xid, | |
52ff878c | 1131 | bool (*match)(struct fc_frame *)); |
3a3b42bf RL |
1132 | void fc_exch_mgr_free(struct fc_lport *); |
1133 | void fc_exch_recv(struct fc_lport *, struct fc_frame *); | |
1f6ff364 | 1134 | void fc_exch_mgr_reset(struct fc_lport *, u32 s_id, u32 d_id); |
42e9a92f RL |
1135 | |
1136 | /* | |
1137 | * Functions for fc_functions_template | |
1138 | */ | |
3a3b42bf | 1139 | void fc_get_host_speed(struct Scsi_Host *); |
3a3b42bf RL |
1140 | void fc_get_host_port_state(struct Scsi_Host *); |
1141 | void fc_set_rport_loss_tmo(struct fc_rport *, u32 timeout); | |
42e9a92f RL |
1142 | struct fc_host_statistics *fc_get_host_stats(struct Scsi_Host *); |
1143 | ||
42e9a92f | 1144 | #endif /* _LIBFC_H_ */ |