task.c 49.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
/*
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * BSD LICENSE
 *
 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <linux/completion.h>
57
#include <linux/irqflags.h>
58
#include "sas.h"
59
#include <scsi/libsas.h>
60 61
#include "remote_device.h"
#include "remote_node_context.h"
62 63 64
#include "isci.h"
#include "request.h"
#include "task.h"
65
#include "host.h"
66

67
/**
68 69 70 71 72 73
* isci_task_refuse() - complete the request to the upper layer driver in
*     the case where an I/O needs to be completed back in the submit path.
* @ihost: host on which the the request was queued
* @task: request to complete
* @response: response code for the completed task.
* @status: status code for the completed task.
74 75
*
*/
76 77 78 79
static void isci_task_refuse(struct isci_host *ihost, struct sas_task *task,
			     enum service_response response,
			     enum exec_status status)

80
{
81
	enum isci_completion_selection disposition;
82

83 84 85
	disposition = isci_perform_normal_io_completion;
	disposition = isci_task_set_completion_status(task, response, status,
						      disposition);
86 87

	/* Tasks aborted specifically by a call to the lldd_abort_task
88 89 90
	 * function should not be completed to the host in the regular path.
	 */
	switch (disposition) {
91 92 93 94 95 96
	case isci_perform_normal_io_completion:
		/* Normal notification (task_done) */
		dev_dbg(&ihost->pdev->dev,
			"%s: Normal - task = %p, response=%d, "
			"status=%d\n",
			__func__, task, response, status);
97

98
		task->lldd_task = NULL;
99

100 101
		isci_execpath_callback(ihost, task, task->task_done);
		break;
102

103 104 105 106 107 108 109 110 111 112
	case isci_perform_aborted_io_completion:
		/*
		 * No notification because this request is already in the
		 * abort path.
		 */
		dev_dbg(&ihost->pdev->dev,
			"%s: Aborted - task = %p, response=%d, "
			"status=%d\n",
			__func__, task, response, status);
		break;
113

114 115 116 117 118 119
	case isci_perform_error_io_completion:
		/* Use sas_task_abort */
		dev_dbg(&ihost->pdev->dev,
			"%s: Error - task = %p, response=%d, "
			"status=%d\n",
			__func__, task, response, status);
120

121 122
		isci_execpath_callback(ihost, task, sas_task_abort);
		break;
123

124 125 126 127 128 129
	default:
		dev_dbg(&ihost->pdev->dev,
			"%s: isci task notification default case!",
			__func__);
		sas_task_abort(task);
		break;
130 131
	}
}
132

133 134 135 136
#define for_each_sas_task(num, task) \
	for (; num > 0; num--,\
	     task = list_entry(task->list.next, struct sas_task, list))

137 138 139 140 141 142 143 144 145

static inline int isci_device_io_ready(struct isci_remote_device *idev,
				       struct sas_task *task)
{
	return idev ? test_bit(IDEV_IO_READY, &idev->flags) ||
		      (test_bit(IDEV_IO_NCQERROR, &idev->flags) &&
		       isci_task_is_ncq_recovery(task))
		    : 0;
}
146 147 148 149 150 151 152 153 154 155 156 157
/**
 * isci_task_execute_task() - This function is one of the SAS Domain Template
 *    functions. This function is called by libsas to send a task down to
 *    hardware.
 * @task: This parameter specifies the SAS task to send.
 * @num: This parameter specifies the number of tasks to queue.
 * @gfp_flags: This parameter specifies the context of this call.
 *
 * status, zero indicates success.
 */
int isci_task_execute_task(struct sas_task *task, int num, gfp_t gfp_flags)
{
158
	struct isci_host *ihost = dev_to_ihost(task->dev);
159
	struct isci_remote_device *idev;
160
	unsigned long flags;
161
	bool io_ready;
162
	u16 tag;
163

164
	dev_dbg(&ihost->pdev->dev, "%s: num=%d\n", __func__, num);
165

166
	for_each_sas_task(num, task) {
167 168
		enum sci_status status = SCI_FAILURE;

169 170
		spin_lock_irqsave(&ihost->scic_lock, flags);
		idev = isci_lookup_device(task->dev);
171
		io_ready = isci_device_io_ready(idev, task);
172
		tag = isci_alloc_tag(ihost);
173
		spin_unlock_irqrestore(&ihost->scic_lock, flags);
174

175 176 177 178
		dev_dbg(&ihost->pdev->dev,
			"task: %p, num: %d dev: %p idev: %p:%#lx cmd = %p\n",
			task, num, task->dev, idev, idev ? idev->flags : 0,
			task->uldd_task);
179

180 181 182
		if (!idev) {
			isci_task_refuse(ihost, task, SAS_TASK_UNDELIVERED,
					 SAS_DEVICE_UNKNOWN);
183
		} else if (!io_ready || tag == SCI_CONTROLLER_INVALID_IO_TAG) {
184 185 186 187 188
			/* Indicate QUEUE_FULL so that the scsi midlayer
			 * retries.
			  */
			isci_task_refuse(ihost, task, SAS_TASK_COMPLETE,
					 SAS_QUEUE_FULL);
189 190 191
		} else {
			/* There is a device and it's ready for I/O. */
			spin_lock_irqsave(&task->task_state_lock, flags);
192

193
			if (task->task_state_flags & SAS_TASK_STATE_ABORTED) {
194
				/* The I/O was aborted. */
195 196
				spin_unlock_irqrestore(&task->task_state_lock,
						       flags);
197

198 199 200
				isci_task_refuse(ihost, task,
						 SAS_TASK_UNDELIVERED,
						 SAM_STAT_TASK_ABORTED);
201
			} else {
202 203
				task->task_state_flags |= SAS_TASK_AT_INITIATOR;
				spin_unlock_irqrestore(&task->task_state_lock, flags);
204 205

				/* build and send the request. */
D
Dan Williams 已提交
206
				status = isci_request_execute(ihost, idev, task, tag);
207 208 209 210 211 212 213 214

				if (status != SCI_SUCCESS) {

					spin_lock_irqsave(&task->task_state_lock, flags);
					/* Did not really start this command. */
					task->task_state_flags &= ~SAS_TASK_AT_INITIATOR;
					spin_unlock_irqrestore(&task->task_state_lock, flags);

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
					if (test_bit(IDEV_GONE, &idev->flags)) {

						/* Indicate that the device
						 * is gone.
						 */
						isci_task_refuse(ihost, task,
							SAS_TASK_UNDELIVERED,
							SAS_DEVICE_UNKNOWN);
					} else {
						/* Indicate QUEUE_FULL so that
						 * the scsi midlayer retries.
						 * If the request failed for
						 * remote device reasons, it
						 * gets returned as
						 * SAS_TASK_UNDELIVERED next
						 * time through.
						 */
						isci_task_refuse(ihost, task,
							SAS_TASK_COMPLETE,
							SAS_QUEUE_FULL);
					}
236
				}
237 238
			}
		}
239 240 241 242 243 244 245 246
		if (status != SCI_SUCCESS && tag != SCI_CONTROLLER_INVALID_IO_TAG) {
			spin_lock_irqsave(&ihost->scic_lock, flags);
			/* command never hit the device, so just free
			 * the tci and skip the sequence increment
			 */
			isci_tci_free(ihost, ISCI_TAG_TCI(tag));
			spin_unlock_irqrestore(&ihost->scic_lock, flags);
		}
247
		isci_put_device(idev);
248
	}
249 250 251
	return 0;
}

252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
static enum sci_status isci_sata_management_task_request_build(struct isci_request *ireq)
{
	struct isci_tmf *isci_tmf;
	enum sci_status status;

	if (tmf_task != ireq->ttype)
		return SCI_FAILURE;

	isci_tmf = isci_request_access_tmf(ireq);

