remote_device.c 70.2 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
/*
 * 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.
 */
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 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 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 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 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 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 831 832 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 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
#include "intel_sas.h"
#include "isci.h"
#include "port.h"
#include "remote_device.h"
#include "request.h"
#include "scic_controller.h"
#include "scic_io_request.h"
#include "scic_phy.h"
#include "scic_port.h"
#include "scic_sds_controller.h"
#include "scic_sds_phy.h"
#include "scic_sds_port.h"
#include "remote_node_context.h"
#include "scic_sds_request.h"
#include "sci_environment.h"
#include "sci_util.h"
#include "scu_event_codes.h"
#include "task.h"

enum sci_status scic_remote_device_stop(
	struct scic_sds_remote_device *sci_dev,
	u32 timeout)
{
	return sci_dev->state_handlers->stop_handler(sci_dev);
}


enum sci_status scic_remote_device_reset(
	struct scic_sds_remote_device *sci_dev)
{
	return sci_dev->state_handlers->reset_handler(sci_dev);
}


enum sci_status scic_remote_device_reset_complete(
	struct scic_sds_remote_device *sci_dev)
{
	return sci_dev->state_handlers->reset_complete_handler(sci_dev);
}


enum sas_linkrate scic_remote_device_get_connection_rate(
	struct scic_sds_remote_device *sci_dev)
{
	return sci_dev->connection_rate;
}


void scic_remote_device_get_protocols(
	struct scic_sds_remote_device *sci_dev,
	struct smp_discover_response_protocols *pr)
{
	pr->u.all = sci_dev->target_protocols.u.all;
}

#if !defined(DISABLE_ATAPI)
bool scic_remote_device_is_atapi(struct scic_sds_remote_device *sci_dev)
{
	return sci_dev->is_atapi;
}
#endif


/**
 *
 *
 * Remote device timer requirements
 */
#define SCIC_SDS_REMOTE_DEVICE_MINIMUM_TIMER_COUNT (0)
#define SCIC_SDS_REMOTE_DEVICE_MAXIMUM_TIMER_COUNT (SCI_MAX_REMOTE_DEVICES)


/**
 *
 * @sci_dev: The remote device for which the suspend is being requested.
 *
 * This method invokes the remote device suspend state handler. enum sci_status
 */
enum sci_status scic_sds_remote_device_suspend(
	struct scic_sds_remote_device *sci_dev,
	u32 suspend_type)
{
	return sci_dev->state_handlers->suspend_handler(sci_dev, suspend_type);
}

/**
 *
 * @sci_dev: The remote device for which the event handling is being
 *    requested.
 * @frame_index: This is the frame index that is being processed.
 *
 * This method invokes the frame handler for the remote device state machine
 * enum sci_status
 */
enum sci_status scic_sds_remote_device_frame_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 frame_index)
{
	return sci_dev->state_handlers->frame_handler(sci_dev, frame_index);
}

/**
 *
 * @sci_dev: The remote device for which the event handling is being
 *    requested.
 * @event_code: This is the event code that is to be processed.
 *
 * This method invokes the remote device event handler. enum sci_status
 */
enum sci_status scic_sds_remote_device_event_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 event_code)
{
	return sci_dev->state_handlers->event_handler(sci_dev, event_code);
}

/**
 *
 * @controller: The controller that is starting the io request.
 * @sci_dev: The remote device for which the start io handling is being
 *    requested.
 * @io_request: The io request that is being started.
 *
 * This method invokes the remote device start io handler. enum sci_status
 */
enum sci_status scic_sds_remote_device_start_io(
	struct scic_sds_controller *controller,
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *io_request)
{
	return sci_dev->state_handlers->start_io_handler(
		       sci_dev, io_request);
}

/**
 *
 * @controller: The controller that is completing the io request.
 * @sci_dev: The remote device for which the complete io handling is being
 *    requested.
 * @io_request: The io request that is being completed.
 *
 * This method invokes the remote device complete io handler. enum sci_status
 */
enum sci_status scic_sds_remote_device_complete_io(
	struct scic_sds_controller *controller,
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *io_request)
{
	return sci_dev->state_handlers->complete_io_handler(
		       sci_dev, io_request);
}

/**
 *
 * @controller: The controller that is starting the task request.
 * @sci_dev: The remote device for which the start task handling is being
 *    requested.
 * @io_request: The task request that is being started.
 *
 * This method invokes the remote device start task handler. enum sci_status
 */
enum sci_status scic_sds_remote_device_start_task(
	struct scic_sds_controller *controller,
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *io_request)
{
	return sci_dev->state_handlers->start_task_handler(
		       sci_dev, io_request);
}

/**
 *
 * @controller: The controller that is completing the task request.
 * @sci_dev: The remote device for which the complete task handling is
 *    being requested.
 * @io_request: The task request that is being completed.
 *
 * This method invokes the remote device complete task handler. enum sci_status
 */

/**
 *
 * @sci_dev:
 * @request:
 *
 * This method takes the request and bulids an appropriate SCU context for the
 * request and then requests the controller to post the request. none
 */
void scic_sds_remote_device_post_request(
	struct scic_sds_remote_device *sci_dev,
	u32 request)
{
	u32 context;

	context = scic_sds_remote_device_build_command_context(sci_dev, request);

	scic_sds_controller_post_request(
		scic_sds_remote_device_get_controller(sci_dev),
		context
		);
}

#if !defined(DISABLE_ATAPI)
/**
 *
 * @sci_dev: The device to be checked.
 *
 * This method check the signature fis of a stp device to decide whether a
 * device is atapi or not. true if a device is atapi device. False if a device
 * is not atapi.
 */
bool scic_sds_remote_device_is_atapi(
	struct scic_sds_remote_device *sci_dev)
{
	if (!sci_dev->target_protocols.u.bits.attached_stp_target)
		return false;
	else if (sci_dev->is_direct_attached) {
		struct scic_sds_phy *phy;
		struct scic_sata_phy_properties properties;
		struct sata_fis_reg_d2h *signature_fis;
		phy = scic_sds_port_get_a_connected_phy(sci_dev->owning_port);
		scic_sata_phy_get_properties(phy, &properties);

		/* decode the signature fis. */
		signature_fis = &(properties.signature_fis);

		if ((signature_fis->sector_count  == 0x01)
		    && (signature_fis->lba_low       == 0x01)
		    && (signature_fis->lba_mid       == 0x14)
		    && (signature_fis->lba_high      == 0xEB)
		    && ((signature_fis->device & 0x5F) == 0x00)
		    ) {
			/* An ATA device supporting the PACKET command set. */
			return true;
		} else
			return false;
	} else {
		/* Expander supported ATAPI device is not currently supported. */
		return false;
	}
}
#endif

/**
 *
 * @user_parameter: This is cast to a remote device object.
 *
 * This method is called once the remote node context is ready to be freed.
 * The remote device can now report that its stop operation is complete. none
 */
static void scic_sds_cb_remote_device_rnc_destruct_complete(
	void *user_parameter)
{
	struct scic_sds_remote_device *sci_dev;

	sci_dev = (struct scic_sds_remote_device *)user_parameter;

	BUG_ON(sci_dev->started_request_count != 0);

	sci_base_state_machine_change_state(&sci_dev->state_machine,
					    SCI_BASE_REMOTE_DEVICE_STATE_STOPPED);
}

/**
 *
 * @user_parameter: This is cast to a remote device object.
 *
 * This method is called once the remote node context has transisitioned to a
 * ready state.  This is the indication that the remote device object can also
 * transition to ready. none
 */
static void scic_sds_remote_device_resume_complete_handler(
	void *user_parameter)
{
	struct scic_sds_remote_device *sci_dev;

	sci_dev = (struct scic_sds_remote_device *)user_parameter;

	if (
		sci_base_state_machine_get_state(&sci_dev->state_machine)
		!= SCI_BASE_REMOTE_DEVICE_STATE_READY
		) {
		sci_base_state_machine_change_state(
			&sci_dev->state_machine,
			SCI_BASE_REMOTE_DEVICE_STATE_READY
			);
	}
}

