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 _SCI_BASE_STATE_MACHINE_H_ 57 #define _SCI_BASE_STATE_MACHINE_H_ 58 59 /** 60 * @file 61 * 62 * @brief This file contains all structures, constants, or method declarations 63 * common to all state machines defined in SCI. 64 */ 65 66 #ifdef __cplusplus 67 extern "C" { 68 #endif // __cplusplus 69 70 #include <dev/isci/scil/sci_base_subject.h> 71 #include <dev/isci/scil/sci_base_state.h> 72 73 74 /** 75 * This macro simply provides simplified retrieval of an objects state 76 * handler. 77 */ 78 #define SET_STATE_HANDLER(object, table, state) \ 79 (object)->state_handlers = &(table)[(state)] 80 81 /** 82 * @struct SCI_BASE_STATE_MACHINE 83 * 84 * @brief This structure defines the fields common to all state machines. 85 */ 86 typedef struct SCI_BASE_STATE_MACHINE 87 { 88 #if defined(SCI_LOGGING) 89 /** 90 * The state machine object participates in the observer design pattern. 91 * Thus, the SCI_BASE_SUBJECT is the parent object, which allows a 92 * state machine to be easily monitored by a user. 93 */ 94 SCI_BASE_SUBJECT_T parent; 95 #endif // defined(SCI_LOGGING) 96 97 /** 98 * This field points to the start of the state machine's state table. 99 */ 100 SCI_BASE_STATE_T * state_table; 101 102 /** 103 * This field points to the object to which this state machine is 104 * associated. It serves as a cookie to be provided to the state 105 * enter/exit methods. 106 */ 107 SCI_BASE_OBJECT_T * state_machine_owner; 108 109 /** 110 * This field simply indicates the state value for the state machine's 111 * initial state. 112 */ 113 U32 initial_state_id; 114 115 /** 116 * This field indicates the current state of the state machine. 117 */ 118 U32 current_state_id; 119 120 /** 121 * This field indicates the previous state of the state machine. 122 */ 123 U32 previous_state_id; 124 125 } SCI_BASE_STATE_MACHINE_T; 126 127 //****************************************************************************** 128 //* P R O T E C T E D M E T H O D S 129 //****************************************************************************** 130 131 void sci_base_state_machine_construct( 132 SCI_BASE_STATE_MACHINE_T *this_state_machine, 133 SCI_BASE_OBJECT_T *state_machine_owner, 134 SCI_BASE_STATE_T *state_table, 135 U32 initial_state 136 ); 137 138 void sci_base_state_machine_start( 139 SCI_BASE_STATE_MACHINE_T *this_state_machine 140 ); 141 142 void sci_base_state_machine_stop( 143 SCI_BASE_STATE_MACHINE_T *this_state_machine 144 ); 145 146 void sci_base_state_machine_change_state( 147 SCI_BASE_STATE_MACHINE_T *this_state_machine, 148 U32 next_state 149 ); 150 151 U32 sci_base_state_machine_get_state( 152 SCI_BASE_STATE_MACHINE_T *this_state_machine 153 ); 154 155 #ifdef __cplusplus 156 } 157 #endif // __cplusplus 158 159 #endif // _SCI_BASE_STATE_MACHINE_H_ 160