drivers/scsi/scsi_transport_sas.c

   1 /*
   2  * Copyright (C) 2005 Dell Inc.
   3  *      Released under GPL v2.
   4  *
   5  * Serial Attached SCSI (SAS) transport class.
   6  *
   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.
  11  *
  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
  19  * the same.
  20  *
  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.
  24  */
  25
  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>
  31
  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>
  37
  38
  39 #define SAS_HOST_ATTRS          0
  40 #define SAS_PORT_ATTRS          17
  41 #define SAS_RPORT_ATTRS         5
  42
  43 struct sas_internal {
  44         struct scsi_transport_template t;
  45         struct sas_function_template *f;
  46
  47         struct class_device_attribute private_host_attrs[SAS_HOST_ATTRS];
  48         struct class_device_attribute private_phy_attrs[SAS_PORT_ATTRS];
  49         struct class_device_attribute private_rphy_attrs[SAS_RPORT_ATTRS];
  50
  51         struct transport_container phy_attr_cont;
  52         struct transport_container rphy_attr_cont;
  53
  54         /*
  55          * The array of null terminated pointers to attributes
  56          * needed by scsi_sysfs.c
  57          */
  58         struct class_device_attribute *host_attrs[SAS_HOST_ATTRS + 1];
  59         struct class_device_attribute *phy_attrs[SAS_PORT_ATTRS + 1];
  60         struct class_device_attribute *rphy_attrs[SAS_RPORT_ATTRS + 1];
  61 };
  62 #define to_sas_internal(tmpl)   container_of(tmpl, struct sas_internal, t)
  63
  64 struct sas_host_attrs {
  65         struct list_head rphy_list;
  66         struct mutex lock;
  67         u32 next_target_id;
  68 };
  69 #define to_sas_host_attrs(host) ((struct sas_host_attrs *)(host)->shost_data)
  70
  71
  72 /*
  73  * Hack to allow attributes of the same name in different objects.
  74  */
  75 #define SAS_CLASS_DEVICE_ATTR(_prefix,_name,_mode,_show,_store) \
  76         struct class_device_attribute class_device_attr_##_prefix##_##_name = \
  77         __ATTR(_name,_mode,_show,_store)
  78
  79
  80 /*
  81  * Pretty printing helpers
  82  */
  83
  84 #define sas_bitfield_name_match(title, table)                   \
  85 static ssize_t                                                  \
  86 get_sas_##title##_names(u32 table_key, char *buf)               \
  87 {                                                               \
  88         char *prefix = "";                                      \
  89         ssize_t len = 0;                                        \
  90         int i;                                                  \
  91                                                                 \
  92         for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) {  \
  93                 if (table[i].value & table_key) {               \
  94                         len += sprintf(buf + len, "%s%s",       \
  95                                 prefix, table[i].name);         \
  96                         prefix = ", ";                          \
  97                 }                                               \
  98         }                                                       \
  99         len += sprintf(buf + len, "\n");                        \
 100         return len;                                             \
 101 }
 102
 103 #define sas_bitfield_name_search(title, table)                  \
 104 static ssize_t                                                  \
 105 get_sas_##title##_names(u32 table_key, char *buf)               \
 106 {                                                               \
 107         ssize_t len = 0;                                        \
 108         int i;                                                  \
 109                                                                 \
 110         for (i = 0; i < sizeof(table)/sizeof(table[0]); i++) {  \
 111                 if (table[i].value == table_key) {              \
 112                         len += sprintf(buf + len, "%s",         \
 113                                 table[i].name);                 \
 114                         break;                                  \
 115                 }                                               \
 116         }                                                       \
 117         len += sprintf(buf + len, "\n");                        \
 118         return len;                                             \
 119 }
 120
 121 static struct {
 122         u32             value;
 123         char            *name;
 124 } sas_device_type_names[] = {
 125         { SAS_PHY_UNUSED,               "unused" },
 126         { SAS_END_DEVICE,               "end device" },
 127         { SAS_EDGE_EXPANDER_DEVICE,     "edge expander" },
 128         { SAS_FANOUT_EXPANDER_DEVICE,   "fanout expander" },
 129 };
 130 sas_bitfield_name_search(device_type, sas_device_type_names)
 131
 132
 133 static struct {
 134         u32             value;
 135         char            *name;
 136 } sas_protocol_names[] = {
 137         { SAS_PROTOCOL_SATA,            "sata" },
 138         { SAS_PROTOCOL_SMP,             "smp" },
 139         { SAS_PROTOCOL_STP,             "stp" },
 140         { SAS_PROTOCOL_SSP,             "ssp" },
 141 };
 142 sas_bitfield_name_match(protocol, sas_protocol_names)
 143
 144 static struct {
 145         u32             value;
 146         char            *name;
 147 } sas_linkspeed_names[] = {
 148         { SAS_LINK_RATE_UNKNOWN,        "Unknown" },
 149         { SAS_PHY_DISABLED,             "Phy disabled" },
 150         { SAS_LINK_RATE_FAILED,         "Link Rate failed" },
 151         { SAS_SATA_SPINUP_HOLD,         "Spin-up hold" },
 152         { SAS_LINK_RATE_1_5_GBPS,       "1.5 Gbit" },
 153         { SAS_LINK_RATE_3_0_GBPS,       "3.0 Gbit" },
 154 };
 155 sas_bitfield_name_search(linkspeed, sas_linkspeed_names)
 156
 157
 158 /*
 159  * SAS host attributes
 160  */
 161
 162 static int sas_host_setup(struct transport_container *tc, struct device *dev,
 163                           struct class_device *cdev)
 164 {
 165         struct Scsi_Host *shost = dev_to_shost(dev);
 166         struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
 167
 168         INIT_LIST_HEAD(&sas_host->rphy_list);
 169         mutex_init(&sas_host->lock);
 170         sas_host->next_target_id = 0;
 171         return 0;
 172 }
 173
 174 static DECLARE_TRANSPORT_CLASS(sas_host_class,
 175                 "sas_host", sas_host_setup, NULL, NULL);
 176
 177 static int sas_host_match(struct attribute_container *cont,
 178                             struct device *dev)
 179 {
 180         struct Scsi_Host *shost;
 181         struct sas_internal *i;
 182
 183         if (!scsi_is_host_device(dev))
 184                 return 0;
 185         shost = dev_to_shost(dev);
 186
 187         if (!shost->transportt)
 188                 return 0;
 189         if (shost->transportt->host_attrs.ac.class !=
 190                         &sas_host_class.class)
 191                 return 0;
 192
 193         i = to_sas_internal(shost->transportt);
 194         return &i->t.host_attrs.ac == cont;
 195 }
 196
 197 static int do_sas_phy_delete(struct device *dev, void *data)
 198 {
 199         if (scsi_is_sas_phy(dev))
 200                 sas_phy_delete(dev_to_phy(dev));
 201         return 0;
 202 }
 203
 204 /**
 205  * sas_remove_host  --  tear down a Scsi_Host's SAS data structures
 206  * @shost:      Scsi Host that is torn down
 207  *
 208  * Removes all SAS PHYs and remote PHYs for a given Scsi_Host.
 209  * Must be called just before scsi_remove_host for SAS HBAs.
 210  */
 211 void sas_remove_host(struct Scsi_Host *shost)
 212 {
 213         device_for_each_child(&shost->shost_gendev, NULL, do_sas_phy_delete);
 214 }
 215 EXPORT_SYMBOL(sas_remove_host);
 216
 217
 218 /*
 219  * SAS Port attributes
 220  */
 221
 222 #define sas_phy_show_simple(field, name, format_string, cast)           \
 223 static ssize_t                                                          \
 224 show_sas_phy_##name(struct class_device *cdev, char *buf)               \
 225 {                                                                       \
 226         struct sas_phy *phy = transport_class_to_phy(cdev);             \
 227                                                                         \
 228         return snprintf(buf, 20, format_string, cast phy->field);       \
 229 }
 230
 231 #define sas_phy_simple_attr(field, name, format_string, type)           \
 232         sas_phy_show_simple(field, name, format_string, (type)) \
 233 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_sas_phy_##name, NULL)
 234
 235 #define sas_phy_show_protocol(field, name)                              \
 236 static ssize_t                                                          \
 237 show_sas_phy_##name(struct class_device *cdev, char *buf)               \
 238 {                                                                       \
 239         struct sas_phy *phy = transport_class_to_phy(cdev);             \
 240                                                                         \
 241         if (!phy->field)                                                \
 242                 return snprintf(buf, 20, "none\n");                     \
 243         return get_sas_protocol_names(phy->field, buf);         \
 244 }
 245
 246 #define sas_phy_protocol_attr(field, name)                              \
 247         sas_phy_show_protocol(field, name)                              \
 248 static CLASS_DEVICE_ATTR(name, S_IRUGO, show_sas_phy_##name, NULL)
 249
 250 #define sas_phy_show_linkspeed(field)                                   \
 251 static ssize_t                                                          \
 252 show_sas_phy_##field(struct class_device *cdev, char *buf)              \
 253 {                                                                       \
 254         struct sas_phy *phy = transport_class_to_phy(cdev);             \
 255                                                                         \
 256         return get_sas_linkspeed_names(phy->field, buf);                \
 257 }
 258
 259 #define sas_phy_linkspeed_attr(field)                                   \
 260         sas_phy_show_linkspeed(field)                                   \
 261 static CLASS_DEVICE_ATTR(field, S_IRUGO, show_sas_phy_##field, NULL)
 262
 263 #define sas_phy_show_linkerror(field)                                   \
 264 static ssize_t                                                          \
 265 show_sas_phy_##field(struct class_device *cdev, char *buf)              \
 266 {                                                                       \
 267         struct sas_phy *phy = transport_class_to_phy(cdev);             \
 268         struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);        \
 269         struct sas_internal *i = to_sas_internal(shost->transportt);    \
 270         int error;                                                      \
 271                                                                         \
 272         if (!phy->local_attached)                                       \
 273                 return -EINVAL;                                         \
 274                                                                         \
 275         error = i->f->get_linkerrors(phy);                              \
 276         if (error)                                                      \
 277                 return error;                                           \
 278         return snprintf(buf, 20, "%u\n", phy->field);                   \
 279 }
 280
 281 #define sas_phy_linkerror_attr(field)                                   \
 282         sas_phy_show_linkerror(field)                                   \
 283 static CLASS_DEVICE_ATTR(field, S_IRUGO, show_sas_phy_##field, NULL)
 284
 285
 286 static ssize_t
 287 show_sas_device_type(struct class_device *cdev, char *buf)
 288 {
 289         struct sas_phy *phy = transport_class_to_phy(cdev);
 290
 291         if (!phy->identify.device_type)
 292                 return snprintf(buf, 20, "none\n");
 293         return get_sas_device_type_names(phy->identify.device_type, buf);
 294 }
 295 static CLASS_DEVICE_ATTR(device_type, S_IRUGO, show_sas_device_type, NULL);
 296
 297 static ssize_t do_sas_phy_reset(struct class_device *cdev,
 298                 size_t count, int hard_reset)
 299 {
 300         struct sas_phy *phy = transport_class_to_phy(cdev);
 301         struct Scsi_Host *shost = dev_to_shost(phy->dev.parent);
 302         struct sas_internal *i = to_sas_internal(shost->transportt);
 303         int error;
 304
 305         if (!phy->local_attached)
 306                 return -EINVAL;
 307
 308         error = i->f->phy_reset(phy, hard_reset);
 309         if (error)
 310                 return error;
 311         return count;
 312 };
 313
 314 static ssize_t store_sas_link_reset(struct class_device *cdev,
 315                 const char *buf, size_t count)
 316 {
 317         return do_sas_phy_reset(cdev, count, 0);
 318 }
 319 static CLASS_DEVICE_ATTR(link_reset, S_IWUSR, NULL, store_sas_link_reset);
 320
 321 static ssize_t store_sas_hard_reset(struct class_device *cdev,
 322                 const char *buf, size_t count)
 323 {
 324         return do_sas_phy_reset(cdev, count, 1);
 325 }
 326 static CLASS_DEVICE_ATTR(hard_reset, S_IWUSR, NULL, store_sas_hard_reset);
 327
 328 sas_phy_protocol_attr(identify.initiator_port_protocols,
 329                 initiator_port_protocols);
 330 sas_phy_protocol_attr(identify.target_port_protocols,
 331                 target_port_protocols);
 332 sas_phy_simple_attr(identify.sas_address, sas_address, "0x%016llx\n",
 333                 unsigned long long);
 334 sas_phy_simple_attr(identify.phy_identifier, phy_identifier, "%d\n", u8);
 335 sas_phy_simple_attr(port_identifier, port_identifier, "%d\n", u8);
 336 sas_phy_linkspeed_attr(negotiated_linkrate);
 337 sas_phy_linkspeed_attr(minimum_linkrate_hw);
 338 sas_phy_linkspeed_attr(minimum_linkrate);
 339 sas_phy_linkspeed_attr(maximum_linkrate_hw);
 340 sas_phy_linkspeed_attr(maximum_linkrate);
 341 sas_phy_linkerror_attr(invalid_dword_count);
 342 sas_phy_linkerror_attr(running_disparity_error_count);
 343 sas_phy_linkerror_attr(loss_of_dword_sync_count);
 344 sas_phy_linkerror_attr(phy_reset_problem_count);
 345
 346
 347 static DECLARE_TRANSPORT_CLASS(sas_phy_class,
 348                 "sas_phy", NULL, NULL, NULL);
 349
 350 static int sas_phy_match(struct attribute_container *cont, struct device *dev)
 351 {
 352         struct Scsi_Host *shost;
 353         struct sas_internal *i;
 354
 355         if (!scsi_is_sas_phy(dev))
 356                 return 0;
 357         shost = dev_to_shost(dev->parent);
 358
 359         if (!shost->transportt)
 360                 return 0;
 361         if (shost->transportt->host_attrs.ac.class !=
 362                         &sas_host_class.class)
 363                 return 0;
 364
 365         i = to_sas_internal(shost->transportt);
 366         return &i->phy_attr_cont.ac == cont;
 367 }
 368
 369 static void sas_phy_release(struct device *dev)
 370 {
 371         struct sas_phy *phy = dev_to_phy(dev);
 372
 373         put_device(dev->parent);
 374         kfree(phy);
 375 }
 376
 377 /**
 378  * sas_phy_alloc  --  allocates and initialize a SAS PHY structure
 379  * @parent:     Parent device
 380  * @number:     Phy index
 381  *
 382  * Allocates an SAS PHY structure.  It will be added in the device tree
 383  * below the device specified by @parent, which has to be either a Scsi_Host
 384  * or sas_rphy.
 385  *
 386  * Returns:
 387  *      SAS PHY allocated or %NULL if the allocation failed.
 388  */
 389 struct sas_phy *sas_phy_alloc(struct device *parent, int number)
 390 {
 391         struct Scsi_Host *shost = dev_to_shost(parent);
 392         struct sas_phy *phy;
 393
 394         phy = kzalloc(sizeof(*phy), GFP_KERNEL);
 395         if (!phy)
 396                 return NULL;
 397
 398         get_device(parent);
 399
 400         phy->number = number;
 401
 402         device_initialize(&phy->dev);
 403         phy->dev.parent = get_device(parent);
 404         phy->dev.release = sas_phy_release;
 405         sprintf(phy->dev.bus_id, "phy-%d:%d", shost->host_no, number);
 406
 407         transport_setup_device(&phy->dev);
 408
 409         return phy;
 410 }
 411 EXPORT_SYMBOL(sas_phy_alloc);
 412
 413 /**
 414  * sas_phy_add  --  add a SAS PHY to the device hierachy
 415  * @phy:        The PHY to be added
 416  *
 417  * Publishes a SAS PHY to the rest of the system.
 418  */
 419 int sas_phy_add(struct sas_phy *phy)
 420 {
 421         int error;
 422
 423         error = device_add(&phy->dev);
 424         if (!error) {
 425                 transport_add_device(&phy->dev);
 426                 transport_configure_device(&phy->dev);
 427         }
 428
 429         return error;
 430 }
 431 EXPORT_SYMBOL(sas_phy_add);
 432
 433 /**
 434  * sas_phy_free  --  free a SAS PHY
 435  * @phy:        SAS PHY to free
 436  *
 437  * Frees the specified SAS PHY.
 438  *
 439  * Note:
 440  *   This function must only be called on a PHY that has not
 441  *   sucessfully been added using sas_phy_add().
 442  */
 443 void sas_phy_free(struct sas_phy *phy)
 444 {
 445         transport_destroy_device(&phy->dev);
 446         put_device(phy->dev.parent);
 447         put_device(phy->dev.parent);
 448         put_device(phy->dev.parent);
 449         kfree(phy);
 450 }
 451 EXPORT_SYMBOL(sas_phy_free);
 452
 453 /**
 454  * sas_phy_delete  --  remove SAS PHY
 455  * @phy:        SAS PHY to remove
 456  *
 457  * Removes the specified SAS PHY.  If the SAS PHY has an
 458  * associated remote PHY it is removed before.
 459  */
 460 void
 461 sas_phy_delete(struct sas_phy *phy)
 462 {
 463         struct device *dev = &phy->dev;
 464
 465         if (phy->rphy)
 466                 sas_rphy_delete(phy->rphy);
 467
 468         transport_remove_device(dev);
 469         device_del(dev);
 470         transport_destroy_device(dev);
 471         put_device(dev->parent);
 472 }
 473 EXPORT_SYMBOL(sas_phy_delete);
 474
 475 /**
 476  * scsi_is_sas_phy  --  check if a struct device represents a SAS PHY
 477  * @dev:        device to check
 478  *
 479  * Returns:
 480  *      %1 if the device represents a SAS PHY, %0 else
 481  */
 482 int scsi_is_sas_phy(const struct device *dev)
 483 {
 484         return dev->release == sas_phy_release;
 485 }
 486 EXPORT_SYMBOL(scsi_is_sas_phy);
 487
 488 /*
 489  * SAS remote PHY attributes.
 490  */
 491
 492 #define sas_rphy_show_simple(field, name, format_string, cast)          \
 493 static ssize_t                                                          \
 494 show_sas_rphy_##name(struct class_device *cdev, char *buf)              \
 495 {                                                                       \
 496         struct sas_rphy *rphy = transport_class_to_rphy(cdev);  \
 497                                                                         \
 498         return snprintf(buf, 20, format_string, cast rphy->field);      \
 499 }
 500
 501 #define sas_rphy_simple_attr(field, name, format_string, type)          \
 502         sas_rphy_show_simple(field, name, format_string, (type))        \
 503 static SAS_CLASS_DEVICE_ATTR(rphy, name, S_IRUGO,                       \
 504                 show_sas_rphy_##name, NULL)
 505
 506 #define sas_rphy_show_protocol(field, name)                             \
 507 static ssize_t                                                          \
 508 show_sas_rphy_##name(struct class_device *cdev, char *buf)              \
 509 {                                                                       \
 510         struct sas_rphy *rphy = transport_class_to_rphy(cdev);  \
 511                                                                         \
 512         if (!rphy->field)                                       \
 513                 return snprintf(buf, 20, "none\n");                     \
 514         return get_sas_protocol_names(rphy->field, buf);        \
 515 }
 516
 517 #define sas_rphy_protocol_attr(field, name)                             \
 518         sas_rphy_show_protocol(field, name)                             \
 519 static SAS_CLASS_DEVICE_ATTR(rphy, name, S_IRUGO,                       \
 520                 show_sas_rphy_##name, NULL)
 521
 522 static ssize_t
 523 show_sas_rphy_device_type(struct class_device *cdev, char *buf)
 524 {
 525         struct sas_rphy *rphy = transport_class_to_rphy(cdev);
 526
 527         if (!rphy->identify.device_type)
 528                 return snprintf(buf, 20, "none\n");
 529         return get_sas_device_type_names(
 530                         rphy->identify.device_type, buf);
 531 }
 532
 533 static SAS_CLASS_DEVICE_ATTR(rphy, device_type, S_IRUGO,
 534                 show_sas_rphy_device_type, NULL);
 535
 536 sas_rphy_protocol_attr(identify.initiator_port_protocols,
 537                 initiator_port_protocols);
 538 sas_rphy_protocol_attr(identify.target_port_protocols, target_port_protocols);
 539 sas_rphy_simple_attr(identify.sas_address, sas_address, "0x%016llx\n",
 540                 unsigned long long);
 541 sas_rphy_simple_attr(identify.phy_identifier, phy_identifier, "%d\n", u8);
 542
 543 static DECLARE_TRANSPORT_CLASS(sas_rphy_class,
 544                 "sas_rphy", NULL, NULL, NULL);
 545
 546 static int sas_rphy_match(struct attribute_container *cont, struct device *dev)
 547 {
 548         struct Scsi_Host *shost;
 549         struct sas_internal *i;
 550
 551         if (!scsi_is_sas_rphy(dev))
 552                 return 0;
 553         shost = dev_to_shost(dev->parent->parent);
 554
 555         if (!shost->transportt)
 556                 return 0;
 557         if (shost->transportt->host_attrs.ac.class !=
 558                         &sas_host_class.class)
 559                 return 0;
 560
 561         i = to_sas_internal(shost->transportt);
 562         return &i->rphy_attr_cont.ac == cont;
 563 }
 564
 565 static void sas_rphy_release(struct device *dev)
 566 {
 567         struct sas_rphy *rphy = dev_to_rphy(dev);
 568
 569         put_device(dev->parent);
 570         kfree(rphy);
 571 }
 572
 573 /**
 574  * sas_rphy_alloc  --  allocates and initialize a SAS remote PHY structure
 575  * @parent:             SAS PHY this remote PHY is conneted to
 576  *
 577  * Allocates an SAS remote PHY structure, connected to @parent.
 578  *
 579  * Returns:
 580  *      SAS PHY allocated or %NULL if the allocation failed.
 581  */
 582 struct sas_rphy *sas_rphy_alloc(struct sas_phy *parent)
 583 {
 584         struct Scsi_Host *shost = dev_to_shost(&parent->dev);
 585         struct sas_rphy *rphy;
 586
 587         rphy = kzalloc(sizeof(*rphy), GFP_KERNEL);
 588         if (!rphy) {
 589                 put_device(&parent->dev);
 590                 return NULL;
 591         }
 592
 593         device_initialize(&rphy->dev);
 594         rphy->dev.parent = get_device(&parent->dev);
 595         rphy->dev.release = sas_rphy_release;
 596         sprintf(rphy->dev.bus_id, "rphy-%d:%d-%d",
 597                 shost->host_no, parent->port_identifier, parent->number);
 598         transport_setup_device(&rphy->dev);
 599
 600         return rphy;
 601 }
 602 EXPORT_SYMBOL(sas_rphy_alloc);
 603
 604 /**
 605  * sas_rphy_add  --  add a SAS remote PHY to the device hierachy
 606  * @rphy:       The remote PHY to be added
 607  *
 608  * Publishes a SAS remote PHY to the rest of the system.
 609  */
 610 int sas_rphy_add(struct sas_rphy *rphy)
 611 {
 612         struct sas_phy *parent = dev_to_phy(rphy->dev.parent);
 613         struct Scsi_Host *shost = dev_to_shost(parent->dev.parent);
 614         struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
 615         struct sas_identify *identify = &rphy->identify;
 616         int error;
 617
 618         if (parent->rphy)
 619                 return -ENXIO;
 620         parent->rphy = rphy;
 621
 622         error = device_add(&rphy->dev);
 623         if (error)
 624                 return error;
 625         transport_add_device(&rphy->dev);
 626         transport_configure_device(&rphy->dev);
 627
 628         mutex_lock(&sas_host->lock);
 629         list_add_tail(&rphy->list, &sas_host->rphy_list);
 630         if (identify->device_type == SAS_END_DEVICE &&
 631             (identify->target_port_protocols &
 632              (SAS_PROTOCOL_SSP|SAS_PROTOCOL_STP|SAS_PROTOCOL_SATA)))
 633                 rphy->scsi_target_id = sas_host->next_target_id++;
 634         else
 635                 rphy->scsi_target_id = -1;
 636         mutex_unlock(&sas_host->lock);
 637
 638         if (rphy->scsi_target_id != -1) {
 639                 scsi_scan_target(&rphy->dev, parent->port_identifier,
 640                                 rphy->scsi_target_id, ~0, 0);
 641         }
 642
 643         return 0;
 644 }
 645 EXPORT_SYMBOL(sas_rphy_add);
 646
 647 /**
 648  * sas_rphy_free  --  free a SAS remote PHY
 649  * @rphy        SAS remote PHY to free
 650  *
 651  * Frees the specified SAS remote PHY.
 652  *
 653  * Note:
 654  *   This function must only be called on a remote
 655  *   PHY that has not sucessfully been added using
 656  *   sas_rphy_add().
 657  */
 658 void sas_rphy_free(struct sas_rphy *rphy)
 659 {
 660         struct Scsi_Host *shost = dev_to_shost(rphy->dev.parent->parent);
 661         struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
 662
 663         mutex_lock(&sas_host->lock);
 664         list_del(&rphy->list);
 665         mutex_unlock(&sas_host->lock);
 666
 667         transport_destroy_device(&rphy->dev);
 668         put_device(rphy->dev.parent);
 669         put_device(rphy->dev.parent);
 670         put_device(rphy->dev.parent);
 671         kfree(rphy);
 672 }
 673 EXPORT_SYMBOL(sas_rphy_free);
 674
 675 /**
 676  * sas_rphy_delete  --  remove SAS remote PHY
 677  * @rphy:       SAS remote PHY to remove
 678  *
 679  * Removes the specified SAS remote PHY.
 680  */
 681 void
 682 sas_rphy_delete(struct sas_rphy *rphy)
 683 {
 684         struct device *dev = &rphy->dev;
 685         struct sas_phy *parent = dev_to_phy(dev->parent);
 686         struct Scsi_Host *shost = dev_to_shost(parent->dev.parent);
 687         struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
 688
 689         switch (rphy->identify.device_type) {
 690         case SAS_END_DEVICE:
 691                 scsi_remove_target(dev);
 692                 break;
 693         case SAS_EDGE_EXPANDER_DEVICE:
 694         case SAS_FANOUT_EXPANDER_DEVICE:
 695                 device_for_each_child(dev, NULL, do_sas_phy_delete);
 696                 break;
 697         default:
 698                 break;
 699         }
 700
 701         transport_remove_device(dev);
 702         device_del(dev);
 703         transport_destroy_device(dev);
 704
 705         mutex_lock(&sas_host->lock);
 706         list_del(&rphy->list);
 707         mutex_unlock(&sas_host->lock);
 708
 709         parent->rphy = NULL;
 710
 711         put_device(&parent->dev);
 712 }
 713 EXPORT_SYMBOL(sas_rphy_delete);
 714
 715 /**
 716  * scsi_is_sas_rphy  --  check if a struct device represents a SAS remote PHY
 717  * @dev:        device to check
 718  *
 719  * Returns:
 720  *      %1 if the device represents a SAS remote PHY, %0 else
 721  */
 722 int scsi_is_sas_rphy(const struct device *dev)
 723 {
 724         return dev->release == sas_rphy_release;
 725 }
 726 EXPORT_SYMBOL(scsi_is_sas_rphy);
 727
 728
 729 /*
 730  * SCSI scan helper
 731  */
 732
 733 static int sas_user_scan(struct Scsi_Host *shost, uint channel,
 734                 uint id, uint lun)
 735 {
 736         struct sas_host_attrs *sas_host = to_sas_host_attrs(shost);
 737         struct sas_rphy *rphy;
 738
 739         mutex_lock(&sas_host->lock);
 740         list_for_each_entry(rphy, &sas_host->rphy_list, list) {
 741                 struct sas_phy *parent = dev_to_phy(rphy->dev.parent);
 742
 743                 if (rphy->scsi_target_id == -1)
 744                         continue;
 745
 746                 if ((channel == SCAN_WILD_CARD || channel == parent->port_identifier) &&
 747                     (id == SCAN_WILD_CARD || id == rphy->scsi_target_id)) {
 748                         scsi_scan_target(&rphy->dev, parent->port_identifier,
 749                                          rphy->scsi_target_id, lun, 1);
 750                 }
 751         }
 752         mutex_unlock(&sas_host->lock);
 753
 754         return 0;
 755 }
 756
 757
 758 /*
 759  * Setup / Teardown code
 760  */
 761
 762 #define SETUP_RPORT_ATTRIBUTE(field)                                    \
 763         i->private_rphy_attrs[count] = class_device_attr_##field;       \
 764         i->private_rphy_attrs[count].attr.mode = S_IRUGO;               \
 765         i->private_rphy_attrs[count].store = NULL;                      \
 766         i->rphy_attrs[count] = &i->private_rphy_attrs[count];   \
 767         count++
 768
 769 #define SETUP_PORT_ATTRIBUTE(field)                                     \
 770         i->private_phy_attrs[count] = class_device_attr_##field;        \
 771         i->private_phy_attrs[count].attr.mode = S_IRUGO;                \
 772         i->private_phy_attrs[count].store = NULL;                       \
 773         i->phy_attrs[count] = &i->private_phy_attrs[count];             \
 774         count++
 775
 776 #define SETUP_PORT_ATTRIBUTE_WRONLY(field)                              \
 777         i->private_phy_attrs[count] = class_device_attr_##field;        \
 778         i->private_phy_attrs[count].attr.mode = S_IWUGO;                \
 779         i->private_phy_attrs[count].show = NULL;                        \
 780         i->phy_attrs[count] = &i->private_phy_attrs[count];             \
 781         count++
 782
 783
 784 /**
 785  * sas_attach_transport  --  instantiate SAS transport template
 786  * @ft:         SAS transport class function template
 787  */
 788 struct scsi_transport_template *
 789 sas_attach_transport(struct sas_function_template *ft)
 790 {
 791         struct sas_internal *i;
 792         int count;
 793
 794         i = kzalloc(sizeof(struct sas_internal), GFP_KERNEL);
 795         if (!i)
 796                 return NULL;
 797
 798         i->t.user_scan = sas_user_scan;
 799
 800         i->t.host_attrs.ac.attrs = &i->host_attrs[0];
 801         i->t.host_attrs.ac.class = &sas_host_class.class;
 802         i->t.host_attrs.ac.match = sas_host_match;
 803         transport_container_register(&i->t.host_attrs);
 804         i->t.host_size = sizeof(struct sas_host_attrs);
 805
 806         i->phy_attr_cont.ac.class = &sas_phy_class.class;
 807         i->phy_attr_cont.ac.attrs = &i->phy_attrs[0];
 808         i->phy_attr_cont.ac.match = sas_phy_match;
 809         transport_container_register(&i->phy_attr_cont);
 810
 811         i->rphy_attr_cont.ac.class = &sas_rphy_class.class;
 812         i->rphy_attr_cont.ac.attrs = &i->rphy_attrs[0];
 813         i->rphy_attr_cont.ac.match = sas_rphy_match;
 814         transport_container_register(&i->rphy_attr_cont);
 815
 816         i->f = ft;
 817
 818         count = 0;
 819         i->host_attrs[count] = NULL;
 820
 821         count = 0;
 822         SETUP_PORT_ATTRIBUTE(initiator_port_protocols);
 823         SETUP_PORT_ATTRIBUTE(target_port_protocols);
 824         SETUP_PORT_ATTRIBUTE(device_type);
 825         SETUP_PORT_ATTRIBUTE(sas_address);
 826         SETUP_PORT_ATTRIBUTE(phy_identifier);
 827         SETUP_PORT_ATTRIBUTE(port_identifier);
 828         SETUP_PORT_ATTRIBUTE(negotiated_linkrate);
 829         SETUP_PORT_ATTRIBUTE(minimum_linkrate_hw);
 830         SETUP_PORT_ATTRIBUTE(minimum_linkrate);
 831         SETUP_PORT_ATTRIBUTE(maximum_linkrate_hw);
 832         SETUP_PORT_ATTRIBUTE(maximum_linkrate);
 833
 834         SETUP_PORT_ATTRIBUTE(invalid_dword_count);
 835         SETUP_PORT_ATTRIBUTE(running_disparity_error_count);
 836         SETUP_PORT_ATTRIBUTE(loss_of_dword_sync_count);
 837         SETUP_PORT_ATTRIBUTE(phy_reset_problem_count);
 838         SETUP_PORT_ATTRIBUTE_WRONLY(link_reset);
 839         SETUP_PORT_ATTRIBUTE_WRONLY(hard_reset);
 840         i->phy_attrs[count] = NULL;
 841
 842         count = 0;
 843         SETUP_RPORT_ATTRIBUTE(rphy_initiator_port_protocols);
 844         SETUP_RPORT_ATTRIBUTE(rphy_target_port_protocols);
 845         SETUP_RPORT_ATTRIBUTE(rphy_device_type);
 846         SETUP_RPORT_ATTRIBUTE(rphy_sas_address);
 847         SETUP_RPORT_ATTRIBUTE(rphy_phy_identifier);
 848         i->rphy_attrs[count] = NULL;
 849
 850         return &i->t;
 851 }
 852 EXPORT_SYMBOL(sas_attach_transport);
 853
 854 /**
 855  * sas_release_transport  --  release SAS transport template instance
 856  * @t:          transport template instance
 857  */
 858 void sas_release_transport(struct scsi_transport_template *t)
 859 {
 860         struct sas_internal *i = to_sas_internal(t);
 861
 862         transport_container_unregister(&i->t.host_attrs);
 863         transport_container_unregister(&i->phy_attr_cont);
 864         transport_container_unregister(&i->rphy_attr_cont);
 865
 866         kfree(i);
 867 }
 868 EXPORT_SYMBOL(sas_release_transport);
 869
 870 static __init int sas_transport_init(void)
 871 {
 872         int error;
 873
 874         error = transport_class_register(&sas_host_class);
 875         if (error)
 876                 goto out;
 877         error = transport_class_register(&sas_phy_class);
 878         if (error)
 879                 goto out_unregister_transport;
 880         error = transport_class_register(&sas_rphy_class);
 881         if (error)
 882                 goto out_unregister_phy;
 883
 884         return 0;
 885
 886  out_unregister_phy:
 887         transport_class_unregister(&sas_phy_class);
 888  out_unregister_transport:
 889         transport_class_unregister(&sas_host_class);
 890  out:
 891         return error;
 892
 893 }
 894
 895 static void __exit sas_transport_exit(void)
 896 {
 897         transport_class_unregister(&sas_host_class);
 898         transport_class_unregister(&sas_phy_class);
 899         transport_class_unregister(&sas_rphy_class);
 900 }
 901
 902 MODULE_AUTHOR("Christoph Hellwig");
 903 MODULE_DESCRIPTION("SAS Transphy Attributes");
 904 MODULE_LICENSE("GPL");
 905
 906 module_init(sas_transport_init);
 907 module_exit(sas_transport_exit);