FreeCalypso > hg > fc-selenite

comparison src/cs/riviera/rv_template/xxx_i.h @ 0:b6a5e36de839

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/cs: initial import from Magnetite
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 15 Jul 2018 04:39:26 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:b6a5e36de839
1 /**
2 * @file xxx_i.h
3 *
4 * Internal definitions for XXX.
5 *
6 * @author Your name here (your_email_here)
7 * @version 0.1
8 */
9
10 /*
11 * History:
12 *
13 * Date Author Modification
14 * -------------------------------------------------------------------
15 * // Create.
16 *
17 * (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved
18 */
19
20 #ifndef __XXX_INST_I_H_
21 #define __XXX_INST_I_H_
22
23
24 #include "rv/rv_general.h"
25 #include "rvf/rvf_api.h"
26 #include "rvm/rvm_gen.h"
27 #include "rvm/rvm_use_id_list.h"
28 #include "rvm/rvm_ext_use_id_list.h"
29
30 #include "xxx/xxx_cfg.h"
31 #include "xxx/xxx_api.h"
32 #include "xxx/xxx_message.h"
33
34 #include "xxx/xxx_state_i.h"
35
36
37 /** Macro used for tracing XXX messages. */
38 #define XXX_SEND_TRACE(string, trace_level) \
39 rvf_send_trace (string, (sizeof(string) - 1), NULL_PARAM, trace_level, XXX_USE_ID)
40
41
42
43 /**
44 * The Control Block buffer of XXX, which gathers all 'Global variables'
45 * used by XXX instance.
46 *
47 * A structure should gathers all the 'global variables' of XXX instance.
48 * Indeed, global variable must not be defined in order to avoid using static memory.
49 * A T_XXX_ENV_CTRL_BLK buffer is allocated when creating XXX instance and is
50 * then always refered by XXX instance when access to 'global variable'
51 * is necessary.
52 */
53 typedef struct
54 {
55 /** Store the current state of the XXX instance */
56 T_XXX_INTERNAL_STATE state;
57
58 /** Pointer to the error function */
59 T_RVM_RETURN (*error_ft)(T_RVM_NAME swe_name,
60 T_RVM_RETURN error_cause,
61 T_RVM_ERROR_TYPE error_type,
62 T_RVM_STRING error_msg);
63 /** Mem bank id. */
64 T_RVF_MB_ID prim_mb_id;
65
66 T_RVF_ADDR_ID addr_id;
67
68 } T_XXX_ENV_CTRL_BLK;
69
70
71 /** External ref "global variables" structure. */
72 extern T_XXX_ENV_CTRL_BLK *xxx_env_ctrl_blk_p;
73
74
75 #endif /* __XXX_INST_I_H_ */