init.c revision e531381e2f8a68b8737c63c7bb890ad80b2470bd
1/* 2 * This file is provided under a dual BSD/GPLv2 license. When using or 3 * redistributing this file, you may do so under either license. 4 * 5 * GPL LICENSE SUMMARY 6 * 7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of version 2 of the GNU General Public License as 11 * published by the Free Software Foundation. 12 * 13 * This program is distributed in the hope that it will be useful, but 14 * WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 * General Public License for more details. 17 * 18 * You should have received a copy of the GNU General Public License 19 * along with this program; if not, write to the Free Software 20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21 * The full GNU General Public License is included in this distribution 22 * in the file called LICENSE.GPL. 23 * 24 * BSD LICENSE 25 * 26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27 * All rights reserved. 28 * 29 * Redistribution and use in source and binary forms, with or without 30 * modification, are permitted provided that the following conditions 31 * are met: 32 * 33 * * Redistributions of source code must retain the above copyright 34 * notice, this list of conditions and the following disclaimer. 35 * * Redistributions in binary form must reproduce the above copyright 36 * notice, this list of conditions and the following disclaimer in 37 * the documentation and/or other materials provided with the 38 * distribution. 39 * * Neither the name of Intel Corporation nor the names of its 40 * contributors may be used to endorse or promote products derived 41 * from this software without specific prior written permission. 42 * 43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 54 */ 55 56#include <linux/kernel.h> 57#include <linux/init.h> 58#include <linux/module.h> 59#include <linux/firmware.h> 60#include <linux/efi.h> 61#include <asm/string.h> 62#include "isci.h" 63#include "task.h" 64#include "sci_controller_constants.h" 65#include "sci_environment.h" 66#include "probe_roms.h" 67 68static struct scsi_transport_template *isci_transport_template; 69 70static DEFINE_PCI_DEVICE_TABLE(isci_id_table) = { 71 { PCI_VDEVICE(INTEL, 0x1D61),}, 72 { PCI_VDEVICE(INTEL, 0x1D63),}, 73 { PCI_VDEVICE(INTEL, 0x1D65),}, 74 { PCI_VDEVICE(INTEL, 0x1D67),}, 75 { PCI_VDEVICE(INTEL, 0x1D69),}, 76 { PCI_VDEVICE(INTEL, 0x1D6B),}, 77 { PCI_VDEVICE(INTEL, 0x1D60),}, 78 { PCI_VDEVICE(INTEL, 0x1D62),}, 79 { PCI_VDEVICE(INTEL, 0x1D64),}, 80 { PCI_VDEVICE(INTEL, 0x1D66),}, 81 { PCI_VDEVICE(INTEL, 0x1D68),}, 82 { PCI_VDEVICE(INTEL, 0x1D6A),}, 83 {} 84}; 85 86MODULE_DEVICE_TABLE(pci, isci_id_table); 87 88/* linux isci specific settings */ 89 90int isci_si_rev = ISCI_SI_REVA2; 91module_param(isci_si_rev, int, 0); 92MODULE_PARM_DESC(isci_si_rev, "(deprecated) override default si rev (0: A0 1: A2 2: B0)"); 93 94unsigned char no_outbound_task_to = 20; 95module_param(no_outbound_task_to, byte, 0); 96MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)"); 97 98u16 ssp_max_occ_to = 20; 99module_param(ssp_max_occ_to, ushort, 0); 100MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)"); 101 102u16 stp_max_occ_to = 5; 103module_param(stp_max_occ_to, ushort, 0); 104MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)"); 105 106u16 ssp_inactive_to = 5; 107module_param(ssp_inactive_to, ushort, 0); 108MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)"); 109 110u16 stp_inactive_to = 5; 111module_param(stp_inactive_to, ushort, 0); 112MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)"); 113 114unsigned char phy_gen = 3; 115module_param(phy_gen, byte, 0); 116MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)"); 117 118unsigned char max_concurr_spinup = 1; 119module_param(max_concurr_spinup, byte, 0); 120MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup"); 121 122static struct scsi_host_template isci_sht = { 123 124 .module = THIS_MODULE, 125 .name = DRV_NAME, 126 .proc_name = DRV_NAME, 127 .queuecommand = sas_queuecommand, 128 .target_alloc = sas_target_alloc, 129 .slave_configure = sas_slave_configure, 130 .slave_destroy = sas_slave_destroy, 131 .scan_finished = isci_host_scan_finished, 132 .scan_start = isci_host_scan_start, 133 .change_queue_depth = sas_change_queue_depth, 134 .change_queue_type = sas_change_queue_type, 135 .bios_param = sas_bios_param, 136 .can_queue = ISCI_CAN_QUEUE_VAL, 137 .cmd_per_lun = 1, 138 .this_id = -1, 139 .sg_tablesize = SG_ALL, 140 .max_sectors = SCSI_DEFAULT_MAX_SECTORS, 141 .use_clustering = ENABLE_CLUSTERING, 142 .eh_device_reset_handler = sas_eh_device_reset_handler, 143 .eh_bus_reset_handler = isci_bus_reset_handler, 144 .slave_alloc = sas_slave_alloc, 145 .target_destroy = sas_target_destroy, 146 .ioctl = sas_ioctl, 147}; 148 149static struct sas_domain_function_template isci_transport_ops = { 150 151 /* The class calls these to notify the LLDD of an event. */ 152 .lldd_port_formed = isci_port_formed, 153 .lldd_port_deformed = isci_port_deformed, 154 155 /* The class calls these when a device is found or gone. */ 156 .lldd_dev_found = isci_remote_device_found, 157 .lldd_dev_gone = isci_remote_device_gone, 158 159 .lldd_execute_task = isci_task_execute_task, 160 /* Task Management Functions. Must be called from process context. */ 161 .lldd_abort_task = isci_task_abort_task, 162 .lldd_abort_task_set = isci_task_abort_task_set, 163 .lldd_clear_aca = isci_task_clear_aca, 164 .lldd_clear_task_set = isci_task_clear_task_set, 165 .lldd_I_T_nexus_reset = isci_task_I_T_nexus_reset, 166 .lldd_lu_reset = isci_task_lu_reset, 167 .lldd_query_task = isci_task_query_task, 168 169 /* Port and Adapter management */ 170 .lldd_clear_nexus_port = isci_task_clear_nexus_port, 171 .lldd_clear_nexus_ha = isci_task_clear_nexus_ha, 172 173 /* Phy management */ 174 .lldd_control_phy = isci_phy_control, 175}; 176 177 178/****************************************************************************** 179* P R O T E C T E D M E T H O D S 180******************************************************************************/ 181 182 183 184/** 185 * isci_register_sas_ha() - This method initializes various lldd 186 * specific members of the sas_ha struct and calls the libsas 187 * sas_register_ha() function. 188 * @isci_host: This parameter specifies the lldd specific wrapper for the 189 * libsas sas_ha struct. 190 * 191 * This method returns an error code indicating sucess or failure. The user 192 * should check for possible memory allocation error return otherwise, a zero 193 * indicates success. 194 */ 195static int isci_register_sas_ha(struct isci_host *isci_host) 196{ 197 int i; 198 struct sas_ha_struct *sas_ha = &(isci_host->sas_ha); 199 struct asd_sas_phy **sas_phys; 200 struct asd_sas_port **sas_ports; 201 202 sas_phys = devm_kzalloc(&isci_host->pdev->dev, 203 SCI_MAX_PHYS * sizeof(void *), 204 GFP_KERNEL); 205 if (!sas_phys) 206 return -ENOMEM; 207 208 sas_ports = devm_kzalloc(&isci_host->pdev->dev, 209 SCI_MAX_PORTS * sizeof(void *), 210 GFP_KERNEL); 211 if (!sas_ports) 212 return -ENOMEM; 213 214 /*----------------- Libsas Initialization Stuff---------------------- 215 * Set various fields in the sas_ha struct: 216 */ 217 218 sas_ha->sas_ha_name = DRV_NAME; 219 sas_ha->lldd_module = THIS_MODULE; 220 sas_ha->sas_addr = &isci_host->phys[0].sas_addr[0]; 221 222 /* set the array of phy and port structs. */ 223 for (i = 0; i < SCI_MAX_PHYS; i++) { 224 sas_phys[i] = &isci_host->phys[i].sas_phy; 225 sas_ports[i] = &isci_host->ports[i].sas_port; 226 } 227 228 sas_ha->sas_phy = sas_phys; 229 sas_ha->sas_port = sas_ports; 230 sas_ha->num_phys = SCI_MAX_PHYS; 231 232 sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL; 233 sas_ha->lldd_max_execute_num = 1; 234 sas_ha->strict_wide_ports = 1; 235 236 sas_register_ha(sas_ha); 237 238 return 0; 239} 240 241static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf) 242{ 243 struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev); 244 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost); 245 struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha); 246 247 return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id); 248} 249 250static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL); 251 252static void isci_unregister(struct isci_host *isci_host) 253{ 254 struct Scsi_Host *shost; 255 256 if (!isci_host) 257 return; 258 259 shost = isci_host->shost; 260 device_remove_file(&shost->shost_dev, &dev_attr_isci_id); 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 err = device_create_file(&shost->shost_dev, &dev_attr_isci_id); 425 if (err) 426 goto err_unregister_ha; 427 428 return isci_host; 429 430 err_unregister_ha: 431 sas_unregister_ha(&(isci_host->sas_ha)); 432 err_shost_remove: 433 scsi_remove_host(shost); 434 err_shost: 435 scsi_host_put(shost); 436 437 return NULL; 438} 439 440static void check_si_rev(struct pci_dev *pdev) 441{ 442 if (num_controllers(pdev) > 1) 443 isci_si_rev = ISCI_SI_REVB0; 444 else { 445 switch (pdev->revision) { 446 case 0: 447 case 1: 448 /* if the id is ambiguous don't update isci_si_rev */ 449 break; 450 case 3: 451 isci_si_rev = ISCI_SI_REVA2; 452 break; 453 default: 454 case 4: 455 isci_si_rev = ISCI_SI_REVB0; 456 break; 457 } 458 } 459 460 dev_info(&pdev->dev, "driver configured for %s silicon (rev: %d)\n", 461 isci_si_rev == ISCI_SI_REVA0 ? "A0" : 462 isci_si_rev == ISCI_SI_REVA2 ? "A2" : "B0", pdev->revision); 463 464} 465 466static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id) 467{ 468 struct isci_pci_info *pci_info; 469 int err, i; 470 struct isci_host *isci_host; 471 const struct firmware *fw = NULL; 472 struct isci_orom *orom = NULL; 473 char *source = "(platform)"; 474 475 check_si_rev(pdev); 476 477 pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL); 478 if (!pci_info) 479 return -ENOMEM; 480 pci_set_drvdata(pdev, pci_info); 481 482 if (efi_enabled) 483 orom = isci_get_efi_var(pdev); 484 485 if (!orom) 486 orom = isci_request_oprom(pdev); 487 488 for (i = 0; orom && i < ARRAY_SIZE(orom->ctrl); i++) { 489 if (scic_oem_parameters_validate(&orom->ctrl[i])) { 490 dev_warn(&pdev->dev, 491 "[%d]: invalid oem parameters detected, falling back to firmware\n", i); 492 devm_kfree(&pdev->dev, orom); 493 orom = NULL; 494 break; 495 } 496 } 497 498 if (!orom) { 499 source = "(firmware)"; 500 orom = isci_request_firmware(pdev, fw); 501 if (!orom) { 502 /* TODO convert this to WARN_TAINT_ONCE once the 503 * orom/efi parameter support is widely available 504 */ 505 dev_warn(&pdev->dev, 506 "Loading user firmware failed, using default " 507 "values\n"); 508 dev_warn(&pdev->dev, 509 "Default OEM configuration being used: 4 " 510 "narrow ports, and default SAS Addresses\n"); 511 } 512 } 513 514 if (orom) 515 dev_info(&pdev->dev, 516 "OEM SAS parameters (version: %u.%u) loaded %s\n", 517 (orom->hdr.version & 0xf0) >> 4, 518 (orom->hdr.version & 0xf), source); 519 520 pci_info->orom = orom; 521 522 err = isci_pci_init(pdev); 523 if (err) 524 return err; 525 526 for (i = 0; i < num_controllers(pdev); i++) { 527 struct isci_host *h = isci_host_alloc(pdev, i); 528 529 if (!h) { 530 err = -ENOMEM; 531 goto err_host_alloc; 532 } 533 pci_info->hosts[i] = h; 534 } 535 536 err = isci_setup_interrupts(pdev); 537 if (err) 538 goto err_host_alloc; 539 540 for_each_isci_host(i, isci_host, pdev) 541 scsi_scan_host(isci_host->shost); 542 543 return 0; 544 545 err_host_alloc: 546 for_each_isci_host(i, isci_host, pdev) 547 isci_unregister(isci_host); 548 return err; 549} 550 551static void __devexit isci_pci_remove(struct pci_dev *pdev) 552{ 553 struct isci_host *isci_host; 554 int i; 555 556 for_each_isci_host(i, isci_host, pdev) { 557 isci_unregister(isci_host); 558 isci_host_deinit(isci_host); 559 scic_controller_disable_interrupts(&isci_host->sci); 560 } 561} 562 563static struct pci_driver isci_pci_driver = { 564 .name = DRV_NAME, 565 .id_table = isci_id_table, 566 .probe = isci_pci_probe, 567 .remove = __devexit_p(isci_pci_remove), 568}; 569 570static __init int isci_init(void) 571{ 572 int err; 573 574 pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME); 575 576 isci_transport_template = sas_domain_attach_transport(&isci_transport_ops); 577 if (!isci_transport_template) 578 return -ENOMEM; 579 580 err = pci_register_driver(&isci_pci_driver); 581 if (err) 582 sas_release_transport(isci_transport_template); 583 584 return err; 585} 586 587static __exit void isci_exit(void) 588{ 589 pci_unregister_driver(&isci_pci_driver); 590 sas_release_transport(isci_transport_template); 591} 592 593MODULE_LICENSE("Dual BSD/GPL"); 594MODULE_FIRMWARE(ISCI_FW_NAME); 595module_init(isci_init); 596module_exit(isci_exit); 597