1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3 * 4 * This file is provided under a dual BSD/GPLv2 license. When using or 5 * redistributing this file, you may do so under either license. 6 * 7 * GPL LICENSE SUMMARY 8 * 9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10 * 11 * This program is free software; you can redistribute it and/or modify 12 * it under the terms of version 2 of the GNU General Public License as 13 * published by the Free Software Foundation. 14 * 15 * This program is distributed in the hope that it will be useful, but 16 * WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18 * General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23 * The full GNU General Public License is included in this distribution 24 * in the file called LICENSE.GPL. 25 * 26 * BSD LICENSE 27 * 28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions 33 * are met: 34 * 35 * * Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * * Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in 39 * the documentation and/or other materials provided with the 40 * distribution. 41 * 42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53 * 54 * $FreeBSD$ 55 */ 56 #ifndef _SCIF_SAS_IO_REQUEST_H_ 57 #define _SCIF_SAS_IO_REQUEST_H_ 58 59 /** 60 * @file 61 * 62 * @brief This file contains the protected interface structures, constants, 63 * and methods for the SCIF_SAS_IO_REQUEST object. 64 */ 65 66 #ifdef __cplusplus 67 extern "C" { 68 #endif // __cplusplus 69 70 #include <dev/isci/scil/scif_io_request.h> 71 #include <dev/isci/scil/sci_base_request.h> 72 #include <dev/isci/scil/scif_sas_request.h> 73 #include <dev/isci/scil/scif_sas_stp_io_request.h> 74 #include <dev/isci/scil/intel_sas.h> 75 76 77 struct SCIF_SAS_CONTROLLER; 78 struct SCIF_SAS_REMOTE_DEVICE; 79 80 //Note 0xFF is the maximum possible value to IO_RETRY_LIMIT since the io_retry_count in 81 //SCIF_SAS_IO_REQUEST is in type of U8. 82 #define SCIF_SAS_IO_RETRY_LIMIT 0xFF 83 84 /** 85 * @struct SCIF_SAS_IO_REQUEST 86 * 87 * @brief The SCI SAS Framework IO request object abstracts the SAS IO 88 * level behavior for the framework component. Additionally, 89 * it provides a higher level of abstraction for the core IO request 90 * object. 91 */ 92 typedef struct SCIF_SAS_IO_REQUEST 93 { 94 /** 95 * The SCI_BASE_REQUEST is the parent object for the 96 * SCIF_SAS_IO_REQUEST object. 97 */ 98 SCIF_SAS_REQUEST_T parent; 99 100 /** 101 * This field specifies the number of bytes to be utilized for this 102 * IO request. This field is utilized during internal IO requests. 103 */ 104 U32 transfer_length; 105 106 /** 107 * This field keeps track of how many times an io got retried. 108 */ 109 U8 retry_count; 110 111 } SCIF_SAS_IO_REQUEST_T; 112 113 extern SCI_BASE_STATE_T scif_sas_io_request_state_table[]; 114 extern SCI_BASE_REQUEST_STATE_HANDLER_T 115 scif_sas_io_request_state_handler_table[]; 116 117 SCI_STATUS scif_sas_io_request_constructed_start_handler( 118 SCI_BASE_REQUEST_T * io_request 119 ); 120 121 SCI_STATUS scif_sas_io_request_constructed_abort_handler( 122 SCI_BASE_REQUEST_T * io_request 123 ); 124 125 SCI_STATUS scif_sas_io_request_default_complete_handler( 126 SCI_BASE_REQUEST_T * io_request 127 ); 128 129 SCI_STATUS scif_sas_io_request_default_destruct_handler( 130 SCI_BASE_REQUEST_T * io_request 131 ); 132 133 SCI_STATUS scif_sas_io_request_construct_smp( 134 struct SCIF_SAS_CONTROLLER * fw_controller, 135 struct SCIF_SAS_REMOTE_DEVICE * fw_device, 136 void * fw_io_memory, 137 void * core_io_memory, 138 U16 io_tag, 139 SMP_REQUEST_T * smp_command, 140 void * user_request_object 141 ); 142 143 SCI_STATUS scif_sas_io_request_continue( 144 struct SCIF_SAS_CONTROLLER * fw_controller, 145 struct SCIF_SAS_REMOTE_DEVICE * fw_device, 146 SCIF_SAS_REQUEST_T * fw_request 147 ); 148 149 #ifdef __cplusplus 150 } 151 #endif // __cplusplus 152 153 #endif // _SCIF_SAS_IO_REQUEST_H_ 154 155