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
• Modules Page
• Interfaces Page

---

Navigating These Pages - the Tabs

• Main
  • Main important information about the model being documented.
  • Related Docs list of other documentation pages 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 a VIP.

• Modules descriptions of all the system verilog modules present.

• Interfaces descriptions of all the system verilog interfaces present.

• Files a list of all source files with links to the contents of these files.

• ? this 'help' page.

The Documentation Search Facility

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.
A link to a documentation area. Highlighted in yellow.
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 listing of all covergroups defined.

Protocol Checks Reference Page

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

It will include

• Protocol Check Instance name
• Description
• Reference
• Error Category

Modules Reference page

Interfaces Reference page

The Interface Reference page contains descriptions of the all the HW interfaces present.

This also includes

• parameters
• modports
• clocking blocks

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