File: acc_user.h

package info (click to toggle)
iverilog 0.9.7-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 6,748 kB
  • ctags: 10,668
  • sloc: cpp: 69,818; ansic: 40,145; yacc: 5,298; sh: 3,231; makefile: 1,182
file content (273 lines) | stat: -rw-r--r-- 7,583 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
#ifndef __acc_user_H
#define __acc_user_H
/*
 * Copyright (c) 2002 Stephen Williams (steve@icarus.com)
 *
 *    This source code is free software; you can redistribute it
 *    and/or modify it in source code form under the terms of the GNU
 *    General Public License as published by the Free Software
 *    Foundation; either version 2 of the License, or (at your option)
 *    any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
 */

/*
 * This header file contains the definitions and declarations needed
 * by an Icarus Verilog user using acc_ routines.
 *
 * NOTE: Icarus Verilog does not support acc_ routines. This is just a
 * stub. The functions that are implemented here are actually
 * implemented using VPI routines.
 */


#ifdef __cplusplus
# define EXTERN_C_START extern "C" {
# define EXTERN_C_END }
#else
# define EXTERN_C_START
# define EXTERN_C_END
# define bool int
#endif

EXTERN_C_START

# include  "_pli_types.h"

/*
 * This is a declaration of the "handle" type that is compatible with
 * the vpiHandle from vpi_user.h. The libveriuser library implements
 * the acc handle type as a vpiHandle, to prevent useless indirection.
 */
typedef struct __vpiHandle *handle;

/* OBJECT TYPES */
#define accModule    20
#define accScope     21
#define accNet       25
#define accReg       30
#define accIntegerParam   200
#define accRealParam 202
#define accStringParam 204
#define accParameter   220
#define accTopModule      224
#define accModuleInstance 226
#define accWire        260
#define accNamedEvent  280
#define accIntegerVar  281
#define accRealVar   282
#define accTimeVar   283
#define accIntVar    accIntegerVar
#define accScalar    300
#define accVector    302
#define accUnknown   412
#define accConstant  600

/* type VALUES FOR t_setval_delay STRUCTURE */
#define accNoDelay  0
#define accInertialDelay 1
#define accTransportDelay 2
#define accPureTransportDelay 3
#define accForceFlag 4
#define accReleaseFlag 5

/* type VALUES FOR t_setval_value STRUCTURE */
#define accBinStrVal 1
#define accOctStrVal 2
#define accDecStrVal 3
#define accHexStrVal 4
#define accScalarVal 5
#define accIntVal 6
#define accRealVal 7
#define accStringVal 8
#define accVectorVal 9

/* Scalar values */
#define acc0 0
#define acc1 1
#define accX 2
#define accZ 3

/* type VALUES FOR t_acc_time STRUCTURE */
#define accTime 1
#define accSimTime 2
#define accRealTime 3

/* reason codes */
#define logic_value_change     1
#define strength_value_change  2
#define real_value_change      3
#define vector_value_change    4
#define event_value_change     5
#define integer_value_change   6
#define time_value_change      7
#define sregister_value_change 8
#define vregister_value_change 9
#define realtime_value_change 10

/* VCL strength values */
#define vclSupply  7
#define vclStrong  6
#define vclPull    5
#define vclLarge   4
#define vclWeak    3
#define vclMedium  2
#define vclSmall   1
#define vclHighZ   0

/* Constants used by acc_vcl_add */
#define vcl_verilog_logic 2
#define VCL_VERILOG_LOGIC vcl_verilog_logic
#define vcl_verilog_strength 3
#define VCL_VERILOG_STRENGTH vcl_verilog_strength

typedef struct t_acc_time {
      int type;
      int low, high;
      double real;
} s_acc_time, *p_acc_time;

typedef struct t_setval_delay {
      s_acc_time time;
      int model;
} s_setval_delay, *p_setval_delay;

typedef struct t_acc_vecval {
      int aval;
      int bval;
} s_acc_vecval, *p_acc_vecval;

typedef struct t_setval_value {
      int format;
      union {
	    char*str;
	    int scalar;
	    int integer;
	    double real;
	    p_acc_vecval vector;
      } value;
} s_setval_value, *p_setval_value, s_acc_value, *p_acc_value;

