sce_retype

Name

sce_retype -- scripting of System-On-Chip Environment (SCE)

Synopsis

sce_retype [options] [action...] design

DESCRIPTION

sce_retype allows to query and change the type of a behavior, variable or channel instance in a given design.

sce_retype reads the SIR file for a given design, performs each action specified via the command line and writes out the resulting modified SIR (if any). An output SIR file is only written if modifications to the design have been made through the actions. If no action is specified, no operations are performed, no output is produced and the specified design is left unchanged.

On successful completion, the exit value 0 is returned. In case of errors, a diagnostic message is written to standard error and the program execution is aborted with a non-zero exit value. In this case, no output is produced.

ARGUMENTS

design

specifies the design to work with; if no -i or -o options are specificed, the suffix '.sir' will be appended to this name in order to obtain the default SIR file to read and write, respectively.

action

specifies the action to perform on the design; actions include operations to query or manipulate the design, and to set up options for following operations; command line actions are processed strictly in order, i.e. multiple operations are performed in the order specified on the command line and earlier options have effect until they are overwritten by later ones.

OPTIONS

-h

prints a short usage and version information and then quits;

-i input file

specifies the name of the input file explicitly; the name '-' can be used to specify reading from standard input;

-n

suppresses the creation of new log information when generating the output SIR file; by default, log information in the main design file is updated automatically (see also section ANNOTATIONS below);

-o output file

specifies the name of the output design file explicitly; the name '-' can be used to specify writing to standard output;

-v

set the verbosity level so that progress reports about actions performed are logged to standard error (default: be silent);

ACTIONS

-m def

show the type of instance def in the design and output it to stdout; def specifies the path to the instance as a dotted hierarchical name, i.e. as a sequence of instance names concatenated and separated by dots ("."); the path is first searched starting from the top-level behavior (if any); if not found under the top-level, the path is searched at the global level; if both lookups fail, an error is produced;

-m def=type

change the type of instance def in the design to type where def specifies the path to the instance as a dotted hierarchical name starting from the top-level behavior or the global level (see above); the type has to be an existing and matching type in the design; if the new type is not compatible, an error will be produced;

-t behavior

specify the top-level behavior to operate on for all actions following on the command line (default: use top-level behavior specified in the design);

ENVIRONMENT

HOME

determines the location of the user's home directory and consequently the default path to the file with user-specific application preferences ($HOME/.sce/scerc);

SCERC_PATH

determines the list of directories where files "scerc" with user-specific application preferences are stored; multiple directories can be provided, separated by colons (":"); directories are searched for and preference files are read in the given order, i.e. preference files in later directories override settings in earlier ones; if SCERC_PATH is not set, the location (directory) of the user-specific "scerc" file defaults to $HOME/.sce;

SPECC_LICENSE_FILE

determines the license file (path and file name) to be used by the SIR tool set; if undefined, the environment variable SPECC is used as the path to the license file called "license.sir"; if neither SPECC_LICENSE_FILE nor SPECC exist, the file "license.sir" is searched in the current directory;

FILES

/ECEnet/Apps1/sce/latest/etc/scerc

File with system-wide default settings for application preferences; system-wide settings are read on startup before user-specific settings;

$SCERC_PATH/scerc or $HOME/.sce/scerc

File(s) with user-specific settings for application preferences; user-specific settings are read on startup after system-wide settings, i.e. user-specific settings override system-wide settings;

ANNOTATIONS

The following SpecC annotations are recognized by sce_retype:

_SCE_LOG

contains the log information of the SIR file; this global annotation is created and maintained automatically by the SpecC compiler and the SCE tool set and can be used to determine the origin and the operations performed on the design model; _SCE_LOG is a composite annotation consisting of a list of log entries, ordered by time of creation; each log entry consists of a time stamp, command line, source file, version info, and an optional comment;

VERSION

The System-On-Chip Environment (SCE) is version 2.2.1.

AUTHOR

Andreas Gerstlauer <gerstl@cecs.uci.edu>

COPYRIGHT

(c) 2001-2010 CECS, UC Irvine

SEE ALSO

sce_top(l), sce_import(l), sce_allocate(l), sce_map(l), sce_schedule(l), sce_connect(l), sce_project(l),

BUGS, LIMITATIONS

None know.