	switch (isci_tmf->tmf_code) {

	case isci_tmf_sata_srst_high:
	case isci_tmf_sata_srst_low: {
		struct host_to_dev_fis *fis = &ireq->stp.cmd;

		memset(fis, 0, sizeof(*fis));

		fis->fis_type  =  0x27;
		fis->flags     &= ~0x80;
		fis->flags     &= 0xF0;
		if (isci_tmf->tmf_code == isci_tmf_sata_srst_high)
			fis->control |= ATA_SRST;
		else
			fis->control &= ~ATA_SRST;
		break;
	}
	/* other management commnd go here... */
	default:
		return SCI_FAILURE;
	}

	/* core builds the protocol specific request
	 *  based on the h2d fis.
	 */
	status = sci_task_request_construct_sata(ireq);

	return status;
}

D
Dan Williams 已提交
292
static struct isci_request *isci_task_request_build(struct isci_host *ihost,
293
						    struct isci_remote_device *idev,
294
						    u16 tag, struct isci_tmf *isci_tmf)
295 296
{
	enum sci_status status = SCI_FAILURE;
D
Dan Williams 已提交
297
	struct isci_request *ireq = NULL;
298
	struct domain_device *dev;
299

D
Dan Williams 已提交
300
	dev_dbg(&ihost->pdev->dev,
301 302
		"%s: isci_tmf = %p\n", __func__, isci_tmf);

D
Dan Williams 已提交
303
	dev = idev->domain_dev;
304 305

	/* do common allocation and init of request object. */
D
Dan Williams 已提交
306
	ireq = isci_tmf_request_from_tag(ihost, isci_tmf, tag);
D
Dan Williams 已提交
307 308
	if (!ireq)
		return NULL;
309 310

	/* let the core do it's construct. */
311
	status = sci_task_request_construct(ihost, idev, tag,
312
					     ireq);
313 314

	if (status != SCI_SUCCESS) {
D
Dan Williams 已提交
315
		dev_warn(&ihost->pdev->dev,
316
			 "%s: sci_task_request_construct failed - "
317 318 319
			 "status = 0x%x\n",
			 __func__,
			 status);
D
Dan Williams 已提交
320
		return NULL;
321 322
	}

323 324
	/* XXX convert to get this from task->tproto like other drivers */
	if (dev->dev_type == SAS_END_DEV) {
325
		isci_tmf->proto = SAS_PROTOCOL_SSP;
326
		status = sci_task_request_construct_ssp(ireq);
327
		if (status != SCI_SUCCESS)
D
Dan Williams 已提交
328
			return NULL;
329 330
	}

331
	if (dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP)) {
332
		isci_tmf->proto = SAS_PROTOCOL_SATA;
D
Dan Williams 已提交
333
		status = isci_sata_management_task_request_build(ireq);
334 335

		if (status != SCI_SUCCESS)
D
Dan Williams 已提交
336
			return NULL;
337
	}
D
Dan Williams 已提交
338
	return ireq;
339 340
}

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
/**
* isci_request_mark_zombie() - This function must be called with scic_lock held.
*/
static void isci_request_mark_zombie(struct isci_host *ihost, struct isci_request *ireq)
{
	struct completion *tmf_completion = NULL;
	struct completion *req_completion;

	/* Set the request state to "dead". */
	ireq->status = dead;

	req_completion = ireq->io_request_completion;
	ireq->io_request_completion = NULL;

	if (ireq->ttype == io_task) {

		/* Break links with the sas_task - the callback is done
		 * elsewhere.
		 */
		struct sas_task *task = isci_request_access_task(ireq);

		if (task)
			task->lldd_task = NULL;

		ireq->ttype_ptr.io_task_ptr = NULL;
	} else {
		/* Break links with the TMF request. */
		struct isci_tmf *tmf = isci_request_access_tmf(ireq);

		/* In the case where a task request is dying,
		 * the thread waiting on the complete will sit and
		 * timeout unless we wake it now.  Since the TMF
		 * has a default error status, complete it here
		 * to wake the waiting thread.
		 */
		if (tmf) {
			tmf_completion = tmf->complete;
			tmf->complete = NULL;
		}
		ireq->ttype_ptr.tmf_task_ptr = NULL;
		dev_dbg(&ihost->pdev->dev, "%s: tmf_code %d, managed tag %#x\n",
			__func__, tmf->tmf_code, tmf->io_tag);
	}

	dev_warn(&ihost->pdev->dev, "task context unrecoverable (tag: %#x)\n",
		 ireq->io_tag);

	/* Don't force waiting threads to timeout. */
	if (req_completion)
		complete(req_completion);

	if (tmf_completion != NULL)
		complete(tmf_completion);
}

396 397 398
static int isci_task_execute_tmf(struct isci_host *ihost,
				 struct isci_remote_device *idev,
				 struct isci_tmf *tmf, unsigned long timeout_ms)
399 400
{
	DECLARE_COMPLETION_ONSTACK(completion);
401
	enum sci_task_status status = SCI_TASK_FAILURE;
D
Dan Williams 已提交
402
	struct isci_request *ireq;
403 404
	int ret = TMF_RESP_FUNC_FAILED;
	unsigned long flags;
E
Edmund Nadolski 已提交
405
	unsigned long timeleft;
406 407 408 409 410 411 412 413
	u16 tag;

	spin_lock_irqsave(&ihost->scic_lock, flags);
	tag = isci_alloc_tag(ihost);
	spin_unlock_irqrestore(&ihost->scic_lock, flags);

	if (tag == SCI_CONTROLLER_INVALID_IO_TAG)
		return ret;
414 415 416 417

	/* sanity check, return TMF_RESP_FUNC_FAILED
	 * if the device is not there and ready.
	 */
418 419 420
	if (!idev ||
	    (!test_bit(IDEV_IO_READY, &idev->flags) &&
	     !test_bit(IDEV_IO_NCQERROR, &idev->flags))) {
D
Dan Williams 已提交
421
		dev_dbg(&ihost->pdev->dev,
422
			"%s: idev = %p not ready (%#lx)\n",
423
			__func__,
424
			idev, idev ? idev->flags : 0);
425
		goto err_tci;
426
	} else
D
Dan Williams 已提交
427
		dev_dbg(&ihost->pdev->dev,
428 429
			"%s: idev = %p\n",
			__func__, idev);
430 431 432

	/* Assign the pointer to the TMF's completion kernel wait structure. */
	tmf->complete = &completion;
433
	tmf->status = SCI_FAILURE_TIMEOUT;
434

435
	ireq = isci_task_request_build(ihost, idev, tag, tmf);
436 437
	if (!ireq)
		goto err_tci;
438

D
Dan Williams 已提交
439
	spin_lock_irqsave(&ihost->scic_lock, flags);
440 441

	/* start the TMF io. */
442
	status = sci_controller_start_task(ihost, idev, ireq);
443

444
	if (status != SCI_TASK_SUCCESS) {
D
Dan Williams 已提交
445
		dev_dbg(&ihost->pdev->dev,
446 447 448
			 "%s: start_io failed - status = 0x%x, request = %p\n",
			 __func__,
			 status,
D
Dan Williams 已提交
449 450
			 ireq);
		spin_unlock_irqrestore(&ihost->scic_lock, flags);
D
Dan Williams 已提交
451
		goto err_tci;
452 453 454 455 456
	}

	if (tmf->cb_state_func != NULL)
		tmf->cb_state_func(isci_tmf_started, tmf, tmf->cb_data);

D
Dan Williams 已提交
457
	isci_request_change_state(ireq, started);
458 459

	/* add the request to the remote device request list. */
460
	list_add(&ireq->dev_node, &idev->reqs_in_process);
461

D
Dan Williams 已提交
462
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
463 464

	/* Wait for the TMF to complete, or a timeout. */
E
Edmund Nadolski 已提交
465
	timeleft = wait_for_completion_timeout(&completion,
466
					       msecs_to_jiffies(timeout_ms));
E
Edmund Nadolski 已提交
467 468

	if (timeleft == 0) {
469 470 471
		/* The TMF did not complete - this could be because
		 * of an unplug.  Terminate the TMF request now.
		 */
D
Dan Williams 已提交
472
		spin_lock_irqsave(&ihost->scic_lock, flags);
E
Edmund Nadolski 已提交
473 474

		if (tmf->cb_state_func != NULL)
475 476
			tmf->cb_state_func(isci_tmf_timed_out, tmf,
					   tmf->cb_data);
E
Edmund Nadolski 已提交
477

478
		sci_controller_terminate_request(ihost, idev, ireq);
E
Edmund Nadolski 已提交
479

D
Dan Williams 已提交
480
		spin_unlock_irqrestore(&ihost->scic_lock, flags);
481

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
		timeleft = wait_for_completion_timeout(
			&completion,
			msecs_to_jiffies(ISCI_TERMINATION_TIMEOUT_MSEC));

		if (!timeleft) {
			/* Strange condition - the termination of the TMF
			 * request timed-out.
			 */
			spin_lock_irqsave(&ihost->scic_lock, flags);

			/* If the TMF status has not changed, kill it. */
			if (tmf->status == SCI_FAILURE_TIMEOUT)
				isci_request_mark_zombie(ihost, ireq);

			spin_unlock_irqrestore(&ihost->scic_lock, flags);
		}
E
Edmund Nadolski 已提交
498
	}
499 500 501 502 503 504

	isci_print_tmf(tmf);

	if (tmf->status == SCI_SUCCESS)
		ret =  TMF_RESP_FUNC_COMPLETE;
	else if (tmf->status == SCI_FAILURE_IO_RESPONSE_VALID) {
D
Dan Williams 已提交
505
		dev_dbg(&ihost->pdev->dev,
506 507 508 509 510 511 512
			"%s: tmf.status == "
			"SCI_FAILURE_IO_RESPONSE_VALID\n",
			__func__);
		ret =  TMF_RESP_FUNC_COMPLETE;
	}
	/* Else - leave the default "failed" status alone. */

D
Dan Williams 已提交
513
	dev_dbg(&ihost->pdev->dev,
514 515
		"%s: completed request = %p\n",
		__func__,
D
Dan Williams 已提交
516
		ireq);
517 518

	return ret;
519 520 521 522 523 524 525

 err_tci:
	spin_lock_irqsave(&ihost->scic_lock, flags);
	isci_tci_free(ihost, ISCI_TAG_TCI(tag));
	spin_unlock_irqrestore(&ihost->scic_lock, flags);

	return ret;
526 527
}

