1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*-
* This file is provided under a dual BSD/GPLv2 license. When using or
* redistributing this file, you may do so under either license.
*
* GPL LICENSE SUMMARY
*
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
* The full GNU General Public License is included in this distribution
* in the file called LICENSE.GPL.
*
* BSD LICENSE
*
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _SCI_BASE_STATE_MACHINE_H_
#define _SCI_BASE_STATE_MACHINE_H_
/**
* @file
*
* @brief This file contains all structures, constants, or method declarations
* common to all state machines defined in SCI.
*/
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
#include <dev/isci/scil/sci_base_subject.h>
#include <dev/isci/scil/sci_base_state.h>
/**
* This macro simply provides simplified retrieval of an objects state
* handler.
*/
#define SET_STATE_HANDLER(object, table, state) \
(object)->state_handlers = &(table)[(state)]
/**
* @struct SCI_BASE_STATE_MACHINE
*
* @brief This structure defines the fields common to all state machines.
*/
typedef struct SCI_BASE_STATE_MACHINE
{
#if defined(SCI_LOGGING)
/**
* The state machine object participates in the observer design pattern.
* Thus, the SCI_BASE_SUBJECT is the parent object, which allows a
* state machine to be easily monitored by a user.
*/
SCI_BASE_SUBJECT_T parent;
#endif // defined(SCI_LOGGING)
/**
* This field points to the start of the state machine's state table.
*/
SCI_BASE_STATE_T * state_table;
/**
* This field points to the object to which this state machine is
* associated. It serves as a cookie to be provided to the state
* enter/exit methods.
*/
SCI_BASE_OBJECT_T * state_machine_owner;
/**
* This field simply indicates the state value for the state machine's
* initial state.
*/
U32 initial_state_id;
/**
* This field indicates the current state of the state machine.
*/
U32 current_state_id;
/**
* This field indicates the previous state of the state machine.
*/
U32 previous_state_id;
} SCI_BASE_STATE_MACHINE_T;
//******************************************************************************
//* P R O T E C T E D M E T H O D S
//******************************************************************************
void sci_base_state_machine_construct(
SCI_BASE_STATE_MACHINE_T *this_state_machine,
SCI_BASE_OBJECT_T *state_machine_owner,
SCI_BASE_STATE_T *state_table,
U32 initial_state
);
void sci_base_state_machine_start(
SCI_BASE_STATE_MACHINE_T *this_state_machine
);
void sci_base_state_machine_stop(
SCI_BASE_STATE_MACHINE_T *this_state_machine
);
void sci_base_state_machine_change_state(
SCI_BASE_STATE_MACHINE_T *this_state_machine,
U32 next_state
);
U32 sci_base_state_machine_get_state(
SCI_BASE_STATE_MACHINE_T *this_state_machine
);
#ifdef __cplusplus
}
#endif // __cplusplus
#endif // _SCI_BASE_STATE_MACHINE_H_
|
