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>
62
#include <scsi/scsi_host.h>
65
#include "probe_roms.h"
70
#define DRV_VERSION __stringify(MAJ) "." __stringify(MIN) "." \
73
MODULE_VERSION(DRV_VERSION);
75
static struct scsi_transport_template *isci_transport_template;
77
static 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),},
93
MODULE_DEVICE_TABLE(pci, isci_id_table);
95
/* linux isci specific settings */
97
unsigned char no_outbound_task_to = 20;
98
module_param(no_outbound_task_to, byte, 0);
99
MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
101
u16 ssp_max_occ_to = 20;
102
module_param(ssp_max_occ_to, ushort, 0);
103
MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
105
u16 stp_max_occ_to = 5;
106
module_param(stp_max_occ_to, ushort, 0);
107
MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
109
u16 ssp_inactive_to = 5;
110
module_param(ssp_inactive_to, ushort, 0);
111
MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
113
u16 stp_inactive_to = 5;
114
module_param(stp_inactive_to, ushort, 0);
115
MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
117
unsigned char phy_gen = 3;
118
module_param(phy_gen, byte, 0);
119
MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
121
unsigned char max_concurr_spinup;
122
module_param(max_concurr_spinup, byte, 0);
123
MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
125
static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
127
struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
128
struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
129
struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
131
return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
134
static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
136
struct device_attribute *isci_host_attrs[] = {
141
static struct scsi_host_template isci_sht = {
143
.module = THIS_MODULE,
145
.proc_name = DRV_NAME,
146
.queuecommand = sas_queuecommand,
147
.target_alloc = sas_target_alloc,
148
.slave_configure = sas_slave_configure,
149
.slave_destroy = sas_slave_destroy,
150
.scan_finished = isci_host_scan_finished,
151
.scan_start = isci_host_scan_start,
152
.change_queue_depth = sas_change_queue_depth,
153
.change_queue_type = sas_change_queue_type,
154
.bios_param = sas_bios_param,
155
.can_queue = ISCI_CAN_QUEUE_VAL,
158
.sg_tablesize = SG_ALL,
159
.max_sectors = SCSI_DEFAULT_MAX_SECTORS,
160
.use_clustering = ENABLE_CLUSTERING,
161
.eh_device_reset_handler = sas_eh_device_reset_handler,
162
.eh_bus_reset_handler = isci_bus_reset_handler,
163
.slave_alloc = sas_slave_alloc,
164
.target_destroy = sas_target_destroy,
166
.shost_attrs = isci_host_attrs,
169
static struct sas_domain_function_template isci_transport_ops = {
171
/* The class calls these to notify the LLDD of an event. */
172
.lldd_port_formed = isci_port_formed,
173
.lldd_port_deformed = isci_port_deformed,
175
/* The class calls these when a device is found or gone. */
176
.lldd_dev_found = isci_remote_device_found,
177
.lldd_dev_gone = isci_remote_device_gone,
179
.lldd_execute_task = isci_task_execute_task,
180
/* Task Management Functions. Must be called from process context. */
181
.lldd_abort_task = isci_task_abort_task,
182
.lldd_abort_task_set = isci_task_abort_task_set,
183
.lldd_clear_aca = isci_task_clear_aca,
184
.lldd_clear_task_set = isci_task_clear_task_set,
185
.lldd_I_T_nexus_reset = isci_task_I_T_nexus_reset,
186
.lldd_lu_reset = isci_task_lu_reset,
187
.lldd_query_task = isci_task_query_task,
189
/* Port and Adapter management */
190
.lldd_clear_nexus_port = isci_task_clear_nexus_port,
191
.lldd_clear_nexus_ha = isci_task_clear_nexus_ha,
194
.lldd_control_phy = isci_phy_control,
197
.lldd_write_gpio = isci_gpio_write,
201
/******************************************************************************
202
* P R O T E C T E D M E T H O D S
203
******************************************************************************/
208
* isci_register_sas_ha() - This method initializes various lldd
209
* specific members of the sas_ha struct and calls the libsas
210
* sas_register_ha() function.
211
* @isci_host: This parameter specifies the lldd specific wrapper for the
212
* libsas sas_ha struct.
214
* This method returns an error code indicating sucess or failure. The user
215
* should check for possible memory allocation error return otherwise, a zero
218
static int isci_register_sas_ha(struct isci_host *isci_host)
221
struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
222
struct asd_sas_phy **sas_phys;
223
struct asd_sas_port **sas_ports;
225
sas_phys = devm_kzalloc(&isci_host->pdev->dev,
226
SCI_MAX_PHYS * sizeof(void *),
231
sas_ports = devm_kzalloc(&isci_host->pdev->dev,
232
SCI_MAX_PORTS * sizeof(void *),
237
/*----------------- Libsas Initialization Stuff----------------------
238
* Set various fields in the sas_ha struct:
241
sas_ha->sas_ha_name = DRV_NAME;
242
sas_ha->lldd_module = THIS_MODULE;
243
sas_ha->sas_addr = &isci_host->phys[0].sas_addr[0];
245
/* set the array of phy and port structs. */
246
for (i = 0; i < SCI_MAX_PHYS; i++) {
247
sas_phys[i] = &isci_host->phys[i].sas_phy;
248
sas_ports[i] = &isci_host->ports[i].sas_port;
251
sas_ha->sas_phy = sas_phys;
252
sas_ha->sas_port = sas_ports;
253
sas_ha->num_phys = SCI_MAX_PHYS;
255
sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL;
256
sas_ha->lldd_max_execute_num = 1;
257
sas_ha->strict_wide_ports = 1;
259
sas_register_ha(sas_ha);
264
static void isci_unregister(struct isci_host *isci_host)
266
struct Scsi_Host *shost;
271
shost = isci_host->shost;
273
sas_unregister_ha(&isci_host->sas_ha);
275
sas_remove_host(isci_host->shost);
276
scsi_remove_host(isci_host->shost);
277
scsi_host_put(isci_host->shost);
280
static int __devinit isci_pci_init(struct pci_dev *pdev)
282
int err, bar_num, bar_mask = 0;
283
void __iomem * const *iomap;
285
err = pcim_enable_device(pdev);
288
"failed enable PCI device %s!\n",
293
for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
294
bar_mask |= 1 << (bar_num * 2);
296
err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
300
iomap = pcim_iomap_table(pdev);
304
pci_set_master(pdev);
306
err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
308
err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
313
err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
315
err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
323
static int num_controllers(struct pci_dev *pdev)
325
/* bar size alone can tell us if we are running with a dual controller
326
* part, no need to trust revision ids that might be under broken firmware
329
resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
330
resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
332
if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
333
smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
334
return SCI_MAX_CONTROLLERS;
339
static int isci_setup_interrupts(struct pci_dev *pdev)
341
int err, i, num_msix;
342
struct isci_host *ihost;
343
struct isci_pci_info *pci_info = to_pci_info(pdev);
346
* Determine the number of vectors associated with this
349
num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
351
for (i = 0; i < num_msix; i++)
352
pci_info->msix_entries[i].entry = i;
354
err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix);
358
for (i = 0; i < num_msix; i++) {
359
int id = i / SCI_NUM_MSI_X_INT;
360
struct msix_entry *msix = &pci_info->msix_entries[i];
363
ihost = pci_info->hosts[id];
364
/* odd numbered vectors are error interrupts */
366
isr = isci_error_isr;
370
err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
371
DRV_NAME"-msix", ihost);
375
dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
377
id = i / SCI_NUM_MSI_X_INT;
378
ihost = pci_info->hosts[id];
379
msix = &pci_info->msix_entries[i];
380
devm_free_irq(&pdev->dev, msix->vector, ihost);
382
pci_disable_msix(pdev);
388
for_each_isci_host(i, ihost, pdev) {
389
err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
390
IRQF_SHARED, DRV_NAME"-intx", ihost);
397
static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
399
struct isci_host *isci_host;
400
struct Scsi_Host *shost;
403
isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host), GFP_KERNEL);
407
isci_host->pdev = pdev;
410
shost = scsi_host_alloc(&isci_sht, sizeof(void *));
413
isci_host->shost = shost;
415
err = isci_host_init(isci_host);
419
SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha;
420
isci_host->sas_ha.core.shost = shost;
421
shost->transportt = isci_transport_template;
425
shost->max_cmd_len = MAX_COMMAND_SIZE;
427
err = scsi_add_host(shost, &pdev->dev);
431
err = isci_register_sas_ha(isci_host);
433
goto err_shost_remove;
438
scsi_remove_host(shost);
440
scsi_host_put(shost);
445
static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
447
struct isci_pci_info *pci_info;
449
struct isci_host *isci_host;
450
const struct firmware *fw = NULL;
451
struct isci_orom *orom = NULL;
452
char *source = "(platform)";
454
dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
457
pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
460
pci_set_drvdata(pdev, pci_info);
463
orom = isci_get_efi_var(pdev);
466
orom = isci_request_oprom(pdev);
468
for (i = 0; orom && i < ARRAY_SIZE(orom->ctrl); i++) {
469
if (sci_oem_parameters_validate(&orom->ctrl[i])) {
471
"[%d]: invalid oem parameters detected, falling back to firmware\n", i);
472
devm_kfree(&pdev->dev, orom);
479
source = "(firmware)";
480
orom = isci_request_firmware(pdev, fw);
482
/* TODO convert this to WARN_TAINT_ONCE once the
483
* orom/efi parameter support is widely available
486
"Loading user firmware failed, using default "
489
"Default OEM configuration being used: 4 "
490
"narrow ports, and default SAS Addresses\n");
496
"OEM SAS parameters (version: %u.%u) loaded %s\n",
497
(orom->hdr.version & 0xf0) >> 4,
498
(orom->hdr.version & 0xf), source);
500
pci_info->orom = orom;
502
err = isci_pci_init(pdev);
506
for (i = 0; i < num_controllers(pdev); i++) {
507
struct isci_host *h = isci_host_alloc(pdev, i);
513
pci_info->hosts[i] = h;
516
err = isci_setup_interrupts(pdev);
520
for_each_isci_host(i, isci_host, pdev)
521
scsi_scan_host(isci_host->shost);
526
for_each_isci_host(i, isci_host, pdev)
527
isci_unregister(isci_host);
531
static void __devexit isci_pci_remove(struct pci_dev *pdev)
533
struct isci_host *ihost;
536
for_each_isci_host(i, ihost, pdev) {
537
isci_unregister(ihost);
538
isci_host_deinit(ihost);
539
sci_controller_disable_interrupts(ihost);
543
static struct pci_driver isci_pci_driver = {
545
.id_table = isci_id_table,
546
.probe = isci_pci_probe,
547
.remove = __devexit_p(isci_pci_remove),
550
static __init int isci_init(void)
554
pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
555
DRV_NAME, DRV_VERSION);
557
isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
558
if (!isci_transport_template)
561
err = pci_register_driver(&isci_pci_driver);
563
sas_release_transport(isci_transport_template);
568
static __exit void isci_exit(void)
570
pci_unregister_driver(&isci_pci_driver);
571
sas_release_transport(isci_transport_template);
574
MODULE_LICENSE("Dual BSD/GPL");
575
MODULE_FIRMWARE(ISCI_FW_NAME);
576
module_init(isci_init);
577
module_exit(isci_exit);