diff --git a/sys/dev/isci/scil/scic_sds_remote_device.h b/sys/dev/isci/scil/scic_sds_remote_device.h index 6eca23c857a5..13155f090492 100644 --- a/sys/dev/isci/scil/scic_sds_remote_device.h +++ b/sys/dev/isci/scil/scic_sds_remote_device.h @@ -1,648 +1,648 @@ /*- * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 * * 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. * * 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. * * $FreeBSD$ */ #ifndef _SCIC_SDS_REMOTE_DEVICE_H_ #define _SCIC_SDS_REMOTE_DEVICE_H_ /** * @file * * @brief This file contains the structures, constants, and prototypes for the * SCIC_SDS_REMOTE_DEVICE object. */ #ifdef __cplusplus extern "C" { #endif // __cplusplus #include #include #include #include #include #include struct SCIC_SDS_CONTROLLER; struct SCIC_SDS_PORT; struct SCIC_SDS_REQUEST; struct SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER; /** * @enum SCIC_SDS_SSP_REMOTE_DEVICE_READY_SUBSTATES * * This is the enumeration of the ready substates for the * SCIC_SDS_REMOTE_DEVICE. */ enum SCIC_SDS_SSP_REMOTE_DEVICE_READY_SUBSTATES { /** * This is the initial state for the remote device ready substate. */ SCIC_SDS_SSP_REMOTE_DEVICE_READY_SUBSTATE_INITIAL, /** * This is the ready operational substate for the remote device. This is the * normal operational state for a remote device. */ SCIC_SDS_SSP_REMOTE_DEVICE_READY_SUBSTATE_OPERATIONAL, /** * This is the suspended state for the remote device. This is the state that * the device is placed in when a RNC suspend is received by the SCU hardware. */ SCIC_SDS_SSP_REMOTE_DEVICE_READY_SUBSTATE_SUSPENDED, /** * This is the final state that the device is placed in before a change to the * base state machine. */ SCIC_SDS_SSP_REMOTE_DEVICE_READY_SUBSTATE_FINAL, SCIC_SDS_SSP_REMOTE_DEVICE_READY_MAX_SUBSTATES }; /** * @enum SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATES * * This is the enumeration for the SCIC_SDS_REMOTE_DEVICE ready substates for * the STP remote device. */ enum SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATES { /** * This is the idle substate for the stp remote device. When there are no * active IO for the device it is in this state. */ SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE, /** * This is the command state for the STP remote device. This state is * entered when the device is processing a non-NCQ command. The device object * will fail any new start IO requests until this command is complete. */ SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD, /** * This is the NCQ state for the STP remote device. This state is entered - * when the device is processing an NCQ reuqest. It will remain in this state + * when the device is processing an NCQ request. It will remain in this state * so long as there is one or more NCQ requests being processed. */ SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ, /** * This is the NCQ error state for the STP remote device. This state is * entered when an SDB error FIS is received by the device object while in the * NCQ state. The device object will only accept a READ LOG command while in * this state. */ SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR, #if !defined(DISABLE_ATAPI) /** * This is the ATAPI error state for the STP ATAPI remote device. This state is * entered when ATAPI device sends error status FIS without data while the device * object is in CMD state. A suspension event is expected in this state. The device * object will resume right away. */ SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_ATAPI_ERROR, #endif /** * This is the READY substate indicates the device is waiting for the RESET task * coming to be recovered from certain hardware specific error. */ SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_AWAIT_RESET, SCIC_SDS_STP_REMOTE_DEVICE_READY_MAX_SUBSTATES }; /** * @enum SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATES * * This is the enumeration of the ready substates for the SMP REMOTE DEVICE. */ enum SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATES { /** * This is the ready operational substate for the remote device. This is the * normal operational state for a remote device. */ SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_IDLE, /** * This is the suspended state for the remote device. This is the state that * the device is placed in when a RNC suspend is received by the SCU hardware. */ SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_CMD, SCIC_SDS_SMP_REMOTE_DEVICE_READY_MAX_SUBSTATES }; /** * @struct SCIC_SDS_REMOTE_DEVICE * * @brief This structure contains the data for an SCU implementation of * the SCU Core device data. */ typedef struct SCIC_SDS_REMOTE_DEVICE { /** * This field is the common base for all remote device objects. */ SCI_BASE_REMOTE_DEVICE_T parent; /** * This field is the programmed device port width. This value is written to * the RCN data structure to tell the SCU how many open connections this * device can have. */ U32 device_port_width; /** * This field is the programmed connection rate for this remote device. It is * used to program the TC with the maximum allowed connection rate. */ SCI_SAS_LINK_RATE connection_rate; /** * This field contains the allowed target protocols for this remote device. */ SMP_DISCOVER_RESPONSE_PROTOCOLS_T target_protocols; /** * This field contains the device SAS address. */ SCI_SAS_ADDRESS_T device_address; /** * This filed is assigned the value of TRUE if the device is directly attached * to the port. */ BOOL is_direct_attached; #if !defined(DISABLE_ATAPI) /** * This filed is assigned the value of TRUE if the device is an ATAPI device. */ BOOL is_atapi; #endif /** * This filed contains a pointer back to the port to which this device is * assigned. */ struct SCIC_SDS_PORT *owning_port; /** * This field contains the SCU silicon remote node context specific * information. */ struct SCIC_SDS_REMOTE_NODE_CONTEXT * rnc; /** * This field contains the stated request count for the remote device. The * device can not reach the SCI_BASE_REMOTE_DEVICE_STATE_STOPPED until all * requests are complete and the rnc_posted value is FALSE. */ U32 started_request_count; /** * This field contains a pointer to the working request object. It is only * used only for SATA requests since the unsolicited frames we get from the * hardware have no Tag value to look up the io request object. */ struct SCIC_SDS_REQUEST * working_request; /** * This field contains the reason for the remote device going not_ready. It is * assigned in the state handlers and used in the state transition. */ U32 not_ready_reason; /** * This field is TRUE if this remote device has an initialized ready substate * machine. SSP devices do not have a ready substate machine and STP devices * have a ready substate machine. */ BOOL has_ready_substate_machine; /** * This field contains the state machine for the ready substate machine for * this SCIC_SDS_REMOTE_DEVICE object. */ SCI_BASE_STATE_MACHINE_T ready_substate_machine; /** * This field maintains the set of state handlers for the remote device * object. These are changed each time the remote device enters a new state. */ struct SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER *state_handlers; #ifdef SCI_LOGGING /** * This field conatins the ready substate machine logger. The logger will * emit a message each time the ready substate machine changes state. */ SCI_BASE_STATE_MACHINE_LOGGER_T ready_substate_machine_logger; #endif } SCIC_SDS_REMOTE_DEVICE_T; typedef SCI_STATUS (*SCIC_SDS_REMOTE_DEVICE_HANDLER_T)( SCIC_SDS_REMOTE_DEVICE_T *this_device); typedef SCI_STATUS (*SCIC_SDS_REMOTE_DEVICE_SUSPEND_HANDLER_T)( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 suspend_type); typedef SCI_STATUS (*SCIC_SDS_REMOTE_DEVICE_RESUME_HANDLER_T)( SCIC_SDS_REMOTE_DEVICE_T *this_device); typedef SCI_STATUS (*SCIC_SDS_REMOTE_DEVICE_FRAME_HANDLER_T)( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 frame_index); typedef SCI_STATUS (*SCIC_SDS_REMOTE_DEVICE_EVENT_HANDLER_T)( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 event_code); typedef void (*SCIC_SDS_REMOTE_DEVICE_READY_NOT_READY_HANDLER_T)( SCIC_SDS_REMOTE_DEVICE_T *this_device); /** * @struct SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER * @brief This structure conains the state handlers that are needed to * process requests for the SCU remote device objects. */ typedef struct SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER { SCI_BASE_REMOTE_DEVICE_STATE_HANDLER_T parent; SCIC_SDS_REMOTE_DEVICE_SUSPEND_HANDLER_T suspend_handler; SCIC_SDS_REMOTE_DEVICE_RESUME_HANDLER_T resume_handler; SCIC_SDS_REMOTE_DEVICE_EVENT_HANDLER_T event_handler; SCIC_SDS_REMOTE_DEVICE_FRAME_HANDLER_T frame_handler; } SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER_T; extern SCI_BASE_STATE_T scic_sds_remote_device_state_table[]; extern SCI_BASE_STATE_T scic_sds_ssp_remote_device_ready_substate_table[]; extern SCI_BASE_STATE_T scic_sds_stp_remote_device_ready_substate_table[]; extern SCI_BASE_STATE_T scic_sds_smp_remote_device_ready_substate_table[]; extern SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER_T scic_sds_remote_device_state_handler_table[]; extern SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER_T scic_sds_ssp_remote_device_ready_substate_handler_table[]; extern SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER_T scic_sds_stp_remote_device_ready_substate_handler_table[]; extern SCIC_SDS_REMOTE_DEVICE_STATE_HANDLER_T scic_sds_smp_remote_device_ready_substate_handler_table[]; /** * This macro incrments the request count for this device */ #define scic_sds_remote_device_increment_request_count(this_device) \ ((this_device)->started_request_count++) /** * This macro decrements the request count for this device. This count * will never decrment past 0. */ #define scic_sds_remote_device_decrement_request_count(this_device) \ ((this_device)->started_request_count > 0 ? \ (this_device)->started_request_count-- : 0) /** * This is a helper macro to return the current device request count. */ #define scic_sds_remote_device_get_request_count(this_device) \ ((this_device)->started_request_count) /** * This macro returns the owning port of this remote device obejct. */ #define scic_sds_remote_device_get_port(this_device) \ ((this_device)->owning_port) /** * This macro returns the controller object that contains this device * object */ #define scic_sds_remote_device_get_controller(this_device) \ scic_sds_port_get_controller(scic_sds_remote_device_get_port(this_device)) /** * This macro sets the remote device state handlers pointer and is set on * entry to each device state. */ #define scic_sds_remote_device_set_state_handlers(this_device, handlers) \ ((this_device)->state_handlers = (handlers)) /** * This macro returns the base sate machine object for the remote device. */ #define scic_sds_remote_device_get_base_state_machine(this_device) \ (&(this_device)->parent.state_machine) /** * This macro returns the remote device ready substate machine */ #define scic_sds_remote_device_get_ready_substate_machine(this_device) \ (&(this_device)->ready_substate_machine) /** * This macro returns the owning port of this device */ #define scic_sds_remote_device_get_port(this_device) \ ((this_device)->owning_port) /** * This macro returns the remote device sequence value */ #define scic_sds_remote_device_get_sequence(this_device) \ ( \ scic_sds_remote_device_get_controller(this_device)->\ remote_device_sequence[(this_device)->rnc->remote_node_index] \ ) /** * This macro returns the controllers protocol engine group */ #define scic_sds_remote_device_get_controller_peg(this_device) \ ( \ scic_sds_controller_get_protocol_engine_group( \ scic_sds_port_get_controller( \ scic_sds_remote_device_get_port(this_device) \ ) \ ) \ ) /** * This macro returns the port index for the devices owning port */ #define scic_sds_remote_device_get_port_index(this_device) \ (scic_sds_port_get_index(scic_sds_remote_device_get_port(this_device))) /** * This macro returns the remote node index for this device object */ #define scic_sds_remote_device_get_index(this_device) \ ((this_device)->rnc->remote_node_index) /** * This macro builds a remote device context for the SCU post request * operation */ #define scic_sds_remote_device_build_command_context(device, command) \ ( (command) \ | ((U32)(scic_sds_remote_device_get_controller_peg((device))) << SCU_CONTEXT_COMMAND_PROTOCOL_ENGINE_GROUP_SHIFT)\ | ((U32)(scic_sds_remote_device_get_port_index((device))) << SCU_CONTEXT_COMMAND_LOGICAL_PORT_SHIFT) \ | (scic_sds_remote_device_get_index((device))) \ ) /** * This macro makes the working request assingment for the remote device * object. To clear the working request use this macro with a NULL request * object. */ #define scic_sds_remote_device_set_working_request(device, request) \ ((device)->working_request = (request)) // --------------------------------------------------------------------------- U32 scic_sds_remote_device_get_min_timer_count(void); U32 scic_sds_remote_device_get_max_timer_count(void); SCI_STATUS scic_sds_remote_device_frame_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 frame_index ); SCI_STATUS scic_sds_remote_device_event_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 event_code ); SCI_STATUS scic_sds_remote_device_start_io( struct SCIC_SDS_CONTROLLER *controller, SCIC_SDS_REMOTE_DEVICE_T *this_device, struct SCIC_SDS_REQUEST *io_request ); SCI_STATUS scic_sds_remote_device_complete_io( struct SCIC_SDS_CONTROLLER *controller, SCIC_SDS_REMOTE_DEVICE_T *this_device, struct SCIC_SDS_REQUEST *io_request ); SCI_STATUS scic_sds_remote_device_resume( SCIC_SDS_REMOTE_DEVICE_T *this_device ); SCI_STATUS scic_sds_remote_device_suspend( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 suspend_type ); SCI_STATUS scic_sds_remote_device_start_task( struct SCIC_SDS_CONTROLLER *controller, SCIC_SDS_REMOTE_DEVICE_T *this_device, struct SCIC_SDS_REQUEST *io_request ); void scic_sds_remote_device_post_request( SCIC_SDS_REMOTE_DEVICE_T * this_device, U32 request ); #if !defined(DISABLE_ATAPI) BOOL scic_sds_remote_device_is_atapi( SCIC_SDS_REMOTE_DEVICE_T *this_device ); #else // !defined(DISABLE_ATAPI) #define scic_sds_remote_device_is_atapi(this_device) FALSE #endif // !defined(DISABLE_ATAPI) // --------------------------------------------------------------------------- #ifdef SCI_LOGGING void scic_sds_remote_device_initialize_state_logging( SCIC_SDS_REMOTE_DEVICE_T *this_device ); void scic_sds_remote_device_deinitialize_state_logging( SCIC_SDS_REMOTE_DEVICE_T *this_device ); #else // SCI_LOGGING #define scic_sds_remote_device_initialize_state_logging(x) #define scic_sds_remote_device_deinitialize_state_logging(x) #endif // SCI_LOGGING // --------------------------------------------------------------------------- void scic_sds_remote_device_start_request( SCIC_SDS_REMOTE_DEVICE_T * this_device, struct SCIC_SDS_REQUEST * the_request, SCI_STATUS status ); void scic_sds_remote_device_continue_request( SCIC_SDS_REMOTE_DEVICE_T * this_device ); SCI_STATUS scic_sds_remote_device_default_start_handler( SCI_BASE_REMOTE_DEVICE_T *this_device ); SCI_STATUS scic_sds_remote_device_default_stop_handler( SCI_BASE_REMOTE_DEVICE_T *this_device ); SCI_STATUS scic_sds_remote_device_default_fail_handler( SCI_BASE_REMOTE_DEVICE_T *this_device ); SCI_STATUS scic_sds_remote_device_default_destruct_handler( SCI_BASE_REMOTE_DEVICE_T *this_device ); SCI_STATUS scic_sds_remote_device_default_reset_handler( SCI_BASE_REMOTE_DEVICE_T *device ); SCI_STATUS scic_sds_remote_device_default_reset_complete_handler( SCI_BASE_REMOTE_DEVICE_T *device ); SCI_STATUS scic_sds_remote_device_default_start_request_handler( SCI_BASE_REMOTE_DEVICE_T *device, SCI_BASE_REQUEST_T *request ); SCI_STATUS scic_sds_remote_device_default_complete_request_handler( SCI_BASE_REMOTE_DEVICE_T *device, SCI_BASE_REQUEST_T *request ); SCI_STATUS scic_sds_remote_device_default_continue_request_handler( SCI_BASE_REMOTE_DEVICE_T *device, SCI_BASE_REQUEST_T *request ); SCI_STATUS scic_sds_remote_device_default_suspend_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 suspend_type ); SCI_STATUS scic_sds_remote_device_default_resume_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device ); SCI_STATUS scic_sds_remote_device_default_event_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 event_code ); SCI_STATUS scic_sds_remote_device_default_frame_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 frame_index ); // --------------------------------------------------------------------------- SCI_STATUS scic_sds_remote_device_ready_state_stop_handler( SCI_BASE_REMOTE_DEVICE_T *device ); SCI_STATUS scic_sds_remote_device_ready_state_reset_handler( SCI_BASE_REMOTE_DEVICE_T *device ); SCI_STATUS scic_sds_remote_device_general_frame_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 frame_index ); SCI_STATUS scic_sds_remote_device_general_event_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device, U32 event_code ); SCI_STATUS scic_sds_ssp_remote_device_ready_suspended_substate_resume_handler( SCIC_SDS_REMOTE_DEVICE_T *this_device ); // --------------------------------------------------------------------------- void scic_sds_remote_device_get_info_from_smp_discover_response( SCIC_SDS_REMOTE_DEVICE_T * this_device, SMP_RESPONSE_DISCOVER_T * discover_response ); #ifdef __cplusplus } #endif // __cplusplus #endif // _SCIC_SDS_REMOTE_DEVICE_H_ diff --git a/sys/dev/isci/scil/scif_sas_remote_device.c b/sys/dev/isci/scil/scif_sas_remote_device.c index 991c6a0b482f..ddca93e80f56 100644 --- a/sys/dev/isci/scil/scif_sas_remote_device.c +++ b/sys/dev/isci/scil/scif_sas_remote_device.c @@ -1,796 +1,796 @@ /*- * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 * * 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. * * 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 __FBSDID("$FreeBSD$"); /** * @file * * @brief This file contains the implementation of the SCIF_SAS_REMOTE_DEVICE * object. */ #include #include #include #include #include #include #include #include #include #include //****************************************************************************** //* P U B L I C M E T H O D S //****************************************************************************** U32 scif_remote_device_get_object_size( void ) { return ( sizeof(SCIF_SAS_REMOTE_DEVICE_T) + scic_remote_device_get_object_size() ); } // --------------------------------------------------------------------------- void scif_remote_device_construct( SCI_DOMAIN_HANDLE_T domain, void * remote_device_memory, SCI_REMOTE_DEVICE_HANDLE_T * new_scif_remote_device_handle ) { SCIF_SAS_DOMAIN_T * fw_domain = (SCIF_SAS_DOMAIN_T *) domain; SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T *) remote_device_memory; SCIF_LOG_TRACE(( sci_base_object_get_logger(fw_domain), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_remote_device_construct(0x%x, 0x%x, 0x%x) enter\n", domain, remote_device_memory, new_scif_remote_device_handle )); memset(remote_device_memory, 0, sizeof(SCIF_SAS_REMOTE_DEVICE_T)); // The user's handle to the remote device evaluates to the memory // address where the remote device object is stored. *new_scif_remote_device_handle = remote_device_memory; fw_device->domain = fw_domain; fw_device->destruct_when_stopped = FALSE; //fw_device->parent.is_failed = FALSE; fw_device->operation_status = SCI_SUCCESS; fw_device->request_count = 0; fw_device->task_request_count = 0; fw_device->is_currently_discovered = TRUE; fw_device->containing_device = NULL; fw_device->device_port_width = 1; fw_device->expander_phy_identifier = 0; fw_device->destination_state = SCIF_SAS_REMOTE_DEVICE_DESTINATION_STATE_UNSPECIFIED; fw_device->ea_target_reset_request_scheduled = NULL; // Construct the base object first in order to ensure logging can // function. sci_base_remote_device_construct( &fw_device->parent, sci_base_object_get_logger(fw_domain), scif_sas_remote_device_state_table ); sci_base_state_machine_construct( &fw_device->starting_substate_machine, &fw_device->parent.parent, scif_sas_remote_device_starting_substate_table, SCIF_SAS_REMOTE_DEVICE_STARTING_SUBSTATE_AWAIT_COMPLETE ); sci_base_state_machine_construct( &fw_device->ready_substate_machine, &fw_device->parent.parent, scif_sas_remote_device_ready_substate_table, SCIF_SAS_REMOTE_DEVICE_READY_SUBSTATE_OPERATIONAL ); scif_sas_remote_device_initialize_state_logging(fw_device); scic_remote_device_construct( fw_domain->core_object, ((U8*) remote_device_memory) + sizeof(SCIF_SAS_REMOTE_DEVICE_T), &fw_device->core_object ); // Set the association in the core object, so that we are able to // determine our framework remote device object from the core remote // device. sci_object_set_association(fw_device->core_object, fw_device); } // --------------------------------------------------------------------------- SCI_STATUS scif_remote_device_da_construct( SCI_REMOTE_DEVICE_HANDLE_T remote_device, SCI_SAS_ADDRESS_T * sas_address, SCI_SAS_IDENTIFY_ADDRESS_FRAME_PROTOCOLS_T * protocols ) { SCI_STATUS status = SCI_SUCCESS; SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T *) remote_device; SCIF_LOG_TRACE(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_remote_device_da_construct(0x%x, 0x%x, 0x%x) enter\n", remote_device, sas_address, protocols )); // Make sure the device hasn't already been constructed and added // to the domain. if (scif_domain_get_device_by_sas_address(fw_device->domain, sas_address) == SCI_INVALID_HANDLE) { SCIC_PORT_PROPERTIES_T properties; scic_port_get_properties(fw_device->domain->core_object, &properties); // Check to see if this is the direct attached device. if ( (sas_address->low == properties.remote.sas_address.low) && (sas_address->high == properties.remote.sas_address.high) ) { //Get accurate port width from port's phy mask for a DA device. SCI_GET_BITS_SET_COUNT(properties.phy_mask, fw_device->device_port_width); status = scic_remote_device_da_construct(fw_device->core_object); } else // Don't allow the user to construct a direct attached device // if it's not a direct attached device. status = SCI_FAILURE_UNSUPPORTED_PROTOCOL; } else status = SCI_FAILURE_DEVICE_EXISTS; if (status == SCI_SUCCESS) { // Add the device to the domain list. sci_abstract_list_pushback( &fw_device->domain->remote_device_list, fw_device ); // If a SATA/STP device is connected, then construct it. if (protocols->u.bits.stp_target) scif_sas_stp_remote_device_construct(fw_device); else if (protocols->u.bits.smp_target) scif_sas_smp_remote_device_construct(fw_device); SCIF_LOG_INFO(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE | SCIF_LOG_OBJECT_DOMAIN_DISCOVERY, "Domain:0x%x SasAddress:0x%x,0x%x remote device constructed\n", fw_device->domain, sas_address->low, sas_address->high )); status = fw_device->state_handlers->parent.start_handler( &fw_device->parent ); } else { SCIF_LOG_WARNING(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE | SCIF_LOG_OBJECT_DOMAIN_DISCOVERY, "Domain:0x%x SasAddress:0x%x,0x%x Status:0x%x remote device construct failure\n", fw_device->domain, sas_address->low, sas_address->high, status )); } return status; } // --------------------------------------------------------------------------- SCI_STATUS scif_remote_device_ea_construct( SCI_REMOTE_DEVICE_HANDLE_T remote_device, SCI_REMOTE_DEVICE_HANDLE_T containing_device, SMP_RESPONSE_DISCOVER_T * smp_response ) { SCI_SAS_ADDRESS_T * sas_address; SCI_STATUS status = SCI_SUCCESS; SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T *) remote_device; SCIF_SAS_REMOTE_DEVICE_T * fw_smp_device = (SCIF_SAS_REMOTE_DEVICE_T *) containing_device; fw_device->containing_device = fw_smp_device; fw_device->expander_phy_identifier = fw_smp_device->protocol_device.smp_device.current_activity_phy_index; sas_address = &smp_response->attached_sas_address; SCIF_LOG_TRACE(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_remote_device_ea_construct(0x%x, 0x%x) enter\n", remote_device, smp_response )); // Make sure the device hasn't already been constructed and added // to the domain. if (scif_domain_get_device_by_sas_address(fw_device->domain, sas_address) == SCI_INVALID_HANDLE) { //for sata device, we need another routine. likely //scif_remote_device_ea_sata_construct. status = scic_remote_device_ea_construct(fw_device->core_object, smp_response); } else status = SCI_FAILURE_DEVICE_EXISTS; if (status == SCI_SUCCESS) { // Add the device to the domain list. sci_abstract_list_pushback( &fw_device->domain->remote_device_list, fw_device ); if (smp_response->protocols.u.bits.attached_smp_target) scif_sas_smp_remote_device_construct(fw_device); else if (smp_response->protocols.u.bits.attached_stp_target) scif_sas_stp_remote_device_construct(fw_device); SCIF_LOG_INFO(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE | SCIF_LOG_OBJECT_DOMAIN_DISCOVERY, "Domain:0x%x SasAddress:0x%x,0x%x remote device constructed\n", fw_device->domain, sas_address->low, sas_address->high )); //only start the device if the device is not a SATA disk on SPINUP_HOLD state. if ( scic_remote_device_get_connection_rate(fw_device->core_object) != SCI_SATA_SPINUP_HOLD ) { status = fw_device->state_handlers->parent.start_handler( &fw_device->parent ); } } else { SCIF_LOG_WARNING(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE | SCIF_LOG_OBJECT_DOMAIN_DISCOVERY, "Domain:0x%x SasAddress:0x%x,0x%x Status:0x%x remote device construct failure\n", fw_device->domain, sas_address->low, sas_address->high, status )); } return status; } // --------------------------------------------------------------------------- SCI_STATUS scif_remote_device_destruct( SCI_REMOTE_DEVICE_HANDLE_T remote_device ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) remote_device; SCIF_LOG_TRACE(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_remote_device_destruct(0x%x) enter\n", remote_device )); //remove the device from domain's remote_device_list fw_device->domain->state_handlers->device_destruct_handler( &fw_device->domain->parent, &fw_device->parent ); // The destruct process may not complete immediately, since the core // remote device likely needs to be stopped first. However, the user // is not given a callback notification for destruction. return fw_device->state_handlers->parent.destruct_handler( &fw_device->parent ); } // --------------------------------------------------------------------------- SCI_REMOTE_DEVICE_HANDLE_T scif_remote_device_get_scic_handle( SCI_REMOTE_DEVICE_HANDLE_T scif_remote_device ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) scif_remote_device; if ( (fw_device == NULL) || (fw_device->core_object == SCI_INVALID_HANDLE) ) return SCI_INVALID_HANDLE; SCIF_LOG_WARNING(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "RemoteDevice:0x%x no associated core device found\n", fw_device )); return fw_device->core_object; } // --------------------------------------------------------------------------- void scic_cb_remote_device_start_complete( SCI_CONTROLLER_HANDLE_T controller, SCI_REMOTE_DEVICE_HANDLE_T remote_device, SCI_STATUS completion_status ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) sci_object_get_association(remote_device); SCIF_LOG_TRACE(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE | SCIF_LOG_OBJECT_REMOTE_DEVICE_CONFIG, "scic_cb_remote_device_start_complete(0x%x, 0x%x, 0x%x) enter\n", controller, remote_device, completion_status )); fw_device->state_handlers->start_complete_handler( fw_device, completion_status ); } // --------------------------------------------------------------------------- void scic_cb_remote_device_stop_complete( SCI_CONTROLLER_HANDLE_T controller, SCI_REMOTE_DEVICE_HANDLE_T remote_device, SCI_STATUS completion_status ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) sci_object_get_association(remote_device); SCIF_LOG_TRACE(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE | SCIF_LOG_OBJECT_REMOTE_DEVICE_CONFIG, "scic_cb_remote_device_stop_complete(0x%x, 0x%x, 0x%x) enter\n", controller, remote_device, completion_status )); fw_device->state_handlers->stop_complete_handler( fw_device, completion_status ); } // --------------------------------------------------------------------------- void scic_cb_remote_device_ready( SCI_CONTROLLER_HANDLE_T controller, SCI_REMOTE_DEVICE_HANDLE_T remote_device ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) sci_object_get_association(remote_device); fw_device->state_handlers->ready_handler(fw_device); } // --------------------------------------------------------------------------- void scic_cb_remote_device_not_ready( SCI_CONTROLLER_HANDLE_T controller, SCI_REMOTE_DEVICE_HANDLE_T remote_device, U32 reason_code ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) sci_object_get_association(remote_device); fw_device->state_handlers->not_ready_handler(fw_device,reason_code); } // --------------------------------------------------------------------------- U16 scif_remote_device_get_max_queue_depth( SCI_REMOTE_DEVICE_HANDLE_T remote_device ) { SCIF_SAS_REMOTE_DEVICE_T * fw_device = (SCIF_SAS_REMOTE_DEVICE_T*) remote_device; SMP_DISCOVER_RESPONSE_PROTOCOLS_T protocols; scic_remote_device_get_protocols(fw_device->core_object, &protocols); // If the target is a SATA/STP target, then determine the queue depth // for either NCQ or for UDMA. if (protocols.u.bits.attached_stp_target) { if (fw_device->protocol_device.stp_device.sati_device.capabilities & SATI_DEVICE_CAP_NCQ_SUPPORTED_ENABLE) { return fw_device->protocol_device.stp_device.sati_device.ncq_depth; } else { // At the moment, we only allow a single UDMA request to be queued. return 1; } } // For SSP devices return a no maximum queue depth supported. return SCIF_REMOTE_DEVICE_NO_MAX_QUEUE_DEPTH; } // --------------------------------------------------------------------------- SCI_STATUS scif_remote_device_get_containing_device( SCI_REMOTE_DEVICE_HANDLE_T remote_device, SCI_REMOTE_DEVICE_HANDLE_T * containing_device ) { SCI_STATUS status = SCI_FAILURE; SCIF_SAS_REMOTE_DEVICE_T * this_device = (SCIF_SAS_REMOTE_DEVICE_T *) remote_device; if ( (this_device != NULL) && (containing_device != NULL) ) { *containing_device = (SCI_REMOTE_DEVICE_HANDLE_T)(this_device->containing_device); if (*containing_device != NULL) { status = SCI_SUCCESS; } } return status; } // --------------------------------------------------------------------------- U32 scif_remote_device_get_started_io_count( SCI_REMOTE_DEVICE_HANDLE_T remote_device ) { SCIF_SAS_REMOTE_DEVICE_T * this_device = (SCIF_SAS_REMOTE_DEVICE_T *) remote_device; return this_device->request_count - this_device->task_request_count; } //****************************************************************************** //* P R O T E C T E D M E T H O D S //****************************************************************************** /* void scif_sas_remote_device_failure( SCIF_SAS_REMOTE_DEVICE_T * fw_device ) { fw_device->parent.is_failed = TRUE; sci_base_state_machine_change_state( &fw_device->parent.state_machine, SCI_BASE_REMOTE_DEVICE_STATE_STOPPING ); } */ /** * @brief This method retrieves info from Report Phy Sata response and * save the additional data for a SATA remote device, if necessary. * * @param[in] report_phy_sata_response SMP Report Phy Sata response * * @return none */ void scif_sas_remote_device_save_report_phy_sata_information( SMP_RESPONSE_REPORT_PHY_SATA_T * report_phy_sata_response ) { //do nothing currently. Later, if needed, we will search the existed //remote device by stp_sas_address, then save more information for //that device off the report_phy_sata_response. This assumes the //stp_sas_address from report_phy_sata response is the same sas address //from discover response. return; } /** * @brief This method does target reset for DA or EA remote device. * * @param[in] fw_controller, the controller object the target device belongs * to. * @param[in] fw_device, the target device to be hard reset. * @param[in] fw_request, the scif task request object that asked for this * target reset. */ void scif_sas_remote_device_target_reset( SCIF_SAS_REMOTE_DEVICE_T * fw_device, SCIF_SAS_REQUEST_T * fw_request ) { SCIF_LOG_INFO(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_sas_remote_device_target_reset! fw_device:0x%x fw_request:0x%x\n", fw_device, fw_request )); if (fw_device->containing_device == NULL) { SCI_PORT_HANDLE_T port; port = scif_domain_get_scic_port_handle(fw_device->domain); //Direct attached device target reset. //calling core to do port reset. The fw_request will not be used here. scic_port_hard_reset( port, scic_remote_device_get_suggested_reset_timeout(fw_device->core_object) ); } else { //Expander attached device target reset. if ( fw_device->containing_device->protocol_device.smp_device.current_activity == SCIF_SAS_SMP_REMOTE_DEVICE_ACTIVITY_TARGET_RESET ) { //The containing expander is in the middle of target resetting other of its //remote disks. Flag this remote device to be target reset later. SCIF_LOG_INFO(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_sas_remote_device_target_reset DELAYED! fw_device:0x%x fw_request:0x%x\n", fw_device, fw_request )); fw_device->ea_target_reset_request_scheduled = fw_request; return; } //set current_activity and current_smp_request to expander device. scif_sas_smp_remote_device_start_target_reset( fw_device->containing_device, fw_device, fw_request); } scic_remote_device_reset(fw_device->core_object); } /** * @brief This method completes target reset for DA or EA remote device. * * @param[in] fw_device, the target device to be hard reset. * @param[in] fw_request, the scif task request object that asked for this * target reset. * @param[in] completion_status */ void scif_sas_remote_device_target_reset_complete( SCIF_SAS_REMOTE_DEVICE_T * fw_device, SCIF_SAS_REQUEST_T * fw_request, SCI_STATUS completion_status ) { SCIF_LOG_INFO(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_sas_remote_device_target_reset_complete! " "fw_device:0x%x fw_request:0x%x completion_status 0x%x\n", fw_device, fw_request, completion_status )); scif_cb_task_request_complete( fw_device->domain->controller, fw_device, fw_request, (SCI_TASK_STATUS) completion_status ); scic_remote_device_reset_complete(fw_device->core_object); //For expander attached device done target reset. if (fw_device->containing_device != NULL) { //search for all the devices in the domain to find other remote devices //needs to be target reset. SCIF_SAS_REMOTE_DEVICE_T * next_device; scif_sas_smp_remote_device_clear(fw_device->containing_device); if( (next_device = scif_sas_domain_find_next_ea_target_reset(fw_device->domain)) != NULL ) { scif_sas_smp_remote_device_start_target_reset( next_device->containing_device, next_device, next_device->ea_target_reset_request_scheduled ); next_device->ea_target_reset_request_scheduled = NULL; } else { //if the domain is in the DISCOVER state, we should resume the DISCOVER. if (fw_device->domain->parent.state_machine.current_state_id == SCI_BASE_DOMAIN_STATE_DISCOVERING) { SCIF_SAS_REMOTE_DEVICE_T * top_expander = fw_device->containing_device; while(top_expander->containing_device != NULL) top_expander = top_expander->containing_device; scif_sas_domain_start_smp_discover(fw_device->domain, top_expander); } else { //Tell driver to kick off Discover process. If the domain is already - //in Discovery state, this discovery requst will not be carried on. + //in Discovery state, this discovery request will not be carried on. scif_cb_domain_change_notification( fw_device->domain->controller, fw_device->domain ); } } } else { //Tell driver to kick off Discover process. If the domain is already - //in Discovery state, this discovery requst will not be carried on. + //in Discovery state, this discovery request will not be carried on. scif_cb_domain_change_notification( fw_device->domain->controller, fw_device->domain ); } } #if !defined(DISABLE_WIDE_PORTED_TARGETS) SCI_STATUS scif_sas_remote_device_update_port_width( SCIF_SAS_REMOTE_DEVICE_T * fw_device, U8 new_port_width ) { SCIF_LOG_INFO(( sci_base_object_get_logger(fw_device), SCIF_LOG_OBJECT_REMOTE_DEVICE, "scif_sas_remote_device_update_port_width (0x%x, 0x%x) enter\n", fw_device, new_port_width )); fw_device->device_port_width = new_port_width; //Don't Start a new update of port width if a device is already in //UPDATING PORT WIDTH state. if (fw_device->parent.state_machine.current_state_id == SCI_BASE_REMOTE_DEVICE_STATE_READY) { if (fw_device->device_port_width != 0) { //Change state to UPDATING_PORT_WIDTH sci_base_state_machine_change_state( &fw_device->parent.state_machine, SCI_BASE_REMOTE_DEVICE_STATE_UPDATING_PORT_WIDTH ); } return SCI_SUCCESS; } else if (fw_device->parent.state_machine.current_state_id == SCI_BASE_REMOTE_DEVICE_STATE_STARTING) { fw_device->destination_state = SCIF_SAS_REMOTE_DEVICE_DESTINATION_STATE_UPDATING_PORT_WIDTH; } return SCI_FAILURE_INVALID_STATE; } #endif //#if !defined(DISABLE_WIDE_PORTED_TARGETS) #ifdef SCI_LOGGING void scif_sas_remote_device_initialize_state_logging( SCIF_SAS_REMOTE_DEVICE_T * remote_device ) { sci_base_state_machine_logger_initialize( &remote_device->parent.state_machine_logger, &remote_device->parent.state_machine, &remote_device->parent.parent, scif_cb_logger_log_states, "SCIF_SAS_REMOTE_DEVICE_T", "base_state_machine", SCIF_LOG_OBJECT_REMOTE_DEVICE ); sci_base_state_machine_logger_initialize( &remote_device->starting_substate_machine_logger, &remote_device->starting_substate_machine, &remote_device->parent.parent, scif_cb_logger_log_states, "SCIF_SAS_REMOTE_DEVICE_T", "starting substate machine", SCIF_LOG_OBJECT_REMOTE_DEVICE ); sci_base_state_machine_logger_initialize( &remote_device->ready_substate_machine_logger, &remote_device->ready_substate_machine, &remote_device->parent.parent, scif_cb_logger_log_states, "SCIF_SAS_REMOTE_DEVICE_T", "ready substate machine", SCIF_LOG_OBJECT_REMOTE_DEVICE ); } void scif_sas_remote_device_deinitialize_state_logging( SCIF_SAS_REMOTE_DEVICE_T * remote_device ) { sci_base_state_machine_logger_deinitialize( &remote_device->parent.state_machine_logger, &remote_device->parent.state_machine ); sci_base_state_machine_logger_deinitialize( &remote_device->starting_substate_machine_logger, &remote_device->starting_substate_machine ); sci_base_state_machine_logger_deinitialize( &remote_device->ready_substate_machine_logger, &remote_device->ready_substate_machine ); } #endif // SCI_LOGGING