/**
 *
 * @device: This parameter specifies the device for which the request is being
 *    started.
 * @request: This parameter specifies the request being started.
 * @status: This parameter specifies the current start operation status.
 *
 * This method will perform the STP request start processing common to IO
 * requests and task requests of all types. none
 */
void scic_sds_remote_device_start_request(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *sci_req,
	enum sci_status status)
{
	/* We still have a fault in starting the io complete it on the port */
	if (status == SCI_SUCCESS)
		scic_sds_remote_device_increment_request_count(sci_dev);
	else{
		sci_dev->owning_port->state_handlers->complete_io_handler(
			sci_dev->owning_port, sci_dev, sci_req
			);
	}
}


/**
 *
 * @request: This parameter specifies the request being continued.
 *
 * This method will continue to post tc for a STP request. This method usually
 * serves as a callback when RNC gets resumed during a task management
 * sequence. none
 */
void scic_sds_remote_device_continue_request(void *dev)
{
	struct scic_sds_remote_device *sci_dev = dev;

	/* we need to check if this request is still valid to continue. */
	if (sci_dev->working_request)
		scic_controller_continue_io(sci_dev->working_request);
}

/**
 * This method will terminate all of the IO requests in the controllers IO
 *    request table that were targeted for this device.
 * @sci_dev: This parameter specifies the remote device for which to
 *    attempt to terminate all requests.
 *
 * This method returns an indication as to whether all requests were
 * successfully terminated.  If a single request fails to be terminated, then
 * this method will return the failure.
 */
static enum sci_status scic_sds_remote_device_terminate_requests(
	struct scic_sds_remote_device *sci_dev)
{
	enum sci_status status           = SCI_SUCCESS;
	enum sci_status terminate_status = SCI_SUCCESS;
	struct scic_sds_request *sci_req;
	u32 index;
	u32 request_count    = sci_dev->started_request_count;

	for (index = 0;
	     (index < SCI_MAX_IO_REQUESTS) && (request_count > 0);
	     index++) {
		sci_req = sci_dev->owning_port->owning_controller->io_request_table[index];

		if ((sci_req != NULL) && (sci_req->target_device == sci_dev)) {
			terminate_status = scic_controller_terminate_request(
				sci_dev->owning_port->owning_controller,
				sci_dev,
				sci_req
				);

			if (terminate_status != SCI_SUCCESS)
				status = terminate_status;

			request_count--;
		}
	}

	return status;
}

static enum sci_status
default_device_handler(struct scic_sds_remote_device *sci_dev,
		       const char *func)
{
	dev_warn(scirdev_to_dev(sci_dev),
		 "%s: in wrong state: %d\n", func,
		 sci_base_state_machine_get_state(&sci_dev->state_machine));
	return SCI_FAILURE_INVALID_STATE;
}

enum sci_status scic_sds_remote_device_default_start_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

static enum sci_status scic_sds_remote_device_default_stop_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_fail_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_destruct_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_reset_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_reset_complete_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_suspend_handler(
	struct scic_sds_remote_device *sci_dev, u32 suspend_type)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_resume_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return default_device_handler(sci_dev, __func__);
}

/**
 *
 * @device: The struct scic_sds_remote_device which is then cast into a
 *    struct scic_sds_remote_device.
 * @event_code: The event code that the struct scic_sds_controller wants the device
 *    object to process.
 *
 * This method is the default event handler.  It will call the RNC state
 * machine handler for any RNC events otherwise it will log a warning and
 * returns a failure. enum sci_status SCI_FAILURE_INVALID_STATE
 */
static enum sci_status  scic_sds_remote_device_core_event_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 event_code,
	bool is_ready_state)
{
	enum sci_status status;

	switch (scu_get_event_type(event_code)) {
	case SCU_EVENT_TYPE_RNC_OPS_MISC:
	case SCU_EVENT_TYPE_RNC_SUSPEND_TX:
	case SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX:
		status = scic_sds_remote_node_context_event_handler(&sci_dev->rnc, event_code);
		break;
	case SCU_EVENT_TYPE_PTX_SCHEDULE_EVENT:

		if (scu_get_event_code(event_code) == SCU_EVENT_IT_NEXUS_TIMEOUT) {
			status = SCI_SUCCESS;

			/* Suspend the associated RNC */
			scic_sds_remote_node_context_suspend(&sci_dev->rnc,
							      SCI_SOFTWARE_SUSPENSION,
							      NULL, NULL);

			dev_dbg(scirdev_to_dev(sci_dev),
				"%s: device: %p event code: %x: %s\n",
				__func__, sci_dev, event_code,
				(is_ready_state)
				? "I_T_Nexus_Timeout event"
				: "I_T_Nexus_Timeout event in wrong state");

			break;
		}
	/* Else, fall through and treat as unhandled... */

	default:
		dev_dbg(scirdev_to_dev(sci_dev),
			"%s: device: %p event code: %x: %s\n",
			__func__, sci_dev, event_code,
			(is_ready_state)
			? "unexpected event"
			: "unexpected event in wrong state");
		status = SCI_FAILURE_INVALID_STATE;
		break;
	}

	return status;
}
/**
 *
 * @device: The struct scic_sds_remote_device which is then cast into a
 *    struct scic_sds_remote_device.
 * @event_code: The event code that the struct scic_sds_controller wants the device
 *    object to process.
 *
 * This method is the default event handler.  It will call the RNC state
 * machine handler for any RNC events otherwise it will log a warning and
 * returns a failure. enum sci_status SCI_FAILURE_INVALID_STATE
 */
static enum sci_status  scic_sds_remote_device_default_event_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 event_code)
{
	return scic_sds_remote_device_core_event_handler(sci_dev,
							  event_code,
							  false);
}

/**
 *
 * @device: The struct scic_sds_remote_device which is then cast into a
 *    struct scic_sds_remote_device.
 * @frame_index: The frame index for which the struct scic_sds_controller wants this
 *    device object to process.
 *
 * This method is the default unsolicited frame handler.  It logs a warning,
 * releases the frame and returns a failure. enum sci_status
 * SCI_FAILURE_INVALID_STATE
 */
enum sci_status scic_sds_remote_device_default_frame_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 frame_index)
{
	dev_warn(scirdev_to_dev(sci_dev),
		 "%s: SCIC Remote Device requested to handle frame %x "
		 "while in wrong state %d\n",
		 __func__,
		 frame_index,
		 sci_base_state_machine_get_state(
			 &sci_dev->state_machine));

	/* Return the frame back to the controller */
	scic_sds_controller_release_frame(
		scic_sds_remote_device_get_controller(sci_dev), frame_index
		);

	return SCI_FAILURE_INVALID_STATE;
}

enum sci_status scic_sds_remote_device_default_start_request_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_complete_request_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	return default_device_handler(sci_dev, __func__);
}

enum sci_status scic_sds_remote_device_default_continue_request_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	return default_device_handler(sci_dev, __func__);
}

/**
 *
 * @device: The struct scic_sds_remote_device which is then cast into a
 *    struct scic_sds_remote_device.
 * @frame_index: The frame index for which the struct scic_sds_controller wants this
 *    device object to process.
 *
 * This method is a general ssp frame handler.  In most cases the device object
 * needs to route the unsolicited frame processing to the io request object.
 * This method decodes the tag for the io request object and routes the
 * unsolicited frame to that object. enum sci_status SCI_FAILURE_INVALID_STATE
 */
enum sci_status scic_sds_remote_device_general_frame_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 frame_index)
{
	enum sci_status result;
	struct sci_ssp_frame_header *frame_header;
	struct scic_sds_request *io_request;

	result = scic_sds_unsolicited_frame_control_get_header(
		&(scic_sds_remote_device_get_controller(sci_dev)->uf_control),
		frame_index,
		(void **)&frame_header
		);

	if (SCI_SUCCESS == result) {
		io_request = scic_sds_controller_get_io_request_from_tag(
			scic_sds_remote_device_get_controller(sci_dev), frame_header->tag);

		if ((io_request == NULL)
		    || (io_request->target_device != sci_dev)) {
			/*
			 * We could not map this tag to a valid IO request
			 * Just toss the frame and continue */
			scic_sds_controller_release_frame(
				scic_sds_remote_device_get_controller(sci_dev), frame_index
				);
		} else {
			/* The IO request is now in charge of releasing the frame */
			result = io_request->state_handlers->frame_handler(
				io_request, frame_index);
		}
	}

