2 * Serial Attached SCSI (SAS) class SCSI Host glue.
4 * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
5 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
7 * This file is licensed under GPLv2.
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License as
11 * published by the Free Software Foundation; either version 2 of the
12 * License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
26 #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_eh.h>
33 #include <scsi/scsi_transport.h>
34 #include <scsi/scsi_transport_sas.h>
35 #include "../scsi_sas_internal.h"
37 #include <linux/err.h>
38 #include <linux/blkdev.h>
39 #include <linux/scatterlist.h>
41 /* ---------- SCSI Host glue ---------- */
43 #define TO_SAS_TASK(_scsi_cmd) ((void *)(_scsi_cmd)->host_scribble)
44 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
46 static void sas_scsi_task_done(struct sas_task *task)
48 struct task_status_struct *ts = &task->task_status;
49 struct scsi_cmnd *sc = task->uldd_task;
50 struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(sc->device->host);
51 unsigned ts_flags = task->task_state_flags;
55 SAS_DPRINTK("task_done called with non existing SCSI cmnd!\n");
56 list_del_init(&task->list);
61 if (ts->resp == SAS_TASK_UNDELIVERED) {
64 } else { /* ts->resp == SAS_TASK_COMPLETE */
65 /* task delivered, what happened afterwards? */
67 case SAS_DEV_NO_RESPONSE:
74 case SAS_DATA_UNDERRUN:
75 sc->resid = ts->residual;
76 if (sc->request_bufflen - sc->resid < sc->underflow)
79 case SAS_DATA_OVERRUN:
83 hs = DID_SOFT_ERROR; /* retry */
85 case SAS_DEVICE_UNKNOWN:
92 if (ts->open_rej_reason == SAS_OREJ_RSVD_RETRY)
93 hs = DID_SOFT_ERROR; /* retry */
97 case SAS_PROTO_RESPONSE:
98 SAS_DPRINTK("LLDD:%s sent SAS_PROTO_RESP for an SSP "
99 "task; please report this\n",
100 task->dev->port->ha->sas_ha_name);
102 case SAS_ABORTED_TASK:
106 memcpy(sc->sense_buffer, ts->buf,
107 max(SCSI_SENSE_BUFFERSIZE, ts->buf_valid_size));
108 stat = SAM_CHECK_COND;
115 ASSIGN_SAS_TASK(sc, NULL);
116 sc->result = (hs << 16) | stat;
117 list_del_init(&task->list);
119 /* This is very ugly but this is how SCSI Core works. */
120 if (ts_flags & SAS_TASK_STATE_ABORTED)
121 scsi_eh_finish_cmd(sc, &sas_ha->eh_done_q);
126 static enum task_attribute sas_scsi_get_task_attr(struct scsi_cmnd *cmd)
128 enum task_attribute ta = TASK_ATTR_SIMPLE;
129 if (cmd->request && blk_rq_tagged(cmd->request)) {
130 if (cmd->device->ordered_tags &&
131 (cmd->request->cmd_flags & REQ_HARDBARRIER))
137 static struct sas_task *sas_create_task(struct scsi_cmnd *cmd,
138 struct domain_device *dev,
141 struct sas_task *task = sas_alloc_task(gfp_flags);
147 *(u32 *)cmd->sense_buffer = 0;
148 task->uldd_task = cmd;
149 ASSIGN_SAS_TASK(cmd, task);
152 task->task_proto = task->dev->tproto; /* BUG_ON(!SSP) */
154 task->ssp_task.retry_count = 1;
155 int_to_scsilun(cmd->device->lun, &lun);
156 memcpy(task->ssp_task.LUN, &lun.scsi_lun, 8);
157 task->ssp_task.task_attr = sas_scsi_get_task_attr(cmd);
158 memcpy(task->ssp_task.cdb, cmd->cmnd, 16);
160 task->scatter = cmd->request_buffer;
161 task->num_scatter = cmd->use_sg;
162 task->total_xfer_len = cmd->request_bufflen;
163 task->data_dir = cmd->sc_data_direction;
165 task->task_done = sas_scsi_task_done;
170 static int sas_queue_up(struct sas_task *task)
172 struct sas_ha_struct *sas_ha = task->dev->port->ha;
173 struct scsi_core *core = &sas_ha->core;
177 spin_lock_irqsave(&core->task_queue_lock, flags);
178 if (sas_ha->lldd_queue_size < core->task_queue_size + 1) {
179 spin_unlock_irqrestore(&core->task_queue_lock, flags);
180 return -SAS_QUEUE_FULL;
182 list_add_tail(&task->list, &core->task_queue);
183 core->task_queue_size += 1;
184 spin_unlock_irqrestore(&core->task_queue_lock, flags);
185 up(&core->queue_thread_sema);
191 * sas_queuecommand -- Enqueue a command for processing
192 * @parameters: See SCSI Core documentation
194 * Note: XXX: Remove the host unlock/lock pair when SCSI Core can
195 * call us without holding an IRQ spinlock...
197 int sas_queuecommand(struct scsi_cmnd *cmd,
198 void (*scsi_done)(struct scsi_cmnd *))
201 struct domain_device *dev = cmd_to_domain_dev(cmd);
202 struct Scsi_Host *host = cmd->device->host;
203 struct sas_internal *i = to_sas_internal(host->transportt);
205 spin_unlock_irq(host->host_lock);
208 struct sas_ha_struct *sas_ha = dev->port->ha;
209 struct sas_task *task;
212 task = sas_create_task(cmd, dev, GFP_ATOMIC);
216 cmd->scsi_done = scsi_done;
217 /* Queue up, Direct Mode or Task Collector Mode. */
218 if (sas_ha->lldd_max_execute_num < 2)
219 res = i->dft->lldd_execute_task(task, 1, GFP_ATOMIC);
221 res = sas_queue_up(task);
225 SAS_DPRINTK("lldd_execute_task returned: %d\n", res);
226 ASSIGN_SAS_TASK(cmd, NULL);
228 if (res == -SAS_QUEUE_FULL) {
229 cmd->result = DID_SOFT_ERROR << 16; /* retry */
237 spin_lock_irq(host->host_lock);
241 static void sas_scsi_clear_queue_lu(struct list_head *error_q, struct scsi_cmnd *my_cmd)
243 struct scsi_cmnd *cmd, *n;
245 list_for_each_entry_safe(cmd, n, error_q, eh_entry) {
247 list_del_init(&cmd->eh_entry);
251 static void sas_scsi_clear_queue_I_T(struct list_head *error_q,
252 struct domain_device *dev)
254 struct scsi_cmnd *cmd, *n;
256 list_for_each_entry_safe(cmd, n, error_q, eh_entry) {
257 struct domain_device *x = cmd_to_domain_dev(cmd);
260 list_del_init(&cmd->eh_entry);
264 static void sas_scsi_clear_queue_port(struct list_head *error_q,
265 struct asd_sas_port *port)
267 struct scsi_cmnd *cmd, *n;
269 list_for_each_entry_safe(cmd, n, error_q, eh_entry) {
270 struct domain_device *dev = cmd_to_domain_dev(cmd);
271 struct asd_sas_port *x = dev->port;
274 list_del_init(&cmd->eh_entry);
278 enum task_disposition {
285 static enum task_disposition sas_scsi_find_task(struct sas_task *task)
287 struct sas_ha_struct *ha = task->dev->port->ha;
290 struct sas_internal *si =
291 to_sas_internal(task->dev->port->ha->core.shost->transportt);
293 if (ha->lldd_max_execute_num > 1) {
294 struct scsi_core *core = &ha->core;
295 struct sas_task *t, *n;
297 spin_lock_irqsave(&core->task_queue_lock, flags);
298 list_for_each_entry_safe(t, n, &core->task_queue, list) {
300 list_del_init(&t->list);
301 spin_unlock_irqrestore(&core->task_queue_lock,
303 SAS_DPRINTK("%s: task 0x%p aborted from "
306 return TASK_IS_ABORTED;
309 spin_unlock_irqrestore(&core->task_queue_lock, flags);
312 spin_lock_irqsave(&task->task_state_lock, flags);
313 if (task->task_state_flags & SAS_TASK_INITIATOR_ABORTED) {
314 spin_unlock_irqrestore(&task->task_state_lock, flags);
315 SAS_DPRINTK("%s: task 0x%p already aborted\n",
317 return TASK_IS_ABORTED;
319 spin_unlock_irqrestore(&task->task_state_lock, flags);
321 for (i = 0; i < 5; i++) {
322 SAS_DPRINTK("%s: aborting task 0x%p\n", __FUNCTION__, task);
323 res = si->dft->lldd_abort_task(task);
325 spin_lock_irqsave(&task->task_state_lock, flags);
326 if (task->task_state_flags & SAS_TASK_STATE_DONE) {
327 spin_unlock_irqrestore(&task->task_state_lock, flags);
328 SAS_DPRINTK("%s: task 0x%p is done\n", __FUNCTION__,
332 spin_unlock_irqrestore(&task->task_state_lock, flags);
334 if (res == TMF_RESP_FUNC_COMPLETE) {
335 SAS_DPRINTK("%s: task 0x%p is aborted\n",
337 return TASK_IS_ABORTED;
338 } else if (si->dft->lldd_query_task) {
339 SAS_DPRINTK("%s: querying task 0x%p\n",
341 res = si->dft->lldd_query_task(task);
342 if (res == TMF_RESP_FUNC_SUCC) {
343 SAS_DPRINTK("%s: task 0x%p at LU\n",
345 return TASK_IS_AT_LU;
346 } else if (res == TMF_RESP_FUNC_COMPLETE) {
347 SAS_DPRINTK("%s: task 0x%p not at LU\n",
349 return TASK_IS_NOT_AT_LU;
356 static int sas_recover_lu(struct domain_device *dev, struct scsi_cmnd *cmd)
358 int res = TMF_RESP_FUNC_FAILED;
360 struct sas_internal *i =
361 to_sas_internal(dev->port->ha->core.shost->transportt);
363 int_to_scsilun(cmd->device->lun, &lun);
365 SAS_DPRINTK("eh: device %llx LUN %x has the task\n",
366 SAS_ADDR(dev->sas_addr),
369 if (i->dft->lldd_abort_task_set)
370 res = i->dft->lldd_abort_task_set(dev, lun.scsi_lun);
372 if (res == TMF_RESP_FUNC_FAILED) {
373 if (i->dft->lldd_clear_task_set)
374 res = i->dft->lldd_clear_task_set(dev, lun.scsi_lun);
377 if (res == TMF_RESP_FUNC_FAILED) {
378 if (i->dft->lldd_lu_reset)
379 res = i->dft->lldd_lu_reset(dev, lun.scsi_lun);
385 static int sas_recover_I_T(struct domain_device *dev)
387 int res = TMF_RESP_FUNC_FAILED;
388 struct sas_internal *i =
389 to_sas_internal(dev->port->ha->core.shost->transportt);
391 SAS_DPRINTK("I_T nexus reset for dev %016llx\n",
392 SAS_ADDR(dev->sas_addr));
394 if (i->dft->lldd_I_T_nexus_reset)
395 res = i->dft->lldd_I_T_nexus_reset(dev);
400 void sas_scsi_recover_host(struct Scsi_Host *shost)
402 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
405 struct scsi_cmnd *cmd, *n;
406 enum task_disposition res = TASK_IS_DONE;
408 struct sas_internal *i = to_sas_internal(shost->transportt);
410 spin_lock_irqsave(shost->host_lock, flags);
411 list_splice_init(&shost->eh_cmd_q, &error_q);
412 spin_unlock_irqrestore(shost->host_lock, flags);
414 SAS_DPRINTK("Enter %s\n", __FUNCTION__);
416 /* All tasks on this list were marked SAS_TASK_STATE_ABORTED
417 * by sas_scsi_timed_out() callback.
420 SAS_DPRINTK("going over list...\n");
421 list_for_each_entry_safe(cmd, n, &error_q, eh_entry) {
422 struct sas_task *task = TO_SAS_TASK(cmd);
423 list_del_init(&cmd->eh_entry);
426 SAS_DPRINTK("%s: taskless cmd?!\n", __FUNCTION__);
429 SAS_DPRINTK("trying to find task 0x%p\n", task);
430 res = sas_scsi_find_task(task);
436 SAS_DPRINTK("%s: task 0x%p is done\n", __FUNCTION__,
438 task->task_done(task);
440 case TASK_IS_ABORTED:
441 SAS_DPRINTK("%s: task 0x%p is aborted\n",
443 task->task_done(task);
446 SAS_DPRINTK("task 0x%p is at LU: lu recover\n", task);
447 tmf_resp = sas_recover_lu(task->dev, cmd);
448 if (tmf_resp == TMF_RESP_FUNC_COMPLETE) {
449 SAS_DPRINTK("dev %016llx LU %x is "
453 task->task_done(task);
454 sas_scsi_clear_queue_lu(&error_q, cmd);
458 case TASK_IS_NOT_AT_LU:
459 SAS_DPRINTK("task 0x%p is not at LU: I_T recover\n",
461 tmf_resp = sas_recover_I_T(task->dev);
462 if (tmf_resp == TMF_RESP_FUNC_COMPLETE) {
463 SAS_DPRINTK("I_T %016llx recovered\n",
464 SAS_ADDR(task->dev->sas_addr));
465 task->task_done(task);
466 sas_scsi_clear_queue_I_T(&error_q, task->dev);
469 /* Hammer time :-) */
470 if (i->dft->lldd_clear_nexus_port) {
471 struct asd_sas_port *port = task->dev->port;
472 SAS_DPRINTK("clearing nexus for port:%d\n",
474 res = i->dft->lldd_clear_nexus_port(port);
475 if (res == TMF_RESP_FUNC_COMPLETE) {
476 SAS_DPRINTK("clear nexus port:%d "
477 "succeeded\n", port->id);
478 task->task_done(task);
479 sas_scsi_clear_queue_port(&error_q,
484 if (i->dft->lldd_clear_nexus_ha) {
485 SAS_DPRINTK("clear nexus ha\n");
486 res = i->dft->lldd_clear_nexus_ha(ha);
487 if (res == TMF_RESP_FUNC_COMPLETE) {
488 SAS_DPRINTK("clear nexus ha "
490 task->task_done(task);
494 /* If we are here -- this means that no amount
495 * of effort could recover from errors. Quite
496 * possibly the HA just disappeared.
498 SAS_DPRINTK("error from device %llx, LUN %x "
499 "couldn't be recovered in any way\n",
500 SAS_ADDR(task->dev->sas_addr),
503 task->task_done(task);
508 scsi_eh_flush_done_q(&ha->eh_done_q);
509 SAS_DPRINTK("--- Exit %s\n", __FUNCTION__);
512 SAS_DPRINTK("--- Exit %s -- clear_q\n", __FUNCTION__);
513 list_for_each_entry_safe(cmd, n, &error_q, eh_entry) {
514 struct sas_task *task = TO_SAS_TASK(cmd);
515 list_del_init(&cmd->eh_entry);
516 task->task_done(task);
520 enum scsi_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *cmd)
522 struct sas_task *task = TO_SAS_TASK(cmd);
526 SAS_DPRINTK("command 0x%p, task 0x%p, gone: EH_HANDLED\n",
531 spin_lock_irqsave(&task->task_state_lock, flags);
532 if (task->task_state_flags & SAS_TASK_INITIATOR_ABORTED) {
533 spin_unlock_irqrestore(&task->task_state_lock, flags);
534 SAS_DPRINTK("command 0x%p, task 0x%p, aborted by initiator: "
535 "EH_NOT_HANDLED\n", cmd, task);
536 return EH_NOT_HANDLED;
538 if (task->task_state_flags & SAS_TASK_STATE_DONE) {
539 spin_unlock_irqrestore(&task->task_state_lock, flags);
540 SAS_DPRINTK("command 0x%p, task 0x%p, timed out: EH_HANDLED\n",
544 task->task_state_flags |= SAS_TASK_STATE_ABORTED;
545 spin_unlock_irqrestore(&task->task_state_lock, flags);
547 SAS_DPRINTK("command 0x%p, task 0x%p, timed out: EH_NOT_HANDLED\n",
550 return EH_NOT_HANDLED;
553 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy)
555 struct Scsi_Host *shost = dev_to_shost(rphy->dev.parent);
556 struct sas_ha_struct *ha = SHOST_TO_SAS_HA(shost);
557 struct domain_device *found_dev = NULL;
560 spin_lock(&ha->phy_port_lock);
561 for (i = 0; i < ha->num_phys; i++) {
562 struct asd_sas_port *port = ha->sas_port[i];
563 struct domain_device *dev;
565 spin_lock(&port->dev_list_lock);
566 list_for_each_entry(dev, &port->dev_list, dev_list_node) {
567 if (rphy == dev->rphy) {
569 spin_unlock(&port->dev_list_lock);
573 spin_unlock(&port->dev_list_lock);
576 spin_unlock(&ha->phy_port_lock);
581 static inline struct domain_device *sas_find_target(struct scsi_target *starget)
583 struct sas_rphy *rphy = dev_to_rphy(starget->dev.parent);
585 return sas_find_dev_by_rphy(rphy);
588 int sas_target_alloc(struct scsi_target *starget)
590 struct domain_device *found_dev = sas_find_target(starget);
595 starget->hostdata = found_dev;
599 #define SAS_DEF_QD 32
600 #define SAS_MAX_QD 64
602 int sas_slave_configure(struct scsi_device *scsi_dev)
604 struct domain_device *dev = sdev_to_domain_dev(scsi_dev);
605 struct sas_ha_struct *sas_ha;
607 BUG_ON(dev->rphy->identify.device_type != SAS_END_DEVICE);
609 sas_ha = dev->port->ha;
611 sas_read_port_mode_page(scsi_dev);
613 if (scsi_dev->tagged_supported) {
614 scsi_set_tag_type(scsi_dev, MSG_SIMPLE_TAG);
615 scsi_activate_tcq(scsi_dev, SAS_DEF_QD);
617 SAS_DPRINTK("device %llx, LUN %x doesn't support "
618 "TCQ\n", SAS_ADDR(dev->sas_addr),
620 scsi_dev->tagged_supported = 0;
621 scsi_set_tag_type(scsi_dev, 0);
622 scsi_deactivate_tcq(scsi_dev, 1);
628 void sas_slave_destroy(struct scsi_device *scsi_dev)
632 int sas_change_queue_depth(struct scsi_device *scsi_dev, int new_depth)
634 int res = min(new_depth, SAS_MAX_QD);
636 if (scsi_dev->tagged_supported)
637 scsi_adjust_queue_depth(scsi_dev, scsi_get_tag_type(scsi_dev),
640 struct domain_device *dev = sdev_to_domain_dev(scsi_dev);
641 sas_printk("device %llx LUN %x queue depth changed to 1\n",
642 SAS_ADDR(dev->sas_addr),
644 scsi_adjust_queue_depth(scsi_dev, 0, 1);
651 int sas_change_queue_type(struct scsi_device *scsi_dev, int qt)
653 if (!scsi_dev->tagged_supported)
656 scsi_deactivate_tcq(scsi_dev, 1);
658 scsi_set_tag_type(scsi_dev, qt);
659 scsi_activate_tcq(scsi_dev, scsi_dev->queue_depth);
664 int sas_bios_param(struct scsi_device *scsi_dev,
665 struct block_device *bdev,
666 sector_t capacity, int *hsc)
670 sector_div(capacity, 255*63);
676 /* ---------- Task Collector Thread implementation ---------- */
678 static void sas_queue(struct sas_ha_struct *sas_ha)
680 struct scsi_core *core = &sas_ha->core;
685 struct sas_internal *i = to_sas_internal(core->shost->transportt);
687 spin_lock_irqsave(&core->task_queue_lock, flags);
688 while (!core->queue_thread_kill &&
689 !list_empty(&core->task_queue)) {
691 can_queue = sas_ha->lldd_queue_size - core->task_queue_size;
692 if (can_queue >= 0) {
693 can_queue = core->task_queue_size;
694 list_splice_init(&core->task_queue, &q);
696 struct list_head *a, *n;
698 can_queue = sas_ha->lldd_queue_size;
699 list_for_each_safe(a, n, &core->task_queue) {
700 list_move_tail(a, &q);
701 if (--can_queue == 0)
704 can_queue = sas_ha->lldd_queue_size;
706 core->task_queue_size -= can_queue;
707 spin_unlock_irqrestore(&core->task_queue_lock, flags);
709 struct sas_task *task = list_entry(q.next,
713 res = i->dft->lldd_execute_task(task, can_queue,
716 __list_add(&q, task->list.prev, &task->list);
718 spin_lock_irqsave(&core->task_queue_lock, flags);
720 list_splice_init(&q, &core->task_queue); /*at head*/
721 core->task_queue_size += can_queue;
724 spin_unlock_irqrestore(&core->task_queue_lock, flags);
727 static DECLARE_COMPLETION(queue_th_comp);
730 * sas_queue_thread -- The Task Collector thread
731 * @_sas_ha: pointer to struct sas_ha
733 static int sas_queue_thread(void *_sas_ha)
735 struct sas_ha_struct *sas_ha = _sas_ha;
736 struct scsi_core *core = &sas_ha->core;
738 daemonize("sas_queue_%d", core->shost->host_no);
739 current->flags |= PF_NOFREEZE;
741 complete(&queue_th_comp);
744 down_interruptible(&core->queue_thread_sema);
746 if (core->queue_thread_kill)
750 complete(&queue_th_comp);
755 int sas_init_queue(struct sas_ha_struct *sas_ha)
758 struct scsi_core *core = &sas_ha->core;
760 spin_lock_init(&core->task_queue_lock);
761 core->task_queue_size = 0;
762 INIT_LIST_HEAD(&core->task_queue);
763 init_MUTEX_LOCKED(&core->queue_thread_sema);
765 res = kernel_thread(sas_queue_thread, sas_ha, 0);
767 wait_for_completion(&queue_th_comp);
769 return res < 0 ? res : 0;
772 void sas_shutdown_queue(struct sas_ha_struct *sas_ha)
775 struct scsi_core *core = &sas_ha->core;
776 struct sas_task *task, *n;
778 init_completion(&queue_th_comp);
779 core->queue_thread_kill = 1;
780 up(&core->queue_thread_sema);
781 wait_for_completion(&queue_th_comp);
783 if (!list_empty(&core->task_queue))
784 SAS_DPRINTK("HA: %llx: scsi core task queue is NOT empty!?\n",
785 SAS_ADDR(sas_ha->sas_addr));
787 spin_lock_irqsave(&core->task_queue_lock, flags);
788 list_for_each_entry_safe(task, n, &core->task_queue, list) {
789 struct scsi_cmnd *cmd = task->uldd_task;
791 list_del_init(&task->list);
793 ASSIGN_SAS_TASK(cmd, NULL);
795 cmd->result = DID_ABORT << 16;
798 spin_unlock_irqrestore(&core->task_queue_lock, flags);
801 EXPORT_SYMBOL_GPL(sas_queuecommand);
802 EXPORT_SYMBOL_GPL(sas_target_alloc);
803 EXPORT_SYMBOL_GPL(sas_slave_configure);
804 EXPORT_SYMBOL_GPL(sas_slave_destroy);
805 EXPORT_SYMBOL_GPL(sas_change_queue_depth);
806 EXPORT_SYMBOL_GPL(sas_change_queue_type);
807 EXPORT_SYMBOL_GPL(sas_bios_param);