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 60230557Sjimharris * SCIF_SAS_INTERNAL_IO_REQUEST object. 61230557Sjimharris */ 62230557Sjimharris 63230557Sjimharris 64230557Sjimharris#include <dev/isci/scil/scic_io_request.h> 65230557Sjimharris#include <dev/isci/scil/scic_remote_device.h> 66230557Sjimharris#include <dev/isci/scil/scic_user_callback.h> 67230557Sjimharris#include <dev/isci/scil/scic_controller.h> 68230557Sjimharris#include <dev/isci/scil/scic_task_request.h> 69230557Sjimharris#include <dev/isci/scil/scif_user_callback.h> 70230557Sjimharris 71230557Sjimharris#include <dev/isci/scil/scif_sas_controller.h> 72230557Sjimharris#include <dev/isci/scil/scif_sas_domain.h> 73230557Sjimharris#include <dev/isci/scil/scif_sas_remote_device.h> 74230557Sjimharris#include <dev/isci/scil/scif_sas_io_request.h> 75230557Sjimharris#include <dev/isci/scil/scif_sas_internal_io_request.h> 76230557Sjimharris#include <dev/isci/scil/scif_sas_task_request.h> 77230557Sjimharris#include <dev/isci/scil/scif_sas_stp_io_request.h> 78230557Sjimharris#include <dev/isci/scil/scif_sas_logger.h> 79230557Sjimharris#include <dev/isci/scil/scif_sas_smp_io_request.h> 80230557Sjimharris#include <dev/isci/scil/sci_util.h> 81230557Sjimharris 82230557Sjimharris//****************************************************************************** 83230557Sjimharris//* P U B L I C M E T H O D S 84230557Sjimharris//****************************************************************************** 85230557Sjimharris 86230557Sjimharris/** 87230557Sjimharris * @brief this routine return all memory needed for an internal request, both 88230557Sjimharris * framework and core request. 89230557Sjimharris * 90230557Sjimharris * @return U32 size of all memory needed for an internal request 91230557Sjimharris */ 92230557SjimharrisU32 scif_sas_internal_request_get_object_size( 93230557Sjimharris void 94230557Sjimharris) 95230557Sjimharris{ 96230557Sjimharris return MAX( 97230557Sjimharris (sizeof(SCIF_SAS_INTERNAL_IO_REQUEST_T) + scic_io_request_get_object_size()), 98230557Sjimharris (sizeof(SCIF_SAS_TASK_REQUEST_T) + scic_task_request_get_object_size()) 99230557Sjimharris ); 100230557Sjimharris} 101230557Sjimharris 102230557Sjimharris 103230557Sjimharris/** 104230557Sjimharris * @brief This method constructs an internal smp request. 105230557Sjimharris * 106230557Sjimharris * @param[in] fw_controller The framework controller 107230557Sjimharris * @param[in] fw_device The smp device that the internal io targets to. 108230557Sjimharris * @param[in] internal_io_memory The memory space for the internal io. 109230557Sjimharris * @param[in] io_tag The io tag for the internl io to be constructed. 110230557Sjimharris * @param[in] smp_command A pointer to the smp request data structure according 111230557Sjimharris * to SAS protocol. 112230557Sjimharris * 113230557Sjimharris * @return Indicate if the internal io was successfully constructed. 114230557Sjimharris * @retval SCI_SUCCESS This value is returned if the internal io was 115230557Sjimharris * successfully constructed. 116230557Sjimharris * @retval SCI_FAILURE This value is returned if the internal io was failed to 117230557Sjimharris * be constructed. 118230557Sjimharris */ 119230557SjimharrisSCI_STATUS scif_sas_internal_io_request_construct_smp( 120230557Sjimharris SCIF_SAS_CONTROLLER_T * fw_controller, 121230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * fw_device, 122230557Sjimharris void * internal_io_memory, 123230557Sjimharris U16 io_tag, 124230557Sjimharris SMP_REQUEST_T * smp_command 125230557Sjimharris) 126230557Sjimharris{ 127230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io = 128230557Sjimharris (SCIF_SAS_INTERNAL_IO_REQUEST_T*)internal_io_memory; 129230557Sjimharris 130230557Sjimharris SCIF_SAS_IO_REQUEST_T * fw_io = 131230557Sjimharris (SCIF_SAS_IO_REQUEST_T*)internal_io_memory; 132230557Sjimharris 133230557Sjimharris SCI_STATUS status; 134230557Sjimharris 135230557Sjimharris //call common smp request construct routine. 136230557Sjimharris status = scif_sas_io_request_construct_smp( 137230557Sjimharris fw_controller, 138230557Sjimharris fw_device, 139230557Sjimharris internal_io_memory, 140230557Sjimharris (char *)internal_io_memory + sizeof(SCIF_SAS_INTERNAL_IO_REQUEST_T), 141230557Sjimharris SCI_CONTROLLER_INVALID_IO_TAG, 142230557Sjimharris smp_command, 143230557Sjimharris NULL //there is no associated user io object. 144230557Sjimharris ); 145230557Sjimharris 146230557Sjimharris //Codes below are all internal io related. 147230557Sjimharris if (status == SCI_SUCCESS) 148230557Sjimharris { 149230557Sjimharris //set the is_internal flag 150230557Sjimharris fw_io->parent.is_internal = TRUE; 151230557Sjimharris 152230557Sjimharris if (fw_internal_io->internal_io_timer == NULL) 153230557Sjimharris { 154230557Sjimharris //create the timer for this internal request. 155230557Sjimharris fw_internal_io->internal_io_timer = 156230557Sjimharris scif_cb_timer_create( 157230557Sjimharris (SCI_CONTROLLER_HANDLE_T *)fw_controller, 158230557Sjimharris scif_sas_internal_io_request_timeout_handler, 159230557Sjimharris (void*)fw_io 160230557Sjimharris ); 161230557Sjimharris } 162230557Sjimharris else 163230557Sjimharris { 164230557Sjimharris ASSERT (0); 165230557Sjimharris } 166230557Sjimharris 167230557Sjimharris //insert into high priority queue 168230557Sjimharris if ( !sci_pool_full(fw_controller->hprq.pool) ) 169230557Sjimharris { 170230557Sjimharris sci_pool_put( 171230557Sjimharris fw_controller->hprq.pool, (POINTER_UINT) internal_io_memory 172230557Sjimharris ); 173230557Sjimharris } 174230557Sjimharris else 175230557Sjimharris { 176230557Sjimharris SCIF_LOG_ERROR(( 177230557Sjimharris sci_base_object_get_logger(fw_controller), 178230557Sjimharris SCIF_LOG_OBJECT_CONTROLLER | SCIF_LOG_OBJECT_REMOTE_DEVICE, 179230557Sjimharris "scif_sas_internal_io_request_construct_smp, high priority queue full!\n" 180230557Sjimharris )); 181230557Sjimharris 182230557Sjimharris scif_sas_internal_io_request_destruct(fw_controller, fw_internal_io); 183230557Sjimharris 184230557Sjimharris //return failure status. 185230557Sjimharris return SCI_FAILURE_INSUFFICIENT_RESOURCES; 186230557Sjimharris } 187230557Sjimharris } 188230557Sjimharris 189230557Sjimharris return status; 190230557Sjimharris} 191230557Sjimharris 192230557Sjimharris 193230557Sjimharris/** 194230557Sjimharris * @brief This method constructs an internal smp request. 195230557Sjimharris * @param[in] fw_io 196230557Sjimharris * 197230557Sjimharris * @return SCI_STATUS 198230557Sjimharris */ 199230557SjimharrisSCI_STATUS scif_sas_internal_io_request_construct_stp( 200230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io 201230557Sjimharris) 202230557Sjimharris{ 203230557Sjimharris //TBD 204230557Sjimharris return SCI_SUCCESS; 205230557Sjimharris} 206230557Sjimharris 207230557Sjimharris 208230557Sjimharris/** 209230557Sjimharris * @brief This method handles the timeout situation for an internal io. 210230557Sjimharris * 211230557Sjimharris * @param[in] fw_internal_io The timed out IO. 212230557Sjimharris * 213230557Sjimharris * @return none 214230557Sjimharris */ 215230557Sjimharrisvoid scif_sas_internal_io_request_timeout_handler( 216230557Sjimharris void * fw_internal_io 217230557Sjimharris) 218230557Sjimharris{ 219230557Sjimharris SCIF_SAS_REQUEST_T * fw_request = (SCIF_SAS_REQUEST_T *)fw_internal_io; 220230557Sjimharris 221230557Sjimharris SCIF_LOG_TRACE(( 222230557Sjimharris sci_base_object_get_logger(fw_request), 223230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST, 224230557Sjimharris "scif_sas_internal_io_request_timeout_handler(0x%x) enter\n", 225230557Sjimharris fw_internal_io 226230557Sjimharris )); 227230557Sjimharris 228230557Sjimharris fw_request->state_handlers->abort_handler(&fw_request->parent); 229230557Sjimharris} 230230557Sjimharris 231230557Sjimharris 232230557Sjimharris/** 233230557Sjimharris * @brief This methods takes care of completion of an internal request about its 234230557Sjimharris * "internal" related feature, including the memory recycling and timer. 235230557Sjimharris * 236230557Sjimharris * @param[in] fw_controller The framework controller object. 237230557Sjimharris * @param[in] fw_internal_io The internal io to be completed. 238230557Sjimharris * @param[in] completion_status the completeion status by core and framework so 239230557Sjimharris * far. 240230557Sjimharris * 241230557Sjimharris * @return none 242230557Sjimharris */ 243230557Sjimharrisvoid scif_sas_internal_io_request_complete( 244230557Sjimharris SCIF_SAS_CONTROLLER_T * fw_controller, 245230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io, 246230557Sjimharris SCI_STATUS completion_status 247230557Sjimharris) 248230557Sjimharris{ 249230557Sjimharris SCIF_LOG_TRACE(( 250230557Sjimharris sci_base_object_get_logger(fw_controller), 251230557Sjimharris SCIF_LOG_OBJECT_IO_REQUEST, 252230557Sjimharris "scif_sas_internal_io_request_complete(0x%x, 0x%x, 0x%x) enter\n", 253230557Sjimharris fw_controller, fw_internal_io, completion_status 254230557Sjimharris )); 255230557Sjimharris 256230557Sjimharris scif_cb_timer_stop(fw_controller, fw_internal_io->internal_io_timer); 257230557Sjimharris scif_sas_internal_io_request_destruct(fw_controller, fw_internal_io); 258230557Sjimharris} 259230557Sjimharris 260230557Sjimharris 261230557Sjimharris/** 262230557Sjimharris * @brief This methods takes care of destruction of an internal request about its 263230557Sjimharris * "internal" related feature, including the memory recycling and timer. 264230557Sjimharris * 265230557Sjimharris * @param[in] fw_controller The framework controller object. 266230557Sjimharris * @param[in] fw_internal_io The internal io to be completed. 267230557Sjimharris * 268230557Sjimharris * @return none 269230557Sjimharris */ 270230557Sjimharrisvoid scif_sas_internal_io_request_destruct( 271230557Sjimharris SCIF_SAS_CONTROLLER_T * fw_controller, 272230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io 273230557Sjimharris) 274230557Sjimharris{ 275230557Sjimharris if (fw_internal_io->internal_io_timer != NULL) 276230557Sjimharris { 277230557Sjimharris scif_cb_timer_destroy(fw_controller, fw_internal_io->internal_io_timer); 278230557Sjimharris fw_internal_io->internal_io_timer = NULL; 279230557Sjimharris } 280230557Sjimharris scif_sas_controller_free_internal_request(fw_controller, fw_internal_io); 281230557Sjimharris} 282230557Sjimharris 283