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 * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCIF_SAS_INTERNAL_REQUEST_H_ 55230557Sjimharris#define _SCIF_SAS_INTERNAL_REQUEST_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains the protected interface structures, constants, 61230557Sjimharris * and methods for the SCIF_SAS_INTERNAL_REQUEST object. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris 69230557Sjimharris#include <dev/isci/scil/scif_io_request.h> 70230557Sjimharris#include <dev/isci/scil/sci_base_request.h> 71230557Sjimharris#include <dev/isci/scil/scif_sas_request.h> 72230557Sjimharris#include <dev/isci/scil/scif_sas_io_request.h> 73230557Sjimharris#include <dev/isci/scil/scif_sas_remote_device.h> 74230557Sjimharris#include <dev/isci/scil/intel_sas.h> 75230557Sjimharris#include <dev/isci/scil/sci_controller_constants.h> 76230557Sjimharris 77230557Sjimharrisstruct SCIF_SAS_CONTROLLER; 78230557Sjimharris 79230557Sjimharris/** 80230557Sjimharris * This constant dictates the maximum number of internal framework 81230557Sjimharris * IO request objects. These objects are used for internal SMP requests 82230557Sjimharris * and for NCQ error handling. 83230557Sjimharris */ 84230557Sjimharris#define SCIF_SAS_MAX_INTERNAL_REQUEST_COUNT (SCI_MAX_DOMAINS*4) 85230557Sjimharris 86230557Sjimharris/** 87230557Sjimharris * This constant dictates the minimum number of internal framework 88230557Sjimharris * IO request objects when size-constrained. 89230557Sjimharris */ 90230557Sjimharris#define SCIF_SAS_MIN_INTERNAL_REQUEST_COUNT (SCI_MAX_DOMAINS) 91230557Sjimharris 92230557Sjimharris/* 93230557Sjimharris * This constant indicates the timeout value of an internal IO request 94230557Sjimharris * in mili-seconds. 95230557Sjimharris */ 96230557Sjimharris#define SCIF_SAS_INTERNAL_REQUEST_TIMEOUT 3000 97230557Sjimharris 98230557Sjimharris/** 99230557Sjimharris * @struct SCIF_SAS_INTERNAL_IO_REQUEST 100230557Sjimharris * 101230557Sjimharris * @brief The SCIF_SAS_INTERNAL_IO_REQUEST object represents the internal SAS 102230557Sjimharris * IO request behavior for the framework component. 103230557Sjimharris */ 104230557Sjimharristypedef struct SCIF_SAS_INTERNAL_IO_REQUEST 105230557Sjimharris{ 106230557Sjimharris /** 107230557Sjimharris * The SCIF_SAS_IO_REQUEST is the parent object for the 108230557Sjimharris * SCIF_SAS_INTERNAL_IO_REQUEST object. 109230557Sjimharris */ 110230557Sjimharris SCIF_SAS_IO_REQUEST_T parent; 111230557Sjimharris 112230557Sjimharris /** 113230557Sjimharris * This field will be utilized only by internal IO to handle timeout 114230557Sjimharris * situation. 115230557Sjimharris */ 116230557Sjimharris void * internal_io_timer; 117230557Sjimharris 118230557Sjimharris}SCIF_SAS_INTERNAL_IO_REQUEST_T; 119230557Sjimharris 120230557Sjimharris 121230557SjimharrisU32 scif_sas_internal_request_get_object_size( 122230557Sjimharris void 123230557Sjimharris); 124230557Sjimharris 125230557SjimharrisSCI_STATUS scif_sas_internal_io_request_construct_smp( 126230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller, 127230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T * fw_remote_device, 128230557Sjimharris void * internal_io_memory, 129230557Sjimharris U16 io_tag, 130230557Sjimharris SMP_REQUEST_T * smp_command 131230557Sjimharris); 132230557Sjimharris 133230557SjimharrisSCI_STATUS scif_sas_internal_io_request_construct_stp( 134230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io 135230557Sjimharris); 136230557Sjimharris 137230557Sjimharrisvoid scif_sas_internal_io_request_timeout_handler( 138230557Sjimharris void * fw_io 139230557Sjimharris); 140230557Sjimharris 141230557Sjimharrisvoid scif_sas_internal_io_request_complete( 142230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller, 143230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_io, 144230557Sjimharris SCI_STATUS completion_status 145230557Sjimharris); 146230557Sjimharris 147230557Sjimharrisvoid scif_sas_internal_io_request_destruct( 148230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller, 149230557Sjimharris SCIF_SAS_INTERNAL_IO_REQUEST_T * fw_internal_io 150230557Sjimharris); 151230557Sjimharris 152230557Sjimharris#ifdef __cplusplus 153230557Sjimharris} 154230557Sjimharris#endif // __cplusplus 155230557Sjimharris 156230557Sjimharris#endif // _SCIF_SAS_IO_REQUEST_H_ 157230557Sjimharris 158