drivers/scsi/isci/task.h

   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 #ifndef _ISCI_TASK_H_
  56 #define _ISCI_TASK_H_
  57
  58 #include <scsi/sas_ata.h>
  59 #include "host.h"
  60
  61 #define ISCI_TERMINATION_TIMEOUT_MSEC 500
  62
  63 struct isci_request;
  64
  65 /**
  66  * enum isci_tmf_cb_state - This enum defines the possible states in which the
  67  *    TMF callback function is invoked during the TMF execution process.
  68  *
  69  *
  70  */
  71 enum isci_tmf_cb_state {
  72
  73         isci_tmf_init_state = 0,
  74         isci_tmf_started,
  75         isci_tmf_timed_out
  76 };
  77
  78 /**
  79  * enum isci_tmf_function_codes - This enum defines the possible preparations
  80  *    of task management requests.
  81  *
  82  *
  83  */
  84 enum isci_tmf_function_codes {
  85
  86         isci_tmf_func_none      = 0,
  87         isci_tmf_ssp_task_abort = TMF_ABORT_TASK,
  88         isci_tmf_ssp_lun_reset  = TMF_LU_RESET,
  89         isci_tmf_sata_srst_high = TMF_LU_RESET + 0x100, /* Non SCSI */
  90         isci_tmf_sata_srst_low  = TMF_LU_RESET + 0x101  /* Non SCSI */
  91 };
  92 /**
  93  * struct isci_tmf - This class represents the task management object which
  94  *    acts as an interface to libsas for processing task management requests
  95  *
  96  *
  97  */
  98 struct isci_tmf {
  99
 100         struct completion *complete;
 101         enum sas_protocol proto;
 102         union {
 103                 struct ssp_response_iu resp_iu;
 104                 struct dev_to_host_fis d2h_fis;
 105                 u8 rsp_buf[SSP_RESP_IU_MAX_SIZE];
 106         } resp;
 107         unsigned char lun[8];
 108         u16 io_tag;
 109         struct isci_remote_device *device;
 110         enum isci_tmf_function_codes tmf_code;
 111         int status;
 112
 113         /* The optional callback function allows the user process to
 114          * track the TMF transmit / timeout conditions.
 115          */
 116         void (*cb_state_func)(
 117                 enum isci_tmf_cb_state,
 118                 struct isci_tmf *, void *);
 119         void *cb_data;
 120
 121 };
 122
 123 static inline void isci_print_tmf(struct isci_tmf *tmf)
 124 {
 125         if (SAS_PROTOCOL_SATA == tmf->proto)
 126                 dev_dbg(&tmf->device->isci_port->isci_host->pdev->dev,
 127                         "%s: status = %x\n"
 128                         "tmf->resp.d2h_fis.status = %x\n"
 129                         "tmf->resp.d2h_fis.error = %x\n",
 130                         __func__,
 131                         tmf->status,
 132                         tmf->resp.d2h_fis.status,
 133                         tmf->resp.d2h_fis.error);
 134         else
 135                 dev_dbg(&tmf->device->isci_port->isci_host->pdev->dev,
 136                         "%s: status = %x\n"
 137                         "tmf->resp.resp_iu.data_present = %x\n"
 138                         "tmf->resp.resp_iu.status = %x\n"
 139                         "tmf->resp.resp_iu.data_length = %x\n"
 140                         "tmf->resp.resp_iu.data[0] = %x\n"
 141                         "tmf->resp.resp_iu.data[1] = %x\n"
 142                         "tmf->resp.resp_iu.data[2] = %x\n"
 143                         "tmf->resp.resp_iu.data[3] = %x\n",
 144                         __func__,
 145                         tmf->status,
 146                         tmf->resp.resp_iu.datapres,
 147                         tmf->resp.resp_iu.status,
 148                         be32_to_cpu(tmf->resp.resp_iu.response_data_len),
 149                         tmf->resp.resp_iu.resp_data[0],
 150                         tmf->resp.resp_iu.resp_data[1],
 151                         tmf->resp.resp_iu.resp_data[2],
 152                         tmf->resp.resp_iu.resp_data[3]);
 153 }
 154
 155
 156 int isci_task_execute_task(
 157         struct sas_task *task,
 158         int num,
 159         gfp_t gfp_flags);
 160
 161 int isci_task_abort_task(
 162         struct sas_task *task);
 163
 164 int isci_task_abort_task_set(
 165         struct domain_device *d_device,
 166         u8 *lun);
 167
 168 int isci_task_clear_aca(
 169         struct domain_device *d_device,
 170         u8 *lun);
 171
 172 int isci_task_clear_task_set(
 173         struct domain_device *d_device,
 174         u8 *lun);
 175
 176 int isci_task_query_task(
 177         struct sas_task *task);
 178
 179 int isci_task_lu_reset(
 180         struct domain_device *d_device,
 181         u8 *lun);
 182
 183 int isci_task_clear_nexus_port(
 184         struct asd_sas_port *port);
 185
 186 int isci_task_clear_nexus_ha(
 187         struct sas_ha_struct *ha);
 188
 189 int isci_task_I_T_nexus_reset(
 190         struct domain_device *d_device);
 191
 192 void isci_task_request_complete(
 193         struct isci_host *isci_host,
 194         struct isci_request *request,
 195         enum sci_task_status completion_status);
 196
 197 u16 isci_task_ssp_request_get_io_tag_to_manage(
 198         struct isci_request *request);
 199
 200 u8 isci_task_ssp_request_get_function(
 201         struct isci_request *request);
 202
 203
 204 void *isci_task_ssp_request_get_response_data_address(
 205         struct isci_request *request);
 206
 207 u32 isci_task_ssp_request_get_response_data_length(
 208         struct isci_request *request);
 209
 210 int isci_queuecommand(
 211         struct scsi_cmnd *scsi_cmd,
 212         void (*donefunc)(struct scsi_cmnd *));
 213
 214 int isci_bus_reset_handler(struct scsi_cmnd *cmd);
 215
 216 /**
 217  * enum isci_completion_selection - This enum defines the possible actions to
 218  *    take with respect to a given request's notification back to libsas.
 219  *
 220  *
 221  */
 222 enum isci_completion_selection {
 223
 224         isci_perform_normal_io_completion,      /* Normal notify (task_done) */
 225         isci_perform_aborted_io_completion,     /* No notification.   */
 226         isci_perform_error_io_completion        /* Use sas_task_abort */
 227 };
 228
 229 /**
 230  * isci_task_set_completion_status() - This function sets the completion status
 231  *    for the request.
 232  * @task: This parameter is the completed request.
 233  * @response: This parameter is the response code for the completed task.
 234  * @status: This parameter is the status code for the completed task.
 235  *
 236 * @return The new notification mode for the request.
 237 */
 238 static inline enum isci_completion_selection
 239 isci_task_set_completion_status(
 240         struct sas_task *task,
 241         enum service_response response,
 242         enum exec_status status,
 243         enum isci_completion_selection task_notification_selection)
 244 {
 245         unsigned long flags;
 246
 247         spin_lock_irqsave(&task->task_state_lock, flags);
 248
 249         /* If a device reset is being indicated, make sure the I/O
 250         * is in the error path.
 251         */
 252         if (task->task_state_flags & SAS_TASK_NEED_DEV_RESET) {
 253                 /* Fail the I/O to make sure it goes into the error path. */
 254                 response = SAS_TASK_UNDELIVERED;
 255                 status = SAM_STAT_TASK_ABORTED;
 256
 257                 task_notification_selection = isci_perform_error_io_completion;
 258         }
 259         task->task_status.resp = response;
 260         task->task_status.stat = status;
 261
 262         switch (task->task_proto) {
 263
 264         case SAS_PROTOCOL_SATA:
 265         case SAS_PROTOCOL_STP:
 266         case SAS_PROTOCOL_SATA | SAS_PROTOCOL_STP:
 267
 268                 if (task_notification_selection
 269                     == isci_perform_error_io_completion) {
 270                         /* SATA/STP I/O has it's own means of scheduling device
 271                         * error handling on the normal path.
 272                         */
 273                         task_notification_selection
 274                                 = isci_perform_normal_io_completion;
 275                 }
 276                 break;
 277         default:
 278                 break;
 279         }
 280
 281         switch (task_notification_selection) {
 282
 283         case isci_perform_error_io_completion:
 284
 285                 if (task->task_proto == SAS_PROTOCOL_SMP) {
 286                         /* There is no error escalation in the SMP case.
 287                          * Convert to a normal completion to avoid the
 288                          * timeout in the discovery path and to let the
 289                          * next action take place quickly.
 290                          */
 291                         task_notification_selection
 292                                 = isci_perform_normal_io_completion;
 293
 294                         /* Fall through to the normal case... */
 295                 } else {
 296                         /* Use sas_task_abort */
 297                         /* Leave SAS_TASK_STATE_DONE clear
 298                          * Leave SAS_TASK_AT_INITIATOR set.
 299                          */
 300                         break;
 301                 }
 302
 303         case isci_perform_aborted_io_completion:
 304                 /* This path can occur with task-managed requests as well as
 305                  * requests terminated because of LUN or device resets.
 306                  */
 307                 /* Fall through to the normal case... */
 308         case isci_perform_normal_io_completion:
 309                 /* Normal notification (task_done) */
 310                 task->task_state_flags |= SAS_TASK_STATE_DONE;
 311                 task->task_state_flags &= ~(SAS_TASK_AT_INITIATOR |
 312                                             SAS_TASK_STATE_PENDING);
 313                 break;
 314         default:
 315                 WARN_ONCE(1, "unknown task_notification_selection: %d\n",
 316                          task_notification_selection);
 317                 break;
 318         }
 319
 320         spin_unlock_irqrestore(&task->task_state_lock, flags);
 321
 322         return task_notification_selection;
 323
 324 }
 325 /**
 326 * isci_execpath_callback() - This function is called from the task
 327 * execute path when the task needs to callback libsas about the submit-time
 328 * task failure.  The callback occurs either through the task's done function
 329 * or through sas_task_abort.  In the case of regular non-discovery SATA/STP I/O
 330 * requests, libsas takes the host lock before calling execute task.  Therefore
 331 * in this situation the host lock must be managed before calling the func.
 332 *
 333 * @ihost: This parameter is the controller to which the I/O request was sent.
 334 * @task: This parameter is the I/O request.
 335 * @func: This parameter is the function to call in the correct context.
 336 * @status: This parameter is the status code for the completed task.
 337 *
 338 */
 339 static inline void isci_execpath_callback(struct isci_host *ihost,
 340                                           struct sas_task  *task,
 341                                           void (*func)(struct sas_task *))
 342 {
 343         struct domain_device *dev = task->dev;
 344
 345         if (dev_is_sata(dev) && task->uldd_task) {
 346                 unsigned long flags;
 347
 348                 /* Since we are still in the submit path, and since
 349                  * libsas takes the host lock on behalf of SATA
 350                  * devices before I/O starts (in the non-discovery case),
 351                  * we need to unlock before we can call the callback function.
 352                  */
 353                 raw_local_irq_save(flags);
 354                 spin_unlock(dev->sata_dev.ap->lock);
 355                 func(task);
 356                 spin_lock(dev->sata_dev.ap->lock);
 357                 raw_local_irq_restore(flags);
 358         } else
 359                 func(task);
 360 }
 361 #endif /* !defined(_SCI_TASK_H_) */