include/scsi/scsi_transport_fc.h

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