Skip to content

Commit 10173c6

Browse files
committed
Updated CHANGELOG and README in prep for release 2022.10
1 parent effee29 commit 10173c6

File tree

2 files changed

+39
-18
lines changed

2 files changed

+39
-18
lines changed

CHANGELOG.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# OSVVM Common Library Change Log
22

3-
| Revision | Revision Date | Release Summary |
4-
------------|---------------|-----------
5-
| 2022.01 | January 2022 | Added Burst Patterns to Address Bus and Stream
6-
| 2021.06 | June 2021 | Updated FifoFillPkg_slv.vhd ...
7-
| 2020.12 | December 2020 | Consistency updates to AddressBus and Stream MIT
8-
| 2020.10 | October 2020 | Added Bursting to Stream Model Independent Transactions
9-
| 2020.07 | July 2020 | Updated for MIT and freed the slaves
10-
| 2020.02 | February 2020 | Created by refactoring Axi4LiteMasterTransactionPkg
3+
| Revision | Release Summary |
4+
------------|-----------
5+
| 2022.10 | Updated InterruptHandler for BurstFIFO updates.
6+
| | Updated PushBurstRandom / CheckBurstRandom to work around Questa bugs
7+
| 2022.01 | Added Burst Patterns to Address Bus and Stream
8+
| 2021.06 | Updated FifoFillPkg_slv.vhd ...
9+
| 2020.12 | Consistency updates to AddressBus and Stream MIT
10+
| 2020.10 | Added Bursting to Stream Model Independent Transactions
11+
| 2020.07 | Updated for MIT and freed the slaves
12+
| 2020.02 | Created by refactoring Axi4LiteMasterTransactionPkg
1113

1214

1315
## 2022.01 January 2022

README.md

+29-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# OSVVM Common Library
2-
The OSVVM Common Library
3-
defines OSVVM's Model Independent Transactions (MIT).
2+
The OSVVM Common library defines
3+
* OSVVM Model Independent Transactions (MIT)
4+
* Support functions for filling burst transfer FIFOs (in MIT or not)
5+
* Generic Interrupt handler for MIT
6+
* Model Parameter Settings support
7+
8+
9+
## About OSVVM's Model Independent Transactions (MIT).
410
MIT defines a common communication interface (record based)
511
and transaction API for Address Bus and Streaming Interface.
612
Using MIT makes verification component development as easy
@@ -46,27 +52,40 @@ You can find the project [Authors here](AUTHORS.md) and
4652

4753
### common/src
4854
* StreamTransactionPkg.vhd
49-
* Stream Interface Model Independent Transaction Definitions
55+
* Stream Interface Model Independent Transaction (MIT) Definitions
5056
* AddressBusTransactionPkg.vhd
51-
* Address Bus Interface Model Independent Transaction Definitions
57+
* Address Bus Interface Model Independent Transaction (MIT) Definitions
5258
* AddressBusResponderTransactionPkg.vhd
53-
* Address Bus Responder Interface Model Independent Transaction Definitions
59+
* Address Bus Responder Interface Model Independent Transaction (MIT) Definitions
5460
* AddressBusVersionCompatibilityPkg.vhd
5561
* Aliases to keep this version compatible with last version
5662
* ModelParametersPkg.vhd
5763
* Support for setting parameters in a verification component
5864
* FifoFillPkg_slv.vhd
5965
* Implements fill patterns for verification component burst buffers.
66+
* InterruptHandler.vhd
67+
* Generic Interrupt Handler for any VC that implements Address Bus Interface MIT
68+
* InterruptHandlerComponentPkg.vhd
69+
* Component declaration for the OSVVM Interrupt Handler
6070
* OsvvmCommonContext.vhd
6171
* Context declaration to include all above packages
6272

6373
For current compile order see Common/common.pro.
6474

65-
### common/testbench
66-
* TbModelParameters.vhd
67-
* Verify ModelParametersPkg.vhd
68-
69-
For current compile order see Common/testbench/testbench.pro.
75+
### Verification
76+
* AddressBusTransactionPkg and AddressBusResponderTransactionPkg
77+
* OsvvmLibraries/AXI4/Axi4/RunAllTests.pro
78+
* StreamTransactionPkg
79+
* OsvvmLibraries/AXI4/AxiStream/RunAllTests.pro
80+
* FifoFillPkg_slv
81+
* OsvvmLibraries/AXI4/Axi4/RunAllTests.pro
82+
* InterruptHandler
83+
* OsvvmLibraries/AXI4/Axi4/testbench_interrupt
84+
* ModelParametersPkg
85+
* common/testbench
86+
* TbModelParameters.vhd to verify ModelParametersPkg.vhd
87+
* Runs using testbench.pro
88+
7089

7190
## More Information on OSVVM
7291

0 commit comments

Comments
 (0)