528 529 530 531 532 533
static void isci_task_build_tmf(struct isci_tmf *tmf,
				enum isci_tmf_function_codes code,
				void (*tmf_sent_cb)(enum isci_tmf_cb_state,
						    struct isci_tmf *,
						    void *),
				void *cb_data)
534 535 536 537 538
{
	memset(tmf, 0, sizeof(*tmf));

	tmf->tmf_code      = code;
	tmf->cb_state_func = tmf_sent_cb;
539 540
	tmf->cb_data       = cb_data;
}
541

542 543 544 545 546 547
static void isci_task_build_abort_task_tmf(struct isci_tmf *tmf,
					   enum isci_tmf_function_codes code,
					   void (*tmf_sent_cb)(enum isci_tmf_cb_state,
							       struct isci_tmf *,
							       void *),
					   struct isci_request *old_request)
548
{
549
	isci_task_build_tmf(tmf, code, tmf_sent_cb, old_request);
550
	tmf->io_tag = old_request->io_tag;
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
}

/**
 * isci_task_validate_request_to_abort() - This function checks the given I/O
 *    against the "started" state.  If the request is still "started", it's
 *    state is changed to aborted. NOTE: isci_host->scic_lock MUST BE HELD
 *    BEFORE CALLING THIS FUNCTION.
 * @isci_request: This parameter specifies the request object to control.
 * @isci_host: This parameter specifies the ISCI host object
 * @isci_device: This is the device to which the request is pending.
 * @aborted_io_completion: This is a completion structure that will be added to
 *    the request in case it is changed to aborting; this completion is
 *    triggered when the request is fully completed.
 *
 * Either "started" on successful change of the task status to "aborted", or
 * "unallocated" if the task cannot be controlled.
 */
static enum isci_request_status isci_task_validate_request_to_abort(
	struct isci_request *isci_request,
	struct isci_host *isci_host,
	struct isci_remote_device *isci_device,
	struct completion *aborted_io_completion)
{
	enum isci_request_status old_state = unallocated;

	/* Only abort the task if it's in the
	 *  device's request_in_process list
	 */
	if (isci_request && !list_empty(&isci_request->dev_node)) {
		old_state = isci_request_change_started_to_aborted(
			isci_request, aborted_io_completion);

	}

	return old_state;
}

588 589 590 591 592 593 594 595 596 597 598 599 600 601
static int isci_request_is_dealloc_managed(enum isci_request_status stat)
{
	switch (stat) {
	case aborted:
	case aborting:
	case terminating:
	case completed:
	case dead:
		return true;
	default:
		return false;
	}
}

602 603 604 605 606
/**
 * isci_terminate_request_core() - This function will terminate the given
 *    request, and wait for it to complete.  This function must only be called
 *    from a thread that can wait.  Note that the request is terminated and
 *    completed (back to the host, if started there).
607
 * @ihost: This SCU.
608
 * @idev: The target.
609 610 611
 * @isci_request: The I/O request to be terminated.
 *
 */
612 613 614
static void isci_terminate_request_core(struct isci_host *ihost,
					struct isci_remote_device *idev,
					struct isci_request *isci_request)
