blob: bf66ea6bed2b024467841e840f1f2b597f4fae81 [file] [log] [blame]
James Smart9ef3e4a2007-05-24 19:04:44 -04001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * FiberChannel transport specific attributes exported to sysfs.
3 *
4 * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * ========
21 *
James Smarta53eb5e2007-04-27 12:41:09 -040022 * Copyright (C) 2004-2007 James Smart, Emulex Corporation
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 * Rewrite for host, target, device, and remote port attributes,
24 * statistics, and service functions...
25 *
26 */
27#ifndef SCSI_TRANSPORT_FC_H
28#define SCSI_TRANSPORT_FC_H
29
Tim Schmielau4e57b682005-10-30 15:03:48 -080030#include <linux/sched.h>
Arnd Bergmannef3fb242016-03-16 17:39:17 +010031#include <asm/unaligned.h>
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -040032#include <scsi/scsi.h>
James Smart84314fd2006-08-18 17:30:09 -040033#include <scsi/scsi_netlink.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35struct scsi_transport_template;
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037/*
38 * FC Port definitions - Following FC HBAAPI guidelines
39 *
40 * Note: Not all binary values for the different fields match HBAAPI.
41 * Instead, we use densely packed ordinal values or enums.
42 * We get away with this as we never present the actual binary values
43 * externally. For sysfs, we always present the string that describes
44 * the value. Thus, an admin doesn't need a magic HBAAPI decoder ring
45 * to understand the values. The HBAAPI user-space library is free to
46 * convert the strings into the HBAAPI-specified binary values.
47 *
48 * Note: Not all HBAAPI-defined values are contained in the definitions
49 * below. Those not appropriate to an fc_host (e.g. FCP initiator) have
50 * been removed.
51 */
52
53/*
54 * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c
55 * (for the ascii descriptions).
56 */
57enum fc_port_type {
58 FC_PORTTYPE_UNKNOWN,
59 FC_PORTTYPE_OTHER,
60 FC_PORTTYPE_NOTPRESENT,
61 FC_PORTTYPE_NPORT, /* Attached to FPort */
62 FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */
63 FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */
64 FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */
James Smarta53eb5e2007-04-27 12:41:09 -040065 FC_PORTTYPE_NPIV, /* VPORT based on NPIV */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066};
67
James Smarta53eb5e2007-04-27 12:41:09 -040068
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/*
70 * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c
71 * (for the ascii descriptions).
72 */
73enum fc_port_state {
74 FC_PORTSTATE_UNKNOWN,
75 FC_PORTSTATE_NOTPRESENT,
76 FC_PORTSTATE_ONLINE,
77 FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */
78 FC_PORTSTATE_BLOCKED,
79 FC_PORTSTATE_BYPASSED,
80 FC_PORTSTATE_DIAGNOSTICS,
81 FC_PORTSTATE_LINKDOWN,
82 FC_PORTSTATE_ERROR,
83 FC_PORTSTATE_LOOPBACK,
James.Smart@Emulex.Com42e33142005-12-15 09:56:22 -050084 FC_PORTSTATE_DELETED,
Linus Torvalds1da177e2005-04-16 15:20:36 -070085};
86
87
James Smarta53eb5e2007-04-27 12:41:09 -040088/*
89 * fc_vport_state: If you alter this, you also need to alter
90 * scsi_transport_fc.c (for the ascii descriptions).
91 */
92enum fc_vport_state {
93 FC_VPORT_UNKNOWN,
94 FC_VPORT_ACTIVE,
95 FC_VPORT_DISABLED,
96 FC_VPORT_LINKDOWN,
97 FC_VPORT_INITIALIZING,
98 FC_VPORT_NO_FABRIC_SUPP,
99 FC_VPORT_NO_FABRIC_RSCS,
100 FC_VPORT_FABRIC_LOGOUT,
101 FC_VPORT_FABRIC_REJ_WWN,
102 FC_VPORT_FAILED,
103};
104
105
106
James Smart9ef3e4a2007-05-24 19:04:44 -0400107/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 * FC Classes of Service
109 * Note: values are not enumerated, as they can be "or'd" together
110 * for reporting (e.g. report supported_classes). If you alter this list,
111 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
112 */
113#define FC_COS_UNSPECIFIED 0
114#define FC_COS_CLASS1 2
115#define FC_COS_CLASS2 4
116#define FC_COS_CLASS3 8
117#define FC_COS_CLASS4 0x10
118#define FC_COS_CLASS6 0x40
119
James Smart9ef3e4a2007-05-24 19:04:44 -0400120/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 * FC Port Speeds
122 * Note: values are not enumerated, as they can be "or'd" together
123 * for reporting (e.g. report supported_speeds). If you alter this list,
124 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
125 */
126#define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver
127 incapable of reporting */
128#define FC_PORTSPEED_1GBIT 1
129#define FC_PORTSPEED_2GBIT 2
Neerav Parikha9277e72012-01-22 17:29:55 -0800130#define FC_PORTSPEED_10GBIT 4
131#define FC_PORTSPEED_4GBIT 8
James Smartc3d23502007-03-12 14:16:35 -0500132#define FC_PORTSPEED_8GBIT 0x10
133#define FC_PORTSPEED_16GBIT 0x20
Chad Dupuis624f28b2014-02-26 04:15:05 -0500134#define FC_PORTSPEED_32GBIT 0x40
Dick Kennedyc21a2c12014-06-13 16:40:36 +0000135#define FC_PORTSPEED_20GBIT 0x80
136#define FC_PORTSPEED_40GBIT 0x100
137#define FC_PORTSPEED_50GBIT 0x200
138#define FC_PORTSPEED_100GBIT 0x400
James Smartc749e6b2015-04-02 15:50:52 -0400139#define FC_PORTSPEED_25GBIT 0x800
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140#define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */
141
142/*
143 * fc_tgtid_binding_type: If you alter this, you also need to alter
144 * scsi_transport_fc.c (for the ascii descriptions).
145 */
146enum fc_tgtid_binding_type {
147 FC_TGTID_BIND_NONE,
148 FC_TGTID_BIND_BY_WWPN,
149 FC_TGTID_BIND_BY_WWNN,
150 FC_TGTID_BIND_BY_ID,
151};
152
153/*
James Smarta53eb5e2007-04-27 12:41:09 -0400154 * FC Port Roles
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 * Note: values are not enumerated, as they can be "or'd" together
156 * for reporting (e.g. report roles). If you alter this list,
157 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
158 */
James Smarta53eb5e2007-04-27 12:41:09 -0400159#define FC_PORT_ROLE_UNKNOWN 0x00
160#define FC_PORT_ROLE_FCP_TARGET 0x01
161#define FC_PORT_ROLE_FCP_INITIATOR 0x02
162#define FC_PORT_ROLE_IP_PORT 0x04
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
James Smarta53eb5e2007-04-27 12:41:09 -0400164/* The following are for compatibility */
165#define FC_RPORT_ROLE_UNKNOWN FC_PORT_ROLE_UNKNOWN
166#define FC_RPORT_ROLE_FCP_TARGET FC_PORT_ROLE_FCP_TARGET
167#define FC_RPORT_ROLE_FCP_INITIATOR FC_PORT_ROLE_FCP_INITIATOR
168#define FC_RPORT_ROLE_IP_PORT FC_PORT_ROLE_IP_PORT
169
170
171/* Macro for use in defining Virtual Port attributes */
Tony Jonesee959b02008-02-22 00:13:36 +0100172#define FC_VPORT_ATTR(_name,_mode,_show,_store) \
173struct device_attribute dev_attr_vport_##_name = \
James Smarta53eb5e2007-04-27 12:41:09 -0400174 __ATTR(_name,_mode,_show,_store)
175
Andrew Vasqueza30c3f62008-07-18 08:32:52 -0700176/*
177 * fc_vport_identifiers: This set of data contains all elements
178 * to uniquely identify and instantiate a FC virtual port.
179 *
180 * Notes:
181 * symbolic_name: The driver is to append the symbolic_name string data
182 * to the symbolic_node_name data that it generates by default.
183 * the resulting combination should then be registered with the switch.
184 * It is expected that things like Xen may stuff a VM title into
185 * this field.
186 */
187#define FC_VPORT_SYMBOLIC_NAMELEN 64
188struct fc_vport_identifiers {
189 u64 node_name;
190 u64 port_name;
191 u32 roles;
192 bool disable;
193 enum fc_port_type vport_type; /* only FC_PORTTYPE_NPIV allowed */
194 char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN];
195};
James Smarta53eb5e2007-04-27 12:41:09 -0400196
197/*
198 * FC Virtual Port Attributes
199 *
200 * This structure exists for each FC port is a virtual FC port. Virtual
201 * ports share the physical link with the Physical port. Each virtual
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300202 * ports has a unique presence on the SAN, and may be instantiated via
James Smarta53eb5e2007-04-27 12:41:09 -0400203 * NPIV, Virtual Fabrics, or via additional ALPAs. As the vport is a
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300204 * unique presence, each vport has it's own view of the fabric,
Joe Perches1e4478c2008-02-03 17:47:00 +0200205 * authentication privilege, and priorities.
James Smarta53eb5e2007-04-27 12:41:09 -0400206 *
207 * A virtual port may support 1 or more FC4 roles. Typically it is a
208 * FCP Initiator. It could be a FCP Target, or exist sole for an IP over FC
209 * roles. FC port attributes for the vport will be reported on any
210 * fc_host class object allocated for an FCP Initiator.
211 *
212 * --
213 *
214 * Fixed attributes are not expected to change. The driver is
215 * expected to set these values after receiving the fc_vport structure
216 * via the vport_create() call from the transport.
217 * The transport fully manages all get functions w/o driver interaction.
218 *
219 * Dynamic attributes are expected to change. The driver participates
220 * in all get/set operations via functions provided by the driver.
221 *
222 * Private attributes are transport-managed values. They are fully
223 * managed by the transport w/o driver interaction.
224 */
225
James Smarta53eb5e2007-04-27 12:41:09 -0400226struct fc_vport {
227 /* Fixed Attributes */
228
229 /* Dynamic Attributes */
230
231 /* Private (Transport-managed) Attributes */
232 enum fc_vport_state vport_state;
233 enum fc_vport_state vport_last_state;
234 u64 node_name;
235 u64 port_name;
236 u32 roles;
237 u32 vport_id; /* Admin Identifier for the vport */
238 enum fc_port_type vport_type;
239 char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN];
240
241 /* exported data */
242 void *dd_data; /* Used for driver-specific storage */
243
244 /* internal data */
245 struct Scsi_Host *shost; /* Physical Port Parent */
246 unsigned int channel;
247 u32 number;
248 u8 flags;
249 struct list_head peers;
250 struct device dev;
James Smart9ef3e4a2007-05-24 19:04:44 -0400251 struct work_struct vport_delete_work;
James Smarta53eb5e2007-04-27 12:41:09 -0400252} __attribute__((aligned(sizeof(unsigned long))));
253
254/* bit field values for struct fc_vport "flags" field: */
255#define FC_VPORT_CREATING 0x01
256#define FC_VPORT_DELETING 0x02
257#define FC_VPORT_DELETED 0x04
258#define FC_VPORT_DEL 0x06 /* Any DELETE state */
259
260#define dev_to_vport(d) \
261 container_of(d, struct fc_vport, dev)
Tony Jonesee959b02008-02-22 00:13:36 +0100262#define transport_class_to_vport(dev) \
263 dev_to_vport(dev->parent)
James Smarta53eb5e2007-04-27 12:41:09 -0400264#define vport_to_shost(v) \
265 (v->shost)
266#define vport_to_shost_channel(v) \
267 (v->channel)
268#define vport_to_parent(v) \
269 (v->dev.parent)
270
271
272/* Error return codes for vport_create() callback */
273#define VPCERR_UNSUPPORTED -ENOSYS /* no driver/adapter
274 support */
275#define VPCERR_BAD_WWN -ENOTUNIQ /* driver validation
276 of WWNs failed */
277#define VPCERR_NO_FABRIC_SUPP -EOPNOTSUPP /* Fabric connection
278 is loop or the
279 Fabric Port does
280 not support NPIV */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
282/*
283 * fc_rport_identifiers: This set of data contains all elements
284 * to uniquely identify a remote FC port. The driver uses this data
285 * to report the existence of a remote FC port in the topology. Internally,
286 * the transport uses this data for attributes and to manage consistent
287 * target id bindings.
288 */
289struct fc_rport_identifiers {
290 u64 node_name;
291 u64 port_name;
292 u32 port_id;
293 u32 roles;
294};
295
James Smarta53eb5e2007-04-27 12:41:09 -0400296
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297/* Macro for use in defining Remote Port attributes */
298#define FC_RPORT_ATTR(_name,_mode,_show,_store) \
Tony Jonesee959b02008-02-22 00:13:36 +0100299struct device_attribute dev_attr_rport_##_name = \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 __ATTR(_name,_mode,_show,_store)
301
302
303/*
304 * FC Remote Port Attributes
305 *
306 * This structure exists for each remote FC port that a LLDD notifies
307 * the subsystem of. A remote FC port may or may not be a SCSI Target,
308 * also be a SCSI initiator, IP endpoint, etc. As such, the remote
309 * port is considered a separate entity, independent of "role" (such
310 * as scsi target).
311 *
312 * --
313 *
314 * Attributes are based on HBAAPI V2.0 definitions. Only those
315 * attributes that are determinable by the local port (aka Host)
316 * are contained.
317 *
318 * Fixed attributes are not expected to change. The driver is
319 * expected to set these values after successfully calling
320 * fc_remote_port_add(). The transport fully manages all get functions
321 * w/o driver interaction.
322 *
323 * Dynamic attributes are expected to change. The driver participates
324 * in all get/set operations via functions provided by the driver.
325 *
326 * Private attributes are transport-managed values. They are fully
327 * managed by the transport w/o driver interaction.
328 */
329
330struct fc_rport { /* aka fc_starget_attrs */
331 /* Fixed Attributes */
332 u32 maxframe_size;
333 u32 supported_classes;
334
335 /* Dynamic Attributes */
336 u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */
337
338 /* Private (Transport-managed) Attributes */
339 u64 node_name;
340 u64 port_name;
341 u32 port_id;
342 u32 roles;
343 enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */
344 u32 scsi_target_id;
James Smart0f29b962006-08-18 17:33:29 -0400345 u32 fast_io_fail_tmo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347 /* exported data */
348 void *dd_data; /* Used for driver-specific storage */
349
350 /* internal data */
351 unsigned int channel;
352 u32 number;
James Smartaedf3492006-04-10 10:14:05 -0400353 u8 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 struct list_head peers;
355 struct device dev;
David Howellsc4028952006-11-22 14:57:56 +0000356 struct delayed_work dev_loss_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 struct work_struct scan_work;
David Howellsc4028952006-11-22 14:57:56 +0000358 struct delayed_work fail_io_work;
James Smartaedf3492006-04-10 10:14:05 -0400359 struct work_struct stgt_delete_work;
360 struct work_struct rport_delete_work;
James Smart9e4f5e22009-03-26 13:33:19 -0400361 struct request_queue *rqst_q; /* bsg support */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362} __attribute__((aligned(sizeof(unsigned long))));
363
James Smartaedf3492006-04-10 10:14:05 -0400364/* bit field values for struct fc_rport "flags" field: */
365#define FC_RPORT_DEVLOSS_PENDING 0x01
366#define FC_RPORT_SCAN_PENDING 0x02
James Smart21098c62008-11-20 10:58:01 -0500367#define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04
James Smart4be98c02009-01-05 12:14:18 -0500368#define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08
James Smartaedf3492006-04-10 10:14:05 -0400369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370#define dev_to_rport(d) \
371 container_of(d, struct fc_rport, dev)
Tony Jonesee959b02008-02-22 00:13:36 +0100372#define transport_class_to_rport(dev) \
373 dev_to_rport(dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374#define rport_to_shost(r) \
375 dev_to_shost(r->dev.parent)
376
377/*
378 * FC SCSI Target Attributes
379 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300380 * The SCSI Target is considered an extension of a remote port (as
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 * a remote port can be more than a SCSI Target). Within the scsi
382 * subsystem, we leave the Target as a separate entity. Doing so
383 * provides backward compatibility with prior FC transport api's,
384 * and lets remote ports be handled entirely within the FC transport
385 * and independently from the scsi subsystem. The drawback is that
386 * some data will be duplicated.
387 */
388
389struct fc_starget_attrs { /* aka fc_target_attrs */
390 /* Dynamic Attributes */
391 u64 node_name;
392 u64 port_name;
393 u32 port_id;
394};
395
396#define fc_starget_node_name(x) \
397 (((struct fc_starget_attrs *)&(x)->starget_data)->node_name)
398#define fc_starget_port_name(x) \
399 (((struct fc_starget_attrs *)&(x)->starget_data)->port_name)
400#define fc_starget_port_id(x) \
401 (((struct fc_starget_attrs *)&(x)->starget_data)->port_id)
402
403#define starget_to_rport(s) \
404 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL
405
406
407/*
408 * FC Local Port (Host) Statistics
409 */
410
411/* FC Statistics - Following FC HBAAPI v2.0 guidelines */
412struct fc_host_statistics {
413 /* port statistics */
414 u64 seconds_since_last_reset;
415 u64 tx_frames;
416 u64 tx_words;
417 u64 rx_frames;
418 u64 rx_words;
419 u64 lip_count;
420 u64 nos_count;
421 u64 error_frames;
422 u64 dumped_frames;
423 u64 link_failure_count;
424 u64 loss_of_sync_count;
425 u64 loss_of_signal_count;
426 u64 prim_seq_protocol_err_count;
427 u64 invalid_tx_word_count;
428 u64 invalid_crc_count;
James Smart9ef3e4a2007-05-24 19:04:44 -0400429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 /* fc4 statistics (only FCP supported currently) */
431 u64 fcp_input_requests;
432 u64 fcp_output_requests;
433 u64 fcp_control_requests;
434 u64 fcp_input_megabytes;
435 u64 fcp_output_megabytes;
Vasu Deve58abb02012-05-25 10:26:38 -0700436 u64 fcp_packet_alloc_failures; /* fcp packet allocation failures */
437 u64 fcp_packet_aborts; /* fcp packet aborted */
438 u64 fcp_frame_alloc_failures; /* fcp frame allocation failures */
439
440 /* fc exches statistics */
441 u64 fc_no_free_exch; /* no free exch memory */
442 u64 fc_no_free_exch_xid; /* no free exch id */
443 u64 fc_xid_not_found; /* exch not found for a response */
444 u64 fc_xid_busy; /* exch exist for new a request */
445 u64 fc_seq_not_found; /* seq is not found for exchange */
446 u64 fc_non_bls_resp; /* a non BLS response frame with
447 a sequence responder in new exch */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448};
449
450
451/*
James Smart84314fd2006-08-18 17:30:09 -0400452 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
453 */
454
455/*
456 * fc_host_event_code: If you alter this, you also need to alter
457 * scsi_transport_fc.c (for the ascii descriptions).
458 */
459enum fc_host_event_code {
460 FCH_EVT_LIP = 0x1,
461 FCH_EVT_LINKUP = 0x2,
462 FCH_EVT_LINKDOWN = 0x3,
463 FCH_EVT_LIPRESET = 0x4,
464 FCH_EVT_RSCN = 0x5,
465 FCH_EVT_ADAPTER_CHANGE = 0x103,
466 FCH_EVT_PORT_UNKNOWN = 0x200,
467 FCH_EVT_PORT_OFFLINE = 0x201,
468 FCH_EVT_PORT_ONLINE = 0x202,
469 FCH_EVT_PORT_FABRIC = 0x204,
470 FCH_EVT_LINK_UNKNOWN = 0x500,
471 FCH_EVT_VENDOR_UNIQUE = 0xffff,
472};
473
474
475/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 * FC Local Port (Host) Attributes
477 *
478 * Attributes are based on HBAAPI V2.0 definitions.
479 * Note: OSDeviceName is determined by user-space library
480 *
481 * Fixed attributes are not expected to change. The driver is
482 * expected to set these values after successfully calling scsi_add_host().
483 * The transport fully manages all get functions w/o driver interaction.
484 *
485 * Dynamic attributes are expected to change. The driver participates
486 * in all get/set operations via functions provided by the driver.
487 *
488 * Private attributes are transport-managed values. They are fully
489 * managed by the transport w/o driver interaction.
490 */
491
492#define FC_FC4_LIST_SIZE 32
493#define FC_SYMBOLIC_NAME_SIZE 256
494#define FC_VERSION_STRING_SIZE 64
495#define FC_SERIAL_NUMBER_SIZE 80
496
497struct fc_host_attrs {
498 /* Fixed Attributes */
499 u64 node_name;
500 u64 port_name;
Andreas Herrmann6b7281d2006-01-13 02:16:54 +0100501 u64 permanent_port_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 u32 supported_classes;
503 u8 supported_fc4s[FC_FC4_LIST_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 u32 supported_speeds;
505 u32 maxframe_size;
James Smarta53eb5e2007-04-27 12:41:09 -0400506 u16 max_npiv_vports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 char serial_number[FC_SERIAL_NUMBER_SIZE];
Neerav Parikhbb8ef582012-01-22 17:29:50 -0800508 char manufacturer[FC_SERIAL_NUMBER_SIZE];
509 char model[FC_SYMBOLIC_NAME_SIZE];
510 char model_description[FC_SYMBOLIC_NAME_SIZE];
511 char hardware_version[FC_VERSION_STRING_SIZE];
512 char driver_version[FC_VERSION_STRING_SIZE];
513 char firmware_version[FC_VERSION_STRING_SIZE];
514 char optionrom_version[FC_VERSION_STRING_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516 /* Dynamic Attributes */
517 u32 port_id;
518 enum fc_port_type port_type;
519 enum fc_port_state port_state;
520 u8 active_fc4s[FC_FC4_LIST_SIZE];
521 u32 speed;
522 u64 fabric_name;
James Smartb8d08212006-08-17 08:00:43 -0400523 char symbolic_name[FC_SYMBOLIC_NAME_SIZE];
524 char system_hostname[FC_SYMBOLIC_NAME_SIZE];
Mike Christie43ca9102010-09-15 16:52:32 -0500525 u32 dev_loss_tmo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
527 /* Private (Transport-managed) Attributes */
528 enum fc_tgtid_binding_type tgtid_bind_type;
529
530 /* internal data */
531 struct list_head rports;
532 struct list_head rport_bindings;
James Smarta53eb5e2007-04-27 12:41:09 -0400533 struct list_head vports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 u32 next_rport_number;
535 u32 next_target_id;
James Smarta53eb5e2007-04-27 12:41:09 -0400536 u32 next_vport_number;
537 u16 npiv_vports_inuse;
James Smartaedf3492006-04-10 10:14:05 -0400538
539 /* work queues for rport state manipulation */
Kay Sieversaab0de22008-05-02 06:02:41 +0200540 char work_q_name[20];
James Smartaedf3492006-04-10 10:14:05 -0400541 struct workqueue_struct *work_q;
Kay Sieversaab0de22008-05-02 06:02:41 +0200542 char devloss_work_q_name[20];
James Smartaedf3492006-04-10 10:14:05 -0400543 struct workqueue_struct *devloss_work_q;
James Smart9e4f5e22009-03-26 13:33:19 -0400544
545 /* bsg support */
546 struct request_queue *rqst_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547};
548
James Smartaedf3492006-04-10 10:14:05 -0400549#define shost_to_fc_host(x) \
550 ((struct fc_host_attrs *)(x)->shost_data)
James.Smart@Emulex.Com42e33142005-12-15 09:56:22 -0500551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552#define fc_host_node_name(x) \
553 (((struct fc_host_attrs *)(x)->shost_data)->node_name)
554#define fc_host_port_name(x) \
555 (((struct fc_host_attrs *)(x)->shost_data)->port_name)
Andreas Herrmann6b7281d2006-01-13 02:16:54 +0100556#define fc_host_permanent_port_name(x) \
557 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558#define fc_host_supported_classes(x) \
559 (((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
560#define fc_host_supported_fc4s(x) \
561 (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562#define fc_host_supported_speeds(x) \
563 (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
564#define fc_host_maxframe_size(x) \
565 (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
James Smarta53eb5e2007-04-27 12:41:09 -0400566#define fc_host_max_npiv_vports(x) \
567 (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568#define fc_host_serial_number(x) \
569 (((struct fc_host_attrs *)(x)->shost_data)->serial_number)
Neerav Parikhbb8ef582012-01-22 17:29:50 -0800570#define fc_host_manufacturer(x) \
571 (((struct fc_host_attrs *)(x)->shost_data)->manufacturer)
572#define fc_host_model(x) \
573 (((struct fc_host_attrs *)(x)->shost_data)->model)
574#define fc_host_model_description(x) \
575 (((struct fc_host_attrs *)(x)->shost_data)->model_description)
576#define fc_host_hardware_version(x) \
577 (((struct fc_host_attrs *)(x)->shost_data)->hardware_version)
578#define fc_host_driver_version(x) \
579 (((struct fc_host_attrs *)(x)->shost_data)->driver_version)
580#define fc_host_firmware_version(x) \
581 (((struct fc_host_attrs *)(x)->shost_data)->firmware_version)
582#define fc_host_optionrom_version(x) \
583 (((struct fc_host_attrs *)(x)->shost_data)->optionrom_version)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584#define fc_host_port_id(x) \
585 (((struct fc_host_attrs *)(x)->shost_data)->port_id)
586#define fc_host_port_type(x) \
587 (((struct fc_host_attrs *)(x)->shost_data)->port_type)
588#define fc_host_port_state(x) \
589 (((struct fc_host_attrs *)(x)->shost_data)->port_state)
590#define fc_host_active_fc4s(x) \
591 (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
592#define fc_host_speed(x) \
593 (((struct fc_host_attrs *)(x)->shost_data)->speed)
594#define fc_host_fabric_name(x) \
595 (((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
James Smartb8d08212006-08-17 08:00:43 -0400596#define fc_host_symbolic_name(x) \
597 (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
598#define fc_host_system_hostname(x) \
599 (((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600#define fc_host_tgtid_bind_type(x) \
601 (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
602#define fc_host_rports(x) \
603 (((struct fc_host_attrs *)(x)->shost_data)->rports)
604#define fc_host_rport_bindings(x) \
605 (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
James Smarta53eb5e2007-04-27 12:41:09 -0400606#define fc_host_vports(x) \
607 (((struct fc_host_attrs *)(x)->shost_data)->vports)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608#define fc_host_next_rport_number(x) \
609 (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
610#define fc_host_next_target_id(x) \
611 (((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
James Smarta53eb5e2007-04-27 12:41:09 -0400612#define fc_host_next_vport_number(x) \
613 (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number)
614#define fc_host_npiv_vports_inuse(x) \
615 (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse)
James Smartaedf3492006-04-10 10:14:05 -0400616#define fc_host_work_q_name(x) \
617 (((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
618#define fc_host_work_q(x) \
619 (((struct fc_host_attrs *)(x)->shost_data)->work_q)
620#define fc_host_devloss_work_q_name(x) \
621 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
622#define fc_host_devloss_work_q(x) \
623 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)
Mike Christie43ca9102010-09-15 16:52:32 -0500624#define fc_host_dev_loss_tmo(x) \
625 (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627
James Smart9e4f5e22009-03-26 13:33:19 -0400628struct fc_bsg_buffer {
629 unsigned int payload_len;
630 int sg_cnt;
631 struct scatterlist *sg_list;
632};
633
634/* Values for fc_bsg_job->state_flags (bitflags) */
635#define FC_RQST_STATE_INPROGRESS 0
636#define FC_RQST_STATE_DONE 1
637
638struct fc_bsg_job {
639 struct Scsi_Host *shost;
640 struct fc_rport *rport;
641 struct device *dev;
642 struct request *req;
643 spinlock_t job_lock;
644 unsigned int state_flags;
645 unsigned int ref_cnt;
646 void (*job_done)(struct fc_bsg_job *);
647
648 struct fc_bsg_request *request;
649 struct fc_bsg_reply *reply;
650 unsigned int request_len;
651 unsigned int reply_len;
652 /*
653 * On entry : reply_len indicates the buffer size allocated for
654 * the reply.
655 *
656 * Upon completion : the message handler must set reply_len
657 * to indicates the size of the reply to be returned to the
658 * caller.
659 */
660
661 /* DMA payloads for the request/response */
662 struct fc_bsg_buffer request_payload;
663 struct fc_bsg_buffer reply_payload;
664
665 void *dd_data; /* Used for driver-specific storage */
666};
667
668
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669/* The functions by which the transport class and the driver communicate */
670struct fc_function_template {
671 void (*get_rport_dev_loss_tmo)(struct fc_rport *);
672 void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32);
673
674 void (*get_starget_node_name)(struct scsi_target *);
675 void (*get_starget_port_name)(struct scsi_target *);
676 void (*get_starget_port_id)(struct scsi_target *);
677
678 void (*get_host_port_id)(struct Scsi_Host *);
679 void (*get_host_port_type)(struct Scsi_Host *);
680 void (*get_host_port_state)(struct Scsi_Host *);
681 void (*get_host_active_fc4s)(struct Scsi_Host *);
682 void (*get_host_speed)(struct Scsi_Host *);
683 void (*get_host_fabric_name)(struct Scsi_Host *);
James Smart016131b2006-08-14 08:20:25 -0400684 void (*get_host_symbolic_name)(struct Scsi_Host *);
James Smartb8d08212006-08-17 08:00:43 -0400685 void (*set_host_system_hostname)(struct Scsi_Host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
687 struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *);
688 void (*reset_fc_host_stats)(struct Scsi_Host *);
689
Andrew Vasquez91ca7b02005-10-27 16:03:37 -0700690 int (*issue_fc_host_lip)(struct Scsi_Host *);
691
James Smart0f29b962006-08-18 17:33:29 -0400692 void (*dev_loss_tmo_callbk)(struct fc_rport *);
693 void (*terminate_rport_io)(struct fc_rport *);
694
James Smarta53eb5e2007-04-27 12:41:09 -0400695 void (*set_vport_symbolic_name)(struct fc_vport *);
696 int (*vport_create)(struct fc_vport *, bool);
697 int (*vport_disable)(struct fc_vport *, bool);
698 int (*vport_delete)(struct fc_vport *);
699
FUJITA Tomonori75252362007-09-01 02:02:27 +0900700 /* target-mode drivers' functions */
701 int (* tsk_mgmt_response)(struct Scsi_Host *, u64, u64, int);
702 int (* it_nexus_response)(struct Scsi_Host *, u64, int);
703
James Smart9e4f5e22009-03-26 13:33:19 -0400704 /* bsg support */
705 int (*bsg_request)(struct fc_bsg_job *);
706 int (*bsg_timeout)(struct fc_bsg_job *);
707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 /* allocation lengths for host-specific data */
709 u32 dd_fcrport_size;
James Smarta53eb5e2007-04-27 12:41:09 -0400710 u32 dd_fcvport_size;
James Smart9e4f5e22009-03-26 13:33:19 -0400711 u32 dd_bsg_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
James Smart9ef3e4a2007-05-24 19:04:44 -0400713 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 * The driver sets these to tell the transport class it
715 * wants the attributes displayed in sysfs. If the show_ flag
716 * is not set, the attribute will be private to the transport
James Smart9ef3e4a2007-05-24 19:04:44 -0400717 * class
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 */
719
720 /* remote port fixed attributes */
721 unsigned long show_rport_maxframe_size:1;
722 unsigned long show_rport_supported_classes:1;
723 unsigned long show_rport_dev_loss_tmo:1;
724
725 /*
726 * target dynamic attributes
727 * These should all be "1" if the driver uses the remote port
728 * add/delete functions (so attributes reflect rport values).
729 */
730 unsigned long show_starget_node_name:1;
731 unsigned long show_starget_port_name:1;
732 unsigned long show_starget_port_id:1;
733
734 /* host fixed attributes */
735 unsigned long show_host_node_name:1;
736 unsigned long show_host_port_name:1;
Andreas Herrmann6b7281d2006-01-13 02:16:54 +0100737 unsigned long show_host_permanent_port_name:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 unsigned long show_host_supported_classes:1;
739 unsigned long show_host_supported_fc4s:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 unsigned long show_host_supported_speeds:1;
741 unsigned long show_host_maxframe_size:1;
742 unsigned long show_host_serial_number:1;
Neerav Parikhbb8ef582012-01-22 17:29:50 -0800743 unsigned long show_host_manufacturer:1;
744 unsigned long show_host_model:1;
745 unsigned long show_host_model_description:1;
746 unsigned long show_host_hardware_version:1;
747 unsigned long show_host_driver_version:1;
748 unsigned long show_host_firmware_version:1;
749 unsigned long show_host_optionrom_version:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 /* host dynamic attributes */
751 unsigned long show_host_port_id:1;
752 unsigned long show_host_port_type:1;
753 unsigned long show_host_port_state:1;
754 unsigned long show_host_active_fc4s:1;
755 unsigned long show_host_speed:1;
756 unsigned long show_host_fabric_name:1;
James Smart016131b2006-08-14 08:20:25 -0400757 unsigned long show_host_symbolic_name:1;
James Smartb8d08212006-08-17 08:00:43 -0400758 unsigned long show_host_system_hostname:1;
Christof Schmitt03f002f2007-08-28 09:31:21 +0200759
760 unsigned long disable_target_scan:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761};
762
763
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400764/**
765 * fc_remote_port_chkready - called to validate the remote port state
766 * prior to initiating io to the port.
767 *
768 * Returns a scsi result code that can be returned by the LLDD.
769 *
770 * @rport: remote port to be checked
771 **/
772static inline int
773fc_remote_port_chkready(struct fc_rport *rport)
774{
775 int result;
776
777 switch (rport->port_state) {
778 case FC_PORTSTATE_ONLINE:
James Smarta53eb5e2007-04-27 12:41:09 -0400779 if (rport->roles & FC_PORT_ROLE_FCP_TARGET)
James Smartaedf3492006-04-10 10:14:05 -0400780 result = 0;
781 else if (rport->flags & FC_RPORT_DEVLOSS_PENDING)
Andrew Vasquez9a1a69a12009-04-29 13:12:39 -0500782 result = DID_IMM_RETRY << 16;
James Smartaedf3492006-04-10 10:14:05 -0400783 else
784 result = DID_NO_CONNECT << 16;
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400785 break;
786 case FC_PORTSTATE_BLOCKED:
Mike Christiefff9d402008-08-19 18:45:23 -0500787 if (rport->flags & FC_RPORT_FAST_FAIL_TIMEDOUT)
Mike Christief46e3072008-08-19 18:45:27 -0500788 result = DID_TRANSPORT_FAILFAST << 16;
Mike Christiefff9d402008-08-19 18:45:23 -0500789 else
Andrew Vasquez9a1a69a12009-04-29 13:12:39 -0500790 result = DID_IMM_RETRY << 16;
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400791 break;
792 default:
793 result = DID_NO_CONNECT << 16;
794 break;
795 }
796 return result;
797}
798
James Smartb8d08212006-08-17 08:00:43 -0400799static inline u64 wwn_to_u64(u8 *wwn)
800{
Arnd Bergmannef3fb242016-03-16 17:39:17 +0100801 return get_unaligned_be64(wwn);
James Smartb8d08212006-08-17 08:00:43 -0400802}
803
804static inline void u64_to_wwn(u64 inm, u8 *wwn)
805{
Arnd Bergmannef3fb242016-03-16 17:39:17 +0100806 put_unaligned_be64(inm, wwn);
James Smartb8d08212006-08-17 08:00:43 -0400807}
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400808
James Smarta53eb5e2007-04-27 12:41:09 -0400809/**
810 * fc_vport_set_state() - called to set a vport's state. Saves the old state,
811 * excepting the transitory states of initializing and sending the ELS
812 * traffic to instantiate the vport on the link.
813 *
814 * Assumes the driver has surrounded this with the proper locking to ensure
815 * a coherent state change.
816 *
817 * @vport: virtual port whose state is changing
818 * @new_state: new state
819 **/
820static inline void
821fc_vport_set_state(struct fc_vport *vport, enum fc_vport_state new_state)
822{
823 if ((new_state != FC_VPORT_UNKNOWN) &&
824 (new_state != FC_VPORT_INITIALIZING))
825 vport->vport_last_state = vport->vport_state;
826 vport->vport_state = new_state;
827}
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829struct scsi_transport_template *fc_attach_transport(
830 struct fc_function_template *);
831void fc_release_transport(struct scsi_transport_template *);
832void fc_remove_host(struct Scsi_Host *);
833struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost,
834 int channel, struct fc_rport_identifiers *ids);
835void fc_remote_port_delete(struct fc_rport *rport);
836void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837int scsi_is_fc_rport(const struct device *);
James Smart84314fd2006-08-18 17:30:09 -0400838u32 fc_get_event_number(void);
839void fc_host_post_event(struct Scsi_Host *shost, u32 event_number,
840 enum fc_host_event_code event_code, u32 event_data);
841void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number,
James Smartf14e2e22006-08-22 09:55:23 -0400842 u32 data_len, char * data_buf, u64 vendor_id);
James Smart84314fd2006-08-18 17:30:09 -0400843 /* Note: when specifying vendor_id to fc_host_post_vendor_event()
844 * be sure to read the Vendor Type and ID formatting requirements
845 * specified in scsi_netlink.h
846 */
Andrew Vasqueza30c3f62008-07-18 08:32:52 -0700847struct fc_vport *fc_vport_create(struct Scsi_Host *shost, int channel,
848 struct fc_vport_identifiers *);
James Smarta53eb5e2007-04-27 12:41:09 -0400849int fc_vport_terminate(struct fc_vport *vport);
Christof Schmitt2f2eb582010-03-24 16:50:30 +0100850int fc_block_scsi_eh(struct scsi_cmnd *cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852#endif /* SCSI_TRANSPORT_FC_H */