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 the implementation of the SCIF_SAS_REQUEST 60230557Sjimharris * object. The SCIF_SAS_REQUEST object provides data and methods 61230557Sjimharris * that are common to both IO requests and task management requests. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris 65230557Sjimharris#include <dev/isci/scil/scic_controller.h> 66230557Sjimharris 67230557Sjimharris#include <dev/isci/scil/scif_sas_request.h> 68230557Sjimharris#include <dev/isci/scil/scif_sas_task_request.h> 69230557Sjimharris#include <dev/isci/scil/scif_sas_controller.h> 70230557Sjimharris#include <dev/isci/scil/scif_sas_domain.h> 71230557Sjimharris#include <dev/isci/scil/scif_sas_remote_device.h> 72230557Sjimharris 73230557Sjimharris#include <dev/isci/scil/scif_sas_logger.h> 74230557Sjimharris 75230557Sjimharris//****************************************************************************** 76230557Sjimharris//* P R O T E C T E D M E T H O D S 77230557Sjimharris//****************************************************************************** 78230557Sjimharris 79230557Sjimharris/** 80230557Sjimharris * @brief This method constructs the SCIF_SAS_REQUEST object. 81230557Sjimharris * 82230557Sjimharris * @param[in] fw_request This parameter specifies the request object to 83230557Sjimharris * be constructed. 84230557Sjimharris * @param[in] fw_device This parameter specifies the remote device object 85230557Sjimharris * to which this request is destined. 86230557Sjimharris * @param[in] logger This parameter specifies the logger associated with 87230557Sjimharris * this base request object. 88230557Sjimharris * @param[in] state_table This parameter specifies the table of state 89230557Sjimharris * definitions to be utilized for the request state machine. 90230557Sjimharris * 91230557Sjimharris * @return none 92230557Sjimharris */ 93230557Sjimharrisvoid scif_sas_request_construct( 94230557Sjimharris SCIF_SAS_REQUEST_T * fw_request, 95230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * fw_device, 96230557Sjimharris SCI_BASE_LOGGER_T * logger, 97230557Sjimharris SCI_BASE_STATE_T * state_table 98230557Sjimharris) 99230557Sjimharris{ 100230557Sjimharris sci_base_request_construct(&fw_request->parent, logger, state_table); 101230557Sjimharris 102230557Sjimharris SCIF_LOG_TRACE(( 103230557Sjimharris sci_base_object_get_logger(fw_request), 104230557Sjimharris SCIF_LOG_OBJECT_TASK_MANAGEMENT, 105230557Sjimharris "scif_sas_request_construct(0x%x, 0x%x, 0x%x, 0x%x) enter\n", 106230557Sjimharris fw_request, fw_device, logger, state_table 107230557Sjimharris )); 108230557Sjimharris 109230557Sjimharris fw_request->device = fw_device; 110230557Sjimharris fw_request->is_internal = FALSE; 111230557Sjimharris fw_request->lun = 0; 112230557Sjimharris fw_request->terminate_requestor = NULL; 113230557Sjimharris fw_request->protocol_complete_handler = NULL; 114230557Sjimharris fw_request->is_high_priority = FALSE; 115230557Sjimharris fw_request->is_waiting_for_abort_task_set = FALSE; 116230557Sjimharris 117230557Sjimharris sci_fast_list_element_init(fw_request, &fw_request->list_element); 118230557Sjimharris} 119230557Sjimharris 120230557Sjimharris/** 121230557Sjimharris * @brief This method will request the SCI core to terminate the supplied 122230557Sjimharris * request. 123230557Sjimharris * 124230557Sjimharris * @param[in] fw_request This parameter specifies the request to be terminated. 125230557Sjimharris * @param[in] core_request This parameter specifies the core request (IO or 126230557Sjimharris * task) to be terminated. 127230557Sjimharris * 128230557Sjimharris * @return This method returns the status of the core termination operation. 129230557Sjimharris */ 130230557SjimharrisSCI_STATUS scif_sas_request_terminate_start( 131230557Sjimharris SCIF_SAS_REQUEST_T * fw_request, 132230557Sjimharris SCI_IO_REQUEST_HANDLE_T core_request 133230557Sjimharris) 134230557Sjimharris{ 135230557Sjimharris SCIF_LOG_TRACE(( 136230557Sjimharris sci_base_object_get_logger(fw_request), 137230557Sjimharris SCIF_LOG_OBJECT_TASK_MANAGEMENT, 138230557Sjimharris "scif_sas_request_terminate_start(0x%x) enter\n", 139230557Sjimharris fw_request 140230557Sjimharris )); 141230557Sjimharris 142230557Sjimharris // Only increment the affected request count if this request is being 143230557Sjimharris // terminated at the behest of a task management request. 144230557Sjimharris if (fw_request->terminate_requestor != NULL) 145230557Sjimharris fw_request->terminate_requestor->affected_request_count++; 146230557Sjimharris 147230557Sjimharris return scic_controller_terminate_request( 148230557Sjimharris fw_request->device->domain->controller->core_object, 149230557Sjimharris fw_request->device->core_object, 150230557Sjimharris core_request 151230557Sjimharris ); 152230557Sjimharris} 153230557Sjimharris 154230557Sjimharris/** 155230557Sjimharris * @brief This method will perform termination completion processing for 156230557Sjimharris * the supplied request. This includes updated the affected 157230557Sjimharris * request count, if a task management request is what generated 158230557Sjimharris * this termination. Also, this method will attempt to transition 159230557Sjimharris * to the READY OPERATIONAL state if this represents the last 160230557Sjimharris * affected request. 161230557Sjimharris * 162230557Sjimharris * @param[in] fw_request This parameter specifies the request for which to 163230557Sjimharris * perform termination completion processing. 164230557Sjimharris * 165230557Sjimharris * @return none 166230557Sjimharris */ 167230557Sjimharrisvoid scif_sas_request_terminate_complete( 168230557Sjimharris SCIF_SAS_REQUEST_T * fw_request 169230557Sjimharris) 170230557Sjimharris{ 171230557Sjimharris SCIF_LOG_TRACE(( 172230557Sjimharris sci_base_object_get_logger(fw_request), 173230557Sjimharris SCIF_LOG_OBJECT_TASK_MANAGEMENT, 174230557Sjimharris "scif_sas_request_terminate_complete(0x%x) enter\n", 175230557Sjimharris fw_request 176230557Sjimharris )); 177230557Sjimharris 178230557Sjimharris // For requests that were terminated due to a task management request, 179230557Sjimharris // check to see if the task management request has completed. 180230557Sjimharris if (fw_request->terminate_requestor != NULL) 181230557Sjimharris scif_sas_task_request_operation_complete(fw_request->terminate_requestor); 182230557Sjimharris} 183230557Sjimharris 184