Skip to content

Commit

Permalink
[doc] Minor tweak to md sanitisation code
Browse files Browse the repository at this point in the history 
This code replaces \n with a space when populating table cells. A good
idea! But it ended up leaving a double space if the source hjson had a
blank line.

There was also a bit of a mess if we have a newline followed by several
spaces. This turned into two spaces, not one.

The fix is simple: treat any number of newlines, followed by any
number of spaces as a single space. The handwritten code here is just
a 1-line change to md_helpers.py. The rest of the commit is from
regenerating the auto-generated stuff that it builds.

Signed-off-by: Rupert Swarbrick <[email protected]>
  • Loading branch information
@rswarbrick
rswarbrick committed Dec 25, 2023
1 parent 671f2b5 commit e7ad3ec
Show file tree
Hide file tree
Showing 20 changed files with 385 additions and 385 deletions.
20 changes: 10 additions & 10 deletions hw/ip/entropy_src/doc/interfaces.md
View file

Large diffs are not rendered by default.

62 changes: 31 additions & 31 deletions hw/ip/entropy_src/doc/registers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -859,9 +859,9 @@ Repetition count test failure counter register
{"reg": [{"name": "REPCNT_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | REPCNT_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:-------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | REPCNT_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## REPCNTS_TOTAL_FAILS
Repetition count symbol test failure counter register
Expand All @@ -875,9 +875,9 @@ Repetition count symbol test failure counter register
{"reg": [{"name": "REPCNTS_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | REPCNTS_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:--------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | REPCNTS_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## ADAPTP_HI_TOTAL_FAILS
Adaptive proportion high test failure counter register
Expand All @@ -891,9 +891,9 @@ Adaptive proportion high test failure counter register
{"reg": [{"name": "ADAPTP_HI_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | ADAPTP_HI_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | ADAPTP_HI_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## ADAPTP_LO_TOTAL_FAILS
Adaptive proportion low test failure counter register
Expand All @@ -907,9 +907,9 @@ Adaptive proportion low test failure counter register
{"reg": [{"name": "ADAPTP_LO_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | ADAPTP_LO_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | ADAPTP_LO_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## BUCKET_TOTAL_FAILS
Bucket test failure counter register
Expand All @@ -923,9 +923,9 @@ Bucket test failure counter register
{"reg": [{"name": "BUCKET_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:-------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | BUCKET_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:-------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | BUCKET_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## MARKOV_HI_TOTAL_FAILS
Markov high test failure counter register
Expand All @@ -939,9 +939,9 @@ Markov high test failure counter register
{"reg": [{"name": "MARKOV_HI_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | MARKOV_HI_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | MARKOV_HI_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## MARKOV_LO_TOTAL_FAILS
Markov low test failure counter register
Expand All @@ -955,9 +955,9 @@ Markov low test failure counter register
{"reg": [{"name": "MARKOV_LO_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | MARKOV_LO_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:----------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | MARKOV_LO_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## EXTHT_HI_TOTAL_FAILS
External health test high threshold failure counter register
Expand All @@ -971,9 +971,9 @@ External health test high threshold failure counter register
{"reg": [{"name": "EXTHT_HI_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | EXTHT_HI_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:---------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | EXTHT_HI_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## EXTHT_LO_TOTAL_FAILS
External health test low threshold failure counter register
Expand All @@ -987,9 +987,9 @@ External health test low threshold failure counter register
{"reg": [{"name": "EXTHT_LO_TOTAL_FAILS", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | EXTHT_LO_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:---------------------|:--------------------------------------------------------------------------------------------------------------------------|
| 31:0 | ro | x | EXTHT_LO_TOTAL_FAILS | This register will hold a running count of test failures observed during normal operation. It will persist until cleared. |

## ALERT_THRESHOLD
Alert threshold register
Expand All @@ -1004,10 +1004,10 @@ Alert threshold register
{"reg": [{"name": "ALERT_THRESHOLD", "bits": 16, "attr": ["rw"], "rotate": 0}, {"name": "ALERT_THRESHOLD_INV", "bits": 16, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
```

| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
| 31:16 | rw | 0xfffd | ALERT_THRESHOLD_INV | This should be set to the value above, but inverted. |
| 15:0 | rw | 0x2 | ALERT_THRESHOLD | This is the threshold size that will signal an alert when value is reached. A value of zero will disable alerts. The default value is 2. |
| Bits | Type | Reset | Name | Description |
|:------:|:------:|:-------:|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|
| 31:16 | rw | 0xfffd | ALERT_THRESHOLD_INV | This should be set to the value above, but inverted. |
| 15:0 | rw | 0x2 | ALERT_THRESHOLD | This is the threshold size that will signal an alert when value is reached. A value of zero will disable alerts. The default value is 2. |

## ALERT_SUMMARY_FAIL_COUNTS
Alert summary failure counts register
Expand Down
Loading

0 comments on commit e7ad3ec

Please sign in to comment.