/* * 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_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); } /** * * @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); } /** * 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); } /** * isci_remote_device_deconstruct() - This function frees an isci_remote_device. * @ihost: This parameter specifies the isci host object. * @idev: This parameter specifies the remote device to be freed. * */ static void isci_remote_device_deconstruct(struct isci_host *ihost, struct isci_remote_device *idev) { dev_dbg(&ihost->pdev->dev, "%s: isci_device = %p\n", __func__, idev); /* 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 */ while (!list_empty(&idev->reqs_in_process)) { dev_err(&ihost->pdev->dev, "%s: ** request list not empty! **\n", __func__); BUG(); } scic_remote_device_destruct(&idev->sci); 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); } /** * 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); } /** * 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, &isci_device->sci); /* 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__); status = scic_remote_device_ea_construct(&isci_device->sci, (struct smp_response_discover *)&discover_response); } else status = scic_remote_device_da_construct(&isci_device->sci); 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; } /* XXX will be killed with sci_base_object removal */ sci_object_set_association(&isci_device->sci, isci_device); /* start the device. */ status = scic_remote_device_start(&isci_device->sci, ISCI_REMOTE_DEVICE_START_TIMEOUT); if (status != SCI_SUCCESS) { dev_warn(&port->isci_host->pdev->dev, "%s: scic_remote_device_start failed\n", __func__); return status; } return status; } void isci_remote_device_nuke_requests(struct isci_host *ihost, struct isci_remote_device *idev) { DECLARE_COMPLETION_ONSTACK(aborted_task_completion); dev_dbg(&ihost->pdev->dev, "%s: idev = %p\n", __func__, idev); /* Cleanup all requests pending for this device. */ isci_terminate_pending_requests(ihost, idev, terminating); dev_dbg(&ihost->pdev->dev, "%s: idev = %p, done\n", __func__, idev); } /** * 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 * isci_remote_device_alloc(struct isci_host *ihost, struct isci_port *iport) { struct isci_remote_device *idev; int i; for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) { idev = &ihost->devices[i]; if (!test_and_set_bit(IDEV_ALLOCATED, &idev->flags)) break; } if (i >= SCI_MAX_REMOTE_DEVICES) { dev_warn(&ihost->pdev->dev, "%s: failed\n", __func__); return NULL; } 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; isci_remote_device_change_state(idev, isci_freed); return idev; } /** * 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. * @ihost: our valid isci_host * @idev: remote device * */ void isci_remote_device_ready(struct isci_host *ihost, struct isci_remote_device *idev) { dev_dbg(&ihost->pdev->dev, "%s: idev = %p\n", __func__, idev); isci_remote_device_change_state(idev, isci_ready_for_io); if (test_and_clear_bit(IDEV_START_PENDING, &idev->flags)) wake_up(&ihost->eventq); } /** * 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 * */ void isci_remote_device_not_ready(struct isci_host *ihost, struct isci_remote_device *idev, u32 reason) { dev_dbg(&ihost->pdev->dev, "%s: isci_device = %p\n", __func__, idev); if (reason == SCIC_REMOTE_DEVICE_NOT_READY_STOP_REQUESTED) isci_remote_device_change_state(idev, isci_stopping); else /* device ready is actually a "not ready for io" state. */ isci_remote_device_change_state(idev, isci_ready); } /** * 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. */ enum sci_status isci_remote_device_stop(struct isci_host *ihost, struct isci_remote_device *idev) { enum sci_status status; unsigned long flags; dev_dbg(&ihost->pdev->dev, "%s: isci_device = %p\n", __func__, idev); isci_remote_device_change_state(idev, isci_stopping); /* Kill all outstanding requests. */ isci_remote_device_nuke_requests(ihost, idev); set_bit(IDEV_STOP_PENDING, &idev->flags); spin_lock_irqsave(&ihost->scic_lock, flags); status = scic_remote_device_stop(&idev->sci, 50); spin_unlock_irqrestore(&ihost->scic_lock, flags); /* Wait for the stop complete callback. */ if (status == SCI_SUCCESS) { wait_for_device_stop(ihost, idev); clear_bit(IDEV_ALLOCATED, &idev->flags); } dev_dbg(&ihost->pdev->dev, "%s: idev = %p - after completion wait\n", __func__, idev); 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. * */ void isci_remote_device_gone(struct domain_device *dev) { struct isci_host *ihost = dev_to_ihost(dev); struct isci_remote_device *idev = dev->lldd_dev; dev_dbg(&ihost->pdev->dev, "%s: domain_device = %p, isci_device = %p, isci_port = %p\n", __func__, dev, idev, idev->isci_port); isci_remote_device_stop(ihost, idev); } /** * 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) { struct isci_host *isci_host = dev_to_ihost(domain_dev); 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); wait_for_start(isci_host); 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); if (!isci_device) return -ENODEV; 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); spin_lock_irq(&isci_host->scic_lock); list_add_tail(&isci_device->node, &isci_port->remote_dev_list); set_bit(IDEV_START_PENDING, &isci_device->flags); status = isci_remote_device_construct(isci_port, isci_device); spin_unlock_irq(&isci_host->scic_lock); dev_dbg(&isci_host->pdev->dev, "%s: isci_device = %p\n", __func__, isci_device); if (status != SCI_SUCCESS) { spin_lock_irq(&isci_host->scic_lock); isci_remote_device_deconstruct( isci_host, isci_device ); spin_unlock_irq(&isci_host->scic_lock); return -ENODEV; } /* wait for the device ready callback. */ wait_for_device_start(isci_host, isci_device); 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); spin_lock(&task->task_state_lock); if (task->task_state_flags & SAS_TASK_NEED_DEV_RESET) reset_is_pending = true; spin_unlock(&task->task_state_lock); } } 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. */ void isci_device_clear_reset_pending(struct isci_host *ihost, struct isci_remote_device *idev) { struct isci_request *isci_request; struct isci_request *tmp_req; unsigned long flags = 0; dev_dbg(&ihost->pdev->dev, "%s: idev=%p, ihost=%p\n", __func__, idev, ihost); spin_lock_irqsave(&ihost->scic_lock, flags); /* Clear reset pending on all pending requests. */ list_for_each_entry_safe(isci_request, tmp_req, &idev->reqs_in_process, dev_node) { dev_dbg(&ihost->pdev->dev, "%s: idev = %p request = %p\n", __func__, idev, isci_request); 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); } } spin_unlock_irqrestore(&ihost->scic_lock, flags); }