blob: d73fdcfeb45a19e1695dc188b045e29c72e57557 [file] [log] [blame]
Dan Williams6f231dd2011-07-02 22:56:22 -07001/*
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>
Dan Williamsd044af12011-03-08 09:52:49 -080059#include <linux/firmware.h>
60#include <linux/efi.h>
Dan Williams6f231dd2011-07-02 22:56:22 -070061#include <asm/string.h>
Dave Jiang3a7bda82011-07-29 17:17:00 -070062#include <scsi/scsi_host.h>
Andrzej Jakowski13de2c52012-02-10 01:18:54 -080063#include "host.h"
Dan Williams6f231dd2011-07-02 22:56:22 -070064#include "isci.h"
65#include "task.h"
Dan Williamsd044af12011-03-08 09:52:49 -080066#include "probe_roms.h"
Dan Williams6f231dd2011-07-02 22:56:22 -070067
Dan Williams98e2a5a2011-07-29 17:17:21 -070068#define MAJ 1
Dan Williamsd3fd2e22012-01-04 01:33:10 -080069#define MIN 1
Dan Williams98e2a5a2011-07-29 17:17:21 -070070#define BUILD 0
71#define DRV_VERSION __stringify(MAJ) "." __stringify(MIN) "." \
72 __stringify(BUILD)
73
74MODULE_VERSION(DRV_VERSION);
75
Dan Williams6f231dd2011-07-02 22:56:22 -070076static struct scsi_transport_template *isci_transport_template;
Dan Williams6f231dd2011-07-02 22:56:22 -070077
78static DEFINE_PCI_DEVICE_TABLE(isci_id_table) = {
79 { PCI_VDEVICE(INTEL, 0x1D61),},
80 { PCI_VDEVICE(INTEL, 0x1D63),},
81 { PCI_VDEVICE(INTEL, 0x1D65),},
82 { PCI_VDEVICE(INTEL, 0x1D67),},
83 { PCI_VDEVICE(INTEL, 0x1D69),},
84 { PCI_VDEVICE(INTEL, 0x1D6B),},
85 { PCI_VDEVICE(INTEL, 0x1D60),},
86 { PCI_VDEVICE(INTEL, 0x1D62),},
87 { PCI_VDEVICE(INTEL, 0x1D64),},
88 { PCI_VDEVICE(INTEL, 0x1D66),},
89 { PCI_VDEVICE(INTEL, 0x1D68),},
90 { PCI_VDEVICE(INTEL, 0x1D6A),},
91 {}
92};
93
Dan Williams6f231dd2011-07-02 22:56:22 -070094MODULE_DEVICE_TABLE(pci, isci_id_table);
95
Dan Williams6f231dd2011-07-02 22:56:22 -070096/* linux isci specific settings */
Dan Williams6f231dd2011-07-02 22:56:22 -070097
Marcin Tomczak6024d382012-01-04 01:32:54 -080098unsigned char no_outbound_task_to = 2;
Dave Jiangb5f18a22011-03-16 14:57:23 -070099module_param(no_outbound_task_to, byte, 0);
100MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
101
102u16 ssp_max_occ_to = 20;
103module_param(ssp_max_occ_to, ushort, 0);
104MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
105
106u16 stp_max_occ_to = 5;
107module_param(stp_max_occ_to, ushort, 0);
108MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
109
110u16 ssp_inactive_to = 5;
111module_param(ssp_inactive_to, ushort, 0);
112MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
113
114u16 stp_inactive_to = 5;
115module_param(stp_inactive_to, ushort, 0);
116MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
117
Jeff Skirvinbe168a32012-01-04 01:33:00 -0800118unsigned char phy_gen = SCIC_SDS_PARM_GEN2_SPEED;
Dave Jiangb5f18a22011-03-16 14:57:23 -0700119module_param(phy_gen, byte, 0);
120MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
121
Andrzej Jakowski7000f7c2011-10-27 15:05:42 -0700122unsigned char max_concurr_spinup;
Dave Jiangb5f18a22011-03-16 14:57:23 -0700123module_param(max_concurr_spinup, byte, 0);
124MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
125
Jeff Skirvin9fee6072012-01-04 01:32:49 -0800126uint cable_selection_override = CABLE_OVERRIDE_DISABLED;
127module_param(cable_selection_override, uint, 0);
128
129MODULE_PARM_DESC(cable_selection_override,
130 "This field indicates length of the SAS/SATA cable between "
131 "host and device. If any bits > 15 are set (default) "
132 "indicates \"use platform defaults\"");
133
Dave Jiang3a7bda82011-07-29 17:17:00 -0700134static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
135{
136 struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
137 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
138 struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
139
140 return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
141}
142
143static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
144
145struct device_attribute *isci_host_attrs[] = {
146 &dev_attr_isci_id,
147 NULL
148};
149
Dan Williams6f231dd2011-07-02 22:56:22 -0700150static struct scsi_host_template isci_sht = {
151
152 .module = THIS_MODULE,
153 .name = DRV_NAME,
Havard Skinnemoen92cd5112011-02-18 18:32:08 -0800154 .proc_name = DRV_NAME,
Dan Williams6f231dd2011-07-02 22:56:22 -0700155 .queuecommand = sas_queuecommand,
156 .target_alloc = sas_target_alloc,
157 .slave_configure = sas_slave_configure,
Dan Williams6f231dd2011-07-02 22:56:22 -0700158 .scan_finished = isci_host_scan_finished,
Artur Wojcike468dc12012-06-21 23:41:56 -0700159 .scan_start = isci_host_start,
Dan Williams6f231dd2011-07-02 22:56:22 -0700160 .change_queue_depth = sas_change_queue_depth,
161 .change_queue_type = sas_change_queue_type,
162 .bios_param = sas_bios_param,
163 .can_queue = ISCI_CAN_QUEUE_VAL,
164 .cmd_per_lun = 1,
165 .this_id = -1,
166 .sg_tablesize = SG_ALL,
167 .max_sectors = SCSI_DEFAULT_MAX_SECTORS,
168 .use_clustering = ENABLE_CLUSTERING,
Dan Williams4e646dd2012-06-21 23:31:04 -0700169 .eh_abort_handler = sas_eh_abort_handler,
170 .eh_device_reset_handler = sas_eh_device_reset_handler,
171 .eh_bus_reset_handler = sas_eh_bus_reset_handler,
Dan Williams6f231dd2011-07-02 22:56:22 -0700172 .target_destroy = sas_target_destroy,
173 .ioctl = sas_ioctl,
Dave Jiang3a7bda82011-07-29 17:17:00 -0700174 .shost_attrs = isci_host_attrs,
Dan Williams6f231dd2011-07-02 22:56:22 -0700175};
176
177static struct sas_domain_function_template isci_transport_ops = {
178
179 /* The class calls these to notify the LLDD of an event. */
180 .lldd_port_formed = isci_port_formed,
181 .lldd_port_deformed = isci_port_deformed,
182
183 /* The class calls these when a device is found or gone. */
184 .lldd_dev_found = isci_remote_device_found,
185 .lldd_dev_gone = isci_remote_device_gone,
186
187 .lldd_execute_task = isci_task_execute_task,
188 /* Task Management Functions. Must be called from process context. */
189 .lldd_abort_task = isci_task_abort_task,
190 .lldd_abort_task_set = isci_task_abort_task_set,
191 .lldd_clear_aca = isci_task_clear_aca,
192 .lldd_clear_task_set = isci_task_clear_task_set,
193 .lldd_I_T_nexus_reset = isci_task_I_T_nexus_reset,
194 .lldd_lu_reset = isci_task_lu_reset,
195 .lldd_query_task = isci_task_query_task,
196
Dan Williams687833a2011-11-17 18:01:38 -0800197 /* ata recovery called from ata-eh */
198 .lldd_ata_check_ready = isci_ata_check_ready,
199
Dan Williams6f231dd2011-07-02 22:56:22 -0700200 /* Port and Adapter management */
201 .lldd_clear_nexus_port = isci_task_clear_nexus_port,
202 .lldd_clear_nexus_ha = isci_task_clear_nexus_ha,
203
204 /* Phy management */
205 .lldd_control_phy = isci_phy_control,
Dan Williamsad4f4c12011-09-01 21:18:31 -0700206
207 /* GPIO support */
208 .lldd_write_gpio = isci_gpio_write,
Dan Williams6f231dd2011-07-02 22:56:22 -0700209};
210
211
212/******************************************************************************
213* P R O T E C T E D M E T H O D S
214******************************************************************************/
215
216
217
218/**
219 * isci_register_sas_ha() - This method initializes various lldd
220 * specific members of the sas_ha struct and calls the libsas
221 * sas_register_ha() function.
222 * @isci_host: This parameter specifies the lldd specific wrapper for the
223 * libsas sas_ha struct.
224 *
Anatol Pomozov4907cb72012-09-01 10:31:09 -0700225 * This method returns an error code indicating success or failure. The user
Dan Williams6f231dd2011-07-02 22:56:22 -0700226 * should check for possible memory allocation error return otherwise, a zero
227 * indicates success.
228 */
229static int isci_register_sas_ha(struct isci_host *isci_host)
230{
231 int i;
232 struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
233 struct asd_sas_phy **sas_phys;
234 struct asd_sas_port **sas_ports;
235
236 sas_phys = devm_kzalloc(&isci_host->pdev->dev,
237 SCI_MAX_PHYS * sizeof(void *),
238 GFP_KERNEL);
239 if (!sas_phys)
240 return -ENOMEM;
241
242 sas_ports = devm_kzalloc(&isci_host->pdev->dev,
243 SCI_MAX_PORTS * sizeof(void *),
244 GFP_KERNEL);
245 if (!sas_ports)
246 return -ENOMEM;
247
Dan Williams6f231dd2011-07-02 22:56:22 -0700248 sas_ha->sas_ha_name = DRV_NAME;
249 sas_ha->lldd_module = THIS_MODULE;
Dan Williams150fc6f2011-02-25 10:25:21 -0800250 sas_ha->sas_addr = &isci_host->phys[0].sas_addr[0];
Dan Williams6f231dd2011-07-02 22:56:22 -0700251
Dan Williams6f231dd2011-07-02 22:56:22 -0700252 for (i = 0; i < SCI_MAX_PHYS; i++) {
Dan Williamse5313812011-05-07 10:11:43 -0700253 sas_phys[i] = &isci_host->phys[i].sas_phy;
Dan Williamsc132f692012-01-03 23:26:08 -0800254 sas_ports[i] = &isci_host->sas_ports[i];
Dan Williams6f231dd2011-07-02 22:56:22 -0700255 }
256
257 sas_ha->sas_phy = sas_phys;
258 sas_ha->sas_port = sas_ports;
259 sas_ha->num_phys = SCI_MAX_PHYS;
260
261 sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL;
262 sas_ha->lldd_max_execute_num = 1;
263 sas_ha->strict_wide_ports = 1;
264
265 sas_register_ha(sas_ha);
266
267 return 0;
268}
269
Dan Williams34cad852011-03-10 00:01:43 -0800270static void isci_unregister(struct isci_host *isci_host)
271{
272 struct Scsi_Host *shost;
273
Dan Williams6f231dd2011-07-02 22:56:22 -0700274 if (!isci_host)
275 return;
276
Dan Williams34cad852011-03-10 00:01:43 -0800277 sas_unregister_ha(&isci_host->sas_ha);
Dan Williams6f231dd2011-07-02 22:56:22 -0700278
Dan Williamsd1dc5e22012-02-25 14:29:49 -0800279 shost = to_shost(isci_host);
280 sas_remove_host(shost);
281 scsi_remove_host(shost);
282 scsi_host_put(shost);
Dan Williams6f231dd2011-07-02 22:56:22 -0700283}
284
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800285static int isci_pci_init(struct pci_dev *pdev)
Dan Williams6f231dd2011-07-02 22:56:22 -0700286{
Artur Wojcikcc3dbd02011-05-04 07:58:16 +0000287 int err, bar_num, bar_mask = 0;
Dan Williams6f231dd2011-07-02 22:56:22 -0700288 void __iomem * const *iomap;
289
290 err = pcim_enable_device(pdev);
291 if (err) {
292 dev_err(&pdev->dev,
293 "failed enable PCI device %s!\n",
294 pci_name(pdev));
295 return err;
296 }
297
298 for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
299 bar_mask |= 1 << (bar_num * 2);
300
301 err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
302 if (err)
303 return err;
304
305 iomap = pcim_iomap_table(pdev);
306 if (!iomap)
307 return -ENOMEM;
308
309 pci_set_master(pdev);
310
311 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
312 if (err) {
313 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
314 if (err)
315 return err;
316 }
317
318 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
319 if (err) {
320 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
321 if (err)
322 return err;
323 }
324
325 return 0;
326}
327
Dan Williams6f231dd2011-07-02 22:56:22 -0700328static int num_controllers(struct pci_dev *pdev)
329{
330 /* bar size alone can tell us if we are running with a dual controller
331 * part, no need to trust revision ids that might be under broken firmware
332 * control
333 */
334 resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
335 resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
Dan Williamsf942f322011-03-26 16:30:06 -0700336
Dan Williams6f231dd2011-07-02 22:56:22 -0700337 if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
338 smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
339 return SCI_MAX_CONTROLLERS;
340 else
341 return 1;
342}
343
344static int isci_setup_interrupts(struct pci_dev *pdev)
345{
346 int err, i, num_msix;
Dan Williams31e824e2011-04-19 12:32:51 -0700347 struct isci_host *ihost;
Dan Williams6f231dd2011-07-02 22:56:22 -0700348 struct isci_pci_info *pci_info = to_pci_info(pdev);
349
350 /*
351 * Determine the number of vectors associated with this
352 * PCI function.
353 */
354 num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
355
356 for (i = 0; i < num_msix; i++)
357 pci_info->msix_entries[i].entry = i;
358
359 err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix);
360 if (err)
361 goto intx;
362
363 for (i = 0; i < num_msix; i++) {
364 int id = i / SCI_NUM_MSI_X_INT;
365 struct msix_entry *msix = &pci_info->msix_entries[i];
Dan Williams92f4f0f2011-02-18 09:25:11 -0800366 irq_handler_t isr;
367
Dan Williams31e824e2011-04-19 12:32:51 -0700368 ihost = pci_info->hosts[id];
Dan Williams92f4f0f2011-02-18 09:25:11 -0800369 /* odd numbered vectors are error interrupts */
370 if (i & 1)
371 isr = isci_error_isr;
372 else
373 isr = isci_msix_isr;
Dan Williams6f231dd2011-07-02 22:56:22 -0700374
Dan Williams92f4f0f2011-02-18 09:25:11 -0800375 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
Dan Williams31e824e2011-04-19 12:32:51 -0700376 DRV_NAME"-msix", ihost);
Dan Williams6f231dd2011-07-02 22:56:22 -0700377 if (!err)
378 continue;
379
380 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
381 while (i--) {
382 id = i / SCI_NUM_MSI_X_INT;
Dan Williams31e824e2011-04-19 12:32:51 -0700383 ihost = pci_info->hosts[id];
Dan Williams6f231dd2011-07-02 22:56:22 -0700384 msix = &pci_info->msix_entries[i];
Dan Williams31e824e2011-04-19 12:32:51 -0700385 devm_free_irq(&pdev->dev, msix->vector, ihost);
Dan Williams6f231dd2011-07-02 22:56:22 -0700386 }
387 pci_disable_msix(pdev);
388 goto intx;
389 }
Dan Williams6f231dd2011-07-02 22:56:22 -0700390 return 0;
391
392 intx:
Dan Williams31e824e2011-04-19 12:32:51 -0700393 for_each_isci_host(i, ihost, pdev) {
394 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
395 IRQF_SHARED, DRV_NAME"-intx", ihost);
396 if (err)
397 break;
398 }
Dan Williams6f231dd2011-07-02 22:56:22 -0700399 return err;
400}
401
Dan Williamsabec9122012-02-15 13:58:42 -0800402static void isci_user_parameters_get(struct sci_user_parameters *u)
403{
404 int i;
405
406 for (i = 0; i < SCI_MAX_PHYS; i++) {
407 struct sci_phy_user_params *u_phy = &u->phys[i];
408
409 u_phy->max_speed_generation = phy_gen;
410
411 /* we are not exporting these for now */
412 u_phy->align_insertion_frequency = 0x7f;
413 u_phy->in_connection_align_insertion_frequency = 0xff;
414 u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
415 }
416
417 u->stp_inactivity_timeout = stp_inactive_to;
418 u->ssp_inactivity_timeout = ssp_inactive_to;
419 u->stp_max_occupancy_timeout = stp_max_occ_to;
420 u->ssp_max_occupancy_timeout = ssp_max_occ_to;
421 u->no_outbound_task_timeout = no_outbound_task_to;
422 u->max_concurr_spinup = max_concurr_spinup;
423}
424
425static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
426 struct sci_user_parameters *sci_parms)
427{
428 u16 index;
429
430 /*
431 * Validate the user parameters. If they are not legal, then
432 * return a failure.
433 */
434 for (index = 0; index < SCI_MAX_PHYS; index++) {
435 struct sci_phy_user_params *u;
436
437 u = &sci_parms->phys[index];
438
439 if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
440 (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
441 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
442
443 if (u->in_connection_align_insertion_frequency < 3)
444 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
445
446 if ((u->in_connection_align_insertion_frequency < 3) ||
447 (u->align_insertion_frequency == 0) ||
448 (u->notify_enable_spin_up_insertion_frequency == 0))
449 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
450 }
451
452 if ((sci_parms->stp_inactivity_timeout == 0) ||
453 (sci_parms->ssp_inactivity_timeout == 0) ||
454 (sci_parms->stp_max_occupancy_timeout == 0) ||
455 (sci_parms->ssp_max_occupancy_timeout == 0) ||
456 (sci_parms->no_outbound_task_timeout == 0))
457 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
458
459 memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
460
461 return SCI_SUCCESS;
462}
463
464static void sci_oem_defaults(struct isci_host *ihost)
465{
466 /* these defaults are overridden by the platform / firmware */
467 struct sci_user_parameters *user = &ihost->user_parameters;
468 struct sci_oem_params *oem = &ihost->oem_parameters;
469 int i;
470
471 /* Default to APC mode. */
472 oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
473
474 /* Default to APC mode. */
475 oem->controller.max_concurr_spin_up = 1;
476
477 /* Default to no SSC operation. */
478 oem->controller.do_enable_ssc = false;
479
480 /* Default to short cables on all phys. */
481 oem->controller.cable_selection_mask = 0;
482
483 /* Initialize all of the port parameter information to narrow ports. */
484 for (i = 0; i < SCI_MAX_PORTS; i++)
485 oem->ports[i].phy_mask = 0;
486
487 /* Initialize all of the phy parameter information. */
488 for (i = 0; i < SCI_MAX_PHYS; i++) {
489 /* Default to 3G (i.e. Gen 2). */
490 user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
491
492 /* the frequencies cannot be 0 */
493 user->phys[i].align_insertion_frequency = 0x7f;
494 user->phys[i].in_connection_align_insertion_frequency = 0xff;
495 user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
496
497 /* Previous Vitesse based expanders had a arbitration issue that
498 * is worked around by having the upper 32-bits of SAS address
499 * with a value greater then the Vitesse company identifier.
500 * Hence, usage of 0x5FCFFFFF.
501 */
502 oem->phys[i].sas_address.low = 0x1 + ihost->id;
503 oem->phys[i].sas_address.high = 0x5FCFFFFF;
504 }
505
506 user->stp_inactivity_timeout = 5;
507 user->ssp_inactivity_timeout = 5;
508 user->stp_max_occupancy_timeout = 5;
509 user->ssp_max_occupancy_timeout = 20;
510 user->no_outbound_task_timeout = 2;
511}
512
Dan Williams6f231dd2011-07-02 22:56:22 -0700513static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
514{
Dan Williamsabec9122012-02-15 13:58:42 -0800515 struct isci_orom *orom = to_pci_info(pdev)->orom;
516 struct sci_user_parameters sci_user_params;
517 u8 oem_version = ISCI_ROM_VER_1_0;
518 struct isci_host *ihost;
Dan Williams6f231dd2011-07-02 22:56:22 -0700519 struct Scsi_Host *shost;
Dan Williamsabec9122012-02-15 13:58:42 -0800520 int err, i;
Dan Williams6f231dd2011-07-02 22:56:22 -0700521
Dan Williamsabec9122012-02-15 13:58:42 -0800522 ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
523 if (!ihost)
Dan Williams6f231dd2011-07-02 22:56:22 -0700524 return NULL;
525
Dan Williamsabec9122012-02-15 13:58:42 -0800526 ihost->pdev = pdev;
527 ihost->id = id;
528 spin_lock_init(&ihost->scic_lock);
529 init_waitqueue_head(&ihost->eventq);
530 ihost->sas_ha.dev = &ihost->pdev->dev;
531 ihost->sas_ha.lldd_ha = ihost;
532 tasklet_init(&ihost->completion_tasklet,
533 isci_host_completion_routine, (unsigned long)ihost);
534
535 /* validate module parameters */
536 /* TODO: kill struct sci_user_parameters and reference directly */
537 sci_oem_defaults(ihost);
538 isci_user_parameters_get(&sci_user_params);
539 if (sci_user_parameters_set(ihost, &sci_user_params)) {
540 dev_warn(&pdev->dev,
541 "%s: sci_user_parameters_set failed\n", __func__);
542 return NULL;
543 }
544
545 /* sanity check platform (or 'firmware') oem parameters */
546 if (orom) {
547 if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
548 dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
549 return NULL;
550 }
551 ihost->oem_parameters = orom->ctrl[id];
552 oem_version = orom->hdr.version;
553 }
554
555 /* validate oem parameters (platform, firmware, or built-in defaults) */
556 if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
557 dev_warn(&pdev->dev, "oem parameter validation failed\n");
558 return NULL;
559 }
560
Dan Williamsabec9122012-02-15 13:58:42 -0800561 for (i = 0; i < SCI_MAX_PORTS; i++) {
562 struct isci_port *iport = &ihost->ports[i];
563
564 INIT_LIST_HEAD(&iport->remote_dev_list);
565 iport->isci_host = ihost;
566 }
567
568 for (i = 0; i < SCI_MAX_PHYS; i++)
569 isci_phy_init(&ihost->phys[i], ihost, i);
570
571 for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
572 struct isci_remote_device *idev = &ihost->devices[i];
573
Dan Williamsabec9122012-02-15 13:58:42 -0800574 INIT_LIST_HEAD(&idev->node);
575 }
Dan Williams6f231dd2011-07-02 22:56:22 -0700576
577 shost = scsi_host_alloc(&isci_sht, sizeof(void *));
578 if (!shost)
579 return NULL;
Dan Williams6f231dd2011-07-02 22:56:22 -0700580
Jeff Skirvin9fee6072012-01-04 01:32:49 -0800581 dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
582 "{%s, %s, %s, %s}\n",
Dan Williamsabec9122012-02-15 13:58:42 -0800583 (is_cable_select_overridden() ? "* " : ""), ihost->id,
584 lookup_cable_names(decode_cable_selection(ihost, 3)),
585 lookup_cable_names(decode_cable_selection(ihost, 2)),
586 lookup_cable_names(decode_cable_selection(ihost, 1)),
587 lookup_cable_names(decode_cable_selection(ihost, 0)));
Jeff Skirvin9fee6072012-01-04 01:32:49 -0800588
Dan Williamsabec9122012-02-15 13:58:42 -0800589 err = isci_host_init(ihost);
Dan Williams6f231dd2011-07-02 22:56:22 -0700590 if (err)
591 goto err_shost;
592
Dan Williamsabec9122012-02-15 13:58:42 -0800593 SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
594 ihost->sas_ha.core.shost = shost;
Dan Williams6f231dd2011-07-02 22:56:22 -0700595 shost->transportt = isci_transport_template;
596
597 shost->max_id = ~0;
598 shost->max_lun = ~0;
599 shost->max_cmd_len = MAX_COMMAND_SIZE;
600
601 err = scsi_add_host(shost, &pdev->dev);
602 if (err)
603 goto err_shost;
604
Dan Williamsabec9122012-02-15 13:58:42 -0800605 err = isci_register_sas_ha(ihost);
Dan Williams6f231dd2011-07-02 22:56:22 -0700606 if (err)
607 goto err_shost_remove;
608
Dan Williamsabec9122012-02-15 13:58:42 -0800609 return ihost;
Dan Williams6f231dd2011-07-02 22:56:22 -0700610
611 err_shost_remove:
612 scsi_remove_host(shost);
613 err_shost:
614 scsi_host_put(shost);
615
616 return NULL;
617}
618
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800619static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
Dan Williams6f231dd2011-07-02 22:56:22 -0700620{
621 struct isci_pci_info *pci_info;
622 int err, i;
623 struct isci_host *isci_host;
Dave Jiang858d4aa2011-02-22 01:27:03 -0800624 const struct firmware *fw = NULL;
Dan Williamsd37ee7e2011-04-26 13:19:53 -0700625 struct isci_orom *orom = NULL;
Dan Williams4711ba12011-03-11 10:43:57 -0800626 char *source = "(platform)";
Dan Williams6f231dd2011-07-02 22:56:22 -0700627
Dan Williamsdc00c8b2011-07-01 11:41:21 -0700628 dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
629 pdev->revision);
Dan Williams6f231dd2011-07-02 22:56:22 -0700630
631 pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
632 if (!pci_info)
633 return -ENOMEM;
634 pci_set_drvdata(pdev, pci_info);
635
Dave Jiang8db37aa2011-02-23 00:02:24 -0800636 if (efi_enabled)
637 orom = isci_get_efi_var(pdev);
Dan Williamsd37ee7e2011-04-26 13:19:53 -0700638
639 if (!orom)
Dan Williamsd044af12011-03-08 09:52:49 -0800640 orom = isci_request_oprom(pdev);
641
Dan Williamsfc25f792012-04-30 11:57:44 -0700642 for (i = 0; orom && i < num_controllers(pdev); i++) {
Dave Jiang594e5662012-01-04 01:32:44 -0800643 if (sci_oem_parameters_validate(&orom->ctrl[i],
644 orom->hdr.version)) {
Dan Williams2d70de52011-04-20 12:57:08 -0700645 dev_warn(&pdev->dev,
646 "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
Dan Williams2d70de52011-04-20 12:57:08 -0700647 orom = NULL;
648 break;
649 }
650 }
651
Dan Williamsd044af12011-03-08 09:52:49 -0800652 if (!orom) {
Dan Williams4711ba12011-03-11 10:43:57 -0800653 source = "(firmware)";
Dan Williamsd044af12011-03-08 09:52:49 -0800654 orom = isci_request_firmware(pdev, fw);
655 if (!orom) {
656 /* TODO convert this to WARN_TAINT_ONCE once the
657 * orom/efi parameter support is widely available
658 */
659 dev_warn(&pdev->dev,
660 "Loading user firmware failed, using default "
661 "values\n");
662 dev_warn(&pdev->dev,
663 "Default OEM configuration being used: 4 "
664 "narrow ports, and default SAS Addresses\n");
Dave Jiang858d4aa2011-02-22 01:27:03 -0800665 }
Dave Jiang858d4aa2011-02-22 01:27:03 -0800666 }
667
Dan Williamsd044af12011-03-08 09:52:49 -0800668 if (orom)
Dan Williams3b67c1f2011-03-08 09:53:51 -0800669 dev_info(&pdev->dev,
Dan Williams4711ba12011-03-11 10:43:57 -0800670 "OEM SAS parameters (version: %u.%u) loaded %s\n",
Dan Williams3b67c1f2011-03-08 09:53:51 -0800671 (orom->hdr.version & 0xf0) >> 4,
Dan Williams4711ba12011-03-11 10:43:57 -0800672 (orom->hdr.version & 0xf), source);
Dan Williams3b67c1f2011-03-08 09:53:51 -0800673
Dan Williamsd044af12011-03-08 09:52:49 -0800674 pci_info->orom = orom;
675
Dan Williams6f231dd2011-07-02 22:56:22 -0700676 err = isci_pci_init(pdev);
677 if (err)
678 return err;
679
680 for (i = 0; i < num_controllers(pdev); i++) {
681 struct isci_host *h = isci_host_alloc(pdev, i);
682
683 if (!h) {
684 err = -ENOMEM;
685 goto err_host_alloc;
686 }
Dan Williamsb329aff2011-03-07 16:02:25 -0800687 pci_info->hosts[i] = h;
Dave Jiang3d2d7522012-02-10 01:18:34 -0800688
689 /* turn on DIF support */
Dan Williamsd1dc5e22012-02-25 14:29:49 -0800690 scsi_host_set_prot(to_shost(h),
Dave Jiang3d2d7522012-02-10 01:18:34 -0800691 SHOST_DIF_TYPE1_PROTECTION |
692 SHOST_DIF_TYPE2_PROTECTION |
693 SHOST_DIF_TYPE3_PROTECTION);
Dan Williamsd1dc5e22012-02-25 14:29:49 -0800694 scsi_host_set_guard(to_shost(h), SHOST_DIX_GUARD_CRC);
Dan Williams6f231dd2011-07-02 22:56:22 -0700695 }
696
697 err = isci_setup_interrupts(pdev);
698 if (err)
699 goto err_host_alloc;
700
Dan Williamsb329aff2011-03-07 16:02:25 -0800701 for_each_isci_host(i, isci_host, pdev)
Dan Williamsd1dc5e22012-02-25 14:29:49 -0800702 scsi_scan_host(to_shost(isci_host));
Dan Williams6f231dd2011-07-02 22:56:22 -0700703
704 return 0;
705
706 err_host_alloc:
Dan Williamsb329aff2011-03-07 16:02:25 -0800707 for_each_isci_host(i, isci_host, pdev)
Dan Williams34cad852011-03-10 00:01:43 -0800708 isci_unregister(isci_host);
Dan Williams6f231dd2011-07-02 22:56:22 -0700709 return err;
710}
711
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800712static void isci_pci_remove(struct pci_dev *pdev)
Dan Williams6f231dd2011-07-02 22:56:22 -0700713{
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700714 struct isci_host *ihost;
Dan Williamsb329aff2011-03-07 16:02:25 -0800715 int i;
Dan Williams6f231dd2011-07-02 22:56:22 -0700716
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700717 for_each_isci_host(i, ihost, pdev) {
Andrzej Jakowski13de2c52012-02-10 01:18:54 -0800718 wait_for_start(ihost);
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700719 isci_unregister(ihost);
720 isci_host_deinit(ihost);
Dan Williams6f231dd2011-07-02 22:56:22 -0700721 }
722}
723
Artur Wojcike468dc12012-06-21 23:41:56 -0700724#ifdef CONFIG_PM
725static int isci_suspend(struct device *dev)
726{
727 struct pci_dev *pdev = to_pci_dev(dev);
728 struct isci_host *ihost;
729 int i;
730
731 for_each_isci_host(i, ihost, pdev) {
732 sas_suspend_ha(&ihost->sas_ha);
733 isci_host_deinit(ihost);
734 }
735
736 pci_save_state(pdev);
737 pci_disable_device(pdev);
738 pci_set_power_state(pdev, PCI_D3hot);
739
740 return 0;
741}
742
743static int isci_resume(struct device *dev)
744{
745 struct pci_dev *pdev = to_pci_dev(dev);
746 struct isci_host *ihost;
747 int rc, i;
748
749 pci_set_power_state(pdev, PCI_D0);
750 pci_restore_state(pdev);
751
752 rc = pcim_enable_device(pdev);
753 if (rc) {
754 dev_err(&pdev->dev,
755 "enabling device failure after resume(%d)\n", rc);
756 return rc;
757 }
758
759 pci_set_master(pdev);
760
761 for_each_isci_host(i, ihost, pdev) {
762 sas_prep_resume_ha(&ihost->sas_ha);
763
764 isci_host_init(ihost);
765 isci_host_start(ihost->sas_ha.core.shost);
766 wait_for_start(ihost);
767
768 sas_resume_ha(&ihost->sas_ha);
769 }
770
771 return 0;
772}
773
774static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
775#endif
776
Dan Williamsf942f322011-03-26 16:30:06 -0700777static struct pci_driver isci_pci_driver = {
778 .name = DRV_NAME,
779 .id_table = isci_id_table,
780 .probe = isci_pci_probe,
Greg Kroah-Hartman6f039792012-12-21 13:08:55 -0800781 .remove = isci_pci_remove,
Artur Wojcike468dc12012-06-21 23:41:56 -0700782#ifdef CONFIG_PM
783 .driver.pm = &isci_pm_ops,
784#endif
Dan Williamsf942f322011-03-26 16:30:06 -0700785};
786
Dan Williams6f231dd2011-07-02 22:56:22 -0700787static __init int isci_init(void)
788{
Dan Williamsd9c37392011-03-03 17:59:32 -0800789 int err;
Dan Williams6f231dd2011-07-02 22:56:22 -0700790
Dan Williams98e2a5a2011-07-29 17:17:21 -0700791 pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
792 DRV_NAME, DRV_VERSION);
Dan Williams6f231dd2011-07-02 22:56:22 -0700793
Dan Williams6f231dd2011-07-02 22:56:22 -0700794 isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
795 if (!isci_transport_template)
Dan Williamsd9c37392011-03-03 17:59:32 -0800796 return -ENOMEM;
Dan Williams6f231dd2011-07-02 22:56:22 -0700797
798 err = pci_register_driver(&isci_pci_driver);
799 if (err)
Dan Williamsd9c37392011-03-03 17:59:32 -0800800 sas_release_transport(isci_transport_template);
Dan Williams6f231dd2011-07-02 22:56:22 -0700801
802 return err;
803}
804
805static __exit void isci_exit(void)
806{
807 pci_unregister_driver(&isci_pci_driver);
808 sas_release_transport(isci_transport_template);
Dan Williams6f231dd2011-07-02 22:56:22 -0700809}
810
811MODULE_LICENSE("Dual BSD/GPL");
812MODULE_FIRMWARE(ISCI_FW_NAME);
813module_init(isci_init);
814module_exit(isci_exit);