1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris */ 52230557Sjimharris 53230557Sjimharris#include <sys/cdefs.h> 54230557Sjimharris__FBSDID("$FreeBSD$"); 55230557Sjimharris 56230557Sjimharris/** 57230557Sjimharris * @file 58230557Sjimharris * 59230557Sjimharris * @brief This file contains all of the method implementations pertaining 60230557Sjimharris * to the framework io request state handler methods. 61230557Sjimharris */ 62230557Sjimharris 63230557Sjimharris#include <dev/isci/scil/scic_controller.h> 64230557Sjimharris#include <dev/isci/scil/scif_sas_logger.h> 65230557Sjimharris#include <dev/isci/scil/scif_sas_io_request.h> 66230557Sjimharris#include <dev/isci/scil/scif_sas_remote_device.h> 67230557Sjimharris#include <dev/isci/scil/scif_sas_domain.h> 68230557Sjimharris#include <dev/isci/scil/scif_sas_controller.h> 69230557Sjimharris 70230557Sjimharris//****************************************************************************** 71230557Sjimharris//* C O N S T R U C T E D H A N D L E R S 72230557Sjimharris//****************************************************************************** 73230557Sjimharris 74230557Sjimharris/** 75230557Sjimharris * @brief This method provides CONSTRUCTED state specific handling for 76230557Sjimharris * when the user attempts to start the supplied IO request. 77230557Sjimharris * 78230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 79230557Sjimharris * to be started. 80230557Sjimharris * 81230557Sjimharris * @return This method returns a value indicating if the IO request was 82230557Sjimharris * successfully started or not. 83230557Sjimharris * @retval SCI_SUCCESS This return value indicates successful starting 84230557Sjimharris * of the IO request. 85230557Sjimharris */ 86230557SjimharrisSCI_STATUS scif_sas_io_request_constructed_start_handler( 87230557Sjimharris SCI_BASE_REQUEST_T * io_request 88230557Sjimharris) 89230557Sjimharris{ 90230557Sjimharris return SCI_SUCCESS; 91230557Sjimharris} 92230557Sjimharris 93230557Sjimharris/** 94230557Sjimharris * @brief This method provides CONSTRUCTED state specific handling for 95230557Sjimharris * when the user attempts to abort the supplied IO request. 96230557Sjimharris * 97230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 98230557Sjimharris * to be aborted. 99230557Sjimharris * 100230557Sjimharris * @return This method returns a value indicating if the IO request was 101230557Sjimharris * successfully aborted or not. 102230557Sjimharris * @retval SCI_SUCCESS This return value indicates successful aborting 103230557Sjimharris * of the IO request. 104230557Sjimharris */ 105230557SjimharrisSCI_STATUS scif_sas_io_request_constructed_abort_handler( 106230557Sjimharris SCI_BASE_REQUEST_T * io_request 107230557Sjimharris) 108230557Sjimharris{ 109230557Sjimharris sci_base_state_machine_change_state( 110230557Sjimharris &io_request->state_machine, SCI_BASE_REQUEST_STATE_COMPLETED 111230557Sjimharris ); 112230557Sjimharris 113230557Sjimharris return SCI_SUCCESS; 114230557Sjimharris} 115230557Sjimharris 116230557Sjimharris//****************************************************************************** 117230557Sjimharris//* S T A R T E D H A N D L E R S 118230557Sjimharris//****************************************************************************** 119230557Sjimharris 120230557Sjimharris/** 121230557Sjimharris * @brief This method provides STARTED state specific handling for 122230557Sjimharris * when the user attempts to abort the supplied IO request. 123230557Sjimharris * 124230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 125230557Sjimharris * to be aborted. 126230557Sjimharris * 127230557Sjimharris * @return This method returns a value indicating if the aborting the 128230557Sjimharris * IO request was successfully started. 129230557Sjimharris * @retval SCI_SUCCESS This return value indicates that the abort process 130230557Sjimharris * began successfully. 131230557Sjimharris */ 132230557Sjimharrisstatic 133230557SjimharrisSCI_STATUS scif_sas_io_request_started_abort_handler( 134230557Sjimharris SCI_BASE_REQUEST_T * io_request 135230557Sjimharris) 136230557Sjimharris{ 137230557Sjimharris SCIF_SAS_REQUEST_T * fw_request = (SCIF_SAS_REQUEST_T *) io_request; 138230557Sjimharris 139230557Sjimharris sci_base_state_machine_change_state( 140230557Sjimharris &io_request->state_machine, SCI_BASE_REQUEST_STATE_ABORTING 141230557Sjimharris ); 142230557Sjimharris 143230557Sjimharris return fw_request->status; 144230557Sjimharris} 145230557Sjimharris 146230557Sjimharris/** 147230557Sjimharris * @brief This method provides STARTED state specific handling for 148230557Sjimharris * when the user attempts to complete the supplied IO request. 149230557Sjimharris * 150230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 151230557Sjimharris * to be completed. 152230557Sjimharris * 153230557Sjimharris * @return This method returns a value indicating if the completion of the 154230557Sjimharris * IO request was successful. 155230557Sjimharris * @retval SCI_SUCCESS This return value indicates that the completion process 156230557Sjimharris * was successful. 157230557Sjimharris */ 158230557Sjimharrisstatic 159230557SjimharrisSCI_STATUS scif_sas_io_request_started_complete_handler( 160230557Sjimharris SCI_BASE_REQUEST_T * io_request 161230557Sjimharris) 162230557Sjimharris{ 163230557Sjimharris sci_base_state_machine_change_state( 164230557Sjimharris &io_request->state_machine, SCI_BASE_REQUEST_STATE_COMPLETED 165230557Sjimharris ); 166230557Sjimharris 167230557Sjimharris return SCI_SUCCESS; 168230557Sjimharris} 169230557Sjimharris 170230557Sjimharris//****************************************************************************** 171230557Sjimharris//* C O M P L E T E D H A N D L E R S 172230557Sjimharris//****************************************************************************** 173230557Sjimharris 174230557Sjimharris/** 175230557Sjimharris * @brief This method provides COMPLETED state specific handling for 176230557Sjimharris * when the user attempts to destruct the supplied IO request. 177230557Sjimharris * 178230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 179230557Sjimharris * to be destructed. 180230557Sjimharris * 181230557Sjimharris * @return This method returns a value indicating if the destruct 182230557Sjimharris * operation was successful. 183230557Sjimharris * @retval SCI_SUCCESS This return value indicates that the destruct 184230557Sjimharris * was successful. 185230557Sjimharris */ 186230557Sjimharrisstatic 187230557SjimharrisSCI_STATUS scif_sas_io_request_completed_destruct_handler( 188230557Sjimharris SCI_BASE_REQUEST_T * io_request 189230557Sjimharris) 190230557Sjimharris{ 191230557Sjimharris sci_base_state_machine_change_state( 192230557Sjimharris &io_request->state_machine, SCI_BASE_REQUEST_STATE_FINAL 193230557Sjimharris ); 194230557Sjimharris 195230557Sjimharris sci_base_state_machine_logger_deinitialize( 196230557Sjimharris &io_request->state_machine_logger, 197230557Sjimharris &io_request->state_machine 198230557Sjimharris ); 199230557Sjimharris 200230557Sjimharris return SCI_SUCCESS; 201230557Sjimharris} 202230557Sjimharris 203230557Sjimharris//****************************************************************************** 204230557Sjimharris//* A B O R T I N G H A N D L E R S 205230557Sjimharris//****************************************************************************** 206230557Sjimharris 207230557Sjimharris/** 208230557Sjimharris * @brief This method provides ABORTING state specific handlering for when the 209230557Sjimharris * user attempts to abort the supplied IO request. 210230557Sjimharris * 211230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 212230557Sjimharris * to be completed. 213230557Sjimharris * 214230557Sjimharris * @return This method returns a value indicating if the completion 215230557Sjimharris * operation was successful. 216230557Sjimharris * @retval SCI_SUCCESS This return value indicates that the abort operation 217230557Sjimharris * was successful. 218230557Sjimharris */ 219230557Sjimharrisstatic 220230557SjimharrisSCI_STATUS scif_sas_io_request_aborting_abort_handler( 221230557Sjimharris SCI_BASE_REQUEST_T * io_request 222230557Sjimharris) 223230557Sjimharris{ 224230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_request = (SCIF_SAS_IO_REQUEST_T *) io_request; 225230557Sjimharris 226230557Sjimharris return scic_controller_terminate_request( 227230557Sjimharris fw_request->parent.device->domain->controller->core_object, 228230557Sjimharris fw_request->parent.device->core_object, 229230557Sjimharris fw_request->parent.core_object 230230557Sjimharris ); 231230557Sjimharris} 232230557Sjimharris 233230557Sjimharris/** 234230557Sjimharris * @brief This method provides ABORTING state specific handling for 235230557Sjimharris * when the user attempts to complete the supplied IO request. 236230557Sjimharris * 237230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 238230557Sjimharris * to be completed. 239230557Sjimharris * 240230557Sjimharris * @return This method returns a value indicating if the completion 241230557Sjimharris * operation was successful. 242230557Sjimharris * @retval SCI_SUCCESS This return value indicates that the completion 243230557Sjimharris * was successful. 244230557Sjimharris */ 245230557Sjimharrisstatic 246230557SjimharrisSCI_STATUS scif_sas_io_request_aborting_complete_handler( 247230557Sjimharris SCI_BASE_REQUEST_T * io_request 248230557Sjimharris) 249230557Sjimharris{ 250230557Sjimharris sci_base_state_machine_change_state( 251230557Sjimharris &io_request->state_machine, SCI_BASE_REQUEST_STATE_COMPLETED 252230557Sjimharris ); 253230557Sjimharris 254230557Sjimharris return SCI_SUCCESS; 255230557Sjimharris} 256230557Sjimharris 257230557Sjimharris//****************************************************************************** 258230557Sjimharris//* D E F A U L T H A N D L E R S 259230557Sjimharris//****************************************************************************** 260230557Sjimharris 261230557Sjimharris/** 262230557Sjimharris * @brief This method provides DEFAULT handling for when the user 263230557Sjimharris * attempts to start the supplied IO request. 264230557Sjimharris * 265230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 266230557Sjimharris * to be started. 267230557Sjimharris * 268230557Sjimharris * @return This method returns an indication that the start operation is 269230557Sjimharris * not allowed. 270230557Sjimharris * @retval SCI_FAILURE_INVALID_STATE This value is always returned. 271230557Sjimharris */ 272230557Sjimharrisstatic 273230557SjimharrisSCI_STATUS scif_sas_io_request_default_start_handler( 274230557Sjimharris SCI_BASE_REQUEST_T * io_request 275230557Sjimharris) 276230557Sjimharris{ 277230557Sjimharris SCIF_LOG_ERROR(( 278230557Sjimharris sci_base_object_get_logger((SCIF_SAS_IO_REQUEST_T *) io_request), 279230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST, 280230557Sjimharris "IoRequest:0x%x State:0x%x invalid state to start\n", 281230557Sjimharris io_request, 282230557Sjimharris sci_base_state_machine_get_state( 283230557Sjimharris &((SCIF_SAS_IO_REQUEST_T *) io_request)->parent.parent.state_machine) 284230557Sjimharris )); 285230557Sjimharris 286230557Sjimharris return SCI_FAILURE_INVALID_STATE; 287230557Sjimharris} 288230557Sjimharris 289230557Sjimharris/** 290230557Sjimharris * @brief This method provides DEFAULT handling for when the user 291230557Sjimharris * attempts to abort the supplied IO request. 292230557Sjimharris * 293230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 294230557Sjimharris * to be aborted. 295230557Sjimharris * 296230557Sjimharris * @return This method returns an indication that the abort operation is 297230557Sjimharris * not allowed. 298230557Sjimharris * @retval SCI_FAILURE_INVALID_STATE This value is always returned. 299230557Sjimharris */ 300230557Sjimharrisstatic 301230557SjimharrisSCI_STATUS scif_sas_io_request_default_abort_handler( 302230557Sjimharris SCI_BASE_REQUEST_T * io_request 303230557Sjimharris) 304230557Sjimharris{ 305230557Sjimharris SCIF_LOG_ERROR(( 306230557Sjimharris sci_base_object_get_logger((SCIF_SAS_IO_REQUEST_T *) io_request), 307230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST, 308230557Sjimharris "IoRequest:0x%x State:0x%x invalid state to abort\n", 309230557Sjimharris io_request, 310230557Sjimharris sci_base_state_machine_get_state( 311230557Sjimharris &((SCIF_SAS_IO_REQUEST_T *) io_request)->parent.parent.state_machine) 312230557Sjimharris )); 313230557Sjimharris 314230557Sjimharris return SCI_FAILURE_INVALID_STATE; 315230557Sjimharris} 316230557Sjimharris 317230557Sjimharris/** 318230557Sjimharris * @brief This method provides DEFAULT handling for when the user 319230557Sjimharris * attempts to complete the supplied IO request. 320230557Sjimharris * 321230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 322230557Sjimharris * to be completed. 323230557Sjimharris * 324230557Sjimharris * @return This method returns an indication that complete operation is 325230557Sjimharris * not allowed. 326230557Sjimharris * @retval SCI_FAILURE_INVALID_STATE This value is always returned. 327230557Sjimharris */ 328230557SjimharrisSCI_STATUS scif_sas_io_request_default_complete_handler( 329230557Sjimharris SCI_BASE_REQUEST_T * io_request 330230557Sjimharris) 331230557Sjimharris{ 332230557Sjimharris SCIF_LOG_ERROR(( 333230557Sjimharris sci_base_object_get_logger((SCIF_SAS_IO_REQUEST_T *) io_request), 334230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST, 335230557Sjimharris "IoRequest:0x%x State:0x%x invalid state to complete\n", 336230557Sjimharris io_request, 337230557Sjimharris sci_base_state_machine_get_state( 338230557Sjimharris &((SCIF_SAS_IO_REQUEST_T *) io_request)->parent.parent.state_machine) 339230557Sjimharris )); 340230557Sjimharris 341230557Sjimharris return SCI_FAILURE_INVALID_STATE; 342230557Sjimharris} 343230557Sjimharris 344230557Sjimharris/** 345230557Sjimharris * @brief This method provides DEFAULT handling for when the user 346230557Sjimharris * attempts to destruct the supplied IO request. 347230557Sjimharris * 348230557Sjimharris * @param[in] io_request This parameter specifies the IO request object 349230557Sjimharris * to be destructed. 350230557Sjimharris * 351230557Sjimharris * @return This method returns an indication that destruct operation is 352230557Sjimharris * not allowed. 353230557Sjimharris * @retval SCI_FAILURE_INVALID_STATE This value is always returned. 354230557Sjimharris */ 355230557SjimharrisSCI_STATUS scif_sas_io_request_default_destruct_handler( 356230557Sjimharris SCI_BASE_REQUEST_T * io_request 357230557Sjimharris) 358230557Sjimharris{ 359230557Sjimharris SCIF_LOG_ERROR(( 360230557Sjimharris sci_base_object_get_logger((SCIF_SAS_IO_REQUEST_T *) io_request), 361230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST, 362230557Sjimharris "IoRequest:0x%x State:0x%x invalid state to destruct.\n", 363230557Sjimharris io_request, 364230557Sjimharris sci_base_state_machine_get_state( 365230557Sjimharris &((SCIF_SAS_IO_REQUEST_T *) io_request)->parent.parent.state_machine) 366230557Sjimharris )); 367230557Sjimharris 368230557Sjimharris return SCI_FAILURE_INVALID_STATE; 369230557Sjimharris} 370230557Sjimharris 371230557Sjimharris 372230557SjimharrisSCI_BASE_REQUEST_STATE_HANDLER_T scif_sas_io_request_state_handler_table[] = 373230557Sjimharris{ 374230557Sjimharris // SCI_BASE_REQUEST_STATE_INITIAL 375230557Sjimharris { 376230557Sjimharris scif_sas_io_request_default_start_handler, 377230557Sjimharris scif_sas_io_request_default_abort_handler, 378230557Sjimharris scif_sas_io_request_default_complete_handler, 379230557Sjimharris scif_sas_io_request_default_destruct_handler 380230557Sjimharris }, 381230557Sjimharris // SCI_BASE_REQUEST_STATE_CONSTRUCTED 382230557Sjimharris { 383230557Sjimharris scif_sas_io_request_constructed_start_handler, 384230557Sjimharris scif_sas_io_request_constructed_abort_handler, 385230557Sjimharris scif_sas_io_request_default_complete_handler, 386230557Sjimharris scif_sas_io_request_default_destruct_handler 387230557Sjimharris }, 388230557Sjimharris // SCI_BASE_REQUEST_STATE_STARTED 389230557Sjimharris { 390230557Sjimharris scif_sas_io_request_default_start_handler, 391230557Sjimharris scif_sas_io_request_started_abort_handler, 392230557Sjimharris scif_sas_io_request_started_complete_handler, 393230557Sjimharris scif_sas_io_request_default_destruct_handler 394230557Sjimharris }, 395230557Sjimharris // SCI_BASE_REQUEST_STATE_COMPLETED 396230557Sjimharris { 397230557Sjimharris scif_sas_io_request_default_start_handler, 398230557Sjimharris scif_sas_io_request_default_abort_handler, 399230557Sjimharris scif_sas_io_request_default_complete_handler, 400230557Sjimharris scif_sas_io_request_completed_destruct_handler 401230557Sjimharris }, 402230557Sjimharris // SCI_BASE_REQUEST_STATE_ABORTING 403230557Sjimharris { 404230557Sjimharris scif_sas_io_request_default_start_handler, 405230557Sjimharris scif_sas_io_request_aborting_abort_handler, 406230557Sjimharris scif_sas_io_request_aborting_complete_handler, 407230557Sjimharris scif_sas_io_request_default_destruct_handler 408230557Sjimharris }, 409230557Sjimharris // SCI_BASE_REQUEST_STATE_FINAL 410230557Sjimharris { 411230557Sjimharris scif_sas_io_request_default_start_handler, 412230557Sjimharris scif_sas_io_request_default_abort_handler, 413230557Sjimharris scif_sas_io_request_default_complete_handler, 414230557Sjimharris scif_sas_io_request_default_destruct_handler 415230557Sjimharris }, 416230557Sjimharris}; 417230557Sjimharris 418