drivers/scsi/libsas/sas_discover.c

   1 /*
   2  * Serial Attached SCSI (SAS) Discover process
   3  *
   4  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
   5  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
   6  *
   7  * This file is licensed under GPLv2.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of the
  12  * License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  22  *
  23  */
  24
  25 #include <linux/scatterlist.h>
  26 #include <linux/slab.h>
  27 #include <scsi/scsi_host.h>
  28 #include <scsi/scsi_eh.h>
  29 #include "sas_internal.h"
  30
  31 #include <scsi/scsi_transport.h>
  32 #include <scsi/scsi_transport_sas.h>
  33 #include <scsi/sas_ata.h>
  34 #include "../scsi_sas_internal.h"
  35
  36 /* ---------- Basic task processing for discovery purposes ---------- */
  37
  38 void sas_init_dev(struct domain_device *dev)
  39 {
  40         switch (dev->dev_type) {
  41         case SAS_END_DEV:
  42                 break;
  43         case EDGE_DEV:
  44         case FANOUT_DEV:
  45                 INIT_LIST_HEAD(&dev->ex_dev.children);
  46                 mutex_init(&dev->ex_dev.cmd_mutex);
  47                 break;
  48         case SATA_DEV:
  49         case SATA_PM:
  50         case SATA_PM_PORT:
  51         case SATA_PENDING:
  52                 INIT_LIST_HEAD(&dev->sata_dev.children);
  53                 break;
  54         default:
  55                 break;
  56         }
  57 }
  58
  59 /* ---------- Domain device discovery ---------- */
  60
  61 /**
  62  * sas_get_port_device -- Discover devices which caused port creation
  63  * @port: pointer to struct sas_port of interest
  64  *
  65  * Devices directly attached to a HA port, have no parent.  This is
  66  * how we know they are (domain) "root" devices.  All other devices
  67  * do, and should have their "parent" pointer set appropriately as
  68  * soon as a child device is discovered.
  69  */
  70 static int sas_get_port_device(struct asd_sas_port *port)
  71 {
  72         unsigned long flags;
  73         struct asd_sas_phy *phy;
  74         struct sas_rphy *rphy;
  75         struct domain_device *dev;
  76
  77         dev = sas_alloc_device();
  78         if (!dev)
  79                 return -ENOMEM;
  80
  81         spin_lock_irqsave(&port->phy_list_lock, flags);
  82         if (list_empty(&port->phy_list)) {
  83                 spin_unlock_irqrestore(&port->phy_list_lock, flags);
  84                 sas_put_device(dev);
  85                 return -ENODEV;
  86         }
  87         phy = container_of(port->phy_list.next, struct asd_sas_phy, port_phy_el);
  88         spin_lock(&phy->frame_rcvd_lock);
  89         memcpy(dev->frame_rcvd, phy->frame_rcvd, min(sizeof(dev->frame_rcvd),
  90                                              (size_t)phy->frame_rcvd_size));
  91         spin_unlock(&phy->frame_rcvd_lock);
  92         spin_unlock_irqrestore(&port->phy_list_lock, flags);
  93
  94         if (dev->frame_rcvd[0] == 0x34 && port->oob_mode == SATA_OOB_MODE) {
  95                 struct dev_to_host_fis *fis =
  96                         (struct dev_to_host_fis *) dev->frame_rcvd;
  97                 if (fis->interrupt_reason == 1 && fis->lbal == 1 &&
  98                     fis->byte_count_low==0x69 && fis->byte_count_high == 0x96
  99                     && (fis->device & ~0x10) == 0)
 100                         dev->dev_type = SATA_PM;
 101                 else
 102                         dev->dev_type = SATA_DEV;
 103                 dev->tproto = SAS_PROTOCOL_SATA;
 104         } else {
 105                 struct sas_identify_frame *id =
 106                         (struct sas_identify_frame *) dev->frame_rcvd;
 107                 dev->dev_type = id->dev_type;
 108                 dev->iproto = id->initiator_bits;
 109                 dev->tproto = id->target_bits;
 110         }
 111
 112         sas_init_dev(dev);
 113
 114         switch (dev->dev_type) {
 115         case SAS_END_DEV:
 116         case SATA_DEV:
 117                 rphy = sas_end_device_alloc(port->port);
 118                 break;
 119         case EDGE_DEV:
 120                 rphy = sas_expander_alloc(port->port,
 121                                           SAS_EDGE_EXPANDER_DEVICE);
 122                 break;
 123         case FANOUT_DEV:
 124                 rphy = sas_expander_alloc(port->port,
 125                                           SAS_FANOUT_EXPANDER_DEVICE);
 126                 break;
 127         default:
 128                 printk("ERROR: Unidentified device type %d\n", dev->dev_type);
 129                 rphy = NULL;
 130                 break;
 131         }
 132
 133         if (!rphy) {
 134                 sas_put_device(dev);
 135                 return -ENODEV;
 136         }
 137         rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
 138         memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
 139         sas_fill_in_rphy(dev, rphy);
 140         sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
 141         port->port_dev = dev;
 142         dev->port = port;
 143         dev->linkrate = port->linkrate;
 144         dev->min_linkrate = port->linkrate;
 145         dev->max_linkrate = port->linkrate;
 146         dev->pathways = port->num_phys;
 147         memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
 148         memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
 149         memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
 150         port->disc.max_level = 0;
 151         sas_device_set_phy(dev, port->port);
 152
 153         dev->rphy = rphy;
 154
 155         if (dev_is_sata(dev) || dev->dev_type == SAS_END_DEV)
 156                 list_add_tail(&dev->disco_list_node, &port->disco_list);
 157         else {
 158                 spin_lock_irq(&port->dev_list_lock);
 159                 list_add_tail(&dev->dev_list_node, &port->dev_list);
 160                 spin_unlock_irq(&port->dev_list_lock);
 161         }
 162
 163         return 0;
 164 }
 165
 166 /* ---------- Discover and Revalidate ---------- */
 167
 168 int sas_notify_lldd_dev_found(struct domain_device *dev)
 169 {
 170         int res = 0;
 171         struct sas_ha_struct *sas_ha = dev->port->ha;
 172         struct Scsi_Host *shost = sas_ha->core.shost;
 173         struct sas_internal *i = to_sas_internal(shost->transportt);
 174
 175         if (i->dft->lldd_dev_found) {
 176                 res = i->dft->lldd_dev_found(dev);
 177                 if (res) {
 178                         printk("sas: driver on pcidev %s cannot handle "
 179                                "device %llx, error:%d\n",
 180                                dev_name(sas_ha->dev),
 181                                SAS_ADDR(dev->sas_addr), res);
 182                 }
 183                 kref_get(&dev->kref);
 184         }
 185         return res;
 186 }
 187
 188
 189 void sas_notify_lldd_dev_gone(struct domain_device *dev)
 190 {
 191         struct sas_ha_struct *sas_ha = dev->port->ha;
 192         struct Scsi_Host *shost = sas_ha->core.shost;
 193         struct sas_internal *i = to_sas_internal(shost->transportt);
 194
 195         if (i->dft->lldd_dev_gone) {
 196                 i->dft->lldd_dev_gone(dev);
 197                 sas_put_device(dev);
 198         }
 199 }
 200
 201 static void sas_probe_devices(struct work_struct *work)
 202 {
 203         struct domain_device *dev, *n;
 204         struct sas_discovery_event *ev =
 205                 container_of(work, struct sas_discovery_event, work);
 206         struct asd_sas_port *port = ev->port;
 207
 208         clear_bit(DISCE_PROBE, &port->disc.pending);
 209
 210         /* devices must be domain members before link recovery and probe */
 211         list_for_each_entry(dev, &port->disco_list, disco_list_node) {
 212                 spin_lock_irq(&port->dev_list_lock);
 213                 list_add_tail(&dev->dev_list_node, &port->dev_list);
 214                 spin_unlock_irq(&port->dev_list_lock);
 215         }
 216
 217         sas_probe_sata(port);
 218
 219         list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node) {
 220                 int err;
 221
 222                 err = sas_rphy_add(dev->rphy);
 223                 if (err)
 224                         sas_fail_probe(dev, __func__, err);
 225                 else
 226                         list_del_init(&dev->disco_list_node);
 227         }
 228 }
 229
 230 /**
 231  * sas_discover_end_dev -- discover an end device (SSP, etc)
 232  * @end: pointer to domain device of interest
 233  *
 234  * See comment in sas_discover_sata().
 235  */
 236 int sas_discover_end_dev(struct domain_device *dev)
 237 {
 238         int res;
 239
 240         res = sas_notify_lldd_dev_found(dev);
 241         if (res)
 242                 return res;
 243         sas_discover_event(dev->port, DISCE_PROBE);
 244
 245         return 0;
 246 }
 247
 248 /* ---------- Device registration and unregistration ---------- */
 249
 250 void sas_free_device(struct kref *kref)
 251 {
 252         struct domain_device *dev = container_of(kref, typeof(*dev), kref);
 253
 254         if (dev->parent)
 255                 sas_put_device(dev->parent);
 256
 257         sas_port_put_phy(dev->phy);
 258         dev->phy = NULL;
 259
 260         /* remove the phys and ports, everything else should be gone */
 261         if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV)
 262                 kfree(dev->ex_dev.ex_phy);
 263
 264         if (dev_is_sata(dev) && dev->sata_dev.ap) {
 265                 ata_sas_port_destroy(dev->sata_dev.ap);
 266                 dev->sata_dev.ap = NULL;
 267         }
 268
 269         kfree(dev);
 270 }
 271
 272 static void sas_unregister_common_dev(struct asd_sas_port *port, struct domain_device *dev)
 273 {
 274         sas_notify_lldd_dev_gone(dev);
 275         if (!dev->parent)
 276                 dev->port->port_dev = NULL;
 277         else
 278                 list_del_init(&dev->siblings);
 279
 280         spin_lock_irq(&port->dev_list_lock);
 281         list_del_init(&dev->dev_list_node);
 282         spin_unlock_irq(&port->dev_list_lock);
 283
 284         sas_put_device(dev);
 285 }
 286
 287 static void sas_destruct_devices(struct work_struct *work)
 288 {
 289         struct domain_device *dev, *n;
 290         struct sas_discovery_event *ev =
 291                 container_of(work, struct sas_discovery_event, work);
 292         struct asd_sas_port *port = ev->port;
 293
 294         clear_bit(DISCE_DESTRUCT, &port->disc.pending);
 295
 296         list_for_each_entry_safe(dev, n, &port->destroy_list, disco_list_node) {
 297                 list_del_init(&dev->disco_list_node);
 298
 299                 sas_remove_children(&dev->rphy->dev);
 300                 sas_rphy_delete(dev->rphy);
 301                 dev->rphy = NULL;
 302                 sas_unregister_common_dev(port, dev);
 303         }
 304 }
 305
 306 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev)
 307 {
 308         if (!test_bit(SAS_DEV_DESTROY, &dev->state) &&
 309             !list_empty(&dev->disco_list_node)) {
 310                 /* this rphy never saw sas_rphy_add */
 311                 list_del_init(&dev->disco_list_node);
 312                 sas_rphy_free(dev->rphy);
 313                 dev->rphy = NULL;
 314                 sas_unregister_common_dev(port, dev);
 315         }
 316
 317         if (dev->rphy && !test_and_set_bit(SAS_DEV_DESTROY, &dev->state)) {
 318                 sas_rphy_unlink(dev->rphy);
 319                 list_move_tail(&dev->disco_list_node, &port->destroy_list);
 320                 sas_discover_event(dev->port, DISCE_DESTRUCT);
 321         }
 322 }
 323
 324 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone)
 325 {
 326         struct domain_device *dev, *n;
 327
 328         list_for_each_entry_safe_reverse(dev, n, &port->dev_list, dev_list_node) {
 329                 if (gone)
 330                         set_bit(SAS_DEV_GONE, &dev->state);
 331                 sas_unregister_dev(port, dev);
 332         }
 333
 334         list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node)
 335                 sas_unregister_dev(port, dev);
 336
 337         port->port->rphy = NULL;
 338
 339 }
 340
 341 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port)
 342 {
 343         struct sas_ha_struct *ha;
 344         struct sas_phy *new_phy;
 345
 346         if (!dev)
 347                 return;
 348
 349         ha = dev->port->ha;
 350         new_phy = sas_port_get_phy(port);
 351
 352         /* pin and record last seen phy */
 353         spin_lock_irq(&ha->phy_port_lock);
 354         if (new_phy) {
 355                 sas_port_put_phy(dev->phy);
 356                 dev->phy = new_phy;
 357         }
 358         spin_unlock_irq(&ha->phy_port_lock);
 359 }
 360
 361 /* ---------- Discovery and Revalidation ---------- */
 362
 363 /**
 364  * sas_discover_domain -- discover the domain
 365  * @port: port to the domain of interest
 366  *
 367  * NOTE: this process _must_ quit (return) as soon as any connection
 368  * errors are encountered.  Connection recovery is done elsewhere.
 369  * Discover process only interrogates devices in order to discover the
 370  * domain.
 371  */
 372 static void sas_discover_domain(struct work_struct *work)
 373 {
 374         struct domain_device *dev;
 375         int error = 0;
 376         struct sas_discovery_event *ev =
 377                 container_of(work, struct sas_discovery_event, work);
 378         struct asd_sas_port *port = ev->port;
 379
 380         clear_bit(DISCE_DISCOVER_DOMAIN, &port->disc.pending);
 381
 382         if (port->port_dev)
 383                 return;
 384
 385         error = sas_get_port_device(port);
 386         if (error)
 387                 return;
 388         dev = port->port_dev;
 389
 390         SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
 391                     task_pid_nr(current));
 392
 393         switch (dev->dev_type) {
 394         case SAS_END_DEV:
 395                 error = sas_discover_end_dev(dev);
 396                 break;
 397         case EDGE_DEV:
 398         case FANOUT_DEV:
 399                 error = sas_discover_root_expander(dev);
 400                 break;
 401         case SATA_DEV:
 402         case SATA_PM:
 403 #ifdef CONFIG_SCSI_SAS_ATA
 404                 error = sas_discover_sata(dev);
 405                 break;
 406 #else
 407                 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
 408                 /* Fall through */
 409 #endif
 410         default:
 411                 error = -ENXIO;
 412                 SAS_DPRINTK("unhandled device %d\n", dev->dev_type);
 413                 break;
 414         }
 415
 416         if (error) {
 417                 sas_rphy_free(dev->rphy);
 418                 dev->rphy = NULL;
 419
 420                 list_del_init(&dev->disco_list_node);
 421                 spin_lock_irq(&port->dev_list_lock);
 422                 list_del_init(&dev->dev_list_node);
 423                 spin_unlock_irq(&port->dev_list_lock);
 424
 425                 sas_put_device(dev);
 426                 port->port_dev = NULL;
 427         }
 428
 429         SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
 430                     task_pid_nr(current), error);
 431 }
 432
 433 static void sas_revalidate_domain(struct work_struct *work)
 434 {
 435         int res = 0;
 436         struct sas_discovery_event *ev =
 437                 container_of(work, struct sas_discovery_event, work);
 438         struct asd_sas_port *port = ev->port;
 439         struct sas_ha_struct *ha = port->ha;
 440
 441         /* prevent revalidation from finding sata links in recovery */
 442         mutex_lock(&ha->disco_mutex);
 443         if (test_bit(SAS_HA_ATA_EH_ACTIVE, &ha->state)) {
 444                 SAS_DPRINTK("REVALIDATION DEFERRED on port %d, pid:%d\n",
 445                             port->id, task_pid_nr(current));
 446                 goto out;
 447         }
 448
 449         clear_bit(DISCE_REVALIDATE_DOMAIN, &port->disc.pending);
 450
 451         SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port->id,
 452                     task_pid_nr(current));
 453
 454         if (port->port_dev)
 455                 res = sas_ex_revalidate_domain(port->port_dev);
 456
 457         SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
 458                     port->id, task_pid_nr(current), res);
 459  out:
 460         mutex_unlock(&ha->disco_mutex);
 461 }
 462
 463 /* ---------- Events ---------- */
 464
 465 static void sas_chain_work(struct sas_ha_struct *ha, struct work_struct *work)
 466 {
 467         /* chained work is not subject to SA_HA_DRAINING or SAS_HA_REGISTERED */
 468         scsi_queue_work(ha->core.shost, work);
 469 }
 470
 471 static void sas_chain_event(int event, unsigned long *pending,
 472                             struct work_struct *work,
 473                             struct sas_ha_struct *ha)
 474 {
 475         if (!test_and_set_bit(event, pending)) {
 476                 unsigned long flags;
 477
 478                 spin_lock_irqsave(&ha->state_lock, flags);
 479                 sas_chain_work(ha, work);
 480                 spin_unlock_irqrestore(&ha->state_lock, flags);
 481         }
 482 }
 483
 484 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
 485 {
 486         struct sas_discovery *disc;
 487
 488         if (!port)
 489                 return 0;
 490         disc = &port->disc;
 491
 492         BUG_ON(ev >= DISC_NUM_EVENTS);
 493
 494         sas_chain_event(ev, &disc->pending, &disc->disc_work[ev].work, port->ha);
 495
 496         return 0;
 497 }
 498
 499 /**
 500  * sas_init_disc -- initialize the discovery struct in the port
 501  * @port: pointer to struct port
 502  *
 503  * Called when the ports are being initialized.
 504  */
 505 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
 506 {
 507         int i;
 508
 509         static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
 510                 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
 511                 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
 512                 [DISCE_PROBE] = sas_probe_devices,
 513                 [DISCE_DESTRUCT] = sas_destruct_devices,
 514         };
 515
 516         disc->pending = 0;
 517         for (i = 0; i < DISC_NUM_EVENTS; i++) {
 518                 INIT_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
 519                 disc->disc_work[i].port = port;
 520         }
 521 }