Skip to content

Commit 5d4fc21

Browse files
dalex78LarsAsplund
authored andcommitted
Add pictures for the 'allow_missing_start' of the 'check_next' procedure (see #576). Indicates in the timing diagram when the options 'allow_overlapping' and 'allow_missing_start' add no influence regarding the given example.
1 parent ceae3a0 commit 5d4fc21

7 files changed

Lines changed: 23 additions & 4 deletions

docs/check/images/check_next_passing.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
{name: 'expr', wave: '0.....10'},
77
{name: 'active_clock_edge', wave: '=.......', data: ['rising_edge']},
88
{name: 'num_cks', wave: '=.......', data: ['4']},
9-
{name: 'allow_overlapping', wave: '=.......', data: ['true']},
10-
{name: 'allow_missing_start', wave: '=.......', data: ['true']}
9+
{name: 'allow_overlapping', wave: '=.......', data: ['true/false']},
10+
{name: 'allow_missing_start', wave: '=.......', data: ['true/false']}
1111
],
1212
head:{
1313
tick:0,
-4.47 KB
Loading
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
signal: [
3+
{name: 'clock', wave: 'p.........'},
4+
{name: 'en', wave: '1...01....'},
5+
{name: 'start_event', wave: '010.......'},
6+
{name: 'expr', wave: '0.....1010'},
7+
{name: 'active_clock_edge', wave: '=.........', data: ['rising_edge']},
8+
{name: 'num_cks', wave: '=.........', data: ['4']},
9+
{name: 'allow_overlapping', wave: '=.........', data: ['true']},
10+
{name: 'allow_missing_start', wave: '=.........', data: ['true']}
11+
],
12+
head:{
13+
tick:0,
14+
}
15+
}
13.8 KB
Loading

docs/check/images/check_next_passing_with_overlap.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
{name: 'active_clock_edge', wave: '=.........', data: ['rising_edge']},
88
{name: 'num_cks', wave: '=.........', data: ['4']},
99
{name: 'allow_overlapping', wave: '=.........', data: ['true']},
10-
{name: 'allow_missing_start', wave: '=.........', data: ['true']}
10+
{name: 'allow_missing_start', wave: '=.........', data: ['true/false']}
1111
],
1212
head:{
1313
tick:0,
-5.03 KB
Loading

docs/check/user_guide.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -951,7 +951,11 @@ the second start event
951951
When ``allow_missing_start`` is ``true`` ``check_next`` will allow
952952
``expr = '1'`` when there is no corresponding start event. When
953953
``allow_missing_start`` is ``false`` such a situation will lead to a
954-
failure.
954+
failure. Here is an example where ``expr`` is at ``'1'`` for one
955+
cycles with no corresponding start event.
956+
957+
.. figure:: images/check_next_passing_with_missing_start.png
958+
:alt:
955959

956960
Any unknown value (``U``, ``X``, ``Z``, ``W``, or ``-``) on ``start_event``
957961
will cause an error.

0 commit comments

Comments
 (0)