0
|
1 |
/*
|
|
2 |
* fsm.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 fsm.h
|
|
40 |
* \brief finite state machine header file
|
|
41 |
*
|
|
42 |
* \see fsm.c
|
|
43 |
*/
|
|
44 |
|
|
45 |
|
|
46 |
/***************************************************************************/
|
|
47 |
/* */
|
|
48 |
/* MODULE: fsm.h */
|
|
49 |
/* PURPOSE: Finite State Machine API */
|
|
50 |
/* */
|
|
51 |
/***************************************************************************/
|
|
52 |
|
|
53 |
#ifndef __FSM_H__
|
|
54 |
#define __FSM_H__
|
|
55 |
|
|
56 |
#include "tidef.h"
|
|
57 |
#include "commonTypes.h"
|
|
58 |
|
|
59 |
/* Constants */
|
|
60 |
#define MAX_DESC_STRING_LEN 64
|
|
61 |
|
|
62 |
|
|
63 |
/* Enumerations */
|
|
64 |
|
|
65 |
/* Typedefs */
|
|
66 |
|
|
67 |
/** state transition function */
|
|
68 |
typedef TI_STATUS (*fsm_eventActivation_t)(TI_UINT8 *currState, TI_UINT8 event, void* data);
|
|
69 |
|
|
70 |
/** action function type definition */
|
|
71 |
typedef TI_STATUS (*fsm_Action_t)(void* pData);
|
|
72 |
|
|
73 |
/* Structures */
|
|
74 |
|
|
75 |
/* State\Event cell */
|
|
76 |
typedef struct
|
|
77 |
{
|
|
78 |
TI_UINT8 nextState; /**< next state in transition */
|
|
79 |
fsm_Action_t actionFunc; /**< action function */
|
|
80 |
} fsm_actionCell_t;
|
|
81 |
|
|
82 |
/** matrix type */
|
|
83 |
typedef fsm_actionCell_t* fsm_Matrix_t;
|
|
84 |
|
|
85 |
/** general FSM structure */
|
|
86 |
typedef struct
|
|
87 |
{
|
|
88 |
fsm_Matrix_t stateEventMatrix; /**< State\Event matrix */
|
|
89 |
TI_UINT8 MaxNoOfStates; /**< Max Number of states in the matrix */
|
|
90 |
TI_UINT8 MaxNoOfEvents; /**< Max Number of events in the matrix */
|
|
91 |
TI_UINT8 ActiveNoOfStates; /**< Active Number of states in the matrix */
|
|
92 |
TI_UINT8 ActiveNoOfEvents; /**< Active Number of events in the matrix */
|
|
93 |
fsm_eventActivation_t transitionFunc; /**< State transition function */
|
|
94 |
} fsm_stateMachine_t;
|
|
95 |
|
|
96 |
/* External data definitions */
|
|
97 |
|
|
98 |
/* External functions definitions */
|
|
99 |
|
|
100 |
/* Function prototypes */
|
|
101 |
|
|
102 |
TI_STATUS fsm_Create(TI_HANDLE hOs,
|
|
103 |
fsm_stateMachine_t **pFsm,
|
|
104 |
TI_UINT8 MaxNoOfStates,
|
|
105 |
TI_UINT8 MaxNoOfEvents);
|
|
106 |
|
|
107 |
TI_STATUS fsm_Unload(TI_HANDLE hOs,
|
|
108 |
fsm_stateMachine_t *pFsm);
|
|
109 |
|
|
110 |
TI_STATUS fsm_Config(fsm_stateMachine_t *pFsm,
|
|
111 |
fsm_Matrix_t pMatrix,
|
|
112 |
TI_UINT8 ActiveNoOfStates,
|
|
113 |
TI_UINT8 ActiveNoOfEvents,
|
|
114 |
fsm_eventActivation_t transFunc,
|
|
115 |
TI_HANDLE hOs);
|
|
116 |
|
|
117 |
TI_STATUS fsm_Event(fsm_stateMachine_t *pFsm,
|
|
118 |
TI_UINT8 *currentState,
|
|
119 |
TI_UINT8 event,
|
|
120 |
void *pData);
|
|
121 |
|
|
122 |
TI_STATUS fsm_GetNextState(fsm_stateMachine_t *pFsm,
|
|
123 |
TI_UINT8 currentState,
|
|
124 |
TI_UINT8 event,
|
|
125 |
TI_UINT8 *nextState);
|
|
126 |
|
|
127 |
|
|
128 |
TI_STATUS action_nop(void *pData);
|
|
129 |
|
|
130 |
|
|
131 |
#endif /* __FSM_H__ */
|