SystemC::Vregs::Bit(3pm)

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

NAME

6       SystemC::Vregs::Bit - Bit object
7

SYNOPSIS

9           use SystemC::Vregs;
10

DESCRIPTION

12       This package contains a blessed hash object for each bit field in a
13       SystemC::Vregs::Type.
14

FIELDS

16       These fields may be specified with the new() function, and accessed via
17       the self hash: $self->{field}.
18
19       access
20           RW/R/W/H/S access for the field, from the access column of the
21           field definition.
22
23       bits
24           The bits the field occupies, from the bit column in the field
25           definition.
26
27       desc
28           Description comment for the object.
29
30       name
31           Name of the object.
32
33       overlaps
34           A string indicating what bitfields may be overlapped by this field.
35           From parsing the description column of the field for "overlaps
36           allowed" strings.
37
38       pack
39           Reference to the package (SystemC::Vregs) object self is a member
40           of.
41
42       rst Reset value from the reset column of the field definition.
43
44       type
45           Type of the field, from the type column of the field definition.
46

DERIVED FIELDS

48       These fields are valid only after check() is called.
49
50       bitarray
51           A array, with one entry for each bit number (0..31).  Each entry
52           contains a hash with the bit field reference and status on that
53           bit.
54

METHODS

56       new Creates a new bit object.
57
58       check
59           Checks the object for errors, and parses to create derived Fields.
60

DISTRIBUTION

62       Vregs is part of the <http://www.veripool.org/> free Verilog software
63       tool suite.  The latest version is available from CPAN and from
64       <http://www.veripool.org/vregs>.  /www.veripool.org/>.
65
66       Copyright 2001-2010 by Wilson Snyder.  This package is free software;
67       you can redistribute it and/or modify it under the terms of either the
68       GNU Lesser General Public License Version 3 or the Perl Artistic
69       License Version 2.0.
70

AUTHORS

72       Wilson Snyder <wsnyder@wsnyder.org>
73