Using This Documentation

These documentation pages were produced with svdoc V-2024.03-3 on 07 August 2024

Navigating These Pages - the Tabs

The Documentation Search Facility

Inbuilt search:

Available through a search dialog at the upper right corner of this class reference documentation.

Search modes in builtin search:

simple - simple searches
reg expr - regular expression searches

Simple Search

A list of potential matching names from the class reference content is presented to you for the name or partial name entered in the text window followed by hitting either enter or tab. This list is distilled from all matching elements.
Since there sometimes may be a substantial number of matching elements of the same name (but different types or scopes!) only a single instance of a matching name is presented. Clicking on any of the names will take you to the master index page where ALL the instances of that name are presented along with their types and scoping.

Searching with Regular Expressions

Using 'reg expr' mode lets you enter a regular expression in the text field. A regular expression allows you to specify complex search patterns. Special chars in a regular expression include:
. - matches any char
^ - matches the start of a name
$ - matches the end of a name
+ - matches one or more of the preceiding char
* - matches zero or more of the previous char
For example to seach for all elements starting with 'bit' you would enter
^bit
To search for all elements containing 'all' and 'cate' you would enter
all.*cate

To search for all elements containing at least two l's (lower case L) in a row

ll+

To search for all elements ending with a least two l's

ll+$

NLP based Search

Use 'SMARTSEARCH' tool for searching using natural language. Click on Smartsearch button in the top right corner to know details about installing and using the NLP based Search framework that supports search across all documentation categories and helps reordering search results and applying learning to subsequent usage.

Hyper Links

Links have a different appearance depending on their purpose.

A link to an element of a class or model component. Highlighted in yellow while hovering over that element.
A link in a piece of source code.

Class Pages

Each class has its own page with overall class documentation and lists of the various members of that class.

Contents in each class documentation:

Macros Reference page

The Macro Reference page starts with a two-column listing of all the macros (defines) used. These are sorted in alphabetical order. Each macro name in this list is a hyper-link to more detailed documentation for that macro including the macro replacement text.

If a macro's replacement text includes a reference to another macro, the referenced macro name is also a hyper link.

The macro arguments are shown in bold-face to make it easier to see where those arguments are used in the replacement text.

Covergroups Reference Page

The Covergroups Reference page has a table listing all covergroups defined in the VIP.

Each row in the Sequences table include

Note: Cross coverage detail displayed only if it is defined for the covergroup. That column is hidden by default and can be viewed by enabling in the Show/Hide option above the covergroups table]

Protocol Checks Reference Page

The Protocol Checks Reference page has list of all Checks defined in the VIP.

Default display of Checks:

Additional details about the Protocol checks:
[Hidden by default and can be viewed by enabling in the show/Hide option in right corner above the Protocol Checks table]

Sequence Reference Page

The Sequence Reference page has a table listing all sequences defined in the VIP.

Each row in the Sequences table include

Note: Controls and Sequencer column are hidden by default and can be viewed by enabling in the Show/Hide option in right corner above the Sequences table

Interfaces Reference page

The Interface Reference page contains summary table with list of all interface present in the VIP and descriptions of each of the HW interfaces present.

This also includes

If there are multiple interfaces they are all listed on this page.

Ports Page

The Ports Reference page has two sub tabs - Analysis Ports and TLM ports with the list of corresponding ports defined in the Application and Agent components of the VIP.

Each row in the Ports table include

07 August 2024, Copyright © 2024 Synopsys, Inc.