Package: ScoreboardGenericPkg
- File: ScoreboardGenericPkg.vhd
Types
| Name | Type | Description |
|---|---|---|
| ScoreboardReportType | (REPORT_ERROR, REPORT_ALL, REPORT_NONE) |
replaced by affirmations |
| ScoreboardIdType | ||
| ScoreboardIdArrayType | array (integer range <>) of ScoreboardIdType | |
| ScoreboardIdMatrixType | array (integer range <>, integer range <>) of ScoreboardIdType |
|
| ScoreBoardPType |
Functions
- Push ( constant ID : in ScoreboardIDType ;
constant Item : in ExpectedType ) return ()
Description
Push items into the scoreboard/FIFO
Simple Scoreboard, no tag
- Push ( constant ID : in ScoreboardIDType ;
constant Tag : in string ;
constant Item : in ExpectedType ) return ()
Description
Simple Tagged Scoreboard
- Check ( constant ID : in ScoreboardIDType ;
constant ActualData : in ActualType ) return ()
Description
Check received item with item in the scoreboard/FIFO
Simple Scoreboard, no tag
- Check ( constant ID : in ScoreboardIDType ;
constant Tag : in string ;
constant ActualData : in ActualType ) return ()
Description
Simple Tagged Scoreboard
- Pop ( constant ID : in ScoreboardIDType ;
variable Item : out ExpectedType ) return ()
Description
Pop the top item (FIFO) from the scoreboard/FIFO
Simple Scoreboard, no tag
- Pop ( constant ID : in ScoreboardIDType ;
constant Tag : in string ;
variable Item : out ExpectedType ) return ()
Description
Simple Tagged Scoreboard
- Peek ( constant ID : in ScoreboardIDType ;
constant Tag : in string ;
variable Item : out ExpectedType ) return ()
Description
Peek at the top item (FIFO) from the scoreboard/FIFO
Simple Tagged Scoreboard
- Peek ( constant ID : in ScoreboardIDType ;
variable Item : out ExpectedType ) return ()
Description
Simple Scoreboard, no tag
- SetAlertLogID ( constant ID : in ScoreboardIDType ;
constant Name : in string ;
constant ParentID : in AlertLogIDType := OSVVM_SCOREBOARD_ALERTLOG_ID ;
constant CreateHierarchy : in Boolean := TRUE ;
constant DoNotReport : in Boolean := FALSE ) return ()
Description
Simple, Tagged
SetAlertLogID - associate an AlertLogID with a scoreboard to allow integrated error reporting
- SetAlertLogID ( constant ID : in ScoreboardIDType ;
constant A : AlertLogIDType ) return ()
Description
Use when an AlertLogID is used by multiple items (Model or other Scoreboards). See also AlertLogPkg.GetAlertLogID
- Flush ( constant ID : in ScoreboardIDType ;
constant ItemNumber : in integer ) return ()
Description
Flush - Remove elements in the scoreboard upto and including the one with ItemNumber
See Find to identify an ItemNumber of a particular value and tag (if applicable)
Simple Scoreboards
- Flush ( constant ID : in ScoreboardIDType ;
constant Tag : in string ;
constant ItemNumber : in integer ) return ()
Description
Tagged Scoreboards - only removes items that also match the tag
- Deallocate ( constant ID : in ScoreboardIDType ) return ()
Description
Generally these are not required. When a simulation ends and
another simulation is started, a simulator will release all allocated items.
- Initialize ( constant ID : in ScoreboardIDType ) return ()
Description
Deletes all allocated items
- CheckFinish ( ID : ScoreboardIDType ;
FinishCheckCount : integer ;
FinishEmpty : boolean ) return ()
Description
- SetReportMode ( constant ID : in ScoreboardIDType ;
constant ReportModeIn : in ScoreboardReportType ) return ()
Description
SetReportMode
Not AlertFlow
REPORT_ALL: Replaced by AlertLogPkg.SetLogEnable(PASSED, TRUE)
REPORT_ERROR: Replaced by AlertLogPkg.SetLogEnable(PASSED, FALSE)
REPORT_NONE: Deprecated, do not use.
AlertFlow:
REPORT_ALL: Replaced by AlertLogPkg.SetLogEnable(AlertLogID, PASSED, TRUE)
REPORT_ERROR: Replaced by AlertLogPkg.SetLogEnable(AlertLogID, PASSED, FALSE)
REPORT_NONE: Replaced by AlertLogPkg.SetAlertEnable(AlertLogID, ERROR, FALSE)