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