drivers/scsi/libsas/sas_ata.c

   1 /*
   2  * Support for SATA devices on Serial Attached SCSI (SAS) controllers
   3  *
   4  * Copyright (C) 2006 IBM Corporation
   5  *
   6  * Written by: Darrick J. Wong <djwong@us.ibm.com>, IBM Corporation
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of the
  11  * License, or (at your option) any later version.
  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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21  * USA
  22  */
  23
  24 #include <scsi/sas_ata.h>
  25 #include "sas_internal.h"
  26 #include <scsi/scsi_host.h>
  27 #include <scsi/scsi_device.h>
  28 #include <scsi/scsi_tcq.h>
  29 #include <scsi/scsi.h>
  30 #include <scsi/scsi_transport.h>
  31 #include <scsi/scsi_transport_sas.h>
  32 #include "../scsi_sas_internal.h"
  33
  34 static enum ata_completion_errors sas_to_ata_err(struct task_status_struct *ts)
  35 {
  36         /* Cheesy attempt to translate SAS errors into ATA.  Hah! */
  37
  38         /* transport error */
  39         if (ts->resp == SAS_TASK_UNDELIVERED)
  40                 return AC_ERR_ATA_BUS;
  41
  42         /* ts->resp == SAS_TASK_COMPLETE */
  43         /* task delivered, what happened afterwards? */
  44         switch (ts->stat) {
  45                 case SAS_DEV_NO_RESPONSE:
  46                         return AC_ERR_TIMEOUT;
  47
  48                 case SAS_INTERRUPTED:
  49                 case SAS_PHY_DOWN:
  50                 case SAS_NAK_R_ERR:
  51                         return AC_ERR_ATA_BUS;
  52
  53
  54                 case SAS_DATA_UNDERRUN:
  55                         /*
  56                          * Some programs that use the taskfile interface
  57                          * (smartctl in particular) can cause underrun
  58                          * problems.  Ignore these errors, perhaps at our
  59                          * peril.
  60                          */
  61                         return 0;
  62
  63                 case SAS_DATA_OVERRUN:
  64                 case SAS_QUEUE_FULL:
  65                 case SAS_DEVICE_UNKNOWN:
  66                 case SAS_SG_ERR:
  67                         return AC_ERR_INVALID;
  68
  69                 case SAM_CHECK_COND:
  70                 case SAS_OPEN_TO:
  71                 case SAS_OPEN_REJECT:
  72                         SAS_DPRINTK("%s: Saw error %d.  What to do?\n",
  73                                     __FUNCTION__, ts->stat);
  74                         return AC_ERR_OTHER;
  75
  76                 case SAS_ABORTED_TASK:
  77                         return AC_ERR_DEV;
  78
  79                 case SAS_PROTO_RESPONSE:
  80                         /* This means the ending_fis has the error
  81                          * value; return 0 here to collect it */
  82                         return 0;
  83                 default:
  84                         return 0;
  85         }
  86 }
  87
  88 static void sas_ata_task_done(struct sas_task *task)
  89 {
  90         struct ata_queued_cmd *qc = task->uldd_task;
  91         struct domain_device *dev = qc->ap->private_data;
  92         struct task_status_struct *stat = &task->task_status;
  93         struct ata_task_resp *resp = (struct ata_task_resp *)stat->buf;
  94         enum ata_completion_errors ac;
  95
  96         if (stat->stat == SAS_PROTO_RESPONSE) {
  97                 ata_tf_from_fis(resp->ending_fis, &dev->sata_dev.tf);
  98                 qc->err_mask |= ac_err_mask(dev->sata_dev.tf.command);
  99                 dev->sata_dev.sstatus = resp->sstatus;
 100                 dev->sata_dev.serror = resp->serror;
 101                 dev->sata_dev.scontrol = resp->scontrol;
 102                 dev->sata_dev.ap->sactive = resp->sactive;
 103         } else if (stat->stat != SAM_STAT_GOOD) {
 104                 ac = sas_to_ata_err(stat);
 105                 if (ac) {
 106                         SAS_DPRINTK("%s: SAS error %x\n", __FUNCTION__,
 107                                     stat->stat);
 108                         /* We saw a SAS error. Send a vague error. */
 109                         qc->err_mask = ac;
 110                         dev->sata_dev.tf.feature = 0x04; /* status err */
 111                         dev->sata_dev.tf.command = ATA_ERR;
 112                 }
 113         }
 114
 115         ata_qc_complete(qc);
 116         list_del_init(&task->list);
 117         sas_free_task(task);
 118 }
 119
 120 static unsigned int sas_ata_qc_issue(struct ata_queued_cmd *qc)
 121 {
 122         int res = -ENOMEM;
 123         struct sas_task *task;
 124         struct domain_device *dev = qc->ap->private_data;
 125         struct sas_ha_struct *sas_ha = dev->port->ha;
 126         struct Scsi_Host *host = sas_ha->core.shost;
 127         struct sas_internal *i = to_sas_internal(host->transportt);
 128         struct scatterlist *sg;
 129         unsigned int num = 0;
 130         unsigned int xfer = 0;
 131
 132         task = sas_alloc_task(GFP_ATOMIC);
 133         if (!task)
 134                 goto out;
 135         task->dev = dev;
 136         task->task_proto = SAS_PROTOCOL_STP;
 137         task->task_done = sas_ata_task_done;
 138
 139         if (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
 140             qc->tf.command == ATA_CMD_FPDMA_READ) {
 141                 /* Need to zero out the tag libata assigned us */
 142                 qc->tf.nsect = 0;
 143         }
 144
 145         ata_tf_to_fis(&qc->tf, (u8*)&task->ata_task.fis, 0);
 146         task->uldd_task = qc;
 147         if (is_atapi_taskfile(&qc->tf)) {
 148                 memcpy(task->ata_task.atapi_packet, qc->cdb, qc->dev->cdb_len);
 149                 task->total_xfer_len = qc->nbytes + qc->pad_len;
 150                 task->num_scatter = qc->pad_len ? qc->n_elem + 1 : qc->n_elem;
 151         } else {
 152                 ata_for_each_sg(sg, qc) {
 153                         num++;
 154                         xfer += sg->length;
 155                 }
 156
 157                 task->total_xfer_len = xfer;
 158                 task->num_scatter = num;
 159         }
 160
 161         task->data_dir = qc->dma_dir;
 162         task->scatter = qc->__sg;
 163         task->ata_task.retry_count = 1;
 164         task->task_state_flags = SAS_TASK_STATE_PENDING;
 165
 166         switch (qc->tf.protocol) {
 167         case ATA_PROT_NCQ:
 168                 task->ata_task.use_ncq = 1;
 169                 /* fall through */
 170         case ATA_PROT_ATAPI_DMA:
 171         case ATA_PROT_DMA:
 172                 task->ata_task.dma_xfer = 1;
 173                 break;
 174         }
 175
 176         if (sas_ha->lldd_max_execute_num < 2)
 177                 res = i->dft->lldd_execute_task(task, 1, GFP_ATOMIC);
 178         else
 179                 res = sas_queue_up(task);
 180
 181         /* Examine */
 182         if (res) {
 183                 SAS_DPRINTK("lldd_execute_task returned: %d\n", res);
 184
 185                 sas_free_task(task);
 186                 if (res == -SAS_QUEUE_FULL)
 187                         return -ENOMEM;
 188         }
 189
 190 out:
 191         return res;
 192 }
 193
 194 static u8 sas_ata_check_status(struct ata_port *ap)
 195 {
 196         struct domain_device *dev = ap->private_data;
 197         return dev->sata_dev.tf.command;
 198 }
 199
 200 static void sas_ata_phy_reset(struct ata_port *ap)
 201 {
 202         struct domain_device *dev = ap->private_data;
 203         struct sas_internal *i =
 204                 to_sas_internal(dev->port->ha->core.shost->transportt);
 205         int res = 0;
 206
 207         if (i->dft->lldd_I_T_nexus_reset)
 208                 res = i->dft->lldd_I_T_nexus_reset(dev);
 209
 210         if (res)
 211                 SAS_DPRINTK("%s: Unable to reset I T nexus?\n", __FUNCTION__);
 212
 213         switch (dev->sata_dev.command_set) {
 214                 case ATA_COMMAND_SET:
 215                         SAS_DPRINTK("%s: Found ATA device.\n", __FUNCTION__);
 216                         ap->device[0].class = ATA_DEV_ATA;
 217                         break;
 218                 case ATAPI_COMMAND_SET:
 219                         SAS_DPRINTK("%s: Found ATAPI device.\n", __FUNCTION__);
 220                         ap->device[0].class = ATA_DEV_ATAPI;
 221                         break;
 222                 default:
 223                         SAS_DPRINTK("%s: Unknown SATA command set: %d.\n",
 224                                     __FUNCTION__,
 225                                     dev->sata_dev.command_set);
 226                         ap->device[0].class = ATA_DEV_ATA;
 227                         break;
 228         }
 229
 230         ap->cbl = ATA_CBL_SATA;
 231 }
 232
 233 static void sas_ata_post_internal(struct ata_queued_cmd *qc)
 234 {
 235         if (qc->flags & ATA_QCFLAG_FAILED)
 236                 qc->err_mask |= AC_ERR_OTHER;
 237
 238         if (qc->err_mask)
 239                 SAS_DPRINTK("%s: Failure; reset phy!\n", __FUNCTION__);
 240 }
 241
 242 static void sas_ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
 243 {
 244         struct domain_device *dev = ap->private_data;
 245         memcpy(tf, &dev->sata_dev.tf, sizeof (*tf));
 246 }
 247
 248 static void sas_ata_scr_write(struct ata_port *ap, unsigned int sc_reg_in,
 249                               u32 val)
 250 {
 251         struct domain_device *dev = ap->private_data;
 252
 253         SAS_DPRINTK("STUB %s\n", __FUNCTION__);
 254         switch (sc_reg_in) {
 255                 case SCR_STATUS:
 256                         dev->sata_dev.sstatus = val;
 257                         break;
 258                 case SCR_CONTROL:
 259                         dev->sata_dev.scontrol = val;
 260                         break;
 261                 case SCR_ERROR:
 262                         dev->sata_dev.serror = val;
 263                         break;
 264                 case SCR_ACTIVE:
 265                         dev->sata_dev.ap->sactive = val;
 266                         break;
 267         }
 268 }
 269
 270 static u32 sas_ata_scr_read(struct ata_port *ap, unsigned int sc_reg_in)
 271 {
 272         struct domain_device *dev = ap->private_data;
 273
 274         SAS_DPRINTK("STUB %s\n", __FUNCTION__);
 275         switch (sc_reg_in) {
 276                 case SCR_STATUS:
 277                         return dev->sata_dev.sstatus;
 278                 case SCR_CONTROL:
 279                         return dev->sata_dev.scontrol;
 280                 case SCR_ERROR:
 281                         return dev->sata_dev.serror;
 282                 case SCR_ACTIVE:
 283                         return dev->sata_dev.ap->sactive;
 284                 default:
 285                         return 0xffffffffU;
 286         }
 287 }
 288
 289 static struct ata_port_operations sas_sata_ops = {
 290         .port_disable           = ata_port_disable,
 291         .check_status           = sas_ata_check_status,
 292         .check_altstatus        = sas_ata_check_status,
 293         .dev_select             = ata_noop_dev_select,
 294         .phy_reset              = sas_ata_phy_reset,
 295         .post_internal_cmd      = sas_ata_post_internal,
 296         .tf_read                = sas_ata_tf_read,
 297         .qc_prep                = ata_noop_qc_prep,
 298         .qc_issue               = sas_ata_qc_issue,
 299         .port_start             = ata_sas_port_start,
 300         .port_stop              = ata_sas_port_stop,
 301         .scr_read               = sas_ata_scr_read,
 302         .scr_write              = sas_ata_scr_write
 303 };
 304
 305 static struct ata_port_info sata_port_info = {
 306         .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY | ATA_FLAG_SATA_RESET |
 307                 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA | ATA_FLAG_NCQ,
 308         .pio_mask = 0x1f, /* PIO0-4 */
 309         .mwdma_mask = 0x07, /* MWDMA0-2 */
 310         .udma_mask = ATA_UDMA6,
 311         .port_ops = &sas_sata_ops
 312 };
 313
 314 int sas_ata_init_host_and_port(struct domain_device *found_dev,
 315                                struct scsi_target *starget)
 316 {
 317         struct Scsi_Host *shost = dev_to_shost(&starget->dev);
 318         struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
 319         struct ata_port *ap;
 320
 321         ata_host_init(&found_dev->sata_dev.ata_host,
 322                       &ha->pcidev->dev,
 323                       sata_port_info.flags,
 324                       &sas_sata_ops);
 325         ap = ata_sas_port_alloc(&found_dev->sata_dev.ata_host,
 326                                 &sata_port_info,
 327                                 shost);
 328         if (!ap) {
 329                 SAS_DPRINTK("ata_sas_port_alloc failed.\n");
 330                 return -ENODEV;
 331         }
 332
 333         ap->private_data = found_dev;
 334         ap->cbl = ATA_CBL_SATA;
 335         ap->scsi_host = shost;
 336         found_dev->sata_dev.ap = ap;
 337
 338         return 0;
 339 }