	return result;
}

/**
 *
 * @[in]: sci_dev This is the device object that is receiving the event.
 * @[in]: event_code The event code to process.
 *
 * This is a common method for handling events reported to the remote device
 * from the controller object. enum sci_status
 */
enum sci_status scic_sds_remote_device_general_event_handler(
	struct scic_sds_remote_device *sci_dev,
	u32 event_code)
{
	return scic_sds_remote_device_core_event_handler(sci_dev,
							  event_code,
							  true);
}

/*
 * *****************************************************************************
 * *  STOPPED STATE HANDLERS
 * ***************************************************************************** */

/**
 *
 * @device:
 *
 * This method takes the struct scic_sds_remote_device from a stopped state and
 * attempts to start it.   The RNC buffer for the device is constructed and the
 * device state machine is transitioned to the
 * SCIC_BASE_REMOTE_DEVICE_STATE_STARTING. enum sci_status SCI_SUCCESS if there is
 * an RNC buffer available to construct the remote device.
 * SCI_FAILURE_INSUFFICIENT_RESOURCES if there is no RNC buffer available in
 * which to construct the remote device.
 */
static enum sci_status scic_sds_remote_device_stopped_state_start_handler(
	struct scic_sds_remote_device *sci_dev)
{
	enum sci_status status;

	status = scic_sds_remote_node_context_resume(&sci_dev->rnc,
			scic_sds_remote_device_resume_complete_handler, sci_dev);

	if (status == SCI_SUCCESS)
		sci_base_state_machine_change_state(&sci_dev->state_machine,
						    SCI_BASE_REMOTE_DEVICE_STATE_STARTING);

	return status;
}

static enum sci_status scic_sds_remote_device_stopped_state_stop_handler(
	struct scic_sds_remote_device *sci_dev)
{
	return SCI_SUCCESS;
}

/**
 *
 * @sci_dev: The struct scic_sds_remote_device which is cast into a
 *    struct scic_sds_remote_device.
 *
 * This method will destruct a struct scic_sds_remote_device that is in a stopped
 * state.  This is the only state from which a destruct request will succeed.
 * The RNi for this struct scic_sds_remote_device is returned to the free pool and the
 * device object transitions to the SCI_BASE_REMOTE_DEVICE_STATE_FINAL.
 * enum sci_status SCI_SUCCESS
 */
static enum sci_status scic_sds_remote_device_stopped_state_destruct_handler(
	struct scic_sds_remote_device *sci_dev)
{
	struct scic_sds_controller *scic;

	scic = scic_sds_remote_device_get_controller(sci_dev);
	scic_sds_controller_free_remote_node_context(scic, sci_dev,
						     sci_dev->rnc.remote_node_index);
	sci_dev->rnc.remote_node_index = SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX;

	sci_base_state_machine_change_state(&sci_dev->state_machine,
					    SCI_BASE_REMOTE_DEVICE_STATE_FINAL);

	return SCI_SUCCESS;
}

/*
 * *****************************************************************************
 * *  STARTING STATE HANDLERS
 * ***************************************************************************** */

static enum sci_status scic_sds_remote_device_starting_state_stop_handler(
	struct scic_sds_remote_device *sci_dev)
{
	/*
	 * This device has not yet started so there had better be no IO requests
	 */
	BUG_ON(sci_dev->started_request_count != 0);

	/*
	 * Destroy the remote node context
	 */
	scic_sds_remote_node_context_destruct(&sci_dev->rnc,
		scic_sds_cb_remote_device_rnc_destruct_complete, sci_dev);

	/*
	 * Transition to the stopping state and wait for the remote node to
	 * complete being posted and invalidated.
	 */
	sci_base_state_machine_change_state(&sci_dev->state_machine,
					    SCI_BASE_REMOTE_DEVICE_STATE_STOPPING);

	return SCI_SUCCESS;
}

enum sci_status scic_sds_remote_device_ready_state_stop_handler(
	struct scic_sds_remote_device *sci_dev)
{
	enum sci_status status = SCI_SUCCESS;

	/* Request the parent state machine to transition to the stopping state */
	sci_base_state_machine_change_state(&sci_dev->state_machine,
					    SCI_BASE_REMOTE_DEVICE_STATE_STOPPING);

	if (sci_dev->started_request_count == 0) {
		scic_sds_remote_node_context_destruct(&sci_dev->rnc,
			scic_sds_cb_remote_device_rnc_destruct_complete,
			sci_dev);
	} else
		status = scic_sds_remote_device_terminate_requests(sci_dev);

	return status;
}

/**
 *
 * @device: The struct scic_sds_remote_device object which is cast to a
 *    struct scic_sds_remote_device object.
 *
 * This is the ready state device reset handler enum sci_status
 */
enum sci_status scic_sds_remote_device_ready_state_reset_handler(
	struct scic_sds_remote_device *sci_dev)
{
	/* Request the parent state machine to transition to the stopping state */
	sci_base_state_machine_change_state(&sci_dev->state_machine,
					    SCI_BASE_REMOTE_DEVICE_STATE_RESETTING);

	return SCI_SUCCESS;
}

/*
 * This method will attempt to start a task request for this device object. The
 * remote device object will issue the start request for the task and if
 * successful it will start the request for the port object then increment its
 * own requet count. enum sci_status SCI_SUCCESS if the task request is started for
 * this device object. SCI_FAILURE_INSUFFICIENT_RESOURCES if the io request
 * object could not get the resources to start.
 */
static enum sci_status scic_sds_remote_device_ready_state_start_task_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	enum sci_status result;

	/* See if the port is in a state where we can start the IO request */
	result = scic_sds_port_start_io(
		scic_sds_remote_device_get_port(sci_dev), sci_dev, request);

	if (result == SCI_SUCCESS) {
		result = scic_sds_remote_node_context_start_task(&sci_dev->rnc,
								 request);
		if (result == SCI_SUCCESS)
			result = scic_sds_request_start(request);

		scic_sds_remote_device_start_request(sci_dev, request, result);
	}

	return result;
}

/*
 * This method will attempt to start an io request for this device object. The
 * remote device object will issue the start request for the io and if
 * successful it will start the request for the port object then increment its
 * own requet count. enum sci_status SCI_SUCCESS if the io request is started for
 * this device object. SCI_FAILURE_INSUFFICIENT_RESOURCES if the io request
 * object could not get the resources to start.
 */
static enum sci_status scic_sds_remote_device_ready_state_start_io_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	enum sci_status result;

	/* See if the port is in a state where we can start the IO request */
	result = scic_sds_port_start_io(
		scic_sds_remote_device_get_port(sci_dev), sci_dev, request);

	if (result == SCI_SUCCESS) {
		result = scic_sds_remote_node_context_start_io(&sci_dev->rnc, request);
		if (result == SCI_SUCCESS)
			result = scic_sds_request_start(request);

		scic_sds_remote_device_start_request(sci_dev, request, result);
	}

	return result;
}

/*
 * This method will complete the request for the remote device object.  The
 * method will call the completion handler for the request object and if
 * successful it will complete the request on the port object then decrement
 * its own started_request_count. enum sci_status
 */
static enum sci_status scic_sds_remote_device_ready_state_complete_request_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	enum sci_status result;

	result = scic_sds_request_complete(request);

	if (result != SCI_SUCCESS)
		return result;

	/* See if the port is in a state
	 * where we can start the IO request */
	result = scic_sds_port_complete_io(
			scic_sds_remote_device_get_port(sci_dev),
			sci_dev, request);

	if (result == SCI_SUCCESS)
		scic_sds_remote_device_decrement_request_count(sci_dev);

	return result;
}

/*
 * *****************************************************************************
 * *  STOPPING STATE HANDLERS
 * ***************************************************************************** */

/**
 *
 * @sci_dev: The struct scic_sds_remote_device which is cast into a
 *    struct scic_sds_remote_device.
 *
 * This method will stop a struct scic_sds_remote_device that is already in the
 * SCI_BASE_REMOTE_DEVICE_STATE_STOPPING state. This is not considered an error
 * since we allow a stop request on a device that is alreay stopping or
 * stopped. enum sci_status SCI_SUCCESS
 */
