0
|
1 |
/*
|
|
2 |
* fsm.c
|
|
3 |
*
|
|
4 |
* Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.
|
|
5 |
* All rights reserved.
|
|
6 |
*
|
|
7 |
* This program and the accompanying materials are made available under the
|
|
8 |
* terms of the Eclipse Public License v1.0 or BSD License which accompanies
|
|
9 |
* this distribution. The Eclipse Public License is available at
|
|
10 |
* http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.
|
|
11 |
*
|
|
12 |
* Redistribution and use in source and binary forms, with or without
|
|
13 |
* modification, are permitted provided that the following conditions
|
|
14 |
* are met:
|
|
15 |
*
|
|
16 |
* * Redistributions of source code must retain the above copyright
|
|
17 |
* notice, this list of conditions and the following disclaimer.
|
|
18 |
* * Redistributions in binary form must reproduce the above copyright
|
|
19 |
* notice, this list of conditions and the following disclaimer in
|
|
20 |
* the documentation and/or other materials provided with the
|
|
21 |
* distribution.
|
|
22 |
* * Neither the name Texas Instruments nor the names of its
|
|
23 |
* contributors may be used to endorse or promote products derived
|
|
24 |
* from this software without specific prior written permission.
|
|
25 |
*
|
|
26 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
27 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
28 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
29 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
30 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
31 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
32 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
33 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
34 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
35 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
36 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
37 |
*/
|
|
38 |
|
|
39 |
/** \file fsm.c
|
|
40 |
* \brief finite state machine source code
|
|
41 |
*
|
|
42 |
* \see fsm.h
|
|
43 |
*/
|
|
44 |
|
|
45 |
|
|
46 |
/***************************************************************************/
|
|
47 |
/* */
|
|
48 |
/* MODULE: fsm.c */
|
|
49 |
/* PURPOSE: Finite State Machine source code */
|
|
50 |
/* */
|
|
51 |
/***************************************************************************/
|
|
52 |
|
|
53 |
#define __FILE_ID__ FILE_ID_127
|
|
54 |
#include "tidef.h"
|
|
55 |
#include "osApi.h"
|
|
56 |
#include "report.h"
|
|
57 |
#include "fsm.h"
|
|
58 |
|
|
59 |
/* Constants */
|
|
60 |
|
|
61 |
/* Enumerations */
|
|
62 |
|
|
63 |
/* Typedefs */
|
|
64 |
|
|
65 |
/* Structures */
|
|
66 |
|
|
67 |
/* External data definitions */
|
|
68 |
|
|
69 |
/* External functions definitions */
|
|
70 |
|
|
71 |
/* Function prototypes */
|
|
72 |
|
|
73 |
/**
|
|
74 |
*
|
|
75 |
* fsm_Init - Initialize the FSM structure
|
|
76 |
*
|
|
77 |
* \b Description:
|
|
78 |
*
|
|
79 |
* Init The FSM structure. If matrix argument is NULL, allocate memory for
|
|
80 |
* new matrix.
|
|
81 |
*
|
|
82 |
* \b ARGS:
|
|
83 |
*
|
|
84 |
* O - pFsm - the generated FSM module \n
|
|
85 |
* I - noOfStates - Number of states in the module \n
|
|
86 |
* I - noOfStates - Number of events in the module \n
|
|
87 |
* I/O - matrix - the state event matrix
|
|
88 |
* I - transFunc - Transition finction for the state machine \n
|
|
89 |
*
|
|
90 |
* \b RETURNS:
|
|
91 |
*
|
|
92 |
* TI_OK on success, TI_NOK on failure
|
|
93 |
*
|
|
94 |
* \sa fsm_Event
|
|
95 |
*/
|
|
96 |
TI_STATUS fsm_Create(TI_HANDLE hOs,
|
|
97 |
fsm_stateMachine_t **pFsm,
|
|
98 |
TI_UINT8 MaxNoOfStates,
|
|
99 |
TI_UINT8 MaxNoOfEvents)
|
|
100 |
{
|
|
101 |
/* check for perliminary conditions */
|
|
102 |
if ((pFsm == NULL) || (MaxNoOfStates == 0) || (MaxNoOfEvents == 0))
|
|
103 |
{
|
|
104 |
return TI_NOK;
|
|
105 |
}
|
|
106 |
|
|
107 |
/* allocate memory for FSM context */
|
|
108 |
*pFsm = (fsm_stateMachine_t *)os_memoryAlloc(hOs, sizeof(fsm_stateMachine_t),MemoryNormal);
|
|
109 |
if (*pFsm == NULL)
|
|
110 |
{
|
|
111 |
return TI_NOK;
|
|
112 |
}
|
|
113 |
|
|
114 |
/* allocate memory for FSM matrix */
|
|
115 |
(*pFsm)->stateEventMatrix = (fsm_Matrix_t)os_memoryAlloc(hOs, MaxNoOfStates * MaxNoOfEvents * sizeof(fsm_actionCell_t),MemoryNormal);
|
|
116 |
if ((*pFsm)->stateEventMatrix == NULL)
|
|
117 |
{
|
|
118 |
os_memoryFree(hOs, *pFsm, sizeof(fsm_stateMachine_t));
|
|
119 |
return TI_NOK;
|
|
120 |
}
|
|
121 |
|
|
122 |
/* update pFsm structure with parameters */
|
|
123 |
(*pFsm)->MaxNoOfStates = MaxNoOfStates;
|
|
124 |
(*pFsm)->MaxNoOfEvents = MaxNoOfEvents;
|
|
125 |
|
|
126 |
return(TI_OK);
|
|
127 |
}
|
|
128 |
|
|
129 |
/**
|
|
130 |
*
|
|
131 |
* fsm_Unload - free all memory allocated to FSM structure
|
|
132 |
*
|
|
133 |
* \b Description:
|
|
134 |
*
|
|
135 |
* Unload the FSM structure.
|
|
136 |
*
|
|
137 |
* \b ARGS:
|
|
138 |
*
|
|
139 |
* O - pFsm - the generated FSM module \n
|
|
140 |
* I - noOfStates - Number of states in the module \n
|
|
141 |
* I - noOfStates - Number of events in the module \n
|
|
142 |
* I/O - matrix - the state event matrix
|
|
143 |
* I - transFunc - Transition finction for the state machine \n
|
|
144 |
*
|
|
145 |
* \b RETURNS:
|
|
146 |
*
|
|
147 |
* TI_OK on success, TI_NOK on failure
|
|
148 |
*
|
|
149 |
* \sa fsm_Event
|
|
150 |
*/
|
|
151 |
TI_STATUS fsm_Unload(TI_HANDLE hOs,
|
|
152 |
fsm_stateMachine_t *pFsm)
|
|
153 |
{
|
|
154 |
/* check for perliminary conditions */
|
|
155 |
if (pFsm == NULL)
|
|
156 |
{
|
|
157 |
return TI_NOK;
|
|
158 |
}
|
|
159 |
|
|
160 |
/* free memory of FSM matrix */
|
|
161 |
if (pFsm->stateEventMatrix != NULL)
|
|
162 |
{
|
|
163 |
os_memoryFree(hOs, pFsm->stateEventMatrix,
|
|
164 |
pFsm->MaxNoOfStates * pFsm->MaxNoOfEvents * sizeof(fsm_actionCell_t));
|
|
165 |
}
|
|
166 |
|
|
167 |
/* free memory for FSM context (no need to check for null) */
|
|
168 |
os_memoryFree(hOs, pFsm, sizeof(fsm_stateMachine_t));
|
|
169 |
|
|
170 |
return(TI_OK);
|
|
171 |
}
|
|
172 |
|
|
173 |
/**
|
|
174 |
*
|
|
175 |
* fsm_Init - Initialize the FSM structure
|
|
176 |
*
|
|
177 |
* \b Description:
|
|
178 |
*
|
|
179 |
* Init The FSM structure. If matrix argument is NULL, allocate memory for
|
|
180 |
* new matrix.
|
|
181 |
*
|
|
182 |
* \b ARGS:
|
|
183 |
*
|
|
184 |
* O - pFsm - the generated FSM module \n
|
|
185 |
* I - noOfStates - Number of states in the module \n
|
|
186 |
* I - noOfStates - Number of events in the module \n
|
|
187 |
* I/O - matrix - the state event matrix
|
|
188 |
* I - transFunc - Transition finction for the state machine \n
|
|
189 |
*
|
|
190 |
* \b RETURNS:
|
|
191 |
*
|
|
192 |
* TI_OK on success, TI_NOK on failure
|
|
193 |
*
|
|
194 |
* \sa fsm_Event
|
|
195 |
*/
|
|
196 |
TI_STATUS fsm_Config(fsm_stateMachine_t *pFsm,
|
|
197 |
fsm_Matrix_t pMatrix,
|
|
198 |
TI_UINT8 ActiveNoOfStates,
|
|
199 |
TI_UINT8 ActiveNoOfEvents,
|
|
200 |
fsm_eventActivation_t transFunc,
|
|
201 |
TI_HANDLE hOs)
|
|
202 |
{
|
|
203 |
/* check for perliminary conditions */
|
|
204 |
if ((pFsm == NULL) ||
|
|
205 |
(pMatrix == NULL))
|
|
206 |
{
|
|
207 |
return TI_NOK;
|
|
208 |
}
|
|
209 |
|
|
210 |
if ((ActiveNoOfStates > pFsm->MaxNoOfStates) ||
|
|
211 |
(ActiveNoOfEvents > pFsm->MaxNoOfEvents))
|
|
212 |
{
|
|
213 |
return TI_NOK;
|
|
214 |
}
|
|
215 |
|
|
216 |
/* copy matrix to FSM context */
|
|
217 |
os_memoryCopy(hOs, (void *)pFsm->stateEventMatrix, (void *)pMatrix,
|
|
218 |
ActiveNoOfStates * ActiveNoOfEvents * sizeof(fsm_actionCell_t));
|
|
219 |
|
|
220 |
/* update pFsm structure with parameters */
|
|
221 |
pFsm->ActiveNoOfStates = ActiveNoOfStates;
|
|
222 |
pFsm->ActiveNoOfEvents = ActiveNoOfEvents;
|
|
223 |
pFsm->transitionFunc = transFunc;
|
|
224 |
return(TI_OK);
|
|
225 |
}
|
|
226 |
|
|
227 |
/**
|
|
228 |
*
|
|
229 |
* fsm_Event - perform event transition in the matrix
|
|
230 |
*
|
|
231 |
* \b Description:
|
|
232 |
*
|
|
233 |
* Perform event transition in the matrix
|
|
234 |
*
|
|
235 |
* \b ARGS:
|
|
236 |
*
|
|
237 |
* I - pFsm - the generated FSM module \n
|
|
238 |
* I/O - currentState - current state of the SM \n
|
|
239 |
* I - event - event causing transition \n
|
|
240 |
* I - pData - data for activation function \n
|
|
241 |
*
|
|
242 |
* \b RETURNS:
|
|
243 |
*
|
|
244 |
* TI_OK on success, TI_NOK on failure
|
|
245 |
*
|
|
246 |
* \sa fsm_Init
|
|
247 |
*/
|
|
248 |
TI_STATUS fsm_Event(fsm_stateMachine_t *pFsm,
|
|
249 |
TI_UINT8 *currentState,
|
|
250 |
TI_UINT8 event,
|
|
251 |
void *pData)
|
|
252 |
{
|
|
253 |
TI_UINT8 oldState;
|
|
254 |
TI_STATUS status;
|
|
255 |
|
|
256 |
/* check for FSM existance */
|
|
257 |
if (pFsm == NULL)
|
|
258 |
{
|
|
259 |
return(TI_NOK);
|
|
260 |
}
|
|
261 |
|
|
262 |
/* boundary check */
|
|
263 |
if ((*currentState >= pFsm->ActiveNoOfStates) || (event >= pFsm->ActiveNoOfEvents))
|
|
264 |
{
|
|
265 |
return(TI_NOK);
|
|
266 |
}
|
|
267 |
|
|
268 |
oldState = *currentState;
|
|
269 |
/* update current state */
|
|
270 |
*currentState = pFsm->stateEventMatrix[(*currentState * pFsm->ActiveNoOfEvents) + event].nextState;
|
|
271 |
|
|
272 |
/* activate transition function */
|
|
273 |
status = (*pFsm->stateEventMatrix[(oldState * pFsm->ActiveNoOfEvents) + event].actionFunc)(pData);
|
|
274 |
|
|
275 |
return status;
|
|
276 |
}
|
|
277 |
|
|
278 |
|
|
279 |
/**
|
|
280 |
*
|
|
281 |
* fsm_GetNextState - Retrun the next state for a given current state and an event.
|
|
282 |
*
|
|
283 |
* \b Description:
|
|
284 |
*
|
|
285 |
* Retrun the next state for a given current state and an event.
|
|
286 |
*
|
|
287 |
* \b ARGS:
|
|
288 |
*
|
|
289 |
* I - pFsm - the generated FSM module \n
|
|
290 |
* I - currentState - current state of the SM \n
|
|
291 |
* I - event - event causing transition \n
|
|
292 |
* O - nextState - returned next state \n
|
|
293 |
*
|
|
294 |
* \b RETURNS:
|
|
295 |
*
|
|
296 |
* TI_OK on success, TI_NOK on failure
|
|
297 |
*
|
|
298 |
* \sa
|
|
299 |
*/
|
|
300 |
TI_STATUS fsm_GetNextState(fsm_stateMachine_t *pFsm,
|
|
301 |
TI_UINT8 currentState,
|
|
302 |
TI_UINT8 event,
|
|
303 |
TI_UINT8 *nextState)
|
|
304 |
{
|
|
305 |
if (pFsm != NULL)
|
|
306 |
{
|
|
307 |
if ((currentState < pFsm->ActiveNoOfStates) && (event < pFsm->ActiveNoOfEvents))
|
|
308 |
{
|
|
309 |
*nextState = pFsm->stateEventMatrix[(currentState * pFsm->ActiveNoOfEvents) + event].nextState;
|
|
310 |
return(TI_OK);
|
|
311 |
}
|
|
312 |
}
|
|
313 |
|
|
314 |
return(TI_NOK);
|
|
315 |
}
|
|
316 |
|
|
317 |
TI_STATUS action_nop(void *pData)
|
|
318 |
{
|
|
319 |
return TI_OK;
|
|
320 |
}
|