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