static enum sci_status scic_sds_remote_device_stopping_state_stop_handler(
	struct scic_sds_remote_device *device)
{
	/*
	 * All requests should have been terminated, but if there is an
	 * attempt to stop a device already in the stopping state, then
	 * try again to terminate. */
	return scic_sds_remote_device_terminate_requests(device);
}
923 924


925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 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 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
/**
 *
 * @device: The device object for which the request is completing.
 * @request: The task request that is being completed.
 *
 * This method completes requests for this struct scic_sds_remote_device while it is
 * in the SCI_BASE_REMOTE_DEVICE_STATE_STOPPING state. This method calls the
 * complete method for the request object and if that is successful the port
 * object is called to complete the task request. Then the device object itself
 * completes the task request. If struct scic_sds_remote_device started_request_count
 * goes to 0 and the invalidate RNC request has completed the device object can
 * transition to the SCI_BASE_REMOTE_DEVICE_STATE_STOPPED. enum sci_status
 */
static enum sci_status scic_sds_remote_device_stopping_state_complete_request_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	enum sci_status status = SCI_SUCCESS;

	status = scic_sds_request_complete(request);

	if (status != SCI_SUCCESS)
		return status;

	status = scic_sds_port_complete_io(scic_sds_remote_device_get_port(sci_dev),
					   sci_dev, request);
	if (status != SCI_SUCCESS)
		return status;

	scic_sds_remote_device_decrement_request_count(sci_dev);

	if (scic_sds_remote_device_get_request_count(sci_dev) == 0)
		scic_sds_remote_node_context_destruct(&sci_dev->rnc,
						      scic_sds_cb_remote_device_rnc_destruct_complete,
						      sci_dev);
	return SCI_SUCCESS;
}

/**
 *
 * @device: The struct scic_sds_remote_device which is to be cast into a
 *    struct scic_sds_remote_device object.
 *
 * This method will complete the reset operation when the device is in the
 * resetting state. enum sci_status
 */
static enum sci_status scic_sds_remote_device_resetting_state_reset_complete_handler(
	struct scic_sds_remote_device *sci_dev)
{

	sci_base_state_machine_change_state(
		&sci_dev->state_machine,
		SCI_BASE_REMOTE_DEVICE_STATE_READY
		);

	return SCI_SUCCESS;
}

/**
 *
 * @device: The struct scic_sds_remote_device which is to be cast into a
 *    struct scic_sds_remote_device object.
 *
 * This method will stop the remote device while in the resetting state.
 * enum sci_status
 */
static enum sci_status scic_sds_remote_device_resetting_state_stop_handler(
	struct scic_sds_remote_device *sci_dev)
{
	sci_base_state_machine_change_state(
		&sci_dev->state_machine,
		SCI_BASE_REMOTE_DEVICE_STATE_STOPPING
		);

	return SCI_SUCCESS;
}

/*
 * This method completes requests for this struct scic_sds_remote_device while it is
 * in the SCI_BASE_REMOTE_DEVICE_STATE_RESETTING state. This method calls the
 * complete method for the request object and if that is successful the port
 * object is called to complete the task request. Then the device object itself
 * completes the task request. enum sci_status
 */
static enum sci_status scic_sds_remote_device_resetting_state_complete_request_handler(
	struct scic_sds_remote_device *sci_dev,
	struct scic_sds_request *request)
{
	enum sci_status status = SCI_SUCCESS;

	status = scic_sds_request_complete(request);

	if (status == SCI_SUCCESS) {
		status = scic_sds_port_complete_io(
				scic_sds_remote_device_get_port(sci_dev),
				sci_dev, request);

		if (status == SCI_SUCCESS) {
			scic_sds_remote_device_decrement_request_count(sci_dev);
		}
	}

	return status;
}

static const struct scic_sds_remote_device_state_handler scic_sds_remote_device_state_handler_table[] = {
	[SCI_BASE_REMOTE_DEVICE_STATE_INITIAL] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_default_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_default_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_default_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_default_event_handler,
		.frame_handler		= scic_sds_remote_device_default_frame_handler
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_STOPPED] = {
		.start_handler		= scic_sds_remote_device_stopped_state_start_handler,
		.stop_handler		= scic_sds_remote_device_stopped_state_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_stopped_state_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_default_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_default_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_default_event_handler,
		.frame_handler		= scic_sds_remote_device_default_frame_handler
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_STARTING] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_starting_state_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_default_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_default_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_general_event_handler,
		.frame_handler		= scic_sds_remote_device_default_frame_handler
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_READY] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_ready_state_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_ready_state_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_ready_state_start_io_handler,
		.complete_io_handler	= scic_sds_remote_device_ready_state_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_ready_state_start_task_handler,
		.complete_task_handler	= scic_sds_remote_device_ready_state_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_general_event_handler,
		.frame_handler		= scic_sds_remote_device_general_frame_handler,
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_STOPPING] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_stopping_state_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_stopping_state_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_stopping_state_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_general_event_handler,
		.frame_handler		= scic_sds_remote_device_general_frame_handler
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_FAILED] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_default_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_default_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_default_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_default_event_handler,
		.frame_handler		= scic_sds_remote_device_general_frame_handler
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_RESETTING] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_resetting_state_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_resetting_state_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_resetting_state_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_resetting_state_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_default_event_handler,
		.frame_handler		= scic_sds_remote_device_general_frame_handler
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_FINAL] = {
		.start_handler		= scic_sds_remote_device_default_start_handler,
		.stop_handler		= scic_sds_remote_device_default_stop_handler,
		.fail_handler		= scic_sds_remote_device_default_fail_handler,
		.destruct_handler	= scic_sds_remote_device_default_destruct_handler,
		.reset_handler		= scic_sds_remote_device_default_reset_handler,
		.reset_complete_handler	= scic_sds_remote_device_default_reset_complete_handler,
		.start_io_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_io_handler	= scic_sds_remote_device_default_complete_request_handler,
		.continue_io_handler	= scic_sds_remote_device_default_continue_request_handler,
		.start_task_handler	= scic_sds_remote_device_default_start_request_handler,
		.complete_task_handler	= scic_sds_remote_device_default_complete_request_handler,
		.suspend_handler	= scic_sds_remote_device_default_suspend_handler,
		.resume_handler		= scic_sds_remote_device_default_resume_handler,
		.event_handler		= scic_sds_remote_device_default_event_handler,
		.frame_handler		= scic_sds_remote_device_default_frame_handler
	}
};

static void scic_sds_remote_device_initial_state_enter(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = (struct scic_sds_remote_device *)object;

	sci_dev = container_of(object, typeof(*sci_dev), parent);
	SET_STATE_HANDLER(sci_dev, scic_sds_remote_device_state_handler_table,
			  SCI_BASE_REMOTE_DEVICE_STATE_INITIAL);

	/* Initial state is a transitional state to the stopped state */
	sci_base_state_machine_change_state(&sci_dev->state_machine,
					    SCI_BASE_REMOTE_DEVICE_STATE_STOPPED);
}

/**
 * isci_remote_device_change_state() - This function gets the status of the
 *    remote_device object.
 * @isci_device: This parameter points to the isci_remote_device object
 *
 * status of the object as a isci_status enum.
 */
void isci_remote_device_change_state(
	struct isci_remote_device *isci_device,
	enum isci_status status)
{
	unsigned long flags;

	spin_lock_irqsave(&isci_device->state_lock, flags);
	isci_device->status = status;
	spin_unlock_irqrestore(&isci_device->state_lock, flags);
}
1200

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
/**
 * scic_remote_device_destruct() - free remote node context and destruct
 * @remote_device: This parameter specifies the remote device to be destructed.
 *
 * Remote device objects are a limited resource.  As such, they must be
 * protected.  Thus calls to construct and destruct are mutually exclusive and
 * non-reentrant. The return value shall indicate if the device was
 * successfully destructed or if some failure occurred. enum sci_status This value
 * is returned if the device is successfully destructed.
 * SCI_FAILURE_INVALID_REMOTE_DEVICE This value is returned if the supplied
 * device isn't valid (e.g. it's already been destoryed, the handle isn't
 * valid, etc.).
 */
