isci: replace this_* and the_* variables with more meaningful names

[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / isci / core / scic_sds_stp_remote_device.c

/*
 * 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 "intel_ata.h"
#include "intel_sata.h"
#include "intel_sat.h"
#include "sci_base_state.h"
#include "scic_remote_device.h"
#include "scic_sds_controller.h"
#include "scic_sds_port.h"
#include "scic_sds_remote_device.h"
#include "scic_sds_request.h"
#include "sci_environment.h"
#include "sci_util.h"
#include "scu_event_codes.h"

/**
 * This method will perform the STP request completion processing common to IO
 *    requests and task requests of all types
 * @device: This parameter specifies the device for which the request is being
 *    completed.
 * @request: This parameter specifies the request being completed.
 *
 * This method returns an indication as to whether the request processing
 * completed successfully.
 */
static enum sci_status scic_sds_stp_remote_device_complete_request(
        struct scic_sds_remote_device *device,
        struct scic_sds_request *request)
{
        enum sci_status status;

        status = scic_sds_io_request_complete(request);

        if (status == SCI_SUCCESS) {
                status = scic_sds_port_complete_io(
                        device->owning_port, device, request);

                if (status == SCI_SUCCESS) {
                        scic_sds_remote_device_decrement_request_count(device);
                        if (request->sci_status == SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED) {
                                /*
                                 * This request causes hardware error, device needs to be Lun Reset.
                                 * So here we force the state machine to IDLE state so the rest IOs
                                 * can reach RNC state handler, these IOs will be completed by RNC with
                                 * status of "DEVICE_RESET_REQUIRED", instead of "INVALID STATE". */
                                sci_base_state_machine_change_state(
                                        &device->ready_substate_machine,
                                        SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_AWAIT_RESET
                                        );
                        } else if (scic_sds_remote_device_get_request_count(device) == 0) {
                                sci_base_state_machine_change_state(
                                        &device->ready_substate_machine,
                                        SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE
                                        );
                        }
                }
        }

        if (status != SCI_SUCCESS)
                dev_err(scirdev_to_dev(device),
                        "%s: Port:0x%p Device:0x%p Request:0x%p Status:0x%x "
                        "could not complete\n",
                        __func__,
                        device->owning_port,
                        device,
                        request,
                        status);

        return status;
}

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY COMMON SUBSTATE HANDLERS
 * ***************************************************************************** */

/**
 * This is the READY NCQ substate handler to start task management request. In
 *    this routine, we suspend and resume the RNC.
 * @device: The target device a task management request towards to.
 * @request: The task request.
 *
 * enum sci_status Always return SCI_FAILURE_RESET_DEVICE_PARTIAL_SUCCESS status to
 * let controller_start_task_handler know that the controller can't post TC for
 * task request yet, instead, when RNC gets resumed, a controller_continue_task
 * callback will be called.
 */
static enum sci_status scic_sds_stp_remote_device_ready_substate_start_request_handler(
        struct scic_sds_remote_device *device,
        struct scic_sds_request *request)
{
        enum sci_status status;

        /* Will the port allow the io request to start? */
        status = device->owning_port->state_handlers->start_io_handler(
                device->owning_port, device, request);
        if (status != SCI_SUCCESS)
                return status;

        status = scic_sds_remote_node_context_start_task(device->rnc, request);
        if (status != SCI_SUCCESS)
                goto out;

        status = request->state_handlers->start_handler(request);
        if (status != SCI_SUCCESS)
                goto out;

        /*
         * Note: If the remote device state is not IDLE this will replace
         * the request that probably resulted in the task management request.
         */
        device->working_request = request;
        sci_base_state_machine_change_state(&device->ready_substate_machine,
                        SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD);

        /*
         * The remote node context must cleanup the TCi to NCQ mapping table.
         * The only way to do this correctly is to either write to the TLCR
         * register or to invalidate and repost the RNC. In either case the
         * remote node context state machine will take the correct action when
         * the remote node context is suspended and later resumed.
         */
        scic_sds_remote_node_context_suspend(device->rnc,
                        SCI_SOFTWARE_SUSPENSION, NULL, NULL);
        scic_sds_remote_node_context_resume(device->rnc,
                        scic_sds_remote_device_continue_request,
                        device);

out:
        scic_sds_remote_device_start_request(device, request, status);
        /*
         * We need to let the controller start request handler know that it can't
         * post TC yet. We will provide a callback function to post TC when RNC gets
         * resumed.
         */
        return SCI_FAILURE_RESET_DEVICE_PARTIAL_SUCCESS;
}

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY IDLE SUBSTATE HANDLERS
 * ***************************************************************************** */

/**
 * This method will handle the start io operation for a sata device that is in
 *    the command idle state. - Evalute the type of IO request to be started -
 *    If its an NCQ request change to NCQ substate - If its any other command
 *    change to the CMD substate
 * @device:
 * @request:
 *
 * If this is a softreset we may want to have a different substate.
 * enum sci_status
 */
static enum sci_status scic_sds_stp_remote_device_ready_idle_substate_start_io_handler(
        struct scic_sds_remote_device *sci_dev,
        struct scic_sds_request *request)
{
        enum sci_status status;
        struct isci_request *isci_request =
                (struct isci_request *)sci_object_get_association(request);


        /* Will the port allow the io request to start? */
        status = sci_dev->owning_port->state_handlers->start_io_handler(
                        sci_dev->owning_port, sci_dev, request);
        if (status != SCI_SUCCESS)
                return status;

        status = scic_sds_remote_node_context_start_io(sci_dev->rnc, request);
        if (status != SCI_SUCCESS)
                goto out;

        status = request->state_handlers->start_handler(request);
        if (status != SCI_SUCCESS)
                goto out;

        if (isci_sata_get_sat_protocol(isci_request) == SAT_PROTOCOL_FPDMA) {
                sci_base_state_machine_change_state(&sci_dev->ready_substate_machine,
                                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ);
        } else {
                sci_dev->working_request = request;
                sci_base_state_machine_change_state(&sci_dev->ready_substate_machine,
                                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD);
        }
out:
        scic_sds_remote_device_start_request(sci_dev, request, status);
        return status;
}


/**
 *
 * @[in]: device The device received event.
 * @[in]: event_code The event code.
 *
 * This method will handle the event for a sata device that is in the idle
 * state. We pick up suspension events to handle specifically to this state. We
 * resume the RNC right away. enum sci_status
 */
static enum sci_status scic_sds_stp_remote_device_ready_idle_substate_event_handler(
        struct scic_sds_remote_device *sci_dev,
        u32 event_code)
{
        enum sci_status status;

        status = scic_sds_remote_device_general_event_handler(sci_dev, event_code);

        if (status == SCI_SUCCESS) {
                if (scu_get_event_type(event_code) == SCU_EVENT_TYPE_RNC_SUSPEND_TX
                    || scu_get_event_type(event_code) == SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX) {
                        status = scic_sds_remote_node_context_resume(
                                sci_dev->rnc, NULL, NULL);
                }
        }

        return status;
}


/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY NCQ SUBSTATE HANDLERS
 * ***************************************************************************** */

static enum sci_status scic_sds_stp_remote_device_ready_ncq_substate_start_io_handler(
        struct scic_sds_remote_device *sci_dev,
        struct scic_sds_request *request)
{
        enum sci_status status;
        struct isci_request *isci_request =
                (struct isci_request *)sci_object_get_association(request);

        if (isci_sata_get_sat_protocol(isci_request) == SAT_PROTOCOL_FPDMA) {
                status = sci_dev->owning_port->state_handlers->start_io_handler(
                                sci_dev->owning_port,
                                sci_dev,
                                request);

                if (status == SCI_SUCCESS) {
                        status = scic_sds_remote_node_context_start_io(
                                        sci_dev->rnc,
                                        request);

                        if (status == SCI_SUCCESS)
                                status = request->state_handlers->start_handler(request);

                        scic_sds_remote_device_start_request(sci_dev,
                                                             request,
                                                             status);
                }
        } else
                status = SCI_FAILURE_INVALID_STATE;

        return status;
}


/**
 * This method will handle events received while the STP device is in the ready
 *    command substate.
 * @sci_dev: This is the device object that is receiving the event.
 * @event_code: The event code to process.
 *
 * enum sci_status
 */

static enum sci_status scic_sds_stp_remote_device_ready_ncq_substate_frame_handler(
        struct scic_sds_remote_device *sci_dev,
        u32 frame_index)
{
        enum sci_status status;
        struct sata_fis_header *frame_header;

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

        if (status == SCI_SUCCESS) {
                if (frame_header->fis_type == SATA_FIS_TYPE_SETDEVBITS &&
                    (frame_header->status & ATA_STATUS_REG_ERROR_BIT)) {
                        sci_dev->not_ready_reason =
                                SCIC_REMOTE_DEVICE_NOT_READY_SATA_SDB_ERROR_FIS_RECEIVED;

                        /*
                         * / @todo Check sactive and complete associated IO
                         * if any.
                         */

                        sci_base_state_machine_change_state(
                                &sci_dev->ready_substate_machine,
                                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR
                                );
                } else if (frame_header->fis_type == SATA_FIS_TYPE_REGD2H &&
                           (frame_header->status & ATA_STATUS_REG_ERROR_BIT)) {

                        /*
                         * Some devices return D2H FIS when an NCQ error is detected.
                         * Treat this like an SDB error FIS ready reason.
                         */
                        sci_dev->not_ready_reason =
                                SCIC_REMOTE_DEVICE_NOT_READY_SATA_SDB_ERROR_FIS_RECEIVED;

                        sci_base_state_machine_change_state(
                                &sci_dev->ready_substate_machine,
                                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR
                                );
                } else {
                        status = SCI_FAILURE;
                }

                scic_sds_controller_release_frame(
                        scic_sds_remote_device_get_controller(sci_dev), frame_index
                        );
        }

        return status;
}

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY CMD SUBSTATE HANDLERS
 * ***************************************************************************** */

/**
 * This device is already handling a command it can not accept new commands
 *    until this one is complete.
 * @device:
 * @request:
 *
 * enum sci_status
 */
static enum sci_status scic_sds_stp_remote_device_ready_cmd_substate_start_io_handler(
        struct scic_sds_remote_device *device,
        struct scic_sds_request *request)
{
        return SCI_FAILURE_INVALID_STATE;
}

static enum sci_status scic_sds_stp_remote_device_ready_cmd_substate_suspend_handler(
        struct scic_sds_remote_device *sci_dev,
        u32 suspend_type)
{
        enum sci_status status;

        status = scic_sds_remote_node_context_suspend(
                sci_dev->rnc, suspend_type, NULL, NULL
                );

        return status;
}

static enum sci_status scic_sds_stp_remote_device_ready_cmd_substate_frame_handler(
        struct scic_sds_remote_device *sci_dev,
        u32 frame_index)
{
        enum sci_status status;

        /*
         * / The device doe not process any UF received from the hardware while
         * / in this state.  All unsolicited frames are forwarded to the io request
         * / object. */
        status = scic_sds_io_request_frame_handler(
                sci_dev->working_request,
                frame_index
                );

        return status;
}


/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY NCQ SUBSTATE HANDLERS
 * ***************************************************************************** */

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY NCQ ERROR SUBSTATE HANDLERS
 * ***************************************************************************** */

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY AWAIT RESET SUBSTATE HANDLERS
 * ***************************************************************************** */
static enum sci_status scic_sds_stp_remote_device_ready_await_reset_substate_start_io_handler(
        struct scic_sds_remote_device *device,
        struct scic_sds_request *request)
{
        return SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED;
}



/**
 * This method will perform the STP request (both io or task) completion
 *    processing for await reset state.
 * @device: This parameter specifies the device for which the request is being
 *    completed.
 * @request: This parameter specifies the request being completed.
 *
 * This method returns an indication as to whether the request processing
 * completed successfully.
 */
static enum sci_status scic_sds_stp_remote_device_ready_await_reset_substate_complete_request_handler(
        struct scic_sds_remote_device *device,
        struct scic_sds_request *request)
{
        struct scic_sds_request *sci_req = (struct scic_sds_request *)request;
        enum sci_status status;

        status = scic_sds_io_request_complete(sci_req);

        if (status == SCI_SUCCESS) {
                status = scic_sds_port_complete_io(
                        device->owning_port, device, sci_req
                        );

                if (status == SCI_SUCCESS)
                        scic_sds_remote_device_decrement_request_count(device);
        }

        if (status != SCI_SUCCESS)
                dev_err(scirdev_to_dev(device),
                        "%s: Port:0x%p Device:0x%p Request:0x%p Status:0x%x "
                        "could not complete\n",
                        __func__,
                        device->owning_port,
                        device,
                        sci_req,
                        status);

        return status;
}

#if !defined(DISABLE_ATAPI)
/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY ATAPI ERROR SUBSTATE HANDLERS
 * ***************************************************************************** */

/**
 *
 * @[in]: device The device received event.
 * @[in]: event_code The event code.
 *
 * This method will handle the event for a ATAPI device that is in the ATAPI
 * ERROR state. We pick up suspension events to handle specifically to this
 * state. We resume the RNC right away. We then complete the outstanding IO to
 * this device. enum sci_status
 */
enum sci_status scic_sds_stp_remote_device_ready_atapi_error_substate_event_handler(
        struct scic_sds_remote_device *sci_dev,
        u32 event_code)
{
        enum sci_status status;

        status = scic_sds_remote_device_general_event_handler(sci_dev, event_code);

        if (status == SCI_SUCCESS) {
                if (scu_get_event_type(event_code) == SCU_EVENT_TYPE_RNC_SUSPEND_TX
                    || scu_get_event_type(event_code) == SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX) {
                        status = scic_sds_remote_node_context_resume(
                                sci_dev->rnc,
                                sci_dev->working_request->state_handlers->parent.complete_handler,
                                (void *)sci_dev->working_request
                                );
                }
        }

        return status;
}
#endif /* !defined(DISABLE_ATAPI) */

/* --------------------------------------------------------------------------- */

static const struct scic_sds_remote_device_state_handler scic_sds_stp_remote_device_ready_substate_handler_table[] = {
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE] = {
                .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_stp_remote_device_ready_idle_substate_start_io_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_stp_remote_device_ready_substate_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_stp_remote_device_ready_idle_substate_event_handler,
                .frame_handler                  = scic_sds_remote_device_default_frame_handler
        },
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD] = {
                .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_stp_remote_device_ready_cmd_substate_start_io_handler,
                .complete_io_handler    = scic_sds_stp_remote_device_complete_request,
                .continue_io_handler    = scic_sds_remote_device_default_continue_request_handler,
                .start_task_handler     = scic_sds_stp_remote_device_ready_substate_start_request_handler,
                .complete_task_handler  = scic_sds_stp_remote_device_complete_request,
                .suspend_handler                = scic_sds_stp_remote_device_ready_cmd_substate_suspend_handler,
                .resume_handler                 = scic_sds_remote_device_default_resume_handler,
                .event_handler                  = scic_sds_remote_device_general_event_handler,
                .frame_handler                  = scic_sds_stp_remote_device_ready_cmd_substate_frame_handler
        },
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ] = {
                .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_stp_remote_device_ready_ncq_substate_start_io_handler,
                .complete_io_handler    = scic_sds_stp_remote_device_complete_request,
                .continue_io_handler    = scic_sds_remote_device_default_continue_request_handler,
                .start_task_handler     = scic_sds_stp_remote_device_ready_substate_start_request_handler,
                .complete_task_handler  = scic_sds_stp_remote_device_complete_request,
                .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_stp_remote_device_ready_ncq_substate_frame_handler
        },
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR] = {
                .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_default_start_request_handler,
                .complete_io_handler    = scic_sds_stp_remote_device_complete_request,
                .continue_io_handler    = scic_sds_remote_device_default_continue_request_handler,
                .start_task_handler     = scic_sds_stp_remote_device_ready_substate_start_request_handler,
                .complete_task_handler  = scic_sds_stp_remote_device_complete_request,
                .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
        },
