Merge tag '4.4-scsi-mkp' into misc
[firefly-linux-kernel-4.4.55.git] / drivers / scsi / isci / init.c
1 /*
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>
59 #include <linux/firmware.h>
60 #include <linux/efi.h>
61 #include <asm/string.h>
62 #include <scsi/scsi_host.h>
63 #include "host.h"
64 #include "isci.h"
65 #include "task.h"
66 #include "probe_roms.h"
67
68 #define MAJ 1
69 #define MIN 2
70 #define BUILD 0
71 #define DRV_VERSION __stringify(MAJ) "." __stringify(MIN) "." \
72         __stringify(BUILD)
73
74 MODULE_VERSION(DRV_VERSION);
75
76 static struct scsi_transport_template *isci_transport_template;
77
78 static const struct pci_device_id 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
94 MODULE_DEVICE_TABLE(pci, isci_id_table);
95
96 /* linux isci specific settings */
97
98 unsigned char no_outbound_task_to = 2;
99 module_param(no_outbound_task_to, byte, 0);
100 MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
101
102 u16 ssp_max_occ_to = 20;
103 module_param(ssp_max_occ_to, ushort, 0);
104 MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
105
106 u16 stp_max_occ_to = 5;
107 module_param(stp_max_occ_to, ushort, 0);
108 MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
109
110 u16 ssp_inactive_to = 5;
111 module_param(ssp_inactive_to, ushort, 0);
112 MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
113
114 u16 stp_inactive_to = 5;
115 module_param(stp_inactive_to, ushort, 0);
116 MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
117
118 unsigned char phy_gen = SCIC_SDS_PARM_GEN2_SPEED;
119 module_param(phy_gen, byte, 0);
120 MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
121
122 unsigned char max_concurr_spinup;
123 module_param(max_concurr_spinup, byte, 0);
124 MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
125
126 uint cable_selection_override = CABLE_OVERRIDE_DISABLED;
127 module_param(cable_selection_override, uint, 0);
128
129 MODULE_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
134 static 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
143 static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
144
145 struct device_attribute *isci_host_attrs[] = {
146         &dev_attr_isci_id,
147         NULL
148 };
149
150 static struct scsi_host_template isci_sht = {
151
152         .module                         = THIS_MODULE,
153         .name                           = DRV_NAME,
154         .proc_name                      = DRV_NAME,
155         .queuecommand                   = sas_queuecommand,
156         .target_alloc                   = sas_target_alloc,
157         .slave_configure                = sas_slave_configure,
158         .scan_finished                  = isci_host_scan_finished,
159         .scan_start                     = isci_host_start,
160         .change_queue_depth             = sas_change_queue_depth,
161         .bios_param                     = sas_bios_param,
162         .can_queue                      = ISCI_CAN_QUEUE_VAL,
163         .this_id                        = -1,
164         .sg_tablesize                   = SG_ALL,
165         .max_sectors                    = SCSI_DEFAULT_MAX_SECTORS,
166         .use_clustering                 = ENABLE_CLUSTERING,
167         .eh_abort_handler               = sas_eh_abort_handler,
168         .eh_device_reset_handler        = sas_eh_device_reset_handler,
169         .eh_bus_reset_handler           = sas_eh_bus_reset_handler,
170         .target_destroy                 = sas_target_destroy,
171         .ioctl                          = sas_ioctl,
172         .shost_attrs                    = isci_host_attrs,
173         .track_queue_depth              = 1,
174 };
175
176 static struct sas_domain_function_template isci_transport_ops  = {
177
178         /* The class calls these to notify the LLDD of an event. */
179         .lldd_port_formed       = isci_port_formed,
180         .lldd_port_deformed     = isci_port_deformed,
181
182         /* The class calls these when a device is found or gone. */
183         .lldd_dev_found         = isci_remote_device_found,
184         .lldd_dev_gone          = isci_remote_device_gone,
185
186         .lldd_execute_task      = isci_task_execute_task,
187         /* Task Management Functions. Must be called from process context. */
188         .lldd_abort_task        = isci_task_abort_task,
189         .lldd_abort_task_set    = isci_task_abort_task_set,
190         .lldd_clear_aca         = isci_task_clear_aca,
191         .lldd_clear_task_set    = isci_task_clear_task_set,
192         .lldd_I_T_nexus_reset   = isci_task_I_T_nexus_reset,
193         .lldd_lu_reset          = isci_task_lu_reset,
194         .lldd_query_task        = isci_task_query_task,
195
196         /* ata recovery called from ata-eh */
197         .lldd_ata_check_ready   = isci_ata_check_ready,
198
199         /* Port and Adapter management */
200         .lldd_clear_nexus_port  = isci_task_clear_nexus_port,
201         .lldd_clear_nexus_ha    = isci_task_clear_nexus_ha,
202
203         /* Phy management */
204         .lldd_control_phy       = isci_phy_control,
205
206         /* GPIO support */
207         .lldd_write_gpio        = isci_gpio_write,
208 };
209
210
211 /******************************************************************************
212 * P R O T E C T E D  M E T H O D S
213 ******************************************************************************/
214
215
216
217 /**
218  * isci_register_sas_ha() - This method initializes various lldd
219  *    specific members of the sas_ha struct and calls the libsas
220  *    sas_register_ha() function.
221  * @isci_host: This parameter specifies the lldd specific wrapper for the
222  *    libsas sas_ha struct.
223  *
224  * This method returns an error code indicating success or failure. The user
225  * should check for possible memory allocation error return otherwise, a zero
226  * indicates success.
227  */
228 static int isci_register_sas_ha(struct isci_host *isci_host)
229 {
230         int i;
231         struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
232         struct asd_sas_phy **sas_phys;
233         struct asd_sas_port **sas_ports;
234
235         sas_phys = devm_kzalloc(&isci_host->pdev->dev,
236                                 SCI_MAX_PHYS * sizeof(void *),
237                                 GFP_KERNEL);
238         if (!sas_phys)
239                 return -ENOMEM;
240
241         sas_ports = devm_kzalloc(&isci_host->pdev->dev,
242                                  SCI_MAX_PORTS * sizeof(void *),
243                                  GFP_KERNEL);
244         if (!sas_ports)
245                 return -ENOMEM;
246
247         sas_ha->sas_ha_name = DRV_NAME;
248         sas_ha->lldd_module = THIS_MODULE;
249         sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
250
251         for (i = 0; i < SCI_MAX_PHYS; i++) {
252                 sas_phys[i] = &isci_host->phys[i].sas_phy;
253                 sas_ports[i] = &isci_host->sas_ports[i];
254         }
255
256         sas_ha->sas_phy  = sas_phys;
257         sas_ha->sas_port = sas_ports;
258         sas_ha->num_phys = SCI_MAX_PHYS;
259
260         sas_ha->strict_wide_ports = 1;
261
262         sas_register_ha(sas_ha);
263
264         return 0;
265 }
266
267 static void isci_unregister(struct isci_host *isci_host)
268 {
269         struct Scsi_Host *shost;
270
271         if (!isci_host)
272                 return;
273
274         shost = to_shost(isci_host);
275         scsi_remove_host(shost);
276         sas_unregister_ha(&isci_host->sas_ha);
277
278         sas_remove_host(shost);
279         scsi_host_put(shost);
280 }
281
282 static int isci_pci_init(struct pci_dev *pdev)
283 {
284         int err, bar_num, bar_mask = 0;
285         void __iomem * const *iomap;
286
287         err = pcim_enable_device(pdev);
288         if (err) {
289                 dev_err(&pdev->dev,
290                         "failed enable PCI device %s!\n",
291                         pci_name(pdev));
292                 return err;
293         }
294
295         for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
296                 bar_mask |= 1 << (bar_num * 2);
297
298         err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
299         if (err)
300                 return err;
301
302         iomap = pcim_iomap_table(pdev);
303         if (!iomap)
304                 return -ENOMEM;
305
306         pci_set_master(pdev);
307
308         err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
309         if (err) {
310                 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
311                 if (err)
312                         return err;
313         }
314
315         err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
316         if (err) {
317                 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
318                 if (err)
319                         return err;
320         }
321
322         return 0;
323 }
324
325 static int num_controllers(struct pci_dev *pdev)
326 {
327         /* bar size alone can tell us if we are running with a dual controller
328          * part, no need to trust revision ids that might be under broken firmware
329          * control
330          */
331         resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
332         resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
333
334         if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
335             smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
336                 return SCI_MAX_CONTROLLERS;
337         else
338                 return 1;
339 }
340
341 static int isci_setup_interrupts(struct pci_dev *pdev)
342 {
343         int err, i, num_msix;
344         struct isci_host *ihost;
345         struct isci_pci_info *pci_info = to_pci_info(pdev);
346
347         /*
348          *  Determine the number of vectors associated with this
349          *  PCI function.
350          */
351         num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
352
353         for (i = 0; i < num_msix; i++)
354                 pci_info->msix_entries[i].entry = i;
355
356         err = pci_enable_msix_exact(pdev, pci_info->msix_entries, num_msix);
357         if (err)
358                 goto intx;
359
360         for (i = 0; i < num_msix; i++) {
361                 int id = i / SCI_NUM_MSI_X_INT;
362                 struct msix_entry *msix = &pci_info->msix_entries[i];
363                 irq_handler_t isr;
364
365                 ihost = pci_info->hosts[id];
366                 /* odd numbered vectors are error interrupts */
367                 if (i & 1)
368                         isr = isci_error_isr;
369                 else
370                         isr = isci_msix_isr;
371
372                 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
373                                        DRV_NAME"-msix", ihost);
374                 if (!err)
375                         continue;
376
377                 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
378                 while (i--) {
379                         id = i / SCI_NUM_MSI_X_INT;
380                         ihost = pci_info->hosts[id];
381                         msix = &pci_info->msix_entries[i];
382                         devm_free_irq(&pdev->dev, msix->vector, ihost);
383                 }
384                 pci_disable_msix(pdev);
385                 goto intx;
386         }
387         return 0;
388
389  intx:
390         for_each_isci_host(i, ihost, pdev) {
391                 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
392                                        IRQF_SHARED, DRV_NAME"-intx", ihost);
393                 if (err)
394                         break;
395         }
396         return err;
397 }
398
399 static void isci_user_parameters_get(struct sci_user_parameters *u)
400 {
401         int i;
402
403         for (i = 0; i < SCI_MAX_PHYS; i++) {
404                 struct sci_phy_user_params *u_phy = &u->phys[i];
405
406                 u_phy->max_speed_generation = phy_gen;
407
408                 /* we are not exporting these for now */
409                 u_phy->align_insertion_frequency = 0x7f;
410                 u_phy->in_connection_align_insertion_frequency = 0xff;
411                 u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
412         }
413
414         u->stp_inactivity_timeout = stp_inactive_to;
415         u->ssp_inactivity_timeout = ssp_inactive_to;
416         u->stp_max_occupancy_timeout = stp_max_occ_to;
417         u->ssp_max_occupancy_timeout = ssp_max_occ_to;
418         u->no_outbound_task_timeout = no_outbound_task_to;
419         u->max_concurr_spinup = max_concurr_spinup;
420 }
421
422 static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
423                                                struct sci_user_parameters *sci_parms)
424 {
425         u16 index;
426
427         /*
428          * Validate the user parameters.  If they are not legal, then
429          * return a failure.
430          */
431         for (index = 0; index < SCI_MAX_PHYS; index++) {
432                 struct sci_phy_user_params *u;
433
434                 u = &sci_parms->phys[index];
435
436                 if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
437                       (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
438                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
439
440                 if (u->in_connection_align_insertion_frequency < 3)
441                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
442
443                 if ((u->in_connection_align_insertion_frequency < 3) ||
444                     (u->align_insertion_frequency == 0) ||
445                     (u->notify_enable_spin_up_insertion_frequency == 0))
446                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
447         }
448
449         if ((sci_parms->stp_inactivity_timeout == 0) ||
450             (sci_parms->ssp_inactivity_timeout == 0) ||
451             (sci_parms->stp_max_occupancy_timeout == 0) ||
452             (sci_parms->ssp_max_occupancy_timeout == 0) ||
453             (sci_parms->no_outbound_task_timeout == 0))
454                 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
455
456         memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
457
458         return SCI_SUCCESS;
459 }
460
461 static void sci_oem_defaults(struct isci_host *ihost)
462 {
463         /* these defaults are overridden by the platform / firmware */
464         struct sci_user_parameters *user = &ihost->user_parameters;
465         struct sci_oem_params *oem = &ihost->oem_parameters;
466         int i;
467
468         /* Default to APC mode. */
469         oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
470
471         /* Default to APC mode. */
472         oem->controller.max_concurr_spin_up = 1;
473
474         /* Default to no SSC operation. */
475         oem->controller.do_enable_ssc = false;
476
477         /* Default to short cables on all phys. */
478         oem->controller.cable_selection_mask = 0;
479
480         /* Initialize all of the port parameter information to narrow ports. */
481         for (i = 0; i < SCI_MAX_PORTS; i++)
482                 oem->ports[i].phy_mask = 0;
483
484         /* Initialize all of the phy parameter information. */
485         for (i = 0; i < SCI_MAX_PHYS; i++) {
486                 /* Default to 3G (i.e. Gen 2). */
487                 user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
488
489                 /* the frequencies cannot be 0 */
490                 user->phys[i].align_insertion_frequency = 0x7f;
491                 user->phys[i].in_connection_align_insertion_frequency = 0xff;
492                 user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
493
494                 /* Previous Vitesse based expanders had a arbitration issue that
495                  * is worked around by having the upper 32-bits of SAS address
496                  * with a value greater then the Vitesse company identifier.
497                  * Hence, usage of 0x5FCFFFFF.
498                  */
499                 oem->phys[i].sas_address.low = 0x1 + ihost->id;
500                 oem->phys[i].sas_address.high = 0x5FCFFFFF;
501         }
502
503         user->stp_inactivity_timeout = 5;
504         user->ssp_inactivity_timeout = 5;
505         user->stp_max_occupancy_timeout = 5;
506         user->ssp_max_occupancy_timeout = 20;
507         user->no_outbound_task_timeout = 2;
508 }
509
510 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
511 {
512         struct isci_orom *orom = to_pci_info(pdev)->orom;
513         struct sci_user_parameters sci_user_params;
514         u8 oem_version = ISCI_ROM_VER_1_0;
515         struct isci_host *ihost;
516         struct Scsi_Host *shost;
517         int err, i;
518
519         ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
520         if (!ihost)
521                 return NULL;
522
523         ihost->pdev = pdev;
524         ihost->id = id;
525         spin_lock_init(&ihost->scic_lock);
526         init_waitqueue_head(&ihost->eventq);
527         ihost->sas_ha.dev = &ihost->pdev->dev;
528         ihost->sas_ha.lldd_ha = ihost;
529         tasklet_init(&ihost->completion_tasklet,
530                      isci_host_completion_routine, (unsigned long)ihost);
531
532         /* validate module parameters */
533         /* TODO: kill struct sci_user_parameters and reference directly */
534         sci_oem_defaults(ihost);
535         isci_user_parameters_get(&sci_user_params);
536         if (sci_user_parameters_set(ihost, &sci_user_params)) {
537                 dev_warn(&pdev->dev,
538                          "%s: sci_user_parameters_set failed\n", __func__);
539                 return NULL;
540         }
541
542         /* sanity check platform (or 'firmware') oem parameters */
543         if (orom) {
544                 if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
545                         dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
546                         return NULL;
547                 }
548                 ihost->oem_parameters = orom->ctrl[id];
549                 oem_version = orom->hdr.version;
550         }
551
552         /* validate oem parameters (platform, firmware, or built-in defaults) */
553         if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
554                 dev_warn(&pdev->dev, "oem parameter validation failed\n");
555                 return NULL;
556         }
557
558         for (i = 0; i < SCI_MAX_PORTS; i++) {
559                 struct isci_port *iport = &ihost->ports[i];
560
561                 INIT_LIST_HEAD(&iport->remote_dev_list);
562                 iport->isci_host = ihost;
563         }
564
565         for (i = 0; i < SCI_MAX_PHYS; i++)
566                 isci_phy_init(&ihost->phys[i], ihost, i);
567
568         for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
569                 struct isci_remote_device *idev = &ihost->devices[i];
570
571                 INIT_LIST_HEAD(&idev->node);
572         }
573
574         shost = scsi_host_alloc(&isci_sht, sizeof(void *));
575         if (!shost)
576                 return NULL;
577
578         dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
579                  "{%s, %s, %s, %s}\n",
580                  (is_cable_select_overridden() ? "* " : ""), ihost->id,
581                  lookup_cable_names(decode_cable_selection(ihost, 3)),
582                  lookup_cable_names(decode_cable_selection(ihost, 2)),
583                  lookup_cable_names(decode_cable_selection(ihost, 1)),
584                  lookup_cable_names(decode_cable_selection(ihost, 0)));
585
586         err = isci_host_init(ihost);
587         if (err)
588                 goto err_shost;
589
590         SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
591         ihost->sas_ha.core.shost = shost;
592         shost->transportt = isci_transport_template;
593
594         shost->max_id = ~0;
595         shost->max_lun = ~0;
596         shost->max_cmd_len = MAX_COMMAND_SIZE;
597
598         err = scsi_add_host(shost, &pdev->dev);
599         if (err)
600                 goto err_shost;
601
602         err = isci_register_sas_ha(ihost);
603         if (err)
604                 goto err_shost_remove;
605
606         return ihost;
607
608  err_shost_remove:
609         scsi_remove_host(shost);
610  err_shost:
611         scsi_host_put(shost);
612
613         return NULL;
614 }
615
616 static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
617 {
618         struct isci_pci_info *pci_info;
619         int err, i;
620         struct isci_host *isci_host;
621         const struct firmware *fw = NULL;
622         struct isci_orom *orom = NULL;
623         char *source = "(platform)";
624
625         dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
626                  pdev->revision);
627
628         pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
629         if (!pci_info)
630                 return -ENOMEM;
631         pci_set_drvdata(pdev, pci_info);
632
633         if (efi_enabled(EFI_RUNTIME_SERVICES))
634                 orom = isci_get_efi_var(pdev);
635
636         if (!orom)
637                 orom = isci_request_oprom(pdev);
638
639         for (i = 0; orom && i < num_controllers(pdev); i++) {
640                 if (sci_oem_parameters_validate(&orom->ctrl[i],
641                                                 orom->hdr.version)) {
642                         dev_warn(&pdev->dev,
643                                  "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
644                         orom = NULL;
645                         break;
646                 }
647         }
648
649         if (!orom) {
650                 source = "(firmware)";
651                 orom = isci_request_firmware(pdev, fw);
652                 if (!orom) {
653                         /* TODO convert this to WARN_TAINT_ONCE once the
654                          * orom/efi parameter support is widely available
655                          */
656                         dev_warn(&pdev->dev,
657                                  "Loading user firmware failed, using default "
658                                  "values\n");
659                         dev_warn(&pdev->dev,
660                                  "Default OEM configuration being used: 4 "
661                                  "narrow ports, and default SAS Addresses\n");
662                 }
663         }
664
665         if (orom)
666                 dev_info(&pdev->dev,
667                          "OEM SAS parameters (version: %u.%u) loaded %s\n",
668                          (orom->hdr.version & 0xf0) >> 4,
669                          (orom->hdr.version & 0xf), source);
670
671         pci_info->orom = orom;
672
673         err = isci_pci_init(pdev);
674         if (err)
675                 return err;
676
677         for (i = 0; i < num_controllers(pdev); i++) {
678                 struct isci_host *h = isci_host_alloc(pdev, i);
679
680                 if (!h) {
681                         err = -ENOMEM;
682                         goto err_host_alloc;
683                 }
684                 pci_info->hosts[i] = h;
685
686                 /* turn on DIF support */
687                 scsi_host_set_prot(to_shost(h),
688                                    SHOST_DIF_TYPE1_PROTECTION |
689                                    SHOST_DIF_TYPE2_PROTECTION |
690                                    SHOST_DIF_TYPE3_PROTECTION);
691                 scsi_host_set_guard(to_shost(h), SHOST_DIX_GUARD_CRC);
692         }
693
694         err = isci_setup_interrupts(pdev);
695         if (err)
696                 goto err_host_alloc;
697
698         for_each_isci_host(i, isci_host, pdev)
699                 scsi_scan_host(to_shost(isci_host));
700
701         return 0;
702
703  err_host_alloc:
704         for_each_isci_host(i, isci_host, pdev)
705                 isci_unregister(isci_host);
706         return err;
707 }
708
709 static void isci_pci_remove(struct pci_dev *pdev)
710 {
711         struct isci_host *ihost;
712         int i;
713
714         for_each_isci_host(i, ihost, pdev) {
715                 wait_for_start(ihost);
716                 isci_unregister(ihost);
717                 isci_host_deinit(ihost);
718         }
719 }
720
721 #ifdef CONFIG_PM_SLEEP
722 static int isci_suspend(struct device *dev)
723 {
724         struct pci_dev *pdev = to_pci_dev(dev);
725         struct isci_host *ihost;
726         int i;
727
728         for_each_isci_host(i, ihost, pdev) {
729                 sas_suspend_ha(&ihost->sas_ha);
730                 isci_host_deinit(ihost);
731         }
732
733         pci_save_state(pdev);
734         pci_disable_device(pdev);
735         pci_set_power_state(pdev, PCI_D3hot);
736
737         return 0;
738 }
739
740 static int isci_resume(struct device *dev)
741 {
742         struct pci_dev *pdev = to_pci_dev(dev);
743         struct isci_host *ihost;
744         int rc, i;
745
746         pci_set_power_state(pdev, PCI_D0);
747         pci_restore_state(pdev);
748
749         rc = pcim_enable_device(pdev);
750         if (rc) {
751                 dev_err(&pdev->dev,
752                         "enabling device failure after resume(%d)\n", rc);
753                 return rc;
754         }
755
756         pci_set_master(pdev);
757
758         for_each_isci_host(i, ihost, pdev) {
759                 sas_prep_resume_ha(&ihost->sas_ha);
760
761                 isci_host_init(ihost);
762                 isci_host_start(ihost->sas_ha.core.shost);
763                 wait_for_start(ihost);
764
765                 sas_resume_ha(&ihost->sas_ha);
766         }
767
768         return 0;
769 }
770 #endif
771
772 static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
773
774 static struct pci_driver isci_pci_driver = {
775         .name           = DRV_NAME,
776         .id_table       = isci_id_table,
777         .probe          = isci_pci_probe,
778         .remove         = isci_pci_remove,
779         .driver.pm      = &isci_pm_ops,
780 };
781
782 static __init int isci_init(void)
783 {
784         int err;
785
786         pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
787                 DRV_NAME, DRV_VERSION);
788
789         isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
790         if (!isci_transport_template)
791                 return -ENOMEM;
792
793         err = pci_register_driver(&isci_pci_driver);
794         if (err)
795                 sas_release_transport(isci_transport_template);
796
797         return err;
798 }
799
800 static __exit void isci_exit(void)
801 {
802         pci_unregister_driver(&isci_pci_driver);
803         sas_release_transport(isci_transport_template);
804 }
805
806 MODULE_LICENSE("Dual BSD/GPL");
807 MODULE_FIRMWARE(ISCI_FW_NAME);
808 module_init(isci_init);
809 module_exit(isci_exit);