615
{
616
	enum sci_status status      = SCI_SUCCESS;
617 618
	bool was_terminated         = false;
	bool needs_cleanup_handling = false;
619 620 621
	unsigned long     flags;
	unsigned long     termination_completed = 1;
	struct completion *io_request_completion;
622

623
	dev_dbg(&ihost->pdev->dev,
624
		"%s: device = %p; request = %p\n",
625
		__func__, idev, isci_request);
626

627
	spin_lock_irqsave(&ihost->scic_lock, flags);
628

629 630
	io_request_completion = isci_request->io_request_completion;

631
	/* Note that we are not going to control
D
Dan Williams 已提交
632 633 634
	 * the target to abort the request.
	 */
	set_bit(IREQ_COMPLETE_IN_TARGET, &isci_request->flags);
635

636 637 638 639
	/* Make sure the request wasn't just sitting around signalling
	 * device condition (if the request handle is NULL, then the
	 * request completed but needed additional handling here).
	 */
D
Dan Williams 已提交
640
	if (!test_bit(IREQ_TERMINATED, &isci_request->flags)) {
641
		was_terminated = true;
642
		needs_cleanup_handling = true;
643
		status = sci_controller_terminate_request(ihost,
644 645
							   idev,
							   isci_request);
646
	}
647
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
648 649 650 651 652 653

	/*
	 * The only time the request to terminate will
	 * fail is when the io request is completed and
	 * being aborted.
	 */
654
	if (status != SCI_SUCCESS) {
D
Dan Williams 已提交
655
		dev_dbg(&ihost->pdev->dev,
656
			"%s: sci_controller_terminate_request"
657
			" returned = 0x%x\n",
658 659
			__func__, status);

660 661 662
		isci_request->io_request_completion = NULL;

	} else {
663
		if (was_terminated) {
664
			dev_dbg(&ihost->pdev->dev,
665 666
				"%s: before completion wait (%p/%p)\n",
				__func__, isci_request, io_request_completion);
667 668

			/* Wait here for the request to complete. */
669
			termination_completed
670
				= wait_for_completion_timeout(
671
				   io_request_completion,
672
				   msecs_to_jiffies(ISCI_TERMINATION_TIMEOUT_MSEC));
673

674 675 676
			if (!termination_completed) {

				/* The request to terminate has timed out.  */
677
				spin_lock_irqsave(&ihost->scic_lock, flags);
678 679

				/* Check for state changes. */
680 681
				if (!test_bit(IREQ_TERMINATED,
					      &isci_request->flags)) {
682 683 684 685 686

					/* The best we can do is to have the
					 * request die a silent death if it
					 * ever really completes.
					 */
687 688 689
					isci_request_mark_zombie(ihost,
								 isci_request);
					needs_cleanup_handling = true;
690 691 692
				} else
					termination_completed = 1;

693
				spin_unlock_irqrestore(&ihost->scic_lock,
694
						       flags);
695

696
				if (!termination_completed) {
697

D
Dan Williams 已提交
698
					dev_dbg(&ihost->pdev->dev,
699 700 701 702
						"%s: *** Timeout waiting for "
						"termination(%p/%p)\n",
						__func__, io_request_completion,
						isci_request);
703

704 705 706 707 708 709 710 711
					/* The request can no longer be referenced
					 * safely since it may go away if the
					 * termination every really does complete.
					 */
					isci_request = NULL;
				}
			}
			if (termination_completed)
712
				dev_dbg(&ihost->pdev->dev,
713 714
					"%s: after completion wait (%p/%p)\n",
					__func__, isci_request, io_request_completion);
715 716
		}

717
		if (termination_completed) {
718

719
			isci_request->io_request_completion = NULL;
720

721 722 723 724 725
			/* Peek at the status of the request.  This will tell
			 * us if there was special handling on the request such that it
			 * needs to be detached and freed here.
			 */
			spin_lock_irqsave(&isci_request->state_lock, flags);
726 727 728 729 730

			needs_cleanup_handling
				= isci_request_is_dealloc_managed(
					isci_request->status);

731
			spin_unlock_irqrestore(&isci_request->state_lock, flags);
732

733
		}
734 735 736 737 738 739 740 741 742 743 744 745 746 747
		if (needs_cleanup_handling) {

			dev_dbg(&ihost->pdev->dev,
				"%s: cleanup isci_device=%p, request=%p\n",
				__func__, idev, isci_request);

			if (isci_request != NULL) {
				spin_lock_irqsave(&ihost->scic_lock, flags);
				isci_free_tag(ihost, isci_request->io_tag);
				isci_request_change_state(isci_request, unallocated);
				list_del_init(&isci_request->dev_node);
				spin_unlock_irqrestore(&ihost->scic_lock, flags);
			}
		}
748
	}
749 750 751 752 753 754 755 756 757
}

/**
 * isci_terminate_pending_requests() - This function will change the all of the
 *    requests on the given device's state to "aborting", will terminate the
 *    requests, and wait for them to complete.  This function must only be
 *    called from a thread that can wait.  Note that the requests are all
 *    terminated and completed (back to the host, if started there).
 * @isci_host: This parameter specifies SCU.
758
 * @idev: This parameter specifies the target.
759 760
 *
 */
761 762
void isci_terminate_pending_requests(struct isci_host *ihost,
				     struct isci_remote_device *idev)
763
{
764
	struct completion request_completion;
765
	enum isci_request_status old_state;
766 767
	unsigned long flags;
	LIST_HEAD(list);
768

769 770
	spin_lock_irqsave(&ihost->scic_lock, flags);
	list_splice_init(&idev->reqs_in_process, &list);
771

772 773 774
	/* assumes that isci_terminate_request_core deletes from the list */
	while (!list_empty(&list)) {
		struct isci_request *ireq = list_entry(list.next, typeof(*ireq), dev_node);
775

776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
		/* Change state to "terminating" if it is currently
		 * "started".
		 */
		old_state = isci_request_change_started_to_newstate(ireq,
								    &request_completion,
								    terminating);
		switch (old_state) {
		case started:
		case completed:
		case aborting:
			break;
		default:
			/* termination in progress, or otherwise dispositioned.
			 * We know the request was on 'list' so should be safe
			 * to move it back to reqs_in_process
			 */
			list_move(&ireq->dev_node, &idev->reqs_in_process);
			ireq = NULL;
			break;
		}
796

797 798 799
		if (!ireq)
			continue;
		spin_unlock_irqrestore(&ihost->scic_lock, flags);
800

801
		init_completion(&request_completion);
802

803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
		dev_dbg(&ihost->pdev->dev,
			 "%s: idev=%p request=%p; task=%p old_state=%d\n",
			 __func__, idev, ireq,
			ireq->ttype == io_task ? isci_request_access_task(ireq) : NULL,
			old_state);

		/* If the old_state is started:
		 * This request was not already being aborted. If it had been,
		 * then the aborting I/O (ie. the TMF request) would not be in
		 * the aborting state, and thus would be terminated here.  Note
		 * that since the TMF completion's call to the kernel function
		 * "complete()" does not happen until the pending I/O request
		 * terminate fully completes, we do not have to implement a
		 * special wait here for already aborting requests - the
		 * termination of the TMF request will force the request
		 * to finish it's already started terminate.
		 *
		 * If old_state == completed:
		 * This request completed from the SCU hardware perspective
		 * and now just needs cleaning up in terms of freeing the
		 * request and potentially calling up to libsas.
		 *
		 * If old_state == aborting:
		 * This request has already gone through a TMF timeout, but may
		 * not have been terminated; needs cleaning up at least.
		 */
		isci_terminate_request_core(ihost, idev, ireq);
		spin_lock_irqsave(&ihost->scic_lock, flags);
831
	}
832
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
}

/**
 * isci_task_send_lu_reset_sas() - This function is called by of the SAS Domain
 *    Template functions.
 * @lun: This parameter specifies the lun to be reset.
 *
 * status, zero indicates success.
 */
static int isci_task_send_lu_reset_sas(
	struct isci_host *isci_host,
	struct isci_remote_device *isci_device,
	u8 *lun)
{
	struct isci_tmf tmf;
	int ret = TMF_RESP_FUNC_FAILED;

	dev_dbg(&isci_host->pdev->dev,
		"%s: isci_host = %p, isci_device = %p\n",
		__func__, isci_host, isci_device);
	/* Send the LUN reset to the target.  By the time the call returns,
	 * the TMF has fully exected in the target (in which case the return
	 * value is "TMF_RESP_FUNC_COMPLETE", or the request timed-out (or
	 * was otherwise unable to be executed ("TMF_RESP_FUNC_FAILED").
	 */
858
	isci_task_build_tmf(&tmf, isci_tmf_ssp_lun_reset, NULL, NULL);
859 860

	#define ISCI_LU_RESET_TIMEOUT_MS 2000 /* 2 second timeout. */
861
	ret = isci_task_execute_tmf(isci_host, isci_device, &tmf, ISCI_LU_RESET_TIMEOUT_MS);
862 863 864 865 866 867 868 869 870 871 872 873 874

	if (ret == TMF_RESP_FUNC_COMPLETE)
		dev_dbg(&isci_host->pdev->dev,
			"%s: %p: TMF_LU_RESET passed\n",
			__func__, isci_device);
	else
		dev_dbg(&isci_host->pdev->dev,
			"%s: %p: TMF_LU_RESET failed (%x)\n",
			__func__, isci_device, ret);

	return ret;
}

875 876 877 878 879 880 881 882 883 884 885 886 887
static int isci_task_send_lu_reset_sata(struct isci_host *ihost,
				 struct isci_remote_device *idev, u8 *lun)
{
	int ret = TMF_RESP_FUNC_FAILED;
	struct isci_tmf tmf;

	/* Send the soft reset to the target */
	#define ISCI_SRST_TIMEOUT_MS 25000 /* 25 second timeout. */
	isci_task_build_tmf(&tmf, isci_tmf_sata_srst_high, NULL, NULL);

	ret = isci_task_execute_tmf(ihost, idev, &tmf, ISCI_SRST_TIMEOUT_MS);

