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