#if !defined(DISABLE_ATAPI)
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_ATAPI_ERROR] = {
                .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_default_start_request_handler,
                .complete_io_handler    = scic_sds_stp_remote_device_complete_request,
                .continue_io_handler    = scic_sds_remote_device_default_continue_request_handler,
                .start_task_handler     = scic_sds_stp_remote_device_ready_substate_start_request_handler,
                .complete_task_handler  = scic_sds_stp_remote_device_complete_request,
                .suspend_handler                = scic_sds_remote_device_default_suspend_handler,
                .resume_handler                 = scic_sds_remote_device_default_resume_handler,
                .event_handler                  = scic_sds_stp_remote_device_ready_atapi_error_substate_event_handler,
                .frame_handler                  = scic_sds_remote_device_general_frame_handler
        },
#endif
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_AWAIT_RESET] = {
                .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_stp_remote_device_ready_await_reset_substate_start_io_handler,
                .complete_io_handler    = scic_sds_stp_remote_device_ready_await_reset_substate_complete_request_handler,
                .continue_io_handler    = scic_sds_remote_device_default_continue_request_handler,
                .start_task_handler     = scic_sds_stp_remote_device_ready_substate_start_request_handler,
                .complete_task_handler  = scic_sds_stp_remote_device_complete_request,
                .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
        }
};

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY SUBSTATE PRIVATE METHODS
 * ***************************************************************************** */

