init.c revision 92cd51153d5c18af027ddf42547d59ba4167873c
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 <asm/string.h> 60#include "isci.h" 61#include "task.h" 62#include "sci_controller_constants.h" 63#include "scic_remote_device.h" 64#include "sci_environment.h" 65 66static struct scsi_transport_template *isci_transport_template; 67struct kmem_cache *isci_kmem_cache; 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 85static int __devinit isci_pci_probe( 86 struct pci_dev *pdev, 87 const struct pci_device_id *device_id_p); 88 89static void __devexit isci_pci_remove(struct pci_dev *pdev); 90 91MODULE_DEVICE_TABLE(pci, isci_id_table); 92 93static struct pci_driver isci_pci_driver = { 94 .name = DRV_NAME, 95 .id_table = isci_id_table, 96 .probe = isci_pci_probe, 97 .remove = __devexit_p(isci_pci_remove), 98}; 99 100/* linux isci specific settings */ 101 102#if defined(CONFIG_PBG_HBA_A0) 103int isci_si_rev = ISCI_SI_REVA0; 104#elif defined(CONFIG_PBG_HBA_A2) 105int isci_si_rev = ISCI_SI_REVA2; 106#else 107int isci_si_rev = ISCI_SI_REVB0; 108#endif 109module_param(isci_si_rev, int, S_IRUGO | S_IWUSR); 110MODULE_PARM_DESC(isci_si_rev, "override default si rev (0: A0 1: A2 2: B0)"); 111 112static struct scsi_host_template isci_sht = { 113 114 .module = THIS_MODULE, 115 .name = DRV_NAME, 116 .proc_name = DRV_NAME, 117 .queuecommand = sas_queuecommand, 118 .target_alloc = sas_target_alloc, 119 .slave_configure = sas_slave_configure, 120 .slave_destroy = sas_slave_destroy, 121 .scan_finished = isci_host_scan_finished, 122 .scan_start = isci_host_scan_start, 123 .change_queue_depth = sas_change_queue_depth, 124 .change_queue_type = sas_change_queue_type, 125 .bios_param = sas_bios_param, 126 .can_queue = ISCI_CAN_QUEUE_VAL, 127 .cmd_per_lun = 1, 128 .this_id = -1, 129 .sg_tablesize = SG_ALL, 130 .max_sectors = SCSI_DEFAULT_MAX_SECTORS, 131 .use_clustering = ENABLE_CLUSTERING, 132 .eh_device_reset_handler = sas_eh_device_reset_handler, 133 .eh_bus_reset_handler = isci_bus_reset_handler, 134 .slave_alloc = sas_slave_alloc, 135 .target_destroy = sas_target_destroy, 136 .ioctl = sas_ioctl, 137}; 138 139static struct sas_domain_function_template isci_transport_ops = { 140 141 /* The class calls these to notify the LLDD of an event. */ 142 .lldd_port_formed = isci_port_formed, 143 .lldd_port_deformed = isci_port_deformed, 144 145 /* The class calls these when a device is found or gone. */ 146 .lldd_dev_found = isci_remote_device_found, 147 .lldd_dev_gone = isci_remote_device_gone, 148 149 .lldd_execute_task = isci_task_execute_task, 150 /* Task Management Functions. Must be called from process context. */ 151 .lldd_abort_task = isci_task_abort_task, 152 .lldd_abort_task_set = isci_task_abort_task_set, 153 .lldd_clear_aca = isci_task_clear_aca, 154 .lldd_clear_task_set = isci_task_clear_task_set, 155 .lldd_I_T_nexus_reset = isci_task_I_T_nexus_reset, 156 .lldd_lu_reset = isci_task_lu_reset, 157 .lldd_query_task = isci_task_query_task, 158 159 /* Port and Adapter management */ 160 .lldd_clear_nexus_port = isci_task_clear_nexus_port, 161 .lldd_clear_nexus_ha = isci_task_clear_nexus_ha, 162 163 /* Phy management */ 164 .lldd_control_phy = isci_phy_control, 165}; 166 167 168/****************************************************************************** 169* P R O T E C T E D M E T H O D S 170******************************************************************************/ 171 172 173 174/** 175 * isci_register_sas_ha() - This method initializes various lldd 176 * specific members of the sas_ha struct and calls the libsas 177 * sas_register_ha() function. 178 * @isci_host: This parameter specifies the lldd specific wrapper for the 179 * libsas sas_ha struct. 180 * 181 * This method returns an error code indicating sucess or failure. The user 182 * should check for possible memory allocation error return otherwise, a zero 183 * indicates success. 184 */ 185static int isci_register_sas_ha(struct isci_host *isci_host) 186{ 187 int i; 188 struct sas_ha_struct *sas_ha = &(isci_host->sas_ha); 189 struct asd_sas_phy **sas_phys; 190 struct asd_sas_port **sas_ports; 191 192 sas_phys = devm_kzalloc(&isci_host->pdev->dev, 193 SCI_MAX_PHYS * sizeof(void *), 194 GFP_KERNEL); 195 if (!sas_phys) 196 return -ENOMEM; 197 198 sas_ports = devm_kzalloc(&isci_host->pdev->dev, 199 SCI_MAX_PORTS * sizeof(void *), 200 GFP_KERNEL); 201 if (!sas_ports) 202 return -ENOMEM; 203 204 /*----------------- Libsas Initialization Stuff---------------------- 205 * Set various fields in the sas_ha struct: 206 */ 207 208 sas_ha->sas_ha_name = DRV_NAME; 209 sas_ha->lldd_module = THIS_MODULE; 210 sas_ha->sas_addr = &(isci_host->sas_addr[0]); 211 212 /* set the array of phy and port structs. */ 213 for (i = 0; i < SCI_MAX_PHYS; i++) { 214 sas_phys[i] = &(isci_host->phys[i].sas_phy); 215 sas_ports[i] = &(isci_host->sas_ports[i]); 216 } 217 218 sas_ha->sas_phy = sas_phys; 219 sas_ha->sas_port = sas_ports; 220 sas_ha->num_phys = SCI_MAX_PHYS; 221 222 sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL; 223 sas_ha->lldd_max_execute_num = 1; 224 sas_ha->strict_wide_ports = 1; 225 226 sas_register_ha(sas_ha); 227 228 return 0; 229} 230 231static void isci_unregister_sas_ha(struct isci_host *isci_host) 232{ 233 if (!isci_host) 234 return; 235 236 sas_unregister_ha(&(isci_host->sas_ha)); 237 238 sas_remove_host(isci_host->shost); 239 scsi_remove_host(isci_host->shost); 240 scsi_host_put(isci_host->shost); 241} 242 243static int __devinit isci_pci_init(struct pci_dev *pdev) 244{ 245 int err, bar_num, bar_mask; 246 void __iomem * const *iomap; 247 248 err = pcim_enable_device(pdev); 249 if (err) { 250 dev_err(&pdev->dev, 251 "failed enable PCI device %s!\n", 252 pci_name(pdev)); 253 return err; 254 } 255 256 for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++) 257 bar_mask |= 1 << (bar_num * 2); 258 259 err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME); 260 if (err) 261 return err; 262 263 iomap = pcim_iomap_table(pdev); 264 if (!iomap) 265 return -ENOMEM; 266 267 pci_set_master(pdev); 268 269 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64)); 270 if (err) { 271 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32)); 272 if (err) 273 return err; 274 } 275 276 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64)); 277 if (err) { 278 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32)); 279 if (err) 280 return err; 281 } 282 283 return 0; 284} 285 286static struct isci_host *isci_host_by_id(struct pci_dev *pdev, int id) 287{ 288 struct isci_host *h; 289 290 for_each_isci_host(h, pdev) 291 if (h->id == id) 292 return h; 293 return NULL; 294} 295 296static int num_controllers(struct pci_dev *pdev) 297{ 298 /* bar size alone can tell us if we are running with a dual controller 299 * part, no need to trust revision ids that might be under broken firmware 300 * control 301 */ 302 resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2); 303 resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2); 304 305 if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS && 306 smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS) 307 return SCI_MAX_CONTROLLERS; 308 else 309 return 1; 310} 311 312static int isci_setup_interrupts(struct pci_dev *pdev) 313{ 314 int err, i, num_msix; 315 struct isci_pci_info *pci_info = to_pci_info(pdev); 316 317 /* 318 * Determine the number of vectors associated with this 319 * PCI function. 320 */ 321 num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT; 322 323 for (i = 0; i < num_msix; i++) 324 pci_info->msix_entries[i].entry = i; 325 326 err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix); 327 if (err) 328 goto intx; 329 330 for (i = 0; i < num_msix; i++) { 331 int id = i / SCI_NUM_MSI_X_INT; 332 struct msix_entry *msix = &pci_info->msix_entries[i]; 333 struct isci_host *isci_host = isci_host_by_id(pdev, id); 334 irq_handler_t isr; 335 336 /* odd numbered vectors are error interrupts */ 337 if (i & 1) 338 isr = isci_error_isr; 339 else 340 isr = isci_msix_isr; 341 342 BUG_ON(!isci_host); 343 344 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0, 345 DRV_NAME"-msix", isci_host); 346 if (!err) 347 continue; 348 349 dev_info(&pdev->dev, "msix setup failed falling back to intx\n"); 350 while (i--) { 351 id = i / SCI_NUM_MSI_X_INT; 352 isci_host = isci_host_by_id(pdev, id); 353 msix = &pci_info->msix_entries[i]; 354 devm_free_irq(&pdev->dev, msix->vector, isci_host); 355 } 356 pci_disable_msix(pdev); 357 goto intx; 358 } 359 360 return 0; 361 362 intx: 363 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr, 364 IRQF_SHARED, DRV_NAME"-intx", pdev); 365 366 return err; 367} 368 369/** 370 * isci_parse_oem_parameters() - This method will take OEM parameters 371 * from the module init parameters and copy them to oem_params. This will 372 * only copy values that are not set to the module parameter default values 373 * @oem_parameters: This parameter specifies the controller default OEM 374 * parameters. It is expected that this has been initialized to the default 375 * parameters for the controller 376 * 377 * 378 */ 379enum sci_status isci_parse_oem_parameters(union scic_oem_parameters *oem_params, 380 int scu_index, 381 struct isci_firmware *fw) 382{ 383 int i; 384 385 /* check for valid inputs */ 386 if (!(scu_index >= 0 387 && scu_index < SCI_MAX_CONTROLLERS 388 && oem_params != NULL)) { 389 return SCI_FAILURE; 390 } 391 392 for (i = 0; i < SCI_MAX_PHYS; i++) { 393 int array_idx = i + (SCI_MAX_PHYS * scu_index); 394 u64 sas_addr = fw->sas_addrs[array_idx]; 395 396 if (sas_addr != 0) { 397 oem_params->sds1.phys[i].sas_address.low = 398 (u32)(sas_addr & 0xffffffff); 399 oem_params->sds1.phys[i].sas_address.high = 400 (u32)((sas_addr >> 32) & 0xffffffff); 401 } 402 } 403 404 for (i = 0; i < SCI_MAX_PORTS; i++) { 405 int array_idx = i + (SCI_MAX_PORTS * scu_index); 406 u32 pmask = fw->phy_masks[array_idx]; 407 408 oem_params->sds1.ports[i].phy_mask = pmask; 409 } 410 411 return SCI_SUCCESS; 412} 413 414/** 415 * isci_parse_user_parameters() - This method will take user parameters 416 * from the module init parameters and copy them to user_params. This will 417 * only copy values that are not set to the module parameter default values 418 * @user_parameters: This parameter specifies the controller default user 419 * parameters. It is expected that this has been initialized to the default 420 * parameters for the controller 421 * 422 * 423 */ 424enum sci_status isci_parse_user_parameters( 425 union scic_user_parameters *user_params, 426 int scu_index, 427 struct isci_firmware *fw) 428{ 429 int i; 430 431 if (!(scu_index >= 0 432 && scu_index < SCI_MAX_CONTROLLERS 433 && user_params != NULL)) { 434 return SCI_FAILURE; 435 } 436 437 for (i = 0; i < SCI_MAX_PORTS; i++) { 438 int array_idx = i + (SCI_MAX_PORTS * scu_index); 439 u32 gen = fw->phy_gens[array_idx]; 440 441 user_params->sds1.phys[i].max_speed_generation = gen; 442 443 } 444 445 return SCI_SUCCESS; 446} 447 448static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id) 449{ 450 struct isci_host *isci_host; 451 struct Scsi_Host *shost; 452 int err; 453 454 isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host), GFP_KERNEL); 455 if (!isci_host) 456 return NULL; 457 458 isci_host->pdev = pdev; 459 isci_host->id = id; 460 461 shost = scsi_host_alloc(&isci_sht, sizeof(void *)); 462 if (!shost) 463 return NULL; 464 isci_host->shost = shost; 465 466 err = isci_host_init(isci_host); 467 if (err) 468 goto err_shost; 469 470 SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha; 471 isci_host->sas_ha.core.shost = shost; 472 shost->transportt = isci_transport_template; 473 474 shost->max_id = ~0; 475 shost->max_lun = ~0; 476 shost->max_cmd_len = MAX_COMMAND_SIZE; 477 478 err = scsi_add_host(shost, &pdev->dev); 479 if (err) 480 goto err_shost; 481 482 err = isci_register_sas_ha(isci_host); 483 if (err) 484 goto err_shost_remove; 485 486 return isci_host; 487 488 err_shost_remove: 489 scsi_remove_host(shost); 490 err_shost: 491 scsi_host_put(shost); 492 493 return NULL; 494} 495 496static void check_si_rev(struct pci_dev *pdev) 497{ 498 if (num_controllers(pdev) > 1) 499 isci_si_rev = ISCI_SI_REVB0; 500 else { 501 switch (pdev->revision) { 502 case 0: 503 case 1: 504 /* if the id is ambiguous don't update isci_si_rev */ 505 break; 506 case 3: 507 isci_si_rev = ISCI_SI_REVA2; 508 break; 509 default: 510 case 4: 511 isci_si_rev = ISCI_SI_REVB0; 512 break; 513 } 514 } 515 516 dev_info(&pdev->dev, "driver configured for %s silicon (rev: %d)\n", 517 isci_si_rev == ISCI_SI_REVA0 ? "A0" : 518 isci_si_rev == ISCI_SI_REVA2 ? "A2" : "B0", pdev->revision); 519 520} 521 522static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id) 523{ 524 struct isci_pci_info *pci_info; 525 int err, i; 526 struct isci_host *isci_host; 527 528 check_si_rev(pdev); 529 530 pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL); 531 if (!pci_info) 532 return -ENOMEM; 533 pci_set_drvdata(pdev, pci_info); 534 535 err = isci_pci_init(pdev); 536 if (err) 537 return err; 538 539 for (i = 0; i < num_controllers(pdev); i++) { 540 struct isci_host *h = isci_host_alloc(pdev, i); 541 542 if (!h) { 543 err = -ENOMEM; 544 goto err_host_alloc; 545 } 546 547 h->next = pci_info->hosts; 548 pci_info->hosts = h; 549 } 550 551 err = isci_setup_interrupts(pdev); 552 if (err) 553 goto err_host_alloc; 554 555 for_each_isci_host(isci_host, pdev) 556 scsi_scan_host(isci_host->shost); 557 558 return 0; 559 560 err_host_alloc: 561 for_each_isci_host(isci_host, pdev) 562 isci_unregister_sas_ha(isci_host); 563 return err; 564} 565 566static void __devexit isci_pci_remove(struct pci_dev *pdev) 567{ 568 struct isci_host *isci_host; 569 570 for_each_isci_host(isci_host, pdev) { 571 isci_unregister_sas_ha(isci_host); 572 isci_host_deinit(isci_host); 573 scic_controller_disable_interrupts(isci_host->core_controller); 574 } 575} 576 577static __init int isci_init(void) 578{ 579 int err = -ENOMEM; 580 581 pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME); 582 583 isci_kmem_cache = kmem_cache_create(DRV_NAME, 584 sizeof(struct isci_remote_device) + 585 scic_remote_device_get_object_size(), 586 0, 0, NULL); 587 if (!isci_kmem_cache) 588 return err; 589 590 isci_transport_template = sas_domain_attach_transport(&isci_transport_ops); 591 if (!isci_transport_template) 592 goto err_kmem; 593 594 err = pci_register_driver(&isci_pci_driver); 595 if (err) 596 goto err_sas; 597 598 return 0; 599 600 err_sas: 601 sas_release_transport(isci_transport_template); 602 err_kmem: 603 kmem_cache_destroy(isci_kmem_cache); 604 605 return err; 606} 607 608static __exit void isci_exit(void) 609{ 610 pci_unregister_driver(&isci_pci_driver); 611 sas_release_transport(isci_transport_template); 612 kmem_cache_destroy(isci_kmem_cache); 613} 614 615MODULE_LICENSE("Dual BSD/GPL"); 616MODULE_FIRMWARE(ISCI_FW_NAME); 617module_init(isci_init); 618module_exit(isci_exit); 619