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