VIP Smartsearch

X

VIP Smartsearch is a framework that supports search within VIP reference documents using query in natural language. It facilitates reordering of search results and keeps record of user’s decision for the ordering of result display and applies that in search of same query on subsequent usage.
How to download VIP smartsearch?
1. Get VIP Smartsearch (Available as a seperate run file).
2. Set environment variable
```
DESIGNWARE_HOME
```
  to required designware home location where VIP Smartsearch should be downloaded.
3. Run
```
vip_smartsearch_<version>.run
```
  file.
  VIP Smartsearch will be downloaded to the location
```
$DESIGNWARE_HOME/vip/svt/vip_smartsearch/<version>
```

How to install VIP Smartsearch?

Please refer to the file

VIP_Smartsearch_installation_and_usage_guide.pdf

in

$DESIGNWARE_HOME/vip/svt/vip_smartsearch/<version>

for installation steps.

Customer Support
For more details about VIP smartsearch tool, contact support_center@synopsys.com.
Mention your queries along with below details and send email to above email id.
Product: Verification IP
Sub Product: <vip_title>
Tool: VIP Smartsearch

Using This Documentation

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

Navigating These Pages - the Tabs

Hyper-links

The Documentation Search Facility

Class Pages

Macros Page

Covergroups Page

Protocol Checks Page

Sequence Page

Interfaces Page

Ports Page

Navigating These Pages - the Tabs

Main
Main important information about the model being documented.
Related Docs lists other documentation pages if exist for the model.
Help this page.

Classes
For products other than svt, classes are categorized as configuration, agent, driver, monitor, sequencer, transaction, coverage, callbacks, sequences, exceptions, status, env and others(as applicable to each vip and methodology)
For svt class reference ,classes as categorized as SVT and methodology classes.

Macros an alphabetically keyed list of all system verilog macros.

Covergroups descriptions of all Covergroups present.

Protocol Checks provides list of Protocol Checks defined in the VIP.

Sequence Page provides list of Sequences defined in the VIP.

Interfaces descriptions of all the system verilog interfaces present.

Ports Page provides list of Analysis and TLM ports defined in the VIP.

? this 'help' page.

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:
Class name and description
List of public attributes with support for grouping related attributes.
List of public member functions:Information about return type, function name and arguments.
List of typedefs.
List of constraints.
Description of each of the above item.

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
Grouping columns for filtering the covergroups of interest
Covergroup name with link to corresponding definition
Coverpoints
Coverpoint bins
Cross coverage
Covergroup Description
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:
Grouping columns for filtering the Protocol checks of interest
Protocol Check Instance name
Reference
Description

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]
Check Intent
Pass Condition
Fail Condition
Applicable Device Type
Additional Information

Sequence Reference Page

The Sequence Reference page has a table listing all sequences defined in the VIP.
Each row in the Sequences table include
Grouping columns for filtering the suquences of interest
Sequence name with link to corresponding class page
Sequence Description.
Control parameters.
Sequencer
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
parameters
modports
clocking blocks

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
Port name with link to its declaration in corresponding class page
Agent component with filter to choose the components of interest
component class with link to corresponding class page and filter to choose the component class of interest.
Description

13 August 2024, Copyright © 2024 Synopsys, Inc.