2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
33 * * Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * * Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in
37 * the documentation and/or other materials provided with the
39 * * Neither the name of Intel Corporation nor the names of its
40 * contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 #ifndef _SCI_BASE_STATE_MACHINE_H_
57 #define _SCI_BASE_STATE_MACHINE_H_
60 * This file contains all structures, constants, or method declarations common
61 * to all state machines defined in SCI.
67 #include "sci_base_state.h"
71 * SET_STATE_HANDLER() -
73 * This macro simply provides simplified retrieval of an objects state handler.
75 #define SET_STATE_HANDLER(object, table, state) \
76 (object)->state_handlers = &(table)[(state)]
79 * struct sci_base_state_machine - This structure defines the fields common to
84 struct sci_base_state_machine {
86 * This field points to the start of the state machine's state table.
88 const struct sci_base_state *state_table;
91 * This field points to the object to which this state machine is
92 * associated. It serves as a cookie to be provided to the state
95 struct sci_base_object *state_machine_owner;
98 * This field simply indicates the state value for the state machine's
101 u32 initial_state_id;
104 * This field indicates the current state of the state machine.
106 u32 current_state_id;
109 * This field indicates the previous state of the state machine.
111 u32 previous_state_id;
116 * ******************************************************************************
117 * * P R O T E C T E D M E T H O D S
118 * ****************************************************************************** */
120 void sci_base_state_machine_construct(
121 struct sci_base_state_machine *this_state_machine,
122 struct sci_base_object *state_machine_owner,
123 const struct sci_base_state *state_table,
126 void sci_base_state_machine_start(
127 struct sci_base_state_machine *this_state_machine);
129 void sci_base_state_machine_stop(
130 struct sci_base_state_machine *this_state_machine);
132 void sci_base_state_machine_change_state(
133 struct sci_base_state_machine *this_state_machine,
136 u32 sci_base_state_machine_get_state(
137 struct sci_base_state_machine *this_state_machine);
139 #endif /* _SCI_BASE_STATE_MACHINE_H_ */