static void
scic_sds_stp_remote_device_ready_idle_substate_resume_complete_handler(void *user_cookie)
{
        struct scic_sds_remote_device *sci_dev = user_cookie;
        struct isci_remote_device *idev = sci_object_get_association(sci_dev);
        struct scic_sds_controller *scic = scic_sds_remote_device_get_controller(sci_dev);
        struct isci_host *ihost = sci_object_get_association(scic);

        /*
         * For NCQ operation we do not issue a
         * scic_cb_remote_device_not_ready().  As a result, avoid sending
         * the ready notification.
         */
        if (sci_dev->ready_substate_machine.previous_state_id !=
                        SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ)
                isci_remote_device_ready(ihost, idev);
}

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY IDLE SUBSTATE
 * ***************************************************************************** */

/**
 *
 * @device: This is the SCI base object which is cast into a
 *    struct scic_sds_remote_device object.
 *
 */
static void scic_sds_stp_remote_device_ready_idle_substate_enter(
        struct sci_base_object *device)
{
        struct scic_sds_remote_device *sci_dev;

        sci_dev = (struct scic_sds_remote_device *)device;

        SET_STATE_HANDLER(
                sci_dev,
                scic_sds_stp_remote_device_ready_substate_handler_table,
                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE
                );

        sci_dev->working_request = NULL;