	if (ret != TMF_RESP_FUNC_COMPLETE) {
D
Dan Williams 已提交
888
		dev_dbg(&ihost->pdev->dev,
889 890 891 892 893 894 895 896 897 898
			 "%s: Assert SRST failed (%p) = %x",
			 __func__, idev, ret);

		/* Return the failure so that the LUN reset is escalated
		 * to a target reset.
		 */
	}
	return ret;
}

899 900 901 902 903 904 905 906 907
/**
 * isci_task_lu_reset() - This function is one of the SAS Domain Template
 *    functions. This is one of the Task Management functoins called by libsas,
 *    to reset the given lun. Note the assumption that while this call is
 *    executing, no I/O will be sent by the host to the device.
 * @lun: This parameter specifies the lun to be reset.
 *
 * status, zero indicates success.
 */
908
int isci_task_lu_reset(struct domain_device *domain_device, u8 *lun)
909
{
910
	struct isci_host *isci_host = dev_to_ihost(domain_device);
911 912
	struct isci_remote_device *isci_device;
	unsigned long flags;
913 914
	int ret;

915 916 917
	spin_lock_irqsave(&isci_host->scic_lock, flags);
	isci_device = isci_lookup_device(domain_device);
	spin_unlock_irqrestore(&isci_host->scic_lock, flags);
918

919 920
	dev_dbg(&isci_host->pdev->dev,
		"%s: domain_device=%p, isci_host=%p; isci_device=%p\n",
921 922
		 __func__, domain_device, isci_host, isci_device);

923
	if (isci_device)
D
Dan Williams 已提交
924
		set_bit(IDEV_EH, &isci_device->flags);
925 926 927 928 929

	/* If there is a device reset pending on any request in the
	 * device's list, fail this LUN reset request in order to
	 * escalate to the device reset.
	 */
930
	if (!isci_device ||
931
	    isci_device_is_reset_pending(isci_host, isci_device)) {
D
Dan Williams 已提交
932
		dev_dbg(&isci_host->pdev->dev,
933
			 "%s: No dev (%p), or "
934
			 "RESET PENDING: domain_device=%p\n",
935
			 __func__, isci_device, domain_device);
936 937
		ret = TMF_RESP_FUNC_FAILED;
		goto out;
938 939 940 941
	}

	/* Send the task management part of the reset. */
	if (sas_protocol_ata(domain_device->tproto)) {
942
		ret = isci_task_send_lu_reset_sata(isci_host, isci_device, lun);
943 944 945 946 947 948 949
	} else
		ret = isci_task_send_lu_reset_sas(isci_host, isci_device, lun);

	/* If the LUN reset worked, all the I/O can now be terminated. */
	if (ret == TMF_RESP_FUNC_COMPLETE)
		/* Terminate all I/O now. */
		isci_terminate_pending_requests(isci_host,
950
						isci_device);
951

952 953
 out:
	isci_put_device(isci_device);
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
	return ret;
}


/*	 int (*lldd_clear_nexus_port)(struct asd_sas_port *); */
int isci_task_clear_nexus_port(struct asd_sas_port *port)
{
	return TMF_RESP_FUNC_FAILED;
}



int isci_task_clear_nexus_ha(struct sas_ha_struct *ha)
{
	return TMF_RESP_FUNC_FAILED;
}

/* Task Management Functions. Must be called from process context.	 */

/**
 * isci_abort_task_process_cb() - This is a helper function for the abort task
 *    TMF command.  It manages the request state with respect to the successful
 *    transmission / completion of the abort task request.
 * @cb_state: This parameter specifies when this function was called - after
 *    the TMF request has been started and after it has timed-out.
 * @tmf: This parameter specifies the TMF in progress.
 *
 *
 */
static void isci_abort_task_process_cb(
	enum isci_tmf_cb_state cb_state,
	struct isci_tmf *tmf,
	void *cb_data)
{
	struct isci_request *old_request;

	old_request = (struct isci_request *)cb_data;

	dev_dbg(&old_request->isci_host->pdev->dev,
		"%s: tmf=%p, old_request=%p\n",
		__func__, tmf, old_request);

	switch (cb_state) {

	case isci_tmf_started:
		/* The TMF has been started.  Nothing to do here, since the
		 * request state was already set to "aborted" by the abort
		 * task function.
		 */
1003 1004
		if ((old_request->status != aborted)
			&& (old_request->status != completed))
D
Dan Williams 已提交
1005
			dev_dbg(&old_request->isci_host->pdev->dev,
1006 1007
				"%s: Bad request status (%d): tmf=%p, old_request=%p\n",
				__func__, old_request->status, tmf, old_request);
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
		break;

	case isci_tmf_timed_out:

		/* Set the task's state to "aborting", since the abort task
		 * function thread set it to "aborted" (above) in anticipation
		 * of the task management request working correctly.  Since the
		 * timeout has now fired, the TMF request failed.  We set the
		 * state such that the request completion will indicate the
		 * device is no longer present.
		 */
		isci_request_change_state(old_request, aborting);
		break;

	default:
D
Dan Williams 已提交
1023
		dev_dbg(&old_request->isci_host->pdev->dev,
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
			"%s: Bad cb_state (%d): tmf=%p, old_request=%p\n",
			__func__, cb_state, tmf, old_request);
		break;
	}
}

/**
 * isci_task_abort_task() - This function is one of the SAS Domain Template
 *    functions. This function is called by libsas to abort a specified task.
 * @task: This parameter specifies the SAS task to abort.
 *
 * status, zero indicates success.
 */
