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_32GBIT 0x40
134 #define FC_PORTSPEED_20GBIT 0x80
135 #define FC_PORTSPEED_40GBIT 0x100
136 #define FC_PORTSPEED_50GBIT 0x200
137 #define FC_PORTSPEED_100GBIT 0x400
138 #define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */
141 * fc_tgtid_binding_type: If you alter this, you also need to alter
142 * scsi_transport_fc.c (for the ascii descriptions).
144 enum fc_tgtid_binding_type
{
146 FC_TGTID_BIND_BY_WWPN
,
147 FC_TGTID_BIND_BY_WWNN
,
153 * 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).
157 #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
162 /* 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
169 /* Macro for use in defining Virtual Port attributes */
170 #define FC_VPORT_ATTR(_name,_mode,_show,_store) \
171 struct device_attribute dev_attr_vport_##_name = \
172 __ATTR(_name,_mode,_show,_store)
175 * fc_vport_identifiers: This set of data contains all elements
176 * to uniquely identify and instantiate a FC virtual port.
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
185 #define FC_VPORT_SYMBOLIC_NAMELEN 64
186 struct fc_vport_identifiers
{
191 enum fc_port_type vport_type
; /* only FC_PORTTYPE_NPIV allowed */
192 char symbolic_name
[FC_VPORT_SYMBOLIC_NAMELEN
];
196 * FC Virtual Port Attributes
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
200 * ports has a unique presence on the SAN, and may be instantiated via
201 * NPIV, Virtual Fabrics, or via additional ALPAs. As the vport is a
202 * unique presence, each vport has it's own view of the fabric,
203 * authentication privilege, and priorities.
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.
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.
217 * Dynamic attributes are expected to change. The driver participates
218 * in all get/set operations via functions provided by the driver.
220 * Private attributes are transport-managed values. They are fully
221 * managed by the transport w/o driver interaction.
225 /* Fixed Attributes */
227 /* Dynamic Attributes */
229 /* Private (Transport-managed) Attributes */
230 enum fc_vport_state vport_state
;
231 enum fc_vport_state vport_last_state
;
235 u32 vport_id
; /* Admin Identifier for the vport */
236 enum fc_port_type vport_type
;
237 char symbolic_name
[FC_VPORT_SYMBOLIC_NAMELEN
];
240 void *dd_data
; /* Used for driver-specific storage */
243 struct Scsi_Host
*shost
; /* Physical Port Parent */
244 unsigned int channel
;
247 struct list_head peers
;
249 struct work_struct vport_delete_work
;
250 } __attribute__((aligned(sizeof(unsigned long))));
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 */
258 #define dev_to_vport(d) \
259 container_of(d, struct fc_vport, dev)
260 #define transport_class_to_vport(dev) \
261 dev_to_vport(dev->parent)
262 #define vport_to_shost(v) \
264 #define vport_to_shost_channel(v) \
266 #define vport_to_parent(v) \
270 /* Error return codes for vport_create() callback */
271 #define VPCERR_UNSUPPORTED -ENOSYS /* no driver/adapter
273 #define VPCERR_BAD_WWN -ENOTUNIQ /* driver validation
275 #define VPCERR_NO_FABRIC_SUPP -EOPNOTSUPP /* Fabric connection
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.
287 struct fc_rport_identifiers
{
295 /* Macro for use in defining Remote Port attributes */
296 #define FC_RPORT_ATTR(_name,_mode,_show,_store) \
297 struct device_attribute dev_attr_rport_##_name = \
298 __ATTR(_name,_mode,_show,_store)
302 * FC Remote Port Attributes
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
312 * Attributes are based on HBAAPI V2.0 definitions. Only those
313 * attributes that are determinable by the local port (aka Host)
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.
321 * Dynamic attributes are expected to change. The driver participates
322 * in all get/set operations via functions provided by the driver.
324 * Private attributes are transport-managed values. They are fully
325 * managed by the transport w/o driver interaction.
328 struct fc_rport
{ /* aka fc_starget_attrs */
329 /* Fixed Attributes */
331 u32 supported_classes
;
333 /* Dynamic Attributes */
334 u32 dev_loss_tmo
; /* Remote Port loss timeout in seconds. */
336 /* Private (Transport-managed) Attributes */
341 enum fc_port_state port_state
; /* Will only be ONLINE or UNKNOWN */
343 u32 fast_io_fail_tmo
;
346 void *dd_data
; /* Used for driver-specific storage */
349 unsigned int channel
;
352 struct list_head peers
;
354 struct delayed_work dev_loss_work
;
355 struct work_struct scan_work
;
356 struct delayed_work fail_io_work
;
357 struct work_struct stgt_delete_work
;
358 struct work_struct rport_delete_work
;
359 struct request_queue
*rqst_q
; /* bsg support */
360 } __attribute__((aligned(sizeof(unsigned long))));
362 /* bit field values for struct fc_rport "flags" field: */
363 #define FC_RPORT_DEVLOSS_PENDING 0x01
364 #define FC_RPORT_SCAN_PENDING 0x02
365 #define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04
366 #define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08
368 #define dev_to_rport(d) \
369 container_of(d, struct fc_rport, dev)
370 #define transport_class_to_rport(dev) \
371 dev_to_rport(dev->parent)
372 #define rport_to_shost(r) \
373 dev_to_shost(r->dev.parent)
376 * FC SCSI Target Attributes
378 * The SCSI Target is considered an extension of a remote port (as
379 * 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.
387 struct fc_starget_attrs
{ /* aka fc_target_attrs */
388 /* Dynamic Attributes */
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)
401 #define starget_to_rport(s) \
402 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL
406 * FC Local Port (Host) Statistics
409 /* FC Statistics - Following FC HBAAPI v2.0 guidelines */
410 struct fc_host_statistics
{
411 /* port statistics */
412 u64 seconds_since_last_reset
;
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
;
428 /* 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
;
434 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 */
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 */
450 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines
454 * fc_host_event_code: If you alter this, you also need to alter
455 * scsi_transport_fc.c (for the ascii descriptions).
457 enum fc_host_event_code
{
459 FCH_EVT_LINKUP
= 0x2,
460 FCH_EVT_LINKDOWN
= 0x3,
461 FCH_EVT_LIPRESET
= 0x4,
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,
474 * FC Local Port (Host) Attributes
476 * Attributes are based on HBAAPI V2.0 definitions.
477 * Note: OSDeviceName is determined by user-space library
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.
483 * Dynamic attributes are expected to change. The driver participates
484 * in all get/set operations via functions provided by the driver.
486 * Private attributes are transport-managed values. They are fully
487 * managed by the transport w/o driver interaction.
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
495 struct fc_host_attrs
{
496 /* Fixed Attributes */
499 u64 permanent_port_name
;
500 u32 supported_classes
;
501 u8 supported_fc4s
[FC_FC4_LIST_SIZE
];
502 u32 supported_speeds
;
505 char serial_number
[FC_SERIAL_NUMBER_SIZE
];
506 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
];
514 /* Dynamic Attributes */
516 enum fc_port_type port_type
;
517 enum fc_port_state port_state
;
518 u8 active_fc4s
[FC_FC4_LIST_SIZE
];
521 char symbolic_name
[FC_SYMBOLIC_NAME_SIZE
];
522 char system_hostname
[FC_SYMBOLIC_NAME_SIZE
];
525 /* Private (Transport-managed) Attributes */
526 enum fc_tgtid_binding_type tgtid_bind_type
;
529 struct list_head rports
;
530 struct list_head rport_bindings
;
531 struct list_head vports
;
532 u32 next_rport_number
;
534 u32 next_vport_number
;
535 u16 npiv_vports_inuse
;
537 /* work queues for rport state manipulation */
538 char work_q_name
[20];
539 struct workqueue_struct
*work_q
;
540 char devloss_work_q_name
[20];
541 struct workqueue_struct
*devloss_work_q
;
544 struct request_queue
*rqst_q
;
547 #define shost_to_fc_host(x) \
548 ((struct fc_host_attrs *)(x)->shost_data)
550 #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)
554 #define fc_host_permanent_port_name(x) \
555 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name)
556 #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)
560 #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)
564 #define fc_host_max_npiv_vports(x) \
565 (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports)
566 #define fc_host_serial_number(x) \
567 (((struct fc_host_attrs *)(x)->shost_data)->serial_number)
568 #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)
582 #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)
594 #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)
598 #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)
604 #define fc_host_vports(x) \
605 (((struct fc_host_attrs *)(x)->shost_data)->vports)
606 #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)
610 #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)
614 #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)
622 #define fc_host_dev_loss_tmo(x) \
623 (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo)
626 struct fc_bsg_buffer
{
627 unsigned int payload_len
;
629 struct scatterlist
*sg_list
;
632 /* Values for fc_bsg_job->state_flags (bitflags) */
633 #define FC_RQST_STATE_INPROGRESS 0
634 #define FC_RQST_STATE_DONE 1
637 struct Scsi_Host
*shost
;
638 struct fc_rport
*rport
;
642 unsigned int state_flags
;
643 unsigned int ref_cnt
;
644 void (*job_done
)(struct fc_bsg_job
*);
646 struct fc_bsg_request
*request
;
647 struct fc_bsg_reply
*reply
;
648 unsigned int request_len
;
649 unsigned int reply_len
;
651 * On entry : reply_len indicates the buffer size allocated for
654 * Upon completion : the message handler must set reply_len
655 * to indicates the size of the reply to be returned to the
659 /* DMA payloads for the request/response */
660 struct fc_bsg_buffer request_payload
;
661 struct fc_bsg_buffer reply_payload
;
663 void *dd_data
; /* Used for driver-specific storage */
667 /* The functions by which the transport class and the driver communicate */
668 struct fc_function_template
{
669 void (*get_rport_dev_loss_tmo
)(struct fc_rport
*);
670 void (*set_rport_dev_loss_tmo
)(struct fc_rport
*, u32
);
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
*);
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
*);
682 void (*get_host_symbolic_name
)(struct Scsi_Host
*);
683 void (*set_host_system_hostname
)(struct Scsi_Host
*);
685 struct fc_host_statistics
* (*get_fc_host_stats
)(struct Scsi_Host
*);
686 void (*reset_fc_host_stats
)(struct Scsi_Host
*);
688 int (*issue_fc_host_lip
)(struct Scsi_Host
*);
690 void (*dev_loss_tmo_callbk
)(struct fc_rport
*);
691 void (*terminate_rport_io
)(struct fc_rport
*);
693 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
*);
698 /* 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);
703 int (*bsg_request
)(struct fc_bsg_job
*);
704 int (*bsg_timeout
)(struct fc_bsg_job
*);
706 /* allocation lengths for host-specific data */
712 * 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
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;
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).
728 unsigned long show_starget_node_name
:1;
729 unsigned long show_starget_port_name
:1;
730 unsigned long show_starget_port_id
:1;
732 /* host fixed attributes */
733 unsigned long show_host_node_name
:1;
734 unsigned long show_host_port_name
:1;
735 unsigned long show_host_permanent_port_name
:1;
736 unsigned long show_host_supported_classes
:1;
737 unsigned long show_host_supported_fc4s
:1;
738 unsigned long show_host_supported_speeds
:1;
739 unsigned long show_host_maxframe_size
:1;
740 unsigned long show_host_serial_number
:1;
741 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;
748 /* 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;
755 unsigned long show_host_symbolic_name
:1;
756 unsigned long show_host_system_hostname
:1;
758 unsigned long disable_target_scan
:1;
763 * fc_remote_port_chkready - called to validate the remote port state
764 * prior to initiating io to the port.
766 * Returns a scsi result code that can be returned by the LLDD.
768 * @rport: remote port to be checked
771 fc_remote_port_chkready(struct fc_rport
*rport
)
775 switch (rport
->port_state
) {
776 case FC_PORTSTATE_ONLINE
:
777 if (rport
->roles
& FC_PORT_ROLE_FCP_TARGET
)
779 else if (rport
->flags
& FC_RPORT_DEVLOSS_PENDING
)
780 result
= DID_IMM_RETRY
<< 16;
782 result
= DID_NO_CONNECT
<< 16;
784 case FC_PORTSTATE_BLOCKED
:
785 if (rport
->flags
& FC_RPORT_FAST_FAIL_TIMEDOUT
)
786 result
= DID_TRANSPORT_FAILFAST
<< 16;
788 result
= DID_IMM_RETRY
<< 16;
791 result
= DID_NO_CONNECT
<< 16;
797 static inline u64
wwn_to_u64(u8
*wwn
)
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];
805 static inline void u64_to_wwn(u64 inm
, u8
*wwn
)
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;
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.
822 * Assumes the driver has surrounded this with the proper locking to ensure
823 * a coherent state change.
825 * @vport: virtual port whose state is changing
826 * @new_state: new state
829 fc_vport_set_state(struct fc_vport
*vport
, enum fc_vport_state new_state
)
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
;
837 struct scsi_transport_template
*fc_attach_transport(
838 struct fc_function_template
*);
839 void fc_release_transport(struct scsi_transport_template
*);
840 void fc_remove_host(struct Scsi_Host
*);
841 struct fc_rport
*fc_remote_port_add(struct Scsi_Host
*shost
,
842 int channel
, struct fc_rport_identifiers
*ids
);
843 void fc_remote_port_delete(struct fc_rport
*rport
);
844 void fc_remote_port_rolechg(struct fc_rport
*rport
, u32 roles
);
845 int scsi_is_fc_rport(const struct device
*);
846 u32
fc_get_event_number(void);
847 void fc_host_post_event(struct Scsi_Host
*shost
, u32 event_number
,
848 enum fc_host_event_code event_code
, u32 event_data
);
849 void fc_host_post_vendor_event(struct Scsi_Host
*shost
, u32 event_number
,
850 u32 data_len
, char * data_buf
, u64 vendor_id
);
851 /* 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
855 struct fc_vport
*fc_vport_create(struct Scsi_Host
*shost
, int channel
,
856 struct fc_vport_identifiers
*);
857 int fc_vport_terminate(struct fc_vport
*vport
);
858 int fc_block_scsi_eh(struct scsi_cmnd
*cmnd
);
860 #endif /* SCSI_TRANSPORT_FC_H */