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 _SCI_BASE_REQUST_H_ 55230557Sjimharris#define _SCI_BASE_REQUST_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains all of the constants, types, and method 61230557Sjimharris * declarations for the SCI base IO and task request objects. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#ifdef __cplusplus 65230557Sjimharrisextern "C" { 66230557Sjimharris#endif // __cplusplus 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/sci_base_logger.h> 69230557Sjimharris#include <dev/isci/scil/sci_base_state_machine.h> 70230557Sjimharris#include <dev/isci/scil/sci_base_state_machine_logger.h> 71230557Sjimharris 72230557Sjimharris/** 73230557Sjimharris * @enum SCI_BASE_REQUEST_STATES 74230557Sjimharris * 75230557Sjimharris * @brief This enumeration depicts all the states for the common request 76230557Sjimharris * state machine. 77230557Sjimharris */ 78230557Sjimharristypedef enum _SCI_BASE_REQUEST_STATES 79230557Sjimharris{ 80230557Sjimharris /** 81230557Sjimharris * Simply the initial state for the base request state machine. 82230557Sjimharris */ 83230557Sjimharris SCI_BASE_REQUEST_STATE_INITIAL, 84230557Sjimharris 85230557Sjimharris /** 86230557Sjimharris * This state indicates that the request has been constructed. This state 87230557Sjimharris * is entered from the INITIAL state. 88230557Sjimharris */ 89230557Sjimharris SCI_BASE_REQUEST_STATE_CONSTRUCTED, 90230557Sjimharris 91230557Sjimharris /** 92230557Sjimharris * This state indicates that the request has been started. This state is 93230557Sjimharris * entered from the CONSTRUCTED state. 94230557Sjimharris */ 95230557Sjimharris SCI_BASE_REQUEST_STATE_STARTED, 96230557Sjimharris 97230557Sjimharris /** 98230557Sjimharris * This state indicates that the request has completed. 99230557Sjimharris * This state is entered from the STARTED state. This state is entered from 100230557Sjimharris * the ABORTING state. 101230557Sjimharris */ 102230557Sjimharris SCI_BASE_REQUEST_STATE_COMPLETED, 103230557Sjimharris 104230557Sjimharris /** 105230557Sjimharris * This state indicates that the request is in the process of being 106230557Sjimharris * terminated/aborted. 107230557Sjimharris * This state is entered from the CONSTRUCTED state. 108230557Sjimharris * This state is entered from the STARTED state. 109230557Sjimharris */ 110230557Sjimharris SCI_BASE_REQUEST_STATE_ABORTING, 111230557Sjimharris 112230557Sjimharris /** 113230557Sjimharris * Simply the final state for the base request state machine. 114230557Sjimharris */ 115230557Sjimharris SCI_BASE_REQUEST_STATE_FINAL, 116230557Sjimharris 117230557Sjimharris SCI_BASE_REQUEST_MAX_STATES 118230557Sjimharris 119230557Sjimharris} SCI_BASE_REQUEST_STATES; 120230557Sjimharris 121230557Sjimharris/** 122230557Sjimharris * @struct SCI_BASE_REQUEST 123230557Sjimharris * 124230557Sjimharris * @brief The base request object abstracts the fields common to all SCI IO 125230557Sjimharris * and task request objects. 126230557Sjimharris */ 127230557Sjimharristypedef struct SCI_BASE_REQUEST 128230557Sjimharris{ 129230557Sjimharris /** 130230557Sjimharris * The field specifies that the parent object for the base request is the 131230557Sjimharris * base object itself. 132230557Sjimharris */ 133230557Sjimharris SCI_BASE_OBJECT_T parent; 134230557Sjimharris 135230557Sjimharris /** 136230557Sjimharris * This field contains the information for the base request state machine. 137230557Sjimharris */ 138230557Sjimharris SCI_BASE_STATE_MACHINE_T state_machine; 139230557Sjimharris 140230557Sjimharris #ifdef SCI_LOGGING 141230557Sjimharris SCI_BASE_STATE_MACHINE_LOGGER_T state_machine_logger; 142230557Sjimharris #endif // SCI_LOGGING 143230557Sjimharris 144230557Sjimharris} SCI_BASE_REQUEST_T; 145230557Sjimharris 146230557Sjimharristypedef SCI_STATUS (*SCI_BASE_REQUEST_HANDLER_T)( 147230557Sjimharris SCI_BASE_REQUEST_T * this_request 148230557Sjimharris); 149230557Sjimharris 150230557Sjimharris/** 151230557Sjimharris * @struct SCI_BASE_REQUEST_STATE_HANDLER 152230557Sjimharris * 153230557Sjimharris * @brief This structure contains all of the state handler methods common to 154230557Sjimharris * base IO and task request state machines. Handler methods provide 155230557Sjimharris * the ability to change the behavior for user requests or 156230557Sjimharris * transitions depending on the state the machine is in. 157230557Sjimharris * 158230557Sjimharris */ 159230557Sjimharristypedef struct SCI_BASE_REQUEST_STATE_HANDLER 160230557Sjimharris{ 161230557Sjimharris /** 162230557Sjimharris * The start_handler specifies the method invoked when a user attempts to 163230557Sjimharris * start a request. 164230557Sjimharris */ 165230557Sjimharris SCI_BASE_REQUEST_HANDLER_T start_handler; 166230557Sjimharris 167230557Sjimharris /** 168230557Sjimharris * The abort_handler specifies the method invoked when a user attempts to 169230557Sjimharris * abort a request. 170230557Sjimharris */ 171230557Sjimharris SCI_BASE_REQUEST_HANDLER_T abort_handler; 172230557Sjimharris 173230557Sjimharris /** 174230557Sjimharris * The complete_handler specifies the method invoked when a user attempts to 175230557Sjimharris * complete a request. 176230557Sjimharris */ 177230557Sjimharris SCI_BASE_REQUEST_HANDLER_T complete_handler; 178230557Sjimharris 179230557Sjimharris /** 180230557Sjimharris * The destruct_handler specifies the method invoked when a user attempts to 181230557Sjimharris * destruct a request. 182230557Sjimharris */ 183230557Sjimharris SCI_BASE_REQUEST_HANDLER_T destruct_handler; 184230557Sjimharris 185230557Sjimharris} SCI_BASE_REQUEST_STATE_HANDLER_T; 186230557Sjimharris 187230557Sjimharris/** 188230557Sjimharris * @brief Construct the base request. 189230557Sjimharris * 190230557Sjimharris * @param[in] this_request This parameter specifies the base request 191230557Sjimharris * to be constructed. 192230557Sjimharris * @param[in] logger This parameter specifies the logger associated with 193230557Sjimharris * this base request object. 194230557Sjimharris * @param[in] state_table This parameter specifies the table of state 195230557Sjimharris * definitions to be utilized for the request state machine. 196230557Sjimharris * 197230557Sjimharris * @return none 198230557Sjimharris */ 199230557Sjimharrisvoid sci_base_request_construct( 200230557Sjimharris SCI_BASE_REQUEST_T * this_request, 201230557Sjimharris SCI_BASE_LOGGER_T * logger, 202230557Sjimharris SCI_BASE_STATE_T * state_table 203230557Sjimharris); 204230557Sjimharris 205230557Sjimharris#ifdef __cplusplus 206230557Sjimharris} 207230557Sjimharris#endif // __cplusplus 208230557Sjimharris 209230557Sjimharris#endif // _SCI_BASE_REQUST_H_ 210