        if (scic_sds_remote_node_context_is_ready(sci_dev->rnc)) {
                /*
                 * Since the RNC is ready, it's alright to finish completion
                 * processing (e.g. signal the remote device is ready). */
                scic_sds_stp_remote_device_ready_idle_substate_resume_complete_handler(
                        sci_dev
                        );
        } else {
                scic_sds_remote_node_context_resume(
                        sci_dev->rnc,
                        scic_sds_stp_remote_device_ready_idle_substate_resume_complete_handler,
                        sci_dev
                        );
        }
}

static void scic_sds_stp_remote_device_ready_cmd_substate_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);

        BUG_ON(sci_dev->working_request == NULL);

        SET_STATE_HANDLER(sci_dev,
                          scic_sds_stp_remote_device_ready_substate_handler_table,
                          SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD);

        isci_remote_device_not_ready(ihost, idev,
                                     SCIC_REMOTE_DEVICE_NOT_READY_SATA_REQUEST_STARTED);
}

static void scic_sds_stp_remote_device_ready_ncq_substate_enter(struct sci_base_object *object)
{
        struct scic_sds_remote_device *sci_dev = container_of(object, typeof(*sci_dev),
                                                              parent);
        SET_STATE_HANDLER(sci_dev,
                          scic_sds_stp_remote_device_ready_substate_handler_table,
                          SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ);
}

