2 * FiberChannel transport specific attributes exported to sysfs.
4 * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
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.
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.
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
22 * Copyright (C) 2004-2007 James Smart, Emulex Corporation
23 * Rewrite for host, target, device, and remote port attributes,
24 * statistics, and service functions...
27 #ifndef SCSI_TRANSPORT_FC_H
28 #define SCSI_TRANSPORT_FC_H
30 #include <linux/sched.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_netlink.h>
34 struct scsi_transport_template
;
37 * FC Port definitions - Following FC HBAAPI guidelines
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.
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
53 * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c
54 * (for the ascii descriptions).
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 */
64 FC_PORTTYPE_NPIV
, /* VPORT based on NPIV */
69 * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c
70 * (for the ascii descriptions).
74 FC_PORTSTATE_NOTPRESENT
,
76 FC_PORTSTATE_OFFLINE
, /* User has taken Port Offline */
78 FC_PORTSTATE_BYPASSED
,
79 FC_PORTSTATE_DIAGNOSTICS
,
80 FC_PORTSTATE_LINKDOWN
,
82 FC_PORTSTATE_LOOPBACK
,
88 * fc_vport_state: If you alter this, you also need to alter
89 * scsi_transport_fc.c (for the ascii descriptions).
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
,
107 * 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).
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
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).
125 #define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver
126 incapable of reporting */
127 #define FC_PORTSPEED_1GBIT 1
128 #define FC_PORTSPEED_2GBIT 2
129 #define FC_PORTSPEED_10GBIT 4
130 #define FC_PORTSPEED_4GBIT 8
131 #define FC_PORTSPEED_8GBIT 0x10
132 #define FC_PORTSPEED_16GBIT 0x20
133 #define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */
136 * fc_tgtid_binding_type: If you alter this, you also need to alter
137 * scsi_transport_fc.c (for the ascii descriptions).
139 enum fc_tgtid_binding_type
{
141 FC_TGTID_BIND_BY_WWPN
,
142 FC_TGTID_BIND_BY_WWNN
,
148 * Note: values are not enumerated, as they can be "or'd" together
149 * for reporting (e.g. report roles). If you alter this list,
150 * you also need to alter scsi_transport_fc.c (for the ascii descriptions).
152 #define FC_PORT_ROLE_UNKNOWN 0x00
153 #define FC_PORT_ROLE_FCP_TARGET 0x01
154 #define FC_PORT_ROLE_FCP_INITIATOR 0x02
155 #define FC_PORT_ROLE_IP_PORT 0x04
157 /* The following are for compatibility */
158 #define FC_RPORT_ROLE_UNKNOWN FC_PORT_ROLE_UNKNOWN
159 #define FC_RPORT_ROLE_FCP_TARGET FC_PORT_ROLE_FCP_TARGET
160 #define FC_RPORT_ROLE_FCP_INITIATOR FC_PORT_ROLE_FCP_INITIATOR
161 #define FC_RPORT_ROLE_IP_PORT FC_PORT_ROLE_IP_PORT
164 /* Macro for use in defining Virtual Port attributes */
165 #define FC_VPORT_ATTR(_name,_mode,_show,_store) \
166 struct device_attribute dev_attr_vport_##_name = \
167 __ATTR(_name,_mode,_show,_store)
170 * fc_vport_identifiers: This set of data contains all elements
171 * to uniquely identify and instantiate a FC virtual port.
174 * symbolic_name: The driver is to append the symbolic_name string data
175 * to the symbolic_node_name data that it generates by default.
176 * the resulting combination should then be registered with the switch.
177 * It is expected that things like Xen may stuff a VM title into
180 #define FC_VPORT_SYMBOLIC_NAMELEN 64
181 struct fc_vport_identifiers
{
186 enum fc_port_type vport_type
; /* only FC_PORTTYPE_NPIV allowed */
187 char symbolic_name
[FC_VPORT_SYMBOLIC_NAMELEN
];
191 * FC Virtual Port Attributes
193 * This structure exists for each FC port is a virtual FC port. Virtual
194 * ports share the physical link with the Physical port. Each virtual
195 * ports has a unique presence on the SAN, and may be instantiated via
196 * NPIV, Virtual Fabrics, or via additional ALPAs. As the vport is a
197 * unique presence, each vport has it's own view of the fabric,
198 * authentication privilege, and priorities.
200 * A virtual port may support 1 or more FC4 roles. Typically it is a
201 * FCP Initiator. It could be a FCP Target, or exist sole for an IP over FC
202 * roles. FC port attributes for the vport will be reported on any
203 * fc_host class object allocated for an FCP Initiator.
207 * Fixed attributes are not expected to change. The driver is
208 * expected to set these values after receiving the fc_vport structure
209 * via the vport_create() call from the transport.
210 * The transport fully manages all get functions w/o driver interaction.
212 * Dynamic attributes are expected to change. The driver participates
213 * in all get/set operations via functions provided by the driver.
215 * Private attributes are transport-managed values. They are fully
216 * managed by the transport w/o driver interaction.
220 /* Fixed Attributes */
222 /* Dynamic Attributes */
224 /* Private (Transport-managed) Attributes */
225 enum fc_vport_state vport_state
;
226 enum fc_vport_state vport_last_state
;
230 u32 vport_id
; /* Admin Identifier for the vport */
231 enum fc_port_type vport_type
;
232 char symbolic_name
[FC_VPORT_SYMBOLIC_NAMELEN
];
235 void *dd_data
; /* Used for driver-specific storage */
238 struct Scsi_Host
*shost
; /* Physical Port Parent */
239 unsigned int channel
;
242 struct list_head peers
;
244 struct work_struct vport_delete_work
;
245 } __attribute__((aligned(sizeof(unsigned long))));
247 /* bit field values for struct fc_vport "flags" field: */
248 #define FC_VPORT_CREATING 0x01
249 #define FC_VPORT_DELETING 0x02
250 #define FC_VPORT_DELETED 0x04
251 #define FC_VPORT_DEL 0x06 /* Any DELETE state */
253 #define dev_to_vport(d) \
254 container_of(d, struct fc_vport, dev)
255 #define transport_class_to_vport(dev) \
256 dev_to_vport(dev->parent)
257 #define vport_to_shost(v) \
259 #define vport_to_shost_channel(v) \
261 #define vport_to_parent(v) \
265 /* Error return codes for vport_create() callback */
266 #define VPCERR_UNSUPPORTED -ENOSYS /* no driver/adapter
268 #define VPCERR_BAD_WWN -ENOTUNIQ /* driver validation
270 #define VPCERR_NO_FABRIC_SUPP -EOPNOTSUPP /* Fabric connection
276 * fc_rport_identifiers: This set of data contains all elements
277 * to uniquely identify a remote FC port. The driver uses this data
278 * to report the existence of a remote FC port in the topology. Internally,
279 * the transport uses this data for attributes and to manage consistent
280 * target id bindings.
282 struct fc_rport_identifiers
{
290 /* Macro for use in defining Remote Port attributes */
291 #define FC_RPORT_ATTR(_name,_mode,_show,_store) \
292 struct device_attribute dev_attr_rport_##_name = \
293 __ATTR(_name,_mode,_show,_store)
297 * FC Remote Port Attributes
299 * This structure exists for each remote FC port that a LLDD notifies
300 * the subsystem of. A remote FC port may or may not be a SCSI Target,
301 * also be a SCSI initiator, IP endpoint, etc. As such, the remote
302 * port is considered a separate entity, independent of "role" (such
307 * Attributes are based on HBAAPI V2.0 definitions. Only those
308 * attributes that are determinable by the local port (aka Host)
311 * Fixed attributes are not expected to change. The driver is
312 * expected to set these values after successfully calling
313 * fc_remote_port_add(). The transport fully manages all get functions
314 * w/o driver interaction.
316 * Dynamic attributes are expected to change. The driver participates
317 * in all get/set operations via functions provided by the driver.
319 * Private attributes are transport-managed values. They are fully
320 * managed by the transport w/o driver interaction.
323 struct fc_rport
{ /* aka fc_starget_attrs */
324 /* Fixed Attributes */
326 u32 supported_classes
;
328 /* Dynamic Attributes */
329 u32 dev_loss_tmo
; /* Remote Port loss timeout in seconds. */
331 /* Private (Transport-managed) Attributes */
336 enum fc_port_state port_state
; /* Will only be ONLINE or UNKNOWN */
338 u32 fast_io_fail_tmo
;
341 void *dd_data
; /* Used for driver-specific storage */
344 unsigned int channel
;
347 struct list_head peers
;
349 struct delayed_work dev_loss_work
;
350 struct work_struct scan_work
;
351 struct delayed_work fail_io_work
;
352 struct work_struct stgt_delete_work
;
353 struct work_struct rport_delete_work
;
354 struct request_queue
*rqst_q
; /* bsg support */
355 } __attribute__((aligned(sizeof(unsigned long))));
357 /* bit field values for struct fc_rport "flags" field: */
358 #define FC_RPORT_DEVLOSS_PENDING 0x01
359 #define FC_RPORT_SCAN_PENDING 0x02
360 #define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04
361 #define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08
363 #define dev_to_rport(d) \
364 container_of(d, struct fc_rport, dev)
365 #define transport_class_to_rport(dev) \
366 dev_to_rport(dev->parent)
367 #define rport_to_shost(r) \
368 dev_to_shost(r->dev.parent)
371 * FC SCSI Target Attributes
373 * The SCSI Target is considered an extension of a remote port (as
374 * a remote port can be more than a SCSI Target). Within the scsi
375 * subsystem, we leave the Target as a separate entity. Doing so
376 * provides backward compatibility with prior FC transport api's,
377 * and lets remote ports be handled entirely within the FC transport
378 * and independently from the scsi subsystem. The drawback is that
379 * some data will be duplicated.
382 struct fc_starget_attrs
{ /* aka fc_target_attrs */
383 /* Dynamic Attributes */
389 #define fc_starget_node_name(x) \
390 (((struct fc_starget_attrs *)&(x)->starget_data)->node_name)
391 #define fc_starget_port_name(x) \
392 (((struct fc_starget_attrs *)&(x)->starget_data)->port_name)
393 #define fc_starget_port_id(x) \
394 (((struct fc_starget_attrs *)&(x)->starget_data)->port_id)
396 #define starget_to_rport(s) \
397 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL
401 * FC Local Port (Host) Statistics
404 /* FC Statistics - Following FC HBAAPI v2.0 guidelines */
405 struct fc_host_statistics
{
406 /* port statistics */
407 u64 seconds_since_last_reset
;
416 u64 link_failure_count
;
417 u64 loss_of_sync_count
;
418 u64 loss_of_signal_count
;
419 u64 prim_seq_protocol_err_count
;
420 u64 invalid_tx_word_count
;
421 u64 invalid_crc_count
;
423 /* fc4 statistics (only FCP supported currently) */
424 u64 fcp_input_requests
;
425 u64 fcp_output_requests
;
426 u64 fcp_control_requests
;
427 u64 fcp_input_megabytes
;
428 u64 fcp_output_megabytes
;
429 u64 fcp_packet_alloc_failures
; /* fcp packet allocation failures */
430 u64 fcp_packet_aborts
; /* fcp packet aborted */
431 u64 fcp_frame_alloc_failures
; /* fcp frame allocation failures */
433 /* fc exches statistics */
434 u64 fc_no_free_exch
; /* no free exch memory */
435 u64 fc_no_free_exch_xid
; /* no free exch id */
436 u64 fc_xid_not_found
; /* exch not found for a response */
437 u64 fc_xid_busy
; /* exch exist for new a request */
438 u64 fc_seq_not_found
; /* seq is not found for exchange */
439 u64 fc_non_bls_resp
; /* a non BLS response frame with
440 a sequence responder in new exch */
445 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
449 * fc_host_event_code: If you alter this, you also need to alter
450 * scsi_transport_fc.c (for the ascii descriptions).
452 enum fc_host_event_code
{
454 FCH_EVT_LINKUP
= 0x2,
455 FCH_EVT_LINKDOWN
= 0x3,
456 FCH_EVT_LIPRESET
= 0x4,
458 FCH_EVT_ADAPTER_CHANGE
= 0x103,
459 FCH_EVT_PORT_UNKNOWN
= 0x200,
460 FCH_EVT_PORT_OFFLINE
= 0x201,
461 FCH_EVT_PORT_ONLINE
= 0x202,
462 FCH_EVT_PORT_FABRIC
= 0x204,
463 FCH_EVT_LINK_UNKNOWN
= 0x500,
464 FCH_EVT_VENDOR_UNIQUE
= 0xffff,
469 * FC Local Port (Host) Attributes
471 * Attributes are based on HBAAPI V2.0 definitions.
472 * Note: OSDeviceName is determined by user-space library
474 * Fixed attributes are not expected to change. The driver is
475 * expected to set these values after successfully calling scsi_add_host().
476 * The transport fully manages all get functions w/o driver interaction.
478 * Dynamic attributes are expected to change. The driver participates
479 * in all get/set operations via functions provided by the driver.
481 * Private attributes are transport-managed values. They are fully
482 * managed by the transport w/o driver interaction.
485 #define FC_FC4_LIST_SIZE 32
486 #define FC_SYMBOLIC_NAME_SIZE 256
487 #define FC_VERSION_STRING_SIZE 64
488 #define FC_SERIAL_NUMBER_SIZE 80
490 struct fc_host_attrs
{
491 /* Fixed Attributes */
494 u64 permanent_port_name
;
495 u32 supported_classes
;
496 u8 supported_fc4s
[FC_FC4_LIST_SIZE
];
497 u32 supported_speeds
;
500 char serial_number
[FC_SERIAL_NUMBER_SIZE
];
501 char manufacturer
[FC_SERIAL_NUMBER_SIZE
];
502 char model
[FC_SYMBOLIC_NAME_SIZE
];
503 char model_description
[FC_SYMBOLIC_NAME_SIZE
];
504 char hardware_version
[FC_VERSION_STRING_SIZE
];
505 char driver_version
[FC_VERSION_STRING_SIZE
];
506 char firmware_version
[FC_VERSION_STRING_SIZE
];
507 char optionrom_version
[FC_VERSION_STRING_SIZE
];
509 /* Dynamic Attributes */
511 enum fc_port_type port_type
;
512 enum fc_port_state port_state
;
513 u8 active_fc4s
[FC_FC4_LIST_SIZE
];
516 char symbolic_name
[FC_SYMBOLIC_NAME_SIZE
];
517 char system_hostname
[FC_SYMBOLIC_NAME_SIZE
];
520 /* Private (Transport-managed) Attributes */
521 enum fc_tgtid_binding_type tgtid_bind_type
;
524 struct list_head rports
;
525 struct list_head rport_bindings
;
526 struct list_head vports
;
527 u32 next_rport_number
;
529 u32 next_vport_number
;
530 u16 npiv_vports_inuse
;
532 /* work queues for rport state manipulation */
533 char work_q_name
[20];
534 struct workqueue_struct
*work_q
;
535 char devloss_work_q_name
[20];
536 struct workqueue_struct
*devloss_work_q
;
539 struct request_queue
*rqst_q
;
542 #define shost_to_fc_host(x) \
543 ((struct fc_host_attrs *)(x)->shost_data)
545 #define fc_host_node_name(x) \
546 (((struct fc_host_attrs *)(x)->shost_data)->node_name)
547 #define fc_host_port_name(x) \
548 (((struct fc_host_attrs *)(x)->shost_data)->port_name)
549 #define fc_host_permanent_port_name(x) \
550 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
551 #define fc_host_supported_classes(x) \
552 (((struct fc_host_attrs *)(x)->shost_data)->supported_classes)
553 #define fc_host_supported_fc4s(x) \
554 (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s)
555 #define fc_host_supported_speeds(x) \
556 (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds)
557 #define fc_host_maxframe_size(x) \
558 (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size)
559 #define fc_host_max_npiv_vports(x) \
560 (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports)
561 #define fc_host_serial_number(x) \
562 (((struct fc_host_attrs *)(x)->shost_data)->serial_number)
563 #define fc_host_manufacturer(x) \
564 (((struct fc_host_attrs *)(x)->shost_data)->manufacturer)
565 #define fc_host_model(x) \
566 (((struct fc_host_attrs *)(x)->shost_data)->model)
567 #define fc_host_model_description(x) \
568 (((struct fc_host_attrs *)(x)->shost_data)->model_description)
569 #define fc_host_hardware_version(x) \
570 (((struct fc_host_attrs *)(x)->shost_data)->hardware_version)
571 #define fc_host_driver_version(x) \
572 (((struct fc_host_attrs *)(x)->shost_data)->driver_version)
573 #define fc_host_firmware_version(x) \
574 (((struct fc_host_attrs *)(x)->shost_data)->firmware_version)
575 #define fc_host_optionrom_version(x) \
576 (((struct fc_host_attrs *)(x)->shost_data)->optionrom_version)
577 #define fc_host_port_id(x) \
578 (((struct fc_host_attrs *)(x)->shost_data)->port_id)
579 #define fc_host_port_type(x) \
580 (((struct fc_host_attrs *)(x)->shost_data)->port_type)
581 #define fc_host_port_state(x) \
582 (((struct fc_host_attrs *)(x)->shost_data)->port_state)
583 #define fc_host_active_fc4s(x) \
584 (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s)
585 #define fc_host_speed(x) \
586 (((struct fc_host_attrs *)(x)->shost_data)->speed)
587 #define fc_host_fabric_name(x) \
588 (((struct fc_host_attrs *)(x)->shost_data)->fabric_name)
589 #define fc_host_symbolic_name(x) \
590 (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name)
591 #define fc_host_system_hostname(x) \
592 (((struct fc_host_attrs *)(x)->shost_data)->system_hostname)
593 #define fc_host_tgtid_bind_type(x) \
594 (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type)
595 #define fc_host_rports(x) \
596 (((struct fc_host_attrs *)(x)->shost_data)->rports)
597 #define fc_host_rport_bindings(x) \
598 (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings)
599 #define fc_host_vports(x) \
600 (((struct fc_host_attrs *)(x)->shost_data)->vports)
601 #define fc_host_next_rport_number(x) \
602 (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number)
603 #define fc_host_next_target_id(x) \
604 (((struct fc_host_attrs *)(x)->shost_data)->next_target_id)
605 #define fc_host_next_vport_number(x) \
606 (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number)
607 #define fc_host_npiv_vports_inuse(x) \
608 (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse)
609 #define fc_host_work_q_name(x) \
610 (((struct fc_host_attrs *)(x)->shost_data)->work_q_name)
611 #define fc_host_work_q(x) \
612 (((struct fc_host_attrs *)(x)->shost_data)->work_q)
613 #define fc_host_devloss_work_q_name(x) \
614 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name)
615 #define fc_host_devloss_work_q(x) \
616 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q)
617 #define fc_host_dev_loss_tmo(x) \
618 (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo)
621 struct fc_bsg_buffer
{
622 unsigned int payload_len
;
624 struct scatterlist
*sg_list
;
627 /* Values for fc_bsg_job->state_flags (bitflags) */
628 #define FC_RQST_STATE_INPROGRESS 0
629 #define FC_RQST_STATE_DONE 1
632 struct Scsi_Host
*shost
;
633 struct fc_rport
*rport
;
637 unsigned int state_flags
;
638 unsigned int ref_cnt
;
639 void (*job_done
)(struct fc_bsg_job
*);
641 struct fc_bsg_request
*request
;
642 struct fc_bsg_reply
*reply
;
643 unsigned int request_len
;
644 unsigned int reply_len
;
646 * On entry : reply_len indicates the buffer size allocated for
649 * Upon completion : the message handler must set reply_len
650 * to indicates the size of the reply to be returned to the
654 /* DMA payloads for the request/response */
655 struct fc_bsg_buffer request_payload
;
656 struct fc_bsg_buffer reply_payload
;
658 void *dd_data
; /* Used for driver-specific storage */
662 /* The functions by which the transport class and the driver communicate */
663 struct fc_function_template
{
664 void (*get_rport_dev_loss_tmo
)(struct fc_rport
*);
665 void (*set_rport_dev_loss_tmo
)(struct fc_rport
*, u32
);
667 void (*get_starget_node_name
)(struct scsi_target
*);
668 void (*get_starget_port_name
)(struct scsi_target
*);
669 void (*get_starget_port_id
)(struct scsi_target
*);
671 void (*get_host_port_id
)(struct Scsi_Host
*);
672 void (*get_host_port_type
)(struct Scsi_Host
*);
673 void (*get_host_port_state
)(struct Scsi_Host
*);
674 void (*get_host_active_fc4s
)(struct Scsi_Host
*);
675 void (*get_host_speed
)(struct Scsi_Host
*);
676 void (*get_host_fabric_name
)(struct Scsi_Host
*);
677 void (*get_host_symbolic_name
)(struct Scsi_Host
*);
678 void (*set_host_system_hostname
)(struct Scsi_Host
*);
680 struct fc_host_statistics
* (*get_fc_host_stats
)(struct Scsi_Host
*);
681 void (*reset_fc_host_stats
)(struct Scsi_Host
*);
683 int (*issue_fc_host_lip
)(struct Scsi_Host
*);
685 void (*dev_loss_tmo_callbk
)(struct fc_rport
*);
686 void (*terminate_rport_io
)(struct fc_rport
*);
688 void (*set_vport_symbolic_name
)(struct fc_vport
*);
689 int (*vport_create
)(struct fc_vport
*, bool);
690 int (*vport_disable
)(struct fc_vport
*, bool);
691 int (*vport_delete
)(struct fc_vport
*);
693 /* target-mode drivers' functions */
694 int (* tsk_mgmt_response
)(struct Scsi_Host
*, u64
, u64
, int);
695 int (* it_nexus_response
)(struct Scsi_Host
*, u64
, int);
698 int (*bsg_request
)(struct fc_bsg_job
*);
699 int (*bsg_timeout
)(struct fc_bsg_job
*);
701 /* allocation lengths for host-specific data */
707 * The driver sets these to tell the transport class it
708 * wants the attributes displayed in sysfs. If the show_ flag
709 * is not set, the attribute will be private to the transport
713 /* remote port fixed attributes */
714 unsigned long show_rport_maxframe_size
:1;
715 unsigned long show_rport_supported_classes
:1;
716 unsigned long show_rport_dev_loss_tmo
:1;
719 * target dynamic attributes
720 * These should all be "1" if the driver uses the remote port
721 * add/delete functions (so attributes reflect rport values).
723 unsigned long show_starget_node_name
:1;
724 unsigned long show_starget_port_name
:1;
725 unsigned long show_starget_port_id
:1;
727 /* host fixed attributes */
728 unsigned long show_host_node_name
:1;
729 unsigned long show_host_port_name
:1;
730 unsigned long show_host_permanent_port_name
:1;
731 unsigned long show_host_supported_classes
:1;
732 unsigned long show_host_supported_fc4s
:1;
733 unsigned long show_host_supported_speeds
:1;
734 unsigned long show_host_maxframe_size
:1;
735 unsigned long show_host_serial_number
:1;
736 unsigned long show_host_manufacturer
:1;
737 unsigned long show_host_model
:1;
738 unsigned long show_host_model_description
:1;
739 unsigned long show_host_hardware_version
:1;
740 unsigned long show_host_driver_version
:1;
741 unsigned long show_host_firmware_version
:1;
742 unsigned long show_host_optionrom_version
:1;
743 /* host dynamic attributes */
744 unsigned long show_host_port_id
:1;
745 unsigned long show_host_port_type
:1;
746 unsigned long show_host_port_state
:1;
747 unsigned long show_host_active_fc4s
:1;
748 unsigned long show_host_speed
:1;
749 unsigned long show_host_fabric_name
:1;
750 unsigned long show_host_symbolic_name
:1;
751 unsigned long show_host_system_hostname
:1;
753 unsigned long disable_target_scan
:1;
758 * fc_remote_port_chkready - called to validate the remote port state
759 * prior to initiating io to the port.
761 * Returns a scsi result code that can be returned by the LLDD.
763 * @rport: remote port to be checked
766 fc_remote_port_chkready(struct fc_rport
*rport
)
770 switch (rport
->port_state
) {
771 case FC_PORTSTATE_ONLINE
:
772 if (rport
->roles
& FC_PORT_ROLE_FCP_TARGET
)
774 else if (rport
->flags
& FC_RPORT_DEVLOSS_PENDING
)
775 result
= DID_IMM_RETRY
<< 16;
777 result
= DID_NO_CONNECT
<< 16;
779 case FC_PORTSTATE_BLOCKED
:
780 if (rport
->flags
& FC_RPORT_FAST_FAIL_TIMEDOUT
)
781 result
= DID_TRANSPORT_FAILFAST
<< 16;
783 result
= DID_IMM_RETRY
<< 16;
786 result
= DID_NO_CONNECT
<< 16;
792 static inline u64
wwn_to_u64(u8
*wwn
)
794 return (u64
)wwn
[0] << 56 | (u64
)wwn
[1] << 48 |
795 (u64
)wwn
[2] << 40 | (u64
)wwn
[3] << 32 |
796 (u64
)wwn
[4] << 24 | (u64
)wwn
[5] << 16 |
797 (u64
)wwn
[6] << 8 | (u64
)wwn
[7];
800 static inline void u64_to_wwn(u64 inm
, u8
*wwn
)
802 wwn
[0] = (inm
>> 56) & 0xff;
803 wwn
[1] = (inm
>> 48) & 0xff;
804 wwn
[2] = (inm
>> 40) & 0xff;
805 wwn
[3] = (inm
>> 32) & 0xff;
806 wwn
[4] = (inm
>> 24) & 0xff;
807 wwn
[5] = (inm
>> 16) & 0xff;
808 wwn
[6] = (inm
>> 8) & 0xff;
813 * fc_vport_set_state() - called to set a vport's state. Saves the old state,
814 * excepting the transitory states of initializing and sending the ELS
815 * traffic to instantiate the vport on the link.
817 * Assumes the driver has surrounded this with the proper locking to ensure
818 * a coherent state change.
820 * @vport: virtual port whose state is changing
821 * @new_state: new state
824 fc_vport_set_state(struct fc_vport
*vport
, enum fc_vport_state new_state
)
826 if ((new_state
!= FC_VPORT_UNKNOWN
) &&
827 (new_state
!= FC_VPORT_INITIALIZING
))
828 vport
->vport_last_state
= vport
->vport_state
;
829 vport
->vport_state
= new_state
;
832 struct scsi_transport_template
*fc_attach_transport(
833 struct fc_function_template
*);
834 void fc_release_transport(struct scsi_transport_template
*);
835 void fc_remove_host(struct Scsi_Host
*);
836 struct fc_rport
*fc_remote_port_add(struct Scsi_Host
*shost
,
837 int channel
, struct fc_rport_identifiers
*ids
);
838 void fc_remote_port_delete(struct fc_rport
*rport
);
839 void fc_remote_port_rolechg(struct fc_rport
*rport
, u32 roles
);
840 int scsi_is_fc_rport(const struct device
*);
841 u32
fc_get_event_number(void);
842 void fc_host_post_event(struct Scsi_Host
*shost
, u32 event_number
,
843 enum fc_host_event_code event_code
, u32 event_data
);
844 void fc_host_post_vendor_event(struct Scsi_Host
*shost
, u32 event_number
,
845 u32 data_len
, char * data_buf
, u64 vendor_id
);
846 /* Note: when specifying vendor_id to fc_host_post_vendor_event()
847 * be sure to read the Vendor Type and ID formatting requirements
848 * specified in scsi_netlink.h
850 struct fc_vport
*fc_vport_create(struct Scsi_Host
*shost
, int channel
,
851 struct fc_vport_identifiers
*);
852 int fc_vport_terminate(struct fc_vport
*vport
);
853 int fc_block_scsi_eh(struct scsi_cmnd
*cmnd
);
855 #endif /* SCSI_TRANSPORT_FC_H */