static enum sci_status scic_remote_device_destruct(struct scic_sds_remote_device *sci_dev)
{
	return sci_dev->state_handlers->destruct_handler(sci_dev);
}
1218 1219 1220

/**
 * isci_remote_device_deconstruct() - This function frees an isci_remote_device.
D
Dan Williams 已提交
1221 1222
 * @ihost: This parameter specifies the isci host object.
 * @idev: This parameter specifies the remote device to be freed.
1223 1224
 *
 */
D
Dan Williams 已提交
1225
static void isci_remote_device_deconstruct(struct isci_host *ihost, struct isci_remote_device *idev)
1226
{
D
Dan Williams 已提交
1227 1228
	dev_dbg(&ihost->pdev->dev,
		"%s: isci_device = %p\n", __func__, idev);
1229 1230 1231 1232 1233

	/* There should not be any outstanding io's. All paths to
	 * here should go through isci_remote_device_nuke_requests.
	 * If we hit this condition, we will need a way to complete
	 * io requests in process */
D
Dan Williams 已提交
1234
	while (!list_empty(&idev->reqs_in_process)) {
1235

D
Dan Williams 已提交
1236
		dev_err(&ihost->pdev->dev,
1237 1238 1239 1240
			"%s: ** request list not empty! **\n", __func__);
		BUG();
	}

1241
	scic_remote_device_destruct(&idev->sci);
D
Dan Williams 已提交
1242 1243 1244 1245 1246 1247 1248 1249
	idev->domain_dev->lldd_dev = NULL;
	idev->domain_dev = NULL;
	idev->isci_port = NULL;
	list_del_init(&idev->node);

	clear_bit(IDEV_START_PENDING, &idev->flags);
	clear_bit(IDEV_STOP_PENDING, &idev->flags);
	wake_up(&ihost->eventq);
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 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 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 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 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 1553 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 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
/**
 * isci_remote_device_stop_complete() - This function is called by the scic
 *    when the remote device stop has completed. We mark the isci device as not
 *    ready and remove the isci remote device.
 * @ihost: This parameter specifies the isci host object.
 * @idev: This parameter specifies the remote device.
 * @status: This parameter specifies status of the completion.
 *
 */
static void isci_remote_device_stop_complete(struct isci_host *ihost,
					     struct isci_remote_device *idev)
{
	dev_dbg(&ihost->pdev->dev, "%s: complete idev = %p\n", __func__, idev);

	isci_remote_device_change_state(idev, isci_stopped);

	/* after stop, we can tear down resources. */
	isci_remote_device_deconstruct(ihost, idev);
}

static void scic_sds_remote_device_stopped_state_enter(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev;
	struct scic_sds_controller *scic;
	struct isci_remote_device *idev;
	struct isci_host *ihost;
	u32 prev_state;

	sci_dev = container_of(object, typeof(*sci_dev), parent);
	scic = scic_sds_remote_device_get_controller(sci_dev);
	ihost = sci_object_get_association(scic);
	idev = sci_object_get_association(sci_dev);

	SET_STATE_HANDLER(sci_dev, scic_sds_remote_device_state_handler_table,
			  SCI_BASE_REMOTE_DEVICE_STATE_STOPPED);

	/* If we are entering from the stopping state let the SCI User know that
	 * the stop operation has completed.
	 */
	prev_state = sci_dev->state_machine.previous_state_id;
	if (prev_state == SCI_BASE_REMOTE_DEVICE_STATE_STOPPING)
		isci_remote_device_stop_complete(ihost, idev);

	scic_sds_controller_remote_device_stopped(scic, sci_dev);
}

static void scic_sds_remote_device_starting_state_enter(struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = container_of(object, typeof(*sci_dev),
							      parent);
	struct scic_sds_controller *scic = scic_sds_remote_device_get_controller(sci_dev);
	struct isci_host *ihost = sci_object_get_association(scic);
	struct isci_remote_device *idev = sci_object_get_association(sci_dev);

	SET_STATE_HANDLER(sci_dev, scic_sds_remote_device_state_handler_table,
			  SCI_BASE_REMOTE_DEVICE_STATE_STARTING);

	isci_remote_device_not_ready(ihost, idev,
				     SCIC_REMOTE_DEVICE_NOT_READY_START_REQUESTED);
}

static void scic_sds_remote_device_ready_state_enter(struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = container_of(object, typeof(*sci_dev),
							      parent);
	struct scic_sds_controller *scic = scic_sds_remote_device_get_controller(sci_dev);
	struct isci_host *ihost = sci_object_get_association(scic);
	struct isci_remote_device *idev = sci_object_get_association(sci_dev);

	SET_STATE_HANDLER(sci_dev,
			  scic_sds_remote_device_state_handler_table,
			  SCI_BASE_REMOTE_DEVICE_STATE_READY);

	scic->remote_device_sequence[sci_dev->rnc.remote_node_index]++;

	if (sci_dev->has_ready_substate_machine)
		sci_base_state_machine_start(&sci_dev->ready_substate_machine);
	else
		isci_remote_device_ready(ihost, idev);
}

static void scic_sds_remote_device_ready_state_exit(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = container_of(object, typeof(*sci_dev),
							      parent);
	if (sci_dev->has_ready_substate_machine)
		sci_base_state_machine_stop(&sci_dev->ready_substate_machine);
	else {
		struct scic_sds_controller *scic = scic_sds_remote_device_get_controller(sci_dev);
		struct isci_host *ihost = sci_object_get_association(scic);
		struct isci_remote_device *idev = sci_object_get_association(sci_dev);

		isci_remote_device_not_ready(ihost, idev,
					     SCIC_REMOTE_DEVICE_NOT_READY_STOP_REQUESTED);
	}
}

static void scic_sds_remote_device_stopping_state_enter(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = (struct scic_sds_remote_device *)object;

	SET_STATE_HANDLER(
		sci_dev,
		scic_sds_remote_device_state_handler_table,
		SCI_BASE_REMOTE_DEVICE_STATE_STOPPING
		);
}

static void scic_sds_remote_device_failed_state_enter(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = (struct scic_sds_remote_device *)object;

	SET_STATE_HANDLER(
		sci_dev,
		scic_sds_remote_device_state_handler_table,
		SCI_BASE_REMOTE_DEVICE_STATE_FAILED
		);
}

static void scic_sds_remote_device_resetting_state_enter(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = (struct scic_sds_remote_device *)object;

	SET_STATE_HANDLER(
		sci_dev,
		scic_sds_remote_device_state_handler_table,
		SCI_BASE_REMOTE_DEVICE_STATE_RESETTING
		);

	scic_sds_remote_node_context_suspend(
		&sci_dev->rnc, SCI_SOFTWARE_SUSPENSION, NULL, NULL);
}

static void scic_sds_remote_device_resetting_state_exit(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = (struct scic_sds_remote_device *)object;

	scic_sds_remote_node_context_resume(&sci_dev->rnc, NULL, NULL);
}

static void scic_sds_remote_device_final_state_enter(
	struct sci_base_object *object)
{
	struct scic_sds_remote_device *sci_dev = (struct scic_sds_remote_device *)object;

	SET_STATE_HANDLER(
		sci_dev,
		scic_sds_remote_device_state_handler_table,
		SCI_BASE_REMOTE_DEVICE_STATE_FINAL
		);
}


static const struct sci_base_state scic_sds_remote_device_state_table[] = {
	[SCI_BASE_REMOTE_DEVICE_STATE_INITIAL] = {
		.enter_state = scic_sds_remote_device_initial_state_enter,
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_STOPPED] = {
		.enter_state = scic_sds_remote_device_stopped_state_enter,
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_STARTING] = {
		.enter_state = scic_sds_remote_device_starting_state_enter,
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_READY] = {
		.enter_state = scic_sds_remote_device_ready_state_enter,
		.exit_state  = scic_sds_remote_device_ready_state_exit
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_STOPPING] = {
		.enter_state = scic_sds_remote_device_stopping_state_enter,
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_FAILED] = {
		.enter_state = scic_sds_remote_device_failed_state_enter,
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_RESETTING] = {
		.enter_state = scic_sds_remote_device_resetting_state_enter,
		.exit_state  = scic_sds_remote_device_resetting_state_exit
	},
	[SCI_BASE_REMOTE_DEVICE_STATE_FINAL] = {
		.enter_state = scic_sds_remote_device_final_state_enter,
	},
};

/**
 * scic_remote_device_construct() - This method will perform the construction
 *    common to all remote device objects.
 * @sci_port: SAS/SATA port through which this device is accessed.
 * @sci_dev: remote device to construct
 *
 * It isn't necessary to call scic_remote_device_destruct() for device objects
 * that have only called this method for construction. Once subsequent
 * construction methods have been invoked (e.g.
 * scic_remote_device_da_construct()), then destruction should occur. none
 */
static void scic_remote_device_construct(struct scic_sds_port *sci_port,
				  struct scic_sds_remote_device *sci_dev)
{
	sci_dev->owning_port = sci_port;
	sci_dev->started_request_count = 0;
	sci_dev->parent.private = NULL;

	sci_base_state_machine_construct(
		&sci_dev->state_machine,
		&sci_dev->parent,
		scic_sds_remote_device_state_table,
		SCI_BASE_REMOTE_DEVICE_STATE_INITIAL
		);

	sci_base_state_machine_start(
		&sci_dev->state_machine
		);

	scic_sds_remote_node_context_construct(&sci_dev->rnc,
					       SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX);

	sci_object_set_association(&sci_dev->rnc, sci_dev);
}

/**
 * scic_remote_device_da_construct() - This method will construct a
 *    SCIC_REMOTE_DEVICE object for a direct attached (da) device.  The
 *    information (e.g. IAF, Signature FIS, etc.) necessary to build the device
 *    is known to the SCI Core since it is contained in the scic_phy object.
 * @remote_device: This parameter specifies the remote device to be destructed.
 *
 * The user must have previously called scic_remote_device_construct() Remote
 * device objects are a limited resource.  As such, they must be protected.
 * Thus calls to construct and destruct are mutually exclusive and
 * non-reentrant. Indicate if the remote device was successfully constructed.
 * SCI_SUCCESS Returned if the device was successfully constructed.
 * SCI_FAILURE_DEVICE_EXISTS Returned if the device has already been
 * constructed.  If it's an additional phy for the target, then call
 * scic_remote_device_da_add_phy(). SCI_FAILURE_UNSUPPORTED_PROTOCOL Returned
 * if the supplied parameters necessitate creation of a remote device for which
 * the protocol is not supported by the underlying controller hardware.
 * SCI_FAILURE_INSUFFICIENT_RESOURCES This value is returned if the core
 * controller associated with the supplied parameters is unable to support
 * additional remote devices.
 */
static enum sci_status scic_remote_device_da_construct(struct scic_sds_remote_device *sci_dev)
{
	enum sci_status status;
	u16 remote_node_index;
	struct sci_sas_identify_address_frame_protocols protocols;

	/*
	 * This information is request to determine how many remote node context
	 * entries will be needed to store the remote node.
	 */
	scic_sds_port_get_attached_protocols(sci_dev->owning_port, &protocols);
	sci_dev->target_protocols.u.all = protocols.u.all;
	sci_dev->is_direct_attached = true;
#if !defined(DISABLE_ATAPI)
	sci_dev->is_atapi = scic_sds_remote_device_is_atapi(sci_dev);
#endif

	status = scic_sds_controller_allocate_remote_node_context(
		sci_dev->owning_port->owning_controller,
		sci_dev,
		&remote_node_index);

	if (status == SCI_SUCCESS) {
		sci_dev->rnc.remote_node_index = remote_node_index;

		scic_sds_port_get_attached_sas_address(
			sci_dev->owning_port, &sci_dev->device_address);

		if (sci_dev->target_protocols.u.bits.attached_ssp_target) {
			sci_dev->has_ready_substate_machine = false;
		} else if (sci_dev->target_protocols.u.bits.attached_stp_target) {
			sci_dev->has_ready_substate_machine = true;

			sci_base_state_machine_construct(
				&sci_dev->ready_substate_machine,
				&sci_dev->parent,
				scic_sds_stp_remote_device_ready_substate_table,
				SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE);
		} else if (sci_dev->target_protocols.u.bits.attached_smp_target) {
			sci_dev->has_ready_substate_machine = true;

			/* add the SMP ready substate machine construction here */
			sci_base_state_machine_construct(
				&sci_dev->ready_substate_machine,
				&sci_dev->parent,
				scic_sds_smp_remote_device_ready_substate_table,
				SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_IDLE);
		}

		sci_dev->connection_rate = scic_sds_port_get_max_allowed_speed(
			sci_dev->owning_port);

		/* / @todo Should I assign the port width by reading all of the phys on the port? */
		sci_dev->device_port_width = 1;
	}

	return status;
}

static void scic_sds_remote_device_get_info_from_smp_discover_response(
	struct scic_sds_remote_device *sci_dev,
	struct smp_response_discover *discover_response)
{
	/* decode discover_response to set sas_address to sci_dev. */
	sci_dev->device_address.high =
		discover_response->attached_sas_address.high;

	sci_dev->device_address.low =
		discover_response->attached_sas_address.low;

	sci_dev->target_protocols.u.all = discover_response->protocols.u.all;
}

/**
 * scic_remote_device_ea_construct() - This method will construct an
 *    SCIC_REMOTE_DEVICE object for an expander attached (ea) device from an
 *    SMP Discover Response.
 * @remote_device: This parameter specifies the remote device to be destructed.
 * @discover_response: This parameter specifies the SMP Discovery Response to
 *    be used in device creation.
 *
 * The user must have previously called scic_remote_device_construct() Remote
 * device objects are a limited resource.  As such, they must be protected.
 * Thus calls to construct and destruct are mutually exclusive and
 * non-reentrant. Indicate if the remote device was successfully constructed.
 * SCI_SUCCESS Returned if the device was successfully constructed.
 * SCI_FAILURE_DEVICE_EXISTS Returned if the device has already been
 * constructed.  If it's an additional phy for the target, then call
 * scic_ea_remote_device_add_phy(). SCI_FAILURE_UNSUPPORTED_PROTOCOL Returned
 * if the supplied parameters necessitate creation of a remote device for which
 * the protocol is not supported by the underlying controller hardware.
 * SCI_FAILURE_INSUFFICIENT_RESOURCES This value is returned if the core
 * controller associated with the supplied parameters is unable to support
 * additional remote devices.
 */
static enum sci_status scic_remote_device_ea_construct(struct scic_sds_remote_device *sci_dev,
						       struct smp_response_discover *discover_response)
{
	enum sci_status status;
	struct scic_sds_controller *scic;

	scic = scic_sds_port_get_controller(sci_dev->owning_port);

	scic_sds_remote_device_get_info_from_smp_discover_response(
		sci_dev, discover_response);

	status = scic_sds_controller_allocate_remote_node_context(
		scic, sci_dev, &sci_dev->rnc.remote_node_index);

	if (status == SCI_SUCCESS) {
		if (sci_dev->target_protocols.u.bits.attached_ssp_target) {
			sci_dev->has_ready_substate_machine = false;
		} else if (sci_dev->target_protocols.u.bits.attached_smp_target) {
			sci_dev->has_ready_substate_machine = true;

			/* add the SMP ready substate machine construction here */
			sci_base_state_machine_construct(
				&sci_dev->ready_substate_machine,
				&sci_dev->parent,
				scic_sds_smp_remote_device_ready_substate_table,
				SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_IDLE);
		} else if (sci_dev->target_protocols.u.bits.attached_stp_target) {
			sci_dev->has_ready_substate_machine = true;

			sci_base_state_machine_construct(
				&sci_dev->ready_substate_machine,
				&sci_dev->parent,
				scic_sds_stp_remote_device_ready_substate_table,
				SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE);
		}

		/*
		 * For SAS-2 the physical link rate is actually a logical link
		 * rate that incorporates multiplexing.  The SCU doesn't
		 * incorporate multiplexing and for the purposes of the
		 * connection the logical link rate is that same as the
		 * physical.  Furthermore, the SAS-2 and SAS-1.1 fields overlay
		 * one another, so this code works for both situations. */
		sci_dev->connection_rate = min_t(u16,
			scic_sds_port_get_max_allowed_speed(sci_dev->owning_port),
			discover_response->u2.sas1_1.negotiated_physical_link_rate
			);

		/* / @todo Should I assign the port width by reading all of the phys on the port? */
		sci_dev->device_port_width = 1;
	}

	return status;
}

/**
 * scic_remote_device_start() - This method will start the supplied remote
 *    device.  This method enables normal IO requests to flow through to the
 *    remote device.
 * @remote_device: This parameter specifies the device to be started.
 * @timeout: This parameter specifies the number of milliseconds in which the
 *    start operation should complete.
 *
 * An indication of whether the device was successfully started. SCI_SUCCESS
 * This value is returned if the device was successfully started.
 * SCI_FAILURE_INVALID_PHY This value is returned if the user attempts to start
 * the device when there have been no phys added to it.
 */
static enum sci_status scic_remote_device_start(struct scic_sds_remote_device *sci_dev,
					 u32 timeout)
{
	return sci_dev->state_handlers->start_handler(sci_dev);
}
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682

/**
 * isci_remote_device_construct() - This function calls the scic remote device
 *    construct and start functions, it waits on the remote device start
 *    completion.
 * @port: This parameter specifies the isci port with the remote device.
 * @isci_device: This parameter specifies the isci remote device
 *
 * status from the scic calls, the caller to this function should clean up
 * resources as appropriate.
 */
static enum sci_status isci_remote_device_construct(
	struct isci_port *port,
	struct isci_remote_device *isci_device)
{
	enum sci_status status = SCI_SUCCESS;

	/* let the core do it's common constuction. */
	scic_remote_device_construct(port->sci_port_handle,
1683
				     &isci_device->sci);
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748

	/* let the core do it's device specific constuction. */
	if (isci_device->domain_dev->parent &&
	    (isci_device->domain_dev->parent->dev_type == EDGE_DEV)) {
		int i;

		/* struct smp_response_discover discover_response; */
		struct discover_resp discover_response;
		struct domain_device *parent =
			isci_device->domain_dev->parent;

		struct expander_device *parent_ex = &parent->ex_dev;

		for (i = 0; i < parent_ex->num_phys; i++) {

			struct ex_phy *phy = &parent_ex->ex_phy[i];

			if ((phy->phy_state == PHY_VACANT) ||
			    (phy->phy_state == PHY_NOT_PRESENT))
				continue;

			if (SAS_ADDR(phy->attached_sas_addr)
			    == SAS_ADDR(isci_device->domain_dev->sas_addr)) {

				discover_response.attached_dev_type
					= phy->attached_dev_type;
				discover_response.linkrate
					= phy->linkrate;
				discover_response.attached_sata_host
					= phy->attached_sata_host;
				discover_response.attached_sata_dev
					= phy->attached_sata_dev;
				discover_response.attached_sata_ps
					= phy->attached_sata_ps;
				discover_response.iproto
					= phy->attached_iproto >> 1;
				discover_response.tproto
					= phy->attached_tproto >> 1;
				memcpy(
					discover_response.attached_sas_addr,
					phy->attached_sas_addr,
					SAS_ADDR_SIZE
					);
				discover_response.attached_phy_id
					= phy->attached_phy_id;
				discover_response.change_count
					= phy->phy_change_count;
				discover_response.routing_attr
					= phy->routing_attr;
				discover_response.hmin_linkrate
					= phy->phy->minimum_linkrate_hw;
				discover_response.hmax_linkrate
					= phy->phy->maximum_linkrate_hw;
				discover_response.pmin_linkrate
					= phy->phy->minimum_linkrate;
				discover_response.pmax_linkrate
					= phy->phy->maximum_linkrate;
			}
		}


		dev_dbg(&port->isci_host->pdev->dev,
			"%s: parent->dev_type = EDGE_DEV\n",
			__func__);

1749
		status = scic_remote_device_ea_construct(&isci_device->sci,
D
Dan Williams 已提交
1750
				(struct smp_response_discover *)&discover_response);
1751 1752

	} else
1753
		status = scic_remote_device_da_construct(&isci_device->sci);
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765


	if (status != SCI_SUCCESS) {
		dev_dbg(&port->isci_host->pdev->dev,
			"%s: scic_remote_device_da_construct failed - "
			"isci_device = %p\n",
			__func__,
			isci_device);

		return status;
	}

1766 1767
	/* XXX will be killed with sci_base_object removal */
	sci_object_set_association(&isci_device->sci, isci_device);
1768 1769

	/* start the device. */
1770
	status = scic_remote_device_start(&isci_device->sci,
D
Dan Williams 已提交
1771
					  ISCI_REMOTE_DEVICE_START_TIMEOUT);
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782

	if (status != SCI_SUCCESS) {
		dev_warn(&port->isci_host->pdev->dev,
			 "%s: scic_remote_device_start failed\n",
			 __func__);
		return status;
	}

	return status;
}

1783
void isci_remote_device_nuke_requests(struct isci_host *ihost, struct isci_remote_device *idev)
1784 1785 1786
{
	DECLARE_COMPLETION_ONSTACK(aborted_task_completion);

1787 1788
	dev_dbg(&ihost->pdev->dev,
		"%s: idev = %p\n", __func__, idev);
1789 1790

	/* Cleanup all requests pending for this device. */
1791
	isci_terminate_pending_requests(ihost, idev, terminating);
1792

1793 1794
	dev_dbg(&ihost->pdev->dev,
		"%s: idev = %p, done\n", __func__, idev);
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
}

/**
 * This function builds the isci_remote_device when a libsas dev_found message
 *    is received.
 * @isci_host: This parameter specifies the isci host object.
 * @port: This parameter specifies the isci_port conected to this device.
 *
 * pointer to new isci_remote_device.
 */
static struct isci_remote_device *
D
Dan Williams 已提交
1806
isci_remote_device_alloc(struct isci_host *ihost, struct isci_port *iport)
1807
{
D
Dan Williams 已提交
1808 1809
	struct isci_remote_device *idev;
	int i;
1810

D
Dan Williams 已提交
1811
	for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
1812
		idev = &ihost->devices[i];
D
Dan Williams 已提交
1813 1814 1815
		if (!test_and_set_bit(IDEV_ALLOCATED, &idev->flags))
			break;
	}
1816

D
Dan Williams 已提交
1817 1818
	if (i >= SCI_MAX_REMOTE_DEVICES) {
		dev_warn(&ihost->pdev->dev, "%s: failed\n", __func__);
1819 1820 1821
		return NULL;
	}

1822 1823 1824 1825 1826 1827
	if (WARN_ONCE(!list_empty(&idev->reqs_in_process), "found requests in process\n"))
		return NULL;

	if (WARN_ONCE(!list_empty(&idev->node), "found non-idle remote device\n"))
		return NULL;

D
Dan Williams 已提交
1828
	isci_remote_device_change_state(idev, isci_freed);
1829

D
Dan Williams 已提交
1830
	return idev;
1831 1832 1833 1834 1835 1836
}

