comparison src/cs/riviera/rv_template/xxx_state_i.h @ 0:4e78acac3d88

src/{condat,cs,gpf,nucleus}: import from Selenite
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 16 Oct 2020 06:23:26 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4e78acac3d88
1 /**
2 * @file xxx_state_i.h
3 *
4 * Internal definitions for XXX state machine,
5 * i.e. the states and the functions corresponding to the states.
6 *
7 * The messages are declared in xxx_message.h, since they can
8 * be seen from outside.
9 *
10 * @author Your name here (your_email_here)
11 * @version 0.1
12 */
13
14 /*
15 * History:
16 *
17 * Date Author Modification
18 * -------------------------------------------------------------------
19 * // Create.
20 *
21 * (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved
22 */
23
24 #ifndef __XXX_STATE_I_H_
25 #define __XXX_STATE_I_H_
26
27
28 #include "rv/rv_general.h"
29
30
31 /**
32 * XXX states.
33 *
34 * XXX instance is a state machine with several possible states.
35 * Based on the current state, XXX handle different kind of messages/events.
36 * States are listed in the order they should normally be sequenced.
37 *
38 * See the Readme file for a description of the state machine.
39 */
40 typedef enum
41 {
42 XXX_STATE_1,
43 XXX_STATE_2
44 } T_XXX_INTERNAL_STATE;
45
46
47 /*
48 * Optional but recommanded, define a function for the processing
49 * in each state, like:
50 * T_XXX_RETURN xxx_state_1 (T_RV_HDR * message_p);
51 * T_XXX_RETURN xxx_state_2 (T_RV_HDR * message_p);
52 */
53
54 #endif /* __XXX_STATE_I_H_ */