typedef struct t_strengths {
      PLI_UBYTE8 logic_value;
      PLI_UBYTE8 strength1;
      PLI_UBYTE8 strength2;
} s_strengths, *p_strengths;

typedef struct t_vc_record {
      PLI_INT32 vc_reason;
      PLI_INT32 vc_hightime;
      PLI_INT32 vc_lowtime;
      void*     user_data;
      union {
	    PLI_UBYTE8 logic_value;
	    double real_value;
	    handle vector_handle;
	    s_strengths strengths_s;
      } out_value;
} s_vc_record, *p_vc_record;


typedef struct t_location {
      PLI_INT32 line_no;
      const char*filename;
} s_location, *p_location;

extern int acc_error_flag;

extern int acc_initialize(void);

extern void acc_close(void);

/*
 * This is the acc_configure command, and the config_param
 * codes that are accepted.
 */
extern int   acc_configure(PLI_INT32 config_param, const char*value);
#define accEnableArgs          6
#define accDevelopmentVersion 11

extern int   acc_fetch_argc(void);
extern char**acc_fetch_argv(void);

extern PLI_INT32 acc_fetch_direction(handle obj);
/* XXXX FIXME: Values returned by acc_fetch_direction */
# define accInout 2

extern char* acc_fetch_fullname(handle obj);

extern int   acc_fetch_location(p_location loc, handle obj);

extern char* acc_fetch_name(handle obj);
extern char* acc_fetch_defname(handle obj);

extern double acc_fetch_paramval(handle obj);

extern double    acc_fetch_tfarg(PLI_INT32);
extern double    acc_fetch_itfarg(PLI_INT32, handle);
extern PLI_INT32 acc_fetch_tfarg_int(PLI_INT32);
extern PLI_INT32 acc_fetch_itfarg_int(PLI_INT32, handle);
extern char*     acc_fetch_tfarg_str(PLI_INT32);
extern char*     acc_fetch_itfarg_str(PLI_INT32, handle);

typedef struct t_timescale_info {
      PLI_INT16 unit;
      PLI_INT16 precision;
} s_timescale_info, *p_timescale_info;
extern void acc_fetch_timescale_info(handle obj, p_timescale_info info);

extern PLI_INT32 acc_fetch_size(handle obj);

extern PLI_INT32 acc_fetch_type(handle obj);
extern PLI_INT32 acc_fetch_fulltype(handle obj);
extern PLI_INT32 acc_fetch_range(handle object, int *msb, int *lsb);
extern char*     acc_fetch_type_str(PLI_INT32 type);

extern char* acc_fetch_value(handle obj, const char*fmt, s_acc_value*value);

extern handle acc_handle_by_name(const char*name, handle scope);
extern handle acc_handle_hiconn(handle port_ref_handle);
extern handle acc_handle_object(const char*name);
extern handle acc_handle_parent(handle obj);
extern handle acc_handle_scope(handle obj);
extern handle acc_handle_simulated_net(handle net);

extern handle acc_handle_tfarg(int n);
extern handle acc_handle_tfinst(void);

extern PLI_INT32 acc_compare_handles(handle, handle);

extern handle acc_next(PLI_INT32 *, handle, handle);
extern handle acc_next_bit(handle ref, handle bit);
extern handle acc_next_port(handle ref, handle bit);
extern handle acc_next_scope(handle, handle);
extern handle acc_next_topmod(handle prev_topmod);

extern int acc_object_in_typelist(handle object, PLI_INT32*typelist);
extern int acc_object_of_type(handle object, PLI_INT32 type);

extern char*acc_product_version(void);

extern char*acc_set_scope(handle ref, ...);

extern int acc_set_value(handle obj, p_setval_value value,
			 p_setval_delay delay);

extern void acc_vcl_add(handle obj, PLI_INT32(*consumer)(p_vc_record),
			void*data, PLI_INT32 vcl_flag);
extern  void acc_vcl_delete(handle obj, PLI_INT32(*consumer)(p_vc_record),
			    void*data, PLI_INT32 vcl_flag);

extern char* acc_version(void);

EXTERN_C_END

#endif