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         struct asd_sas_phy *phy;
  73         struct sas_rphy *rphy;
  74         struct domain_device *dev;
  75
  76         dev = sas_alloc_device();
  77         if (!dev)
  78                 return -ENOMEM;
  79
  80         spin_lock_irq(&port->phy_list_lock);
  81         if (list_empty(&port->phy_list)) {
  82                 spin_unlock_irq(&port->phy_list_lock);
  83                 sas_put_device(dev);
  84                 return -ENODEV;
  85         }
  86         phy = container_of(port->phy_list.next, struct asd_sas_phy, port_phy_el);
  87         spin_lock(&phy->frame_rcvd_lock);
  88         memcpy(dev->frame_rcvd, phy->frame_rcvd, min(sizeof(dev->frame_rcvd),
  89                                              (size_t)phy->frame_rcvd_size));
  90         spin_unlock(&phy->frame_rcvd_lock);
  91         spin_unlock_irq(&port->phy_list_lock);
  92
  93         if (dev->frame_rcvd[0] == 0x34 && port->oob_mode == SATA_OOB_MODE) {
  94                 struct dev_to_host_fis *fis =
  95                         (struct dev_to_host_fis *) dev->frame_rcvd;
  96                 if (fis->interrupt_reason == 1 && fis->lbal == 1 &&
  97                     fis->byte_count_low==0x69 && fis->byte_count_high == 0x96
  98                     && (fis->device & ~0x10) == 0)
  99                         dev->dev_type = SATA_PM;
 100                 else
 101                         dev->dev_type = SATA_DEV;
 102                 dev->tproto = SAS_PROTOCOL_SATA;
 103         } else {
 104                 struct sas_identify_frame *id =
 105                         (struct sas_identify_frame *) dev->frame_rcvd;
 106                 dev->dev_type = id->dev_type;
 107                 dev->iproto = id->initiator_bits;
 108                 dev->tproto = id->target_bits;
 109         }
 110
 111         sas_init_dev(dev);
 112
 113         switch (dev->dev_type) {
 114         case SAS_END_DEV:
 115         case SATA_DEV:
 116                 rphy = sas_end_device_alloc(port->port);
 117                 break;
 118         case EDGE_DEV:
 119                 rphy = sas_expander_alloc(port->port,
 120                                           SAS_EDGE_EXPANDER_DEVICE);
 121                 break;
 122         case FANOUT_DEV:
 123                 rphy = sas_expander_alloc(port->port,
 124                                           SAS_FANOUT_EXPANDER_DEVICE);
 125                 break;
 126         default:
 127                 printk("ERROR: Unidentified device type %d\n", dev->dev_type);
 128                 rphy = NULL;
 129                 break;
 130         }
 131
 132         if (!rphy) {
 133                 sas_put_device(dev);
 134                 return -ENODEV;
 135         }
 136
 137         spin_lock_irq(&port->phy_list_lock);
 138         list_for_each_entry(phy, &port->phy_list, port_phy_el)
 139                 sas_phy_set_target(phy, dev);
 140         spin_unlock_irq(&port->phy_list_lock);
 141         rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
 142         memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
 143         sas_fill_in_rphy(dev, rphy);
 144         sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
 145         port->port_dev = dev;
 146         dev->port = port;
 147         dev->linkrate = port->linkrate;
 148         dev->min_linkrate = port->linkrate;
 149         dev->max_linkrate = port->linkrate;
 150         dev->pathways = port->num_phys;
 151         memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
 152         memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
 153         memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
 154         port->disc.max_level = 0;
 155         sas_device_set_phy(dev, port->port);
 156
 157         dev->rphy = rphy;
 158
 159         if (dev_is_sata(dev) || dev->dev_type == SAS_END_DEV)
 160                 list_add_tail(&dev->disco_list_node, &port->disco_list);
 161         else {
 162                 spin_lock_irq(&port->dev_list_lock);
 163                 list_add_tail(&dev->dev_list_node, &port->dev_list);
 164                 spin_unlock_irq(&port->dev_list_lock);
 165         }
 166
 167         return 0;
 168 }
 169
 170 /* ---------- Discover and Revalidate ---------- */
 171
 172 int sas_notify_lldd_dev_found(struct domain_device *dev)
 173 {
 174         int res = 0;
 175         struct sas_ha_struct *sas_ha = dev->port->ha;
 176         struct Scsi_Host *shost = sas_ha->core.shost;
 177         struct sas_internal *i = to_sas_internal(shost->transportt);
 178
 179         if (i->dft->lldd_dev_found) {
 180                 res = i->dft->lldd_dev_found(dev);
 181                 if (res) {
 182                         printk("sas: driver on pcidev %s cannot handle "
 183                                "device %llx, error:%d\n",
 184                                dev_name(sas_ha->dev),
 185                                SAS_ADDR(dev->sas_addr), res);
 186                 }
 187                 kref_get(&dev->kref);
 188         }
 189         return res;
 190 }
 191
 192
 193 void sas_notify_lldd_dev_gone(struct domain_device *dev)
 194 {
 195         struct sas_ha_struct *sas_ha = dev->port->ha;
 196         struct Scsi_Host *shost = sas_ha->core.shost;
 197         struct sas_internal *i = to_sas_internal(shost->transportt);
 198
 199         if (i->dft->lldd_dev_gone) {
 200                 i->dft->lldd_dev_gone(dev);
 201                 sas_put_device(dev);
 202         }
 203 }
 204
 205 static void sas_probe_devices(struct work_struct *work)
 206 {
 207         struct domain_device *dev, *n;
 208         struct sas_discovery_event *ev = to_sas_discovery_event(work);
 209         struct asd_sas_port *port = ev->port;
 210
 211         clear_bit(DISCE_PROBE, &port->disc.pending);
 212
 213         /* devices must be domain members before link recovery and probe */
 214         list_for_each_entry(dev, &port->disco_list, disco_list_node) {
 215                 spin_lock_irq(&port->dev_list_lock);
 216                 list_add_tail(&dev->dev_list_node, &port->dev_list);
 217                 spin_unlock_irq(&port->dev_list_lock);
 218         }
 219
 220         sas_probe_sata(port);
 221
 222         list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node) {
 223                 int err;
 224
 225                 err = sas_rphy_add(dev->rphy);
 226                 if (err)
 227                         sas_fail_probe(dev, __func__, err);
 228                 else
 229                         list_del_init(&dev->disco_list_node);
 230         }
 231 }
 232
 233 /**
 234  * sas_discover_end_dev -- discover an end device (SSP, etc)
 235  * @end: pointer to domain device of interest
 236  *
 237  * See comment in sas_discover_sata().
 238  */
 239 int sas_discover_end_dev(struct domain_device *dev)
 240 {
 241         int res;
 242
 243         res = sas_notify_lldd_dev_found(dev);
 244         if (res)
 245                 return res;
 246         sas_discover_event(dev->port, DISCE_PROBE);
 247
 248         return 0;
 249 }
 250
 251 /* ---------- Device registration and unregistration ---------- */
 252
 253 void sas_free_device(struct kref *kref)
 254 {
 255         struct domain_device *dev = container_of(kref, typeof(*dev), kref);
 256
 257         if (dev->parent)
 258                 sas_put_device(dev->parent);
 259
 260         sas_port_put_phy(dev->phy);
 261         dev->phy = NULL;
 262
 263         /* remove the phys and ports, everything else should be gone */
 264         if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV)
 265                 kfree(dev->ex_dev.ex_phy);
 266
 267         if (dev_is_sata(dev) && dev->sata_dev.ap) {
 268                 ata_sas_port_destroy(dev->sata_dev.ap);
 269                 dev->sata_dev.ap = NULL;
 270         }
 271
 272         kfree(dev);
 273 }
 274
 275 static void sas_unregister_common_dev(struct asd_sas_port *port, struct domain_device *dev)
 276 {
 277         sas_notify_lldd_dev_gone(dev);
 278         if (!dev->parent)
 279                 dev->port->port_dev = NULL;
 280         else
 281                 list_del_init(&dev->siblings);
 282
 283         spin_lock_irq(&port->dev_list_lock);
 284         list_del_init(&dev->dev_list_node);
 285         spin_unlock_irq(&port->dev_list_lock);
 286
 287         sas_put_device(dev);
 288 }
 289
 290 static void sas_destruct_devices(struct work_struct *work)
 291 {
 292         struct domain_device *dev, *n;
 293         struct sas_discovery_event *ev = to_sas_discovery_event(work);
 294         struct asd_sas_port *port = ev->port;
 295
 296         clear_bit(DISCE_DESTRUCT, &port->disc.pending);
 297
 298         list_for_each_entry_safe(dev, n, &port->destroy_list, disco_list_node) {
 299                 list_del_init(&dev->disco_list_node);
 300
 301                 sas_remove_children(&dev->rphy->dev);
 302                 sas_rphy_delete(dev->rphy);
 303                 dev->rphy = NULL;
 304                 sas_unregister_common_dev(port, dev);
 305         }
 306 }
 307
 308 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev)
 309 {
 310         if (!test_bit(SAS_DEV_DESTROY, &dev->state) &&
 311             !list_empty(&dev->disco_list_node)) {
 312                 /* this rphy never saw sas_rphy_add */
 313                 list_del_init(&dev->disco_list_node);
 314                 sas_rphy_free(dev->rphy);
 315                 dev->rphy = NULL;
 316                 sas_unregister_common_dev(port, dev);
 317         }
 318
 319         if (dev->rphy && !test_and_set_bit(SAS_DEV_DESTROY, &dev->state)) {
 320                 sas_rphy_unlink(dev->rphy);
 321                 list_move_tail(&dev->disco_list_node, &port->destroy_list);
 322                 sas_discover_event(dev->port, DISCE_DESTRUCT);
 323         }
 324 }
 325
 326 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone)
 327 {
 328         struct domain_device *dev, *n;
 329
 330         list_for_each_entry_safe_reverse(dev, n, &port->dev_list, dev_list_node) {
 331                 if (gone)
 332                         set_bit(SAS_DEV_GONE, &dev->state);
 333                 sas_unregister_dev(port, dev);
 334         }
 335
 336         list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node)
 337                 sas_unregister_dev(port, dev);
 338
 339         port->port->rphy = NULL;
 340
 341 }
 342
 343 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port)
 344 {
 345         struct sas_ha_struct *ha;
 346         struct sas_phy *new_phy;
 347
 348         if (!dev)
 349                 return;
 350
 351         ha = dev->port->ha;
 352         new_phy = sas_port_get_phy(port);
 353
 354         /* pin and record last seen phy */
 355         spin_lock_irq(&ha->phy_port_lock);
 356         if (new_phy) {
 357                 sas_port_put_phy(dev->phy);
 358                 dev->phy = new_phy;
 359         }
 360         spin_unlock_irq(&ha->phy_port_lock);
 361 }
 362
 363 /* ---------- Discovery and Revalidation ---------- */
 364
 365 /**
 366  * sas_discover_domain -- discover the domain
 367  * @port: port to the domain of interest
 368  *
 369  * NOTE: this process _must_ quit (return) as soon as any connection
 370  * errors are encountered.  Connection recovery is done elsewhere.
 371  * Discover process only interrogates devices in order to discover the
 372  * domain.
 373  */
 374 static void sas_discover_domain(struct work_struct *work)
 375 {
 376         struct domain_device *dev;
 377         int error = 0;
 378         struct sas_discovery_event *ev = to_sas_discovery_event(work);
 379         struct asd_sas_port *port = ev->port;
 380
 381         clear_bit(DISCE_DISCOVER_DOMAIN, &port->disc.pending);
 382
 383         if (port->port_dev)
 384                 return;
 385
 386         error = sas_get_port_device(port);
 387         if (error)
 388                 return;
 389         dev = port->port_dev;
 390
 391         SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
 392                     task_pid_nr(current));
 393
 394         switch (dev->dev_type) {
 395         case SAS_END_DEV:
 396                 error = sas_discover_end_dev(dev);
 397                 break;
 398         case EDGE_DEV:
 399         case FANOUT_DEV:
 400                 error = sas_discover_root_expander(dev);
 401                 break;
 402         case SATA_DEV:
 403         case SATA_PM:
 404 #ifdef CONFIG_SCSI_SAS_ATA
 405                 error = sas_discover_sata(dev);
 406                 break;
 407 #else
 408                 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
 409                 /* Fall through */
 410 #endif
 411         default:
 412                 error = -ENXIO;
 413                 SAS_DPRINTK("unhandled device %d\n", dev->dev_type);
 414                 break;
 415         }
 416
 417         if (error) {
 418                 sas_rphy_free(dev->rphy);
 419                 dev->rphy = NULL;
 420
 421                 list_del_init(&dev->disco_list_node);
 422                 spin_lock_irq(&port->dev_list_lock);
 423                 list_del_init(&dev->dev_list_node);
 424                 spin_unlock_irq(&port->dev_list_lock);
 425
 426                 sas_put_device(dev);
 427                 port->port_dev = NULL;
 428         }
 429
 430         SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
 431                     task_pid_nr(current), error);
 432 }
 433
 434 static void sas_revalidate_domain(struct work_struct *work)
 435 {
 436         int res = 0;
 437         struct sas_discovery_event *ev = to_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 sas_work *sw)
 466 {
 467         /* chained work is not subject to SA_HA_DRAINING or
 468          * SAS_HA_REGISTERED, because it is either submitted in the
 469          * workqueue, or known to be submitted from a context that is
 470          * not racing against draining
 471          */
 472         scsi_queue_work(ha->core.shost, &sw->work);
 473 }
 474
 475 static void sas_chain_event(int event, unsigned long *pending,
 476                             struct sas_work *sw,
 477                             struct sas_ha_struct *ha)
 478 {
 479         if (!test_and_set_bit(event, pending)) {
 480                 unsigned long flags;
 481
 482                 spin_lock_irqsave(&ha->state_lock, flags);
 483                 sas_chain_work(ha, sw);
 484                 spin_unlock_irqrestore(&ha->state_lock, flags);
 485         }
 486 }
 487
 488 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
 489 {
 490         struct sas_discovery *disc;
 491
 492         if (!port)
 493                 return 0;
 494         disc = &port->disc;
 495
 496         BUG_ON(ev >= DISC_NUM_EVENTS);
 497
 498         sas_chain_event(ev, &disc->pending, &disc->disc_work[ev].work, port->ha);
 499
 500         return 0;
 501 }
 502
 503 /**
 504  * sas_init_disc -- initialize the discovery struct in the port
 505  * @port: pointer to struct port
 506  *
 507  * Called when the ports are being initialized.
 508  */
 509 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
 510 {
 511         int i;
 512
 513         static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
 514                 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
 515                 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
 516                 [DISCE_PROBE] = sas_probe_devices,
 517                 [DISCE_DESTRUCT] = sas_destruct_devices,
 518         };
 519
 520         disc->pending = 0;
 521         for (i = 0; i < DISC_NUM_EVENTS; i++) {
 522                 INIT_SAS_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
 523                 disc->disc_work[i].port = port;
 524         }
 525 }