|
1 /* |
|
2 * GenSM.h |
|
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 GenSM.h |
|
40 * \brief Generic state machine declarations |
|
41 * |
|
42 * \see GenSM.c |
|
43 */ |
|
44 |
|
45 |
|
46 #ifndef __GENSM_H__ |
|
47 #define __GENSM_H__ |
|
48 |
|
49 #include "tidef.h" |
|
50 |
|
51 /* action function type definition */ |
|
52 typedef void (*TGenSM_action) (void *pData); |
|
53 |
|
54 |
|
55 /* State/Event cell */ |
|
56 typedef struct |
|
57 { |
|
58 TI_UINT32 uNextState; /**< next state in transition */ |
|
59 TGenSM_action fAction; /**< action function */ |
|
60 } TGenSM_actionCell; |
|
61 |
|
62 |
|
63 |
|
64 /* |
|
65 * matrix type |
|
66 * Although the state-machine matrix is actually a two-dimensional array, it is treated as a single |
|
67 * dimension array, since the size of each dimeansion is only known in run-time |
|
68 */ |
|
69 typedef TGenSM_actionCell *TGenSM_matrix; |
|
70 |
|
71 TI_HANDLE genSM_Create (TI_HANDLE hOS); |
|
72 void genSM_Unload (TI_HANDLE hGenSM); |
|
73 void genSM_Init (TI_HANDLE hGenSM, TI_HANDLE hReport); |
|
74 void genSM_SetDefaults (TI_HANDLE hGenSM, TI_UINT32 uStateNum, TI_UINT32 uEventNum, |
|
75 TGenSM_matrix pMatrix, TI_UINT32 uInitialState, TI_INT8 *pGenSMName, |
|
76 TI_INT8 **pStateDesc, TI_INT8 **pEventDesc, TI_UINT32 uModuleLogIndex); |
|
77 void genSM_Event (TI_HANDLE hGenSM, TI_UINT32 uEvent, void *pData); |
|
78 TI_UINT32 genSM_GetCurrentState (TI_HANDLE hGenSM); |
|
79 |
|
80 #endif /* __GENSM_H__ */ |
|
81 |