int isci_task_abort_task(struct sas_task *task)
{
1039
	struct isci_host *isci_host = dev_to_ihost(task->dev);
1040
	DECLARE_COMPLETION_ONSTACK(aborted_io_completion);
1041 1042
	struct isci_request       *old_request = NULL;
	enum isci_request_status  old_state;
1043
	struct isci_remote_device *isci_device = NULL;
1044 1045 1046 1047
	struct isci_tmf           tmf;
	int                       ret = TMF_RESP_FUNC_FAILED;
	unsigned long             flags;
	bool                      any_dev_reset = false;
1048 1049 1050 1051 1052 1053

	/* Get the isci_request reference from the task.  Note that
	 * this check does not depend on the pending request list
	 * in the device, because tasks driving resets may land here
	 * after completion in the core.
	 */
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
	spin_lock_irqsave(&isci_host->scic_lock, flags);
	spin_lock(&task->task_state_lock);

	old_request = task->lldd_task;

	/* If task is already done, the request isn't valid */
	if (!(task->task_state_flags & SAS_TASK_STATE_DONE) &&
	    (task->task_state_flags & SAS_TASK_AT_INITIATOR) &&
	    old_request)
		isci_device = isci_lookup_device(task->dev);

	spin_unlock(&task->task_state_lock);
	spin_unlock_irqrestore(&isci_host->scic_lock, flags);
1067 1068 1069 1070

	dev_dbg(&isci_host->pdev->dev,
		"%s: task = %p\n", __func__, task);

1071 1072
	if (!isci_device || !old_request)
		goto out;
1073

D
Dan Williams 已提交
1074 1075
	set_bit(IDEV_EH, &isci_device->flags);

1076 1077 1078 1079
	/* This version of the driver will fail abort requests for
	 * SATA/STP.  Failing the abort request this way will cause the
	 * SCSI error handler thread to escalate to LUN reset
	 */
1080
	if (sas_protocol_ata(task->task_proto)) {
D
Dan Williams 已提交
1081
		dev_dbg(&isci_host->pdev->dev,
1082 1083 1084
			    " task %p is for a STP/SATA device;"
			    " returning TMF_RESP_FUNC_FAILED\n"
			    " to cause a LUN reset...\n", task);
1085
		goto out;
1086 1087 1088 1089 1090
	}

	dev_dbg(&isci_host->pdev->dev,
		"%s: old_request == %p\n", __func__, old_request);

1091
	any_dev_reset = isci_device_is_reset_pending(isci_host, isci_device);
1092

1093 1094
	spin_lock_irqsave(&task->task_state_lock, flags);

1095
	any_dev_reset = any_dev_reset || (task->task_state_flags & SAS_TASK_NEED_DEV_RESET);
1096 1097 1098 1099 1100 1101

	/* If the extraction of the request reference from the task
	 * failed, then the request has been completed (or if there is a
	 * pending reset then this abort request function must be failed
	 * in order to escalate to the target reset).
	 */
1102
	if ((old_request == NULL) || any_dev_reset) {
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114

		/* If the device reset task flag is set, fail the task
		 * management request.  Otherwise, the original request
		 * has completed.
		 */
		if (any_dev_reset) {

			/* Turn off the task's DONE to make sure this
			 * task is escalated to a target reset.
			 */
			task->task_state_flags &= ~SAS_TASK_STATE_DONE;

1115 1116 1117 1118 1119
			/* Make the reset happen as soon as possible. */
			task->task_state_flags |= SAS_TASK_NEED_DEV_RESET;

			spin_unlock_irqrestore(&task->task_state_lock, flags);

1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
			/* Fail the task management request in order to
			 * escalate to the target reset.
			 */
			ret = TMF_RESP_FUNC_FAILED;

			dev_dbg(&isci_host->pdev->dev,
				"%s: Failing task abort in order to "
				"escalate to target reset because\n"
				"SAS_TASK_NEED_DEV_RESET is set for "
				"task %p on dev %p\n",
				__func__, task, isci_device);


1133
		} else {
1134 1135 1136 1137 1138 1139 1140
			/* The request has already completed and there
			 * is nothing to do here other than to set the task
			 * done bit, and indicate that the task abort function
			 * was sucessful.
			 */
			isci_set_task_doneflags(task);

1141
			spin_unlock_irqrestore(&task->task_state_lock, flags);
1142

1143
			ret = TMF_RESP_FUNC_COMPLETE;
1144

1145 1146 1147
			dev_dbg(&isci_host->pdev->dev,
				"%s: abort task not needed for %p\n",
				__func__, task);
1148
		}
1149
		goto out;
1150
	} else {
1151
		spin_unlock_irqrestore(&task->task_state_lock, flags);
1152
	}
1153 1154 1155

	spin_lock_irqsave(&isci_host->scic_lock, flags);

1156
	/* Check the request status and change to "aborted" if currently
1157
	 * "starting"; if true then set the I/O kernel completion
1158 1159
	 * struct that will be triggered when the request completes.
	 */
1160 1161 1162
	old_state = isci_task_validate_request_to_abort(
				old_request, isci_host, isci_device,
				&aborted_io_completion);
1163 1164 1165
	if ((old_state != started) &&
	    (old_state != completed) &&
	    (old_state != aborting)) {
1166 1167 1168

		spin_unlock_irqrestore(&isci_host->scic_lock, flags);

1169 1170 1171 1172 1173 1174 1175
		/* The request was already being handled by someone else (because
		* they got to set the state away from started).
		*/
		dev_dbg(&isci_host->pdev->dev,
			"%s:  device = %p; old_request %p already being aborted\n",
			__func__,
			isci_device, old_request);
1176 1177
		ret = TMF_RESP_FUNC_COMPLETE;
		goto out;
1178
	}
D
Dan Williams 已提交
1179 1180
	if (task->task_proto == SAS_PROTOCOL_SMP ||
	    test_bit(IREQ_COMPLETE_IN_TARGET, &old_request->flags)) {
1181 1182 1183

		spin_unlock_irqrestore(&isci_host->scic_lock, flags);

1184 1185 1186 1187
		dev_dbg(&isci_host->pdev->dev,
			"%s: SMP request (%d)"
			" or complete_in_target (%d), thus no TMF\n",
			__func__, (task->task_proto == SAS_PROTOCOL_SMP),
D
Dan Williams 已提交
1188
			test_bit(IREQ_COMPLETE_IN_TARGET, &old_request->flags));
1189

1190 1191 1192 1193 1194 1195
		/* Set the state on the task. */
		isci_task_all_done(task);

		ret = TMF_RESP_FUNC_COMPLETE;

		/* Stopping and SMP devices are not sent a TMF, and are not
1196
		 * reset, but the outstanding I/O request is terminated below.
1197 1198 1199
		 */
	} else {
		/* Fill in the tmf stucture */
1200
		isci_task_build_abort_task_tmf(&tmf, isci_tmf_ssp_task_abort,
1201 1202
					       isci_abort_task_process_cb,
					       old_request);
1203 1204 1205 1206

		spin_unlock_irqrestore(&isci_host->scic_lock, flags);

		#define ISCI_ABORT_TASK_TIMEOUT_MS 500 /* half second timeout. */
1207
		ret = isci_task_execute_tmf(isci_host, isci_device, &tmf,
1208 1209
					    ISCI_ABORT_TASK_TIMEOUT_MS);

1210
		if (ret != TMF_RESP_FUNC_COMPLETE)
D
Dan Williams 已提交
1211
			dev_dbg(&isci_host->pdev->dev,
1212 1213 1214
				"%s: isci_task_send_tmf failed\n",
				__func__);
	}
1215
	if (ret == TMF_RESP_FUNC_COMPLETE) {
D
Dan Williams 已提交
1216
		set_bit(IREQ_COMPLETE_IN_TARGET, &old_request->flags);
1217

1218 1219 1220
		/* Clean up the request on our side, and wait for the aborted
		 * I/O to complete.
		 */
1221
		isci_terminate_request_core(isci_host, isci_device, old_request);
1222
	}
1223

1224 1225
	/* Make sure we do not leave a reference to aborted_io_completion */
	old_request->io_request_completion = NULL;
1226 1227
 out:
	isci_put_device(isci_device);
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
	return ret;
}

/**
 * isci_task_abort_task_set() - This function is one of the SAS Domain Template
 *    functions. This is one of the Task Management functoins called by libsas,
 *    to abort all task for the given lun.
 * @d_device: This parameter specifies the domain device associated with this
 *    request.
 * @lun: This parameter specifies the lun associated with this request.
 *
 * status, zero indicates success.
 */
int isci_task_abort_task_set(
	struct domain_device *d_device,
	u8 *lun)
{
	return TMF_RESP_FUNC_FAILED;
}


/**
 * isci_task_clear_aca() - This function is one of the SAS Domain Template
 *    functions. This is one of the Task Management functoins called by libsas.
 * @d_device: This parameter specifies the domain device associated with this
 *    request.
 * @lun: This parameter specifies the lun	 associated with this request.
 *
 * status, zero indicates success.
 */
int isci_task_clear_aca(
	struct domain_device *d_device,
	u8 *lun)
{
	return TMF_RESP_FUNC_FAILED;
}



/**
 * isci_task_clear_task_set() - This function is one of the SAS Domain Template
 *    functions. This is one of the Task Management functoins called by libsas.
 * @d_device: This parameter specifies the domain device associated with this
 *    request.
 * @lun: This parameter specifies the lun	 associated with this request.
 *
 * status, zero indicates success.
 */
int isci_task_clear_task_set(
	struct domain_device *d_device,
	u8 *lun)
{
	return TMF_RESP_FUNC_FAILED;
}


/**
 * isci_task_query_task() - This function is implemented to cause libsas to
 *    correctly escalate the failed abort to a LUN or target reset (this is
 *    because sas_scsi_find_task libsas function does not correctly interpret
 *    all return codes from the abort task call).  When TMF_RESP_FUNC_SUCC is
 *    returned, libsas turns this into a LUN reset; when FUNC_FAILED is
 *    returned, libsas will turn this into a target reset
 * @task: This parameter specifies the sas task being queried.
 * @lun: This parameter specifies the lun associated with this request.
 *
 * status, zero indicates success.
 */
int isci_task_query_task(
	struct sas_task *task)
{
	/* See if there is a pending device reset for this device. */
	if (task->task_state_flags & SAS_TASK_NEED_DEV_RESET)
		return TMF_RESP_FUNC_FAILED;
	else
		return TMF_RESP_FUNC_SUCC;
}

