2 * Copyright (C) 2005-2006 Dell Inc.
3 * Released under GPL v2.
5 * Serial Attached SCSI (SAS) transport class.
7 * The SAS transport class contains common code to deal with SAS HBAs,
8 * an aproximated representation of SAS topologies in the driver model,
9 * and various sysfs attributes to expose these topologies and managment
10 * interfaces to userspace.
12 * In addition to the basic SCSI core objects this transport class
13 * introduces two additional intermediate objects: The SAS PHY
14 * as represented by struct sas_phy defines an "outgoing" PHY on
15 * a SAS HBA or Expander, and the SAS remote PHY represented by
16 * struct sas_rphy defines an "incoming" PHY on a SAS Expander or
17 * end device. Note that this is purely a software concept, the
18 * underlying hardware for a PHY and a remote PHY is the exactly
21 * There is no concept of a SAS port in this code, users can see
22 * what PHYs form a wide port based on the port_identifier attribute,
23 * which is the same for all PHYs in a port.
26 #include <linux/init.h>
27 #include <linux/module.h>
28 #include <linux/err.h>
29 #include <linux/slab.h>
30 #include <linux/string.h>
32 #include <scsi/scsi.h>
33 #include <scsi/scsi_device.h>
34 #include <scsi/scsi_host.h>
35 #include <scsi/scsi_transport.h>
36 #include <scsi/scsi_transport_sas.h>
39 #define SAS_HOST_ATTRS 0
40 #define SAS_PORT_ATTRS 17
41 #define SAS_RPORT_ATTRS 7
42 #define SAS_END_DEV_ATTRS 3
43 #define SAS_EXPANDER_ATTRS 7
46 struct scsi_transport_template t;
47 struct sas_function_template *f;
49 struct class_device_attribute private_host_attrs[SAS_HOST_ATTRS];
50 struct class_device_attribute private_phy_attrs[SAS_PORT_ATTRS];
51 struct class_device_attribute private_rphy_attrs[SAS_RPORT_ATTRS];
52 struct class_device_attribute private_end_dev_attrs[SAS_END_DEV_ATTRS];
53 struct class_device_attribute private_expander_attrs[SAS_EXPANDER_ATTRS];
55 struct transport_container phy_attr_cont;
56 struct transport_container rphy_attr_cont;
57 struct transport_container end_dev_attr_cont;
58 struct transport_container expander_attr_cont;
61 * The array of null terminated pointers to attributes
62 * needed by scsi_sysfs.c
64 struct class_device_attribute *host_attrs[SAS_HOST_ATTRS + 1];
65 struct class_device_attribute *phy_attrs[SAS_PORT_ATTRS + 1];
66 struct class_device_attribute *rphy_attrs[SAS_RPORT_ATTRS + 1];
67 struct class_device_attribute *end_dev_attrs[SAS_END_DEV_ATTRS + 1];
68 struct class_device_attribute *expander_attrs[SAS_EXPANDER_ATTRS + 1];
70 #define to_sas_internal(tmpl) container_of(tmpl, struct sas_internal, t)
72 struct sas_host_attrs {
73 struct list_head rphy_list;
78 #define to_sas_host_attrs(host) ((struct sas_host_attrs *)(host)->shost_data)
82 * Hack to allow attributes of the same name in different objects.
84 #define SAS_CLASS_DEVICE_ATTR(_prefix,_name,_mode,_show,_store) \
85 struct class_device_attribute class_device_attr_##_prefix##_##_name = \
86 __ATTR(_name,_mode,_show,_store)
90 * Pretty printing helpers
93 #define sas_bitfield_name_match(title, table) \
95 get_sas_##title##_names(u32 table_key, char *buf) \
101 for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) { \
102 if (table[i].value & table_key) { \
103 len += sprintf(buf + len, "%s%s", \
104 prefix, table[i].name); \
108 len += sprintf(buf + len, "\n"); \
112 #define sas_bitfield_name_search(title, table) \
114 get_sas_##title##_names(u32 table_key, char *buf) \
119 for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) { \
120 if (table[i].value == table_key) { \
121 len += sprintf(buf + len, "%s", \
126 len += sprintf(buf + len, "\n"); \
133 } sas_device_type_names[] = {
134 { SAS_PHY_UNUSED, "unused" },
135 { SAS_END_DEVICE, "end device" },
136 { SAS_EDGE_EXPANDER_DEVICE, "edge expander" },
137 { SAS_FANOUT_EXPANDER_DEVICE, "fanout expander" },
139 sas_bitfield_name_search(device_type, sas_device_type_names)
145 } sas_protocol_names[] = {
146 { SAS_PROTOCOL_SATA, "sata" },
147 { SAS_PROTOCOL_SMP, "smp" },
148 { SAS_PROTOCOL_STP, "stp" },
149 { SAS_PROTOCOL_SSP, "ssp" },
151 sas_bitfield_name_match(protocol, sas_protocol_names)
156 } sas_linkspeed_names[] = {
157 { SAS_LINK_RATE_UNKNOWN, "Unknown" },
158 { SAS_PHY_DISABLED, "Phy disabled" },
159 { SAS_LINK_RATE_FAILED, "Link Rate failed" },
160 { SAS_SATA_SPINUP_HOLD, "Spin-up hold" },
161 { SAS_LINK_RATE_1_5_GBPS, "1.5 Gbit" },
162 { SAS_LINK_RATE_3_0_GBPS, "3.0 Gbit" },
163 { SAS_LINK_RATE_6_0_GBPS, "6.0 Gbit" },
165 sas_bitfield_name_search(linkspeed, sas_linkspeed_names)
169 * SAS host attributes
172 static int sas_host_setup(struct transport_container *tc, struct device *dev,
173 struct class_device *cdev)
175 struct Scsi_Host *shost = dev_to_shost(dev);
176 struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
178 INIT_LIST_HEAD(&sas_host->rphy_list);
179 mutex_init(&sas_host->lock);
180 sas_host->next_target_id = 0;
181 sas_host->next_expander_id = 0;
185 static DECLARE_TRANSPORT_CLASS(sas_host_class,
186 "sas_host", sas_host_setup, NULL, NULL);
188 static int sas_host_match(struct attribute_container *cont,
191 struct Scsi_Host *shost;
192 struct sas_internal *i;
194 if (!scsi_is_host_device(dev))
196 shost = dev_to_shost(dev);
198 if (!shost->transportt)
200 if (shost->transportt->host_attrs.ac.class !=
201 &sas_host_class.class)
204 i = to_sas_internal(shost->transportt);
205 return &i->t.host_attrs.ac == cont;
208 static int do_sas_phy_delete(struct device *dev, void *data)
210 if (scsi_is_sas_phy(dev))
211 sas_phy_delete(dev_to_phy(dev));
216 * sas_remove_host -- tear down a Scsi_Host's SAS data structures
217 * @shost: Scsi Host that is torn down
219 * Removes all SAS PHYs and remote PHYs for a given Scsi_Host.
220 * Must be called just before scsi_remove_host for SAS HBAs.
222 void sas_remove_host(struct Scsi_Host *shost)
224 device_for_each_child(&shost->shost_gendev, NULL, do_sas_phy_delete);
226 EXPORT_SYMBOL(sas_remove_host);
230 * SAS Port attributes
233 #define sas_phy_show_simple(field, name, format_string, cast) \
235 show_sas_phy_##name(struct class_device *cdev, char *buf) \
237 struct sas_phy *phy = transport_class_to_phy(cdev); \
239 return snprintf(buf, 20, format_string, cast phy->field); \
242 #define sas_phy_simple_attr(field, name, format_string, type) \
243 sas_phy_show_simple(field, name, format_string, (type)) \
244 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_sas_phy_##name, NULL)
246 #define sas_phy_show_protocol(field, name) \
248 show_sas_phy_##name(struct class_device *cdev, char *buf) \
250 struct sas_phy *phy = transport_class_to_phy(cdev); \
253 return snprintf(buf, 20, "none\n"); \
254 return get_sas_protocol_names(phy->field, buf); \
257 #define sas_phy_protocol_attr(field, name) \
258 sas_phy_show_protocol(field, name) \
259 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_sas_phy_##name, NULL)
261 #define sas_phy_show_linkspeed(field) \
263 show_sas_phy_##field(struct class_device *cdev, char *buf) \
265 struct sas_phy *phy = transport_class_to_phy(cdev); \
267 return get_sas_linkspeed_names(phy->field, buf); \
270 #define sas_phy_linkspeed_attr(field) \
271 sas_phy_show_linkspeed(field) \
272 static CLASS_DEVICE_ATTR(field, S_IRUGO, show_sas_phy_##field, NULL)
274 #define sas_phy_show_linkerror(field) \
276 show_sas_phy_##field(struct class_device *cdev, char *buf) \
278 struct sas_phy *phy = transport_class_to_phy(cdev); \
279 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent); \
280 struct sas_internal *i = to_sas_internal(shost->transportt); \
283 if (!phy->local_attached) \
286 error = i->f->get_linkerrors ? i->f->get_linkerrors(phy) : 0; \
289 return snprintf(buf, 20, "%u\n", phy->field); \
292 #define sas_phy_linkerror_attr(field) \
293 sas_phy_show_linkerror(field) \
294 static CLASS_DEVICE_ATTR(field, S_IRUGO, show_sas_phy_##field, NULL)
298 show_sas_device_type(struct class_device *cdev, char *buf)
300 struct sas_phy *phy = transport_class_to_phy(cdev);
302 if (!phy->identify.device_type)
303 return snprintf(buf, 20, "none\n");
304 return get_sas_device_type_names(phy->identify.device_type, buf);
306 static CLASS_DEVICE_ATTR(device_type, S_IRUGO, show_sas_device_type, NULL);
308 static ssize_t do_sas_phy_reset(struct class_device *cdev,
309 size_t count, int hard_reset)
311 struct sas_phy *phy = transport_class_to_phy(cdev);
312 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
313 struct sas_internal *i = to_sas_internal(shost->transportt);
316 if (!phy->local_attached)
319 error = i->f->phy_reset(phy, hard_reset);
325 static ssize_t store_sas_link_reset(struct class_device *cdev,
326 const char *buf, size_t count)
328 return do_sas_phy_reset(cdev, count, 0);
330 static CLASS_DEVICE_ATTR(link_reset, S_IWUSR, NULL, store_sas_link_reset);
332 static ssize_t store_sas_hard_reset(struct class_device *cdev,
333 const char *buf, size_t count)
335 return do_sas_phy_reset(cdev, count, 1);
337 static CLASS_DEVICE_ATTR(hard_reset, S_IWUSR, NULL, store_sas_hard_reset);
339 sas_phy_protocol_attr(identify.initiator_port_protocols,
340 initiator_port_protocols);
341 sas_phy_protocol_attr(identify.target_port_protocols,
342 target_port_protocols);
343 sas_phy_simple_attr(identify.sas_address, sas_address, "0x%016llx\n",
345 sas_phy_simple_attr(identify.phy_identifier, phy_identifier, "%d\n", u8);
346 sas_phy_simple_attr(port_identifier, port_identifier, "%d\n", u8);
347 sas_phy_linkspeed_attr(negotiated_linkrate);
348 sas_phy_linkspeed_attr(minimum_linkrate_hw);
349 sas_phy_linkspeed_attr(minimum_linkrate);
350 sas_phy_linkspeed_attr(maximum_linkrate_hw);
351 sas_phy_linkspeed_attr(maximum_linkrate);
352 sas_phy_linkerror_attr(invalid_dword_count);
353 sas_phy_linkerror_attr(running_disparity_error_count);
354 sas_phy_linkerror_attr(loss_of_dword_sync_count);
355 sas_phy_linkerror_attr(phy_reset_problem_count);
358 static DECLARE_TRANSPORT_CLASS(sas_phy_class,
359 "sas_phy", NULL, NULL, NULL);
361 static int sas_phy_match(struct attribute_container *cont, struct device *dev)
363 struct Scsi_Host *shost;
364 struct sas_internal *i;
366 if (!scsi_is_sas_phy(dev))
368 shost = dev_to_shost(dev->parent);
370 if (!shost->transportt)
372 if (shost->transportt->host_attrs.ac.class !=
373 &sas_host_class.class)
376 i = to_sas_internal(shost->transportt);
377 return &i->phy_attr_cont.ac == cont;
380 static void sas_phy_release(struct device *dev)
382 struct sas_phy *phy = dev_to_phy(dev);
384 put_device(dev->parent);
389 * sas_phy_alloc -- allocates and initialize a SAS PHY structure
390 * @parent: Parent device
393 * Allocates an SAS PHY structure. It will be added in the device tree
394 * below the device specified by @parent, which has to be either a Scsi_Host
398 * SAS PHY allocated or %NULL if the allocation failed.
400 struct sas_phy *sas_phy_alloc(struct device *parent, int number)
402 struct Scsi_Host *shost = dev_to_shost(parent);
405 phy = kzalloc(sizeof(*phy), GFP_KERNEL);
409 phy->number = number;
411 device_initialize(&phy->dev);
412 phy->dev.parent = get_device(parent);
413 phy->dev.release = sas_phy_release;
414 if (scsi_is_sas_expander_device(parent)) {
415 struct sas_rphy *rphy = dev_to_rphy(parent);
416 sprintf(phy->dev.bus_id, "phy-%d-%d:%d", shost->host_no,
417 rphy->scsi_target_id, number);
419 sprintf(phy->dev.bus_id, "phy-%d:%d", shost->host_no, number);
421 transport_setup_device(&phy->dev);
425 EXPORT_SYMBOL(sas_phy_alloc);
428 * sas_phy_add -- add a SAS PHY to the device hierachy
429 * @phy: The PHY to be added
431 * Publishes a SAS PHY to the rest of the system.
433 int sas_phy_add(struct sas_phy *phy)
437 error = device_add(&phy->dev);
439 transport_add_device(&phy->dev);
440 transport_configure_device(&phy->dev);
445 EXPORT_SYMBOL(sas_phy_add);
448 * sas_phy_free -- free a SAS PHY
449 * @phy: SAS PHY to free
451 * Frees the specified SAS PHY.
454 * This function must only be called on a PHY that has not
455 * sucessfully been added using sas_phy_add().
457 void sas_phy_free(struct sas_phy *phy)
459 transport_destroy_device(&phy->dev);
460 put_device(&phy->dev);
462 EXPORT_SYMBOL(sas_phy_free);
465 * sas_phy_delete -- remove SAS PHY
466 * @phy: SAS PHY to remove
468 * Removes the specified SAS PHY. If the SAS PHY has an
469 * associated remote PHY it is removed before.
472 sas_phy_delete(struct sas_phy *phy)
474 struct device *dev = &phy->dev;
477 sas_rphy_delete(phy->rphy);
479 transport_remove_device(dev);
481 transport_destroy_device(dev);
484 EXPORT_SYMBOL(sas_phy_delete);
487 * scsi_is_sas_phy -- check if a struct device represents a SAS PHY
488 * @dev: device to check
491 * %1 if the device represents a SAS PHY, %0 else
493 int scsi_is_sas_phy(const struct device *dev)
495 return dev->release == sas_phy_release;
497 EXPORT_SYMBOL(scsi_is_sas_phy);
500 * SAS remote PHY attributes.
503 #define sas_rphy_show_simple(field, name, format_string, cast) \
505 show_sas_rphy_##name(struct class_device *cdev, char *buf) \
507 struct sas_rphy *rphy = transport_class_to_rphy(cdev); \
509 return snprintf(buf, 20, format_string, cast rphy->field); \
512 #define sas_rphy_simple_attr(field, name, format_string, type) \
513 sas_rphy_show_simple(field, name, format_string, (type)) \
514 static SAS_CLASS_DEVICE_ATTR(rphy, name, S_IRUGO, \
515 show_sas_rphy_##name, NULL)
517 #define sas_rphy_show_protocol(field, name) \
519 show_sas_rphy_##name(struct class_device *cdev, char *buf) \
521 struct sas_rphy *rphy = transport_class_to_rphy(cdev); \
524 return snprintf(buf, 20, "none\n"); \
525 return get_sas_protocol_names(rphy->field, buf); \
528 #define sas_rphy_protocol_attr(field, name) \
529 sas_rphy_show_protocol(field, name) \
530 static SAS_CLASS_DEVICE_ATTR(rphy, name, S_IRUGO, \
531 show_sas_rphy_##name, NULL)
534 show_sas_rphy_device_type(struct class_device *cdev, char *buf)
536 struct sas_rphy *rphy = transport_class_to_rphy(cdev);
538 if (!rphy->identify.device_type)
539 return snprintf(buf, 20, "none\n");
540 return get_sas_device_type_names(
541 rphy->identify.device_type, buf);
544 static SAS_CLASS_DEVICE_ATTR(rphy, device_type, S_IRUGO,
545 show_sas_rphy_device_type, NULL);
548 show_sas_rphy_enclosure_identifier(struct class_device *cdev, char *buf)
550 struct sas_rphy *rphy = transport_class_to_rphy(cdev);
551 struct sas_phy *phy = dev_to_phy(rphy->dev.parent);
552 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
553 struct sas_internal *i = to_sas_internal(shost->transportt);
558 * Only devices behind an expander are supported, because the
559 * enclosure identifier is a SMP feature.
561 if (phy->local_attached)
564 error = i->f->get_enclosure_identifier(rphy, &identifier);
567 return sprintf(buf, "0x%llx\n", (unsigned long long)identifier);
570 static SAS_CLASS_DEVICE_ATTR(rphy, enclosure_identifier, S_IRUGO,
571 show_sas_rphy_enclosure_identifier, NULL);
574 show_sas_rphy_bay_identifier(struct class_device *cdev, char *buf)
576 struct sas_rphy *rphy = transport_class_to_rphy(cdev);
577 struct sas_phy *phy = dev_to_phy(rphy->dev.parent);
578 struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
579 struct sas_internal *i = to_sas_internal(shost->transportt);
582 if (phy->local_attached)
585 val = i->f->get_bay_identifier(rphy);
588 return sprintf(buf, "%d\n", val);
591 static SAS_CLASS_DEVICE_ATTR(rphy, bay_identifier, S_IRUGO,
592 show_sas_rphy_bay_identifier, NULL);
594 sas_rphy_protocol_attr(identify.initiator_port_protocols,
595 initiator_port_protocols);
596 sas_rphy_protocol_attr(identify.target_port_protocols, target_port_protocols);
597 sas_rphy_simple_attr(identify.sas_address, sas_address, "0x%016llx\n",
599 sas_rphy_simple_attr(identify.phy_identifier, phy_identifier, "%d\n", u8);
601 /* only need 8 bytes of data plus header (4 or 8) */
604 int sas_read_port_mode_page(struct scsi_device *sdev)
606 char *buffer = kzalloc(BUF_SIZE, GFP_KERNEL), *msdata;
607 struct sas_rphy *rphy = target_to_rphy(sdev->sdev_target);
608 struct sas_end_device *rdev;
609 struct scsi_mode_data mode_data;
612 BUG_ON(rphy->identify.device_type != SAS_END_DEVICE);
614 rdev = rphy_to_end_device(rphy);
619 res = scsi_mode_sense(sdev, 1, 0x19, buffer, BUF_SIZE, 30*HZ, 3,
623 if (!scsi_status_is_good(res))
626 msdata = buffer + mode_data.header_length +
627 mode_data.block_descriptor_length;
629 if (msdata - buffer > BUF_SIZE - 8)
634 rdev->ready_led_meaning = msdata[2] & 0x10 ? 1 : 0;
635 rdev->I_T_nexus_loss_timeout = (msdata[4] << 8) + msdata[5];
636 rdev->initiator_response_timeout = (msdata[6] << 8) + msdata[7];
642 EXPORT_SYMBOL(sas_read_port_mode_page);
644 static DECLARE_TRANSPORT_CLASS(sas_end_dev_class,
645 "sas_end_device", NULL, NULL, NULL);
647 #define sas_end_dev_show_simple(field, name, format_string, cast) \
649 show_sas_end_dev_##name(struct class_device *cdev, char *buf) \
651 struct sas_rphy *rphy = transport_class_to_rphy(cdev); \
652 struct sas_end_device *rdev = rphy_to_end_device(rphy); \
654 return snprintf(buf, 20, format_string, cast rdev->field); \
657 #define sas_end_dev_simple_attr(field, name, format_string, type) \
658 sas_end_dev_show_simple(field, name, format_string, (type)) \
659 static SAS_CLASS_DEVICE_ATTR(end_dev, name, S_IRUGO, \
660 show_sas_end_dev_##name, NULL)
662 sas_end_dev_simple_attr(ready_led_meaning, ready_led_meaning, "%d\n", int);
663 sas_end_dev_simple_attr(I_T_nexus_loss_timeout, I_T_nexus_loss_timeout,
665 sas_end_dev_simple_attr(initiator_response_timeout, initiator_response_timeout,
668 static DECLARE_TRANSPORT_CLASS(sas_expander_class,
669 "sas_expander", NULL, NULL, NULL);
671 #define sas_expander_show_simple(field, name, format_string, cast) \
673 show_sas_expander_##name(struct class_device *cdev, char *buf) \
675 struct sas_rphy *rphy = transport_class_to_rphy(cdev); \
676 struct sas_expander_device *edev = rphy_to_expander_device(rphy); \
678 return snprintf(buf, 20, format_string, cast edev->field); \
681 #define sas_expander_simple_attr(field, name, format_string, type) \
682 sas_expander_show_simple(field, name, format_string, (type)) \
683 static SAS_CLASS_DEVICE_ATTR(expander, name, S_IRUGO, \
684 show_sas_expander_##name, NULL)
686 sas_expander_simple_attr(vendor_id, vendor_id, "%s\n", char *);
687 sas_expander_simple_attr(product_id, product_id, "%s\n", char *);
688 sas_expander_simple_attr(product_rev, product_rev, "%s\n", char *);
689 sas_expander_simple_attr(component_vendor_id, component_vendor_id,
691 sas_expander_simple_attr(component_id, component_id, "%u\n", unsigned int);
692 sas_expander_simple_attr(component_revision_id, component_revision_id, "%u\n",
694 sas_expander_simple_attr(level, level, "%d\n", int);
696 static DECLARE_TRANSPORT_CLASS(sas_rphy_class,
697 "sas_device", NULL, NULL, NULL);
699 static int sas_rphy_match(struct attribute_container *cont, struct device *dev)
701 struct Scsi_Host *shost;
702 struct sas_internal *i;
704 if (!scsi_is_sas_rphy(dev))
706 shost = dev_to_shost(dev->parent->parent);
708 if (!shost->transportt)
710 if (shost->transportt->host_attrs.ac.class !=
711 &sas_host_class.class)
714 i = to_sas_internal(shost->transportt);
715 return &i->rphy_attr_cont.ac == cont;
718 static int sas_end_dev_match(struct attribute_container *cont,
721 struct Scsi_Host *shost;
722 struct sas_internal *i;
723 struct sas_rphy *rphy;
725 if (!scsi_is_sas_rphy(dev))
727 shost = dev_to_shost(dev->parent->parent);
728 rphy = dev_to_rphy(dev);
730 if (!shost->transportt)
732 if (shost->transportt->host_attrs.ac.class !=
733 &sas_host_class.class)
736 i = to_sas_internal(shost->transportt);
737 return &i->end_dev_attr_cont.ac == cont &&
738 rphy->identify.device_type == SAS_END_DEVICE;
741 static int sas_expander_match(struct attribute_container *cont,
744 struct Scsi_Host *shost;
745 struct sas_internal *i;
746 struct sas_rphy *rphy;
748 if (!scsi_is_sas_rphy(dev))
750 shost = dev_to_shost(dev->parent->parent);
751 rphy = dev_to_rphy(dev);
753 if (!shost->transportt)
755 if (shost->transportt->host_attrs.ac.class !=
756 &sas_host_class.class)
759 i = to_sas_internal(shost->transportt);
760 return &i->expander_attr_cont.ac == cont &&
761 (rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE ||
762 rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE);
765 static void sas_expander_release(struct device *dev)
767 struct sas_rphy *rphy = dev_to_rphy(dev);
768 struct sas_expander_device *edev = rphy_to_expander_device(rphy);
770 put_device(dev->parent);
774 static void sas_end_device_release(struct device *dev)
776 struct sas_rphy *rphy = dev_to_rphy(dev);
777 struct sas_end_device *edev = rphy_to_end_device(rphy);
779 put_device(dev->parent);
784 * sas_end_device_alloc - allocate an rphy for an end device
786 * Allocates an SAS remote PHY structure, connected to @parent.
789 * SAS PHY allocated or %NULL if the allocation failed.
791 struct sas_rphy *sas_end_device_alloc(struct sas_phy *parent)
793 struct Scsi_Host *shost = dev_to_shost(&parent->dev);
794 struct sas_end_device *rdev;
796 rdev = kzalloc(sizeof(*rdev), GFP_KERNEL);
801 device_initialize(&rdev->rphy.dev);
802 rdev->rphy.dev.parent = get_device(&parent->dev);
803 rdev->rphy.dev.release = sas_end_device_release;
804 sprintf(rdev->rphy.dev.bus_id, "end_device-%d:%d-%d",
805 shost->host_no, parent->port_identifier, parent->number);
806 rdev->rphy.identify.device_type = SAS_END_DEVICE;
807 transport_setup_device(&rdev->rphy.dev);
811 EXPORT_SYMBOL(sas_end_device_alloc);
814 * sas_expander_alloc - allocate an rphy for an end device
816 * Allocates an SAS remote PHY structure, connected to @parent.
819 * SAS PHY allocated or %NULL if the allocation failed.
821 struct sas_rphy *sas_expander_alloc(struct sas_phy *parent,
822 enum sas_device_type type)
824 struct Scsi_Host *shost = dev_to_shost(&parent->dev);
825 struct sas_expander_device *rdev;
826 struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
828 BUG_ON(type != SAS_EDGE_EXPANDER_DEVICE &&
829 type != SAS_FANOUT_EXPANDER_DEVICE);
831 rdev = kzalloc(sizeof(*rdev), GFP_KERNEL);
836 device_initialize(&rdev->rphy.dev);
837 rdev->rphy.dev.parent = get_device(&parent->dev);
838 rdev->rphy.dev.release = sas_expander_release;
839 mutex_lock(&sas_host->lock);
840 rdev->rphy.scsi_target_id = sas_host->next_expander_id++;
841 mutex_unlock(&sas_host->lock);
842 sprintf(rdev->rphy.dev.bus_id, "expander-%d:%d",
843 shost->host_no, rdev->rphy.scsi_target_id);
844 rdev->rphy.identify.device_type = type;
845 transport_setup_device(&rdev->rphy.dev);
849 EXPORT_SYMBOL(sas_expander_alloc);
852 * sas_rphy_add -- add a SAS remote PHY to the device hierachy
853 * @rphy: The remote PHY to be added
855 * Publishes a SAS remote PHY to the rest of the system.
857 int sas_rphy_add(struct sas_rphy *rphy)
859 struct sas_phy *parent = dev_to_phy(rphy->dev.parent);
860 struct Scsi_Host *shost = dev_to_shost(parent->dev.parent);
861 struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
862 struct sas_identify *identify = &rphy->identify;
869 error = device_add(&rphy->dev);
872 transport_add_device(&rphy->dev);
873 transport_configure_device(&rphy->dev);
875 mutex_lock(&sas_host->lock);
876 list_add_tail(&rphy->list, &sas_host->rphy_list);
877 if (identify->device_type == SAS_END_DEVICE &&
878 (identify->target_port_protocols &
879 (SAS_PROTOCOL_SSP|SAS_PROTOCOL_STP|SAS_PROTOCOL_SATA)))
880 rphy->scsi_target_id = sas_host->next_target_id++;
881 mutex_unlock(&sas_host->lock);
883 if (identify->device_type == SAS_END_DEVICE &&
884 rphy->scsi_target_id != -1) {
885 scsi_scan_target(&rphy->dev, parent->port_identifier,
886 rphy->scsi_target_id, ~0, 0);
891 EXPORT_SYMBOL(sas_rphy_add);
894 * sas_rphy_free -- free a SAS remote PHY
895 * @rphy SAS remote PHY to free
897 * Frees the specified SAS remote PHY.
900 * This function must only be called on a remote
901 * PHY that has not sucessfully been added using
904 void sas_rphy_free(struct sas_rphy *rphy)
906 struct device *dev = &rphy->dev;
907 struct Scsi_Host *shost = dev_to_shost(rphy->dev.parent->parent);
908 struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
910 mutex_lock(&sas_host->lock);
911 list_del(&rphy->list);
912 mutex_unlock(&sas_host->lock);
914 transport_destroy_device(dev);
918 EXPORT_SYMBOL(sas_rphy_free);
921 * sas_rphy_delete -- remove SAS remote PHY
922 * @rphy: SAS remote PHY to remove
924 * Removes the specified SAS remote PHY.
927 sas_rphy_delete(struct sas_rphy *rphy)
929 struct device *dev = &rphy->dev;
930 struct sas_phy *parent = dev_to_phy(dev->parent);
931 struct Scsi_Host *shost = dev_to_shost(parent->dev.parent);
932 struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
934 switch (rphy->identify.device_type) {
936 scsi_remove_target(dev);
938 case SAS_EDGE_EXPANDER_DEVICE:
939 case SAS_FANOUT_EXPANDER_DEVICE:
940 device_for_each_child(dev, NULL, do_sas_phy_delete);
946 transport_remove_device(dev);
948 transport_destroy_device(dev);
950 mutex_lock(&sas_host->lock);
951 list_del(&rphy->list);
952 mutex_unlock(&sas_host->lock);
958 EXPORT_SYMBOL(sas_rphy_delete);
961 * scsi_is_sas_rphy -- check if a struct device represents a SAS remote PHY
962 * @dev: device to check
965 * %1 if the device represents a SAS remote PHY, %0 else
967 int scsi_is_sas_rphy(const struct device *dev)
969 return dev->release == sas_end_device_release ||
970 dev->release == sas_expander_release;
972 EXPORT_SYMBOL(scsi_is_sas_rphy);
979 static int sas_user_scan(struct Scsi_Host *shost, uint channel,
982 struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
983 struct sas_rphy *rphy;
985 mutex_lock(&sas_host->lock);
986 list_for_each_entry(rphy, &sas_host->rphy_list, list) {
987 struct sas_phy *parent = dev_to_phy(rphy->dev.parent);
989 if (rphy->scsi_target_id == -1)
992 if ((channel == SCAN_WILD_CARD || channel == parent->port_identifier) &&
993 (id == SCAN_WILD_CARD || id == rphy->scsi_target_id)) {
994 scsi_scan_target(&rphy->dev, parent->port_identifier,
995 rphy->scsi_target_id, lun, 1);
998 mutex_unlock(&sas_host->lock);
1005 * Setup / Teardown code
1008 #define SETUP_TEMPLATE(attrb, field, perm, test) \
1009 i->private_##attrb[count] = class_device_attr_##field; \
1010 i->private_##attrb[count].attr.mode = perm; \
1011 i->private_##attrb[count].store = NULL; \
1012 i->attrb[count] = &i->private_##attrb[count]; \
1017 #define SETUP_RPORT_ATTRIBUTE(field) \
1018 SETUP_TEMPLATE(rphy_attrs, field, S_IRUGO, 1)
1020 #define SETUP_OPTIONAL_RPORT_ATTRIBUTE(field, func) \
1021 SETUP_TEMPLATE(rphy_attrs, field, S_IRUGO, i->f->func)
1023 #define SETUP_PORT_ATTRIBUTE(field) \
1024 SETUP_TEMPLATE(phy_attrs, field, S_IRUGO, 1)
1026 #define SETUP_OPTIONAL_PORT_ATTRIBUTE(field, func) \
1027 SETUP_TEMPLATE(phy_attrs, field, S_IRUGO, i->f->func)
1029 #define SETUP_PORT_ATTRIBUTE_WRONLY(field) \
1030 SETUP_TEMPLATE(phy_attrs, field, S_IWUGO, 1)
1032 #define SETUP_OPTIONAL_PORT_ATTRIBUTE_WRONLY(field, func) \
1033 SETUP_TEMPLATE(phy_attrs, field, S_IWUGO, i->f->func)
1035 #define SETUP_END_DEV_ATTRIBUTE(field) \
1036 SETUP_TEMPLATE(end_dev_attrs, field, S_IRUGO, 1)
1038 #define SETUP_EXPANDER_ATTRIBUTE(field) \
1039 SETUP_TEMPLATE(expander_attrs, expander_##field, S_IRUGO, 1)
1042 * sas_attach_transport -- instantiate SAS transport template
1043 * @ft: SAS transport class function template
1045 struct scsi_transport_template *
1046 sas_attach_transport(struct sas_function_template *ft)
1048 struct sas_internal *i;
1051 i = kzalloc(sizeof(struct sas_internal), GFP_KERNEL);
1055 i->t.user_scan = sas_user_scan;
1057 i->t.host_attrs.ac.attrs = &i->host_attrs[0];
1058 i->t.host_attrs.ac.class = &sas_host_class.class;
1059 i->t.host_attrs.ac.match = sas_host_match;
1060 transport_container_register(&i->t.host_attrs);
1061 i->t.host_size = sizeof(struct sas_host_attrs);
1063 i->phy_attr_cont.ac.class = &sas_phy_class.class;
1064 i->phy_attr_cont.ac.attrs = &i->phy_attrs[0];
1065 i->phy_attr_cont.ac.match = sas_phy_match;
1066 transport_container_register(&i->phy_attr_cont);
1068 i->rphy_attr_cont.ac.class = &sas_rphy_class.class;
1069 i->rphy_attr_cont.ac.attrs = &i->rphy_attrs[0];
1070 i->rphy_attr_cont.ac.match = sas_rphy_match;
1071 transport_container_register(&i->rphy_attr_cont);
1073 i->end_dev_attr_cont.ac.class = &sas_end_dev_class.class;
1074 i->end_dev_attr_cont.ac.attrs = &i->end_dev_attrs[0];
1075 i->end_dev_attr_cont.ac.match = sas_end_dev_match;
1076 transport_container_register(&i->end_dev_attr_cont);
1078 i->expander_attr_cont.ac.class = &sas_expander_class.class;
1079 i->expander_attr_cont.ac.attrs = &i->expander_attrs[0];
1080 i->expander_attr_cont.ac.match = sas_expander_match;
1081 transport_container_register(&i->expander_attr_cont);
1086 i->host_attrs[count] = NULL;
1089 SETUP_PORT_ATTRIBUTE(initiator_port_protocols);
1090 SETUP_PORT_ATTRIBUTE(target_port_protocols);
1091 SETUP_PORT_ATTRIBUTE(device_type);
1092 SETUP_PORT_ATTRIBUTE(sas_address);
1093 SETUP_PORT_ATTRIBUTE(phy_identifier);
1094 SETUP_PORT_ATTRIBUTE(port_identifier);
1095 SETUP_PORT_ATTRIBUTE(negotiated_linkrate);
1096 SETUP_PORT_ATTRIBUTE(minimum_linkrate_hw);
1097 SETUP_PORT_ATTRIBUTE(minimum_linkrate);
1098 SETUP_PORT_ATTRIBUTE(maximum_linkrate_hw);
1099 SETUP_PORT_ATTRIBUTE(maximum_linkrate);
1101 SETUP_PORT_ATTRIBUTE(invalid_dword_count);
1102 SETUP_PORT_ATTRIBUTE(running_disparity_error_count);
1103 SETUP_PORT_ATTRIBUTE(loss_of_dword_sync_count);
1104 SETUP_PORT_ATTRIBUTE(phy_reset_problem_count);
1105 SETUP_OPTIONAL_PORT_ATTRIBUTE_WRONLY(link_reset, phy_reset);
1106 SETUP_OPTIONAL_PORT_ATTRIBUTE_WRONLY(hard_reset, phy_reset);
1107 i->phy_attrs[count] = NULL;
1110 SETUP_RPORT_ATTRIBUTE(rphy_initiator_port_protocols);
1111 SETUP_RPORT_ATTRIBUTE(rphy_target_port_protocols);
1112 SETUP_RPORT_ATTRIBUTE(rphy_device_type);
1113 SETUP_RPORT_ATTRIBUTE(rphy_sas_address);
1114 SETUP_RPORT_ATTRIBUTE(rphy_phy_identifier);
1115 SETUP_OPTIONAL_RPORT_ATTRIBUTE(rphy_enclosure_identifier,
1116 get_enclosure_identifier);
1117 SETUP_OPTIONAL_RPORT_ATTRIBUTE(rphy_bay_identifier,
1118 get_bay_identifier);
1119 i->rphy_attrs[count] = NULL;
1122 SETUP_END_DEV_ATTRIBUTE(end_dev_ready_led_meaning);
1123 SETUP_END_DEV_ATTRIBUTE(end_dev_I_T_nexus_loss_timeout);
1124 SETUP_END_DEV_ATTRIBUTE(end_dev_initiator_response_timeout);
1125 i->end_dev_attrs[count] = NULL;
1128 SETUP_EXPANDER_ATTRIBUTE(vendor_id);
1129 SETUP_EXPANDER_ATTRIBUTE(product_id);
1130 SETUP_EXPANDER_ATTRIBUTE(product_rev);
1131 SETUP_EXPANDER_ATTRIBUTE(component_vendor_id);
1132 SETUP_EXPANDER_ATTRIBUTE(component_id);
1133 SETUP_EXPANDER_ATTRIBUTE(component_revision_id);
1134 SETUP_EXPANDER_ATTRIBUTE(level);
1135 i->expander_attrs[count] = NULL;
1139 EXPORT_SYMBOL(sas_attach_transport);
1142 * sas_release_transport -- release SAS transport template instance
1143 * @t: transport template instance
1145 void sas_release_transport(struct scsi_transport_template *t)
1147 struct sas_internal *i = to_sas_internal(t);
1149 transport_container_unregister(&i->t.host_attrs);
1150 transport_container_unregister(&i->phy_attr_cont);
1151 transport_container_unregister(&i->rphy_attr_cont);
1152 transport_container_unregister(&i->end_dev_attr_cont);
1153 transport_container_unregister(&i->expander_attr_cont);
1157 EXPORT_SYMBOL(sas_release_transport);
1159 static __init int sas_transport_init(void)
1163 error = transport_class_register(&sas_host_class);
1166 error = transport_class_register(&sas_phy_class);
1168 goto out_unregister_transport;
1169 error = transport_class_register(&sas_rphy_class);
1171 goto out_unregister_phy;
1172 error = transport_class_register(&sas_end_dev_class);
1174 goto out_unregister_rphy;
1175 error = transport_class_register(&sas_expander_class);
1177 goto out_unregister_end_dev;
1181 out_unregister_end_dev:
1182 transport_class_unregister(&sas_end_dev_class);
1183 out_unregister_rphy:
1184 transport_class_unregister(&sas_rphy_class);
1186 transport_class_unregister(&sas_phy_class);
1187 out_unregister_transport:
1188 transport_class_unregister(&sas_host_class);
1194 static void __exit sas_transport_exit(void)
1196 transport_class_unregister(&sas_host_class);
1197 transport_class_unregister(&sas_phy_class);
1198 transport_class_unregister(&sas_rphy_class);
1199 transport_class_unregister(&sas_end_dev_class);
1200 transport_class_unregister(&sas_expander_class);
1203 MODULE_AUTHOR("Christoph Hellwig");
1204 MODULE_DESCRIPTION("SAS Transphy Attributes");
1205 MODULE_LICENSE("GPL");
1207 module_init(sas_transport_init);
1208 module_exit(sas_transport_exit);