/**
 * isci_remote_device_ready() - This function is called by the scic when the
 *    remote device is ready. We mark the isci device as ready and signal the
 *    waiting proccess.
1837 1838
 * @ihost: our valid isci_host
 * @idev: remote device
1839 1840
 *
 */
1841
void isci_remote_device_ready(struct isci_host *ihost, struct isci_remote_device *idev)
1842
{
1843
	dev_dbg(&ihost->pdev->dev,
1844
		"%s: idev = %p\n", __func__, idev);
1845

1846 1847 1848
	isci_remote_device_change_state(idev, isci_ready_for_io);
	if (test_and_clear_bit(IDEV_START_PENDING, &idev->flags))
		wake_up(&ihost->eventq);
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
}

/**
 * isci_remote_device_not_ready() - This function is called by the scic when
 *    the remote device is not ready. We mark the isci device as ready (not
 *    "ready_for_io") and signal the waiting proccess.
 * @isci_host: This parameter specifies the isci host object.
 * @isci_device: This parameter specifies the remote device
 *
 */
1859 1860
void isci_remote_device_not_ready(struct isci_host *ihost,
				  struct isci_remote_device *idev, u32 reason)
1861
{
1862 1863
	dev_dbg(&ihost->pdev->dev,
		"%s: isci_device = %p\n", __func__, idev);
1864

1865 1866
	if (reason == SCIC_REMOTE_DEVICE_NOT_READY_STOP_REQUESTED)
		isci_remote_device_change_state(idev, isci_stopping);
1867 1868
	else
		/* device ready is actually a "not ready for io" state. */
1869
		isci_remote_device_change_state(idev, isci_ready);
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879
}

