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