2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
56 #ifndef _SCI_BASE_REQUST_H_
57 #define _SCI_BASE_REQUST_H_
62 * @brief This file contains all of the constants, types, and method
63 * declarations for the SCI base IO and task request objects.
70 #include <dev/isci/scil/sci_base_logger.h>
71 #include <dev/isci/scil/sci_base_state_machine.h>
72 #include <dev/isci/scil/sci_base_state_machine_logger.h>
75 * @enum SCI_BASE_REQUEST_STATES
77 * @brief This enumeration depicts all the states for the common request
80 typedef enum _SCI_BASE_REQUEST_STATES
83 * Simply the initial state for the base request state machine.
85 SCI_BASE_REQUEST_STATE_INITIAL,
88 * This state indicates that the request has been constructed. This state
89 * is entered from the INITIAL state.
91 SCI_BASE_REQUEST_STATE_CONSTRUCTED,
94 * This state indicates that the request has been started. This state is
95 * entered from the CONSTRUCTED state.
97 SCI_BASE_REQUEST_STATE_STARTED,
100 * This state indicates that the request has completed.
101 * This state is entered from the STARTED state. This state is entered from
102 * the ABORTING state.
104 SCI_BASE_REQUEST_STATE_COMPLETED,
107 * This state indicates that the request is in the process of being
108 * terminated/aborted.
109 * This state is entered from the CONSTRUCTED state.
110 * This state is entered from the STARTED state.
112 SCI_BASE_REQUEST_STATE_ABORTING,
115 * Simply the final state for the base request state machine.
117 SCI_BASE_REQUEST_STATE_FINAL,
119 SCI_BASE_REQUEST_MAX_STATES
121 } SCI_BASE_REQUEST_STATES;
124 * @struct SCI_BASE_REQUEST
126 * @brief The base request object abstracts the fields common to all SCI IO
127 * and task request objects.
129 typedef struct SCI_BASE_REQUEST
132 * The field specifies that the parent object for the base request is the
133 * base object itself.
135 SCI_BASE_OBJECT_T parent;
138 * This field contains the information for the base request state machine.
140 SCI_BASE_STATE_MACHINE_T state_machine;
143 SCI_BASE_STATE_MACHINE_LOGGER_T state_machine_logger;
144 #endif // SCI_LOGGING
146 } SCI_BASE_REQUEST_T;
148 typedef SCI_STATUS (*SCI_BASE_REQUEST_HANDLER_T)(
149 SCI_BASE_REQUEST_T * this_request
153 * @struct SCI_BASE_REQUEST_STATE_HANDLER
155 * @brief This structure contains all of the state handler methods common to
156 * base IO and task request state machines. Handler methods provide
157 * the ability to change the behavior for user requests or
158 * transitions depending on the state the machine is in.
161 typedef struct SCI_BASE_REQUEST_STATE_HANDLER
164 * The start_handler specifies the method invoked when a user attempts to
167 SCI_BASE_REQUEST_HANDLER_T start_handler;
170 * The abort_handler specifies the method invoked when a user attempts to
173 SCI_BASE_REQUEST_HANDLER_T abort_handler;
176 * The complete_handler specifies the method invoked when a user attempts to
177 * complete a request.
179 SCI_BASE_REQUEST_HANDLER_T complete_handler;
182 * The destruct_handler specifies the method invoked when a user attempts to
183 * destruct a request.
185 SCI_BASE_REQUEST_HANDLER_T destruct_handler;
187 } SCI_BASE_REQUEST_STATE_HANDLER_T;
190 * @brief Construct the base request.
192 * @param[in] this_request This parameter specifies the base request
194 * @param[in] logger This parameter specifies the logger associated with
195 * this base request object.
196 * @param[in] state_table This parameter specifies the table of state
197 * definitions to be utilized for the request state machine.
201 void sci_base_request_construct(
202 SCI_BASE_REQUEST_T * this_request,
203 SCI_BASE_LOGGER_T * logger,
204 SCI_BASE_STATE_T * state_table
209 #endif // __cplusplus
211 #endif // _SCI_BASE_REQUST_H_