/**
 * isci_remote_device_stop() - This function is called internally to stop the
 *    remote device.
 * @isci_host: This parameter specifies the isci host object.
 * @isci_device: This parameter specifies the remote device.
 *
 * The status of the scic request to stop.
 */
1880
enum sci_status isci_remote_device_stop(struct isci_host *ihost, struct isci_remote_device *idev)
1881 1882 1883 1884
{
	enum sci_status status;
	unsigned long flags;

1885 1886
	dev_dbg(&ihost->pdev->dev,
		"%s: isci_device = %p\n", __func__, idev);
1887

1888
	isci_remote_device_change_state(idev, isci_stopping);
1889 1890

	/* Kill all outstanding requests. */
1891
	isci_remote_device_nuke_requests(ihost, idev);
1892

1893
	set_bit(IDEV_STOP_PENDING, &idev->flags);
1894

1895
	spin_lock_irqsave(&ihost->scic_lock, flags);
1896
	status = scic_remote_device_stop(&idev->sci, 50);
1897
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
1898 1899

	/* Wait for the stop complete callback. */
D
Dan Williams 已提交
1900
	if (status == SCI_SUCCESS) {
1901
		wait_for_device_stop(ihost, idev);
D
Dan Williams 已提交
1902 1903
		clear_bit(IDEV_ALLOCATED, &idev->flags);
	}
1904

1905 1906 1907
	dev_dbg(&ihost->pdev->dev,
		"%s: idev = %p - after completion wait\n",
		__func__, idev);
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917

	return status;
}

