2 * Support for SATA devices on Serial Attached SCSI (SAS) controllers
4 * Copyright (C) 2006 IBM Corporation
6 * Written by: Darrick J. Wong <djwong@us.ibm.com>, IBM Corporation
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.
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.
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
24 #include <linux/scatterlist.h>
25 #include <linux/slab.h>
27 #include <scsi/sas_ata.h>
28 #include "sas_internal.h"
29 #include <scsi/scsi_host.h>
30 #include <scsi/scsi_device.h>
31 #include <scsi/scsi_tcq.h>
32 #include <scsi/scsi.h>
33 #include <scsi/scsi_transport.h>
34 #include <scsi/scsi_transport_sas.h>
35 #include "../scsi_sas_internal.h"
36 #include "../scsi_transport_api.h"
37 #include <scsi/scsi_eh.h>
39 static enum ata_completion_errors sas_to_ata_err(struct task_status_struct *ts)
41 /* Cheesy attempt to translate SAS errors into ATA. Hah! */
44 if (ts->resp == SAS_TASK_UNDELIVERED)
45 return AC_ERR_ATA_BUS;
47 /* ts->resp == SAS_TASK_COMPLETE */
48 /* task delivered, what happened afterwards? */
50 case SAS_DEV_NO_RESPONSE:
51 return AC_ERR_TIMEOUT;
56 return AC_ERR_ATA_BUS;
59 case SAS_DATA_UNDERRUN:
61 * Some programs that use the taskfile interface
62 * (smartctl in particular) can cause underrun
63 * problems. Ignore these errors, perhaps at our
68 case SAS_DATA_OVERRUN:
70 case SAS_DEVICE_UNKNOWN:
72 return AC_ERR_INVALID;
76 SAS_DPRINTK("%s: Saw error %d. What to do?\n",
80 case SAM_STAT_CHECK_CONDITION:
81 case SAS_ABORTED_TASK:
84 case SAS_PROTO_RESPONSE:
85 /* This means the ending_fis has the error
86 * value; return 0 here to collect it */
93 static void sas_ata_task_done(struct sas_task *task)
95 struct ata_queued_cmd *qc = task->uldd_task;
96 struct domain_device *dev = task->dev;
97 struct task_status_struct *stat = &task->task_status;
98 struct ata_task_resp *resp = (struct ata_task_resp *)stat->buf;
99 struct sas_ha_struct *sas_ha = dev->port->ha;
100 enum ata_completion_errors ac;
102 struct ata_link *link;
105 spin_lock_irqsave(&dev->done_lock, flags);
106 if (test_bit(SAS_HA_FROZEN, &sas_ha->state))
108 else if (qc && qc->scsicmd)
109 ASSIGN_SAS_TASK(qc->scsicmd, NULL);
110 spin_unlock_irqrestore(&dev->done_lock, flags);
112 /* check if libsas-eh got to the task before us */
117 goto qc_already_gone;
122 spin_lock_irqsave(ap->lock, flags);
123 /* check if we lost the race with libata/sas_ata_post_internal() */
124 if (unlikely(ap->pflags & ATA_PFLAG_FROZEN)) {
125 spin_unlock_irqrestore(ap->lock, flags);
127 goto qc_already_gone;
129 /* if eh is not involved and the port is frozen then the
130 * ata internal abort process has taken responsibility
137 if (stat->stat == SAS_PROTO_RESPONSE || stat->stat == SAM_STAT_GOOD ||
138 ((stat->stat == SAM_STAT_CHECK_CONDITION &&
139 dev->sata_dev.command_set == ATAPI_COMMAND_SET))) {
140 ata_tf_from_fis(resp->ending_fis, &dev->sata_dev.tf);
142 if (!link->sactive) {
143 qc->err_mask |= ac_err_mask(dev->sata_dev.tf.command);
145 link->eh_info.err_mask |= ac_err_mask(dev->sata_dev.tf.command);
146 if (unlikely(link->eh_info.err_mask))
147 qc->flags |= ATA_QCFLAG_FAILED;
150 ac = sas_to_ata_err(stat);
152 SAS_DPRINTK("%s: SAS error %x\n", __func__,
154 /* We saw a SAS error. Send a vague error. */
155 if (!link->sactive) {
158 link->eh_info.err_mask |= AC_ERR_DEV;
159 qc->flags |= ATA_QCFLAG_FAILED;
162 dev->sata_dev.tf.feature = 0x04; /* status err */
163 dev->sata_dev.tf.command = ATA_ERR;
167 qc->lldd_task = NULL;
169 spin_unlock_irqrestore(ap->lock, flags);
172 list_del_init(&task->list);
176 static unsigned int sas_ata_qc_issue(struct ata_queued_cmd *qc)
179 struct sas_task *task;
180 struct scatterlist *sg;
181 int ret = AC_ERR_SYSTEM;
182 unsigned int si, xfer = 0;
183 struct ata_port *ap = qc->ap;
184 struct domain_device *dev = ap->private_data;
185 struct sas_ha_struct *sas_ha = dev->port->ha;
186 struct Scsi_Host *host = sas_ha->core.shost;
187 struct sas_internal *i = to_sas_internal(host->transportt);
189 /* TODO: audit callers to ensure they are ready for qc_issue to
190 * unconditionally re-enable interrupts
192 local_irq_save(flags);
193 spin_unlock(ap->lock);
195 /* If the device fell off, no sense in issuing commands */
196 if (test_bit(SAS_DEV_GONE, &dev->state))
199 task = sas_alloc_task(GFP_ATOMIC);
203 task->task_proto = SAS_PROTOCOL_STP;
204 task->task_done = sas_ata_task_done;
206 if (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
207 qc->tf.command == ATA_CMD_FPDMA_READ) {
208 /* Need to zero out the tag libata assigned us */
212 ata_tf_to_fis(&qc->tf, 1, 0, (u8*)&task->ata_task.fis);
213 task->uldd_task = qc;
214 if (ata_is_atapi(qc->tf.protocol)) {
215 memcpy(task->ata_task.atapi_packet, qc->cdb, qc->dev->cdb_len);
216 task->total_xfer_len = qc->nbytes;
217 task->num_scatter = qc->n_elem;
219 for_each_sg(qc->sg, sg, qc->n_elem, si)
222 task->total_xfer_len = xfer;
223 task->num_scatter = si;
226 task->data_dir = qc->dma_dir;
227 task->scatter = qc->sg;
228 task->ata_task.retry_count = 1;
229 task->task_state_flags = SAS_TASK_STATE_PENDING;
230 qc->lldd_task = task;
232 switch (qc->tf.protocol) {
234 task->ata_task.use_ncq = 1;
238 task->ata_task.dma_xfer = 1;
243 ASSIGN_SAS_TASK(qc->scsicmd, task);
245 if (sas_ha->lldd_max_execute_num < 2)
246 ret = i->dft->lldd_execute_task(task, 1, GFP_ATOMIC);
248 ret = sas_queue_up(task);
252 SAS_DPRINTK("lldd_execute_task returned: %d\n", ret);
255 ASSIGN_SAS_TASK(qc->scsicmd, NULL);
262 local_irq_restore(flags);
266 static bool sas_ata_qc_fill_rtf(struct ata_queued_cmd *qc)
268 struct domain_device *dev = qc->ap->private_data;
270 memcpy(&qc->result_tf, &dev->sata_dev.tf, sizeof(qc->result_tf));
274 static int sas_ata_hard_reset(struct ata_link *link, unsigned int *class,
275 unsigned long deadline)
277 struct ata_port *ap = link->ap;
278 struct domain_device *dev = ap->private_data;
279 struct sas_internal *i =
280 to_sas_internal(dev->port->ha->core.shost->transportt);
281 int res = TMF_RESP_FUNC_FAILED;
284 if (i->dft->lldd_I_T_nexus_reset)
285 res = i->dft->lldd_I_T_nexus_reset(dev);
287 if (res != TMF_RESP_FUNC_COMPLETE) {
288 SAS_DPRINTK("%s: Unable to reset I T nexus?\n", __func__);
292 switch (dev->sata_dev.command_set) {
293 case ATA_COMMAND_SET:
294 SAS_DPRINTK("%s: Found ATA device.\n", __func__);
295 *class = ATA_DEV_ATA;
297 case ATAPI_COMMAND_SET:
298 SAS_DPRINTK("%s: Found ATAPI device.\n", __func__);
299 *class = ATA_DEV_ATAPI;
302 SAS_DPRINTK("%s: Unknown SATA command set: %d.\n",
304 dev->sata_dev.command_set);
305 *class = ATA_DEV_UNKNOWN;
309 ap->cbl = ATA_CBL_SATA;
313 static int sas_ata_soft_reset(struct ata_link *link, unsigned int *class,
314 unsigned long deadline)
316 struct ata_port *ap = link->ap;
317 struct domain_device *dev = ap->private_data;
318 struct sas_internal *i =
319 to_sas_internal(dev->port->ha->core.shost->transportt);
320 int res = TMF_RESP_FUNC_FAILED;
323 if (i->dft->lldd_ata_soft_reset)
324 res = i->dft->lldd_ata_soft_reset(dev);
326 if (res != TMF_RESP_FUNC_COMPLETE) {
327 SAS_DPRINTK("%s: Unable to soft reset\n", __func__);
331 switch (dev->sata_dev.command_set) {
332 case ATA_COMMAND_SET:
333 SAS_DPRINTK("%s: Found ATA device.\n", __func__);
334 *class = ATA_DEV_ATA;
336 case ATAPI_COMMAND_SET:
337 SAS_DPRINTK("%s: Found ATAPI device.\n", __func__);
338 *class = ATA_DEV_ATAPI;
341 SAS_DPRINTK("%s: Unknown SATA command set: %d.\n",
342 __func__, dev->sata_dev.command_set);
343 *class = ATA_DEV_UNKNOWN;
347 ap->cbl = ATA_CBL_SATA;
352 * notify the lldd to forget the sas_task for this internal ata command
353 * that bypasses scsi-eh
355 static void sas_ata_internal_abort(struct sas_task *task)
357 struct sas_internal *si =
358 to_sas_internal(task->dev->port->ha->core.shost->transportt);
362 spin_lock_irqsave(&task->task_state_lock, flags);
363 if (task->task_state_flags & SAS_TASK_STATE_ABORTED ||
364 task->task_state_flags & SAS_TASK_STATE_DONE) {
365 spin_unlock_irqrestore(&task->task_state_lock, flags);
366 SAS_DPRINTK("%s: Task %p already finished.\n", __func__,
370 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
371 spin_unlock_irqrestore(&task->task_state_lock, flags);
373 res = si->dft->lldd_abort_task(task);
375 spin_lock_irqsave(&task->task_state_lock, flags);
376 if (task->task_state_flags & SAS_TASK_STATE_DONE ||
377 res == TMF_RESP_FUNC_COMPLETE) {
378 spin_unlock_irqrestore(&task->task_state_lock, flags);
382 /* XXX we are not prepared to deal with ->lldd_abort_task()
383 * failures. TODO: lldds need to unconditionally forget about
384 * aborted ata tasks, otherwise we (likely) leak the sas task
387 SAS_DPRINTK("%s: Task %p leaked.\n", __func__, task);
389 if (!(task->task_state_flags & SAS_TASK_STATE_DONE))
390 task->task_state_flags &= ~SAS_TASK_STATE_ABORTED;
391 spin_unlock_irqrestore(&task->task_state_lock, flags);
395 list_del_init(&task->list);
399 static void sas_ata_post_internal(struct ata_queued_cmd *qc)
401 if (qc->flags & ATA_QCFLAG_FAILED)
402 qc->err_mask |= AC_ERR_OTHER;
406 * Find the sas_task and kill it. By this point, libata
407 * has decided to kill the qc and has frozen the port.
408 * In this state sas_ata_task_done() will no longer free
409 * the sas_task, so we need to notify the lldd (via
410 * ->lldd_abort_task) that the task is dead and free it
413 struct sas_task *task = qc->lldd_task;
416 qc->lldd_task = NULL;
418 /* Should this be a AT(API) device reset? */
419 spin_lock_irqsave(&task->task_state_lock, flags);
420 task->task_state_flags |= SAS_TASK_NEED_DEV_RESET;
421 spin_unlock_irqrestore(&task->task_state_lock, flags);
423 task->uldd_task = NULL;
424 sas_ata_internal_abort(task);
430 static void sas_ata_set_dmamode(struct ata_port *ap, struct ata_device *ata_dev)
432 struct domain_device *dev = ap->private_data;
433 struct sas_internal *i =
434 to_sas_internal(dev->port->ha->core.shost->transportt);
436 if (i->dft->lldd_ata_set_dmamode)
437 i->dft->lldd_ata_set_dmamode(dev);
440 static struct ata_port_operations sas_sata_ops = {
441 .prereset = ata_std_prereset,
442 .softreset = sas_ata_soft_reset,
443 .hardreset = sas_ata_hard_reset,
444 .postreset = ata_std_postreset,
445 .error_handler = ata_std_error_handler,
446 .post_internal_cmd = sas_ata_post_internal,
447 .qc_defer = ata_std_qc_defer,
448 .qc_prep = ata_noop_qc_prep,
449 .qc_issue = sas_ata_qc_issue,
450 .qc_fill_rtf = sas_ata_qc_fill_rtf,
451 .port_start = ata_sas_port_start,
452 .port_stop = ata_sas_port_stop,
453 .set_dmamode = sas_ata_set_dmamode,
456 static struct ata_port_info sata_port_info = {
457 .flags = ATA_FLAG_SATA | ATA_FLAG_PIO_DMA | ATA_FLAG_NCQ,
458 .pio_mask = ATA_PIO4,
459 .mwdma_mask = ATA_MWDMA2,
460 .udma_mask = ATA_UDMA6,
461 .port_ops = &sas_sata_ops
464 int sas_ata_init_host_and_port(struct domain_device *found_dev,
465 struct scsi_target *starget)
467 struct Scsi_Host *shost = dev_to_shost(&starget->dev);
468 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
471 ata_host_init(&found_dev->sata_dev.ata_host,
473 sata_port_info.flags,
475 ap = ata_sas_port_alloc(&found_dev->sata_dev.ata_host,
479 SAS_DPRINTK("ata_sas_port_alloc failed.\n");
483 ap->private_data = found_dev;
484 ap->cbl = ATA_CBL_SATA;
485 ap->scsi_host = shost;
486 found_dev->sata_dev.ap = ap;
491 void sas_ata_task_abort(struct sas_task *task)
493 struct ata_queued_cmd *qc = task->uldd_task;
494 struct completion *waiting;
496 /* Bounce SCSI-initiated commands to the SCSI EH */
498 struct request_queue *q = qc->scsicmd->device->request_queue;
501 spin_lock_irqsave(q->queue_lock, flags);
502 blk_abort_request(qc->scsicmd->request);
503 spin_unlock_irqrestore(q->queue_lock, flags);
504 scsi_schedule_eh(qc->scsicmd->device->host);
508 /* Internal command, fake a timeout and complete. */
509 qc->flags &= ~ATA_QCFLAG_ACTIVE;
510 qc->flags |= ATA_QCFLAG_FAILED;
511 qc->err_mask |= AC_ERR_TIMEOUT;
512 waiting = qc->private_data;
516 static void sas_get_ata_command_set(struct domain_device *dev)
518 struct dev_to_host_fis *fis =
519 (struct dev_to_host_fis *) dev->frame_rcvd;
521 if ((fis->sector_count == 1 && /* ATA */
527 (fis->sector_count == 0 && /* CE-ATA (mATA) */
531 (fis->device & ~0x10) == 0))
533 dev->sata_dev.command_set = ATA_COMMAND_SET;
535 else if ((fis->interrupt_reason == 1 && /* ATAPI */
537 fis->byte_count_low == 0x14 &&
538 fis->byte_count_high == 0xEB &&
539 (fis->device & ~0x10) == 0))
541 dev->sata_dev.command_set = ATAPI_COMMAND_SET;
543 else if ((fis->sector_count == 1 && /* SEMB */
549 (fis->interrupt_reason == 1 && /* SATA PM */
551 fis->byte_count_low == 0x69 &&
552 fis->byte_count_high == 0x96 &&
553 (fis->device & ~0x10) == 0))
555 /* Treat it as a superset? */
556 dev->sata_dev.command_set = ATAPI_COMMAND_SET;
559 void sas_probe_sata(struct work_struct *work)
561 struct domain_device *dev, *n;
562 struct sas_discovery_event *ev =
563 container_of(work, struct sas_discovery_event, work);
564 struct asd_sas_port *port = ev->port;
566 clear_bit(DISCE_PROBE, &port->disc.pending);
568 list_for_each_entry_safe(dev, n, &port->disco_list, disco_list_node) {
571 spin_lock_irq(&port->dev_list_lock);
572 list_add_tail(&dev->dev_list_node, &port->dev_list);
573 spin_unlock_irq(&port->dev_list_lock);
575 err = sas_rphy_add(dev->rphy);
578 SAS_DPRINTK("%s: for %s device %16llx returned %d\n",
579 __func__, dev->parent ? "exp-attached" :
581 SAS_ADDR(dev->sas_addr), err);
582 sas_unregister_dev(port, dev);
584 list_del_init(&dev->disco_list_node);
589 * sas_discover_sata -- discover an STP/SATA domain device
590 * @dev: pointer to struct domain_device of interest
592 * Devices directly attached to a HA port, have no parents. All other
593 * devices do, and should have their "parent" pointer set appropriately
594 * before calling this function.
596 int sas_discover_sata(struct domain_device *dev)
600 if (dev->dev_type == SATA_PM)
603 sas_get_ata_command_set(dev);
604 sas_fill_in_rphy(dev, dev->rphy);
606 res = sas_notify_lldd_dev_found(dev);
610 sas_discover_event(dev->port, DISCE_PROBE);
614 void sas_ata_strategy_handler(struct Scsi_Host *shost)
616 struct scsi_device *sdev;
617 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
619 /* it's ok to defer revalidation events during ata eh, these
620 * disks are in one of three states:
621 * 1/ present for initial domain discovery, and these
622 * resets will cause bcn flutters
623 * 2/ hot removed, we'll discover that after eh fails
624 * 3/ hot added after initial discovery, lost the race, and need
625 * to catch the next train.
627 sas_disable_revalidation(sas_ha);
629 shost_for_each_device(sdev, shost) {
630 struct domain_device *ddev = sdev_to_domain_dev(sdev);
631 struct ata_port *ap = ddev->sata_dev.ap;
633 if (!dev_is_sata(ddev))
636 ata_port_printk(ap, KERN_DEBUG, "sas eh calling libata port error handler");
637 ata_scsi_port_error_handler(shost, ap);
640 sas_enable_revalidation(sas_ha);
643 int sas_ata_eh(struct Scsi_Host *shost, struct list_head *work_q,
644 struct list_head *done_q)
647 struct scsi_cmnd *cmd, *n;
655 list_for_each_entry_safe(cmd, n, work_q, eh_entry) {
656 struct domain_device *ddev = cmd_to_domain_dev(cmd);
658 if (!dev_is_sata(ddev) || TO_SAS_TASK(cmd))
660 if (ap && ap != ddev->sata_dev.ap)
662 ap = ddev->sata_dev.ap;
664 list_move(&cmd->eh_entry, &sata_q);
667 if (!list_empty(&sata_q)) {
668 ata_port_printk(ap, KERN_DEBUG, "sas eh calling libata cmd error handler\n");
669 ata_scsi_cmd_error_handler(shost, ap, &sata_q);
671 * ata's error handler may leave the cmd on the list
672 * so make sure they don't remain on a stack list
673 * about to go out of scope.
675 * This looks strange, since the commands are
676 * now part of no list, but the next error
677 * action will be ata_port_error_handler()
678 * which takes no list and sweeps them up
679 * anyway from the ata tag array.
681 while (!list_empty(&sata_q))
682 list_del_init(sata_q.next);