forked from OSVVM/OSVVM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
OsvvmGlobalPkg.vhd
431 lines (420 loc) · 17.8 KB
/
OsvvmGlobalPkg.vhd
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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
--
-- File Name: OsvvmGlobalPkg.vhd
-- Design Unit Name: OsvvmGlobalPkg
-- Revision: STANDARD VERSION, revision 2015.01
--
-- Maintainer: Jim Lewis email: jim@synthworks.com
-- Contributor(s):
-- Jim Lewis jim@synthworks.com
--
--
-- Description:
-- Global Settings for OSVVM packages
--
--
-- Developed for:
-- SynthWorks Design Inc.
-- VHDL Training Classes
-- 11898 SW 128th Ave. Tigard, Or 97223
-- http://www.SynthWorks.com
--
-- Revision History:
-- Date Version Description
-- 03/2024 2024.03 Most of package functionality replaced by constants in OsvvmSettingsPkg_default.vhd
-- 06/2022 2022.06 Minor reordering of constants
-- 02/2022 2022.02 Added support for IdSeparator.
-- Supports PrintParent mode PRINT_NAME_AND_PARENT. <Parent Name> <IdSeparator> <AlertLogID Name>.
-- 01/2020 2020.01 Updated Licenses to Apache
-- 01/2014 2015.01 Initial revision
--
--
-- This file is part of OSVVM.
--
-- Copyright (c) 2015 - 2020 by SynthWorks Design Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- https://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
library ieee ;
use std.textio.all ;
use work.NamePkg.all ;
package OsvvmGlobalPkg is
-- Shared Options Type used in OSVVM
type OsvvmOptionsType is (OPT_INIT_PARM_DETECT, OPT_USE_DEFAULT, DISABLED, FALSE, ENABLED, TRUE) ;
function IsEnabled (A : OsvvmOptionsType) return boolean ; -- Requires that TRUE is last and ENABLED is 2nd to last
function to_OsvvmOptionsType (A : boolean) return OsvvmOptionsType ;
-- Defaults for String values
constant OSVVM_STRING_INIT_PARM_DETECT : string := NUL & NUL & NUL ;
constant OSVVM_STRING_USE_DEFAULT : string := NUL & "" ;
function IsOsvvmStringSet (A : string) return boolean ;
-- The remaining capability has been replaced by OsvvmSettingsPkg.vhd / OsvvmSettingsPkg_default.vhd
-- These provide a lighter weight implementation of this capability
--
--!! procedure SetOsvvmDefaultTimeUnits (A : time) ;
--!! impure function GetOsvvmDefaultTimeUnits return time ;
--!!
--!! type OsvvmDefaultTimeUnitsPType is protected
--!! procedure Set (A: time) ;
--!! impure function get return time ;
--!! end protected OsvvmDefaultTimeUnitsPType ;
--!!
--!! -- AlertLog Settings - See OsvvmSettingsPkg
--!! constant OSVVM_DEFAULT_WRITE_PREFIX : string := "%% " ;
--!! constant OSVVM_DEFAULT_ALERT_PREFIX : string := "Alert" ;
--!! constant OSVVM_DEFAULT_LOG_PREFIX : string := "Log " ;
--!! constant OSVVM_DEFAULT_DONE_NAME : string := "DONE" ;
--!! constant OSVVM_DEFAULT_PASS_NAME : string := "PASSED" ;
--!! constant OSVVM_DEFAULT_FAIL_NAME : string := "FAILED" ;
--!! constant OSVVM_DEFAULT_ID_SEPARATOR : string := ": " ;
--!!
--!! -- Coverage Settings
--!! constant OSVVM_DEFAULT_WRITE_PASS_FAIL : OsvvmOptionsType := FALSE ;
--!! constant OSVVM_DEFAULT_WRITE_BIN_INFO : OsvvmOptionsType := TRUE ;
--!! constant OSVVM_DEFAULT_WRITE_COUNT : OsvvmOptionsType := TRUE ;
--!! constant OSVVM_DEFAULT_WRITE_ANY_ILLEGAL : OsvvmOptionsType := FALSE ;
--!!
--!! ------------------------------------------------------------
--!! procedure SetOsvvmGlobalOptions (
--!! ------------------------------------------------------------
--!! WritePassFail : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WriteBinInfo : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WriteCount : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WriteAnyIllegal : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WritePrefix : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! DoneName : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! PassName : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! FailName : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! IdSeparator : string := OSVVM_STRING_INIT_PARM_DETECT
--!! ) ;
--!!
--!! ------------------------------------------------------------
--!! -- Accessor Functions
--!! function ResolveOsvvmOption(A, B, C : OsvvmOptionsType) return OsvvmOptionsType ;
--!! function ResolveOsvvmOption(A, B, C, D : OsvvmOptionsType) return OsvvmOptionsType ;
--!! function ResolveOsvvmOption(A, B : string) return string ;
--!! function ResolveOsvvmOption(A, B, C : string) return string ;
--!! function ResolveOsvvmOption(A, B, C, D : string) return string ;
--!!
--!! impure function ResolveOsvvmWritePrefix (A : String) return string ;
--!! impure function ResolveOsvvmDoneName (A : String) return string ;
--!! impure function ResolveOsvvmPassName (A : String) return string ;
--!! impure function ResolveOsvvmFailName (A : String) return string ;
--!! impure function ResolveOsvvmIdSeparator (A : String) return string ;
--!!
--!! impure function ResolveCovWritePassFail (A : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!! impure function ResolveCovWriteBinInfo (A : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!! impure function ResolveCovWriteCount (A : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!! impure function ResolveCovWriteAnyIllegal(A : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!!
--!! impure function ResolveOsvvmWritePrefix (A, B : String) return string ;
--!! impure function ResolveOsvvmDoneName (A, B : String) return string ;
--!! impure function ResolveOsvvmPassName (A, B : String) return string ;
--!! impure function ResolveOsvvmFailName (A, B : String) return string ;
--!!
--!! impure function ResolveCovWritePassFail (A, B : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!! impure function ResolveCovWriteBinInfo (A, B : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!! impure function ResolveCovWriteCount (A, B : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!! impure function ResolveCovWriteAnyIllegal(A, B : OsvvmOptionsType) return OsvvmOptionsType ; -- Cov
--!!
--!!
--!! procedure OsvvmDeallocate ;
--!!
--!! type OptionsPType is protected
--!! procedure Set (A: OsvvmOptionsType) ;
--!! impure function get return OsvvmOptionsType ;
--!! end protected OptionsPType ;
end OsvvmGlobalPkg ;
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
package body OsvvmGlobalPkg is
function IsEnabled (A : OsvvmOptionsType) return boolean is
begin
return A >= ENABLED ;
end function IsEnabled ;
function to_OsvvmOptionsType (A : boolean) return OsvvmOptionsType is
begin
if A then
return TRUE ;
else
return FALSE ;
end if ;
end function to_OsvvmOptionsType ;
function IsOsvvmStringSet (A : string) return boolean is
begin
if A'length = 0 then -- Null strings permitted
return TRUE ;
else
return A(A'left) /= NUL ;
end if;
end function IsOsvvmStringSet ;
--!! type OptionsPType is protected body
--!! variable GlobalVar : OsvvmOptionsType ;
--!! procedure Set (A : OsvvmOptionsType) is
--!! begin
--!! GlobalVar := A ;
--!! end procedure Set ;
--!! impure function get return OsvvmOptionsType is
--!! begin
--!! return GlobalVar ;
--!! end function get ;
--!! end protected body OptionsPType ;
--!!
--!! type OsvvmDefaultTimeUnitsPType is protected body
--!!-- variable GlobalVar : time := std.env.resolution_limit ; -- VHDL-2008
--!! variable GlobalVar : time := 1 ns ; -- compatibility with LocalPrint in AlertLogPkg
--!! procedure Set (A : time) is
--!! begin
--!! if A >= std.env.resolution_limit then
--!! GlobalVar := A ;
--!! elsif A < std.env.resolution_limit then
--!! report "SetOsvvmDefaultTimeUnits: time unit parameter too small" severity warning ;
--!! end if ;
--!! end procedure Set ;
--!! impure function get return time is
--!! begin
--!! return GlobalVar ;
--!! end function get ;
--!! end protected body OsvvmDefaultTimeUnitsPType ;
--!!
--!! shared variable OsvvmDefaultTimeUnitsVar : OsvvmDefaultTimeUnitsPType ;
--!!
--!! procedure SetOsvvmDefaultTimeUnits (A : time) is
--!! begin
--!! OsvvmDefaultTimeUnitsVar.Set(A) ;
--!! end procedure SetOsvvmDefaultTimeUnits ;
--!!
--!! impure function GetOsvvmDefaultTimeUnits return time is
--!! begin
--!! return OsvvmDefaultTimeUnitsVar.Get ;
--!! end function GetOsvvmDefaultTimeUnits ;
--!!
--!! shared variable WritePrefixVar : NamePType ;
--!! shared variable DoneNameVar : NamePType ;
--!! shared variable PassNameVar : NamePType ;
--!! shared variable FailNameVar : NamePType ;
--!! shared variable IdSeparatorVar : NamePType ;
--!! shared variable WritePassFailVar : OptionsPType ; -- := FALSE ;
--!! shared variable WriteBinInfoVar : OptionsPType ; -- := TRUE ;
--!! shared variable WriteCountVar : OptionsPType ; -- := TRUE ;
--!! shared variable WriteAnyIllegalVar : OptionsPType ; -- := FALSE ;
--!!
--!! ------------------------------------------------------------
--!! procedure SetOsvvmGlobalOptions (
--!! ------------------------------------------------------------
--!! WritePassFail : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WriteBinInfo : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WriteCount : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WriteAnyIllegal : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;
--!! WritePrefix : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! DoneName : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! PassName : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! FailName : string := OSVVM_STRING_INIT_PARM_DETECT ;
--!! IdSeparator : string := OSVVM_STRING_INIT_PARM_DETECT
--!! ) is
--!! begin
--!! if WritePassFail /= OPT_INIT_PARM_DETECT then
--!! WritePassFailVar.Set(WritePassFail) ;
--!! end if ;
--!! if WriteBinInfo /= OPT_INIT_PARM_DETECT then
--!! WriteBinInfoVar.Set(WriteBinInfo) ;
--!! end if ;
--!! if WriteCount /= OPT_INIT_PARM_DETECT then
--!! WriteCountVar.Set(WriteCount) ;
--!! end if ;
--!! if WriteAnyIllegal /= OPT_INIT_PARM_DETECT then
--!! WriteAnyIllegalVar.Set(WriteAnyIllegal) ;
--!! end if ;
--!! if WritePrefix /= OSVVM_STRING_INIT_PARM_DETECT then
--!! WritePrefixVar.Set(WritePrefix) ;
--!! end if ;
--!! if DoneName /= OSVVM_STRING_INIT_PARM_DETECT then
--!! DoneNameVar.Set(DoneName) ;
--!! end if ;
--!! if PassName /= OSVVM_STRING_INIT_PARM_DETECT then
--!! PassNameVar.Set(PassName) ;
--!! end if ;
--!! if FailName /= OSVVM_STRING_INIT_PARM_DETECT then
--!! FailNameVar.Set(FailName) ;
--!! end if ;
--!! if IdSeparator /= OSVVM_STRING_INIT_PARM_DETECT then
--!! IdSeparatorVar.Set(IdSeparator) ;
--!! end if ;
--!! end procedure SetOsvvmGlobalOptions ;
--!!
--!! ------------------------------------------------------------
--!! -- Accessor Functions
--!! -- Local Function
--!! function IsOsvvmOptionSet (A : OsvvmOptionsType) return boolean is
--!! begin
--!! return A > OPT_USE_DEFAULT ;
--!! end function IsOsvvmOptionSet ;
--!!
--!! function ResolveOsvvmOption(A, B, C : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! if IsOsvvmOptionSet(A) then
--!! return A ;
--!! elsif IsOsvvmOptionSet(B) then
--!! return B ;
--!! else
--!! return C ;
--!! end if ;
--!! end function ResolveOsvvmOption ;
--!!
--!! function ResolveOsvvmOption(A, B, C, D : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! if IsOsvvmOptionSet(A) then
--!! return A ;
--!! elsif IsOsvvmOptionSet(B) then
--!! return B ;
--!! elsif IsOsvvmOptionSet(C) then
--!! return C ;
--!! else
--!! return D ;
--!! end if ;
--!! end function ResolveOsvvmOption ;
--!!
--!! function ResolveOsvvmOption(A, B : string) return string is
--!! begin
--!! if IsOsvvmStringSet(A) then
--!! return A ;
--!! else
--!! return B ;
--!! end if ;
--!! end function ResolveOsvvmOption ;
--!!
--!! function ResolveOsvvmOption(A, B, C : string) return string is
--!! begin
--!! if IsOsvvmStringSet(A) then
--!! return A ;
--!! elsif IsOsvvmStringSet(B) then
--!! return B ;
--!! else
--!! return C ;
--!! end if ;
--!! end function ResolveOsvvmOption ;
--!!
--!! function ResolveOsvvmOption(A, B, C, D : string) return string is
--!! begin
--!! if IsOsvvmStringSet(A) then
--!! return A ;
--!! elsif IsOsvvmStringSet(B) then
--!! return B ;
--!! elsif IsOsvvmStringSet(C) then
--!! return C ;
--!! else
--!! return D ;
--!! end if ;
--!! end function ResolveOsvvmOption ;
--!!
--!! impure function ResolveOsvvmWritePrefix(A : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, WritePrefixVar.GetOpt, OSVVM_DEFAULT_WRITE_PREFIX) ;
--!! end function ResolveOsvvmWritePrefix ;
--!!
--!! impure function ResolveOsvvmDoneName(A : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, DoneNameVar.GetOpt, OSVVM_DEFAULT_DONE_NAME) ;
--!! end function ResolveOsvvmDoneName ;
--!!
--!! impure function ResolveOsvvmPassName(A : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, PassNameVar.GetOpt, OSVVM_DEFAULT_PASS_NAME) ;
--!! end function ResolveOsvvmPassName ;
--!!
--!! impure function ResolveOsvvmFailName(A : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, FailNameVar.GetOpt, OSVVM_DEFAULT_FAIL_NAME) ;
--!! end function ResolveOsvvmFailName ;
--!!
--!! impure function ResolveOsvvmIdSeparator(A : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, IdSeparatorVar.GetOpt, OSVVM_DEFAULT_ID_SEPARATOR) ;
--!! end function ResolveOsvvmIdSeparator ;
--!!
--!!
--!! impure function ResolveCovWritePassFail(A : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, WritePassFailVar.Get, OSVVM_DEFAULT_WRITE_PASS_FAIL) ;
--!! end function ResolveCovWritePassFail ; -- Cov
--!!
--!! impure function ResolveCovWriteBinInfo(A : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, WriteBinInfoVar.Get, OSVVM_DEFAULT_WRITE_BIN_INFO) ;
--!! end function ResolveCovWriteBinInfo ; -- Cov
--!!
--!! impure function ResolveCovWriteCount(A : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, WriteCountVar.Get, OSVVM_DEFAULT_WRITE_COUNT) ;
--!! end function ResolveCovWriteCount ; -- Cov
--!!
--!! impure function ResolveCovWriteAnyIllegal(A : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, WriteAnyIllegalVar.Get, OSVVM_DEFAULT_WRITE_ANY_ILLEGAL) ;
--!! end function ResolveCovWriteAnyIllegal ; -- Cov
--!!
--!!
--!! impure function ResolveOsvvmWritePrefix(A, B : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, B, WritePrefixVar.GetOpt, OSVVM_DEFAULT_WRITE_PREFIX) ;
--!! end function ResolveOsvvmWritePrefix ;
--!!
--!! impure function ResolveOsvvmDoneName(A, B : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, DoneNameVar.GetOpt, OSVVM_DEFAULT_DONE_NAME) ;
--!! end function ResolveOsvvmDoneName ;
--!!
--!! impure function ResolveOsvvmPassName(A, B : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, B, PassNameVar.GetOpt, OSVVM_DEFAULT_PASS_NAME) ;
--!! end function ResolveOsvvmPassName ;
--!!
--!! impure function ResolveOsvvmFailName(A, B : String) return string is
--!! begin
--!! return ResolveOsvvmOption(A, B, FailNameVar.GetOpt, OSVVM_DEFAULT_FAIL_NAME) ;
--!! end function ResolveOsvvmFailName ;
--!!
--!!
--!! impure function ResolveCovWritePassFail(A, B : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, B, WritePassFailVar.Get, OSVVM_DEFAULT_WRITE_PASS_FAIL) ;
--!! end function ResolveCovWritePassFail ; -- Cov
--!!
--!! impure function ResolveCovWriteBinInfo(A, B : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, B, WriteBinInfoVar.Get, OSVVM_DEFAULT_WRITE_BIN_INFO) ;
--!! end function ResolveCovWriteBinInfo ; -- Cov
--!!
--!! impure function ResolveCovWriteCount(A, B : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, B, WriteCountVar.Get, OSVVM_DEFAULT_WRITE_COUNT) ;
--!! end function ResolveCovWriteCount ; -- Cov
--!!
--!! impure function ResolveCovWriteAnyIllegal(A, B : OsvvmOptionsType) return OsvvmOptionsType is
--!! begin
--!! return ResolveOsvvmOption(A, B, WriteAnyIllegalVar.Get, OSVVM_DEFAULT_WRITE_ANY_ILLEGAL) ;
--!! end function ResolveCovWriteAnyIllegal ; -- Cov
--!!
--!! procedure OsvvmDeallocate is
--!! begin
--!! -- Free up space used by NamePType within OsvvmGlobalPkg
--!! WritePrefixVar.Deallocate ;
--!! DoneNameVar.Deallocate ;
--!! PassNameVar.Deallocate ;
--!! FailNameVar.Deallocate ;
--!! WritePassFailVar.Set(FALSE) ; -- := FALSE ;
--!! WriteBinInfoVar.Set(TRUE ) ; -- := TRUE ;
--!! WriteCountVar.Set(TRUE ) ; -- := TRUE ;
--!! WriteAnyIllegalVar.Set(FALSE) ; -- := FALSE ;
--!!
--!! end procedure OsvvmDeallocate ;
end package body OsvvmGlobalPkg ;