drivers/scsi/isci/sata.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 "isci.h"
  57 #include "scic_remote_device.h"
  58 #include "scic_sds_remote_device.h"
  59 #include "scic_io_request.h"
  60 #include "scic_task_request.h"
  61 #include "task.h"
  62 #include "request.h"
  63 #include "sata.h"
  64 #include "intel_sat.h"
  65 #include "intel_ata.h"
  66
  67 static u8 isci_sata_get_management_task_protocol(struct isci_tmf *tmf);
  68
  69
  70 /**
  71  * isci_sata_task_to_fis_copy() - This function gets the host_to_dev_fis from
  72  *    the core and copies the fis from the task into it.
  73  * @task: This parameter is a pointer to the task struct from libsas.
  74  *
  75  * pointer to the host_to_dev_fis from the core request object.
  76  */
  77 struct host_to_dev_fis *isci_sata_task_to_fis_copy(struct sas_task *task)
  78 {
  79         struct isci_request *request = task->lldd_task;
  80         struct host_to_dev_fis *register_fis =
  81                 scic_stp_io_request_get_h2d_reg_address(
  82                         request->sci_request_handle
  83                         );
  84
  85         memcpy(
  86                 (u8 *)register_fis,
  87                 (u8 *)&task->ata_task.fis,
  88                 sizeof(struct host_to_dev_fis)
  89                 );
  90
  91         if (!task->ata_task.device_control_reg_update)
  92                 register_fis->flags |= 0x80;
  93
  94         register_fis->flags &= 0xF0;
  95
  96         return register_fis;
  97 }
  98
  99 /**
 100  * isci_sata_is_task_ncq() - This function determines if the given stp task is
 101  *    a ncq request.
 102  * @task: This parameter is a pointer to the task struct from libsas.
 103  *
 104  * true if the task is ncq
 105  */
 106 bool isci_sata_is_task_ncq(struct sas_task *task)
 107 {
 108         struct ata_queued_cmd *qc = task->uldd_task;
 109
 110         bool ret = (qc &&
 111                     (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
 112                      qc->tf.command == ATA_CMD_FPDMA_READ));
 113
 114         return ret;
 115 }
 116
 117 /**
 118  * isci_sata_set_ncq_tag() - This function sets the ncq tag field in the
 119  *    host_to_dev_fis equal to the tag in the queue command in the task.
 120  * @task: This parameter is a pointer to the task struct from libsas.
 121  * @register_fis: This parameter is a pointer to the host_to_dev_fis from the
 122  *    core request object.
 123  *
 124  */
 125 void isci_sata_set_ncq_tag(
 126         struct host_to_dev_fis *register_fis,
 127         struct sas_task *task)
 128 {
 129         struct ata_queued_cmd *qc = task->uldd_task;
 130         struct isci_request *request = task->lldd_task;
 131
 132         register_fis->sector_count = qc->tag << 3;
 133         scic_stp_io_request_set_ncq_tag(request->sci_request_handle, qc->tag);
 134 }
 135
 136 /**
 137  * isci_request_process_stp_response() - This function sets the status and
 138  *    response, in the task struct, from the request object for the upper layer
 139  *    driver.
 140  * @sas_task: This parameter is the task struct from the upper layer driver.
 141  * @response_buffer: This parameter points to the response of the completed
 142  *    request.
 143  *
 144  * none.
 145  */
 146 void isci_request_process_stp_response(
 147         struct sas_task *task,
 148         void *response_buffer)
 149 {
 150         struct sata_fis_reg_d2h *d2h_reg_fis = (struct sata_fis_reg_d2h *)response_buffer;
 151         struct task_status_struct *ts = &task->task_status;
 152         struct ata_task_resp *resp = (void *)&ts->buf[0];
 153
 154         resp->frame_len = le16_to_cpu(*(__le16 *)(response_buffer + 6));
 155         memcpy(&resp->ending_fis[0], response_buffer + 16, 24);
 156         ts->buf_valid_size = sizeof(*resp);
 157
 158         /**
 159          * If the device fault bit is set in the status register, then
 160          * set the sense data and return.
 161          */
 162         if (d2h_reg_fis->status & ATA_STATUS_REG_DEVICE_FAULT_BIT)
 163                 ts->stat = SAS_PROTO_RESPONSE;
 164         else
 165                 ts->stat = SAM_STAT_GOOD;
 166
 167         ts->resp = SAS_TASK_COMPLETE;
 168 }
 169
 170 /**
 171  * isci_sata_get_sat_protocol() - retrieve the sat protocol for the request
 172  * @isci_request: ata request
 173  *
 174  * Note: temporary implementation until expert mode removes the callback
 175  *
 176  */
 177 u8 isci_sata_get_sat_protocol(struct isci_request *isci_request)
 178 {
 179         struct sas_task *task;
 180         struct domain_device *dev;
 181
 182         dev_dbg(&isci_request->isci_host->pdev->dev,
 183                 "%s: isci_request = %p, ttype = %d\n",
 184                 __func__, isci_request, isci_request->ttype);
 185
 186         if (tmf_task == isci_request->ttype) {
 187                 struct isci_tmf *tmf = isci_request_access_tmf(isci_request);
 188
 189                 return isci_sata_get_management_task_protocol(tmf);
 190         }
 191
 192         task = isci_request_access_task(isci_request);
 193         dev = task->dev;
 194
 195         if (!sas_protocol_ata(task->task_proto)) {
 196                 WARN(1, "unhandled task protocol\n");
 197                 return SAT_PROTOCOL_NON_DATA;
 198         }
 199
 200         if (task->data_dir == DMA_NONE)
 201                 return SAT_PROTOCOL_NON_DATA;
 202
 203         /* the "_IN" protocol types are equivalent to their "_OUT"
 204          * analogs as far as the core is concerned
 205          */
 206         if (dev->sata_dev.command_set == ATAPI_COMMAND_SET) {
 207                 if (task->ata_task.dma_xfer)
 208                         return SAT_PROTOCOL_PACKET_DMA_DATA_IN;
 209                 else
 210                         return SAT_PROTOCOL_PACKET_PIO_DATA_IN;
 211         }
 212
 213         if (task->ata_task.use_ncq)
 214                 return SAT_PROTOCOL_FPDMA;
 215
 216         if (task->ata_task.dma_xfer)
 217                 return SAT_PROTOCOL_UDMA_DATA_IN;
 218         else
 219                 return SAT_PROTOCOL_PIO_DATA_IN;
 220 }
 221
 222 static u8 isci_sata_get_management_task_protocol(
 223         struct isci_tmf *tmf)
 224 {
 225         u8 ret = 0;
 226
 227         pr_warn("tmf = %p, func = %d\n", tmf, tmf->tmf_code);
 228
 229         if ((tmf->tmf_code == isci_tmf_sata_srst_high) ||
 230             (tmf->tmf_code == isci_tmf_sata_srst_low)) {
 231                 pr_warn("%s: tmf->tmf_code == TMF_LU_RESET\n", __func__);
 232                 ret = SAT_PROTOCOL_SOFT_RESET;
 233         }
 234
 235         return ret;
 236 }
 237
 238 enum sci_status isci_sata_management_task_request_build(
 239         struct isci_request *isci_request)
 240 {
 241         struct isci_tmf *isci_tmf;
 242         enum sci_status status;
 243
 244         if (tmf_task != isci_request->ttype)
 245                 return SCI_FAILURE;
 246
 247         isci_tmf = isci_request_access_tmf(isci_request);
 248
 249         switch (isci_tmf->tmf_code) {
 250
 251         case isci_tmf_sata_srst_high:
 252         case isci_tmf_sata_srst_low:
 253         {
 254                 struct host_to_dev_fis *register_fis =
 255                         scic_stp_io_request_get_h2d_reg_address(
 256                                 isci_request->sci_request_handle
 257                                 );
 258
 259                 memset(register_fis, 0, sizeof(*register_fis));
 260
 261                 register_fis->fis_type  =  0x27;
 262                 register_fis->flags     &= ~0x80;
 263                 register_fis->flags     &= 0xF0;
 264                 if (isci_tmf->tmf_code == isci_tmf_sata_srst_high)
 265                         register_fis->control |= ATA_SRST;
 266                 else
 267                         register_fis->control &= ~ATA_SRST;
 268                 break;
 269         }
 270         /* other management commnd go here... */
 271         default:
 272                 return SCI_FAILURE;
 273         }
 274
 275         /* core builds the protocol specific request
 276          *  based on the h2d fis.
 277          */
 278         status = scic_task_request_construct_sata(
 279                 isci_request->sci_request_handle
 280                 );
 281
 282         return status;
 283 }
 284
 285 /**
 286  * isci_task_send_lu_reset_sata() - This function is called by of the SAS
 287  *    Domain Template functions. This is one of the Task Management functoins
 288  *    called by libsas, to reset the given SAS lun. Note the assumption that
 289  *    while this call is executing, no I/O will be sent by the host to the
 290  *    device.
 291  * @lun: This parameter specifies the lun to be reset.
 292  *
 293  * status, zero indicates success.
 294  */
 295 int isci_task_send_lu_reset_sata(
 296         struct isci_host *isci_host,
 297         struct isci_remote_device *isci_device,
 298         u8 *lun)
 299 {
 300         struct isci_tmf tmf;
 301         int ret = TMF_RESP_FUNC_FAILED;
 302         unsigned long flags;
 303
 304         /* Send the initial SRST to the target */
 305         #define ISCI_SRST_TIMEOUT_MS 20 /* 20 ms timeout. */
 306         isci_task_build_tmf(&tmf, isci_device, isci_tmf_sata_srst_high,
 307                             NULL, NULL
 308                             );
 309
 310         ret = isci_task_execute_tmf(isci_host, &tmf, ISCI_SRST_TIMEOUT_MS);
 311
 312         if (ret != TMF_RESP_FUNC_COMPLETE) {
 313                 dev_warn(&isci_host->pdev->dev,
 314                          "%s: Assert SRST failed (%p) = %x",
 315                          __func__,
 316                          isci_device,
 317                          ret);
 318
 319                 /* Return the failure so that the LUN reset is escalated
 320                  * to a target reset.
 321                  */
 322                 goto out;
 323         }
 324
 325         /* Leave SRST high for a bit. */
 326         #define ISCI_SRST_ASSERT_DELAY 100 /* usecs */
 327         udelay(ISCI_SRST_ASSERT_DELAY);
 328
 329         /* Deassert SRST. */
 330         isci_task_build_tmf(&tmf, isci_device, isci_tmf_sata_srst_low,
 331                             NULL, NULL
 332                             );
 333         ret = isci_task_execute_tmf(isci_host, &tmf, ISCI_SRST_TIMEOUT_MS);
 334
 335         if (ret == TMF_RESP_FUNC_COMPLETE)
 336                 dev_dbg(&isci_host->pdev->dev,
 337                         "%s: SATA LUN reset passed (%p)\n",
 338                         __func__,
 339                         isci_device);
 340         else
 341                 dev_warn(&isci_host->pdev->dev,
 342                          "%s: Deassert SRST failed (%p)=%x\n",
 343                          __func__,
 344                          isci_device,
 345                          ret);
 346
 347  out:
 348         spin_lock_irqsave(&isci_host->scic_lock, flags);
 349
 350         /* Resume the device. */
 351         scic_sds_remote_device_resume(isci_device->sci_device_handle);
 352
 353         spin_unlock_irqrestore(&isci_host->scic_lock, flags);
 354
 355         return ret;
 356 }