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 /* Macro for use in defining Remote Port attributes */ 290 #define FC_RPORT_ATTR(_name,_mode,_show,_store) \ 291 struct device_attribute dev_attr_rport_##_name = \ 292 __ATTR(_name,_mode,_show,_store) 293 294 295 /* 296 * FC Remote Port Attributes 297 * 298 * This structure exists for each remote FC port that a LLDD notifies 299 * the subsystem of. A remote FC port may or may not be a SCSI Target, 300 * also be a SCSI initiator, IP endpoint, etc. As such, the remote 301 * port is considered a separate entity, independent of "role" (such 302 * as scsi target). 303 * 304 * -- 305 * 306 * Attributes are based on HBAAPI V2.0 definitions. Only those 307 * attributes that are determinable by the local port (aka Host) 308 * are contained. 309 * 310 * Fixed attributes are not expected to change. The driver is 311 * expected to set these values after successfully calling 312 * fc_remote_port_add(). The transport fully manages all get functions 313 * w/o driver interaction. 314 * 315 * Dynamic attributes are expected to change. The driver participates 316 * in all get/set operations via functions provided by the driver. 317 * 318 * Private attributes are transport-managed values. They are fully 319 * managed by the transport w/o driver interaction. 320 */ 321 322 struct fc_rport { /* aka fc_starget_attrs */ 323 /* Fixed Attributes */ 324 u32 maxframe_size; 325 u32 supported_classes; 326 327 /* Dynamic Attributes */ 328 u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */ 329 330 /* Private (Transport-managed) Attributes */ 331 u64 node_name; 332 u64 port_name; 333 u32 port_id; 334 u32 roles; 335 enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */ 336 u32 scsi_target_id; 337 u32 fast_io_fail_tmo; 338 339 /* exported data */ 340 void *dd_data; /* Used for driver-specific storage */ 341 342 /* internal data */ 343 unsigned int channel; 344 u32 number; 345 u8 flags; 346 struct list_head peers; 347 struct device dev; 348 struct delayed_work dev_loss_work; 349 struct work_struct scan_work; 350 struct delayed_work fail_io_work; 351 struct work_struct stgt_delete_work; 352 struct work_struct rport_delete_work; 353 struct request_queue *rqst_q; /* bsg support */ 354 } __attribute__((aligned(sizeof(unsigned long)))); 355 356 /* bit field values for struct fc_rport "flags" field: */ 357 #define FC_RPORT_DEVLOSS_PENDING 0x01 358 #define FC_RPORT_SCAN_PENDING 0x02 359 #define FC_RPORT_FAST_FAIL_TIMEDOUT 0x04 360 #define FC_RPORT_DEVLOSS_CALLBK_DONE 0x08 361 362 #define dev_to_rport(d) \ 363 container_of(d, struct fc_rport, dev) 364 #define transport_class_to_rport(dev) \ 365 dev_to_rport(dev->parent) 366 #define rport_to_shost(r) \ 367 dev_to_shost(r->dev.parent) 368 369 /* 370 * FC SCSI Target Attributes 371 * 372 * The SCSI Target is considered an extension of a remote port (as 373 * a remote port can be more than a SCSI Target). Within the scsi 374 * subsystem, we leave the Target as a separate entity. Doing so 375 * provides backward compatibility with prior FC transport api's, 376 * and lets remote ports be handled entirely within the FC transport 377 * and independently from the scsi subsystem. The drawback is that 378 * some data will be duplicated. 379 */ 380 381 struct fc_starget_attrs { /* aka fc_target_attrs */ 382 /* Dynamic Attributes */ 383 u64 node_name; 384 u64 port_name; 385 u32 port_id; 386 }; 387 388 #define fc_starget_node_name(x) \ 389 (((struct fc_starget_attrs *)&(x)->starget_data)->node_name) 390 #define fc_starget_port_name(x) \ 391 (((struct fc_starget_attrs *)&(x)->starget_data)->port_name) 392 #define fc_starget_port_id(x) \ 393 (((struct fc_starget_attrs *)&(x)->starget_data)->port_id) 394 395 #define starget_to_rport(s) \ 396 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL 397 398 399 /* 400 * FC Local Port (Host) Statistics 401 */ 402 403 /* FC Statistics - Following FC HBAAPI v2.0 guidelines */ 404 struct fc_host_statistics { 405 /* port statistics */ 406 u64 seconds_since_last_reset; 407 u64 tx_frames; 408 u64 tx_words; 409 u64 rx_frames; 410 u64 rx_words; 411 u64 lip_count; 412 u64 nos_count; 413 u64 error_frames; 414 u64 dumped_frames; 415 u64 link_failure_count; 416 u64 loss_of_sync_count; 417 u64 loss_of_signal_count; 418 u64 prim_seq_protocol_err_count; 419 u64 invalid_tx_word_count; 420 u64 invalid_crc_count; 421 422 /* fc4 statistics (only FCP supported currently) */ 423 u64 fcp_input_requests; 424 u64 fcp_output_requests; 425 u64 fcp_control_requests; 426 u64 fcp_input_megabytes; 427 u64 fcp_output_megabytes; 428 u64 fcp_packet_alloc_failures; /* fcp packet allocation failures */ 429 u64 fcp_packet_aborts; /* fcp packet aborted */ 430 u64 fcp_frame_alloc_failures; /* fcp frame allocation failures */ 431 432 /* fc exches statistics */ 433 u64 fc_no_free_exch; /* no free exch memory */ 434 u64 fc_no_free_exch_xid; /* no free exch id */ 435 u64 fc_xid_not_found; /* exch not found for a response */ 436 u64 fc_xid_busy; /* exch exist for new a request */ 437 u64 fc_seq_not_found; /* seq is not found for exchange */ 438 u64 fc_non_bls_resp; /* a non BLS response frame with 439 a sequence responder in new exch */ 440 }; 441 442 443 /* 444 * FC Event Codes - Polled and Async, following FC HBAAPI v2.0 guidelines 445 */ 446 447 /* 448 * fc_host_event_code: If you alter this, you also need to alter 449 * scsi_transport_fc.c (for the ascii descriptions). 450 */ 451 enum fc_host_event_code { 452 FCH_EVT_LIP = 0x1, 453 FCH_EVT_LINKUP = 0x2, 454 FCH_EVT_LINKDOWN = 0x3, 455 FCH_EVT_LIPRESET = 0x4, 456 FCH_EVT_RSCN = 0x5, 457 FCH_EVT_ADAPTER_CHANGE = 0x103, 458 FCH_EVT_PORT_UNKNOWN = 0x200, 459 FCH_EVT_PORT_OFFLINE = 0x201, 460 FCH_EVT_PORT_ONLINE = 0x202, 461 FCH_EVT_PORT_FABRIC = 0x204, 462 FCH_EVT_LINK_UNKNOWN = 0x500, 463 FCH_EVT_LINK_FPIN = 0x501, 464 FCH_EVT_VENDOR_UNIQUE = 0xffff, 465 }; 466 467 468 /* 469 * FC Local Port (Host) Attributes 470 * 471 * Attributes are based on HBAAPI V2.0 definitions. 472 * Note: OSDeviceName is determined by user-space library 473 * 474 * Fixed attributes are not expected to change. The driver is 475 * expected to set these values after successfully calling scsi_add_host(). 476 * The transport fully manages all get functions w/o driver interaction. 477 * 478 * Dynamic attributes are expected to change. The driver participates 479 * in all get/set operations via functions provided by the driver. 480 * 481 * Private attributes are transport-managed values. They are fully 482 * managed by the transport w/o driver interaction. 483 */ 484 485 #define FC_FC4_LIST_SIZE 32 486 #define FC_SYMBOLIC_NAME_SIZE 256 487 #define FC_VERSION_STRING_SIZE 64 488 #define FC_SERIAL_NUMBER_SIZE 80 489 490 struct fc_host_attrs { 491 /* Fixed Attributes */ 492 u64 node_name; 493 u64 port_name; 494 u64 permanent_port_name; 495 u32 supported_classes; 496 u8 supported_fc4s[FC_FC4_LIST_SIZE]; 497 u32 supported_speeds; 498 u32 maxframe_size; 499 u16 max_npiv_vports; 500 char serial_number[FC_SERIAL_NUMBER_SIZE]; 501 char manufacturer[FC_SERIAL_NUMBER_SIZE]; 502 char model[FC_SYMBOLIC_NAME_SIZE]; 503 char model_description[FC_SYMBOLIC_NAME_SIZE]; 504 char hardware_version[FC_VERSION_STRING_SIZE]; 505 char driver_version[FC_VERSION_STRING_SIZE]; 506 char firmware_version[FC_VERSION_STRING_SIZE]; 507 char optionrom_version[FC_VERSION_STRING_SIZE]; 508 509 /* Dynamic Attributes */ 510 u32 port_id; 511 enum fc_port_type port_type; 512 enum fc_port_state port_state; 513 u8 active_fc4s[FC_FC4_LIST_SIZE]; 514 u32 speed; 515 u64 fabric_name; 516 char symbolic_name[FC_SYMBOLIC_NAME_SIZE]; 517 char system_hostname[FC_SYMBOLIC_NAME_SIZE]; 518 u32 dev_loss_tmo; 519 520 /* Private (Transport-managed) Attributes */ 521 enum fc_tgtid_binding_type tgtid_bind_type; 522 523 /* internal data */ 524 struct list_head rports; 525 struct list_head rport_bindings; 526 struct list_head vports; 527 u32 next_rport_number; 528 u32 next_target_id; 529 u32 next_vport_number; 530 u16 npiv_vports_inuse; 531 532 /* work queues for rport state manipulation */ 533 char work_q_name[20]; 534 struct workqueue_struct *work_q; 535 char devloss_work_q_name[20]; 536 struct workqueue_struct *devloss_work_q; 537 538 /* bsg support */ 539 struct request_queue *rqst_q; 540 }; 541 542 #define shost_to_fc_host(x) \ 543 ((struct fc_host_attrs *)(x)->shost_data) 544 545 #define fc_host_node_name(x) \ 546 (((struct fc_host_attrs *)(x)->shost_data)->node_name) 547 #define fc_host_port_name(x) \ 548 (((struct fc_host_attrs *)(x)->shost_data)->port_name) 549 #define fc_host_permanent_port_name(x) \ 550 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name) 551 #define fc_host_supported_classes(x) \ 552 (((struct fc_host_attrs *)(x)->shost_data)->supported_classes) 553 #define fc_host_supported_fc4s(x) \ 554 (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s) 555 #define fc_host_supported_speeds(x) \ 556 (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds) 557 #define fc_host_maxframe_size(x) \ 558 (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size) 559 #define fc_host_max_npiv_vports(x) \ 560 (((struct fc_host_attrs *)(x)->shost_data)->max_npiv_vports) 561 #define fc_host_serial_number(x) \ 562 (((struct fc_host_attrs *)(x)->shost_data)->serial_number) 563 #define fc_host_manufacturer(x) \ 564 (((struct fc_host_attrs *)(x)->shost_data)->manufacturer) 565 #define fc_host_model(x) \ 566 (((struct fc_host_attrs *)(x)->shost_data)->model) 567 #define fc_host_model_description(x) \ 568 (((struct fc_host_attrs *)(x)->shost_data)->model_description) 569 #define fc_host_hardware_version(x) \ 570 (((struct fc_host_attrs *)(x)->shost_data)->hardware_version) 571 #define fc_host_driver_version(x) \ 572 (((struct fc_host_attrs *)(x)->shost_data)->driver_version) 573 #define fc_host_firmware_version(x) \ 574 (((struct fc_host_attrs *)(x)->shost_data)->firmware_version) 575 #define fc_host_optionrom_version(x) \ 576 (((struct fc_host_attrs *)(x)->shost_data)->optionrom_version) 577 #define fc_host_port_id(x) \ 578 (((struct fc_host_attrs *)(x)->shost_data)->port_id) 579 #define fc_host_port_type(x) \ 580 (((struct fc_host_attrs *)(x)->shost_data)->port_type) 581 #define fc_host_port_state(x) \ 582 (((struct fc_host_attrs *)(x)->shost_data)->port_state) 583 #define fc_host_active_fc4s(x) \ 584 (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s) 585 #define fc_host_speed(x) \ 586 (((struct fc_host_attrs *)(x)->shost_data)->speed) 587 #define fc_host_fabric_name(x) \ 588 (((struct fc_host_attrs *)(x)->shost_data)->fabric_name) 589 #define fc_host_symbolic_name(x) \ 590 (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name) 591 #define fc_host_system_hostname(x) \ 592 (((struct fc_host_attrs *)(x)->shost_data)->system_hostname) 593 #define fc_host_tgtid_bind_type(x) \ 594 (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type) 595 #define fc_host_rports(x) \ 596 (((struct fc_host_attrs *)(x)->shost_data)->rports) 597 #define fc_host_rport_bindings(x) \ 598 (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings) 599 #define fc_host_vports(x) \ 600 (((struct fc_host_attrs *)(x)->shost_data)->vports) 601 #define fc_host_next_rport_number(x) \ 602 (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number) 603 #define fc_host_next_target_id(x) \ 604 (((struct fc_host_attrs *)(x)->shost_data)->next_target_id) 605 #define fc_host_next_vport_number(x) \ 606 (((struct fc_host_attrs *)(x)->shost_data)->next_vport_number) 607 #define fc_host_npiv_vports_inuse(x) \ 608 (((struct fc_host_attrs *)(x)->shost_data)->npiv_vports_inuse) 609 #define fc_host_work_q_name(x) \ 610 (((struct fc_host_attrs *)(x)->shost_data)->work_q_name) 611 #define fc_host_work_q(x) \ 612 (((struct fc_host_attrs *)(x)->shost_data)->work_q) 613 #define fc_host_devloss_work_q_name(x) \ 614 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name) 615 #define fc_host_devloss_work_q(x) \ 616 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q) 617 #define fc_host_dev_loss_tmo(x) \ 618 (((struct fc_host_attrs *)(x)->shost_data)->dev_loss_tmo) 619 620 /* The functions by which the transport class and the driver communicate */ 621 struct fc_function_template { 622 void (*get_rport_dev_loss_tmo)(struct fc_rport *); 623 void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32); 624 625 void (*get_starget_node_name)(struct scsi_target *); 626 void (*get_starget_port_name)(struct scsi_target *); 627 void (*get_starget_port_id)(struct scsi_target *); 628 629 void (*get_host_port_id)(struct Scsi_Host *); 630 void (*get_host_port_type)(struct Scsi_Host *); 631 void (*get_host_port_state)(struct Scsi_Host *); 632 void (*get_host_active_fc4s)(struct Scsi_Host *); 633 void (*get_host_speed)(struct Scsi_Host *); 634 void (*get_host_fabric_name)(struct Scsi_Host *); 635 void (*get_host_symbolic_name)(struct Scsi_Host *); 636 void (*set_host_system_hostname)(struct Scsi_Host *); 637 638 struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *); 639 void (*reset_fc_host_stats)(struct Scsi_Host *); 640 641 int (*issue_fc_host_lip)(struct Scsi_Host *); 642 643 void (*dev_loss_tmo_callbk)(struct fc_rport *); 644 void (*terminate_rport_io)(struct fc_rport *); 645 646 void (*set_vport_symbolic_name)(struct fc_vport *); 647 int (*vport_create)(struct fc_vport *, bool); 648 int (*vport_disable)(struct fc_vport *, bool); 649 int (*vport_delete)(struct fc_vport *); 650 651 /* bsg support */ 652 int (*bsg_request)(struct bsg_job *); 653 int (*bsg_timeout)(struct bsg_job *); 654 655 /* allocation lengths for host-specific data */ 656 u32 dd_fcrport_size; 657 u32 dd_fcvport_size; 658 u32 dd_bsg_size; 659 660 /* 661 * The driver sets these to tell the transport class it 662 * wants the attributes displayed in sysfs. If the show_ flag 663 * is not set, the attribute will be private to the transport 664 * class 665 */ 666 667 /* remote port fixed attributes */ 668 unsigned long show_rport_maxframe_size:1; 669 unsigned long show_rport_supported_classes:1; 670 unsigned long show_rport_dev_loss_tmo:1; 671 672 /* 673 * target dynamic attributes 674 * These should all be "1" if the driver uses the remote port 675 * add/delete functions (so attributes reflect rport values). 676 */ 677 unsigned long show_starget_node_name:1; 678 unsigned long show_starget_port_name:1; 679 unsigned long show_starget_port_id:1; 680 681 /* host fixed attributes */ 682 unsigned long show_host_node_name:1; 683 unsigned long show_host_port_name:1; 684 unsigned long show_host_permanent_port_name:1; 685 unsigned long show_host_supported_classes:1; 686 unsigned long show_host_supported_fc4s:1; 687 unsigned long show_host_supported_speeds:1; 688 unsigned long show_host_maxframe_size:1; 689 unsigned long show_host_serial_number:1; 690 unsigned long show_host_manufacturer:1; 691 unsigned long show_host_model:1; 692 unsigned long show_host_model_description:1; 693 unsigned long show_host_hardware_version:1; 694 unsigned long show_host_driver_version:1; 695 unsigned long show_host_firmware_version:1; 696 unsigned long show_host_optionrom_version:1; 697 /* host dynamic attributes */ 698 unsigned long show_host_port_id:1; 699 unsigned long show_host_port_type:1; 700 unsigned long show_host_port_state:1; 701 unsigned long show_host_active_fc4s:1; 702 unsigned long show_host_speed:1; 703 unsigned long show_host_fabric_name:1; 704 unsigned long show_host_symbolic_name:1; 705 unsigned long show_host_system_hostname:1; 706 707 unsigned long disable_target_scan:1; 708 }; 709 710 711 /** 712 * fc_remote_port_chkready - called to validate the remote port state 713 * prior to initiating io to the port. 714 * 715 * Returns a scsi result code that can be returned by the LLDD. 716 * 717 * @rport: remote port to be checked 718 **/ 719 static inline int 720 fc_remote_port_chkready(struct fc_rport *rport) 721 { 722 int result; 723 724 switch (rport->port_state) { 725 case FC_PORTSTATE_ONLINE: 726 if (rport->roles & FC_PORT_ROLE_FCP_TARGET) 727 result = 0; 728 else if (rport->flags & FC_RPORT_DEVLOSS_PENDING) 729 result = DID_IMM_RETRY << 16; 730 else 731 result = DID_NO_CONNECT << 16; 732 break; 733 case FC_PORTSTATE_BLOCKED: 734 if (rport->flags & FC_RPORT_FAST_FAIL_TIMEDOUT) 735 result = DID_TRANSPORT_FAILFAST << 16; 736 else 737 result = DID_IMM_RETRY << 16; 738 break; 739 default: 740 result = DID_NO_CONNECT << 16; 741 break; 742 } 743 return result; 744 } 745 746 static inline u64 wwn_to_u64(const u8 *wwn) 747 { 748 return get_unaligned_be64(wwn); 749 } 750 751 static inline void u64_to_wwn(u64 inm, u8 *wwn) 752 { 753 put_unaligned_be64(inm, wwn); 754 } 755 756 /** 757 * fc_vport_set_state() - called to set a vport's state. Saves the old state, 758 * excepting the transitory states of initializing and sending the ELS 759 * traffic to instantiate the vport on the link. 760 * 761 * Assumes the driver has surrounded this with the proper locking to ensure 762 * a coherent state change. 763 * 764 * @vport: virtual port whose state is changing 765 * @new_state: new state 766 **/ 767 static inline void 768 fc_vport_set_state(struct fc_vport *vport, enum fc_vport_state new_state) 769 { 770 if ((new_state != FC_VPORT_UNKNOWN) && 771 (new_state != FC_VPORT_INITIALIZING)) 772 vport->vport_last_state = vport->vport_state; 773 vport->vport_state = new_state; 774 } 775 776 struct scsi_transport_template *fc_attach_transport( 777 struct fc_function_template *); 778 void fc_release_transport(struct scsi_transport_template *); 779 void fc_remove_host(struct Scsi_Host *); 780 struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost, 781 int channel, struct fc_rport_identifiers *ids); 782 void fc_remote_port_delete(struct fc_rport *rport); 783 void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles); 784 int scsi_is_fc_rport(const struct device *); 785 u32 fc_get_event_number(void); 786 void fc_host_post_event(struct Scsi_Host *shost, u32 event_number, 787 enum fc_host_event_code event_code, u32 event_data); 788 void fc_host_post_vendor_event(struct Scsi_Host *shost, u32 event_number, 789 u32 data_len, char *data_buf, u64 vendor_id); 790 void fc_host_post_fc_event(struct Scsi_Host *shost, u32 event_number, 791 enum fc_host_event_code event_code, 792 u32 data_len, char *data_buf, u64 vendor_id); 793 /* Note: when specifying vendor_id to fc_host_post_vendor_event() 794 * or fc_host_post_fc_event(), be sure to read the Vendor Type 795 * and ID formatting requirements specified in scsi_netlink.h 796 * Note: when calling fc_host_post_fc_event(), vendor_id may be 797 * specified as 0. 798 */ 799 void fc_host_fpin_rcv(struct Scsi_Host *shost, u32 fpin_len, char *fpin_buf); 800 struct fc_vport *fc_vport_create(struct Scsi_Host *shost, int channel, 801 struct fc_vport_identifiers *); 802 int fc_vport_terminate(struct fc_vport *vport); 803 int fc_block_rport(struct fc_rport *rport); 804 int fc_block_scsi_eh(struct scsi_cmnd *cmnd); 805 enum blk_eh_timer_return fc_eh_timed_out(struct scsi_cmnd *scmd); 806 807 static inline struct Scsi_Host *fc_bsg_to_shost(struct bsg_job *job) 808 { 809 if (scsi_is_host_device(job->dev)) 810 return dev_to_shost(job->dev); 811 return rport_to_shost(dev_to_rport(job->dev)); 812 } 813 814 static inline struct fc_rport *fc_bsg_to_rport(struct bsg_job *job) 815 { 816 if (scsi_is_fc_rport(job->dev)) 817 return dev_to_rport(job->dev); 818 return NULL; 819 } 820 821 #endif /* SCSI_TRANSPORT_FC_H */ 822