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