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",
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", __func__
,
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
;
182 task
->num_scatter
= 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 bool sas_ata_qc_fill_rtf(struct ata_queued_cmd
*qc
)
230 struct domain_device
*dev
= qc
->ap
->private_data
;
232 memcpy(&qc
->result_tf
, &dev
->sata_dev
.tf
, sizeof(qc
->result_tf
));
236 static void sas_ata_phy_reset(struct ata_port
*ap
)
238 struct domain_device
*dev
= ap
->private_data
;
239 struct sas_internal
*i
=
240 to_sas_internal(dev
->port
->ha
->core
.shost
->transportt
);
241 int res
= TMF_RESP_FUNC_FAILED
;
243 if (i
->dft
->lldd_I_T_nexus_reset
)
244 res
= i
->dft
->lldd_I_T_nexus_reset(dev
);
246 if (res
!= TMF_RESP_FUNC_COMPLETE
)
247 SAS_DPRINTK("%s: Unable to reset I T nexus?\n", __func__
);
249 switch (dev
->sata_dev
.command_set
) {
250 case ATA_COMMAND_SET
:
251 SAS_DPRINTK("%s: Found ATA device.\n", __func__
);
252 ap
->link
.device
[0].class = ATA_DEV_ATA
;
254 case ATAPI_COMMAND_SET
:
255 SAS_DPRINTK("%s: Found ATAPI device.\n", __func__
);
256 ap
->link
.device
[0].class = ATA_DEV_ATAPI
;
259 SAS_DPRINTK("%s: Unknown SATA command set: %d.\n",
261 dev
->sata_dev
.command_set
);
262 ap
->link
.device
[0].class = ATA_DEV_UNKNOWN
;
266 ap
->cbl
= ATA_CBL_SATA
;
269 static void sas_ata_post_internal(struct ata_queued_cmd
*qc
)
271 if (qc
->flags
& ATA_QCFLAG_FAILED
)
272 qc
->err_mask
|= AC_ERR_OTHER
;
276 * Find the sas_task and kill it. By this point,
277 * libata has decided to kill the qc, so we needn't
278 * bother with sas_ata_task_done. But we still
279 * ought to abort the task.
281 struct sas_task
*task
= qc
->lldd_task
;
284 qc
->lldd_task
= NULL
;
286 /* Should this be a AT(API) device reset? */
287 spin_lock_irqsave(&task
->task_state_lock
, flags
);
288 task
->task_state_flags
|= SAS_TASK_NEED_DEV_RESET
;
289 spin_unlock_irqrestore(&task
->task_state_lock
, flags
);
291 task
->uldd_task
= NULL
;
292 __sas_task_abort(task
);
297 static int sas_ata_scr_write(struct ata_link
*link
, unsigned int sc_reg_in
,
300 struct domain_device
*dev
= link
->ap
->private_data
;
302 SAS_DPRINTK("STUB %s\n", __func__
);
305 dev
->sata_dev
.sstatus
= val
;
308 dev
->sata_dev
.scontrol
= val
;
311 dev
->sata_dev
.serror
= val
;
314 dev
->sata_dev
.ap
->link
.sactive
= val
;
322 static int sas_ata_scr_read(struct ata_link
*link
, unsigned int sc_reg_in
,
325 struct domain_device
*dev
= link
->ap
->private_data
;
327 SAS_DPRINTK("STUB %s\n", __func__
);
330 *val
= dev
->sata_dev
.sstatus
;
333 *val
= dev
->sata_dev
.scontrol
;
336 *val
= dev
->sata_dev
.serror
;
339 *val
= dev
->sata_dev
.ap
->link
.sactive
;
346 static struct ata_port_operations sas_sata_ops
= {
347 .phy_reset
= sas_ata_phy_reset
,
348 .post_internal_cmd
= sas_ata_post_internal
,
349 .qc_prep
= ata_noop_qc_prep
,
350 .qc_issue
= sas_ata_qc_issue
,
351 .qc_fill_rtf
= sas_ata_qc_fill_rtf
,
352 .port_start
= ata_sas_port_start
,
353 .port_stop
= ata_sas_port_stop
,
354 .scr_read
= sas_ata_scr_read
,
355 .scr_write
= sas_ata_scr_write
358 static struct ata_port_info sata_port_info
= {
359 .flags
= ATA_FLAG_SATA
| ATA_FLAG_NO_LEGACY
| ATA_FLAG_SATA_RESET
|
360 ATA_FLAG_MMIO
| ATA_FLAG_PIO_DMA
| ATA_FLAG_NCQ
,
361 .pio_mask
= 0x1f, /* PIO0-4 */
362 .mwdma_mask
= 0x07, /* MWDMA0-2 */
363 .udma_mask
= ATA_UDMA6
,
364 .port_ops
= &sas_sata_ops
367 int sas_ata_init_host_and_port(struct domain_device
*found_dev
,
368 struct scsi_target
*starget
)
370 struct Scsi_Host
*shost
= dev_to_shost(&starget
->dev
);
371 struct sas_ha_struct
*ha
= SHOST_TO_SAS_HA(shost
);
374 ata_host_init(&found_dev
->sata_dev
.ata_host
,
376 sata_port_info
.flags
,
378 ap
= ata_sas_port_alloc(&found_dev
->sata_dev
.ata_host
,
382 SAS_DPRINTK("ata_sas_port_alloc failed.\n");
386 ap
->private_data
= found_dev
;
387 ap
->cbl
= ATA_CBL_SATA
;
388 ap
->scsi_host
= shost
;
389 found_dev
->sata_dev
.ap
= ap
;
394 void sas_ata_task_abort(struct sas_task
*task
)
396 struct ata_queued_cmd
*qc
= task
->uldd_task
;
397 struct completion
*waiting
;
399 /* Bounce SCSI-initiated commands to the SCSI EH */
401 blk_abort_request(qc
->scsicmd
->request
);
402 scsi_schedule_eh(qc
->scsicmd
->device
->host
);
406 /* Internal command, fake a timeout and complete. */
407 qc
->flags
&= ~ATA_QCFLAG_ACTIVE
;
408 qc
->flags
|= ATA_QCFLAG_FAILED
;
409 qc
->err_mask
|= AC_ERR_TIMEOUT
;
410 waiting
= qc
->private_data
;
414 static void sas_task_timedout(unsigned long _task
)
416 struct sas_task
*task
= (void *) _task
;
419 spin_lock_irqsave(&task
->task_state_lock
, flags
);
420 if (!(task
->task_state_flags
& SAS_TASK_STATE_DONE
))
421 task
->task_state_flags
|= SAS_TASK_STATE_ABORTED
;
422 spin_unlock_irqrestore(&task
->task_state_lock
, flags
);
424 complete(&task
->completion
);
427 static void sas_disc_task_done(struct sas_task
*task
)
429 if (!del_timer(&task
->timer
))
431 complete(&task
->completion
);
434 #define SAS_DEV_TIMEOUT 10
437 * sas_execute_task -- Basic task processing for discovery
438 * @task: the task to be executed
439 * @buffer: pointer to buffer to do I/O
440 * @size: size of @buffer
441 * @dma_dir: DMA direction. DMA_xxx
443 static int sas_execute_task(struct sas_task
*task
, void *buffer
, int size
,
444 enum dma_data_direction dma_dir
)
447 struct scatterlist
*scatter
= NULL
;
448 struct task_status_struct
*ts
= &task
->task_status
;
451 struct sas_internal
*i
=
452 to_sas_internal(task
->dev
->port
->ha
->core
.shost
->transportt
);
454 if (dma_dir
!= DMA_NONE
) {
455 scatter
= kzalloc(sizeof(*scatter
), GFP_KERNEL
);
459 sg_init_one(scatter
, buffer
, size
);
463 task
->task_proto
= task
->dev
->tproto
;
464 task
->scatter
= scatter
;
465 task
->num_scatter
= num_scatter
;
466 task
->total_xfer_len
= size
;
467 task
->data_dir
= dma_dir
;
468 task
->task_done
= sas_disc_task_done
;
469 if (dma_dir
!= DMA_NONE
&&
470 sas_protocol_ata(task
->task_proto
)) {
471 task
->num_scatter
= dma_map_sg(task
->dev
->port
->ha
->dev
,
477 for (retries
= 0; retries
< 5; retries
++) {
478 task
->task_state_flags
= SAS_TASK_STATE_PENDING
;
479 init_completion(&task
->completion
);
481 task
->timer
.data
= (unsigned long) task
;
482 task
->timer
.function
= sas_task_timedout
;
483 task
->timer
.expires
= jiffies
+ SAS_DEV_TIMEOUT
*HZ
;
484 add_timer(&task
->timer
);
486 res
= i
->dft
->lldd_execute_task(task
, 1, GFP_KERNEL
);
488 del_timer(&task
->timer
);
489 SAS_DPRINTK("executing SAS discovery task failed:%d\n",
493 wait_for_completion(&task
->completion
);
495 if (task
->task_state_flags
& SAS_TASK_STATE_ABORTED
) {
497 SAS_DPRINTK("task aborted, flags:0x%x\n",
498 task
->task_state_flags
);
499 res2
= i
->dft
->lldd_abort_task(task
);
500 SAS_DPRINTK("came back from abort task\n");
501 if (!(task
->task_state_flags
& SAS_TASK_STATE_DONE
)) {
502 if (res2
== TMF_RESP_FUNC_COMPLETE
)
503 continue; /* Retry the task */
508 if (task
->task_status
.stat
== SAM_BUSY
||
509 task
->task_status
.stat
== SAM_TASK_SET_FULL
||
510 task
->task_status
.stat
== SAS_QUEUE_FULL
) {
511 SAS_DPRINTK("task: q busy, sleeping...\n");
512 schedule_timeout_interruptible(HZ
);
513 } else if (task
->task_status
.stat
== SAM_CHECK_COND
) {
514 struct scsi_sense_hdr shdr
;
516 if (!scsi_normalize_sense(ts
->buf
, ts
->buf_valid_size
,
518 SAS_DPRINTK("couldn't normalize sense\n");
521 if ((shdr
.sense_key
== 6 && shdr
.asc
== 0x29) ||
522 (shdr
.sense_key
== 2 && shdr
.asc
== 4 &&
524 SAS_DPRINTK("device %016llx LUN: %016llx "
525 "powering up or not ready yet, "
527 SAS_ADDR(task
->dev
->sas_addr
),
528 SAS_ADDR(task
->ssp_task
.LUN
));
530 schedule_timeout_interruptible(5*HZ
);
531 } else if (shdr
.sense_key
== 1) {
534 } else if (shdr
.sense_key
== 5) {
537 SAS_DPRINTK("dev %016llx LUN: %016llx "
538 "sense key:0x%x ASC:0x%x ASCQ:0x%x"
540 SAS_ADDR(task
->dev
->sas_addr
),
541 SAS_ADDR(task
->ssp_task
.LUN
),
543 shdr
.asc
, shdr
.ascq
);
545 } else if (task
->task_status
.resp
!= SAS_TASK_COMPLETE
||
546 task
->task_status
.stat
!= SAM_GOOD
) {
547 SAS_DPRINTK("task finished with resp:0x%x, "
549 task
->task_status
.resp
,
550 task
->task_status
.stat
);
558 if (dma_dir
!= DMA_NONE
) {
559 if (sas_protocol_ata(task
->task_proto
))
560 dma_unmap_sg(task
->dev
->port
->ha
->dev
,
561 task
->scatter
, task
->num_scatter
,
569 /* ---------- SATA ---------- */
571 static void sas_get_ata_command_set(struct domain_device
*dev
)
573 struct dev_to_host_fis
*fis
=
574 (struct dev_to_host_fis
*) dev
->frame_rcvd
;
576 if ((fis
->sector_count
== 1 && /* ATA */
582 (fis
->sector_count
== 0 && /* CE-ATA (mATA) */
586 (fis
->device
& ~0x10) == 0))
588 dev
->sata_dev
.command_set
= ATA_COMMAND_SET
;
590 else if ((fis
->interrupt_reason
== 1 && /* ATAPI */
592 fis
->byte_count_low
== 0x14 &&
593 fis
->byte_count_high
== 0xEB &&
594 (fis
->device
& ~0x10) == 0))
596 dev
->sata_dev
.command_set
= ATAPI_COMMAND_SET
;
598 else if ((fis
->sector_count
== 1 && /* SEMB */
604 (fis
->interrupt_reason
== 1 && /* SATA PM */
606 fis
->byte_count_low
== 0x69 &&
607 fis
->byte_count_high
== 0x96 &&
608 (fis
->device
& ~0x10) == 0))
610 /* Treat it as a superset? */
611 dev
->sata_dev
.command_set
= ATAPI_COMMAND_SET
;
615 * sas_issue_ata_cmd -- Basic SATA command processing for discovery
616 * @dev: the device to send the command to
617 * @command: the command register
618 * @features: the features register
619 * @buffer: pointer to buffer to do I/O
620 * @size: size of @buffer
621 * @dma_dir: DMA direction. DMA_xxx
623 static int sas_issue_ata_cmd(struct domain_device
*dev
, u8 command
,
624 u8 features
, void *buffer
, int size
,
625 enum dma_data_direction dma_dir
)
628 struct sas_task
*task
;
629 struct dev_to_host_fis
*d2h_fis
= (struct dev_to_host_fis
*)
633 task
= sas_alloc_task(GFP_KERNEL
);
639 task
->ata_task
.fis
.fis_type
= 0x27;
640 task
->ata_task
.fis
.command
= command
;
641 task
->ata_task
.fis
.features
= features
;
642 task
->ata_task
.fis
.device
= d2h_fis
->device
;
643 task
->ata_task
.retry_count
= 1;
645 res
= sas_execute_task(task
, buffer
, size
, dma_dir
);
652 #define ATA_IDENTIFY_DEV 0xEC
653 #define ATA_IDENTIFY_PACKET_DEV 0xA1
654 #define ATA_SET_FEATURES 0xEF
655 #define ATA_FEATURE_PUP_STBY_SPIN_UP 0x07
658 * sas_discover_sata_dev -- discover a STP/SATA device (SATA_DEV)
659 * @dev: STP/SATA device of interest (ATA/ATAPI)
661 * The LLDD has already been notified of this device, so that we can
662 * send FISes to it. Here we try to get IDENTIFY DEVICE or IDENTIFY
663 * PACKET DEVICE, if ATAPI device, so that the LLDD can fine-tune its
664 * performance for this device.
666 static int sas_discover_sata_dev(struct domain_device
*dev
)
672 identify_x
= kzalloc(512, GFP_KERNEL
);
676 if (dev
->sata_dev
.command_set
== ATA_COMMAND_SET
) {
677 dev
->sata_dev
.identify_device
= identify_x
;
678 command
= ATA_IDENTIFY_DEV
;
680 dev
->sata_dev
.identify_packet_device
= identify_x
;
681 command
= ATA_IDENTIFY_PACKET_DEV
;
684 res
= sas_issue_ata_cmd(dev
, command
, 0, identify_x
, 512,
689 /* lives on the media? */
690 if (le16_to_cpu(identify_x
[0]) & 4) {
691 /* incomplete response */
692 SAS_DPRINTK("sending SET FEATURE/PUP_STBY_SPIN_UP to "
693 "dev %llx\n", SAS_ADDR(dev
->sas_addr
));
694 if (!(identify_x
[83] & cpu_to_le16(1<<6)))
696 res
= sas_issue_ata_cmd(dev
, ATA_SET_FEATURES
,
697 ATA_FEATURE_PUP_STBY_SPIN_UP
,
702 schedule_timeout_interruptible(5*HZ
); /* More time? */
703 res
= sas_issue_ata_cmd(dev
, command
, 0, identify_x
, 512,
709 /* XXX Hint: register this SATA device with SATL.
710 When this returns, dev->sata_dev->lu is alive and
712 sas_satl_register_dev(dev);
715 sas_fill_in_rphy(dev
, dev
->rphy
);
719 dev
->sata_dev
.identify_packet_device
= NULL
;
720 dev
->sata_dev
.identify_device
= NULL
;
725 static int sas_discover_sata_pm(struct domain_device
*dev
)
731 * sas_discover_sata -- discover an STP/SATA domain device
732 * @dev: pointer to struct domain_device of interest
734 * First we notify the LLDD of this device, so we can send frames to
735 * it. Then depending on the type of device we call the appropriate
736 * discover functions. Once device discover is done, we notify the
737 * LLDD so that it can fine-tune its parameters for the device, by
738 * removing it and then adding it. That is, the second time around,
739 * the driver would have certain fields, that it is looking at, set.
740 * Finally we initialize the kobj so that the device can be added to
741 * the system at registration time. Devices directly attached to a HA
742 * port, have no parents. All other devices do, and should have their
743 * "parent" pointer set appropriately before calling this function.
745 int sas_discover_sata(struct domain_device
*dev
)
749 sas_get_ata_command_set(dev
);
751 res
= sas_notify_lldd_dev_found(dev
);
755 switch (dev
->dev_type
) {
757 res
= sas_discover_sata_dev(dev
);
760 res
= sas_discover_sata_pm(dev
);
765 sas_notify_lldd_dev_gone(dev
);
767 sas_notify_lldd_dev_found(dev
);
768 res
= sas_rphy_add(dev
->rphy
);