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 #ifndef _SCI_BASE_REQUST_H_ 55 #define _SCI_BASE_REQUST_H_ 56 57 /** 58 * @file 59 * 60 * @brief This file contains all of the constants, types, and method 61 * declarations for the SCI base IO and task request objects. 62 */ 63 64 #ifdef __cplusplus 65 extern "C" { 66 #endif // __cplusplus 67 68 #include <dev/isci/scil/sci_base_logger.h> 69 #include <dev/isci/scil/sci_base_state_machine.h> 70 #include <dev/isci/scil/sci_base_state_machine_logger.h> 71 72 /** 73 * @enum SCI_BASE_REQUEST_STATES 74 * 75 * @brief This enumeration depicts all the states for the common request 76 * state machine. 77 */ 78 typedef enum _SCI_BASE_REQUEST_STATES 79 { 80 /** 81 * Simply the initial state for the base request state machine. 82 */ 83 SCI_BASE_REQUEST_STATE_INITIAL, 84 85 /** 86 * This state indicates that the request has been constructed. This state 87 * is entered from the INITIAL state. 88 */ 89 SCI_BASE_REQUEST_STATE_CONSTRUCTED, 90 91 /** 92 * This state indicates that the request has been started. This state is 93 * entered from the CONSTRUCTED state. 94 */ 95 SCI_BASE_REQUEST_STATE_STARTED, 96 97 /** 98 * This state indicates that the request has completed. 99 * This state is entered from the STARTED state. This state is entered from 100 * the ABORTING state. 101 */ 102 SCI_BASE_REQUEST_STATE_COMPLETED, 103 104 /** 105 * This state indicates that the request is in the process of being 106 * terminated/aborted. 107 * This state is entered from the CONSTRUCTED state. 108 * This state is entered from the STARTED state. 109 */ 110 SCI_BASE_REQUEST_STATE_ABORTING, 111 112 /** 113 * Simply the final state for the base request state machine. 114 */ 115 SCI_BASE_REQUEST_STATE_FINAL, 116 117 SCI_BASE_REQUEST_MAX_STATES 118 119 } SCI_BASE_REQUEST_STATES; 120 121 /** 122 * @struct SCI_BASE_REQUEST 123 * 124 * @brief The base request object abstracts the fields common to all SCI IO 125 * and task request objects. 126 */ 127 typedef struct SCI_BASE_REQUEST 128 { 129 /** 130 * The field specifies that the parent object for the base request is the 131 * base object itself. 132 */ 133 SCI_BASE_OBJECT_T parent; 134 135 /** 136 * This field contains the information for the base request state machine. 137 */ 138 SCI_BASE_STATE_MACHINE_T state_machine; 139 140 #ifdef SCI_LOGGING 141 SCI_BASE_STATE_MACHINE_LOGGER_T state_machine_logger; 142 #endif // SCI_LOGGING 143 144 } SCI_BASE_REQUEST_T; 145 146 typedef SCI_STATUS (*SCI_BASE_REQUEST_HANDLER_T)( 147 SCI_BASE_REQUEST_T * this_request 148 ); 149 150 /** 151 * @struct SCI_BASE_REQUEST_STATE_HANDLER 152 * 153 * @brief This structure contains all of the state handler methods common to 154 * base IO and task request state machines. Handler methods provide 155 * the ability to change the behavior for user requests or 156 * transitions depending on the state the machine is in. 157 * 158 */ 159 typedef struct SCI_BASE_REQUEST_STATE_HANDLER 160 { 161 /** 162 * The start_handler specifies the method invoked when a user attempts to 163 * start a request. 164 */ 165 SCI_BASE_REQUEST_HANDLER_T start_handler; 166 167 /** 168 * The abort_handler specifies the method invoked when a user attempts to 169 * abort a request. 170 */ 171 SCI_BASE_REQUEST_HANDLER_T abort_handler; 172 173 /** 174 * The complete_handler specifies the method invoked when a user attempts to 175 * complete a request. 176 */ 177 SCI_BASE_REQUEST_HANDLER_T complete_handler; 178 179 /** 180 * The destruct_handler specifies the method invoked when a user attempts to 181 * destruct a request. 182 */ 183 SCI_BASE_REQUEST_HANDLER_T destruct_handler; 184 185 } SCI_BASE_REQUEST_STATE_HANDLER_T; 186 187 /** 188 * @brief Construct the base request. 189 * 190 * @param[in] this_request This parameter specifies the base request 191 * to be constructed. 192 * @param[in] logger This parameter specifies the logger associated with 193 * this base request object. 194 * @param[in] state_table This parameter specifies the table of state 195 * definitions to be utilized for the request state machine. 196 * 197 * @return none 198 */ 199 void sci_base_request_construct( 200 SCI_BASE_REQUEST_T * this_request, 201 SCI_BASE_LOGGER_T * logger, 202 SCI_BASE_STATE_T * state_table 203 ); 204 205 #ifdef __cplusplus 206 } 207 #endif // __cplusplus 208 209 #endif // _SCI_BASE_REQUST_H_ 210