init.c revision 3a7bda830fad427768ed71c0ebf3448849c006b5
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 "isci.h" 64#include "task.h" 65#include "probe_roms.h" 66 67static struct scsi_transport_template *isci_transport_template; 68 69static DEFINE_PCI_DEVICE_TABLE(isci_id_table) = { 70 { PCI_VDEVICE(INTEL, 0x1D61),}, 71 { PCI_VDEVICE(INTEL, 0x1D63),}, 72 { PCI_VDEVICE(INTEL, 0x1D65),}, 73 { PCI_VDEVICE(INTEL, 0x1D67),}, 74 { PCI_VDEVICE(INTEL, 0x1D69),}, 75 { PCI_VDEVICE(INTEL, 0x1D6B),}, 76 { PCI_VDEVICE(INTEL, 0x1D60),}, 77 { PCI_VDEVICE(INTEL, 0x1D62),}, 78 { PCI_VDEVICE(INTEL, 0x1D64),}, 79 { PCI_VDEVICE(INTEL, 0x1D66),}, 80 { PCI_VDEVICE(INTEL, 0x1D68),}, 81 { PCI_VDEVICE(INTEL, 0x1D6A),}, 82 {} 83}; 84 85MODULE_DEVICE_TABLE(pci, isci_id_table); 86 87/* linux isci specific settings */ 88 89unsigned char no_outbound_task_to = 20; 90module_param(no_outbound_task_to, byte, 0); 91MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)"); 92 93u16 ssp_max_occ_to = 20; 94module_param(ssp_max_occ_to, ushort, 0); 95MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)"); 96 97u16 stp_max_occ_to = 5; 98module_param(stp_max_occ_to, ushort, 0); 99MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)"); 100 101u16 ssp_inactive_to = 5; 102module_param(ssp_inactive_to, ushort, 0); 103MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)"); 104 105u16 stp_inactive_to = 5; 106module_param(stp_inactive_to, ushort, 0); 107MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)"); 108 109unsigned char phy_gen = 3; 110module_param(phy_gen, byte, 0); 111MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)"); 112 113unsigned char max_concurr_spinup = 1; 114module_param(max_concurr_spinup, byte, 0); 115MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup"); 116 117static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf) 118{ 119 struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev); 120 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost); 121 struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha); 122 123 return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id); 124} 125 126static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL); 127 128struct device_attribute *isci_host_attrs[] = { 129 &dev_attr_isci_id, 130 NULL 131}; 132 133static struct scsi_host_template isci_sht = { 134 135 .module = THIS_MODULE, 136 .name = DRV_NAME, 137 .proc_name = DRV_NAME, 138 .queuecommand = sas_queuecommand, 139 .target_alloc = sas_target_alloc, 140 .slave_configure = sas_slave_configure, 141 .slave_destroy = sas_slave_destroy, 142 .scan_finished = isci_host_scan_finished, 143 .scan_start = isci_host_scan_start, 144 .change_queue_depth = sas_change_queue_depth, 145 .change_queue_type = sas_change_queue_type, 146 .bios_param = sas_bios_param, 147 .can_queue = ISCI_CAN_QUEUE_VAL, 148 .cmd_per_lun = 1, 149 .this_id = -1, 150 .sg_tablesize = SG_ALL, 151 .max_sectors = SCSI_DEFAULT_MAX_SECTORS, 152 .use_clustering = ENABLE_CLUSTERING, 153 .eh_device_reset_handler = sas_eh_device_reset_handler, 154 .eh_bus_reset_handler = isci_bus_reset_handler, 155 .slave_alloc = sas_slave_alloc, 156 .target_destroy = sas_target_destroy, 157 .ioctl = sas_ioctl, 158 .shost_attrs = isci_host_attrs, 159}; 160 161static struct sas_domain_function_template isci_transport_ops = { 162 163 /* The class calls these to notify the LLDD of an event. */ 164 .lldd_port_formed = isci_port_formed, 165 .lldd_port_deformed = isci_port_deformed, 166 167 /* The class calls these when a device is found or gone. */ 168 .lldd_dev_found = isci_remote_device_found, 169 .lldd_dev_gone = isci_remote_device_gone, 170 171 .lldd_execute_task = isci_task_execute_task, 172 /* Task Management Functions. Must be called from process context. */ 173 .lldd_abort_task = isci_task_abort_task, 174 .lldd_abort_task_set = isci_task_abort_task_set, 175 .lldd_clear_aca = isci_task_clear_aca, 176 .lldd_clear_task_set = isci_task_clear_task_set, 177 .lldd_I_T_nexus_reset = isci_task_I_T_nexus_reset, 178 .lldd_lu_reset = isci_task_lu_reset, 179 .lldd_query_task = isci_task_query_task, 180 181 /* Port and Adapter management */ 182 .lldd_clear_nexus_port = isci_task_clear_nexus_port, 183 .lldd_clear_nexus_ha = isci_task_clear_nexus_ha, 184 185 /* Phy management */ 186 .lldd_control_phy = isci_phy_control, 187}; 188 189 190/****************************************************************************** 191* P R O T E C T E D M E T H O D S 192******************************************************************************/ 193 194 195 196/** 197 * isci_register_sas_ha() - This method initializes various lldd 198 * specific members of the sas_ha struct and calls the libsas 199 * sas_register_ha() function. 200 * @isci_host: This parameter specifies the lldd specific wrapper for the 201 * libsas sas_ha struct. 202 * 203 * This method returns an error code indicating sucess or failure. The user 204 * should check for possible memory allocation error return otherwise, a zero 205 * indicates success. 206 */ 207static int isci_register_sas_ha(struct isci_host *isci_host) 208{ 209 int i; 210 struct sas_ha_struct *sas_ha = &(isci_host->sas_ha); 211 struct asd_sas_phy **sas_phys; 212 struct asd_sas_port **sas_ports; 213 214 sas_phys = devm_kzalloc(&isci_host->pdev->dev, 215 SCI_MAX_PHYS * sizeof(void *), 216 GFP_KERNEL); 217 if (!sas_phys) 218 return -ENOMEM; 219 220 sas_ports = devm_kzalloc(&isci_host->pdev->dev, 221 SCI_MAX_PORTS * sizeof(void *), 222 GFP_KERNEL); 223 if (!sas_ports) 224 return -ENOMEM; 225 226 /*----------------- Libsas Initialization Stuff---------------------- 227 * Set various fields in the sas_ha struct: 228 */ 229 230 sas_ha->sas_ha_name = DRV_NAME; 231 sas_ha->lldd_module = THIS_MODULE; 232 sas_ha->sas_addr = &isci_host->phys[0].sas_addr[0]; 233 234 /* set the array of phy and port structs. */ 235 for (i = 0; i < SCI_MAX_PHYS; i++) { 236 sas_phys[i] = &isci_host->phys[i].sas_phy; 237 sas_ports[i] = &isci_host->ports[i].sas_port; 238 } 239 240 sas_ha->sas_phy = sas_phys; 241 sas_ha->sas_port = sas_ports; 242 sas_ha->num_phys = SCI_MAX_PHYS; 243 244 sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL; 245 sas_ha->lldd_max_execute_num = 1; 246 sas_ha->strict_wide_ports = 1; 247 248 sas_register_ha(sas_ha); 249 250 return 0; 251} 252 253static void isci_unregister(struct isci_host *isci_host) 254{ 255 struct Scsi_Host *shost; 256 257 if (!isci_host) 258 return; 259 260 shost = isci_host->shost; 261 262 sas_unregister_ha(&isci_host->sas_ha); 263 264 sas_remove_host(isci_host->shost); 265 scsi_remove_host(isci_host->shost); 266 scsi_host_put(isci_host->shost); 267} 268 269static int __devinit isci_pci_init(struct pci_dev *pdev) 270{ 271 int err, bar_num, bar_mask = 0; 272 void __iomem * const *iomap; 273 274 err = pcim_enable_device(pdev); 275 if (err) { 276 dev_err(&pdev->dev, 277 "failed enable PCI device %s!\n", 278 pci_name(pdev)); 279 return err; 280 } 281 282 for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++) 283 bar_mask |= 1 << (bar_num * 2); 284 285 err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME); 286 if (err) 287 return err; 288 289 iomap = pcim_iomap_table(pdev); 290 if (!iomap) 291 return -ENOMEM; 292 293 pci_set_master(pdev); 294 295 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64)); 296 if (err) { 297 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32)); 298 if (err) 299 return err; 300 } 301 302 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64)); 303 if (err) { 304 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32)); 305 if (err) 306 return err; 307 } 308 309 return 0; 310} 311 312static int num_controllers(struct pci_dev *pdev) 313{ 314 /* bar size alone can tell us if we are running with a dual controller 315 * part, no need to trust revision ids that might be under broken firmware 316 * control 317 */ 318 resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2); 319 resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2); 320 321 if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS && 322 smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS) 323 return SCI_MAX_CONTROLLERS; 324 else 325 return 1; 326} 327 328static int isci_setup_interrupts(struct pci_dev *pdev) 329{ 330 int err, i, num_msix; 331 struct isci_host *ihost; 332 struct isci_pci_info *pci_info = to_pci_info(pdev); 333 334 /* 335 * Determine the number of vectors associated with this 336 * PCI function. 337 */ 338 num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT; 339 340 for (i = 0; i < num_msix; i++) 341 pci_info->msix_entries[i].entry = i; 342 343 err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix); 344 if (err) 345 goto intx; 346 347 for (i = 0; i < num_msix; i++) { 348 int id = i / SCI_NUM_MSI_X_INT; 349 struct msix_entry *msix = &pci_info->msix_entries[i]; 350 irq_handler_t isr; 351 352 ihost = pci_info->hosts[id]; 353 /* odd numbered vectors are error interrupts */ 354 if (i & 1) 355 isr = isci_error_isr; 356 else 357 isr = isci_msix_isr; 358 359 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0, 360 DRV_NAME"-msix", ihost); 361 if (!err) 362 continue; 363 364 dev_info(&pdev->dev, "msix setup failed falling back to intx\n"); 365 while (i--) { 366 id = i / SCI_NUM_MSI_X_INT; 367 ihost = pci_info->hosts[id]; 368 msix = &pci_info->msix_entries[i]; 369 devm_free_irq(&pdev->dev, msix->vector, ihost); 370 } 371 pci_disable_msix(pdev); 372 goto intx; 373 } 374 return 0; 375 376 intx: 377 for_each_isci_host(i, ihost, pdev) { 378 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr, 379 IRQF_SHARED, DRV_NAME"-intx", ihost); 380 if (err) 381 break; 382 } 383 return err; 384} 385 386static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id) 387{ 388 struct isci_host *isci_host; 389 struct Scsi_Host *shost; 390 int err; 391 392 isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host), GFP_KERNEL); 393 if (!isci_host) 394 return NULL; 395 396 isci_host->pdev = pdev; 397 isci_host->id = id; 398 399 shost = scsi_host_alloc(&isci_sht, sizeof(void *)); 400 if (!shost) 401 return NULL; 402 isci_host->shost = shost; 403 404 err = isci_host_init(isci_host); 405 if (err) 406 goto err_shost; 407 408 SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha; 409 isci_host->sas_ha.core.shost = shost; 410 shost->transportt = isci_transport_template; 411 412 shost->max_id = ~0; 413 shost->max_lun = ~0; 414 shost->max_cmd_len = MAX_COMMAND_SIZE; 415 416 err = scsi_add_host(shost, &pdev->dev); 417 if (err) 418 goto err_shost; 419 420 err = isci_register_sas_ha(isci_host); 421 if (err) 422 goto err_shost_remove; 423 424 return isci_host; 425 426 err_shost_remove: 427 scsi_remove_host(shost); 428 err_shost: 429 scsi_host_put(shost); 430 431 return NULL; 432} 433 434static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id) 435{ 436 struct isci_pci_info *pci_info; 437 int err, i; 438 struct isci_host *isci_host; 439 const struct firmware *fw = NULL; 440 struct isci_orom *orom = NULL; 441 char *source = "(platform)"; 442 443 dev_info(&pdev->dev, "driver configured for rev: %d silicon\n", 444 pdev->revision); 445 446 pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL); 447 if (!pci_info) 448 return -ENOMEM; 449 pci_set_drvdata(pdev, pci_info); 450 451 if (efi_enabled) 452 orom = isci_get_efi_var(pdev); 453 454 if (!orom) 455 orom = isci_request_oprom(pdev); 456 457 for (i = 0; orom && i < ARRAY_SIZE(orom->ctrl); i++) { 458 if (sci_oem_parameters_validate(&orom->ctrl[i])) { 459 dev_warn(&pdev->dev, 460 "[%d]: invalid oem parameters detected, falling back to firmware\n", i); 461 devm_kfree(&pdev->dev, orom); 462 orom = NULL; 463 break; 464 } 465 } 466 467 if (!orom) { 468 source = "(firmware)"; 469 orom = isci_request_firmware(pdev, fw); 470 if (!orom) { 471 /* TODO convert this to WARN_TAINT_ONCE once the 472 * orom/efi parameter support is widely available 473 */ 474 dev_warn(&pdev->dev, 475 "Loading user firmware failed, using default " 476 "values\n"); 477 dev_warn(&pdev->dev, 478 "Default OEM configuration being used: 4 " 479 "narrow ports, and default SAS Addresses\n"); 480 } 481 } 482 483 if (orom) 484 dev_info(&pdev->dev, 485 "OEM SAS parameters (version: %u.%u) loaded %s\n", 486 (orom->hdr.version & 0xf0) >> 4, 487 (orom->hdr.version & 0xf), source); 488 489 pci_info->orom = orom; 490 491 err = isci_pci_init(pdev); 492 if (err) 493 return err; 494 495 for (i = 0; i < num_controllers(pdev); i++) { 496 struct isci_host *h = isci_host_alloc(pdev, i); 497 498 if (!h) { 499 err = -ENOMEM; 500 goto err_host_alloc; 501 } 502 pci_info->hosts[i] = h; 503 } 504 505 err = isci_setup_interrupts(pdev); 506 if (err) 507 goto err_host_alloc; 508 509 for_each_isci_host(i, isci_host, pdev) 510 scsi_scan_host(isci_host->shost); 511 512 return 0; 513 514 err_host_alloc: 515 for_each_isci_host(i, isci_host, pdev) 516 isci_unregister(isci_host); 517 return err; 518} 519 520static void __devexit isci_pci_remove(struct pci_dev *pdev) 521{ 522 struct isci_host *ihost; 523 int i; 524 525 for_each_isci_host(i, ihost, pdev) { 526 isci_unregister(ihost); 527 isci_host_deinit(ihost); 528 sci_controller_disable_interrupts(ihost); 529 } 530} 531 532static struct pci_driver isci_pci_driver = { 533 .name = DRV_NAME, 534 .id_table = isci_id_table, 535 .probe = isci_pci_probe, 536 .remove = __devexit_p(isci_pci_remove), 537}; 538 539static __init int isci_init(void) 540{ 541 int err; 542 543 pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME); 544 545 isci_transport_template = sas_domain_attach_transport(&isci_transport_ops); 546 if (!isci_transport_template) 547 return -ENOMEM; 548 549 err = pci_register_driver(&isci_pci_driver); 550 if (err) 551 sas_release_transport(isci_transport_template); 552 553 return err; 554} 555 556static __exit void isci_exit(void) 557{ 558 pci_unregister_driver(&isci_pci_driver); 559 sas_release_transport(isci_transport_template); 560} 561 562MODULE_LICENSE("Dual BSD/GPL"); 563MODULE_FIRMWARE(ISCI_FW_NAME); 564module_init(isci_init); 565module_exit(isci_exit); 566