Skip to content

Commit ab3e1d8

Browse files
docs: Scoreboard pack
Signed-off-by: Istvan-Zsolt Szekely <istvan.szekely@analog.com>
1 parent b0db5c5 commit ab3e1d8

File tree

1 file changed

+43
-0
lines changed
  • docs/library/drivers/common/scoreboard_pack

1 file changed

+43
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
.. _scoreboard_pack:
2+
3+
Scoreboard Pack
4+
================================================================================
5+
6+
Overview
7+
-------------------------------------------------------------------------------
8+
9+
This class is a specialized version of a generic scoreboard class, parameterized
10+
by the data type and packer mode. The scoreboard pack class is designed to
11+
handle and compare data streams in a verification environment.
12+
13+
Variables
14+
-------------------------------------------------------------------------------
15+
16+
No additional variables are available for direct external access.
17+
18+
Functions
19+
-------------------------------------------------------------------------------
20+
21+
function new(...);
22+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23+
24+
Creates the scoreboard object. The name gives the scoreboard a name that is
25+
relevant in the current environment it is instantiated in, the channels set the
26+
number of channels that are present on the packer module, the sample value sets
27+
the number of samples that are set in the converter, the width specifies the
28+
width of one sample for one channel, the mode is set based on the current pack
29+
module, which can be a packer or unpacker and the parent sets the parent object
30+
in which it resides.
31+
32+
virtual function void compare_transaction();
33+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
34+
35+
The compare module's base functionality is the same as the base class, but it
36+
specifically verifies the input and output of the packer and unpacker modules.
37+
38+
Usage and recommendations
39+
-------------------------------------------------------------------------------
40+
41+
Same as the base class.
42+
43+
.. include:: ../../../../common/support.rst

0 commit comments

Comments
 (0)