blob: 007a0bc01b74a0a8779d759db6c091fa05f42404 [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>
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -040031#include <scsi/scsi.h>
James Smart84314fd2006-08-18 17:30:09 -040032#include <scsi/scsi_netlink.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34struct scsi_transport_template;
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036/*
37 * FC Port definitions - Following FC HBAAPI guidelines
38 *
39 * Note: Not all binary values for the different fields match HBAAPI.
40 * Instead, we use densely packed ordinal values or enums.
41 * We get away with this as we never present the actual binary values
42 * externally. For sysfs, we always present the string that describes
43 * the value. Thus, an admin doesn't need a magic HBAAPI decoder ring
44 * to understand the values. The HBAAPI user-space library is free to
45 * convert the strings into the HBAAPI-specified binary values.
46 *
47 * Note: Not all HBAAPI-defined values are contained in the definitions
48 * below. Those not appropriate to an fc_host (e.g. FCP initiator) have
49 * been removed.
50 */
51
52/*
53 * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c
54 * (for the ascii descriptions).
55 */
56enum fc_port_type {
57 FC_PORTTYPE_UNKNOWN,
58 FC_PORTTYPE_OTHER,
59 FC_PORTTYPE_NOTPRESENT,
60 FC_PORTTYPE_NPORT, /* Attached to FPort */
61 FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */
62 FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */
63 FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */
James Smarta53eb5e2007-04-27 12:41:09 -040064 FC_PORTTYPE_NPIV, /* VPORT based on NPIV */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065};
66
James Smarta53eb5e2007-04-27 12:41:09 -040067
Linus Torvalds1da177e2005-04-16 15:20:36 -070068/*
69 * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c
70 * (for the ascii descriptions).
71 */
72enum fc_port_state {
73 FC_PORTSTATE_UNKNOWN,
74 FC_PORTSTATE_NOTPRESENT,
75 FC_PORTSTATE_ONLINE,
76 FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */
77 FC_PORTSTATE_BLOCKED,
78 FC_PORTSTATE_BYPASSED,
79 FC_PORTSTATE_DIAGNOSTICS,
80 FC_PORTSTATE_LINKDOWN,
81 FC_PORTSTATE_ERROR,
82 FC_PORTSTATE_LOOPBACK,
James.Smart@Emulex.Com42e33142005-12-15 09:56:22 -050083 FC_PORTSTATE_DELETED,
Linus Torvalds1da177e2005-04-16 15:20:36 -070084};
85
86
James Smarta53eb5e2007-04-27 12:41:09 -040087/*
88 * fc_vport_state: If you alter this, you also need to alter
89 * scsi_transport_fc.c (for the ascii descriptions).
90 */
91enum fc_vport_state {
92 FC_VPORT_UNKNOWN,
93 FC_VPORT_ACTIVE,
94 FC_VPORT_DISABLED,
95 FC_VPORT_LINKDOWN,
96 FC_VPORT_INITIALIZING,
97 FC_VPORT_NO_FABRIC_SUPP,
98 FC_VPORT_NO_FABRIC_RSCS,
99 FC_VPORT_FABRIC_LOGOUT,
100 FC_VPORT_FABRIC_REJ_WWN,
101 FC_VPORT_FAILED,
102};
103
104
105
James Smart9ef3e4a2007-05-24 19:04:44 -0400106/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 * FC Classes of Service
108 * Note: values are not enumerated, as they can be "or'd" together
109 * for reporting (e.g. report supported_classes). If you alter this list,
110 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
111 */
112#define FC_COS_UNSPECIFIED 0
113#define FC_COS_CLASS1 2
114#define FC_COS_CLASS2 4
115#define FC_COS_CLASS3 8
116#define FC_COS_CLASS4 0x10
117#define FC_COS_CLASS6 0x40
118
James Smart9ef3e4a2007-05-24 19:04:44 -0400119/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 * FC Port Speeds
121 * Note: values are not enumerated, as they can be "or'd" together
122 * for reporting (e.g. report supported_speeds). If you alter this list,
123 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
124 */
125#define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver
126 incapable of reporting */
127#define FC_PORTSPEED_1GBIT 1
128#define FC_PORTSPEED_2GBIT 2
Neerav Parikha9277e72012-01-22 17:29:55 -0800129#define FC_PORTSPEED_10GBIT 4
130#define FC_PORTSPEED_4GBIT 8
James Smartc3d23502007-03-12 14:16:35 -0500131#define FC_PORTSPEED_8GBIT 0x10
132#define FC_PORTSPEED_16GBIT 0x20
Chad Dupuis624f28b2014-02-26 04:15:05 -0500133#define FC_PORTSPEED_32GBIT 0x40
Dick Kennedyc21a2c12014-06-13 16:40:36 +0000134#define FC_PORTSPEED_20GBIT 0x80
135#define FC_PORTSPEED_40GBIT 0x100
136#define FC_PORTSPEED_50GBIT 0x200
137#define FC_PORTSPEED_100GBIT 0x400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138#define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */
139
140/*
141 * fc_tgtid_binding_type: If you alter this, you also need to alter
142 * scsi_transport_fc.c (for the ascii descriptions).
143 */
144enum fc_tgtid_binding_type {
145 FC_TGTID_BIND_NONE,
146 FC_TGTID_BIND_BY_WWPN,
147 FC_TGTID_BIND_BY_WWNN,
148 FC_TGTID_BIND_BY_ID,
149};
150
151/*
James Smarta53eb5e2007-04-27 12:41:09 -0400152 * FC Port Roles
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 * Note: values are not enumerated, as they can be "or'd" together
154 * for reporting (e.g. report roles). If you alter this list,
155 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
156 */
James Smarta53eb5e2007-04-27 12:41:09 -0400157#define FC_PORT_ROLE_UNKNOWN 0x00
158#define FC_PORT_ROLE_FCP_TARGET 0x01
159#define FC_PORT_ROLE_FCP_INITIATOR 0x02
160#define FC_PORT_ROLE_IP_PORT 0x04
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
James Smarta53eb5e2007-04-27 12:41:09 -0400162/* The following are for compatibility */
163#define FC_RPORT_ROLE_UNKNOWN FC_PORT_ROLE_UNKNOWN
164#define FC_RPORT_ROLE_FCP_TARGET FC_PORT_ROLE_FCP_TARGET
165#define FC_RPORT_ROLE_FCP_INITIATOR FC_PORT_ROLE_FCP_INITIATOR
166#define FC_RPORT_ROLE_IP_PORT FC_PORT_ROLE_IP_PORT
167
168
169/* Macro for use in defining Virtual Port attributes */
Tony Jonesee959b02008-02-22 00:13:36 +0100170#define FC_VPORT_ATTR(_name,_mode,_show,_store) \
171struct device_attribute dev_attr_vport_##_name = \
James Smarta53eb5e2007-04-27 12:41:09 -0400172 __ATTR(_name,_mode,_show,_store)
173
Andrew Vasqueza30c3f62008-07-18 08:32:52 -0700174/*
175 * fc_vport_identifiers: This set of data contains all elements
176 * to uniquely identify and instantiate a FC virtual port.
177 *
178 * Notes:
179 * symbolic_name: The driver is to append the symbolic_name string data
180 * to the symbolic_node_name data that it generates by default.
181 * the resulting combination should then be registered with the switch.
182 * It is expected that things like Xen may stuff a VM title into
183 * this field.
184 */
185#define FC_VPORT_SYMBOLIC_NAMELEN 64
186struct fc_vport_identifiers {
187 u64 node_name;
188 u64 port_name;
189 u32 roles;
190 bool disable;
191 enum fc_port_type vport_type; /* only FC_PORTTYPE_NPIV allowed */
192 char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN];
193};
James Smarta53eb5e2007-04-27 12:41:09 -0400194
195/*
196 * FC Virtual Port Attributes
197 *
198 * This structure exists for each FC port is a virtual FC port. Virtual
199 * ports share the physical link with the Physical port. Each virtual
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300200 * ports has a unique presence on the SAN, and may be instantiated via
James Smarta53eb5e2007-04-27 12:41:09 -0400201 * NPIV, Virtual Fabrics, or via additional ALPAs. As the vport is a
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300202 * unique presence, each vport has it's own view of the fabric,
Joe Perches1e4478c2008-02-03 17:47:00 +0200203 * authentication privilege, and priorities.
James Smarta53eb5e2007-04-27 12:41:09 -0400204 *
205 * A virtual port may support 1 or more FC4 roles. Typically it is a
206 * FCP Initiator. It could be a FCP Target, or exist sole for an IP over FC
207 * roles. FC port attributes for the vport will be reported on any
208 * fc_host class object allocated for an FCP Initiator.
209 *
210 * --
211 *
212 * Fixed attributes are not expected to change. The driver is
213 * expected to set these values after receiving the fc_vport structure
214 * via the vport_create() call from the transport.
215 * The transport fully manages all get functions w/o driver interaction.
216 *
217 * Dynamic attributes are expected to change. The driver participates
218 * in all get/set operations via functions provided by the driver.
219 *
220 * Private attributes are transport-managed values. They are fully
221 * managed by the transport w/o driver interaction.
222 */
223
James Smarta53eb5e2007-04-27 12:41:09 -0400224struct fc_vport {
225 /* Fixed Attributes */
226
227 /* Dynamic Attributes */
228
229 /* Private (Transport-managed) Attributes */
230 enum fc_vport_state vport_state;
231 enum fc_vport_state vport_last_state;
232 u64 node_name;
233 u64 port_name;
234 u32 roles;
235 u32 vport_id; /* Admin Identifier for the vport */
236 enum fc_port_type vport_type;
237 char symbolic_name[FC_VPORT_SYMBOLIC_NAMELEN];
238
239 /* exported data */
240 void *dd_data; /* Used for driver-specific storage */
241
242 /* internal data */
243 struct Scsi_Host *shost; /* Physical Port Parent */
244 unsigned int channel;
245 u32 number;
246 u8 flags;
247 struct list_head peers;
248 struct device dev;
James Smart9ef3e4a2007-05-24 19:04:44 -0400249 struct work_struct vport_delete_work;
James Smarta53eb5e2007-04-27 12:41:09 -0400250} __attribute__((aligned(sizeof(unsigned long))));
251
252/* bit field values for struct fc_vport "flags" field: */
253#define FC_VPORT_CREATING 0x01
254#define FC_VPORT_DELETING 0x02
255#define FC_VPORT_DELETED 0x04
256#define FC_VPORT_DEL 0x06 /* Any DELETE state */
257
258#define dev_to_vport(d) \
259 container_of(d, struct fc_vport, dev)
Tony Jonesee959b02008-02-22 00:13:36 +0100260#define transport_class_to_vport(dev) \
261 dev_to_vport(dev->parent)
James Smarta53eb5e2007-04-27 12:41:09 -0400262#define vport_to_shost(v) \
263 (v->shost)
264#define vport_to_shost_channel(v) \
265 (v->channel)
266#define vport_to_parent(v) \
267 (v->dev.parent)
268
269
270/* Error return codes for vport_create() callback */
271#define VPCERR_UNSUPPORTED -ENOSYS /* no driver/adapter
272 support */
273#define VPCERR_BAD_WWN -ENOTUNIQ /* driver validation
274 of WWNs failed */
275#define VPCERR_NO_FABRIC_SUPP -EOPNOTSUPP /* Fabric connection
276 is loop or the
277 Fabric Port does
278 not support NPIV */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280/*
281 * fc_rport_identifiers: This set of data contains all elements
282 * to uniquely identify a remote FC port. The driver uses this data
283 * to report the existence of a remote FC port in the topology. Internally,
284 * the transport uses this data for attributes and to manage consistent
285 * target id bindings.
286 */
287struct fc_rport_identifiers {
288 u64 node_name;
289 u64 port_name;
290 u32 port_id;
291 u32 roles;
292};
293
James Smarta53eb5e2007-04-27 12:41:09 -0400294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295/* Macro for use in defining Remote Port attributes */
296#define FC_RPORT_ATTR(_name,_mode,_show,_store) \
Tony Jonesee959b02008-02-22 00:13:36 +0100297struct device_attribute dev_attr_rport_##_name = \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 __ATTR(_name,_mode,_show,_store)
299
300
301/*
302 * FC Remote Port Attributes
303 *
304 * This structure exists for each remote FC port that a LLDD notifies
305 * the subsystem of. A remote FC port may or may not be a SCSI Target,
306 * also be a SCSI initiator, IP endpoint, etc. As such, the remote
307 * port is considered a separate entity, independent of "role" (such
308 * as scsi target).
309 *
310 * --
311 *
312 * Attributes are based on HBAAPI V2.0 definitions. Only those
313 * attributes that are determinable by the local port (aka Host)
314 * are contained.
315 *
316 * Fixed attributes are not expected to change. The driver is
317 * expected to set these values after successfully calling
318 * fc_remote_port_add(). The transport fully manages all get functions
319 * w/o driver interaction.
320 *
321 * Dynamic attributes are expected to change. The driver participates
322 * in all get/set operations via functions provided by the driver.
323 *
324 * Private attributes are transport-managed values. They are fully
325 * managed by the transport w/o driver interaction.
326 */
327
328struct fc_rport { /* aka fc_starget_attrs */
329 /* Fixed Attributes */
330 u32 maxframe_size;
331 u32 supported_classes;
332
333 /* Dynamic Attributes */
334 u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */
335
336 /* Private (Transport-managed) Attributes */
337 u64 node_name;
338 u64 port_name;
339 u32 port_id;
340 u32 roles;
341 enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */
342 u32 scsi_target_id;
James Smart0f29b962006-08-18 17:33:29 -0400343 u32 fast_io_fail_tmo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345 /* exported data */
346 void *dd_data; /* Used for driver-specific storage */
347
348 /* internal data */
349 unsigned int channel;
350 u32 number;
James Smartaedf3492006-04-10 10:14:05 -0400351 u8 flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 struct list_head peers;
353 struct device dev;
David Howellsc4028952006-11-22 14:57:56 +0000354 struct delayed_work dev_loss_work;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 struct work_struct scan_work;
David Howellsc4028952006-11-22 14:57:56 +0000356 struct delayed_work fail_io_work;
James Smartaedf3492006-04-10 10:14:05 -0400357 struct work_struct stgt_delete_work;
358 struct work_struct rport_delete_work;
James Smart9e4f5e22009-03-26 13:33:19 -0400359 struct request_queue *rqst_q; /* bsg support */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360} __attribute__((aligned(sizeof(unsigned long))));
361
James Smartaedf3492006-04-10 10:14:05 -0400362/* bit field values for struct fc_rport "flags" field: */
363#define FC_RPORT_DEVLOSS_PENDING 0x01
364#define FC_RPORT_SCAN_PENDING 0x02
James Smart21098c62008-11-20 10:58:01 -0500365#define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04
James Smart4be98c02009-01-05 12:14:18 -0500366#define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08
James Smartaedf3492006-04-10 10:14:05 -0400367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368#define dev_to_rport(d) \
369 container_of(d, struct fc_rport, dev)
Tony Jonesee959b02008-02-22 00:13:36 +0100370#define transport_class_to_rport(dev) \
371 dev_to_rport(dev->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372#define rport_to_shost(r) \
373 dev_to_shost(r->dev.parent)
374
375/*
376 * FC SCSI Target Attributes
377 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300378 * The SCSI Target is considered an extension of a remote port (as
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 * a remote port can be more than a SCSI Target). Within the scsi
380 * subsystem, we leave the Target as a separate entity. Doing so
381 * provides backward compatibility with prior FC transport api's,
382 * and lets remote ports be handled entirely within the FC transport
383 * and independently from the scsi subsystem. The drawback is that
384 * some data will be duplicated.
385 */
386
387struct fc_starget_attrs { /* aka fc_target_attrs */
388 /* Dynamic Attributes */
389 u64 node_name;
390 u64 port_name;
391 u32 port_id;
392};
393
394#define fc_starget_node_name(x) \
395 (((struct fc_starget_attrs *)&(x)->starget_data)->node_name)
396#define fc_starget_port_name(x) \
397 (((struct fc_starget_attrs *)&(x)->starget_data)->port_name)
398#define fc_starget_port_id(x) \
399 (((struct fc_starget_attrs *)&(x)->starget_data)->port_id)
400
401#define starget_to_rport(s) \
402 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL
403
404
405/*
406 * FC Local Port (Host) Statistics
407 */
408
409/* FC Statistics - Following FC HBAAPI v2.0 guidelines */
410struct fc_host_statistics {
411 /* port statistics */
412 u64 seconds_since_last_reset;
413 u64 tx_frames;
414 u64 tx_words;
415 u64 rx_frames;
416 u64 rx_words;
417 u64 lip_count;
418 u64 nos_count;
419 u64 error_frames;
420 u64 dumped_frames;
421 u64 link_failure_count;
422 u64 loss_of_sync_count;
423 u64 loss_of_signal_count;
424 u64 prim_seq_protocol_err_count;
425 u64 invalid_tx_word_count;
426 u64 invalid_crc_count;
James Smart9ef3e4a2007-05-24 19:04:44 -0400427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 /* fc4 statistics (only FCP supported currently) */
429 u64 fcp_input_requests;
430 u64 fcp_output_requests;
431 u64 fcp_control_requests;
432 u64 fcp_input_megabytes;
433 u64 fcp_output_megabytes;
Vasu Deve58abb02012-05-25 10:26:38 -0700434 u64 fcp_packet_alloc_failures; /* fcp packet allocation failures */
435 u64 fcp_packet_aborts; /* fcp packet aborted */
436 u64 fcp_frame_alloc_failures; /* fcp frame allocation failures */
437
438 /* fc exches statistics */
439 u64 fc_no_free_exch; /* no free exch memory */
440 u64 fc_no_free_exch_xid; /* no free exch id */
441 u64 fc_xid_not_found; /* exch not found for a response */
442 u64 fc_xid_busy; /* exch exist for new a request */
443 u64 fc_seq_not_found; /* seq is not found for exchange */
444 u64 fc_non_bls_resp; /* a non BLS response frame with
445 a sequence responder in new exch */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446};
447
448
449/*
James Smart84314fd2006-08-18 17:30:09 -0400450 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
451 */
452
453/*
454 * fc_host_event_code: If you alter this, you also need to alter
455 * scsi_transport_fc.c (for the ascii descriptions).
456 */
457enum fc_host_event_code {
458 FCH_EVT_LIP = 0x1,
459 FCH_EVT_LINKUP = 0x2,
460 FCH_EVT_LINKDOWN = 0x3,
461 FCH_EVT_LIPRESET = 0x4,
462 FCH_EVT_RSCN = 0x5,
463 FCH_EVT_ADAPTER_CHANGE = 0x103,
464 FCH_EVT_PORT_UNKNOWN = 0x200,
465 FCH_EVT_PORT_OFFLINE = 0x201,
466 FCH_EVT_PORT_ONLINE = 0x202,
467 FCH_EVT_PORT_FABRIC = 0x204,
468 FCH_EVT_LINK_UNKNOWN = 0x500,
469 FCH_EVT_VENDOR_UNIQUE = 0xffff,
470};
471
472
473/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 * FC Local Port (Host) Attributes
475 *
476 * Attributes are based on HBAAPI V2.0 definitions.
477 * Note: OSDeviceName is determined by user-space library
478 *
479 * Fixed attributes are not expected to change. The driver is
480 * expected to set these values after successfully calling scsi_add_host().
481 * The transport fully manages all get functions w/o driver interaction.
482 *
483 * Dynamic attributes are expected to change. The driver participates
484 * in all get/set operations via functions provided by the driver.
485 *
486 * Private attributes are transport-managed values. They are fully
487 * managed by the transport w/o driver interaction.
488 */
489
490#define FC_FC4_LIST_SIZE 32
491#define FC_SYMBOLIC_NAME_SIZE 256
492#define FC_VERSION_STRING_SIZE 64
493#define FC_SERIAL_NUMBER_SIZE 80
494
495struct fc_host_attrs {
496 /* Fixed Attributes */
497 u64 node_name;
498 u64 port_name;
Andreas Herrmann6b7281d2006-01-13 02:16:54 +0100499 u64 permanent_port_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 u32 supported_classes;
501 u8 supported_fc4s[FC_FC4_LIST_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 u32 supported_speeds;
503 u32 maxframe_size;
James Smarta53eb5e2007-04-27 12:41:09 -0400504 u16 max_npiv_vports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 char serial_number[FC_SERIAL_NUMBER_SIZE];
Neerav Parikhbb8ef582012-01-22 17:29:50 -0800506 char manufacturer[FC_SERIAL_NUMBER_SIZE];
507 char model[FC_SYMBOLIC_NAME_SIZE];
508 char model_description[FC_SYMBOLIC_NAME_SIZE];
509 char hardware_version[FC_VERSION_STRING_SIZE];
510 char driver_version[FC_VERSION_STRING_SIZE];
511 char firmware_version[FC_VERSION_STRING_SIZE];
512 char optionrom_version[FC_VERSION_STRING_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514 /* Dynamic Attributes */
515 u32 port_id;
516 enum fc_port_type port_type;
517 enum fc_port_state port_state;
518 u8 active_fc4s[FC_FC4_LIST_SIZE];
519 u32 speed;
520 u64 fabric_name;
James Smartb8d08212006-08-17 08:00:43 -0400521 char symbolic_name[FC_SYMBOLIC_NAME_SIZE];
522 char system_hostname[FC_SYMBOLIC_NAME_SIZE];
Mike Christie43ca9102010-09-15 16:52:32 -0500523 u32 dev_loss_tmo;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
525 /* Private (Transport-managed) Attributes */
526 enum fc_tgtid_binding_type tgtid_bind_type;
527
528 /* internal data */
529 struct list_head rports;
530 struct list_head rport_bindings;
James Smarta53eb5e2007-04-27 12:41:09 -0400531 struct list_head vports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 u32 next_rport_number;
533 u32 next_target_id;
James Smarta53eb5e2007-04-27 12:41:09 -0400534 u32 next_vport_number;
535 u16 npiv_vports_inuse;
James Smartaedf3492006-04-10 10:14:05 -0400536
537 /* work queues for rport state manipulation */
Kay Sieversaab0de22008-05-02 06:02:41 +0200538 char work_q_name[20];
James Smartaedf3492006-04-10 10:14:05 -0400539 struct workqueue_struct *work_q;
Kay Sieversaab0de22008-05-02 06:02:41 +0200540 char devloss_work_q_name[20];
James Smartaedf3492006-04-10 10:14:05 -0400541 struct workqueue_struct *devloss_work_q;
James Smart9e4f5e22009-03-26 13:33:19 -0400542
543 /* bsg support */
544 struct request_queue *rqst_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545};
546
James Smartaedf3492006-04-10 10:14:05 -0400547#define shost_to_fc_host(x) \
548 ((struct fc_host_attrs *)(x)->shost_data)
James.Smart@Emulex.Com42e33142005-12-15 09:56:22 -0500549
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550#define fc_host_node_name(x) \
551 (((struct fc_host_attrs *)(x)->shost_data)->node_name)
552#define fc_host_port_name(x) \
553 (((struct fc_host_attrs *)(x)->shost_data)->port_name)
Andreas Herrmann6b7281d2006-01-13 02:16:54 +0100554#define fc_host_permanent_port_name(x) \
555 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556#define fc_host_supported_classes(x) \
557 (((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
558#define fc_host_supported_fc4s(x) \
559 (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560#define fc_host_supported_speeds(x) \
561 (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
562#define fc_host_maxframe_size(x) \
563 (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
James Smarta53eb5e2007-04-27 12:41:09 -0400564#define fc_host_max_npiv_vports(x) \
565 (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566#define fc_host_serial_number(x) \
567 (((struct fc_host_attrs *)(x)->shost_data)->serial_number)
Neerav Parikhbb8ef582012-01-22 17:29:50 -0800568#define fc_host_manufacturer(x) \
569 (((struct fc_host_attrs *)(x)->shost_data)->manufacturer)
570#define fc_host_model(x) \
571 (((struct fc_host_attrs *)(x)->shost_data)->model)
572#define fc_host_model_description(x) \
573 (((struct fc_host_attrs *)(x)->shost_data)->model_description)
574#define fc_host_hardware_version(x) \
575 (((struct fc_host_attrs *)(x)->shost_data)->hardware_version)
576#define fc_host_driver_version(x) \
577 (((struct fc_host_attrs *)(x)->shost_data)->driver_version)
578#define fc_host_firmware_version(x) \
579 (((struct fc_host_attrs *)(x)->shost_data)->firmware_version)
580#define fc_host_optionrom_version(x) \
581 (((struct fc_host_attrs *)(x)->shost_data)->optionrom_version)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582#define fc_host_port_id(x) \
583 (((struct fc_host_attrs *)(x)->shost_data)->port_id)
584#define fc_host_port_type(x) \
585 (((struct fc_host_attrs *)(x)->shost_data)->port_type)
586#define fc_host_port_state(x) \
587 (((struct fc_host_attrs *)(x)->shost_data)->port_state)
588#define fc_host_active_fc4s(x) \
589 (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
590#define fc_host_speed(x) \
591 (((struct fc_host_attrs *)(x)->shost_data)->speed)
592#define fc_host_fabric_name(x) \
593 (((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
James Smartb8d08212006-08-17 08:00:43 -0400594#define fc_host_symbolic_name(x) \
595 (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
596#define fc_host_system_hostname(x) \
597 (((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598#define fc_host_tgtid_bind_type(x) \
599 (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
600#define fc_host_rports(x) \
601 (((struct fc_host_attrs *)(x)->shost_data)->rports)
602#define fc_host_rport_bindings(x) \
603 (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
James Smarta53eb5e2007-04-27 12:41:09 -0400604#define fc_host_vports(x) \
605 (((struct fc_host_attrs *)(x)->shost_data)->vports)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606#define fc_host_next_rport_number(x) \
607 (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
608#define fc_host_next_target_id(x) \
609 (((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
James Smarta53eb5e2007-04-27 12:41:09 -0400610#define fc_host_next_vport_number(x) \
611 (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number)
612#define fc_host_npiv_vports_inuse(x) \
613 (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse)
James Smartaedf3492006-04-10 10:14:05 -0400614#define fc_host_work_q_name(x) \
615 (((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
616#define fc_host_work_q(x) \
617 (((struct fc_host_attrs *)(x)->shost_data)->work_q)
618#define fc_host_devloss_work_q_name(x) \
619 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
620#define fc_host_devloss_work_q(x) \
621 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)
Mike Christie43ca9102010-09-15 16:52:32 -0500622#define fc_host_dev_loss_tmo(x) \
623 (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625
James Smart9e4f5e22009-03-26 13:33:19 -0400626struct fc_bsg_buffer {
627 unsigned int payload_len;
628 int sg_cnt;
629 struct scatterlist *sg_list;
630};
631
632/* Values for fc_bsg_job->state_flags (bitflags) */
633#define FC_RQST_STATE_INPROGRESS 0
634#define FC_RQST_STATE_DONE 1
635
636struct fc_bsg_job {
637 struct Scsi_Host *shost;
638 struct fc_rport *rport;
639 struct device *dev;
640 struct request *req;
641 spinlock_t job_lock;
642 unsigned int state_flags;
643 unsigned int ref_cnt;
644 void (*job_done)(struct fc_bsg_job *);
645
646 struct fc_bsg_request *request;
647 struct fc_bsg_reply *reply;
648 unsigned int request_len;
649 unsigned int reply_len;
650 /*
651 * On entry : reply_len indicates the buffer size allocated for
652 * the reply.
653 *
654 * Upon completion : the message handler must set reply_len
655 * to indicates the size of the reply to be returned to the
656 * caller.
657 */
658
659 /* DMA payloads for the request/response */
660 struct fc_bsg_buffer request_payload;
661 struct fc_bsg_buffer reply_payload;
662
663 void *dd_data; /* Used for driver-specific storage */
664};
665
666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667/* The functions by which the transport class and the driver communicate */
668struct fc_function_template {
669 void (*get_rport_dev_loss_tmo)(struct fc_rport *);
670 void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32);
671
672 void (*get_starget_node_name)(struct scsi_target *);
673 void (*get_starget_port_name)(struct scsi_target *);
674 void (*get_starget_port_id)(struct scsi_target *);
675
676 void (*get_host_port_id)(struct Scsi_Host *);
677 void (*get_host_port_type)(struct Scsi_Host *);
678 void (*get_host_port_state)(struct Scsi_Host *);
679 void (*get_host_active_fc4s)(struct Scsi_Host *);
680 void (*get_host_speed)(struct Scsi_Host *);
681 void (*get_host_fabric_name)(struct Scsi_Host *);
James Smart016131b2006-08-14 08:20:25 -0400682 void (*get_host_symbolic_name)(struct Scsi_Host *);
James Smartb8d08212006-08-17 08:00:43 -0400683 void (*set_host_system_hostname)(struct Scsi_Host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
685 struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *);
686 void (*reset_fc_host_stats)(struct Scsi_Host *);
687
Andrew Vasquez91ca7b02005-10-27 16:03:37 -0700688 int (*issue_fc_host_lip)(struct Scsi_Host *);
689
James Smart0f29b962006-08-18 17:33:29 -0400690 void (*dev_loss_tmo_callbk)(struct fc_rport *);
691 void (*terminate_rport_io)(struct fc_rport *);
692
James Smarta53eb5e2007-04-27 12:41:09 -0400693 void (*set_vport_symbolic_name)(struct fc_vport *);
694 int (*vport_create)(struct fc_vport *, bool);
695 int (*vport_disable)(struct fc_vport *, bool);
696 int (*vport_delete)(struct fc_vport *);
697
FUJITA Tomonori75252362007-09-01 02:02:27 +0900698 /* target-mode drivers' functions */
699 int (* tsk_mgmt_response)(struct Scsi_Host *, u64, u64, int);
700 int (* it_nexus_response)(struct Scsi_Host *, u64, int);
701
James Smart9e4f5e22009-03-26 13:33:19 -0400702 /* bsg support */
703 int (*bsg_request)(struct fc_bsg_job *);
704 int (*bsg_timeout)(struct fc_bsg_job *);
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 /* allocation lengths for host-specific data */
707 u32 dd_fcrport_size;
James Smarta53eb5e2007-04-27 12:41:09 -0400708 u32 dd_fcvport_size;
James Smart9e4f5e22009-03-26 13:33:19 -0400709 u32 dd_bsg_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
James Smart9ef3e4a2007-05-24 19:04:44 -0400711 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 * The driver sets these to tell the transport class it
713 * wants the attributes displayed in sysfs. If the show_ flag
714 * is not set, the attribute will be private to the transport
James Smart9ef3e4a2007-05-24 19:04:44 -0400715 * class
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 */
717
718 /* remote port fixed attributes */
719 unsigned long show_rport_maxframe_size:1;
720 unsigned long show_rport_supported_classes:1;
721 unsigned long show_rport_dev_loss_tmo:1;
722
723 /*
724 * target dynamic attributes
725 * These should all be "1" if the driver uses the remote port
726 * add/delete functions (so attributes reflect rport values).
727 */
728 unsigned long show_starget_node_name:1;
729 unsigned long show_starget_port_name:1;
730 unsigned long show_starget_port_id:1;
731
732 /* host fixed attributes */
733 unsigned long show_host_node_name:1;
734 unsigned long show_host_port_name:1;
Andreas Herrmann6b7281d2006-01-13 02:16:54 +0100735 unsigned long show_host_permanent_port_name:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 unsigned long show_host_supported_classes:1;
737 unsigned long show_host_supported_fc4s:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 unsigned long show_host_supported_speeds:1;
739 unsigned long show_host_maxframe_size:1;
740 unsigned long show_host_serial_number:1;
Neerav Parikhbb8ef582012-01-22 17:29:50 -0800741 unsigned long show_host_manufacturer:1;
742 unsigned long show_host_model:1;
743 unsigned long show_host_model_description:1;
744 unsigned long show_host_hardware_version:1;
745 unsigned long show_host_driver_version:1;
746 unsigned long show_host_firmware_version:1;
747 unsigned long show_host_optionrom_version:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 /* host dynamic attributes */
749 unsigned long show_host_port_id:1;
750 unsigned long show_host_port_type:1;
751 unsigned long show_host_port_state:1;
752 unsigned long show_host_active_fc4s:1;
753 unsigned long show_host_speed:1;
754 unsigned long show_host_fabric_name:1;
James Smart016131b2006-08-14 08:20:25 -0400755 unsigned long show_host_symbolic_name:1;
James Smartb8d08212006-08-17 08:00:43 -0400756 unsigned long show_host_system_hostname:1;
Christof Schmitt03f002f2007-08-28 09:31:21 +0200757
758 unsigned long disable_target_scan:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759};
760
761
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400762/**
763 * fc_remote_port_chkready - called to validate the remote port state
764 * prior to initiating io to the port.
765 *
766 * Returns a scsi result code that can be returned by the LLDD.
767 *
768 * @rport: remote port to be checked
769 **/
770static inline int
771fc_remote_port_chkready(struct fc_rport *rport)
772{
773 int result;
774
775 switch (rport->port_state) {
776 case FC_PORTSTATE_ONLINE:
James Smarta53eb5e2007-04-27 12:41:09 -0400777 if (rport->roles & FC_PORT_ROLE_FCP_TARGET)
James Smartaedf3492006-04-10 10:14:05 -0400778 result = 0;
779 else if (rport->flags & FC_RPORT_DEVLOSS_PENDING)
Andrew Vasquez9a1a69a12009-04-29 13:12:39 -0500780 result = DID_IMM_RETRY << 16;
James Smartaedf3492006-04-10 10:14:05 -0400781 else
782 result = DID_NO_CONNECT << 16;
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400783 break;
784 case FC_PORTSTATE_BLOCKED:
Mike Christiefff9d402008-08-19 18:45:23 -0500785 if (rport->flags & FC_RPORT_FAST_FAIL_TIMEDOUT)
Mike Christief46e3072008-08-19 18:45:27 -0500786 result = DID_TRANSPORT_FAILFAST << 16;
Mike Christiefff9d402008-08-19 18:45:23 -0500787 else
Andrew Vasquez9a1a69a12009-04-29 13:12:39 -0500788 result = DID_IMM_RETRY << 16;
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400789 break;
790 default:
791 result = DID_NO_CONNECT << 16;
792 break;
793 }
794 return result;
795}
796
James Smartb8d08212006-08-17 08:00:43 -0400797static inline u64 wwn_to_u64(u8 *wwn)
798{
799 return (u64)wwn[0] << 56 | (u64)wwn[1] << 48 |
800 (u64)wwn[2] << 40 | (u64)wwn[3] << 32 |
801 (u64)wwn[4] << 24 | (u64)wwn[5] << 16 |
802 (u64)wwn[6] << 8 | (u64)wwn[7];
803}
804
805static inline void u64_to_wwn(u64 inm, u8 *wwn)
806{
807 wwn[0] = (inm >> 56) & 0xff;
808 wwn[1] = (inm >> 48) & 0xff;
809 wwn[2] = (inm >> 40) & 0xff;
810 wwn[3] = (inm >> 32) & 0xff;
811 wwn[4] = (inm >> 24) & 0xff;
812 wwn[5] = (inm >> 16) & 0xff;
813 wwn[6] = (inm >> 8) & 0xff;
814 wwn[7] = inm & 0xff;
815}
James.Smart@Emulex.Com19a7b4a2005-10-18 12:03:35 -0400816
James Smarta53eb5e2007-04-27 12:41:09 -0400817/**
818 * fc_vport_set_state() - called to set a vport's state. Saves the old state,
819 * excepting the transitory states of initializing and sending the ELS
820 * traffic to instantiate the vport on the link.
821 *
822 * Assumes the driver has surrounded this with the proper locking to ensure
823 * a coherent state change.
824 *
825 * @vport: virtual port whose state is changing
826 * @new_state: new state
827 **/
828static inline void
829fc_vport_set_state(struct fc_vport *vport, enum fc_vport_state new_state)
830{
831 if ((new_state != FC_VPORT_UNKNOWN) &&
832 (new_state != FC_VPORT_INITIALIZING))
833 vport->vport_last_state = vport->vport_state;
834 vport->vport_state = new_state;
835}
836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837struct scsi_transport_template *fc_attach_transport(
838 struct fc_function_template *);
839void fc_release_transport(struct scsi_transport_template *);
840void fc_remove_host(struct Scsi_Host *);
841struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost,
842 int channel, struct fc_rport_identifiers *ids);
843void fc_remote_port_delete(struct fc_rport *rport);
844void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845int scsi_is_fc_rport(const struct device *);
James Smart84314fd2006-08-18 17:30:09 -0400846u32 fc_get_event_number(void);
847void fc_host_post_event(struct Scsi_Host *shost, u32 event_number,
848 enum fc_host_event_code event_code, u32 event_data);
849void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number,
James Smartf14e2e22006-08-22 09:55:23 -0400850 u32 data_len, char * data_buf, u64 vendor_id);
James Smart84314fd2006-08-18 17:30:09 -0400851 /* Note: when specifying vendor_id to fc_host_post_vendor_event()
852 * be sure to read the Vendor Type and ID formatting requirements
853 * specified in scsi_netlink.h
854 */
Andrew Vasqueza30c3f62008-07-18 08:32:52 -0700855struct fc_vport *fc_vport_create(struct Scsi_Host *shost, int channel,
856 struct fc_vport_identifiers *);
James Smarta53eb5e2007-04-27 12:41:09 -0400857int fc_vport_terminate(struct fc_vport *vport);
Christof Schmitt2f2eb582010-03-24 16:50:30 +0100858int fc_block_scsi_eh(struct scsi_cmnd *cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860#endif /* SCSI_TRANSPORT_FC_H */