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 "sci_controller_constants.h"
65 #include "scic_remote_device.h"
66 #include "sci_environment.h"
67 #include "probe_roms.h"
69 static struct scsi_transport_template
*isci_transport_template
;
71 static DEFINE_PCI_DEVICE_TABLE(isci_id_table
) = {
72 { PCI_VDEVICE(INTEL
, 0x1D61),},
73 { PCI_VDEVICE(INTEL
, 0x1D63),},
74 { PCI_VDEVICE(INTEL
, 0x1D65),},
75 { PCI_VDEVICE(INTEL
, 0x1D67),},
76 { PCI_VDEVICE(INTEL
, 0x1D69),},
77 { PCI_VDEVICE(INTEL
, 0x1D6B),},
78 { PCI_VDEVICE(INTEL
, 0x1D60),},
79 { PCI_VDEVICE(INTEL
, 0x1D62),},
80 { PCI_VDEVICE(INTEL
, 0x1D64),},
81 { PCI_VDEVICE(INTEL
, 0x1D66),},
82 { PCI_VDEVICE(INTEL
, 0x1D68),},
83 { PCI_VDEVICE(INTEL
, 0x1D6A),},
87 struct isci_firmware
*isci_firmware
;
89 static int __devinit
isci_pci_probe(
91 const struct pci_device_id
*device_id_p
);
93 static void __devexit
isci_pci_remove(struct pci_dev
*pdev
);
95 MODULE_DEVICE_TABLE(pci
, isci_id_table
);
97 static struct pci_driver isci_pci_driver
= {
99 .id_table
= isci_id_table
,
100 .probe
= isci_pci_probe
,
101 .remove
= __devexit_p(isci_pci_remove
),
104 /* linux isci specific settings */
106 #if defined(CONFIG_PBG_HBA_A0)
107 int isci_si_rev
= ISCI_SI_REVA0
;
108 #elif defined(CONFIG_PBG_HBA_A2)
109 int isci_si_rev
= ISCI_SI_REVA2
;
111 int isci_si_rev
= ISCI_SI_REVB0
;
113 module_param(isci_si_rev
, int, 0);
114 MODULE_PARM_DESC(isci_si_rev
, "override default si rev (0: A0 1: A2 2: B0)");
116 unsigned char no_outbound_task_to
= 20;
117 module_param(no_outbound_task_to
, byte
, 0);
118 MODULE_PARM_DESC(no_outbound_task_to
, "No Outbound Task Timeout (1us incr)");
120 u16 ssp_max_occ_to
= 20;
121 module_param(ssp_max_occ_to
, ushort
, 0);
122 MODULE_PARM_DESC(ssp_max_occ_to
, "SSP Max occupancy timeout (100us incr)");
124 u16 stp_max_occ_to
= 5;
125 module_param(stp_max_occ_to
, ushort
, 0);
126 MODULE_PARM_DESC(stp_max_occ_to
, "STP Max occupancy timeout (100us incr)");
128 u16 ssp_inactive_to
= 5;
129 module_param(ssp_inactive_to
, ushort
, 0);
130 MODULE_PARM_DESC(ssp_inactive_to
, "SSP inactivity timeout (100us incr)");
132 u16 stp_inactive_to
= 5;
133 module_param(stp_inactive_to
, ushort
, 0);
134 MODULE_PARM_DESC(stp_inactive_to
, "STP inactivity timeout (100us incr)");
136 unsigned char phy_gen
= 3;
137 module_param(phy_gen
, byte
, 0);
138 MODULE_PARM_DESC(phy_gen
, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
140 unsigned char max_concurr_spinup
= 1;
141 module_param(max_concurr_spinup
, byte
, 0);
142 MODULE_PARM_DESC(max_concurr_spinup
, "Max concurrent device spinup");
144 static struct scsi_host_template isci_sht
= {
146 .module
= THIS_MODULE
,
148 .proc_name
= DRV_NAME
,
149 .queuecommand
= sas_queuecommand
,
150 .target_alloc
= sas_target_alloc
,
151 .slave_configure
= sas_slave_configure
,
152 .slave_destroy
= sas_slave_destroy
,
153 .scan_finished
= isci_host_scan_finished
,
154 .scan_start
= isci_host_scan_start
,
155 .change_queue_depth
= sas_change_queue_depth
,
156 .change_queue_type
= sas_change_queue_type
,
157 .bios_param
= sas_bios_param
,
158 .can_queue
= ISCI_CAN_QUEUE_VAL
,
161 .sg_tablesize
= SG_ALL
,
162 .max_sectors
= SCSI_DEFAULT_MAX_SECTORS
,
163 .use_clustering
= ENABLE_CLUSTERING
,
164 .eh_device_reset_handler
= sas_eh_device_reset_handler
,
165 .eh_bus_reset_handler
= isci_bus_reset_handler
,
166 .slave_alloc
= sas_slave_alloc
,
167 .target_destroy
= sas_target_destroy
,
171 static struct sas_domain_function_template isci_transport_ops
= {
173 /* The class calls these to notify the LLDD of an event. */
174 .lldd_port_formed
= isci_port_formed
,
175 .lldd_port_deformed
= isci_port_deformed
,
177 /* The class calls these when a device is found or gone. */
178 .lldd_dev_found
= isci_remote_device_found
,
179 .lldd_dev_gone
= isci_remote_device_gone
,
181 .lldd_execute_task
= isci_task_execute_task
,
182 /* Task Management Functions. Must be called from process context. */
183 .lldd_abort_task
= isci_task_abort_task
,
184 .lldd_abort_task_set
= isci_task_abort_task_set
,
185 .lldd_clear_aca
= isci_task_clear_aca
,
186 .lldd_clear_task_set
= isci_task_clear_task_set
,
187 .lldd_I_T_nexus_reset
= isci_task_I_T_nexus_reset
,
188 .lldd_lu_reset
= isci_task_lu_reset
,
189 .lldd_query_task
= isci_task_query_task
,
191 /* Port and Adapter management */
192 .lldd_clear_nexus_port
= isci_task_clear_nexus_port
,
193 .lldd_clear_nexus_ha
= isci_task_clear_nexus_ha
,
196 .lldd_control_phy
= isci_phy_control
,
200 /******************************************************************************
201 * P R O T E C T E D M E T H O D S
202 ******************************************************************************/
207 * isci_register_sas_ha() - This method initializes various lldd
208 * specific members of the sas_ha struct and calls the libsas
209 * sas_register_ha() function.
210 * @isci_host: This parameter specifies the lldd specific wrapper for the
211 * libsas sas_ha struct.
213 * This method returns an error code indicating sucess or failure. The user
214 * should check for possible memory allocation error return otherwise, a zero
217 static int isci_register_sas_ha(struct isci_host
*isci_host
)
220 struct sas_ha_struct
*sas_ha
= &(isci_host
->sas_ha
);
221 struct asd_sas_phy
**sas_phys
;
222 struct asd_sas_port
**sas_ports
;
224 sas_phys
= devm_kzalloc(&isci_host
->pdev
->dev
,
225 SCI_MAX_PHYS
* sizeof(void *),
230 sas_ports
= devm_kzalloc(&isci_host
->pdev
->dev
,
231 SCI_MAX_PORTS
* sizeof(void *),
236 /*----------------- Libsas Initialization Stuff----------------------
237 * Set various fields in the sas_ha struct:
240 sas_ha
->sas_ha_name
= DRV_NAME
;
241 sas_ha
->lldd_module
= THIS_MODULE
;
242 sas_ha
->sas_addr
= &isci_host
->phys
[0].sas_addr
[0];
244 /* set the array of phy and port structs. */
245 for (i
= 0; i
< SCI_MAX_PHYS
; i
++) {
246 sas_phys
[i
] = &(isci_host
->phys
[i
].sas_phy
);
247 sas_ports
[i
] = &(isci_host
->sas_ports
[i
]);
250 sas_ha
->sas_phy
= sas_phys
;
251 sas_ha
->sas_port
= sas_ports
;
252 sas_ha
->num_phys
= SCI_MAX_PHYS
;
254 sas_ha
->lldd_queue_size
= ISCI_CAN_QUEUE_VAL
;
255 sas_ha
->lldd_max_execute_num
= 1;
256 sas_ha
->strict_wide_ports
= 1;
258 sas_register_ha(sas_ha
);
263 static ssize_t
isci_show_id(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
265 struct Scsi_Host
*shost
= container_of(dev
, typeof(*shost
), shost_dev
);
266 struct sas_ha_struct
*sas_ha
= SHOST_TO_SAS_HA(shost
);
267 struct isci_host
*ihost
= container_of(sas_ha
, typeof(*ihost
), sas_ha
);
269 return snprintf(buf
, PAGE_SIZE
, "%d\n", ihost
->id
);
272 static DEVICE_ATTR(isci_id
, S_IRUGO
, isci_show_id
, NULL
);
274 static void isci_unregister(struct isci_host
*isci_host
)
276 struct Scsi_Host
*shost
;
281 shost
= isci_host
->shost
;
282 device_remove_file(&shost
->shost_dev
, &dev_attr_isci_id
);
284 sas_unregister_ha(&isci_host
->sas_ha
);
286 sas_remove_host(isci_host
->shost
);
287 scsi_remove_host(isci_host
->shost
);
288 scsi_host_put(isci_host
->shost
);
291 static int __devinit
isci_pci_init(struct pci_dev
*pdev
)
293 int err
, bar_num
, bar_mask
;
294 void __iomem
* const *iomap
;
296 err
= pcim_enable_device(pdev
);
299 "failed enable PCI device %s!\n",
304 for (bar_num
= 0; bar_num
< SCI_PCI_BAR_COUNT
; bar_num
++)
305 bar_mask
|= 1 << (bar_num
* 2);
307 err
= pcim_iomap_regions(pdev
, bar_mask
, DRV_NAME
);
311 iomap
= pcim_iomap_table(pdev
);
315 pci_set_master(pdev
);
317 err
= pci_set_dma_mask(pdev
, DMA_BIT_MASK(64));
319 err
= pci_set_dma_mask(pdev
, DMA_BIT_MASK(32));
324 err
= pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(64));
326 err
= pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(32));
334 static int num_controllers(struct pci_dev
*pdev
)
336 /* bar size alone can tell us if we are running with a dual controller
337 * part, no need to trust revision ids that might be under broken firmware
340 resource_size_t scu_bar_size
= pci_resource_len(pdev
, SCI_SCU_BAR
*2);
341 resource_size_t smu_bar_size
= pci_resource_len(pdev
, SCI_SMU_BAR
*2);
343 if (scu_bar_size
>= SCI_SCU_BAR_SIZE
*SCI_MAX_CONTROLLERS
&&
344 smu_bar_size
>= SCI_SMU_BAR_SIZE
*SCI_MAX_CONTROLLERS
)
345 return SCI_MAX_CONTROLLERS
;
350 static int isci_setup_interrupts(struct pci_dev
*pdev
)
352 int err
, i
, num_msix
;
353 struct isci_pci_info
*pci_info
= to_pci_info(pdev
);
356 * Determine the number of vectors associated with this
359 num_msix
= num_controllers(pdev
) * SCI_NUM_MSI_X_INT
;
361 for (i
= 0; i
< num_msix
; i
++)
362 pci_info
->msix_entries
[i
].entry
= i
;
364 err
= pci_enable_msix(pdev
, pci_info
->msix_entries
, num_msix
);
368 for (i
= 0; i
< num_msix
; i
++) {
369 int id
= i
/ SCI_NUM_MSI_X_INT
;
370 struct msix_entry
*msix
= &pci_info
->msix_entries
[i
];
371 struct isci_host
*isci_host
= pci_info
->hosts
[id
];
374 /* odd numbered vectors are error interrupts */
376 isr
= isci_error_isr
;
382 err
= devm_request_irq(&pdev
->dev
, msix
->vector
, isr
, 0,
383 DRV_NAME
"-msix", isci_host
);
387 dev_info(&pdev
->dev
, "msix setup failed falling back to intx\n");
389 id
= i
/ SCI_NUM_MSI_X_INT
;
390 isci_host
= pci_info
->hosts
[id
];
391 msix
= &pci_info
->msix_entries
[i
];
392 devm_free_irq(&pdev
->dev
, msix
->vector
, isci_host
);
394 pci_disable_msix(pdev
);
401 err
= devm_request_irq(&pdev
->dev
, pdev
->irq
, isci_intx_isr
,
402 IRQF_SHARED
, DRV_NAME
"-intx", pdev
);
407 static struct isci_host
*isci_host_alloc(struct pci_dev
*pdev
, int id
)
409 struct isci_host
*isci_host
;
410 struct Scsi_Host
*shost
;
413 isci_host
= devm_kzalloc(&pdev
->dev
, sizeof(*isci_host
) +
414 SCI_MAX_REMOTE_DEVICES
*
415 (sizeof(struct isci_remote_device
) +
416 scic_remote_device_get_object_size()), GFP_KERNEL
);
420 isci_host
->pdev
= pdev
;
423 shost
= scsi_host_alloc(&isci_sht
, sizeof(void *));
426 isci_host
->shost
= shost
;
428 err
= isci_host_init(isci_host
);
432 SHOST_TO_SAS_HA(shost
) = &isci_host
->sas_ha
;
433 isci_host
->sas_ha
.core
.shost
= shost
;
434 shost
->transportt
= isci_transport_template
;
438 shost
->max_cmd_len
= MAX_COMMAND_SIZE
;
440 err
= scsi_add_host(shost
, &pdev
->dev
);
444 err
= isci_register_sas_ha(isci_host
);
446 goto err_shost_remove
;
448 err
= device_create_file(&shost
->shost_dev
, &dev_attr_isci_id
);
450 goto err_unregister_ha
;
455 sas_unregister_ha(&(isci_host
->sas_ha
));
457 scsi_remove_host(shost
);
459 scsi_host_put(shost
);
464 static void check_si_rev(struct pci_dev
*pdev
)
466 if (num_controllers(pdev
) > 1)
467 isci_si_rev
= ISCI_SI_REVB0
;
469 switch (pdev
->revision
) {
472 /* if the id is ambiguous don't update isci_si_rev */
475 isci_si_rev
= ISCI_SI_REVA2
;
479 isci_si_rev
= ISCI_SI_REVB0
;
484 dev_info(&pdev
->dev
, "driver configured for %s silicon (rev: %d)\n",
485 isci_si_rev
== ISCI_SI_REVA0
? "A0" :
486 isci_si_rev
== ISCI_SI_REVA2
? "A2" : "B0", pdev
->revision
);
490 static int __devinit
isci_pci_probe(struct pci_dev
*pdev
, const struct pci_device_id
*id
)
492 struct isci_pci_info
*pci_info
;
494 struct isci_host
*isci_host
;
495 const struct firmware
*fw
= NULL
;
496 struct isci_orom
*orom
;
497 char *source
= "(platform)";
501 pci_info
= devm_kzalloc(&pdev
->dev
, sizeof(*pci_info
), GFP_KERNEL
);
504 pci_set_drvdata(pdev
, pci_info
);
507 orom
= isci_get_efi_var(pdev
);
509 orom
= isci_request_oprom(pdev
);
512 source
= "(firmware)";
513 orom
= isci_request_firmware(pdev
, fw
);
515 /* TODO convert this to WARN_TAINT_ONCE once the
516 * orom/efi parameter support is widely available
519 "Loading user firmware failed, using default "
522 "Default OEM configuration being used: 4 "
523 "narrow ports, and default SAS Addresses\n");
529 "OEM SAS parameters (version: %u.%u) loaded %s\n",
530 (orom
->hdr
.version
& 0xf0) >> 4,
531 (orom
->hdr
.version
& 0xf), source
);
533 pci_info
->orom
= orom
;
535 err
= isci_pci_init(pdev
);
539 for (i
= 0; i
< num_controllers(pdev
); i
++) {
540 struct isci_host
*h
= isci_host_alloc(pdev
, i
);
546 pci_info
->hosts
[i
] = h
;
549 err
= isci_setup_interrupts(pdev
);
553 for_each_isci_host(i
, isci_host
, pdev
)
554 scsi_scan_host(isci_host
->shost
);
559 for_each_isci_host(i
, isci_host
, pdev
)
560 isci_unregister(isci_host
);
564 static void __devexit
isci_pci_remove(struct pci_dev
*pdev
)
566 struct isci_host
*isci_host
;
569 for_each_isci_host(i
, isci_host
, pdev
) {
570 isci_unregister(isci_host
);
571 isci_host_deinit(isci_host
);
572 scic_controller_disable_interrupts(isci_host
->core_controller
);
576 static __init
int isci_init(void)
580 pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME
);
582 isci_transport_template
= sas_domain_attach_transport(&isci_transport_ops
);
583 if (!isci_transport_template
)
586 err
= pci_register_driver(&isci_pci_driver
);
588 sas_release_transport(isci_transport_template
);
593 static __exit
void isci_exit(void)
595 pci_unregister_driver(&isci_pci_driver
);
596 sas_release_transport(isci_transport_template
);
599 MODULE_LICENSE("Dual BSD/GPL");
600 MODULE_FIRMWARE(ISCI_FW_NAME
);
601 module_init(isci_init
);
602 module_exit(isci_exit
);