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>
26 #include <scsi/sas_ata.h>
27 #include "sas_internal.h"
28 #include <scsi/scsi_host.h>
29 #include <scsi/scsi_device.h>
30 #include <scsi/scsi_tcq.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_transport.h>
33 #include <scsi/scsi_transport_sas.h>
34 #include "../scsi_sas_internal.h"
35 #include "../scsi_transport_api.h"
36 #include <scsi/scsi_eh.h>
38 static enum ata_completion_errors sas_to_ata_err(struct task_status_struct *ts)
40 /* Cheesy attempt to translate SAS errors into ATA. Hah! */
43 if (ts->resp == SAS_TASK_UNDELIVERED)
44 return AC_ERR_ATA_BUS;
46 /* ts->resp == SAS_TASK_COMPLETE */
47 /* task delivered, what happened afterwards? */
49 case SAS_DEV_NO_RESPONSE:
50 return AC_ERR_TIMEOUT;
55 return AC_ERR_ATA_BUS;
58 case SAS_DATA_UNDERRUN:
60 * Some programs that use the taskfile interface
61 * (smartctl in particular) can cause underrun
62 * problems. Ignore these errors, perhaps at our
67 case SAS_DATA_OVERRUN:
69 case SAS_DEVICE_UNKNOWN:
71 return AC_ERR_INVALID;
76 SAS_DPRINTK("%s: Saw error %d. What to do?\n",
77 __FUNCTION__, ts->stat);
80 case SAS_ABORTED_TASK:
83 case SAS_PROTO_RESPONSE:
84 /* This means the ending_fis has the error
85 * value; return 0 here to collect it */
92 static void sas_ata_task_done(struct sas_task *task)
94 struct ata_queued_cmd *qc = task->uldd_task;
95 struct domain_device *dev;
96 struct task_status_struct *stat = &task->task_status;
97 struct ata_task_resp *resp = (struct ata_task_resp *)stat->buf;
98 struct sas_ha_struct *sas_ha;
99 enum ata_completion_errors ac;
103 goto qc_already_gone;
105 dev = qc->ap->private_data;
106 sas_ha = dev->port->ha;
108 spin_lock_irqsave(dev->sata_dev.ap->lock, flags);
109 if (stat->stat == SAS_PROTO_RESPONSE || stat->stat == SAM_GOOD) {
110 ata_tf_from_fis(resp->ending_fis, &dev->sata_dev.tf);
111 qc->err_mask |= ac_err_mask(dev->sata_dev.tf.command);
112 dev->sata_dev.sstatus = resp->sstatus;
113 dev->sata_dev.serror = resp->serror;
114 dev->sata_dev.scontrol = resp->scontrol;
115 } else if (stat->stat != SAM_STAT_GOOD) {
116 ac = sas_to_ata_err(stat);
118 SAS_DPRINTK("%s: SAS error %x\n", __FUNCTION__,
120 /* We saw a SAS error. Send a vague error. */
122 dev->sata_dev.tf.feature = 0x04; /* status err */
123 dev->sata_dev.tf.command = ATA_ERR;
127 qc->lldd_task = NULL;
129 ASSIGN_SAS_TASK(qc->scsicmd, NULL);
131 spin_unlock_irqrestore(dev->sata_dev.ap->lock, flags);
134 * If the sas_task has an ata qc, a scsi_cmnd and the aborted
135 * flag is set, then we must have come in via the libsas EH
136 * functions. When we exit this function, we need to put the
137 * scsi_cmnd on the list of finished errors. The ata_qc_complete
138 * call cleans up the libata side of things but we're protected
139 * from the scsi_cmnd going away because the scsi_cmnd is owned
140 * by the EH, making libata's call to scsi_done a NOP.
142 spin_lock_irqsave(&task->task_state_lock, flags);
143 if (qc->scsicmd && task->task_state_flags & SAS_TASK_STATE_ABORTED)
144 scsi_eh_finish_cmd(qc->scsicmd, &sas_ha->eh_done_q);
145 spin_unlock_irqrestore(&task->task_state_lock, flags);
148 list_del_init(&task->list);
152 static unsigned int sas_ata_qc_issue(struct ata_queued_cmd *qc)
155 struct sas_task *task;
156 struct domain_device *dev = qc->ap->private_data;
157 struct sas_ha_struct *sas_ha = dev->port->ha;
158 struct Scsi_Host *host = sas_ha->core.shost;
159 struct sas_internal *i = to_sas_internal(host->transportt);
160 struct scatterlist *sg;
161 unsigned int xfer = 0;
164 task = sas_alloc_task(GFP_ATOMIC);
166 return AC_ERR_SYSTEM;
168 task->task_proto = SAS_PROTOCOL_STP;
169 task->task_done = sas_ata_task_done;
171 if (qc->tf.command == ATA_CMD_FPDMA_WRITE ||
172 qc->tf.command == ATA_CMD_FPDMA_READ) {
173 /* Need to zero out the tag libata assigned us */
177 ata_tf_to_fis(&qc->tf, 1, 0, (u8*)&task->ata_task.fis);
178 task->uldd_task = qc;
179 if (ata_is_atapi(qc->tf.protocol)) {
180 memcpy(task->ata_task.atapi_packet, qc->cdb, qc->dev->cdb_len);
181 task->total_xfer_len = qc->nbytes + qc->pad_len;
182 task->num_scatter = qc->pad_len ? qc->n_elem + 1 : qc->n_elem;
184 for_each_sg(qc->sg, sg, qc->n_elem, si)
187 task->total_xfer_len = xfer;
188 task->num_scatter = si;
191 task->data_dir = qc->dma_dir;
192 task->scatter = qc->sg;
193 task->ata_task.retry_count = 1;
194 task->task_state_flags = SAS_TASK_STATE_PENDING;
195 qc->lldd_task = task;
197 switch (qc->tf.protocol) {
199 task->ata_task.use_ncq = 1;
203 task->ata_task.dma_xfer = 1;
208 ASSIGN_SAS_TASK(qc->scsicmd, task);
210 if (sas_ha->lldd_max_execute_num < 2)
211 res = i->dft->lldd_execute_task(task, 1, GFP_ATOMIC);
213 res = sas_queue_up(task);
217 SAS_DPRINTK("lldd_execute_task returned: %d\n", res);
220 ASSIGN_SAS_TASK(qc->scsicmd, NULL);
222 return AC_ERR_SYSTEM;
228 static u8 sas_ata_check_status(struct ata_port *ap)
230 struct domain_device *dev = ap->private_data;
231 return dev->sata_dev.tf.command;
234 static void sas_ata_phy_reset(struct ata_port *ap)
236 struct domain_device *dev = ap->private_data;
237 struct sas_internal *i =
238 to_sas_internal(dev->port->ha->core.shost->transportt);
241 if (i->dft->lldd_I_T_nexus_reset)
242 res = i->dft->lldd_I_T_nexus_reset(dev);
245 SAS_DPRINTK("%s: Unable to reset I T nexus?\n", __FUNCTION__);
247 switch (dev->sata_dev.command_set) {
248 case ATA_COMMAND_SET:
249 SAS_DPRINTK("%s: Found ATA device.\n", __FUNCTION__);
250 ap->link.device[0].class = ATA_DEV_ATA;
252 case ATAPI_COMMAND_SET:
253 SAS_DPRINTK("%s: Found ATAPI device.\n", __FUNCTION__);
254 ap->link.device[0].class = ATA_DEV_ATAPI;
257 SAS_DPRINTK("%s: Unknown SATA command set: %d.\n",
259 dev->sata_dev.command_set);
260 ap->link.device[0].class = ATA_DEV_UNKNOWN;
264 ap->cbl = ATA_CBL_SATA;
267 static void sas_ata_post_internal(struct ata_queued_cmd *qc)
269 if (qc->flags & ATA_QCFLAG_FAILED)
270 qc->err_mask |= AC_ERR_OTHER;
274 * Find the sas_task and kill it. By this point,
275 * libata has decided to kill the qc, so we needn't
276 * bother with sas_ata_task_done. But we still
277 * ought to abort the task.
279 struct sas_task *task = qc->lldd_task;
282 qc->lldd_task = NULL;
284 /* Should this be a AT(API) device reset? */
285 spin_lock_irqsave(&task->task_state_lock, flags);
286 task->task_state_flags |= SAS_TASK_NEED_DEV_RESET;
287 spin_unlock_irqrestore(&task->task_state_lock, flags);
289 task->uldd_task = NULL;
290 __sas_task_abort(task);
295 static void sas_ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
297 struct domain_device *dev = ap->private_data;
298 memcpy(tf, &dev->sata_dev.tf, sizeof (*tf));
301 static int sas_ata_scr_write(struct ata_port *ap, unsigned int sc_reg_in,
304 struct domain_device *dev = ap->private_data;
306 SAS_DPRINTK("STUB %s\n", __FUNCTION__);
309 dev->sata_dev.sstatus = val;
312 dev->sata_dev.scontrol = val;
315 dev->sata_dev.serror = val;
318 dev->sata_dev.ap->link.sactive = val;
326 static int sas_ata_scr_read(struct ata_port *ap, unsigned int sc_reg_in,
329 struct domain_device *dev = ap->private_data;
331 SAS_DPRINTK("STUB %s\n", __FUNCTION__);
334 *val = dev->sata_dev.sstatus;
337 *val = dev->sata_dev.scontrol;
340 *val = dev->sata_dev.serror;
343 *val = dev->sata_dev.ap->link.sactive;
350 static struct ata_port_operations sas_sata_ops = {
351 .check_status = sas_ata_check_status,
352 .check_altstatus = sas_ata_check_status,
353 .dev_select = ata_noop_dev_select,
354 .phy_reset = sas_ata_phy_reset,
355 .post_internal_cmd = sas_ata_post_internal,
356 .tf_read = sas_ata_tf_read,
357 .qc_prep = ata_noop_qc_prep,
358 .qc_issue = sas_ata_qc_issue,
359 .port_start = ata_sas_port_start,
360 .port_stop = ata_sas_port_stop,
361 .scr_read = sas_ata_scr_read,
362 .scr_write = sas_ata_scr_write
365 static struct ata_port_info sata_port_info = {
366 .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY | ATA_FLAG_SATA_RESET |
367 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA | ATA_FLAG_NCQ,
368 .pio_mask = 0x1f, /* PIO0-4 */
369 .mwdma_mask = 0x07, /* MWDMA0-2 */
370 .udma_mask = ATA_UDMA6,
371 .port_ops = &sas_sata_ops
374 int sas_ata_init_host_and_port(struct domain_device *found_dev,
375 struct scsi_target *starget)
377 struct Scsi_Host *shost = dev_to_shost(&starget->dev);
378 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
381 ata_host_init(&found_dev->sata_dev.ata_host,
383 sata_port_info.flags,
385 ap = ata_sas_port_alloc(&found_dev->sata_dev.ata_host,
389 SAS_DPRINTK("ata_sas_port_alloc failed.\n");
393 ap->private_data = found_dev;
394 ap->cbl = ATA_CBL_SATA;
395 ap->scsi_host = shost;
396 found_dev->sata_dev.ap = ap;
401 void sas_ata_task_abort(struct sas_task *task)
403 struct ata_queued_cmd *qc = task->uldd_task;
404 struct completion *waiting;
406 /* Bounce SCSI-initiated commands to the SCSI EH */
408 scsi_req_abort_cmd(qc->scsicmd);
409 scsi_schedule_eh(qc->scsicmd->device->host);
413 /* Internal command, fake a timeout and complete. */
414 qc->flags &= ~ATA_QCFLAG_ACTIVE;
415 qc->flags |= ATA_QCFLAG_FAILED;
416 qc->err_mask |= AC_ERR_TIMEOUT;
417 waiting = qc->private_data;
421 static void sas_task_timedout(unsigned long _task)
423 struct sas_task *task = (void *) _task;
426 spin_lock_irqsave(&task->task_state_lock, flags);
427 if (!(task->task_state_flags & SAS_TASK_STATE_DONE))
428 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
429 spin_unlock_irqrestore(&task->task_state_lock, flags);
431 complete(&task->completion);
434 static void sas_disc_task_done(struct sas_task *task)
436 if (!del_timer(&task->timer))
438 complete(&task->completion);
441 #define SAS_DEV_TIMEOUT 10
444 * sas_execute_task -- Basic task processing for discovery
445 * @task: the task to be executed
446 * @buffer: pointer to buffer to do I/O
447 * @size: size of @buffer
448 * @dma_dir: DMA direction. DMA_xxx
450 static int sas_execute_task(struct sas_task *task, void *buffer, int size,
451 enum dma_data_direction dma_dir)
454 struct scatterlist *scatter = NULL;
455 struct task_status_struct *ts = &task->task_status;
458 struct sas_internal *i =
459 to_sas_internal(task->dev->port->ha->core.shost->transportt);
461 if (dma_dir != DMA_NONE) {
462 scatter = kzalloc(sizeof(*scatter), GFP_KERNEL);
466 sg_init_one(scatter, buffer, size);
470 task->task_proto = task->dev->tproto;
471 task->scatter = scatter;
472 task->num_scatter = num_scatter;
473 task->total_xfer_len = size;
474 task->data_dir = dma_dir;
475 task->task_done = sas_disc_task_done;
476 if (dma_dir != DMA_NONE &&
477 sas_protocol_ata(task->task_proto)) {
478 task->num_scatter = dma_map_sg(task->dev->port->ha->dev,
484 for (retries = 0; retries < 5; retries++) {
485 task->task_state_flags = SAS_TASK_STATE_PENDING;
486 init_completion(&task->completion);
488 task->timer.data = (unsigned long) task;
489 task->timer.function = sas_task_timedout;
490 task->timer.expires = jiffies + SAS_DEV_TIMEOUT*HZ;
491 add_timer(&task->timer);
493 res = i->dft->lldd_execute_task(task, 1, GFP_KERNEL);
495 del_timer(&task->timer);
496 SAS_DPRINTK("executing SAS discovery task failed:%d\n",
500 wait_for_completion(&task->completion);
502 if (task->task_state_flags & SAS_TASK_STATE_ABORTED) {
504 SAS_DPRINTK("task aborted, flags:0x%x\n",
505 task->task_state_flags);
506 res2 = i->dft->lldd_abort_task(task);
507 SAS_DPRINTK("came back from abort task\n");
508 if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
509 if (res2 == TMF_RESP_FUNC_COMPLETE)
510 continue; /* Retry the task */
515 if (task->task_status.stat == SAM_BUSY ||
516 task->task_status.stat == SAM_TASK_SET_FULL ||
517 task->task_status.stat == SAS_QUEUE_FULL) {
518 SAS_DPRINTK("task: q busy, sleeping...\n");
519 schedule_timeout_interruptible(HZ);
520 } else if (task->task_status.stat == SAM_CHECK_COND) {
521 struct scsi_sense_hdr shdr;
523 if (!scsi_normalize_sense(ts->buf, ts->buf_valid_size,
525 SAS_DPRINTK("couldn't normalize sense\n");
528 if ((shdr.sense_key == 6 && shdr.asc == 0x29) ||
529 (shdr.sense_key == 2 && shdr.asc == 4 &&
531 SAS_DPRINTK("device %016llx LUN: %016llx "
532 "powering up or not ready yet, "
534 SAS_ADDR(task->dev->sas_addr),
535 SAS_ADDR(task->ssp_task.LUN));
537 schedule_timeout_interruptible(5*HZ);
538 } else if (shdr.sense_key == 1) {
541 } else if (shdr.sense_key == 5) {
544 SAS_DPRINTK("dev %016llx LUN: %016llx "
545 "sense key:0x%x ASC:0x%x ASCQ:0x%x"
547 SAS_ADDR(task->dev->sas_addr),
548 SAS_ADDR(task->ssp_task.LUN),
550 shdr.asc, shdr.ascq);
552 } else if (task->task_status.resp != SAS_TASK_COMPLETE ||
553 task->task_status.stat != SAM_GOOD) {
554 SAS_DPRINTK("task finished with resp:0x%x, "
556 task->task_status.resp,
557 task->task_status.stat);
565 if (dma_dir != DMA_NONE) {
566 if (sas_protocol_ata(task->task_proto))
567 dma_unmap_sg(task->dev->port->ha->dev,
568 task->scatter, task->num_scatter,
576 /* ---------- SATA ---------- */
578 static void sas_get_ata_command_set(struct domain_device *dev)
580 struct dev_to_host_fis *fis =
581 (struct dev_to_host_fis *) dev->frame_rcvd;
583 if ((fis->sector_count == 1 && /* ATA */
589 (fis->sector_count == 0 && /* CE-ATA (mATA) */
593 (fis->device & ~0x10) == 0))
595 dev->sata_dev.command_set = ATA_COMMAND_SET;
597 else if ((fis->interrupt_reason == 1 && /* ATAPI */
599 fis->byte_count_low == 0x14 &&
600 fis->byte_count_high == 0xEB &&
601 (fis->device & ~0x10) == 0))
603 dev->sata_dev.command_set = ATAPI_COMMAND_SET;
605 else if ((fis->sector_count == 1 && /* SEMB */
611 (fis->interrupt_reason == 1 && /* SATA PM */
613 fis->byte_count_low == 0x69 &&
614 fis->byte_count_high == 0x96 &&
615 (fis->device & ~0x10) == 0))
617 /* Treat it as a superset? */
618 dev->sata_dev.command_set = ATAPI_COMMAND_SET;
622 * sas_issue_ata_cmd -- Basic SATA command processing for discovery
623 * @dev: the device to send the command to
624 * @command: the command register
625 * @features: the features register
626 * @buffer: pointer to buffer to do I/O
627 * @size: size of @buffer
628 * @dma_dir: DMA direction. DMA_xxx
630 static int sas_issue_ata_cmd(struct domain_device *dev, u8 command,
631 u8 features, void *buffer, int size,
632 enum dma_data_direction dma_dir)
635 struct sas_task *task;
636 struct dev_to_host_fis *d2h_fis = (struct dev_to_host_fis *)
640 task = sas_alloc_task(GFP_KERNEL);
646 task->ata_task.fis.fis_type = 0x27;
647 task->ata_task.fis.command = command;
648 task->ata_task.fis.features = features;
649 task->ata_task.fis.device = d2h_fis->device;
650 task->ata_task.retry_count = 1;
652 res = sas_execute_task(task, buffer, size, dma_dir);
659 static void sas_sata_propagate_sas_addr(struct domain_device *dev)
662 struct asd_sas_port *port = dev->port;
663 struct asd_sas_phy *phy;
667 memcpy(port->attached_sas_addr, dev->sas_addr, SAS_ADDR_SIZE);
668 spin_lock_irqsave(&port->phy_list_lock, flags);
669 list_for_each_entry(phy, &port->phy_list, port_phy_el)
670 memcpy(phy->attached_sas_addr, dev->sas_addr, SAS_ADDR_SIZE);
671 spin_unlock_irqrestore(&port->phy_list_lock, flags);
674 #define ATA_IDENTIFY_DEV 0xEC
675 #define ATA_IDENTIFY_PACKET_DEV 0xA1
676 #define ATA_SET_FEATURES 0xEF
677 #define ATA_FEATURE_PUP_STBY_SPIN_UP 0x07
680 * sas_discover_sata_dev -- discover a STP/SATA device (SATA_DEV)
681 * @dev: STP/SATA device of interest (ATA/ATAPI)
683 * The LLDD has already been notified of this device, so that we can
684 * send FISes to it. Here we try to get IDENTIFY DEVICE or IDENTIFY
685 * PACKET DEVICE, if ATAPI device, so that the LLDD can fine-tune its
686 * performance for this device.
688 static int sas_discover_sata_dev(struct domain_device *dev)
694 identify_x = kzalloc(512, GFP_KERNEL);
698 if (dev->sata_dev.command_set == ATA_COMMAND_SET) {
699 dev->sata_dev.identify_device = identify_x;
700 command = ATA_IDENTIFY_DEV;
702 dev->sata_dev.identify_packet_device = identify_x;
703 command = ATA_IDENTIFY_PACKET_DEV;
706 res = sas_issue_ata_cmd(dev, command, 0, identify_x, 512,
711 /* lives on the media? */
712 if (le16_to_cpu(identify_x[0]) & 4) {
713 /* incomplete response */
714 SAS_DPRINTK("sending SET FEATURE/PUP_STBY_SPIN_UP to "
715 "dev %llx\n", SAS_ADDR(dev->sas_addr));
716 if (!le16_to_cpu(identify_x[83] & (1<<6)))
718 res = sas_issue_ata_cmd(dev, ATA_SET_FEATURES,
719 ATA_FEATURE_PUP_STBY_SPIN_UP,
724 schedule_timeout_interruptible(5*HZ); /* More time? */
725 res = sas_issue_ata_cmd(dev, command, 0, identify_x, 512,
732 if (dev->port->oob_mode != SATA_OOB_MODE) {
733 memcpy(dev->sas_addr, dev->sata_dev.rps_resp.rps.stp_sas_addr,
735 } else if (dev->sata_dev.command_set == ATA_COMMAND_SET &&
736 (le16_to_cpu(dev->sata_dev.identify_device[108]) & 0xF000)
740 for (i = 0; i < 4; i++) {
742 (le16_to_cpu(dev->sata_dev.identify_device[108+i]) & 0xFF00) >> 8;
743 dev->sas_addr[2*i+1] =
744 le16_to_cpu(dev->sata_dev.identify_device[108+i]) & 0x00FF;
747 sas_hash_addr(dev->hashed_sas_addr, dev->sas_addr);
749 sas_sata_propagate_sas_addr(dev);
751 /* XXX Hint: register this SATA device with SATL.
752 When this returns, dev->sata_dev->lu is alive and
754 sas_satl_register_dev(dev);
757 sas_fill_in_rphy(dev, dev->rphy);
761 dev->sata_dev.identify_packet_device = NULL;
762 dev->sata_dev.identify_device = NULL;
767 static int sas_discover_sata_pm(struct domain_device *dev)
773 * sas_discover_sata -- discover an STP/SATA domain device
774 * @dev: pointer to struct domain_device of interest
776 * First we notify the LLDD of this device, so we can send frames to
777 * it. Then depending on the type of device we call the appropriate
778 * discover functions. Once device discover is done, we notify the
779 * LLDD so that it can fine-tune its parameters for the device, by
780 * removing it and then adding it. That is, the second time around,
781 * the driver would have certain fields, that it is looking at, set.
782 * Finally we initialize the kobj so that the device can be added to
783 * the system at registration time. Devices directly attached to a HA
784 * port, have no parents. All other devices do, and should have their
785 * "parent" pointer set appropriately before calling this function.
787 int sas_discover_sata(struct domain_device *dev)
791 sas_get_ata_command_set(dev);
793 res = sas_notify_lldd_dev_found(dev);
797 switch (dev->dev_type) {
799 res = sas_discover_sata_dev(dev);
802 res = sas_discover_sata_pm(dev);
807 sas_notify_lldd_dev_gone(dev);
809 sas_notify_lldd_dev_found(dev);
810 res = sas_rphy_add(dev->rphy);