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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
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.
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>
64 #include "probe_roms.h"
66 static struct scsi_transport_template *isci_transport_template;
68 static DEFINE_PCI_DEVICE_TABLE(isci_id_table) = {
69 { PCI_VDEVICE(INTEL, 0x1D61),},
70 { PCI_VDEVICE(INTEL, 0x1D63),},
71 { PCI_VDEVICE(INTEL, 0x1D65),},
72 { PCI_VDEVICE(INTEL, 0x1D67),},
73 { PCI_VDEVICE(INTEL, 0x1D69),},
74 { PCI_VDEVICE(INTEL, 0x1D6B),},
75 { PCI_VDEVICE(INTEL, 0x1D60),},
76 { PCI_VDEVICE(INTEL, 0x1D62),},
77 { PCI_VDEVICE(INTEL, 0x1D64),},
78 { PCI_VDEVICE(INTEL, 0x1D66),},
79 { PCI_VDEVICE(INTEL, 0x1D68),},
80 { PCI_VDEVICE(INTEL, 0x1D6A),},
84 MODULE_DEVICE_TABLE(pci, isci_id_table);
86 /* linux isci specific settings */
88 unsigned char no_outbound_task_to = 20;
89 module_param(no_outbound_task_to, byte, 0);
90 MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
92 u16 ssp_max_occ_to = 20;
93 module_param(ssp_max_occ_to, ushort, 0);
94 MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
96 u16 stp_max_occ_to = 5;
97 module_param(stp_max_occ_to, ushort, 0);
98 MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
100 u16 ssp_inactive_to = 5;
101 module_param(ssp_inactive_to, ushort, 0);
102 MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
104 u16 stp_inactive_to = 5;
105 module_param(stp_inactive_to, ushort, 0);
106 MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
108 unsigned char phy_gen = 3;
109 module_param(phy_gen, byte, 0);
110 MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
112 unsigned char max_concurr_spinup = 1;
113 module_param(max_concurr_spinup, byte, 0);
114 MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
116 static struct scsi_host_template isci_sht = {
118 .module = THIS_MODULE,
120 .proc_name = DRV_NAME,
121 .queuecommand = sas_queuecommand,
122 .target_alloc = sas_target_alloc,
123 .slave_configure = sas_slave_configure,
124 .slave_destroy = sas_slave_destroy,
125 .scan_finished = isci_host_scan_finished,
126 .scan_start = isci_host_scan_start,
127 .change_queue_depth = sas_change_queue_depth,
128 .change_queue_type = sas_change_queue_type,
129 .bios_param = sas_bios_param,
130 .can_queue = ISCI_CAN_QUEUE_VAL,
133 .sg_tablesize = SG_ALL,
134 .max_sectors = SCSI_DEFAULT_MAX_SECTORS,
135 .use_clustering = ENABLE_CLUSTERING,
136 .eh_device_reset_handler = sas_eh_device_reset_handler,
137 .eh_bus_reset_handler = isci_bus_reset_handler,
138 .slave_alloc = sas_slave_alloc,
139 .target_destroy = sas_target_destroy,
143 static struct sas_domain_function_template isci_transport_ops = {
145 /* The class calls these to notify the LLDD of an event. */
146 .lldd_port_formed = isci_port_formed,
147 .lldd_port_deformed = isci_port_deformed,
149 /* The class calls these when a device is found or gone. */
150 .lldd_dev_found = isci_remote_device_found,
151 .lldd_dev_gone = isci_remote_device_gone,
153 .lldd_execute_task = isci_task_execute_task,
154 /* Task Management Functions. Must be called from process context. */
155 .lldd_abort_task = isci_task_abort_task,
156 .lldd_abort_task_set = isci_task_abort_task_set,
157 .lldd_clear_aca = isci_task_clear_aca,
158 .lldd_clear_task_set = isci_task_clear_task_set,
159 .lldd_I_T_nexus_reset = isci_task_I_T_nexus_reset,
160 .lldd_lu_reset = isci_task_lu_reset,
161 .lldd_query_task = isci_task_query_task,
163 /* Port and Adapter management */
164 .lldd_clear_nexus_port = isci_task_clear_nexus_port,
165 .lldd_clear_nexus_ha = isci_task_clear_nexus_ha,
168 .lldd_control_phy = isci_phy_control,
172 /******************************************************************************
173 * P R O T E C T E D M E T H O D S
174 ******************************************************************************/
179 * isci_register_sas_ha() - This method initializes various lldd
180 * specific members of the sas_ha struct and calls the libsas
181 * sas_register_ha() function.
182 * @isci_host: This parameter specifies the lldd specific wrapper for the
183 * libsas sas_ha struct.
185 * This method returns an error code indicating sucess or failure. The user
186 * should check for possible memory allocation error return otherwise, a zero
189 static int isci_register_sas_ha(struct isci_host *isci_host)
192 struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
193 struct asd_sas_phy **sas_phys;
194 struct asd_sas_port **sas_ports;
196 sas_phys = devm_kzalloc(&isci_host->pdev->dev,
197 SCI_MAX_PHYS * sizeof(void *),
202 sas_ports = devm_kzalloc(&isci_host->pdev->dev,
203 SCI_MAX_PORTS * sizeof(void *),
208 /*----------------- Libsas Initialization Stuff----------------------
209 * Set various fields in the sas_ha struct:
212 sas_ha->sas_ha_name = DRV_NAME;
213 sas_ha->lldd_module = THIS_MODULE;
214 sas_ha->sas_addr = &isci_host->phys[0].sas_addr[0];
216 /* set the array of phy and port structs. */
217 for (i = 0; i < SCI_MAX_PHYS; i++) {
218 sas_phys[i] = &isci_host->phys[i].sas_phy;
219 sas_ports[i] = &isci_host->ports[i].sas_port;
222 sas_ha->sas_phy = sas_phys;
223 sas_ha->sas_port = sas_ports;
224 sas_ha->num_phys = SCI_MAX_PHYS;
226 sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL;
227 sas_ha->lldd_max_execute_num = 1;
228 sas_ha->strict_wide_ports = 1;
230 sas_register_ha(sas_ha);
235 static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
237 struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
238 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
239 struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
241 return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
244 static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
246 static void isci_unregister(struct isci_host *isci_host)
248 struct Scsi_Host *shost;
253 shost = isci_host->shost;
254 device_remove_file(&shost->shost_dev, &dev_attr_isci_id);
256 sas_unregister_ha(&isci_host->sas_ha);
258 sas_remove_host(isci_host->shost);
259 scsi_remove_host(isci_host->shost);
260 scsi_host_put(isci_host->shost);
263 static int __devinit isci_pci_init(struct pci_dev *pdev)
265 int err, bar_num, bar_mask = 0;
266 void __iomem * const *iomap;
268 err = pcim_enable_device(pdev);
271 "failed enable PCI device %s!\n",
276 for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
277 bar_mask |= 1 << (bar_num * 2);
279 err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
283 iomap = pcim_iomap_table(pdev);
287 pci_set_master(pdev);
289 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
291 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
296 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
298 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
306 static int num_controllers(struct pci_dev *pdev)
308 /* bar size alone can tell us if we are running with a dual controller
309 * part, no need to trust revision ids that might be under broken firmware
312 resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
313 resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
315 if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
316 smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
317 return SCI_MAX_CONTROLLERS;
322 static int isci_setup_interrupts(struct pci_dev *pdev)
324 int err, i, num_msix;
325 struct isci_host *ihost;
326 struct isci_pci_info *pci_info = to_pci_info(pdev);
329 * Determine the number of vectors associated with this
332 num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
334 for (i = 0; i < num_msix; i++)
335 pci_info->msix_entries[i].entry = i;
337 err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix);
341 for (i = 0; i < num_msix; i++) {
342 int id = i / SCI_NUM_MSI_X_INT;
343 struct msix_entry *msix = &pci_info->msix_entries[i];
346 ihost = pci_info->hosts[id];
347 /* odd numbered vectors are error interrupts */
349 isr = isci_error_isr;
353 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
354 DRV_NAME"-msix", ihost);
358 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
360 id = i / SCI_NUM_MSI_X_INT;
361 ihost = pci_info->hosts[id];
362 msix = &pci_info->msix_entries[i];
363 devm_free_irq(&pdev->dev, msix->vector, ihost);
365 pci_disable_msix(pdev);
371 for_each_isci_host(i, ihost, pdev) {
372 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
373 IRQF_SHARED, DRV_NAME"-intx", ihost);
380 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
382 struct isci_host *isci_host;
383 struct Scsi_Host *shost;
386 isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host), GFP_KERNEL);
390 isci_host->pdev = pdev;
393 shost = scsi_host_alloc(&isci_sht, sizeof(void *));
396 isci_host->shost = shost;
398 err = isci_host_init(isci_host);
402 SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha;
403 isci_host->sas_ha.core.shost = shost;
404 shost->transportt = isci_transport_template;
408 shost->max_cmd_len = MAX_COMMAND_SIZE;
410 err = scsi_add_host(shost, &pdev->dev);
414 err = isci_register_sas_ha(isci_host);
416 goto err_shost_remove;
418 err = device_create_file(&shost->shost_dev, &dev_attr_isci_id);
420 goto err_unregister_ha;
425 sas_unregister_ha(&(isci_host->sas_ha));
427 scsi_remove_host(shost);
429 scsi_host_put(shost);
434 static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
436 struct isci_pci_info *pci_info;
438 struct isci_host *isci_host;
439 const struct firmware *fw = NULL;
440 struct isci_orom *orom = NULL;
441 char *source = "(platform)";
443 dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
446 pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
449 pci_set_drvdata(pdev, pci_info);
452 orom = isci_get_efi_var(pdev);
455 orom = isci_request_oprom(pdev);
457 for (i = 0; orom && i < ARRAY_SIZE(orom->ctrl); i++) {
458 if (sci_oem_parameters_validate(&orom->ctrl[i])) {
460 "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
461 devm_kfree(&pdev->dev, orom);
468 source = "(firmware)";
469 orom = isci_request_firmware(pdev, fw);
471 /* TODO convert this to WARN_TAINT_ONCE once the
472 * orom/efi parameter support is widely available
475 "Loading user firmware failed, using default "
478 "Default OEM configuration being used: 4 "
479 "narrow ports, and default SAS Addresses\n");
485 "OEM SAS parameters (version: %u.%u) loaded %s\n",
486 (orom->hdr.version & 0xf0) >> 4,
487 (orom->hdr.version & 0xf), source);
489 pci_info->orom = orom;
491 err = isci_pci_init(pdev);
495 for (i = 0; i < num_controllers(pdev); i++) {
496 struct isci_host *h = isci_host_alloc(pdev, i);
502 pci_info->hosts[i] = h;
505 err = isci_setup_interrupts(pdev);
509 for_each_isci_host(i, isci_host, pdev)
510 scsi_scan_host(isci_host->shost);
515 for_each_isci_host(i, isci_host, pdev)
516 isci_unregister(isci_host);
520 static void __devexit isci_pci_remove(struct pci_dev *pdev)
522 struct isci_host *ihost;
525 for_each_isci_host(i, ihost, pdev) {
526 isci_unregister(ihost);
527 isci_host_deinit(ihost);
528 sci_controller_disable_interrupts(ihost);
532 static struct pci_driver isci_pci_driver = {
534 .id_table = isci_id_table,
535 .probe = isci_pci_probe,
536 .remove = __devexit_p(isci_pci_remove),
539 static __init int isci_init(void)
543 pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME);
545 isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
546 if (!isci_transport_template)
549 err = pci_register_driver(&isci_pci_driver);
551 sas_release_transport(isci_transport_template);
556 static __exit void isci_exit(void)
558 pci_unregister_driver(&isci_pci_driver);
559 sas_release_transport(isci_transport_template);
562 MODULE_LICENSE("Dual BSD/GPL");
563 MODULE_FIRMWARE(ISCI_FW_NAME);
564 module_init(isci_init);
565 module_exit(isci_exit);