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_internal.h"
  34
  35 /* ---------- Basic task processing for discovery purposes ---------- */
  36
  37 void sas_init_dev(struct domain_device *dev)
  38 {
  39         switch (dev->dev_type) {
  40         case SAS_END_DEV:
  41                 break;
  42         case EDGE_DEV:
  43         case FANOUT_DEV:
  44                 INIT_LIST_HEAD(&dev->ex_dev.children);
  45                 break;
  46         case SATA_DEV:
  47         case SATA_PM:
  48         case SATA_PM_PORT:
  49                 INIT_LIST_HEAD(&dev->sata_dev.children);
  50                 break;
  51         default:
  52                 break;
  53         }
  54 }
  55
  56 /* ---------- Domain device discovery ---------- */
  57
  58 /**
  59  * sas_get_port_device -- Discover devices which caused port creation
  60  * @port: pointer to struct sas_port of interest
  61  *
  62  * Devices directly attached to a HA port, have no parent.  This is
  63  * how we know they are (domain) "root" devices.  All other devices
  64  * do, and should have their "parent" pointer set appropriately as
  65  * soon as a child device is discovered.
  66  */
  67 static int sas_get_port_device(struct asd_sas_port *port)
  68 {
  69         unsigned long flags;
  70         struct asd_sas_phy *phy;
  71         struct sas_rphy *rphy;
  72         struct domain_device *dev;
  73
  74         dev = sas_alloc_device();
  75         if (!dev)
  76                 return -ENOMEM;
  77
  78         spin_lock_irqsave(&port->phy_list_lock, flags);
  79         if (list_empty(&port->phy_list)) {
  80                 spin_unlock_irqrestore(&port->phy_list_lock, flags);
  81                 sas_put_device(dev);
  82                 return -ENODEV;
  83         }
  84         phy = container_of(port->phy_list.next, struct asd_sas_phy, port_phy_el);
  85         spin_lock(&phy->frame_rcvd_lock);
  86         memcpy(dev->frame_rcvd, phy->frame_rcvd, min(sizeof(dev->frame_rcvd),
  87                                              (size_t)phy->frame_rcvd_size));
  88         spin_unlock(&phy->frame_rcvd_lock);
  89         spin_unlock_irqrestore(&port->phy_list_lock, flags);
  90
  91         if (dev->frame_rcvd[0] == 0x34 && port->oob_mode == SATA_OOB_MODE) {
  92                 struct dev_to_host_fis *fis =
  93                         (struct dev_to_host_fis *) dev->frame_rcvd;
  94                 if (fis->interrupt_reason == 1 && fis->lbal == 1 &&
  95                     fis->byte_count_low==0x69 && fis->byte_count_high == 0x96
  96                     && (fis->device & ~0x10) == 0)
  97                         dev->dev_type = SATA_PM;
  98                 else
  99                         dev->dev_type = SATA_DEV;
 100                 dev->tproto = SAS_PROTOCOL_SATA;
 101         } else {
 102                 struct sas_identify_frame *id =
 103                         (struct sas_identify_frame *) dev->frame_rcvd;
 104                 dev->dev_type = id->dev_type;
 105                 dev->iproto = id->initiator_bits;
 106                 dev->tproto = id->target_bits;
 107         }
 108
 109         sas_init_dev(dev);
 110
 111         switch (dev->dev_type) {
 112         case SAS_END_DEV:
 113         case SATA_DEV:
 114                 rphy = sas_end_device_alloc(port->port);
 115                 break;
 116         case EDGE_DEV:
 117                 rphy = sas_expander_alloc(port->port,
 118                                           SAS_EDGE_EXPANDER_DEVICE);
 119                 break;
 120         case FANOUT_DEV:
 121                 rphy = sas_expander_alloc(port->port,
 122                                           SAS_FANOUT_EXPANDER_DEVICE);
 123                 break;
 124         default:
 125                 printk("ERROR: Unidentified device type %d\n", dev->dev_type);
 126                 rphy = NULL;
 127                 break;
 128         }
 129
 130         if (!rphy) {
 131                 sas_put_device(dev);
 132                 return -ENODEV;
 133         }
 134         rphy->identify.phy_identifier = phy->phy->identify.phy_identifier;
 135         memcpy(dev->sas_addr, port->attached_sas_addr, SAS_ADDR_SIZE);
 136         sas_fill_in_rphy(dev, rphy);
 137         sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
 138         port->port_dev = dev;
 139         dev->port = port;
 140         dev->linkrate = port->linkrate;
 141         dev->min_linkrate = port->linkrate;
 142         dev->max_linkrate = port->linkrate;
 143         dev->pathways = port->num_phys;
 144         memset(port->disc.fanout_sas_addr, 0, SAS_ADDR_SIZE);
 145         memset(port->disc.eeds_a, 0, SAS_ADDR_SIZE);
 146         memset(port->disc.eeds_b, 0, SAS_ADDR_SIZE);
 147         port->disc.max_level = 0;
 148
 149         dev->rphy = rphy;
 150         spin_lock_irq(&port->dev_list_lock);
 151         list_add_tail(&dev->dev_list_node, &port->dev_list);
 152         spin_unlock_irq(&port->dev_list_lock);
 153
 154         return 0;
 155 }
 156
 157 /* ---------- Discover and Revalidate ---------- */
 158
 159 int sas_notify_lldd_dev_found(struct domain_device *dev)
 160 {
 161         int res = 0;
 162         struct sas_ha_struct *sas_ha = dev->port->ha;
 163         struct Scsi_Host *shost = sas_ha->core.shost;
 164         struct sas_internal *i = to_sas_internal(shost->transportt);
 165
 166         if (i->dft->lldd_dev_found) {
 167                 res = i->dft->lldd_dev_found(dev);
 168                 if (res) {
 169                         printk("sas: driver on pcidev %s cannot handle "
 170                                "device %llx, error:%d\n",
 171                                dev_name(sas_ha->dev),
 172                                SAS_ADDR(dev->sas_addr), res);
 173                 }
 174                 kref_get(&dev->kref);
 175         }
 176         return res;
 177 }
 178
 179
 180 void sas_notify_lldd_dev_gone(struct domain_device *dev)
 181 {
 182         struct sas_ha_struct *sas_ha = dev->port->ha;
 183         struct Scsi_Host *shost = sas_ha->core.shost;
 184         struct sas_internal *i = to_sas_internal(shost->transportt);
 185
 186         if (i->dft->lldd_dev_gone) {
 187                 i->dft->lldd_dev_gone(dev);
 188                 sas_put_device(dev);
 189         }
 190 }
 191
 192 /* ---------- Common/dispatchers ---------- */
 193
 194
 195 /**
 196  * sas_discover_end_dev -- discover an end device (SSP, etc)
 197  * @end: pointer to domain device of interest
 198  *
 199  * See comment in sas_discover_sata().
 200  */
 201 int sas_discover_end_dev(struct domain_device *dev)
 202 {
 203         int res;
 204
 205         res = sas_notify_lldd_dev_found(dev);
 206         if (res)
 207                 goto out_err2;
 208
 209         res = sas_rphy_add(dev->rphy);
 210         if (res)
 211                 goto out_err;
 212
 213         return 0;
 214
 215 out_err:
 216         sas_notify_lldd_dev_gone(dev);
 217 out_err2:
 218         return res;
 219 }
 220
 221 /* ---------- Device registration and unregistration ---------- */
 222
 223 void sas_free_device(struct kref *kref)
 224 {
 225         struct domain_device *dev = container_of(kref, typeof(*dev), kref);
 226
 227         if (dev->parent)
 228                 sas_put_device(dev->parent);
 229
 230         /* remove the phys and ports, everything else should be gone */
 231         if (dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV)
 232                 kfree(dev->ex_dev.ex_phy);
 233
 234         kfree(dev);
 235 }
 236
 237 static void sas_unregister_common_dev(struct asd_sas_port *port, struct domain_device *dev)
 238 {
 239         sas_notify_lldd_dev_gone(dev);
 240         if (!dev->parent)
 241                 dev->port->port_dev = NULL;
 242         else
 243                 list_del_init(&dev->siblings);
 244
 245         spin_lock_irq(&port->dev_list_lock);
 246         list_del_init(&dev->dev_list_node);
 247         spin_unlock_irq(&port->dev_list_lock);
 248
 249         sas_put_device(dev);
 250 }
 251
 252 void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev)
 253 {
 254         if (dev->rphy) {
 255                 sas_remove_children(&dev->rphy->dev);
 256                 sas_rphy_delete(dev->rphy);
 257                 dev->rphy = NULL;
 258         }
 259         sas_unregister_common_dev(port, dev);
 260 }
 261
 262 void sas_unregister_domain_devices(struct asd_sas_port *port)
 263 {
 264         struct domain_device *dev, *n;
 265
 266         list_for_each_entry_safe_reverse(dev, n, &port->dev_list, dev_list_node)
 267                 sas_unregister_dev(port, dev);
 268
 269         port->port->rphy = NULL;
 270
 271 }
 272
 273 /* ---------- Discovery and Revalidation ---------- */
 274
 275 /**
 276  * sas_discover_domain -- discover the domain
 277  * @port: port to the domain of interest
 278  *
 279  * NOTE: this process _must_ quit (return) as soon as any connection
 280  * errors are encountered.  Connection recovery is done elsewhere.
 281  * Discover process only interrogates devices in order to discover the
 282  * domain.
 283  */
 284 static void sas_discover_domain(struct work_struct *work)
 285 {
 286         struct domain_device *dev;
 287         int error = 0;
 288         struct sas_discovery_event *ev =
 289                 container_of(work, struct sas_discovery_event, work);
 290         struct asd_sas_port *port = ev->port;
 291
 292         sas_begin_event(DISCE_DISCOVER_DOMAIN, &port->disc.disc_event_lock,
 293                         &port->disc.pending);
 294
 295         if (port->port_dev)
 296                 return;
 297
 298         error = sas_get_port_device(port);
 299         if (error)
 300                 return;
 301         dev = port->port_dev;
 302
 303         SAS_DPRINTK("DOING DISCOVERY on port %d, pid:%d\n", port->id,
 304                     task_pid_nr(current));
 305
 306         switch (dev->dev_type) {
 307         case SAS_END_DEV:
 308                 error = sas_discover_end_dev(dev);
 309                 break;
 310         case EDGE_DEV:
 311         case FANOUT_DEV:
 312                 error = sas_discover_root_expander(dev);
 313                 break;
 314         case SATA_DEV:
 315         case SATA_PM:
 316 #ifdef CONFIG_SCSI_SAS_ATA
 317                 error = sas_discover_sata(dev);
 318                 break;
 319 #else
 320                 SAS_DPRINTK("ATA device seen but CONFIG_SCSI_SAS_ATA=N so cannot attach\n");
 321                 /* Fall through */
 322 #endif
 323         default:
 324                 error = -ENXIO;
 325                 SAS_DPRINTK("unhandled device %d\n", dev->dev_type);
 326                 break;
 327         }
 328
 329         if (error) {
 330                 sas_rphy_free(dev->rphy);
 331                 dev->rphy = NULL;
 332
 333                 spin_lock_irq(&port->dev_list_lock);
 334                 list_del_init(&dev->dev_list_node);
 335                 spin_unlock_irq(&port->dev_list_lock);
 336
 337                 sas_put_device(dev);
 338                 port->port_dev = NULL;
 339         }
 340
 341         SAS_DPRINTK("DONE DISCOVERY on port %d, pid:%d, result:%d\n", port->id,
 342                     task_pid_nr(current), error);
 343 }
 344
 345 static void sas_revalidate_domain(struct work_struct *work)
 346 {
 347         int res = 0;
 348         struct sas_discovery_event *ev =
 349                 container_of(work, struct sas_discovery_event, work);
 350         struct asd_sas_port *port = ev->port;
 351
 352         sas_begin_event(DISCE_REVALIDATE_DOMAIN, &port->disc.disc_event_lock,
 353                         &port->disc.pending);
 354
 355         SAS_DPRINTK("REVALIDATING DOMAIN on port %d, pid:%d\n", port->id,
 356                     task_pid_nr(current));
 357         if (port->port_dev)
 358                 res = sas_ex_revalidate_domain(port->port_dev);
 359
 360         SAS_DPRINTK("done REVALIDATING DOMAIN on port %d, pid:%d, res 0x%x\n",
 361                     port->id, task_pid_nr(current), res);
 362 }
 363
 364 /* ---------- Events ---------- */
 365
 366 int sas_discover_event(struct asd_sas_port *port, enum discover_event ev)
 367 {
 368         struct sas_discovery *disc;
 369
 370         if (!port)
 371                 return 0;
 372         disc = &port->disc;
 373
 374         BUG_ON(ev >= DISC_NUM_EVENTS);
 375
 376         sas_queue_event(ev, &disc->disc_event_lock, &disc->pending,
 377                         &disc->disc_work[ev].work, port->ha);
 378
 379         return 0;
 380 }
 381
 382 /**
 383  * sas_init_disc -- initialize the discovery struct in the port
 384  * @port: pointer to struct port
 385  *
 386  * Called when the ports are being initialized.
 387  */
 388 void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port)
 389 {
 390         int i;
 391
 392         static const work_func_t sas_event_fns[DISC_NUM_EVENTS] = {
 393                 [DISCE_DISCOVER_DOMAIN] = sas_discover_domain,
 394                 [DISCE_REVALIDATE_DOMAIN] = sas_revalidate_domain,
 395         };
 396
 397         spin_lock_init(&disc->disc_event_lock);
 398         disc->pending = 0;
 399         for (i = 0; i < DISC_NUM_EVENTS; i++) {
 400                 INIT_WORK(&disc->disc_work[i].work, sas_event_fns[i]);
 401                 disc->disc_work[i].port = port;
 402         }
 403 }