static void scic_sds_stp_remote_device_ready_ncq_error_substate_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_stp_remote_device_ready_substate_handler_table,
                          SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR);

        if (sci_dev->not_ready_reason ==
                SCIC_REMOTE_DEVICE_NOT_READY_SATA_SDB_ERROR_FIS_RECEIVED)
                isci_remote_device_not_ready(ihost, idev, sci_dev->not_ready_reason);
}

/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY AWAIT RESET SUBSTATE
 * ***************************************************************************** */

/**
 * The enter routine to READY AWAIT RESET substate.
 * @device: This is the SCI base object which is cast into a
 *    struct scic_sds_remote_device object.
 *
 */
static void scic_sds_stp_remote_device_ready_await_reset_substate_enter(
        struct sci_base_object *device)
{
        struct scic_sds_remote_device *sci_dev;

        sci_dev = (struct scic_sds_remote_device *)device;

        SET_STATE_HANDLER(
                sci_dev,
                scic_sds_stp_remote_device_ready_substate_handler_table,
                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_AWAIT_RESET
                );
}

#if !defined(DISABLE_ATAPI)
/*
 * *****************************************************************************
 * *  STP REMOTE DEVICE READY ATAPI ERROR SUBSTATE
 * ***************************************************************************** */

/**
 * The enter routine to READY ATAPI ERROR substate.
 * @device: This is the SCI base object which is cast into a
 *    struct scic_sds_remote_device object.
 *
 */
