2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
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., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
33 * * Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * * Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in
37 * the documentation and/or other materials provided with the
39 * * Neither the name of Intel Corporation nor the names of its
40 * contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57 #include "scic_remote_device.h"
58 #include "scic_io_request.h"
59 #include "scic_task_request.h"
60 #include "scic_port.h"
64 #include "scu_completion_codes.h"
67 static enum sci_status isci_request_ssp_request_construct(
68 struct isci_request *request)
70 enum sci_status status;
72 dev_dbg(&request->isci_host->pdev->dev,
76 status = scic_io_request_construct_basic_ssp(
77 request->sci_request_handle
82 static enum sci_status isci_request_stp_request_construct(
83 struct isci_request *request)
85 struct sas_task *task = isci_request_access_task(request);
86 enum sci_status status;
87 struct host_to_dev_fis *register_fis;
89 dev_dbg(&request->isci_host->pdev->dev,
94 /* Get the host_to_dev_fis from the core and copy
95 * the fis from the task into it.
97 register_fis = isci_sata_task_to_fis_copy(task);
99 status = scic_io_request_construct_basic_sata(
100 request->sci_request_handle
103 /* Set the ncq tag in the fis, from the queue
104 * command in the task.
106 if (isci_sata_is_task_ncq(task)) {
108 isci_sata_set_ncq_tag(
118 * isci_smp_request_build() - This function builds the smp request object.
119 * @isci_host: This parameter specifies the ISCI host object
120 * @request: This parameter points to the isci_request object allocated in the
121 * request construct function.
122 * @sci_device: This parameter is the handle for the sci core's remote device
123 * object that is the destination for this request.
125 * SCI_SUCCESS on successfull completion, or specific failure code.
127 static enum sci_status isci_smp_request_build(
128 struct isci_request *request)
130 enum sci_status status = SCI_FAILURE;
131 struct sas_task *task = isci_request_access_task(request);
133 void *command_iu_address =
134 scic_io_request_get_command_iu_address(
135 request->sci_request_handle
138 dev_dbg(&request->isci_host->pdev->dev,
139 "%s: request = %p\n",
142 dev_dbg(&request->isci_host->pdev->dev,
143 "%s: smp_req len = %d\n",
145 task->smp_task.smp_req.length);
147 /* copy the smp_command to the address; */
148 sg_copy_to_buffer(&task->smp_task.smp_req, 1,
149 (char *)command_iu_address,
150 sizeof(struct smp_request)
153 status = scic_io_request_construct_smp(request->sci_request_handle);
154 if (status != SCI_SUCCESS)
155 dev_warn(&request->isci_host->pdev->dev,
156 "%s: scic_io_request_construct_smp failed with "
165 * isci_io_request_build() - This function builds the io request object.
166 * @isci_host: This parameter specifies the ISCI host object
167 * @request: This parameter points to the isci_request object allocated in the
168 * request construct function.
169 * @sci_device: This parameter is the handle for the sci core's remote device
170 * object that is the destination for this request.
172 * SCI_SUCCESS on successfull completion, or specific failure code.
174 static enum sci_status isci_io_request_build(
175 struct isci_host *isci_host,
176 struct isci_request *request,
177 struct isci_remote_device *isci_device)
179 struct smp_discover_response_protocols dev_protocols;
180 enum sci_status status = SCI_SUCCESS;
181 struct sas_task *task = isci_request_access_task(request);
182 struct scic_sds_remote_device *sci_device = to_sci_dev(isci_device);
184 dev_dbg(&isci_host->pdev->dev,
185 "%s: isci_device = 0x%p; request = %p, "
186 "num_scatter = %d\n",
192 /* map the sgl addresses, if present.
193 * libata does the mapping for sata devices
194 * before we get the request.
196 if (task->num_scatter &&
197 !sas_protocol_ata(task->task_proto) &&
198 !(SAS_PROTOCOL_SMP & task->task_proto)) {
200 request->num_sg_entries = dma_map_sg(
201 &isci_host->pdev->dev,
207 if (request->num_sg_entries == 0)
208 return SCI_FAILURE_INSUFFICIENT_RESOURCES;
211 /* build the common request object. For now,
212 * we will let the core allocate the IO tag.
214 status = scic_io_request_construct(
215 isci_host->core_controller,
217 SCI_CONTROLLER_INVALID_IO_TAG,
219 request->sci_request_mem_ptr,
220 (struct scic_sds_request **)&request->sci_request_handle
223 if (status != SCI_SUCCESS) {
224 dev_warn(&isci_host->pdev->dev,
225 "%s: failed request construct\n",
230 sci_object_set_association(request->sci_request_handle, request);
232 /* Determine protocol and call the appropriate basic constructor */
233 scic_remote_device_get_protocols(sci_device, &dev_protocols);
234 if (dev_protocols.u.bits.attached_ssp_target)
235 status = isci_request_ssp_request_construct(request);
236 else if (dev_protocols.u.bits.attached_stp_target)
237 status = isci_request_stp_request_construct(request);
238 else if (dev_protocols.u.bits.attached_smp_target)
239 status = isci_smp_request_build(request);
241 dev_warn(&isci_host->pdev->dev,
242 "%s: unknown protocol\n", __func__);
251 * isci_request_alloc_core() - This function gets the request object from the
252 * isci_host dma cache.
253 * @isci_host: This parameter specifies the ISCI host object
254 * @isci_request: This parameter will contain the pointer to the new
255 * isci_request object.
256 * @isci_device: This parameter is the pointer to the isci remote device object
257 * that is the destination for this request.
258 * @gfp_flags: This parameter specifies the os allocation flags.
260 * SCI_SUCCESS on successfull completion, or specific failure code.
262 static int isci_request_alloc_core(
263 struct isci_host *isci_host,
264 struct isci_request **isci_request,
265 struct isci_remote_device *isci_device,
270 struct isci_request *request;
273 /* get pointer to dma memory. This actually points
274 * to both the isci_remote_device object and the
275 * sci object. The isci object is at the beginning
276 * of the memory allocated here.
278 request = dma_pool_alloc(isci_host->dma_pool, gfp_flags, &handle);
280 dev_warn(&isci_host->pdev->dev,
281 "%s: dma_pool_alloc returned NULL\n", __func__);
285 /* initialize the request object. */
286 spin_lock_init(&request->state_lock);
287 request->sci_request_mem_ptr = ((u8 *)request) +
288 sizeof(struct isci_request);
289 request->request_daddr = handle;
290 request->isci_host = isci_host;
291 request->isci_device = isci_device;
292 request->io_request_completion = NULL;
294 request->request_alloc_size = isci_host->dma_pool_alloc_size;
295 request->num_sg_entries = 0;
297 request->complete_in_target = false;
299 INIT_LIST_HEAD(&request->completed_node);
300 INIT_LIST_HEAD(&request->dev_node);
302 *isci_request = request;
303 isci_request_change_state(request, allocated);
308 static int isci_request_alloc_io(
309 struct isci_host *isci_host,
310 struct sas_task *task,
311 struct isci_request **isci_request,
312 struct isci_remote_device *isci_device,
315 int retval = isci_request_alloc_core(isci_host, isci_request,
316 isci_device, gfp_flags);
319 (*isci_request)->ttype_ptr.io_task_ptr = task;
320 (*isci_request)->ttype = io_task;
322 task->lldd_task = *isci_request;
328 * isci_request_alloc_tmf() - This function gets the request object from the
329 * isci_host dma cache and initializes the relevant fields as a sas_task.
330 * @isci_host: This parameter specifies the ISCI host object
331 * @sas_task: This parameter is the task struct from the upper layer driver.
332 * @isci_request: This parameter will contain the pointer to the new
333 * isci_request object.
334 * @isci_device: This parameter is the pointer to the isci remote device object
335 * that is the destination for this request.
336 * @gfp_flags: This parameter specifies the os allocation flags.
338 * SCI_SUCCESS on successfull completion, or specific failure code.
340 int isci_request_alloc_tmf(
341 struct isci_host *isci_host,
342 struct isci_tmf *isci_tmf,
343 struct isci_request **isci_request,
344 struct isci_remote_device *isci_device,
347 int retval = isci_request_alloc_core(isci_host, isci_request,
348 isci_device, gfp_flags);
352 (*isci_request)->ttype_ptr.tmf_task_ptr = isci_tmf;
353 (*isci_request)->ttype = tmf_task;
359 * isci_request_signal_device_reset() - This function will set the "device
360 * needs target reset" flag in the given sas_tasks' task_state_flags, and
361 * then cause the task to be added into the SCSI error handler queue which
362 * will eventually be escalated to a target reset.
366 static void isci_request_signal_device_reset(
367 struct isci_request *isci_request)
370 struct sas_task *task = isci_request_access_task(isci_request);
372 dev_dbg(&isci_request->isci_host->pdev->dev,
373 "%s: request=%p, task=%p\n", __func__, isci_request, task);
375 spin_lock_irqsave(&task->task_state_lock, flags);
376 task->task_state_flags |= SAS_TASK_NEED_DEV_RESET;
377 spin_unlock_irqrestore(&task->task_state_lock, flags);
379 /* Cause this task to be scheduled in the SCSI error handler
382 sas_task_abort(task);
386 * isci_request_execute() - This function allocates the isci_request object,
387 * all fills in some common fields.
388 * @isci_host: This parameter specifies the ISCI host object
389 * @sas_task: This parameter is the task struct from the upper layer driver.
390 * @isci_request: This parameter will contain the pointer to the new
391 * isci_request object.
392 * @gfp_flags: This parameter specifies the os allocation flags.
394 * SCI_SUCCESS on successfull completion, or specific failure code.
396 int isci_request_execute(
397 struct isci_host *isci_host,
398 struct sas_task *task,
399 struct isci_request **isci_request,
403 struct scic_sds_remote_device *sci_device;
404 enum sci_status status = SCI_FAILURE_UNSUPPORTED_PROTOCOL;
405 struct isci_remote_device *isci_device;
406 struct isci_request *request;
409 isci_device = isci_dev_from_domain_dev(task->dev);
410 sci_device = to_sci_dev(isci_device);
412 /* do common allocation and init of request object. */
413 ret = isci_request_alloc_io(
424 status = isci_io_request_build(isci_host, request, isci_device);
425 if (status == SCI_SUCCESS) {
427 spin_lock_irqsave(&isci_host->scic_lock, flags);
429 /* send the request, let the core assign the IO TAG. */
430 status = scic_controller_start_io(
431 isci_host->core_controller,
433 request->sci_request_handle,
434 SCI_CONTROLLER_INVALID_IO_TAG
437 if (status == SCI_SUCCESS ||
438 status == SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED) {
440 /* Either I/O started OK, or the core has signaled that
441 * the device needs a target reset.
443 * In either case, hold onto the I/O for later.
445 * Update it's status and add it to the list in the
446 * remote device object.
448 isci_request_change_state(request, started);
449 list_add(&request->dev_node,
450 &isci_device->reqs_in_process);
453 SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED) {
454 /* Signal libsas that we need the SCSI error
455 * handler thread to work on this I/O and that
456 * we want a device reset.
458 isci_request_signal_device_reset(request);
460 /* Change the status, since we are holding
461 * the I/O until it is managed by the SCSI
464 status = SCI_SUCCESS;
467 dev_warn(&isci_host->pdev->dev,
468 "%s: failed request start\n",
471 spin_unlock_irqrestore(&isci_host->scic_lock, flags);
474 dev_warn(&isci_host->pdev->dev,
475 "%s: request_construct failed - status = 0x%x\n",
480 if (status != SCI_SUCCESS) {
482 /* release dma memory on failure. */
483 isci_request_free(isci_host, request);
488 *isci_request = request;
494 * isci_request_process_response_iu() - This function sets the status and
495 * response iu, in the task struct, from the request object for the upper
497 * @sas_task: This parameter is the task struct from the upper layer driver.
498 * @resp_iu: This parameter points to the response iu of the completed request.
499 * @dev: This parameter specifies the linux device struct.
503 static void isci_request_process_response_iu(
504 struct sas_task *task,
505 struct ssp_response_iu *resp_iu,
510 "resp_iu->status = 0x%x,\nresp_iu->datapres = %d "
511 "resp_iu->response_data_len = %x, "
512 "resp_iu->sense_data_len = %x\nrepsonse data: ",
517 resp_iu->response_data_len,
518 resp_iu->sense_data_len);
520 task->task_status.stat = resp_iu->status;
522 /* libsas updates the task status fields based on the response iu. */
523 sas_ssp_task_response(dev, task, resp_iu);
527 * isci_request_set_open_reject_status() - This function prepares the I/O
528 * completion for OPEN_REJECT conditions.
529 * @request: This parameter is the completed isci_request object.
530 * @response_ptr: This parameter specifies the service response for the I/O.
531 * @status_ptr: This parameter specifies the exec status for the I/O.
532 * @complete_to_host_ptr: This parameter specifies the action to be taken by
533 * the LLDD with respect to completing this request or forcing an abort
534 * condition on the I/O.
535 * @open_rej_reason: This parameter specifies the encoded reason for the
536 * abandon-class reject.
540 static void isci_request_set_open_reject_status(
541 struct isci_request *request,
542 struct sas_task *task,
543 enum service_response *response_ptr,
544 enum exec_status *status_ptr,
545 enum isci_completion_selection *complete_to_host_ptr,
546 enum sas_open_rej_reason open_rej_reason)
548 /* Task in the target is done. */
549 request->complete_in_target = true;
550 *response_ptr = SAS_TASK_UNDELIVERED;
551 *status_ptr = SAS_OPEN_REJECT;
552 *complete_to_host_ptr = isci_perform_normal_io_completion;
553 task->task_status.open_rej_reason = open_rej_reason;
557 * isci_request_handle_controller_specific_errors() - This function decodes
558 * controller-specific I/O completion error conditions.
559 * @request: This parameter is the completed isci_request object.
560 * @response_ptr: This parameter specifies the service response for the I/O.
561 * @status_ptr: This parameter specifies the exec status for the I/O.
562 * @complete_to_host_ptr: This parameter specifies the action to be taken by
563 * the LLDD with respect to completing this request or forcing an abort
564 * condition on the I/O.
568 static void isci_request_handle_controller_specific_errors(
569 struct isci_remote_device *isci_device,
570 struct isci_request *request,
571 struct sas_task *task,
572 enum service_response *response_ptr,
573 enum exec_status *status_ptr,
574 enum isci_completion_selection *complete_to_host_ptr)
576 unsigned int cstatus;
578 cstatus = scic_request_get_controller_status(
579 request->sci_request_handle
582 dev_dbg(&request->isci_host->pdev->dev,
583 "%s: %p SCI_FAILURE_CONTROLLER_SPECIFIC_IO_ERR "
584 "- controller status = 0x%x\n",
585 __func__, request, cstatus);
587 /* Decode the controller-specific errors; most
588 * important is to recognize those conditions in which
589 * the target may still have a task outstanding that
592 * Note that there are SCU completion codes being
593 * named in the decode below for which SCIC has already
594 * done work to handle them in a way other than as
595 * a controller-specific completion code; these are left
596 * in the decode below for completeness sake.
599 case SCU_TASK_DONE_DMASETUP_DIRERR:
600 /* Also SCU_TASK_DONE_SMP_FRM_TYPE_ERR: */
601 case SCU_TASK_DONE_XFERCNT_ERR:
602 /* Also SCU_TASK_DONE_SMP_UFI_ERR: */
603 if (task->task_proto == SAS_PROTOCOL_SMP) {
604 /* SCU_TASK_DONE_SMP_UFI_ERR == Task Done. */
605 *response_ptr = SAS_TASK_COMPLETE;
607 /* See if the device has been/is being stopped. Note
608 * that we ignore the quiesce state, since we are
609 * concerned about the actual device state.
611 if ((isci_device->status == isci_stopping) ||
612 (isci_device->status == isci_stopped))
613 *status_ptr = SAS_DEVICE_UNKNOWN;
615 *status_ptr = SAS_ABORTED_TASK;
617 request->complete_in_target = true;
619 *complete_to_host_ptr =
620 isci_perform_normal_io_completion;
622 /* Task in the target is not done. */
623 *response_ptr = SAS_TASK_UNDELIVERED;
625 if ((isci_device->status == isci_stopping) ||
626 (isci_device->status == isci_stopped))
627 *status_ptr = SAS_DEVICE_UNKNOWN;
629 *status_ptr = SAM_STAT_TASK_ABORTED;
631 request->complete_in_target = false;
633 *complete_to_host_ptr =
634 isci_perform_error_io_completion;
639 case SCU_TASK_DONE_CRC_ERR:
640 case SCU_TASK_DONE_NAK_CMD_ERR:
641 case SCU_TASK_DONE_EXCESS_DATA:
642 case SCU_TASK_DONE_UNEXP_FIS:
643 /* Also SCU_TASK_DONE_UNEXP_RESP: */
644 case SCU_TASK_DONE_VIIT_ENTRY_NV: /* TODO - conditions? */
645 case SCU_TASK_DONE_IIT_ENTRY_NV: /* TODO - conditions? */
646 case SCU_TASK_DONE_RNCNV_OUTBOUND: /* TODO - conditions? */
647 /* These are conditions in which the target
648 * has completed the task, so that no cleanup
651 *response_ptr = SAS_TASK_COMPLETE;
653 /* See if the device has been/is being stopped. Note
654 * that we ignore the quiesce state, since we are
655 * concerned about the actual device state.
657 if ((isci_device->status == isci_stopping) ||
658 (isci_device->status == isci_stopped))
659 *status_ptr = SAS_DEVICE_UNKNOWN;
661 *status_ptr = SAS_ABORTED_TASK;
663 request->complete_in_target = true;
665 *complete_to_host_ptr = isci_perform_normal_io_completion;
669 /* Note that the only open reject completion codes seen here will be
670 * abandon-class codes; all others are automatically retried in the SCU.
672 case SCU_TASK_OPEN_REJECT_WRONG_DESTINATION:
674 isci_request_set_open_reject_status(
675 request, task, response_ptr, status_ptr,
676 complete_to_host_ptr, SAS_OREJ_WRONG_DEST);
679 case SCU_TASK_OPEN_REJECT_ZONE_VIOLATION:
681 /* Note - the return of AB0 will change when
682 * libsas implements detection of zone violations.
684 isci_request_set_open_reject_status(
685 request, task, response_ptr, status_ptr,
686 complete_to_host_ptr, SAS_OREJ_RESV_AB0);
689 case SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_1:
691 isci_request_set_open_reject_status(
692 request, task, response_ptr, status_ptr,
693 complete_to_host_ptr, SAS_OREJ_RESV_AB1);
696 case SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_2:
698 isci_request_set_open_reject_status(
699 request, task, response_ptr, status_ptr,
700 complete_to_host_ptr, SAS_OREJ_RESV_AB2);
703 case SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_3:
705 isci_request_set_open_reject_status(
706 request, task, response_ptr, status_ptr,
707 complete_to_host_ptr, SAS_OREJ_RESV_AB3);
710 case SCU_TASK_OPEN_REJECT_BAD_DESTINATION:
712 isci_request_set_open_reject_status(
713 request, task, response_ptr, status_ptr,
714 complete_to_host_ptr, SAS_OREJ_BAD_DEST);
717 case SCU_TASK_OPEN_REJECT_STP_RESOURCES_BUSY:
719 isci_request_set_open_reject_status(
720 request, task, response_ptr, status_ptr,
721 complete_to_host_ptr, SAS_OREJ_STP_NORES);
724 case SCU_TASK_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED:
726 isci_request_set_open_reject_status(
727 request, task, response_ptr, status_ptr,
728 complete_to_host_ptr, SAS_OREJ_EPROTO);
731 case SCU_TASK_OPEN_REJECT_CONNECTION_RATE_NOT_SUPPORTED:
733 isci_request_set_open_reject_status(
734 request, task, response_ptr, status_ptr,
735 complete_to_host_ptr, SAS_OREJ_CONN_RATE);
738 case SCU_TASK_DONE_LL_R_ERR:
739 /* Also SCU_TASK_DONE_ACK_NAK_TO: */
740 case SCU_TASK_DONE_LL_PERR:
741 case SCU_TASK_DONE_LL_SY_TERM:
742 /* Also SCU_TASK_DONE_NAK_ERR:*/
743 case SCU_TASK_DONE_LL_LF_TERM:
744 /* Also SCU_TASK_DONE_DATA_LEN_ERR: */
745 case SCU_TASK_DONE_LL_ABORT_ERR:
746 case SCU_TASK_DONE_SEQ_INV_TYPE:
747 /* Also SCU_TASK_DONE_UNEXP_XR: */
748 case SCU_TASK_DONE_XR_IU_LEN_ERR:
749 case SCU_TASK_DONE_INV_FIS_LEN:
750 /* Also SCU_TASK_DONE_XR_WD_LEN: */
751 case SCU_TASK_DONE_SDMA_ERR:
752 case SCU_TASK_DONE_OFFSET_ERR:
753 case SCU_TASK_DONE_MAX_PLD_ERR:
754 case SCU_TASK_DONE_LF_ERR:
755 case SCU_TASK_DONE_SMP_RESP_TO_ERR: /* Escalate to dev reset? */
756 case SCU_TASK_DONE_SMP_LL_RX_ERR:
757 case SCU_TASK_DONE_UNEXP_DATA:
758 case SCU_TASK_DONE_UNEXP_SDBFIS:
759 case SCU_TASK_DONE_REG_ERR:
760 case SCU_TASK_DONE_SDB_ERR:
761 case SCU_TASK_DONE_TASK_ABORT:
763 /* Task in the target is not done. */
764 *response_ptr = SAS_TASK_UNDELIVERED;
765 *status_ptr = SAM_STAT_TASK_ABORTED;
766 request->complete_in_target = false;
768 *complete_to_host_ptr = isci_perform_error_io_completion;
774 * isci_task_save_for_upper_layer_completion() - This function saves the
775 * request for later completion to the upper layer driver.
776 * @host: This parameter is a pointer to the host on which the the request
777 * should be queued (either as an error or success).
778 * @request: This parameter is the completed request.
779 * @response: This parameter is the response code for the completed task.
780 * @status: This parameter is the status code for the completed task.
784 static void isci_task_save_for_upper_layer_completion(
785 struct isci_host *host,
786 struct isci_request *request,
787 enum service_response response,
788 enum exec_status status,
789 enum isci_completion_selection task_notification_selection)
791 struct sas_task *task = isci_request_access_task(request);
793 task_notification_selection
794 = isci_task_set_completion_status(task, response, status,
795 task_notification_selection);
797 /* Tasks aborted specifically by a call to the lldd_abort_task
798 * function should not be completed to the host in the regular path.
800 switch (task_notification_selection) {
802 case isci_perform_normal_io_completion:
804 /* Normal notification (task_done) */
805 dev_dbg(&host->pdev->dev,
806 "%s: Normal - task = %p, response=%d, status=%d\n",
811 /* Add to the completed list. */
812 list_add(&request->completed_node,
813 &host->requests_to_complete);
815 /* Take the request off the device's pending request list. */
816 list_del_init(&request->dev_node);
819 case isci_perform_aborted_io_completion:
820 /* No notification to libsas because this request is
821 * already in the abort path.
823 dev_warn(&host->pdev->dev,
824 "%s: Aborted - task = %p, response=%d, status=%d\n",
830 /* Wake up whatever process was waiting for this
831 * request to complete.
833 WARN_ON(request->io_request_completion == NULL);
835 if (request->io_request_completion != NULL) {
837 /* Signal whoever is waiting that this
838 * request is complete.
840 complete(request->io_request_completion);
844 case isci_perform_error_io_completion:
845 /* Use sas_task_abort */
846 dev_warn(&host->pdev->dev,
847 "%s: Error - task = %p, response=%d, status=%d\n",
852 /* Add to the aborted list. */
853 list_add(&request->completed_node,
854 &host->requests_to_errorback);
858 dev_warn(&host->pdev->dev,
859 "%s: Unknown - task = %p, response=%d, status=%d\n",
865 /* Add to the error to libsas list. */
866 list_add(&request->completed_node,
867 &host->requests_to_errorback);
873 * isci_request_io_request_complete() - This function is called by the sci core
874 * when an io request completes.
875 * @isci_host: This parameter specifies the ISCI host object
876 * @request: This parameter is the completed isci_request object.
877 * @completion_status: This parameter specifies the completion status from the
882 void isci_request_io_request_complete(
883 struct isci_host *isci_host,
884 struct isci_request *request,
885 enum sci_io_status completion_status)
887 struct sas_task *task = isci_request_access_task(request);
888 struct ssp_response_iu *resp_iu;
890 unsigned long task_flags;
891 struct isci_remote_device *isci_device = request->isci_device;
892 enum service_response response = SAS_TASK_UNDELIVERED;
893 enum exec_status status = SAS_ABORTED_TASK;
894 enum isci_request_status request_status;
895 enum isci_completion_selection complete_to_host
896 = isci_perform_normal_io_completion;
898 dev_dbg(&isci_host->pdev->dev,
899 "%s: request = %p, task = %p,\n"
900 "task->data_dir = %d completion_status = 0x%x\n",
907 spin_lock(&request->state_lock);
908 request_status = isci_request_get_state(request);
910 /* Decode the request status. Note that if the request has been
911 * aborted by a task management function, we don't care
912 * what the status is.
914 switch (request_status) {
917 /* "aborted" indicates that the request was aborted by a task
918 * management function, since once a task management request is
919 * perfomed by the device, the request only completes because
920 * of the subsequent driver terminate.
922 * Aborted also means an external thread is explicitly managing
923 * this request, so that we do not complete it up the stack.
925 * The target is still there (since the TMF was successful).
927 request->complete_in_target = true;
928 response = SAS_TASK_COMPLETE;
930 /* See if the device has been/is being stopped. Note
931 * that we ignore the quiesce state, since we are
932 * concerned about the actual device state.
934 if ((isci_device->status == isci_stopping)
935 || (isci_device->status == isci_stopped)
937 status = SAS_DEVICE_UNKNOWN;
939 status = SAS_ABORTED_TASK;
941 complete_to_host = isci_perform_aborted_io_completion;
942 /* This was an aborted request. */
944 spin_unlock(&request->state_lock);
948 /* aborting means that the task management function tried and
949 * failed to abort the request. We need to note the request
950 * as SAS_TASK_UNDELIVERED, so that the scsi mid layer marks the
953 * Aborting also means an external thread is explicitly managing
954 * this request, so that we do not complete it up the stack.
956 request->complete_in_target = true;
957 response = SAS_TASK_UNDELIVERED;
959 if ((isci_device->status == isci_stopping) ||
960 (isci_device->status == isci_stopped))
961 /* The device has been /is being stopped. Note that
962 * we ignore the quiesce state, since we are
963 * concerned about the actual device state.
965 status = SAS_DEVICE_UNKNOWN;
967 status = SAS_PHY_DOWN;
969 complete_to_host = isci_perform_aborted_io_completion;
971 /* This was an aborted request. */
973 spin_unlock(&request->state_lock);
978 /* This was an terminated request. This happens when
979 * the I/O is being terminated because of an action on
980 * the device (reset, tear down, etc.), and the I/O needs
981 * to be completed up the stack.
983 request->complete_in_target = true;
984 response = SAS_TASK_UNDELIVERED;
986 /* See if the device has been/is being stopped. Note
987 * that we ignore the quiesce state, since we are
988 * concerned about the actual device state.
990 if ((isci_device->status == isci_stopping) ||
991 (isci_device->status == isci_stopped))
992 status = SAS_DEVICE_UNKNOWN;
994 status = SAS_ABORTED_TASK;
996 complete_to_host = isci_perform_aborted_io_completion;
998 /* This was a terminated request. */
1000 spin_unlock(&request->state_lock);
1005 /* The request is done from an SCU HW perspective. */
1006 request->status = completed;
1008 spin_unlock(&request->state_lock);
1010 /* This is an active request being completed from the core. */
1011 switch (completion_status) {
1013 case SCI_IO_FAILURE_RESPONSE_VALID:
1014 dev_dbg(&isci_host->pdev->dev,
1015 "%s: SCI_IO_FAILURE_RESPONSE_VALID (%p/%p)\n",
1020 if (sas_protocol_ata(task->task_proto)) {
1022 = scic_stp_io_request_get_d2h_reg_address(
1023 request->sci_request_handle
1025 isci_request_process_stp_response(task,
1029 } else if (SAS_PROTOCOL_SSP == task->task_proto) {
1031 /* crack the iu response buffer. */
1033 = scic_io_request_get_response_iu_address(
1034 request->sci_request_handle
1037 isci_request_process_response_iu(task, resp_iu,
1038 &isci_host->pdev->dev
1041 } else if (SAS_PROTOCOL_SMP == task->task_proto) {
1043 dev_err(&isci_host->pdev->dev,
1044 "%s: SCI_IO_FAILURE_RESPONSE_VALID: "
1045 "SAS_PROTOCOL_SMP protocol\n",
1049 dev_err(&isci_host->pdev->dev,
1050 "%s: unknown protocol\n", __func__);
1052 /* use the task status set in the task struct by the
1053 * isci_request_process_response_iu call.
1055 request->complete_in_target = true;
1056 response = task->task_status.resp;
1057 status = task->task_status.stat;
1060 case SCI_IO_SUCCESS:
1061 case SCI_IO_SUCCESS_IO_DONE_EARLY:
1063 response = SAS_TASK_COMPLETE;
1064 status = SAM_STAT_GOOD;
1065 request->complete_in_target = true;
1067 if (task->task_proto == SAS_PROTOCOL_SMP) {
1069 u8 *command_iu_address
1070 = scic_io_request_get_command_iu_address(
1071 request->sci_request_handle
1074 dev_dbg(&isci_host->pdev->dev,
1075 "%s: SMP protocol completion\n",
1078 sg_copy_from_buffer(
1079 &task->smp_task.smp_resp, 1,
1081 + sizeof(struct smp_request),
1082 sizeof(struct smp_resp)
1084 } else if (completion_status
1085 == SCI_IO_SUCCESS_IO_DONE_EARLY) {
1087 /* This was an SSP / STP / SATA transfer.
1088 * There is a possibility that less data than
1089 * the maximum was transferred.
1091 u32 transferred_length
1092 = scic_io_request_get_number_of_bytes_transferred(
1093 request->sci_request_handle);
1095 task->task_status.residual
1096 = task->total_xfer_len - transferred_length;
1098 /* If there were residual bytes, call this an
1101 if (task->task_status.residual != 0)
1102 status = SAS_DATA_UNDERRUN;
1104 dev_dbg(&isci_host->pdev->dev,
1105 "%s: SCI_IO_SUCCESS_IO_DONE_EARLY %d\n",
1110 dev_dbg(&isci_host->pdev->dev,
1111 "%s: SCI_IO_SUCCESS\n",
1116 case SCI_IO_FAILURE_TERMINATED:
1117 dev_dbg(&isci_host->pdev->dev,
1118 "%s: SCI_IO_FAILURE_TERMINATED (%p/%p)\n",
1123 /* The request was terminated explicitly. No handling
1124 * is needed in the SCSI error handler path.
1126 request->complete_in_target = true;
1127 response = SAS_TASK_UNDELIVERED;
1129 /* See if the device has been/is being stopped. Note
1130 * that we ignore the quiesce state, since we are
1131 * concerned about the actual device state.
1133 if ((isci_device->status == isci_stopping) ||
1134 (isci_device->status == isci_stopped))
1135 status = SAS_DEVICE_UNKNOWN;
1137 status = SAS_ABORTED_TASK;
1139 complete_to_host = isci_perform_normal_io_completion;
1142 case SCI_FAILURE_CONTROLLER_SPECIFIC_IO_ERR:
1144 isci_request_handle_controller_specific_errors(
1145 isci_device, request, task, &response, &status,
1150 case SCI_IO_FAILURE_REMOTE_DEVICE_RESET_REQUIRED:
1151 /* This is a special case, in that the I/O completion
1152 * is telling us that the device needs a reset.
1153 * In order for the device reset condition to be
1154 * noticed, the I/O has to be handled in the error
1155 * handler. Set the reset flag and cause the
1156 * SCSI error thread to be scheduled.
1158 spin_lock_irqsave(&task->task_state_lock, task_flags);
1159 task->task_state_flags |= SAS_TASK_NEED_DEV_RESET;
1160 spin_unlock_irqrestore(&task->task_state_lock, task_flags);
1162 complete_to_host = isci_perform_error_io_completion;
1163 request->complete_in_target = false;
1167 /* Catch any otherwise unhandled error codes here. */
1168 dev_warn(&isci_host->pdev->dev,
1169 "%s: invalid completion code: 0x%x - "
1170 "isci_request = %p\n",
1171 __func__, completion_status, request);
1173 response = SAS_TASK_UNDELIVERED;
1175 /* See if the device has been/is being stopped. Note
1176 * that we ignore the quiesce state, since we are
1177 * concerned about the actual device state.
1179 if ((isci_device->status == isci_stopping) ||
1180 (isci_device->status == isci_stopped))
1181 status = SAS_DEVICE_UNKNOWN;
1183 status = SAS_ABORTED_TASK;
1185 complete_to_host = isci_perform_error_io_completion;
1186 request->complete_in_target = false;
1192 isci_request_unmap_sgl(request, isci_host->pdev);
1194 /* Put the completed request on the correct list */
1195 isci_task_save_for_upper_layer_completion(isci_host, request, response,
1196 status, complete_to_host
1199 /* complete the io request to the core. */
1200 scic_controller_complete_io(
1201 isci_host->core_controller,
1202 to_sci_dev(isci_device),
1203 request->sci_request_handle
1205 /* NULL the request handle so it cannot be completed or
1206 * terminated again, and to cause any calls into abort
1207 * task to recognize the already completed case.
1209 request->sci_request_handle = NULL;
1211 isci_host_can_dequeue(isci_host, 1);
1215 * isci_request_io_request_get_transfer_length() - This function is called by
1216 * the sci core to retrieve the transfer length for a given request.
1217 * @request: This parameter is the isci_request object.
1219 * length of transfer for specified request.
1221 u32 isci_request_io_request_get_transfer_length(struct isci_request *request)
1223 struct sas_task *task = isci_request_access_task(request);
1225 dev_dbg(&request->isci_host->pdev->dev,
1226 "%s: total_xfer_len: %d\n",
1228 task->total_xfer_len);
1229 return task->total_xfer_len;
1234 * isci_request_io_request_get_data_direction() - This function is called by
1235 * the sci core to retrieve the data direction for a given request.
1236 * @request: This parameter is the isci_request object.
1238 * data direction for specified request.
1240 enum dma_data_direction isci_request_io_request_get_data_direction(
1241 struct isci_request *request)
1243 struct sas_task *task = isci_request_access_task(request);
1245 return task->data_dir;
1249 * isci_request_sge_get_address_field() - This function is called by the sci
1250 * core to retrieve the address field contents for a given sge.
1251 * @request: This parameter is the isci_request object.
1252 * @sge_address: This parameter is the sge.
1254 * physical address in the specified sge.
1256 dma_addr_t isci_request_sge_get_address_field(
1257 struct isci_request *request,
1260 struct sas_task *task = isci_request_access_task(request);
1262 struct isci_host *isci_host = isci_host_from_sas_ha(
1263 task->dev->port->ha);
1265 dev_dbg(&isci_host->pdev->dev,
1266 "%s: request = %p, sge_address = %p\n",
1271 if (task->data_dir == PCI_DMA_NONE)
1274 /* the case where num_scatter == 0 is special, in that
1275 * task->scatter is the actual buffer address, not an sgl.
1276 * so a map single is required here.
1278 if ((task->num_scatter == 0) &&
1279 !sas_protocol_ata(task->task_proto)) {
1280 ret = dma_map_single(
1281 &isci_host->pdev->dev,
1283 task->total_xfer_len,
1286 request->zero_scatter_daddr = ret;
1288 ret = sg_dma_address(((struct scatterlist *)sge_address));
1290 dev_dbg(&isci_host->pdev->dev,
1291 "%s: bus address = %lx\n",
1293 (unsigned long)ret);
1300 * isci_request_sge_get_length_field() - This function is called by the sci
1301 * core to retrieve the length field contents for a given sge.
1302 * @request: This parameter is the isci_request object.
1303 * @sge_address: This parameter is the sge.
1305 * length field value in the specified sge.
1307 u32 isci_request_sge_get_length_field(
1308 struct isci_request *request,
1311 struct sas_task *task = isci_request_access_task(request);
1314 dev_dbg(&request->isci_host->pdev->dev,
1315 "%s: request = %p, sge_address = %p\n",
1320 if (task->data_dir == PCI_DMA_NONE)
1323 /* the case where num_scatter == 0 is special, in that
1324 * task->scatter is the actual buffer address, not an sgl.
1325 * so we return total_xfer_len here.
1327 if (task->num_scatter == 0)
1328 ret = task->total_xfer_len;
1330 ret = sg_dma_len((struct scatterlist *)sge_address);
1332 dev_dbg(&request->isci_host->pdev->dev,
1342 * isci_request_ssp_io_request_get_cdb_address() - This function is called by
1343 * the sci core to retrieve the cdb address for a given request.
1344 * @request: This parameter is the isci_request object.
1346 * cdb address for specified request.
1348 void *isci_request_ssp_io_request_get_cdb_address(
1349 struct isci_request *request)
1351 struct sas_task *task = isci_request_access_task(request);
1353 dev_dbg(&request->isci_host->pdev->dev,
1354 "%s: request->task->ssp_task.cdb = %p\n",
1356 task->ssp_task.cdb);
1357 return task->ssp_task.cdb;
1362 * isci_request_ssp_io_request_get_cdb_length() - This function is called by
1363 * the sci core to retrieve the cdb length for a given request.
1364 * @request: This parameter is the isci_request object.
1366 * cdb length for specified request.
1368 u32 isci_request_ssp_io_request_get_cdb_length(
1369 struct isci_request *request)
1376 * isci_request_ssp_io_request_get_lun() - This function is called by the sci
1377 * core to retrieve the lun for a given request.
1378 * @request: This parameter is the isci_request object.
1380 * lun for specified request.
1382 u32 isci_request_ssp_io_request_get_lun(
1383 struct isci_request *request)
1385 struct sas_task *task = isci_request_access_task(request);
1390 for (i = 0; i < 8; i++)
1391 dev_dbg(&request->isci_host->pdev->dev,
1392 "%s: task->ssp_task.LUN[%d] = %x\n",
1393 __func__, i, task->ssp_task.LUN[i]);
1397 return task->ssp_task.LUN[0];
1402 * isci_request_ssp_io_request_get_task_attribute() - This function is called
1403 * by the sci core to retrieve the task attribute for a given request.
1404 * @request: This parameter is the isci_request object.
1406 * task attribute for specified request.
1408 u32 isci_request_ssp_io_request_get_task_attribute(
1409 struct isci_request *request)
1411 struct sas_task *task = isci_request_access_task(request);
1413 dev_dbg(&request->isci_host->pdev->dev,
1414 "%s: request->task->ssp_task.task_attr = %x\n",
1416 task->ssp_task.task_attr);
1418 return task->ssp_task.task_attr;
1423 * isci_request_ssp_io_request_get_command_priority() - This function is called
1424 * by the sci core to retrieve the command priority for a given request.
1425 * @request: This parameter is the isci_request object.
1427 * command priority for specified request.
1429 u32 isci_request_ssp_io_request_get_command_priority(
1430 struct isci_request *request)
1432 struct sas_task *task = isci_request_access_task(request);
1434 dev_dbg(&request->isci_host->pdev->dev,
1435 "%s: request->task->ssp_task.task_prio = %x\n",
1437 task->ssp_task.task_prio);
1439 return task->ssp_task.task_prio;