drivers/scsi/isci/init.c

   1 /*
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  * redistributing this file, you may do so under either license.
   4  *
   5  * GPL LICENSE SUMMARY
   6  *
   7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * BSD LICENSE
  25  *
  26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
  27  * All rights reserved.
  28  *
  29  * Redistribution and use in source and binary forms, with or without
  30  * modification, are permitted provided that the following conditions
  31  * are met:
  32  *
  33  *   * Redistributions of source code must retain the above copyright
  34  *     notice, this list of conditions and the following disclaimer.
  35  *   * Redistributions in binary form must reproduce the above copyright
  36  *     notice, this list of conditions and the following disclaimer in
  37  *     the documentation and/or other materials provided with the
  38  *     distribution.
  39  *   * Neither the name of Intel Corporation nor the names of its
  40  *     contributors may be used to endorse or promote products derived
  41  *     from this software without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  54  */
  55
  56 #include <linux/kernel.h>
  57 #include <linux/init.h>
  58 #include <linux/module.h>
  59 #include <linux/firmware.h>
  60 #include <linux/efi.h>
  61 #include <asm/string.h>
  62 #include "isci.h"
  63 #include "task.h"
  64 #include "sci_controller_constants.h"
  65 #include "scic_remote_device.h"
  66 #include "sci_environment.h"
  67 #include "probe_roms.h"
  68
  69 static struct scsi_transport_template *isci_transport_template;
  70
  71 static DEFINE_PCI_DEVICE_TABLE(isci_id_table) = {
  72         { PCI_VDEVICE(INTEL, 0x1D61),},
  73         { PCI_VDEVICE(INTEL, 0x1D63),},
  74         { PCI_VDEVICE(INTEL, 0x1D65),},
  75         { PCI_VDEVICE(INTEL, 0x1D67),},
  76         { PCI_VDEVICE(INTEL, 0x1D69),},
  77         { PCI_VDEVICE(INTEL, 0x1D6B),},
  78         { PCI_VDEVICE(INTEL, 0x1D60),},
  79         { PCI_VDEVICE(INTEL, 0x1D62),},
  80         { PCI_VDEVICE(INTEL, 0x1D64),},
  81         { PCI_VDEVICE(INTEL, 0x1D66),},
  82         { PCI_VDEVICE(INTEL, 0x1D68),},
  83         { PCI_VDEVICE(INTEL, 0x1D6A),},
  84         {}
  85 };
  86
  87 struct isci_firmware *isci_firmware;
  88
  89 static int __devinit isci_pci_probe(
  90         struct pci_dev *pdev,
  91         const struct pci_device_id *device_id_p);
  92
  93 static void __devexit isci_pci_remove(struct pci_dev *pdev);
  94
  95 MODULE_DEVICE_TABLE(pci, isci_id_table);
  96
  97 static struct pci_driver isci_pci_driver = {
  98         .name           = DRV_NAME,
  99         .id_table       = isci_id_table,
 100         .probe          = isci_pci_probe,
 101         .remove         = __devexit_p(isci_pci_remove),
 102 };
 103
 104 /* linux isci specific settings */
 105
 106 #if defined(CONFIG_PBG_HBA_A0)
 107 int isci_si_rev = ISCI_SI_REVA0;
 108 #elif defined(CONFIG_PBG_HBA_A2)
 109 int isci_si_rev = ISCI_SI_REVA2;
 110 #else
 111 int isci_si_rev = ISCI_SI_REVB0;
 112 #endif
 113 module_param(isci_si_rev, int, S_IRUGO | S_IWUSR);
 114 MODULE_PARM_DESC(isci_si_rev, "override default si rev (0: A0 1: A2 2: B0)");
 115
 116 static struct scsi_host_template isci_sht = {
 117
 118         .module                         = THIS_MODULE,
 119         .name                           = DRV_NAME,
 120         .proc_name                      = DRV_NAME,
 121         .queuecommand                   = sas_queuecommand,
 122         .target_alloc                   = sas_target_alloc,
 123         .slave_configure                = sas_slave_configure,
 124         .slave_destroy                  = sas_slave_destroy,
 125         .scan_finished                  = isci_host_scan_finished,
 126         .scan_start                     = isci_host_scan_start,
 127         .change_queue_depth             = sas_change_queue_depth,
 128         .change_queue_type              = sas_change_queue_type,
 129         .bios_param                     = sas_bios_param,
 130         .can_queue                      = ISCI_CAN_QUEUE_VAL,
 131         .cmd_per_lun                    = 1,
 132         .this_id                        = -1,
 133         .sg_tablesize                   = SG_ALL,
 134         .max_sectors                    = SCSI_DEFAULT_MAX_SECTORS,
 135         .use_clustering                 = ENABLE_CLUSTERING,
 136         .eh_device_reset_handler        = sas_eh_device_reset_handler,
 137         .eh_bus_reset_handler           = isci_bus_reset_handler,
 138         .slave_alloc                    = sas_slave_alloc,
 139         .target_destroy                 = sas_target_destroy,
 140         .ioctl                          = sas_ioctl,
 141 };
 142
 143 static struct sas_domain_function_template isci_transport_ops  = {
 144
 145         /* The class calls these to notify the LLDD of an event. */
 146         .lldd_port_formed       = isci_port_formed,
 147         .lldd_port_deformed     = isci_port_deformed,
 148
 149         /* The class calls these when a device is found or gone. */
 150         .lldd_dev_found         = isci_remote_device_found,
 151         .lldd_dev_gone          = isci_remote_device_gone,
 152
 153         .lldd_execute_task      = isci_task_execute_task,
 154         /* Task Management Functions. Must be called from process context. */
 155         .lldd_abort_task        = isci_task_abort_task,
 156         .lldd_abort_task_set    = isci_task_abort_task_set,
 157         .lldd_clear_aca         = isci_task_clear_aca,
 158         .lldd_clear_task_set    = isci_task_clear_task_set,
 159         .lldd_I_T_nexus_reset   = isci_task_I_T_nexus_reset,
 160         .lldd_lu_reset          = isci_task_lu_reset,
 161         .lldd_query_task        = isci_task_query_task,
 162
 163         /* Port and Adapter management */
 164         .lldd_clear_nexus_port  = isci_task_clear_nexus_port,
 165         .lldd_clear_nexus_ha    = isci_task_clear_nexus_ha,
 166
 167         /* Phy management */
 168         .lldd_control_phy       = isci_phy_control,
 169 };
 170
 171
 172 /******************************************************************************
 173 * P R O T E C T E D  M E T H O D S
 174 ******************************************************************************/
 175
 176
 177
 178 /**
 179  * isci_register_sas_ha() - This method initializes various lldd
 180  *    specific members of the sas_ha struct and calls the libsas
 181  *    sas_register_ha() function.
 182  * @isci_host: This parameter specifies the lldd specific wrapper for the
 183  *    libsas sas_ha struct.
 184  *
 185  * This method returns an error code indicating sucess or failure. The user
 186  * should check for possible memory allocation error return otherwise, a zero
 187  * indicates success.
 188  */
 189 static int isci_register_sas_ha(struct isci_host *isci_host)
 190 {
 191         int i;
 192         struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
 193         struct asd_sas_phy **sas_phys;
 194         struct asd_sas_port **sas_ports;
 195
 196         sas_phys = devm_kzalloc(&isci_host->pdev->dev,
 197                                 SCI_MAX_PHYS * sizeof(void *),
 198                                 GFP_KERNEL);
 199         if (!sas_phys)
 200                 return -ENOMEM;
 201
 202         sas_ports = devm_kzalloc(&isci_host->pdev->dev,
 203                                  SCI_MAX_PORTS * sizeof(void *),
 204                                  GFP_KERNEL);
 205         if (!sas_ports)
 206                 return -ENOMEM;
 207
 208         /*----------------- Libsas Initialization Stuff----------------------
 209          * Set various fields in the sas_ha struct:
 210          */
 211
 212         sas_ha->sas_ha_name = DRV_NAME;
 213         sas_ha->lldd_module = THIS_MODULE;
 214         sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
 215
 216         /* set the array of phy and port structs.  */
 217         for (i = 0; i < SCI_MAX_PHYS; i++) {
 218                 sas_phys[i] = &(isci_host->phys[i].sas_phy);
 219                 sas_ports[i] = &(isci_host->sas_ports[i]);
 220         }
 221
 222         sas_ha->sas_phy  = sas_phys;
 223         sas_ha->sas_port = sas_ports;
 224         sas_ha->num_phys = SCI_MAX_PHYS;
 225
 226         sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL;
 227         sas_ha->lldd_max_execute_num = 1;
 228         sas_ha->strict_wide_ports = 1;
 229
 230         sas_register_ha(sas_ha);
 231
 232         return 0;
 233 }
 234
 235 static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
 236 {
 237         struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
 238         struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
 239         struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
 240
 241         return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
 242 }
 243
 244 static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
 245
 246 static void isci_unregister(struct isci_host *isci_host)
 247 {
 248         struct Scsi_Host *shost;
 249
 250         if (!isci_host)
 251                 return;
 252
 253         shost = isci_host->shost;
 254         device_remove_file(&shost->shost_dev, &dev_attr_isci_id);
 255
 256         sas_unregister_ha(&isci_host->sas_ha);
 257
 258         sas_remove_host(isci_host->shost);
 259         scsi_remove_host(isci_host->shost);
 260         scsi_host_put(isci_host->shost);
 261 }
 262
 263 static int __devinit isci_pci_init(struct pci_dev *pdev)
 264 {
 265         int err, bar_num, bar_mask;
 266         void __iomem * const *iomap;
 267
 268         err = pcim_enable_device(pdev);
 269         if (err) {
 270                 dev_err(&pdev->dev,
 271                         "failed enable PCI device %s!\n",
 272                         pci_name(pdev));
 273                 return err;
 274         }
 275
 276         for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
 277                 bar_mask |= 1 << (bar_num * 2);
 278
 279         err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
 280         if (err)
 281                 return err;
 282
 283         iomap = pcim_iomap_table(pdev);
 284         if (!iomap)
 285                 return -ENOMEM;
 286
 287         pci_set_master(pdev);
 288
 289         err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
 290         if (err) {
 291                 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
 292                 if (err)
 293                         return err;
 294         }
 295
 296         err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
 297         if (err) {
 298                 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
 299                 if (err)
 300                         return err;
 301         }
 302
 303         return 0;
 304 }
 305
 306 static int num_controllers(struct pci_dev *pdev)
 307 {
 308         /* bar size alone can tell us if we are running with a dual controller
 309          * part, no need to trust revision ids that might be under broken firmware
 310          * control
 311          */
 312         resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
 313         resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
 314
 315         if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
 316             smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
 317                 return SCI_MAX_CONTROLLERS;
 318         else
 319                 return 1;
 320 }
 321
 322 static int isci_setup_interrupts(struct pci_dev *pdev)
 323 {
 324         int err, i, num_msix;
 325         struct isci_pci_info *pci_info = to_pci_info(pdev);
 326
 327         /*
 328          *  Determine the number of vectors associated with this
 329          *  PCI function.
 330          */
 331         num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
 332
 333         for (i = 0; i < num_msix; i++)
 334                 pci_info->msix_entries[i].entry = i;
 335
 336         err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix);
 337         if (err)
 338                 goto intx;
 339
 340         for (i = 0; i < num_msix; i++) {
 341                 int id = i / SCI_NUM_MSI_X_INT;
 342                 struct msix_entry *msix = &pci_info->msix_entries[i];
 343                 struct isci_host *isci_host = pci_info->hosts[id];
 344                 irq_handler_t isr;
 345
 346                 /* odd numbered vectors are error interrupts */
 347                 if (i & 1)
 348                         isr = isci_error_isr;
 349                 else
 350                         isr = isci_msix_isr;
 351
 352                 BUG_ON(!isci_host);
 353
 354                 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
 355                                        DRV_NAME"-msix", isci_host);
 356                 if (!err)
 357                         continue;
 358
 359                 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
 360                 while (i--) {
 361                         id = i / SCI_NUM_MSI_X_INT;
 362                         isci_host = pci_info->hosts[id];
 363                         msix = &pci_info->msix_entries[i];
 364                         devm_free_irq(&pdev->dev, msix->vector, isci_host);
 365                 }
 366                 pci_disable_msix(pdev);
 367                 goto intx;
 368         }
 369
 370         return 0;
 371
 372  intx:
 373         err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
 374                                IRQF_SHARED, DRV_NAME"-intx", pdev);
 375
 376         return err;
 377 }
 378
 379 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
 380 {
 381         struct isci_host *isci_host;
 382         struct Scsi_Host *shost;
 383         int err;
 384
 385         isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host) +
 386                                  SCI_MAX_REMOTE_DEVICES *
 387                                  (sizeof(struct isci_remote_device) +
 388                                   scic_remote_device_get_object_size()), GFP_KERNEL);
 389         if (!isci_host)
 390                 return NULL;
 391
 392         isci_host->pdev = pdev;
 393         isci_host->id = id;
 394
 395         shost = scsi_host_alloc(&isci_sht, sizeof(void *));
 396         if (!shost)
 397                 return NULL;
 398         isci_host->shost = shost;
 399
 400         err = isci_host_init(isci_host);
 401         if (err)
 402                 goto err_shost;
 403
 404         SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha;
 405         isci_host->sas_ha.core.shost = shost;
 406         shost->transportt = isci_transport_template;
 407
 408         shost->max_id = ~0;
 409         shost->max_lun = ~0;
 410         shost->max_cmd_len = MAX_COMMAND_SIZE;
 411
 412         err = scsi_add_host(shost, &pdev->dev);
 413         if (err)
 414                 goto err_shost;
 415
 416         err = isci_register_sas_ha(isci_host);
 417         if (err)
 418                 goto err_shost_remove;
 419
 420         err = device_create_file(&shost->shost_dev, &dev_attr_isci_id);
 421         if (err)
 422                 goto err_unregister_ha;
 423
 424         return isci_host;
 425
 426  err_unregister_ha:
 427         sas_unregister_ha(&(isci_host->sas_ha));
 428  err_shost_remove:
 429         scsi_remove_host(shost);
 430  err_shost:
 431         scsi_host_put(shost);
 432
 433         return NULL;
 434 }
 435
 436 static void check_si_rev(struct pci_dev *pdev)
 437 {
 438         if (num_controllers(pdev) > 1)
 439                 isci_si_rev = ISCI_SI_REVB0;
 440         else {
 441                 switch (pdev->revision) {
 442                 case 0:
 443                 case 1:
 444                         /* if the id is ambiguous don't update isci_si_rev */
 445                         break;
 446                 case 3:
 447                         isci_si_rev = ISCI_SI_REVA2;
 448                         break;
 449                 default:
 450                 case 4:
 451                         isci_si_rev = ISCI_SI_REVB0;
 452                         break;
 453                 }
 454         }
 455
 456         dev_info(&pdev->dev, "driver configured for %s silicon (rev: %d)\n",
 457                  isci_si_rev == ISCI_SI_REVA0 ? "A0" :
 458                  isci_si_rev == ISCI_SI_REVA2 ? "A2" : "B0", pdev->revision);
 459
 460 }
 461
 462 static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 463 {
 464         struct isci_pci_info *pci_info;
 465         int err, i;
 466         struct isci_host *isci_host;
 467         const struct firmware *fw = NULL;
 468         struct isci_orom *orom;
 469
 470         check_si_rev(pdev);
 471
 472         pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
 473         if (!pci_info)
 474                 return -ENOMEM;
 475         pci_set_drvdata(pdev, pci_info);
 476
 477         if (efi_enabled)
 478                 orom = isci_get_efi_var(pdev);
 479         else
 480                 orom = isci_request_oprom(pdev);
 481
 482         if (!orom) {
 483                 orom = isci_request_firmware(pdev, fw);
 484                 if (!orom) {
 485                         /* TODO convert this to WARN_TAINT_ONCE once the
 486                          * orom/efi parameter support is widely available
 487                          */
 488                         dev_warn(&pdev->dev,
 489                                  "Loading user firmware failed, using default "
 490                                  "values\n");
 491                         dev_warn(&pdev->dev,
 492                                  "Default OEM configuration being used: 4 "
 493                                  "narrow ports, and default SAS Addresses\n");
 494                 }
 495         }
 496
 497         if (orom)
 498                 dev_info(&pdev->dev, "sas parameters (version: %#x) loaded\n",
 499                          orom->hdr.version);
 500         pci_info->orom = orom;
 501
 502         err = isci_pci_init(pdev);
 503         if (err)
 504                 return err;
 505
 506         for (i = 0; i < num_controllers(pdev); i++) {
 507                 struct isci_host *h = isci_host_alloc(pdev, i);
 508
 509                 if (!h) {
 510                         err = -ENOMEM;
 511                         goto err_host_alloc;
 512                 }
 513                 pci_info->hosts[i] = h;
 514         }
 515
 516         err = isci_setup_interrupts(pdev);
 517         if (err)
 518                 goto err_host_alloc;
 519
 520         for_each_isci_host(i, isci_host, pdev)
 521                 scsi_scan_host(isci_host->shost);
 522
 523         return 0;
 524
 525  err_host_alloc:
 526         for_each_isci_host(i, isci_host, pdev)
 527                 isci_unregister(isci_host);
 528         return err;
 529 }
 530
 531 static void __devexit isci_pci_remove(struct pci_dev *pdev)
 532 {
 533         struct isci_host *isci_host;
 534         int i;
 535
 536         for_each_isci_host(i, isci_host, pdev) {
 537                 isci_unregister(isci_host);
 538                 isci_host_deinit(isci_host);
 539                 scic_controller_disable_interrupts(isci_host->core_controller);
 540         }
 541 }
 542
 543 static __init int isci_init(void)
 544 {
 545         int err;
 546
 547         pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME);
 548
 549         isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
 550         if (!isci_transport_template)
 551                 return -ENOMEM;
 552
 553         err = pci_register_driver(&isci_pci_driver);
 554         if (err)
 555                 sas_release_transport(isci_transport_template);
 556
 557         return err;
 558 }
 559
 560 static __exit void isci_exit(void)
 561 {
 562         pci_unregister_driver(&isci_pci_driver);
 563         sas_release_transport(isci_transport_template);
 564 }
 565
 566 MODULE_LICENSE("Dual BSD/GPL");
 567 MODULE_FIRMWARE(ISCI_FW_NAME);
 568 module_init(isci_init);
 569 module_exit(isci_exit);