void scic_sds_stp_remote_device_ready_atapi_error_substate_enter(
        struct sci_base_object *device)
{
        struct scic_sds_remote_device *sci_dev;

        sci_dev = (struct scic_sds_remote_device *)device;

        SET_STATE_HANDLER(
                sci_dev,
                scic_sds_stp_remote_device_ready_substate_handler_table,
                SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_ATAPI_ERROR
                );
}
#endif /* !defined(DISABLE_ATAPI) */

/* --------------------------------------------------------------------------- */

const struct sci_base_state scic_sds_stp_remote_device_ready_substate_table[] = {
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE] = {
                .enter_state = scic_sds_stp_remote_device_ready_idle_substate_enter,
        },
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD] = {
                .enter_state = scic_sds_stp_remote_device_ready_cmd_substate_enter,
        },
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ] = {
                .enter_state = scic_sds_stp_remote_device_ready_ncq_substate_enter,
        },
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR] = {
                .enter_state = scic_sds_stp_remote_device_ready_ncq_error_substate_enter,
        },
#if !defined(DISABLE_ATAPI)
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_ATAPI_ERROR] = {
                .enter_state = scic_sds_stp_remote_device_ready_atapi_error_substate_enter,
        },
#endif
        [SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_AWAIT_RESET] = {
                .enter_state = scic_sds_stp_remote_device_ready_await_reset_substate_enter,
        },
};