SystemC::Vregs - Utility routines used by vregs
use SystemC::Vregs;
A Vregs object contains a documentation "package" containing enumerations, definitions, classes, and registers.
See also SystemC::Vregs::Output::* for details on functions that write out various header files.
Creates a new Vregs package object and returns a reference to it. The name of the package should be passed as a "name" named parameter, likewise the number of address bits should be passed as address_bits.
Checks the object for errors, and parses the object to create some derived fields.
Returns list of SystemC::Vregs::Define objects.
Returns list of SystemC::Vregs::Enum objects.
Exits if any errors were detected by check().
Returns SystemC::Vregs::Define object with a name matching the passed parameter, or undef if not found.
Returns SystemC::Vregs::Enum object with a name matching the passed parameter, or undef if not found.
Returns SystemC::Vregs::Type object with a name matching the passed parameter, or undef if not found.
Returns list of SystemC::Vregs::Type objects with a name matching the passed wildcard, or undef if not found.
Reads the specified HTML filename, and creates internal objects.
Reads the specified .vregs filename, and creates internal objects.
Calls the normal sequence of commands to read a known-good vregs file; regs_read, check, and exit_if_error.
Returns list of SystemC::Vregs::Register objects.
Creates the specified .vregs filename.
Returns list of SystemC::Vregs::Type objects.
Vregs is part of the http://www.veripool.org/ free Verilog software tool suite. The latest version is available from CPAN and from http://www.veripool.org/vregs. /www.veripool.org/>.
Copyright 2001-2010 by Wilson Snyder. This package is free software; you can redistribute it and/or modify it under the terms of either the GNU Lesser General Public License Version 3 or the Perl Artistic License Version 2.0.
Wilson Snyder <wsnyder@wsnyder.org>
vreg, vreg_latex2html, SystemC::Vregs::Rules
Low level objects:
SystemC::Vregs::Bit, SystemC::Vregs::Define, SystemC::Vregs::Enum, SystemC::Vregs::Language, SystemC::Vregs::Number, SystemC::Vregs::Register, SystemC::Vregs::Subclass, SystemC::Vregs::Type SystemC::Vregs::Input::TableExtract, SystemC::Vregs::Input::Layout, SystemC::Vregs::Input::HTML, SystemC::Vregs::Output::Class, SystemC::Vregs::Output::Defines, SystemC::Vregs::Output::Hash, SystemC::Vregs::Output::Info, SystemC::Vregs::Output::Layout, SystemC::Vregs::Output::Latex, SystemC::Vregs::Output::Param
To install SystemC::Vregs, copy and paste the appropriate command in to your terminal.
cpanm
cpanm SystemC::Vregs
CPAN shell
perl -MCPAN -e shell install SystemC::Vregs
For more information on module installation, please visit the detailed CPAN module installation guide.