2 * FiberChannel transport specific attributes exported to sysfs.
4 * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
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.
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.
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
22 * Copyright (C) 2004-2005 James Smart, Emulex Corporation
23 * Rewrite for host, target, device, and remote port attributes,
24 * statistics, and service functions...
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_host.h>
31 #include <scsi/scsi_transport.h>
32 #include <scsi/scsi_transport_fc.h>
33 #include "scsi_priv.h"
35 #define FC_PRINTK(x, l, f, a...) printk(l "scsi(%d:%d:%d:%d): " f, (x)->host->host_no, (x)->channel, (x)->id, (x)->lun , ##a)
38 * Redefine so that we can have same named attributes in the
39 * sdev/starget/host objects.
41 #define FC_CLASS_DEVICE_ATTR(_prefix,_name,_mode,_show,_store) \
42 struct class_device_attribute class_device_attr_##_prefix##_##_name = \
43 __ATTR(_name,_mode,_show,_store)
45 #define fc_enum_name_search(title, table_type, table) \
46 static const char *get_fc_##title##_name(enum table_type table_key) \
51 for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) { \
52 if (table[i].value == table_key) { \
53 name = table[i].name; \
60 #define fc_enum_name_match(title, table_type, table) \
61 static int get_fc_##title##_match(const char *table_key, \
62 enum table_type *value) \
66 for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) { \
67 if (strncmp(table_key, table[i].name, \
68 table[i].matchlen) == 0) { \
69 *value = table[i].value; \
70 return 0; /* success */ \
73 return 1; /* failure */ \
77 /* Convert fc_port_type values to ascii string name */
79 enum fc_port_type value;
81 } fc_port_type_names[] = {
82 { FC_PORTTYPE_UNKNOWN, "Unknown" },
83 { FC_PORTTYPE_OTHER, "Other" },
84 { FC_PORTTYPE_NOTPRESENT, "Not Present" },
85 { FC_PORTTYPE_NPORT, "NPort (fabric via point-to-point)" },
86 { FC_PORTTYPE_NLPORT, "NLPort (fabric via loop)" },
87 { FC_PORTTYPE_LPORT, "LPort (private loop)" },
88 { FC_PORTTYPE_PTP, "Point-To-Point (direct nport connection" },
90 fc_enum_name_search(port_type, fc_port_type, fc_port_type_names)
91 #define FC_PORTTYPE_MAX_NAMELEN 50
94 /* Convert fc_port_state values to ascii string name */
96 enum fc_port_state value;
98 } fc_port_state_names[] = {
99 { FC_PORTSTATE_UNKNOWN, "Unknown" },
100 { FC_PORTSTATE_NOTPRESENT, "Not Present" },
101 { FC_PORTSTATE_ONLINE, "Online" },
102 { FC_PORTSTATE_OFFLINE, "Offline" },
103 { FC_PORTSTATE_BLOCKED, "Blocked" },
104 { FC_PORTSTATE_BYPASSED, "Bypassed" },
105 { FC_PORTSTATE_DIAGNOSTICS, "Diagnostics" },
106 { FC_PORTSTATE_LINKDOWN, "Linkdown" },
107 { FC_PORTSTATE_ERROR, "Error" },
108 { FC_PORTSTATE_LOOPBACK, "Loopback" },
110 fc_enum_name_search(port_state, fc_port_state, fc_port_state_names)
111 #define FC_PORTSTATE_MAX_NAMELEN 20
114 /* Convert fc_tgtid_binding_type values to ascii string name */
116 enum fc_tgtid_binding_type value;
119 } fc_tgtid_binding_type_names[] = {
120 { FC_TGTID_BIND_NONE, "none", 4 },
121 { FC_TGTID_BIND_BY_WWPN, "wwpn (World Wide Port Name)", 4 },
122 { FC_TGTID_BIND_BY_WWNN, "wwnn (World Wide Node Name)", 4 },
123 { FC_TGTID_BIND_BY_ID, "port_id (FC Address)", 7 },
125 fc_enum_name_search(tgtid_bind_type, fc_tgtid_binding_type,
126 fc_tgtid_binding_type_names)
127 fc_enum_name_match(tgtid_bind_type, fc_tgtid_binding_type,
128 fc_tgtid_binding_type_names)
129 #define FC_BINDTYPE_MAX_NAMELEN 30
132 #define fc_bitfield_name_search(title, table) \
134 get_fc_##title##_names(u32 table_key, char *buf) \
140 for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) { \
141 if (table[i].value & table_key) { \
142 len += sprintf(buf + len, "%s%s", \
143 prefix, table[i].name); \
147 len += sprintf(buf + len, "\n"); \
152 /* Convert FC_COS bit values to ascii string name */
157 { FC_COS_CLASS1, "Class 1" },
158 { FC_COS_CLASS2, "Class 2" },
159 { FC_COS_CLASS3, "Class 3" },
160 { FC_COS_CLASS4, "Class 4" },
161 { FC_COS_CLASS6, "Class 6" },
163 fc_bitfield_name_search(cos, fc_cos_names)
166 /* Convert FC_PORTSPEED bit values to ascii string name */
170 } fc_port_speed_names[] = {
171 { FC_PORTSPEED_1GBIT, "1 Gbit" },
172 { FC_PORTSPEED_2GBIT, "2 Gbit" },
173 { FC_PORTSPEED_4GBIT, "4 Gbit" },
174 { FC_PORTSPEED_10GBIT, "10 Gbit" },
175 { FC_PORTSPEED_NOT_NEGOTIATED, "Not Negotiated" },
177 fc_bitfield_name_search(port_speed, fc_port_speed_names)
181 show_fc_fc4s (char *buf, u8 *fc4_list)
185 for (i = 0; i < FC_FC4_LIST_SIZE; i++, fc4_list++)
186 len += sprintf(buf + len , "0x%02x ", *fc4_list);
187 len += sprintf(buf + len, "\n");
192 /* Convert FC_RPORT_ROLE bit values to ascii string name */
196 } fc_remote_port_role_names[] = {
197 { FC_RPORT_ROLE_FCP_TARGET, "FCP Target" },
198 { FC_RPORT_ROLE_FCP_INITIATOR, "FCP Initiator" },
199 { FC_RPORT_ROLE_IP_PORT, "IP Port" },
201 fc_bitfield_name_search(remote_port_roles, fc_remote_port_role_names)
204 * Define roles that are specific to port_id. Values are relative to ROLE_MASK.
206 #define FC_WELLKNOWN_PORTID_MASK 0xfffff0
207 #define FC_WELLKNOWN_ROLE_MASK 0x00000f
208 #define FC_FPORT_PORTID 0x00000e
209 #define FC_FABCTLR_PORTID 0x00000d
210 #define FC_DIRSRVR_PORTID 0x00000c
211 #define FC_TIMESRVR_PORTID 0x00000b
212 #define FC_MGMTSRVR_PORTID 0x00000a
215 static void fc_timeout_blocked_rport(void *data);
216 static void fc_scsi_scan_rport(void *data);
217 static void fc_rport_terminate(struct fc_rport *rport);
220 * Attribute counts pre object type...
221 * Increase these values if you add attributes
223 #define FC_STARGET_NUM_ATTRS 3
224 #define FC_RPORT_NUM_ATTRS 9
225 #define FC_HOST_NUM_ATTRS 15
228 struct scsi_transport_template t;
229 struct fc_function_template *f;
232 * For attributes : each object has :
233 * An array of the actual attributes structures
234 * An array of null-terminated pointers to the attribute
235 * structures - used for mid-layer interaction.
237 * The attribute containers for the starget and host are are
238 * part of the midlayer. As the remote port is specific to the
239 * fc transport, we must provide the attribute container.
241 struct class_device_attribute private_starget_attrs[
242 FC_STARGET_NUM_ATTRS];
243 struct class_device_attribute *starget_attrs[FC_STARGET_NUM_ATTRS + 1];
245 struct class_device_attribute private_host_attrs[FC_HOST_NUM_ATTRS];
246 struct class_device_attribute *host_attrs[FC_HOST_NUM_ATTRS + 1];
248 struct transport_container rport_attr_cont;
249 struct class_device_attribute private_rport_attrs[FC_RPORT_NUM_ATTRS];
250 struct class_device_attribute *rport_attrs[FC_RPORT_NUM_ATTRS + 1];
253 #define to_fc_internal(tmpl) container_of(tmpl, struct fc_internal, t)
255 static int fc_target_setup(struct device *dev)
257 struct scsi_target *starget = to_scsi_target(dev);
258 struct fc_rport *rport = starget_to_rport(starget);
261 * if parent is remote port, use values from remote port.
262 * Otherwise, this host uses the fc_transport, but not the
263 * remote port interface. As such, initialize to known non-values.
266 fc_starget_node_name(starget) = rport->node_name;
267 fc_starget_port_name(starget) = rport->port_name;
268 fc_starget_port_id(starget) = rport->port_id;
270 fc_starget_node_name(starget) = -1;
271 fc_starget_port_name(starget) = -1;
272 fc_starget_port_id(starget) = -1;
278 static DECLARE_TRANSPORT_CLASS(fc_transport_class,
284 static int fc_host_setup(struct device *dev)
286 struct Scsi_Host *shost = dev_to_shost(dev);
289 * Set default values easily detected by the midlayer as
290 * failure cases. The scsi lldd is responsible for initializing
291 * all transport attributes to valid values per host.
293 fc_host_node_name(shost) = -1;
294 fc_host_port_name(shost) = -1;
295 fc_host_supported_classes(shost) = FC_COS_UNSPECIFIED;
296 memset(fc_host_supported_fc4s(shost), 0,
297 sizeof(fc_host_supported_fc4s(shost)));
298 memset(fc_host_symbolic_name(shost), 0,
299 sizeof(fc_host_symbolic_name(shost)));
300 fc_host_supported_speeds(shost) = FC_PORTSPEED_UNKNOWN;
301 fc_host_maxframe_size(shost) = -1;
302 memset(fc_host_serial_number(shost), 0,
303 sizeof(fc_host_serial_number(shost)));
305 fc_host_port_id(shost) = -1;
306 fc_host_port_type(shost) = FC_PORTTYPE_UNKNOWN;
307 fc_host_port_state(shost) = FC_PORTSTATE_UNKNOWN;
308 memset(fc_host_active_fc4s(shost), 0,
309 sizeof(fc_host_active_fc4s(shost)));
310 fc_host_speed(shost) = FC_PORTSPEED_UNKNOWN;
311 fc_host_fabric_name(shost) = -1;
313 fc_host_tgtid_bind_type(shost) = FC_TGTID_BIND_BY_WWPN;
315 INIT_LIST_HEAD(&fc_host_rports(shost));
316 INIT_LIST_HEAD(&fc_host_rport_bindings(shost));
317 fc_host_next_rport_number(shost) = 0;
318 fc_host_next_target_id(shost) = 0;
323 static DECLARE_TRANSPORT_CLASS(fc_host_class,
330 * Setup and Remove actions for remote ports are handled
331 * in the service functions below.
333 static DECLARE_TRANSPORT_CLASS(fc_rport_class,
344 * dev_loss_tmo: the default number of seconds that the FC transport
345 * should insulate the loss of a remote port.
346 * The maximum will be capped by the value of SCSI_DEVICE_BLOCK_MAX_TIMEOUT.
348 static unsigned int fc_dev_loss_tmo = SCSI_DEVICE_BLOCK_MAX_TIMEOUT;
350 module_param_named(dev_loss_tmo, fc_dev_loss_tmo, int, S_IRUGO|S_IWUSR);
351 MODULE_PARM_DESC(dev_loss_tmo,
352 "Maximum number of seconds that the FC transport should"
353 " insulate the loss of a remote port. Once this value is"
354 " exceeded, the scsi target is removed. Value should be"
355 " between 1 and SCSI_DEVICE_BLOCK_MAX_TIMEOUT.");
358 static __init int fc_transport_init(void)
360 int error = transport_class_register(&fc_host_class);
363 error = transport_class_register(&fc_rport_class);
366 return transport_class_register(&fc_transport_class);
369 static void __exit fc_transport_exit(void)
371 transport_class_unregister(&fc_transport_class);
372 transport_class_unregister(&fc_rport_class);
373 transport_class_unregister(&fc_host_class);
377 * FC Remote Port Attribute Management
380 #define fc_rport_show_function(field, format_string, sz, cast) \
382 show_fc_rport_##field (struct class_device *cdev, char *buf) \
384 struct fc_rport *rport = transport_class_to_rport(cdev); \
385 struct Scsi_Host *shost = rport_to_shost(rport); \
386 struct fc_internal *i = to_fc_internal(shost->transportt); \
387 if (i->f->get_rport_##field) \
388 i->f->get_rport_##field(rport); \
389 return snprintf(buf, sz, format_string, cast rport->field); \
392 #define fc_rport_store_function(field) \
394 store_fc_rport_##field(struct class_device *cdev, const char *buf, \
398 struct fc_rport *rport = transport_class_to_rport(cdev); \
399 struct Scsi_Host *shost = rport_to_shost(rport); \
400 struct fc_internal *i = to_fc_internal(shost->transportt); \
401 val = simple_strtoul(buf, NULL, 0); \
402 i->f->set_rport_##field(rport, val); \
406 #define fc_rport_rd_attr(field, format_string, sz) \
407 fc_rport_show_function(field, format_string, sz, ) \
408 static FC_CLASS_DEVICE_ATTR(rport, field, S_IRUGO, \
409 show_fc_rport_##field, NULL)
411 #define fc_rport_rd_attr_cast(field, format_string, sz, cast) \
412 fc_rport_show_function(field, format_string, sz, (cast)) \
413 static FC_CLASS_DEVICE_ATTR(rport, field, S_IRUGO, \
414 show_fc_rport_##field, NULL)
416 #define fc_rport_rw_attr(field, format_string, sz) \
417 fc_rport_show_function(field, format_string, sz, ) \
418 fc_rport_store_function(field) \
419 static FC_CLASS_DEVICE_ATTR(rport, field, S_IRUGO | S_IWUSR, \
420 show_fc_rport_##field, \
421 store_fc_rport_##field)
424 #define fc_private_rport_show_function(field, format_string, sz, cast) \
426 show_fc_rport_##field (struct class_device *cdev, char *buf) \
428 struct fc_rport *rport = transport_class_to_rport(cdev); \
429 return snprintf(buf, sz, format_string, cast rport->field); \
432 #define fc_private_rport_rd_attr(field, format_string, sz) \
433 fc_private_rport_show_function(field, format_string, sz, ) \
434 static FC_CLASS_DEVICE_ATTR(rport, field, S_IRUGO, \
435 show_fc_rport_##field, NULL)
437 #define fc_private_rport_rd_attr_cast(field, format_string, sz, cast) \
438 fc_private_rport_show_function(field, format_string, sz, (cast)) \
439 static FC_CLASS_DEVICE_ATTR(rport, field, S_IRUGO, \
440 show_fc_rport_##field, NULL)
443 #define fc_private_rport_rd_enum_attr(title, maxlen) \
445 show_fc_rport_##title (struct class_device *cdev, char *buf) \
447 struct fc_rport *rport = transport_class_to_rport(cdev); \
449 name = get_fc_##title##_name(rport->title); \
452 return snprintf(buf, maxlen, "%s\n", name); \
454 static FC_CLASS_DEVICE_ATTR(rport, title, S_IRUGO, \
455 show_fc_rport_##title, NULL)
458 #define SETUP_RPORT_ATTRIBUTE_RD(field) \
459 i->private_rport_attrs[count] = class_device_attr_rport_##field; \
460 i->private_rport_attrs[count].attr.mode = S_IRUGO; \
461 i->private_rport_attrs[count].store = NULL; \
462 i->rport_attrs[count] = &i->private_rport_attrs[count]; \
463 if (i->f->show_rport_##field) \
466 #define SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(field) \
467 i->private_rport_attrs[count] = class_device_attr_rport_##field; \
468 i->private_rport_attrs[count].attr.mode = S_IRUGO; \
469 i->private_rport_attrs[count].store = NULL; \
470 i->rport_attrs[count] = &i->private_rport_attrs[count]; \
473 #define SETUP_RPORT_ATTRIBUTE_RW(field) \
474 i->private_rport_attrs[count] = class_device_attr_rport_##field; \
475 if (!i->f->set_rport_##field) { \
476 i->private_rport_attrs[count].attr.mode = S_IRUGO; \
477 i->private_rport_attrs[count].store = NULL; \
479 i->rport_attrs[count] = &i->private_rport_attrs[count]; \
480 if (i->f->show_rport_##field) \
484 /* The FC Transport Remote Port Attributes: */
486 /* Fixed Remote Port Attributes */
488 fc_private_rport_rd_attr(maxframe_size, "%u bytes\n", 20);
491 show_fc_rport_supported_classes (struct class_device *cdev, char *buf)
493 struct fc_rport *rport = transport_class_to_rport(cdev);
494 if (rport->supported_classes == FC_COS_UNSPECIFIED)
495 return snprintf(buf, 20, "unspecified\n");
496 return get_fc_cos_names(rport->supported_classes, buf);
498 static FC_CLASS_DEVICE_ATTR(rport, supported_classes, S_IRUGO,
499 show_fc_rport_supported_classes, NULL);
501 /* Dynamic Remote Port Attributes */
503 fc_rport_rw_attr(dev_loss_tmo, "%d\n", 20);
506 /* Private Remote Port Attributes */
508 fc_private_rport_rd_attr_cast(node_name, "0x%llx\n", 20, unsigned long long);
509 fc_private_rport_rd_attr_cast(port_name, "0x%llx\n", 20, unsigned long long);
510 fc_private_rport_rd_attr(port_id, "0x%06x\n", 20);
513 show_fc_rport_roles (struct class_device *cdev, char *buf)
515 struct fc_rport *rport = transport_class_to_rport(cdev);
517 /* identify any roles that are port_id specific */
518 if ((rport->port_id != -1) &&
519 (rport->port_id & FC_WELLKNOWN_PORTID_MASK) ==
520 FC_WELLKNOWN_PORTID_MASK) {
521 switch (rport->port_id & FC_WELLKNOWN_ROLE_MASK) {
522 case FC_FPORT_PORTID:
523 return snprintf(buf, 30, "Fabric Port\n");
524 case FC_FABCTLR_PORTID:
525 return snprintf(buf, 30, "Fabric Controller\n");
526 case FC_DIRSRVR_PORTID:
527 return snprintf(buf, 30, "Directory Server\n");
528 case FC_TIMESRVR_PORTID:
529 return snprintf(buf, 30, "Time Server\n");
530 case FC_MGMTSRVR_PORTID:
531 return snprintf(buf, 30, "Management Server\n");
533 return snprintf(buf, 30, "Unknown Fabric Entity\n");
536 if (rport->roles == FC_RPORT_ROLE_UNKNOWN)
537 return snprintf(buf, 20, "unknown\n");
538 return get_fc_remote_port_roles_names(rport->roles, buf);
541 static FC_CLASS_DEVICE_ATTR(rport, roles, S_IRUGO,
542 show_fc_rport_roles, NULL);
544 fc_private_rport_rd_enum_attr(port_state, FC_PORTSTATE_MAX_NAMELEN);
545 fc_private_rport_rd_attr(scsi_target_id, "%d\n", 20);
550 * FC SCSI Target Attribute Management
554 * Note: in the target show function we recognize when the remote
555 * port is in the heirarchy and do not allow the driver to get
556 * involved in sysfs functions. The driver only gets involved if
557 * it's the "old" style that doesn't use rports.
559 #define fc_starget_show_function(field, format_string, sz, cast) \
561 show_fc_starget_##field (struct class_device *cdev, char *buf) \
563 struct scsi_target *starget = transport_class_to_starget(cdev); \
564 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent); \
565 struct fc_internal *i = to_fc_internal(shost->transportt); \
566 struct fc_rport *rport = starget_to_rport(starget); \
568 fc_starget_##field(starget) = rport->field; \
569 else if (i->f->get_starget_##field) \
570 i->f->get_starget_##field(starget); \
571 return snprintf(buf, sz, format_string, \
572 cast fc_starget_##field(starget)); \
575 #define fc_starget_rd_attr(field, format_string, sz) \
576 fc_starget_show_function(field, format_string, sz, ) \
577 static FC_CLASS_DEVICE_ATTR(starget, field, S_IRUGO, \
578 show_fc_starget_##field, NULL)
580 #define fc_starget_rd_attr_cast(field, format_string, sz, cast) \
581 fc_starget_show_function(field, format_string, sz, (cast)) \
582 static FC_CLASS_DEVICE_ATTR(starget, field, S_IRUGO, \
583 show_fc_starget_##field, NULL)
585 #define SETUP_STARGET_ATTRIBUTE_RD(field) \
586 i->private_starget_attrs[count] = class_device_attr_starget_##field; \
587 i->private_starget_attrs[count].attr.mode = S_IRUGO; \
588 i->private_starget_attrs[count].store = NULL; \
589 i->starget_attrs[count] = &i->private_starget_attrs[count]; \
590 if (i->f->show_starget_##field) \
593 #define SETUP_STARGET_ATTRIBUTE_RW(field) \
594 i->private_starget_attrs[count] = class_device_attr_starget_##field; \
595 if (!i->f->set_starget_##field) { \
596 i->private_starget_attrs[count].attr.mode = S_IRUGO; \
597 i->private_starget_attrs[count].store = NULL; \
599 i->starget_attrs[count] = &i->private_starget_attrs[count]; \
600 if (i->f->show_starget_##field) \
603 /* The FC Transport SCSI Target Attributes: */
604 fc_starget_rd_attr_cast(node_name, "0x%llx\n", 20, unsigned long long);
605 fc_starget_rd_attr_cast(port_name, "0x%llx\n", 20, unsigned long long);
606 fc_starget_rd_attr(port_id, "0x%06x\n", 20);
610 * Host Attribute Management
613 #define fc_host_show_function(field, format_string, sz, cast) \
615 show_fc_host_##field (struct class_device *cdev, char *buf) \
617 struct Scsi_Host *shost = transport_class_to_shost(cdev); \
618 struct fc_internal *i = to_fc_internal(shost->transportt); \
619 if (i->f->get_host_##field) \
620 i->f->get_host_##field(shost); \
621 return snprintf(buf, sz, format_string, cast fc_host_##field(shost)); \
624 #define fc_host_store_function(field) \
626 store_fc_host_##field(struct class_device *cdev, const char *buf, \
630 struct Scsi_Host *shost = transport_class_to_shost(cdev); \
631 struct fc_internal *i = to_fc_internal(shost->transportt); \
633 val = simple_strtoul(buf, NULL, 0); \
634 i->f->set_host_##field(shost, val); \
638 #define fc_host_rd_attr(field, format_string, sz) \
639 fc_host_show_function(field, format_string, sz, ) \
640 static FC_CLASS_DEVICE_ATTR(host, field, S_IRUGO, \
641 show_fc_host_##field, NULL)
643 #define fc_host_rd_attr_cast(field, format_string, sz, cast) \
644 fc_host_show_function(field, format_string, sz, (cast)) \
645 static FC_CLASS_DEVICE_ATTR(host, field, S_IRUGO, \
646 show_fc_host_##field, NULL)
648 #define fc_host_rw_attr(field, format_string, sz) \
649 fc_host_show_function(field, format_string, sz, ) \
650 fc_host_store_function(field) \
651 static FC_CLASS_DEVICE_ATTR(host, field, S_IRUGO | S_IWUSR, \
652 show_fc_host_##field, \
653 store_fc_host_##field)
655 #define fc_host_rd_enum_attr(title, maxlen) \
657 show_fc_host_##title (struct class_device *cdev, char *buf) \
659 struct Scsi_Host *shost = transport_class_to_shost(cdev); \
660 struct fc_internal *i = to_fc_internal(shost->transportt); \
662 if (i->f->get_host_##title) \
663 i->f->get_host_##title(shost); \
664 name = get_fc_##title##_name(fc_host_##title(shost)); \
667 return snprintf(buf, maxlen, "%s\n", name); \
669 static FC_CLASS_DEVICE_ATTR(host, title, S_IRUGO, show_fc_host_##title, NULL)
671 #define SETUP_HOST_ATTRIBUTE_RD(field) \
672 i->private_host_attrs[count] = class_device_attr_host_##field; \
673 i->private_host_attrs[count].attr.mode = S_IRUGO; \
674 i->private_host_attrs[count].store = NULL; \
675 i->host_attrs[count] = &i->private_host_attrs[count]; \
676 if (i->f->show_host_##field) \
679 #define SETUP_HOST_ATTRIBUTE_RW(field) \
680 i->private_host_attrs[count] = class_device_attr_host_##field; \
681 if (!i->f->set_host_##field) { \
682 i->private_host_attrs[count].attr.mode = S_IRUGO; \
683 i->private_host_attrs[count].store = NULL; \
685 i->host_attrs[count] = &i->private_host_attrs[count]; \
686 if (i->f->show_host_##field) \
690 #define fc_private_host_show_function(field, format_string, sz, cast) \
692 show_fc_host_##field (struct class_device *cdev, char *buf) \
694 struct Scsi_Host *shost = transport_class_to_shost(cdev); \
695 return snprintf(buf, sz, format_string, cast fc_host_##field(shost)); \
698 #define fc_private_host_rd_attr(field, format_string, sz) \
699 fc_private_host_show_function(field, format_string, sz, ) \
700 static FC_CLASS_DEVICE_ATTR(host, field, S_IRUGO, \
701 show_fc_host_##field, NULL)
703 #define fc_private_host_rd_attr_cast(field, format_string, sz, cast) \
704 fc_private_host_show_function(field, format_string, sz, (cast)) \
705 static FC_CLASS_DEVICE_ATTR(host, field, S_IRUGO, \
706 show_fc_host_##field, NULL)
708 #define SETUP_PRIVATE_HOST_ATTRIBUTE_RD(field) \
709 i->private_host_attrs[count] = class_device_attr_host_##field; \
710 i->private_host_attrs[count].attr.mode = S_IRUGO; \
711 i->private_host_attrs[count].store = NULL; \
712 i->host_attrs[count] = &i->private_host_attrs[count]; \
715 #define SETUP_PRIVATE_HOST_ATTRIBUTE_RW(field) \
716 i->private_host_attrs[count] = class_device_attr_host_##field; \
717 i->host_attrs[count] = &i->private_host_attrs[count]; \
721 /* Fixed Host Attributes */
724 show_fc_host_supported_classes (struct class_device *cdev, char *buf)
726 struct Scsi_Host *shost = transport_class_to_shost(cdev);
728 if (fc_host_supported_classes(shost) == FC_COS_UNSPECIFIED)
729 return snprintf(buf, 20, "unspecified\n");
731 return get_fc_cos_names(fc_host_supported_classes(shost), buf);
733 static FC_CLASS_DEVICE_ATTR(host, supported_classes, S_IRUGO,
734 show_fc_host_supported_classes, NULL);
737 show_fc_host_supported_fc4s (struct class_device *cdev, char *buf)
739 struct Scsi_Host *shost = transport_class_to_shost(cdev);
740 return (ssize_t)show_fc_fc4s(buf, fc_host_supported_fc4s(shost));
742 static FC_CLASS_DEVICE_ATTR(host, supported_fc4s, S_IRUGO,
743 show_fc_host_supported_fc4s, NULL);
746 show_fc_host_supported_speeds (struct class_device *cdev, char *buf)
748 struct Scsi_Host *shost = transport_class_to_shost(cdev);
750 if (fc_host_supported_speeds(shost) == FC_PORTSPEED_UNKNOWN)
751 return snprintf(buf, 20, "unknown\n");
753 return get_fc_port_speed_names(fc_host_supported_speeds(shost), buf);
755 static FC_CLASS_DEVICE_ATTR(host, supported_speeds, S_IRUGO,
756 show_fc_host_supported_speeds, NULL);
759 fc_private_host_rd_attr_cast(node_name, "0x%llx\n", 20, unsigned long long);
760 fc_private_host_rd_attr_cast(port_name, "0x%llx\n", 20, unsigned long long);
761 fc_private_host_rd_attr(symbolic_name, "%s\n", (FC_SYMBOLIC_NAME_SIZE +1));
762 fc_private_host_rd_attr(maxframe_size, "%u bytes\n", 20);
763 fc_private_host_rd_attr(serial_number, "%s\n", (FC_SERIAL_NUMBER_SIZE +1));
766 /* Dynamic Host Attributes */
769 show_fc_host_active_fc4s (struct class_device *cdev, char *buf)
771 struct Scsi_Host *shost = transport_class_to_shost(cdev);
772 struct fc_internal *i = to_fc_internal(shost->transportt);
774 if (i->f->get_host_active_fc4s)
775 i->f->get_host_active_fc4s(shost);
777 return (ssize_t)show_fc_fc4s(buf, fc_host_active_fc4s(shost));
779 static FC_CLASS_DEVICE_ATTR(host, active_fc4s, S_IRUGO,
780 show_fc_host_active_fc4s, NULL);
783 show_fc_host_speed (struct class_device *cdev, char *buf)
785 struct Scsi_Host *shost = transport_class_to_shost(cdev);
786 struct fc_internal *i = to_fc_internal(shost->transportt);
788 if (i->f->get_host_speed)
789 i->f->get_host_speed(shost);
791 if (fc_host_speed(shost) == FC_PORTSPEED_UNKNOWN)
792 return snprintf(buf, 20, "unknown\n");
794 return get_fc_port_speed_names(fc_host_speed(shost), buf);
796 static FC_CLASS_DEVICE_ATTR(host, speed, S_IRUGO,
797 show_fc_host_speed, NULL);
800 fc_host_rd_attr(port_id, "0x%06x\n", 20);
801 fc_host_rd_enum_attr(port_type, FC_PORTTYPE_MAX_NAMELEN);
802 fc_host_rd_enum_attr(port_state, FC_PORTSTATE_MAX_NAMELEN);
803 fc_host_rd_attr_cast(fabric_name, "0x%llx\n", 20, unsigned long long);
806 /* Private Host Attributes */
809 show_fc_private_host_tgtid_bind_type(struct class_device *cdev, char *buf)
811 struct Scsi_Host *shost = transport_class_to_shost(cdev);
814 name = get_fc_tgtid_bind_type_name(fc_host_tgtid_bind_type(shost));
817 return snprintf(buf, FC_BINDTYPE_MAX_NAMELEN, "%s\n", name);
821 store_fc_private_host_tgtid_bind_type(struct class_device *cdev,
822 const char *buf, size_t count)
824 struct Scsi_Host *shost = transport_class_to_shost(cdev);
825 struct fc_rport *rport, *next_rport;
826 enum fc_tgtid_binding_type val;
829 if (get_fc_tgtid_bind_type_match(buf, &val))
832 /* if changing bind type, purge all unused consistent bindings */
833 if (val != fc_host_tgtid_bind_type(shost)) {
834 spin_lock_irqsave(shost->host_lock, flags);
835 list_for_each_entry_safe(rport, next_rport,
836 &fc_host_rport_bindings(shost), peers)
837 fc_rport_terminate(rport);
838 spin_unlock_irqrestore(shost->host_lock, flags);
841 fc_host_tgtid_bind_type(shost) = val;
845 static FC_CLASS_DEVICE_ATTR(host, tgtid_bind_type, S_IRUGO | S_IWUSR,
846 show_fc_private_host_tgtid_bind_type,
847 store_fc_private_host_tgtid_bind_type);
850 * Host Statistics Management
853 /* Show a given an attribute in the statistics group */
855 fc_stat_show(const struct class_device *cdev, char *buf, unsigned long offset)
857 struct Scsi_Host *shost = transport_class_to_shost(cdev);
858 struct fc_internal *i = to_fc_internal(shost->transportt);
859 struct fc_host_statistics *stats;
860 ssize_t ret = -ENOENT;
862 if (offset > sizeof(struct fc_host_statistics) ||
863 offset % sizeof(u64) != 0)
866 if (i->f->get_fc_host_stats) {
867 stats = (i->f->get_fc_host_stats)(shost);
869 ret = snprintf(buf, 20, "0x%llx\n",
870 (unsigned long long)*(u64 *)(((u8 *) stats) + offset));
876 /* generate a read-only statistics attribute */
877 #define fc_host_statistic(name) \
878 static ssize_t show_fcstat_##name(struct class_device *cd, char *buf) \
880 return fc_stat_show(cd, buf, \
881 offsetof(struct fc_host_statistics, name)); \
883 static FC_CLASS_DEVICE_ATTR(host, name, S_IRUGO, show_fcstat_##name, NULL)
885 fc_host_statistic(seconds_since_last_reset);
886 fc_host_statistic(tx_frames);
887 fc_host_statistic(tx_words);
888 fc_host_statistic(rx_frames);
889 fc_host_statistic(rx_words);
890 fc_host_statistic(lip_count);
891 fc_host_statistic(nos_count);
892 fc_host_statistic(error_frames);
893 fc_host_statistic(dumped_frames);
894 fc_host_statistic(link_failure_count);
895 fc_host_statistic(loss_of_sync_count);
896 fc_host_statistic(loss_of_signal_count);
897 fc_host_statistic(prim_seq_protocol_err_count);
898 fc_host_statistic(invalid_tx_word_count);
899 fc_host_statistic(invalid_crc_count);
900 fc_host_statistic(fcp_input_requests);
901 fc_host_statistic(fcp_output_requests);
902 fc_host_statistic(fcp_control_requests);
903 fc_host_statistic(fcp_input_megabytes);
904 fc_host_statistic(fcp_output_megabytes);
907 fc_reset_statistics(struct class_device *cdev, const char *buf,
910 struct Scsi_Host *shost = transport_class_to_shost(cdev);
911 struct fc_internal *i = to_fc_internal(shost->transportt);
913 /* ignore any data value written to the attribute */
914 if (i->f->reset_fc_host_stats) {
915 i->f->reset_fc_host_stats(shost);
921 static FC_CLASS_DEVICE_ATTR(host, reset_statistics, S_IWUSR, NULL,
922 fc_reset_statistics);
925 static struct attribute *fc_statistics_attrs[] = {
926 &class_device_attr_host_seconds_since_last_reset.attr,
927 &class_device_attr_host_tx_frames.attr,
928 &class_device_attr_host_tx_words.attr,
929 &class_device_attr_host_rx_frames.attr,
930 &class_device_attr_host_rx_words.attr,
931 &class_device_attr_host_lip_count.attr,
932 &class_device_attr_host_nos_count.attr,
933 &class_device_attr_host_error_frames.attr,
934 &class_device_attr_host_dumped_frames.attr,
935 &class_device_attr_host_link_failure_count.attr,
936 &class_device_attr_host_loss_of_sync_count.attr,
937 &class_device_attr_host_loss_of_signal_count.attr,
938 &class_device_attr_host_prim_seq_protocol_err_count.attr,
939 &class_device_attr_host_invalid_tx_word_count.attr,
940 &class_device_attr_host_invalid_crc_count.attr,
941 &class_device_attr_host_fcp_input_requests.attr,
942 &class_device_attr_host_fcp_output_requests.attr,
943 &class_device_attr_host_fcp_control_requests.attr,
944 &class_device_attr_host_fcp_input_megabytes.attr,
945 &class_device_attr_host_fcp_output_megabytes.attr,
946 &class_device_attr_host_reset_statistics.attr,
950 static struct attribute_group fc_statistics_group = {
951 .name = "statistics",
952 .attrs = fc_statistics_attrs,
955 static int fc_host_match(struct attribute_container *cont,
958 struct Scsi_Host *shost;
959 struct fc_internal *i;
961 if (!scsi_is_host_device(dev))
964 shost = dev_to_shost(dev);
965 if (!shost->transportt || shost->transportt->host_attrs.ac.class
966 != &fc_host_class.class)
969 i = to_fc_internal(shost->transportt);
971 return &i->t.host_attrs.ac == cont;
974 static int fc_target_match(struct attribute_container *cont,
977 struct Scsi_Host *shost;
978 struct fc_internal *i;
980 if (!scsi_is_target_device(dev))
983 shost = dev_to_shost(dev->parent);
984 if (!shost->transportt || shost->transportt->host_attrs.ac.class
985 != &fc_host_class.class)
988 i = to_fc_internal(shost->transportt);
990 return &i->t.target_attrs.ac == cont;
993 static void fc_rport_dev_release(struct device *dev)
995 struct fc_rport *rport = dev_to_rport(dev);
996 put_device(dev->parent);
1000 int scsi_is_fc_rport(const struct device *dev)
1002 return dev->release == fc_rport_dev_release;
1004 EXPORT_SYMBOL(scsi_is_fc_rport);
1006 static int fc_rport_match(struct attribute_container *cont,
1009 struct Scsi_Host *shost;
1010 struct fc_internal *i;
1012 if (!scsi_is_fc_rport(dev))
1015 shost = dev_to_shost(dev->parent);
1016 if (!shost->transportt || shost->transportt->host_attrs.ac.class
1017 != &fc_host_class.class)
1020 i = to_fc_internal(shost->transportt);
1022 return &i->rport_attr_cont.ac == cont;
1025 struct scsi_transport_template *
1026 fc_attach_transport(struct fc_function_template *ft)
1028 struct fc_internal *i = kmalloc(sizeof(struct fc_internal),
1035 memset(i, 0, sizeof(struct fc_internal));
1037 i->t.target_attrs.ac.attrs = &i->starget_attrs[0];
1038 i->t.target_attrs.ac.class = &fc_transport_class.class;
1039 i->t.target_attrs.ac.match = fc_target_match;
1040 i->t.target_size = sizeof(struct fc_starget_attrs);
1041 transport_container_register(&i->t.target_attrs);
1043 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1044 i->t.host_attrs.ac.class = &fc_host_class.class;
1045 i->t.host_attrs.ac.match = fc_host_match;
1046 i->t.host_size = sizeof(struct fc_host_attrs);
1047 if (ft->get_fc_host_stats)
1048 i->t.host_attrs.statistics = &fc_statistics_group;
1049 transport_container_register(&i->t.host_attrs);
1051 i->rport_attr_cont.ac.attrs = &i->rport_attrs[0];
1052 i->rport_attr_cont.ac.class = &fc_rport_class.class;
1053 i->rport_attr_cont.ac.match = fc_rport_match;
1054 transport_container_register(&i->rport_attr_cont);
1058 /* Transport uses the shost workq for scsi scanning */
1059 i->t.create_work_queue = 1;
1062 * Setup SCSI Target Attributes.
1065 SETUP_STARGET_ATTRIBUTE_RD(node_name);
1066 SETUP_STARGET_ATTRIBUTE_RD(port_name);
1067 SETUP_STARGET_ATTRIBUTE_RD(port_id);
1069 BUG_ON(count > FC_STARGET_NUM_ATTRS);
1071 i->starget_attrs[count] = NULL;
1075 * Setup SCSI Host Attributes.
1078 SETUP_HOST_ATTRIBUTE_RD(node_name);
1079 SETUP_HOST_ATTRIBUTE_RD(port_name);
1080 SETUP_HOST_ATTRIBUTE_RD(supported_classes);
1081 SETUP_HOST_ATTRIBUTE_RD(supported_fc4s);
1082 SETUP_HOST_ATTRIBUTE_RD(symbolic_name);
1083 SETUP_HOST_ATTRIBUTE_RD(supported_speeds);
1084 SETUP_HOST_ATTRIBUTE_RD(maxframe_size);
1085 SETUP_HOST_ATTRIBUTE_RD(serial_number);
1087 SETUP_HOST_ATTRIBUTE_RD(port_id);
1088 SETUP_HOST_ATTRIBUTE_RD(port_type);
1089 SETUP_HOST_ATTRIBUTE_RD(port_state);
1090 SETUP_HOST_ATTRIBUTE_RD(active_fc4s);
1091 SETUP_HOST_ATTRIBUTE_RD(speed);
1092 SETUP_HOST_ATTRIBUTE_RD(fabric_name);
1094 /* Transport-managed attributes */
1095 SETUP_PRIVATE_HOST_ATTRIBUTE_RW(tgtid_bind_type);
1097 BUG_ON(count > FC_HOST_NUM_ATTRS);
1099 i->host_attrs[count] = NULL;
1102 * Setup Remote Port Attributes.
1105 SETUP_RPORT_ATTRIBUTE_RD(maxframe_size);
1106 SETUP_RPORT_ATTRIBUTE_RD(supported_classes);
1107 SETUP_RPORT_ATTRIBUTE_RW(dev_loss_tmo);
1108 SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(node_name);
1109 SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(port_name);
1110 SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(port_id);
1111 SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(roles);
1112 SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(port_state);
1113 SETUP_PRIVATE_RPORT_ATTRIBUTE_RD(scsi_target_id);
1115 BUG_ON(count > FC_RPORT_NUM_ATTRS);
1117 i->rport_attrs[count] = NULL;
1121 EXPORT_SYMBOL(fc_attach_transport);
1123 void fc_release_transport(struct scsi_transport_template *t)
1125 struct fc_internal *i = to_fc_internal(t);
1127 transport_container_unregister(&i->t.target_attrs);
1128 transport_container_unregister(&i->t.host_attrs);
1129 transport_container_unregister(&i->rport_attr_cont);
1133 EXPORT_SYMBOL(fc_release_transport);
1137 * fc_remove_host - called to terminate any fc_transport-related elements
1139 * @rport: remote port to be unblocked.
1141 * This routine is expected to be called immediately preceeding the
1142 * a driver's call to scsi_remove_host().
1144 * WARNING: A driver utilizing the fc_transport, which fails to call
1145 * this routine prior to scsi_remote_host(), will leave dangling
1146 * objects in /sys/class/fc_remote_ports. Access to any of these
1147 * objects can result in a system crash !!!
1150 * This routine assumes no locks are held on entry.
1153 fc_remove_host(struct Scsi_Host *shost)
1155 struct fc_rport *rport, *next_rport;
1157 /* Remove any remote ports */
1158 list_for_each_entry_safe(rport, next_rport,
1159 &fc_host_rports(shost), peers)
1160 fc_rport_terminate(rport);
1161 list_for_each_entry_safe(rport, next_rport,
1162 &fc_host_rport_bindings(shost), peers)
1163 fc_rport_terminate(rport);
1165 EXPORT_SYMBOL(fc_remove_host);
1168 * fc_rport_create - allocates and creates a remote FC port.
1169 * @shost: scsi host the remote port is connected to.
1170 * @channel: Channel on shost port connected to.
1171 * @ids: The world wide names, fc address, and FC4 port
1172 * roles for the remote port.
1174 * Allocates and creates the remoter port structure, including the
1175 * class and sysfs creation.
1178 * This routine assumes no locks are held on entry.
1181 fc_rport_create(struct Scsi_Host *shost, int channel,
1182 struct fc_rport_identifiers *ids)
1184 struct fc_host_attrs *fc_host =
1185 (struct fc_host_attrs *)shost->shost_data;
1186 struct fc_internal *fci = to_fc_internal(shost->transportt);
1187 struct fc_rport *rport;
1189 unsigned long flags;
1193 size = (sizeof(struct fc_rport) + fci->f->dd_fcrport_size);
1194 rport = kmalloc(size, GFP_KERNEL);
1195 if (unlikely(!rport)) {
1196 printk(KERN_ERR "%s: allocation failure\n", __FUNCTION__);
1199 memset(rport, 0, size);
1201 rport->maxframe_size = -1;
1202 rport->supported_classes = FC_COS_UNSPECIFIED;
1203 rport->dev_loss_tmo = fc_dev_loss_tmo;
1204 memcpy(&rport->node_name, &ids->node_name, sizeof(rport->node_name));
1205 memcpy(&rport->port_name, &ids->port_name, sizeof(rport->port_name));
1206 rport->port_id = ids->port_id;
1207 rport->roles = ids->roles;
1208 rport->port_state = FC_PORTSTATE_ONLINE;
1209 if (fci->f->dd_fcrport_size)
1210 rport->dd_data = &rport[1];
1211 rport->channel = channel;
1213 INIT_WORK(&rport->dev_loss_work, fc_timeout_blocked_rport, rport);
1214 INIT_WORK(&rport->scan_work, fc_scsi_scan_rport, rport);
1216 spin_lock_irqsave(shost->host_lock, flags);
1218 rport->number = fc_host->next_rport_number++;
1219 if (rport->roles & FC_RPORT_ROLE_FCP_TARGET)
1220 rport->scsi_target_id = fc_host->next_target_id++;
1222 rport->scsi_target_id = -1;
1223 list_add_tail(&rport->peers, &fc_host_rports(shost));
1224 get_device(&shost->shost_gendev);
1226 spin_unlock_irqrestore(shost->host_lock, flags);
1229 device_initialize(dev);
1230 dev->parent = get_device(&shost->shost_gendev);
1231 dev->release = fc_rport_dev_release;
1232 sprintf(dev->bus_id, "rport-%d:%d-%d",
1233 shost->host_no, channel, rport->number);
1234 transport_setup_device(dev);
1236 error = device_add(dev);
1238 printk(KERN_ERR "FC Remote Port device_add failed\n");
1241 transport_add_device(dev);
1242 transport_configure_device(dev);
1244 if (rport->roles & FC_RPORT_ROLE_FCP_TARGET)
1245 /* initiate a scan of the target */
1246 scsi_queue_work(shost, &rport->scan_work);
1251 transport_destroy_device(dev);
1252 put_device(dev->parent);
1253 spin_lock_irqsave(shost->host_lock, flags);
1254 list_del(&rport->peers);
1255 put_device(&shost->shost_gendev);
1256 spin_unlock_irqrestore(shost->host_lock, flags);
1257 put_device(dev->parent);
1263 * fc_remote_port_add - notifies the fc transport of the existence
1264 * of a remote FC port.
1265 * @shost: scsi host the remote port is connected to.
1266 * @channel: Channel on shost port connected to.
1267 * @ids: The world wide names, fc address, and FC4 port
1268 * roles for the remote port.
1270 * The LLDD calls this routine to notify the transport of the existence
1271 * of a remote port. The LLDD provides the unique identifiers (wwpn,wwn)
1272 * of the port, it's FC address (port_id), and the FC4 roles that are
1273 * active for the port.
1275 * For ports that are FCP targets (aka scsi targets), the FC transport
1276 * maintains consistent target id bindings on behalf of the LLDD.
1277 * A consistent target id binding is an assignment of a target id to
1278 * a remote port identifier, which persists while the scsi host is
1279 * attached. The remote port can disappear, then later reappear, and
1280 * it's target id assignment remains the same. This allows for shifts
1281 * in FC addressing (if binding by wwpn or wwnn) with no apparent
1282 * changes to the scsi subsystem which is based on scsi host number and
1283 * target id values. Bindings are only valid during the attachment of
1284 * the scsi host. If the host detaches, then later re-attaches, target
1285 * id bindings may change.
1287 * This routine is responsible for returning a remote port structure.
1288 * The routine will search the list of remote ports it maintains
1289 * internally on behalf of consistent target id mappings. If found, the
1290 * remote port structure will be reused. Otherwise, a new remote port
1291 * structure will be allocated.
1293 * Whenever a remote port is allocated, a new fc_remote_port class
1294 * device is created.
1296 * Should not be called from interrupt context.
1299 * This routine assumes no locks are held on entry.
1302 fc_remote_port_add(struct Scsi_Host *shost, int channel,
1303 struct fc_rport_identifiers *ids)
1305 struct fc_rport *rport;
1306 unsigned long flags;
1309 if (likely((ids->roles & FC_RPORT_ROLE_FCP_TARGET) &&
1310 (fc_host_tgtid_bind_type(shost) != FC_TGTID_BIND_NONE))) {
1312 /* search for a matching consistent binding */
1314 spin_lock_irqsave(shost->host_lock, flags);
1316 list_for_each_entry(rport, &fc_host_rport_bindings(shost),
1318 if (rport->channel != channel)
1321 switch (fc_host_tgtid_bind_type(shost)) {
1322 case FC_TGTID_BIND_BY_WWPN:
1323 if (rport->port_name == ids->port_name)
1326 case FC_TGTID_BIND_BY_WWNN:
1327 if (rport->node_name == ids->node_name)
1330 case FC_TGTID_BIND_BY_ID:
1331 if (rport->port_id == ids->port_id)
1334 case FC_TGTID_BIND_NONE: /* to keep compiler happy */
1339 list_move_tail(&rport->peers,
1340 &fc_host_rports(shost));
1345 spin_unlock_irqrestore(shost->host_lock, flags);
1348 memcpy(&rport->node_name, &ids->node_name,
1349 sizeof(rport->node_name));
1350 memcpy(&rport->port_name, &ids->port_name,
1351 sizeof(rport->port_name));
1352 rport->port_id = ids->port_id;
1353 rport->roles = ids->roles;
1354 rport->port_state = FC_PORTSTATE_ONLINE;
1356 if (rport->roles & FC_RPORT_ROLE_FCP_TARGET)
1357 /* initiate a scan of the target */
1358 scsi_queue_work(shost, &rport->scan_work);
1364 /* No consistent binding found - create new remote port entry */
1365 rport = fc_rport_create(shost, channel, ids);
1369 EXPORT_SYMBOL(fc_remote_port_add);
1372 * fc_rport_tgt_remove - Removes the scsi target on the remote port
1373 * @rport: The remote port to be operated on
1376 fc_rport_tgt_remove(struct fc_rport *rport)
1378 struct Scsi_Host *shost = rport_to_shost(rport);
1380 scsi_target_unblock(&rport->dev);
1382 /* Stop anything on the workq */
1383 if (!cancel_delayed_work(&rport->dev_loss_work))
1384 flush_scheduled_work();
1385 scsi_flush_work(shost);
1387 scsi_remove_target(&rport->dev);
1391 * fc_rport_terminate - this routine tears down and deallocates a remote port.
1392 * @rport: The remote port to be terminated
1395 * This routine assumes no locks are held on entry.
1398 fc_rport_terminate(struct fc_rport *rport)
1400 struct Scsi_Host *shost = rport_to_shost(rport);
1401 struct device *dev = &rport->dev;
1402 unsigned long flags;
1404 fc_rport_tgt_remove(rport);
1406 transport_remove_device(dev);
1408 transport_destroy_device(dev);
1409 spin_lock_irqsave(shost->host_lock, flags);
1410 list_del(&rport->peers);
1411 spin_unlock_irqrestore(shost->host_lock, flags);
1412 put_device(&shost->shost_gendev);
1416 * fc_remote_port_delete - notifies the fc transport that a remote
1417 * port is no longer in existence.
1418 * @rport: The remote port that no longer exists
1420 * The LLDD calls this routine to notify the transport that a remote
1421 * port is no longer part of the topology. Note: Although a port
1422 * may no longer be part of the topology, it may persist in the remote
1423 * ports displayed by the fc_host. This is done so that target id
1424 * mappings (managed via the remote port structures), are always visible
1425 * as long as the mapping is valid, regardless of port state,
1427 * If the remote port is not an FCP Target, it will be fully torn down
1428 * and deallocated, including the fc_remote_port class device.
1430 * If the remote port is an FCP Target, the port structure will be
1431 * marked as Not Present, but will remain as long as there is a valid
1432 * SCSI target id mapping associated with the port structure. Validity
1433 * is determined by the binding type. If binding by wwpn, then the port
1434 * structure is always valid and will not be deallocated until the host
1435 * is removed. If binding by wwnn, then the port structure is valid
1436 * until another port with the same node name is found in the topology.
1437 * If binding by port id (fc address), then the port structure is valid
1438 * valid until another port with the same address is identified.
1440 * Called from interrupt or normal process context.
1443 * This routine assumes no locks are held on entry.
1446 fc_remote_port_delete(struct fc_rport *rport)
1448 struct Scsi_Host *shost = rport_to_shost(rport);
1449 unsigned long flags;
1451 /* If no scsi target id mapping or consistent binding type, delete it */
1452 if ((rport->scsi_target_id == -1) ||
1453 (fc_host_tgtid_bind_type(shost) == FC_TGTID_BIND_NONE)) {
1454 fc_rport_terminate(rport);
1458 fc_rport_tgt_remove(rport);
1460 spin_lock_irqsave(shost->host_lock, flags);
1461 list_move_tail(&rport->peers, &fc_host_rport_bindings(shost));
1462 spin_unlock_irqrestore(shost->host_lock, flags);
1465 * Note: We do not remove or clear the hostdata area. This allows
1466 * host-specific target data to persist along with the
1467 * scsi_target_id. It's up to the host to manage it's hostdata area.
1471 * Reinitialize port attributes that may change if the port comes back.
1473 rport->maxframe_size = -1;
1474 rport->supported_classes = FC_COS_UNSPECIFIED;
1475 rport->roles = FC_RPORT_ROLE_UNKNOWN;
1476 rport->port_state = FC_PORTSTATE_NOTPRESENT;
1478 /* remove the identifiers that aren't used in the consisting binding */
1479 switch (fc_host_tgtid_bind_type(shost)) {
1480 case FC_TGTID_BIND_BY_WWPN:
1481 rport->node_name = -1;
1482 rport->port_id = -1;
1484 case FC_TGTID_BIND_BY_WWNN:
1485 rport->port_name = -1;
1486 rport->port_id = -1;
1488 case FC_TGTID_BIND_BY_ID:
1489 rport->node_name = -1;
1490 rport->port_name = -1;
1492 case FC_TGTID_BIND_NONE: /* to keep compiler happy */
1496 EXPORT_SYMBOL(fc_remote_port_delete);
1499 * fc_remote_port_rolechg - notifies the fc transport that the roles
1500 * on a remote may have changed.
1501 * @rport: The remote port that changed.
1503 * The LLDD calls this routine to notify the transport that the roles
1504 * on a remote port may have changed. The largest effect of this is
1505 * if a port now becomes a FCP Target, it must be allocated a
1506 * scsi target id. If the port is no longer a FCP target, any
1507 * scsi target id value assigned to it will persist in case the
1508 * role changes back to include FCP Target. No changes in the scsi
1509 * midlayer will be invoked if the role changes (in the expectation
1510 * that the role will be resumed. If it doesn't normal error processing
1513 * Should not be called from interrupt context.
1516 * This routine assumes no locks are held on entry.
1519 fc_remote_port_rolechg(struct fc_rport *rport, u32 roles)
1521 struct Scsi_Host *shost = rport_to_shost(rport);
1522 struct fc_host_attrs *fc_host =
1523 (struct fc_host_attrs *)shost->shost_data;
1524 unsigned long flags;
1527 rport->roles = roles;
1529 spin_lock_irqsave(shost->host_lock, flags);
1530 if ((rport->scsi_target_id == -1) &&
1531 (rport->roles & FC_RPORT_ROLE_FCP_TARGET)) {
1532 rport->scsi_target_id = fc_host->next_target_id++;
1535 spin_unlock_irqrestore(shost->host_lock, flags);
1538 /* initiate a scan of the target */
1539 scsi_queue_work(shost, &rport->scan_work);
1541 EXPORT_SYMBOL(fc_remote_port_rolechg);
1544 * fc_timeout_blocked_rport - Timeout handler for blocked remote port
1545 * that fails to return in the alloted time.
1546 * @data: scsi target that failed to reappear in the alloted time.
1549 fc_timeout_blocked_rport(void *data)
1551 struct fc_rport *rport = (struct fc_rport *)data;
1553 rport->port_state = FC_PORTSTATE_OFFLINE;
1555 dev_printk(KERN_ERR, &rport->dev,
1556 "blocked FC remote port time out: removing target\n");
1559 * As this only occurs if the remote port (scsi target)
1560 * went away and didn't come back - we'll remove
1561 * all attached scsi devices.
1563 scsi_target_unblock(&rport->dev);
1564 scsi_remove_target(&rport->dev);
1568 * fc_remote_port_block - temporarily block any scsi traffic to a remote port.
1569 * @rport: remote port to be blocked.
1571 * scsi lldd's with a FC transport call this routine to temporarily stop
1572 * all scsi traffic to a remote port. If the port is not a SCSI target,
1573 * no action is taken. If the port is a SCSI target, all attached devices
1574 * are placed into a SDEV_BLOCK state and a timer is started. The timer is
1575 * represents the maximum amount of time the port may be blocked. If the
1576 * timer expires, the port is considered non-existent and the attached
1577 * scsi devices will be removed.
1579 * Called from interrupt or normal process context.
1581 * Returns zero if successful or error if not
1584 * This routine assumes no locks are held on entry.
1586 * The timeout and timer types are extracted from the fc transport
1587 * attributes from the caller's rport pointer.
1590 fc_remote_port_block(struct fc_rport *rport)
1592 int timeout = rport->dev_loss_tmo;
1593 struct work_struct *work = &rport->dev_loss_work;
1595 if (timeout < 0 || timeout > SCSI_DEVICE_BLOCK_MAX_TIMEOUT)
1598 scsi_target_block(&rport->dev);
1600 /* cap the length the devices can be blocked */
1601 schedule_delayed_work(work, timeout * HZ);
1603 rport->port_state = FC_PORTSTATE_BLOCKED;
1606 EXPORT_SYMBOL(fc_remote_port_block);
1609 * fc_remote_port_unblock - restart any blocked scsi traffic to a remote port.
1610 * @rport: remote port to be unblocked.
1612 * scsi lld's with a FC transport call this routine to restart IO to all
1613 * devices associated with the caller's scsi target following a fc_target_block
1614 * request. Called from interrupt or normal process context.
1617 * This routine assumes no locks are held on entry.
1620 fc_remote_port_unblock(struct fc_rport *rport)
1622 struct work_struct *work = &rport->dev_loss_work;
1623 struct Scsi_Host *shost = rport_to_shost(rport);
1626 * Stop the target timer first. Take no action on the del_timer
1627 * failure as the state machine state change will validate the
1630 if (!cancel_delayed_work(work))
1631 flush_scheduled_work();
1633 if (rport->port_state == FC_PORTSTATE_OFFLINE)
1635 * initiate a scan of the target as the target has
1638 scsi_queue_work(shost, &rport->scan_work);
1640 scsi_target_unblock(&rport->dev);
1642 rport->port_state = FC_PORTSTATE_ONLINE;
1644 EXPORT_SYMBOL(fc_remote_port_unblock);
1647 * fc_scsi_scan_rport - called to perform a scsi scan on a remote port.
1648 * @data: remote port to be scanned.
1651 fc_scsi_scan_rport(void *data)
1653 struct fc_rport *rport = (struct fc_rport *)data;
1655 scsi_scan_target(&rport->dev, rport->channel, rport->scsi_target_id,
1660 MODULE_AUTHOR("Martin Hicks");
1661 MODULE_DESCRIPTION("FC Transport Attributes");
1662 MODULE_LICENSE("GPL");
1664 module_init(fc_transport_init);
1665 module_exit(fc_transport_exit);