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_IO_REQUEST_H_ 55230557Sjimharris#define _SCIF_SAS_IO_REQUEST_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains the protected interface structures, constants, 61230557Sjimharris * and methods for the SCIF_SAS_IO_REQUEST object. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/scif_io_request.h> 69230557Sjimharris#include <dev/isci/scil/sci_base_request.h> 70230557Sjimharris#include <dev/isci/scil/scif_sas_request.h> 71230557Sjimharris#include <dev/isci/scil/scif_sas_stp_io_request.h> 72230557Sjimharris#include <dev/isci/scil/intel_sas.h> 73230557Sjimharris 74230557Sjimharris 75230557Sjimharrisstruct SCIF_SAS_CONTROLLER; 76230557Sjimharrisstruct SCIF_SAS_REMOTE_DEVICE; 77230557Sjimharris 78230557Sjimharris//Note 0xFF is the maximum possible value to IO_RETRY_LIMIT since the io_retry_count in 79230557Sjimharris//SCIF_SAS_IO_REQUEST is in type of U8. 80230557Sjimharris#define SCIF_SAS_IO_RETRY_LIMIT 0xFF 81230557Sjimharris 82230557Sjimharris/** 83230557Sjimharris * @struct SCIF_SAS_IO_REQUEST 84230557Sjimharris * 85230557Sjimharris * @brief The SCI SAS Framework IO request object abstracts the SAS IO 86230557Sjimharris * level behavior for the framework component. Additionally, 87230557Sjimharris * it provides a higher level of abstraction for the core IO request 88230557Sjimharris * object. 89230557Sjimharris */ 90230557Sjimharristypedef struct SCIF_SAS_IO_REQUEST 91230557Sjimharris{ 92230557Sjimharris /** 93230557Sjimharris * The SCI_BASE_REQUEST is the parent object for the 94230557Sjimharris * SCIF_SAS_IO_REQUEST object. 95230557Sjimharris */ 96230557Sjimharris SCIF_SAS_REQUEST_T parent; 97230557Sjimharris 98230557Sjimharris /** 99230557Sjimharris * This field specifies the number of bytes to be utilized for this 100230557Sjimharris * IO request. This field is utilized during internal IO requests. 101230557Sjimharris */ 102230557Sjimharris U32 transfer_length; 103230557Sjimharris 104230557Sjimharris /** 105230557Sjimharris * This field keeps track of how many times an io got retried. 106230557Sjimharris */ 107230557Sjimharris U8 retry_count; 108230557Sjimharris 109230557Sjimharris} SCIF_SAS_IO_REQUEST_T; 110230557Sjimharris 111230557Sjimharrisextern SCI_BASE_STATE_T scif_sas_io_request_state_table[]; 112230557Sjimharrisextern SCI_BASE_REQUEST_STATE_HANDLER_T 113230557Sjimharris scif_sas_io_request_state_handler_table[]; 114230557Sjimharris 115230557SjimharrisSCI_STATUS scif_sas_io_request_constructed_start_handler( 116230557Sjimharris SCI_BASE_REQUEST_T * io_request 117230557Sjimharris); 118230557Sjimharris 119230557SjimharrisSCI_STATUS scif_sas_io_request_constructed_abort_handler( 120230557Sjimharris SCI_BASE_REQUEST_T * io_request 121230557Sjimharris); 122230557Sjimharris 123230557SjimharrisSCI_STATUS scif_sas_io_request_default_complete_handler( 124230557Sjimharris SCI_BASE_REQUEST_T * io_request 125230557Sjimharris); 126230557Sjimharris 127230557SjimharrisSCI_STATUS scif_sas_io_request_default_destruct_handler( 128230557Sjimharris SCI_BASE_REQUEST_T * io_request 129230557Sjimharris); 130230557Sjimharris 131230557SjimharrisSCI_STATUS scif_sas_io_request_construct_smp( 132230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller, 133230557Sjimharris struct SCIF_SAS_REMOTE_DEVICE * fw_device, 134230557Sjimharris void * fw_io_memory, 135230557Sjimharris void * core_io_memory, 136230557Sjimharris U16 io_tag, 137230557Sjimharris SMP_REQUEST_T * smp_command, 138230557Sjimharris void * user_request_object 139230557Sjimharris); 140230557Sjimharris 141230557SjimharrisSCI_STATUS scif_sas_io_request_continue( 142230557Sjimharris struct SCIF_SAS_CONTROLLER * fw_controller, 143230557Sjimharris struct SCIF_SAS_REMOTE_DEVICE * fw_device, 144230557Sjimharris SCIF_SAS_REQUEST_T * fw_request 145230557Sjimharris); 146230557Sjimharris 147230557Sjimharris#ifdef __cplusplus 148230557Sjimharris} 149230557Sjimharris#endif // __cplusplus 150230557Sjimharris 151230557Sjimharris#endif // _SCIF_SAS_IO_REQUEST_H_ 152230557Sjimharris 153