Commit | Line | Data |
---|---|---|
1a59d1b8 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
9ef3e4a4 | 2 | /* |
1da177e4 LT |
3 | * FiberChannel transport specific attributes exported to sysfs. |
4 | * | |
5 | * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved. | |
a53eb5e0 | 6 | * Copyright (C) 2004-2007 James Smart, Emulex Corporation |
1da177e4 LT |
7 | * Rewrite for host, target, device, and remote port attributes, |
8 | * statistics, and service functions... | |
1da177e4 LT |
9 | */ |
10 | #ifndef SCSI_TRANSPORT_FC_H | |
11 | #define SCSI_TRANSPORT_FC_H | |
12 | ||
4e57b681 | 13 | #include <linux/sched.h> |
eb340948 | 14 | #include <linux/bsg-lib.h> |
ef3fb242 | 15 | #include <asm/unaligned.h> |
19a7b4ae | 16 | #include <scsi/scsi.h> |
84314fd4 | 17 | #include <scsi/scsi_netlink.h> |
75cc8cfc | 18 | #include <scsi/scsi_host.h> |
1da177e4 LT |
19 | |
20 | struct scsi_transport_template; | |
21 | ||
1da177e4 LT |
22 | /* |
23 | * FC Port definitions - Following FC HBAAPI guidelines | |
24 | * | |
25 | * Note: Not all binary values for the different fields match HBAAPI. | |
26 | * Instead, we use densely packed ordinal values or enums. | |
27 | * We get away with this as we never present the actual binary values | |
28 | * externally. For sysfs, we always present the string that describes | |
29 | * the value. Thus, an admin doesn't need a magic HBAAPI decoder ring | |
30 | * to understand the values. The HBAAPI user-space library is free to | |
31 | * convert the strings into the HBAAPI-specified binary values. | |
32 | * | |
33 | * Note: Not all HBAAPI-defined values are contained in the definitions | |
34 | * below. Those not appropriate to an fc_host (e.g. FCP initiator) have | |
35 | * been removed. | |
36 | */ | |
37 | ||
38 | /* | |
39 | * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c | |
40 | * (for the ascii descriptions). | |
41 | */ | |
42 | enum fc_port_type { | |
43 | FC_PORTTYPE_UNKNOWN, | |
44 | FC_PORTTYPE_OTHER, | |
45 | FC_PORTTYPE_NOTPRESENT, | |
46 | FC_PORTTYPE_NPORT, /* Attached to FPort */ | |
47 | FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */ | |
48 | FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */ | |
49 | FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */ | |
a53eb5e0 | 50 | FC_PORTTYPE_NPIV, /* VPORT based on NPIV */ |
1da177e4 LT |
51 | }; |
52 | ||
a53eb5e0 | 53 | |
1da177e4 LT |
54 | /* |
55 | * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c | |
56 | * (for the ascii descriptions). | |
57 | */ | |
58 | enum fc_port_state { | |
59 | FC_PORTSTATE_UNKNOWN, | |
60 | FC_PORTSTATE_NOTPRESENT, | |
61 | FC_PORTSTATE_ONLINE, | |
62 | FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */ | |
63 | FC_PORTSTATE_BLOCKED, | |
64 | FC_PORTSTATE_BYPASSED, | |
65 | FC_PORTSTATE_DIAGNOSTICS, | |
66 | FC_PORTSTATE_LINKDOWN, | |
67 | FC_PORTSTATE_ERROR, | |
68 | FC_PORTSTATE_LOOPBACK, | |
42e33148 | 69 | FC_PORTSTATE_DELETED, |
1da177e4 LT |
70 | }; |
71 | ||
72 | ||
a53eb5e0 JS |
73 | /* |
74 | * fc_vport_state: If you alter this, you also need to alter | |
75 | * scsi_transport_fc.c (for the ascii descriptions). | |
76 | */ | |
77 | enum fc_vport_state { | |
78 | FC_VPORT_UNKNOWN, | |
79 | FC_VPORT_ACTIVE, | |
80 | FC_VPORT_DISABLED, | |
81 | FC_VPORT_LINKDOWN, | |
82 | FC_VPORT_INITIALIZING, | |
83 | FC_VPORT_NO_FABRIC_SUPP, | |
84 | FC_VPORT_NO_FABRIC_RSCS, | |
85 | FC_VPORT_FABRIC_LOGOUT, | |
86 | FC_VPORT_FABRIC_REJ_WWN, | |
87 | FC_VPORT_FAILED, | |
88 | }; | |
89 | ||
90 | ||
91 | ||
9ef3e4a4 | 92 | /* |
1da177e4 LT |
93 | * FC Classes of Service |
94 | * Note: values are not enumerated, as they can be "or'd" together | |
95 | * for reporting (e.g. report supported_classes). If you alter this list, | |
96 | * you also need to alter scsi_transport_fc.c (for the ascii descriptions). | |
97 | */ | |
98 | #define FC_COS_UNSPECIFIED 0 | |
99 | #define FC_COS_CLASS1 2 | |
100 | #define FC_COS_CLASS2 4 | |
101 | #define FC_COS_CLASS3 8 | |
102 | #define FC_COS_CLASS4 0x10 | |
103 | #define FC_COS_CLASS6 0x40 | |
104 | ||
9ef3e4a4 | 105 | /* |
1da177e4 LT |
106 | * FC Port Speeds |
107 | * Note: values are not enumerated, as they can be "or'd" together | |
108 | * for reporting (e.g. report supported_speeds). If you alter this list, | |
109 | * you also need to alter scsi_transport_fc.c (for the ascii descriptions). | |
110 | */ | |
111 | #define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver | |
112 | incapable of reporting */ | |
113 | #define FC_PORTSPEED_1GBIT 1 | |
114 | #define FC_PORTSPEED_2GBIT 2 | |
a9277e77 NP |
115 | #define FC_PORTSPEED_10GBIT 4 |
116 | #define FC_PORTSPEED_4GBIT 8 | |
c3d2350a JS |
117 | #define FC_PORTSPEED_8GBIT 0x10 |
118 | #define FC_PORTSPEED_16GBIT 0x20 | |
624f28be | 119 | #define FC_PORTSPEED_32GBIT 0x40 |
c21a2c1a DK |
120 | #define FC_PORTSPEED_20GBIT 0x80 |
121 | #define FC_PORTSPEED_40GBIT 0x100 | |
122 | #define FC_PORTSPEED_50GBIT 0x200 | |
123 | #define FC_PORTSPEED_100GBIT 0x400 | |
c749e6bc | 124 | #define FC_PORTSPEED_25GBIT 0x800 |
cc019a5a JS |
125 | #define FC_PORTSPEED_64GBIT 0x1000 |
126 | #define FC_PORTSPEED_128GBIT 0x2000 | |
1da177e4 LT |
127 | #define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */ |
128 | ||
129 | /* | |
130 | * fc_tgtid_binding_type: If you alter this, you also need to alter | |
131 | * scsi_transport_fc.c (for the ascii descriptions). | |
132 | */ | |
133 | enum fc_tgtid_binding_type { | |
134 | FC_TGTID_BIND_NONE, | |
135 | FC_TGTID_BIND_BY_WWPN, | |
136 | FC_TGTID_BIND_BY_WWNN, | |
137 | FC_TGTID_BIND_BY_ID, | |
138 | }; | |
139 | ||
140 | /* | |
a53eb5e0 | 141 | * FC Port Roles |
1da177e4 LT |
142 | * Note: values are not enumerated, as they can be "or'd" together |
143 | * for reporting (e.g. report roles). If you alter this list, | |
144 | * you also need to alter scsi_transport_fc.c (for the ascii descriptions). | |
145 | */ | |
a53eb5e0 JS |
146 | #define FC_PORT_ROLE_UNKNOWN 0x00 |
147 | #define FC_PORT_ROLE_FCP_TARGET 0x01 | |
148 | #define FC_PORT_ROLE_FCP_INITIATOR 0x02 | |
149 | #define FC_PORT_ROLE_IP_PORT 0x04 | |
0c3ae266 | 150 | #define FC_PORT_ROLE_FCP_DUMMY_INITIATOR 0x08 |
a6a6d058 HR |
151 | #define FC_PORT_ROLE_NVME_INITIATOR 0x10 |
152 | #define FC_PORT_ROLE_NVME_TARGET 0x20 | |
153 | #define FC_PORT_ROLE_NVME_DISCOVERY 0x40 | |
a53eb5e0 JS |
154 | |
155 | /* The following are for compatibility */ | |
156 | #define FC_RPORT_ROLE_UNKNOWN FC_PORT_ROLE_UNKNOWN | |
157 | #define FC_RPORT_ROLE_FCP_TARGET FC_PORT_ROLE_FCP_TARGET | |
158 | #define FC_RPORT_ROLE_FCP_INITIATOR FC_PORT_ROLE_FCP_INITIATOR | |
159 | #define FC_RPORT_ROLE_IP_PORT FC_PORT_ROLE_IP_PORT | |
160 | ||
161 | ||
162 | /* Macro for use in defining Virtual Port attributes */ | |
ee959b00 TJ |
163 | #define FC_VPORT_ATTR(_name,_mode,_show,_store) \ |
164 | struct device_attribute dev_attr_vport_##_name = \ | |
a53eb5e0 | 165 | __ATTR(_name,_mode,_show,_store) |
1da177e4 | 166 | |
a30c3f69 AV |
167 | /* |
168 | * fc_vport_identifiers: This set of data contains all elements | |
169 | * to uniquely identify and instantiate a FC virtual port. | |
170 | * | |
171 | * Notes: | |
172 | * symbolic_name: The driver is to append the symbolic_name string data | |
173 | * to the symbolic_node_name data that it generates by default. | |
174 | * the resulting combination should then be registered with the switch. | |
175 | * It is expected that things like Xen may stuff a VM title into | |
176 | * this field. | |
177 | */ | |
178 | #define FC_VPORT_SYMBOLIC_NAMELEN 64 | |
179 | struct fc_vport_identifiers { | |
180 | u64 node_name; | |
181 | u64 port_name; | |
182 | u32 roles; | |
183 | bool disable; | |
184 | enum fc_port_type vport_type; /* only FC_PORTTYPE_NPIV allowed */ | |
185 | char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN]; | |
186 | }; | |
1da177e4 | 187 | |
a53eb5e0 JS |
188 | /* |
189 | * FC Virtual Port Attributes | |
190 | * | |
191 | * This structure exists for each FC port is a virtual FC port. Virtual | |
192 | * ports share the physical link with the Physical port. Each virtual | |
25985edc | 193 | * ports has a unique presence on the SAN, and may be instantiated via |
a53eb5e0 | 194 | * NPIV, Virtual Fabrics, or via additional ALPAs. As the vport is a |
25985edc | 195 | * unique presence, each vport has it's own view of the fabric, |
1e4478c3 | 196 | * authentication privilege, and priorities. |
a53eb5e0 JS |
197 | * |
198 | * A virtual port may support 1 or more FC4 roles. Typically it is a | |
199 | * FCP Initiator. It could be a FCP Target, or exist sole for an IP over FC | |
200 | * roles. FC port attributes for the vport will be reported on any | |
201 | * fc_host class object allocated for an FCP Initiator. | |
202 | * | |
203 | * -- | |
204 | * | |
205 | * Fixed attributes are not expected to change. The driver is | |
206 | * expected to set these values after receiving the fc_vport structure | |
207 | * via the vport_create() call from the transport. | |
208 | * The transport fully manages all get functions w/o driver interaction. | |
209 | * | |
210 | * Dynamic attributes are expected to change. The driver participates | |
211 | * in all get/set operations via functions provided by the driver. | |
212 | * | |
213 | * Private attributes are transport-managed values. They are fully | |
214 | * managed by the transport w/o driver interaction. | |
215 | */ | |
216 | ||
a53eb5e0 JS |
217 | struct fc_vport { |
218 | /* Fixed Attributes */ | |
219 | ||
220 | /* Dynamic Attributes */ | |
221 | ||
222 | /* Private (Transport-managed) Attributes */ | |
223 | enum fc_vport_state vport_state; | |
224 | enum fc_vport_state vport_last_state; | |
225 | u64 node_name; | |
226 | u64 port_name; | |
227 | u32 roles; | |
228 | u32 vport_id; /* Admin Identifier for the vport */ | |
229 | enum fc_port_type vport_type; | |
230 | char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN]; | |
231 | ||
232 | /* exported data */ | |
233 | void *dd_data; /* Used for driver-specific storage */ | |
234 | ||
235 | /* internal data */ | |
236 | struct Scsi_Host *shost; /* Physical Port Parent */ | |
237 | unsigned int channel; | |
238 | u32 number; | |
239 | u8 flags; | |
240 | struct list_head peers; | |
241 | struct device dev; | |
9ef3e4a4 | 242 | struct work_struct vport_delete_work; |
a53eb5e0 JS |
243 | } __attribute__((aligned(sizeof(unsigned long)))); |
244 | ||
245 | /* bit field values for struct fc_vport "flags" field: */ | |
246 | #define FC_VPORT_CREATING 0x01 | |
247 | #define FC_VPORT_DELETING 0x02 | |
248 | #define FC_VPORT_DELETED 0x04 | |
249 | #define FC_VPORT_DEL 0x06 /* Any DELETE state */ | |
250 | ||
251 | #define dev_to_vport(d) \ | |
252 | container_of(d, struct fc_vport, dev) | |
ee959b00 TJ |
253 | #define transport_class_to_vport(dev) \ |
254 | dev_to_vport(dev->parent) | |
a53eb5e0 JS |
255 | #define vport_to_shost(v) \ |
256 | (v->shost) | |
257 | #define vport_to_shost_channel(v) \ | |
258 | (v->channel) | |
259 | #define vport_to_parent(v) \ | |
260 | (v->dev.parent) | |
261 | ||
262 | ||
263 | /* Error return codes for vport_create() callback */ | |
264 | #define VPCERR_UNSUPPORTED -ENOSYS /* no driver/adapter | |
265 | support */ | |
266 | #define VPCERR_BAD_WWN -ENOTUNIQ /* driver validation | |
267 | of WWNs failed */ | |
268 | #define VPCERR_NO_FABRIC_SUPP -EOPNOTSUPP /* Fabric connection | |
269 | is loop or the | |
270 | Fabric Port does | |
271 | not support NPIV */ | |
272 | ||
1da177e4 LT |
273 | /* |
274 | * fc_rport_identifiers: This set of data contains all elements | |
275 | * to uniquely identify a remote FC port. The driver uses this data | |
276 | * to report the existence of a remote FC port in the topology. Internally, | |
277 | * the transport uses this data for attributes and to manage consistent | |
278 | * target id bindings. | |
279 | */ | |
280 | struct fc_rport_identifiers { | |
281 | u64 node_name; | |
282 | u64 port_name; | |
283 | u32 port_id; | |
284 | u32 roles; | |
285 | }; | |
286 | ||
a53eb5e0 | 287 | |
1da177e4 LT |
288 | /* Macro for use in defining Remote Port attributes */ |
289 | #define FC_RPORT_ATTR(_name,_mode,_show,_store) \ | |
ee959b00 | 290 | struct device_attribute dev_attr_rport_##_name = \ |
1da177e4 LT |
291 | __ATTR(_name,_mode,_show,_store) |
292 | ||
293 | ||
294 | /* | |
295 | * FC Remote Port Attributes | |
296 | * | |
297 | * This structure exists for each remote FC port that a LLDD notifies | |
298 | * the subsystem of. A remote FC port may or may not be a SCSI Target, | |
299 | * also be a SCSI initiator, IP endpoint, etc. As such, the remote | |
300 | * port is considered a separate entity, independent of "role" (such | |
301 | * as scsi target). | |
302 | * | |
303 | * -- | |
304 | * | |
305 | * Attributes are based on HBAAPI V2.0 definitions. Only those | |
306 | * attributes that are determinable by the local port (aka Host) | |
307 | * are contained. | |
308 | * | |
309 | * Fixed attributes are not expected to change. The driver is | |
310 | * expected to set these values after successfully calling | |
311 | * fc_remote_port_add(). The transport fully manages all get functions | |
312 | * w/o driver interaction. | |
313 | * | |
314 | * Dynamic attributes are expected to change. The driver participates | |
315 | * in all get/set operations via functions provided by the driver. | |
316 | * | |
317 | * Private attributes are transport-managed values. They are fully | |
318 | * managed by the transport w/o driver interaction. | |
319 | */ | |
320 | ||
321 | struct fc_rport { /* aka fc_starget_attrs */ | |
322 | /* Fixed Attributes */ | |
323 | u32 maxframe_size; | |
324 | u32 supported_classes; | |
325 | ||
326 | /* Dynamic Attributes */ | |
327 | u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */ | |
328 | ||
329 | /* Private (Transport-managed) Attributes */ | |
330 | u64 node_name; | |
331 | u64 port_name; | |
332 | u32 port_id; | |
333 | u32 roles; | |
334 | enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */ | |
335 | u32 scsi_target_id; | |
0f29b966 | 336 | u32 fast_io_fail_tmo; |
1da177e4 LT |
337 | |
338 | /* exported data */ | |
339 | void *dd_data; /* Used for driver-specific storage */ | |
340 | ||
341 | /* internal data */ | |
342 | unsigned int channel; | |
343 | u32 number; | |
aedf3497 | 344 | u8 flags; |
1da177e4 LT |
345 | struct list_head peers; |
346 | struct device dev; | |
c4028958 | 347 | struct delayed_work dev_loss_work; |
1da177e4 | 348 | struct work_struct scan_work; |
c4028958 | 349 | struct delayed_work fail_io_work; |
aedf3497 JS |
350 | struct work_struct stgt_delete_work; |
351 | struct work_struct rport_delete_work; | |
9e4f5e29 | 352 | struct request_queue *rqst_q; /* bsg support */ |
1da177e4 LT |
353 | } __attribute__((aligned(sizeof(unsigned long)))); |
354 | ||
aedf3497 JS |
355 | /* bit field values for struct fc_rport "flags" field: */ |
356 | #define FC_RPORT_DEVLOSS_PENDING 0x01 | |
357 | #define FC_RPORT_SCAN_PENDING 0x02 | |
21098c68 | 358 | #define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04 |
4be98c0c | 359 | #define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08 |
aedf3497 | 360 | |
1da177e4 LT |
361 | #define dev_to_rport(d) \ |
362 | container_of(d, struct fc_rport, dev) | |
ee959b00 TJ |
363 | #define transport_class_to_rport(dev) \ |
364 | dev_to_rport(dev->parent) | |
1da177e4 LT |
365 | #define rport_to_shost(r) \ |
366 | dev_to_shost(r->dev.parent) | |
367 | ||
368 | /* | |
369 | * FC SCSI Target Attributes | |
370 | * | |
25985edc | 371 | * The SCSI Target is considered an extension of a remote port (as |
1da177e4 LT |
372 | * a remote port can be more than a SCSI Target). Within the scsi |
373 | * subsystem, we leave the Target as a separate entity. Doing so | |
374 | * provides backward compatibility with prior FC transport api's, | |
375 | * and lets remote ports be handled entirely within the FC transport | |
376 | * and independently from the scsi subsystem. The drawback is that | |
377 | * some data will be duplicated. | |
378 | */ | |
379 | ||
380 | struct fc_starget_attrs { /* aka fc_target_attrs */ | |
381 | /* Dynamic Attributes */ | |
382 | u64 node_name; | |
383 | u64 port_name; | |
384 | u32 port_id; | |
385 | }; | |
386 | ||
387 | #define fc_starget_node_name(x) \ | |
388 | (((struct fc_starget_attrs *)&(x)->starget_data)->node_name) | |
389 | #define fc_starget_port_name(x) \ | |
390 | (((struct fc_starget_attrs *)&(x)->starget_data)->port_name) | |
391 | #define fc_starget_port_id(x) \ | |
392 | (((struct fc_starget_attrs *)&(x)->starget_data)->port_id) | |
393 | ||
394 | #define starget_to_rport(s) \ | |
395 | scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL | |
396 | ||
397 | ||
398 | /* | |
399 | * FC Local Port (Host) Statistics | |
400 | */ | |
401 | ||
402 | /* FC Statistics - Following FC HBAAPI v2.0 guidelines */ | |
403 | struct fc_host_statistics { | |
404 | /* port statistics */ | |
405 | u64 seconds_since_last_reset; | |
406 | u64 tx_frames; | |
407 | u64 tx_words; | |
408 | u64 rx_frames; | |
409 | u64 rx_words; | |
410 | u64 lip_count; | |
411 | u64 nos_count; | |
412 | u64 error_frames; | |
413 | u64 dumped_frames; | |
414 | u64 link_failure_count; | |
415 | u64 loss_of_sync_count; | |
416 | u64 loss_of_signal_count; | |
417 | u64 prim_seq_protocol_err_count; | |
418 | u64 invalid_tx_word_count; | |
419 | u64 invalid_crc_count; | |
9ef3e4a4 | 420 | |
1da177e4 LT |
421 | /* fc4 statistics (only FCP supported currently) */ |
422 | u64 fcp_input_requests; | |
423 | u64 fcp_output_requests; | |
424 | u64 fcp_control_requests; | |
425 | u64 fcp_input_megabytes; | |
426 | u64 fcp_output_megabytes; | |
e58abb0c VD |
427 | u64 fcp_packet_alloc_failures; /* fcp packet allocation failures */ |
428 | u64 fcp_packet_aborts; /* fcp packet aborted */ | |
429 | u64 fcp_frame_alloc_failures; /* fcp frame allocation failures */ | |
430 | ||
431 | /* fc exches statistics */ | |
432 | u64 fc_no_free_exch; /* no free exch memory */ | |
433 | u64 fc_no_free_exch_xid; /* no free exch id */ | |
434 | u64 fc_xid_not_found; /* exch not found for a response */ | |
435 | u64 fc_xid_busy; /* exch exist for new a request */ | |
436 | u64 fc_seq_not_found; /* seq is not found for exchange */ | |
437 | u64 fc_non_bls_resp; /* a non BLS response frame with | |
438 | a sequence responder in new exch */ | |
1da177e4 LT |
439 | }; |
440 | ||
441 | ||
84314fd4 JS |
442 | /* |
443 | * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines | |
444 | */ | |
445 | ||
446 | /* | |
447 | * fc_host_event_code: If you alter this, you also need to alter | |
448 | * scsi_transport_fc.c (for the ascii descriptions). | |
449 | */ | |
450 | enum fc_host_event_code { | |
451 | FCH_EVT_LIP = 0x1, | |
452 | FCH_EVT_LINKUP = 0x2, | |
453 | FCH_EVT_LINKDOWN = 0x3, | |
454 | FCH_EVT_LIPRESET = 0x4, | |
455 | FCH_EVT_RSCN = 0x5, | |
456 | FCH_EVT_ADAPTER_CHANGE = 0x103, | |
457 | FCH_EVT_PORT_UNKNOWN = 0x200, | |
458 | FCH_EVT_PORT_OFFLINE = 0x201, | |
459 | FCH_EVT_PORT_ONLINE = 0x202, | |
460 | FCH_EVT_PORT_FABRIC = 0x204, | |
461 | FCH_EVT_LINK_UNKNOWN = 0x500, | |
c39e0af6 | 462 | FCH_EVT_LINK_FPIN = 0x501, |
84314fd4 JS |
463 | FCH_EVT_VENDOR_UNIQUE = 0xffff, |
464 | }; | |
465 | ||
466 | ||
1da177e4 LT |
467 | /* |
468 | * FC Local Port (Host) Attributes | |
469 | * | |
470 | * Attributes are based on HBAAPI V2.0 definitions. | |
471 | * Note: OSDeviceName is determined by user-space library | |
472 | * | |
473 | * Fixed attributes are not expected to change. The driver is | |
474 | * expected to set these values after successfully calling scsi_add_host(). | |
475 | * The transport fully manages all get functions w/o driver interaction. | |
476 | * | |
477 | * Dynamic attributes are expected to change. The driver participates | |
478 | * in all get/set operations via functions provided by the driver. | |
479 | * | |
480 | * Private attributes are transport-managed values. They are fully | |
481 | * managed by the transport w/o driver interaction. | |
482 | */ | |
483 | ||
484 | #define FC_FC4_LIST_SIZE 32 | |
485 | #define FC_SYMBOLIC_NAME_SIZE 256 | |
486 | #define FC_VERSION_STRING_SIZE 64 | |
487 | #define FC_SERIAL_NUMBER_SIZE 80 | |
488 | ||
489 | struct fc_host_attrs { | |
490 | /* Fixed Attributes */ | |
491 | u64 node_name; | |
492 | u64 port_name; | |
6b7281d0 | 493 | u64 permanent_port_name; |
1da177e4 LT |
494 | u32 supported_classes; |
495 | u8 supported_fc4s[FC_FC4_LIST_SIZE]; | |
1da177e4 LT |
496 | u32 supported_speeds; |
497 | u32 maxframe_size; | |
a53eb5e0 | 498 | u16 max_npiv_vports; |
1da177e4 | 499 | char serial_number[FC_SERIAL_NUMBER_SIZE]; |
bb8ef587 NP |
500 | char manufacturer[FC_SERIAL_NUMBER_SIZE]; |
501 | char model[FC_SYMBOLIC_NAME_SIZE]; | |
502 | char model_description[FC_SYMBOLIC_NAME_SIZE]; | |
503 | char hardware_version[FC_VERSION_STRING_SIZE]; | |
504 | char driver_version[FC_VERSION_STRING_SIZE]; | |
505 | char firmware_version[FC_VERSION_STRING_SIZE]; | |
506 | char optionrom_version[FC_VERSION_STRING_SIZE]; | |
1da177e4 LT |
507 | |
508 | /* Dynamic Attributes */ | |
509 | u32 port_id; | |
510 | enum fc_port_type port_type; | |
511 | enum fc_port_state port_state; | |
512 | u8 active_fc4s[FC_FC4_LIST_SIZE]; | |
513 | u32 speed; | |
514 | u64 fabric_name; | |
b8d08210 JS |
515 | char symbolic_name[FC_SYMBOLIC_NAME_SIZE]; |
516 | char system_hostname[FC_SYMBOLIC_NAME_SIZE]; | |
43ca910a | 517 | u32 dev_loss_tmo; |
1da177e4 LT |
518 | |
519 | /* Private (Transport-managed) Attributes */ | |
520 | enum fc_tgtid_binding_type tgtid_bind_type; | |
521 | ||
522 | /* internal data */ | |
523 | struct list_head rports; | |
524 | struct list_head rport_bindings; | |
a53eb5e0 | 525 | struct list_head vports; |
1da177e4 LT |
526 | u32 next_rport_number; |
527 | u32 next_target_id; | |
a53eb5e0 JS |
528 | u32 next_vport_number; |
529 | u16 npiv_vports_inuse; | |
1da177e4 | 530 | |
aedf3497 | 531 | /* work queues for rport state manipulation */ |
aab0de24 | 532 | char work_q_name[20]; |
aedf3497 | 533 | struct workqueue_struct *work_q; |
aab0de24 | 534 | char devloss_work_q_name[20]; |
aedf3497 | 535 | struct workqueue_struct *devloss_work_q; |
9e4f5e29 JS |
536 | |
537 | /* bsg support */ | |
538 | struct request_queue *rqst_q; | |
aedf3497 | 539 | }; |
42e33148 | 540 | |
aedf3497 JS |
541 | #define shost_to_fc_host(x) \ |
542 | ((struct fc_host_attrs *)(x)->shost_data) | |
42e33148 | 543 | |
1da177e4 LT |
544 | #define fc_host_node_name(x) \ |
545 | (((struct fc_host_attrs *)(x)->shost_data)->node_name) | |
546 | #define fc_host_port_name(x) \ | |
547 | (((struct fc_host_attrs *)(x)->shost_data)->port_name) | |
6b7281d0 AH |
548 | #define fc_host_permanent_port_name(x) \ |
549 | (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name) | |
1da177e4 LT |
550 | #define fc_host_supported_classes(x) \ |
551 | (((struct fc_host_attrs *)(x)->shost_data)->supported_classes) | |
552 | #define fc_host_supported_fc4s(x) \ | |
553 | (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s) | |
1da177e4 LT |
554 | #define fc_host_supported_speeds(x) \ |
555 | (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds) | |
556 | #define fc_host_maxframe_size(x) \ | |
557 | (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size) | |
a53eb5e0 JS |
558 | #define fc_host_max_npiv_vports(x) \ |
559 | (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports) | |
1da177e4 LT |
560 | #define fc_host_serial_number(x) \ |
561 | (((struct fc_host_attrs *)(x)->shost_data)->serial_number) | |
bb8ef587 NP |
562 | #define fc_host_manufacturer(x) \ |
563 | (((struct fc_host_attrs *)(x)->shost_data)->manufacturer) | |
564 | #define fc_host_model(x) \ | |
565 | (((struct fc_host_attrs *)(x)->shost_data)->model) | |
566 | #define fc_host_model_description(x) \ | |
567 | (((struct fc_host_attrs *)(x)->shost_data)->model_description) | |
568 | #define fc_host_hardware_version(x) \ | |
569 | (((struct fc_host_attrs *)(x)->shost_data)->hardware_version) | |
570 | #define fc_host_driver_version(x) \ | |
571 | (((struct fc_host_attrs *)(x)->shost_data)->driver_version) | |
572 | #define fc_host_firmware_version(x) \ | |
573 | (((struct fc_host_attrs *)(x)->shost_data)->firmware_version) | |
574 | #define fc_host_optionrom_version(x) \ | |
575 | (((struct fc_host_attrs *)(x)->shost_data)->optionrom_version) | |
1da177e4 LT |
576 | #define fc_host_port_id(x) \ |
577 | (((struct fc_host_attrs *)(x)->shost_data)->port_id) | |
578 | #define fc_host_port_type(x) \ | |
579 | (((struct fc_host_attrs *)(x)->shost_data)->port_type) | |
580 | #define fc_host_port_state(x) \ | |
581 | (((struct fc_host_attrs *)(x)->shost_data)->port_state) | |
582 | #define fc_host_active_fc4s(x) \ | |
583 | (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s) | |
584 | #define fc_host_speed(x) \ | |
585 | (((struct fc_host_attrs *)(x)->shost_data)->speed) | |
586 | #define fc_host_fabric_name(x) \ | |
587 | (((struct fc_host_attrs *)(x)->shost_data)->fabric_name) | |
b8d08210 JS |
588 | #define fc_host_symbolic_name(x) \ |
589 | (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name) | |
590 | #define fc_host_system_hostname(x) \ | |
591 | (((struct fc_host_attrs *)(x)->shost_data)->system_hostname) | |
1da177e4 LT |
592 | #define fc_host_tgtid_bind_type(x) \ |
593 | (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type) | |
594 | #define fc_host_rports(x) \ | |
595 | (((struct fc_host_attrs *)(x)->shost_data)->rports) | |
596 | #define fc_host_rport_bindings(x) \ | |
597 | (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings) | |
a53eb5e0 JS |
598 | #define fc_host_vports(x) \ |
599 | (((struct fc_host_attrs *)(x)->shost_data)->vports) | |
1da177e4 LT |
600 | #define fc_host_next_rport_number(x) \ |
601 | (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number) | |
602 | #define fc_host_next_target_id(x) \ | |
603 | (((struct fc_host_attrs *)(x)->shost_data)->next_target_id) | |
a53eb5e0 JS |
604 | #define fc_host_next_vport_number(x) \ |
605 | (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number) | |
606 | #define fc_host_npiv_vports_inuse(x) \ | |
607 | (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse) | |
aedf3497 JS |
608 | #define fc_host_work_q_name(x) \ |
609 | (((struct fc_host_attrs *)(x)->shost_data)->work_q_name) | |
610 | #define fc_host_work_q(x) \ | |
611 | (((struct fc_host_attrs *)(x)->shost_data)->work_q) | |
612 | #define fc_host_devloss_work_q_name(x) \ | |
613 | (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name) | |
614 | #define fc_host_devloss_work_q(x) \ | |
615 | (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q) | |
43ca910a MC |
616 | #define fc_host_dev_loss_tmo(x) \ |
617 | (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo) | |
1da177e4 | 618 | |
1da177e4 LT |
619 | /* The functions by which the transport class and the driver communicate */ |
620 | struct fc_function_template { | |
621 | void (*get_rport_dev_loss_tmo)(struct fc_rport *); | |
622 | void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32); | |
623 | ||
624 | void (*get_starget_node_name)(struct scsi_target *); | |
625 | void (*get_starget_port_name)(struct scsi_target *); | |
626 | void (*get_starget_port_id)(struct scsi_target *); | |
627 | ||
628 | void (*get_host_port_id)(struct Scsi_Host *); | |
629 | void (*get_host_port_type)(struct Scsi_Host *); | |
630 | void (*get_host_port_state)(struct Scsi_Host *); | |
631 | void (*get_host_active_fc4s)(struct Scsi_Host *); | |
632 | void (*get_host_speed)(struct Scsi_Host *); | |
633 | void (*get_host_fabric_name)(struct Scsi_Host *); | |
016131b8 | 634 | void (*get_host_symbolic_name)(struct Scsi_Host *); |
b8d08210 | 635 | void (*set_host_system_hostname)(struct Scsi_Host *); |
1da177e4 LT |
636 | |
637 | struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *); | |
638 | void (*reset_fc_host_stats)(struct Scsi_Host *); | |
639 | ||
91ca7b01 AV |
640 | int (*issue_fc_host_lip)(struct Scsi_Host *); |
641 | ||
0f29b966 JS |
642 | void (*dev_loss_tmo_callbk)(struct fc_rport *); |
643 | void (*terminate_rport_io)(struct fc_rport *); | |
644 | ||
a53eb5e0 JS |
645 | void (*set_vport_symbolic_name)(struct fc_vport *); |
646 | int (*vport_create)(struct fc_vport *, bool); | |
647 | int (*vport_disable)(struct fc_vport *, bool); | |
648 | int (*vport_delete)(struct fc_vport *); | |
649 | ||
9e4f5e29 | 650 | /* bsg support */ |
75cc8cfc JT |
651 | int (*bsg_request)(struct bsg_job *); |
652 | int (*bsg_timeout)(struct bsg_job *); | |
9e4f5e29 | 653 | |
1da177e4 LT |
654 | /* allocation lengths for host-specific data */ |
655 | u32 dd_fcrport_size; | |
a53eb5e0 | 656 | u32 dd_fcvport_size; |
9e4f5e29 | 657 | u32 dd_bsg_size; |
1da177e4 | 658 | |
9ef3e4a4 | 659 | /* |
1da177e4 LT |
660 | * The driver sets these to tell the transport class it |
661 | * wants the attributes displayed in sysfs. If the show_ flag | |
662 | * is not set, the attribute will be private to the transport | |
9ef3e4a4 | 663 | * class |
1da177e4 LT |
664 | */ |
665 | ||
666 | /* remote port fixed attributes */ | |
667 | unsigned long show_rport_maxframe_size:1; | |
668 | unsigned long show_rport_supported_classes:1; | |
669 | unsigned long show_rport_dev_loss_tmo:1; | |
670 | ||
671 | /* | |
672 | * target dynamic attributes | |
673 | * These should all be "1" if the driver uses the remote port | |
674 | * add/delete functions (so attributes reflect rport values). | |
675 | */ | |
676 | unsigned long show_starget_node_name:1; | |
677 | unsigned long show_starget_port_name:1; | |
678 | unsigned long show_starget_port_id:1; | |
679 | ||
680 | /* host fixed attributes */ | |
681 | unsigned long show_host_node_name:1; | |
682 | unsigned long show_host_port_name:1; | |
6b7281d0 | 683 | unsigned long show_host_permanent_port_name:1; |
1da177e4 LT |
684 | unsigned long show_host_supported_classes:1; |
685 | unsigned long show_host_supported_fc4s:1; | |
1da177e4 LT |
686 | unsigned long show_host_supported_speeds:1; |
687 | unsigned long show_host_maxframe_size:1; | |
688 | unsigned long show_host_serial_number:1; | |
bb8ef587 NP |
689 | unsigned long show_host_manufacturer:1; |
690 | unsigned long show_host_model:1; | |
691 | unsigned long show_host_model_description:1; | |
692 | unsigned long show_host_hardware_version:1; | |
693 | unsigned long show_host_driver_version:1; | |
694 | unsigned long show_host_firmware_version:1; | |
695 | unsigned long show_host_optionrom_version:1; | |
1da177e4 LT |
696 | /* host dynamic attributes */ |
697 | unsigned long show_host_port_id:1; | |
698 | unsigned long show_host_port_type:1; | |
699 | unsigned long show_host_port_state:1; | |
700 | unsigned long show_host_active_fc4s:1; | |
701 | unsigned long show_host_speed:1; | |
702 | unsigned long show_host_fabric_name:1; | |
016131b8 | 703 | unsigned long show_host_symbolic_name:1; |
b8d08210 | 704 | unsigned long show_host_system_hostname:1; |
03f002f7 CS |
705 | |
706 | unsigned long disable_target_scan:1; | |
1da177e4 LT |
707 | }; |
708 | ||
709 | ||
19a7b4ae JSEC |
710 | /** |
711 | * fc_remote_port_chkready - called to validate the remote port state | |
712 | * prior to initiating io to the port. | |
713 | * | |
714 | * Returns a scsi result code that can be returned by the LLDD. | |
715 | * | |
716 | * @rport: remote port to be checked | |
717 | **/ | |
718 | static inline int | |
719 | fc_remote_port_chkready(struct fc_rport *rport) | |
720 | { | |
721 | int result; | |
722 | ||
723 | switch (rport->port_state) { | |
724 | case FC_PORTSTATE_ONLINE: | |
a53eb5e0 | 725 | if (rport->roles & FC_PORT_ROLE_FCP_TARGET) |
aedf3497 JS |
726 | result = 0; |
727 | else if (rport->flags & FC_RPORT_DEVLOSS_PENDING) | |
9a1a69a1 | 728 | result = DID_IMM_RETRY << 16; |
aedf3497 JS |
729 | else |
730 | result = DID_NO_CONNECT << 16; | |
19a7b4ae JSEC |
731 | break; |
732 | case FC_PORTSTATE_BLOCKED: | |
fff9d40c | 733 | if (rport->flags & FC_RPORT_FAST_FAIL_TIMEDOUT) |
f46e307d | 734 | result = DID_TRANSPORT_FAILFAST << 16; |
fff9d40c | 735 | else |
9a1a69a1 | 736 | result = DID_IMM_RETRY << 16; |
19a7b4ae JSEC |
737 | break; |
738 | default: | |
739 | result = DID_NO_CONNECT << 16; | |
740 | break; | |
741 | } | |
742 | return result; | |
743 | } | |
744 | ||
5585cbdd | 745 | static inline u64 wwn_to_u64(const u8 *wwn) |
b8d08210 | 746 | { |
ef3fb242 | 747 | return get_unaligned_be64(wwn); |
b8d08210 JS |
748 | } |
749 | ||
750 | static inline void u64_to_wwn(u64 inm, u8 *wwn) | |
751 | { | |
ef3fb242 | 752 | put_unaligned_be64(inm, wwn); |
b8d08210 | 753 | } |
19a7b4ae | 754 | |
a53eb5e0 JS |
755 | /** |
756 | * fc_vport_set_state() - called to set a vport's state. Saves the old state, | |
757 | * excepting the transitory states of initializing and sending the ELS | |
758 | * traffic to instantiate the vport on the link. | |
759 | * | |
760 | * Assumes the driver has surrounded this with the proper locking to ensure | |
761 | * a coherent state change. | |
762 | * | |
763 | * @vport: virtual port whose state is changing | |
764 | * @new_state: new state | |
765 | **/ | |
766 | static inline void | |
767 | fc_vport_set_state(struct fc_vport *vport, enum fc_vport_state new_state) | |
768 | { | |
769 | if ((new_state != FC_VPORT_UNKNOWN) && | |
770 | (new_state != FC_VPORT_INITIALIZING)) | |
771 | vport->vport_last_state = vport->vport_state; | |
772 | vport->vport_state = new_state; | |
773 | } | |
774 | ||
1da177e4 LT |
775 | struct scsi_transport_template *fc_attach_transport( |
776 | struct fc_function_template *); | |
777 | void fc_release_transport(struct scsi_transport_template *); | |
778 | void fc_remove_host(struct Scsi_Host *); | |
779 | struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost, | |
780 | int channel, struct fc_rport_identifiers *ids); | |
781 | void fc_remote_port_delete(struct fc_rport *rport); | |
782 | void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles); | |
1da177e4 | 783 | int scsi_is_fc_rport(const struct device *); |
84314fd4 JS |
784 | u32 fc_get_event_number(void); |
785 | void fc_host_post_event(struct Scsi_Host *shost, u32 event_number, | |
786 | enum fc_host_event_code event_code, u32 event_data); | |
787 | void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number, | |
2b1be558 JS |
788 | u32 data_len, char *data_buf, u64 vendor_id); |
789 | void fc_host_post_fc_event(struct Scsi_Host *shost, u32 event_number, | |
790 | enum fc_host_event_code event_code, | |
791 | u32 data_len, char *data_buf, u64 vendor_id); | |
84314fd4 | 792 | /* Note: when specifying vendor_id to fc_host_post_vendor_event() |
2b1be558 JS |
793 | * or fc_host_post_fc_event(), be sure to read the Vendor Type |
794 | * and ID formatting requirements specified in scsi_netlink.h | |
795 | * Note: when calling fc_host_post_fc_event(), vendor_id may be | |
796 | * specified as 0. | |
84314fd4 | 797 | */ |
c39e0af6 | 798 | void fc_host_fpin_rcv(struct Scsi_Host *shost, u32 fpin_len, char *fpin_buf); |
a30c3f69 AV |
799 | struct fc_vport *fc_vport_create(struct Scsi_Host *shost, int channel, |
800 | struct fc_vport_identifiers *); | |
a53eb5e0 | 801 | int fc_vport_terminate(struct fc_vport *vport); |
67b46525 | 802 | int fc_block_rport(struct fc_rport *rport); |
2f2eb587 | 803 | int fc_block_scsi_eh(struct scsi_cmnd *cmnd); |
b6a05c82 | 804 | enum blk_eh_timer_return fc_eh_timed_out(struct scsi_cmnd *scmd); |
1da177e4 | 805 | |
75cc8cfc JT |
806 | static inline struct Scsi_Host *fc_bsg_to_shost(struct bsg_job *job) |
807 | { | |
808 | if (scsi_is_host_device(job->dev)) | |
809 | return dev_to_shost(job->dev); | |
810 | return rport_to_shost(dev_to_rport(job->dev)); | |
811 | } | |
812 | ||
813 | static inline struct fc_rport *fc_bsg_to_rport(struct bsg_job *job) | |
814 | { | |
815 | if (scsi_is_fc_rport(job->dev)) | |
816 | return dev_to_rport(job->dev); | |
817 | return NULL; | |
818 | } | |
819 | ||
1da177e4 | 820 | #endif /* SCSI_TRANSPORT_FC_H */ |