forked from OSVVM/OSVVM
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathReportPkg.vhd
More file actions
226 lines (197 loc) · 7.9 KB
/
Copy pathReportPkg.vhd
File metadata and controls
226 lines (197 loc) · 7.9 KB
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
--
-- File Name: ReportPkg.vhd
-- Design Unit Name: ReportPkg
-- Revision: STANDARD VERSION
--
-- Maintainer: Jim Lewis email: jim@synthworks.com
-- Contributor(s):
-- Jim Lewis jim@synthworks.com
--
-- Description:
-- Generate Final Reports
-- Elements of these reports come from AlertLogPkg, CoveragePkg, and
-- the ScoreboardGenericPkg instances of ScoreboardPkg_int and ScoreboardPkg_slv
--
-- Developed for:
-- SynthWorks Design Inc.
-- VHDL Training Classes
-- 11898 SW 128th Ave. Tigard, Or 97223
-- http://www.SynthWorks.com
--
-- Revision History:
-- Version Description
-- 2026.08 Moved TranscriptOpen to TranscriptPkg
-- 2024.07 Added timeout flag to EndOfTestReports.
-- Added scoreboard reporting for: unsigned, signed, and IntV
-- 2024.01 Updated WriteCovSummaryYaml to print FunctionalCoverage: "" when no functional coverage (to work with TCL 8.5).
-- 2023.09 Added WriteSimTimeYaml.
-- 2023.07 Added call to WriteRequirementsYaml.
-- 2023.04 Added TranscriptOpen without parameters
-- 2023.01 OSVVM_TEMP_OUTPUT_DIRECTORY replaced REPORTS_DIRECTORY
-- Added simple TranscriptOpen that uses GetTestName
-- 2022.06 Minor reordering of EndOfTestReports
-- 2022.02 EndOfTestReports now calls WriteScoreboardYaml
-- 2021.10 Initial revision
--
-- This file is part of OSVVM.
--
-- Copyright (c) 2021-2026 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.
--
use std.textio.all ;
use work.OsvvmScriptSettingsPkg.all ;
use work.TranscriptBasePkg.all ;
use work.AlertLogPkg.all ;
use work.CoveragePkg.all ;
use work.ScoreboardPkg_slv.all ;
use work.ScoreboardPkg_signed.all ;
use work.ScoreboardPkg_unsigned.all ;
use work.ScoreboardPkg_int.all ;
use work.ScoreboardPkg_IntV.all ;
package ReportPkg is
impure function EndOfTestReports (
ReportAll : boolean := FALSE ;
ExternalErrors : AlertCountType := (0,0,0) ;
TimeOut : boolean := FALSE
) return integer ;
procedure EndOfTestReports (
ReportAll : boolean := FALSE ;
ExternalErrors : AlertCountType := (0,0,0) ;
Stop : boolean := FALSE ;
TimeOut : boolean := FALSE
) ;
alias EndOfTestSummary is EndOfTestReports[boolean, AlertCountType, boolean return integer] ;
alias EndOfTestSummary is EndOfTestReports[boolean, AlertCountType, boolean, boolean] ;
-- Deprecated in this location. These moved to TranscriptPkg. Aliases to support backward compatibility
alias TranscriptOpen is work.TranscriptPkg.TranscriptOpen [FILE_OPEN_STATUS, WRITE_APPEND_OPEN_KIND] ;
alias TranscriptOpen is work.TranscriptPkg.TranscriptOpen [WRITE_APPEND_OPEN_KIND] ;
alias TranscriptOpen is work.TranscriptPkg.TranscriptOpen [FILE_OPEN_STATUS] ;
alias TranscriptOpen is work.TranscriptPkg.TranscriptOpen [] ;
end ReportPkg ;
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
--- ///////////////////////////////////////////////////////////////////////////
package body ReportPkg is
------------------------------------------------------------
procedure WriteCovSummaryYaml (FileName : string ) is
------------------------------------------------------------
--x file OsvvmYamlFile : text open APPEND_MODE is FileName ;
file OsvvmYamlFile : text ;
variable buf : line ;
begin
file_open(OsvvmYamlFile, FileName, APPEND_MODE) ;
if GotCoverage then
swrite(buf, " FunctionalCoverage: " & to_string(GetCov, 2)) ;
else
swrite(buf, " FunctionalCoverage: " & """""") ;
end if ;
writeline(OsvvmYamlFile, buf) ;
file_close(OsvvmYamlFile) ;
end procedure WriteCovSummaryYaml ;
------------------------------------------------------------
procedure WriteSimTimeYaml (FileName : string ) is
------------------------------------------------------------
--x file OsvvmYamlFile : text open APPEND_MODE is FileName ;
file OsvvmYamlFile : text ;
variable buf : line ;
begin
file_open(OsvvmYamlFile, FileName, APPEND_MODE) ;
swrite(buf, " SimulationTime: """ & to_string(NOW) & '"') ;
writeline(OsvvmYamlFile, buf) ;
file_close(OsvvmYamlFile) ;
end procedure WriteSimTimeYaml ;
------------------------------------------------------------
impure function EndOfTestReports (
------------------------------------------------------------
ReportAll : boolean := FALSE ;
ExternalErrors : AlertCountType := (0,0,0) ;
TimeOut : boolean := FALSE
) return integer is
begin
if TimeOut then
Alert("TimeOut signaled to EndOFTestReports") ;
end if;
if GotCoverage then
WriteCovYaml (
FileName => OSVVM_TEMP_OUTPUT_DIRECTORY & GetTestName & "_cov.yml"
) ;
RecordCovRequirements ;
end if ;
if work.ScoreboardPkg_slv.GotScoreboards then
work.ScoreboardPkg_slv.WriteScoreboardYaml (
FileName => "slv", FileNameIsBaseName => TRUE
) ;
end if ;
if work.ScoreboardPkg_unsigned.GotScoreboards then
work.ScoreboardPkg_unsigned.WriteScoreboardYaml (
FileName => "unsigned", FileNameIsBaseName => TRUE
) ;
end if ;
if work.ScoreboardPkg_signed.GotScoreboards then
work.ScoreboardPkg_signed.WriteScoreboardYaml (
FileName => "signed", FileNameIsBaseName => TRUE
) ;
end if ;
if work.ScoreboardPkg_int.GotScoreboards then
work.ScoreboardPkg_int.WriteScoreboardYaml (
FileName => "int", FileNameIsBaseName => TRUE
) ;
end if ;
if work.ScoreboardPkg_IntV.GotScoreboards then
work.ScoreboardPkg_IntV.WriteScoreboardYaml (
FileName => "IntV", FileNameIsBaseName => TRUE
) ;
end if ;
if GotRequirements then
WriteRequirementsYaml (
FileName => OSVVM_TEMP_OUTPUT_DIRECTORY & GetTestName & "_req.yml"
) ;
end if ;
-- Summarize Results Last to allow previous steps to update Alerts
WriteCovSummaryYaml (
FileName => OSVVM_BUILD_YAML_FILE
) ;
WriteSimTimeYaml (
FileName => OSVVM_BUILD_YAML_FILE
) ;
ReportAlerts(ExternalErrors => ExternalErrors, ReportAll => ReportAll, TimeOut => TimeOut) ;
WriteAlertSummaryYaml(
FileName => OSVVM_BUILD_YAML_FILE,
ExternalErrors => ExternalErrors,
TimeOut => TimeOut
) ;
WriteAlertYaml (
FileName => OSVVM_TEMP_OUTPUT_DIRECTORY & GetTestName & "_alerts.yml",
ExternalErrors => ExternalErrors,
TimeOut => TimeOut
) ;
TranscriptClose ; -- Close Transcript if open
return SumAlertCount(GetAlertCount + ExternalErrors) ;
end function EndOfTestReports ;
------------------------------------------------------------
procedure EndOfTestReports (
------------------------------------------------------------
ReportAll : boolean := FALSE ;
ExternalErrors : AlertCountType := (0,0,0) ;
Stop : boolean := FALSE ;
TimeOut : boolean := FALSE
) is
variable ErrorCount : integer ;
begin
ErrorCount := EndOfTestReports(ReportAll, ExternalErrors, TimeOut) ;
if Stop then
std.env.stop ;
end if ;
end procedure EndOfTestReports ;
end package body ReportPkg ;