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 <asm/string.h>
62 #include "sci_controller_constants.h"
63 #include "scic_remote_device.h"
64 #include "sci_environment.h"
66 static struct scsi_transport_template
*isci_transport_template
;
67 struct kmem_cache
*isci_kmem_cache
;
69 static 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),},
85 struct isci_firmware
*isci_firmware
;
87 static int __devinit
isci_pci_probe(
89 const struct pci_device_id
*device_id_p
);
91 static void __devexit
isci_pci_remove(struct pci_dev
*pdev
);
93 MODULE_DEVICE_TABLE(pci
, isci_id_table
);
95 static struct pci_driver isci_pci_driver
= {
97 .id_table
= isci_id_table
,
98 .probe
= isci_pci_probe
,
99 .remove
= __devexit_p(isci_pci_remove
),
102 /* linux isci specific settings */
104 #if defined(CONFIG_PBG_HBA_A0)
105 int isci_si_rev
= ISCI_SI_REVA0
;
106 #elif defined(CONFIG_PBG_HBA_A2)
107 int isci_si_rev
= ISCI_SI_REVA2
;
109 int isci_si_rev
= ISCI_SI_REVB0
;
111 module_param(isci_si_rev
, int, S_IRUGO
| S_IWUSR
);
112 MODULE_PARM_DESC(isci_si_rev
, "override default si rev (0: A0 1: A2 2: B0)");
114 static struct scsi_host_template isci_sht
= {
116 .module
= THIS_MODULE
,
118 .proc_name
= DRV_NAME
,
119 .queuecommand
= sas_queuecommand
,
120 .target_alloc
= sas_target_alloc
,
121 .slave_configure
= sas_slave_configure
,
122 .slave_destroy
= sas_slave_destroy
,
123 .scan_finished
= isci_host_scan_finished
,
124 .scan_start
= isci_host_scan_start
,
125 .change_queue_depth
= sas_change_queue_depth
,
126 .change_queue_type
= sas_change_queue_type
,
127 .bios_param
= sas_bios_param
,
128 .can_queue
= ISCI_CAN_QUEUE_VAL
,
131 .sg_tablesize
= SG_ALL
,
132 .max_sectors
= SCSI_DEFAULT_MAX_SECTORS
,
133 .use_clustering
= ENABLE_CLUSTERING
,
134 .eh_device_reset_handler
= sas_eh_device_reset_handler
,
135 .eh_bus_reset_handler
= isci_bus_reset_handler
,
136 .slave_alloc
= sas_slave_alloc
,
137 .target_destroy
= sas_target_destroy
,
141 static struct sas_domain_function_template isci_transport_ops
= {
143 /* The class calls these to notify the LLDD of an event. */
144 .lldd_port_formed
= isci_port_formed
,
145 .lldd_port_deformed
= isci_port_deformed
,
147 /* The class calls these when a device is found or gone. */
148 .lldd_dev_found
= isci_remote_device_found
,
149 .lldd_dev_gone
= isci_remote_device_gone
,
151 .lldd_execute_task
= isci_task_execute_task
,
152 /* Task Management Functions. Must be called from process context. */
153 .lldd_abort_task
= isci_task_abort_task
,
154 .lldd_abort_task_set
= isci_task_abort_task_set
,
155 .lldd_clear_aca
= isci_task_clear_aca
,
156 .lldd_clear_task_set
= isci_task_clear_task_set
,
157 .lldd_I_T_nexus_reset
= isci_task_I_T_nexus_reset
,
158 .lldd_lu_reset
= isci_task_lu_reset
,
159 .lldd_query_task
= isci_task_query_task
,
161 /* Port and Adapter management */
162 .lldd_clear_nexus_port
= isci_task_clear_nexus_port
,
163 .lldd_clear_nexus_ha
= isci_task_clear_nexus_ha
,
166 .lldd_control_phy
= isci_phy_control
,
170 /******************************************************************************
171 * P R O T E C T E D M E T H O D S
172 ******************************************************************************/
177 * isci_register_sas_ha() - This method initializes various lldd
178 * specific members of the sas_ha struct and calls the libsas
179 * sas_register_ha() function.
180 * @isci_host: This parameter specifies the lldd specific wrapper for the
181 * libsas sas_ha struct.
183 * This method returns an error code indicating sucess or failure. The user
184 * should check for possible memory allocation error return otherwise, a zero
187 static int isci_register_sas_ha(struct isci_host
*isci_host
)
190 struct sas_ha_struct
*sas_ha
= &(isci_host
->sas_ha
);
191 struct asd_sas_phy
**sas_phys
;
192 struct asd_sas_port
**sas_ports
;
194 sas_phys
= devm_kzalloc(&isci_host
->pdev
->dev
,
195 SCI_MAX_PHYS
* sizeof(void *),
200 sas_ports
= devm_kzalloc(&isci_host
->pdev
->dev
,
201 SCI_MAX_PORTS
* sizeof(void *),
206 /*----------------- Libsas Initialization Stuff----------------------
207 * Set various fields in the sas_ha struct:
210 sas_ha
->sas_ha_name
= DRV_NAME
;
211 sas_ha
->lldd_module
= THIS_MODULE
;
212 sas_ha
->sas_addr
= &isci_host
->phys
[0].sas_addr
[0];
214 /* set the array of phy and port structs. */
215 for (i
= 0; i
< SCI_MAX_PHYS
; i
++) {
216 sas_phys
[i
] = &(isci_host
->phys
[i
].sas_phy
);
217 sas_ports
[i
] = &(isci_host
->sas_ports
[i
]);
220 sas_ha
->sas_phy
= sas_phys
;
221 sas_ha
->sas_port
= sas_ports
;
222 sas_ha
->num_phys
= SCI_MAX_PHYS
;
224 sas_ha
->lldd_queue_size
= ISCI_CAN_QUEUE_VAL
;
225 sas_ha
->lldd_max_execute_num
= 1;
226 sas_ha
->strict_wide_ports
= 1;
228 sas_register_ha(sas_ha
);
233 static void isci_unregister_sas_ha(struct isci_host
*isci_host
)
238 sas_unregister_ha(&(isci_host
->sas_ha
));
240 sas_remove_host(isci_host
->shost
);
241 scsi_remove_host(isci_host
->shost
);
242 scsi_host_put(isci_host
->shost
);
245 static int __devinit
isci_pci_init(struct pci_dev
*pdev
)
247 int err
, bar_num
, bar_mask
;
248 void __iomem
* const *iomap
;
250 err
= pcim_enable_device(pdev
);
253 "failed enable PCI device %s!\n",
258 for (bar_num
= 0; bar_num
< SCI_PCI_BAR_COUNT
; bar_num
++)
259 bar_mask
|= 1 << (bar_num
* 2);
261 err
= pcim_iomap_regions(pdev
, bar_mask
, DRV_NAME
);
265 iomap
= pcim_iomap_table(pdev
);
269 pci_set_master(pdev
);
271 err
= pci_set_dma_mask(pdev
, DMA_BIT_MASK(64));
273 err
= pci_set_dma_mask(pdev
, DMA_BIT_MASK(32));
278 err
= pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(64));
280 err
= pci_set_consistent_dma_mask(pdev
, DMA_BIT_MASK(32));
288 static int num_controllers(struct pci_dev
*pdev
)
290 /* bar size alone can tell us if we are running with a dual controller
291 * part, no need to trust revision ids that might be under broken firmware
294 resource_size_t scu_bar_size
= pci_resource_len(pdev
, SCI_SCU_BAR
*2);
295 resource_size_t smu_bar_size
= pci_resource_len(pdev
, SCI_SMU_BAR
*2);
297 if (scu_bar_size
>= SCI_SCU_BAR_SIZE
*SCI_MAX_CONTROLLERS
&&
298 smu_bar_size
>= SCI_SMU_BAR_SIZE
*SCI_MAX_CONTROLLERS
)
299 return SCI_MAX_CONTROLLERS
;
304 static int isci_setup_interrupts(struct pci_dev
*pdev
)
306 int err
, i
, num_msix
;
307 struct isci_pci_info
*pci_info
= to_pci_info(pdev
);
310 * Determine the number of vectors associated with this
313 num_msix
= num_controllers(pdev
) * SCI_NUM_MSI_X_INT
;
315 for (i
= 0; i
< num_msix
; i
++)
316 pci_info
->msix_entries
[i
].entry
= i
;
318 err
= pci_enable_msix(pdev
, pci_info
->msix_entries
, num_msix
);
322 for (i
= 0; i
< num_msix
; i
++) {
323 int id
= i
/ SCI_NUM_MSI_X_INT
;
324 struct msix_entry
*msix
= &pci_info
->msix_entries
[i
];
325 struct isci_host
*isci_host
= pci_info
->hosts
[id
];
328 /* odd numbered vectors are error interrupts */
330 isr
= isci_error_isr
;
336 err
= devm_request_irq(&pdev
->dev
, msix
->vector
, isr
, 0,
337 DRV_NAME
"-msix", isci_host
);
341 dev_info(&pdev
->dev
, "msix setup failed falling back to intx\n");
343 id
= i
/ SCI_NUM_MSI_X_INT
;
344 isci_host
= pci_info
->hosts
[id
];
345 msix
= &pci_info
->msix_entries
[i
];
346 devm_free_irq(&pdev
->dev
, msix
->vector
, isci_host
);
348 pci_disable_msix(pdev
);
355 err
= devm_request_irq(&pdev
->dev
, pdev
->irq
, isci_intx_isr
,
356 IRQF_SHARED
, DRV_NAME
"-intx", pdev
);
362 * isci_parse_oem_parameters() - This method will take OEM parameters
363 * from the module init parameters and copy them to oem_params. This will
364 * only copy values that are not set to the module parameter default values
365 * @oem_parameters: This parameter specifies the controller default OEM
366 * parameters. It is expected that this has been initialized to the default
367 * parameters for the controller
371 enum sci_status
isci_parse_oem_parameters(union scic_oem_parameters
*oem_params
,
373 struct isci_firmware
*fw
)
377 /* check for valid inputs */
379 && scu_index
< SCI_MAX_CONTROLLERS
380 && oem_params
!= NULL
)) {
384 for (i
= 0; i
< SCI_MAX_PHYS
; i
++) {
385 int array_idx
= i
+ (SCI_MAX_PHYS
* scu_index
);
386 u64 sas_addr
= fw
->sas_addrs
[array_idx
];
389 oem_params
->sds1
.phys
[i
].sas_address
.low
=
390 (u32
)(sas_addr
& 0xffffffff);
391 oem_params
->sds1
.phys
[i
].sas_address
.high
=
392 (u32
)((sas_addr
>> 32) & 0xffffffff);
396 for (i
= 0; i
< SCI_MAX_PORTS
; i
++) {
397 int array_idx
= i
+ (SCI_MAX_PORTS
* scu_index
);
398 u32 pmask
= fw
->phy_masks
[array_idx
];
400 oem_params
->sds1
.ports
[i
].phy_mask
= pmask
;
407 * isci_parse_user_parameters() - This method will take user parameters
408 * from the module init parameters and copy them to user_params. This will
409 * only copy values that are not set to the module parameter default values
410 * @user_parameters: This parameter specifies the controller default user
411 * parameters. It is expected that this has been initialized to the default
412 * parameters for the controller
416 enum sci_status
isci_parse_user_parameters(
417 union scic_user_parameters
*user_params
,
419 struct isci_firmware
*fw
)
424 && scu_index
< SCI_MAX_CONTROLLERS
425 && user_params
!= NULL
)) {
429 for (i
= 0; i
< SCI_MAX_PORTS
; i
++) {
430 int array_idx
= i
+ (SCI_MAX_PORTS
* scu_index
);
431 u32 gen
= fw
->phy_gens
[array_idx
];
433 user_params
->sds1
.phys
[i
].max_speed_generation
= gen
;
440 static struct isci_host
*isci_host_alloc(struct pci_dev
*pdev
, int id
)
442 struct isci_host
*isci_host
;
443 struct Scsi_Host
*shost
;
446 isci_host
= devm_kzalloc(&pdev
->dev
, sizeof(*isci_host
), GFP_KERNEL
);
450 isci_host
->pdev
= pdev
;
453 shost
= scsi_host_alloc(&isci_sht
, sizeof(void *));
456 isci_host
->shost
= shost
;
458 err
= isci_host_init(isci_host
);
462 SHOST_TO_SAS_HA(shost
) = &isci_host
->sas_ha
;
463 isci_host
->sas_ha
.core
.shost
= shost
;
464 shost
->transportt
= isci_transport_template
;
468 shost
->max_cmd_len
= MAX_COMMAND_SIZE
;
470 err
= scsi_add_host(shost
, &pdev
->dev
);
474 err
= isci_register_sas_ha(isci_host
);
476 goto err_shost_remove
;
481 scsi_remove_host(shost
);
483 scsi_host_put(shost
);
488 static void check_si_rev(struct pci_dev
*pdev
)
490 if (num_controllers(pdev
) > 1)
491 isci_si_rev
= ISCI_SI_REVB0
;
493 switch (pdev
->revision
) {
496 /* if the id is ambiguous don't update isci_si_rev */
499 isci_si_rev
= ISCI_SI_REVA2
;
503 isci_si_rev
= ISCI_SI_REVB0
;
508 dev_info(&pdev
->dev
, "driver configured for %s silicon (rev: %d)\n",
509 isci_si_rev
== ISCI_SI_REVA0
? "A0" :
510 isci_si_rev
== ISCI_SI_REVA2
? "A2" : "B0", pdev
->revision
);
514 static int isci_verify_firmware(const struct firmware
*fw
,
515 struct isci_firmware
*isci_fw
)
519 if (fw
->size
< ISCI_FIRMWARE_MIN_SIZE
)
524 /* 12th char should be the NULL terminate for the ID string */
528 if (strncmp("#SCU MAGIC#", tmp
, 11) != 0)
532 isci_fw
->version
= fw
->data
[ISCI_FW_VER_OFS
];
533 isci_fw
->subversion
= fw
->data
[ISCI_FW_SUBVER_OFS
];
535 tmp
= fw
->data
+ ISCI_FW_DATA_OFS
;
537 while (*tmp
!= ISCI_FW_HDR_EOF
) {
539 case ISCI_FW_HDR_PHYMASK
:
541 isci_fw
->phy_masks_size
= *tmp
;
543 isci_fw
->phy_masks
= (const u32
*)tmp
;
544 tmp
+= sizeof(u32
) * isci_fw
->phy_masks_size
;
547 case ISCI_FW_HDR_PHYGEN
:
549 isci_fw
->phy_gens_size
= *tmp
;
551 isci_fw
->phy_gens
= (const u32
*)tmp
;
552 tmp
+= sizeof(u32
) * isci_fw
->phy_gens_size
;
555 case ISCI_FW_HDR_SASADDR
:
557 isci_fw
->sas_addrs_size
= *tmp
;
559 isci_fw
->sas_addrs
= (const u64
*)tmp
;
560 tmp
+= sizeof(u64
) * isci_fw
->sas_addrs_size
;
564 pr_err("bad field in firmware binary blob\n");
569 pr_info("isci firmware v%u.%u loaded.\n",
570 isci_fw
->version
, isci_fw
->subversion
);
575 static int __devinit
isci_pci_probe(struct pci_dev
*pdev
, const struct pci_device_id
*id
)
577 struct isci_pci_info
*pci_info
;
579 struct isci_host
*isci_host
;
580 const struct firmware
*fw
= NULL
;
584 pci_info
= devm_kzalloc(&pdev
->dev
, sizeof(*pci_info
), GFP_KERNEL
);
587 pci_set_drvdata(pdev
, pci_info
);
589 err
= request_firmware(&fw
, ISCI_FW_NAME
, &pdev
->dev
);
592 "Loading firmware failed, using default values\n");
594 "Default OEM configuration being used:"
595 " 4 narrow ports, and default SAS Addresses\n");
597 isci_firmware
= devm_kzalloc(&pdev
->dev
,
598 sizeof(struct isci_firmware
),
601 err
= isci_verify_firmware(fw
, isci_firmware
);
602 if (err
!= SCI_SUCCESS
) {
604 "firmware verification failed\n");
606 "Default OEM configuration being used:"
607 " 4 narrow ports, and default SAS "
609 devm_kfree(&pdev
->dev
, isci_firmware
);
610 isci_firmware
= NULL
;
613 release_firmware(fw
);
616 err
= isci_pci_init(pdev
);
620 for (i
= 0; i
< num_controllers(pdev
); i
++) {
621 struct isci_host
*h
= isci_host_alloc(pdev
, i
);
627 pci_info
->hosts
[i
] = h
;
630 err
= isci_setup_interrupts(pdev
);
634 for_each_isci_host(i
, isci_host
, pdev
)
635 scsi_scan_host(isci_host
->shost
);
640 for_each_isci_host(i
, isci_host
, pdev
)
641 isci_unregister_sas_ha(isci_host
);
645 static void __devexit
isci_pci_remove(struct pci_dev
*pdev
)
647 struct isci_host
*isci_host
;
650 for_each_isci_host(i
, isci_host
, pdev
) {
651 isci_unregister_sas_ha(isci_host
);
652 isci_host_deinit(isci_host
);
653 scic_controller_disable_interrupts(isci_host
->core_controller
);
657 static __init
int isci_init(void)
661 pr_info("%s: Intel(R) C600 SAS Controller Driver\n", DRV_NAME
);
663 isci_kmem_cache
= kmem_cache_create(DRV_NAME
,
664 sizeof(struct isci_remote_device
) +
665 scic_remote_device_get_object_size(),
667 if (!isci_kmem_cache
)
670 isci_transport_template
= sas_domain_attach_transport(&isci_transport_ops
);
671 if (!isci_transport_template
)
674 err
= pci_register_driver(&isci_pci_driver
);
681 sas_release_transport(isci_transport_template
);
683 kmem_cache_destroy(isci_kmem_cache
);
688 static __exit
void isci_exit(void)
690 pci_unregister_driver(&isci_pci_driver
);
691 sas_release_transport(isci_transport_template
);
692 kmem_cache_destroy(isci_kmem_cache
);
695 MODULE_LICENSE("Dual BSD/GPL");
696 MODULE_FIRMWARE(ISCI_FW_NAME
);
697 module_init(isci_init
);
698 module_exit(isci_exit
);