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