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-2005 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/config.h> 31 #include <linux/sched.h> 32 #include <scsi/scsi.h> 33 34 struct scsi_transport_template; 35 36 37 /* 38 * FC Port definitions - Following FC HBAAPI guidelines 39 * 40 * Note: Not all binary values for the different fields match HBAAPI. 41 * Instead, we use densely packed ordinal values or enums. 42 * We get away with this as we never present the actual binary values 43 * externally. For sysfs, we always present the string that describes 44 * the value. Thus, an admin doesn't need a magic HBAAPI decoder ring 45 * to understand the values. The HBAAPI user-space library is free to 46 * convert the strings into the HBAAPI-specified binary values. 47 * 48 * Note: Not all HBAAPI-defined values are contained in the definitions 49 * below. Those not appropriate to an fc_host (e.g. FCP initiator) have 50 * been removed. 51 */ 52 53 /* 54 * fc_port_type: If you alter this, you also need to alter scsi_transport_fc.c 55 * (for the ascii descriptions). 56 */ 57 enum fc_port_type { 58 FC_PORTTYPE_UNKNOWN, 59 FC_PORTTYPE_OTHER, 60 FC_PORTTYPE_NOTPRESENT, 61 FC_PORTTYPE_NPORT, /* Attached to FPort */ 62 FC_PORTTYPE_NLPORT, /* (Public) Loop w/ FLPort */ 63 FC_PORTTYPE_LPORT, /* (Private) Loop w/o FLPort */ 64 FC_PORTTYPE_PTP, /* Point to Point w/ another NPort */ 65 }; 66 67 /* 68 * fc_port_state: If you alter this, you also need to alter scsi_transport_fc.c 69 * (for the ascii descriptions). 70 */ 71 enum fc_port_state { 72 FC_PORTSTATE_UNKNOWN, 73 FC_PORTSTATE_NOTPRESENT, 74 FC_PORTSTATE_ONLINE, 75 FC_PORTSTATE_OFFLINE, /* User has taken Port Offline */ 76 FC_PORTSTATE_BLOCKED, 77 FC_PORTSTATE_BYPASSED, 78 FC_PORTSTATE_DIAGNOSTICS, 79 FC_PORTSTATE_LINKDOWN, 80 FC_PORTSTATE_ERROR, 81 FC_PORTSTATE_LOOPBACK, 82 FC_PORTSTATE_DELETED, 83 }; 84 85 86 /* 87 * FC Classes of Service 88 * Note: values are not enumerated, as they can be "or'd" together 89 * for reporting (e.g. report supported_classes). If you alter this list, 90 * you also need to alter scsi_transport_fc.c (for the ascii descriptions). 91 */ 92 #define FC_COS_UNSPECIFIED 0 93 #define FC_COS_CLASS1 2 94 #define FC_COS_CLASS2 4 95 #define FC_COS_CLASS3 8 96 #define FC_COS_CLASS4 0x10 97 #define FC_COS_CLASS6 0x40 98 99 /* 100 * FC Port Speeds 101 * Note: values are not enumerated, as they can be "or'd" together 102 * for reporting (e.g. report supported_speeds). If you alter this list, 103 * you also need to alter scsi_transport_fc.c (for the ascii descriptions). 104 */ 105 #define FC_PORTSPEED_UNKNOWN 0 /* Unknown - transceiver 106 incapable of reporting */ 107 #define FC_PORTSPEED_1GBIT 1 108 #define FC_PORTSPEED_2GBIT 2 109 #define FC_PORTSPEED_4GBIT 4 110 #define FC_PORTSPEED_10GBIT 8 111 #define FC_PORTSPEED_NOT_NEGOTIATED (1 << 15) /* Speed not established */ 112 113 /* 114 * fc_tgtid_binding_type: If you alter this, you also need to alter 115 * scsi_transport_fc.c (for the ascii descriptions). 116 */ 117 enum fc_tgtid_binding_type { 118 FC_TGTID_BIND_NONE, 119 FC_TGTID_BIND_BY_WWPN, 120 FC_TGTID_BIND_BY_WWNN, 121 FC_TGTID_BIND_BY_ID, 122 }; 123 124 /* 125 * FC Remote Port Roles 126 * Note: values are not enumerated, as they can be "or'd" together 127 * for reporting (e.g. report roles). If you alter this list, 128 * you also need to alter scsi_transport_fc.c (for the ascii descriptions). 129 */ 130 #define FC_RPORT_ROLE_UNKNOWN 0x00 131 #define FC_RPORT_ROLE_FCP_TARGET 0x01 132 #define FC_RPORT_ROLE_FCP_INITIATOR 0x02 133 #define FC_RPORT_ROLE_IP_PORT 0x04 134 135 136 /* 137 * fc_rport_identifiers: This set of data contains all elements 138 * to uniquely identify a remote FC port. The driver uses this data 139 * to report the existence of a remote FC port in the topology. Internally, 140 * the transport uses this data for attributes and to manage consistent 141 * target id bindings. 142 */ 143 struct fc_rport_identifiers { 144 u64 node_name; 145 u64 port_name; 146 u32 port_id; 147 u32 roles; 148 }; 149 150 /* Macro for use in defining Remote Port attributes */ 151 #define FC_RPORT_ATTR(_name,_mode,_show,_store) \ 152 struct class_device_attribute class_device_attr_rport_##_name = \ 153 __ATTR(_name,_mode,_show,_store) 154 155 156 /* 157 * FC Remote Port Attributes 158 * 159 * This structure exists for each remote FC port that a LLDD notifies 160 * the subsystem of. A remote FC port may or may not be a SCSI Target, 161 * also be a SCSI initiator, IP endpoint, etc. As such, the remote 162 * port is considered a separate entity, independent of "role" (such 163 * as scsi target). 164 * 165 * -- 166 * 167 * Attributes are based on HBAAPI V2.0 definitions. Only those 168 * attributes that are determinable by the local port (aka Host) 169 * are contained. 170 * 171 * Fixed attributes are not expected to change. The driver is 172 * expected to set these values after successfully calling 173 * fc_remote_port_add(). The transport fully manages all get functions 174 * w/o driver interaction. 175 * 176 * Dynamic attributes are expected to change. The driver participates 177 * in all get/set operations via functions provided by the driver. 178 * 179 * Private attributes are transport-managed values. They are fully 180 * managed by the transport w/o driver interaction. 181 */ 182 183 struct fc_rport { /* aka fc_starget_attrs */ 184 /* Fixed Attributes */ 185 u32 maxframe_size; 186 u32 supported_classes; 187 188 /* Dynamic Attributes */ 189 u32 dev_loss_tmo; /* Remote Port loss timeout in seconds. */ 190 191 /* Private (Transport-managed) Attributes */ 192 u64 node_name; 193 u64 port_name; 194 u32 port_id; 195 u32 roles; 196 enum fc_port_state port_state; /* Will only be ONLINE or UNKNOWN */ 197 u32 scsi_target_id; 198 199 /* exported data */ 200 void *dd_data; /* Used for driver-specific storage */ 201 202 /* internal data */ 203 unsigned int channel; 204 u32 number; 205 u8 flags; 206 struct list_head peers; 207 struct device dev; 208 struct work_struct dev_loss_work; 209 struct work_struct scan_work; 210 struct work_struct stgt_delete_work; 211 struct work_struct rport_delete_work; 212 } __attribute__((aligned(sizeof(unsigned long)))); 213 214 /* bit field values for struct fc_rport "flags" field: */ 215 #define FC_RPORT_DEVLOSS_PENDING 0x01 216 #define FC_RPORT_SCAN_PENDING 0x02 217 218 #define dev_to_rport(d) \ 219 container_of(d, struct fc_rport, dev) 220 #define transport_class_to_rport(classdev) \ 221 dev_to_rport(classdev->dev) 222 #define rport_to_shost(r) \ 223 dev_to_shost(r->dev.parent) 224 225 /* 226 * FC SCSI Target Attributes 227 * 228 * The SCSI Target is considered an extention of a remote port (as 229 * a remote port can be more than a SCSI Target). Within the scsi 230 * subsystem, we leave the Target as a separate entity. Doing so 231 * provides backward compatibility with prior FC transport api's, 232 * and lets remote ports be handled entirely within the FC transport 233 * and independently from the scsi subsystem. The drawback is that 234 * some data will be duplicated. 235 */ 236 237 struct fc_starget_attrs { /* aka fc_target_attrs */ 238 /* Dynamic Attributes */ 239 u64 node_name; 240 u64 port_name; 241 u32 port_id; 242 }; 243 244 #define fc_starget_node_name(x) \ 245 (((struct fc_starget_attrs *)&(x)->starget_data)->node_name) 246 #define fc_starget_port_name(x) \ 247 (((struct fc_starget_attrs *)&(x)->starget_data)->port_name) 248 #define fc_starget_port_id(x) \ 249 (((struct fc_starget_attrs *)&(x)->starget_data)->port_id) 250 251 #define starget_to_rport(s) \ 252 scsi_is_fc_rport(s->dev.parent) ? dev_to_rport(s->dev.parent) : NULL 253 254 255 /* 256 * FC Local Port (Host) Statistics 257 */ 258 259 /* FC Statistics - Following FC HBAAPI v2.0 guidelines */ 260 struct fc_host_statistics { 261 /* port statistics */ 262 u64 seconds_since_last_reset; 263 u64 tx_frames; 264 u64 tx_words; 265 u64 rx_frames; 266 u64 rx_words; 267 u64 lip_count; 268 u64 nos_count; 269 u64 error_frames; 270 u64 dumped_frames; 271 u64 link_failure_count; 272 u64 loss_of_sync_count; 273 u64 loss_of_signal_count; 274 u64 prim_seq_protocol_err_count; 275 u64 invalid_tx_word_count; 276 u64 invalid_crc_count; 277 278 /* fc4 statistics (only FCP supported currently) */ 279 u64 fcp_input_requests; 280 u64 fcp_output_requests; 281 u64 fcp_control_requests; 282 u64 fcp_input_megabytes; 283 u64 fcp_output_megabytes; 284 }; 285 286 287 /* 288 * FC Local Port (Host) Attributes 289 * 290 * Attributes are based on HBAAPI V2.0 definitions. 291 * Note: OSDeviceName is determined by user-space library 292 * 293 * Fixed attributes are not expected to change. The driver is 294 * expected to set these values after successfully calling scsi_add_host(). 295 * The transport fully manages all get functions w/o driver interaction. 296 * 297 * Dynamic attributes are expected to change. The driver participates 298 * in all get/set operations via functions provided by the driver. 299 * 300 * Private attributes are transport-managed values. They are fully 301 * managed by the transport w/o driver interaction. 302 */ 303 304 #define FC_FC4_LIST_SIZE 32 305 #define FC_SYMBOLIC_NAME_SIZE 256 306 #define FC_VERSION_STRING_SIZE 64 307 #define FC_SERIAL_NUMBER_SIZE 80 308 309 struct fc_host_attrs { 310 /* Fixed Attributes */ 311 u64 node_name; 312 u64 port_name; 313 u64 permanent_port_name; 314 u32 supported_classes; 315 u8 supported_fc4s[FC_FC4_LIST_SIZE]; 316 char symbolic_name[FC_SYMBOLIC_NAME_SIZE]; 317 u32 supported_speeds; 318 u32 maxframe_size; 319 char serial_number[FC_SERIAL_NUMBER_SIZE]; 320 321 /* Dynamic Attributes */ 322 u32 port_id; 323 enum fc_port_type port_type; 324 enum fc_port_state port_state; 325 u8 active_fc4s[FC_FC4_LIST_SIZE]; 326 u32 speed; 327 u64 fabric_name; 328 329 /* Private (Transport-managed) Attributes */ 330 enum fc_tgtid_binding_type tgtid_bind_type; 331 332 /* internal data */ 333 struct list_head rports; 334 struct list_head rport_bindings; 335 u32 next_rport_number; 336 u32 next_target_id; 337 338 /* work queues for rport state manipulation */ 339 char work_q_name[KOBJ_NAME_LEN]; 340 struct workqueue_struct *work_q; 341 char devloss_work_q_name[KOBJ_NAME_LEN]; 342 struct workqueue_struct *devloss_work_q; 343 }; 344 345 #define shost_to_fc_host(x) \ 346 ((struct fc_host_attrs *)(x)->shost_data) 347 348 #define fc_host_node_name(x) \ 349 (((struct fc_host_attrs *)(x)->shost_data)->node_name) 350 #define fc_host_port_name(x) \ 351 (((struct fc_host_attrs *)(x)->shost_data)->port_name) 352 #define fc_host_permanent_port_name(x) \ 353 (((struct fc_host_attrs *)(x)->shost_data)->permanent_port_name) 354 #define fc_host_supported_classes(x) \ 355 (((struct fc_host_attrs *)(x)->shost_data)->supported_classes) 356 #define fc_host_supported_fc4s(x) \ 357 (((struct fc_host_attrs *)(x)->shost_data)->supported_fc4s) 358 #define fc_host_symbolic_name(x) \ 359 (((struct fc_host_attrs *)(x)->shost_data)->symbolic_name) 360 #define fc_host_supported_speeds(x) \ 361 (((struct fc_host_attrs *)(x)->shost_data)->supported_speeds) 362 #define fc_host_maxframe_size(x) \ 363 (((struct fc_host_attrs *)(x)->shost_data)->maxframe_size) 364 #define fc_host_serial_number(x) \ 365 (((struct fc_host_attrs *)(x)->shost_data)->serial_number) 366 #define fc_host_port_id(x) \ 367 (((struct fc_host_attrs *)(x)->shost_data)->port_id) 368 #define fc_host_port_type(x) \ 369 (((struct fc_host_attrs *)(x)->shost_data)->port_type) 370 #define fc_host_port_state(x) \ 371 (((struct fc_host_attrs *)(x)->shost_data)->port_state) 372 #define fc_host_active_fc4s(x) \ 373 (((struct fc_host_attrs *)(x)->shost_data)->active_fc4s) 374 #define fc_host_speed(x) \ 375 (((struct fc_host_attrs *)(x)->shost_data)->speed) 376 #define fc_host_fabric_name(x) \ 377 (((struct fc_host_attrs *)(x)->shost_data)->fabric_name) 378 #define fc_host_tgtid_bind_type(x) \ 379 (((struct fc_host_attrs *)(x)->shost_data)->tgtid_bind_type) 380 #define fc_host_rports(x) \ 381 (((struct fc_host_attrs *)(x)->shost_data)->rports) 382 #define fc_host_rport_bindings(x) \ 383 (((struct fc_host_attrs *)(x)->shost_data)->rport_bindings) 384 #define fc_host_next_rport_number(x) \ 385 (((struct fc_host_attrs *)(x)->shost_data)->next_rport_number) 386 #define fc_host_next_target_id(x) \ 387 (((struct fc_host_attrs *)(x)->shost_data)->next_target_id) 388 #define fc_host_work_q_name(x) \ 389 (((struct fc_host_attrs *)(x)->shost_data)->work_q_name) 390 #define fc_host_work_q(x) \ 391 (((struct fc_host_attrs *)(x)->shost_data)->work_q) 392 #define fc_host_devloss_work_q_name(x) \ 393 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q_name) 394 #define fc_host_devloss_work_q(x) \ 395 (((struct fc_host_attrs *)(x)->shost_data)->devloss_work_q) 396 397 398 /* The functions by which the transport class and the driver communicate */ 399 struct fc_function_template { 400 void (*get_rport_dev_loss_tmo)(struct fc_rport *); 401 void (*set_rport_dev_loss_tmo)(struct fc_rport *, u32); 402 403 void (*get_starget_node_name)(struct scsi_target *); 404 void (*get_starget_port_name)(struct scsi_target *); 405 void (*get_starget_port_id)(struct scsi_target *); 406 407 void (*get_host_port_id)(struct Scsi_Host *); 408 void (*get_host_port_type)(struct Scsi_Host *); 409 void (*get_host_port_state)(struct Scsi_Host *); 410 void (*get_host_active_fc4s)(struct Scsi_Host *); 411 void (*get_host_speed)(struct Scsi_Host *); 412 void (*get_host_fabric_name)(struct Scsi_Host *); 413 414 struct fc_host_statistics * (*get_fc_host_stats)(struct Scsi_Host *); 415 void (*reset_fc_host_stats)(struct Scsi_Host *); 416 417 int (*issue_fc_host_lip)(struct Scsi_Host *); 418 419 /* allocation lengths for host-specific data */ 420 u32 dd_fcrport_size; 421 422 /* 423 * The driver sets these to tell the transport class it 424 * wants the attributes displayed in sysfs. If the show_ flag 425 * is not set, the attribute will be private to the transport 426 * class 427 */ 428 429 /* remote port fixed attributes */ 430 unsigned long show_rport_maxframe_size:1; 431 unsigned long show_rport_supported_classes:1; 432 unsigned long show_rport_dev_loss_tmo:1; 433 434 /* 435 * target dynamic attributes 436 * These should all be "1" if the driver uses the remote port 437 * add/delete functions (so attributes reflect rport values). 438 */ 439 unsigned long show_starget_node_name:1; 440 unsigned long show_starget_port_name:1; 441 unsigned long show_starget_port_id:1; 442 443 /* host fixed attributes */ 444 unsigned long show_host_node_name:1; 445 unsigned long show_host_port_name:1; 446 unsigned long show_host_permanent_port_name:1; 447 unsigned long show_host_supported_classes:1; 448 unsigned long show_host_supported_fc4s:1; 449 unsigned long show_host_symbolic_name:1; 450 unsigned long show_host_supported_speeds:1; 451 unsigned long show_host_maxframe_size:1; 452 unsigned long show_host_serial_number:1; 453 /* host dynamic attributes */ 454 unsigned long show_host_port_id:1; 455 unsigned long show_host_port_type:1; 456 unsigned long show_host_port_state:1; 457 unsigned long show_host_active_fc4s:1; 458 unsigned long show_host_speed:1; 459 unsigned long show_host_fabric_name:1; 460 }; 461 462 463 /** 464 * fc_remote_port_chkready - called to validate the remote port state 465 * prior to initiating io to the port. 466 * 467 * Returns a scsi result code that can be returned by the LLDD. 468 * 469 * @rport: remote port to be checked 470 **/ 471 static inline int 472 fc_remote_port_chkready(struct fc_rport *rport) 473 { 474 int result; 475 476 switch (rport->port_state) { 477 case FC_PORTSTATE_ONLINE: 478 if (rport->roles & FC_RPORT_ROLE_FCP_TARGET) 479 result = 0; 480 else if (rport->flags & FC_RPORT_DEVLOSS_PENDING) 481 result = DID_IMM_RETRY << 16; 482 else 483 result = DID_NO_CONNECT << 16; 484 break; 485 case FC_PORTSTATE_BLOCKED: 486 result = DID_IMM_RETRY << 16; 487 break; 488 default: 489 result = DID_NO_CONNECT << 16; 490 break; 491 } 492 return result; 493 } 494 495 496 struct scsi_transport_template *fc_attach_transport( 497 struct fc_function_template *); 498 void fc_release_transport(struct scsi_transport_template *); 499 void fc_remove_host(struct Scsi_Host *); 500 struct fc_rport *fc_remote_port_add(struct Scsi_Host *shost, 501 int channel, struct fc_rport_identifiers *ids); 502 void fc_remote_port_delete(struct fc_rport *rport); 503 void fc_remote_port_rolechg(struct fc_rport *rport, u32 roles); 504 int scsi_is_fc_rport(const struct device *); 505 506 static inline u64 wwn_to_u64(u8 *wwn) 507 { 508 return (u64)wwn[0] << 56 | (u64)wwn[1] << 48 | 509 (u64)wwn[2] << 40 | (u64)wwn[3] << 32 | 510 (u64)wwn[4] << 24 | (u64)wwn[5] << 16 | 511 (u64)wwn[6] << 8 | (u64)wwn[7]; 512 } 513 514 #endif /* SCSI_TRANSPORT_FC_H */ 515