/**
 * isci_remote_device_gone() - This function is called by libsas when a domain
 *    device is removed.
 * @domain_device: This parameter specifies the libsas domain device.
 *
 */
1918
void isci_remote_device_gone(struct domain_device *dev)
1919
{
1920
	struct isci_host *ihost = dev_to_ihost(dev);
1921
	struct isci_remote_device *idev = dev->lldd_dev;
1922

1923
	dev_dbg(&ihost->pdev->dev,
1924
		"%s: domain_device = %p, isci_device = %p, isci_port = %p\n",
1925
		__func__, dev, idev, idev->isci_port);
1926

1927
	isci_remote_device_stop(ihost, idev);
1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
}


/**
 * isci_remote_device_found() - This function is called by libsas when a remote
 *    device is discovered. A remote device object is created and started. the
 *    function then sleeps until the sci core device started message is
 *    received.
 * @domain_device: This parameter specifies the libsas domain device.
 *
 * status, zero indicates success.
 */
int isci_remote_device_found(struct domain_device *domain_dev)
{
1942
	struct isci_host *isci_host = dev_to_ihost(domain_dev);
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
	struct isci_port *isci_port;
	struct isci_phy *isci_phy;
	struct asd_sas_port *sas_port;
	struct asd_sas_phy *sas_phy;
	struct isci_remote_device *isci_device;
	enum sci_status status;

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

1953 1954
	wait_for_start(isci_host);

1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
	sas_port = domain_dev->port;
	sas_phy = list_first_entry(&sas_port->phy_list, struct asd_sas_phy,
				   port_phy_el);
	isci_phy = to_isci_phy(sas_phy);
	isci_port = isci_phy->isci_port;

	/* we are being called for a device on this port,
	 * so it has to come up eventually
	 */
	wait_for_completion(&isci_port->start_complete);

	if ((isci_stopping == isci_port_get_state(isci_port)) ||
	    (isci_stopped == isci_port_get_state(isci_port)))
		return -ENODEV;

	isci_device = isci_remote_device_alloc(isci_host, isci_port);
D
Dan Williams 已提交
1971 1972
	if (!isci_device)
		return -ENODEV;
1973 1974 1975 1976 1977 1978 1979 1980

	INIT_LIST_HEAD(&isci_device->node);
	domain_dev->lldd_dev = isci_device;
	isci_device->domain_dev = domain_dev;
	isci_device->isci_port = isci_port;
	isci_remote_device_change_state(isci_device, isci_starting);


1981
	spin_lock_irq(&isci_host->scic_lock);
1982 1983
	list_add_tail(&isci_device->node, &isci_port->remote_dev_list);

1984
	set_bit(IDEV_START_PENDING, &isci_device->flags);
1985
	status = isci_remote_device_construct(isci_port, isci_device);
1986
	spin_unlock_irq(&isci_host->scic_lock);
1987 1988 1989 1990 1991 1992 1993

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

	if (status != SCI_SUCCESS) {

1994
		spin_lock_irq(&isci_host->scic_lock);
1995 1996 1997 1998
		isci_remote_device_deconstruct(
			isci_host,
			isci_device
			);
1999
		spin_unlock_irq(&isci_host->scic_lock);
2000 2001 2002
		return -ENODEV;
	}

2003 2004 2005
	/* wait for the device ready callback. */
	wait_for_device_start(isci_host, isci_device);

2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039
	return 0;
}
/**
 * isci_device_is_reset_pending() - This function will check if there is any
 *    pending reset condition on the device.
 * @request: This parameter is the isci_device object.
 *
 * true if there is a reset pending for the device.
 */
bool isci_device_is_reset_pending(
	struct isci_host *isci_host,
	struct isci_remote_device *isci_device)
{
	struct isci_request *isci_request;
	struct isci_request *tmp_req;
	bool reset_is_pending = false;
	unsigned long flags;

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

	spin_lock_irqsave(&isci_host->scic_lock, flags);

	/* Check for reset on all pending requests. */
	list_for_each_entry_safe(isci_request, tmp_req,
				 &isci_device->reqs_in_process, dev_node) {
		dev_dbg(&isci_host->pdev->dev,
			"%s: isci_device = %p request = %p\n",
			__func__, isci_device, isci_request);

		if (isci_request->ttype == io_task) {
			struct sas_task *task = isci_request_access_task(
				isci_request);

2040
			spin_lock(&task->task_state_lock);
2041 2042
			if (task->task_state_flags & SAS_TASK_NEED_DEV_RESET)
				reset_is_pending = true;
2043
			spin_unlock(&task->task_state_lock);
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
		}
	}

	spin_unlock_irqrestore(&isci_host->scic_lock, flags);

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

	return reset_is_pending;
}

/**
 * isci_device_clear_reset_pending() - This function will clear if any pending
 *    reset condition flags on the device.
 * @request: This parameter is the isci_device object.
 *
 * true if there is a reset pending for the device.
 */
2063
void isci_device_clear_reset_pending(struct isci_host *ihost, struct isci_remote_device *idev)
2064 2065 2066 2067 2068
{
	struct isci_request *isci_request;
	struct isci_request *tmp_req;
	unsigned long flags = 0;

2069 2070
	dev_dbg(&ihost->pdev->dev, "%s: idev=%p, ihost=%p\n",
		 __func__, idev, ihost);
2071

2072
	spin_lock_irqsave(&ihost->scic_lock, flags);
2073 2074 2075

	/* Clear reset pending on all pending requests. */
	list_for_each_entry_safe(isci_request, tmp_req,
2076 2077 2078
				 &idev->reqs_in_process, dev_node) {
		dev_dbg(&ihost->pdev->dev, "%s: idev = %p request = %p\n",
			 __func__, idev, isci_request);
2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090

		if (isci_request->ttype == io_task) {

			unsigned long flags2;
			struct sas_task *task = isci_request_access_task(
				isci_request);

			spin_lock_irqsave(&task->task_state_lock, flags2);
			task->task_state_flags &= ~SAS_TASK_NEED_DEV_RESET;
			spin_unlock_irqrestore(&task->task_state_lock, flags2);
		}
	}
2091
	spin_unlock_irqrestore(&ihost->scic_lock, flags);
2092
}