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