X-Amin provides several commands aimed at providing various information about components that been read into the application. This section will discuss the two most used commands: info and report.

Info

The info command provides a wealth of data regarding a namespace including:

• Component name
• HDL source filename
• Number of lines of code
• HDL code format (Verilog or VHDL)
• Summary of statement types
• Instance information
• Input/Ouput/Internal signal information
• Tasks/Procedures and Function information

This command is not available on the GUI menus or toolbar icons and must be typed into the Command Entry. The info command format is:

SYNTAX
 (void) info
    [-detail]
    [<namespace>...]
   

ARGUMENTS
 -detail
   Included detailed information in the report such as
   signal names. The default is to generate summary
   information.

 <namespace>
   Generate the info report from the specified names­
   pace(s). If no namespaces are specified, generate
   the report from current scope.

An example info command output is shown below:

> info -detail
Information for comp1
 Name : :comp1
 Filename : ../comps/comp1.v
 Lines of code : 14
 format : Verilog
 Space Type : Module
 Time Scale : 
 Initial Blocks : 0
 Always Blocks : 1
 Concurrent Assigns : 1
 Unique Instances : 0
 Total Instances : 0
 Inputs : 3
    a
    b
    clk
 Outputs : 1
    z
 Bidirs : 0
 Parameters : 0
 Regs : 1
    d
 Wires : 1
    z
 Tasks : 0
 Functions : 0
   

Report

The report command provides detailed information about a components signals, subprograms, constants, etc. This command is similar to the info command except is targeted more toward internal signals and subprograms. Additionally, the information presented by report can be customized via command options. This command is not available on the GUI menus or toolbar icons and must be typed into the Command Entry. The report command format is:

SYNTAX
 (void) report
    [-filter <regexp>
    [-bidirs]
    [-functions]
    [-inputs]
    [-instances]
    [-outputs]
    [-parameters]
    [-ports]
    [-regs]
    [-tasks]
    [-wires]
    [<namespace>...]

ARGUMENTS
 -filter <regexp>
   Return only the items that match the regular
   expression filter <regexp>.

 -bidirs
   Include bidirectional port names in the report

 -functions
   Include function names in the report

 -inputs
   Include input port names in the report

 -instances
   Include instance names in the report

 -outputs
   Include output port names in the report

 -parameters
   Include parameter names in the report

 -ports Include port names (input, bidir, output) in the
   report

 -regs Include register names in the report

 -tasks Include task/procedure names in the report

 -wires Include wire names in the report

 <namespace>...
   List of namspaces on which to produce the report
   

An example report command output is shown below:

> report
----- :comp1 -----
bidirs

functions

inputs
   a
   b
   clk

instances

outputs
   z

parameters

inputs
   a
   b
   clk

outputs
   z

regs
   d

tasks

wires
   z