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