drivers/scsi/isci/port.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 /**
  57  * This file contains the isci port implementation.
  58  *
  59  *
  60  */
  61
  62
  63 #include <linux/workqueue.h>
  64 #include "isci.h"
  65 #include "scic_io_request.h"
  66 #include "scic_phy.h"
  67 #include "scic_sds_phy.h"
  68 #include "scic_port.h"
  69 #include "port.h"
  70 #include "request.h"
  71 #include "core/scic_sds_controller.h"
  72
  73 static void isci_port_change_state(
  74         struct isci_port *isci_port,
  75         enum isci_status status);
  76
  77
  78
  79 void isci_port_init(struct isci_port *iport, struct isci_host *ihost, int index)
  80 {
  81         struct scic_sds_port *sci_port;
  82
  83         INIT_LIST_HEAD(&iport->remote_dev_list);
  84         INIT_LIST_HEAD(&iport->domain_dev_list);
  85         spin_lock_init(&iport->state_lock);
  86         init_completion(&iport->start_complete);
  87         iport->isci_host = ihost;
  88         isci_port_change_state(iport, isci_freed);
  89
  90         sci_port = &ihost->sci.port_table[index];
  91         iport->sci_port_handle = sci_port;
  92         sci_port->iport = iport;
  93 }
  94
  95
  96 /**
  97  * isci_port_get_state() - This function gets the status of the port object.
  98  * @isci_port: This parameter points to the isci_port object
  99  *
 100  * status of the object as a isci_status enum.
 101  */
 102 enum isci_status isci_port_get_state(
 103         struct isci_port *isci_port)
 104 {
 105         return isci_port->status;
 106 }
 107
 108 static void isci_port_change_state(
 109         struct isci_port *isci_port,
 110         enum isci_status status)
 111 {
 112         unsigned long flags;
 113
 114         dev_dbg(&isci_port->isci_host->pdev->dev,
 115                 "%s: isci_port = %p, state = 0x%x\n",
 116                 __func__, isci_port, status);
 117
 118         spin_lock_irqsave(&isci_port->state_lock, flags);
 119         isci_port->status = status;
 120         spin_unlock_irqrestore(&isci_port->state_lock, flags);
 121 }
 122
 123 void isci_port_bc_change_received(struct isci_host *ihost,
 124                                   struct scic_sds_port *sci_port,
 125                                   struct scic_sds_phy *sci_phy)
 126 {
 127         struct isci_phy *iphy = sci_phy_to_iphy(sci_phy);
 128
 129         dev_dbg(&ihost->pdev->dev, "%s: iphy = %p, sas_phy = %p\n",
 130                 __func__, iphy, &iphy->sas_phy);
 131
 132         ihost->sas_ha.notify_port_event(&iphy->sas_phy, PORTE_BROADCAST_RCVD);
 133         scic_port_enable_broadcast_change_notification(sci_port);
 134 }
 135
 136 void isci_port_link_up(struct isci_host *isci_host,
 137                        struct scic_sds_port *port,
 138                        struct scic_sds_phy *phy)
 139 {
 140         unsigned long flags;
 141         struct scic_port_properties properties;
 142         struct isci_phy *isci_phy = sci_phy_to_iphy(phy);
 143         struct isci_port *isci_port = port->iport;
 144         unsigned long success = true;
 145
 146         BUG_ON(isci_phy->isci_port != NULL);
 147
 148         isci_phy->isci_port = isci_port;
 149
 150         dev_dbg(&isci_host->pdev->dev,
 151                 "%s: isci_port = %p\n",
 152                 __func__, isci_port);
 153
 154         spin_lock_irqsave(&isci_phy->sas_phy.frame_rcvd_lock, flags);
 155
 156         isci_port_change_state(isci_phy->isci_port, isci_starting);
 157
 158         scic_port_get_properties(port, &properties);
 159
 160         if (phy->protocol == SCIC_SDS_PHY_PROTOCOL_SATA) {
 161                 u64 attached_sas_address;
 162
 163                 isci_phy->sas_phy.oob_mode = SATA_OOB_MODE;
 164                 isci_phy->sas_phy.frame_rcvd_size = sizeof(struct dev_to_host_fis);
 165
 166                 /*
 167                  * For direct-attached SATA devices, the SCI core will
 168                  * automagically assign a SAS address to the end device
 169                  * for the purpose of creating a port. This SAS address
 170                  * will not be the same as assigned to the PHY and needs
 171                  * to be obtained from struct scic_port_properties properties.
 172                  */
 173                 attached_sas_address = properties.remote.sas_address.high;
 174                 attached_sas_address <<= 32;
 175                 attached_sas_address |= properties.remote.sas_address.low;
 176                 swab64s(&attached_sas_address);
 177
 178                 memcpy(&isci_phy->sas_phy.attached_sas_addr,
 179                        &attached_sas_address, sizeof(attached_sas_address));
 180         } else if (phy->protocol == SCIC_SDS_PHY_PROTOCOL_SAS) {
 181                 isci_phy->sas_phy.oob_mode = SAS_OOB_MODE;
 182                 isci_phy->sas_phy.frame_rcvd_size = sizeof(struct sas_identify_frame);
 183
 184                 /* Copy the attached SAS address from the IAF */
 185                 memcpy(isci_phy->sas_phy.attached_sas_addr,
 186                        isci_phy->frame_rcvd.iaf.sas_addr, SAS_ADDR_SIZE);
 187         } else {
 188                 dev_err(&isci_host->pdev->dev, "%s: unkown target\n", __func__);
 189                 success = false;
 190         }
 191
 192         isci_phy->sas_phy.phy->negotiated_linkrate = sci_phy_linkrate(phy);
 193
 194         spin_unlock_irqrestore(&isci_phy->sas_phy.frame_rcvd_lock, flags);
 195
 196         /* Notify libsas that we have an address frame, if indeed
 197          * we've found an SSP, SMP, or STP target */
 198         if (success)
 199                 isci_host->sas_ha.notify_port_event(&isci_phy->sas_phy,
 200                                                     PORTE_BYTES_DMAED);
 201 }
 202
 203
 204 /**
 205  * isci_port_link_down() - This function is called by the sci core when a link
 206  *    becomes inactive.
 207  * @isci_host: This parameter specifies the isci host object.
 208  * @phy: This parameter specifies the isci phy with the active link.
 209  * @port: This parameter specifies the isci port with the active link.
 210  *
 211  */
 212 void isci_port_link_down(struct isci_host *isci_host, struct isci_phy *isci_phy,
 213                          struct isci_port *isci_port)
 214 {
 215         struct isci_remote_device *isci_device;
 216
 217         dev_dbg(&isci_host->pdev->dev,
 218                 "%s: isci_port = %p\n", __func__, isci_port);
 219
 220         if (isci_port) {
 221
 222                 /* check to see if this is the last phy on this port. */
 223                 if (isci_phy->sas_phy.port
 224                     && isci_phy->sas_phy.port->num_phys == 1) {
 225
 226                         /* change the state for all devices on this port.
 227                          * The next task sent to this device will be returned
 228                          * as SAS_TASK_UNDELIVERED, and the scsi mid layer
 229                          * will remove the target
 230                          */
 231                         list_for_each_entry(isci_device,
 232                                             &isci_port->remote_dev_list,
 233                                             node) {
 234                                 dev_dbg(&isci_host->pdev->dev,
 235                                         "%s: isci_device = %p\n",
 236                                         __func__, isci_device);
 237                                 isci_remote_device_change_state(isci_device,
 238                                                                 isci_stopping);
 239                         }
 240                 }
 241                 isci_port_change_state(isci_port, isci_stopping);
 242         }
 243
 244         /* Notify libsas of the borken link, this will trigger calls to our
 245          * isci_port_deformed and isci_dev_gone functions.
 246          */
 247         sas_phy_disconnected(&isci_phy->sas_phy);
 248         isci_host->sas_ha.notify_phy_event(&isci_phy->sas_phy,
 249                                            PHYE_LOSS_OF_SIGNAL);
 250
 251         isci_phy->isci_port = NULL;
 252
 253         dev_dbg(&isci_host->pdev->dev,
 254                 "%s: isci_port = %p - Done\n", __func__, isci_port);
 255 }
 256
 257
 258 /**
 259  * isci_port_deformed() - This function is called by libsas when a port becomes
 260  *    inactive.
 261  * @phy: This parameter specifies the libsas phy with the inactive port.
 262  *
 263  */
 264 void isci_port_deformed(
 265         struct asd_sas_phy *phy)
 266 {
 267         pr_debug("%s: sas_phy = %p\n", __func__, phy);
 268 }
 269
 270 /**
 271  * isci_port_formed() - This function is called by libsas when a port becomes
 272  *    active.
 273  * @phy: This parameter specifies the libsas phy with the active port.
 274  *
 275  */
 276 void isci_port_formed(
 277         struct asd_sas_phy *phy)
 278 {
 279         pr_debug("%s: sas_phy = %p, sas_port = %p\n", __func__, phy, phy->port);
 280 }
 281
 282 /**
 283  * isci_port_ready() - This function is called by the sci core when a link
 284  *    becomes ready.
 285  * @isci_host: This parameter specifies the isci host object.
 286  * @port: This parameter specifies the sci port with the active link.
 287  *
 288  */
 289 void isci_port_ready(struct isci_host *isci_host, struct isci_port *isci_port)
 290 {
 291         dev_dbg(&isci_host->pdev->dev,
 292                 "%s: isci_port = %p\n", __func__, isci_port);
 293
 294         complete_all(&isci_port->start_complete);
 295         isci_port_change_state(isci_port, isci_ready);
 296         return;
 297 }
 298
 299 /**
 300  * isci_port_not_ready() - This function is called by the sci core when a link
 301  *    is not ready. All remote devices on this link will be removed if they are
 302  *    in the stopping state.
 303  * @isci_host: This parameter specifies the isci host object.
 304  * @port: This parameter specifies the sci port with the active link.
 305  *
 306  */
 307 void isci_port_not_ready(struct isci_host *isci_host, struct isci_port *isci_port)
 308 {
 309         dev_dbg(&isci_host->pdev->dev,
 310                 "%s: isci_port = %p\n", __func__, isci_port);
 311 }
 312
 313 /**
 314  * isci_port_hard_reset_complete() - This function is called by the sci core
 315  *    when the hard reset complete notification has been received.
 316  * @port: This parameter specifies the sci port with the active link.
 317  * @completion_status: This parameter specifies the core status for the reset
 318  *    process.
 319  *
 320  */
 321 void isci_port_hard_reset_complete(struct isci_port *isci_port,
 322                                    enum sci_status completion_status)
 323 {
 324         dev_dbg(&isci_port->isci_host->pdev->dev,
 325                 "%s: isci_port = %p, completion_status=%x\n",
 326                      __func__, isci_port, completion_status);
 327
 328         /* Save the status of the hard reset from the port. */
 329         isci_port->hard_reset_status = completion_status;
 330
 331         complete_all(&isci_port->hard_reset_complete);
 332 }
 333
 334 int isci_port_perform_hard_reset(struct isci_host *ihost, struct isci_port *iport,
 335                                  struct isci_phy *iphy)
 336 {
 337         unsigned long flags;
 338         enum sci_status status;
 339         int ret = TMF_RESP_FUNC_COMPLETE;
 340
 341         dev_dbg(&ihost->pdev->dev, "%s: iport = %p\n",
 342                 __func__, iport);
 343
 344         init_completion(&iport->hard_reset_complete);
 345
 346         spin_lock_irqsave(&ihost->scic_lock, flags);
 347
 348         #define ISCI_PORT_RESET_TIMEOUT SCIC_SDS_SIGNATURE_FIS_TIMEOUT
 349         status = scic_port_hard_reset(iport->sci_port_handle,
 350                                       ISCI_PORT_RESET_TIMEOUT);
 351
 352         spin_unlock_irqrestore(&ihost->scic_lock, flags);
 353
 354         if (status == SCI_SUCCESS) {
 355                 wait_for_completion(&iport->hard_reset_complete);
 356
 357                 dev_dbg(&ihost->pdev->dev,
 358                         "%s: iport = %p; hard reset completion\n",
 359                         __func__, iport);
 360
 361                 if (iport->hard_reset_status != SCI_SUCCESS)
 362                         ret = TMF_RESP_FUNC_FAILED;
 363         } else {
 364                 ret = TMF_RESP_FUNC_FAILED;
 365
 366                 dev_err(&ihost->pdev->dev,
 367                         "%s: iport = %p; scic_port_hard_reset call"
 368                         " failed 0x%x\n",
 369                         __func__, iport, status);
 370
 371         }
 372
 373         /* If the hard reset for the port has failed, consider this
 374          * the same as link failures on all phys in the port.
 375          */
 376         if (ret != TMF_RESP_FUNC_COMPLETE) {
 377                 dev_err(&ihost->pdev->dev,
 378                         "%s: iport = %p; hard reset failed "
 379                         "(0x%x) - sending link down to libsas for phy %p\n",
 380                         __func__, iport, iport->hard_reset_status, iphy);
 381
 382                 isci_port_link_down(ihost, iphy, iport);
 383         }
 384
 385         return ret;
 386 }
 387
 388 void isci_port_stop_complete(struct scic_sds_controller *scic,
 389                                           struct scic_sds_port *sci_port,
 390                                           enum sci_status completion_status)
 391 {
 392         dev_dbg(&scic_to_ihost(scic)->pdev->dev, "Port stop complete\n");
 393 }