Verilog::Netlist::Interface(3pm)

1Netlist::Interface(3) User Contributed Perl DocumentationNetlist::Interface(3)
2
3
4

NAME

6       Verilog::Netlist::Interface - Interface within a Verilog Netlist
7

SYNOPSIS

9         use Verilog::Netlist;
10
11         ...
12         my $interface = $netlist->find_interface('name');
13         my $cell = $self->find_cell('name')
14         my $port =  $self->find_port('name')
15         my $net =  $self->find_net('name')
16

DESCRIPTION

18       A Verilog::Netlist::Interface object is created by Verilog::Netlist for
19       every interface in the design.
20

ACCESSORS

22       See also Verilog::Netlist::Subclass for additional accessors and
23       methods.
24
25       $self->comment
26           Returns any comments following the definition.  keep_comments=>1
27           must be passed to Verilog::Netlist::new for comments to be
28           retained.
29
30       $self->find_port_by_index
31           Returns the port name associated with the given index.
32
33       $self->name
34           The name of the interface.
35
36       $self->netlist
37           Reference to the Verilog::Netlist the interface is under.
38
39       $self->nets
40           Returns list of references to Verilog::Netlist::Net in the
41           interface.
42
43       $self->nets_sorted
44           Returns list of name sorted references to Verilog::Netlist::Net in
45           the interface.
46
47       $self->nets_and_ports_sorted
48           Returns list of name sorted references to Verilog::Netlist::Net and
49           Verilog::Netlist::Port in the interface.
50
51       $self->ports
52           Returns list of references to Verilog::Netlist::Port in the module.
53
54       $self->ports_ordered
55           Returns list of references to Verilog::Netlist::Port in the module
56           sorted by pin number.
57
58       $self->ports_sorted
59           Returns list of references to Verilog::Netlist::Port in the module
60           sorted by name.
61

MEMBER FUNCTIONS

63       See also Verilog::Netlist::Subclass for additional accessors and
64       methods.
65
66       $self->autos
67           Updates the AUTOs for the interface.
68
69       $self->find_net(name)
70           Returns Verilog::Netlist::Net matching given name.
71
72       $self->level
73           Returns the reverse depth of this interface with respect to other
74           modules and interfaces.  See also Netlist's modules_sorted_level.
75
76       $self->lint
77           Checks the interface for errors.
78
79       $self->link
80           Creates interconnections between this interface and other
81           interfaces.
82
83       $self->new_net
84           Creates a new Verilog::Netlist::Net.
85
86       $self->dump
87           Prints debugging information for this interface.
88
89       $self->verilog_text
90           Returns verilog code which represents this interface.  Returned as
91           an array that must be joined together to form the final text
92           string.
93

DISTRIBUTION

95       Verilog-Perl is part of the <http://www.veripool.org/> free Verilog EDA
96       software tool suite.  The latest version is available from CPAN and
97       from http://www.veripool.org/verilog-perl
98       <http://www.veripool.org/verilog-perl>.
99
100       Copyright 2000-2009 by Wilson Snyder.  This package is free software;
101       you can redistribute it and/or modify it under the terms of either the
102       GNU Lesser General Public License Version 3 or the Perl Artistic
103       License Version 2.0.
104

AUTHORS

106       Wilson Snyder <wsnyder@wsnyder.org>
107