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->modports
34           Returns list of references to Verilog::Netlist::ModPort in the
35           interface.
36
37       $self->modports_sorted
38           Returns list of references to Verilog::Netlist::ModPort in the
39           interface sorted by name.
40
41       $self->name
42           The name of the interface.
43
44       $self->netlist
45           Reference to the Verilog::Netlist the interface is under.
46
47       $self->nets
48           Returns list of references to Verilog::Netlist::Net in the
49           interface.
50
51       $self->nets_sorted
52           Returns list of name sorted references to Verilog::Netlist::Net in
53           the interface.
54
55       $self->nets_and_ports_sorted
56           Returns list of name sorted references to Verilog::Netlist::Net and
57           Verilog::Netlist::Port in the interface.
58
59       $self->ports
60           Returns list of references to Verilog::Netlist::Port in the
61           interface.
62
63       $self->ports_ordered
64           Returns list of references to Verilog::Netlist::Port in the
65           interface sorted by pin number.
66
67       $self->ports_sorted
68           Returns list of references to Verilog::Netlist::Port in the
69           interface sorted by name.
70

MEMBER FUNCTIONS

72       See also Verilog::Netlist::Subclass for additional accessors and
73       methods.
74
75       $self->find_net(name)
76           Returns Verilog::Netlist::Net matching given name.
77
78       $self->level
79           Returns the reverse depth of this interface with respect to other
80           modules and interfaces.  See also Netlist's modules_sorted_level.
81
82       $self->lint
83           Checks the interface for errors.
84
85       $self->link
86           Creates interconnections between this interface and other
87           interfaces.
88
89       $self->new_net
90           Creates a new Verilog::Netlist::Net.
91
92       $self->dump
93           Prints debugging information for this interface.
94
95       $self->verilog_text
96           Returns verilog code which represents this interface.  Returned as
97           an array that must be joined together to form the final text
98           string.  The netlist must be already ->link'ed for this to work
99           correctly.
100

DISTRIBUTION

102       Verilog-Perl is part of the <https://www.veripool.org/> free Verilog
103       EDA software tool suite.  The latest version is available from CPAN and
104       from <https://www.veripool.org/verilog-perl>.
105
106       Copyright 2000-2021 by Wilson Snyder.  This package is free software;
107       you can redistribute it and/or modify it under the terms of either the
108       GNU Lesser General Public License Version 3 or the Perl Artistic
109       License Version 2.0.
110

AUTHORS

112       Wilson Snyder <wsnyder@wsnyder.org>
113