1306
/*
1307 1308
 * isci_task_request_complete() - This function is called by the sci core when
 *    an task request completes.
1309 1310
 * @ihost: This parameter specifies the ISCI host object
 * @ireq: This parameter is the completed isci_request object.
1311 1312 1313 1314 1315
 * @completion_status: This parameter specifies the completion status from the
 *    sci core.
 *
 * none.
 */
1316 1317 1318 1319
void
isci_task_request_complete(struct isci_host *ihost,
			   struct isci_request *ireq,
			   enum sci_task_status completion_status)
1320
{
1321
	struct isci_tmf *tmf = isci_request_access_tmf(ireq);
1322 1323
	struct completion *tmf_complete = NULL;
	struct completion *request_complete = ireq->io_request_completion;
1324

1325
	dev_dbg(&ihost->pdev->dev,
1326
		"%s: request = %p, status=%d\n",
1327
		__func__, ireq, completion_status);
1328

1329
	isci_request_change_state(ireq, completed);
1330

D
Dan Williams 已提交
1331
	set_bit(IREQ_COMPLETE_IN_TARGET, &ireq->flags);
1332

1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
	if (tmf) {
		tmf->status = completion_status;

		if (tmf->proto == SAS_PROTOCOL_SSP) {
			memcpy(&tmf->resp.resp_iu,
			       &ireq->ssp.rsp,
			       SSP_RESP_IU_MAX_SIZE);
		} else if (tmf->proto == SAS_PROTOCOL_SATA) {
			memcpy(&tmf->resp.d2h_fis,
			       &ireq->stp.rsp,
			       sizeof(struct dev_to_host_fis));
		}
		/* PRINT_TMF( ((struct isci_tmf *)request->task)); */
		tmf_complete = tmf->complete;
1347
	}
1348
	sci_controller_complete_io(ihost, ireq->target_device, ireq);
1349
	/* set the 'terminated' flag handle to make sure it cannot be terminated
1350 1351
	 *  or completed again.
	 */
D
Dan Williams 已提交
1352
	set_bit(IREQ_TERMINATED, &ireq->flags);
1353

1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
	/* As soon as something is in the terminate path, deallocation is
	 * managed there.  Note that the final non-managed state of a task
	 * request is "completed".
	 */
	if ((ireq->status == completed) ||
	    !isci_request_is_dealloc_managed(ireq->status)) {
		isci_request_change_state(ireq, unallocated);
		isci_free_tag(ihost, ireq->io_tag);
		list_del_init(&ireq->dev_node);
	}
1364

1365 1366 1367 1368
	/* "request_complete" is set if the task was being terminated. */
	if (request_complete)
		complete(request_complete);

1369
	/* The task management part completes last. */
1370 1371
	if (tmf_complete)
		complete(tmf_complete);
1372 1373
}

1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
static void isci_smp_task_timedout(unsigned long _task)
{
	struct sas_task *task = (void *) _task;
	unsigned long flags;

	spin_lock_irqsave(&task->task_state_lock, flags);
	if (!(task->task_state_flags & SAS_TASK_STATE_DONE))
		task->task_state_flags |= SAS_TASK_STATE_ABORTED;
	spin_unlock_irqrestore(&task->task_state_lock, flags);

	complete(&task->completion);
}

static void isci_smp_task_done(struct sas_task *task)
{
	if (!del_timer(&task->timer))
		return;
	complete(&task->completion);
}

static int isci_smp_execute_task(struct isci_host *ihost,
				 struct domain_device *dev, void *req,
				 int req_size, void *resp, int resp_size)
{
	int res, retry;
	struct sas_task *task = NULL;

	for (retry = 0; retry < 3; retry++) {
1402
		task = sas_alloc_task(GFP_KERNEL);
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
		if (!task)
			return -ENOMEM;

		task->dev = dev;
		task->task_proto = dev->tproto;
		sg_init_one(&task->smp_task.smp_req, req, req_size);
		sg_init_one(&task->smp_task.smp_resp, resp, resp_size);

		task->task_done = isci_smp_task_done;

		task->timer.data = (unsigned long) task;
		task->timer.function = isci_smp_task_timedout;
		task->timer.expires = jiffies + 10*HZ;
		add_timer(&task->timer);

		res = isci_task_execute_task(task, 1, GFP_KERNEL);

		if (res) {
			del_timer(&task->timer);
D
Dan Williams 已提交
1422
			dev_dbg(&ihost->pdev->dev,
1423 1424 1425 1426 1427 1428 1429 1430
				"%s: executing SMP task failed:%d\n",
				__func__, res);
			goto ex_err;
		}

		wait_for_completion(&task->completion);
		res = -ECOMM;
		if ((task->task_state_flags & SAS_TASK_STATE_ABORTED)) {
D
Dan Williams 已提交
1431
			dev_dbg(&ihost->pdev->dev,
1432 1433 1434 1435
				"%s: smp task timed out or aborted\n",
				__func__);
			isci_task_abort_task(task);
			if (!(task->task_state_flags & SAS_TASK_STATE_DONE)) {
D
Dan Williams 已提交
1436
				dev_dbg(&ihost->pdev->dev,
1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458
					"%s: SMP task aborted and not done\n",
					__func__);
				goto ex_err;
			}
		}
		if (task->task_status.resp == SAS_TASK_COMPLETE &&
		    task->task_status.stat == SAM_STAT_GOOD) {
			res = 0;
			break;
		}
		if (task->task_status.resp == SAS_TASK_COMPLETE &&
		      task->task_status.stat == SAS_DATA_UNDERRUN) {
			/* no error, but return the number of bytes of
			* underrun */
			res = task->task_status.residual;
			break;
		}
		if (task->task_status.resp == SAS_TASK_COMPLETE &&
		      task->task_status.stat == SAS_DATA_OVERRUN) {
			res = -EMSGSIZE;
			break;
		} else {
D
Dan Williams 已提交
1459
			dev_dbg(&ihost->pdev->dev,
1460 1461 1462 1463 1464
				"%s: task to dev %016llx response: 0x%x "
				"status 0x%x\n", __func__,
				SAS_ADDR(dev->sas_addr),
				task->task_status.resp,
				task->task_status.stat);
1465
			sas_free_task(task);
1466 1467 1468 1469 1470
			task = NULL;
		}
	}
ex_err:
	BUG_ON(retry == 3 && task != NULL);
1471
	sas_free_task(task);
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552
	return res;
}

#define DISCOVER_REQ_SIZE  16
#define DISCOVER_RESP_SIZE 56

int isci_smp_get_phy_attached_dev_type(struct isci_host *ihost,
				       struct domain_device *dev,
				       int phy_id, int *adt)
{
	struct smp_resp *disc_resp;
	u8 *disc_req;
	int res;

	disc_resp = kzalloc(DISCOVER_RESP_SIZE, GFP_KERNEL);
	if (!disc_resp)
		return -ENOMEM;

	disc_req = kzalloc(DISCOVER_REQ_SIZE, GFP_KERNEL);
	if (disc_req) {
		disc_req[0] = SMP_REQUEST;
		disc_req[1] = SMP_DISCOVER;
		disc_req[9] = phy_id;
	} else {
		kfree(disc_resp);
		return -ENOMEM;
	}
	res = isci_smp_execute_task(ihost, dev, disc_req, DISCOVER_REQ_SIZE,
				    disc_resp, DISCOVER_RESP_SIZE);
	if (!res) {
		if (disc_resp->result != SMP_RESP_FUNC_ACC)
			res = disc_resp->result;
		else
			*adt = disc_resp->disc.attached_dev_type;
	}
	kfree(disc_req);
	kfree(disc_resp);

	return res;
}

