How To Use This Documentation

These documentation pages were produced with svdoc 0.20p on 16 December 2008

---

• Navigating These Pages - the Tabs
• Hyper-links
• The Documentation Search Facility
• Searching with Regular Expressions
• Class Hierarchy Lists
• Class Hierarchy with Multiple Children
• Class Pages
• Macros 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
  • Class Hierarchy a hierarchical list of all classes showing the parent / child relationships.
  • Class List a list of all classes including brief descriptions (where available).
  • Alphabetical List an alphabetically keyed list of all classes

• Macros an alphabetically keyed list of all system verilog macros.

• 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.

• Index the index pages
  • All index containing ALL source code elements
  • Functions index containing only function and task related elements
  • Attributes index containing only varaible elements.
  • Enums index containing only enum definitions.
  • Constraints index containing only constraints.
  • Macros index containing only macros.
  • Modules & Interfaces index containing only module and interface related elements.

• ? this 'help' page.

The Documentation Search Facility

In the upper right corner of the documentation windows are the controls of the search facility. Enter the name or partial name of a program element into the text window and either hit enter or tab and a list of matches will be presented to you.

If desired set the search mode to either

simple - simple searches
reg expr - regular expression searches

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 contining 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+$

A list of potential matching names is presented to you. 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.

For example searching for 'alloc' might return the following list of matches:

allocate	22 elements matched ...
allocate_scenario	6 elements matched ...
svt_sata_host_atapi_allocation_length_in_bytes_cdb_byte_3_to_4	1 element matched ...
svt_sata_host_atapi_allocation_length_in_bytes_cdb_byte_4	1 element matched ...
svt_sata_host_atapi_allocation_length_in_bytes_cdb_byte_6_to_8	1 element matched ...
svt_sata_host_atapi_allocation_length_in_bytes_cdb_byte_7_to_8	1 element matched ...
svt_sata_host_atapi_allocation_length_in_bytes_cdb_byte_8_to_9	1 element matched ...

There are 22 matching elements for the name 'allocate'. Clicking on the word allocate takes you to the master index page where the entries for 'allocate' are present.

allocate	function	function, defined in class vmm_data,,  returns type vmm_data
allocate	function	function, defined in class svt_data,,  returns type vmm_data
allocate	function	function, defined in class svt_channel_data,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_configuration,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_command,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_fis_exception_list,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_fis,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_fis_exception,,  returns type vmm_data
allocate	function	function, defined in class svt_8b10b_data,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_8b10b_exception_list,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_8b10b,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_8b10b_exception,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_primitive_exception_list,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_primitive,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_primitive_exception,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_host_command_exception_list,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_host_command,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_host_command_exception,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_fis_response,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_oob_exception_list,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_oob,,  returns type vmm_data
allocate	function	function, defined in class svt_sata_oob_exception,,  returns type vmm_data

Hyper Links

Links have a different appearance depending on their purpose.

A link to an element of a class or model component. Hilites in yellow.
A link to a documentation area. Hilites in yellow.
A link in a piece of source code.

Class Hierarchy lists

Each class starts with a listing of its hierarchy. For example:

Inheritance list for class svt_configuration:

• vmm_data
  • svt_data
    • svt_configuration
      • svt_sata_configuration

Note that this list is for the class svt_configuration. This is highlighted in light purple in the list. The classes above it are its parents. Those below it are its children. A base class would have no classes listed above.

Clicking on a class name in a hierarchy list will take you to that classes' documentation.

Inheritance list with Multiple Children

Here's an example of a class, svt_data, showing all of its multiple children.

Inheritance list for class svt_data:

• vmm_data
  • svt_data
    • svt_channel_data
    • svt_configuration
      • svt_sata_configuration
    • svt_err_check_data
    • svt_err_check_stats
    • svt_exception
      • svt_sata_8b10b_exception
      • svt_sata_fis_exception
      • svt_sata_host_command_exception
      • svt_sata_oob_exception
      • svt_sata_primitive_exception
    • svt_exception_list
      • svt_sata_8b10b_exception_list
      • svt_sata_fis_exception_list
      • svt_sata_host_command_exception_list
      • svt_sata_oob_exception_list
      • svt_sata_primitive_exception_list
    • svt_transaction
      • svt_8b10b_data
        • svt_sata_8b10b
      • svt_sata_command
        • svt_sata_host_command
      • svt_sata_fis
      • svt_sata_fis_response
      • svt_sata_oob
      • svt_sata_primitive
    • svt_xactor_callbacks_data
    • svt_xactor_data

Class Pages

Each class has its own page with overall class documentation and lists of the various members of that class. Members include variables, tasks, functions, and constraints.

Each class page has brief listings of the members near the top of the page. Each memberlisting has a hyper-link to the more detailed description of that member further down in the page. The brief listings are in alphabetical order.

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.

Modules Reference page

The Module Reference page contains descriptions of all the Verilog modules present.

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.