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 <scsi/scsi_host.h>
  63 #include "host.h"
  64 #include "isci.h"
  65 #include "task.h"
  66 #include "probe_roms.h"
  67
  68 #define MAJ 1
  69 #define MIN 2
  70 #define BUILD 0
  71 #define DRV_VERSION __stringify(MAJ) "." __stringify(MIN) "." \
  72         __stringify(BUILD)
  73
  74 MODULE_VERSION(DRV_VERSION);
  75
  76 static struct scsi_transport_template *isci_transport_template;
  77
  78 static const struct pci_device_id isci_id_table[] = {
  79         { PCI_VDEVICE(INTEL, 0x1D61),},
  80         { PCI_VDEVICE(INTEL, 0x1D63),},
  81         { PCI_VDEVICE(INTEL, 0x1D65),},
  82         { PCI_VDEVICE(INTEL, 0x1D67),},
  83         { PCI_VDEVICE(INTEL, 0x1D69),},
  84         { PCI_VDEVICE(INTEL, 0x1D6B),},
  85         { PCI_VDEVICE(INTEL, 0x1D60),},
  86         { PCI_VDEVICE(INTEL, 0x1D62),},
  87         { PCI_VDEVICE(INTEL, 0x1D64),},
  88         { PCI_VDEVICE(INTEL, 0x1D66),},
  89         { PCI_VDEVICE(INTEL, 0x1D68),},
  90         { PCI_VDEVICE(INTEL, 0x1D6A),},
  91         {}
  92 };
  93
  94 MODULE_DEVICE_TABLE(pci, isci_id_table);
  95
  96 /* linux isci specific settings */
  97
  98 unsigned char no_outbound_task_to = 2;
  99 module_param(no_outbound_task_to, byte, 0);
 100 MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
 101
 102 u16 ssp_max_occ_to = 20;
 103 module_param(ssp_max_occ_to, ushort, 0);
 104 MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
 105
 106 u16 stp_max_occ_to = 5;
 107 module_param(stp_max_occ_to, ushort, 0);
 108 MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
 109
 110 u16 ssp_inactive_to = 5;
 111 module_param(ssp_inactive_to, ushort, 0);
 112 MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
 113
 114 u16 stp_inactive_to = 5;
 115 module_param(stp_inactive_to, ushort, 0);
 116 MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
 117
 118 unsigned char phy_gen = SCIC_SDS_PARM_GEN2_SPEED;
 119 module_param(phy_gen, byte, 0);
 120 MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
 121
 122 unsigned char max_concurr_spinup;
 123 module_param(max_concurr_spinup, byte, 0);
 124 MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
 125
 126 uint cable_selection_override = CABLE_OVERRIDE_DISABLED;
 127 module_param(cable_selection_override, uint, 0);
 128
 129 MODULE_PARM_DESC(cable_selection_override,
 130                  "This field indicates length of the SAS/SATA cable between "
 131                  "host and device. If any bits > 15 are set (default) "
 132                  "indicates \"use platform defaults\"");
 133
 134 static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
 135 {
 136         struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
 137         struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
 138         struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
 139
 140         return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
 141 }
 142
 143 static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
 144
 145 struct device_attribute *isci_host_attrs[] = {
 146         &dev_attr_isci_id,
 147         NULL
 148 };
 149
 150 static struct scsi_host_template isci_sht = {
 151
 152         .module                         = THIS_MODULE,
 153         .name                           = DRV_NAME,
 154         .proc_name                      = DRV_NAME,
 155         .queuecommand                   = sas_queuecommand,
 156         .target_alloc                   = sas_target_alloc,
 157         .slave_configure                = sas_slave_configure,
 158         .scan_finished                  = isci_host_scan_finished,
 159         .scan_start                     = isci_host_start,
 160         .change_queue_depth             = sas_change_queue_depth,
 161         .bios_param                     = sas_bios_param,
 162         .can_queue                      = ISCI_CAN_QUEUE_VAL,
 163         .this_id                        = -1,
 164         .sg_tablesize                   = SG_ALL,
 165         .max_sectors                    = SCSI_DEFAULT_MAX_SECTORS,
 166         .use_clustering                 = ENABLE_CLUSTERING,
 167         .eh_abort_handler               = sas_eh_abort_handler,
 168         .eh_device_reset_handler        = sas_eh_device_reset_handler,
 169         .eh_target_reset_handler        = sas_eh_target_reset_handler,
 170         .target_destroy                 = sas_target_destroy,
 171         .ioctl                          = sas_ioctl,
 172         .shost_attrs                    = isci_host_attrs,
 173         .track_queue_depth              = 1,
 174 };
 175
 176 static struct sas_domain_function_template isci_transport_ops  = {
 177
 178         /* The class calls these to notify the LLDD of an event. */
 179         .lldd_port_formed       = isci_port_formed,
 180         .lldd_port_deformed     = isci_port_deformed,
 181
 182         /* The class calls these when a device is found or gone. */
 183         .lldd_dev_found         = isci_remote_device_found,
 184         .lldd_dev_gone          = isci_remote_device_gone,
 185
 186         .lldd_execute_task      = isci_task_execute_task,
 187         /* Task Management Functions. Must be called from process context. */
 188         .lldd_abort_task        = isci_task_abort_task,
 189         .lldd_abort_task_set    = isci_task_abort_task_set,
 190         .lldd_clear_aca         = isci_task_clear_aca,
 191         .lldd_clear_task_set    = isci_task_clear_task_set,
 192         .lldd_I_T_nexus_reset   = isci_task_I_T_nexus_reset,
 193         .lldd_lu_reset          = isci_task_lu_reset,
 194         .lldd_query_task        = isci_task_query_task,
 195
 196         /* ata recovery called from ata-eh */
 197         .lldd_ata_check_ready   = isci_ata_check_ready,
 198
 199         /* Port and Adapter management */
 200         .lldd_clear_nexus_port  = isci_task_clear_nexus_port,
 201         .lldd_clear_nexus_ha    = isci_task_clear_nexus_ha,
 202
 203         /* Phy management */
 204         .lldd_control_phy       = isci_phy_control,
 205
 206         /* GPIO support */
 207         .lldd_write_gpio        = isci_gpio_write,
 208 };
 209
 210
 211 /******************************************************************************
 212 * P R O T E C T E D  M E T H O D S
 213 ******************************************************************************/
 214
 215
 216
 217 /**
 218  * isci_register_sas_ha() - This method initializes various lldd
 219  *    specific members of the sas_ha struct and calls the libsas
 220  *    sas_register_ha() function.
 221  * @isci_host: This parameter specifies the lldd specific wrapper for the
 222  *    libsas sas_ha struct.
 223  *
 224  * This method returns an error code indicating success or failure. The user
 225  * should check for possible memory allocation error return otherwise, a zero
 226  * indicates success.
 227  */
 228 static int isci_register_sas_ha(struct isci_host *isci_host)
 229 {
 230         int i;
 231         struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
 232         struct asd_sas_phy **sas_phys;
 233         struct asd_sas_port **sas_ports;
 234
 235         sas_phys = devm_kzalloc(&isci_host->pdev->dev,
 236                                 SCI_MAX_PHYS * sizeof(void *),
 237                                 GFP_KERNEL);
 238         if (!sas_phys)
 239                 return -ENOMEM;
 240
 241         sas_ports = devm_kzalloc(&isci_host->pdev->dev,
 242                                  SCI_MAX_PORTS * sizeof(void *),
 243                                  GFP_KERNEL);
 244         if (!sas_ports)
 245                 return -ENOMEM;
 246
 247         sas_ha->sas_ha_name = DRV_NAME;
 248         sas_ha->lldd_module = THIS_MODULE;
 249         sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
 250
 251         for (i = 0; i < SCI_MAX_PHYS; i++) {
 252                 sas_phys[i] = &isci_host->phys[i].sas_phy;
 253                 sas_ports[i] = &isci_host->sas_ports[i];
 254         }
 255
 256         sas_ha->sas_phy  = sas_phys;
 257         sas_ha->sas_port = sas_ports;
 258         sas_ha->num_phys = SCI_MAX_PHYS;
 259
 260         sas_ha->strict_wide_ports = 1;
 261
 262         sas_register_ha(sas_ha);
 263
 264         return 0;
 265 }
 266
 267 static void isci_unregister(struct isci_host *isci_host)
 268 {
 269         struct Scsi_Host *shost;
 270
 271         if (!isci_host)
 272                 return;
 273
 274         shost = to_shost(isci_host);
 275         sas_unregister_ha(&isci_host->sas_ha);
 276
 277         sas_remove_host(shost);
 278         scsi_host_put(shost);
 279 }
 280
 281 static int isci_pci_init(struct pci_dev *pdev)
 282 {
 283         int err, bar_num, bar_mask = 0;
 284         void __iomem * const *iomap;
 285
 286         err = pcim_enable_device(pdev);
 287         if (err) {
 288                 dev_err(&pdev->dev,
 289                         "failed enable PCI device %s!\n",
 290                         pci_name(pdev));
 291                 return err;
 292         }
 293
 294         for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
 295                 bar_mask |= 1 << (bar_num * 2);
 296
 297         err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
 298         if (err)
 299                 return err;
 300
 301         iomap = pcim_iomap_table(pdev);
 302         if (!iomap)
 303                 return -ENOMEM;
 304
 305         pci_set_master(pdev);
 306
 307         err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
 308         if (err) {
 309                 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
 310                 if (err)
 311                         return err;
 312         }
 313
 314         err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
 315         if (err) {
 316                 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
 317                 if (err)
 318                         return err;
 319         }
 320
 321         return 0;
 322 }
 323
 324 static int num_controllers(struct pci_dev *pdev)
 325 {
 326         /* bar size alone can tell us if we are running with a dual controller
 327          * part, no need to trust revision ids that might be under broken firmware
 328          * control
 329          */
 330         resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
 331         resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
 332
 333         if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
 334             smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
 335                 return SCI_MAX_CONTROLLERS;
 336         else
 337                 return 1;
 338 }
 339
 340 static int isci_setup_interrupts(struct pci_dev *pdev)
 341 {
 342         int err, i, num_msix;
 343         struct isci_host *ihost;
 344         struct isci_pci_info *pci_info = to_pci_info(pdev);
 345
 346         /*
 347          *  Determine the number of vectors associated with this
 348          *  PCI function.
 349          */
 350         num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
 351
 352         err = pci_alloc_irq_vectors(pdev, num_msix, num_msix, PCI_IRQ_MSIX);
 353         if (err < 0)
 354                 goto intx;
 355
 356         for (i = 0; i < num_msix; i++) {
 357                 int id = i / SCI_NUM_MSI_X_INT;
 358                 irq_handler_t isr;
 359
 360                 ihost = pci_info->hosts[id];
 361                 /* odd numbered vectors are error interrupts */
 362                 if (i & 1)
 363                         isr = isci_error_isr;
 364                 else
 365                         isr = isci_msix_isr;
 366
 367                 err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
 368                                 isr, 0, DRV_NAME"-msix", ihost);
 369                 if (!err)
 370                         continue;
 371
 372                 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
 373                 while (i--) {
 374                         id = i / SCI_NUM_MSI_X_INT;
 375                         ihost = pci_info->hosts[id];
 376                         devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i),
 377                                         ihost);
 378                 }
 379                 pci_free_irq_vectors(pdev);
 380                 goto intx;
 381         }
 382         return 0;
 383
 384  intx:
 385         for_each_isci_host(i, ihost, pdev) {
 386                 err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, 0),
 387                                 isci_intx_isr, IRQF_SHARED, DRV_NAME"-intx",
 388                                 ihost);
 389                 if (err)
 390                         break;
 391         }
 392         return err;
 393 }
 394
 395 static void isci_user_parameters_get(struct sci_user_parameters *u)
 396 {
 397         int i;
 398
 399         for (i = 0; i < SCI_MAX_PHYS; i++) {
 400                 struct sci_phy_user_params *u_phy = &u->phys[i];
 401
 402                 u_phy->max_speed_generation = phy_gen;
 403
 404                 /* we are not exporting these for now */
 405                 u_phy->align_insertion_frequency = 0x7f;
 406                 u_phy->in_connection_align_insertion_frequency = 0xff;
 407                 u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
 408         }
 409
 410         u->stp_inactivity_timeout = stp_inactive_to;
 411         u->ssp_inactivity_timeout = ssp_inactive_to;
 412         u->stp_max_occupancy_timeout = stp_max_occ_to;
 413         u->ssp_max_occupancy_timeout = ssp_max_occ_to;
 414         u->no_outbound_task_timeout = no_outbound_task_to;
 415         u->max_concurr_spinup = max_concurr_spinup;
 416 }
 417
 418 static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
 419                                                struct sci_user_parameters *sci_parms)
 420 {
 421         u16 index;
 422
 423         /*
 424          * Validate the user parameters.  If they are not legal, then
 425          * return a failure.
 426          */
 427         for (index = 0; index < SCI_MAX_PHYS; index++) {
 428                 struct sci_phy_user_params *u;
 429
 430                 u = &sci_parms->phys[index];
 431
 432                 if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
 433                       (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
 434                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
 435
 436                 if (u->in_connection_align_insertion_frequency < 3)
 437                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
 438
 439                 if ((u->in_connection_align_insertion_frequency < 3) ||
 440                     (u->align_insertion_frequency == 0) ||
 441                     (u->notify_enable_spin_up_insertion_frequency == 0))
 442                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
 443         }
 444
 445         if ((sci_parms->stp_inactivity_timeout == 0) ||
 446             (sci_parms->ssp_inactivity_timeout == 0) ||
 447             (sci_parms->stp_max_occupancy_timeout == 0) ||
 448             (sci_parms->ssp_max_occupancy_timeout == 0) ||
 449             (sci_parms->no_outbound_task_timeout == 0))
 450                 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
 451
 452         memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
 453
 454         return SCI_SUCCESS;
 455 }
 456
 457 static void sci_oem_defaults(struct isci_host *ihost)
 458 {
 459         /* these defaults are overridden by the platform / firmware */
 460         struct sci_user_parameters *user = &ihost->user_parameters;
 461         struct sci_oem_params *oem = &ihost->oem_parameters;
 462         int i;
 463
 464         /* Default to APC mode. */
 465         oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
 466
 467         /* Default to APC mode. */
 468         oem->controller.max_concurr_spin_up = 1;
 469
 470         /* Default to no SSC operation. */
 471         oem->controller.do_enable_ssc = false;
 472
 473         /* Default to short cables on all phys. */
 474         oem->controller.cable_selection_mask = 0;
 475
 476         /* Initialize all of the port parameter information to narrow ports. */
 477         for (i = 0; i < SCI_MAX_PORTS; i++)
 478                 oem->ports[i].phy_mask = 0;
 479
 480         /* Initialize all of the phy parameter information. */
 481         for (i = 0; i < SCI_MAX_PHYS; i++) {
 482                 /* Default to 3G (i.e. Gen 2). */
 483                 user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
 484
 485                 /* the frequencies cannot be 0 */
 486                 user->phys[i].align_insertion_frequency = 0x7f;
 487                 user->phys[i].in_connection_align_insertion_frequency = 0xff;
 488                 user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
 489
 490                 /* Previous Vitesse based expanders had a arbitration issue that
 491                  * is worked around by having the upper 32-bits of SAS address
 492                  * with a value greater then the Vitesse company identifier.
 493                  * Hence, usage of 0x5FCFFFFF.
 494                  */
 495                 oem->phys[i].sas_address.low = 0x1 + ihost->id;
 496                 oem->phys[i].sas_address.high = 0x5FCFFFFF;
 497         }
 498
 499         user->stp_inactivity_timeout = 5;
 500         user->ssp_inactivity_timeout = 5;
 501         user->stp_max_occupancy_timeout = 5;
 502         user->ssp_max_occupancy_timeout = 20;
 503         user->no_outbound_task_timeout = 2;
 504 }
 505
 506 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
 507 {
 508         struct isci_orom *orom = to_pci_info(pdev)->orom;
 509         struct sci_user_parameters sci_user_params;
 510         u8 oem_version = ISCI_ROM_VER_1_0;
 511         struct isci_host *ihost;
 512         struct Scsi_Host *shost;
 513         int err, i;
 514
 515         ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
 516         if (!ihost)
 517                 return NULL;
 518
 519         ihost->pdev = pdev;
 520         ihost->id = id;
 521         spin_lock_init(&ihost->scic_lock);
 522         init_waitqueue_head(&ihost->eventq);
 523         ihost->sas_ha.dev = &ihost->pdev->dev;
 524         ihost->sas_ha.lldd_ha = ihost;
 525         tasklet_init(&ihost->completion_tasklet,
 526                      isci_host_completion_routine, (unsigned long)ihost);
 527
 528         /* validate module parameters */
 529         /* TODO: kill struct sci_user_parameters and reference directly */
 530         sci_oem_defaults(ihost);
 531         isci_user_parameters_get(&sci_user_params);
 532         if (sci_user_parameters_set(ihost, &sci_user_params)) {
 533                 dev_warn(&pdev->dev,
 534                          "%s: sci_user_parameters_set failed\n", __func__);
 535                 return NULL;
 536         }
 537
 538         /* sanity check platform (or 'firmware') oem parameters */
 539         if (orom) {
 540                 if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
 541                         dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
 542                         return NULL;
 543                 }
 544                 ihost->oem_parameters = orom->ctrl[id];
 545                 oem_version = orom->hdr.version;
 546         }
 547
 548         /* validate oem parameters (platform, firmware, or built-in defaults) */
 549         if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
 550                 dev_warn(&pdev->dev, "oem parameter validation failed\n");
 551                 return NULL;
 552         }
 553
 554         for (i = 0; i < SCI_MAX_PORTS; i++) {
 555                 struct isci_port *iport = &ihost->ports[i];
 556
 557                 INIT_LIST_HEAD(&iport->remote_dev_list);
 558                 iport->isci_host = ihost;
 559         }
 560
 561         for (i = 0; i < SCI_MAX_PHYS; i++)
 562                 isci_phy_init(&ihost->phys[i], ihost, i);
 563
 564         for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
 565                 struct isci_remote_device *idev = &ihost->devices[i];
 566
 567                 INIT_LIST_HEAD(&idev->node);
 568         }
 569
 570         shost = scsi_host_alloc(&isci_sht, sizeof(void *));
 571         if (!shost)
 572                 return NULL;
 573
 574         dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
 575                  "{%s, %s, %s, %s}\n",
 576                  (is_cable_select_overridden() ? "* " : ""), ihost->id,
 577                  lookup_cable_names(decode_cable_selection(ihost, 3)),
 578                  lookup_cable_names(decode_cable_selection(ihost, 2)),
 579                  lookup_cable_names(decode_cable_selection(ihost, 1)),
 580                  lookup_cable_names(decode_cable_selection(ihost, 0)));
 581
 582         err = isci_host_init(ihost);
 583         if (err)
 584                 goto err_shost;
 585
 586         SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
 587         ihost->sas_ha.core.shost = shost;
 588         shost->transportt = isci_transport_template;
 589
 590         shost->max_id = ~0;
 591         shost->max_lun = ~0;
 592         shost->max_cmd_len = MAX_COMMAND_SIZE;
 593
 594         err = scsi_add_host(shost, &pdev->dev);
 595         if (err)
 596                 goto err_shost;
 597
 598         err = isci_register_sas_ha(ihost);
 599         if (err)
 600                 goto err_shost_remove;
 601
 602         return ihost;
 603
 604  err_shost_remove:
 605         scsi_remove_host(shost);
 606  err_shost:
 607         scsi_host_put(shost);
 608
 609         return NULL;
 610 }
 611
 612 static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 613 {
 614         struct isci_pci_info *pci_info;
 615         int err, i;
 616         struct isci_host *isci_host;
 617         const struct firmware *fw = NULL;
 618         struct isci_orom *orom = NULL;
 619         char *source = "(platform)";
 620
 621         dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
 622                  pdev->revision);
 623
 624         pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
 625         if (!pci_info)
 626                 return -ENOMEM;
 627         pci_set_drvdata(pdev, pci_info);
 628
 629         if (efi_enabled(EFI_RUNTIME_SERVICES))
 630                 orom = isci_get_efi_var(pdev);
 631
 632         if (!orom)
 633                 orom = isci_request_oprom(pdev);
 634
 635         for (i = 0; orom && i < num_controllers(pdev); i++) {
 636                 if (sci_oem_parameters_validate(&orom->ctrl[i],
 637                                                 orom->hdr.version)) {
 638                         dev_warn(&pdev->dev,
 639                                  "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
 640                         orom = NULL;
 641                         break;
 642                 }
 643         }
 644
 645         if (!orom) {
 646                 source = "(firmware)";
 647                 orom = isci_request_firmware(pdev, fw);
 648                 if (!orom) {
 649                         /* TODO convert this to WARN_TAINT_ONCE once the
 650                          * orom/efi parameter support is widely available
 651                          */
 652                         dev_warn(&pdev->dev,
 653                                  "Loading user firmware failed, using default "
 654                                  "values\n");
 655                         dev_warn(&pdev->dev,
 656                                  "Default OEM configuration being used: 4 "
 657                                  "narrow ports, and default SAS Addresses\n");
 658                 }
 659         }
 660
 661         if (orom)
 662                 dev_info(&pdev->dev,
 663                          "OEM SAS parameters (version: %u.%u) loaded %s\n",
 664                          (orom->hdr.version & 0xf0) >> 4,
 665                          (orom->hdr.version & 0xf), source);
 666
 667         pci_info->orom = orom;
 668
 669         err = isci_pci_init(pdev);
 670         if (err)
 671                 return err;
 672
 673         for (i = 0; i < num_controllers(pdev); i++) {
 674                 struct isci_host *h = isci_host_alloc(pdev, i);
 675
 676                 if (!h) {
 677                         err = -ENOMEM;
 678                         goto err_host_alloc;
 679                 }
 680                 pci_info->hosts[i] = h;
 681
 682                 /* turn on DIF support */
 683                 scsi_host_set_prot(to_shost(h),
 684                                    SHOST_DIF_TYPE1_PROTECTION |
 685                                    SHOST_DIF_TYPE2_PROTECTION |
 686                                    SHOST_DIF_TYPE3_PROTECTION);
 687                 scsi_host_set_guard(to_shost(h), SHOST_DIX_GUARD_CRC);
 688         }
 689
 690         err = isci_setup_interrupts(pdev);
 691         if (err)
 692                 goto err_host_alloc;
 693
 694         for_each_isci_host(i, isci_host, pdev)
 695                 scsi_scan_host(to_shost(isci_host));
 696
 697         return 0;
 698
 699  err_host_alloc:
 700         for_each_isci_host(i, isci_host, pdev)
 701                 isci_unregister(isci_host);
 702         return err;
 703 }
 704
 705 static void isci_pci_remove(struct pci_dev *pdev)
 706 {
 707         struct isci_host *ihost;
 708         int i;
 709
 710         for_each_isci_host(i, ihost, pdev) {
 711                 wait_for_start(ihost);
 712                 isci_unregister(ihost);
 713                 isci_host_deinit(ihost);
 714         }
 715 }
 716
 717 #ifdef CONFIG_PM_SLEEP
 718 static int isci_suspend(struct device *dev)
 719 {
 720         struct pci_dev *pdev = to_pci_dev(dev);
 721         struct isci_host *ihost;
 722         int i;
 723
 724         for_each_isci_host(i, ihost, pdev) {
 725                 sas_suspend_ha(&ihost->sas_ha);
 726                 isci_host_deinit(ihost);
 727         }
 728
 729         pci_save_state(pdev);
 730         pci_disable_device(pdev);
 731         pci_set_power_state(pdev, PCI_D3hot);
 732
 733         return 0;
 734 }
 735
 736 static int isci_resume(struct device *dev)
 737 {
 738         struct pci_dev *pdev = to_pci_dev(dev);
 739         struct isci_host *ihost;
 740         int rc, i;
 741
 742         pci_set_power_state(pdev, PCI_D0);
 743         pci_restore_state(pdev);
 744
 745         rc = pcim_enable_device(pdev);
 746         if (rc) {
 747                 dev_err(&pdev->dev,
 748                         "enabling device failure after resume(%d)\n", rc);
 749                 return rc;
 750         }
 751
 752         pci_set_master(pdev);
 753
 754         for_each_isci_host(i, ihost, pdev) {
 755                 sas_prep_resume_ha(&ihost->sas_ha);
 756
 757                 isci_host_init(ihost);
 758                 isci_host_start(ihost->sas_ha.core.shost);
 759                 wait_for_start(ihost);
 760
 761                 sas_resume_ha(&ihost->sas_ha);
 762         }
 763
 764         return 0;
 765 }
 766 #endif
 767
 768 static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
 769
 770 static struct pci_driver isci_pci_driver = {
 771         .name           = DRV_NAME,
 772         .id_table       = isci_id_table,
 773         .probe          = isci_pci_probe,
 774         .remove         = isci_pci_remove,
 775         .driver.pm      = &isci_pm_ops,
 776 };
 777
 778 static __init int isci_init(void)
 779 {
 780         int err;
 781
 782         pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
 783                 DRV_NAME, DRV_VERSION);
 784
 785         isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
 786         if (!isci_transport_template)
 787                 return -ENOMEM;
 788
 789         err = pci_register_driver(&isci_pci_driver);
 790         if (err)
 791                 sas_release_transport(isci_transport_template);
 792
 793         return err;
 794 }
 795
 796 static __exit void isci_exit(void)
 797 {
 798         pci_unregister_driver(&isci_pci_driver);
 799         sas_release_transport(isci_transport_template);
 800 }
 801
 802 MODULE_LICENSE("Dual BSD/GPL");
 803 MODULE_FIRMWARE(ISCI_FW_NAME);
 804 module_init(isci_init);
 805 module_exit(isci_exit);