library ieee ;

use ieee.std_logic_1164.all ;

use ieee.numeric_std.all ;

use ieee.math_real.all ;

use std.textio.all ;

use work.IfElsePkg.all ;

use work.OsvvmScriptSettingsPkg.all ;

use work.OsvvmSettingsPkg.all ;

use work.TextUtilPkg.all ;

use work.ResolutionPkg.all ;

use work.TranscriptBasePkg.all ;

use work.AlertLogPkg.all ;

use work.RandomBasePkg.all ;

use work.RandomProcedurePkg.all ;

use work.RandomPkg.all ;

use work.NamePkg.all ;

use work.NameStorePkg.all ;

use work.MessageListPkg.all ;

use work.OsvvmGlobalPkg.all ;

use work.CoverageVendorApiPkg.all ;

use work.LanguageSupport2019Pkg.all ;

package CoveragePkg is

type CoverageIDType is record

ID : integer_max ;

end record CoverageIDType ;

constant COVERAGE_ID_UNINITIALZED : CoverageIdType := (ID => integer'low) ;

type CoverageIDArrayType is array (integer range <>) of CoverageIDType ;

file OsvvmCoverageWriteBinFile : text ;

-- Merged the two constants in AlertLogPkg constant OSVVM_COVERAGE_ALERTLOG_ID : AlertLogIDType := OSVVM_COV_ALERTLOG_ID ;

-- CovPType allocates bins that are multiples of MIN_NUM_BINS

constant MIN_NUM_BINS : integer := 2**7 ; -- power of 2

type RangeType is record

min : integer ;

max : integer ;

end record ;

type RangeArrayType is array (integer range <>) of RangeType ;

constant ALL_RANGE : RangeArrayType := (1=>(integer'low, integer'high)) ;

procedure write ( variable buf : inout line ; constant BinVal : in RangeArrayType) ;

-- CovBinBaseType.action values.

-- Note that coverage counting depends on these values

constant COV_COUNT : integer := 1 ;

constant COV_IGNORE : integer := 0 ;

constant COV_ILLEGAL : integer := -1 ;

constant COV_OPT_INIT_PARM_DETECT : OsvvmOptionsType := OPT_INIT_PARM_DETECT ;

-- Used for easy manual entry. Order: min, max, action

-- Intentionally did not use a record to allow other input

-- formats in the future with VHDL-2008 unconstrained arrays

-- of unconstrained elements

-- type CovBinManualType is array (natural range <>) of integer_vector(0 to 2) ;

type CovBinBaseType is record

BinVal : RangeArrayType(1 to 1) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovBinType is array (natural range <>) of CovBinBaseType ;

constant ALL_BIN : CovBinType := (0 => ( BinVal => ALL_RANGE, Action => COV_COUNT, Count => 0, AtLeast => 1, Weight => 1 )) ;

constant ALL_COUNT : CovBinType := (0 => ( BinVal => ALL_RANGE, Action => COV_COUNT, Count => 0, AtLeast => 1, Weight => 1 )) ;

constant ALL_ILLEGAL : CovBinType := (0 => ( BinVal => ALL_RANGE, Action => COV_ILLEGAL, Count => 0, AtLeast => 0, Weight => 0 )) ;

constant ALL_IGNORE : CovBinType := (0 => ( BinVal => ALL_RANGE, Action => COV_IGNORE, Count => 0, AtLeast => 0, Weight => 0 )) ;

constant ZERO_BIN : CovBinType := (0 => ( BinVal => (1=>(0,0)), Action => COV_COUNT, Count => 0, AtLeast => 1, Weight => 1 )) ;

constant ONE_BIN : CovBinType := (0 => ( BinVal => (1=>(1,1)), Action => COV_COUNT, Count => 0, AtLeast => 1, Weight => 1 )) ;

constant NULL_BIN : CovBinType(work.RandomBasePkg.NULL_RANGE_TYPE) := (others => ( BinVal => ALL_RANGE, Action => integer'high, Count => 0, AtLeast => integer'high, Weight => integer'high )) ;

type NextPointModeType is (RANDOM, INCREMENT, MODE_MINIMUM) ;

type CountModeType is (COUNT_FIRST, COUNT_ALL) ;

type IllegalModeType is (ILLEGAL_ON, ILLEGAL_FAILURE, ILLEGAL_OFF) ;

-- WeightModeType other than AT_LEAST or REMAIN is deprecated

type WeightModeType is (AT_LEAST, REMAIN, WEIGHT, REMAIN_EXP, REMAIN_SCALED, REMAIN_WEIGHT ) ;

-- In VHDL-2008 CovMatrix?BaseType and CovMatrix?Type will be subsumed

-- by CovBinBaseType and CovBinType with RangeArrayType as an unconstrained array.

type CovMatrix2BaseType is record

BinVal : RangeArrayType(1 to 2) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix2Type is array (natural range <>) of CovMatrix2BaseType ;

type CovMatrix3BaseType is record

BinVal : RangeArrayType(1 to 3) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix3Type is array (natural range <>) of CovMatrix3BaseType ;

type CovMatrix4BaseType is record

BinVal : RangeArrayType(1 to 4) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix4Type is array (natural range <>) of CovMatrix4BaseType ;

type CovMatrix5BaseType is record

BinVal : RangeArrayType(1 to 5) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix5Type is array (natural range <>) of CovMatrix5BaseType ;

type CovMatrix6BaseType is record

BinVal : RangeArrayType(1 to 6) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix6Type is array (natural range <>) of CovMatrix6BaseType ;

type CovMatrix7BaseType is record

BinVal : RangeArrayType(1 to 7) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix7Type is array (natural range <>) of CovMatrix7BaseType ;

type CovMatrix8BaseType is record

BinVal : RangeArrayType(1 to 8) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix8Type is array (natural range <>) of CovMatrix8BaseType ;

type CovMatrix9BaseType is record

BinVal : RangeArrayType(1 to 9) ;

Action : integer ;

Count : integer ;

AtLeast : integer ;

Weight : integer ;

end record ;

type CovMatrix9Type is array (natural range <>) of CovMatrix9BaseType ;

------------------------------------------------------------ VendorCov

-- VendorCov Conversion for Vendor supported functional coverage modeling

function ToVendorCovBinVal (BinVal : RangeArrayType) return VendorCovRangeArrayType ;

------------------------------------------------------------

-- BinVal to Minimum Point

function ToMinPoint (A : RangeArrayType) return integer ;

function ToMinPoint (A : RangeArrayType) return integer_vector ;

------------------------------------------------------------

procedure ToRandPoint(

-- BinVal to Random Point

-- better as a function, however, inout not supported on functions

------------------------------------------------------------

variable RV : inout RandomPType ;

constant BinVal : in RangeArrayType ;

variable result : out integer

) ;

------------------------------------------------------------

procedure ToRandPoint(

-- BinVal to Random Point

------------------------------------------------------------

variable RV : inout RandomPType ;

constant BinVal : in RangeArrayType ;

variable result : out integer_vector

) ;

------------------------------------------------------------

impure function NewID (

Name : String ;

ParentID : AlertLogIDType := OSVVM_COVERAGE_ALERTLOG_ID ;

ReportMode : AlertLogReportModeType := ENABLED ;

Search : NameSearchType := PRIVATE_NAME ;

PrintParent : AlertLogPrintParentType := PRINT_NAME_AND_PARENT

) return CoverageIDType ;

------------------------------------------------------------

impure function NewReqID (

Name : String ;

ParentID : AlertLogIDType := OSVVM_COVERAGE_ALERTLOG_ID ;

ReportMode : AlertLogReportModeType := ENABLED ;

Search : NameSearchType := PRIVATE_NAME ;

PrintParent : AlertLogPrintParentType := PRINT_NAME_AND_PARENT

) return CoverageIDType ;

------------------------------------------------------------

impure function GetNumIDs return integer ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Coverage Global Settings Common to All Coverage Models

-- /////////////////////////////////////////

------------------------------------------------------------

procedure FileOpenWriteBin (FileName : string; OpenKind : File_Open_Kind ) ;

procedure FileCloseWriteBin ;

procedure PrintToCovFile(S : string) ;

------------------------------------------------------------

procedure SetReportOptions (

------------------------------------------------------------

WritePassFail : OsvvmOptionsType := COV_OPT_INIT_PARM_DETECT ;

WriteBinInfo : OsvvmOptionsType := COV_OPT_INIT_PARM_DETECT ;

WriteCount : OsvvmOptionsType := COV_OPT_INIT_PARM_DETECT ;

WriteAnyIllegal : OsvvmOptionsType := COV_OPT_INIT_PARM_DETECT ;

WritePrefix : string := OSVVM_STRING_INIT_PARM_DETECT ;

PassName : string := OSVVM_STRING_INIT_PARM_DETECT ;

FailName : string := OSVVM_STRING_INIT_PARM_DETECT

) ;

procedure ResetReportOptions ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Coverage Model Settings

-- /////////////////////////////////////////

------------------------------------------------------------

procedure SetAlertLogID (ID : CoverageIDType; A : AlertLogIDType) ;

procedure SetAlertLogID (ID : CoverageIDType; Name : string ; ParentID : AlertLogIDType := OSVVM_COVERAGE_ALERTLOG_ID ; CreateHierarchy : Boolean := TRUE) ;

impure function GetAlertLogID (ID : CoverageIDType) return AlertLogIDType ;

------------------------------------------------------------

impure function GetName (ID : CoverageIDType) return String ;

impure function GetCovModelName (ID : CoverageIDType) return String ;

impure function GetNamePlus (ID : CoverageIDType; prefix, suffix : string) return String ;

procedure SetItemBinNames (

ID : CoverageIDType ;

Name1 : String ;

Name2, Name3, Name4, Name5,

Name6, Name7, Name8, Name9, Name10,

Name11, Name12, Name13, Name14, Name15,

Name16, Name17, Name18, Name19, Name20 : string := ""

) ;

alias SetFieldName is SetItemBinNames [CoverageIDType,

string, string, string, string, string, string, string, string, string, string,

string, string, string, string, string, string, string, string, string, string] ;

procedure SetCovTarget (ID : CoverageIDType; Percent : real) ;

impure function GetCovTarget (ID : CoverageIDType) return real ;

procedure SetThresholding (ID : CoverageIDType; A : boolean := TRUE ) ;

procedure SetCovThreshold (ID : CoverageIDType; Percent : real) ;

procedure SetMerging (ID : CoverageIDType; A : boolean := TRUE ) ;

procedure SetCountMode (ID : CoverageIDType; A : CountModeType) ;

procedure SetIllegalMode (ID : CoverageIDType; A : IllegalModeType) ;

procedure SetNextPointMode (ID : CoverageIDType; A : NextPointModeType) ;

--

-- SetWeightMode with a WeightMode other than AT_LEAST or REMAIN is deprecated

-- SetWeightMode with a WeightScale parameter is deprecated

procedure SetWeightMode (ID : CoverageIDType; WeightMode : WeightModeType; WeightScale : real := 1.0) ;

procedure SetCovWeight (ID : CoverageIDType; Weight : integer) ;

impure function GetCovWeight (ID : CoverageIDType) return integer ;

------------------------------------------------------------

-- Seeds are initialized by NewID.

procedure InitSeed (ID : CoverageIDType; S : string; UseNewSeedMethods : boolean := COVERAGE_USE_NEW_SEED_METHODS) ;

impure function InitSeed (ID : CoverageIDType; S : string; UseNewSeedMethods : boolean := COVERAGE_USE_NEW_SEED_METHODS ) return string ;

procedure InitSeed (ID : CoverageIDType; I : integer; UseNewSeedMethods : boolean := COVERAGE_USE_NEW_SEED_METHODS ) ;

------------------------------------------------------------

procedure SetSeed (ID : CoverageIDType; RandomSeedIn : RandomSeedType ) ;

impure function GetSeed (ID : CoverageIDType) return RandomSeedType ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Item / Cross Bin Creation and Destruction

-- /////////////////////////////////////////

------------------------------------------------------------

procedure SetBinSize (ID : CoverageIDType; NewNumBins : integer) ;

procedure Deallocate (ID : CoverageIDType) ;

procedure DeallocateBins (CoverID : CoverageIDType) ;

alias DeleteBins is DeallocateBins[CoverageIdType] ;

------------------------------------------------------------

procedure AddBins (

------------------------------------------------------------

ID : CoverageIDType ;

Name : String ;

AtLeast : integer ;

CovBin : CovBinType

) ;

procedure AddBins (ID : CoverageIDType; Name : String ; CovBin : CovBinType) ;

procedure AddBins (ID : CoverageIDType; AtLeast : integer ; CovBin : CovBinType ) ;

procedure AddBins (ID : CoverageIDType; CovBin : CovBinType ) ;

------------------------------------------------------------

procedure AddCross(

------------------------------------------------------------

ID : CoverageIDType ;

Name : string ;

AtLeast : integer ;

Bin1, Bin2 : CovBinType ;

Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9, Bin10, Bin11, Bin12, Bin13,

Bin14, Bin15, Bin16, Bin17, Bin18, Bin19, Bin20 : CovBinType := NULL_BIN

) ;

------------------------------------------------------------

procedure AddCross(

------------------------------------------------------------

ID : CoverageIDType ;

Name : string ;

Bin1, Bin2 : CovBinType ;

Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9, Bin10, Bin11, Bin12, Bin13,

Bin14, Bin15, Bin16, Bin17, Bin18, Bin19, Bin20 : CovBinType := NULL_BIN

) ;

------------------------------------------------------------

procedure AddCross(

------------------------------------------------------------

ID : CoverageIDType ;

AtLeast : integer ;

Bin1, Bin2 : CovBinType ;

Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9, Bin10, Bin11, Bin12, Bin13,

Bin14, Bin15, Bin16, Bin17, Bin18, Bin19, Bin20 : CovBinType := NULL_BIN

) ;

------------------------------------------------------------

procedure AddCross(

------------------------------------------------------------

ID : CoverageIDType ;

Bin1, Bin2 : CovBinType ;

Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9, Bin10, Bin11, Bin12, Bin13,

Bin14, Bin15, Bin16, Bin17, Bin18, Bin19, Bin20 : CovBinType := NULL_BIN

) ;

------------------------------------------------------------

-- AddCross for usage with constants created by GenCross

------------------------------------------------------------

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix2Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix3Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix4Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix5Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix6Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix7Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix8Type ; Name : String := "") ;

procedure AddCross (ID : CoverageIDType; CovBin : CovMatrix9Type ; Name : String := "") ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Recording and Clearing Coverage

-- /////////////////////////////////////////

------------------------------------------------------------

------------------------------------------------------------

procedure ICoverLast (ID : CoverageIDType) ;

procedure ICover (ID : CoverageIDType; CovPoint : integer_vector) ;

procedure ICover (ID : CoverageIDType; CovPoint : integer) ;

procedure TCover (ID : CoverageIDType; A : integer) ;

impure function FindBinIndex (ID : CoverageIDType; CovPoint : integer_vector; StartingIndex : integer := 1) return integer ;

impure function FindBinIndex (ID : CoverageIDType; CovPoint : integer; StartingIndex : integer := 1) return integer ;

procedure ClearCov (ID : CoverageIDType) ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Coverage Information and Statistics

-- /////////////////////////////////////////

------------------------------------------------------------

------------------------------------------------------------

impure function IsBinCovered (ID : CoverageIDType ; BinIndex : integer ; PercentCov : real ) return boolean ;

impure function IsBinCovered (ID : CoverageIDType ; BinIndex : integer ) return boolean ;

impure function IsCovered (ID : CoverageIDType ; PercentCov : real ) return boolean ;

impure function IsCovered (ID : CoverageIDType) return boolean ;

impure function AllCovered (PercentCov : real ) return boolean ;

impure function AllCovered return boolean ;

impure function IsNotCovered (ID : CoverageIDType ; PercentCov : real ) return boolean ;

impure function IsNotCovered (ID : CoverageIDType) return boolean ;

impure function IsInitialized (ID : CoverageIDType) return boolean ;

------------------------------------------------------------

impure function IsBinCount (ID : CoverageIDType; BinIndex : integer) return boolean ;

impure function IsBinIllegal(ID : CoverageIDType; BinIndex : integer) return boolean ;

impure function IsBinIgnore (ID : CoverageIDType; BinIndex : integer) return boolean ;

------------------------------------------------------------

impure function IsPointCount (ID : CoverageIDType; CovPoint : integer_vector) return boolean ;

impure function IsPointCount (ID : CoverageIDType; CovPoint : integer) return boolean ;

impure function IsPointIllegal(ID : CoverageIDType; CovPoint : integer_vector) return boolean ;

impure function IsPointIllegal(ID : CoverageIDType; CovPoint : integer) return boolean ;

impure function IsPointIgnore (ID : CoverageIDType; CovPoint : integer_vector) return boolean ;

impure function IsPointIgnore (ID : CoverageIDType; CovPoint : integer) return boolean ;

------------------------------------------------------------

impure function GetItemCount (ID : CoverageIDType) return integer ;

impure function GetCov (ID : CoverageIDType; PercentCov : real ) return real ;

impure function GetCov (ID : CoverageIDType) return real ;

impure function GetTotalCovCount(ID : CoverageIDType; PercentCov : real ) return integer ;

impure function GetTotalCovCount(ID : CoverageIDType) return integer ;

impure function GetTotalCovGoal (ID : CoverageIDType; PercentCov : real ) return integer ;

impure function GetTotalCovGoal (ID : CoverageIDType) return integer ;

------------------------------------------------------------

impure function GetMinCov (ID : CoverageIDType) return real ;

impure function GetMinCount (ID : CoverageIDType) return integer ;

impure function GetMaxCov (ID : CoverageIDType) return real ;

impure function GetMaxCount (ID : CoverageIDType) return integer ;

impure function GetMaxAtLeast (ID : CoverageIDType) return integer ;

------------------------------------------------------------

impure function CountCovHoles (ID : CoverageIDType; PercentCov : real ) return integer ;

impure function CountCovHoles (ID : CoverageIDType) return integer ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Generating Coverage Points, BinValues, and Indices

-- /////////////////////////////////////////

------------------------------------------------------------

-- Return Points

------------------------------------------------------------

-- to be replaced in VHDL-2019 by version that uses RandomSeed as an inout

impure function ToRandPoint (ID : CoverageIDType; BinVal : RangeArrayType ) return integer ;

impure function ToRandPoint (ID : CoverageIDType; BinVal : RangeArrayType ) return integer_vector ;

------------------------------------------------------------

-- Return Points

impure function GetPoint (ID : CoverageIDType; BinIndex : integer ) return integer ;

impure function GetPoint (ID : CoverageIDType; BinIndex : integer ) return integer_vector ;

impure function GetRandPoint (ID : CoverageIDType) return integer ;

impure function GetRandPoint (ID : CoverageIDType; PercentCov : real ) return integer ;

impure function GetRandPoint (ID : CoverageIDType) return integer_vector ;

impure function GetRandPoint (ID : CoverageIDType; PercentCov : real ) return integer_vector ;

impure function GetIncPoint (ID : CoverageIDType) return integer ;

impure function GetIncPoint (ID : CoverageIDType) return integer_vector ;

impure function GetMinPoint (ID : CoverageIDType) return integer ;

impure function GetMinPoint (ID : CoverageIDType) return integer_vector ;

impure function GetMaxPoint (ID : CoverageIDType) return integer ;

impure function GetMaxPoint (ID : CoverageIDType) return integer_vector ;

impure function GetNextPoint (ID : CoverageIDType; Mode : NextPointModeType) return integer ;

impure function GetNextPoint (ID : CoverageIDType; Mode : NextPointModeType) return integer_vector ;

impure function GetNextPoint (ID : CoverageIDType) return integer ;

impure function GetNextPoint (ID : CoverageIDType) return integer_vector ;

------------------------------------------------------------

-- deprecated, see GetRandPoint

impure function RandCovPoint (ID : CoverageIDType) return integer ;

impure function RandCovPoint (ID : CoverageIDType; PercentCov : real ) return integer ;

impure function RandCovPoint (ID : CoverageIDType) return integer_vector ;

impure function RandCovPoint (ID : CoverageIDType; PercentCov : real ) return integer_vector ;

------------------------------------------------------------

-- Return BinVals

impure function GetBinVal (ID : CoverageIDType; BinIndex : integer ) return RangeArrayType ;

impure function GetRandBinVal (ID : CoverageIDType; PercentCov : real ) return RangeArrayType ;

impure function GetRandBinVal (ID : CoverageIDType) return RangeArrayType ;

impure function GetLastBinVal (ID : CoverageIDType) return RangeArrayType ;

impure function GetIncBinVal (ID : CoverageIDType) return RangeArrayType ;

impure function GetMinBinVal (ID : CoverageIDType) return RangeArrayType ;

impure function GetMaxBinVal (ID : CoverageIDType) return RangeArrayType ;

impure function GetNextBinVal (ID : CoverageIDType; Mode : NextPointModeType) return RangeArrayType ;

impure function GetNextBinVal (ID : CoverageIDType) return RangeArrayType ;

impure function GetHoleBinVal (ID : CoverageIDType; ReqHoleNum : integer ; PercentCov : real ) return RangeArrayType ;

impure function GetHoleBinVal (ID : CoverageIDType; PercentCov : real ) return RangeArrayType ;

impure function GetHoleBinVal (ID : CoverageIDType; ReqHoleNum : integer := 1 ) return RangeArrayType ;

-- deprecated RandCovBinVal, see GetRandBinVal

impure function RandCovBinVal (ID : CoverageIDType; PercentCov : real ) return RangeArrayType ;

impure function RandCovBinVal (ID : CoverageIDType) return RangeArrayType ;

-- Return Index Values

------------------------------------------------------------

impure function GetNumBins (ID : CoverageIDType) return integer ;

impure function GetRandIndex (ID : CoverageIDType; CovTargetPercent : real ) return integer ;

impure function GetRandIndex (ID : CoverageIDType) return integer ;

impure function GetLastIndex (ID : CoverageIDType) return integer ;

impure function GetIncIndex (ID : CoverageIDType) return integer ;

impure function GetMinIndex (ID : CoverageIDType) return integer ;

impure function GetMaxIndex (ID : CoverageIDType) return integer ;

impure function GetNextIndex (ID : CoverageIDType; Mode : NextPointModeType) return integer ;

impure function GetNextIndex (ID : CoverageIDType) return integer ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Accessing Coverage Bin Information

-- /////////////////////////////////////////

------------------------------------------------------------

-- ------------------------------------------------------------

-- Get all bin information except the BinVal (since it is sized)

impure function GetBinInfo (ID : CoverageIDType; BinIndex : integer ) return CovBinBaseType ;

-- ------------------------------------------------------------

-- Get Pieces of Bin Information

impure function GetBinValLength (ID : CoverageIDType) return integer ; -- Length of BinVal

impure function GetBinAction (ID : CoverageIDType; BinIndex : integer) return integer ;

impure function GetBinName (ID : CoverageIDType; BinIndex : integer; DefaultName : string := "" ) return string ;

procedure SetBinName (ID : CoverageIDType; BinIndex : integer; Name : string) ;

impure function GetPointAction (ID : CoverageIDType; CovPoint : integer_vector) return integer ;

impure function GetPointAction (ID : CoverageIDType; CovPoint : integer) return integer ;

-- ------------------------------------------------------------

-- Eventually the multiple GetBin functions will be replaced by a

-- a single GetBin that returns CovBinBaseType with BinVal as an

-- unconstrained element

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovBinBaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix2BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix3BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix4BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix5BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix6BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix7BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix8BaseType ;

impure function GetBin (ID : CoverageIDType; BinIndex : integer ) return CovMatrix9BaseType ;

------------------------------------------------------------

impure function GetErrorCount (ID : CoverageIDType) return integer ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Printing Coverage Bin Information

-- /////////////////////////////////////////

------------------------------------------------------------

-- To specify the following, see SetReportOptions

-- WritePassFail, WriteBinInfo, WriteCount, WriteAnyIllegal

-- WritePrefix, PassName, FailName

------------------------------------------------------------

procedure WriteBin (ID : CoverageIDType) ;

procedure WriteBin (ID : CoverageIDType; LogLevel : LogType ) ; -- With LogLevel

procedure WriteBin (ID : CoverageIDType; FileName : string; OpenKind : File_Open_Kind := APPEND_MODE) ;

procedure WriteBin (ID : CoverageIDType; LogLevel : LogType; FileName : string; OpenKind : File_Open_Kind := APPEND_MODE) ;

procedure WriteAllBins (FileName : string := "" ; OpenKind : File_Open_Kind := WRITE_MODE) ;

------------------------------------------------------------

procedure WriteCovHoles (ID : CoverageIDType; LogLevel : LogType := ALWAYS ) ;

procedure WriteCovHoles (ID : CoverageIDType; PercentCov : real ) ;

procedure WriteCovHoles (ID : CoverageIDType; LogLevel : LogType; PercentCov : real ) ;

procedure WriteCovHoles (ID : CoverageIDType; FileName : string; OpenKind : File_Open_Kind := APPEND_MODE ) ;

procedure WriteCovHoles (ID : CoverageIDType; LogLevel : LogType; FileName : string; OpenKind : File_Open_Kind := APPEND_MODE ) ;

procedure WriteCovHoles (ID : CoverageIDType; FileName : string; PercentCov : real ; OpenKind : File_Open_Kind := APPEND_MODE ) ;

procedure WriteCovHoles (ID : CoverageIDType; LogLevel : LogType; FileName : string; PercentCov : real ; OpenKind : File_Open_Kind := APPEND_MODE ) ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Writing Out RAW Coverage Bin Information

-- Note that read supports merging of coverage models

-- /////////////////////////////////////////

------------------------------------------------------------

procedure ReadCovDb (ID : CoverageIDType; FileName : string; Merge : boolean := FALSE) ;

procedure WriteCovDb (ID : CoverageIDType; FileName : string; OpenKind : File_Open_Kind := WRITE_MODE ) ;

-- procedure WriteCovDb (ID : CoverageIDType) ;

procedure ReadCovYaml (variable ID : inout CoverageIDType; FileName : string := ""; Merge : boolean := FALSE) ;

procedure WriteCovYaml (ID : CoverageIDType; FileName : string; OpenKind : File_Open_Kind := WRITE_MODE ) ;

------------------------------------------------------------

-- /////////////////////////////////////////

-- Operations across all coverage models

-- /////////////////////////////////////////

------------------------------------------------------------

procedure WriteCovYaml (FileName : string := ""; OpenKind : File_Open_Kind := WRITE_MODE) ;

procedure ReadCovYaml (FileName : string := ""; Merge : boolean := FALSE) ;

impure function GotCoverage return boolean ;

procedure RecordCovRequirements ;

impure function GetCov (PercentCov : real ) return real ;

impure function GetCov return real ;

procedure AffirmIfCovered ;

procedure AlertIfNotCovered (Level : AlertType := ERROR) ;

--------------------------------------------------------------

-- Start of Deprecated / Subsumed by versions with PercentCov Parameter

-- Maintained for backward compatibility only and

-- may be removed in the future.

-- ------------------------------------------------------------

impure function CountCovHoles (ID : CoverageIDType; AtLeast : integer ) return integer ;

impure function IsCovered (ID : CoverageIDType; AtLeast : integer ) return boolean ;

impure function GetRandIndex (ID : CoverageIDType; AtLeast : integer ) return integer ;

impure function GetRandBinVal (ID : CoverageIDType; AtLeast : integer ) return RangeArrayType ;

impure function GetRandPoint (ID : CoverageIDType; AtLeast : integer ) return integer ;

impure function GetRandPoint (ID : CoverageIDType; AtLeast : integer ) return integer_vector ;

impure function GetHoleBinVal (ID : CoverageIDType; ReqHoleNum : integer ; AtLeast : integer ) return RangeArrayType ;

procedure WriteCovHoles (ID : CoverageIDType; AtLeast : integer ) ;

procedure WriteCovHoles (ID : CoverageIDType; LogLevel : LogType ; AtLeast : integer ) ;

procedure WriteCovHoles (ID : CoverageIDType; FileName : string; AtLeast : integer ; OpenKind : File_Open_Kind := APPEND_MODE ) ;

procedure WriteCovHoles (ID : CoverageIDType; LogLevel : LogType ; FileName : string; AtLeast : integer ; OpenKind : File_Open_Kind := APPEND_MODE ) ;

--------------------------------------------------------------

-- End of Deprecated / Subsumed by versions with PercentCov Parameter

-- ------------------------------------------------------------

------------------------------------------------------------

-- Experimental. Intended primarily for development.

procedure CompareBins (

------------------------------------------------------------

constant Bin1 : in CoverageIDType ;

constant Bin2 : in CoverageIDType ;

variable ErrorCount : out integer

) ;

------------------------------------------------------------

-- Experimental. Intended primarily for development.

procedure CompareBins (

------------------------------------------------------------

constant Bin1 : in CoverageIDType ;

constant Bin2 : in CoverageIDType ;

variable Valid : out Boolean

) ;

------------------------------------------------------------

-- Experimental. Intended primarily for development.

procedure CompareBins (

------------------------------------------------------------

constant Bin1 : in CoverageIDType ;

constant Bin2 : in CoverageIDType

) ;

--

-- Support for AddBins and AddCross

--

------------------------------------------------------------

function GenBin(

------------------------------------------------------------

AtLeast : integer ;

Min, Max : integer ;

NumBin : integer

) return CovBinType ;

-- Each item in range in a separate CovBin

function GenBin(Min, Max, NumBin : integer ) return CovBinType ;

function GenBin(Min, Max : integer) return CovBinType ;

function GenBin(A : integer) return CovBinType ;

------------------------------------------------------------

function GenBin(

------------------------------------------------------------

AtLeast : integer ;

A : integer_vector

) return CovBinType ;

function GenBin ( A : integer_vector ) return CovBinType ;

------------------------------------------------------------

function IllegalBin ( Min, Max, NumBin : integer ) return CovBinType ;

------------------------------------------------------------

-- All items in range in a single CovBin

function IllegalBin ( Min, Max : integer ) return CovBinType ;

function IllegalBin ( A : integer ) return CovBinType ;

------------------------------------------------------------

function IgnoreBin (Min, Max, NumBin : integer) return CovBinType ;

------------------------------------------------------------

function IgnoreBin (Min, Max : integer) return CovBinType ; -- All items in range in a single CovBin

function IgnoreBin (A : integer) return CovBinType ;

-- With VHDL-2008, there will be one GenCross that returns CovBinType

-- and has inputs initialized to NULL_BIN - see AddCross

------------------------------------------------------------

function GenCross( -- 2

-- Cross existing bins

-- Use AddCross for adding values directly to coverage database

-- Use GenCross for constants

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2 : CovBinType

) return CovMatrix2Type ;

function GenCross(Bin1, Bin2 : CovBinType) return CovMatrix2Type ;

------------------------------------------------------------

function GenCross( -- 3

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3 : CovBinType

) return CovMatrix3Type ;

function GenCross( Bin1, Bin2, Bin3 : CovBinType ) return CovMatrix3Type ;

------------------------------------------------------------

function GenCross( -- 4

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3, Bin4 : CovBinType

) return CovMatrix4Type ;

function GenCross( Bin1, Bin2, Bin3, Bin4 : CovBinType ) return CovMatrix4Type ;

------------------------------------------------------------

function GenCross( -- 5

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3, Bin4, Bin5 : CovBinType

) return CovMatrix5Type ;

function GenCross( Bin1, Bin2, Bin3, Bin4, Bin5 : CovBinType ) return CovMatrix5Type ;

------------------------------------------------------------

function GenCross( -- 6

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3, Bin4, Bin5, Bin6 : CovBinType

) return CovMatrix6Type ;

function GenCross( Bin1, Bin2, Bin3, Bin4, Bin5, Bin6 : CovBinType ) return CovMatrix6Type ;

------------------------------------------------------------

function GenCross( -- 7

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3, Bin4, Bin5, Bin6, Bin7 : CovBinType

) return CovMatrix7Type ;

function GenCross( Bin1, Bin2, Bin3, Bin4, Bin5, Bin6, Bin7 : CovBinType ) return CovMatrix7Type ;

------------------------------------------------------------

function GenCross( -- 8

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3, Bin4, Bin5, Bin6, Bin7, Bin8 : CovBinType

) return CovMatrix8Type ;

function GenCross( Bin1, Bin2, Bin3, Bin4, Bin5, Bin6, Bin7, Bin8 : CovBinType ) return CovMatrix8Type ;

------------------------------------------------------------

function GenCross( -- 9

------------------------------------------------------------

AtLeast : integer ;

Bin1, Bin2, Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9 : CovBinType

) return CovMatrix9Type ;

function GenCross( Bin1, Bin2, Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9 : CovBinType ) return CovMatrix9Type ;

------------------------------------------------------------

-- Utilities. Remove if added to std.standard

function to_integer ( B : boolean ) return integer ;

function to_boolean ( I : integer ) return boolean ;

function to_integer ( SL : std_logic ) return integer ;

function to_std_logic ( I : integer ) return std_logic ;

function to_integer_vector ( BV : boolean_vector ) return integer_vector ;

function to_boolean_vector ( IV : integer_vector ) return boolean_vector ;

function to_integer_vector ( SLV : std_logic_vector ) return integer_vector ;

function to_std_logic_vector ( IV : integer_vector ) return std_logic_vector ;

alias to_slv is to_std_logic_vector[integer_vector return std_logic_vector] ;

------------------------------------------------------------

-- Deprecated items

-- The following will be removed from the package in the future.

--

------------------------------------------------------------

-- SetName is deprecated, see NewID

procedure SetName (ID : CoverageIDType; Name : String) ;

impure function SetName (ID : CoverageIDType; Name : String) return string ;

procedure DeallocateName (ID : CoverageIDType) ;

------------------------------------------------------------

-- SetMessage is deprecated, see PrintToCovFile

procedure SetMessage (ID : CoverageIDType; Message : String) ;

procedure DeallocateMessage (ID : CoverageIDType) ;

------------------------------------------------------------

-- DumpBin is deprecated

procedure DumpBin (ID : CoverageIDType; LogLevel : LogType := DEBUG) ;

procedure DumpBin (ID : CoverageIDType; LogLevel : LogType; FileName : string; OpenKind : File_Open_Kind := APPEND_MODE) ;

------------------------------------------------------------

-- Weight Deprecated

procedure AddBins (

------------------------------------------------------------

ID : CoverageIDType ;

Name : String ;

AtLeast : integer ;

Weight : integer ;

CovBin : CovBinType

) ;

procedure AddBins (ID : CoverageIDType; AtLeast : integer ; Weight : integer ; CovBin : CovBinType ) ; -- Weight Deprecated

------------------------------------------------------------

-- Weight Deprecated

procedure AddCross(

------------------------------------------------------------

ID : CoverageIDType ;

Name : string ;

AtLeast : integer ;

Weight : integer ;

Bin1, Bin2 : CovBinType ;

Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9, Bin10, Bin11, Bin12, Bin13,

Bin14, Bin15, Bin16, Bin17, Bin18, Bin19, Bin20 : CovBinType := NULL_BIN

) ;

------------------------------------------------------------

-- Weight Deprecated

procedure AddCross(

------------------------------------------------------------

ID : CoverageIDType ;

AtLeast : integer ;

Weight : integer ;

Bin1, Bin2 : CovBinType ;

Bin3, Bin4, Bin5, Bin6, Bin7, Bin8, Bin9, Bin10, Bin11, Bin12, Bin13,

Bin14, Bin15, Bin16, Bin17, Bin18, Bin19, Bin20 : CovBinType := NULL_BIN

) ;

------------------------------------------------------------

-- Weight Parameter is deprecated

function GenBin(

------------------------------------------------------------

AtLeast : integer ;

Weight : integer ;

Min, Max : integer ;

NumBin : integer

) return CovBinType ;

------------------------------------------------------------

-- Weight Parameter is deprecated

function GenBin(

------------------------------------------------------------

AtLeast : integer ;

Weight : integer ;

A : integer_vector

) return CovBinType ;

------------------------------------------------------------

function GenCross( -- 2

-- Cross existing bins

-- Use AddCross for adding values directly to coverage database

-- Use GenCross for constants

------------------------------------------------------------

AtLeast : integer ;

Weight : integer ;

Bin1, Bin2 : CovBinType

) return CovMatrix2Type ;

------------------------------------------------------------

function GenCross( -- 3

------------------------------------------------------------

AtLeast : integer ;

Weight : integer ;

Bin1, Bin2, Bin3 : CovBinType

) return CovMatrix3Type ;

------------------------------------------------------------

function GenCross( -- 4

------------------------------------------------------------

AtLeast : integer ;

Weight : integer ;

Bin1, Bin2, Bin3, Bin4 : CovBinType

) return CovMatrix4Type ;

------------------------------------------------------------

function GenCross( -- 5

------------------------------------------------------------