summaryrefslogtreecommitdiff
path: root/src/grt/grt-fst_api.ads
blob: ba0ec0c5df9d34ab96a48c4e6ff136505ea0f1f2 (plain)
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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
with Interfaces; use Interfaces;
with Interfaces.C; use Interfaces.C;
with System;
with Grt.Types; use Grt.Types;

package Grt.Fst_Api is

   subtype fstHandle is unsigned;
   Null_fstHandle : constant fstHandle := 0;

   type fstWriterPackType is
     (FST_WR_PT_ZLIB,
      FST_WR_PT_FASTLZ,
      FST_WR_PT_LZ4);
   pragma Convention (C, fstWriterPackType);

   subtype fstFileType is unsigned;
   FST_FT_MIN          : constant fstFileType := 0;
   FST_FT_VERILOG      : constant fstFileType := 0;
   FST_FT_VHDL         : constant fstFileType := 1;
   FST_FT_VERILOG_VHDL : constant fstFileType := 2;
   FST_FT_MAX          : constant fstFileType := 2;

   subtype fstBlockType is unsigned;
   FST_BL_HDR               : constant fstBlockType := 0;
   FST_BL_VCDATA            : constant fstBlockType := 1;
   FST_BL_BLACKOUT          : constant fstBlockType := 2;
   FST_BL_GEOM              : constant fstBlockType := 3;
   FST_BL_HIER              : constant fstBlockType := 4;
   FST_BL_VCDATA_DYN_ALIAS  : constant fstBlockType := 5;
   FST_BL_HIER_LZ4          : constant fstBlockType := 6;
   FST_BL_HIER_LZ4DUO       : constant fstBlockType := 7;
   FST_BL_VCDATA_DYN_ALIAS2 : constant fstBlockType := 8;
   FST_BL_ZWRAPPER          : constant fstBlockType := 254;
   FST_BL_SKIP              : constant fstBlockType := 255;

   subtype fstScopeType is unsigned;
   FST_ST_MIN               : constant fstScopeType := 0;
   FST_ST_VCD_MODULE        : constant fstScopeType := 0;
   FST_ST_VCD_TASK          : constant fstScopeType := 1;
   FST_ST_VCD_FUNCTION      : constant fstScopeType := 2;
   FST_ST_VCD_BEGIN         : constant fstScopeType := 3;
   FST_ST_VCD_FORK          : constant fstScopeType := 4;
   FST_ST_VCD_GENERATE      : constant fstScopeType := 5;
   FST_ST_VCD_STRUCT        : constant fstScopeType := 6;
   FST_ST_VCD_UNION         : constant fstScopeType := 7;
   FST_ST_VCD_CLASS         : constant fstScopeType := 8;
   FST_ST_VCD_INTERFACE     : constant fstScopeType := 9;
   FST_ST_VCD_PACKAGE       : constant fstScopeType := 10;
   FST_ST_VCD_PROGRAM       : constant fstScopeType := 11;
   FST_ST_VHDL_ARCHITECTURE : constant fstScopeType := 12;
   FST_ST_VHDL_PROCEDURE    : constant fstScopeType := 13;
   FST_ST_VHDL_FUNCTION     : constant fstScopeType := 14;
   FST_ST_VHDL_RECORD       : constant fstScopeType := 15;
   FST_ST_VHDL_PROCESS      : constant fstScopeType := 16;
   FST_ST_VHDL_BLOCK        : constant fstScopeType := 17;
   FST_ST_VHDL_FOR_GENERATE : constant fstScopeType := 18;
   FST_ST_VHDL_IF_GENERATE  : constant fstScopeType := 19;
   FST_ST_VHDL_GENERATE     : constant fstScopeType := 20;
   FST_ST_VHDL_PACKAGE      : constant fstScopeType := 21;
   FST_ST_MAX               : constant fstScopeType := 21;
   FST_ST_GEN_ATTRBEGIN     : constant fstScopeType := 252;
   FST_ST_GEN_ATTREND       : constant fstScopeType := 253;
   FST_ST_VCD_SCOPE         : constant fstScopeType := 254;
   FST_ST_VCD_UPSCOPE       : constant fstScopeType := 255;

   subtype fstVarType is unsigned;
   FST_VT_MIN                : constant fstVarType := 0;
   FST_VT_VCD_EVENT          : constant fstVarType := 0;
   FST_VT_VCD_INTEGER        : constant fstVarType := 1;
   FST_VT_VCD_PARAMETER      : constant fstVarType := 2;
   FST_VT_VCD_REAL           : constant fstVarType := 3;
   FST_VT_VCD_REAL_PARAMETER : constant fstVarType := 4;
   FST_VT_VCD_REG            : constant fstVarType := 5;
   FST_VT_VCD_SUPPLY0        : constant fstVarType := 6;
   FST_VT_VCD_SUPPLY1        : constant fstVarType := 7;
   FST_VT_VCD_TIME           : constant fstVarType := 8;
   FST_VT_VCD_TRI            : constant fstVarType := 9;
   FST_VT_VCD_TRIAND         : constant fstVarType := 10;
   FST_VT_VCD_TRIOR          : constant fstVarType := 11;
   FST_VT_VCD_TRIREG         : constant fstVarType := 12;
   FST_VT_VCD_TRI0           : constant fstVarType := 13;
   FST_VT_VCD_TRI1           : constant fstVarType := 14;
   FST_VT_VCD_WAND           : constant fstVarType := 15;
   FST_VT_VCD_WIRE           : constant fstVarType := 16;
   FST_VT_VCD_WOR            : constant fstVarType := 17;
   FST_VT_VCD_PORT           : constant fstVarType := 18;
   FST_VT_VCD_SPARRAY        : constant fstVarType := 19;
   FST_VT_VCD_REALTIME       : constant fstVarType := 20;
   FST_VT_GEN_STRING         : constant fstVarType := 21;
   FST_VT_SV_BIT             : constant fstVarType := 22;
   FST_VT_SV_LOGIC           : constant fstVarType := 23;
   FST_VT_SV_INT             : constant fstVarType := 24;
   FST_VT_SV_SHORTINT        : constant fstVarType := 25;
   FST_VT_SV_LONGINT         : constant fstVarType := 26;
   FST_VT_SV_BYTE            : constant fstVarType := 27;
   FST_VT_SV_ENUM            : constant fstVarType := 28;
   FST_VT_SV_SHORTREAL       : constant fstVarType := 29;
   FST_VT_MAX                : constant fstVarType := 29;

   subtype fstVarDir is unsigned;
   FST_VD_MIN      : constant fstVarDir := 0;
   FST_VD_IMPLICIT : constant fstVarDir := 0;
   FST_VD_INPUT    : constant fstVarDir := 1;
   FST_VD_OUTPUT   : constant fstVarDir := 2;
   FST_VD_INOUT    : constant fstVarDir := 3;
   FST_VD_BUFFER   : constant fstVarDir := 4;
   FST_VD_LINKAGE  : constant fstVarDir := 5;
   FST_VD_MAX      : constant fstVarDir := 5;

   subtype fstHierType is unsigned;
   FST_HT_MIN       : constant fstHierType := 0;
   FST_HT_SCOPE     : constant fstHierType := 0;
   FST_HT_UPSCOPE   : constant fstHierType := 1;
   FST_HT_VAR       : constant fstHierType := 2;
   FST_HT_ATTRBEGIN : constant fstHierType := 3;
   FST_HT_ATTREND   : constant fstHierType := 4;
   FST_HT_MAX       : constant fstHierType := 4;

   subtype fstAttrType is unsigned;
   FST_AT_MIN   : constant fstAttrType := 0;
   FST_AT_MISC  : constant fstAttrType := 0;
   FST_AT_ARRAY : constant fstAttrType := 1;
   FST_AT_ENUM  : constant fstAttrType := 2;
   FST_AT_PACK  : constant fstAttrType := 3;
   FST_AT_MAX   : constant fstAttrType := 3;

   subtype fstMiscType is unsigned;
   FST_MT_MIN         : constant fstMiscType := 0;
   FST_MT_COMMENT     : constant fstMiscType := 0;
   FST_MT_ENVVAR      : constant fstMiscType := 1;
   FST_MT_SUPVAR      : constant fstMiscType := 2;
   FST_MT_PATHNAME    : constant fstMiscType := 3;
   FST_MT_SOURCESTEM  : constant fstMiscType := 4;
   FST_MT_SOURCEISTEM : constant fstMiscType := 5;
   FST_MT_UNKNOWN     : constant fstMiscType := 6;
   FST_MT_MAX         : constant fstMiscType := 6;

   subtype fstArrayType is unsigned;
   FST_AR_MIN      : constant fstArrayType := 0;
   FST_AR_NONE     : constant fstArrayType := 0;
   FST_AR_UNPACKED : constant fstArrayType := 1;
   FST_AR_PACKED   : constant fstArrayType := 2;
   FST_AR_SPARSE   : constant fstArrayType := 3;
   FST_AR_MAX      : constant fstArrayType := 3;

   subtype fstEnumValueType is unsigned;
   FST_EV_SV_INTEGER           : constant fstEnumValueType := 0;
   FST_EV_SV_BIT               : constant fstEnumValueType := 1;
   FST_EV_SV_LOGIC             : constant fstEnumValueType := 2;
   FST_EV_SV_INT               : constant fstEnumValueType := 3;
   FST_EV_SV_SHORTINT          : constant fstEnumValueType := 4;
   FST_EV_SV_LONGINT           : constant fstEnumValueType := 5;
   FST_EV_SV_BYTE              : constant fstEnumValueType := 6;
   FST_EV_SV_UNSIGNED_INTEGER  : constant fstEnumValueType := 7;
   FST_EV_SV_UNSIGNED_BIT      : constant fstEnumValueType := 8;
   FST_EV_SV_UNSIGNED_LOGIC    : constant fstEnumValueType := 9;
   FST_EV_SV_UNSIGNED_INT      : constant fstEnumValueType := 10;
   FST_EV_SV_UNSIGNED_SHORTINT : constant fstEnumValueType := 11;
   FST_EV_SV_UNSIGNED_LONGINT  : constant fstEnumValueType := 12;
   FST_EV_SV_UNSIGNED_BYTE     : constant fstEnumValueType := 13;
   FST_EV_MAX                  : constant fstEnumValueType := 13;

   subtype fstPackType is unsigned;
   FST_PT_NONE          : constant fstPackType := 0;
   FST_PT_UNPACKED      : constant fstPackType := 1;
   FST_PT_PACKED        : constant fstPackType := 2;
   FST_PT_TAGGED_PACKED : constant fstPackType := 3;
   FST_PT_MAX           : constant fstPackType := 3;

   subtype fstSupplementalVarType is unsigned;
   FST_SVT_MIN           : constant fstSupplementalVarType := 0;
   FST_SVT_NONE          : constant fstSupplementalVarType := 0;
   FST_SVT_VHDL_SIGNAL   : constant fstSupplementalVarType := 1;
   FST_SVT_VHDL_VARIABLE : constant fstSupplementalVarType := 2;
   FST_SVT_VHDL_CONSTANT : constant fstSupplementalVarType := 3;
   FST_SVT_VHDL_FILE     : constant fstSupplementalVarType := 4;
   FST_SVT_VHDL_MEMORY   : constant fstSupplementalVarType := 5;
   FST_SVT_MAX           : constant fstSupplementalVarType := 5;

   subtype fstSupplementalDataType is unsigned;
   FST_SDT_MIN                    : constant fstSupplementalDataType := 0;
   FST_SDT_NONE                   : constant fstSupplementalDataType := 0;
   FST_SDT_VHDL_BOOLEAN           : constant fstSupplementalDataType := 1;
   FST_SDT_VHDL_BIT               : constant fstSupplementalDataType := 2;
   FST_SDT_VHDL_BIT_VECTOR        : constant fstSupplementalDataType := 3;
   FST_SDT_VHDL_STD_ULOGIC        : constant fstSupplementalDataType := 4;
   FST_SDT_VHDL_STD_ULOGIC_VECTOR : constant fstSupplementalDataType := 5;
   FST_SDT_VHDL_STD_LOGIC         : constant fstSupplementalDataType := 6;
   FST_SDT_VHDL_STD_LOGIC_VECTOR  : constant fstSupplementalDataType := 7;
   FST_SDT_VHDL_UNSIGNED          : constant fstSupplementalDataType := 8;
   FST_SDT_VHDL_SIGNED            : constant fstSupplementalDataType := 9;
   FST_SDT_VHDL_INTEGER           : constant fstSupplementalDataType := 10;
   FST_SDT_VHDL_REAL              : constant fstSupplementalDataType := 11;
   FST_SDT_VHDL_NATURAL           : constant fstSupplementalDataType := 12;
   FST_SDT_VHDL_POSITIVE          : constant fstSupplementalDataType := 13;
   FST_SDT_VHDL_TIME              : constant fstSupplementalDataType := 14;
   FST_SDT_VHDL_CHARACTER         : constant fstSupplementalDataType := 15;
   FST_SDT_VHDL_STRING            : constant fstSupplementalDataType := 16;
   FST_SDT_MAX                    : constant fstSupplementalDataType := 16;
   FST_SDT_SVT_SHIFT_COUNT        : constant fstSupplementalDataType := 10;
   FST_SDT_ABS_MAX                : constant fstSupplementalDataType := 1023;

   type fstContext is new System.Address;
   Null_fstContext : constant fstContext := fstContext (System.Null_Address);

   procedure fstWriterClose (ctx : fstContext);
   pragma Import (C, fstWriterClose, "fstWriterClose");

   function fstWriterCreate (nam : Ghdl_C_String; use_compressed_hier : int)
                             return fstContext;
   pragma Import (C, fstWriterCreate, "fstWriterCreate");

   function fstWriterCreateVar
     (ctx : fstContext;
      vt : fstVarType;
      vd : fstVarDir;
      len : unsigned;
      nam : Ghdl_C_String;
      aliasHandle : fstHandle) return fstHandle;
   pragma Import (C, fstWriterCreateVar, "fstWriterCreateVar");

   function fstWriterCreateVar2
     (ctx : fstContext;
      vt : fstVarType;
      vd : fstVarDir;
      len : unsigned;
      nam : Ghdl_C_String;
      aliasHandle : fstHandle;
      c_type : Ghdl_C_String;
      svt : fstSupplementalVarType;
      sdt : fstSupplementalDataType) return fstHandle;
   pragma Import (C, fstWriterCreateVar2, "fstWriterCreateVar2");

   procedure fstWriterEmitValueChange
     (ctx : fstContext;
      handle : fstHandle;
      val : System.Address);
   pragma Import (C, fstWriterEmitValueChange, "fstWriterEmitValueChange");

   procedure fstWriterEmitVariableLengthValueChange
     (ctx : fstContext;
      handle : fstHandle;
      val : System.Address;
      len : unsigned);
   pragma Import (C, fstWriterEmitVariableLengthValueChange,
                  "fstWriterEmitVariableLengthValueChange");

   procedure fstWriterEmitDumpActive (ctx : fstContext; enable : int);
   pragma Import (C, fstWriterEmitDumpActive, "fstWriterEmitDumpActive");

   procedure fstWriterEmitTimeChange
     (ctx : fstContext; tim : Unsigned_64);
   pragma Import (C, fstWriterEmitTimeChange, "fstWriterEmitTimeChange");

   procedure fstWriterFlushContext (ctx : fstContext);
   pragma Import (C, fstWriterFlushContext, "fstWriterFlushContext");

   function fstWriterGetDumpSizeLimitReached (ctx : fstContext) return int;
   pragma Import (C, fstWriterGetDumpSizeLimitReached,
                  "fstWriterGetDumpSizeLimitReached");

   function fstWriterGetFseekFailed (ctx : fstContext) return int;
   pragma Import (C, fstWriterGetFseekFailed, "fstWriterGetFseekFailed");

   procedure fstWriterSetAttrBegin
     (ctx : fstContext;
      attrtype : fstAttrType;
      c_subtype : int;
      attrname : Ghdl_C_String;
      arg : Unsigned_64);
   pragma Import (C, fstWriterSetAttrBegin, "fstWriterSetAttrBegin");

   procedure fstWriterSetAttrEnd (ctx : fstContext);
   pragma Import (C, fstWriterSetAttrEnd, "fstWriterSetAttrEnd");

   procedure fstWriterSetComment (ctx : fstContext; comm : Ghdl_C_String);
   pragma Import (C, fstWriterSetComment, "fstWriterSetComment");

   procedure fstWriterSetDate (ctx : fstContext; dat : Ghdl_C_String);
   pragma Import (C, fstWriterSetDate, "fstWriterSetDate");

   procedure fstWriterSetDumpSizeLimit
     (ctx : Ghdl_C_String; numbytes : Unsigned_64);
   pragma Import (C, fstWriterSetDumpSizeLimit, "fstWriterSetDumpSizeLimit");

   procedure fstWriterSetEnvVar (ctx : fstContext; envvar : Ghdl_C_String);
   pragma Import (C, fstWriterSetEnvVar, "fstWriterSetEnvVar");

   procedure fstWriterSetFileType (ctx : fstContext; filetype : fstFileType);
   pragma Import (C, fstWriterSetFileType, "fstWriterSetFileType");

   procedure fstWriterSetPackType (ctx : fstContext; typ : fstWriterPackType);
   pragma Import (C, fstWriterSetPackType, "fstWriterSetPackType");

   procedure fstWriterSetParallelMode (ctx : fstContext; enable : int);
   pragma Import (C, fstWriterSetParallelMode, "fstWriterSetParallelMode");

   procedure fstWriterSetRepackOnClose (ctx : fstContext; enable : int);
   pragma Import (C, fstWriterSetRepackOnClose, "fstWriterSetRepackOnClose");

   procedure fstWriterSetScope
     (ctx : fstContext;
      scopetype : fstScopeType;
      scopename : Ghdl_C_String;
      scopecomp : Ghdl_C_String);
   pragma Import (C, fstWriterSetScope, "fstWriterSetScope");

   procedure fstWriterSetSourceInstantiationStem
     (ctx : fstContext;
      path : Ghdl_C_String;
      line : unsigned;
      use_realpath : unsigned);
   pragma Import (C, fstWriterSetSourceInstantiationStem,
                  "fstWriterSetSourceInstantiationStem");

   procedure fstWriterSetSourceStem
     (ctx : fstContext;
      path : Ghdl_C_String;
      line : unsigned;
      use_realpath : unsigned);
   pragma Import (C, fstWriterSetSourceStem, "fstWriterSetSourceStem");

   procedure fstWriterSetTimescale (ctx : fstContext; ts : Integer);
   pragma Import (C, fstWriterSetTimescale, "fstWriterSetTimescale");

   procedure fstWriterSetTimescaleFromString
     (ctx : fstContext; s : Ghdl_C_String);
   pragma Import (C, fstWriterSetTimescaleFromString,
                  "fstWriterSetTimescaleFromString");

   procedure fstWriterSetTimezero (ctx : fstContext; tim : Unsigned_64);
   pragma Import (C, fstWriterSetTimezero, "fstWriterSetTimezero");

   procedure fstWriterSetUpscope (ctx : fstContext);
   pragma Import (C, fstWriterSetUpscope, "fstWriterSetUpscope");

   procedure fstWriterSetVersion (ctx : fstContext; vers : Ghdl_C_String);
   pragma Import (C, fstWriterSetVersion, "fstWriterSetVersion");

   function fstUtilityBinToEsc
     (d : access unsigned_char;
      s : access unsigned_char;
      len : int) return int;
   pragma Import (C, fstUtilityBinToEsc, "fstUtilityBinToEsc");

   function fstUtilityEscToBin
     (d : access unsigned_char;
      s : access unsigned_char;
      len : int) return int;
   pragma Import (C, fstUtilityEscToBin, "fstUtilityEscToBin");

end Grt.Fst_Api;