GNU Linux-libre 4.19.286-gnu1
[releases.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_target_reset_handler        = sas_eh_target_reset_handler,
170         .slave_alloc                    = sas_slave_alloc,
171         .target_destroy                 = sas_target_destroy,
172         .ioctl                          = sas_ioctl,
173         .shost_attrs                    = isci_host_attrs,
174         .track_queue_depth              = 1,
175 };
176
177 static 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
197         /* ata recovery called from ata-eh */
198         .lldd_ata_check_ready   = isci_ata_check_ready,
199
200         /* 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,
206
207         /* GPIO support */
208         .lldd_write_gpio        = isci_gpio_write,
209 };
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  *
225  * This method returns an error code indicating success or failure. The user
226  * should check for possible memory allocation error return otherwise, a zero
227  * indicates success.
228  */
229 static 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_kcalloc(&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_kcalloc(&isci_host->pdev->dev,
243                                  SCI_MAX_PORTS, sizeof(void *),
244                                  GFP_KERNEL);
245         if (!sas_ports)
246                 return -ENOMEM;
247
248         sas_ha->sas_ha_name = DRV_NAME;
249         sas_ha->lldd_module = THIS_MODULE;
250         sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
251
252         for (i = 0; i < SCI_MAX_PHYS; i++) {
253                 sas_phys[i] = &isci_host->phys[i].sas_phy;
254                 sas_ports[i] = &isci_host->sas_ports[i];
255         }
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->strict_wide_ports = 1;
262
263         sas_register_ha(sas_ha);
264
265         return 0;
266 }
267
268 static void isci_unregister(struct isci_host *isci_host)
269 {
270         struct Scsi_Host *shost;
271
272         if (!isci_host)
273                 return;
274
275         shost = to_shost(isci_host);
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         err = pci_alloc_irq_vectors(pdev, num_msix, num_msix, PCI_IRQ_MSIX);
354         if (err < 0)
355                 goto intx;
356
357         for (i = 0; i < num_msix; i++) {
358                 int id = i / SCI_NUM_MSI_X_INT;
359                 irq_handler_t isr;
360
361                 ihost = pci_info->hosts[id];
362                 /* odd numbered vectors are error interrupts */
363                 if (i & 1)
364                         isr = isci_error_isr;
365                 else
366                         isr = isci_msix_isr;
367
368                 err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
369                                 isr, 0, DRV_NAME"-msix", ihost);
370                 if (!err)
371                         continue;
372
373                 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
374                 while (i--) {
375                         id = i / SCI_NUM_MSI_X_INT;
376                         ihost = pci_info->hosts[id];
377                         devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i),
378                                         ihost);
379                 }
380                 pci_free_irq_vectors(pdev);
381                 goto intx;
382         }
383         return 0;
384
385  intx:
386         for_each_isci_host(i, ihost, pdev) {
387                 err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, 0),
388                                 isci_intx_isr, IRQF_SHARED, DRV_NAME"-intx",
389                                 ihost);
390                 if (err)
391                         break;
392         }
393         return err;
394 }
395
396 static void isci_user_parameters_get(struct sci_user_parameters *u)
397 {
398         int i;
399
400         for (i = 0; i < SCI_MAX_PHYS; i++) {
401                 struct sci_phy_user_params *u_phy = &u->phys[i];
402
403                 u_phy->max_speed_generation = phy_gen;
404
405                 /* we are not exporting these for now */
406                 u_phy->align_insertion_frequency = 0x7f;
407                 u_phy->in_connection_align_insertion_frequency = 0xff;
408                 u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
409         }
410
411         u->stp_inactivity_timeout = stp_inactive_to;
412         u->ssp_inactivity_timeout = ssp_inactive_to;
413         u->stp_max_occupancy_timeout = stp_max_occ_to;
414         u->ssp_max_occupancy_timeout = ssp_max_occ_to;
415         u->no_outbound_task_timeout = no_outbound_task_to;
416         u->max_concurr_spinup = max_concurr_spinup;
417 }
418
419 static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
420                                                struct sci_user_parameters *sci_parms)
421 {
422         u16 index;
423
424         /*
425          * Validate the user parameters.  If they are not legal, then
426          * return a failure.
427          */
428         for (index = 0; index < SCI_MAX_PHYS; index++) {
429                 struct sci_phy_user_params *u;
430
431                 u = &sci_parms->phys[index];
432
433                 if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
434                       (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
435                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
436
437                 if ((u->in_connection_align_insertion_frequency < 3) ||
438                     (u->align_insertion_frequency == 0) ||
439                     (u->notify_enable_spin_up_insertion_frequency == 0))
440                         return SCI_FAILURE_INVALID_PARAMETER_VALUE;
441         }
442
443         if ((sci_parms->stp_inactivity_timeout == 0) ||
444             (sci_parms->ssp_inactivity_timeout == 0) ||
445             (sci_parms->stp_max_occupancy_timeout == 0) ||
446             (sci_parms->ssp_max_occupancy_timeout == 0) ||
447             (sci_parms->no_outbound_task_timeout == 0))
448                 return SCI_FAILURE_INVALID_PARAMETER_VALUE;
449
450         memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
451
452         return SCI_SUCCESS;
453 }
454
455 static void sci_oem_defaults(struct isci_host *ihost)
456 {
457         /* these defaults are overridden by the platform / firmware */
458         struct sci_user_parameters *user = &ihost->user_parameters;
459         struct sci_oem_params *oem = &ihost->oem_parameters;
460         int i;
461
462         /* Default to APC mode. */
463         oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
464
465         /* Default to APC mode. */
466         oem->controller.max_concurr_spin_up = 1;
467
468         /* Default to no SSC operation. */
469         oem->controller.do_enable_ssc = false;
470
471         /* Default to short cables on all phys. */
472         oem->controller.cable_selection_mask = 0;
473
474         /* Initialize all of the port parameter information to narrow ports. */
475         for (i = 0; i < SCI_MAX_PORTS; i++)
476                 oem->ports[i].phy_mask = 0;
477
478         /* Initialize all of the phy parameter information. */
479         for (i = 0; i < SCI_MAX_PHYS; i++) {
480                 /* Default to 3G (i.e. Gen 2). */
481                 user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
482
483                 /* the frequencies cannot be 0 */
484                 user->phys[i].align_insertion_frequency = 0x7f;
485                 user->phys[i].in_connection_align_insertion_frequency = 0xff;
486                 user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
487
488                 /* Previous Vitesse based expanders had a arbitration issue that
489                  * is worked around by having the upper 32-bits of SAS address
490                  * with a value greater then the Vitesse company identifier.
491                  * Hence, usage of 0x5FCFFFFF.
492                  */
493                 oem->phys[i].sas_address.low = 0x1 + ihost->id;
494                 oem->phys[i].sas_address.high = 0x5FCFFFFF;
495         }
496
497         user->stp_inactivity_timeout = 5;
498         user->ssp_inactivity_timeout = 5;
499         user->stp_max_occupancy_timeout = 5;
500         user->ssp_max_occupancy_timeout = 20;
501         user->no_outbound_task_timeout = 2;
502 }
503
504 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
505 {
506         struct isci_orom *orom = to_pci_info(pdev)->orom;
507         struct sci_user_parameters sci_user_params;
508         u8 oem_version = ISCI_ROM_VER_1_0;
509         struct isci_host *ihost;
510         struct Scsi_Host *shost;
511         int err, i;
512
513         ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
514         if (!ihost)
515                 return NULL;
516
517         ihost->pdev = pdev;
518         ihost->id = id;
519         spin_lock_init(&ihost->scic_lock);
520         init_waitqueue_head(&ihost->eventq);
521         ihost->sas_ha.dev = &ihost->pdev->dev;
522         ihost->sas_ha.lldd_ha = ihost;
523         tasklet_init(&ihost->completion_tasklet,
524                      isci_host_completion_routine, (unsigned long)ihost);
525
526         /* validate module parameters */
527         /* TODO: kill struct sci_user_parameters and reference directly */
528         sci_oem_defaults(ihost);
529         isci_user_parameters_get(&sci_user_params);
530         if (sci_user_parameters_set(ihost, &sci_user_params)) {
531                 dev_warn(&pdev->dev,
532                          "%s: sci_user_parameters_set failed\n", __func__);
533                 return NULL;
534         }
535
536         /* sanity check platform (or 'firmware') oem parameters */
537         if (orom) {
538                 if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
539                         dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
540                         return NULL;
541                 }
542                 ihost->oem_parameters = orom->ctrl[id];
543                 oem_version = orom->hdr.version;
544         }
545
546         /* validate oem parameters (platform, firmware, or built-in defaults) */
547         if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
548                 dev_warn(&pdev->dev, "oem parameter validation failed\n");
549                 return NULL;
550         }
551
552         for (i = 0; i < SCI_MAX_PORTS; i++) {
553                 struct isci_port *iport = &ihost->ports[i];
554
555                 INIT_LIST_HEAD(&iport->remote_dev_list);
556                 iport->isci_host = ihost;
557         }
558
559         for (i = 0; i < SCI_MAX_PHYS; i++)
560                 isci_phy_init(&ihost->phys[i], ihost, i);
561
562         for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
563                 struct isci_remote_device *idev = &ihost->devices[i];
564
565                 INIT_LIST_HEAD(&idev->node);
566         }
567
568         shost = scsi_host_alloc(&isci_sht, sizeof(void *));
569         if (!shost)
570                 return NULL;
571
572         dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
573                  "{%s, %s, %s, %s}\n",
574                  (is_cable_select_overridden() ? "* " : ""), ihost->id,
575                  lookup_cable_names(decode_cable_selection(ihost, 3)),
576                  lookup_cable_names(decode_cable_selection(ihost, 2)),
577                  lookup_cable_names(decode_cable_selection(ihost, 1)),
578                  lookup_cable_names(decode_cable_selection(ihost, 0)));
579
580         err = isci_host_init(ihost);
581         if (err)
582                 goto err_shost;
583
584         SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
585         ihost->sas_ha.core.shost = shost;
586         shost->transportt = isci_transport_template;
587
588         shost->max_id = ~0;
589         shost->max_lun = ~0;
590         shost->max_cmd_len = MAX_COMMAND_SIZE;
591
592         /* turn on DIF support */
593         scsi_host_set_prot(shost,
594                            SHOST_DIF_TYPE1_PROTECTION |
595                            SHOST_DIF_TYPE2_PROTECTION |
596                            SHOST_DIF_TYPE3_PROTECTION);
597         scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
598
599         err = scsi_add_host(shost, &pdev->dev);
600         if (err)
601                 goto err_shost;
602
603         err = isci_register_sas_ha(ihost);
604         if (err)
605                 goto err_shost_remove;
606
607         return ihost;
608
609  err_shost_remove:
610         scsi_remove_host(shost);
611  err_shost:
612         scsi_host_put(shost);
613
614         return NULL;
615 }
616
617 static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
618 {
619         struct isci_pci_info *pci_info;
620         int err, i;
621         struct isci_host *isci_host;
622         const struct firmware *fw = NULL;
623         struct isci_orom *orom = NULL;
624         char *source = "(platform)";
625
626         dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
627                  pdev->revision);
628
629         pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
630         if (!pci_info)
631                 return -ENOMEM;
632         pci_set_drvdata(pdev, pci_info);
633
634         if (efi_enabled(EFI_RUNTIME_SERVICES))
635                 orom = isci_get_efi_var(pdev);
636
637         if (!orom)
638                 orom = isci_request_oprom(pdev);
639
640         for (i = 0; orom && i < num_controllers(pdev); i++) {
641                 if (sci_oem_parameters_validate(&orom->ctrl[i],
642                                                 orom->hdr.version)) {
643                         dev_warn(&pdev->dev,
644                                  "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
645                         orom = NULL;
646                         break;
647                 }
648         }
649
650         if (!orom) {
651                 source = "(firmware)";
652                 orom = isci_request_firmware(pdev, fw);
653                 if (!orom) {
654                         /* TODO convert this to WARN_TAINT_ONCE once the
655                          * orom/efi parameter support is widely available
656                          */
657                         dev_warn(&pdev->dev,
658                                  "Loading user firmware failed, using default "
659                                  "values\n");
660                         dev_warn(&pdev->dev,
661                                  "Default OEM configuration being used: 4 "
662                                  "narrow ports, and default SAS Addresses\n");
663                 }
664         }
665
666         if (orom)
667                 dev_info(&pdev->dev,
668                          "OEM SAS parameters (version: %u.%u) loaded %s\n",
669                          (orom->hdr.version & 0xf0) >> 4,
670                          (orom->hdr.version & 0xf), source);
671
672         pci_info->orom = orom;
673
674         err = isci_pci_init(pdev);
675         if (err)
676                 return err;
677
678         for (i = 0; i < num_controllers(pdev); i++) {
679                 struct isci_host *h = isci_host_alloc(pdev, i);
680
681                 if (!h) {
682                         err = -ENOMEM;
683                         goto err_host_alloc;
684                 }
685                 pci_info->hosts[i] = h;
686         }
687
688         err = isci_setup_interrupts(pdev);
689         if (err)
690                 goto err_host_alloc;
691
692         for_each_isci_host(i, isci_host, pdev)
693                 scsi_scan_host(to_shost(isci_host));
694
695         return 0;
696
697  err_host_alloc:
698         for_each_isci_host(i, isci_host, pdev)
699                 isci_unregister(isci_host);
700         return err;
701 }
702
703 static void isci_pci_remove(struct pci_dev *pdev)
704 {
705         struct isci_host *ihost;
706         int i;
707
708         for_each_isci_host(i, ihost, pdev) {
709                 wait_for_start(ihost);
710                 isci_unregister(ihost);
711                 isci_host_deinit(ihost);
712         }
713 }
714
715 #ifdef CONFIG_PM_SLEEP
716 static int isci_suspend(struct device *dev)
717 {
718         struct pci_dev *pdev = to_pci_dev(dev);
719         struct isci_host *ihost;
720         int i;
721
722         for_each_isci_host(i, ihost, pdev) {
723                 sas_suspend_ha(&ihost->sas_ha);
724                 isci_host_deinit(ihost);
725         }
726
727         pci_save_state(pdev);
728         pci_disable_device(pdev);
729         pci_set_power_state(pdev, PCI_D3hot);
730
731         return 0;
732 }
733
734 static int isci_resume(struct device *dev)
735 {
736         struct pci_dev *pdev = to_pci_dev(dev);
737         struct isci_host *ihost;
738         int rc, i;
739
740         pci_set_power_state(pdev, PCI_D0);
741         pci_restore_state(pdev);
742
743         rc = pcim_enable_device(pdev);
744         if (rc) {
745                 dev_err(&pdev->dev,
746                         "enabling device failure after resume(%d)\n", rc);
747                 return rc;
748         }
749
750         pci_set_master(pdev);
751
752         for_each_isci_host(i, ihost, pdev) {
753                 sas_prep_resume_ha(&ihost->sas_ha);
754
755                 isci_host_init(ihost);
756                 isci_host_start(ihost->sas_ha.core.shost);
757                 wait_for_start(ihost);
758
759                 sas_resume_ha(&ihost->sas_ha);
760         }
761
762         return 0;
763 }
764 #endif
765
766 static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
767
768 static struct pci_driver isci_pci_driver = {
769         .name           = DRV_NAME,
770         .id_table       = isci_id_table,
771         .probe          = isci_pci_probe,
772         .remove         = isci_pci_remove,
773         .driver.pm      = &isci_pm_ops,
774 };
775
776 static __init int isci_init(void)
777 {
778         int err;
779
780         pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
781                 DRV_NAME, DRV_VERSION);
782
783         isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
784         if (!isci_transport_template)
785                 return -ENOMEM;
786
787         err = pci_register_driver(&isci_pci_driver);
788         if (err)
789                 sas_release_transport(isci_transport_template);
790
791         return err;
792 }
793
794 static __exit void isci_exit(void)
795 {
796         pci_unregister_driver(&isci_pci_driver);
797         sas_release_transport(isci_transport_template);
798 }
799
800 MODULE_LICENSE("Dual BSD/GPL");
801 MODULE_FIRMWARE(ISCI_FW_NAME);
802 module_init(isci_init);
803 module_exit(isci_exit);