Skip to content

Commit 989ef7d

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

File tree

6 files changed

+283
-0
lines changed

6 files changed

+283
-0
lines changed

docs/library/drivers/common/scoreboard/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ subscriber_class which extends adi_subscriber and is responsible for receiving
1414
and storing data streams. The scoreboard can operate in oneshot or in
1515
cyclic mode, which allows the verification of repeating sequence verification.
1616

17+
.. svg:: library/drivers/common/scoreboard/scoreboard.svg
18+
:align: center
19+
1720
Variables
1821
-------------------------------------------------------------------------------
1922

docs/library/drivers/common/scoreboard/scoreboard.svg

Lines changed: 102 additions & 0 deletions
Loading
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Classes
2+
3+
# Base
4+
adi_reporter: {shape: class}
5+
adi_component: {shape: class}
6+
7+
# Component
8+
adi_subscriber: {shape: class}
9+
10+
# Scoreboard
11+
scoreboard: {
12+
shape: class
13+
+subscriber_source
14+
+subscriber_sink
15+
\#sink_type
16+
\#enabled
17+
\#bytestream_empty_sig
18+
\#byte_streams_empty
19+
\#stop_scoreboard
20+
+run()
21+
+stop()
22+
+set_sink_type()
23+
+get_sink_type()
24+
\#clear_streams()
25+
+wait_until_complete()
26+
+compare_transaction()
27+
}
28+
29+
# Inheritances
30+
31+
# Base
32+
adi_reporter <- adi_component: {shape: triangle; source-arrowhead.style.filled: false}
33+
34+
# Scoreboard
35+
adi_component <- scoreboard: {shape: triangle; source-arrowhead.style.filled: false}
36+
37+
# Aggregations
38+
39+
# Scoreboard
40+
scoreboard <- adi_subscriber: {source-arrowhead: 2 {shape: diamond; style.filled: true}}

docs/library/drivers/common/scoreboard_pack/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ This class is a specialized version of a generic scoreboard class, parameterized
1010
by the data type and packer mode. The scoreboard pack class is designed to
1111
handle and compare data streams in a verification environment.
1212

13+
.. svg:: library/drivers/common/scoreboard_pack/scoreboard_pack.svg
14+
:align: center
15+
1316
Variables
1417
-------------------------------------------------------------------------------
1518

docs/library/drivers/common/scoreboard_pack/scoreboard_pack.svg

Lines changed: 102 additions & 0 deletions
Loading
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Classes
2+
3+
# Base
4+
adi_reporter: {shape: class}
5+
adi_component: {shape: class}
6+
7+
# Component
8+
adi_subscriber: {shape: class}
9+
10+
# Scoreboard
11+
scoreboard: {shape: class}
12+
scoreboard_pack: {
13+
shape: class
14+
\#channels
15+
\#samples
16+
\#width
17+
\#mode
18+
+compare_transaction()
19+
}
20+
21+
# Inheritances
22+
23+
# Base
24+
adi_reporter <- adi_component: {shape: triangle; source-arrowhead.style.filled: false}
25+
26+
# Scoreboard
27+
adi_component <- scoreboard: {shape: triangle; source-arrowhead.style.filled: false}
28+
scoreboard <- scoreboard_pack: {shape: triangle; source-arrowhead.style.filled: false}
29+
30+
# Aggregations
31+
32+
# Scoreboard
33+
scoreboard_pack <- adi_subscriber: {source-arrowhead: 2 {shape: diamond; style.filled: true}}

0 commit comments

Comments
 (0)