static void isci_wait_for_smp_phy_reset(struct isci_remote_device *idev, int phy_num)
{
	struct domain_device *dev = idev->domain_dev;
	struct isci_port *iport = idev->isci_port;
	struct isci_host *ihost = iport->isci_host;
	int res, iteration = 0, attached_device_type;
	#define STP_WAIT_MSECS 25000
	unsigned long tmo = msecs_to_jiffies(STP_WAIT_MSECS);
	unsigned long deadline = jiffies + tmo;
	enum {
		SMP_PHYWAIT_PHYDOWN,
		SMP_PHYWAIT_PHYUP,
		SMP_PHYWAIT_DONE
	} phy_state = SMP_PHYWAIT_PHYDOWN;

	/* While there is time, wait for the phy to go away and come back */
	while (time_is_after_jiffies(deadline) && phy_state != SMP_PHYWAIT_DONE) {
		int event = atomic_read(&iport->event);

		++iteration;

		tmo = wait_event_timeout(ihost->eventq,
					 event != atomic_read(&iport->event) ||
					 !test_bit(IPORT_BCN_BLOCKED, &iport->flags),
					 tmo);
		/* link down, stop polling */
		if (!test_bit(IPORT_BCN_BLOCKED, &iport->flags))
			break;

		dev_dbg(&ihost->pdev->dev,
			"%s: iport %p, iteration %d,"
			" phase %d: time_remaining %lu, bcns = %d\n",
			__func__, iport, iteration, phy_state,
			tmo, test_bit(IPORT_BCN_PENDING, &iport->flags));

		res = isci_smp_get_phy_attached_dev_type(ihost, dev, phy_num,
							 &attached_device_type);
		tmo = deadline - jiffies;

		if (res) {
D
Dan Williams 已提交
1553
			dev_dbg(&ihost->pdev->dev,
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
				 "%s: iteration %d, phase %d:"
				 " SMP error=%d, time_remaining=%lu\n",
				 __func__, iteration, phy_state, res, tmo);
			break;
		}
		dev_dbg(&ihost->pdev->dev,
			"%s: iport %p, iteration %d,"
			" phase %d: time_remaining %lu, bcns = %d, "
			"attdevtype = %x\n",
			__func__, iport, iteration, phy_state,
			tmo, test_bit(IPORT_BCN_PENDING, &iport->flags),
			attached_device_type);

		switch (phy_state) {
		case SMP_PHYWAIT_PHYDOWN:
			/* Has the device gone away? */
			if (!attached_device_type)
				phy_state = SMP_PHYWAIT_PHYUP;

			break;

		case SMP_PHYWAIT_PHYUP:
			/* Has the device come back? */
			if (attached_device_type)
				phy_state = SMP_PHYWAIT_DONE;
			break;

		case SMP_PHYWAIT_DONE:
			break;
		}

	}
	dev_dbg(&ihost->pdev->dev, "%s: done\n",  __func__);
}

1589
static int isci_reset_device(struct isci_host *ihost,
1590
			     struct isci_remote_device *idev)
1591
{
1592
	struct sas_phy *phy = sas_find_local_phy(idev->domain_dev);
1593
	struct isci_port *iport = idev->isci_port;
1594
	enum sci_status status;
D
Dan Williams 已提交
1595 1596
	unsigned long flags;
	int rc;
1597

D
Dan Williams 已提交
1598
	dev_dbg(&ihost->pdev->dev, "%s: idev %p\n", __func__, idev);
1599

D
Dan Williams 已提交
1600
	spin_lock_irqsave(&ihost->scic_lock, flags);
1601
	status = sci_remote_device_reset(idev);
1602
	if (status != SCI_SUCCESS) {
D
Dan Williams 已提交
1603
		spin_unlock_irqrestore(&ihost->scic_lock, flags);
1604

D
Dan Williams 已提交
1605
		dev_dbg(&ihost->pdev->dev,
1606
			 "%s: sci_remote_device_reset(%p) returned %d!\n",
D
Dan Williams 已提交
1607
			 __func__, idev, status);
1608 1609 1610

		return TMF_RESP_FUNC_FAILED;
	}
D
Dan Williams 已提交
1611
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
1612 1613

	/* Make sure all pending requests are able to be fully terminated. */
D
Dan Williams 已提交
1614
	isci_device_clear_reset_pending(ihost, idev);
1615

1616 1617 1618 1619
	/* If this is a device on an expander, disable BCN processing. */
	if (!scsi_is_sas_phy_local(phy))
		set_bit(IPORT_BCN_BLOCKED, &iport->flags);

1620
	rc = sas_phy_reset(phy, true);
1621

D
Dan Williams 已提交
1622 1623
	/* Terminate in-progress I/O now. */
	isci_remote_device_nuke_requests(ihost, idev);
1624

1625
	/* Since all pending TCs have been cleaned, resume the RNC. */
D
Dan Williams 已提交
1626
	spin_lock_irqsave(&ihost->scic_lock, flags);
1627
	status = sci_remote_device_reset_complete(idev);
D
Dan Williams 已提交
1628
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
1629

1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
	/* If this is a device on an expander, bring the phy back up. */
	if (!scsi_is_sas_phy_local(phy)) {
		/* A phy reset will cause the device to go away then reappear.
		 * Since libsas will take action on incoming BCNs (eg. remove
		 * a device going through an SMP phy-control driven reset),
		 * we need to wait until the phy comes back up before letting
		 * discovery proceed in libsas.
		 */
		isci_wait_for_smp_phy_reset(idev, phy->number);

		spin_lock_irqsave(&ihost->scic_lock, flags);
		isci_port_bcn_enable(ihost, idev->isci_port);
		spin_unlock_irqrestore(&ihost->scic_lock, flags);
	}
1644

D
Dan Williams 已提交
1645
	if (status != SCI_SUCCESS) {
D
Dan Williams 已提交
1646
		dev_dbg(&ihost->pdev->dev,
1647
			 "%s: sci_remote_device_reset_complete(%p) "
D
Dan Williams 已提交
1648
			 "returned %d!\n", __func__, idev, status);
1649 1650
	}

D
Dan Williams 已提交
1651
	dev_dbg(&ihost->pdev->dev, "%s: idev %p complete.\n", __func__, idev);
1652

D
Dan Williams 已提交
1653 1654
	return rc;
}
1655

D
Dan Williams 已提交
1656 1657 1658 1659 1660
int isci_task_I_T_nexus_reset(struct domain_device *dev)
{
	struct isci_host *ihost = dev_to_ihost(dev);
	struct isci_remote_device *idev;
	unsigned long flags;
1661
	int ret;
D
Dan Williams 已提交
1662 1663

	spin_lock_irqsave(&ihost->scic_lock, flags);
1664
	idev = isci_lookup_device(dev);
D
Dan Williams 已提交
1665 1666
	spin_unlock_irqrestore(&ihost->scic_lock, flags);

1667 1668 1669 1670
	if (!idev || !test_bit(IDEV_EH, &idev->flags)) {
		ret = TMF_RESP_FUNC_COMPLETE;
		goto out;
	}
D
Dan Williams 已提交
1671

1672
	ret = isci_reset_device(ihost, idev);
1673 1674 1675
 out:
	isci_put_device(idev);
	return ret;
D
Dan Williams 已提交
1676 1677 1678 1679 1680
}

int isci_bus_reset_handler(struct scsi_cmnd *cmd)
{
	struct domain_device *dev = sdev_to_domain_dev(cmd->device);
1681 1682 1683
	struct isci_host *ihost = dev_to_ihost(dev);
	struct isci_remote_device *idev;
	unsigned long flags;
1684
	int ret;
1685

1686 1687 1688 1689 1690 1691 1692 1693 1694
	spin_lock_irqsave(&ihost->scic_lock, flags);
	idev = isci_lookup_device(dev);
	spin_unlock_irqrestore(&ihost->scic_lock, flags);

	if (!idev) {
		ret = TMF_RESP_FUNC_COMPLETE;
		goto out;
	}

1695
	ret = isci_reset_device(ihost, idev);
1696 1697 1698
 out:
	isci_put_device(idev);
	return ret;
1699
}