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;
  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         unsigned long flags;
  96
  97         if (!qc)
  98                 goto qc_already_gone;
  99
 100         dev = qc->ap->private_data;
 101
 102         spin_lock_irqsave(dev->sata_dev.ap->lock, flags);
 103         if (stat->stat == SAS_PROTO_RESPONSE || stat->stat == SAM_GOOD) {
 104                 ata_tf_from_fis(resp->ending_fis, &dev->sata_dev.tf);
 105                 qc->err_mask |= ac_err_mask(dev->sata_dev.tf.command);
 106                 dev->sata_dev.sstatus = resp->sstatus;
 107                 dev->sata_dev.serror = resp->serror;
 108                 dev->sata_dev.scontrol = resp->scontrol;
 109         } else if (stat->stat != SAM_STAT_GOOD) {
 110                 ac = sas_to_ata_err(stat);
 111                 if (ac) {
 112                         SAS_DPRINTK("%s: SAS error %x\n", __FUNCTION__,
 113                                     stat->stat);
 114                         /* We saw a SAS error. Send a vague error. */
 115                         qc->err_mask = ac;
 116                         dev->sata_dev.tf.feature = 0x04; /* status err */
 117                         dev->sata_dev.tf.command = ATA_ERR;
 118                 }
 119         }
 120
 121         qc->lldd_task = NULL;
 122         if (qc->scsicmd)
 123                 ASSIGN_SAS_TASK(qc->scsicmd, NULL);
 124         ata_qc_complete(qc);
 125         spin_unlock_irqrestore(dev->sata_dev.ap->lock, flags);
 126
 127 qc_already_gone:
 128         list_del_init(&task->list);
 129         sas_free_task(task);
 130 }
 131
 132 static unsigned int sas_ata_qc_issue(struct ata_queued_cmd *qc)
 133 {
 134         int res;
 135         struct sas_task *task;
 136         struct domain_device *dev = qc->ap->private_data;
 137         struct sas_ha_struct *sas_ha = dev->port->ha;
 138         struct Scsi_Host *host = sas_ha->core.shost;
 139         struct sas_internal *i = to_sas_internal(host->transportt);
 140         struct scatterlist *sg;
 141         unsigned int num = 0;
 142         unsigned int xfer = 0;
 143
 144         task = sas_alloc_task(GFP_ATOMIC);
 145         if (!task)
 146                 return AC_ERR_SYSTEM;
 147         task->dev = dev;
 148         task->task_proto = SAS_PROTOCOL_STP;
 149         task->task_done = sas_ata_task_done;
 150
 151         if (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
 152             qc->tf.command == ATA_CMD_FPDMA_READ) {
 153                 /* Need to zero out the tag libata assigned us */
 154                 qc->tf.nsect = 0;
 155         }
 156
 157         ata_tf_to_fis(&qc->tf, (u8*)&task->ata_task.fis, 0);
 158         task->uldd_task = qc;
 159         if (is_atapi_taskfile(&qc->tf)) {
 160                 memcpy(task->ata_task.atapi_packet, qc->cdb, qc->dev->cdb_len);
 161                 task->total_xfer_len = qc->nbytes + qc->pad_len;
 162                 task->num_scatter = qc->pad_len ? qc->n_elem + 1 : qc->n_elem;
 163         } else {
 164                 ata_for_each_sg(sg, qc) {
 165                         num++;
 166                         xfer += sg->length;
 167                 }
 168
 169                 task->total_xfer_len = xfer;
 170                 task->num_scatter = num;
 171         }
 172
 173         task->data_dir = qc->dma_dir;
 174         task->scatter = qc->__sg;
 175         task->ata_task.retry_count = 1;
 176         task->task_state_flags = SAS_TASK_STATE_PENDING;
 177         qc->lldd_task = task;
 178
 179         switch (qc->tf.protocol) {
 180         case ATA_PROT_NCQ:
 181                 task->ata_task.use_ncq = 1;
 182                 /* fall through */
 183         case ATA_PROT_ATAPI_DMA:
 184         case ATA_PROT_DMA:
 185                 task->ata_task.dma_xfer = 1;
 186                 break;
 187         }
 188
 189         if (qc->scsicmd)
 190                 ASSIGN_SAS_TASK(qc->scsicmd, task);
 191
 192         if (sas_ha->lldd_max_execute_num < 2)
 193                 res = i->dft->lldd_execute_task(task, 1, GFP_ATOMIC);
 194         else
 195                 res = sas_queue_up(task);
 196
 197         /* Examine */
 198         if (res) {
 199                 SAS_DPRINTK("lldd_execute_task returned: %d\n", res);
 200
 201                 if (qc->scsicmd)
 202                         ASSIGN_SAS_TASK(qc->scsicmd, NULL);
 203                 sas_free_task(task);
 204                 return AC_ERR_SYSTEM;
 205         }
 206
 207         return 0;
 208 }
 209
 210 static u8 sas_ata_check_status(struct ata_port *ap)
 211 {
 212         struct domain_device *dev = ap->private_data;
 213         return dev->sata_dev.tf.command;
 214 }
 215
 216 static void sas_ata_phy_reset(struct ata_port *ap)
 217 {
 218         struct domain_device *dev = ap->private_data;
 219         struct sas_internal *i =
 220                 to_sas_internal(dev->port->ha->core.shost->transportt);
 221         int res = 0;
 222
 223         if (i->dft->lldd_I_T_nexus_reset)
 224                 res = i->dft->lldd_I_T_nexus_reset(dev);
 225
 226         if (res)
 227                 SAS_DPRINTK("%s: Unable to reset I T nexus?\n", __FUNCTION__);
 228
 229         switch (dev->sata_dev.command_set) {
 230                 case ATA_COMMAND_SET:
 231                         SAS_DPRINTK("%s: Found ATA device.\n", __FUNCTION__);
 232                         ap->device[0].class = ATA_DEV_ATA;
 233                         break;
 234                 case ATAPI_COMMAND_SET:
 235                         SAS_DPRINTK("%s: Found ATAPI device.\n", __FUNCTION__);
 236                         ap->device[0].class = ATA_DEV_ATAPI;
 237                         break;
 238                 default:
 239                         SAS_DPRINTK("%s: Unknown SATA command set: %d.\n",
 240                                     __FUNCTION__,
 241                                     dev->sata_dev.command_set);
 242                         ap->device[0].class = ATA_DEV_UNKNOWN;
 243                         break;
 244         }
 245
 246         ap->cbl = ATA_CBL_SATA;
 247 }
 248
 249 static void sas_ata_post_internal(struct ata_queued_cmd *qc)
 250 {
 251         if (qc->flags & ATA_QCFLAG_FAILED)
 252                 qc->err_mask |= AC_ERR_OTHER;
 253
 254         if (qc->err_mask) {
 255                 /*
 256                  * Find the sas_task and kill it.  By this point,
 257                  * libata has decided to kill the qc, so we needn't
 258                  * bother with sas_ata_task_done.  But we still
 259                  * ought to abort the task.
 260                  */
 261                 struct sas_task *task = qc->lldd_task;
 262                 struct domain_device *dev = qc->ap->private_data;
 263
 264                 qc->lldd_task = NULL;
 265                 if (task) {
 266                         task->uldd_task = NULL;
 267                         __sas_task_abort(task);
 268                 }
 269
 270                 sas_phy_reset(dev->port->phy, 1);
 271         }
 272 }
 273
 274 static void sas_ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
 275 {
 276         struct domain_device *dev = ap->private_data;
 277         memcpy(tf, &dev->sata_dev.tf, sizeof (*tf));
 278 }
 279
 280 static void sas_ata_scr_write(struct ata_port *ap, unsigned int sc_reg_in,
 281                               u32 val)
 282 {
 283         struct domain_device *dev = ap->private_data;
 284
 285         SAS_DPRINTK("STUB %s\n", __FUNCTION__);
 286         switch (sc_reg_in) {
 287                 case SCR_STATUS:
 288                         dev->sata_dev.sstatus = val;
 289                         break;
 290                 case SCR_CONTROL:
 291                         dev->sata_dev.scontrol = val;
 292                         break;
 293                 case SCR_ERROR:
 294                         dev->sata_dev.serror = val;
 295                         break;
 296                 case SCR_ACTIVE:
 297                         dev->sata_dev.ap->sactive = val;
 298                         break;
 299         }
 300 }
 301
 302 static u32 sas_ata_scr_read(struct ata_port *ap, unsigned int sc_reg_in)
 303 {
 304         struct domain_device *dev = ap->private_data;
 305
 306         SAS_DPRINTK("STUB %s\n", __FUNCTION__);
 307         switch (sc_reg_in) {
 308                 case SCR_STATUS:
 309                         return dev->sata_dev.sstatus;
 310                 case SCR_CONTROL:
 311                         return dev->sata_dev.scontrol;
 312                 case SCR_ERROR:
 313                         return dev->sata_dev.serror;
 314                 case SCR_ACTIVE:
 315                         return dev->sata_dev.ap->sactive;
 316                 default:
 317                         return 0xffffffffU;
 318         }
 319 }
 320
 321 static struct ata_port_operations sas_sata_ops = {
 322         .port_disable           = ata_port_disable,
 323         .check_status           = sas_ata_check_status,
 324         .check_altstatus        = sas_ata_check_status,
 325         .dev_select             = ata_noop_dev_select,
 326         .phy_reset              = sas_ata_phy_reset,
 327         .post_internal_cmd      = sas_ata_post_internal,
 328         .tf_read                = sas_ata_tf_read,
 329         .qc_prep                = ata_noop_qc_prep,
 330         .qc_issue               = sas_ata_qc_issue,
 331         .port_start             = ata_sas_port_start,
 332         .port_stop              = ata_sas_port_stop,
 333         .scr_read               = sas_ata_scr_read,
 334         .scr_write              = sas_ata_scr_write
 335 };
 336
 337 static struct ata_port_info sata_port_info = {
 338         .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY | ATA_FLAG_SATA_RESET |
 339                 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA | ATA_FLAG_NCQ,
 340         .pio_mask = 0x1f, /* PIO0-4 */
 341         .mwdma_mask = 0x07, /* MWDMA0-2 */
 342         .udma_mask = ATA_UDMA6,
 343         .port_ops = &sas_sata_ops
 344 };
 345
 346 int sas_ata_init_host_and_port(struct domain_device *found_dev,
 347                                struct scsi_target *starget)
 348 {
 349         struct Scsi_Host *shost = dev_to_shost(&starget->dev);
 350         struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
 351         struct ata_port *ap;
 352
 353         ata_host_init(&found_dev->sata_dev.ata_host,
 354                       &ha->pcidev->dev,
 355                       sata_port_info.flags,
 356                       &sas_sata_ops);
 357         ap = ata_sas_port_alloc(&found_dev->sata_dev.ata_host,
 358                                 &sata_port_info,
 359                                 shost);
 360         if (!ap) {
 361                 SAS_DPRINTK("ata_sas_port_alloc failed.\n");
 362                 return -ENODEV;
 363         }
 364
 365         ap->private_data = found_dev;
 366         ap->cbl = ATA_CBL_SATA;
 367         ap->scsi_host = shost;
 368         found_dev->sata_dev.ap = ap;
 369
 370         return 0;
 371 }