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 SCIF_SAS_IO_REQUEST object 60230557Sjimharris * state entrance and exit method implementations. 61230557Sjimharris */ 62230557Sjimharris 63230557Sjimharris#include <dev/isci/scil/scic_controller.h> 64230557Sjimharris 65230557Sjimharris#include <dev/isci/scil/scif_sas_io_request.h> 66230557Sjimharris#include <dev/isci/scil/scif_sas_domain.h> 67230557Sjimharris#include <dev/isci/scil/scif_sas_controller.h> 68230557Sjimharris#include <dev/isci/scil/scif_sas_logger.h> 69230557Sjimharris 70230557Sjimharris//****************************************************************************** 71230557Sjimharris//* P R O T E C T E D M E T H O D S 72230557Sjimharris//****************************************************************************** 73230557Sjimharris 74230557Sjimharris/** 75230557Sjimharris * @brief This method implements the actions taken when entering the 76230557Sjimharris * INITIAL state. 77230557Sjimharris * 78230557Sjimharris * @param[in] object This parameter specifies the base object for which 79230557Sjimharris * the state transition is occurring. This is cast into a 80230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 81230557Sjimharris * 82230557Sjimharris * @return none 83230557Sjimharris */ 84230557Sjimharrisstatic 85230557Sjimharrisvoid scif_sas_io_request_initial_state_enter( 86230557Sjimharris SCI_BASE_OBJECT_T *object 87230557Sjimharris) 88230557Sjimharris{ 89230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = (SCIF_SAS_IO_REQUEST_T *)object; 90230557Sjimharris 91230557Sjimharris SET_STATE_HANDLER( 92230557Sjimharris &fw_io->parent, 93230557Sjimharris scif_sas_io_request_state_handler_table, 94230557Sjimharris SCI_BASE_REQUEST_STATE_INITIAL 95230557Sjimharris ); 96230557Sjimharris 97230557Sjimharris // Initial state is a transitional state to the constructed state 98230557Sjimharris sci_base_state_machine_change_state( 99230557Sjimharris &fw_io->parent.parent.state_machine, SCI_BASE_REQUEST_STATE_CONSTRUCTED 100230557Sjimharris ); 101230557Sjimharris} 102230557Sjimharris 103230557Sjimharris/** 104230557Sjimharris * @brief This method implements the actions taken when entering the 105230557Sjimharris * CONSTRUCTED state. 106230557Sjimharris * 107230557Sjimharris * @param[in] object This parameter specifies the base object for which 108230557Sjimharris * the state transition is occurring. This is cast into a 109230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 110230557Sjimharris * 111230557Sjimharris * @return none 112230557Sjimharris */ 113230557Sjimharrisstatic 114230557Sjimharrisvoid scif_sas_io_request_constructed_state_enter( 115230557Sjimharris SCI_BASE_OBJECT_T *object 116230557Sjimharris) 117230557Sjimharris{ 118230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = (SCIF_SAS_IO_REQUEST_T *)object; 119230557Sjimharris 120230557Sjimharris SET_STATE_HANDLER( 121230557Sjimharris &fw_io->parent, 122230557Sjimharris scif_sas_io_request_state_handler_table, 123230557Sjimharris SCI_BASE_REQUEST_STATE_CONSTRUCTED 124230557Sjimharris ); 125230557Sjimharris} 126230557Sjimharris 127230557Sjimharris/** 128230557Sjimharris * @brief This method implements the actions taken when entering the 129230557Sjimharris * STARTED state. 130230557Sjimharris * 131230557Sjimharris * @param[in] object This parameter specifies the base object for which 132230557Sjimharris * the state transition is occurring. This is cast into a 133230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 134230557Sjimharris * 135230557Sjimharris * @return none 136230557Sjimharris */ 137230557Sjimharrisstatic 138230557Sjimharrisvoid scif_sas_io_request_started_state_enter( 139230557Sjimharris SCI_BASE_OBJECT_T *object 140230557Sjimharris) 141230557Sjimharris{ 142230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = (SCIF_SAS_IO_REQUEST_T *)object; 143230557Sjimharris 144230557Sjimharris SET_STATE_HANDLER( 145230557Sjimharris &fw_io->parent, 146230557Sjimharris scif_sas_io_request_state_handler_table, 147230557Sjimharris SCI_BASE_REQUEST_STATE_STARTED 148230557Sjimharris ); 149230557Sjimharris} 150230557Sjimharris 151230557Sjimharris/** 152230557Sjimharris * @brief This method implements the actions taken when entering the 153230557Sjimharris * COMPLETED state. 154230557Sjimharris * 155230557Sjimharris * @param[in] object This parameter specifies the base object for which 156230557Sjimharris * the state transition is occurring. This is cast into a 157230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 158230557Sjimharris * 159230557Sjimharris * @return none 160230557Sjimharris */ 161230557Sjimharrisstatic 162230557Sjimharrisvoid scif_sas_io_request_completed_state_enter( 163230557Sjimharris SCI_BASE_OBJECT_T *object 164230557Sjimharris) 165230557Sjimharris{ 166230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = (SCIF_SAS_IO_REQUEST_T *)object; 167230557Sjimharris 168230557Sjimharris SET_STATE_HANDLER( 169230557Sjimharris &fw_io->parent, 170230557Sjimharris scif_sas_io_request_state_handler_table, 171230557Sjimharris SCI_BASE_REQUEST_STATE_COMPLETED 172230557Sjimharris ); 173230557Sjimharris} 174230557Sjimharris 175230557Sjimharris/** 176230557Sjimharris * @brief This method implements the actions taken when entering the 177230557Sjimharris * ABORTING state. 178230557Sjimharris * 179230557Sjimharris * @param[in] object This parameter specifies the base object for which 180230557Sjimharris * the state transition is occurring. This is cast into a 181230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 182230557Sjimharris * 183230557Sjimharris * @return none 184230557Sjimharris */ 185230557Sjimharrisstatic 186230557Sjimharrisvoid scif_sas_io_request_aborting_state_enter( 187230557Sjimharris SCI_BASE_OBJECT_T *object 188230557Sjimharris) 189230557Sjimharris{ 190230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = (SCIF_SAS_IO_REQUEST_T *)object; 191230557Sjimharris 192230557Sjimharris SCIF_LOG_WARNING(( 193230557Sjimharris sci_base_object_get_logger(fw_io), 194230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST | SCIF_LOG_OBJECT_TASK_MANAGEMENT, 195230557Sjimharris "Domain:0x%x Device:0x%x IORequest:0x%x terminating\n", 196230557Sjimharris fw_io->parent.device->domain, fw_io->parent.device, fw_io 197230557Sjimharris )); 198230557Sjimharris 199230557Sjimharris SET_STATE_HANDLER( 200230557Sjimharris &fw_io->parent, 201230557Sjimharris scif_sas_io_request_state_handler_table, 202230557Sjimharris SCI_BASE_REQUEST_STATE_ABORTING 203230557Sjimharris ); 204230557Sjimharris 205230557Sjimharris fw_io->parent.status = scif_sas_request_terminate_start( 206230557Sjimharris &fw_io->parent, fw_io->parent.core_object 207230557Sjimharris ); 208230557Sjimharris} 209230557Sjimharris 210230557Sjimharris/** 211230557Sjimharris * @brief This method implements the actions taken when exiting the 212230557Sjimharris * ABORTING state. 213230557Sjimharris * 214230557Sjimharris * @param[in] object This parameter specifies the base object for which 215230557Sjimharris * the state transition is occurring. This is cast into a 216230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 217230557Sjimharris * 218230557Sjimharris * @return none 219230557Sjimharris */ 220230557Sjimharrisstatic 221230557Sjimharrisvoid scif_sas_io_request_aborting_state_exit( 222230557Sjimharris SCI_BASE_OBJECT_T *object 223230557Sjimharris) 224230557Sjimharris{ 225230557Sjimharris SCIF_SAS_REQUEST_T * fw_request = (SCIF_SAS_REQUEST_T *)object; 226230557Sjimharris scif_sas_request_terminate_complete(fw_request); 227230557Sjimharris} 228230557Sjimharris 229230557Sjimharris/** 230230557Sjimharris * @brief This method implements the actions taken when entering the 231230557Sjimharris * FINAL state. 232230557Sjimharris * 233230557Sjimharris * @param[in] object This parameter specifies the base object for which 234230557Sjimharris * the state transition is occurring. This is cast into a 235230557Sjimharris * SCIF_SAS_IO_REQUEST object in the method implementation. 236230557Sjimharris * 237230557Sjimharris * @return none 238230557Sjimharris */ 239230557Sjimharrisstatic 240230557Sjimharrisvoid scif_sas_io_request_final_state_enter( 241230557Sjimharris SCI_BASE_OBJECT_T *object 242230557Sjimharris) 243230557Sjimharris{ 244230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = (SCIF_SAS_IO_REQUEST_T *)object; 245230557Sjimharris 246230557Sjimharris SET_STATE_HANDLER( 247230557Sjimharris &fw_io->parent, 248230557Sjimharris scif_sas_io_request_state_handler_table, 249230557Sjimharris SCI_BASE_REQUEST_STATE_FINAL 250230557Sjimharris ); 251230557Sjimharris} 252230557Sjimharris 253230557SjimharrisSCI_BASE_STATE_T scif_sas_io_request_state_table[SCI_BASE_REQUEST_MAX_STATES] = 254230557Sjimharris{ 255230557Sjimharris { 256230557Sjimharris SCI_BASE_REQUEST_STATE_INITIAL, 257230557Sjimharris scif_sas_io_request_initial_state_enter, 258230557Sjimharris NULL 259230557Sjimharris }, 260230557Sjimharris { 261230557Sjimharris SCI_BASE_REQUEST_STATE_CONSTRUCTED, 262230557Sjimharris scif_sas_io_request_constructed_state_enter, 263230557Sjimharris NULL 264230557Sjimharris }, 265230557Sjimharris { 266230557Sjimharris SCI_BASE_REQUEST_STATE_STARTED, 267230557Sjimharris scif_sas_io_request_started_state_enter, 268230557Sjimharris NULL 269230557Sjimharris }, 270230557Sjimharris { 271230557Sjimharris SCI_BASE_REQUEST_STATE_COMPLETED, 272230557Sjimharris scif_sas_io_request_completed_state_enter, 273230557Sjimharris NULL 274230557Sjimharris }, 275230557Sjimharris { 276230557Sjimharris SCI_BASE_REQUEST_STATE_ABORTING, 277230557Sjimharris scif_sas_io_request_aborting_state_enter, 278230557Sjimharris scif_sas_io_request_aborting_state_exit 279230557Sjimharris }, 280230557Sjimharris { 281230557Sjimharris SCI_BASE_REQUEST_STATE_FINAL, 282230557Sjimharris scif_sas_io_request_final_state_enter, 283230557Sjimharris NULL 284230557Sjimharris }, 285230557Sjimharris}; 286230557Sjimharris 287