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