1Vregs(3)              User Contributed Perl Documentation             Vregs(3)
2
3
4

NAME

6       SystemC::Vregs - Utility routines used by vregs
7

SYNOPSIS

9         use SystemC::Vregs;
10

DESCRIPTION

12       A Vregs object contains a documentation "package" containing
13       enumerations, definitions, classes, and registers.
14

METHODS

16       See also SystemC::Vregs::Output::* for details on functions that write
17       out various header files.
18
19       new Creates a new Vregs package object and returns a reference to it.
20           The name of the package should be passed as a "name" named
21           parameter, likewise the number of address bits should be passed as
22           address_bits.
23
24       check
25           Checks the object for errors, and parses the object to create some
26           derived fields.
27
28       defines_sorted
29           Returns list of SystemC::Vregs::Define objects.
30
31       enums_sorted
32           Returns list of SystemC::Vregs::Enum objects.
33
34       exit_if_error
35           Exits if any errors were detected by check().
36
37       find_define
38           Returns SystemC::Vregs::Define object with a name matching the
39           passed parameter, or undef if not found.
40
41       find_enum
42           Returns SystemC::Vregs::Enum object with a name matching the passed
43           parameter, or undef if not found.
44
45       find_type
46           Returns SystemC::Vregs::Type object with a name matching the passed
47           parameter, or undef if not found.
48
49       find_type_regexp
50           Returns list of SystemC::Vregs::Type objects with a name matching
51           the passed wildcard, or undef if not found.
52
53       html_read
54           Reads the specified HTML filename, and creates internal objects.
55
56       regs_read
57           Reads the specified .vregs filename, and creates internal objects.
58
59       regs_read_check
60           Calls the normal sequence of commands to read a known-good vregs
61           file; regs_read, check, and exit_if_error.
62
63       regs_sorted
64           Returns list of SystemC::Vregs::Register objects.
65
66       regs_write
67           Creates the specified .vregs filename.
68
69       types_sorted
70           Returns list of SystemC::Vregs::Type objects.
71

DISTRIBUTION

73       Vregs is part of the <http://www.veripool.org/> free Verilog software
74       tool suite.  The latest version is available from CPAN and from
75       <http://www.veripool.org/vregs>.  /www.veripool.org/>.
76
77       Copyright 2001-2010 by Wilson Snyder.  This package is free software;
78       you can redistribute it and/or modify it under the terms of either the
79       GNU Lesser General Public License Version 3 or the Perl Artistic
80       License Version 2.0.
81

AUTHORS

83       Wilson Snyder <wsnyder@wsnyder.org>
84

SEE ALSO

86       vreg, vreg_latex2html, SystemC::Vregs::Rules
87
88       Low level objects:
89
90       SystemC::Vregs::Bit, SystemC::Vregs::Define, SystemC::Vregs::Enum,
91       SystemC::Vregs::Language, SystemC::Vregs::Number,
92       SystemC::Vregs::Register, SystemC::Vregs::Subclass,
93       SystemC::Vregs::Type SystemC::Vregs::Input::TableExtract,
94       SystemC::Vregs::Input::Layout, SystemC::Vregs::Input::HTML,
95       SystemC::Vregs::Output::Class, SystemC::Vregs::Output::Defines,
96       SystemC::Vregs::Output::Hash, SystemC::Vregs::Output::Info,
97       SystemC::Vregs::Output::Layout, SystemC::Vregs::Output::Latex,
98       SystemC::Vregs::Output::Param
99
100
101
102perl v5.30.1                      2020-01-30                          Vregs(3)
Impressum