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 "probe_roms.h"
  65
  66 static struct scsi_transport_template *isci_transport_template;
  67
  68 static DEFINE_PCI_DEVICE_TABLE(isci_id_table) = {
  69         { PCI_VDEVICE(INTEL, 0x1D61),},
  70         { PCI_VDEVICE(INTEL, 0x1D63),},
  71         { PCI_VDEVICE(INTEL, 0x1D65),},
  72         { PCI_VDEVICE(INTEL, 0x1D67),},
  73         { PCI_VDEVICE(INTEL, 0x1D69),},
  74         { PCI_VDEVICE(INTEL, 0x1D6B),},
  75         { PCI_VDEVICE(INTEL, 0x1D60),},
  76         { PCI_VDEVICE(INTEL, 0x1D62),},
  77         { PCI_VDEVICE(INTEL, 0x1D64),},
  78         { PCI_VDEVICE(INTEL, 0x1D66),},
  79         { PCI_VDEVICE(INTEL, 0x1D68),},
  80         { PCI_VDEVICE(INTEL, 0x1D6A),},
  81         {}
  82 };
  83
  84 MODULE_DEVICE_TABLE(pci, isci_id_table);
  85
  86 /* linux isci specific settings */
  87
  88 unsigned char no_outbound_task_to = 20;
  89 module_param(no_outbound_task_to, byte, 0);
  90 MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
  91
  92 u16 ssp_max_occ_to = 20;
  93 module_param(ssp_max_occ_to, ushort, 0);
  94 MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
  95
  96 u16 stp_max_occ_to = 5;
  97 module_param(stp_max_occ_to, ushort, 0);
  98 MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
  99
 100 u16 ssp_inactive_to = 5;
 101 module_param(ssp_inactive_to, ushort, 0);
 102 MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
 103
 104 u16 stp_inactive_to = 5;
 105 module_param(stp_inactive_to, ushort, 0);
 106 MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
 107
 108 unsigned char phy_gen = 3;
 109 module_param(phy_gen, byte, 0);
 110 MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
 111
 112 unsigned char max_concurr_spinup = 1;
 113 module_param(max_concurr_spinup, byte, 0);
 114 MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
 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->ports[i].sas_port;
 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 = 0;
 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_host *ihost;
 326         struct isci_pci_info *pci_info = to_pci_info(pdev);
 327
 328         /*
 329          *  Determine the number of vectors associated with this
 330          *  PCI function.
 331          */
 332         num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
 333
 334         for (i = 0; i < num_msix; i++)
 335                 pci_info->msix_entries[i].entry = i;
 336
 337         err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix);
 338         if (err)
 339                 goto intx;
 340
 341         for (i = 0; i < num_msix; i++) {
 342                 int id = i / SCI_NUM_MSI_X_INT;
 343                 struct msix_entry *msix = &pci_info->msix_entries[i];
 344                 irq_handler_t isr;
 345
 346                 ihost = pci_info->hosts[id];
 347                 /* odd numbered vectors are error interrupts */
 348                 if (i & 1)
 349                         isr = isci_error_isr;
 350                 else
 351                         isr = isci_msix_isr;
 352
 353                 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
 354                                        DRV_NAME"-msix", ihost);
 355                 if (!err)
 356                         continue;
 357
 358                 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
 359                 while (i--) {
 360                         id = i / SCI_NUM_MSI_X_INT;
 361                         ihost = pci_info->hosts[id];
 362                         msix = &pci_info->msix_entries[i];
 363                         devm_free_irq(&pdev->dev, msix->vector, ihost);
 364                 }
 365                 pci_disable_msix(pdev);
 366                 goto intx;
 367         }
 368         return 0;
 369
 370  intx:
 371         for_each_isci_host(i, ihost, pdev) {
 372                 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
 373                                        IRQF_SHARED, DRV_NAME"-intx", ihost);
 374                 if (err)
 375                         break;
 376         }
 377         return err;
 378 }
 379
 380 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
 381 {
 382         struct isci_host *isci_host;
 383         struct Scsi_Host *shost;
 384         int err;
 385
 386         isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host), GFP_KERNEL);
 387         if (!isci_host)
 388                 return NULL;
 389
 390         isci_host->pdev = pdev;
 391         isci_host->id = id;
 392
 393         shost = scsi_host_alloc(&isci_sht, sizeof(void *));
 394         if (!shost)
 395                 return NULL;
 396         isci_host->shost = shost;
 397
 398         err = isci_host_init(isci_host);
 399         if (err)
 400                 goto err_shost;
 401
 402         SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha;
 403         isci_host->sas_ha.core.shost = shost;
 404         shost->transportt = isci_transport_template;
 405
 406         shost->max_id = ~0;
 407         shost->max_lun = ~0;
 408         shost->max_cmd_len = MAX_COMMAND_SIZE;
 409
 410         err = scsi_add_host(shost, &pdev->dev);
 411         if (err)
 412                 goto err_shost;
 413
 414         err = isci_register_sas_ha(isci_host);
 415         if (err)
 416                 goto err_shost_remove;
 417
 418         err = device_create_file(&shost->shost_dev, &dev_attr_isci_id);
 419         if (err)
 420                 goto err_unregister_ha;
 421
 422         return isci_host;
 423
 424  err_unregister_ha:
 425         sas_unregister_ha(&(isci_host->sas_ha));
 426  err_shost_remove:
 427         scsi_remove_host(shost);
 428  err_shost:
 429         scsi_host_put(shost);
 430
 431         return NULL;
 432 }
 433
 434 static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 435 {
 436         struct isci_pci_info *pci_info;
 437         int err, i;
 438         struct isci_host *isci_host;
 439         const struct firmware *fw = NULL;
 440         struct isci_orom *orom = NULL;
 441         char *source = "(platform)";
 442
 443         dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
 444                  pdev->revision);
 445
 446         pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
 447         if (!pci_info)
 448                 return -ENOMEM;
 449         pci_set_drvdata(pdev, pci_info);
 450
 451         if (efi_enabled)
 452                 orom = isci_get_efi_var(pdev);
 453
 454         if (!orom)
 455                 orom = isci_request_oprom(pdev);
 456
 457         for (i = 0; orom && i < ARRAY_SIZE(orom->ctrl); i++) {
 458                 if (sci_oem_parameters_validate(&orom->ctrl[i])) {
 459                         dev_warn(&pdev->dev,
 460                                  "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
 461                         devm_kfree(&pdev->dev, orom);
 462                         orom = NULL;
 463                         break;
 464                 }
 465         }
 466
 467         if (!orom) {
 468                 source = "(firmware)";
 469                 orom = isci_request_firmware(pdev, fw);
 470                 if (!orom) {
 471                         /* TODO convert this to WARN_TAINT_ONCE once the
 472                          * orom/efi parameter support is widely available
 473                          */
 474                         dev_warn(&pdev->dev,
 475                                  "Loading user firmware failed, using default "
 476                                  "values\n");
 477                         dev_warn(&pdev->dev,
 478                                  "Default OEM configuration being used: 4 "
 479                                  "narrow ports, and default SAS Addresses\n");
 480                 }
 481         }
 482
 483         if (orom)
 484                 dev_info(&pdev->dev,
 485                          "OEM SAS parameters (version: %u.%u) loaded %s\n",
 486                          (orom->hdr.version & 0xf0) >> 4,
 487                          (orom->hdr.version & 0xf), source);
 488
 489         pci_info->orom = orom;
 490
 491         err = isci_pci_init(pdev);
 492         if (err)
 493                 return err;
 494
 495         for (i = 0; i < num_controllers(pdev); i++) {
 496                 struct isci_host *h = isci_host_alloc(pdev, i);
 497
 498                 if (!h) {
 499                         err = -ENOMEM;
 500                         goto err_host_alloc;
 501                 }
 502                 pci_info->hosts[i] = h;
 503         }
 504
 505         err = isci_setup_interrupts(pdev);
 506         if (err)
 507                 goto err_host_alloc;
 508
 509         for_each_isci_host(i, isci_host, pdev)
 510                 scsi_scan_host(isci_host->shost);
 511
 512         return 0;
 513
 514  err_host_alloc:
 515         for_each_isci_host(i, isci_host, pdev)
 516                 isci_unregister(isci_host);
 517         return err;
 518 }
 519
 520 static void __devexit isci_pci_remove(struct pci_dev *pdev)
 521 {
 522         struct isci_host *ihost;
 523         int i;
 524
 525         for_each_isci_host(i, ihost, pdev) {
 526                 isci_unregister(ihost);
 527                 isci_host_deinit(ihost);
 528                 sci_controller_disable_interrupts(ihost);
 529         }
 530 }
 531
 532 static struct pci_driver isci_pci_driver = {
 533         .name           = DRV_NAME,
 534         .id_table       = isci_id_table,
 535         .probe          = isci_pci_probe,
 536         .remove         = __devexit_p(isci_pci_remove),
 537 };
 538
 539 static __init int isci_init(void)
 540 {
 541         int err;
 542
 543         pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME);
 544
 545         isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
 546         if (!isci_transport_template)
 547                 return -ENOMEM;
 548
 549         err = pci_register_driver(&isci_pci_driver);
 550         if (err)
 551                 sas_release_transport(isci_transport_template);
 552
 553         return err;
 554 }
 555
 556 static __exit void isci_exit(void)
 557 {
 558         pci_unregister_driver(&isci_pci_driver);
 559         sas_release_transport(isci_transport_template);
 560 }
 561
 562 MODULE_LICENSE("Dual BSD/GPL");
 563 MODULE_FIRMWARE(ISCI_FW_NAME);
 564 module_init(isci_init);
 565 module_exit(isci_exit);