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                 INIT_LIST_HEAD(&dev->sata_dev.children);
  52                 break;
  53         default:
  54                 break;
  55         }
  56 }
  57
  58 /* ---------- Domain device discovery ---------- */
  59
  60 /**
  61  * sas_get_port_device -- Discover devices which caused port creation
  62  * @port: pointer to struct sas_port of interest
  63  *
  64  * Devices directly attached to a HA port, have no parent.  This is
  65  * how we know they are (domain) "root" devices.  All other devices
  66  * do, and should have their "parent" pointer set appropriately as
  67  * soon as a child device is discovered.
  68  */
  69 static int sas_get_port_device(struct asd_sas_port *port)
  70 {
  71         unsigned long flags;
  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_irqsave(&port->phy_list_lock, flags);
  81         if (list_empty(&port->phy_list)) {
  82                 spin_unlock_irqrestore(&port->phy_list_lock, flags);
  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_irqrestore(&port->phy_list_lock, flags);
  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         rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
 137         memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
 138         sas_fill_in_rphy(dev, rphy);
 139         sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
 140         port->port_dev = dev;
 141         dev->port = port;
 142         dev->linkrate = port->linkrate;
 143         dev->min_linkrate = port->linkrate;
 144         dev->max_linkrate = port->linkrate;
 145         dev->pathways = port->num_phys;
 146         memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
 147         memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
 148         memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
 149         port->disc.max_level = 0;
 150         sas_device_set_phy(dev, port->port);
 151
 152         dev->rphy = rphy;
 153
 154         if (dev_is_sata(dev))
 155                 list_add_tail(&dev->disco_list_node, &port->disco_list);
 156         else {
 157                 spin_lock_irq(&port->dev_list_lock);
 158                 list_add_tail(&dev->dev_list_node, &port->dev_list);
 159                 spin_unlock_irq(&port->dev_list_lock);
 160         }
 161
 162         return 0;
 163 }
 164
 165 /* ---------- Discover and Revalidate ---------- */
 166
 167 int sas_notify_lldd_dev_found(struct domain_device *dev)
 168 {
 169         int res = 0;
 170         struct sas_ha_struct *sas_ha = dev->port->ha;
 171         struct Scsi_Host *shost = sas_ha->core.shost;
 172         struct sas_internal *i = to_sas_internal(shost->transportt);
 173
 174         if (i->dft->lldd_dev_found) {
 175                 res = i->dft->lldd_dev_found(dev);
 176                 if (res) {
 177                         printk("sas: driver on pcidev %s cannot handle "
 178                                "device %llx, error:%d\n",
 179                                dev_name(sas_ha->dev),
 180                                SAS_ADDR(dev->sas_addr), res);
 181                 }
 182                 kref_get(&dev->kref);
 183         }
 184         return res;
 185 }
 186
 187
 188 void sas_notify_lldd_dev_gone(struct domain_device *dev)
 189 {
 190         struct sas_ha_struct *sas_ha = dev->port->ha;
 191         struct Scsi_Host *shost = sas_ha->core.shost;
 192         struct sas_internal *i = to_sas_internal(shost->transportt);
 193
 194         if (i->dft->lldd_dev_gone) {
 195                 i->dft->lldd_dev_gone(dev);
 196                 sas_put_device(dev);
 197         }
 198 }
 199
 200 /* ---------- Common/dispatchers ---------- */
 201
 202
 203 /**
 204  * sas_discover_end_dev -- discover an end device (SSP, etc)
 205  * @end: pointer to domain device of interest
 206  *
 207  * See comment in sas_discover_sata().
 208  */
 209 int sas_discover_end_dev(struct domain_device *dev)
 210 {
 211         int res;
 212
 213         res = sas_notify_lldd_dev_found(dev);
 214         if (res)
 215                 goto out_err2;
 216
 217         res = sas_rphy_add(dev->rphy);
 218         if (res)
 219                 goto out_err;
 220
 221         return 0;
 222
 223 out_err:
 224         sas_notify_lldd_dev_gone(dev);
 225 out_err2:
 226         return res;
 227 }
 228
 229 /* ---------- Device registration and unregistration ---------- */
 230
 231 void sas_free_device(struct kref *kref)
 232 {
 233         struct domain_device *dev = container_of(kref, typeof(*dev), kref);
 234
 235         if (dev->parent)
 236                 sas_put_device(dev->parent);
 237
 238         sas_port_put_phy(dev->phy);
 239         dev->phy = NULL;
 240
 241         /* remove the phys and ports, everything else should be gone */
 242         if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV)
 243                 kfree(dev->ex_dev.ex_phy);
 244
 245         if (dev_is_sata(dev) && dev->sata_dev.ap) {
 246                 ata_sas_port_destroy(dev->sata_dev.ap);
 247                 dev->sata_dev.ap = NULL;
 248         }
 249
 250         kfree(dev);
 251 }
 252
 253 static void sas_unregister_common_dev(struct asd_sas_port *port, struct domain_device *dev)
 254 {
 255         sas_notify_lldd_dev_gone(dev);
 256         if (!dev->parent)
 257                 dev->port->port_dev = NULL;
 258         else
 259                 list_del_init(&dev->siblings);
 260
 261         spin_lock_irq(&port->dev_list_lock);
 262         list_del_init(&dev->dev_list_node);
 263         spin_unlock_irq(&port->dev_list_lock);
 264
 265         sas_put_device(dev);
 266 }
 267
 268 static void sas_destruct_devices(struct work_struct *work)
 269 {
 270         struct domain_device *dev, *n;
 271         struct sas_discovery_event *ev =
 272                 container_of(work, struct sas_discovery_event, work);
 273         struct asd_sas_port *port = ev->port;
 274
 275         clear_bit(DISCE_DESTRUCT, &port->disc.pending);
 276
 277         list_for_each_entry_safe(dev, n, &port->destroy_list, disco_list_node) {
 278                 list_del_init(&dev->disco_list_node);
 279
 280                 sas_remove_children(&dev->rphy->dev);
 281                 sas_rphy_delete(dev->rphy);
 282                 dev->rphy = NULL;
 283                 sas_unregister_common_dev(port, dev);
 284
 285                 sas_put_device(dev);
 286         }
 287 }
 288
 289 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev)
 290 {
 291         if (!test_bit(SAS_DEV_DESTROY, &dev->state) &&
 292             !list_empty(&dev->disco_list_node)) {
 293                 /* this rphy never saw sas_rphy_add */
 294                 list_del_init(&dev->disco_list_node);
 295                 sas_rphy_free(dev->rphy);
 296                 dev->rphy = NULL;
 297                 sas_unregister_common_dev(port, dev);
 298         }
 299
 300         if (dev->rphy && !test_and_set_bit(SAS_DEV_DESTROY, &dev->state)) {
 301                 sas_rphy_unlink(dev->rphy);
 302                 list_move_tail(&dev->disco_list_node, &port->destroy_list);
 303                 sas_discover_event(dev->port, DISCE_DESTRUCT);
 304         }
 305 }
 306
 307 void sas_unregister_domain_devices(struct asd_sas_port *port, int gone)
 308 {
 309         struct domain_device *dev, *n;
 310
 311         list_for_each_entry_safe_reverse(dev, n, &port->dev_list, dev_list_node) {
 312                 if (gone)
 313                         set_bit(SAS_DEV_GONE, &dev->state);
 314                 sas_unregister_dev(port, dev);
 315         }
 316
 317         list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node)
 318                 sas_unregister_dev(port, dev);
 319
 320         port->port->rphy = NULL;
 321
 322 }
 323
 324 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port)
 325 {
 326         struct sas_ha_struct *ha;
 327         struct sas_phy *new_phy;
 328
 329         if (!dev)
 330                 return;
 331
 332         ha = dev->port->ha;
 333         new_phy = sas_port_get_phy(port);
 334
 335         /* pin and record last seen phy */
 336         spin_lock_irq(&ha->phy_port_lock);
 337         if (new_phy) {
 338                 sas_port_put_phy(dev->phy);
 339                 dev->phy = new_phy;
 340         }
 341         spin_unlock_irq(&ha->phy_port_lock);
 342 }
 343
 344 /* ---------- Discovery and Revalidation ---------- */
 345
 346 /**
 347  * sas_discover_domain -- discover the domain
 348  * @port: port to the domain of interest
 349  *
 350  * NOTE: this process _must_ quit (return) as soon as any connection
 351  * errors are encountered.  Connection recovery is done elsewhere.
 352  * Discover process only interrogates devices in order to discover the
 353  * domain.
 354  */
 355 static void sas_discover_domain(struct work_struct *work)
 356 {
 357         struct domain_device *dev;
 358         int error = 0;
 359         struct sas_discovery_event *ev =
 360                 container_of(work, struct sas_discovery_event, work);
 361         struct asd_sas_port *port = ev->port;
 362
 363         clear_bit(DISCE_DISCOVER_DOMAIN, &port->disc.pending);
 364
 365         if (port->port_dev)
 366                 return;
 367
 368         error = sas_get_port_device(port);
 369         if (error)
 370                 return;
 371         dev = port->port_dev;
 372
 373         SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
 374                     task_pid_nr(current));
 375
 376         switch (dev->dev_type) {
 377         case SAS_END_DEV:
 378                 error = sas_discover_end_dev(dev);
 379                 break;
 380         case EDGE_DEV:
 381         case FANOUT_DEV:
 382                 error = sas_discover_root_expander(dev);
 383                 break;
 384         case SATA_DEV:
 385         case SATA_PM:
 386 #ifdef CONFIG_SCSI_SAS_ATA
 387                 error = sas_discover_sata(dev);
 388                 break;
 389 #else
 390                 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
 391                 /* Fall through */
 392 #endif
 393         default:
 394                 error = -ENXIO;
 395                 SAS_DPRINTK("unhandled device %d\n", dev->dev_type);
 396                 break;
 397         }
 398
 399         if (error) {
 400                 sas_rphy_free(dev->rphy);
 401                 dev->rphy = NULL;
 402
 403                 list_del_init(&dev->disco_list_node);
 404                 spin_lock_irq(&port->dev_list_lock);
 405                 list_del_init(&dev->dev_list_node);
 406                 spin_unlock_irq(&port->dev_list_lock);
 407
 408                 sas_put_device(dev);
 409                 port->port_dev = NULL;
 410         }
 411
 412         SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
 413                     task_pid_nr(current), error);
 414 }
 415
 416 static void sas_revalidate_domain(struct work_struct *work)
 417 {
 418         int res = 0;
 419         struct sas_discovery_event *ev =
 420                 container_of(work, struct sas_discovery_event, work);
 421         struct asd_sas_port *port = ev->port;
 422         struct sas_ha_struct *ha = port->ha;
 423
 424         /* prevent revalidation from finding sata links in recovery */
 425         mutex_lock(&ha->disco_mutex);
 426         if (test_bit(SAS_HA_ATA_EH_ACTIVE, &ha->state)) {
 427                 SAS_DPRINTK("REVALIDATION DEFERRED on port %d, pid:%d\n",
 428                             port->id, task_pid_nr(current));
 429                 goto out;
 430         }
 431
 432         clear_bit(DISCE_REVALIDATE_DOMAIN, &port->disc.pending);
 433
 434         SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port->id,
 435                     task_pid_nr(current));
 436
 437         if (port->port_dev)
 438                 res = sas_ex_revalidate_domain(port->port_dev);
 439
 440         SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
 441                     port->id, task_pid_nr(current), res);
 442  out:
 443         mutex_unlock(&ha->disco_mutex);
 444 }
 445
 446 /* ---------- Events ---------- */
 447
 448 static void sas_chain_work(struct sas_ha_struct *ha, struct work_struct *work)
 449 {
 450         /* chained work is not subject to SA_HA_DRAINING or SAS_HA_REGISTERED */
 451         scsi_queue_work(ha->core.shost, work);
 452 }
 453
 454 static void sas_chain_event(int event, unsigned long *pending,
 455                             struct work_struct *work,
 456                             struct sas_ha_struct *ha)
 457 {
 458         if (!test_and_set_bit(event, pending)) {
 459                 unsigned long flags;
 460
 461                 spin_lock_irqsave(&ha->state_lock, flags);
 462                 sas_chain_work(ha, work);
 463                 spin_unlock_irqrestore(&ha->state_lock, flags);
 464         }
 465 }
 466
 467 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
 468 {
 469         struct sas_discovery *disc;
 470
 471         if (!port)
 472                 return 0;
 473         disc = &port->disc;
 474
 475         BUG_ON(ev >= DISC_NUM_EVENTS);
 476
 477         sas_chain_event(ev, &disc->pending, &disc->disc_work[ev].work, port->ha);
 478
 479         return 0;
 480 }
 481
 482 /**
 483  * sas_init_disc -- initialize the discovery struct in the port
 484  * @port: pointer to struct port
 485  *
 486  * Called when the ports are being initialized.
 487  */
 488 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
 489 {
 490         int i;
 491
 492         static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
 493                 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
 494                 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
 495                 [DISCE_PROBE] = sas_probe_sata,
 496                 [DISCE_DESTRUCT] = sas_destruct_devices,
 497         };
 498
 499         disc->pending = 0;
 500         for (i = 0; i < DISC_NUM_EVENTS; i++) {
 501                 INIT_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
 502                 disc->disc_work[i].port = port;
 503         }
 504 }